zope.container API

Interfaces

Container-related interfaces

exception zope.container.interfaces.ContainerError

Bases: exceptions.Exception

An error of a container with one of its components.

interface zope.container.interfaces.IBTreeContainer

Extends: zope.container.interfaces.IContainer

Container that supports BTree semantics for some methods.

keys(key=None)

Return an iterator over the keys in the container.

If None is passed as key, this method behaves as if no argument were passed; exactly as required for IContainer.keys().

If key is in the container, the first key provided by the iterator will be that key. Otherwise, the first key will be the one that would come next if key were in the container.

items(key=None)

Return an iterator over the key-value pairs in the container.

If None is passed as key, this method behaves as if no argument were passed; exactly as required for IContainer.items().

If key is in the container, the first item provided by the iterator will correspond to that key. Otherwise, the first item will be for the key that would come next if key were in the container.

values(key=None)

Return an iterator over the values in the container.

If None is passed as key, this method behaves as if no argument were passed; exactly as required for IContainer.values().

If key is in the container, the first value provided by the iterator will correspond to that key. Otherwise, the first value will be for the key that would come next if key were in the container.

interface zope.container.interfaces.IContainer

Extends: zope.container.interfaces.IReadContainer, zope.container.interfaces.IWriteContainer

Readable and writable content container.

interface zope.container.interfaces.IContainerModifiedEvent

Extends: zope.lifecycleevent.interfaces.IObjectModifiedEvent

The container has been modified.

This event is specific to “containerness” modifications, which means addition, removal or reordering of sub-objects.

interface zope.container.interfaces.IContainerNamesContainer

Extends: zope.container.interfaces.IContainer

Containers that always choose names for their items.

interface zope.container.interfaces.IContentContainer

Extends: zope.container.interfaces.IContainer

A container that is to be used as a content type.

interface zope.container.interfaces.IFind

Find support for containers.

find(id_filters=None, object_filters=None)

Find object that matches all filters in all sub-objects.

This container itself is not included.

interface zope.container.interfaces.IItemContainer

Extends: zope.interface.common.mapping.IItemMapping

Minimal readable container.

interface zope.container.interfaces.IItemWriteContainer

Extends: zope.container.interfaces.IWriteContainer, zope.container.interfaces.IItemContainer

A write container that also supports minimal reads.

interface zope.container.interfaces.IOrdered

Objects whose contents are maintained in order.

updateOrder(order)

Revise the order of keys, replacing the current ordering.

order is a list or a tuple containing the set of existing keys in the new order. order must contain len(keys()) items and cannot contain duplicate keys.

Raises TypeError if order is not a tuple or a list.

Raises ValueError if order contains an invalid set of keys.

interface zope.container.interfaces.IOrderedContainer

Extends: zope.container.interfaces.IOrdered, zope.container.interfaces.IContainer

Containers whose contents are maintained in order.

interface zope.container.interfaces.IReadContainer

Extends: zope.container.interfaces.ISimpleReadContainer, zope.interface.common.mapping.IEnumerableMapping

Readable containers that can be enumerated.

interface zope.container.interfaces.IReservedNames

A sequence of names that are reserved for that container

reservedNames

Reserved Names

Names that are not allowed for addable content

interface zope.container.interfaces.ISimpleReadContainer

Extends: zope.container.interfaces.IItemContainer, zope.interface.common.mapping.IReadMapping

Readable content containers.

interface zope.container.interfaces.IWriteContainer

An interface for the write aspects of a container.

__setitem__(name, object)

Add the given object to the container under the given name.

Raises a TypeError if the key is not a unicode or ascii string.

Raises a ValueError if the key is empty, or if the key contains a character which is not allowed in an object name.

Raises a KeyError if the key violates a uniqueness constraint.

The container might choose to add a different object than the one passed to this method.

If the object doesn’t implement IContained, then one of two things must be done:

1. If the object implements ILocation, then the IContained interface must be declared for the object.
2. Otherwise, a ContainedProxy is created for the object and stored.

The object’s __parent__ and __name__ attributes are set to the container and the given name.

If the old parent was None, then an IObjectAddedEvent is generated, otherwise, an IObjectMovedEvent is generated. An IContainerModifiedEvent is generated for the container.

If the object replaces another object, then the old object is deleted before the new object is added, unless the container vetos the replacement by raising an exception.

If the object’s __parent__ and __name__ were already set to the container and the name, then no events are generated and no hooks. This allows advanced clients to take over event generation.

__delitem__(name)

Delete the named object from the container.

Raises a KeyError if the object is not found.

If the deleted object’s __parent__ and __name__ match the container and given name, then an IObjectRemovedEvent is generated and the attributes are set to None. If the object can be adapted to IObjectMovedEvent, then the adapter’s moveNotify method is called with the event.

Unless the object’s __parent__ and __name__ attributes were initially None, generate an IContainerModifiedEvent for the container.

If the object’s __parent__ and __name__ were already set to None, then no events are generated. This allows advanced clients to take over event generation.

exception zope.container.interfaces.InvalidContainerType

Bases: zope.interface.exceptions.Invalid, exceptions.TypeError

The type of a container is not valid.

exception zope.container.interfaces.InvalidItemType

Bases: zope.interface.exceptions.Invalid, exceptions.TypeError

The type of an item is not valid.

exception zope.container.interfaces.InvalidType

Bases: zope.interface.exceptions.Invalid, exceptions.TypeError

The type of an object is not valid.

exception zope.container.interfaces.NameReserved

Bases: exceptions.ValueError

The name is reserved for this container

exception zope.container.interfaces.UnaddableError(container, obj, message='')

Bases: zope.container.interfaces.ContainerError

An object cannot be added to a container.