在 Django 中定义常量

Question

我想在 Django 项目中有一些常量。例如，假设有一个名为 MIN_TIME_TEST 的常量。

我希望能够在两个地方访问这个常量：从我的 Python 代码中，以及从任何模板中。

执行此操作的最佳方法是什么？

编辑： 为了澄清这一点，我了解模板上下文处理器以及将内容放入 settings.py 或其他文件中然后导入。

我的问题是，如何结合这两种方法而不违反“不要重复自己”规则？根据到目前为止的答案，这是我的方法：

我想创建一个名为 global_constants.py 的文件，其中包含常量列表（例如 MIN_TIME_TEST = 5）。我可以将此文件导入到任何模块中以获取常量。

但现在，我想创建返回所有这些常量的上下文处理器。我怎样才能自动执行此操作，而不必像 John Mee 的回答那样在字典中再次列出它们？

Answer 1

恕我直言，卢珀和弗拉基米尔都是正确的，但你需要两者才能完成你的要求。

• 虽然，常量不需要位于 settings.py 中，但您可以将它们放在任何位置并将它们从该位置导入到视图/模型/模块代码中。如果我不想让它们被认为是全局相关的，我有时会将它们放入 __init__.py 中。

• 像这样的上下文处理器将确保所选变量全局位于模板范围内

  def 设置（请求）：
      ”“”
      将选定的设置变量放入默认模板上下文中
      ”“”
      从 django.conf 导入设置
      返回 {
          'DOMAIN': 设置.DOMAIN,
          'GOOGLEMAPS_API_KEY'：设置.GOOGLEMAPS_API_KEY，
      }
  

但是如果您是 django 的新手，这可能有点过分了；也许您只是问如何将变量放入模板范围......？

from django.conf import settings

...
# do stuff with settings.MIN_TIME_TEST as you wish

render_to_response("the_template.html", { 
    "MIN_TIME_TEST": settings.MIN_TIME_TEST 
}, context_instance=RequestContext(request)

Answer 2

为了以其他人的答案为基础，您可以通过以下简单的方法来实现：

在您的设置文件中：

GLOBAL_SETTINGS = {
    'MIN_TIME_TEST': 'blah',
    'RANDOM_GLOBAL_VAR': 'blah',
}

然后，构建 John Mee 的上下文处理器：

def settings(request):
    """
    Put selected settings variables into the default template context
    """
    from django.conf import settings
    return settings.GLOBAL_SETTINGS

这将解决 DRY 问题。

或者，如果您只打算偶尔使用全局设置并希望从视图中调用它们：

def view_func(request):
    from django.conf import settings
    # function code here
    ctx = {} #context variables here
    ctx.update(settings.GLOBAL_SETTINGS)
    # whatever output you want here

Answer 3

考虑将其放入应用程序的 settings.py 中。当然，为了在模板中使用它，您需要将其像任何其他常用变量一样可供模板使用。

Answer 4

使用上下文处理器来让你的常量在所有模板中可用（settings.py 是定义它们的好地方，正如弗拉基米尔所说）。

Answer 5

上下文处理器更适合处理更动态的对象数据——它们被定义为 文档，并且在此处的许多帖子中，它们都被修改或传递给视图 - 模板可能会失去对全局信息的访问，因为例如您忘记了，这是没有意义的在视图中使用专门的上下文处理器。根据定义，数据是全球性的将视图与模板结合起来。

更好的方法是定义自定义模板标签。这样：

• 模板不依赖视图来将全局信息传递给它们，
• 它是干燥的：定义全局设置的应用程序可以导出到许多项目，消除项目之间的通用代码
• 模板决定它们是否有权访问全局信息，而不是视图函数

在下面的例子中，我处理了你的问题——加载到这个 MIN_TIME_TEST 变量中——以及我经常遇到的问题，加载到当我的环境改变时会改变的 URL。

我有 4 个环境 - 2 个开发环境和 2 个生产环境：

• Dev: django-web server, url: localhost:8000
• Dev: apache web server: url: sandbox.com ->解析为 127.0.0.1
• Prod 沙箱服务器，url：sandbox.domain.com
• Prod 服务器：url：domain.com

我在所有项目上都执行此操作将所有网址保存在文件 global_settings.py 中，以便可以通过代码访问。我定义了一个自定义模板标签 {% site_url %} ，可以（可选）加载到

我创建的名为 global_settings 的应用程序的任何模板中，并确保它包含在我的 settings.INSTALLED_APPS 元组中。

Django 使用 render() 方法将模板化文本编译到节点中，该方法告诉如何显示数据 - 我创建了一个对象，该对象通过根据传入的名称返回 global_settings.py 中的值来呈现数据。

它看起来像这样

from django import template
import global_settings

class GlobalSettingNode(template.Node):
    def __init__(self, settingname):
        self.settingname = settingname;
    def render(self, context):
        if hasattr(global_settings, self.settingname):
            return getattr(global_settings, self.settingname)
        else:
            raise template.TemplateSyntaxError('%s tag does not exist' % self.settingname)

： ，在 global_settings.py 中，我注册了几个标签：我的示例的 site_url 和您的示例的 min_test_time 。这样，当从模板调用 {% min_time_test %} 时，它将调用 get_min_time_test ，它解析为加载 value=5。在我的示例中，{% site_url %} 将执行基于名称的查找，以便我可以同时定义所有 4 个 URL 并选择我正在使用的环境。这对我来说比仅仅使用 Django 内置的 settings.Debug=True/False 标志更灵活。

from django import template
from templatenodes import GlobalSettingNode
register = template.Library()


MIN_TIME_TEST = 5

DEV_DJANGO_SITE_URL = 'http://localhost:8000/'
DEV_APACHE_SITE_URL = 'http://sandbox.com/'
PROD_SANDBOX_URL = 'http://sandbox.domain.com/'
PROD_URL = 'http://domain.com/'

CURRENT_ENVIRONMENT = 'DEV_DJANGO_SITE_URL'



def get_site_url(parser, token):
    return GlobalSettingNode(CURRENT_ENVIRONMENT)

def get_min_time_test(parser, token):
    return GlobalSettingNode('MIN_TIME_TEST')

register.tag('site_url', get_site_url)
register.tag('min_time_test', get_min_time_test)

请注意，为了使其正常工作，django 期望 global_settings.py 位于 Django 应用程序下名为 templatetags 的 python 打包中。我的 Django 应用程序称为 global_settings，因此我的目录结构如下所示：

/project-name/global_settings/templatetags/global_settings.py
等等。

最后模板选择是否在全局设置中加载，这有利于性能。将此行添加到您的模板中以公开在 global_settings.py 中注册的所有标记：

{% load global_settings %}

现在，需要 MIN_TIME_TEST 或公开的这些环境的其他项目可以简单地安装此应用程序 =)

Answer 6

在上下文处理器中，您可以使用以下内容：

import settings

context = {}
for item in dir(settings):
    #use some way to exclude __doc__, __name__, etc..
    if item[0:2] != '__':
        context[item] = getattr(settings, item)

Answer 7

John Mee 最后一部分的变体，对 Jordan Reiter 讨论的同一想法进行了一些阐述。

假设您的设置中有类似于 Jordan 建议的内容 - 换句话说，类似于：

GLOBAL_SETTINGS = {
   'SOME_CONST': 'thingy',
   'SOME_OTHER_CONST': 'other_thingy',
}

进一步假设您已经有一个字典，其中包含您想要传递模板的一些变量，可能作为参数传递给您的视图。我们将其命名为 my_dict。假设您希望 my_dict 中的值覆盖 settings.GLOBAL_SETTINGS 字典中的值。

您可以在您的视图中执行以下操作：

def my_view(request, *args, **kwargs)
    from django.conf import settings
    my_dict = some_kind_of_arg_parsing(*args,**kwargs)
    tmp = settings.GLOBAL_SETTINGS.copy()
    tmp.update(my_dict)
    my_dict = tmp
    render_to_response('the_template.html', my_dict, context_instance=RequestContext(request))

这使您可以全局确定可用于模板的设置，并且不需要您手动键入每个设置。

如果您没有任何额外的变量来传递模板，也不需要重写，您可以这样做

render_to_response('the_template.html', settings.GLOBAL_SETTINGS, context_instance=RequestContext(request))

： Jordan 所拥有的是，对于他来说，settings.GLOBAL_SETTINGS 会覆盖它与您的上下文字典可能共有的任何内容，而对于我的，我的上下文字典会覆盖 settings.GLOBAL_SETTINGS 。 YMMV。