Further type annotations

Author: jhamrick

nbgrader/auth/base.py

@@ -10,7 +10,7 @@ def get_student_courses(self, student_id: str) -> Optional[list]:  # pragma: no
 
         Arguments
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
 
         Returns
@@ -28,9 +28,9 @@ def add_student_to_course(self, student_id: str, course_id: str) -> None:  # pra
 
         Arguments
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
-        course_id: string
+        course_id:
             The unique id of the course.
 
         """
@@ -41,9 +41,9 @@ def remove_student_from_course(self, student_id: str, course_id: str) -> None:
 
         Arguments
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
-        course_id: string
+        course_id:
             The unique id of the course.
 
         """
@@ -88,7 +88,7 @@ def get_student_courses(self, student_id: str) -> Optional[list]:
 
         Arguments
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
 
         Returns
@@ -106,9 +106,9 @@ def has_access(self, student_id: str, course_id: str) -> bool:
 
         Arguments
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
-        course_id: string
+        course_id:
             The unique id of the course.
 
         Returns
@@ -126,9 +126,9 @@ def add_student_to_course(self, student_id: str, course_id: str) -> None:
 
         Arguments
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
-        course_id: string
+        course_id:
             The unique id of the course.
 
         """
@@ -139,9 +139,9 @@ def remove_student_from_course(self, student_id: str, course_id: str) -> None:
 
         Arguments
         ---------
-        student_id: string
+        student_id:
             The unique id of the student.
-        course_id: string
+        course_id:
             The unique id of the course.
 
         """

nbgrader/plugins/export.py

@@ -1,21 +1,21 @@
 from traitlets import Unicode, List
 
 from .base import BasePlugin
-from ..api import MissingEntry
+from ..api import MissingEntry, Gradebook
 
 
 class ExportPlugin(BasePlugin):
     """Base class for export plugins."""
 
     to = Unicode("", help="destination to export to").tag(config=True)
 
-    student = List([],
-        help="list of students to export").tag(config=True)
+    student = List(
+        [], help="list of students to export").tag(config=True)
 
-    assignment = List([],
-        help="list of assignments to export").tag(config=True)
+    assignment = List(
+        [], help="list of assignments to export").tag(config=True)
 
-    def export(self, gradebook):
+    def export(self, gradebook: Gradebook) -> None:
         """Export grades to another format.
 
         This method MUST be implemented by subclasses. Users should be able to
@@ -25,7 +25,7 @@ def export(self, gradebook):
 
         Arguments
         ---------
-        gradebook: :class:`nbgrader.api.Gradebook`
+        gradebook:
             An instance of the gradebook
 
         """
@@ -35,7 +35,7 @@ def export(self, gradebook):
 class CsvExportPlugin(ExportPlugin):
     """CSV exporter plugin."""
 
-    def export(self, gradebook):
+    def export(self, gradebook: Gradebook) -> None:
         if self.to == "":
             dest = "grades.csv"
         else:

nbgrader/plugins/latesubmission.py

@@ -26,11 +26,11 @@ def late_submission_penalty(self, student_id: str, score: float, total_seconds_l
 
         Parameters
         ----------
-        student_id : string
+        student_id:
             The unique id of the student
-        score : float
+        score:
             The score the student obtained for the submitted notebook
-        total_seconds_late : float
+        total_seconds_late:
             The total number of seconds the submitted notebook was late
 
         Returns

nbgrader/plugins/zipcollect.py

@@ -4,6 +4,7 @@
 
 from textwrap import dedent
 from traitlets import Bool, List, Unicode
+from typing import Optional
 
 from .base import BasePlugin
 from ..utils import unzip
@@ -31,7 +32,7 @@ class ExtractorPlugin(BasePlugin):
         )
     ).tag(config=True)
 
-    def extract(self, archive_path, extracted_path):
+    def extract(self, archive_path: str, extracted_path: str) -> None:
         """Extract archive (zip) files and submission files in the
         `archive_directory`. Files are extracted to the `extracted_directory`.
         Non-archive (zip) files found in the `archive_directory` are copied to
@@ -42,9 +43,9 @@ def extract(self, archive_path, extracted_path):
 
         Arguments
         ---------
-        archive_path: str
+        archive_path:
             Absolute path to the `archive_directory`.
-        extracted_path: str
+        extracted_path:
             Absolute path to the `extracted_directory`.
         """
         if not os.listdir(archive_path):
@@ -100,7 +101,7 @@ class FileNameCollectorPlugin(BasePlugin):
     named_regexp = Unicode(
         default_value='',
         help=dedent(
-            """
+            r"""
             This regular expression is applied to each submission filename and
             MUST be supplied by the instructor. This regular expression MUST
             provide the `(?P<student_id>...)` and `(?P<file_id>...)` named
@@ -131,7 +132,7 @@ class FileNameCollectorPlugin(BasePlugin):
         )
     ).tag(config=True)
 
