cognite-neat 0.72.1__py3-none-any.whl → 0.72.2__py3-none-any.whl

cognite/neat/_version.py

@@ -1 +1 @@
-__version__ = "0.72.1"
+__version__ = "0.72.2"

cognite/neat/app/api/routers/core.py

@@ -1,11 +1,13 @@
 import json
 import shutil
 import tempfile
+from copy import deepcopy
 from pathlib import Path
 from typing import cast
 
 from fastapi import APIRouter, UploadFile
 
+from cognite.neat.app.api.configuration import NEAT_APP
 from cognite.neat.rules import exporters, importers
 from cognite.neat.rules.models._rules import DMSRules
 from cognite.neat.rules.models._rules.base import RoleTypes
@@ -55,8 +57,36 @@ async def convert_data_model_to_rules(file: UploadFile):
 @router.post("/api/core/rules2dms")
 async def convert_rules_to_dms(rules: DMSRules):
     dms_schema = exporters.DMSExporter().export(rules)
+    containers = {f"{container.space}:{container.external_id}": container.dump() for container in dms_schema.containers}
+    views = {f"{view.space}:{view.external_id}": view.dump() for view in dms_schema.views}
+
+    if views and containers:
+        _to_visualization_compliant_views(views, containers)
 
     return {
-        "views": dms_schema.views.dump() if dms_schema.views else None,
-        "containers": dms_schema.containers.dump() if dms_schema.containers else None,
+        "views": list(views.values()) if views else None,
+        "containers": list(containers.values()) if containers else None,
     }
+
+
+def _to_visualization_compliant_views(views, containers):
+    for view in views.values():
+        for property in view["properties"].values():
+            # needs coping information from container:
+            if property.get("container", None) and property["container"]["type"] == "container":
+                container_id = f"{property['container']['space']}:{property['container']['externalId']}"
+                container_property_def = deepcopy(
+                    containers[container_id]["properties"][property["containerPropertyIdentifier"]]
+                )
+                property["type"] = container_property_def["type"]
+                container_property_def.pop("type")
+                property.update(container_property_def)
+
+
+@router.post("/api/core/publish-rules")
+async def publish_rules_as_data_model(rules: DMSRules):
+    if NEAT_APP.cdf_client:
+        uploaded = exporters.DMSExporter().export_to_cdf(rules, NEAT_APP.cdf_client)
+        return {"uploaded": uploaded}
+    else:
+        return {"uploaded": []}

cognite/neat/rules/issues/dms.py

@@ -24,6 +24,8 @@ __all__ = [
     "EmptyContainerWarning",
     "UnsupportedRelationWarning",
     "MultipleReferenceWarning",
+    "HasDataFilterOnNoPropertiesViewWarning",
+    "NodeTypeFilterOnParentViewWarning",
 ]
 
 
@@ -329,3 +331,44 @@ class MultipleReferenceWarning(DMSSchemaWarning):
         output["view_id"] = self.view_id.dump()
         output["implements"] = [view.dump() for view in self.implements]
         return output
+
+
+@dataclass(frozen=True)
+class HasDataFilterOnNoPropertiesViewWarning(DMSSchemaWarning):
+    description = "Attempting to set a HasData filter on a view without properties."
+    fix = "Add properties to the view or use a node type filter"
+    error_name: ClassVar[str] = "HasDataFilterOnNoPropertiesViewWarning"
+    view_id: dm.ViewId
+
+    def message(self) -> str:
+        return (
+            f"Cannot set hasData filter on view {self.view_id} as it does not have properties in any containers. "
+            "Using a node type filter instead."
+        )
+
+    def dump(self) -> dict[str, Any]:
+        output = super().dump()
+        output["view_id"] = self.view_id.dump()
+        return output
+
+
+@dataclass(frozen=True)
+class NodeTypeFilterOnParentViewWarning(DMSSchemaWarning):
+    description = (
+        "Setting a node type filter on a parent view. This is no "
+        "recommended as parent views are typically used for multiple type of nodes."
+    )
+    fix = "Use a HasData filter instead"
+    error_name: ClassVar[str] = "NodeTypeFilterOnParentViewWarning"
+    view_id: dm.ViewId
+
+    def message(self) -> str:
+        return (
+            f"Setting a node type filter on parent view {self.view_id}. This is not recommended as "
+            "parent views are typically used for multiple types of nodes."
+        )
+
+    def dump(self) -> dict[str, Any]:
+        output = super().dump()
+        output["view_id"] = self.view_id.dump()
+        return output

cognite/neat/rules/models/_rules/dms_architect_rules.py

@@ -243,6 +243,7 @@ class DMSView(SheetEntity):
     view: ViewType = Field(alias="View")
     implements: ViewListType | None = Field(None, alias="Implements")
     reference: ReferenceType = Field(alias="Reference", default=None)
+    filter_: Literal["hasData", "nodeType"] | None = Field(None, alias="Filter")
     in_model: bool = Field(True, alias="InModel")
 
     def as_view(self, default_space: str, default_version: str, standardize_casing: bool = True) -> dm.ViewApply:
@@ -677,6 +678,11 @@ class _DMSExporter:
         views = dm.ViewApplyList(
             [dms_view.as_view(default_space, default_version, self.standardize_casing) for dms_view in dms_views]
         )
+        dms_view_by_id = {
+            dms_view.view.as_id(False, default_space, default_version, self.standardize_casing): dms_view
+            for dms_view in dms_views
+        }
+
         for view in views:
             view_id = view.as_id()
             view.properties = {}
@@ -796,24 +802,30 @@ class _DMSExporter:
 
         node_types = dm.NodeApplyList([])
         parent_views = {parent for view in views for parent in view.implements or []}
-        node_type_flag = False
         for view in views:
             ref_containers = sorted(view.referenced_containers(), key=lambda c: c.as_tuple())
             has_data = dm.filters.HasData(containers=list(ref_containers)) if ref_containers else None
             node_type = dm.filters.Equals(["node", "type"], {"space": view.space, "externalId": view.external_id})
+            dms_view = dms_view_by_id.get(view.as_id())
             if view.as_id() in parent_views:
-                view.filter = has_data
-            elif has_data is None:
-                # Child filter without container properties
-                if node_type_flag:
-                    # Transformations do not yet support setting node type.
+                if dms_view and dms_view.filter_ == "nodeType":
+                    warnings.warn(issues.dms.NodeTypeFilterOnParentViewWarning(view.as_id()), stacklevel=2)
                     view.filter = node_type
                     node_types.append(dm.NodeApply(space=view.space, external_id=view.external_id, sources=[]))
+                else:
+                    view.filter = has_data
+            elif has_data is None:
+                # Child filter without container properties
+                if dms_view and dms_view.filter_ == "hasData":
+                    warnings.warn(issues.dms.HasDataFilterOnNoPropertiesViewWarning(view.as_id()), stacklevel=2)
+                view.filter = node_type
+                node_types.append(dm.NodeApply(space=view.space, external_id=view.external_id, sources=[]))
             else:
-                # Child filter with its own container properties
-                if node_type_flag:
-                    # Transformations do not yet support setting node type.
-                    view.filter = dm.filters.And(has_data, node_type)
+                if dms_view and (dms_view.filter_ == "hasData" or dms_view.filter_ is None):
+                    # Default option
+                    view.filter = has_data
+                elif dms_view and dms_view.filter_ == "nodeType":
+                    view.filter = node_type
                     node_types.append(dm.NodeApply(space=view.space, external_id=view.external_id, sources=[]))
                 else:
                     view.filter = has_data

{cognite_neat-0.72.1.dist-info → cognite_neat-0.72.2.dist-info}/METADATA

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

