DadosAbertosBrasil.uf

Objeto UF contendo informações das Unidades da Federação.

Este módulo consolida dados estaduais disponíveis no pacote DadosAbertosBrasil, incluindo informações sobre governadores e outras estatísticas por estado.

Objeto UF contendo informações das Unidades da Federação.

Serve como um consolidador por UF de diversar funções do pacote DadosAbertosBrasil.

class DadosAbertosBrasil.uf._governador.Governador(uf: str, verificar_certificado: bool = True)

Base: object

Informações básicas do governador da UF.

Parameters

uf: str

Nome, sigla ou código da UF desejada.

verificar_certificadobool, default=True

Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Attributes

uf : str nome : str nome_completo : str ano_eleicao : int mandato_inicio : datetime.date mandato_fim : datetime.date partido : str partido_sigla : str vice_governador : str

Objeto UF contendo informações das Unidades da Federação.

Serve como um consolidador por UF de diversar funções do pacote DadosAbertosBrasil.

class DadosAbertosBrasil.uf._uf.UF(uf: str, verificar_certificado: bool = True)

Base: object

Consolidado de informações de uma Unidade Federativa.

Parameters

ufstr

Nome, sigla ou código da UF desejada.

verificar_certificadobool, default=True

Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Attributes

siglastr

Sigla de duas letras maiúsculas.

codint

Código IBGE.

nomestr

Nome completo.

areafloat

Área terrotorial em quilómetros quadrados.

capitalstr

Cidade sede do governo estadual.

extintobool

True, caso UF tenha sido extinta (Fernando de Noronha ou Guanabara).

gentilicoset

Conjunto de gentílicos e variações.

lemastr

Lema da UF.

regiaostr

Grande região (Norte, Nordeste, Sudeste, Sul ou Centro-Oeste).

coordenadasdict[str, float]

Dicionário contendo latitude e longitude.

Properties

densidadefloat

Densidade populacional (hab/km²) da UF.

galeriaDadosAbertosBrasil.ibge.Galeria

Gera uma galeria de fotos da UF.

governadorDadosAbertosBrasil.uf.Governador

Informações básico do governador da UF.

historiaDadosAbertosBrasil.ibge.Historia

Objeto contendo a história da UF.

municipioslist[str]

Lista de municípios.

populacaoint

População projetada pelo IBGE.

Methods

bandeira(tamanho=100)

Gera a URL da WikiMedia para a bandeira do estado.

brasao(tamanho=100)

Gera a URL da WikiMedia para o brasão do estado.

deputados(nome, legislatura, partido, sexo, inicio, fim, pagina, itens…)

Lista dos deputados federais em exercício.

malha(nivel, divisoes, periodo, formato, qualidade)

Obtém a URL para a malha referente à UF.

senadores(tipo, sexo, partido, contendo, excluindo, url, index, formato)

Lista de senadores da república desta UF.

bandeira(tamanho: int = 100) → str

Gera a URL da WikiMedia para a bandeira do estado.

Parameters

tamanhoint, default=100

Tamanho em pixels da bandeira.

Returns

str

URL da bandeira do estado no formato PNG.

See Also

DadosAbertosBrasil.favoritos.bandeira

Função original.

Examples

Gera o link para a imagem da bandeira de Santa Catarina de 200 pixels.

>>> sc = UF("sc")
>>> sc.bandeira(tamanho=200)
'https://upload.wikimedia.org/wikipedia/commons/thumb/1/1a/' ...

brasao(tamanho: int = 100) → str

Gera a URL da WikiMedia para o brasão do estado.

Parameters

tamanhoint, default=100

Tamanho em pixels da bandeira.

Returns

str

URL da bandeira do estado no formato PNG.

See Also

DadosAbertosBrasil.favoritos.brasao

Função original.

Examples

Gera o link para a imagem do brasão de Santa Catarina de 200 pixels.

>>> sc = UF('SC')
>>> sc.brasao(tamanho=200)
'https://upload.wikimedia.org/wikipedia/commons/thumb/1/1a/' ...

property densidade: float

Densidade populacional (hab/km²) da UF.

É a razão entre a população projetada pelo IBGE (habitantes) e a área territorial da UF (quilómetros quadrados).

Returns

float

Densidade populacional.

Raises

DAB_UFError

Caso seja uma UF extinta.

See Also

DadosAbertosBrasil.ibge.populacao

Função utilizada para projetar a população da UF.

Examples

>>> am = UF('AM')
>>> am.populacao()
2.719286132694809

