Items data

This script provides dataclasses that represent the relational data components in the server.

Aircraft dataclass

Bases: BoundedItem, CoreItem

Aircraft instance.

Parameters:

Name	Type	Description	Default
model	str	Aircraft model and ID	required
seat_capacity	int	Seat capacity	required

Source code in src/rmlab/data/items.py

@dataclass
class Aircraft(BoundedItem, CoreItem):
    """Aircraft instance.

    Args:
        model (str): Aircraft model and ID
        seat_capacity (int): Seat capacity
    """

    model: str
    seat_capacity: int

    def __post_init__(self):
        self.seat_capacity = int(self.seat_capacity)

Airline dataclass

Bases: BoundedItem, CoreItem

Airline instance.

Parameters:

Name	Type	Description	Default
name	str	Airline name and ID	required
type	str	Airline type (Either 'low-cost' or 'legacy')	'undefined'

Source code in src/rmlab/data/items.py

@dataclass
class Airline(BoundedItem, CoreItem):
    """Airline instance.

    Args:
        name (str): Airline name and ID
        type (str): Airline type (Either 'low-cost' or 'legacy')
    """

    name: str
    type: str = "undefined"

Airport dataclass

Bases: BoundedItem, CoreItem

Airport instance.

Parameters:

Name	Type	Description	Default
name	str	Full airport name	required
city_id	str	City ID of the airport	required
iata	str	IATA code of the airport	required
icao	str	ICAO code of the airport	'undefined'
altitude	int	Location altitude in MAMSL	0
latitude	int	Location latitude	0
longitude	int	Location longitude	0

Source code in src/rmlab/data/items.py

@dataclass
class Airport(BoundedItem, CoreItem):
    """Airport instance.

    Args:
        name (str): Full airport name
        city_id (str): City ID of the airport
        iata (str): IATA code of the airport
        icao (str): ICAO code of the airport
        altitude (int): Location altitude in MAMSL
        latitude (int): Location latitude
        longitude (int): Location longitude
    """

    name: str
    city_id: str
    iata: str
    icao: str = "undefined"
    altitude: int = 0
    latitude: int = 0
    longitude: int = 0

    def __post_init__(self):
        self.altitude = int(self.altitude)
        self.latitude = int(self.latitude)
        self.longitude = int(self.longitude)

City dataclass

Bases: BoundedItem, CoreItem

City instance.

Parameters:

Name	Type	Description	Default
name	str	City name and ID	required
country_id	str	Country ID of the city	required

Source code in src/rmlab/data/items.py

@dataclass
class City(BoundedItem, CoreItem):
    """City instance.

    Args:
        name (str): City name and ID
        country_id (str): Country ID of the city
    """

    name: str
    country_id: str

CityRoute dataclass

Bases: BoundedItem, DerivedItem, CustomersModelHolder, AirlineLocation

Pair of cities with unspecified direction.

Parameters:

Name	Type	Description	Default
first_id	str	First city ID of the pair in alphabetical order	required
second_id	str	Second city ID of the pair in alphabetical order	required

Source code in src/rmlab/data/items.py

@dataclass
class CityRoute(BoundedItem, DerivedItem, CustomersModelHolder, AirlineLocation):
    """Pair of cities with unspecified direction.

    Args:
        first_id (str): First city ID of the pair in alphabetical order
        second_id (str): Second city ID of the pair in alphabetical order
    """

    first_id: str
    second_id: str

CitySector dataclass

Bases: BoundedItem, DerivedItem, CustomersModelHolder, AirlineLocation

Pair of cities with specified direction.

Parameters:

Name	Type	Description	Default
origin_id	str	Departure city ID	required
destination_id	str	Arrival city ID	required

Source code in src/rmlab/data/items.py

@dataclass
class CitySector(BoundedItem, DerivedItem, CustomersModelHolder, AirlineLocation):
    """Pair of cities with specified direction.

    Args:
        origin_id (str): Departure city ID
        destination_id (str): Arrival city ID
    """

    origin_id: str
    destination_id: str

Country dataclass

Bases: BoundedItem, CoreItem

Country instance.

Parameters:

Name	Type	Description	Default
name	str	Country name and ID	required
currency	CurrencyKind	Country currency	required

Source code in src/rmlab/data/items.py

@dataclass
class Country(BoundedItem, CoreItem):
    """Country instance.

    Args:
        name (str): Country name and ID
        currency (CurrencyKind): Country currency
    """

    name: str
    currency: CurrencyKind

    def __post_init__(self):
        if isinstance(self.currency, str):
            self.currency = CurrencyKind.str_to_enum_value(self.currency)

