Added Division Support

CHANGELOG.md

@@ -4,7 +4,14 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
-- N/A
+- Fixed a bug in the MyFantasyLeague League Loader where playoff Matchups could be ignored
+- Fixed a bug in the Sleeper League Loader where leagues with 1-week playoff rounds could be loaded incorrectly
+- Integration Divisions into league models
+- Added Divisions to all League Loader flows
+- Added Division column to Excel sheets
+- Added an .equals() method to each league model object, allowing for more customized model comparisons
+- Added the ability to pass a custom league name for each League Loader
+- Added better validation for league models
 
 ## [2.4.0]
 
@@ -21,7 +28,7 @@ All notable changes to this project will be documented in this file.
 - Added better tests for the Sleeper League Loader
 - Added better tests for the Yahoo League Loader
 - Added better validation to all League Loaders
-- Added human-readable info logging with differences when comparing league models with "=="
+- Added human-readable info logging with differences when comparing League models with "=="
 - Updated League Loader examples
 
 ## [2.3.0]

README.md

@@ -115,6 +115,7 @@ TypeError: dataclass() got an unexpected keyword argument 'kw_only'
 This error occurs when the Python version you are using is not 3.10 or greater.\
 Make sure you are using Python version 3.10 or a newer version.
 
+___
 **Q:**
 How do I use this library to pull stats from my online fantasy league?
 
