refactor: migrate schedules, drafts, and awards models to Pydantic

Models converted:

schedules/ (4 classes):
- Schedule, ScheduleDates, ScheduleGames, ScheduleHomeAndAway, ScheduleGameTeam

drafts/ (4 classes):
- Round, DraftPick, DraftHome, DraftSchool

awards/ (2 classes):
- Awards, Award

Key changes:
- All fields use snake_case with aliases for API compatibility
- Class names: Home -> DraftHome, School -> DraftSchool (avoid conflicts)
- Fixed optional fields: DraftSchool.city/state/school_class, DraftHome.state
- Field validators handle empty dicts from API as None
- Updated all related tests to use new Pythonic field names
- Changed TypeError expectations to ValidationError in tests

Author: Mattsface

mlbstatsapi/models/awards/__init__.py

@@ -1,2 +1,2 @@
 from .awards import Awards
-from .attributes import Award
+from .attributes import Award

mlbstatsapi/models/awards/attributes.py

@@ -1,47 +1,37 @@
-from typing import Union, Optional
-from dataclasses import dataclass
-
+from typing import Optional
+from mlbstatsapi.models.base import MLBBaseModel
 from mlbstatsapi.models.teams import Team
 from mlbstatsapi.models.people import Person
 
-@dataclass(kw_only=True, repr=False)
-class Award:
+
+class Award(MLBBaseModel):
     """
-    This class represents an award object
+    A class representing an award.
 
     Attributes
     ----------
     id : str
-        Award id
+        Award ID.
     name : str
-        Name of the award
+        Name of the award.
     date : str
-        Date of when award was given
+        Date of when award was given.
     season : str
-        Season award is for/from
+        Season award is for/from.
     team : Team
-        Team award was to/ Player is from
+        Team award was to / Player is from.
     player : Person
-        Person award is for
-    votes : int None
-        Any votes associated with award
-    notes : str  None
-        Any notes associated with award
+        Person award is for.
+    votes : int
+        Any votes associated with award.
+    notes : str
+        Any notes associated with award.
     """
-
     id: str
     name: str
     date: str
     season: str
-    team: Union[Team, dict]
-    player: Union[Person, dict]
+    team: Team
+    player: Person
     votes: Optional[int] = None
     notes: Optional[str] = None
-
-    def __post_init__(self):
-        self.team = Team(**self.team)
-        self.player = Person(**self.player)
-
-    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))

mlbstatsapi/models/awards/awards.py

@@ -1,17 +1,15 @@
 from typing import List
-from dataclasses import dataclass
-
+from mlbstatsapi.models.base import MLBBaseModel
 from .attributes import Award
 
-@dataclass
-class Awards:
+
+class Awards(MLBBaseModel):
     """
-    This class represents an awards object
+    A class representing an awards collection.
 
     Attributes
     ----------
     awards : List[Award]
-        Awards
+        List of awards.
     """
-
-    awards: List[Award]
+    awards: List[Award] = []

mlbstatsapi/models/drafts/__init__.py

@@ -1 +1,2 @@
-from .rounds import Round
+from .rounds import Round, DraftPick
+from .attributes import DraftHome, DraftSchool

mlbstatsapi/models/drafts/attributes.py

@@ -1,10 +1,11 @@
-from dataclasses import dataclass, field
+from typing import Optional
+from pydantic import Field
+from mlbstatsapi.models.base import MLBBaseModel
 
 
-@dataclass
-class Home:
+class DraftHome(MLBBaseModel):
     """
-    A home is a where a draft player is from
+    A class representing where a draft player is from.
 
     Attributes
     ----------
@@ -16,19 +17,19 @@ class Home:
         The country where the player is from.
     """
     city: str
-    state: str
     country: str
+    state: Optional[str] = None
 
-@dataclass
-class School:
+
+class DraftSchool(MLBBaseModel):
     """
-    Represents the school the draft player is from.
+    A class representing the school the draft player is from.
 
     Attributes
     ----------
     name : str
         The name of the school.
-    schoolclass : str
+    school_class : str
         The class the student is in.
     city : str
         The city where the school is located.
@@ -38,7 +39,7 @@ class School:
         The state where the school is located.
     """
     name: str
-    schoolclass: str
-    city: str
     country: str
-    state: str
+    state: Optional[str] = None
+    school_class: Optional[str] = Field(default=None, alias="schoolclass")
+    city: Optional[str] = None

mlbstatsapi/models/drafts/rounds.py

@@ -1,97 +1,88 @@
-from dataclasses import dataclass, field
-from typing import List, Optional, Union
-
-from .attributes import School, Home
+from typing import List, Optional
+from pydantic import Field
+from mlbstatsapi.models.base import MLBBaseModel
 from mlbstatsapi.models.teams import Team
 from mlbstatsapi.models.people import Person
 from mlbstatsapi.models.data import CodeDesc
