Refactor openingExplorer type to use generic Typedict

Author: DoraFgr

berserk/types/opening_explorer.py

@@ -1,14 +1,18 @@
 from __future__ import annotations
 
-from typing import Literal, List
+from typing import Generic, Literal, List, TypeVar
 from typing_extensions import TypedDict, NotRequired
-from .common import Speed
+from .common import Color, Speed
 
 OpeningExplorerRating = Literal[
     "0", "1000", "1200", "1400", "1600", "1800", "2000", "2200", "2500"
 ]
 
 
+MoveT = TypeVar("MoveT")
+GameT = TypeVar("GameT")
+
+
 class Opening(TypedDict):
     # The eco code of this opening
     eco: str
@@ -27,7 +31,7 @@ class GameWithoutUci(TypedDict):
     # The id of the game
     id: str
     # The winner of the game. Draw if None
-    winner: Literal["white"] | Literal["black"] | None
+    winner: Color | None
     # The speed of the game
     speed: Speed
     # The type of game
@@ -46,7 +50,7 @@ class MastersGameWithoutUci(TypedDict):
     # The id of the OTB master game
     id: str
     # The winner of the game. Draw if None
-    winner: Literal["white"] | Literal["black"] | None
+    winner: Color | None
     # The black player
     black: Player
     # The white player
@@ -126,7 +130,7 @@ class MastersMove(TypedDict):
     opening: Opening | None
 
 
-class OpeningStatistic(TypedDict):
+class BaseOpeningStatistic(TypedDict, Generic[MoveT, GameT]):
     # Number of game won by white from this position
     white: int
     # Number of game won by black from this position
@@ -135,41 +139,24 @@ class OpeningStatistic(TypedDict):
     black: int
     # Opening info of this position
     opening: Opening | None
-    # The list of moves played by players from this position
-    moves: List[Move]
-    # recent games with this opening
-    recentGames: List[Game]
+    # The list of moves played from this position
+    moves: List[MoveT]
+
+
+class OpeningStatistic(BaseOpeningStatistic[Move, Game]):
     # top rating games with this opening
     topGames: List[Game]
+    # recent games with this opening (optional per schema)
+    recentGames: NotRequired[List[Game]]
 
 
-class PlayerOpeningStatistic(TypedDict):
-    # Number of game won by white from this position
-    white: int
-    # Number of game won by black from this position
-    draws: int
-    # Number draws from this position
-    black: int
-    # Opening info of this position
-    opening: Opening | None
-    # The list of moves played by the player from this position
-    moves: List[PlayerMove]
+class PlayerOpeningStatistic(BaseOpeningStatistic[PlayerMove, Game]):
+    # Queue position for indexing (present when wait_for_indexing parameter used)
+    queuePosition: int
     # recent games with this opening
     recentGames: List[Game]
-    # Queue position for indexing (present when wait_for_indexing parameter used)
-    queuePosition: NotRequired[int]
 
 
-class MastersOpeningStatistic(TypedDict):
-    # Number of game won by white from this position
-    white: int
-    # Number of game won by black from this position
-    draws: int
-    # Number draws from this position
-    black: int
-    # Opening info of this position
-    opening: Opening | None
-    # The list of moves played by players from this position (OTB masters)
-    moves: List[MastersMove]
+class MastersOpeningStatistic(BaseOpeningStatistic[MastersMove, MastersGame]):
     # top rating OTB master games with this opening
     topGames: List[MastersGame]