supervisely 6.73.259__py3-none-any.whl → 6.73.260__py3-none-any.whl

supervisely/annotation/tag_meta.py

@@ -2,12 +2,14 @@
 """General information about :class:`Tag<supervisely.annotation.tag.Tag>`"""
 
 from __future__ import annotations
-from typing import List, Optional, Dict
+
 from copy import deepcopy
-from supervisely.imaging.color import random_rgb, rgb2hex, hex2rgb, _validate_color
-from supervisely.io.json import JsonSerializable
-from supervisely.collection.key_indexed_collection import KeyObject
+from typing import Dict, List, Optional
+
 from supervisely._utils import take_with_default
+from supervisely.collection.key_indexed_collection import KeyObject
+from supervisely.imaging.color import _validate_color, hex2rgb, random_rgb, rgb2hex
+from supervisely.io.json import JsonSerializable
 
 
 class TagValueType:
@@ -47,6 +49,7 @@ class TagMetaJsonFields:
     """"""
     APPLICABLE_CLASSES = "classes"
     """"""
+    TARGET_TYPE = "target_type"  # "Scope"
 
 
 class TagApplicableTo:
@@ -62,6 +65,19 @@ class TagApplicableTo:
     """"""
 
 
+class TagTargetType:
+    """
+    Defines Tag target type (scope) - entities, frames or both.
+    """
+
+    ALL = "all"  # both entities and frames
+    """"""
+    FRAME_BASED = "framesOnly"
+    """"""
+    GLOBAL = "entitiesOnly"
+    """"""
+
+
 SUPPORTED_TAG_VALUE_TYPES = [
     TagValueType.NONE,
     TagValueType.ANY_NUMBER,
@@ -74,6 +90,12 @@ SUPPORTED_APPLICABLE_TO = [
     TagApplicableTo.OBJECTS_ONLY,
 ]
 
+SUPPORTED_TARGET_TYPES = [
+    TagTargetType.ALL,
+    TagTargetType.FRAME_BASED,
+    TagTargetType.GLOBAL,
+]
+
 
 class TagMeta(KeyObject, JsonSerializable):
     """
@@ -95,6 +117,8 @@ class TagMeta(KeyObject, JsonSerializable):
     :type applicable_to: str, optional
     :param applicable_classes: Defines applicability of Tag only to certain classes.
     :type applicable_classes: List[str], optional
+    :param target_type: Defines Tag target type (scope) - entities, frames or both.
+    :type target_type: str, optional
     :raises: :class:`ValueError`, if color is not list, or doesn't have exactly 3 values
     :Usage example:
 
@@ -128,6 +152,7 @@ class TagMeta(KeyObject, JsonSerializable):
         hotkey: Optional[str] = None,
         applicable_to: Optional[str] = None,
         applicable_classes: Optional[List[str]] = None,
+        target_type: Optional[str] = None,
     ):
         if value_type not in SUPPORTED_TAG_VALUE_TYPES:
             raise ValueError(
@@ -144,12 +169,20 @@ class TagMeta(KeyObject, JsonSerializable):
         self._hotkey = take_with_default(hotkey, "")
         self._applicable_to = take_with_default(applicable_to, TagApplicableTo.ALL)
         self._applicable_classes = take_with_default(applicable_classes, [])
+        self._target_type = take_with_default(target_type, TagTargetType.ALL)
         if self._applicable_to not in SUPPORTED_APPLICABLE_TO:
             raise ValueError(
                 "applicable_to = {!r} is unknown, should be one of {}".format(
                     self._applicable_to, SUPPORTED_APPLICABLE_TO
                 )
             )
+        
+        if self._target_type not in SUPPORTED_TARGET_TYPES:
+            raise ValueError(
+                "target_type = {!r} is unknown, should be one of {}".format(
+                    self._target_type, SUPPORTED_TARGET_TYPES
+                )
+            )
 
         if self._value_type == TagValueType.ONEOF_STRING:
             if self._possible_values is None:
@@ -329,6 +362,24 @@ class TagMeta(KeyObject, JsonSerializable):
             # Output: ['car', 'bicycle']
         """
         return self._applicable_classes
+    
+    @property
+    def target_type(self) -> str:
+        """
+        Tag target type (scope) - entities, frames or both.
+
+        :return: Target type
+        :rtype: :class:`str`
+        :Usage example:
+
+         .. code-block:: python
+
+            meta_dog = sly.TagMeta('dog', sly.TagValueType.NONE, target_type=TagTargetType.FRAME_BASED)
+
+            print(meta_dog.target_type)
+            # Output: 'framesOnly'
+        """
+        return self._target_type
 
     def to_json(self) -> Dict:
         """
@@ -390,6 +441,8 @@ class TagMeta(KeyObject, JsonSerializable):
             jdict[TagMetaJsonFields.APPLICABLE_TYPE] = self.applicable_to
         if self._applicable_classes is not None:
             jdict[TagMetaJsonFields.APPLICABLE_CLASSES] = self.applicable_classes
+        if self._target_type is not None:
+            jdict[TagMetaJsonFields.TARGET_TYPE] = self.target_type
 
         return jdict
 
@@ -445,6 +498,7 @@ class TagMeta(KeyObject, JsonSerializable):
             hotkey = data.get(TagMetaJsonFields.HOTKEY, "")
             applicable_to = data.get(TagMetaJsonFields.APPLICABLE_TYPE, TagApplicableTo.ALL)
             applicable_classes = data.get(TagMetaJsonFields.APPLICABLE_CLASSES, [])
+            target_type = data.get(TagMetaJsonFields.TARGET_TYPE, TagTargetType.ALL)
 
             return cls(
                 name=name,
@@ -455,6 +509,7 @@ class TagMeta(KeyObject, JsonSerializable):
                 hotkey=hotkey,
                 applicable_to=applicable_to,
                 applicable_classes=applicable_classes,
+                target_type=target_type,
             )
         else:
             raise ValueError("Tags must be dict or str types.")
@@ -632,6 +687,7 @@ class TagMeta(KeyObject, JsonSerializable):
         hotkey: Optional[str] = None,
         applicable_to: Optional[str] = None,
         applicable_classes: Optional[List[str]] = None,
+        target_type: Optional[str] = None,
     ) -> TagMeta:
         """
         Clone makes a copy of TagMeta with new fields, if fields are given, otherwise it will use original TagMeta fields.
@@ -683,6 +739,7 @@ class TagMeta(KeyObject, JsonSerializable):
             hotkey=take_with_default(hotkey, self.hotkey),
             applicable_to=take_with_default(applicable_to, self.applicable_to),
             applicable_classes=take_with_default(applicable_classes, self.applicable_classes),
+            target_type=take_with_default(target_type, self.target_type),
         )
 
     def __str__(self):
