Class Cell

gspread/cell.py:14–95

An instance of this class represents a single cell in a :class:`~gspread.worksheet.Worksheet`.

class Cell:
    """An instance of this class represents a single cell
    in a :class:`~gspread.worksheet.Worksheet`.
    """

    def __init__(self, row: int, col: int, value: Optional[str] = "") -> None:
        self._row: int = row
        self._col: int = col

        #: Value of the cell.
        self.value: Optional[str] = value

    @classmethod
    def from_address(cls, label: str, value: str = "") -> "Cell":
        """Instantiate a new :class:`~gspread.cell.Cell`
        from an A1 notation address and a value

        :param string label: the A1 label of the returned cell
        :param string value: the value for the returned cell
        :rtype: Cell
        """
        row, col = a1_to_rowcol(label)
        return cls(row, col, value)

    def __repr__(self) -> str:
        return "<{} R{}C{} {}>".format(
            self.__class__.__name__,
            self.row,
            self.col,
            repr(self.value),
        )

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, Cell):
            return False

        same_row = self.row == other.row
        same_col = self.col == other.col
        same_value = self.value == other.value
        return same_row and same_col and same_value

    @property
    def row(self) -> int:
        """Row number of the cell.

        :type: int
        """
        return self._row

    @property
    def col(self) -> int:
        """Column number of the cell.

        :type: int
        """
        return self._col

    @property