8ef8b35a54
A variety of updates were made to improve the toggle documentation: * Added comments to help ensure that the waffle(), waffle_switches(), waffle_flags() anti-pattern won't be contagious (copied). * Some minor toggle_description updates. * Removed empty toggle_target_removal_date annotations for non-temporary toggles. * Removed empty optional toggle_warnings annotations. * Removed empty optional toggle_tickets annotations. * Removed deprecated toggle_category, toggle_status, and toggle_expiration_date annotations. * Fixed some indents, use cases, and implementations. ARCHBOM-1721
71 lines
2.6 KiB
Python
71 lines
2.6 KiB
Python
"""
|
|
This module contains various configuration settings via
|
|
waffle switches for the instructor_task app.
|
|
"""
|
|
|
|
from edx_toggles.toggles import LegacyWaffleFlagNamespace, LegacyWaffleSwitchNamespace
|
|
|
|
from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag
|
|
|
|
WAFFLE_NAMESPACE = 'instructor_task'
|
|
# TODO: Remove and replace with direct references to each flag.
|
|
INSTRUCTOR_TASK_WAFFLE_FLAG_NAMESPACE = LegacyWaffleFlagNamespace(name=WAFFLE_NAMESPACE)
|
|
# TODO: Remove and replace with direct references to each switch.
|
|
WAFFLE_SWITCHES = LegacyWaffleSwitchNamespace(name=WAFFLE_NAMESPACE)
|
|
|
|
# Waffle switches
|
|
# TODO: Replace with WaffleSwitch(). See WAFFLE_SWITCHES comment.
|
|
OPTIMIZE_GET_LEARNERS_FOR_COURSE = 'optimize_get_learners_for_course'
|
|
|
|
# Course override flags
|
|
# TODO: Replace with WaffleFlag(). See waffle_flags() docstring.
|
|
GENERATE_PROBLEM_GRADE_REPORT_VERIFIED_ONLY = 'generate_problem_grade_report_verified_only'
|
|
# TODO: Replace with WaffleFlag(). See waffle_flags() docstring.
|
|
GENERATE_COURSE_GRADE_REPORT_VERIFIED_ONLY = 'generate_course_grade_report_verified_only'
|
|
|
|
|
|
def waffle_flags():
|
|
"""
|
|
Returns the namespaced, cached, audited Waffle flags dictionary for Grades.
|
|
|
|
IMPORTANT: Do NOT copy this dict pattern and do NOT add new flags to this dict.
|
|
Instead, replace the string constants above with the actual flag instances.
|
|
"""
|
|
return {
|
|
GENERATE_PROBLEM_GRADE_REPORT_VERIFIED_ONLY: CourseWaffleFlag(
|
|
waffle_namespace=INSTRUCTOR_TASK_WAFFLE_FLAG_NAMESPACE,
|
|
flag_name=GENERATE_PROBLEM_GRADE_REPORT_VERIFIED_ONLY,
|
|
module_name=__name__,
|
|
),
|
|
GENERATE_COURSE_GRADE_REPORT_VERIFIED_ONLY: CourseWaffleFlag(
|
|
waffle_namespace=INSTRUCTOR_TASK_WAFFLE_FLAG_NAMESPACE,
|
|
flag_name=GENERATE_COURSE_GRADE_REPORT_VERIFIED_ONLY,
|
|
module_name=__name__,
|
|
),
|
|
}
|
|
|
|
|
|
def optimize_get_learners_switch_enabled():
|
|
"""
|
|
Returns True if optimize get learner switch is enabled, otherwise False.
|
|
"""
|
|
return WAFFLE_SWITCHES.is_enabled(OPTIMIZE_GET_LEARNERS_FOR_COURSE)
|
|
|
|
|
|
def problem_grade_report_verified_only(course_id):
|
|
"""
|
|
Returns True if problem grade reports should only
|
|
return rows for verified students in the given course,
|
|
False otherwise.
|
|
"""
|
|
return waffle_flags()[GENERATE_PROBLEM_GRADE_REPORT_VERIFIED_ONLY].is_enabled(course_id)
|
|
|
|
|
|
def course_grade_report_verified_only(course_id):
|
|
"""
|
|
Returns True if problem grade reports should only
|
|
return rows for verified students in the given course,
|
|
False otherwise.
|
|
"""
|
|
return waffle_flags()[GENERATE_COURSE_GRADE_REPORT_VERIFIED_ONLY].is_enabled(course_id)
|