z3c.pt 4.4

页面模板

>>> from z3c.pt.pagetemplate import PageTemplate
>>> from z3c.pt.pagetemplate import PageTemplateFile

使用字符串初始化PageTemplate类。

>>> template = PageTemplate("""\
... <div xmlns="http://www.w3.org/1999/xhtml">
...   Hello World!
... </div>""")

>>> print(template())
<div xmlns="http://www.w3.org/1999/xhtml">
  Hello World!
</div>

使用磁盘上模板文件的绝对路径初始化PageTemplateFile类。

>>> template_file = PageTemplateFile('tests/helloworld.pt')
>>> print(template_file())
<div xmlns="http://www.w3.org/1999/xhtml">
  Hello World!
</div>

>>> import os
>>> os.path.isabs(template_file.filename)
True

如果没有提供content_type并且请求中也没有，它将设置为‘text/html’。

>>> class Response(object):
...     def __init__(self):
...         self.headers = {}
...         self.getHeader = self.headers.get
...         self.setHeader = self.headers.__setitem__

>>> class Request(object):
...     def __init__(self):
...         self.response = Response()

>>> template_file = PageTemplateFile('tests/helloworld.pt')
>>> request = Request()
>>> print(request.response.getHeader('Content-Type'))
None

>>> template = template_file.bind(None, request=request)
>>> print(template())
<div xmlns="http://www.w3.org/1999/xhtml">
  Hello World!
</div>

>>> print(request.response.getHeader('Content-Type'))
text/html

如果请求中存在content_type，则不覆盖它。

>>> request = Request()
>>> request.response.setHeader('Content-Type', 'text/xml')
>>> print(request.response.getHeader('Content-Type'))
text/xml

>>> template = template_file.bind(None, request=request)
>>> print(template())
<div xmlns="http://www.w3.org/1999/xhtml">
  Hello World!
</div>

>>> print(request.response.getHeader('Content-Type'))
text/xml

content_type也可以在实例化时设置，并且将被尊重。

>>> template_file = PageTemplateFile('tests/helloworld.pt',
...                                  content_type='application/rdf+xml')

>>> request = Request()
>>> print(request.response.getHeader('Content-Type'))
None

>>> template = template_file.bind(None, request=request)
>>> print(template())
<div xmlns="http://www.w3.org/1999/xhtml">
  Hello World!
</div>

>>> print(request.response.getHeader('Content-Type'))
application/rdf+xml

两者都可以用作类属性（属性）。

>>> class MyClass(object):
...     template = PageTemplate("""\
...       <div xmlns="http://www.w3.org/1999/xhtml">
...          Hello World!
...       </div>""")
...
...     template_file = PageTemplateFile('tests/helloworld.pt')

>>> instance = MyClass()
>>> print(instance.template())
<div xmlns="http://www.w3.org/1999/xhtml">
  Hello World!
</div>

>>> print(instance.template_file())
<div xmlns="http://www.w3.org/1999/xhtml">
  Hello World!
</div>

视图页面模板

>>> from z3c.pt.pagetemplate import ViewPageTemplate
>>> from z3c.pt.pagetemplate import ViewPageTemplateFile

>>> class View(object):
...     request = u'request'
...     context = u'context'
...
...     def __repr__(self):
...         return 'view'

>>> view = View()

与之前一样，我们可以使用字符串初始化视图页面模板（这里偶然从磁盘加载）。

>>> from z3c.pt import tests
>>> path = tests.__path__[0]
>>> with open(path + '/view.pt') as f:
...     template = ViewPageTemplate(f.read())

要在视图的上下文中渲染模板，我们将模板绑定并传递视图作为参数（视图页面模板从property-类派生，通常定义在视图类的一个属性上）。

>>> print(template.bind(view)(test=u'test'))
<div xmlns="http://www.w3.org/1999/xhtml">
  <span>view</span>
  <span>context</span>
  <span>request</span>
  <span>test</span>
  <span>test</span>
