ladok3 4.16__py3-none-any.whl → 4.18__py3-none-any.whl

ladok3/ladok3.nw

@@ -57,6 +57,17 @@ ladok = ladok3.LadokSession("KTH Royal Institute of Technology",
                             test_environment=True) # for experiments
 \end{minted}
 
+Yet another way is to use the [[ladok]] command's own credential store.
+\begin{minted}[linenos]{python}
+import ladok3
+import ladok3.cli
+
+ladok = ladok3.LadokSession(*ladok3.cli.load_credentials(),
+                            test_environment=True) # for experiments
+\end{minted}
+Just note that unpacking [[*]] to unpack the tuple that [[load_credentials]] 
+returns.
+
 This chapter covers how the [[LadokSession]] class work.
 The remaining chapters cover what the [[ladok]] object can be used for.
 \Cref{StudentClasses} covers how we can work with student data.
@@ -923,9 +934,62 @@ for course in self.ladok.registrations_JSON(self.ladok_id):
 
 We also want to know if a student is suspended or not.
 We can get a list of suspensions for a student.
-However, since suspended students are rare, we haven't found a specimen to 
-study; so we simply don't know what the list contains.
-But we can return it nonetheless.
+This list looks like this:
+\begin{minted}{json}
+[
+  {"Anteckning": "VJ-2024-...",
+   "Giltighetsperiod": {"Slutdatum": "2024-12-03",
+                        "Startdatum": "2024-09-25", "link": []},
+   "LarosateID": 29,
+   "OrsakID": 101450,
+   "SenastAndradAv": "someone@kth.se",
+   "SenastSparad": "2024-09-24T16:45:56.941",
+   "StudentUID": "...",
+   "Uid": "...",
+   "link": [{"method": "GET",
+             "uri": "https://api.ladok.se:443/studentinformation/internal/avstangning/...", 
+             "mediaType": "application/vnd.ladok+xml",
+             "rel": "self"}]
+  }
+]
+\end{minted}
+Let's make a class for this.
+<<classes>>=
+class Suspension(LadokData):
+  """A suspension"""
+  def __init__(self, /, **kwargs):
+    super().__init__(**kwargs)
+    self.__note = kwargs.pop("Anteckning")
+    self.__validity = (
+      datetime.date.fromisoformat(kwargs["Giltighetsperiod"]["Startdatum"]),
+      datetime.date.fromisoformat(kwargs["Giltighetsperiod"]["Slutdatum"])
+    )
+
+  @property
+  def note(self):
+    """
+    The note of the suspension. This is usually a case number.
+    """
+    return self.__note
+
+  @property
+  def validity(self):
+    """
+    A tuple (start, end) of the validity period of the suspension.
+    """
+    return self.__validity
+
+  @property
+  def is_current(self):
+    """
+    Is True if the suspension is currently valid.
+    """
+    return self.validity[0] <= datetime.date.today() <= self.validity[1]
+
+  def __str__(self):
+    return f"{self.validity[0]}--{self.validity[1]}"
+@
+
 We never cache this result since we always want the most up-to-date version.
 <<student attribute methods>>=
 @property
@@ -933,7 +997,9 @@ def suspensions(self):
   """
   The list of the students' suspensions.
   """
-  return self.ladok.get_student_suspensions_JSON(self.ladok_id)["Avstangning"]
+  suspensions = self.ladok.get_student_suspensions_JSON(
+                                            self.ladok_id)["Avstangning"]
+  return [Suspension(**suspension) for suspension in suspensions]
 @
 
 

ladok3/report.nw

@@ -163,7 +163,7 @@ error message.
 try:
   course = student.courses(code=args.course_code)[0]
 except IndexError:
-  raise Exception("f{args.course_code}: No such course for {student}")
+  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]

ladok3/report.py

@@ -19,7 +19,7 @@ def report_one_result(ladok, args):
         try:
             course = student.courses(code=args.course_code)[0]
         except IndexError:
-            raise Exception("f{args.course_code}: No such course for {student}")
+            raise Exception(f"{args.course_code}: No such course for {student}")
         try:
             result = course.results(component=args.component_code)[0]
         except IndexError:

ladok3/student.nw

@@ -106,9 +106,28 @@ def print_student_data(student):
   print(f"Personnummer: {student.personnummer}")
   print(f"LADOK ID:     {student.ladok_id}")
   print(f"Alive:        {student.alive}")
