Update NEWS
[dbus-python-phuang.git] / NEWS
blobe5587da0c094bebb958f453b1aeb80b3cfccf7ad
1 D-Bus Python Bindings 0.82.3 (unreleased)
2 =========================================
4 Fixes:
6 * Out-of-tree builds with an absolute $(srcdir) can now build docs and run tests
8 D-Bus Python Bindings 0.82.2 (2007-08-01)
9 =========================================
11 Incompatibility with 0.82.1:
13 * If you pass the timeout argument to call_async or an asynchronous proxy
14   method call and expect it to be in milliseconds, you should change the
15   argument to be in seconds, and require dbus-python >= 0.82.2.
17   This feature didn't work at all in versions prior to 0.82.1, so any code
18   that works with 0.82.0 or earlier is unaffected.
20 Features:
22 * @dbus.service.method supports a rel_path_keyword argument for the benefit
23   of fallback objects, which provides the method implementation with the path
24   of the object within the exported subtree. For instance, if you have a
25   fallback object exported at /Fallback, and you call a method that has
26   rel_path_keyword='rel_path' on /Fallback and on /Fallback/Some/Where, the
27   method implementation will be called with rel_path='/' and with
28   rel_path='/Some/Where' respectively. (fd.o #11623)
30 * If you have epydoc version 3 (currently in beta), API documention is now
31   generated by default.
33 Fixes:
35 * As mentioned under "Incompatibilities" above, Connection.call_async()
36   measures timeouts in seconds, as was always intended.
37   This means that calls through a proxy object with a reply_handler and
38   error_handler will measure the timeout in seconds too.
40 * Introspect() now works on objects exported in more than one location.
41   (fd.o #11794)
43 * Building against Python 2.4 on non-Debian-derived distributions, or a
44   non-default Python version on Gentoo, should work again (revenge
45   of fd.o #11282, thanks Eyal Ben David).
47 D-Bus Python Bindings 0.82.1 (2007-07-11)
48 =========================================
50 The "double precision" release.
52 Fixes:
54 * Parse the timeout correctly in send_message_with_reply() and
55   send_message_with_reply_and_block(), fixing the use of non-default timeouts
56   (bugs.fd.o #11489)
57 * The tutorial no longer uses interactive-Python syntax, as it confused users.
58   (bugs.fd.o #11209)
59 * When making a call via a proxy object with ignore_reply=True, also get the
60   necessary introspection data asynchronously. This can avoid deadlocks in
61   some cases, such as calling methods in the same process (though this is not
62   recommended, for efficiency and sanity reasons).
63 * dbus.lowlevel exposes enough constants to write correct filter functions.
64 * We don't use dbus_watch_get_fd() (deprecated in libdbus) unless our libdbus
65   is too old to have the modern replacement, dbus_watch_get_unix_fd().
67 Deprecations:
69 * Omitting the bus argument in the BusName constructor is deprecated.
70   The fact that it uses the globally shared connection to the session bus by
71   default is uncomfortably subtle.
73 D-Bus Python Bindings 0.82.0 (2007-06-19)
74 =========================================
76 Features:
78 * dbus.service.Object can start off with no Connection or object path, and
79   become exported later. If suitable class attributes are set, objects can
80   even be exported on multiple connections, or with multiple object-paths,
81   or both.
83 * dbus.service.FallbackObject implements a whole subtree of object-path space
84   (fd.o #9295).
86 * ``@method`` accepts a parameter ``connection_keyword`` so methods can find
87   out which connection to use for any follow-up actions.
89 * ``@signal`` has a new parameter ``rel_path_keyword`` which gets the path at
90   which to emit the signal, relative to the path of the FallbackObject.
91   ``path_keyword`` is now deprecated, and will raise an exception if used
92   on an object with ``SUPPORTS_MULTIPLE_OBJECT_PATHS``, including any
93   ``FallbackObject``.
95 Fixes:
97 * In watch_name_owner, only the desired name is watched!
99 * When cleaning up signal matches, errors are ignored. This avoids using up
100   scarce pending-call allowance on dbus-daemon < 1.1, and emitting error
101   messages if we get disconnected.
103 * Signal handlers which are bound to a unique name are automatically
104   disconnected when the unique name goes away, reducing the likelihood that
105   applications will leak signal matches.
107 * Some corrections were made to the tutorial (@service and @method take a
108   parameter dbus_interface, not just interface; fd.o #11209).
110 * ${PYTHON}-config is used to get the Python include path (patch from
111   Sebastien Bacher/Ubuntu, fd.o #11282).
113 D-Bus Python Bindings 0.81.1 (4 June 2007)
114 ==========================================
116 Features:
118 * When an Error message on the bus is represented as a DBusException, the
119   error name is copied into the exception and can be retrieved by
120   get_dbus_name(). Exception handlers should use this instead of looking at
121   the stringified form of the exception, unless backwards compatibility
122   is needed.
123 * DBusException objects now get all arguments from the Error message, not
124   just the first (although there will usually only be one). Use the 'args'
125   attribute if you need to retrieve them.
126 * The Connection, BusConnection and Bus classes have a method
127   list_exported_child_objects(path: str) -> list of str, which wraps
128   dbus_connection_list_registered()
129 * You can remove objects from D-Bus before they become unreferenced, by
130   using dbus.service.Object.remove_from_connection()
131   (https://bugs.freedesktop.org/show_bug.cgi?id=10457)
133 Bug fixes:
135 * Don't deadlock when removing a signal match that tracks name-owner changes.
136   (http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=426412)
137 * Include child nodes in introspection using list_exported_child_objects()
139 D-Bus Python Bindings 0.81.0 (9 May 2007)
140 =========================================
142 The 'series of tubes' release
143 -----------------------------
145 This is a feature release with support for non-bus-daemon connections
146 and improved GObject integration.
148 Features:
150 * Bus has a superclass dbus.bus.BusConnection (a connection to a bus daemon,
151   but without the shared-connection semantics or any deprecated API)
152   for the benefit of those wanting to subclass bus daemon connections
154 * BusConnection has a superclass dbus.connection.Connection (a
155   connection without a bus daemon) for use in peer-to-peer situations,
156   or distributed pseudo-bus situations without a bus daemon such as
157   Telepathy's Tubes API
159 * dbus.gobject_service.ExportedGObject is like dbus.service.Object, but
160   is also a subclass of GObject (with the necessary metaclass magic to
161   make this work). Until someone has verified that the GObject side of
162   things works as expected too, I consider this API to be potentially
163   subject to change!
165 * Connection and BusConnection have gained a number of useful methods,
166   including watch_name_owner (track name owner changes asynchronously,
167   avoiding race conditions), call_blocking and call_async (blocking and
168   asynchronous method calls without going via a proxy - note that these
169   are semi-low-level interfaces which don't do introspection), and
170   list_names, list_activatable_names and get_name_owner which are
171   simple wrappers for the corresponding org.freedesktop.DBus methods
173 * dbus.Interface (now also available at dbus.proxies.Interface)
174   and dbus.proxies.ProxyObject now have some reasonably obvious properties.
176 Deprecations:
178 * All keyword arguments called named_service are deprecated in favour of an
179   argument called bus_name (to be compatible with both older and newer
180   dbus-python, you should pass these positional arguments).
182 * The bus keyword argument to dbus.proxies.ProxyObject is deprecated in
183   favour of an argument called conn, because proxies will work on non-bus
184   connections now (again, for maximum compatibility you should use a
185   positional argument for this).
187 * No warning is raised for this, but I consider calling any remote method
188   on a ProxyObject or Interface whose name is either alllowercase or
189   lower_case_with_underscores to be deprecated, and reserve the right
190   to add properties or methods of this form in future releases - use
191   ProxyObject.get_dbus_method if you must call a remote method named in
192   this way. Methods named following TheUsualDBusConvention or
193   theJavaConvention are safe.
195 Bugfixes:
197 * Exceptions in signal handlers print a stack trace to stderr (this can
198   be redirected elsewhere with Python's logging framework). Partially
199   addresses fd.o #9980.
201 * The reserved local interface and object path are properly checked for.
203 * When you return a tuple that is not a Struct from a method with no
204   out_signature, it's interpreted as multiple return values, not a
205   single Struct (closes fd.o #10174).
207 * If send_with_reply() returns TRUE but with pending call NULL, dbus-python
208   no longer crashes. This can happen when unexpectedly disconnected.
210 * Arguments are not examined for functions declared METH_NOARGS (this is
211   unnecessary and can cause a crash).
213 Other notable changes:
215 * dbus-python uses the standard Python logging framework throughout.
216   The first time a WARNING or ERROR is generated, it will configure the
217   logging framework to output to stderr, unless you have already
218   configured logging in your application.
220 * The tutorial now advocates the use of add_signal_receiver if all you
221   want to do is listen for signals: this avoids undesired activation,
222   e.g. of Listen or Rhythmbox (!). Addresses fd.o #10743, fd.o #10568.
224 D-Bus Python Bindings 0.80.2 (13 February 2007)
225 ===============================================
226 - Fix numerous memory and reference leaks
227 - Only use -Werror if the user specifically asks for it
228 - Audit tp_dealloc callbacks to make sure they correctly preserve the
229   exception state
230 - Relicense files solely owned by Collabora Ltd. more permissively (LGPL/AFL
231   rather than GPL/AFL) - this includes the tutorial and all the C code
233 D-Bus Python Bindings 0.80.1 (24 January 2007)
234 ==============================================
235 - The "oops" release
236 - Install dbus/_version.py, so dbus.__version__ exists again
238 D-Bus Python Bindings 0.80.0 (24 January 2007)
239 ==============================================
240 - The "everything changes" release
241 - Rewrite dbus_bindings (Pyrex) as _dbus_bindings (C) - API changes!
242 - Define what's public API
243 - Move low-level but still public API to dbus.lowlevel
244 - Remove Variant class, add variant_level property on all D-Bus types
245 - Make signal matching keep working as expected when name ownership changes
246 - Use unambiguous D-Bus types when transferring from D-Bus to Python
247 - Follow well-defined rules when transferring from Python to D-Bus
248 - Add utf8_strings and byte_arrays options in various places, so a user
249   can tweak the calling conventions to be more efficient
250 - Raise RuntimeError if user tries to use a connection with no main loop
251   to do something that won't work without one
252 - Make asynchronous method calls actually asynchronous when made before
253   introspection results come back
254 - Redo main loop machinery so we can add pure-Python main loops later without
255   API breakage
256 - Allow construction of a dbus.service.Object if you don't have a BusName
257   (or even a Bus)
258 - Port introspection XML parser from libxml2 (external package) to expat
259   (included with Python)
260 - Port build system from distutils to autoconf/automake/libtool
261 - Install a header file for third-party main loop integration
262 - Make compatible with Python 2.5, including on 64-bit platforms
263 - Add docstrings throughout
264 - Add more tests and examples
265 - Add interoperability tests (which interoperate with Java)
266 - Add copyright notices!
268 D-Bus Python Bindings 0.71 (24 July 2006)
269 ==============================================================
270 - Binary modules are now installed in the correct directory
271 - Distutils exports the dbus and dbus-glib cflags
273 D-Bus Python Bindings 0.70 (17 July 2006)
274 ==============================================================
275 - First release of bindings split
276 - Move to a distutils build enviornment
277 - It is possible to now specify sender_keyword="foo", path_keyword="bar" when 
278   adding a signal listener