Merge lp:~thomir-deactivatedaccount/autopilot/trunk-use-six into lp:autopilot

[Thomi Richards]

Use the 'six' python module to help us get python 2/3 compatibility, rather than rolling our own.

Use the 'six' python module to help us get python 2/3 compatibility, rather than rolling our own.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:352
http://jenkins.qa.ubuntu.com/job/autopilot-ci/268/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-amd64-ci/196
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-armhf-ci/196
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-i386-ci/40

Click here to trigger a rebuild:
http://10.97.0.26:8080/job/autopilot-ci/268/rebuild

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

Looks good to me.

review: Approve

=== modified file 'autopilot/input/_X11.py'
--- autopilot/input/_X11.py	2013-10-10 00:35:30 +0000
+++ autopilot/input/_X11.py	2013-10-13 21:52:16 +0000
@@ -27,7 +27,7 @@
 from __future__ import absolute_import
 
 import logging
-import sys
+import six
 from time import sleep
 
 from autopilot.display import is_point_on_any_screen, move_mouse_to_screen
@@ -46,10 +46,6 @@
 _DISPLAY = None
 logger = logging.getLogger(__name__)
 
-# py2 compatible alias for py3
-if sys.version >= '3':
-    basestring = str
-
 
 def get_display():
     """Return the Xlib display object.
@@ -141,7 +137,7 @@
         presses the 'Alt' and 'F2' keys.
 
         """
-        if not isinstance(keys, basestring):
+        if not isinstance(keys, six.string_types):
             raise TypeError("'keys' argument must be a string.")
         logger.debug("Pressing keys %r with delay %f", keys, delay)
         for key in self.__translate_keys(keys):
@@ -160,7 +156,7 @@
         releases the 'Alt' and 'F2' keys.
 
         """
-        if not isinstance(keys, basestring):
+        if not isinstance(keys, six.string_types):
             raise TypeError("'keys' argument must be a string.")
         logger.debug("Releasing keys %r with delay %f", keys, delay)
         # release keys in the reverse order they were pressed in.
@@ -196,7 +192,7 @@
          and a 't').
 
         """
-        if not isinstance(string, basestring):
+        if not isinstance(string, six.string_types):
             raise TypeError("'keys' argument must be a string.")
         logger.debug("Typing text %r", string)
         for key in string:
@@ -223,7 +219,7 @@
         _PRESSED_KEYS = []
 
     def __perform_on_key(self, key, event):
-        if not isinstance(key, basestring):
+        if not isinstance(key, six.string_types):
             raise TypeError("Key parameter must be a string")
 
         keycode = 0

=== modified file 'autopilot/input/_osk.py'
--- autopilot/input/_osk.py	2013-09-05 09:38:04 +0000
+++ autopilot/input/_osk.py	2013-10-13 21:52:16 +0000
@@ -18,7 +18,7 @@
 #
 
 import logging
-import sys
+import six
 from time import sleep
 from contextlib import contextmanager
 
@@ -32,10 +32,6 @@
 
 logger = logging.getLogger(__name__)
 
-# py2 compatible alias for py3
-if sys.version >= '3':
-    basestring = str
-
 
 class Keyboard(KeyboardBase):
 
@@ -106,7 +102,7 @@
         not supported by the OSK Backend (or the current OSK langauge layout.)
 
         """
-        if not isinstance(string, basestring):
+        if not isinstance(string, six.string_types):
             raise TypeError("'string' argument must be a string.")
         logger.debug("Typing text: %s", string)
         self._keyboard.type(string, delay)

=== modified file 'autopilot/input/_uinput.py'
--- autopilot/input/_uinput.py	2013-10-10 00:35:30 +0000
+++ autopilot/input/_uinput.py	2013-10-13 21:52:16 +0000
@@ -29,7 +29,7 @@
 from time import sleep
 from evdev import UInput, ecodes as e
 import os.path
-import sys
+import six
 
 logger = logging.getLogger(__name__)
 
@@ -38,10 +38,6 @@
 
 _PRESSED_KEYS = []
 
-# py2 compatible alias for py3
-if sys.version >= '3':
-    basestring = str
-
 
 def _get_devnode_path():
     """Provide a fallback uinput node for devices which don't support udev"""
@@ -76,7 +72,7 @@
         presses the 'Alt' and 'F2' keys.
 
         """
-        if not isinstance(keys, basestring):
+        if not isinstance(keys, six.string_types):
             raise TypeError("'keys' argument must be a string.")
 
         for key in self._sanitise_keys(keys):
@@ -99,7 +95,7 @@
         Keys are released in the reverse order in which they are specified.
 
         """
-        if not isinstance(keys, basestring):
+        if not isinstance(keys, six.string_types):
             raise TypeError("'keys' argument must be a string.")
 
         for key in reversed(self._sanitise_keys(keys)):
