Changeset 2518

Timestamp:

03/12/06 19:33:45 (3 years ago)

Author:

adrian

Message:

magic-removal: Added first bit of validation-aware models. Model objects now have a validate() method. See docstrings in db.models.base and db.models.fields.init for information. Also added unit tests for all the currently supported validation.

Files:

• django/branches/magic-removal/django/db/models/base.py (modified) (4 diffs)
• django/branches/magic-removal/django/db/models/fields/__init__.py (modified) (13 diffs)
• django/branches/magic-removal/tests/modeltests/validation (added)
• django/branches/magic-removal/tests/modeltests/validation/__init__.py (added)
• django/branches/magic-removal/tests/modeltests/validation/models.py (added)

django/branches/magic-removal/django/db/models/base.py

@@ -1 +1 @@
-import django.db.models.manipulators
-import django.db.models.manager
+from django.core import validators
+from django.core.exceptions import ObjectDoesNotExist
-from django.db.models.fields import AutoField, ImageField, FieldDoesNotExist
-from django.db.models.fields.related import OneToOne, ManyToOne
@@ -10 +12 @@
-from django.db.models.loading import register_models
-from django.dispatch import dispatcher
-from django.core.exceptions import ObjectDoesNotExist
-from django.utils.datastructures import SortedDict
-from django.utils.functional import curry
@@ -39 +40 @@
-        # Build complete list of parents
-        for base in bases:
+            # TODO: Checking for the presence of '_meta' is hackish.
-            if '_meta' in dir(base):
-                new_class._meta.parents.append(base)
@@ -197 +199 @@
-    save.alters_data = True
-
+    def validate(self):
+        """
+        First coerces all fields on this instance to their proper Python types.
+        Then runs validation on every field. Returns a dictionary of
+        field_name -> error_list.
+        """
+        error_dict = {}
+        invalid_python = {}
+        for f in self._meta.fields:
+            try:
+                setattr(self, f.attname, f.to_python(getattr(self, f.attname, f.get_default())))
+            except validators.ValidationError, e:
+                error_dict[f.name] = e.messages
+                invalid_python[f.name] = 1
+        for f in self._meta.fields:
+            if f.name in invalid_python:
+                continue
+            errors = f.validate_full(getattr(self, f.attname, f.get_default()), self.__dict__)
+            if errors:
+                error_dict[f.name] = errors
+        return error_dict
+
-    def _collect_sub_objects(self, seen_objs):
-        """

django/branches/magic-removal/django/db/models/fields/__init__.py

@@ -7 +7 @@
-from django.utils.functional import curry, lazy
-from django.utils.text import capfirst
-
-
+, gettext
+, time
-
-class NOT_PROVIDED:
@@ -38 +38 @@
-    if getattr(self, 'original_object', None) and self.original_object._get_pk_val() == old_obj._get_pk_val():
-        return
-_
+gettext
-
-# A guide to Field parameters:
@@ -97 +97 @@
-        return cmp(self.creation_counter, other.creation_counter)
-
+    def to_python(self, value):
+        """
+        Converts the input value into the expected Python data type, raising
+        validators.ValidationError if the data can't be converted. Returns the
+        converted value. Subclasses should override this.
+        """
+        return value
+
+    def validate_full(self, field_data, all_data):
+        """
+        Returns a list of errors for this field. This is the main interface,
+        as it encapsulates some basic validation logic used by all fields.
+        Subclasses should implement validate(), not validate_full().
+        """
+        if not self.blank and not field_data:
+            return [gettext_lazy('This field is required.')]
+        try:
+            self.validate(field_data, all_data)
+        except validators.ValidationError, e:
+            return e.messages
+        return []
+
+    def validate(self, field_data, all_data):
+        """
+        Raises validators.ValidationError if field_data has any errors.
+        Subclasses should override this to specify field-specific validation
+        logic. This method should assume field_data has already been converted
+        into the appropriate data type by Field.to_python().
+        """
+        pass
+
-    def set_attributes_from_name(self, name):
-        self.name = name
@@ -300 +331 @@
-    def __init__(self, *args, **kwargs):
-        assert kwargs.get('primary_key', False) is True, "%ss must have primary_key=True." % self.__class__.__name__
+        kwargs['blank'] = True
-        Field.__init__(self, *args, **kwargs)
+
+    def to_python(self, value):
+        if value is None:
+            return value
+        try:
+            return int(value)
+        except (TypeError, ValueError):
+            raise validators.ValidationError, gettext("This value must be an integer.")
-
-    def get_manipulator_fields(self, opts, manipulator, change, name_prefix='', rel=False, follow=True):
@@ -328 +368 @@
-        Field.__init__(self, *args, **kwargs)
-
+    def to_python(self, value):
+        if value in (True, False): return value
+        if value is 't': return True
+        if value is 'f': return False
+        raise validators.ValidationError, gettext("This value must be either True or False.")
+
-    def get_manipulator_field_objs(self):
-        return [forms.CheckboxField]
@@ -335 +381 @@
-        return [forms.TextField]
-
+    def to_python(self, value):
+        if isinstance(value, basestring):
+            return value
+        if value is None:
+            if self.null:
+                return value
+            else:
+                raise validators.ValidationError, gettext_lazy("This field cannot be null.")
+        return str(value)
+
+# TODO: Maybe move this into contrib, because it's specialized.
-class CommaSeparatedIntegerField(CharField):
-    def get_manipulator_field_objs(self):
@@ -349 +406 @@
-        Field.__init__(self, verbose_name, name, **kwargs)
-
+    def to_python(self, value):
+        if isinstance(value, datetime.datetime):
+            return value.date()
+        if isinstance(value, datetime.date):
+            return value
+        validators.isValidANSIDate(value, None)
+        return datetime.date(*time.strptime(value, '%Y-%m-%d')[:3])
+
-    def get_db_prep_lookup(self, lookup_type, value):
-        if lookup_type == 'range':
@@ -392 +457 @@
-
-class DateTimeField(DateField):
+    def to_python(self, value):
+        if isinstance(value, datetime.datetime):
+            return value
+        if isinstance(value, datetime.date):
+            return datetime.datetime(value.year, value.month, value.day)
+        try: # Seconds are optional, so try converting seconds first.
+            return datetime.datetime(*time.strptime(value, '%Y-%m-%d %H:%M:%S')[:6])
+        except ValueError:
+            try: # Try without seconds.
+                return datetime.datetime(*time.strptime(value, '%Y-%m-%d %H:%M')[:5])
+            except ValueError: # Try without hour/minutes/seconds.
+                try:
+                    return datetime.datetime(*time.strptime(value, '%Y-%m-%d')[:3])
+                except ValueError:
+                    raise validators.ValidationError, gettext('Enter a valid date/time in YYYY-MM-DD HH:MM format.')
+
-    def get_db_prep_save(self, value):
-        # Casts dates into string format for entry into database.
@@ -433 +514 @@
-                time_field: (val is not None and val.strftime("%H:%M:%S") or '')}
-
-
+Char
-    def __init__(self, *args, **kwargs):
-        kwargs['maxlength'] = 75
-
+Char
-
-    def get_internal_type(self):
@@ -443 +524 @@
-    def get_manipulator_field_objs(self):
-        return [forms.EmailField]
+
+    def validate(self, field_data, all_data):
+        validators.isValidEmail(field_data, all_data)
-
-class FileField(Field):
@@ -584 +668 @@
-        return [forms.IPAddressField]
-
+    def validate(self, field_data, all_data):
+        validators.isValidIPAddress4(field_data, None)
+
-class NullBooleanField(Field):
-    def __init__(self, *args, **kwargs):
@@ -595 +682 @@
-    def get_manipulator_field_objs(self):
-        return [forms.PhoneNumberField]
+
+    def validate(self, field_data, all_data):
+        validators.isValidPhone(field_data, all_data)
-
-class PositiveIntegerField(IntegerField):
@@ -627 +717 @@
-    empty_strings_allowed = False
-    def __init__(self, verbose_name=None, name=None, auto_now=False, auto_now_add=False, **kwargs):
- 
+
-        if auto_now or auto_now_add:
-            kwargs['editable'] = False