Merge lp:~barry/ubuntu/quantal/dbus-python/lp846044 into lp:ubuntu/quantal/dbus-python

[Barry Warsaw]

Proposing mine so we can just get a diff. I have no preference whether mine or Michael's branch is merged. Both seem to address the problem, pass the tests, etc. Ultimately if possible we should wait until upstream makes a commit to its trunk, and then use that patch.

[Michael Vogt (mvo)]

Thanks, that looks great. I uploaded this to quantal-proposed some days ago already and will now upload to raring.

review: Approve

Unmerged revisions

41. By Barry Warsaw on 2012-10-16

debian/patches/fdo-bug-55899.patch: Support Unicode DBusExceptions
in Python 2. (LP: #846044)

=== modified file 'debian/changelog'
--- debian/changelog	2012-06-25 17:35:50 +0000
+++ debian/changelog	2012-10-17 14:55:32 +0000
@@ -1,3 +1,10 @@
+dbus-python (1.1.1-1ubuntu1) quantal-proposed; urgency=low
+
+  * debian/patches/fdo-bug-55899.patch: Support Unicode DBusExceptions
+    in Python 2.  (LP: #846044)
+
+ -- Barry Warsaw <[e-mail]>  Tue, 16 Oct 2012 15:25:00 -0400
+
 dbus-python (1.1.1-1) unstable; urgency=low
 
   * New upstream version

=== modified file 'debian/control'
--- debian/control	2012-06-25 17:35:50 +0000
+++ debian/control	2012-10-17 14:55:32 +0000
@@ -1,7 +1,8 @@
 Source: dbus-python
 Section: devel
 Priority: optional
-Maintainer: Utopia Maintenance Team <[e-mail]>
+Maintainer: Ubuntu Developers <[e-mail]>
+XSBC-Original-Maintainer: Utopia Maintenance Team <[e-mail]>
 Uploaders: Sjoerd Simons <[e-mail]>,
            Sebastian Dröge <[e-mail]>,
            Simon McVittie <[e-mail]>,

=== added directory 'debian/patches'
=== added file 'debian/patches/fdo-bug-55899.patch'
--- debian/patches/fdo-bug-55899.patch	1970-01-01 00:00:00 +0000
+++ debian/patches/fdo-bug-55899.patch	2012-10-17 14:55:32 +0000
@@ -0,0 +1,199 @@
+From 09b540bd55fb2fca14d4df7e0c520b8ba0ce4646 Mon Sep 17 00:00:00 2001
+From: Michael Vogt <[e-mail]>
+Date: Fri, 12 Oct 2012 13:37:51 +0200
+Subject: [PATCH 1/5] Support unicode messages for DBusException in
+Python 2
+
+[commit message amended -smcv]
+Bug: https://bugs.freedesktop.org/show_bug.cgi?id=55899
+Reviewed-by: Simon McVittie <[e-mail]>
+
+Barry: actually includes patches 1-5/5.
+
+--- a/dbus/exceptions.py
++++ b/dbus/exceptions.py
+@@ -27,6 +27,8 @@
+            'IntrospectionParserException', 'UnknownMethodException',
+            'NameExistsException')
+ 
++from dbus._compat import is_py3
++
+ 
+ class DBusException(Exception):
+ 
+@@ -49,7 +51,22 @@
+                             % ', '.join(kwargs.keys()))
+         Exception.__init__(self, *args)
+ 
++    def __unicode__(self):
++        """Return a unicode error"""
++        # We can't just use Exception.__unicode__ because it chains up weirdly.
++        # https://code.launchpad.net/~mvo/ubuntu/quantal/dbus-python/lp846044/+merge/129214
++        if len(self.args) > 1:
++            s = unicode(self.args)
++        else:
++            s = ''.join(self.args)
++
++        if self._dbus_error_name is not None:
++            return '%s: %s' % (self._dbus_error_name, s)
++        else:
++            return s
++
+     def __str__(self):
++        """Return a str error"""
+         s = Exception.__str__(self)
+         if self._dbus_error_name is not None:
+             return '%s: %s' % (self._dbus_error_name, s)
+@@ -57,9 +74,17 @@
+             return s
+ 
+     def get_dbus_message(self):
+-        s = Exception.__str__(self)
++        if len(self.args) > 1:
++            if is_py3:
++                s = str(self.args)
++            else:
++                s = unicode(self.args)
++        else:
++            s = ''.join(self.args)
++
+         if isinstance(s, bytes):
+             return s.decode('utf-8', 'replace')
++
+         return s
+ 
+     def get_dbus_name(self):
+--- a/test/run-test.sh
++++ b/test/run-test.sh
+@@ -67,6 +67,12 @@
+ echo "PYTHONPATH=$PYTHONPATH"
+ echo "PYTHON=$PYTHON"
+ 
++# the exceptions handling test is version specific
++PYMAJOR=$($PYTHON -c 'import sys;print(sys.version_info[0])')
++PYTEST=test-exception-py$PYMAJOR.py
++echo "running $PYTEST"
++$PYTHON "$DBUS_TOP_SRCDIR"/test/$PYTEST || die "$PYTEST failed"
++
+ echo "running test-standalone.py"
+ $PYTHON "$DBUS_TOP_SRCDIR"/test/test-standalone.py || die "test-standalone.py failed"
+ 
+--- /dev/null
++++ b/test/test-exception-py2.py
+@@ -0,0 +1,62 @@
++#!/usr/bin/python
++# -*- coding: utf-8 -*-
++
++import sys
++import unittest
++
++import dbus
++
++# from test-service.py
++class ServiceError(dbus.DBusException):
++    """Exception representing a normal "environmental" error"""
++    include_traceback = False
++    _dbus_error_name = 'com.example.Networking.ServerError'
++
++
++class DBusExceptionTestCase(unittest.TestCase):
++    """Test the DBusException str/unicode behavior with py2"""
++
++    def test_dbus_exception_normal(self):
++        """Test the normal Exception behavior"""
++        e = dbus.exceptions.DBusException("baaa")
++        msg = e.get_dbus_message()
++        self.assertEqual(msg, u"baaa")
++
++    def test_dbus_exception_unicode(self):
++        """Test that DBusExceptions that take a py2 unicode work"""
++        e = dbus.exceptions.DBusException(u"bäää")
++        msg = e.get_dbus_message()
++        self.assertEqual(msg, u"bäää")
++
++    def test_dbus_exception_convert_str(self):
++        """Test that converting a DBusException to str() works as expected"""
++        e = dbus.exceptions.DBusException(u"bxxx")
++        self.assertEqual(str(e), "bxxx")
++
++    def test_dbus_exception_convert_str_fail(self):
++        """Test that a non-ascii Exception fails to convert to str"""
++        if sys.getdefaultencoding() == 'ascii':
++            self.assertRaises(UnicodeEncodeError,
++                    lambda: str(dbus.exceptions.DBusException(u"bä")))
++        else:
++            self.skipTest("you're using a weird non-ascii "
++                    "sys.getdefaultencoding()")
++
++    def test_dbus_exception_convert_unicode(self):
++        """Test that converting a DBusEception to unicode works"""
++        e = dbus.exceptions.DBusException(u"bäää")
++        self.assertEqual(e.get_dbus_message(), u"bäää")
++        self.assertEqual(e.__unicode__(), u"bäää")
++        self.assertEqual(unicode(e), u"bäää")
++
++    def test_subclass_exception_unicode(self):
++        """Test that DBusExceptions that take a py2 unicode work"""
++        e = ServiceError(u"bäää")
++        msg = e.get_dbus_message()
++        self.assertEqual(msg, u"bäää")
++        self.assertEqual(
++            unicode(e), u"com.example.Networking.ServerError: bäää")
++
++
++if __name__ == "__main__":
++    unittest.main()
+--- /dev/null
++++ b/test/test-exception-py3.py
+@@ -0,0 +1,31 @@
++#!/usr/bin/python
++# -*- coding: utf-8 -*-
++
++import unittest
++
++import dbus
++
++# from test-service.py
++class ServiceError(dbus.DBusException):
++    """Exception representing a normal "environmental" error"""
++    include_traceback = False
++    _dbus_error_name = 'com.example.Networking.ServerError'
++
++
++class DBusExceptionTestCase(unittest.TestCase):
++
++    def test_dbus_exception(self):
++        e = dbus.exceptions.DBusException("bäää")
++        msg = e.get_dbus_message()
++        self.assertEqual(msg, "bäää")
++        self.assertEqual(str(e), "bäää")
++
++    def test_subclass_exception(self):
++        e = ServiceError("bäää")
++        msg = e.get_dbus_message()
++        self.assertEqual(msg, "bäää")
++        self.assertEqual(str(e), "com.example.Networking.ServerError: bäää")
++
++
++if __name__ == "__main__":
++    unittest.main()
+--- a/test/test-client.py
++++ b/test/test-client.py
+@@ -563,6 +563,8 @@
+             self.iface.RaiseDBusExceptionNoTraceback()
+         except Exception as e:
+             self.assertTrue(isinstance(e, dbus.DBusException), e.__class__)
++            self.assertEqual(e.get_dbus_name(),
++                    'com.example.Networking.ServerError')
+             self.assertEqual(str(e),
+                               'com.example.Networking.ServerError: '
+                               'Server not responding')
+@@ -573,6 +575,8 @@
+             self.iface.RaiseDBusExceptionWithTraceback()
+         except Exception as e:
+             self.assertTrue(isinstance(e, dbus.DBusException), e.__class__)
++            self.assertEqual(e.get_dbus_name(),
++                    'com.example.Misc.RealityFailure')
+             self.assertTrue(str(e).startswith('com.example.Misc.RealityFailure: '
+                                            'Traceback '),
+                          'Wanted a traceback but got:\n%s' % str(e))

=== added file 'debian/patches/series'
--- debian/patches/series	1970-01-01 00:00:00 +0000
+++ debian/patches/series	2012-10-17 14:55:32 +0000
@@ -0,0 +1,1 @@
+fdo-bug-55899.patch