Docs update

Author: VaghinakDev

CHANGELOG.rst

@@ -5,6 +5,24 @@ History
 =======
 
 All release highlights of this project will be documented in this file.
+4.4.25 - Sep 30, 2024
+________________________
+
+**Added**
+
+    - ``SAClient.create_project`` method, a new ``workflow`` argument has been added to define the workflow for the project.
+    - ``SAClient.get_project_steps`` method, added instead of ``get_project_workflow`` function.
+    - ``SAClient.set_project_steps`` method, added instead of ``set_project_workflow`` function.
+    - ``SAClient.list_items`` method has been added to search for items using advanced filtering criteria.
+
+
+**Updated**
+
+    - ``SAClient.create_project`` method, removed ``workflows`` argument, use ``set_project_steps`` function instead.
+    - ``SAClient.clone_project`` method, removed ``copy_workflow`` argument, use ``set_project_steps`` function instead.
+    - ``SAClient.get_project_metadata`` method, removed ``include_workflow`` argument, use ``get_project_steps`` function instead.
+    - ``SAClient.get_project_workflow`` method deprecated, use ``get_project_steps`` function instead.
+    - ``SAClient.set_project_workflow`` method deprecated, use ``set_project_steps`` function instead.
 
 4.4.24 - July 2, 2024
 _______________________

docs/source/api_reference/api_metadata.rst

@@ -104,28 +104,20 @@ Item metadata example:
 .. code-block:: python
 
   {
-  "createdAt": "2022-09-14T07:06:53.000Z",
+   "createdAt": "2022-09-14T07:06:53.000Z",
    "updatedAt": "2022-09-30T13:14:26.000Z",
    "id": 33027004,
    "name": "5199856037_03d1929b7b_o.jpg",
    "path": "New Classes",
    "url": "None",
-  "assignments": [
+   "assignments": [
       {
          "user_role": "Annotator",
          "user_id": "annotator@example.com"
       },
       {
          "user_role": "QA",
          "user_id": "qa@example.com"
-      },
-      {
-         "user_role": "reviewer",
-         "user_id": null
-      },
-      {
-         "user_role": "<role_name",
-         "user_id": "my@example.com"
       }
    ],
    "entropy_value": "None",

docs/source/userguide/quickstart.rst

@@ -85,7 +85,7 @@ Custom config.ini example:
 
     [DEFAULT]
     SA_TOKEN = <token>
-    LOGGING_LEVEL = DEBUG
+    LOGGING_LEVEL = INFO
     LOGGING_PATH = /Users/username/data/superannotate_logs
 
 ----------

pytest.ini

@@ -3,4 +3,4 @@ minversion = 3.7
 log_cli=true
 python_files = test_*.py
 ;pytest_plugins = ['pytest_profiling']
-addopts = -n auto --dist=loadscope
+;addopts = -n auto --dist=loadscope

src/superannotate/__init__.py

@@ -3,7 +3,7 @@
 import sys
 
 
-__version__ = "4.4.25dev2"
+__version__ = "4.4.25b1"
 
 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

@@ -2666,7 +2666,7 @@ def list_items(
         project: Union[int, str],
         folder: Optional[Union[int, str]] = None,
         *,
-        include: List[Literal["assignments", "custom_metadata"]] = None,
+        include: List[Literal["custom_metadata"]] = None,
         **filters,
     ):
         """
@@ -2685,7 +2685,6 @@ def list_items(
 
                 Possible values are
 
-                - "assignee": Includes information about the role of the item assignee.
                 - "custom_metadata": Includes custom metadata attached to the item.
         :type include: list of str, optional
 
@@ -2801,8 +2800,6 @@ def list_items(
         if include:
             if "custom_metadata" not in include:
                 exclude.add("custom_metadata")
-            if "assignments" not in include:
-                exclude.add("assignments")
         return BaseSerializer.serialize_iterable(res, exclude=exclude)
 
     def attach_items(

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

@@ -1426,11 +1426,8 @@ def _get_validator(self, version: str) -> superannotate_schemas.Draft7Validator:
             schema_response = self._service_provider.annotations.get_schema(
                 self._project_type, version
             )
-            if not schema_response.ok:
+            if not schema_response.ok or not schema_response.data:
                 raise AppException(f"Schema {version} does not exist.")
-            if not schema_response.data:
-                ValidateAnnotationUseCase.SCHEMAS[key] = lambda x: x
-                return ValidateAnnotationUseCase.SCHEMAS[key]
             validator = superannotate_schemas.Draft7Validator(schema_response.data)
             from functools import partial
 

src/superannotate/lib/infrastructure/services/http_client.py

@@ -273,10 +273,16 @@ async def request(self, *args, **kwargs) -> aiohttp.ClientResponse:
             try:
                 response = await super()._request(*args, **kwargs)
                 if attempts <= 1 or response.status not in self.RETRY_STATUS_CODES:
+                    if not response.ok:
+                        txt = await response.text()
+                        logger.debug(
+                            f"Got {response.status} response from backend: {txt}"
+                        )
                     return response
                 if isinstance(kwargs["data"], aiohttp.FormData):
                     raise RuntimeError(await response.text())
             except (aiohttp.ClientError, RuntimeError) as e:
+                logger.debug(f"AsyncClient got {str(e)} response from backend")
                 if attempts <= 1:
                     raise
                 data = kwargs["data"]

tests/integration/annotations/validations/test_gen_ai_annotation_validation.py

@@ -0,0 +1,16 @@
+from unittest import TestCase
+from unittest.mock import patch
+
+from src.superannotate import SAClient
+
+sa = SAClient()
+
+
+class TestVectorValidators(TestCase):
+    PROJECT_TYPE = "GenAi"
+
+    @patch("builtins.print")
+    def test_validate_annotation_without_metadata(self, mock_print):
+        is_valid = sa.validate_annotations(self.PROJECT_TYPE, {"instances": []})
+        assert not is_valid
+        mock_print.assert_any_call("'metadata' is a required property")

tests/integration/annotations/validations/test_vector_annotation_validation.py

@@ -61,6 +61,5 @@ def test_validate_create_dby(self, mock_print):
         assert not is_valid
         assert mock_print.call_args_list[0].args[0] == (
             """instances[0]                                    'points' is a required property
-instances[0].createdBy.role                     'dmin' is not one of ['Customer', 'Admin', 'Annotator', 'QA']
 instances[1]                                    'points' is a required property"""
         )