Python 2 and 3 with the same source!

sudorandom · sudorandom · commit cd0210ff7b98 · 2014-02-02T17:23:17.000-06:00
* Fixes Python 3 compatibility issues so one codebase will work for python 2.6, 2.7, 3.2 and 3.3. * Adds six dependency. * Also adds python wheels support to the build/release fab script (softlayer#234)
diff --git a/SoftLayer/API.py b/SoftLayer/API.py
@@ -7,10 +7,10 @@
 """
 import time
 
-from consts import API_PUBLIC_ENDPOINT, API_PRIVATE_ENDPOINT, USER_AGENT
-from transports import make_xml_rpc_api_call
-from auth import TokenAuthentication
-from config import get_client_settings
+from .consts import API_PUBLIC_ENDPOINT, API_PRIVATE_ENDPOINT, USER_AGENT
+from .transports import make_xml_rpc_api_call
+from .auth import TokenAuthentication
+from .config import get_client_settings
 
 
 __all__ = ['Client', 'TimedClient', 'API_PUBLIC_ENDPOINT',
diff --git a/SoftLayer/CLI/core.py b/SoftLayer/CLI/core.py
@@ -49,8 +49,8 @@
 
 from SoftLayer import Client, TimedClient, SoftLayerError, SoftLayerAPIError
 from SoftLayer.consts import VERSION
-from helpers import CLIAbort, ArgumentError, format_output, KeyValueTable
-from environment import Environment, InvalidCommand, InvalidModule
+from .helpers import CLIAbort, ArgumentError, format_output, KeyValueTable
+from .environment import Environment, InvalidCommand, InvalidModule
 
 
 DEBUG_LOGGING_MAP = {
diff --git a/SoftLayer/CLI/environment.py b/SoftLayer/CLI/environment.py
@@ -12,6 +12,8 @@
 import os.path
 import sys
 
+import six
+
 from SoftLayer.CLI.modules import get_module_list
 from SoftLayer import SoftLayerError
 
@@ -90,7 +92,7 @@ def err(self, s, nl=True):
             self.stderr.write(os.linesep)
 
     def input(self, prompt):
-        return raw_input(prompt)
+        return six.moves.input(prompt)
 
     def getpass(self, prompt):
         return getpass.getpass(prompt)
diff --git a/SoftLayer/CLI/formatting.py b/SoftLayer/CLI/formatting.py
@@ -10,6 +10,8 @@
 import os
 import json
 
+import six
+
 from prettytable import PrettyTable, FRAME, NONE
 
 
@@ -20,7 +22,7 @@ def format_output(data, fmt='table'):
                  SequentialOutput
     :param string fmt (optional): One of: table, raw, json, python
     """
-    if isinstance(data, basestring):
+    if isinstance(data, six.string_types):
         if fmt == 'json':
             return json.dumps(data)
         return data
@@ -142,7 +144,7 @@ def active_txn(item):
 
 
 def valid_response(prompt, *valid):
-    ans = raw_input(prompt).lower()
+    ans = six.moves.input(prompt).lower()
 
     if ans in valid:
         return True
diff --git a/SoftLayer/CLI/helpers.py b/SoftLayer/CLI/helpers.py
@@ -8,12 +8,12 @@
 
 from SoftLayer.utils import NestedDict
 from SoftLayer.CLI.environment import CLIRunnable
-from exceptions import CLIHalt, CLIAbort, ArgumentError
-from formatting import (
+from .exceptions import CLIHalt, CLIAbort, ArgumentError
+from .formatting import (
     Table, KeyValueTable, FormattedItem, SequentialOutput, confirm,
     no_going_back, mb_to_gb, gb, listing, blank, format_output,
     active_txn, valid_response)
-from template import update_with_template_args, export_to_template
+from .template import update_with_template_args, export_to_template
 
 __all__ = [
     # Core/Misc
diff --git a/SoftLayer/CLI/modules/cci.py b/SoftLayer/CLI/modules/cci.py
@@ -245,15 +245,13 @@ def execute(self, args):
             t.add_row(['datacenter', listing(datacenters, separator=',')])
 
         if args['--cpu'] or show_all:
-            standard_cpu = filter(
-                lambda x: not x['template'].get(
-                    'dedicatedAccountHostOnlyFlag', False),
-                result['processors'])
+            standard_cpu = [x for x in result['processors']
+                            if not x['template'].get(
+                                'dedicatedAccountHostOnlyFlag', False)]
 
-            ded_cpu = filter(
-                lambda x: x['template'].get(
-                    'dedicatedAccountHostOnlyFlag', False),
-                result['processors'])
+            ded_cpu = [x for x in result['processors']
+                       if x['template'].get('dedicatedAccountHostOnlyFlag',
+                                            False)]
 
             def cpus_row(c, name):
                 cpus = []
@@ -284,19 +282,16 @@ def cpus_row(c, name):
             for summary in sorted(os_summary):
                 t.add_row([
                     'os (%s)' % summary,
-                    linesep.join(sorted(filter(
-                        lambda x: x[0:len(summary)] == summary, op_sys))
-                    )
+                    linesep.join(sorted([x for x in op_sys
+                                         if x[0:len(summary)] == summary]))
                 ])
 
         if args['--disk'] or show_all:
-            local_disks = filter(
-                lambda x: x['template'].get('localDiskFlag', False),
-                result['blockDevices'])
+            local_disks = [x for x in result['blockDevices']
+                           if x['template'].get('localDiskFlag', False)]
 
-            san_disks = filter(
-                lambda x: not x['template'].get('localDiskFlag', False),
-                result['blockDevices'])
+            san_disks = [x for x in result['blockDevices']
+                         if not x['template'].get('localDiskFlag', False)]
 
             def block_rows(blocks, name):
                 simple = {}
@@ -877,7 +872,7 @@ def sync_a_record():
                     instance['primaryIpAddress'],
                     ttl=args['--ttl'])
             else:
-                recs = filter(lambda x: x['type'].lower() == 'a', records)
+                recs = [x for x in records if x['type'].lower() == 'a']
                 if len(recs) != 1:
                     raise CLIAbort("Aborting A record sync, found %d "
                                    "A record exists!" % len(recs))
diff --git a/SoftLayer/CLI/modules/config.py b/SoftLayer/CLI/modules/config.py
@@ -11,11 +11,12 @@
 
 import os.path
 
+import six
+
 from SoftLayer import (
     Client, SoftLayerAPIError, API_PUBLIC_ENDPOINT, API_PRIVATE_ENDPOINT)
 from SoftLayer.CLI import (
     CLIRunnable, CLIAbort, KeyValueTable, confirm, format_output)
-import ConfigParser
 
 
 def get_settings_from_client(client):
@@ -144,19 +145,19 @@ def execute(self, args):
 
         # Persist the config file. Read the target config file in before
         # setting the values to avoid clobbering settings
-        config = ConfigParser.RawConfigParser()
+        config = six.moves.configparser.RawConfigParser()
         config.read(config_path)
         try:
             config.add_section('softlayer')
-        except ConfigParser.DuplicateSectionError:
+        except six.moves.configparser.DuplicateSectionError:
             pass
 
         config.set('softlayer', 'username', settings['username'])
         config.set('softlayer', 'api_key', settings['api_key'])
         config.set('softlayer', 'endpoint_url', settings['endpoint_url'])
 
         f = os.fdopen(os.open(
-            config_path, (os.O_WRONLY | os.O_CREAT), 0600), 'w')
+            config_path, (os.O_WRONLY | os.O_CREAT), 0o600), 'w')
         try:
             config.write(f)
         finally:
