def test_parse_doc_string_warning():
text = """
Danger!
~~~~~~~
This is a dangerous function.
.. warning::
This is a warning
It has multiple lines
It has a multi-line description.
:param int id: An id.
"""
result = apidocs.parse_doc_string(text)
assert result[0] == "Danger!"
expected = ["", "This is a dangerous function.", "", "It has a multi-line description.", ""]
assert result[1] == expected
expected = "This is a warning\n\nIt has multiple lines"
assert result[2] == expected
params = result[3]
assert "param" in params, "Should have regular param"
assert params["param"][0] == dict(name="id", type="int", description="An id.")
def test_parse_doc_string():
text = """
Glory!
~~~~~~
This is a glorious function.
It has a multi-line description.
:param int id: An ``id``.
:qparam bool louder: Make it **louder**?
:pparam string orgid: The *orgid*.
On a second line.
:auth: required
"""
result = apidocs.parse_doc_string(text)
assert result[0] == "Glory!"
expected = ["", "This is a glorious function.", "", "It has a multi-line description.", ""]
assert result[1] == expected
assert result[2] is None, "no warning present"
params = result[3]
assert "path" in params, "Should have path params"
assert params["path"][0] == dict(
name="orgid", type="string", description="The *orgid*. On a second line."
)
assert "query" in params, "Should have query params"
assert params["query"][0] == dict(name="louder", type="bool", description="Make it **louder**?")
assert "auth" in params, "Should have auth"
assert params["auth"][0] == dict(name="", type="", description="required")
assert "param" in params, "Should have regular param"
assert params["param"][0] == dict(name="id", type="int", description="An `id`.")
def test_parse_doc_string_warning():
text = """
Danger!
~~~~~~~
This is a dangerous function.
.. warning::
This is a warning
It has multiple lines
It has a multi-line description.
:param int id: An id.
"""
result = apidocs.parse_doc_string(text)
assert result[0] == 'Danger!'
expected = [
'',
'This is a dangerous function.',
'',
'It has a multi-line description.',
''
]
assert result[1] == expected
expected = 'This is a warning\n\nIt has multiple lines'
assert result[2] == expected
params = result[3]
assert 'param' in params, 'Should have regular param'
assert params['param'][0] == dict(name='id', type="int",
description='An id.')
def test_parse_doc_string():
text = """
Glory!
~~~~~~
This is a glorious function
:param int id: An id.
:qparam bool louder: Make it louder?
:pparam string orgid: The orgid
:auth: required
"""
result = apidocs.parse_doc_string(text)
assert result[0] == 'Glory!'
assert result[1] == ['This is a glorious function']
params = result[2]
assert 'path' in params, 'Should have path params'
assert params['path'][0] == dict(name='orgid', type="string",
description='The orgid')
assert 'query' in params, 'Should have query params'
assert params['query'][0] == dict(name='louder', type="bool",
description='Make it louder?')
assert 'auth' in params, 'Should have auth'
assert params['auth'][0] == dict(name='', type="", description='required')
assert 'param' in params, 'Should have regular param'
assert params['param'][0] == dict(name='id', type="int",
description='An id.')
def test_parse_doc_string():
text = """
Glory!
~~~~~~
This is a glorious function.
It has a multi-line description.
:param int id: An ``id``.
:qparam bool louder: Make it **louder**?
:pparam string orgid: The *orgid*.
On a second line.
:auth: required
"""
result = apidocs.parse_doc_string(text)
assert result[0] == 'Glory!'
expected = [
'',
'This is a glorious function.',
'',
'It has a multi-line description.',
''
]
assert result[1] == expected
assert result[2] is None, 'no warning present'
params = result[3]
assert 'path' in params, 'Should have path params'
assert params['path'][0] == dict(name='orgid', type="string",
description='The *orgid*. On a second line.')
assert 'query' in params, 'Should have query params'
assert params['query'][0] == dict(name='louder', type="bool",
description='Make it **louder**?')
assert 'auth' in params, 'Should have auth'
assert params['auth'][0] == dict(name='', type="", description='required')
assert 'param' in params, 'Should have regular param'
assert params['param'][0] == dict(name='id', type="int",
description='An `id`.')