brazilian_ids.functions package

Subpackages

• brazilian_ids.functions.company package
  • Submodules
  • brazilian_ids.functions.company.cnpj module
    • CNPJ
      • CNPJ.cnpj
      • CNPJ.establishment
      • CNPJ.firm
      • CNPJ.first_digit
      • CNPJ.second_digit
    • InvalidCnpjError
    • InvalidCnpjLengthError
    • InvalidCnpjTypeMixin
      • InvalidCnpjTypeMixin.id_type()
    • format()
    • from_firm_id()
    • is_valid()
    • pad()
    • parse()
    • random()
    • verification_digits()
  • Module contents
• brazilian_ids.functions.labor_dispute package
  • Submodules
  • brazilian_ids.functions.labor_dispute.nupj module
    • Court
      • Court.acronym
      • Court.description
      • Court.id
    • Courts
      • Courts.court()
      • Courts.court_acronym()
      • Courts.segment()
      • Courts.total_courts()
    • InvalidCourtIdError
    • InvalidNupjError
    • InvalidNupjTypeMixin
      • InvalidNupjTypeMixin.id_type()
    • InvalidSegmentIdError
    • NUPJ
      • NUPJ.court_id
      • NUPJ.digits()
      • NUPJ.first_digit
      • NUPJ.lawsuit_city
      • NUPJ.lawsuit_id
      • NUPJ.second_digit
      • NUPJ.segment
      • NUPJ.year
    • is_valid()
    • pad()
    • parse()
  • Module contents
• brazilian_ids.functions.location package
  • Submodules
  • brazilian_ids.functions.location.cep module
    • CEP
      • CEP.division
      • CEP.formatted_cep
      • CEP.region
      • CEP.sector
      • CEP.sub_region
      • CEP.sub_sector
      • CEP.suffix
    • format()
    • parse()
  • brazilian_ids.functions.location.municipio module
    • InvalidMunicipioFederalUnitError
    • InvalidMunicipioLengthError
    • InvalidMunicipioTypeMixin
      • InvalidMunicipioTypeMixin.id_type()
    • Municipio
      • Municipio.control_digits
      • Municipio.federal_unit
      • Municipio.federal_unit_code
      • Municipio.federal_units()
      • Municipio.municipio
    • is_valid()
    • parse()
  • Module contents
• brazilian_ids.functions.person package
  • Submodules
  • brazilian_ids.functions.person.cpf module
    • InvalidCpfError
    • InvalidCpfLengthError
    • InvalidCpfTypeMixin
      • InvalidCpfTypeMixin.id_type()
    • format()
    • is_valid()
    • pad()
    • random()
    • verification_digits()
  • brazilian_ids.functions.person.pis_pasep module
    • InvalidPISPASEPError
    • InvalidPISPASEPLengthError
    • InvalidPisPasedTypeMixin
      • InvalidPisPasedTypeMixin.id_type()
    • format()
    • is_valid()
    • pad()
    • random()
    • validation_digit()
  • Module contents
• brazilian_ids.functions.real_state package
  • Submodules
  • brazilian_ids.functions.real_state.cno module
    • InvalidCnoError
    • InvalidCnoLengthError
    • InvalidCnoTypeMixin
      • InvalidCnoTypeMixin.id_type()
    • format()
    • is_valid()
    • pad()
    • random()
    • verification_digit()
  • brazilian_ids.functions.real_state.sql module
    • InvalidSqlError
    • InvalidSqlLengthError
    • InvalidSqlTypeMixin
      • InvalidSqlTypeMixin.id_type()
    • format()
    • is_valid()
    • pad()
    • verification_digit()
  • Module contents

Submodules

brazilian_ids.functions.exceptions module

Generic exceptions for bad formed ID’s.

exception brazilian_ids.functions.exceptions.InvalidIdError(id, message=None)

Bases: ValueError

Exception for an invalid ID.

Parameters:

• id (str)

• message (None | str)

Return type:

None

abstract id_type()

Return the ID type. Subclasses must override this method.

exception brazilian_ids.functions.exceptions.InvalidIdLengthError(id, expected_digits)

Bases: InvalidIdError

Exception for an ID that has missing digits, excluding the verification one in the expected number of digits.

Parameters:

• id (str)

• expected_digits (int)

Return type:

None

brazilian_ids.functions.util module

Helper to validate identifiers.

For internal use only.

Module contents