Browse Source

Fixed #22786 -- Documented value_from_datadict caveat

Thanks blueyed for the report and Tim Graham for the review.
Claude Paroz 10 years ago
parent
commit
909015a51b
1 changed files with 6 additions and 1 deletions
  1. 6 1
      docs/ref/forms/widgets.txt

+ 6 - 1
docs/ref/forms/widgets.txt

@@ -230,7 +230,12 @@ foundation for custom widgets.
     .. method:: value_from_datadict(data, files, name)
 
         Given a dictionary of data and this widget's name, returns the value
-        of this widget. Returns ``None`` if a value wasn't provided.
+        of this widget. ``files`` may contain data coming from
+        :attr:`request.FILES <django.http.HttpRequest.FILES>`. Returns ``None``
+        if a value wasn't provided. Note also that ``value_from_datadict`` may
+        be called more than once during handling of form data, so if you
+        customize it and add expensive processing, you should implement some
+        caching mechanism yourself.
 
 .. class:: MultiWidget(widgets, attrs=None)