Settings¶

with_name(name: str | None) → Self

Add a name to the valid frame object.

with_columns_policy(*, ordered: bool = False, ...) → Self

Frame wide rules for columns.

Information¶

with_info(*, title: str | None = None, ...) → Self

Add info to the valid frame object.

Transformations¶

transform(data: IntoValidation, *, ...) → TransformFrameTree

Applies the specified transformation and returns the transformed target data tree.

Export¶

serialize(**kwargs: Any) → str

Serialize the object to JSON string.

Validation¶

validate(data, ...) → FrameLike | ValidationError | None

Validate the target data using the validator.

Methods¶

gather_predicates(target: pl.Schema | None = None) → list[pl.Expr]

Gather all the set rules as predicate expressions.