cognite-neat 0.123.10__tar.gz → 0.123.12__tar.gz

{cognite_neat-0.123.10 → cognite_neat-0.123.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.123.10
+Version: 0.123.12
 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.12/cognite/neat/_version.py

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

{cognite_neat-0.123.10 → cognite_neat-0.123.12}/cognite/neat/core/_data_model/importers/_rdf/_shared.py

@@ -1,4 +1,5 @@
 from typing import cast
+from urllib.parse import quote
 
 from rdflib import BNode, Graph
 from rdflib.plugins.sparql import prepareQuery
@@ -33,6 +34,9 @@ def parse_concepts(graph: Graph, query: str, language: str, issue_list: IssueLis
         res: dict = convert_rdflib_content(cast(ResultRow, raw).asdict(), True)
         res = {key: res.get(key, None) for key in expected_keys}
 
+        # Quote the concept id to ensure it is web-safe
+        res["concept"] = quote(res["concept"], safe="")
+
         concept_id = res["concept"]
 
         # Safeguarding against incomplete semantic definitions
@@ -91,6 +95,8 @@ def parse_properties(graph: Graph, query: str, language: str, issue_list: IssueL
         res: dict = convert_rdflib_content(cast(ResultRow, raw).asdict(), True)
         res = {key: res.get(key, None) for key in expected_keys}
 
+        # Quote the concept id to ensure it is web-safe
+        res["property_"] = quote(res["property_"], safe="")
         property_id = res["property_"]
 
         # Safeguarding against incomplete semantic definitions
@@ -115,6 +121,10 @@ def parse_properties(graph: Graph, query: str, language: str, issue_list: IssueL
             )
             continue
 
+        # Quote the concept and value_type to ensure they are web-safe
+        res["concept"] = quote(res["concept"], safe="")
+        res["value_type"] = quote(res["value_type"], safe="")
+
         id_ = f"{res['concept']}.{res['property_']}"
 
         if id_ not in properties:

{cognite_neat-0.123.10 → cognite_neat-0.123.12}/cognite/neat/core/_data_model/models/conceptual/_validation.py

@@ -11,7 +11,7 @@ from cognite.neat.core._issues.errors._resources import (
     ResourceDuplicatedError,
     ResourceNotDefinedError,
 )
-from cognite.neat.core._issues.warnings._models import UndefinedConceptWarning
+from cognite.neat.core._issues.warnings._models import ConceptOnlyDataModelWarning, UndefinedConceptWarning
 from cognite.neat.core._issues.warnings._resources import (
     ResourceNotDefinedWarning,
     ResourceRegexViolationWarning,
@@ -46,10 +46,16 @@ class ConceptualValidation:
         self._parent_concept_defined()
         self._referenced_classes_exist()
         self._referenced_value_types_exist()
+        self._concept_only_data_model()
         self._regex_compliance_with_physical_data_model()
 
         return self.issue_list
 
+    def _concept_only_data_model(self) -> None:
+        """Check if the data model only consists of concepts without any properties."""
+        if not self._properties:
+            self.issue_list.append(ConceptOnlyDataModelWarning())
+
     def _duplicated_resources(self) -> None:
         properties_sheet = self._read_info_by_spreadsheet.get("Properties")
         concepts_sheet = self._read_info_by_spreadsheet.get("Concepts")

{cognite_neat-0.123.10 → cognite_neat-0.123.12}/cognite/neat/core/_data_model/models/conceptual/_verified.py

@@ -241,8 +241,10 @@ class ConceptualProperty(SheetRow):
 
 class ConceptualDataModel(BaseVerifiedDataModel):
     metadata: ConceptualMetadata = Field(alias="Metadata", description="Metadata for the conceptual data model")
-    properties: SheetList[ConceptualProperty] = Field(alias="Properties", description="List of properties")
     concepts: SheetList[Concept] = Field(alias="Concepts", description="List of concepts")
+    properties: SheetList[ConceptualProperty] = Field(
+        alias="Properties", default_factory=SheetList, description="List of properties"
+    )
     prefixes: dict[str, Namespace] = Field(
         alias="Prefixes",
         default_factory=get_default_prefixes_and_namespaces,

{cognite_neat-0.123.10 → cognite_neat-0.123.12}/cognite/neat/core/_issues/warnings/_models.py

@@ -101,6 +101,14 @@ class UndefinedConceptWarning(UserModelingWarning):
     concept_id: str
 
 
+@dataclass(unsafe_hash=True)
+class ConceptOnlyDataModelWarning(UserModelingWarning):
+    """Data model is concept-only (contains concepts but no properties).
+    This model will likely cause issues when converting to a physical data model."""
+
+    fix = "Define properties for concepts or make sure that concepts implement other concepts that have properties."
+
+
 @dataclass(unsafe_hash=True)
 class UndefinedViewWarning(UserModelingWarning):
     """Undefined view {value_type} has been referred as value type for property <{view_property}> of view {view_id}."""

cognite_neat-0.123.12/last_changelog_entry.md

@@ -0,0 +1,3 @@
+### Improved
+
+- Concept only conceptual data models are now allowed

cognite_neat-0.123.12/last_git_message.txt

@@ -0,0 +1,24 @@
+Enable concept only conceptual data models (#1247)
+
+# Description
+
+This enables conceptual data models to consist of only concepts. It
+raises nice warning.
+
+Risk reviewers: This is stacked PR on top of
+[1246](https://github.com/cognitedata/neat/pull/1246)
+
+## Bump
+
+- [x] Patch
+- [ ] Minor
+- [ ] Skip
+
+## Changelog
+### Improved
+
+- Concept only conceptual data models are now allowed
+
+---------
+
+Co-authored-by: Nikola Vasiljevic <nikola@Nikolas-MacBook-Air.local>

cognite_neat-0.123.12/last_version.txt

@@ -0,0 +1 @@
+0.123.11

{cognite_neat-0.123.10 → cognite_neat-0.123.12}/pyproject.toml

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

{cognite_neat-0.123.10 → cognite_neat-0.123.12}/tests/data/__init__.py

@@ -49,6 +49,7 @@ class SchemaData:
         information_unknown_value_type_xlsx = _conceptual / "information-unknown-value-type.xlsx"
         info_with_cdm_ref_xlsx = _conceptual / "info_with_cdm_ref.xlsx"
         broken_concepts_xlsx = _conceptual / "broken_concepts.xlsx"
+        ontology_with_regex_warnings = _conceptual / "ontology.ttl"
 
     class NonNeatFormats:
         class DTDL:

cognite_neat-0.123.12/tests/data/_schema/conceptual/ontology.ttl

@@ -0,0 +1,42 @@
+@prefix : <http://example.com/industrial#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+
+<http://example.com/industrial>
+    a owl:Ontology .
+
+### Classes
+
+<http://example.com/industrial/Machine.Type-A(01)~?@!$&'*+,;=%[]>
+    a owl:Class ;
+    rdfs:label "Machine Type A" .
+
+<http://example.com/industrial/Sensor.Unit_01(Temp)~?@!$&'*+,;=%[]>
+    a owl:Class ;
+    rdfs:label "Temperature Sensor Unit" .
+
+<http://example.com/industrial/Control.Panel-1(Safety)~?@!$&'*+,;=%[]>
+    a owl:Class ;
+    rdfs:label "Safety Control Panel" .
+
+### Object Properties with special characters in URIs
+
+<http://example.com/industrial/has.Sensor-Unit(01):Temp~?@!$&'*+,;=%[]>
+    a owl:ObjectProperty ;
+    rdfs:domain <http://example.com/industrial/Machine.Type-A(01)~?@!$&'*+,;=%[]> ;
+    rdfs:range <http://example.com/industrial/Sensor.Unit_01(Temp)~?@!$&'*+,;=%[]> ;
+    rdfs:label "has sensor unit" .
+
+<http://example.com/industrial/is.Controlled-By(Panel):Safety~?@!$&'*+,;=%[]>
+    a owl:ObjectProperty ;
+    rdfs:domain <http://example.com/industrial/Machine.Type-A(01)~?@!$&'*+,;=%[]> ;
+    rdfs:range <http://example.com/industrial/Control.Panel-1(Safety)~?@!$&'*+,;=%[]> ;
+    rdfs:label "is controlled by" .
+
+<http://example.com/industrial/is.Connected-To(Control):Panel~?@!$&'*+,;=%[]>
+    a owl:ObjectProperty ;
+    rdfs:domain <http://example.com/industrial/Sensor.Unit_01(Temp)~?@!$&'*+,;=%[]> ;
+    rdfs:range <http://example.com/industrial/Control.Panel-1(Safety)~?@!$&'*+,;=%[]> ;
+    rdfs:label "is connected to" .

{cognite_neat-0.123.10 → cognite_neat-0.123.12}/tests/tests_unit/test_rules/test_importers/test_owl_importer.py

@@ -4,6 +4,8 @@ from cognite.neat.core._data_model.analysis import DataModelAnalysis
 from cognite.neat.core._data_model.models.entities import ConceptEntity
 from cognite.neat.core._data_model.transformers._verification import VerifyAnyDataModel
 from cognite.neat.core._issues import catch_issues
+from cognite.neat.core._issues.warnings._resources import ResourceNotDefinedWarning, ResourceRegexViolationWarning
+from tests.data import SchemaData
 
 
 def test_ill_formed_owl_importer():
@@ -13,7 +15,6 @@ def test_ill_formed_owl_importer():
 
     assert len(issues) == 6
     assert issues.has_errors
-    assert issues.has_errors
     assert str(issues.errors[0].identifier) == "neat_space:Award"
 
     acceptable_properties = []
@@ -37,3 +38,27 @@ def test_ill_formed_owl_importer():
         .type_
         == EntityTypes.data_property
     )
+
+
+def test_owl_enitity_quoting():
+    input = importers.OWLImporter.from_file(filepath=SchemaData.Conceptual.ontology_with_regex_warnings).to_data_model()
+    with catch_issues() as issues:
+        conceptual_data_model = VerifyAnyDataModel().transform(input)
+
+    categorized_issues = {}
+    for issue in issues:
+        if type(issue) not in categorized_issues:
+            categorized_issues[type(issue)] = []
+        categorized_issues[type(issue)].append(issue)
+
+    assert len(issues) == 13
+    # quoting is successful, but regex warnings are raised
+    assert not issues.has_errors
+    assert issues.has_warnings
+
+    assert len(categorized_issues) == 2
+    assert len(categorized_issues[ResourceRegexViolationWarning]) == 12
+    assert len(categorized_issues[ResourceNotDefinedWarning]) == 1
+
+    assert len(conceptual_data_model.concepts) == 3
+    assert len(conceptual_data_model.properties) == 3

{cognite_neat-0.123.10 → cognite_neat-0.123.12}/tests/tests_unit/test_rules/test_models/test_conceptual_model.py

@@ -31,8 +31,10 @@ from cognite.neat.core._data_model.transformers._converters import (
 from cognite.neat.core._data_model.transformers._verification import VerifyAnyDataModel
 from cognite.neat.core._issues import NeatError
 from cognite.neat.core._issues._base import MultiValueError
+from cognite.neat.core._issues._contextmanagers import catch_issues
 from cognite.neat.core._issues.errors import ResourceNotDefinedError
 from cognite.neat.core._issues.errors._resources import ResourceDuplicatedError
+from cognite.neat.core._issues.warnings._models import ConceptOnlyDataModelWarning
 
 
 def case_insensitive_value_types():
@@ -151,6 +153,45 @@ def duplicated_entries():
     )
 
 
+def concepts_only_data_model():
+    yield pytest.param(
+        {
+            "Metadata": {
+                "role": "information architect",
+                "creator": "Jon, Emma, David",
+                "space": "power",
+                "external_id": "power2consumer",
+                "created": datetime(2024, 2, 9, 0, 0),
+                "updated": datetime(2024, 2, 9, 0, 0),
+                "version": "0.1.0",
+                "name": "Power to Consumer Data Model",
+            },
+            "Concepts": [
+                {
+                    "Concept": "GeneratingUnit",
+                    "Description": None,
+                    "Parent Class": None,
+                },
+                {
+                    "Concept": "Substation",
+                    "Description": None,
+                    "Parent Class": None,
+                },
+            ],
+            "Properties": [],
+        },
+        {
+            ResourceDuplicatedError(
+                identifier="name",
+                resource_type="property",
+                location="the Properties sheet at row 1 and 2 if data model is read from a spreadsheet.",
+            ),
+            ConceptOnlyDataModelWarning(),
+        },
+        id="concept_only_data_model",
+    )
+
+
 def incomplete_rules_case():
     yield pytest.param(
         {
@@ -215,6 +256,19 @@ class TestInformationRules:
 
         assert set(e.value.errors) == expected_exception
 
+    @pytest.mark.parametrize("dm_dict, expected_exception", list(concepts_only_data_model()))
+    def test_concepts_only_data_model(self, dm_dict, expected_exception) -> None:
+        input_rules = ImportedDataModel(
+            unverified_data_model=UnverifiedConceptualDataModel.load(dm_dict),
+            context={},
+        )
+        with catch_issues() as issues:
+            _ = VerifyAnyDataModel(validate=True).transform(input_rules)
+
+        assert not issues.has_errors
+        assert len(issues) == 3
+        assert len([issue for issue in issues if isinstance(issue, ConceptOnlyDataModelWarning)]) == 1
+
     def test_load_valid_jon_rules(self, david_spreadsheet: dict[str, dict[str, Any]]) -> None:
         valid_rules = ConceptualDataModel.model_validate(UnverifiedConceptualDataModel.load(david_spreadsheet).dump())
 

{cognite_neat-0.123.10 → cognite_neat-0.123.12}/uv.lock

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

cognite_neat-0.123.10/cognite/neat/_version.py

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

cognite_neat-0.123.10/last_changelog_entry.md

@@ -1,3 +0,0 @@
-### Improved
-
-- Regex on property id has been relaxed accepting web safe characters

cognite_neat-0.123.10/last_git_message.txt

@@ -1,21 +0,0 @@
-Conceptual data model relaxation on property id (#1245)
-
-# Description
-
-This is continued relaxation of regex for conceptual data model to
-support various source data models import to NEAT
-
-## Bump
-
-- [x] Patch
-- [ ] Minor
-- [ ] Skip
-
-## Changelog
-### Improved
-
-- Regex on property id has been relaxed accepting web safe characters
-
----------
-
-Co-authored-by: Nikola Vasiljevic <nikola@Nikolas-MacBook-Air.local>

cognite_neat-0.123.10/last_version.txt

@@ -1 +0,0 @@
-0.123.9

{cognite_neat-0.123.10 → cognite_neat-0.123.12}/cognite/neat/core/_data_model/models/conceptual/_unverified.py

@@ -146,8 +146,8 @@ class UnverifiedConcept(UnverifiedComponent[Concept]):
 @dataclass
 class UnverifiedConceptualDataModel(UnverifiedDataModel[ConceptualDataModel]):
     metadata: UnverifiedConceptualMetadata
-    properties: list[UnverifiedConceptualProperty] = field(default_factory=list)
     concepts: list[UnverifiedConcept] = field(default_factory=list)
+    properties: list[UnverifiedConceptualProperty] = field(default_factory=list)
     prefixes: dict[str, Namespace] | None = None
 
     @classmethod