tbapi.common.descriptors

  1from typing import TypeVar, Generic, Optional, Callable, Any, Dict, Final
  2from dataclasses import dataclass
  3from enum import Enum, IntFlag
  4from tbapi.common.converters import *
  5from tbapi.common.arguments import SerializableArgument
  6from typing import get_args, get_origin
  7import clr
  8import json
  9
 10
 11class NumericRange(SerializableArgument):
 12    """
 13    Specifies the numeric range constraints for a parameter.
 14
 15    Attributes:
 16        min_value: The minimum value of the numeric range. Default is 0.
 17        max_value: The maximum value of the numeric range. Default is inf.
 18        step: The step value for incrementing within the range. Default is 1.
 19    """
 20
 21    def __init__(self, min_value: float = 0, max_value: float = 999999, step: float = 1):
 22        self.min_value = min_value
 23        self.max_value = max_value
 24        self.step = step
 25        self.attribute_name = "NumericRange"
 26        super().__init__()
 27
 28    @classmethod
 29    def new(cls, min_value: float = 0, max_value: float = 999999, step: float = 1):
 30        return cls(min_value, max_value, step)
 31
 32
 33T = TypeVar("T")
 34
 35
 36class TbDescriptorBase(Generic[T], SerializableArgument):
 37    """Base descriptor for internal use only."""
 38
 39    def __init__(self, name: str) -> None:
 40        self.property_name: str = name
 41        self._clr_name: Optional[str] = None
 42        self.py_type: Optional[type] = None
 43        super().__init__()
 44
 45    def __set_name__(self, owner: type, name: str) -> None:
 46        self._clr_name = "".join(part.capitalize() for part in name.split("_"))
 47        annots = getattr(owner, "__annotations__", {})
 48
 49        if name in annots:
 50            self.py_type = annots[name]
 51
 52        if self.py_type is None:
 53            if hasattr(self, "__orig_class__"):
 54                args = get_args(self.__orig_class__)
 55                if args:
 56                    self.py_type = args[0]
 57
 58        self.property_type = self.get_full_type_name()
 59
 60    def __get__(self, obj: Any, objtype: Optional[type] = None) -> Optional[T]:
 61        if obj is None:
 62            return self
 63
 64        value_obj = getattr(obj, "_value", None)
 65        if value_obj is None:
 66            return None
 67
 68        raw_value = getattr(value_obj, self._clr_name)
 69
 70        if issubclass(self.py_type, Enum) or issubclass(self.py_type, IntFlag):
 71            return self.py_type(int(raw_value))
 72
 73        if self.py_type is not None and hasattr(self.py_type, "_value") and hasattr(self.py_type, "__tb_decorated__"):
 74            return self.py_type(_existing=raw_value)
 75
 76        return raw_value
 77
 78    def __set__(self, obj: Any, val: T) -> None:
 79        value_obj: Any = getattr(obj, "_value", None)
 80        if value_obj is None:
 81            raise AttributeError("_value not initialized on the wrapper instance")
 82
 83        if self.py_type is not None and hasattr(val, "_value") and hasattr(val, "__tb_decorated__"):
 84            setattr(value_obj, self._clr_name, val._value)
 85        else:
 86            if isinstance(val, (Enum, IntFlag)):
 87                setattr(value_obj, self._clr_name, get_origin_enum(val, val))
 88            else:
 89                setattr(value_obj, self._clr_name, val)
 90
 91    def get_full_type_name(self) -> str:
 92        """
 93        Returns the full type name of the parameter (module + class).
 94        For internal use only
 95        """
 96        if hasattr(self, "py_type") and self.py_type is not None:
 97            py_type = self.py_type
 98            module = getattr(py_type, "__module__", "UnknownModule")
 99            name = getattr(py_type, "__name__", "UnknownType")
100            if module == "builtins":
101                return name
102            return f"{module}.{name}"
103
104        if hasattr(self, "__orig_class__") and self.__orig_class__ is not None:
105            s = str(self.__orig_class__)
106            start = s.find("[")
107            end = s.find("]")
108            if start >= 0 and end > start:
109                return s[start + 1:end]
110
111        return "Unknown"
112
113    @clr.clrmethod(None, [str])
114    def to_json(self) -> str:
115        return json.dumps(
116            self.encode() if isinstance(self, SerializableArgument) else str(self),
117            indent=4,
118            default=lambda o: (
119                o.encode() if isinstance(o, SerializableArgument) else
120                (o.__name__ if isinstance(o, type) else str(o))
121            )
122        )
123
124
125class ScriptParameter(TbDescriptorBase[T]):
126    """
127    Specifies metadata for a parameter property.
128
129    Attributes:
130        name: The display name of the parameter.
131        group_name: Group name of the parameter (optional).
132        description: Description of the parameter (optional).
133        order: Order of the parameter (optional).
134        show_in_signature: Indicates whether the parameter is shown in the script signature.
135        numeric_range: The numeric range constraints for a parameter.
136    """
137
138    def __init__(
139            self,
140            name: str,
141            group_name: Optional[str] = None,
142            description: Optional[str] = None,
143            order: Optional[int] = None,
144            show_in_signature: Optional[bool] = None,
145            numeric_range : Optional[NumericRange] = None,
146    ) -> None:
147        super().__init__(name)
148        self.group_name = group_name
149        self.description = description
150        self.order = order
151        self.show_in_signature = show_in_signature
152        self.numeric_range = numeric_range
153        self.attribute_name = "ScriptParameter"
154        self.parameter_name = name
155
156
157class Plot(TbDescriptorBase[T]):
158    """
159    Specifies metadata for a Plot property.
160
161    Attributes:
162        name: The display name of the plot.
163    """
164
165    def __init__(self, name: str) -> None:
166        super().__init__(name)
167        self.attribute_name  = "Plot"
168        self.plot_name = name
169
170class Source(TbDescriptorBase[T]):
171    """
172    Specifies metadata for a Source property.
173    """
174
175    def __init__(self, name: str = "Source") -> None:
176        super().__init__(name)
177        self.attribute_name  = "Source"
178        self.source_name = name