diff --git a/SoftLayer/CLI/modules/server.py b/SoftLayer/CLI/modules/server.py
@@ -268,9 +268,8 @@ def execute(self, args):
         t.align['Reason'] = 'l'
 
         mgr = HardwareManager(self.client)
-        reasons = mgr.get_cancellation_reasons().iteritems()
 
-        for code, reason in reasons:
+        for code, reason in mgr.get_cancellation_reasons().items():
             t.add_row([code, reason])
 
         return t
diff --git a/SoftLayer/CLI/modules/summary.py b/SoftLayer/CLI/modules/summary.py
@@ -31,7 +31,7 @@ def execute(self, args):
         ])
         t.sortby = args.get('--sortby') or 'datacenter'
 
-        for name, dc in datacenters.iteritems():
+        for name, dc in datacenters.items():
             t.add_row([
                 name,
                 dc['vlanCount'],
diff --git a/SoftLayer/CLI/template.py b/SoftLayer/CLI/template.py
@@ -8,10 +8,9 @@
     :license: MIT, see LICENSE for more details.
 """
 import os.path
-import ConfigParser
-import StringIO
+import six
 
-from exceptions import ArgumentError
+from .exceptions import ArgumentError
 
 
 def update_with_template_args(args):
@@ -26,10 +25,10 @@ def update_with_template_args(args):
                 'File does not exist [-t | --template] = %s'
                 % template_path)
 
-        config = ConfigParser.ConfigParser()
+        config = six.moves.configparser.ConfigParser()
         ini_str = '[settings]\n' + open(
             os.path.expanduser(template_path), 'r').read()
-        ini_fp = StringIO.StringIO(ini_str)
+        ini_fp = six.StringIO(ini_str)
         config.readfp(ini_fp)
 
         # Merge template options with the options passed in
diff --git a/SoftLayer/__init__.py b/SoftLayer/__init__.py
@@ -15,10 +15,10 @@
 """
 from SoftLayer.consts import VERSION
 
-from API import *  # NOQA
-from managers import *  # NOQA
-from exceptions import *  # NOQA
-from auth import *  # NOQA
+from .API import *  # NOQA
+from .managers import *  # NOQA
+from .exceptions import *  # NOQA
+from .auth import *  # NOQA
 
 __title__ = 'SoftLayer'
 __version__ = VERSION
diff --git a/SoftLayer/config.py b/SoftLayer/config.py
@@ -5,11 +5,11 @@
 
     :license: MIT, see LICENSE for more details.
 """
-import ConfigParser
+import six
 import os
 import os.path
 
-from auth import BasicAuthentication
+from .auth import BasicAuthentication
 
 
 def get_client_settings_args(**kwargs):
@@ -50,7 +50,7 @@ def get_client_settings_config_file(**kwargs):
     if kwargs.get('config_file'):
         config_files.append(kwargs.get('config_file'))
     config_files = [os.path.expanduser(f) for f in config_files]
-    config = ConfigParser.RawConfigParser({
+    config = six.moves.configparser.RawConfigParser({
         'username': '',
         'api_key': '',
         'endpoint_url': '',
diff --git a/SoftLayer/exceptions.py b/SoftLayer/exceptions.py
@@ -7,7 +7,7 @@
 """
 
 
-class SoftLayerError(StandardError):
+class SoftLayerError(Exception):
     " The base SoftLayer error. "
 
 
diff --git a/SoftLayer/managers/firewall.py b/SoftLayer/managers/firewall.py
@@ -52,4 +52,4 @@ def get_firewalls(self):
                 }
             })['networkVlans']
 
