Factory

Inheritance diagram of musify.libraries.remote.spotify.factory

Configuration relating to the Spotify module.

This configuration can be used to inject dependencies into dependencies throughout the module.

Classes:

SpotifyObjectFactory([playlist, track, ...])

class musify.libraries.remote.spotify.factory.SpotifyObjectFactory(playlist=<class 'musify.libraries.remote.spotify.object.SpotifyPlaylist'>, track=<class 'musify.libraries.remote.spotify.object.SpotifyTrack'>, album=<class 'musify.libraries.remote.spotify.object.SpotifyAlbum'>, artist=<class 'musify.libraries.remote.spotify.object.SpotifyArtist'>, api=None)

Bases: RemoteObjectFactory

Classes:

playlist

alias of SpotifyPlaylist

track

alias of SpotifyTrack

album

alias of SpotifyAlbum

artist

alias of SpotifyArtist

playlist

alias of SpotifyPlaylist Attributes:

collaborative

Are other users allowed to modify this playlist

date_added

A map of {<URI>: <date>} for each item for when that item was added to the playlist

date_created

datetime object representing when the first track was added to this playlist

date_modified

datetime object representing when a track was most recently added/removed

description

Description of this playlist

followers

The number of followers this playlist has

has_image

Does this playlist have an image

image_links

The images associated with this playlist in the form {<image name/type>: <image link>}

name

A name for this object

owner_id

The ID of the owner of this playlist

owner_name

The name of the owner of this playlist

public

Can other users access this playlist

track_total

The total number of tracks in this playlist

tracks

The tracks in this playlist

Methods:

refresh([skip_checks])

Refresh this object by updating from the stored API response.

reload([extend_tracks, extend_features])

Reload this object from the API, calling all required endpoints to get a complete set of data for this item type.

track

alias of SpotifyTrack Attributes:

album

The album this track is featured on

album_artist

The artist of the album this track is featured on

artist

Joined string representation of all artists featured on this track

artists

List of all artists featured on this track.

bpm

The tempo of this track

comments

Comments associated with this track set by the user

compilation

Is the album this track is featured on a compilation

day

The day this track was released

disc_number

The number of the disc from the album this track is featured on

disc_total

The total number the discs from the album this track is featured on

genres

List of genres for the album this track is featured on.

has_image

Does the album this track is associated with have an image

image_links

The images associated with the album this track is featured on in the form {<image name/type>: <image link>}

key

The key of this track in alphabetical musical notation format

length

Total duration of this track in seconds

month

The month this track was released

name

A name for this object

rating

The rating for this track

title

This track's title

track_number

The position this track has on the album it is featured on

track_total

The track number of tracks on the album this track is featured on

year

The year this track was released

Methods:

load(value, api[, features, analysis, ...])

Generate a new object of this class, calling all required endpoints to get a complete set of data for this item type.

refresh([skip_checks])

Refresh this object by updating from the stored API response.

reload([features, analysis, extend_album, ...])

Reload this object from the API, calling all required endpoints to get a complete set of data for this item type.

album

alias of SpotifyAlbum Attributes:

album_artist

The album artist for this album

artist

Joined string representation of all artists on this album ordered by frequency of appearance

artists

List of artists ordered by frequency of appearance on the tracks on this album

compilation

Is this album a compilation

day

The day this album was released

genres

List of genres ordered by frequency of appearance on the tracks on this album

has_image

Does this album have an image

image_links

The images associated with this album in the form {<image name/type>: <image link>}

month

The month this album was released

name

The album name

rating

Rating of this album

track_total

The total number of tracks on this album

tracks

The tracks on this album

year

The year this album was released

Methods:

refresh([skip_checks])

Refresh this object by updating from the stored API response.

reload([extend_artists, extend_tracks, ...])

Reload this object from the API, calling all required endpoints to get a complete set of data for this item type.

artist

alias of SpotifyArtist Attributes:

albums

List of albums ordered by frequency of appearance on the tracks by this artist

artist

The artist name

followers

The total number of followers for this artist

genres

List of genres for this artist

image_links

The images associated with this artist in the form {<image name/type>: <image link>}

items

The albums this artist is featured on

name

The artist name

rating

The popularity of this artist

Methods:

refresh([skip_checks])

Refresh this object by updating from the stored API response.

reload([extend_albums, extend_tracks, ...])

Reload this object from the API, calling all required endpoints to get a complete set of data for this item type.