Source code for

# Copyright(C) 2010-2011 Romain Bignon, Julien Hebert
# This file is part of woob.
# woob is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# woob is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License
# along with woob. If not, see <>.

import datetime

from .base import Capability, BaseObject, StringField, DecimalField, UserError
from .date import TimeField, DeltaField, DateField

__all__ = ['Station', 'Departure', 'RoadStep', 'RoadmapError', 'RoadmapFilters', 'CapTravel']

[docs]class Station(BaseObject): """ Describes a station. """ name = StringField('Name of station') def __init__(self, id=None, name=None, url=None): super(Station, self).__init__(id, url) = name def __repr__(self): return "<Station id=%r name=%r>" % (,
[docs]class Departure(BaseObject): """ Describes a departure. """ type = StringField('Type of train') time = TimeField('Departure time') departure_station = StringField('Departure station') arrival_station = StringField('Destination of the train') arrival_time = TimeField('Arrival time') late = TimeField('Optional late', default=datetime.time()) information = StringField('Informations') plateform = StringField('Where the train will leave') price = DecimalField('Price of ticket') currency = StringField('Currency', default=None) def __init__(self, id=None, _type=None, _time=None, url=None): super(Departure, self).__init__(id, url) self.type = _type self.time = _time def __repr__(self): return "<Departure id=%r type=%r time=%r departure=%r arrival=%r>" % (, self.type, self.time.strftime('%H:%M'), self.departure_station, self.arrival_station)
[docs]class RoadStep(BaseObject): """ A step on a roadmap. """ line = StringField('When line') start_time = TimeField('Start of step') end_time = TimeField('End of step') departure = StringField('Departure station') arrival = StringField('Arrival station') duration = DeltaField('Duration of this step')
[docs]class RoadmapError(UserError): """ Raised when the roadmap is unable to be calculated. """
[docs]class RoadmapFilters(BaseObject): """ Filters to get a roadmap. """ departure_time = DateField('Wanted departure time') arrival_time = DateField('Wanted arrival time') def __init__(self, id='', url=None): super(RoadmapFilters, self).__init__(id, url)
[docs]class CapTravel(Capability): """ Travel websites. """
[docs] def iter_station_departures(self, station_id, arrival_id=None, date=None): """ Iterate on departures. :param station_id: the station ID :type station_id: str :param arrival_id: optionnal arrival station ID :type arrival_id: str :param date: optional date :type date: datetime.datetime :rtype: iter[:class:`Departure`] """ raise NotImplementedError()
[docs] def iter_roadmap(self, departure, arrival, filters): """ Get a roadmap. :param departure: name of departure station :type departure: str :param arrival: name of arrival station :type arrival: str :param filters: filters on search :type filters: :class:`RoadmapFilters` :rtype: iter[:class:`RoadStep`] """ raise NotImplementedError()