No project description provided
Project description
dbus-objects
![codecov](https://pypi-camo.freetls.fastly.net/bc7b971fcb099be6fcc76b3ec69c78a074a804b4/68747470733a2f2f636f6465636f762e696f2f67682f46465930302f646275732d6f626a656374732f6272616e63682f6d61737465722f67726170682f62616467652e737667)
DBus objects implementation on top of the Python type system.
Integrations:
import random
from typing import List
import dbus_objects.object
import dbus_objects.integration.jeepney
class ExampleObject(dbus_objects.object.DBusObject):
def __init__(self):
super().__init__(default_interface_root='io.github.ffy00.dbus_objects.example')
self._bets = []
@dbus_objects.object.dbus_method()
def ping(self) -> str:
return 'Pong!'
@dbus_objects.object.dbus_method()
def print(self, msg: str) -> None:
print(msg)
@dbus_objects.object.dbus_method()
def sum(self, a: int, b: int) -> int:
return a + b
@dbus_objects.object.dbus_method()
def save_bet(self, number: int) -> None:
self._bets.append(number)
@dbus_objects.object.dbus_method()
def get_bets(self) -> List[int]:
return self._bets
@dbus_objects.object.dbus_method()
def lotery(self) -> int:
winner = random.choice(self._bets)
self._bets = []
return winner
server = dbus_objects.integration.jeepney.BlockingDBusServer(
bus='SESSION',
name='io.github.ffy00.dbus-objects'
)
server.register_object('/io/github/ffy00/dbus_objects/example', ExampleObject())
server.listen()
This example will generate the following server topology:
paths
├── /
│ ├── org.freedesktop.DBus.Introspectable
│ │ └── Introspect
│ └── org.freedesktop.DBus.Peer
│ └── Ping
├── /io
│ ├── org.freedesktop.DBus.Introspectable
│ │ └── Introspect
│ └── org.freedesktop.DBus.Peer
│ └── Ping
├── /io/github
│ ├── org.freedesktop.DBus.Introspectable
│ │ └── Introspect
│ └── org.freedesktop.DBus.Peer
│ └── Ping
├── /io/github/ffy00
│ ├── org.freedesktop.DBus.Introspectable
│ │ └── Introspect
│ └── org.freedesktop.DBus.Peer
│ └── Ping
├── /io/github/ffy00/dbus_objects
│ ├── org.freedesktop.DBus.Introspectable
│ │ └── Introspect
│ └── org.freedesktop.DBus.Peer
│ └── Ping
└── /io/github/ffy00/dbus_objects/example
├── io.github.ffy00.dbus_objects.example.ExampleObject
│ ├── GetBets
│ ├── Lotery
│ ├── Ping
│ ├── Print
│ ├── SaveBet
│ └── Sum
├── org.freedesktop.DBus.Introspectable
│ └── Introspect
├── org.freedesktop.DBus.Peer
│ └── Ping
└── org.freedesktop.DBus.Properties
├── Get
├── GetAll
└── Set
And, for eg., the following DBus introspection XML for /io/github/ffy00/dbus_objects/example
:
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" >
<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name="io.github.ffy00.dbus_objects.example.ExampleObject">
<method name="GetBets">
<arg direction="out" type="ai" />
</method>
<method name="Lotery">
<arg direction="out" type="i" />
</method>
<method name="Ping">
<arg direction="out" type="s" />
</method>
<method name="Print">
<arg direction="in" type="s" name="msg" />
</method>
<method name="SaveBet">
<arg direction="in" type="i" name="number" />
</method>
<method name="Sum">
<arg direction="in" type="i" name="a" />
<arg direction="in" type="i" name="b" />
<arg direction="out" type="i" />
</method>
</interface>
<interface name="org.freedesktop.DBus.Properties">
<method name="GetAll">
<arg direction="in" type="s" name="interface_name" />
<arg direction="out" type="a{sv}" />
</method>
</interface>
<interface name="org.freedesktop.DBus.Introspectable">
<method name="Introspect">
<arg direction="out" type="s" name="xml" />
</method>
</interface>
<interface name="org.freedesktop.DBus.Peer">
<method name="Ping" />
</interface>
</node>
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
dbus-objects-0.0.1b2.tar.gz
(13.2 kB
view hashes)
Built Distribution
Close
Hashes for dbus_objects-0.0.1b2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f54f65250a66b87a23b662290a3b9a1cb2ec1b406c07f7ac93ea3018e31d556 |
|
MD5 | 385ec1c14b05e25b857bf3502e8709cb |
|
BLAKE2b-256 | dd6f2cbba344420c02207f0c8998c3b0a6f1547d8bcd8807f158b9e8f083ce53 |