ladok3 4.19__py3-none-any.whl → 5.0__py3-none-any.whl

ladok3/data.nw

@@ -16,7 +16,7 @@ from LADOK (\cref{DataCommand}).
 This is a subcommand for the [[ladok]] command-line interface.
 It can be used like this:
 \begin{minted}{bash}
-ladok data DD1315 > DD1315.csv
+ladok course DD1315 > DD1315.csv
 \end{minted}
 This program will produce CSV-formated data to answer the questions above.
 The data is formated like this:
@@ -26,11 +26,11 @@ The data is formated like this:
 \item component,
 \item student (pseudonym),
 \item grade,
-\item normalized time.
+\item either absolute date or normalized to the course start and finish.
 \end{itemize}
 
 
-\section{The [[data]] subcommand}\label{DataCommand}
+\section{The [[course]] subcommand}\label{DataCommand}
 
 This is a subcommand run as part of the [[ladok3.cli]] module.
 We provide a function [[add_command_options]] that adds the subcommand options 
@@ -59,7 +59,7 @@ def command(ladok, args):
 We add a subparser.
 We set it up to use the function [[command]].
 <<add data parser to parser>>=
-data_parser = parser.add_parser("data",
+data_parser = parser.add_parser("course",
   help="Returns course results data in CSV form",
   description="""
 Returns the results in CSV form for all first-time registered students.
@@ -79,9 +79,10 @@ course_rounds = filter_rounds(
   ladok.search_course_rounds(code=args.course_code),
   args.rounds)
 
-data_writer.writerow([
-  "Course", "Round", "Component", "Student", "Grade", "Time"
-])
+if args.header:
+  data_writer.writerow([
+    "Course", "Round", "Component", "Student", "Grade", "Time"
+  ])
 for course_round in course_rounds:
   data = extract_data_for_round(ladok, course_round, args)
 
@@ -91,6 +92,7 @@ for course_round in course_rounds:
         student, grade, time]
     )
 @ We must take a course code and a delimiter as arguments.
+We also want to know if we want a header or not.
 <<add data command arguments to data parser>>=
 data_parser.add_argument("course_code",
   help="The course code of the course for which to export data")
@@ -100,6 +102,9 @@ data_parser.add_argument("-d", "--delimiter",
   help="The delimiter for the CSV output; "
     "default is a tab character to be compatible with POSIX commands, "
     "use `-d,` or `-d ,` to get comma-separated values.")
+
+data_parser.add_argument("-H", "--header", action="store_true",
+                         help="Print a header line with the column names.")
 @
 
 We filter the rounds.
@@ -154,7 +159,20 @@ def extract_data_for_round(ladok, course_round, args):
       else:
         <<extract grade and normalized date from result data>>
 
-      yield student, component, grade, normalized_date
+      <<yield [[student, component, grade]] and date>>
+@
+
+We want to yield the data in CSV form, so we simply yield a tuple.
+The date is either the normalized date or the date from the result data.
+<<yield [[student, component, grade]] and date>>=
+if args.normalize_date:
+  yield student, component, grade, normalized_date
+elif result_data:
+  yield student, component, grade, result_data["Examinationsdatum"]
+<<add data command arguments to data parser>>=
+data_parser.add_argument("-n", "--normalize-date", action="store_true",
+                         help="Normalize the date to the start of the course, "
+                              "otherwise the date is printed as is.")
 @
 
 \subsection{Get round data}

ladok3/data.py

@@ -60,7 +60,10 @@ def extract_data_for_round(ladok, course_round, args):
                     grade = "-"
                     normalized_date = None
 
-            yield student, component, grade, normalized_date
+            if args.normalize_date:
+                yield student, component, grade, normalized_date
+            elif result_data:
+                yield student, component, grade, result_data["Examinationsdatum"]
 
 
 def filter_student_results(student, results):
@@ -132,7 +135,7 @@ def has_credit_transfer(results):
 
 def add_command_options(parser):
     data_parser = parser.add_parser(
-        "data",
+        "course",
         help="Returns course results data in CSV form",
         description="""
   Returns the results in CSV form for all first-time registered students.
@@ -151,6 +154,13 @@ def add_command_options(parser):
         "default is a tab character to be compatible with POSIX commands, "
         "use `-d,` or `-d ,` to get comma-separated values.",
     )
+
+    data_parser.add_argument(
+        "-H",
+        "--header",
+        action="store_true",
+        help="Print a header line with the column names.",
+    )
     data_parser.add_argument(
         "-r",
         "--rounds",
@@ -158,6 +168,13 @@ def add_command_options(parser):
         help="The round codes for the rounds to include, "
         "otherwise all rounds will be included.",
     )
+    data_parser.add_argument(
+        "-n",
+        "--normalize-date",
+        action="store_true",
+        help="Normalize the date to the start of the course, "
+        "otherwise the date is printed as is.",
+    )
     data_parser.add_argument(
         "-t",
         "--time-limit",
@@ -188,7 +205,10 @@ def command(ladok, args):
         ladok.search_course_rounds(code=args.course_code), args.rounds
     )
 
-    data_writer.writerow(["Course", "Round", "Component", "Student", "Grade", "Time"])
+    if args.header:
+        data_writer.writerow(
+            ["Course", "Round", "Component", "Student", "Grade", "Time"]
+        )
     for course_round in course_rounds:
         data = extract_data_for_round(ladok, course_round, args)
 

ladok3/report.nw

@@ -115,11 +115,24 @@ try:
   set_grade(ladok, args,
             student_id, course_code, component_code, grade, date, graders)
 except Exception as err:
-  print(f"{course_code} {component_code}={grade} ({date}) {student_id}: "
+  <<try to resolve [[student]] from [[ladok]] using [[student_id]]>>
+  print(f"{course_code} {component_code}={grade} ({date}) {student}: "
         f"{err}",
         file=sys.stderr)
 @
 
+The reason we want to resolve the student from LADOK is that the [[student_id]] 
+might be a personnummer or a LADOK ID---if the latter, it's not particularly 
+readable for a human and we can't use the LADOK ID in the LADOK web interface 
+when we want to deal with the errors manually.
+But if we resolve the student, then we get a readable name.
+<<try to resolve [[student]] from [[ladok]] using [[student_id]]>>=
+try:
+  student = ladok.get_student(student_id)
+except Exception:
+  student = student_id
+@
+
 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.)
@@ -254,8 +267,10 @@ try:
             args.student_id, args.course_code, args.component_code,
             args.grade, args.date, args.graders)
 except Exception as err:
