Add basic typing to Bracket endpoint

Author: vlee489

README.md

@@ -11,6 +11,7 @@ An async Python client for Sendou.ink
 
 ## Dependencies
 - aiohttp
+- [aiohttp-client-cache](https://pypi.org/project/aiohttp-client-cache/)
 - python-dateutil
 
 ## Installation
@@ -22,7 +23,7 @@ An async Python client for Sendou.ink
 - [x] Get Tournament Info
   - [x] Get Tournament Teams
   - [X] Get Tournament Brackets
-- [x] Get Tournament Match Info (*by ID not linked to bracket*)
+    - [x] Get Tournament Match Info
 
 ## Usage
 ```python

docs/index.md

@@ -8,17 +8,19 @@ This library is maintained by [Inkling Performance Labs Productions](https://git
 
 ## Dependencies
 - aiohttp
+- [aiohttp-client-cache](https://pypi.org/project/aiohttp-client-cache/)
 - python-dateutil
 
 ## Installation
 `pip install sendou.py`
 
 ## Supported Endpoints
 - [x] Get user
+- [x] Get Calendar Entries
 - [x] Get Tournament Info
   - [x] Get Tournament Teams
   - [X] Get Tournament Brackets
-- [x] Get Tournament Match Info (*by ID not linked to bracket*)
+    - [x] Get Tournament Match Info
 
 ## Usage
 ```python

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sendou-py"
-version = "1.0.0"
+version = "1.1.0"
 description = "An async Python library for Sendou.ink"
 authors = ["Vincent Lee <[email protected]>"]
 license = "MIT"
@@ -12,7 +12,7 @@ documentation = "https://sendou.opensource.iplabs.work/"
 keywords = ["splatoon", "sendou.ink"]
 classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
-    "Development Status :: 3 - Alpha"
+    "Development Status :: 3 - Beta"
 ]
 
 [tool.poetry.dependencies]

sendou/models/tournament/__init__.py

@@ -2,4 +2,4 @@
 from .tournament import TournamentTeamInfo as TournamentTeam
 from .team import TournamentTeam, TeamMember
 from .match import Match, MatchTeam, MapListSourceEnum, MapListMap
-from .bracket import Bracket
+from .bracket import Bracket

sendou/models/tournament/bracket.py

@@ -0,0 +1,2 @@
+from .bracket import Bracket
+from .type import BracketType, RoundType, MatchResult

sendou/models/tournament/bracket/__init__.py

