musixmatch-master/musixmatch/lyrics.py

Go to the documentation of this file.

"""
This module contains higher level classes to query Musixmatch API and build
simple dictionary-like objects representing a track lyrics.

>>> from musixmatch.lyrics import Lyrics
>>> import musixmatch.api
>>> 
>>> try:
...     lyrics = Lyrics(lyrics_id=292)
... except musixmatch.api.Error, e:
...     pass
"""
import musixmatch
__license__ = musixmatch.__license__
__author__ = musixmatch.__author__

from musixmatch.base import Item
from musixmatch.ws import track

class Lyrics(Item):
    """
    This class builds a :py:class:`dict` object representing a the lyrics of a
    track. It can get lyrics through the :py:class:`musixmatch.api.Method`
    **track.lyrics.get** or from an already well-formed :py:class:`dict`.
    Create a Track object based on a given keyword argument:

    :param track_id: musiXmatch track ID
    :param musicbrainz_id: Musicbrainz track ID
    :param track_echonest_id: Echonest track ID
    :param lyrics_data: an already well-formed :py:class:`dict` of track data
    :raises: :py:class:`musixmatch.api.Error` if :py:class:`musixmatch.api.ResponseStatusCode` is not 200

    Once information are collected, the following keys are available:

    :keyword lyrics_body: the lyrics text
    :keyword lyrics_id: the Musixmatch lyrics id
    :keyword lyrics_language: the lyrics language
    :keyword lyrics_copyright: the lyrics copyright statement
    :keyword pixel_tracking_url: the pixel tracking url
    :keyword script_tracking_url: the script tracking url
    """
    __api_method__ = track.lyrics.get