在 django 中创建我自己的上下文处理器

Question

我已经到了需要将某些变量传递给我的所有视图（主要是自定义身份验证类型变量）的地步。

有人告诉我编写自己的上下文处理器是执行此操作的最佳方法，但我遇到了一些问题。

我的设置文件如下所示

TEMPLATE_CONTEXT_PROCESSORS = (
    "django.contrib.auth.context_processors.auth",
    "django.core.context_processors.debug",
    "django.core.context_processors.i18n",
    "django.core.context_processors.media",
    "django.contrib.messages.context_processors.messages",
    "sandbox.context_processors.say_hello", 
)

如您所见，我有一个名为“context_processors”的模块和一个名为“say_hello”的函数。

看起来

def say_hello(request):
        return {
            'say_hello':"Hello",
        }

我是否正确地假设我现在可以在我的观点范围内执行以下操作？

{{ say_hello }}

现在，这在我的模板中没有呈现任何内容。

我的观点看起来像

from django.shortcuts import render_to_response

def test(request):
        return render_to_response("test.html")

Answer 1

您编写的上下文处理器应该可以工作。问题出在你的看法上。

您确定您的视图是通过 RequestContext 渲染的吗？

例如：

def test_view(request):
    return render_to_response('template.html')

上面的视图不会使用TEMPLATE_CONTEXT_PROCESSORS中列出的上下文处理器。确保您提供一个 RequestContext ，如下所示：

def test_view(request):
    return render_to_response('template.html', context_instance=RequestContext(request))

Answer 2

根据 django 文档 您可以使用render 作为快捷方式，而不是带有 context_instance 参数的 render_to_response：

或者，使用 render() 快捷方式，该快捷方式与使用 context_instance 参数调用 render_to_response() 相同，强制使用 RequestContext。

Answer 3

假设您有这样的文件结构：

YourDjangoProject
├───project
│   ├───__init__.py
│   ├───asgi.py
│   ├───settings.py
│   ├───urls.py
│   └───wsgi.py
├───.env
├───manage.py
└───db.sqlite3

1) 在任何位置创建一个 context_processors.py 文件

我将在项目文件夹中创建一个（使用 settings.py）：

YourDjangoProject
└───project
    ├───...
    └───context_processors.py

2) 创建一个context_processors.py 中接受 HttpRequest 对象作为参数并返回字典的函数

上下文处理器只是一个接受 HttpRequest 对象作为参数并返回字典的函数。

像这样：

# project/context_processors.py

def site_email(request):
    return {'site_email': '[email protected]'}

3) 将其添加到 settings.py 中的 context_processors 设置（出于安全原因位于底部）

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR / 'config' / 'templates'],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
                'project.context_processors.site_email',  # <- New context processor here
            ],
        },
    },
]

现在，您将能够访问整个网站上每个 django 模板上的“site_email”模板变量。

祝您编码愉快！

Answer 4

从 Django 1.8 开始，您可以像这样注册自定义上下文处理器：

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [
            'templates'
        ],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
                'www.context_processors.instance',
            ],
        },
    },
]

假设您的上下文处理器位于应用程序 www 的 context_processors.py 中

Answer 5

如果您使用 Django 的 render_to_response() 快捷方式用字典的内容填充模板，则默认情况下将向您的模板传递一个 Context 实例（而不是 RequestContext） 。要在模板渲染中使用 RequestContext，请使用 render() 快捷方式，该快捷方式与使用 render_to_response() 进行调用相同code>context_instance 参数强制使用 RequestContext。