Merge lp:~gz/bzr/2.3_unprintable_retrywithnewpacks into lp:bzr/2.3

[Martin Packman]

Store context argument to RetryWithNewPacks which stops stringification breaking

Merge Andrew's fix for the RetryWithNewPacks exception not being printable, due to missing the context attribute. The exception is not intended to bubble up to users at all, and this doesn't tackle the underlying problem in bug 709349 but may as well be resolved separately now.

Proposing against 2.3 as that's what his branch was, and it's a safe and obvious fix.

[Vincent Ladeuil (vila)]

Safe and obvious indeed, green light to merge in 2.3 and up to trunk

Just one question:

26 + '{context} {exc value}', str(error))

is error not an exception or is it safe to call str() here ? If the later, I'll warmly welcome some idiot-proof guide on when that's the case ;)

review: Approve

[Martin Packman (gz)]

> Just one question:
>
> 26 + '{context} {exc value}', str(error))
>
> is error not an exception or is it safe to call str() here ? If the later,
> I'll warmly welcome some idiot-proof guide on when that's the case ;)

Test does look a bit funny, but works with how the code is written currently. Calling str() is okay because we're supplying ascii only inputs - and it's one of our exceptions that has the added robustness when formatting, hence the original 'Unprintable exception' complaint rather than a knock-on KeyError.

Test is in the right place to get updated on bzr.dev when handling of wrapped exceptions is improved.

[Martin Packman (gz)]

sent to pqm by email

=== modified file 'bzrlib/errors.py'
--- bzrlib/errors.py	2011-07-27 11:57:32 +0000
+++ bzrlib/errors.py	2011-11-10 11:06:39 +0000
@@ -1563,6 +1563,7 @@
             problem we can raise the original error (value from sys.exc_info())
         """
         BzrError.__init__(self)
+        self.context = context
         self.reload_occurred = reload_occurred
         self.exc_info = exc_info
         self.orig_error = exc_info[1]
 
=== modified file 'bzrlib/tests/test_errors.py'
--- bzrlib/tests/test_errors.py	2011-01-12 01:01:53 +0000
+++ bzrlib/tests/test_errors.py	2011-11-10 11:06:39 +0000
@@ -712,6 +712,14 @@
             'Please use `bzr unbind` to fix.')
         self.assertEqualDiff(msg, str(error))
 
+    def test_retry_with_new_packs(self):
+        fake_exc_info = ('{exc type}', '{exc value}', '{exc traceback}')
+        error = errors.RetryWithNewPacks(
+            '{context}', reload_occurred=False, exc_info=fake_exc_info)
+        self.assertEqual(
+            'Pack files have changed, reload and retry. context: '
+            '{context} {exc value}', str(error))
+
 
 class PassThroughError(errors.BzrError):
 
 
=== modified file 'doc/en/release-notes/bzr-2.3.txt'
--- doc/en/release-notes/bzr-2.3.txt	2011-09-09 12:32:08 +0000
+++ doc/en/release-notes/bzr-2.3.txt	2011-11-10 11:06:39 +0000
@@ -35,6 +35,9 @@
 * Cope cleanly with buggy HTTP proxies that close the socket in the middle
   of a multipart response.  (Martin Pool, #198646).
 
+* Fix "Unprintable exception" error when a RetryWithNewPacks error is
+  displayed.  (Andrew Bennetts)
+
 Documentation
 *************