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

Skip to content

Use test cache for test result images too. #15932

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
Sep 25, 2020
Merged

Use test cache for test result images too. #15932

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
36 changes: 35 additions & 1 deletion lib/matplotlib/testing/compare.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
"""

import atexit
import functools
import hashlib
import logging
import os
from pathlib import Path
import re
Expand All @@ -19,6 +21,8 @@
from matplotlib import cbook
from matplotlib.testing.exceptions import ImageComparisonFailure

_log = logging.getLogger(__name__)

__all__ = ['compare_images', 'comparable_formats']


Expand Down Expand Up @@ -285,20 +289,50 @@ def convert(filename, cache):
cache_dir = Path(get_cache_dir()) if cache else None

if cache_dir is not None:
_register_conversion_cache_cleaner_once()
hash_value = get_file_hash(path)
cached_path = cache_dir / (hash_value + newpath.suffix)
if cached_path.exists():
_log.debug("For %s: reusing cached conversion.", filename)
shutil.copyfile(cached_path, newpath)
return str(newpath)

_log.debug("For %s: converting to png.", filename)
converter[path.suffix[1:]](path, newpath)

if cache_dir is not None:
_log.debug("For %s: caching conversion result.", filename)
shutil.copyfile(newpath, cached_path)

return str(newpath)


def _clean_conversion_cache():
# This will actually ignore mpl_toolkits baseline images, but they're
# relatively small.
baseline_images_size = sum(
path.stat().st_size
for path in Path(mpl.__file__).parent.glob("**/baseline_images/**/*"))
# 2x: one full copy of baselines, and one full copy of test results
# (actually an overestimate: we don't convert png baselines and results).
max_cache_size = 2 * baseline_images_size
# Reduce cache until it fits.
cache_stat = {
path: path.stat() for path in Path(get_cache_dir()).glob("*")}
cache_size = sum(stat.st_size for stat in cache_stat.values())
paths_by_atime = sorted( # Oldest at the end.
cache_stat, key=lambda path: cache_stat[path].st_atime, reverse=True)
while cache_size > max_cache_size:
path = paths_by_atime.pop()
cache_size -= cache_stat[path].st_size
path.unlink()


@functools.lru_cache() # Ensure this is only registered once.
def _register_conversion_cache_cleaner_once():
atexit.register(_clean_conversion_cache)


def crop_to_same(actual_path, actual_image, expected_path, expected_image):
# clip the images to the same size -- this is useful only when
# comparing eps to pdf
Expand Down Expand Up @@ -387,7 +421,7 @@ def compare_images(expected, actual, tol, in_decorator=False):
raise IOError('Baseline image %r does not exist.' % expected)
extension = expected.split('.')[-1]
if extension != 'png':
actual = convert(actual, cache=False)
actual = convert(actual, cache=True)
expected = convert(expected, cache=True)

# open the image files and remove the alpha channel (if it exists)
Expand Down