tango-frame 0.1.1__py3-none-any.whl

tango_frame/__init__.py

@@ -0,0 +1,8 @@
+from .auto_dispatch import AutoDispatchClient, AutoDispatchDevice
+from .server import run_device_server
+
+__all__ = [
+    "AutoDispatchClient",
+    "AutoDispatchDevice",
+    "run_device_server",
+]

tango_frame/auto_dispatch.py

@@ -0,0 +1,379 @@
+"""Automatic adaptation between ordinary Python classes and TANGO devices."""
+
+from types import MethodType
+from typing import Any, Dict, Optional, Set, Type
+
+from tango import AttrWriteType, DevState
+from tango.server import Device, attribute, command
+
+from .codec import pack_call, pack_value, unpack_call, unpack_value
+from .config import Config
+from .introspection import PropertySpec, public_methods, public_properties
+from .type_mapping import (
+    input_type,
+    output_type,
+    tango_value_type,
+    uses_encoded_input,
+    uses_encoded_output,
+)
+
+
+class AutoDispatchDevice(Device):
+    """Expose an ordinary Python device class as a TANGO device server.
+
+    Subclasses set ``device_class`` to the transport-independent Python class.
+    Public methods become TANGO commands and public properties become TANGO
+    attributes.
+    """
+
+    device_class = None  # type: Optional[Type[Any]]
+    excluded_commands = set()  # type: Set[str]
+
+    def init_device(self) -> None:
+        """Create the local Python device object when TANGO initializes it.
+
+        Raises:
+            RuntimeError: If no Python device class has been configured.
+        """
+        Device.init_device(self)
+        if self.device_class is None:
+            raise RuntimeError("device_class is not configured")
+
+        # The authoritative local device class is reconstructed inside the
+        # TANGO device server process.
+        self._device_object = self.device_class()
+        self.set_state(DevState.ON)
+
+    def delete_device(self) -> None:
+        """Release the wrapped Python device object when available."""
+        device_object = getattr(self, "_device_object", None)
+        if device_object is not None:
+            release = getattr(device_object, "release", None)
+            if callable(release):
+                release()
+
+    def initialize_dynamic_attributes(self) -> None:
+        """Install TANGO commands and attributes from the Python class.
+
+        Raises:
+            RuntimeError: If no Python device class has been configured.
+        """
+        if self.device_class is None:
+            raise RuntimeError("device_class is not configured")
+
+        _install_commands(self, self.device_class)
+        _install_attributes(self, self.device_class)
+
+
+def _command_handler(
+    name: str,
+    has_input: bool,
+    encoded_input: bool,
+    encoded_output: bool,
+) -> Any:
+    """Build a dynamic TANGO command handler.
+
+    Args:
+        name: Python method and TANGO command name.
+        has_input: Whether the command accepts a TANGO input value.
+        encoded_input: Whether the input uses the JSON call envelope.
+        encoded_output: Whether the result uses JSON value encoding.
+
+    Returns:
+        Unbound handler function ready to bind to a device instance.
+    """
+    if not has_input:
+        def handler(device_self: AutoDispatchDevice) -> Any:
+            """Dispatch a command without TANGO input."""
+            target = getattr(device_self._device_object, name)
+            result = target()
+            if encoded_output:
+                return pack_value(result)
+            return result
+    else:
+        def handler(device_self: AutoDispatchDevice, value: Any) -> Any:
+            """Dispatch a command with native or encoded TANGO input."""
+            target = getattr(device_self._device_object, name)
+            if encoded_input:
+                args, kwargs = unpack_call(value)
+                result = target(*args, **kwargs)
+            else:
+                result = target(value)
+            if encoded_output:
+                return pack_value(result)
+            return result
+
+    handler.__name__ = name
+    return handler
+
+
+def _install_commands(device: AutoDispatchDevice, device_class: Type[Any]) -> None:
+    """Install public Python methods as dynamic TANGO commands.
+
+    Args:
+        device: Running PyTango device instance.
+        device_class: Ordinary Python device class being exposed.
+    """
+    for spec in public_methods(device_class):
+        if spec.name in device.excluded_commands:
+            continue
+
+        parameters = list(spec.signature.parameters.values())
+        has_input = len(parameters) != 0
+        encoded_input = uses_encoded_input(spec.signature)
+        encoded_output = uses_encoded_output(spec.signature)
+        handler = _command_handler(
+            spec.name,
+            has_input,
+            encoded_input,
+            encoded_output,
+        )
+
+        # add_command() installs the supplied callable on this device instance.
+        # Bind the generated method explicitly before creating the command.
+        bound_handler = MethodType(handler, device)
+        tango_command = command(
+            bound_handler,
+            dtype_in=input_type(spec.signature),
+            dtype_out=output_type(spec.signature),
+        )
+        device.add_command(tango_command, device_level=True)
+
+
+def _property_reader(name: str, encoded: bool) -> Any:
+    """Build a dynamic TANGO attribute reader.
+
+    Args:
+        name: Python property and TANGO attribute name.
+        encoded: Whether the value uses JSON encoding.
+
+    Returns:
+        Unbound attribute reader.
+    """
+    def reader(device_self: AutoDispatchDevice, attr: Any) -> Any:
+        """Read a wrapped Python property."""
+        value = getattr(device_self._device_object, name)
+        if encoded:
+            return pack_value(value)
+        return value
+
+    reader.__name__ = "read_" + name
+    return reader
+
+
+def _property_writer(name: str, encoded: bool) -> Any:
+    """Build a dynamic TANGO attribute writer.
+
+    Args:
+        name: Python property and TANGO attribute name.
+        encoded: Whether the value uses JSON encoding.
+
+    Returns:
+        Unbound attribute writer.
+    """
+    def writer(device_self: AutoDispatchDevice, attr: Any) -> None:
+        """Write a wrapped Python property."""
+        value = attr.get_write_value()
+        if encoded:
+            value = unpack_value(value)
+        setattr(device_self._device_object, name, value)
+
+    writer.__name__ = "write_" + name
+    return writer
+
+
+def _install_attributes(device: AutoDispatchDevice, device_class: Type[Any]) -> None:
+    """Install public Python properties as dynamic TANGO attributes.
+
+    Args:
+        device: Running PyTango device instance.
+        device_class: Ordinary Python device class being exposed.
+    """
+    for spec in public_properties(device_class):
+        dtype = tango_value_type(spec.annotation)
+        encoded = dtype is None
+        if encoded:
+            dtype = str
+
+        access = AttrWriteType.READ
+        if spec.writable:
+            access = AttrWriteType.READ_WRITE
+
+        reader = MethodType(_property_reader(spec.name, encoded), device)
+        kwargs = {
+            "name": spec.name,
+            "dtype": dtype,
+            "access": access,
+            "fget": reader,
+        }
+
+        if spec.writable:
+            writer = MethodType(_property_writer(spec.name, encoded), device)
+            kwargs["fset"] = writer
+
+        tango_attribute = attribute(**kwargs)
+        device.add_attribute(tango_attribute)
+
+
+class AutoDispatchClient(object):
+    """Reconstruct a Python device API over a TANGO connection.
+
+    ``device_class`` defines the local Python interface.  The remote TANGO
+    device may be generated by this framework or independently implemented, as
+    long as its commands and attributes match that interface.
+    """
+
+    device_class = None  # type: Optional[Type[Any]]
+    config = None  # type: Optional[Config]
+
+    def __init__(self, config: Optional[Config] = None) -> None:
+        """Create a reconstructed client for a TANGO device.
+
+        Args:
+            config: Connection configuration.  If omitted, the class-level
+                ``config`` value is used.
+
+        Raises:
+            RuntimeError: If ``device_class`` or connection configuration is
+                missing.
+        """
+        from .client import TangoTransport
+
+        if self.device_class is None:
+            raise RuntimeError("device_class is not configured")
+
+        selected_config = config
+        if selected_config is None:
+            selected_config = type(self).config
+        if selected_config is None:
+            raise RuntimeError("config is not configured")
+
+        object.__setattr__(self, "_config", selected_config)
+        object.__setattr__(self, "_transport", TangoTransport(selected_config))
+
+        property_specs = {}  # type: Dict[str, PropertySpec]
+        for item in public_properties(self.device_class):
+            property_specs[item.name] = item
+        object.__setattr__(self, "_property_specs", property_specs)
+        _install_client_methods(self)
+
+    def __getattr__(self, name: str) -> Any:
+        """Read a reconstructed Python property through TANGO.
+
+        Args:
+            name: Python property name.
+
+        Returns:
+            Remote attribute value.
+
+        Raises:
+            AttributeError: If the name is not a reconstructed property.
+        """
+        specs = object.__getattribute__(self, "_property_specs")
+        if name in specs:
+            spec = specs[name]
+            encoded = tango_value_type(spec.annotation) is None
+            value = self._transport.read_attribute(name)
+            if encoded:
+                return unpack_value(value)
+            return value
+        raise AttributeError(name)
+
+    def __setattr__(self, name: str, value: Any) -> None:
+        """Write a reconstructed Python property through TANGO.
+
+        Args:
+            name: Python property name.
+            value: Value to assign.
+
+        Raises:
+            AttributeError: If a reconstructed property is read-only.
+        """
+        if name.startswith("_"):
+            object.__setattr__(self, name, value)
+            return
+
+        specs = object.__getattribute__(self, "_property_specs")
+        if name in specs:
+            spec = specs[name]
+            if not spec.writable:
+                raise AttributeError("read-only property: " + name)
+
+            encoded = tango_value_type(spec.annotation) is None
+            if encoded:
+                value = pack_value(value)
+
+            self._transport.write_attribute(name, value)
+            return
+
+        object.__setattr__(self, name, value)
+
+    @property
+    def tango_config(self) -> Config:
+        """Return the TANGO connection configuration.
+
+        Returns:
+            Configuration used by this reconstructed client.
+        """
+        return object.__getattribute__(self, "_config")
+
+
+def _client_method(name: str, signature: Any) -> Any:
+    """Build a client method that dispatches a TANGO command.
+
+    Args:
+        name: Python method and TANGO command name.
+        signature: Original Python method signature without ``self``.
+
+    Returns:
+        Unbound client method ready to bind to a client instance.
+    """
+    encoded_input = uses_encoded_input(signature)
+    encoded_output = uses_encoded_output(signature)
+
+    def method(
+        client_self: AutoDispatchClient,
+        *args: Any,
+        **kwargs: Any
+    ) -> Any:
+        """Dispatch one reconstructed Python method through TANGO."""
+        if encoded_input:
+            value = pack_call(tuple(args), dict(kwargs))
+            result = client_self._transport.command(name, value)
+        else:
+            parameters = list(signature.parameters.values())
+            if len(parameters) == 0:
+                result = client_self._transport.command(name)
+            else:
+                bound = signature.bind(*args, **kwargs)
+                bound.apply_defaults()
+                value = next(iter(bound.arguments.values()))
+                result = client_self._transport.command(name, value)
+
+        if encoded_output:
+            return unpack_value(result)
+        return result
+
+    method.__name__ = name
+    method.__signature__ = signature
+    return method
+
+
+def _install_client_methods(client: AutoDispatchClient) -> None:
+    """Install reconstructed remote methods on one client instance.
+
+    Args:
+        client: Auto-dispatch client instance.
+    """
+    client_class = type(client)
+    if client.device_class is None:
+        raise RuntimeError("device_class is not configured")
+
+    for spec in public_methods(client.device_class):
+        # Device-specific client methods are local overrides and must not be
+        # replaced by automatically generated remote dispatch methods.
+        if spec.name in client_class.__dict__:
+            continue
+
+        method = _client_method(spec.name, spec.signature)
+        object.__setattr__(client, spec.name, MethodType(method, client))

