Skip to content

Commit 4e14680

Browse files
Removed '_query' suffixes from lms.model.scores.AssignmentScore to make output cleaner.
1 parent 8bbb7b1 commit 4e14680

File tree

11 files changed

+68
-68
lines changed

11 files changed

+68
-68
lines changed

lms/backend/canvas/model.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ def assignment_score(data: typing.Dict[str, typing.Any]) -> lms.model.scores.Ass
6565
data['graded_date'] = lms.backend.canvas.common.parse_timestamp(data.get('graded_at', None))
6666

6767
assignment_id = lms.util.parse.required_string(data.get('assignment_id', None), 'assignment_id')
68-
data['assignment_query'] = lms.model.assignments.AssignmentQuery(id = assignment_id)
68+
data['assignment'] = lms.model.assignments.AssignmentQuery(id = assignment_id)
6969

7070
user_id = lms.util.parse.required_string(data.get('user_id', None), 'user_id')
71-
data['user_query'] = lms.model.users.UserQuery(id = user_id)
71+
data['user'] = lms.model.users.UserQuery(id = user_id)
7272

7373
return lms.model.scores.AssignmentScore(**data)
7474

lms/backend/testdata/backendtests/courses/gradebook/upload_backendtest.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ def _get_base_gradebook():
5555
base_gradebook = lms.model.scores.Gradebook(base_assignments, base_users)
5656

5757
base_gradebook.add(lms.model.scores.AssignmentScore(score = 1.0,
58-
assignment_query = base_assignments[0], user_query = base_users[0]))
58+
assignment = base_assignments[0], user = base_users[0]))
5959
base_gradebook.add(lms.model.scores.AssignmentScore(score = 0.5,
60-
assignment_query = base_assignments[0], user_query = base_users[1]))
60+
assignment = base_assignments[0], user = base_users[1]))
6161
base_gradebook.add(lms.model.scores.AssignmentScore(score = 1.0, comment = 'extra-course-student-1 comment',
62-
assignment_query = base_assignments[1], user_query = base_users[0]))
62+
assignment = base_assignments[1], user = base_users[0]))
6363
base_gradebook.add(lms.model.scores.AssignmentScore(score = 0.5, comment = 'extra-course-student-2 comment',
64-
assignment_query = base_assignments[1], user_query = base_users[1]))
64+
assignment = base_assignments[1], user = base_users[1]))
6565

6666
return base_gradebook

lms/backend/testdata/cli/tests/courses/assignments/scores/get_base.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
}
99
---
1010
id: 110050101
11-
user_query: course-student@test.edulinq.org (100050000)
12-
assignment_query: Homework 0 (110000100)
11+
user: course-student@test.edulinq.org (100050000)
12+
assignment: Homework 0 (110000100)
1313
score: 2.0
1414
submission_date:
1515
graded_date: 2023-10-15 13:44

lms/backend/testdata/cli/tests/courses/assignments/scores/list_base.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
}
88
---
99
id: 110050101
10-
user_query: course-student@test.edulinq.org (100050000)
11-
assignment_query: Homework 0 (110000100)
10+
user: course-student@test.edulinq.org (100050000)
11+
assignment: Homework 0 (110000100)
1212
score: 2.0
1313
submission_date:
1414
graded_date: 2023-10-15 13:44

