Example that fails to execute

This example demonstrates a code block that raises an error and how any code blocks that follow are not executed.

When scripts fail, their gallery thumbnail is replaced with the broken image stamp. This allows easy identification in the gallery display.

You will also get the python traceback of the failed code block.

15
16
17
18
19
20
21
22
 # Code source: Óscar Nájera
 # License: BSD 3 clause
 # sphinx_gallery_line_numbers = True

 import numpy as np
 import matplotlib.pyplot as plt

 plt.pcolormesh(np.random.randn(100, 100))
../../_images/sphx_glr_plot_raise_001.png

Out:

<matplotlib.collections.QuadMesh object at 0x7fca081eda60>

This next block will raise a NameError

27
 iae
Traceback (most recent call last):
  File "/build/sphinx-gallery-gk9RIn/sphinx-gallery-0.5.0/build/lib/sphinx_gallery/gen_rst.py", line 433, in _memory_usage
    mem, out = memory_usage(func, max_usage=True, retval=True,
  File "/usr/lib/python3/dist-packages/memory_profiler.py", line 333, in memory_usage
    returned = f(*args, **kw)
  File "/build/sphinx-gallery-gk9RIn/sphinx-gallery-0.5.0/build/lib/sphinx_gallery/gen_rst.py", line 425, in __call__
    exec(self.code, self.globals)
  File "/build/sphinx-gallery-gk9RIn/sphinx-gallery-0.5.0/examples/no_output/plot_raise.py", line 27, in <module>
    iae
NameError: name 'iae' is not defined

Sphinx gallery will stop executing the remaining code blocks after the exception has occurred in the example script. Nevertheless the html will still render all the example annotated text and code blocks, but no output will be shown.

Here is another error raising block but will not be executed

38
 plt.plot('Strings are not a valid argument for the plot function')

Estimated memory usage: 178 MB

Gallery generated by Sphinx-Gallery