o Ďi/@sXdZddlmZddlmZejZejZejZGdddejZe dkr*e dSdS)z!Tests for fire docstrings module.) docstrings) testutilsc@seZdZddZddZddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZddZddZdd Zd!d"Zd#d$Zd%S)&DocstringsTestcCs(d}t|}tdd}|||dS)NA simple one line docstring.summaryrparse DocstringInfo assertEqualself docstringdocstring_infoexpected_docstring_inforP/home/jeff/fluffinator/venv/lib/python3.10/site-packages/fire/docstrings_test.pytest_one_line_simples  z#DocstringsTest.test_one_line_simplecC(d}t|}tdd}|||dS)Nz( A simple one line docstring. rrrr rrrtest_one_line_simple_whitespace%s  z.DocstringsTest.test_one_line_simple_whitespacecCr)NzA one line docstring that is both a little too verbose and a little too long so it keeps going well beyond a reasonable length for a one-liner. zA one line docstring that is both a little too verbose and a little too long so it keeps going well beyond a reasonable length for a one-liner.rrr rrrtest_one_line_too_long/s  z%DocstringsTest.test_one_line_too_longcCr)NztA one line docstring that is both a little too verbose and a little too long so it runs onto a second line. kA one line docstring that is both a little too verbose and a little too long so it runs onto a second line.rrr rrrtest_one_line_runs_over<s  z&DocstringsTest.test_one_line_runs_overcCr)Nz} A one line docstring that is both a little too verbose and a little too long so it runs onto a second line. rrrr rrr"test_one_line_runs_over_whitespaceIs  z1DocstringsTest.test_one_line_runs_over_whitespacecCs>d}t|}tdtdddtdddgd}|||dS) Nz_One line description. Args: arg1: arg1_description arg2: arg2_description zOne line description.arg1arg1_descriptionname descriptionarg2arg2_descriptionrargsrr r ArgInfor r rrrtest_google_format_args_onlyUs   z+DocstringsTest.test_google_format_args_onlycCs2d}t|}ttdddgd}|||dS)Nz+ Args: args: arg_description r"arg_descriptionr)r"r#r rrr!test_google_format_arg_named_argsfs  z0DocstringsTest.test_google_format_arg_named_argsc CFd}t|}tddtddddtdd d dgd d }|||dS) Na*Docstring summary. This is a longer description of the docstring. It spans multiple lines, as is allowed. Args: param1 (int): The first parameter. param2 (str): The second parameter. Returns: bool: The return value. True for success, False otherwise. Docstring summary.VThis is a longer description of the docstring. It spans multiple lines, as is allowed.param1intThe first parameter.rtyperparam2strThe second parameter.z:bool: The return value. True for success, False otherwise.rrr"returnsr#r rrr)test_google_format_typed_args_and_returnsss  z8DocstringsTest.test_google_format_typed_args_and_returnsc CDd}t|}tddtddddtdd d dgd }|||dS) NaDocstring summary. This is a longer description of the docstring. It spans multiple lines, as is allowed. Args: param1 (int): The first parameter. param2 (str): The second parameter. This has a lot of text, enough to cover two lines. r)r*r+r,r-r.r0r1HThe second parameter. This has a lot of text, enough to cover two lines.rrr"r#r rrr,test_google_format_multiline_arg_descriptions  z;DocstringsTest.test_google_format_multiline_arg_descriptionc CsHd}t|}tddtddddtdd d dgd d d }|||dS)NaDDocstring summary. This is a longer description of the docstring. It spans across multiple lines. :param arg1: Description of arg1. :type arg1: str. :param arg2: Description of arg2. :type arg2: bool. :returns: int -- description of the return value. :raises: AttributeError, KeyError r)NThis is a longer description of the docstring. It spans across multiple lines.rr1Description of arg1.r.rboolDescription of arg2.z'int -- description of the return value.zAttributeError, KeyError)rrr"r4raisesr#r rrr&test_rst_format_typed_args_and_returnss   z5DocstringsTest.test_rst_format_typed_args_and_returnsc Cr() Na:Docstring summary. This is a longer description of the docstring. It spans across multiple lines. Parameters ---------- param1 : int The first parameter. param2 : str The second parameter. Returns ------- bool True if successful, False otherwise. r)r:r+r,r-r.r0r1r2z)bool True if successful, False otherwise.r3r#r rrr(test_numpy_format_typed_args_and_returnss  z7DocstringsTest.test_numpy_format_typed_args_and_returnsc Cr6) Na&Docstring summary. This is a longer description of the docstring. It spans across multiple lines. Parameters ---------- param1 : int The first parameter. param2 : str The second parameter. This has a lot of text, enough to cover two lines. r)r:r+r,r-r.r0r1r7r8r#r rrr+test_numpy_format_multiline_arg_descriptions  z:DocstringsTest.test_numpy_format_multiline_arg_descriptioncCs*d}t|}tddd}|||dS)NzDocstring summary. This is the first section of a docstring description. This is the second section of a docstring description. This docstring description has just two sections. r)zThis is the first section of a docstring description. This is the second section of a docstring description. This docstring description has just two sections.)rrrr rrrtest_multisection_docstrings z*DocstringsTest.test_multisection_docstringcCs d}t|}|d|jdS)NztInspired by requests HTTPAdapter docstring. :param x: Simple param. Usage: >>> import requests z+Inspired by requests HTTPAdapter docstring.)rr r r)r rrrrr)test_google_section_with_blank_first_lines  z8DocstringsTest.test_google_section_with_blank_first_linecCsd}t|dS)NzDocstring summary. args: raises :: : pathological docstrings should not fail, and ideally should behave reasonably. )rr )r rrrrtest_ill_formed_docstring%sz(DocstringsTest.test_ill_formed_docstringcCs$gd}dg}||t|dS)N)  foo rErF)r r_strip_blank_lines)r linesexpected_outputrrrtest_strip_blank_lines/sz%DocstringsTest.test_strip_blank_linesc CsPd}t|}tddtddddtddd dtd d ddgd }|||dS) Nz Greets name. Arguments --------- name : str name, default : World arg2 : int arg2, default:None arg3 : bool z Greets name.rr1zname, default : Worldr.rr,zarg2, default:Nonearg3r<r8r#r rrrtest_numpy_colon_in_description5s   z.DocstringsTest.test_numpy_colon_in_descriptionc CsNd}t|}tdtddddtddd dtd dd dgd }|||dS) NzDocstring summary. :param arg1: Description of arg1. :type arg1: str. :key arg2: Description of arg2. :type arg2: bool. :key arg3: Description of arg3. :type arg3: str. r)rr1r;r.rr<r=rKzDescription of arg3.r!)rr r r$ KwargInfor r rrr%test_rst_format_typed_args_and_kwargsOs   z4DocstringsTest.test_rst_format_typed_args_and_kwargsN)__name__ __module__ __qualname__rrrrrr%r'r5r9r?r@rArBrCrDrJrLrNrrrrrs&     "   r__main__N) __doc__firerrr r$rM BaseTestCaserrOmainrrrrs  O