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.

Sign up for GitHub

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

fix: refactor method track_lyrics_get #41

Merged
merged 1 commit into from
Jan 8, 2025
Merged

fix: refactor method track_lyrics_get #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 5 additions & 6 deletions pymusixmatch/musixmatch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ def track_get(
self,
commontrack_id: Optional[str] = "",
track_isrc: Optional[str] = "",
):
) -> dict:
"""Get a track info from our database:
title, artist, instrumental flag and cover art.

Expand All @@ -232,18 +232,17 @@ def track_get(
)
return data

def track_lyrics_get(self, track_id, commontrack_id=None, _format="json"):
def track_lyrics_get(self, track_id: str = "", commontrack_id: str = "") -> dict:
"""Get the lyrics of a track.

Parameters:

track_id - The musiXmatch track id.
track_mbid - The musicbrainz track id.
format - Decide the output type json or xml (default json).
track_id (str): The musiXmatch track id.
track_mbid (str): The musicbrainz track id.
"""
data = self._request(
self._get_url(
f"track.lyrics.get?track_id={track_id}&commontrack_id={commontrack_id}&format={_format}",
f"track.lyrics.get?track_id={track_id}&commontrack_id={commontrack_id}",
),
)
return data
Expand Down
4 changes: 2 additions & 2 deletions tests/test_musixmatch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,9 @@ def test_track_get(self, requests_mock, track_get: dict) -> None:
assert track_get == request

def test_track_lyrics_get(self, requests_mock, tracks: dict) -> None:
url = "https://api.musixmatch.com/ws/1.1/track.lyrics.get?track_id=12345"
url = "https://api.musixmatch.com/ws/1.1/track.lyrics.get?track_id=12345&commontrack_id=12345"
requests_mock.get(url=url, json=tracks)
request = self.musixmatch.track_lyrics_get(12345)
request = self.musixmatch.track_lyrics_get(12345, 12345)
assert tracks == request

def test_track_snippet_get(self, requests_mock, track_snippet: dict) -> None:
Expand Down
Loading