cognite-neat 1.0.5__py3-none-any.whl → 1.0.7__py3-none-any.whl

cognite/neat/_session/_result/_deployment/_physical/_changes.py

@@ -0,0 +1,195 @@
+import itertools
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from cognite.neat._data_model.deployer.data_classes import (
+    AddedField,
+    AppliedChanges,
+    ChangedField,
+    ChangeResult,
+    DeploymentResult,
+    FieldChange,
+    FieldChanges,
+    RemovedField,
+    ResourceChange,
+)
+
+
+class SerializedFieldChange(BaseModel):
+    """Serialized field change for JSON output."""
+
+    field_path: str
+    severity: str
+    description: str
+
+    @classmethod
+    def from_field_change(cls, field_change: FieldChange) -> list["SerializedFieldChange"]:
+        """Serialize a field change, handling nested FieldChanges recursively.
+
+        Args:
+            field_change: The field change to serialize.
+
+        Returns:
+            List of serialized field changes (may be multiple if nested).
+        """
+        serialized_changes: list[SerializedFieldChange] = []
+
+        if isinstance(field_change, FieldChanges):
+            # Recursively handle nested changes
+            for change in field_change.changes:
+                serialized_changes.extend(cls.from_field_change(change))
+        else:
+            # Base case: single field change
+            serialized_changes.append(cls._from_single_field_change(field_change))
+
+        return serialized_changes
+
+    @classmethod
+    def _from_single_field_change(cls, field_change: FieldChange) -> "SerializedFieldChange":
+        """Serialize a single non-nested field change.
+
+        Args:
+            field_change: The single field change to serialize.
+
+        Returns:
+            Serialized field change.
+        """
+        return cls(
+            field_path=field_change.field_path,
+            severity=field_change.severity.name,
+            description=field_change.description
+            if isinstance(field_change, AddedField | RemovedField | ChangedField)
+            else "Field changed",
+        )
+
+
+class SerializedResourceChange(BaseModel):
+    """Serialized resource change for JSON output."""
+
+    id: int
+    endpoint: str
+    change_type: str
+    severity: str
+    resource_id: str
+    message: str | None = None
+    changes: list[SerializedFieldChange] = Field(default_factory=list)
+
+    @classmethod
+    def from_resource_change(
+        cls, resource: ResourceChange, endpoint: str, change_id: int
+    ) -> "SerializedResourceChange":
+        """Serialize a single resource change.
+
+        Args:
+            resource: The resource change to serialize.
+            endpoint: The endpoint type.
+            change_id: Unique ID for this change.
+
+        Returns:
+            Serialized resource change.
+        """
+        changes: list[SerializedFieldChange] = []
+
+        for change in resource.changes:
+            changes.extend(SerializedFieldChange.from_field_change(change))
+
+        return cls(
+            id=change_id,
+            endpoint=endpoint,
+            change_type=resource.change_type,
+            severity=resource.severity.name,
+            resource_id=str(resource.resource_id),
+            changes=changes,
+        )
+
+    @classmethod
+    def from_change_result(cls, change_id: int, response: ChangeResult) -> "SerializedResourceChange":
+        """Serialize from a change result (actual deployment).
+
+        Args:
+            change_id: Unique ID for this change.
+            response: The change result from deployment.
+
+        Returns:
+            Serialized resource change with deployment status.
+        """
+        serialized_resource_change = cls.from_resource_change(
+            resource=response.change,
+            endpoint=response.endpoint,
+            change_id=change_id,
+        )
+
+        serialized_resource_change.message = response.message
+        if not response.is_success:
+            serialized_resource_change.change_type = "failed"
+
+        return serialized_resource_change
+
+
+class SerializedChanges(BaseModel):
+    """Container for all serialized changes."""
+
+    changes: list[SerializedResourceChange] = Field(default_factory=list)
+
+    @classmethod
+    def from_deployment_result(cls, result: DeploymentResult) -> "SerializedChanges":
+        """Create SerializedChanges from a DeploymentResult.
+
+        Args:
+            result: The deployment result to serialize changes from.
+
+        Returns:
+            SerializedChanges instance with all changes.
+        """
+        serialized = cls()
+
+        if not result.responses:
+            serialized._add_from_dry_run(result)
+        else:
+            serialized._add_from_applied_changes(result.responses)
+
+        return serialized
+
+    def _add_from_dry_run(self, result: DeploymentResult) -> None:
+        """Add changes from dry run deployment.
+
+        Args:
+            result: The deployment result in dry run mode.
+        """
+        # Iterate over each endpoint plan
+        for endpoint_plan in result.plan:
+            # Then per resource in the endpoint
+            for resource in endpoint_plan.resources:
+                # Then serialize individual resource change
+                serialized_resource_change = SerializedResourceChange.from_resource_change(
+                    resource=resource,
+                    endpoint=endpoint_plan.endpoint,
+                    change_id=len(self.changes),
+                )
+                self.changes.append(serialized_resource_change)
+
+    def _add_from_applied_changes(self, applied_changes: AppliedChanges) -> None:
+        """Add changes from actual deployment.
+        Args:
+            result: The deployment result from actual deployment.
+        """
+        for response in itertools.chain(
+            applied_changes.created,
+            applied_changes.merged_updated,
+            applied_changes.deletions,
+            applied_changes.unchanged,
+            applied_changes.skipped,
+        ):
+            self.changes.append(SerializedResourceChange.from_change_result(len(self.changes), response))
+
+    def model_dump_json_flat(self, **kwargs: Any) -> str:
+        """Dump changes as JSON array without the wrapper key.
+        Returns:
+            JSON string of the changes array.
+        """
+        if not self.changes:
+            return "[]"
+
+        iterator = (change.model_dump_json(**kwargs) for change in self.changes)
+        return f"[{','.join(iterator)}]"

