lms.djangoapps.gating package#

Submodules#

lms.djangoapps.gating.api module#

API for the gating djangoapp

lms.djangoapps.gating.api.evaluate_entrance_exam(course_grade, user)#

Evaluates any entrance exam milestone relationships attached to the given course. If the course_grade meets the minimum score required, the dependent milestones will be marked fulfilled for the user.

lms.djangoapps.gating.api.get_entrance_exam_score(course_grade, exam_chapter_key)#

Returns the score for the given chapter as a ratio of the aggregated earned over the possible points, resulting in a decimal value less than 1.

lms.djangoapps.gating.api.get_entrance_exam_usage_key(course)#

Returns the UsageKey of the entrance exam for the course.

lms.djangoapps.gating.apps module#

Django AppConfig module for the Gating app

class lms.djangoapps.gating.apps.GatingConfig(app_name, app_module)#

Bases: AppConfig

Django AppConfig class for the gating app

name = 'lms.djangoapps.gating'#
ready()#

Override this method in subclasses to run code when Django starts.

lms.djangoapps.gating.signals module#

Signal handlers for the gating djangoapp

lms.djangoapps.gating.signals.evaluate_course_gated_milestones(**kwargs)#

Receives the COURSE_GRADE_CHANGED signal and triggers the evaluation of any milestone relationships which are attached to the course grade.

Parameters:

kwargs (dict) – Contains user, course_grade

Returns:

None

lms.djangoapps.gating.signals.evaluate_subsection_completion_milestones(**kwargs)#

Receives the BlockCompletion signal and triggers the evaluation of any milestone which can be completed.

lms.djangoapps.gating.signals.evaluate_subsection_gated_milestones(**kwargs)#

Receives the SUBSECTION_SCORE_CHANGED signal and triggers the evaluation of any milestone relationships which are attached to the subsection.

Parameters:

kwargs (dict) – Contains user, course, course_structure, subsection_grade

Returns:

None

lms.djangoapps.gating.tasks module#

This file contains celery tasks related to course content gating.

Module contents#