deputados(nome: str | None = None, legislatura: int | None = None, partido: str | None = None, sexo: str | None = None, inicio: date | None = None, fim: date | None = None, pagina: int = 1, itens: int | None = None, asc: bool = True, ordenar_por: str = 'nome', url: bool = True, index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict]

Lista dos deputados federais da UF em exercício.

Retorna uma lista de dados básicos sobre deputados que estiveram em exercício parlamentar em algum intervalo de tempo. Se não for passado um parâmetro de tempo, como legislatura ou inicio, a lista enumerará somente os deputados em exercício no momento da requisição.

Parameters

nomestr, optional

Parte do nome dos parlamentares.

legislaturaint, optional

Número da legislatura a qual os dados buscados devem corresponder.

partidostr, optional

Sigla do partido ao qual sejam filiados os deputados. Para obter as siglas válidas, consulte a função camara.lista_partidos. Atenção: partidos diferentes podem usar a mesma sigla em diferentes legislaturas.

sexo{‘f’, ‘m’}, optional

Letra que designe o gênero dos parlamentares que se deseja buscar: - ‘f’: Feminino; - ‘m’: Masculino.

iniciostr, optional

Data de início de um intervalo de tempo, no formato ‘AAAA-MM-DD’.

fimstr, optional

Data de término de um intervalo de tempo, no formato ‘AAAA-MM-DD’.

paginaint, default=1

Número da página de resultados, a partir de 1, que se deseja obter com a requisição, contendo o número de itens definido pelo parâmetro itens. Se omitido, assume o valor 1.

itensint, optional

Número máximo de itens na página que se deseja obter com esta requisição.

ascbool, default=True

Se os registros são ordenados no sentido ascendente: - True: De A a Z ou 0 a 9 (ascendente); - False: De Z a A ou 9 a 0 (descendente).

ordenar_porstr, default=’nome’

Qual dos elementos da representação deverá ser usado para aplicar ordenação à lista.

urlbool, default=False

Se False, remove as colunas contendo URI, URL e e-mails. Esse argumento é ignorado se formato for igual a ‘json’.

indexbool, default=False

Se True, define a coluna id como index do DataFrame.

formato{“json”, “pandas”, “url”}, default=”pandas”

Formato do dado que será retornado: - “json”: Dicionário com as chaves e valores originais da API; - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.

verificar_certificadobool, default=True

Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Returns

pandas.core.frame.DataFrame | str | dict | list[dict]

Tabela com informações básicas dos deputados federais.

Raises

DAB_UFError

Caso seja uma UF extinta.

See Also

DadosAbertosBrasil.camara.lista_deputados

Função original.

Examples

>>> rj = UF('RJ')
>>> rj.deputados()

property galeria: Galeria

Gera uma galeria de fotos da UF.

Returns

DadosAbertosBrasil._ibge.cidades.Galeria

Objeto Galeria contendo uma lista de Fotografias.

See Also

DadosAbertosBrasil.ibge.Galeria

Classe original.

Examples

Capturar a primeira fotografia da galeria do Espírito Santo.

>>> es = dab.UF('ES')
>>> galeria = es.galeria()
>>> foto = galeria.fotografias[0]

Gerar uma URL da fotografia com altura máxima de 500 pixels.

>>> foto.url(altura=500)
'https://servicodados.ibge.gov.br/api/v1/resize/image?maxwidth=600...'

property governador: Governador

Informações básicas do governador da UF.

Attributes

uf : str nome : str nome_completo : str ano_eleicao : int mandato_inicio : datetime.date mandato_fim : datetime.date partido : str partido_sigla : str cargo_anterior : str vice_governador : str

Raises

DAB_UFError

Caso seja uma UF extinta.

property historia: Historia

Objeto contendo a história da UF.

Returns

DadosAbertosBrasil._ibge.cidades.Historia

Objeto Historia da API IBGE Cidades.

See Also

DadosAbertosBrasil.ibge.Historia

Classe original.

Examples

Capturar o texto da história de Minas Gerais.

>>> mg = dab.UF('MG')
>>> hist = mg.historia()
>>> hist.historico
"O Município de Wenceslau Braz tem sua origem praticamente desconh..."

malha(nivel: str = 'estados', divisoes: str | None = None, periodo: int = 2020, formato: str = 'geojson', qualidade: str = 'minima') → dict | str

Obtém a malha referente à UF.

Parameters

nivelstr, default=’estados’

Nível geográfico dos dados.