</div>

对于基于文件的变体，操作类似。

>>> template = ViewPageTemplateFile('tests/view.pt')
>>> print(template.bind(view)(test=u'test'))
<div xmlns="http://www.w3.org/1999/xhtml">
  <span>view</span>
  <span>context</span>
  <span>request</span>
  <span>test</span>
  <span>test</span>
</div>

出于兼容性原因，视图模板可以使用替代的上下文和请求调用。

>>> print(template(view, u"alt_context", "alt_request", test=u'test'))
<div xmlns="http://www.w3.org/1999/xhtml">
  <span>view</span>
  <span>alt_context</span>
  <span>alt_request</span>
  <span>test</span>
  <span>test</span>
</div>

非关键字参数

这些作为options/args传入，当使用__call__方法时。

>>> print(PageTemplate("""\
... <div xmlns="http://www.w3.org/1999/xhtml">
...   <div tal:repeat="arg options/args">
...      <span tal:content="arg" />
...   </div>
... </div>""").__call__(1, 2, 3))
<div xmlns="http://www.w3.org/1999/xhtml">
  <div>
     <span>1</span>
  </div>
  <div>
     <span>2</span>
  </div>
  <div>
     <span>3</span>
  </div>
</div>

全局‘path’函数

与zope.pagetemplate一样，在z3c.pt中可以使用全局定义的path()函数在python表达式中。

>>> template = PageTemplate("""\
... <div xmlns="http://www.w3.org/1999/xhtml">
...   <span tal:content="options/test" />
...   <span tal:content="python: path('options/test')" />
... </div>""")

>>> print(template(test='test'))
<div xmlns="http://www.w3.org/1999/xhtml">
  <span>test</span>
  <span>test</span>
</div>

全局‘exists’函数

这同样适用于exists()函数。

>>> template = PageTemplate("""\
... <div xmlns="http://www.w3.org/1999/xhtml">
...   <span tal:content="python: exists('options/test') and 'Yes' or 'No'" />
... </div>""")

>>> print(template(test='test'))
<div xmlns="http://www.w3.org/1999/xhtml">
  <span>Yes</span>
</div>

‘default’和路径表达式

标准ZPT的另一个功能：使用‘default’表示如果条件不满足，将输出包含在HTML中的任何内容。

这对于属性有效

>>> template = PageTemplate("""\
... <div xmlns="http://www.w3.org/1999/xhtml">
...   <span tal:attributes="class options/not-existing | default"
...         class="blue">i'm blue</span>
... </div>""")

>>> print(template())
<div xmlns="http://www.w3.org/1999/xhtml">
  <span class="blue">i'm blue</span>
</div>

也适用于内容

>>> template = PageTemplate("""\
... <div xmlns="http://www.w3.org/1999/xhtml">
...   <span tal:content="options/not-existing | default">default content</span>
... </div>""")

>>> print(template())
<div xmlns="http://www.w3.org/1999/xhtml">
  <span>default content</span>
</div>

‘exists’类型表达式

在非全局名称和全局名称上使用‘exists()’函数

>>> template = PageTemplate("""\
... <div xmlns="http://www.w3.org/1999/xhtml">
...   <span tal:content="python: exists('options/nope') and 'Yes' or 'No'">do I exist?</span>
...   <span tal:content="python: exists('nope') and 'Yes' or 'No'">do I exist?</span>
... </div>""")

>>> print(template())
<div xmlns="http://www.w3.org/1999/xhtml">
  <span>No</span>
  <span>No</span>
</div>

在非全局名称和全局名称上使用‘exists:’表达式

>>> template = PageTemplate("""\
... <div xmlns="http://www.w3.org/1999/xhtml">
...   <span tal:define="yup exists:options/nope"
...         tal:content="python: yup and 'Yes' or 'No'">do I exist?</span>
...   <span tal:define="yup exists:nope"
...         tal:content="python: yup and 'Yes' or 'No'">do I exist?</span>
... </div>""")

