usos-api 0.4.0__tar.gz → 0.5.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {usos_api-0.4.0 → usos_api-0.5.0}/PKG-INFO +2 -2
- {usos_api-0.4.0 → usos_api-0.5.0}/pyproject.toml +1 -1
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/client.py +3 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/helper.py +1 -2
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/models/__init__.py +51 -1
- usos_api-0.5.0/usos_api/models/exam_report.py +265 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/models/grade.py +18 -4
- usos_api-0.5.0/usos_api/models/programme.py +61 -0
- usos_api-0.5.0/usos_api/models/usos_bool.py +18 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/services/__init__.py +2 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/services/exam_reports.py +145 -244
- usos_api-0.5.0/usos_api/services/programmes.py +47 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/uv.lock +1 -1
- usos_api-0.4.0/usos_api/models/programme.py +0 -34
- {usos_api-0.4.0 → usos_api-0.5.0}/.github/workflows/publish.yml +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/.gitignore +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/.readthedocs.yaml +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/README.md +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/docs/Makefile +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/docs/conf.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/docs/full-docs.rst +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/docs/index.rst +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/docs/make.bat +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/docs/quickstart.rst +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/run.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/__init__.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/auth.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/connection.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/exceptions.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/logger.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/models/api_documentation.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/models/consumer.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/models/course.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/models/group.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/models/lang_dict.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/models/registration.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/models/term.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/models/user.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/services/api_documentation.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/services/api_server.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/services/courses.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/services/grades.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/services/groups.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/services/registrations.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/services/terms.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/services/users.py +0 -0
- {usos_api-0.4.0 → usos_api-0.5.0}/usos_api/utils/__init__.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
2
|
Name: usos-api
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.5.0
|
|
4
4
|
Summary: Asynchronous USOS API for Python
|
|
5
5
|
Project-URL: Homepage, https://github.com/Antoni-Czaplicki/usos-api
|
|
6
6
|
Project-URL: Repository, https://github.com/Antoni-Czaplicki/usos-api
|
|
@@ -10,6 +10,7 @@ from .services import (
|
|
|
10
10
|
ExamReportService,
|
|
11
11
|
GradeService,
|
|
12
12
|
GroupService,
|
|
13
|
+
ProgrammeService,
|
|
13
14
|
RegistrationService,
|
|
14
15
|
TermService,
|
|
15
16
|
UserService,
|
|
@@ -31,6 +32,7 @@ class USOSClient:
|
|
|
31
32
|
:var GradeService grade_service: The grade service.
|
|
32
33
|
:var ExamReportService exam_report_service: The exam report service.
|
|
33
34
|
:var RegistrationService registration_service: The registration service.
|
|
35
|
+
:var ProgrammeService programme_service: The programme service.
|
|
34
36
|
|
|
35
37
|
:ivar USOSAPIConnection connection: The connection to the USOS API, used for making requests.
|
|
36
38
|
"""
|
|
@@ -62,6 +64,7 @@ class USOSClient:
|
|
|
62
64
|
self.api_server_service = APIServerService(self.connection)
|
|
63
65
|
self.api_documentation_service = APIDocumentationService(self.connection)
|
|
64
66
|
self.registration_service = RegistrationService(self.connection)
|
|
67
|
+
self.programme_service = ProgrammeService(self.connection)
|
|
65
68
|
|
|
66
69
|
self.helper = APIHelper(self)
|
|
67
70
|
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
from typing import TYPE_CHECKING, List
|
|
2
2
|
|
|
3
|
-
from usos_api.models import CourseEdition, Grade
|
|
3
|
+
from usos_api.models import CourseEdition, Grade, UserExamReportsByTerm
|
|
4
4
|
from usos_api.services.courses import CourseEctsByTerm
|
|
5
|
-
from usos_api.services.exam_reports import UserExamReportsByTerm
|
|
6
5
|
|
|
7
6
|
if TYPE_CHECKING:
|
|
8
7
|
from usos_api import USOSClient
|
|
@@ -16,10 +16,35 @@ from .course import (
|
|
|
16
16
|
CourseEditionConducted,
|
|
17
17
|
CourseUnit,
|
|
18
18
|
)
|
|
19
|
+
from .exam_report import (
|
|
20
|
+
ExamReport,
|
|
21
|
+
ExamReport2,
|
|
22
|
+
ExamReport2ClassGroup,
|
|
23
|
+
ExamReport2Session,
|
|
24
|
+
ExamReport2StudentGrade,
|
|
25
|
+
ExamReport2UserGrade,
|
|
26
|
+
ExamReportCourse,
|
|
27
|
+
ExamReportCourseUnit,
|
|
28
|
+
ExamReportGradeDistributionItem,
|
|
29
|
+
ExamReportIssuerGrade,
|
|
30
|
+
ExamReportSessionAccess,
|
|
31
|
+
ExamReportType,
|
|
32
|
+
ExternalObject,
|
|
33
|
+
ExamReportSession,
|
|
34
|
+
GradeType,
|
|
35
|
+
GradeValue,
|
|
36
|
+
LegacyCourseEditionExamReport,
|
|
37
|
+
LegacyUserExamReportsByTerm,
|
|
38
|
+
RawUserExamReportsByTerm,
|
|
39
|
+
UserExamReportsByTerm,
|
|
40
|
+
parse_legacy_course_edition_exam_report,
|
|
41
|
+
parse_legacy_user_exam_reports,
|
|
42
|
+
parse_user_exam_reports,
|
|
43
|
+
)
|
|
19
44
|
from .grade import Grade
|
|
20
45
|
from .group import Group
|
|
21
46
|
from .lang_dict import LangDict
|
|
22
|
-
from .programme import Programme, StudentProgramme
|
|
47
|
+
from .programme import Faculty, Programme, ProgrammeStage, StudentProgramme
|
|
23
48
|
from .registration import (
|
|
24
49
|
CoursesCart,
|
|
25
50
|
Link,
|
|
@@ -64,6 +89,8 @@ __all__ = [
|
|
|
64
89
|
"ExternalIds",
|
|
65
90
|
"StudentProgramme",
|
|
66
91
|
"Programme",
|
|
92
|
+
"ProgrammeStage",
|
|
93
|
+
"Faculty",
|
|
67
94
|
"Sex",
|
|
68
95
|
"LangDict",
|
|
69
96
|
"CourseAttribute",
|
|
@@ -72,9 +99,32 @@ __all__ = [
|
|
|
72
99
|
"Grade",
|
|
73
100
|
"Course",
|
|
74
101
|
"CourseEditionConducted",
|
|
102
|
+
"ExternalObject",
|
|
103
|
+
"ExamReport2",
|
|
104
|
+
"ExamReport2ClassGroup",
|
|
105
|
+
"ExamReport2Session",
|
|
106
|
+
"ExamReport2StudentGrade",
|
|
107
|
+
"ExamReport2UserGrade",
|
|
108
|
+
"ExamReport",
|
|
109
|
+
"ExamReportCourse",
|
|
110
|
+
"ExamReportCourseUnit",
|
|
111
|
+
"ExamReportGradeDistributionItem",
|
|
112
|
+
"ExamReportIssuerGrade",
|
|
113
|
+
"ExamReportSession",
|
|
114
|
+
"ExamReportSessionAccess",
|
|
115
|
+
"ExamReportType",
|
|
116
|
+
"GradeType",
|
|
117
|
+
"GradeValue",
|
|
75
118
|
"Term",
|
|
76
119
|
"Consumer",
|
|
77
120
|
"CourseUnit",
|
|
121
|
+
"UserExamReportsByTerm",
|
|
122
|
+
"RawUserExamReportsByTerm",
|
|
123
|
+
"LegacyUserExamReportsByTerm",
|
|
124
|
+
"LegacyCourseEditionExamReport",
|
|
125
|
+
"parse_user_exam_reports",
|
|
126
|
+
"parse_legacy_user_exam_reports",
|
|
127
|
+
"parse_legacy_course_edition_exam_report",
|
|
78
128
|
"AuthOptions",
|
|
79
129
|
"Argument",
|
|
80
130
|
"ResultField",
|
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
from datetime import datetime
|
|
2
|
+
from typing import Any, Mapping, TypeAlias
|
|
3
|
+
|
|
4
|
+
from pydantic import BaseModel, ConfigDict, field_validator
|
|
5
|
+
|
|
6
|
+
from .lang_dict import LangDict
|
|
7
|
+
from .usos_bool import USOSBool
|
|
8
|
+
from .user import User
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class ExternalObject(BaseModel):
|
|
12
|
+
model_config = ConfigDict(extra="allow")
|
|
13
|
+
|
|
14
|
+
id: str | int | None = None
|
|
15
|
+
name: LangDict | str | None = None
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class GradeValue(BaseModel):
|
|
19
|
+
grade_type: ExternalObject | None = None
|
|
20
|
+
order_key: str | int | None = None
|
|
21
|
+
symbol: str | None = None
|
|
22
|
+
passes: USOSBool | None = None
|
|
23
|
+
decimal_value: float | None = None
|
|
24
|
+
name: LangDict | None = None
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
class GradeType(BaseModel):
|
|
28
|
+
id: str | None = None
|
|
29
|
+
name: LangDict | None = None
|
|
30
|
+
values: list[GradeValue] | None = None
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
class ExamReportType(BaseModel):
|
|
34
|
+
id: str | None = None
|
|
35
|
+
name: LangDict | None = None
|
|
36
|
+
grade_type: GradeType | None = None
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
class ExamReport2StudentGrade(BaseModel):
|
|
40
|
+
grade_value: GradeValue | None = None
|
|
41
|
+
comment: str | None = None
|
|
42
|
+
private_comment: str | None = None
|
|
43
|
+
user: ExternalObject | None = None
|
|
44
|
+
grader: ExternalObject | None = None
|
|
45
|
+
last_updated: datetime | None = None
|
|
46
|
+
is_editable: USOSBool | None = None
|
|
47
|
+
resignation: USOSBool | None = None
|
|
48
|
+
inactive_links: USOSBool | None = None
|
|
49
|
+
why_cannot_edit: str | None = None
|
|
50
|
+
date_acquisition: datetime | None = None
|
|
51
|
+
examrep_session: ExternalObject | None = None
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
class ExamReport2UserGrade(BaseModel):
|
|
55
|
+
grade_value: GradeValue | None = None
|
|
56
|
+
comment: str | None = None
|
|
57
|
+
user: ExternalObject | None = None
|
|
58
|
+
grader: ExternalObject | None = None
|
|
59
|
+
last_updated: datetime | None = None
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
def grades_by_user(value: Any) -> dict[str, ExamReport2StudentGrade] | None:
|
|
63
|
+
if value is None or isinstance(value, dict):
|
|
64
|
+
return value
|
|
65
|
+
if isinstance(value, list):
|
|
66
|
+
parsed_grades: dict[str, ExamReport2StudentGrade] = {}
|
|
67
|
+
for index, raw_grade in enumerate(value):
|
|
68
|
+
grade = ExamReport2StudentGrade.model_validate(raw_grade)
|
|
69
|
+
user_id = grade.user.id if grade.user is not None else None
|
|
70
|
+
parsed_grades[str(user_id if user_id is not None else index)] = grade
|
|
71
|
+
return parsed_grades
|
|
72
|
+
raise ValueError("Expected grade dictionary, grade list or None.")
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
class ExamReport2Session(BaseModel):
|
|
76
|
+
examrep_id: str | int | None = None
|
|
77
|
+
number: int | None = None
|
|
78
|
+
status: str | None = None
|
|
79
|
+
description: LangDict | None = None
|
|
80
|
+
deadline: datetime | None = None
|
|
81
|
+
is_open: USOSBool | None = None
|
|
82
|
+
is_acquisition_date_required: USOSBool | None = None
|
|
83
|
+
all_grades: dict[str, ExamReport2StudentGrade] | None = None
|
|
84
|
+
issuer_grade: ExamReport2UserGrade | None = None
|
|
85
|
+
read_access: list[ExternalObject] | None = None
|
|
86
|
+
write_access: list[ExternalObject] | None = None
|
|
87
|
+
|
|
88
|
+
@field_validator("all_grades", mode="before")
|
|
89
|
+
@classmethod
|
|
90
|
+
def _parse_all_grades(
|
|
91
|
+
cls, value: Any
|
|
92
|
+
) -> dict[str, ExamReport2StudentGrade] | None:
|
|
93
|
+
return grades_by_user(value)
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
class ExamReport2(BaseModel):
|
|
97
|
+
id: str | int | None = None
|
|
98
|
+
description: LangDict | None = None
|
|
99
|
+
counts_into_average: USOSBool | None = None
|
|
100
|
+
grade_type: GradeType | None = None
|
|
101
|
+
is_general_report: USOSBool | None = None
|
|
102
|
+
sessions: list[ExamReport2Session] | None = None
|
|
103
|
+
edit_access: list[ExternalObject] | None = None
|
|
104
|
+
course_edition: ExternalObject | None = None
|
|
105
|
+
course_unit: ExternalObject | None = None
|
|
106
|
+
active_sessions: list[ExamReport2Session] | None = None
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
class ExamReportSessionAccess(BaseModel):
|
|
110
|
+
cause: str | None = None
|
|
111
|
+
groups: list[ExternalObject] | None = None
|
|
112
|
+
exam_groups: list[ExternalObject] | None = None
|
|
113
|
+
unassigned: USOSBool | None = None
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
class ExamReport2ClassGroup(BaseModel):
|
|
117
|
+
class_group: ExternalObject | None = None
|
|
118
|
+
grades: dict[str, ExamReport2StudentGrade] | None = None
|
|
119
|
+
|
|
120
|
+
@field_validator("grades", mode="before")
|
|
121
|
+
@classmethod
|
|
122
|
+
def _parse_grades(cls, value: Any) -> dict[str, ExamReport2StudentGrade] | None:
|
|
123
|
+
return grades_by_user(value)
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
class ExamReportCourse(BaseModel):
|
|
127
|
+
id: str | None = None
|
|
128
|
+
name: LangDict | None = None
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
class ExamReportCourseUnit(BaseModel):
|
|
132
|
+
id: str | None = None
|
|
133
|
+
course_id: str | None = None
|
|
134
|
+
course_name: LangDict | None = None
|
|
135
|
+
classtype_id: str | None = None
|
|
136
|
+
term_id: str | None = None
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
class ExamReportGradeDistributionItem(BaseModel):
|
|
140
|
+
grade_symbol: str | None = None
|
|
141
|
+
percentage: float | None = None
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
class ExamReportIssuerGrade(BaseModel):
|
|
145
|
+
value_symbol: str | None = None
|
|
146
|
+
passes: USOSBool | None = None
|
|
147
|
+
value_description: LangDict | None = None
|
|
148
|
+
exam_id: str | int | None = None
|
|
149
|
+
exam_session_number: int | None = None
|
|
150
|
+
counts_into_average: USOSBool | None = None
|
|
151
|
+
comment: str | None = None
|
|
152
|
+
private_comment: str | None = None
|
|
153
|
+
grade_type_id: str | None = None
|
|
154
|
+
date_modified: datetime | None = None
|
|
155
|
+
date_acquisition: datetime | None = None
|
|
156
|
+
modification_author: User | None = None
|
|
157
|
+
|
|
158
|
+
@field_validator("modification_author", mode="before")
|
|
159
|
+
@classmethod
|
|
160
|
+
def _parse_modification_author(cls, value: Any) -> User | None:
|
|
161
|
+
if value is None or isinstance(value, User):
|
|
162
|
+
return value
|
|
163
|
+
if isinstance(value, dict):
|
|
164
|
+
return User.model_validate(value)
|
|
165
|
+
if isinstance(value, str | int):
|
|
166
|
+
return User(id=value)
|
|
167
|
+
raise ValueError("Expected user object, user id or None.")
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
class ExamReportSession(BaseModel):
|
|
171
|
+
number: int | None = None
|
|
172
|
+
examrep_id: str | int | None = None
|
|
173
|
+
status: str | None = None
|
|
174
|
+
description: LangDict | None = None
|
|
175
|
+
deadline: datetime | None = None
|
|
176
|
+
is_editable: USOSBool | None = None
|
|
177
|
+
issuer_grades: list[ExamReportIssuerGrade] | None = None
|
|
178
|
+
|
|
179
|
+
@field_validator("issuer_grades", mode="before")
|
|
180
|
+
@classmethod
|
|
181
|
+
def _parse_issuer_grades(cls, value: Any) -> list[Any] | None:
|
|
182
|
+
if value is None or isinstance(value, list):
|
|
183
|
+
return value
|
|
184
|
+
if isinstance(value, dict):
|
|
185
|
+
return [value]
|
|
186
|
+
raise ValueError("Expected issuer grade object, issuer grade list or None.")
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
class ExamReport(BaseModel):
|
|
190
|
+
id: str | int | None = None
|
|
191
|
+
description: LangDict | None = None
|
|
192
|
+
type_id: str | None = None
|
|
193
|
+
type_description: LangDict | None = None
|
|
194
|
+
counts_into_average: USOSBool | None = None
|
|
195
|
+
term_id: str | None = None
|
|
196
|
+
is_editable: USOSBool | None = None
|
|
197
|
+
course_unit: ExamReportCourseUnit | None = None
|
|
198
|
+
course: ExamReportCourse | None = None
|
|
199
|
+
sessions: list[ExamReportSession] | None = None
|
|
200
|
+
grades_distribution: list[ExamReportGradeDistributionItem] | None = None
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
UserExamReportsByTerm: TypeAlias = dict[str, dict[str, list[ExamReport]]]
|
|
204
|
+
RawUserExamReportsByTerm: TypeAlias = dict[str, dict[str, list[dict[str, Any]]]]
|
|
205
|
+
LegacyUserExamReportsByTerm: TypeAlias = dict[
|
|
206
|
+
str, dict[str, dict[str, list[ExamReport]]]
|
|
207
|
+
]
|
|
208
|
+
LegacyCourseEditionExamReport: TypeAlias = dict[
|
|
209
|
+
str, ExamReport | list[ExamReport] | dict[str, list[ExamReport]] | None
|
|
210
|
+
]
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
def parse_user_exam_reports(
|
|
214
|
+
reports_by_term: Mapping[str, Mapping[str, list[Mapping[str, Any]]]],
|
|
215
|
+
) -> UserExamReportsByTerm:
|
|
216
|
+
return {
|
|
217
|
+
term_id: {
|
|
218
|
+
course_id: [ExamReport.model_validate(report) for report in reports]
|
|
219
|
+
for course_id, reports in courses.items()
|
|
220
|
+
}
|
|
221
|
+
for term_id, courses in reports_by_term.items()
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
def parse_legacy_user_exam_reports(
|
|
226
|
+
reports_by_term: Mapping[
|
|
227
|
+
str, Mapping[str, Mapping[str, list[Mapping[str, Any]]]]
|
|
228
|
+
],
|
|
229
|
+
) -> LegacyUserExamReportsByTerm:
|
|
230
|
+
return {
|
|
231
|
+
term_id: {
|
|
232
|
+
course_id: {
|
|
233
|
+
group_id: [ExamReport.model_validate(report) for report in reports]
|
|
234
|
+
for group_id, reports in groups.items()
|
|
235
|
+
}
|
|
236
|
+
for course_id, groups in courses.items()
|
|
237
|
+
}
|
|
238
|
+
for term_id, courses in reports_by_term.items()
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
def parse_legacy_course_edition_exam_report(
|
|
243
|
+
exam_report_data: Mapping[str, Any],
|
|
244
|
+
) -> LegacyCourseEditionExamReport:
|
|
245
|
+
return {
|
|
246
|
+
key: _parse_legacy_course_edition_value(value)
|
|
247
|
+
for key, value in exam_report_data.items()
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
def _parse_legacy_course_edition_value(
|
|
252
|
+
value: Any,
|
|
253
|
+
) -> ExamReport | list[ExamReport] | dict[str, list[ExamReport]] | None:
|
|
254
|
+
if value is None:
|
|
255
|
+
return None
|
|
256
|
+
if isinstance(value, list):
|
|
257
|
+
return [ExamReport.model_validate(report) for report in value]
|
|
258
|
+
if isinstance(value, dict):
|
|
259
|
+
if all(isinstance(reports, list) for reports in value.values()):
|
|
260
|
+
return {
|
|
261
|
+
group_id: [ExamReport.model_validate(report) for report in reports]
|
|
262
|
+
for group_id, reports in value.items()
|
|
263
|
+
}
|
|
264
|
+
return ExamReport.model_validate(value)
|
|
265
|
+
raise ValueError("Expected exam report object, exam report list, mapping or None.")
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
from datetime import datetime
|
|
2
2
|
from typing import TYPE_CHECKING, Any, Optional
|
|
3
3
|
|
|
4
|
-
from pydantic import BaseModel
|
|
4
|
+
from pydantic import BaseModel, field_validator
|
|
5
5
|
|
|
6
6
|
from . import CourseEdition
|
|
7
7
|
from .course import CourseUnit
|
|
8
|
+
from .usos_bool import USOSBool
|
|
8
9
|
|
|
9
10
|
if TYPE_CHECKING:
|
|
10
11
|
from .user import User
|
|
@@ -15,17 +16,17 @@ from .lang_dict import LangDict
|
|
|
15
16
|
class Grade(BaseModel):
|
|
16
17
|
value: float | None = None
|
|
17
18
|
value_symbol: str | None = None
|
|
18
|
-
passes:
|
|
19
|
+
passes: USOSBool | None = None
|
|
19
20
|
value_description: LangDict | None = None
|
|
20
21
|
exam_id: int | None = None
|
|
21
22
|
exam_session_number: int | None = None
|
|
22
|
-
counts_into_average:
|
|
23
|
+
counts_into_average: USOSBool | None = None
|
|
23
24
|
comment: str | None = None
|
|
24
25
|
private_comment: str | None = None
|
|
25
26
|
grade_type_id: str | None = None
|
|
26
27
|
date_modified: datetime | None = None
|
|
27
28
|
date_acquisition: datetime | None = None
|
|
28
|
-
modification_author:
|
|
29
|
+
modification_author: Optional["User"] = None
|
|
29
30
|
course_edition: CourseEdition | None = None
|
|
30
31
|
unit: CourseUnit | None = None
|
|
31
32
|
exam_report: dict[str, Any] | None = None
|
|
@@ -41,3 +42,16 @@ class Grade(BaseModel):
|
|
|
41
42
|
self.value = float(self.value_symbol.replace(",", "."))
|
|
42
43
|
except ValueError:
|
|
43
44
|
pass # Invalid value, ignore it
|
|
45
|
+
|
|
46
|
+
@field_validator("modification_author", mode="before")
|
|
47
|
+
@classmethod
|
|
48
|
+
def _parse_modification_author(cls, value: Any) -> Optional["User"]:
|
|
49
|
+
from .user import User
|
|
50
|
+
|
|
51
|
+
if value is None or isinstance(value, User):
|
|
52
|
+
return value
|
|
53
|
+
if isinstance(value, dict):
|
|
54
|
+
return User.model_validate(value)
|
|
55
|
+
if isinstance(value, str | int):
|
|
56
|
+
return User(id=value)
|
|
57
|
+
raise ValueError("Expected user object, user id or None.")
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
from datetime import date
|
|
2
|
+
|
|
3
|
+
from pydantic import BaseModel
|
|
4
|
+
|
|
5
|
+
from .lang_dict import LangDict
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class Faculty(BaseModel):
|
|
9
|
+
"""
|
|
10
|
+
Class representing a faculty.
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
id: str | None = None
|
|
14
|
+
name: LangDict | None = None
|
|
15
|
+
profile_url: str | None = None
|
|
16
|
+
homepage_url: str | None = None
|
|
17
|
+
postal_address: str | None = None
|
|
18
|
+
email: str | None = None
|
|
19
|
+
is_public: bool | None = None
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
class Programme(BaseModel):
|
|
23
|
+
"""
|
|
24
|
+
Class representing a study programme.
|
|
25
|
+
"""
|
|
26
|
+
|
|
27
|
+
id: str | None = None
|
|
28
|
+
name: LangDict | None = None
|
|
29
|
+
description: LangDict | None = None
|
|
30
|
+
faculty: Faculty | None = None
|
|
31
|
+
all_faculties: list[Faculty] | None = None
|
|
32
|
+
mode_of_studies: LangDict | None = None
|
|
33
|
+
level_of_studies: LangDict | None = None
|
|
34
|
+
duration: LangDict | None = None
|
|
35
|
+
professional_status: LangDict | None = None
|
|
36
|
+
level: str | None = None
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
class ProgrammeStage(BaseModel):
|
|
40
|
+
"""
|
|
41
|
+
Class representing a stage of a programme a student is enrolled in.
|
|
42
|
+
"""
|
|
43
|
+
|
|
44
|
+
id: str | None = None
|
|
45
|
+
name: LangDict | None = None
|
|
46
|
+
code: str | None = None
|
|
47
|
+
description: LangDict | None = None
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
class StudentProgramme(BaseModel):
|
|
51
|
+
"""
|
|
52
|
+
Class representing a student programme a user is enrolled in.
|
|
53
|
+
"""
|
|
54
|
+
|
|
55
|
+
id: str | None = None
|
|
56
|
+
user: dict | None = None
|
|
57
|
+
programme: Programme | None = None
|
|
58
|
+
status: str | None = None
|
|
59
|
+
admission_date: date | None = None
|
|
60
|
+
stages: list[ProgrammeStage] | None = []
|
|
61
|
+
is_primary: bool | None = None
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
from typing import Annotated, Any
|
|
2
|
+
|
|
3
|
+
from pydantic import BeforeValidator
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
def usos_bool(value: Any) -> Any:
|
|
7
|
+
if value is None or isinstance(value, bool):
|
|
8
|
+
return value
|
|
9
|
+
if isinstance(value, str):
|
|
10
|
+
normalized = value.strip().upper()
|
|
11
|
+
if normalized == "T":
|
|
12
|
+
return True
|
|
13
|
+
if normalized == "N":
|
|
14
|
+
return False
|
|
15
|
+
return value
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
USOSBool = Annotated[bool, BeforeValidator(usos_bool)]
|
|
@@ -4,6 +4,7 @@ from .courses import CourseService
|
|
|
4
4
|
from .exam_reports import ExamReportService
|
|
5
5
|
from .grades import GradeService
|
|
6
6
|
from .groups import GroupService
|
|
7
|
+
from .programmes import ProgrammeService
|
|
7
8
|
from .registrations import RegistrationService
|
|
8
9
|
from .terms import TermService
|
|
9
10
|
from .users import UserService
|
|
@@ -15,6 +16,7 @@ __all__ = [
|
|
|
15
16
|
"ExamReportService",
|
|
16
17
|
"GradeService",
|
|
17
18
|
"GroupService",
|
|
19
|
+
"ProgrammeService",
|
|
18
20
|
"TermService",
|
|
19
21
|
"UserService",
|
|
20
22
|
"RegistrationService",
|