Merge pull request #1265 from rommapp/misc/initial-igdb-typehints

misc: Initial addition of IGDB typehints

.trunk/trunk.yaml

@@ -26,7 +26,7 @@ lint:
     - [email protected]
     - git-diff-check
     - [email protected]
-    - mypy@1.11.2
+    - mypy@1.13.0
     - [email protected]
     - [email protected]
     - [email protected]

backend/adapters/services/igdb_types.py

@@ -0,0 +1,286 @@
+from __future__ import annotations
+
+import enum
+from typing import NewType, TypedDict
+
+# https://api-docs.igdb.com/#expander
+type ExpandableField[T] = T | int
+
+# TODO: Add missing structures until all are implemented.
+UnimplementedEntity = NewType("UnimplementedEntity", dict)
+AgeRatingContentDescription = UnimplementedEntity
+AlternativeName = UnimplementedEntity
+Artwork = UnimplementedEntity
+CollectionRelation = UnimplementedEntity
+CollectionType = UnimplementedEntity
+Cover = UnimplementedEntity
+ExternalGame = UnimplementedEntity
+Franchise = UnimplementedEntity
+GameEngine = UnimplementedEntity
+GameLocalization = UnimplementedEntity
+GameMode = UnimplementedEntity
+Genre = UnimplementedEntity
+InvolvedCompany = UnimplementedEntity
+Keyword = UnimplementedEntity
+LanguageSupport = UnimplementedEntity
+MultiplayerMode = UnimplementedEntity
+PlatformFamily = UnimplementedEntity
+PlatformLogo = UnimplementedEntity
+PlatformVersionCompany = UnimplementedEntity
+PlatformVersionReleaseDate = UnimplementedEntity
+PlatformWebsite = UnimplementedEntity
+PlayerPerspective = UnimplementedEntity
+ReleaseDate = UnimplementedEntity
+TagNumber = UnimplementedEntity
+Theme = UnimplementedEntity
+Website = UnimplementedEntity
+
+
+class IGDBEntity(TypedDict):
+    """Base class for all IGDB entities.
+
+    All IGDB entities include an ID field. They must inherit from this class, and set `total=False`
+    in the class definition, as they only include the `fields` requested in the API query.
+    """
+
+    id: int
+
+
+# https://api-docs.igdb.com/#age-rating-enums
+class AgeRatingCategory(enum.IntEnum):
+    ESRB = 1
+    PEGI = 2
+    CERO = 3
+    USK = 4
+    GRAC = 5
+    CLASS_IND = 6
+    ACB = 7
+
+
+# https://api-docs.igdb.com/#age-rating-enums
+class AgeRatingRating(enum.IntEnum):
+    THREE = 1
+    SEVEN = 2
+    TWELVE = 3
+    SIXTEEN = 4
+    EIGHTEEN = 5
+    RP = 6
+    EC = 7
+    E = 8
+    E10 = 9
+    T = 10
+    M = 11
+    AO = 12
+    CERO_A = 13
+    CERO_B = 14
+    CERO_C = 15
+    CERO_D = 16
+    CERO_Z = 17
+    USK_0 = 18
+    USK_6 = 19
+    USK_12 = 20
+    USK_16 = 21
+    USK_18 = 22
+    GRAC_ALL = 23
+    GRAC_TWELVE = 24
+    GRAC_FIFTEEN = 25
+    GRAC_EIGHTEEN = 26
+    GRAC_TESTING = 27
+    CLASS_IND_L = 28
+    CLASS_IND_TEN = 29
+    CLASS_IND_TWELVE = 30
+    CLASS_IND_FOURTEEN = 31
+    CLASS_IND_SIXTEEN = 32
+    CLASS_IND_EIGHTEEN = 33
+    ACB_G = 34
+    ACB_PG = 35
+    ACB_M = 36
+    ACB_MA15 = 37
+    ACB_R18 = 38
+    ACB_RC = 39
+
+
+# https://api-docs.igdb.com/#age-rating
+class AgeRating(IGDBEntity, total=False):
+    category: AgeRatingCategory
+    checksum: str  # uuid
+    content_descriptions: list[ExpandableField[AgeRatingContentDescription]]
+    rating: AgeRatingRating
+    rating_cover_url: str
+    synopsis: str
+
+
+# https://api-docs.igdb.com/#collection
+class Collection(IGDBEntity, total=False):
+    as_child_relations: list[ExpandableField[CollectionRelation]]
+    as_parent_relations: list[ExpandableField[CollectionRelation]]
+    checksum: str  # uuid
+    created_at: int  # timestamp
+    games: list[ExpandableField[Game]]
+    name: str
+    slug: str
+    type: ExpandableField[CollectionType]
+    updated_at: int  # timestamp
+    url: str
+
+
+# https://api-docs.igdb.com/#game-enums
+class GameCategory(enum.IntEnum):
+    MAIN_GAME = 0
+    DLC_ADDON = 1
+    EXPANSION = 2
+    BUNDLE = 3
+    STANDALONE_EXPANSION = 4
+    MOD = 5
+    EPISODE = 6
+    SEASON = 7
+    REMAKE = 8
+    REMASTER = 9
+    EXPANDED_GAME = 10
+    PORT = 11
+    FORK = 12
+    PACK = 13
+    UPDATE = 14
+
+
+# https://api-docs.igdb.com/#game-enums
+class GameStatus(enum.IntEnum):
+    RELEASED = 0
+    ALPHA = 2
+    BETA = 3
+    EARLY_ACCESS = 4
+    OFFLINE = 5
+    CANCELLED = 6
+    RUMORED = 7
+    DELISTED = 8
+
+
+# https://api-docs.igdb.com/#game
+class Game(IGDBEntity, total=False):
+    age_ratings: list[ExpandableField[AgeRating]]
+    aggregated_rating: float
+    aggregated_rating_count: int
+    alternative_names: list[ExpandableField[AlternativeName]]
+    artworks: list[ExpandableField[Artwork]]
+    bundles: list[ExpandableField[Game]]
+    category: GameCategory
+    checksum: str  # uuid
+    collections: list[ExpandableField[Collection]]
+    cover: ExpandableField[Cover]
+    created_at: int  # timestamp
+    dlcs: list[ExpandableField[Game]]
+    expanded_games: list[ExpandableField[Game]]
+    expansions: list[ExpandableField[Game]]
+    external_games: list[ExpandableField[ExternalGame]]
+    first_release_date: int  # timestamp
+    forks: list[ExpandableField[Game]]
+    franchise: ExpandableField[Franchise]
+    franchises: list[ExpandableField[Franchise]]
+    game_engines: list[ExpandableField[GameEngine]]
+    game_localizations: list[ExpandableField[GameLocalization]]
+    game_modes: list[ExpandableField[GameMode]]
+    genres: list[ExpandableField[Genre]]
+    hypes: int
+    involved_companies: list[ExpandableField[InvolvedCompany]]
+    keywords: list[ExpandableField[Keyword]]
+    language_supports: list[ExpandableField[LanguageSupport]]
+    multiplayer_modes: list[ExpandableField[MultiplayerMode]]
+    name: str
+    parent_game: ExpandableField[Game]
+    platforms: list[ExpandableField[Platform]]
+    player_perspectives: list[ExpandableField[PlayerPerspective]]
+    ports: list[ExpandableField[Game]]
+    rating: float
+    rating_count: int
+    release_dates: list[ExpandableField[ReleaseDate]]
+    remakes: list[ExpandableField[Game]]
+    remasters: list[ExpandableField[Game]]
+    screenshots: list[ExpandableField[Screenshot]]
+    similar_games: list[ExpandableField[Game]]
+    slug: str
+    standalone_expansions: list[ExpandableField[Game]]
+    status: GameStatus
+    storyline: str
+    summary: str
+    tags: list[TagNumber]
+    themes: list[ExpandableField[Theme]]
+    total_rating: float
+    total_rating_count: int
+    updated_at: int  # timestamp
+    url: str
+    version_parent: ExpandableField[Game]
+    version_title: str
+    videos: list[ExpandableField[GameVideo]]
+    websites: list[ExpandableField[Website]]
+
+
+# https://api-docs.igdb.com/#game-video
+class GameVideo(IGDBEntity, total=False):
+    checksum: str  # uuid
+    game: ExpandableField[Game]
+    name: str
+    video_id: str
+
+
+# https://api-docs.igdb.com/#platform-enums
+class PlatformCategory(enum.IntEnum):
+    CONSOLE = 1
+    ARCADE = 2
+    PLATFORM = 3
+    OPERATING_SYSTEM = 4
+    PORTABLE_CONSOLE = 5
+    COMPUTER = 6
+
+
+# https://api-docs.igdb.com/#platform
+class Platform(IGDBEntity, total=False):
+    abbreviation: str
+    alternative_name: str
+    category: PlatformCategory
+    checksum: str  # uuid
+    created_at: int  # timestamp
+    generation: int
+    name: str
+    platform_family: ExpandableField[PlatformFamily]
+    platform_logo: ExpandableField[PlatformLogo]
+    slug: str
+    summary: str
+    updated_at: int  # timestamp
+    url: str
+    versions: list[ExpandableField[PlatformVersion]]
+    websites: list[ExpandableField[PlatformWebsite]]
+
+
+# https://api-docs.igdb.com/#platform-version
+class PlatformVersion(IGDBEntity, total=False):
+    checksum: str  # uuid
+    companies: list[ExpandableField[PlatformVersionCompany]]
+    connectivity: str
+    cpu: str
+    graphics: str
+    main_manufacturer: ExpandableField[PlatformVersionCompany]
+    media: str
+    memory: str
+    name: str
+    os: str
+    output: str
+    platform_logo: ExpandableField[PlatformLogo]
+    platform_version_release_dates: list[ExpandableField[PlatformVersionReleaseDate]]
+    resolutions: str
+    slug: str
+    sound: str
+    storage: str
+    summary: str
+    url: str
+
+
+# https://api-docs.igdb.com/#screenshot
+class Screenshot(IGDBEntity, total=False):
+    alpha_channel: bool
+    animated: bool
+    checksum: str  # uuid
+    game: ExpandableField[Game]
+    height: int
+    image_id: str
+    url: str
+    width: int

