Enums & Errors

This page documents the enums and errors of the backend. These values are consistent across all program instances.

Enums

class src.enums.ArtistRole(value)

The possible artist roles.

MAIN = 1
FEATURE = 2
REMIXER = 3
PRODUCER = 4
COMPOSER = 5
CONDUCTOR = 6
DJMIXER = 7
class src.enums.ReleaseType(value)

The available release types.

ALBUM = 1
SINGLE = 2
EP = 3
COMPILATION = 4
SOUNDTRACK = 5
SPOKENWORD = 6
LIVE = 7
REMIX = 8
DJMIX = 9
MIXTAPE = 10
OTHER = 11
UNKNOWN = 12
class src.enums.CollectionType(value)

The available collection types.

SYSTEM = 1
PERSONAL = 2
COLLAGE = 3
LABEL = 4
GENRE = 5
class src.enums.PlaylistType(value)

The available playlist types.

SYSTEM = 1
PERSONAL = 2
PLAYLIST = 3
class src.enums.ReleaseSort(value)

The possible ways to sort releases; used when querying the database for a list of releases. The enum values are templates with an $order key–this key should be ASC or DESC.

RECENTLY_ADDED = <string.Template object>
TITLE = <string.Template object>
YEAR = <string.Template object>
RATING = <string.Template object>
RANDOM = <string.Template object>
SEARCH_RANK = <string.Template object>
class src.enums.TrackSort(value)

The possible ways to sort tracks; used when querying the database for a list of tracks. The enum values are templates with an $order key–this key should be ASC or DESC.

The RECENTLY_ADDED, YEAR methods sort on the release fields and then on the track’s disc and track numbers.

RECENTLY_ADDED = <string.Template object>
TITLE = <string.Template object>
YEAR = <string.Template object>
RANDOM = <string.Template object>
SEARCH_RANK = <string.Template object>

Errors

exception src.errors.BackendError

Bases: Exception

exception src.errors.CliError

Bases: src.errors.BackendError

exception src.errors.InvalidConfig

Bases: src.errors.BackendError

exception src.errors.LibError(message=None, *args, **kwargs)

Bases: src.errors.BackendError

message: Optional[str]

The error message.

exception src.errors.InvalidNickname(*args, **kwargs)

Bases: src.errors.LibError

This error does not accept a message as a part of its constructor.

The message is static to the exception.

exception src.errors.TokenGenerationFailure(message=None, *args, **kwargs)

Bases: src.errors.LibError

exception src.errors.CodeGenerationFailure(message=None, *args, **kwargs)

Bases: src.errors.LibError

exception src.errors.InvalidCollectionType(message=None, *args, **kwargs)

Bases: src.errors.LibError

exception src.errors.InvalidPlaylistType(message=None, *args, **kwargs)

Bases: src.errors.LibError

exception src.errors.InvalidArgument(message=None, *args, **kwargs)

Bases: src.errors.LibError

exception src.errors.Immutable(message=None, *args, **kwargs)

Bases: src.errors.LibError

exception src.errors.NotFound(message=None, *args, **kwargs)

Bases: src.errors.LibError

exception src.errors.Duplicate(message=None, entity=None, *args, **kwargs)

Bases: src.errors.LibError

entity: Any

The duplicate entity.

exception src.errors.AlreadyExists(message=None, *args, **kwargs)

Bases: src.errors.LibError

exception src.errors.DoesNotExist(message=None, *args, **kwargs)

Bases: src.errors.LibError

exception src.errors.ParseError(message=None, *args, **kwargs)

Bases: src.errors.LibError

exception src.errors.InvalidImage(message=None, *args, **kwargs)

Bases: src.errors.LibError