Pro Week

griddy / nfl / models / entities / pro_week**

pro_week

Attributes

ProWeekWeekType module-attribute

ProWeekWeekType = Literal['HOF', 'PRE', 'REG']

Type of week

Classes

ProWeekTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.entities.pro_week.ProWeekTypedDict[ProWeekTypedDict]

              

              click griddy.nfl.models.entities.pro_week.ProWeekTypedDict href "" "griddy.nfl.models.entities.pro_week.ProWeekTypedDict"
            

Attributes

bye_teams instance-attribute

bye_teams: NotRequired[List[TeamTypedDict]]

Teams on bye this week (empty array if no bye teams)

date_begin instance-attribute

date_begin: NotRequired[date]

First day of the week

date_end instance-attribute

date_end: NotRequired[date]

Last day of the week

season instance-attribute

season: NotRequired[int]

Season year

season_type instance-attribute

season_type: NotRequired[SeasonTypeEnum]

Type of NFL season

season_type_week instance-attribute

season_type_week: NotRequired[str]

Combined season type and week identifier

text instance-attribute

text: NotRequired[str]

Human-readable week description

week instance-attribute

week: NotRequired[int]

Week number (0 for Hall of Fame game)

week_slug instance-attribute

week_slug: NotRequired[str]

Week identifier slug

week_type instance-attribute

week_type: NotRequired[ProWeekWeekType]

Type of week

ProWeek

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.entities.pro_week.ProWeek[ProWeek]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.pro_week.ProWeek
                


              click griddy.nfl.models.entities.pro_week.ProWeek href "" "griddy.nfl.models.entities.pro_week.ProWeek"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

bye_teams class-attribute instance-attribute

bye_teams: Annotated[
    Optional[List[Team]], Field(alias="byeTeams")
] = None

Teams on bye this week (empty array if no bye teams)

date_begin class-attribute instance-attribute

date_begin: Annotated[
    Optional[date], Field(alias="dateBegin")
] = None

First day of the week

date_end class-attribute instance-attribute

date_end: Annotated[
    Optional[date], Field(alias="dateEnd")
] = None

Last day of the week

season class-attribute instance-attribute

season: Optional[int] = None

Season year

season_type class-attribute instance-attribute

season_type: Annotated[
    Optional[SeasonTypeEnum], Field(alias="seasonType")
] = None

Type of NFL season

season_type_week class-attribute instance-attribute

season_type_week: Annotated[
    Optional[str], Field(alias="seasonTypeWeek")
] = None

Combined season type and week identifier

text class-attribute instance-attribute

text: Optional[str] = None

Human-readable week description

week class-attribute instance-attribute

week: Optional[int] = None

Week number (0 for Hall of Fame game)

week_slug class-attribute instance-attribute

week_slug: Annotated[
    Optional[str], Field(alias="weekSlug")
] = None

Week identifier slug

week_type class-attribute instance-attribute

week_type: Annotated[
    Optional[ProWeekWeekType], Field(alias="weekType")
] = None

Type of week