Reestructuring the code and new backward incompatible version

Author: Jesús Espino

setup.py

@@ -1,11 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-import os # To avoid an error importing validatedfile for versiontools
-os.environ['DJANGO_SETTINGS_MODULE'] = 'testing.settings'
-
 from setuptools import setup, find_packages
-import validatedfile
 
 setup(
     name = 'django-validated-file',

testing/forms.py

@@ -1,23 +1,24 @@
 from django import forms
-from models import TestModel, TestModelNoValidate, TestContainer, TestElement
-from validatedfile import QuotaValidator
+from models import TestModel, TestModelNoValidate, TestElement
+from validatedfile.fields import QuotaValidator
+
 
 class TestModelForm(forms.ModelForm):
-    
+
     class Meta:
         model = TestModel
 
 
 class TestModelNoValidateForm(forms.ModelForm):
-    
+
     class Meta:
         model = TestModelNoValidate
 
 
 class TestElementForm(forms.ModelForm):
 
-    the_file = forms.FileField(required = False,
-                    validators = [QuotaValidator(max_usage = 10000)])
+    the_file = forms.FileField(required=False,
+                               validators=[QuotaValidator(max_usage=10000)])
 
     class Meta:
         model = TestElement
@@ -27,15 +28,14 @@ def __init__(self, container, *args, **kwargs):
         super(TestElementForm, self).__init__(*args, **kwargs)
         self.container = container
         self.fields['the_file'].validators[0].update_quota(
-                items = self.container.test_elements.all(),
-                attr_name = 'the_file',
-            )
+            items=self.container.test_elements.all(),
+            attr_name='the_file',
+        )
 
     def exceeds_quota(self):
         return self.fields['the_file'].validators[0].quota.exceeds()
 
     def save(self, *args, **kwargs):
-        element = super(TestElementForm, self).save(commit = False)
+        element = super(TestElementForm, self).save(commit=False)
         element.container = self.container
         element.save()
-

testing/models.py

@@ -1,5 +1,5 @@
 from django.db import models
