canvaslms 5.10__py3-none-any.whl → 6.1__py3-none-any.whl

canvaslms/cli/assignments.py

@@ -289,6 +289,12 @@ def assignments_view_command(config, canvas, args):
                 assignment_rubric = None
                 if hasattr(assignment, "rubric") and assignment.rubric:
                     assignment_rubric = assignment.rubric
+                if hasattr(args, "assignment") and args.assignment not in (None, ".*"):
+                    # User specified a -a filter, use it verbatim
+                    assignment_regex = args.assignment
+                else:
+                    # Generate exact-match regex from name
+                    assignment_regex = "^" + re.escape(assignment.name) + "$"
                 output = canvaslms.cli.content.render_to_html(
                     assignment,
                     canvaslms.cli.content.ASSIGNMENT_SCHEMA,
@@ -296,6 +302,7 @@ def assignments_view_command(config, canvas, args):
                     extra_attributes={
                         "modules": assignment_modules,
                         "rubric": assignment_rubric,
+                        "regex": assignment_regex,
                     },
                 )
                 print(output)
@@ -306,6 +313,12 @@ def assignments_view_command(config, canvas, args):
                 assignment_rubric = None
                 if hasattr(assignment, "rubric") and assignment.rubric:
                     assignment_rubric = assignment.rubric
+                if hasattr(args, "assignment") and args.assignment not in (None, ".*"):
+                    # User specified a -a filter, use it verbatim
+                    assignment_regex = args.assignment
+                else:
+                    # Generate exact-match regex from name
+                    assignment_regex = "^" + re.escape(assignment.name) + "$"
                 output = canvaslms.cli.content.render_to_markdown(
                     assignment,
                     canvaslms.cli.content.ASSIGNMENT_SCHEMA,
@@ -313,6 +326,7 @@ def assignments_view_command(config, canvas, args):
                     extra_attributes={
                         "modules": assignment_modules,
                         "rubric": assignment_rubric,
+                        "regex": assignment_regex,
                     },
                 )
                 print(output)
@@ -502,37 +516,42 @@ def assignments_edit_command(config, canvas, args):
                 args.file
             )
         except FileNotFoundError:
-            logger.error(f"File not found: {args.file}")
-            print(f"Error: File not found: {args.file}", file=sys.stderr)
-            return
+            canvaslms.cli.err(1, f"File not found: {args.file}")
         except Exception as e:
-            logger.error(f"Error reading file: {e}")
-            print(f"Error reading file: {e}", file=sys.stderr)
-            return
+            canvaslms.cli.err(1, f"Error reading file: {e}")
 
         errors = canvaslms.cli.content.validate_attributes(
             attributes, canvaslms.cli.content.ASSIGNMENT_SCHEMA
         )
         if errors:
             for error in errors:
-                print(f"Validation error: {error}", file=sys.stderr)
-            return
+                logger.error(f"Validation error: {error}")
+            canvaslms.cli.err(1, "File validation failed")
         if args.html:
             html_content = body_content  # Already HTML, no conversion needed
         else:
             html_content = pypandoc.convert_text(body_content, "html", format="md")
 
-        if "id" in attributes and attributes["id"]:
-            assignment_id = attributes["id"]
+        if "regex" in attributes and attributes["regex"]:
+            regex_pattern = attributes["regex"]
             course_list = courses.process_course_option(canvas, args)
             if not course_list:
-                print("Error: No courses found matching criteria", file=sys.stderr)
-                return
+                canvaslms.cli.err(1, "No courses found matching criteria")
 
             course = course_list[0]
+
+            all_assignments = list(course.get_assignments())
+            for a in all_assignments:
+                a.course = course
+
             try:
