httk.core.register.schemas

Schema and definition resource registries.

Functions

register_entry_type_definition(*, definition_id, resource)	Register one resource for an entry-type definition IRI.
known_entry_type_definitions()	Return registered entry-type definition IRIs.
register_property_definition(*, definition_id, resource)	Register one resource for a property definition IRI.
known_property_definitions()	Return registered property definition IRIs.
load_entry_type_definition(definition_id)	Load and verify a registered entry-type definition resource.
load_property_definition(definition_id)	Load and verify a registered property definition resource.

Module Contents

httk.core.register.schemas.register_entry_type_definition(*, definition_id, resource)

Register one resource for an entry-type definition IRI.

Parameters:

• definition_id (str) – The entry-type definition IRI.

• resource (str) – The package resource reference to load.

Raises:

ValueError – If definition_id is already registered.

httk.core.register.schemas.known_entry_type_definitions()

Return registered entry-type definition IRIs.

Returns:

Registered entry-type definition identifiers.

Return type:

list[str]

httk.core.register.schemas.register_property_definition(*, definition_id, resource)

Register one resource for a property definition IRI.

Parameters:

• definition_id (str) – The property definition IRI.

• resource (str) – The package resource reference to load.

Raises:

ValueError – If definition_id is already registered.

httk.core.register.schemas.known_property_definitions()

Return registered property definition IRIs.

Returns:

Registered property definition identifiers.

Return type:

list[str]

httk.core.register.schemas.load_entry_type_definition(definition_id)

Load and verify a registered entry-type definition resource.

Parameters:

definition_id (str) – The registered entry-type definition IRI.

Returns:

The loaded and validated entry-type definition.

Raises:

ValueError – If the IRI is unregistered or disagrees with the document.

Return type:

httk.core.property_definitions.EntryTypeDefinition

httk.core.register.schemas.load_property_definition(definition_id)

Load and verify a registered property definition resource.

Parameters:

definition_id (str) – The registered property definition IRI.

Returns:

The loaded and validated property definition.

Raises:

ValueError – If the IRI is unregistered or disagrees with the document.

Return type:

httk.core.property_definitions.PropertyDefinition