123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572 |
- # -*- coding: utf-8 -*-
- # 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>
- # Copyright (c) 2016 Moises Lopez <moylop260@vauxoo.com>
-
- # 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 return 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 TestDocstringCheckerReturn(CheckerTestCase):
- """Tests for pylint_plugin.RaiseDocChecker"""
- CHECKER_CLASS = DocstringParameterChecker
-
- def test_ignores_no_docstring(self):
- return_node = astroid.extract_node('''
- def my_func(self):
- return False #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- @set_config(accept_no_return_doc=False)
- def test_warns_no_docstring(self):
- node = astroid.extract_node('''
- def my_func(self):
- return False
- ''')
- return_node = node.body[0]
- with self.assertAddsMessages(
- Message(msg_id='missing-return-doc', node=node),
- Message(msg_id='missing-return-type-doc', node=node)):
- self.checker.visit_return(return_node)
-
- def test_ignores_unknown_style(self):
- return_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring."""
- return False #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_warn_partial_sphinx_returns(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :returns: Always False
- """
- return False
- ''')
- return_node = node.body[0]
- with self.assertAddsMessages(
- Message(msg_id='missing-return-type-doc', node=node)):
- self.checker.visit_return(return_node)
-
- def test_warn_partial_sphinx_returns_type(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :rtype: bool
- """
- return False
- ''')
- return_node = node.body[0]
- with self.assertAddsMessages(
- Message(msg_id='missing-return-doc', node=node)):
- self.checker.visit_return(return_node)
-
- def test_warn_missing_sphinx_returns(self):
- node = astroid.extract_node('''
- def my_func(self, doc_type):
- """This is a docstring.
-
- :param doc_type: Sphinx
- :type doc_type: str
- """
- return False
- ''')
- return_node = node.body[0]
- with self.assertAddsMessages(
- Message(msg_id='missing-return-doc', node=node),
- Message(msg_id='missing-return-type-doc', node=node)):
- self.checker.visit_return(return_node)
-
- def test_warn_partial_google_returns(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns:
- Always False
- """
- return False
- ''')
- return_node = node.body[0]
- with self.assertAddsMessages(
- Message(msg_id='missing-return-type-doc', node=node)):
- self.checker.visit_return(return_node)
-
- def test_warn_partial_google_returns_type(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns:
- bool:
- """
- return False
- ''')
- return_node = node.body[0]
- with self.assertAddsMessages(
- Message(msg_id='missing-return-doc', node=node)):
- self.checker.visit_return(return_node)
-
- def test_warn_missing_google_returns(self):
- node = astroid.extract_node('''
- def my_func(self, doc_type):
- """This is a docstring.
-
- Parameters:
- doc_type (str): Google
- """
- return False
- ''')
- return_node = node.body[0]
- with self.assertAddsMessages(
- Message(msg_id='missing-return-doc', node=node),
- Message(msg_id='missing-return-type-doc', node=node)):
- self.checker.visit_return(return_node)
-
- def test_warn_partial_numpy_returns_type(self):
- node = astroid.extract_node('''
- def my_func(self, doc_type):
- """This is a docstring.
-
- Arguments
- ---------
- doc_type : str
- Numpy
-
- Returns
- -------
- bool
- """
- return False
- ''')
- return_node = node.body[0]
- with self.assertAddsMessages(
- Message(msg_id='missing-return-doc', node=node)):
- self.checker.visit_return(return_node)
-
- def test_warn_missing_numpy_returns(self):
- node = astroid.extract_node('''
- def my_func(self, doc_type):
- """This is a docstring.
-
- Arguments
- ---------
- doc_type : str
- Numpy
- """
- return False
- ''')
- return_node = node.body[0]
- with self.assertAddsMessages(
- Message(msg_id='missing-return-doc', node=node),
- Message(msg_id='missing-return-type-doc', node=node)):
- self.checker.visit_return(return_node)
-
- def test_find_sphinx_returns(self):
- return_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :return: Always False
- :rtype: bool
- """
- return False #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_find_google_returns(self):
- return_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns:
- bool: Always False
- """
- return False #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_find_numpy_returns(self):
- return_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns
- -------
- bool
- Always False
- """
- return False #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_ignores_sphinx_return_none(self):
- return_node = astroid.extract_node('''
- def my_func(self, doc_type):
- """This is a docstring.
-
- :param doc_type: Sphinx
- :type doc_type: str
- """
- return #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_ignores_google_return_none(self):
- return_node = astroid.extract_node('''
- def my_func(self, doc_type):
- """This is a docstring.
-
- Args:
- doc_type (str): Google
- """
- return #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_ignores_numpy_return_none(self):
- return_node = astroid.extract_node('''
- def my_func(self, doc_type):
- """This is a docstring.
-
- Arguments
- ---------
- doc_type : str
- Numpy
- """
- return #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_finds_sphinx_return_custom_class(self):
- return_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :returns: An object
- :rtype: :class:`mymodule.Class`
- """
- return mymodule.Class() #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_finds_google_return_custom_class(self):
- return_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns:
- mymodule.Class: An object
- """
- return mymodule.Class() #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_finds_numpy_return_custom_class(self):
- return_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns
- -------
- mymodule.Class
- An object
- """
- return mymodule.Class() #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_finds_sphinx_return_list_of_custom_class(self):
- return_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :returns: An object
- :rtype: list(:class:`mymodule.Class`)
- """
- return [mymodule.Class()] #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_finds_google_return_list_of_custom_class(self):
- return_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns:
- list(:class:`mymodule.Class`): An object
- """
- return [mymodule.Class()] #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_finds_numpy_return_list_of_custom_class(self):
- return_node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns
- -------
- list(:class:`mymodule.Class`)
- An object
- """
- return [mymodule.Class()] #@
- ''')
- with self.assertNoMessages():
- self.checker.visit_return(return_node)
-
- def test_warns_sphinx_return_list_of_custom_class_without_description(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :rtype: list(:class:`mymodule.Class`)
- """
- return [mymodule.Class()]
- ''')
- return_node = node.body[0]
- with self.assertAddsMessages(
- Message(msg_id='missing-return-doc', node=node)):
- self.checker.visit_return(return_node)
-
- def test_warns_google_return_list_of_custom_class_without_description(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns:
- list(:class:`mymodule.Class`):
- """
- return [mymodule.Class()]
- ''')
- return_node = node.body[0]
- with self.assertAddsMessages(
- Message(msg_id='missing-return-doc', node=node)):
- self.checker.visit_return(return_node)
-
- def test_warns_numpy_return_list_of_custom_class_without_description(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns
- -------
- list(:class:`mymodule.Class`)
- """
- return [mymodule.Class()]
- ''')
- return_node = node.body[0]
- with self.assertAddsMessages(
- Message(msg_id='missing-return-doc', node=node)):
- self.checker.visit_return(return_node)
-
- def test_warns_sphinx_redundant_return_doc(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :returns: One
- """
- return None
- ''')
- with self.assertAddsMessages(
- Message(msg_id='redundant-returns-doc', node=node)):
- self.checker.visit_functiondef(node)
-
- def test_warns_sphinx_redundant_rtype_doc(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :rtype: int
- """
- return None
- ''')
- with self.assertAddsMessages(
- Message(msg_id='redundant-returns-doc', node=node)):
- self.checker.visit_functiondef(node)
-
- def test_warns_google_redundant_return_doc(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns:
- One
- """
- return None
- ''')
- with self.assertAddsMessages(
- Message(msg_id='redundant-returns-doc', node=node)):
- self.checker.visit_functiondef(node)
-
- def test_warns_google_redundant_rtype_doc(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns:
- int:
- """
- return None
- ''')
- with self.assertAddsMessages(
- Message(msg_id='redundant-returns-doc', node=node)):
- self.checker.visit_functiondef(node)
-
- def test_warns_numpy_redundant_return_doc(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns
- -------
- int
- One
- """
- return None
- ''')
- with self.assertAddsMessages(
- Message(msg_id='redundant-returns-doc', node=node)):
- self.checker.visit_functiondef(node)
-
- def test_warns_numpy_redundant_rtype_doc(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns
- -------
- int
- """
- return None
- ''')
- with self.assertAddsMessages(
- Message(msg_id='redundant-returns-doc', node=node)):
- self.checker.visit_functiondef(node)
-
- def test_ignores_sphinx_redundant_return_doc_multiple_returns(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- :returns: One
- :rtype: int
-
- :returns: None sometimes
- :rtype: None
- """
- if a_func():
- return None
- return 1
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_ignores_google_redundant_return_doc_multiple_returns(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns:
- int or None: One, or sometimes None.
- """
- if a_func():
- return None
- return 1
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_ignores_numpy_redundant_return_doc_multiple_returns(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns
- -------
- int
- One
- None
- Sometimes
- """
- if a_func():
- return None
- return 1
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_ignore_sphinx_redundant_return_doc_yield(self):
- node = astroid.extract_node('''
- def my_func_with_yield(self):
- """This is a docstring.
-
- :returns: One
- :rtype: generator
- """
- for value in range(3):
- yield value
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_warns_google_redundant_return_doc_yield(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns:
- int: One
- """
- yield 1
- ''')
- with self.assertAddsMessages(
- Message(msg_id='redundant-returns-doc', node=node)):
- self.checker.visit_functiondef(node)
-
- def test_warns_numpy_redundant_return_doc_yield(self):
- node = astroid.extract_node('''
- def my_func(self):
- """This is a docstring.
-
- Returns
- -------
- int
- One
- """
- yield 1
- ''')
- with self.assertAddsMessages(
- Message(msg_id='redundant-returns-doc', node=node)):
- self.checker.visit_functiondef(node)
|