Add bracket argument to aunique #2399

diomekes · 2017-01-19T21:14:30Z

A little background as to why I felt this was needed:

If I have two albums that are disambiguated by albumdisambig, and one album has that field empty, then it would have an empty []. In this case, I would only want the brackets gone.

Also, if I do something like [$year%aunique{}], then I would have two sets of brackets, with the inner set possibly empty. Plus, in this case, if the inner brackets are removed, then there is still a white space after the year and before the closing bracket.

So this change does a few things:

It adds a third argument to %aunique{} that should be two characters to be used as brackets.
It removes the blank space along with any brackets created from an empty disambiguator.
It adds brackets when the fallback album_id is used as the disambiguator (I decided to add this for consistency, but maybe it was left out originally for a reason I'm not aware of).

This will close #2397.

Finally, I think adding the brackets to the album_id fallback messed up the test for library.py. I fixed it, but I don't know if I did it correctly.

And I'm totally fine if this request is considered unnecessary for whatever reason, especially if some of my changes look "ugly".

sampsyo

Aha! Thanks for diagnosing this—you're right that empty brackets look weird and we should dispense with them. And in addition, the new brackets parameter seems useful. I'm all for this.

It would be awesome to have small tests for the new functionality (dropping empty disambiguation strings and changing the brackets) and a changelog entry.

sampsyo · 2017-01-19T23:09:43Z

beets/library.py

@@ -1447,7 +1447,7 @@ 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):


Could you please add a description of bracket to the docstring?

sampsyo · 2017-01-19T23:13:06Z

beets/library.py

        keys = keys.split()
        disam = disam.split()
+        bracket = None if bracket is ' ' else list(bracket)


Is there a reason the condition is bracket is ' ' instead of using the empty string ''?

is might work sometimes for comparing strings, but == is the right operator to use here.

>>> 'a' is 'a' True >>> 'a' * 100 is 'a' * 100 False >>> 'a' * 100 == 'a' * 100 True

The bracket == ' ' is to check for a white space in the third argument for %aunique in order to remove any bracketing.

Right—I guess the question is whether the empty string might be a better "use nothing" indicator than a space.

sampsyo · 2017-01-19T23:15:32Z

beets/library.py

            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)
+        res = u' {1}{0}{2}'.format(disam_value, bracket[0] if bracket else u'',
+                                   bracket[1] if bracket else u'')


Maybe this and the prior line with bracket-formatting would be more legible if the two brackets were assigned into variables?

if bracket: bracket_l = bracket[0] bracket_r = bracket[1] else: bracket_l = u'' bracket_r = u''

sampsyo · 2017-01-19T23:16:25Z

beets/library.py

@@ -1502,13 +1504,20 @@ 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[0] if bracket else
+                                       u'', bracket[1] if bracket else u'')


This is fine—I don't have a strong opinion about whether the brackets should appear here, but you're certainly right that it will look more consistent.

sampsyo · 2017-01-19T23:17:37Z

beets/library.py

+
+        # Remove space and/or brackets if disambiguation value is empty
+        if bracket and res == u' ' + ''.join(bracket) or res.isspace():
+            res = u''


Hmm… is there a cleaner way we can check for an empty disambiguation string? Perhaps, if this appears earlier, we can just use if disam_value: for the check.

sampsyo · 2017-01-19T23:20:06Z

docs/reference/pathformat.rst


 The default identifiers are ``albumartist album`` and the default disambiguators
 are ``albumtype year label catalognum albumdisambig``. So you can get reasonable
 disambiguation behavior if you just use ``%aunique{}`` with no parameters in
 your path forms (as in the default path formats), but you can customize the
 disambiguation if, for example, you include the year by default in path formats.

+The default characters used as brackets are ``[]``. If a single blank space is
+used, then the disambiguator will not be surrounded by anything.


For full clarity, maybe something like this:

The default characters used as brackets are []. To change this, provide a third argument to the %aunique function consisting of two characters: the left and right brackets. Or, to turn off bracketing entirely, use a single blank space.

sampsyo · 2017-01-19T23:20:19Z

test/test_library.py

-        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)


That looks like the right change to me!

…ange bracket test

diomekes · 2017-01-20T01:52:15Z

test/test_library.py

+        album1 = self.lib.get_album(self.i1)
+        album1.year = None
+        album1.store()
+        self._assert_dest(b'/base/foo/the title', self.i1)


How do I add an empty field in the tests? My efforts yielded [0000] for year = None and [1] for everything else.

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 foo to be empty on one album and to have a known value on another, and then set up the %aunique invocation to use that as the only (or first) disambiguator.

