Skip to content

Latest commit

 

History

History
113 lines (76 loc) · 2.9 KB

models.rst

File metadata and controls

113 lines (76 loc) · 2.9 KB
Raw

mopidy.models --- Data models

These immutable data models are used for all data transfer within the Mopidy backends and between the backends and the MPD frontend. All fields are optional and immutable. In other words, they can only be set through the class constructor during instance creation. Additionally fields are type checked.

If you want to modify a model, use the ~mopidy.models.ImmutableObject.replace method. It accepts keyword arguments for the parts of the model you want to change, and copies the rest of the data from the model you call it on. Example:

>>> from mopidy.models import Track
>>> track1 = Track(name='Christmas Carol', length=171)
>>> track1
Track(artists=[], length=171, name='Christmas Carol')
>>> track2 = track1.replace(length=37)
>>> track2
Track(artists=[], length=37, name='Christmas Carol')
>>> track1
Track(artists=[], length=171, name='Christmas Carol')

Data model relations

model_relations

Ref -> Album [ style="dotted", weight=1 ] Ref -> Artist [ style="dotted", weight=1 ] Ref -> Directory [ style="dotted", weight=1 ] Ref -> Playlist [ style="dotted", weight=1 ] Ref -> Track [ style="dotted", weight=1 ]

Playlist -> Track [ label="has 0..n", weight=2 ] Track -> Album [ label="has 0..1", weight=10 ] Track -> Artist [ label="has 0..n", weight=10 ] Album -> Artist [ label="has 0..n", weight=10 ]

Image

SearchResult -> Artist [ label="has 0..n", weight=1 ] SearchResult -> Album [ label="has 0..n", weight=1 ] SearchResult -> Track [ label="has 0..n", weight=1 ]

TlTrack -> Track [ label="has 1", weight=20 ]

Data model API

mopidy.models

mopidy.models.Ref

mopidy.models.Track

mopidy.models.Album

mopidy.models.Artist

mopidy.models.Playlist

mopidy.models.Image

mopidy.models.TlTrack

mopidy.models.SearchResult

Data model helpers

mopidy.models.ImmutableObject

mopidy.models.ValidatedImmutableObject

Data model (de)serialization

mopidy.models.model_json_decoder

mopidy.models.ModelJSONEncoder

Data model field types

mopidy.models.fields.Field

mopidy.models.fields.String

mopidy.models.fields.Identifier

mopidy.models.fields.URI

mopidy.models.fields.Date

mopidy.models.fields.Integer

mopidy.models.fields.Collection