codey/api
1
0
Fork 0
Code Issues Pull Requests Activity

docstrings

Browse Source
This commit is contained in:
codey
2025-08-11 14:06:42 -04:00
parent 0fc78b08e4
commit 4cbd0fb934
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
utils/sr_wrapper.py
View File

@@ -54,7 +54,7 @@ class SRUtil:
return f"{m}:{s:02}" return f"{m}:{s:02}"
async def get_artists_by_name(self, artist_name: str) -> Optional[list]: async def get_artists_by_name(self, artist_name: str) -> Optional[list]:
"""Get artist(s) by name from HiFi API. """Get artist(s) by name.
Args: Args:
artist_name (str): The name of the artist. artist_name (str): The name of the artist.
Returns: Returns:
@@ -89,7 +89,7 @@ class SRUtil:
return artists_out return artists_out
async def get_albums_by_artist_id(self, artist_id: int) -> Optional[list | dict]: async def get_albums_by_artist_id(self, artist_id: int) -> Optional[list | dict]:
"""Get albums by artist ID from HiFi API. """Get albums by artist ID
Args: Args:
artist_id (int): The ID of the artist. artist_id (int): The ID of the artist.
Returns: Returns:
@@ -127,7 +127,7 @@ class SRUtil:
return albums_out return albums_out
async def get_tracks_by_album_id(self, album_id: int) -> Optional[list | dict]: async def get_tracks_by_album_id(self, album_id: int) -> Optional[list | dict]:
"""Get tracks by album ID from HiFi API. """Get tracks by album ID
Args: Args:
album_id (int): The ID of the album. album_id (int): The ID of the album.
Returns: Returns:
@@ -158,7 +158,7 @@ class SRUtil:
return tracks_out return tracks_out
async def get_tracks_by_artist_song(self, artist: str, song: str) -> Optional[list]: async def get_tracks_by_artist_song(self, artist: str, song: str) -> Optional[list]:
"""Get track by artist and song name from HiFi API. """Get track by artist and song name
Args: Args:
artist (str): The name of the artist. artist (str): The name of the artist.
song (str): The name of the song. song (str): The name of the song.
@@ -171,7 +171,7 @@ class SRUtil:
async def get_stream_url_by_track_id( async def get_stream_url_by_track_id(
self, track_id: int, quality: str = "LOSSLESS" self, track_id: int, quality: str = "LOSSLESS"
) -> Optional[str]: ) -> Optional[str]:
"""Get stream URL by track ID from HiFi API. """Get stream URL by track ID
Args: Args:
track_id (int): The ID of the track. track_id (int): The ID of the track.
quality (str): The quality of the stream, default is "LOSSLESS". Other options: HIGH, LOW quality (str): The quality of the stream, default is "LOSSLESS". Other options: HIGH, LOW