cognite-toolkit 0.5.97__py3-none-any.whl → 0.7.34__py3-none-any.whl

cognite_toolkit/_cdf_tk/client/data_classes/migration.py

@@ -16,7 +16,7 @@ from cognite.client.data_classes.data_modeling.instances import (
 
 from cognite_toolkit._cdf_tk.constants import COGNITE_MIGRATION_SPACE
 from cognite_toolkit._cdf_tk.tk_warnings import IgnoredValueWarning
-from cognite_toolkit._cdf_tk.utils import humanize_collection
+from cognite_toolkit._cdf_tk.utils.useful_types import AssetCentricType, AssetCentricTypeExtended
 
 if sys.version_info >= (3, 11):
     from typing import Self
@@ -26,7 +26,7 @@ else:
 
 @dataclass(frozen=True)
 class AssetCentricId(CogniteObject):
-    resource_type: Literal["asset", "event", "file", "sequence", "timeseries"]
+    resource_type: AssetCentricTypeExtended
     id_: int
 
     @classmethod
@@ -97,7 +97,7 @@ class InstanceSource(_InstanceSourceProperties, TypedNode):
         last_updated_time: int,
         created_time: int,
         *,
-        resource_type: Literal["asset", "event", "file", "sequence", "timeseries"],
+        resource_type: AssetCentricType,
         id_: int,
         data_set_id: int | None = None,
         classic_external_id: str | None = None,
@@ -114,6 +114,14 @@ class InstanceSource(_InstanceSourceProperties, TypedNode):
         self.preferred_consumer_view_id = preferred_consumer_view_id
         self.ingestion_view = DirectRelationReference.load(ingestion_view) if ingestion_view else None
 
+    def dump(self, camel_case: bool = True) -> dict[str, Any]:
+        output = super().dump(camel_case)
+        if self.preferred_consumer_view_id:
+            output["properties"]["cognite_migration"]["InstanceSource/v1"]["preferredConsumerViewId"] = (
+                self.preferred_consumer_view_id.dump(camel_case=camel_case)
+            )
+        return output
+
     @classmethod
     def _load_properties(cls, resource: dict[str, Any]) -> dict[str, Any]:
         if "preferredConsumerViewId" in resource:
@@ -151,58 +159,21 @@ class InstanceSource(_InstanceSourceProperties, TypedNode):
         }[self.resource_type]
         return ViewId("cdf_cdm", external_id, "v1")
 
-
-@dataclass
-class AssetCentricToViewMapping(CogniteObject):
-    to_property_id: dict[str, str]
-    metadata_to_property_id: dict[str, str] | None = None
-
-    @classmethod
-    def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
-        """Load an AssetCentricToViewMapping from a dictionary."""
-        to_property_id = resource["toPropertyId"]
-        metadata_to_property_id = resource.get("metadataToPropertyId")
-
-        if not isinstance(to_property_id, dict):
-            raise TypeError(f"toPropertyId must be a dictionary, not {type(to_property_id)}")
-
-        if invalid_keys := [
-            key for key, value in to_property_id.items() if not (isinstance(key, str) and isinstance(value, str))
-        ]:
-            raise TypeError(
-                f"toPropertyId keys and values must be strings, found invalid keys: {humanize_collection(invalid_keys)}"
-            )
-
-        if metadata_to_property_id is not None and not isinstance(metadata_to_property_id, dict):
-            raise TypeError(f"metadataToPropertyId must be a dictionary or None, not {type(metadata_to_property_id)}")
-
-        if metadata_to_property_id and (
-            invalid_metadata_keys := [
-                key
-                for key, value in metadata_to_property_id.items()
-                if not (isinstance(key, str) and isinstance(value, str))
-            ]
-        ):
-            raise TypeError(
-                f"metadataToPropertyId keys and values must be strings, found invalid keys: {humanize_collection(invalid_metadata_keys)}"
-            )
-
-        return cls(
-            to_property_id=to_property_id,
-            metadata_to_property_id=metadata_to_property_id,
-        )
+    def as_direct_relation_reference(self) -> DirectRelationReference:
+        return DirectRelationReference(space=self.space, external_id=self.external_id)
 
 
-class _ViewSourceProperties:
+class _ResourceViewMapping:
     resource_type = PropertyOptions("resourceType")
     view_id = PropertyOptions("viewId")