Yeah, that is what I ran into with my library. I think adding the second album fixed it.

sampsyo

Looking great. Here's one last suggestion and a question.

sampsyo · 2017-01-21T02:50:20Z

beets/library.py

        keys = keys.split()
        disam = disam.split()
+        bracket = None if bracket == ' ' else list(bracket)


To avoid crashes, maybe this should check that bracket has length 2.

sampsyo · 2017-01-21T02:52:26Z

docs/reference/pathformat.rst

+The default characters used as brackets are ``[]``. To change this, provide a
+third argument to the ``%aunique`` function consisting of two characters: the left
+and right brackets. Or, to turn off bracketing entirely, use a single blank
+space.


Great; this sounds good! But just to triple-check: is it necessary for the "null option" here to be a single space? That seems a little counterintuitive, but if there's a technical reason we can't use the empty string instead it's fine.

Well, I set it up to default to []. I could change it to default to nothing, and that way we can get rid of the whole single space thing, or change from a single space to something else as the argument for no brackets. Is that what you mean?

Right—I meant that, to get no brackets, you would use %aunique{foo,bar,} instead of %aunique{foo,bar, }. To use the default square brackets, you would leave the comma off: %aunique{foo,bar}. In other words, the third argument to the function would be '' for no brackets and None for the default.

OK, I think I got it. I was trying to distinguish '' from None with ' ', but I guess that's not necessary.

Add bracket argument to aunique

Indexing a string works just fine.

Add bracket argument to aunique

Indexing a string works just fine.

sampsyo · 2017-01-21T04:54:17Z

Fantastic; thank you for finishing this up! It's all merged. ✨

sampsyo requested changes Jan 19, 2017

View reviewed changes

diomekes added 2 commits January 19, 2017 20:39

add bracket argument to aunique

377a2a6

simplify check for empty disam_val, update changelog and docs, add ch…

3a967df

…ange bracket test

diomekes force-pushed the aunique-bracket branch from 1fb3068 to 3a967df Compare January 20, 2017 01:45

diomekes commented Jan 20, 2017

View reviewed changes

diomekes added 2 commits January 20, 2017 09:06

add test for aunique without brackets

d10df34

fix empty disambig string test

eaa2161

sampsyo requested changes Jan 21, 2017

View reviewed changes

diomekes added 2 commits January 20, 2017 22:47

change no-bracket argument from white space to empty

04f7915

fix docstring for aunique empty bracket

672fc36

sampsyo added a commit that referenced this pull request Jan 21, 2017

Merge pull request #2399 from diomekes/aunique-bracket

779a490

Add bracket argument to aunique

sampsyo added a commit that referenced this pull request Jan 21, 2017

Remove an unnecessary list conversion (#2399)

3b10644

Indexing a string works just fine.

sampsyo merged commit 672fc36 into beetbox:master Jan 21, 2017

sampsyo added a commit that referenced this pull request Jan 21, 2017

Merge pull request #2399 from diomekes/aunique-bracket

ad957b5

Add bracket argument to aunique

sampsyo added a commit that referenced this pull request Jan 21, 2017

Remove an unnecessary list conversion (#2399)

c2b6623

Indexing a string works just fine.

diomekes deleted the aunique-bracket branch January 22, 2017 14:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add bracket argument to aunique #2399

Add bracket argument to aunique #2399

diomekes commented Jan 19, 2017 •

edited

Loading

sampsyo left a comment

sampsyo Jan 19, 2017

sampsyo Jan 19, 2017

diomekes Jan 20, 2017

sampsyo Jan 20, 2017

sampsyo Jan 19, 2017

sampsyo Jan 19, 2017

sampsyo Jan 19, 2017

sampsyo Jan 19, 2017

sampsyo Jan 19, 2017

diomekes Jan 20, 2017

sampsyo Jan 21, 2017

diomekes Jan 21, 2017

sampsyo left a comment

sampsyo Jan 21, 2017

sampsyo Jan 21, 2017

diomekes Jan 21, 2017 •

edited

Loading

sampsyo Jan 21, 2017

diomekes Jan 21, 2017

sampsyo commented Jan 21, 2017

Add bracket argument to aunique #2399

Add bracket argument to aunique #2399

Conversation

diomekes commented Jan 19, 2017 • edited Loading

sampsyo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sampsyo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diomekes Jan 21, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sampsyo commented Jan 21, 2017

diomekes commented Jan 19, 2017 •

edited

Loading

diomekes Jan 21, 2017 •

edited

Loading