industrial-model 1.0.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

industrial_model/cognite_adapters/__init__.py

@@ -124,20 +124,29 @@ class CogniteAdapter:
         return data
 
     def upsert(
-        self, entries: list[TWritableViewInstance], replace: bool = False
+        self,
+        entries: list[TWritableViewInstance],
+        replace: bool = False,
+        remove_unset: bool = False,
     ) -> None:
         logger = logging.getLogger(__name__)
-        operation = self._upsert_mapper.map(entries)
+        operation = self._upsert_mapper.map(entries, remove_unset)
 
         for node_chunk in operation.chunk_nodes():
-            logger.debug(f"Upserting {len(node_chunk)} nodes (replace={replace})")
+            logger.debug(
+                f"Upserting {len(node_chunk)} nodes (replace={replace}, "
+                "remove_unset={remove_unset})"
+            )
             self._cognite_client.data_modeling.instances.apply(
                 nodes=node_chunk,
                 replace=replace,
             )
 
         for edge_chunk in operation.chunk_edges():
-            logger.debug(f"Upserting {len(edge_chunk)} edges (replace={replace})")
+            logger.debug(
+                f"Upserting {len(edge_chunk)} edges (replace={replace},"
+                "remove_unset={remove_unset})"
+            )
             self._cognite_client.data_modeling.instances.apply(
                 edges=edge_chunk,
                 replace=replace,

industrial_model/cognite_adapters/sort_mapper.py

@@ -1,4 +1,4 @@
-from cognite.client.data_classes.data_modeling import InstanceSort, View
+from cognite.client.data_classes.data_modeling import InstanceSort, MappedProperty, View
 
 from industrial_model.cognite_adapters.utils import get_property_ref
 from industrial_model.constants import SORT_DIRECTION
@@ -15,7 +15,17 @@ class SortMapper:
             InstanceSort(
                 property=get_property_ref(column.property, root_view),
                 direction=direction,
-                nulls_first=direction == "descending",
+                nulls_first=self._is_nulls_first(column, root_view, direction),
             )
             for column, direction in sort_clauses
         ]
+
+    def _is_nulls_first(
+        self, column: Column, root_view: View, direction: SORT_DIRECTION
+    ) -> bool:
+        view_property = root_view.properties.get(column.property)
+
+        if isinstance(view_property, MappedProperty) and view_property.source:
+            return direction == "ascending"
+
+        return direction == "descending"

industrial_model/cognite_adapters/upsert_mapper.py

@@ -25,14 +25,16 @@ class UpsertMapper:
     def __init__(self, view_mapper: ViewMapper):
         self._view_mapper = view_mapper
 
-    def map(self, instances: list[TWritableViewInstance]) -> UpsertOperation:
+    def map(
+        self, instances: list[TWritableViewInstance], remove_unset: bool
+    ) -> UpsertOperation:
         nodes: dict[tuple[str, str], NodeApply] = {}
         edges: dict[tuple[str, str], EdgeApply] = {}
         edges_to_delete: dict[tuple[str, str], EdgeContainer] = {}
 
         for instance in instances:
             entry_nodes, entry_edges, entry_edges_to_delete = self._map_instance(
-                instance
+                instance, remove_unset
             )
 
             nodes[instance.as_tuple()] = entry_nodes
@@ -48,7 +50,7 @@ class UpsertMapper:
         )
 
     def _map_instance(
-        self, instance: TWritableViewInstance
+        self, instance: TWritableViewInstance, remove_unset: bool
     ) -> tuple[NodeApply, list[EdgeApply], list[EdgeContainer]]:
         view = self._view_mapper.get_view(instance.get_view_external_id())
 
@@ -59,6 +61,10 @@ class UpsertMapper:
             property_key = instance.get_field_name(property_name)
             if not property_key:
                 continue
+
+            if remove_unset and property_key not in instance.model_fields_set:
+                continue
+
             entry = instance.__getattribute__(property_key)
 
             if isinstance(property, MappedProperty):

industrial_model/engines/_internal.py

