如何为自定义 Django 设置定义默认值

Question

您可以添加的 Django 文档提及您自己的设置到django.conf.settings。因此，如果我的项目的 settings.py 定义了，

APPLES = 1

我可以在该项目的应用程序中使用 settings.APPLES 访问它。

但是，如果我的 settings.py 没有定义该值，则访问 settings.APPLES 显然将无法工作。如果 settings.py 中没有显式设置，是否有某种方法可以为 APPLES 定义默认值？

我最好在需要设置的模块/包中定义默认值。

Answer 1

在我的应用程序中，我有一个单独的 settings.py 文件。在该文件中，我有一个 get() 函数，它在项目的 settings.py 文件中进行查找，如果找不到，则返回默认值。

from django.conf import settings

def get(key, default):
    return getattr(settings, key, default)


APPLES = get('APPLES', 1)

然后，在我需要访问 APPLES 的地方，我有：

from myapp import settings as myapp_settings

myapp_settings.APPLES

这允许在项目 settings.py 中进行覆盖，getattr 将首先检查那里，如果找到该属性，则返回该值，或者使用应用程序设置文件中定义的默认值。

Answer 2

怎么样：

getattr(app_settings, 'SOME_SETTING', 'default value')

Answer 3

这里有两个解决方案。对于这两种情况，您都可以在应用程序中设置 settings.py 文件并用默认值填充它们。

为单个应用程序配置默认值

在代码中使用 from MYAPP import settings 而不是 from django.conf import settings。

编辑 YOURAPP/__init__.py：

from django.conf import settings as user_settings
from . import settings as default_settings

class AppSettings:
    def __getattr__(self, name):
        # If the setting you want is filled by the user, let's use it.
        if hasattr(user_settings, name):
            return getattr(user_settings, name)

        # If the setting you want has a default value, let's use it.
        if hasattr(default_settings, name):
            return getattr(default_settings, name)

        raise AttributeError("'Settings' object has no attribute '%s'" % name)

settings = AppSettings()

为整个项目配置默认值

在您的项目中使用 from MYPROJECT import settings 而不是 from django.conf import settings代码。

编辑 MYPROJECT/MYPROJECT/__init__.py

import os, sys, importlib
from . import settings as user_settings

def get_local_apps():
    """Returns the locally installed apps names"""
    apps = []
    for app in user_settings.INSTALLED_APPS:
        path = os.path.join(user_settings.BASE_DIR, app)
        if os.path.exists(path) and app != __name__:
            apps.append(sys.modules[app])
    return apps

class AppSettings:
    SETTINGS_MODULE = 'settings'

    def __getattr__(self, setting_name):

        # If the setting you want is filled by the user, let's use it.
        if hasattr(user_settings, setting_name):
            return getattr(user_settings, setting_name)

        # Let's check every local app loaded by django.
        for app in get_local_apps():
            module_source = os.path.join(app.__path__[0], "%s.py" % self.SETTINGS_MODULE)
            module_binary = os.path.join(app.__path__[0], "%s.pyc" % self.SETTINGS_MODULE)
            if os.path.exists(module_source) or os.path.exists(module_binary):
                module = importlib.import_module("%s.%s" % (app.__name__, self.SETTINGS_MODULE))

                # Let's take the first default value for this setting we can find in any app
                if hasattr(module, setting_name):
                    return getattr(module, setting_name)

        raise AttributeError("'Settings' object has no attribute '%s'" % setting_name)

settings = AppSettings()

此解决方案可能看起来更容易安装，但它不能保证返回良好的默认值。如果多个应用程序在其 settings.py 中声明相同的变量，您无法确定哪一个应用程序将返回您要求的默认值。

Answer 4

从迈克的回答开始，我现在将默认设置处理包装到一个具有易于使用的界面的类中。

帮助程序模块：

from django.conf import settings

class SettingsView(object):
   class Defaults(object):
      pass

   def __init__(self):
      self.defaults = SettingsView.Defaults()

   def __getattr__(self, name):
      return getattr(settings, name, getattr(self.defaults, name))

用法：

from localconf import SettingsView

settings = SettingsView()
settings.defaults.APPLES = 1

print settings.APPLES

这将打印 django.conf.settings 中的值，如果未在那里设置，则打印默认值。此 settings 对象还可用于访问所有标准设置值。

Answer 5

我最近遇到了同样的问题，并创建了一个 Django 应用程序，专门用于这种情况。它允许您定义某些设置的默认值。然后，它首先检查全局设置文件中是否设置了该设置。如果没有，它将返回默认值。

我将其扩展为还允许对默认值进行某些类型检查或预先处理（例如，可以在加载时将点分类路径转换为类本身）

该应用程序可以在以下位置找到： https://pypi.python.org/pypi?name=django-pluggableappsettings&version=0.2.0&:action=display