Replace tournament phase with enum

Author: Galarzaa90

docs/api.rst

@@ -59,6 +59,10 @@ Enumerations are provided for various values in order to avoid depending on stri
     :members:
     :undoc-members:
 
+.. autoclass:: TournamentPhase
+    :members:
+    :undoc-members:
+
 .. autoclass:: TransferType
     :members:
     :undoc-members:

tests/tests_tournament.py

@@ -2,7 +2,8 @@
 import unittest
 
 from tests.tests_tibiapy import TestCommons
-from tibiapy import InvalidContent, ListedTournament, PvpType, RuleSet, ScoreSet, Tournament, TournamentLeaderboard
+from tibiapy import InvalidContent, ListedTournament, PvpType, RuleSet, ScoreSet, Tournament, TournamentLeaderboard, \
+    TournamentPhase
 
 FILE_TOURNAMENT_SIGN_UP = "tournaments/tibiacom_sign_up.txt"
 FILE_TOURNAMENT_ARCHIVE = "tournaments/tibiacom_archive.txt"
@@ -21,7 +22,7 @@ def test_tournament_from_content(self):
         content = self._load_resource(FILE_TOURNAMENT_SIGN_UP)
         tournament = Tournament.from_content(content)
         self.assertEqual(tournament.title, "TRIUMPH")
-        self.assertEqual("sign up", tournament.phase)
+        self.assertEqual(TournamentPhase.SIGN_UP, tournament.phase)
         self.assertIsInstance(tournament.start_date, datetime.datetime)
         self.assertIsInstance(tournament.end_date, datetime.datetime)
         self.assertEqual(6, len(tournament.worlds))
@@ -81,7 +82,7 @@ def test_tournament_from_content_archived(self):
         content = self._load_resource(FILE_TOURNAMENT_ARCHIVE)
         tournament = Tournament.from_content(content)
         self.assertEqual(tournament.title, "GLORY")
-        self.assertEqual("ended", tournament.phase)
+        self.assertEqual(TournamentPhase.ENDED, tournament.phase)
         self.assertIsInstance(tournament.start_date, datetime.datetime)
         self.assertIsInstance(tournament.end_date, datetime.datetime)
         self.assertEqual(6, len(tournament.worlds))

tibiapy/enums.py

@@ -11,6 +11,7 @@
     'PvpType',
     'Sex',
     'TournamentWorldType',
+    'TournamentPhase',
     'TransferType',
     'Vocation',
     'VocationFilter',
@@ -67,9 +68,7 @@ class HouseStatus(BaseEnum):
 
 
 class HouseType(BaseEnum):
-    """
-    The types of house available.
-    """
+    """The types of house available."""
     HOUSE = "house"
     GUILDHALL = "guildhall"
 
@@ -111,6 +110,13 @@ class TournamentWorldType(BaseEnum):
     RESTRICTED = "Restricted Store"
 
 
+class TournamentPhase(BaseEnum):
+    """The possible tournament phases."""
+    SIGN_UP = "sign up"
+    RUNNING = "running"
+    ENDED = "ended"
+
+
 class TransferType(BaseEnum):
     """The possible special transfer restrictions a world may have."""
     REGULAR = "regular"  #: No special transfer restrictions

tibiapy/tournament.py

@@ -5,7 +5,7 @@
 
 import bs4
 
-from tibiapy import abc, InvalidContent, PvpType, Vocation
+from tibiapy import abc, InvalidContent, PvpType, TournamentPhase, Vocation
 from tibiapy.utils import get_tibia_url, parse_integer, parse_tibia_datetime, parse_tibia_full_date, \
     parse_tibiacom_content, split_list, \
     try_enum
@@ -280,7 +280,7 @@ class Tournament(abc.BaseTournament):
         An internal number used to get direct access to a specific tournament in the archive.
 
         This will only be present when viewing an archived tournament, otherwise it will default to 0.
-    phase: :class:`str`
+    phase: :class:`TournamentPhase`
         The current phase of the tournament.
     start_date: :class:`datetime.datetime`
         The start date of the tournament.
@@ -312,7 +312,7 @@ class Tournament(abc.BaseTournament):
     def __init__(self, **kwargs):
         self.title = kwargs.get("title")
         self.cycle = kwargs.get("cycle", 0)
-        self.phase = kwargs.get("phase")
+        self.phase = try_enum(TournamentPhase, kwargs.get("phase"))
         self.start_date = kwargs.get("start_date")  # type: datetime.datetime
         self.end_date = kwargs.get("end_date")  # type: datetime.datetime
         self.worlds = kwargs.get("worlds")  # type: List[str]
@@ -419,6 +419,8 @@ def _parse_tournament_info(self, table):
                 value = parse_tibia_datetime(value)
             if field in list_fields:
                 value = split_list(value, ",", ",")
+            if field == "phase":
+                value = try_enum(TournamentPhase, value)
             try:
                 setattr(self, field, value)
             except AttributeError: