zarr_vectors

zarr-vectors: Python utilities for the Zarr Vectors (ZV) format.

Cloud-native storage for points, lines, streamlines, graphs, and meshes built on Zarr v3.

The flat top-level namespace. Importing zarr_vectors re-exports the whole Data API surface — Dataset, Level, Query, Selection, ReadResult, Schema, Layout, Grid, ObjectCatalog, EditPlan, and the open / create entry-points — so zarr_vectors.open(...) and zarr_vectors.api.open(...) are the same object under two names.

Those names are documented once, on the page that carries the reasoning for them: Data API for reading, querying and editing stores, and Building stores for tools that create them. zarr_vectors.building is the same module as the one documented there.

What is left below is the handful of names that exist only at the top level: they answer questions about the installed package rather than about a store.

zarr_vectors.stability(module)

Which tier module (or anything under it) is in.

Parameters:

module (str) – A dotted module name, e.g. "zarr_vectors.core.arrays".

Raises:

KeyError – If nothing in the manifest covers it — which means a module was added without being classified, not that the caller asked wrongly.

Return type:

Literal[‘supported’, ‘internal’, ‘undecided’]

zarr_vectors.require_api(spec='', *, features=())

Raise unless this build’s API surface satisfies spec.

Parameters:

• spec (str) – Comma-separated >=/>/<=/</== clauses against __api_version__, e.g. ">=1.0". Empty checks only features.

• features (object) – Feature names from FEATURES that must all be present. Prefer these to a version range: they say what the caller needs rather than when it happened to land.

Raises:

ImportError – If the requirement is not met. ImportError rather than a ZVError because the failure is “this build does not have what I import”, and that is what a caller’s dependency handling already catches.

Return type:

None

zarr_vectors.FEATURES = frozenset({'coarsen-strategy-options', 'presence-rebuild', 'query-cells', 'selection-level-optional', 'sharded-presence-guard', 'surfaces', 'vertex-attributes-on-read'})

frozenset() -> empty frozenset object frozenset(iterable) -> frozenset object

Build an immutable unordered collection of unique elements.