DadosAbertosBrasil.utils

Subpacote _utils — Ferramentas auxiliares do pacote DadosAbertosBrasil.

Módulos

• errors: Exceções personalizadas para as funções do pacote.

• get: Função para captura de dados em formato JSON.

• parse: Padronização de inputs das funções do pacote.

utils.endpoints

utils.errors

Erros específicos dos módulos do DadosAbertosBrasil.

exception DadosAbertosBrasil.utils.errors.DAB_DataError

Base: TypeError

Erro gerado quando o usuário insere um valor inválido para a data.

exception DadosAbertosBrasil.utils.errors.DAB_DeprecationError

Base: DeprecationWarning

Erro gerado quando o usuário chama uma função depreciada.

exception DadosAbertosBrasil.utils.errors.DAB_InputError

Base: ValueError

Erro gerado quando o usuário insere um valor inválido para um argumento.

exception DadosAbertosBrasil.utils.errors.DAB_LocalidadeError

Base: TypeError

Erro gerado quando o usuário insere um valor inválido para a localidade.

exception DadosAbertosBrasil.utils.errors.DAB_MoedaError

Base: ValueError

Erro gerado quando o usuário insere um valor inválido para uma moeda.

exception DadosAbertosBrasil.utils.errors.DAB_UFError

Base: ValueError

Erro gerado quando o usuário insere um valor inválido para a UF.

utils.get

class DadosAbertosBrasil.utils.get.Base(endpoint: Literal['camara', 'senado'], path: list[str], unpack_keys: list[str], error_key: str, atributos: dict, verify: bool)

Base: object

Base para os objetos DadosAbertosBrasil.

Parameters

api{‘camara’, ‘senado’}

Referência da API que será consultada.

pathstr or list of str

Argumentos da consulta via URL.

unpack_keysstr or list of str

Lista de keys do arquivo JSON onde estão os dados.

error_keystr

Key que deve estar contida no arquivo JSON.

atributosdict[str, str]

Dicionário de atributos e respectivos unpack_keys.

Attributes

dadosdict

Arquivo JSON em seu formato bruto.

Raises

DadosAbertosBrasil._utils.errors.DAB_InputError

Quando os dados do Senador não forem encontrado, por qualquer que seja o motivo.

class DadosAbertosBrasil.utils.get.Get(*, endpoint: str, path: list[str], params: dict | None = None, verify: bool = True, unpack_keys: list[str] | None = None, cols_to_rename: dict | None = None, cols_to_int: list[str] | None = None, cols_to_date: list[str] | None = None, cols_to_bool: list[str] | None = None, true_value: str | None = None, false_value: str | None = None, remover_url: bool = False, url_cols: list[str] | None = None, index: bool = False, index_col: str = 'codigo')

Base: BaseModel

Função padrão para coleta e formatação de dados JSON.

Parameters

endpointstr

Seleciona o endpoint da API desejada. Consultar _utils.endpoints.ENDPOINTS.

pathlist[str]

Diretório dos dados a partir do endpoint.

paramsdict, optional

Parâmetros do request HTTP.

unpack_keyslist[str], optional

Lista de chaves do arquivo JSON para acessar os dados relevantes.

cols_to_renamedict, optional

Colunas que serão renomeadas.

cols_to_intlist of str, optional

Lista de colunas que serão convertidas em int.

cols_to_datelist of str, optional

Lista de colunas que serão convertidas em datetime.

cols_to_boollist of str, optional

Lista de colunas que serão convertidas em bool.

true_valuestr, optional

Valor que será convertido para True nas colunas listadas pelo argumento cols_to_bool.

false_valuestr, optional

Valor que será convertido para False nas colunas listadas pelo argumento cols_to_bool.

urlbool, default=True

Retorna ou não as colunas contendo URI, URL ou e-mails.

url_colslist of str, optional

Lista das colunas que serão removidas ou não pelo argumento url.

indexbool, default=False

Se True, define a coluna de index_col como index do DataFrame. Esse argumento é ignorado se formato for igual a ‘json’.

index_colstr, default=’codigo’

Nome da coluna que será o index do DataFrame, caso o argumento index seja igual a True.

cols_to_bool: list[str] | None

cols_to_date: list[str] | None

cols_to_int: list[str] | None

cols_to_rename: dict | None

endpoint: str

false_value: str | None

get(formato: Literal['json', 'pandas', 'url'] = 'pandas') → DataFrame | str | dict | list[dict]

index: bool

index_col: str

property json: dict

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property pandas: DataFrame

params: dict | None

path: list[str]

remover_url: bool

true_value: str | None

unpack_keys: list[str] | None

property url: str

url_cols: list[str] | None

verify: bool

utils.parse

Funções para padronização de parâmetros entre os módulos.

Padroniza argumentos de data, UF, localidades e moeda, gerando Exceptions especiais do módulo _utils.errors.

DadosAbertosBrasil.utils.parse.data(data: datetime | date | str, modulo: str) → str

Padroniza o input de datas entre módulos.

Parameters

data: datetime.datetime or datetime.date or str

Input a ser padronizado. Pode ser uma objeto date, datetime ou uma string no formato ISO-8601.

modulo: {‘camara’, ‘senado’, ‘bacen’}

Módulo que o parser seja aplicado para selecionar a formatação adequada:

• ‘camara’: API da Câmara dos Deputados;

• ‘senado’: API do Senado Federal;

• ‘bacen’: Consultas do Banco Central do Brasil.

Returns

str

Data no formato adequado para o módulo escolhido.

DadosAbertosBrasil.utils.parse.localidade(localidade: str, brasil=1, on_error='raise') → str

Verifica se o código da localidade é válido.

Parametros

localidade: str ou int

Código da localidade que se deseja verificar. Caso localidade == None, retorna o valor padrão do Brasil.

brasil: default = 1

Valor padrão para o Brasil.

on_error: {‘raise’, ‘brasil’}, default=’raise’

• ‘raise’: Gera um erro quando o valor não for válido;

• ‘brasil’: Retorna o valor Brasil quando o valor não for válido.

Returns

str ou int

Valor da localidade validado.

DadosAbertosBrasil.utils.parse.moeda(moedas: str | list[str]) → list[str]

Verifica se o(s) código(s) da(s) moeda(s) inserida(s) está(ão) em um formato válido.

Parameters

moedasstr or list of str

Símbolo da moeda ou lista de símbolos de moedas que se deseja validar.

Returns

list of str

Lista de símbolos de moedas formatados.

DadosAbertosBrasil.utils.parse.uf(uf: str | int, extintos: bool = False) → str

Converte os nomes dos estados em siglas padrões. Suporta abreviaturas, acentuação e case sensibility.

Parametros

uf: str | int

Nome, sigla ou código IBGE da UF.

extintos: bool, default=False

Verificar também as UFs extintas:

• 20: Fernando de Noronha / FN

• 34: Guanabara / GB

Returns

str

String de dois caracteres maiúsculos que representam a sigla da Unidade Federativa desejada.

utils.typing