Skip to content

base

Base module for all other lyrics providers.

LyricsProvider() ¤

Base class for all other lyrics providers.

Source code in spotdl/providers/lyrics/base.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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",
    }

name: str property ¤

Returns the name of the lyrics provider.

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/base.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
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) ¤

Returns the lyrics for the given song.

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/base.py 
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
def get_lyrics(self, name: str, artists: List[str], **kwargs) -> Optional[str]:
    """
    Returns the lyrics for the given song.

    ### 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:
        results = self.get_results(name, artists, **kwargs)
    except Exception as exc:
        logger.debug(
            "%s: Failed to get results for %s - %s: %s",
            self.name,
            name,
            ", ".join(artists),
            exc,
        )
        return None

    if not results:
        return None

    results_with_score = {}
    for title, url in results.items():
        result_title = slugify(title)
        match_title = slugify(f"{name} - {', '.join(artists)}")

        res_list, song_list = based_sort(
            result_title.split("-"), match_title.split("-")
        )
        result_title, match_title = "-".join(res_list), "-".join(song_list)

        score = ratio(result_title, match_title)
        results_with_score[score] = url

    if not results_with_score:
        return None

    # Get song url with highest title match
    score, url = max(results_with_score.items(), key=lambda x: x[0])

    # Only return lyrics if the title match is at least 55%
    if score < 55:
        return None

    try:
        return self.extract_lyrics(url, **kwargs)
    except Exception as exc:
        logger.debug(
            "%s: Failed to extract lyrics from %s: %s", self.name, url, exc
        )
        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/base.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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