dbus-fast 2.45.1__cp311-cp311-macosx_11_0_arm64.whl

dbus_fast/message.pxd

@@ -0,0 +1,76 @@
+"""cdefs for message.py"""
+
+import cython
+
+from ._private.marshaller cimport Marshaller
+from .signature cimport Variant, SignatureTree, SignatureType
+
+cdef object ErrorType
+cdef object MessageType
+
+cdef object HEADER_PATH
+cdef object HEADER_INTERFACE
+cdef object HEADER_MEMBER
+cdef object HEADER_ERROR_NAME
+cdef object HEADER_REPLY_SERIAL
+cdef object HEADER_DESTINATION
+cdef object HEADER_SENDER
+cdef object HEADER_SIGNATURE
+cdef object HEADER_UNIX_FDS
+
+
+cdef object LITTLE_ENDIAN
+cdef object PROTOCOL_VERSION
+
+cdef object MESSAGE_FLAG
+cdef object MESSAGE_FLAG_NONE
+cdef object MESSAGE_TYPE_METHOD_CALL
+
+cdef SignatureTree SIGNATURE_TREE_G
+cdef SignatureTree SIGNATURE_TREE_O
+cdef SignatureTree SIGNATURE_TREE_S
+cdef SignatureTree SIGNATURE_TREE_U
+
+cdef get_signature_tree
+
+cdef class Message:
+
+    cdef public object destination
+    cdef public object path
+    cdef public object interface
+    cdef public object member
+    cdef public object message_type
+    cdef public object flags
+    cdef public object error_name
+    cdef public unsigned int reply_serial
+    cdef public object sender
+    cdef public list unix_fds
+    cdef public str signature
+    cdef public SignatureTree signature_tree
+    cdef public object body
+    cdef public unsigned int serial
+
+    @cython.locals(
+        body_buffer=bytearray,
+        header_buffer=bytearray,
+        var=Variant
+    )
+    cpdef _marshall(self, bint negotiate_unix_fd)
+
+    cdef _fast_init(
+        self,
+        object destination,
+        object path,
+        object interface,
+        object member,
+        object message_type,
+        object flags,
+        object error_name,
+        unsigned int reply_serial,
+        object sender,
+        list unix_fds,
+        SignatureTree signature_tree,
+        object body,
+        unsigned int serial,
+        bint validate
+    )

dbus_fast/message.py

