Openpyxl: _cells_by_row - Python

Openpyxl is a Python library used to read and write Excel (.xlsx) files. One of the functionalities that openpyxl provides is the _cells_by_row method.

What is _cells_by_row method?

_cells_by_row is an internal method used by openpyxl to iterate through cells in a row. It returns a tuple with two elements; a dictionary of row number and list of cells in that row, and another dictionary indicating which rows have been loaded.

Syntax

def _cells_by_row(self, min_row=None, max_row=None):
        ......
        return rows, self.row_dimensions.loaded

Parameters

The _cells_by_row method has two optional parameters:

• min_row: The minimum row number to load. Default is None.
• max_row: The maximum row number to load. Default is None.

Return Value

The _cells_by_row method returns a tuple of two elements:

• rows: A dictionary with the row number as the key and a list of cells in that row as the value.
• self.row_dimensions.loaded: A dictionary indicating which rows have been loaded.

Example

from openpyxl import load_workbook
  
wb = load_workbook('data.xlsx')
ws = wb.active

for row, cell in ws._cells_by_row():
    if row > 10:
        break
    for c in cell:
        print(c.value)

In the above example, we load a workbook and iterate through cells by row using the _cell_by_row method. We print the value of each cell in the first 10 rows.

Conclusion

In conclusion, the _cells_by_row method is a useful internal method provided by the openpyxl library to iterate through cells in a row. By using this method, we can easily loop through cells in a particular row and get their values or attributes, thus making the processing of Ecxel files a lot more efficient and easier.