Danger

You are looking at the documentation for an older version of the SDV! We are no longer supporting or maintaining this version of the software

Click here to go to the new docs pages.

sdv.constraints.Constraint

class sdv.constraints.Constraint(*args, **kwargs)[source]

Constraint base class.

This class is not intended to be used directly and should rather be subclassed to create different types of constraints.

constraint_columns

The names of the columns used by this constraint.

Type

tuple[str]

rebuild_columns

The names of the columns that this constraint will rebuild during reverse_transform.

Type

tuple[str]

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(*args, **kwargs)

Initialize self.

filter_valid(table_data)

Get only the rows that are valid.

fit(table_data)

Fit Constraint class to data.

fit_transform(table_data)

Fit this Constraint to the data and then transform it.

from_dict(constraint_dict)

Build a Constraint object from a dict.

is_valid(table_data)

Say whether the given table rows are valid.

reverse_transform(table_data)

Handle logic around reverse transforming constraints.

to_dict()

Return a dict representation of this Constraint.

transform(table_data)

Perform necessary transformations needed by constraint.

Attributes

constraint_columns