tango_frame/client.py

@@ -0,0 +1,124 @@
+"""Client-side adapters for native and reconstructed TANGO devices."""
+
+from typing import Any, Optional
+
+from tango import DeviceProxy as NativeDeviceProxy
+
+from .config import Config
+
+
+class DeviceProxy(object):
+    """Framework proxy for a native TANGO device.
+
+    This class does not reconstruct a Python device class.  It creates the
+    native PyTango ``DeviceProxy`` from ``Config`` and transparently
+    delegates the normal TANGO client API to it.
+
+    Args:
+        config: TANGO connection configuration.
+    """
+
+    def __init__(self, config: Config) -> None:
+        """Create a native TANGO proxy from framework configuration.
+
+        Args:
+            config: TANGO connection configuration.
+        """
+        self._config = config
+        self._proxy = NativeDeviceProxy(config.device_url())
+
+    def __getattr__(self, name: str) -> Any:
+        """Delegate unknown members to the native PyTango proxy.
+
+        Args:
+            name: Attribute or command name requested by the caller.
+
+        Returns:
+            Member exposed by the native ``tango.DeviceProxy``.
+        """
+        return getattr(self._proxy, name)
+
+    @property
+    def config(self) -> Config:
+        """Return the framework connection configuration.
+
+        Returns:
+            TANGO connection configuration used by this proxy.
+        """
+        return self._config
+
+    @property
+    def native_proxy(self) -> NativeDeviceProxy:
+        """Return the underlying native PyTango proxy.
+
+        Returns:
+            Native ``tango.DeviceProxy`` instance.
+        """
+        return self._proxy
+
+
+class TangoTransport(object):
+    """Transport used by ``AutoDispatchClient`` for reconstructed Python APIs.
+
+    Args:
+        config: TANGO connection configuration.
+    """
+
+    def __init__(self, config: Config) -> None:
+        """Initialize transport through the framework ``DeviceProxy``.
+
+        Args:
+            config: TANGO connection configuration.
+        """
+        self._device = DeviceProxy(config=config)
+
+    def command(self, name: str, value: Any = None) -> Any:
+        """Execute a TANGO command.
+
+        Args:
+            name: TANGO command name.
+            value: Optional command input value.
+
+        Returns:
+            Command result returned by PyTango.
+        """
+        if value is None:
+            return self._device.native_proxy.command_inout(name)
+        return self._device.native_proxy.command_inout(name, value)
+
+    def read_attribute(self, name: str) -> Any:
+        """Read a TANGO attribute value.
+
+        Args:
+            name: TANGO attribute name.
+
+        Returns:
+            Attribute value.
+        """
+        return self._device.native_proxy.read_attribute(name).value
+
+    def write_attribute(self, name: str, value: Any) -> None:
+        """Write a TANGO attribute value.
+
+        Args:
+            name: TANGO attribute name.
+            value: Value written to the attribute.
+        """
+        self._device.native_proxy.write_attribute(name, value)
+
+    def ping(self) -> int:
+        """Ping the remote TANGO device.
+
+        Returns:
+            Round-trip time reported by PyTango in microseconds.
+        """
+        return self._device.native_proxy.ping()
+
+    @property
+    def proxy(self) -> NativeDeviceProxy:
+        """Return the underlying native PyTango proxy.
+
+        Returns:
+            Native ``tango.DeviceProxy`` instance.
+        """
+        return self._device.native_proxy