+  student_id = args.student_id
+  <<try to resolve [[student]] from [[ladok]] using [[student_id]]>>
   print(f"{args.course_code} {args.component_code}={args.grade} ({args.date}) "
-        f"{args.student_id}: {err}",
+        f"{student}: {err}",
         file=sys.stderr)
 @
 

ladok3/report.py

@@ -27,9 +27,14 @@ def report_one_result(ladok, args):
             args.graders,
         )
     except Exception as err:
+        student_id = args.student_id
+        try:
+            student = ladok.get_student(student_id)
+        except Exception:
+            student = student_id
         print(
             f"{args.course_code} {args.component_code}={args.grade} ({args.date}) "
-            f"{args.student_id}: {err}",
+            f"{student}: {err}",
             file=sys.stderr,
         )
 
@@ -49,9 +54,12 @@ def report_many_results(ladok, args):
                 graders,
             )
         except Exception as err:
+            try:
+                student = ladok.get_student(student_id)
+            except Exception:
+                student = student_id
             print(
-                f"{course_code} {component_code}={grade} ({date}) {student_id}: "
-                f"{err}",
+                f"{course_code} {component_code}={grade} ({date}) {student}: " f"{err}",
                 file=sys.stderr,
             )
 

{ladok3-4.19.dist-info → ladok3-5.0.dist-info}/METADATA

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

{ladok3-4.19.dist-info → ladok3-5.0.dist-info}/RECORD

