industrial-model 1.0.0__tar.gz → 1.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. {industrial_model-1.0.0 → industrial_model-1.1.0}/PKG-INFO +2 -2
  2. {industrial_model-1.0.0 → industrial_model-1.1.0}/README.md +1 -1
  3. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/cognite_adapters/__init__.py +13 -4
  4. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/cognite_adapters/sort_mapper.py +12 -2
  5. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/cognite_adapters/upsert_mapper.py +9 -3
  6. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/engines/_internal.py +6 -6
  7. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/engines/async_engine.py +5 -2
  8. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/engines/engine.py +10 -4
  9. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/models/entities.py +3 -3
  10. {industrial_model-1.0.0 → industrial_model-1.1.0}/pyproject.toml +1 -1
  11. {industrial_model-1.0.0 → industrial_model-1.1.0}/.gitignore +0 -0
  12. {industrial_model-1.0.0 → industrial_model-1.1.0}/LICENSE +0 -0
  13. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/__init__.py +0 -0
  14. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/cognite_adapters/aggregation_mapper.py +0 -0
  15. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/cognite_adapters/filter_mapper.py +0 -0
  16. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/cognite_adapters/models.py +0 -0
  17. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/cognite_adapters/optimizer.py +0 -0
  18. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/cognite_adapters/query_mapper.py +0 -0
  19. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/cognite_adapters/query_result_mapper.py +0 -0
  20. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/cognite_adapters/search_mapper.py +0 -0
  21. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/cognite_adapters/utils.py +0 -0
  22. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/cognite_adapters/view_mapper.py +0 -0
  23. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/config.py +0 -0
  24. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/constants.py +0 -0
  25. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/engines/__init__.py +0 -0
  26. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/models/__init__.py +0 -0
  27. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/models/base.py +0 -0
  28. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/models/schemas.py +0 -0
  29. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/models/utils.py +0 -0
  30. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/py.typed +0 -0
  31. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/queries/__init__.py +0 -0
  32. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/queries/models.py +0 -0
  33. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/queries/params.py +0 -0
  34. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/queries/utils.py +0 -0
  35. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/statements/__init__.py +0 -0
  36. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/statements/expressions.py +0 -0
  37. {industrial_model-1.0.0 → industrial_model-1.1.0}/industrial_model/utils.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: industrial-model
3
- Version: 1.0.0
3
+ Version: 1.1.0
4
4
  Summary: Industrial Model ORM
5
5
  Project-URL: Homepage, https://github.com/lucasrosaalves/industrial-model
6
6
  Project-URL: Source, https://github.com/lucasrosaalves/industrial-model
@@ -309,7 +309,7 @@ instances = engine.query_all_pages(
309
309
  for instance in instances:
310
310
  instance.aliases.append("new_alias")
311
311
 
312
- engine.upsert(instances, replace=False)
312
+ engine.upsert(instances, replace=False, remove_unset=False)
313
313
  ```
314
314
 
315
315
  ---
@@ -285,7 +285,7 @@ instances = engine.query_all_pages(
285
285
  for instance in instances:
286
286
  instance.aliases.append("new_alias")
287
287
 
288
- engine.upsert(instances, replace=False)
288
+ engine.upsert(instances, replace=False, remove_unset=False)
289
289
  ```
290
290
 
291
291
  ---
@@ -124,20 +124,29 @@ class CogniteAdapter:
124
124
  return data
125
125
 
126
126
  def upsert(
127
- self, entries: list[TWritableViewInstance], replace: bool = False
127
+ self,
128
+ entries: list[TWritableViewInstance],
129
+ replace: bool = False,
130
+ remove_unset: bool = False,
128
131
  ) -> None:
129
132
  logger = logging.getLogger(__name__)
130
- operation = self._upsert_mapper.map(entries)
133
+ operation = self._upsert_mapper.map(entries, remove_unset)
131
134
 
132
135
  for node_chunk in operation.chunk_nodes():
133
- logger.debug(f"Upserting {len(node_chunk)} nodes (replace={replace})")
136
+ logger.debug(
137
+ f"Upserting {len(node_chunk)} nodes (replace={replace}, "
138
+ "remove_unset={remove_unset})"
139
+ )
134
140
  self._cognite_client.data_modeling.instances.apply(
135
141
  nodes=node_chunk,
136
142
  replace=replace,
137
143
  )
138
144
 
139
145
  for edge_chunk in operation.chunk_edges():
140
- logger.debug(f"Upserting {len(edge_chunk)} edges (replace={replace})")
146
+ logger.debug(
147
+ f"Upserting {len(edge_chunk)} edges (replace={replace},"
148
+ "remove_unset={remove_unset})"
149
+ )
141
150
  self._cognite_client.data_modeling.instances.apply(
142
151
  edges=edge_chunk,
143
152
  replace=replace,
@@ -1,4 +1,4 @@
1
- from cognite.client.data_classes.data_modeling import InstanceSort, View
1
+ from cognite.client.data_classes.data_modeling import InstanceSort, MappedProperty, View
2
2
 
3
3
  from industrial_model.cognite_adapters.utils import get_property_ref
4
4
  from industrial_model.constants import SORT_DIRECTION
@@ -15,7 +15,17 @@ class SortMapper:
15
15
  InstanceSort(
16
16
  property=get_property_ref(column.property, root_view),
17
17
  direction=direction,
18
- nulls_first=direction == "descending",
18
+ nulls_first=self._is_nulls_first(column, root_view, direction),
19
19
  )
20
20
  for column, direction in sort_clauses
21
21
  ]
22
+
23
+ def _is_nulls_first(
24
+ self, column: Column, root_view: View, direction: SORT_DIRECTION
25
+ ) -> bool:
26
+ view_property = root_view.properties.get(column.property)
27
+
28
+ if isinstance(view_property, MappedProperty) and view_property.source:
29
+ return direction == "ascending"
30
+
31
+ return direction == "descending"
@@ -25,14 +25,16 @@ class UpsertMapper:
25
25
  def __init__(self, view_mapper: ViewMapper):
26
26
  self._view_mapper = view_mapper
27
27
 
28
- def map(self, instances: list[TWritableViewInstance]) -> UpsertOperation:
28
+ def map(
29
+ self, instances: list[TWritableViewInstance], remove_unset: bool
30
+ ) -> UpsertOperation:
29
31
  nodes: dict[tuple[str, str], NodeApply] = {}
30
32
  edges: dict[tuple[str, str], EdgeApply] = {}
31
33
  edges_to_delete: dict[tuple[str, str], EdgeContainer] = {}
32
34
 
33
35
  for instance in instances:
34
36
  entry_nodes, entry_edges, entry_edges_to_delete = self._map_instance(
35
- instance
37
+ instance, remove_unset
36
38
  )
37
39
 
38
40
  nodes[instance.as_tuple()] = entry_nodes
@@ -48,7 +50,7 @@ class UpsertMapper:
48
50
  )