tango_frame/codec.py

@@ -0,0 +1,111 @@
+"""JSON codec used when a Python call cannot use a native TANGO type."""
+
+import base64
+import json
+from typing import Any, Dict, Tuple
+
+
+_TYPE_KEY = "__tango_frame_type__"
+
+
+def _encode(value: Any) -> Any:
+    """Convert Python values into JSON-serializable values.
+
+    Args:
+        value: Python value to encode.
+
+    Returns:
+        JSON-serializable representation.
+    """
+    if isinstance(value, bytes):
+        return {
+            _TYPE_KEY: "bytes",
+            "data": base64.b64encode(value).decode("ascii"),
+        }
+    if isinstance(value, tuple):
+        return {
+            _TYPE_KEY: "tuple",
+            "items": [_encode(item) for item in value],
+        }
+    if isinstance(value, list):
+        return [_encode(item) for item in value]
+    if isinstance(value, dict):
+        return {str(key): _encode(item) for key, item in value.items()}
+    return value
+
+
+def _decode(value: Any) -> Any:
+    """Restore a Python value from its JSON-compatible representation.
+
+    Args:
+        value: Decoded JSON value.
+
+    Returns:
+        Restored Python value.
+    """
+    if isinstance(value, list):
+        return [_decode(item) for item in value]
+    if isinstance(value, dict):
+        value_type = value.get(_TYPE_KEY)
+        if value_type == "bytes":
+            return base64.b64decode(value["data"].encode("ascii"))
+        if value_type == "tuple":
+            return tuple(_decode(item) for item in value["items"])
+        return {key: _decode(item) for key, item in value.items()}
+    return value
+
+
+def pack_call(args: Tuple[Any, ...], kwargs: Dict[str, Any]) -> str:
+    """Serialize positional and keyword arguments into one TANGO string.
+
+    Args:
+        args: Positional call arguments.
+        kwargs: Keyword call arguments.
+
+    Returns:
+        Compact JSON payload.
+    """
+    return json.dumps(
+        {"args": _encode(args), "kwargs": _encode(kwargs)},
+        ensure_ascii=False,
+        separators=(",", ":"),
+    )
+
+
+def unpack_call(payload: str) -> Tuple[Tuple[Any, ...], Dict[str, Any]]:
+    """Deserialize a call payload.
+
+    Args:
+        payload: JSON call payload.
+
+    Returns:
+        Tuple containing positional arguments and keyword arguments.
+    """
+    data = json.loads(payload)
+    args = _decode(data["args"])
+    kwargs = _decode(data["kwargs"])
+    return tuple(args), dict(kwargs)
+
+
+def pack_value(value: Any) -> str:
+    """Serialize a non-native Python value.
+
+    Args:
+        value: Python value to serialize.
+
+    Returns:
+        Compact JSON payload.
+    """
+    return json.dumps(_encode(value), ensure_ascii=False, separators=(",", ":"))
+
+
+def unpack_value(payload: str) -> Any:
+    """Deserialize a non-native Python value.
+
+    Args:
+        payload: JSON payload.
+
+    Returns:
+        Restored Python value.
+    """
+    return _decode(json.loads(payload))