@@ -0,0 +1,387 @@
+from typing import Any, Optional, Union
+
+from ._private.constants import LITTLE_ENDIAN, PROTOCOL_VERSION, HeaderField
+from ._private.marshaller import Marshaller
+from .constants import ErrorType, MessageFlag, MessageType
+from .errors import InvalidMessageError
+from .signature import SignatureTree, Variant, get_signature_tree
+from .validators import (
+    assert_bus_name_valid,
+    assert_interface_name_valid,
+    assert_member_name_valid,
+    assert_object_path_valid,
+)
+
+REQUIRED_FIELDS = {
+    MessageType.METHOD_CALL.value: ("path", "member"),
+    MessageType.SIGNAL.value: ("path", "member", "interface"),
+    MessageType.ERROR.value: ("error_name", "reply_serial"),
+    MessageType.METHOD_RETURN.value: ("reply_serial",),
+}
+
+HEADER_PATH = HeaderField.PATH.value
+HEADER_INTERFACE = HeaderField.INTERFACE.value
+HEADER_MEMBER = HeaderField.MEMBER.value
+HEADER_ERROR_NAME = HeaderField.ERROR_NAME.value
+HEADER_REPLY_SERIAL = HeaderField.REPLY_SERIAL.value
+HEADER_DESTINATION = HeaderField.DESTINATION.value
+HEADER_SIGNATURE = HeaderField.SIGNATURE.value
+HEADER_UNIX_FDS = HeaderField.UNIX_FDS.value
+
+MESSAGE_FLAG = MessageFlag
+
+MESSAGE_FLAG_NONE = MessageFlag.NONE
+MESSAGE_TYPE_METHOD_CALL = MessageType.METHOD_CALL
+
+SIGNATURE_TREE_G = get_signature_tree("g")
+SIGNATURE_TREE_O = get_signature_tree("o")
+SIGNATURE_TREE_S = get_signature_tree("s")
+SIGNATURE_TREE_U = get_signature_tree("u")
+
+_int = int
+_str = str
+_bool = bool
+_MessageType = MessageType
+_MessageFlag = MessageFlag
+_list = list
+
+
+class Message:
+    """A class for sending and receiving messages through the
+    :class:`MessageBus <dbus_fast.message_bus.BaseMessageBus>` with the
+    low-level api.
+
+    A ``Message`` can be constructed by the user to send over the message bus.
+    When messages are received, such as from method calls or signal emissions,
+    they will use this class as well.
+
+    :ivar destination: The address of the client for which this message is intended.
+    :vartype destination: str
+    :ivar path: The intended object path exported on the destination bus.
+    :vartype path: str
+    :ivar interface: The intended interface on the object path.
+    :vartype interface: str
+    :ivar member: The intended member on the interface.
+    :vartype member: str
+    :ivar message_type: The type of this message. A method call, signal, method return, or error.
+    :vartype message_type: :class:`MessageType`
+    :ivar flags: Flags that affect the behavior of this message.
+    :vartype flags: :class:`MessageFlag`
+    :ivar error_name: If this message is an error, the name of this error. Must be a valid interface name.
+    :vartype error_name: str
+    :ivar reply_serial: If this is a return type, the serial this message is in reply to.
+    :vartype reply_serial: int
+    :ivar sender: The address of the sender of this message. Will be a unique name.
+    :vartype sender: str
+    :ivar unix_fds: A list of unix fds that were sent in the header of this message.
+    :vartype unix_fds: list(int)
+    :ivar signature: The signature of the body of this message.
+    :vartype signature: str
+    :ivar signature_tree: The signature parsed as a signature tree.
+    :vartype signature_tree: :class:`SignatureTree`
+    :ivar body: The body of this message. Must match the signature.
+    :vartype body: list(Any)
+    :ivar serial: The serial of the message. Will be automatically set during message sending if not present. Use the ``new_serial()`` method of the bus to generate a serial.
+    :vartype serial: int
+
+    :raises:
+        - :class:`InvalidMessageError` - If the message is malformed or missing fields for the message type.
+        - :class:`InvalidSignatureError` - If the given signature is not valid.
+        - :class:`InvalidObjectPathError` - If ``path`` is not a valid object path.
+        - :class:`InvalidBusNameError` - If ``destination`` is not a valid bus name.
+        - :class:`InvalidMemberNameError` - If ``member`` is not a valid member name.
+        - :class:`InvalidInterfaceNameError` - If ``error_name`` or ``interface`` is not a valid interface name.
+    """
+
+    __slots__ = (
+        "body",
+        "destination",
+        "error_name",
+        "flags",
+        "interface",
+        "member",
+        "message_type",
+        "path",
+        "reply_serial",
+        "sender",
+        "serial",
+        "signature",
+        "signature_tree",
+        "unix_fds",
+    )
+
+    def __init__(
+        self,
+        destination: Optional[str] = None,
+        path: Optional[str] = None,
+        interface: Optional[str] = None,
+        member: Optional[str] = None,
+        message_type: MessageType = MESSAGE_TYPE_METHOD_CALL,
+        flags: Union[MessageFlag, int] = MESSAGE_FLAG_NONE,
+        error_name: Optional[Union[str, ErrorType]] = None,
+        reply_serial: Optional[int] = None,
+        sender: Optional[str] = None,
+        unix_fds: list[int] = [],
+        signature: Optional[Union[SignatureTree, str]] = None,
+        body: list[Any] = [],
+        serial: Optional[int] = None,
+        validate: bool = True,
+    ) -> None:
+        self._fast_init(
+            destination,
+            path,
+            interface,
+            member,
+            message_type,
+            flags if type(flags) is MESSAGE_FLAG else MESSAGE_FLAG(flags),
+            str(error_name.value) if type(error_name) is ErrorType else error_name,
+            reply_serial or 0,
+            sender,
+            unix_fds,
+            signature
+            if type(signature) is SignatureTree
+            else get_signature_tree(signature or ""),
+            body,
+            serial or 0,
+            validate,
+        )
+
+    def _fast_init(
+        self,
+        destination: Optional[_str],
+        path: Optional[_str],
+        interface: Optional[_str],
+        member: Optional[_str],
+        message_type: _MessageType,
+        flags: _MessageFlag,
+        error_name: Optional[_str],
+        reply_serial: _int,
+        sender: _str,
+        unix_fds: _list[int],
+        signature_tree: SignatureTree,
+        body: _list[Any],
+        serial: _int,
+        validate: _bool,
+    ) -> None:
+        self.destination = destination
+        self.path = path
+        self.interface = interface
+        self.member = member
+        self.message_type = message_type
+        self.flags = flags
+        self.error_name = error_name
+        self.reply_serial = reply_serial
+        self.sender = sender
+        self.unix_fds = unix_fds
+        self.signature = signature_tree.signature
+        self.signature_tree = signature_tree
+        self.body = body
+        self.serial = serial
+
+        if not validate:
+            return
+        if self.destination is not None:
+            assert_bus_name_valid(self.destination)
+        if self.interface is not None:
+            assert_interface_name_valid(self.interface)
+        if self.path is not None:
+            assert_object_path_valid(self.path)
+        if self.member is not None:
+            assert_member_name_valid(self.member)
+        if self.error_name is not None:
+            assert_interface_name_valid(self.error_name)  # type: ignore[arg-type]
+
+        required_fields = REQUIRED_FIELDS.get(self.message_type.value)
+        if not required_fields:
+            raise InvalidMessageError(f"got unknown message type: {self.message_type}")
+        for field in required_fields:
+            if not getattr(self, field):
+                raise InvalidMessageError(f"missing required field: {field}")
+
+    def __repr__(self) -> str:
+        """Return a string representation of this message."""
+        return (
+            f"<Message {self.message_type.name} "
+            f"serial={self.serial} "
+            f"reply_serial={self.reply_serial} "
+            f"sender={self.sender} "
+            f"destination={self.destination} "
+            f"path={self.path} "
+            f"interface={self.interface} "
+            f"member={self.member} "
+            f"error_name={self.error_name} "
+            f"signature={self.signature} "
+            f"body={self.body}>"
+        )
+
+    @staticmethod
+    def new_error(
+        msg: "Message", error_name: Union[str, ErrorType], error_text: str
+    ) -> "Message":
+        """A convenience constructor to create an error message in reply to the given message.
+
+        :param msg: The message this error is in reply to.
+        :type msg: :class:`Message`
+        :param error_name: The name of this error. Must be a valid interface name.
+        :type error_name: str
+        :param error_text: Human-readable text for the error.
+
+        :returns: The error message.
+        :rtype: :class:`Message`
+
+        :raises:
+            - :class:`InvalidInterfaceNameError` - If the error_name is not a valid interface name.
+        """
+        return Message(
+            message_type=MessageType.ERROR,
+            reply_serial=msg.serial,
+            destination=msg.sender,
+            error_name=error_name,
+            signature="s",
+            body=[error_text],
+        )
+
+    @staticmethod
+    def new_method_return(
+        msg: "Message",
+        signature: str = "",
+        body: list[Any] = [],
+        unix_fds: list[int] = [],
+    ) -> "Message":
+        """A convenience constructor to create a method return to the given method call message.
+
+        :param msg: The method call message this is a reply to.
+        :type msg: :class:`Message`
+        :param signature: The signature for the message body.
+        :type signature: str
+        :param body: The body of this message. Must match the signature.
+        :type body: list(Any)
+        :param unix_fds: List integer file descriptors to send with this message.
+        :type body: list(int)
+
+        :returns: The method return message
+        :rtype: :class:`Message`
+
+        :raises:
+            - :class:`InvalidSignatureError` - If the signature is not a valid signature.
+        """
+        return Message(
+            message_type=MessageType.METHOD_RETURN,
+            reply_serial=msg.serial,
+            destination=msg.sender,
+            signature=signature,
+            body=body,
+            unix_fds=unix_fds,
+        )
+
+    @staticmethod
+    def new_signal(
+        path: str,
+        interface: str,
+        member: str,
+        signature: str = "",
+        body: Optional[list[Any]] = None,
+        unix_fds: Optional[list[int]] = None,
+    ) -> "Message":
+        """A convenience constructor to create a new signal message.
+
+        :param path: The path of this signal.
+        :type path: str
+        :param interface: The interface of this signal.
+        :type interface: str
+        :param member: The member name of this signal.
+        :type member: str
+        :param signature: The signature of the signal body.
+        :type signature: str
+        :param body: The body of this signal message.
+        :type body: list(Any)
+        :param unix_fds: List integer file descriptors to send with this message.
+        :type body: list(int)
+
+        :returns: The signal message.
+        :rtype: :class:`Message`
+
+        :raises:
+            - :class:`InvalidSignatureError` - If the signature is not a valid signature.
+            - :class:`InvalidObjectPathError` - If ``path`` is not a valid object path.
+            - :class:`InvalidInterfaceNameError` - If ``interface`` is not a valid interface name.
+            - :class:`InvalidMemberNameError` - If ``member`` is not a valid member name.
+        """
+        return Message(
+            message_type=MessageType.SIGNAL,
+            interface=interface,
+            path=path,
+            member=member,
+            signature=signature,
+            body=body or [],
+            unix_fds=unix_fds or [],
+        )
+
+    def _marshall(self, negotiate_unix_fd: bool) -> bytearray:
+        """Marshall this message into a byte array."""
+        # TODO maximum message size is 134217728 (128 MiB)
+        body_block = Marshaller(self.signature, self.body)
+        body_buffer = body_block._marshall()
+
+        fields = []
+
+        # No verify here since the marshaller will raise an exception if the
+        # Variant is invalid.
+
+        if self.path:
+            fields.append((HEADER_PATH, Variant._factory(SIGNATURE_TREE_O, self.path)))
+        if self.interface:
+            fields.append(
+                (HEADER_INTERFACE, Variant._factory(SIGNATURE_TREE_S, self.interface))
+            )
+        if self.member:
+            fields.append(
+                (HEADER_MEMBER, Variant._factory(SIGNATURE_TREE_S, self.member))
+            )
+        if self.error_name:
+            fields.append(
+                (
+                    HEADER_ERROR_NAME,
+                    Variant._factory(SIGNATURE_TREE_S, self.error_name),
+                )
+            )
+        if self.reply_serial:
+            fields.append(
+                (
+                    HEADER_REPLY_SERIAL,
+                    Variant._factory(SIGNATURE_TREE_U, self.reply_serial),
+                )
+            )
+        if self.destination:
+            fields.append(
+                (
+                    HEADER_DESTINATION,
+                    Variant._factory(SIGNATURE_TREE_S, self.destination),
+                )
+            )
+        if self.signature:
+            fields.append(
+                (HEADER_SIGNATURE, Variant._factory(SIGNATURE_TREE_G, self.signature))
+            )
+        if self.unix_fds and negotiate_unix_fd:
+            fields.append(
+                (
+                    HEADER_UNIX_FDS,
+                    Variant._factory(SIGNATURE_TREE_U, len(self.unix_fds)),
+                )
+            )
+
+        header_body = [
+            LITTLE_ENDIAN,
+            self.message_type.value,
+            self.flags.value,
+            PROTOCOL_VERSION,
+            len(body_buffer),
+            self.serial,
+            fields,
+        ]
+        header_block = Marshaller("yyyyuua(yv)", header_body)
+        header_block._marshall()
+        header_block._align(8)
+        header_buffer = header_block._buffer()
+        return header_buffer + body_buffer

