plone.transformchain 3.0.1

简介

plone.transformchain 提供了修改使用 repoze.zope2 或“经典” ZPublisher 发布的页面响应的方法，在将其返回给浏览器之前。

注册一个名为（发布，请求）的独特适配器，提供 ITransform 接口。 published 是发布的对象，例如视图；request 是当前请求。

可以通过适配器的 order 属性来维持转换的顺序。

将根据从发布者获取的输入类型和/或之前的方法调用三种方法之一。

• transformBytes() 在输入是 str（字节）对象时被调用

• transformUnicode() 在输入是 unicode 对象时被调用

• transformIterable() 在输入是其他类型的可迭代对象时被调用

每个阶段可以返回字节字符串、unicode 字符串或可迭代对象。

大多数转换器将具有“自然”的结果表示，并将实现相应的方法以返回相同表示的另一个值，例如实现 transformUnicode() 以转换并返回 unicode 对象。其他方法可以实施为返回 None（不执行任何操作）或将值转换为适当的类型。

链中的第一个转换器可能会得到

• 如果转换器在标准 Zope 2 ZPublisher 下运行，则为字节字符串。

• 如果转换器在 repoze.zope2 或另一个 WSGI 管道下运行，则为可迭代对象。

检查 self.request.response.getHeader('content-type') 以查看结果的类型。当可迭代对象展开时，它将符合此类型，例如对于“text/html”，''.join(result) 应该是一个 HTML 字符串。

返回值将传递给链中的下一个转换。最终的转换应该返回 unicode 字符串、编码字符串或可迭代对象。

如果链中的最后一个转换返回字节字符串或 unicode 字符串，则 Content-Length 标头将自动更新。

返回 None 以表示结果不应从之前的转换中更改。

以下是一个将所有内容转换为大写的示例

from zope.component import adapter
from zope.interface import implementer
from zope.interface import Interface
from plone.transformchain.interfaces import ITransform

@implementer(ITransform)
@adapter(Interface, Interface) # any context, any request
class UpperTransform(object):

    order = 1000

    def __init__(self, published, request):
        self.published = published
        self.request = request

    def transformBytes(self, result, encoding):
        return result.upper()

    def transformUnicode(self, result, encoding):
        return result.upper()

    def transformIterable(self, result, encoding):
        return [s.upper() for s in result]

您可以在 ZCML 中注册此内容

<adapter factory=".transforms.UpperTransform" name="example.uppertransform" />

如果您需要关闭特定请求的转换，可以在 request.environ 中设置一个键

request.environ['plone.transformchain.disable'] = True

这将保留响应不变，并且不会调用任何 ITransform 适配器。

变更日志