cognite/neat/_session/_result/_deployment/_physical/_statistics.py

@@ -0,0 +1,180 @@
+import itertools
+from typing import Any, Literal, cast, get_args
+
+from pydantic import BaseModel, Field
+
+from cognite.neat._data_model.deployer.data_classes import (
+    AppliedChanges,
+    DataModelEndpoint,
+    DeploymentResult,
+)
+
+
+class EndpointStatistics(BaseModel):
+    """Statistics for a single endpoint."""
+
+    create: int = 0
+    update: int = 0
+    delete: int = 0
+    skip: int = 0
+    unchanged: int = 0
+    failed: int = 0
+
+    @property
+    def total(self) -> int:
+        """Total number of changes for this endpoint."""
+        return self.create + self.update + self.delete + self.skip + self.unchanged + self.failed
+
+    def increment(self, change_type: Literal["create", "update", "delete", "unchanged", "skip", "failed"]) -> None:
+        """Increment the count for a specific change type.
+
+        Args:
+            change_type: The type of change (create, update, delete, skip, unchanged, failed).
+        """
+        if hasattr(self, change_type):
+            setattr(self, change_type, getattr(self, change_type) + 1)
+        else:
+            raise RuntimeError(f"Unknown change type: {change_type}. This is a bug in NEAT.")
+
+
+class ChangeTypeStatistics(BaseModel):
+    """Statistics grouped by change type."""
+
+    create: int = 0
+    update: int = 0
+    delete: int = 0
+    skip: int = 0
+    unchanged: int = 0
+    failed: int = 0
+
+    def increment(self, change_type: Literal["create", "update", "delete", "unchanged", "skip", "failed"]) -> None:
+        """Increment the count for a specific change type.
+
+        Args:
+            change_type: The type of change (create, update, delete, skip, unchanged, failed).
+        """
+        if hasattr(self, change_type):
+            setattr(self, change_type, getattr(self, change_type) + 1)
+        else:
+            raise RuntimeError(f"Unknown change type: {change_type}. This is a bug in NEAT.")
+
+
+class SeverityStatistics(BaseModel):
+    """Statistics grouped by severity."""
+
+    SAFE: int = 0
+    WARNING: int = 0
+    BREAKING: int = 0
+
+    def increment(self, severity: Literal["SAFE", "WARNING", "BREAKING"]) -> None:
+        """Increment the count for a specific severity level.
+
+        Args:
+            severity: The severity level (SAFE, WARNING, BREAKING).
+        """
+        if hasattr(self, severity):
+            setattr(self, severity, getattr(self, severity) + 1)
+        else:
+            raise RuntimeError(f"Unknown severity level: {severity}. This is a bug in NEAT.")
+
+
+class DeploymentStatistics(BaseModel):
+    """Overall deployment statistics."""
+
+    by_endpoint: dict[str, EndpointStatistics] = Field(default_factory=dict)
+    by_change_type: ChangeTypeStatistics = Field(default_factory=ChangeTypeStatistics)
+    by_severity: SeverityStatistics = Field(default_factory=SeverityStatistics)
+
+    @property
+    def total_changes(self) -> int:
+        """Total number of changes in the deployment."""
+        return sum(endpoint_stats.total for endpoint_stats in self.by_endpoint.values())
+
+    def model_dump(self, **kwargs: Any) -> dict[str, Any]:
+        """Include computed properties in serialization."""
+        data = super().model_dump(**kwargs)
+        data["total_changes"] = self.total_changes
+        return data
+
+    @classmethod
+    def from_deployment_result(cls, result: DeploymentResult) -> "DeploymentStatistics":
+        """Create DeploymentStatistics from a DeploymentResult.
+
+        Args:
+            result: The deployment result to create statistics from.
+
+        Returns:
+            DeploymentStatistics instance with computed statistics.
+        """
+        stats = cls(
+            by_endpoint={endpoint: EndpointStatistics() for endpoint in get_args(DataModelEndpoint)},
+            by_change_type=ChangeTypeStatistics(),
+            by_severity=SeverityStatistics(),
+        )
+
+        if result.is_dry_run:
+            stats._update_from_dry_run(result)
+        else:
+            stats._update_from_deployment(result)
+
+        return stats
+
+    def _update_from_dry_run(self, result: DeploymentResult) -> None:
+        """Update statistics from dry run mode.
+
+        Args:
+            result: The deployment result in dry run mode.
+        """
+        for plan in result.plan:
+            for resource in plan.resources:
+                self._update_single_stat(
+                    endpoint=plan.endpoint,
+                    change_type=resource.change_type,
+                    severity=cast(Literal["SAFE", "WARNING", "BREAKING"], resource.severity.name),
+                )
+
+    def _update_from_deployment(self, result: DeploymentResult) -> None:
+        """Update statistics from actual deployment mode.
+
+        Args:
+            result: The deployment result from actual deployment.
+        """
+        applied_changes = cast(AppliedChanges, result.responses)
+
+        for response in itertools.chain(
+            applied_changes.created,
+            applied_changes.merged_updated,
+            applied_changes.deletions,
+            applied_changes.unchanged,
+            applied_changes.skipped,
+        ):
+            self._update_single_stat(
+                endpoint=response.endpoint,
+                change_type=response.change.change_type if response.is_success else "failed",
+                severity=cast(Literal["SAFE", "WARNING", "BREAKING"], response.change.severity.name),
+            )
+
+    def _update_single_stat(
+        self,
+        endpoint: str,
+        change_type: Literal["create", "update", "delete", "unchanged", "skip", "failed"],
+        severity: Literal["SAFE", "WARNING", "BREAKING"],
+    ) -> None:
+        """Update all statistics for a single change.
+
+        Args:
+            endpoint: The endpoint type (spaces, containers, views, datamodels).
+            change_type: The type of change (create, update, delete, skip, unchanged, failed).
+            severity: The severity level (SAFE, WARNING, BREAKING).
+        """
+        # Update by change type statistics
+        self.by_change_type.increment(change_type)
+
+        # Update by endpoint statistics
+        if endpoint in self.by_endpoint:
+            self.by_endpoint[endpoint].increment(change_type)
+        else:
+            raise RuntimeError(f"Unknown endpoint: {endpoint}. This is a bug in NEAT.")
+
+        # Update severity statistics
+        self.by_severity.increment(severity)

