Adds pylint script to .travis.yml (google#38)

dbieber · web-flow · commit 51fc990ddc5e · 2017-03-28T10:51:47.000-04:00
diff --git a/.travis.yml b/.travis.yml
@@ -6,6 +6,9 @@ python:
   - "3.6"
 before_install:
   - pip install --upgrade setuptools pip
+  - pip install --upgrade pylint pytest pytest-pylint pytest-runner
 install:
   - python setup.py develop
-script: nosetests --ignore-files=parser_fuzz_test.py --exclude=test_components_py3.py
+script:
+  - python -m pytest
+  - if [[ $TRAVIS_PYTHON_VERSION != 3.6 ]]; then pylint fire --ignore=test_components_py3.py,parser_fuzz_test.py; fi
diff --git a/examples/__init__.py b/examples/__init__.py
diff --git a/examples/cipher/__init__.py b/examples/cipher/__init__.py
diff --git a/examples/cipher/cipher_test.py b/examples/cipher/cipher_test.py
@@ -12,9 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Tests for the cipher module."""
+
 from fire import testutils
 
-from fire.examples.cipher import cipher
+from examples.cipher import cipher
 
 
 class CipherTest(testutils.BaseTestCase):
diff --git a/examples/diff/__init__.py b/examples/diff/__init__.py
diff --git a/examples/diff/diff_test.py b/examples/diff/diff_test.py
@@ -12,12 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Tests for the diff and difffull modules."""
+
 import tempfile
 
 from fire import testutils
 
-from fire.examples.diff import diff
-from fire.examples.diff import difffull
+from examples.diff import diff
+from examples.diff import difffull
 
 
 class DiffTest(testutils.BaseTestCase):
@@ -30,8 +32,8 @@ def setUp(self):
     self.file1 = file1 = tempfile.NamedTemporaryFile()
     self.file2 = file2 = tempfile.NamedTemporaryFile()
 
-    file1.write('test\ntest1\n')
-    file2.write('test\ntest2\nextraline\n')
+    file1.write(b'test\ntest1\n')
+    file2.write(b'test\ntest2\nextraline\n')
 
     file1.flush()
     file2.flush()
diff --git a/examples/identity/__init__.py b/examples/identity/__init__.py
diff --git a/examples/widget/__init__.py b/examples/widget/__init__.py
diff --git a/examples/widget/collector.py b/examples/widget/collector.py
@@ -16,7 +16,7 @@
 
 import fire
 
-from fire.examples.widget import widget
+from examples.widget import widget
 
 
 class Collector(object):
@@ -28,7 +28,7 @@ def __init__(self):
 
   def collect_widgets(self):
     """Returns all the widgets the Collector wants."""
-    return [widget.Widget() for _ in xrange(self.desired_widget_count)]
+    return [widget.Widget() for _ in range(self.desired_widget_count)]
 
 
 def main():
diff --git a/examples/widget/collector_test.py b/examples/widget/collector_test.py
@@ -12,10 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Tests for the collector module."""
+
 from fire import testutils
 
-from fire.examples.widget import collector
-from fire.examples.widget import widget
+from examples.widget import collector
+from examples.widget import widget
 
 
 class CollectorTest(testutils.BaseTestCase):
@@ -26,11 +28,11 @@ def testCollectorHasWidget(self):
 
   def testCollectorWantsMoreWidgets(self):
     col = collector.Collector()
-    self.assertEquals(col.desired_widget_count, 10)
+    self.assertEqual(col.desired_widget_count, 10)
 
   def testCollectorGetsWantedWidgets(self):
     col = collector.Collector()
-    self.assertEquals(len(col.collect_widgets()), 10)
+    self.assertEqual(len(col.collect_widgets()), 10)
 
 
 if __name__ == '__main__':
diff --git a/examples/widget/widget.py b/examples/widget/widget.py
@@ -21,7 +21,7 @@ class Widget(object):
 
   def whack(self, n=1):
     """Prints "whack!" n times."""
-    return ' '.join('whack!' for _ in xrange(n))
+    return ' '.join('whack!' for _ in range(n))
 
   def bang(self, noise='bang'):
     """Makes a loud noise."""
diff --git a/examples/widget/widget_test.py b/examples/widget/widget_test.py
@@ -12,9 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Tests for the widget module."""
+
 from fire import testutils
 
-from fire.examples.widget import widget
+from examples.widget import widget
 
 
 class WidgetTest(testutils.BaseTestCase):
diff --git a/fire/decorators_test.py b/fire/decorators_test.py
@@ -23,7 +23,7 @@
 from fire import testutils
 
 
-class A(object):
+class NoDefaults(object):
 
   @decorators.SetParseFns(count=int)
   def double(self, count):
@@ -43,7 +43,7 @@ def double(count):
   return 2 * count
 
 
-class B(object):
+class WithDefaults(object):
 
   @decorators.SetParseFns(float)
   def example1(self, arg1=10):
@@ -54,14 +54,14 @@ def example2(self, arg1=10):
     return arg1, type(arg1)
 
 
-class C(object):
+class MixedArguments(object):
 
   @decorators.SetParseFns(float, arg2=str)
   def example3(self, arg1, arg2):
     return arg1, arg2
 
 
-class D(object):
+class PartialParseFn(object):
 
   @decorators.SetParseFns(arg1=str)
   def example4(self, arg1, arg2):
@@ -72,7 +72,7 @@ def example5(self, arg1, arg2):
     return arg1, arg2
 
 
-class E(object):
+class WithKwargs(object):
 
   @decorators.SetParseFns(mode=str, count=int)
   def example6(self, **kwargs):
@@ -82,7 +82,7 @@ def example6(self, **kwargs):
     )
 
 
