ladok3 3.6__py3-none-any.whl → 3.7__py3-none-any.whl

ladok3/__init__.py

@@ -4170,6 +4170,12 @@ class Student(LadokRemoteData):
       courses = self.__courses
 
     return filter_on_keys(courses, **kwargs)
+  @property
+  def suspensions(self):
+    """
+    The list of the students' suspensions.
+    """
+    return self.ladok.get_student_suspensions_JSON(self.ladok_id)["Avstangning"]
 class CourseInstance(LadokRemoteData):
   """Represents a course instance. Must be constructed from at least
   ladok (a LadokSession object),
@@ -4189,10 +4195,10 @@ class CourseInstance(LadokRemoteData):
 
     self.__code = data.pop("Utbildningskod")
     self.__name = data.pop("Benamning")
-    self.__version = data.pop("Versionsnummer")
+    self.__version = data.pop("Versionsnummer", None) 
 
-    self.__credits = data.pop("Omfattning")
-    self.__unit = data.pop("Enhet")
+    self.__credits = data.pop("Omfattning", None)
+    self.__unit = data.pop("Enhet", None)
 
     self.__grade_scale = self.ladok.get_grade_scales(
       id=data.pop("BetygsskalaID"))
@@ -4325,8 +4331,8 @@ class CourseComponent(LadokData):
     else:
       self.__description = description
 
-    self.__credits = kwargs.pop("Omfattning")
-    self.__unit = kwargs.pop("Enhet")
+    self.__credits = kwargs.pop("Omfattning", None)
+    self.__unit = kwargs.pop("Enhet", None)
 
     ladok = kwargs.pop("ladok")
     grade_scale_id = kwargs.pop("BetygsskalaID")
@@ -4382,7 +4388,7 @@ class CourseRegistration(CourseInstance):
 
     # ett Ladok-ID för kursomgången
     self.__round_id = kwargs.pop("UtbildningstillfalleUID")
-    self.__round_code = kwargs.pop("Utbildningstillfalleskod")
+    self.__round_code = kwargs.pop("Utbildningstillfalleskod", None)
 
     dates = kwargs.pop("Studieperiod")
     self.__start = datetime.date.fromisoformat(dates["Startdatum"])
@@ -4409,10 +4415,10 @@ class CourseRegistration(CourseInstance):
     return self.__end
 
   def __str__(self):
-    return f"{self.code} {self.round_code} ({self.start}--{self.end})"
+    return f"{self.code} {self.round_code or ''} ({self.start}--{self.end})"
 
   def __repr__(self):
-    return f"{self.code}:{self.round_code}:{self.start}--{self.end}"
+    return f"{self.code}:{self.round_code or ''}:{self.start}--{self.end}"
 
   def results(self, /, **kwargs):
     """Returns the student's results on the course, filtered on keywords"""
@@ -4595,6 +4601,10 @@ class CourseResult(LadokRemoteData):
     """Returns True if the grade has been attested in LADOK"""
     return self.__attested
 
+  def __str__(self):
+    return f"{self.component} {self.grade} " \
+           f"{self.date}{'*' if not self.attested else ''}"
+
   def push(self):
     if self.__uid:
       try:

ladok3/ladok3.nw

@@ -908,6 +908,24 @@ for course in self.ladok.registrations_JSON(self.ladok_id):
 @
 
 
+\section{Is the student suspended?}
+
+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.
+We never cache this result since we always want the most up-to-date version.
+<<student attribute methods>>=
+@property
+def suspensions(self):
+  """
+  The list of the students' suspensions.
+  """
+  return self.ladok.get_student_suspensions_JSON(self.ladok_id)["Avstangning"]
+@
+
+
 \chapter{Courses}\label{CourseClasses}
 
 We can use the course-related classes as follows.
@@ -1099,15 +1117,20 @@ print(r"\end{minted}")
 
 Now that we have the [[data]] object, we can assign its values to the private 
 attributes.
+We note, however, that some course instances lack both [[Versionsnummer]] and 
+[[Omfattning]].
+It seems like faux courses are created to document when students go on 
+Exchanges.
+These faux courses have a name and code, but no credits or version of syllabus.
 <<assign CourseInstance data to private attributes>>=
 self.__education_id = data.pop("UtbildningUID")
 
 self.__code = data.pop("Utbildningskod")
 self.__name = data.pop("Benamning")
-self.__version = data.pop("Versionsnummer")
+self.__version = data.pop("Versionsnummer", None) 
 
-self.__credits = data.pop("Omfattning")
-self.__unit = data.pop("Enhet")
+self.__credits = data.pop("Omfattning", None)
+self.__unit = data.pop("Enhet", None)
 
 self.__grade_scale = self.ladok.get_grade_scales(
   id=data.pop("BetygsskalaID"))
