Merge pull request #74 from Doomki/master

Added type signatures to dining and laundry

Author: RitwikGupta

PittAPI/dining.py

@@ -19,6 +19,7 @@
 
 import requests
 import grequests
+from typing import Dict
 
 sess = requests.session()
 
@@ -41,7 +42,7 @@ def get_locations():
     return get_locations_by_status()
 
 
-def get_locations_by_status(status=None):
+def get_locations_by_status(status: str=None) -> List[Dict[str,str]]:
     # status can be nil, open, or closed
     # None     - returns all dining locations
     # 'all'    - same as None (or anything else)
@@ -96,7 +97,7 @@ def get_locations_by_status(status=None):
 #    return []
 
 
-def _encode_dining_location(string):
+def _encode_dining_location(string: str) -> str:
     # changes full name into dict key name
     string = string.lower()
     string = string.replace(' ', '_')

PittAPI/laundry.py

@@ -22,6 +22,8 @@
 import requests
 from bs4 import BeautifulSoup
 
+from typing import Dict, List
+
 session = requests.session()
 
 location_dict = {
@@ -36,7 +38,7 @@
 }
 
 
-def get_status_simple(building_name):
+def get_status_simple(building_name: str) -> Dict[str,str]:
     """
     :returns: a dictionary with free washers and dryers as well as total washers
     and dryers for given building
@@ -75,7 +77,7 @@ def get_status_simple(building_name):
     return di
 
 
-def get_status_detailed(building_name):
+def get_status_detailed(building_name: str) -> List[Dict[str,str]]:
     building_name = building_name.upper()
 
     # Get a cookie
@@ -113,7 +115,7 @@ def get_status_detailed(building_name):
 
     cleaned_resp = [x for x in cleaned_resp if len(x) == 10]
 
-    di = []
+    di = [] # type: List[Dict[str,str]]
     for machine in cleaned_resp:
         time_left = -1
         machine_name = "{}_{}".format(machine[9], machine[3])