Changeset 8131

Timestamp:

07/29/08 00:09:29 (4 months ago)

Author:

mtredinnick

Message:

Fixed #7560 -- Moved a lot of the value conversion preparation for
loading/saving interactions with the databases into django.db.backend. This
helps external db backend writers and removes a bunch of database-specific
if-tests in django.db.models.fields.

Great work from Leo Soto.

Files:

• django/trunk/django/db/backends/__init__.py (modified) (5 diffs)
• django/trunk/django/db/backends/mysql/base.py (modified) (2 diffs)
• django/trunk/django/db/backends/oracle/base.py (modified) (3 diffs)
• django/trunk/django/db/backends/sqlite3/base.py (modified) (2 diffs)
• django/trunk/django/db/backends/util.py (modified) (1 diff)
• django/trunk/django/db/models/fields/__init__.py (modified) (16 diffs)
• django/trunk/docs/custom_model_fields.txt (modified) (5 diffs)
• django/trunk/tests/modeltests/custom_methods/models.py (modified) (1 diff)
• django/trunk/tests/modeltests/validation/models.py (modified) (4 diffs)
• django/trunk/tests/regressiontests/model_fields/tests.py (modified) (1 diff)
• django/trunk/tests/regressiontests/model_regress/models.py (modified) (2 diffs)

django/trunk/django/db/backends/__init__.py

@@ -5 +5 @@
-    # Import copy of _thread_local.py from Python 2.4
-    from django.utils._threading_local import local
+
+from django.db.backends import util
+from django.utils import datetime_safe
-
-class BaseDatabaseWrapper(local):
@@ -37 +40 @@
-
-    def make_debug_cursor(self, cursor):
-        from django.db.backends import util
-        return util.CursorDebugWrapper(cursor, self)
-
@@ -43 +45 @@
-    allows_group_by_ordinal = True
-    inline_fk_references = True
+    # True if django.db.backend.utils.typecast_timestamp is used on values
+    # returned from dates() calls.
-    needs_datetime_string_cast = True
-    supports_constraints = True
@@ -50 +54 @@
-    empty_fetchmany_value = []
-    update_can_self_select = True
-    supports_usecs = True
-    time_field_needs_date = False
-    interprets_empty_strings_as_nulls = False
-    date_field_supports_time_value = True
-    can_use_chunked_reads = True
-
@@ -264 +265 @@
-        from django.utils.encoding import smart_unicode
-        return smart_unicode(x).replace("\\", "\\\\").replace("%", "\%").replace("_", "\_")
+
+    def value_to_db_date(self, value):
+        """
+        Transform a date value to an object compatible with what is expected
+        by the backend driver for date columns.
+        """
+        if value is None:
+            return None
+        return datetime_safe.new_date(value).strftime('%Y-%m-%d')
+
+    def value_to_db_datetime(self, value):
+        """
+        Transform a datetime value to an object compatible with what is expected
+        by the backend driver for date columns.
+        """
+        if value is None:
+            return None
+        return unicode(value)
+
+    def value_to_db_time(self, value):
+        """
+        Transform a datetime value to an object compatible with what is expected
+        by the backend driver for date columns.
+        """
+        if value is None:
+            return None
+        return unicode(value)
+
+    def value_to_db_decimal(self, value, max_digits, decimal_places):
+        """
+        Transform a decimal.Decimal value to an object compatible with what is
+        expected by the backend driver for decimal (numeric) columns.
+        """
+        if value is None:
+            return None
+        return util.format_number(value, max_digits, decimal_places)
+
+    def year_lookup_bounds(self, value):
+        """
+        Returns a two-elements list with the lower and upper bound to be used
+        with a BETWEEN operator to query a field value using a year lookup
+
+        `value` is an int, containing the looked-up year.
+        """
+        first = '%s-01-01 00:00:00'
+        second = '%s-12-31 23:59:59.999999'
+        return [first % value, second % value]
+
+    def year_lookup_bounds_for_date_field(self, value):
+        """
+        Returns a two-elements list with the lower and upper bound to be used
+        with a BETWEEN operator to query a DateField value using a year lookup
+
+        `value` is an int, containing the looked-up year.
+
+        By default, it just calls `self.year_lookup_bounds`. Some backends need
+        this hook because on their DB date fields can't be compared to values
+        which include a time part.
+        """
+        return self.year_lookup_bounds(value)
+

django/trunk/django/db/backends/mysql/base.py