lms/backend/testdata/cli/tests/courses/gradebook/list_1_formatting_json.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@
2424
[
2525
{
2626
"id": "110050101",
27-
"user_query": {
27+
"user": {
2828
"id": "100050000",
2929
"name": "course-student",
3030
"email": "course-student@test.edulinq.org"
3131
},
32-
"assignment_query": {
32+
"assignment": {
3333
"id": "110000100",
3434
"name": "Homework 0"
3535
},

lms/backend/testdata/cli/tests/courses/users/scores/get_base.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
}
99
---
1010
id: 110050101
11-
user_query: course-student@test.edulinq.org (100050000)
12-
assignment_query: Homework 0 (110000100)
11+
user: course-student@test.edulinq.org (100050000)
12+
assignment: Homework 0 (110000100)
1313
score: 2.0
1414
submission_date:
1515
graded_date: 2023-10-15 13:44

lms/backend/testdata/cli/tests/courses/users/scores/list_base.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
}
88
---
99
id: 110050101
10-
user_query: course-student@test.edulinq.org (100050000)
11-
assignment_query: Homework 0 (110000100)
10+
user: course-student@test.edulinq.org (100050000)
11+
assignment: Homework 0 (110000100)
1212
score: 2.0
1313
submission_date:
1414
graded_date: 2023-10-15 13:44

lms/cli/courses/gradebook/upload.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ def _load_gradebook(
9393
except Exception:
9494
raise ValueError(f"File '{path}' line {lineno} has a score that cannot be converted to a number: '{part}'.") # pylint: disable=raise-missing-from
9595

96-
assignment_score = lms.model.scores.AssignmentScore(score = float_score, assignment_query = assignments[i], user_query = user)
96+
assignment_score = lms.model.scores.AssignmentScore(score = float_score, assignment = assignments[i], user = user)
9797
scores.append(assignment_score)
9898

9999
gradebook = lms.model.scores.Gradebook(assignments, users)

lms/model/backend.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ def courses_assignments_scores_get(self,
206206
matches = []
207207
for score in scores:
208208
for user_query in user_queries:
209-
if (user_query.match(score.user_query)):
209+
if (user_query.match(score.user)):
210210
matches.append(score)
211211

212212
return sorted(matches)
@@ -225,7 +225,7 @@ def courses_assignments_scores_fetch(self,
225225

226226
scores = self.courses_assignments_scores_list(course_id, assignment_id, **kwargs)
227227
for score in scores:
228-
if ((score.user_query is not None) and (score.user_query.id == user_id)):
228+
if ((score.user is not None) and (score.user.id == user_id)):
229229
return score
230230

231231
return None
@@ -271,10 +271,10 @@ def courses_assignments_scores_resolve_and_list(self,
271271
users_map = {user.id: user for user in users}
272272

273273
for score in scores:
274-
score.assignment_query = target_assignment.to_query()
274+
score.assignment = target_assignment.to_query()
275275

276-
if ((score.user_query is not None) and (score.user_query.id in users_map)):
277-
score.user_query = users_map[score.user_query.id].to_query()
276+
if ((score.user is not None) and (score.user.id in users_map)):
277+
score.user = users_map[score.user.id].to_query()
278278

279279
return sorted(scores)
280280

@@ -1209,7 +1209,7 @@ def courses_users_scores_get(self,
12091209
matches = []
12101210
for score in scores:
12111211
for assignment_query in assignment_queries:
1212-
if (assignment_query.match(score.assignment_query)):
1212+
if (assignment_query.match(score.assignment)):
12131213
matches.append(score)
12141214

12151215
return matches
@@ -1270,10 +1270,10 @@ def courses_users_scores_resolve_and_list(self,
12701270
assignments_map = {assignment.id: assignment for assignment in assignments}
12711271

12721272
for score in scores:
1273-
score.user_query = target_user.to_query()
1273+
score.user = target_user.to_query()
12741274

1275-
if ((score.assignment_query is not None) and (score.assignment_query.id in assignments_map)):
1276-
score.assignment_query = assignments_map[score.assignment_query.id].to_query()
1275+
if ((score.assignment is not None) and (score.assignment.id in assignments_map)):
1276+
score.assignment = assignments_map[score.assignment.id].to_query()
12771277

12781278
return sorted(scores)
12791279

lms/model/scores.py

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class AssignmentScore(lms.model.base.BaseType):
2929
"""
3030

3131
CORE_FIELDS = [
32-
'id', 'user_query', 'assignment_query', 'score', 'submission_date', 'graded_date', 'comment',
32+
'id', 'user', 'assignment', 'score', 'submission_date', 'graded_date', 'comment',
3333
]
3434

3535
def __init__(self,
@@ -38,18 +38,18 @@ def __init__(self,
3838
submission_date: typing.Union[edq.util.time.Timestamp, None] = None,
3939
graded_date: typing.Union[edq.util.time.Timestamp, None] = None,
4040
comment: typing.Union[str, None] = None,
41-
assignment_query: typing.Union[lms.model.assignments.AssignmentQuery, None] = None,
42-
user_query: typing.Union[lms.model.users.UserQuery, None] = None,
41+
assignment: typing.Union[lms.model.assignments.AssignmentQuery, None] = None,
42+
user: typing.Union[lms.model.users.UserQuery, None] = None,
4343
**kwargs: typing.Any) -> None:
4444
super().__init__(**kwargs)
4545

4646
self.id: typing.Union[str, None] = id
4747
""" The LMS's identifier for this score. """
4848

49-
self.assignment_query: typing.Union[lms.model.assignments.AssignmentQuery, None] = assignment_query
49+
self.assignment: typing.Union[lms.model.assignments.AssignmentQuery, None] = assignment
5050
""" The assignment associated with this score. """
5151

52-
self.user_query: typing.Union[lms.model.users.UserQuery, None] = user_query
52+
self.user: typing.Union[lms.model.users.UserQuery, None] = user
5353
""" The user associated with this score. """
5454

5555
self.score: typing.Union[float, None] = score
@@ -156,25 +156,25 @@ def add(self, score: AssignmentScore) -> None:
156156

157157
found_assignment = None
158158
for assignment in self.assignments:
159-
if (assignment.match(score.assignment_query)):
159+
if (assignment.match(score.assignment)):
160160
found_assignment = assignment
161161
break
162162

163163
if (found_assignment is None):
164-
raise ValueError(f"Could not match gradebook assignment to score's assignment '{score.assignment_query}'.")
164+
raise ValueError(f"Could not match gradebook assignment to score's assignment '{score.assignment}'.")
165165

166166
found_user = None
167167
for user in self.users:
168-
if (user.match(score.user_query)):
168+
if (user.match(score.user)):
169169
found_user = user
170170
break
171171

172172
if (found_user is None):
173-
raise ValueError(f"Could not match gradebook user to score's user '{score.user_query}'.")
173+
raise ValueError(f"Could not match gradebook user to score's user '{score.user}'.")
174174

175175
# Update the score's queries.
176-
score.assignment_query = found_assignment
177-
score.user_query = found_user
176+
score.assignment = found_assignment
177+
score.user = found_user
178178

179179
self._entries[self._make_key(found_assignment, found_user)] = score
180180

@@ -191,11 +191,11 @@ def update_queries(self,
191191
self.users = [user_map.get(user.id, user) for user in self.users]
192192

193193
for score in self._entries.values():
194-
if (score.assignment_query is not None):
195-
score.assignment_query = assignment_map.get(score.assignment_query.id, score.assignment_query)
194+
if (score.assignment is not None):
195+
score.assignment = assignment_map.get(score.assignment.id, score.assignment)
196196

197-
if (score.user_query is not None):
198-
score.user_query = user_map.get(score.user_query.id, score.user_query)
197+
if (score.user is not None):
198+
score.user = user_map.get(score.user.id, score.user)
199199

200200
def as_text_rows(self,
201201
skip_headers: bool = False,

0 commit comments

Comments
 (0)