cognite-neat 0.121.1__tar.gz → 0.122.0__tar.gz

{cognite_neat-0.121.1 → cognite_neat-0.122.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.121.1
+Version: 0.122.0
 Summary: Knowledge graph transformation
 Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
 Project-URL: Homepage, https://cognite-neat.readthedocs-hosted.com/
@@ -67,9 +67,9 @@ Description-Content-Type: text/markdown
 
 NEAT is a domain expert centric and developer friendly solution for rapid:
 
-- semantic data modeling
-- creation, transformation and enrichment of knowledge graphs
-- and ingestion of the models and graphs into [Cognite Data Fusion](https://www.cognite.com/en/product/cognite_data_fusion_industrial_dataops_platform)
+- data modeling
+- extraction, transformation and loading of instances
+- and ingestion of the models and instances (i.e. knowledge graphs) into [Cognite Data Fusion](https://www.cognite.com/en/product/cognite_data_fusion_industrial_dataops_platform)
 
 NEAT is using open and globally recognized standards maintained by the [World Wide Web Consortium (W3C)](https://www.w3.org/RDF/).
 NEAT represents an essential tool for creation of standardized, machine-actionable, linked and semantic (meta)data.
@@ -85,13 +85,12 @@ By mid of 2022, sheet2rdf was used in several POCs in Cognite. As Cognite's Data
 
 Presented in various forums in 2022, this approach paved the way for NEAT’s formal development in November 2022 to enable cost-saving and empowerment of Cognite customers to self-sufficiently maintain and onboard knowledge graphs to Cognite Data Fusion.
 
-
 ## Authorship
 
 ### Authors
 The plot below shows the NEAT authorship from the start until present day.
 
-![NEAT authorship](./docs/artifacts/figs/authorship.png)
+![NEAT authorship](./artifacts/figs/authorship.png)
 
 #### Current authors
 - [Nikola Vasiljević](www.linkedin.com/in/thisisnikola)
@@ -108,9 +107,17 @@ We are very grateful for the contributions made by:
 
 - [Marie Solvik Lepoutre](https://www.linkedin.com/in/mslepoutre/), who improved RDF triples projections to Cognite Data Fusion
 - [Bård Henning Tvedt](https://www.linkedin.com/in/bhtvedt/), who implemented IMF importer
+- [Hassan Gomaa](https://www.linkedin.com/in/dr-hassan-gomaa-232638121/), who extended the DEXPI extractor
 - [Kristina Tomičić](https://www.linkedin.com/in/kristina-tomicic-6bb443108/), who implemented Data Model and Instances visualization
 
 
+## Sponsors
+NEAT is developed and maintained by Cognite. We are grateful for the past support of our sponsors, who funded us to develop NEAT and to make it open source.
+
+- [Statnett](https://www.statnett.no/) - the MIMIR team ([Ola Hagen Øyan](https://www.linkedin.com/in/ola-%C3%B8yan-b0205b19/), [Olav Westeng Alstad](https://www.linkedin.com/in/olav-w-alstad-52329191/),[Andreas Kimsås](https://www.linkedin.com/in/andreas-kims%C3%A5s-964a0b2/) and [Anders Willersrud](https://www.linkedin.com/in/anders-willersrud-13a20220/)) – who supported the development of NEAT from end of 2022 to mid of 2023 and its integration with Statnett's infrastructure, where NEAT was battle-tested as a tool for non-sematic experts to define data models and transform large knowledge graphs representing the entire Norwegian power grid system. Without Statnett's support NEAT would not exist in the first place, and would not be open-source.
+- [Aker Solutions](https://www.akersolutions.com/) – the IMod Team (currently lead by [Maria Kenderkova](https://www.linkedin.com/in/maria-kenderkova/)), who funded development of NEAT from mid of 2023 till end of 2024 (multi-level and role-based data modeling, support for ontologies, IMF, DEXPI, AML,...) , as well who were early adopters and embraced NEAT and who were patient with us when things did not work so well. Aker Solutions was instrumental to elevating NEAT to a product level, and who selflessly advocate for NEAT globally.
+
+
 ## Installation
 
 ```bash
@@ -134,4 +141,4 @@ neat.read.cdf.data_model(("my_space", "MyDataModel", "v1"))
 
 ## Documentation
 
-For more information, see the [documentation](https://cognite-neat.readthedocs-hosted.com/en/latest/)
+For more information, see the [documentation](https://cognite-neat.readthedocs-hosted.com/en/latest/)

{cognite_neat-0.121.1 → cognite_neat-0.122.0}/README.md

@@ -13,9 +13,9 @@
 
 NEAT is a domain expert centric and developer friendly solution for rapid:
 
-- semantic data modeling
-- creation, transformation and enrichment of knowledge graphs
-- and ingestion of the models and graphs into [Cognite Data Fusion](https://www.cognite.com/en/product/cognite_data_fusion_industrial_dataops_platform)
+- data modeling
+- extraction, transformation and loading of instances
+- and ingestion of the models and instances (i.e. knowledge graphs) into [Cognite Data Fusion](https://www.cognite.com/en/product/cognite_data_fusion_industrial_dataops_platform)
 
 NEAT is using open and globally recognized standards maintained by the [World Wide Web Consortium (W3C)](https://www.w3.org/RDF/).
 NEAT represents an essential tool for creation of standardized, machine-actionable, linked and semantic (meta)data.
@@ -31,13 +31,12 @@ By mid of 2022, sheet2rdf was used in several POCs in Cognite. As Cognite's Data
 
 Presented in various forums in 2022, this approach paved the way for NEAT’s formal development in November 2022 to enable cost-saving and empowerment of Cognite customers to self-sufficiently maintain and onboard knowledge graphs to Cognite Data Fusion.
 
-
 ## Authorship
 
 ### Authors
 The plot below shows the NEAT authorship from the start until present day.
 
-![NEAT authorship](./docs/artifacts/figs/authorship.png)
+![NEAT authorship](./artifacts/figs/authorship.png)
 
 #### Current authors
 - [Nikola Vasiljević](www.linkedin.com/in/thisisnikola)
@@ -54,9 +53,17 @@ We are very grateful for the contributions made by:
 
 - [Marie Solvik Lepoutre](https://www.linkedin.com/in/mslepoutre/), who improved RDF triples projections to Cognite Data Fusion
 - [Bård Henning Tvedt](https://www.linkedin.com/in/bhtvedt/), who implemented IMF importer
+- [Hassan Gomaa](https://www.linkedin.com/in/dr-hassan-gomaa-232638121/), who extended the DEXPI extractor
 - [Kristina Tomičić](https://www.linkedin.com/in/kristina-tomicic-6bb443108/), who implemented Data Model and Instances visualization
 
 
+## Sponsors
+NEAT is developed and maintained by Cognite. We are grateful for the past support of our sponsors, who funded us to develop NEAT and to make it open source.
+
+- [Statnett](https://www.statnett.no/) - the MIMIR team ([Ola Hagen Øyan](https://www.linkedin.com/in/ola-%C3%B8yan-b0205b19/), [Olav Westeng Alstad](https://www.linkedin.com/in/olav-w-alstad-52329191/),[Andreas Kimsås](https://www.linkedin.com/in/andreas-kims%C3%A5s-964a0b2/) and [Anders Willersrud](https://www.linkedin.com/in/anders-willersrud-13a20220/)) – who supported the development of NEAT from end of 2022 to mid of 2023 and its integration with Statnett's infrastructure, where NEAT was battle-tested as a tool for non-sematic experts to define data models and transform large knowledge graphs representing the entire Norwegian power grid system. Without Statnett's support NEAT would not exist in the first place, and would not be open-source.
+- [Aker Solutions](https://www.akersolutions.com/) – the IMod Team (currently lead by [Maria Kenderkova](https://www.linkedin.com/in/maria-kenderkova/)), who funded development of NEAT from mid of 2023 till end of 2024 (multi-level and role-based data modeling, support for ontologies, IMF, DEXPI, AML,...) , as well who were early adopters and embraced NEAT and who were patient with us when things did not work so well. Aker Solutions was instrumental to elevating NEAT to a product level, and who selflessly advocate for NEAT globally.
+
+
 ## Installation
 
 ```bash
@@ -80,4 +87,4 @@ neat.read.cdf.data_model(("my_space", "MyDataModel", "v1"))
 
 ## Documentation
 
-For more information, see the [documentation](https://cognite-neat.readthedocs-hosted.com/en/latest/)
+For more information, see the [documentation](https://cognite-neat.readthedocs-hosted.com/en/latest/)

cognite_neat-0.122.0/cognite/neat/_version.py

@@ -0,0 +1,2 @@
+__version__ = "0.122.0"
+__engine__ = "^2.0.4"

cognite_neat-0.122.0/cognite/neat/core/_client/_api/statistics.py

@@ -0,0 +1,91 @@
+import itertools
+from typing import overload
+
+from cognite.client._api_client import APIClient
+from cognite.client._cognite_client import CogniteClient
+from cognite.client.config import ClientConfig
+from cognite.client.data_classes.data_modeling.ids import _load_space_identifier
+from cognite.client.utils.useful_types import SequenceNotStr
+
+from cognite.neat.core._client.data_classes.statistics import (
+    ProjectStatsAndLimits,
+    SpaceInstanceCounts,
+    SpaceInstanceCountsList,
+)
+
+
+class StatisticsAPI(APIClient):
+    _RESOURCE_PATH = "/models/statistics"
+
+    def __init__(self, config: ClientConfig, api_version: str | None, cognite_client: CogniteClient) -> None:
+        # This is an alpha API, which requires a specific version.
+        super().__init__(config, "v1", cognite_client)
+        self._RETRIEVE_LIMIT = 100
+
+    def project(self) -> ProjectStatsAndLimits:
+        """`Retrieve project-wide usage data and limits
+
+        Returns the usage data and limits for a project's data modelling usage, including data model schemas
+        and graph instances
+
+        Returns:
+            ProjectStatsAndLimits: The requested statistics and limits
+
+        Examples:
+            Fetch project statistics (and limits) and check the current number of data models vs.
+            and how many more can be created:
+                >>> from cognite.neat.core._client import NeatClient
+                >>> client = NeatClient()
+                >>> stats = client.instance_statistics.project()
+                >>> num_dm = stats.data_models.current
+                >>> num_dm_left = stats.data_models.limit - num_dm
+        """
+        response_data = self._get(self._RESOURCE_PATH).json()
+        if "project" not in response_data:
+            response_data["project"] = self._cognite_client._config.project
+        return ProjectStatsAndLimits._load(response_data)
+
+    @overload
+    def list(self, space: str) -> SpaceInstanceCounts: ...
+
+    @overload
+    def list(self, space: SequenceNotStr[str] | None = None) -> SpaceInstanceCountsList: ...
+
+    def list(self, space: str | SequenceNotStr[str] | None = None) -> SpaceInstanceCounts | SpaceInstanceCountsList:
+        """`Retrieve usage data and limits per space
+
+        Args:
+            space (str | SequenceNotStr[str] | None): The space or spaces to retrieve statistics for.
+                If None, all spaces will be retrieved.
+
+        Returns:
+            SpaceInstanceCounts | SpaceInstanceCountsList: InstanceStatsPerSpace if a single space is given, else
+                InstanceStatsList (which is a list of InstanceStatsPerSpace)
+
+        Examples:
+            Fetch statistics for a single space:
+                >>> from cognite.neat.core._client import NeatClient
+                >>> client = NeatClient()
+                >>> res = client.instance_statistics.list("my-space")
+            Fetch statistics for multiple spaces:
+                >>> res = client.instance_statistics.list(
+                ...     ["my-space1", "my-space2"]
+                ... )
+            Fetch statistics for all spaces (ignores the 'space' argument):
+                >>> res = client.instance_statistics.list(return_all=True)
+        """
+        if space is None:
+            return SpaceInstanceCountsList._load(self._get(self._RESOURCE_PATH + "/spaces").json()["items"])
+
+        is_single = isinstance(space, str)
+
+        ids = _load_space_identifier(space)
+        result = SpaceInstanceCountsList._load(
+            itertools.chain.from_iterable(
+                self._post(self._RESOURCE_PATH + "/spaces/byids", json={"items": chunk.as_dicts()}).json()["items"]
+                for chunk in ids.chunked(self._RETRIEVE_LIMIT)
+            )
+        )
+        if is_single:
+            return result[0]
+        return result

{cognite_neat-0.121.1 → cognite_neat-0.122.0}/cognite/neat/core/_client/_api_client.py

@@ -5,6 +5,7 @@ from cognite.neat.core._utils.auth import _CLIENT_NAME
 from ._api.data_modeling_loaders import DataModelLoaderAPI
 from ._api.neat_instances import NeatInstancesAPI
 from ._api.schema import SchemaAPI
+from ._api.statistics import StatisticsAPI
 
 
 class NeatClient(CogniteClient):
@@ -17,3 +18,4 @@ class NeatClient(CogniteClient):
         self.loaders = DataModelLoaderAPI(self)
         self.schema = SchemaAPI(self)
         self.instances = NeatInstancesAPI(self)
+        self.instance_statistics = StatisticsAPI(self._config, self._config.api_subversion, self)

cognite_neat-0.122.0/cognite/neat/core/_client/data_classes/statistics.py

@@ -0,0 +1,125 @@
+from dataclasses import dataclass
+from typing import Any
+
+from cognite.client import CogniteClient
+from cognite.client.data_classes._base import CogniteObject, CogniteResource, CogniteResourceList
+from typing_extensions import Self
+
+
+@dataclass
+class InstanceCounts(CogniteResource):
+    nodes: int
+    edges: int
+    soft_deleted_nodes: int
+    soft_deleted_edges: int
+
+    @classmethod
+    def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
+        return cls(
+            nodes=resource["nodes"],
+            edges=resource["edges"],
+            soft_deleted_nodes=resource["softDeletedNodes"],
+            soft_deleted_edges=resource["softDeletedEdges"],
+        )
+
+
+@dataclass
+class SpaceInstanceCounts(InstanceCounts):
+    space: str
+
+    @classmethod
+    def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
+        return cls(
+            space=resource["space"],
+            nodes=resource["nodes"],
+            edges=resource["edges"],
+            soft_deleted_nodes=resource["softDeletedNodes"],
+            soft_deleted_edges=resource["softDeletedEdges"],
+        )
+
+
+class SpaceInstanceCountsList(CogniteResourceList):
+    _RESOURCE = SpaceInstanceCounts
+
+
+@dataclass
+class CountLimitPair(CogniteObject):
+    count: int
+    limit: int
+
+    @classmethod
+    def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
+        return cls(
+            count=resource["count"],
+            limit=resource["limit"],
+        )
+
+
+@dataclass
+class InstanceCountsLimits(InstanceCounts):
+    instances_limit: int
+    soft_deleted_instances_limit: int
+
+    @property
+    def instances(self) -> int:
+        return self.nodes + self.edges
+
+    @property
+    def soft_deleted_instances(self) -> int:
+        return self.soft_deleted_nodes + self.soft_deleted_edges
+
+    @classmethod
+    def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
+        return cls(
+            nodes=resource["nodes"],
+            edges=resource["edges"],
+            soft_deleted_nodes=resource["softDeletedNodes"],
+            soft_deleted_edges=resource["softDeletedEdges"],
+            instances_limit=resource["instancesLimit"],
+            soft_deleted_instances_limit=resource["softDeletedInstancesLimit"],
+        )
+
+
+@dataclass
+class ProjectStatsAndLimits(CogniteResource):
+    project: str
+    spaces: CountLimitPair
+    containers: CountLimitPair
+    views: CountLimitPair
+    data_models: CountLimitPair
+    container_properties: CountLimitPair
+    instances: InstanceCountsLimits
+    concurrent_read_limit: int
+    concurrent_write_limit: int
+    concurrent_delete_limit: int
+
+    @classmethod
+    def _load(cls, data: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
+        return cls(
+            project=data["project"],
+            spaces=CountLimitPair._load(data["spaces"]),
+            containers=CountLimitPair._load(data["containers"]),
+            views=CountLimitPair._load(data["views"]),
+            data_models=CountLimitPair._load(data["dataModels"]),
+            container_properties=CountLimitPair._load(data["containerProperties"]),
+            instances=InstanceCountsLimits._load(data["instances"]),
+            concurrent_read_limit=data["concurrentReadLimit"],
+            concurrent_write_limit=data["concurrentWriteLimit"],
+            concurrent_delete_limit=data["concurrentDeleteLimit"],
+        )
+
+    def dump(self, camel_case: bool = True) -> dict[str, Any]:
+        return {
+            "project": self.project,
+            "spaces": self.spaces.dump(camel_case=camel_case),
+            "containers": self.containers.dump(camel_case=camel_case),
+            "views": self.views.dump(camel_case=camel_case),
+            "dataModels" if camel_case else "data_models": self.data_models.dump(camel_case=camel_case),
+            "containerProperties" if camel_case else "container_properties": self.container_properties.dump(
+                camel_case=camel_case
+            ),
+            "instances": self.instances.dump(camel_case=camel_case),
+            "concurrentReadLimit" if camel_case else "concurrent_read_limit": self.concurrent_read_limit,
+            "concurrentWriteLimit" if camel_case else "concurrent_write_limit": self.concurrent_write_limit,
+            "concurrentDeleteLimit" if camel_case else "concurrent_delete_limit": self.concurrent_delete_limit,
+        }

{cognite_neat-0.121.1 → cognite_neat-0.122.0}/cognite/neat/core/_client/testing.py

@@ -1,6 +1,7 @@
 from collections.abc import Iterator
 from contextlib import contextmanager
 from typing import Any
+from unittest.mock import MagicMock
 
 from cognite.client.testing import CogniteClientMock
 
@@ -9,6 +10,7 @@ from cognite.neat.core._client._api_client import NeatClient
 from ._api.data_modeling_loaders import DataModelLoaderAPI
 from ._api.neat_instances import NeatInstancesAPI
 from ._api.schema import SchemaAPI
+from ._api.statistics import StatisticsAPI
 
 
 class NeatClientMock(CogniteClientMock):
@@ -22,6 +24,8 @@ class NeatClientMock(CogniteClientMock):
             super().__init__(*args, **kwargs)
             return
         super().__init__(*args, **kwargs)
+        self.instance_statistics = MagicMock(spec_set=StatisticsAPI)
+
         self.schema = SchemaAPI(self)
         self.loaders = DataModelLoaderAPI(self)
         self.instances = NeatInstancesAPI(self)

{cognite_neat-0.121.1 → cognite_neat-0.122.0}/cognite/neat/core/_constants.py

@@ -12,7 +12,7 @@ from cognite import neat
 from cognite.neat.core._issues.errors._general import NeatValueError
 
 if TYPE_CHECKING:
-    from cognite.neat.core._data_model.models.dms import DMSProperty
+    from cognite.neat.core._data_model.models.physical import PhysicalProperty
 
 
 def _is_in_notebook() -> bool:
@@ -104,9 +104,8 @@ COGNITE_CONCEPTS = (
 
 DMS_LISTABLE_PROPERTY_LIMIT = 1000
 
-EXAMPLE_RULES = PACKAGE_DIRECTORY / "_rules" / "examples"
-EXAMPLE_GRAPHS = PACKAGE_DIRECTORY / "_graph" / "examples"
-EXAMPLE_WORKFLOWS = PACKAGE_DIRECTORY / "_workflows" / "examples"
+EXAMPLE_DATA_MODELS = PACKAGE_DIRECTORY / "core" / "_data_model" / "examples"
+EXAMPLE_GRAPHS = PACKAGE_DIRECTORY / "core" / "_instances" / "examples"
 
 DEFAULT_SPACE_URI = "http://purl.org/cognite/space/{space}#"
 SPACE_URI_PATTERN = re.compile(r"http://purl.org/cognite/space/(?P<space>[^#]+)#$")
@@ -196,11 +195,11 @@ _ASSET_PATH_PROPERTY = {
 BASE_MODEL = Literal["CogniteCore"]
 
 
-def get_asset_read_only_properties_with_connection() -> "list[DMSProperty]":
+def get_asset_read_only_properties_with_connection() -> "list[PhysicalProperty]":
     """Gets the asset read-only properties with connection, i.e. Root and Path."""
-    from cognite.neat.core._data_model.models.dms import DMSProperty
+    from cognite.neat.core._data_model.models.physical import PhysicalProperty
 
-    return [DMSProperty.model_validate(item) for item in (_ASSET_ROOT_PROPERTY, _ASSET_PATH_PROPERTY)]
+    return [PhysicalProperty.model_validate(item) for item in (_ASSET_ROOT_PROPERTY, _ASSET_PATH_PROPERTY)]
 
 
 def get_base_concepts(

{cognite_neat-0.121.1 → cognite_neat-0.122.0}/cognite/neat/core/_data_model/_constants.py

@@ -15,9 +15,10 @@ class EntityTypes(StrEnum):
     predicate = "predicate"
     object = "object"
     class_ = "class"
+    concept = "concept"
     parent_class = "parent_class"
     property_ = "property"
-    dms_property = "dms_property"
+    physical_property = "physical_property"
     conceptual_property = "conceptual_property"
     object_property = "ObjectProperty"
     data_property = "DatatypeProperty"
@@ -43,9 +44,11 @@ class EntityTypes(StrEnum):
     space = "space"
 
 
-def get_reserved_words(key: Literal["class", "view", "property", "space"]) -> list[str]:
+def get_reserved_words(
+    key: Literal["concept", "view", "property", "space"],
+) -> list[str]:
     return {
-        "class": ["Class", "class"],
+        "concept": ["Concept", "concept"],
         "view": [
             "Query",
             "Mutation",
@@ -103,10 +106,14 @@ DATA_MODEL_COMPLIANCE_REGEX = r"^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$"
 VIEW_ID_COMPLIANCE_REGEX = (
     rf"(?!^({'|'.join(get_reserved_words('view'))})$)" r"(^[a-zA-Z][a-zA-Z0-9_]{0,253}[a-zA-Z0-9]?$)"
 )
-DMS_PROPERTY_ID_COMPLIANCE_REGEX = (
-    rf"(?!^({'|'.join(get_reserved_words('property'))})$)" r"(^[a-zA-Z][a-zA-Z0-9_]{0,253}[a-zA-Z0-9]?$)"
+PHYSICAL_PROPERTY_ID_COMPLIANCE_REGEX = (
+    rf"(?!^({'|'.join(get_reserved_words('property'))})$)"
+    r"(^[a-zA-Z][a-zA-Z0-9_]{0,253}[a-zA-Z0-9]?$)"
+)
+CONCEPT_ID_COMPLIANCE_REGEX = (
+    rf"(?!^({'|'.join(get_reserved_words('concept'))})$)"
+    r"(^[a-zA-Z0-9._-]{0,253}[a-zA-Z0-9]?$)"
 )
-CLASS_ID_COMPLIANCE_REGEX = rf"(?!^({'|'.join(get_reserved_words('class'))})$)" r"(^[a-zA-Z0-9._-]{0,253}[a-zA-Z0-9]?$)"
 
 INFORMATION_PROPERTY_ID_COMPLIANCE_REGEX = r"^(\*)|(?!^(Property|property)$)(^[a-zA-Z0-9._-]{0,253}[a-zA-Z0-9]?$)"
 VERSION_COMPLIANCE_REGEX = r"^[a-zA-Z0-9]([.a-zA-Z0-9_-]{0,41}[a-zA-Z0-9])?$"
@@ -139,15 +146,15 @@ class _Patterns:
         return re.compile(VIEW_ID_COMPLIANCE_REGEX)
 
     @cached_property
-    def dms_property_id_compliance(self) -> re.Pattern[str]:
-        return re.compile(DMS_PROPERTY_ID_COMPLIANCE_REGEX)
+    def physical_property_id_compliance(self) -> re.Pattern[str]:
+        return re.compile(PHYSICAL_PROPERTY_ID_COMPLIANCE_REGEX)
 
     @cached_property
-    def class_id_compliance(self) -> re.Pattern[str]:
-        return re.compile(CLASS_ID_COMPLIANCE_REGEX)
+    def concept_id_compliance(self) -> re.Pattern[str]:
+        return re.compile(CONCEPT_ID_COMPLIANCE_REGEX)
 
     @cached_property
-    def information_property_id_compliance(self) -> re.Pattern[str]:
+    def conceptual_property_id_compliance(self) -> re.Pattern[str]:
         return re.compile(INFORMATION_PROPERTY_ID_COMPLIANCE_REGEX)
 
     @cached_property
@@ -158,11 +165,11 @@ class _Patterns:
         self,
         entity: EntityTypes,
     ) -> re.Pattern:
-        if entity == EntityTypes.class_:
-            return self.class_id_compliance
+        if entity == EntityTypes.concept:
+            return self.concept_id_compliance
 
         elif entity == EntityTypes.conceptual_property:
-            return self.information_property_id_compliance
+            return self.conceptual_property_id_compliance
 
         elif entity == EntityTypes.view:
             return self.view_id_compliance
@@ -171,8 +178,8 @@ class _Patterns:
         elif entity == EntityTypes.container:
             return self.view_id_compliance
 
-        elif entity == EntityTypes.dms_property:
-            return self.dms_property_id_compliance
+        elif entity == EntityTypes.physical_property:
+            return self.physical_property_id_compliance
 
         elif entity == EntityTypes.version:
             return self.version_compliance

cognite_neat-0.122.0/cognite/neat/core/_data_model/_shared.py

@@ -0,0 +1,59 @@
+from dataclasses import dataclass
+from typing import Generic, TypeAlias, TypeVar
+
+from cognite.neat.core._data_model.models import (
+    ConceptualDataModel,
+    PhysicalDataModel,
+)
+from cognite.neat.core._data_model.models.conceptual._unverified import (
+    UnverifiedConceptualDataModel,
+)
+from cognite.neat.core._data_model.models.physical._unverified import (
+    UnverifiedPhysicalDataModel,
+)
+from cognite.neat.core._utils.spreadsheet import SpreadsheetRead
+
+VerifiedDataModel: TypeAlias = ConceptualDataModel | PhysicalDataModel
+
+T_VerifiedDataModel = TypeVar("T_VerifiedDataModel", bound=VerifiedDataModel)
+UnverifiedDataModel: TypeAlias = UnverifiedPhysicalDataModel | UnverifiedConceptualDataModel
+T_UnverifiedDataModel = TypeVar("T_UnverifiedDataModel", bound=UnverifiedDataModel)
+
+
+@dataclass
+class ImportedDataModel(Generic[T_UnverifiedDataModel]):
+    """This class is used to store results of data model import from a source prior to
+    verification and validation.
+
+    Attributes:
+        unverified_data_model: The unverified data model.
+        context: The context of the import, including warnings, errors and any other
+                 relevant information.
+    """
+
+    unverified_data_model: T_UnverifiedDataModel | None
+    context: dict[str, SpreadsheetRead]
+
+    @classmethod
+    def display_type_name(cls) -> str:
+        return "UnverifiedModel"
+
+    @property
+    def display_name(self) -> str:
+        if self.unverified_data_model is None:
+            return "Failed to load data model"
+        return self.unverified_data_model.display_name
+
+
+ImportedUnverifiedDataModel: TypeAlias = (
+    ImportedDataModel[UnverifiedPhysicalDataModel] | ImportedDataModel[UnverifiedConceptualDataModel]
+)
+T_ImportedUnverifiedDataModel = TypeVar("T_ImportedUnverifiedDataModel", bound=ImportedUnverifiedDataModel)
+
+DataModel: TypeAlias = (
+    ConceptualDataModel
+    | PhysicalDataModel
+    | ImportedDataModel[UnverifiedPhysicalDataModel]
+    | ImportedDataModel[UnverifiedConceptualDataModel]
+)
+T_DataModel = TypeVar("T_DataModel", bound=DataModel)

cognite_neat-0.122.0/cognite/neat/core/_data_model/analysis/__init__.py

@@ -0,0 +1,3 @@
+from ._base import DataModelAnalysis
+
+__all__ = ["DataModelAnalysis"]