@@ -0,0 +1,260 @@
+"""
+Tournament Bracket Model
+"""
+from sendou.models.baseModel import BaseModel
+from sendou.requests import RequestsClient
+
+from typing import Any, Optional, List
+from datetime import datetime, timezone
+
+from .type import BracketType, RoundType, MatchResult
+from sendou.models.tournament.match import Match
+
+
+class BracketMeta:
+    """
+    Bracket Metadata
+
+    Attributes:
+        teams_per_group (Optional[int]): Teams per Group
+        group_count (Optional[int]): Group Count
+        round_count (Optional[int]): Round Count
+    """
+    teams_per_group: Optional[int]
+    group_count: Optional[int]
+    round_count: Optional[int]
+
+    def __init__(self, data: dict):
+        self.teams_per_group = data.get("teamsPerGroup", None)
+        self.group_count = data.get("groupCount", None)
+        self.round_count = data.get("roundCount", None)
+
+
+class BracketStage:
+    """
+    Bracket Stage
+
+    Attributes:
+        id (int): Bracket Stage ID
+        name (str): Bracket Stage Name
+        number (int): Bracket Stage Number
+        settings (Any): Bracket Stage Settings
+        tournament_id (int): Tournament ID
+        type (BracketType): Bracket Type
+        created_at (datetime): Created At
+    """
+    id: int
+    name: str
+    number: int
+    settings: Any
+    tournament_id: int
+    type: BracketType
+    created_at: datetime  # Provided as unix timestamp
+
+    def __init__(self, data: dict):
+        self.id = data.get("id", 0)
+        self.name = data.get("name", "")
+        self.number = data.get("number", 0)
+        self.settings = data.get("settings", {})
+        self.tournament_id = data.get("tournament_id", 0)
+        self.type = BracketType(data.get("type", ""))
+        self.created_at = datetime.fromtimestamp(data.get("createdAt", 0), tz=timezone.utc)
+
+
+class BracketGroup:
+    """
+    Bracket Group
+
+    Attributes:
+        id (int): Bracket Group ID
+        number (int): Bracket Group Number
+        stage_id (int): Bracket Stage ID
+    """
+    id: int
+    number: int
+    stage_id: int
+
+    def __init__(self, data: dict):
+        self.id = data.get("id", 0)
+        self.numbers = data.get("number", 0)
+        self.stage_id = data.get("stage_id", 0)
+
+
+class BracketRoundMap:
+    """
+    Bracket Round Map
+
+    Attributes:
+        count (int): Round Count
+        type (RoundType): Round Type
+    """
+    count: int
+    type: RoundType
+
+    def __init__(self, data: dict):
+        self.count = data.get("count", 0)
+        self.type = RoundType(data.get("type", ""))
+
+
+class BracketRound:
+    """
+    Bracket Round
+
+    Attributes:
+        id (int): Bracket Round ID
+        group_id (int): Bracket Group ID
+        number (int): Bracket Round Number
+        stage_id (int): Bracket Stage ID
+        maps (BracketRoundMap): Bracket Round Map Metadata
+    """
+    id: int
+    group_id: int
+    number: int
+    stage_id: int
+    maps: BracketRoundMap
+
+    def __init__(self, data: dict):
+        self.id = data.get("id", 0)
+        self.group_id = data.get("group_id", 0)
+        self.number = data.get("number", 0)
+        self.stage_id = data.get("stage_id", 0)
+        self.maps = BracketRoundMap(data.get("maps", {}))
+
+
+class BracketMatchOpponent:
+    """
+    Bracket Match Opponent
+
+    Attributes:
+        id (int): Opponent ID
+        position (int): Opponent Seed?
+        score (int): Opponent Score
+        result (MatchResult): Opponent Result
+        totalPoints (int): Total Points (Swiss/RR)
+    """
+    id: int
+    position: Optional[int]
+    score: Optional[int]
+    result: Optional[MatchResult]
+    totalPoints: Optional[int]
+
+    def __init__(self, data: dict):
+        self.id = data.get("id", 0)
+        if "position" in data:
+            self.position = data.get("position", 0)
+        if "score" in data:
+            self.score = data.get("score", 0)
+        if "result" in data:
+            self.result = MatchResult(data.get("result", ""))
+        if "totalPoints" in data:
+            self.totalPoints = data.get("totalPoints", 0)
+
+
+class BracketMatch(BaseModel):
+    """
+    Bracket Match
+
+    Attributes:
+        id (int): Bracket Match ID
+        group_id (int): Bracket Group ID
+        number (int): Bracket Match Number
+        opponent1 (BracketMatchOpponent): Opponent 1
+        opponent2 (Optional[BracketMatchOpponent]): Opponent 2
+        round_id (int): Bracket Round ID
+        stage_id (int): Bracket Stage ID
+        status (int): Bracket Match Status
+        lastGameFinishedAt (datetime): Last Game Finished At
+        createdAt (datetime): Created At
+    """
+    id: int
+    group_id: int
+    number: int
+    opponent1: BracketMatchOpponent
+    opponent2: Optional[BracketMatchOpponent]
+    round_id: int
+    stage_id: int
+    status: int
+    lastGameFinishedAt: Optional[datetime]  # Unix timestamp
+    createdAt: Optional[datetime]  # Unix timestamp
+
+    def __init__(self, data: dict, request_client: RequestsClient):
+        super().__init__(data, request_client)
+        self.id = data.get("id", 0)
+        self.group_id = data.get("group_id", 0)
+        self.number = data.get("number", 0)
+        self.opponent1 = BracketMatchOpponent(data.get("opponent1", {}))
+        if data.get("opponent2", {}):
+            self.opponent2 = BracketMatchOpponent(data.get("opponent2", {}))
+        self.round_id = data.get("round_id", 0)
+        self.stage_id = data.get("stage_id", 0)
+        self.status = data.get("status", 0)
+        if data.get("lastGameFinishedAt", None):
+            self.lastGameFinishedAt = datetime.fromtimestamp(data.get("lastGameFinishedAt", 0), tz=timezone.utc)
+        if data.get("createdAt", None):
+            self.createdAt = datetime.fromtimestamp(data.get("createdAt", 0), tz=timezone.utc)
+
+    async def get_match(self) -> Optional[Match]:
+        """
+        Get the match data
+
+        Returns:
+            (Match): Match Data
+        """
+        path = Match.api_route(match_id=self.id)
+        data = await self._request_client.get_response(path)
+        if data:
+            return Match(data, self._request_client)
+
+
+class BracketData(BaseModel):
+    """
+    Bracket Data
+
+    Attributes:
+        stage (BracketStage): Bracket Stage
+        group (List[BracketGroup]): Bracket Groups
+        round (List[BracketRound]): Bracket Rounds
+        match (List[BracketMatch]): Bracket Matches
+    """
+    stage: List[BracketStage]
+    group: List[BracketGroup]
+    round: List[BracketRound]
+    match: List[BracketMatch]
+
+    def __init__(self, data: dict, request_client: RequestsClient):
+        super().__init__(data, request_client)
+        self.stage = [BracketStage(stage) for stage in data.get("stage", [])]
+        self.group = [BracketGroup(group) for group in data.get("group", [])]
+        self.round = [BracketRound(r) for r in data.get("round", [])]
+        self.match = [BracketMatch(match, request_client) for match in data.get("match", [])]
+
+
+class Bracket(BaseModel):
+    """
+    Sendou.ink Tournament Bracket Info
+
+    Attributes:
+        data (Any): Bracket Data
+        meta (BracketMeta): Bracket Metadata
+    """
+    data: BracketData  # https://github.com/Sendouc/sendou.ink/blob/rewrite/app/features/api-public/schema.ts#L232
+    meta: BracketMeta
+
+    def __init__(self, data: dict, request_client: RequestsClient):
+        super().__init__(data, request_client)
+        self.data = BracketData(data.get("data", {}), request_client)
+        self.meta = BracketMeta(data.get("meta", {}))
+
+    @staticmethod
+    def api_route(**kwargs) -> str:
+        """
+        Get the api route for the bracket
+
+        Args:
+            tournament_id (str): Tournament ID
+            bracket_index (int): Bracket Index
+
+        Returns:
+            (str): API Route
+        """
+        return f"api/tournament/{kwargs.get('tournament_id')}/brackets/{kwargs.get('bracket_index')}"