Attachment 48183 Details for Bug 26903 – A patch to add properties support, second version

[patch] A patch to add properties support, second version

Add-support-for-properties-v2.patch (text/plain), 13.59 KB, created by Marko Kohtala on 2011-06-20 03:11:24 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Marko Kohtala

Created: 2011-06-20 03:11:24 UTC

Size: 13.59 KB

patch

obsolete

>From c2a34e28e5ecb6ba28cf56297647381466325a87 Mon Sep 17 00:00:00 2001
>From: Marko Kohtala <marko.kohtala@cef.fi>
>Date: Mon, 20 Jun 2011 13:03:16 +0300
>Subject: [PATCH] Add support for properties.
>
>---
> dbus/decorators.py |   94 ++++++++++++++++++++++++++++++++++
> dbus/service.py    |  142 +++++++++++++++++++++++++++++++++++++++++++++++++---
> 2 files changed, 228 insertions(+), 8 deletions(-)
>
>diff --git a/dbus/decorators.py b/dbus/decorators.py
>index a5ca281..5f024a1 100644
>--- a/dbus/decorators.py
>+++ b/dbus/decorators.py
>@@ -338,3 +338,97 @@ def signal(dbus_interface, signature=None, path_keyword=None,
>         return emit_signal
> 
>     return decorator
>+
>+class property(object):
>+    """A decorator used to mark properties of a `dbus.service.Object`.
>+    """
>+
>+    def __init__(self, dbus_interface=None, signature=None,
>+                 property_name=None, emits_changed_signal=None,
>+                 fget=None, fset=None, doc=None):
>+        """Initialize the decorator used to mark properties of a
>+        `dbus.service.Object`.
>+
>+        :Parameters:
>+            `dbus_interface` : str
>+                The D-Bus interface owning the property
>+
>+            `signature` : str
>+                The signature of the property in the usual D-Bus notation. The
>+                signature must be suitable to be carried in a variant.
>+
>+            `property_name` : str
>+                A name for the property. Defaults to the name of the getter or
>+                setter function.
>+
>+            `emits_changed_signal` : True, False, "invalidates", or None
>+                Tells for introspection if the object emits PropertiesChanged
>+                signal.
>+
>+            `fget` : func
>+                Getter function taking the instance from which to read the
>+                property.
>+
>+            `fset` : func
>+                Setter function taking the instance to which set the property
>+                and the property value.
>+
>+            `doc` : str
>+                Documentation string for the property. Defaults to documentation
>+                string of getter function.
>+
>+                :Since: 0.85.0
>+        """
>+        validate_interface_name(dbus_interface)
>+        self._dbus_interface = dbus_interface
>+
>+        self._init_property_name = property_name
>+        if property_name is None:
>+            if fget is not None:
>+                property_name = fget.__name__
>+            elif fset is not None:
>+                property_name = fset.__name__
>+        if property_name:
>+            validate_member_name(property_name)
>+        self.__name__ = property_name
>+
>+        self._init_doc = doc
>+        if doc is None and fget is not None:
>+            doc = getattr(fget, "__doc__", None)
>+        self.fget = fget
>+        self.fset = fset
>+        self.__doc__ = doc
>+
>+        self._emits_changed_signal = emits_changed_signal
>+        if len(tuple(Signature(signature))) != 1:
>+            raise ValueError, 'signature must have only one item'
>+        self._dbus_signature = signature
>+
>+    def __get__(self, inst, type=None):
>+        if inst is None:
>+            return self
>+        if self.fget is None:
>+            raise AttributeError, "unreadable attribute"
>+        return self.fget(inst)
>+
>+    def __set__(self, inst, value):
>+        if self.fset is None:
>+            raise AttributeError, "can't set attribute"
>+        self.fset(inst, value)
>+
>+    def __call__(self, fget):
>+        return self.getter(fget)
>+
>+    def _copy(self, fget=None, fset=None):
>+        return property(dbus_interface=self._dbus_interface,
>+                        signature=self._dbus_signature,
>+                        property_name=self._init_property_name,
>+                        emits_changed_signal=self._emits_changed_signal,
>+                        fget=fget or self.fget, fset=fset or self.fset,
>+                        doc=self._init_doc)
>+
>+    def getter(self, fget):
>+        return self._copy(fget=fget)
>+
>+    def setter(self, fset):
>+        return self._copy(fset=fset)
>diff --git a/dbus/service.py b/dbus/service.py
>index b92d840..9bf43fe 100644
>--- a/dbus/service.py
>+++ b/dbus/service.py
>@@ -34,11 +34,13 @@ try:
>     import thread
> except ImportError:
>     import dummy_thread as thread
>+import __builtin__
> 
> import _dbus_bindings
> from dbus import SessionBus, Signature, Struct, validate_bus_name, \
>-                 validate_object_path, INTROSPECTABLE_IFACE, ObjectPath
>-from dbus.decorators import method, signal
>+                 validate_object_path, INTROSPECTABLE_IFACE, \
>+                 PROPERTIES_IFACE, ObjectPath
>+from dbus.decorators import method, signal, property
> from dbus.exceptions import DBusException, \
>                             NameExistsException, \
>                             UnknownMethodException
>@@ -296,6 +298,16 @@ def _method_reply_error(connection, message, exception):
> 
> class InterfaceType(type):
>     def __init__(cls, name, bases, dct):
>+        # Properties require the PropertiesInterface base.
>+        for func in dct.values():
>+            if isinstance(func, property):
>+                for b in bases:
>+                    if issubclass(b, PropertiesInterface):
>+                        break
>+                else:
>+                    bases += (PropertiesInterface,)
>+                break
>+
>         # these attributes are shared between all instances of the Interface
>         # object, so this has to be a dictionary that maps class names to
>         # the per-class introspection/interface data
>@@ -320,7 +332,7 @@ class InterfaceType(type):
> 
>         super(InterfaceType, cls).__init__(name, bases, dct)
> 
>-    # methods are different to signals, so we have two functions... :)
>+    # methods are different to signals and properties, so we have three functions... :)
>     def _reflect_on_method(cls, func):
>         args = func._dbus_args
> 
>@@ -368,9 +380,104 @@ class InterfaceType(type):
> 
>         return reflection_data
> 
>+    def _reflect_on_property(cls, descriptor):
>+        signature = descriptor._dbus_signature
>+        if signature is None:
>+            signature = 'v'
>+
>+        if descriptor.fget:
>+            if descriptor.fset:
>+                access = "readwrite"
>+            else:
>+                access = "read"
>+        elif descriptor.fset:
>+            access = "write"
>+        else:
>+            return ""
>+        reflection_data = '    <property access="%s" type="%s" name="%s"' % (access, signature, descriptor.__name__)
>+        if descriptor._emits_changed_signal is not None:
>+            value = {True: "true", False: "false", "invalidates": "invalidates"}[descriptor._emits_changed_signal]
>+            reflection_data += '>\n      <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="%s"/>\n    </property>\n' % (value,)
>+        else:
>+            reflection_data += ' />\n'
>+        return reflection_data
>+
> class Interface(object):
>     __metaclass__ = InterfaceType
> 
>+def _filter_properties(ifdict):
>+    return filter(lambda t: isinstance(t[1], property), ifdict.iteritems())
>+
>+class PropertiesInterface(Interface):
>+    """An object with properties must inherit from this interface."""
>+
>+    def _get_decorator(self, interface_name, property_name):
>+        interfaces = self._dbus_class_table[self.__class__.__module__ + '.' + self.__class__.__name__]
>+        if interface_name:
>+            interface = interfaces.get(interface_name)
>+            if interface is None:
>+                raise DBusException("No interface %s on object" % interface_name)
>+            prop = interface.get(property_name)
>+            if prop is None:
>+                raise DBusException("No property %s on object interface %s" % (property_name, interface_name))
>+            if not isinstance(prop, property):
>+                raise DBusException("Name %s on object interface %s is not a property" % (property_name, interface_name))
>+            return prop
>+        else:
>+            for interface in interfaces.itervalues():
>+                prop = interface.get(property_name)
>+                if prop and isinstance(prop, property):
>+                    return prop
>+            raise DBusException("No property %s found" % (property_name,))
>+
>+    @method(PROPERTIES_IFACE, in_signature="ss", out_signature="v")
>+    def Get(self, interface_name, property_name):
>+        """Get the value of the property on named interface. interface_name
>+        may be empty, but if there are many properties with the same name the
>+        behaviour is undefined.
>+        """
>+        prop = self._get_decorator(interface_name, property_name)
>+        if not prop.fget:
>+            raise DBusException("Property %s not readable" % property_name)
>+        return prop.fget(self)
>+
>+    @method(PROPERTIES_IFACE, in_signature="ssv")
>+    def Set(self, interface_name, property_name, value):
>+        """Set value of property on named interface to value. interface_name
>+        may be empty, but if there are many properties with the same name the
>+        behaviour is undefined.
>+        """
>+        prop = self._get_decorator(interface_name, property_name)
>+        if not prop.fset:
>+            raise DBusException("Property %s not writable" % property_name)
>+        return prop.fset(self, value)
>+
>+    @method(PROPERTIES_IFACE, in_signature="s", out_signature="a{sv}")
>+    def GetAll(self, interface_name):
>+        """Return a dictionary of all property names and values. Returns only
>+        readable properties.
>+        """
>+        interfaces = self._dbus_class_table[self.__class__.__module__ + '.' + self.__class__.__name__]
>+        if interface_name:
>+            iface = interfaces.get(interface_name)
>+            if iface is None:
>+                raise DBusException("No interface %s on object" % interface_name)
>+            ifaces = [iface]
>+        else:
>+            ifaces = interfaces.values()
>+        properties = {}
>+        for iface in ifaces:
>+            for name, prop in _filter_properties(iface):
>+                if not prop.fget or name in properties:
>+                    continue
>+                properties[name] = prop.fget(self)
>+        return properties
>+
>+    @signal(PROPERTIES_IFACE, signature='sa{sv}as')
>+    def PropertiesChanged(self, interface_name, changed_properties,
>+                          invalidated_properties):
>+        pass
>+
> #: A unique object used as the value of Object._object_path and
> #: Object._connection if it's actually in more than one place
> _MANY = object()
>@@ -379,11 +486,12 @@ class Object(Interface):
>     r"""A base class for exporting your own Objects across the Bus.
> 
>     Just inherit from Object and mark exported methods with the
>-    @\ `dbus.service.method` or @\ `dbus.service.signal` decorator.
>+    @\ `dbus.service.method`, @\ `dbus.service.signal` or
>+    @\ `dbus.service.property` decorator.
> 
>     Example::
> 
>-        class Example(dbus.service.object):
>+        class Example(dbus.service.Object):
>             def __init__(self, object_path):
>                 dbus.service.Object.__init__(self, dbus.SessionBus(), path)
>                 self._last_input = None
>@@ -392,6 +500,8 @@ class Object(Interface):
>                                  in_signature='v', out_signature='s')
>             def StringifyVariant(self, var):
>                 self.LastInputChanged(var)      # emits the signal
>+                # Emit the property changed signal
>+                self.PropertiesChanged('com.example.Sample', {'LastInput': var}, [])
>                 return str(var)
> 
>             @dbus.service.signal(interface='com.example.Sample',
>@@ -405,6 +515,20 @@ class Object(Interface):
>                                  in_signature='', out_signature='v')
>             def GetLastInput(self):
>                 return self._last_input
>+
>+            @dbus.service.property(interface='com.example.Sample',
>+                                   signature='s')
>+            def LastInput(self):
>+                return self._last_input
>+
>+            @LastInput.setter
>+            def LastInput(self, value):
>+                self._last_input = value
>+                # By default a property is expected to send the
>+                # PropertiesChanged signal when value changes.
>+                self.PropertiesChanged('com.example.Sample',
>+                                       {'LastInput': var}, [])
>+
>     """
> 
>     #: If True, this object can be made available at more than one object path.
>@@ -479,7 +603,7 @@ class Object(Interface):
>         if conn is not None and object_path is not None:
>             self.add_to_connection(conn, object_path)
> 
>-    @property
>+    @__builtin__.property
>     def __dbus_object_path__(self):
>         """The object-path at which this object is available.
>         Access raises AttributeError if there is no object path, or more than
>@@ -495,7 +619,7 @@ class Object(Interface):
>         else:
>             return self._object_path
> 
>-    @property
>+    @__builtin__.property
>     def connection(self):
>         """The Connection on which this object is available.
>         Access raises AttributeError if there is no Connection, or more than
>@@ -511,7 +635,7 @@ class Object(Interface):
>         else:
>             return self._connection
> 
>-    @property
>+    @__builtin__.property
>     def locations(self):
>         """An iterable over tuples representing locations at which this
>         object is available.
>@@ -765,6 +889,8 @@ class Object(Interface):
>                     reflection_data += self.__class__._reflect_on_method(func)
>                 elif getattr(func, '_dbus_is_signal', False):
>                     reflection_data += self.__class__._reflect_on_signal(func)
>+                elif isinstance(func, property):
>+                    reflection_data += self.__class__._reflect_on_property(func)
> 
>             reflection_data += '  </interface>\n'
> 
>-- 
>1.7.3.4
>

Actions: View | Splinter Review

Attachments on bug 26903: 35713 | 48084 | 48183 | 98993 | 112098

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.