@@ -713,6 +770,7 @@ class TagMeta(KeyObject, JsonSerializable):
             "Hotkey",
             "Applicable to",
             "Applicable classes",
+            "Target type",
         ]
 
     def get_row_ptable(self):
@@ -724,6 +782,7 @@ class TagMeta(KeyObject, JsonSerializable):
             self.hotkey,
             self.applicable_to,
             self.applicable_classes,
+            self.target_type,
         ]
 
     def _set_id(self, id: int):

{supervisely-6.73.259.dist-info → supervisely-6.73.260.dist-info}/METADATA

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

{supervisely-6.73.259.dist-info → supervisely-6.73.260.dist-info}/RECORD

@@ -15,7 +15,7 @@ supervisely/annotation/obj_class_mapper.py,sha256=aIJDoRULqcAOD2a1CQPk2OOF8k3VPP
 supervisely/annotation/renamer.py,sha256=rVvNLtpfd1kKUVPgm8VlLmYSDByWjriJ92FobC4buqY,1944
 supervisely/annotation/tag.py,sha256=m_sPgrr_ZW8HuiK7Fr2-WnHwKwez1WZtGrcdZN2DZuQ,17598
 supervisely/annotation/tag_collection.py,sha256=MVPTzer9rLpD4O0g2XhYFUheK7-ILgwAXDJd1em3kZ8,10015
-supervisely/annotation/tag_meta.py,sha256=7r89qe4UOiI3BQ3TVGrz4kpcrVpteTpFc9-CuiYk3WQ,25759
+supervisely/annotation/tag_meta.py,sha256=2UkgRSMuQ7LXH48Ok2bJNdlK-miX54wXYAoB_as9_a0,27543
 supervisely/annotation/tag_meta_collection.py,sha256=JY2wAo4dF47UylYeglkJtRtpVOArGjf3dXeEYIHFWP0,14491
 supervisely/annotation/tag_meta_mapper.py,sha256=RWeTrxJ64syodyhXIRSH007bX6Hr3B45tG14YTcpwSU,1639
 supervisely/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -1057,9 +1057,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.259.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-supervisely-6.73.259.dist-info/METADATA,sha256=HIPNQSEj3JiqMJTUJwVoxBUSorGAhnvQ4tXlf1e0Xhk,33573
-supervisely-6.73.259.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-supervisely-6.73.259.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
-supervisely-6.73.259.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
-supervisely-6.73.259.dist-info/RECORD,,
+supervisely-6.73.260.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+supervisely-6.73.260.dist-info/METADATA,sha256=CPwcqKvIAjMyeGM6DRLQKHF3owWEcixltIqVe4T0x-E,33573
+supervisely-6.73.260.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+supervisely-6.73.260.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
+supervisely-6.73.260.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
+supervisely-6.73.260.dist-info/RECORD,,