Skip to content

Helpers

alphabet_to_index(cell_ref)

Method to convert A1 notation to an integer.

This method will return zero-centered indexes,

despite index_to_alphabet taking one-centered index inputs.

:type cell_ref: str :param cell_ref: A1 notation of cell to convert.

:rtype: int :returns: Index notation of the cell.

Source code in pygsuite/sheets/helpers.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def alphabet_to_index(cell_ref: str) -> int:
    """Method to convert A1 notation to an integer.
    NOTE: This method will return zero-centered indexes,
            despite `index_to_alphabet` taking one-centered index inputs.

    :type cell_ref: str
    :param cell_ref: A1 notation of cell to convert.

    :rtype: int
    :returns: Index notation of the cell.
    """

    idx = 0
    for char in cell_ref:
        if char in ascii_letters:
            idx = idx * 26 + (ord(char.upper()) - ord("A")) + 1

    return idx - 1

index_to_alphabet(input_index)

Method to convert integer to A1 notation.

:type input_index: int :param idx: Cell index to convert.

:rtype: str :returns: A1 notation of the cell.

Source code in pygsuite/sheets/helpers.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
def index_to_alphabet(input_index: int) -> str:
    """Method to convert integer to A1 notation.

    :type input_index: int
    :param idx: Cell index to convert.

    :rtype: str
    :returns: A1 notation of the cell.
    """

    try:
        assert input_index <= SHEETS_MAX_COLUMN_NUMBER
    except AssertionError:
        raise ValueError(
            f"Input of column index {input_index} exceeds the maximum column number allowed of {SHEETS_MAX_COLUMN_NUMBER}."
        )

    a1_notation = ""

    while input_index > 0:
        input_index, remainder = divmod(input_index - 1, 26)
        a1_notation = ascii_uppercase[remainder] + a1_notation

    return a1_notation