cognite/neat/_session/_result/_deployment/_physical/serializer.py

@@ -0,0 +1,35 @@
+import uuid
+from typing import Any
+
+from cognite.neat._data_model.deployer.data_classes import DeploymentResult
+
+from ._changes import SerializedChanges
+from ._statistics import DeploymentStatistics
+
+
+def serialize_deployment_result(result: DeploymentResult) -> dict[str, Any]:
+    """Serialize deployment result into structured changes.
+
+    Args:
+        result: The deployment result to serialize.
+
+    Returns:
+        Serialized changes representing the deployment result.
+    """
+    result_dict = {"unique_id": uuid.uuid4().hex[:8], "status": result.status, "is_dry_run": result.is_dry_run}
+
+    stats = DeploymentStatistics.from_deployment_result(result)
+    changes = SerializedChanges.from_deployment_result(result)
+
+    result_dict["total_changes"] = stats.total_changes
+    result_dict["created"] = stats.by_change_type.create
+    result_dict["updated"] = stats.by_change_type.update
+    result_dict["deleted"] = stats.by_change_type.delete
+    result_dict["skipped"] = stats.by_change_type.skip
+    result_dict["unchanged"] = stats.by_change_type.unchanged
+    result_dict["failed"] = stats.by_change_type.failed
+
+    result_dict["STATS_JSON"] = stats.model_dump_json()
+    result_dict["CHANGES_JSON"] = changes.model_dump_json_flat()
+
+    return result_dict

