Improves Style Issues

sudorandom · sudorandom · commit f038ddd2df74 · 2014-10-23T17:47:58.000-05:00
diff --git a/SoftLayer/CLI/core.py b/SoftLayer/CLI/core.py
@@ -20,6 +20,9 @@
 # pylint: disable=too-many-public-methods, broad-except, unused-argument
 # pylint: disable=redefined-builtin, super-init-not-called
 
+# Disable the cyclic import error. This is handled by an inline import.
+# pylint: disable=cyclic-import
+
 DEBUG_LOGGING_MAP = {
     0: logging.CRITICAL,
     1: logging.WARNING,
@@ -160,8 +163,8 @@ def cli(ctx,
     if env.client is None:
         # Environment can be passed in explicitly. This is used for testing
         if fixtures:
-            from SoftLayer import testing
-            real_client = testing.FixtureClient()
+            from SoftLayer import fixture_client
+            real_client = fixture_client.FixtureClient()
         else:
             # Create SL Client
             real_client = SoftLayer.Client(proxy=proxy, config_file=config)
diff --git a/SoftLayer/CLI/environment.py b/SoftLayer/CLI/environment.py
@@ -21,6 +21,7 @@
 
 class Environment(object):
     """Provides access to the current CLI environment."""
+
     def __init__(self):
         # {'path:to:command': ModuleLoader()}
         # {'vs:list': ModuleLoader()}
@@ -70,9 +71,12 @@ def list_commands(self, *path):
 
         commands = []
         for command in self.commands.keys():
+
             # Filter based on prefix and the segment length
             if all([command.startswith(path_str),
                     len(path) == command.count(":")]):
+
+                # offset is used to exclude the path that the caller requested.
                 offset = len(path_str)+1 if path_str else 0
                 commands.append(command[offset:])
 
diff --git a/SoftLayer/fixture_client.py b/SoftLayer/fixture_client.py
@@ -41,6 +41,7 @@ def __getitem__(self, service_name):
         return service
 
     def call(self, service, method, *args, **kwargs):
+        """Call the method on the service."""
         return getattr(self[service], method)(*args, **kwargs)
 
     def reset_mock(self):
@@ -88,6 +89,7 @@ def _wrap_fixture(fixture):
         return call_handler
 
     def wrapped(*args, **kwargs):
+        """When this is called, return the fixture (ignoring the arguments)."""
         return fixture
 
     return wrapped
diff --git a/SoftLayer/testing/__init__.py b/SoftLayer/testing/__init__.py
@@ -14,7 +14,7 @@
 
 from SoftLayer.CLI import core
 from SoftLayer.CLI import environment
-from SoftLayer.testing import fixture_client
+from SoftLayer import fixture_client
 
 from click import testing
 
@@ -47,12 +47,17 @@ def run_command(self,
                     env=None,
                     fixtures=True,
                     fmt='json'):
+        """A helper that runs a SoftLayer CLI command.
 
-        runner = testing.CliRunner()
-        if fixtures:
+        This returns a click.testing.Result object.
+        """
+        args = args or []
+
+        if fixtures is True:
             args.insert(0, '--fixtures')
         args.insert(0, '--format=%s' % fmt)
 
+        runner = testing.CliRunner()
         return runner.invoke(core.cli, args=args, obj=env or self.env)
 
 __all__ = ['unittest', 'FixtureClient']
diff --git a/SoftLayer/utils.py b/SoftLayer/utils.py
@@ -9,14 +9,16 @@
 
 import six
 
+# pylint: disable=pointless-except, no-member, invalid-name
+
 UUID_RE = re.compile(r'^[0-9a-f\-]{36}$', re.I)
 KNOWN_OPERATIONS = ['<=', '>=', '<', '>', '~', '!~', '*=', '^=', '$=', '_=']
 
-configparser = six.moves.configparser  # pylint: disable=E1101,C0103
-console_input = six.moves.input  # pylint: disable=E1101,C0103
-string_types = six.string_types  # pylint: disable=C0103
-StringIO = six.StringIO  # pylint: disable=C0103
-xmlrpc_client = six.moves.xmlrpc_client  # pylint: disable=E1101,C0103
+configparser = six.moves.configparser
+console_input = six.moves.input
+string_types = six.string_types
+StringIO = six.StringIO
+xmlrpc_client = six.moves.xmlrpc_client
 
 
 def lookup(dic, key, *keys):
diff --git a/fabfile.py b/fabfile.py
@@ -18,10 +18,10 @@ def upload():
 
 def clean():
     puts("* Cleaning Repo")
-    dirs = ['.tox', 'SoftLayer.egg-info', 'build', 'dist']
-    for d in dirs:
-        if os.path.exists(d) and os.path.isdir(d):
-            shutil.rmtree(d)
+    directories = ['.tox', 'SoftLayer.egg-info', 'build', 'dist']
+    for directory in directories:
+        if os.path.exists(directory) and os.path.isdir(directory):
+            shutil.rmtree(directory)
 
 
 def release(version, force=False):
@@ -37,8 +37,8 @@ def release(version, force=False):
     clean()
 
     puts(" * Tagging Version %s" % version_str)
-    f = 'f' if force else ''
-    local("git tag -%sam \"%s\" %s" % (f, version_str, version_str))
+    force_option = 'f' if force else ''
+    local("git tag -%sam \"%s\" %s" % (force_option, version_str, version_str))
 
     local("pip install wheel")
 
diff --git a/setup.py b/setup.py
@@ -1,3 +1,4 @@
+from __future__ import print_function
 import sys
 import os
 
@@ -13,34 +14,29 @@
     print("Python 2.6 or greater is required.")
     sys.exit(1)
 
-extra = {}
-
-requires = [
+REQUIRES = [
     'six >= 1.7.0',
     'prettytable >= 0.7.0',
     'click',
     'requests',
 ]
 
 if sys.version_info < (2, 7):
-    requires.append('importlib')
+    REQUIRES.append('importlib')
 
-description = "A library for SoftLayer's API"
+DESCRIPTION = "A library for SoftLayer's API"
 
 if os.path.exists('README.rst'):
-    f = open('README.rst')
-    try:
-        long_description = f.read()
-    finally:
-        f.close()
+    with open('README.rst') as readme_file:
+        LONG_DESCRIPTION = readme_file.read()
 else:
-    long_description = description
+    LONG_DESCRIPTION = DESCRIPTION
 
 setup(
     name='SoftLayer',
     version='3.3.0',
-    description=description,
-    long_description=long_description,
+    description=DESCRIPTION,
+    long_description=LONG_DESCRIPTION,
     author='SoftLayer Technologies, Inc.',
     author_email='sldn@softlayer.com',
     packages=find_packages(exclude=["SoftLayer.tests"]),
@@ -50,9 +46,9 @@
     entry_points={
         'console_scripts': ['sl = SoftLayer.CLI.core:main'],
     },
-    package_data={'SoftLayer': ['tests/fixtures/*.conf']},
     test_suite='nose.collector',
-    install_requires=requires,
+    install_requires=REQUIRES,
+    keywords=['softlayer', 'cloud'],
     classifiers=[
         'Environment :: Console',
         'Environment :: Web Environment',
@@ -69,5 +65,4 @@
         'Programming Language :: Python :: Implementation :: CPython',
         'Programming Language :: Python :: Implementation :: PyPy',
     ],
-    **extra
 )
diff --git a/tox.ini b/tox.ini
@@ -24,22 +24,21 @@ commands =
     flake8 SoftLayer
     pylint SoftLayer \
            -r n \ # Don't show the long report
-           --ignore=tests,testing \
-           -d R0903 \ # Too few public methods
-           -d R0914 \ # Too many local variables
-           -d R0201 \ # Method could be a function
-           -d I0011 \ # Locally Disabling
-           -d W0142 \ # Used * or ** magic
+           --ignore=tests,fixtures \
+           -d too-many-locals \ # Too many local variables
+           -d no-self-use \     # Method could be a function
+           -d star-args \       # Used * or ** magic
+           -d I0011 \           # Locally Disabling
            --max-args=20 \
            --max-branches=40 \
            --max-statements=86 \
            --max-module-lines=1200 \
            --max-returns=8 \
+           --min-public-methods=0 \
            --min-similarity-lines=50
-    pylint SoftLayer/testing \
-          -d C0103 \ # Fixtures don't follow proper naming conventions
-          -d C0111 \ # Fixtures don't have docstrings
-          -d I0011 \ # Locally Disabling
+    pylint SoftLayer/testing/fixtures \
+          -d invalid-name \ # Fixtures don't follow proper naming conventions
+          -d missing-docstring \ # Fixtures don't have docstrings
           --max-module-lines=2000 \
           --min-similarity-lines=50 \
           -r n