>>> print(template())
<div xmlns="http://www.w3.org/1999/xhtml">
  <span>No</span>
  <span>No</span>
</div>

与否定一起使用‘exists:’

>>> print(PageTemplate("""\
... <div xmlns="http://www.w3.org/1999/xhtml">
...   <span tal:condition="not:exists:options/nope">I don't exist?</span>
... </div>""")())
<div xmlns="http://www.w3.org/1999/xhtml">
  <span>I don't exist?</span>
</div>

字典的路径表达式

路径表达式优先选择字典项而不是字典属性。

>>> print(PageTemplate("""\
... <div xmlns="http://www.w3.org/1999/xhtml"
...      tal:define="links python:{'copy':'XXX', 'delete':'YYY'}">
...   <span tal:content="links/copy">ZZZ</span>
... </div>""")())
<div xmlns="http://www.w3.org/1999/xhtml">
  <span>XXX</span>
</div>

一个标签中的变量永远不会泄漏到另一个标签中

>>> body = """\
... <div xmlns="http://www.w3.org/1999/xhtml"
...      xmlns:tal="http://xml.zope.org/namespaces/tal"
...      xmlns:metal="http://xml.zope.org/namespaces/metal">
...   <div class="macro" metal:define-macro="greeting"
...        tal:define="greeting greeting|string:'Hey'">
...       <span tal:replace="greeting" />
...   </div>
...   <div tal:define="greeting string:'Hello'">
...     <metal:block metal:use-macro="python:template.macros['greeting']" />
...   </div>
...   <div>
...     <metal:block metal:use-macro="python:template.macros['greeting']" />
...   </div>
... </div>"""
>>> print(PageTemplate(body)())
<div xmlns="http://www.w3.org/1999/xhtml">
  <div class="macro">
      'Hey'
  </div>
  <div>
    <div class="macro">
      'Hello'
  </div>
<BLANKLINE>
</div>
  <div>
    <div class="macro">
      'Hey'
  </div>
<BLANKLINE>
</div>
</div>

TALES函数命名空间

如http://wiki.zope.org/zope3/talesns.html中所述，可以实施自定义TALES命名空间适配器。我们还支持低级TALES函数命名空间（TALES命名空间适配器基于此构建）。

>>> import datetime
>>> import zope.interface
>>> import zope.component
>>> from zope.traversing.interfaces import ITraversable
>>> from zope.traversing.interfaces import IPathAdapter
>>> from zope.tales.interfaces import ITALESFunctionNamespace
>>> from z3c.pt.namespaces import function_namespaces

>>> @zope.interface.implementer(ITALESFunctionNamespace)
... class ns1(object):
...     def __init__(self, context):
...         self.context = context
...     def parent(self):
...         return self.context.parent

>>> function_namespaces.namespaces['ns1'] = ns1

>>> class ns2(object):
...     def __init__(self, context):
...         self.context = context
...     def upper(self):
...         return self.context.upper()

>>> zope.component.getGlobalSiteManager().registerAdapter(
...     ns2, [zope.interface.Interface], IPathAdapter, 'ns2')

>>> class ns3(object):
...     def __init__(self, context):
...         self.context = context
...     def fullDateTime(self):
...         return self.context.strftime('%Y-%m-%d %H:%M:%S')

>>> zope.component.getGlobalSiteManager().registerAdapter(
...     ns3, [zope.interface.Interface], IPathAdapter, 'ns3')

来自遗留应用程序的一个真正边缘案例：TALES命名空间适配器没有可调用的函数，而是遍历剩余的路径

>>> from zope.traversing.interfaces import TraversalError

