# python-dbus-next
The next great DBus library for Python.
[Documentation](https://python-dbus-next.readthedocs.io/en/latest/)
[Chat](https://discord.gg/UdbXHVX)
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](https://pypi.org/project/dbus-next/).
```
pip3 install dbus-next
```
## The Client Interface
To use a service on the bus, the library constructs a proxy object you can use to call methods, get and set properties, and listen to signals.
For more information, see the [overview for the high-level client](https://python-dbus-next.readthedocs.io/en/latest/high-level-client/index.html).
This example connects to a media player and controls it with the [MPRIS](https://specifications.freedesktop.org/mpris-spec/latest/) DBus interface.
```python
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
To define a service on the bus, use the `ServiceInterface` class and decorate class methods to specify DBus methods, properties, and signals with their type signatures.
For more information, see the [overview for the high-level service](https://python-dbus-next.readthedocs.io/en/latest/high-level-service/index.html).
```python
from dbus_next.service 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 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'
async def main():
bus = await MessageBus().connect()
interface = ExampleInterface('test.interface')
bus.export('/test/path', interface)
# now that we are ready to handle requests, we can request name from D-Bus
await bus.request_name('test.name')
# wait indefinitely
await asyncio.get_event_loop().create_future()
asyncio.get_event_loop().run_until_complete(main())
```
## The Low-Level Interface
The low-level interface works with DBus messages directly.
For more information, see the [overview for the low-level interface](https://python-dbus-next.readthedocs.io/en/latest/low-level-interface/index.html).
```python
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())
```
## Projects that use python-dbus-next
* The [Playerctl](https://github.com/altdesktop/playerctl) test suite
* [i3-dstatus](https://github.com/altdesktop/i3-dstatus)
## Contributing
Contributions are welcome. Development happens on [Github](https://github.com/altdesktop/python-dbus-next).
Before you commit, run `make` to run the linter, code formatter, and the test suite.
# Copyright
You can use this code under an MIT license (see LICENSE).
© 2019, Tony Crisci
Raw data
{
"_id": null,
"home_page": "https://github.com/altdesktop/python-dbus-next",
"name": "dbus-next",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6.0",
"maintainer_email": "",
"keywords": "",
"author": "Tony Crisci",
"author_email": "tony@dubstepdish.com",
"download_url": "https://files.pythonhosted.org/packages/ce/45/6a40fbe886d60a8c26f480e7d12535502b5ba123814b3b9a0b002ebca198/dbus_next-0.2.3.tar.gz",
"platform": "",
"description": "\n# python-dbus-next\n\nThe next great DBus library for Python.\n\n[Documentation](https://python-dbus-next.readthedocs.io/en/latest/)\n\n[Chat](https://discord.gg/UdbXHVX)\n\npython-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.\n\nDesktop application developers can use this library for integrating their applications into desktop environments by implementing common DBus standard interfaces or creating custom plugin interfaces.\n\nDesktop users can use this library to create their own scripts and utilities to interact with those interfaces for customization of their desktop environment.\n\npython-dbus-next plans to improve over other DBus libraries for Python in the following ways:\n\n* Zero dependencies and pure Python 3.\n* Support for multiple IO backends including asyncio and the GLib main loop.\n* Nonblocking IO suitable for GUI development.\n* Target the latest language features of Python for beautiful services and clients.\n* Complete implementation of the DBus type system without ever guessing types.\n* Integration tests for all features of the library.\n* Completely documented public API.\n\n## Installing\n\nThis library is available on PyPi as [dbus-next](https://pypi.org/project/dbus-next/).\n\n```\npip3 install dbus-next\n```\n\n## The Client Interface\n\nTo use a service on the bus, the library constructs a proxy object you can use to call methods, get and set properties, and listen to signals.\n\nFor more information, see the [overview for the high-level client](https://python-dbus-next.readthedocs.io/en/latest/high-level-client/index.html).\n\nThis example connects to a media player and controls it with the [MPRIS](https://specifications.freedesktop.org/mpris-spec/latest/) DBus interface.\n\n```python\nfrom dbus_next.aio import MessageBus\n\nimport asyncio\n\nloop = asyncio.get_event_loop()\n\n\nasync def main():\n bus = await MessageBus().connect()\n # the introspection xml would normally be included in your project, but\n # this is convenient for development\n introspection = await bus.introspect('org.mpris.MediaPlayer2.vlc', '/org/mpris/MediaPlayer2')\n\n obj = bus.get_proxy_object('org.mpris.MediaPlayer2.vlc', '/org/mpris/MediaPlayer2', introspection)\n player = obj.get_interface('org.mpris.MediaPlayer2.Player')\n properties = obj.get_interface('org.freedesktop.DBus.Properties')\n\n # call methods on the interface (this causes the media player to play)\n await player.call_play()\n\n volume = await player.get_volume()\n print(f'current volume: {volume}, setting to 0.5')\n\n await player.set_volume(0.5)\n\n # listen to signals\n def on_properties_changed(interface_name, changed_properties, invalidated_properties):\n for changed, variant in changed_properties.items():\n print(f'property changed: {changed} - {variant.value}')\n\n properties.on_properties_changed(on_properties_changed)\n\n await loop.create_future()\n\nloop.run_until_complete(main())\n```\n\n## The Service Interface\n\nTo define a service on the bus, use the `ServiceInterface` class and decorate class methods to specify DBus methods, properties, and signals with their type signatures.\n\nFor more information, see the [overview for the high-level service](https://python-dbus-next.readthedocs.io/en/latest/high-level-service/index.html).\n\n```python\nfrom dbus_next.service import ServiceInterface, method, dbus_property, signal, Variant\nfrom dbus_next.aio MessageBus\n\nimport asyncio\n\nclass ExampleInterface(ServiceInterface):\n def __init__(self, name):\n super().__init__(name)\n self._string_prop = 'kevin'\n\n @method()\n def Echo(self, what: 's') -> 's':\n return what\n\n @method()\n def GetVariantDict() -> 'a{sv}':\n return {\n 'foo': Variant('s', 'bar'),\n 'bat': Variant('x', -55),\n 'a_list': Variant('as', ['hello', 'world'])\n }\n\n @dbus_property()\n def string_prop(self) -> 's':\n return self._string_prop\n\n @string_prop.setter\n def string_prop_setter(self, val: 's'):\n self._string_prop = val\n\n @signal()\n def signal_simple(self) -> 's':\n return 'hello'\n\nasync def main():\n bus = await MessageBus().connect()\n interface = ExampleInterface('test.interface')\n bus.export('/test/path', interface)\n # now that we are ready to handle requests, we can request name from D-Bus\n await bus.request_name('test.name')\n # wait indefinitely\n await asyncio.get_event_loop().create_future()\n\nasyncio.get_event_loop().run_until_complete(main())\n```\n\n## The Low-Level Interface\n\nThe low-level interface works with DBus messages directly.\n\nFor more information, see the [overview for the low-level interface](https://python-dbus-next.readthedocs.io/en/latest/low-level-interface/index.html).\n\n```python\nfrom dbus_next.message import Message, MessageType\nfrom dbus_next.aio import MessageBus\n\nimport asyncio\nimport json\n\nloop = asyncio.get_event_loop()\n\n\nasync def main():\n bus = await MessageBus().connect()\n\n reply = await bus.call(\n Message(destination='org.freedesktop.DBus',\n path='/org/freedesktop/DBus',\n interface='org.freedesktop.DBus',\n member='ListNames'))\n\n if reply.message_type == MessageType.ERROR:\n raise Exception(reply.body[0])\n\n print(json.dumps(reply.body[0], indent=2))\n\n\nloop.run_until_complete(main())\n```\n\n## Projects that use python-dbus-next\n\n* The [Playerctl](https://github.com/altdesktop/playerctl) test suite\n* [i3-dstatus](https://github.com/altdesktop/i3-dstatus)\n\n## Contributing\n\nContributions are welcome. Development happens on [Github](https://github.com/altdesktop/python-dbus-next).\n\nBefore you commit, run `make` to run the linter, code formatter, and the test suite.\n\n# Copyright\n\nYou can use this code under an MIT license (see LICENSE).\n\n\u00a9 2019, Tony Crisci\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A zero-dependency DBus library for Python with asyncio support",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://github.com/altdesktop/python-dbus-next"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d2fcc0a3f4c4eaa5a22fbef91713474666e13d0ea2a69c84532579490a9f2cc8",
"md5": "6aef374717bd305f6b79f1b28b2f1d08",
"sha256": "58948f9aff9db08316734c0be2a120f6dc502124d9642f55e90ac82ffb16a18b"
},
"downloads": -1,
"filename": "dbus_next-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6aef374717bd305f6b79f1b28b2f1d08",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.0",
"size": 57885,
"upload_time": "2021-07-25T22:11:25",
"upload_time_iso_8601": "2021-07-25T22:11:25.466973Z",
"url": "https://files.pythonhosted.org/packages/d2/fc/c0a3f4c4eaa5a22fbef91713474666e13d0ea2a69c84532579490a9f2cc8/dbus_next-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ce456a40fbe886d60a8c26f480e7d12535502b5ba123814b3b9a0b002ebca198",
"md5": "0e31605bd90f3460aebcd0bb7fe0dc20",
"sha256": "f4eae26909332ada528c0a3549dda8d4f088f9b365153952a408e28023a626a5"
},
"downloads": -1,
"filename": "dbus_next-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "0e31605bd90f3460aebcd0bb7fe0dc20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.0",
"size": 71112,
"upload_time": "2021-07-25T22:11:28",
"upload_time_iso_8601": "2021-07-25T22:11:28.398791Z",
"url": "https://files.pythonhosted.org/packages/ce/45/6a40fbe886d60a8c26f480e7d12535502b5ba123814b3b9a0b002ebca198/dbus_next-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-07-25 22:11:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "altdesktop",
"github_project": "python-dbus-next",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "dbus-next"
}
JSON
