Ticket #5387: form-is-multipart-test-docs.diff

django/newforms/forms.py

@@ -212 +212 @@
-        """
-        return self.cleaned_data
-
+    def is_multipart(self):
+        """
+        Returns True if the form needs to be multipart-encrypted, i.e. it has
+        FileInput. Otherwise, False.
+        """
+        # python 2.5 syntax
+        # return all(field.widget.needs_multipart_form for field in self.fields.values())
+        for field in self.fields.values():
+            if field.widget.needs_multipart_form:
+                return True
+        return False
+
-class Form(BaseForm):
-    "A collection of Fields, plus their associated data."
-    # This is a separate class from BaseForm in order to abstract the way

django/newforms/widgets.py

@@ -24 +24 @@
-
-class Widget(object):
-    is_hidden = False          # Determines whether this corresponds to an <input type="hidden">.
+    needs_multipart_form = False # Determines does this widget need multipart-encrypted form
-
-    def __init__(self, attrs=None):
-        if attrs is not None:
@@ -120 +121 @@
-
-class FileInput(Input):
-    input_type = 'file'
+    needs_multipart_form = True
-
-    def render(self, name, value, attrs=None):
-        return super(FileInput, self).render(name, None, attrs=attrs)

docs/newforms.txt

@@ -776 +776 @@
-    # Unbound form with a image field
-    >>> f = ContactFormWithMugshot()
-
+If you're writing some generic views and templates, you can check 
+that your form needs proper ``enctype`` with the help from ``is_multipart()``::
+
+    >>> f = ContactFormWithMugshot()
+    >>> f.is_multipart()
+    True
+
-Subclassing forms
------------------
-

tests/regressiontests/forms/tests.py

@@ -3856 +3856 @@
-<div class="errorlist"><div class="error">This field is required.</div></div>
-<p>Comment: <input type="text" name="comment" /></p>
-
+#################################
+# Test multipart-encrypted form #
+#################################
+
+>>> class FormWithoutFile(Form):
+...     username = CharField()
+>>> class FormWithFile(Form):
+...     username = CharField()
+...     file = FileField()
+>>> class FormWithImage(Form):
+...     image = ImageField()
+
+>>> FormWithoutFile().is_multipart()
+False
+>>> FormWithFile().is_multipart()
+True
+>>> FormWithImage().is_multipart()
+True
+
-"""
-
-__test__ = {