Skip to content

data_types

This module contains the metadata (and other) models that are used in the kiara_plugin.core_types package.

Those models are convenience wrappers that make it easier for kiara to find, create, manage and version metadata -- but also other type of models -- that is attached to data, as well as kiara modules.

Metadata models must be a sub-class of [kiara.metadata.MetadataModel][]. Other models usually sub-class a pydantic BaseModel or implement custom base classes.

Classes

DictModel

Bases: BaseModel, Mapping

A dict implentation that contains (optional) schema information of the dicts items.

Source code in kiara/models/data_types.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
class DictModel(BaseModel, Mapping):
    """A dict implentation that contains (optional) schema information of the dicts items."""

    class Config:
        json_loads = orjson.loads
        json_dumps = orjson_dumps

    dict_data: Dict[str, Any] = Field(description="The data.")
    data_schema: Dict[str, Any] = Field(description="The schema.")
    python_class: PythonClass = Field(
        description="The python class of which model instances are created. This is mostly meant as a hint for client applications."
    )

    _size_cache: int = PrivateAttr(default=None)
    _hash_cache: int = PrivateAttr(default=None)
    _data_hash: int = PrivateAttr(default=None)
    _schema_hash: int = PrivateAttr(default=None)
    _value_hash: int = PrivateAttr(default=None)

    @property
    def size(self):
        if self._size_cache is not None:
            return self._size_cache

        self._size_cache = len(self.dict_data) + len(self.data_schema)
        return self._size_cache

    @property
    def data_hash(self) -> int:
        if self._data_hash is not None:
            return self._data_hash

        self._data_hash = compute_cid(self.dict_data)
        return self._data_hash

    @property
    def schema_hash(self) -> int:
        if self._schema_hash is not None:
            return self._schema_hash

        self._schema_hash = compute_cid(self.data_schema)
        return self._schema_hash

    @property
    def value_hash(self) -> int:
        if self._value_hash is not None:
            return self._value_hash

        obj = {"data": self.data_hash, "data_schema": self.schema_hash}
        self._value_hash = compute_cid(obj)
        return self._value_hash

    def __getitem__(self, item):
        return self.dict_data.__getitem__(item)

    def __iter__(self):
        return self.dict_data.__iter__()

    def __len__(self):
        return self.dict_data.__len__()

Attributes

dict_data: Dict[str, Any] = Field(description='The data.') class-attribute
data_schema: Dict[str, Any] = Field(description='The schema.') class-attribute
python_class: PythonClass = Field(description='The python class of which model instances are created. This is mostly meant as a hint for client applications.') class-attribute
size property
data_hash: int property
schema_hash: int property
value_hash: int property

Classes

Config
Source code in kiara/models/data_types.py 
25
26
27
class Config:
    json_loads = orjson.loads
    json_dumps = orjson_dumps
Attributes
json_loads = orjson.loads class-attribute
json_dumps = orjson_dumps class-attribute

Functions