Package: dbus-fast
dbus-fastA faster version of dbus-next originally from thegreat DBus next library❤️InstallationInstall this via pip (or your favourite package manager):pip install dbus-fastDocumentationdbus-fast is a Python library for DBus that aims to be a performant 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.dbus-fast plans to improve over other DBus libraries for Python in the following ways:Zero dependencies and pure Python 3An optional cython extension is available to speed up (un)marshallingFocus on performanceSupport 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.InstallingThis library is available on PyPi asdbus-fast.pip3 install dbus-fastThe Client InterfaceTo 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 theoverview for the high-level client.This example connects to a media player and controls it with theMPRISDBus interface.fromdbus_fast.aioimportMessageBusimportasyncioasyncdefmain():bus=awaitMessageBus().connect()# the introspection xml would normally be included in your project, but# this is convenient for developmentintrospection=awaitbus.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)awaitplayer.call_play()volume=awaitplayer.get_volume()print(f'current volume:{volume}, setting to 0.5')awaitplayer.set_volume(0.5)# listen to signalsdefon_properties_changed(interface_name,changed_properties,invalidated_properties):forchanged,variantinchanged_properties.items():print(f'property changed:{changed}-{variant.value}')properties.on_properties_changed(on_properties_changed)awaitasyncio.Event().wait()asyncio.run(main())The Service InterfaceTo define a service on the bus, use theServiceInterfaceclass and decorate class methods to specify DBus methods, properties, and signals with their type signatures.For more information, see theoverview for the high-level service.fromdbus_fast.serviceimportServiceInterface,method,dbus_property,signal,Variantfromdbus_fast.aioMessageBusimportasyncioclassExampleInterface(ServiceInterface):def__init__(self,name):super().__init__(name)self._string_prop='kevin'@method()defEcho(self,what:'s')->'s':returnwhat@method()defGetVariantDict()->'a{sv}':return{'foo':Variant('s','bar'),'bat':Variant('x',-55),'a_list':Variant('as',['hello','world'])}@dbus_property()defstring_prop(self)->'s':returnself._string_prop@string_prop.setterdefstring_prop_setter(self,val:'s'):self._string_prop=val@signal()defsignal_simple(self)->'s':return'hello'asyncdefmain():bus=awaitMessageBus().connect()interface=ExampleInterface('test.interface')bus.export('/test/path',interface)# now that we are ready to handle requests, we can request name from D-Busawaitbus.request_name('test.name')# wait indefinitelyawaitasyncio.Event().wait()asyncio.run(main())The Low-Level InterfaceThe low-level interface works with DBus messages directly.For more information, see theoverview for the low-level interface.fromdbus_fast.messageimportMessage,MessageTypefromdbus_fast.aioimportMessageBusimportasyncioimportjsonasyncdefmain():bus=awaitMessageBus().connect()reply=awaitbus.call(Message(destination='org.freedesktop.DBus',path='/org/freedesktop/DBus',interface='org.freedesktop.DBus',member='ListNames'))ifreply.message_type==MessageType.ERROR:raiseException(reply.body[0])print(json.dumps(reply.body[0],indent=2))asyncio.run(main())Projects that use python-dbus-fastBluetooth AdaptersContributingContributions are welcome. Development happens onGithub.Before you commit, runpre-commit run --all-filesto run the linter, code formatter, and the test suite.CopyrightYou can use this code under an MIT license (see LICENSE).© 2019, Tony Crisci© 2022, Bluetooth Devices authorsContributors ✨Thanks goes to these wonderful people (emoji key):This project follows theall-contributorsspecification. Contributions of any kind welcome!CreditsThis package was created withCookiecutterand thebrowniebroke/cookiecutter-pypackageproject template.