Flight dataclass

Bases: UnboundedItem, DerivedItem, PricingModelHolder

Flight instance.

Parameters:

Name	Type	Description	Default
seat_capacity	int	Seat capacity	required
schedule_id	str	Schedule ID	required
sector_id	str	Sector ID	required
citysector_id	str	CitySector ID	required
airline_id	str	Airline ID	required
aircraft_id	str	Aircraft ID	required
flight_number	str	Flight number identifier	required
onsale_date_time	datetime	Flight is put on sale this date, upto days (year-month-day)	required
departure_date_time	datetime	Departure date and time, upto minutes (year-month-day-hour-minute)	required
fares	List[str]	List of fare identifiers	required
lowest_pps	int	Price per seat of the lowest fare in cents	required
highest_pps	int	Price per seat of the highest fare in cents	required

Source code in src/rmlab/data/items.py

@dataclass
class Flight(UnboundedItem, DerivedItem, PricingModelHolder):
    """Flight instance.

    Args:
        seat_capacity (int): Seat capacity
        schedule_id (str): Schedule ID
        sector_id (str): Sector ID
        citysector_id (str): CitySector ID
        airline_id (str): Airline ID
        aircraft_id (str): Aircraft ID
        flight_number (str): Flight number identifier
        onsale_date_time (datetime): Flight is put on sale this date, upto days (year-month-day)
        departure_date_time (datetime): Departure date and time, upto minutes (year-month-day-hour-minute)
        fares (List[str]): List of fare identifiers
        lowest_pps (int): Price per seat of the lowest fare in cents
        highest_pps (int): Price per seat of the highest fare in cents
    """

    seat_capacity: int
    schedule_id: str
    sector_id: str
    citysector_id: str
    airline_id: str
    aircraft_id: str
    flight_number: str
    onsale_date_time: datetime
    departure_date_time: datetime
    fares: List[str]
    lowest_pps: int
    highest_pps: int

    def __post_init__(self):
        self.seat_capacity = int(self.seat_capacity)
        self.fares = self.fares.split("-")
        self.lowest_pps = self.lowest_pps
        self.highest_pps = self.highest_pps
        self.onsale_date_time = datetime.strptime(self.onsale_date_time, DateFormat).replace(tzinfo=timezone.utc)
        self.departure_date_time = datetime.strptime(self.departure_date_time, DateTimeMinFormat).replace(tzinfo=timezone.utc)

PModel dataclass

Bases: BoundedItem, CoreItem

Item holding a set of parameters.

Parameters:

Name	Type	Description	Default
filename	str	Name of file storing the parameters	required
hash	str	MD5 hash of the content	required
cnt	str	Model content	required

Source code in src/rmlab/data/items.py

@dataclass
class PModel(BoundedItem, CoreItem):
    """Item holding a set of parameters.

    Args:
        filename (str): Name of file storing the parameters
        hash (str): MD5 hash of the content
        cnt (str): Model content
    """

    filename: str
    hash: str
    cnt: str

Route dataclass

Bases: BoundedItem, DerivedItem, AirlineLocation

Pair of airports with unspecified direction.

Parameters:

Name	Type	Description	Default
first_id	str	First airport ID of the pair in alphabetical order	required
second_id	str	Second airport ID of the pair in alphabetical order	required

Source code in src/rmlab/data/items.py

@dataclass
class Route(BoundedItem, DerivedItem, AirlineLocation):
    """Pair of airports with unspecified direction.

    Args:
        first_id (str): First airport ID of the pair in alphabetical order
        second_id (str): Second airport ID of the pair in alphabetical order
    """

    first_id: str
    second_id: str
    cityroute_id: str

Schedule dataclass

Bases: UnboundedItem, CoreItem

Schedule instance. Template generator for flights in an airline with common aircraft, sector and days of week.

Parameters:

Name	Type	Description	Default
airline_id	str	Airline ID	required
aircraft_id	str	Aircraft ID	required
origin_id	str	Departure airport ID	required
destination_id	str	Arrival airport ID	required
days_of_week	List[DayOfWeek]	Days of week	required
departure_time	timedelta	Departure time upto minutes (hour-minutes)	required
duration	timedelta	Flight duration upto minutes (hour-minutes)	required
flight_number	int	Flight number identifier	required
sell_before_days	int	Flights are put on sale these days before departure day	required
from_date	datetime	Start date of the range of flight departures, upto days (year-month-day)	required
to_date	datetime	End date of the range of flight departures, up to days (year-month-day)	required
sector_id	str	Sector ID	required
citysector_id	str	CitySector ID	required
route_id	str	Route ID	required
cityroute_id	str	CityRoute ID	required
from_date_load	datetime	Start date of the selling period, upto days (year-month-day)	required
to_date_load	datetime	End date of the selling period, upto days (year-month-day)	required
from_date_departure	datetime	Date of the first departure, upto days (year-month-day)	required
to_date_departure	datetime	Date of the last departure, up to days (year-month-day)	required

