Adds pylintrc and moves towards conforming to the pylintrc (google#36)

dbieber · web-flow · commit 4198d5a42bae · 2017-03-27T16:01:23.000-04:00
* Adds pylintrc and moves towards conforming to that pylintrc. * Also moves all tests to use testutils.BaseTestCase. Copybara generated commit for Python Fire. PiperOrigin-RevId: 151341797 Change-Id: I1c4d7ecf1fc4d7931e6c91328649fa5da9e916e1 Reviewed-on: https://team-review.git.corp.google.com/65525 Reviewed-by: David Bieber <dbieber@google.com>
diff --git a/examples/cipher/cipher_test.py b/examples/cipher/cipher_test.py
@@ -12,12 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from fire.examples.cipher import cipher
+from fire import testutils
 
-import unittest
+from fire.examples.cipher import cipher
 
 
-class CipherTest(unittest.TestCase):
+class CipherTest(testutils.BaseTestCase):
 
   def testCipher(self):
     self.assertEqual(cipher.rot13('Hello world!'), 'Uryyb jbeyq!')
@@ -29,4 +29,4 @@ def testCipher(self):
 
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.main()
diff --git a/examples/diff/diff_test.py b/examples/diff/diff_test.py
@@ -14,13 +14,13 @@
 
 import tempfile
 
+from fire import testutils
+
 from fire.examples.diff import diff
 from fire.examples.diff import difffull
 
-import unittest
-
 
-class DiffTest(unittest.TestCase):
+class DiffTest(testutils.BaseTestCase):
   """The purpose of these tests is to ensure the difflib wrappers works.
 
   It is not the goal of these tests to exhaustively test difflib functionality.
@@ -90,4 +90,4 @@ def testDiffFull(self):
 
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.main()
diff --git a/examples/widget/collector_test.py b/examples/widget/collector_test.py
@@ -12,13 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from fire import testutils
+
 from fire.examples.widget import collector
 from fire.examples.widget import widget
 
-import unittest
-
 
-class CollectorTest(unittest.TestCase):
+class CollectorTest(testutils.BaseTestCase):
 
   def testCollectorHasWidget(self):
     col = collector.Collector()
@@ -34,4 +34,4 @@ def testCollectorGetsWantedWidgets(self):
 
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.main()
diff --git a/examples/widget/widget_test.py b/examples/widget/widget_test.py
@@ -12,12 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from fire.examples.widget import widget
+from fire import testutils
 
-import unittest
+from fire.examples.widget import widget
 
 
-class WidgetTest(unittest.TestCase):
+class WidgetTest(testutils.BaseTestCase):
 
   def testWidgetWhack(self):
     toy = widget.Widget()
@@ -31,4 +31,4 @@ def testWidgetBang(self):
 
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.main()
diff --git a/fire/completion.py b/fire/completion.py
@@ -226,4 +226,3 @@ def _Commands(component, depth=3):
 
     for command in _Commands(member, depth - 1):
       yield (member_name,) + command
-
diff --git a/fire/completion_test.py b/fire/completion_test.py
@@ -12,17 +12,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Tests for the completion module."""
+
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
 
 from fire import completion
 from fire import test_components as tc
-
-import unittest
+from fire import testutils
 
 
-class TabCompletionTest(unittest.TestCase):
+class TabCompletionTest(testutils.BaseTestCase):
 
   def testCompletionScript(self):
     # A sanity check test to make sure the completion script satisfies some
@@ -32,7 +33,7 @@ def testCompletionScript(self):
         ['halt'],
         ['halt', '--now'],
     ]
-    script = completion._Script(name='command', commands=commands)
+    script = completion._Script(name='command', commands=commands)  # pylint: disable=protected-access
     self.assertIn('command', script)
     self.assertIn('halt', script)
     self.assertIn('"$start" == "command"', script)
@@ -135,4 +136,4 @@ def testMethodCompletions(self):
 
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.main()
diff --git a/fire/core_test.py b/fire/core_test.py
@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Tests for the core module."""
+
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
@@ -22,16 +24,14 @@
 from fire import trace
 import mock
 
-import unittest
-
 
 class CoreTest(testutils.BaseTestCase):
 
   def testOneLineResult(self):
-    self.assertEqual(core._OneLineResult(1), '1')
-    self.assertEqual(core._OneLineResult('hello'), 'hello')
-    self.assertEqual(core._OneLineResult({}), '{}')
-    self.assertEqual(core._OneLineResult({'x': 'y'}), '{"x": "y"}')
+    self.assertEqual(core._OneLineResult(1), '1')  # pylint: disable=protected-access
+    self.assertEqual(core._OneLineResult('hello'), 'hello')  # pylint: disable=protected-access
+    self.assertEqual(core._OneLineResult({}), '{}')  # pylint: disable=protected-access
+    self.assertEqual(core._OneLineResult({'x': 'y'}), '{"x": "y"}')  # pylint: disable=protected-access
 
   @mock.patch('fire.interact.Embed')
   def testInteractiveMode(self, mock_embed):
@@ -94,4 +94,4 @@ def testFireErrorMultipleValues(self):
     self.assertIsNotNone(error)
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.main()
diff --git a/fire/decorators_test.py b/fire/decorators_test.py
@@ -12,14 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Tests for the decorators module."""
+
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
 
 from fire import core
 from fire import decorators
