Data models

Bases: BaseModel

An album.

Methods:

• replace –

  Return a new instance with updated fields.

• serialize –

  Serialize the model to a dict.

Attributes:

• artists (frozenset[Artist]) –

  A set of album artists.

• date (DateOrYear | None) –

  The album release date. A string formatted as "YYYY" or "YYYY-MM-DD".

• musicbrainz_id (UUID | None) –

  The MusicBrainz ID of the album.

• name (str | None) –

  The album name.

• num_discs (NonNegativeInt | None) –

  The number of discs in the album.

• num_tracks (NonNegativeInt | None) –

  The number of tracks in the album.

• uri (Uri | None) –

  The album URI.

artists: frozenset[Artist] = frozenset()

date: DateOrYear | None = Field(
    default=None, pattern="^\\d{4}(-\\d{2}-\\d{2})?$"
)

musicbrainz_id: UUID | None = None

name: str | None = None

num_discs: NonNegativeInt | None = None

num_tracks: NonNegativeInt | None = None

uri: Uri | None = None

replace(**updated_fields: Any) -> Self

serialize() -> dict[str, Any]

Bases: BaseModel

An artist.

Methods:

• replace –

  Return a new instance with updated fields.

• serialize –

  Serialize the model to a dict.

Attributes:

• musicbrainz_id (UUID | None) –

  The MusicBrainz ID of the artist.

• name (str | None) –

  The artist name.

• sortname (str | None) –

  Artist name for better sorting, e.g. with articles stripped.

• uri (Uri | None) –

  The artist URI.

musicbrainz_id: UUID | None = None

name: str | None = None

sortname: str | None = None

uri: Uri | None = None

replace(**updated_fields: Any) -> Self

serialize() -> dict[str, Any]

Bases: BaseModel

An image with a URI and dimensions.

Methods:

• replace –

  Return a new instance with updated fields.

• serialize –

  Serialize the model to a dict.

Attributes:

• height (NonNegativeInt | None) –

  Height of the image in pixels.

• uri (Uri) –

  The image URI.

• width (NonNegativeInt | None) –

  Width of the image in pixels.

height: NonNegativeInt | None = None

uri: Uri

width: NonNegativeInt | None = None

replace(**updated_fields: Any) -> Self

serialize() -> dict[str, Any]

Bases: StrEnum

Enumeration of model types.

Attributes:

• ALBUM –

  An album.

• ARTIST –

  An artist.

• DIRECTORY –

  A directory.

• PLAYLIST –

  A playlist.

• TRACK –

  A track.

ALBUM = 'album'

ARTIST = 'artist'

DIRECTORY = 'directory'

PLAYLIST = 'playlist'

TRACK = 'track'

Bases: BaseModel

A playlist.

Methods:

• replace –

  Return a new instance with updated fields.

• serialize –

  Serialize the model to a dict.

Attributes:

• last_modified (NonNegativeInt | None) –

  The playlist modification time in milliseconds since Unix epoch.

• length (NonNegativeInt) –

  The number of tracks in the playlist.

• name (str | None) –

  The playlist name.

• tracks (tuple[Track, ...]) –

  The playlist's tracks.

• uri (Uri) –

  The playlist URI.

last_modified: NonNegativeInt | None = None

length: NonNegativeInt

name: str | None = None

tracks: tuple[Track, ...] = ()

uri: Uri

replace(**updated_fields: Any) -> Self

serialize() -> dict[str, Any]

Bases: BaseModel

Model to represent URI references with a human friendly name and type.

This is intended for use a lightweight object "free" of metadata that can be passed around instead of using full blown models.

Methods:

• album –

  Create a Ref with type ALBUM.

• artist –

  Create a Ref with type ARTIST.

• directory –

  Create a Ref with type DIRECTORY.

• playlist –

  Create a Ref with type PLAYLIST.

• replace –

  Return a new instance with updated fields.

• serialize –

  Serialize the model to a dict.

