cognite-toolkit 0.6.113__tar.gz → 0.6.114__tar.gz

{cognite_toolkit-0.6.113 → cognite_toolkit-0.6.114}/.github/workflows/demo.yml

@@ -20,7 +20,7 @@ jobs:
     name: Loadmaster
     steps:
       - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6
-      - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
+      - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install dependencies

{cognite_toolkit-0.6.113 → cognite_toolkit-0.6.114}/.github/workflows/release.yaml

@@ -19,7 +19,7 @@ jobs:
       IDP_TOKEN_URL: ${{ vars.IDP_TOKEN_URL }}
     steps:
       - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6
-      - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
+      - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6
         with:
           python-version: 3.11
       - name: Install dependencies
@@ -42,7 +42,7 @@ jobs:
       - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
+      - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install dependencies

{cognite_toolkit-0.6.113 → cognite_toolkit-0.6.114}/.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
           - --fixable=E,W,F,I,T,RUF,TID,UP
           - --target-version=py310
       - id: ruff-format
-    rev: v0.14.5
+    rev: v0.14.6
 
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.46.0

{cognite_toolkit-0.6.113 → cognite_toolkit-0.6.114}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite_toolkit
-Version: 0.6.113
+Version: 0.6.114
 Summary: Official Cognite Data Fusion tool for project templates and configuration deployment
 Project-URL: Homepage, https://docs.cognite.com/cdf/deploy/cdf_toolkit/
 Project-URL: Changelog, https://github.com/cognitedata/toolkit/releases

{cognite_toolkit-0.6.113 → cognite_toolkit-0.6.114}/cdf.toml

@@ -33,7 +33,7 @@ dev = true
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.6.113"
+version = "0.6.114"
 
 
 [library.toolkit-data]

{cognite_toolkit-0.6.113 → cognite_toolkit-0.6.114}/cognite_toolkit/_cdf.py

@@ -94,8 +94,6 @@ _app.add_typer(RepoApp(**default_typer_kws), name="repo")
 
 
 if Plugins.run.value.is_enabled():
-    if Flags.v07.is_enabled():
-        print("The run plugin is deprecated and will be replaced by the dev plugin in v0.8.0.")
     _app.add_typer(RunApp(**default_typer_kws), name="run")
 
 if Plugins.dump.value.is_enabled():

{cognite_toolkit-0.6.113 → cognite_toolkit-0.6.114}/cognite_toolkit/_cdf_tk/apps/_download_app.py

