|
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988 |
- # Copyright (c) 2014-2015 Bruno Daniel <bruno.daniel@blue-yonder.com>
- # Copyright (c) 2015-2017 Claudiu Popa <pcmanticore@gmail.com>
- # Copyright (c) 2016-2018 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) 2016 Glenn Matthews <glmatthe@cisco.com>
- # Copyright (c) 2017 hippo91 <guillaume.peillex@gmail.com>
- # Copyright (c) 2017 Mitar <mitar.github@tnode.com>
- # Copyright (c) 2017 John Paraskevopoulos <io.paraskev@gmail.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 pylint checkers in :mod:`pylint.extensions.check_docs`,
- in particular the parameter documentation checker `DocstringChecker`
- """
- from __future__ import division, print_function, absolute_import
-
- import sys
-
- import pytest
-
- import astroid
- from pylint.testutils import CheckerTestCase, Message, set_config
-
- from pylint.extensions.docparams import DocstringParameterChecker
-
-
- class TestParamDocChecker(CheckerTestCase):
- """Tests for pylint_plugin.ParamDocChecker"""
- CHECKER_CLASS = DocstringParameterChecker
- CONFIG = {
- 'accept_no_param_doc': False,
- }
-
- def test_missing_func_params_in_sphinx_docstring(self):
- """Example of a function with missing Sphinx parameter documentation in
- the docstring
- """
- node = astroid.extract_node("""
- def function_foo(x, y, z):
- '''docstring ...
-
- :param x: bla
-
- :param int z: bar
- '''
- pass
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('y',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('x, y',))
- ):
- self.checker.visit_functiondef(node)
-
- def test_missing_func_params_in_google_docstring(self):
- """Example of a function with missing Google style parameter
- documentation in the docstring
- """
- node = astroid.extract_node("""
- def function_foo(x, y, z):
- '''docstring ...
-
- Args:
- x: bla
- z (int): bar
-
- some other stuff
- '''
- pass
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('y',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('x, y',))
- ):
- self.checker.visit_functiondef(node)
-
- def test_func_params_and_keyword_params_in_google_docstring(self):
- """Example of a function with Google style parameter splitted
- in Args and Keyword Args in the docstring
- """
- node = astroid.extract_node("""
- def my_func(this, other, that=True):
- '''Prints this, other and that
-
- Args:
- this (str): Printed first
- other (int): Other args
-
- Keyword Args:
- that (bool): Printed second
- '''
- print(this, that, other)
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_func_params_and_wrong_keyword_params_in_google_docstring(self):
- """Example of a function with Google style parameter splitted
- in Args and Keyword Args in the docstring but with wrong keyword args
- """
- node = astroid.extract_node("""
- def my_func(this, other, that=True):
- '''Prints this, other and that
-
- Args:
- this (str): Printed first
- other (int): Other args
-
- Keyword Args:
- these (bool): Printed second
- '''
- print(this, that, other)
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('that',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('that',)),
- Message(
- msg_id='differing-param-doc',
- node=node,
- args=('these',)),
- Message(
- msg_id='differing-type-doc',
- node=node,
- args=('these',))
- ):
- self.checker.visit_functiondef(node)
-
- def test_missing_func_params_in_numpy_docstring(self):
- """Example of a function with missing NumPy style parameter
- documentation in the docstring
- """
- node = astroid.extract_node("""
- def function_foo(x, y, z):
- '''docstring ...
-
- Parameters
- ----------
- x:
- bla
- z: int
- bar
-
- some other stuff
- '''
- pass
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('y',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('x, y',))
- ):
- self.checker.visit_functiondef(node)
-
- @set_config(accept_no_param_doc=True)
- def test_tolerate_no_param_documentation_at_all(self):
- """Example of a function with no parameter documentation at all
-
- No error message is emitted.
- """
- node = astroid.extract_node("""
- def function_foo(x, y):
- '''docstring ...
-
- missing parameter documentation'''
- pass
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_don_t_tolerate_no_param_documentation_at_all(self):
- """Example of a function with no parameter documentation at all
-
- Missing documentation error message is emitted.
- """
- node = astroid.extract_node("""
- def function_foo(x, y):
- '''docstring ...
-
- missing parameter documentation'''
- pass
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('x, y',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('x, y',))
- ):
- self.checker.visit_functiondef(node)
-
- def test_see_tolerate_no_param_documentation_at_all(self):
- """Example for the usage of "For the parameters, see"
- to suppress missing-param warnings.
- """
- node = astroid.extract_node("""
- def function_foo(x, y):
- '''docstring ...
-
- For the parameters, see :func:`blah`
- '''
- pass
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def _visit_methods_of_class(self, node):
- """Visit all methods of a class node
-
- :param node: class node
- :type node: :class:`astroid.scoped_nodes.Class`
- """
- for body_item in node.body:
- if (isinstance(body_item, astroid.FunctionDef)
- and hasattr(body_item, 'name')):
- self.checker.visit_functiondef(body_item)
-
- def test_missing_method_params_in_sphinx_docstring(self):
- """Example of a class method with missing parameter documentation in
- the Sphinx style docstring
- """
- node = astroid.extract_node("""
- class Foo(object):
- def method_foo(self, x, y):
- '''docstring ...
-
- missing parameter documentation
-
- :param x: bla
- '''
- pass
- """)
- method_node = node.body[0]
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=method_node,
- args=('y',)),
- Message(
- msg_id='missing-type-doc',
- node=method_node,
- args=('x, y',))
- ):
- self._visit_methods_of_class(node)
-
- def test_missing_method_params_in_google_docstring(self):
- """Example of a class method with missing parameter documentation in
- the Google style docstring
- """
- node = astroid.extract_node("""
- class Foo(object):
- def method_foo(self, x, y):
- '''docstring ...
-
- missing parameter documentation
-
- Args:
- x: bla
- '''
- pass
- """)
- method_node = node.body[0]
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=method_node,
- args=('y',)),
- Message(
- msg_id='missing-type-doc',
- node=method_node,
- args=('x, y',))
- ):
- self._visit_methods_of_class(node)
-
- def test_missing_method_params_in_numpy_docstring(self):
- """Example of a class method with missing parameter documentation in
- the Numpy style docstring
- """
- node = astroid.extract_node("""
- class Foo(object):
- def method_foo(self, x, y):
- '''docstring ...
-
- missing parameter documentation
-
- Parameters
- ----------
- x:
- bla
- '''
- pass
- """)
- method_node = node.body[0]
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=method_node,
- args=('y',)),
- Message(
- msg_id='missing-type-doc',
- node=method_node,
- args=('x, y',))
- ):
- self._visit_methods_of_class(node)
-
- def test_existing_func_params_in_sphinx_docstring(self):
- """Example of a function with correctly documented parameters and
- return values (Sphinx style)
- """
- node = astroid.extract_node("""
- def function_foo(xarg, yarg, zarg, warg):
- '''function foo ...
-
- :param xarg: bla xarg
- :type xarg: int
-
- :parameter yarg: bla yarg
- :type yarg: my.qualified.type
-
- :arg int zarg: bla zarg
-
- :keyword my.qualified.type warg: bla warg
-
- :return: sum
- :rtype: float
- '''
- return xarg + yarg
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_existing_func_params_in_google_docstring(self):
- """Example of a function with correctly documented parameters and
- return values (Google style)
- """
- node = astroid.extract_node("""
- def function_foo(xarg, yarg, zarg, warg):
- '''function foo ...
-
- Args:
- xarg (int): bla xarg
- yarg (my.qualified.type): bla
- bla yarg
-
- zarg (int): bla zarg
- warg (my.qualified.type): bla warg
-
- Returns:
- float: sum
- '''
- return xarg + yarg
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_existing_func_params_in_numpy_docstring(self):
- """Example of a function with correctly documented parameters and
- return values (Numpy style)
- """
- node = astroid.extract_node("""
- def function_foo(xarg, yarg, zarg, warg):
- '''function foo ...
-
- Parameters
- ----------
- xarg: int
- bla xarg
- yarg: my.qualified.type
- bla yarg
-
- zarg: int
- bla zarg
- warg: my.qualified.type
- bla warg
-
- Returns
- -------
- float
- sum
- '''
- return xarg + yarg
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_wrong_name_of_func_params_in_sphinx_docstring(self):
- """Example of functions with inconsistent parameter names in the
- signature and in the Sphinx style documentation
- """
- node = astroid.extract_node("""
- def function_foo(xarg, yarg, zarg):
- '''function foo ...
-
- :param xarg1: bla xarg
- :type xarg: int
-
- :param yarg: bla yarg
- :type yarg1: float
-
- :param str zarg1: bla zarg
- '''
- return xarg + yarg
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('xarg, zarg',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('yarg, zarg',)),
- Message(
- msg_id='differing-param-doc',
- node=node,
- args=('xarg1, zarg1',)),
- Message(
- msg_id='differing-type-doc',
- node=node,
- args=('yarg1, zarg1',)),
- ):
- self.checker.visit_functiondef(node)
-
- node = astroid.extract_node("""
- def function_foo(xarg, yarg):
- '''function foo ...
-
- :param yarg1: bla yarg
- :type yarg1: float
-
- For the other parameters, see bla.
- '''
- return xarg + yarg
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='differing-param-doc',
- node=node,
- args=('yarg1',)),
- Message(
- msg_id='differing-type-doc',
- node=node,
- args=('yarg1',)),
- ):
- self.checker.visit_functiondef(node)
-
- def test_wrong_name_of_func_params_in_google_docstring(self):
- """Example of functions with inconsistent parameter names in the
- signature and in the Google style documentation
- """
- node = astroid.extract_node("""
- def function_foo(xarg, yarg, zarg):
- '''function foo ...
-
- Args:
- xarg1 (int): bla xarg
- yarg (float): bla yarg
-
- zarg1 (str): bla zarg
- '''
- return xarg + yarg
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('xarg, zarg',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('xarg, zarg',)),
- Message(
- msg_id='differing-param-doc',
- node=node,
- args=('xarg1, zarg1',)),
- Message(
- msg_id='differing-type-doc',
- node=node,
- args=('xarg1, zarg1',)),
- ):
- self.checker.visit_functiondef(node)
-
- node = astroid.extract_node("""
- def function_foo(xarg, yarg):
- '''function foo ...
-
- Args:
- yarg1 (float): bla yarg
-
- For the other parameters, see bla.
- '''
- return xarg + yarg
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='differing-param-doc',
- node=node,
- args=('yarg1',)),
- Message(
- msg_id='differing-type-doc',
- node=node,
- args=('yarg1',))
- ):
- self.checker.visit_functiondef(node)
-
- def test_wrong_name_of_func_params_in_numpy_docstring(self):
- """Example of functions with inconsistent parameter names in the
- signature and in the Numpy style documentation
- """
- node = astroid.extract_node("""
- def function_foo(xarg, yarg, zarg):
- '''function foo ...
-
- Parameters
- ----------
- xarg1: int
- bla xarg
- yarg: float
- bla yarg
-
- zarg1: str
- bla zarg
- '''
- return xarg + yarg
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('xarg, zarg',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('xarg, zarg',)),
- Message(
- msg_id='differing-param-doc',
- node=node,
- args=('xarg1, zarg1',)),
- Message(
- msg_id='differing-type-doc',
- node=node,
- args=('xarg1, zarg1',)),
- ):
- self.checker.visit_functiondef(node)
-
- node = astroid.extract_node("""
- def function_foo(xarg, yarg):
- '''function foo ...
-
- Parameters
- ----------
- yarg1: float
- bla yarg
-
- For the other parameters, see bla.
- '''
- return xarg + yarg
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='differing-param-doc',
- node=node,
- args=('yarg1',)),
- Message(
- msg_id='differing-type-doc',
- node=node,
- args=('yarg1',))
- ):
- self.checker.visit_functiondef(node)
-
- def test_see_sentence_for_func_params_in_sphinx_docstring(self):
- """Example for the usage of "For the other parameters, see" to avoid
- too many repetitions, e.g. in functions or methods adhering to a
- given interface (Sphinx style)
- """
- node = astroid.extract_node("""
- def function_foo(xarg, yarg):
- '''function foo ...
-
- :param yarg: bla yarg
- :type yarg: float
-
- For the other parameters, see :func:`bla`
- '''
- return xarg + yarg
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_see_sentence_for_func_params_in_google_docstring(self):
- """Example for the usage of "For the other parameters, see" to avoid
- too many repetitions, e.g. in functions or methods adhering to a
- given interface (Google style)
- """
- node = astroid.extract_node("""
- def function_foo(xarg, yarg):
- '''function foo ...
-
- Args:
- yarg (float): bla yarg
-
- For the other parameters, see :func:`bla`
- '''
- return xarg + yarg
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_see_sentence_for_func_params_in_numpy_docstring(self):
- """Example for the usage of "For the other parameters, see" to avoid
- too many repetitions, e.g. in functions or methods adhering to a
- given interface (Numpy style)
- """
- node = astroid.extract_node("""
- def function_foo(xarg, yarg):
- '''function foo ...
-
- Parameters
- ----------
- yarg: float
- bla yarg
-
- For the other parameters, see :func:`bla`
- '''
- return xarg + yarg
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_constr_params_in_class_sphinx(self):
- """Example of a class with missing constructor parameter documentation
- (Sphinx style)
-
- Everything is completely analogous to functions.
- """
- node = astroid.extract_node("""
- class ClassFoo(object):
- '''docstring foo
-
- :param y: bla
-
- missing constructor parameter documentation
- '''
-
- def __init__(self, x, y):
- pass
-
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('x',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('x, y',))
- ):
- self._visit_methods_of_class(node)
-
- def test_constr_params_in_class_google(self):
- """Example of a class with missing constructor parameter documentation
- (Google style)
-
- Everything is completely analogous to functions.
- """
- node = astroid.extract_node("""
- class ClassFoo(object):
- '''docstring foo
-
- Args:
- y: bla
-
- missing constructor parameter documentation
- '''
-
- def __init__(self, x, y):
- pass
-
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('x',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('x, y',))
- ):
- self._visit_methods_of_class(node)
-
- def test_constr_params_in_class_numpy(self):
- """Example of a class with missing constructor parameter documentation
- (Numpy style)
-
- Everything is completely analogous to functions.
- """
- node = astroid.extract_node("""
- class ClassFoo(object):
- '''docstring foo
-
- Parameters
- ----------
- y:
- bla
-
- missing constructor parameter documentation
- '''
-
- def __init__(self, x, y):
- pass
-
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('x',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('x, y',))
- ):
- self._visit_methods_of_class(node)
-
- def test_constr_params_in_init_sphinx(self):
- """Example of a class with missing constructor parameter documentation
- (Sphinx style)
-
- Everything is completely analogous to functions.
- """
- node = astroid.extract_node("""
- class ClassFoo(object):
- def __init__(self, x, y):
- '''docstring foo constructor
-
- :param y: bla
-
- missing constructor parameter documentation
- '''
-
- pass
-
- """)
- constructor_node = node.body[0]
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=constructor_node,
- args=('x',)),
- Message(
- msg_id='missing-type-doc',
- node=constructor_node,
- args=('x, y',))
- ):
- self._visit_methods_of_class(node)
-
- def test_constr_params_in_init_google(self):
- """Example of a class with missing constructor parameter documentation
- (Google style)
-
- Everything is completely analogous to functions.
- """
- node = astroid.extract_node("""
- class ClassFoo(object):
- def __init__(self, x, y):
- '''docstring foo constructor
-
- Args:
- y: bla
-
- missing constructor parameter documentation
- '''
- pass
-
- """)
- constructor_node = node.body[0]
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=constructor_node,
- args=('x',)),
- Message(
- msg_id='missing-type-doc',
- node=constructor_node,
- args=('x, y',))
- ):
- self._visit_methods_of_class(node)
-
- def test_constr_params_in_init_numpy(self):
- """Example of a class with missing constructor parameter documentation
- (Numpy style)
-
- Everything is completely analogous to functions.
- """
- node = astroid.extract_node("""
- class ClassFoo(object):
- def __init__(self, x, y):
- '''docstring foo constructor
-
- Parameters
- ----------
- y:
- bla
-
- missing constructor parameter documentation
- '''
- pass
-
- """)
- constructor_node = node.body[0]
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=constructor_node,
- args=('x',)),
- Message(
- msg_id='missing-type-doc',
- node=constructor_node,
- args=('x, y',))
- ):
- self._visit_methods_of_class(node)
-
- def test_see_sentence_for_constr_params_in_class(self):
- """Example usage of "For the parameters, see" in class docstring"""
- node = astroid.extract_node("""
- class ClassFoo(object):
- '''docstring foo
-
- For the parameters, see :func:`bla`
- '''
-
- def __init__(self, x, y):
- '''init'''
- pass
-
- """)
- with self.assertNoMessages():
- self._visit_methods_of_class(node)
-
- def test_see_sentence_for_constr_params_in_init(self):
- """Example usage of "For the parameters, see" in init docstring"""
- node = astroid.extract_node("""
- class ClassFoo(object):
- '''foo'''
-
- def __init__(self, x, y):
- '''docstring foo constructor
-
- For the parameters, see :func:`bla`
- '''
- pass
-
- """)
- with self.assertNoMessages():
- self._visit_methods_of_class(node)
-
-
- def test_constr_params_in_class_and_init_sphinx(self):
- """Example of a class with missing constructor parameter documentation
- in both the init docstring and the class docstring
- (Sphinx style)
-
- Everything is completely analogous to functions.
- """
- node = astroid.extract_node("""
- class ClassFoo(object):
- '''docstring foo
-
- :param y: None
-
- missing constructor parameter documentation
- '''
-
- def __init__(self, x, y):
- '''docstring foo
-
- :param y: bla
-
- missing constructor parameter documentation
- '''
- pass
-
- """)
- constructor_node = node.body[0]
- with self.assertAddsMessages(
- Message(
- msg_id='multiple-constructor-doc',
- node=node,
- args=(node.name,)),
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('x',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('x, y',)),
- Message(
- msg_id='missing-param-doc',
- node=constructor_node,
- args=('x',)),
- Message(
- msg_id='missing-type-doc',
- node=constructor_node,
- args=('x, y',)),
- ):
- self._visit_methods_of_class(node)
-
- def test_constr_params_in_class_and_init_google(self):
- """Example of a class with missing constructor parameter documentation
- in both the init docstring and the class docstring
- (Google style)
-
- Everything is completely analogous to functions.
- """
- node = astroid.extract_node("""
- class ClassFoo(object):
- '''docstring foo
-
- Args:
- y: bla
-
- missing constructor parameter documentation
- '''
-
- def __init__(self, x, y):
- '''docstring foo
-
- Args:
- y: bla
-
- missing constructor parameter documentation
- '''
- pass
-
- """)
- constructor_node = node.body[0]
- with self.assertAddsMessages(
- Message(
- msg_id='multiple-constructor-doc',
- node=node,
- args=(node.name,)),
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('x',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('x, y',)),
- Message(
- msg_id='missing-param-doc',
- node=constructor_node,
- args=('x',)),
- Message(
- msg_id='missing-type-doc',
- node=constructor_node,
- args=('x, y',)),
- ):
- self._visit_methods_of_class(node)
-
- def test_constr_params_in_class_and_init_numpy(self):
- """Example of a class with missing constructor parameter documentation
- in both the init docstring and the class docstring
- (Numpy style)
-
- Everything is completely analogous to functions.
- """
- node = astroid.extract_node("""
- class ClassFoo(object):
- '''docstring foo
-
- Parameters
- ----------
- y:
- bla
-
- missing constructor parameter documentation
- '''
-
- def __init__(self, x, y):
- '''docstring foo
-
- Parameters
- ----------
- y:
- bla
-
- missing constructor parameter documentation
- '''
- pass
-
- """)
- constructor_node = node.body[0]
- with self.assertAddsMessages(
- Message(
- msg_id='multiple-constructor-doc',
- node=node,
- args=(node.name,)),
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('x',)),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('x, y',)),
- Message(
- msg_id='missing-param-doc',
- node=constructor_node,
- args=('x',)),
- Message(
- msg_id='missing-type-doc',
- node=constructor_node,
- args=('x, y',)),
- ):
- self._visit_methods_of_class(node)
-
- @pytest.mark.skipif(sys.version_info[0] != 3, reason="Enabled on Python 3")
- def test_kwonlyargs_are_taken_in_account(self):
- node = astroid.extract_node('''
- def my_func(arg, *, kwonly, missing_kwonly):
- """The docstring
-
- :param int arg: The argument.
- :param bool kwonly: A keyword-arg.
- """
- ''')
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('missing_kwonly', )),
- Message(
- msg_id='missing-type-doc',
- node=node,
- args=('missing_kwonly', ))):
- self.checker.visit_functiondef(node)
-
- def test_warns_missing_args_sphinx(self):
- node = astroid.extract_node('''
- def my_func(named_arg, *args):
- """The docstring
-
- :param named_arg: Returned
- :type named_arg: object
- :returns: Maybe named_arg
- :rtype: object or None
- """
- if args:
- return named_arg
- ''')
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('args',))):
- self.checker.visit_functiondef(node)
-
- def test_warns_missing_kwargs_sphinx(self):
- node = astroid.extract_node('''
- def my_func(named_arg, **kwargs):
- """The docstring
-
- :param named_arg: Returned
- :type named_arg: object
- :returns: Maybe named_arg
- :rtype: object or None
- """
- if kwargs:
- return named_arg
- ''')
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('kwargs',))):
- self.checker.visit_functiondef(node)
-
- def test_warns_missing_args_google(self):
- node = astroid.extract_node('''
- def my_func(named_arg, *args):
- """The docstring
-
- Args:
- named_arg (object): Returned
-
- Returns:
- object or None: Maybe named_arg
- """
- if args:
- return named_arg
- ''')
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('args',))):
- self.checker.visit_functiondef(node)
-
- def test_warns_missing_kwargs_google(self):
- node = astroid.extract_node('''
- def my_func(named_arg, **kwargs):
- """The docstring
-
- Args:
- named_arg (object): Returned
-
- Returns:
- object or None: Maybe named_arg
- """
- if kwargs:
- return named_arg
- ''')
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('kwargs',))):
- self.checker.visit_functiondef(node)
-
- def test_warns_missing_args_numpy(self):
- node = astroid.extract_node('''
- def my_func(named_arg, *args):
- """The docstring
-
- Args
- ----
- named_arg : object
- Returned
-
- Returns
- -------
- object or None
- Maybe named_arg
- """
- if args:
- return named_arg
- ''')
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('args',))):
- self.checker.visit_functiondef(node)
-
- def test_warns_missing_kwargs_numpy(self):
- node = astroid.extract_node('''
- def my_func(named_arg, **kwargs):
- """The docstring
-
- Args
- ----
- named_arg : object
- Returned
-
- Returns
- -------
- object or None
- Maybe named_arg
- """
- if kwargs:
- return named_arg
- ''')
- with self.assertAddsMessages(
- Message(
- msg_id='missing-param-doc',
- node=node,
- args=('kwargs',))):
- self.checker.visit_functiondef(node)
-
- def test_finds_args_without_type_sphinx(self):
- node = astroid.extract_node('''
- def my_func(named_arg, *args):
- """The docstring
-
- :param named_arg: Returned
- :type named_arg: object
- :param args: Optional arguments
- :returns: Maybe named_arg
- :rtype: object or None
- """
- if args:
- return named_arg
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_finds_kwargs_without_type_sphinx(self):
- node = astroid.extract_node('''
- def my_func(named_arg, **kwargs):
- """The docstring
-
- :param named_arg: Returned
- :type named_arg: object
- :param kwargs: Keyword arguments
- :returns: Maybe named_arg
- :rtype: object or None
- """
- if kwargs:
- return named_arg
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_finds_args_without_type_google(self):
- node = astroid.extract_node('''
- def my_func(named_arg, *args):
- """The docstring
-
- Args:
- named_arg (object): Returned
- *args: Optional arguments
-
- Returns:
- object or None: Maybe named_arg
- """
- if args:
- return named_arg
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_finds_kwargs_without_type_google(self):
- node = astroid.extract_node('''
- def my_func(named_arg, **kwargs):
- """The docstring
-
- Args:
- named_arg (object): Returned
- **kwargs: Keyword arguments
-
- Returns:
- object or None: Maybe named_arg
- """
- if kwargs:
- return named_arg
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_finds_args_without_type_numpy(self):
- node = astroid.extract_node('''
- def my_func(named_arg, *args):
- """The docstring
-
- Args
- ----
- named_arg : object
- Returned
- args :
- Optional Arguments
-
- Returns
- -------
- object or None
- Maybe named_arg
- """
- if args:
- return named_arg
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_finds_args_with_xref_type_google(self):
- node = astroid.extract_node('''
- def my_func(named_arg, **kwargs):
- """The docstring
-
- Args:
- named_arg (`example.value`): Returned
- **kwargs: Keyword arguments
-
- Returns:
- `example.value`: Maybe named_arg
- """
- if kwargs:
- return named_arg
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_finds_args_with_xref_type_numpy(self):
- node = astroid.extract_node('''
- def my_func(named_arg, *args):
- """The docstring
-
- Args
- ----
- named_arg : `example.value`
- Returned
- args :
- Optional Arguments
-
- Returns
- -------
- `example.value`
- Maybe named_arg
- """
- if args:
- return named_arg
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_finds_kwargs_without_type_numpy(self):
- node = astroid.extract_node('''
- def my_func(named_arg, **kwargs):
- """The docstring
-
- Args
- ----
- named_arg : object
- Returned
- kwargs :
- Keyword arguments
-
- Returns
- -------
- object or None
- Maybe named_arg
- """
- if kwargs:
- return named_arg
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- CONTAINER_TYPES = [
- 'dict(str,str)',
- 'dict[str,str]',
- 'tuple(int)',
- 'list[tokenize.TokenInfo]',
- ]
-
- COMPLEX_TYPES = CONTAINER_TYPES + [
- 'dict(str, str)',
- 'dict[str, str]',
- 'int or str',
- 'tuple(int or str)',
- 'tuple(int) or list(int)',
- 'tuple(int or str) or list(int or str)',
- ]
-
- @pytest.mark.parametrize('complex_type', COMPLEX_TYPES)
- def test_finds_multiple_types_sphinx(self, complex_type):
- node = astroid.extract_node('''
- def my_func(named_arg):
- """The docstring
-
- :param named_arg: Returned
- :type named_arg: {0}
-
- :returns: named_arg
- :rtype: {0}
- """
- return named_arg
- '''.format(complex_type))
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- @pytest.mark.parametrize('complex_type', COMPLEX_TYPES)
- def test_finds_multiple_types_google(self, complex_type):
- node = astroid.extract_node('''
- def my_func(named_arg):
- """The docstring
-
- Args:
- named_arg ({0}): Returned
-
- Returns:
- {0}: named_arg
- """
- return named_arg
- '''.format(complex_type))
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- @pytest.mark.parametrize('complex_type', COMPLEX_TYPES)
- def test_finds_multiple_types_numpy(self, complex_type):
- node = astroid.extract_node('''
- def my_func(named_arg):
- """The docstring
-
- Args
- ----
- named_arg : {0}
- Returned
-
- Returns
- -------
- {0}
- named_arg
- """
- return named_arg
- '''.format(complex_type))
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- @pytest.mark.parametrize('container_type', CONTAINER_TYPES)
- def test_finds_compact_container_types_sphinx(self, container_type):
- node = astroid.extract_node('''
- def my_func(named_arg):
- """The docstring
-
- :param {0} named_arg: Returned
-
- :returns: named_arg
- :rtype: {0}
- """
- return named_arg
- '''.format(container_type))
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_ignores_optional_specifier_numpy(self):
- node = astroid.extract_node('''
- def do_something(param, param2='all'):
- """Do something.
-
- Parameters
- ----------
- param : str
- Description.
- param2 : str, optional
- Description (the default is 'all').
-
- Returns
- -------
- int
- Description.
- """
- return param, param2
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_finds_short_name_exception(self):
- node = astroid.extract_node('''
- from fake_package import BadError
-
- def do_something(): #@
- """Do something.
-
- Raises:
- ~fake_package.exceptions.BadError: When something bad happened.
- """
- raise BadError("A bad thing happened.")
- ''')
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_finds_missing_raises_from_setter_sphinx(self):
- """Example of a setter having missing raises documentation in
- the Sphinx style docstring of the property
- """
- property_node, node = astroid.extract_node("""
- class Foo(object):
- @property
- def foo(self): #@
- '''docstring ...
-
- :type: int
- '''
- return 10
-
- @foo.setter
- def foo(self, value):
- raise AttributeError() #@
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-raises-doc',
- node=property_node,
- args=('AttributeError',)),
- ):
- self.checker.visit_raise(node)
-
- def test_finds_missing_raises_from_setter_google(self):
- """Example of a setter having missing raises documentation in
- the Google style docstring of the property
- """
- property_node, node = astroid.extract_node("""
- class Foo(object):
- @property
- def foo(self): #@
- '''int: docstring
-
- Include a "Raises" section so that this is identified
- as a Google docstring and not a Numpy docstring.
-
- Raises:
- RuntimeError: Always
- '''
- raise RuntimeError()
- return 10
-
- @foo.setter
- def foo(self, value):
- raises AttributeError() #@
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-raises-doc',
- node=property_node,
- args=('AttributeError',)),
- ):
- self.checker.visit_raise(node)
-
- def test_finds_missing_raises_from_setter_numpy(self):
- """Example of a setter having missing raises documentation in
- the Numpy style docstring of the property
- """
- property_node, node = astroid.extract_node("""
- class Foo(object):
- @property
- def foo(self): #@
- '''int: docstring
-
- Include a "Raises" section so that this is identified
- as a Numpy docstring and not a Google docstring.
-
- Raises
- ------
- RuntimeError
- Always
- '''
- raise RuntimeError()
- return 10
-
- @foo.setter
- def foo(self, value):
- raises AttributeError() #@
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-raises-doc',
- node=property_node,
- args=('AttributeError',)),
- ):
- self.checker.visit_raise(node)
-
- def test_finds_missing_raises_in_setter_sphinx(self):
- """Example of a setter having missing raises documentation in
- its own Sphinx style docstring
- """
- setter_node, node = astroid.extract_node("""
- class Foo(object):
- @property
- def foo(self):
- '''docstring ...
-
- :type: int
- :raises RuntimeError: Always
- '''
- raise RuntimeError()
- return 10
-
- @foo.setter
- def foo(self, value): #@
- '''setter docstring ...
-
- :type: None
- '''
- raise AttributeError() #@
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-raises-doc',
- node=setter_node,
- args=('AttributeError',)),
- ):
- self.checker.visit_raise(node)
-
- def test_finds_missing_raises_from_setter_google(self):
- """Example of a setter having missing raises documentation in
- its own Google style docstring of the property
- """
- setter_node, node = astroid.extract_node("""
- class Foo(object):
- @property
- def foo(self):
- '''int: docstring ...
-
- Raises:
- RuntimeError: Always
- '''
- raise RuntimeError()
- return 10
-
- @foo.setter
- def foo(self, value): #@
- '''setter docstring ...
-
- Raises:
- RuntimeError: Never
- '''
- if True:
- raise AttributeError() #@
- raise RuntimeError()
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-raises-doc',
- node=setter_node,
- args=('AttributeError',)),
- ):
- self.checker.visit_raise(node)
-
- def test_finds_missing_raises_from_setter_numpy(self):
- """Example of a setter having missing raises documentation in
- its own Numpy style docstring of the property
- """
- setter_node, node = astroid.extract_node("""
- class Foo(object):
- @property
- def foo(self):
- '''int: docstring ...
-
- Raises
- ------
- RuntimeError
- Always
- '''
- raise RuntimeError()
- return 10
-
- @foo.setter
- def foo(self, value): #@
- '''setter docstring ...
-
- Raises
- ------
- RuntimeError
- Never
- '''
- if True:
- raise AttributeError() #@
- raise RuntimeError()
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-raises-doc',
- node=setter_node,
- args=('AttributeError',)),
- ):
- self.checker.visit_raise(node)
-
- def test_finds_property_return_type_sphinx(self):
- """Example of a property having return documentation in
- a Sphinx style docstring
- """
- node = astroid.extract_node("""
- class Foo(object):
- @property
- def foo(self): #@
- '''docstring ...
-
- :type: int
- '''
- return 10
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_finds_property_return_type_google(self):
- """Example of a property having return documentation in
- a Google style docstring
- """
- node = astroid.extract_node("""
- class Foo(object):
- @property
- def foo(self): #@
- '''int: docstring ...
-
- Raises:
- RuntimeError: Always
- '''
- raise RuntimeError()
- return 10
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_finds_property_return_type_numpy(self):
- """Example of a property having return documentation in
- a numpy style docstring
- """
- node = astroid.extract_node("""
- class Foo(object):
- @property
- def foo(self): #@
- '''int: docstring ...
-
- Raises
- ------
- RuntimeError
- Always
- '''
- raise RuntimeError()
- return 10
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_finds_missing_property_return_type_sphinx(self):
- """Example of a property having missing return documentation in
- a Sphinx style docstring
- """
- property_node, node = astroid.extract_node("""
- class Foo(object):
- @property
- def foo(self): #@
- '''docstring ...
-
- :raises RuntimeError: Always
- '''
- raise RuntimeError()
- return 10 #@
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-return-type-doc',
- node=property_node),
- ):
- self.checker.visit_return(node)
-
- def test_finds_missing_property_return_type_google(self):
- """Example of a property having return documentation in
- a Google style docstring
- """
- property_node, node = astroid.extract_node("""
- class Foo(object):
- @property
- def foo(self): #@
- '''docstring ...
-
- Raises:
- RuntimeError: Always
- '''
- raise RuntimeError()
- return 10 #@
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-return-type-doc',
- node=property_node),
- ):
- self.checker.visit_return(node)
-
- def test_finds_missing_property_return_type_numpy(self):
- """Example of a property having return documentation in
- a numpy style docstring
- """
- property_node, node = astroid.extract_node("""
- class Foo(object):
- @property
- def foo(self): #@
- '''docstring ...
-
- Raises
- ------
- RuntimeError
- Always
- '''
- raise RuntimeError()
- return 10 #@
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-return-type-doc',
- node=property_node),
- ):
- self.checker.visit_return(node)
-
- def test_ignores_non_property_return_type_sphinx(self):
- """Example of a class function trying to use `type` as return
- documentation in a Sphinx style docstring
- """
- func_node, node = astroid.extract_node("""
- class Foo(object):
- def foo(self): #@
- '''docstring ...
-
- :type: int
- '''
- return 10 #@
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-return-doc',
- node=func_node),
- Message(
- msg_id='missing-return-type-doc',
- node=func_node),
- ):
- self.checker.visit_return(node)
-
- def test_ignores_non_property_return_type_google(self):
- """Example of a class function trying to use `type` as return
- documentation in a Google style docstring
- """
- func_node, node = astroid.extract_node("""
- class Foo(object):
- def foo(self): #@
- '''int: docstring ...
-
- Raises:
- RuntimeError: Always
- '''
- raise RuntimeError()
- return 10 #@
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-return-doc',
- node=func_node),
- Message(
- msg_id='missing-return-type-doc',
- node=func_node),
- ):
- self.checker.visit_return(node)
-
- def test_ignores_non_property_return_type_numpy(self):
- """Example of a class function trying to use `type` as return
- documentation in a numpy style docstring
- """
- func_node, node = astroid.extract_node("""
- class Foo(object):
- def foo(self): #@
- '''int: docstring ...
-
- Raises
- ------
- RuntimeError
- Always
- '''
- raise RuntimeError()
- return 10 #@
- """)
- with self.assertAddsMessages(
- Message(
- msg_id='missing-return-doc',
- node=func_node),
- Message(
- msg_id='missing-return-type-doc',
- node=func_node),
- ):
- self.checker.visit_return(node)
-
- def test_ignores_return_in_abstract_method_sphinx(self):
- """Example of an abstract method documenting the return type that an
- implementation should return.
- """
- node = astroid.extract_node("""
- import abc
- class Foo(object):
- @abc.abstractmethod
- def foo(self): #@
- '''docstring ...
-
- :returns: Ten
- :rtype: int
- '''
- return 10
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_ignores_return_in_abstract_method_google(self):
- """Example of an abstract method documenting the return type that an
- implementation should return.
- """
- node = astroid.extract_node("""
- import abc
- class Foo(object):
- @abc.abstractmethod
- def foo(self): #@
- '''docstring ...
-
- Returns:
- int: Ten
- '''
- return 10
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_ignores_return_in_abstract_method_numpy(self):
- """Example of an abstract method documenting the return type that an
- implementation should return.
- """
- node = astroid.extract_node("""
- import abc
- class Foo(object):
- @abc.abstractmethod
- def foo(self): #@
- '''docstring ...
-
- Returns
- -------
- int
- Ten
- '''
- return 10
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_ignores_raise_notimplementederror_sphinx(self):
- """Example of an abstract
- """
- node = astroid.extract_node("""
- class Foo(object):
- def foo(self, arg): #@
- '''docstring ...
-
- :param arg: An argument.
- :type arg: int
- '''
- raise NotImplementedError()
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_ignores_return_in_abstract_method_google(self):
- """Example of a method documenting the return type that an
- implementation should return.
- """
- node = astroid.extract_node("""
- class Foo(object):
- def foo(self, arg): #@
- '''docstring ...
-
- Args:
- arg (int): An argument.
- '''
- raise NotImplementedError()
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
-
- def test_ignores_return_in_abstract_method_numpy(self):
- """Example of a method documenting the return type that an
- implementation should return.
- """
- node = astroid.extract_node("""
- class Foo(object):
- def foo(self, arg): #@
- '''docstring ...
-
- Parameters
- ----------
- arg : int
- An argument.
- '''
- raise NotImplementedError()
- """)
- with self.assertNoMessages():
- self.checker.visit_functiondef(node)
|