Data Types#

class checkedframe._dtypes.Array(inner: _DType, shape: int | tuple[int, ...], *, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Binary(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Boolean(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Categorical(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.CfUnion(*columns: TypedColumn | Iterable[TypedColumn])#

Union type.

Examples

import checkedframe as cf
import polars as pl

class S(cf.Schema):
    by_var = cf.Union(cf.Boolean(), cf.Int64(cast=True))


df = pl.DataFrame({"by_var": [1.0, 5.0]})
S.validate(df)

Output:

class checkedframe._dtypes.Date(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Datetime(time_unit: TimeUnit = 'us', time_zone: str | timezone | None = None, *, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Decimal(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Duration(time_unit: TimeUnit = 'us', *, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Enum(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Float32(*, name: str | None = None, nullable: bool = False, allow_nan: bool = False, allow_inf: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Float64(*, name: str | None = None, nullable: bool = False, allow_nan: bool = False, allow_inf: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Int128(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Int16(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Int32(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Int64(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Int8(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.List(inner: _DType, *, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Object(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.String(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Struct(fields: Mapping[str, _DType], *, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.TypedColumn(name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.UInt128(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.UInt16(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.UInt32(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.UInt64(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.UInt8(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#

class checkedframe._dtypes.Unknown(*, name: str | None = None, nullable: bool = False, required: bool = True, cast: bool = False, checks: Iterable[Check] | None = None)#