Core

momapy_kb.core

Core data models for momapy_kb.

Provides CollectionEntry and Collection dataclasses for organizing maps into named collections.

Classes:

Name	Description
Collection	A named collection of map entries.
CollectionEntry	A single entry in a collection.

Collection dataclass

Collection(name: str, entries: frozenset[CollectionEntry] = frozenset())

A named collection of map entries.

Attributes:

Name	Type	Description
name	str	The collection name.
entries	frozenset[CollectionEntry]	The entries in this collection.

CollectionEntry dataclass

CollectionEntry(id_: str, obj: Map | Model | Layout, element_to_annotations: frozendict | None = None, id_to_element: frozendict | None = None, file_path: str | None = None, source_id_to_model_element: FrozenIdentityMultiDict | None = None, source_id_to_layout_element: FrozenSurjectionDict | None = None, element_to_notes: frozendict | None = None)

A single entry in a collection.

Attributes:

Name	Type	Description
id_	str	Unique identifier for this entry.
obj	Map | Model | Layout	The momapy map, model, or layout object.
element_to_annotations	frozendict | None	Optional mapping from map elements to their annotations.
id_to_element	frozendict | None	Optional mapping from momapy element IDs to elements.
file_path	str | None	Optional path to the source file.
source_id_to_model_element	FrozenIdentityMultiDict | None	Optional mapping from source file IDs to model elements.
source_id_to_layout_element	FrozenSurjectionDict | None	Optional mapping from source file IDs to layout elements.
element_to_notes	frozendict | None	Optional mapping from map elements to their notes.