-
-import unittest
+from fire import testutils
 
 
 class A(object):
@@ -88,7 +89,7 @@ def example7(self, arg1, arg2=None, *varargs, **kwargs):
     return arg1, arg2, varargs, kwargs
 
 
-class FireDecoratorsTest(unittest.TestCase):
+class FireDecoratorsTest(testutils.BaseTestCase):
 
   def testSetParseFnsNamedArgs(self):
     self.assertEqual(core.Fire(A, 'double 2'), 4)
@@ -147,4 +148,4 @@ def testSetParseFn(self):
 
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.main()
diff --git a/fire/fire_import_test.py b/fire/fire_import_test.py
@@ -12,14 +12,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import mock
+"""Tests importing the fire module."""
+
 import sys
-import unittest
 
 import fire
+from fire import testutils
+import mock
 
 
-class FireImportTest(unittest.TestCase):
+class FireImportTest(testutils.BaseTestCase):
   """Tests importing Fire."""
 
   def testFire(self):
@@ -35,4 +37,4 @@ def testNoPrivateMethods(self):
 
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.main()
diff --git a/fire/fire_test.py b/fire/fire_test.py
@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Tests for the fire module."""
+
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
@@ -414,4 +416,4 @@ def testTraceErrors(self):
 
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.main()
diff --git a/fire/helputils_test.py b/fire/helputils_test.py
@@ -12,19 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Tests for the helputils module."""
+
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
 
+import os
+
 from fire import helputils
 from fire import test_components as tc
+from fire import testutils
 import six
 
-import unittest
-import os
-
 
-class HelpUtilsTest(unittest.TestCase):
+class HelpUtilsTest(testutils.BaseTestCase):
 
   def testHelpStringClass(self):
     helpstring = helputils.HelpString(tc.NoDefaults)
@@ -126,4 +128,4 @@ def testHelpClassNoInit(self):
 
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.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)
+       kwonlyargs, kwonlydefaults, annotations) = inspect.getfullargspec(fn)  # pylint: disable=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/inspectutils_test.py b/fire/inspectutils_test.py
@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Tests for the inspectutils module."""
+
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
@@ -21,11 +23,12 @@
 
 from fire import inspectutils
 from fire import test_components as tc
+from fire import testutils
 
 import six
 
 
-class InspectUtilsTest(unittest.TestCase):
+class InspectUtilsTest(testutils.BaseTestCase):
 
   def testGetFullArgSpec(self):
     spec = inspectutils.GetFullArgSpec(tc.identity)
@@ -113,4 +116,4 @@ def testInfoClassNoInit(self):
 
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.main()
diff --git a/fire/interact_test.py b/fire/interact_test.py
@@ -12,17 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Tests for the interact module."""
+
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
 
 from fire import interact
-import mock
+from fire import testutils
 
-import unittest
+import mock
 
 
-class InteractTest(unittest.TestCase):
+class InteractTest(testutils.BaseTestCase):
 
   @mock.patch('IPython.start_ipython')
   def testInteract(self, mock_ipython):
@@ -40,4 +42,4 @@ def testInteractVariables(self, mock_ipython):
     self.assertTrue(mock_ipython.called)
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.main()
diff --git a/fire/parser_fuzz_test.py b/fire/parser_fuzz_test.py
@@ -12,22 +12,23 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Fuzz tests for the parser module."""
+
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
 
 from fire import parser
+from fire import testutils
 from hypothesis import example
 from hypothesis import given
 from hypothesis import settings
 from hypothesis import strategies as st
 import Levenshtein
 import six
 
-import unittest
-
 
-class ParserFuzzTest(unittest.TestCase):
+class ParserFuzzTest(testutils.BaseTestCase):
 
   @given(st.text(min_size=1), settings=settings.Settings(max_examples=10000))
   @example('True')
@@ -94,4 +95,4 @@ def testDefaultParseValueFuzz(self, value):
 
 
 if __name__ == '__main__':
-  unittest.main()
+  testutils.main()
diff --git a/fire/parser_test.py b/fire/parser_test.py
diff --git a/fire/test_components.py b/fire/test_components.py
diff --git a/fire/test_components_test.py b/fire/test_components_test.py
diff --git a/fire/testutils.py b/fire/testutils.py
diff --git a/fire/trace_test.py b/fire/trace_test.py
diff --git a/pylintrc b/pylintrc
diff --git a/setup.py b/setup.py

Original file line number	Diff line number	Diff line change
`@@ -226,4 +226,3 @@ def _Commands(component, depth=3):`
`226`	`226`
`227`	`227`	`for command in _Commands(member, depth - 1):`
`228`	`228`	`yield (member_name,) + command`
`229`		`-`