cornellGrading 2.17.0__tar.gz → 2.18.0__tar.gz

{cornellgrading-2.17.0/cornellGrading.egg-info → cornellgrading-2.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cornellGrading
-Version: 2.17.0
+Version: 2.18.0
 Summary: Routines for interacting with Cornell installations of Canvas and Qualtrics
 Home-page: https://github.com/dsavransky/grading
 Author: Dmitry Savransky

{cornellgrading-2.17.0 → cornellgrading-2.18.0}/cornellGrading/__init__.py

@@ -1,4 +1,4 @@
 name = "cornellGrading"
-__version__ = "2.17.0"
+__version__ = "2.18.0"
 from .cornellGrading import cornellGrading
 from .cornellQualtrics import cornellQualtrics

{cornellgrading-2.17.0 → cornellgrading-2.18.0}/cornellGrading/cornellGrading.py

@@ -15,6 +15,7 @@ from cornellGrading.cornellQualtrics import cornellQualtrics
 import urllib.parse
 import subprocess
 import shutil
+import requests
 
 try:
     from cornellGrading.pandocHTMLParser import pandocHTMLParser
@@ -209,6 +210,7 @@ class cornellGrading:
                 Name of assignment to return.  Must be exact match.
                 To see all assignments do:
                 >> for a in c.course.get_assignments(): print(a)
+
         Returns:
             canvasapi.assignment.Assignment:
                 The Assignment object
@@ -234,6 +236,7 @@ class cornellGrading:
                 Name of assignment group to return.  Must be exact match.
                 To see all assignments do:
                 >> for a in c.course.get_assignment_groups(): print(a)
+
         Returns:
             canvasapi.assignment.AssignmentGroup:
                 The assignment group object
@@ -255,8 +258,9 @@ class cornellGrading:
         """Create assignment group by name
 
         Args:
-            assignmentGroup (str):
+            groupName (str):
                 Name of assignment group to create. Cannot be name of existing group
+
         Returns:
             canvasapi.assignment.AssignmentGroup:
                 The assignment group object
@@ -277,10 +281,11 @@ class cornellGrading:
         """Locate folder by name
 
         Args:
-             (str):
+             folderName (str):
                 Name of folder to return.  Must be exact match.
                 To see all assignments do:
                 >> for a in c.course.get_folders(): print(a.name)
+
         Returns:
             canvasapi.folder.Folder:
                 The folder object
@@ -313,6 +318,7 @@ class cornellGrading:
             hidden (bool):
                 Whether to toggle to hidden (false by default). If parent folder is
                 hidden, you cannot make the subfolder visible.
+
         Returns:
             canvasapi.folder.Folder:
                 The folder object
@@ -478,7 +484,9 @@ class cornellGrading:
 
         return pg
 
-    def createPage(self, title, body, editing_roles="teachers", published=False):
+    def createPage(
+        self, title, body, editing_roles="teachers", published=False, publish_at=None
+    ):
         """Create a Page
 
         Args:
@@ -489,7 +497,10 @@ class cornellGrading:
             editing_roles (str):
                 See canvas API. Comma sepeated string, defaults to "teachers"
             published (bool):
-                Whether page is published on create (defaults True)
+                Whether page is published on create (defaults False)
+            publish_at (datetime.datetime):
+                Publish date (not included if None). Must be timezone aware and UTC! If
+                set, overrides any inputs for published. Defaults None.
 
         Returns:
             canvasapi.page.Page:
@@ -503,6 +514,8 @@ class cornellGrading:
         """
 
         assert isinstance(editing_roles, str), "editing_roles must be a string."
+        if publish_at is not None:
+            published = False
 
         wiki_page = {
             "title": title,
@@ -510,6 +523,8 @@ class cornellGrading:
             "editing_roles": editing_roles,
             "published": published,
         }
+        if publish_at:
+            wiki_page["publish_at"] = publish_at.strftime("%Y-%m-%dT%H:%M:%SZ")
 
         res = self.course.create_page(wiki_page=wiki_page)
 
@@ -523,6 +538,7 @@ class cornellGrading:
         hidden=True,
         editing_roles="teachers",
         published=False,
+        publish_at=None,
         insertPDF=False,
     ):
         """Generate a new canvas page out of a LaTex source file
@@ -546,6 +562,9 @@ class cornellGrading:
                 See canvas API. Comma sepeated string, defaults to "teachers"
             published (bool):
                 Whether page is published on create (defaults False)
+            publish_at (datetime.datetime):
+                Publish date (not included if None). Must be timezone aware and UTC! If
+                set, overrides any inputs for published. Defaults None.
             insertPDF (bool):
                 If true, also include the original file in the page (this assumes that
                 fname points at the compiled PDF and not the source).
@@ -558,6 +577,7 @@ class cornellGrading:
             Requires pandoc to be installed and callable!
 
         .. warning::
+
             Uploaded files will overwrite files of the same name in the upload folder.
 
         """
