brazilian_ids.functions.person package

Submodules

brazilian_ids.functions.person.cpf module

Functions to handle a CPF.

exception brazilian_ids.functions.person.cpf.InvalidCpfError(cpf)

Bases: InvalidCpfTypeMixin, InvalidIdError

Exception for an invalid CPF.

Parameters:

cpf (str)

exception brazilian_ids.functions.person.cpf.InvalidCpfLengthError(cpf)

Bases: InvalidCpfTypeMixin, InvalidIdLengthError

Exception for an invalid CPF with less than 9 digits.

Parameters:

cpf (str)

class brazilian_ids.functions.person.cpf.InvalidCpfTypeMixin

Bases: object

Mixin class for CPF errors.

id_type()

brazilian_ids.functions.person.cpf.format(cpf)

Applies the typical 000.000.000-00 formatting to CPF.

Parameters:

cpf (str)

Return type:

str

brazilian_ids.functions.person.cpf.is_valid(cpf, autopad=True)

Check whether CPF is valid.

Parameters:

• cpf (str)

• autopad (bool)

brazilian_ids.functions.person.cpf.pad(cpf)

Takes a CPF that has leading zeros and pads it.

If the given CPF is invalid, the InvalidCPFError exception is raised.

Parameters:

cpf (str)

Return type:

str

brazilian_ids.functions.person.cpf.random(formatted=True)

Create a random, valid CPF identifier.

Parameters:

formatted (bool)

Return type:

str

brazilian_ids.functions.person.cpf.verification_digits(cpf)

Find the two check digits that are required to make a CPF valid.

If the length of the CPF is less than 9 characters, the InvalidCPFLengthError is raised.

Parameters:

cpf (str)

Return type:

tuple[int, int]

brazilian_ids.functions.person.pis_pasep module

Functions to handle Brazilian PIS/PASEP identifiers.

exception brazilian_ids.functions.person.pis_pasep.InvalidPISPASEPError(pis_pasep)

Bases: InvalidPisPasedTypeMixin, InvalidIdError

Exception for an invalid PIS/PASEP.

Parameters:

pis_pasep (str)

Return type:

None

exception brazilian_ids.functions.person.pis_pasep.InvalidPISPASEPLengthError(pis_pasep)

Bases: InvalidPisPasedTypeMixin, InvalidIdLengthError

Exception for an invalid PIS/PASEP with less than 10 digits.

Parameters:

pis_pasep (str)

Return type:

None

class brazilian_ids.functions.person.pis_pasep.InvalidPisPasedTypeMixin

Bases: object

Mixin class for PIS/PASEP errors.

id_type()

brazilian_ids.functions.person.pis_pasep.format(pis_pasep)

Applies the format ‘000.0000.000-0’ to a PIS/PASEP.

Parameters:

pis_pasep (str)

Return type:

str

brazilian_ids.functions.person.pis_pasep.is_valid(pis_pasep, autopad=True)

Check whether PIS/PASEP is valid. Optionally pad if too short.

Parameters:

• pis_pasep (str)

• autopad (bool)

Return type:

bool

brazilian_ids.functions.person.pis_pasep.pad(pis_pasep, validate=False)

Takes a PIS/PASEP that should have leading zeros and pads it.

Parameters:

• pis_pasep (str)

• validate (bool)

Return type:

str

brazilian_ids.functions.person.pis_pasep.random(formatted=True)

Create a random, valid PIS identifier.

brazilian_ids.functions.person.pis_pasep.validation_digit(pis_pasep)

Calculate the validation (last) digit required to make a PIS/PASEP valid.

Parameters:

pis_pasep (str)

Return type:

int

Module contents