8000 [MRG+2] MAINT: Refactor the converted-image cache by jkseppan · Pull Request #7764 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

[MRG+2] MAINT: Refactor the converted-image cache #7764

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 19 commits into from
Closed

[MRG+2] MAINT: Refactor the converted-image cache #7764

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
1b24a16
Factor the converted-image cache out of compare.py
jkseppan Jan 7, 2017
650ddf2
Import cbook again
jkseppan Jan 21, 2017
3b5f636
Lock the cache directory
jkseppan Jan 21, 2017
556fd82
Communicate node-specific cache reports to master if using xdist
jkseppan Jan 22, 2017
9f5a06d
Delete the nose plugin
jkseppan Jan 25, 2017
33f2528
Reinstate deleted functions
jkseppan Jan 25, 2017
2136a26
Make conversion_cache private
jkseppan Jan 25, 2017
6995a27
Make globals private
jkseppan Jan 25, 2017
9ea66dd
Improve wording
jkseppan Jan 25, 2017
3751f01
mkdirs throws OSError
jkseppan Jan 25, 2017
a70081e
Improve documentation in response to review
jkseppan Jan 30, 2017
85f54de
Use pytest facilities
jkseppan Jan 30, 2017
0d51e03
Simplify gs and inkscape version checking logic
jkseppan Jan 30, 2017
9de06c0
pep8 fixes
jkseppan Jan 30, 2017
6007b37
There is no nose plugin any more
jkseppan Feb 18, 2017
e52cdd2
Import the pytest hooks in the other conftest.py files
jkseppan Feb 20, 2017
e5184bb
Omit unnecessary tmpdir deletions
jkseppan Feb 22, 2017
f47cbe4
Move pytest_addoption call to top-level conftest.py
jkseppan Feb 22, 2017
996f22b
pep8 fix
jkseppan Feb 22, 2017
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
Prev Previous commit
Next Next commit
Use pytest facilities
  • Loading branch information
@jkseppan
jkseppan committed Feb 20, 2017
commit 85f54dec1f5f15c4813ac2a15e3aaa5ee82eb300
137 changes: 61 additions & 76 deletions lib/matplotlib/tests/test_cache.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,91 +6,78 @@
import mock

import os
import shutil
import stat
import tempfile

from nose.tools import raises

from matplotlib import cbook
from matplotlib.testing._conversion_cache import _ConversionCache, _CacheError
import pytest


def test_cache_basic():
tmpdir = tempfile.mkdtemp()

def test_cache_basic(tmpdir):
def intmp(f):
return os.path.join(tmpdir, f)
return tmpdir.join(f)
def fname(f):
return str(intmp(f))
try:
cache = _ConversionCache(intmp('cache'))
with open(intmp('fake.pdf'), 'w') as pdf:
pdf.write('this is a fake pdf file')
with open(intmp('fake.svg'), 'w') as svg:
svg.write('this pretends to be an svg file')

