Skip to content
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

Playlist numbering only feature #2275

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions spotdl/console/download.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ def download(
query,
use_ytm_data=downloader.settings["ytm_data"],
playlist_numbering=downloader.settings["playlist_numbering"],
playlist_numbering_only=downloader.settings["playlist_numbering_only"],
albums_to_ignore=downloader.settings["ignore_albums"],
album_type=downloader.settings["album_type"],
playlist_retain_track_cover=downloader.settings["playlist_retain_track_cover"],
Expand Down
1 change: 1 addition & 0 deletions spotdl/console/meta.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ async def pool_worker(file_path: Path) -> None:
threads=downloader.settings["threads"],
use_ytm_data=downloader.settings["ytm_data"],
playlist_numbering=downloader.settings["playlist_numbering"],
playlist_numbering_only=downloader.settings["playlist_numbering_only"],
album_type=downloader.settings["album_type"],
playlist_retain_track_cover=downloader.settings[
"playlist_retain_track_cover"
Expand Down
1 change: 1 addition & 0 deletions spotdl/console/save.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ def save(
threads=downloader.settings["threads"],
use_ytm_data=downloader.settings["ytm_data"],
playlist_numbering=downloader.settings["playlist_numbering"],
playlist_numbering_only=downloader.settings["playlist_numbering_only"],
album_type=downloader.settings["album_type"],
playlist_retain_track_cover=downloader.settings["playlist_retain_track_cover"],
)
Expand Down
2 changes: 2 additions & 0 deletions spotdl/console/sync.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ def sync(
threads=downloader.settings["threads"],
use_ytm_data=downloader.settings["ytm_data"],
playlist_numbering=downloader.settings["playlist_numbering"],
playlist_numberung_only=downloader.settings["playlist_numbering_only"],
album_type=downloader.settings["album_type"],
playlist_retain_track_cover=downloader.settings[
"playlist_retain_track_cover"
Expand Down Expand Up @@ -114,6 +115,7 @@ def sync(
threads=downloader.settings["threads"],
use_ytm_data=downloader.settings["ytm_data"],
playlist_numbering=downloader.settings["playlist_numbering"],
playlist_numberung_only=downloader.settings["playlist_numbering_only"],
album_type=downloader.settings["album_type"],
playlist_retain_track_cover=downloader.settings[
"playlist_retain_track_cover"
Expand Down
1 change: 1 addition & 0 deletions spotdl/console/url.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ def url(
threads=downloader.settings["threads"],
use_ytm_data=downloader.settings["ytm_data"],
playlist_numbering=downloader.settings["playlist_numbering"],
playlist_numberung_only=downloader.settings["playlist_numbering_only"],
album_type=downloader.settings["album_type"],
playlist_retain_track_cover=downloader.settings["playlist_retain_track_cover"],
)
Expand Down
7 changes: 5 additions & 2 deletions spotdl/providers/lyrics/genius.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def get_results(self, name: str, artists: List[str], **_) -> Dict[str, str]:
results[hit["result"]["full_title"]] = hit["result"]["id"]

return results

def extract_lyrics(self, url: str, **_) -> Optional[str]:
"""
Extracts the lyrics from the given url.
Expand Down Expand Up @@ -112,12 +112,15 @@ def extract_lyrics(self, url: str, **_) -> Optional[str]:

lyrics_div = soup.select_one("div.lyrics")
lyrics_containers = soup.select("div[class^=Lyrics__Container]")
lyrics_container = soup.find("div", {"data-lyrics-container": "true"})

# Get lyrics
if lyrics_div:
lyrics = lyrics_div.get_text()
elif lyrics_containers:
lyrics = "\n".join(con.get_text() for con in lyrics_containers)
elif lyrics_container:
lyrics = lyrics_container.get_text("\n")
else:
return None

Expand All @@ -131,4 +134,4 @@ def extract_lyrics(self, url: str, **_) -> Optional[str]:
for to_remove in ["desc", "Desc"]:
lyrics.replace(to_remove, "", 1)

return lyrics
return lyrics
2 changes: 2 additions & 0 deletions spotdl/types/options.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ class DownloaderOptions(TypedDict):
lyrics_providers: List[str]
genius_token: str
playlist_numbering: bool
playlist_numbering_only: bool
playlist_retain_track_cover: bool
scan_for_songs: bool
m3u: Optional[str]
Expand Down Expand Up @@ -142,6 +143,7 @@ class DownloaderOptionalOptions(TypedDict, total=False):
lyrics_providers: List[str]
genius_token: str
playlist_numbering: bool
playlist_numbering_only: bool
playlist_retain_track_cover: bool
scan_for_songs: bool
m3u: Optional[str]
Expand Down
9 changes: 9 additions & 0 deletions spotdl/utils/arguments.py
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,15 @@ def parse_output_options(parser: _ArgumentGroup):
and album art as the playlist's icon",
)

# Stripped down version of the playlist numbering option, only setting the song's number to the playlist's index.
parser.add_argument(
"--playlist-numbering-only",
action="store_const",
dest="playlist_numbering_only",
const=True,
help="Sets the song's number to the playlist's index in a playlist",
)

# Option to set the track number & album of tracks, while retaining album art of each track, in
# a playlist to their index in the playlist & the name of playlist respectively.
parser.add_argument(
Expand Down
1 change: 1 addition & 0 deletions spotdl/utils/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,7 @@ def get_parameter(cls, key):
"lyrics_providers": ["genius", "azlyrics", "musixmatch"],
"genius_token": "alXXDbPZtK1m2RrZ8I4k2Hn8Ahsd0Gh_o076HYvcdlBvmc0ULL1H8Z8xRlew5qaG",
"playlist_numbering": False,
"playlist_numbering_only": False,
"playlist_retain_track_cover": False,
"scan_for_songs": False,
"m3u": None,
Expand Down
8 changes: 8 additions & 0 deletions spotdl/utils/search.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ def parse_query(
threads: int = 1,
use_ytm_data: bool = False,
playlist_numbering: bool = False,
playlist_numbering_only: bool = False,
album_type=None,
playlist_retain_track_cover: bool = False,
) -> List[Song]:
Expand All @@ -99,6 +100,7 @@ def parse_query(
query,
use_ytm_data=use_ytm_data,
playlist_numbering=playlist_numbering,
playlist_numbering_only=playlist_numbering_only,
album_type=album_type,
playlist_retain_track_cover=playlist_retain_track_cover,
)
Expand All @@ -120,6 +122,7 @@ def get_simple_songs(
query: List[str],
use_ytm_data: bool = False,
playlist_numbering: bool = False,
playlist_numbering_only: bool = False,
albums_to_ignore=None,
album_type=None,
playlist_retain_track_cover: bool = False,
Expand Down Expand Up @@ -256,6 +259,7 @@ def get_simple_songs(
[full_url],
use_ytm_data=use_ytm_data,
playlist_numbering=playlist_numbering,
playlist_numbering_only=playlist_numbering_only,
album_type=album_type,
playlist_retain_track_cover=playlist_retain_track_cover,
)
Expand Down Expand Up @@ -307,6 +311,10 @@ def get_simple_songs(
song_data["list_position"] = song.list_position
song_data["list_length"] = song_list.length

if playlist_numbering_only:
song_data["track_number"] = song_data["list_position"]
song_data["tracks_count"] = song_data["list_length"]

if playlist_numbering:
song_data["track_number"] = song_data["list_position"]
song_data["tracks_count"] = song_data["list_length"]
Expand Down