>>> @zope.interface.implementer(ITraversable)
... class ns4(object):
...
...     def __init__(self, context):
...         self.context = context
...
...     def traverse(self, name, furtherPath):
...         if name == 'page':
...             if len(furtherPath) == 1:
...                 pagetype = furtherPath.pop()
...             elif not furtherPath:
...                 pagetype = 'default'
...             else:
...                 raise TraversalError("Max 1 path segment after ns4:page")
...             return self._page(pagetype)
...         if len(furtherPath) == 1:
...              name = '%s/%s' % (name, furtherPath.pop())
...         return 'traversed: ' + name
...
...     def _page(self, pagetype):
...         return 'called page: ' + pagetype

>>> zope.component.getGlobalSiteManager().registerAdapter(
...     ns4, [zope.interface.Interface], IPathAdapter, 'ns4')

>>> @zope.interface.implementer(ITraversable)
... class ns5(object):
...
...     def __init__(self, context):
...         self.context = context
...
...     def traverse(self, name, furtherPath):
...         name = '/'.join([name] + furtherPath[::-1])
...         del furtherPath[:]
...         return 'traversed: ' + name

>>> zope.component.getGlobalSiteManager().registerAdapter(
...     ns5, [zope.interface.Interface], IPathAdapter, 'ns5')

>>> class Ob(object):
...     def __init__(self, title, date, parent=None, child=None):
...         self.title = title
...         self.date = date
...         self.parent = parent
...         self.child = child

>>> child = Ob('child', datetime.datetime(2008, 12, 30, 13, 48, 0, 0))
>>> father = Ob('father', datetime.datetime(1978, 12, 30, 13, 48, 0, 0))
>>> grandpa = Ob('grandpa', datetime.datetime(1948, 12, 30, 13, 48, 0, 0))

>>> child.parent = father
>>> father.child = child
>>> father.parent = grandpa
>>> grandpa.child = father

>>> class View(object):
...     request = u'request'
...     context = father
...
...     def __repr__(self):
...         return 'view'

>>> view = View()
>>> template = ViewPageTemplateFile('tests/function_namespaces.pt')
>>> print(template.bind(view)())
<div xmlns="http://www.w3.org/1999/xhtml">
  <span>GRANDPA</span>
  <span>2008-12-30 13:48:00</span>
  <span>traversed: link:main</span>
  <span>called page: default</span>
  <span>called page: another</span>
  <span></span>
  <span>traversed: zope.Public</span>
  <span>traversed: text-to-html</span>
  <span>traversed: page/yet/even/another</span>
</div>

4.4 (2024-08-07)

• 扩展布尔html属性列表以包括所有html5布尔属性。

4.3 (2024-02-01)

• 添加对Python 3.12的支持。

• 修复Windows测试兼容性。

4.2 (2024-01-31)

• 添加对“结构”表达式类型的支持。（问题 #17）。

• 更新测试套件以与较新的Chameleon版本兼容。

4.1 (2024-01-09)

• 提供自己的接口，因为Chameleon不会在未来版本中提供这些接口。

4.0 (2023-03-27)

• 添加对Python 3.11的支持。

• 停止对Python 2.7，3.5，3.6的支持。

3.3.1 (2021-12-17)

• 添加对Python 3.9和3.10的支持。

3.3.0 (2020-03-31)

• 停止对Python 3.4的支持

• 添加对Python 3.8的支持。

• 防止在注释中插值（即$$*var*, $$${*path*}``替换）。

3.2.0 (2019-01-05)

• 添加对Python 3.7的支持。

• 停止使用python setup.py test运行测试。

3.1.0 (2017-10-17)

• 增加对Python 3.6的支持。

• 放弃对Python 3.3的支持。

• 如果可用，使用来自zope.pagetemplate的适配器命名空间，而不是使用zope.app.pagetemplate中的向后兼容层。参见问题3。

• 增加string和nocall函数，以便在Python表达式中使用。参见问题2。