• track –

  Create a Ref with type TRACK.

Attributes:

• name (str | None) –

  The object name.

• type (ModelType) –

  The object type, e.g. "artist", "album", "track", "playlist", "directory".

• uri (Uri) –

  The object URI.

name: str | None = None

type: ModelType

uri: Uri

album(*, uri: Uri, name: str | None = None) -> Self

artist(*, uri: Uri, name: str | None = None) -> Self

directory(*, uri: Uri, name: str | None = None) -> Self

playlist(*, uri: Uri, name: str | None = None) -> Self

replace(**updated_fields: Any) -> Self

serialize() -> dict[str, Any]

track(*, uri: Uri, name: str | None = None) -> Self

Bases: BaseModel

A search result.

Methods:

• replace –

  Return a new instance with updated fields.

• serialize –

  Serialize the model to a dict.

Attributes:

• albums (tuple[Album, ...]) –

  The albums matching the search query.

• artists (tuple[Artist, ...]) –

  The artists matching the search query.

• tracks (tuple[Track, ...]) –

  The tracks matching the search query.

• uri (Uri | None) –

  The search result URI.

albums: tuple[Album, ...] = ()

artists: tuple[Artist, ...] = ()

tracks: tuple[Track, ...] = ()

uri: Uri | None = None

replace(**updated_fields: Any) -> Self

serialize() -> dict[str, Any]

Bases: BaseModel

A tracklist track. Wraps a regular track and it's tracklist ID.

The use of TlTrack allows the same track to appear multiple times in the tracklist.

This class also accepts it's parameters as positional arguments. Both arguments must be provided, and they must appear in the order they are listed here.

This class also supports iteration, so you can extract its values like this:

(tlid, track) = tl_track

Methods:

• replace –

  Return a new instance with updated fields.

• serialize –

  Serialize the model to a dict.

Attributes:

• tlid (TracklistId) –

  The tracklist ID.

• track (Track) –

  The track.

tlid: TracklistId = Field(..., ge=1)

track: Track

replace(**updated_fields: Any) -> Self

serialize() -> dict[str, Any]

Bases: BaseModel

An audio track.

Methods:

• replace –

  Return a new instance with updated fields.

• serialize –

  Serialize the model to a dict.

Attributes:

• album (Album | None) –

  The track album.

• artists (frozenset[Artist]) –

  A set of track artists.

• bitrate (NonNegativeInt | None) –

  The track's bitrate in kbit/s.

• comment (str | None) –

  The track comment.

• composers (frozenset[Artist]) –

  A set of track composers.

• date (DateOrYear | None) –

  The track release date. A string formatted as "YYYY" or "YYYY-MM-DD".

• disc_no (NonNegativeInt | None) –

  The disc number in the album.

• genre (str | None) –

  The track genre.

• last_modified (NonNegativeInt | None) –

  Integer representing when the track was last modified.

• length (DurationMs | None) –

  The track length in milliseconds.

• musicbrainz_id (UUID | None) –

  The MusicBrainz ID of the track.

• name (str | None) –

  The track name.

• performers (frozenset[Artist]) –

  A set of track performers.

• track_no (NonNegativeInt | None) –

  The track number in the album.

• uri (Uri) –

  The track URI.

album: Album | None = None

artists: frozenset[Artist] = frozenset()

bitrate: NonNegativeInt | None = None

comment: str | None = None

composers: frozenset[Artist] = frozenset()

date: DateOrYear | None = Field(
    default=None, pattern="^\\d{4}(-\\d{2}-\\d{2})?$"
)

disc_no: NonNegativeInt | None = None

genre: str | None = None

last_modified: NonNegativeInt | None = None

length: DurationMs | None = None

musicbrainz_id: UUID | None = None

name: str | None = None

performers: frozenset[Artist] = frozenset()

track_no: NonNegativeInt | None = None

uri: Uri

replace(**updated_fields: Any) -> Self

serialize() -> dict[str, Any]