@@ -12,6 +12,7 @@ from cognite_toolkit._cdf_tk.commands import DownloadCommand
 from cognite_toolkit._cdf_tk.constants import DATA_DEFAULT_DIR
 from cognite_toolkit._cdf_tk.storageio import (
     AssetIO,
+    CanvasIO,
     ChartIO,
     EventIO,
     FileMetadataIO,
@@ -22,6 +23,8 @@ from cognite_toolkit._cdf_tk.storageio import (
 )
 from cognite_toolkit._cdf_tk.storageio.selectors import (
     AssetSubtreeSelector,
+    CanvasExternalIdSelector,
+    CanvasSelector,
     ChartExternalIdSelector,
     ChartSelector,
     DataSetSelector,
@@ -37,6 +40,7 @@ from cognite_toolkit._cdf_tk.utils.interactive_select import (
     DataModelingSelect,
     EventInteractiveSelect,
     FileMetadataInteractiveSelect,
+    InteractiveCanvasSelect,
     InteractiveChartSelect,
     RawTableInteractiveSelect,
     TimeSeriesInteractiveSelect,
@@ -67,6 +71,10 @@ class ChartFormats(str, Enum):
     ndjson = "ndjson"
 
 
+class CanvasFormats(str, Enum):
+    ndjson = "ndjson"
+
+
 class InstanceTypes(str, Enum):
     node = "node"
     edge = "edge"
@@ -92,6 +100,7 @@ class DownloadApp(typer.Typer):
         self.command("hierarchy")(self.download_hierarchy_cmd)
         self.command("instances")(self.download_instances_cmd)
         self.command("charts")(self.download_charts_cmd)
+        self.command("canvas")(self.download_canvas_cmd)
 
     @staticmethod
     def download_main(ctx: typer.Context) -> None:
@@ -840,3 +849,76 @@ class DownloadApp(typer.Typer):
                 verbose=verbose,
             )
         )
+
+    @staticmethod
+    def download_canvas_cmd(
+        ctx: typer.Context,
+        external_ids: Annotated[
+            list[str] | None,
+            typer.Argument(
+                help="List of canvas external IDs to download. If not provided, an interactive selection will be made.",
+            ),
+        ] = None,
+        file_format: Annotated[
+            CanvasFormats,
+            typer.Option(
+                "--format",
+                "-f",
+                help="Format for downloading the canvas.",
+            ),
+        ] = CanvasFormats.ndjson,
+        compression: Annotated[
+            CompressionFormat,
+            typer.Option(
+                "--compression",
+                "-z",
+                help="Compression format to use when downloading the canvas.",
+            ),
+        ] = CompressionFormat.none,
+        output_dir: Annotated[
+            Path,
+            typer.Option(
+                "--output-dir",
+                "-o",
+                help="Where to download the canvas.",
+                allow_dash=True,
+            ),
+        ] = DEFAULT_DOWNLOAD_DIR,
+        limit: Annotated[
+            int,
+            typer.Option(
+                "--limit",
+                "-l",
+                help="The maximum number of canvas to download. Use -1 to download all canvas.",
+            ),
+        ] = 1000,
+        verbose: Annotated[
+            bool,
+            typer.Option(
+                "--verbose",
+                "-v",
+                help="Turn on to get more verbose output when running the command",
+            ),
+        ] = False,
+    ) -> None:
+        """This command will download Canvas from CDF into a temporary directory."""
+        cmd = DownloadCommand()
+        client = EnvironmentVariables.create_from_environment().get_client()
+        selector: CanvasSelector
+        if external_ids is None:
+            selected_external_ids = InteractiveCanvasSelect(client).select_external_ids()
+            selector = CanvasExternalIdSelector(external_ids=tuple(selected_external_ids))
+        else:
+            selector = CanvasExternalIdSelector(external_ids=tuple(external_ids))
+
+        cmd.run(
+            lambda: cmd.download(
+                selectors=[selector],
+                io=CanvasIO(client),
+                output_dir=output_dir,
+                file_format=f".{file_format.value}",
+                compression=compression.value,
+                limit=limit if limit != -1 else None,
+                verbose=verbose,
+            )
+        )

{cognite_toolkit-0.6.113 → cognite_toolkit-0.6.114}/cognite_toolkit/_cdf_tk/apps/_run.py

@@ -10,6 +10,7 @@ from cognite_toolkit._cdf_tk.commands import (
     RunTransformationCommand,
     RunWorkflowCommand,
 )
+from cognite_toolkit._cdf_tk.feature_flags import Flags
 from cognite_toolkit._cdf_tk.utils.auth import EnvironmentVariables
 
 CDF_TOML = CDFToml.load(Path.cwd())
@@ -23,9 +24,16 @@ class RunApp(typer.Typer):
         self.command("workflow")(self.run_workflow)
         self.add_typer(RunFunctionApp(*args, **kwargs), name="function")
 
+    @staticmethod
+    def _print_deprecation_warning() -> None:
+        """Print deprecation warning for the run plugin."""
+        if Flags.v07.is_enabled():
+            print("The run plugin is deprecated and will be replaced by the dev plugin in v0.8.0.")
+
     @staticmethod
     def main(ctx: typer.Context) -> None:
         """Commands to execute processes in CDF."""
+        RunApp._print_deprecation_warning()
         if ctx.invoked_subcommand is None:
             print("Use [bold yellow]cdf run --help[/] for more information.")
 
@@ -51,6 +59,7 @@ class RunApp(typer.Typer):
         ] = False,
     ) -> None:
         """This command will run the specified transformation using a one-time session."""
