def test_works_on_python_docstrings():
before = '''\
def f():
"""hello world
.. code-block:: python
f(1,2,3)
```python
f(1,2,3)
```
"""
'''
expected = '''\
def f():
"""hello world
.. code-block:: python
f(1, 2, 3)
```python
f(1, 2, 3)
```
"""
'''
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == expected
def test_format_src_rst_pycon_indented():
before = (
'.. versionadded:: 3.1\n'
'\n'
' hello\n'
'\n'
' .. code-block:: pycon\n'
'\n'
' >>> def hi():\n'
' ... f(1,2,3)\n'
' ...\n'
'\n'
' world\n'
)
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == (
'.. versionadded:: 3.1\n'
'\n'
' hello\n'
'\n'
' .. code-block:: pycon\n'
'\n'
' >>> def hi():\n'
' ... f(1, 2, 3)\n'
' ...\n'
'\n'
' world\n'
)
def improve_markdown(markdown: str) -> str:
"""Improve markdown."""
md_text = html.unescape(markdown)
md_text = convert_code_block_style(md_text)
fixed_md, _ = blacken_docs.format_str(
md_text, black.FileMode(target_versions="3.6", line_length=79))
return fixed_md
def test_format_src_rst_pycon_no_prompt():
before = (
'.. code-block:: pycon\n'
'\n'
' pass\n'
)
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == before
def test_format_src_rst_pycon_elided_traceback():
before = ('.. code-block:: pycon\n'
'\n'
' >>> 1 / 0\n'
' Traceback (most recent call last):\n'
' ...\n'
' ZeroDivisionError: division by zero\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == before
def test_format_src_rst_pycon_preserves_output_indentation():
before = ('.. code-block:: pycon\n'
'\n'
' >>> 1 / 0\n'
' Traceback (most recent call last):\n'
' File "<stdin>", line 1, in <module>\n'
' ZeroDivisionError: division by zero\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == before
def test_format_src_rst_pycon_comment_before_promopt():
before = ('.. code-block:: pycon\n'
'\n'
' # Comment about next line\n'
' >>> pass\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('.. code-block:: pycon\n'
'\n'
' # Comment about next line\n'
' >>> pass\n')
def test_format_src_rst_pycon_code_block_is_final_line2():
before = ('.. code-block:: pycon\n'
'\n'
' >>> if True:\n'
' ... pass\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('.. code-block:: pycon\n'
'\n'
' >>> if True:\n'
' ... pass\n'
' ...\n')
def test_format_src_rst_python_inside_non_python_code_block():
before = ('blacken-docs does changes like:\n'
'\n'
'.. code-block:: diff\n'
'\n'
' .. code-block:: python\n'
'\n'
" - 'Hello World'\n"
' + "Hello World"\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == before
def test_format_src_rst_pycon_preserves_trailing_whitespace():
before = ('hello\n'
'\n'
'.. code-block:: pycon\n'
'\n'
' >>> d = {"a": 1, "b": 2, "c": 3}\n'
'\n'
'\n'
'\n'
'world\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == before
def test_format_src_latex_minted():
before = ('hello\n'
'\\begin{minted}{python}\n'
'f(1,2,3)\n'
'\\end{minted}\n'
'world!')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('hello\n'
'\\begin{minted}{python}\n'
'f(1, 2, 3)\n'
'\\end{minted}\n'
'world!')
def test_format_src_rst_pycon_no_trailing_newline():
before = (
'.. code-block:: pycon\n'
'\n'
' >>> pass'
)
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == (
'.. code-block:: pycon\n'
'\n'
' >>> pass\n'
)
def test_format_src_rst_pycon_nested_def2():
before = ('.. code-block:: pycon\n'
'\n'
' >>> if True:\n'
' ... def f(): pass\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('.. code-block:: pycon\n'
'\n'
' >>> if True:\n'
' ... def f():\n'
' ... pass\n'
' ...\n')
def test_format_src_markdown_trailing_whitespace():
before = (
'```python\n'
'f(1,2,3)\n'
'``` \n'
)
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == (
'```python\n'
'f(1, 2, 3)\n'
'``` \n'
)
def test_format_src_indented_markdown():
before = ('- do this pls:\n'
' ```python\n'
' f(1,2,3)\n'
' ```\n'
'- also this\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('- do this pls:\n'
' ```python\n'
' f(1, 2, 3)\n'
' ```\n'
'- also this\n')
def test_src_pythontex(tmpdir):
before = ('hello\n'
'\\begin{pyblock}\n'
'f(1,2,3)\n'
'\\end{pyblock}\n'
'world!')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('hello\n'
'\\begin{pyblock}\n'
'f(1, 2, 3)\n'
'\\end{pyblock}\n'
'world!')
def test_format_src_rst_pycon_empty_line():
before = ('.. code-block:: pycon\n'
'\n'
' >>> l = [\n'
' ...\n'
' ... 1,\n'
' ... ]\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('.. code-block:: pycon\n'
'\n'
' >>> l = [\n'
' ... 1,\n'
' ... ]\n')
def test_format_src_latex_minted():
# Nicer style to put the \begin and \end on new lines,
# but not actually required for the begin line
before = ('hello\n'
'\\begin{minted}{python}\n'
'f(1,2,3)\n'
'\\end{minted}\n'
'world!')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('hello\n'
'\\begin{minted}{python}\n'
'f(1, 2, 3)\n'
'\\end{minted}\n'
'world!')
def test_format_src_rst_with_highlight_directives():
before = ('.. code-block:: python\n'
' :lineno-start: 10\n'
' :emphasize-lines: 11\n'
'\n'
' def foo():\n'
' bar(1,2,3)\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('.. code-block:: python\n'
' :lineno-start: 10\n'
' :emphasize-lines: 11\n'
'\n'
' def foo():\n'
' bar(1, 2, 3)\n')
def test_format_src_latex_minted_pycon():
before = ('Preceeding text\n'
'\\begin{minted}{pycon}\n'
">>> print( 'Hello World' )\n"
'Hello World\n'
'\\end{minted}\n'
'Following text.')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('Preceeding text\n'
'\\begin{minted}{pycon}\n'
'>>> print("Hello World")\n'
'Hello World\n'
'\\end{minted}\n'
'Following text.')
def test_format_src_rst_pycon_adds_contiuation():
before = ('.. code-block:: pycon\n'
'\n'
' >>> d = {"a": 1,"b": 2,"c": 3,}\n'
'\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('.. code-block:: pycon\n'
'\n'
' >>> d = {\n'
' ... "a": 1,\n'
' ... "b": 2,\n'
' ... "c": 3,\n'
' ... }\n'
'\n')
def test_format_src_rst():
before = ('hello\n'
'\n'
'.. code-block:: python\n'
'\n'
' f(1,2,3)\n'
'\n'
'world\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('hello\n'
'\n'
'.. code-block:: python\n'
'\n'
' f(1, 2, 3)\n'
'\n'
'world\n')
def test_format_src_latex_minted_indented():
# Personaly I would have minted python code all flush left,
# with only the Python code's own four space indentation:
before = ('hello\n'
' \\begin{minted}{python}\n'
' if True:\n'
' f(1,2,3)\n'
' \\end{minted}\n'
'world!')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('hello\n'
' \\begin{minted}{python}\n'
' if True:\n'
' f(1, 2, 3)\n'
' \\end{minted}\n'
'world!')
def test_format_src_rst_jupyter_sphinx():
before = ('hello\n'
'\n'
'.. jupyter-execute::\n'
'\n'
' f(1,2,3)\n'
'\n'
'world\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('hello\n'
'\n'
'.. jupyter-execute::\n'
'\n'
' f(1, 2, 3)\n'
'\n'
'world\n')
def test_format_src_latex_minted_pycon_indented():
# Nicer style to put the \begin and \end on new lines,
# but not actually required for the begin line
before = ('Preceeding text\n'
' \\begin{minted}{pycon}\n'
" >>> print( 'Hello World' )\n"
' Hello World\n'
' \\end{minted}\n'
'Following text.')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('Preceeding text\n'
' \\begin{minted}{pycon}\n'
' >>> print("Hello World")\n'
' Hello World\n'
' \\end{minted}\n'
'Following text.')
def test_format_src_markdown_pycon():
before = ('hello\n'
'\n'
'```pycon\n'
'\n'
' >>> f(1,2,3)\n'
' output\n'
'```\n'
'world\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == ('hello\n'
'\n'
'```pycon\n'
'\n'
'>>> f(1, 2, 3)\n'
'output\n'
'```\n'
'world\n')
def test_format_src_rst_sphinx_doctest():
before = (
'.. testsetup:: group1\n'
'\n'
' import parrot \n'
' mock = SomeMock( )\n'
'\n'
'.. testcleanup:: group1\n'
'\n'
' mock.stop( )\n'
'\n'
'.. doctest:: group1\n'
'\n'
' >>> parrot.voom( 3000 )\n'
' This parrot wouldn\'t voom if you put 3000 volts through it!\n'
'\n'
'.. testcode::\n'
'\n'
' parrot.voom( 3000 )\n'
'\n')
after, _ = blacken_docs.format_str(before, BLACK_MODE)
assert after == (
'.. testsetup:: group1\n'
'\n'
' import parrot\n'
'\n'
' mock = SomeMock()\n'
'\n'
'.. testcleanup:: group1\n'
'\n'
' mock.stop()\n'
'\n'
'.. doctest:: group1\n'
'\n'
' >>> parrot.voom(3000)\n'
' This parrot wouldn\'t voom if you put 3000 volts through it!\n'
'\n'
'.. testcode::\n'
'\n'
' parrot.voom(3000)\n'
'\n')
def test_format_src_rst_indented():
before = ('.. versionadded:: 3.1\n'
'\n'
' hello\n'
'\n'
' .. code-block:: python\n'
'\n'
' def hi():\n'
' f(1,2,3)\n'
'\n'
' world\n')
after, _ = blacken_docs.format_str(before, **OPTS)
assert after == ('.. versionadded:: 3.1\n'
'\n'
' hello\n'
'\n'
' .. code-block:: python\n'
'\n'
' def hi():\n'
' f(1, 2, 3)\n'
'\n'
' world\n')
def test_format_src_trivial():
after, _ = blacken_docs.format_str('', BLACK_MODE)
assert after == ''
def test_format_src_markdown_simple():
before = ('```python\n' 'f(1,2,3)\n' '```\n')
after, _ = blacken_docs.format_str(before, **OPTS)
assert after == ('```python\n' 'f(1, 2, 3)\n' '```\n')