-class F(object):
+class WithVarArgs(object):
 
   @decorators.SetParseFn(str)
   def example7(self, arg1, arg2=None, *varargs, **kwargs):
@@ -92,59 +92,64 @@ def example7(self, arg1, arg2=None, *varargs, **kwargs):
 class FireDecoratorsTest(testutils.BaseTestCase):
 
   def testSetParseFnsNamedArgs(self):
-    self.assertEqual(core.Fire(A, 'double 2'), 4)
-    self.assertEqual(core.Fire(A, 'triple 4'), 12.0)
+    self.assertEqual(core.Fire(NoDefaults, 'double 2'), 4)
+    self.assertEqual(core.Fire(NoDefaults, 'triple 4'), 12.0)
 
   def testSetParseFnsPositionalArgs(self):
-    self.assertEqual(core.Fire(A, 'quadruple 5'), 20)
+    self.assertEqual(core.Fire(NoDefaults, 'quadruple 5'), 20)
 
   def testSetParseFnsFnWithPositionalArgs(self):
     self.assertEqual(core.Fire(double, '5'), 10)
 
   def testSetParseFnsDefaultsFromPython(self):
     # When called from Python, function should behave normally.
-    self.assertTupleEqual(B().example1(), (10, int))
-    self.assertEqual(B().example1(5), (5, int))
-    self.assertEqual(B().example1(12.0), (12, float))
+    self.assertTupleEqual(WithDefaults().example1(), (10, int))
+    self.assertEqual(WithDefaults().example1(5), (5, int))
+    self.assertEqual(WithDefaults().example1(12.0), (12, float))
 
   def testSetParseFnsDefaultsFromFire(self):
     # Fire should use the decorator to know how to parse string arguments.
-    self.assertEqual(core.Fire(B, 'example1'), (10, int))
-    self.assertEqual(core.Fire(B, 'example1 10'), (10, float))
-    self.assertEqual(core.Fire(B, 'example1 13'), (13, float))
-    self.assertEqual(core.Fire(B, 'example1 14.0'), (14, float))
+    self.assertEqual(core.Fire(WithDefaults, 'example1'), (10, int))
+    self.assertEqual(core.Fire(WithDefaults, 'example1 10'), (10, float))
+    self.assertEqual(core.Fire(WithDefaults, 'example1 13'), (13, float))
+    self.assertEqual(core.Fire(WithDefaults, 'example1 14.0'), (14, float))
 
   def testSetParseFnsNamedDefaultsFromPython(self):
     # When called from Python, function should behave normally.
-    self.assertTupleEqual(B().example2(), (10, int))
-    self.assertEqual(B().example2(5), (5, int))
-    self.assertEqual(B().example2(12.0), (12, float))
+    self.assertTupleEqual(WithDefaults().example2(), (10, int))
+    self.assertEqual(WithDefaults().example2(5), (5, int))
+    self.assertEqual(WithDefaults().example2(12.0), (12, float))
 
   def testSetParseFnsNamedDefaultsFromFire(self):
     # Fire should use the decorator to know how to parse string arguments.
-    self.assertEqual(core.Fire(B, 'example2'), (10, int))
-    self.assertEqual(core.Fire(B, 'example2 10'), (10, float))
-    self.assertEqual(core.Fire(B, 'example2 13'), (13, float))
-    self.assertEqual(core.Fire(B, 'example2 14.0'), (14, float))
+    self.assertEqual(core.Fire(WithDefaults, 'example2'), (10, int))
+    self.assertEqual(core.Fire(WithDefaults, 'example2 10'), (10, float))
+    self.assertEqual(core.Fire(WithDefaults, 'example2 13'), (13, float))
+    self.assertEqual(core.Fire(WithDefaults, 'example2 14.0'), (14, float))
 
   def testSetParseFnsPositionalAndNamed(self):
-    self.assertEqual(core.Fire(C, 'example3 10 10'), (10, '10'))
+    self.assertEqual(core.Fire(MixedArguments, 'example3 10 10'), (10, '10'))
 
   def testSetParseFnsOnlySomeTypes(self):
-    self.assertEqual(core.Fire(D, 'example4 10 10'), ('10', 10))
-    self.assertEqual(core.Fire(D, 'example5 10 10'), (10, '10'))
+    self.assertEqual(core.Fire(PartialParseFn, 'example4 10 10'), ('10', 10))
+    self.assertEqual(core.Fire(PartialParseFn, 'example5 10 10'), (10, '10'))
 
   def testSetParseFnsForKeywordArgs(self):
