woob.capabilities.travel
¶
- class Station(id=None, name=None, url=None)[source]¶
Bases:
BaseObject
Describes a station.
- Variables
url – (
str
) urlname – (
str
) Name of station
- class Departure(id=None, _type=None, _time=None, url=None)[source]¶
Bases:
BaseObject
Describes a departure.
- Variables
url – (
str
) urltype – (
str
) Type of traintime – (
time
,datetime
) Departure timedeparture_station – (
str
) Departure stationarrival_station – (
str
) Destination of the trainarrival_time – (
time
,datetime
) Arrival timelate – (
time
,datetime
) Optional late (default: 00:00:00)information – (
str
) Informationsplateform – (
str
) Where the train will leaveprice – (
Decimal
) Price of ticketcurrency – (
str
) Currency (default: None)
- class RoadStep(id='', url=NotLoaded, backend=None)[source]¶
Bases:
BaseObject
A step on a roadmap.
- Variables
url – (
str
) urlline – (
str
) When linestart_time – (
time
,datetime
) Start of stepend_time – (
time
,datetime
) End of stepdeparture – (
str
) Departure stationarrival – (
str
) Arrival stationduration – (
timedelta
) Duration of this step
- exception RoadmapError[source]¶
Bases:
UserError
Raised when the roadmap is unable to be calculated.
- class RoadmapFilters(id='', url=None)[source]¶
Bases:
BaseObject
Filters to get a roadmap.
- Variables
url – (
str
) urldeparture_time – (
date
,datetime
) Wanted departure timearrival_time – (
date
,datetime
) Wanted arrival time
- class CapTravel[source]¶
Bases:
Capability
Travel websites.
- iter_station_search(pattern)[source]¶
Iterates on search results of stations.
- Parameters
pattern (str) – the search pattern
- Return type
iter[
Station
]
- iter_station_departures(station_id, arrival_id=None, date=None)[source]¶
Iterate on departures.
- Parameters
station_id (str) – the station ID
arrival_id (str) – optionnal arrival station ID
date (datetime.datetime) – optional date
- Return type
iter[
Departure
]
- iter_roadmap(departure, arrival, filters)[source]¶
Get a roadmap.
- Parameters
departure (str) – name of departure station
arrival (str) – name of arrival station
filters (
RoadmapFilters
) – filters on search
- Return type
iter[
RoadStep
]