-from validatedfile import ValidatedFileField
+from validatedfile.fields import ValidatedFileField
 
 class TestModel(models.Model):
     the_file = ValidatedFileField(

testing/tests.py

@@ -5,7 +5,7 @@
 
 import os.path
 
-from validatedfile import FileQuota
+from validatedfile.fields import FileQuota
 
 from testing.models import TestModel, TestModelNoValidate, TestContainer, TestElement
 from testing.forms import TestModelForm, TestModelNoValidateForm, TestElementForm

validatedfile/__init__.py

@@ -1,87 +1 @@
-__version__ = (1, 0, 0, "final", 0)
-
-from django.db import models
-from django import forms
-from django.template.defaultfilters import filesizeformat
-from django.utils.translation import ugettext as _
-
-import magic
-
-
-class ValidatedFileField(models.FileField):
-    def __init__(self, *args, **kwargs):
-        self.content_types = kwargs.pop("content_types", [])
-        self.max_upload_size = kwargs.pop("max_upload_size", 0)
-        self.mime_lookup_length = kwargs.pop("mime_lookup_length", 4096)
-        super(ValidatedFileField, self).__init__(*args, **kwargs)
-
-    def clean(self, *args, **kwargs):
-        data = super(ValidatedFileField, self).clean(*args, **kwargs)
-        file = data.file
-
-        if self.content_types:
-            uploaded_content_type = getattr(file, 'content_type', '')
-
-            mg = magic.Magic(mime=True)
-            content_type_magic = mg.from_buffer(
-                file.read(self.mime_lookup_length)
-            )
-            file.seek(0)
-
-            # Prefere mime-type instead mime-type from http header
-            if uploaded_content_type != content_type_magic:
-                uploaded_content_type = content_type_magic
-
-            if not uploaded_content_type in self.content_types:
-                raise forms.ValidationError(_('Files of type %(type)s are not supported.') % {'type': content_type_magic})
-
-        if self.max_upload_size and hasattr(file, '_size'):
-            if file._size > self.max_upload_size:
-                raise forms.ValidationError(_('Files of size greater than %(max_size)s are not allowed. Your file is %(current_size)s') %
-                                            {'max_size': filesizeformat(self.max_upload_size),
-                                             'current_size': filesizeformat(file._size)})
-
-        return data
-
-
-class FileQuota(object):
-
-    def __init__(self, max_usage = -1):
-        self.current_usage = 0
-        self.max_usage = max_usage
-
-    def update(self, items, attr_name):
-        self.current_usage = 0
-        for item in items:
-            the_file = getattr(item, attr_name, None)
-            if the_file:
-                try:
-                    self.current_usage += the_file.size
-                except AttributeError:
-                    pass # Protect against the inconsistence of that the file has been deleted in storage but still is in the field
-
-    def exceeds(self, size = 0):
-        if self.max_usage >= 0:
-            return (self.current_usage + size > self.max_usage)
-        else:
-            return False
-
-    def near_limit(self, limit_threshold = 0.8):
-        return (float(self.current_usage) / float(self.max_usage)) > limit_threshold
-
-
-class QuotaValidator(object):
-
-    def __init__(self, max_usage):
-        self.quota = FileQuota(max_usage)
-
-    def update_quota(self, items, attr_name):
-        self.quota.update(items, attr_name)
-
-    def __call__(self, file):
-        file_size = file.size
-        if self.quota.exceeds(file_size):
-            raise forms.ValidationError(_('Please keep the total uploaded files under %(total_size)s. With this file, the total would be %(exceed_size)s.' %
-                                   {'total_size': filesizeformat(self.quota.max_usage),
-                                    'exceed_size': filesizeformat(self.quota.current_usage + file_size)}))
-
+__version__ = (2, 0, 0, "final", 0)

validatedfile/fields.py

@@ -0,0 +1,89 @@
+from django.db import models
+from django import forms
+from django.template.defaultfilters import filesizeformat
+from django.utils.translation import ugettext as _
+
+import magic
+
+
+class ValidatedFileField(models.FileField):
+    def __init__(self, *args, **kwargs):
+        self.content_types = kwargs.pop("content_types", [])
+        self.max_upload_size = kwargs.pop("max_upload_size", 0)
+        self.mime_lookup_length = kwargs.pop("mime_lookup_length", 4096)
+        super(ValidatedFileField, self).__init__(*args, **kwargs)
+
+    def clean(self, *args, **kwargs):
+        data = super(ValidatedFileField, self).clean(*args, **kwargs)
+        file = data.file
+
+        if self.content_types:
+            uploaded_content_type = getattr(file, 'content_type', '')
+
+            mg = magic.Magic(mime=True)
+            content_type_magic = mg.from_buffer(
+                file.read(self.mime_lookup_length)
+            )
+            file.seek(0)
+
+            # Prefere mime-type instead mime-type from http header
+            if uploaded_content_type != content_type_magic:
+                uploaded_content_type = content_type_magic
+
+            if not uploaded_content_type in self.content_types:
+                raise forms.ValidationError(
+                    _('Files of type %(type)s are not supported.') % {'type': content_type_magic}
+                )
+
+        if self.max_upload_size and hasattr(file, '_size'):
+            if file._size > self.max_upload_size:
+                raise forms.ValidationError(
+                    _('Files of size greater than %(max_size)s are not allowed. Your file is %(current_size)s') %
+                    {'max_size': filesizeformat(self.max_upload_size), 'current_size': filesizeformat(file._size)}
+                )
+
+        return data
+
+
+class FileQuota(object):
+
+    def __init__(self, max_usage=-1):
+        self.current_usage = 0
+        self.max_usage = max_usage
+
+    def update(self, items, attr_name):
+        self.current_usage = 0
+        for item in items:
+            the_file = getattr(item, attr_name, None)
+            if the_file:
+                try:
+                    self.current_usage += the_file.size
+                except AttributeError:
+                    pass  # Protect against the inconsistence of that the file
+                          # has been deleted in storage but still is in the field
+
+    def exceeds(self, size=0):
+        if self.max_usage >= 0:
+            return (self.current_usage + size > self.max_usage)
+        else:
+            return False
+
+    def near_limit(self, limit_threshold=0.8):
+        return (float(self.current_usage) / float(self.max_usage)) > limit_threshold
+
+
+class QuotaValidator(object):
+
+    def __init__(self, max_usage):
+        self.quota = FileQuota(max_usage)
+
+    def update_quota(self, items, attr_name):
+        self.quota.update(items, attr_name)
+
+    def __call__(self, file):
+        file_size = file.size
+        if self.quota.exceeds(file_size):
+            raise forms.ValidationError(
+                _('Please keep the total uploaded files under %(total_size)s. With this file, the total would be %(exceed_size)s.' %
+                {'total_size': filesizeformat(self.quota.max_usage), 'exceed_size': filesizeformat(self.quota.current_usage + file_size)})
+            )