base4sistemas / acbrlib-python

Camada de abstração para acesso à ACBrLib em Python

ACBrLib Python

Camada de abstração para acesso à ACBrLib em Python.

---

ACBrLib é um conjunto de bibliotecas voltadas para o mercado de automação comercial que oferece acesso à um conjunto rico de abstrações que facilitam o desenvolvimento de aplicações como pontos-de-venda (PDV) e aplicações relacionadas. Esta biblioteca fornece uma camada que torna trivial a utilização da ACBrLib em seus próprios aplicativos escritos em linguagem Python.

Note

Esta biblioteca está em seus primeiros estágios de desenvolvimento, portanto, não espere encontrar toda a riqueza que os componentes ACBr possuem, por enquanto. Mas estamos totalmente abertos a sujestões e estamos aceitando pull-requests.

Instalação

Instale, preferencialmente em um ambiente virtual, usando pip:

pip install acbrlib-python

ACBrLibCEP

Dá acesso a consultas de CEP utilizando dezenas de serviços de consulta disponíveis. Alguns desses serviços podem ser gratuítos ou gratuítos para desenvolvimento. Veja este link para ter uma ideia dos serviços que podem ser utilizados.

Para fazer uma consulta baseada no CEP:

from acbrlib_python import ACBrLibCEP

with ACBrLibCEP.usando('/caminho/para/libacbrcep64.so') as cep:
    enderecos = cep.buscar_por_cep('18270170')
    for endereco in enderecos:
        print(endereco)

O trecho acima resultará em uma lista de objetos Endereco como resultado da busca, prontos para serem usados. A consulta acima trará um único resultado (usando o serviço ViaCEP):

Endereco(
        tipo_logradouro='',
        logradouro='Rua Coronel Aureliano de Camargo',
        complemento='',
        bairro='Centro',
        municipio='Tatuí',
        uf='SP',
        cep='18270-170',
        ibge_municipio='3554003',
        ibge_uf='35'
    )

Para mais exemplos de uso, veja a pasta exemplos neste repositório.

Sobre Nomenclatura e Estilo de Código

Uma questão muito relevante é a maneira como esta abstração se refere aos nomes dos métodos disponíveis na biblioteca ACBrLib que utiliza uma convenção de nomenclatura para variáveis e nomes de argumentos ou parâmetros de funções conhecida como Notação Húngara. Porém, em Python é utilizada a convenção snake case tal como descrito na PEP8.

Assim, para manter o estilo de Python, os nomes de variáveis e argumentos de função deverão descartar o prefixo que indica o tipo de dado e converter o restante para snake case, assim como nomes de métodos e funções também, por exemplo:

• eArqConfig para arq_config;
• ConfigLerValor para config_ler_valor;
• eArquivoXmlEvento para arquivo_xml_evento;
• etc…

Métodos de bibliotecas que são prefixados com o nome da lib, será descartado o prefixo e o restante do nome do método convertido para snake case, por exemplo:

• (ACBrLibNFe) NFE_CarregarINI para carregar_ini;
• (ACBrLibNFe) NFE_ValidarRegrasdeNegocios para validar_regras_de_negocios (note a correção do conector de que está em minúsculo no original);
• (ACBrLibCEP) CEP_BuscarPorLogradouro para buscar_por_logradouro;
• etc…

Esperamos que essa explicação faça sentido, senão, envia suas sujestões.

Desenvolvimento

Você é bem-vindo para ajudar no desenvolvimento desta biblioteca enviando suas contribuições através de pull-requests. Faça um fork deste repositório e execute os testes antes de começar a implementar alguma coisa. A gestão de dependências é feita via Poetry e recomendamos a utilização de pyenv

$ git clone https://github.com/base4sistemas/acbrlib-python.git
$ cd acbrlib-python
$ poetry install
$ poetry run pytest