refactor: migrate core models to Pydantic with Pythonic field names

BREAKING CHANGES:
- All model field names are now snake_case (e.g., spring_league instead of springleague)
- Class names standardized to PascalCase (e.g., TeamRecords instead of Teamrecords)
- Models now raise ValidationError instead of TypeError for missing required fields

Models converted:
- Sport, Season
- Venue, Location, TimeZone, FieldInfo, VenueDefaultCoordinates
- League, LeagueRecord
- Division
- Team, TeamRecord, Record, OverallLeagueRecord, TypeRecords, DivisionRecords, LeagueRecords, Records
- Standings, TeamRecords, Streak
- Attendance, AttendanceRecords, AttendanceTotals, AttendanceHighLowGame, AttendanceGameType

Key improvements:
- All models inherit from MLBBaseModel with extra=ignore (handles new API fields gracefully)
- Field aliases maintain API compatibility (e.g., Field(alias=springleague))
- populate_by_name=True allows both old and new names in constructors
- Fixed several type mismatches (season: int, active: bool, elevation: int, etc.)
- Updated all affected tests to use new field names

Author: Mattsface

mlbstatsapi/models/attendances/attendance.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] = []

mlbstatsapi/models/attendances/attributes.py

@@ -1,190 +1,175 @@
-from dataclasses import dataclass, field
-from typing import Optional, Union
+from typing import Optional
+from pydantic import Field
+from mlbstatsapi.models.base import MLBBaseModel
 from mlbstatsapi.models.teams import Team
 
 
-@dataclass
-class AttendanceHighLowGameContent:
+class AttendanceHighLowGameContent(MLBBaseModel):
     """
-    A class to represent attendance records.
+    A class to represent attendance game content.
+
     Attributes
     ----------
     link : str
-        games content endpoint link
+        Games content endpoint link.
     """
     link: str
 
 
-@dataclass
-class AttendanceHighLowGame:
+class AttendanceHighLowGame(MLBBaseModel):
     """
-    A class to represent attendance High and Low games.
+    A class to represent attendance high and low games.
+
     Attributes
     ----------
-    gamepk : int
-        Games Id number
+    game_pk : int
+        Game's ID number.
     link : str
-        games endpoint link
+        Games endpoint link.
     content : AttendanceHighLowGameContent
-        Content for this game
-    daynight : str
-        Type of time of day for game
+        Content for this game.
+    day_night : str
+        Time of day for game (day or night).
     """
-    gamepk: int
+    game_pk: int = Field(alias="gamepk")
     link: str
-    content: Union[AttendanceHighLowGameContent, dict]
-    daynight: str
-
-    def __post_init__(self):
-        self.content = AttendanceHighLowGameContent(**self.content)
+    content: AttendanceHighLowGameContent
+    day_night: str = Field(alias="daynight")
 
 
-@dataclass
-class AttendenceGameType:
+class AttendanceGameType(MLBBaseModel):
     """
-    A class to represent Attendance Game Type.
+    A class to represent attendance game type.
+
     Attributes
     ----------
     id : str
-        Game type id 
+        Game type ID.
     description : str
-        Game type description
+        Game type description.
     """
     id: str
     description: str
 
 
-@dataclass(repr=False)
-class AttendanceRecords:
+class AttendanceRecords(MLBBaseModel):
     """
     A class to represent attendance records.
+
     Attributes
     ----------
-    openingstotal : int
-        Total amount of openings
-    openingstotalaway : int
-        Total amount of opening away games
-    openingstotalhome : int
-        Total amount of opening home games
-    openingstotallost : int
-        Total amount of openings lost
-    gamestotal : int
-        Total amount of games
-    gamesawaytotal : int
-        Total amount of away games
-    gameshometotal : int
-        Total amount of home games
+    openings_total : int
+        Total number of openings.
+    openings_total_away : int
+        Total number of opening away games.
+    openings_total_home : int
+        Total number of opening home games.
+    openings_total_lost : int
+        Total number of openings lost.
+    games_total : int
+        Total number of games.
+    games_away_total : int
+        Total number of away games.
+    games_home_total : int
+        Total number of home games.
     year : str
-        Year as a string
-    attendanceaverageaway : int
-        Average attendance for away games
-    attendanceaveragehome : int
-        Average attendance for home games
-    attendanceaverageytd : int
-        Average attendance year to date
-    attendancehigh : int
-        Attendance High number
-    attendancehighdate : str
-        Attendance high date
-    attendancehighgame : AttendanceHighLowGame
-        Attendance high game
-    attendancelow : int
-        Attendance low number
-    attendancelowdate : str
-         Attendance low date
-    attendancelowgame : AttendanceHighLowGame
-         Attendance low game
-    attendanceopeningaverage : int
-         Attendance opening average
-    attendancetotal : int
-        Attendance total
-    attendancetotalaway : int
-        Attendance total away
-    attendancetotalhome : int
-        Attendance total home
-    gametype : AttendenceGameType
-        Game type
+        Year as a string.
+    attendance_average_away : int
+        Average attendance for away games.
+    attendance_average_home : int
+        Average attendance for home games.
+    attendance_average_ytd : int
+        Average attendance year to date.
+    attendance_high : int
+        Attendance high number.
+    attendance_high_date : str
+        Attendance high date.
+    attendance_high_game : AttendanceHighLowGame
+        Attendance high game.
+    attendance_low : int
+        Attendance low number.
+    attendance_low_date : str
+        Attendance low date.
+    attendance_low_game : AttendanceHighLowGame
+        Attendance low game.
+    attendance_opening_average : int
+        Attendance opening average.
+    attendance_total : int
+        Attendance total.
+    attendance_total_away : int
+        Attendance total away.
+    attendance_total_home : int
+        Attendance total home.
+    game_type : AttendanceGameType
+        Game type.
     team : Team
-        Team
+        Team.
     """
-    openingstotal: int
-    openingstotalaway: int
-    openingstotalhome: int
-    openingstotallost: int
-    gamestotal: int
-    gamesawaytotal: int
-    gameshometotal: int
+    openings_total: int = Field(alias="openingstotal")
+    openings_total_away: int = Field(alias="openingstotalaway")
+    openings_total_home: int = Field(alias="openingstotalhome")
+    openings_total_lost: int = Field(alias="openingstotallost")
+    games_total: int = Field(alias="gamestotal")
+    games_away_total: int = Field(alias="gamesawaytotal")
+    games_home_total: int = Field(alias="gameshometotal")
     year: str
-    attendanceaverageytd: int
-    gametype: Union[AttendenceGameType, dict]
-    team: Union[Team, dict]
-    attendancetotal: Optional[int] = None
-    attendanceaverageaway: Optional[int] = None
-    attendanceaveragehome: Optional[int] = None
-    attendancehigh: Optional[int] = None
-    attendancehighdate: Optional[str] = None
-    attendancehighgame: Optional[Union[AttendanceHighLowGame, dict]] = None
-    attendancelow: Optional[int] = None
-    attendancelowdate: Optional[str] = None
-    attendancelowgame: Optional[Union[AttendanceHighLowGame, dict]] = None
-    attendancetotalaway: Optional[int] = None
-    attendancetotalhome: Optional[int] = None
-    attendanceopeningaverage: Optional[int] = None
-    
-    def __post_init__(self):
-        self.attendancehighgame = AttendanceHighLowGame(**self.attendancehighgame) if self.attendancehighgame else self.attendancehighgame
-        self.attendancelowgame = AttendanceHighLowGame(**self.attendancelowgame) if self.attendancelowgame else self.attendancelowgame
-        self.gameType = AttendenceGameType(**self.gametype)
-        self.team = Team(**self.team)
+    attendance_average_ytd: int = Field(alias="attendanceaverageytd")
+    game_type: AttendanceGameType = Field(alias="gametype")
+    team: Team
+    attendance_total: Optional[int] = Field(default=None, alias="attendancetotal")
+    attendance_average_away: Optional[int] = Field(default=None, alias="attendanceaverageaway")
+    attendance_average_home: Optional[int] = Field(default=None, alias="attendanceaveragehome")
+    attendance_high: Optional[int] = Field(default=None, alias="attendancehigh")
+    attendance_high_date: Optional[str] = Field(default=None, alias="attendancehighdate")
+    attendance_high_game: Optional[AttendanceHighLowGame] = Field(default=None, alias="attendancehighgame")
+    attendance_low: Optional[int] = Field(default=None, alias="attendancelow")
+    attendance_low_date: Optional[str] = Field(default=None, alias="attendancelowdate")
+    attendance_low_game: Optional[AttendanceHighLowGame] = Field(default=None, alias="attendancelowgame")
+    attendance_total_away: Optional[int] = Field(default=None, alias="attendancetotalaway")
+    attendance_total_home: Optional[int] = Field(default=None, alias="attendancetotalhome")
+    attendance_opening_average: Optional[int] = Field(default=None, alias="attendanceopeningaverage")
 
