lbxtoolkit 2.2.0__py3-none-any.whl → 2.2.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lbxtoolkit/__init__.py +72 -40
- lbxtoolkit/api_rest.py +16 -14
- lbxtoolkit/auth_entra_id.py +6 -7
- lbxtoolkit/config_manager.py +8 -6
- lbxtoolkit/lbx_logger.py +69 -28
- lbxtoolkit/misc.py +6 -6
- lbxtoolkit/postgresql.py +10 -10
- lbxtoolkit/service.py +154 -9
- lbxtoolkit/service_windows.py +24 -10
- lbxtoolkit-2.2.1.dist-info/METADATA +1002 -0
- lbxtoolkit-2.2.1.dist-info/RECORD +12 -0
- lbxtoolkit-2.2.0.dist-info/METADATA +0 -592
- lbxtoolkit-2.2.0.dist-info/RECORD +0 -12
- {lbxtoolkit-2.2.0.dist-info → lbxtoolkit-2.2.1.dist-info}/WHEEL +0 -0
lbxtoolkit/__init__.py
CHANGED
|
@@ -1,64 +1,95 @@
|
|
|
1
1
|
"""
|
|
2
|
-
# **
|
|
2
|
+
# **Caixa de ferramentas de automações de processo (RPA)**
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
Biblioteca com ferramentas utilitárias e de uso recorrente em aplicações de RPA para automações de processos.
|
|
5
|
+
|
|
6
|
+
Todas as classes e métodos deste módulo possuem **docstrings**. Portanto, para ter acesso às informações de uso, use `nome_classe.__doc__`. Exemplo:
|
|
7
|
+
|
|
8
|
+
```python
|
|
9
|
+
from lbxtoolkit import Servicer
|
|
10
|
+
help = Servicer.__doc__
|
|
11
|
+
print(help)
|
|
12
|
+
```
|
|
5
13
|
|
|
6
14
|
## **Classe e funções**
|
|
7
15
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
disclaimer : Mensagem sobre a necessidade de autenticação
|
|
11
|
-
valida_grupo : Autentica o usuário e aborta se checa não pertencer ao grupo de segurança
|
|
16
|
+
**auth_EntraID**
|
|
17
|
+
Usa o Microsoft Entra ID (antiga Azure AD) para evitar execução não autorizada de scripts
|
|
18
|
+
> - `disclaimer` : Mensagem sobre a necessidade de autenticação
|
|
19
|
+
> - `valida_grupo` : Autentica o usuário e aborta se checa não pertencer ao grupo de segurança
|
|
12
20
|
|
|
13
|
-
|
|
21
|
+
|
|
14
22
|
**postgreSQL**
|
|
15
23
|
Interage com o banco de dados PostgreSQL
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
24
|
+
> - `db` Inicia sessão com o banco
|
|
25
|
+
> - `csv_df` Lê arquivo CSV e gera Dataframe (pandas) a partir dele
|
|
26
|
+
> - `db_insert_df` Insere informações de Dataframe em tabela do banco com estrutura equivalente
|
|
27
|
+
> - `db_select` Retorna um cursor a partir de uma query
|
|
28
|
+
> - `db_update` Executa update em tabelas
|
|
21
29
|
|
|
22
30
|
|
|
23
31
|
**api_rest**
|
|
24
32
|
Interage com APIs RESTfull, especialmente providas para a plataforma Sienge
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
33
|
+
> - `auth_base` Autentica (HTTPBasicAuth) sessão na API
|
|
34
|
+
> - `auth_bearer` Autentica sessão na API pelos métodos: OAuth, JWT, Bearer
|
|
35
|
+
> - `endpoint_json` Realizad chama ao endpoint. Payload em formato `json` opcional.
|
|
36
|
+
> - `trata_erro_sienge` Retorna a mensagem de erro do Sienge caso código de retorno seja diferente de 200.
|
|
37
|
+
> - `close` Encerra a sessão autenticada
|
|
30
38
|
|
|
31
39
|
**lbx_logger**
|
|
32
40
|
Manipula e formata as mensagens de saída do script para direcioná-las para tela (stdout) e/ou arquivo de log
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
41
|
+
> - `add` Adiciona a mensagem a um _buffer_ sem exibir, acumulando até a próxima chamada em algum dos níveis abaixo.
|
|
42
|
+
> - `print` Contorna o manipulador de log e imprime diretamente na tela (stdout), sem formatar a mensagem nem registrar no arquivo
|
|
43
|
+
> - `debug, .info, .aviso, .erro, .critico` Classifica as mensagens por nível de severidade/relevância e rediciona a saída (arquivo, tela, tela+arquivo) conforme a configuração do nível
|
|
44
|
+
> - `stop_logging` Interrompe a manipulação das saídas pelo logger e restaura as saídas padrão (stdout/stderr) para a tela
|
|
45
|
+
> - `filtra` Filtra os eventos do arquivo de log registrados em um intervalo de tempo específico
|
|
46
|
+
|
|
47
|
+
**SafeLogger**
|
|
48
|
+
Intercepta as ordens de saída comandadas pelos métodos de lbx_logger e interrompe um daemon em execução antes de saír
|
|
49
|
+
|
|
50
|
+
**ConfigManager**
|
|
51
|
+
Permite a inicialização/instanciamento e o consumo de objetos entre classes e métodos independentes, inclusive métodos estáticos (sem instanciamento da classe), garantindo que todas as partes do código usem a mesma instância e, portanto, compartilhem a mesma configuração.
|
|
52
|
+
> - `initialize` Inicialização com Argumentos Dinâmicos: O método initialize usa **kwargs para aceitar qualquer número de pares chave-valor, armazenando-os no dicionário da instância.
|
|
53
|
+
> - `get` O método get aceita uma chave como argumento e retorna o valor correspondente do dicionário _config.
|
|
54
|
+
> - `set` O método set permite adicionar ou atualizar dinamicamente valores no dicionário _config.
|
|
55
|
+
> - `reset` O método reset limpa todas as configurações armazenadas, permitindo uma nova inicialização do ConfigManager com novos valores
|
|
56
|
+
|
|
57
|
+
**ServicoWindows**
|
|
58
|
+
Gerencia a instalação e execução de um daemon como um serviço do windows. Também assum o controle dos argumentos recebidos via linha de comando.
|
|
59
|
+
> - `SvcInstall` Cria um serviço do windows com base neste script
|
|
60
|
+
> - `SvcRemove` Remove o serviço do windows configurado à partir de `SvcInstall`
|
|
61
|
+
> - `SvcStop` Para/Interrompe a execução do serviço do windows criado por este script (método herdado da classe pai _win32serviceutil.ServiceFramework_)
|
|
62
|
+
> - `SvcDoRun` Inicializa a execução do serviço do windows criado por este script (método herdado da classe pai _win32serviceutil.ServiceFramework_)
|
|
63
|
+
|
|
64
|
+
**Servicer**
|
|
65
|
+
Classe base com a esrtutura padrão para a criação dameons/serviços do windows.
|
|
66
|
+
> - `run`, `stop` Usados para iniciar (`run`) e parar (`stop`) a execução do daemon/serviço.
|
|
67
|
+
> - `main` deve ser chamada para controlar a sua chamada inicial do script, tratando os argumentos da linha de comando
|
|
68
|
+
> - `on_run` é o método que efetivamente executa o propósito do script quando o método pai `run` é executado
|
|
69
|
+
> - `args_parser` é o método que define o comportamento do script quando o método `main` é executado (**`argpaser`**)
|
|
38
70
|
|
|
39
71
|
**misc**
|
|
40
72
|
Classe de miscelâneas/diversos
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
73
|
+
> - `seleciona_arquivo` Abre um picker do sistema operacionar para selecionar um *arquivo* e retorna seu path
|
|
74
|
+
> - `seleciona_dir` Abre um picker do sistema operacionar para selecionar um *diretório* e retorna seu path
|
|
75
|
+
> - `normaliza` Limpa caracteres especiais e espaços de strings e retorna tudo em minúsculo
|
|
76
|
+
> - `get_cmd_window` Captura a referencia da janela atual (cmd.exe) para retornar o foco à ela depois de chamar os pickers
|
|
77
|
+
> - `maximize_console` Maxima a janela do console (cmd.exe)
|
|
46
78
|
|
|
47
79
|
## Instalação e uso:
|
|
48
80
|
|
|
49
81
|
### Instalação
|
|
50
|
-
|
|
51
|
-
```
|
|
82
|
+
```bash
|
|
52
83
|
pip install lbx_toolkit
|
|
53
84
|
```
|
|
54
85
|
|
|
55
86
|
### Uso
|
|
56
|
-
```
|
|
57
|
-
from lbx_toolkit import auth_EntraID, PostgreSQL, api_rest, lbx_logger
|
|
87
|
+
```python
|
|
88
|
+
from lbx_toolkit import auth_EntraID, PostgreSQL, api_rest, lbx_logger, SafeLogger, ServicoWindows, ConfigManager, Servicer
|
|
58
89
|
```
|
|
59
90
|
"""
|
|
60
91
|
import locale
|
|
61
|
-
from .lbx_logger import lbx_logger
|
|
92
|
+
from .lbx_logger import lbx_logger, SafeLogger
|
|
62
93
|
from .config_manager import ConfigManager
|
|
63
94
|
from .service_windows import ServicoWindows
|
|
64
95
|
from .service import Servicer
|
|
@@ -70,12 +101,13 @@ from .misc import misc
|
|
|
70
101
|
locale.setlocale(locale.LC_ALL, 'pt_BR.UTF-8')
|
|
71
102
|
|
|
72
103
|
__all__ = [
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
104
|
+
"lbx_logger",
|
|
105
|
+
"SafeLogger",
|
|
106
|
+
"ConfigManager",
|
|
107
|
+
"ServicoWindows",
|
|
108
|
+
"Servicer",
|
|
109
|
+
"auth_EntraID",
|
|
110
|
+
"postgreSQL",
|
|
111
|
+
"api_rest",
|
|
112
|
+
"misc"
|
|
81
113
|
]
|
lbxtoolkit/api_rest.py
CHANGED
|
@@ -13,20 +13,22 @@ class api_rest: # Classe para interação com APIs Rest (especialmente Sienge)
|
|
|
13
13
|
|
|
14
14
|
A classe deve ser instanciada conforme sintaxe abaixo:
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
```python
|
|
17
|
+
api_rest(url, credenciais, cadencia, timeout=6, logger=None, headers={"Content-Type": "application/json"}, verify=True)
|
|
18
|
+
```
|
|
17
19
|
|
|
18
20
|
São nessários 2 parâmetros posicionais obrigatórios, e 5 parametros nominais facultativos (valor padrão, se omisso, indicado na sintaxe acima):
|
|
19
|
-
- `url`: o endereço da URL de autenticação da API
|
|
20
|
-
- `crednciais`: Dicionário com credenciais de autenticação.
|
|
21
|
-
- `cadencia` Número máximo de chamadas *por segudo* à API
|
|
22
|
-
- `timeout` Tempo máximo (segundos) para aguardar retorno à chamada. Padrão 6s, se omisso.
|
|
23
|
-
- `logger` O objeto _log handler_ para lidar com as informações de saída. Se não informado, todas as saídas serão direcionadas para a stdout.
|
|
24
|
-
- `headers` Cabeçalhos _http_ para a requisição à API.
|
|
25
|
-
- `verify` Verifica a validade do certificado SSL do servidor de destino da requisição.
|
|
21
|
+
> - `url`: o endereço da URL de autenticação da API
|
|
22
|
+
> - `crednciais`: Dicionário com credenciais de autenticação.
|
|
23
|
+
> - `cadencia` Número máximo de chamadas *por segudo* à API
|
|
24
|
+
> - `timeout` Tempo máximo (segundos) para aguardar retorno à chamada. Padrão 6s, se omisso.
|
|
25
|
+
> - `logger` O objeto _log handler_ para lidar com as informações de saída. Se não informado, todas as saídas serão direcionadas para a stdout.
|
|
26
|
+
> - `headers` Cabeçalhos _http_ para a requisição à API.
|
|
27
|
+
> - `verify` Verifica a validade do certificado SSL do servidor de destino da requisição.
|
|
26
28
|
|
|
27
29
|
Quanto às credenciais de autenticação, assim como a classe de interação com o PostgreSQL, elas precisam ser fornecidas na forma de um *dicionário*.
|
|
28
30
|
Para o método `api_rest.aut_basic()`, o formato deve ser:
|
|
29
|
-
```
|
|
31
|
+
```python
|
|
30
32
|
credenciais = {
|
|
31
33
|
'user': 'USUARIO_API',
|
|
32
34
|
'password': 'TOKEN_USUARIO'
|
|
@@ -36,10 +38,10 @@ class api_rest: # Classe para interação com APIs Rest (especialmente Sienge)
|
|
|
36
38
|
|
|
37
39
|
|
|
38
40
|
A classe possui 3 métodos:
|
|
39
|
-
- `api_rest.auth_basic()`: instanciamento da sessão autenticando pelo método HTTPBasicAuth
|
|
40
|
-
- `api_rest.auth_bearer()`: instanciamento da sessão autenticando pelos métodos OAuth, JWT, Bearer
|
|
41
|
-
- `api_rest.endpoint_json([endereço], [método], payload=None)`: para a chamada ao endpoint
|
|
42
|
-
- `close()` para encerra a instância/sessão
|
|
41
|
+
> - `api_rest.auth_basic()`: instanciamento da sessão autenticando pelo método HTTPBasicAuth
|
|
42
|
+
> - `api_rest.auth_bearer()`: instanciamento da sessão autenticando pelos métodos OAuth, JWT, Bearer
|
|
43
|
+
> - `api_rest.endpoint_json([endereço], [método], payload=None)`: para a chamada ao endpoint
|
|
44
|
+
> - `close()` para encerra a instância/sessão
|
|
43
45
|
|
|
44
46
|
O consumo é feito pelo método `api_rest.endpoint_json` que suporta apenas APIs cujo payload (opcional) seja aceito no formato JSON.
|
|
45
47
|
|
|
@@ -52,7 +54,7 @@ class api_rest: # Classe para interação com APIs Rest (especialmente Sienge)
|
|
|
52
54
|
|
|
53
55
|
Exemplo de uso:
|
|
54
56
|
|
|
55
|
-
```
|
|
57
|
+
```python
|
|
56
58
|
from lbx_toolkit import api_rest
|
|
57
59
|
|
|
58
60
|
UrlBase=r'https://api.sienge.com.br/lbx/public/api/v1'
|
lbxtoolkit/auth_entra_id.py
CHANGED
|
@@ -20,23 +20,22 @@ class auth_EntraID: # Classe de autenticação de usuários no Microsoft Entra I
|
|
|
20
20
|
|
|
21
21
|
Essa classe possui apenas dois métodos:
|
|
22
22
|
|
|
23
|
-
- `auth_EntraID.disclaimer()`: apenas exibe uma tela de informações/instruções ao usuário.
|
|
24
|
-
|
|
25
|
-
- `auth_EntraID.valida_grupo([client_id], [client_secret], [tenant_id], timeout=60, log_file='auth_EntraID.log')`: efetua a autenticação do usuário e verifica se ele pertence ao grupo informado, abortando a execução caso não pertença ao grupo ou a autenticação não seja validada no tempo estabelecido. Os argumentos `timeout` e `log_file` são opcionais e, se omitidos, os valores aqui atribuídos serão adotados como padrão.
|
|
23
|
+
> - `auth_EntraID.disclaimer()`: apenas exibe uma tela de informações/instruções ao usuário.
|
|
24
|
+
> - `auth_EntraID.valida_grupo([client_id], [client_secret], [tenant_id], timeout=60, log_file='auth_EntraID.log')`: efetua a autenticação do usuário e verifica se ele pertence ao grupo informado, abortando a execução caso não pertença ao grupo ou a autenticação não seja validada no tempo estabelecido. Os argumentos `timeout` e `log_file` são opcionais e, se omitidos, os valores aqui atribuídos serão adotados como padrão.
|
|
26
25
|
|
|
27
26
|
É necessário obter parametros da plataforma de identidade da Microsoft (AD Azure, agora Microsoft Entra ID), no [*Centro de administração do Microsoft Entra*](https://entra.microsoft.com).
|
|
28
27
|
Sugerimos não armazenar estas ou outras informações sensíveis no script. Considere usar o pacote `dotenv` para isso.
|
|
29
28
|
|
|
30
29
|
Os argumentos obrigatórios (posicionais) são:
|
|
31
30
|
|
|
32
|
-
1
|
|
31
|
+
1. `tenant_id` corresponde ao campo *ID do Locatário*, que pode ser obtido na página [visão geral de identidade do domínio](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/TenantOverview.ReactView)
|
|
33
32
|
|
|
34
|
-
2
|
|
33
|
+
2. `client_id` corresponde ao *ID do aplicativo (cliente)*, obtido na secção [_Identidade > Aplicativos > Registros de Aplicativo_](https://entra.microsoft.com/#view/Microsoft_AAD_RegisteredApps/ApplicationsListBlade/quickStartType~/null/sourceType/Microsoft_AAD_IAM). Considere não reaproveitar aplicativos e criar um específico para essa finalidade.
|
|
35
34
|
|
|
36
|
-
3
|
|
35
|
+
3. `secret_id` corresponde ao *Valor* do _ID secreto_ (não ao próprio ID Secreto) do aplicativo. Este token não é passivel de consulta após gerado e para obtê-lo, é necessário criar um novo segredo para o aplicativo na subsecção _"Certificados e Segredos"_, após clicar no nome do aplicativo exibo na indicada no item (2). O token (_Valor do segredo_) deve ser copiado e anotado no ato da criação, pois *não é possível consultá-lo posteriormente*.
|
|
37
36
|
|
|
38
37
|
|
|
39
|
-
```
|
|
38
|
+
```python
|
|
40
39
|
from lbx_toolkit import auth_EntraID
|
|
41
40
|
|
|
42
41
|
client_id = 'SEU_CLIENT_ID'
|
lbxtoolkit/config_manager.py
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
class ConfigManager: # Inicializa e recupera variáveis em ambiente de intercâmbio entre classes
|
|
2
2
|
"""
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
3
|
+
#### Classe **auth_EntraID**
|
|
4
|
+
|
|
5
|
+
É um singleton que garante que todas as partes do código usem a mesma instância e, portanto, compartilhem a mesma configuração.
|
|
6
|
+
|
|
7
|
+
> - `initialize(chave1=valor1, ..., chaveN=valorN)` : O método initialize usa **kwargs para aceitar qualquer número de pares chave-valor, armazenando-os no dicionário _config da instância.
|
|
8
|
+
> - `get('chave')`: O método get aceita uma chave como argumento e retorna o valor correspondente do dicionário _config.
|
|
9
|
+
> - `set('chave', valor)`: O método set permite adicionar ou atualizar dinamicamente valores no dicionário _config.
|
|
10
|
+
> - `reset`: O método reset limpa todas as configurações armazenadas, permitindo uma nova inicialização do ConfigManager com novos valores
|
|
9
11
|
"""
|
|
10
12
|
_instance = None
|
|
11
13
|
def __new__(cls):
|
lbxtoolkit/lbx_logger.py
CHANGED
|
@@ -9,37 +9,39 @@ class lbx_logger: # Classe para gerenciar a saída para log
|
|
|
9
9
|
r"""
|
|
10
10
|
#### Classe **lbx_logger**
|
|
11
11
|
|
|
12
|
-
Essa classe requer a importação do módulo `logging`
|
|
12
|
+
Essa classe requer a importação do módulo `logging` e tem o propósito de manipular/formatar as mensagens de saída, alterando o formato e redirecionando destino padrão (stdout e stderr) para uma combinação de tela e/ou arquivo.
|
|
13
13
|
|
|
14
|
-
O comportamento padrão é registrar todas as saídas
|
|
14
|
+
O comportamento padrão é registrar todas as saídas **simultaneamente** em tela e no arquivo com endereço informado no parâmetro `log_file_path`. Se este parametro for omisso no instanciamento da classe, as mensagens serão exibidas apenas na tela.
|
|
15
15
|
|
|
16
16
|
A mensagens devem ser classificadas por grau de severidade/relevância, da menor para a maior, na seguinte ordem: *debug, info, warning (aviso), error (erro), critical (critico)*
|
|
17
17
|
|
|
18
|
-
A classificação do nível de serveridade da mensagem se dá pelo método escolhido para
|
|
18
|
+
A classificação do nível de serveridade da mensagem se dá pelo método escolhido para exibir a mensagem, correspondente aos níveis de severidade equivalentes.
|
|
19
19
|
|
|
20
20
|
A classe deve ser instanciada conforme sintaxe abaixo:
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
```python
|
|
23
|
+
log = lbx_logger(log_file_path=None, log_level=logging.DEBUG, formato_log='%(asctime)s - %(levelname)s - %(message)s', modulo=None, ignore_console=None, ignore_file=None)
|
|
24
|
+
```
|
|
23
25
|
|
|
24
26
|
Todos os parametros são nominativos e facultativos. Em caso de omissão, os valores padrão são assumidos conforme o exemplo acima.
|
|
25
27
|
|
|
26
28
|
Os parametros para o instanciamento da classe são:
|
|
27
29
|
|
|
28
|
-
- `log_file_path
|
|
29
|
-
- `log_level
|
|
30
|
-
- `logging.DEBUG
|
|
31
|
-
- `logging.INFO
|
|
32
|
-
- `logging.WARNING
|
|
33
|
-
- `logging.ERROR
|
|
34
|
-
- `logging.CRITICAL
|
|
35
|
-
- `formato_log
|
|
36
|
-
- `modulo
|
|
37
|
-
- `ignore_console
|
|
38
|
-
- `ignore_file
|
|
39
|
-
|
|
40
|
-
1
|
|
41
|
-
|
|
42
|
-
```
|
|
30
|
+
> - `log_file_path`: Define o caminho e o nome do arquivo de log. Se omisso, as mensagens serão todas direcionadas apenas para a tela.
|
|
31
|
+
> - `log_level`: Define o nível mínimo de severidade das mensagens a serem manipuladas pelo logger. Se omisso, será assumido o nível mais baixo (_debug_). As mensagens com nível abaixo do especificado são descartadas. Os níveis devem ser informados de acordo com a sintaxe acima (prefixados com _logging._ e com o nome do nível em inglês e maiúsculas). Exemplo:
|
|
32
|
+
> - `logging.DEBUG`: para manipular chamadas do método *.debug()* e acima.
|
|
33
|
+
> - `logging.INFO`: para manipular chamadas do método *.info()* e acima.
|
|
34
|
+
> - `logging.WARNING`: para manipular chamadas do método *.aviso()* e acima.
|
|
35
|
+
> - `logging.ERROR`: para manipular chamadas do método *.erro()* e acima.
|
|
36
|
+
> - `logging.CRITICAL`: para manipular chamadas do método *.critico()* e acima.
|
|
37
|
+
> - `formato_log`: Define o formato em que a mensagem será apresentada. Se omisso, o padrá é *DATA_HORA - NIVEL - MENSAGEM*. Para maiores opções veja: [Atributos de log](https://docs.python.org/3/library/logging.html#logrecord-attributes)
|
|
38
|
+
> - `modulo`: Nome do módulo para o qual os logs serão monitorados. Permite instanciar várias vezes a classe para criar manipuladores diferentes para módulos diferente. Informe o nome do módulo para criar um log específico para ele ou simplesmente omita o parametro para criar um log para o script em geral.
|
|
39
|
+
> - `ignore_console`: Lista com os níveis de severidade a serem ignorados para *apresentação na tela*, registrando *apenas no arquivo* (quando informado no parametro `log_file_path`) e obedecendo ao nível mínimo estabelecido no parametro `log_level`. Note que omitir o parametro `log_file_path` e incluir um nível na lsita `ignore_console` implica em ignorar/suprimir esse nível de mensagem de qualquer apresentação.
|
|
40
|
+
> - `ignore_file`: Mesma lógica do parametro `ignore_console`, mas com lógica invertida: suprime o registro do nível do arquivo e demonstra *apenas na tela*.
|
|
41
|
+
|
|
42
|
+
1. As mensagem são manipuladas substituindo-se o comando `print()` pela chamada a um dos 5 métodos acima (_.add(), .debug(), .info(), .aviso(), .erro(), .critico()_). Exceto o método `.add()`, qualquer um dos demais métodos pode interromper a execução do script, através da passagem do parâmetro `exit`. Ao informar esse parametro na chamadada do método, atribua a ele o código de saída desejado (0 para normal, qualquer outro número para saída com erro). Exemplo:
|
|
43
|
+
|
|
44
|
+
```python
|
|
43
45
|
log.erro('Essa mensagem apenas resulta em uma mensagem de nível ERROR')
|
|
44
46
|
log.erro('Essa mensagem resulta em uma mensagem de nível ERRO e encerra o script com código de retorno -1', exit=-1)
|
|
45
47
|
```
|
|
@@ -47,21 +49,21 @@ class lbx_logger: # Classe para gerenciar a saída para log
|
|
|
47
49
|
Qualquer chamada ao comando `print()`, uma vez instanciado manipulador de log, será registada como uma chamada ao método _.info()_ e registrada com este nível de severidade.
|
|
48
50
|
Para retornar ao comportamente padrão do comando print, ou interromper o manipulador, faça chamada ao método `.stop_logging()`
|
|
49
51
|
|
|
50
|
-
2
|
|
52
|
+
2. O método _.add()_ não exibe/grava imediatamente a mensagem, mas apenas a diciona a _buffer_. Todas as chamas a _.add()_ irão concatenar a mensagem recebida até a próxima chamada em algum dos níveis _.debug(), .info(), .aviso(), .erro(), .critico()_. Na primeira chama de um destes níveis após uma (ou mais) chamada(s) ao método _.add()_ o *buffer* será concatenado à mensagem recebida por um destes métodos e o resultado será manipulado pelo log conforme os parametros definidos no intanciamento da classe e o método chamado. Essa função é útil para tratar mensagens com retorno condicional. Exemplo:
|
|
51
53
|
|
|
52
|
-
```
|
|
54
|
+
```python
|
|
53
55
|
log.add('Mensagem 1# ') ## não será exibida/registrada
|
|
54
56
|
log.add('Mensagem 2# ') ## não será exibida/registrada
|
|
55
57
|
log.info('Mensagem 3) ## será exibida/registrada como nível "info" e com texto: "Mensagem 1# Mensagem 2# Mensagem 3"
|
|
56
58
|
```
|
|
57
59
|
|
|
58
|
-
3
|
|
60
|
+
3. Os métodos que exibem as mensagens (`.debug()`,`.info()`,`.aviso()`, `.erro()`, `.critico()`) possuem 3 parametros: `message`, `corte=None`, `exit=None`.
|
|
59
61
|
|
|
60
|
-
- `message`: posicional e obrigatório. corresponde à mensagem a ser exibida
|
|
61
|
-
- `corte`: o tamanho máximo da mensagem a ser exibida. opcional e se omitido, exibe a mensagem inteira. se fornecido, corta a mensagem no comprimento informado
|
|
62
|
-
- `exit`: opcional. se informado (requer um código de retorno), aborta o script com o código informado. se omisso (padrão) a mensagem apenas é minutada pelo log, sem interferir no funcionamento do script
|
|
62
|
+
> - `message`: posicional e obrigatório. corresponde à mensagem a ser exibida
|
|
63
|
+
> - `corte`: o tamanho máximo da mensagem a ser exibida. opcional e se omitido, exibe a mensagem inteira. se fornecido, corta a mensagem no comprimento informado
|
|
64
|
+
> - `exit`: opcional. se informado (requer um código de retorno), aborta o script com o código informado. se omisso (padrão) a mensagem apenas é minutada pelo log, sem interferir no funcionamento do script
|
|
63
65
|
|
|
64
|
-
4
|
|
66
|
+
4. O método `.filtra()` possui 3 parametros posicionais, todos opcionais: `log_file`, `dh_ini`, `dh_fim`.
|
|
65
67
|
|
|
66
68
|
Se os 3 forem omitidos, serão exibidas as entradas de log do arquivo corrente, definido no instanciamento da classe `lbx_logger`, registradas na última hora. Deste modo, o valor padrão para `dh_fim` é `now()` e para `dh_ini` é `now()` menos 1 hora.
|
|
67
69
|
|
|
@@ -74,9 +76,9 @@ class lbx_logger: # Classe para gerenciar a saída para log
|
|
|
74
76
|
A saída dessa função retorna um objeto, que pode ser salvo em disco ou impresso na tela.
|
|
75
77
|
|
|
76
78
|
|
|
77
|
-
5
|
|
79
|
+
5. Exemplos de uso:
|
|
78
80
|
|
|
79
|
-
```
|
|
81
|
+
```python
|
|
80
82
|
from lbx_toolkit import lbx_logger
|
|
81
83
|
import logging
|
|
82
84
|
import os
|
|
@@ -369,3 +371,42 @@ class lbx_logger: # Classe para gerenciar a saída para log
|
|
|
369
371
|
return filtered_lines
|
|
370
372
|
#
|
|
371
373
|
#
|
|
374
|
+
class SafeLogger: ## intercepta as entradas de log para parar o daemon/watcher quando parametro EXIT existir
|
|
375
|
+
"""
|
|
376
|
+
Essa classe tem o propoósito de interceptar as ordens de saída (exit) disparadas pelos métodos do lbx_logger e interromper um daemon/serviço que esteja em execução antes.
|
|
377
|
+
Para isso, a classe precisa ser instancianda recebendo como parametros o objeto de log handler do script e o daemon do serviço a ser interrompido
|
|
378
|
+
O daemon, por sua vez, precisa obrigatoriamente possui um método `stop`
|
|
379
|
+
"""
|
|
380
|
+
def __init__(self, logger, daemon):
|
|
381
|
+
self.log = logger # recebe o objeto do log
|
|
382
|
+
self.daemon = daemon # recebe o objeto do watchdog (daemon)
|
|
383
|
+
#self.Args = args # recebe os argumentos da linha de comando (para saber se está rodando como daemon ou interativo)
|
|
384
|
+
#
|
|
385
|
+
#
|
|
386
|
+
def __getattr__(self, name):
|
|
387
|
+
# Este método é chamado quando um método inexistente é chamado na classe
|
|
388
|
+
# Ele repassa a chamada para o logger original, aplicando a lógica de exit
|
|
389
|
+
original_attr = getattr(self.log, name)
|
|
390
|
+
|
|
391
|
+
if callable(original_attr):
|
|
392
|
+
def wrapper(*args, **kwargs):
|
|
393
|
+
#if 'exit' in kwargs and (Args.d or not (Args.d or Args.f)): #não tentar para o daemon se execucção interativa
|
|
394
|
+
if 'exit' in kwargs and self.daemon: #não tentar para o daemon se execucção interativa
|
|
395
|
+
evento = 'CRASH' if kwargs['exit'] != 0 else 'STOP'
|
|
396
|
+
msg1 = 'um erro ocorreu. Interceptando log para interromper daemon/watcher...' if kwargs['exit'] != 0 else \
|
|
397
|
+
'Interrompendo daemon/watcher...'
|
|
398
|
+
msg2 = 'daemon/watcher interrompido... exibindo o erro interceptado: ' if kwargs['exit'] != 0 else \
|
|
399
|
+
'daemon/watcher interrompido!'
|
|
400
|
+
self.log.aviso(msg1)
|
|
401
|
+
self.daemon.stop(evento)
|
|
402
|
+
self.log.aviso(msg2)
|
|
403
|
+
result = original_attr(*args, **kwargs)
|
|
404
|
+
# if 'exit' in kwargs :
|
|
405
|
+
# log.aviso('Saindo...')
|
|
406
|
+
# os._exit(kwargs['exit'])
|
|
407
|
+
return result
|
|
408
|
+
return wrapper
|
|
409
|
+
else:
|
|
410
|
+
return original_attr
|
|
411
|
+
#
|
|
412
|
+
#
|
lbxtoolkit/misc.py
CHANGED
|
@@ -13,13 +13,13 @@ class misc: # Classe de miscelâneas
|
|
|
13
13
|
|
|
14
14
|
Classe que reune pequenas funções uteis para agilizar tarefas comuns.
|
|
15
15
|
|
|
16
|
-
Sintaxe e exemplos de uso. Parametros omissos assume
|
|
16
|
+
Sintaxe e exemplos de uso. Parametros omissos assume-se os valores padrão indicados abaixo:
|
|
17
17
|
|
|
18
|
-
- `Arquivo = seleciona_arquivo(DirBase, TiposArquivo=[('Todos os arquivos', '*.*')], Titulo='Selecionar arquivo')`
|
|
19
|
-
- `Diretório = seleciona_dir(DirBase=Path(r'./'), Titulo='Selecionar diretório'):`
|
|
20
|
-
- `NomeLimpo = normaliza('String # SEM Noção!') #>>> string_sem_nocao`
|
|
21
|
-
- `cmd_window = get_cmd_window()`
|
|
22
|
-
- `maximize_console()`
|
|
18
|
+
> - `Arquivo = seleciona_arquivo(DirBase, TiposArquivo=[('Todos os arquivos', '*.*')], Titulo='Selecionar arquivo')`
|
|
19
|
+
> - `Diretório = seleciona_dir(DirBase=Path(r'./'), Titulo='Selecionar diretório'):`
|
|
20
|
+
> - `NomeLimpo = normaliza('String # SEM Noção!') #>>> string_sem_nocao`
|
|
21
|
+
> - `cmd_window = get_cmd_window()`
|
|
22
|
+
> - `maximize_console()`
|
|
23
23
|
"""
|
|
24
24
|
def __init__(self):
|
|
25
25
|
pass
|
lbxtoolkit/postgresql.py
CHANGED
|
@@ -11,9 +11,9 @@ class postgreSQL: # Classe de acesso e interação com banco PostgreSQL
|
|
|
11
11
|
|
|
12
12
|
Recursos de interação com o banco de dados relacional PostgreSQL
|
|
13
13
|
|
|
14
|
-
1
|
|
14
|
+
1. O método `postgreSQl.db()` exige que as credenciais e parametros de acesso sejam fornecidas em um *dicionário* com, ao mínimo, o seguinte formato:
|
|
15
15
|
|
|
16
|
-
```
|
|
16
|
+
```python
|
|
17
17
|
credenciais = {
|
|
18
18
|
'dbname': 'NOME_BANCO',
|
|
19
19
|
'user': 'USUARIO'',
|
|
@@ -29,15 +29,15 @@ class postgreSQL: # Classe de acesso e interação com banco PostgreSQL
|
|
|
29
29
|
|
|
30
30
|
Qualquer argumento de conexão previsto no pacote *psycopg2* são aceitos como entrada no dicionário acima.
|
|
31
31
|
|
|
32
|
-
2
|
|
32
|
+
2. O método `postgreSQl.csv_df()` lê arquivo texto do tipo CSV e o converte para o objeto Dataframe do `pandas`. A assinatura da função exige que se forneça o caminho do arquivo CSV e, opcionalmente o caracter delimitador. Se o caracter demilitador não for informado, será assumido `;`. Considere usar a função `Path` para tratar o caminho do arquivo de origem.
|
|
33
33
|
|
|
34
|
-
```
|
|
34
|
+
```python
|
|
35
35
|
from pathlib import Path
|
|
36
36
|
arquivo_csv = Path('./diretorio/arquivo_exemplo.csv')
|
|
37
37
|
dados = postgreSQL.csv_df(arquivo_csv, CsvDelim=',') # usando vírgula como separador. se omisso, assume ";'
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
1. O método `postgreSQl.db_insert_df()` insere dados a partir de um Dataframe (pandas) em uma tabela do banco com estrutura de colunas equivalente.
|
|
41
41
|
|
|
42
42
|
A assinatura da função é `postgreSQL.db_insert_df([conexao], [dataframe_origem], [tabela_destino], Schema=None, Colunas=None, OnConflict=None)`
|
|
43
43
|
|
|
@@ -55,7 +55,7 @@ class postgreSQL: # Classe de acesso e interação com banco PostgreSQL
|
|
|
55
55
|
|
|
56
56
|
Exemplo de uso:
|
|
57
57
|
|
|
58
|
-
```
|
|
58
|
+
```python
|
|
59
59
|
from lbx_toolkit import postgreSQL
|
|
60
60
|
from pathlib import Path
|
|
61
61
|
|
|
@@ -78,7 +78,7 @@ class postgreSQL: # Classe de acesso e interação com banco PostgreSQL
|
|
|
78
78
|
conexao.close()
|
|
79
79
|
```
|
|
80
80
|
|
|
81
|
-
4
|
|
81
|
+
4. O método `postgreSQl.db_select()` executa consultas no banco de dados e retorna um `cursor` com o resultado.
|
|
82
82
|
|
|
83
83
|
A assinatura da função é `postgreSQL.db_select([conexao], [query])`
|
|
84
84
|
|
|
@@ -90,7 +90,7 @@ class postgreSQL: # Classe de acesso e interação com banco PostgreSQL
|
|
|
90
90
|
|
|
91
91
|
Exemplo de uso:
|
|
92
92
|
|
|
93
|
-
```
|
|
93
|
+
```python
|
|
94
94
|
from lbx_toolkit import postgreSQL
|
|
95
95
|
from pathlib import Path
|
|
96
96
|
|
|
@@ -110,7 +110,7 @@ class postgreSQL: # Classe de acesso e interação com banco PostgreSQL
|
|
|
110
110
|
conexao.close()
|
|
111
111
|
```
|
|
112
112
|
|
|
113
|
-
5
|
|
113
|
+
5. O método `postgreSQl.db_update()` executa updates no banco
|
|
114
114
|
|
|
115
115
|
A assinatura da função é `postgreSQL.db_update([conexao], [query])`
|
|
116
116
|
|
|
@@ -120,7 +120,7 @@ class postgreSQL: # Classe de acesso e interação com banco PostgreSQL
|
|
|
120
120
|
|
|
121
121
|
Exemplo de uso:
|
|
122
122
|
|
|
123
|
-
|
|
123
|
+
```´python
|
|
124
124
|
from lbx_toolkit import postgreSQL
|
|
125
125
|
from pathlib import Path
|
|
126
126
|
|