模型使用时在Django中覆盖设置

时间:2018-12-28 03:46:01

标签: python django python-3.x override django-settings

我们将Django用于Speedy Net and Speedy Match(当前是Django 1.11.17,由于我们的要求之一django-modeltranslation,我们无法升级到较新版本的Django)。我们的某些设置被模型使用。例如:

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)。

问题是,当我尝试覆盖测试中的此类设置(您可以在Can I define classes in Django settings, and how can I override such settings in tests?上看到我的问题和答案)时,User.settings保持不变,并且不会被我尝试设置覆盖覆盖。这是一个问题,因为在模型中我例如将settings.MIN_SLUG_LENGTH传递给了验证器,验证器也通过其他模型传递了其他值。是否可以通过这样的方式定义模型和设置,即在生产和测试中都将使用正确的设置,包括我何时要覆盖它们?

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

  

警告

     

设置文件包含一些仅可参考的设置   在Django内部初始化期间。如果您用   Override_settings,如果您通过   django.conf.settings模块,但是Django内部人员可以访问它   不一样。有效地,使用override_settings()或   使用这些设置的Modify_settings()可能不会做什么   您希望它能做到。

     

我们不建议您更改数据库设置。改变   可以进行CACHES设置,但如果使用的话,会有些棘手   使用缓存的内部组件,例如django.contrib.sessions。   例如,您将必须在   使用缓存的会话并覆盖CACHES的测试。

     

最后,避免将您的设置作为模块级常量的别名   overlay_settings()不适用于此类值,因为它们只是   在第一次导入模块时进行了评估。

我了解在这种情况下的相关性,但是如何以可以覆盖它们的方式定义设置?

1 个答案:

答案 0 :(得分:3)

问题,如您所引用:

  

避免将设置别名作为模块级常量,因为override_settings()不适用于此类值,因为它们仅在首次导入模块时才进行评估。

有3种解决方法,其中方法1 > 方法3 > 方法2

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

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

  • Pro:最具表现力,更易于调试。
  • 缺点:模型中有更多代码。
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类属性的类属性将不起作用。

尽管方法2 允许以下代码仍然有效,但是它们在类定义(导入)时进行评估,并且不能基于override_settings()进行合理更改,除非它们是{{1 }}。

classproperty

方式2:补丁设置类,因此实例读取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)

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

  • 专业人士:模型中的代码未更改。
  • 缺点:表现力最低,更难调试。

  1. 定义一个函数django_settings
overridable_settings
  1. 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() 现在是设置类的实例。代替django_settings.USER_SETTINGS,定义get_django_settings_class_with_override_settings
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):

方法3:创建信号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): 的接收器以更新别名

  • 专业人士:对模型的代码更改最少。
  • 缺点:关于注意事项中的从属属性,其表现力不及方法1

来自https://docs.djangoproject.com/en/dev/topics/testing/tools/#overriding-settings

  

覆盖设置时,请确保处理您的应用代码使用即使保留设置更改也能保持状态的缓存或类似功能。 Django提供了django.test.signals.setting_changed信号,可让您注册回调以进行清理,或者在更改设置时重置状态。

     

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

setting_changed

用法:

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