Added support for empty_value kwarg in Django >= 1.11.

Author: benkonrath

localflavor/ar/forms.py

@@ -3,11 +3,12 @@
 
 from __future__ import unicode_literals
 
-from django.core.validators import EMPTY_VALUES
 from django.forms import ValidationError
 from django.forms.fields import CharField, RegexField, Select
 from django.utils.translation import ugettext_lazy as _
 
+from localflavor.compat import EmptyValueCompatMixin
+
 from .ar_provinces import PROVINCE_CHOICES
 
 
@@ -18,7 +19,7 @@ def __init__(self, attrs=None):
         super(ARProvinceSelect, self).__init__(attrs, choices=PROVINCE_CHOICES)
 
 
-class ARPostalCodeField(RegexField):
+class ARPostalCodeField(EmptyValueCompatMixin, RegexField):
     """
     A field that accepts a 'classic' NNNN Postal Code or a CPA.
 
@@ -38,16 +39,16 @@ def __init__(self, max_length=8, min_length=4, *args, **kwargs):
 
     def clean(self, value):
         value = super(ARPostalCodeField, self).clean(value)
-        if value in EMPTY_VALUES:
-            return ''
+        if value in self.empty_values:
+            return self.empty_value
         if len(value) not in (4, 8):
             raise ValidationError(self.error_messages['invalid'])
         if len(value) == 8:
             return '%s%s%s' % (value[0].upper(), value[1:5], value[5:].upper())
         return value
 
 
-class ARDNIField(CharField):
+class ARDNIField(EmptyValueCompatMixin, CharField):
     """A field that validates 'Documento Nacional de Identidad' (DNI) numbers."""
 
     default_error_messages = {
@@ -62,8 +63,8 @@ def __init__(self, max_length=10, min_length=7, *args, **kwargs):
     def clean(self, value):
         """Value can be a string either in the [X]X.XXX.XXX or [X]XXXXXXX formats."""
         value = super(ARDNIField, self).clean(value)
-        if value in EMPTY_VALUES:
-            return ''
+        if value in self.empty_values:
+            return self.empty_value
         if not value.isdigit():
             value = value.replace('.', '')
         if not value.isdigit():
@@ -74,7 +75,7 @@ def clean(self, value):
         return value
 
 
-class ARCUITField(RegexField):
+class ARCUITField(EmptyValueCompatMixin, RegexField):
     """
     This field validates a CUIT (Código Único de Identificación Tributaria).
 
@@ -100,8 +101,8 @@ def __init__(self, max_length=None, min_length=None, *args, **kwargs):
     def clean(self, value):
         """Value can be either a string in the format XX-XXXXXXXX-X or an 11-digit number."""
         value = super(ARCUITField, self).clean(value)
-        if value in EMPTY_VALUES:
-            return ''
+        if value in self.empty_values:
+            return self.empty_value
         value, cd = self._canon(value)
         if not value[:2] in ['27', '20', '30', '23', '24', '33']:
             raise ValidationError(self.error_messages['legal_type'])
@@ -132,7 +133,7 @@ def _format(self, cuit, check_digit=None):
         return '%s-%s-%s' % (cuit[:2], cuit[2:], check_digit)
 
 
-class ARCBUField(CharField):
+class ARCBUField(EmptyValueCompatMixin, CharField):
     """
     This field validates a CBU (Clave Bancaria Uniforme).
 
@@ -184,8 +185,8 @@ def _checksum(self, value):
     def clean(self, value):
         """Value must be a 22 digits long number."""
         value = super(ARCBUField, self).clean(value)
-        if value in EMPTY_VALUES:
-            return ''
+        if value in self.empty_values:
+            return self.empty_value
         if not value.isdigit():
             raise ValidationError(self.error_messages['invalid'])
         if not self._checksum(value):

localflavor/au/forms.py

@@ -4,12 +4,12 @@
 
 import re
 
-from django.core.validators import EMPTY_VALUES
 from django.forms import ValidationError
 from django.forms.fields import CharField, RegexField, Select
 from django.utils.encoding import force_text
 from django.utils.translation import ugettext_lazy as _
 
+from localflavor.compat import EmptyValueCompatMixin
 from localflavor.generic.forms import DeprecatedPhoneNumberFormFieldMixin
 
 from .au_states import STATE_CHOICES
@@ -35,7 +35,7 @@ def __init__(self, max_length=4, min_length=None, *args, **kwargs):
                                               max_length, min_length, *args, **kwargs)
 
 
-class AUPhoneNumberField(CharField, DeprecatedPhoneNumberFormFieldMixin):
+class AUPhoneNumberField(EmptyValueCompatMixin, CharField, DeprecatedPhoneNumberFormFieldMixin):
     """
     A form field that validates input as an Australian phone number.
 
@@ -49,8 +49,8 @@ class AUPhoneNumberField(CharField, DeprecatedPhoneNumberFormFieldMixin):
     def clean(self, value):
         """Validate a phone number. Strips parentheses, whitespace and hyphens."""
         super(AUPhoneNumberField, self).clean(value)
