Changeset 5819

Timestamp:

08/06/07 08:58:56 (1 year ago)

Author:

russellm

Message:

Fixed #3297 -- Implemented FileField? and ImageField? for newforms. Thanks to the many users that contributed to and tested this patch.

Files:

• django/trunk/django/db/models/fields/__init__.py (modified) (4 diffs)
• django/trunk/django/db/models/fields/related.py (modified) (1 diff)
• django/trunk/django/newforms/extras/widgets.py (modified) (1 diff)
• django/trunk/django/newforms/fields.py (modified) (3 diffs)
• django/trunk/django/newforms/forms.py (modified) (4 diffs)
• django/trunk/django/newforms/models.py (modified) (2 diffs)
• django/trunk/django/newforms/widgets.py (modified) (6 diffs)
• django/trunk/docs/newforms.txt (modified) (3 diffs)
• django/trunk/tests/regressiontests/forms/tests.py (modified) (7 diffs)

django/trunk/django/db/models/fields/__init__.py

@@ -381 +381 @@
-    choices = property(_get_choices)
-
+    def save_form_data(self, instance, data):
+        setattr(instance, self.name, data)
+        
-    def formfield(self, form_class=forms.CharField, **kwargs):
-        "Returns a django.newforms.Field instance for this database Field."
@@ -696 +699 @@
-        self.upload_to = upload_to
-        Field.__init__(self, verbose_name, name, **kwargs)
+
+    def get_db_prep_save(self, value):
+        "Returns field's value prepared for saving into a database."
+        # Need to convert UploadedFile objects provided via a form to unicode for database insertion
+        if value is None:
+            return None
+        return unicode(value)
-
-    def get_manipulator_fields(self, opts, manipulator, change, name_prefix='', rel=False, follow=True):
@@ -773 +783 @@
-        return os.path.normpath(f)
-
+    def save_form_data(self, instance, data):
+        if data:
+            getattr(instance, "save_%s_file" % self.name)(os.path.join(self.upload_to, data.filename), data.content, save=False)
+        
+    def formfield(self, **kwargs):
+        defaults = {'form_class': forms.FileField}
+        # If a file has been provided previously, then the form doesn't require 
+        # that a new file is provided this time.
+        if 'initial' in kwargs:
+            defaults['required'] = False
+        defaults.update(kwargs)
+        return super(FileField, self).formfield(**defaults)
+
-class FilePathField(Field):
-    def __init__(self, verbose_name=None, name=None, path='', match=None, recursive=False, **kwargs):
@@ -820 +843 @@
-                setattr(new_object, self.height_field, getattr(original_object, self.height_field))
-            new_object.save()
+
+    def formfield(self, **kwargs):
+        defaults = {'form_class': forms.ImageField}
+        return super(ImageField, self).formfield(**defaults)
-
-class IntegerField(Field):

django/trunk/django/db/models/fields/related.py

@@ -757 +757 @@
-        return getattr(obj, self.attname).all()
-
+    def save_form_data(self, instance, data):
+        setattr(instance, self.attname, data)
+        
-    def formfield(self, **kwargs):
-        defaults = {'form_class': forms.ModelMultipleChoiceField, 'queryset': self.rel.to._default_manager.all()}

django/trunk/django/newforms/extras/widgets.py

@@ -54 +54 @@
-        return u'\n'.join(output)
-
-
+files, 
-        y, m, d = data.get(self.year_field % name), data.get(self.month_field % name), data.get(self.day_field % name)
-        if y and m and d:

django/trunk/django/newforms/fields.py

