Tipos

tipos

Tipos usados pela biblioteca.

ModuloT

ModuloT = Literal['ecd', 'ecf', 'efd_contribuicoes', 'efd_icms_ipi']

Tipo que representa o nome de um módulo.

ModulosT

ModulosT = dict[ModuloT, LeiauteT]

Tipo que representa as informações dos módulos.

CampoTipoT

CampoTipoT = Literal['C', 'N']

Tipo que representa os diferentes tipos de campos.

Chave

Chave = str | int

Tipo que representam os valores que podem ser usados para indexar um campo.

ValorC

ValorC = str

Tipo que representa o valor alfanumérico de um campo.

ValorN

ValorN = int | float | None

Tipo que representa o valor numérico de um campo.

ValorN0

ValorN0 = int | float

Tipo que representa o valor numérico, não nulo, de um campo.

Valor

Valor = ValorC | ValorN

Tipo que representa o valor de um campo.

Valor0

Valor0 = ValorC | ValorN0

Tipo que representa o valor, não nulo, de um campo.

LeiauteT

Bases: TypedDict

Tipo que representa as informações de um leiaute de módulo.

Attributes:

• registros (dict[str, RegistroT]) –

  Informações sobre registros.

• blocos (list[BlocoT]) –

  Informações sobre blocos.

BlocoT

Bases: TypedDict

Tipo que representa as informações de um bloco.

Attributes:

• numero (int) –

  Ordem do bloco na escrituração.

• nome (str) –

  Nome do bloco.

• descricao (str) –

  Descrição do bloco.

• abertura (str) –

  Nome do registro de abertura do bloco.

• fechamento (str) –

  Nome do registro de fechamento do bloco.

RegistroT

Bases: TypedDict

Tipo que representa as informações de um registro.

Attributes:

• descricao (str) –

  Descrição do registro.

• nivel (int) –

  Nível do registro na escrituração.

• obrigatorio (bool) –

  Se o registro é obrigatório estar presente na escrituração.

• unico (bool) –

  Se o registro é único na escrituração.

• campos (list[CampoT]) –

  Informações sobres os campos do registro.

• campos_exatos (list[int] | None) –

  Quando diferente de None, é uma lista de quantidade de campos permitidos.

• campos_faixa (tuple[int, int] | None) –

  Quando diferente de None, é uma tupla com a quantidade mínima e máxima de campos permitidos.

• filhos (list[str]) –

  Lista de nomes de registros filhos válidos do registro.

• pai (str | None) –

  Nome do pai do registro, se existir.

CampoT

Bases: TypedDict

Tipo que representa as informações de um campo.

Attributes:

• numero (int) –

  Ordem do campo no registro.

• nome (str) –

  Nome do campo.

• descricao (str) –

  Descrição do campo.

• obrigatorio (bool) –

  Se o preenchimento do campo é obrigatório.

• tamanho (int) –

  Tamanho máximo do campo.

• tamanho_exato (bool) –

  Se o tamanho do campo precisa ser exato.

• decimal (int | None) –

  Quantidade de casas decimais do campo.

• tipo (CampoTipoT) –

  Tipo do campo.