cognite/neat/_session/_result/_result.py

@@ -0,0 +1,31 @@
+from cognite.neat._data_model.deployer.data_classes import DeploymentResult
+from cognite.neat._session._html._render import render
+from cognite.neat._store import NeatStore
+
+from ._deployment._physical.serializer import serialize_deployment_result
+
+
+class Result:
+    """Class to handle deployment results in the NeatSession."""
+
+    def __init__(self, store: NeatStore) -> None:
+        self._store = store
+
+    @property
+    def _result(self) -> DeploymentResult | None:
+        """Get deployment result from the last change in the store."""
+        if change := self._store.provenance.last_change:
+            if change.result:
+                return change.result
+        return None
+
+    def _repr_html_(self) -> str:
+        """Generate interactive HTML representation."""
+        if not self._result:
+            return "<p>No deployment result available</p>"
+
+        if isinstance(self._result, DeploymentResult):
+            serialized_result = serialize_deployment_result(self._result)
+            return render("deployment", serialized_result)
+        else:
+            raise NotImplementedError(f"HTML rendering for the result type {type(self._result)} is not implemented.")

cognite/neat/_version.py

@@ -1,2 +1,2 @@
-__version__ = "1.0.5"
+__version__ = "1.0.7"
 __engine__ = "^2.0.4"

{cognite_neat-1.0.5.dist-info → cognite_neat-1.0.7.dist-info}/METADATA

@@ -1,56 +1,56 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 1.0.5
+Version: 1.0.7
 Summary: Knowledge graph transformation
-Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
-Project-URL: Homepage, https://cognite-neat.readthedocs-hosted.com/
-Project-URL: GitHub, https://github.com/cognitedata/neat
-Project-URL: Changelog, https://github.com/cognitedata/neat/releases
+Author: Nikola Vasiljevic, Anders Albert
 Author-email: Nikola Vasiljevic <nikola.vasiljevic@cognite.com>, Anders Albert <anders.albert@cognite.com>
 License-Expression: Apache-2.0
-License-File: LICENSE
-Requires-Python: >=3.10
-Requires-Dist: backports-strenum<2.0.0,>=1.2; python_version < '3.11'
-Requires-Dist: cognite-sdk<8.0.0,>=7.83.0
-Requires-Dist: elementpath<5.0.0,>=4.0.0
-Requires-Dist: exceptiongroup<2.0.0,>=1.1.3; python_version < '3.11'
+Requires-Dist: pandas>=1.5.3,<3.0.0
+Requires-Dist: cognite-sdk>=7.83.0,<8.0.0
+Requires-Dist: rdflib>=7.0.0,<8.0.0
 Requires-Dist: httpx>=0.28.1
-Requires-Dist: jsonpath-python<2.0.0,>=1.0.6
-Requires-Dist: mixpanel<5.0.0,>=4.10.1
-Requires-Dist: networkx<4.0.0,>=3.4.2
-Requires-Dist: openpyxl<4.0.0,>=3.0.10
+Requires-Dist: pydantic>=2.0.0,<3.0.0
+Requires-Dist: pyyaml>=6.0.1,<7.0.0
+Requires-Dist: requests>=2.28.1,<3.0.0
+Requires-Dist: urllib3>=1.26.15,<3.0.0
+Requires-Dist: openpyxl>=3.0.10,<4.0.0
+Requires-Dist: networkx>=3.4.2,<4.0.0
+Requires-Dist: mixpanel>=4.10.1,<5.0.0
 Requires-Dist: packaging>=22.0
