Merge pull request #1238 from lzach/pluggable_exchange

Pluggable exchange

Author: willingc

nbgrader/apps/api.py

@@ -5,12 +5,12 @@
 import logging
 import warnings
 
-from traitlets.config import LoggingConfigurable, Config
+from traitlets.config import LoggingConfigurable, Config, get_config
 from traitlets import Instance, Enum, Unicode, observe
 
 from ..coursedir import CourseDirectory
 from ..converters import GenerateAssignment, Autograde, GenerateFeedback
-from ..exchange import ExchangeList, ExchangeReleaseAssignment, ExchangeReleaseFeedback, ExchangeFetchFeedback, ExchangeCollect, ExchangeError, ExchangeSubmit
+from ..exchange import ExchangeFactory, ExchangeError
 from ..api import MissingEntry, Gradebook, Student, SubmittedAssignment
 from ..utils import parse_utc, temp_attrs, capture_log, as_timezone, to_numeric_tz
 from ..auth import Authenticator
@@ -21,6 +21,7 @@ class NbGraderAPI(LoggingConfigurable):
 
     coursedir = Instance(CourseDirectory, allow_none=True)
     authenticator = Instance(Authenticator, allow_none=True)
+    exchange = Instance(ExchangeFactory, allow_none=True)
 
     # The log level for the application
     log_level = Enum(
@@ -48,7 +49,7 @@ def _log_level_changed(self, change):
             self.log_level = new
         self.log.setLevel(new)
 
-    def __init__(self, coursedir=None, authenticator=None, **kwargs):
+    def __init__(self, coursedir=None, authenticator=None, exchange=None, **kwargs):
         """Initialize the API.
 
         Arguments
@@ -58,6 +59,9 @@ def __init__(self, coursedir=None, authenticator=None, **kwargs):
         authenticator : :class:~`nbgrader.auth.BaseAuthenticator`
             (Optional) An authenticator instance for communicating with an
             external database.
+        exchange : :class:~`nbgrader.exchange.ExchangeFactory`
+            (Optional) A factory for creating the exchange classes used
+            for distributing assignments and feedback.
         kwargs:
             Additional keyword arguments (e.g. ``parent``, ``config``)
 
@@ -75,13 +79,22 @@ def __init__(self, coursedir=None, authenticator=None, **kwargs):
         else:
             self.authenticator = authenticator
 
+        if exchange is None:
+            self.exchange = ExchangeFactory(parent=self)
+        else:
+            self.exchange = exchange
+
         if sys.platform != 'win32':
-            lister = ExchangeList(
+            lister = self.exchange.List(
                 coursedir=self.coursedir,
                 authenticator=self.authenticator,
                 parent=self)
             self.course_id = self.coursedir.course_id
-            self.exchange = lister.root
+            if hasattr(lister, "root"):
+                self.exchange_root = lister.root
+            else:
+                # For non-fs based exchanges
+                self.exchange_root = ''
 
             try:
                 lister.start()
@@ -92,7 +105,7 @@ def __init__(self, coursedir=None, authenticator=None, **kwargs):
 
         else:
             self.course_id = ''
-            self.exchange = ''
+            self.exchange_root = ''
             self.exchange_missing = True
 
     @property
@@ -155,7 +168,7 @@ def get_released_assignments(self):
 
         """
         if self.exchange_is_functional:
-            lister = ExchangeList(
+            lister = self.exchange.List(
                 coursedir=self.coursedir,
                 authenticator=self.authenticator,
                 parent=self)
@@ -640,7 +653,7 @@ def _filter_existing_notebooks(self, assignment_id, notebooks):
         # should be here already so we don't need to filter for only
         # existing notebooks in that case.
         if self.exchange_is_functional:
-            app = ExchangeSubmit(
+            app = self.exchange.Submit(
                     coursedir=self.coursedir,
                     authenticator=self.authenticator,
                     parent=self)
@@ -924,7 +937,7 @@ def unrelease(self, assignment_id):
         """
         if sys.platform != 'win32':
             with temp_attrs(self.coursedir, assignment_id=assignment_id):
-                app = ExchangeList(
+                app = self.exchange.List(
                     coursedir=self.coursedir,
                     authenticator=self.authenticator,
                     parent=self)
@@ -960,7 +973,7 @@ def release_assignment(self, assignment_id):
         """
         if sys.platform != 'win32':
             with temp_attrs(self.coursedir, assignment_id=assignment_id):
-                app = ExchangeReleaseAssignment(
+                app = self.exchange.ReleaseAssignment(
                     coursedir=self.coursedir,
                     authenticator=self.authenticator,
                     parent=self)
@@ -989,7 +1002,7 @@ def collect(self, assignment_id, update=True):
         """
         if sys.platform != 'win32':
             with temp_attrs(self.coursedir, assignment_id=assignment_id):
-                app = ExchangeCollect(
+                app = self.exchange.Collect(
                     coursedir=self.coursedir,
                     authenticator=self.authenticator,
                     parent=self)
@@ -1095,14 +1108,14 @@ def release_feedback(self, assignment_id, student_id=None):
         """
         if student_id is not None:
             with temp_attrs(self.coursedir, assignment_id=assignment_id, student_id=student_id):
-                app = ExchangeReleaseFeedback(
+                app = self.exchange.ReleaseFeedback(
                     coursedir=self.coursedir,
                     authentictor=self.authenticator,
                     parent=self)
                 return capture_log(app)
         else:
             with temp_attrs(self.coursedir, assignment_id=assignment_id, student_id='*'):
-                app = ExchangeReleaseFeedback(
+                app = self.exchange.ReleaseFeedback(
                     coursedir=self.coursedir,
                     authentictor=self.authenticator,
                     parent=self)
@@ -1130,15 +1143,15 @@ def fetch_feedback(self, assignment_id, student_id):
 
         """
         with temp_attrs(self.coursedir, assignment_id=assignment_id, student_id=student_id):
-            app = ExchangeFetchFeedback(
+            app = self.exchange.FetchFeedback(
                 coursedir=self.coursedir,
                 authentictor=self.authenticator,
                 parent=self)
             ret_dic = capture_log(app)
             # assignment tab needs a 'value' field with the info needed to repopulate
             # the tables.
         with temp_attrs(self.coursedir, assignment_id='*', student_id=student_id):
-            lister_rel = ExchangeList(
+            lister_rel = self.exchange.List(
                 inbound=False, cached=True,
                 coursedir=self.coursedir,
                 authenticator=self.authenticator,

nbgrader/apps/baseapp.py

@@ -16,6 +16,7 @@
 from traitlets.config.application import catch_config_error
 from traitlets.config.loader import Config
 
+from nbgrader.exchange import ExchangeFactory
 from ..coursedir import CourseDirectory
 from ..auth import Authenticator
 from .. import preprocessors
@@ -117,14 +118,15 @@ def deinit_logging(self) -> None:
 
     coursedir = Instance(CourseDirectory, allow_none=True)
     authenticator = Instance(Authenticator, allow_none=True)
+    exchange = Instance(ExchangeFactory, allow_none=True)
     verbose_crash = Bool(False)
 
     # The classes added here determine how configuration will be documented
     classes = List()
 
     @default("classes")
     def _classes_default(self) -> TypingList[MetaHasTraits]:
-        return [NbGrader, CourseDirectory]
+        return [ExchangeFactory, NbGrader, CourseDirectory]
 
     def all_configurable_classes(self) -> TypingList[MetaHasTraits]:
         """Get a list of all configurable classes for nbgrader
@@ -162,6 +164,12 @@ def all_configurable_classes(self) -> TypingList[MetaHasTraits]:
             if hasattr(ex, "class_traits") and ex.class_traits(config=True):
                 classes.append(ex)
 
+        # include all the default exchange actions
+        for ex_name in exchange.default.__all__:
+            ex = getattr(exchange, ex_name)
+            if hasattr(ex, "class_traits") and ex.class_traits(config=True):
+                classes.append(ex)
+
         # include all the converters
         for ex_name in converters.__all__:
             ex = getattr(converters, ex_name)
@@ -352,3 +360,5 @@ def load_config_file(self, **kwargs: Any) -> None:
     def start(self) -> None:
         super(NbGrader, self).start()
         self.authenticator = Authenticator(parent=self)
+        self.exchange = ExchangeFactory(parent=self)
+

nbgrader/apps/collectapp.py

@@ -96,7 +96,7 @@ def start(self):
         elif self.coursedir.assignment_id == "":
             self.fail("Must provide assignment name:\nnbgrader <command> ASSIGNMENT [ --course COURSE ]")
 
-        collect = ExchangeCollect(
+        collect = self.exchange.Collect(
             coursedir=self.coursedir,
             authenticator=self.authenticator,
             parent=self)

nbgrader/apps/dbapp.py

@@ -12,7 +12,6 @@
 
 from . import NbGrader
 from ..api import Gradebook, MissingEntry, Student, Assignment
-from ..exchange import ExchangeList
 from .. import dbutil
 
 aliases = {
@@ -36,7 +35,6 @@ class DbBaseApp(NbGrader):
 
     def start(self):
         if sys.platform != 'win32':
-            lister = ExchangeList(coursedir=self.coursedir, parent=self)
             self.course_id = self.coursedir.course_id
         else:
             self.course_id = ''

nbgrader/apps/fetchassignmentapp.py

@@ -80,7 +80,7 @@ def start(self):
             self.fail("Must provide assignment name:\nnbgrader fetch_assignment ASSIGNMENT [ --course COURSE ]")
 
         if self.coursedir.assignment_id != "":
-            fetch = ExchangeFetchAssignment(
+            fetch = self.exchange.FetchAssignment(
                 coursedir=self.coursedir,
                 authenticator=self.authenticator,
                 parent=self)
@@ -93,7 +93,7 @@ def start(self):
 
             for arg in self.extra_args:
                 self.coursedir.assignment_id = arg
-                fetch = ExchangeFetchAssignment(
+                fetch = self.exchange.FetchAssignment(
                     coursedir=self.coursedir,
                     authenticator=self.authenticator,
                     parent=self)

nbgrader/apps/fetchfeedbackapp.py

@@ -64,7 +64,7 @@ def start(self):
             self.fail("Must provide assignment name:\nnbgrader fetch_feedback ASSIGNMENT [ --course COURSE ]")
 
         if self.coursedir.assignment_id != "":
-            fetch = ExchangeFetchFeedback(
+            fetch = self.exchange.FetchFeedback(
                 coursedir=self.coursedir,
                 authenticator=self.authenticator,
                 parent=self)
@@ -77,7 +77,7 @@ def start(self):
 
             for arg in self.extra_args:
                 self.coursedir.assignment_id = arg
-                fetch = ExchangeFetchFeedback(
+                fetch = self.exchange.FetchFeedback(
                     coursedir=self.coursedir,
                     authenticator=self.authenticator,
                     parent=self)

nbgrader/apps/listapp.py

@@ -117,7 +117,7 @@ def start(self):
         elif len(self.extra_args) > 2:
             self.fail("Too many arguments")
 
-        lister = ExchangeList(
+        lister = self.exchange.List(
             coursedir=self.coursedir,
             authenticator=self.authenticator,
             parent=self)

nbgrader/apps/releaseassignmentapp.py

@@ -99,7 +99,7 @@ def start(self):
         elif self.coursedir.assignment_id == "":
             self.fail("Must provide assignment name:\nnbgrader <command> ASSIGNMENT [ --course COURSE ]")
 
-        release = ExchangeReleaseAssignment(
+        release = self.exchange.ReleaseAssignment(
             coursedir=self.coursedir,
             authenticator=self.authenticator,
             parent=self)

nbgrader/apps/releasefeedbackapp.py

@@ -60,7 +60,7 @@ def start(self):
         elif self.coursedir.assignment_id == "":
             self.fail("Must provide assignment name:\nnbgrader <command> ASSIGNMENT [ --course COURSE ]")
 
-        release_feedback = ExchangeReleaseFeedback(
+        release_feedback = self.exchange.ReleaseFeedback(
             coursedir=self.coursedir,
             authenticator=self.authenticator,
             parent=self)

nbgrader/apps/submitapp.py

@@ -95,7 +95,7 @@ def start(self):
         elif self.coursedir.assignment_id == "":
             self.fail("Must provide assignment name:\nnbgrader <command> ASSIGNMENT [ --course COURSE ]")
 
-        submit = ExchangeSubmit(
+        submit = self.exchange.Submit(
             coursedir=self.coursedir,
             authenticator=self.authenticator,
             parent=self)