falcon_alliance.District

class falcon_alliance.District(*args, **kwargs)

Class representing a district containing methods to get specific district information.

key

Key for this district, e.g. 2022chs.

Type:: str

year

Year this district participated.

Type:: int

abbreviation

The short identifier for the district.

Type:: str

display_name

The long name for the district.

Type:: str, optional

class Ranking(team_key: str, rank: int, rookie_bonus: int, other_bonus: int | None = None, point_total: int = 0, event_points: List[dict] | None = None): Class representing a team’s ranking in a given district.

events(simple: bool = False, keys: bool = False) → List[str | Event]

Retrieves a list of events in the given district.

Parameters:

simple (bool) – A boolean that specifies whether the results for each event should be ‘shortened’ and only contain more relevant information.
keys (bool) – A boolean that specifies whether only the keys of the events in a given district should be retrieved.

Returns:

A list of strings with each string representing an event’s key for all the events in the given district or a list of Event objects with each object representing an event in the given district.

Return type:

List[Union[str, falcon_alliance.Event]]

rankings() → List[Ranking]

Retrieves a list of team district rankings for the given district.

Returns:: A list of Ranking objects with each Ranking object representing a team’s district ranking for the given district.
Return type:: List[falcon_alliance.District.Ranking]

teams(simple: bool = False, keys: bool = False) → List[str | Team]

Retrieves a list of teams in the given district.

Parameters:

simple (bool) – A boolean that specifies whether the results for each team should be ‘shortened’ and only contain more relevant information.
keys (bool) – A boolean that specifies whether only the keys of the teams in a given district should be retrieved.

Returns:

A list of strings with each string representing a team’s key for all the teams in the given district or a list of Team objects with each object representing a team in the given district.

Return type:

List[Union[str, falcon_alliance.Team]]