Update docs

Author: VaghinakDev

src/superannotate/__init__.py

@@ -3,7 +3,7 @@
 import sys
 
 
-__version__ = "4.4.30b2"
+__version__ = "4.4.30dev1"
 
 os.environ.update({"sa_version": __version__})
 sys.path.append(os.path.split(os.path.realpath(__file__))[0])

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

@@ -406,13 +406,13 @@ def list_users(self, *, include: List[Literal["custom_fields"]] = None, **filter
             - email__contains: str
             - email__starts: str
             - email__ends: str
-            - state: Literal[“CONFIRMED”, “PENDING”]
-            - state__in: List[Literal[“CONFIRMED”, “PENDING”]]
+            - state: Literal[“Confirmed”, “Pending”]
+            - state__in: List[Literal[“Confirmed”, “Pending”]]
             - role: Literal[“admin”, “contributor”]
             - role__in: List[Literal[“admin”, “contributor”]]
 
             Custom Fields Filtering:
-                - Custom fields must be prefixed with custom_field__.
+                - Custom fields must be prefixed with `custom_field__`.
                 - Example: custom_field__Due_date__gte="1738281600" (filtering users whose Due date is after the given Unix timestamp).
 
         :type filters: UserFilters, optional
@@ -426,7 +426,7 @@ def list_users(self, *, include: List[Literal["custom_fields"]] = None, **filter
             client.list_users(
                 email__contains="@superannotate.com",
                 include=["custom_fields"],
-                state__in=["CONFIRMED"]
+                state__in=["Confirmed"]
                 custom_fields__Tag__in=["Tag1", "Tag3"]
             )
 
@@ -3372,7 +3372,7 @@ def list_projects(
             - status__notin: List[Literal[“NotStarted”, “InProgress”, “Completed”, “OnHold”]]
 
             Custom Fields Filtering:
-                - Custom fields must be prefixed with custom_field__.
+                - Custom fields must be prefixed with `custom_field__`.
                 - Example: custom_field__Due_date__gte="1738281600" (filtering users whose Due date is after the given Unix timestamp).
                 - If include does not include "custom_fields" but filter contains custom_fields, an error will be returned
 

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

@@ -46,7 +46,7 @@ class UserFilters(TypedDict, total=False):
     email__contains: Optional[str]
     email__starts: Optional[str]
     email__ends: Optional[str]
-    state: Optional[Literal["CONFIRMED", "PENDING"]]
-    state__in: Optional[List[Literal["CONFIRMED", "PENDING"]]]
-    role: Optional[Literal["admin", "contributor"]]
-    role__in: Optional[List[Literal["admin", "contributor"]]]
+    state: Optional[str]
+    state__in: Optional[List[str]]
+    role: Optional[str]
+    role__in: Optional[List[str]]

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

@@ -4,6 +4,7 @@
 from typing import Optional
 
 from lib.core.entities.base import TimedBaseModel
+from lib.core.enums import WMUserStateEnum
 from lib.core.pydantic_v1 import Extra
 from lib.core.pydantic_v1 import Field
 from lib.core.pydantic_v1 import parse_datetime
@@ -21,17 +22,6 @@ class ProjectType(str, Enum):
     Multimodal = "CUSTOM_LLM"
 
 
-class WMUserStateEnum(str, Enum):
-    Pending = "PENDING"
-    Confirmed = "CONFIRMED"
-    Video = "PUBLIC_VIDEO"
-    Document = "PUBLIC_TEXT"
-    Tiled = "TILED"
-    Other = "CLASSIFICATION"
-    PointCloud = "POINT_CLOUD"
-    Multimodal = "CUSTOM_LLM"
-
-
 class WMUserTypeEnum(int, Enum):
     Contributor = 4
     TeamAdmin = 7

src/superannotate/lib/core/enums.py

@@ -199,3 +199,8 @@ class CustomFieldType(Enum):
     SINGLE_SELECT = 3
     DATE_PICKER = 4
     NUMERIC = 5
+
+
+class WMUserStateEnum(str, Enum):
+    Pending = "PENDING"
+    Confirmed = "CONFIRMED"

src/superannotate/lib/infrastructure/query_builder.py

@@ -14,6 +14,7 @@
 from lib.core.enums import CustomFieldType
 from lib.core.enums import ProjectStatus
 from lib.core.enums import UserRole
+from lib.core.enums import WMUserStateEnum
 from lib.core.exceptions import AppException
 from lib.core.jsx_conditions import EmptyQuery
 from lib.core.jsx_conditions import Filter
@@ -95,6 +96,60 @@ def handle(self, filters: Dict[str, Any], query: Query = None) -> Query:
         return super().handle(filters, query)
 
 
+class ItemFilterHandler(AbstractQueryHandler):
+    def __init__(
+        self,
+        project: ProjectEntity,
+        entity: BaseItemEntity,
+        service_provider: BaseServiceProvider,
+    ):
+        self._service_provider = service_provider
+        self._entity = entity
+        self._project = project
+
+    def handle(self, filters: Dict[str, Any], query: Query = None) -> Query:
+        if query is None:
+            query = EmptyQuery()
+        for key, val in filters.items():
+            _keys = key.split("__")
+            val = self._handle_special_fields(_keys, val)
+            condition, _key = determine_condition_and_key(_keys)
+            query &= Filter(_key, val, condition)
+        return super().handle(filters, query)
+
+    @staticmethod
+    def _extract_value_from_mapping(data, extractor=lambda x: x):
+        if isinstance(data, (list, tuple, set)):
+            return [extractor(i) for i in data]
+        return extractor(data)
+
+    def _handle_special_fields(self, keys: List[str], val):
+        """
+        Handle special fields like 'approval_status', 'assignments',  'user_role' and 'annotation_status'.
+        """
+        if keys[0] == "approval_status":
+            val = (
+                [ApprovalStatus(i).value for i in val]
+                if isinstance(val, (list, tuple, set))
+                else ApprovalStatus(val).value
+            )
+        elif keys[0] == "annotation_status":
+            val = self._extract_value_from_mapping(
+                val,
+                lambda x: self._service_provider.get_annotation_status_value(
+                    self._project, x
+                ),
+            )
+        elif keys[0] == "assignments" and keys[1] == "user_role":
+            if isinstance(val, list):
+                val = [
+                    self._service_provider.get_role_id(self._project, i) for i in val
+                ]
+            else:
+                val = self._service_provider.get_role_id(self._project, val)
+        return val
+
+
 class BaseCustomFieldHandler(AbstractQueryHandler):
     def __init__(
         self, service_provider: BaseServiceProvider, entity: CustomFieldEntityEnum
@@ -151,8 +206,16 @@ def _determine_condition_and_key(keys: List[str]) -> Tuple[OperatorEnum, str]:
             key = ".".join(keys)
         return condition, key
 
-    @staticmethod
-    def _handle_special_fields(keys: List[str], val):
+    def _handle_special_fields(self, keys: List[str], val):
+        if keys[0] == "custom_field":
+            component_id = self._service_provider.get_custom_field_component_id(
+                field_id=int(keys[1]), entity=self._entity
+            )
+            if component_id == CustomFieldType.DATE_PICKER.value:
+                try:
+                    val = val * 1000
+                except Exception:
+                    raise AppException("Invalid custom field value provided.")
         return val
 
     def handle(self, filters: Dict[str, Any], query: Query = None) -> Query:
@@ -168,75 +231,12 @@ def handle(self, filters: Dict[str, Any], query: Query = None) -> Query:
         return super().handle(filters, query)
 
 
-class ItemFilterHandler(AbstractQueryHandler):
-    def __init__(
-        self,
-        project: ProjectEntity,
-        entity: BaseItemEntity,
-        service_provider: BaseServiceProvider,
-    ):
-        self._service_provider = service_provider
-        self._entity = entity
-        self._project = project
-
-    def handle(self, filters: Dict[str, Any], query: Query = None) -> Query:
-        if query is None:
-            query = EmptyQuery()
-        for key, val in filters.items():
-            _keys = key.split("__")
-            val = self._handle_special_fields(_keys, val)
-            condition, _key = determine_condition_and_key(_keys)
-            query &= Filter(_key, val, condition)
-        return super().handle(filters, query)
-
-    @staticmethod
-    def _extract_value_from_mapping(data, extractor=lambda x: x):
-        if isinstance(data, (list, tuple, set)):
-            return [extractor(i) for i in data]
-        return extractor(data)
-
-    def _handle_special_fields(self, keys: List[str], val):
-        """
-        Handle special fields like 'approval_status', 'assignments',  'user_role' and 'annotation_status'.
-        """
-        if keys[0] == "approval_status":
-            val = (
-                [ApprovalStatus(i).value for i in val]
-                if isinstance(val, (list, tuple, set))
-                else ApprovalStatus(val).value
-            )
-        elif keys[0] == "annotation_status":
-            val = self._extract_value_from_mapping(
-                val,
-                lambda x: self._service_provider.get_annotation_status_value(
-                    self._project, x
-                ),
-            )
-        elif keys[0] == "assignments" and keys[1] == "user_role":
-            if isinstance(val, list):
-                val = [
-                    self._service_provider.get_role_id(self._project, i) for i in val
-                ]
-            else:
-                val = self._service_provider.get_role_id(self._project, val)
-        return val
-
-
 class UserFilterHandler(BaseCustomFieldHandler):
     def _handle_special_fields(self, keys: List[str], val):
         """
         Handle special fields like 'custom_fields__'.
         """
-        if keys[0] == "custom_field":
-            component_id = self._service_provider.get_custom_field_component_id(
-                field_id=int(keys[1]), entity=self._entity
-            )
-            if component_id == CustomFieldType.DATE_PICKER.value:
-                try:
-                    val = val * 1000
-                except Exception:
-                    raise AppException("Invalid custom field value provided.")
-        elif keys[0] == "role":
+        if keys[0] == "role":
             try:
                 if isinstance(val, list):
                     val = [UserRole.__getitem__(i.upper()).value for i in val]
@@ -247,14 +247,14 @@ def _handle_special_fields(self, keys: List[str], val):
             except (KeyError, AttributeError):
                 raise AppException("Invalid user role provided.")
         elif keys[0] == "state":
-            valid_states = ["PENDING", "CONFIRMED"]
-            if isinstance(val, list):
-                for state in val:
-                    if state not in valid_states:
-                        raise AppException("Invalid user state provided.")
-            elif val not in valid_states:
+            try:
+                if isinstance(val, list):
+                    val = [WMUserStateEnum[i].value for i in val]
+                else:
+                    val = WMUserStateEnum[val].value
+            except (TypeError, KeyError):
                 raise AppException("Invalid user state provided.")
-        return val
+        return super()._handle_special_fields(keys, val)
 
 
 class ProjectFilterHandler(BaseCustomFieldHandler):
@@ -268,16 +268,7 @@ def _handle_special_fields(self, keys: List[str], val):
                 if isinstance(val, (list, tuple, set))
                 else ProjectStatus(val).value
             )
-        elif keys[0] == "custom_field":
-            component_id = self._service_provider.get_custom_field_component_id(
-                field_id=int(keys[1]), entity=self._entity
-            )
-            if component_id == CustomFieldType.DATE_PICKER.value:
-                try:
-                    val = val * 1000
-                except Exception:
-                    raise AppException("Invalid custom field value provided.")
-        return val
+        return super()._handle_special_fields(keys, val)
 
 
 class QueryBuilderChain:

tests/integration/work_management/test_user_custom_fields.py

@@ -141,7 +141,9 @@ def test_list_users(self):
         assert scapegoat["custom_fields"]["SDK_test_date_picker"] == value
 
         # by email__contains
-        assert len(sa.list_users(email__contains="@superannotate.com")) == len(users)
+        assert len(sa.list_users(email__contains="@superannotate.com")) == len(
+            [i for i in users if i["email"].endswith("@superannotate.com")]
+        )
 
         # by role
         assert len(sa.list_users(role="contributor")) == len(all_contributors)
@@ -150,8 +152,8 @@ def test_list_users(self):
             sa.list_users(role__in=["invalid_role"])
 
         # by state
-        assert len(sa.list_users(state="CONFIRMED")) == len(all_confirmed)
-        assert len(sa.list_users(state__in=["PENDING"])) == len(all_pending)
+        assert len(sa.list_users(state="Confirmed")) == len(all_confirmed)
+        assert len(sa.list_users(state__in=["Pending"])) == len(all_pending)
         with self.assertRaisesRegexp(AppException, "Invalid user state provided."):
             assert len(sa.list_users(state__in=["invalid_state"])) == len(all_pending)