Source code for localflavor.ca.forms
"""Canada-specific Form helpers."""
import re
from django.core.exceptions import ImproperlyConfigured
from django.forms import ValidationError
from django.forms.fields import CharField, Select
from django.utils.translation import gettext_lazy as _
from stdnum import luhn
sin_re = re.compile(r"^(\d{3})-(\d{3})-(\d{3})$")
[docs]class CAPostalCodeField(CharField):
"""
Canadian postal code form field.
Validates against known invalid characters: D, F, I, O, Q, U
Additionally the first character cannot be Z or W.
For more info see:
http://www.canadapost.ca/tools/pg/manual/PGaddress-e.asp#1402170
"""
default_error_messages = {
'invalid': _('Enter a postal code in the format XXX XXX.'),
}
postcode_regex = re.compile(
r'^([ABCEGHJKLMNPRSTVXY]\d[ABCEGHJKLMNPRSTVWXYZ]) *(\d[ABCEGHJKLMNPRSTVWXYZ]\d)$')
[docs] def clean(self, value):
value = super().clean(value)
if value in self.empty_values:
return value
postcode = value.upper().strip()
m = self.postcode_regex.match(postcode)
if not m:
raise ValidationError(self.error_messages['invalid'], code='invalid')
return "%s %s" % (m.group(1), m.group(2))
[docs]class CAProvinceField(CharField):
"""
A form field that validates its input is a Canadian province name or abbreviation.
It normalizes the input to the standard two-leter postal service
abbreviation for the given province.
"""
default_error_messages = {
'invalid': _('Enter a Canadian province or territory.'),
}
[docs] def clean(self, value):
value = super().clean(value)
if value in self.empty_values:
return value
try:
# Load data in memory only when it is required, see also #17275
from .ca_provinces import PROVINCES_NORMALIZED
return PROVINCES_NORMALIZED[value.lower()]
except KeyError:
pass
raise ValidationError(self.error_messages['invalid'], code='invalid')
[docs]class CAProvinceSelect(Select):
"""A Select widget that uses a list of Canadian provinces and territories as its choices."""
def __init__(self, attrs=None):
# Load data in memory only when it is required, see also #17275
from .ca_provinces import PROVINCE_CHOICES
super().__init__(attrs, choices=PROVINCE_CHOICES)
[docs]class CASocialInsuranceNumberField(CharField):
"""
A Canadian Social Insurance Number (SIN).
Checks the following rules to determine whether the number is valid:
* Conforms to the XXX-XXX-XXX format.
* Passes the check digit process "Luhn Algorithm"
See: http://en.wikipedia.org/wiki/Social_Insurance_Number
"""
default_error_messages = {
'invalid': _(
'Enter a valid Canadian Social Insurance number in XXX-XXX-XXX format.'),
}
[docs] def clean(self, value):
value = super().clean(value)
if value in self.empty_values:
return value
match = re.match(sin_re, value)
if not match:
raise ValidationError(self.error_messages['invalid'], code='invalid')
number = '%s-%s-%s' % (match.group(1), match.group(2), match.group(3))
check_number = '%s%s%s' % (
match.group(1),
match.group(2),
match.group(3))
if not luhn.is_valid(check_number):
raise ValidationError(self.error_messages['invalid'], code='invalid')
return number