cognite-neat 0.123.37__tar.gz → 0.123.38__tar.gz

{cognite_neat-0.123.37 → cognite_neat-0.123.38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.123.37
+Version: 0.123.38
 Summary: Knowledge graph transformation
 Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
 Project-URL: Homepage, https://cognite-neat.readthedocs-hosted.com/

{cognite_neat-0.123.37 → cognite_neat-0.123.38}/cognite/neat/_data_model/models/dms/_space.py

@@ -15,8 +15,8 @@ class Space(WriteableResource["SpaceRequest"], ABC):
         max_length=43,
         pattern=SPACE_FORMAT_PATTERN,
     )
-    name: str | None = Field(None, description="Name of the space.", max_length=1024)
-    description: str | None = Field(None, description="The description of the space.", max_length=255)
+    name: str | None = Field(None, description="Name of the space.", max_length=255)
+    description: str | None = Field(None, description="The description of the space.", max_length=1024)
 
     @field_validator("space")
     def check_forbidden_space_value(cls, val: str) -> str:

cognite_neat-0.123.38/cognite/neat/_version.py

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

{cognite_neat-0.123.37 → cognite_neat-0.123.38}/cognite/neat/v0/core/_data_model/exporters/_data_model2semantic_model.py

@@ -462,25 +462,27 @@ class ShaclShapes(_ModelConfig):
         """
         analysis = DataModelAnalysis(data_model)
         concepts_by_concept_entity = analysis.concept_by_concept_entity
-        properties_by_concept_entity = analysis.properties_by_id_by_concept()
+        properties_by_concept_entity = analysis.properties_by_concepts()
         return cls(
             shapes=[
                 # shapes that have property shapes as well
-                SHACLNodeShape.from_data_model(
-                    concepts_by_concept_entity[concept_entity],
-                    list(properties.values()),
+                SHACLNodeShape.from_concept(
+                    concept_entity,
+                    concepts_by_concept_entity,
+                    properties,
                     data_model.metadata.namespace,
                 )
                 for concept_entity, properties in properties_by_concept_entity.items()
             ]
             + [
                 # shapes without any property shapes
-                SHACLNodeShape.from_data_model(
-                    concept,
+                SHACLNodeShape.from_concept(
+                    concept_entity,
+                    concepts_by_concept_entity,
                     [],
                     data_model.metadata.namespace,
                 )
-                for concept_entity, concept in concepts_by_concept_entity.items()
+                for concept_entity in concepts_by_concept_entity.keys()
                 if concept_entity not in properties_by_concept_entity
             ],
             prefixes=data_model.prefixes,
@@ -548,21 +550,28 @@ class SHACLNodeShape(_ModelConfig):
         )
 
     @classmethod
-    def from_data_model(
+    def from_concept(
         cls,
-        concept_definition: Concept,
-        property_definitions: list[ConceptualProperty],
+        concept_entity: ConceptEntity,
+        concepts_by_concept_entity: dict[ConceptEntity, Concept],
+        properties: list[ConceptualProperty],
         namespace: Namespace,
     ) -> "SHACLNodeShape":
-        if concept_definition.implements:
-            parent = [namespace[str(parent.suffix) + "Shape"] for parent in concept_definition.implements]
+        if not (concept := concepts_by_concept_entity.get(concept_entity)):
+            raise ValueError(f"Concept {concept_entity} not found in data model!")
+
+        if concept.implements:
+            parent = [namespace[str(parent.suffix) + "Shape"] for parent in concept.implements]
         else:
             parent = None
         return cls(
-            id_=namespace[f"{concept_definition.concept.suffix!s}Shape"],
-            target_class=namespace[str(concept_definition.concept.suffix)],
+            id_=namespace[f"{concept.concept.suffix!s}Shape"],
+            target_class=concept.instance_source or namespace[str(concept.concept.suffix)],
             parent=parent,
-            property_shapes=[SHACLPropertyShape.from_property(prop, namespace) for prop in property_definitions],
+            property_shapes=[
+                SHACLPropertyShape.from_property(property_, concepts_by_concept_entity, namespace)
+                for property_ in properties
+            ],
             namespace=namespace,
         )
 
@@ -607,23 +616,31 @@ class SHACLPropertyShape(_ModelConfig):
         return self.path_triples + self.node_kind_triples + self.cardinality_triples
 
     @classmethod
-    def from_property(cls, definition: ConceptualProperty, namespace: Namespace) -> "SHACLPropertyShape":
-        # TODO requires PR to fix MultiValueType and UnknownValueType
-        if isinstance(definition.value_type, ConceptEntity):
-            expected_value_type = namespace[f"{definition.value_type.suffix}Shape"]
-        elif isinstance(definition.value_type, DataType):
-            expected_value_type = XSD[definition.value_type.xsd]
+    def from_property(
+        cls,
+        property_: ConceptualProperty,
+        concepts_by_concept_entity: dict[ConceptEntity, Concept],
+        namespace: Namespace,
+    ) -> "SHACLPropertyShape":
+        if isinstance(property_.value_type, ConceptEntity):
+            concept = concepts_by_concept_entity.get(property_.value_type)
+            value_type_uri = concept.instance_source if concept else None
+            expected_value_type = value_type_uri or namespace[f"{property_.value_type.suffix}"]
+        elif isinstance(property_.value_type, DataType):
+            expected_value_type = XSD[property_.value_type.xsd]
         else:
-            raise ValueError(f"Value type {definition.value_type.type_} is not supported")
+            raise NotImplementedError(f"Value type {property_.value_type.type_} is not supported yet")
 
         return cls(
             id_=BNode(),
-            path=namespace[definition.property_],
-            node_kind=SHACL.IRI if definition.type_ == EntityTypes.object_property else SHACL.Literal,
+            path=property_.instance_source[0]
+            if property_.instance_source and len(property_.instance_source) == 1
+            else namespace[property_.property_],
+            node_kind=SHACL.IRI if property_.type_ == EntityTypes.object_property else SHACL.Literal,
             expected_value_type=expected_value_type,
-            min_count=definition.min_count,
+            min_count=property_.min_count,
             max_count=(
-                int(definition.max_count) if definition.max_count and definition.max_count != float("inf") else None
+                int(property_.max_count) if property_.max_count and property_.max_count != float("inf") else None
             ),
             namespace=namespace,
         )

cognite_neat-0.123.38/last_changelog_entry.md

@@ -0,0 +1,7 @@
+
+### Improved
+
+- Node shape target class and property shape node are now set to
+instance source (if exists) or class uri
+- Property shape path is now set to instance source (if exists) or class
+uri when property is object property

cognite_neat-0.123.38/last_git_message.txt

@@ -0,0 +1,30 @@
+THIS 752: Correct target class and value type setting (#1304)
+
+# Description
+
+This is stacked PR on top of #1303 
+
+During the testing of SHACL engine, which was taking shacl rules
+generated by neat, it has beed detected that we were setting
+`NodeShape`'s `targetClass` and `PropertyShape`'s `node` to URI of SHACL
+shapes. The correct way is to set those properties to class URI, which
+in our case is stored as `instance_source` (if conceptual data model is
+linked to the instances) or to generate such URI from concept entity
+suffix and data model namespace. Furthermore, `PropertyShape`'s `path`
+was not leveraging `instance_source` of property (if it exists). The
+above has been implemented in this PR.
+
+
+## Bump
+
+- [x] Patch
+- [ ] Minor
+- [ ] Skip
+
+## Changelog
+### Improved
+
+- Node shape target class and property shape node are now set to
+instance source (if exists) or class uri
+- Property shape path is now set to instance source (if exists) or class
+uri when property is object property

cognite_neat-0.123.38/last_version.txt

@@ -0,0 +1 @@
+0.123.37

{cognite_neat-0.123.37 → cognite_neat-0.123.38}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cognite-neat"
-version = "0.123.37"
+version = "0.123.38"
 readme = "README.md"
 description = "Knowledge graph transformation"
 authors = [

cognite_neat-0.123.38/tests/tests_unit_v1/test_data_model/test_models/test_dms/test_spaces.py

@@ -0,0 +1,33 @@
+from collections.abc import Iterator
+from typing import Any
+
+import pytest
+from pydantic import ValidationError
+
+from cognite.neat._data_model.models.dms import SpaceRequest
+from cognite.neat._utils.validation import humanize_validation_error
+
+
+def invalid_space_definition_test_cases() -> Iterator[tuple]:
+    yield pytest.param(
+        {"space": "my_space", "name": "way too long name" * 50},
+        {"In field name string should have at most 255 characters"},
+        id="Name above 255 characters",
+    )
+    yield pytest.param(
+        {"space": "forbidden#space", "name": "Valid Name", "description": "Way too long description" * 100},
+        {
+            "In field description string should have at most 1024 characters",
+            "In field space string should match pattern '^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$'",
+        },
+        id="Forbidden space and description above 1024 characters",
+    )
+
+
+class TestSpaceRequest:
+    @pytest.mark.parametrize("data,expected_errors", list(invalid_space_definition_test_cases()))
+    def test_invalid_definition(self, data: dict[str, Any], expected_errors: set[str]) -> None:
+        with pytest.raises(ValidationError) as excinfo:
+            SpaceRequest.model_validate(data)
+        errors = set(humanize_validation_error(excinfo.value))
+        assert errors == expected_errors

{cognite_neat-0.123.37 → cognite_neat-0.123.38}/tests/v0/tests_unit/test_rules/test_exporters/test_rules2ontology.py

@@ -4,11 +4,12 @@ from rdflib import DCTERMS, OWL, RDF, RDFS, BNode, Graph, Literal, Namespace
 
 from cognite.neat.v0.core._data_model.exporters._data_model2semantic_model import OWLExporter, SHACLExporter
 from cognite.neat.v0.core._data_model.models import ConceptualDataModel
+from cognite.neat.v0.core._data_model.models.entities._single_value import ConceptEntity
 
 SHACL = Namespace("http://www.w3.org/ns/shacl#")
 
 
-class TestOntologyExporter:
+class TestSemanticExporter:
     def test_export_ontology(self, david_rules: ConceptualDataModel, tmp_path: Path) -> None:
         exporter = OWLExporter()
         ttl_path = tmp_path / "test.ttl"
@@ -41,4 +42,24 @@ class TestOntologyExporter:
         exporter.export_to_file(david_rules, ttl_path)
 
         shacl_shapes = Graph().parse(ttl_path, format="ttl")
-        assert 26 == len(list(shacl_shapes.subjects(RDF.type, SHACL.NodeShape)))
+        assert len(david_rules.concepts) == len(list(shacl_shapes.subjects(RDF.type, SHACL.NodeShape)))
+
+        actual_target_classes = set(shacl_shapes.objects(None, SHACL.targetClass))
+        expected_node = {
+            concept.instance_source or david_rules.metadata.namespace[concept.concept.suffix]
+            for concept in david_rules.concepts
+        }
+        assert actual_target_classes == expected_node
+
+        expected_node = set()
+
+        for property_ in david_rules.properties:
+            if isinstance(property_.value_type, ConceptEntity):
+                if property_.instance_source and len(property_.instance_source) == 1:
+                    expected_node.add(property_.instance_source)
+                else:
+                    expected_node.add(david_rules.metadata.namespace[property_.value_type.suffix])
+
+        actual_node = set(shacl_shapes.objects(None, SHACL.node))
+
+        assert actual_node == expected_node

{cognite_neat-0.123.37 → cognite_neat-0.123.38}/uv.lock

@@ -346,7 +346,7 @@ wheels = [
 
 [[package]]
 name = "cognite-neat"
-version = "0.123.37"
+version = "0.123.38"
 source = { editable = "." }
 dependencies = [
     { name = "backports-strenum", marker = "python_full_version < '3.11'" },

cognite_neat-0.123.37/cognite/neat/_version.py

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

cognite_neat-0.123.37/last_changelog_entry.md

@@ -1,4 +0,0 @@
-
-### Added
-
-- Property (conceptual) pydantic model

cognite_neat-0.123.37/last_git_message.txt

@@ -1,24 +0,0 @@
-THIS-737 Add Property model (#1301)
-
-# Description
-
-Context: We are changing the internal structure of the neat data models.
-We are replacing flat conceptual data model structure with nested for
-easier manipulation of data model as well conversion of conceptual data
-model to DMS API representation. Also, we are dropping "unverified"
-state of data model, resulting in more simple data model representation.
-
-In this PR we are defining conceptual data model Property model.
-
-Note: most of the code is test and docstring
-
-## Bump
-
-- [X] Patch
-- [ ] Minor
-- [ ] Skip
-
-## Changelog
-### Added
-
-- Property (conceptual) pydantic model

cognite_neat-0.123.37/last_version.txt

@@ -1 +0,0 @@
-0.123.36