dataio.validate.contracts.models¶
Module Contents¶
Classes¶
API¶
- class dataio.validate.contracts.models.DatasetKind[source]¶
Bases:
enum.StrEnum- TABULAR¶
‘tabular’
- GEOJSON¶
‘geojson’
- class dataio.validate.contracts.models.ManifestField(/, **data: typing.Any)[source]¶
Bases:
pydantic.BaseModel- model_config¶
‘ConfigDict(…)’
- type: str¶
None
- description: str | None¶
None
- nullable: bool¶
True
- format: str | None¶
None
- allowedValues: list[Any] | None¶
None
- enumRef: str | None¶
None
- range: list[float] | None¶
None
- min: float | None¶
None
- max: float | None¶
None
- comments: str | list[str] | None¶
None
- validate_contract() dataio.validate.contracts.models.ManifestField[source]¶
- class dataio.validate.contracts.models.ManifestTable(/, **data: typing.Any)[source]¶
Bases:
pydantic.BaseModel- model_config¶
‘ConfigDict(…)’
- description: str | None¶
None
- path: str | None¶
None
- required: bool¶
True
- dataDictionary: dict[str, dataio.validate.contracts.models.ManifestField]¶
‘Field(…)’
- class dataio.validate.contracts.models.EnumValueDefinition(/, **data: typing.Any)[source]¶
Bases:
pydantic.BaseModel- model_config¶
‘ConfigDict(…)’
- description: str | None¶
None
- class dataio.validate.contracts.models.EnumDefinition(/, **data: typing.Any)[source]¶
Bases:
pydantic.BaseModel- model_config¶
‘ConfigDict(…)’
- description: str | None¶
None
- values: dict[str, dataio.validate.contracts.models.EnumValueDefinition]¶
‘Field(…)’
- class dataio.validate.contracts.models.DatasetManifest(/, **data: typing.Any)[source]¶
Bases:
pydantic.BaseModel- model_config¶
‘ConfigDict(…)’
- metadataSpecVersion: str¶
None
- datasetTitle: str¶
None
- datasetSlug: str¶
None
- datasetDescription: str¶
None
- source: Any¶
None
- category: dict[str, Any]¶
None
- collection: dict[str, Any]¶
None
- datasetID: str | None¶
None
- datasetKind: dataio.validate.contracts.models.DatasetKind¶
None
- datasetTables: dict[str, dataio.validate.contracts.models.ManifestTable]¶
‘Field(…)’
- enumDefinitions: dict[str, dataio.validate.contracts.models.EnumDefinition]¶
‘Field(…)’
- specs: list[str]¶
‘Field(…)’
- validate_shape() dataio.validate.contracts.models.DatasetManifest[source]¶
- class dataio.validate.contracts.models.ValidationRequest(/, **data: typing.Any)[source]¶
Bases:
pydantic.BaseModel- model_config¶
‘ConfigDict(…)’
- dataset_kind: dataio.validate.contracts.models.DatasetKind¶
None
- manifest_source: str | bytes | dict[str, Any] | dataio.validate.contracts.models.DatasetManifest¶
None
- data: str | bytes | dict[str, Any] | None¶
None
- data_files: dict[str, str]¶
‘Field(…)’
- enabled_specs: list[str]¶
‘Field(…)’
- strict: bool¶
False
- deep_check: bool¶
False
- validate_data: bool¶
True
- full_scan: bool¶
True
- max_rows: int | None¶
None
- extra_column_policy: Literal[warn, error, ignore]¶
‘warn’