upsies.utils.webdbs.base

Abstract base class for online databases

Classes

class upsies.utils.webdbs.base.WebDbApiBase(config=None)

Bases: ABC

Base class for all web DB APIs

Not all DBs provide all information. Methods that take an id argument may return an empty string, an empty tuple or None.

abstract property name

Unique name of this DB

abstract property label

User-facing name of this DB

property no_results_info

Hints for the user to find something

This should be displayed if there are no search results.

property config

User configuration

This is a deep copy of default_config that is updated with the config argument from initialization.

abstract property default_config

Default user configuration as a dictionary

sanitize_query(query)

Modify Query for specific DB

If get_id_from_text() finds an ID in Query.title, Query.id is set to that ID, which means all other query parameters are ignored.

abstractmethod get_id_from_text(text)

Return ID found in text or None

abstractmethod async search(query)

Search DB

Parameters:

query – Query instance

Returns:

List of SearchResult instances

abstractmethod async cast(id)

Return list of cast names

async countries(id)

Return list of country names

abstractmethod async languages(id)

Return list of spoken languages

abstractmethod async creators(id)

Return list of creator names (usually empty for movies and episodes)

abstractmethod async directors(id)

Return list of director names (usually empty for series)

abstractmethod async genres(id)

Return list of genres

abstractmethod async poster_url(id, season=None)

Return URL of poster image or empty string

Parameters:

season –

Return poster for specific season

If this is not supported by the concrete implementation, default to the URL for the main poster.

async poster(id, season=None)

Return poster image as binary data or None

Parameters:

season –

Return poster for specific season

If this is not supported by the concrete implementation, default to the main poster.

abstractmethod async rating(id)

Return rating as a number or None

abstract property rating_min

Minimum rating() value

abstract property rating_max

Maximum rating() value

async runtimes(id)

Return mapping of runtimes

Keys are descriptive strings (e.g. “Director’s Cut”, “Ultimate Cut”, etc) and values are the runtime in minutes (:class:int).

The key of the default cut is default.

abstractmethod async summary(id)

Return short plot description

async title_original(id)

Return original title

See also title_english().

async title_english(id, *, default_to_original=False)

Return English title (AKA) or empty string

If the English title is too similar to the original title, return an empty string.

Titles are considered too similar if they are equal or either one contains the other after normalization.

Titles are normalized by casefolding, removing whitespace, translating roman numerals to arabic, etc.

For example, if the original title is “Föö & Bár II” and the English title is “The Foo and Bar 2”, the titles are too similar.

Parameters:

default_to_original – Instead of defaulting to an empty string if no appropriate English title is found, default to the original title

abstractmethod async type(id)

Return ReleaseType

abstractmethod async url(id)

Return URL for id

abstractmethod async year(id)

Return release year or empty string

async gather(id, *methods)

Fetch information concurrently

Parameters:

• id – Valid ID for this DB

• methods (sequence of str) – Names of coroutine methods of this class

Returns:

Dictionary that maps methods to return values