+    property_mapping = PropertyOptions("propertyMapping")
 
     @classmethod
     def get_source(cls) -> ViewId:
-        return ViewId("cognite_migration", "ViewSource", "v1")
+        return ViewId("cognite_migration", "ResourceViewMapping", "v1")
 
 
-class ViewSourceApply(_ViewSourceProperties, TypedNodeApply):
+class ResourceViewMappingApply(_ResourceViewMapping, TypedNodeApply):
     """This represents the writing format of view source.
 
     It is used to when data is written to CDF.
@@ -213,7 +184,7 @@ class ViewSourceApply(_ViewSourceProperties, TypedNodeApply):
         external_id: The external id of the view source.
         resource_type: The resource type field.
         view_id: The view id field.
-        mapping: The mapping field.
+        property_mapping: The mapping of asset-centric properties to data model properties.
         existing_version: Fail the ingestion request if the node's version is greater than or equal to this value.
             If no existingVersion is specified, the ingestion will always overwrite any existing data for the node
             (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert,
@@ -226,27 +197,98 @@ class ViewSourceApply(_ViewSourceProperties, TypedNodeApply):
         self,
         external_id: str,
         *,
-        resource_type: Literal["asset", "event", "file", "sequence", "timeseries"],
+        resource_type: str,
         view_id: ViewId,
-        mapping: AssetCentricToViewMapping,
+        property_mapping: dict[str, str],
         existing_version: int | None = None,
         type: DirectRelationReference | tuple[str, str] | None = None,
     ) -> None:
         TypedNodeApply.__init__(self, COGNITE_MIGRATION_SPACE, external_id, existing_version, type)
         self.resource_type = resource_type
         self.view_id = view_id
-        self.mapping = mapping
+        self.property_mapping = property_mapping
+
+    def dump(self, camel_case: bool = True, context: Literal["api", "local"] = "api") -> dict[str, Any]:
+        """Dumps the object to a dictionary.
+
+        Args:
+            camel_case: Whether to use camel case or not.
+            context: If 'api', the output is for the API and will match the Node API schema. If 'local', the output is
+                for a YAML file and all properties are  on the same level as the node properties. See below
+
+        Example:
+            >>> node = ResourceViewMappingApply(
+            ...    external_id="myMapping",
+            ...    resource_type="asset",
+            ...    view_id=ViewId("cdf_cdm", "CogniteAsset", "v1"),
+            ...    property_mapping={"name": "name"},
+            ... )
+            >>> node.dump(camel_case=True, context="api")
+            {
+                "space": "cognite_migration",
+                "externalId": "myMapping",
+                "sources": [
+                    {
+                        "source": {
+                            "space": "cognite_migration",
+                            "externalId": "ViewSource",
+                            "version": "v1",
+                            "type": "view"
+                            },
+
+                        "properties": {
+                            "resourceType": "asset",
+                            "viewId": {
+                                "space": "cdf_cdm",
+                                "externalId": "CogniteAsset",
+                                "version": "v1"
+                            },
+                            "propertyMapping": {
+                                "name": "name"
+                            }
+                        }
+                    }
+                ]
+            }
+            >>> node.dump(camel_case=True, context="local")
+            {
+                "externalId": "myMapping",
+                "resourceType": "asset",
+                "viewId": {
+                    "space": "cdf_cdm",
+                    "externalId": "CogniteAsset",
+                    "version": "v1"
+                },
+                "propertyMapping": {
+                    "name": "name"
+                },
+            }
+
+        Returns:
+            dict[str, Any]: The dumped dictionary representation of the object.
+        """
+        output = super().dump(camel_case)
+        source = output["sources"][0]
+        properties = source["properties"]
+        properties["viewId"] = self.view_id.dump(camel_case=camel_case, include_type=context == "api")
+
+        if context == "local":
+            for key in ("space", "sources", "instanceType"):
+                output.pop(key, None)
+            output.update(properties)
+        return output
 
-    def _dump_properties(self) -> dict[str, Any]:
-        """Dump the properties of the ViewSourceApply."""
-        return {
-            "resourceType": self.resource_type,
-            "viewId": self.view_id.dump(),
-            "mapping": self.mapping.dump(),
-        }
+    @classmethod
+    def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
+        base_props = cls._load_base_properties(resource)
+        properties = cls._load_properties(resource)
+        if "viewId" in resource:
+            properties["view_id"] = ViewId.load(resource["viewId"])
 
+        return cls(**base_props, **properties)
 
-class ViewSource(_ViewSourceProperties, TypedNode):
+
+class ResourceViewMapping(_ResourceViewMapping, TypedNode):
     """This represents the reading format of view source.
 
     It is used to when data is read from CDF.
