Skip to content

has_column

laktory.polars.dataframe.has_column ¤

FUNCTION DESCRIPTION
has_column

Check if column col exists in df

Functions¤

has_column ¤

has_column(df, col)

Check if column col exists in df

PARAMETER DESCRIPTION
df

Input DataFrame

TYPE: DataFrame

col

Column name

TYPE: str

RETURNS DESCRIPTION
bool

Result

Examples:

import laktory  # noqa: F401
import polars as pl

df = pl.DataFrame(
    {
        "indexx": [1, 2, 3],
        "stock": [
            {"symbol": "AAPL", "name": "Apple"},
            {"symbol": "MSFT", "name": "Microsoft"},
            {"symbol": "GOOGL", "name": "Google"},
        ],
        "prices": [
            [{"open": 1, "close": 2}, {"open": 1, "close": 2}],
            [{"open": 1, "close": 2}, {"open": 1, "close": 2}],
            [{"open": 1, "close": 2}, {"open": 1, "close": 2}],
        ],
    }
)

print(df.laktory.has_column("symbol"))
# > False
print(df.laktory.has_column("`stock`.`symbol`"))
# > True
print(df.laktory.has_column("`prices[2]`.`close`"))
# > True
Source code in laktory/polars/dataframe/has_column.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def has_column(df: pl.DataFrame, col: str) -> bool:
    """
    Check if column `col` exists in `df`

    Parameters
    ----------
    df:
        Input DataFrame
    col
        Column name

    Returns
    -------
    :
        Result

    Examples
    --------

    ```py
    import laktory  # noqa: F401
    import polars as pl

    df = pl.DataFrame(
        {
            "indexx": [1, 2, 3],
            "stock": [
                {"symbol": "AAPL", "name": "Apple"},
                {"symbol": "MSFT", "name": "Microsoft"},
                {"symbol": "GOOGL", "name": "Google"},
            ],
            "prices": [
                [{"open": 1, "close": 2}, {"open": 1, "close": 2}],
                [{"open": 1, "close": 2}, {"open": 1, "close": 2}],
                [{"open": 1, "close": 2}, {"open": 1, "close": 2}],
            ],
        }
    )

    print(df.laktory.has_column("symbol"))
    # > False
    print(df.laktory.has_column("`stock`.`symbol`"))
    # > True
    print(df.laktory.has_column("`prices[2]`.`close`"))
    # > True
    ```
    """
    _col = re.sub(r"\[(\d+)\]", r"[*]", col)
    _col = re.sub(r"`", "", _col)
    return _col in df.laktory.schema_flat()