Skip to content

Legs

Leg

Bases: BaseModel

Source code in passengersim/config/legs.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
class Leg(BaseModel, extra="forbid"):
    carrier: str
    fltno: int
    """A unique identifier for this leg.

    Each leg in a network should have a globally unique identifier (i.e. even
    if the carrier is different, `fltno` values should be unique.
    """

    orig: str
    """Origination location for this leg."""

    dest: str
    """Destination location for this leg."""

    date: datetime = datetime.fromisoformat("2020-03-01")
    """Date for this leg."""

    dep_time: int
    """Departure time for this leg in Unix time.

    In input files, this can be specified as a string in the format "HH:MM",
    with the hour in 24-hour format.

    Unix time is the number of seconds since 00:00:00 UTC on 1 Jan 1970."""

    arr_time: int
    """Arrival time for this leg in Unix time.

    In input files, this can be specified as a string in the format "HH:MM",
    with the hour in 24-hour format.

    Unix time is the number of seconds since 00:00:00 UTC on 1 Jan 1970."""

    capacity: int
    distance: float | None = None

    @field_validator("date", mode="before")
    def _date_from_string(cls, v):
        if isinstance(v, str):
            v = datetime.fromisoformat(v)
        return v

    @field_validator("dep_time", "arr_time", mode="before")
    def _timestring_to_int(cls, v, info: ValidationInfo):
        if isinstance(v, str) and ":" in v:
            dep_time_str = v.split(":")
            hh, mm = int(dep_time_str[0]), int(dep_time_str[1])
            v = create_timestamp(info.data["date"], 0, hh, mm)
        if info.field_name == "arr_time":
            if v < info.data["dep_time"]:
                v += 86400  # add a day (in seconds) as arr time is next day
        return v

arr_time instance-attribute 

arr_time: int

Arrival time for this leg in Unix time.

In input files, this can be specified as a string in the format "HH:MM", with the hour in 24-hour format.

Unix time is the number of seconds since 00:00:00 UTC on 1 Jan 1970.

capacity instance-attribute 

capacity: int

carrier instance-attribute 

carrier: str

date class-attribute instance-attribute 

date: datetime = datetime.fromisoformat('2020-03-01')

Date for this leg.

dep_time instance-attribute 

dep_time: int

Departure time for this leg in Unix time.

In input files, this can be specified as a string in the format "HH:MM", with the hour in 24-hour format.

Unix time is the number of seconds since 00:00:00 UTC on 1 Jan 1970.

dest instance-attribute 

dest: str

Destination location for this leg.

distance class-attribute instance-attribute 

distance: float | None = None

fltno instance-attribute 

fltno: int

A unique identifier for this leg.

Each leg in a network should have a globally unique identifier (i.e. even if the carrier is different, fltno values should be unique.

orig instance-attribute 

orig: str

Origination location for this leg.