pandera.api.pandas.model.DataFrameModelΒΆ
- class pandera.api.pandas.model.DataFrameModel(*args, **kwargs)[source]ΒΆ
Model of a pandas
DataFrameSchema
.new in 0.5.0
Important
This class is the new name for
SchemaModel
, which will be deprecated in pandera version0.20.0
.See the User Guide for more.
Validate a DataFrame based on the schema specification.
- Parameters:
check_obj (pd.DataFrame) β the dataframe to be validated.
head β validate the first n rows. Rows overlapping with tail or sample are de-duplicated.
tail β validate the last n rows. Rows overlapping with head or sample are de-duplicated.
sample β validate a random sample of n rows. Rows overlapping with head or tail are de-duplicated.
random_state β random seed for the
sample
argument.lazy β if True, lazily evaluates dataframe against all validation checks and raises a
SchemaErrors
. Otherwise, raiseSchemaError
as soon as one occurs.inplace β if True, applies coercion to the object of validation, otherwise creates a copy of the data.
- Returns:
validated
DataFrame
- Raises:
SchemaError β when
DataFrame
violates built-in or custom checks.
Methods
- rtype:
Serialize schema metadata into json-schema format.