@@ -134,7 +130,7 @@
         (such as 'Alt' will be interpreted as an 'A', and 'l', and a 't').
 
         """
-        if not isinstance(string, basestring):
+        if not isinstance(string, six.string_types):
             raise TypeError("'keys' argument must be a string.")
         logger.debug("Typing text %r", string)
         for key in string:

=== modified file 'autopilot/introspection/__init__.py'
--- autopilot/introspection/__init__.py	2013-10-07 03:14:09 +0000
+++ autopilot/introspection/__init__.py	2013-10-13 21:52:16 +0000
@@ -34,7 +34,7 @@
 from functools import partial
 import os
 import psutil
-import sys
+import six
 
 from autopilot.introspection.backends import DBusAddress
 from autopilot.introspection.constants import (
@@ -63,10 +63,6 @@
 # Keep track of known connections during search
 connection_list = []
 
-# py2 compatible alias for py3
-if sys.version >= '3':
-    basestring = str
-
 
 class ProcessSearchError(RuntimeError):
     pass
@@ -118,7 +114,7 @@
         prepare the environment before launching the application itself.
     """
 
-    if not isinstance(application, basestring):
+    if not isinstance(application, six.string_types):
         raise TypeError("'application' parameter must be a string.")
     cwd = kwargs.pop('launch_dir', None)
     capture_output = kwargs.pop('capture_output', True)

=== modified file 'autopilot/introspection/dbus.py'
--- autopilot/introspection/dbus.py	2013-10-07 03:55:03 +0000
+++ autopilot/introspection/dbus.py	2013-10-13 21:52:16 +0000
@@ -30,7 +30,7 @@
 from contextlib import contextmanager
 import logging
 import re
-import sys
+import six
 from time import sleep
 from uuid import uuid4
 
@@ -43,14 +43,6 @@
 logger = logging.getLogger(__name__)
 
 
-# py2 compatible alias for py3
-if sys.version >= '3':
-    _PY3 = True
-    basestring = str
-else:
-    _PY3 = False
-
-
 class StateNotFoundError(RuntimeError):
 
     """Raised when a piece of state information is not found.
@@ -96,7 +88,7 @@
                 )
 
     def __str__(self):
-        if sys.version_info[0] >= 3:
+        if six.PY3:
             return self._message
         else:
             return self._message.encode('utf8')
@@ -225,7 +217,7 @@
         result = []
         for instance in instances:
             # Skip items that are not instances of the desired type:
-            if isinstance(desired_type, basestring):
+            if isinstance(desired_type, six.string_types):
                 if instance.__class__.__name__ != desired_type:
                     continue
             elif not isinstance(instance, desired_type):
@@ -529,7 +521,7 @@
         :raises: **TypeError** on invalid *piece* parameter.
 
         """
-        if not isinstance(piece, basestring):
+        if not isinstance(piece, six.string_types):
             raise TypeError(
                 "XPath query must be a string, not %r", type(piece))
 
@@ -631,7 +623,7 @@
 
     """
     if isinstance(value, str):
-        if _PY3:
+        if six.PY3:
             escaped_value = value.encode("unicode_escape")\
                 .decode('ASCII')\
                 .replace("'", "\\'")

=== modified file 'autopilot/keybindings.py'
--- autopilot/keybindings.py	2013-09-16 19:58:11 +0000
+++ autopilot/keybindings.py	2013-10-13 21:52:16 +0000
@@ -37,7 +37,7 @@
 
 import logging
 import re
-import sys
+import six
 
 from autopilot.input import Keyboard
 from autopilot.utilities import Silence
@@ -45,10 +45,6 @@
 logger = logging.getLogger(__name__)
 
 
-# py2 compatible alias for py3
-if sys.version >= '3':
-    basestring = str
-
 #
 # Fill this dictionary with keybindings we want to store.
 #
@@ -145,12 +141,12 @@
      dictionaries.
 
     """
-    if not isinstance(binding_name, basestring):
+    if not isinstance(binding_name, six.string_types):
         raise TypeError("binding_name must be a string.")
     if binding_name not in _keys:
         raise ValueError("Unknown binding name '%s'." % (binding_name))
     v = _keys[binding_name]
-    if isinstance(v, basestring):
+    if isinstance(v, six.string_types):
         return v
     else:
         return _get_compiz_keybinding(v)
