cognite-neat 0.123.2__py3-none-any.whl → 0.127.30__py3-none-any.whl

cognite/neat/{core → v0/core}/_data_model/models/physical/_verified.py

@@ -8,9 +8,10 @@ from cognite.client import data_modeling as dm
 from pydantic import Field, field_serializer, field_validator, model_validator
 from pydantic_core.core_schema import SerializationInfo, ValidationInfo
 
-from cognite.neat.core._client.data_classes.schema import DMSSchema
-from cognite.neat.core._constants import DMS_CONTAINER_LIST_MAX_LIMIT
-from cognite.neat.core._data_model.models._base_verified import (
+from cognite.neat.v0.core._client.data_classes.schema import DMSSchema
+from cognite.neat.v0.core._constants import DMS_CONTAINER_LIST_MAX_LIMIT
+from cognite.neat.v0.core._data_model._constants import CONSTRAINT_ID_MAX_LENGTH
+from cognite.neat.v0.core._data_model.models._base_verified import (
     BaseVerifiedDataModel,
     BaseVerifiedMetadata,
     ContainerProperty,
@@ -21,17 +22,17 @@ from cognite.neat.core._data_model.models._base_verified import (
     ViewProperty,
     ViewRef,
 )
-from cognite.neat.core._data_model.models._types import (
+from cognite.neat.v0.core._data_model.models._types import (
     ConceptEntityType,
     ContainerEntityType,
     PhysicalPropertyType,
-    StrListType,
     URIRefType,
     ViewEntityType,
 )
-from cognite.neat.core._data_model.models.data_types import DataType
-from cognite.neat.core._data_model.models.entities import (
+from cognite.neat.v0.core._data_model.models.data_types import DataType
+from cognite.neat.v0.core._data_model.models.entities import (
     ConceptualEntity,
+    ContainerIndexEntity,
     DMSNodeEntity,
     EdgeEntity,
     HasDataFilter,
@@ -40,15 +41,19 @@ from cognite.neat.core._data_model.models.entities import (
     PhysicalUnknownEntity,
     RawFilter,
     ReverseConnectionEntity,
+    Undefined,
     ViewEntity,
     ViewEntityList,
 )
-from cognite.neat.core._data_model.models.entities._types import ContainerEntityList, ContainerIndexListType
-from cognite.neat.core._issues.errors import NeatValueError
-from cognite.neat.core._issues.warnings._general import NeatValueWarning
+from cognite.neat.v0.core._data_model.models.entities._types import (
+    ContainerConstraintListType,
+    ContainerIndexListType,
+)
+from cognite.neat.v0.core._issues.errors import NeatValueError
+from cognite.neat.v0.core._issues.warnings import NeatValueWarning, PropertyDefinitionWarning
 
 if TYPE_CHECKING:
-    from cognite.neat.core._data_model.models import ConceptualDataModel
+    from cognite.neat.v0.core._data_model.models import ConceptualDataModel
 
 _DEFAULT_VERSION = "1"
 
@@ -147,7 +152,7 @@ class PhysicalProperty(SheetRow):
         alias="Index",
         description="The names of the indexes (comma separated) that should be created for the property.",
     )
-    constraint: StrListType | None = Field(
+    constraint: ContainerConstraintListType | None = Field(
         None,
         alias="Constraint",
         description="The names of the uniquness (comma separated) that should be created for the property.",
@@ -257,6 +262,86 @@ class PhysicalProperty(SheetRow):
             )
         return value
 
+    @field_validator("index", mode="after")
+    @classmethod
+    def index_set_correctly(cls, value: list[ContainerIndexEntity] | None, info: ValidationInfo) -> Any:
+        if value is None:
+            return value
+
+        container = info.data["container"]
+        container_property = info.data["container_property"]
+
+        if not container or not container_property:
+            raise ValueError("Container and container property must be set to use indexes")
+        max_count = info.data.get("max_count")
+        is_list = (
+            max_count is not None and (isinstance(max_count, int | float) and max_count > 1)
+        ) or max_count is float("inf")
+        for index in value:
+            if index.prefix is Undefined:
+                message = f"The type of index is not defined. Please set 'inverted:{index!s}' or 'btree:{index!s}'."
+                warnings.warn(
+                    PropertyDefinitionWarning(str(container), "container property", str(container_property), message),
+                    stacklevel=2,
+                )
+            elif index.prefix == "inverted" and not is_list:
+                message = (
+                    "It is not recommended to use inverted index on non-list properties. "
+                    "Please consider using btree index instead."
+                )
+                warnings.warn(
+                    PropertyDefinitionWarning(str(container), "container property", str(container_property), message),
+                    stacklevel=2,
+                )
+            elif index.prefix == "btree" and is_list:
+                message = (
+                    "It is not recommended to use btree index on list properties. "
+                    "Please consider using inverted index instead."
+                )
+                warnings.warn(
+                    PropertyDefinitionWarning(str(container), "container property", str(container_property), message),
+                    stacklevel=2,
+                )
+            if index.prefix == "inverted" and (index.cursorable is not None or index.by_space is not None):
+                message = "Cursorable and bySpace are not supported for inverted indexes. These will be ignored."
+                warnings.warn(
+                    PropertyDefinitionWarning(str(container), "container property", str(container_property), message),
+                    stacklevel=2,
+                )
+        return value
+
+    @field_validator("constraint", mode="after")
+    @classmethod
+    def constraint_set_correctly(cls, value: ContainerConstraintListType | None, info: ValidationInfo) -> Any:
+        if value is None:
+            return value
+
+        container = info.data["container"]
+        container_property = info.data["container_property"]
+
+        if not container or not container_property:
+            raise ValueError("Container and container property must be set to use constraint")
+
+        for constraint in value:
+            if constraint.prefix is Undefined:
+                message = f"The type of constraint is not defined. Please set 'uniqueness:{constraint!s}'."
+                warnings.warn(
+                    PropertyDefinitionWarning(str(container), "container property", str(container_property), message),
+                    stacklevel=2,
+                )
+            elif constraint.prefix != "uniqueness":
+                message = (
+                    f"Unsupported constraint type on container property"
+                    f" '{constraint.prefix}'. Currently only 'uniqueness' is supported."
+                )
+                raise ValueError(message) from None
+
+            if len(constraint.suffix) > CONSTRAINT_ID_MAX_LENGTH:
+                message = f"Constraint id '{constraint.suffix}' exceeds maximum length of {CONSTRAINT_ID_MAX_LENGTH}."
+                raise ValueError(message) from None
+
+        return value
+
     @field_serializer("value_type", when_used="always")
     def as_dms_type(self, value_type: DataType | EdgeEntity | ViewEntity, info: SerializationInfo) -> str:
         if isinstance(value_type, DataType):
@@ -303,13 +388,46 @@ class PhysicalContainer(SheetRow):
     description: str | None = Field(
         alias="Description", default=None, description="Short description of the node being defined."
     )
-    constraint: ContainerEntityList | None = Field(
+    constraint: ContainerConstraintListType | None = Field(
         None, alias="Constraint", description="List of required (comma separated) constraints for the container"
     )
     used_for: Literal["node", "edge", "all"] | None = Field(
         "all", alias="Used For", description=" Whether the container is used for nodes, edges or all."
     )
 
+    @field_validator("constraint", mode="after")
+    @classmethod
+    def constraint_set_correctly(cls, value: ContainerConstraintListType | None) -> Any:
+        if value is None:
+            return value
+
+        for constraint in value:
+            if constraint.prefix is Undefined:
+                message = f"The type of constraint is not defined. Please set 'requires:{constraint!s}'."
+                warnings.warn(
+                    message,
+                    stacklevel=2,
+                )
+            elif constraint.prefix != "requires":
+                message = (
+                    f"Unsupported constraint type on container as "
+                    f"the whole '{constraint.prefix}'. Currently only 'requires' is supported."
+                )
+                raise ValueError(message) from None
+
+            if len(constraint.suffix) > CONSTRAINT_ID_MAX_LENGTH:
+                message = f"Constraint id '{constraint.suffix}' exceeds maximum length of {CONSTRAINT_ID_MAX_LENGTH}."
+                raise ValueError(message) from None
+
+            if constraint.require is None:
+                message = (
+                    f"Container constraint must have a container set. "
+                    f"Please set 'requires:{constraint!s}(container=space:external_id)'."
+                )
+                raise ValueError(message) from None
+
+        return value
+
     def _identifier(self) -> tuple[Hashable, ...]:
         return (self.container,)
 
@@ -317,8 +435,10 @@ class PhysicalContainer(SheetRow):
         container_id = self.container.as_id()
         constraints: dict[str, dm.Constraint] = {}
         for constraint in self.constraint or []:
-            requires = dm.RequiresConstraint(constraint.as_id())
-            constraints[f"{constraint.space}_{constraint.external_id}"] = requires
+            if constraint.require is None:
+                continue
+            requires = dm.RequiresConstraint(constraint.require.as_id())
+            constraints[constraint.suffix] = requires
 
         return dm.ContainerApply(
             space=container_id.space,

cognite/neat/{core → v0/core}/_data_model/transformers/__init__.py

@@ -26,6 +26,7 @@ from ._converters import (
     ToSolutionModel,
 )
 from ._mapping import AsParentPropertyId, MapOneToOne, PhysicalDataModelMapper
+from ._union_conceptual import UnionConceptualDataModel
 from ._verification import (
     VerifyAnyDataModel,
     VerifyConceptualDataModel,
@@ -61,6 +62,7 @@ __all__ = [
     "ToEnterpriseModel",
     "ToExtensionModel",
     "ToSolutionModel",
+    "UnionConceptualDataModel",
     "VerifiedDataModelTransformer",
     "VerifyAnyDataModel",
     "VerifyConceptualDataModel",

cognite/neat/{core → v0/core}/_data_model/transformers/_base.py

@@ -4,17 +4,17 @@ from functools import lru_cache
 from types import UnionType
 from typing import Generic, TypeVar, Union, get_args, get_origin
 
-from cognite.neat.core._constants import DEFAULT_NAMESPACE
-from cognite.neat.core._data_model._shared import (
+from cognite.neat.v0.core._constants import DEFAULT_NAMESPACE
+from cognite.neat.v0.core._data_model._shared import (
     DataModel,
     ImportedDataModel,
     VerifiedDataModel,
 )
-from cognite.neat.core._data_model.models import (
+from cognite.neat.v0.core._data_model.models import (
     UnverifiedConceptualDataModel,
     UnverifiedPhysicalDataModel,
 )
-from cognite.neat.core._store._provenance import Agent as ProvenanceAgent
+from cognite.neat.v0.core._store._provenance import Agent as ProvenanceAgent
 
 T_DataModelIn = TypeVar("T_DataModelIn", bound=DataModel)
 T_DataModelOut = TypeVar("T_DataModelOut", bound=DataModel)

cognite/neat/{core → v0/core}/_data_model/transformers/_converters.py

@@ -16,12 +16,12 @@ from cognite.client.utils.useful_types import SequenceNotStr
 from pydantic import ValidationError
 from rdflib import Namespace
 
-from cognite.neat.core._client import NeatClient
-from cognite.neat.core._client.data_classes.data_modeling import (
+from cognite.neat.v0.core._client import NeatClient
+from cognite.neat.v0.core._client.data_classes.data_modeling import (
     ContainerApplyDict,
     ViewApplyDict,
 )
-from cognite.neat.core._constants import (
+from cognite.neat.v0.core._constants import (
     COGNITE_CONCEPTS,
     COGNITE_MODELS,
     COGNITE_SPACES,
@@ -29,15 +29,16 @@ from cognite.neat.core._constants import (
     DMS_RESERVED_PROPERTIES,
     get_default_prefixes_and_namespaces,
 )
-from cognite.neat.core._data_model._constants import PATTERNS, get_reserved_words
-from cognite.neat.core._data_model._shared import (
+from cognite.neat.v0.core._data_model._constants import CONSTRAINT_ID_MAX_LENGTH, PATTERNS, get_reserved_words
+from cognite.neat.v0.core._data_model._shared import (
+    ImportContext,
     ImportedDataModel,
     ImportedUnverifiedDataModel,
     VerifiedDataModel,
 )
-from cognite.neat.core._data_model.analysis import DataModelAnalysis
-from cognite.neat.core._data_model.importers import DMSImporter
-from cognite.neat.core._data_model.models import (
+from cognite.neat.v0.core._data_model.analysis import DataModelAnalysis
+from cognite.neat.v0.core._data_model.importers import DMSImporter
+from cognite.neat.v0.core._data_model.models import (
     ConceptualDataModel,
     PhysicalDataModel,
     SheetList,
@@ -45,14 +46,14 @@ from cognite.neat.core._data_model.models import (
     UnverifiedPhysicalDataModel,
     data_types,
 )
-from cognite.neat.core._data_model.models.conceptual import (
+from cognite.neat.v0.core._data_model.models.conceptual import (
     Concept,
     ConceptualMetadata,
     ConceptualProperty,
     UnverifiedConcept,
     UnverifiedConceptualProperty,
 )
-from cognite.neat.core._data_model.models.data_types import (
+from cognite.neat.v0.core._data_model.models.data_types import (
     AnyURI,
     DataType,
     Enum,
@@ -60,7 +61,7 @@ from cognite.neat.core._data_model.models.data_types import (
     String,
     Timeseries,
 )
-from cognite.neat.core._data_model.models.entities import (
+from cognite.neat.v0.core._data_model.models.entities import (
     ConceptEntity,
     ContainerEntity,
     EdgeEntity,
@@ -71,30 +72,30 @@ from cognite.neat.core._data_model.models.entities import (
     UnknownEntity,
     ViewEntity,
 )
-from cognite.neat.core._data_model.models.physical import (
+from cognite.neat.v0.core._data_model.models.entities._single_value import ContainerConstraintEntity
+from cognite.neat.v0.core._data_model.models.physical import (
     PhysicalMetadata,
     PhysicalProperty,
     PhysicalValidation,
     PhysicalView,
 )
-from cognite.neat.core._data_model.models.physical._verified import (
+from cognite.neat.v0.core._data_model.models.physical._verified import (
     PhysicalContainer,
     PhysicalEnum,
     PhysicalNodeType,
 )
-from cognite.neat.core._issues import IssueList
-from cognite.neat.core._issues._factory import from_pydantic_errors
-from cognite.neat.core._issues.errors import CDFMissingClientError, NeatValueError
-from cognite.neat.core._issues.warnings import (
+from cognite.neat.v0.core._issues import IssueList
+from cognite.neat.v0.core._issues._factory import from_pydantic_errors
+from cognite.neat.v0.core._issues.errors import CDFMissingClientError, NeatValueError
+from cognite.neat.v0.core._issues.warnings import (
     NeatValueWarning,
     PropertyOverwritingWarning,
 )
-from cognite.neat.core._issues.warnings._models import (
+from cognite.neat.v0.core._issues.warnings._models import (
     SolutionModelBuildOnTopOfCDMWarning,
 )
-from cognite.neat.core._utils.rdf_ import get_inheritance_path
-from cognite.neat.core._utils.spreadsheet import SpreadsheetRead
-from cognite.neat.core._utils.text import (
+from cognite.neat.v0.core._utils.rdf_ import get_inheritance_path
+from cognite.neat.v0.core._utils.text import (
     NamingStandardization,
     humanize_collection,
     title,
@@ -1437,7 +1438,7 @@ class _ConceptualDataModelConverter:
         ignore_undefined_value_types: bool = False,
         reserved_properties: Literal["error", "warning"] = "error",
     ) -> "PhysicalDataModel":
-        from cognite.neat.core._data_model.models.physical._verified import (
+        from cognite.neat.v0.core._data_model.models.physical._verified import (
             PhysicalContainer,
             PhysicalDataModel,
             PhysicalProperty,
@@ -1638,19 +1639,25 @@ class _ConceptualDataModelConverter:
         default_space: str,
         concept_by_concept_entity: dict[ConceptEntity, Concept],
         referenced_containers: Collection[ContainerEntity],
-    ) -> list[ContainerEntity]:
-        constrains: list[ContainerEntity] = []
+    ) -> list[ContainerConstraintEntity]:
+        constrains: list[ContainerConstraintEntity] = []
         for entity in concept_entities:
             concept = concept_by_concept_entity[entity]
             for parent in concept.implements or []:
                 parent_entity = parent.as_container_entity(default_space)
                 if parent_entity in referenced_containers:
-                    constrains.append(parent_entity)
+                    constrains.append(
+                        ContainerConstraintEntity(
+                            prefix="requires",
+                            suffix=f"{parent_entity.space}_{parent_entity.external_id}"[:CONSTRAINT_ID_MAX_LENGTH],
+                            require=parent_entity,
+                        )
+                    )
         return constrains
 
     @classmethod
     def _convert_conceptual_to_physical_metadata(cls, metadata: ConceptualMetadata) -> "PhysicalMetadata":
-        from cognite.neat.core._data_model.models.physical._verified import (
+        from cognite.neat.v0.core._data_model.models.physical._verified import (
             PhysicalMetadata,
         )
 
@@ -1676,7 +1683,7 @@ class _ConceptualDataModelConverter:
         edge_value_types_by_concept_property_pair: dict[tuple[ConceptEntity, str], ConceptEntity],
         end_node_by_edge: dict[ConceptEntity, ConceptEntity],
     ) -> "PhysicalProperty":
-        from cognite.neat.core._data_model.models.physical._verified import PhysicalProperty
+        from cognite.neat.v0.core._data_model.models.physical._verified import PhysicalProperty
 
         # returns property type, which can be ObjectProperty or DatatypeProperty
         value_type = self._get_value_type(
@@ -2012,7 +2019,7 @@ class _PhysicalDataModelConverter:
     def as_conceptual_data_model(
         self,
     ) -> "ConceptualDataModel":
-        from cognite.neat.core._data_model.models.conceptual._verified import (
+        from cognite.neat.v0.core._data_model.models.conceptual._verified import (
             Concept,
             ConceptualDataModel,
             ConceptualProperty,
@@ -2090,7 +2097,7 @@ class _PhysicalDataModelConverter:
 
     @classmethod
     def _convert_physical_to_conceptual_metadata(cls, metadata: PhysicalMetadata) -> "ConceptualMetadata":
-        from cognite.neat.core._data_model.models.conceptual._verified import (
+        from cognite.neat.v0.core._data_model.models.conceptual._verified import (
             ConceptualMetadata,
         )
 
@@ -2412,13 +2419,13 @@ class AddCogniteProperties(
                 concepts=new_classes,
                 prefixes=input_.prefixes,
             ),
-            context={},
+            context=None,
         )
 
     @staticmethod
     def _get_properties_by_concepts(
         properties: list[UnverifiedConceptualProperty],
-        read_context: dict[str, SpreadsheetRead],
+        read_context: ImportContext | None,
         default_space: str,
     ) -> dict[ConceptEntity, dict[str, UnverifiedConceptualProperty]]:
         issues = IssueList()
@@ -2438,7 +2445,7 @@ class AddCogniteProperties(
     @staticmethod
     def _get_dependencies_by_concepts(
         concepts: list[UnverifiedConcept],
-        read_context: dict[str, SpreadsheetRead],
+        read_context: ImportContext | None,
         default_space: str,
     ) -> dict[ConceptEntity, set[ConceptEntity]]:
         dependencies_by_concepts: dict[ConceptEntity, set[ConceptEntity]] = {}

cognite/neat/{core → v0/core}/_data_model/transformers/_mapping.py

@@ -5,25 +5,25 @@ from typing import Any, ClassVar, Literal
 
 from cognite.client import data_modeling as dm
 
-from cognite.neat.core._client import NeatClient
-from cognite.neat.core._data_model.models import PhysicalDataModel, SheetList
-from cognite.neat.core._data_model.models.data_types import Enum
-from cognite.neat.core._data_model.models.entities import (
+from cognite.neat.v0.core._client import NeatClient
+from cognite.neat.v0.core._data_model.models import PhysicalDataModel, SheetList
+from cognite.neat.v0.core._data_model.models.data_types import Enum
+from cognite.neat.v0.core._data_model.models.entities import (
     ConceptEntity,
     ContainerEntity,
     ViewEntity,
 )
-from cognite.neat.core._data_model.models.physical import (
+from cognite.neat.v0.core._data_model.models.physical import (
     PhysicalContainer,
     PhysicalEnum,
     PhysicalProperty,
 )
-from cognite.neat.core._issues.errors import (
+from cognite.neat.v0.core._issues.errors import (
     CDFMissingClientError,
     NeatValueError,
     ResourceNotFoundError,
 )
-from cognite.neat.core._issues.warnings import PropertyOverwritingWarning
+from cognite.neat.v0.core._issues.warnings import PropertyOverwritingWarning
 
 from ._base import VerifiedDataModelTransformer