Canada (ca)

Forms

Canada-specific Form helpers.

class localflavor.ca.forms.CAPostalCodeField(*, max_length=None, min_length=None, strip=True, empty_value='', **kwargs)[source]

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

clean(value)[source]

Validate the given value and return its “cleaned” value as an appropriate Python object. Raise ValidationError for any errors.

class localflavor.ca.forms.CAProvinceField(*, required=True, widget=None, label=None, initial=None, help_text='', error_messages=None, show_hidden_initial=False, validators=(), localize=False, disabled=False, label_suffix=None)[source]

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.

clean(value)[source]

Validate the given value and return its “cleaned” value as an appropriate Python object. Raise ValidationError for any errors.

class localflavor.ca.forms.CAProvinceSelect(attrs=None)[source]

A Select widget that uses a list of Canadian provinces and territories as its choices.

class localflavor.ca.forms.CASocialInsuranceNumberField(*, required=True, widget=None, label=None, initial=None, help_text='', error_messages=None, show_hidden_initial=False, validators=(), localize=False, disabled=False, label_suffix=None)[source]

A Canadian Social Insurance Number (SIN).

Checks the following rules to determine whether the number is valid:

clean(value)[source]

Validate the given value and return its “cleaned” value as an appropriate Python object. Raise ValidationError for any errors.

Data

localflavor.ca.ca_provinces.PROVINCE_CHOICES = (('AB', 'Alberta'), ('BC', 'British Columbia'), ('MB', 'Manitoba'), ('NB', 'New Brunswick'), ('NL', 'Newfoundland and Labrador'), ('NT', 'Northwest Territories'), ('NS', 'Nova Scotia'), ('NU', 'Nunavut'), ('ON', 'Ontario'), ('PE', 'Prince Edward Island'), ('QC', 'Quebec'), ('SK', 'Saskatchewan'), ('YT', 'Yukon'))

An alphabetical list of provinces and territories for use as choices in a formfield. Source: http://www.canada.gc.ca/othergov/prov_e.html

localflavor.ca.ca_provinces.PROVINCES_NORMALIZED = {'ab': 'AB', 'alberta': 'AB', 'b.c.': 'BC', 'bc': 'BC', 'british columbia': 'BC', 'manitoba': 'MB', 'mb': 'MB', 'nb': 'NB', 'new brunswick': 'NB', 'newfoundland': 'NL', 'newfoundland and labrador': 'NL', 'nf': 'NL', 'nl': 'NL', 'northwest territories': 'NT', 'nova scotia': 'NS', 'ns': 'NS', 'nt': 'NT', 'nu': 'NU', 'nunavut': 'NU', 'on': 'ON', 'ontario': 'ON', 'p.e.i.': 'PE', 'pe': 'PE', 'pei': 'PE', 'pq': 'QC', 'prince edward island': 'PE', 'qc': 'QC', 'quebec': 'QC', 'saskatchewan': 'SK', 'sk': 'SK', 'yk': 'YT', 'yt': 'YT', 'yukon': 'YT', 'yukon territory': 'YT'}

a mapping of province misspellings/abbreviations to normalized abbreviations