• 使绑定页面模板具有__self__和__func__属性，使其更像Python 3的绑定方法。（im_func和im_self仍然可用。）参见问题9。

3.0 (2016-09-02)

• 增加了对Python 3.4、3.5、PyPy和PyPy3的支持。

• 放弃对Python 2.6的支持。

3.0.0a1（2013-02-25）

兼容性

• 增加对Python 3.3的支持。

• 向chameleon.i18n添加一个小补丁以定义basestring。

错误修正

• 允许路径表达式的部分以数字开头。

2.2.3 (2012-06-01)

兼容性

• 翻译函数现在接受（但忽略）一个context参数。这解决了与Chameleon 2.9.x的兼容性问题。

2.2.2 (2012-04-24)

错误修正

• 不要依赖于“LANGUAGE”请求键来跳过语言协商。相反，我们假设协商成本低（并且可能已缓存）。

2.2.1 (2012-02-15)

• 仅要求Chameleon >= 2.4，在上一个版本中无意义地提高了。

• 添加测试额外，从buildout.cfg中删除版本。

2.2 (2012-01-08)

功能

• 属性之间的空白现在减少到单个空白字符。

• request符号不再需要来评估路径表达式；如果没有在命名空间中提供，它现在默认为None。

错误修正

• 内容提供者表达式现在正确应用TAL命名空间数据。

变更

• 已删除ZopeTraverser类，并用一个简单函数替换。

2.1.5 (2011-11-24)

• 如果可用，使用非严格模式以与仅在评估时间编译表达式的引用引擎兼容。

2.1.4 (2011-09-14)

• 提供者表达式现在首先作为字符串表达式评估，其结果用作内容提供者名称。

  这修复了一个问题，即（提供者-）字符串表达式不会得到正确评估，例如provider: ${mgr}。

2.1.3 (2011-08-22)

• 配置HTML布尔属性（仅在HTML模式中）

  "compact", "nowrap", "ismap", "declare", "noshade",
  "checked", "disabled", "readonly", "multiple", "selected",
  "noresize", "defer"

2.1.2 (2011-08-19)

• 启用选项literal_false以获得当值为False时不会删除属性的行为。

2.1.1 (2011-08-11)

• 确保内置名称“path”和“exists”可以被重定义。

• 使用ProxyFactory防止sys.modules（映射到内置变量“modules”）在导入时产生副作用。

2.1 (2011-07-28)

• 使用Chameleon附带的动力表达式评估框架。

2.0 (2011-07-14)

• 点发布。

• 将特定于实现的上下文设置移至render方法。这允许使用已准备好的上下文的模板类。

• 修复了Zope遍历器编译器上的调用标志问题。

2.0-rc3（2011-07-11）

• Python表达式不再是TALES表达式；之前，管道操作符会分割Python表达式子句，即使对于Python表达式也允许回退，但这不是ZPT的标准行为。

• 修复了在动态path或exists评估中发生错误，由于缺少远程上下文而无法传播的问题。

• 将变量here和context设置为PageTemplate实例上的绑定实例值。

2.0-rc2（2011-03-24）

• 修复了与"exists:"表达式的问题，其中会尝试调用可调用对象。现在，这个表达式类型隐含地表示它应该使用"nocall:"说明。

2.0-rc1（2011-02-28）

• 更新到Chameleon 2.0。

  本版本包含许多更改，并是对1.x系列的全面重写。

  平台

  • 现在需要Python 2.5及以上版本。

  显著变化

  • 表达式插值始终启用。

  • 空白输出不同，现在与模板输入紧密对齐。

  • 新的语言结构

    1. tal:on-error

    2. tal:switch

    3. tal:case

  不兼容性

  • 表达式翻译接口已被表达式引擎取代。这意味着所有表达式都必须重写。

• 存在表达式评估器应忽略KeyError异常。

• 特殊处理Zope2的Missing.MV，如Products.ZCatalog在LP#649343中所述。[rossp]