-        if value in EMPTY_VALUES:
-            return ''
+        if value in self.empty_values:
+            return self.empty_value
         value = re.sub('(\(|\)|\s+|-)', '', force_text(value))
         phone_match = PHONE_DIGITS_RE.search(value)
         if phone_match:
@@ -65,7 +65,7 @@ def __init__(self, attrs=None):
         super(AUStateSelect, self).__init__(attrs, choices=STATE_CHOICES)
 
 
-class AUBusinessNumberField(CharField):
+class AUBusinessNumberField(EmptyValueCompatMixin, CharField):
     """
     A form field that validates input as an Australian Business Number (ABN).
 
@@ -77,6 +77,8 @@ class AUBusinessNumberField(CharField):
 
     def to_python(self, value):
         value = super(AUBusinessNumberField, self).to_python(value)
+        if value in self.empty_values:
+            return self.empty_value
         return value.upper().replace(' ', '')
 
     def prepare_value(self, value):
@@ -88,7 +90,7 @@ def prepare_value(self, value):
         return '{} {} {} {}'.format(spaceless[:2], spaceless[2:5], spaceless[5:8], spaceless[8:])
 
 
-class AUCompanyNumberField(CharField):
+class AUCompanyNumberField(EmptyValueCompatMixin, CharField):
     """
     A form field that validates input as an Australian Company Number (ACN).
 
@@ -99,6 +101,8 @@ class AUCompanyNumberField(CharField):
 
     def to_python(self, value):
         value = super(AUCompanyNumberField, self).to_python(value)
+        if value in self.empty_values:
+            return self.empty_value
         return value.upper().replace(' ', '')
 
     def prepare_value(self, value):

localflavor/br/forms.py

@@ -11,6 +11,7 @@
 from django.utils.encoding import force_text
 from django.utils.translation import ugettext_lazy as _
 
+from localflavor.compat import EmptyValueCompatMixin
 from localflavor.generic.forms import DeprecatedPhoneNumberFormFieldMixin
 
 from .br_states import STATE_CHOICES
@@ -103,7 +104,7 @@ def DV_maker(v):  # noqa
     return dv_maker(v)
 
 
-class BRCPFField(CharField):
+class BRCPFField(EmptyValueCompatMixin, CharField):
     """
     A form field that validates a CPF number or a CPF string.
 
@@ -124,8 +125,8 @@ def __init__(self, max_length=14, min_length=11, *args, **kwargs):
     def clean(self, value):
         """Value can be either a string in the format XXX.XXX.XXX-XX or an 11-digit number."""
         value = super(BRCPFField, self).clean(value)
-        if value in EMPTY_VALUES:
-            return ''
+        if value in self.empty_values:
+            return self.empty_value
         orig_value = value[:]
         if not value.isdigit():
             cpf = cpf_digits_re.search(value)
@@ -153,7 +154,7 @@ def clean(self, value):
         return orig_value
 
 
-class BRCNPJField(CharField):
+class BRCNPJField(EmptyValueCompatMixin, CharField):
     """
     A form field that validates input as `Brazilian CNPJ`_.
 
@@ -183,8 +184,8 @@ def __init__(self, min_length=14, max_length=18, *args, **kwargs):
     def clean(self, value):
         """Value can be either a string in the format XX.XXX.XXX/XXXX-XX or a group of 14 characters."""
         value = super(BRCNPJField, self).clean(value)
-        if value in EMPTY_VALUES:
-            return ''
+        if value in self.empty_values:
+            return self.empty_value
         orig_value = value[:]
         if not value.isdigit():
             cnpj = cnpj_digits_re.search(value)
@@ -213,7 +214,7 @@ def mod_97_base10(value):
     return 98 - ((value * 100 % 97) % 97)
 
 
-class BRProcessoField(CharField):
+class BRProcessoField(EmptyValueCompatMixin, CharField):
     """
     A form field that validates a Legal Process(Processo) number or a Legal Process string.
 
@@ -232,8 +233,8 @@ def __init__(self, max_length=25, min_length=20, *args, **kwargs):
     def clean(self, value):
         """Value can be either a string in the format NNNNNNN-DD.AAAA.J.TR.OOOO or an 20-digit number."""
         value = super(BRProcessoField, self).clean(value)
-        if value in EMPTY_VALUES:
-            return ''
+        if value in self.empty_values:
+            return self.empty_value
 
         orig_value = value[:]
         if not value.isdigit():

localflavor/ca/forms.py

@@ -10,14 +10,15 @@
 from django.utils.encoding import force_text
 from django.utils.translation import ugettext_lazy as _
 
+from localflavor.compat import EmptyValueCompatMixin
 from localflavor.generic.checksums import luhn
 from localflavor.generic.forms import DeprecatedPhoneNumberFormFieldMixin
 
 phone_digits_re = re.compile(r'^(?:1-?)?(\d{3})[-\.]?(\d{3})[-\.]?(\d{4})$')
 sin_re = re.compile(r"^(\d{3})-(\d{3})-(\d{3})$")
 
 
-class CAPostalCodeField(CharField):
+class CAPostalCodeField(EmptyValueCompatMixin, CharField):
     """
     Canadian postal code form field.
 
