zope.site 5.0

创建和访问站点

站点 用于为您的应用程序或网站的部分提供自定义组件设置。每个文件夹

>>> from zope.site import folder
>>> myfolder = folder.rootFolder()

都有可能成为站点

>>> from zope.component.interfaces import ISite, IPossibleSite
>>> IPossibleSite.providedBy(myfolder)
True

但还不是

>>> ISite.providedBy(myfolder)
False

如果您希望您的自定义内容组件能够成为站点，您可以使用 SiteManagerContainer 混合类

>>> from zope import site
>>> class MyContentComponent(site.SiteManagerContainer):
...     pass

>>> myContent = MyContentComponent()
>>> IPossibleSite.providedBy(myContent)
True
>>> ISite.providedBy(myContent)
False

要将可能的站点转换为真实站点，我们必须提供站点管理器

>>> sm = site.LocalSiteManager(myfolder)
>>> myfolder.setSiteManager(sm)
>>> ISite.providedBy(myfolder)
True
>>> myfolder.getSiteManager() is sm
True

请注意，在创建本地站点管理器时会生成一个事件

>>> from zope.component.eventtesting import getEvents
>>> from zope.site.interfaces import INewLocalSite
>>> [event] = getEvents(INewLocalSite)
>>> event.manager is sm
True

如果尝试设置一个无效的站点管理员，将抛出一个ValueError错误

>>> myfolder2 = folder.Folder()
>>> myfolder2.setSiteManager(object)
Traceback (most recent call last):
...
ValueError: setSiteManager requires an IComponentLookup

如果可能已更改到已存在的站点，当尝试添加新的站点管理员时，将抛出一个TypeError错误

>>> myfolder.setSiteManager(site.LocalSiteManager(myfolder))
Traceback (most recent call last):
...
TypeError: Already a site

此外，您还可以使用一个适配器从任何位置获取下一个站点管理员

>>> myfolder['mysubfolder'] = folder.Folder()
>>> import zope.interface.interfaces
>>> zope.interface.interfaces.IComponentLookup(myfolder['mysubfolder']) is sm
True

如果传递的定位符是站点，则返回该站点的站点管理员

>>> zope.interface.interfaces.IComponentLookup(myfolder) is sm
True

使用站点管理员

站点管理员包含几个站点管理文件夹，用于逻辑组织软件。当初始化站点管理员时，将创建一个默认的站点管理文件夹

>>> sm = myfolder.getSiteManager()
>>> default = sm['default']
>>> default.__class__
<class 'zope.site.site.SiteManagementFolder'>

然而，您可以在创建LocalSiteManager时指示不要创建默认站点管理文件夹

>>> nodefault = site.LocalSiteManager(myfolder, default_folder=False)
>>> 'default' in nodefault
False

此外，请注意，在创建LocalSiteManager时，其__parent__设置为构造函数中传递的站点，而__name__设置为++etc++site。

>>> nodefault.__parent__ is myfolder
True
>>> nodefault.__name__ == '++etc++site'
True

您可以轻松地创建一个新的站点管理文件夹

>>> sm['mySMF'] = site.SiteManagementFolder()
>>> sm['mySMF'].__class__
<class 'zope.site.site.SiteManagementFolder'>

一旦您有了站点管理文件夹——让我们使用默认的一个——我们就可以注册一些组件。让我们从一个（我们在一个可以序列化的__module__中定义的）实用工具开始

>>> import zope.interface
>>> __name__ = 'zope.site.tests'
>>> class IMyUtility(zope.interface.Interface):
...     pass

>>> import persistent
>>> from zope.container.contained import Contained
>>> @zope.interface.implementer(IMyUtility)
... class MyUtility(persistent.Persistent, Contained):
...     def __init__(self, title):
...         self.title = title
...     def __repr__(self):
...         return "%s('%s')" %(self.__class__.__name__, self.title)

现在我们可以创建实用工具的实例，将其放入站点管理文件夹并注册它

>>> myutil = MyUtility('My custom utility')
>>> default['myutil'] = myutil
>>> sm.registerUtility(myutil, IMyUtility, 'u1')

现在我们可以向站点管理员请求实用工具

>>> sm.queryUtility(IMyUtility, 'u1')
MyUtility('My custom utility')

当然，本地站点管理员也有权访问全局组件注册

>>> gutil = MyUtility('Global Utility')
>>> from zope.component import getGlobalSiteManager
>>> gsm = getGlobalSiteManager()
>>> gsm.registerUtility(gutil, IMyUtility, 'gutil')

>>> sm.queryUtility(IMyUtility, 'gutil')
MyUtility('Global Utility')

接下来，让我们看看是否也可以成功注册适配器。这里的适配器将提供文件的大小

>>> class IFile(zope.interface.Interface):
...     pass

>>> class ISized(zope.interface.Interface):
...     pass

>>> @zope.interface.implementer(IFile)
... class File(object):
...     pass

>>> @zope.interface.implementer(ISized)
... class FileSize(object):
...     def __init__(self, context):
...         self.context = context

现在我们已经有了适配器，需要将其注册

>>> sm.registerAdapter(FileSize, [IFile])

最后，我们可以为文件获取适配器

>>> file = File()
>>> size = sm.queryAdapter(file, ISized, name='')
>>> isinstance(size, FileSize)
True
>>> size.context is file
True