@@ -1126,6 +1149,10 @@ else:
 The [[CourseComponent]] class will make the attributes available.
 We specify the most interesting ones and let the [[LadokData]] constructor turn 
 the rest into properties as well, so that they are available for the curious.
+
+Turns out that some course components don't have any credits.
+This is probably a consequence of being a component in a course with no 
+credits, \eg one of those faux courses to register exchange studies.
 <<classes>>=
 class CourseComponent(LadokData):
   """Represents a course component of a course registration"""
@@ -1148,8 +1175,8 @@ class CourseComponent(LadokData):
     else:
       self.__description = description
 
-    self.__credits = kwargs.pop("Omfattning")
-    self.__unit = kwargs.pop("Enhet")
+    self.__credits = kwargs.pop("Omfattning", None)
+    self.__unit = kwargs.pop("Enhet", None)
 
     ladok = kwargs.pop("ladok")
     grade_scale_id = kwargs.pop("BetygsskalaID")
@@ -1260,6 +1287,12 @@ def __fetch_participants(self):
 Students register for a course.
 The [[CourseRegistration]] class represents this data from LADOK.
 This is the object that must be used to get results for a student.
+This object keeps more info than the course instance.
+
+We note that some registrations lack the \enquote{Utbildningstillfalleskod} 
+attribute.
+This happens on \enquote{custom courses} like Erasmus exchanges.
+If that's the case, we use the value [[None]] in its place.
 <<classes>>=
 class CourseRegistration(CourseInstance):
   """Represents a student's participation in a course instance"""
@@ -1268,7 +1301,7 @@ class CourseRegistration(CourseInstance):
 
     # ett Ladok-ID för kursomgången
     self.__round_id = kwargs.pop("UtbildningstillfalleUID")
-    self.__round_code = kwargs.pop("Utbildningstillfalleskod")
+    self.__round_code = kwargs.pop("Utbildningstillfalleskod", None)
 
     dates = kwargs.pop("Studieperiod")
     self.__start = datetime.date.fromisoformat(dates["Startdatum"])
@@ -1295,10 +1328,10 @@ class CourseRegistration(CourseInstance):
     return self.__end
 
   def __str__(self):
-    return f"{self.code} {self.round_code} ({self.start}--{self.end})"
+    return f"{self.code} {self.round_code or ''} ({self.start}--{self.end})"
 
   def __repr__(self):
-    return f"{self.code}:{self.round_code}:{self.start}--{self.end}"
+    return f"{self.code}:{self.round_code or ''}:{self.start}--{self.end}"
 
   def results(self, /, **kwargs):
     """Returns the student's results on the course, filtered on keywords"""
@@ -1444,6 +1477,10 @@ class CourseResult(LadokRemoteData):
     """Returns True if the grade has been attested in LADOK"""
     return self.__attested
 
+  def __str__(self):
+    return f"{self.component} {self.grade} " \
+           f"{self.date}{'*' if not self.attested else ''}"
+
   def push(self):
     if self.__uid:
       <<push the existing CourseResult grade data to LADOK>>

ladok3/student.nw

@@ -79,6 +79,7 @@ except Exception as err:
 print_student_data(student)
 
 if args.course:
+  print()
   print_course_data(student, args.course)
 @
 
@@ -94,16 +95,20 @@ 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}")
 @
 
 \subsection{Printing student's course data}
 
 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.
 <<functions>>=
 def print_course_data(student, course):
   """Prints the courses"""
   print("Courses:")
   for course in student.courses(code=course):
-    print(f"- {course}")
+    print(f"{course}")
+    for result in course.results():
+      print(f"  {result}")
 @

ladok3/student.py

@@ -8,11 +8,14 @@ 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}")
 def print_course_data(student, course):
   """Prints the courses"""
   print("Courses:")
   for course in student.courses(code=course):
