ladok3 3.7__tar.gz → 3.8__tar.gz

{ladok3-3.7 → ladok3-3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ladok3
-Version: 3.7
+Version: 3.8
 Summary: Python wrapper and CLI for the LADOK3 REST API.
 Home-page: https://github.com/dbosk/ladok3
 License: MIT

{ladok3-3.7 → ladok3-3.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ladok3"
-version = "3.7"
+version = "3.8"
 description = "Python wrapper and CLI for the LADOK3 REST API."
 authors = [
   "Daniel Bosk <dbosk@kth.se>",

{ladok3-3.7 → ladok3-3.8}/src/ladok3/report.nw

@@ -129,8 +129,8 @@ them.
 <<check that we got all positional arguments>>
 try:
   student = ladok.get_student(args.student_id)
-  course = student.courses(code=args.course_code)[0]
-  result = course.results(component=args.component_code)[0]
+  <<look up [[course]] from [[student]]>>
+  <<look up [[result]] from [[course]]>>
   result.set_grade(args.grade, args.date)
   if args.finalize:
     result.finalize()
@@ -139,9 +139,25 @@ except Exception as err:
     print(f"{student}: {err}")
   except ValueError as verr:
     print(f"{verr}: {args.student_id}: {err}")
-@ This means that we need the following command-line arguments.
-The option [[args.finalize]] is already set above, so we don't need to add that 
-one here.
+@ The option [[args.finalize]] is already set above, so we don't need to add 
+that one here.
+
+Both looking up the course and the component can yield index errors.
+We'd like to distinguish these.
+We will catch the exception, the reraise the same exception but with a better 
+error message.
+<<look up [[course]] from [[student]]>>=
+try:
+  course = student.courses(code=args.course_code)[0]
+except IndexError:
+  raise Exception("f{args.course_code}: No such course for {student}")
+<<look up [[result]] from [[course]]>>=
+try:
+  result = course.results(component=args.component_code)[0]
+except IndexError:
+  raise Exception(f"{args.component_code}: "
+                  f"No such component for {args.course_code}")
+@
 
 
 \section{Report many results given in standard input}
@@ -180,23 +196,14 @@ try:
   try:
     course = student.courses(code=course_code)[0]
   except IndexError:
-    raise Exception(f"{course_code}: no such course.")
+    raise Exception(f"{course_code}: No such course for {student}")
 
   try:
     component = course.results(component=component_code)[0]
   except IndexError:
-    raise Exception(f"{course_code} has no component {component_code}.")
+    raise Exception(f"{component_code}: no such component for {course_code}")
 
-  if not component.attested and component.grade != grade:
-    component.set_grade(grade, date)
-    component.finalize()
-    if args.verbose:
-      print(f"{course_code} {student}: reported "
-        f"{component.component} = {component.grade} ({date}).")
-  elif component.grade != grade:
-    print(f"{course_code} {student}: attested {component.component} "
-      f"result {component.grade} ({component.date}) "
-      f"is different from {grade} ({date}).")
+  <<set [[grade]] to [[component]], output if verbose>>
 except Exception as err:
   try:
     print(f"{course_code} {component_code}={grade} ({date}) {student}: {err}",
@@ -207,6 +214,30 @@ except Exception as err:
       file=sys.stderr)
 @
 
+Now, when we set the grade, there are a few cases that should be handled.
+If the grade isn't attested, we try to change it.
+(This might still fail if the grade is finalized but not attested.)
+If we've selected the verbose option, then we print what we have reported.
+
+If the grade was attested, then we check if it's different.
+If it's different, we output this.
+If it's the same, we silently ignore it.
+This is best for bulk reporting, because then we can always try to report for 
+all students.
+<<set [[grade]] to [[component]], output if verbose>>=
+if not component.attested and component.grade != grade:
+  component.set_grade(grade, date)
+  if args.finalize:
+    component.finalize()
+  if args.verbose:
+    print(f"{course_code} {student}: reported "
+      f"{component.component} = {component.grade} ({date}).")
+elif component.grade != grade:
+  print(f"{course_code} {student}: attested {component.component} "
+    f"result {component.grade} ({component.date}) "
+    f"is different from {grade} ({date}).")
+@
+
 
 \section{Determine which function to run}
 

{ladok3-3.7 → ladok3-3.8}/src/ladok3/student.nw

@@ -63,6 +63,17 @@ student_parser.add_argument("-c", "--course",
 )
 @
 
+\subsection{A results flag}
+
+We also want a flag for specifying whether or not to include the results of 
+each course.
+<<add student command arguments to student parser>>=
+student_parser.add_argument("-r", "--results",
+  action="store_true", default=False,
+  help="Set to include results for each course listed."
+)
+@
+
 \section{Print the student data}
 
 Now that we have the student identifier, we can simply use that to fetch the 
@@ -80,7 +91,7 @@ print_student_data(student)
 
 if args.course:
   print()
-  print_course_data(student, args.course)
+  print_course_data(student, args)
 @
 
 \subsection{Printing personal student data}
@@ -102,13 +113,15 @@ def print_student_data(student):
 
 To print the student's course data, we simply filter the courses on the option 
 that the user supplies.
-We then print all results for each course.
+We then print all courses and, if the flag is set, we also print the results 
+for each course.
 <<functions>>=
-def print_course_data(student, course):
+def print_course_data(student, args):
   """Prints the courses"""
   print("Courses:")
-  for course in student.courses(code=course):
+  for course in student.courses(code=args.course):
     print(f"{course}")
-    for result in course.results():
-      print(f"  {result}")
+    if args.results:
+      for result in course.results():
+        print(f"  {result}")
 @