grokcore.message 4.0

设置grokcore.message

当被grok处理时，grokcore.message注册：

• 一个名为“session”的全局会话消息源。

• 一个全局消息接收器。

此包的grok处理发生在执行本地configure.zcml时。在基于Grok的标准包中，这通常自动发生。

当然，也可以手动grok这个包

>>> import grokcore.component as grok
>>> grok.testing.grok('grokcore.message')

这设置了一个全局消息接收器

>>> from z3c.flashmessage.interfaces import IMessageReceiver
>>> from zope.component import getUtility
>>> getUtility(IMessageReceiver)
<z3c.flashmessage.receiver.GlobalMessageReceiver object at 0x...>

它还设置了一个名为“session”的基于会话的消息源

>>> from z3c.flashmessage.interfaces import IMessageSource
>>> getUtility(IMessageSource, name=u'session')
<z3c.flashmessage.sources.SessionMessageSource object at 0x...>

我们还提供了一个可以由包含“ram.zcml”来启用且默认未注册的RAM存储消息源

>>> getUtility(IMessageSource, name=u'ram')
Traceback (most recent call last):
...
zope.interface.interfaces.ComponentLookupError: (<InterfaceClass z3c.flashmessage.interfaces.IMessageSource>, 'ram')

您可以通过在ZCML设置中包含来自“grokcore.message”的“ram.zcml”来启用此源，如下所示

<configure xmlns="http://namespaces.zope.org/zope">
  <include package="grokcore.message" file="ram.zcml" />
</configure>

或者，当然，通过手动注册RAMMessageSource

>>> from zope.component import provideUtility
>>> from z3c.flashmessage.sources import RAMMessageSource
>>> ram_source = RAMMessageSource()
>>> provideUtility(ram_source, name=u'ram')

现在我们可以获取RAM源

>>> getUtility(IMessageSource, name=u'ram')
<z3c.flashmessage.sources.RAMMessageSource object at 0x...>

组件（API）

grokcore.message除了从z3c.flashmessage提供的常规组件外，还提供了一些额外的组件和函数。

示例

创建一个 UniqueMessageSource

>>> from grokcore.message import UniqueMessageSource
>>> class MyUniqueMessageSource(UniqueMessageSource):
...   grok.name('uniq_source')

在解析后，源将自动注册

>>> grok.testing.grok_component(
...     'MyUniqueMessageSource', MyUniqueMessageSource,
...     dotted_name='grokcore.message.tests')
True

>>> source = getUtility(IMessageSource, name='uniq_source')
>>> source
<...MyUniqueMessageSource object at 0x...>

它提供了由 IMessageSource 接口要求的方法

>>> from z3c.flashmessage.interfaces import IMessageSource
>>> from zope.interface import verify

>>> verify.verifyClass(IMessageSource, MyUniqueMessageSource)
True

我们可以列出存储在源中的消息

>>> source.list()
<generator object ...>

>>> list(source.list())
[]

>>> source.send(message='Hello!', type='message')
>>> list(source.list())
[<z3c.flashmessage.message.PersistentMessage object at 0x...>]

>>> print(list(source.list())[0].message)
Hello!

当我们发送另一条消息时，旧的消息将被默默地丢弃

>>> source.send(message='Hello again!', type='message')
>>> len(list(source.list()))
1

>>> print(list(source.list())[0].message)
Hello again!

我们可以删除消息

>>> msg = list(source.list())[0]
>>> source.delete(msg)
>>> len(list(source.list()))
0

方便函数的示例可以在上方找到。

4.0 (2023-08-28)

• 停止支持 Python 2.7, 3.4, 3.5, 3.6。

• 添加对 Python 3.7, 3.8, 3.9, 3.10, 3.11 的支持。

3.0.1 (2018-01-17)

• 在整个文档中用 @grok.implementer() 指令替换 grok.implements() 的使用。

3.0.0 (2018-01-15)

• Python 3 兼容性。

0.4.3 (2016-02-15)

• 更新测试。

0.4.2 (2010-10-25)

• 通过显式注册 IClientIdManager 和 ISessionDataContainer 工具修复了测试。为此重新引入了 ftesting.zcml。

0.4.1 (2010-10-25)

• 删除不再必要的 ftesting.zcml。

0.4 (2010-10-25)

• 确保 zope.session 已配置，因为该包声称提供基于会话的闪存消息机制。

• 使包符合 zope.org 存储库策略。

0.3 (2010-03-05)

• UniqueMessageSource 现在完全实现了 IMessageSource 接口，即使用 UniqueMessageSource.send() 时，type 参数现在是可选的。

0.2 (2010-03-03)

• 实用函数 send 现在接收一个 name 参数，允许选择目标消息源。

0.1 (2010-03-03)

• 从 grokui.admin、grok 和 megrok.layout 的旧版本中提取出来。