.. py:class:: DbusInterfaceCommonAsync(interface_name)

:py:func:`dbus_property_async`, :py:func:`dbus_signal_async`,

and :py:func:`dbus_method_async` decorators.

.. note::

Don't forget to call ``super().__init__()`` in derived classes

init calls as it sets up important attributes.

name that will be used for all properties, methods

and signals defined in the body of the class.

:param bool serving_enabled: If set to :py:obj:`True`

for interfaces that sd-bus already provides such as

``org.freedesktop.DBus.Peer``.

.. py:method:: dbus_ping()

:async:

Useful to test if connection or remote service is alive.

.. py:method:: dbus_introspect()

:async:

It is users responsibility to parse that data.

.. py:method:: _proxify(bus, service_name, object_path)

:param str service_name:

For example, systemd uses ``org.freedesktop.systemd1``

:param str object_path:

Should be a forward slash separated path.

Starting object is usually ``/``.

Example: ``/org/freedesktop/systemd/unit/dbus_2eservice``

:param SdBus bus:

.. py:classmethod:: new_proxy(bus, service_name, object_path)

Create new proxy object and bypass ``__init__``.

:param str service_name:

For example, systemd uses ``org.freedesktop.systemd1``

:param str object_path:

Should be a forward slash separated path.

Starting object is usually ``/``.

Example: ``/org/freedesktop/systemd/unit/dbus_2eservice``

:param SdBus bus:

.. py:method:: export_to_dbus(object_path, bus)

:param str object_path:

Object path that it will be available at.

:param SdBus bus:

.. py:class:: DbusObjectManagerInterfaceAsync(interface_name)

Object to export to D-Bus.

:param SdBus bus:

:raises RuntimeError: ObjectManager was not exported.

Underlying function must be a coroutine function.

Defaults to "" meaning method takes no arguments.

Required if you intend to connect to a remote object.

Defaults to "" meaning method returns empty reply on success.

Required if you intend to serve the object.

argument names will be used otherwise input arguments

will be nameless

instead of being based on Python function name.

Example: ::

.. py:decorator:: dbus_property_async(property_signature, [flags, [property_name]])

The underlying function has to be a regular ``def`` function.

does not perform heavy IO or computation

as that will block other methods or properties.

Has to be a single type or container.

:param int flags: modifies behavior.

.. py:decorator:: dbus_signal_async([signal_signature, [signal_args_names, [flags, [signal_name]]]])

Underlying function return type hint is used for signal type hints.

Defaults to empty signal.

:param Sequence[str] signal_args_names: sequence of signal argument names.

the service name of the proxy will be used.

:param str bus:

If not passed when called from proxy the bus connected

to proxy will be used or when called from class default

bus will be used.

Interface classes for async IO should be derived from :py:class:`DbusInterfaceCommonAsync`.

Example: ::

Serving objects

:py:meth:`DbusInterfaceCommonAsync.export_to_dbus` method

Example using ExampleInterface from before: ::

Signals

The function is only used for type hints information. It is recommended

to just put ``raise NotImplementedError`` in to the body of the function.

Subclass Overrides

you need to use :py:func:`dbus_method_async_override` and :py:func:`dbus_property_async_override`

decorators. Overridden property can decorate a new setter.

Multiple interfaces

To implement this define multiple interface classes and do a

multiple inheritance on all interfaces the object has.

Python-sdbus has an extension for Sphinx autodoc that can

To use it include ``"sdbus.autodoc"`` extension in your

``conf.py`` file.

.. warning:: Autodoc extension is early in development and

has multiple issues. For example, the inheritance ``:inherited-members:``

Writing docstrings

would. See `Sphinx documentation on possible fields \

<https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists>`_

.. code-block:: python

stub function.

.. code-block:: python

.. py:currentmodule:: sdbus

.. py:function:: request_default_bus_name_async(new_name, allow_replacement, replace_existing, queue)

Acquire a name on the default bus async.

:param str new_name: the name to acquire.

:param str new_name: the name to acquire.

:param bool allow_replacement: If name was acquired allow other peers

to take away the name.

:param bool replace_existing: If current name owner allows, take

Acquire a name on the default bus.

:param str new_name: the name to acquire.

:param bool allow_replacement: If name was acquired allow other peers

to take away the name.

:param bool replace_existing: If current name owner allows, take

:return: valid object path

:rtype: str