Df validation

Submodules

Classes

DataFrameValidation

ColumnValidation

ValidationRequirement

Package Contents

class DataFrameValidation(df, label, columns_validations, required_columns=None)
Parameters:
  • df (pandas.DataFrame)

  • label (str)

  • columns_validations (List[Columnvalidation])

  • required_columns (List[str])

label: str
df: pandas.DataFrame
required_columns: List[str] | None = None
columns_validations: List[Columnvalidation]
df_failures: pandas.DataFrame | None = None
_run_required_columns()
Return type:

pandas.DataFrame

_run_column_validation()
Return type:

pandas.DataFrame

run()
to_excel(directory)
Parameters:

directory (str)

Return type:

Optional[str]

class ColumnValidation(column_name, requirements)
Parameters:
column_name
requirements
class ValidationRequirement(requirement, failure_msg, filters=None, stop_validation_on_failure=False)
Parameters:
  • requirement (Callable[[pandas.Series], pandas.Series])

  • failure_msg (str)

  • filters (Optional[Callable[[pandas.DataFrame], pandas.Series]])

  • stop_validation_on_failure (bool)

requirement
filters = None
failure_msg
stop_validation_on_failure: bool = False
validate(df, column)
Parameters:
  • df (pandas.DataFrame)

  • column (str)

Return type:

pandas.DataFrame