[Zope3-checkins] CVS: Zope3/src/zope/app/interfaces -
container.py:1.2 find.py:1.1
Jim Fulton
jim at zope.com
Fri Sep 5 15:43:50 EDT 2003
Update of /cvs-repository/Zope3/src/zope/app/interfaces
In directory cvs.zope.org:/tmp/cvs-serv13374/src/zope/app/interfaces
Added Files:
container.py find.py
Log Message:
Moved the find interfaces out of zope.interfaces.container so that we
can make zope.interfaces.container a regular module.
=== Zope3/src/zope/app/interfaces/container.py 1.1 => 1.2 ===
--- /dev/null Fri Sep 5 14:43:50 2003
+++ Zope3/src/zope/app/interfaces/container.py Fri Sep 5 14:43:19 2003
@@ -0,0 +1,359 @@
+#
+# This file is necessary to make this directory a package.
+
+
+from zope.interface import Interface, Attribute
+from zope.component.interfaces import IView
+from zope.interface.common.mapping import IItemMapping
+from zope.interface.common.mapping import IReadMapping, IEnumerableMapping
+
+class DuplicateIDError(KeyError):
+ pass
+
+class ContainerError(Exception):
+ """An error of a container with one of its components."""
+
+class CopyException(Exception):
+ """An error that occurred within a copy operation."""
+
+ def __init__(self, container, key, message=""):
+ self.container = container
+ self.key = key
+ self.message = message and ": %s" % message
+
+ def __str__(self):
+ return ("%(key)s cannot be copied "
+ "from %(container)s%(message)s" % self.__dict__)
+
+class MoveException(Exception):
+ """An error that occurred within a move operation."""
+
+ def __init__(self, container, key, message=""):
+ self.container = container
+ self.key = key
+ self.message = message and ": %s" % message
+
+ def __str__(self):
+ return ("%(key)s cannot be copied "
+ "from %(container)s%(message)s" % self.__dict__)
+
+class UnaddableError(ContainerError):
+ """An object cannot be added to a container."""
+
+ def __init__(self, container, obj, message=""):
+ self.container = container
+ self.obj = obj
+ self.message = message and ": %s" % message
+
+ def __str__(self):
+ return ("%(obj)s cannot be added "
+ "to %(container)s%(message)s" % self.__dict__)
+
+
+class IItemContainer(IItemMapping):
+ """Minimal readable container
+ """
+
+class ISimpleReadContainer(IItemContainer, IReadMapping):
+ """Readable content containers
+ """
+
+class IReadContainer(ISimpleReadContainer, IEnumerableMapping):
+ """Readable containers that can be enumerated.
+ """
+
+class IWriteContainer(Interface):
+ """An interface for the write aspects of a container."""
+
+ def setObject(key, object):
+ """Add the given object to the container under the given key.
+
+ The container might choose to add a different object than the
+ one passed to this method.
+
+ Raises a ValueError if key is an empty string, unless the
+ container chooses a different key.
+
+ Raises a TypeError if the key is not a unicode or ascii string.
+
+ Returns the key used, which might be different than the given key.
+ """
+
+ def __delitem__(key):
+ """Delete the keyed object from the container.
+
+ Raises a KeyError if the object is not found.
+ """
+
+class IItemWriteContainer(IWriteContainer, IItemContainer):
+ """A write container that also supports minimal reads."""
+
+class IContentContainer(IWriteContainer):
+ """Containers (like folders) that contain ordinary content"""
+
+class IContainer(IReadContainer, IWriteContainer):
+ """Readable and writable content container."""
+
+class IOrderedContainer(IContainer):
+ """Containers whose contents are maintained in order
+ """
+
+ def 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.
+ """
+
+class IOptionalNamesContainer(IContainer):
+ """Containers that will choose names for their items if no names are given
+ """
+
+class IContainerNamesContainer(IContainer):
+ """Containers that always choose names for their items
+ """
+
+class IAdding(IView):
+
+ def add(content):
+ """Add content object to container.
+
+ Add using the name in contentName. Returns the added object
+ in the context of its container.
+
+ If contentName is already used in container, raises
+ DuplicateIDError.
+ """
+
+ contentName = Attribute(
+ """The content name, as usually set by the Adder traverser.
+
+ If the content name hasn't been defined yet, returns None.
+
+ Some creation views might use this to optionally display the
+ name on forms.
+ """
+ )
+
+ def nextURL():
+ """Return the URL that the creation view should redirect to.
+
+ This is called by the creation view after calling add.
+
+ It is the adder's responsibility, not the creation view's to
+ decide what page to display after content is added.
+ """
+
+class IZopeItemContainer(IItemContainer):
+
+ def __getitem__(key):
+ """Return the content for the given key
+
+ Raises KeyError if the content can't be found.
+
+ The returned value will be in the context of the container.
+ """
+
+class IZopeSimpleReadContainer(IZopeItemContainer, ISimpleReadContainer):
+ """Readable content containers
+ """
+
+ def get(key, default=None):
+ """Get a value for a key
+
+ The default is returned if there is no value for the key.
+
+ The value for the key will be in the context of the container.
+ """
+
+class IZopeReadContainer(IZopeSimpleReadContainer, IReadContainer):
+ """Readable containers that can be enumerated.
+ """
+
+ def values():
+ """Return the values of the mapping object in the context of
+ the container
+ """
+
+ def items():
+ """Return the items of the mapping object in the context
+ of the container
+ """
+
+
+class IZopeWriteContainer(IWriteContainer):
+ """An interface for the write aspects of a container."""
+
+ def setObject(key, object):
+ """Add the given object to the container under the given key.
+
+ Raises a ValueError if key is an empty string, unless the
+ context wrapper chooses a different key.
+
+ Returns the key used, which might be different than the given key.
+
+ If the object has an adpter to IAddNotifiable then the afterAddHook
+ method on the adpter will be called after the object is added.
+
+ An IObjectAddedEvent will be published after the object is added and
+ after afterAddHook is called. The event object will be the added
+ object in the context of the container
+
+ An IObjectModifiedEvent will be published after the IObjectAddedEvent
+ is published. The event object will be the container.
+ """
+
+ def __delitem__(key):
+ """Delete the keyed object from the context of the container.
+
+ Raises a KeyError if the object is not found.
+
+ If the object has an adpter to IDeleteNotifiable then the
+ beforeDeleteHook method on the adpter will be called before
+ the object is removed.
+
+ An IObjectRemovedEvent will be published before the object is
+ removed and before beforeDeleteHook method is called.
+ The event object will be the removed from the context of the container
+
+ An IObjectModifiedEvent will be published after the
+ IObjectRemovedEvent is published. The event object will be the
+ container.
+ """
+
+class IZopeItemWriteContainer(IZopeWriteContainer, IZopeItemContainer):
+ """An IZopeWriteContainer for writable item containers.
+
+ 'setObject' and '__delitem__' of IZopeWriteContainer imply being able
+ to get at an object after it has been added to the container, or
+ before it has been deleted from the container.
+ This interface makes that contract explicit, and also offers to
+ make '__getitem__' context-aware.
+ """
+
+class IZopeContainer(IZopeReadContainer, IZopeWriteContainer, IContainer):
+ """Readable and writable content container."""
+
+class IAddNotifiable(Interface):
+ """Interface for notification of being added."""
+
+ def afterAddHook(object, container):
+ """Hook method will call after an object is added to container."""
+
+class IDeleteNotifiable(Interface):
+ """Interface for notification of being deleted."""
+
+ def beforeDeleteHook(object, container):
+ """Hook method will call before object is removed from container."""
+
+class IMoveNotifiable(IDeleteNotifiable, IAddNotifiable):
+ """Interface for notification of being deleted, added, or moved."""
+
+ def beforeDeleteHook(object, container, movingTo=None):
+ """Hook method will call before object is removed from container.
+
+ If the object is being moved, 'movingTo' will be the unicode path
+ the object is being moved to.
+ If the object is simply being deleted and not being moved, 'movingTo'
+ will be None.
+ """
+
+ def afterAddHook(object, container, movedFrom=None):
+ """Hook method will call after an object is added to container.
+
+ If the object is being moved, 'movedFrom' will be the unicode path
+ the object was moved from.
+ If the object is simply being added and not being moved, 'movedFrom'
+ will be None.
+ """
+
+class ICopyNotifiable(IAddNotifiable):
+
+ def afterAddHook(object, container, copiedFrom=None):
+ """Hook method. Will be called after an object is added to a
+ container.
+
+ If the object is being copied, 'copiedFrom' will
+ be the unicode path the object was copied from.
+
+ If the object is simply being added and not being copied,
+ 'copiedFrom' will be None.
+
+ Clients calling this method must be careful to use
+ 'copiededFrom' as a keyword argument rather than a positional
+ argument, to avoid confusion if the object is both
+ IMoveNotifiable and ICopyNotifiable. """
+
+class IPasteTarget(Interface):
+
+ def acceptsObject(key, obj):
+ '''Allow the container to say if it accepts the given wrapped
+ object.
+
+ Returns True if the object would be accepted as contents of
+ this container. Otherwise, returns False.
+ '''
+
+ def pasteObject(key, obj):
+ '''Add the given object to the container under the given key.
+
+ Raises a ValueError if key is an empty string, unless the
+ this object chooses a different key.
+
+ Returns the key used, which might be different than the
+ given key.
+
+ This method must not issue an IObjectAddedEvent, nor must it
+ call the afterAddHook hook of the object.
+ However, it must publish an IObjectModified event for the
+ container.
+ '''
+
+class IMoveSource(Interface):
+
+ def removeObject(key, movingTo):
+ '''Remove and return the object with the given key, as the
+ first part of a move.
+
+ movingTo is the unicode path for where the move is to.
+ This method should not publish an IObjectRemovedEvent, nor should
+ it call the afterDeleteHook method of the object.
+ However, it must publish an IObjectModified event for the container.
+ '''
+
+class ICopySource(Interface):
+
+ def copyObject(key, copyingTo):
+ '''Return the object with the given key, as the first part of a
+ copy.
+
+ copyingTo is the unicode path for where the copy is to.
+ '''
+
+class INoChildrenCopySource(ICopySource):
+
+ def copyObjectWithoutChildren(key, copyingTo):
+ '''Return the object with the given key, without any children,
+ as the first part of a copy.
+
+ copyingTo is the unicode path for where the copy is to.
+
+ May return None if its not possible to get a copy without children.
+ '''
+
+class IPasteNamesChooser(Interface):
+ """Containers automatically chooses a new name for the object if the
+ given one is already choosen.
+ """
+
+ def getNewName(obj, key):
+ """ Should return a choosen name based on object and key to be used
+ for pasting. This may not be reliable all the time as
+ the name you choose is not guaranteed to be reserved between the time
+ you get it and the time you paste the object, so be careful."""
+
=== Added File Zope3/src/zope/app/interfaces/find.py ===
##############################################################################
#
# Copyright (c) 2001, 2002 Zope Corporation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""
$Id: find.py,v 1.1 2003/09/05 18:43:19 jim Exp $
"""
from zope.interface import Interface
class IFind(Interface):
"""
Find support for containers.
"""
def find(id_filters=None, object_filters=None):
"""Find object that matches all filters in all sub objects,
not including this container itself.
"""
class IObjectFindFilter(Interface):
def matches(object):
"""Returns true if the object matches the filter criteria.
"""
class IIdFindFilter(Interface):
def matches(id):
"""Returns true if the id matches the filter criteria.
"""
More information about the Zope3-Checkins
mailing list