[Zope3-checkins] CVS: Zope3/src/zope/app/interfaces/container - __init__.py:1.2 find.py:1.2

[Jim Fulton]

Update of /cvs-repository/Zope3/src/zope/app/interfaces/container
In directory cvs.zope.org:/tmp/cvs-serv15352/src/zope/app/interfaces/container

Added Files:
	__init__.py find.py 
Log Message:
Grand renaming:

- Renamed most files (especially python modules) to lower case.

- Moved views and interfaces into separate hierarchies within each
  project, where each top-level directory under the zope package
  is a separate project.

- Moved everything to src from lib/python.

  lib/python will eventually go away. I need access to the cvs
  repository to make this happen, however.

There are probably some bits that are broken. All tests pass
and zope runs, but I haven't tried everything. There are a number
of cleanups I'll work on tomorrow.



=== Zope3/src/zope/app/interfaces/container/__init__.py 1.1 => 1.2 ===
--- /dev/null	Wed Dec 25 09:13:59 2002
+++ Zope3/src/zope/app/interfaces/container/__init__.py	Wed Dec 25 09:12:58 2002
@@ -0,0 +1,206 @@
+#
+# 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 IReadMapping, IEnumerableMapping
+
+class DuplicateIDError(KeyError):
+    pass
+
+class ContainerError(Exception):
+    """An error of a container with one of its components."""
+
+
+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(Interface):
+
+    def __getitem__(key):
+        """Return the content for the given key.
+
+        Raises KeyError if the content can't be found.
+        """
+
+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.
+
+        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 IContentContainer(IWriteContainer):
+    """Containers (like folders) that contain ordinary content"""
+
+class IContainer(IReadContainer, IWriteContainer):
+    """Readable and writable content container."""
+
+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 manageAfterAdd
+        method on the adpter will be called after the object is added.
+
+        An IObjectAddedEvent will be published after the object is added and
+        after manageAfterAdd 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 keyd 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
+        manageBeforeDeleteObject method on the adpter will be called before
+        the object is removed.
+
+        An IObjectRemovedEvent will be published before the object is
+        removed and before  manageBeforeDeleteObject 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 IZopeContainer(IZopeReadContainer, IZopeWriteContainer, IContainer):
+    """Readable and writable content container."""
+
+
+
+class IAddNotifiable(Interface):
+    """The Base interface for Managing Objects."""
+
+    def manage_afterAdd(object, container):
+        """Hook method will call after an object is added to container."""
+
+class IDeleteNotifiable(Interface):
+    """The Base interface for Managing Objects."""
+
+    def manage_beforeDelete(object, container):
+        """Hook method will call before object is removed from container."""


=== Zope3/src/zope/app/interfaces/container/find.py 1.1 => 1.2 ===
--- /dev/null	Wed Dec 25 09:13:59 2002
+++ Zope3/src/zope/app/interfaces/container/find.py	Wed Dec 25 09:12:58 2002
@@ -0,0 +1,41 @@
+##############################################################################
+#
+# 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$
+"""
+
+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.
+        """