Welcome to postmon-python’s documentation!¶

Contents:

O postmon-python é um wrapper da API do Postmon.

As chamadas devem ser feitas para as funções do módulo, que fazem as chamadas para o Postmon e retornam objetos com os resultados. Em caso de falha, todas as funções retornam None.

class postmon.Cidade(uf, nome, area_km2=None, codigo_ibge=None, **kwargs)¶: Objeto que representa uma cidade do Postmon.

class postmon.Endereco(cep, logradouro=None, bairro=None, cidade=None, estado=None, cidade_info=None, estado_info=None, **kwargs)¶

Objeto que representa um endereço do Postmon.

O Endereco pode ser criado apenas com o CEP para posteriormente ser buscado.

>>> import postmon
>>> e = postmon.Endereco('30110-012')
>>> if e.buscar():
...     print("Bairro: %s" % e.bairro)
... else:
...     print("Busca falhou: %s" % e.status)
Bairro: Floresta

class postmon.Estado(uf, nome=None, area_km2=None, codigo_ibge=None, **kwargs)¶: Objeto que representa um estado do Postmon.

class postmon.PostmonModel¶

Objeto base para os modelos do Postmon.

buscar()¶

Faz a busca das informações do objeto no Postmon.

Retorna um bool indicando se a busca foi bem sucedida.

status¶

Status da resposta recebida do Postmon.

Os status previstos pelo Postmon são:

200 OK

404 CEP NAO ENCONTRADO

503 SERVICO INDISPONIVEL

Além dos status listados, outros status HTTP podem ocorrer, como em qualquer chamada HTTP.

O único caso de sucesso é o 200 OK, caso em que o resultado no objeto é válido e pode ser utilizado.

url¶

Retorna a URL chamada pelo objeto.

>>> e = Endereco('11111111')
>>> e.url
'http://api.postmon.com.br/v1/cep/11111111'

postmon.cidade(uf, nome)¶

Busca a cidade no Postmon e retorna um objeto Cidade.

Retorna None caso a cidade não exista ou caso ocorra algum erro de comunicação.

>>> import postmon
>>> postmon.cidade('MG', 'Belo Horizonte')
<Cidade 'Belo Horizonte'>

postmon.endereco(cep)¶

Busca o CEP no Postmon e retorna um objeto Endereco.

Retorna None caso o CEP não exista ou caso ocorra algum erro de comunicação.

>>> import postmon
>>> postmon.endereco('01001-000')
<Endereco '01001-000'>

postmon.estado(uf)¶

Busca o estado no Postmon e retorna um objeto Estado.

Retorna None caso o estado não exista ou caso ocorra algum erro de comunicação.

>>> import postmon
>>> postmon.estado('MG')
<Estado 'MG'>

Welcome to postmon-python’s documentation!¶

Indices and tables¶