polars.datatypes.Categorical#

class polars.datatypes.Categorical(ordering: CategoricalOrdering | None = 'physical')[source]#

A categorical encoding of a set of strings.

Parameters:
ordering{‘lexical’, ‘physical’}

Ordering by order of appearance ('physical', default) or string value ('lexical').

__init__(ordering: CategoricalOrdering | None = 'physical') None[source]#

Methods

__init__([ordering])

base_type()

Return this DataType's fundamental/root type class.

from_python(py_type)

Return the Polars data type corresponding to a given Python type.

is_(other)

Check if this DataType is the same as another DataType.

is_decimal()

Check whether the data type is a decimal type.

is_float()

Check whether the data type is a floating point type.

is_integer()

Check whether the data type is an integer type.

is_nested()

Check whether the data type is a nested type.

is_numeric()

Check whether the data type is a numeric type.

is_signed_integer()

Check whether the data type is a signed integer type.

is_temporal()

Check whether the data type is a temporal type.

is_unsigned_integer()

Check whether the data type is an unsigned integer type.

to_python()

Return the Python type corresponding to this Polars data type.

Attributes

ordering