edx_toggles.toggles.state.internal package#
Submodules#
edx_toggles.toggles.state.internal.report module#
Toggle state report API.
- class edx_toggles.toggles.state.internal.report.ToggleStateReport#
Bases:
objectConvenient class to collect toggle objects across a codebase and expose them via a REST API.
Many methods are overridable to expose custom toggle objects in different IDAs.
Use as follows:
report = ToggleStateReport().as_dict()
- add_waffle_flag_computed_status(flags_dict)#
Add “computed_status” key to each waffle flag.
- add_waffle_flag_instances(flags_dict)#
Add waffle flag instances, indexed by name.
- add_waffle_flag_state(flags_dict)#
Add extra fields to some flag.
- as_dict()#
Produce a JSON-convertible report dict.
- Returns:
this contains following keys: “waffle_flags”, “waffle_switches”, “django_settings”.
- Return type:
report (OrderedDict)
- get_django_settings()#
Get all Django settins, indexed by name.
- get_waffle_flag_computed_status(flag)#
Return the computed status of a flag.
- get_waffle_flags()#
Get all waffle flags and their state, indexed by name.
- get_waffle_switches()#
Get all waffle switches, indexed by name.
- edx_toggles.toggles.state.internal.report.get_or_create_toggle_response(toggles_dict, toggle_name)#
Gets or creates a toggle response dict and adds it to the toggles_dict.
- Returns:
Either the pre-existing toggle response, or a new toggle dict with the “name” key.
- edx_toggles.toggles.state.internal.report.setting_dict_name(dict_name, key)#
Return the name associated to a dict_name[key] setting.
- edx_toggles.toggles.state.internal.report.sorted_values_by_name(entries)#
Return the dict values sorted by their “name” key.