@@ -585,7 +605,11 @@ class cornellGrading:
         body += " " + out
 
         res = self.createPage(
-            title, body, editing_roles=editing_roles, published=published
+            title,
+            body,
+            editing_roles=editing_roles,
+            published=published,
+            publish_at=publish_at,
         )
 
         return res
@@ -1011,6 +1035,8 @@ class cornellGrading:
                 Due date in format: YYYY-MM-DD (5pm assumed local time)
             hwfile (str):
                 Full path to homework file
+            totscore (int, float):
+                Total number of points for the assignment. Defaults to 10.
             unlockDelta (float):
                 Unlock this number of days before due date. Defaults to None,
                 which makes the assignment initially unlocked.
@@ -1211,36 +1237,31 @@ class cornellGrading:
                 f.write(ll)
 
         # run pandoc
-        if hwd:
-            _ = subprocess.run(
-                [
-                    "pandoc",
-                    os.path.join(tmpdir, texf),
-                    "-s",
-                    "--webtex",
-                    "-o",
-                    htmlf,
-                    "--default-image-extension=png",
-                ],
-                cwd=hwd,
-                check=True,
-                capture_output=True,
-            )
+        if not (hwd):
+            hwd = os.path.curdir
+
+        pandoc_comm = [
+            "pandoc",
+            os.path.join(tmpdir, texf),
+            "-s",
+            "--webtex",
+            "-o",
+            htmlf,
+            "--default-image-extension=png",
+        ]
+
+        if shutil.which("pandoc-crossref") is not None:
+            pandoc_comm += ["--filter", "pandoc-crossref"]
+            have_crossref = True
         else:
-            _ = subprocess.run(
-                [
-                    "pandoc",
-                    os.path.join(tmpdir, texf),
-                    "-s",
-                    "--webtex",
-                    "-o",
-                    htmlf,
-                    "--default-image-extension=png",
-                ],
-                cwd=os.path.curdir,
-                check=True,
-                capture_output=True,
-            )
+            have_crossref = False
+
+        _ = subprocess.run(
+            pandoc_comm,
+            cwd=hwd,
+            check=True,
+            capture_output=True,
+        )
 
         assert os.path.exists(htmlf), "Cannot locate html output %s" % htmlf
 
@@ -1250,13 +1271,7 @@ class cornellGrading:
 
         upfolder = self.createFolder(folder, hidden=hidden)
 
-        # global replacements
-        repdict = {
-            r'class="math display"': r'style="display: block; text-align: center; margin: 0.5rem auto;"',
-            r'img style="vertical-align:middle"': r'img class="equation_image"',
-            r'src="https://latex.codecogs.com/png.latex\?': r'src="https://canvas.cornell.edu/equation_images/',
-        }
-
+        # latex conversion
         p = re.compile(r'src="https://latex.codecogs.com/png.latex\?(.*?)"')
 
         def convlatex(x):
@@ -1269,21 +1284,10 @@ class cornellGrading:
             parser.feed(line)
             if parser.inBody:
                 tmp = p.sub(convlatex, line)
-                for k, v in repdict.items():
-                    tmp = re.sub(k, v, tmp)
-
-                while parser.imagesUploaded:
-                    imup = parser.imagesUploaded.pop()
-                    canvasimurl = (
-                        r'src="https://canvas.cornell.edu{0}/preview" '
-                        r'data-api-endpoint="https://canvas.cornell.edu/api/'
-                        r'v1{0}" data-api-returntype="File" '.format(imup["url"])
-                    )
-                    tmp = re.sub(r'src="{0}"'.format(imup["orig"]), canvasimurl, tmp)
 
-                    if parser.figcaptions:
-                        figcap = parser.figcaptions.pop()
-                        tmp = re.sub(r'alt=""', r'alt="{0}"'.format(figcap), tmp)
+                if (len(parser.figcaptions) > 0) and not (have_crossref):
+                    figcap = parser.figcaptions.pop()
+                    tmp = re.sub(r'alt=""', r'alt="{0}"'.format(figcap), tmp)
 
                 if parser.spanDefs:
                     for cl, val in parser.spanDefs.items():
