当模型使用Django时,重写设置



我们使用Django进行SpeedyNet和SpeedyMatch(目前为Django 2.1)。我们的一些设置被模型使用。例如:

class USER_SETTINGS(object):
MIN_USERNAME_LENGTH = 6
MAX_USERNAME_LENGTH = 40
MIN_SLUG_LENGTH = 6
MAX_SLUG_LENGTH = 200
# Users can register from age 0 to 180, but can't be kept on the site after age 250.
MIN_AGE_ALLOWED_IN_MODEL = 0  # In years.
MAX_AGE_ALLOWED_IN_MODEL = 250  # In years.
MIN_AGE_ALLOWED_IN_FORMS = 0  # In years.
MAX_AGE_ALLOWED_IN_FORMS = 180  # In years.
MIN_PASSWORD_LENGTH = 8
MAX_PASSWORD_LENGTH = 120
MAX_NUMBER_OF_FRIENDS_ALLOWED = 800
PASSWORD_VALIDATORS = [
{
'NAME': 'speedy.core.accounts.validators.PasswordMinLengthValidator',
},
{
'NAME': 'speedy.core.accounts.validators.PasswordMaxLengthValidator',
},
]

(定义见https://github.com/speedy-net/speedy-net/blob/staging/speedy/net/settings/global_settings.py)。然后在我使用的模型中:

from django.conf import settings as django_settings
class User(ValidateUserPasswordMixin, PermissionsMixin, Entity, AbstractBaseUser):
settings = django_settings.USER_SETTINGS

(然后在类中使用settings的属性,例如settings.MIN_SLUG_LENGTH)。

问题是,当我试图在测试中覆盖这些设置时(你可以看到我在Django设置中可以定义类吗,以及我如何在测试中重写这些设置?),User.settings保持不变,不会被我试图覆盖的设置覆盖。这是一个问题,因为在模型中,我将settings.MIN_SLUG_LENGTH传递给验证器,验证器也由其他模型传递其他值。是否可以定义模型和设置,以便在生产和测试中使用正确的设置,包括当我想覆盖它们时?

我知道这句话来自https://docs.djangoproject.com/en/dev/topics/testing/tools/#overriding-设置:

警告

设置文件包含一些仅被查阅的设置在Django内部初始化期间。如果你用override_settings,如果您通过django.conf.settings模块,但是django的内部访问它不同地有效地,使用override_settings()或modify_settings()使用这些设置可能不会起到什么作用

我们不建议更改DATABASES设置。正在更改CACHES设置是可能的,但如果您使用使用缓存的内部组件,如django.contrib.sessions。例如,您必须在使用缓存会话并覆盖CACHES的测试。

最后,避免将您的设置混淆为模块级常量override_settings()无法处理此类值,因为它们只是在第一次导入模块时进行评估。

我知道这在这种情况下是相关的,但我如何定义设置以覆盖它们?

speed/core/base/test/models.py中的函数_1___set_up是使测试工作的一种变通方法,但这是一种破解方法,我认为从长远来看,这不是一个好的解决方案。

问题,正如您所引用的:

请避免将您的设置混淆为模块级常量,因为override_settings()不会处理这些值,因为它们只在第一次导入模块时进行求值。

有三种方法可以解决这一问题,其中方法1方式3>方式2

方法1:不使用class属性进行别名,而是使用classproperty

推荐;可以说是正确的方式。

  • Pro:最具表现力,更易于调试
  • Con:模型中有更多代码
from django.utils.decorators import classproperty
class User(PermissionsMixin, Entity, AbstractBaseUser):
# settings = django_settings.USER_SETTINGS
@classproperty
def settings(cls):
return django_settings.USER_SETTINGS

注意事项:依赖于settings类属性的类属性将不起作用。

尽管Way2允许以下代码仍然有效,但这些代码在类定义(导入)时进行评估,并且不能根据override_settings()进行合理更改,除非它们也是classproperty

AGE_VALID_VALUES_IN_MODEL = range(settings.MIN_AGE_ALLOWED_IN_MODEL, settings.MAX_AGE_ALLOWED_IN_MODEL)
AGE_VALID_VALUES_IN_FORMS = range(settings.MIN_AGE_ALLOWED_IN_FORMS, settings.MAX_AGE_ALLOWED_IN_FORMS)

方法2:修补设置类,使实例读取django_settings

不推荐不仅在测试(@hynekcer)中,还在生产中影响USER_SETTINGS的运行时评估

  • Pro:模型中没有代码更改
  • 缺点:表达能力差,更难调试。

  1. 定义函数overridable_settings
def overridable_settings(settings_class):
old__getattribute__ = settings_class.__getattribute__
settings_name = settings_class.__name__
def patched__getattribute__(_self, item):
from django.conf import settings as django_settings
settings = getattr(django_settings, settings_name)
return old__getattribute__(settings, item)
settings_class.__getattribute__ = patched__getattribute__
return settings_class()
  1. django_settings.USER_SETTINGS现在是设置类的一个实例。定义override_settings而不是get_django_settings_class_with_override_settings
import copy
def override_settings(settings, **overrides):
copied_settings = copy.deepcopy(settings)
for setting, value in overrides.items():
setattr(copied_settings, setting, value)
assert copied_settings != settings
return copied_settings

用法:

@overridable_settings
class USER_SETTINGS(object):
from speedy.core.base.test import utils
# @override_settings(USER_SETTINGS=get_django_settings_class_with_override_settings(django_settings_class=django_settings.USER_SETTINGS, MIN_SLUG_LENGTH=tests_settings.OVERRIDE_USER_SETTINGS.MIN_SLUG_LENGTH))
@override_settings(USER_SETTINGS=utils.override_settings(django_settings.USER_SETTINGS, MIN_SLUG_LENGTH=tests_settings.OVERRIDE_USER_SETTINGS.MIN_SLUG_LENGTH))
def test_slug_min_length_fail_username_min_length_ok(self):

方法3:创建信号setting_changed的接收器以更新别名

  • Pro:对模型的代码更改最小
  • Con:在洞穴中的依赖属性方面,表现力低于方式1

来源https://docs.djangoproject.com/en/dev/topics/testing/tools/#overriding-设置:

覆盖设置时,确保处理应用程序代码使用缓存或类似功能的情况,即使设置发生更改,该功能也会保持状态。Django提供django.test.signals.setting_changed信号,允许您注册回调以在设置更改时清除或重置状态。

Django本身使用这个信号来重置各种数据。

from django.core.signals import setting_changed
from django.dispatch.dispatcher import receiver
def register_django_setting_alias(setting_alias, django_setting):
def decorator(cls):
@receiver(setting_changed, weak=False)
def update_setting_alias(setting, value, **_):
if setting == django_setting:
setattr(cls, setting_alias, value)
return cls
return decorator

用法:

@register_django_setting_alias('settings', 'USER_SETTINGS')
class User(PermissionsMixin, Entity, AbstractBaseUser):
settings = django_settings.USER_SETTINGS

最新更新