-    self.assertEqual(core.Fire(E, 'example6'), ('default', 0))
-    self.assertEqual(core.Fire(E, 'example6 --herring "red"'), ('default', 0))
-    self.assertEqual(core.Fire(E, 'example6 --mode train'), ('train', 0))
-    self.assertEqual(core.Fire(E, 'example6 --mode 3'), ('3', 0))
-    self.assertEqual(core.Fire(E, 'example6 --mode -1 --count 10'), ('-1', 10))
-    self.assertEqual(core.Fire(E, 'example6 --count -2'), ('default', -2))
+    self.assertEqual(core.Fire(WithKwargs, 'example6'), ('default', 0))
+    self.assertEqual(
+        core.Fire(WithKwargs, 'example6 --herring "red"'), ('default', 0))
+    self.assertEqual(
+        core.Fire(WithKwargs, 'example6 --mode train'), ('train', 0))
+    self.assertEqual(core.Fire(WithKwargs, 'example6 --mode 3'), ('3', 0))
+    self.assertEqual(
+        core.Fire(WithKwargs, 'example6 --mode -1 --count 10'), ('-1', 10))
+    self.assertEqual(
+        core.Fire(WithKwargs, 'example6 --count -2'), ('default', -2))
 
   def testSetParseFn(self):
-    self.assertEqual(core.Fire(F, 'example7 1 --arg2=2 3 4 --kwarg=5'),
-                     ('1', '2', ('3', '4'), {'kwarg': '5'}))
+    self.assertEqual(
+        core.Fire(WithVarArgs, 'example7 1 --arg2=2 3 4 --kwarg=5'),
+        ('1', '2', ('3', '4'), {'kwarg': '5'}))
 
 
 if __name__ == '__main__':
diff --git a/fire/inspectutils.py b/fire/inspectutils.py
@@ -94,7 +94,7 @@ def GetFullArgSpec(fn):
       annotations = getattr(fn, '__annotations__', None)
     else:
       (args, varargs, varkw, defaults,
-       kwonlyargs, kwonlydefaults, annotations) = inspect.getfullargspec(fn)  # pylint: disable=no-member
+       kwonlyargs, kwonlydefaults, annotations) = inspect.getfullargspec(fn)  # pylint: disable=deprecated-method,no-member
 
   except TypeError:
     # If we can't get the argspec, how do we know if the fn should take args?
diff --git a/fire/test_components.py b/fire/test_components.py
@@ -21,7 +21,7 @@
 import six
 
 if six.PY3:
-  from fire import test_components_py3 as py3  # pylint: disable=unused-import
+  from fire import test_components_py3 as py3  # pylint: disable=unused-import,no-name-in-module
 
 
 def identity(arg1, arg2, arg3=10, arg4=20, *arg5, **arg6):
diff --git a/pylintrc b/pylintrc
@@ -95,7 +95,7 @@ class-rgx=[A-Z_][a-zA-Z0-9]+$
 function-rgx=^(?:(?P<camel_case>_?[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_?[a-z][a-z0-9_]*))$
 
 # Regular expression which should only match correct method names
-method-rgx=^(?:(?P<exempt>__[a-z0-9_]+__|next)|(?P<camel_case>_{0,2}(test)?[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_{0,2}[a-z][a-z0-9_]*))$
+method-rgx=^(?:(?P<exempt>__[a-z0-9_]+__|next)|(?P<camel_case>_{0,2}(?:test|assert)?[A-Z][a-zA-Z0-9]*)|(?:_{0,2}[a-z][a-z0-9_]*))$
 
 # Regular expression which should only match correct instance attribute names
 attr-rgx=^_{0,2}[a-z][a-z0-9_]*$
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,5 @@
+[aliases]
+test=pytest
+
+[tool:pytest]
+addopts = --ignore=fire/test_components_py3.py --ignore=fire/parser_fuzz_test.py
diff --git a/setup.py b/setup.py
@@ -16,7 +16,8 @@
 
 from setuptools import setup
 
-long_description = """
+
+LONG_DESCRIPTION = """
 Python Fire is a library for automatically generating command line interfaces
 (CLIs) with a single line of code.
 
@@ -25,15 +26,15 @@
 it fires off your command.
 """.strip()
 
-short_description = """
+SHORT_DESCRIPTION = """
 A library for automatically generating commane line interfaces.""".strip()
 
-dependencies = [
+DEPENDENCIES = [
     'ipython',
     'six',
 ]
 
-test_dependencies = [
+TEST_DEPENDENCIES = [
     'hypothesis',
     'mock',
     'python-Levenshtein',
@@ -43,8 +44,8 @@
     name='fire',
     version='0.1.0',
 
-    description=short_description,
-    long_description=long_description,
+    description=SHORT_DESCRIPTION,
+    long_description=LONG_DESCRIPTION,
 
     url='https://github.com/google/python-fire',
 
@@ -79,6 +80,6 @@
 
     packages=['fire'],
 
-    install_requires=dependencies,
-    tests_require=test_dependencies,
+    install_requires=DEPENDENCIES,
+    tests_require=TEST_DEPENDENCIES,
 )
