Paths

Path

Bases: BaseModel

Source code in src/passengersim/config/paths.py

class Path(BaseModel, extra="forbid"):
    path_id: int | None = None
    orig: str
    dest: str
    path_quality_index: float

    legs: list[int]
    """Flight numbers of legs comprising the path."""

    @field_validator("legs", mode="before")
    def allow_single_leg(cls, v):
        """Allow a single leg path to be just an int not a list of one int."""
        if isinstance(v, int):
            v = [v]
        return v

    @field_validator("legs")
    def at_least_one_leg(cls, v):
        """There must be at least one leg."""
        if len(v) < 1:
            raise ValueError("path must have at least one leg")
        return v

dest instance-attribute

dest: str

legs instance-attribute

legs: list[int]

Flight numbers of legs comprising the path.

orig instance-attribute

orig: str

path_id class-attribute instance-attribute

path_id: int | None = None

path_quality_index instance-attribute

path_quality_index: float

allow_single_leg

allow_single_leg(v)

Allow a single leg path to be just an int not a list of one int.

Source code in src/passengersim/config/paths.py

@field_validator("legs", mode="before")
def allow_single_leg(cls, v):
    """Allow a single leg path to be just an int not a list of one int."""
    if isinstance(v, int):
        v = [v]
    return v

at_least_one_leg

at_least_one_leg(v)

There must be at least one leg.

Source code in src/passengersim/config/paths.py

@field_validator("legs")
def at_least_one_leg(cls, v):
    """There must be at least one leg."""
    if len(v) < 1:
        raise ValueError("path must have at least one leg")
    return v