Mopidy-Podcast¶

Mopidy-Podcast Data Models¶

Mopidy-Podcast extends Mopidy’s data model by providing additional domain-specific types. These immutable data models are used for all data transfer between Mopidy-Podcast extensions and the Mopidy-Podcast core module. The intricacies of converting from/to Mopidy’s native data models are left to the Mopidy-Podcast module, so extension developers can work solely with domain objects.

These models are based on Apple’s – rather informal – podcast specification, which in turn is based on RSS 2.0.

class mopidy_podcast.models.Podcast(*args, **kwargs)¶

Mopidy model type to represent a podcast.

Parameters:

uri (string) – podcast URI title (string) – podcast title link (string) – Web site URI copyright (string) – copyright notice language (string) – ISO two-letter language code pubdate (datetime.datetime) – publication date and time author (string) – author name block (boolean) – prevent the podcast from appearing category (string) – main category image (Image) – podcast image explicit (boolean) – whether the podcast contains explicit material complete (boolean) – whether the podcast is complete newfeedurl (string) – new feed location subtitle (string) – short description summary (string) – long description episodes (list of Episode) – podcast episodes

author = None¶

The podcast’s author’s name.

block = None¶

Prevent a podcast from appearing in the directory.

category = None¶

The main category of the podcast.

complete = None¶

Indicates completion of the podcast.

copyright = None¶

The podcast’s copyright notice.

episodes = ()¶

The podcast’s episodes as a read-only tuple of Episode instances.

explicit = None¶

Indicates whether the podcast contains explicit material.

image = None¶

An image to be displayed with the podcast as an instance of Image.

language = None¶

The podcast’s ISO two-letter language code.

link = None¶

The URL of the HTML website corresponding to the podcast.

newfeedurl = None¶

Used to inform of new feed URL location.

pubdate = None¶

The podcast’s publication date and time as an instance of datetime.datetime.

subtitle = None¶

A short description of the podcast.

summary = None¶

A description of the podcast, up to 4000 characters long.

title = None¶

The podcast’s title.

uri = None¶

The podcast URI.

For podcasts distributed as RSS feeds, the podcast URI is the URL from which the RSS feed can be retrieved.

To distinguish between podcast and episode URIs, the podcast URI MUST NOT contain a fragment identifier.

class mopidy_podcast.models.Episode(*args, **kwargs)¶

Mopidy model type to represent a podcast episode.

Parameters:

uri (string) – episode URI title (string) – episode title guid (string) – globally unique identifier pubdate (datetime.datetime) – publication date and time author (string) – author name block (boolean) – prevent the episode from appearing image (Image) – episode image duration (datetime.timedelta) – episode duration explicit (boolean) – whether the podcast contains explicit material order (integer) – override default ordering subtitle (string) – short description summary (Enclosure) – long description enclosure – media object

author = None¶

The episode’s author’s name.

block = None¶

Prevent an episode from appearing in the directory.

duration = None¶

The episode’s duration as an instance of datetime.timedelta.

enclosure = None¶

The media object, e.g. the audio stream, attached to the episode as an instance of Enclosure.

explicit = None¶

Indicates whether the episode contains explicit material.

guid = None¶

A string that uniquely identifies the episode.

image = None¶

An image to be displayed with the episode as an instance of Image.

order = None¶

Overrides the default ordering of episodes.

pubdate = None¶

The episode’s publication date and time as an instance of datetime.datetime.

subtitle = None¶

A short description of the episode.

summary = None¶

A description of the episode, up to 4000 characters long.

title = None¶

The episode’s title.

uri = None¶

The episode URI.

If the episode contains an enclosure, the episode URI MUST consist of the associated podcast URI with the enclosure URL appended as a fragment identifier.

class mopidy_podcast.models.Image(*args, **kwargs)¶

Mopidy model type to represent a podcast’s image.

Parameters:	uri (string) – image URI title – image title width (integer or None) – image width in pixels height (integer or None) – image height in pixels

height = None¶

The image’s height in pixels.

title = None¶

The image’s title.

uri = None¶

The image’s URI.

width = None¶

The image’s width in pixels.

class mopidy_podcast.models.Enclosure(*args, **kwargs)¶

