[Deprecated] Run the matplotlib test suite.
Deprecated since version 3.5.
Helper functions for testing.
Utilities for comparing image results.
Calculate the per-pixel errors, then compute the root mean square error.
Return the list of file formats that compare_images
can compare on this system.
E.g. ['png', 'pdf', 'svg', 'eps']
.
Compare two "image" files checking differences within a tolerance.
The two given filenames may point to files which are convertible to PNG via the converter
dictionary. The underlying RMS is calculated with the calculate_rms
function.
The filename of the expected image.
The filename of the actual image.
The tolerance (a color value difference, where 255 is the maximal difference). The test fails if the average pixel difference is greater than this value.
Determines the output format. If called from image_comparison decorator, this should be True. (default=False)
Return None if the images are equal within the given tolerance.
If the images differ, the return value depends on in_decorator. If in_decorator is true, a dict with the following entries is returned:
Otherwise, a human-readable multi-line string representation of this information is returned.
img1 = "./baseline/plot.png" img2 = "./output/plot.png" compare_images(img1, img2, 0.001)
Bases: unittest.case.TestCase
A wrapper for unittest.TestCase that includes cleanup operations.
Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.
Hook method for setting up class fixture before running tests in the class.
Hook method for deconstructing the class fixture after running all tests in the class.
Decorator for test cases that generate and compare two figures.
The decorated function must take two keyword arguments, fig_test and fig_ref, and draw the test and reference images on them. After the function returns, the figures are saved and compared.
This decorator should be preferred over image_comparison
when possible in order to keep the size of the test suite from ballooning.
The extensions to test.
The RMS threshold above which the test is considered failed.
If any new figures are created (and not subsequently closed) inside the test function.
Check that calling Axes.plot
with a single argument plots it against [0, 1, 2, ...]
:
@check_figures_equal() def test_plot(fig_test, fig_ref): fig_test.subplots().plot([1, 3, 5]) fig_ref.subplots().plot([0, 1, 2], [1, 3, 5])
A decorator to ensure that any global state is reset before running a test.
The style(s) to apply. Defaults to ["classic",
"_classic_test_patch"]
.
Compare images generated by the test with those specified in baseline_images, which must correspond, else an ImageComparisonFailure
exception will be raised.
A list of strings specifying the names of the images generated by calls to Figure.savefig
.
If None, the test function must use the baseline_images
fixture, either as a parameter or with pytest.mark.usefixtures
. This value is only allowed when using pytest.
The list of extensions to test, e.g. ['png', 'pdf']
.
If None, defaults to all supported extensions: png, pdf, and svg.
When testing a single extension, it can be directly included in the names passed to baseline_images. In that case, extensions must not be set.
In order to keep the size of the test suite from ballooning, we only include the svg
or pdf
outputs if the test is explicitly exercising a feature dependent on that backend (see also the check_figures_equal
decorator for that purpose).
The RMS threshold above which the test is considered failed.
Due to expected small differences in floating-point calculations, on 32-bit systems an additional 0.06 is added to this threshold.
The expected freetype version or range of versions for this test to pass.
Remove the title and tick text from the figure before comparison. This is useful to make the baseline images independent of variations in text rendering between different versions of FreeType.
This does not remove other, more deliberate, text, such as legends and annotations.
Optional arguments that are passed to the savefig method.
The optional style(s) to apply to the image test. The test itself can also apply additional styles if desired. Defaults to ["classic",
"_classic_test_patch"]
.
Bases: AssertionError
Raise this exception to mark a test as a comparison between two images.
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.5.1/api/testing_api.html