Move ``TestDocstringCheckerYield`` to functional tests (#5435)

1 files changed, 0 insertions, 514 deletions

diff --git a/tests/extensions/test_check_yields_docs.py b/tests/extensions/test_check_yields_docs.py
deleted file mode 100644
index e4ae70770..000000000
--- a/tests/extensions/test_check_yields_docs.py
+++ /dev/null
@@ -1,514 +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) 2019-2021 Pierre Sassoulas <pierre.sassoulas@gmail.com>
-# Copyright (c) 2019 Hugo van Kemenade <hugovk@users.noreply.github.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 yield 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 TestDocstringCheckerYield(CheckerTestCase):
-    """Tests for pylint_plugin.RaiseDocChecker"""
-
-    CHECKER_CLASS = DocstringParameterChecker
-
-    def test_ignores_no_docstring(self) -> None:
-        yield_node = astroid.extract_node(
-            """
-        def my_func(self):
-            yield False #@
-        """
-        )
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)
-
-    @set_config(accept_no_yields_doc=False)
-    def test_warns_no_docstring(self) -> None:
-        node = astroid.extract_node(
-            """
-        def my_func(self):
-            yield False
-        """
-        )
-        yield_node = node.body[0]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-yield-doc", node=node),
-            MessageTest(msg_id="missing-yield-type-doc", node=node),
-        ):
-            self.checker.visit_yield(yield_node)
-
-    def test_ignores_unknown_style(self) -> None:
-        yield_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring."""
-            yield False #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)
-
-    @set_config(accept_no_yields_doc="no")
-    def test_warn_partial_sphinx_yields(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            :returns: Always False
-            """
-            yield False
-        '''
-        )
-        yield_node = node.body[0]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-yield-type-doc", node=node)
-        ):
-            self.checker.visit_yield(yield_node)
-
-    @set_config(accept_no_yields_doc="no")
-    def test_warn_partial_sphinx_yields_type(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            :rtype: bool
-            """
-            yield False
-        '''
-        )
-        yield_node = node.body[0]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-yield-doc", node=node)
-        ):
-            self.checker.visit_yield(yield_node)
-
-    @set_config(accept_no_yields_doc="no")
-    def test_warn_missing_sphinx_yields(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self, doc_type):
-            """This is a docstring.
-
-            :param doc_type: Sphinx
-            :type doc_type: str
-            """
-            yield False
-        '''
-        )
-        yield_node = node.body[0]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-yield-doc", node=node),
-            MessageTest(msg_id="missing-yield-type-doc", node=node),
-        ):
-            self.checker.visit_yield(yield_node)
-
-    @set_config(accept_no_yields_doc="no")
-    def test_warn_partial_google_yields(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields:
-                Always False
-            """
-            yield False
-        '''
-        )
-        yield_node = node.body[0]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-yield-type-doc", node=node)
-        ):
-            self.checker.visit_yield(yield_node)
-
-    @set_config(accept_no_yields_doc="no")
-    def test_warn_partial_google_yields_type(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields:
-                bool:
-            """
-            yield False
-        '''
-        )
-        yield_node = node.body[0]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-yield-doc", node=node)
-        ):
-            self.checker.visit_yield(yield_node)
-
-    @set_config(accept_no_yields_doc="no")
-    def test_warn_missing_google_yields(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self, doc_type):
-            """This is a docstring.
-
-            Parameters:
-                doc_type (str): Google
-            """
-            yield False
-        '''
-        )
-        yield_node = node.body[0]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-yield-doc", node=node),
-            MessageTest(msg_id="missing-yield-type-doc", node=node),
-        ):
-            self.checker.visit_yield(yield_node)
-
-    @set_config(accept_no_yields_doc="no")
-    def test_warn_missing_numpy_yields(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self, doc_type):
-            """This is a docstring.
-
-            Arguments
-            ---------
-            doc_type : str
-                Numpy
-            """
-            yield False
-        '''
-        )
-        yield_node = node.body[0]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-yield-doc", node=node),
-            MessageTest(msg_id="missing-yield-type-doc", node=node),
-        ):
-            self.checker.visit_yield(yield_node)
-
-    def test_find_sphinx_yields(self) -> None:
-        yield_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            :return: Always False
-            :rtype: bool
-            """
-            yield False #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)
-
-    def test_find_google_yields(self) -> None:
-        yield_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields:
-                bool: Always False
-            """
-            yield False #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)
-
-    def test_find_numpy_yields(self) -> None:
-        yield_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields
-            -------
-            bool
-                Always False
-            """
-            yield False #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)
-
-    def test_finds_sphinx_yield_custom_class(self) -> None:
-        yield_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            :returns: An object
-            :rtype: :class:`mymodule.Class`
-            """
-            yield mymodule.Class() #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)
-
-    def test_finds_google_yield_custom_class(self) -> None:
-        yield_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields:
-                mymodule.Class: An object
-            """
-            yield mymodule.Class() #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)
-
-    def test_finds_numpy_yield_custom_class(self) -> None:
-        yield_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields
-            -------
-                mymodule.Class
-                    An object
-            """
-            yield mymodule.Class() #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)
-
-    def test_finds_sphinx_yield_list_of_custom_class(self) -> None:
-        yield_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            :returns: An object
-            :rtype: list(:class:`mymodule.Class`)
-            """
-            yield [mymodule.Class()] #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)
-
-    def test_finds_google_yield_list_of_custom_class(self) -> None:
-        yield_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields:
-                list(:class:`mymodule.Class`): An object
-            """
-            yield [mymodule.Class()] #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)
-
-    def test_finds_numpy_yield_list_of_custom_class(self) -> None:
-        yield_node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields
-            -------
-                list(:class:`mymodule.Class`)
-                    An object
-            """
-            yield [mymodule.Class()] #@
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)
-
-    @set_config(accept_no_yields_doc="no")
-    def test_warns_sphinx_yield_list_of_custom_class_without_description(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            :rtype: list(:class:`mymodule.Class`)
-            """
-            yield [mymodule.Class()]
-        '''
-        )
-        yield_node = node.body[0]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-yield-doc", node=node)
-        ):
-            self.checker.visit_yield(yield_node)
-
-    @set_config(accept_no_yields_doc="no")
-    def test_warns_google_yield_list_of_custom_class_without_description(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields:
-                list(:class:`mymodule.Class`):
-            """
-            yield [mymodule.Class()]
-        '''
-        )
-        yield_node = node.body[0]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-yield-doc", node=node)
-        ):
-            self.checker.visit_yield(yield_node)
-
-    @set_config(accept_no_yields_doc="no")
-    def test_warns_numpy_yield_list_of_custom_class_without_description(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields
-            -------
-                list(:class:`mymodule.Class`)
-            """
-            yield [mymodule.Class()]
-        '''
-        )
-        yield_node = node.body[0]
-        with self.assertAddsMessages(
-            MessageTest(msg_id="missing-yield-doc", node=node)
-        ):
-            self.checker.visit_yield(yield_node)
-
-    # No such thing as redundant yield documentation for sphinx because it
-    # doesn't support yield documentation
-
-    def test_ignores_google_redundant_yield_doc_multiple_yields(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields:
-                int or None: One, or sometimes None.
-            """
-            if a_func():
-                yield None
-            yield 1
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_functiondef(node)
-
-    def test_ignores_numpy_redundant_yield_doc_multiple_yields(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields
-            -------
-                int
-                    One
-                None
-                    Sometimes
-            """
-            if a_func():
-                yield None
-            yield 1
-        '''
-        )
-        with self.assertNoMessages():
-            self.checker.visit_functiondef(node)
-
-    # No such thing as redundant yield documentation for sphinx because it
-    # doesn't support yield documentation
-
-    def test_warns_google_redundant_yield_doc_return(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields:
-                int: One
-            """
-            return 1
-        '''
-        )
-        with self.assertAddsMessages(
-            MessageTest(msg_id="redundant-yields-doc", node=node)
-        ):
-            self.checker.visit_functiondef(node)
-
-    def test_warns_numpy_redundant_yield_doc_return(self) -> None:
-        node = astroid.extract_node(
-            '''
-        def my_func(self):
-            """This is a docstring.
-
-            Yields
-            -------
-                int
-                    One
-            """
-            return 1
-        '''
-        )
-        with self.assertAddsMessages(
-            MessageTest(msg_id="redundant-yields-doc", node=node)
-        ):
-            self.checker.visit_functiondef(node)
-
-    def test_sphinx_missing_yield_type_with_annotations(self) -> None:
-        node = astroid.extract_node(
-            '''
-            import typing
-
-            def generator() -> typing.Iterator[int]:
-                """A simple function for checking type hints.
-
-                :returns: The number 0
-                """
-                yield 0
-            '''
-        )
-        yield_node = node.body[0]
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)
-
-    def test_google_missing_yield_type_with_annotations(self) -> None:
-        node = astroid.extract_node(
-            '''
-            import typing
-
-            def generator() -> typing.Iterator[int]:
-                """A simple function for checking type hints.
-
-                Yields:
-                    The number 0
-                """
-                yield 0
-            '''
-        )
-        yield_node = node.body[0]
-        with self.assertNoMessages():
-            self.checker.visit_yield(yield_node)