musixmatch.track.TracksCollection Class Reference

Inheritance diagram for musixmatch.track.TracksCollection:

Collaboration diagram for musixmatch.track.TracksCollection:

Public Member Functions
def	fromAlbum (cls, keywords)
def	fromSearch (cls, keywords)
def	fromChart (cls, keywords)
def	fromAlbum (cls, keywords)
def	fromSearch (cls, keywords)
def	fromChart (cls, keywords)
def	fromAlbum (cls, keywords)
def	fromSearch (cls, keywords)
def	fromChart (cls, keywords)
def	fromAlbum (cls, keywords)
def	fromSearch (cls, keywords)
def	fromChart (cls, keywords)
Public Member Functions inherited from musixmatch.base.ItemsCollection
def	__init__ (self, items)
def	__repr__ (self)
def	__str__ (self)
def	__add__ (self, iterable)
def	__iadd__ (self, iterable)
def	__mul__ (self, by)
def	__imul__ (self, by)
def	__setitem__ (self, key, item)
def	__setslice__ (self, indices)
def	__getslice__ (self, i=0, j=-1)
def	__getitem__ (self, i)
def	append (self, item)
def	extend (self, iterable)
def	count (self, item)
def	copy (self)
def	index (self, item, indices)
def	insert (self, key, item)
def	paged (self, page_size=3)
def	page (self, page_index, page_size=3)
def	pager (self, page_size=3)
def	pages (self, page_size=3)
def	fromResponseMessage (cls, message)
def	allowedin (cls)
def	label (cls)
def	__init__ (self, items)
def	__repr__ (self)
def	__str__ (self)
def	__add__ (self, iterable)
def	__iadd__ (self, iterable)
def	__mul__ (self, by)
def	__imul__ (self, by)
def	__setitem__ (self, key, item)
def	__setslice__ (self, indices)
def	__getslice__ (self, i=0, j=-1)
def	__getitem__ (self, i)
def	append (self, item)
def	extend (self, iterable)
def	count (self, item)
def	copy (self)
def	index (self, item, indices)
def	insert (self, key, item)
def	paged (self, page_size=3)
def	page (self, page_index, page_size=3)
def	pager (self, page_size=3)
def	pages (self, page_size=3)
def	fromResponseMessage (cls, message)
def	allowedin (cls)
def	label (cls)
def	__init__ (self, items)
def	__repr__ (self)
def	__str__ (self)
def	__add__ (self, iterable)
def	__iadd__ (self, iterable)
def	__mul__ (self, by)
def	__imul__ (self, by)
def	__setitem__ (self, key, item)
def	__setslice__ (self, indices)
def	__getslice__ (self, i=0, j=-1)
def	__getitem__ (self, i)
def	append (self, item)
def	extend (self, iterable)
def	count (self, item)
def	copy (self)
def	index (self, item, indices)
def	insert (self, key, item)
def	paged (self, page_size=3)
def	page (self, page_index, page_size=3)
def	pager (self, page_size=3)
def	pages (self, page_size=3)
def	fromResponseMessage (cls, message)
def	allowedin (cls)
def	label (cls)
def	__init__ (self, items)
def	__repr__ (self)
def	__str__ (self)
def	__add__ (self, iterable)
def	__iadd__ (self, iterable)
def	__mul__ (self, by)
def	__imul__ (self, by)
def	__setitem__ (self, key, item)
def	__setslice__ (self, indices)
def	__getslice__ (self, i=0, j=-1)
def	__getitem__ (self, i)
def	append (self, item)
def	extend (self, iterable)
def	count (self, item)
def	copy (self)
def	index (self, item, indices)
def	insert (self, key, item)
def	paged (self, page_size=3)
def	page (self, page_index, page_size=3)
def	pager (self, page_size=3)
def	pages (self, page_size=3)
def	fromResponseMessage (cls, message)
def	allowedin (cls)
def	label (cls)
Public Member Functions inherited from musixmatch.base.Base
def	label (cls)
def	apiMethod (cls)
def	__str__ (self)
def	__repr__ (self)
def	label (cls)
def	apiMethod (cls)
def	__str__ (self)
def	__repr__ (self)
def	label (cls)
def	apiMethod (cls)
def	__str__ (self)
def	__repr__ (self)
def	label (cls)
def	apiMethod (cls)
def	__str__ (self)
def	__repr__ (self)