@@ -180,14 +181,6 @@ If a fantasy site you use is not listed here and you would like it to be, please
 Stats used in this library are
 documented [here](https://github.com/joeyagreco/leeger/blob/main/doc/stats.md).
 
-## Running Tests
-
-To run tests, run the following command:
-
-```bash
-  pytest
-```
-
 ## Contributing
 
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
@@ -196,11 +189,19 @@ Please make sure to update tests as appropriate.
 
 ## Development
 
-### Formatting
+_Run these commands from the root folder_
+- Format Code: `./main fmt`
+- Run Unit Tests: `./main test`
+- Generate Coverage Report: `./main cov`
+
+### Running Tests
+
+Run the following command from the root folder:
+
+```bash
+  pytest
+```
 
-_Run these commands from the root folder (leeger) before committing._\
-**General Format:** `black --config=pyproject.toml . `\
-**Import/Variable Format:** `autoflake --config=pyproject.toml .`
 
 ## License
 

batch/coverage.bat

@@ -0,0 +1,7 @@
+@echo off
+
+cd test
+coverage run -m pytest
+coverage xml -o coverage.xml
+coverage html
+cd ..

batch/format.bat

@@ -0,0 +1,4 @@
+@echo off
+
+black --config=pyproject.toml .
+autoflake --config=pyproject.toml .

batch/test.bat

@@ -0,0 +1,4 @@
+@echo off
+
+cd test
+pytest

example/league/comparingLeagueObjects.py

@@ -0,0 +1,23 @@
+from leeger.league_loader.ESPNLeagueLoader import ESPNLeagueLoader
+
+from leeger.model.league import League
+
+if __name__ == "__main__":
+    # to compare a League model (or any of its child models) you can use .equals()
+
+    # 1. take any model (let's get a dummy League) for an example
+    espnLeagueLoader = ESPNLeagueLoader("12345678", [2019, 2020])
+    league: League = espnLeagueLoader.loadLeague()
+
+    # 2. lets compare it
+    league.equals(league)  # compares models with all fields
+    league.equals(league, ignoreBaseIds=True)  # ignores the base "id" field in each object
+    league.equals(
+        league, ignoreIds=True
+    )  # ignores fields that hold an id but not the base "id" fields
+    league.equals(
+        league, logDifferences=True
+    )  # logs all differences IF the equality check is False
+
+    # 3. you can also use "=="
+    league == league  # compares models using all of the .equals() defaults

leeger/exception/InvalidDivisionFormatException.py

@@ -0,0 +1,4 @@
+class InvalidDivisionFormatException(Exception):
+    """
+    Raised when an Division model is not formatted correctly.
+    """

leeger/exception/__init__.py

@@ -1,4 +1,5 @@
 from .DoesNotExistException import DoesNotExistException
+from .InvalidDivisionFormatException import InvalidDivisionFormatException
 from .InvalidFilterException import InvalidFilterException
 from .InvalidLeagueFormatException import InvalidLeagueFormatException
 from .InvalidMatchupFormatException import InvalidMatchupFormatException

leeger/league_loader/ESPNLeagueLoader.py

@@ -5,6 +5,7 @@
 
 from leeger.enum.MatchupType import MatchupType
 from leeger.league_loader.LeagueLoader import LeagueLoader
+from leeger.model.league.Division import Division
 from leeger.model.league.League import League
 from leeger.model.league.Matchup import Matchup
 from leeger.model.league.Owner import Owner
@@ -40,17 +41,23 @@ def __init__(
         espnS2: str = None,
         swid: str = None,
         ownerNamesAndAliases: Optional[dict[str, list[str]]] = None,
+        leagueName: Optional[str] = None,
     ):
         # validation
         try:
             int(leagueId)
         except ValueError:
             raise ValueError(f"League ID '{leagueId}' could not be turned into an int.")
-        super().__init__(leagueId, years, ownerNamesAndAliases=ownerNamesAndAliases)
+        super().__init__(
+            leagueId, years, ownerNamesAndAliases=ownerNamesAndAliases, leagueName=leagueName
+        )
 
         self.__espnS2 = espnS2
         self.__swid = swid
         self.__espnTeamIdToTeamMap: dict[str, Team] = dict()
+        self.__espnDivisionIdToDivisionMap: dict[
+            int, Division
+        ] = dict()  # holds the division info for ONLY the current year
 
     def __getAllLeagues(self) -> list[ESPNLeague]:
         espnLeagueYears = list()
@@ -90,7 +97,6 @@ def __buildLeague(self, espnLeagues: list[ESPNLeague]) -> League:
             self._leagueNameByYear[espnLeague.year] = espnLeague.settings.name
             self.__loadOwners(espnLeague.teams)
             years.append(self.__buildYear(espnLeague))
-        # use the league name from the most recent year
         return League(
             name=self._getLeagueName(), owners=self._owners, years=self._getValidYears(years)
         )
@@ -106,9 +112,21 @@ def __loadOwners(self, espnTeams: list[ESPNTeam]) -> None:
             self._owners = owners
 
     def __buildYear(self, espnLeague: ESPNLeague) -> Year:
+        # save division info
+        for espnDivisionId, espnDivisionName in espnLeague.settings.division_map.items():
+            self.__espnDivisionIdToDivisionMap[espnDivisionId] = Division(name=espnDivisionName)
         teams = self.__buildTeams(espnLeague.teams)
         weeks = self.__buildWeeks(espnLeague)
-        return Year(yearNumber=espnLeague.year, teams=teams, weeks=weeks)
+        # TODO: see if there are cases where ESPN leagues do NOT have divisions
+        year = Year(
+            yearNumber=espnLeague.year,
+            teams=teams,
+            weeks=weeks,
+            divisions=list(self.__espnDivisionIdToDivisionMap.values()),
+        )
+        # clear division info
+        self.__espnDivisionIdToDivisionMap = dict()
+        return year
 
     def __buildWeeks(self, espnLeague: ESPNLeague) -> list[Week]:
         weeks = list()
@@ -205,8 +223,10 @@ def __getESPNTeamByESPNId(espnTeamId: int, espnTeams: list[ESPNTeam]) -> ESPNTea
     def __buildTeams(self, espnTeams: list[ESPNTeam]) -> list[Team]:
         teams = list()
         for espnTeam in espnTeams:
+            # TODO: see if there are cases where ESPN leagues do NOT have divisions
+            divisionId = self.__espnDivisionIdToDivisionMap[espnTeam.division_id].id
             owner = self._getOwnerByName(espnTeam.owner)
-            team = Team(ownerId=owner.id, name=espnTeam.team_name)
+            team = Team(ownerId=owner.id, name=espnTeam.team_name, divisionId=divisionId)
             teams.append(team)
             self.__espnTeamIdToTeamMap[espnTeam.team_id] = team
         return teams

leeger/league_loader/FleaflickerLeagueLoader.py

@@ -13,6 +13,7 @@
 from leeger.model.league.Week import Week
 from leeger.model.league.Year import Year
 from leeger.validate import leagueValidation
+from leeger.model.league.Division import Division
 
 
 class FleaflickerLeagueLoader(LeagueLoader):
@@ -27,16 +28,22 @@ def __init__(
         years: list[int],
         *,
         ownerNamesAndAliases: Optional[dict[str, list[str]]] = None,
+        leagueName: Optional[str] = None,
     ):
         # validation
         try:
             int(leagueId)
         except ValueError:
             raise ValueError(f"League ID '{leagueId}' could not be turned into an int.")
-        super().__init__(leagueId, years, ownerNamesAndAliases=ownerNamesAndAliases)
+        super().__init__(
+            leagueId, years, ownerNamesAndAliases=ownerNamesAndAliases, leagueName=leagueName
+        )
 
         self.__fleaflickerTeamIdToOwnerMap: dict[int, Owner] = dict()
         self.__fleaflickerTeamIdToTeamMap: dict[int, Team] = dict()
+        self.__fleaflickerDivisionIdToDivisionMap: dict[
+            int, Division
+        ] = dict()  # holds the division info for ONLY the current year
 
     def __getAllLeagues(self) -> list[dict]:
         # return a list of all leagues
@@ -82,9 +89,22 @@ def __buildLeague(self, fleaflickerLeagues: list[dict]) -> League:
         return League(name=self._getLeagueName(), owners=owners, years=self._getValidYears(years))
 
     def __buildYear(self, fleaflickerLeague: dict) -> Year:
+        # save division info
+        for fleaflickerDivision in fleaflickerLeague["divisions"]:
+            self.__fleaflickerDivisionIdToDivisionMap[fleaflickerDivision["id"]] = Division(
+                name=fleaflickerDivision["name"]
+            )
         teams = self.__buildTeams(fleaflickerLeague)
         weeks = self.__buildWeeks(fleaflickerLeague)
-        return Year(yearNumber=int(fleaflickerLeague["season"]), teams=teams, weeks=weeks)
+        year = Year(
+            yearNumber=int(fleaflickerLeague["season"]),
+            teams=teams,
+            weeks=weeks,
+            divisions=list(self.__fleaflickerDivisionIdToDivisionMap.values()),
+        )
+        # clear division info
+        self.__fleaflickerDivisionIdToDivisionMap = dict()
+        return year
 
     def __buildWeeks(self, fleaflickerLeague: dict) -> list[Week]:
         weeks = list()
@@ -160,7 +180,11 @@ def __buildTeams(self, fleaflickerLeague: dict) -> list[Team]:
                 teamName = team["name"]
                 teamId = team["id"]
                 owner = self.__fleaflickerTeamIdToOwnerMap[teamId]
-                team = Team(ownerId=owner.id, name=teamName)
+                team = Team(
+                    ownerId=owner.id,
+                    name=teamName,
+                    divisionId=self.__fleaflickerDivisionIdToDivisionMap[division["id"]].id,
+                )
                 teams.append(team)
                 self.__fleaflickerTeamIdToTeamMap[teamId] = team
         return teams