Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2025-12-24 17:43:52 +01:00
Code Issues Projects Releases Wiki Activity

initial work on allowing slightly non-square images in fetchart

Browse source
This commit is contained in:
wordofglass 2016-04-18 01:47:39 +02:00
parent 8169983074
commit 6cbbba7dae
2 changed files with 91 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
beetsplug/fetchart.py
View file

@ -30,6 +30,7 @@ from beets import ui
from beets import util
from beets import config
from beets.util.artresizer import ArtResizer
from beets.util import confit
try:
import itunes
@ -91,6 +92,9 @@ class Candidate(object):
u'`enforce_ratio` may be violated.')
return self.CANDIDATE_EXACT
short_edge = min(self.size)
long_edge = max(self.size)
# Check minimum size.
if extra['minwidth'] and self.size[0] < extra['minwidth']:
self._log.debug(u'image too small ({} < {})',
@ -98,10 +102,23 @@ class Candidate(object):
return self.CANDIDATE_BAD
# Check aspect ratio.
if extra['enforce_ratio'] and self.size[0] != self.size[1]:
self._log.debug(u'image is not square ({} != {})',
self.size[0], self.size[1])
return self.CANDIDATE_BAD
edge_diff = long_edge - short_edge
if extra['enforce_ratio']:
if extra['margin_px'] and edge_diff > extra['margin_px']:
self._log.debug(u'image is notblablapxsquare ({} != {})',
self.size[0], self.size[1])
return self.CANDIDATE_BAD
elif extra['margin_percent'] and \
edge_diff > extra['margin_percent'] * long_edge:
self._log.debug(u'image is notblablapercentsquare ({} != {})',
self.size[0], self.size[1])
return self.CANDIDATE_BAD
elif not extra['margin_px'] and not extra['margin_percent'] and \
edge_diff:
# also reached for margin_px == 0 and margin_percent == 0.0
self._log.debug(u'image is not square ({} != {})',
self.size[0], self.size[1])
return self.CANDIDATE_BAD
# Check maximum size.
if extra['maxwidth'] and self.size[0] > extra['maxwidth']:
@ -634,9 +651,16 @@ SOURCE_NAMES = {v: k for k, v in ART_SOURCES.items()}
class FetchArtPlugin(plugins.BeetsPlugin, RequestMixin):
PAT_PX = r"(0|[1-9][0-9]*)px"
PAT_PERCENT = r"(100(\.00?)?|[1-9]?[0-9](\.[0-9]{1,2})?)%"
def __init__(self):
super(FetchArtPlugin, self).__init__()
# Holds paths to downloaded images between fetching them and
# placing them in the filesystem.
self.art_paths = {}
self.config.add({
'auto': True,
'minwidth': 0,
@ -653,13 +677,25 @@ class FetchArtPlugin(plugins.BeetsPlugin, RequestMixin):
self.config['google_key'].redact = True
self.config['fanarttv_key'].redact = True
# Holds paths to downloaded images between fetching them and
# placing them in the filesystem.
self.art_paths = {}
self.minwidth = self.config['minwidth'].get(int)
self.maxwidth = self.config['maxwidth'].get(int)
self.enforce_ratio = self.config['enforce_ratio'].get(bool)
# allow both pixel and percentage-based margin specifications
self.enforce_ratio = self.config['enforce_ratio'].get(
confit.OneOf([bool,
confit.String(pattern=self.PAT_PX),
confit.String(pattern=self.PAT_PERCENT)]))
self.margin_px = None
self.margin_percent = None
if type(self.enforce_ratio) is unicode:
if self.enforce_ratio[-1] == u'%':
self.margin_percent = float(self.enforce_ratio[:-1]) / 100
elif self.enforce_ratio[-2:] == u'px':
self.margin_px = int(self.enforce_ratio[:-2])
else:
# shouldn't happen
raise confit.ConfigValueError()
self.enforce_ratio = True
cover_names = self.config['cover_names'].as_str_seq()
self.cover_names = map(util.bytestring_path, cover_names)
@ -765,6 +801,8 @@ class FetchArtPlugin(plugins.BeetsPlugin, RequestMixin):
'cover_names': self.cover_names,
'cautious': self.cautious,
'enforce_ratio': self.enforce_ratio,
'margin_px': self.margin_px,
'margin_percent': self.margin_percent,
'minwidth': self.minwidth,
'maxwidth': self.maxwidth}

44
test/test_art.py
View file

@ -33,6 +33,7 @@ from beets import importer
from beets import logging
from beets import util
from beets.util.artresizer import ArtResizer, WEBPROXY
from beets.util import confit
logger = logging.getLogger('beets.test_art')
@ -534,6 +535,26 @@ class ArtForAlbumTest(UseThePlugin):
self.plugin.enforce_ratio = False
self._assertImageIsValidArt(self.IMG_500x490, True)
def test_respect_enforce_ratio_px_above(self):
self.plugin.enforce_ratio = True
self.plugin.margin_px = 5
self._assertImageIsValidArt(self.IMG_500x490, False)
def test_respect_enforce_ratio_px_below(self):
self.plugin.enforce_ratio = True
self.plugin.margin_px = 15
self._assertImageIsValidArt(self.IMG_500x490, True)
def test_respect_enforce_ratio_percent_above(self):
self.plugin.enforce_ratio = True
self.plugin.margin_percent = (500 - 490) / 500 * 0.5
self._assertImageIsValidArt(self.IMG_500x490, False)
def test_respect_enforce_ratio_percent_below(self):
self.plugin.enforce_ratio = True
self.plugin.margin_percent = (500 - 490) / 500 * 1.5
self._assertImageIsValidArt(self.IMG_500x490, True)
def test_resize_if_necessary(self):
self._require_backend()
self.plugin.maxwidth = 300
@ -559,6 +580,29 @@ class DeprecatedConfigTest(_common.TestCase):
self.assertEqual(type(self.plugin.sources[-1]), fetchart.FileSystem)
class EnforceRatioConfigTest(_common.TestCase):
"""Throw some data at the regexes."""
def _load_with_config(self, values, should_raise):
if should_raise:
for v in values:
config['fetchart']['enforce_ratio'] = v
with self.assertRaises(confit.ConfigValueError):
fetchart.FetchArtPlugin()
else:
for v in values:
config['fetchart']['enforce_ratio'] = v
fetchart.FetchArtPlugin()
def test_px(self):
self._load_with_config(u'0px 4px 12px 123px'.split(), False)
self._load_with_config(u'00px stuff5px'.split(), True)
def test_percent(self):
self._load_with_config(u'0% 0.00% 5.1% 5% 100%'.split(), False)
self._load_with_config(u'00% 1.234% foo5% 100.1%'.split(), True)
def suite():
return unittest.TestLoader().loadTestsFromName(__name__)