toktokkie.metadata.tv.components package

Submodules

toktokkie.metadata.tv.components.TvEpisode module

class toktokkie.metadata.tv.components.TvEpisode.TvEpisode(season: int, episode: int)

Bases: toktokkie.metadata.base.components.JsonComponent.JsonComponent

Class that models a TV Episode

__init__(season: int, episode: int)

Initializes the TvEpisode object :param season: The season of the episode :param episode: The episode number

classmethod from_json(json_data: Dict[str, Any]) → toktokkie.metadata.tv.components.TvEpisode.TvEpisode

Generates a TvEpisode object from json data :param json_data: The JSON data :return: The generated TvEpisode object :raises InvalidMetadataException: If the provided JSON is invalid

property json

Returns

The object represented as JSON data

toktokkie.metadata.tv.components.TvEpisodeRange module

class toktokkie.metadata.tv.components.TvEpisodeRange.TvEpisodeRange(season: int, start_episode: int, end_episode: int)

Bases: toktokkie.metadata.base.components.JsonComponent.JsonComponent

Class that models a TV Episode Range

__init__(season: int, start_episode: int, end_episode: int)

Initializes the TvEpisodeRange object :param season: The season :param start_episode: The first episode in the range :param end_episode: The last episode in the range

property episodes

Returns

A list of episodes included in this episode range

classmethod from_json(json_data: Dict[str, Any]) → toktokkie.metadata.tv.components.TvEpisodeRange.TvEpisodeRange

Generates a TvEpisodeRange object based on json data :param json_data: The JSON data :return: The generated TvEpisodeRange object :raises InvalidMetadataException: If the provided JSON is invalid

property json

Returns

A JSON-compatible dictionary representing the object

toktokkie.metadata.tv.components.TvSeason module

class toktokkie.metadata.tv.components.TvSeason.TvSeason(parent_path: str, parent_ids: Dict[toktokkie.enums.IdType, List[str]], ids: Dict[toktokkie.enums.IdType, List[str]], name: str)

Bases: toktokkie.metadata.base.components.JsonComponent.JsonComponent

Class that models a season of a TV Series

__init__(parent_path: str, parent_ids: Dict[toktokkie.enums.IdType, List[str]], ids: Dict[toktokkie.enums.IdType, List[str]], name: str)

Initializes the TvSeason object :param parent_path: The path to the parent metadata directory :param parent_ids: The IDs of the parent metadata :param ids: The specific IDs for this season :param name: The name of the season

property episode_names

Returns

A sorted list of episode names

classmethod from_json(parent_path: str, parent_ids: Dict[toktokkie.enums.IdType, List[str]], json_data: Dict[str, Any])

Generates a TvSeason object based on JSON data :param parent_path: The path to the parent metadata directory :param parent_ids: The IDs of the parent metadata :param json_data: The JSON data :return: The generated TvSeason object :raises InvalidMetadataException: If the provided JSON is invalid

is_spinoff() → bool

Returns

Whether or not this season is a spinoff

property json

Returns

A JSON-compatible dictionary representing this object

property season_number

Returns

The season number of the season

Module contents