canvaslms 5.5__tar.gz → 5.6__tar.gz

{canvaslms-5.5 → canvaslms-5.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: canvaslms
-Version: 5.5
+Version: 5.6
 Summary: Command-line interface to Canvas LMS
 License-Expression: MIT
 License-File: LICENSE

{canvaslms-5.5 → canvaslms-5.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "canvaslms"
-version = "5.5"
+version = "5.6"
 description = "Command-line interface to Canvas LMS"
 authors = [
   {name = "Daniel Bosk", email = "daniel@bosk.se"}

{canvaslms-5.5 → canvaslms-5.6}/src/canvaslms/cli/modules.nw

@@ -486,6 +486,14 @@ def get_item_modules(course, item_type, item_id):
   Returns:
       List of module names containing this item
   """
+  target_url = None
+  if item_type == 'Page':
+    try:
+      target_url = course.get_page(item_id).url
+    except Exception:
+      # If we can't resolve the target page, fall back to raw comparisons.
+      target_url = item_id
+
   modules = []
   for module in course.get_modules():
     try:
@@ -514,10 +522,10 @@ elif item_type == 'Page':
     if item.page_url == item_id:
       modules.append(module.name)
       break
-    # Check if URLs resolve to same page (handles redirects)
+    # Compare canonical URLs to avoid duplicates when Canvas redirects old slugs.
     try:
       resolved_page = course.get_page(item.page_url)
-      if resolved_page.url == item_id:
+      if resolved_page.url == target_url:
         modules.append(module.name)
         break
     except Exception:
@@ -598,11 +606,18 @@ with its new canonical URL.
 Without handling this, the direct comparison [[item.page_url == item_id]] would
 fail, causing the page to be added to the module again (creating duplicates).
 
-To detect this, we fetch the page using the module item's [[page_url]] and
-compare its canonical [[url]] attribute with [[item_id]]. This adds an API call
-per page item, but only when the direct comparison fails.
+To detect this, we fetch both the target page ([[item_id]]) and the module
+item's page ([[item.page_url]]) and compare canonical [[url]] values. This adds
+API calls, but only when the direct comparison fails.
 <<find current module item if present>>=
 current_item = None
+canonical_page_url = None
+if item_type == 'Page':
+  try:
+    canonical_page_url = course.get_page(item_id).url
+  except Exception:
+    canonical_page_url = item_id
+
 try:
   for item in module.get_module_items():
     if not hasattr(item, 'type') or item.type != item_type:
@@ -625,10 +640,10 @@ Canvas has created a redirect from an old URL to a new one.
 if item.page_url == item_id:
   current_item = item
   break
-# URLs don't match directly; check if they resolve to same page
+# URLs don't match directly; compare canonical URLs to avoid duplicates.
 try:
   resolved_page = course.get_page(item.page_url)
-  if resolved_page.url == item_id:
+  if resolved_page.url == canonical_page_url:
     current_item = item
     break
 except Exception:

{canvaslms-5.5 → canvaslms-5.6}/src/canvaslms/cli/quizzes.nw

@@ -343,6 +343,7 @@ import canvaslms.cli
 import canvaslms.cli.courses as courses
 import canvaslms.cli.assignments as assignments
 import canvaslms.cli.content as content
+import canvaslms.cli.modules as modules
 import canvaslms.cli.utils
 from rich.console import Console
 from rich.markdown import Markdown
@@ -2982,6 +2983,24 @@ NEW_QUIZ_RESULT_VIEW_SCHEMA = {
 \subsection{File formats for quiz editing}
 \label{sec:quiz-file-formats}
 
+\subsection{Updating module membership}
+
+When a quiz is edited from a file, the front matter may include a [[modules]]
+field. We interpret this the same way as [[assignments edit]]:
+\begin{description}
+\item[Absent] Leave module membership unchanged.
+\item[Empty list] Remove the quiz from all modules.
+\item[List of regexes] Ensure the quiz appears in every matching module and is
+  removed from non-matching modules.
+\end{description}
+
+New Quizzes are implemented as assignments, and the module item type Canvas uses
+is [[Assignment]]. We therefore update membership using the quiz's assignment ID.
+Classic quizzes also appear as module items and can be targeted the same way.
+
+We centralize this logic in a helper function so both file-based and interactive
+edit paths behave identically.
+
 The [[quizzes edit]] command supports three file formats, auto-detected from
 the file extension and verified against the content:
 \begin{description}
@@ -3003,6 +3022,18 @@ characters of the file:
 \item Front matter format starts with [[---]]
 \end{itemize}
 
+<<functions>>=
+def update_quiz_module_membership(quiz, module_regexes):
+  """Update module membership for a quiz based on module regex list"""
+  item_id = int(quiz.id) if is_new_quiz(quiz) else quiz.id
+  added, removed = modules.update_item_modules(
+      quiz.course, 'Assignment', item_id, module_regexes)
+  if added:
+    print(f"  Added to modules: {', '.join(added)}", file=sys.stderr)
+  if removed:
+    print(f"  Removed from modules: {', '.join(removed)}", file=sys.stderr)
+
+
 <<functions>>=
 def detect_quiz_file_format(filepath):
     """Detect quiz file format from extension and content
@@ -3270,6 +3301,15 @@ If [[--replace-items]] is specified and the file contains items, we replace
 the quiz questions.  But first we check for student submissions and ask for
 confirmation if any exist.
 
+If the file contains a [[modules]] key (front matter, YAML, or JSON), we also
+update the quiz's module membership after a successful edit. We interpret this
+field the same way as in [[assignments edit]]:
+\begin{description}
+\item[Absent] Module membership is not modified
+\item[Empty list] Quiz is removed from all modules
+\item[List of regexes] Quiz is placed in all modules matching the patterns
+\end{description}
+
 <<handle item replacement if requested>>=
 items = quiz_data.get('items')
 if args.replace_items and items:
@@ -3294,6 +3334,7 @@ for quiz in quiz_list:
   success = apply_quiz_edit(quiz, settings, body, requester, args.html)
   if success:
     print(f"Updated quiz: {quiz.title}")
+    <<update quiz module membership from file>>
   else:
     canvaslms.cli.warn(f"Failed to update quiz: {quiz.title}")
 @
@@ -3396,6 +3437,8 @@ def edit_quiz_interactive(quiz, requester, html_mode=False):
 
   # Apply the changes
   success = apply_quiz_edit(quiz, final_attrs, final_body, requester, html_mode)
+  if success:
+    <<update quiz module membership interactively>>
   return 'updated' if success else 'error'
 @
 
@@ -3415,6 +3458,11 @@ The workflow is:
 \item Apply the changes (settings only, unless [[--replace-items]])
 \end{enumerate}
 
+<<update quiz module membership interactively>>=
+if 'modules' in final_attrs:
+  update_quiz_module_membership(quiz, final_attrs['modules'])
+@
+
 <<functions>>=
 def edit_quiz_interactive_json(quiz, requester, html_mode=False,
                                replace_items=False):
@@ -3680,6 +3728,11 @@ The [[replace_quiz_items]] function handles the complete process of replacing
 quiz items.  It first checks for submissions, then deletes existing items,
 and finally creates the new items.
 
+<<update quiz module membership from file>>=
+if 'modules' in settings:
+  update_quiz_module_membership(quiz, settings['modules'])
+@
+
 <<functions>>=
 def replace_quiz_items(quiz, items, requester):
   """Replace all items in a quiz with new ones
@@ -4256,6 +4309,11 @@ The export command finds the quiz, extracts its settings, and exports all
 questions.  We reuse the existing [[export_new_quiz_items]] and
 [[export_classic_questions]] functions for question export.
 
+If the quiz appears in modules, we also export a [[modules]] list. The
+[[quizzes edit]] command interprets this list as regex patterns, so we export
+module names as anchored, regex-escaped patterns (e.g., [[^FBF$]]) to mean
+\enquote{match this module name exactly}.
+
 <<functions>>=
 def export_command(config, canvas, args):
   """Exports a complete quiz (settings + questions) to JSON"""
@@ -4305,6 +4363,11 @@ def export_full_new_quiz(quiz, requester, include_banks=True, importable=False):
   """
   # Extract basic settings
   settings = {
+    'modules': [
+      "^" + re.escape(name) + "$"
+      for name in modules.get_item_modules(
+          quiz.course, 'Assignment', int(quiz.id))
+    ],
     'title': getattr(quiz, 'title', ''),
     'instructions': getattr(quiz, 'instructions', '') or '',
     'time_limit': getattr(quiz, 'time_limit', None),
@@ -4354,6 +4417,11 @@ def export_full_classic_quiz(quiz, importable=False):
   """
   # Extract settings
   settings = {
+    'modules': [
+      "^" + re.escape(name) + "$"
+      for name in modules.get_item_modules(
+          quiz.course, 'Assignment', quiz.id)
+    ],
     'title': getattr(quiz, 'title', ''),
     'description': getattr(quiz, 'description', '') or '',
     'quiz_type': getattr(quiz, 'quiz_type', 'assignment'),