-Ph ddlZddlmZddlmZmZmZddlmZm Z ddl Z ddl Z ddl m Z ddlmZddlmZe j Zee jZe jdd gd hegeegd hd hgd d hd d hghd ed d hz gd dhedhz ggdZe jddhdhdhd dhgdZGddeZdZe jdd gdigddd gigddd d gigddd gigddd dgigddgd dgd ggd!Ze jd"e jd#d$%e jd&d'%fe jd(e jd)d&d*%e jd+d#d,%fd-Z Gd.d/Z!Gd0d1Z"Gd2d3Z#Gd4d5Z$Gd6d7Z%Gd8d9Z&Gd:d;Z'Gd<d=Z(Gd>d?Z)d@Z*e*e*GdAdBZ+GdCdDZ,dEZ-dS)FN) nullcontext)cached_propertypartialwraps) getsourcefilegetsourcelinesvalidate)get_doc_object) ValidatorchecksexpectedallEX01SA01>rrrPR01c:tj||ksJdS)z"Ensure check selection is working.N)r get_validation_checks)r rs \/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/numpydoc/tests/test_validate.py test_utils_get_validation_checksrs&  )& 1 1X = = = = = =everySM10ctjtd5tj|}ddddS#1swxYwYdS)z'Ensure that invalid checks are flagged.zUnrecognized validation codematchN)pytestraises ValueErrorr r)r _s r#test_get_validation_checks_validityr!"s z)G H H H33  *6 2 2333333333333333333s>AAceZdZdZdS) _DummyListz$Dummy list class to test validation.N)__name__ __module__ __qualname____doc__rrr#r#1s....rr#c.tjddS)z>Test that validation can be done on functions made on the fly.z-numpydoc.tests.test_validate._DummyList.clearNr r(rr test_no_filer*5s EFFFFFr file_contentszclass MyClass: passz/class MyClass: # numpydoc ignore=EX01 passz5class MyClass: # numpydoc ignore= EX01,SA01 passzHclass MyClass: def my_method(): # numpydoc ignore:EX01 passzNclass MyClass: def my_method(): # numpydoc ignore: EX01,PR01 passzeclass MyClass: # numpydoc ignore=GL08 def my_method(): # numpydoc ignore:EX01,PR01 passGL08)r,r-c|dz }t|d5}||dddn #1swxYwYtj||ksJdS)z>Test that extraction of validation ignore comments is working.ignore_comments.pywN)openwriter "extract_ignore_validation_comments)tmp_pathr+rfilepathfiles r'test_extract_ignore_validation_commentsr8;s2..H h  " =!!!"""""""""""""""  6x @ @H L L L L L Ls 8<<assumed_encodingutf-8 utf8_codec)idcp1252 cp1252_codec) classnameactual_encodinguMÿClass cp1252_fileu MyClass utf8_filec|dz }d|d}t|d5}|||dddn #1swxYwY|dkr(|dkr"ttjt d }n5|dkr(|dkr"ttjt d }nt}|5tj ||}|iksJ ddddS#1swxYwYdS) z1Test handling of different source file encodings.r0zclass z : passwbNr=r:z8can't decode byte 0xff in position 7: invalid start byterzCcan't decode byte 0x81 in position 9: character maps to ) r2r3encoderrrUnicodeDecodeErrorrr r4) r5r?r@r9r6r+r7contextresults rtest_encodingsrIZs"..H3Y333M h  : =''88999:::::::::::::::(""'77'B'B M L    G # #(8H(D(D M W     >> result = 1 + 1 cdS)z.Allow one liner docstrings (including quotes).Nr(selfs r one_linerzGoodDocStrings.one_linerrbluec dS)a7 Generate a plot. Render the data in the Series as a matplotlib plot of the specified kind. Parameters ---------- kind : str Kind of matplotlib plot, e.g.:: "foo" color : str, default 'blue' Color name or rgb code. **kwargs These parameters will be passed to the matplotlib plotting function. See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr()rNkindcolorkwargss rplotzGoodDocStrings.plotrPrcdS)a Swap two indices on an array. The extended summary can be multiple paragraphs, but just one is enough to pass the validation. Parameters ---------- arr : list The list having indexes swapped. i, j : int The indexes being swapped. *args, **kwargs Extraneous parameters are being permitted. See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr()rNarrijargsrUs rswapzGoodDocStrings.swaprPrcdS)a Generate and return a random number. The value is sampled from a continuous uniform distribution between 0 and 1. Returns ------- float Random number generated. - Make sure you set a seed for reproducibility See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr(rMs rsamplezGoodDocStrings.samplerPrcdS)a Generate and return a sequence of random letters. The length of the returned string is also random, and is also returned. Returns ------- length : int Length of the returned string. letters : str String of random letters. .. versionadded:: 0.1 See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr(rMs rrandom_letterszGoodDocStrings.random_lettersrPrcdS)az Generate an infinite sequence of random numbers. The values are sampled from a continuous uniform distribution between 0 and 1. Yields ------ float Random number generated. See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr(rMs r sample_valueszGoodDocStrings.sample_valuesrPrcdS)aL Return the first 5 elements of the Series. This function is mainly useful to preview the values of the Series without displaying the whole of it. Returns ------- int Subset of the original series with the 5 first values. See Also -------- Series.tail : Return the last 5 elements of the Series. Series.iloc : Return a slice of the elements in the Series, which can also be used to return the first or last n. Examples -------- >>> 1 + 1 2 r,r(rMs rheadzGoodDocStrings.heads .qrcdS)a Return the first elements of the Series. This function is mainly useful to preview the values of the Series without displaying the whole of it. Parameters ---------- n : int Number of values to return. Returns ------- int Subset of the original series with the n first values. See Also -------- tail : Return the last n elements of the Series. Examples -------- >>> s = 10 >>> s 10 With the `n` parameter, we can change the number of returned rows: >>> s + 1 11 r,r(rNns rhead1zGoodDocStrings.head1. @qrcdS)a 2nd rule of summaries should allow this. 3 Starting the summary with a number instead of a capital letter. Also in parameters, returns, see also... Parameters ---------- n : int 4 Number of values to return. Returns ------- int 5 Subset of the original series with the n first values. See Also -------- tail : 6 Return the last n elements of the Series. Examples -------- >>> s = 10 >>> s 10 7 With the `n` parameter, we can change the number of returned rows: >>> s + 1 11 r,r(rgs rsummary_starts_with_numberz)GoodDocStrings.summary_starts_with_numberPrjrTNaNcdS)a Return whether each value contains `pat`. In this case, we are illustrating how to use sections, even if the example is simple enough and does not require them. Parameters ---------- pat : str Pattern to check for within each element. case : bool, default True Whether check should be done with case sensitivity. na : object, default np.nan Fill value for missing data. See Also -------- related : Something related. Examples -------- >>> s = 25 >>> s 25 **Case sensitivity** With `case_sensitive` set to `False` we can match `a` with both `a` and `A`: >>> s + 1 26 **Missing values** We can fill missing values in the output using the `na` parameter: >>> s * 2 50 Nr()rNpatcasenas rcontainszGoodDocStrings.containsrrPrcdS)a Ensure reST directives don't affect checks for leading periods. The extended summary can be multiple paragraphs, but just one is enough to pass the validation. Parameters ---------- axis : str Sentence ending in period, followed by single directive. .. versionchanged:: 0.1.2 numeric_only : bool Sentence ending in period, followed by multiple directives. .. versionadded:: 0.1.2 .. deprecated:: 0.00.0 A multiline description, which spans another line. See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr()rNaxis numeric_onlys rmodezGoodDocStrings.moderPrcdS)a Ensure import other than numpy and pandas are fine. The extended summary can be multiple paragraphs, but just one is enough to pass the validation. See Also -------- related : Something related. Examples -------- This example does not import pandas or import numpy. >>> import datetime >>> datetime.MAXYEAR 9999 Nr(rMs r good_importszGoodDocStrings.good_importsrPrcdS)a' Say hello and have no returns. The extended summary can be multiple paragraphs, but just one is enough to pass the validation. See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr(rMs r no_returnszGoodDocStrings.no_returnsrPrc"d}| dS)a# Say hello and always return None. Since this function never returns a value, this docstring doesn't need a return section. See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 cdS)Nz Hello World!r(r(rr say_helloz/GoodDocStrings.empty_returns..say_hellos!>rTNr()rNr}s r empty_returnszGoodDocStrings.empty_returnss(  " " "    FrcdS)aP Do one thing. Sometimes, this function does other things. Warnings -------- This function may produce side effects when some condition is met. See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr(rMs rwarningszGoodDocStrings.warningsrPrcdS)a Swap two values in a matrix. The extended summary can be multiple paragraphs, but just one is enough to pass the validation. Parameters ---------- matrix : list of list A double list that represents a matrix. a, b : int The indices of the first value. i, j : int The indices of the second value. See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr()rNmatrixabrYrZs rmultiple_variables_on_one_linez-GoodDocStrings.multiple_variables_on_one_line rPrcdS)a Ensure "Other Parameters" are recognized. The second parameter is used infrequently, so it is put in the "Other Parameters" section. Parameters ---------- param1 : bool Description of commonly used parameter. Other Parameters ---------------- param2 : str Description of infrequently used parameter. See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr()rNparam1param2s rother_parameterszGoodDocStrings.other_parameters$rPrcdS)a2 Ensure a PR06 error is not raised when type is member of a set. Literal keywords like 'integer' are valid when specified in a set of valid options for a keyword parameter. Parameters ---------- bar : {'integer', 'boolean'} The literal values of 'integer' and 'boolean' are part of an options set and thus should not be subject to PR06 warnings. See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr()rNbars r+valid_options_in_parameter_description_setsz:GoodDocStrings.valid_options_in_parameter_description_sets>rPrcdS)ah Ensure PR01 and PR02 errors are not raised with trailing underscores. Parameters with trailing underscores need to be escaped to render properly in the documentation since trailing underscores are used to create links. Doing so without also handling the change in the validation logic makes it impossible to both pass validation and render correctly. Parameters ---------- str\_ : str Some text. See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr()rNstr_s r$parameters_with_trailing_underscoresz3GoodDocStrings.parameters_with_trailing_underscoresTrPrcdS)a  Ensure PR06 doesn't fail when non-preferable types are substrings. While PR06 checks for parameter types which contain non-preferable type names like integer (int), string (str), and boolean (bool), PR06 should not fail if those types are used only as susbtrings in, for example, custom type names. Parameters ---------- a : Myint Some text. b : intClass Some text. c : Mystring Some text. d : stringClass Some text. e : Mybool Some text. f : boolClass Some text. See Also -------- related : Something related. Examples -------- >>> result = 1 + 1 Nr()rNrrcdefs r(parameter_with_wrong_types_as_substringsz7GoodDocStrings.parameter_with_wrong_types_as_substringskrPrN)rQ)re)r$r%r&r'rOrVr\r^r`rbrdrirlfloatrrrvrxrzr~rrrrrrr(rrrKrKsp  ===    :   2   .   2   *2    D    D"&%%,,( ( ( ( T   >   &   2   (   2   4   ,   .     rrKc`eZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdS)BadGenericDocStringsz#Everything here has a bad docstringcd}d}||zS)aSome function. With several mistakes in the docstring. It has a blank like after the signature `def func():`. The text 'Some function' should go in the line after the opening quotes of the docstring, not in the same line. There is a blank line between the docstring and the first line of code `foo = 1`. The closing quotes should be in the next line, not in this one.r,r-r()rNfoors rfunczBadGenericDocStrings.funcsSyrcdS)zo Casts Series type. Verb in third-person of the present simple, should be infinitive. Nr(rNdtypes rastypezBadGenericDocStrings.astyperPrcdS)zP Method to cast Series type. Does not start with verb. Nr(rs rastype1zBadGenericDocStrings.astype1rPrcdS)zC Cast Series type Missing dot at the end. Nr(rs rastype2zBadGenericDocStrings.astype2rPrcdS)z Cast Series type from its current type to the new type defined in the parameter dtype. Summary is too verbose and doesn't fit in a single line. Nr(rs rastype3zBadGenericDocStrings.astype3rPrcdS)z Test linebreaks message GL03. Note 2 blank lines before parameters section. Parameters ---------- foo : str Description of foo parameter. Nr(rNrs rtwo_linebreaks_between_sectionsz4BadGenericDocStrings.two_linebreaks_between_sectionsrPrcdS)z Test linebreaks message GL03. Note extra blank line at end of docstring. Parameters ---------- foo : str Description of foo parameter. Nr(rs rlinebreak_at_end_of_docstringz2BadGenericDocStrings.linebreak_at_end_of_docstringrPrc dS)aT Generate a plot. Render the data in the Series as a matplotlib plot of the specified kind. Note the blank line between the parameters title and the first parameter. Also, note that after the name of the parameter `kind` and before the colon, a space is missing. Also, note that the parameter descriptions do not start with a capital letter, and do not finish with a dot. Finally, the `**kwargs` parameter is missing. Parameters ---------- kind: str kind of matplotlib plot Nr(rNrSrUs rrVzBadGenericDocStrings.plotrPrcdS)z This section has an unknown section title. Unknown Section --------------- This should raise an error in the validation. Nr(rMs runknown_sectionz$BadGenericDocStrings.unknown_sectionrPrcdS)a This docstring has the sections in the wrong order. Parameters ---------- name : str This section is in the right position. Examples -------- >>> print("So far Examples is good, as it goes before Parameters") So far Examples is good, as it goes before Parameters See Also -------- function : This should generate an error, as See Also needs to go before Examples. Nr(rMs rsections_in_wrong_orderz,BadGenericDocStrings.sections_in_wrong_orderrPrcdS)aI This docstring has the deprecation warning in the wrong order. This is the extended summary. The correct order should be summary, deprecation warning, extended summary. .. deprecated:: 1.0 This should generate an error as it needs to go before extended summary. Nr(rMs rdeprecation_in_wrong_orderz/BadGenericDocStrings.deprecation_in_wrong_orderrPrcdSNr(rMs rmethod_wo_docstringsz)BadGenericDocStrings.method_wo_docstringss rcdS)a Ensure reST directives have trailing colons. Parameters ---------- first : str Sentence ending in period, followed by single directive w/o colons. .. versionchanged 0.1.2 second : bool Sentence ending in period, followed by multiple directives w/o colons. .. versionadded 0.1.2 .. deprecated 0.00.0 Nr()rNfirstseconds rdirectives_without_two_colonsz2BadGenericDocStrings.directives_without_two_colonsrPrN)r$r%r&r'rrrrrrrrVrrrrrr(rrrrs--&                       .      (            rrceZdZdZdZdS)WarnGenericFormatzC Those contains things that _may_ be incorrect formatting. cdS)z~ The header line is too short. Parameters ------ a, b : int Foo bar baz. Nr(rNrrs rtoo_short_header_underlinez,WarnGenericFormat.too_short_header_underline7rPrN)r$r%r&r'rr(rrrr2s-     rrc>eZdZdZdZdZdZdZdZdZ dZ d S) BadSummariescdS)zM Returns ------- int Always one. Nr(rMs r no_summaryzBadSummaries.no_summaryCrPrcdS)z{ Summary with heading whitespaces. Returns ------- int Always one. Nr(rMs rheading_whitespacesz BadSummaries.heading_whitespacesKrPrcdS)z@Quotes are on the wrong line. Both opening and closing.Nr(rMs r wrong_linezBadSummaries.wrong_lineUrPrcdS)z< Has the right line but forgets punctuation Nr(rMs rno_punctuationzBadSummaries.no_punctuationZrPrcdS)z/ provides a lowercase summary. Nr(rMs rno_capitalizationzBadSummaries.no_capitalization_rPrcdS)z= Started with a verb that is not infinitive. Nr(rMs r no_infinitivezBadSummaries.no_infinitivedrPrcdS)zG Extends beyond one line which is not correct. Nr(rMs r multi_linezBadSummaries.multi_lineirPrcdS)z Extends beyond one line which is not correct. Extends beyond one line, which in itself is correct but the previous short summary should still be an issue. Nr(rMs rtwo_paragraph_multi_linez%BadSummaries.two_paragraph_multi_lineorPrN) r$r%r&rrrrrrrrr(rrrrBs      %%%                  rrcleZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdS) BadParameterszD Everything here has a problem with its Parameters section. cdS)z| Lacks the type. Parameters ---------- value A parameter without type. Nr(rNvalues rno_typezBadParameters.no_type~rPrcdS)z Has period after type. Parameters ---------- value : str. A parameter type should not finish with period. Nr(rs rtype_with_periodzBadParameters.type_with_periodrPrcdS)zc Lacks the description. Parameters ---------- value : str Nr(rs rno_descriptionzBadParameters.no_descriptionrPrc dS)z Lacks kwargs in Parameters. Parameters ---------- kind : str Foo bar baz. Nr(rs rmissing_paramszBadParameters.missing_paramsrPrcdS)z Has bad spacing in the type line. Parameters ---------- kind: str Needs a space after kind. Nr(rNrSs rbad_colon_spacingzBadParameters.bad_colon_spacingrPrcdS)z Forgets to add a period to the description. Parameters ---------- kind : str Doesn't end with a dot Nr(rs rno_description_periodz#BadParameters.no_description_periodrPrcdS)z Forgets to add a period, and also includes a directive. Parameters ---------- kind : str Doesn't end with a dot .. versionadded:: 0.00.0 Nr(rs r$no_description_period_with_directivez2BadParameters.no_description_period_with_directiverPrcdS)z Forgets to add a period, and also includes multiple directives. Parameters ---------- kind : str Doesn't end with a dot .. versionchanged:: 0.00.0 .. deprecated:: 0.00.0 Nr(rs r%no_description_period_with_directivesz3BadParameters.no_description_period_with_directivesrPrcdS)z Forgets to capitalize the description. Parameters ---------- kind : str this is not capitalized. Nr(rs rparameter_capitalizationz&BadParameters.parameter_capitalizationrPrcdS)z Adds a blank line after the section header. Parameters ---------- kind : str Foo bar baz. Nr(rs r blank_lineszBadParameters.blank_linesrPrcdS)z Uses integer instead of int. Parameters ---------- kind : integer Foo bar baz. Nr(rs rinteger_parameterzBadParameters.integer_parameterrPrcdS)z Uses string instead of str. Parameters ---------- kind : string Foo bar baz. Nr(rs rstring_parameterzBadParameters.string_parameterrPrcdS)z Uses boolean instead of bool. Parameters ---------- kind : boolean Foo bar baz. Nr(rs rboolean_parameterzBadParameters.boolean_parameterrPrcdS)z Uses list of boolean instead of list of bool. Parameters ---------- kind : list of boolean, integer, float or string Foo bar baz. Nr(rs rlist_incorrect_parameter_typez+BadParameters.list_incorrect_parameter_typerPrcdS)z The parameters on the same line have an extra space between them. Parameters ---------- a, b : int Foo bar baz. Nr(rs rbad_parameter_spacingz#BadParameters.bad_parameter_spacingrPrN)r$r%r&r'rrrrrrrrrrrrrrrr(rrrrys                                                  rrc>eZdZdZdZdZdZdZdZdZ dZ d S) BadReturnscdS)z+ Lacks section for Returns Hello world!r(rMs rreturn_not_documentedz BadReturns.return_not_documenteds ~rc#KdVdS)z* Lacks section for Yields rNr(rMs ryield_not_documentedzBadReturns.yield_not_documented!srcdS)zk Returns documented but without type. Returns ------- Some value. rr(rMs rrzBadReturns.no_type' ~rcdS)z` Provides type but no description. Returns ------- str rr(rMs rrzBadReturns.no_description1rrcdS)z Provides type and description but no period. Returns ------- str A nice greeting rr(rMs rrzBadReturns.no_punctuation; ~rcdS)z Provides name but returns only one value. Returns ------- s : str A nice greeting. rr(rMs rnamed_single_returnzBadReturns.named_single_returnFrrcdS)z Forgets capitalization in return values description. Returns ------- foo : str The first returned string. bar : str the second returned string. HellozWorld!r(rMs rrzBadReturns.no_capitalizationQ ! rcdS)z Forgets period in return values description. Returns ------- foo : str The first returned string bar : str The second returned string. rr(rMs rno_period_multizBadReturns.no_period_multi^rrN) r$r%r&rrrrrrrrr(rrrrs         ! ! ! ! ! ! ! !rrc&eZdZdZdZdZdZdS) BadSeeAlsocdS)zs Return the first 5 elements of the Series. See Also -------- Series.tail Nr(rMs rno_desczBadSeeAlso.no_descmrPrcdS)a$ Return the first 5 elements of the Series. See Also -------- Series.tail : Return the last 5 elements of the Series. Series.iloc : Return a slice of the elements in the Series, which can also be used to return the first or last n Nr(rMs rdesc_no_periodzBadSeeAlso.desc_no_periodvrPrcdS)a% Return the first 5 elements of the Series. See Also -------- Series.tail : return the last 5 elements of the Series. Series.iloc : Return a slice of the elements in the Series, which can also be used to return the first or last n. Nr(rMs rdesc_first_letter_lowercasez&BadSeeAlso.desc_first_letter_lowercaserPrcdS)z Have `pandas` prefix in See Also section. See Also -------- pandas.Series.rename : Alter Series index labels or name. DataFrame.head : The first `n` rows of the caller object. Nr(rMs r prefix_pandaszBadSeeAlso.prefix_pandasrPrN)r$r%r&r r rrr(rrr r lsP                rr c eZdZdZdZdZdS) BadExamplescdS)zG Examples -------- >>> 2 + 5 7 Nr(rMs r-missing_whitespace_around_arithmetic_operatorz9BadExamples.missing_whitespace_around_arithmetic_operatorrPrcdS)zV Examples -------- >>> if 2 + 5: ... pass Nr(rMs r%indentation_is_not_a_multiple_of_fourz1BadExamples.indentation_is_not_a_multiple_of_fourrPrcdS)zu Examples -------- >>> import datetime >>> value = datetime.date(2019, 1, 1) Nr(rMs rmissing_whitespace_after_commaz*BadExamples.missing_whitespace_after_commarPrN)r$r%r&rrrr(rrrrsA           rrc jeZdZd>dZdZdZejdgddZ dZ ejdd gd Z ejdgd d Z ejd gddddddddddddddddddd d!d"d#d$d%d&d'd(d)d*d+ej d,d-d.ejj /d0d1ej d2d3d4ejj /d5d6d7d8d9d:d;d<d=ZdS)? TestValidatorNcnd}|rd||g}|rd||g}|S)a[ Build the required import path for tests in this module. Parameters ---------- klass : str Class name of object in module. func : str Function name of object in module. Returns ------- str Import path of specified object in this module znumpydoc.tests.test_validate.)join)rNklassr base_paths r _import_pathzTestValidator._import_pathsK 3  5)U!344I  4)T!233Irct|dd}dd|dD}d|vsJd|vsJdS) NrKrOrr c3&K|] }|dV dSr,Nr(.0errs r z/TestValidator.test_one_liner..s&==S#a&======rerrors=should start in the line immediately after the opening quotes0should be placed in the line after the last text) validate_oner!r)rNcapsysrHr+s rtest_one_linerzTestValidator.test_one_liners   $4;  G G  ==F8,<===== K    BOOOOOOrct|dd}t|tsJ|rJdS)NrKrr+r.r! isinstancelistrNr/r+s rtest_good_classzTestValidator.test_good_classsNd//6F/GGHHR&$'''''rr)rVr\r^r`rbrdrirlrrrvrxrzr~rrrrrrct|d|d}t|tsJ|rJdS)NrKr#r+r3rNr/rr+s rtest_good_functionsz!TestValidator.test_good_functionssW2d//6FT/RRSS  &$'''''rct|dd}t|tsJ|sJdS)Nrr2r+r3r6s rtest_bad_classzTestValidator.test_bad_classsId//6L/MMNNxX&$''''' rrctjt5t|d|}dddn #1swxYwYdt jvsJdS)Nrr#z is too short)rwarns UserWarningr.r!r1msgr9s rtest_bad_generic_functionsz(TestValidator.test_bad_generic_functionss\+ & &  !!!(;$!GGF               &&&&&&s%A  AA)rrrrrrVrct|d|d}t|tsJ|sJdS)Nrr#r+r3r9s rrAz(TestValidator.test_bad_generic_functions sW   $:  F F  &$''''' rzklass,func,msgs)rr)z(Found unknown section "Unknown Section".)rr)zQSections are in the wrong order. Correct order is: Parameters, See Also, Examples)rr)z3Deprecation warning should precede extended summary)rr)z_reST directives ['versionchanged', 'versionadded', 'deprecated'] must be followed by two colons)r r )z8Missing description for See Also "Series.tail" reference)r r )z?Missing period at end of description for See Also "Series.iloc")r r)z0should be capitalized for See Also "Series.tail")rr)zNo summary found)rr)z$Summary contains heading whitespaces)rr)r,r-)rr)z"Summary does not end with a period)rr)z,Summary does not start with a capital letter)rr)z'Summary must start with infinitive verb)rrz#Summary should fit in a single line)rrrC)rr)zParameter "value" has no type)rr)z1Parameter "value" type should not finish with ".")rr)z$Parameter "value" has no description)rr)z&Parameters {'**kwargs'} not documented)rr)zYParameter "kind" requires a space before the colon separating the parameter name and type)rrz3Parameter "kind" description should finish with ".")rrrD)rr)z?Parameter "kind" description should start with a capital letter)rrz;Parameter "kind" type should use "int" instead of "integer")rrz:Parameter "kind" type should use "str" instead of "string")rrz.s0HH(C OO;HHHHHHrr$c3&K|] }|dV dSr&r(r's rr*z4TestValidator.test_bad_docstrings..s&"F"Fc3q6"F"F"F"F"F"Frr+)rcatch_warningsr.r!lenrr)rNr/rrmsgsr1rHr@s rtest_bad_docstringsz!TestValidator.test_bad_docstrings sx $D 1 1 1 MQ!$"3"3%d"3"K"KLLF M M M M M M M M M M M M M M M q66 IHHaHHHHH H H H G GC#(("F"FVH5E"F"F"FFFFFFFF G Gs%AA A )NN)r$r%r&r!r0r7rmark parametrizer:r<rAparamxfailrUr(rrrrs4 P P P  [   010  [ (  ''  ' [        [W  W  W  W ( )W 8 9W B CW L MW X YW b cW l mW | X}W ~ W H IW R USW T UW ` aW j kW t uW ~ W H IW X YW b cW l mW v wW @ AW J KW T UW ^ _W h iW r sW | FL"k'    }W J SKW L QMW N FLy(&+BS T T TOW P SQW R SW \ ]W l mW v wW @ AW J KW \ ]W ZZvGGwZZvGGGrrc|S)zTest decorator.r()xs r decoratorr\s HrczeZdZdZdZedZedZe e e dZ dS)DecoratorClassa Class and methods with decorators. * `DecoratorClass` has two decorators. * `DecoratorClass.test_no_decorator` has no decorator. * `DecoratorClass.test_property` has a `@property` decorator. * `DecoratorClass.test_cached_property` has a `@cached_property` decorator. * `DecoratorClass.test_three_decorators` has three decorators. `Validator.source_file_def_line` should return the `def` or `class` line number, not the line of the first decorator. cdS)zTest method without decorators.Nr(rMs rtest_no_decoratorz DecoratorClass.test_no_decoratorrPrcdSzTest property method.Nr(rMs r test_propertyzDecoratorClass.test_propertyrPrcdSrbr(rMs rtest_cached_propertyz#DecoratorClass.test_cached_property rPrcdS)z"Test method with three decorators.Nr(rMs rtest_three_decoratorsz$DecoratorClass.test_three_decorators$rPrN) r$r%r&r'r`propertyrcrrer\rgr(rrr^r^ s  ...$$X$$$_$11YYY111rr^c eZdZejdddgdZejdddgdZejdd gd ee d d zgd ee j d gdee j j d dzgdee j jd dzgdee jd dzggdZejddgdee j j gdee j jggdZdS)TestValidatorClass invalid_name unknown_modzunknown_mod.MyClasscd|d}tjt|5tjj|ddddS#1swxYwYdS)Nz No module can be imported from ""r)rr ImportErrornumpydocr r _load_obj)rNrkr@s r#test_raises_for_invalid_module_namez6TestValidatorClass.test_raises_for_invalid_module_name,s@@@@ ];c 2 2 2 @ @   ' 1 1, ? ? ? @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @s%AAAzdatetime.BadClassNamezdatetime.bad_method_namec|d}|d|d}}d|d|d}tjt|5tjj|ddddS#1swxYwYdS)Nr'z' has no attribute 'r)splitrrAttributeErrorrpr r rq)rNrkname_componentsobj_nameinvalid_attr_namer@s r&test_raises_for_invalid_attribute_namez9TestValidatorClass.test_raises_for_invalid_attribute_name2s',,S11&5b&9?2;N#D(DD0ADDD ]> 5 5 5 @ @   ' 1 1, ? ? ? @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @s %A<<BB decorated_objdef_linez+numpydoc.tests.test_validate.DecoratorClassrur-z=numpydoc.tests.test_validate.DecoratorClass.test_no_decoratorz9numpydoc.tests.test_validate.DecoratorClass.test_propertyr,z@numpydoc.tests.test_validate.DecoratorClass.test_cached_propertyzAnumpydoc.tests.test_validate.DecoratorClass.test_three_decoratorsctjtjtjj|}|j|ksJdSr)rpr r docscraper rqsource_file_def_line)rNr}r~docs r)test_source_file_def_line_with_decoratorsz~..r2Q6  P~?@@D  L~;@AA"EI  S~BGHHLqP  T~CDDRH1L # 244324 [ [!L n:?@@  S nAFGG    11  111rrjc<d}d}|d}|||d}tt|}|jsJtt|}|jsJtt|}|jsJdS)ztEnsure that the check for a Yields section when an object is a generator (YD01) works with decorated generators.c<tfd}|S)Nc|i|Srr()r[rUrs rwrapperzLtest_is_generator_validation_with_decorator..tinsel..wrapperxs1d%f%% %r)r)rrs` rtinselz;test_is_generator_validation_with_decorator..tinselws3 q & & & &  &rc34KtdEd{VdS)zA simple generator Nranger(rrrz8test_is_generator_validation_with_decorator..foo~s*99rc34KtdEd{VdS)zGenerator wrapped oncerNrr(rrrz8test_is_generator_validation_with_decorator..bars,99rc34KtdEd{VdS)z Generator wrapped multiple timesrNrr(rrbazz8test_is_generator_validation_with_decorator..bazs, 99rN)r r is_generator_function)rrrrvs r+test_is_generator_validation_with_decoratorrss  V    V V V .%%&&A """" .%%&&A """" .%%&&A """"""r).r contextlibr functoolsrrrinspectrrrnumpydoc.testsrpr numpydoc.docscraper numpydoc.validater r.set ERROR_MSGSkeys ALL_CHECKSrVrWrr!r5r#r*r8rXrIrKrrrrrr rrr\r^rjrr(rrrs""""""555555555511111111 ------'''''' S$))++ , ,  z *  F8 & FF+, */?"?@ *x/0   >>  >      333 ////////GGG j! #R( ;a&]K D  ! Y M _  ! vff- . . .MM/.M W... X.111$ Zm<<< _g+>>>