dbus_fast/message_bus.pxd

@@ -0,0 +1,75 @@
+import cython
+
+from ._private.address cimport get_bus_address, parse_address
+from .message cimport Message
+from .service cimport ServiceInterface, _Method
+
+cdef bint TYPE_CHECKING
+
+cdef object MessageType
+cdef object DBusError
+cdef object MessageFlag
+
+cdef object MESSAGE_TYPE_CALL
+cdef object MESSAGE_TYPE_SIGNAL
+cdef cython.uint NO_REPLY_EXPECTED_VALUE
+cdef object NONE
+cdef object NO_REPLY_EXPECTED
+
+cdef object BLOCK_UNEXPECTED_REPLY
+cdef object assert_object_path_valid
+cdef object assert_bus_name_valid
+
+@cython.locals(flag_value=cython.uint)
+cdef bint _expects_reply(Message msg)
+
+
+cdef class BaseMessageBus:
+
+    cdef public object unique_name
+    cdef public bint _disconnected
+    cdef public object _user_disconnect
+    cdef public cython.dict _method_return_handlers
+    cdef public object _serial
+    cdef public cython.dict _path_exports
+    cdef public cython.list _user_message_handlers
+    cdef public cython.dict _name_owners
+    cdef public object _bus_address
+    cdef public object _name_owner_match_rule
+    cdef public cython.dict _match_rules
+    cdef public object _high_level_client_initialized
+    cdef public object _ProxyObject
+    cdef public object _machine_id
+    cdef public bint _negotiate_unix_fd
+    cdef public object _sock
+    cdef public object _stream
+    cdef public object _fd
+
+    cpdef void _process_message(self, Message msg) except *
+
+    @cython.locals(exported_service_interface=ServiceInterface)
+    cpdef export(self, str path, ServiceInterface interface)
+
+    @cython.locals(
+        methods=cython.list,
+        method=_Method,
+        interface=ServiceInterface,
+        interfaces=dict,
+    )
+    cdef _find_message_handler(self, Message msg)
+
+    cdef _find_any_message_handler_matching_signature(self, dict interfaces, Message msg)
+
+    cdef _setup_socket(self)
+
+    cpdef _call(self, Message msg, object callback)
+
+    cpdef next_serial(self)
+
+    cpdef void _callback_method_handler(
+        self,
+        ServiceInterface interface,
+        _Method method,
+        Message msg,
+        object send_reply
+    ) except *