Ticket #5526: localflavor_datetimefields.patch

django/contrib/localflavor/nl/__init__.py

@@ +1 @@
+LOCALES = (
+    'nl_NL',
+    'nl_NL.UTF-8', 'nl_NL.ISO8859-1',  # Some OSes need these (e.g., FreeBSD)
+)

django/contrib/localflavor/nl/forms.py

@@ -8 +8 @@
 from django.newforms.fields import Field, Select, EMPTY_VALUES
 from django.utils.translation import ugettext as _
 from django.utils.encoding import smart_unicode
+from django.contrib.localflavor.generic import forms
+from django.contrib.localflavor.nl.widgets import DateTimeInput
+from django.contrib.localflavor.nl import LOCALES
 
+DATE_INPUT_FORMATS = (
+    '%d-%m-%Y', '%d/%m/%Y', # '25-10-2006', '25/10/2006'
+    '%d/%m/%y',             # '25/10/06'
+    '%d %b %Y', '%d %B %Y', # '25 okt 2006', '25 oktober 2006'
+)
+
+DATETIME_INPUT_FORMATS = (
+    '%d-%m-%Y %H:%M:%S',    # '25-10-2006 14:30:59'
+    '%d-%m-%Y %H:%M',       # '25-10-2006 14:30'
+    '%d-%m-%Y',             # '25-10-2006'
+    '%d/%m/%Y %H:%M:%S',    # '25/10/2006 14:30:59'
+    '%d/%m/%Y %H:%M',       # '25/10/2006 14:30'
+    '%d/%m/%Y',             # '25/10/2006'
+    '%d-%m-%y %H:%M:%S',    # '25-10-06 14:30:59'
+    '%d-%m-%y %H:%M',       # '25-10-06 14:30'
+    '%d-%m-%y',             # '25-10-06'
+    '%d/%m/%y %H:%M:%S',    # '25/10/06 14:30:59'
+    '%d/%m/%y %H:%M',       # '25/10/06 14:30'
+    '%d/%m/%y',             # '25/10/06'
+)
+
+DATE_OUTPUT_FORMAT = '%d-%m-%Y'
+DATETIME_OUTPUT_FORMAT = '%d-%m-%Y %H:%M:%S'
+
 pc_re = re.compile('^\d{4}[A-Z]{2}$')
 sofi_re = re.compile('^\d{9}$')
 numeric_re = re.compile('^\d+$')
@@ -90 +117 @@
             raise ValidationError(msg)
         
         return value
+
+class DateField(forms.DateField):
+    """
+    A DateField using a Dutch locale.
+    """
+    widget = DateTimeInput(DATE_OUTPUT_FORMAT)
+    locales = LOCALES
+    def __init__(self, input_formats=DATE_INPUT_FORMATS, *args, **kwargs):
+        super(DateField, self).__init__(input_formats=input_formats, *args, **kwargs)
+
+class DateTimeField(forms.DateTimeField):
+    """
+    A DateTimeField using a Dutch locale.
+    """
+    widget = DateTimeInput(DATETIME_OUTPUT_FORMAT)
+    locales = LOCALES
+    def __init__(self, input_formats=DATETIME_INPUT_FORMATS, *args, **kwargs):
+        super(DateTimeField, self).__init__(input_formats=input_formats, *args, **kwargs)

django/contrib/localflavor/nl/widgets.py

@@ +1 @@
+from django.contrib.localflavor.generic import widgets
+from django.contrib.localflavor.nl import LOCALES
+
+class DateTimeInput(widgets.DateTimeInput):
+    locales = LOCALES

django/contrib/localflavor/generic/forms.py

@@ +1 @@
+import locale
+
 from django import newforms as forms
 
 DEFAULT_DATE_INPUT_FORMATS = (
@@ -20 +22 @@
     '%d/%m/%y',              # '25/10/06'
 )
 
-class DateField(forms.DateField):
+def try_locales(locales):
     """
+    Try to set the locale to one of the specified locales.  Stop as soon as
+    one of the locales is available.
+    """
+    for _locale in locales:
+        try:
+            locale.setlocale(locale.LC_TIME, _locale)
+            break
+        except locale.Error:
+            pass
+
+class LocalizedDateTimeField(object):
+    locales = ()
+
+    def clean(self, value):
+        """
+        Temporarily replace the current locale with the locale necessary to
+        properly validate given value. 
+        """
+        cur_locale = locale.setlocale(locale.LC_TIME)
+        try:
+            try_locales(self.locales)
+            return super(LocalizedDateTimeField, self).clean(value)
+        finally:
+            locale.setlocale(locale.LC_TIME, cur_locale)
+
+class DateField(LocalizedDateTimeField, forms.DateField):
+    """
     A date input field which uses non-US date input formats by default.
     """
     def __init__(self, input_formats=None, *args, **kwargs):
         input_formats = input_formats or DEFAULT_DATE_INPUT_FORMATS
         super(DateField, self).__init__(input_formats=input_formats, *args, **kwargs)
 
