Added Lyrics w. Timestamps #662

heinrich26 · 2024-10-10T18:38:00Z

Added get_lyrics_with_timestamps to get lyrics with timestamps. The Method doesn't try to parse the response as normal lyrics, if no lyrics with timestamps are returned. (could be changed to do so tho, the format is the same)

Added `get_lyrics_with_timestamps` to get lyrics with timestamps. The Method doesn't try to parse the response as normal lyrics, if no lyrics with timestamps are returned. (could be changed to do so tho, the format is the same)

codecov · 2024-10-11T15:53:11Z

Codecov Report

Attention: Patch coverage is 97.59036% with 2 lines in your changes missing coverage. Please review.

Project coverage is 95.01%. Comparing base (db732f2) to head (2e1e89f).

Files with missing lines	Patch %	Lines
ytmusicapi/mixins/browsing.py	92.59%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #662      +/-   ##
==========================================
+ Coverage   94.88%   95.01%   +0.12%     
==========================================
  Files          38       40       +2     
  Lines        2289     2348      +59     
==========================================
+ Hits         2172     2231      +59     
  Misses        117      117

Flag	Coverage Δ
unittests	`95.01% <97.59%> (+0.12%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

sigma67

Hi @heinrich26 , pretty cool that you were able to make this work!

I take it you're basically emulating the mobile client to fetch the timed data? Since you're modifying the client info.

Could we replace the previous get_lyrics with this? I wouldn't want to have two methods for the same purpose in the API if one provides a superset of information.

Finally, to get this merged:

please ensure the linters pass
please add a test for the function

heinrich26 · 2024-10-11T23:44:19Z

Yea, calling the API "as a different frontend" gives you different results. I temporarily changed the client because I thought unforeseen side-effects aren't desirable.As per the implementation of a multipurpose `get_lyrics()`, I would add an argument like `timestamps=True/False`, to keep it backwards compatible and allow the user to always get the same (old) format – with my approach, you'll end up with 2 possible formats.Furthermore, would you keep the original format with the nested `CueRange` or would you rather have a flat dict? I think that nesting is kinda useless.

… errors

…ads, because vscode didn't show them otherwise

Pushed to the wrong branch :(

because idk where it came from...

sigma67

Thanks, looks much better! :)

As a general rule of thumb: Don't change more than necessary in a single PR. It makes it harder for the maintainer to review the changes (more time consuming), and harder to trace back potential future issues to specific PRs. It will also prolong the time it takes for the PR to get merged.

Note for this review: Please don't resolve threads, I will do so myself after verifying the changes

sigma67 · 2024-10-15T14:49:44Z

ytmusicapi/mixins/search.py

@@ -204,7 +206,7 @@ def search(
        if filter and "playlists" in filter:
            filter = "playlists"
        elif scope == scopes[1]:
-            filter = scopes[1]
+            filter = scopes[1] # type:ignore


please undo all changes to this file

ytmusicapi/mixins/uploads.py

sigma67 · 2024-10-15T14:50:51Z

ytmusicapi/ytmusic.py

@@ -181,7 +181,7 @@ def __init__(
            try:
                cookie = self.base_headers.get("cookie")
                self.sapisid = sapisid_from_cookie(cookie)
-                self.origin = self.base_headers.get("origin", self.base_headers.get("x-origin"))
+                self.origin = cast(str, self.base_headers.get("origin", self.base_headers.get("x-origin")))


Please undo changes to this file

sigma67 · 2024-10-15T14:52:15Z

ytmusicapi/__init__.py

@@ -2,14 +2,16 @@

 from ytmusicapi.setup import setup, setup_oauth
 from ytmusicapi.ytmusic import YTMusic
+from .mixins.browsing import Lyrics, TimedLyrics, LyricLine


Please undo the changes to this file. They are not needed and I don't want to start exporting everything from root

I was thinking similar, but then you'll need to create a submodule for these classes to be accessible

You can already access them: from ytmusicapi.mixins.browsing import TimedLyrics

It's similar for https://github.com/sigma67/ytmusicapi/blob/main/ytmusicapi/parsers/podcasts.py

Although with #621 in mind, it might be wise to move them to a ytmusicapi.models module (one for podcasts and one for lyrics, I guess)

sigma67 · 2024-10-15T14:53:31Z

ytmusicapi/mixins/_utils.py


 from ytmusicapi.exceptions import YTMusicUserError


+OrderType = Literal['a_to_z', 'z_to_a', 'recently_added']


This is a good change in general, but the name is too broad. Since you introduced an ArtistOrderType elsewhere, this should have a more specific name as well. Maybe LibraryOrderType ?

ytmusicapi/mixins/browsing.py

ytmusicapi/mixins/_protocol.py

reverted some changes that I moved to an extra PR

…y `yt.as_mobile()`

heinrich26 · 2024-10-20T11:50:00Z

finally used pre-commit to fix those formatting complaints 🤷‍♂️

sigma67 · 2024-12-17T17:41:03Z

Hi @heinrich26 , I am moving this over to #693 as merging is somehow blocked here

* Added Lyrics w. Timestamps Added `get_lyrics_with_timestamps` to get lyrics with timestamps. The Method doesn't try to parse the response as normal lyrics, if no lyrics with timestamps are returned. (could be changed to do so tho, the format is the same) * Update browsing.py * Combined both get_lyrics methods into one and fixed some typechecking errors * Fixed a missing hasTimestamps and added the doccomments to the overloads, because vscode didn't show them otherwise * Removed the old get_lyrics_with_timestamps method because idk where it came from... * fixed remaining issues * Update uploads.py reverted some changes that I moved to an extra PR * removed variable `context` from the Mixin, as it's use was replaced by `yt.as_mobile()` * fix some formatting complaints by ruff and mypy * please the linter * fix union syntax * improve typing in ytmusic.py * improve typing * replace docsbuild.yml with RTD --------- Co-authored-by: Hendrik Horstmann <65970327+heinrich26@users.noreply.github.com> Co-authored-by: henrich26 <hendrik-horstmann@o2mail.de>

heinrich26 added 2 commits October 10, 2024 20:37

Added Lyrics w. Timestamps

4d4a76f

Added `get_lyrics_with_timestamps` to get lyrics with timestamps. The Method doesn't try to parse the response as normal lyrics, if no lyrics with timestamps are returned. (could be changed to do so tho, the format is the same)

Update browsing.py

14313be

sigma67 reviewed Oct 11, 2024

View reviewed changes

heinrich26 and others added 4 commits October 12, 2024 20:14

Combined both get_lyrics methods into one and fixed some typechecking…

0885616

… errors

Fixed a missing hasTimestamps and added the doccomments to the overlo…

28a8828

…ads, because vscode didn't show them otherwise

Merge pull request #1 from heinrich26/main

ab032f5

Pushed to the wrong branch :(

Removed the old get_lyrics_with_timestamps method

049b0b0

because idk where it came from...

sigma67 reviewed Oct 15, 2024

View reviewed changes

ytmusicapi/mixins/_protocol.py Outdated Show resolved Hide resolved

sigma67 added the enhancement New feature or request label Oct 16, 2024

heinrich26 and others added 3 commits October 16, 2024 23:33

fixed remaining issues

3198b1f

Update uploads.py

cfd9a4a

reverted some changes that I moved to an extra PR

removed variable context from the Mixin, as it's use was replaced b…

0c2444c

…y `yt.as_mobile()`

heinrich26 requested a review from sigma67 October 16, 2024 21:58

heinrich26 added 2 commits October 18, 2024 18:26

fix some formatting complaints by ruff and mypy

a8a1f5f

please the linter

b546eed

Merge remote-tracking branch 'origin/main' into heinrich26-patch-1

2e1e89f

sigma67 closed this Dec 17, 2024

sigma67 mentioned this pull request Dec 17, 2024

Added Lyrics w. Timestamps #662 #693

Merged

sigma67 reopened this Dec 17, 2024

sigma67 closed this Dec 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Lyrics w. Timestamps #662

Added Lyrics w. Timestamps #662

heinrich26 commented Oct 10, 2024

codecov bot commented Oct 11, 2024 •

edited

Loading

sigma67 left a comment

heinrich26 commented Oct 11, 2024 via email

sigma67 left a comment

sigma67 Oct 15, 2024

sigma67 Oct 15, 2024

sigma67 Oct 15, 2024

heinrich26 Oct 15, 2024

sigma67 Oct 16, 2024

sigma67 Oct 15, 2024

heinrich26 Oct 15, 2024

heinrich26 commented Oct 20, 2024

sigma67 commented Dec 17, 2024


		from ytmusicapi.exceptions import YTMusicUserError


		OrderType = Literal['a_to_z', 'z_to_a', 'recently_added']

Added Lyrics w. Timestamps #662

Added Lyrics w. Timestamps #662

Conversation

heinrich26 commented Oct 10, 2024

codecov bot commented Oct 11, 2024 • edited Loading

Codecov Report

sigma67 left a comment

Choose a reason for hiding this comment

heinrich26 commented Oct 11, 2024 via email

sigma67 left a comment

Choose a reason for hiding this comment

sigma67 Oct 15, 2024

Choose a reason for hiding this comment

sigma67 Oct 15, 2024

Choose a reason for hiding this comment

sigma67 Oct 15, 2024

Choose a reason for hiding this comment

heinrich26 Oct 15, 2024

Choose a reason for hiding this comment

sigma67 Oct 16, 2024

Choose a reason for hiding this comment

sigma67 Oct 15, 2024

Choose a reason for hiding this comment

heinrich26 Oct 15, 2024

Choose a reason for hiding this comment

heinrich26 commented Oct 20, 2024

sigma67 commented Dec 17, 2024

codecov bot commented Oct 11, 2024 •

edited

Loading