fix(LAB-3474): deprecation of projectType and creation of fromDemoProject parameter

Co-authored-by: Sihem Tchabi <[email protected]>

Author: stchabi

src/kili/adapters/kili_api_gateway/project/operations_mixin.py

@@ -14,7 +14,7 @@
     load_project_json_fields,
 )
 from kili.adapters.kili_api_gateway.project.operations import get_projects_query
-from kili.core.enums import ProjectType
+from kili.core.enums import DemoProjectType, ProjectType
 from kili.domain.project import ComplianceTag, InputType, ProjectFilters, ProjectId
 from kili.domain.types import ListOrTuple
 
@@ -45,18 +45,20 @@ def create_project(
         description: str,
         project_type: Optional[ProjectType],
         compliance_tags: Optional[ListOrTuple[ComplianceTag]],
+        from_demo_project: Optional[DemoProjectType],
     ) -> ProjectId:
         """Create a project."""
         variables = {
             "data": {
                 "description": description,
+                "fromDemoProject": from_demo_project,
                 "inputType": input_type,
                 "jsonInterface": json.dumps(json_interface),
                 "projectType": project_type,
                 "title": title,
             }
         }
-        # complience tags are only available for Kili app > 2.138
+        # compliance tags are only available for Kili app > 2.138
         if compliance_tags:
             variables["data"]["complianceTags"] = compliance_tags
 

src/kili/core/enums.py

@@ -64,6 +64,27 @@
 ]
 
 
