Schemas¶

To access bundled schemas within your project:

Create a retrieval callable using bundled_schemas_retriever().
Pass this callable when instantiating referencing.Registry

All bundled schemas will be available through the registry, using the base URI BUNDLED_SCHEMAS_URI_BASE. If you’d like to access them by a different base URI, you can use RetrievalURITranslator.

Basic example:

from typing import Any

from jsonschema import Validator
from jsonschema_extras import bundled_schemas_retriever
from referencing import Registry

your_schema: Any

with bundled_schemas_retriever() as retrieve:
    registry = Registry(retrieve=retrieve)
    validator = Validator(your_schema, registry=registry)
    # use validator

Chaining multiple retrievers:

Use RetrieversChain to combine multiple retrieval callables.

from jsonschema_extras import RetrieversChain, bundled_schemas_retriever
from referencing import Registry
from referencing.typing import Retrieve

retrieve_custom: Retrieve

with bundled_schemas_retriever() as retrieve_bundled_schemas:
    registry = Registry(
        retrieve=RetrieversChain(
            retrieve_custom, retrieve_bundled_schemas,
        ),
    )
    validator = Validator(your_schema, registry=registry)
    # use validator