[Checkins] SVN: zope.generic/trunk/src/zope/generic/ factory function createConfiguration for CongiurationData

Dominik Huber dominik.huber at perse.ch
Wed May 17 12:14:19 EDT 2006


Log message for revision 68171:
  factory function createConfiguration for CongiurationData

Changed:
  U   zope.generic/trunk/src/zope/generic/adapter/property.py
  U   zope.generic/trunk/src/zope/generic/configuration/README.txt
  U   zope.generic/trunk/src/zope/generic/configuration/api.py
  U   zope.generic/trunk/src/zope/generic/configuration/base.py
  U   zope.generic/trunk/src/zope/generic/configuration/helper.py
  U   zope.generic/trunk/src/zope/generic/content/EXAMPLE.txt
  U   zope.generic/trunk/src/zope/generic/content/README.txt
  U   zope.generic/trunk/src/zope/generic/factory/factory.py
  U   zope.generic/trunk/src/zope/generic/handler/metadirectives.py
  U   zope.generic/trunk/src/zope/generic/informationprovider/NEW_README.txt
  U   zope.generic/trunk/src/zope/generic/informationprovider/README.txt
  U   zope.generic/trunk/src/zope/generic/informationprovider/api.py
  U   zope.generic/trunk/src/zope/generic/informationprovider/metaconfigure.py
  U   zope.generic/trunk/src/zope/generic/operation/README.txt

-=-
Modified: zope.generic/trunk/src/zope/generic/adapter/property.py
===================================================================
--- zope.generic/trunk/src/zope/generic/adapter/property.py	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/adapter/property.py	2006-05-17 16:14:18 UTC (rev 68171)
@@ -19,7 +19,7 @@
 __docformat__ = 'restructuredtext'
 
 from zope.generic.configuration import IConfigurations
-from zope.generic.configuration.base import ConfigurationData
+from zope.generic.configuration.base import createConfiguration
 from zope.generic.configuration.helper import configuratonToDict
 from zope.generic.informationprovider.api import getInformation
 from zope.generic.informationprovider.api import getInformationProvider
@@ -105,7 +105,7 @@
         # create a new configuration
         else:
             try:
-                configurations[keyface] = ConfigurationData(keyface, {self._name: value})
+                configurations[keyface] = createConfiguration(keyface, {self._name: value})
 
             except TypeError, e:
                 # hack around the atomic update of the form framework
@@ -127,7 +127,7 @@
 
                 data = configuratonToDict(configuration)
                 data[self._name] = value
-                configurations[keyface] = ConfigurationData(keyface, data)
+                configurations[keyface] = createConfiguration(keyface, data)
 
         inst.__dict__[self._name] = value
 

Modified: zope.generic/trunk/src/zope/generic/configuration/README.txt
===================================================================
--- zope.generic/trunk/src/zope/generic/configuration/README.txt	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/configuration/README.txt	2006-05-17 16:14:18 UTC (rev 68171)
@@ -106,18 +106,18 @@
     ...
     KeyError: <InterfaceClass example.IFooConfiguration>
 
-You can create valid configuration data using the generic ConfigurationData
+You can create valid configuration data using the generic createConfiguration
 implementation and a configuration schema. The setting of the configuration is
 notified by a object configured event if the parent has a location an the 
 parent's parent is not None:
 
     >>> from zope.component.eventtesting import getEvents, clearEvents
-    >>> from zope.generic.configuration.api import ConfigurationData
+    >>> from zope.generic.configuration.api import createConfiguration
     >>> from zope.generic.configuration.api import IObjectConfiguredEvent
 
     >>> clearEvents()
 
-    >>> data = ConfigurationData(IFooConfiguration, {'foo': u'Foo!'})
+    >>> data = createConfiguration(IFooConfiguration, {'foo': u'Foo!'})
 
     >>> configurations[IFooConfiguration] = data
 
@@ -246,7 +246,7 @@
 First test nested configuration:
 
 #    >>> data = {'foo.foo': u'bla', 'foo.optional': u'Blu'}
-#    >>> config = api.ConfigurationData(ISubConfigurationConfiguration, data)
+#    >>> config = api.createConfiguration(ISubConfigurationConfiguration, data)
 #    >>> IFooConfiguration.providedBy(config.foo)
 #    True
 #    >>> config.foo.foo
@@ -255,7 +255,7 @@
 #    u'Blu'
 #
 #    >>> data = {'foo.foo': u'xxx'}
-#    >>> config = api.ConfigurationData(ISubConfigurationConfiguration, data)
+#    >>> config = api.createConfiguration(ISubConfigurationConfiguration, data)
 #    >>> IFooConfiguration.providedBy(config.foo)
 #    True
 #    >>> config.foo.foo
