Merge lp:~parthm/bzr/603461-ensure-no-var-named-message into lp:bzr

[Parth Malwankar]

test to ensure that errors.BzrError subclasses don't use "message" as arg name for __init__ and _fmt (#603461)

This patch adds a test to bt.test_errors to ensure that errors.BzrError subclasses in bzrlib.errors do not have an argument named "message" for __init__ and _fmt as this causes problems with some Python versions (e.g. bug #603461).

[Parth Malwankar (parthm)]

Note that errors.LockError was using "message" and this is also changed to "msg". It doesn't break anything in bzr test suite. I am not sure if any plugins use 'LockError(message="...")' specifically.

[lp:~parthm/bzr/603461-ensure-no-var-named-message]

5343. By Parth Malwankar on 2010-07-10

cleanup test case by using isclass rather than catching exception.

5344. By Parth Malwankar on 2010-07-10

imporved test to check _fmt

5345. By Parth Malwankar on 2010-07-10

improved assert message.

5346. By Parth Malwankar on 2010-07-10

improved fmt_pattern and assert message.

[Parth Malwankar (parthm)]

I am rejecting this as its proposed against 2.2 now.
https://code.launchpad.net/~parthm/bzr/603461-ensure-no-var-named-message-2.2/+merge/29837

Unmerged revisions

5346. By Parth Malwankar on 2010-07-10

improved fmt_pattern and assert message.

5345. By Parth Malwankar on 2010-07-10

improved assert message.

5344. By Parth Malwankar on 2010-07-10

imporved test to check _fmt

5343. By Parth Malwankar on 2010-07-10

cleanup test case by using isclass rather than catching exception.

5342. By Parth Malwankar on 2010-07-10

updated NEWS

5341. By Parth Malwankar on 2010-07-10

test case to ensure the errors.exceptions don't use message arg name

=== modified file 'NEWS'
--- NEWS	2010-07-08 10:34:12 +0000
+++ NEWS	2010-07-10 05:26:39 +0000
@@ -5,11 +5,44 @@
 .. contents:: List of Releases
    :depth: 1
 
+bzr 2.3b1
+#########
+
+:2.3b1: NOT RELEASED YET
+
+Compatibility Breaks
+********************
+
+New Features
+************
+
+Bug Fixes
+*********
+
+Improvements
+************
+
+Documentation
+*************
+
+API Changes
+***********
+
+Internals
+*********
+
+Testing
+*******
+
+* Added test case to disallow argument named "message" for bzrlib.errors
+  exceptions as this breaks on some Python versions.
+  (Parth Malwankar, #603461)
+
 bzr 2.2b4
 #########
 
 :Codename: Monkey Magic
-:2.2b4: NOT RELEASED YET
+:2.2b4: 2004-07-09
 
 Compatibility Breaks
 ********************

=== modified file 'bzrlib/errors.py'
--- bzrlib/errors.py	2010-07-09 16:16:11 +0000
+++ bzrlib/errors.py	2010-07-10 05:26:39 +0000
@@ -947,11 +947,8 @@
     # original exception is available as e.original_error
     #
     # New code should prefer to raise specific subclasses
-    def __init__(self, message):
-        # Python 2.5 uses a slot for StandardError.message,
-        # so use a different variable name.  We now work around this in
-        # BzrError.__str__, but this member name is kept for compatability.
-        self.msg = message
+    def __init__(self, msg):
+        self.msg = msg
 
 
 class LockActive(LockError):
@@ -1378,12 +1375,12 @@
 
 class WeaveParentMismatch(WeaveError):
 
-    _fmt = "Parents are mismatched between two revisions. %(message)s"
+    _fmt = "Parents are mismatched between two revisions. %(msg)s"
 
 
 class WeaveInvalidChecksum(WeaveError):
 
-    _fmt = "Text did not match it's checksum: %(message)s"
+    _fmt = "Text did not match it's checksum: %(msg)s"
 
 
 class WeaveTextDiffers(WeaveError):
@@ -1437,7 +1434,7 @@
 
 class VersionedFileInvalidChecksum(VersionedFileError):
 
-    _fmt = "Text did not match its checksum: %(message)s"
+    _fmt = "Text did not match its checksum: %(msg)s"
 
 
 class KnitError(InternalBzrError):

=== modified file 'bzrlib/tests/test_errors.py'
--- bzrlib/tests/test_errors.py	2010-07-09 16:16:11 +0000
+++ bzrlib/tests/test_errors.py	2010-07-10 05:26:39 +0000
@@ -16,6 +16,8 @@
 
 """Tests for the formatting and construction of errors."""
 
+import inspect
+import re
 import socket
 import sys
 
@@ -31,6 +33,30 @@
 
 class TestErrors(TestCaseWithTransport):
 
+    def test_init_arg_names(self):
+        """Ensure the exception.__init__ in errors do not have "message" arg.
+
+        This test fails if any exception.__init__ in errors has an argument
+        named "message" as this can cause errors in some Python versions.
+        Python 2.5 uses a slot for StandardError.message.
+        See bug #603461
+        """
+        fmt_pattern = re.compile("%\(message\)[sir]")
+        for e, v in errors.__dict__.iteritems():
+            init = None
+            fmt = None
+            if inspect.isclass(v) and issubclass(v, errors.BzrError):
+                init = getattr(v, '__init__', None)
+                fmt = getattr(v, '_fmt', None)
+            if init:
+                args = inspect.getargspec(init)[0]
+                self.assertFalse('message' in args,
+                    ('Argument name "message" not allowed for '
+                    '"errors.%s"' % e))
+            if fmt and fmt_pattern.search(fmt):
+                self.assertFalse(True, ('"message" not allowed in '
+                    '"errors.%s._fmt"' % e))
+
     def test_bad_filename_encoding(self):
         error = errors.BadFilenameEncoding('bad/filen\xe5me', 'UTF-8')
         self.assertEqualDiff(