Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Simplify logic for determining image comparison directories #5858

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

Closed
wants to merge 6 commits into from
Closed

Simplify logic for determining image comparison directories #5858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
86f7bcd
Simplify logic which finds baseline image directories for @image_comp…
maxalbert Jan 14, 2016
54412ba
Raise error if test specifies more baseline images than it creates fi…
maxalbert Jan 14, 2016
b05110e
Make error message more informative by printing the name of the test …
maxalbert Jan 14, 2016
841dbc6
Raise error if test does not specify enough baseline images.
maxalbert Jan 15, 2016
628427a
Fix test_scatter_plot() which failed with the stricter checks because…
maxalbert Jan 15, 2016
f883da9
Add corrected PDF for scatter plot test, too.
maxalbert Jan 18, 2016
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
77 changes: 28 additions & 49 deletions lib/matplotlib/testing/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,16 @@

import functools
import gc
import inspect
import os
import sys
import shutil
import warnings
import unittest
try:
from itertools import zip_longest
except ImportError:
from itertools import izip_longest as zip_longest

import nose
import numpy as np
Expand Down Expand Up @@ -200,7 +205,16 @@ def remove_text(figure):
def test(self):
baseline_dir, result_dir = _image_directories(self._func)

for fignum, baseline in zip(plt.get_fignums(), self._baseline_images):
for fignum, baseline in zip_longest(plt.get_fignums(), self._baseline_images):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than using izip_longest, couldn't you just check that the lengths of plt.get_fignums() and self._baseline_images are the same before the loop? That we we don't do a bunch of work only to fail later. (And if either of those is an iterator, they are certainly very short iterators so the cost of doing list() on them should be negligible).

if fignum is None:
raise ImageComparisonFailure(
'Test "%s" specifies more baseline images than it creates figures' %
self._orig_test_name)
if baseline is None:
raise ImageComparisonFailure(
('Test "%s" does not specify baseline images for some of the figures '
'it creates') % self._orig_test_name)

for extension in self._extensions:
will_fail = not extension in comparable_formats()
if will_fail:
Expand Down Expand Up @@ -321,12 +335,13 @@ def compare_images_decorator(func):
# something without the word "test", or it will be run as
# well, outside of the context of our image comparison test
# generator.
func = staticmethod(func)
func.__get__(1).__name__ = str('_private')
orig_test_name = func.__name__
func.__name__ = str('_private')
new_class = type(
name,
(ImageComparisonTest,),
{'_func': func,
{'_func': staticmethod(func),
'_orig_test_name': orig_test_name,
'_baseline_images': baseline_images,
'_extensions': extensions,
'_tol': tol,
Expand All @@ -342,52 +357,16 @@ def _image_directories(func):
"""
Compute the baseline and result image directories for testing *func*.
Create the result directory if it doesn't exist.

If the test function is called `test_foobar` and lives in the file
/path/to/test_dir/test_script.py then the baseline directory will
be /path/to/test_dir/baseline_images/test_script/ and the result
directory will be /path/to/test_dir/result_images/test_script/.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't quite right. The result_images dir is relative to where the tests are run from, not /path/to/test_dir. (The idea is that the test runner shouldn't write any files in the source tree). It doesn't like the code actually changes this in that regard, I think the docstring is just incorrect here.

"""
module_name = func.__module__
if module_name == '__main__':
# FIXME: this won't work for nested packages in matplotlib.tests
warnings.warn('test module run as script. guessing baseline image locations')
script_name = sys.argv[0]
basedir = os.path.abspath(os.path.dirname(script_name))
subdir = os.path.splitext(os.path.split(script_name)[1])[0]
else:
mods = module_name.split('.')
if len(mods) >= 3:
mods.pop(0)
# mods[0] will be the name of the package being tested (in
# most cases "matplotlib") However if this is a
# namespace package pip installed and run via the nose
# multiprocess plugin or as a specific test this may be
# missing. See https://github.com/matplotlib/matplotlib/issues/3314
if mods.pop(0) != 'tests':
warnings.warn(("Module '%s' does not live in a parent module "
"named 'tests'. This is probably ok, but we may not be able "
"to guess the correct subdirectory containing the baseline "
"images. If things go wrong please make sure that there is "
"a parent directory named 'tests' and that it contains a "
"__init__.py file (can be empty).") % module_name)
subdir = os.path.join(*mods)

import imp
def find_dotted_module(module_name, path=None):
"""A version of imp which can handle dots in the module name.
As for imp.find_module(), the return value is a 3-element
tuple (file, pathname, description)."""
res = None
for sub_mod in module_name.split('.'):
try:
res = file, path, _ = imp.find_module(sub_mod, path)
path = [path]
if file is not None:
file.close()
except ImportError:
# assume namespace package
path = sys.modules[sub_mod].__path__
res = None, path, None
return res

mod_file = find_dotted_module(func.__module__)[1]
basedir = os.path.dirname(mod_file)
script_name = inspect.getsourcefile(func)

basedir = os.path.abspath(os.path.dirname(script_name))
subdir = os.path.splitext(os.path.split(script_name)[1])[0]

baseline_dir = os.path.join(basedir, 'baseline_images', subdir)
result_dir = os.path.abspath(os.path.join('result_images', subdir))
Expand Down
Binary file modified lib/matplotlib/tests/baseline_images/test_axes/scatter.pdf
View file
Open in desktop
Binary file not shown.
Binary file modified lib/matplotlib/tests/baseline_images/test_axes/scatter.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading