-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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.
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
Add bracket argument to aunique #2399
Changes from all commits
377a2a6
3a967df
d10df34
eaa2161
04f7915
672fc36
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1447,13 +1447,15 @@ def tmpl_time(s, fmt): | |
cur_fmt = beets.config['time_format'].as_str() | ||
return time.strftime(fmt, time.strptime(s, cur_fmt)) | ||
|
||
def tmpl_aunique(self, keys=None, disam=None): | ||
def tmpl_aunique(self, keys=None, disam=None, bracket=None): | ||
"""Generate a string that is guaranteed to be unique among all | ||
albums in the library who share the same set of keys. A fields | ||
from "disam" is used in the string if one is sufficient to | ||
disambiguate the albums. Otherwise, a fallback opaque value is | ||
used. Both "keys" and "disam" should be given as | ||
whitespace-separated lists of field names. | ||
whitespace-separated lists of field names, while "bracket" is a | ||
pair of characters to be used as brackets surrounding the | ||
disambiguator or empty to have no brackets. | ||
""" | ||
# Fast paths: no album, no item or library, or memoized value. | ||
if not self.item or not self.lib: | ||
|
@@ -1467,9 +1469,20 @@ def tmpl_aunique(self, keys=None, disam=None): | |
|
||
keys = keys or 'albumartist album' | ||
disam = disam or 'albumtype year label catalognum albumdisambig' | ||
if bracket is None: | ||
bracket = '[]' | ||
keys = keys.split() | ||
disam = disam.split() | ||
|
||
# Assign a left and right bracket or leave blank if argument is empty. | ||
if len(bracket) == 2: | ||
bracket = list(bracket) | ||
bracket_l = bracket[0] | ||
bracket_r = bracket[1] | ||
else: | ||
bracket_l = u'' | ||
bracket_r = u'' | ||
|
||
album = self.lib.get_album(self.item) | ||
if not album: | ||
# Do nothing for singletons. | ||
|
@@ -1502,13 +1515,19 @@ def tmpl_aunique(self, keys=None, disam=None): | |
|
||
else: | ||
# No disambiguator distinguished all fields. | ||
res = u' {0}'.format(album.id) | ||
res = u' {1}{0}{2}'.format(album.id, bracket_l, bracket_r) | ||
self.lib._memotable[memokey] = res | ||
return res | ||
|
||
# Flatten disambiguation value into a string. | ||
disam_value = album.formatted(True).get(disambiguator) | ||
res = u' [{0}]'.format(disam_value) | ||
|
||
# Return empty string if disambiguator is empty. | ||
if disam_value: | ||
res = u' {1}{0}{2}'.format(disam_value, bracket_l, bracket_r) | ||
else: | ||
res = u'' | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hmm… is there a cleaner way we can check for an empty disambiguation string? Perhaps, if this appears earlier, we can just use |
||
|
||
self.lib._memotable[memokey] = res | ||
return res | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -713,8 +713,8 @@ def test_use_fallback_numbers_when_identical(self): | |
album2.year = 2001 | ||
album2.store() | ||
|
||
self._assert_dest(b'/base/foo 1/the title', self.i1) | ||
self._assert_dest(b'/base/foo 2/the title', self.i2) | ||
self._assert_dest(b'/base/foo [1]/the title', self.i1) | ||
self._assert_dest(b'/base/foo [2]/the title', self.i2) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That looks like the right change to me! |
||
|
||
def test_unique_falls_back_to_second_distinguishing_field(self): | ||
self._setf(u'foo%aunique{albumartist album,month year}/$title') | ||
|
@@ -730,6 +730,24 @@ def test_unique_sanitized(self): | |
self._setf(u'foo%aunique{albumartist album,albumtype}/$title') | ||
self._assert_dest(b'/base/foo [foo_bar]/the title', self.i1) | ||
|
||
def test_drop_empty_disambig_string(self): | ||
album1 = self.lib.get_album(self.i1) | ||
album1.albumdisambig = None | ||
album2 = self.lib.get_album(self.i2) | ||
album2.albumdisambig = u'foo' | ||
album1.store() | ||
album2.store() | ||
self._setf(u'foo%aunique{albumartist album,albumdisambig}/$title') | ||
self._assert_dest(b'/base/foo/the title', self.i1) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How do I add an empty field in the tests? My efforts yielded There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hmm; I suppose I assumed you had run into this with some music in your library. Maybe you can reuse the data from there? You could, for example, try setting some arbitrary field There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah, that is what I ran into with my library. I think adding the second album fixed it. |
||
|
||
def test_change_brackets(self): | ||
self._setf(u'foo%aunique{albumartist album,year,()}/$title') | ||
self._assert_dest(b'/base/foo (2001)/the title', self.i1) | ||
|
||
def test_remove_brackets(self): | ||
self._setf(u'foo%aunique{albumartist album,year,}/$title') | ||
self._assert_dest(b'/base/foo 2001/the title', self.i1) | ||
|
||
|
||
class PluginDestinationTest(_common.TestCase): | ||
def setUp(self): | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please add a description of
bracket
to the docstring?