feature: --ignore-album #1934 can only accept one keyword for albums to ignore

[mckayc]

System OS

Windows

Python Version

3.11 (CPython)

Install Source

pip / PyPi

Install version / commit hash

4.2.4

Expected Behavior vs Actual Behavior

Expected behavior:
When you use the flag --ignore-albums, you should be able to ignore albums with several different keywords.

For example, if you want to download all the albums of the band "Sweet" but want to exclude albums that are mixes, sessions, or rare, you could run

spotdl https://open.spotify.com/artist/3JaAGmSTpJK35DqWrDUzBz --ignore-albums "mixes" or "sessions" or "rare" --output '{artist}/({year}) {album}/{artist} - {album} - {track-number} - {title}'

And this should exclude downloading any album with any of the keywords.

Actual behavior:

When doing the command with multiple keywords, albums are not ignored as they should be.

I have also tried it like:

spotdl https://open.spotify.com/artist/3JaAGmSTpJK35DqWrDUzBz --ignore-albums "mixes, sessions, rare" --output '{artist}/({year}) {album}/{artist} - {album} - {track-number} - {title}'

Either way I run the command, it will still download albums that have any of the keywords in the title.

Steps to reproduce - Ensure to include actual links!

1. Run the following command:
   spotdl https://open.spotify.com/artist/3JaAGmSTpJK35DqWrDUzBz --ignore-albums "mixes" --output '{artist}/({year}) {album}/{artist} - {album} - {track-number} - {title}'
2. Notice that the album "Give Us A Wink (Alt. Mixes & Demos)" is NOT downloaded.
3. Now run the following command:
   spotdl https://open.spotify.com/artist/3JaAGmSTpJK35DqWrDUzBz --ignore-albums "mixes" or "sessions" --output '{artist}/({year}) {album}/{artist} - {album} - {track-number} - {title}'
4. Notice that all albums are being downloaded including albums with "mixes" or "sessions" in the title.

Traceback

Processing query: https://open.spotify.com/artist/3JaAGmSTpJK35DqWrDUzBz
Found 347 songs in Sweet (Artist)
Skipped 0 songs (Ignored albums)

Other details

It is possible that this works as intended and only one keyword is allowed. I would think however that you should be able to specify multiple keywords.

I have tried many different syntaxes, and none of them worked. Maybe this is working and I just don't know how to write the keywords. If this is the case, a simple update in documentation would likely suffice.

Thanks!

[bharat-nair]

You should be able to pass multiple keywords like so: --ignore-albums "mixes" "sessions" "rare" in different quotes.
However, you're right, there seems to be a bug in the keyword check.

[mckayc]

@bharat-nair thanks for writing. I thought I had checked the quote method before like you showed, I checked again just now to verify if it is still buggy. It is. One other thing I noticed is that it either tries to repeatedly download the same songs over and over again or it somehow gets stuck in some sort of loop because when I try downloading ignoring keywords it never fully downloads.

Here is a line you can use to test:
spotdl $URL --ignore-albums "live" "greatest" "in concert" "retrospective" "demo" "mixes" "sessions" "demos" "anniversary" "rare" "hits" "rehearsals" "complete" "love songs" "gold" "anthology" "box set" "singles" "best" --skip-explicit --output '{artist}/({year}) {album}/{artist} - {album} - {track-number} - {title}'

Replace $URL with either an artist URL or an album URL.

If you use an artist URL (example: https://open.spotify.com/artist/3JaAGmSTpJK35DqWrDUzBz ), it does not ignore all the keywords.
If you use an album URL with one of the ignored keywords (example: https://open.spotify.com/album/62aBpOfBSGG0H7eBbiyB5A ), it does not ignore the album. This also seems to go into the weird loop where it tries downloading over and over again. This might be the easiest way to test things out.

Thanks!

[bharat-nair]

So earlier if you had albums: [A, B, C, D] and keywords [B, D], for B the check would compare B-B exclusive of B-D, which ended up adding B to the list of songs. #2014 should fix this, I've tested it with the command you have provided, thanks for that!

[mckayc]

@bharat-nair Cool beans. Thanks so much for the fix. I look forward to trying it out!

[stale]

This issue has been automatically marked stale because there hasn't been any activity for the last 30 days.