Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve monitoring of waffle deprecation with custom attributes

Browse Source 
We observe a lot of deprecation warnings using the
"deprecated_waffle_utils" custom attribute. To make it easier to track
these items, we add the waffle flag/namespace name to the custom
attribute.
This commit is contained in:
Régis Behmo
2020-11-05 08:32:56 +01:00
parent 103ec9e0dc
commit b32fc50947
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
openedx/core/djangoapps/waffle_utils/__init__.py
View File

@@ -21,8 +21,8 @@ class WaffleSwitchNamespace(BaseWaffleSwitchNamespace):
Deprecated class: instead, use edx_toggles.toggles.WaffleSwitchNamespace.
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
def __init__(self, name, log_prefix=None):
super().__init__(name, log_prefix=log_prefix)
warnings.warn(
(
"Importing WaffleSwitchNamespace from waffle_utils is deprecated. Instead, import from"
@@ -31,7 +31,7 @@ class WaffleSwitchNamespace(BaseWaffleSwitchNamespace):
DeprecationWarning,
stacklevel=2,
)
set_custom_attribute("deprecated_waffle_utils", "WaffleSwitchNamespace")
set_custom_attribute("deprecated_waffle_utils", "WaffleSwitchNamespace[{}]".format(name))
@contextmanager
def override(self, switch_name, active=True):
@@ -62,14 +62,14 @@ class WaffleSwitch(BaseWaffleSwitch):
Deprecated class: instead, use edx_toggles.toggles.WaffleSwitch.
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
def __init__(self, waffle_namespace, switch_name, module_name=None):
super().__init__(waffle_namespace, switch_name, module_name=module_name)
warnings.warn(
"Importing WaffleSwitch from waffle_utils is deprecated. Instead, import from edx_toggles.toggles.",
DeprecationWarning,
stacklevel=2,
)
set_custom_attribute("deprecated_waffle_utils", "WaffleSwitch")
set_custom_attribute("deprecated_waffle_utils", "WaffleSwitch[{}]".format(self.name))
class WaffleFlagNamespace(BaseWaffleFlagNamespace):
@@ -77,14 +77,14 @@ class WaffleFlagNamespace(BaseWaffleFlagNamespace):
Deprecated class: instead, use edx_toggles.toggles.WaffleFlagNamespace.
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
def __init__(self, name, log_prefix=None):
super().__init__(name, log_prefix=log_prefix)
warnings.warn(
"Importing WaffleFlagNamespace from waffle_utils is deprecated. Instead, import from edx_toggles.toggles.",
DeprecationWarning,
stacklevel=2,
)
set_custom_attribute("deprecated_waffle_utils", "WaffleFlagNamespace")
set_custom_attribute("deprecated_waffle_utils", "WaffleFlagNamespace[{}]".format(name))
class WaffleFlag(BaseWaffleFlag):
@@ -92,14 +92,14 @@ class WaffleFlag(BaseWaffleFlag):
Deprecated class: instead, use edx_toggles.toggles.WaffleFlag.
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
def __init__(self, waffle_namespace, flag_name, module_name=None):
super().__init__(waffle_namespace, flag_name, module_name=module_name)
warnings.warn(
"Importing WaffleFlag from waffle_utils is deprecated. Instead, import from edx_toggles.toggles.",
DeprecationWarning,
stacklevel=2,
)
set_custom_attribute("deprecated_waffle_utils", "WaffleFlag")
set_custom_attribute("deprecated_waffle_utils", "WaffleFlag[{}]".format(self.name))
@contextmanager
def override(self, active=True):