@@ -1294,10 +1298,43 @@ class cornellGrading:
 
                 out.append(tmp)
 
+        # put everything together into a isngle string
         out = out[1:]
-        # out = ' #strdelim# '.join(out)
         out = " ".join(out)
 
+        # global replacements
+        repdict = {
+            r'class="math display"': r'style="display: block; text-align: center; margin: 0.5rem auto;"',
+            r'img[\s]*style="vertical-align:middle"': r'img class="equation_image"',
+            r'src="https://latex.codecogs.com/png.latex\?': r'src="https://canvas.cornell.edu/equation_images/',
+            r"<figcaption": '<figcaption style="text-align: center;"',
+        }
+
+        for k, v in repdict.items():
+            out = re.sub(k, v, out)
+
+        # handle all uploaded figures:
+        while parser.imagesUploaded:
+            imup = parser.imagesUploaded.pop()
+            canvasimurl = (
+                r'src="https://canvas.cornell.edu{0}/preview" '
+                r'data-api-endpoint="https://canvas.cornell.edu/api/'
+                r'v1{0}" data-api-returntype="File" '.format(imup["url"])
+            )
+            out = re.sub(r'src="{0}"'.format(imup["orig"]), canvasimurl, out)
+
+        # figures less than 100% width get centered:
+        p2 = re.compile(r'style="([\S]*)?(?=")"')
+
+        def convwidth(x):
+            return re.sub(
+                x.group(1),
+                f"{x.group(1)}; display: block; margin-left: auto; margin-right: auto;",
+                x.group(),
+            )
+
+        out = p2.sub(convwidth, out)
+
         # handle any labeled equations
         if parser.eqlabels:
             for label, (eqnum, labelstr) in parser.eqlabels.items():
@@ -1306,14 +1343,10 @@ class cornellGrading:
                 # for every equation image with a label, find it, and replace with a
                 # span with an equation number
                 imtag = re.search(
-                    # r'<p>(<img class="equation_image"(.*?)(?={})([\s\S]*?)(?=/></p>)/>)</p>'.format(
-                    # r'(<img class="equation_image"(.*?)(?={})([\s\S]*?)(?=/>)/>)'.format(
-                    # r'(<img class="equation_image" src="https://canvas.cornell.edu/equation_images/([\w%]*?)(?={})([\s\S]*?)(?=/>)/>)'.format(
-                    r'(<img class="equation_image" src="https://canvas.cornell.edu/equation_images/([\w%.-]*?)(?={})([\s\S]*?)(?=/>)/>)'.format(
-                        enclabel
-                    ),
+                    rf'(<img class="equation_image"[\s]*src="https://canvas.cornell.edu/equation_images/([\w%.-]*?)(?={enclabel})([\s\S]*?)(?=/>)/>)',
                     out,
                 )