assert not cache.get(intmp('fake.pdf'), intmp('fakepdf.png'))
assert not cache.get(intmp('fake.svg'), intmp('fakesvg.png'))
cache = _ConversionCache(fname('cache'))
intmp('fake.pdf').write_binary(b'this is a fake pdf file')
intmp('fake.svg').write_binary(b'this pretends to be an svg file')
assert not cache.get(fname('fake.pdf'), fname('fakepdf.png'))
assert not cache.get(fname('fake.svg'), fname('fakesvg.png'))
assert cache.report() == \
{'gets': {intmp('fake.pdf'), intmp('fake.svg')},
{'gets': {fname('fake.pdf'), fname('fake.svg')},
'hits': set()}

with open(intmp('fakepdf.png'), 'w') as png:
png.write('generated from the pdf file')
cache.put(intmp('fake.pdf'), intmp('fakepdf.png'))
assert cache.get(intmp('fake.pdf'), intmp('copypdf.png'))
with open(intmp('copypdf.png'), 'r') as copy:
assert copy.read() == 'generated from the pdf file'
intmp('fakepdf.png').write_binary(b'generated from the pdf file')
cache.put(fname('fake.pdf'), fname('fakepdf.png'))
assert cache.get(fname('fake.pdf'), fname('copypdf.png'))
assert intmp('copypdf.png').read() == 'generated from the pdf file'
assert cache.report() == \
{'gets': {intmp('fake.pdf'), intmp('fake.svg')},
'hits': set([intmp('fake.pdf')])}

with open(intmp('fakesvg.png'), 'w') as png:
png.write('generated from the svg file')
cache.put(intmp('fake.svg'), intmp('fakesvg.png'))
assert cache.get(intmp('fake.svg'), intmp('copysvg.png'))
with open(intmp('copysvg.png'), 'r') as copy:
assert copy.read() == 'generated from the svg file'
{'gets': {fname('fake.pdf'), fname('fake.svg')},
'hits': {fname('fake.pdf')}}

intmp('fakesvg.png').write_binary(b'generated from the svg file')
cache.put(fname('fake.svg'), fname('fakesvg.png'))
assert cache.get(fname('fake.svg'), fname('copysvg.png'))
assert intmp('copysvg.png').read() == 'generated from the svg file'
assert cache.report() == \
{'gets': {intmp('fake.pdf'), intmp('fake.svg')},
'hits': {intmp('fake.pdf'), intmp('fake.svg')}}
{'gets': {fname('fake.pdf'), fname('fake.svg')},
'hits': {fname('fake.pdf'), fname('fake.svg')}}
finally:
shutil.rmtree(tmpdir)

tmpdir.remove(rec=1)

def test_cache_expire():
tmpdir = tempfile.mkdtemp()

def test_cache_expire(tmpdir):
def intmp(*f):
return os.path.join(tmpdir, *f)
return tmpdir.join(*f)
def fname(*f):
return str(intmp(*f))
try:
cache = _ConversionCache(intmp('cache'), 10)
cache = _ConversionCache(fname('cache'), 10)
for i in range(5):
filename = intmp('cache', 'file%d.png' % i)
with open(filename, 'w') as f:
f.write('1234')
os.utime(filename, (i*1000, i*1000))
pngfile = intmp('cache', 'file%d.png' % i)
pngfile.write_binary(b'1234')
os.utime(str(pngfile), (i*1000, i*1000))

cache.expire()
assert not os.path.exists(intmp('cache', 'file0.png'))
assert not os.path.exists(intmp('cache', 'file1.png'))
assert not os.path.exists(intmp('cache', 'file2.png'))
assert os.path.exists(intmp('cache', 'file3.png'))
assert os.path.exists(intmp('cache', 'file4.png'))
assert not os.path.exists(fname('cache', 'file0.png'))
assert not os.path.exists(fname('cache', 'file1.png'))
assert not os.path.exists(fname('cache', 'file2.png'))
assert os.path.exists(fname('cache', 'file3.png'))
assert os.path.exists(fname('cache', 'file4.png'))

with open(intmp('cache', 'onemore.png'), 'w') as f:
f.write('x' * 11)
os.utime(intmp('cache', 'onemore.png'), (5000, 5000))
intmp('cache', 'onemore.png').write_binary(b'x' * 11)
os.utime(fname('cache', 'onemore.png'), (5000, 5000))

cache.expire()
assert not os.path.exists(intmp('cache', 'file0.png'))
assert not os.path.exists(intmp('cache', 'file1.png'))
assert not os.path.exists(intmp('cache', 'file2.png'))
assert not os.path.exists(intmp('cache', 'file3.png'))
assert not os.path.exists(intmp('cache', 'file4.png'))
assert not os.path.exists(intmp('cache', 'onemore.png'))
assert not os.path.exists(fname('cache', 'file0.png'))
assert not os.path.exists(fname('cache', 'file1.png'))
assert not os.path.exists(fname('cache', 'file2.png'))
assert not os.path.exists(fname('cache', 'file3.png'))
assert not os.path.exists(fname('cache', 'file4.png'))
assert not os.path.exists(fname('cache', 'onemore.png'))

finally:
shutil.rmtree(tmpdir)
tmpdir.remove(rec=1)
Copy link
Member

Choose a reason for hiding this comment

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

Why do this instead of letting the fixture clean up?

Copy link
Member Author

Choose a reason for hiding this comment

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

I didn't see in the documentation that it promises to do any cleanup. But it seems that the base directory gets cleaned up after three test runs.



def test_cache_default_dir():
Expand All @@ -101,25 +88,23 @@ def test_cache_default_dir():
pass


@raises(_CacheError)
@mock.patch('matplotlib.testing._conversion_cache.cbook.mkdirs',
side_effect=OSError)
def test_cache_mkdir_error(mkdirs):
tmpdir = tempfile.mkdtemp()
try:
c = _ConversionCache(os.path.join(tmpdir, 'cache'))
finally:
shutil.rmtree(tmpdir)
def test_cache_mkdir_error(mkdirs, tmpdir):
with pytest.raises(_CacheError):
try:
c = _ConversionCache(str(tmpdir.join('cache')))
finally:
tmpdir.remove(rec=1)


@raises(_CacheError)
@mock.patch('matplotlib.testing._conversion_cache.os.access',
side_effect=[False])
def test_cache_unwritable_error(access):
tmpdir = tempfile.mkdtemp()
cachedir = os.path.join(tmpdir, 'test_cache')
try:
cbook.mkdirs(cachedir)
c = _ConversionCache(cachedir)
finally:
shutil.rmtree(tmpdir)
def test_cache_unwritable_error(access, tmpdir):
with pytest.raises(_CacheError):
cachedir = tmpdir.join('cache')
cachedir.ensure(dir=True)
try:
c = _ConversionCache(str(cachedir))
finally:
tmpdir.remove(rec=1)
0