def test_arguments_with_multiple_lines(self):
"""Make sure multiple lines are okay in items."""
docstring = '\n'.join([
'This is an example of a module level function.',
'',
'The format for a parameter is::',
'',
' name (type): description',
' The description may span multiple lines. Following',
' lines should be indented. The "(type)" is optional.',
'',
' Multiple paragraphs are supported in parameter',
' descriptions.',
'',
'Args:',
' param1 (int): The first parameter.',
' param2 (:obj:`str`, optional): The second parameter. Defaults to None.', # noqa: E501
' Second line of description should be indented.',
' *args: Variable length argument list.',
' **kwargs: Arbitrary keyword arguments.',
'',
'Returns:',
' bool: True if successful, False otherwise.',
])
doc = Docstring(docstring)
args = doc.get_items(Sections.ARGUMENTS_SECTION)
for arg in 'param1', 'param2', '*args', '**kwargs':
self.assertTrue(arg in args)
def test_single_word_sections_parse_correctly(self):
"""Make sure we can have a minimal amount of words in each section."""
contents = '\n'.join([
'def f(foo):',
' """foobar',
'',
' Args:',
' foo: foobar',
'',
' Returns:',
' bar',
'',
' """',
' return "bar"',
])
function = ast.parse(contents).body[0]
docstring = ast.get_docstring(function)
doc = Docstring(docstring)
self.assertEqual(
doc.get_section(Sections.SHORT_DESCRIPTION),
'foobar',
)
self.assertEqual(
doc.get_section(Sections.RETURNS_SECTION),
'Returns:\n bar',
)
self.assertEqual(
doc.get_items(Sections.ARGUMENTS_SECTION),
['foo'],
)
def test_star_arguments_parsed(self):
docstring = '\n'.join([
'Negate a function which returns a boolean.',
'',
'Args:',
' *fns (int): Functions which returns a boolean.',
'',
'Returns:',
' int: A function which returns fallse when any of the'
' callables return true, and true will all of the ',
' callables return false.',
])
doc = Docstring(docstring)
self.assertTrue('*fns' in doc.get_items(Sections.ARGUMENTS_SECTION))
def test_argument_types_can_be_parsed(self):
docstring = '\n'.join([
'This docstring contains types for its arguments.',
'',
'Args:',
' x (int): The first number.',
' y (float): The second number.',
])
doc = Docstring(docstring)
arg_types = {
name: _type
for name, _type in zip(
doc.get_items(Sections.ARGUMENTS_SECTION),
doc.get_types(Sections.ARGUMENTS_SECTION),
)
}
self.assertEqual(arg_types['x'], 'int')
self.assertEqual(arg_types['y'], 'float')
def test_parse_noqa_for_argument(self):
"""Make sure we can get the noqas."""
func = '\n'.join([
'def my_function():',
' """Has an extra argument, but thats okay.',
'',
' Args:',
' arg1: This will be defined very soon. # noqa: I102',
'',
' """',
' print("Not done yet!")',
])
doc = ast.get_docstring(ast.parse(func).body[0])
self.assertTrue(doc.startswith('Has an extra'))
docstring = Docstring(doc)
self.assertTrue(
'arg1' in docstring.get_items(Sections.ARGUMENTS_SECTION))
noqas = docstring.get_noqas()
self.assertTrue('arg1' in noqas['I102'])
def test_arguments_are_last(self):
"""Make sure arguments can be parsed as the last section."""
docstring = '\n'.join([
'Example of docstring on the __init__ method.',
'',
'The __init__ method may be documented in either the class level',
'docstring, or as a docstring on the __init__ method itself.',
'',
'Either form is acceptable, but the two should not be mixed. Choose one', # noqa: E501
'convention to document the __init__ method and be consistent with it.', # noqa: E501
'',
'Note:',
' Do not include the `self` parameter in the ``Args`` section.',
'',
'Args:',
' param1 (str): Description of `param1`.',
' param2 (:obj:`int`, optional): Description of `param2`. Multiple', # noqa: E501
' lines are supported.',
' param3 (list(str)): Description of `param3`.',
])
doc = Docstring(docstring)
args = doc.get_items(Sections.ARGUMENTS_SECTION)
for arg in ['param1', 'param2', 'param3']:
arg in args
def test_arguments_extracted_when_extant(self):
"""Make sure the arguments can be parsed."""
docstring = '\n'.join([
'Example function with types documented in the docstring.',
'',
'`PEP 484`_ type annotations are supported. If attribute, parameter, and', # noqa: E501
'return types are annotated according to `PEP 484`_, they do not need to be', # noqa: E501
'included in the docstring:',
'',
'Args:',
' param1 (int): The first parameter.',
' param2 (str): The second parameter.',
'',
'Returns:',
' bool: The return value. True for success, False otherwise.',
'',
'.. _PEP 484:',
' https://www.python.org/dev/peps/pep-0484/',
])
doc = Docstring(docstring)
args = doc.get_items(Sections.ARGUMENTS_SECTION)
self.assertTrue('param1' in args)
self.assertTrue('param2' in args)