Source code in src/rmlab/data/items.py

@dataclass
class Schedule(UnboundedItem, CoreItem):
    """Schedule instance. Template generator for flights in an airline with common aircraft, sector and days of week.

    Args:
        airline_id (str): Airline ID
        aircraft_id (str): Aircraft ID
        origin_id (str): Departure airport ID
        destination_id (str): Arrival airport ID
        days_of_week (List[DayOfWeek]): Days of week
        departure_time (timedelta): Departure time upto minutes (hour-minutes)
        duration (timedelta): Flight duration upto minutes (hour-minutes)
        flight_number (int): Flight number identifier
        sell_before_days (int): Flights are put on sale these days before departure day
        from_date (datetime): Start date of the range of flight departures, upto days (year-month-day)
        to_date (datetime): End date of the range of flight departures, up to days (year-month-day)
        sector_id (str): Sector ID
        citysector_id (str): CitySector ID
        route_id (str): Route ID
        cityroute_id (str): CityRoute ID
        from_date_load (datetime): Start date of the selling period, upto days (year-month-day)
        to_date_load (datetime): End date of the selling period, upto days (year-month-day)
        from_date_departure (datetime): Date of the first departure, upto days (year-month-day)
        to_date_departure (datetime): Date of the last departure, up to days (year-month-day)

    """

    airline_id: str
    aircraft_id: str
    origin_id: str
    destination_id: str
    days_of_week: List[DayOfWeek]
    departure_time: timedelta
    duration: timedelta
    flight_number: str
    sell_before_days: int
    from_date: datetime
    to_date: datetime
    sector_id: str
    citysector_id: str
    route_id: str
    cityroute_id: str
    from_date_load: datetime
    to_date_load: datetime
    from_date_departure: datetime
    to_date_departure: datetime

    def __post_init__(self):

        self.sell_before_days = int(self.sell_before_days)

        if isinstance(self.days_of_week, int):
            self.days_of_week = str(self.days_of_week)

        self.days_of_week = [
            DayOfWeek.int_to_enum_value(int(d))
            for d in self.days_of_week.replace("-", "")
        ]

        self.departure_time = self.departure_time

        if isinstance(self.from_date, str):
            self.from_date = datetime.strptime(self.from_date, DateFormat).replace(tzinfo=timezone.utc)
        elif not isinstance(self.from_date, datetime):
            raise TypeError(f"Expected string or datetime in field `from_date`")
        if isinstance(self.to_date, str):
            self.to_date = datetime.strptime(self.to_date, DateFormat).replace(tzinfo=timezone.utc)
        elif not isinstance(self.to_date, datetime):
            raise TypeError(f"Expected string or datetime in field `to_date`")
        # Expect following datetime fields to be strings since they come from server
        self.from_date_load = datetime.strptime(self.from_date_load, DateFormat).replace(tzinfo=timezone.utc)
        self.to_date_load = datetime.strptime(self.to_date_load, DateFormat).replace(tzinfo=timezone.utc)
        self.from_date_departure = datetime.strptime(self.from_date_departure, DateFormat).replace(tzinfo=timezone.utc)
        self.to_date_departure = datetime.strptime(self.to_date_departure, DateFormat).replace(tzinfo=timezone.utc)

        self.departure_time = timedelta(minutes=int(self.departure_time))
        self.duration = timedelta(minutes=int(self.duration))

Sector dataclass

Bases: BoundedItem, DerivedItem, AirlineLocation

Pair of airports with specified direction.

Parameters:

Name	Type	Description	Default
origin_id	str	Departure airport ID	required
destination_id	str	Arrival airport ID	required

Source code in src/rmlab/data/items.py

@dataclass
class Sector(BoundedItem, DerivedItem, AirlineLocation):
    """Pair of airports with specified direction.

    Args:
        origin_id (str): Departure airport ID
        destination_id (str): Arrival airport ID
    """

    origin_id: str
    destination_id: str
    citysector_id: str