6ce7b6c4d3
BREAKING CHANGE: The 'scene_naming' config option has been removed. Users must configure 'output_template' in unshackle.yaml with movies, series, and songs templates. See unshackle-example.yaml for examples.
175 lines
6.8 KiB
Python
175 lines
6.8 KiB
Python
import re
|
|
from abc import ABC
|
|
from collections import Counter
|
|
from typing import Any, Iterable, Optional, Union
|
|
|
|
from langcodes import Language
|
|
from pymediainfo import MediaInfo
|
|
from rich.tree import Tree
|
|
from sortedcontainers import SortedKeyList
|
|
|
|
from unshackle.core.config import config
|
|
from unshackle.core.titles.title import Title
|
|
from unshackle.core.utilities import sanitize_filename
|
|
from unshackle.core.utils.template_formatter import TemplateFormatter
|
|
|
|
|
|
class Episode(Title):
|
|
def __init__(
|
|
self,
|
|
id_: Any,
|
|
service: type,
|
|
title: str,
|
|
season: Union[int, str],
|
|
number: Union[int, str],
|
|
name: Optional[str] = None,
|
|
year: Optional[Union[int, str]] = None,
|
|
language: Optional[Union[str, Language]] = None,
|
|
data: Optional[Any] = None,
|
|
description: Optional[str] = None,
|
|
) -> None:
|
|
super().__init__(id_, service, language, data)
|
|
|
|
if not title:
|
|
raise ValueError("Episode title must be provided")
|
|
if not isinstance(title, str):
|
|
raise TypeError(f"Expected title to be a str, not {title!r}")
|
|
|
|
if season != 0 and not season:
|
|
raise ValueError("Episode season must be provided")
|
|
if isinstance(season, str) and season.isdigit():
|
|
season = int(season)
|
|
elif not isinstance(season, int):
|
|
raise TypeError(f"Expected season to be an int, not {season!r}")
|
|
|
|
if number != 0 and not number:
|
|
raise ValueError("Episode number must be provided")
|
|
if isinstance(number, str) and number.isdigit():
|
|
number = int(number)
|
|
elif not isinstance(number, int):
|
|
raise TypeError(f"Expected number to be an int, not {number!r}")
|
|
|
|
if name is not None and not isinstance(name, str):
|
|
raise TypeError(f"Expected name to be a str, not {name!r}")
|
|
|
|
if year is not None:
|
|
if isinstance(year, str) and year.isdigit():
|
|
year = int(year)
|
|
elif not isinstance(year, int):
|
|
raise TypeError(f"Expected year to be an int, not {year!r}")
|
|
|
|
title = title.strip()
|
|
|
|
if name is not None:
|
|
name = name.strip()
|
|
# ignore episode names that are the episode number or title name
|
|
if re.match(r"Episode ?#?\d+", name, re.IGNORECASE):
|
|
name = None
|
|
elif name.lower() == title.lower():
|
|
name = None
|
|
|
|
if year is not None and year <= 0:
|
|
raise ValueError(f"Episode year cannot be {year}")
|
|
|
|
self.title = title
|
|
self.season = season
|
|
self.number = number
|
|
self.name = name
|
|
self.year = year
|
|
self.description = description
|
|
|
|
def _build_template_context(self, media_info: MediaInfo, show_service: bool = True) -> dict:
|
|
"""Build template context dictionary from MediaInfo."""
|
|
context = self._build_base_template_context(media_info, show_service)
|
|
context["title"] = self.title.replace("$", "S")
|
|
context["year"] = self.year or ""
|
|
context["season"] = f"S{self.season:02}"
|
|
context["episode"] = f"E{self.number:02}"
|
|
context["season_episode"] = f"S{self.season:02}E{self.number:02}"
|
|
context["episode_name"] = self.name or ""
|
|
return context
|
|
|
|
def __str__(self) -> str:
|
|
return "{title}{year} S{season:02}E{number:02} {name}".format(
|
|
title=self.title,
|
|
year=f" {self.year}" if self.year else "",
|
|
season=self.season,
|
|
number=self.number,
|
|
name=self.name or "",
|
|
).strip()
|
|
|
|
def get_filename(self, media_info: MediaInfo, folder: bool = False, show_service: bool = True) -> str:
|
|
if folder:
|
|
series_template = config.output_template.get("series")
|
|
if series_template:
|
|
folder_template = series_template
|
|
folder_template = re.sub(r'\{episode\}', '', folder_template)
|
|
folder_template = re.sub(r'\{episode_name\?\}', '', folder_template)
|
|
folder_template = re.sub(r'\{episode_name\}', '', folder_template)
|
|
folder_template = re.sub(r'\{season_episode\}', '{season}', folder_template)
|
|
|
|
folder_template = re.sub(r'\.{2,}', '.', folder_template)
|
|
folder_template = re.sub(r'\s{2,}', ' ', folder_template)
|
|
folder_template = re.sub(r'^[\.\s]+|[\.\s]+$', '', folder_template)
|
|
|
|
formatter = TemplateFormatter(folder_template)
|
|
context = self._build_template_context(media_info, show_service)
|
|
context['season'] = f"S{self.season:02}"
|
|
|
|
folder_name = formatter.format(context)
|
|
|
|
if '.' in series_template and ' ' not in series_template:
|
|
return sanitize_filename(folder_name, ".")
|
|
else:
|
|
return sanitize_filename(folder_name, " ")
|
|
else:
|
|
name = f"{self.title}"
|
|
if self.year:
|
|
name += f" {self.year}"
|
|
name += f" S{self.season:02}"
|
|
return sanitize_filename(name, " ")
|
|
|
|
formatter = TemplateFormatter(config.output_template["series"])
|
|
context = self._build_template_context(media_info, show_service)
|
|
return formatter.format(context)
|
|
|
|
|
|
class Series(SortedKeyList, ABC):
|
|
def __init__(self, iterable: Optional[Iterable] = None):
|
|
super().__init__(iterable, key=lambda x: (x.season, x.number, x.year or 0))
|
|
|
|
def __str__(self) -> str:
|
|
if not self:
|
|
return super().__str__()
|
|
return self[0].title + (f" ({self[0].year})" if self[0].year else "")
|
|
|
|
def tree(self, verbose: bool = False) -> Tree:
|
|
seasons = Counter(x.season for x in self)
|
|
num_seasons = len(seasons)
|
|
sum(seasons.values())
|
|
season_breakdown = ", ".join(f"S{season}({count})" for season, count in sorted(seasons.items()))
|
|
tree = Tree(
|
|
f"{num_seasons} seasons, {season_breakdown}",
|
|
guide_style="bright_black",
|
|
)
|
|
if verbose:
|
|
for season, episodes in seasons.items():
|
|
season_tree = tree.add(
|
|
f"[bold]Season {str(season).zfill(len(str(num_seasons)))}[/]: [bright_black]{episodes} episodes",
|
|
guide_style="bright_black",
|
|
)
|
|
for episode in self:
|
|
if episode.season == season:
|
|
if episode.name:
|
|
season_tree.add(
|
|
f"[bold]{str(episode.number).zfill(len(str(episodes)))}.[/] "
|
|
f"[bright_black]{episode.name}"
|
|
)
|
|
else:
|
|
season_tree.add(f"[bright_black]Episode {str(episode.number).zfill(len(str(episodes)))}")
|
|
|
|
return tree
|
|
|
|
|
|
__all__ = ("Episode", "Series")
|