@@ -262,7 +304,7 @@ class ViewSource(_ViewSourceProperties, TypedNode):
             Coordinated Universal Time (UTC), minus leap seconds.
         resource_type: The resource type field.
         view_id: The view id field.
-        mapping: The mapping field.
+        property_mapping: The mapping field.
         type: Direct relation pointing to the type node.
         deleted_time: The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time
             (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances
@@ -276,9 +318,9 @@ class ViewSource(_ViewSourceProperties, TypedNode):
         last_updated_time: int,
         created_time: int,
         *,
-        resource_type: Literal["asset", "event", "file", "sequence", "timeseries"],
+        resource_type: str,
         view_id: ViewId,
-        mapping: AssetCentricToViewMapping,
+        property_mapping: dict[str, str],
         type: DirectRelationReference | None = None,
         deleted_time: int | None = None,
     ) -> None:
@@ -287,14 +329,14 @@ class ViewSource(_ViewSourceProperties, TypedNode):
         )
         self.resource_type = resource_type
         self.view_id = view_id
-        self.mapping = mapping
+        self.property_mapping = property_mapping
 
-    def as_write(self) -> ViewSourceApply:
-        return ViewSourceApply(
+    def as_write(self) -> ResourceViewMappingApply:
+        return ResourceViewMappingApply(
             self.external_id,
             resource_type=self.resource_type,
             view_id=self.view_id,
-            mapping=self.mapping,
+            property_mapping=self.property_mapping,
             existing_version=self.version,
             type=self.type,
         )
@@ -307,14 +349,6 @@ class ViewSource(_ViewSourceProperties, TypedNode):
                 resource["viewId"] = ViewId.load(view_id)
             except (TypeError, KeyError) as e:
                 raise ValueError(f"Invalid viewId format. Expected 'space', 'externalId', 'version'. Error: {e!s}")
-        if "mapping" in resource:
-            mapping = resource.pop("mapping")
-            try:
-                resource["mapping"] = AssetCentricToViewMapping._load(mapping)
-            except (TypeError, KeyError) as e:
-                raise ValueError(
-                    f"Invalid mapping format. Expected 'toPropertyId' and optionally 'metadataToPropertyId'. Error: {e!s}"
-                )
         return super()._load_properties(resource)
 
     def _dump_properties(self) -> dict[str, Any]:
@@ -322,5 +356,102 @@ class ViewSource(_ViewSourceProperties, TypedNode):
         return {
             "resourceType": self.resource_type,
             "viewId": self.view_id.dump(),
-            "mapping": self.mapping.dump(),
+            "propertyMapping": self.property_mapping,
         }
+
+
+class CreatedSourceSystem(TypedNode):
+    """This represents the reading format of instance source.
+
+    It is used to when data is read from CDF.
+
+    The source of the instance in asset-centric resources.
+
+    Args:
+        space: The space where the node is located.
+        external_id: The external id of the instance source.
+        version (int): DMS version.
+        last_updated_time (int): The number of milliseconds since 00:00:00 Thursday, 1 January 1970,
+            Coordinated Universal Time (UTC), minus leap seconds.
+        created_time (int): The number of milliseconds since 00:00:00 Thursday, 1 January 1970,
+            Coordinated Universal Time (UTC), minus leap seconds.
+        source: The source string from the asset-centric Asset, Event, or FileMetadata source property.
+        type: Direct relation pointing to the type node.
+        deleted_time: The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time
+            (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances
+            are filtered out of query results, but present in sync results
+    """
+
+    def __init__(
+        self,
+        space: str,
+        external_id: str,
+        version: int,
+        last_updated_time: int,
+        created_time: int,
+        *,
+        source: str,
+        type: DirectRelationReference | None = None,
+        deleted_time: int | None = None,
+    ) -> None:
+        TypedNode.__init__(self, space, external_id, version, last_updated_time, created_time, deleted_time, type)
+        self.source = source
+
+    @classmethod
+    def get_source(cls) -> ViewId:
+        return ViewId("cognite_migration", "CreatedSourceSystem", "v1")
+
+    def as_direct_relation_reference(self) -> DirectRelationReference:
+        return DirectRelationReference(space=self.space, external_id=self.external_id)
+
+
+class SpaceSource(TypedNode):
+    """This represents the reading format of space source.
+
+    It is used to when data is read from CDF.
+
+    The source dataSet of an instance space
+
+    Args:
+        space: The space where the node is located.
+        external_id: The external id of the node.
+        version (int): DMS version.
+        last_updated_time (int): The number of milliseconds since 00:00:00 Thursday, 1 January 1970,
+            Coordinated Universal Time (UTC), minus leap seconds.
+        created_time (int): The number of milliseconds since 00:00:00 Thursday, 1 January 1970,
+            Coordinated Universal Time (UTC), minus leap seconds.
+        instance_space (str): The instance space name.
+        data_set_id: The data set id associated with the instance space.
+        data_set_external_id: The classic external id associated with the instance space.
+        type: Direct relation pointing to the type node.
+        deleted_time: The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time
+            (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances
+            are filtered out of query results, but present in sync results
+    """
+
+    instance_space = PropertyOptions("instanceSpace")
+    data_set_id = PropertyOptions("dataSetId")
+    data_set_external_id = PropertyOptions("dataSetExternalId")
+
+    def __init__(
+        self,
+        space: str,
+        external_id: str,
+        version: int,
+        last_updated_time: int,
+        created_time: int,
+        *,
+        instance_space: str,
+        data_set_id: int,
+        data_set_external_id: str | None = None,
+        type: DirectRelationReference | None = None,
+        deleted_time: int | None = None,
+    ) -> None:
+        TypedNode.__init__(self, space, external_id, version, last_updated_time, created_time, deleted_time, type)
+        self.instance_space = instance_space
+        self.data_set_id = data_set_id
+        self.data_set_external_id = data_set_external_id
+
+    @classmethod
+    def get_source(cls) -> ViewId:
+        return ViewId("cognite_migration", "SpaceSource", "v1")

cognite_toolkit/_cdf_tk/client/data_classes/project.py

@@ -0,0 +1,41 @@
+import sys
+from dataclasses import dataclass
+from typing import Any, Literal
+
+from cognite.client import CogniteClient
+from cognite.client.data_classes._base import CogniteResource, CogniteResourceList
+
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+@dataclass
+class ProjectStatus(CogniteResource):
+    """Project status information."""
+
+    data_modeling_status: Literal["HYBRID", "DATA_MODELING_ONLY"]
+    url_name: str
+
+    @classmethod
+    def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
+        return cls(
+            data_modeling_status=resource["dataModelingStatus"],
+            url_name=resource["urlName"],
+        )
+
+
+class ProjectStatusList(CogniteResourceList[ProjectStatus]):
+    """List of ProjectStatus items."""
+
+    _RESOURCE = ProjectStatus
+
+    @property
+    def this_project(self) -> ProjectStatus:
+        """Returns the ProjectStatus of the current project."""
+        project = self._cognite_client.config.project
+        for item in self:
+            if item.url_name == project:
+                return item
+        raise ValueError(f"Project '{project}' not found in the list of projects.")

cognite_toolkit/_cdf_tk/client/data_classes/search_config.py

@@ -12,11 +12,14 @@ from cognite.client.data_classes._base import (
 from typing_extensions import Self
 
 
-@dataclass
-class SearchConfigView(CogniteObject):
+@dataclass(frozen=True)
+class ViewId(CogniteObject):
     external_id: str
     space: str
 
+    def __str__(self) -> str:
+        return f"({self.external_id}, {self.space})"
+
     @classmethod
     def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
         return cls(
@@ -51,18 +54,18 @@ class SearchConfigCore(WriteableCogniteResource["SearchConfigWrite"], ABC):
         id: A server-generated ID for the object.
         use_as_name: The name of property to use for the name column in the UI.
         use_as_description: The name of property to use for the description column in the UI.
-        column_layout: Array of column configurations per property.
+        columns_layout: Array of column configurations per property.
         filter_layout: Array of filter configurations per property.
         properties_layout: Array of property configurations per property.
     """
 
     def __init__(
         self,
-        view: SearchConfigView,
+        view: ViewId,
         id: int | None = None,
         use_as_name: str | None = None,
         use_as_description: str | None = None,
-        column_layout: list[SearchConfigViewProperty] | None = None,
+        columns_layout: list[SearchConfigViewProperty] | None = None,
         filter_layout: list[SearchConfigViewProperty] | None = None,
         properties_layout: list[SearchConfigViewProperty] | None = None,
     ) -> None:
@@ -70,7 +73,7 @@ class SearchConfigCore(WriteableCogniteResource["SearchConfigWrite"], ABC):
         self.id = id
         self.use_as_name = use_as_name
         self.use_as_description = use_as_description
-        self.column_layout = column_layout
+        self.columns_layout = columns_layout
         self.filter_layout = filter_layout
         self.properties_layout = properties_layout
 
@@ -80,16 +83,16 @@ class SearchConfigCore(WriteableCogniteResource["SearchConfigWrite"], ABC):
             id=self.id,
             use_as_name=self.use_as_name,
             use_as_description=self.use_as_description,
-            column_layout=self.column_layout,
+            columns_layout=self.columns_layout,
             filter_layout=self.filter_layout,
             properties_layout=self.properties_layout,
         )
 
     def dump(self, camel_case: bool = True) -> dict[str, Any]:
         output = super().dump(camel_case)
-        if self.column_layout:
-            output["columLayout" if camel_case else "column_layout"] = [
-                _data.dump(camel_case) for _data in self.column_layout
+        if self.columns_layout:
+            output["columnsLayout" if camel_case else "columns_layout"] = [
+                _data.dump(camel_case) for _data in self.columns_layout
             ]
         if self.filter_layout:
             output["filterLayout" if camel_case else "filter_layout"] = [
@@ -113,7 +116,7 @@ class SearchConfigWrite(SearchConfigCore):
         id: A server-generated ID for the object.
         use_as_name: The name of property to use for the name column in the UI.
         use_as_description: The name of property to use for the description column in the UI.
-        column_layout: Array of column configurations per property.
+        columns_layout: Array of column configurations per property.
         filter_layout: Array of filter configurations per property.
         properties_layout: Array of property configurations per property.
     """
@@ -122,18 +125,24 @@ class SearchConfigWrite(SearchConfigCore):
     def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
         return cls(
             id=resource.get("id"),
-            view=SearchConfigView.load(resource["view"]),
+            view=ViewId.load(resource["view"]),
             use_as_name=resource.get("useAsName"),
             use_as_description=resource.get("useAsDescription"),
-            column_layout=[SearchConfigViewProperty.load(item) for item in resource.get("columnLayout", [])]
-            if resource.get("columnLayout")
-            else None,
-            filter_layout=[SearchConfigViewProperty.load(item) for item in resource.get("filterLayout", [])]
-            if resource.get("filterLayout")
-            else None,
-            properties_layout=[SearchConfigViewProperty.load(item) for item in resource.get("propertiesLayout", [])]
-            if resource.get("propertiesLayout")
-            else None,
+            columns_layout=(
+                [SearchConfigViewProperty.load(item) for item in items]
+                if (items := resource.get("columnsLayout"))
+                else None
+            ),
+            filter_layout=(
+                [SearchConfigViewProperty.load(item) for item in items]
+                if (items := resource.get("filterLayout"))
+                else None
+            ),
+            properties_layout=(
+                [SearchConfigViewProperty.load(item) for item in items]
+                if (items := resource.get("propertiesLayout"))
+                else None
+            ),
         )
 
 
@@ -148,20 +157,20 @@ class SearchConfig(SearchConfigCore):
         updated_time: The time when the search config was last updated.
         use_as_name: The name of property to use for the name column in the UI.
         use_as_description: The name of property to use for the description column in the UI.
-        column_layout: Array of column configurations per property.
+        columns_layout: Array of column configurations per property.
         filter_layout: Array of filter configurations per property.
         properties_layout: Array of property configurations per property.
     """
 
     def __init__(
         self,
-        view: SearchConfigView,
+        view: ViewId,
         id: int,
         created_time: int,
         updated_time: int,
         use_as_name: str | None = None,
         use_as_description: str | None = None,
-        column_layout: list[SearchConfigViewProperty] | None = None,
+        columns_layout: list[SearchConfigViewProperty] | None = None,
         filter_layout: list[SearchConfigViewProperty] | None = None,
         properties_layout: list[SearchConfigViewProperty] | None = None,
     ) -> None:
@@ -170,7 +179,7 @@ class SearchConfig(SearchConfigCore):
             id,
             use_as_name,
             use_as_description,
-            column_layout,
+            columns_layout,
             filter_layout,
             properties_layout,
         )
@@ -180,21 +189,27 @@ class SearchConfig(SearchConfigCore):
     @classmethod
     def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
         return cls(
-            view=SearchConfigView.load(resource["view"]),
+            view=ViewId.load(resource["view"]),
             id=resource["id"],
             created_time=resource["createdTime"],
             updated_time=resource["lastUpdatedTime"],
             use_as_name=resource.get("useAsName"),
             use_as_description=resource.get("useAsDescription"),
-            column_layout=[SearchConfigViewProperty.load(item) for item in resource.get("columnLayout", [])]
-            if resource.get("columnLayout")
-            else None,
-            filter_layout=[SearchConfigViewProperty.load(item) for item in resource.get("filterLayout", [])]
-            if resource.get("filterLayout")
-            else None,
-            properties_layout=[SearchConfigViewProperty.load(item) for item in resource.get("propertiesLayout", [])]
-            if resource.get("propertiesLayout")
-            else None,
+            columns_layout=(
+                [SearchConfigViewProperty.load(item) for item in items]
+                if (items := resource.get("columnsLayout"))
+                else None
+            ),
+            filter_layout=(
+                [SearchConfigViewProperty.load(item) for item in items]
+                if (items := resource.get("filterLayout"))
+                else None
+            ),
+            properties_layout=(
+                [SearchConfigViewProperty.load(item) for item in items]
+                if (items := resource.get("propertiesLayout"))
+                else None
+            ),
         )