made pep8 compliant, added non-object-oriented get_departures()

Author: leftshift

mvg/__init__.py

@@ -1,6 +1,8 @@
 # coding=utf-8
 
-import urllib2, json, datetime
+import urllib2
+import json
+import datetime
 from time import mktime
 
 api_key = "5af1beca494712ed38d313714d4caff6"
@@ -10,12 +12,14 @@
 nearby_url = "https://www.mvg.de/fahrinfo/api/location/nearby"
 routing_url = "https://www.mvg.de/fahrinfo/api/routing/?"
 
+
 def _perform_api_request(url):
     opener = urllib2.build_opener()
     opener.addheaders = [('X-MVG-Authorization-Key', api_key)]
     response = opener.open(url)
     return json.loads(response.read())
 
+
 def _convert_time(time):
     """
     Takes datetime.datetime() or unix time in ms
@@ -29,6 +33,7 @@ def _convert_time(time):
         except Exception as e:
             raise
 
+
 def get_nearby_stations(lat, log):
     if lat == 0 or log == 0:
         return None
@@ -41,6 +46,7 @@ def get_nearby_stations(lat, log):
     results = _perform_api_request(url)
     return results['locations']
 
+
 def get_id_for_station(station_name):
     """
     Gives the station_id for the given station_name.
@@ -50,6 +56,7 @@ def get_id_for_station(station_name):
     station = get_stations(station_name)[0]
     return station['id']
 
+
 def get_locations(query):
     if isinstance(query, int):
         url = query_url + str(query)
@@ -67,11 +74,10 @@ def get_stations(station):
             stations.append(result)
     return stations
 
-def get_route(start, dest, time=None, arrival_time=False, max_walk_time_to_start=None, max_walk_time_to_dest=None):
-    """
-    returns connectionList = [] of possible routes.
-    Adds departure_datetime and arrival_datetime to array as datetime objects.
-    """
+
+def get_route(start, dest,
+              time=None, arrival_time=False,
+              max_walk_time_to_start=None, max_walk_time_to_dest=None):
     url = routing_url
     options = []
 
@@ -81,15 +87,17 @@ def get_route(start, dest, time=None, arrival_time=False, max_walk_time_to_start
         options.append("fromLatitude=" + str(start[0]))
         options.append("fromLongitude=" + str(start[1]))
     else:
-        raise ValueError("A start must be given; either int station id or tuple latitude longitude")
+        raise ValueError("A start must be given;\
+                          either int station id or tuple latitude longitude")
 
     if isinstance(dest, int):
         options.append("toStation=" + str(dest))
     elif isinstance(dest, tuple) and len(dest) == 2:
         options.append("toLatitude=" + str(dest[0]))
         options.append("toLongitude=" + str(dest[1]))
     else:
-        raise ValueError("A destination must be given; either int station id or tuple latitude longitude")
+        raise ValueError("A destination must be given;\
+                          either int station id or tuple latitude longitude")
 
     if time:
         if isinstance(time, datetime.datetime):
@@ -98,30 +106,51 @@ def get_route(start, dest, time=None, arrival_time=False, max_walk_time_to_start
         if arrival_time:
             options.append("arrival=true")
     if max_walk_time_to_start:
-        options.append("maxTravelTimeFootwayToStation=" + str(max_walk_time_to_start))
+        options.append("maxTravelTimeFootwayToStation=" +
+                       str(max_walk_time_to_start))
     if max_walk_time_to_dest:
-        options.append("maxTravelTimeFootwayToDestination=" + str(max_walk_time_to_dest))
+        options.append("maxTravelTimeFootwayToDestination=" +
+                       str(max_walk_time_to_dest))
 
     options_url = "&".join(options)
     url = routing_url + options_url
     results = _perform_api_request(url)
     for connection in results["connectionList"]:
-        connection["departure_datetime"] = _convert_time(connection["departure"])
+        connection["departure_datetime"] = \
+            _convert_time(connection["departure"])
         connection["arrival_datetime"] = _convert_time(connection["arrival"])
     return results["connectionList"]
 
 
+def get_departures(station_id):
+    """get array of departures for station_id."""
+    if not isinstance(station_id, int):
+        raise TypeError("Please give the int station_id of the station.\
+                         You can find it out by running \
+                         get_id_for_station('Station name')")
+    url = departure_url + str(station_id) + departure_url_postfix
+    departures = _perform_api_request(url)['departures']
+    for departure in departures:
+        # For some reason, mvg gives you a Unix timestamp, but in milliseconds.
+        # Here, we convert it to datetime
+        time = _convert_time(departure['departureTime'])
+        relative_time = time - datetime.datetime.now()
+        departure[u'departureTimeMinutes'] = relative_time.seconds // 60
+    return departures
+
+
 class Station:
-    """
-        Gives you an object to acess current departure times from mvg.de
+    """Gives you an object to acess current departure times from mvg.de
+    Might be useful if you need to keep track of multiple stations?
 
-        Either give it an exact station name (like "Hauptbahnhof") or a station_id.
+    Either give it an exact station name (like "Hauptbahnhof")
+    or a station_id.
     """
 
     def __init__(self, station):
         if isinstance(station, str) or isinstance(station, unicode):
             self.station_id = get_id_for_station(station)
-            if self.station_id == None:
+            if self.station_id is None:
                 raise NameError("No matching station found")
         elif isinstance(station, int):
             self.station_id = station
@@ -137,8 +166,8 @@ def get_departures(self):
         url = departure_url + str(self.station_id) + departure_url_postfix
         departures = _perform_api_request(url)['departures']
         for departure in departures:
-            # For some reason, mvg gives you a Unix timestamp, but in milliseconds.
-            # Here, we convert it to datetime
+            # For some reason, mvg gives you a Unix timestamp in milliseconds.
+            # Here, we convert it to a datetime object
             time = _convert_time(departure['departureTime'])
             relative_time = time - datetime.datetime.now()
             departure[u'departureTimeMinutes'] = relative_time.seconds // 60