Move ``TestDocstringCheckerRaise`` to functional tests (#5444)

1 files changed, 0 insertions, 902 deletions

diff --git a/tests/extensions/test_check_raise_docs.py b/tests/extensions/test_check_raise_docs.py
deleted file mode 100644
index f191bc14e..000000000
--- a/tests/extensions/test_check_raise_docs.py
+++ /dev/null
@@ -1,902 +0,0 @@
-# Copyright (c) 2016-2018, 2020 Claudiu Popa <pcmanticore@gmail.com>
-# Copyright (c) 2016, 2019 Ashley Whetter <ashley@awhetter.co.uk>
-# Copyright (c) 2016 Derek Gustafson <degustaf@gmail.com>
-# Copyright (c) 2016 Glenn Matthews <glenn@e-dad.net>
-# Copyright (c) 2018 Jim Robertson <jrobertson98atx@gmail.com>
-# Copyright (c) 2018 Adam Dangoor <adamdangoor@gmail.com>
-# Copyright (c) 2019-2021 Pierre Sassoulas <pierre.sassoulas@gmail.com>
-# Copyright (c) 2019 Hugo van Kemenade <hugovk@users.noreply.github.com>
-# Copyright (c) 2019 Danny Hermes <daniel.j.hermes@gmail.com>
-# Copyright (c) 2020 hippo91 <guillaume.peillex@gmail.com>
-# Copyright (c) 2021 Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
-# Copyright (c) 2021 Marc Mueller <30130371+cdce8p@users.noreply.github.com>
-
-# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
-# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
-
-"""Unit tests for the raised exception documentation checking in the
-`DocstringChecker` in :mod:`pylint.extensions.check_docs`
-"""
-
-# pylint: disable=too-many-public-methods
-
-import astroid
-
-from pylint.extensions.docparams import DocstringParameterChecker
-from pylint.testutils import CheckerTestCase, MessageTest, set_config
-
-
-class TestDocstringCheckerRaise(CheckerTestCase):
-    """Tests for pylint_plugin.RaiseDocChecker"""
-
-    CHECKER_CLASS = DocstringParameterChecker
-
-    def test_ignores_no_docstring(self) -> None:
-        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) -> None:
-        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) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring."""
-            raise RuntimeError('hi')
-        '''
-        )
-        raise_node = node.body[0]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-raises-doc", node=node, args=("RuntimeError",))
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_find_missing_sphinx_raises(self) -> None:
-        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(
-            MessageTest(msg_id="missing-raises-doc", node=node, args=("RuntimeError",))
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_find_missing_google_raises(self) -> None:
-        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(
-            MessageTest(msg_id="missing-raises-doc", node=node, args=("RuntimeError",))
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_find_google_attr_raises_exact_exc(self) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a google docstring.
-
-            Raises:
-                re.error: Sometimes
-            """
-            import re
-            raise re.error('hi')  #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_raise(raise_node)
-
-    def test_find_google_attr_raises_substr_exc(self) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a google docstring.
-
-            Raises:
-                re.error: Sometimes
-            """
-            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) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a google docstring.
-
-            Raises:
-                re.anothererror: Sometimes
-            """
-            from re import error
-            raise error('hi')
-        '''
-        )
-        raise_node = node.body[1]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-raises-doc", node=node, args=("error",))
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_find_invalid_missing_google_attr_raises(self) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a google docstring.
-
-            Raises:
-                bogusmodule.error: Sometimes
-            """
-            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():
-            self.checker.visit_raise(raise_node)
-
-    def test_google_raises_local_reference(self) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a google docstring.
-
-            Raises:
-                .LocalException: Always
-            """
-            from neighbor_module import LocalException
-            raise LocalException('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():
-            self.checker.visit_raise(raise_node)
-
-    @set_config(accept_no_raise_doc=False)
-    def test_google_raises_with_prefix(self) -> None:
-        code_snippet = '''
-        def my_func(self):
-            """This is a google docstring.
-
-            Raises:
-                {prefix}re.error: Sometimes
-            """
-            import re
-            raise re.error('hi') #@
-        '''
-        for prefix in ("~", "!"):
-            raise_node = astroid.extract_node(code_snippet.format(prefix=prefix))
-            with self.assertNoMessages():
-                self.checker.visit_raise(raise_node)
-
-    def test_find_missing_numpy_raises(self) -> None:
-        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(
-            MessageTest(msg_id="missing-raises-doc", node=node, args=("RuntimeError",))
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_ignore_spurious_sphinx_raises(self) -> None:
-        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) -> None:
-        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) -> None:
-        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) -> None:
-        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_multiple_sphinx_raises(self) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            :raises RuntimeError: Always
-            :raises NameError, OSError, 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_multiple_google_raises(self) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Raises:
-                RuntimeError: Always
-                NameError, OSError, 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_finds_rethrown_sphinx_raises(self) -> None:
-        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(
-            MessageTest(msg_id="missing-raises-doc", node=node, args=("RuntimeError",))
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_find_rethrown_google_raises(self) -> None:
-        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(
-            MessageTest(msg_id="missing-raises-doc", node=node, args=("RuntimeError",))
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_find_rethrown_numpy_raises(self) -> None:
-        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(
-            MessageTest(msg_id="missing-raises-doc", node=node, args=("RuntimeError",))
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_finds_rethrown_sphinx_multiple_raises(self) -> None:
-        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(
-            MessageTest(
-                msg_id="missing-raises-doc",
-                node=node,
-                args=("RuntimeError, ValueError",),
-            )
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_find_rethrown_google_multiple_raises(self) -> None:
-        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(
-            MessageTest(
-                msg_id="missing-raises-doc",
-                node=node,
-                args=("RuntimeError, ValueError",),
-            )
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_find_rethrown_numpy_multiple_raises(self) -> None:
-        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(
-            MessageTest(
-                msg_id="missing-raises-doc",
-                node=node,
-                args=("RuntimeError, ValueError",),
-            )
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_ignores_caught_sphinx_raises(self) -> None:
-        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) -> None:
-        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) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a numpy 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_numpy_attr_raises_exact_exc(self) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a numpy docstring.
-
-            Raises
-            ------
-            re.error
-                Sometimes
-            """
-            import re
-            raise re.error('hi')  #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_raise(raise_node)
-
-    def test_find_numpy_attr_raises_substr_exc(self) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a numpy docstring.
-
-            Raises
-            ------
-            re.error
-                Sometimes
-            """
-            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) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a numpy docstring.
-
-            Raises
-            ------
-            re.anothererror
-                Sometimes
-            """
-            from re import error
-            raise error('hi')
-        '''
-        )
-        raise_node = node.body[1]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-raises-doc", node=node, args=("error",))
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_find_invalid_missing_numpy_attr_raises(self) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a numpy docstring.
-
-            Raises
-            ------
-            bogusmodule.error
-                Sometimes
-            """
-            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():
-            self.checker.visit_raise(raise_node)
-
-    @set_config(accept_no_raise_doc=False)
-    def test_numpy_raises_with_prefix(self) -> None:
-        code_snippet = '''
-        def my_func(self):
-            """This is a numpy docstring.
-
-            Raises
-            ------
-            {prefix}re.error
-                Sometimes
-            """
-            import re
-            raise re.error('hi') #@
-        '''
-        for prefix in ("~", "!"):
-            raise_node = astroid.extract_node(code_snippet.format(prefix=prefix))
-            with self.assertNoMessages():
-                self.checker.visit_raise(raise_node)
-
-    def test_find_missing_sphinx_raises_infer_from_instance(self) -> None:
-        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(
-            MessageTest(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) -> None:
-        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(
-            MessageTest(msg_id="missing-raises-doc", node=node, args=("RuntimeError",))
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_find_sphinx_attr_raises_exact_exc(self) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a sphinx docstring.
-
-            :raises re.error: Sometimes
-            """
-            import re
-            raise re.error('hi')  #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_raise(raise_node)
-
-    def test_find_sphinx_attr_raises_substr_exc(self) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a sphinx docstring.
-
-            :raises re.error: Sometimes
-            """
-            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) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a sphinx docstring.
-
-            :raises re.anothererror: Sometimes
-            """
-            from re import error
-            raise error('hi')
-        '''
-        )
-        raise_node = node.body[1]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-raises-doc", node=node, args=("error",))
-        ):
-            self.checker.visit_raise(raise_node)
-
-    def test_find_invalid_missing_sphinx_attr_raises(self) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a sphinx docstring.
-
-            :raises bogusmodule.error: Sometimes
-            """
-            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():
-            self.checker.visit_raise(raise_node)
-
-    @set_config(accept_no_raise_doc=False)
-    def test_sphinx_raises_with_prefix(self) -> None:
-        code_snippet = '''
-        def my_func(self):
-            """This is a sphinx docstring.
-
-            :raises {prefix}re.error: Sometimes
-            """
-            import re
-            raise re.error('hi') #@
-        '''
-        for prefix in ("~", "!"):
-            raise_node = astroid.extract_node(code_snippet.format(prefix=prefix))
-            with self.assertNoMessages():
-                self.checker.visit_raise(raise_node)
-
-        with self.assertNoMessages():
-            self.checker.visit_raise(raise_node)
-
-    def test_ignores_raise_uninferable(self) -> None:
-        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) -> None:
-        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(
-            MessageTest(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) -> None:
-        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) -> None:
-        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) -> None:
-        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) -> None:
-        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) -> None:
-        raise_node = astroid.extract_node(
-            '''
-        def my_func():
-            """
-            Raises:
-                NotImplementedError: When called.
-            """
-            raise NotImplementedError #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_raise(raise_node)