Season str typing (#65)

- Change typing for File.season_id to `int | str | None`
- Change typing for Season.id to `int | str`

Author: Buried-In-Code

mediux_posters/mediux/schemas.py

@@ -12,12 +12,20 @@
 
 from datetime import date, datetime
 from enum import Enum
+from typing import Annotated
 
-from pydantic import AliasPath, Field
+from pydantic import AliasPath, BeforeValidator, Field, TypeAdapter, ValidationError
 
 from mediux_posters.utils import BaseModel
 
 
+def int_or_str(val: int | str | None) -> int | str | None:
+    try:
+        return TypeAdapter(int).validate_python(val)
+    except ValidationError:
+        return val
+
+
 class MediuxModel(BaseModel, extra="ignore"): ...
 
 
@@ -37,11 +45,17 @@ class File(MediuxModel):
     id: str
     file_type: FileType
     last_updated: datetime = Field(alias="modified_on")
-    show_id: int | None = Field(validation_alias=AliasPath("show", "id"), default=None)
-    season_id: int | None = Field(validation_alias=AliasPath("season", "id"), default=None)
-    episode_id: int | None = Field(validation_alias=AliasPath("episode", "id"), default=None)
-    collection_id: int | None = Field(validation_alias=AliasPath("collection", "id"), default=None)
-    movie_id: int | None = Field(validation_alias=AliasPath("movie", "id"), default=None)
+    show_id: Annotated[int | None, Field(validation_alias=AliasPath("show", "id"))] = None
+    season_id: Annotated[
+        int | str | None,
+        BeforeValidator(int_or_str),
+        Field(validation_alias=AliasPath("season", "id")),
+    ] = None
+    episode_id: Annotated[int | None, Field(validation_alias=AliasPath("episode", "id"))] = None
+    collection_id: Annotated[int | None, Field(validation_alias=AliasPath("collection", "id"))] = (
+        None
+    )
+    movie_id: Annotated[int | None, Field(validation_alias=AliasPath("movie", "id"))] = None
 
 
 class Episode(MediuxModel):
@@ -52,7 +66,7 @@ class Episode(MediuxModel):
 
 class Season(MediuxModel):
     episodes: list[Episode]
-    id: int
+    id: Annotated[int | str, BeforeValidator(int_or_str)]
     number: int = Field(alias="season_number")
     title: str | None = Field(alias="season_name", default=None)
 

mediux_posters/services/_base/service.py

@@ -22,7 +22,7 @@
 
 
 class BaseService(ABC, Generic[T, S, E, C, M]):
-    def __init__(self, cache: ServiceCache) -> None:
+    def __init__(self, cache: ServiceCache | None = None) -> None:
         self.cache = cache
 
     @abstractmethod

mediux_posters/services/jellyfin/service.py

@@ -29,7 +29,7 @@
 
 
 class Jellyfin(BaseService[Show, Season, Episode, Collection, Movie]):
-    def __init__(self, base_url: str, token: str, cache: ServiceCache):
+    def __init__(self, base_url: str, token: str, cache: ServiceCache | None = None):
         super().__init__(cache=cache)
         self.client = Client(
             base_url=base_url,

mediux_posters/services/plex/service.py

@@ -28,7 +28,7 @@
 
 
 class Plex(BaseService[Show, Season, Episode, Collection, Movie]):
-    def __init__(self, base_url: str, token: str, cache: ServiceCache):
+    def __init__(self, base_url: str, token: str, cache: ServiceCache | None = None):
         super().__init__(cache=cache)
         self.client = Client(
             base_url=base_url,

tests/application_test.py

@@ -60,6 +60,16 @@ def test_get_show_set_invalid(mediux_session: Mediux) -> None:
     assert result is None
 
 
+def test_show_set_season_id_typing(mediux_session: Mediux) -> None:
+    result = mediux_session.get_show_set(set_id=6578)
+    assert result is not None
+
+    assert isinstance(result.files[0].season_id, str)
+    assert result.files[0].season_id == "ALT15773"
+    assert isinstance(result.show.seasons[1].id, str)
+    assert result.show.seasons[1].id == "ALT26311"
+
+
 def test_list_collection_sets(mediux_session: Mediux) -> None:
     results = mediux_session.list_collection_sets(tmdb_id=573436)
     assert len(results) != 0
@@ -81,7 +91,7 @@ def test_list_collection_sets(mediux_session: Mediux) -> None:
     assert result.files[0].movie_id == 324857
     assert result.files[0].collection_id is None
     assert result.id == 24404
-    assert result.set_title == "Spider-Man: Spider-Verse Collection"
+    assert result.set_title == "Spider-Man: Spider-Verse Collection Set"
     assert result.username == "willtong93"