Qt for Python DBusIntegration: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:LanguageBindings::PySide]]
[[Category:Qt for Python]]


= PySide D-Bus Integration =
To get PySide2 and DBus working together you can use the glib mainloop integration already done in [https://pypi.org/project/dbus-python/ dbus-python].


To get PySide and DBus working toghether you can use the glib mainloop integration already done in pydbus.
The examples below show how to export Qt objects to Python and emit a D-Bus signal when a Qt signal is emitted.
The code comments explain what you need to know about PySide2 and D-Bus.


The examples below show how to export Qt objects to Python and emit a D-Bus signal when a Qt signal is emitted. The code comments explain what you need to know about PySide and D-Bus.
Also refer to the [http://dbus.freedesktop.org/doc/dbus-python/doc/tutorial.html dbus-python tutorial].


Also refer to the "dbus-python tutorial":http://dbus.freedesktop.org/doc/dbus-python/doc/tutorial.html.
== D-Bus Client ==


== D-Bus Client ==
<syntaxhighlight lang="python" line='line'>
#!/usr/bin/env python
# -'''- coding: utf-8 -'''-
 
# DBUS Client using PySide2 integration
 
import sys
from traceback import print_exc
 
# import python dbus module
import dbus
# import python dbus GLib mainloop support
import dbus.mainloop.glib
# import QtCore
from PySide2.QtCore import *


<code><br />#!/usr/bin/env python<br /># <s>'''- coding: utf-8 <s>'''-
# signal handler
<br /># DBUS Client using PySide integration
def button_clicked():
<br />import sys<br />from traceback import print_exc
    print("button clicked")
<br /># import python dbus module<br />import dbus<br /># import python dbus GLib mainloop support<br />import dbus.mainloop.glib<br /># import QtCore<br />from PySide.QtCore import'''
<br /># signal handler<br />def button_clicked():<br /> print &quot;button clicked&amp;quot;
<br /># main function<br />if ''name'' == '''main''':
<br /> # Enable glib main loop support<br /> dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)<br /> # Get the session bus<br /> bus = dbus.SessionBus()
<br /> try:<br /> # Get the remote object<br /> remote_object = bus.get_object(&quot;com.example.SampleService&amp;quot;,<br /> &quot;/DBusWidget&amp;quot;)<br /> # Get the remote interface for the remote object<br /> iface = dbus.Interface(remote_object, &quot;com.example.SampleWidget&amp;quot;)<br /> except dbus.DBusException:<br /> print_exc()<br /> sys.exit(1)
<br /> # Start the application<br /> app = QCoreApplication([])
<br /> # Call some methods of the remote interface<br /> iface.show()<br /> iface.setText(&quot;Emit signal&amp;quot;)<br /> # connect the DBus signal clicked to the function button_clicked<br /> iface.connect_to_signal(&quot;clicked&amp;quot;, button_clicked)<br /> iface.connect_to_signal(&quot;lastWindowClosed&amp;quot;, app.quit)
<br /> # enter in the main loop<br /> app.exec_()<br /></code>
<br />h3. D-Bus Server
<br /><code><br />#!/usr/bin/env python<br />#</s>'''</s> coding: utf-8 -'''-
<br /># DBUS Server Example of use PySide with PyDBus library
<br />import dbus<br />import dbus.service<br />import dbus.mainloop.glib<br />import random
<br />from PySide.QtCore import'''<br />from PySide.QtGui import QPushButton, QApplication


# The adaptor, MUST inherit dbus.service.Object<br />class DBusWidget(dbus.service.Object):<br /> def ''init''(self, name, session):<br /> # export this object to dbus<br /> dbus.service.Object.''init''(self, name, session)
# main function
if __name__ == '__main__':
    # Enable glib main loop support
    dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
    # Get the session bus
    bus = dbus.SessionBus()
   
    try:
        # Get the remote object
        remote_object = bus.get_object("com.example.SampleService",
        "/DBusWidget")
        # Get the remote interface for the remote object
        iface = dbus.Interface(remote_object, "com.example.SampleWidget")
    except dbus.DBusException:
        print_exc()
        sys.exit(1)
   
    # Start the application
    app = QCoreApplication([])
   
    # Call some methods of the remote interface
    iface.show()
    iface.setText("Emit signal")
    # connect the DBus signal clicked to the function button_clicked
    iface.connect_to_signal("clicked", button_clicked)
    iface.connect_to_signal("lastWindowClosed", app.quit)
   
    # enter in the main loop
    app.exec_()


# create a simple widget<br /> self.widget = QPushButton()<br /> self.widget.resize(200, 50)
</syntaxhighlight>


# To export a Qt signal as a DBus-signal, you need to connect it to a method in this class.<br /> # The method MUST have the signal annotation, so python-dbus will export it as a dbus-signal<br /> QObject.connect(self.widget, SIGNAL (&amp;quot;clicked()&quot;), self.clicked)<br /> QObject.connect(QApplication.instance(), SIGNAL (&amp;quot;lastWindowClosed()&quot;), self.lastWindowClosed)
=== D-Bus Server ===
<syntaxhighlight lang="python" line='line'>
#!/usr/bin/env python
#-'''- coding: utf-8 -'''-


# You can export methods to dbus like you do in python-dbus.<br /> &amp;#64;dbus.service.method(&quot;com.example.SampleWidget&amp;quot;, in_signature='', out_signature='')<br /> def show(self):<br /> self.widget.show()
# DBUS Server Example of use PySide2 with dbus-python library


# Another method… now with a parameter<br /> &amp;#64;dbus.service.method(&quot;com.example.SampleWidget&amp;quot;, in_signature='s', out_signature='')<br /> def setText(self, value):<br /> self.widget.setText(value)
import dbus
import dbus.service
import dbus.mainloop.glib
import random


# Another one…<br /> &amp;#64;dbus.service.method(&quot;com.example.SampleWidget&amp;quot;, in_signature='', out_signature='')<br /> def exit(self):<br /> qApp().quit()
from PySide2.QtCore import *
from PySide2.QtWidgets import QPushButton, QApplication


# A signal that will be exported to dbus<br /> &amp;#64;dbus.service.signal(&quot;com.example.SampleWidget&amp;quot;, signature='')<br /> def clicked(self):<br /> pass
# The adaptor, MUST inherit dbus.service.Object
class DBusWidget(dbus.service.Object):
    def __init__(self, name, session):
        # export this object to dbus
        dbus.service.Object.__init__(self, name, session)


# Another signal that will be exported to dbus<br /> &amp;#64;dbus.service.signal(&quot;com.example.SampleWidget&amp;quot;, signature='')<br /> def lastWindowClosed(self):<br /> pass
        # create a simple widget
        self.widget = QPushButton()
        self.widget.resize(200, 50)


if ''name'' == '''main''':<br /> app = QApplication([])<br /> # Use qt/glib mainloop integration to get dbus mainloop working<br /> dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
        # To export a Qt signal as a DBus-signal, you need to connect it to
        # a method in this class.
        # The method MUST have the signal annotation, so dbus-python will
        # export it as a dbus-signal
        QObject.connect(self.widget, SIGNAL ("clicked()"), self.clicked)
        QObject.connect(QApplication.instance(), SIGNAL ("lastWindowClosed()"),
            self.lastWindowClosed)


session_bus = dbus.SessionBus()<br /> # Export the service<br /> name = dbus.service.BusName(&quot;com.example.SampleService&amp;quot;, session_bus)<br /> # Export the object<br /> widget = DBusWidget(session_bus, '/DBusWidget')
    # You can export methods to dbus like you do in python-dbus.
    @dbus.service.method("com.example.SampleWidget", in_signature='', out_signature='')
    def show(self):
        self.widget.show()
   
    # Another method… now with a parameter
    @dbus.service.method("com.example.SampleWidget", in_signature='s', out_signature='')
    def setText(self, value):
        self.widget.setText(value)
   
    # Another one…
    @dbus.service.method("com.example.SampleWidget", in_signature='', out_signature='')
    def exit(self):
        qApp().quit()
   
    # A signal that will be exported to dbus
    @dbus.service.signal("com.example.SampleWidget", signature='')
    def clicked(self):
        pass
   
    # Another signal that will be exported to dbus
    @dbus.service.signal("com.example.SampleWidget", signature='')
    def lastWindowClosed(self):
        pass


print &quot;Running example service.&quot;<br /> app.exec_()<br /></code>
if __name__ == "__main__":
    print("holi")
    app = QApplication([])
    # Use qt/glib mainloop integration to get dbus mainloop working
    dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
   
    session_bus = dbus.SessionBus()
    print(session_bus)
    # Export the service
    name = dbus.service.BusName("com.example.SampleService", session_bus)
    # Export the object
    widget = DBusWidget(session_bus, '/DBusWidget')
   
    print("Running
</syntaxhighlight>


=== Running the examples ===
=== Running the examples ===
Line 54: Line 140:
Copy the client code to a file called example-client.py and the server to a file called example-server.py and type:
Copy the client code to a file called example-client.py and the server to a file called example-server.py and type:


<code><br />python example-server.py &amp;<br />python example-client.py<br /></code>
<code>
python example-server.py &
python example-client.py
</code>


A small window should appear on screen. Click on the button to emit a Qt signal. The signal will be converted to a D-Bus signal that will be caught by our D-Bus client.
A small window should appear on screen. Click on the button to emit a Qt signal. The signal will be converted to a D-Bus signal that will be caught by our D-Bus client.

Latest revision as of 15:11, 27 May 2018


To get PySide2 and DBus working together you can use the glib mainloop integration already done in dbus-python.

The examples below show how to export Qt objects to Python and emit a D-Bus signal when a Qt signal is emitted. The code comments explain what you need to know about PySide2 and D-Bus.

Also refer to the dbus-python tutorial.

D-Bus Client

#!/usr/bin/env python
# -'''- coding: utf-8 -'''-

# DBUS Client using PySide2 integration

import sys
from traceback import print_exc

# import python dbus module
import dbus
# import python dbus GLib mainloop support
import dbus.mainloop.glib
# import QtCore
from PySide2.QtCore import *

# signal handler
def button_clicked():
    print("button clicked")

# main function
if __name__ == '__main__':
    # Enable glib main loop support
    dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
    # Get the session bus
    bus = dbus.SessionBus()
    
    try:
        # Get the remote object
        remote_object = bus.get_object("com.example.SampleService",
        "/DBusWidget")
        # Get the remote interface for the remote object
        iface = dbus.Interface(remote_object, "com.example.SampleWidget")
    except dbus.DBusException:
        print_exc()
        sys.exit(1)
    
    # Start the application
    app = QCoreApplication([])
    
    # Call some methods of the remote interface
    iface.show()
    iface.setText("Emit signal")
    # connect the DBus signal clicked to the function button_clicked
    iface.connect_to_signal("clicked", button_clicked)
    iface.connect_to_signal("lastWindowClosed", app.quit)
    
    # enter in the main loop
    app.exec_()

D-Bus Server

#!/usr/bin/env python
#-'''- coding: utf-8 -'''-

# DBUS Server Example of use PySide2 with dbus-python library

import dbus
import dbus.service
import dbus.mainloop.glib
import random

from PySide2.QtCore import *
from PySide2.QtWidgets import QPushButton, QApplication

# The adaptor, MUST inherit dbus.service.Object
class DBusWidget(dbus.service.Object):
    def __init__(self, name, session):
        # export this object to dbus
        dbus.service.Object.__init__(self, name, session)

        # create a simple widget
        self.widget = QPushButton()
        self.widget.resize(200, 50)

        # To export a Qt signal as a DBus-signal, you need to connect it to
        # a method in this class.
        # The method MUST have the signal annotation, so dbus-python will
        # export it as a dbus-signal
        QObject.connect(self.widget, SIGNAL ("clicked()"), self.clicked)
        QObject.connect(QApplication.instance(), SIGNAL ("lastWindowClosed()"),
            self.lastWindowClosed)

    # You can export methods to dbus like you do in python-dbus.
    @dbus.service.method("com.example.SampleWidget", in_signature='', out_signature='')
    def show(self):
        self.widget.show()
    
    # Another method… now with a parameter
    @dbus.service.method("com.example.SampleWidget", in_signature='s', out_signature='')
    def setText(self, value):
        self.widget.setText(value)
    
    # Another one…
    @dbus.service.method("com.example.SampleWidget", in_signature='', out_signature='')
    def exit(self):
        qApp().quit()
    
    # A signal that will be exported to dbus
    @dbus.service.signal("com.example.SampleWidget", signature='')
    def clicked(self):
        pass
    
    # Another signal that will be exported to dbus
    @dbus.service.signal("com.example.SampleWidget", signature='')
    def lastWindowClosed(self):
        pass

if __name__ == "__main__":
    print("holi")
    app = QApplication([])
    # Use qt/glib mainloop integration to get dbus mainloop working
    dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
    
    session_bus = dbus.SessionBus()
    print(session_bus)
    # Export the service
    name = dbus.service.BusName("com.example.SampleService", session_bus)
    # Export the object
    widget = DBusWidget(session_bus, '/DBusWidget')
    
    print("Running

Running the examples

Copy the client code to a file called example-client.py and the server to a file called example-server.py and type:

python example-server.py &
python example-client.py

A small window should appear on screen. Click on the button to emit a Qt signal. The signal will be converted to a D-Bus signal that will be caught by our D-Bus client.