@@ -264,15 +264,15 @@
 #    u'Bla'
 #
 #    >>> data = {'foo.optional': u'Blu'}
-#    >>> config = api.ConfigurationData(ISubConfigurationConfiguration, data)
+#    >>> config = api.createConfiguration(ISubConfigurationConfiguration, data)
 #    Traceback (most recent call last):
 #    ...
 #    TypeError: __init__ requires 'foo.foo' of 'ISubConfigurationConfiguration'.
 #
 #    >>> subdata = {'foo': u'bla', 'optional': u'Blu'}
-#    >>> subconfig = api.ConfigurationData(IFooConfiguration, subdata)
+#    >>> subconfig = api.createConfiguration(IFooConfiguration, subdata)
 #    >>> data = {'foo': subconfig}
-#    >>> config = api.ConfigurationData(ISubConfigurationConfiguration, data)
+#    >>> config = api.createConfiguration(ISubConfigurationConfiguration, data)
 #    >>> IFooConfiguration.providedBy(config.foo)
 #    True
 #    >>> config.foo.foo

Modified: zope.generic/trunk/src/zope/generic/configuration/api.py
===================================================================
--- zope.generic/trunk/src/zope/generic/configuration/api.py	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/configuration/api.py	2006-05-17 16:14:18 UTC (rev 68171)
@@ -20,7 +20,7 @@
 
 from zope.generic.configuration import *
 from zope.generic.configuration.adapter import AttributeConfigurations
-from zope.generic.configuration.base import ConfigurationData
+from zope.generic.configuration.base import createConfiguration
 from zope.generic.configuration.helper import configuratonToDict
 from zope.generic.configuration.helper import provideConfigurationType
 from zope.generic.configuration.helper import requiredInOrder
@@ -118,7 +118,7 @@
     # assume that kws are ok
     if not pos:
         try:
-            return ConfigurationData(__keyface__, kws)
+            return createConfiguration(__keyface__, kws)
 
         except:
             pass
@@ -143,5 +143,5 @@
     if errors:
         raise AttributeError('Duplicated arguments: %s.' % ', '.join(errors))
 
-    return ConfigurationData(__keyface__, kws)
+    return createConfiguration(__keyface__, kws)
         
\ No newline at end of file

Modified: zope.generic/trunk/src/zope/generic/configuration/base.py
===================================================================
--- zope.generic/trunk/src/zope/generic/configuration/base.py	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/configuration/base.py	2006-05-17 16:14:18 UTC (rev 68171)
@@ -37,7 +37,11 @@
 from zope.generic.configuration import IConfigurationType
 
 
+def createConfiguration(keyface, data):
+    return ConfigurationData(keyface, data)
 
