cognite-neat 0.75.9__py3-none-any.whl → 0.76.1__py3-none-any.whl

cognite/neat/rules/models/wrapped_entities.py

@@ -0,0 +1,166 @@
+from abc import ABC, abstractmethod
+from collections.abc import Collection
+from functools import total_ordering
+from typing import Any, ClassVar, TypeVar
+
+from cognite.client import data_modeling as dm
+from cognite.client.data_classes.data_modeling import ContainerId, NodeId
+from pydantic import BaseModel, model_serializer, model_validator
+
+from cognite.neat.rules.models.entities import ContainerEntity, DMSNodeEntity, Entity
+
+
+@total_ordering
+class WrappedEntity(BaseModel, ABC):
+    name: ClassVar[str]
+    _inner_cls: ClassVar[type[Entity]]
+    inner: list[Entity] | None
+
+    @classmethod
+    def load(cls: "type[T_WrappedEntity]", data: Any) -> "T_WrappedEntity":
+        if isinstance(data, cls):
+            return data
+        return cls.model_validate(data)
+
+    @model_validator(mode="before")
+    def _load(cls, data: Any) -> dict:
+        if isinstance(data, dict):
+            return data
+        elif not isinstance(data, str):
+            raise ValueError(f"Cannot load {cls.__name__} from {data}")
+        elif not data.casefold().startswith(cls.name.casefold()):
+            raise ValueError(f"Expected {cls.name} but got {data}")
+        result = cls._parse(data)
+        return result
+
+    @classmethod
+    def _parse(cls, data: str) -> dict:
+        if data.casefold() == cls.name.casefold():
+            return {"inner": None}
+        inner = data[len(cls.name) :].removeprefix("(").removesuffix(")")
+        return {"inner": [cls._inner_cls.load(entry.strip()) for entry in inner.split(",")]}
+
+    @model_serializer(when_used="unless-none", return_type=str)
+    def as_str(self) -> str:
+        return str(self)
+
+    def __str__(self):
+        return self.id
+
+    @property
+    def id(self) -> str:
+        inner = self.as_tuple()[1:]
+        return f"{self.name}({','.join(inner)})"
+
+    @property
+    def is_empty(self) -> bool:
+        return self.inner is None or (isinstance(self.inner, list) and not self.inner)
+
+    def dump(self) -> str:
+        return str(self)
+
+    def as_tuple(self) -> tuple[str, ...]:
+        entities: list[str] = [str(inner) for inner in self.inner or []]
+        return self.name, *entities
+
+    def __lt__(self, other: object) -> bool:
+        if not isinstance(other, WrappedEntity):
+            return NotImplemented
+        return self.as_tuple() < other.as_tuple()
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, WrappedEntity):
+            return NotImplemented
+        return self.as_tuple() == other.as_tuple()
+
+    def __hash__(self) -> int:
+        return hash(str(self))
+
+    def __repr__(self) -> str:
+        return self.id
+
+
+T_WrappedEntity = TypeVar("T_WrappedEntity", bound=WrappedEntity)
+
+
+class DMSFilter(WrappedEntity):
+    @abstractmethod
+    def as_dms_filter(self, default: Any | None = None) -> dm.filters.Filter:
+        raise NotImplementedError
+
+    @classmethod
+    def from_dms_filter(cls, filter: dm.Filter) -> "DMSFilter":
+        dumped = filter.dump()
+        if (body := dumped.get(dm.filters.Equals._filter_name)) and (value := body.get("value")):
+            space = value.get("space")
+            external_id = value.get("externalId")
+            if space is not None and external_id is not None:
+                return NodeTypeFilter(inner=[DMSNodeEntity(space=space, externalId=external_id)])
+        elif (body := dumped.get(dm.filters.In._filter_name)) and (values := body.get("values")):
+            return NodeTypeFilter(
+                inner=[
+                    DMSNodeEntity(space=entry["space"], externalId=entry["externalId"])
+                    for entry in values
+                    if isinstance(entry, dict) and "space" in entry and "externalId" in entry
+                ]
+            )
+        elif body := dumped.get(dm.filters.HasData._filter_name):
+            return HasDataFilter(
+                inner=[
+                    ContainerEntity(space=entry["space"], externalId=entry["externalId"])
+                    for entry in body
+                    if isinstance(entry, dict) and "space" in entry and "externalId" in entry
+                ]
+            )
+
+        raise ValueError(f"Cannot convert {filter._filter_name} to {cls.__name__}")
+
+
+class NodeTypeFilter(DMSFilter):
+    name: ClassVar[str] = "nodeType"
+    _inner_cls: ClassVar[type[DMSNodeEntity]] = DMSNodeEntity
+    inner: list[DMSNodeEntity] | None = None  # type: ignore[assignment]
+
+    @property
+    def nodes(self) -> list[NodeId]:
+        return [node.as_id() for node in self.inner or []]
+
+    def as_dms_filter(self, default: Collection[NodeId] | None = None) -> dm.Filter:
+        if self.inner is not None:
+            node_ids = [node.as_id() for node in self.inner]
+        elif default is not None:
+            node_ids = list(default)
+        else:
+            raise ValueError("Empty nodeType filter, please provide a default node.")
+        if len(node_ids) == 1:
+            return dm.filters.Equals(
+                ["node", "type"], {"space": node_ids[0].space, "externalId": node_ids[0].external_id}
+            )
+        else:
+            return dm.filters.In(
+                ["node", "type"],
+                [
+                    {"space": node.space, "externalId": node.external_id}
+                    for node in sorted(node_ids, key=lambda node: node.as_tuple())
+                ],
+            )
+
+
+class HasDataFilter(DMSFilter):
+    name: ClassVar[str] = "hasData"
+    _inner_cls: ClassVar[type[ContainerEntity]] = ContainerEntity
+    inner: list[ContainerEntity] | None = None  # type: ignore[assignment]
+
+    def as_dms_filter(self, default: Collection[ContainerId] | None = None) -> dm.Filter:
+        containers: list[ContainerId]
+        if self.inner:
+            containers = [container.as_id() for container in self.inner]
+        elif default:
+            containers = list(default)
+        else:
+            raise ValueError("Empty hasData filter, please provide a default containers.")
+
+        return dm.filters.HasData(
+            # Sorting to ensure deterministic order
+            containers=sorted(containers, key=lambda container: container.as_tuple())  # type: ignore[union-attr]
+        )

