mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
0949735210
Keep imports alphabetically sorted and their order homogeneous across Python source files. The isort project has more feature and is more active than the flake8-import-order plugin. Most issues caught were simply import ordering from the same module. Where imports were purposefully placed out of order, tag with isort:skip.
80 lines
2.7 KiB
Python
80 lines
2.7 KiB
Python
"""
|
|
test_util_docstrings
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Test sphinx.util.docstrings.
|
|
|
|
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
from sphinx.util.docstrings import extract_metadata, prepare_commentdoc, prepare_docstring
|
|
|
|
|
|
def test_extract_metadata():
|
|
metadata = extract_metadata(":meta foo: bar\n"
|
|
":meta baz:\n")
|
|
assert metadata == {'foo': 'bar', 'baz': ''}
|
|
|
|
# field_list like text following just after paragaph is not a field_list
|
|
metadata = extract_metadata("blah blah blah\n"
|
|
":meta foo: bar\n"
|
|
":meta baz:\n")
|
|
assert metadata == {}
|
|
|
|
# field_list like text following after blank line is a field_list
|
|
metadata = extract_metadata("blah blah blah\n"
|
|
"\n"
|
|
":meta foo: bar\n"
|
|
":meta baz:\n")
|
|
assert metadata == {'foo': 'bar', 'baz': ''}
|
|
|
|
# non field_list item breaks field_list
|
|
metadata = extract_metadata(":meta foo: bar\n"
|
|
"blah blah blah\n"
|
|
":meta baz:\n")
|
|
assert metadata == {'foo': 'bar'}
|
|
|
|
|
|
def test_prepare_docstring():
|
|
docstring = """multiline docstring
|
|
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit,
|
|
sed do eiusmod tempor incididunt ut labore et dolore magna
|
|
aliqua::
|
|
|
|
Ut enim ad minim veniam, quis nostrud exercitation
|
|
ullamco laboris nisi ut aliquip ex ea commodo consequat.
|
|
"""
|
|
|
|
assert (prepare_docstring(docstring) ==
|
|
["multiline docstring",
|
|
"",
|
|
"Lorem ipsum dolor sit amet, consectetur adipiscing elit,",
|
|
"sed do eiusmod tempor incididunt ut labore et dolore magna",
|
|
"aliqua::",
|
|
"",
|
|
" Ut enim ad minim veniam, quis nostrud exercitation",
|
|
" ullamco laboris nisi ut aliquip ex ea commodo consequat.",
|
|
""])
|
|
|
|
docstring = """
|
|
|
|
multiline docstring with leading empty lines
|
|
"""
|
|
assert (prepare_docstring(docstring) ==
|
|
["multiline docstring with leading empty lines",
|
|
""])
|
|
|
|
docstring = "single line docstring"
|
|
assert (prepare_docstring(docstring) ==
|
|
["single line docstring",
|
|
""])
|
|
|
|
|
|
def test_prepare_commentdoc():
|
|
assert prepare_commentdoc("hello world") == []
|
|
assert prepare_commentdoc("#: hello world") == ["hello world", ""]
|
|
assert prepare_commentdoc("#: hello world") == [" hello world", ""]
|
|
assert prepare_commentdoc("#: hello\n#: world\n") == ["hello", "world", ""]
|