U +c^0@sxdZddlmZddlmZddlmZddlmZddlmZejZej Z ej Z Gdddej Z e d krted S) z!Tests for fire docstrings module.)absolute_import)division)print_function) 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_infoZexpected_docstring_infor8/tmp/pip-unpacked-wheel-1xt1w7un/fire/docstrings_test.pytest_one_line_simple!s  z#DocstringsTest.test_one_line_simplecCs(d}t|}tdd}|||dS)Nz( A simple one line docstring. rr r rrrrtest_one_line_simple_whitespace)s  z.DocstringsTest.test_one_line_simple_whitespacecCs(d}t|}tdd}|||dS)NzA one line docstring thats 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 thats both a little too verbose and a little too long so it keeps going well beyond a reasonable length for a one-liner.r r rrrrtest_one_line_too_long3s  z%DocstringsTest.test_one_line_too_longcCs(d}t|}tdd}|||dS)NzrA one line docstring thats both a little too verbose and a little too long so it runs onto a second line. iA one line docstring thats both a little too verbose and a little too long so it runs onto a second line.r r rrrrtest_one_line_runs_over@s  z&DocstringsTest.test_one_line_runs_overcCs(d}t|}tdd}|||dS)Nz{ A one line docstring thats both a little too verbose and a little too long so it runs onto a second line. rr r rrrr"test_one_line_runs_over_whitespaceMs  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.arg1Zarg1_descriptionname descriptionarg2Zarg2_descriptionr argsrr r ArgInforrrrrtest_google_format_args_onlyYs   z+DocstringsTest.test_google_format_args_onlycCs2d}t|}ttdddgd}|||dS)Nz+ Args: args: arg_description r!Zarg_descriptionr)r!r"rrrr!test_google_format_arg_named_argsjs  z0DocstringsTest.test_google_format_arg_named_argsc CsFd}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.r rr!returnsr"rrrr)test_google_format_typed_args_and_returnsws  z8DocstringsTest.test_google_format_typed_args_and_returnsc CsDd}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+r-r.HThe second parameter. This has a lot of text, enough to cover two lines.r rr!r"rrrr,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.rr.Description of arg1.r+rboolDescription of arg2.z'int -- description of the return value.zAttributeError, KeyError)r rr!r1Zraisesr"rrrr&test_rst_format_typed_args_and_returnss   z5DocstringsTest.test_rst_format_typed_args_and_returnsc CsFd}t|}tddtddddtdd d dgd d }|||dS) 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&r6r(r)r*r+r-r.r/z)bool True if successful, False otherwise.r0r"rrrr(test_numpy_format_typed_args_and_returnss  z7DocstringsTest.test_numpy_format_typed_args_and_returnsc CsDd}t|}tddtddddtdd d dgd }|||dS) 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&r6r(r)r*r+r-r.r3r4r"rrrr+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.)r rr rrrrtest_multisection_docstring s 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 rr )rrrrrr)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 )rrrrrtest_ill_formed_docstring)sz(DocstringsTest.test_ill_formed_docstringcCs&dddg}dg}||t|dS)Nz z foo )rrZ_strip_blank_lines)rlinesZexpected_outputrrrtest_strip_blank_lines3s z%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.rr.zname, default : Worldr+rr)zarg2, default:Nonearg3r8r4r"rrrrtest_numpy_colon_in_description9s   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&rr.r7r+rr8r9rBzDescription of arg3.r )rr r r# KwargInforrrrr%test_rst_format_typed_args_and_kwargsSs   z4DocstringsTest.test_rst_format_typed_args_and_kwargsN)__name__ __module__ __qualname__rrrrrr$r%r2r5r:r;r<r=r>r?rArCrErrrrrs$     "  r__main__N)__doc__ __future__rrrZfirerrr r#rDZ BaseTestCaserrFmainrrrrs     O