Validation¶

Five-level conformance validator for ZVF stores. See Validation overview for a full description of each level.

Unified validation — runs levels 1–5 cumulatively.

zarr_vectors.validate.validate(store_path, *, level=3)[source]¶

Validate a zarr vectors store at the specified conformance level (1–5).

Parameters:

store_path (str | Path)
level (int)

Return type:

ValidationResult

ValidationResult¶

class zarr_vectors.validate.ValidationResult(level, passed=<factory>, warnings=<factory>, errors=<factory>)[source]¶

Bases: object

Accumulated validation outcome.

Parameters:

level (int)
passed (list[str])
warnings (list[str])
errors (list[str])

__init__(level, passed=<factory>, warnings=<factory>, errors=<factory>)¶

Parameters:

level (int)
passed (list[str])
warnings (list[str])
errors (list[str])

Return type:

None

add_error(msg)[source]¶

Parameters:: msg (str)
Return type:: None

add_pass(msg)[source]¶

Parameters:: msg (str)
Return type:: None

add_warning(msg)[source]¶

Parameters:: msg (str)
Return type:: None

errors: list[str]¶

level: int¶

merge(other)[source]¶

Parameters:: other (ValidationResult)
Return type:: None

property ok: bool¶

passed: list[str]¶

summary()[source]¶

Return type:: str

warnings: list[str]¶

Check¶

Individual validation modules¶

Level 1 structural validation — verify the store layout on disk.

class zarr_vectors.validate.structure.ValidationResult(level, passed=<factory>, warnings=<factory>, errors=<factory>)[source]¶

Bases: object

Accumulated validation outcome.

Parameters:

level (int)
passed (list[str])
warnings (list[str])
errors (list[str])

__init__(level, passed=<factory>, warnings=<factory>, errors=<factory>)¶

Parameters:

level (int)
passed (list[str])
warnings (list[str])
errors (list[str])

Return type:

None

add_error(msg)[source]¶

Parameters:: msg (str)
Return type:: None

add_pass(msg)[source]¶

Parameters:: msg (str)
Return type:: None

add_warning(msg)[source]¶

Parameters:: msg (str)
Return type:: None

errors: list[str]¶

level: int¶

merge(other)[source]¶

Parameters:: other (ValidationResult)
Return type:: None

property ok: bool¶

passed: list[str]¶

summary()[source]¶

Return type:: str

warnings: list[str]¶

zarr_vectors.validate.structure.validate_structure(store_path)[source]¶

Level 1: verify store directory layout.

Parameters:: store_path (str | Path)
Return type:: ValidationResult

Level 2 metadata validation — verify metadata is well-formed.

zarr_vectors.validate.metadata.validate_metadata(store_path)[source]¶

Level 2: verify all metadata is well-formed.

Parameters:: store_path (str | Path)
Return type:: ValidationResult

Level 3 consistency validation — verify data arrays are internally consistent.

zarr_vectors.validate.consistency.validate_consistency(store_path)[source]¶

Level 3: verify internal data consistency.

Parameters:: store_path (str | Path)
Return type:: ValidationResult