hololinked.client.abstractions.ConsumedThingProperty

class ConsumedThingProperty:  # noqa: D101 # Dont add class doc otherwise it will conflict with __doc__ in slots
    # property get set abstraction

    if TYPE_CHECKING:
        # These are declared as __slots__ in the protocol-specific mixin subclasses.
        # Annotated here only so type checkers resolve them on the base type.
        __name__: str
        __qualname__: str
        __doc__: str | None

    def __init__(self, resource: PropertyAffordance, owner_inst: Any, logger: structlog.stdlib.BoundLogger) -> None:
        """
        Initialize a consumed thing property.

        Parameters
        ----------
        resource: PropertyAffordance
            dataclass object TD fragment representing the property (must have forms).
        owner_inst: Any
            instance of the owning consumed Thing or `ObjectProxy`
        logger: structlog.stdlib.BoundLogger
            logger instance
        """
        from . import ObjectProxy  # noqa: F401

        self.resource = resource
        self.owner_inst = owner_inst  # type: ObjectProxy
        self.logger = logger

    @property  # i.e. cannot have setter
    def last_read_value(self) -> Any:
        """
        Cache of last read value, updated on each get/read call.

        Does not necessarily reflect the current value on the server.
        """
        raise NotImplementedError("implement last_read_value per protocol")

    def set(self, value: Any) -> None:
        """
        Set or write property value.

        Parameters
        ----------
        value: Any
            value to set
        """
        raise NotImplementedError("implement property set per protocol")

    def get(self) -> Any:
        """
        Get or read property value.

        Returns
        -------
        Any
            property value
        """
        raise NotImplementedError("implement property get per protocol")

    async def async_set(self, value: Any) -> None:
        """
        Async set or write property value.

        Asynchronous at the network level, may not necessarily be at the server level.

        Parameters
        ----------
        value: Any
            value to set
        """
        raise NotImplementedError("implement async property set per protocol")

    async def async_get(self) -> Any:
        """
        Async get or read property value.

        Asynchronous at the network level, may not necessarily be at the server level.

        Returns
        -------
        Any
            property value
        """
        raise NotImplementedError("implement async property get per protocol")

    def noblock_get(self) -> str:
        """
        Get or read property value without blocking.

        Make a request and collect it later and the method returns immediately. Server must return a message ID to
        identify the request.

        Returns
        -------
        str
            id of the request or message (UUID4 as string)
        """
        raise NotImplementedError("implement property noblock get per protocol")

    def noblock_set(self, value: Any) -> str:
        """
        Set or write property value without blocking.

        Make a request and collect it later and the method returns immediately. Server must return a message ID to
        identify the request.

        Parameters
        ----------
        value: Any
            value to set

        Returns
        -------
        str
            id of the request or message (UUID4 as string)
        """
        raise NotImplementedError("implement property noblock set per protocol")

    def oneway_set(self, value: Any) -> None:
        """
        Set property value without waiting for acknowledgement.

        The server also does not (need to) send any reply. There is no guarantee that the property value was set.

        Parameters
        ----------
        value: Any
            value to set
        """
        raise NotImplementedError("implement property oneway set per protocol")

    def observe(self, *callbacks: Callable) -> None:
        """
        Observe property value changes.

        Parameters
        ----------
        *callbacks: Callable
            callback to call when property value changes
        """
        # looks like this will be unused. observe property is done via ConsumedThingEvent
        raise NotImplementedError("implement property observe per protocol")

    def unobserve(self) -> None:
        """Stop observing property value changes."""
        # looks like this will be unused, observe property is done via ConsumedThingEvent
        raise NotImplementedError("implement property unobserve per protocol")

    def read_reply(self, message_id: str, timeout: float | None = None) -> Any:
        """
        Read the reply of the property get or set which was scheduled with `noblock`.

        Parameters
        ----------
        message_id: str
            id of the request or message (UUID4 as string)
        timeout: float | int | None
            timeout in seconds to wait for the reply, None means wait indefinitely

        Returns
        -------
        Any
            reply of the property get or set
        """
        raise NotImplementedError("implement property read_reply per protocol")