Fix pep8 issues and docs

Author: VaghinakDev

docs/source/superannotate.sdk.rst

@@ -94,6 +94,7 @@ Subsets
 ______
 
 .. automethod:: superannotate.SAClient.get_subsets
+.. automethod:: superannotate.SAClient.add_items_to_subset
 
 ----------
 

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

@@ -3052,59 +3052,65 @@ def add_items_to_subset(
 
         Associates selected items with a given subset. Non-existing subset will be automatically created.
 
-        :param project:  – project name (e.g., “project1”)
+        :param project:  project name (e.g., “project1”)
         :type project: str
 
         :param subset: a name of an existing/new subset to associate items with. New subsets will be automatically created.
         :type subset: str
 
-        :param items: – list of items metadata. Required keys are 'name' and 'path'
+        :param items: list of items metadata. Required keys are 'name' and 'path'
         :type items: list of dicts
 
         Request Example:
-
         ::
-        client = SAClient()
+            client = SAClient()
 
-        # option 1
-        queried_items = client.query(
-            project="Image Project",
-            query="instance(error = true)"
-         )
+            # option 1
+            queried_items = client.query(
+                project="Image Project",
+                query="instance(error = true)"
+             )
 
-        client.add_items_to_subset(
-            project="Medical Annotations",
-            subset="Brain Study - Disapproved",
-            items=queried_items
-        )
-
-        items_list = [
-            {
-                'name': 'image_1.jpeg',
-                'path': 'Image Project'
-            },
-            {
-                'name': 'image_2.jpeg',
-                'path': 'Image Project/Subfolder A'
-            }
-        ]
+            client.add_items_to_subset(
+                project="Medical Annotations",
+                subset="Brain Study - Disapproved",
+                items=queried_items
+            )
 
-        client.add_items_to_subset(
-            project="Image Project",
-            subset="Subset Name",
-            items=items_list
+            items_list = [
+                {
+                    'name': 'image_1.jpeg',
+                    'path': 'Image Project'
+                },
+                {
+                    'name': 'image_2.jpeg',
+                    'path': 'Image Project/Subfolder A'
+                }
+            ]
 
-        )
+            client.add_items_to_subset(
+                project="Image Project",
+                subset="Subset Name",
+                items=items_list
 
+            )
 
         Response Example:
         ::
-        {
-            "succeeded": [{}, {}],
-            "failed": [],
-            "skipped": []
-        }
-
+            {
+                "succeeded": [
+                    {
+                        'name': 'image_1.jpeg',
+                        'path': 'Image Project'
+                    },
+                    {
+                        'name': 'image_2.jpeg',
+                        'path': 'Image Project/Subfolder A'
+                    }
+                ],
+                "failed": [],
+                "skipped": []
+            }
         """
 
         project_name, _ = extract_project_folder(project)

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

@@ -145,7 +145,7 @@ def __init__(
         folder: FolderEntity,
         backend_service_provider: SuperannotateServiceProvider,
         query: str,
-        subset: str,
+        subset: str = None,
     ):
         super().__init__(reporter)
         self._project = project
@@ -918,7 +918,8 @@ def __separate_to_paths(
                     folders=self.folder_repository,
                     condition=Condition.get_empty_condition(),
                 ).execute()
-
+                if folder_candidates.errors:
+                    raise AppException(folder_candidates.errors)
                 for f in folder_candidates.data:
                     if f.name == folder:
                         value["folder"] = f
@@ -931,7 +932,7 @@ def __separate_to_paths(
             except Exception as e:
                 removeables.append(path)
 
-        ## Removing completely incorrect paths and their items
+        # Removing completely incorrect paths and their items
         for item in removeables:
             self.results["skipped"].extend(self.path_separated[item]["items"])
             self.path_separated.pop(item)
@@ -945,7 +946,6 @@ def __build_query_string(self, path, item_names):
         return query_str
 
     def __query(self, path, items):
-        folder = None
         _, folder = extract_project_folder(path)
 
         item_names = [item["name"] for item in items["items"]]
@@ -1039,7 +1039,9 @@ def execute(
                     self.subset_name,
                 )
 
-                self.reporter.log_info("You've successfully created a new subset - {subset name}.")
+                self.reporter.log_info(
+                    f"You've successfully created a new subset - {self.subset_name}."
+                )
 
             subset_id = subset["id"]
             response = None
@@ -1048,7 +1050,7 @@ def execute(
                 tmp_response = self._backend_client.add_items_to_subset(
                     project_id=self.project.id,
                     team_id=self.project.team_id,
-                    item_ids=self.item_ids[i : i + self.CHUNK_SIZE],
+                    item_ids=self.item_ids[i : i + self.CHUNK_SIZE],  # noqa
                     subset_id=subset_id,
                 )
 

src/superannotate/lib/infrastructure/services.py

@@ -1663,7 +1663,9 @@ def sort_items_by_size(
             response_data["large"].extend(response_json.get("large", []))
         return response_data
 
-    def add_items_to_subset(self, project_id, team_id, item_ids, subset_id):
+    def add_items_to_subset(
+        self, project_id: int, team_id: int, item_ids: List[int], subset_id: int
+    ):
         params = {"team_id": team_id}
 
         data = {"action": "ATTACH", "item_ids": item_ids}
@@ -1711,7 +1713,6 @@ def get_subset(self, team_id, project_id, subset_name):
         for subset in subsets:
             if subset["name"] == subset_name:
                 return subset
-
         return None
 
     def create_subset(self, team_id, project_id, subset_name):
@@ -1732,5 +1733,4 @@ def create_subset(self, team_id, project_id, subset_name):
         if not response.ok:
             raise AppException(response.json().get("errors", "undefined"))
 
-
         return response.json()[0]