industrial-model 0.1.12__py3-none-any.whl → 0.1.13__py3-none-any.whl

industrial_model/__init__.py

@@ -1,9 +1,10 @@
 from .config import DataModelId
 from .engines import AsyncEngine, Engine
 from .models import (
-    AggregationResult,
+    AggregatedViewInstance,
     InstanceId,
     PaginatedResult,
+    TAggregatedViewInstance,
     TViewInstance,
     TWritableViewInstance,
     ValidationMode,
@@ -15,7 +16,7 @@ from .statements import aggregate, and_, col, not_, or_, select
 
 __all__ = [
     "aggregate",
-    "AggregationResult",
+    "AggregatedViewInstance",
     "and_",
     "or_",
     "col",
@@ -25,6 +26,7 @@ __all__ = [
     "InstanceId",
     "TViewInstance",
     "DataModelId",
+    "TAggregatedViewInstance",
     "TWritableViewInstance",
     "ValidationMode",
     "Engine",

industrial_model/cognite_adapters/__init__.py

@@ -12,7 +12,7 @@ from cognite.client.data_classes.data_modeling.query import (
 
 from industrial_model.config import DataModelId
 from industrial_model.models import (
-    AggregationResult,
+    TAggregatedViewInstance,
     TViewInstance,
     TWritableViewInstance,
 )
@@ -83,8 +83,8 @@ class CogniteAdapter:
                 return data, next_cursor_
 
     def aggregate(
-        self, statement: AggregationStatement[TViewInstance]
-    ) -> list[AggregationResult]:
+        self, statement: AggregationStatement[TAggregatedViewInstance]
+    ) -> list[dict[str, Any]]:
         query = self._aggregation_mapper.map(statement)
 
         result = self._cognite_client.data_modeling.instances.aggregate(
@@ -94,16 +94,15 @@ class CogniteAdapter:
             group_by=query.group_by_columns,
             limit=query.limit,
         )
-
-        return [
-            AggregationResult(
-                group=item.group,
-                value=item.aggregates[0].value,
-                aggregate=statement.aggregate_,
-            )
-            for item in result
-            if item.aggregates and item.aggregates[0].value is not None
-        ]
+        data: list[dict[str, Any]] = []
+        for item in result:
+            if not item.aggregates or item.aggregates[0].value is None:
+                continue
+
+            entry = item.group if item.group else {}
+            entry["value"] = item.aggregates[0].value
+            data.append(entry)
+        return data
 
     def upsert(
         self, entries: list[TWritableViewInstance], replace: bool = False

industrial_model/cognite_adapters/aggregation_mapper.py

@@ -1,12 +1,19 @@
 from dataclasses import dataclass
 
 import cognite.client.data_classes.filters as filters
-from cognite.client.data_classes.aggregations import Count, MetricAggregation
+from cognite.client.data_classes.aggregations import (
+    Avg,
+    Count,
+    Max,
+    MetricAggregation,
+    Min,
+    Sum,
+)
 from cognite.client.data_classes.data_modeling import (
     View,
 )
 
-from industrial_model.models import TViewInstance
+from industrial_model.models import TAggregatedViewInstance
 from industrial_model.statements import AggregationStatement
 
 from .filter_mapper import (
@@ -30,7 +37,7 @@ class AggregationMapper:
         self._filter_mapper = FilterMapper(view_mapper)
 
     def map(
-        self, statement: AggregationStatement[TViewInstance]
+        self, statement: AggregationStatement[TAggregatedViewInstance]
     ) -> AggregationQuery:
         root_node = statement.entity.get_view_external_id()
 
@@ -43,12 +50,18 @@ class AggregationMapper:
             if statement.where_clauses
             else None
         )
+        metric_aggregation: MetricAggregation | None = None
+        if statement.aggregate == "avg":
+            metric_aggregation = Avg(statement.aggregation_property.property)
+        elif statement.aggregate == "min":
+            metric_aggregation = Min(statement.aggregation_property.property)
+        elif statement.aggregate == "max":
+            metric_aggregation = Max(statement.aggregation_property.property)
+        elif statement.aggregate == "sum":
+            metric_aggregation = Sum(statement.aggregation_property.property)
+        elif statement.aggregate == "count":
+            metric_aggregation = Count(statement.aggregation_property.property)
 
-        metric_aggregation = (
-            Count(statement.aggregation_property.property)
-            if statement.aggregate_ == "count"
-            else None
-        )
         if metric_aggregation is None:
             raise ValueError(
                 f"Unsupported aggregate function: {statement.aggregate_}"
@@ -57,8 +70,6 @@ class AggregationMapper:
             view=root_view,
             metric_aggregation=metric_aggregation,
             filters=filters_,
-            group_by_columns=[
-                column.property for column in statement.group_by_columns
-            ],
+            group_by_columns=statement.entity.get_group_by_fields(),
             limit=statement.limit_,
         )

industrial_model/cognite_adapters/filter_mapper.py

@@ -1,4 +1,4 @@
-from datetime import datetime
+from datetime import date, datetime
 
 import cognite.client.data_classes.filters as cdf_filters
 from cognite.client.data_classes.data_modeling import MappedProperty, View
@@ -57,6 +57,9 @@ class FilterMapper:
         if isinstance(value_, datetime):
             value_ = datetime_to_ms_iso_timestamp(value_)
 
+        if isinstance(value_, date):
+            value_ = value_.strftime("%Y-%m-%d")
+
         if expression.operator == "==":
             return cdf_filters.Equals(property_ref, value_)
         elif expression.operator == "in":

industrial_model/engines/async_engine.py

@@ -2,8 +2,8 @@ from cognite.client import CogniteClient
 
 from industrial_model.config import DataModelId
 from industrial_model.models import (
-    AggregationResult,
     PaginatedResult,
+    TAggregatedViewInstance,
     TViewInstance,
     TWritableViewInstance,
     ValidationMode,
@@ -39,8 +39,8 @@ class AsyncEngine:
         )
 
     async def aggregate_async(
-        self, statement: AggregationStatement[TViewInstance]
-    ) -> list[AggregationResult]:
+        self, statement: AggregationStatement[TAggregatedViewInstance]
+    ) -> list[TAggregatedViewInstance]:
         return await run_async(self._engine.aggregate, statement)
 
     async def upsert_async(

industrial_model/engines/engine.py

@@ -5,9 +5,9 @@ from cognite.client import CogniteClient
 from industrial_model.cognite_adapters import CogniteAdapter
 from industrial_model.config import DataModelId
 from industrial_model.models import (
-    AggregationResult,
     EdgeContainer,
     PaginatedResult,
+    TAggregatedViewInstance,
     TViewInstance,
     TWritableViewInstance,
     ValidationMode,
@@ -49,9 +49,11 @@ class Engine:
         return self._validate_data(statement.entity, data, validation_mode)
 
     def aggregate(
-        self, statement: AggregationStatement[TViewInstance]
-    ) -> list[AggregationResult]:
-        return self._cognite_adapter.aggregate(statement)
+        self, statement: AggregationStatement[TAggregatedViewInstance]
+    ) -> list[TAggregatedViewInstance]:
+        data = self._cognite_adapter.aggregate(statement)
+
+        return [statement.entity.model_validate(item) for item in data]
 
     def upsert(
         self, entries: list[TWritableViewInstance], replace: bool = False

industrial_model/models/__init__.py

@@ -1,9 +1,10 @@
 from .base import RootModel
 from .entities import (
-    AggregationResult,
+    AggregatedViewInstance,
     EdgeContainer,
     InstanceId,
     PaginatedResult,
+    TAggregatedViewInstance,
     TViewInstance,
     TWritableViewInstance,
     ValidationMode,
@@ -14,10 +15,11 @@ from .entities import (
 from .schemas import get_parent_and_children_nodes, get_schema_properties
 
 __all__ = [
-    "AggregationResult",
+    "AggregatedViewInstance",
     "RootModel",
     "EdgeContainer",
     "InstanceId",
+    "TAggregatedViewInstance",
     "TViewInstance",
     "TWritableViewInstance",
     "ViewInstance",

industrial_model/models/base.py

@@ -44,3 +44,14 @@ class RootModel(BaseModel):
         populate_by_name=True,
         from_attributes=True,
     )
+
+    def get_field_name(self, field_name_or_alias: str) -> str | None:
+        entry = self.__class__.model_fields.get(field_name_or_alias)
+        if entry:
+            return field_name_or_alias
+
+        for key, field_info in self.__class__.model_fields.items():
+            if field_info.alias == field_name_or_alias:
+                return key
+
+        return None

industrial_model/models/entities.py

@@ -56,17 +56,6 @@ class ViewInstance(InstanceId, metaclass=DBModelMetaclass):
     def get_view_external_id(cls) -> str:
         return cls.view_config.get("view_external_id") or cls.__name__
 
-    def get_field_name(self, field_name_or_alias: str) -> str | None:
-        entry = self.__class__.model_fields.get(field_name_or_alias)
-        if entry:
-            return field_name_or_alias
-
-        for key, field_info in self.__class__.model_fields.items():
-            if field_info.alias == field_name_or_alias:
-                return key
-
-        return None
-
 
 class WritableViewInstance(ViewInstance):
     @abstractmethod
@@ -78,10 +67,33 @@ class WritableViewInstance(ViewInstance):
         )
 
 
+class AggregatedViewInstance(RootModel, metaclass=DBModelMetaclass):
+    view_config: ClassVar[ViewInstanceConfig] = ViewInstanceConfig()
+
+    value: float
+
+    @classmethod
+    def get_view_external_id(cls) -> str:
+        return cls.view_config.get("view_external_id") or cls.__name__
+
+    @classmethod
+    def get_group_by_fields(cls) -> list[str]:
+        group_by_fields: set[str] = set()
+        for key, field_info in cls.model_fields.items():
+            if key == "value":
+                continue
+            group_by_fields.add(field_info.alias or key)
+
+        return list(group_by_fields)
+
+
 TViewInstance = TypeVar("TViewInstance", bound=ViewInstance)
 TWritableViewInstance = TypeVar(
     "TWritableViewInstance", bound=WritableViewInstance
 )
+TAggregatedViewInstance = TypeVar(
+    "TAggregatedViewInstance", bound=AggregatedViewInstance
+)
 
 
 class PaginatedResult(RootModel, Generic[TViewInstance]):
@@ -90,10 +102,4 @@ class PaginatedResult(RootModel, Generic[TViewInstance]):
     next_cursor: str | None
 
 
-class AggregationResult(RootModel):
-    group: dict[str, str | int | float | bool | InstanceId] | None
-    value: float
-    aggregate: str
-
-
 ValidationMode = Literal["raiseOnError", "ignoreOnError"]

industrial_model/statements/__init__.py

@@ -63,30 +63,24 @@ class Statement(Generic[T]):
         return self
 
 
+AggregateTypes = Literal["count", "avg", "min", "max", "sum"]
+
+
 @dataclass
 class AggregationStatement(Generic[T]):
-    aggregate_: Literal["count"] = field(init=False, default="count")
+    entity: type[T] = field(init=True)
+    aggregate: AggregateTypes = field(init=True)
+
     aggregation_property: Column = field(
         init=False, default=Column("externalId")
     )
-
-    entity: type[T] = field(init=True)
-    group_by_columns: list[Column] = field(init=False, default_factory=list)
     where_clauses: list[Expression] = field(init=False, default_factory=list)
     limit_: int = field(init=False, default=-1)
 
-    def aggregate(self, aggregates: Literal["count"]) -> Self:
-        self.aggregate_ = aggregates
-        return self
-
     def aggregate_by(self, property: str | Column | Any) -> Self:
         self.aggregation_property = _create_column(property)
         return self
 
-    def group_by(self, *property: str | Column | Any) -> Self:
-        self.group_by_columns.extend(_create_column(p) for p in property)
-        return self
-
     def where(self, *expressions: bool | Expression) -> Self:
         for expression in expressions:
             assert isinstance(expression, Expression)
@@ -102,8 +96,11 @@ def select(entity: type[T]) -> Statement[T]:
     return Statement(entity)
 
 
-def aggregate(entity: type[T]) -> AggregationStatement[T]:
-    return AggregationStatement(entity)
+def aggregate(
+    entity: type[T],
+    aggregate: AggregateTypes = "count",
+) -> AggregationStatement[T]:
+    return AggregationStatement(entity=entity, aggregate=aggregate)
 
 
 __all__ = [

{industrial_model-0.1.12.dist-info → industrial_model-0.1.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: industrial-model
-Version: 0.1.12
+Version: 0.1.13
 Summary: Industrial Model ORM
 Author-email: Lucas Alves <lucasrosaalves@gmail.com>
 Classifier: Programming Language :: Python
@@ -50,14 +50,19 @@ from cognite.client import CogniteClient
 from pydantic import Field
 
 from industrial_model import (
+    aggregate,
+    AggregatedViewInstance,
     AsyncEngine,
     DataModelId,
     Engine,
+    InstanceId,
     ViewInstance,
-    select,
-    col,
+    ViewInstanceConfig,
+    WritableViewInstance,
     and_,
+    col,
     or_,
+    select,
 )
 
 # Define entities (view instances)
@@ -184,12 +189,10 @@ all_results = engine.query_all_pages(statement)
 
 # 7. Data Ingestion
 
-from industrial_model import (
-    WritableViewInstance  # necessary for data ingestion
-)
-
-
 class WritablePerson(WritableViewInstance):
+    view_config = ViewInstanceConfig(
+        view_external_id="Person"                    # Maps this class to the 'Person' view
+    )
     name: str
     lives_in: InstanceId
     cars: list[InstanceId]
@@ -203,10 +206,7 @@ class WritablePerson(WritableViewInstance):
             space=self.space,
         )
 
-statement = select(WritablePerson).where(
-    (WritablePerson.external_id == "Lucas") 
-)
-
+statement = select(WritablePerson).where(WritablePerson.external_id == "Lucas")
 person = engine.query_all_pages(statement)[0]
 
 person.lives_in = InstanceId(external_id="br", space="data-space")
@@ -214,7 +214,21 @@ person.cars.clear() # Gonna remove all car edges from the person
 
 engine.upsert([person])
 
-```
 
 
+# 8. Aggregate
+
+class AggregateByNamePerson(AggregatedViewInstance):
+    view_config = ViewInstanceConfig(
+        view_external_id="Person"  # Maps this class to the 'Person' view
+    )
+
+    name: str  # group by name
+
+
+aggregate_result = engine.aggregate(aggregate(AggregateByNamePerson, "count"))
+
+
+```
+
 ---

{industrial_model-0.1.12.dist-info → industrial_model-0.1.13.dist-info}/RECORD

@@ -1,11 +1,11 @@
-industrial_model/__init__.py,sha256=13TekQQlw7euJr1pIncV1R1Z8cWtvCPPx5e6s0NY_C0,711
+industrial_model/__init__.py,sha256=JyQbC-Qz4yI2lH0vfD1QXx2EJwe73frLIsXU_gfbMIU,781
 industrial_model/config.py,sha256=bNEfjgD2vth4RPGKDwjGmh0edleQ95g__UJGHV4vix0,520
 industrial_model/constants.py,sha256=wtFdxkR9gojqekwXeyVCof6VUkJYuqjjgAgVVKrcxaw,450
 industrial_model/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 industrial_model/utils.py,sha256=oh4AxwxXaWgIC2uolkCbvkgo0ququHB6yAPVIXy45Ts,663
-industrial_model/cognite_adapters/__init__.py,sha256=a7xPiSkuWkVxvsmVfFD-lOzdOc-tTNo8JmbyL5tC-68,5461
-industrial_model/cognite_adapters/aggregation_mapper.py,sha256=wG8ottGilTAJcpf2kQvhvyRmDBpSKiT4esx0P5kmZBU,1845
-industrial_model/cognite_adapters/filter_mapper.py,sha256=NqH-OW7_iKFY9POCG8W3KjkwXUgrZP1d_yxDx1J0fXM,3859
+industrial_model/cognite_adapters/__init__.py,sha256=MxX7Z6VntqmP8luG1CzbMBFu_K0ls8iU2diLsrEjLCk,5492
+industrial_model/cognite_adapters/aggregation_mapper.py,sha256=rXt2BZ2jS3afD9d3B2t8aizL9TWnMnqCCNdzTn_XR3Y,2362
+industrial_model/cognite_adapters/filter_mapper.py,sha256=X2BVp305v1Wt00DTZEnCooOG_g6Jo7bkj-NyfRtECAE,3952
 industrial_model/cognite_adapters/models.py,sha256=2j2IS01uPkQEp9WdVk8seYzEqGcDdWFnpzXhusHB2zk,945
 industrial_model/cognite_adapters/optimizer.py,sha256=BbbsA3r9ZKJt6mN1wVRZc046ov-vbml9_ESfurTNRUg,2477
 industrial_model/cognite_adapters/query_mapper.py,sha256=3fEcaLsGjLKIh-g1BbMcffQ6rp99JeCW555iJo8JW44,6260
@@ -15,17 +15,17 @@ industrial_model/cognite_adapters/upsert_mapper.py,sha256=tWEiBJQeeNz1HDu0AoBIfC
 industrial_model/cognite_adapters/utils.py,sha256=rztCtS10ZTQmXfBv0nLgDiQIMWemhdSFK-SwrbRjVxM,4792
 industrial_model/cognite_adapters/view_mapper.py,sha256=qvT25gwIgPdAqZf-oQEh0GylUi5KEPwjLNmIl5ISQGA,1474
 industrial_model/engines/__init__.py,sha256=7aGHrUm2MxIq39vR8h0xu3i1zNOuT9H9U-q4lV3nErQ,102
-industrial_model/engines/async_engine.py,sha256=qILOHTBnq8DOwHoGnBQ6qrRh2zv2-0rjBd36hqWXM0w,1523
-industrial_model/engines/engine.py,sha256=fSJL0i7TwJsVP_-uNrN_WoxToCpwidIik58KREEw-oQ,3003
-industrial_model/models/__init__.py,sha256=klwPCssjGx-0rGi8aBLzP6GWO9kgR7zDAo93el9hQ1I,672
-industrial_model/models/base.py,sha256=jbiaICJ0R1mmxXtDqxxlVdq-tTX4RLdqnLTgs9HLm_4,1279
-industrial_model/models/entities.py,sha256=xWvkGp0tCuI5wMAG-rfnh8bmsiJXtc7uNEXJ1RJL4GU,2519
+industrial_model/engines/async_engine.py,sha256=XgDKCHh4gi2mPBknp7MM4mRsuA_224NesIZ7xq1YQic,1545
+industrial_model/engines/engine.py,sha256=DaA34P1aL_qvL691OG_-g_yCC-U2ZJr9tF32Pl5vpP4,3098
+industrial_model/models/__init__.py,sha256=AzJ0CyPK5PvUCX45FFtybl13tkukUvk2UAF_90s_LQ8,742
+industrial_model/models/base.py,sha256=iGhDjXqA5ULEQIFHtkMi7WYJl0nQq1wi8_zqOr-Ep78,1649
+industrial_model/models/entities.py,sha256=GZu-Y5ZalhXM8EHTzBe4hCKA2Dryk8J99p_FTVNX2jc,2709
 industrial_model/models/schemas.py,sha256=LKNPDnUy1jtMyOHDf28En9vThhdzOSswewIcjC_y-6U,4393
 industrial_model/queries/__init__.py,sha256=7aheTE5qs03rxWm9fmGWptbz_p9OIXXYD8if56cqs18,227
 industrial_model/queries/models.py,sha256=iiHQ7-cfg0nukEv5PoCx9QPF-w1gVSnoNbXBOK9Mzeo,1185
 industrial_model/queries/params.py,sha256=ehgCoR5n6E-tkEuoymZ2lkLcSzMaBAx_HnyJ7sWpqz0,964
-industrial_model/statements/__init__.py,sha256=Y57G1TJlYxCHg3Zz7ojQoAMVnCMaUCRRWXEm2IcbAWo,3332
+industrial_model/statements/__init__.py,sha256=15LI9POLUdh6i3Zw0Aek0fVFfcTj8P8ZEa1Cli3pgXQ,3095
 industrial_model/statements/expressions.py,sha256=Sar1cIvy3sYi7tkWJN3ylHlZ252oN2mZJpZ1TX9jN3s,4940
-industrial_model-0.1.12.dist-info/METADATA,sha256=NK9n4THFdg-uVxO24RZiB-OOp0TfTQxra-YMHO30VxM,5698
-industrial_model-0.1.12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-industrial_model-0.1.12.dist-info/RECORD,,
+industrial_model-0.1.13.dist-info/METADATA,sha256=SVjWvzWjDcTnXYVMMs1zIqJTZjadxGrydjjoHVlPo7w,6144
+industrial_model-0.1.13.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+industrial_model-0.1.13.dist-info/RECORD,,