+        RunApp._print_deprecation_warning()
         cmd = RunTransformationCommand()
         client = EnvironmentVariables.create_from_environment().get_client()
         cmd.run(lambda: cmd.run_transformation(client, external_id))
@@ -108,6 +117,7 @@ class RunApp(typer.Typer):
         ] = False,
     ) -> None:
         """This command will run the specified workflow."""
+        RunApp._print_deprecation_warning()
         cmd = RunWorkflowCommand()
         env_vars = EnvironmentVariables.create_from_environment()
         cmd.run(lambda: cmd.run_workflow(env_vars, organization_dir, env_name, external_id, version, wait))
@@ -123,6 +133,7 @@ class RunFunctionApp(typer.Typer):
     @staticmethod
     def main(ctx: typer.Context) -> None:
         """Commands to execute function."""
+        RunApp._print_deprecation_warning()
         if ctx.invoked_subcommand is None:
             print("Use [bold yellow]cdf run function --help[/] for more information.")
 
@@ -178,6 +189,7 @@ class RunFunctionApp(typer.Typer):
         ] = False,
     ) -> None:
         """This command will run the specified function locally."""
+        RunApp._print_deprecation_warning()
         cmd = RunFunctionCommand()
         env_vars = EnvironmentVariables.create_from_environment()
         cmd.run(
@@ -243,6 +255,7 @@ class RunFunctionApp(typer.Typer):
         ] = False,
     ) -> None:
         """This command will run the specified function (assuming it is deployed) in CDF."""
+        RunApp._print_deprecation_warning()
         cmd = RunFunctionCommand()
         env_vars = EnvironmentVariables.create_from_environment()
         cmd.run(lambda: cmd.run_cdf(env_vars, organization_dir, env_name, external_id, schedule, wait))

{cognite_toolkit-0.6.113 → cognite_toolkit-0.6.114}/cognite_toolkit/_cdf_tk/client/data_classes/canvas.py

@@ -2,7 +2,7 @@ import sys
 from abc import ABC
 from collections.abc import Sequence
 from datetime import datetime, timezone
-from typing import Any
+from typing import Any, TypeVar
 from uuid import uuid4
 
 from cognite.client import CogniteClient
@@ -31,6 +31,7 @@ from cognite.client.data_classes.data_modeling.instances import (
 )
 
 from cognite_toolkit._cdf_tk.client.data_classes.migration import AssetCentricId
+from cognite_toolkit._cdf_tk.utils.useful_types import JsonVal
 
 if sys.version_info >= (3, 11):
     from typing import Self
@@ -68,6 +69,9 @@ class ExtendedTypedNodeApply(TypedNodeApply, ABC):
         return output
 
 
+T_ExtendedTypedNodeApply = TypeVar("T_ExtendedTypedNodeApply", bound=ExtendedTypedNodeApply)
+
+
 class _CanvasProperties:
     created_by = PropertyOptions("createdBy")
     updated_at = PropertyOptions("updatedAt")
@@ -901,7 +905,7 @@ class IndustrialCanvasApply(CogniteResource):
                 raise TypeError(f"Unexpected instance type: {type(instance)}")
         return ids
 
