Merge pull request #1282 from aliniknejad/master

Further type annotations across the codebase

Author: jhamrick

nbgrader/apps/autogradeapp.py

@@ -6,6 +6,9 @@
 
 from .baseapp import NbGrader, nbgrader_aliases, nbgrader_flags
 from ..converters import BaseConverter, Autograde, NbGraderException
+from traitlets.traitlets import MetaHasTraits
+from traitlets.config.loader import Config
+from typing import List
 
 aliases = {
     'course': 'CourseDirectory.course_id'
@@ -95,12 +98,12 @@ class AutogradeApp(NbGrader):
         """
 
     @default("classes")
-    def _classes_default(self):
+    def _classes_default(self) -> List[MetaHasTraits]:
         classes = super(AutogradeApp, self)._classes_default()
         classes.extend([BaseConverter, Autograde])
         return classes
 
-    def _load_config(self, cfg, **kwargs):
+    def _load_config(self, cfg: Config, **kwargs: dict) -> None:
         if 'AutogradeApp' in cfg:
             self.log.warning(
                 "Use Autograde in config, not AutogradeApp. Outdated config:\n%s",
@@ -114,8 +117,8 @@ def _load_config(self, cfg, **kwargs):
 
         super(AutogradeApp, self)._load_config(cfg, **kwargs)
 
-    def start(self):
-        super(AutogradeApp, self).start()
+    def start(self) -> None:
+        super().start()
 
         if len(self.extra_args) > 1:
             self.fail("Only one argument (the assignment id) may be specified")

nbgrader/apps/baseapp.py

@@ -22,6 +22,10 @@
 from .. import plugins
 from .. import exchange
 from .. import converters
+from traitlets.traitlets import MetaHasTraits
+from typing import List as TypingList
+from io import StringIO
+from typing import Any
 
 
 nbgrader_aliases = {
@@ -62,15 +66,15 @@ class NbGrader(JupyterApp):
     _log_formatter_cls = LogFormatter
 
     @default("log_level")
-    def _log_level_default(self):
+    def _log_level_default(self) -> int:
         return logging.INFO
 
     @default("log_datefmt")
-    def _log_datefmt_default(self):
+    def _log_datefmt_default(self) -> str:
         return "%Y-%m-%d %H:%M:%S"
 
     @default("log_format")
-    def _log_format_default(self):
+    def _log_format_default(self) -> str:
         return "%(color)s[%(name)s | %(levelname)s]%(end_color)s %(message)s"
 
     logfile = Unicode(
@@ -83,7 +87,11 @@ def _log_format_default(self):
         )
     ).tag(config=True)
 
-    def init_logging(self, handler_class, handler_args, color=True, subapps=False):
+    def init_logging(self,
+                     handler_class: type,
+                     handler_args: TypingList[StringIO],
+                     color: bool = True,
+                     subapps: bool = False) -> None:
         handler = handler_class(*handler_args)
 
         if color:
@@ -101,7 +109,7 @@ def init_logging(self, handler_class, handler_args, color=True, subapps=False):
         if subapps and self.subapp:
             self.subapp.init_logging(handler_class, handler_args, color=color, subapps=subapps)
 
-    def deinit_logging(self):
+    def deinit_logging(self) -> None:
         if len(self.log.handlers) > 1:
             for handler in self.log.handlers[1:]:
                 handler.close()
@@ -115,10 +123,10 @@ def deinit_logging(self):
     classes = List()
 
     @default("classes")
-    def _classes_default(self):
+    def _classes_default(self) -> TypingList[MetaHasTraits]:
         return [NbGrader, CourseDirectory]
 
-    def all_configurable_classes(self):
+    def all_configurable_classes(self) -> TypingList[MetaHasTraits]:
         """Get a list of all configurable classes for nbgrader
         """
         # Call explicitly the method on this class, to avoid infinite recursion
@@ -163,10 +171,10 @@ def all_configurable_classes(self):
         return classes
 
     @default("config_file_name")
-    def _config_file_name_default(self):
+    def _config_file_name_default(self) -> str:
         return u'nbgrader_config'
 
-    def _load_config(self, cfg, **kwargs):
+    def _load_config(self, cfg: Config, **kwargs: Any) -> None:
         if 'NbGraderConfig' in cfg:
             self.log.warning(
                 "Use NbGrader in config, not NbGraderConfig. Outdated config:\n%s",
@@ -286,14 +294,14 @@ def fail(self, msg, *args):
         self.log.error(msg, *args)
         sys.exit(1)
 
-    def build_extra_config(self):
+    def build_extra_config(self) -> Config:
         return Config()
 
     def excepthook(self, etype, evalue, tb):
         format_excepthook(etype, evalue, tb)
 
     @catch_config_error
-    def initialize(self, argv=None):
+    def initialize(self, argv: TypingList[str] = None) -> None:
         self.update_config(self.build_extra_config())
         self.init_syspath()
         self.coursedir = CourseDirectory(parent=self)
@@ -305,11 +313,11 @@ def initialize(self, argv=None):
         if self.logfile:
             self.init_logging(logging.FileHandler, [self.logfile], color=False)
 
-    def init_syspath(self):
+    def init_syspath(self) -> None:
         """Add the cwd to the sys.path ($PYTHONPATH)"""
         sys.path.insert(0, os.getcwd())
 
-    def reset(self):
+    def reset(self) -> None:
         # stop logging
         self.deinit_logging()
 
@@ -325,7 +333,7 @@ def print_subcommands(self):
         for key, (app, desc) in self.subcommands.items():
             print("    {}\n{}\n".format(key, desc))
 
-    def load_config_file(self, **kwargs):
+    def load_config_file(self, **kwargs: Any) -> None:
         """Load the config file.
         By default, errors in loading config are handled, and a warning
         printed on screen. For testing, the suppress_errors option is set
@@ -341,6 +349,6 @@ def load_config_file(self, **kwargs):
 
         super(NbGrader, self).load_config_file(**kwargs)
 
-    def start(self):
+    def start(self) -> None:
         super(NbGrader, self).start()
         self.authenticator = Authenticator(parent=self)

nbgrader/apps/generateassignmentapp.py

@@ -6,6 +6,9 @@
 
 from .baseapp import NbGrader, nbgrader_aliases, nbgrader_flags
 from ..converters import BaseConverter, GenerateAssignment, NbGraderException
+from traitlets.traitlets import MetaHasTraits
+from typing import List, Any
+from traitlets.config.loader import Config
 
 aliases = {
     'course': 'CourseDirectory.course_id'
@@ -107,12 +110,12 @@ class GenerateAssignmentApp(NbGrader):
         """
 
     @default("classes")
-    def _classes_default(self):
+    def _classes_default(self) -> List[MetaHasTraits]:
         classes = super(GenerateAssignmentApp, self)._classes_default()
         classes.extend([BaseConverter, GenerateAssignment])
         return classes
 
-    def _load_config(self, cfg, **kwargs):
+    def _load_config(self, cfg: Config, **kwargs: Any) -> None:
         if 'AssignApp' in cfg:
             self.log.warning(
                 "Use GenerateAssignment in config, not AssignApp. Outdated config:\n%s",
@@ -124,10 +127,10 @@ def _load_config(self, cfg, **kwargs):
             cfg.GenerateAssignment.merge(cfg.AssignApp)
             del cfg.AssignApp
 
-        super(GenerateAssignmentApp, self)._load_config(cfg, **kwargs)
+        super()._load_config(cfg, **kwargs)
 
-    def start(self):
-        super(GenerateAssignmentApp, self).start()
+    def start(self) -> None:
+        super().start()
 
         if len(self.extra_args) > 1:
             self.fail("Only one argument (the assignment id) may be specified")

nbgrader/apps/nbgraderapp.py

@@ -38,6 +38,8 @@
     ZipCollectApp,
     GenerateConfigApp
 )
+from traitlets.traitlets import MetaHasTraits
+from typing import List
 
 aliases = {}
 aliases.update(nbgrader_aliases)
@@ -294,14 +296,14 @@ class NbGraderApp(NbGrader):
     )
 
     @default("classes")
-    def _classes_default(self):
+    def _classes_default(self) -> List[MetaHasTraits]:
         return self.all_configurable_classes()
 
     @catch_config_error
-    def initialize(self, argv=None):
+    def initialize(self, argv: List[str] = None) -> None:
         super(NbGraderApp, self).initialize(argv)
 
-    def start(self):
+    def start(self) -> None:
         # check: is there a subapp given?
         if self.subapp is None:
             print("No command given (run with --help for options). List of subcommands:\n")

nbgrader/auth/base.py

@@ -1,15 +1,16 @@
 from traitlets import Instance, Type
 from traitlets.config import LoggingConfigurable
+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
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
 
         Returns
@@ -22,27 +23,27 @@ 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
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
-        course_id: string
+        course_id:
             The unique id of the course.
 
         """
         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
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
-        course_id: string
+        course_id:
             The unique id of the course.
 
         """
@@ -51,23 +52,22 @@ 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
 
 
-
 class Authenticator(LoggingConfigurable):
 
     plugin_class = Type(
@@ -78,17 +78,17 @@ class Authenticator(LoggingConfigurable):
 
     plugin = Instance(BaseAuthPlugin).tag(config=False)
 
-    def __init__(self, *args, **kwargs):
-        super(Authenticator, self).__init__(*args, **kwargs)
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
         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
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
 
         Returns
@@ -101,14 +101,14 @@ 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
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
-        course_id: string
+        course_id:
             The unique id of the course.
 
         Returns
@@ -121,27 +121,27 @@ def has_access(self, student_id, course_id):
             return True
         return course_id in courses
 
-    def add_student_to_course(self, student_id, course_id):
+    def add_student_to_course(self, student_id: str, course_id: str) -> None:
         """Grants a student access to a given course.
 
         Arguments
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
-        course_id: string
+        course_id:
             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
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
-        course_id: string
+        course_id:
             The unique id of the course.
 
         """