refactor: deprecate static_url argument from ModuleSystem

This argument was officially used only by the ProblemBlock.
If you need to get the base URL for static assets in your XBlock, please use
`settings.STATIC_URL` directly, instead of `runtime.STATIC_URL`.
This commit is contained in:
Agrendalath
2022-06-25 23:05:09 +02:00
committed by Piotr Surowiec
parent 9f30fece9a
commit 668683559b
8 changed files with 22 additions and 23 deletions

View File

@@ -1705,6 +1705,19 @@ class ModuleSystemShim:
if rebind_user_service:
return partial(rebind_user_service.rebind_noauth_module_to_user)
# noinspection PyPep8Naming
@property
def STATIC_URL(self): # pylint: disable=invalid-name
"""
Returns the base URL for static assets.
Deprecated in favor of the settings.STATIC_URL configuration.
"""
warnings.warn(
'runtime.STATIC_URL is deprecated. Please use settings.STATIC_URL instead.',
DeprecationWarning, stacklevel=3,
)
return settings.STATIC_URL
class ModuleSystem(MetricsMixin, ConfigurableFragmentWrapper, ModuleSystemShim, Runtime):
"""
@@ -1721,7 +1734,6 @@ class ModuleSystem(MetricsMixin, ConfigurableFragmentWrapper, ModuleSystemShim,
def __init__(
self,
static_url,
track_function,
get_module,
descriptor_runtime,
@@ -1732,8 +1744,6 @@ class ModuleSystem(MetricsMixin, ConfigurableFragmentWrapper, ModuleSystemShim,
"""
Create a closure around the system environment.
static_url - the base URL to static assets
track_function - function of (event_type, event), intended for logging
or otherwise tracking the event.
TODO: Not used, and has inconsistent args in different
@@ -1754,7 +1764,6 @@ class ModuleSystem(MetricsMixin, ConfigurableFragmentWrapper, ModuleSystemShim,
kwargs.setdefault('id_generator', getattr(descriptor_runtime, 'id_generator', AsideKeyGenerator()))
super().__init__(**kwargs)
self.STATIC_URL = static_url
self.track_function = track_function
self.get_module = get_module
self.course_id = course_id