-  print(f"Suspended:    {student.suspensions}")
+  <<print info about suspensions for [[student]]>>
 @
 
+We want to print whether the student is currently suspended or not.
+We want to make this really clear.
+<<print info about suspensions for [[student]]>>=
+print(f"Suspended:    ", end="")
+if any(map(lambda x: x.is_current, student.suspensions)):
+  print("YES")
+else:
+  print("no")
+@ Then we also want to print all the times the student has been suspended.
+We only want to print this if the student has been suspended at least once.
+<<print info about suspensions for [[student]]>>=
+if student.suspensions:
+  print(f"Suspenions:   ", end="")
+  for suspension in student.suspensions:
+    print(f"{suspension}", end="\n              ")
+  print()
+@
+
+
 \subsection{Printing student's course data}
 
 To print the student's course data, we simply filter the courses on the option 

ladok3/student.py

@@ -1,54 +1,75 @@
 import csv
 import ladok3.cli
 
+
 def print_student_data(student):
-  """Prints the student data, all attributes, to stdout."""
-  print(f"First name:   {student.first_name}")
-  print(f"Last name:    {student.last_name}")
-  print(f"Personnummer: {student.personnummer}")
-  print(f"LADOK ID:     {student.ladok_id}")
-  print(f"Alive:        {student.alive}")
-  print(f"Suspended:    {student.suspensions}")
+    """Prints the student data, all attributes, to stdout."""
+    print(f"First name:   {student.first_name}")
+    print(f"Last name:    {student.last_name}")
+    print(f"Personnummer: {student.personnummer}")
+    print(f"LADOK ID:     {student.ladok_id}")
+    print(f"Alive:        {student.alive}")
+    print(f"Suspended:    ", end="")
+    if any(map(lambda x: x.is_current, student.suspensions)):
+        print("YES")
+    else:
+        print("no")
+    if student.suspensions:
+        print(f"Suspenions:   ", end="")
+        for suspension in student.suspensions:
+            print(f"{suspension}", end="\n              ")
+        print()
+
+
 def print_course_data(student, args):
-  """Prints the courses"""
-  print("Courses:")
-  for course in student.courses(code=args.course):
-    print(f"{course}")
-    if args.results:
-      for result in course.results():
-        print(f"  {result}")
+    """Prints the courses"""
+    print("Courses:")
+    for course in student.courses(code=args.course):
+        print(f"{course}")
+        if args.results:
+            for result in course.results():
+                print(f"  {result}")
+
 
 def add_command_options(parser):
-  student_parser = parser.add_parser("student",
-    help="Shows a student's information in LADOK",
-    description="""
+    student_parser = parser.add_parser(
+        "student",
+        help="Shows a student's information in LADOK",
+        description="""
     Show a student's information in LADOK.
     Shows information like name, personnummer, contact information.
-    """
-  )
-  student_parser.set_defaults(func=command)
-  student_parser.add_argument("id",
-    help="The student's ID, either personnummer or LADOK ID"
-  )
-  student_parser.add_argument("-c", "--course",
-    nargs="?", const=".*",
-    help="A regular expression for which course codes to list, " \
-      "use no value for listing all courses."
-  )
-  student_parser.add_argument("-r", "--results",
-    action="store_true", default=False,
-    help="Set to include results for each course listed."
-  )
+    """,
+    )
+    student_parser.set_defaults(func=command)
+    student_parser.add_argument(
+        "id", help="The student's ID, either personnummer or LADOK ID"
+    )
+    student_parser.add_argument(
+        "-c",
+        "--course",
+        nargs="?",
+        const=".*",
+        help="A regular expression for which course codes to list, "
+        "use no value for listing all courses.",
+    )
+    student_parser.add_argument(
+        "-r",
+        "--results",
+        action="store_true",
+        default=False,
+        help="Set to include results for each course listed.",
+    )
+
 
 def command(ladok, args):
-  try:
-    student = ladok.get_student(args.id)
-    student.alive
-  except Exception as err:
-    ladok3.cli.err(-1, f"can't fetch student data for {args.id}: {err}")
+    try:
+        student = ladok.get_student(args.id)
+        student.alive
+    except Exception as err:
+        ladok3.cli.err(-1, f"can't fetch student data for {args.id}: {err}")
 
-  print_student_data(student)
+    print_student_data(student)
 
-  if args.course:
-    print()
-    print_course_data(student, args)
+    if args.course:
+        print()
+        print_course_data(student, args)