Docs update

Author: VaghinakDev

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

@@ -3632,13 +3632,12 @@ def item_context(
         overwrite: bool = True,
     ) -> ItemContext:
         """
-        Creates an `ItemContext` instance for managing item annotations and metadata.
+        Creates an “ItemContext” for managing item annotations and metadata.
 
-        The function retrieves the specified project and folder based on the given `path`
-        (can be a string path or a tuple of project and folder names/IDs) and locates the
-        item by name or ID. It then returns an `ItemContext` object to handle the annotations
-        of the specified item. Changes to annotations are automatically saved upon exiting
-        the context.
+        This function allows you to manage annotations and metadata for an item located within a
+        specified project and folder. The path to the item can be provided either as a string or a tuple,
+        and you can specify the item using its name or ID.
+        It returns an “ItemContext” that automatically saves any changes to annotations when the context is exited.
 
         :param path: Specifies the project and folder containing the item. Can be one of:
             - A string path, e.g., "project_name/folder_name".
@@ -3649,7 +3648,7 @@ def item_context(
         :param item: The name or ID of the item for which the context is being created.
         :type item: Union[str, int]
 
-        :param overwrite: If `True`, annotations are overwritten during saving. Defaults to `True`.
+        :param overwrite: If `True`, annotations are overwritten during saving. Defaults is `True`.
             If `False`, raises a `FileChangedError` if the item was modified concurrently.
         :type overwrite: bool
 
@@ -3680,20 +3679,23 @@ def item_context(
         Create an `ItemContext` using a tuple of IDs and an item name:
 
         .. code-block:: python
+
             with client.item_context((101, 202), "item_name") as context:
                 value = context.get_component_value("component_id")
                 print(value)
 
         Save annotations automatically after modifying component values:
 
         .. code-block:: python
+
             with client.item_context("project_name/folder_name", "item_name", overwrite=True) as context:
                 context.set_component_value("component_id", "new_value")
             # No need to call .save(), changes are saved automatically on context exit.
 
         Handle exceptions during context execution:
 
         .. code-block:: python
+
             from superannotate import FileChangedError
 
             try:

tests/integration/items/test_item_context.py

@@ -48,48 +48,43 @@ def _attach_item(path, name):
 
     def _base_test(self, path, item):
         with sa.item_context(path, item, overwrite=True) as ic:
-            print(1111111)
             ic.set_component_value("component_id_1", None)
         with sa.item_context(path, item, overwrite=False) as ic:
-            print(222222)
             assert ic.get_component_value("component_id_1") is None
-            print(333333)
             ic.set_component_value("component_id_1", "value")
         with self.assertRaisesRegexp(
             FileChangedError, "The file has changed and overwrite is set to False."
         ):
             with sa.item_context(path, item, overwrite=False) as ic:
-                print(4444444)
                 assert ic.get_component_value("component_id_1") == "value"
                 sa.item_context(path, item, overwrite=True).set_component_value(
                     "component_id_1", "to crash"
                 ).save()
-                print(555555)
                 ic.set_component_value("component_id_1", "value")
 
     def test_overwrite_false(self):
         # test root by folder name
         self._attach_item(self.PROJECT_NAME, "dummy")
         time.sleep(2)
         self._base_test(self.PROJECT_NAME, "dummy")
-        #
-        # folder = sa.create_folder(self.PROJECT_NAME, folder_name="folder")
-        # # test from folder by project and folder names
-        # time.sleep(2)
-        # path = f"{self.PROJECT_NAME}/folder"
-        # self._attach_item(path, "dummy")
-        # self._base_test(path, "dummy")
-        #
-        # # test from folder by project and folder names as tuple
-        # path = (self.PROJECT_NAME, 'folder')
-        # self._base_test(path, "dummy")
-        #
-        # # test from folder by project and folder ids as tuple item name as dict
-        # self._base_test((self._project['id'], folder['id']), "dummy")
-        #
-        # # test from folder by project and folder ids as tuple and item id
-        # item = sa.search_items(f"{self.PROJECT_NAME}/folder", "dummy")[0]
-        # self._base_test((self._project['id'], folder['id']), item['id'])
+
+        folder = sa.create_folder(self.PROJECT_NAME, folder_name="folder")
+        # test from folder by project and folder names
+        time.sleep(2)
+        path = f"{self.PROJECT_NAME}/folder"
+        self._attach_item(path, "dummy")
+        self._base_test(path, "dummy")
+
+        # test from folder by project and folder names as tuple
+        path = (self.PROJECT_NAME, "folder")
+        self._base_test(path, "dummy")
+
+        # test from folder by project and folder ids as tuple item name as dict
+        self._base_test((self._project["id"], folder["id"]), "dummy")
+
+        # test from folder by project and folder ids as tuple and item id
+        item = sa.search_items(f"{self.PROJECT_NAME}/folder", "dummy")[0]
+        self._base_test((self._project["id"], folder["id"]), item["id"])
 
 
 def test_():