+
+
 def subData(name, data):
     """Return a subdata dict and remove the subdata from the given data dict.
 
@@ -75,7 +79,7 @@
                 try:
                     subdata = subData(name, data)
                     if subdata or field.required is True:
-                        data[name] = ConfigurationData(field.schema, subData(name, data))
+                        data[name] = createConfiguration(field.schema, subData(name, data))
                         continue
 
                 except:

Modified: zope.generic/trunk/src/zope/generic/configuration/helper.py
===================================================================
--- zope.generic/trunk/src/zope/generic/configuration/helper.py	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/configuration/helper.py	2006-05-17 16:14:18 UTC (rev 68171)
@@ -50,8 +50,8 @@
 
     Minimal data without defaults:
 
-        >>> from zope.generic.configuration.base import ConfigurationData
-        >>> configuration = ConfigurationData(IAnyConfiguration, {'a': u'a bla'})
+        >>> from zope.generic.configuration.base import createConfiguration
+        >>> configuration = createConfiguration(IAnyConfiguration, {'a': u'a bla'})
         >>> api.configuratonToDict(configuration)
         {'a': u'a bla'}
 

Modified: zope.generic/trunk/src/zope/generic/content/EXAMPLE.txt
===================================================================
--- zope.generic/trunk/src/zope/generic/content/EXAMPLE.txt	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/content/EXAMPLE.txt	2006-05-17 16:14:18 UTC (rev 68171)
@@ -108,17 +108,17 @@
     ...     provideInformation(INoteConfig, {'body': note}, context)
     ...     deleteInformation(IArticleInitializationConfiguration, context)
  
-    >>> from zope.generic.configuration.api import ConfigurationData
+    >>> from zope.generic.configuration.api import createConfiguration
     
-    >>> textDefaults = ConfigurationData(ITextConfig, 
+    >>> textDefaults = createConfiguration(ITextConfig, 
     ...     {'body': u"This is the default text."})
 
-    >>> noteDefaults = ConfigurationData(INoteConfig, 
+    >>> noteDefaults = createConfiguration(INoteConfig, 
     ...     {'body': u"This is the default note."})
 
-    >>> articleTextDefaults = ConfigurationData(ITextConfig, 
+    >>> articleTextDefaults = createConfiguration(ITextConfig, 
     ...     {'body': u"This is the default article."})
-    >>> articleNoteDefaults = ConfigurationData(INoteConfig, 
+    >>> articleNoteDefaults = createConfiguration(INoteConfig, 
     ...     {'body': u""})
 
     >>> registerDirective('''

Modified: zope.generic/trunk/src/zope/generic/content/README.txt
===================================================================
--- zope.generic/trunk/src/zope/generic/content/README.txt	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/content/README.txt	2006-05-17 16:14:18 UTC (rev 68171)
@@ -136,8 +136,8 @@
     ...     />
     ... ''') 
 
-	>>> from zope.generic.configuration.api import ConfigurationData
-	>>> typedata = ConfigurationData(IAnyConfiguration, {'any': u'Guguseli from Type!'})
+	>>> from zope.generic.configuration.api import createConfiguration
+	>>> typedata = createConfiguration(IAnyConfiguration, {'any': u'Guguseli from Type!'})
 	>>> IAnyConfiguration.providedBy(typedata)
 	True
 
@@ -239,7 +239,7 @@
 	u'Specific initialization data.'
 
     >>> from zope.generic.configuration.api import IConfigurations
-	>>> objectdata = ConfigurationData(IAnyConfiguration, {'any': u'Guguseli from Object!'})
+	>>> objectdata = createConfiguration(IAnyConfiguration, {'any': u'Guguseli from Object!'})
 	>>> IConfigurations(bar)[IAnyConfiguration] = objectdata
 	
 	>>> queryInformation(IAnyConfiguration, bar).any

Modified: zope.generic/trunk/src/zope/generic/factory/factory.py
===================================================================
--- zope.generic/trunk/src/zope/generic/factory/factory.py	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/factory/factory.py	2006-05-17 16:14:18 UTC (rev 68171)
@@ -111,7 +111,7 @@
         >>> def init_handler(context, *pos, **kws):
         ...    print 'initializing'
 
-        >>> from zope.generic.configuration.api import ConfigurationData
+        >>> from zope.generic.configuration.api import createConfiguration
         >>> from zope.generic.operation import IOperationConfiguration
         >>> from zope.generic.operation.api import Operation
 

Modified: zope.generic/trunk/src/zope/generic/handler/metadirectives.py
===================================================================
--- zope.generic/trunk/src/zope/generic/handler/metadirectives.py	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/handler/metadirectives.py	2006-05-17 16:14:18 UTC (rev 68171)
@@ -19,7 +19,7 @@
 __docformat__ = 'restructuredtext'
 
 from zope.app.i18n import ZopeMessageFactory as _
-from zope.configuration.fields import GlobalInterface
+from zope.configuration.fields import GlobalObject
 from zope.interface import Interface
 
 from zope.generic.informationprovider.metadirectives import IKeyfaceDirective
@@ -31,7 +31,7 @@
 class IEventDirective(Interface):
     """Event directive."""
 
-    event = GlobalInterface(
+    event = GlobalObject(
         title=_('Event'),
         description=_('The event to be listened.'),
         required=True

Modified: zope.generic/trunk/src/zope/generic/informationprovider/NEW_README.txt
===================================================================
--- zope.generic/trunk/src/zope/generic/informationprovider/NEW_README.txt	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/informationprovider/NEW_README.txt	2006-05-17 16:14:18 UTC (rev 68171)
@@ -65,7 +65,7 @@
 You can provide all configuration value, but at least you have to provide
 the required ones.
 
-    >>> from zope.generic.configuration.api import ConfigurationData
+    >>> from zope.generic.configuration.api import createConfiguration
 
     >>> supplier_default = {'header': 'Supplier', 'timeFormat': '%y.%m.%d'}
 
@@ -184,7 +184,7 @@
     >>> class IMy(interface.Interface):
     ...     """My own key interface."""
 
-    >>> my_supplier = ConfigurationData(ILogConfiguration, {'header': 'My Supplier'})
+    >>> my_supplier = createConfiguration(ILogConfiguration, {'header': 'My Supplier'})
 
     >>> registerDirective('''
     ... <generic:informationProvider
@@ -225,7 +225,7 @@
     >>> class IMy(IUndefinedKeyface):
     ...     """My own key interface."""
 
-    >>> my_supplier = ConfigurationData(ILogConfiguration, {'header': 'My Supplier'})
+    >>> my_supplier = createConfiguration(ILogConfiguration, {'header': 'My Supplier'})
 
     >>> registerDirective('''
     ... <generic:informationProvider
@@ -258,7 +258,7 @@
 As soon as we configure the user context information provider we ca overwrite
 the default settings, too:
 
-    >>> my_user = ConfigurationData(ILogConfiguration, {'header': 'My User'})
+    >>> my_user = createConfiguration(ILogConfiguration, {'header': 'My User'})
 
     >>> registerDirective('''
     ... <generic:informationProvider

Modified: zope.generic/trunk/src/zope/generic/informationprovider/README.txt
===================================================================
--- zope.generic/trunk/src/zope/generic/informationprovider/README.txt	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/informationprovider/README.txt	2006-05-17 16:14:18 UTC (rev 68171)
@@ -138,8 +138,8 @@
 
     >>> my_annotation = object()
 
-    >>> from zope.generic.configuration.api import ConfigurationData
-    >>> my_configuration = ConfigurationData(IMyConfiguration, {'my': u'My!'})
+    >>> from zope.generic.configuration.api import createConfiguration
+    >>> my_configuration = createConfiguration(IMyConfiguration, {'my': u'My!'})
 
     >>> registerDirective('''
     ... <generic:informationProvider

Modified: zope.generic/trunk/src/zope/generic/informationprovider/api.py
===================================================================
--- zope.generic/trunk/src/zope/generic/informationprovider/api.py	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/informationprovider/api.py	2006-05-17 16:14:18 UTC (rev 68171)
@@ -24,7 +24,7 @@
 
 from zope.generic.configuration import IConfigurationType
 from zope.generic.configuration import IConfigurations
-from zope.generic.configuration.api import ConfigurationData
+from zope.generic.configuration.api import createConfiguration
 from zope.generic.face import IConfaceType
 from zope.generic.face import IKeyfaceType
 from zope.generic.face import IUndefinedContext
@@ -144,7 +144,7 @@
 
     if IConfigurationType.providedBy(informationkey):
         if type(information) is dict:
-            information = ConfigurationData(informationkey, information)
+            information = createConfiguration(informationkey, information)
     
         IConfigurations(context)[informationkey] = information
 

Modified: zope.generic/trunk/src/zope/generic/informationprovider/metaconfigure.py
===================================================================
--- zope.generic/trunk/src/zope/generic/informationprovider/metaconfigure.py	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/informationprovider/metaconfigure.py	2006-05-17 16:14:18 UTC (rev 68171)
@@ -36,7 +36,7 @@
 
 from zope.generic.configuration import IConfigurations
 from zope.generic.configuration import IConfigurationType
-from zope.generic.configuration.api import ConfigurationData
+from zope.generic.configuration.api import createConfiguration
 from zope.generic.face import IConfaceType
 from zope.generic.face import IKeyfaceType
 from zope.generic.face import IUndefinedContext
@@ -105,7 +105,7 @@
     """Provide a configuration for a certain type marker."""
 
     if type(configuration) is dict:
-        configuration = ConfigurationData(configuration_keyface, configuration)
+        configuration = createConfiguration(configuration_keyface, configuration)
 
     info = getInformationProvider(keyface, conface)
     
@@ -151,7 +151,7 @@
 
                 if subdata or field.required is True:
                     try:
-                        data[name] = ConfigurationData(subkeyface, subdata)
+                        data[name] = createConfiguration(subkeyface, subdata)
                         continue
                     except:
                         if field.required is False:

Modified: zope.generic/trunk/src/zope/generic/operation/README.txt
===================================================================
--- zope.generic/trunk/src/zope/generic/operation/README.txt	2006-05-17 15:19:12 UTC (rev 68170)
+++ zope.generic/trunk/src/zope/generic/operation/README.txt	2006-05-17 16:14:18 UTC (rev 68171)
@@ -27,13 +27,13 @@
     ...    b = TextLine()
 
     >>> from zope.generic.configuration.api import parameterToConfiguration
-    >>> from zope.generic.configuration.api import ConfigurationData
+    >>> from zope.generic.configuration.api import createConfiguration
 
     >>> def anyOperation(context, *pos, **kws):
     ...     input = parameterToConfiguration(IAnyInput, *pos, **kws)
     ...     print 'Any input: a=%s, b=%s, c=%s.' % (input.a, input.b, input.c)
     ...     print 'Operate on *%s*.' % context
-    ...     return ConfigurationData(IAnyOutput, {'b': u'b operated'})
+    ...     return createConfiguration(IAnyOutput, {'b': u'b operated'})
 
 We have to register those parts:
 
@@ -165,7 +165,7 @@
 the input parameter for the pau- and the any-operation, and the fourth should
 avoid the return value of the any-operation:
 
-    >>> from zope.generic.configuration.api import ConfigurationData
+    >>> from zope.generic.configuration.api import createConfiguration
     >>> from zope.generic.informationprovider.api import getInformation
     >>> from zope.generic.informationprovider.api import provideInformation
 



More information about the Checkins mailing list