Capabilities / Canonical Object

CanonicalGeometryCapability

class teksi_hooks.capabilities.canonical_object.CanonicalGeometryCapability(metadata)[source]

Metadata-driven helper for identifying canonical geometry attributes.

Geometry identification is derived solely from canonical attribute metadata rather than naming conventions.

Parameters:: metadata (CanonicalModelMetadata)

is_geometry_attribute(class_id, attribute_id)[source]

Return whether a canonical attribute represents geometry.

Parameters:

class_id (str)
attribute_id (str)

Return type:

bool

geometry_attribute_names(class_id)[source]

Return canonical geometry attribute identifiers for a class.

Parameters:: class_id (str)
Return type:: tuple[str, …]

Fields

metadata: Type: CanonicalModelMetadata

InMemoryCanonicalModelCapability

class teksi_hooks.capabilities.canonical_object.InMemoryCanonicalModelCapability(metadata)[source]

In-memory canonical model metadata provider.

Useful for tests, examples and offline workflows.

Parameters:: metadata (CanonicalModelMetadata)

canonical_model()[source]

Return complete canonical model metadata.

Return type:: CanonicalModelMetadata

classes()[source]

Return class metadata keyed by class_id.

Return type:: dict[str, CanonicalClassMetadata]

attributes(class_id=None)[source]

Return attribute metadata keyed by (class_id, attribute_id).

Parameters:: class_id (str | None)
Return type:: dict[tuple[str, str], CanonicalAttributeMetadata]

values(class_id=None, attribute_id=None)[source]

Return value metadata keyed by (class_id, attribute_id, value_id).

Parameters:

class_id (str | None)
attribute_id (str | None)

Return type:

dict[tuple[str, str, str], CanonicalValueMetadata]

class_metadata(class_id)[source]

Return metadata for one class.

Parameters:: class_id (str)
Return type:: CanonicalClassMetadata | None

attribute_metadata(class_id, attribute_id)[source]

Return metadata for one attribute.

Parameters:

class_id (str)
attribute_id (str)

Return type:

CanonicalAttributeMetadata | None

value_metadata(class_id, attribute_id, value_id)[source]

Return metadata for one value.

Parameters:

class_id (str)
attribute_id (str)
value_id (str)

Return type:

CanonicalValueMetadata | None

Base class: CanonicalModelCapability

Fields

metadata: Type: CanonicalModelMetadata