Mopidy model type to represent an episode’s media object.

Parameters:	uri (string) – enclosure URI length (integer) – enclosure file size in bytes type (string) – enclosure MIME type

length = None¶

The enclosure’s file size in bytes.

type = None¶

The MIME type of the enclosure, e.g. audio/mpeg.

uri = None¶

The URI of the media object.

class mopidy_podcast.models.Ref(*args, **kwargs)¶

Extends mopidy.models.Ref to provide factory methods and type constants for Podcast and Episode.

Parameters:	uri (string) – object URI name (string) – object name type (string) – object type

EPISODE = u'episode'¶

Constant used for comparison with the type field.

PODCAST = u'podcast'¶

Constant used for comparison with the type field.

classmethod episode(**kwargs)¶

Create a Ref with type EPISODE.

classmethod podcast(**kwargs)¶

Create a Ref with type PODCAST.

Mopidy-Podcast Directory Provider¶

A PodcastDirectory provides access to collections (also termed directories in Mopidy), podcasts and episodes, possibly via an external directory service. Each PodcastDirectory instance manages its own private namespace of URI references, all starting with an absolute path and optionally containg a query string and fragment identifier. The URI reference / specifies the root of a podcast directory, and any two podcast directories may use the same URI reference, e.g. /Music?topPodcasts, for different resources.

A PodcastDirectory may also register one or more URI schemes via the uri_schemes attribute. For example, the feeds directory bundled with Mopidy-Podcast already registers the file, ftp, http and https schemes, assuming URIs with these schemes point to podcast RSS feeds. By returning an absolute URI with one of these schemes, a podcast directory actually delegates retrieving and parsing the respective resource to the feeds directory.

class mopidy_podcast.directory.PodcastDirectory(config)¶

Podcast directory provider.

name = None¶

Name of the podcast directory implementation.

Subclasses must override this attribute with a string starting with an ASCII character and consisting solely of ASCII characters, digits and hyphens (-).

root_name = None¶

Name of the root directory for browsing.

Subclasses must override this attribute if they implement the browse() method.

uri_schemes = []¶

List of URI schemes the directory can handle.

Subclasses that provide support for additional URI schemes must implement the get() method for the specified schemes, and must also support absolute URIs in their browse() and search() methods.

Note that the file, ftp, http and https schemes are already handled by the feeds directory implementation.

get(uri)¶

Return a podcast for the given uri.

uri is an absolute URI corresponding to one of the configured uri_schemes.

If a subclass does not override uri_schemes, this method need not be implemented.

Parameters:	uri (string) – podcast URI
Return type:	mopidy_podcast.models.Podcast

browse(uri, limit=None)¶

Browse directories, podcasts and episodes at the given uri.

uri may be either a URI reference starting with /, or an absolute URI with one of the configured uri_schemes.

limit specifies the maximum number of objects to return, or None if no such limit is given.

Returns a list of mopidy_podcast.models.Ref objects for the directories, podcasts and episodes at the given uri.

Parameters:	uri (string) – browse URI limit (int) – browse limit
Return type:	mopidy_podcast.models.Ref iterable

search(uri, terms, attr=None, type=None, limit=None)¶

Search podcasts and episodes at the given uri for terms.

uri may be either a URI reference starting with /, or an absolute URI with one of the configured uri_schemes.

terms is a list of strings specifying search terms.

attr may be an attribute name which must be matched, or None if any attribute may match terms.

type, if given, specifies the type of items to search for, and must be either mopidy_podcast.models.Ref.PODCAST or mopidy_podcast.models.Ref.EPISODE.

limit specifies the maximum number of objects to return, or None if no such limit is given.

Returns a list of mopidy_podcast.models.Ref objects for the matching podcasts and episodes found at the given uri.

Parameters:	uri (string) – browse URI terms (list of strings) – search terms attr (string) – search attribute type (string) – search result type limit (int) – search limit
Return type:	mopidy_podcast.models.Ref iterable

refresh(uri=None)¶

Refresh the podcast directory.

This method is called right after __init__() and should be used to perform potentially time-consuming initialization, such as retrieving data from a Web site.

This method may also be called periodically as a request to update any locally cached data.

Parameters:	uri (string) – refresh URI