Develop

CHANGELOG.rst

@@ -6,6 +6,14 @@ History
 
 All release highlights of this project will be documented in this file.
 
+4.4.36 - June 05, 2025
+______________________
+
+**Updated**
+
+    - ``SAClient.get_project_steps`` and ``SAClient.get_project_steps`` now support keypoint workflows, enabling structured step configuration with class             IDs, attributes, and step connections.
+    - ``SAClient.list_users`` now returns user-specific permission states for paused, allow_orchestrate, allow_run_explore, and allow_view_sdk_token.
+
 
 4.4.35 - May 2, 2025
 ____________________

docs/source/api_reference/api_project.rst

@@ -24,6 +24,6 @@ Projects
 .. automethod:: superannotate.SAClient.add_contributors_to_project
 .. automethod:: superannotate.SAClient.get_project_settings
 .. automethod:: superannotate.SAClient.set_project_default_image_quality_in_editor
-.. automethod:: superannotate.SAClient.set_project_steps
 .. automethod:: superannotate.SAClient.get_project_steps
+.. automethod:: superannotate.SAClient.set_project_steps
 .. automethod:: superannotate.SAClient.get_component_config

src/superannotate/__init__.py

@@ -3,7 +3,7 @@
 import sys
 
 
-__version__ = "4.4.35"
+__version__ = "4.4.36"
 
 
 os.environ.update({"sa_version": __version__})

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

@@ -74,7 +74,6 @@
 from lib.core.entities.work_managament import WMUserTypeEnum
 from lib.core.jsx_conditions import EmptyQuery
 
-
 logger = logging.getLogger("sa")
 
 NotEmptyStr = constr(strict=True, min_length=1)
@@ -1493,10 +1492,11 @@ def get_project_steps(self, project: Union[str, dict]):
         :param project: project name or metadata
         :type project: str or dict
 
-        :return: project steps
-        :rtype: list of dicts
+        :return: A list of step dictionaries,
+            or a dictionary containing both steps and their connections (for Keypoint workflows).
+        :rtype: list of dicts or dict
 
-        Response Example:
+        Response Example for General Annotation Project:
         ::
 
             [
@@ -1515,6 +1515,34 @@ def get_project_steps(self, project: Union[str, dict]):
                 }
             ]
 
+        Response Example for Keypoint Annotation Project:
+        ::
+
+            {
+              "steps": [
+                {
+                  "step": 1,
+                  "className": "Left Shoulder",
+                  "class_id": "1",
+                  "attribute": [
+                    {
+                            "attribute": {
+                                "id": 123,
+                                "group_id": 12
+                            }
+                        }
+                  ]
+                },
+                {
+                  "step": 2,
+                  "class_id": "2",
+                  "className": "Right Shoulder",
+                }
+              ],
+              "connections": [
+                [1, 2]
+              ]
+            }
         """
         project_name, _ = extract_project_folder(project)
         project = self.controller.get_project(project_name)
@@ -2511,7 +2539,12 @@ def download_export(
         if response.errors:
             raise AppException(response.errors)
 
-    def set_project_steps(self, project: Union[NotEmptyStr, dict], steps: List[dict]):
+    def set_project_steps(
+        self,
+        project: Union[NotEmptyStr, dict],
+        steps: List[dict],
+        connections: List[List[int]] = None,
+    ):
         """Sets project's steps.
 
         :param project: project name or metadata
@@ -2520,7 +2553,11 @@ def set_project_steps(self, project: Union[NotEmptyStr, dict], steps: List[dict]
         :param steps: new workflow list of dicts
         :type steps: list of dicts
 
-        Request Example:
+        :param connections: Defines connections between keypoint annotation steps.
+            Each inner list specifies a pair of step IDs indicating a connection.
+        :type connections: list of list
+
+        Request Example for General Annotation Project:
         ::
 
             sa.set_project_steps(
@@ -2541,10 +2578,40 @@ def set_project_steps(self, project: Union[NotEmptyStr, dict], steps: List[dict]
                     }
                 ]
             )
