refactor; Implemented API endopints

Author: doctrino

cognite/client/_api/projects.py

@@ -1,24 +1,36 @@
 from __future__ import annotations
 
+from typing import Sequence, overload
+
 from cognite.client._api_client import APIClient
-from cognite.client.data_classes import Project, ProjectUpdate, ProjectWrite
+from cognite.client.data_classes import Project, ProjectList, ProjectUpdate, ProjectURLNameList, ProjectWrite
 
 
 class ProjectsAPI(APIClient):
     _RESOURCE_PATH = "/projects"
 
+    @overload
     def create(self, item: ProjectWrite) -> Project:
+        ...
+
+    @overload
+    def create(self, item: Sequence[ProjectWrite]) -> ProjectList:
+        ...
+
+    def create(self, item: ProjectWrite | Sequence[ProjectWrite]) -> Project | ProjectList:
         """`Create a project <https://developer.cognite.com/api#tag/Projects/operation/createProject>`_"""
-        raise NotImplementedError
+        return self._create_multiple(item, list_cls=ProjectList, resource_cls=Project, input_resource_cls=ProjectWrite)
 
     def retrieve(self, project: str) -> Project:
         """`Retrieve a project <https://developer.cognite.com/api#tag/Projects/operation/getProject>`_"""
-        raise NotImplementedError
+        item = self._get(f"{self._RESOURCE_PATH}/{project}")
+        return Project._load(item.json(), cognite_client=self._cognite_client)
 
     def update(self, item: ProjectWrite | ProjectUpdate) -> Project:
         """`Update a project <https://developer.cognite.com/api#tag/Projects/operation/updateProject>`_"""
-        raise NotImplementedError
+        return self._update_multiple(item, list_cls=ProjectList, resource_cls=Project, update_cls=ProjectUpdate)
 
-    def list(self) -> list[str]:
+    def list(self) -> ProjectURLNameList:
         """`List all projects <https://developer.cognite.com/api#tag/Projects/operation/listProjects>`_"""
-        raise NotImplementedError
+        items = self._get(self._RESOURCE_PATH)
+        return ProjectURLNameList.load(items.json(), cognite_client=self._cognite_client)

cognite/client/data_classes/__init__.py

@@ -151,7 +151,17 @@
     LabelDefinitionWrite,
     LabelFilter,
 )
-from cognite.client.data_classes.projects import Claim, OIDCConfiguration, Project, ProjectUpdate, ProjectWrite
+from cognite.client.data_classes.projects import (
+    Claim,
+    OIDCConfiguration,
+    Project,
+    ProjectList,
+    ProjectUpdate,
+    ProjectURLName,
+    ProjectURLNameList,
+    ProjectWrite,
+    ProjectWriteList,
+)
 from cognite.client.data_classes.raw import (
     Database,
     DatabaseList,
@@ -561,6 +571,10 @@
     "Project",
     "ProjectUpdate",
     "ProjectWrite",
+    "ProjectURLName",
+    "ProjectURLNameList",
+    "ProjectWriteList",
+    "ProjectList",
     "OIDCConfiguration",
     "Claim",
 ]

cognite/client/data_classes/projects.py

@@ -8,8 +8,10 @@
     CogniteObjectUpdate,
     CognitePrimitiveUpdate,
     CogniteResource,
+    CogniteResourceList,
     CogniteUpdate,
     PropertySpec,
+    WriteableCogniteResource,
 )
 from cognite.client.data_classes.user_profiles import UserProfilesConfiguration
 
@@ -110,7 +112,24 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
         return output
 
 
-class ProjectCore(CogniteResource, ABC):
+class ProjectURLName(CogniteResource):
+    """A project URL name is a unique identifier for a project.
+
+    Args:
+        url_name (str): The URL name of the project. This is used as part of the request path in API calls.
+            Valid URL names contain between 3 and 32 characters, and may only contain English letters, digits and hyphens,
+            must contain at least one letter and may not start or end with a hyphen.
+    """
+
+    def __init__(self, url_name: str) -> None:
+        self.url_name = url_name
+
+    @classmethod
+    def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> ProjectURLName:
+        return cls(url_name=resource["urlName"])
+
+
+class ProjectCore(WriteableCogniteResource["ProjectWrite"], ABC):
     """Projects are used to isolate data in CDF rom each other. All objects in CDF belong to a single project,
     and objects in different projects are isolated from each other.
 
@@ -168,6 +187,10 @@ def __init__(
         # is required for the Read format but not the Write format.
         self.user_profiles_configuration = user_profiles_configuration
 
+    def as_write(self) -> ProjectWrite:
+        """Returns this instance which is a Project Write"""
+        return self
+
     @classmethod
     def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> ProjectWrite:
         return cls(
@@ -230,6 +253,10 @@ def __init__(
         # is required for the Read format but not the Write format.
         self.user_profiles_configuration = user_profiles_configuration
 
+    def as_write(self) -> ProjectWrite:
+        """Returns this instance which is a Project Write"""
+        raise NotImplementedError("Project cannot be used as a ProjectWrite")
+
     @classmethod
     def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Project:
         return cls(
@@ -301,3 +328,15 @@ def _get_update_properties(cls) -> list[PropertySpec]:
             PropertySpec("oidc_configuration", is_nullable=True),
             PropertySpec("user_profiles_configuration", is_nullable=False),
         ]
+
+
+class ProjectURLNameList(CogniteResourceList[ProjectURLName]):
+    _RESOURCE = ProjectURLName
+
+
+class ProjectList(CogniteResourceList[Project]):
+    _RESOURCE = Project
+
+
+class ProjectWriteList(CogniteResourceList[ProjectWrite]):
+    _RESOURCE = ProjectWrite

tests/tests_integration/test_api/test_projects.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+import pytest
+
+from cognite.client.data_classes import ProjectURLName, ProjectURLNameList
+
+
+@pytest.fixture(scope="module")
+def available_projects(cognite_client) -> ProjectURLNameList:
+    if projects := cognite_client.iam.projects.list():
+        return projects
+    pytest.skip("Can't test projects without any projects available", allow_module_level=True)
+
+
+@pytest.mark.skip(reason="Lack access to projects to perform operations")
+class TestProjects:
+    def test_list_projects(self, available_projects: ProjectURLNameList) -> None:
+        assert len(available_projects) >= 1, "Expected at least one project"
+        assert isinstance(available_projects, ProjectURLNameList)
+        assert isinstance(available_projects[0], ProjectURLName)