49
51
 
50
52
  def _map_instance(
51
- self, instance: TWritableViewInstance
53
+ self, instance: TWritableViewInstance, remove_unset: bool
52
54
  ) -> tuple[NodeApply, list[EdgeApply], list[EdgeContainer]]:
53
55
  view = self._view_mapper.get_view(instance.get_view_external_id())
54
56
 
@@ -59,6 +61,10 @@ class UpsertMapper:
59
61
  property_key = instance.get_field_name(property_name)
60
62
  if not property_key:
61
63
  continue
64
+
65
+ if remove_unset and property_key not in instance.model_fields_set:
66
+ continue
67
+
62
68
  entry = instance.__getattribute__(property_key)
63
69
 
64
70
  if isinstance(property, MappedProperty):
@@ -20,13 +20,13 @@ def generate_engine_params(
20
20
  file_env_parsed = env_sub_template.substitute(dict(os.environ))
21
21
 
22
22
  engine_config = yaml.safe_load(file_env_parsed)
23
- assert isinstance(
24
- engine_config, dict
25
- ), "Configuration file must contain a dictionary"
23
+ assert isinstance(engine_config, dict), (
24
+ "Configuration file must contain a dictionary"
25
+ )
26
26
  assert "cognite" in engine_config, "Configuration must contain 'cognite' section"
27
- assert (
28
- "data_model" in engine_config
29
- ), "Configuration must contain 'data_model' section"
27
+ assert "data_model" in engine_config, (
28
+ "Configuration must contain 'data_model' section"
29
+ )
30
30
 
31
31
  client = CogniteClient.load(engine_config["cognite"])
32
32
  dm_id = DataModelId.model_validate(engine_config["data_model"])
@@ -55,9 +55,12 @@ class AsyncEngine:
55
55
  return await self._engine.aggregate_async(statement)
56
56
 
57
57
  async def upsert_async(
58
- self, entries: list[TWritableViewInstance], replace: bool = False
58
+ self,
59
+ entries: list[TWritableViewInstance],
60
+ replace: bool = False,
61
+ remove_unset: bool = False,
59
62
  ) -> None:
60
- return await self._engine.upsert_async(entries, replace)
63
+ return await self._engine.upsert_async(entries, replace, remove_unset)
61
64
 
62
65
  async def delete_async(self, nodes: list[TViewInstance]) -> None:
63
66
  return await self._engine.delete_async(nodes)
@@ -98,17 +98,23 @@ class Engine:
98
98
  return await run_async(self.aggregate, statement)
99
99
 
100
100
  def upsert(
101
- self, entries: list[TWritableViewInstance], replace: bool = False
101
+ self,
102
+ entries: list[TWritableViewInstance],
103
+ replace: bool = False,
104
+ remove_unset: bool = False,
102
105
  ) -> None:
103
106
  if not entries:
104
107
  return
105
108
 
106
- return self._cognite_adapter.upsert(entries, replace)
109
+ return self._cognite_adapter.upsert(entries, replace, remove_unset)
107
110
 
108
111
  async def upsert_async(
109
- self, entries: list[TWritableViewInstance], replace: bool = False
112
+ self,
113
+ entries: list[TWritableViewInstance],
114
+ replace: bool = False,
115
+ remove_unset: bool = False,
110
116
  ) -> None:
111
- return await run_async(self.upsert, entries, replace)
117
+ return await run_async(self.upsert, entries, replace, remove_unset)
112
118
 
113
119
  def delete(self, nodes: list[TViewInstance]) -> None:
114
120
  self._cognite_adapter.delete(
@@ -73,9 +73,9 @@ class ViewInstance(InstanceId):
73
73
  return cls.view_config.get("view_external_id") or cls.__name__
74
74
 
75
75
  def get_edge_metadata(self, property: Column | str | Any) -> list[EdgeContainer]:
76
- assert isinstance(
77
- property, Column | str
78
- ), f"Expected property to be Column, or str, got {type(property).__name__}"
76
+ assert isinstance(property, Column | str), (
77
+ f"Expected property to be Column, or str, got {type(property).__name__}"
78
+ )
79
79
  identifier = property.property if isinstance(property, Column) else property
80
80
 
81
81
  edge_map_key = self.get_field_alias(identifier) or self.get_field_name(
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "industrial-model"
3
- version = "1.0.0"
3
+ version = "1.1.0"
4
4
  description = "Industrial Model ORM"
5
5
  readme = "README.md"
6
6
  requires-python = ">=3.11"