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