o +id;d?gfd@d=dAgfdBd=dAgfgdCejejej e e fddfdDdEZejdFgdGde dHej e dIej e ddfdJdKZejdgdLde de ddfdMdNZdS)Pz,Tests for numpydoc-style docstring routines.Ncomposeparsezsource, expected))N) NShort descriptionrz Short description rz Short description rsourceexpectedreturncCs2t|}|j|ks J|jdusJ|jrJdS)zTest parsing short description.N)rshort_descriptionlong_descriptionmeta)r r docstringra/var/www/html/psymed-ai/venv/lib/python3.10/site-packages/docstring_parser/tests/test_numpydoc.pytest_short_description s rz?source, expected_short_desc, expected_long_desc, expected_blank))#Short description Long descriptionrLong descriptionT)I Short description Long description rrT)a Short description Long description Second line rLong description Second lineT)"Short description Long descriptionrrF)H Short description Long description rrF)$ Short description Long description rrF)` Short description Long description Second line rrFexpected_short_descexpected_long_descexpected_blankcCs@t|}|j|ks J|j|ksJ|j|ksJ|jrJdS)zTest parsing long description.N)rrrblank_after_short_descriptionr)r rrr rrrrtest_long_descriptions Fr"zdsource, expected_short_desc, expected_long_desc, expected_blank_short_desc, expected_blank_long_desc))zi Short description Parameters ---------- asd rNFF)z Short description Long description Parameters ---------- asd rrFF)z Short description First line Second line Parameters ---------- asd rFirst line Second lineFF)z Short description First line Second line Parameters ---------- asd rr#TF)z Short description First line Second line Parameters ---------- asd rr#TT)zK Parameters ---------- asd NNFFexpected_blank_short_descexpected_blank_long_desccCsVt|}|j|ks J|j|ksJ|j|ksJ|j|ks Jt|jdks)JdS)z2Test parsing newlines around description sections.N)rrrr!blank_after_long_descriptionlenr)r rrr$r%rrrrtest_meta_newlineshs _r)cCsltd}|jdks Jt|jdksJ|jdjddgks J|jdjdks*J|jdjdks4JdS) z*Test parsing multiline meta documentation.z Short description Parameters ---------- spam asd 1 2 3 rr&rparamspam asd 1 2 3N)rrr(rargsarg_name descriptionrrrr$test_meta_with_multiline_descriptions r1zBsource, expected_is_optional, expected_type_name, expected_default))z Parameters ---------- arg1 : int The first arg FintN)z Parameters ---------- arg2 : str The second arg FstrN)z Parameters ---------- arg3 : float, optional The third arg. Default is 1.0. Tfloatz1.0)z Parameters ---------- arg4 : Optional[Dict[str, Any]], optional The fourth arg. Defaults to None TzOptional[Dict[str, Any]]None)z Parameters ---------- arg5 : str, optional The fifth arg. Default: DEFAULT_ARGS Tr3 DEFAULT_ARGS)z Parameters ---------- parameter_without_default : int The parameter_without_default is required. Fr2Nexpected_is_optionalexpected_type_nameexpected_defaultcCs^t|}|dus Jt|jdksJ|jd}|j|ksJ|j|ks&J|j|ks-JdS)zTest parsing default arguments.Nr&r)rr(params is_optional type_namedefault)r r7r8r9rarg1rrrtest_default_argssN  r?cCstd}|jdks Jt|jdksJ|jdjddgks J|jdjdks*J|jdjdks4J|jdjd d gks@J|jdjd ksJJ|jdjd ksTJ|jd jd d gks`J|jd jd ksjJ|jd jdkstJdS)zTest parsing multiple meta.z Short description Parameters ---------- spam asd 1 2 3 Raises ------ bla herp yay derp rrr*r+r,r&raisesblaherpyayderpN)rrr(rr-r.r/r<r0rrrtest_multiple_meta=srGcCtd}t|jdks Jtd}t|jdksJ|jdjdks$J|jdjdus.J|jdjdks8J|jdjr@J|jdjd ksJJ|jdjd ksTJ|jdjd ks^J|jdjrfJ|jd jd kspJ|jd jdkszJ|jd jdksJ|jd jsJ|jdjdksJ|jdjdksJ|jdjdksJ|jdjsJtd}t|jd ksJ|jdjdksJ|jdjdusJ|jdjdksJ|jdjd ksJ|jdjd ksJ|jdjd ksJdS)zTest parsing params.rra Short description Parameters ---------- name description 1 priority : int description 2 sender : str, optional description 3 ratio : Optional[float], optional description 4 nameN description 1r&priorityr2 description 2rDsenderr3 description 3r@ratioOptional[float] description 4z Short description Parameters ---------- name description 1 with multi-line text priority : int description 2 "description 1 with multi-line textrr(r:r.r<r/r;r0rrr test_params`D  rUcCrH)zTest parsing attributes.rra Short description Attributes ---------- name description 1 priority : int description 2 sender : str, optional description 3 ratio : Optional[float], optional description 4 rIrJNrKr&rLr2rMrDrNr3rOr@rPrQrRz Short description Attributes ---------- name description 1 with multi-line text priority : int description 2 rSrTr0rrrtest_attributesrVrWcCstd}t|jdks J|jdjddgksJ|jdjdks#J|jdjdks-J|jdjs5J|jdjdks?J|jdjdd gksKJd S) zTest parsing other parameters.z Short description Other Parameters ---------------- only_seldom_used_keywords : type, optional Explanation common_parameters_listed_above : type, optional Explanation rDr other_paramonly_seldom_used_keywordstype Explanationr&common_parameters_listed_aboveN)rr(rr-r.r<r;r/r0rrrtest_other_paramss    r]cCstd}t|jdks J|jdjdgksJ|jdjdks"J|jdjdks,J|jdjdus6J|jdjs>JdS)zTest parsing yields.ze Short description Yields ------ int description r&ryieldsr2r/N)rr(rr-r<r/ return_name is_generatorr0rrr test_yieldss racCstd}|jdus J|jdusJt|jdksJtd}|jdus&J|jjdks.J|jjdus6J|jdus=Jt|jdksFJ|jd|jksPJtd}|jdus[J|jjdkscJ|jjd kskJ|jdusrJt|jdks{J|jd|jksJtd }|jdusJ|jjd ksJ|jjd ksJ|jdusJt|jdksJ|jd|jksJtd }|jdusJ|jjdksJ|jjdksJ|jdusJt|jdksJ|jd|jksJtd}|jdusJ|jjdksJ|jjdks J|jdusJt|jdksJ|jdjdks)J|jdjdks4J|jdjdks?J|jdjdksJJ|jdjdksUJ|jdjdks`JdS)zTest parsing returns.# Short description NrzP Short description Returns ------- type rZr&zg Short description Returns ------- int description r2r/z{ Returns ------- Optional[Mapping[str, List[int]]] A description: with a colon z!Optional[Mapping[str, List[int]]]zA description: with a colonz Short description Returns ------- int description with much text even some spacing z-description with much text even some spacingz Short description Returns ------- a : int description for a b : str description for b zdescription for arDar3zdescription for bb)rreturns many_returnsr(r<r/r_r0rrr test_returnsst   rgcCs`td}t|jdks Jtd}t|jdksJ|jdjdks$J|jdjdks.JdS)zTest parsing raises.rbrzl Short description Raises ------ ValueError description r& ValueErrorr/N)rr(rAr<r/r0rrr test_raisests ricCsFtd}t|jdks J|jdjdksJ|jdjdks!JdS)zTest parsing warns.zk Short description Warns ----- UserWarning description r&r UserWarningr/N)rr(rr<r/r0rrr test_warnss  rkcCstd}t|jdks J|jdjdgksJ|jdjdks"J|jdjdgks-J|jdjdks7J|jd jd gksBJ|jd jd ksLJ|jd jd gksWJdS)zTest parsing simple sections.a Short description See Also -------- something : some thing you can also see actually, anything can go in this section Warnings -------- Here be dragons Notes ----- None of this is real References ---------- Cite the relevant literature, e.g. [1]_. You may also cite these references in the notes section above. .. [1] O. McNoleg, "The integration of GIS, remote sensing, expert systems and adaptive co-kriging for environmental habitat modelling of the Highland Haggis using object-oriented, fuzzy-logic and neural-network techniques," Computers & Geosciences, vol. 22, pp. 585-588, 1996. rIrsee_alsozQsomething : some thing you can also see actually, anything can go in this sectionr&warningszHere be dragonsrDnoteszNone of this is realr@ referencesN)rr(rr-r/r0rrrtest_simple_sectionss rpzsource, expected_resultsz5Description Examples -------- long example more here)Nzlong example more herez&Description Examples -------- >>> test)z>>> testrz1Description Examples -------- >>> testa >>> testb)z>>> testa >>> testbrz-Description Examples -------- >>> test1 desc1)z >>> test1desc1zADescription Examples -------- >>> test1a >>> test1b desc1a desc1b)z>>> test1a >>> test1bz desc1a desc1bz=Description Examples -------- >>> test1 desc1 >>> test2 desc2)z >>> test2desc2zfDescription Examples -------- >>> test1a >>> test1b desc1a desc1b >>> test2a >>> test2b desc2a desc2b )z>>> test2a >>> test2bz desc2a desc2bzDescription Examples -------- >>> test1a >>> test1b desc1a desc1b >>> test2a >>> test2b desc2a desc2b expected_resultscCst|}t|jt|ksJt|j|D] \}}|j|dks"Jqt|jt|ks.Jt|j|D]\}}|j|dksAJ|j|dksJJq4dS)zTest parsing examples.r&rN)rr(rzipr/examplessnippet)r rsrrexpected_resultexamplerrr test_examplessBryz1source, expected_depr_version, expected_depr_desc))zShort description Parameters: ----------- name description 1 priority: int description 2 sender: str, optional description 3 message: str, optional description 4, defaults to 'hello' multiline: str, optional long description 5, defaults to 'bye')z Short description Raises: ------- ValueError description zDShort description Raises: ------- ValueError description)z Description Examples: -------- >>> test1a >>> test1b desc1a desc1b >>> test2a >>> test2b desc2a desc2b zfDescription Examples: -------- >>> test1a >>> test1b desc1a desc1b >>> test2a >>> test2b desc2a desc2bcCstt||ks JdS)zTest compose in default mode.Nr)r r rrr test_compose=sr)r N)__doc__typingTpytestdocstring_parser.numpydocrrmark parametrizer3rboolr"Optionalr)r1r?rGrUrWr]rargrirkrpListTupleryrrrrrrs ? W G  # ? ?   f  /  >