Static Private Attributes
	__allowedin__ = Track

Detailed Description

This class build a :py:class:`list` like object representing a tracks
collection. It accepts :py:class:`dict` or :py:class:`Track` objects.

Definition at line 116 of file musixmatch-master/build/lib/musixmatch/track.py.

Member Function Documentation

def musixmatch.track.TracksCollection.fromAlbum	(		cls,
			keywords
	)

This classmethod builds an :py:class:`TracksCollection` from a
**album.tracks.get** :py:class:`musixmatch.api.Method` call.

:param album_id: musiXmatch album ID

Definition at line 124 of file musixmatch-master/build/lib/musixmatch/track.py.

Referenced by musixmatch.track.TracksCollection.fromAlbum().

def musixmatch.track.TracksCollection.fromAlbum	(		cls,
			keywords
	)

This classmethod builds an :py:class:`TracksCollection` from a
**album.tracks.get** :py:class:`musixmatch.api.Method` call.

:param album_id: musiXmatch album ID

Definition at line 124 of file musixmatch-master/musixmatch/track.py.

def musixmatch.track.TracksCollection.fromAlbum	(		cls,
			keywords
	)

This classmethod builds an :py:class:`TracksCollection` from a
**album.tracks.get** :py:class:`musixmatch.api.Method` call.

:param album_id: musiXmatch album ID

Definition at line 124 of file Yading/musixmatch-master/musixmatch/track.py.

def musixmatch.track.TracksCollection.fromAlbum	(		cls,
			keywords
	)

This classmethod builds an :py:class:`TracksCollection` from a
**album.tracks.get** :py:class:`musixmatch.api.Method` call.

:param album_id: musiXmatch album ID

Definition at line 124 of file Yading/musixmatch-master/build/lib/musixmatch/track.py.

def musixmatch.track.TracksCollection.fromChart	(		cls,
			keywords
	)

This classmethod builds an :py:class:`TracksCollection` from a
**track.chart.get** :py:class:`musixmatch.api.Method` call.

:param page: requested page of results
:param page_size: desired number of items per result page
:param country: the country code of the desired country chart
:param f_has_lyrics: exclude tracks without an available lyrics
             (automatic if q_lyrics is set)

Definition at line 160 of file Yading/musixmatch-master/build/lib/musixmatch/track.py.

def musixmatch.track.TracksCollection.fromChart	(		cls,
			keywords
	)

This classmethod builds an :py:class:`TracksCollection` from a
**track.chart.get** :py:class:`musixmatch.api.Method` call.

:param page: requested page of results
:param page_size: desired number of items per result page
:param country: the country code of the desired country chart
:param f_has_lyrics: exclude tracks without an available lyrics
             (automatic if q_lyrics is set)

Definition at line 160 of file Yading/musixmatch-master/musixmatch/track.py.

def musixmatch.track.TracksCollection.fromChart	(		cls,
			keywords
	)

This classmethod builds an :py:class:`TracksCollection` from a
**track.chart.get** :py:class:`musixmatch.api.Method` call.

:param page: requested page of results
:param page_size: desired number of items per result page
:param country: the country code of the desired country chart
:param f_has_lyrics: exclude tracks without an available lyrics
             (automatic if q_lyrics is set)

Definition at line 160 of file musixmatch-master/build/lib/musixmatch/track.py.

Referenced by musixmatch.track.TracksCollection.fromChart().

def musixmatch.track.TracksCollection.fromChart	(		cls,
			keywords
	)

This classmethod builds an :py:class:`TracksCollection` from a
**track.chart.get** :py:class:`musixmatch.api.Method` call.

:param page: requested page of results
:param page_size: desired number of items per result page
:param country: the country code of the desired country chart
:param f_has_lyrics: exclude tracks without an available lyrics
             (automatic if q_lyrics is set)

Definition at line 160 of file musixmatch-master/musixmatch/track.py.

def musixmatch.track.TracksCollection.fromSearch	(		cls,
			keywords
	)

This classmethod builds an :py:class:`TracksCollection` from a
**track.search** :py:class:`musixmatch.api.Method` call.

:param q: a string that will be searched in every data field
  (q_track, q_artist, q_lyrics)