@@ -36,8 +37,8 @@ class CAPostalCodeField(CharField):
 
     def clean(self, value):
         value = super(CAPostalCodeField, self).clean(value)
-        if value in EMPTY_VALUES:
-            return ''
+        if value in self.empty_values:
+            return self.empty_value
         postcode = value.upper().strip()
         m = self.postcode_regex.match(postcode)
         if not m:

localflavor/cl/forms.py

@@ -2,12 +2,13 @@
 
 from __future__ import unicode_literals
 
-from django.core.validators import EMPTY_VALUES
 from django.forms import ValidationError
 from django.forms.fields import RegexField, Select
 from django.utils.encoding import force_text
 from django.utils.translation import ugettext_lazy as _
 
+from localflavor.compat import EmptyValueCompatMixin
+
 from .cl_regions import REGION_CHOICES
 
 
@@ -18,7 +19,7 @@ def __init__(self, attrs=None):
         super(CLRegionSelect, self).__init__(attrs, choices=REGION_CHOICES)
 
 
-class CLRutField(RegexField):
+class CLRutField(EmptyValueCompatMixin, RegexField):
     """
     Chilean "Rol Unico Tributario" (RUT) field.
 
@@ -48,8 +49,8 @@ def __init__(self, *args, **kwargs):
     def clean(self, value):
         """Check and clean the Chilean RUT."""
         super(CLRutField, self).clean(value)
-        if value in EMPTY_VALUES:
-            return ''
+        if value in self.empty_values:
+            return self.empty_value
         rut, verificador = self._canonify(value)
         if self._algorithm(rut) == verificador:
             return self._format(rut, verificador)

localflavor/cn/forms.py

@@ -8,6 +8,7 @@
 from django.forms.fields import CharField, RegexField, Select
 from django.utils.translation import ugettext_lazy as _
 
+from localflavor.compat import EmptyValueCompatMixin
 from localflavor.generic.forms import DeprecatedPhoneNumberFormFieldMixin
 
 from .cn_provinces import CN_PROVINCE_CHOICES
@@ -87,7 +88,7 @@ def __init__(self, *args, **kwargs):
         super(CNPostCodeField, self).__init__(POST_CODE_RE, *args, **kwargs)
 
 
-class CNIDCardField(CharField):
+class CNIDCardField(EmptyValueCompatMixin, CharField):
     """
     A form field that validates input as a Resident Identity Card (PRC) number.
 
@@ -116,8 +117,8 @@ def clean(self, value):
         """Check whether the input is a valid ID Card Number."""
         # Check the length of the ID card number.
         super(CNIDCardField, self).clean(value)
-        if not value:
-            return ""
+        if value in self.empty_values:
+            return self.empty_value
         # Check whether this ID card number has valid format
         if not re.match(ID_CARD_RE, value):
             raise ValidationError(self.error_messages['invalid'])

localflavor/compat.py

@@ -0,0 +1,18 @@
+
+class EmptyValueCompatMixin(object):
+    """
+    forms.CharField in Django >= 1.11 has an 'empty_value' keyword argument for representing a value for "empty".
+
+    https://docs.djangoproject.com/en/1.11/ref/forms/fields/#django.forms.CharField.empty_value
+
+    This mixin adds self.empty_value set to an empty string for Django <= 1.10. This allows localflavor form fields to
+    use self.empty_value consistently across Django versions.
+
+    This mixin does not add an 'empty_value' keyword argument to versions of Django that don't already support it.
+
+    This mixin can be removed when localflavor removes support for Django <= 1.10.
+    """
+    def __init__(self, *args, **kwargs):
+        super(EmptyValueCompatMixin, self).__init__(*args, **kwargs)
+        if not hasattr(self, 'empty_value'):
+            self.empty_value = ''

localflavor/cz/forms.py

@@ -9,6 +9,8 @@
 from django.forms.fields import Field, RegexField, Select
 from django.utils.translation import ugettext_lazy as _
 
+from localflavor.compat import EmptyValueCompatMixin
+
 from .cz_regions import REGION_CHOICES
 
 birth_number = re.compile(r'^(?P<birth>\d{6})/?(?P<id>\d{3,4})$')
@@ -22,7 +24,7 @@ def __init__(self, attrs=None):
         super(CZRegionSelect, self).__init__(attrs, choices=REGION_CHOICES)
 
 
-class CZPostalCodeField(RegexField):
+class CZPostalCodeField(EmptyValueCompatMixin, RegexField):
     """
     A form field that validates its input as Czech postal code.
 
@@ -43,8 +45,10 @@ def clean(self, value):
 
         Returns an empty string for empty values.
         """
-        v = super(CZPostalCodeField, self).clean(value)
-        return v.replace(' ', '')
+        value = super(CZPostalCodeField, self).clean(value)
+        if value in self.empty_values:
+            return self.empty_value
+        return value.replace(' ', '')
 
 
 class CZBirthNumberField(Field):