-Requires-Dist: pandas<3.0.0,>=1.5.3
-Requires-Dist: pydantic<3.0.0,>=2.0.0
-Requires-Dist: pyvis<1.0.0,>=0.3.2
-Requires-Dist: pyyaml<7.0.0,>=6.0.1
-Requires-Dist: rdflib<8.0.0,>=7.0.0
-Requires-Dist: requests<3.0.0,>=2.28.1
-Requires-Dist: rich[jupyter]<14.0.0,>=13.7.1
-Requires-Dist: tomli<3.0.0,>=2.0.1; python_version < '3.11'
-Requires-Dist: typing-extensions<5.0.0,>=4.8.0; python_version < '3.11'
-Requires-Dist: urllib3<3.0.0,>=1.26.15
+Requires-Dist: jsonpath-python>=1.0.6,<2.0.0
+Requires-Dist: elementpath>=4.0.0,<5.0.0
+Requires-Dist: pyvis>=0.3.2,<1.0.0
+Requires-Dist: rich[jupyter]>=13.7.1,<14.0.0
+Requires-Dist: exceptiongroup>=1.1.3,<2.0.0 ; python_full_version < '3.11'
+Requires-Dist: backports-strenum>=1.2,<2.0.0 ; python_full_version < '3.11'
+Requires-Dist: typing-extensions>=4.8.0,<5.0.0 ; python_full_version < '3.11'
+Requires-Dist: tomli>=2.0.1,<3.0.0 ; python_full_version < '3.11'
+Requires-Dist: mkdocs>=1.4.0,<2.0.0 ; extra == 'docs'
+Requires-Dist: mkdocs-jupyter>=0.25.1,<1.0.0 ; extra == 'docs'
+Requires-Dist: mkdocs-material-extensions>=1.3.1,<2.0.0 ; extra == 'docs'
+Requires-Dist: mkdocs-git-revision-date-localized-plugin ; extra == 'docs'
+Requires-Dist: mkdocs-git-authors-plugin>=0.9.4,<1.0.0 ; extra == 'docs'
+Requires-Dist: mkdocs-gitbook>=0.0.1,<1.0.0 ; extra == 'docs'
+Requires-Dist: mkdocs-glightbox>=0.4.0,<1.0.0 ; extra == 'docs'
+Requires-Dist: pymdown-extensions>=10.14.3,<11.0.0 ; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.25.2,<1.0.0 ; extra == 'docs'
+Requires-Dist: mistune==3.0.2 ; extra == 'docs'
+Requires-Dist: mkdocs-autorefs>=0.5.0,<1.0.0 ; extra == 'docs'
+Requires-Dist: gspread>=5.0.0,<6.0.0 ; extra == 'google'
+Requires-Dist: google-api-python-client>=2.70.0,<3.0.0 ; extra == 'google'
+Requires-Dist: google-auth-oauthlib>=1.0.0,<2.0.0 ; extra == 'google'
+Requires-Dist: lxml>=5.3.0,<6.0.0 ; extra == 'lxml'
+Requires-Dist: oxrdflib>=0.4.0,<0.5.0 ; extra == 'oxi'
+Requires-Dist: pyoxigraph>=0.4.3,<0.5.0 ; extra == 'oxi'
+Requires-Python: >=3.10
+Project-URL: Changelog, https://github.com/cognitedata/neat/releases
+Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
+Project-URL: GitHub, https://github.com/cognitedata/neat
+Project-URL: Homepage, https://cognite-neat.readthedocs-hosted.com/
 Provides-Extra: docs
-Requires-Dist: mistune==3.0.2; extra == 'docs'
-Requires-Dist: mkdocs-autorefs<1.0.0,>=0.5.0; extra == 'docs'
-Requires-Dist: mkdocs-git-authors-plugin<1.0.0,>=0.9.4; extra == 'docs'
-Requires-Dist: mkdocs-git-revision-date-localized-plugin; extra == 'docs'
-Requires-Dist: mkdocs-gitbook<1.0.0,>=0.0.1; extra == 'docs'
-Requires-Dist: mkdocs-glightbox<1.0.0,>=0.4.0; extra == 'docs'
-Requires-Dist: mkdocs-jupyter<1.0.0,>=0.25.1; extra == 'docs'
-Requires-Dist: mkdocs-material-extensions<2.0.0,>=1.3.1; extra == 'docs'
-Requires-Dist: mkdocs<2.0.0,>=1.4.0; extra == 'docs'
-Requires-Dist: mkdocstrings[python]<1.0.0,>=0.25.2; extra == 'docs'
-Requires-Dist: pymdown-extensions<11.0.0,>=10.14.3; extra == 'docs'
 Provides-Extra: google
-Requires-Dist: google-api-python-client<3.0.0,>=2.70.0; extra == 'google'
-Requires-Dist: google-auth-oauthlib<2.0.0,>=1.0.0; extra == 'google'
-Requires-Dist: gspread<6.0.0,>=5.0.0; extra == 'google'
 Provides-Extra: lxml
-Requires-Dist: lxml<6.0.0,>=5.3.0; extra == 'lxml'
 Provides-Extra: oxi
-Requires-Dist: oxrdflib<0.5.0,>=0.4.0; extra == 'oxi'
-Requires-Dist: pyoxigraph<0.5.0,>=0.4.3; extra == 'oxi'
 Description-Content-Type: text/markdown
 
 # kNowlEdge grAph Transformer (NEAT)