signature

laktory.polars.dataframe.signature

FUNCTION	DESCRIPTION
signature	Returns DataFrame signature.

Functions

signature

signature(df)

Returns DataFrame signature.

PARAMETER	DESCRIPTION
df	Input DataFrame TYPE: DataFrame

RETURNS	DESCRIPTION
str	Result
```py
import laktory # noqa: F401
import polars as pl
df = pl.DataFrame({"x": [1, 2, 3], "label": ["a", "b", "c"]})
print(signature())
# > DataFrame[x: Int64, label: String]
```

Source code in laktory/polars/dataframe/signature.py

def signature(df: pl.DataFrame) -> str:
    """
    Returns DataFrame signature.

    Parameters
    ----------
    df:
        Input DataFrame

    Returns
    -------
    :
        Result

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

    df = pl.DataFrame({"x": [1, 2, 3], "label": ["a", "b", "c"]})
    print(df.laktory.signature())
    # > DataFrame[x: Int64, label: String]
    ```

    """

    s = ", ".join([f"{k}: {v}" for k, v in df.schema.items()])
    s = f"DataFrame[{s}]"
    return s