|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529 |
- # Copyright (c) 2016-2017 Claudiu Popa <pcmanticore@gmail.com>
- # Copyright (c) 2016 Derek Gustafson <degustaf@gmail.com>
- # Copyright (c) 2016 Glenn Matthews <glenn@e-dad.net>
- # Copyright (c) 2016 Ashley Whetter <ashley@awhetter.co.uk>
-
- # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
- # For details: https://github.com/PyCQA/pylint/blob/master/COPYING
-
- """Unit tests for the raised exception documentation checking in the
- `DocstringChecker` in :mod:`pylint.extensions.check_docs`
- """
- from __future__ import division, print_function, absolute_import
-
- import astroid
- from pylint.testutils import CheckerTestCase, Message, set_config
-
- from pylint.extensions.docparams import DocstringParameterChecker
-
-
- class TestDocstringCheckerRaise(CheckerTestCase):
- """Tests for pylint_plugin.RaiseDocChecker"""
- CHECKER_CLASS = DocstringParameterChecker
-
- def test_ignores_no_docstring(self):
- 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('''
- 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('''
- 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', ))):
- self.checker.visit_raise(raise_node)
-
- def test_find_missing_sphinx_raises(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :raises NameError: Never
- """
- raise RuntimeError('hi')
- raise NameError('hi')
- ''')
- raise_node = node.body[0]
- with self.assertAddsMessages(
- 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('''
- def my_func(self):
- """This is a docstring.
-
- Raises:
- NameError: Never
- """
- raise RuntimeError('hi')
- raise NameError('hi')
- ''')
- raise_node = node.body[0]
- with self.assertAddsMessages(
- Message(
- msg_id='missing-raises-doc',
- node=node,
- args=('RuntimeError', ))):
- self.checker.visit_raise(raise_node)
-
- def test_find_missing_numpy_raises(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Raises
- ------
- NameError
- Never
- """
- raise RuntimeError('hi')
- raise NameError('hi')
- ''')
- raise_node = node.body[0]
- with self.assertAddsMessages(
- 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('''
- def my_func(self):
- """This is a docstring.
-
- :raises RuntimeError: Always
- :except NameError: Never
- :raise OSError: Never
- :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('''
- def my_func(self):
- """This is a docstring.
-
- :raises RuntimeError: Always
- :except NameError: Never
- :raise OSError: Never
- :exception ValueError: Never
- """
- raise RuntimeError('hi') #@
- 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('''
- def my_func(self):
- """This is a docstring.
-
- Raises:
- RuntimeError: Always
- NameError: Never
- """
- 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('''
- def my_func(self):
- """This is a docstring.
-
- Raises
- ------
- RuntimeError
- Always
- NameError
- Never
- """
- 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('''
- def my_func(self):
- """This is a docstring.
-
- :raises NameError: Sometimes
- """
- try:
- fake_func()
- except RuntimeError:
- raise #@
-
- raise NameError('hi')
- ''')
- node = raise_node.frame()
- with self.assertAddsMessages(
- 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('''
- def my_func(self):
- """This is a docstring.
-
- Raises:
- NameError: Sometimes
- """
- try:
- fake_func()
- except RuntimeError:
- raise #@
-
- raise NameError('hi')
- ''')
- node = raise_node.frame()
- with self.assertAddsMessages(
- 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('''
- def my_func(self):
- """This is a docstring.
-
- Raises
- ------
- NameError
- Sometimes
- """
- try:
- fake_func()
- except RuntimeError:
- raise #@
-
- raise NameError('hi')
- ''')
- node = raise_node.frame()
- with self.assertAddsMessages(
- 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('''
- def my_func(self):
- """This is a docstring.
-
- :raises NameError: Sometimes
- """
- try:
- fake_func()
- except (RuntimeError, ValueError):
- raise #@
-
- raise NameError('hi')
- ''')
- node = raise_node.frame()
- with self.assertAddsMessages(
- Message(
- msg_id='missing-raises-doc',
- node=node,
- args=('RuntimeError, ValueError', ))):
- self.checker.visit_raise(raise_node)
-
- def test_find_rethrown_google_multiple_raises(self):
- raise_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Raises:
- NameError: Sometimes
- """
- try:
- fake_func()
- except (RuntimeError, ValueError):
- raise #@
-
- raise NameError('hi')
- ''')
- node = raise_node.frame()
- with self.assertAddsMessages(
- Message(
- msg_id='missing-raises-doc',
- node=node,
- args=('RuntimeError, ValueError', ))):
- self.checker.visit_raise(raise_node)
-
- def test_find_rethrown_numpy_multiple_raises(self):
- raise_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Raises
- ------
- NameError
- Sometimes
- """
- try:
- fake_func()
- except (RuntimeError, ValueError):
- raise #@
-
- raise NameError('hi')
- ''')
- node = raise_node.frame()
- with self.assertAddsMessages(
- Message(
- msg_id='missing-raises-doc',
- node=node,
- args=('RuntimeError, ValueError', ))):
- self.checker.visit_raise(raise_node)
-
- def test_ignores_caught_sphinx_raises(self):
- raise_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :raises NameError: Sometimes
- """
- try:
- raise RuntimeError('hi') #@
- except RuntimeError:
- 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('''
- def my_func(self):
- """This is a docstring.
-
- Raises:
- NameError: Sometimes
- """
- try:
- raise RuntimeError('hi') #@
- except RuntimeError:
- 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('''
- def my_func(self):
- """This is a docstring.
-
- Raises
- ------
- NameError
- Sometimes
- """
- try:
- raise RuntimeError('hi') #@
- except RuntimeError:
- pass
-
- raise NameError('hi')
- ''')
- with self.assertNoMessages():
- self.checker.visit_raise(raise_node)
-
- def test_find_missing_sphinx_raises_infer_from_instance(self):
- raise_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :raises NameError: Never
- """
- 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', ))):
- self.checker.visit_raise(raise_node)
-
- def test_find_missing_sphinx_raises_infer_from_function(self):
- raise_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :raises NameError: Never
- """
- def ex_func(val):
- 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', ))):
- self.checker.visit_raise(raise_node)
-
- def test_ignores_raise_uninferable(self):
- raise_node = astroid.extract_node('''
- from unknown import Unknown
-
- def my_func(self):
- """This is a docstring.
-
- :raises NameError: Never
- """
- 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('''
- def my_func(self):
- """This is a docstring.
-
- :raises NameError: Never
- """
- def ex_func(val):
- def inner_func(value):
- return OSError(value)
- 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', ))):
- # 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('''
- def myfunc():
- """This is a docstring
-
- :raises NameError: Never
- """
- def inner_func():
- 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('''
- def myfunc():
- """This is a docstring
-
- :raises MyException: Never
- """
- class MyException(Exception):
- pass
- def inner_func():
- 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('''
- import collections
-
- def test():
- """raises
-
- :raise U: pass
- """
- try:
- 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('''
- import collections
-
- def test():
- """raises
-
- :raise U: pass
- """
- try:
- 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('''
- def my_func():
- """
- Raises:
- NotImplementedError: When called.
- """
- raise NotImplementedError #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_raise(raise_node)
|