@@ -20,13 +20,13 @@ def generate_engine_params(
     file_env_parsed = env_sub_template.substitute(dict(os.environ))
 
     engine_config = yaml.safe_load(file_env_parsed)
-    assert isinstance(
-        engine_config, dict
-    ), "Configuration file must contain a dictionary"
+    assert isinstance(engine_config, dict), (
+        "Configuration file must contain a dictionary"
+    )
     assert "cognite" in engine_config, "Configuration must contain 'cognite' section"
-    assert (
-        "data_model" in engine_config
-    ), "Configuration must contain 'data_model' section"
+    assert "data_model" in engine_config, (
+        "Configuration must contain 'data_model' section"
+    )
 
     client = CogniteClient.load(engine_config["cognite"])
     dm_id = DataModelId.model_validate(engine_config["data_model"])

industrial_model/engines/async_engine.py

@@ -55,9 +55,12 @@ class AsyncEngine:
         return await self._engine.aggregate_async(statement)
 
     async def upsert_async(
-        self, entries: list[TWritableViewInstance], replace: bool = False
+        self,
+        entries: list[TWritableViewInstance],
+        replace: bool = False,
+        remove_unset: bool = False,
     ) -> None:
-        return await self._engine.upsert_async(entries, replace)
+        return await self._engine.upsert_async(entries, replace, remove_unset)
 
     async def delete_async(self, nodes: list[TViewInstance]) -> None:
         return await self._engine.delete_async(nodes)

industrial_model/engines/engine.py

@@ -98,17 +98,23 @@ class Engine:
         return await run_async(self.aggregate, statement)
 
     def upsert(
-        self, entries: list[TWritableViewInstance], replace: bool = False
+        self,
+        entries: list[TWritableViewInstance],
+        replace: bool = False,
+        remove_unset: bool = False,
     ) -> None:
         if not entries:
             return
 
-        return self._cognite_adapter.upsert(entries, replace)
+        return self._cognite_adapter.upsert(entries, replace, remove_unset)
 
     async def upsert_async(
-        self, entries: list[TWritableViewInstance], replace: bool = False
+        self,
+        entries: list[TWritableViewInstance],
+        replace: bool = False,
+        remove_unset: bool = False,
     ) -> None:
-        return await run_async(self.upsert, entries, replace)
+        return await run_async(self.upsert, entries, replace, remove_unset)
 
     def delete(self, nodes: list[TViewInstance]) -> None:
         self._cognite_adapter.delete(

industrial_model/models/entities.py

@@ -73,9 +73,9 @@ class ViewInstance(InstanceId):
         return cls.view_config.get("view_external_id") or cls.__name__
 
     def get_edge_metadata(self, property: Column | str | Any) -> list[EdgeContainer]:
-        assert isinstance(
-            property, Column | str
-        ), f"Expected property to be Column, or str, got {type(property).__name__}"
+        assert isinstance(property, Column | str), (
+            f"Expected property to be Column, or str, got {type(property).__name__}"
+        )
         identifier = property.property if isinstance(property, Column) else property
 
         edge_map_key = self.get_field_alias(identifier) or self.get_field_name(

{industrial_model-1.0.0.dist-info → industrial_model-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: industrial-model
-Version: 1.0.0
+Version: 1.1.0
 Summary: Industrial Model ORM
 Project-URL: Homepage, https://github.com/lucasrosaalves/industrial-model
 Project-URL: Source, https://github.com/lucasrosaalves/industrial-model
@@ -309,7 +309,7 @@ instances = engine.query_all_pages(
 for instance in instances:
     instance.aliases.append("new_alias")
 
-engine.upsert(instances, replace=False)
+engine.upsert(instances, replace=False, remove_unset=False)
 ```
 
 ---

{industrial_model-1.0.0.dist-info → industrial_model-1.1.0.dist-info}/RECORD

@@ -3,7 +3,7 @@ industrial_model/config.py,sha256=fiwW-54fgCBY6ciFlRqeCBCNUvY41D-xuv8rCH7Ok54,29
 industrial_model/constants.py,sha256=MO85Wk05LHrpfbS4zml1hneJNFxht2oa3KFAKXw92qo,450
 industrial_model/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 industrial_model/utils.py,sha256=oh4AxwxXaWgIC2uolkCbvkgo0ququHB6yAPVIXy45Ts,663
-industrial_model/cognite_adapters/__init__.py,sha256=HPCvjvHO4xKyWxDIK_v7wrFJeQsnmJ84ptTzDQTZoH4,6275
+industrial_model/cognite_adapters/__init__.py,sha256=y8vCi2HdjDDkjqPt9y9LTpWu4ZFtc-65re70aHmc-ho,6497
 industrial_model/cognite_adapters/aggregation_mapper.py,sha256=CYbOR7Eh447PEwCtPKFCHYh3-K6akwLTJdQ-oeSYvKo,2599
 industrial_model/cognite_adapters/filter_mapper.py,sha256=eSrEYdEKZHQuJ98gblBYy1qCe5VYpq3fjLSUg8614fk,5261
 industrial_model/cognite_adapters/models.py,sha256=2j2IS01uPkQEp9WdVk8seYzEqGcDdWFnpzXhusHB2zk,945
@@ -11,17 +11,17 @@ industrial_model/cognite_adapters/optimizer.py,sha256=-iorsO-yOe8wuMNBMsV1KjAmC3
 industrial_model/cognite_adapters/query_mapper.py,sha256=tpRdrEW6i0NKy5h6bYrIIP96nanPSokK-s5-1d0PES8,6597
 industrial_model/cognite_adapters/query_result_mapper.py,sha256=KaBqYr5l1t8sQMxEoX_F3J2prypKIPaDJxSzGF_fMB8,10203
 industrial_model/cognite_adapters/search_mapper.py,sha256=zRe5FgucTWHX2VVbh3iLmzM7FmUAFhJG5t42gXnnJrE,1587
-industrial_model/cognite_adapters/sort_mapper.py,sha256=RJUAYlZGXoYzK0PwX63cibRF_L-MUq9g2ZsC2EeNIF4,696
-industrial_model/cognite_adapters/upsert_mapper.py,sha256=jzelnmECFcuVkQY7dgZG-xL19yD9kxtYvx827InIMO8,4951
+industrial_model/cognite_adapters/sort_mapper.py,sha256=EQ2Xpfdet8jN6EK0rEZ3IA8L7sPXWVX1MA9kQg4LdXs,1083
+industrial_model/cognite_adapters/upsert_mapper.py,sha256=iHt3gOEruFkZmg7KdynVPdRA7VZbuKhjAST0uFPb5rM,5125
 industrial_model/cognite_adapters/utils.py,sha256=-9NUG84r49cKvmmzoUinxNF1zhHIlmoWFypUCD_WTeM,4800
 industrial_model/cognite_adapters/view_mapper.py,sha256=9nWx0P7h8TMthLcOF5GZ4yC4UOndVuUo_s-Oz5nSAyM,1276
 industrial_model/engines/__init__.py,sha256=7aGHrUm2MxIq39vR8h0xu3i1zNOuT9H9U-q4lV3nErQ,102
-industrial_model/engines/_internal.py,sha256=bepUTKygYNHcOB810-KoWIKnzf4hFpwXZoWYJyuOUfc,1090
-industrial_model/engines/async_engine.py,sha256=BSuI1vjUsjHeYSvxZM4bK2cEw-WutzjlCUFU0Nnu2-M,2139
-industrial_model/engines/engine.py,sha256=icpYh-zgzMM_jsV5AytXoXz-nb2nYKug6qkekeMAQQw,4621
+industrial_model/engines/_internal.py,sha256=a3fdqqP3pVTPkfYIF5W_bNSQiIps3MA4xiGC3HOIYhI,1092
+industrial_model/engines/async_engine.py,sha256=3DXKGQ4spsmG8D3EhCKDCoDL4E2S3TocFIGV2gKF-DI,2206
+industrial_model/engines/engine.py,sha256=l6prJdvWy22nmMsu08VeT9qU18uLK6EFKopEzFdtWag,4755
 industrial_model/models/__init__.py,sha256=g8oa95iG6c22A-vTYhiZKSYa6RG2C7Ht1dpn5_HfXxs,796
 industrial_model/models/base.py,sha256=qi44m0KW9KuXKTSJqSLea1poErBeAqm6Hv08VdRYHkU,2023
-industrial_model/models/entities.py,sha256=jqTgyCv8frzovKCKg6yVUNO9hoBqz_b3HGYbGwIq7gI,5698
+industrial_model/models/entities.py,sha256=-Jf7bNCijbS3_wZohlog3bRsAkXvkUeAQW9DamJqGFo,5700
 industrial_model/models/schemas.py,sha256=EoLK9GYdS-0DQ98myTP3wOU9YpWIJOfDSLOYZUy3xEY,4559
 industrial_model/models/utils.py,sha256=MFS8OyCfh4cYPY_R66-mUaCauQfQy0vd558Rw0tiGDc,1786
 industrial_model/queries/__init__.py,sha256=lA83zOxMRgBgkseWJgK9kCr1vD8D8iSWs9NGGRnoYKk,355
@@ -30,7 +30,7 @@ industrial_model/queries/params.py,sha256=50qY5BO5onLsXorhcv-7qCKhJaMO94UzhKLCmZ
 industrial_model/queries/utils.py,sha256=uP6PLh9IVHDK6J8x444zHWPmyV4PkxdLO-PMc6qWItc,1505
 industrial_model/statements/__init__.py,sha256=3Et9PM7AMbIS7Fh9051Q0u3qUpX6588d1yuNrvdd4wI,5429
 industrial_model/statements/expressions.py,sha256=4ZZOcZroI5-4xRw4PXIRlufi0ARndE5zSbbxLDpR2Ec,4816
-industrial_model-1.0.0.dist-info/METADATA,sha256=NDEiaElRHaf8EmCWcPkT1JUeRVL0xa_ZehEdR0m4iUI,7680
-industrial_model-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-industrial_model-1.0.0.dist-info/licenses/LICENSE,sha256=BCHCZ1Qo7m4YvAEIQqtVBI3NebFJdZ8_7m_cxInIlN0,4934
-industrial_model-1.0.0.dist-info/RECORD,,
+industrial_model-1.1.0.dist-info/METADATA,sha256=_kqHVSleX7wZ44wqZoRF0ahHdzRU-8xRG_fA5VXZrvg,7700
+industrial_model-1.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+industrial_model-1.1.0.dist-info/licenses/LICENSE,sha256=BCHCZ1Qo7m4YvAEIQqtVBI3NebFJdZ8_7m_cxInIlN0,4934
+industrial_model-1.1.0.dist-info/RECORD,,