Mark Bus.get_connection() as deprecated; improve Bus.__repr__
[dbus-python-phuang.git] / NEWS
blobbb515eaa2d2289cc27dd7ab9e57b2b3030f585e2
1 D-Bus Python Bindings 0.82.0 (unreleased)
2 =========================================
4 Features:
6 * dbus.service.Object can start off with no Connection or object path, and
7   become exported later. If suitable class attributes are set, objects can
8   even be exported on multiple connections, or with multiple object-paths,
9   or both.
11 * dbus.service.FallbackObject implements a whole subtree of object-path space
12   (fd.o #9295).
14 * ``@method`` accepts a parameter ``connection_keyword`` so methods can find
15   out which connection to use for any follow-up actions.
17 * ``@signal`` has a new parameter ``rel_path_keyword`` which gets the path at
18   which to emit the signal, relative to the path of the FallbackObject.
19   ``path_keyword`` is now deprecated, and will raise an exception if used
20   on an object with ``SUPPORTS_MULTIPLE_OBJECT_PATHS``, including any
21   ``FallbackObject``.
23 Fixes:
25 * In watch_name_owner, only the desired name is watched!
27 * When cleaning up signal matches, errors are ignored. This avoids using up
28   scarce pending-call allowance on dbus-daemon < 1.1, and emitting error
29   messages if we get disconnected.
31 * Signal handlers which are bound to a unique name are automatically
32   disconnected when the unique name goes away, reducing the likelihood that
33   applications will leak signal matches.
35 * Some corrections were made to the tutorial (@service and @method take a
36   parameter dbus_interface, not just interface; fd.o #11209).
38 * ${PYTHON}-config is used to get the Python include path (patch from
39   Sebastien Bacher/Ubuntu, fd.o #11282).
41 D-Bus Python Bindings 0.81.1 (4 June 2007)
42 ==========================================
44 Features:
46 * When an Error message on the bus is represented as a DBusException, the
47   error name is copied into the exception and can be retrieved by
48   get_dbus_name(). Exception handlers should use this instead of looking at
49   the stringified form of the exception, unless backwards compatibility
50   is needed.
51 * DBusException objects now get all arguments from the Error message, not
52   just the first (although there will usually only be one). Use the 'args'
53   attribute if you need to retrieve them.
54 * The Connection, BusConnection and Bus classes have a method
55   list_exported_child_objects(path: str) -> list of str, which wraps
56   dbus_connection_list_registered()
57 * You can remove objects from D-Bus before they become unreferenced, by
58   using dbus.service.Object.remove_from_connection()
59   (https://bugs.freedesktop.org/show_bug.cgi?id=10457)
61 Bug fixes:
63 * Don't deadlock when removing a signal match that tracks name-owner changes.
64   (http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=426412)
65 * Include child nodes in introspection using list_exported_child_objects()
67 D-Bus Python Bindings 0.81.0 (9 May 2007)
68 =========================================
70 The 'series of tubes' release
71 -----------------------------
73 This is a feature release with support for non-bus-daemon connections
74 and improved GObject integration.
76 Features:
78 * Bus has a superclass dbus.bus.BusConnection (a connection to a bus daemon,
79   but without the shared-connection semantics or any deprecated API)
80   for the benefit of those wanting to subclass bus daemon connections
82 * BusConnection has a superclass dbus.connection.Connection (a
83   connection without a bus daemon) for use in peer-to-peer situations,
84   or distributed pseudo-bus situations without a bus daemon such as
85   Telepathy's Tubes API
87 * dbus.gobject_service.ExportedGObject is like dbus.service.Object, but
88   is also a subclass of GObject (with the necessary metaclass magic to
89   make this work). Until someone has verified that the GObject side of
90   things works as expected too, I consider this API to be potentially
91   subject to change!
93 * Connection and BusConnection have gained a number of useful methods,
94   including watch_name_owner (track name owner changes asynchronously,
95   avoiding race conditions), call_blocking and call_async (blocking and
96   asynchronous method calls without going via a proxy - note that these
97   are semi-low-level interfaces which don't do introspection), and
98   list_names, list_activatable_names and get_name_owner which are
99   simple wrappers for the corresponding org.freedesktop.DBus methods
101 * dbus.Interface (now also available at dbus.proxies.Interface)
102   and dbus.proxies.ProxyObject now have some reasonably obvious properties.
104 Deprecations:
106 * All keyword arguments called named_service are deprecated in favour of an
107   argument called bus_name (to be compatible with both older and newer
108   dbus-python, you should pass these positional arguments).
110 * The bus keyword argument to dbus.proxies.ProxyObject is deprecated in
111   favour of an argument called conn, because proxies will work on non-bus
112   connections now (again, for maximum compatibility you should use a
113   positional argument for this).
115 * No warning is raised for this, but I consider calling any remote method
116   on a ProxyObject or Interface whose name is either alllowercase or
117   lower_case_with_underscores to be deprecated, and reserve the right
118   to add properties or methods of this form in future releases - use
119   ProxyObject.get_dbus_method if you must call a remote method named in
120   this way. Methods named following TheUsualDBusConvention or
121   theJavaConvention are safe.
123 Bugfixes:
125 * Exceptions in signal handlers print a stack trace to stderr (this can
126   be redirected elsewhere with Python's logging framework). Partially
127   addresses fd.o #9980.
129 * The reserved local interface and object path are properly checked for.
131 * When you return a tuple that is not a Struct from a method with no
132   out_signature, it's interpreted as multiple return values, not a
133   single Struct (closes fd.o #10174).
135 * If send_with_reply() returns TRUE but with pending call NULL, dbus-python
136   no longer crashes. This can happen when unexpectedly disconnected.
138 * Arguments are not examined for functions declared METH_NOARGS (this is
139   unnecessary and can cause a crash).
141 Other notable changes:
143 * dbus-python uses the standard Python logging framework throughout.
144   The first time a WARNING or ERROR is generated, it will configure the
145   logging framework to output to stderr, unless you have already
146   configured logging in your application.
148 * The tutorial now advocates the use of add_signal_receiver if all you
149   want to do is listen for signals: this avoids undesired activation,
150   e.g. of Listen or Rhythmbox (!). Addresses fd.o #10743, fd.o #10568.
152 D-Bus Python Bindings 0.80.2 (13 February 2007)
153 ===============================================
154 - Fix numerous memory and reference leaks
155 - Only use -Werror if the user specifically asks for it
156 - Audit tp_dealloc callbacks to make sure they correctly preserve the
157   exception state
158 - Relicense files solely owned by Collabora Ltd. more permissively (LGPL/AFL
159   rather than GPL/AFL) - this includes the tutorial and all the C code
161 D-Bus Python Bindings 0.80.1 (24 January 2007)
162 ==============================================
163 - The "oops" release
164 - Install dbus/_version.py, so dbus.__version__ exists again
166 D-Bus Python Bindings 0.80.0 (24 January 2007)
167 ==============================================
168 - The "everything changes" release
169 - Rewrite dbus_bindings (Pyrex) as _dbus_bindings (C) - API changes!
170 - Define what's public API
171 - Move low-level but still public API to dbus.lowlevel
172 - Remove Variant class, add variant_level property on all D-Bus types
173 - Make signal matching keep working as expected when name ownership changes
174 - Use unambiguous D-Bus types when transferring from D-Bus to Python
175 - Follow well-defined rules when transferring from Python to D-Bus
176 - Add utf8_strings and byte_arrays options in various places, so a user
177   can tweak the calling conventions to be more efficient
178 - Raise RuntimeError if user tries to use a connection with no main loop
179   to do something that won't work without one
180 - Make asynchronous method calls actually asynchronous when made before
181   introspection results come back
182 - Redo main loop machinery so we can add pure-Python main loops later without
183   API breakage
184 - Allow construction of a dbus.service.Object if you don't have a BusName
185   (or even a Bus)
186 - Port introspection XML parser from libxml2 (external package) to expat
187   (included with Python)
188 - Port build system from distutils to autoconf/automake/libtool
189 - Install a header file for third-party main loop integration
190 - Make compatible with Python 2.5, including on 64-bit platforms
191 - Add docstrings throughout
192 - Add more tests and examples
193 - Add interoperability tests (which interoperate with Java)
194 - Add copyright notices!
196 D-Bus Python Bindings 0.71 (24 July 2006)
197 ==============================================================
198 - Binary modules are now installed in the correct directory
199 - Distutils exports the dbus and dbus-glib cflags
201 D-Bus Python Bindings 0.70 (17 July 2006)
202 ==============================================================
203 - First release of bindings split
204 - Move to a distutils build enviornment
205 - It is possible to now specify sender_keyword="foo", path_keyword="bar" when 
206   adding a signal listener