repoze.bfg.httprequest 0.4.2

概述

该软件包的动机是鼓励使用请求类型适配而不是依赖于带有请求类型定义的软件包。

我们鼓励使用适配模式而不是继承请求接口

>>> from repoze.bfg.interfaces import IRequest
>>> IGZipRequest = IRequest({'http_accept_encoding': 'gzip'})

事件处理器监听INewRequest事件，并自动将请求标记为所需的接口，以适配请求到可能应用的请求类型。

为了完成上面的示例，一个请求将包含如下的HTTP环境

{‘http_accept_encoding’: ‘compress, gzip’}

由于我们已经将请求适配到‘gzip’的接受编码，适配机制将标记接口，使此环境与IGZipRequest接口匹配。

这将是子类化的替代方案，我们不需要手动设置事件监听器来解释请求环境并标记请求接口。

>>> class IGZipRequest(IRequest):
...     """Marker interface for requests for gzipped response."""

可调整的HTTP请求接口

假设我们想调整具有“http_accept_encoding”的请求，该请求要求返回gzip压缩的响应，我们将设置如下接口

>>> from repoze.bfg.interfaces import IRequest
>>> IGZipRequest = IRequest({'http_accept_encoding': 'gzip'})

现在让我们构建一个符合该接口的请求。

>>> class TestRequest(object):
...     interface.implements(IRequest)
...
...     def __init__(self, environ):
...         self.environ = environ

>>> request = TestRequest({'http_accept_encoding': 'compress, gzip'})

到目前为止，请求还没有为调整做好准备。

>>> from repoze.bfg.events import NewRequest
>>> from zope.event import notify
>>> notify(NewRequest(request))

我们期望请求实现IGZipRequest接口。

>>> IGZipRequest.providedBy(request)
True

为了获得更多灵活性，我们可以提供一个匹配函数

>>> IAlternativeGZipRequest = IRequest(
...    {'http_accept_encoding': lambda value: 'gzip' in value})

>>> notify(NewRequest(request))
>>> IAlternativeGZipRequest.providedBy(request)
True

假设现在我们还想支持德语文档的请求。

>>> IGermanLanguageRequest = IRequest({'http_accept_language': 'de'})

我们将创建一个新的请求，除了要求gzip压缩响应外，还要求内容为德语。

>>> request = TestRequest(
...     {'http_accept_encoding': 'compress, gzip', 'http_accept_language': 'de'})

>>> notify(NewRequest(request))

验证请求是否提供了调整后的接口。

>>> IGermanLanguageRequest.providedBy(request)
True

>>> IGZipRequest.providedBy(request)
True

现在，正如您所期望的，我们可以调整一个结合这两个环境的请求接口。

>>> IZippedGerman = IRequest(
...    {'http_accept_encoding': 'gzip', 'http_accept_language': 'de'})
>>> notify(NewRequest(request))

>>> IZippedGerman.providedBy(request)
True

请注意，此接口扩展了为它创建的每个环境对的两个接口。

>>> IZippedGerman.isOrExtends(IGermanLanguageRequest)
True

>>> IZippedGerman.isOrExtends(IGZipRequest)
True

让我们尝试一个不匹配的请求。

>>> IZippedFrench = IRequest(
...     {'http_accept_encoding': 'gzip', 'http_accept_language': 'fr'})
>>> notify(NewRequest(request))

>>> IZippedFrench.providedBy(request)
False

调整后的请求相对于环境是全局的

>>> IRequest({'http_accept_encoding': 'gzip'}) is IRequest({'http_accept_encoding': 'gzip'})
True