Skip to content

Column Constraints API

MeanBetween

ydata.constraints.columns.constraint.MeanBetween

Bases: Interval

StandardDeviationBetween

ydata.constraints.columns.constraint.StandardDeviationBetween

Bases: Interval

QuantileBetween

ydata.constraints.columns.constraint.QuantileBetween

Bases: Interval

MinBetween

ydata.constraints.columns.constraint.MinBetween

Bases: Interval

Check that the minimum value of a column falls inside [lower_bound, upper_bound].

Parameters:

Name Type Description Default
lower_bound int | float

Minimum allowed column minimum.

required
upper_bound int | float

Maximum allowed column minimum.

required
columns str | list[str] | None

Column(s) to check.

None

MaxBetween

ydata.constraints.columns.constraint.MaxBetween

Bases: Interval

Check that the maximum value of a column falls inside [lower_bound, upper_bound].

Parameters:

Name Type Description Default
lower_bound int | float

Minimum allowed column maximum.

required
upper_bound int | float

Maximum allowed column maximum.

required
columns str | list[str] | None

Column(s) to check.

None

NullRateLowerThan

ydata.constraints.columns.constraint.NullRateLowerThan

Bases: LowerThan

Check that the proportion of null values in a column is below a threshold.

Unlike :class:NullValuesCountLowerThan, which requires knowing the absolute count, this constraint uses a rate in [0, 1] and therefore works regardless of dataset size.

Parameters:

Name Type Description Default
value float

Maximum allowed null rate (exclusive), e.g. 0.05 for 5 %.

required
columns str | list[str] | None

Column(s) to check.

None

NullValuesCountLowerThan

ydata.constraints.columns.constraint.NullValuesCountLowerThan

Bases: LowerThan

UniqueValuesBetween

ydata.constraints.columns.constraint.UniqueValuesBetween

Bases: Interval

Constant

ydata.constraints.columns.constraint.Constant

Bases: Interval

SumLowerThan

ydata.constraints.columns.constraint.SumLowerThan

Bases: LowerThan

Interval

ydata.constraints.columns.constraint.Interval

Bases: ColumnConstraint

Check that check(column) falls inside [lower_bound, upper_bound].

Unlike the old implementation this class is not a subclass of ColumnCustomConstraint — it owns its validate directly, so there is no three-level closure chain to follow.

Equal

ydata.constraints.columns.constraint.Equal

Bases: Interval

GreaterThan

ydata.constraints.columns.constraint.GreaterThan

Bases: Interval

LowerThan

ydata.constraints.columns.constraint.LowerThan

Bases: Interval

ColumnCustomConstraint

ydata.constraints.columns.constraint.ColumnCustomConstraint

Bases: ColumnConstraint

Apply a user-supplied callable to each requested column and check the result falls inside a pd.Interval.

The callable receives the full column Series and must return a scalar.