Changeset 6277 for main/waeup.sirp/trunk

Timestamp:

4 Jun 2011, 11:19:25 (14 years ago)

Author:

uli

Message:

Update convert interface.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/interfaces.py (modified) (1 diff)

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

@@ -377 +377 @@
     """
 
-    def applyRowData(data_dict, context, form_fields=None):
-        """Apply data in `data_dict` to `context`.
-
-        `data_dict` is a dict containing field names as
-        keys. `context` is an object or string.
-
-        `data_dict` gives the values to set on an object where the
-        dict contains the attribute names as keys and values to set as
-        values. Values and keys have to be strings.
-
-        If `context` is a string, this is understood as a factory name
-        and we will try to create a proper object calling
-        ``createObject()``. If it is an object then we will update
-        this object.
-
-        `form_fields` are by default (``None``) buildt from the given
-        `iface` but can also be passed in to override the
-        default. This might be handy if you want to omit or select
-        certains fields from the interface.
-
-        Returns a tuple ``(<ERROR_LIST, INV_ERR_LIST, OBJ>)`` where
-        ``ERROR_DICT`` is a dict of errors for single fields (if
-        happened), ``INV_ERR_LIST`` is a list of invariant errors
-        happened (errors that apply to several fields), and ``OBJ`` is
-        the created/updated object.
-        """
+    def fromStringDict(self, data_dict, context, form_fields=None):
+        """Convert values in `data_dict`.
+
+        Converts data in `data_dict` into real values based on
+        `context` and `form_fields`.
+
+        `data_dict` is a mapping (dict) from field names to values
+        represented as strings.
+
+        The fields (keys) to convert can be given in optional
+        `form_fields`. If given, form_fields should be an instance of
+        :class:`zope.formlib.form.Fields`. Suitable instances are for
+        example created by :class:`grok.AutoFields`.
+
+        If no `form_fields` are given, a default is computed from the
+        associated interface.
+
+        The `context` can be an existing object (implementing the
+        associated interface) or a factory name. If it is a string, we
+        try to create an object using
+        :func:`zope.component.createObject`.
+
+        Returns a tuple ``(<FIELD_ERRORS>, <INVARIANT_ERRORS>,
+        <DATA_DICT>)`` where
+
+        ``<FIELD_ERRORS>``
+           is a list of tuples ``(<FIELD_NAME>, <ERROR>)`` for each
+           error that happened when validating the input data in
+           `data_dict`
+
+        ``<INVARIANT_ERRORS>``
+           is a list of invariant errors concerning several fields
+
+        ``<DATA_DICT>``
+           is a dict with the values from input dict converted.
+
+        If errors happen, i.e. the error lists are not empty, always
+        an empty ``<DATA_DICT>`` is returned.
+
+        If ``<DATA_DICT>` is non-empty, there were no errors.
+        """