dbus.connection module

class dbus.connection.Connection(*args, **kwargs)

Bases: _dbus_bindings.Connection

A connection to another application. In this base class there is assumed to be no bus daemon.

Since:0.81.0
ProxyObjectClass

alias of dbus.proxies.ProxyObject

activate_name_owner(bus_name)

Return the unique name for the given bus name, activating it if necessary and possible.

If the name is already unique or this connection is not to a bus daemon, just return it.

Returns:a bus name. If the given bus_name exists, the returned name identifies its current owner; otherwise the returned name does not exist.
Raises DBusException:
 if the implementation has failed to activate the given bus name.
Since:0.81.0
add_signal_receiver(handler_function, signal_name=None, dbus_interface=None, bus_name=None, path=None, **keywords)

Arrange for the given function to be called when a signal matching the parameters is received.

Parameters:
handler_function : callable

The function to be called. Its positional arguments will be the arguments of the signal. By default it will receive no keyword arguments, but see the description of the optional keyword arguments below.

signal_name : str

The signal name; None (the default) matches all names

dbus_interface : str

The D-Bus interface name with which to qualify the signal; None (the default) matches all interface names

bus_name : str

A bus name for the sender, which will be resolved to a unique name if it is not already; None (the default) matches any sender.

path : str

The object path of the object which must have emitted the signal; None (the default) matches any object path

Keywords:
utf8_strings : bool

If True, the handler function will receive any string arguments as dbus.UTF8String objects (a subclass of str guaranteed to be UTF-8). If False (default) it will receive any string arguments as dbus.String objects (a subclass of unicode).

byte_arrays : bool

If True, the handler function will receive any byte-array arguments as dbus.ByteArray objects (a subclass of str). If False (default) it will receive any byte-array arguments as a dbus.Array of dbus.Byte (subclasses of: a list of ints).

sender_keyword : str

If not None (the default), the handler function will receive the unique name of the sending endpoint as a keyword argument with this name.

destination_keyword : str

If not None (the default), the handler function will receive the bus name of the destination (or None if the signal is a broadcast, as is usual) as a keyword argument with this name.

interface_keyword : str

If not None (the default), the handler function will receive the signal interface as a keyword argument with this name.

member_keyword : str

If not None (the default), the handler function will receive the signal name as a keyword argument with this name.

path_keyword : str

If not None (the default), the handler function will receive the object-path of the sending object as a keyword argument with this name.

message_keyword : str

If not None (the default), the handler function will receive the dbus.lowlevel.SignalMessage as a keyword argument with this name.

arg… : unicode or UTF-8 str

If there are additional keyword parameters of the form argn, match only signals where the nth argument is the value given for that keyword parameter. As of this time only string arguments can be matched (in particular, object paths and signatures can’t).

named_service : str

A deprecated alias for bus_name.

call_async(bus_name, object_path, dbus_interface, method, signature, args, reply_handler, error_handler, timeout=-1.0, byte_arrays=False, require_main_loop=True, **kwargs)

Call the given method, asynchronously.

If the reply_handler is None, successful replies will be ignored. If the error_handler is None, failures will be ignored. If both are None, the implementation may request that no reply is sent.

Returns:The dbus.lowlevel.PendingCall.
Since:0.81.0
call_blocking(bus_name, object_path, dbus_interface, method, signature, args, timeout=-1.0, byte_arrays=False, **kwargs)

Call the given method, synchronously. :Since: 0.81.0

call_on_disconnection(callable)

Arrange for callable to be called with one argument (this Connection object) when the Connection becomes disconnected.

Since:0.83.0
get_object(bus_name=None, object_path=None, introspect=True, **kwargs)

Return a local proxy for the given remote object.

Method calls on the proxy are translated into method calls on the remote object.

Parameters:
bus_name : str

A bus name (either the unique name or a well-known name) of the application owning the object. The keyword argument named_service is a deprecated alias for this.

object_path : str

The object path of the desired object

introspect : bool

If true (default), attempt to introspect the remote object to find out supported methods and their signatures

Returns:

a dbus.proxies.ProxyObject

remove_signal_receiver(handler_or_match, signal_name=None, dbus_interface=None, bus_name=None, path=None, **keywords)
class dbus.connection.SignalMatch(conn, sender, object_path, dbus_interface, member, handler, byte_arrays=False, sender_keyword=None, path_keyword=None, interface_keyword=None, member_keyword=None, message_keyword=None, destination_keyword=None, **kwargs)

Bases: object

matches_removal_spec(sender, object_path, dbus_interface, member, handler, **kwargs)
maybe_handle_message(message)
remove()
sender
set_sender_name_owner(new_name)