{cognite_neat-0.75.9.dist-info → cognite_neat-0.76.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cognite-neat
-Version: 0.75.9
+Version: 0.76.1
 Summary: Knowledge graph transformation
 Home-page: https://cognite-neat.readthedocs-hosted.com/
 License: Apache-2.0

{cognite_neat-0.75.9.dist-info → cognite_neat-0.76.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 cognite/neat/__init__.py,sha256=v-rRiDOgZ3sQSMQKq0vgUQZvpeOkoHFXissAx6Ktg84,61
-cognite/neat/_version.py,sha256=X-H6VAOk6BxNKKWyApnUjlIZqx4arMZpDacrdykwDYc,23
+cognite/neat/_version.py,sha256=JYMWad1hoQA4r17GzBIhK4in6LVyBr7OqBPAmFHo8cc,23
 cognite/neat/app/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/app/api/asgi/metrics.py,sha256=nxFy7L5cChTI0a-zkCiJ59Aq8yLuIJp5c9Dg0wRXtV0,152
 cognite/neat/app/api/configuration.py,sha256=2U5M6M252swvQPQyooA1EBzFUZNtcTmuSaywfJDgckM,4232
@@ -164,15 +164,15 @@ cognite/neat/rules/examples/wind-energy.owl,sha256=NuomCA9FuuLF0JlSuG3OKqD4VBcHg
 cognite/neat/rules/exceptions.py,sha256=YLnsbXXJdDSr_szQoioEtOdqDV8PR7RdQjpMP2SWeCs,123868
 cognite/neat/rules/exporters/__init__.py,sha256=Gn3CjkVKHJF9Po1ZPH4wAJ-sRW9up7b2CpXm-eReV3Q,413
 cognite/neat/rules/exporters/_base.py,sha256=rJIKvM9CQlwwAOBlmpYepB1Urb-ZLC0xBxS0fE7am-I,1517
-cognite/neat/rules/exporters/_models.py,sha256=BX19QXsbWjImCY9NCaOnrlMSs-6qcA5P3QLittrWvGM,1870
-cognite/neat/rules/exporters/_rules2dms.py,sha256=KXK_bJp752Zo8E3apHnTZzcZ2sQnmXftazI1mKPEfcQ,14231
-cognite/neat/rules/exporters/_rules2excel.py,sha256=vB8Gy6Zwso06nazTnnKe00-5gWH9a4GzO9C2T6MgzK8,13769
+cognite/neat/rules/exporters/_models.py,sha256=vRd0P_YsrZ1eaAGGHfdTeFunaqHdaa0ZtnWiVZBR1nc,1976
+cognite/neat/rules/exporters/_rules2dms.py,sha256=zFb-C4ihWrvud81AbNU2ZbSQ0jHqbYk4x34Zc1zFHyw,16126
+cognite/neat/rules/exporters/_rules2excel.py,sha256=QFRNsd3kt1WLtz5WxI5gFErzS_Y1ScIb-u2QYNtnPAQ,13068
 cognite/neat/rules/exporters/_rules2ontology.py,sha256=GBpaAjM0X8t02NWE3CRmKKovEiHhvOHdWfbeXP7Hh6c,20139
 cognite/neat/rules/exporters/_rules2yaml.py,sha256=Irr4CwJ5pLlwiJeOMuGPU-HX9zoYrONyfV9JpRYz6j8,3038
 cognite/neat/rules/exporters/_validation.py,sha256=zPMwQLw3U2HKFTtdrUMt2e0D-3FfgcaqdYU0DZ9YG_g,4090
 cognite/neat/rules/importers/__init__.py,sha256=zqNbGpvdVhYkLjWx1i9dJ3FXzYGtuQyTydUYsj-BndQ,408
-cognite/neat/rules/importers/_base.py,sha256=syKsI9011tL_ygwvYYFQk_8bf9uc2B4vQVSdQ_IP2DU,4041
-cognite/neat/rules/importers/_dms2rules.py,sha256=-f7c-26DTvZH9ehZ8Wf1Oqf4Ae82N_NSJoOY_wrnuQQ,10363
+cognite/neat/rules/importers/_base.py,sha256=ZT9kzmC8TluiMTao1rCVvD1ZK_Rq3WWclzn96ZuQg2U,4280
+cognite/neat/rules/importers/_dms2rules.py,sha256=eSuUYZauRP3Hs3kh5SLUfd-KV_tubWesyxUEgbTdm6w,17827
 cognite/neat/rules/importers/_dtdl2rules/__init__.py,sha256=CNR-sUihs2mnR1bPMKs3j3L4ds3vFTsrl6YycExZTfU,68
 cognite/neat/rules/importers/_dtdl2rules/_unit_lookup.py,sha256=wW4saKva61Q_i17guY0dc4OseJDQfqHy_QZBtm0OD6g,12134
 cognite/neat/rules/importers/_dtdl2rules/dtdl_converter.py,sha256=dHWbcP7rLxnLOef69DBR2xDYFIWj_DQPx-IkIWwBZIA,12676
@@ -183,29 +183,30 @@ cognite/neat/rules/importers/_owl2rules/_owl2classes.py,sha256=3qxQlZr-3MLhL0oDH
 cognite/neat/rules/importers/_owl2rules/_owl2metadata.py,sha256=mqDa0oiKCX2gBEk47rX4r-VzOmsVyK6q_J7wvDOCklA,7804
 cognite/neat/rules/importers/_owl2rules/_owl2properties.py,sha256=UB7iZZFkoeTsxuM745rl5I4Myp5mrotDgzmjPBBfv8w,7443
 cognite/neat/rules/importers/_owl2rules/_owl2rules.py,sha256=CN0CK0vXzXwawRH1Sp4FdDmxjChP3IWZYdYb1HEV23s,6931
-cognite/neat/rules/importers/_spreadsheet2rules.py,sha256=ndPUOh07_u_nlX790ztO2ny_gVT2SL-gpec0pgT6NMI,11274
+cognite/neat/rules/importers/_spreadsheet2rules.py,sha256=Td5w03RCY7ligcLHrSEiCLMHngwLuwgTSSUruMe3jz8,11397
 cognite/neat/rules/importers/_yaml2rules.py,sha256=LzcfsdKgU28TPAqxG5q3y09rJbUPbMhBWZRt0Z5bU3k,4299
 cognite/neat/rules/issues/__init__.py,sha256=Ms6jgCxCezc5IgTOwCFtXQPtoVFfOvdcXj84_rs917I,563
-cognite/neat/rules/issues/base.py,sha256=qgoZ3qr35XLtdmkWWewf3sCYOW0sCkJrN9VpFvX-WzY,6158
-cognite/neat/rules/issues/dms.py,sha256=uNBRgWOBg25K5yKkUtif8fn1ixG1BvvUooShk9uot4w,15330
-cognite/neat/rules/issues/fileread.py,sha256=n-GZaULOJF_MKkBIh1maaOuGZXOvZYw7Y6fDAS0jrBI,4492
+cognite/neat/rules/issues/base.py,sha256=MpqxzJrAEzPUOSdJEkUE1CvJogyWDN_7YJyoAY6sR_o,6242
+cognite/neat/rules/issues/dms.py,sha256=0xBTYa3b3CPFjsdfKv59l3yX8DLTYB1Jo0LWDhfG6oQ,19178
+cognite/neat/rules/issues/fileread.py,sha256=ao199mtvhPSW0IA8ZQZ0RzuLIIipYtL0jp6fLqxb4_c,5748
 cognite/neat/rules/issues/formatters.py,sha256=_ag2bJ9hncOj8pAGJvTTEPs9kTtxbD7vkqvS9Zcnizc,3385
-cognite/neat/rules/issues/importing.py,sha256=GqUywhBD840Fbc4DD5L2I0oEllJ78MTjpmXogVEjihA,7493
-cognite/neat/rules/issues/spreadsheet.py,sha256=Iyje5xqgDN3nhpF9hi1Nm-baCXMxOLYVXZ8_jE18zLI,13763
+cognite/neat/rules/issues/importing.py,sha256=p90847g_TbUAXMyxalcEaWXaPygJoSE5E85dQO4syoo,12288
+cognite/neat/rules/issues/spreadsheet.py,sha256=-jMcamtvDIACKiIHtDNafjiMgovVN-VthyqE1FaSy-0,13936
 cognite/neat/rules/issues/spreadsheet_file.py,sha256=YCp0Pk_TsiqYuOPdWpjUpre-zvi2c5_MvrC_dxw10YY,4964
 cognite/neat/rules/models/data_types.py,sha256=lanwkhwG8iHKfjYfia4v2SBTJrMeXOsqaVkVEP2QMXs,6078
-cognite/neat/rules/models/entities.py,sha256=riRJXlK9Q_uRqCbk8J-GxOoNwOhu8e8KRIW1Vtao6Zo,15477
+cognite/neat/rules/models/entities.py,sha256=iBG84Jr1qQ7PvkMJUJzJ1oWApeONb1IACixdJSztUhk,16395
 cognite/neat/rules/models/rdfpath.py,sha256=RoHnfWufjnDtwJh7UUzWKoJz8luvX7Gb5SDQORfkQTE,11030
 cognite/neat/rules/models/rules/__init__.py,sha256=YHzkEkDzDuPs9N69FP12SAbnOBiLOxk0m5jXH-IQgbY,522
-cognite/neat/rules/models/rules/_base.py,sha256=CKFrEFeLROq6IWDb5SfYTRJqsrOm0gvB-MGudMKBQqo,11024
-cognite/neat/rules/models/rules/_dms_architect_rules.py,sha256=A7Wh7DLOvJMcibhXdi6F5fQNRfOEOF2jo0NQPGZIAvk,52602
-cognite/neat/rules/models/rules/_dms_rules_write.py,sha256=JYo39XvaWsRtsfmgm9U3rThi7eMcS4W0nm6gns72-gM,12810
-cognite/neat/rules/models/rules/_dms_schema.py,sha256=BHxp6mhtvK0AFb6LeOHd0vnmrJVXQo78qhmAUOW9e_I,30777
-cognite/neat/rules/models/rules/_domain_rules.py,sha256=oa_if8jPSZWN9nS2j-UdxnCSIfjwIWq128cPd_BzLOw,2655
-cognite/neat/rules/models/rules/_information_rules.py,sha256=Cc1eB3rLj-WFvKOl45cgANjC_6oaYQE6Rs-Yeg7wLEk,22015
+cognite/neat/rules/models/rules/_base.py,sha256=bFH_HSftl960ROroUMy5jjXdIir6lm3tHK2qJmc-UG8,10876
+cognite/neat/rules/models/rules/_dms_architect_rules.py,sha256=sGlV_hOyQemtUUwYC_fwtihk40PlU7WrlywdagP65fI,58546
+cognite/neat/rules/models/rules/_dms_rules_write.py,sha256=12fkwQY5c0Y6SGM_pU6pEAqjUO2VuB3cPOAVllwUOkQ,13135
+cognite/neat/rules/models/rules/_dms_schema.py,sha256=ySGa0Qe_puGjXg1T-Ec0Kzvobqn60D5toFuSzeLuzW0,35870
+cognite/neat/rules/models/rules/_domain_rules.py,sha256=2S74P9YPPtb6myx8wg3-el9jrEBMH9AOBg9dAfwzlh4,2934
+cognite/neat/rules/models/rules/_information_rules.py,sha256=ni2KSHHG9nBqho50Sn5C7HJRHZCPatNUSM1xQSn_0lI,22447
 cognite/neat/rules/models/rules/_types/__init__.py,sha256=l1tGxzE7ezNHIL72AoEvNHN2IFuitxOLxiHJG__s6t4,305
 cognite/neat/rules/models/rules/_types/_base.py,sha256=2GhLUE1ukV8X8SGL_JDxpbWGZyAvOnSqAE6JmDh5wbI,929
 cognite/neat/rules/models/rules/_types/_field.py,sha256=74WfCSVbTubpK4n4VsysQqCch6VI8IcPqnHQpvNbFZ8,3197
+cognite/neat/rules/models/wrapped_entities.py,sha256=c5GkzOrYrE6SSRzIS2r8OAjhwxXpOoAO1WGc8kwiPPo,6154
 cognite/neat/utils/__init__.py,sha256=l5Nyqhqo25bcQXCOb_lk01cr-UXsG8cczz_y_I0u6bg,68
 cognite/neat/utils/auxiliary.py,sha256=E2-YtddzScvN7l7j0kNYIMlfqIUT9NWMqLpcJYPK4rY,309
 cognite/neat/utils/cdf.py,sha256=dTg8wnm2916yhWT_2Jg9_PlauHCbmnuNgmpqrGU8eO0,711
@@ -263,8 +264,8 @@ cognite/neat/workflows/steps_registry.py,sha256=fkTX14ZA7_gkUYfWIlx7A1XbCidvqR23
 cognite/neat/workflows/tasks.py,sha256=dqlJwKAb0jlkl7abbY8RRz3m7MT4SK8-7cntMWkOYjw,788
 cognite/neat/workflows/triggers.py,sha256=_BLNplzoz0iic367u1mhHMHiUrCwP-SLK6_CZzfODX0,7071
 cognite/neat/workflows/utils.py,sha256=gKdy3RLG7ctRhbCRwaDIWpL9Mi98zm56-d4jfHDqP1E,453
-cognite_neat-0.75.9.dist-info/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.75.9.dist-info/METADATA,sha256=fF2tMkrPlJv7YTy1GCBZ23mBH282qIwbqKN1xOCAfyY,9316
-cognite_neat-0.75.9.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-cognite_neat-0.75.9.dist-info/entry_points.txt,sha256=61FPqiWb25vbqB0KI7znG8nsg_ibLHBvTjYnkPvNFso,50
-cognite_neat-0.75.9.dist-info/RECORD,,
+cognite_neat-0.76.1.dist-info/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.76.1.dist-info/METADATA,sha256=WbYTbZfKFf2l9ASMKwMVGYW_otwMLULyqp1K0WfIqOY,9316
+cognite_neat-0.76.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+cognite_neat-0.76.1.dist-info/entry_points.txt,sha256=61FPqiWb25vbqB0KI7znG8nsg_ibLHBvTjYnkPvNFso,50
+cognite_neat-0.76.1.dist-info/RECORD,,