-    def dump(self, keep_existing_version: bool = True) -> dict[str, object]:
+    def dump(self, keep_existing_version: bool = True) -> dict[str, JsonVal]:
         """Dump the IndustrialCanvasApply to a dictionary."""
         return {
             "canvas": self.canvas.dump(keep_existing_version=keep_existing_version),
@@ -953,7 +957,46 @@ class IndustrialCanvasApply(CogniteResource):
     @classmethod
     def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
         """Load an IndustrialCanvasApply instance from a resource dictionary."""
-        raise NotImplementedError("IndustrialCanvasApply cannot be loaded from dict.")
+        if "canvas" not in resource:
+            raise ValueError("Resource does not contain a canvas node.")
+        canvas_resource = resource["canvas"]
+        if isinstance(canvas_resource, dict):
+            canvas = CanvasApply._load(canvas_resource)
+        elif isinstance(canvas_resource, CanvasApply):
+            canvas = canvas_resource
+        elif isinstance(canvas_resource, NodeApply):
+            canvas = CanvasApply._load(canvas_resource.dump())
+        else:
+            raise TypeError(f"Canvas resource {type(canvas_resource)} is not supported.")
+        return cls(
+            canvas=canvas,
+            annotations=cls._load_apply_items(resource.get("annotations"), CanvasAnnotationApply),
+            container_references=cls._load_apply_items(resource.get("containerReferences"), ContainerReferenceApply),
+            fdm_instance_container_references=cls._load_apply_items(
+                resource.get("fdmInstanceContainerReferences"), FdmInstanceContainerReferenceApply
+            ),
+            solution_tags=cls._load_apply_items(resource.get("solutionTags"), CogniteSolutionTagApply),
+        )
+
+    @classmethod
+    def _load_apply_items(
+        cls, items: object | None, node_cls: type[T_ExtendedTypedNodeApply]
+    ) -> list[T_ExtendedTypedNodeApply]:
+        if items is None:
+            return []
+        elif isinstance(items, Sequence):
+            nodes: list[T_ExtendedTypedNodeApply] = []
+            for node in items:
+                if isinstance(node, dict):
+                    nodes.append(node_cls._load(node))
+                elif isinstance(node, node_cls):
+                    nodes.append(node)
+                elif isinstance(node, NodeApply):
+                    nodes.append(node_cls._load(node.dump()))
+                else:
+                    raise TypeError(f"Expected a sequence of {node_cls.__name__}, got {type(node).__name__}")
+            return nodes
+        raise TypeError(f"Expected a sequence of {node_cls.__name__}, got {type(items).__name__}")
 
 
 class IndustrialCanvas(WriteableCogniteResource[IndustrialCanvasApply]):

{cognite_toolkit-0.6.113 → cognite_toolkit-0.6.114}/cognite_toolkit/_cdf_tk/commands/build_cmd.py

@@ -65,6 +65,7 @@ from cognite_toolkit._cdf_tk.exceptions import (
     ToolkitMissingModuleError,
     ToolkitYAMLFormatError,
 )
+from cognite_toolkit._cdf_tk.feature_flags import Flags
 from cognite_toolkit._cdf_tk.hints import Hint, ModuleDefinition, verify_module_directory
 from cognite_toolkit._cdf_tk.tk_warnings import (
     DuplicatedItemWarning,
@@ -358,6 +359,16 @@ class BuildCommand(ToolkitCommand):
         for resource_name, resource_files in module.source_paths_by_resource_folder.items():
             source_files = self._replace_variables(resource_files, module_variables, resource_name, module.dir, verbose)
 
+            if resource_name == "data_models":
+                resource_name = "data_modeling"
+                if Flags.v07:
+                    self.warn(
+                        MediumSeverityWarning(
+                            "The resource folder 'data_models' is deprecated and will be removed in v1.0. "
+                            "Please rename the folder to 'data_modeling'."
+                        )
+                    )
+
             builder = self._get_builder(build_dir, resource_name)
 
             built_resources = BuiltResourceList[Hashable]()

{cognite_toolkit-0.6.113 → cognite_toolkit-0.6.114}/cognite_toolkit/_cdf_tk/cruds/__init__.py

@@ -106,6 +106,9 @@ for _loader in itertools.chain(
     CRUDS_BY_FOLDER_NAME[_loader.folder_name].append(_loader)  # type: ignore[arg-type, attr-defined]
 del _loader  # cleanup module namespace
 
+# For backwards compatibility
+CRUDS_BY_FOLDER_NAME["data_models"] = CRUDS_BY_FOLDER_NAME["data_modeling"]  # Todo: Remove in v1.0
+
 CRUD_LIST = list(itertools.chain.from_iterable(CRUDS_BY_FOLDER_NAME.values()))
 RESOURCE_CRUD_LIST = [loader for loader in CRUD_LIST if issubclass(loader, ResourceCRUD)]
 RESOURCE_CRUD_CONTAINER_LIST = [loader for loader in CRUD_LIST if issubclass(loader, ResourceContainerCRUD)]
@@ -123,7 +126,8 @@ ResourceTypes: TypeAlias = Literal[
     "auth",
     "cdf_applications",
     "classic",
-    "data_models",
+    "data_modeling",
+    "data_models",  # Todo: Remove in v1.0
     "data_sets",
     "hosted_extractors",
     "locations",

{cognite_toolkit-0.6.113 → cognite_toolkit-0.6.114}/cognite_toolkit/_cdf_tk/cruds/_resource_cruds/datamodel.py

@@ -120,7 +120,7 @@ from .auth import GroupAllScopedCRUD
 @final
 class SpaceCRUD(ResourceContainerCRUD[str, SpaceApply, Space, SpaceApplyList, SpaceList]):
     item_name = "nodes and edges"
-    folder_name = "data_models"
+    folder_name = "data_modeling"
     filename_pattern = r"^.*space$"
     resource_cls = Space
     resource_write_cls = SpaceApply
@@ -252,7 +252,7 @@ class SpaceCRUD(ResourceContainerCRUD[str, SpaceApply, Space, SpaceApplyList, Sp
 
 class ContainerCRUD(ResourceContainerCRUD[ContainerId, ContainerApply, Container, ContainerApplyList, ContainerList]):
     item_name = "nodes and edges"
-    folder_name = "data_models"
+    folder_name = "data_modeling"
     filename_pattern = r"^.*container$"
     resource_cls = Container
     resource_write_cls = ContainerApply
@@ -516,7 +516,7 @@ class ContainerCRUD(ResourceContainerCRUD[ContainerId, ContainerApply, Container
 
 
 class ViewCRUD(ResourceCRUD[ViewId, ViewApply, View, ViewApplyList, ViewList]):
-    folder_name = "data_models"
+    folder_name = "data_modeling"
     filename_pattern = r"^.*view$"
     resource_cls = View
     resource_write_cls = ViewApply
@@ -857,7 +857,7 @@ class ViewCRUD(ResourceCRUD[ViewId, ViewApply, View, ViewApplyList, ViewList]):
 
 @final
 class DataModelCRUD(ResourceCRUD[DataModelId, DataModelApply, DataModel, DataModelApplyList, DataModelList]):
-    folder_name = "data_models"
+    folder_name = "data_modeling"
     filename_pattern = r"^.*datamodel$"
     resource_cls = DataModel
     resource_write_cls = DataModelApply
@@ -991,7 +991,7 @@ class DataModelCRUD(ResourceCRUD[DataModelId, DataModelApply, DataModel, DataMod
 @final
 class NodeCRUD(ResourceContainerCRUD[NodeId, NodeApply, Node, NodeApplyList, NodeList]):
     item_name = "nodes"
-    folder_name = "data_models"
+    folder_name = "data_modeling"
     filename_pattern = r"^.*node$"
     resource_cls = Node
     resource_write_cls = NodeApply
@@ -1150,7 +1150,7 @@ class GraphQLCRUD(
         DataModelId, GraphQLDataModelWrite, GraphQLDataModel, GraphQLDataModelWriteList, GraphQLDataModelList
     ]
 ):
-    folder_name = "data_models"
+    folder_name = "data_modeling"
     filename_pattern = r"^.*GraphQLSchema"
     resource_cls = GraphQLDataModel
     resource_write_cls = GraphQLDataModelWrite
@@ -1350,7 +1350,7 @@ class GraphQLCRUD(
 @final
 class EdgeCRUD(ResourceContainerCRUD[EdgeId, EdgeApply, Edge, EdgeApplyList, EdgeList]):
     item_name = "edges"
-    folder_name = "data_models"
+    folder_name = "data_modeling"
     filename_pattern = r"^.*edge"
     resource_cls = Edge
     resource_write_cls = EdgeApply