@@ -8 +8 @@
-
-from django.utils.translation import ugettext
-
+StrAndUnicode, 
-
-from util import ErrorList, ValidationError
-
+FileInput, 
-
-try:
@@ -23 +23 @@
-    'DEFAULT_TIME_INPUT_FORMATS', 'TimeField',
-    'DEFAULT_DATETIME_INPUT_FORMATS', 'DateTimeField',
-
+FileField', 'ImageField', '
-    'ChoiceField', 'NullBooleanField', 'MultipleChoiceField',
-    'ComboField', 'MultiValueField', 'FloatField', 'DecimalField',
@@ -349 +349 @@
-    URL_VALIDATOR_USER_AGENT = 'Django (http://www.djangoproject.com/)'
-
+class UploadedFile(StrAndUnicode):
+    "A wrapper for files uploaded in a FileField"
+    def __init__(self, filename, content):
+        self.filename = filename
+        self.content = content
+        
+    def __unicode__(self):
+        """
+        The unicode representation is the filename, so that the pre-database-insertion
+        logic can use UploadedFile objects
+        """
+        return self.filename
+
+class FileField(Field):
+    widget = FileInput
+    def __init__(self, *args, **kwargs):
+        super(FileField, self).__init__(*args, **kwargs)
+
+    def clean(self, data):
+        super(FileField, self).clean(data)
+        if not self.required and data in EMPTY_VALUES:
+            return None
+        try:
+            f = UploadedFile(data['filename'], data['content'])
+        except TypeError:
+            raise ValidationError(ugettext(u"No file was submitted. Check the encoding type on the form."))
+        except KeyError:
+            raise ValidationError(ugettext(u"No file was submitted."))
+        if not f.content:
+            raise ValidationError(ugettext(u"The submitted file is empty."))
+        return f
+
+class ImageField(FileField):
+    def clean(self, data):
+        """
+        Checks that the file-upload field data contains a valid image (GIF, JPG,
+        PNG, possibly others -- whatever the Python Imaging Library supports).
+        """
+        f = super(ImageField, self).clean(data)
+        if f is None:
+            return None
+        from PIL import Image
+        from cStringIO import StringIO
+        try:
+            Image.open(StringIO(f.content))
+        except IOError: # Python Imaging Library doesn't recognize it as an image
+            raise ValidationError(ugettext(u"Upload a valid image. The file you uploaded was either not an image or a corrupted image."))
+        return f
+        
-class URLField(RegexField):
-    def __init__(self, max_length=None, min_length=None, verify_exists=False,

django/trunk/django/newforms/forms.py

@@ -58 +58 @@
-    # information. Any improvements to the form API should be made to *this*
-    # class, not to the Form class.
-
-
+files=None, 
+ or files is not None
-        self.data = data or {}
+        self.files = files or {}
-        self.auto_id = auto_id
-        self.prefix = prefix
@@ -89 +90 @@
-
-    def _get_errors(self):
-self.data
+the data provided for the form
-        if self._errors is None:
-            self.full_clean()
@@ -180 +181 @@
-        self.cleaned_data = {}
-        for name, field in self.fields.items():
-ictionary
+ata dictionaries
-            # Each widget type knows how to retrieve its own data, because some
-            # widgets split data over several HTML fields.
-
+files, self.
-            try:
-                value = field.clean(value)
@@ -284 +285 @@
-        Returns the data for this BoundField, or None if it wasn't given.
-        """
-
+form.files, self.
-    data = property(_data)
-

django/trunk/django/newforms/models.py

@@ -35 +35 @@
-        if fields and f.name not in fields:
-            continue
-setattr(instance, f.name, cleaned_data[f.name])
+f.save_form_data(instance, cleaned_data[f.name])        
-    # Wrap up the saving of m2m data as a function
-    def save_m2m():
@@ -44 +44 @@
-                continue
-            if f.name in cleaned_data:
-setattr(instance, f.attnam
+f.save_form_data(instanc
-    if commit:
-        # If we are committing, save the instance and the m2m data immediately

django/trunk/django/newforms/widgets.py

@@ -48 +48 @@
-        return attrs
-
-
+files, 
-        """
-        Given a dictionary of data and this widget's name, returns the value
@@ -114 +114 @@
-        return u'\n'.join([(u'<input%s />' % flatatt(dict(value=force_unicode(v), **final_attrs))) for v in value])
-
-
+files, 
-        if isinstance(data, MultiValueDict):
-            return data.getlist(name)
@@ -121 +121 @@
-class FileInput(Input):
-    input_type = 'file'
+
+    def render(self, name, value, attrs=None):
+        return super(FileInput, self).render(name, None, attrs=attrs)
+        
+    def value_from_datadict(self, data, files, name):
+        "File widgets take data from FILES, not POST"
+        return files.get(name, None)
-
-class Textarea(Widget):
@@ -189 +196 @@
-        return super(NullBooleanSelect, self).render(name, value, attrs, choices)
-
-
+files, 
-        value = data.get(name, None)
-        return {u'2': True, u'3': False, True: True, False: False}.get(value, None)
@@ -211 +218 @@
-        return u'\n'.join(output)
-
-
+files, 
-        if isinstance(data, MultiValueDict):
-            return data.getlist(name)
@@ -378 +385 @@
-    id_for_label = classmethod(id_for_label)
-
-
-
+files, 
+files, 
-
-    def format_output(self, rendered_widgets):

django/trunk/docs/newforms.txt

@@ -711 +711 @@
-    </form>
-
+Binding uploaded files to a form
+--------------------------------
+
+Dealing with forms that have ``FileField`` and ``ImageField`` fields
+is a little more complicated than a normal form.
+
+Firstly, in order to upload files, you'll need to make sure that your
+``<form>`` element correctly defines the ``enctype`` as
+``"multipart/form-data"``::
+
+  <form enctype="multipart/form-data" method="post" action="/foo/">
+
+Secondly, when you use the form, you need to bind the file data. File
+data is handled separately to normal form data, so when your form
+contains a ``FileField`` and ``ImageField``, you will need to specify
+a second argument when you bind your form. So if we extend our
+ContactForm to include an ``ImageField`` called ``mugshot``, we
+need to bind the file data containing the mugshot image::
+
+    # Bound form with an image field
+    >>> data = {'subject': 'hello',
+    ...         'message': 'Hi there',
+    ...         'sender': 'foo@example.com',
+    ...         'cc_myself': True}
+    >>> file_data = {'mugshot': {'filename':'face.jpg'
+    ...                          'content': <file data>}}
+    >>> f = ContactFormWithMugshot(data, file_data)
+
+In practice, you will usually specify ``request.FILES`` as the source
+of file data (just like you use ``request.POST`` as the source of
+form data)::
+
+    # Bound form with an image field, data from the request
+    >>> f = ContactFormWithMugshot(request.POST, request.FILES)
+
+Constructing an unbound form is the same as always -- just omit both
+form data *and* file data:
+
+    # Unbound form with a image field
+    >>> f = ContactFormWithMugshot()
+
-Subclassing forms
------------------
@@ -1100 +1141 @@
-given length.
-
+``FileField``
+~~~~~~~~~~~~~
+
+    * Default widget: ``FileInput``
+    * Empty value: ``None``
+    * Normalizes to: An ``UploadedFile`` object that wraps the file content
+      and file name into a single object.
+    * Validates that non-empty file data has been bound to the form.
+
+An ``UploadedFile`` object has two attributes:
+
+    ======================  =====================================================
+    Argument                Description
+    ======================  =====================================================
+    ``filename``            The name of the file, provided by the uploading
+                            client.
+    ``content``             The array of bytes comprising the file content.
+    ======================  =====================================================
+
+The string representation of an ``UploadedFile`` is the same as the filename
+attribute.
+
+When you use a ``FileField`` on a form, you must also remember to
+`bind the file data to the form`_.
+
+.. _`bind the file data to the form`: `Binding uploaded files to a form`_
+
+``ImageField``
+~~~~~~~~~~~~~~
+
+    * Default widget: ``FileInput``
+    * Empty value: ``None``
+    * Normalizes to: An ``UploadedFile`` object that wraps the file content
+      and file name into a single object.
+    * Validates that file data has been bound to the form, and that the
+      file is of an image format understood by PIL.
+
+Using an ImageField requires that the `Python Imaging Library`_ is installed.
+
+When you use a ``FileField`` on a form, you must also remember to
+`bind the file data to the form`_.
+
+.. _Python Imaging Library: http://www.pythonware.com/products/pil/
+
-``IntegerField``
-~~~~~~~~~~~~~~~~
@@ -1379 +1464 @@
-    ``DecimalField``                 ``DecimalField``
-    ``EmailField``                   ``EmailField``
-Char
+File
-    ``FilePathField``                ``CharField``
-    ``FloatField``                   ``FloatField``
-    ``ForeignKey``                   ``ModelChoiceField`` (see below)
-Char
+Image
-    ``IntegerField``                 ``IntegerField``
-    ``IPAddressField``               ``CharField``

django/trunk/tests/regressiontests/forms/tests.py

@@ -174 +174 @@
-# FileInput Widget ############################################################
-
+FileInput widgets don't ever show the value, because the old value is of no use
+if you are updating the form or if the provided file generated an error.
->>> w = FileInput()
->>> w.render('email', '')
@@ -180 +182 @@
-u'<input type="file" name="email" />'
->>> w.render('email', 'test@example.com')
-value="test@example.com" 
+
->>> w.render('email', 'some "quoted" & ampersanded value')
-value="some &quot;quoted&quot; &amp; ampersanded value" 
+
->>> w.render('email', 'test@example.com', attrs={'class': 'fun'})
-value="test@example.com" 
+
-
-You can also pass 'attrs' to the constructor:
@@ -191 +193 @@
-u'<input type="file" class="fun" name="email" />'
->>> w.render('email', 'foo@example.com')
-value="foo@example.com" 
+
-
->>> w.render('email', 'ŠĐĆŽćžšđ', attrs={'class': 'fun'})
-value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" 
+
-
-# Textarea Widget #############################################################
@@ -1532 +1534 @@
-...
-ValidationError: [u'Ensure this value has at most 15 characters (it has 20).']
+
+# FileField ##################################################################
+
+>>> f = FileField()
+>>> f.clean('')
+Traceback (most recent call last):
+...
+ValidationError: [u'This field is required.']
+
+>>> f.clean(None)
+Traceback (most recent call last):
+...
+ValidationError: [u'This field is required.']
+
+>>> f.clean({})
+Traceback (most recent call last):
+...
+ValidationError: [u'No file was submitted.']
+
+>>> f.clean('some content that is not a file')
+Traceback (most recent call last):
+...
+ValidationError: [u'No file was submitted. Check the encoding type on the form.']
+
+>>> f.clean({'filename': 'name', 'content':None})
+Traceback (most recent call last):
+...
+ValidationError: [u'The submitted file is empty.']
+
+>>> f.clean({'filename': 'name', 'content':''})
+Traceback (most recent call last):
+...
+ValidationError: [u'The submitted file is empty.']
+
+>>> type(f.clean({'filename': 'name', 'content':'Some File Content'}))
+<class 'django.newforms.fields.UploadedFile'>
-
-# URLField ##################################################################
@@ -2574 +2612 @@
->>> class MyForm(Form):
-...     def __init__(self, data=None, auto_id=False, field_list=[]):
-
+=auto_id
-...         for field in field_list:
-...             self.fields[field[0]] = field[1]
@@ -2592 +2630 @@
-...     default_field_2 = CharField()
-...     def __init__(self, data=None, auto_id=False, field_list=[]):
-
+=auto_id
-...         for field in field_list:
-...             self.fields[field[0]] = field[1]
@@ -3247 +3285 @@
-</select>
-
+# Forms with FileFields ################################################
+
+FileFields are a special case because they take their data from the request.FILES,
+not request.POST. 
+
+>>> class FileForm(Form):
+...     file1 = FileField()
+>>> f = FileForm(auto_id=False)
+>>> print f
+<tr><th>File1:</th><td><input type="file" name="file1" /></td></tr>
+
+>>> f = FileForm(data={}, files={}, auto_id=False)
+>>> print f
+<tr><th>File1:</th><td><ul class="errorlist"><li>This field is required.</li></ul><input type="file" name="file1" /></td></tr>
+
+>>> f = FileForm(data={}, files={'file1': {'filename': 'name', 'content':''}}, auto_id=False)
+>>> print f
+<tr><th>File1:</th><td><ul class="errorlist"><li>The submitted file is empty.</li></ul><input type="file" name="file1" /></td></tr>
+
+>>> f = FileForm(data={}, files={'file1': 'something that is not a file'}, auto_id=False)
+>>> print f
+<tr><th>File1:</th><td><ul class="errorlist"><li>No file was submitted. Check the encoding type on the form.</li></ul><input type="file" name="file1" /></td></tr>
+
+>>> f = FileForm(data={}, files={'file1': {'filename': 'name', 'content':'some content'}}, auto_id=False)
+>>> print f
+<tr><th>File1:</th><td><input type="file" name="file1" /></td></tr>
+>>> f.is_valid()
+True
+
-# Basic form processing in a view #############################################
-