tango_frame/config.py

@@ -0,0 +1,67 @@
+"""Configuration objects for TANGO client connections."""
+
+from typing import Optional
+
+
+class Config(object):
+    """Store the connection settings for a TANGO device.
+
+    Normal operation uses the TANGO database namespace.  A database-less
+    connection is supported only for local tests and requires ``tango_host``.
+
+    Args:
+        device_name: TANGO device name in ``domain/family/member`` form, or a
+            device alias when a database is used.
+        tango_host: TANGO database endpoint in ``host:port`` form.  If omitted
+            for a database connection, PyTango resolves the device using the
+            process TANGO_HOST configuration.
+        database: Whether the normal TANGO database namespace is used.
+    """
+
+    def __init__(
+        self,
+        device_name: str,
+        tango_host: Optional[str] = None,
+        database: bool = True,
+    ) -> None:
+        """Initialize TANGO connection settings.
+
+        Args:
+            device_name: TANGO device name or database alias.
+            tango_host: TANGO database endpoint in ``host:port`` form.
+            database: Whether to resolve the device through the TANGO database.
+
+        Raises:
+            ValueError: If required configuration is missing or inconsistent.
+        """
+        if not device_name:
+            raise ValueError("device_name must not be empty")
+        if not database and not tango_host:
+            raise ValueError("tango_host is required when database is False")
+
+        self.device_name = device_name
+        self.tango_host = tango_host
+        self.database = database
+
+    def device_url(self) -> str:
+        """Return the device identifier passed to native ``tango.DeviceProxy``.
+
+        Returns:
+            Device name, alias, or a fully qualified TANGO URL.
+        """
+        # With no explicit host, leave namespace resolution to the normal
+        # PyTango/TANGO_HOST configuration.
+        if self.database and self.tango_host is None:
+            return self.device_name
+
+        if self.database:
+            return "tango://{0}/{1}".format(
+                self.tango_host,
+                self.device_name,
+            )
+
+        # Database-less addressing is intentionally isolated to local tests.
+        return "tango://{0}/{1}#dbase=no".format(
+            self.tango_host,
+            self.device_name,
+        )

