z3c.viewtemplate 0.4.1

ViewTemplate

此包允许我们将视图代码和视图模板的注册分离。

为什么这是好事？

在开发需要为我们特定的应用程序开发多个客户UI的可定制应用程序时，我们注意到皮肤和层之间有一个细微但清晰的区别。层包含准备数据以进行展示输出的逻辑，即视图类。另一方面，皮肤包含生成UI的资源，例如模板、图像和CSS文件。

现有基础设施的问题在于代码、模板和层都硬链接在一个视图组件的zcml配置指令中 – 页面、内容提供者、视图组件。此包将这个三元组 – 代码、模板、层 – 分离成两个对，代码/层和模板/皮肤。由于皮肤和层在物理上是相同的组件，因此没有引入额外的组件。

在使用此新方法设置视图组件之前，我们必须首先创建一个模板 …

>>> import os, tempfile
>>> temp_dir = tempfile.mkdtemp()
>>> template = os.path.join(temp_dir, 'demoTemplate.pt')
>>> open(template, 'w').write('''<div>demo</div>''')

以及视图代码

>>> from zope.publisher.browser import TestRequest
>>> request = TestRequest()

>>> from zope import interface
>>> from z3c.viewtemplate.baseview import BaseView
>>> class IMyView(interface.Interface):
...     pass
>>> class MyView(BaseView):
...     interface.implements(IMyView)

>>> view = MyView(root, request)

由于模板尚未注册，渲染视图将失败

>>> print view()
Traceback (most recent call last):
...
ComponentLookupError: ......

现在让我们注册模板（通常使用ZCML完成）

>>> from zope import component
>>> from zope.publisher.interfaces.browser import IDefaultBrowserLayer
>>> from z3c.viewtemplate.zcml import TemplateFactory
>>> from zope.pagetemplate.interfaces import IPageTemplate

模板工厂允许我们创建ViewPageTeplateFile实例。

>>> factory = TemplateFactory(template, None, 'text/html')

我们在视图接口和层上注册该工厂。

>>> component.provideAdapter(factory,
...            (interface.Interface, IDefaultBrowserLayer),
...            IPageTemplate)
>>> template = component.getMultiAdapter(
...               (view, request), IPageTemplate)
>>> template
<zope...viewpagetemplatefile.ViewPageTemplateFile ...>

现在我们已为默认层注册了模板，可以再次调用我们的视图。视图是一个内容提供者，所以在调用其更新方法之前会触发一个BeforeUpdateEvent。

>>> events = []
>>> component.provideHandler(events.append, (None,))
>>> print view()
<div>demo</div>
>>> events
[<zope.contentprovider.interfaces.BeforeUpdateEvent object at ...>]

现在我们在视图的特定接口上注册一个新模板。

>>> myTemplate = os.path.join(temp_dir, 'myViewTemplate.pt')
>>> open(myTemplate, 'w').write('''<div>IMyView</div>''')
>>> factory = TemplateFactory(myTemplate, None, 'text/html')
>>> component.provideAdapter(factory,
...            (IMyView, IDefaultBrowserLayer),
...            IPageTemplate)
>>> print view()
<div>IMyView</div>

我们还可以用设置了调试标志的方式渲染视图。

>>> request.debug.sourceAnnotations = True
>>> print view()
<!--
==============================================================================
...myViewTemplate.pt
==============================================================================
--><div>IMyView</div>
>>> request.debug.sourceAnnotations = False

可以直接提供模板。

我们创建了一个新模板。

>>> viewTemplate = os.path.join(temp_dir, 'viewTemplate.pt')
>>> open(viewTemplate, 'w').write('''<div>view</div>''')

>>> from zope.app.pagetemplate.viewpagetemplatefile import ViewPageTemplateFile
>>> class MyViewWithTemplate(BaseView):
...     interface.implements(IMyView)
...     template = ViewPageTemplateFile(viewTemplate)
>>> templatedView = MyViewWithTemplate(root, request)

如果我们渲染这个视图，我们得到的是原始模板，而不是注册的模板。

>>> print templatedView()
<div>view</div>

宏的使用。

>>> macroTemplate = os.path.join(temp_dir, 'macroTemplate.pt')
>>> open(macroTemplate, 'w').write('''
...   <metal:block define-macro="macro1">
...     <div>macro1</div>
...   </metal:block>
...   <metal:block define-macro="macro2">
...   <div tal:content="options/foo">macro2</div>
...   </metal:block>
...   ''')

>>> factory = TemplateFactory(macroTemplate, 'macro1', 'text/html')
>>> print factory(view, request)()
<div>macro1</div>

由于可以为视图小部件传递选项，让我们验证宏是否也可以这样做。

>>> factory = TemplateFactory(macroTemplate, 'macro2', 'text/html')
>>> print factory(view, request)(foo='bar')
<div>bar</div>

为什么我们没有使用来自zope.formlib包的命名模板呢？

尽管命名模板允许我们将视图代码与模板注册分离，但它们不能注册到特定的层，这使得使用命名模板实现多个皮肤变得不可能。

变更