updates in create_project

Author: Narek Mkhitaryan

src/superannotate/lib/app/interface/sdk_interface.py

@@ -1133,37 +1133,38 @@ def create_project(
         workflow: str = None,
         form: dict = None,
     ):
-        """Create a new project in the team.
+        """Creates a new project in the team. For Multimodal projects, you must provide a valid form object,
+        which serves as a template determining the layout and behavior of the project's interface.
 
-        :param project_name: the new project's name
+        :param project_name: The new project's name.
         :type project_name: str
 
-        :param project_description: the new project's description
+        :param project_description: The new project's description.
         :type project_description: str
 
-        :param project_type: the new project type, Vector, Pixel, Video, Document, Tiled, PointCloud, Multimodal.
+        :param project_type: The project type. Supported types: 'Vector', 'Pixel', 'Video', 'Document', 'Tiled', 'PointCloud', 'Multimodal'.
         :type project_type: str
 
         :param settings: list of settings objects
         :type settings: list of dicts
 
-        :param classes: list of class objects
+        :param classes: List of class objects. Not allowed for 'Multimodal' projects.
         :type classes: list of dicts
 
-        :param workflows: Deprecated
+        :param workflows: Deprecated. Do not use.
         :type workflows: list of dicts
 
-        :param workflow: the name of the workflow already created within the team, which must match exactly.
-                         If None, the default “System workflow” workflow will be set.
+        :param workflow: Name of the workflow already created within the team (must match exactly). If None, the default "System workflow" will be used.
         :type workflow: str
 
-        :param instructions_link: str of instructions URL
+        :param instructions_link: URL for project instructions.
         :type instructions_link: str
 
-        :param form: form object that will be used for the MULTIMODAL project.
+        :param form: Required for Multimodal projects. Must be a JSON object that conforms to SuperAnnotate’s schema
+         for Multimodal form templates, as used in the Multimodal Form Editor.
         :type form: dict
 
-        :return: dict object metadata the new project
+        :return: Metadata of the newly created project.
         :rtype: dict
         """
         if workflows is not None:
@@ -1177,9 +1178,14 @@ def create_project(
         else:
             settings = []
         if ProjectType(project_type) == ProjectType.MULTIMODAL:
-            logger.error("Form is required for Multimodal projects.")
+            if not form:
+                raise AppException(
+                    "A form object is required when creating a Multimodal project."
+                )
             if classes is not None:
-                raise AppException("You can't provide classes for Multimodal projects.")
+                raise AppException(
+                    "Classes cannot be provided for Multimodal projects."
+                )
             settings.append(SettingEntity(attribute="TemplateState", value=1))
         if classes:
             classes = parse_obj_as(List[AnnotationClassEntity], classes)

src/superannotate/lib/core/usecases/projects.py

@@ -1008,11 +1008,13 @@ def __init__(
 
     def validate_form(self):
         if self._form is None:
-            raise AppException("Form is not provided.")
+            raise AppException("Form was not provided.")
         try:
             self._entity = FormModel(**self._form)
         except ValidationError:
-            raise AppException("Form is not valid.")
+            raise AppException(
+                "The provided form object is invalid or does not match the required schema."
+            )
 
     def execute(self) -> Response:
         if self.is_valid():
@@ -1028,6 +1030,8 @@ def execute(self) -> Response:
                 self._response.data = response.data
             else:
                 self._response.errors = response.error
-                logger.error("Failed attach form deleting the project.")
+                logger.error(
+                    "Failed to attach form to the project. Project will be deleted."
+                )
                 self._service_provider.projects.delete(self._project)
         return self._response

tests/integration/projects/test_multimodal_creation.py

@@ -131,3 +131,53 @@ def test_create_project_with_form_classes(self):
                     assert (
                         gen_attr["default"] == exp_attr["default"]
                     ), f"Class {i}, group {j}, attr {k}: default mismatch"
+
+    def test_create_project_multimodal_no_form(self):
+        """Test that multimodal project creation fails when no form is provided"""
+        with self.assertRaises(AppException) as context:
+            sa.create_project(
+                self.PROJECT_NAME,
+                "desc",
+                self.PROJECT_TYPE,
+            )
+        assert "A form object is required when creating a Multimodal project." in str(
+            context.exception
+        )
+
+    def test_create_project_multimodal_with_classes(self):
+        """Test that multimodal project creation fails when classes are provided"""
+        classes = [
+            {
+                "type": 1,
+                "name": "Test Class",
+                "color": "#FF0000",
+            }
+        ]
+
+        with self.assertRaises(AppException) as context:
+            sa.create_project(
+                self.PROJECT_NAME,
+                "desc",
+                self.PROJECT_TYPE,
+                classes=classes,
+                form={"components": []},
+            )
+        assert "Classes cannot be provided for Multimodal projects." in str(
+            context.exception
+        )
+
+    def test_create_project_invalid_form_structure(self):
+        """Test project creation with structurally invalid form data"""
+        invalid_form = {
+            "invalid_key": [
+                {"type": "invalid_component", "missing_required_fields": True}
+            ]
+        }
+
+        with self.assertRaises(AppException):
+            sa.create_project(
+                self.PROJECT_NAME,
+                "desc",
+                self.PROJECT_TYPE,
+                form=invalid_form,
+            )