divisoesstr, optional

Subdiviões intrarregionais do nível. Se None, apresenta a malha sem subdivisões.

periodoint, default=2020

Ano da revisão da malha.

formato{‘svg’, ‘json’, ‘geojson’}, default=’geojson’

Formato dos dados da malha.

qualidade{‘minima’, ‘intermediaria’, ‘maxima’}, default=’minima’

Qualidade de imagem da malha.

Returns

str

Se formato=’svg’, retorna a URL da malha da localidade desejada.

dict

Se formato=’json’, retorna a malha em formato TopoJSON.

dict

Se formato=’geojson’, retorna a malha em formato GeoJSON.

Raises

DAB_LocalidadeError

Caso o nível geográfico seja inválido.

Notes

https://servicodados.ibge.gov.br/api/docs/malhas?versao=3

See also

DadosAbertosBrasil.ibge.malha

Função original

Examples

Captura a malha do Distrito Federal (localidade=53) em formato GeoJSON.

>>> df = dab.UF('DF')
>>> df.malha(formato='geojson')
{'type': 'FeatureCollection',
    'features': [{'type': 'Feature',
        'geometry': {'type': 'Polygon',
            'coordinates': [[[-47.31, -16.0363], ...

Captura a malha de Alagoas em formato SVG com qualidade mínima com subdivisões municipais.

>>> al = dab.UF('alagoas')
>>> al.malha(
...     nivel = 'municipios',
...     formato = 'svg',
...     qualidade = 'minima'
... )
'https://servicodados.ibge.gov.br/api/v3/malhas/...'

property municipios: int | str

Lista de municípios.

Returns

dict[int, str]

Dicionário onde a chave é o código IBGE do município e o valor é seu respectivo nome.

Raises

DAB_UFError

Caso seja uma UF extinta.

Examples

>>> ac = UF('AC')
>>> ac.municipios()
{1200013: 'Acrelândia', 1200054: 'Assis Brasil', 1200104: 'Brasiléia', ...

property populacao: int

População projetada pelo IBGE.

Returns

int

População projetada.

Raises

DAB_UFError

Caso seja uma UF extinta.

See Also

DadosAbertosBrasil.ibge.populacao

Função original.

Examples

>>> df = UF('DF')
>>> df.populacao()
3092244

senadores(tipo: Literal['atual', 'titulares', 'suplentes', 'afastados'] = 'atual', sexo: str | None = None, partido: str | None = None, contendo: str | None = None, excluindo: str | None = None, url: bool = True, index: bool = False, formato: Literal['json', 'pandas', 'url'] = 'pandas', verificar_certificado: bool = True) → DataFrame | str | dict | list[dict]

Lista de senadores da república desta UF.

Parameters

tipo{‘atual’, ‘titulares’, ‘suplentes’, ‘afastados’}, default=’atual’

• ‘atual’: Todos os senadores em exercício;

• ‘titulares’: Apenas senadores que iniciaram o mandato como titulares;

• ‘suplentes’: Apenas senadores que iniciaram o mandato como suplentes;

• ‘afastados’: Todos os senadores afastados.

sexostr, optional

Filtro de sexo dos senadores.

partidostr, optional

Filtro de partido dos senadores.

contendostr, optional

Captura apenas senadores contendo esse texto no nome.

excluindostr, optional

Exclui da consulta senadores contendo esse texto no nome.

urlbool, default=False

Se False, remove as colunas contendo URI, URL e e-mails. Esse argumento é ignorado se formato for igual a ‘json’.

indexbool, default=False

Se True, define a coluna codigo como index do DataFrame.

formato{“json”, “pandas”, “url”}, default=”pandas”

Formato do dado que será retornado: - “json”: Dicionário com as chaves e valores originais da API; - “pandas”: DataFrame formatado; - “url”: Endereço da API que retorna o arquivo JSON.

verificar_certificadobool, default=True

Defina esse argumento como False em caso de falha na verificação do certificado SSL.

Returns

pandas.core.frame.DataFrame | str | dict | list[dict]

Lista de senadores.

See Also

DadosAbertosBrasil.senado.lista_senadores

Função original.

Examples

Lista senadores do partido PL do Rio de Janeiro.

>>> rj = UF('rj')
>>> rj.senadores(partido='PL')
codigo nome_parlamentar              nome_completo       sexo         0   5936  Carlos Portinho  Carlos Francisco Portinho  Masculino
1   5322          Romário     Romario de Souza Faria  Masculino