Canada (ca)

Forms

Canada-specific Form helpers

class localflavor.ca.forms.CAPhoneNumberField(required=True, widget=None, label=None, initial=None, help_text=None, error_messages=None, show_hidden_initial=False, validators=[], localize=False)

Canadian phone number form field.

class localflavor.ca.forms.CAPostalCodeField(max_length=None, min_length=None, *args, **kwargs)

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

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

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.

class localflavor.ca.forms.CAProvinceSelect(attrs=None)

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=None, error_messages=None, show_hidden_initial=False, validators=[], localize=False)

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

luhn_checksum_is_valid(number)

Checks to make sure that the SIN passes a luhn mod-10 checksum See: http://en.wikipedia.org/wiki/Luhn_algorithm

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

a mapping of province misspellings/abbreviations to normalized abbreviations