Rename within_deadline to submission_open; add submission_closed

Author: ChrisMayfield

examples/5_import_funcs/test_clock.py

@@ -1,5 +1,5 @@
 from jmu_pytest_utils.common import assert_pep8, assert_docs
-from jmu_pytest_utils.common import within_deadline, postpone_tests
+from jmu_pytest_utils.common import submission_open, postpone_tests
 from jmu_pytest_utils.decorators import weight
 
 from clock import time_str, add_time
@@ -42,5 +42,5 @@ def test_add_time_hard():
     assert add_time(1, 15, 2*24*60 + 75) == "02:30 AM", "2 days and 75 minutes after 01:15 AM"
 
 
-if within_deadline():
+if submission_open():
     postpone_tests()

jmu_pytest_utils/common.py

@@ -135,11 +135,13 @@ def run_module(filename, input=None):
     return run_command(["python", filename], input)
 
 
-def within_deadline(before=5, after=5):
+def submission_open(before=5, after=5):
     """Check if the current time is within the user's submission window.
 
-    The window is extended `before` minutes prior to the release date
-    and `after` minutes beyond the due date (or late due date, if set).
+    The window starts at the release date and ends at the due date (or late
+    due date, if set). This function applies a tolerance by including times:
+      * `before` minutes prior to the release date
+      * `after` minutes beyond the due/late date
 
     Args:
         before (int): Minutes to extend the window before the release date.
@@ -156,7 +158,7 @@ def within_deadline(before=5, after=5):
     except FileNotFoundError:
         return False
 
-    # Get the user's assignment dates
+    # Get the assignment's dates specific to the user
     assignment = metadata["users"][0]["assignment"]
     beg = datetime.fromisoformat(assignment["release_date"])
     end = datetime.fromisoformat(assignment["due_date"])
@@ -173,6 +175,14 @@ def within_deadline(before=5, after=5):
     return beg <= now <= end
 
 
+def submission_closed():
+    """Check if the current time is outside the user's submission window.
+
+    See submission_open() for more details. This function returns the opposite.
+    """
+    return not submission_open()
+
+
 def postpone_tests(
     title="Ready to grade",
     message="Your submission has been received and will be graded manually.",