-                assignment = course.get_assignment(assignment_id)
-                assignment.course = course
+                assignment = canvaslms.cli.content.match_item_by_regex(
+                    all_assignments,
+                    regex_pattern,
+                    [lambda a: a.name, lambda a: str(a.id)],
+                    item_type="assignment",
+                    name_func=lambda a: a.name,
+                )
                 update_data = {
                     "assignment": {
                         "name": attributes.get("name", assignment.name),
@@ -584,12 +603,12 @@ def assignments_edit_command(config, canvas, args):
                                 file=sys.stderr,
                             )
                 except Exception as e:
-                    logger.error(f"Error updating assignment '{assignment.name}': {e}")
-                    print(
-                        f"Error updating assignment '{assignment.name}': {e}",
-                        file=sys.stderr,
+                    canvaslms.cli.err(
+                        1, f"Error updating assignment '{assignment.name}': {e}"
                     )
-            except Exception as e:
+            except re.error as e:
+                canvaslms.cli.err(1, f"Invalid regex pattern '{regex_pattern}': {e}")
+            except canvaslms.cli.EmptyListError:
                 if args.create:
                     create_params = {
                         "name": attributes.get("name", "Untitled Assignment"),
@@ -617,9 +636,9 @@ def assignments_edit_command(config, canvas, args):
                             assignment=create_params
                         )
                         new_assignment.course = course
-                        print(
-                            f"Created assignment: {new_assignment.name} (id: {new_assignment.id})",
-                            file=sys.stderr,
+                        logger.info(
+                            f"Created assignment: {new_assignment.name} "
+                            f"(id: {new_assignment.id})"
                         )
                         if "modules" in attributes:
                             module_regexes = attributes["modules"]
@@ -635,75 +654,211 @@ def assignments_edit_command(config, canvas, args):
                                     file=sys.stderr,
                                 )
                     except Exception as e:
-                        logger.error(f"Error creating assignment: {e}")
-                        print(f"Error creating assignment: {e}", file=sys.stderr)
+                        canvaslms.cli.err(1, f"Error creating assignment: {e}")
                 else:
-                    print(
-                        f"Error: Assignment with ID '{assignment_id}' not found. "
+                    canvaslms.cli.err(
+                        1,
+                        f"No assignments match regex '{regex_pattern}'. "
                         f"Use --create to create a new assignment.",
-                        file=sys.stderr,
                     )
-                    return
         else:
-            assignment_list = process_assignment_option(canvas, args)
+            if "name" in attributes and attributes["name"]:
+                name = attributes["name"]
+                course_list = courses.process_course_option(canvas, args)
+                if not course_list:
+                    canvaslms.cli.err(1, "No courses found matching criteria")
 
-            for assignment in assignment_list:
-                update_data = {
-                    "assignment": {
-                        "name": attributes.get("name", assignment.name),
-                        "description": html_content,
-                    }
-                }
+                course = course_list[0]
 
-                if "due_at" in attributes and attributes["due_at"] is not None:
-                    update_data["assignment"]["due_at"] = attributes["due_at"]
-                if "unlock_at" in attributes and attributes["unlock_at"] is not None:
-                    update_data["assignment"]["unlock_at"] = attributes["unlock_at"]
-                if "lock_at" in attributes and attributes["lock_at"] is not None:
-                    update_data["assignment"]["lock_at"] = attributes["lock_at"]
-                if (
-                    "points_possible" in attributes
-                    and attributes["points_possible"] is not None
-                ):
-                    update_data["assignment"]["points_possible"] = attributes[
-                        "points_possible"
-                    ]
-                if "published" in attributes:
-                    update_data["assignment"]["published"] = attributes["published"]
+                all_assignments = list(course.get_assignments())
+                for a in all_assignments:
+                    a.course = course
 
                 try:
-                    assignment.edit(**update_data)
-                    assignment._fetched_at = datetime.now()
-                    if hasattr(assignment.course, "assignment_cache"):
-                        assignment.course.assignment_cache[assignment.id] = (
-                            assignment,
-                            {},
-                        )
-                    logger.info(f"Updated assignment: {assignment.name}")
-                    if "modules" in attributes:
-                        module_regexes = attributes["modules"]
-                        added, removed = modules.update_item_modules(
-                            assignment.course,
-                            "Assignment",
-                            assignment.id,
-                            module_regexes,
+                    assignment = canvaslms.cli.content.match_item_by_name(
+                        all_assignments, name, lambda a: a.name, item_type="assignment"
+                    )
+                    update_data = {
+                        "assignment": {
+                            "name": attributes.get("name", assignment.name),
+                            "description": html_content,
+                        }
+                    }
+
+                    if "due_at" in attributes and attributes["due_at"] is not None:
+                        update_data["assignment"]["due_at"] = attributes["due_at"]
+                    if (
+                        "unlock_at" in attributes
+                        and attributes["unlock_at"] is not None
+                    ):
+                        update_data["assignment"]["unlock_at"] = attributes["unlock_at"]
+                    if "lock_at" in attributes and attributes["lock_at"] is not None:
+                        update_data["assignment"]["lock_at"] = attributes["lock_at"]
+                    if (
+                        "points_possible" in attributes
+                        and attributes["points_possible"] is not None
+                    ):
+                        update_data["assignment"]["points_possible"] = attributes[
+                            "points_possible"
+                        ]
+                    if "published" in attributes:
+                        update_data["assignment"]["published"] = attributes["published"]
+
+                    try:
+                        assignment.edit(**update_data)
+                        assignment._fetched_at = datetime.now()
+                        if hasattr(assignment.course, "assignment_cache"):
+                            assignment.course.assignment_cache[assignment.id] = (
+                                assignment,
+                                {},
+                            )
+                        logger.info(f"Updated assignment: {assignment.name}")
+                        if "modules" in attributes:
+                            module_regexes = attributes["modules"]
+                            added, removed = modules.update_item_modules(
+                                assignment.course,
+                                "Assignment",
+                                assignment.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,
+                                )
+                    except Exception as e:
+                        canvaslms.cli.err(
+                            1, f"Error updating assignment '{assignment.name}': {e}"
                         )
-                        if added:
-                            print(
-                                f"  Added to modules: {', '.join(added)}",
-                                file=sys.stderr,
+                except canvaslms.cli.EmptyListError:
+                    if args.create:
+                        create_params = {
+                            "name": attributes.get("name", "Untitled Assignment"),
+                            "description": html_content,
+                        }
+                        if "due_at" in attributes and attributes["due_at"] is not None:
+                            create_params["due_at"] = attributes["due_at"]
+                        if (
+                            "unlock_at" in attributes
+                            and attributes["unlock_at"] is not None
+                        ):
+                            create_params["unlock_at"] = attributes["unlock_at"]
+                        if (
+                            "lock_at" in attributes
+                            and attributes["lock_at"] is not None
+                        ):
+                            create_params["lock_at"] = attributes["lock_at"]
+                        if (
+                            "points_possible" in attributes
+                            and attributes["points_possible"] is not None
+                        ):
+                            create_params["points_possible"] = attributes[
+                                "points_possible"
+                            ]
+                        if "published" in attributes:
+                            create_params["published"] = attributes["published"]
+
+                        try:
+                            new_assignment = course.create_assignment(
+                                assignment=create_params
                             )
-                        if removed:
-                            print(
-                                f"  Removed from modules: {', '.join(removed)}",
-                                file=sys.stderr,
+                            new_assignment.course = course
+                            logger.info(
+                                f"Created assignment: {new_assignment.name} "
+                                f"(id: {new_assignment.id})"
                             )
-                except Exception as e:
-                    logger.error(f"Error updating assignment '{assignment.name}': {e}")
-                    print(
-                        f"Error updating assignment '{assignment.name}': {e}",
-                        file=sys.stderr,
+                            if "modules" in attributes:
+                                module_regexes = attributes["modules"]
+                                added, removed = modules.update_item_modules(
+                                    new_assignment.course,
+                                    "Assignment",
+                                    new_assignment.id,
+                                    module_regexes,
+                                )
+                                if added:
+                                    print(
+                                        f"  Added to modules: {', '.join(added)}",
+                                        file=sys.stderr,
+                                    )
+                        except Exception as e:
+                            canvaslms.cli.err(1, f"Error creating assignment: {e}")
+                    else:
+                        canvaslms.cli.err(
+                            1,
+                            f"No assignments match name '{name}'. "
+                            f"Use --create to create a new assignment.",
+                        )
+            else:
+                assignment_list = process_assignment_option(canvas, args)
+                if len(assignment_list) > 1:
+                    canvaslms.cli.err(
+                        1,
+                        f"{len(assignment_list)} assignments match filter. "
+                        f"Add 'name' or 'regex' to YAML, or use -a to narrow selection.",
                     )
+                for assignment in assignment_list:
+                    update_data = {
+                        "assignment": {
+                            "name": attributes.get("name", assignment.name),
+                            "description": html_content,
+                        }
+                    }
+
+                    if "due_at" in attributes and attributes["due_at"] is not None:
+                        update_data["assignment"]["due_at"] = attributes["due_at"]
+                    if (
+                        "unlock_at" in attributes
+                        and attributes["unlock_at"] is not None
+                    ):
+                        update_data["assignment"]["unlock_at"] = attributes["unlock_at"]
+                    if "lock_at" in attributes and attributes["lock_at"] is not None:
+                        update_data["assignment"]["lock_at"] = attributes["lock_at"]
+                    if (
+                        "points_possible" in attributes
+                        and attributes["points_possible"] is not None
+                    ):
+                        update_data["assignment"]["points_possible"] = attributes[
+                            "points_possible"
+                        ]
+                    if "published" in attributes:
+                        update_data["assignment"]["published"] = attributes["published"]
+
+                    try:
+                        assignment.edit(**update_data)
+                        assignment._fetched_at = datetime.now()
+                        if hasattr(assignment.course, "assignment_cache"):
+                            assignment.course.assignment_cache[assignment.id] = (
+                                assignment,
+                                {},
+                            )
+                        logger.info(f"Updated assignment: {assignment.name}")
+                        if "modules" in attributes:
+                            module_regexes = attributes["modules"]
+                            added, removed = modules.update_item_modules(
+                                assignment.course,
+                                "Assignment",
+                                assignment.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,
+                                )
+                    except Exception as e:
+                        canvaslms.cli.err(
+                            1, f"Error updating assignment '{assignment.name}': {e}"
+                        )
     else:
         try:
             assignment_list = process_assignment_option(canvas, args)
@@ -891,6 +1046,8 @@ def add_assignments_command(subp):
         "view",
         help="View assignment details",
         description="Views detailed information about assignments. "
+        "When piped (not a TTY), outputs YAML front matter with a 'regex' field "
+        "for stable identification, followed by the description as Markdown. "
         "Use --html to preserve HTML instead of converting to Markdown.",
     )
     view_parser.set_defaults(func=assignments_view_command)
@@ -938,10 +1095,18 @@ def add_assignments_command(subp):
         description="Edit assignment content. Without -f, opens each matching "
         "assignment in your editor for interactive editing with preview. "
         "With -f, reads from a Markdown file with YAML front matter and updates "
-        "directly (script-friendly). If the YAML contains an 'id' field, the "
-        "command uses it to identify the assignment; use --create to create a new "
-        "assignment if the ID is not found. Use --html to read/edit HTML directly "
-        "without Markdown conversion.",
+        "directly (script-friendly). "
+        "Assignment matching workflow: "
+        "(1) If the YAML contains a 'regex' field, it matches assignments by "
+        "name or Canvas numeric ID. The regex is tested against both. "
+        "This provides stable identification: export an assignment with "
+        "'assignments view -a \"Lab 1.*\" > lab.md', edit locally, and push "
+        "back with 'assignments edit -f lab.md'---the regex stays constant "
+        "even if the name changes slightly. "
+        "(2) If no 'regex' is present but 'name' is, exact name matching is "
+        "used. "
+        "(3) Otherwise, falls back to -a, -A, and -M filters. "
+        "Use --html to read/edit HTML directly without Markdown conversion.",
     )
     edit_parser.set_defaults(func=assignments_edit_command)
     add_assignment_option(edit_parser, ungraded=False, required=True)
@@ -949,7 +1114,7 @@ def add_assignments_command(subp):
     edit_parser.add_argument(
         "--create",
         action="store_true",
-        help="Create a new assignment if the ID in the YAML is not found",
+        help="Create a new assignment if no match is found",
     )
     edit_parser.add_argument(
         "--html",

canvaslms/cli/cli.nw

@@ -76,9 +76,19 @@ import argparse
 \section{Printing errors and warnings}
 
 We want uniform error handling.
+Both [[EmptyListError]] and [[MultipleMatchesError]] represent query-result
+conditions: the caller asked for items and got the wrong number.
+Different callers handle these differently---interactive commands may catch
+them locally and continue, while batch commands let them propagate to the
+main handler for uniform treatment.
 <<classes and exceptions>>=
 class EmptyListError(Exception):
-  """Exception raised when a process function returns an empty list"""
+  """Exception raised when a query returns no matching items"""
+  pass
+
+class MultipleMatchesError(Exception):
+  """Exception raised when a query matches multiple items
+  but exactly one was expected"""
   pass
 @
 
@@ -411,6 +421,11 @@ if args.func:
       err(1, str(e))
     else:
       sys.exit(1)
+  except MultipleMatchesError as e:
+    if args.quiet == 0:
+      err(1, str(e))
+    else:
+      sys.exit(1)
 @
 
 We know that the [[login]] command doesn't need the Canvas object.