from abc import ABCMeta
from typing import Any, ClassVar
class Interface(metaclass=ABCMeta):
"""Base class for all interfaces in pyobs."""
version: int = 1
state: ClassVar[type | None] = None
capabilities: ClassVar[type | None] = None
__module__ = "pyobs.interfaces"
[docs]
def get_state(self, interface: "type[Interface]") -> Any | None:
"""Return the last received state for the given interface, or None."""
return None
[docs]
def get_capabilities(self, interface: "type[Interface]") -> Any | None:
"""Return the capabilities for the given interface, or None."""
return None
[docs]
async def wait_for_state(self, interface: "type[Interface]", timeout: float = 10.0) -> Any | None:
"""Return state immediately if available, otherwise wait for the first update."""
return None
[docs]
@classmethod
def has_own_state(cls) -> bool:
"""True if this interface defines its own state, as opposed to merely inheriting
one from a component interface it combines (e.g. ICamera inheriting IExposure's
state). Modules publish state under the interface that actually defines it, so
composite interfaces would otherwise be (wrongly) treated as publishing state too.
"""
return "state" in cls.__dict__
__all__ = ["Interface"]