-    print(f"- {course}")
+    print(f"{course}")
+    for result in course.results():
+      print(f"  {result}")
 
 def add_command_options(parser):
   student_parser = parser.add_parser("student",
@@ -42,4 +45,5 @@ def command(ladok, args):
   print_student_data(student)
 
   if args.course:
+    print()
     print_course_data(student, args.course)

{ladok3-3.6.dist-info → ladok3-3.7.dist-info}/METADATA

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

{ladok3-3.6.dist-info → ladok3-3.7.dist-info}/RECORD

@@ -1,7 +1,7 @@
-doc/ltxobj/ladok3.pdf,sha256=LlhF8hsKD_CtUqiNccSy6VTg3xNNl54DDh9-zzD0bG8,1320856
+doc/ltxobj/ladok3.pdf,sha256=icIbzJ8YAOai3DhC7XrIMphm7LGkclZHwxGzPl3u_-E,1334876
 ladok3/.gitignore,sha256=QOcCshtjIsFasi4vaqFcooBWPJkxVWaoYEWOBBtdY_w,81
 ladok3/Makefile,sha256=Jy6OFjoVLU9YivnVxctxI_zrUOK9ysEOiistJ3ST6Nw,557
-ladok3/__init__.py,sha256=I7O5jFFAlco4rHmgUzJoHq_nZ-MhTVwE5n03s8ikZvE,228517
+ladok3/__init__.py,sha256=bdFgx0CHaosa5hDqmLbIGjq6IoVHkXqO--yaIpuOOGU,228872
 ladok3/api.nw,sha256=xCPoCQRMgvChbep_l6PFS9c-Ua4NpdK_cgcWr_diizc,43238
 ladok3/cli.nw,sha256=na0B80ll4Ocz7jOYj6ztehCHlPasPB212d6m_4LBOmk,20472
 ladok3/cli.py,sha256=8qZGIxGQ4WLOciZIRf34bGvU0KS9pFyr0zUymuoSCA8,10321
@@ -9,15 +9,15 @@ ladok3/data.nw,sha256=3o6-kmeMtCGoSJ5yL8qFCuIINQeym_WtW_2mhItuR-s,11785
 ladok3/data.py,sha256=mCHySFtQL_oh6mkfMbgRM4T1bnM8HR45eumgoKFwomk,5893
 ladok3/kth.py,sha256=aoodYd2bLQcPNQiFwyP0mppJO399UcqUgUhN9wzVwBA,3720
 ladok3/ladok.bash,sha256=zGfTFdtos2zLjV13pzfK-1uCy2b_lF2qUKMoL2ExW7c,1441
-ladok3/ladok3.nw,sha256=iWeQwilaGL1y_b9EF8rFANm5wvw5wNaKtOnx4Af1LkE,48653
+ladok3/ladok3.nw,sha256=UoiEJAIihPNrHuMHWjoNoz7pl2hDEkziGE3B6X6zbk0,50144
 ladok3/report.nw,sha256=_PUV9Qrg1aUuxiqcQg3VNOApOY3oDdTEJSCOdRiluyc,7303
 ladok3/report.py,sha256=rNCIiPTd9egw8iXSSKsmyrcF3NebqinpuRxfphcyIjo,4082
-ladok3/student.nw,sha256=7ErLwgyAVjzwDn6sqBf7bUXxl1EuQkjMaZUBfQxg9JU,3194
-ladok3/student.py,sha256=qO7-MLoCeYcvhvRsy7EnINXeyHPiCod7yAGpnLRI6VE,1410
+ladok3/student.nw,sha256=RFS3Uo-l_dYsmm41Psh4EPO3LpJQ2ipDSLBsFhlkTco,3356
+ladok3/student.py,sha256=3YRf6WXimFBusH-sBiWKJhEJ_W-qfzqVPox2sLJNFCI,1531
 ladok3/test.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ladok3/undoc.nw,sha256=NyHuVIzrRqJPM39MyAlZNEE7PbXdUDJFQ2kJ0NfdwQI,180333
-ladok3-3.6.dist-info/LICENSE,sha256=s_C5qznXAvDRrzU7vRd4eqzshyIkAfPwGyVBihGeOdM,1155
-ladok3-3.6.dist-info/METADATA,sha256=4N5XD6hdyuwWz3cUIjFF5awQ5x7aOyIalXQLRfdcV3o,8098
-ladok3-3.6.dist-info/WHEEL,sha256=kLuE8m1WYU0Ig0_YEGrXyTtiJvKPpLpDEiChiNyei5Y,88
-ladok3-3.6.dist-info/entry_points.txt,sha256=pi-KKP5Obo0AyuDjXQUpadS9kIvAY2_5ORhPgEYlJv8,41
-ladok3-3.6.dist-info/RECORD,,
+ladok3-3.7.dist-info/LICENSE,sha256=s_C5qznXAvDRrzU7vRd4eqzshyIkAfPwGyVBihGeOdM,1155
+ladok3-3.7.dist-info/METADATA,sha256=Jelc3ichBPu0MfSaO58NbteMHOAuenpMG4Z6-X95NEc,8098
+ladok3-3.7.dist-info/WHEEL,sha256=kLuE8m1WYU0Ig0_YEGrXyTtiJvKPpLpDEiChiNyei5Y,88
+ladok3-3.7.dist-info/entry_points.txt,sha256=pi-KKP5Obo0AyuDjXQUpadS9kIvAY2_5ORhPgEYlJv8,41
+ladok3-3.7.dist-info/RECORD,,