+from .attributes import DraftSchool, DraftHome
+
 
-@dataclass(repr=False)
-class DraftPick:
+class DraftPick(MLBBaseModel):
     """
-    Represents a pick made in the MLB draft.
+    A class representing a pick made in the MLB draft.
 
     Attributes
     ----------
-    bisplayerid : int
-        The unique identifier of the player associated with this draft pick.
-    pickround : str
+    team : Team
+        The team that made this draft pick.
+    draft_type : CodeDesc
+        Information about the type of draft in which this pick was made.
+    is_drafted : bool
+        Whether or not the player associated with this pick has been drafted.
+    is_pass : bool
+        Whether or not the team passed on making a pick in this round.
+    year : str
+        The year in which the draft took place.
+    school : DraftSchool
+        Information about the player's school or college.
+    home : DraftHome
+        Information about the player's home location.
+    pick_round : str
         The round of the draft in which this pick was made.
-    picknumber : int
+    pick_number : int
         The number of the pick in the round.
-    displaypicknumber : int
+    display_pick_number : int
         The overall pick number displayed.
-    roundpicknumber : int
+    round_pick_number : int
         The number of the pick overall in the draft.
+    headshot_link : str
+        A link to a headshot image of the player.
+    person : Person
+        The person drafted.
+    bis_player_id : int
+        The unique identifier of the player associated with this draft pick.
     rank : int
         The rank of the player among all players eligible for the draft.
-    pickvalue : str
+    pick_value : str
         The value of the pick, if known.
-    signingbonus : str
+    signing_bonus : str
         The signing bonus associated with this pick, if known.
-    home : Home
-        Information about the player's home location.
-    scoutingreport : str
-    A   scouting report on the player's abilities.
-    school : School
-        Information about the player's school or college.
+    scouting_report : str
+        A scouting report on the player's abilities.
     blurb : str
-        A   brief summary of the player's background and accomplishments.
-    headshotlink : str
-        A   link to a headshot image of the player.
-    team : Team or dict
-        The team that made this draft pick.
-    drafttype : CodeDesc
-        Information about the type of draft in which this pick was made.
-    isdrafted : bool
-        Whether or not the player associated with this pick has been drafted.
-    ispass : bool
-        Whether or not the team passed on making a pick in this round.
-    year : str
-        The year in which the draft took place.
+        A brief summary of the player's background and accomplishments.
     """
-    team: Union[Team, dict]
-    drafttype: Union[CodeDesc, dict]
-    isdrafted: bool
-    ispass: bool
+    team: Team
+    draft_type: CodeDesc = Field(alias="drafttype")
+    is_drafted: bool = Field(alias="isdrafted")
+    is_pass: bool = Field(alias="ispass")
     year: str
-    school: Union[School , dict] 
-    home: Union[Home, dict]
-    pickround:  str
-    picknumber:  int
-    displaypicknumber: int
-    roundpicknumber:  int
-    headshotlink: Optional[str] = None
-    person: Optional[Union[Person, dict]] = None
-    bisplayerid: Optional[int] = None
+    school: DraftSchool
+    home: DraftHome
+    pick_round: str = Field(alias="pickround")
+    pick_number: int = Field(alias="picknumber")
+    display_pick_number: int = Field(alias="displaypicknumber")
+    round_pick_number: int = Field(alias="roundpicknumber")
+    headshot_link: Optional[str] = Field(default=None, alias="headshotlink")
+    person: Optional[Person] = None
+    bis_player_id: Optional[int] = Field(default=None, alias="bisplayerid")
     rank: Optional[int] = None
-    pickvalue: Optional[str] = None
-    signingbonus:  Optional[str] = None
-    scoutingreport: Optional[str] = None
+    pick_value: Optional[str] = Field(default=None, alias="pickvalue")
+    signing_bonus: Optional[str] = Field(default=None, alias="signingbonus")
+    scouting_report: Optional[str] = Field(default=None, alias="scoutingreport")
     blurb: Optional[str] = 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))
 
-@dataclass(repr=False)
-class Round:
+class Round(MLBBaseModel):
     """
-    Represents a round of the MLB draft.
+    A class representing a round of the MLB draft.
 
     Attributes
     ----------
     round : str
         The round number of the draft, represented as a string.
     picks : List[DraftPick]
-        A list of DraftPick objects representing the picks made in this round of the draft.
+        A list of DraftPick objects representing the picks made in this round.
     """
     round: str
-    picks: List[DraftPick]
-
-    def __post_init__(self):
-        self.picks = [DraftPick(**pick) for pick in self.picks]
-
-    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))
+    picks: List[DraftPick] = []

mlbstatsapi/models/schedules/__init__.py

@@ -1,2 +1,2 @@
 from .schedule import Schedule
-from .attributes import ScheduleGames
+from .attributes import ScheduleGames, ScheduleDates, ScheduleHomeAndAway, ScheduleGameTeam