compuglobal 0.4.0__tar.gz → 0.4.2__tar.gz

{compuglobal-0.4.0 → compuglobal-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compuglobal
-Version: 0.4.0
+Version: 0.4.2
 Summary: Python wrapper for the CGHMC API (Frinkiac, Morbotron Master Of All Science and more.
 Keywords: The Simpsons,Futurama,Rick and Morty,West Wing,Frinkiac,Morbotron,Master of all Science,Capital Beat,API,API Wrapper,CompuGlobal,CompuGlobalHyperMegaNet,CGHMC
 Author: MitchellAW

{compuglobal-0.4.0 → compuglobal-0.4.2}/compuglobal/__init__.py

@@ -22,7 +22,7 @@ from compuglobal.models.timestamp import Timestamp
 __title__ = "compuglobal"
 __author__ = "MitchellAW"
 __license__ = "MIT"
-__version__ = "0.4.0"
+__version__ = "0.4.2"
 
 __all__ = [
     "APIPageStatusError",

{compuglobal-0.4.0 → compuglobal-0.4.2}/compuglobal/aio.py

@@ -1,5 +1,6 @@
 """Used for interacting with and building CGHMC APIs."""
 
+import dataclasses
 import json
 import logging
 from typing import overload
@@ -32,8 +33,10 @@ class AsyncCompuGlobalAPI:
 
     Parameters
     ----------
-    session : aiohttp.ClientSession, optional
+    session : aiohttp.ClientSession
         The client session to use for all API calls
+    default_format : OverlayFormat | None, optional
+        The default overlay format to use for all overlays/subtitles
 
     Attributes
     ----------
@@ -41,8 +44,8 @@ class AsyncCompuGlobalAPI:
         The base url of the API
     TITLE : str
         The title of the API
-    DEFAULT_FORMAT : OverlayFormat
-        The default formatting to use in all comic/gif overlays
+    EXTRA_FONTS : frozenset[FontFamily]
+        A frozenset of any extra fonts permitted by the API
     discovery : DiscoveryAPI
         The discovery API with all discovery endpoints
     media : MediaAPI
@@ -54,16 +57,27 @@ class AsyncCompuGlobalAPI:
 
     BASE_URL: str
     TITLE: str
-    DEFAULT_FORMAT: OverlayFormat
+    EXTRA_FONTS: frozenset[FontFamily] = frozenset()
     _MAX_ALLOWED_SUBTITLES = 4
 
     discovery: DiscoveryAPI = DiscoveryAPI()
     media: MediaAPI = MediaAPI()
     metadata: MetadataAPI = MetadataAPI()
 
-    def __init__(self, session: aiohttp.ClientSession) -> None:
+    def __init__(self, session: aiohttp.ClientSession, default_format: OverlayFormat | None = None) -> None:
+        extra_fonts = list(self.EXTRA_FONTS)
+        if default_format is None:
+            chosen_font = extra_fonts[0] if len(extra_fonts) > 0 else FontFamily.IMPACT
+            default_format = OverlayFormat(font_family=chosen_font)
+
+        allowed_fonts = FontFamily.universal_fonts() + extra_fonts
+
+        self.config = CompuGlobalAPIConfig(
+            title=self.TITLE,
+            allowed_fonts=allowed_fonts,
+            default_format=default_format,
+        )
         self.client = CompuGlobalAPIClient(base_url=self.BASE_URL, session=session)
-        self.config = CompuGlobalAPIConfig(title=self.TITLE, default_format=self.DEFAULT_FORMAT)
 
     async def get_screencap(
         self,
@@ -476,6 +490,21 @@ class AsyncCompuGlobalAPI:
             query={"b64": stream.encoded},
         )
 
+    def _resolve_font(self, overlay_format: OverlayFormat) -> OverlayFormat:
+        if overlay_format.font_family in self.config.allowed_fonts:
+            return overlay_format
+
+        log.warning(
+            "Font family %s is not allowed for %s, using IMPACT font instead | overlay_format=%s",
+            overlay_format.font_family,
+            self.config.title,
+            overlay_format,
+        )
+        return dataclasses.replace(overlay_format, font_family=FontFamily.IMPACT)
+
+    def _resolve_fonts(self, overlay_formats: list[OverlayFormat]) -> list[OverlayFormat]:
+        return [self._resolve_font(overlay_format) for overlay_format in overlay_formats]
+
     @overload
     def _resolve_overlay_inputs(
         self,
@@ -504,6 +533,12 @@ class AsyncCompuGlobalAPI:
         if overlay_format != self.config.default_format:
             log.debug("Using custom overlay format | screencap=%s | overlay_format=%s", screencap, overlay_format)
 
+        # Resolve any disallowed fonts in the format(s)
+        if isinstance(overlay_format, list):
+            overlay_format = self._resolve_fonts(overlay_format)
+        else:
+            overlay_format = self._resolve_font(overlay_format)
+
         # Use screencap subtitles if not given
         subtitles = subtitles or screencap.subtitles
         if subtitles != screencap.subtitles:
@@ -523,7 +558,6 @@ class CapitalBeatUs(AsyncCompuGlobalAPI):
 
     BASE_URL = "https://capitalbeat.us"
     TITLE = "West Wing"
-    DEFAULT_FORMAT = OverlayFormat(font_family=FontFamily.IMPACT)
 
 
 class Frinkiac(AsyncCompuGlobalAPI):
@@ -531,7 +565,7 @@ class Frinkiac(AsyncCompuGlobalAPI):
 
     BASE_URL = "https://frinkiac.com"
     TITLE = "Simpsons"
-    DEFAULT_FORMAT = OverlayFormat(font_family=FontFamily.AKBAR)
+    EXTRA_FONTS = frozenset({FontFamily.AKBAR})
 
 
 @deprecated("The MasterOfAllScience API is deprecated, and currently redirects to Frinkiac")
@@ -540,7 +574,6 @@ class MasterOfAllScience(AsyncCompuGlobalAPI):
 
     BASE_URL = "https://masterofallscience.com"
     TITLE = "Rick and Morty"
-    DEFAULT_FORMAT = OverlayFormat(font_family=FontFamily.IMPACT)
 
 
 class Morbotron(AsyncCompuGlobalAPI):
@@ -548,4 +581,4 @@ class Morbotron(AsyncCompuGlobalAPI):
 
     BASE_URL = "https://morbotron.com"
     TITLE = "Futurama"
-    DEFAULT_FORMAT = OverlayFormat(font_family=FontFamily.FR_BOLD)
+    EXTRA_FONTS = frozenset({FontFamily.FR_BOLD})

compuglobal-0.4.2/compuglobal/api/config.py

@@ -0,0 +1,30 @@
+"""The configuration for a CGHMC API (title + font)."""
+
+import dataclasses
+import logging
+from dataclasses import dataclass, field
+
+from compuglobal.models.font import FontFamily
+from compuglobal.models.overlay import OverlayFormat
+
+log = logging.getLogger(__name__)
+
+
+@dataclass
+class CompuGlobalAPIConfig:
+    """The configuration for a CompuGlobal API."""
+
+    #: The title of the API
+    title: str
+
+    #: The allowed fonts for this API
+    allowed_fonts: list[FontFamily] = field(default_factory=FontFamily.universal_fonts)
+
+    #: The default formatting to use in all stream/comic overlays (subtitles)
+    default_format: OverlayFormat = field(default_factory=OverlayFormat)
+
+    def __post_init__(self) -> None:
+        """Validate font family is allowed in API. If not allowed, use IMPACT font."""
+        if self.default_format.font_family not in self.allowed_fonts:
+            log.warning("Chosen font is not allowed for this API. Using IMPACT font instead.")
+            self.default_format = dataclasses.replace(self.default_format, font_family=FontFamily.IMPACT)

{compuglobal-0.4.0 → compuglobal-0.4.2}/compuglobal/models/font.py

@@ -28,6 +28,23 @@ class FontFamily(StrEnum):
     #: The Fr Bold font family (Morbotron default)
     FR_BOLD = "fr"
 
+    @staticmethod
+    def universal_fonts() -> list["FontFamily"]:
+        """Get a list of universal fonts that work across all APIs.
+
+        Returns
+        -------
+        list[FontFamily]
+            List of universal fonts
+
+        """
+        return [
+            FontFamily.IMPACT,
+            FontFamily.COMIC_NEUE,
+            FontFamily.JOST,
+            FontFamily.PACIFICO,
+        ]
+
 
 class FontAlignment(StrEnum):
     """An enumeration of font alignments."""

{compuglobal-0.4.0 → compuglobal-0.4.2}/compuglobal/models/overlay.py

@@ -1,13 +1,12 @@
 """Helper class for formatting of StreamOverlays and ComicOverlays."""
 
-import dataclasses
-from dataclasses import dataclass, field
+from pydantic import Field
 
+from compuglobal.models.base import BaseCompuGlobalModel
 from compuglobal.models.font import FontAlignment, FontColor, FontFamily
 
 
-@dataclass(frozen=True)
-class OverlayFormat:
+class OverlayFormat(BaseCompuGlobalModel):
     """The formatting style to use in an overlay.
 
     Attributes
@@ -29,19 +28,16 @@ class OverlayFormat:
 
     """
 
-    font_family: FontFamily = FontFamily.IMPACT
-    font_size: int = 0
-    font_color: FontColor = field(default_factory=FontColor)
-    text_position_x: int = 50
-    text_position_y: int = 97
-    text_alignment: FontAlignment = FontAlignment.ALIGN_CENTER
-    all_caps: bool = True
-
-    def _changed_fields(self) -> dict:
-        return {f.name: getattr(self, f.name) for f in dataclasses.fields(self) if getattr(self, f.name) != f.default}
+    font_family: FontFamily = Field(default=FontFamily.IMPACT)
+    font_size: int = Field(ge=0, le=120, default=0)
+    font_color: FontColor = Field(default=FontColor())
+    text_position_x: int = Field(default=50)
+    text_position_y: int = Field(default=97)
+    text_alignment: FontAlignment = Field(default=FontAlignment.ALIGN_CENTER)
+    all_caps: bool = Field(default=True)
 
     def __str__(self) -> str:  # noqa: D105
-        return str(self._changed_fields())
+        return str(self.model_dump(exclude_defaults=True))
 
     @property
     def font_color_hex(self) -> str:

{compuglobal-0.4.0 → compuglobal-0.4.2}/compuglobal/models/subtitle.py

@@ -47,3 +47,15 @@ class Subtitle(BaseCompuGlobalModel):
 
         """
         return Timestamp.get_duration(start_timestamp=self.start_timestamp, end_timestamp=self.end_timestamp)
+
+    @property
+    def timecode(self) -> str:
+        """A readable timecode for the subtitle's representative timestamp in format ``mm:ss``.
+
+        Returns
+        -------
+        str
+            A readable timecode in format ``mm:ss``
+
+        """
+        return Timestamp.get_timecode(self.representative_timestamp)

compuglobal-0.4.0/compuglobal/api/config.py

@@ -1,16 +0,0 @@
-"""The configuration for a CGHMC API (title + font)."""
-
-from dataclasses import dataclass, field
-
-from compuglobal.models.overlay import OverlayFormat
-
-
-@dataclass
-class CompuGlobalAPIConfig:
-    """The configuration for a CompuGlobal API."""
-
-    #: The title of the API
-    title: str
-
-    #: The default formatting to use in all stream/comic overlays (subtitles)
-    default_format: OverlayFormat = field(default_factory=OverlayFormat)