.. This page is generated by scripts/generate_dataclass_docs.py. Do not edit manually. Models / Canonical Object ========================= .. automodule:: teksi_hooks.models.canonical_object CanonicalAttributeMetadata -------------------------- .. autoclass:: teksi_hooks.models.canonical_object.CanonicalAttributeMetadata :members: Base class: ``CanonicalModelElementMetadata`` Fields ~~~~~~ ``source_id`` Type: ``int`` Numeric source identifier, i.e. from the corresponding sys dictionary table. The meaning is scoped by the concrete metadata level. ``identifier`` Type: ``str`` Canonical string identifier for this model element. The meaning is scoped by the concrete metadata level. ``localized`` Type: ``LocalizedMetadata`` Localized technical names for this model element. ``field_datatype`` Type: ``str | None`` Source field datatype from canonical metadata. For TEKSI Wastewater dictionary metadata this corresponds to txx_sys.dictionary_od_field.field_datatype. Geometry attributes are identified with field_datatype='geometry'. CanonicalClassMetadata ---------------------- .. autoclass:: teksi_hooks.models.canonical_object.CanonicalClassMetadata :members: Base class: ``CanonicalModelElementMetadata`` Fields ~~~~~~ ``source_id`` Type: ``int`` Numeric source identifier, i.e. from the corresponding sys dictionary table. The meaning is scoped by the concrete metadata level. ``identifier`` Type: ``str`` Canonical string identifier for this model element. The meaning is scoped by the concrete metadata level. ``localized`` Type: ``LocalizedMetadata`` Localized technical names for this model element. CanonicalIdentityMapping ------------------------ .. autoclass:: teksi_hooks.models.canonical_object.CanonicalIdentityMapping :members: Fields ~~~~~~ ``source_attribute`` Type: ``str`` Source object identity. ``canonical_attribute`` Type: ``str`` Canonical object identity. CanonicalModelElementMetadata ----------------------------- .. autoclass:: teksi_hooks.models.canonical_object.CanonicalModelElementMetadata :members: Fields ~~~~~~ ``source_id`` Type: ``int`` Numeric source identifier, i.e. from the corresponding sys dictionary table. The meaning is scoped by the concrete metadata level. ``identifier`` Type: ``str`` Canonical string identifier for this model element. The meaning is scoped by the concrete metadata level. ``localized`` Type: ``LocalizedMetadata`` Localized technical names for this model element. CanonicalModelMetadata ---------------------- .. autoclass:: teksi_hooks.models.canonical_object.CanonicalModelMetadata :members: Fields ~~~~~~ ``classes`` Type: ``dict[str, CanonicalClassMetadata]`` Class metadata keyed by canonical class_id. ``attributes`` Type: ``dict[tuple[str, str], CanonicalAttributeMetadata]`` Attribute metadata keyed by (class_id, attribute_id). ``values`` Type: ``dict[tuple[str, str, str], CanonicalValueMetadata]`` Value metadata keyed by (class_id, attribute_id, value_id). CanonicalObject --------------- .. autoclass:: teksi_hooks.models.canonical_object.CanonicalObject :members: Fields ~~~~~~ ``identity`` Type: ``CanonicalObjectIdentity`` Canonical object identity. ``values`` Type: ``Mapping[str, Any]`` Canonical attribute values. ``last_modification`` Type: ``datetime | None`` Last modification snapshot. CanonicalObjectIdentity ----------------------- .. autoclass:: teksi_hooks.models.canonical_object.CanonicalObjectIdentity :members: Fields ~~~~~~ ``class_id`` Type: ``str`` Canonical class identifier. ``attributes`` Type: ``Mapping[str, Any]`` Attributes uniquely identifying the object. CanonicalValueMetadata ---------------------- .. autoclass:: teksi_hooks.models.canonical_object.CanonicalValueMetadata :members: Base class: ``CanonicalModelElementMetadata`` Fields ~~~~~~ ``source_id`` Type: ``int`` Numeric source identifier, i.e. from the corresponding sys dictionary table. The meaning is scoped by the concrete metadata level. ``identifier`` Type: ``str`` Canonical string identifier for this model element. The meaning is scoped by the concrete metadata level. ``localized`` Type: ``LocalizedMetadata`` Localized technical names for this model element. LocalizedMetadata ----------------- .. autoclass:: teksi_hooks.models.canonical_object.LocalizedMetadata :members: Fields ~~~~~~ ``names`` Type: ``dict[str, str]`` Localized technical names keyed by language code. Examples: {'de': 'Absperr_Drosselorgan'}, {'fr': '...'}. ``display_names`` Type: ``dict[str, str]`` Localized technical names keyed by language code. Examples: {'de': 'Absperr_Drosselorgan'}, {'fr': '...'}.