Skip to content

Fix trailing text in doctest-syntax plot_directive. #20109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 1, 2021
Merged

Fix trailing text in doctest-syntax plot_directive. #20109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/api/next_api_changes/deprecations/20109-AL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
``plot_directive`` internals deprecations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following helpers in `matplotlib.sphinxext.plot_directive` are deprecated:
``unescape_doctest`` (use `doctest.script_from_examples` instead),
``split_code_at_show``, ``run_code``.
32 changes: 25 additions & 7 deletions lib/matplotlib/sphinxext/plot_directive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@
"""

import contextlib
import doctest
from io import StringIO
import itertools
import os
Expand Down Expand Up @@ -301,14 +302,14 @@ def contains_doctest(text):
return bool(m)


@_api.deprecated("3.5", alternative="doctest.script_from_examples")
def unescape_doctest(text):
"""
Extract code from a piece of text, which contains either Python code
or doctests.
"""
if not contains_doctest(text):
return text

code = ""
for line in text.split("\n"):
m = re.match(r'^\s*(>>>|\.\.\.) (.*)$', line)
Expand All @@ -321,11 +322,16 @@ def unescape_doctest(text):
return code


@_api.deprecated("3.5")
def split_code_at_show(text):
"""Split code at plt.show()."""
return _split_code_at_show(text)[1]


def _split_code_at_show(text):
"""Split code at plt.show()."""
parts = []
is_doctest = contains_doctest(text)

part = []
for line in text.split("\n"):
if (not is_doctest and line.strip() == 'plt.show()') or \
Expand All @@ -337,7 +343,7 @@ def split_code_at_show(text):
part.append(line)
if "\n".join(part).strip():
parts.append("\n".join(part))
return parts
return is_doctest, parts


# -----------------------------------------------------------------------------
Expand Down Expand Up @@ -437,11 +443,20 @@ class PlotError(RuntimeError):
pass


@_api.deprecated("3.5")
def run_code(code, code_path, ns=None, function_name=None):
"""
Import a Python module from a path, and run the function given by
name, if function_name is not None.
"""
_run_code(unescape_doctest(code), code_path, ns, function_name)


def _run_code(code, code_path, ns=None, function_name=None):
"""
Import a Python module from a path, and run the function given by
name, if function_name is not None.
"""

# Change the working directory to the directory of the example, so
# it can get at its data files, if any. Add its path to sys.path
Expand All @@ -466,7 +481,6 @@ def run_code(code, code_path, ns=None, function_name=None):
sys, argv=[code_path], path=[os.getcwd(), *sys.path]), \
contextlib.redirect_stdout(StringIO()):
try:
code = unescape_doctest(code)
if ns is None:
ns = {}
if not ns:
Expand Down Expand Up @@ -529,7 +543,7 @@ def render_figures(code, code_path, output_dir, output_base, context,

# Try to determine if all images already exist

code_pieces = split_code_at_show(code)
is_doctest, code_pieces = _split_code_at_show(code)

# Look for single-figure output files first
all_exists = True
Expand Down Expand Up @@ -593,7 +607,9 @@ def render_figures(code, code_path, output_dir, output_base, context,
elif close_figs:
plt.close('all')

run_code(code_piece, code_path, ns, function_name)
_run_code(doctest.script_from_examples(code_piece) if is_doctest
else code_piece,
code_path, ns, function_name)

images = []
fig_managers = _pylab_helpers.Gcf.get_all_fig_managers()
Expand Down Expand Up @@ -816,7 +832,9 @@ def run(arguments, content, options, state_machine, state, lineno):

# copy script (if necessary)
Path(dest_dir, output_base + source_ext).write_text(
unescape_doctest(code) if source_file_name == rst_file else code,
doctest.script_from_examples(code)
if source_file_name == rst_file and is_doctest
else code,
encoding='utf-8')

return errors
9 changes: 7 additions & 2 deletions lib/matplotlib/tests/tinypages/some_plots.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,16 @@ Plot 2 doesn't use context either; has length 6:

plt.plot(range(6))

Plot 3 has length 4:
Plot 3 has length 4, and uses doctest syntax:

.. plot::
:format: doctest

plt.plot(range(4))
This is a doctest...

>>> plt.plot(range(4))

... isn't it?

Plot 4 shows that a new block with context does not see the variable defined
in the no-context block:
Expand Down