leaguemanager.models.base¶
Base classes for database objects are loosely based on IPTC Sport Schema. see: https://sportschema.org
Module Contents¶
Classes¶
Base class for organization responsible for running competitions. |
|
Base class for competitions. Can be child of Governing Body or other Competitions. |
|
A sub-group of events within a competition (i.e., regular, semifinals, knockout round, etc…) |
|
Base class for an event (match/fixture) that produces results. |
|
Base class for actions related to an event. |
|
Base class for rules or properties. |
|
Base class for Individual, Team, or Club. |
|
All individuals will inherit these properties, but properties optional to allow anonymous usage. |
|
Defines membership of an entity in another entity for a given time. |
|
Base class for a given site. |
|
Base class for modeling participation of an actor in an event. |
|
Base class for team stats in an Event. |
|
Base class for involvement of Officials in an Event. |
|
Base class for individual stats in an Event. |
Data¶
API¶
- leaguemanager.models.base.mapper¶
‘registry(…)’
- leaguemanager.models.base.metadata¶
‘MetaData(…)’
- class leaguemanager.models.base.UUIDBase¶
- id: uuid.UUID¶
‘field(…)’
- to_dict(exclude: set[str] | None = None) dict[str, Any]¶
Convert model to dictionary.
Returns: Dict[str, Any]: A dict representation of the model
- str_to_iso(format: str)¶
Converts string to datetime object.
- class leaguemanager.models.base.UUIDAuditBase¶
Bases:
leaguemanager.models.base.UUIDBase- created_at: datetime.datetime¶
‘field(…)’
- updated_at: datetime.datetime¶
‘field(…)’
- class leaguemanager.models.base.GoverningBodyBase¶
Bases:
leaguemanager.models.base.UUIDAuditBaseBase class for organization responsible for running competitions.
- org_type: str | None¶
‘field(…)’
- class leaguemanager.models.base.CompetitionBase¶
Bases:
leaguemanager.models.base.UUIDAuditBaseBase class for competitions. Can be child of Governing Body or other Competitions.
The competition_type attribute should describe whether the object is meant to be a recurring construct (i.e., recurring-competition), or something finite (i.e., competition, tournament). The value of this property will vary based on the object that inherits this class.
#TODO: May need to create a constraint with pre-determined types.
- class leaguemanager.models.base.CompetitionPhaseBase¶
Bases:
leaguemanager.models.base.CompetitionBaseA sub-group of events within a competition (i.e., regular, semifinals, knockout round, etc…)
- phase_type: str | None¶
‘field(…)’
- class leaguemanager.models.base.EventBase¶
Bases:
leaguemanager.models.base.UUIDAuditBaseBase class for an event (match/fixture) that produces results.
- class leaguemanager.models.base.ActionBase¶
Bases:
leaguemanager.models.base.UUIDAuditBaseBase class for actions related to an event.
- class leaguemanager.models.base.PropertiesBase¶
Bases:
leaguemanager.models.base.UUIDAuditBaseBase class for rules or properties.
- class leaguemanager.models.base.AgentBase¶
Bases:
leaguemanager.models.base.UUIDAuditBaseBase class for Individual, Team, or Club.
- class leaguemanager.models.base.IndividualBase¶
Bases:
leaguemanager.models.base.AgentBaseAll individuals will inherit these properties, but properties optional to allow anonymous usage.
- first_name: str | None¶
‘field(…)’
- last_name: str | None¶
‘field(…)’
- middle_name: str | None¶
‘field(…)’
- full_name: str | None¶
‘field(…)’
- alias: str | list[str] | None¶
‘field(…)’
- email: str | None¶
‘field(…)’
- mobile_phone: str | None¶
‘field(…)’
- class leaguemanager.models.base.MembershipBase¶
Bases:
leaguemanager.models.base.UUIDAuditBaseDefines membership of an entity in another entity for a given time.
- class leaguemanager.models.base.SiteBase¶
Bases:
leaguemanager.models.base.UUIDBaseBase class for a given site.
- class leaguemanager.models.base.ParticipationBase¶
Bases:
leaguemanager.models.base.UUIDAuditBaseBase class for modeling participation of an actor in an event.
- class leaguemanager.models.base.TeamParticipationBase¶
Bases:
leaguemanager.models.base.ParticipationBaseBase class for team stats in an Event.
- class leaguemanager.models.base.OfficialParticipationBase¶
Bases:
leaguemanager.models.base.ParticipationBaseBase class for involvement of Officials in an Event.
- class leaguemanager.models.base.IndividualParticipationBase¶
Bases:
leaguemanager.models.base.ParticipationBaseBase class for individual stats in an Event.