Merge pull request #9 from joeyagreco/playoff-round-type

Added PlayoffRoundType enum field

sleeper/enum/PlayoffRoundType.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from enum import unique
+
+from sleeper.enum.ModelEnum import ModelEnum
+
+
+@unique
+class PlayoffRoundType(ModelEnum):
+    ONE_WEEK_PER_ROUND = "ONE_WEEK_PER_ROUND"  # each round of playoffs is one week
+    TWO_WEEK_CHAMPIONSHIP_ROUND = "TWO_WEEK_CHAMPIONSHIP_ROUND"  # each round of playoffs is one week, while the championship spans two weeks
+    TWO_WEEKS_PER_ROUND = "TWO_WEEKS_PER_ROUND"  # each round of playoffs spans two weeks
+
+    @classmethod
+    def from_int(cls, val: int) -> PlayoffRoundType:
+        if val == 0:
+            return PlayoffRoundType.ONE_WEEK_PER_ROUND
+        elif val == 1:
+            return PlayoffRoundType.TWO_WEEK_CHAMPIONSHIP_ROUND
+        elif val == 2:
+            return PlayoffRoundType.TWO_WEEKS_PER_ROUND
+        else:
+            cls._handle_unknown_value(PlayoffRoundType, str(val))

sleeper/model/LeagueSettings.py

@@ -2,6 +2,8 @@
 
 from dataclasses import dataclass
 
+from sleeper.enum.PlayoffRoundType import PlayoffRoundType
+
 
 @dataclass(kw_only=True)
 class LeagueSettings:
@@ -25,6 +27,7 @@ class LeagueSettings:
     offseason_adds: int
     pick_trading: int
     playoff_round_type: int
+    playoff_round_type_enum: PlayoffRoundType  # a more clear representation of the "playoff_round_type" field
     playoff_seed_type: int
     playoff_teams: int
     playoff_type: int
@@ -82,6 +85,8 @@ def from_dict(settings_dict: dict) -> LeagueSettings:
                               disable_trades=settings_dict.get("disable_trades"),
                               league_average_match=settings_dict.get("league_average_match"),
                               playoff_round_type=settings_dict.get("playoff_round_type"),
+                              playoff_round_type_enum=PlayoffRoundType.from_int(
+                                  settings_dict.get("playoff_round_type")),
                               playoff_seed_type=settings_dict.get("playoff_seed_type"),
                               playoff_type=settings_dict.get("playoff_type"),
                               reserve_allow_cov=settings_dict.get("reserve_allow_cov"),

test/test_api/test_LeagueAPIClient.py

@@ -5,6 +5,7 @@
 from requests import HTTPError
 
 from sleeper.api import LeagueAPIClient
+from sleeper.enum.PlayoffRoundType import PlayoffRoundType
 from sleeper.enum.SeasonStatus import SeasonStatus
 from sleeper.enum.SeasonType import SeasonType
 from sleeper.enum.Sport import Sport
@@ -368,6 +369,7 @@ def test_get_league_happy_path(self, mock_requests_get):
         self.assertEqual(1, response.settings.disable_trades)
         self.assertEqual(0, response.settings.league_average_match)
         self.assertEqual(0, response.settings.playoff_round_type)
+        self.assertEqual(PlayoffRoundType.ONE_WEEK_PER_ROUND, response.settings.playoff_round_type_enum)
         self.assertEqual(0, response.settings.playoff_seed_type)
         self.assertEqual(0, response.settings.playoff_type)
         self.assertEqual(0, response.settings.reserve_allow_cov)
@@ -742,6 +744,7 @@ def test_get_user_leagues_for_year_happy_path(self, mock_requests_get):
         self.assertEqual(1, response.settings.disable_trades)
         self.assertEqual(0, response.settings.league_average_match)
         self.assertEqual(0, response.settings.playoff_round_type)
+        self.assertEqual(PlayoffRoundType.ONE_WEEK_PER_ROUND, response.settings.playoff_round_type_enum)
         self.assertEqual(0, response.settings.playoff_seed_type)
         self.assertEqual(0, response.settings.playoff_type)
         self.assertEqual(0, response.settings.reserve_allow_cov)