{cognite_neat-0.72.1.dist-info → cognite_neat-0.72.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 cognite/neat/__init__.py,sha256=v-rRiDOgZ3sQSMQKq0vgUQZvpeOkoHFXissAx6Ktg84,61
-cognite/neat/_version.py,sha256=-bsES2AHa1TNyPmsDMRScqqA4ezbJdvAUS3UylEI4rQ,23
+cognite/neat/_version.py,sha256=TB9NfKJN3p__h60nooN7qSNFiqOO_zE_B3dfGb0-uXQ,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=xnKdBE_dtq1nRvKa79YGA_wimI5UhoSRuBQz4LkLzQw,4606
@@ -10,7 +10,7 @@ cognite/neat/app/api/data_classes/configuration.py,sha256=oBnnX6Zam7TOstiLpQbi3G
 cognite/neat/app/api/data_classes/rest.py,sha256=yVWqFkBCDCGooOWaE5nun4No8B-PBa6svdenIjBINdo,1675
 cognite/neat/app/api/explorer.py,sha256=OlLI-RbQGjXEuDgtmFfBuTXfnRVemTJDKbL9VvXLr6Y,1891
 cognite/neat/app/api/routers/configuration.py,sha256=tFiEbtFHNVehMwM8T-IvnWpDOL_y-wCt-wd5w-Z4PQk,554
-cognite/neat/app/api/routers/core.py,sha256=OO9M611KG9QAdCVurWQPiU6wj6GVsTzs5DdXlCFA-wI,2191
+cognite/neat/app/api/routers/core.py,sha256=ZU7sZ1QgFtrNHR-Y6DVzxLZSIJoZZeCvlXLgp2oO46U,3583
 cognite/neat/app/api/routers/crud.py,sha256=Cnvw77JWCs_wzeoQYdWwGfFns8LgtYmsYWgKPtud3BA,4646
 cognite/neat/app/api/routers/data_exploration.py,sha256=XlpEbggy1mK1XmwVtLZmrXWulTzdaGQaKAyHs3H04qU,13653
 cognite/neat/app/api/routers/metrics.py,sha256=S_bUQk_GjfQq7WbEhSVdow4MUYBZ_bZNafzgcKogXK8,210
@@ -149,7 +149,7 @@ cognite/neat/rules/importers/_spreadsheet2rules.py,sha256=GVkTtWnQkM8nXkPAOs2Upx
 cognite/neat/rules/importers/_yaml2rules.py,sha256=sIaYY3Zo--v1cXSu65n4ZPv47cS-5InvSbpkw3Ahov4,4198
 cognite/neat/rules/issues/__init__.py,sha256=Ms6jgCxCezc5IgTOwCFtXQPtoVFfOvdcXj84_rs917I,563
 cognite/neat/rules/issues/base.py,sha256=dS4lmbW9VQ8awgOIB-Ah9z9LdNbCa-fPd8tbyPb8sM4,5856
-cognite/neat/rules/issues/dms.py,sha256=q5Sv81HiRpX4e7B3wzG3kILpbdGNrbYSyTlT3yw1d2A,11167
+cognite/neat/rules/issues/dms.py,sha256=WB8N6MPbLFxdScJLGGY_zdErcrEXJnAsMladMB5aKa4,12722
 cognite/neat/rules/issues/fileread.py,sha256=n-GZaULOJF_MKkBIh1maaOuGZXOvZYw7Y6fDAS0jrBI,4492
 cognite/neat/rules/issues/formatters.py,sha256=_pSogWtfkt2JK0PZgWQffbj2On8vumFNshxOKAi5fYw,3346
 cognite/neat/rules/issues/importing.py,sha256=GqUywhBD840Fbc4DD5L2I0oEllJ78MTjpmXogVEjihA,7493
@@ -163,7 +163,7 @@ cognite/neat/rules/models/_rules/_types/_base.py,sha256=EsTqjXUP0zpuQ-Z_BMP-00rJ
 cognite/neat/rules/models/_rules/_types/_field.py,sha256=dOVAU1jWCupFVnrYYwLfI-nNUC4rv4vXHMzpiObtWiw,10295
 cognite/neat/rules/models/_rules/_types/_value.py,sha256=ubyWmU6neyNxx17fqcciIjyB-CIpYNUuM97Xh2sVrYo,6308
 cognite/neat/rules/models/_rules/base.py,sha256=9DgtdCmpz84sMFxZB_stWkalVbjA4HQKsTMpSjjOVLU,10635
-cognite/neat/rules/models/_rules/dms_architect_rules.py,sha256=d4WKTyuSWWw6ioOYCnayTQcTWNGv-dys2LU3PBI8Fuc,49465
+cognite/neat/rules/models/_rules/dms_architect_rules.py,sha256=2JbQm-5rWQLpuZJbov5pKigddE_GslmxhA18GiNXWms,50201
 cognite/neat/rules/models/_rules/dms_schema.py,sha256=-ru40beGY2WJvf9_sd5eO2Wh8x2qLQ2UmgzExloBWac,30229
 cognite/neat/rules/models/_rules/domain_rules.py,sha256=mOE4M6wOurmnAehxbnxvP9vIVXsFuKSiyMmD1shXKpA,2051
 cognite/neat/rules/models/_rules/information_rules.py,sha256=kETaZ3HsPw0EFXIeU-YhfEZeK4FhAh5RvNQAWbrcE-E,21026
@@ -227,8 +227,8 @@ cognite/neat/workflows/steps_registry.py,sha256=PZVoHX4d6Vmjz6XzUFnFFWMCnrVnqkUC
 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.72.1.dist-info/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.72.1.dist-info/METADATA,sha256=Ow2IjY4oEmsDS2NTfizqbgKBUapUvhV7WDWxBwIA5Ak,9321
-cognite_neat-0.72.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-cognite_neat-0.72.1.dist-info/entry_points.txt,sha256=61FPqiWb25vbqB0KI7znG8nsg_ibLHBvTjYnkPvNFso,50
-cognite_neat-0.72.1.dist-info/RECORD,,
+cognite_neat-0.72.2.dist-info/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.72.2.dist-info/METADATA,sha256=1k5nxYBvZSbu3_bbjMgjMq21jCOvMv3LlwE8fUIcAO4,9321
+cognite_neat-0.72.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+cognite_neat-0.72.2.dist-info/entry_points.txt,sha256=61FPqiWb25vbqB0KI7znG8nsg_ibLHBvTjYnkPvNFso,50
+cognite_neat-0.72.2.dist-info/RECORD,,