Base

Inheritance diagram of musify.base

The fundamental core classes for the entire package.

Classes:

Result()

Stores the results of an operation

MusifyObject()

Generic base class for any nameable and taggable object.

MusifyItem()

Generic class for storing an item.

MusifyItemSettable()

Generic class for storing an item that can have select properties modified.

HasLength()

Simple protocol for an object which has a length

class musify.base.Result

Bases: object

Stores the results of an operation

class musify.base.MusifyObject

Bases: AttributePrinter

Generic base class for any nameable and taggable object.

Attributes:

tag_sep

When representing a list of tags as a string, use this value as the separator.

name

A name for this object

clean_tags

A map of tags that have been cleaned to use when matching/searching

tag_sep: str = '; '

When representing a list of tags as a string, use this value as the separator.

abstract property name: str

A name for this object

property clean_tags: dict[TagField, Any]

A map of tags that have been cleaned to use when matching/searching

class musify.base.MusifyItem

Bases: MusifyObject

Generic class for storing an item.

Attributes:

uri

URI (Uniform Resource Indicator) is the unique identifier for this item.

has_uri

Does this track have a valid associated URI.

abstract property uri: str | None

URI (Uniform Resource Indicator) is the unique identifier for this item.

abstract property has_uri: bool | None

Does this track have a valid associated URI. When None, answer is unknown.

class musify.base.MusifyItemSettable

Bases: MusifyItem

Generic class for storing an item that can have select properties modified.

Attributes:

uri

URI (Uniform Resource Indicator) is the unique identifier for this item.

property uri

URI (Uniform Resource Indicator) is the unique identifier for this item.

class musify.base.HasLength

Bases: object

Simple protocol for an object which has a length

Attributes:

length

Total duration of this object in seconds

abstract property length

Total duration of this object in seconds