tango_frame/introspection.py

@@ -0,0 +1,91 @@
+"""Introspection helpers for ordinary Python device classes."""
+
+import inspect
+from typing import Any, List, NamedTuple, Type
+
+
+class MethodSpec(NamedTuple):
+    """Describe one public Python method.
+
+    Attributes:
+        name: Public method name.
+        signature: Method signature without the instance ``self`` parameter.
+    """
+
+    name: str
+    signature: inspect.Signature
+
+
+class PropertySpec(NamedTuple):
+    """Describe one public Python property.
+
+    Attributes:
+        name: Public property name.
+        descriptor: Original Python property descriptor.
+        annotation: Getter return annotation used for TANGO type mapping.
+        writable: Whether the property has a setter.
+    """
+
+    name: str
+    descriptor: property
+    annotation: Any
+    writable: bool
+
+
+def public_methods(device_class: Type[Any]) -> List[MethodSpec]:
+    """Return public callable methods declared by a device class.
+
+    Args:
+        device_class: Ordinary Python device class to inspect.
+
+    Returns:
+        Public method specifications.
+    """
+    result = []  # type: List[MethodSpec]
+    for name in dir(device_class):
+        if name.startswith("_"):
+            continue
+
+        raw = getattr(device_class, name)
+        if not callable(raw):
+            continue
+
+        signature = inspect.signature(raw)
+        parameters = list(signature.parameters.values())
+        if parameters and parameters[0].name == "self":
+            signature = signature.replace(parameters=parameters[1:])
+
+        result.append(MethodSpec(name=name, signature=signature))
+    return result
+
+
+def public_properties(device_class: Type[Any]) -> List[PropertySpec]:
+    """Return public properties declared by a device class.
+
+    Args:
+        device_class: Ordinary Python device class to inspect.
+
+    Returns:
+        Public property specifications.
+    """
+    result = []  # type: List[PropertySpec]
+    for name in dir(device_class):
+        if name.startswith("_"):
+            continue
+
+        descriptor = getattr(device_class, name)
+        if not isinstance(descriptor, property):
+            continue
+
+        # A property getter is required by Python's property protocol for a
+        # readable property.  Its return annotation defines the TANGO type.
+        annotation = inspect.signature(descriptor.fget).return_annotation
+        result.append(
+            PropertySpec(
+                name=name,
+                descriptor=descriptor,
+                annotation=annotation,
+                writable=descriptor.fset is not None,
+            )
+        )
+    return result