@@ -1,21 +1,21 @@
-doc/ltxobj/ladok3.pdf,sha256=ibiFIK0Vn-_0DokQTYSUmwTAG7deD5Sqb4i-3g3HWRc,2279853
+doc/ltxobj/ladok3.pdf,sha256=5veFT8zO_oUWLCBQVqmwLRWsy3_34dZms1RgitsNzrM,2284649
 ladok3/.gitignore,sha256=QOcCshtjIsFasi4vaqFcooBWPJkxVWaoYEWOBBtdY_w,81
 ladok3/Makefile,sha256=Jy6OFjoVLU9YivnVxctxI_zrUOK9ysEOiistJ3ST6Nw,557
 ladok3/__init__.py,sha256=2ySW9vSJ0joOV5TH9dtK_CAOdk1PByZ7jYfAwQxfAhc,87708
 ladok3/api.nw,sha256=o7ZWO6eplSG3ReS0Y-rzcrLP2yiFVwvQUtg6dPDXG5E,66716
 ladok3/cli.nw,sha256=sA5kevvAWBkzZHZ3UBkPEHoWvPw5yYtGYiPEnWMmjus,22864
 ladok3/cli.py,sha256=6R7B0XVvYFlHcMbv6E73KOeI3ZGQFeQN2-ojz12H1vU,12555
-ladok3/data.nw,sha256=3o6-kmeMtCGoSJ5yL8qFCuIINQeym_WtW_2mhItuR-s,11785
-ladok3/data.py,sha256=kPRO9l5DTQb9lGnN2kU-YYPSyg31t0bq5HCw986hbPk,6747
+ladok3/data.nw,sha256=NddmEnzfgaXZkYyaOLle67MNySy4YKWx4OXMWAOAMkA,12676
+ladok3/data.py,sha256=nLta8ZlSmgRqXZoCbJqtw6KlHH-EyZfImbDcPs74G2U,7324
 ladok3/ladok.bash,sha256=zGfTFdtos2zLjV13pzfK-1uCy2b_lF2qUKMoL2ExW7c,1441
 ladok3/ladok3.nw,sha256=mftysbBD9CLaKD8JgRcSO9KOnjV6koOd2dfmbSSJJi0,55594
-ladok3/report.nw,sha256=B_xZ06r-xCJMi9lIo-oTA6eLnN4Jnci1G_2YJM4-2CQ,9406
-ladok3/report.py,sha256=fTrolQMwaSVQ9_lUdUqRQcj4KKHC_m7S3SUP1lTHU0M,5817
+ladok3/report.nw,sha256=nmyP6TnSYBsMIeG2bdiVQ7LqQN_gEqyEfbDrrOR1afc,10068
+ladok3/report.py,sha256=BDFbTsO2mwFQoCysRnak2VYA3p4RYOnxaU6zamhqbAY,6091
 ladok3/student.nw,sha256=qgJN1IA6oIoI4RsfWsoTaO2yxdtB_y3mBNSmlccoE4Y,4395
 ladok3/student.py,sha256=a3z5dY18UXqxZh4WtEhgsUdHePhRNBiU5GaNNP6LKxI,2178
 ladok3/undoc.nw,sha256=rRAZ8fC44PD2hBDF8TeEg1hyge_-vd-ScRcojRXQycI,19841
-ladok3-4.19.dist-info/LICENSE,sha256=Oe-mWTBQ-MzuA4jGuRDPDxQtMe8SuP_YjSQl7SOtZ7Q,1155
-ladok3-4.19.dist-info/METADATA,sha256=9rhTkRUfmdmEm4pZQfNZAiSi2C4bM9TlZ8DiUrRCc5k,9371
-ladok3-4.19.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-ladok3-4.19.dist-info/entry_points.txt,sha256=pi-KKP5Obo0AyuDjXQUpadS9kIvAY2_5ORhPgEYlJv8,41
-ladok3-4.19.dist-info/RECORD,,
+ladok3-5.0.dist-info/LICENSE,sha256=Oe-mWTBQ-MzuA4jGuRDPDxQtMe8SuP_YjSQl7SOtZ7Q,1155
+ladok3-5.0.dist-info/METADATA,sha256=8R5uIVTEFZfciQhdgCKklOxTAn6x2U7wD3LAPLCjGYs,9370
+ladok3-5.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+ladok3-5.0.dist-info/entry_points.txt,sha256=pi-KKP5Obo0AyuDjXQUpadS9kIvAY2_5ORhPgEYlJv8,41
+ladok3-5.0.dist-info/RECORD,,