-        return filter(has_firewall, results)
+        return list(filter(has_firewall, results))
diff --git a/SoftLayer/managers/hardware.py b/SoftLayer/managers/hardware.py
@@ -506,7 +506,7 @@ def _generate_create_dict(
 
         # Find all remaining required categories so we can auto-default them
         required_fields = []
-        for category, data in p_options['categories'].iteritems():
+        for category, data in p_options['categories'].items():
             if data.get('is_required') and category not in arguments:
                 if 'disk' in category:
                     # This block makes sure that we can default unspecified
diff --git a/SoftLayer/tests/CLI/helper_tests.py b/SoftLayer/tests/CLI/helper_tests.py
@@ -13,11 +13,16 @@
 from mock import patch, mock_open, call
 
 
+# if sys.version_info >= (3,):
+#     raw_input_path = 'builtins.input'
+#     open_path = 'builtins.open'
+# else:
+#     raw_input_path = '__builtin__.raw_input'
+#     open_path = '__builtin__.open'
+
 if sys.version_info >= (3,):
-    raw_input_path = 'builtins.input'
     open_path = 'builtins.open'
 else:
-    raw_input_path = '__builtin__.raw_input'
     open_path = '__builtin__.open'
 
 
@@ -40,7 +45,7 @@ def test_fail(self):
 
 class PromptTests(unittest.TestCase):
 
-    @patch(raw_input_path)
+    @patch('six.moves.input')
     def test_invalid_response(self, raw_input_mock):
         raw_input_mock.return_value = 'y'
         result = cli.helpers.valid_response('test', 'n')
@@ -57,7 +62,7 @@ def test_invalid_response(self, raw_input_mock):
         raw_input_mock.assert_called_with('test')
         self.assertEqual(result, None)
 
-    @patch(raw_input_path)
+    @patch('six.moves.input')
     def test_valid_response(self, raw_input_mock):
         raw_input_mock.return_value = 'n'
         result = cli.helpers.valid_response('test', 'n')
@@ -69,7 +74,7 @@ def test_valid_response(self, raw_input_mock):
         raw_input_mock.assert_called_with('test')
         self.assertTrue(result)
 
-    @patch(raw_input_path)
+    @patch('six.moves.input')
     def test_do_or_die(self, raw_input_mock):
         confirmed = '37347373737'
         raw_input_mock.return_value = confirmed
@@ -92,7 +97,7 @@ def test_clirunnable_exercise(self):
         res = runnable.execute({})
         self.assertEqual(res, None)
 
-    @patch(raw_input_path)
+    @patch('six.moves.input')
     def test_confirmation(self, raw_input_mock):
         raw_input_mock.return_value = 'Y'
         res = cli.confirm('Confirm?', default=False)
@@ -217,8 +222,8 @@ def test_format_output_string(self):
         t = cli.helpers.format_output('just a string', 'raw')
         self.assertEqual('just a string', t)
 
-        t = cli.helpers.format_output(u'just a string', 'raw')
-        self.assertEqual(u'just a string', t)
+        t = cli.helpers.format_output(b'just a string', 'raw')
+        self.assertEqual(b'just a string', t)
 
     def test_format_output_raw(self):
         t = cli.Table(['nothing'])
diff --git a/SoftLayer/tests/api_tests.py b/SoftLayer/tests/api_tests.py
diff --git a/SoftLayer/tests/config_tests.py b/SoftLayer/tests/config_tests.py
diff --git a/SoftLayer/transports.py b/SoftLayer/transports.py
diff --git a/SoftLayer/utils.py b/SoftLayer/utils.py
diff --git a/fabfile.py b/fabfile.py
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
diff --git a/tools/requirements.txt b/tools/requirements.txt