tango_frame/server.py

@@ -0,0 +1,26 @@
+"""Helpers for starting TANGO device servers."""
+
+from typing import Any, List, Optional, Sequence, Type
+
+from tango.server import run
+
+
+def run_device_server(
+    device_class: Type[Any],
+    args: Optional[Sequence[str]] = None,
+) -> None:
+    """Run a PyTango device server class.
+
+    The helper does not force database-less operation.  Normal TANGO database
+    startup arguments can therefore be supplied by the application.  ``-nodb``
+    remains an application-level option for local tests only.
+
+    Args:
+        device_class: PyTango ``Device`` subclass to run.
+        args: Optional argument sequence passed to ``tango.server.run``.
+    """
+    run_args = None  # type: Optional[List[str]]
+    if args is not None:
+        run_args = list(args)
+
+    run((device_class,), args=run_args)

tango_frame/type_mapping.py

@@ -0,0 +1,166 @@
+"""Map Python 3.7 type annotations onto PyTango value types."""
+
+import inspect
+from typing import Any, List, Optional, Type
+
+
+def _list_element_type(annotation: Any) -> Optional[Type[Any]]:
+    """Return the supported element type of a homogeneous list annotation.
+
+    Python 3.7 does not provide ``typing.get_origin`` or ``typing.get_args``.
+    The compatibility path therefore uses the ``__origin__`` and ``__args__``
+    attributes exposed by ``typing.List``.
+
+    Args:
+        annotation: Python type annotation.
+
+    Returns:
+        Supported list element type, or ``None`` when unsupported.
+    """
+    origin = getattr(annotation, "__origin__", None)
+    args = getattr(annotation, "__args__", ())
+    if origin in (list, List) and len(args) == 1:
+        element = args[0]
+        if element in (bool, int, float, str):
+            return element
+    return None
+
+
+def tango_scalar_type(annotation: Any) -> Optional[Any]:
+    """Map a scalar Python annotation to a PyTango high-level type.
+
+    Args:
+        annotation: Python type annotation.
+
+    Returns:
+        PyTango-compatible scalar type, or ``None`` when unsupported.
+    """
+    if annotation is bool:
+        return bool
+    if annotation is int:
+        return int
+    if annotation is float:
+        return float
+    if annotation is str:
+        return str
+    return None
+
+
+def tango_array_type(annotation: Any) -> Optional[Any]:
+    """Map a homogeneous list annotation to a PyTango spectrum type.
+
+    Args:
+        annotation: Python type annotation.
+
+    Returns:
+        PyTango high-level spectrum type, or ``None`` when unsupported.
+    """
+    element = _list_element_type(annotation)
+    if element is None:
+        return None
+    return (element,)
+
+
+def tango_value_type(annotation: Any) -> Optional[Any]:
+    """Map a supported Python annotation to a PyTango value type.
+
+    Args:
+        annotation: Python type annotation.
+
+    Returns:
+        PyTango-compatible type, or ``None`` when JSON fallback is required.
+    """
+    scalar = tango_scalar_type(annotation)
+    if scalar is not None:
+        return scalar
+    return tango_array_type(annotation)
+
+
+def is_void(annotation: Any) -> bool:
+    """Return whether an annotation represents no return value.
+
+    Args:
+        annotation: Python return annotation.
+
+    Returns:
+        ``True`` for ``None`` or ``NoneType``.
+    """
+    return annotation is None or annotation is type(None)
+
+
+def input_type(signature: inspect.Signature) -> Optional[Any]:
+    """Determine the TANGO command input type for a Python signature.
+
+    Args:
+        signature: Python method signature without ``self``.
+
+    Returns:
+        Native PyTango type, ``str`` for encoded input, or ``None`` for void.
+    """
+    parameters = list(signature.parameters.values())
+    if len(parameters) == 0:
+        return None
+    if len(parameters) == 1:
+        parameter = parameters[0]
+        if parameter.kind in (
+            inspect.Parameter.POSITIONAL_ONLY,
+            inspect.Parameter.POSITIONAL_OR_KEYWORD,
+        ):
+            native = tango_value_type(parameter.annotation)
+            if native is not None:
+                return native
+    return str
+
+
+def output_type(signature: inspect.Signature) -> Optional[Any]:
+    """Determine the TANGO command output type for a Python signature.
+
+    Args:
+        signature: Python method signature without ``self``.
+
+    Returns:
+        Native PyTango type, ``str`` for encoded output, or ``None`` for void.
+    """
+    annotation = signature.return_annotation
+    if is_void(annotation):
+        return None
+
+    native = tango_value_type(annotation)
+    if native is not None:
+        return native
+    return str
+
+
+def uses_encoded_input(signature: inspect.Signature) -> bool:
+    """Return whether a call requires the JSON input envelope.
+
+    Args:
+        signature: Python method signature without ``self``.
+
+    Returns:
+        ``True`` when the input cannot be represented by one native TANGO value.
+    """
+    parameters = list(signature.parameters.values())
+    if len(parameters) == 0:
+        return False
+    if len(parameters) == 1:
+        parameter = parameters[0]
+        native = tango_value_type(parameter.annotation)
+        if native is not None:
+            return False
+    return True
+
+
+def uses_encoded_output(signature: inspect.Signature) -> bool:
+    """Return whether a return value requires JSON encoding.
+
+    Args:
+        signature: Python method signature without ``self``.
+
+    Returns:
+        ``True`` when the return type has no native TANGO representation.
+    """
+    annotation = signature.return_annotation
+    if is_void(annotation):
+        return False
+    return tango_value_type(annotation) is None