backend/handler/metadata/igdb_handler.py

@@ -5,6 +5,7 @@
 
 import httpx
 import pydash
+from adapters.services.igdb_types import GameCategory
 from config import IGDB_CLIENT_ID, IGDB_CLIENT_SECRET, IS_PYTEST_RUN
 from fastapi import HTTPException, status
 from handler.redis_handler import sync_cache
@@ -23,9 +24,6 @@
 # Used to display the IGDB API status in the frontend
 IGDB_API_ENABLED: Final = bool(IGDB_CLIENT_ID) and bool(IGDB_CLIENT_SECRET)
 
-MAIN_GAME_CATEGORY: Final = 0
-EXPANDED_GAME_CATEGORY: Final = 10
-N_SCREENSHOTS: Final = 5
 PS1_IGDB_ID: Final = 7
 PS2_IGDB_ID: Final = 8
 PSP_IGDB_ID: Final = 38
@@ -274,7 +272,7 @@ async def _search_rom(
 
         search_term = uc(search_term)
         category_filter: str = (
-            f"& (category={MAIN_GAME_CATEGORY} | category={EXPANDED_GAME_CATEGORY})"
+            f"& (category={GameCategory.MAIN_GAME} | category={GameCategory.EXPANDED_GAME})"
             if with_category
             else ""
         )