From aa501dea662bafd788777ee386fd7fa3481e082a Mon Sep 17 00:00:00 2001 From: Eugene Dyudyunov Date: Thu, 24 Mar 2022 10:53:30 +0200 Subject: [PATCH] refactor: change the send_grade_signals to send_course_grade_signals --- lms/djangoapps/certificates/generation_handler.py | 10 +++++----- lms/djangoapps/grades/course_grade_factory.py | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lms/djangoapps/certificates/generation_handler.py b/lms/djangoapps/certificates/generation_handler.py index 95b6c825a6..8b3834f528 100644 --- a/lms/djangoapps/certificates/generation_handler.py +++ b/lms/djangoapps/certificates/generation_handler.py @@ -53,7 +53,7 @@ def generate_allowlist_certificate_task(user, course_key, generation_mode=None, Create a task to generate an allowlist certificate for this user in this course run. """ enrollment_mode = _get_enrollment_mode(user, course_key) - course_grade = _get_course_grade(user, course_key, send_grade_signals=False) + course_grade = _get_course_grade(user, course_key, send_course_grade_signals=False) if _can_generate_allowlist_certificate(user, course_key, enrollment_mode): return _generate_certificate_task(user=user, course_key=course_key, enrollment_mode=enrollment_mode, course_grade=course_grade, generation_mode=generation_mode, @@ -72,7 +72,7 @@ def _generate_regular_certificate_task(user, course_key, generation_mode=None, d eligible and a certificate can be generated. """ enrollment_mode = _get_enrollment_mode(user, course_key) - course_grade = _get_course_grade(user, course_key, send_grade_signals=False) + course_grade = _get_course_grade(user, course_key, send_course_grade_signals=False) if _can_generate_regular_certificate(user, course_key, enrollment_mode, course_grade): return _generate_certificate_task(user=user, course_key=course_key, enrollment_mode=enrollment_mode, course_grade=course_grade, generation_mode=generation_mode, @@ -377,14 +377,14 @@ def _get_grade_value(course_grade): return '' -def _get_course_grade(user, course_key, send_grade_signals=True): +def _get_course_grade(user, course_key, send_course_grade_signals=True): """ Get the user's course grade in this course run. Note that this may be None. - Use send_grade_signals=False to avoid firing the course grade signals recursively. + Use send_course_grade_signals=False to avoid firing the course grade signals recursively. See details in lms/djangoapps/grades/course_grade_factory.py _update method. """ - return CourseGradeFactory().read(user, course_key=course_key, send_grade_signals=send_grade_signals) + return CourseGradeFactory().read(user, course_key=course_key, send_course_grade_signals=send_course_grade_signals) def _get_enrollment_mode(user, course_key): diff --git a/lms/djangoapps/grades/course_grade_factory.py b/lms/djangoapps/grades/course_grade_factory.py index 5a86a060c0..65f3a9c4cc 100644 --- a/lms/djangoapps/grades/course_grade_factory.py +++ b/lms/djangoapps/grades/course_grade_factory.py @@ -33,7 +33,7 @@ class CourseGradeFactory: course_structure=None, course_key=None, create_if_needed=True, - send_grade_signals=True, + send_course_grade_signals=True, ): """ Returns the CourseGrade for the given user in the course. @@ -52,7 +52,7 @@ class CourseGradeFactory: if assume_zero_if_absent(course_data.course_key): return self._create_zero(user, course_data) elif create_if_needed: - return self._update(user, course_data, send_grade_signals=send_grade_signals) + return self._update(user, course_data, send_course_grade_signals=send_course_grade_signals) else: return None @@ -161,11 +161,11 @@ class CourseGradeFactory: ) @staticmethod - def _update(user, course_data, force_update_subsections=False, send_grade_signals=True): + def _update(user, course_data, force_update_subsections=False, send_course_grade_signals=True): """ Computes, saves, and returns a CourseGrade object for the given user and course. - send_grade_signals defines if signals should be sent. Use it to avoid recursion issues in + send_course_grade_signals defines if signals should be sent. Use it to avoid recursion issues in cases when the signal listener trying to get grades but Persistent Grades are disabled. If True - sends: COURSE_GRADE_CHANGED signal to listeners and @@ -197,7 +197,7 @@ class CourseGradeFactory: passed=course_grade.passed, ) - if send_grade_signals: + if send_course_grade_signals: COURSE_GRADE_CHANGED.send_robust( sender=None, user=user,