o +ij @sdZddlZddlZddlmZmZddlmZm Z m Z m Z m Z dBddZ dBdd ZdBd d ZdBd d ZejdgddededdfddZejdgddededededdf ddZejdgddedejedejedededdf dd ZdBd!d"ZdBd#d$ZdBd%d&ZdBd'd(ZdBd)d*ZdBd+d,ZdBd-d.ZdBd/d0Z dBd1d2Z!dBd3d4Z"dBd5d6Z#dBd7d8Z$ejdgd9dededdfd:d;Z%ejddZ&ejdd?gdededdfd@dAZ'dS)Cz*Tests for Google-style docstring routines.N) ParseErrorRenderingStyle) GoogleParserSection SectionTypecomposeparsereturncCsBt}|d}|jdksJ|jdksJt|jdksJdS)zQTest parsing an unknown section with default GoogleParser configuration. z. Unknown: spam: a zUnknown:zspam: arN)rrshort_descriptionlong_descriptionlenmetaparser docstringr_/var/www/html/psymed-ai/venv/lib/python3.10/site-packages/docstring_parser/tests/test_google.py"test_google_parser_unknown_sectionsrcCs(t}|d}|jdjdksJdS)zBTest parsing a multi-line parameter type with default GoogleParseraDescription of the function. Args: output_type (Literal["searchResults", "sourcedAnswer", "structured"]): The type of output. This can be one of the following: - "searchResults": Represents the search results. - "sourcedAnswer": Represents a sourced answer. - "structured": Represents a structured output format. Returns: bool: Indicates success or failure. r output_typeN)rrparamsarg_namerrrr,test_google_parser_multi_line_parameter_type s rcCs|ttddtjtddtjtddtjtddtjgd d }|d }|jd us*J|jd us1Jt|j d ks:J|j dj dgksEJ|j dj dksOJ|j dj ddgks[J|j dj dkseJ|j dj ddgksqJ|j dj dks{J|j dj ddgksJ|j dj dksJ|j dj ddgksJ|j dj dksJ|j dj dgksJ|j dj dksJd S)zPTest parsing an unknown section with custom GoogleParser configuration. DESCRIPTIONdesc ARGUMENTSparam ATTRIBUTES attributeEXAMPLESexamplesF title_colona/ DESCRIPTION This is the description. ARGUMENTS arg1: first arg arg2: second arg ATTRIBUTES attr1: first attribute attr2: second attribute EXAMPLES Many examples More examples NrzThis is the description.arg1z first argarg2z second argattr1zfirst attributeattr2zsecond attributezMany examples More examples) rrrSINGULARMULTIPLErr r r r args descriptionrrrr"test_google_parser_custom_sections6s4     r0cCstdd}|tddtj|d}|jdksJ|jdks"J|d}|jdks.J|jd ks5J|d }t|j d ksCJ|j d j dgksNJ|j d j d ksXJdS)zjTest parsing an unknown section with custom GoogleParser configuration that was set at a runtime. Fr NotenotezE short description Note: a note zshort descriptionzNote: a notez8 short description Note a note z Note a notezD short description Note a note r#rza noteN) r add_sectionrrr,rr r r r r.r/rrrr(test_google_parser_custom_sections_aftergs$ r4zsource, expected))N) NShort descriptionr8z Short description r8z Short description r8sourceexpectedcCs2t|}|j|ks J|jdusJ|jrJdS)zTest parsing short description.N)rr r r )r;r<rrrrtest_short_descriptions r=z?source, expected_short_desc, expected_long_desc, expected_blank))#Short description Long descriptionr8Long descriptionT)I Short description Long description r8r?T)a Short description Long description Second line r8Long description Second lineT)"Short description Long descriptionr8r?F)H Short description Long description r8r?F)$ Short description Long description r8r?F)` Short description Long description Second line r8rBFexpected_short_descexpected_long_descexpected_blankcCs@t|}|j|ks J|j|ksJ|j|ksJ|jrJdS)zTest parsing long description.N)rr r blank_after_short_descriptionr )r;rGrHrIrrrrtest_long_descriptions FrKzdsource, expected_short_desc, expected_long_desc, expected_blank_short_desc, expected_blank_long_desc))zR Short description Args: asd: r8NFF)zo Short description Long description Args: asd: r8r?FF)z Short description First line Second line Args: asd: r8First line Second lineFF)z Short description First line Second line Args: asd: r8rLTF)z Short description First line Second line Args: asd: r8rLTT)z4 Args: 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.r#N)rr r rJblank_after_long_descriptionr r )r;rGrHrMrNrrrrtest_meta_newliness YrPcCsltd}|jdks Jt|jdksJ|jdjddgks J|jdjdks*J|jdjdks4JdS) z*Test parsing multiline meta documentation.z Short description Args: spam: asd 1 2 3 r8r#rrspam asd 1 2 3N)rr r r r.rr/rrrr$test_meta_with_multiline_descriptionOs rTcCsvtd}|dus Jt|jdksJ|jd}|jdksJ|js$J|jdks+J|jdks2J|jdks9JdS) zTest parsing default arguments.aA sample function A function the demonstrates docstrings Args: arg1 (int): The firsty arg arg2 (str): The second arg arg3 (float, optional): The third arg. Defaults to 1.0. arg4 (Optional[Dict[str, Any]], optional): The last arg. Defaults to None. arg5 (str, optional): The fifth arg. Defaults to DEFAULT_ARG5. Returns: Mapping[str, Any]: The args packed in a mapping Nr+r'arg4zOptional[Dict[str, Any]]NonezThe last arg. Defaults to None.)rr rr is_optional type_namedefaultr/)rrUrrrtest_default_argscs   rZcCstd}|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 Args: spam: asd 1 2 3 Raises: bla: herp yay: derp r8r'rrrQrRr#raisesblaherpr%yayderpN)rr r r r.rr/rXrSrrrtest_multiple_metasr`cCtd}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.r8rz Short description Args: name: description 1 priority (int): description 2 sender (str?): description 3 ratio (Optional[float], optional): description 4 r)nameN description 1r#priorityint description 2r%senderstr description 3r'ratioOptional[float] description 4z Short description Args: name: description 1 with multi-line text priority (int): description 2 "description 1 with multi-line textrr rrrXr/rWrSrrr test_paramsD   rocCra)zTest parsing attributes.r8rz Short description Attributes: name: description 1 priority (int): description 2 sender (str?): description 3 ratio (Optional[float], optional): description 4 r)rbNrcr#rdrerfr%rgrhrir'rjrkrlz Short description Attributes: name: description 1 with multi-line text priority (int): description 2 rmrnrSrrrtest_attributesrprqcCstd}|jdus J|jdusJt|jdksJtd}|jdus&J|jjdus.J|jjdks6J|jdus=Jt|jdksFJ|jd|jksPJtd}|jdus[J|jjduscJ|jjdkskJ|jdusrJt|jdks{J|jd|jksJtd }|jdusJ|jjd ksJ|jjdksJ|jdusJt|jdksJ|jd|jksJtd }|jdusJ|jjd ksJ|jjd ksJ|jdusJt|jdksJ|jd|jksJtd}|jdusJ|jjd ksJ|jjdks J|jdusJt|jdksJ|jd|jks)Jtd}|jdus5J|jjd ks>J|jjdksGJ|jdusOJt|jdksYJ|jd|jksdJdS)zTest parsing returns.# Short description NrzL Short description Returns: description r/r#z[ Short description Returns: description with: a colon! zdescription with: a colon!zQ Short description Returns: int: description reze Returns: Optional[Mapping[str, List[int]]]: A description: with a colon z!Optional[Mapping[str, List[int]]]zA description: with a colonzP Short description Yields: int: description z Short description Returns: int: description with much text even some spacing z-description with much text even some spacing)rreturns many_returnsr rXr/rSrrr test_returns s|  rucCs`td}t|jdks Jtd}t|jdksJ|jdjdks$J|jdjdks.JdS)zTest parsing raises.rrrzW Short description Raises: ValueError: description r# ValueErrorr/N)rr r[rXr/rSrrr test_raisespsrwcCsFtd}t|jdks J|jdjdksJ|jdjdks!JdS)zTest parsing examples.z Short description Example: example: 1 Examples: long example more here r%rz example: 1r#zlong example more hereN)rr rr/rSrrr test_exampless  rxcCsjtt tdWdn1swYtt tdWddS1s.wYdS)zTest parsing broken meta.zArgs:NzArgs: herp derppytestr[rrrrrrtest_broken_metas    "r{cCs\td}|jdjdksJ|jdjdksJ|jdjdks"J|jdjdks,JdS) zTest parsing unknown meta.zShort desc Unknown 0: title0: content0 Args: arg0: desc0 arg1: desc1 Unknown1: title1: content1 Unknown2: title2: content2 rarg0desc0r#r$desc1N)rrrr/rSrrrtest_unknown_metasrcCs8tt tdWddS1swYdS)zTest parsing broken arguments.zWThis is a test Args: param - poorly formatted Nryrrrrtest_broken_argumentss "rcCsHtd}t|jdks J|jdjdgksJ|jdjdks"JdS)z$Test parsing empty examples section.z]Short description Example: Raises: IOError: some error r#rrr5N)rr rr.r/rSrrrtest_empty_examples  r))r5r5)r6r5r7r9r:)r>r>)r@r>)rAz/Short description Long description Second line)rCrC)rDrC)rErC)rFz.Short description Long description Second line)zQ Short description Meta: asd zShort description Meta: asd)zn Short description Long description Meta: asd z0Short description Long description Meta: asd)z Short description First line Second line Meta: asd z:Short description First line Second line Meta: asd)z Short description First line Second line Meta: asd z;Short description First line Second line Meta: asd)z Short description First line Second line Meta: asd zs   1( ? Q     7 7 d    C!