API

General Functions

bvggrabber.api.compute_remaining(start, end)

Compute the number of seconds between start and end and return the number of seconds rounded down to entire minutes. That means:

• [0, 59] => 0
• [60, 119] => 60
• [120, 179] => 120
• [-59, -1] => -60
• [-119, -60] => -120

Parameters:

• start (datetime.datetime) – The start to compute the remaining number of minutes.
• end (datetime.datetime) – The end of the interval

Raises:

TypeError if either of start or end is not a datetime.datetime.

Returns:

The number of remaining seconds rounded to entire minutes

Return type:

int

Base and Main Classes

class bvggrabber.api.Departure(start, end, when, line, since=None, no_add_day=False)

__eq__(other)

Two departures are assumed to be equal iff their remaining time and their destination are equal.

Right now we do not considering the start or line, since that would require some kind of geo location in order to define a total order.

__init__(start, end, when, line, since=None, no_add_day=False)

Parameters:

• start (str) – The start station
• end (str) – The end station
• when – The leaving time of the public transport at the given start station. Might be an int (timestamp), a datetime.datetime instance or a str accepted by dateutil.parse(). If when is smaller than since and the difference between both times is larger than 12 hours (43200sec), the API will add another day unless no_add_day is True.
• line (str) – The line of the public transport
• since – Either None or datetime.datetime. Defines the temporal start for searching. None will internally be resolved as datetime.datetime.now().
• no_add_day (bool) – If true, there no additional day will be added if when is smaller than since. Default False.

Raises:

TypeError if when is invalid or cannot be parsed.

__lt__(other)

A departure is assumed to be less than another iff its remaining time is less than the remaining time of the other departure.

Right now we do not considering the start, end or line, since that would require some kind of geo location in order to define a total order.

remaining

See also

bvggrabber.api.compute_remaining

class bvggrabber.api.QueryApi

call()

Needs to be implemented by inheriting classes!

class bvggrabber.api.Response(state, station=None, departures=None, error=None)

__init__(state, station=None, departures=None, error=None)

Creates a new response. Returned by QueryApi.call()

Parameters:

• state (bool) – True iff the request and parsing was successful, False otherwise.
• station – If a list, the station name is ambiguous. If a string the full qualified name of the station.
• departures – A list of Departure` objects
• error (Exception) – In case an unexpected error occurred, this contains the original exception.

If state is True, station must be a str and departures must be a list of Departure` objects. If state is False there must be several reasons for that:

1. The provided station name during the QueryApi.call() returned multiple possible departing stations. You have to specify the name in an unambiguous way.
2. The station does not exist at all.
3. An exception occurred during the QueryApi.call()

Deprecated since version 0.1b3: The state argument will be removed in the future and will be computed automatically based on station, departures and error.

departures

A list of 2-tuple in the form (str, Departure). The first element in the tuple defines the departing station where the second element holds a list of departure objects.

error

The error that occurred during creation or None

json

Uses ObjectJSONEncoder to encode the departures to a JSON format.

merge(other)

Checks that other is a Response and extends departures by the departures given in other iff neither response object has a invalid state.

state

True iff the request and parsing was successful, False otherwise.

Concrete Implementations

• Actual Departure API
• Scheduled Departure API