lbxtoolkit 2.0.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
ADDED
|
@@ -0,0 +1,664 @@
|
|
|
1
|
+
import os
|
|
2
|
+
import sys
|
|
3
|
+
import locale
|
|
4
|
+
import time
|
|
5
|
+
import threading
|
|
6
|
+
import logging
|
|
7
|
+
import msal
|
|
8
|
+
import requests
|
|
9
|
+
from requests.auth import HTTPBasicAuth
|
|
10
|
+
from selenium import webdriver
|
|
11
|
+
from selenium.webdriver.chrome.service import Service
|
|
12
|
+
from selenium.webdriver.chrome.options import Options
|
|
13
|
+
from webdriver_manager.chrome import ChromeDriverManager
|
|
14
|
+
import psycopg2
|
|
15
|
+
from psycopg2.extras import execute_values
|
|
16
|
+
import pandas as pd
|
|
17
|
+
import numpy as np
|
|
18
|
+
from http.server import BaseHTTPRequestHandler, HTTPServer
|
|
19
|
+
import urllib.parse as urlparse
|
|
20
|
+
import validators
|
|
21
|
+
|
|
22
|
+
locale.setlocale(locale.LC_ALL, 'pt_BR.UTF-8')
|
|
23
|
+
|
|
24
|
+
class auth_EntraID: # Classe de autenticação de usuários no Microsoft Entra ID (antiga Azure AD)
|
|
25
|
+
def __init__(self, client_id, client_secret, tenant_id, grupo, timeout=60, log_file='auth_EntraID.log'):
|
|
26
|
+
self.client_id = client_id
|
|
27
|
+
self.client_secret = client_secret
|
|
28
|
+
self.tenant_id = tenant_id
|
|
29
|
+
self.timeout = timeout
|
|
30
|
+
self.grupo = grupo
|
|
31
|
+
self.authority = f"https://login.microsoftonline.com/{self.tenant_id}"
|
|
32
|
+
self.scope = ["https://graph.microsoft.com/.default"]
|
|
33
|
+
self.redirect_uri = "http://localhost:8000"
|
|
34
|
+
self.response = ""
|
|
35
|
+
self.status_code = 0
|
|
36
|
+
self.server = None
|
|
37
|
+
self.log_file = log_file
|
|
38
|
+
|
|
39
|
+
# Configura o logger
|
|
40
|
+
logging.basicConfig(filename=log_file, level=logging.INFO,
|
|
41
|
+
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
|
|
42
|
+
self.logger = logging.getLogger(__name__)
|
|
43
|
+
|
|
44
|
+
def valida_grupo(self): # Valida se o usuário autenticado pertence a grupo de segurança informado
|
|
45
|
+
# Redireciona stdout e stderr para arquivos de log
|
|
46
|
+
original_stdout = sys.stdout
|
|
47
|
+
original_stderr = sys.stderr
|
|
48
|
+
sys.stdout = open('stdout.log', 'a')
|
|
49
|
+
sys.stderr = open('stderr.log', 'a')
|
|
50
|
+
|
|
51
|
+
# Configurações do Selenium
|
|
52
|
+
chrome_options = Options()
|
|
53
|
+
chrome_options.add_argument("--incognito")
|
|
54
|
+
|
|
55
|
+
# Inicializa a aplicação MSAL
|
|
56
|
+
try:
|
|
57
|
+
app = msal.ConfidentialClientApplication(
|
|
58
|
+
self.client_id,
|
|
59
|
+
authority=self.authority,
|
|
60
|
+
client_credential=self.client_secret,
|
|
61
|
+
)
|
|
62
|
+
except BaseException as err:
|
|
63
|
+
print(f'Falha ao iniciar aplicação MSAL: {err}')
|
|
64
|
+
# Restaura saída padrão
|
|
65
|
+
sys.stdout.close()
|
|
66
|
+
sys.stderr.close()
|
|
67
|
+
sys.stdout = original_stdout
|
|
68
|
+
sys.stderr = original_stderr
|
|
69
|
+
print(f'Script abortado por falha aplicação MSAL. Verifque logs: {self.log_file}, stdout.log e sterr.log')
|
|
70
|
+
os._exit(0)
|
|
71
|
+
|
|
72
|
+
# Inicia o fluxo de código de autorização
|
|
73
|
+
try:
|
|
74
|
+
flow = app.initiate_auth_code_flow(scopes=self.scope, redirect_uri=self.redirect_uri)
|
|
75
|
+
auth_url = flow["auth_uri"]
|
|
76
|
+
self.response = f"Acessando a URL de autenticação Microsoft Entra ID (antiga Azure AD): {auth_url}"
|
|
77
|
+
self.logger.info(self.response)
|
|
78
|
+
except BaseException as err:
|
|
79
|
+
print(f'Falha no fluxo de autorização Microsoft Entra ID (antiga Azure AD): {err}')
|
|
80
|
+
# Restaura saída padrão
|
|
81
|
+
sys.stdout.close()
|
|
82
|
+
sys.stderr.close()
|
|
83
|
+
sys.stdout = original_stdout
|
|
84
|
+
sys.stderr = original_stderr
|
|
85
|
+
print(f'Script abortado por falha no fluxo de autorização Microsoft Entra ID (antiga Azure AD). Verifque logs: {self.log_file}, stdout.log e sterr.log')
|
|
86
|
+
os._exit(0)
|
|
87
|
+
|
|
88
|
+
# Inicializa o ChromeDriver com redirecionamento de saída
|
|
89
|
+
try:
|
|
90
|
+
service = Service(ChromeDriverManager().install())
|
|
91
|
+
service.start()
|
|
92
|
+
driver = webdriver.Chrome(service=service, options=chrome_options)
|
|
93
|
+
driver.get(auth_url)
|
|
94
|
+
except BaseException as err:
|
|
95
|
+
print(f'Falha na inicialização do Chrome: {err}')
|
|
96
|
+
# Restaura saída padrão
|
|
97
|
+
sys.stdout.close()
|
|
98
|
+
sys.stderr.close()
|
|
99
|
+
sys.stdout = original_stdout
|
|
100
|
+
sys.stderr = original_stderr
|
|
101
|
+
print(f'Script abortado na inicialização do Chrome. Verifque logs: {self.log_file}, stdout.log e sterr.log')
|
|
102
|
+
os._exit(0)
|
|
103
|
+
|
|
104
|
+
class AuthHandler(BaseHTTPRequestHandler):
|
|
105
|
+
def log_message(self, format, *args):
|
|
106
|
+
self.server.logger.info("%s - - [%s] %s\n" %
|
|
107
|
+
(self.client_address[0],
|
|
108
|
+
self.log_date_time_string(),
|
|
109
|
+
format % args))
|
|
110
|
+
|
|
111
|
+
def do_GET(self):
|
|
112
|
+
parsed_path = urlparse.urlparse(self.path)
|
|
113
|
+
query_params = urlparse.parse_qs(parsed_path.query)
|
|
114
|
+
self.send_response(200)
|
|
115
|
+
self.send_header('Content-type', 'text/html')
|
|
116
|
+
self.end_headers()
|
|
117
|
+
|
|
118
|
+
# Captura o código de autorização e o estado
|
|
119
|
+
if 'code' in query_params and 'state' in query_params:
|
|
120
|
+
self.server.auth_code = query_params['code'][0]
|
|
121
|
+
self.server.state = query_params['state'][0]
|
|
122
|
+
self.wfile.write(b'''
|
|
123
|
+
<!DOCTYPE html>
|
|
124
|
+
<html lang="pt_BR">
|
|
125
|
+
<head>
|
|
126
|
+
<meta charset="UTF-8">
|
|
127
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
128
|
+
<style>
|
|
129
|
+
body {
|
|
130
|
+
font-family: 'Arial', sans-serif;
|
|
131
|
+
background-color: #f8f9fa;
|
|
132
|
+
margin: 0;
|
|
133
|
+
font-size: 16px;
|
|
134
|
+
padding: 30px;
|
|
135
|
+
display: flex; *
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
.container {
|
|
139
|
+
width: 100%;
|
|
140
|
+
margin: auto;
|
|
141
|
+
background-color: #ffffff;
|
|
142
|
+
box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
|
|
143
|
+
padding: 16px;
|
|
144
|
+
text-align: center;
|
|
145
|
+
font-size: 16px;
|
|
146
|
+
border-radius: 8px;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
h1 {
|
|
150
|
+
font-size: 18px;
|
|
151
|
+
text-align: center;
|
|
152
|
+
color: #007bff;
|
|
153
|
+
}
|
|
154
|
+
</style>
|
|
155
|
+
</head>
|
|
156
|
+
<div class="container">
|
|
157
|
+
<h1>Autenticação realizada com sucesso!</h1>
|
|
158
|
+
Aguarde que esta página será fechada automaticamente.<br>
|
|
159
|
+
Se isto não acontecer, pode fechá-la manualmente.
|
|
160
|
+
</div>
|
|
161
|
+
</body></html>
|
|
162
|
+
''')
|
|
163
|
+
else:
|
|
164
|
+
self.wfile.write(b'''
|
|
165
|
+
<!DOCTYPE html>
|
|
166
|
+
<html lang="pt_BR">
|
|
167
|
+
<head>
|
|
168
|
+
<meta charset="UTF-8">
|
|
169
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
170
|
+
<style>
|
|
171
|
+
body {
|
|
172
|
+
font-family: 'Arial', sans-serif;
|
|
173
|
+
background-color: #f8f9fa;
|
|
174
|
+
margin: 0;
|
|
175
|
+
font-size: 16px;
|
|
176
|
+
padding: 30px;
|
|
177
|
+
display: flex; *
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
.container {
|
|
181
|
+
width: 100%;
|
|
182
|
+
margin: auto;
|
|
183
|
+
background-color: #ffffff;
|
|
184
|
+
box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
|
|
185
|
+
padding: 16px;
|
|
186
|
+
text-align: center;
|
|
187
|
+
font-size: 16px;
|
|
188
|
+
border-radius: 8px;
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
h1 {
|
|
192
|
+
font-size: 18px;
|
|
193
|
+
text-align: center;
|
|
194
|
+
color: red;
|
|
195
|
+
}
|
|
196
|
+
</style>
|
|
197
|
+
</head>
|
|
198
|
+
<div class="container">
|
|
199
|
+
<h1>Falha na autenticação!</h1>
|
|
200
|
+
Esta página será fechada automaticamente.<br>
|
|
201
|
+
Se isto não acontecer, pode fechá-la manualmente.
|
|
202
|
+
</div>
|
|
203
|
+
</body></html>
|
|
204
|
+
''')
|
|
205
|
+
|
|
206
|
+
# Inicializa o servidor HTTP
|
|
207
|
+
self.server = HTTPServer(('localhost', 8000), AuthHandler)
|
|
208
|
+
self.server.logger = self.logger # Passa o logger para o servidor
|
|
209
|
+
|
|
210
|
+
# Função para monitorar o tempo limite
|
|
211
|
+
def monitor_timeout():
|
|
212
|
+
time.sleep(self.timeout)
|
|
213
|
+
if not hasattr(self.server, 'auth_code'):
|
|
214
|
+
self.response = "tempo limite para autenticação foi excedido"
|
|
215
|
+
self.status_code = 490
|
|
216
|
+
self.logger.error(self.response)
|
|
217
|
+
sys.stdout.close()
|
|
218
|
+
sys.stderr.close()
|
|
219
|
+
sys.stdout = original_stdout
|
|
220
|
+
sys.stderr = original_stderr
|
|
221
|
+
print(f'Código retorno: {self.status_code} ', end='') ## self.status_code = 200, usuário pertence ao grupo informado. self.status_code = 299, grupo existe mas usuário NÃO pertence à ele. Erros retornam 4xx.
|
|
222
|
+
print(f'Resposta: {self.response}', end='\n\n')
|
|
223
|
+
print('Falha na autenticação! Execução abortada!')
|
|
224
|
+
driver.quit()
|
|
225
|
+
self.server.server_close()
|
|
226
|
+
os._exit(0)
|
|
227
|
+
|
|
228
|
+
# Inicia a thread para monitorar o tempo limite
|
|
229
|
+
timeout_thread = threading.Thread(target=monitor_timeout)
|
|
230
|
+
timeout_thread.start()
|
|
231
|
+
|
|
232
|
+
# Espera pelo código de autorização
|
|
233
|
+
self.response = "Esperando pela autenticação..."
|
|
234
|
+
self.logger.info(self.response)
|
|
235
|
+
self.server.handle_request()
|
|
236
|
+
|
|
237
|
+
# Restaura stdout e stderr
|
|
238
|
+
sys.stdout.close()
|
|
239
|
+
sys.stderr.close()
|
|
240
|
+
sys.stdout = original_stdout
|
|
241
|
+
sys.stderr = original_stderr
|
|
242
|
+
|
|
243
|
+
# Verifica se o código de autorização foi obtido dentro do tempo limite
|
|
244
|
+
if not hasattr(self.server, 'auth_code'):
|
|
245
|
+
return
|
|
246
|
+
|
|
247
|
+
# Obtém o código de autorização e o estado capturados pelo servidor HTTP
|
|
248
|
+
auth_code = self.server.auth_code
|
|
249
|
+
state = self.server.state
|
|
250
|
+
|
|
251
|
+
# Adquire o token usando o código de autorização, verificando o estado
|
|
252
|
+
try:
|
|
253
|
+
result = app.acquire_token_by_auth_code_flow(flow, {"code": auth_code, "state": state})
|
|
254
|
+
except ValueError as e:
|
|
255
|
+
self.response = f"Erro ao obter o token de acesso: {e}"
|
|
256
|
+
self.status_code = 401
|
|
257
|
+
self.logger.error(self.response)
|
|
258
|
+
driver.quit()
|
|
259
|
+
return
|
|
260
|
+
|
|
261
|
+
if "access_token" in result:
|
|
262
|
+
access_token = result['access_token']
|
|
263
|
+
headers = {
|
|
264
|
+
'Authorization': 'Bearer ' + access_token
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
# Obtém o email do usuário autenticado
|
|
268
|
+
me_response = requests.get(
|
|
269
|
+
'https://graph.microsoft.com/v1.0/me',
|
|
270
|
+
headers=headers
|
|
271
|
+
)
|
|
272
|
+
self.status_code = me_response.status_code
|
|
273
|
+
if me_response.status_code == 200:
|
|
274
|
+
me_data = me_response.json()
|
|
275
|
+
user_email = me_data['userPrincipalName']
|
|
276
|
+
self.response = f"Email do usuário autenticado: {user_email}"
|
|
277
|
+
self.logger.info(self.response)
|
|
278
|
+
|
|
279
|
+
# Verifica se o usuário pertence ao grupo
|
|
280
|
+
group_name = self.grupo
|
|
281
|
+
|
|
282
|
+
# Obtém o ID do usuário
|
|
283
|
+
user_response = requests.get(
|
|
284
|
+
f'https://graph.microsoft.com/v1.0/users/{user_email}',
|
|
285
|
+
headers=headers
|
|
286
|
+
)
|
|
287
|
+
self.status_code = user_response.status_code
|
|
288
|
+
if user_response.status_code == 200:
|
|
289
|
+
user_data = user_response.json()
|
|
290
|
+
user_id = user_data['id']
|
|
291
|
+
|
|
292
|
+
# Pesquisa o grupo pelo nome
|
|
293
|
+
group_response = requests.get(
|
|
294
|
+
f"https://graph.microsoft.com/v1.0/groups?$filter=displayName eq '{group_name}'",
|
|
295
|
+
headers=headers
|
|
296
|
+
)
|
|
297
|
+
self.status_code = group_response.status_code
|
|
298
|
+
if group_response.status_code == 200:
|
|
299
|
+
group_data = group_response.json()
|
|
300
|
+
if 'value' in group_data and len(group_data['value']) > 0:
|
|
301
|
+
group_id = group_data['value'][0]['id']
|
|
302
|
+
|
|
303
|
+
# Verifica se o usuário está no grupo
|
|
304
|
+
members_response = requests.get(
|
|
305
|
+
f'https://graph.microsoft.com/v1.0/groups/{group_id}/members',
|
|
306
|
+
headers=headers
|
|
307
|
+
)
|
|
308
|
+
self.status_code = members_response.status_code
|
|
309
|
+
if members_response.status_code == 200:
|
|
310
|
+
members_data = members_response.json()
|
|
311
|
+
if 'value' in members_data:
|
|
312
|
+
user_in_group = any(member['id'] == user_id for member in members_data['value'])
|
|
313
|
+
if user_in_group:
|
|
314
|
+
self.response = f"O usuário {user_email} liberado para uso desta aplicação."
|
|
315
|
+
else:
|
|
316
|
+
self.response = f"O usuário {user_email} NÃO liberado para uso desta aplicação. Solicite acesso à TI."
|
|
317
|
+
self.status_code = 299
|
|
318
|
+
else:
|
|
319
|
+
self.response = "Resposta da API de membros não contém a chave 'value'."
|
|
320
|
+
self.status_code = 460
|
|
321
|
+
else:
|
|
322
|
+
self.response = f"Erro na resposta da API de membros: {members_response.status_code}"
|
|
323
|
+
self.response += f"\n{members_response.json()}"
|
|
324
|
+
else:
|
|
325
|
+
self.response = f"Grupo '{group_name}' não encontrado."
|
|
326
|
+
self.status_code = 470
|
|
327
|
+
else:
|
|
328
|
+
self.response = f"Erro na resposta da API de grupos: {group_response.status_code}"
|
|
329
|
+
self.response += f"\n{group_response.json()}"
|
|
330
|
+
else:
|
|
331
|
+
self.response = f"Erro na resposta da API de usuário: {user_response.status_code}"
|
|
332
|
+
self.response += f"\n{user_response.json()}"
|
|
333
|
+
else:
|
|
334
|
+
self.response = f"Erro ao obter informações do usuário: {me_response.status_code}"
|
|
335
|
+
self.response += f"\n{me_response.json()}"
|
|
336
|
+
else:
|
|
337
|
+
self.response = f"Erro ao obter o token de acesso: {result.get('error')}"
|
|
338
|
+
self.response += f"\n{result.get('error_description')}"
|
|
339
|
+
self.status_code = 480
|
|
340
|
+
|
|
341
|
+
# Fecha o navegador
|
|
342
|
+
driver.quit()
|
|
343
|
+
service.stop()
|
|
344
|
+
|
|
345
|
+
# Define o retorno
|
|
346
|
+
print(f'\nCódigo retorno: {self.status_code} ', end='') ## self.status_code = 200, usuário pertence ao grupo informado. self.status_code = 299, grupo existe mas usuário NÃO pertence à ele. Erros retornam 4xx.
|
|
347
|
+
print(f'Resposta: {self.response}', end='\n\n')
|
|
348
|
+
if self.status_code == 200:
|
|
349
|
+
print('Acesso autorizado!')
|
|
350
|
+
else:
|
|
351
|
+
print('Permissões inválidas! Execução abortada!')
|
|
352
|
+
os._exit(0)
|
|
353
|
+
|
|
354
|
+
def disclaimer(self): # Mostra o aviso do funcionamento e necessidade de autenticação
|
|
355
|
+
input(f'''
|
|
356
|
+
|
|
357
|
+
Para ser utilizado de forma adequada e segura, este script requer autenticação no Microsoft Entra ID (antiga Azure AD).
|
|
358
|
+
Também requer que seu usuário pertença a um grupo de segurança específico. Se você não tem a segurança que tem permissão de uso, solicite previamente à TI.
|
|
359
|
+
|
|
360
|
+
Para continuar, é necessário fornecer suas credenciais, aquelas que costumeiramente utiliza para acessar os serviços de e-mail corporativo.
|
|
361
|
+
Uma janela de navegador será aberta e você será direcionado à tela de Logon do Microsoft Entra ID.
|
|
362
|
+
Faça o Logon fornecendo usuário, senha e validação de duplo fator (no autenticador da Microsoft, instalado em seu celular).
|
|
363
|
+
Após a autenticação, a janela do navegador será fechada e o script iniciará o processo de execução.
|
|
364
|
+
|
|
365
|
+
Você tem {self.timeout} segundos para realizar a autenticação ou a execução será abortada.
|
|
366
|
+
|
|
367
|
+
Tecle [ENTER] para continuar ...
|
|
368
|
+
|
|
369
|
+
''')
|
|
370
|
+
|
|
371
|
+
class postgreSQL: # Classe de acesso e interação com banco PostgreSQL
|
|
372
|
+
def __init__(self, config, logger=None):
|
|
373
|
+
self.logger = logger if not logger is None else lbx_logger(None, logging.DEBUG, '%(levelname)s: %(message)s') # se não fornecer o logger, vai tudo para o console
|
|
374
|
+
|
|
375
|
+
try:
|
|
376
|
+
self.Conexao = psycopg2.connect(**config) ## na chamada de uma função/método, o * explode os valores de um dicionário em argumentos posicionais (só valores) e ** explode discionário em argumentos nominais (nome=valor)
|
|
377
|
+
except Exception as Err:
|
|
378
|
+
raise
|
|
379
|
+
|
|
380
|
+
def csv_df(self, CsvPath, CsvDelim=';'): # Le arquivo CSV e gera Dataframe do Pandas
|
|
381
|
+
try:
|
|
382
|
+
DataFrame = pd.read_csv(CsvPath, delimiter=CsvDelim) # Verifique se o delimitador é ';'
|
|
383
|
+
DataFrame.replace({np.nan: None}, inplace=True) ## troca 'NaN' por None (null no postgresql)
|
|
384
|
+
return DataFrame
|
|
385
|
+
except Exception as Err:
|
|
386
|
+
raise
|
|
387
|
+
|
|
388
|
+
def db_insert_df(self, DataFrame, Tabela, Schema=None, Colunas=None, OnConflict=None): # Insere os dados de um dataframe em uma tabela equivalente no banco (exige mesma estrutura de colunas)
|
|
389
|
+
# Essa função exige que os nomes dos cabeçalhos das colunas do CSV sejam os mesmos das colunas da tabela de destino
|
|
390
|
+
Colunas = Colunas or DataFrame.columns.tolist() # Caso não seja fornecida a lista de colunas, assume as colunas do DataFrame
|
|
391
|
+
Valores = [tuple(Linha) for Linha in DataFrame[Colunas].values]
|
|
392
|
+
Schema = Schema or 'public'
|
|
393
|
+
Query = f'insert into {Schema}.{Tabela} ({', '.join(Colunas)}) values %s '
|
|
394
|
+
if not OnConflict is None:
|
|
395
|
+
Query = Query + OnConflict
|
|
396
|
+
|
|
397
|
+
try:
|
|
398
|
+
self.Cursor = self.Conexao.cursor()
|
|
399
|
+
execute_values(self.Cursor, Query, Valores)
|
|
400
|
+
self.Conexao.commit()
|
|
401
|
+
except Exception as Err:
|
|
402
|
+
self.Conexao.rollback()
|
|
403
|
+
raise
|
|
404
|
+
finally:
|
|
405
|
+
self.Cursor.close()
|
|
406
|
+
#Conexao.close() ## conexão precisa ser fechada explicitamente fora da classe
|
|
407
|
+
|
|
408
|
+
def db_select(self, Query): # Retorna um cursor à partir de um select
|
|
409
|
+
BlackList = ['INSERT ', 'DELETE ', 'UPDATE ', 'CREATE ', 'DROP ', 'MERGE ', 'REPLACE ', 'CALL ', 'EXECUTE ']
|
|
410
|
+
if any(element in Query.upper() for element in BlackList):
|
|
411
|
+
BlackListed = [element for element in BlackList if element in Query.upper()]
|
|
412
|
+
self.logger.erro(f'{__name__}: Este método permite apenas consultas. A query informada possui as seguintes palavras reservadas não aceitas: {BlackListed} e não foi executada!')
|
|
413
|
+
return None
|
|
414
|
+
else:
|
|
415
|
+
try:
|
|
416
|
+
self.Cursor = self.Conexao.cursor()
|
|
417
|
+
self.Cursor.execute(Query)
|
|
418
|
+
Dados = self.Cursor.fetchall()
|
|
419
|
+
Colunas = [Col[0] for Col in self.Cursor.description]
|
|
420
|
+
self.Conexao.commit()
|
|
421
|
+
self.Cursor.close()
|
|
422
|
+
return Dados, Colunas
|
|
423
|
+
except Exception as Err:
|
|
424
|
+
self.Conexao.rollback()
|
|
425
|
+
raise
|
|
426
|
+
|
|
427
|
+
def db_update(self, Query): # Retorna um cursor à partir de um select
|
|
428
|
+
UpdRows = 0
|
|
429
|
+
BlackList = ['INSERT ', 'DELETE ', 'SELECT ', 'CREATE ', 'DROP ', 'MERGE ', 'REPLACE ', 'CALL ', 'EXECUTE ']
|
|
430
|
+
if any(element in Query.upper() for element in BlackList):
|
|
431
|
+
BlackListed = [element for element in BlackList if element in Query.upper()]
|
|
432
|
+
self.logger.erro(f'{__name__}: Este método permite apenas updates. A query informada possui as seguintes palavras reservadas não aceitas: {BlackListed} e não foi executada!')
|
|
433
|
+
return None
|
|
434
|
+
else:
|
|
435
|
+
try:
|
|
436
|
+
self.Cursor = self.Conexao.cursor()
|
|
437
|
+
self.Cursor.execute(Query)
|
|
438
|
+
UpdRows = self.Cursor.rowcount
|
|
439
|
+
self.Conexao.commit()
|
|
440
|
+
self.Cursor.close()
|
|
441
|
+
return UpdRows
|
|
442
|
+
except Exception as Err:
|
|
443
|
+
self.Conexao.rollback()
|
|
444
|
+
raise
|
|
445
|
+
|
|
446
|
+
class api_rest: # Classe para interação com APIs Rest (especialmente Sienge)
|
|
447
|
+
def __init__(self, url, credenciais, cadencia=3, timeout=6, logger=None, headers={"Content-Type": "application/json"}, verify=True):
|
|
448
|
+
self.logger = logger if not logger is None else lbx_logger(None, logging.DEBUG, '%(levelname)s: %(message)s') # se não fornecer o logger, vai tudo para o console
|
|
449
|
+
|
|
450
|
+
if not validators.url(url):
|
|
451
|
+
self.logger.critico('URL inválida: {url}. Primeiro parametro precisar uma URL válida. Script abortado', exit=1)
|
|
452
|
+
if not isinstance(credenciais, dict):
|
|
453
|
+
self.logger.critico('O segundo parametro posicional precisa ser um dicionário. Script abortado', exit=1)
|
|
454
|
+
|
|
455
|
+
self.RetEndPoint = None # Inicializa self.RetEndPoint como None
|
|
456
|
+
self.Headers = headers
|
|
457
|
+
self.Verify = verify
|
|
458
|
+
self.Url = url
|
|
459
|
+
self.Timeout = timeout
|
|
460
|
+
self.Credenciais = credenciais
|
|
461
|
+
self.Cadencia = 1/cadencia ## candencia corresponde a chamadas por segundo, não minuto
|
|
462
|
+
self.TempoUltReq = None
|
|
463
|
+
self.Intervalo = self.Cadencia + 1
|
|
464
|
+
|
|
465
|
+
def controla_cadencia(self): ## para controle apenas, não deve ser chamada fora da classe
|
|
466
|
+
# Verificar o tempo atual
|
|
467
|
+
Agora = time.time()
|
|
468
|
+
|
|
469
|
+
# Calcular intervalo entre requisições
|
|
470
|
+
if self.TempoUltReq:
|
|
471
|
+
self.Intervalo = Agora - self.TempoUltReq
|
|
472
|
+
else:
|
|
473
|
+
self.Intervalo = float('inf') # Primeira requisição não espera
|
|
474
|
+
|
|
475
|
+
# Calcular o tempo de espera necessário para respeitar o limite
|
|
476
|
+
if self.Intervalo < self.Cadencia:
|
|
477
|
+
self.Espera = self.Cadencia - self.Intervalo
|
|
478
|
+
time.sleep(self.Espera)
|
|
479
|
+
return self.Espera
|
|
480
|
+
else:
|
|
481
|
+
self.Espera = 0
|
|
482
|
+
return self.Espera, self.Intervalo
|
|
483
|
+
|
|
484
|
+
def auth_basic(self): # Autentica e abre sessão na API
|
|
485
|
+
if not self.Credenciais['user'] or not self.Credenciais['password']:
|
|
486
|
+
self.logger.critico('Dicionário de credenciais não possui chaves "user" e/ou "password". Script abortado', exit=1)
|
|
487
|
+
try:
|
|
488
|
+
self.Sessao = requests.Session()
|
|
489
|
+
#Sessao.auth = (ApiUser, ApiPass)
|
|
490
|
+
self.Sessao.auth = HTTPBasicAuth(self.Credenciais['user'], self.Credenciais['password'])
|
|
491
|
+
Auth = self.Sessao.post(self.Url)
|
|
492
|
+
#print(f'Status: {Auth.status_code}')
|
|
493
|
+
#print(f'Retorno: {Auth.text}')
|
|
494
|
+
return self.Sessao
|
|
495
|
+
except Exception as Err:
|
|
496
|
+
self.logger.critico(f"Falha ao autenticar API: {Err}. URL: {self.Url}", exit=1)
|
|
497
|
+
|
|
498
|
+
def auth_bearer(self): # Autentica e abre sessão na API
|
|
499
|
+
#self.UrlLogin = UrlLogin if UrlLogin is not None else self.Url
|
|
500
|
+
try:
|
|
501
|
+
self.Sessao = requests.Session()
|
|
502
|
+
Token = self.Sessao.post(self.Url, headers=self.Headers, json=self.Credenciais, verify=self.Verify)
|
|
503
|
+
self.Headers.update({"Authorization": f"Bearer {Token.text}"})
|
|
504
|
+
if 200 <= Token.status_code <= 299:
|
|
505
|
+
self.Sessao.status_code = Token.status_code
|
|
506
|
+
self.Sessao.token = Token.text
|
|
507
|
+
return self.Sessao
|
|
508
|
+
else:
|
|
509
|
+
self.logger.critico(f"Erro ao autenticar API: {Token.status_code} - {Token.text}", exit=1)
|
|
510
|
+
except Exception as Err:
|
|
511
|
+
self.logger.critico(f"Falha ao autenticar API: {Err}. URL: {self.Url}", exit=1)
|
|
512
|
+
|
|
513
|
+
def endpoint_json(self, endpoint, metodo, payload=None): # Interage com End Point
|
|
514
|
+
self.ult_tempo_req = time.time()
|
|
515
|
+
self.Metodo = metodo.lower()
|
|
516
|
+
#self.EndPoint = self.Url + endpoint
|
|
517
|
+
self.EndPoint = endpoint
|
|
518
|
+
self.Payload = payload
|
|
519
|
+
MetodosAceitos = ['post', 'get', 'patch', 'put']
|
|
520
|
+
if not any(element in self.Metodo for element in MetodosAceitos):
|
|
521
|
+
self.logger.critico(f'Método {self.Metodo} não previsto. Abortando chamada!', exit=1)
|
|
522
|
+
else:
|
|
523
|
+
ChamadaApi = f'self.Sessao.{self.Metodo}(self.EndPoint, timeout=self.Timeout, headers=self.Headers, verify=self.Verify)' if self.Payload is None else f'self.Sessao.{self.Metodo}(self.EndPoint, timeout=self.Timeout, headers=self.Headers, verify=self.Verify, json=self.Payload)'
|
|
524
|
+
self.controla_cadencia()
|
|
525
|
+
self.TempoUltReq = time.time()
|
|
526
|
+
try:
|
|
527
|
+
self.RetEndPoint = eval(ChamadaApi)
|
|
528
|
+
if self.RetEndPoint.status_code >= 500:
|
|
529
|
+
self.logger.critico(f'Erro {self.RetEndPoint.status_code} na chamada do endpoint: {Err}\nEndpoint: {self.EndPoint}\nResposta: {self.RetEndPoint.text}', exit=1)
|
|
530
|
+
self.RetEndPoint.Espera = self.Espera ## adiona o tempo de espera ao retorno da API
|
|
531
|
+
self.RetEndPoint.Intervalo = self.Intervalo ## adiciona o intervalo entre chamada ao retorno da API
|
|
532
|
+
return self.RetEndPoint
|
|
533
|
+
except requests.exceptions.ReadTimeout as Err:
|
|
534
|
+
self.logger.critico(f'Excedido tempo limite {self.Timeout} para retorno do endpoint: {Err}\nEndpoint: {self.EndPoint}', exit=1)
|
|
535
|
+
except Exception as Err:
|
|
536
|
+
self.logger.critico(f'Falha na chamada do endpoint: {Err}\nEndpoint: {self.EndPoint}\nCodigo retorno: {self.RetEndPoint.status_code}\nResposta:{self.RetEndPoint.text}', exit=1)
|
|
537
|
+
|
|
538
|
+
def close(self): # Encerra a cessão
|
|
539
|
+
self.Sessao.close()
|
|
540
|
+
|
|
541
|
+
class lbx_logger: # Classe para gerenciar a saída para log
|
|
542
|
+
class LevelFilter(logging.Filter):
|
|
543
|
+
def __init__(self, levels_to_ignore):
|
|
544
|
+
self.levels_to_ignore = levels_to_ignore
|
|
545
|
+
|
|
546
|
+
def filter(self, record):
|
|
547
|
+
return record.levelno not in self.levels_to_ignore
|
|
548
|
+
|
|
549
|
+
def __init__(self, log_file_path=None, log_level=logging.DEBUG, formato_log='%(asctime)s - %(levelname)s - %(message)s', modulo=None, ignore_console=None, ignore_file=None):
|
|
550
|
+
self.ignore_file = [] if ignore_file is None else ignore_file
|
|
551
|
+
self.ignore_console = [] if ignore_console is None else ignore_console
|
|
552
|
+
self.modulo = __name__ if modulo is None else modulo
|
|
553
|
+
self.logger = logging.getLogger(self.modulo)
|
|
554
|
+
self.logger.setLevel(log_level)
|
|
555
|
+
self.msg = ''
|
|
556
|
+
|
|
557
|
+
if log_file_path:
|
|
558
|
+
# Criando um handler para escrever em um arquivo de log
|
|
559
|
+
file_handler = logging.FileHandler(log_file_path)
|
|
560
|
+
file_handler.setLevel(log_level) # Sempre registrar tudo no arquivo
|
|
561
|
+
|
|
562
|
+
# Criando um handler para exibir no console
|
|
563
|
+
console_handler = logging.StreamHandler()
|
|
564
|
+
console_handler.setLevel(log_level) # Registrar DEBUG e acima no console
|
|
565
|
+
|
|
566
|
+
# Adicionando filtro para ignorar certos níveis no console e no arquivo
|
|
567
|
+
file_handler.addFilter(self.LevelFilter(self.ignore_file))
|
|
568
|
+
console_handler.addFilter(self.LevelFilter(self.ignore_console))
|
|
569
|
+
|
|
570
|
+
# Definindo o formato das mensagens de log
|
|
571
|
+
formatter = logging.Formatter(formato_log)
|
|
572
|
+
file_handler.setFormatter(formatter)
|
|
573
|
+
console_handler.setFormatter(formatter)
|
|
574
|
+
|
|
575
|
+
# Adicionando os handlers ao logger
|
|
576
|
+
self.logger.addHandler(file_handler)
|
|
577
|
+
self.logger.addHandler(console_handler)
|
|
578
|
+
else:
|
|
579
|
+
# Tudo direcionado para o console
|
|
580
|
+
console_handler = logging.StreamHandler()
|
|
581
|
+
console_handler.setLevel(log_level) # Registrar no console
|
|
582
|
+
|
|
583
|
+
# Adicionando filtro para ignorar certos níveis no console e no arquivo
|
|
584
|
+
console_handler.addFilter(self.LevelFilter(self.ignore_console))
|
|
585
|
+
|
|
586
|
+
# Definindo o formato das mensagens de log
|
|
587
|
+
formatter = logging.Formatter(formato_log)
|
|
588
|
+
console_handler.setFormatter(formatter)
|
|
589
|
+
|
|
590
|
+
# Adicionando o handler ao logger
|
|
591
|
+
self.logger.addHandler(console_handler)
|
|
592
|
+
|
|
593
|
+
# Redirecionando exceções para o logger
|
|
594
|
+
sys.excepthook = self.handle_exception
|
|
595
|
+
|
|
596
|
+
# Redirecionando saída padrão
|
|
597
|
+
self.original_stdout = sys.stdout
|
|
598
|
+
sys.stdout = self
|
|
599
|
+
|
|
600
|
+
def handle_exception(self, exc_type, exc_value, exc_traceback):
|
|
601
|
+
if issubclass(exc_type, KeyboardInterrupt):
|
|
602
|
+
sys.__excepthook__(exc_type, exc_value, exc_traceback)
|
|
603
|
+
return
|
|
604
|
+
self.logger.error("Exceção não prevista", exc_info=(exc_type, exc_value, exc_traceback))
|
|
605
|
+
|
|
606
|
+
def add(self, message, corte=None):
|
|
607
|
+
message = message[:corte] if corte else message
|
|
608
|
+
self.msg = self.msg + message if not message is None else self.msg
|
|
609
|
+
|
|
610
|
+
def write(self, message):
|
|
611
|
+
if message.strip(): # Ignorar mensagens vazias
|
|
612
|
+
self.logger.info(message.strip())
|
|
613
|
+
|
|
614
|
+
def flush(self):
|
|
615
|
+
pass # Método necessário para compatibilidade com sys.stdout
|
|
616
|
+
|
|
617
|
+
def debug(self, message, corte=None, exit=None):
|
|
618
|
+
self.msg = self.msg + message if not message is None else self.msg
|
|
619
|
+
msg = self.msg[:corte] if corte else self.msg
|
|
620
|
+
self.logger.debug(msg)
|
|
621
|
+
self.msg = ''
|
|
622
|
+
if exit:
|
|
623
|
+
os._exit(exit)
|
|
624
|
+
|
|
625
|
+
def info(self, message, corte=None, exit=None):
|
|
626
|
+
self.msg = self.msg + message if not message is None else self.msg
|
|
627
|
+
msg = self.msg[:corte] if corte else self.msg
|
|
628
|
+
self.logger.info(msg)
|
|
629
|
+
self.msg = ''
|
|
630
|
+
if exit:
|
|
631
|
+
os._exit(exit)
|
|
632
|
+
|
|
633
|
+
def aviso(self, message, corte=None, exit=None):
|
|
634
|
+
self.msg = self.msg + message if not message is None else self.msg
|
|
635
|
+
msg = self.msg[:corte] if corte else self.msg
|
|
636
|
+
self.logger.warning(msg)
|
|
637
|
+
self.msg = ''
|
|
638
|
+
if exit:
|
|
639
|
+
os._exit(exit)
|
|
640
|
+
|
|
641
|
+
def erro(self, message, corte=None, exit=None):
|
|
642
|
+
self.msg = self.msg + message if not message is None else self.msg
|
|
643
|
+
msg = self.msg[:corte] if corte else self.msg
|
|
644
|
+
self.logger.error(msg)
|
|
645
|
+
self.msg = ''
|
|
646
|
+
if exit:
|
|
647
|
+
os._exit(exit)
|
|
648
|
+
|
|
649
|
+
def critico(self, message, corte=None, exit=None):
|
|
650
|
+
self.msg = self.msg + message if not message is None else self.msg
|
|
651
|
+
msg = self.msg[:corte] if corte else self.msg
|
|
652
|
+
self.logger.critical(msg)
|
|
653
|
+
self.msg = ''
|
|
654
|
+
if exit:
|
|
655
|
+
os._exit(exit)
|
|
656
|
+
|
|
657
|
+
def stop_logging(self):
|
|
658
|
+
# Restaurar o stdout original
|
|
659
|
+
sys.stdout = self.original_stdout
|
|
660
|
+
# Remover handlers do logger
|
|
661
|
+
handlers = self.logger.handlers[:]
|
|
662
|
+
for handler in handlers:
|
|
663
|
+
handler.close()
|
|
664
|
+
self.logger.removeHandler(handler)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 lbx_toolkit
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,414 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: lbxtoolkit
|
|
3
|
+
Version: 2.0.1
|
|
4
|
+
Summary: Biblioteca de ferramentas LBX S/A
|
|
5
|
+
Author: Cristiano P. Ferrari
|
|
6
|
+
Author-email: boxferrari@gmail.com
|
|
7
|
+
License: MIT License
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
10
|
+
Classifier: Operating System :: OS Independent
|
|
11
|
+
Requires-Python: >=3.6
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
License-File: LICENSE
|
|
14
|
+
Requires-Dist: psycopg2
|
|
15
|
+
Requires-Dist: pandas
|
|
16
|
+
Requires-Dist: numpy
|
|
17
|
+
Requires-Dist: msal
|
|
18
|
+
Requires-Dist: requests
|
|
19
|
+
Requires-Dist: selenium
|
|
20
|
+
Requires-Dist: webdriver-manager
|
|
21
|
+
Requires-Dist: validators
|
|
22
|
+
|
|
23
|
+
# Biblioteca de ferramentas LBX S/A
|
|
24
|
+
|
|
25
|
+
Esta biblioteca possui ferramentas de uso recorrente para interação com banco de dados e API, além de autenticação/validação de credenciais de usuário no Microsoft Entra ID
|
|
26
|
+
|
|
27
|
+
## Classe e funções
|
|
28
|
+
|
|
29
|
+
**auth_EntraID**: Usa o Microsoft Entra ID (antiga Azure AD) para evitar execução não autorizada
|
|
30
|
+
- _.disclaimer_: Mensagem sobre a necessidade de autenticação
|
|
31
|
+
- _.valida_grupo_: Autentica o usuário e aborta se checa não pertencer ao grupo de segurança
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
**postgreSQL**: Interage com o banco de dados PostgreSQL
|
|
35
|
+
- _.db_: Inicia sessão com o banco
|
|
36
|
+
- _.csv_df_: Lê arquivo CSV e gera Dataframe (pandas) a partir dele
|
|
37
|
+
- _.db_insert_df_: Insere informações de Dataframe em tabela do banco com estrutura equivalente
|
|
38
|
+
- _.db_select_: Retorna um cursor a partir de uma query
|
|
39
|
+
- _.db_update_: Executa update em tabelas
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
**api_rest**: Interage com APIs RESTfull, especialmente providas para a plataforma Sienge
|
|
43
|
+
- _.auth_base_: Autentica (HTTPBasicAuth) sessão na API
|
|
44
|
+
- _.auth_bearer_: Autentica sessão na API pelos métodos: OAuth, JWT, Bearer
|
|
45
|
+
- _.endpoint_json_: Realizad chama ao endpoint. Payload em formato `json` opcional.
|
|
46
|
+
- _.close_: Encerra a sessão autenticada
|
|
47
|
+
|
|
48
|
+
**lbx_logger**: Manipula e formata as mensagens de saída do script para direcioná-las para tela (stdout) e/ou arquivo de log
|
|
49
|
+
- _.add_: Adiciona a mensagem a um _buffer_ sem exibir, acumulando até a próxima chamada em algum dos níveis abaixo.
|
|
50
|
+
- _.debug, .info, .aviso, .erro, .critico_:
|
|
51
|
+
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
|
|
52
|
+
- _.stop_logging_: Interrompe a manipulação das saídas pelo logger e restaura as saídas padrão (stdout/stderr) para a tela
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
## Instalação e uso:
|
|
56
|
+
|
|
57
|
+
### Instalação
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
pip install lbx_toolkit
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Uso
|
|
64
|
+
```
|
|
65
|
+
from lbx_toolkit import auth_EntraID, PostgreSQL, api_rest, lbx_logger
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
#### Classe **auth_EntraID**
|
|
69
|
+
|
|
70
|
+
Este recurso tem o propósito de controlar as permissões de execução do script usando as credencias do ambiente AD em nuvem da Microsoft (Azure AD >> Microsoft Entra ID), abortando se a autentição falhar ou o usuário não pertencer ao grupo.
|
|
71
|
+
|
|
72
|
+
Essa classe possui apenas dois métodos:
|
|
73
|
+
|
|
74
|
+
- `auth_EntraID.disclaimer()`: apenas exibe uma tela de informações/instruções ao usuário.
|
|
75
|
+
|
|
76
|
+
- `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.
|
|
77
|
+
|
|
78
|
+
É 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).
|
|
79
|
+
Sugerimos não armazenar estas ou outras informações sensíveis no script. Considere usar o pacote `dotenv` para isso.
|
|
80
|
+
|
|
81
|
+
Os argumentos obrigatórios (posicionais) são:
|
|
82
|
+
|
|
83
|
+
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)
|
|
84
|
+
|
|
85
|
+
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.
|
|
86
|
+
|
|
87
|
+
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*.
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
```
|
|
91
|
+
from lbx_toolkit import auth_EntraID
|
|
92
|
+
|
|
93
|
+
client_id = 'SEU_CLIENT_ID'
|
|
94
|
+
client_secret = 'SEU_CLIENT_SECRET'
|
|
95
|
+
tenant_id = 'SEU_TENANT_ID'
|
|
96
|
+
|
|
97
|
+
# inicializa instância
|
|
98
|
+
auth = auth_EntraID(client_id, client_secret, tenant_id, timeout=60, log_file='auth_EntraID.log')
|
|
99
|
+
|
|
100
|
+
# exibe a mensagem padrão de aviso
|
|
101
|
+
auth.disclaimer()
|
|
102
|
+
|
|
103
|
+
auth.valida_grupo('Nome do Grupo de Distribuição')
|
|
104
|
+
# se usuário não pertencer a grupo informado, a execução do script é abortada.
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
#### Classe **postgreSQL**
|
|
108
|
+
|
|
109
|
+
Recursos de interação com o banco de dados relacional PostgreSQL
|
|
110
|
+
|
|
111
|
+
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:
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
credenciais = {
|
|
115
|
+
'dbname': 'NOME_BANCO',
|
|
116
|
+
'user': 'USUARIO'',
|
|
117
|
+
'password': 'SENHA',
|
|
118
|
+
'host': 'IP_OU_DNS_SERVIDOR',
|
|
119
|
+
'port': 'PORTA_POSTGRESQL', ## padrão = 5432
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
conexao = postgreSQL.db(credenciais)
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
O nome do schema é ser declarado no contexto da query, mas se desejar alterar o schema padrão, adicione *`'options' : '-c search_path=[NOME_SCHEMA]',`* ao dicionário.
|
|
126
|
+
|
|
127
|
+
Qualquer argumento de conexão previsto no pacote *psycopg2* são aceitos como entrada no dicionário acima.
|
|
128
|
+
|
|
129
|
+
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.
|
|
130
|
+
|
|
131
|
+
```
|
|
132
|
+
from pathlib import Path
|
|
133
|
+
arquivo_csv = Path('./diretorio/arquivo_exemplo.csv')
|
|
134
|
+
dados = postgreSQL.csv_df(arquivo_csv, CsvDelim=',') # usando vírgula como separador. se omisso, assume ";'
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
3) 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.
|
|
138
|
+
|
|
139
|
+
A assinatura da função é `postgreSQL.db_insert_df([conexao], [dataframe_origem], [tabela_destino], Schema=None, Colunas=None, OnConflict=None)`
|
|
140
|
+
|
|
141
|
+
É necessário que os nomes das colunas do dataframe coincidam com o nome das colunas da tabela.
|
|
142
|
+
Não há como traduzir/compatibilizar (de-para) nomes de colunas entre o dataframe e a tabela.
|
|
143
|
+
|
|
144
|
+
Os três primeiros parametros são posicionais e correspondem, respectivamente, (1) ao objeto da conexão com o banco, (2) ao objeto que contém o dataframe e (3) ao nome da tabela de destino.
|
|
145
|
+
Assume-se que a tabela pertença ao schema padrão (definido na variável _search_path_ do servidor). Caso a tabela de destino esteja em um _schema_ diferente do padrão, deve-se informar seu nome no parâmetro opcional `Schema`.
|
|
146
|
+
|
|
147
|
+
O parametro opcional `Colunas` espera um objeto do tipo _lista_ que contenha a relação das colunas a serem importadas.
|
|
148
|
+
As colunas listadas neste objeto precisam existir nas duas pontas (dataframe e tabela).
|
|
149
|
+
Caso seja omisso, todas as colunas do dataframe serão inseridas na tabela. Neste caso, admite-se que haja colunas na tabela que não exitam no dataframe (serão gravadas como NULL), mas o contrário provocará erro.
|
|
150
|
+
|
|
151
|
+
O último parametro opcional `OnConflict` espera uma declaração para tratar o que fazer caso o dado a ser inserido já exista na tabela, baseado na cláusula [*ON CONFLICT*](https://www.postgresql.org/docs/current/sql-insert.html#SQL-ON-CONFLICT) do comando INSERT. A claúsula deve ser declarada explicita e integralmente nessa variável (clausula, _target_ e _action_) e não há crítica/validação desse argumento, podendo gerar erros se declarado inconforme com o padrão SQL.
|
|
152
|
+
|
|
153
|
+
Exemplo de uso:
|
|
154
|
+
|
|
155
|
+
```
|
|
156
|
+
from lbx_toolkit import postgreSQL
|
|
157
|
+
from pathlib import Path
|
|
158
|
+
|
|
159
|
+
credenciais = {
|
|
160
|
+
'dbname': 'NOME_BANCO',
|
|
161
|
+
'user': 'USUARIO'',
|
|
162
|
+
'password': 'SENHA',
|
|
163
|
+
'host': 'IP_OU_DNS_SERVIDOR',
|
|
164
|
+
'port': 'PORTA_POSTGRESQL', ## padrão = 5432
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
conexao = postgreSQL.db(credenciais)
|
|
168
|
+
|
|
169
|
+
arquivo_csv = Path('./diretorio/arquivo_exemplo.csv')
|
|
170
|
+
dados = postgreSQL.csv_df(arquivo_csv, CsvDelim=',') # usando vírgula como separador. se omisso, assume ";'
|
|
171
|
+
|
|
172
|
+
postgreSQL.db_insert_df(conexao, dados, 'teste_table', Schema='meu_esquema', OnConflict='on conflict (coluna_chave_primaria) do nothing')
|
|
173
|
+
|
|
174
|
+
# conexão com o banco precisa ser fechada explicitamente após a chamada do método, caso não seja mais utilizada:
|
|
175
|
+
conexao.close()
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
4) O método `postgreSQl.db_select()` executa consultas no banco de dados e retorna um `cursor` com o resultado.
|
|
179
|
+
|
|
180
|
+
A assinatura da função é `postgreSQL.db_select([conexao], [query])`
|
|
181
|
+
|
|
182
|
+
São permitidas apenas instruções de consulta (podendo serem complexas, por exemplo, com uso de [CTE](https://www.postgresql.org/docs/current/queries-with.html)). A presença de outras instruções SQL de manipulação de dados e metadados não são permitidas e abortarão a execução da query, se presentes.
|
|
183
|
+
|
|
184
|
+
O `cursor` é fechado no contexto do método, antes do retorno, *não podendo* ser manipulado após recebido como retorno da função.
|
|
185
|
+
|
|
186
|
+
A função retorna *dois objetos*, o primeiro contendo os dados do cursor, o segundo, contendo os nomes das respectivas colunas.
|
|
187
|
+
|
|
188
|
+
Exemplo de uso:
|
|
189
|
+
|
|
190
|
+
```
|
|
191
|
+
from lbx_toolkit import postgreSQL
|
|
192
|
+
from pathlib import Path
|
|
193
|
+
|
|
194
|
+
credenciais = {
|
|
195
|
+
'dbname': 'NOME_BANCO',
|
|
196
|
+
'user': 'USUARIO'',
|
|
197
|
+
'password': 'SENHA',
|
|
198
|
+
'host': 'IP_OU_DNS_SERVIDOR',
|
|
199
|
+
'port': 'PORTA_POSTGRESQL', ## padrão = 5432
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
conexao = postgreSQL.db(credenciais)
|
|
203
|
+
|
|
204
|
+
query = 'select * from meu_esquema.teste_table'
|
|
205
|
+
|
|
206
|
+
dados, colunas = postgreSQL.db_select(conexao, query)
|
|
207
|
+
conexao.close()
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
5) O método `postgreSQl.db_update()` executa updates no banco
|
|
211
|
+
|
|
212
|
+
A assinatura da função é `postgreSQL.db_update([conexao], [query])`
|
|
213
|
+
|
|
214
|
+
São permitidas apenas instruções de update. A presença de outras instruções SQL de manipulação de dados e metadados não são permitidas e abortarão a execução da query.
|
|
215
|
+
|
|
216
|
+
A função retorna *a quantidade de linhas alteradas*.
|
|
217
|
+
|
|
218
|
+
Exemplo de uso:
|
|
219
|
+
|
|
220
|
+
```
|
|
221
|
+
from lbx_toolkit import postgreSQL
|
|
222
|
+
from pathlib import Path
|
|
223
|
+
|
|
224
|
+
credenciais = {
|
|
225
|
+
'dbname': 'NOME_BANCO',
|
|
226
|
+
'user': 'USUARIO'',
|
|
227
|
+
'password': 'SENHA',
|
|
228
|
+
'host': 'IP_OU_DNS_SERVIDOR',
|
|
229
|
+
'port': 'PORTA_POSTGRESQL', ## padrão = 5432
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
conexao = postgreSQL.db(credenciais)
|
|
233
|
+
|
|
234
|
+
query = "update meu_esquema.teste_table set coluna='novo_valor' where pk='chave'"
|
|
235
|
+
|
|
236
|
+
result = postgreSQL.db_update(conexao, query)
|
|
237
|
+
conexao.close()
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
#### Classe **api_rest**
|
|
241
|
+
|
|
242
|
+
Destina-se a interatir com APIs RESTfull, em especial as publicadas pela SoftPlan para a [Plataforma Sienge](https://api.sienge.com.br/docs/).
|
|
243
|
+
|
|
244
|
+
A classe deve ser instanciada conforme sintaxe abaixo:
|
|
245
|
+
|
|
246
|
+
`api_rest(url, credenciais, cadencia, timeout=6, logger=None, headers={"Content-Type": "application/json"}, verify=True)`
|
|
247
|
+
|
|
248
|
+
São nessários 2 parâmetros posicionais obrigatórios, e 5 parametros nominais facultativos (valor padrão, se omisso, indicado na sintaxe acima):
|
|
249
|
+
- `url`: o endereço da URL de autenticação da API
|
|
250
|
+
- `crednciais`: Dicionário com credenciais de autenticação.
|
|
251
|
+
- `cadencia` Número máximo de chamadas *por segudo* à API
|
|
252
|
+
- `timeout` Tempo máximo (segundos) para aguardar retorno à chamada. Padrão 6s, se omisso.
|
|
253
|
+
- `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.
|
|
254
|
+
- `headers` Cabeçalhos _http_ para a requisição à API.
|
|
255
|
+
- `verify` Verifica a validade do certificado SSL do servidor de destino da requisição.
|
|
256
|
+
|
|
257
|
+
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*.
|
|
258
|
+
Para o método `api_rest.aut_basic()`, o formato deve ser:
|
|
259
|
+
```
|
|
260
|
+
credenciais = {
|
|
261
|
+
'user': 'USUARIO_API',
|
|
262
|
+
'password': 'TOKEN_USUARIO'
|
|
263
|
+
}
|
|
264
|
+
```
|
|
265
|
+
Caso a autenticação seja pelo método `api_rest.aut_bearer()`, o dicionário deve corresponder ao formato previsto pelo endpoint e seu conteúdo será enviado como um JSON ao endereço indicado no parametro `url`
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
A classe possui 3 métodos:
|
|
269
|
+
- `api_rest.auth_basic()`: instanciamento da sessão autenticando pelo método HTTPBasicAuth
|
|
270
|
+
- `api_rest.auth_bearer()`: instanciamento da sessão autenticando pelos métodos OAuth, JWT, Bearer
|
|
271
|
+
- `api_rest.endpoint_json([endereço], [método], payload=None)`: para a chamada ao endpoint
|
|
272
|
+
- `close()` para encerra a instância/sessão
|
|
273
|
+
|
|
274
|
+
O consumo é feito pelo método `api_rest.endpoint_json` que suporta apenas APIs cujo payload (opcional) seja aceito no formato JSON.
|
|
275
|
+
|
|
276
|
+
Esse método espera 2 parametros posicionais obrigatórios: o endereço do endpoint e o verbo (get, post, patch ou put), tendo parametro opcional o objeto de 'payload' (json).
|
|
277
|
+
Note que o endereço do endpoint deve ser informado completo. A URL informada no instanciamento da classe corresponde apenas ao endereço de autenticação.
|
|
278
|
+
|
|
279
|
+
O tempo, em segundos, transcorrido entre a chamada a atual e a chamada anterior ao endpoint pode ser consultado pelo argumento `.Intervalo` no objeto recebido do retorno à chamada ao método `.endpoint_json`.
|
|
280
|
+
|
|
281
|
+
Da mesma forma, o tempo de espera imposto para respeitar a cadência do webservcie também pode ser consultado pelo argumento `.Espera`.
|
|
282
|
+
|
|
283
|
+
Exemplo de uso:
|
|
284
|
+
|
|
285
|
+
```
|
|
286
|
+
from lbx_toolkit import api_rest
|
|
287
|
+
|
|
288
|
+
UrlBase=r'https://api.sienge.com.br/lbx/public/api/v1'
|
|
289
|
+
Credenciais = {
|
|
290
|
+
'user': 'USUARIO_API',
|
|
291
|
+
'password': 'TOKEN_USUARIO'
|
|
292
|
+
}
|
|
293
|
+
ApiSienge = api_rest(UrlBase,Credenciais,2.5) # limite de 2 requisições/segundo para cadência de chamada ao endpoint
|
|
294
|
+
Auth = ApiSienge.auth_basic()
|
|
295
|
+
|
|
296
|
+
Nutitulo=input('Numero do título:')
|
|
297
|
+
Nuparcela=input('Numero da parcela:')
|
|
298
|
+
Vencimento=input('Vencimento [AAAA-MM-DD]:')
|
|
299
|
+
Payload = {
|
|
300
|
+
"dueDate": f"{Vencimento}"
|
|
301
|
+
}
|
|
302
|
+
EndPoint = f'{UrlBase}/bills/{Nutitulo}/installments/{Nuparcela}'
|
|
303
|
+
|
|
304
|
+
#chama o endpoint e recebe o retorno no objeto AlteraVcto
|
|
305
|
+
AlteraVcto = ApiSienge.endpoint_json(EndPoint, 'patch', Payload)
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
No exemplo acima não é esperado que o endpoint retorne nenhum dado (`patch`).
|
|
309
|
+
|
|
310
|
+
Quando se usa o verbo `get` e se espera o retorno de algum dado, use o método `.json` do pacote `request` para acessar o objeto recebido.
|
|
311
|
+
|
|
312
|
+
Para uso em APIs com autenticação JWT (JSON Web Token), OAuth, Bearer Token Authentication, a construção é a mesma indicada acima, bastando-se usar `.auth_bearer()` ao invés de _.auth_basic()_, e ajustar o dicionário `credenciais` informado no instanciamento da classe, que deve ser estruturado conforme o padrão fornecido peo mantendor da API e será enviado como payload ao endpoint (`json=credenciais`).
|
|
313
|
+
|
|
314
|
+
#### Classe **lbx_logger**
|
|
315
|
+
|
|
316
|
+
Essa classe tem o propósito de manipular e formatar as mensagens de saída do script, alterando o formato e redirecionando destino padrão (stdout e stderr) para uma combinação de tela e/ou arquivo.
|
|
317
|
+
|
|
318
|
+
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.
|
|
319
|
+
|
|
320
|
+
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)*
|
|
321
|
+
|
|
322
|
+
A classificação do nível de serveridade da mensagem se dá pelo método escolhido para invocar a mensagem, correspondente aos níveis de severidade equivalentes.
|
|
323
|
+
|
|
324
|
+
A classe deve ser instanciada conforme sintaxe abaixo:
|
|
325
|
+
|
|
326
|
+
`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):`
|
|
327
|
+
|
|
328
|
+
Todos os parametros são nominativos e facultativos. Em caso de omissão, os valores padrão são assumidos conforme o exemplo acima.
|
|
329
|
+
|
|
330
|
+
Os parametros para o instanciamento da classe são:
|
|
331
|
+
|
|
332
|
+
- `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.
|
|
333
|
+
- `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:
|
|
334
|
+
- `logging.DEBUG` para manipular chamadas do método *.debug()* e acima.
|
|
335
|
+
- `logging.INFO` para manipular chamadas do método *.info()* e acima.
|
|
336
|
+
- `logging.WARNING` para manipular chamadas do método *.aviso()* e acima.
|
|
337
|
+
- `logging.ERROR` para manipular chamadas do método *.erro()* e acima.
|
|
338
|
+
- `logging.CRITICAL` para manipular chamadas do método *.critico()* e acima.
|
|
339
|
+
- `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)
|
|
340
|
+
- `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.
|
|
341
|
+
- `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.
|
|
342
|
+
- `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*.
|
|
343
|
+
|
|
344
|
+
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:
|
|
345
|
+
|
|
346
|
+
```
|
|
347
|
+
log.erro('Essa mensagem apenas resulta em uma mensagem de nível ERROR')
|
|
348
|
+
log.erro('Essa mensagem resulta em uma mensagem de nível ERRO e encerra o script com código de retorno -1', exit=-1)
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
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.
|
|
352
|
+
Para retornar ao comportamente padrão do comando print, ou interromper o manipulador, faça chamada ao método `.stop_logging()`
|
|
353
|
+
|
|
354
|
+
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:
|
|
355
|
+
|
|
356
|
+
```
|
|
357
|
+
log.add('Mensagem 1# ') ## não será exibida/registrada
|
|
358
|
+
log.add('Mensagem 2# ') ## não será exibida/registrada
|
|
359
|
+
log.info('Mensagem 3) ## será exibida/registrada como nível "info" e com texto: "Mensagem 1# Mensagem 2# Mensagem 3"
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
Os métodos que exibem as mensagens (`.debug()`,`.info()`,`.aviso()`, `.erro()`, `.critico()`) possuem 3 parametros: ``message``, `corte=None`, `exit=None`.
|
|
363
|
+
|
|
364
|
+
- `message`: posicional e obrigatório. corresponde à mensagem a ser exibida
|
|
365
|
+
- `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
|
|
366
|
+
- `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
|
|
367
|
+
|
|
368
|
+
Essa classe requer a importação do módulo `logging` no script em que for instanciada.
|
|
369
|
+
|
|
370
|
+
Exemplos de uso:
|
|
371
|
+
|
|
372
|
+
```
|
|
373
|
+
from lbx_toolkit import lbx_logger
|
|
374
|
+
import logging
|
|
375
|
+
import os
|
|
376
|
+
from pathlib import Path
|
|
377
|
+
|
|
378
|
+
DirBase = Path('./') # diretório corrente do script
|
|
379
|
+
BaseName = os.path.splitext(os.path.basename(__file__))[0] # nome do script sem extensão
|
|
380
|
+
LogFile = Path(DirBase, BaseName + '.log') # salva logs no diretório corrente, em um arquivo nomeado com nome do script + extensão ".log"
|
|
381
|
+
|
|
382
|
+
### instancia o manipulador para tratar todas as mensagens (nível DEBUG acima),
|
|
383
|
+
# mas suprime a apresentação em tela das mensagens de nível "DEBUG" na tela,
|
|
384
|
+
# apenas registrando-as somente no arquivo
|
|
385
|
+
# e sumprime o registro no arquivo das mensagens de nível "ERROR",
|
|
386
|
+
# mostrando-as apenas na tela
|
|
387
|
+
log = lbx_logger(LogFile, logging.DEBUG, ignore_console=[logging.DEBUG], ignore_file=[logging.ERROR])
|
|
388
|
+
|
|
389
|
+
# Exemplo de mensagens de log
|
|
390
|
+
log.debug('Esta é uma mensagem de debug')
|
|
391
|
+
log.info('Esta é uma mensagem informativa')
|
|
392
|
+
log.add('Esta mensagem não será exibida agora, mas acumulada no buffer# ')
|
|
393
|
+
log.aviso('Esta é uma mensagem de aviso')
|
|
394
|
+
log.erro('Esta é uma mensagem de erro')
|
|
395
|
+
log.erro('Esta é uma mensagem erro muito comprida e será limitada a 40 caracteres, o restante será cortado e ingorado ao ser manipulado', 40)
|
|
396
|
+
log.critico('Esta é uma mensagem crítica')
|
|
397
|
+
|
|
398
|
+
# Exemplo de função que gera uma exceção
|
|
399
|
+
def funcao_com_erro():
|
|
400
|
+
raise ValueError('Este é um erro de exemplo')
|
|
401
|
+
|
|
402
|
+
# Testando redirecionamento de print e captura de exceção
|
|
403
|
+
print('Mensagem de teste via print')
|
|
404
|
+
try:
|
|
405
|
+
funcao_com_erro()
|
|
406
|
+
except Exception as e:
|
|
407
|
+
print(f'Capturado um erro: {e}')
|
|
408
|
+
|
|
409
|
+
log.erro('Essa é uma mensagem de erro e abortará a execução do script', exit=1)
|
|
410
|
+
|
|
411
|
+
log.info('Essa mensagem não será exibida pois o script foi abortado na mensagem anterior')
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
lbxtoolkit/__init__.py,sha256=GGaV_R8kyui17xL_AYfEI5cHs40d3_pdnjt-dVVzT8g,34349
|
|
2
|
+
lbxtoolkit-2.0.1.dist-info/LICENSE,sha256=oWbIXdrHh8fiZ9xtLg5gloBth4N3LHUxM7REa5mCu4U,1087
|
|
3
|
+
lbxtoolkit-2.0.1.dist-info/METADATA,sha256=paHvj9fu84qZEKcuLLvjEdX66JbU7zvUS7_LlNdzNdw,23925
|
|
4
|
+
lbxtoolkit-2.0.1.dist-info/WHEEL,sha256=Wyh-_nZ0DJYolHNn1_hMa4lM7uDedD_RGVwbmTjyItk,91
|
|
5
|
+
lbxtoolkit-2.0.1.dist-info/top_level.txt,sha256=2fO2dxZu2kJzx49GALRsptbLdoPOps2mb52zsFFgDaM,11
|
|
6
|
+
lbxtoolkit-2.0.1.dist-info/RECORD,,
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
lbxtoolkit
|