A zero-dependency DBus library for Python with asyncio support
Project description
python-dbus-next
The next great DBus library for Python.
This project is in the early stages of development and the public api is unstable
python-dbus-next is a Python library for DBus that aims to be a fully featured high level library primarily geared towards integration of applications into Linux desktop and mobile environments.
Desktop application developers can use this library for integrating their applications into desktop environments by implementing common DBus standard interfaces or creating custom plugin interfaces.
Desktop users can use this library to create their own scripts and utilities to interact with those interfaces for customization of their desktop environment.
python-dbus-next plans to improve over other DBus libraries for Python in the following ways:
- Zero dependencies and pure Python 3.
- Support for multiple IO backends including asyncio and the GLib main loop.
- Nonblocking IO suitable for GUI development.
- Target the latest language features of Python for beautiful services and clients.
- Complete implementation of the DBus type system without ever guessing types.
- Integration tests for all features of the library.
- Completely documented public API.
Installing
This library is available on PyPi as dbus-next.
pip3 install dbus-next
The Client Interface
The client interface is unstable
from dbus_next.aio import MessageBus
import asyncio
loop = asyncio.get_event_loop()
async def main():
bus = await MessageBus().connect()
# the introspection xml would normally be included in your project, but
# this is convenient for development
introspection = await bus.introspect('org.mpris.MediaPlayer2.vlc', '/org/mpris/MediaPlayer2')
obj = bus.get_proxy_object('org.mpris.MediaPlayer2.vlc', '/org/mpris/MediaPlayer2', introspection)
player = obj.get_interface('org.mpris.MediaPlayer2.Player')
properties = obj.get_interface('org.freedesktop.DBus.Properties')
# call methods on the interface (this causes the media player to play)
await player.call_play()
volume = await player.get_volume()
print(f'current volume: {volume}, setting to 0.5')
await player.set_volume(0.5)
# listen to signals
def on_properties_changed(interface_name, changed_properties, invalidated_properties):
for changed, variant in changed_properties.items():
print(f'property changed: {changed} - {variant.value}')
properties.on_properties_changed(on_properties_changed)
await loop.create_future()
loop.run_until_complete(main())
The Service Interface
The service interface is unstable
from dbus_next import ServiceInterface, method, dbus_property, signal, Variant
from dbus_next.aio MessageBus
import asyncio
class ExampleInterface(ServiceInterface):
def __init__(self, name):
super().__init__(name)
self._string_prop = 'kevin'
@method()
def Echo(self, what: 's') -> 's':
return what
@method()
def EchoMultiple(self, what1: 's', what2: 's') -> 'ss':
return [what1, what2]
@method()
def GetVariantDict() -> 'a{sv}':
return {
'foo': Variant('s', 'bar'),
'bat': Variant('x', -55),
'a_list': Variant('as', ['hello', 'world'])
}
@dbus_property()
def string_prop(self) -> 's':
return self._string_prop
@string_prop.setter
def string_prop_setter(self, val: 's'):
self._string_prop = val
@signal()
def signal_simple(self) -> 's':
return 'hello'
@signal()
def signal_multiple(self) -> 'ss':
return ['hello', 'world']
async def main():
bus = await MessageBus().connect()
await bus.request_name('test.name')
interface = ExampleInterface('test.interface')
bus.export('/test/path', interface)
await asyncio.get_event_loop().create_future()
asyncio.get_event_loop().run_until_complete(main())
The Low-Level Interface
The low-level interface is unstable
from dbus_next.message import Message, MessageType
from dbus_next.aio import MessageBus
import asyncio
import json
loop = asyncio.get_event_loop()
async def main():
bus = await MessageBus().connect()
reply = await bus.call(
Message(destination='org.freedesktop.DBus',
path='/org/freedesktop/DBus',
interface='org.freedesktop.DBus',
member='ListNames'))
if reply.message_type == MessageType.ERROR:
raise Exception(reply.body[0])
print(json.dumps(reply.body[0], indent=2))
loop.run_until_complete(main())
Contributing
Contributions are welcome. Development happens on Github.
TODO
- properties cache
- documentation
Copyright
You can use this code under an MIT license (see LICENSE).
© 2019, Tony Crisci
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dbus_next-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69f3ea1693eccec1bafea74f44beba7b883b17f6b0d070c9d056b1ed01975455 |
|
MD5 | de626648c546a71044294f053a22a737 |
|
BLAKE2b-256 | 43321aae81f09bd656d5d2c87fd481fb65f40d7da393d591df17c8231531003e |