+
                 imspan = (
                     r'<span style="margin: 1ex auto; display: table; '
                     r'text-align: center; width: 100%; vertical-align: middle;"> '
@@ -1332,11 +1365,10 @@ class cornellGrading:
                 out = out.replace("[{}]".format(label), "{}".format(eqnum))
 
         # handle any figure labels
-        if parser.figLabels:
+        if (len(parser.figLabels) > 0) and not (have_crossref):
             for cl, val in parser.figLabels.items():
                 out = out.replace(cl, val)
 
-        # out = out.split(' #strdelim# ')
         return out
 
     def genPrivateHWSurvey(self, surveyname, nprobs, scoreOptions=None, ecprobs=[]):
@@ -1599,7 +1631,7 @@ class cornellGrading:
                 Number of assignment. Name of survey will be
                 "self.coursename HW# Self-Grade"
                 Name of assignment will be HW#
-            escore (int):
+            ecscore (int):
                 Extra credit score (defaults to 3)
             checkLate (bool):
                 Check for late submissions (defaults true)
@@ -1962,3 +1994,265 @@ class cornellGrading:
             item["position"] = position
 
         module.create_module_item(item)
+
+    def addNewQuizItem(self, quizid, item):
+        """
+
+        Args:
+            quizid (int):
+                ID of New Quiz to add item to.\
+            item (dict):
+                Item payload dictionary.  This is the contents of the 'item' key in the
+                JSON payload. For details, see:
+                https://canvas.instructure.com/doc/api/new_quiz_items.html#Question+Types-appendix
+
+        """
+
+        full_url = "{}{}".format(
+            self.course._requester.new_quizzes_url,
+            "courses/{}/quizzes/{}/items".format(self.course.id, quizid),
+        )
+        headers = {
+            "Authorization": "Bearer {}".format(self.course._requester.access_token)
+        }
+
+        r = requests.post(full_url, json={"item": item}, headers=headers)
+        assert r.status_code == 200
+
+    def getHomework(self, assignmentNum, preamble=""):
+        """Retrieve assignment based on number and optional preamble
+
+        Args:
+            assignmentNum (int):
+                Assignment names will be of the form "[preamble] HW#"
+                where # is `assignmentNum`. See also `preamble` input.
+
+            preamble (str):
+                If not "", then assignment name will be "[preamble] HW#". Otherwise,
+                name will be "HW#".  Defaults to ""
+
+        Returns:
+            tuple:
+                hwname (str):
+                    Full assignment name
+                hw (canvasapi.assignment.Assignment):
+                    Assignment object
+        """
+
+        # if preamble set, make sure it ends in a space
+        if preamble != "":
+            preamble = f"{preamble.strip()} "
+
+        # generate the name and grab the assignment
+        hwname = f"{preamble}HW{assignmentNum}"
+        hw = self.getAssignment(hwname)
+
+        return hwname, hw
+
+    def setupNewQuizSelfAssessment(
+        self,
+        assignmentNum,
+        nprobs,
+        solfile,
+        item,
+        preamble="",
+        selfGradeDueDelta=7,
+        selfGradeReleasedDelta=3,
+    ):
+        """Create a page with reference solutions and a New Quiz linking to the page for
+        student self-assemssent.
+
+        Args:
+            assignmentNum (int):
+                Number of assignment.
+                See :py:meth:`cornellGrading.cornellGrading.getHomework` for details.
+            nprobs (int):
+                Number of howmework problems
+            solfile (str):
+                Full path to solutions file to upload
+            item (dict):
+                New Quiz item payload dictionary. See `addNewQuizItem`
+            preamble (str):
+                Preamble for all naming.
+                See :py:meth:`cornellGrading.cornellGrading.getHomework` for details.
+            selfGradeDueDelta (float):
+                Days after initial hw duedate that self-grading is due
+            selfGradeReleasedDelta (float):
+                Days after initial hw duedate that self-grading (and solutions) are
+                released.
+
+        Returns:
+            None
+
+        """
+
+        # ensure solutions file exists
+        assert os.path.exists(solfile)
+
+        # get original assignment
+        hwname, hw = self.getHomework(assignmentNum, preamble=preamble)
+
+        # figure out all dates
+        duedate = datetime.strptime(hw.due_at, """%Y-%m-%dT%H:%M:%S%z""")
+        unlockdate = duedate + timedelta(days=selfGradeReleasedDelta)
+        selfgradeduedate = unlockdate + timedelta(days=selfGradeDueDelta)
+
+        # generate reference solutions page
+        pagename = f"{hwname} Solutions"
+
+        hwfoldername = "Homeworks/HW%d" % assignmentNum
+        _ = self.createFolder(hwfoldername, hidden=True)
+
+        p = self.latex2page(
+            solfile,
+            pagename,
+            folder=hwfoldername,
+            publish_at=unlockdate,
+        )
+
+        # get self-assessment assignment group and generate new quiz there
+        assgrp = self.getAssignmentGroup("Homework Self-Assessment")
+
+        instructions = (
+            rf"<p>{hwname} Solutions are available here: "
+            rf'<a title={pagename} href="{p.html_url.split(".edu")[-1]}" '
+            rf'data-course-type="wikiPages">{pagename}</a>. Check your work and score '
+            r" yourself based on the rubric in the syllabus.</p>"
+        )
+
+        nq = self.course.create_new_quiz(
+            quiz={
+                "title": f"{hwname} Self-Assessment",
+                "assignment_group_id": assgrp.id,
+                "points_possible": hw.points_possible,
+                "due_at": selfgradeduedate,
+                "unlock_at": unlockdate,
+                "grading_type": "points",
+                "instructions": instructions,
+            }
+        )
+
+        # add new quiz items
+        for j in range(nprobs):
+            tmp = item.copy()
+            tmp["position"] = j + 1
+            tmp["entry"]["title"] = f"Problem {j+1} score"
+            self.addNewQuizItem(nq.id, tmp)
+
+        # publish quiz
+        ass = self.getAssignment(nq.title)
+        ass.edit(assignment={"published": True})
+
+    def linearTimePenalty(self, hw, latePenalty=0.25, maxDaysLate=3):
+        """Compute late penalty as linearly increasing in time.
+
+        Args:
+            hw (canvasapi.assignment.Assignment):
+                Assignment object
+            latePenalty (float):
+                Maximum fraction of score to remove for lateness (defaults to 0.25).
+                Must be in (0,1).
+            maxDaysLate (float):
+                After this number of days past deadline, HW gets zero. Defaults to 3.
+                Students submitting at exactly the maximum time will recieve the maximum
+                late penalty.
+
+        Returns:
+            dict:
+                Dictionary of late penalties in absolute points. Keys are netids.
+                The dictionary will only contain values for students with submissions.
+
+        """
+
+        totscore = hw.points_possible
+        duedate = datetime.strptime(hw.due_at, """%Y-%m-%dT%H:%M:%S%z""")
+
+        lates = {}
+        for t in hw.get_submissions():
+            if t.user_id in self.ids:
+                netid = self.netids[self.ids == t.user_id][0]
+
+                if t.submitted_at:
+                    subtime = datetime.strptime(
+                        t.submitted_at, """%Y-%m-%dT%H:%M:%S%z"""
+                    )
+                    if not t.late:
+                        tdelta = 0
+                    else:
+                        tdelta = np.abs((duedate - subtime).total_seconds()) / 86400
+
+                    if tdelta > maxDaysLate:
+                        lates[netid] = totscore
+                    else:
+                        lates[netid] = tdelta / maxDaysLate * totscore * latePenalty
+
+        return lates
+
+    def importNewQuizSelfAssessment(
+        self,
+        assignmentNum,
+        latePenalty=0.25,
+        maxDaysLate=3,
+        preamble="",
+    ):
+        """
+
+        Args:
+            assignmentNum (int):
+                Number of assignment.
+                See :py:meth:`cornellGrading.cornellGrading.getHomework` for details.
+            latePenalty (float):
+                Maximum fraction of score to remove for lateness (defaults to 0.25).
+                Must be in (0,1).
+            maxDaysLate (float):
+                After this number of days past deadline, HW gets zero. Defaults to 3.
+                Students submitting at exactly the maximum time will recieve the maximum
+                late penalty.
+            preamble (str):
+                Preamble for all naming.
+                See :py:meth:`cornellGrading.cornellGrading.getHomework` for details.
+
+        Returns:
+            tuple:
+                submittedScoreNoAssignment (list):
+                    netids of students who submitted scores but not the original
+                    assignment
+                submittedAssignmentNoScore (list):
+                    netids of students who submitted original assignments but not
+                    self-assessment scores
+
+        """
+
+        # get original assignments
+        hwname, hw = self.getHomework(assignmentNum, preamble=preamble)
+
+        # compute late penalties
+        lates = self.linearTimePenalty(
+            hw, latePenalty=latePenalty, maxDaysLate=maxDaysLate
+        )
+
+        # get the self-grading assignment and process submissions
+        sg = self.getAssignment(f"{hwname} Self-Assessment")
+        netids = []
+        scores = []
+        submittedScoreNoAssignment = []
+        for sub in sg.get_submissions():
+            if sub.user_id not in self.ids:
+                continue
+            if sub.grade is None:
+                continue
+            netid = self.netids[self.ids == sub.user_id][0]
+            if netid not in lates:
+                print(f"{netid} submitted self-grading but not the assignment!")
+                submittedScoreNoAssignment.append(netid)
+                continue
+
+            netids.append(netid)
+            scores.append(float(sub.grade) - lates[netid])
+
+        # identify students with submitted assignments but no self-assessments
+        submittedAssignmentNoScore = list(set(lates.keys()) - set(netids))
+
+        self.uploadScores(hw, netids, scores)
+
+        return submittedScoreNoAssignment, submittedAssignmentNoScore

{cornellgrading-2.17.0 → cornellgrading-2.18.0/cornellGrading.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cornellGrading
-Version: 2.17.0
+Version: 2.18.0
 Summary: Routines for interacting with Cornell installations of Canvas and Qualtrics
 Home-page: https://github.com/dsavransky/grading
 Author: Dmitry Savransky

cornellgrading-2.18.0/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+    "tests",
+]
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+# Assume Python 3.10
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F", "D101", "D102", "D103", "D105", "D106", "D207", "D208", "D416", "D417","D419"]
+ignore = ["E741", "E731", "E203"]
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+

cornellgrading-2.17.0/pyproject.toml

@@ -1,3 +0,0 @@
-[build-system]
-requires = ["setuptools", "wheel"]
-build-backend = "setuptools.build_meta"