Allow formatted IBANs longer than 26 chars to be saved (#522)

Author: benkonrath

docs/changelog.rst

@@ -78,7 +78,8 @@ Modifications to existing flavors:
   - `NPZoneSelect`: dandaki was corrected to gandaki (fixed typo).
 
   (`gh-506 <https://github.com/django/django-localflavor/pull/506/files>`_).
-
+- Allow formatted IBANs longer than 26 chars to be saved in `IBANField`
+  (`gh-522 <https://github.com/django/django-localflavor/pull/522>`_).
 
 Other changes:
 

localflavor/generic/forms.py

@@ -22,8 +22,6 @@
     '%d/%m/%y',              # '25/10/06'
 )
 
-IBAN_MIN_LENGTH = min(IBAN_COUNTRY_CODE_LENGTH.values())
-
 
 class DateField(forms.DateField):
     """A date input field which uses non-US date input formats by default."""
@@ -80,11 +78,15 @@ class MyForm(forms.Form):
     """
 
     def __init__(self, use_nordea_extensions=False, include_countries=None, **kwargs):
-        kwargs.setdefault('min_length', IBAN_MIN_LENGTH)
-        kwargs.setdefault('max_length', 34)
+        # The IBANValidator handles the length check, so we don't need to use the form min and max length validators.
+        kwargs.pop("max_length", None)
         self.default_validators = [IBANValidator(use_nordea_extensions, include_countries)]
         super().__init__(**kwargs)
 
+        # We still need to use max_length=42 in the <input ...> instead of max_length=34 (from the model) to
+        # account for the spaces in the formatted value.
+        self.widget.attrs["max_length"] = 42
+
     def to_python(self, value):
         value = super().to_python(value)
         if value in self.empty_values:

tests/test_generic/tests.py

@@ -180,12 +180,8 @@ def test_iban_fields(self):
             'NL91ABNB0417164300': ['Not a valid IBAN.'],
             'NL91 ABNB 0417 1643 00': ['Not a valid IBAN.'],
 
-            'MU17BOMM0101101030300200000MUR12345': [
-                'MU IBANs must contain 30 characters.',
-                'Ensure this value has at most 34 characters (it has 35).'],
-            'MU17 BOMM 0101 1010 3030 0200 000M UR12 345': [
-                'MU IBANs must contain 30 characters.',
-                'Ensure this value has at most 34 characters (it has 35).'],
+            'MU17BOMM0101101030300200000MUR12345': ['MU IBANs must contain 30 characters.'],
+            'MU17 BOMM 0101 1010 3030 0200 000M UR12 345': ['MU IBANs must contain 30 characters.'],
 
             # This IBAN should only be valid only if the Nordea extensions are turned on.
             'BJ11B00610100400271101192591': ['BJ is not a valid country code for IBAN.'],
@@ -203,6 +199,17 @@ def test_iban_fields(self):
         self.assertIsNone(iban_model_field.to_python(None))
 
         # Invalid inputs for model field.
+
+        # The model field has max_length set which means the max length validator is used, unlike the form.
+        invalid['MU17BOMM0101101030300200000MUR12345'] = [
+            'MU IBANs must contain 30 characters.',
+            'Ensure this value has at most 34 characters (it has 35).'
+        ]
+        invalid['MU17 BOMM 0101 1010 3030 0200 000M UR12 345'] = [
+            'MU IBANs must contain 30 characters.',
+            'Ensure this value has at most 34 characters (it has 35).',
+        ]
+
         for input, errors in invalid.items():
             with self.subTest(input=input, errors=errors):
                 with self.assertRaises(ValidationError) as context_manager:
@@ -307,6 +314,20 @@ def test_model_field_deconstruct(self):
             with self.subTest(attr=attr):
                 self.assertEqual(getattr(test_instance, attr), getattr(new_instance, attr))
 
+    def test_model_form_input_max_length(self):
+        form = UseNordeaExtensionsForm({
+            "iban": "RU03 0445 2522 5408 1781 0538 0913 1041 9",
+        })
+        self.assertEqual(None, form.fields["iban"].max_length)
+        self.assertEqual(42, form.fields["iban"].widget.attrs["max_length"])
+
+        form.save()  # Not validation error raised.
+
+    def test_form_field_input_max_length_without_model_form(self):
+        form_field = IBANFormField()
+        self.assertEqual(None, form_field.max_length)
+        self.assertEqual(42, form_field.widget.attrs["max_length"])
+
 
 class BICTests(TestCase):
     def test_bic_validator(self):