Merge pull request #41 from hudsonbrendon/fix/track-lyrics-get

fix: refactor method track_lyrics_get

pymusixmatch/musixmatch.py

@@ -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.
 
@@ -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

tests/test_musixmatch.py

@@ -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: