自定义模板加载器 Django

Posted 2023-02-24

【中文标题】自定义模板加载器 Django

【英文标题】：custom template loader Django

【发布时间】：2019-06-06 05:17:37

【问题描述】：

我正在尝试在 django 中编写一个自定义模板加载器，它服务于 s3 存储桶中存在的 index.html。以下是我的加载器文件

from django.conf import settings
from django.template import Origin, Engine
from django.template.loader import TemplateDoesNotExist
from django.template.loaders.base import Loader
from boto3.session import Session

ACCESS_KEY_NAME = getattr(settings, 'AWS_TEMPLATE_LOADING_ACCESS_KEY_ID', getattr(settings, 'AWS_TEMPLATE_LOADING_ACCESS_KEY_ID', None))
SECRET_KEY_NAME = getattr(settings, 'AWS_TEMPLATE_LOADING_SECRET_ACCESS_KEY', getattr(settings, 'AWS_TEMPLATE_LOADING_SECRET_ACCESS_KEY', None))
TEMPLATE_BUCKET = getattr(settings, 'AWS_TEMPLATE_BUCKET_NAME')


class Loader(Loader):
    is_usable = True

    def __init__(self, *args, **kwargs):
        params = args[0]
        options = params.pop('OPTIONS').copy()
        options.setdefault('autoescape', True)
        options.setdefault('debug', settings.DEBUG)
        options.setdefault('file_charset', settings.FILE_CHARSET)
        libraries = options.get('libraries', )
        session = Session(aws_access_key_id=ACCESS_KEY_NAME,
                          aws_secret_access_key=SECRET_KEY_NAME)
        s3 = session.resource('s3')
        self.bucket = s3.Bucket(TEMPLATE_BUCKET)
        super(Loader, self).__init__(*args, **kwargs)
        self.engine = Engine(dirs=params['DIRS'], context_processors=options, loaders=Loader)

    def getKeys(self):
        keys_objects = []
        for obj in self.bucket.objects.all():
            key = obj.key
            keys_objects.append(
                'key': key,
                'object': obj
            )
        return keys_objects

    def get_contents(self, origin):
        try:
            keys_objects = self.getKeys()
            for key_object in keys_objects:
                if key_object['key'] == origin:
                    return key_object['object'].get()['Body'].read()
        except FileNotFoundError:
            raise TemplateDoesNotExist(origin)


    def get_template_sources(self, template_name, template_dirs=None):
        tried = []
        yield Origin(
            name=template_name,
            template_name=template_name,
            loader=self,
        )
        tried.append('/index.html')
        if tried:
            error_msg = "Tried Keys %s" % tried
        else:
            error_msg = "Your TEMPLATE_DIRS setting is empty. Change it to point to at least one template directory."
        raise TemplateDoesNotExist(error_msg)

    get_template_sources.is_usable = True

在我的设置中，我已经按照以下方式设置了模板设置。

TEMPLATES = [
    
        'BACKEND': 'app.s3template_loader.Loader',
        'DIRS': [
            'index.html'
        ],
        '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',
            ],
        ,
    
]

以下是我的看法

from django.shortcuts import render
from django.views.generic import TemplateView

# Create your views here.


class AngularAppView(TemplateView):
    template_name = 'index.html'

但是当我尝试访问我的终点时，我得到了

内部服务器错误：/ Traceback（最近一次调用最后一次）：文件 "/usr/local/lib/python3.6/site-packages/django/core/handlers/exception.py", 第 41 行，在内部 response = get_response(request) 文件“/usr/local/lib/python3.6/site-packages/django/core/handlers/base.py”, 第 217 行，在 _get_response response = self.process_exception_by_middleware(e, request) 文件 "/usr/local/lib/python3.6/site-packages/django/core/handlers/base.py", 第 215 行，在 _get_response 中 response = response.render() 文件“/usr/local/lib/python3.6/site-packages/django/template/response.py”, 第 107 行，在渲染中 self.content = self.rendered_content 文件“/usr/local/lib/python3.6/site-packages/django/template/response.py”， 第 84 行，在 render_content 中 content = template.render(context, self._request) TypeError: render() 接受 2 个位置参数，但给出了 3 个

我无法找到我做错了什么。任何帮助表示赞赏。

【参考方案1】：

您构建了一个加载器，但您将它用作后端/引擎。试试这个配置：

TEMPLATES = [
    
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [
            'index.html'
        ],
        'APP_DIRS': True,
        'OPTIONS': 
            'loaders': ['app.s3template_loader.Loader'],
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        ,
    
]

请注意，设置 OPTIONS['loaders'] 将禁用缓存。请参阅cached.Loader 上的文档。

【讨论】：

感谢您的共鸣。你能告诉我如何在我的 TEMPLATES 数组中使用多个引擎吗？

您想要多个引擎（Django、Jinja2...）还是多个加载器（您的 S3 加载器、文件系统加载器...）？

我想要多个引擎，Django 不是多个加载器

TEMPLATES 是一个列表，只需添加多个条目。有关更多详细信息，我建议提出一个新问题:)

我正在添加多个输入，但我得到 模板引擎别名不是唯一的，重复：django.在 settings.TEMPLATES 中为每个引擎设置一个唯一的名称。