扩展表单域以添加新验证

时间:2010-04-28 23:14:53

标签: python django oop django-forms

我写了一个应用程序,它使用表单来收集信息,然后通过电子邮件发送。其中许多表单都有一个用于将文件附加到电子邮件的文件字段。我想验证两件事,即文件的大小(以确保我们的邮件服务器接受电子邮件。我还想检查文件扩展名,以阻止附加不适合我们用户的文件类型。

(这是我试图扩展的python类)

class FileField(Field):
    widget = FileInput
    default_error_messages = {
        'invalid': _(u"No file was submitted. Check the encoding type on the form."),
        'missing': _(u"No file was submitted."),
        'empty': _(u"The submitted file is empty."),
        'max_length': _(u'Ensure this filename has at most %(max)d characters (it has %(length)d).'),
    }

    def __init__(self, *args, **kwargs):
        self.max_length = kwargs.pop('max_length', None)
        super(FileField, self).__init__(*args, **kwargs)

    def clean(self, data, initial=None):
        super(FileField, self).clean(initial or data)
        if not self.required and data in EMPTY_VALUES:
            return None
        elif not data and initial:
            return initial

        # UploadedFile objects should have name and size attributes.
        try:
            file_name = data.name
            file_size = data.size
        except AttributeError:
            raise ValidationError(self.error_messages['invalid'])

        if self.max_length is not None and len(file_name) > self.max_length:
            error_values =  {'max': self.max_length, 'length': len(file_name)}
            raise ValidationError(self.error_messages['max_length'] % error_values)
        if not file_name:
            raise ValidationError(self.error_messages['invalid'])
        if not file_size:
            raise ValidationError(self.error_messages['empty'])
    return data

3 个答案:

答案 0 :(得分:2)

只是重载“干净”的方法:

def clean(self, data, initial=None):
    try:
        if data.size > somesize:
            raise ValidationError('File is too big')

        (junk, ext) = os.path.splitext(data.name)
        if not ext in ('.jpg', '.gif', '.png'):
            raise ValidationError('Invalid file type')

    except AttributeError:
        raise ValidationError(self.error_messages['invalid'])

    return FileField.clean(self, data, initial)

答案 1 :(得分:1)

在我看来,继承实际的字段类是很费劲的方法。简单地扩展表单类应该更容易。您可以添加一个“清理”文件字段的方法。

例如:

class MyForm(forms.Form):
  attachment = forms.FileField(...)

  def clean_attachment(self):
    data = self.cleaned_data['attachment'] // UploadedFile object
    exts = ['jpg', 'png'] // allowed extensions

    // 1. check file size
    if data.size > x:
      raise forms.ValidationError("file to big")

    // 2. check file extension
    file_extension = data.name.split('.')[1] // simple method

    if file_extension not in exts:
      raise forms.ValidationError("Wrong file type")

    return data

这只是一个基本的例子,并且有一些粗糙的边缘。但您可以使用此示例并对其进行改进,直到您拥有适合您的版本为止。

推荐读物:

Django Doc - Cleaning a specific field

Django Doc - UploadedFile class

Django Doc - File class

答案 2 :(得分:0)

这就是我最终做的事情:

在我的应用设置文件中:

exts = ['doc', 'docx', 'pdf', 'jpg', 'png', 'xls', 'xlsx', '.xlsm', '.xlsb']
max_email_attach_size = 10485760 #10MB written in bytes

在一个名为formfunctions的新文件中:

from django import forms
from django.forms.util import ErrorList, ValidationError
from app.settings import exts, max_email_attach_size


class SizedFileField(forms.FileField):

    def clean(self, data, initial=None):

        if not data in (None, ''):

            try:
                if data.size > max_email_attach_size:
                    raise ValidationError("The file is too big")

                file_extension = data.name.split('.')[1]
                if file_extension not in exts:
                    raise ValidationError("Invalid File Type")

            except AttributeError:
                raise ValidationError(self.error_messages['invalid'])

        return forms.FileField.clean(self, data, initial)

并在我的表单文件中:

from formfunctions import SizedFileField

表单文件中的示例类:

class ExampleClass(forms.Form):
    Email_Body = forms.CharField(widget=forms.Textarea, required=False)
    Todays_Date = forms.CharField()
    Attachment = SizedFileField(required=False)