-    def _match(self, filename):
+    def _match(self, filename: str) -> Optional[dict]:
         """Match the named group regular expression to the beginning of the
         filename and return the match groupdict or None if no match.
         """
@@ -157,20 +158,20 @@ def _match(self, filename):
         )
         return gd
 
-    def collect(self, submitted_file):
+    def collect(self, submitted_file: str) -> Optional[dict]:
         """This is the main function called by the
         :class:`~nbgrader.apps.zipcollectapp.ZipCollectApp` for each submitted
         file. Note this function must also return a dictionary or None for
         sub-classed plugins.
 
         Arguments
         ---------
-        submitted_file: str
+        submitted_file:
             Each submitted file in the ``extracted_directory`` (absolute path).
 
         Returns
         -------
-        groupdict: dict
+        groupdict:
             Collected data from the filename or None if the file should be
             skipped. Collected data is a dict of the form::
 

nbgrader/preprocessors/getgrades.py

@@ -1,5 +1,9 @@
 from traitlets import List
 
+from nbconvert.exporters.exporter import ResourcesDict
+from nbformat.notebooknode import NotebookNode
+from typing import Optional, Any, Tuple
+
 from .. import utils
 from ..api import Gradebook
 from . import NbGraderPreprocessor
@@ -10,7 +14,10 @@ class GetGrades(NbGraderPreprocessor):
 
     display_data_priority = List(['text/html', 'application/pdf', 'text/latex', 'image/svg+xml', 'image/png', 'image/jpeg', 'text/plain'], config=True)
 
-    def preprocess(self, nb, resources):
+    def preprocess(self,
+                   nb: NotebookNode,
+                   resources: ResourcesDict,
+                   ) -> Tuple[NotebookNode, ResourcesDict]:
         # pull information from the resources
         self.notebook_id = resources['nbgrader']['notebook']
         self.assignment_id = resources['nbgrader']['assignment']
@@ -37,7 +44,7 @@ def preprocess(self, nb, resources):
 
         return nb, resources
 
-    def _get_comment(self, cell, resources):
+    def _get_comment(self, cell: NotebookNode, resources: ResourcesDict) -> None:
         """Graders can optionally add comments to the student's solutions, so
         add the comment information into the database if it doesn't
         already exist. It should NOT overwrite existing comments that
@@ -55,7 +62,7 @@ def _get_comment(self, cell, resources):
         # save it in the notebook
         cell.metadata.nbgrader['comment'] = comment.comment
 
-    def _get_score(self, cell, resources):
+    def _get_score(self, cell: NotebookNode, resources: ResourcesDict) -> None:
         grade = self.gradebook.find_grade(
             cell.metadata['nbgrader']['grade_id'],
             self.notebook_id,
@@ -65,7 +72,10 @@ def _get_score(self, cell, resources):
         cell.metadata.nbgrader['score'] = grade.score
         cell.metadata.nbgrader['points'] = grade.max_score
 
-    def preprocess_cell(self, cell, resources, cell_index):
+    def preprocess_cell(self,
+                        cell: NotebookNode,
+                        resources: ResourcesDict, cell_index: int,
+                        ) -> Tuple[NotebookNode, ResourcesDict]:
         # if it's a solution cell, then add a comment
         if utils.is_solution(cell):
             self._get_comment(cell, resources)

nbgrader/preprocessors/overwritecells.py

@@ -5,7 +5,7 @@
 from . import NbGraderPreprocessor
 from nbconvert.exporters.exporter import ResourcesDict
 from nbformat.notebooknode import NotebookNode
-from typing import Tuple
+from typing import Tuple, Any
 
 
 class OverwriteCells(NbGraderPreprocessor):
@@ -25,7 +25,7 @@ def preprocess(self, nb: NotebookNode, resources: ResourcesDict) -> Tuple[Notebo
 
         return nb, resources
 
-    def update_cell_type(self, cell, cell_type):
+    def update_cell_type(self, cell: NotebookNode, cell_type: str) -> None:
         if cell.cell_type == cell_type:
             return
         elif cell_type == 'code':
@@ -41,7 +41,7 @@ def update_cell_type(self, cell, cell_type):
                 del cell['execution_count']
             validate(cell, 'markdown_cell')
 
-    def report_change(self, name, attr, old, new):
+    def report_change(self, name: str, attr: str, old: Any, new: Any) -> None:
         self.log.warning(
             "Attribute '%s' for cell %s has changed! (should be: %s, got: %s)", attr, name, old, new)
 

nbgrader/preprocessors/savecells.py

@@ -131,7 +131,7 @@ def _create_solution_cell(self, cell: NotebookNode) -> None:
 
         self.new_solution_cells[grade_id] = solution_cell
 
-    def _create_task_cell(self, cell):
+    def _create_task_cell(self, cell: NotebookNode) -> None:
         grade_id = cell.metadata.nbgrader['grade_id']
         try:
             task_cell = self.gradebook.find_task_cell(grade_id, self.notebook_id, self.assignment_id).to_dict()