************************************
:mod:`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
:meth:`~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
====================

.. digraph:: 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
==============

.. module:: mopidy.models
    :synopsis: Data model API

.. autoclass:: mopidy.models.Ref
    :members:

.. autoclass:: mopidy.models.Track
    :members:

.. autoclass:: mopidy.models.Album
    :members:

.. autoclass:: mopidy.models.Artist
    :members:

.. autoclass:: mopidy.models.Playlist
    :members:

.. autoclass:: mopidy.models.Image
    :members:

.. autoclass:: mopidy.models.TlTrack
    :members:

.. autoclass:: mopidy.models.SearchResult
    :members:


Data model helpers
==================

.. autoclass:: mopidy.models.ValidatedImmutableObject
    :members: replace

Data model (de)serialization
----------------------------

.. autofunction:: mopidy.models.model_json_decoder

.. autoclass:: mopidy.models.ModelJSONEncoder

Data model field types
----------------------

.. autoclass:: mopidy.models.fields.Field

.. autoclass:: mopidy.models.fields.String

.. autoclass:: mopidy.models.fields.Identifier

.. autoclass:: mopidy.models.fields.URI

.. autoclass:: mopidy.models.fields.Date

.. autoclass:: mopidy.models.fields.Integer

.. autoclass:: mopidy.models.fields.Collection
