Person

griddy / nfl / models / entities / person**

person

Classes

PersonTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.entities.person.PersonTypedDict[PersonTypedDict]

              

              click griddy.nfl.models.entities.person.PersonTypedDict href "" "griddy.nfl.models.entities.person.PersonTypedDict"
            

Attributes

id_ instance-attribute

id_: str

UUUID assigned by the NFL

college_names instance-attribute

college_names: NotRequired[List[str]]

Colleges the person attended

display_name instance-attribute

display_name: str

First and last name

birth_date instance-attribute

birth_date: NotRequired[str]

Person's date of birth as YYYY-MM-DD

first_name instance-attribute

first_name: str

Person's formal first name

common_first_name instance-attribute

common_first_name: str

e.g. Mike instead of Michael

esb_id instance-attribute

esb_id: str

Another form of ID tracked by the NFL

gsis_id instance-attribute

gsis_id: NotRequired[str]

Yet another ID

headshot instance-attribute

headshot: NotRequired[str]

A URL for the person's headshot used in Media

height instance-attribute

height: int

Person's height rounded to nearest whole inch

internation_exempt instance-attribute

internation_exempt: bool

Not sure what this is

jersey_number instance-attribute

jersey_number: NotRequired[str]

Number the player wears on the field.

last_name instance-attribute

last_name: str

Person's surname

nfl_experience instance-attribute

nfl_experience: int

Number of years the person has been a part of the NFL

position instance-attribute

position: str

Player's position on the field

position_group instance-attribute

position_group: str

Player's position group

status instance-attribute

status: str

Whether the player is active or retired

weight instance-attribute

weight: int

Player's weight rounded to the nearest pound

Person

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.entities.person.Person[Person]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.person.Person
                


              click griddy.nfl.models.entities.person.Person href "" "griddy.nfl.models.entities.person.Person"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

id_ instance-attribute

id_: Annotated[str, Field(alias=id)]

UUUID assigned by the NFL

college_names instance-attribute

college_names: Annotated[
    Optional[List[str]], Field(alias=collegeNames)
]

Colleges the person attended

display_name instance-attribute

display_name: Annotated[str, Field(alias=displayName)]

First and last name

birth_date class-attribute instance-attribute

birth_date: Annotated[
    Optional[str], Field(alias=birthDate)
] = None

Person's date of birth as YYYY-MM-DD

first_name instance-attribute

first_name: Annotated[str, Field(alias=firstName)]

Person's formal first name

common_first_name instance-attribute

common_first_name: Annotated[
    str, Field(alias=commonFirstName)
]

e.g. Mike instead of Michael

esb_id instance-attribute

esb_id: Annotated[str, Field(alias=esbId)]

Another form of ID tracked by the NFL

gsis_id class-attribute instance-attribute

gsis_id: Annotated[Optional[str], Field(alias=gsisId)] = (
    None
)

Yet another ID

headshot class-attribute instance-attribute

headshot: Optional[str] = None

A URL for the person's headshot used in Media

height instance-attribute

height: int

Person's height rounded to nearest whole inch

internation_exempt instance-attribute

internation_exempt: Annotated[
    bool, Field(alias=internationalExempt)
]

Not sure what this is

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[str],
    Field(alias=jerseyNumber),
    BeforeValidator(int_to_str),
] = None

Number the player wears on the field.

last_name instance-attribute

last_name: Annotated[str, Field(alias=lastName)]

Person's surname

nfl_experience instance-attribute

nfl_experience: Annotated[int, Field(alias=nflExperience)]

Number of years the person has been a part of the NFL

position instance-attribute

position: str

Player's position on the field

position_group instance-attribute

position_group: Annotated[str, Field(alias=positionGroup)]

Player's position group

status instance-attribute

status: str

Whether the player is active or retired

weight instance-attribute

weight: int

Player's weight rounded to the nearest pound