Skip to main content

Python bindings for libubus

Project description

Code in this directory enables a subset of libubus functions to be used directly from python.

Installation

To install these bidning you need to have the following libraries and headers installed:

  • libubox

  • libubus

  • python/python3

Examples

connect and disconnect

To connect you need to:

import ubus
ubus.connect("/var/run/ubus/ubus.sock")

To disconnect you can simply:

ubus.disconnect()

Note that calling connect()/disconnect() on opened/closed connection will throw an exception.

add

To add an object to ubus you can (you need to become root first):

def callback(handler, data):
    handler.reply(data)  # this should return exactly the same data to the caller

ubus.add(
    "my_object", {
        "my_method": {"method": callback, "signature": {
                "first": ubus.BLOBMSG_TYPE_STRING,
                "second": ubus.BLOBMSG_TYPE_BOOL,
                "third": ubus.BLOBMSG_TYPE_INT32,
        }},
     },
)

You need to enter the loop to serve the object methods afterwards:

ubus.loop()

Note that it might not be a good idea to call the callback function recursively.

objects

To list the objects which are currently connected to ubus you can call:

ubus.objects()

->

{u'my_object': {u'my_method': {u'first': 3, u'second': 7, u'third': 5}}}

call

To call an actual method on an object you can use:

ubus.call("my_object", "my_method", {"first": "my_string", "second": True, "third": 42})

->

[{"first": "my_string", "second": True, "third": 42}]

listen

To listen for an event you can:

def callback(event, data):
    print(event, data)  # just print event name and data to stdout

ubus.listen(("my_event", callback))

And you need to enter the loop to start to listen:

ubus.loop()

Note that it might not be a good idea to call the callback function recursively.

send

This will send an event to ubus:

ubus.send("my_event", {"some": "data"})

Notes

There are some tests present (‘tests/’ directory). So feel free to check it for some more complex examples. To run the tests you need to have ubus installed and become root:

sudo python setup.py test

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

ubus-0.1.2.tar.gz (20.0 kB view details)

Uploaded Source

File details

Details for the file ubus-0.1.2.tar.gz.

File metadata

  • Download URL: ubus-0.1.2.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.9

File hashes

Hashes for ubus-0.1.2.tar.gz
Algorithm Hash digest
SHA256 4dc4ef0fbcc8abb7a2354691475a58ff3eb015f1bab3150750729f7f657dd440
MD5 fb3711b0f4e71bc2fd013b3233f2ab45
BLAKE2b-256 a001af1d382ac0e031cd67773bb70cd8ada0a6af040c4d4a28bd35c851d59f23

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page