Titles API¶

Auto-generated reference for the title model: Movies, Series/Episodes, and Music/Albums/Songs. A service returns one of these collections from its title lookup. See Creating a Service.

Episode ¶

Episode(
    id_,
    service,
    title,
    season,
    number,
    name=None,
    year=None,
    language=None,
    data=None,
    description=None,
    air_date=None,
)

Bases: Title

Movie ¶

Movie(
    id_,
    service,
    name,
    year=None,
    language=None,
    data=None,
    description=None,
)

Bases: Title

Album ¶

Album(
    iterable=None,
    kind="album",
    title=None,
    artist=None,
    year=None,
    total_tracks=None,
    total_discs=None,
    artwork_url=None,
    total_duration=None,
    owner=None,
    description=None,
)

Bases: Music

Backward-compatible collection name for album-style music releases.

Music ¶

Music(
    iterable=None,
    kind="album",
    title=None,
    artist=None,
    year=None,
    total_tracks=None,
    total_discs=None,
    artwork_url=None,
    total_duration=None,
    owner=None,
    description=None,
)

Bases: SortedKeyList, ABC

A grouped music release, such as an album, EP, single, compilation, or playlist.

Song ¶

Song(
    id_,
    service,
    name,
    artist,
    album,
    track,
    disc,
    year,
    language=None,
    data=None,
    album_artist=None,
    release_type="album",
    total_tracks=None,
    total_discs=None,
    genre=None,
    explicit=None,
    isrc=None,
    upc=None,
    copyright=None,
    label=None,
    lyrics=None,
    artwork_url=None,
)

Bases: Title

remap_titles ¶

remap_titles(titles, title_map)

Rewrite titles in-place using an exact-match title_map.

Some services name a title differently from how the user wants it stored, which can break library matching. title_map maps a source title string to the desired output title. Episodes are matched on their title (the show name), Movies and Songs on their name. Returns the same collection for convenient chaining.