synced

Synced lyrics provider using the syncedlyrics library

Synced()

Bases: LyricsProvider

Lyrics provider for synced lyrics using the syncedlyrics library Currently supported websites: Deezer, NetEase

Source code in spotdl/providers/lyrics/base.py

def __init__(self):
    """
    Init the lyrics provider searchand set headers.
    """

    self.headers = {
        "Connection": "keep-alive",
        "Pragma": "no-cache",
        "Cache-Control": "no-cache",
        "sec-ch-ua": '"Chromium";v="104", " Not A;Brand";v="99", "Google Chrome";v="104"',
        "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 "
        "(KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36",
        "Accept": "*/*",
        "Sec-Fetch-Site": "same-origin",
        "Sec-Fetch-Mode": "cors",
        "Sec-Fetch-Dest": "empty",
        "Accept-Language": "en-US;q=0.8,en;q=0.7",
    }

extract_lyrics(url, **kwargs)

Extracts the lyrics from the given url.

Arguments

• url: The url to extract the lyrics from.
• kwargs: Additional arguments.

Returns

• The lyrics of the song or None if no lyrics were found.

Source code in spotdl/providers/lyrics/synced.py

def extract_lyrics(self, url: str, **kwargs) -> Optional[str]:
    """
    Extracts the lyrics from the given url.

    ### Arguments
    - url: The url to extract the lyrics from.
    - kwargs: Additional arguments.

    ### Returns
    - The lyrics of the song or None if no lyrics were found.
    """

    raise NotImplementedError

get_lyrics(name, artists, **kwargs)

Try to get lyrics using syncedlyrics

Arguments

• name: The name of the song.
• artists: The artists of the song.
• kwargs: Additional arguments.

Returns

• The lyrics of the song or None if no lyrics were found.

Source code in spotdl/providers/lyrics/synced.py

def get_lyrics(self, name: str, artists: List[str], **kwargs) -> Optional[str]:
    """
    Try to get lyrics using syncedlyrics

    ### Arguments
    - name: The name of the song.
    - artists: The artists of the song.
    - kwargs: Additional arguments.

    ### Returns
    - The lyrics of the song or None if no lyrics were found.
    """

    try:
        lyrics = syncedlyrics.search(
            f"{name} - {artists[0]}",
            allow_plain_format=kwargs.get("allow_plain_format", True),
        )
        return lyrics
    except requests.exceptions.SSLError:
        # Max retries reached
        return None
    except TypeError:
        # Error at syncedlyrics.providers.musixmatch L89 -
        #   Because `body` is occasionally an empty list instead of a dictionary.
        # We get this error when allow_plain_format is set to True,
        #   and there are no synced lyrics present
        # Because its empty, we know there are no lyrics
        return None

get_results(name, artists, **kwargs)

Returns the results for the given song.

Arguments

• name: The name of the song.
• artists: The artists of the song.
• kwargs: Additional arguments.

Returns

• A dictionary with the results. (The key is the title and the value is the url.)

Source code in spotdl/providers/lyrics/synced.py

def get_results(self, name: str, artists: List[str], **kwargs) -> Dict[str, str]:
    """
    Returns the results for the given song.

    ### Arguments
    - name: The name of the song.
    - artists: The artists of the song.
    - kwargs: Additional arguments.

    ### Returns
    - A dictionary with the results. (The key is the title and the value is the url.)
    """

    raise NotImplementedError