[Zope-Checkins] CVS: Zope3/lib/python/Zope/App/OFS/Container - Exceptions.py:1.1.2.3 IContainer.py:1.1.2.5 SampleContainer.py:1.1.2.6 __init__.py:1.1.2.3

[Gary Poster]

Update of /cvs-repository/Zope3/lib/python/Zope/App/OFS/Container
In directory cvs.zope.org:/tmp/cvs-serv1556/App/OFS/Container

Modified Files:
      Tag: Zope-3x-branch
	Exceptions.py IContainer.py SampleContainer.py __init__.py 
Log Message:
ComponentArchitecture reorganization; addition of for_container; addition of IWriteContainer.isAddable.

good news: all tests pass; bad news: after the new security system, my changes have some problems.  I had to punt on the default contents view of all folders for instance--hasServiceManager is causing a problem for some reason I couldn't divine, even with Shane's Checker tool.  I commented out the offending code on the contents.pt just to keep things up.

I tagged before committing: gary_CA-reorganization

changes more in depth (as I understand it, all or most approved :-) ):

(in ComponentArchitecture:)
 * changing implementation names to Global* (i.e., AdapterService becomes 
GlobalAdapterService) and giving each its own file (many are clumped together 
in hooks.py)
 * removing hooks.py in ComponentArchitecture, putting all functions in appropriate module above (i.e. getAdapter will be in the adapter module)
 * largely removing indirection (_hook) except for getService and 
getNextService
 * changing IServiceService.py to IServiceManager
 * changing Service.py to GlobalServiceManager.py (and class name too)
 * removing "provide*" functions (i.e., provideAdapter, provideUtility, etc.) 
and "defineService" from the __init__.py imports
 * change all global services to classes with appropriate methods as per 
interfaces
 * update all tests 
 * remove all of the "provide*" functions from the interfaces
 * renamed IComponentArchitecture to IPlacefulComponentArchitecture (hereafter IPCA), after long discussion with SteveA 
 * list Resources as one of core CA services in IPlacefulComponentArchitecture
 * build actual IPCA interface, not just import of service interfaces (because we want IPCA to be placeful, but the service interfaces do not need to be)
 * place functions implementing ICA actually in __init__
 * explicitly setting up services in zcml
 * created Global service interfaces, and placed the "provides" and "set" and "define" functions there: however, to keep the main interfaces clean and clear, I placed these global interfaces in the same file as the global implementations, hoping to clarify that these are not reusable interfaces but descriptive, one-time interfaces
 * built PlacefulSetup in Zope.ComponentArchitecture.tests for more specific CleanUp (a subclass).  PlacefulSetup is in the tests folder of the local ServiceManager.  AddableSetup also is available, in the AddableService tests.

(elsewhere in Zope3)
 * built for_container in addables
 * built isAddable for containers (after discussion with Jim, we decided an addable "contains" attribute in the zcml might not be the way to go.  I chose the isAddable approach for a number of reasons)
 * addableservice does some more checks in getting the addable list, pertinent to the above and to whether it can find the appropriate factories
 * a few more tests: a start of one in the local event service, and some more here and there

I'm sorry to add to the confusion of the big security changes, but I needed to either trash these changes or commit them: I'm a bit out of time for the moment.  If all else fails, again, I did tag the previous version.



=== Zope3/lib/python/Zope/App/OFS/Container/Exceptions.py 1.1.2.2 => 1.1.2.3 ===
 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__
\ No newline at end of file


=== Zope3/lib/python/Zope/App/OFS/Container/IContainer.py 1.1.2.4 => 1.1.2.5 ===
         """Add the given object to the container under the given name.
         
-        Raises a ValueError if name is an empty string."""
+        Raises a ValueError if name is an empty string.
+        
+        Raises a Zope.App.OFS.Container.Exceptions.UnaddableError
+        if the item cannot be added.
+        """
 
     def delObject(name):
         """Delete the named object from the container. Raises a KeyError
            if the object is not found."""
+    
+    def isAddable(interfaces):
+        """Given an interface or tuple of interfaces that one object
+        implements (or None, if the object is not a component--that is,
+        if it declares no implementation), returns a true value (an
+        object that implements the full set of the given interfaces is
+        addable to this container) or a false value (is not)."""
 
 
 class IContainer(IReadContainer, IWriteContainer):


=== Zope3/lib/python/Zope/App/OFS/Container/SampleContainer.py 1.1.2.5 => 1.1.2.6 ===
 from IContainer import IContainer
 from types import StringTypes
+from Exceptions import UnaddableError
 
 _marker = object()
 
@@ -85,11 +86,18 @@
     def setObject(self, name, object):
         '''See interface IWriteContainer'''
         if type(name) in StringTypes and len(name)==0:
-            raise ValueError
+            raise ValueError("The id cannot be an empty string")
+        if not self.isAddable(getattr(object,'__implements__', None)):
+            raise UnaddableError (self, object, name)
         self.__data[name] = object
 
+    def isAddable(self, interfaces):
+        '''See interface IWriteContainer'''
+        return 1
+
     def delObject(self, name):
         '''See interface IWriteContainer'''
         del self.__data[name]
+
     #
     ############################################################


=== Zope3/lib/python/Zope/App/OFS/Container/__init__.py 1.1.2.2 => 1.1.2.3 ===
 ##############################################################################
 """Provide generic container support components
-"""
+"""
\ No newline at end of file