Skip to content

sok.media.video.episode

Episode class for TV series episodes.

Episode

class Episode(
series_name: str,
language: str,
media_manager: UniversalMediaManager,
season_number: int = 1,
episode_number: int = 1,
series_id: Optional[str] = None,
)

Bases: BaseMedia

Class for managing TV series episodes.

Represents a single episode within a TV series season.

Initialize an Episode instance.

Parameters

NameTypeDefaultDescription
series_namestrName of the parent TV series.
languagestrLanguage code (e.g., 'en', 'fr').
media_managerUniversalMediaManagerThe API manager.
season_numberint1Season number (default: 1).
episode_numberint1Episode number (default: 1).
series_idOptional[str]NoneID of the parent series if known.
Source

Attributes

NameTypeDescription
air_dateOptional[str]

Original air date.

episode_number

Episode number within the season.

runtimeOptional[int]

Duration in minutes.

season_number

Season number.

series_id

ID of the parent series.

series_name

Name of the parent series.

still_pathOptional[str]

Path to episode still image.

from_dictclassmethod

def from_dict(
data: Dict[str, Any],
media_manager: UniversalMediaManager,
) -> Episode:

Create an Episode instance from a dictionary.

Parameters

NameTypeDescription
dataDict[str, Any]Episode data.
media_managerUniversalMediaManagerThe API manager.

Returns

Source

get_detailsasync

async def get_details() -> None:

Retrieve detailed episode information.

Fills attributes: title, air_date, runtime, still_path, etc.

Source

get_episode_code

def get_episode_code() -> str:

Return the episode code.

Returns

  • strEpisode code (e.g., 'S01E01').
Source

get_formatted_name

def get_formatted_name() -> str:

Return the formatted episode name.

Format: 'Series Name - S##E## - Episode Title'

Returns

  • strFormatted episode name.
Source

to_dict

def to_dict() -> Dict[str, Any]:

Convert the episode to a dictionary.

Returns

  • Dict[str, Any]Episode data as dictionary.
Source
Built with Kiln