API Documentation¶
Validation¶
This is the main module of the package. It contains functions for schema generation and data validation.
- filter_column_schemas_by_keys(keys: list[str], column_schemas: dict) dict¶
- filter_dict_by_keys(keys: list[str], d: dict) dict¶
- gen_coercion_schema(cerb_schema: dict) dict¶
- generate_validation_schema(parts: list[dict], sets: list[dict] = [], schema_version: str = '3.0.1', schema_additions: dict = {}) dict¶
- validate_data(schema: dict, data: dict[str, list[dict]], data_kind: DataKind = DataKind.python, data_version: str = '3.0.1', rule_blacklist: list[RuleId] = []) ValidationReport¶
- Parameters:
rule_blacklist – A list of rule ids to explicitly disable.
Utils¶
- export_yaml_file(data: dict, path: str) None¶
- get_asset_dir() str¶
- get_pkg_dir() str¶
returns the actual pkg. dir or /src/odm_validation/ if in dev. env.
- import_csv_file(path: str) list[dict]¶
- import_dataset(path: str) list[dict]¶
- import_json_file(path: str) dict¶
- import_yaml_file(path: str) dict¶