+
+        Request Example for Keypoint Annotation Project:
+        ::
+
+            sa.set_project_steps(
+                project="Pose Estimation Project",
+                steps=[
+                    {
+                        "step": 1,
+                        "class_id": 12,
+                        "attribute": [
+                            {
+                                "attribute": {
+                                    "id": 123,
+                                    "group_id": 12
+                                }
+                            }
+                        ]
+                    },
+                    {
+                        "step": 2,
+                        "class_id": 13
+                    }
+                ],
+                connections=[
+                    [1, 2]
+                ]
+            )
         """
         project_name, _ = extract_project_folder(project)
         project = self.controller.get_project(project_name)
-        response = self.controller.projects.set_steps(project, steps=steps)
+        response = self.controller.projects.set_steps(
+            project, steps=steps, connections=connections
+        )
         if response.errors:
             raise AppException(response.errors)
 

src/superannotate/lib/core/__init__.py

@@ -10,6 +10,7 @@
 from lib.core.enums import ImageQuality
 from lib.core.enums import ProjectStatus
 from lib.core.enums import ProjectType
+from lib.core.enums import StepsType
 from lib.core.enums import TrainingStatus
 from lib.core.enums import UploadState
 from lib.core.enums import UserRole
@@ -186,6 +187,7 @@ def setup_logging(level=DEFAULT_LOGGING_LEVEL, file_path=LOG_FILE_LOCATION):
     FolderStatus,
     ProjectStatus,
     ProjectType,
+    StepsType,
     UserRole,
     UploadState,
     TrainingStatus,

src/superannotate/lib/core/entities/work_managament.py

@@ -133,6 +133,7 @@ class WMProjectUserEntity(TimedBaseModel):
     email: Optional[str]
     state: Optional[WMUserStateEnum]
     custom_fields: Optional[dict] = Field(dict(), alias="customField")
+    permissions: Optional[dict]
 
     class Config:
         extra = Extra.ignore

src/superannotate/lib/core/enums.py

@@ -117,6 +117,12 @@ def images(self):
         return self.VECTOR.value, self.PIXEL.value, self.TILED.value
 
 
+class StepsType(Enum):
+    INITIAL = 1
+    BASIC = 2
+    KEYPOINT = 3
+
+
 class UserRole(BaseTitledEnum):
     CONTRIBUTOR = "Contributor", 4
     ADMIN = "Admin", 7

src/superannotate/lib/core/serviceproviders.py

@@ -264,10 +264,18 @@ def set_settings(
     def list_steps(self, project: entities.ProjectEntity):
         raise NotImplementedError
 
+    @abstractmethod
+    def list_keypoint_steps(self, project: entities.ProjectEntity):
+        raise NotImplementedError
+
     @abstractmethod
     def set_step(self, project: entities.ProjectEntity, step: entities.StepEntity):
         raise NotImplementedError
 
+    @abstractmethod
+    def set_keypoint_steps(self, project: entities.ProjectEntity, steps, connections):
+        raise NotImplementedError
+
     @abstractmethod
     def set_steps(self, project: entities.ProjectEntity, steps: list):
         raise NotImplementedError

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

@@ -107,10 +107,10 @@ def log_report(
 
 class ItemToUpload(BaseModel):
     item: BaseItemEntity
-    annotation_json: Optional[dict]
-    path: Optional[str]
-    file_size: Optional[int]
-    mask: Optional[io.BytesIO]
+    annotation_json: Optional[dict] = None
+    path: Optional[str] = None
+    file_size: Optional[int] = None
+    mask: Optional[io.BytesIO] = None
 
     class Config:
         arbitrary_types_allowed = True
@@ -282,7 +282,7 @@ def validate_project_type(self):
             raise AppException("Unsupported project type.")
 
     def _validate_json(self, json_data: dict) -> list:
-        if self._project.type >= constants.ProjectType.PIXEL.value:
+        if self._project.type >= int(constants.ProjectType.PIXEL):
             return []
         use_case = ValidateAnnotationUseCase(
             reporter=self.reporter,
@@ -2101,16 +2101,16 @@ def execute(self):
                 if categorization_enabled:
                     item_id_category_map = {}
                     for item_name in uploaded_annotations:
-                        category = (
-                            name_annotation_map[item_name]["metadata"]
-                            .get("item_category", {})
-                            .get("value")
+                        category = name_annotation_map[item_name]["metadata"].get(
+                            "item_category", None
                         )
                         if category:
                             item_id_category_map[name_item_map[item_name].id] = category
-                    self._attach_categories(
-                        folder_id=folder.id, item_id_category_map=item_id_category_map
-                    )
+                    if item_id_category_map:
+                        self._attach_categories(
+                            folder_id=folder.id,
+                            item_id_category_map=item_id_category_map,
+                        )
                 workflow = self._service_provider.work_management.get_workflow(
                     self._project.workflow_id
                 )
@@ -2149,7 +2149,7 @@ def _attach_categories(self, folder_id: int, item_id_category_map: Dict[int, str
             )
             response.raise_for_status()
             categories = response.data
-            self._category_name_to_id_map = {c.name: c.id for c in categories}
+            self._category_name_to_id_map = {c.value: c.id for c in categories}
         for item_id in list(item_id_category_map.keys()):
             category_name = item_id_category_map[item_id]
             if category_name not in self._category_name_to_id_map: