supervisely 6.73.315__py3-none-any.whl → 6.73.316__py3-none-any.whl

supervisely/api/module_api.py

@@ -625,7 +625,8 @@ class ApiField:
     """"""
     NON_FINAL_VALUE = "nonFinalValue"
     """"""
-
+    HOTKEY = "hotkey"
+    """"""
 
 def _get_single_item(items):
     """_get_single_item"""

supervisely/api/object_class_api.py

@@ -201,3 +201,78 @@ class ObjectClassApi(ModuleApi):
     #     response = self._api.post('videos.tags.bulk.add', {ApiField.VIDEO_ID: video_id, ApiField.TAGS: tags_json})
     #     ids = [obj[ApiField.ID] for obj in response.json()]
     #     return ids
+
+    def update(
+        self,
+        id: int,
+        name: Optional[str] = None,
+        description: Optional[str] = None,
+        hotkey: Optional[str] = None,
+        shape: Optional[str] = None,
+        color: Optional[str] = None,
+        settings: Optional[dict] = None,
+    ) -> NamedTuple:
+        """
+        Update the class with the given ID on the server.
+        Returned object contains updated information about the class except settings.
+
+        :param id: ID of the class to update.
+        :type id: int
+        :param name: New name of the class.
+        :type name: str, optional
+        :param description: New description of the class.
+        :type description: str, optional
+        :param hotkey: New hotkey of the class (e.g., "K").
+        :type hotkey: str, optional
+        :param shape: New shape of the class.
+        :type shape: str, optional
+        :param color: New color of the class in HEX format (e.g., #FFFFFF).
+        :type color: str, optional
+        :param settings: New settings of the class.
+                        Do not pass "availableShapes" for shape other than "any".
+                        Do not pass "availableShapes" that does not contain the current shape.
+        :type settings: dict, optional
+
+        :return: Updated class information
+        :rtype: :class:`ObjectClassInfo<ObjectClassInfo>`
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+
+            obj_class_info = api.object_class.update(
+                id=22309,
+                shape='any',
+                settings={
+                    "availableShapes": [
+                        "bitmap",
+                        "polygon",
+                    ],
+                },
+            )
+        """
+        if all(arg is None for arg in [name, description, hotkey, shape, color, settings]):
+            raise ValueError(
+                f"To update the class with ID: {id}, you must specify at least one parameter to update; all are currently None"
+            )
+
+        data = {ApiField.ID: id}
+        if name is not None:
+            data[ApiField.NAME] = name
+        if description is not None:
+            data[ApiField.DESCRIPTION] = description
+        if hotkey is not None:
+            data[ApiField.HOTKEY] = hotkey
+        if shape is not None:
+            data[ApiField.SHAPE] = shape
+        if color is not None:
+            data[ApiField.COLOR] = color
+        if settings is not None:
+            data[ApiField.SETTINGS] = settings
+
+        response = self._api.post("advanced.object_classes.editInfo", data)
+        return self._convert_json_info(response.json(), skip_missing=True)

{supervisely-6.73.315.dist-info → supervisely-6.73.316.dist-info}/METADATA

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

{supervisely-6.73.315.dist-info → supervisely-6.73.316.dist-info}/RECORD

@@ -32,9 +32,9 @@ supervisely/api/image_api.py,sha256=WIML_6N1qgOWBm3acexmGSWz4hAaSxlYmUtbytROaP8,
 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=EWJh3TGauAOUWuAlK-Ey8s_S4FDMwa6I0snHX6dnhH8,55036
-supervisely/api/module_api.py,sha256=NkDU9gZ0hAHFVnbF26fOOx56QGizyQO23E2kMjKrBWM,44513
+supervisely/api/module_api.py,sha256=GSkB9p4Xz9_HeIC9pFm060fOFeGkUK4M7pgryClrAbE,44545
 supervisely/api/neural_network_api.py,sha256=ktPVRO4Jeulougio8F0mioJJHwRJcX250Djp1wBoQ9c,7620
-supervisely/api/object_class_api.py,sha256=-rQcKwhBw3iL9KNH9c1ROgoimgWM1ls6Wi_tb1R-MzY,7683
+supervisely/api/object_class_api.py,sha256=hBcQuKi9ouoiR7f99eot6vXHvqbzmal3IrHjJxuoFXg,10396
 supervisely/api/plugin_api.py,sha256=TlfrosdRuYG4NUxk92QiQoVaOdztFspPpygyVa3M3zk,5283
 supervisely/api/project_api.py,sha256=WwpwzsQjue2276Rn_wkcPxJAM4OaQr6haf81ZmCGpBI,79992
 supervisely/api/project_class_api.py,sha256=5cyjdGPPb2tpttu5WmYoOxUNiDxqiojschkhZumF0KM,1426
@@ -1075,9 +1075,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.315.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-supervisely-6.73.315.dist-info/METADATA,sha256=FgW6GD5UxnnvJGHRPPUQTLUj4Oc-gXyh7tZbGw2E4uE,33596
-supervisely-6.73.315.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-supervisely-6.73.315.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
-supervisely-6.73.315.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
-supervisely-6.73.315.dist-info/RECORD,,
+supervisely-6.73.316.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+supervisely-6.73.316.dist-info/METADATA,sha256=1Bzkm7rcu6QQawRicf_xyPpgsgcqefhLyRDC4Kd6zXw,33596
+supervisely-6.73.316.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+supervisely-6.73.316.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
+supervisely-6.73.316.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
+supervisely-6.73.316.dist-info/RECORD,,