supervisely 6.73.217__py3-none-any.whl → 6.73.218__py3-none-any.whl

supervisely/api/image_api.py

@@ -2629,7 +2629,7 @@ class ImageApi(RemoveableBulkModuleApi):
         """
         return resize_image_url(url, ext, method, width, height, quality)
 
-    def update_meta(self, id: int, meta: Dict) -> Dict:
+    def update_meta(self, id: int, meta: Dict) -> Dict[str, Any]:
         """
         It is possible to add custom JSON data to every image for storing some additional information.
         Updates Image metadata by ID. Metadata is visible in Labeling Tool.
@@ -2669,10 +2669,93 @@ class ImageApi(RemoveableBulkModuleApi):
             #     "Focal Length": "16 mm"
             # }
         """
-        if type(meta) is not dict:
-            raise TypeError("Meta must be dict, not {}".format(type(meta)))
-        response = self._api.post("images.editInfo", {ApiField.ID: id, ApiField.META: meta})
-        return response.json()
+        return self.edit(id=id, meta=meta, return_json=True)
+
+    def edit(
+        self,
+        id: int,
+        name: Optional[str] = None,
+        description: Optional[str] = None,
+        meta: Optional[Dict] = None,
+        return_json: bool = False,
+    ) -> Union[ImageInfo, Dict[str, Any]]:
+        """Updates the information about the image by given ID with provided parameters.
+        At least one parameter must be set, otherwise ValueError will be raised.
+
+        :param id: Image ID in Supervisely.
+        :type id: int
+        :param name: New Image name.
+        :type name: str, optional
+        :param description: New Image description.
+        :type description: str, optional
+        :param meta: New Image metadata.
+        :type meta: dict, optional
+        :return_json: If True, return response in JSON format, otherwise convert it ImageInfo object.
+            This parameter is only added for backward compatibility for update_meta method.
+            It's not recommended to use it in new code.
+        :type return_json: bool, optional
+        :raises: :class:`ValueError` if at least one parameter is not set
+        :raises: :class:`ValueError if meta parameter was set and it is not a dictionary
+        :return: Information about updated image as ImageInfo object or as dict if return_json is True
+        :rtype: :class:`ImageInfo` or :class:`dict`
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+
+            image_id = 123456
+            new_image_name = "IMG_3333_new.jpg"
+
+            api.image.edit(id=image_id, name=new_image_name)
+        """
+        if name is None and description is None and meta is None:
+            raise ValueError("At least one parameter must be set")
+
+        if meta is not None and not isinstance(meta, dict):
+            raise ValueError("meta parameter must be a dictionary")
+
+        data = {
+            ApiField.ID: id,
+            ApiField.NAME: name,
+            ApiField.DESCRIPTION: description,
+            ApiField.META: meta,
+        }
+        data = {k: v for k, v in data.items() if v is not None}
+
+        response = self._api.post("images.editInfo", data)
+        if return_json:
+            return response.json()
+        return self._convert_json_info(response.json(), skip_missing=True)
+
+    def rename(self, id: int, name: str) -> ImageInfo:
+        """
+        Renames Image with given ID.
+
+        :param id: Image ID in Supervisely.
+        :type id: int
+        :param name: New Image name.
+        :type name: str
+        :return: Information about updated Image.
+        :rtype: :class:`ImageInfo`
+        :Usage example:
+
+         .. code-block:: python
+
+            import supervisely as sly
+
+            os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
+            os.environ['API_TOKEN'] = 'Your Supervisely API Token'
+            api = sly.Api.from_env()
+
+            image_id = 376729
+            new_image_name = 'new_image_name.jpg'
+            img_info = api.image.rename(image_id, new_image_name)
+        """
+        return self.edit(id=id, name=name)
 
     def add_tag(self, image_id: int, tag_id: int, value: Optional[Union[str, int]] = None) -> None:
         """

{supervisely-6.73.217.dist-info → supervisely-6.73.218.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: supervisely
-Version: 6.73.217
+Version: 6.73.218
 Summary: Supervisely Python SDK.
 Home-page: https://github.com/supervisely/supervisely
 Author: Supervisely

{supervisely-6.73.217.dist-info → supervisely-6.73.218.dist-info}/RECORD

@@ -28,7 +28,7 @@ supervisely/api/dataset_api.py,sha256=7iwAyz3pmzFG2i072gLdXjczfBGbyj-V_rRl7Tx-V3
 supervisely/api/file_api.py,sha256=y8FkE-vx1382cbhNo_rTZs7SobrkxmYQAe79CpvStO4,54279
 supervisely/api/github_api.py,sha256=NIexNjEer9H5rf5sw2LEZd7C1WR-tK4t6IZzsgeAAwQ,623
 supervisely/api/image_annotation_tool_api.py,sha256=YcUo78jRDBJYvIjrd-Y6FJAasLta54nnxhyaGyanovA,5237
-supervisely/api/image_api.py,sha256=TALfxJoBf6xYJs_UKuX7nNt6WNADsAHso2r8cffSm3o,135794
+supervisely/api/image_api.py,sha256=wnzoCbD5vV8f8joBQsNCbRjoG0jhyAXHe1ZM8YhbCsc,138727
 supervisely/api/import_storage_api.py,sha256=BDCgmR0Hv6OoiRHLCVPKt3iDxSVlQp1WrnKhAK_Zl84,460
 supervisely/api/issues_api.py,sha256=BqDJXmNoTzwc3xe6_-mA7FDFC5QQ-ahGbXk_HmpkSeQ,17925
 supervisely/api/labeling_job_api.py,sha256=odnzZjp29yM16Gq-FYkv-OA4WFMNJCLFo4qSikW2A7c,56280
@@ -997,9 +997,9 @@ supervisely/worker_proto/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 supervisely/worker_proto/worker_api_pb2.py,sha256=VQfi5JRBHs2pFCK1snec3JECgGnua3Xjqw_-b3aFxuM,59142
 supervisely/worker_proto/worker_api_pb2_grpc.py,sha256=3BwQXOaP9qpdi0Dt9EKG--Lm8KGN0C5AgmUfRv77_Jk,28940
 supervisely_lib/__init__.py,sha256=7-3QnN8Zf0wj8NCr2oJmqoQWMKKPKTECvjH9pd2S5vY,159
-supervisely-6.73.217.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-supervisely-6.73.217.dist-info/METADATA,sha256=J-MzogOhMEtif7Ihw4DFhpeMKhRlY18L34Djs1DCE80,33090
-supervisely-6.73.217.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-supervisely-6.73.217.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
-supervisely-6.73.217.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
-supervisely-6.73.217.dist-info/RECORD,,
+supervisely-6.73.218.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+supervisely-6.73.218.dist-info/METADATA,sha256=EnGwT_zAqgvOytZQYfG8Cc6sTL3MniXkWeNgG-TXZP4,33090
+supervisely-6.73.218.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+supervisely-6.73.218.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
+supervisely-6.73.218.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
+supervisely-6.73.218.dist-info/RECORD,,

{supervisely-6.73.217.dist-info → supervisely-6.73.218.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.2.0)
+Generator: setuptools (75.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any