:param q_track: words to be searched among track titles
:param q_artist: words to be searched among artist names
:param q_track_artist: words to be searched among track titles or
               artist names
:param q_lyrics: words to be searched into the lyrics
:param page: requested page of results
:param page_size: desired number of items per result page
:param f_has_lyrics: exclude tracks without an available lyrics
             (automatic if q_lyrics is set)
:param f_artist_id: filter the results by the artist_id
:param f_artist_mbid: filter the results by the artist_mbid
:param quorum_factor: only works together with q and q_track_artist
              parameter. Possible values goes from 0.1 to
              0.9. A value of 0.9 means: 'match at least 90
              percent of the words'.

Definition at line 134 of file musixmatch-master/build/lib/musixmatch/track.py.

Referenced by musixmatch.track.TracksCollection.fromSearch().

def musixmatch.track.TracksCollection.fromSearch	(		cls,
			keywords
	)

This classmethod builds an :py:class:`TracksCollection` from a
**track.search** :py:class:`musixmatch.api.Method` call.

:param q: a string that will be searched in every data field
  (q_track, q_artist, q_lyrics)
:param q_track: words to be searched among track titles
:param q_artist: words to be searched among artist names
:param q_track_artist: words to be searched among track titles or
               artist names
:param q_lyrics: words to be searched into the lyrics
:param page: requested page of results
:param page_size: desired number of items per result page
:param f_has_lyrics: exclude tracks without an available lyrics
             (automatic if q_lyrics is set)
:param f_artist_id: filter the results by the artist_id
:param f_artist_mbid: filter the results by the artist_mbid
:param quorum_factor: only works together with q and q_track_artist
              parameter. Possible values goes from 0.1 to
              0.9. A value of 0.9 means: 'match at least 90
              percent of the words'.

Definition at line 134 of file Yading/musixmatch-master/musixmatch/track.py.

def musixmatch.track.TracksCollection.fromSearch	(		cls,
			keywords
	)

This classmethod builds an :py:class:`TracksCollection` from a
**track.search** :py:class:`musixmatch.api.Method` call.

:param q: a string that will be searched in every data field
  (q_track, q_artist, q_lyrics)
:param q_track: words to be searched among track titles
:param q_artist: words to be searched among artist names
:param q_track_artist: words to be searched among track titles or
               artist names
:param q_lyrics: words to be searched into the lyrics
:param page: requested page of results
:param page_size: desired number of items per result page
:param f_has_lyrics: exclude tracks without an available lyrics
             (automatic if q_lyrics is set)
:param f_artist_id: filter the results by the artist_id
:param f_artist_mbid: filter the results by the artist_mbid
:param quorum_factor: only works together with q and q_track_artist
              parameter. Possible values goes from 0.1 to
              0.9. A value of 0.9 means: 'match at least 90
              percent of the words'.

Definition at line 134 of file musixmatch-master/musixmatch/track.py.

def musixmatch.track.TracksCollection.fromSearch	(		cls,
			keywords
	)

This classmethod builds an :py:class:`TracksCollection` from a
**track.search** :py:class:`musixmatch.api.Method` call.

:param q: a string that will be searched in every data field
  (q_track, q_artist, q_lyrics)
:param q_track: words to be searched among track titles
:param q_artist: words to be searched among artist names
:param q_track_artist: words to be searched among track titles or
               artist names
:param q_lyrics: words to be searched into the lyrics
:param page: requested page of results
:param page_size: desired number of items per result page
:param f_has_lyrics: exclude tracks without an available lyrics
             (automatic if q_lyrics is set)
:param f_artist_id: filter the results by the artist_id
:param f_artist_mbid: filter the results by the artist_mbid
:param quorum_factor: only works together with q and q_track_artist
              parameter. Possible values goes from 0.1 to
              0.9. A value of 0.9 means: 'match at least 90
              percent of the words'.

Definition at line 134 of file Yading/musixmatch-master/build/lib/musixmatch/track.py.

Field Documentation

musixmatch.track.TracksCollection.__allowedin__ = Track

staticprivate

Definition at line 121 of file musixmatch-master/build/lib/musixmatch/track.py.

---

The documentation for this class was generated from the following file:

• musixmatch-master/build/lib/musixmatch/track.py