Path

class passengersim.config.Path[source]

Bases: BaseModel

A travel path from an origin to a destination, comprised of one or more legs.

Attributes:

path_id

Optional numeric identifier for the path.

orig

Identifier code for the path origin.

dest

Identifier code for the path destination.

path_quality_index

A numeric index representing the quality of the path.

legs

Leg IDs of the legs comprising the path, in order from origin to destination.

market_identifier

A tilde-separated string identifying the origin–destination market.

path_id : int | None

Optional numeric identifier for the path.

orig : str

Identifier code for the path origin.

This is typically the IATA airport code for the origin airport, but it may be a different code if the path is being used in a non-air-travel context, or if the airport is a hypothetical place that does not have an assigned IATA code.

dest : str

Identifier code for the path destination.

This is typically the IATA airport code for the destination airport, but it may be a different code if the path is being used in a non-air-travel context, or if the airport is a hypothetical place that does not have an assigned IATA code.

path_quality_index : float

A numeric index representing the quality of the path.

Lower values typically indicate a more desirable itinerary. This is typically the number of connections on the path but could also be some other quality measure.

legs : list[int]

Leg IDs of the legs comprising the path, in order from origin to destination.

At least one leg is required.

property market_identifier : str

A tilde-separated string identifying the origin–destination market.

Returns:

str – A string of the form "<orig>~<dest>", e.g. "JFK~LAX".