zope.site API

Interfaces

Interfaces for the Local Component Architecture

interface zope.site.interfaces.IFolder

Extends: zope.container.interfaces.IContainer, zope.component.interfaces.IPossibleSite, zope.annotation.interfaces.IAttributeAnnotatable

The standard Zope Folder object interface.

interface zope.site.interfaces.ILocalSiteManager

Extends: zope.interface.interfaces.IComponents

Site Managers act as containers for registerable components.

If a Site Manager is asked for an adapter or utility, it checks for those it contains before using a context-based lookup to find another site manager to delegate to. If no other site manager is found they defer to the global site manager which contains file based utilities and adapters.

subs

A collection of registries that describe the next level of the registry tree. They are the children of this registry node. This attribute should never be manipulated manually. Use addSub() and removeSub() instead.

addSub(sub)

Add a new sub-registry to the node.

Caution

This method should not be used manually. It is automatically called by setNext. To add a new registry to the tree, use sub.setNext(self, self.base) instead!

removeSub(sub)

Remove a sub-registry to the node.

Caution

This method should not be used manually. It is automatically called by setNext. To remove a registry from the tree, use sub.setNext(None) instead!

interface zope.site.interfaces.INewLocalSite

Event: a local site was created

manager

The new site manager

interface zope.site.interfaces.IRootFolder

Extends: zope.location.interfaces.IRoot, zope.site.interfaces.IFolder

The standard Zope root Folder object interface.

Changed in version 4.5.0: IRoot is now defined to come before IFolder in the interface resolution (priority) order.

interface zope.site.interfaces.ISiteManagementFolder

Extends: zope.container.interfaces.IContainer

Component and component registration containers.

__parent__

Implementation

zope.schema.Field

Read Only

False

Required

True

Default Value

None

class zope.site.interfaces.NewLocalSite(manager)

Bases: object

Event: a local site was created

Implementations

Site

Site and Local Site Manager implementation

A local site manager has a number of roles:

• A local site manager, that provides a local adapter and utility registry.

• A place to do TTW development and/or to manage database-based code.

• A registry for persistent modules. The Zope 3 import hook uses the SiteManager to search for modules.

class zope.site.site.LocalSiteManager(site, default_folder=True)

Bases: BTreeContainer, PersistentComponents

Local Site Manager (ILocalSiteManager) implementation

addSub(sub)

See zope.site.interfaces.ILocalSiteManager.addSub()

removeSub(sub)

See zope.site.interfaces.ILocalSiteManager.removeSub()

class zope.site.site.SMFolderFactory(context)

Bases: object

Implementation of a IDirectoryFactory that creates SiteManagementFolder

class zope.site.site.SiteManagementFolder

Bases: BTreeContainer

Implementation of a ISiteManagementFolder

class zope.site.site.SiteManagerContainer

Bases: Contained

Implement access to the site manager (++etc++site).

This is a mix-in that implements the IPossibleSite interface; for example, it is used by the Folder implementation.

zope.site.site.SiteManagerAdapter(ob)

An adapter from ILocation to IComponentLookup.

The ILocation is interpreted flexibly, we just check for __parent__.

zope.site.site.changeSiteConfigurationAfterMove(site, event)

After a site is (re-)moved, its site manager links have to be updated.

Subscriber to ISite objects in a IObjectMovedEvent.

zope.site.site.clearThreadSiteSubscriber(event)

A subscriber to zope.publisher.interfaces.EndRequestEvent

Cleans up the site thread global after the request is processed.

Note

The configure.zcml included in this package does not install this subscriber. That must be configured separately. zope.app.publication includes such configuration.

zope.site.site.threadSiteSubscriber(ob, event)

A multi-subscriber to zope.component.interfaces.ISite and zope.traversing.interfaces.BeforeTraverseEvent.

Sets the ‘site’ thread global if the object traversed is a site.

Note

The configure.zcml included in this package does not install this subscriber. That must be configured separately. zope.app.publication includes such configuration.

Folder

class zope.site.folder.Folder

Bases: Folder, SiteManagerContainer

Implementation of zope.site.interfaces.IFolder

class zope.site.folder.FolderSublocations(folder)

Bases: object

Adapter for an zope.site.interfaces.IFolder to zope.location.interfaces.ISublocations.

The subobjects of a folder include it’s contents and it’s site manager if it is a site:

>>> from zope.container.contained import Contained
>>> folder = Folder()
>>> folder['ob1'] = Contained()
>>> folder['ob2'] = Contained()
>>> folder['ob3'] = Contained()
>>> subs = list(FolderSublocations(folder).sublocations())
>>> subs.remove(folder['ob1'])
>>> subs.remove(folder['ob2'])
>>> subs.remove(folder['ob3'])
>>> subs
[]

>>> sm = Contained()
>>> from zope.interface import directlyProvides
>>> from zope.interface.interfaces import IComponentLookup
>>> directlyProvides(sm, IComponentLookup)
>>> folder.setSiteManager(sm)
>>> directlyProvides(folder, zope.component.interfaces.ISite)
>>> subs = list(FolderSublocations(folder).sublocations())
>>> subs.remove(folder['ob1'])
>>> subs.remove(folder['ob2'])
>>> subs.remove(folder['ob3'])
>>> subs.remove(sm)
>>> subs
[]

zope.site.folder.rootFolder()

Factory for a zope.site.interfaces.IRootFolder