-    def __repr__(self) -> str:
-        kws = [f'{key}={value}' for key, value in self.__dict__.items() if value is not None and value]
-        return "{}({})".format(type(self).__name__, ", ".join(kws))
 
-@dataclass(repr=False)
-class AttendanceTotals:
+class AttendanceTotals(MLBBaseModel):
     """
-    A class to represent attendance aggregate toatls.
+    A class to represent attendance aggregate totals.
+
     Attributes
     ----------
-    openingstotalaway : int
-        Total amount of opening game attendance number
-    openingstotalhome : int
-        Total amount of opening home game attendance number
-    openingstotallost : int
-        Total amount of opening games lost
-    openingstotalytd : int
-        Total amount of opening games year to date
-    attendanceaverageaway : int
-        Average away game attendance
-    attendanceaveragehome : int
-        Average home game attendance
-    attendanceaverageytd : int
-        Average attendance year to date
-    attendancehigh : int
-        Attendance high
-    attendancehighdate : str
-        Attendance high date
-    attendancetotal : int
-        Attendance total
-    attendancetotalaway : int
-        Attendace total away
-    attendancetotalhome : int
-        Attendance total home
+    openings_total_away : int
+        Total opening game attendance number for away games.
+    openings_total_home : int
+        Total opening home game attendance number.
+    openings_total_lost : int
+        Total number of opening games lost.
+    openings_total_ytd : int
+        Total number of opening games year to date.
+    attendance_average_away : int
+        Average away game attendance.
+    attendance_average_home : int
+        Average home game attendance.
+    attendance_average_ytd : int
+        Average attendance year to date.
+    attendance_high : int
+        Attendance high.
+    attendance_high_date : str
+        Attendance high date.
+    attendance_total : int
+        Attendance total.
+    attendance_total_away : int
+        Attendance total away.
+    attendance_total_home : int
+        Attendance total home.
     """
-    openingstotalaway: int
-    openingstotalhome: int
-    openingstotallost: int
-    openingstotalytd: int
-    attendanceaverageytd: int
-    attendancehigh: int
-    attendancehighdate: str
-    attendancetotal: int
-    attendancetotalaway: int
-    attendancetotalhome: int
-    attendanceaverageaway: Optional[int] = None
-    attendanceaveragehome: Optional[int] = None
-
-    def __repr__(self) -> str:
-        kws = [f'{key}={value}' for key, value in self.__dict__.items() if value is not None and value]
-        return "{}({})".format(type(self).__name__, ", ".join(kws))
+    openings_total_away: int = Field(alias="openingstotalaway")
+    openings_total_home: int = Field(alias="openingstotalhome")
+    openings_total_lost: int = Field(alias="openingstotallost")
+    openings_total_ytd: int = Field(alias="openingstotalytd")
+    attendance_average_ytd: int = Field(alias="attendanceaverageytd")
+    attendance_high: int = Field(alias="attendancehigh")
+    attendance_high_date: str = Field(alias="attendancehighdate")
+    attendance_total: int = Field(alias="attendancetotal")
+    attendance_total_away: int = Field(alias="attendancetotalaway")
+    attendance_total_home: int = Field(alias="attendancetotalhome")
+    attendance_average_away: Optional[int] = Field(default=None, alias="attendanceaverageaway")
+    attendance_average_home: Optional[int] = Field(default=None, alias="attendanceaveragehome")

mlbstatsapi/models/divisions/__init__.py

@@ -1 +1,5 @@
-from .division import Division
+from .division import Division
+from mlbstatsapi.models.leagues import League
+
+# Rebuild to resolve forward reference to League
+Division.model_rebuild()