ctnx.validation module¶

class ctnx.validation.CccdResult(id: str, is_male: bool, birth_year: int, birth_country: str, birth_province: str = '')[source]¶

Bases: tuple

Contains information of a parsed Vietnamese Citizen Identity Card (Căn cước công dân) number.

birth_country: str¶: Alias for field number 3

birth_province: str¶: Alias for field number 4

birth_year: int¶: Alias for field number 2

id: str¶: Alias for field number 0

is_male: bool¶: Alias for field number 1

exception ctnx.validation.ParseError(message, pos: int, *args)[source]¶: Bases: ValueError

ctnx.validation.is_valid_cccd(raw: int | str) → bool[source]¶

Checks whether a Vietnamese Citizen Identity Card (Căn cước công dân) number is valid or not.

Parameters:: raw (str or int) – The ID number to be validated
Returns:: Whether the ID is valid or not
Return type:: bool

ctnx.validation.parse_cccd(raw: int | str) → CccdResult[source]¶

Extracts information from a Vietnamese Citizen Identity Card (Căn cước công dân) number.

Parameters:: raw (str or int) – The ID number to be parsed
Returns:: A named tuple containing the extracted information, consisting of gender, date of birth, registration place, and the unique sequential ID
Return type:: CccdResult
Raises:: ParseError – If the ID is invalid