@@ -232,7 +228,7 @@
     :param string keystroke_string: A compizconfig-style keystroke string.
 
     """
-    if not isinstance(keystroke_string, basestring):
+    if not isinstance(keystroke_string, six.string_types):
         raise TypeError("keystroke string must be a string.")
 
     translations = {

=== modified file 'autopilot/tests/functional/test_ap_apps.py'
--- autopilot/tests/functional/test_ap_apps.py	2013-09-18 13:50:18 +0000
+++ autopilot/tests/functional/test_ap_apps.py	2013-10-13 21:52:16 +0000
@@ -24,6 +24,7 @@
 import subprocess
 import logging
 import sys
+import six
 from mock import patch
 from tempfile import mktemp
 from testtools.matchers import raises, LessThan
@@ -39,7 +40,7 @@
 
 
 # backwards compatible alias for Python 3
-if sys.version > '3':
+if six.PY3:
     xrange = range
 
 logger = logging.getLogger(__name__)

=== modified file 'autopilot/tests/unit/test_exceptions.py'
--- autopilot/tests/unit/test_exceptions.py	2013-09-18 17:17:08 +0000
+++ autopilot/tests/unit/test_exceptions.py	2013-10-13 21:52:16 +0000
@@ -17,14 +17,12 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-import sys
+import six
 from testtools import TestCase
 from testtools.matchers import raises, Equals
 
 from autopilot.introspection.dbus import StateNotFoundError
 
-_Py2 = sys.version_info[0] == 2
-
 
 class StateNotFoundTests(TestCase):
 
@@ -45,7 +43,7 @@
             str(err),
             Equals("State not found for class 'MyClass'.")
         )
-        if _Py2:
+        if not six.PY3:
             self.assertThat(
                 unicode(err),
                 Equals(u"State not found for class 'MyClass'.")
@@ -58,7 +56,7 @@
             str(err),
             Equals("State not found with filters {'foo': 'bar'}.")
         )
-        if _Py2:
+        if not six.PY3:
             self.assertThat(
                 unicode(err),
                 Equals(u"State not found with filters {'foo': 'bar'}.")
@@ -72,7 +70,7 @@
             Equals("State not found for class 'MyClass'"
                    " and filters {'foo': 'bar'}.")
         )
-        if _Py2:
+        if not six.PY3:
             self.assertThat(
                 unicode(err),
                 Equals(u"State not found for class 'MyClass'"

=== modified file 'autopilot/tests/unit/test_matchers.py'
--- autopilot/tests/unit/test_matchers.py	2013-10-07 03:14:09 +0000
+++ autopilot/tests/unit/test_matchers.py	2013-10-13 21:52:16 +0000
@@ -20,14 +20,10 @@
 
 from __future__ import absolute_import
 
-import sys
-
-from autopilot.introspection.dbus import DBusIntrospectionObject
-from autopilot.matchers import Eventually
-
 from contextlib import contextmanager
 import dbus
 from testscenarios import TestWithScenarios
+import six
 from testtools import TestCase
 from testtools.matchers import (
     Contains,
@@ -39,9 +35,8 @@
 )
 from time import time
 
-
-if sys.version >= '3':
-    unicode = str
+from autopilot.introspection.dbus import DBusIntrospectionObject
+from autopilot.matchers import Eventually
 
 
 @contextmanager
@@ -76,10 +71,10 @@
     if attribute_type == 'callable':
         return lambda: result
     elif attribute_type == 'wait_for':
-        if isinstance(result, unicode):
+        if isinstance(result, six.text_type):
             obj = FakeObject(dict(id=[0, 123], attr=[0, dbus.String(result)]))
             return obj.attr
-        elif isinstance(result, bytes):
+        elif isinstance(result, six.binary_type):
             obj = FakeObject(
                 dict(id=[0, 123], attr=[0, dbus.UTF8String(result)])
             )

=== modified file 'autopilot/vis/main_window.py'
--- autopilot/vis/main_window.py	2013-09-11 18:45:00 +0000
+++ autopilot/vis/main_window.py	2013-10-13 21:52:16 +0000
@@ -20,9 +20,9 @@
 
 from __future__ import absolute_import
 
-import sys
 import dbus
 from PyQt4 import QtGui, QtCore
+import six
 
 from autopilot.introspection import (
     _get_dbus_address_object,
@@ -34,8 +34,6 @@
 from autopilot.vis.objectproperties import TreeNodeDetailWidget
 from autopilot.vis.resources import get_qt_icon
 
-_PY3 = sys.version >= '3'
-
 
 class MainWindow(QtGui.QMainWindow):
     def __init__(self, dbus_bus):
@@ -47,7 +45,7 @@
 
     def readSettings(self):
         settings = QtCore.QSettings()
-        if _PY3:
+        if six.PY3:
             self.restoreGeometry(settings.value("geometry").data())
             self.restoreState(settings.value("windowState").data())
         else:
@@ -116,7 +114,7 @@
 
     def conn_list_activated(self, index):
         dbus_details = self.connection_list.itemData(index)
-        if not _PY3:
+        if not six.PY3:
             dbus_details = dbus_details.toPyObject()
         if dbus_details:
             self.tree_model = VisTreeModel(dbus_details)

=== modified file 'autopilot/vis/objectproperties.py'
--- autopilot/vis/objectproperties.py	2013-09-11 18:45:00 +0000
+++ autopilot/vis/objectproperties.py	2013-10-13 21:52:16 +0000
@@ -20,8 +20,8 @@
 
 """Code for introspection tree object properties."""
 
-import sys
 
+import six
 from PyQt4 import QtGui, QtCore
 
 
@@ -97,7 +97,7 @@
     def __init__(self, *args, **kwargs):
         super(PropertyView, self).__init__(*args, **kwargs)
 
-        if sys.version >= '3':
+        if six.PY3:
             header_titles = ["Name", "Value"]
         else:
             header_titles = QtCore.QStringList(["Name", "Value"])