ó '![c@`sŒdZddlmZmZmZddlZddlZddlZddlm Z m Z m Z ddl m Z de fd„ƒYZdS(sUnit tests for the pylint checkers in :mod:`pylint.extensions.check_docs`, in particular the parameter documentation checker `DocstringChecker` i(tdivisiontprint_functiontabsolute_importN(tCheckerTestCasetMessaget set_config(tDocstringParameterCheckertTestParamDocCheckercB`sqeZdZeZied6Zd„Zd„Zd„Z d„Z d„Z e de ƒd„ƒZd„Zd „Zd „Zd „Zd „Zd „Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Z d„Z!d„Z"d„Z#d„Z$d„Z%d„Z&d „Z'd!„Z(e)j*j+e,j-d"d#kd$d%ƒd&„ƒZ.d'„Z/d(„Z0d)„Z1d*„Z2d+„Z3d,„Z4d-„Z5d.„Z6d/„Z7d0„Z8d1„Z9d2„Z:d3„Z;d4„Z<d5d6d7d8gZ=e=d9d:d;d<d=d>gZ>e)j*j?d?e>ƒd@„ƒZ@e)j*j?d?e>ƒdA„ƒZAe)j*j?d?e>ƒdB„ƒZBe)j*j?dCe=ƒdD„ƒZCdE„ZDdF„ZEdG„ZFdH„ZGdI„ZHdJ„ZIdK„ZGdL„ZHdM„ZJdN„ZKdO„ZLdP„ZMdQ„ZNdR„ZOdS„ZPdT„ZQdU„ZRdV„ZSdW„ZTdX„ZUdY„ZVdZ„ZTd[„ZURS(\s'Tests for pylint_plugin.ParamDocCheckertaccept_no_param_docc C`sftjdƒ}|jtddd|dd ƒtddd|dd ƒƒ|jj|ƒWd QXd S( scExample of a function with missing Sphinx parameter documentation in the docstring s¤ def function_foo(x, y, z): '''docstring ... :param x: bla :param int z: bar ''' pass tmsg_idsmissing-param-doctnodetargstysmissing-type-docsx, yN(R (sx, y(tastroidt extract_nodetassertAddsMessagesRtcheckertvisit_functiondef(tselfR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt,test_missing_func_params_in_sphinx_docstring$s  c C`sftjdƒ}|jtddd|dd ƒtddd|dd ƒƒ|jj|ƒWd QXd S( siExample of a function with missing Google style parameter documentation in the docstring sÏ def function_foo(x, y, z): '''docstring ... Args: x: bla z (int): bar some other stuff ''' pass R smissing-param-docR R R smissing-type-docsx, yN(R (sx, y(R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt,test_missing_func_params_in_google_docstring>s  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(suExample of a function with Google style parameter splitted in Args and Keyword Args in the docstring sV 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) N(R RtassertNoMessagesRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt7test_func_params_and_keyword_params_in_google_docstringZs  c C`s–tjdƒ}|jtddd|dd ƒtddd|dd ƒtddd|ddƒtdd d|ddƒƒ|jj|ƒWd QXd S(s‘Example of a function with Google style parameter splitted in Args and Keyword Args in the docstring but with wrong keyword args sW 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) R smissing-param-docR R tthatsmissing-type-docsdiffering-param-doctthesesdiffering-type-docN(R(R(R(R(R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt=test_func_params_and_wrong_keyword_params_in_google_docstringns(  c C`sftjdƒ}|jtddd|dd ƒtddd|dd ƒƒ|jj|ƒWd QXd S( shExample of a function with missing NumPy style parameter documentation in the docstring s def function_foo(x, y, z): '''docstring ... Parameters ---------- x: bla z: int bar some other stuff ''' pass R smissing-param-docR R R smissing-type-docsx, yN(R (sx, y(R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt+test_missing_func_params_in_numpy_docstring“s  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(skExample of a function with no parameter documentation at all No error message is emitted. s‡ def function_foo(x, y): '''docstring ... missing parameter documentation''' pass N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt+test_tolerate_no_param_documentation_at_all²s  c C`sftjdƒ}|jtddd|dd ƒtddd|dd ƒƒ|jj|ƒWdQXdS( s~Example of a function with no parameter documentation at all Missing documentation error message is emitted. s‡ def function_foo(x, y): '''docstring ... missing parameter documentation''' pass R smissing-param-docR R sx, ysmissing-type-docN(sx, y(sx, y(R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt1test_don_t_tolerate_no_param_documentation_at_allÂs  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(sgExample for the usage of "For the parameters, see" to suppress missing-param warnings. s™ def function_foo(x, y): '''docstring ... For the parameters, see :func:`blah` ''' pass N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt/test_see_tolerate_no_param_documentation_at_allÚs  cC`sLxE|jD]:}t|tjƒr t|dƒr |jj|ƒq q WdS(sƒVisit all methods of a class node :param node: class node :type node: :class:`astroid.scoped_nodes.Class` tnameN(tbodyt isinstanceR t FunctionDefthasattrRR(RR t body_item((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt_visit_methods_of_classésc C`sptjdƒ}|jd}|jtddd|dd ƒtddd|dd ƒƒ|j|ƒWd QXd S( smExample of a class method with missing parameter documentation in the Sphinx style docstring sæ class Foo(object): def method_foo(self, x, y): '''docstring ... missing parameter documentation :param x: bla ''' pass iR smissing-param-docR R R smissing-type-docsx, yN(R (sx, y(R RRRRR$(RR t method_node((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt.test_missing_method_params_in_sphinx_docstringôs   c C`sptjdƒ}|jd}|jtddd|dd ƒtddd|dd ƒƒ|j|ƒWd QXd S( smExample of a class method with missing parameter documentation in the Google style docstring sù class Foo(object): def method_foo(self, x, y): '''docstring ... missing parameter documentation Args: x: bla ''' pass iR smissing-param-docR R R smissing-type-docsx, yN(R (sx, y(R RRRRR$(RR R%((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt.test_missing_method_params_in_google_docstrings   c C`sptjdƒ}|jd}|jtddd|dd ƒtddd|dd ƒƒ|j|ƒWd QXd S( slExample of a class method with missing parameter documentation in the Numpy style docstring s) class Foo(object): def method_foo(self, x, y): '''docstring ... missing parameter documentation Parameters ---------- x: bla ''' pass iR smissing-param-docR R R smissing-type-docsx, yN(R (sx, y(R RRRRR$(RR R%((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt-test_missing_method_params_in_numpy_docstring-s   cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(slExample of a function with correctly documented parameters and return values (Sphinx style) sª 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 N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt-test_existing_func_params_in_sphinx_docstringLs  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(slExample of a function with correctly documented parameters and return values (Google style) s— 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 N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt-test_existing_func_params_in_google_docstringfs  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(skExample of a function with correctly documented parameters and return values (Numpy style) sá 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 N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt,test_existing_func_params_in_numpy_docstring~s  c C`søtjdƒ}|jtddd|ddƒtddd|ddƒtdd d|ddƒtdd d|ddƒƒ|jj|ƒWd QXtjdƒ}|jtdd d|ddƒtdd d|ddƒƒ|jj|ƒWd QXd S(s~Example of functions with inconsistent parameter names in the signature and in the Sphinx style documentation s. 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 R smissing-param-docR R s xarg, zargsmissing-type-docs yarg, zargsdiffering-param-docs xarg1, zarg1sdiffering-type-docs yarg1, zarg1Nsñ def function_foo(xarg, yarg): '''function foo ... :param yarg1: bla yarg :type yarg1: float For the other parameters, see bla. ''' return xarg + yarg tyarg1(s xarg, zarg(s yarg, zarg(s xarg1, zarg1(s yarg1, zarg1(R,(R,(R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt2test_wrong_name_of_func_params_in_sphinx_docstringœs@    c C`søtjdƒ}|jtddd|ddƒtddd|ddƒtddd|ddƒtdd d|ddƒƒ|jj|ƒWd QXtjd ƒ}|jtddd|ddƒtdd d|ddƒƒ|jj|ƒWd QXd S(s~Example of functions with inconsistent parameter names in the signature and in the Google style documentation s  def function_foo(xarg, yarg, zarg): '''function foo ... Args: xarg1 (int): bla xarg yarg (float): bla yarg zarg1 (str): bla zarg ''' return xarg + yarg R smissing-param-docR R s xarg, zargsmissing-type-docsdiffering-param-docs xarg1, zarg1sdiffering-type-docNsé def function_foo(xarg, yarg): '''function foo ... Args: yarg1 (float): bla yarg For the other parameters, see bla. ''' return xarg + yarg R,(s xarg, zarg(s xarg, zarg(s xarg1, zarg1(s xarg1, zarg1(R,(R,(R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt2test_wrong_name_of_func_params_in_google_docstringÙs@    c C`søtjdƒ}|jtddd|ddƒtddd|ddƒtddd|ddƒtdd d|ddƒƒ|jj|ƒWd QXtjd ƒ}|jtddd|ddƒtdd d|ddƒƒ|jj|ƒWd QXd S(s}Example of functions with inconsistent parameter names in the signature and in the Numpy style documentation sE def function_foo(xarg, yarg, zarg): '''function foo ... Parameters ---------- xarg1: int bla xarg yarg: float bla yarg zarg1: str bla zarg ''' return xarg + yarg R smissing-param-docR R s xarg, zargsmissing-type-docsdiffering-param-docs xarg1, zarg1sdiffering-type-docNs def function_foo(xarg, yarg): '''function foo ... Parameters ---------- yarg1: float bla yarg For the other parameters, see bla. ''' return xarg + yarg R,(s xarg, zarg(s xarg, zarg(s xarg1, zarg1(s xarg1, zarg1(R,(R,(R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt1test_wrong_name_of_func_params_in_numpy_docstrings@    cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(sº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) sö def function_foo(xarg, yarg): '''function foo ... :param yarg: bla yarg :type yarg: float For the other parameters, see :func:`bla` ''' return xarg + yarg N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt5test_see_sentence_for_func_params_in_sphinx_docstringUs  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(sº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) sï def function_foo(xarg, yarg): '''function foo ... Args: yarg (float): bla yarg For the other parameters, see :func:`bla` ''' return xarg + yarg N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt5test_see_sentence_for_func_params_in_google_docstringhs  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(s¹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) s def function_foo(xarg, yarg): '''function foo ... Parameters ---------- yarg: float bla yarg For the other parameters, see :func:`bla` ''' return xarg + yarg N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt4test_see_sentence_for_func_params_in_numpy_docstring{s  c C`sctjdƒ}|jtddd|dd ƒtddd|dd ƒƒ|j|ƒWd QXd S( sExample of a class with missing constructor parameter documentation (Sphinx style) Everything is completely analogous to functions. só class ClassFoo(object): '''docstring foo :param y: bla missing constructor parameter documentation ''' def __init__(self, x, y): pass R smissing-param-docR R txsmissing-type-docsx, yN(R3(sx, y(R RRRR$(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt"test_constr_params_in_class_sphinxs  c C`sctjdƒ}|jtddd|dd ƒtddd|dd ƒƒ|j|ƒWd QXd S( sExample of a class with missing constructor parameter documentation (Google style) Everything is completely analogous to functions. s class ClassFoo(object): '''docstring foo Args: y: bla missing constructor parameter documentation ''' def __init__(self, x, y): pass R smissing-param-docR R R3smissing-type-docsx, yN(R3(sx, y(R RRRR$(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt"test_constr_params_in_class_google¯s  c C`sctjdƒ}|jtddd|dd ƒtddd|dd ƒƒ|j|ƒWd QXd S( sœExample of a class with missing constructor parameter documentation (Numpy style) Everything is completely analogous to functions. s* class ClassFoo(object): '''docstring foo Parameters ---------- y: bla missing constructor parameter documentation ''' def __init__(self, x, y): pass R smissing-param-docR R R3smissing-type-docsx, yN(R3(sx, y(R RRRR$(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt!test_constr_params_in_class_numpyÏs  c C`sptjdƒ}|jd}|jtddd|dd ƒtddd|dd ƒƒ|j|ƒWd QXd S( sExample of a class with missing constructor parameter documentation (Sphinx style) Everything is completely analogous to functions. s class ClassFoo(object): def __init__(self, x, y): '''docstring foo constructor :param y: bla missing constructor parameter documentation ''' pass iR smissing-param-docR R R3smissing-type-docsx, yN(R3(sx, y(R RRRRR$(RR tconstructor_node((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt!test_constr_params_in_init_sphinxñs   c C`sptjdƒ}|jd}|jtddd|dd ƒtddd|dd ƒƒ|j|ƒWd QXd S( sExample of a class with missing constructor parameter documentation (Google style) Everything is completely analogous to functions. s class ClassFoo(object): def __init__(self, x, y): '''docstring foo constructor Args: y: bla missing constructor parameter documentation ''' pass iR smissing-param-docR R R3smissing-type-docsx, yN(R3(sx, y(R RRRRR$(RR R7((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt!test_constr_params_in_init_googles   c C`sptjdƒ}|jd}|jtddd|dd ƒtddd|dd ƒƒ|j|ƒWd QXd S( sœExample of a class with missing constructor parameter documentation (Numpy style) Everything is completely analogous to functions. sE class ClassFoo(object): def __init__(self, x, y): '''docstring foo constructor Parameters ---------- y: bla missing constructor parameter documentation ''' pass iR smissing-param-docR R R3smissing-type-docsx, yN(R3(sx, y(R RRRRR$(RR R7((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt test_constr_params_in_init_numpy1s   cC`s3tjdƒ}|jƒ|j|ƒWdQXdS(s=Example usage of "For the parameters, see" in class docstringsß class ClassFoo(object): '''docstring foo For the parameters, see :func:`bla` ''' def __init__(self, x, y): '''init''' pass N(R RRR$(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt,test_see_sentence_for_constr_params_in_classSs  cC`s3tjdƒ}|jƒ|j|ƒWdQXdS(s<Example usage of "For the parameters, see" in init docstringsò class ClassFoo(object): '''foo''' def __init__(self, x, y): '''docstring foo constructor For the parameters, see :func:`bla` ''' pass N(R RRR$(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt+test_see_sentence_for_constr_params_in_initds  c C`s¾tjdƒ}|jd}|jtddd|d|jfƒtddd|dd ƒtdd d|dd ƒtddd|ddƒtdd d|ddƒƒ|j|ƒWd QXd S(sØ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. sy 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 iR smultiple-constructor-docR R smissing-param-docR3smissing-type-docsx, yN(R3(sx, y(R3(sx, y(R RRRRRR$(RR R7((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt+test_constr_params_in_class_and_init_sphinxvs2    c C`s¾tjdƒ}|jd}|jtddd|d|jfƒtddd|dd ƒtdd d|dd ƒtddd|ddƒtdd d|ddƒƒ|j|ƒWd QXd S(sØ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. sš 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 iR smultiple-constructor-docR R smissing-param-docR3smissing-type-docsx, yN(R3(sx, y(R3(sx, y(R RRRRRR$(RR R7((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt+test_constr_params_in_class_and_init_google©s2    c C`s¾tjdƒ}|jd}|jtddd|d|jfƒtddd|dd ƒtdd d|dd ƒtddd|ddƒtdd d|ddƒƒ|j|ƒWd QXd S(s×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. sò 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 iR smultiple-constructor-docR R smissing-param-docR3smissing-type-docsx, yN(R3(sx, y(R3(sx, y(R RRRRRR$(RR R7((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt*test_constr_params_in_class_and_init_numpyÞs2    iitreasonsEnabled on Python 3c C`sftjdƒ}|jtddd|ddƒtddd|dd ƒƒ|jj|ƒWdQXdS( NsÅ def my_func(arg, *, kwonly, missing_kwonly): """The docstring :param int arg: The argument. :param bool kwonly: A keyword-arg. """ R smissing-param-docR R tmissing_kwonlysmissing-type-doc(RA(RA(R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt$test_kwonlyargs_are_taken_in_accounts  cC`sNtjdƒ}|jtddd|ddƒƒ|jj|ƒWdQXdS(Ns( 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 R smissing-param-docR R (R (R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyttest_warns_missing_args_sphinx,s  cC`sNtjdƒ}|jtddd|ddƒƒ|jj|ƒWdQXdS(Ns- 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 R smissing-param-docR R tkwargs(RD(R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt test_warns_missing_kwargs_sphinx@s  cC`sNtjdƒ}|jtddd|ddƒƒ|jj|ƒWdQXdS(Ns 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 R smissing-param-docR R (R (R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyttest_warns_missing_args_googleTs  cC`sNtjdƒ}|jtddd|ddƒƒ|jj|ƒWdQXdS(Ns 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 R smissing-param-docR R RD(RD(R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt test_warns_missing_kwargs_googleis  cC`sNtjdƒ}|jtddd|ddƒƒ|jj|ƒWdQXdS(NsZ 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 R smissing-param-docR R (R (R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyttest_warns_missing_args_numpy~s  cC`sNtjdƒ}|jtddd|ddƒƒ|jj|ƒWdQXdS(Ns_ 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 R smissing-param-docR R RD(RD(R RRRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyttest_warns_missing_kwargs_numpy—s  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(NsT 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 (R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt#test_finds_args_without_type_sphinx°s  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(NsZ 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 (R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt%test_finds_kwargs_without_type_sphinxÁs  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(NsC 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 (R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt#test_finds_args_without_type_googleÒs  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(NsJ 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 (R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt%test_finds_kwargs_without_type_googleäs  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(Ns 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 (R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt"test_finds_args_without_type_numpyös  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(NsT 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 (R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt%test_finds_args_with_xref_type_google s  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(Nsš 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 (R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt$test_finds_args_with_xref_type_numpys  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(Ns– 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 (R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt$test_finds_kwargs_without_type_numpy6s  s dict(str,str)s dict[str,str]s tuple(int)slist[tokenize.TokenInfo]sdict(str, str)sdict[str, str]s int or strstuple(int or str)stuple(int) or list(int)s%tuple(int or str) or list(int or str)t complex_typecC`s?tjdj|ƒƒ}|jƒ|jj|ƒWdQXdS(Nsõ def my_func(named_arg): """The docstring :param named_arg: Returned :type named_arg: {0} :returns: named_arg :rtype: {0} """ return named_arg (R RtformatRRR(RRRR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt test_finds_multiple_types_sphinx]s  cC`s?tjdj|ƒƒ}|jƒ|jj|ƒWdQXdS(Nså def my_func(named_arg): """The docstring Args: named_arg ({0}): Returned Returns: {0}: named_arg """ return named_arg (R RRSRRR(RRRR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt test_finds_multiple_types_googlens  cC`s?tjdj|ƒƒ}|jƒ|jj|ƒWdQXdS(Ns& def my_func(named_arg): """The docstring Args ---- named_arg : {0} Returned Returns ------- {0} named_arg """ return named_arg (R RRSRRR(RRRR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyttest_finds_multiple_types_numpys tcontainer_typecC`s?tjdj|ƒƒ}|jƒ|jj|ƒWdQXdS(NsØ def my_func(named_arg): """The docstring :param {0} named_arg: Returned :returns: named_arg :rtype: {0} """ return named_arg (R RRSRRR(RRWR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt)test_finds_compact_container_types_sphinx”s  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(Ns— 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 (R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt%test_ignores_optional_specifier_numpy¤s  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(Ns 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.") (R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyttest_finds_short_name_exceptionºs  cC`sTtjdƒ\}}|jtddd|ddƒƒ|jj|ƒWdQXdS( svExample of a setter having missing raises documentation in the Sphinx style docstring of the property s( class Foo(object): @property def foo(self): #@ '''docstring ... :type: int ''' return 10 @foo.setter def foo(self, value): raise AttributeError() #@ R smissing-raises-docR R tAttributeErrorN(R[(R RRRRt visit_raise(Rt property_nodeR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt,test_finds_missing_raises_from_setter_sphinxÉs  cC`sTtjdƒ\}}|jtddd|ddƒƒ|jj|ƒWdQXdS( svExample of a setter having missing raises documentation in the Google style docstring of the property sý 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() #@ R smissing-raises-docR R R[N(R[(R RRRRR\(RR]R ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt,test_finds_missing_raises_from_setter_googleãs cC`sTtjdƒ\}}|jtddd|ddƒƒ|jj|ƒWdQXdS( suExample of a setter having missing raises documentation in the Numpy style docstring of the property s" 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() #@ R smissing-raises-docR R R[N(R[(R RRRRR\(RR]R ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt+test_finds_missing_raises_from_setter_numpys cC`sTtjdƒ\}}|jtddd|ddƒƒ|jj|ƒWdQXdS( sjExample of a setter having missing raises documentation in its own Sphinx style docstring sÓ 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() #@ R smissing-raises-docR R R[N(R[(R RRRRR\(Rt setter_nodeR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt*test_finds_missing_raises_in_setter_sphinx#s cC`sTtjdƒ\}}|jtddd|ddƒƒ|jj|ƒWdQXdS( szExample of a setter having missing raises documentation in its own Google style docstring of the property s7 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() R smissing-raises-docR R R[N(R[(R RRRRR\(RRaR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyR_Cs cC`sTtjdƒ\}}|jtddd|ddƒƒ|jj|ƒWdQXdS( syExample of a setter having missing raises documentation in its own Numpy style docstring of the property s 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() R smissing-raises-docR R R[N(R[(R RRRRR\(RRaR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyR`fs cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(s^Example of a property having return documentation in a Sphinx style docstring sà class Foo(object): @property def foo(self): #@ '''docstring ... :type: int ''' return 10 N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt&test_finds_property_return_type_sphinxs  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(s^Example of a property having return documentation in a Google style docstring s class Foo(object): @property def foo(self): #@ '''int: docstring ... Raises: RuntimeError: Always ''' raise RuntimeError() return 10 N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt&test_finds_property_return_type_googležs  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(s]Example of a property having return documentation in a numpy style docstring s8 class Foo(object): @property def foo(self): #@ '''int: docstring ... Raises ------ RuntimeError Always ''' raise RuntimeError() return 10 N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt%test_finds_property_return_type_numpy±s  cC`sNtjdƒ\}}|jtddd|ƒƒ|jj|ƒWdQXdS(sfExample of a property having missing return documentation in a Sphinx style docstring sý class Foo(object): @property def foo(self): #@ '''docstring ... :raises RuntimeError: Always ''' raise RuntimeError() return 10 #@ R smissing-return-type-docR N(R RRRRt visit_return(RR]R ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt.test_finds_missing_property_return_type_sphinxÆs  cC`sNtjdƒ\}}|jtddd|ƒƒ|jj|ƒWdQXdS(s^Example of a property having return documentation in a Google style docstring s class Foo(object): @property def foo(self): #@ '''docstring ... Raises: RuntimeError: Always ''' raise RuntimeError() return 10 #@ R smissing-return-type-docR N(R RRRRRf(RR]R ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt.test_finds_missing_property_return_type_googleÜs  cC`sNtjdƒ\}}|jtddd|ƒƒ|jj|ƒWdQXdS(s]Example of a property having return documentation in a numpy style docstring s6 class Foo(object): @property def foo(self): #@ '''docstring ... Raises ------ RuntimeError Always ''' raise RuntimeError() return 10 #@ R smissing-return-type-docR N(R RRRRRf(RR]R ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt-test_finds_missing_property_return_type_numpyós  cC`s`tjdƒ\}}|jtddd|ƒtddd|ƒƒ|jj|ƒWdQXdS(suExample of a class function trying to use `type` as return documentation in a Sphinx style docstring s° class Foo(object): def foo(self): #@ '''docstring ... :type: int ''' return 10 #@ R smissing-return-docR smissing-return-type-docN(R RRRRRf(Rt func_nodeR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt,test_ignores_non_property_return_type_sphinx s cC`s`tjdƒ\}}|jtddd|ƒtddd|ƒƒ|jj|ƒWdQXdS(suExample of a class function trying to use `type` as return documentation in a Google style docstring s class Foo(object): def foo(self): #@ '''int: docstring ... Raises: RuntimeError: Always ''' raise RuntimeError() return 10 #@ R smissing-return-docR smissing-return-type-docN(R RRRRRf(RRjR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt,test_ignores_non_property_return_type_google#s  cC`s`tjdƒ\}}|jtddd|ƒtddd|ƒƒ|jj|ƒWdQXdS(stExample of a class function trying to use `type` as return documentation in a numpy style docstring s% class Foo(object): def foo(self): #@ '''int: docstring ... Raises ------ RuntimeError Always ''' raise RuntimeError() return 10 #@ R smissing-return-docR smissing-return-type-docN(R RRRRRf(RRjR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt+test_ignores_non_property_return_type_numpy<s  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(spExample of an abstract method documenting the return type that an implementation should return. sÿ import abc class Foo(object): @abc.abstractmethod def foo(self): #@ '''docstring ... :returns: Ten :rtype: int ''' return 10 N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt-test_ignores_return_in_abstract_method_sphinxWs  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(spExample of an abstract method documenting the return type that an implementation should return. sû import abc class Foo(object): @abc.abstractmethod def foo(self): #@ '''docstring ... Returns: int: Ten ''' return 10 N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt-test_ignores_return_in_abstract_method_googlejs  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(spExample of an abstract method documenting the return type that an implementation should return. s! import abc class Foo(object): @abc.abstractmethod def foo(self): #@ '''docstring ... Returns ------- int Ten ''' return 10 N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt,test_ignores_return_in_abstract_method_numpy}s  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(sExample of an abstract sñ class Foo(object): def foo(self, arg): #@ '''docstring ... :param arg: An argument. :type arg: int ''' raise NotImplementedError() N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyt-test_ignores_raise_notimplementederror_sphinx’s  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(sfExample of a method documenting the return type that an implementation should return. së class Foo(object): def foo(self, arg): #@ '''docstring ... Args: arg (int): An argument. ''' raise NotImplementedError() N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyRo¢s  cC`s6tjdƒ}|jƒ|jj|ƒWdQXdS(sfExample of a method documenting the return type that an implementation should return. s class Foo(object): def foo(self, arg): #@ '''docstring ... Parameters ---------- arg : int An argument. ''' raise NotImplementedError() N(R RRRR(RR ((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyRp³s  (Wt__name__t __module__t__doc__Rt CHECKER_CLASStFalsetCONFIGRRRRRRtTrueRRRR$R&R'R(R)R*R+R-R.R/R0R1R2R4R5R6R8R9R:R;R<R=R>R?tpytesttmarktskipiftsyst version_infoRBRCRERFRGRHRIRJRKRLRMRNRORPRQtCONTAINER_TYPESt COMPLEX_TYPESt parametrizeRTRURVRXRYRZR^R_R`RbRcRdReRgRhRiRkRlRmRnRoRpRq(((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyRs²     %          = ; A     " "   3 5 9.                     ! # '              (Rtt __future__RRRR|RyR tpylint.testutilsRRRtpylint.extensions.docparamsRR(((sElib/python2.7/site-packages/pylint/test/extensions/test_check_docs.pyts