tango_frame-0.1.1.dist-info/METADATA

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: tango-frame
+Version: 0.1.1
+Summary: Automatic TANGO dispatch framework for ordinary Python device classes
+Requires-Python: >=3.8
+License-File: LICENSE
+Requires-Dist: pytango>=10
+Dynamic: license-file

tango_frame-0.1.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+tango_frame/__init__.py,sha256=Z9z8s_HPREosom2y7IhrqJg8og8ArYKlfgSRgv5aeFA,196
+tango_frame/auto_dispatch.py,sha256=cVex_O05G81wRMrHMzbPPbKNwWQ1j89vi3rzoU1UBcQ,12640
+tango_frame/client.py,sha256=sI4kpaF9npR19iSqGJfAgNnOhbCUZhEvKzrYRnIKsyU,3464
+tango_frame/codec.py,sha256=avyQ8KbCAMcnIAwkpx_wnjPC7SU1JSKBAbW5rzJnfgo,2840
+tango_frame/config.py,sha256=9u6xHmD9er7LfG4FoF__vG2cO81bhGV_8QFkliXhFWY,2359
+tango_frame/introspection.py,sha256=pUodfK5ZYcKBYomgGuO79klNzhjtYIFN17Wf6tG_FKU,2588
+tango_frame/server.py,sha256=Ggw8o89l9ov3q5aneduTjIaQqI1mPWv46fSlIv600us,799
+tango_frame/type_mapping.py,sha256=ILC0PRYlsSX0k9G5twRdZ3WxvlUuor4ASE_BD-YKq2Q,4733
+tango_frame-0.1.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+tango_frame-0.1.1.dist-info/METADATA,sha256=NlXUXqZoYiUPrIaE9bTJomGEh6MGT74sysAuiH8xjTw,228
+tango_frame-0.1.1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+tango_frame-0.1.1.dist-info/top_level.txt,sha256=yuN0q1K-UfHh1NzOuF0Y89R-tD98GtfVb5swStOlslc,12
+tango_frame-0.1.1.dist-info/RECORD,,

tango_frame-0.1.1.dist-info/WHEEL

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

tango_frame-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tango_frame-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+tango_frame