Update docs and version string for 0.5.5 release

git-svn-id: https://katfs.kat.ac.za/svnDS/code/katcp-python/trunk@21717 b56c7a7d-ac47-0410-a905-b6f7de78896a

CHANGELOG

@@ -1,3 +1,18 @@
+14 July 2014 (0.5.5)
+ * Add utility code to katcp.version.py that other modules can use to parse svn
+   or git revisions for use in build-state informs or sensors
+ * Add katcp.client.request_check: a convenience function for making KATCP
+   requests and raising an exception if there is an error.
+ * Add katcp.testutils.handle_mock_req() to allow mocked testing of server request
+   handlers and dispatch, removing the need to start() a DeviceServer for
+   handler tests.
+ * Make katcp.testutils.WaitingMock robust against race conditions
+ * Explicitly list set of base KATCP requests in katcp.server.BASE_REQUESTS
+ * Make method-name to KATCP-name function available outside KATCP server
+   meta-class
+ * Improvements to logging (i.a. prevents issues when using SocketHandler)
+ * Docstring cleanups
+
 10 June 2013 (0.5.4)
  * Change event-rate strategy to always send an update if the sensor has
    changed and shortest-period has passed

doc/releasenotes.rst

@@ -4,6 +4,16 @@
 Release Notes
 *************
 
+See also :download:`CHANGELOG` for more details on chages.
+
+0.5.5
+=====
+
+* Various cleanups (logging, docstrings, base request set, minor refactoring)
+* Improvements to testing utilities
+* Convenience utility functions in `katcp.version`, `katcp.client`,
+  `katcp.testutils`.
+
 0.5.4
 =====
 
@@ -15,7 +25,7 @@ Release Notes
 0.5.3
 =====
 
-Add "meth:`convert_seconds` method to katcp client classes that converts seconds
+Add :meth:`convert_seconds` method to katcp client classes that converts seconds
 into the device timestamp format.
 
 0.5.2
@@ -42,7 +52,7 @@ a number of backward incompatible changes, and hence requires care. This library
 implements support for both KATCP v5 and for the older dialect. Some API changes
 have also been made, mainly in aid of fool-proof support of the Message ID
 feature of KATCP v5. The changes do, however, also eliminate a category of
-potential bugs for older versions of the spec. See also :download:`CHANGELOG`.
+potential bugs for older versions of the spec. 
 
 Important API changes
 ---------------------

katcp/server.py

@@ -533,7 +533,7 @@ def inform(self, connection, msg):
         if isinstance(connection, ClientRequestConnection):
             self._logger.warn(
                 'Deprecation warning: do not use self.inform() '
-                'within a reply handler context -- use req.reply()\n'
+                'within a reply handler context -- use req.inform()\n'
                 'Traceback:\n %s', "".join(traceback.format_stack() ))
             # Get the underlying ClientConnectionTCP instance
             connection = connection.client_connection

katcp/testutils.py

@@ -1420,6 +1420,13 @@ def mock_req(req_name, *args, **kwargs):
     if not client_conn:
         client_conn = WaitingMock()
 
+    # TODO Consider making the mocks autospecced from the real classes to test somewhat
+    # more strictly.
+
+    # TODO Consider making .reply_msg and .inform_msgs attributes containing the actualy
+    # reply/inform Message objects that would have been sent. May make certain kinds of
+    # test comparisons easier.
+
     req = WaitingMock()
     req.client_connection = client_conn
     req.msg = Message.request(req_name, *args)

katcp/version.py

@@ -9,7 +9,7 @@
 
 import pkg_resources
 
-VERSION = (0, 5, 5, 'alpha', 0)
+VERSION = (0, 5, 5, 'final', 0)
 
 BASE_VERSION_STR = '.'.join([str(x) for x in VERSION[:3]])
 VERSION_STR = {