Add additional annotations to auth

Author: jhamrick

nbgrader/auth/base.py

@@ -1,11 +1,11 @@
 from traitlets import Instance, Type
 from traitlets.config import LoggingConfigurable
-from typing import Any
+from typing import Any, Optional
 
 
 class BaseAuthPlugin(LoggingConfigurable):
 
-    def get_student_courses(self, student_id):  # pragma: no cover
+    def get_student_courses(self, student_id: str) -> Optional[list]:  # pragma: no cover
         """Gets the list of courses that the student is enrolled in.
 
         Arguments
@@ -23,7 +23,7 @@ def get_student_courses(self, student_id):  # pragma: no cover
         """
         raise NotImplementedError
 
-    def add_student_to_course(self, student_id, course_id):  # pragma: no cover
+    def add_student_to_course(self, student_id: str, course_id: str) -> None:  # pragma: no cover
         """Grants a student access to a given course.
 
         Arguments
@@ -36,7 +36,7 @@ def add_student_to_course(self, student_id, course_id):  # pragma: no cover
         """
         raise NotImplementedError
 
-    def remove_student_from_course(self, student_id, course_id):  # pragma: no cover
+    def remove_student_from_course(self, student_id: str, course_id: str) -> None:  # pragma: no cover
         """Removes a student's access to a given course.
 
         Arguments
@@ -52,17 +52,17 @@ def remove_student_from_course(self, student_id, course_id):  # pragma: no cover
 
 class NoAuthPlugin(BaseAuthPlugin):
 
-    def get_student_courses(self, student_id):
+    def get_student_courses(self, student_id: str) -> Optional[list]:
         # None means that the student has access to any course that might exist
         # on the system.
         return None
 
-    def add_student_to_course(self, student_id, course_id):
+    def add_student_to_course(self, student_id: str, course_id: str) -> None:
         # Nothing to do, we don't keep track of which students are in which
         # courses in the default setting.
         pass
 
-    def remove_student_from_course(self, student_id, course_id):
+    def remove_student_from_course(self, student_id: str, course_id: str) -> None:
         # Nothing to do, we don't keep track of which students are in which
         # courses in the default setting.
         pass
@@ -83,7 +83,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         self.log.debug("Using authenticator: %s", self.plugin_class.__name__)
         self.plugin = self.plugin_class(parent=self)
 
-    def get_student_courses(self, student_id):
+    def get_student_courses(self, student_id: str) -> Optional[list]:
         """Gets the list of courses that the student is enrolled in.
 
         Arguments
@@ -101,7 +101,7 @@ def get_student_courses(self, student_id):
         """
         return self.plugin.get_student_courses(student_id)
 
-    def has_access(self, student_id, course_id):
+    def has_access(self, student_id: str, course_id: str) -> bool:
         """Checks whether a student has access to a particular course.
 
         Arguments
@@ -121,7 +121,7 @@ def has_access(self, student_id, course_id):
             return True
         return course_id in courses
 
-    def add_student_to_course(self, student_id: str, course_id: str) -> Any:
+    def add_student_to_course(self, student_id: str, course_id: str) -> None:
         """Grants a student access to a given course.
 
         Arguments
@@ -132,9 +132,9 @@ def add_student_to_course(self, student_id: str, course_id: str) -> Any:
             The unique id of the course.
 
         """
-        return self.plugin.add_student_to_course(student_id, course_id)
+        self.plugin.add_student_to_course(student_id, course_id)
 
-    def remove_student_from_course(self, student_id, course_id):
+    def remove_student_from_course(self, student_id: str, course_id: str) -> None:
         """Removes a student's access to a given course.
 
         Arguments

nbgrader/auth/jupyterhub.py

@@ -24,7 +24,7 @@ def get_jupyterhub_api_url() -> str:
     return os.environ.get('JUPYTERHUB_API_URL') or 'http://127.0.0.1:8081/hub/api'
 
 
-def get_jupyterhub_authorization():
+def get_jupyterhub_authorization() -> dict:
     if os.getenv('JUPYTERHUB_API_TOKEN'):
         api_token = os.environ['JUPYTERHUB_API_TOKEN']
     else:
@@ -72,7 +72,7 @@ def _query_jupyterhub_api(method: str, api_path: str, post_data: Optional[dict]
 
 class JupyterHubAuthPlugin(BaseAuthPlugin):
 
-    def get_student_courses(self, student_id):
+    def get_student_courses(self, student_id: str) -> Optional[list]:
         if student_id == "*":
             student_id = "{authenticated_user}"
         response = None
@@ -138,7 +138,7 @@ def add_student_to_course(self, student_id: str, course_id: str) -> None:
             self.log.error(err_msg + str(e))
             self.log.error("Make sure you set a valid admin_user 'api_token' in your config file before starting the service")
 
-    def remove_student_from_course(self, student_id, course_id):
+    def remove_student_from_course(self, student_id: str, course_id: str) -> None:
         if not course_id:
             self.log.error(
                 "Could not remove student from course because the course_id has "