Merge pull request #237 from zero-sum-seattle/refactor/pydantic-model-migration

Refactor/pydantic model migration

Author: Mattsface

README.md

@@ -16,8 +16,8 @@
 from mlbstatsapi.models.seasons import Season
 from mlbstatsapi.models.drafts import Round
 from mlbstatsapi.models.awards import Award
-from mlbstatsapi.models.gamepace import Gamepace
-from mlbstatsapi.models.homerunderby import Homerunderby
+from mlbstatsapi.models.gamepace import GamePace
+from mlbstatsapi.models.homerunderby import HomeRunDerby
 from mlbstatsapi.models.standings import Standings
 
 from .mlb_dataadapter import MlbDataAdapter
@@ -1099,7 +1099,7 @@ def get_game_ids(self, date: str = None,
 
         return game_ids
 
-    def get_gamepace(self, season: str, sport_id=1, **params) -> Union[Gamepace, None]:
+    def get_gamepace(self, season: str, sport_id=1, **params) -> Union[GamePace, None]:
         """
         Get pace of game metrics for specific sport, league or team.
 
@@ -1164,7 +1164,7 @@ def get_gamepace(self, season: str, sport_id=1, **params) -> Union[Gamepace, Non
             or 'leagues' in mlb_data.data and mlb_data.data['leagues']
             or 'sports' in mlb_data.data and mlb_data.data['sports']):
 
-            return Gamepace(**mlb_data.data)
+            return GamePace(**mlb_data.data)
 
     def get_venue(self, venue_id: int, **params) -> Union[Venue, None]:
         """
@@ -2016,7 +2016,7 @@ def get_awards(self, award_id: str, **params) -> List[Award]:
 
         return awards_list
 
-    def get_homerun_derby(self, game_id, **params) -> Union[Homerunderby, None]:
+    def get_homerun_derby(self, game_id, **params) -> Union[HomeRunDerby, None]:
         """
         The homerun derby endpoint on the Stats API allows for users to 
         request information from the MLB database pertaining to the 
@@ -2036,7 +2036,7 @@ def get_homerun_derby(self, game_id, **params) -> Union[Homerunderby, None]:
 
         Returns
         -------
-        Homerunderby object
+        HomeRunDerby object
 
         See Also
         --------
@@ -2049,7 +2049,7 @@ def get_homerun_derby(self, game_id, **params) -> Union[Homerunderby, None]:
             None
 
         if 'status' in mlb_data.data and mlb_data.data['status']:
-            return Homerunderby(**mlb_data.data)
+            return HomeRunDerby(**mlb_data.data)
 
 
     def get_team_stats(self, team_id: int, stats: list, groups: list, **params) -> dict:

mlbstatsapi/mlb_api.py

@@ -0,0 +1,3 @@
+from .base import MLBBaseModel
+
+__all__ = ["MLBBaseModel"]

mlbstatsapi/models/__init__.py

@@ -1,23 +1,19 @@
-from dataclasses import dataclass, field
-from typing import Union, List
+from typing import List
+from pydantic import Field
+from mlbstatsapi.models.base import MLBBaseModel
 from .attributes import AttendanceTotals, AttendanceRecords
 
-@dataclass
-class Attendance:
+
+class Attendance(MLBBaseModel):
     """
     A class to represent attendance.
+
     Attributes
     ----------
-    copyright : str
-        Copyright message
     records : List[AttendanceRecords]
-        List of attendance records
-    aggregatetotals : AttendanceAggregateTotals
-        Attendence aggregate total numbers for query
+        List of attendance records.
+    aggregate_totals : AttendanceTotals
+        Attendance aggregate total numbers for query.
     """
-    aggregatetotals: Union[AttendanceTotals, dict]
-    records: Union[List[AttendanceRecords], List[dict]] = field(default_factory=list)
-
-    def __post_init__(self):
-        self.records = [AttendanceRecords(**record) for record in self.records if self.records]
-        self.aggregatetotals = AttendanceTotals(**self.aggregatetotals)
+    aggregate_totals: AttendanceTotals = Field(alias="aggregatetotals")
+    records: List[AttendanceRecords] = []