Note
Click here to download the full example code or to run this example in your browser via Binder
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.
# 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))
Out:
<matplotlib.collections.QuadMesh object at 0x76a46b49a3d0>
This next block will raise a NameError
iae
Traceback (most recent call last):
File "/home/runner/work/mkdocs-gallery/mkdocs-gallery/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
plt.plot('Strings are not a valid argument for the plot function')
Total running time of the script: ( 0 minutes 0.159 seconds)
Download Python source code: plot_raise.py