@@ -64 +64 @@
-    empty_fetchmany_value = ()
-    update_can_self_select = False
-    supports_usecs = False
-
-class DatabaseOperations(BaseDatabaseOperations):
@@ -124 +123 @@
-        else:
-            return []
+
+    def value_to_db_datetime(self, value):
+        # MySQL doesn't support microseconds
+        if value is None:
+            return None
+        return unicode(value.replace(microsecond=0))
+
+    def value_to_db_time(self, value):
+        # MySQL doesn't support microseconds
+        if value is None:
+            return None
+        return unicode(value.replace(microsecond=0))
+
+    def year_lookup_bounds(self, value):
+        # Again, no microseconds
+        first = '%s-01-01 00:00:00'
+        second = '%s-12-31 23:59:59.99'
+        return [first % value, second % value]
-
-class DatabaseWrapper(BaseDatabaseWrapper):

django/trunk/django/db/backends/oracle/base.py

@@ -6 +6 @@
-
-import os
+import datetime
+import time
-
-from django.db.backends import BaseDatabaseWrapper, BaseDatabaseFeatures, BaseDatabaseOperations, util
@@ -29 +31 @@
-    uses_case_insensitive_names = True
-    uses_custom_query_class = True
-    time_field_needs_date = True
-    interprets_empty_strings_as_nulls = True
-    date_field_supports_time_value = False
-
-class DatabaseOperations(BaseDatabaseOperations):
@@ -180 +180 @@
-    def tablespace_sql(self, tablespace, inline=False):
-        return "%sTABLESPACE %s" % ((inline and "USING INDEX " or ""), self.quote_name(tablespace))
+
+    def value_to_db_time(self, value):
+        if value is None:
+            return None
+        if isinstance(value, basestring):
+            return datetime.datetime(*(time.strptime(value, '%H:%M:%S')[:6]))
+        return datetime.datetime(1900, 1, 1, value.hour, value.minute,
+                                 value.second, value.microsecond)
+
+    def year_lookup_bounds_for_date_field(self, value):
+        first = '%s-01-01'
+        second = '%s-12-31'
+        return [first % value, second % value]
+
+
-
-class DatabaseWrapper(BaseDatabaseWrapper):

django/trunk/django/db/backends/sqlite3/base.py

