Processing Functions

aims.roster.duties(html: str) → tuple[tuple[Duty, ...], tuple[AllDayEvent, ...]]

Produces a tuple of aims.data_structures.Duty objects and a tuple of aims.data_structures.AllDayEvent objects from the html of a vertical AIMS Crew Schedule.

Parameters:

html – The HTML of a vertical AIMS crew schedule

Returns:

A tuple consisting of a tuple of aims.data_structures.Duty objects and a tuple of aims.data_structures.AllDayEvent objects.

aims.logbook_report.duties(html: str) → tuple[tuple[Duty, ...], tuple[AllDayEvent, ...]]

Produce a tuple of aims.data_structures.Duty from an the html of an AIMS Pilot Logbook report.

Parameters:

html – The HTML of an AIMS Pilot Logbook report.

Returns:

A tuple consisting of a tuple of aims.data_structures.Duty objects and an empty tuple. The empty tuple is due to maintaining the same function signature as aims.roster.duties() and there being no all day events recorded in the Logbook report

aims.parse.parse(html: str) → tuple[tuple[Duty, ...], tuple[AllDayEvent, ...]]

Do some basic checks on the HTML, then attempt to identify whether it is an AIMS Crew Schedule or an AIMS Pilot Logbook report. If identification is successful, return the results of routing it to the correct duties() function.

Parameters:

html (str) – The text of the HTML file being processed.

Returns:

A tuple of aims.data_structures.Duty objects and a tuple of aims.data_structures.AllDayEvent objects