+DemoProjectType = Literal[
+    "DEMO_COMPUTER_VISION_TUTORIAL",
+    "DEMO_TEXT_TUTORIAL",
+    "DEMO_PDF_TUTORIAL",
+    "VIDEO_FRAME_OBJECT_TRACKING",
+    "DEMO_SEGMENTATION_COCO",
+    "DEMO_NER",
+    "DEMO_ID_OCR",
+    "DEMO_REVIEWS",
+    "DEMO_OCR",
+    "DEMO_NER_TWEETS",
+    "DEMO_PLASTIC",
+    "DEMO_CHATBOT",
+    "DEMO_PDF",
+    "DEMO_ANIMALS",
+    "DEMO_LLM",
+    "DEMO_LLM_INSTR_FOLLOWING",
+    "DEMO_SEGMENTATION",
+]
+
+
 Right = Literal[
     "CAN_ACCESS_SMART_TOOLS",
     "CAN_LABEL",

src/kili/presentation/client/project.py

@@ -1,5 +1,4 @@
 """Client presentation methods for projects."""
-
 import warnings
 from typing import (
     Any,
@@ -16,10 +15,11 @@
 from typeguard import typechecked
 
 from kili.adapters.kili_api_gateway.helpers.queries import QueryOptions
-from kili.core.enums import ProjectType
+from kili.core.enums import DemoProjectType, ProjectType
 from kili.domain.project import ComplianceTag, InputType, ProjectFilters, ProjectId
 from kili.domain.tag import TagId
 from kili.domain.types import ListOrTuple
+from kili.exceptions import IncompatibleArgumentsError
 from kili.presentation.client.helpers.common_validators import (
     disable_tqdm_if_as_generator,
 )
@@ -46,6 +46,7 @@ def create_project(
         project_type: Optional[ProjectType] = None,
         tags: Optional[ListOrTuple[str]] = None,
         compliance_tags: Optional[ListOrTuple[ComplianceTag]] = None,
+        from_demo_project: Optional[DemoProjectType] = None,
     ) -> Dict[Literal["id"], str]:
         """Create a project.
 
@@ -55,34 +56,31 @@ def create_project(
             title: Title of the project.
             description: Description of the project.
             project_id: Identifier of the project to copy.
-            project_type: Currently, one of:
-
-                - `IMAGE_CLASSIFICATION_MULTI`
-                - `IMAGE_CLASSIFICATION_SINGLE`
-                - `IMAGE_OBJECT_DETECTION_POLYGON`
-                - `IMAGE_OBJECT_DETECTION_RECTANGLE`
-                - `IMAGE_OBJECT_DETECTION_SEMANTIC`
-                - `IMAGE_POSE_ESTIMATION`
-                - `OCR`
-                - `PDF_CLASSIFICATION_MULTI`
-                - `PDF_CLASSIFICATION_SINGLE`
-                - `PDF_NAMED_ENTITY_RECOGNITION`
-                - `PDF_OBJECT_DETECTION_RECTANGLE`
-                - `SPEECH_TO_TEXT`
-                - `TEXT_CLASSIFICATION_MULTI`
-                - `TEXT_CLASSIFICATION_SINGLE`
-                - `TEXT_NER`
-                - `TEXT_TRANSCRIPTION`
-                - `TIME_SERIES`
-                - `VIDEO_CLASSIFICATION_SINGLE`
-                - `VIDEO_FRAME_CLASSIFICATION`
-                - `VIDEO_FRAME_OBJECT_TRACKING`
-
+            project_type: Will be deprecated soon, use from_demo_project instead.
             tags: Tags to add to the project. The tags must already exist in the organization.
             compliance_tags: Compliance tags of the project.
                 Compliance tags are used to categorize projects based on the sensitivity of
                 the data being handled and the legal constraints associated with it.
                 Possible values are: `PHI` and `PII`.
+            from_demo_project: Currently, one of:
+
+                - `DEMO_COMPUTER_VISION_TUTORIAL`
+                - `DEMO_TEXT_TUTORIAL`
+                - `DEMO_PDF_TUTORIAL`
+                - `VIDEO_FRAME_OBJECT_TRACKING`
+                - `DEMO_SEGMENTATION_COCO`
+                - `DEMO_NER`
+                - `DEMO_ID_OCR`
+                - `DEMO_REVIEWS`
+                - `DEMO_OCR`
+                - `DEMO_NER_TWEETS`
+                - `DEMO_PLASTIC`
+                - `DEMO_CHATBOT`
+                - `DEMO_PDF`
+                - `DEMO_ANIMALS`
+                - `DEMO_LLM`
+                - `DEMO_LLM_INSTR_FOLLOWING`
+                - `DEMO_SEGMENTATION`
 
         Returns:
             A dict with the id of the created project.
@@ -94,6 +92,18 @@ def create_project(
             For more detailed examples on how to create projects,
                 see [the recipe](https://docs.kili-technology.com/recipes/creating-a-project).
         """
+        if project_type is not None:
+            warnings.warn(
+                "Parameter project_type will be soon deprecated, please use from_demo_project instead.",
+                DeprecationWarning,
+                stacklevel=1,
+            )
+
+        if project_type is not None and from_demo_project is not None:
+            raise IncompatibleArgumentsError(
+                "Either provide project_type or from_demo_project. Not both at the same time."
+            )
+
         project_id = ProjectUseCases(self.kili_api_gateway).create_project(
             input_type=input_type,
             json_interface=json_interface,
@@ -102,6 +112,7 @@ def create_project(
             project_id=project_id,
             project_type=project_type,
             compliance_tags=compliance_tags,
+            from_demo_project=from_demo_project,
         )
 
         if tags is not None:

src/kili/use_cases/project/project.py

@@ -11,7 +11,7 @@
 from kili.adapters.kili_api_gateway.helpers.queries import QueryOptions
 from kili.adapters.kili_api_gateway.project.mappers import project_data_mapper
 from kili.adapters.kili_api_gateway.project.types import ProjectDataKiliAPIGatewayInput
-from kili.core.enums import ProjectType
+from kili.core.enums import DemoProjectType, ProjectType
 from kili.domain.project import ComplianceTag, InputType, ProjectFilters, ProjectId
 from kili.domain.types import ListOrTuple
 from kili.exceptions import NotFound
@@ -21,13 +21,14 @@
 class ProjectUseCases(BaseUseCases):
     """Project use cases."""
 
-    # pylint: disable=too-many-arguments
+    # pylint: disable=too-many-arguments, too-many-locals
     def create_project(
         self,
         title: str,
         description: str,
         project_type: Optional[ProjectType],
         compliance_tags: Optional[ListOrTuple[ComplianceTag]],
+        from_demo_project: Optional[DemoProjectType],
         project_id: Optional[ProjectId] = None,
         input_type: Optional[InputType] = None,
         json_interface: Optional[Dict] = None,
@@ -47,6 +48,7 @@ def create_project(
                 description=description,
                 project_type=project_type,
                 compliance_tags=compliance_tags,
+                from_demo_project=from_demo_project,
             )
             if project_copied["instructions"]:
                 self.update_properties_in_project(
@@ -75,6 +77,7 @@ def create_project(
                 description=description,
                 project_type=project_type,
                 compliance_tags=compliance_tags,
+                from_demo_project=from_demo_project,
             )
 
         # The project is not immediately available after creation

tests/integration/presentation/test_project.py

@@ -28,6 +28,7 @@ def test_when_creating_project_then_it_returns_project_id(mocker: pytest_mock.Mo
                 "jsonInterface": "{}",
                 "projectType": None,
                 "title": "fake_title",
+                "fromDemoProject": None,
             }
         },
     )

tests/integration/use_cases/test_project.py

@@ -42,6 +42,7 @@ def test_when_create_project_it_works(kili_api_gateway: KiliAPIGateway):
         project_id=None,
         project_type=None,
         compliance_tags=None,
+        from_demo_project=None,
     )
 
     # Then
@@ -66,6 +67,7 @@ def test_when_create_project_without_inputType_or_jsonInterface_it_throw_an_erro
             description="description",
             project_type=None,
             compliance_tags=None,
+            from_demo_project=None,
         )
 
 
@@ -91,6 +93,7 @@ def test_when_create_project_with_project_id_it_works(kili_api_gateway: KiliAPIG
         project_id=ProjectId("fake_project_id"),
         project_type=None,
         compliance_tags=None,
+        from_demo_project=None,
     )
 
     # Then
@@ -128,6 +131,7 @@ def test_when_create_project_with_project_id_it_throw_an_error_if_tags_do_not_be
             project_id=ProjectId("fake_project_id"),
             project_type=None,
             compliance_tags=None,
+            from_demo_project=None,
         )