顺便说一句，一旦设置了站点

>>> from zope.component import hooks
>>> hooks.setSite(myfolder)

您可以直接使用zope.component的getSiteManager()方法来获取最近的站点管理员

>>> from zope.component import getSiteManager
>>> getSiteManager() is sm
True

这也意味着您可以直接使用zope.component来查找您的实用工具

>>> from zope.component import getUtility
>>> getUtility(IMyUtility, 'gutil')
MyUtility('Global Utility')

或通过接口的__call__方法获取适配器

>>> size = ISized(file)
>>> isinstance(size, FileSize)
True
>>> size.context is file
True

多个站点

到目前为止，我们只处理了一个本地站点和全局站点。但是，当我们有多个站点时，事情变得真正有趣。我们可以覆盖其他本地配置。

此行为使用了位置的概念，因此我们需要首先配置zope.location包

>>> import zope.configuration.xmlconfig
>>> _  = zope.configuration.xmlconfig.string("""
... <configure xmlns="http://namespaces.zope.org/zope">
...   <include package="zope.component" file="meta.zcml"/>
...   <include package="zope.location" />
... </configure>
... """)

现在，创建一个名为folder11的新文件夹，将其添加到myfolder中，并将其设置为站点

>>> myfolder11 = folder.Folder()
>>> myfolder['myfolder11'] = myfolder11
>>> myfolder11.setSiteManager(site.LocalSiteManager(myfolder11))
>>> sm11 = myfolder11.getSiteManager()

如果我们要求第二个站点管理员获取其下一个，我们得到

>>> sm11.__bases__ == (sm, )
True

并且第一个站点管理员应该有以下的子管理员

>>> sm.subs == (sm11,)
True

如果我们现在用新的站点管理员文件夹注册一个具有相同名称和接口的第二个实用工具，

>>> default11 = sm11['default']
>>> myutil11 = MyUtility('Utility, uno & uno')
>>> default11['myutil'] = myutil11

>>> sm11.registerUtility(myutil11, IMyUtility, 'u1')

那么它将在第二个站点管理员中可用

>>> sm11.queryUtility(IMyUtility, 'u1')
MyUtility('Utility, uno & uno')

但不在第一个中

>>> sm.queryUtility(IMyUtility, 'u1')
MyUtility('My custom utility')

查看移动和复制站点的用例也非常有趣。为此，我们创建一个第二个根文件夹，并将其设置为站点，以便站点层次结构如下

         _____ global site _____
        /                       \
    myfolder                 myfolder2
        |
    myfolder11


>>> myfolder2 = folder.rootFolder()
>>> myfolder2.setSiteManager(site.LocalSiteManager(myfolder2))

在我们可以移动或复制站点之前，我们需要注册两个事件订阅者来管理移动或复制后站点管理器的连接

>>> import zope.lifecycleevent.interfaces
>>> gsm.registerHandler(
...    site.changeSiteConfigurationAfterMove,
...    (ISite, zope.lifecycleevent.interfaces.IObjectMovedEvent),
...    )

由于复制操作会创建一个特殊的IObjectMovedEvent类型的IObjectAddedEvent，我们只需要注册一个事件监听器。

首先，请确保一切设置正确

>>> myfolder11.getSiteManager().__bases__ == (myfolder.getSiteManager(), )
True
>>> myfolder.getSiteManager().subs[0] is myfolder11.getSiteManager()
True
>>> myfolder2.getSiteManager().subs
()

现在让我们将myfolder11从myfolder移动到myfolder2

>>> myfolder2['myfolder21'] = myfolder11
>>> del myfolder['myfolder11']

现在myfolder11的站点管理员的下一个站点管理员应该已经改变

>>> myfolder21 = myfolder11
>>> myfolder21.getSiteManager().__bases__ == (myfolder2.getSiteManager(), )
True
>>> myfolder2.getSiteManager().subs[0] is myfolder21.getSiteManager()
True
>>> myfolder.getSiteManager().subs
()

请确保我们的接口和类是可序列化的

>>> import sys
>>> sys.modules['zope.site.tests'].IMyUtility = IMyUtility
>>> sys.modules['zope.site.tests'].MyUtility = MyUtility

>>> from pickle import dumps, loads
>>> data = dumps(myfolder2['myfolder21'])
>>> myfolder['myfolder11'] = loads(data)

>>> myfolder11 = myfolder['myfolder11']
>>> myfolder11.getSiteManager().__bases__ == (myfolder.getSiteManager(), )
True
>>> myfolder.getSiteManager().subs[0] is myfolder11.getSiteManager()
True
>>> myfolder2.getSiteManager().subs[0] is myfolder21.getSiteManager()
True

最后，让我们检查当我们的文件夹被移动到不包含任何站点管理员的文件夹时，一切是否正常。我们的文件夹的sitemanager的bases应该设置为全局站点管理员。

>>> myfolder11.getSiteManager().__bases__ == (myfolder.getSiteManager(), )
True

>>> nosm = folder.Folder()
>>> nosm['root'] = myfolder11
>>> myfolder11.getSiteManager().__bases__ == (gsm, )
True

删除站点将取消其站点管理器与其父站点管理器的注册

>>> del myfolder2['myfolder21']
>>> myfolder2.getSiteManager().subs
()

已删除的站点管理器现在没有基础

>>> myfolder21.getSiteManager().__bases__
()