Qatar (qa)

The Qatar localflavor provides helpers for validating Qatari National ID numbers used in forms and model fields, plus a municipality choice field.

Data

localflavor.qa.qa_municipalities.resolve_municipality(value)

Return the ISO 3166-2:QA code for value, or None if unrecognised.

Accepts codes, English names, Arabic names, and registered aliases, all case- and whitespace-insensitive.

Forms

class localflavor.qa.forms.QAMunicipalityField(**kwargs)

A choice field for Qatar municipalities.

The field accepts both the 2-letter ISO 3166-2:QA abbreviation (e.g. 'DA'), common English names and Arabic names, and always returns the abbreviation.

Added in version 5.1.

clean(value)

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

class localflavor.qa.forms.QANationalIDNumberField(max_length=11, min_length=11, **kwargs)

A form field for validating Qatari National ID numbers.

Added in version 5.1.

Models

class localflavor.qa.models.QAMunicipalityField(*args, **kwargs)

A model field for Qatar municipalities.

Stores the municipality as a 2-character ISO 3166-2:QA code (e.g. 'DA' for Ad Dawhah / Doha).

Added in version 5.1.

deconstruct()

Return enough information to recreate the field as a 4-tuple:

• The name of the field on the model, if contribute_to_class() has been run.

• The import path of the field, including the class, e.g. django.db.models.IntegerField. This should be the most portable version, so less specific may be better.

• A list of positional arguments.

• A dict of keyword arguments.

Note that the positional or keyword arguments must contain values of the following types (including inner values of collection types):

• None, bool, str, int, float, complex, set, frozenset, list, tuple, dict

• UUID

• datetime.datetime (naive), datetime.date

• top-level classes, top-level functions - will be referenced by their full import path

• Storage instances - these have their own deconstruct() method

This is because the values here must be serialized into a text format (possibly new Python code, possibly JSON) and these are the only types with encoding handlers defined.

There’s no need to return the exact way the field was instantiated this time, just ensure that the resulting field is the same - prefer keyword arguments over positional ones, and omit parameters with their default values.

formfield(**kwargs)

Return a django.forms.Field instance for this field.

class localflavor.qa.models.QANationalIDField(*args, **kwargs)

A model field for Qatari National ID numbers.

Added in version 5.1.

formfield(**kwargs)

Return a django.forms.Field instance for this field.

Validators

class localflavor.qa.validators.QANationalIDValidator(*args, **kwargs)

Validate Qatari National ID numbers.

Format: CYYNNNSSSSS

Where: - C is the century digit (2 or 3) - YY is the last two digits of the year of birth - NNN is an ISO 3166-1 numeric nationality code - SSSSS is a unique serial number

Checks the following rules to determine the validity of the number:

1. The number consists of 11 digits.

2. The century digit is valid (2 or 3).

3. The year of birth is not in the future.

4. The nationality code is a valid ISO 3166-1 numeric country code.

Added in version 5.1.

deconstruct()

Return a 3-tuple of class import path, positional arguments, and keyword arguments.