-class DateTimeField(forms.DateTimeField):
+class DateTimeField(LocalizedDateTimeField, forms.DateTimeField):
     """
     A date and time input field which uses non-US date and time input formats
     by default.

django/contrib/localflavor/generic/widgets.py

@@ +1 @@
+import locale
+
+from django.newforms.widgets import TextInput
+from django.contrib.localflavor.generic.forms import try_locales
+
+class DateTimeInput(TextInput):
+    locales = []
+    def __init__(self, date_output_format, locales=None, *args, **kwargs):
+        super(DateTimeInput, self).__init__(*args, **kwargs)
+        self.date_output_format = date_output_format
+        self.locales = locales or self.locales
+    
+    def render(self, name, value, attrs=None):
+        if hasattr(value, 'strftime'):
+            try:
+                cur_locale = locale.setlocale(locale.LC_TIME)
+                try_locales(self.locales)
+                str_value = value.strftime(self.date_output_format)
+                return super(DateTimeInput, self).render(name, str_value, attrs)
+            finally:
+                locale.setlocale(locale.LC_TIME, cur_locale)
+        else:
+            return super(DateTimeInput, self).render(name, value, attrs)

tests/regressiontests/forms/localflavor.py

@@ -1529 +1529 @@
 >>> s.render('provinces', 'OV')
 u'<select name="provinces">\n<option value="DR">Drente</option>\n<option value="FL">Flevoland</option>\n<option value="FR">Friesland</option>\n<option value="GL">Gelderland</option>\n<option value="GR">Groningen</option>\n<option value="LB">Limburg</option>\n<option value="NB">Noord-Brabant</option>\n<option value="NH">Noord-Holland</option>\n<option value="OV" selected="selected">Overijssel</option>\n<option value="UT">Utrecht</option>\n<option value="ZE">Zeeland</option>\n<option value="ZH">Zuid-Holland</option>\n</select>'
 
+# Dutch DateField ###########################################################
+
+>>> import datetime
+>>> from django.contrib.localflavor.nl.forms import DateField
+>>> f = DateField()
+>>> f.clean(datetime.date(2006, 10, 25))
+datetime.date(2006, 10, 25)
+>>> f.clean('25-10-2006')
+datetime.date(2006, 10, 25)
+>>> f.clean('25/10/2006')
+datetime.date(2006, 10, 25)
+>>> f.clean('25/10/06')
+datetime.date(2006, 10, 25)
+>>> f.clean('25 okt 2006')
+datetime.date(2006, 10, 25)
+>>> f.clean('25 oktober 2006')
+datetime.date(2006, 10, 25)
+>>> f.clean('2006-10-25')
+Traceback (most recent call last):
+    ...
+ValidationError: [u'Enter a valid date.']
+>>> f.clean('October 25 2006')
+Traceback (most recent call last):
+    ...
+ValidationError: [u'Enter a valid date.']
+
+DateField accepts an optional input_formats parameter:
+>>> f = DateField(input_formats=['%Y %B %d'])
+>>> f.clean(datetime.date(2006, 10, 25))
+datetime.date(2006, 10, 25)
+>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30))
+datetime.date(2006, 10, 25)
+>>> f.clean('2006 oktober 1')
+datetime.date(2006, 10, 1)
+
+The input_formats parameter overrides all default input formats,
+so the default formats won't work unless you specify them:
+>>> f.clean('25-10-2006')
+Traceback (most recent call last):
+...
+ValidationError: [u'Enter a valid date.']
+>>> f.clean('25/10/2006')
+Traceback (most recent call last):
+...
+ValidationError: [u'Enter a valid date.']
+>>> f.clean('25/10/06')
+Traceback (most recent call last):
+...
+ValidationError: [u'Enter a valid date.']
+
+# Dutch DateTimeField #######################################################
+
+>>> import datetime
+>>> from django.contrib.localflavor.nl.forms import DateTimeField
+>>> f = DateTimeField()
+>>> f.clean(datetime.date(2006, 10, 25))
+datetime.datetime(2006, 10, 25, 0, 0)
+>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30))
+datetime.datetime(2006, 10, 25, 14, 30)
+>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30, 59))
+datetime.datetime(2006, 10, 25, 14, 30, 59)
+>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30, 59, 200))
+datetime.datetime(2006, 10, 25, 14, 30, 59, 200)
+>>> f.clean('25-10-2006 14:30:45')
+datetime.datetime(2006, 10, 25, 14, 30, 45)
+>>> f.clean('25-10-2006 14:30:00')
+datetime.datetime(2006, 10, 25, 14, 30)
+>>> f.clean('25-10-2006 14:30')
+datetime.datetime(2006, 10, 25, 14, 30)
+>>> f.clean('25-10-2006')
+datetime.datetime(2006, 10, 25, 0, 0)
+>>> f.clean('25/10/2006 14:30:45')
+datetime.datetime(2006, 10, 25, 14, 30, 45)
+>>> f.clean('25/10/2006 14:30:00')
+datetime.datetime(2006, 10, 25, 14, 30)
+>>> f.clean('25/10/2006 14:30')
+datetime.datetime(2006, 10, 25, 14, 30)
+>>> f.clean('25/10/2006')
+datetime.datetime(2006, 10, 25, 0, 0)
+>>> f.clean('25/10/06 14:30:45')
+datetime.datetime(2006, 10, 25, 14, 30, 45)
+>>> f.clean('25/10/06 14:30:00')
+datetime.datetime(2006, 10, 25, 14, 30)
+>>> f.clean('25/10/06 14:30')
+datetime.datetime(2006, 10, 25, 14, 30)
+>>> f.clean('25/10/06')
+datetime.datetime(2006, 10, 25, 0, 0)
+>>> f.clean('hello')
+Traceback (most recent call last):
+...
+ValidationError: [u'Enter a valid date/time.']
+>>> f = DateTimeField(input_formats=['%Y %m %d %H:%M'])
+>>> f.clean(datetime.date(2006, 10, 25))
+datetime.datetime(2006, 10, 25, 0, 0)
+>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30))
+datetime.datetime(2006, 10, 25, 14, 30)
+>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30, 59))
+datetime.datetime(2006, 10, 25, 14, 30, 59)
+>>> f.clean(datetime.datetime(2006, 10, 25, 14, 30, 59, 200))
+datetime.datetime(2006, 10, 25, 14, 30, 59, 200)
+>>> f.clean('2006 10 25 14:30')
+datetime.datetime(2006, 10, 25, 14, 30)
+
+The input_formats parameter overrides all default input formats,
+so the default formats won't work unless you specify them:
+>>> f.clean('25-10-2006 14:30:45')
+Traceback (most recent call last):
+...
+ValidationError: [u'Enter a valid date/time.']
+
+>>> f = DateTimeField(required=False)
+>>> f.clean(None)
+>>> repr(f.clean(None))
+'None'
+>>> f.clean('')
+>>> repr(f.clean(''))
+'None'
+
+# A form using DateTimeInput with a Dutch locale ############################
+
+>>> import django.newforms as forms
+>>> from django.contrib.localflavor.nl.widgets import DateTimeInput
+>>> class NLDateTimeForm(forms.Form):
+...     date = DateField()
+...     date_custom_format = DateField(widget=DateTimeInput('%d %B %Y'))
+...     datetime = DateTimeField()
+...     foo = DateField()
+>>> f = NLDateTimeForm(initial={
+...     'date': datetime.date(2006, 10, 25), 
+...     'date_custom_format': datetime.date(2006, 10, 25), 
+...     'datetime': datetime.datetime(2006, 10, 25, 10, 11, 12),
+...     'foo': 'bar',
+... })
+>>> print f['date']
+<input type="text" name="date" value="25-10-2006" id="id_date" />
+>>> print f['date_custom_format']
+<input type="text" name="date_custom_format" value="25 oktober 2006" id="id_date_custom_format" />
+>>> print f['datetime']
+<input type="text" name="datetime" value="25-10-2006 10:11:12" id="id_datetime" />
+>>> print f['foo']
+<input type="text" name="foo" value="bar" id="id_foo" />
+
 # ARProvinceField #############################################################
 
 >>> from django.contrib.localflavor.ar.forms import ARProvinceSelect
@@ -2194 +2336 @@
 >>> repr(f.clean(''))
 'None'
 
+# LocalizedDateTimeField #####################################################
+>>> # Make sure the locale is reset after use.
+>>> import locale
+>>> from django.contrib.localflavor.nl.forms import DateField
+>>> locale_before = locale.setlocale(locale.LC_TIME)
+>>> f = DateField()
+>>> try:
+...     f.clean('foo')
+... except:
+...     pass
+>>> locale_after = locale.setlocale(locale.LC_TIME)
+>>> locale_before == locale_after
+True
+
 """