diff options
| author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2019-07-21 21:53:05 +0200 |
|---|---|---|
| committer | Claudiu Popa <pcmanticore@gmail.com> | 2019-07-22 12:39:50 +0200 |
| commit | eae3436de87df5abb08a4583e345e7afa5510ac9 (patch) | |
| tree | 9130a6ff159f8f972d731e861771024bbc476d0f /tests/extensions/test_check_raise_docs.py | |
| parent | a598e2b5514da298aae821075ec1d444b53f9ab4 (diff) | |
| download | pylint-git-eae3436de87df5abb08a4583e345e7afa5510ac9.tar.gz | |
[black style] Apply black style on unformatted python file
Diffstat (limited to 'tests/extensions/test_check_raise_docs.py')
| -rw-r--r-- | tests/extensions/test_check_raise_docs.py | 338 |
1 files changed, 199 insertions, 139 deletions
diff --git a/tests/extensions/test_check_raise_docs.py b/tests/extensions/test_check_raise_docs.py index c51a1fdaa..c2d7556a4 100644 --- a/tests/extensions/test_check_raise_docs.py +++ b/tests/extensions/test_check_raise_docs.py @@ -20,43 +20,49 @@ from pylint.testutils import CheckerTestCase, Message, set_config class TestDocstringCheckerRaise(CheckerTestCase): """Tests for pylint_plugin.RaiseDocChecker""" + CHECKER_CLASS = DocstringParameterChecker def test_ignores_no_docstring(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + """ def my_func(self): raise RuntimeError('hi') #@ - ''') + """ + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_ignores_unknown_style(self): - node = astroid.extract_node(''' + node = astroid.extract_node( + ''' def my_func(self): """This is a docstring.""" raise RuntimeError('hi') - ''') + ''' + ) raise_node = node.body[0] with self.assertNoMessages(): self.checker.visit_raise(raise_node) @set_config(accept_no_raise_doc=False) def test_warns_unknown_style(self): - node = astroid.extract_node(''' + node = astroid.extract_node( + ''' def my_func(self): """This is a docstring.""" raise RuntimeError('hi') - ''') + ''' + ) raise_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('RuntimeError', ))): + Message(msg_id="missing-raises-doc", node=node, args=("RuntimeError",)) + ): self.checker.visit_raise(raise_node) def test_find_missing_sphinx_raises(self): - node = astroid.extract_node(''' + node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -64,17 +70,17 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ raise RuntimeError('hi') raise NameError('hi') - ''') + ''' + ) raise_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('RuntimeError', ))): + Message(msg_id="missing-raises-doc", node=node, args=("RuntimeError",)) + ): self.checker.visit_raise(raise_node) def test_find_missing_google_raises(self): - node = astroid.extract_node(''' + node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -83,17 +89,17 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ raise RuntimeError('hi') raise NameError('hi') - ''') + ''' + ) raise_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('RuntimeError', ))): + Message(msg_id="missing-raises-doc", node=node, args=("RuntimeError",)) + ): self.checker.visit_raise(raise_node) def test_find_google_attr_raises_exact_exc(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a google docstring. @@ -102,13 +108,15 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ import re raise re.error('hi') #@ - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) pass def test_find_google_attr_raises_substr_exc(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a google docstring. @@ -117,12 +125,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ from re import error raise error('hi') #@ - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_find_valid_missing_google_attr_raises(self): - node = astroid.extract_node(''' + node = astroid.extract_node( + ''' def my_func(self): """This is a google docstring. @@ -131,17 +141,17 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ from re import error raise error('hi') - ''') + ''' + ) raise_node = node.body[1] with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('error', ))): + Message(msg_id="missing-raises-doc", node=node, args=("error",)) + ): self.checker.visit_raise(raise_node) def test_find_invalid_missing_google_attr_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a google docstring. @@ -150,7 +160,8 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ from re import error raise error('hi') #@ - ''') + ''' + ) # pylint allows this to pass since the comparison between Raises and # raise are based on the class name, not the qualified name. with self.assertNoMessages(): @@ -174,7 +185,8 @@ class TestDocstringCheckerRaise(CheckerTestCase): self.checker.visit_raise(raise_node) def test_find_missing_numpy_raises(self): - node = astroid.extract_node(''' + node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -185,17 +197,17 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ raise RuntimeError('hi') raise NameError('hi') - ''') + ''' + ) raise_node = node.body[0] with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('RuntimeError', ))): + Message(msg_id="missing-raises-doc", node=node, args=("RuntimeError",)) + ): self.checker.visit_raise(raise_node) def test_ignore_spurious_sphinx_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -205,12 +217,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): :exception ValueError: Never """ raise RuntimeError('Blah') #@ - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_find_all_sphinx_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -223,12 +237,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): raise NameError('hi') raise OSError(2, 'abort!') raise ValueError('foo') - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_find_all_google_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -238,12 +254,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ raise RuntimeError('hi') #@ raise NameError('hi') - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_find_all_numpy_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -256,12 +274,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ raise RuntimeError('hi') #@ raise NameError('hi') - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_finds_rethrown_sphinx_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -273,17 +293,17 @@ class TestDocstringCheckerRaise(CheckerTestCase): raise #@ raise NameError('hi') - ''') + ''' + ) node = raise_node.frame() with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('RuntimeError', ))): + Message(msg_id="missing-raises-doc", node=node, args=("RuntimeError",)) + ): self.checker.visit_raise(raise_node) def test_find_rethrown_google_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -296,17 +316,17 @@ class TestDocstringCheckerRaise(CheckerTestCase): raise #@ raise NameError('hi') - ''') + ''' + ) node = raise_node.frame() with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('RuntimeError', ))): + Message(msg_id="missing-raises-doc", node=node, args=("RuntimeError",)) + ): self.checker.visit_raise(raise_node) def test_find_rethrown_numpy_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -321,17 +341,17 @@ class TestDocstringCheckerRaise(CheckerTestCase): raise #@ raise NameError('hi') - ''') + ''' + ) node = raise_node.frame() with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('RuntimeError', ))): + Message(msg_id="missing-raises-doc", node=node, args=("RuntimeError",)) + ): self.checker.visit_raise(raise_node) def test_finds_rethrown_sphinx_multiple_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -343,17 +363,21 @@ class TestDocstringCheckerRaise(CheckerTestCase): raise #@ raise NameError('hi') - ''') + ''' + ) node = raise_node.frame() with self.assertAddsMessages( Message( - msg_id='missing-raises-doc', + msg_id="missing-raises-doc", node=node, - args=('RuntimeError, ValueError', ))): + args=("RuntimeError, ValueError",), + ) + ): self.checker.visit_raise(raise_node) def test_find_rethrown_google_multiple_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -366,17 +390,21 @@ class TestDocstringCheckerRaise(CheckerTestCase): raise #@ raise NameError('hi') - ''') + ''' + ) node = raise_node.frame() with self.assertAddsMessages( Message( - msg_id='missing-raises-doc', + msg_id="missing-raises-doc", node=node, - args=('RuntimeError, ValueError', ))): + args=("RuntimeError, ValueError",), + ) + ): self.checker.visit_raise(raise_node) def test_find_rethrown_numpy_multiple_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -391,17 +419,21 @@ class TestDocstringCheckerRaise(CheckerTestCase): raise #@ raise NameError('hi') - ''') + ''' + ) node = raise_node.frame() with self.assertAddsMessages( Message( - msg_id='missing-raises-doc', + msg_id="missing-raises-doc", node=node, - args=('RuntimeError, ValueError', ))): + args=("RuntimeError, ValueError",), + ) + ): self.checker.visit_raise(raise_node) def test_ignores_caught_sphinx_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -413,12 +445,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): pass raise NameError('hi') - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_ignores_caught_google_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -431,12 +465,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): pass raise NameError('hi') - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_ignores_caught_numpy_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a numpy docstring. @@ -451,12 +487,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): pass raise NameError('hi') - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_find_numpy_attr_raises_exact_exc(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a numpy docstring. @@ -467,13 +505,15 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ import re raise re.error('hi') #@ - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) pass def test_find_numpy_attr_raises_substr_exc(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a numpy docstring. @@ -484,12 +524,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ from re import error raise error('hi') #@ - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_find_valid_missing_numpy_attr_raises(self): - node = astroid.extract_node(''' + node = astroid.extract_node( + ''' def my_func(self): """This is a numpy docstring. @@ -500,17 +542,17 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ from re import error raise error('hi') - ''') + ''' + ) raise_node = node.body[1] with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('error', ))): + Message(msg_id="missing-raises-doc", node=node, args=("error",)) + ): self.checker.visit_raise(raise_node) def test_find_invalid_missing_numpy_attr_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a numpy docstring. @@ -521,7 +563,8 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ from re import error raise error('hi') #@ - ''') + ''' + ) # pylint allows this to pass since the comparison between Raises and # raise are based on the class name, not the qualified name. with self.assertNoMessages(): @@ -547,7 +590,8 @@ class TestDocstringCheckerRaise(CheckerTestCase): self.checker.visit_raise(raise_node) def test_find_missing_sphinx_raises_infer_from_instance(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -556,17 +600,17 @@ class TestDocstringCheckerRaise(CheckerTestCase): my_exception = RuntimeError('hi') raise my_exception #@ raise NameError('hi') - ''') + ''' + ) node = raise_node.frame() with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('RuntimeError', ))): + Message(msg_id="missing-raises-doc", node=node, args=("RuntimeError",)) + ): self.checker.visit_raise(raise_node) def test_find_missing_sphinx_raises_infer_from_function(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -576,17 +620,17 @@ class TestDocstringCheckerRaise(CheckerTestCase): return RuntimeError(val) raise ex_func('hi') #@ raise NameError('hi') - ''') + ''' + ) node = raise_node.frame() with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('RuntimeError', ))): + Message(msg_id="missing-raises-doc", node=node, args=("RuntimeError",)) + ): self.checker.visit_raise(raise_node) def test_find_sphinx_attr_raises_exact_exc(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a sphinx docstring. @@ -594,12 +638,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ import re raise re.error('hi') #@ - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_find_sphinx_attr_raises_substr_exc(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a sphinx docstring. @@ -607,12 +653,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ from re import error raise error('hi') #@ - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_find_valid_missing_sphinx_attr_raises(self): - node = astroid.extract_node(''' + node = astroid.extract_node( + ''' def my_func(self): """This is a sphinx docstring. @@ -620,17 +668,17 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ from re import error raise error('hi') - ''') + ''' + ) raise_node = node.body[1] with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('error', ))): + Message(msg_id="missing-raises-doc", node=node, args=("error",)) + ): self.checker.visit_raise(raise_node) def test_find_invalid_missing_sphinx_attr_raises(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a sphinx docstring. @@ -638,7 +686,8 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ from re import error raise error('hi') #@ - ''') + ''' + ) # pylint allows this to pass since the comparison between Raises and # raise are based on the class name, not the qualified name. with self.assertNoMessages(): @@ -660,12 +709,12 @@ class TestDocstringCheckerRaise(CheckerTestCase): with self.assertNoMessages(): self.checker.visit_raise(raise_node) - with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_ignores_raise_uninferable(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' from unknown import Unknown def my_func(self): @@ -675,12 +724,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): """ raise Unknown('hi') #@ raise NameError('hi') - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_ignores_returns_from_inner_functions(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(self): """This is a docstring. @@ -692,18 +743,18 @@ class TestDocstringCheckerRaise(CheckerTestCase): return RuntimeError(val) raise ex_func('hi') #@ raise NameError('hi') - ''') + ''' + ) node = raise_node.frame() with self.assertAddsMessages( - Message( - msg_id='missing-raises-doc', - node=node, - args=('RuntimeError', ))): + Message(msg_id="missing-raises-doc", node=node, args=("RuntimeError",)) + ): # we do NOT expect a warning about the OSError in inner_func! self.checker.visit_raise(raise_node) def test_ignores_returns_use_only_names(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def myfunc(): """This is a docstring @@ -713,12 +764,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): return 42 raise inner_func() #@ - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_ignores_returns_use_only_exception_instances(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def myfunc(): """This is a docstring @@ -730,12 +783,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): return MyException raise inner_func() #@ - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_no_crash_when_inferring_handlers(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' import collections def test(): @@ -747,12 +802,14 @@ class TestDocstringCheckerRaise(CheckerTestCase): pass except collections.U as exc: raise #@ - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_no_crash_when_cant_find_exception(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' import collections def test(): @@ -764,18 +821,21 @@ class TestDocstringCheckerRaise(CheckerTestCase): pass except U as exc: raise #@ - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) def test_no_error_notimplemented_documented(self): - raise_node = astroid.extract_node(''' + raise_node = astroid.extract_node( + ''' def my_func(): """ Raises: NotImplementedError: When called. """ raise NotImplementedError #@ - ''') + ''' + ) with self.assertNoMessages(): self.checker.visit_raise(raise_node) |