@@ -85 +85 @@
-        return sql
-
+    def year_lookup_bounds(self, value):
+        first = '%s-01-01'
+        second = '%s-12-31 23:59:59.999999'
+        return [first % value, second % value]
+
+
-class DatabaseWrapper(BaseDatabaseWrapper):
-    features = DatabaseFeatures()
@@ -160 +166 @@
-    except (ValueError, TypeError):
-        return None
-str(getattr(dt, lookup_type)
+getattr(dt, lookup_type
-
-def _sqlite_date_trunc(lookup_type, dt):

django/trunk/django/db/backends/util.py

@@ -118 +118 @@
-
-    return '%s%s' % (name[:length-4], hash)
+
+def format_number(value, max_digits, decimal_places):
+    """
+    Formats a number into a string with the requisite number of digits and
+    decimal places.
+    """
+    return u"%.*f" % (decimal_places, value)

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

@@ -219 +219 @@
-        return getattr(model_instance, self.attname)
-
+    def get_db_prep_value(self, value):
+        """Returns field's value prepared for interacting with the database
+        backend.
+
+        Used by the default implementations of ``get_db_prep_save``and
+        `get_db_prep_lookup```
+        """
+        return value
+
-    def get_db_prep_save(self, value):
-        "Returns field's value prepared for saving into a database."
-value
+self.get_db_prep_value(value)
-
-    def get_db_prep_lookup(self, lookup_type, value):
@@ -228 +237 @@
-            sql, params = value.as_sql()
-            return QueryWrapper(('(%s)' % sql), params)
-exact', 'regex', 'iregex', 'gt', 'gte', 'lt', 'lte
+regex', 'iregex
-            return [value]
+        elif lookup_type in ('exact', 'gt', 'gte', 'lt', 'lte'):
+            return [self.get_db_prep_value(value)]
-        elif lookup_type in ('range', 'in'):
-value
+[self.get_db_prep_value(v) for v in value]
-        elif lookup_type in ('contains', 'icontains'):
-            return ["%%%s%%" % connection.ops.prep_for_like_query(value)]
@@ -247 +258 @@
-            except ValueError:
-                raise ValueError("The __year lookup type requires an integer argument")
-
-
-
-
-
-
-
-
-
+
+
+
-            else:
-
-
-
+
+
-        raise TypeError("Field has invalid lookup: %s" % lookup_type)
-
@@ -458 +462 @@
-            raise validators.ValidationError, _("This value must be an integer.")
-
+    def get_db_prep_value(self, value):
+        if value is None:
+            return None
+        return int(value)
+
-    def get_manipulator_fields(self, opts, manipulator, change, name_prefix='', rel=False, follow=True):
-        if not rel:
@@ -498 +507 @@
-        if value in ('f', 'False', '0'): return False
-        raise validators.ValidationError, _("This value must be either True or False.")
+
+    def get_db_prep_value(self, value):
+        if value is None:
+            return None
+        return bool(value)
-
-    def get_manipulator_field_objs(self):
@@ -560 +574 @@
-            raise validators.ValidationError, _('Enter a valid date in YYYY-MM-DD format.')
-
-    def get_db_prep_lookup(self, lookup_type, value):
-        if lookup_type in ('range', 'in'):
-            value = [smart_unicode(v) for v in value]
-        elif lookup_type in ('exact', 'gt', 'gte', 'lt', 'lte') and hasattr(value, 'strftime'):
-            value = datetime_safe.new_date(value).strftime('%Y-%m-%d')
-        else:
-            value = smart_unicode(value)
-        return Field.get_db_prep_lookup(self, lookup_type, value)
-
-    def pre_save(self, model_instance, add):
-        if self.auto_now or (self.auto_now_add and add):
@@ -592 +597 @@
-            return self.editable or self.auto_now or self.auto_now_add
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-
-    def get_manipulator_field_objs(self):
@@ -630 +628 @@
-        if isinstance(value, datetime.date):
-            return datetime.datetime(value.year, value.month, value.day)
+
+        # Attempt to parse a datetime:
+        value = smart_str(value)
+        # split usecs, because they are not recognized by strptime.
+        if '.' in value:
+            try:
+                value, usecs = value.split('.')
+                usecs = int(usecs)
+            except ValueError:
+                raise validators.ValidationError, _('Enter a valid date/time in YYYY-MM-DD HH:MM[ss[.uuuuuu]] format.')
+        else:
+            usecs = 0
+        kwargs = {'microsecond': usecs}
-        try: # Seconds are optional, so try converting seconds first.
-
+
+
+
-        except ValueError:
-            try: # Try without seconds.
-
+
+
-            except ValueError: # Try without hour/minutes/seconds.
-                try:
-
+
+
-                except ValueError:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
-
-    def get_manipulator_field_objs(self):
@@ -721 +723 @@
-        decimal places.
-        """
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-    def get_manipulator_field_objs(self):
@@ -779 +773 @@
-        return "FileField"
-
-sav
+valu
-        "Returns field's value prepared for saving into a database."
-        # Need to convert UploadedFile objects provided via a form to unicode for database insertion
@@ -920 +914 @@
-    empty_strings_allowed = False
-
+    def get_db_prep_value(self, value):
+        if value is None:
+            return None
+        return float(value)
+
-    def get_manipulator_field_objs(self):
-        return [oldforms.FloatField]
@@ -967 +966 @@
-class IntegerField(Field):
-    empty_strings_allowed = False
+    def get_db_prep_value(self, value):
+        if value is None:
+            return None
+        return int(value)
+
-    def get_manipulator_field_objs(self):
-        return [oldforms.IntegerField]
@@ -1014 +1018 @@
-        raise validators.ValidationError, _("This value must be either None, True or False.")
-
+    def get_db_prep_value(self, value):
+        if value is None:
+            return None
+        return bool(value)
+
-    def get_manipulator_field_objs(self):
-        return [oldforms.NullBooleanField]
@@ -1026 +1035 @@
-        return super(NullBooleanField, self).formfield(**defaults)
-
-Integer
+
-    def get_manipulator_field_objs(self):
-        return [oldforms.PhoneNumberField]
@@ -1108 +1117 @@
-        return "TimeField"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    def pre_save(self, model_instance, add):
@@ -1131 +1154 @@
-            return super(TimeField, self).pre_save(model_instance, add)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-
-    def get_manipulator_field_objs(self):

django/trunk/docs/custom_model_fields.txt

@@ -386 +386 @@
-mentioned earlier. Otherwise ``to_python()`` won't be called automatically.
-
-sav
-
+valu
+~
-
-This is the reverse of ``to_python()`` when working with the database backends
@@ -400 +400 @@
-        # ...
-
-sav
+valu
-            return ''.join([''.join(l) for l in (value.north,
-                    value.east, value.south, value.west)])
+
+``get_db_prep_save(self, value)``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Same as the above, but called when the Field value must be *saved* to the
+database. As the default implementation just calls ``get_db_prep_value``, you
+shouldn't need to implement this method unless your custom field need a special
+conversion when being saved that is not the same as the used for normal query
+parameters (which is implemented by ``get_db_prep_value``).
+
-
-``pre_save(self, model_instance, add)``
@@ -441 +451 @@
-
-If you needed to implement ``get_db_prep_save()``, you will usually need to
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    class HandField(models.Field):
@@ -456 +473 @@
-            # We only handle 'exact' and 'in'. All others are errors.
-            if lookup_type == 'exact':
-sav
+valu
-            elif lookup_type == 'in':
-sav
+valu
-            else:
-                raise TypeError('Lookup type %r not supported.' % lookup_type)
@@ -558 +575 @@
-        def flatten_data(self, follow, obj=None):
-            value = self._get_val_from_obj(obj)
-sav
+valu
-
-Some general advice

django/trunk/tests/modeltests/custom_methods/models.py

@@ -32 +32 @@
-            FROM custom_methods_article
-            WHERE pub_date = %s
-
+
+
-        # The asterisk in "(*row)" tells Python to expand the list into
-        # positional arguments to Article().

django/trunk/tests/modeltests/validation/models.py

@@ -17 +17 @@
-    favorite_moment = models.DateTimeField()
-    email = models.EmailField()
+    best_time = models.TimeField()
-
-    def __unicode__(self):
@@ -29 +30 @@
-...     'birthdate': datetime.date(2000, 5, 3),
-...     'favorite_moment': datetime.datetime(2002, 4, 3, 13, 23),
-
+
+
-... }
->>> p = Person(**valid_params)
@@ -131 +133 @@
-datetime.datetime(2002, 4, 3, 0, 0)
-
+>>> p = Person(**dict(valid_params, best_time='16:20:00'))
+>>> p.validate()
+{}
+>>> p.best_time
+datetime.time(16, 20)
+
+>>> p = Person(**dict(valid_params, best_time='16:20'))
+>>> p.validate()
+{}
+>>> p.best_time
+datetime.time(16, 20)
+
+>>> p = Person(**dict(valid_params, best_time='bar'))
+>>> p.validate()['best_time']
+[u'Enter a valid time in HH:MM[:ss[.uuuuuu]] format.']
+
->>> p = Person(**dict(valid_params, email='john@example.com'))
->>> p.validate()
@@ -154 +172 @@
->>> errors['birthdate']
-[u'This field is required.']
+>>> errors['best_time']
+[u'This field is required.']
-
-"""}

django/trunk/tests/regressiontests/model_fields/tests.py

@@ -21 +21 @@
->>> y = f.to_python('2.6')
-
-get_db_prep_save
+_format
-u'2.0'
-get_db_prep_save
+_format
-u'2.6'
-
-
-
-
-
+
->>> f.get_db_prep_lookup('exact', None)
-[None]
-
+# DateTimeField and TimeField to_python should support usecs:
+>>> f = DateTimeField()
+>>> f.to_python('2001-01-02 03:04:05.000006')
+datetime.datetime(2001, 1, 2, 3, 4, 5, 6)
+>>> f.to_python('2001-01-02 03:04:05.999999')
+datetime.datetime(2001, 1, 2, 3, 4, 5, 999999)
+
+>>> f = TimeField()
+>>> f.to_python('01:02:03.000004')
+datetime.time(1, 2, 3, 4)
+>>> f.to_python('01:02:03.999999')
+datetime.time(1, 2, 3, 999999)
+
+
-"""

django/trunk/tests/regressiontests/model_regress/models.py

@@ -29 +29 @@
-class Party(models.Model):
-    when = models.DateField()
+
+class Event(models.Model):
+    when = models.DateTimeField()
-
-__test__ = {'API_TESTS': """
@@ -69 +72 @@
-[datetime.date(1998, 12, 31)]
-
+# Check that get_next_by_FIELD and get_previous_by_FIELD don't crash when we
+# have usecs values stored on the database
+#
+# [It crashed after the Field.get_db_prep_* refactor, because on most backends
+#  DateTimeFields supports usecs, but DateTimeField.to_python didn't recognize
+#  them. (Note that Model._get_next_or_previous_by_FIELD coerces values to
+#  strings)]
+#
+>>> e = Event.objects.create(when = datetime.datetime(2000, 1, 1, 16, 0, 0))
+>>> e = Event.objects.create(when = datetime.datetime(2000, 1, 1, 6, 1, 1))
+>>> e = Event.objects.create(when = datetime.datetime(2000, 1, 1, 13, 1, 1))
+>>> e = Event.objects.create(when = datetime.datetime(2000, 1, 1, 12, 0, 20, 24))
+>>> e.get_next_by_when().when
+datetime.datetime(2000, 1, 1, 13, 1, 1)
+>>> e.get_previous_by_when().when
+datetime.datetime(2000, 1, 1, 6, 1, 1)
-"""
-}