Changeset 6075 for main/waeup.sirp/trunk/src

Timestamp:

14 May 2011, 00:25:23 (14 years ago)

Author:

uli

Message:

Clean up. Document what happens and avoid empty doc strings.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/applicants/interfaces.py (modified) (4 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/applicants/interfaces.py

@@ -27 +27 @@
 from zc.sourcefactory.basic import BasicSourceFactory
 from zope import schema
+from zope.component import getUtility, getUtilitiesFor
 from zope.interface import Interface, Attribute
 from zope.pluggableauth.interfaces import IPrincipalInfo
@@ -33 +34 @@
 from waeup.sirp.image.image import WAeUPImageFile
 from waeup.sirp.interfaces import IWAeUPObject, SimpleWAeUPVocabulary
-from zope.component import getAllUtilitiesRegisteredFor
+
 
 IMAGE_PATH = os.path.join(
@@ -83 +84 @@
             
 class ApplicantContainerProviderSource(BasicSourceFactory):
-    """
+    """A source offering all available applicants container types.
+
+    The values returned by this source are names of utilities that can
+    create :class:`ApplicantContainer` instances. So, if you get a
+    name like ``'myactype'`` from this source, then you can do:
+
+      >>> from zope.component import getUtility
+      >>> p = getUtility(IApplicantsContainerProvider, name=myactype)
+      >>> my_applicants_container = p.factory()
+
+    Or you can access class-attributes like
+
+      >>> my_applicants_container.container_title
+      'Pretty'
+    
     """
     def getValues(self):
-        providers = getAllUtilitiesRegisteredFor(IApplicantsContainerProvider)
-        return providers                 
+        """Returns a list of ``(<name>, <provider>)`` tuples.
+
+        Here ``<name>`` is the name under which an
+        :class:``ApplicantContainerProvider`` was registered as a
+        utility and ``<provider>`` is the utility itself.
+        """
+        return getUtilitiesFor(IApplicantsContainerProvider)
 
     def getToken(self, value):
-        return getattr(value, 'grokcore.component.directive.name')
-        
+        """Return the name of the ``(<name>, <provider>)`` tuple.
+        """
+        return value[0]
+
     def getTitle(self, value):
-        return "%s - %s" % (value.factory.title, value.factory.description)            
+        """Get a 'title - description' string for a container type.
+        """
+        factory = value[1].factory
+        return "%s - %s" % (
+            factory.container_title, factory.container_description)
 
 class IResultEntry(IWAeUPObject):
@@ -118 +144 @@
     """
 
+    container_title = Attribute(
+        u'classattribute: title for type of container')
+    container_description = Attribute(
+        u'classattribute: description for type of container')
+
+    
     code = schema.TextLine(
         title = u'Code',