No project description provided
Project description
<!doctype html>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="icon" href="assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.31">
<title>lbxtoolkit</title>
<link rel="stylesheet" href="assets/stylesheets/main.3cba04c6.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="assets/_mkdocstrings.css">
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#lbxtoolkit" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
Home
<h2 id="lbxtoolkit--biblioteca-de-ferramentas-lbx-sa"><strong>Biblioteca de ferramentas LBX S/A</strong></h2>
Esta biblioteca possui um ferramentas utilitárias de uso recorrente para aplicações de RPA em python.
Classe e funções
auth_EntraID
Usa o Microsoft Entra ID (antiga Azure AD) para evitar execução não autorizada
disclaimer : Mensagem sobre a necessidade de autenticação
valida_grupo : Autentica o usuário e aborta se checa não pertencer ao grupo de segurança
postgreSQL Interage com o banco de dados PostgreSQL - .db: Inicia sessão com o banco - .csv_df: Lê arquivo CSV e gera Dataframe (pandas) a partir dele - .db_insert_df: Insere informações de Dataframe em tabela do banco com estrutura equivalente - .db_select: Retorna um cursor a partir de uma query - .db_update: Executa update em tabelas
api_rest
Interage com APIs RESTfull, especialmente providas para a plataforma Sienge
- .auth_base: Autentica (HTTPBasicAuth) sessão na API
- .auth_bearer: Autentica sessão na API pelos métodos: OAuth, JWT, Bearer
- .endpoint_json: Realizad chama ao endpoint. Payload em formato json opcional.
- .trata_erro_sienge: Retorna a mensagem de erro do Sienge caso código de retorno seja diferente de 200.
- .close: Encerra a sessão autenticada
lbx_logger Manipula e formata as mensagens de saída do script para direcioná-las para tela (stdout) e/ou arquivo de log - .add: Adiciona a mensagem a um buffer sem exibir, acumulando até a próxima chamada em algum dos níveis abaixo. - .print: Contorna o manipulador de log e imprime diretamente na tela (stdout), sem formatar a mensagem nem registrar no arquivo - .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 - .stop_logging: Interrompe a manipulação das saídas pelo logger e restaura as saídas padrão (stdout/stderr) para a tela - .filtra: Filtra os eventos do arquivo de log registrados em um intervalo de tempo específico
misc Classe de miscelâneas/diversos - .seleciona_arquivo: Abre um picker do sistema operacionar para selecionar um arquivo e retorna seu path - .seleciona_dir: Abre um picker do sistema operacionar para selecionar um diretório e retorna seu path - .normaliza: Limpa caracteres especiais e espaços de strings e retorna tudo em minúsculo - .get_cmd_window: Captura a referencia da janela atual (cmd.exe) para retornar o foco à ela depois de chamar os pickers - .maximize_console: Maxima a janela do console (cmd.exe)
Instalação e uso:
Instalação
pip install lbx_toolkit
Uso
from lbx_toolkit import auth_EntraID, PostgreSQL, api_rest, lbx_logger
ConfigManager
<div class="doc doc-contents ">
<p>Como Funciona
Singleton Pattern: ConfigManager é um singleton que garante que todas as partes do código usem a mesma instância e, portanto, compartilhem a mesma configuração. 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 _config da instância. Método Genérico get: O método get aceita uma chave como argumento e retorna o valor correspondente do dicionário _config. Método set: O método set permite adicionar ou atualizar dinamicamente valores no dicionário _config. Método reset: O método reset limpa todas as configurações armazenadas, permitindo uma nova inicialização do ConfigManager com novos valores
<details class="quote">
<summary>Source code in <code>lbxtoolkit\__init__.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1336</span>
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
class ConfigManager: # Inicializa e recupera variáveis em ambiente de intercâmbio entre classes
"""
Como Funciona
Singleton Pattern: ConfigManager é um singleton que garante que todas as partes do código usem a mesma instância e, portanto, compartilhem a mesma configuração.
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 _config da instância.
Método Genérico get: O método get aceita uma chave como argumento e retorna o valor correspondente do dicionário _config.
Método set: O método set permite adicionar ou atualizar dinamicamente valores no dicionário _config.
Método reset: O método reset limpa todas as configurações armazenadas, permitindo uma nova inicialização do ConfigManager com novos valores
"""
_instance = None
def new(cls):
if cls._instance is None:
cls._instance = super(ConfigManager, cls).new(cls)
cls._instance._config = {}
return cls._instance
#
#
@classmethod
def initialize(cls, kwargs):
instance = cls()
for key, value in kwargs.items():
instance._config[key] = value
#
#
@classmethod
def get(cls, key):
return cls._instance._config.get(key)
#
#
@classmethod
def set(cls, key, value):
cls._instance._config[key] = value
#
#
@classmethod
def reset(cls):
cls._instance._config = {}
</div>
Servicer
<div class="doc doc-contents ">
<p>Classe base que implementa as rotinas padrão para a criação dameons/serviços do windows.
Além de iniciar e interromper o daemon/serviço, a classe implementar os métodos daemon_logs() e cleanup(), dependencias de run() e stop() que criam um arquivo de log do serviço/daemon (não do script em si) e um arquivo PID para o monitor de serviços. Os métodos padrão são init(), run() e stop() e não devem ser redefinidos/sobrecarregados. Para ser funcional, é necessária a criação de uma classe local que herde essa classe e redefina (por sobrecarga) ao menos os métodos on_run, on_start e args_parser(). on_init é opcional. Outros métodos complementares são oferidos para init, run e stop, permitindo injetar código no ínicio (pre) e fim (pós) os respectivos métodos (on_init_pre(), on_init_pos(), on_run_pre(), on_run_pos(), on_stop_pre(), on_stop_pos())
<details class="quote">
<summary>Source code in <code>lbxtoolkit\__init__.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1377</span>
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
class Servicer(): # Cria um daemon para rodar como serviço """ Classe base que implementa as rotinas padrão para a criação dameons/serviços do windows. Além de iniciar e interromper o daemon/serviço, a classe implementar os métodos daemon_logs() e cleanup(), dependencias de run() e stop() que criam um arquivo de log do serviço/daemon (não do script em si) e um arquivo PID para o monitor de serviços. Os métodos padrão são init(), run() e stop() e não devem ser redefinidos/sobrecarregados. Para ser funcional, é necessária a criação de uma classe local que herde essa classe e redefina (por sobrecarga) ao menos os métodos on_run, on_start e args_parser(). on_init é opcional. Outros métodos complementares são oferidos para init, run e stop, permitindo injetar código no ínicio (pre) e fim (pós) os respectivos métodos (on_init_pre(), on_init_pos(), on_run_pre(), on_run_pos(), on_stop_pre(), on_stop_pos()) """ def init(self, Log=None, piddir=None):#TODO: ao criar uma classe padrão usar args/kwargs para lidar como parametros variáveis no instanciamento # PRE-REQUISITOS/DEPENDÊNCIAS: self.log = ConfigManager.get('log') self.kwargs = ConfigManager.get('argparse_cfg') self.kwopts = ConfigManager.get('argparse_opt')
self.ambiente = ConfigManager.get('ambiente')
if self.log is None or not isinstance(self.log, lbx_logger): raise ValueError(f'Argumento "log" é mandatório e deve ser uma instância de "lbxtoolkit.lbx_logger"') if self.kwargs is None: raise ValueError(f'Argumento "argparse_cfg" é mandatório e deve ser um dicionário com ao mínimo as chaves: [description, usage, usage, add_help, formatter_class] para configuração do módulo argpase') if self.kwopts is None: raise ValueError(f'Argumento "argparse_opt" é mandatório e deve ser uma lista de dicionários ao mínimo as chaves: [short, long, action, help] para tratamento dos argumentos recebidos da linha de comando') if self.ambiente is None or self.ambiente not in ['Linux', 'Windows', 'Serviço']: raise ValueError(f'Argumento "ambiente" é mandatório e deve ser uma string com um dos seguintes valores: [Linux, Windows, Serviço]')<span class="bp">self</span><span class="o">.</span><span class="n">on_init_pre</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local</span> <span class="c1"># Argumentos padrão obrigatórios </span> <span class="bp">self</span><span class="o">.</span><span class="n">LogFile</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">'.'</span><span class="p">,</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="s1">'.daemon'</span><span class="p">)</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">Log</span> <span class="k">else</span> <span class="n">Log</span> <span class="bp">self</span><span class="o">.</span><span class="n">OS</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">PID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getppid</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">IP</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">gethostbyname</span><span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">gethostname</span><span class="p">())</span> <span class="bp">self</span><span class="o">.</span><span class="n">Host</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">gethostname</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">Usuario</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getlogin</span><span class="p">()</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">OS</span> <span class="o">==</span> <span class="s1">'Windows'</span> <span class="k">else</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s1">'~'</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="sa">r</span><span class="s1">'/'</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span> <span class="bp">self</span><span class="o">.</span><span class="n">Me</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">PIDDir</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">piddir</span> <span class="k">else</span> <span class="n">piddir</span> <span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">PIDDir</span><span class="p">,</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">PID</span><span class="p">))</span> <span class="bp">self</span><span class="o">.</span><span class="n">exit</span> <span class="o">=</span> <span class="kc">False</span> <span class="bp">self</span><span class="o">.</span><span class="n">mode</span> <span class="o">=</span> <span class="s1">'[DAEMON (console)]'</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_init</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_init_pos</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1">#kwargs = ConfigManager.get('argparse_cfg')</span> <span class="c1">#kwopts = ConfigManager.get('argparse_opt') </span> <span class="c1">#ambiente = ConfigManager.get('ambiente') </span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">ambiente</span> <span class="o">==</span> <span class="s1">'Serviço'</span><span class="p">:</span> <span class="c1">## VEM DAQUI https://gist.github.com/drmalex07/10554232?permalink_comment_id=2555358#gistcomment-2555358 </span> <span class="n">servicemanager</span><span class="o">.</span><span class="n">Initialize</span><span class="p">()</span> <span class="n">servicemanager</span><span class="o">.</span><span class="n">PrepareToHostSingle</span><span class="p">(</span><span class="n">ServicoWindows</span><span class="p">)</span> <span class="n">servicemanager</span><span class="o">.</span><span class="n">StartServiceCtrlDispatcher</span><span class="p">()</span> <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'install'</span><span class="p">:</span> <span class="n">ServicoWindows</span><span class="o">.</span><span class="n">SvcInstall</span><span class="p">()</span> <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'remove'</span><span class="p">:</span> <span class="n">ServicoWindows</span><span class="o">.</span><span class="n">SvcRemove</span><span class="p">()</span> <span class="k">else</span><span class="p">:</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'start'</span><span class="p">,</span> <span class="s1">'stop'</span><span class="p">,</span> <span class="s1">'restart'</span><span class="p">,</span> <span class="s1">'debug'</span><span class="p">]:</span> <span class="n">win32serviceutil</span><span class="o">.</span><span class="n">HandleCommandLine</span><span class="p">(</span><span class="n">ServicoWindows</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">(</span><span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span> <span class="k">for</span> <span class="n">opt</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">kwopts</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="n">opt</span><span class="p">[</span><span class="s1">'short'</span><span class="p">],</span> <span class="n">opt</span><span class="p">[</span><span class="s1">'long'</span><span class="p">],</span> <span class="n">action</span><span class="o">=</span><span class="n">opt</span><span class="p">[</span><span class="s1">'action'</span><span class="p">],</span> <span class="n">help</span><span class="o">=</span><span class="n">opt</span><span class="p">[</span><span class="s1">'help'</span><span class="p">])</span> <span class="bp">self</span><span class="o">.</span><span class="n">args</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">args_paser</span><span class="p">()</span> <span class="c1">## tratamento dos arguemntos deve ser redefindo por sobrecarga no na função local</span> <span class="c1">#</span> <span class="c1"># </span> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>"""Inicia a execução do do serviço"""
<span class="bp">self</span><span class="o">.</span><span class="n">on_run_pre</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span> <span class="bp">self</span><span class="o">.</span><span class="n">daemon_log</span><span class="p">(</span><span class="s1">'START'</span><span class="p">)</span> <span class="c1">## Gera o PIDFile</span> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Iniciando daemon [PID: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">PID</span><span class="si">}</span><span class="s1">] para monitorar os processos que rodam como serviço/daemon monitorados em: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">PIDDir</span><span class="si">}</span><span class="s1">... '</span><span class="p">)</span> <span class="k">try</span><span class="p">:</span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">'utf-8'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">Me</span> <span class="o">+</span> <span class="s1">';'</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">LogFile</span><span class="p">))</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">(</span><span class="s1">'CRASH'</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">erro</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Erro [</span><span class="si">{</span><span class="n">Err</span><span class="si">}</span><span class="s1">] ao salvar PIDFile: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span><span class="si">}</span><span class="s1">'</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Ok!'</span><span class="p">)</span> <span class="c1">## trocar para debug em prd ??</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_run</span><span class="p">()</span> <span class="c1"># função principal para interreper o daemon/serviço, definir localmente por sobrecarga (criar classe que herde essa classe e defina essa função) </span> <span class="bp">self</span><span class="o">.</span><span class="n">on_run_pos</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">evento</span><span class="o">=</span><span class="s1">'STOP'</span><span class="p">):</span>"""Interrompe o daemon/serviço"""
<span class="bp">self</span><span class="o">.</span><span class="n">on_stop_pre</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span> <span class="bp">self</span><span class="o">.</span><span class="n">daemon_log</span><span class="p">(</span><span class="n">evento</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_stop</span><span class="p">()</span> <span class="c1"># função principal para interreper o daemon/serviço, definir localmente por sobrecarga (criar classe que herde essa classe e defina essa função)</span> <span class="bp">self</span><span class="o">.</span><span class="n">cleanup</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">exit</span><span class="o">=</span><span class="kc">True</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_stop_pos</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">cleanup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1">## Elimina o arquivo PID do processo se estiver rodando como daemon</span>"""Método auxiliar utilizado no stop() para limpar o o PID file na interrupção"""
<span class="bp">self</span><span class="o">.</span><span class="n">on_cleanup_pre</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span><span class="p">:</span> <span class="c1">## verifica se está rodando como daemon</span> <span class="k">if</span> <span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span><span class="p">)</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span> <span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span><span class="p">)</span><span class="o">.</span><span class="n">unlink</span><span class="p">()</span> <span class="c1">##exclui o pidfile do daemon se o arquivo existir </span> <span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span> <span class="o">=</span> <span class="kc">None</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_cleanup_pos</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">daemon_log</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">evento</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="c1">## Gerar log de início/interrupção do serviço</span>"""Método auxiliar utilizado alimentar log do histórico de inicialização/interrupção do serviço/daemon"""
<span class="n">evento</span> <span class="o">=</span> <span class="s1">'CHECK'</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">evento</span> <span class="k">else</span> <span class="n">evento</span> <span class="n">evento</span> <span class="o">=</span> <span class="n">evento</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="n">TimeStamp</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s1">'%Y-%m-</span><span class="si">%d</span><span class="s1"> %H:%M:%S'</span><span class="p">)</span> <span class="n">Message</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'</span><span class="si">{</span><span class="n">TimeStamp</span><span class="si">}</span><span class="s1"> - </span><span class="si">{</span><span class="n">evento</span><span class="si">}</span><span class="s1"> - </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">OS</span><span class="si">}</span><span class="s1"> - </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">Host</span><span class="si">}</span><span class="s1">/</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">IP</span><span class="si">}</span><span class="s1"> - PID: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">PID</span><span class="si">}</span><span class="s1"> - </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">Usuario</span><span class="si">}</span><span class="s1"> - </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">Me</span><span class="si">}</span><span class="s1">'</span> <span class="k">try</span><span class="p">:</span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">LogFile</span><span class="p">,</span> <span class="s1">'a'</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span> <span class="n">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">Message</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">erro</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Erro [</span><span class="si">{</span><span class="n">Err</span><span class="si">}</span><span class="s1">] ao gravar status do daemon em </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">LogFile</span><span class="si">}</span><span class="s1">'</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">on_init_pre</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="k">def</span> <span class="nf">on_init_pos</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="k">def</span> <span class="nf">on_init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="k">def</span> <span class="nf">on_cleanup_pre</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="k">def</span> <span class="nf">on_cleanup_pos</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="k">def</span> <span class="nf">on_cleanup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="k">def</span> <span class="nf">on_run_pre</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="k">def</span> <span class="nf">on_run_pos</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="k">def</span> <span class="nf">on_run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="k">def</span> <span class="nf">on_stop_pre</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="k">def</span> <span class="nf">on_stop_pos</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="k">def</span> <span class="nf">on_stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="k">def</span> <span class="nf">args_paser</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span>
cleanup()
<div class="doc doc-contents ">
<p>Método auxiliar utilizado no stop() para limpar o o PID file na interrupção</p>
<details class="quote">
<summary>Source code in <code>lbxtoolkit\__init__.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1478</span>
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
def cleanup(self): ## Elimina o arquivo PID do processo se estiver rodando como daemon """Método auxiliar utilizado no stop() para limpar o o PID file na interrupção"""<span class="bp">self</span><span class="o">.</span><span class="n">on_cleanup_pre</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span><span class="p">:</span> <span class="c1">## verifica se está rodando como daemon</span> <span class="k">if</span> <span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span><span class="p">)</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span> <span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span><span class="p">)</span><span class="o">.</span><span class="n">unlink</span><span class="p">()</span> <span class="c1">##exclui o pidfile do daemon se o arquivo existir </span> <span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span> <span class="o">=</span> <span class="kc">None</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_cleanup_pos</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span>
daemon_log(evento=None)
<div class="doc doc-contents ">
<p>Método auxiliar utilizado alimentar log do histórico de inicialização/interrupção do serviço/daemon</p>
<details class="quote">
<summary>Source code in <code>lbxtoolkit\__init__.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1491</span>
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502
def daemon_log(self, evento=None): ## Gerar log de início/interrupção do serviço """Método auxiliar utilizado alimentar log do histórico de inicialização/interrupção do serviço/daemon"""<span class="n">evento</span> <span class="o">=</span> <span class="s1">'CHECK'</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">evento</span> <span class="k">else</span> <span class="n">evento</span> <span class="n">evento</span> <span class="o">=</span> <span class="n">evento</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="n">TimeStamp</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s1">'%Y-%m-</span><span class="si">%d</span><span class="s1"> %H:%M:%S'</span><span class="p">)</span> <span class="n">Message</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'</span><span class="si">{</span><span class="n">TimeStamp</span><span class="si">}</span><span class="s1"> - </span><span class="si">{</span><span class="n">evento</span><span class="si">}</span><span class="s1"> - </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">OS</span><span class="si">}</span><span class="s1"> - </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">Host</span><span class="si">}</span><span class="s1">/</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">IP</span><span class="si">}</span><span class="s1"> - PID: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">PID</span><span class="si">}</span><span class="s1"> - </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">Usuario</span><span class="si">}</span><span class="s1"> - </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">Me</span><span class="si">}</span><span class="s1">'</span> <span class="k">try</span><span class="p">:</span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">LogFile</span><span class="p">,</span> <span class="s1">'a'</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span> <span class="n">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">Message</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">erro</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Erro [</span><span class="si">{</span><span class="n">Err</span><span class="si">}</span><span class="s1">] ao gravar status do daemon em </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">LogFile</span><span class="si">}</span><span class="s1">'</span><span class="p">)</span>
run()
<div class="doc doc-contents ">
<p>Inicia a execução do do serviço</p>
<details class="quote">
<summary>Source code in <code>lbxtoolkit\__init__.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1444</span>
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
def run(self): """Inicia a execução do do serviço"""<span class="bp">self</span><span class="o">.</span><span class="n">on_run_pre</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span> <span class="bp">self</span><span class="o">.</span><span class="n">daemon_log</span><span class="p">(</span><span class="s1">'START'</span><span class="p">)</span> <span class="c1">## Gera o PIDFile</span> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Iniciando daemon [PID: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">PID</span><span class="si">}</span><span class="s1">] para monitorar os processos que rodam como serviço/daemon monitorados em: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">PIDDir</span><span class="si">}</span><span class="s1">... '</span><span class="p">)</span> <span class="k">try</span><span class="p">:</span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">'utf-8'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">Me</span> <span class="o">+</span> <span class="s1">';'</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">LogFile</span><span class="p">))</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">(</span><span class="s1">'CRASH'</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">erro</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Erro [</span><span class="si">{</span><span class="n">Err</span><span class="si">}</span><span class="s1">] ao salvar PIDFile: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">PIDFile</span><span class="si">}</span><span class="s1">'</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Ok!'</span><span class="p">)</span> <span class="c1">## trocar para debug em prd ??</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_run</span><span class="p">()</span> <span class="c1"># função principal para interreper o daemon/serviço, definir localmente por sobrecarga (criar classe que herde essa classe e defina essa função) </span> <span class="bp">self</span><span class="o">.</span><span class="n">on_run_pos</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span>
stop(evento='STOP')
<div class="doc doc-contents ">
<p>Interrompe o daemon/serviço</p>
<details class="quote">
<summary>Source code in <code>lbxtoolkit\__init__.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1465</span>
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
def stop(self, evento='STOP'): """Interrompe o daemon/serviço"""<span class="bp">self</span><span class="o">.</span><span class="n">on_stop_pre</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span> <span class="bp">self</span><span class="o">.</span><span class="n">daemon_log</span><span class="p">(</span><span class="n">evento</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_stop</span><span class="p">()</span> <span class="c1"># função principal para interreper o daemon/serviço, definir localmente por sobrecarga (criar classe que herde essa classe e defina essa função)</span> <span class="bp">self</span><span class="o">.</span><span class="n">cleanup</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">exit</span><span class="o">=</span><span class="kc">True</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_stop_pos</span><span class="p">()</span> <span class="c1">## método opcional a ser definito por sobrecarga na função local </span>
</div>
api_rest
<div class="doc doc-contents ">
<h6 id="lbxtoolkit.api_rest--classe-api_rest">Classe <strong>api_rest</strong></h6>
Destina-se a interatir com APIs RESTfull, em especial as publicadas pela SoftPlan para a Plataforma Sienge.
A classe deve ser instanciada conforme sintaxe abaixo:
api_rest(url, credenciais, cadencia, timeout=6, logger=None, headers={"Content-Type": "application/json"}, verify=True)
São nessários 2 parâmetros posicionais obrigatórios, e 5 parametros nominais facultativos (valor padrão, se omisso, indicado na sintaxe acima):
- url: o endereço da URL de autenticação da API
- crednciais: Dicionário com credenciais de autenticação.
- cadencia Número máximo de chamadas por segudo à API
- timeout Tempo máximo (segundos) para aguardar retorno à chamada. Padrão 6s, se omisso.
- 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.
- headers Cabeçalhos http para a requisição à API.
- verify Verifica a validade do certificado SSL do servidor de destino da requisição.
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.
Para o método api_rest.aut_basic(), o formato deve ser:
credenciais = {
'user': 'USUARIO_API',
'password': 'TOKEN_USUARIO'
}
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
A classe possui 3 métodos:
- api_rest.auth_basic(): instanciamento da sessão autenticando pelo método HTTPBasicAuth
- api_rest.auth_bearer(): instanciamento da sessão autenticando pelos métodos OAuth, JWT, Bearer
- api_rest.endpoint_json([endereço], [método], payload=None): para a chamada ao endpoint
- close() para encerra a instância/sessão
O consumo é feito pelo método api_rest.endpoint_json que suporta apenas APIs cujo payload (opcional) seja aceito no formato JSON.
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). 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.
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.
Da mesma forma, o tempo de espera imposto para respeitar a cadência do webservcie também pode ser consultado pelo argumento .Espera.
Exemplo de uso:
from lbx_toolkit import api_restUrlBase=r'https://api.sienge.com.br/lbx/public/api/v1' Credenciais = { 'user': 'USUARIO_API', 'password': 'TOKEN_USUARIO' } ApiSienge = api_rest(UrlBase,Credenciais,2.5) # limite de 2 requisições/segundo para cadência de chamada ao endpoint Auth = ApiSienge.auth_basic()
Nutitulo=input('Numero do título:') Nuparcela=input('Numero da parcela:') Vencimento=input('Vencimento [AAAA-MM-DD]:') Payload = { "dueDate": f"{Vencimento}" } EndPoint = f'{UrlBase}/bills/{Nutitulo}/installments/{Nuparcela}'
#chama o endpoint e recebe o retorno no objeto AlteraVcto AlteraVcto = ApiSienge.endpoint_json(EndPoint, 'patch', Payload)
No exemplo acima não é esperado que o endpoint retorne nenhum dado (patch).
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.
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).
<details class="quote">
<summary>Source code in <code>lbxtoolkit\__init__.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">709</span>
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
class api_rest: # Classe para interação com APIs Rest (especialmente Sienge) """ #### Classe api_restDestina-se a interatir com APIs RESTfull, em especial as publicadas pela SoftPlan para a Plataforma Sienge.
A classe deve ser instanciada conforme sintaxe abaixo:
api_rest(url, credenciais, cadencia, timeout=6, logger=None, headers={"Content-Type": "application/json"}, verify=True)São nessários 2 parâmetros posicionais obrigatórios, e 5 parametros nominais facultativos (valor padrão, se omisso, indicado na sintaxe acima): -
url: o endereço da URL de autenticação da API -crednciais: Dicionário com credenciais de autenticação. -cadenciaNúmero máximo de chamadas por segudo à API -timeoutTempo máximo (segundos) para aguardar retorno à chamada. Padrão 6s, se omisso. -loggerO 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. -headersCabeçalhos http para a requisição à API. -verifyVerifica a validade do certificado SSL do servidor de destino da requisição.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. Para o método
api_rest.aut_basic(), o formato deve ser:</span> <span class="sd"> credenciais = {</span> <span class="sd"> 'user': 'USUARIO_API',</span> <span class="sd"> 'password': 'TOKEN_USUARIO'</span> <span class="sd"> }</span> <span class="sd">Caso a autenticação seja pelo métodoapi_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 parametrourlA classe possui 3 métodos: -
api_rest.auth_basic(): instanciamento da sessão autenticando pelo método HTTPBasicAuth -api_rest.auth_bearer(): instanciamento da sessão autenticando pelos métodos OAuth, JWT, Bearer -api_rest.endpoint_json([endereço], [método], payload=None): para a chamada ao endpoint -close()para encerra a instância/sessãoO consumo é feito pelo método
api_rest.endpoint_jsonque suporta apenas APIs cujo payload (opcional) seja aceito no formato JSON.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). 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.
O tempo, em segundos, transcorrido entre a chamada a atual e a chamada anterior ao endpoint pode ser consultado pelo argumento
.Intervalono objeto recebido do retorno à chamada ao método.endpoint_json.Da mesma forma, o tempo de espera imposto para respeitar a cadência do webservcie também pode ser consultado pelo argumento
.Espera.Exemplo de uso:
``` from lbx_toolkit import api_rest
UrlBase=r'https://api.sienge.com.br/lbx/public/api/v1' Credenciais = { 'user': 'USUARIO_API', 'password': 'TOKEN_USUARIO' } ApiSienge = api_rest(UrlBase,Credenciais,2.5) # limite de 2 requisições/segundo para cadência de chamada ao endpoint Auth = ApiSienge.auth_basic()
Nutitulo=input('Numero do título:') Nuparcela=input('Numero da parcela:') Vencimento=input('Vencimento [AAAA-MM-DD]:') Payload = { "dueDate": f"{Vencimento}" } EndPoint = f'{UrlBase}/bills/{Nutitulo}/installments/{Nuparcela}'
#chama o endpoint e recebe o retorno no objeto AlteraVcto AlteraVcto = ApiSienge.endpoint_json(EndPoint, 'patch', Payload) ```
No exemplo acima não é esperado que o endpoint retorne nenhum dado (
patch).Quando se usa o verbo
gete se espera o retorno de algum dado, use o método.jsondo pacoterequestpara acessar o objeto recebido.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áriocredenciaisinformado 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).""" def init(self, url, credenciais, cadencia=3, timeout=6, logger=None, headers={"Content-Type": "application/json"}, verify=True): 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
<span class="k">if</span> <span class="ow">not</span> <span class="n">validators</span><span class="o">.</span><span class="n">url</span><span class="p">(</span><span class="n">url</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critico</span><span class="p">(</span><span class="s1">'URL inválida: </span><span class="si">{url}</span><span class="s1">. Primeiro parametro precisar uma URL válida. Script abortado'</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">credenciais</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critico</span><span class="p">(</span><span class="s1">'O segundo parametro posicional precisa ser um dicionário. Script abortado'</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">RetEndPoint</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># Inicializa self.RetEndPoint como None </span> <span class="bp">self</span><span class="o">.</span><span class="n">Headers</span> <span class="o">=</span> <span class="n">headers</span> <span class="bp">self</span><span class="o">.</span><span class="n">Verify</span> <span class="o">=</span> <span class="n">verify</span> <span class="bp">self</span><span class="o">.</span><span class="n">Url</span> <span class="o">=</span> <span class="n">url</span> <span class="bp">self</span><span class="o">.</span><span class="n">Timeout</span> <span class="o">=</span> <span class="n">timeout</span> <span class="bp">self</span><span class="o">.</span><span class="n">Credenciais</span> <span class="o">=</span> <span class="n">credenciais</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cadencia</span> <span class="o">=</span> <span class="mi">1</span><span class="o">/</span><span class="n">cadencia</span> <span class="c1">## candencia corresponde a chamadas por segundo, não minuto</span> <span class="bp">self</span><span class="o">.</span><span class="n">TempoUltReq</span> <span class="o">=</span> <span class="kc">None</span> <span class="bp">self</span><span class="o">.</span><span class="n">Intervalo</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cadencia</span> <span class="o">+</span> <span class="mi">1</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">controla_cadencia</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1">## para controle apenas, não deve ser chamada fora da classe</span> <span class="c1"># Verificar o tempo atual</span> <span class="n">Agora</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="c1"># Calcular intervalo entre requisições</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">TempoUltReq</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Intervalo</span> <span class="o">=</span> <span class="n">Agora</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">TempoUltReq</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Intervalo</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="s1">'inf'</span><span class="p">)</span> <span class="c1"># Primeira requisição não espera</span> <span class="c1"># Calcular o tempo de espera necessário para respeitar o limite</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">Intervalo</span> <span class="o"><</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cadencia</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Espera</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cadencia</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">Intervalo</span> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">Espera</span><span class="p">)</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">Espera</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Espera</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">Espera</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">Intervalo</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">auth_basic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1"># Autentica e abre sessão na API </span> <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">Credenciais</span><span class="p">[</span><span class="s1">'user'</span><span class="p">]</span> <span class="ow">or</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">Credenciais</span><span class="p">[</span><span class="s1">'password'</span><span class="p">]:</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critico</span><span class="p">(</span><span class="s1">'Dicionário de credenciais não possui chaves "user" e/ou "password". Script abortado'</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="k">try</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Sessao</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">Session</span><span class="p">()</span> <span class="c1">#Sessao.auth = (ApiUser, ApiPass)</span> <span class="bp">self</span><span class="o">.</span><span class="n">Sessao</span><span class="o">.</span><span class="n">auth</span> <span class="o">=</span> <span class="n">HTTPBasicAuth</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">Credenciais</span><span class="p">[</span><span class="s1">'user'</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">Credenciais</span><span class="p">[</span><span class="s1">'password'</span><span class="p">])</span> <span class="n">Auth</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">Sessao</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">Url</span><span class="p">)</span> <span class="c1">#print(f'Status: {Auth.status_code}')</span> <span class="c1">#print(f'Retorno: {Auth.text}')</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">Sessao</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critico</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Falha ao autenticar API: </span><span class="si">{</span><span class="n">Err</span><span class="si">}</span><span class="s2">. URL: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">Url</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">auth_bearer</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1"># Autentica e abre sessão na API</span> <span class="c1">#self.UrlLogin = UrlLogin if UrlLogin is not None else self.Url</span> <span class="k">try</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Sessao</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">Session</span><span class="p">()</span> <span class="n">Token</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">Sessao</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">Url</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">Headers</span><span class="p">,</span> <span class="n">json</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">Credenciais</span><span class="p">,</span> <span class="n">verify</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">Verify</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">Headers</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s2">"Authorization"</span><span class="p">:</span> <span class="sa">f</span><span class="s2">"Bearer </span><span class="si">{</span><span class="n">Token</span><span class="o">.</span><span class="n">text</span><span class="si">}</span><span class="s2">"</span><span class="p">})</span> <span class="k">if</span> <span class="mi">200</span> <span class="o"><=</span> <span class="n">Token</span><span class="o">.</span><span class="n">status_code</span> <span class="o"><=</span> <span class="mi">299</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Sessao</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="n">Token</span><span class="o">.</span><span class="n">status_code</span> <span class="bp">self</span><span class="o">.</span><span class="n">Sessao</span><span class="o">.</span><span class="n">token</span> <span class="o">=</span> <span class="n">Token</span><span class="o">.</span><span class="n">text</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">Sessao</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critico</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Erro ao autenticar API: </span><span class="si">{</span><span class="n">Token</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s2"> - </span><span class="si">{</span><span class="n">Token</span><span class="o">.</span><span class="n">text</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critico</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Falha ao autenticar API: </span><span class="si">{</span><span class="n">Err</span><span class="si">}</span><span class="s2">. URL: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">Url</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">endpoint_json</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">metodo</span><span class="p">,</span> <span class="n">payload</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="c1"># Interage com End Point</span> <span class="bp">self</span><span class="o">.</span><span class="n">ult_tempo_req</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">Metodo</span> <span class="o">=</span> <span class="n">metodo</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="c1">#self.EndPoint = self.Url + endpoint</span> <span class="bp">self</span><span class="o">.</span><span class="n">EndPoint</span> <span class="o">=</span> <span class="n">endpoint</span> <span class="bp">self</span><span class="o">.</span><span class="n">Payload</span> <span class="o">=</span> <span class="n">payload</span> <span class="n">MetodosAceitos</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'post'</span><span class="p">,</span> <span class="s1">'get'</span><span class="p">,</span> <span class="s1">'patch'</span><span class="p">,</span> <span class="s1">'put'</span><span class="p">]</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span><span class="n">element</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">Metodo</span> <span class="k">for</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">MetodosAceitos</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critico</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Método </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">Metodo</span><span class="si">}</span><span class="s1"> não previsto. Abortando chamada!'</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="n">ChamadaApi</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'self.Sessao.</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">Metodo</span><span class="si">}</span><span class="s1">(self.EndPoint, timeout=self.Timeout, headers=self.Headers, verify=self.Verify)'</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">Payload</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="sa">f</span><span class="s1">'self.Sessao.</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">Metodo</span><span class="si">}</span><span class="s1">(self.EndPoint, timeout=self.Timeout, headers=self.Headers, verify=self.Verify, json=self.Payload)'</span> <span class="bp">self</span><span class="o">.</span><span class="n">controla_cadencia</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">TempoUltReq</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="k">try</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">RetEndPoint</span> <span class="o">=</span> <span class="nb">eval</span><span class="p">(</span><span class="n">ChamadaApi</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">RetEndPoint</span><span class="o">.</span><span class="n">status_code</span> <span class="o">>=</span> <span class="mi">500</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critico</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Erro </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">RetEndPoint</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s1"> na chamada do endpoint: </span><span class="si">{</span><span class="n">Err</span><span class="si">}</span><span class="se">\n</span><span class="s1">Endpoint: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">EndPoint</span><span class="si">}</span><span class="se">\n</span><span class="s1">Resposta: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">RetEndPoint</span><span class="o">.</span><span class="n">text</span><span class="si">}</span><span class="s1">'</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">RetEndPoint</span><span class="o">.</span><span class="n">Espera</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">Espera</span> <span class="c1">## adiona o tempo de espera ao retorno da API</span> <span class="bp">self</span><span class="o">.</span><span class="n">RetEndPoint</span><span class="o">.</span><span class="n">Intervalo</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">Intervalo</span> <span class="c1">## adiciona o intervalo entre chamada ao retorno da API </span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">RetEndPoint</span> <span class="k">except</span> <span class="n">requests</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ReadTimeout</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critico</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Excedido tempo limite </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">Timeout</span><span class="si">}</span><span class="s1"> para retorno do endpoint: </span><span class="si">{</span><span class="n">Err</span><span class="si">}</span><span class="se">\n</span><span class="s1">Endpoint: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">EndPoint</span><span class="si">}</span><span class="s1">'</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critico</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Falha na chamada do endpoint: </span><span class="si">{</span><span class="n">Err</span><span class="si">}</span><span class="se">\n</span><span class="s1">Endpoint: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">EndPoint</span><span class="si">}</span><span class="se">\n</span><span class="s1">Codigo retorno: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">RetEndPoint</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="se">\n</span><span class="s1">Resposta:</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">RetEndPoint</span><span class="o">.</span><span class="n">text</span><span class="si">}</span><span class="s1">'</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">trata_erro_sienge</span><span class="p">(</span><span class="n">CodRet</span><span class="p">,</span> <span class="n">Retorno</span><span class="p">):</span> <span class="k">if</span> <span class="ow">not</span> <span class="mi">200</span> <span class="o"><=</span> <span class="n">CodRet</span> <span class="o"><=</span> <span class="mi">299</span><span class="p">:</span> <span class="k">try</span><span class="p">:</span> <span class="n">DicRetorno</span> <span class="o">=</span> <span class="nb">eval</span><span class="p">(</span><span class="n">Retorno</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'null'</span><span class="p">,</span><span class="s1">'None'</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">r</span><span class="s1">'\n\t'</span><span class="p">,</span><span class="s1">' '</span><span class="p">))</span> <span class="k">if</span> <span class="s1">'clientMessage'</span> <span class="ow">in</span> <span class="n">DicRetorno</span> <span class="ow">and</span> <span class="n">DicRetorno</span><span class="p">[</span><span class="s1">'clientMessage'</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'None'</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="s1">''</span><span class="p">,</span> <span class="s1">' '</span><span class="p">,</span> <span class="s1">'null'</span><span class="p">]:</span> <span class="n">MsgErro</span> <span class="o">=</span> <span class="n">DicRetorno</span><span class="p">[</span><span class="s1">'clientMessage'</span><span class="p">]</span> <span class="k">elif</span> <span class="s1">'developerMessage'</span> <span class="ow">in</span> <span class="n">DicRetorno</span> <span class="ow">and</span> <span class="n">DicRetorno</span><span class="p">[</span><span class="s1">'developerMessage'</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'None'</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="s1">''</span><span class="p">,</span> <span class="s1">' '</span><span class="p">,</span> <span class="s1">'null'</span><span class="p">]:</span> <span class="n">MsgErro</span> <span class="o">=</span> <span class="n">DicRetorno</span><span class="p">[</span><span class="s1">'developerMessage'</span><span class="p">]</span> <span class="k">elif</span> <span class="s1">'message'</span> <span class="ow">in</span> <span class="n">DicRetorno</span> <span class="ow">and</span> <span class="n">DicRetorno</span><span class="p">[</span><span class="s1">'message'</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'None'</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="s1">''</span><span class="p">,</span> <span class="s1">' '</span><span class="p">,</span> <span class="s1">'null'</span><span class="p">]:</span> <span class="n">MsgErro</span> <span class="o">=</span> <span class="n">DicRetorno</span><span class="p">[</span><span class="s1">'message'</span><span class="p">]</span> <span class="k">else</span><span class="p">:</span> <span class="n">MsgErro</span> <span class="o">=</span> <span class="n">Retorno</span> <span class="k">except</span><span class="p">:</span> <span class="n">MsgErro</span> <span class="o">=</span> <span class="n">Retorno</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="sa">r</span><span class="s1">'\n\t'</span><span class="p">,</span><span class="s1">' '</span><span class="p">)</span> <span class="k">finally</span><span class="p">:</span> <span class="k">return</span> <span class="n">MsgErro</span> <span class="k">else</span><span class="p">:</span> <span class="k">return</span> <span class="n">Retorno</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1"># Encerra a cessão</span> <span class="bp">self</span><span class="o">.</span><span class="n">Sessao</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</div>
auth_EntraID
<div class="doc doc-contents ">
<h6 id="lbxtoolkit.auth_EntraID--classe-auth_entraid">Classe <strong>auth_EntraID</strong></h6>
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.
Essa classe possui apenas dois métodos:
-
auth_EntraID.disclaimer(): apenas exibe uma tela de informações/instruções ao usuário. -
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 argumentostimeoutelog_filesão opcionais e, se omitidos, os valores aqui atribuídos serão adotados como padrão.
É necessário obter parametros da plataforma de identidade da Microsoft (AD Azure, agora Microsoft Entra ID), no Centro de administração do Microsoft Entra.
Sugerimos não armazenar estas ou outras informações sensíveis no script. Considere usar o pacote dotenv para isso.
Os argumentos obrigatórios (posicionais) são:
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
2) client_id corresponde ao ID do aplicativo (cliente), obtido na secção Identidade > Aplicativos > Registros de Aplicativo. Considere não reaproveitar aplicativos e criar um específico para essa finalidade.
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.
from lbx_toolkit import auth_EntraIDclient_id = 'SEU_CLIENT_ID' client_secret = 'SEU_CLIENT_SECRET' tenant_id = 'SEU_TENANT_ID'
inicializa instância
auth = auth_EntraID(client_id, client_secret, tenant_id, timeout=60, log_file='auth_EntraID.log')
exibe a mensagem padrão de aviso
auth.disclaimer()
auth.valida_grupo('Nome do Grupo de Distribuição')
se usuário não pertencer a grupo informado, a execução do script é abortada.
<details class="quote">
<summary>Source code in <code>lbxtoolkit\__init__.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">100</span>
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
class auth_EntraID: # Classe de autenticação de usuários no Microsoft Entra ID (antiga Azure AD) """ #### Classe auth_EntraIDEste 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.
Essa classe possui apenas dois métodos:
-
auth_EntraID.disclaimer(): apenas exibe uma tela de informações/instruções ao usuário.-
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 argumentostimeoutelog_filesão opcionais e, se omitidos, os valores aqui atribuídos serão adotados como padrão.É necessário obter parametros da plataforma de identidade da Microsoft (AD Azure, agora Microsoft Entra ID), no Centro de administração do Microsoft Entra. Sugerimos não armazenar estas ou outras informações sensíveis no script. Considere usar o pacote
dotenvpara isso.Os argumentos obrigatórios (posicionais) são:
1)
tenant_idcorresponde ao campo ID do Locatário, que pode ser obtido na página visão geral de identidade do domínio2)
client_idcorresponde ao ID do aplicativo (cliente), obtido na secção Identidade > Aplicativos > Registros de Aplicativo. Considere não reaproveitar aplicativos e criar um específico para essa finalidade.3)
secret_idcorresponde 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.``` from lbx_toolkit import auth_EntraID
client_id = 'SEU_CLIENT_ID' client_secret = 'SEU_CLIENT_SECRET' tenant_id = 'SEU_TENANT_ID'
# inicializa instância auth = auth_EntraID(client_id, client_secret, tenant_id, timeout=60, log_file='auth_EntraID.log')
# exibe a mensagem padrão de aviso auth.disclaimer()
auth.valida_grupo('Nome do Grupo de Distribuição') # se usuário não pertencer a grupo informado, a execução do script é abortada. ``` """ def init(self, client_id, client_secret, tenant_id, grupo, timeout=60, log_file='auth_EntraID.log'): self.client_id = client_id self.client_secret = client_secret self.tenant_id = tenant_id self.timeout = timeout self.grupo = grupo self.authority = f"https://login.microsoftonline.com/{self.tenant_id}" self.scope = ["https://graph.microsoft.com/.default"] self.redirect_uri = "http://localhost:8000" self.response = "" self.status_code = 0 self.server = None self.log_file = log_file
<span class="c1"># Configura o logger</span> <span class="n">logging</span><span class="o">.</span><span class="n">basicConfig</span><span class="p">(</span><span class="n">filename</span><span class="o">=</span><span class="n">log_file</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">'</span><span class="si">%(asctime)s</span><span class="s1"> - </span><span class="si">%(name)s</span><span class="s1"> - </span><span class="si">%(levelname)s</span><span class="s1"> - </span><span class="si">%(message)s</span><span class="s1">'</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">valida_grupo</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1"># Valida se o usuário autenticado pertence a grupo de segurança informado</span> <span class="c1"># Redireciona stdout e stderr para arquivos de log</span> <span class="n">original_stdout</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="n">original_stderr</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'stdout.log'</span><span class="p">,</span> <span class="s1">'a'</span><span class="p">)</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'stderr.log'</span><span class="p">,</span> <span class="s1">'a'</span><span class="p">)</span> <span class="c1"># Configurações do Selenium</span> <span class="n">chrome_options</span> <span class="o">=</span> <span class="n">Options</span><span class="p">()</span> <span class="n">chrome_options</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--incognito"</span><span class="p">)</span> <span class="c1"># Inicializa a aplicação MSAL</span> <span class="k">try</span><span class="p">:</span> <span class="n">app</span> <span class="o">=</span> <span class="n">msal</span><span class="o">.</span><span class="n">ConfidentialClientApplication</span><span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">client_id</span><span class="p">,</span> <span class="n">authority</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">authority</span><span class="p">,</span> <span class="n">client_credential</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">client_secret</span><span class="p">,</span> <span class="p">)</span> <span class="k">except</span> <span class="ne">BaseException</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Falha ao iniciar aplicação MSAL: </span><span class="si">{</span><span class="n">err</span><span class="si">}</span><span class="s1">'</span><span class="p">)</span> <span class="c1"># Restaura saída padrão</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">original_stdout</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">original_stderr</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Script abortado por falha aplicação MSAL. Verifque logs: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="si">}</span><span class="s1">, stdout.log e sterr.log'</span><span class="p">)</span> <span class="n">os</span><span class="o">.</span><span class="n">_exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># Inicia o fluxo de código de autorização</span> <span class="k">try</span><span class="p">:</span> <span class="n">flow</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">initiate_auth_code_flow</span><span class="p">(</span><span class="n">scopes</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">scope</span><span class="p">,</span> <span class="n">redirect_uri</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">redirect_uri</span><span class="p">)</span> <span class="n">auth_url</span> <span class="o">=</span> <span class="n">flow</span><span class="p">[</span><span class="s2">"auth_uri"</span><span class="p">]</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Acessando a URL de autenticação Microsoft Entra ID (antiga Azure AD): </span><span class="si">{</span><span class="n">auth_url</span><span class="si">}</span><span class="s2">"</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">response</span><span class="p">)</span> <span class="k">except</span> <span class="ne">BaseException</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Falha no fluxo de autorização Microsoft Entra ID (antiga Azure AD): </span><span class="si">{</span><span class="n">err</span><span class="si">}</span><span class="s1">'</span><span class="p">)</span> <span class="c1"># Restaura saída padrão</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">original_stdout</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">original_stderr</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Script abortado por falha no fluxo de autorização Microsoft Entra ID (antiga Azure AD). Verifque logs: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="si">}</span><span class="s1">, stdout.log e sterr.log'</span><span class="p">)</span> <span class="n">os</span><span class="o">.</span><span class="n">_exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># Inicializa o ChromeDriver com redirecionamento de saída</span> <span class="k">try</span><span class="p">:</span> <span class="n">service</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="n">ChromeDriverManager</span><span class="p">()</span><span class="o">.</span><span class="n">install</span><span class="p">())</span> <span class="n">service</span><span class="o">.</span><span class="n">start</span><span class="p">()</span> <span class="n">driver</span> <span class="o">=</span> <span class="n">webdriver</span><span class="o">.</span><span class="n">Chrome</span><span class="p">(</span><span class="n">service</span><span class="o">=</span><span class="n">service</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">chrome_options</span><span class="p">)</span> <span class="n">driver</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">auth_url</span><span class="p">)</span> <span class="k">except</span> <span class="ne">BaseException</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Falha na inicialização do Chrome: </span><span class="si">{</span><span class="n">err</span><span class="si">}</span><span class="s1">'</span><span class="p">)</span> <span class="c1"># Restaura saída padrão</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">original_stdout</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">original_stderr</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Script abortado na inicialização do Chrome. Verifque logs: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file</span><span class="si">}</span><span class="s1">, stdout.log e sterr.log'</span><span class="p">)</span> <span class="n">os</span><span class="o">.</span><span class="n">_exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">class</span> <span class="nc">AuthHandler</span><span class="p">(</span><span class="n">BaseHTTPRequestHandler</span><span class="p">):</span> <span class="k">def</span> <span class="nf">log_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">format</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> - - [</span><span class="si">%s</span><span class="s2">] </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">client_address</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_date_time_string</span><span class="p">(),</span> <span class="nb">format</span> <span class="o">%</span> <span class="n">args</span><span class="p">))</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">do_GET</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="n">parsed_path</span> <span class="o">=</span> <span class="n">urlparse</span><span class="o">.</span><span class="n">urlparse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span> <span class="n">query_params</span> <span class="o">=</span> <span class="n">urlparse</span><span class="o">.</span><span class="n">parse_qs</span><span class="p">(</span><span class="n">parsed_path</span><span class="o">.</span><span class="n">query</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">send_response</span><span class="p">(</span><span class="mi">200</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">send_header</span><span class="p">(</span><span class="s1">'Content-type'</span><span class="p">,</span> <span class="s1">'text/html'</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">end_headers</span><span class="p">()</span> <span class="c1"># Captura o código de autorização e o estado</span> <span class="k">if</span> <span class="s1">'code'</span> <span class="ow">in</span> <span class="n">query_params</span> <span class="ow">and</span> <span class="s1">'state'</span> <span class="ow">in</span> <span class="n">query_params</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">auth_code</span> <span class="o">=</span> <span class="n">query_params</span><span class="p">[</span><span class="s1">'code'</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">state</span> <span class="o">=</span> <span class="n">query_params</span><span class="p">[</span><span class="s1">'state'</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="bp">self</span><span class="o">.</span><span class="n">wfile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="sa">b</span><span class="s2">"""</span><!DOCTYPE html> <html lang="pt_BR"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <style> body { font-family: 'Arial', sans-serif; background-color: #f8f9fa; margin: 0; font-size: 16px; padding: 30px; display: flex; * }
.container { width: 100%; margin: auto; background-color: #ffffff; box-shadow: 0 0 10px rgba(0, 0, 0, 0.1); padding: 16px; text-align: center; font-size: 16px; border-radius: 8px; }
h1 { font-size: 18px; text-align: center; color: #007bff; } </style> </head> <div class="container"> <h1>Autenticação realizada com sucesso!</h1> Aguarde que esta página será fechada automaticamente.<br> Se isto não acontecer, pode fechá-la manualmente. </div> </body></html> """) else: self.wfile.write(b""" <!DOCTYPE html> <html lang="pt_BR"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <style> body { font-family: 'Arial', sans-serif; background-color: #f8f9fa; margin: 0; font-size: 16px; padding: 30px; display: flex; * }
.container { width: 100%; margin: auto; background-color: #ffffff; box-shadow: 0 0 10px rgba(0, 0, 0, 0.1); padding: 16px; text-align: center; font-size: 16px; border-radius: 8px; }
h1 { font-size: 18px; text-align: center; color: red; } </style> </head> <div class="container"> <h1>Falha na autenticação!</h1> Esta página será fechada automaticamente.<br> Se isto não acontecer, pode fechá-la manualmente. </div> </body></html> """) # # # Inicializa o servidor HTTP self.server = HTTPServer(('localhost', 8000), AuthHandler) self.server.logger = self.logger # Passa o logger para o servidor
<span class="c1"># Função para monitorar o tempo limite</span> <span class="k">def</span> <span class="nf">monitor_timeout</span><span class="p">():</span> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">)</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="p">,</span> <span class="s1">'auth_code'</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="s2">"tempo limite para autenticação foi excedido"</span> <span class="bp">self</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="mi">490</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">response</span><span class="p">)</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">original_stdout</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">original_stderr</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Código retorno: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s1"> '</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span> <span class="c1">## 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.</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Resposta: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">response</span><span class="si">}</span><span class="s1">'</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">'</span><span class="se">\n\n</span><span class="s1">'</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'Falha na autenticação! Execução abortada!'</span><span class="p">)</span> <span class="n">driver</span><span class="o">.</span><span class="n">quit</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">server_close</span><span class="p">()</span> <span class="n">os</span><span class="o">.</span><span class="n">_exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="c1"># Inicia a thread para monitorar o tempo limite</span> <span class="n">timeout_thread</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="p">(</span><span class="n">target</span><span class="o">=</span><span class="n">monitor_timeout</span><span class="p">)</span> <span class="n">timeout_thread</span><span class="o">.</span><span class="n">start</span><span class="p">()</span> <span class="c1"># Espera pelo código de autorização</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="s2">"Esperando pela autenticação..."</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">response</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">handle_request</span><span class="p">()</span> <span class="c1"># Restaura stdout e stderr</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">original_stdout</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">original_stderr</span> <span class="c1"># Verifica se o código de autorização foi obtido dentro do tempo limite</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="p">,</span> <span class="s1">'auth_code'</span><span class="p">):</span> <span class="k">return</span> <span class="c1"># Obtém o código de autorização e o estado capturados pelo servidor HTTP</span> <span class="n">auth_code</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">auth_code</span> <span class="n">state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">state</span> <span class="c1"># Adquire o token usando o código de autorização, verificando o estado</span> <span class="k">try</span><span class="p">:</span> <span class="n">result</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">acquire_token_by_auth_code_flow</span><span class="p">(</span><span class="n">flow</span><span class="p">,</span> <span class="p">{</span><span class="s2">"code"</span><span class="p">:</span> <span class="n">auth_code</span><span class="p">,</span> <span class="s2">"state"</span><span class="p">:</span> <span class="n">state</span><span class="p">})</span> <span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Erro ao obter o token de acesso: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">"</span> <span class="bp">self</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="mi">401</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">response</span><span class="p">)</span> <span class="n">driver</span><span class="o">.</span><span class="n">quit</span><span class="p">()</span> <span class="k">return</span> <span class="k">if</span> <span class="s2">"access_token"</span> <span class="ow">in</span> <span class="n">result</span><span class="p">:</span> <span class="n">access_token</span> <span class="o">=</span> <span class="n">result</span><span class="p">[</span><span class="s1">'access_token'</span><span class="p">]</span> <span class="n">headers</span> <span class="o">=</span> <span class="p">{</span> <span class="s1">'Authorization'</span><span class="p">:</span> <span class="s1">'Bearer '</span> <span class="o">+</span> <span class="n">access_token</span> <span class="p">}</span> <span class="c1"># Obtém o email do usuário autenticado</span> <span class="n">me_response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> <span class="s1">'https://graph.microsoft.com/v1.0/me'</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span> <span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="n">me_response</span><span class="o">.</span><span class="n">status_code</span> <span class="k">if</span> <span class="n">me_response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span> <span class="n">me_data</span> <span class="o">=</span> <span class="n">me_response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span> <span class="n">user_email</span> <span class="o">=</span> <span class="n">me_data</span><span class="p">[</span><span class="s1">'userPrincipalName'</span><span class="p">]</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Email do usuário autenticado: </span><span class="si">{</span><span class="n">user_email</span><span class="si">}</span><span class="s2">"</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">response</span><span class="p">)</span> <span class="c1"># Verifica se o usuário pertence ao grupo</span> <span class="n">group_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">grupo</span> <span class="c1"># Obtém o ID do usuário</span> <span class="n">user_response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> <span class="sa">f</span><span class="s1">'https://graph.microsoft.com/v1.0/users/</span><span class="si">{</span><span class="n">user_email</span><span class="si">}</span><span class="s1">'</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span> <span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="n">user_response</span><span class="o">.</span><span class="n">status_code</span> <span class="k">if</span> <span class="n">user_response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span> <span class="n">user_data</span> <span class="o">=</span> <span class="n">user_response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span> <span class="n">user_id</span> <span class="o">=</span> <span class="n">user_data</span><span class="p">[</span><span class="s1">'id'</span><span class="p">]</span> <span class="c1"># Pesquisa o grupo pelo nome</span> <span class="n">group_response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> <span class="sa">f</span><span class="s2">"https://graph.microsoft.com/v1.0/groups?$filter=displayName eq '</span><span class="si">{</span><span class="n">group_name</span><span class="si">}</span><span class="s2">'"</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span> <span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="n">group_response</span><span class="o">.</span><span class="n">status_code</span> <span class="k">if</span> <span class="n">group_response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span> <span class="n">group_data</span> <span class="o">=</span> <span class="n">group_response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span> <span class="k">if</span> <span class="s1">'value'</span> <span class="ow">in</span> <span class="n">group_data</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">group_data</span><span class="p">[</span><span class="s1">'value'</span><span class="p">])</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> <span class="n">group_id</span> <span class="o">=</span> <span class="n">group_data</span><span class="p">[</span><span class="s1">'value'</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="s1">'id'</span><span class="p">]</span> <span class="c1"># Verifica se o usuário está no grupo</span> <span class="n">members_response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> <span class="sa">f</span><span class="s1">'https://graph.microsoft.com/v1.0/groups/</span><span class="si">{</span><span class="n">group_id</span><span class="si">}</span><span class="s1">/members'</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span> <span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="n">members_response</span><span class="o">.</span><span class="n">status_code</span> <span class="k">if</span> <span class="n">members_response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span> <span class="n">members_data</span> <span class="o">=</span> <span class="n">members_response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span> <span class="k">if</span> <span class="s1">'value'</span> <span class="ow">in</span> <span class="n">members_data</span><span class="p">:</span> <span class="n">user_in_group</span> <span class="o">=</span> <span class="nb">any</span><span class="p">(</span><span class="n">member</span><span class="p">[</span><span class="s1">'id'</span><span class="p">]</span> <span class="o">==</span> <span class="n">user_id</span> <span class="k">for</span> <span class="n">member</span> <span class="ow">in</span> <span class="n">members_data</span><span class="p">[</span><span class="s1">'value'</span><span class="p">])</span> <span class="k">if</span> <span class="n">user_in_group</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"O usuário </span><span class="si">{</span><span class="n">user_email</span><span class="si">}</span><span class="s2"> liberado para uso desta aplicação."</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"O usuário </span><span class="si">{</span><span class="n">user_email</span><span class="si">}</span><span class="s2"> NÃO liberado para uso desta aplicação. Solicite acesso à TI."</span> <span class="bp">self</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="mi">299</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="s2">"Resposta da API de membros não contém a chave 'value'."</span> <span class="bp">self</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="mi">460</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Erro na resposta da API de membros: </span><span class="si">{</span><span class="n">members_response</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s2">"</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">+=</span> <span class="sa">f</span><span class="s2">"</span><span class="se">\n</span><span class="si">{</span><span class="n">members_response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="si">}</span><span class="s2">"</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Grupo '</span><span class="si">{</span><span class="n">group_name</span><span class="si">}</span><span class="s2">' não encontrado."</span> <span class="bp">self</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="mi">470</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Erro na resposta da API de grupos: </span><span class="si">{</span><span class="n">group_response</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s2">"</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">+=</span> <span class="sa">f</span><span class="s2">"</span><span class="se">\n</span><span class="si">{</span><span class="n">group_response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="si">}</span><span class="s2">"</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Erro na resposta da API de usuário: </span><span class="si">{</span><span class="n">user_response</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s2">"</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">+=</span> <span class="sa">f</span><span class="s2">"</span><span class="se">\n</span><span class="si">{</span><span class="n">user_response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="si">}</span><span class="s2">"</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Erro ao obter informações do usuário: </span><span class="si">{</span><span class="n">me_response</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s2">"</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">+=</span> <span class="sa">f</span><span class="s2">"</span><span class="se">\n</span><span class="si">{</span><span class="n">me_response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="si">}</span><span class="s2">"</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Erro ao obter o token de acesso: </span><span class="si">{</span><span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'error'</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span> <span class="bp">self</span><span class="o">.</span><span class="n">response</span> <span class="o">+=</span> <span class="sa">f</span><span class="s2">"</span><span class="se">\n</span><span class="si">{</span><span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'error_description'</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span> <span class="bp">self</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="mi">480</span> <span class="c1"># Fecha o navegador</span> <span class="n">driver</span><span class="o">.</span><span class="n">quit</span><span class="p">()</span> <span class="n">service</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span> <span class="c1"># Define o retorno</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Código retorno: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s1"> '</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span> <span class="c1">## 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.</span> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Resposta: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">response</span><span class="si">}</span><span class="s1">'</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">'</span><span class="se">\n\n</span><span class="s1">'</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'Acesso autorizado!'</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'Permissões inválidas! Execução abortada!'</span><span class="p">)</span> <span class="n">os</span><span class="o">.</span><span class="n">_exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">disclaimer</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1"># Mostra o aviso do funcionamento e necessidade de autenticação</span> <span class="nb">input</span><span class="p">(</span><span class="sa">f</span><span class="s2">"""</span>Para ser utilizado de forma adequada e segura, este script requer autenticação no Microsoft Entra ID (antiga Azure AD). 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.
Para continuar, é necessário fornecer suas credenciais, aquelas que costumeiramente utiliza para acessar os serviços de e-mail corporativo. Uma janela de navegador será aberta e você será direcionado à tela de Logon do Microsoft Entra ID. Faça o Logon fornecendo usuário, senha e validação de duplo fator (no autenticador da Microsoft, instalado em seu celular). Após a autenticação, a janela do navegador será fechada e o script iniciará o processo de execução.
Você tem {self.timeout} segundos para realizar a autenticação ou a execução será abortada.
Tecle [ENTER] para continuar ...
""")
</div>
lbx_logger
<div class="doc doc-contents ">
<h6 id="lbxtoolkit.lbx_logger--classe-lbx_logger">Classe <strong>lbx_logger</strong></h6>
Essa classe requer a importação do módulo logging no script em que for instanciada e tem o propósito de manipular/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.
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.
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)
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.
A classe deve ser instanciada conforme sintaxe abaixo:
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):
Todos os parametros são nominativos e facultativos. Em caso de omissão, os valores padrão são assumidos conforme o exemplo acima.
Os parametros para o instanciamento da classe são:
log_file_pathDefine o caminho e o nome do arquivo de log. Se omisso, as mensagens serão todas direcionadas apenas para a tela.log_levelDefine 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:logging.DEBUGpara manipular chamadas do método .debug() e acima.logging.INFOpara manipular chamadas do método .info() e acima.logging.WARNINGpara manipular chamadas do método .aviso() e acima.logging.ERRORpara manipular chamadas do método .erro() e acima.logging.CRITICALpara manipular chamadas do método .critico() e acima.formato_logDefine o formato em que a mensagem será apresentada. Se omisso, o padrá é DATA_HORA - NIVEL - MENSAGEM. Para maiores opções veja: Atributos de logmoduloNome 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.ignore_consoleLista com os níveis de severidade a serem ignorados para apresentação na tela, registrando apenas no arquivo (quando informado no parametrolog_file_path) e obedecendo ao nível mínimo estabelecido no parametrolog_level. Note que omitir o parametrolog_file_pathe incluir um nível na lsitaignore_consoleimplica em ignorar/suprimir esse nível de mensagem de qualquer apresentação.ignore_fileMesma lógica do parametroignore_console, mas com lógica invertida: suprime o registro do nível do arquivo e demonstra apenas na tela.
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:
log.erro('Essa mensagem apenas resulta em uma mensagem de nível ERROR')
log.erro('Essa mensagem resulta em uma mensagem de nível ERRO e encerra o script com código de retorno -1', exit=-1)
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.
Para retornar ao comportamente padrão do comando print, ou interromper o manipulador, faça chamada ao método .stop_logging()
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:
log.add('Mensagem 1# ') ## não será exibida/registrada
log.add('Mensagem 2# ') ## não será exibida/registrada
log.info('Mensagem 3) ## será exibida/registrada como nível "info" e com texto: "Mensagem 1# Mensagem 2# Mensagem 3"
3) Os métodos que exibem as mensagens (.debug(),.info(),.aviso(), .erro(), .critico()) possuem 3 parametros: message, corte=None, exit=None.
message: posicional e obrigatório. corresponde à mensagem a ser exibidacorte: o tamanho máximo da mensagem a ser exibida. opcional e se omitido, exibe a mensagem inteira. se fornecido, corta a mensagem no comprimento informadoexit: 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
4) O método .filtra() possui 3 parametros posicionais, todos opcionais: log_file, dh_ini, dh_fim.
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.
Caso queira filtrar os registro de outro arquivo de log, que não seja o do script corrente, informe o endereço do arquivo no primeiro parametro.
E caso queira alterar alterar o período de filtragem, informe nos parametros 2 e 3 a data/hora de início e fim do período. Estes dois parametros aceitam tanto um objeto do tipo datetime como uma string (que será convertida para datetime), desde que ela esteja no formato dd/mm/aaaa hh:mm:[ss] (segundos são opcionais).
Considerando que os parametros são posicionais, caso queira omitir apenas um dos parametros, preencha a posição do parametro a ser omitido com None.
A saída dessa função retorna um objeto, que pode ser salvo em disco ou impresso na tela.
5) Exemplos de uso:
from lbx_toolkit import lbx_logger import logging import os from pathlib import PathDirBase = Path('./') # diretório corrente do script BaseName = os.path.splitext(os.path.basename(file))[0] # nome do script sem extensão LogFile = Path(DirBase, BaseName + '.log') # salva logs no diretório corrente, em um arquivo nomeado com nome do script + extensão ".log"
instancia o manipulador para tratar todas as mensagens (nível DEBUG acima),
mas suprime a apresentação em tela das mensagens de nível "DEBUG" na tela,
apenas registrando-as somente no arquivo
e sumprime o registro no arquivo das mensagens de nível "ERROR",
mostrando-as apenas na tela
log = lbx_logger(LogFile, logging.DEBUG, ignore_console=[logging.DEBUG], ignore_file=[logging.ERROR])
Exemplo de mensagens de log
log.debug('Esta é uma mensagem de debug') log.info('Esta é uma mensagem informativa') log.add('Esta mensagem não será exibida agora, mas acumulada no buffer# ') log.aviso('Esta é uma mensagem de aviso') log.erro('Esta é uma mensagem de erro') log.erro('Esta é uma mensagem erro muito comprida e será limitada a 40 caracteres, o restante será cortado e ingorado ao ser manipulado', 40) log.critico('Esta é uma mensagem crítica')
Exemplo de função que gera uma exceção
def funcao_com_erro(): raise ValueError('Este é um erro de exemplo')
Testando redirecionamento de print e captura de exceção
print('Mensagem de teste via print') try: funcao_com_erro() except Exception as e: print(f'Capturado um erro: {e}')
log.erro('Essa é uma mensagem de erro e abortará a execução do script', exit=1)
log.info('Essa mensagem não será exibida pois o script foi abortado na mensagem anterior')
obtem os registros de log da última hora (comportamento padrão)
filtra_log = log.search()
obtem os registros das últimas 6 horas
ultimas_6h = datetime.datetime.now() - datetime.timedelta(hours=6) ## carimbo de tempo de 6 horas atrás !!! requer>> import datetime filtra_log = log.search(None, ultimas_6h) # None no 1º parametro impõe o log do arquivo corrente como padrão (definido em 'LogFile' e apontado no instanciamento da classe)
obtem os registros do dia 14/01/2020 até 3h atrás
ultimas_3h = datetime.datetime.now() - datetime.timedelta(hours=3) ## carimbo de tempo de 6 horas atrás !!! requer>> import datetime filtra_log = log.search(None, '14/01/2020 00:00', ultimas_3h) #
obtem os registros do horário comercial do dia 23/12/2023 do arquivo salvo em C:\temp\outro_arquivo.log
Outro_Log = Path(r'c:\temp\outro_arquivo.log') filtra_log = log.search(Outro_Log, '23/12/2023 08:00', '23/12/2023 18:00') #
salva conteúdo filtrado em um arquivo:
filtrado = 'filtered_log.txt' with open(filtado, 'w', encoding='ISO-8859-1') as output_file: # indique o enconding conforme salvo (UTF-8 ou ISO-8859-1) output_file.writelines(filta_log)
mostra o conteúdo filtrado na tela
print(''.join(filtra_log))
mostra o conteúdo filtrado na tela, listando apenas as os registros do nível "DEBUG"
for line in filtered_lines: if "DEBUG" in line: print(line, end='')
<details class="quote">
<summary>Source code in <code>lbxtoolkit\__init__.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 906</span>
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
class lbx_logger: # Classe para gerenciar a saída para log r""" #### Classe lbx_loggerEssa classe requer a importação do módulo
loggingno script em que for instanciada e tem o propósito de manipular/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.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.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)
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.
A classe deve ser instanciada conforme sintaxe abaixo:
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):Todos os parametros são nominativos e facultativos. Em caso de omissão, os valores padrão são assumidos conforme o exemplo acima.
Os parametros para o instanciamento da classe são:
-
log_file_pathDefine o caminho e o nome do arquivo de log. Se omisso, as mensagens serão todas direcionadas apenas para a tela. -log_levelDefine 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: -logging.DEBUGpara manipular chamadas do método .debug() e acima. -logging.INFOpara manipular chamadas do método .info() e acima. -logging.WARNINGpara manipular chamadas do método .aviso() e acima. -logging.ERRORpara manipular chamadas do método .erro() e acima. -logging.CRITICALpara manipular chamadas do método .critico() e acima. -formato_logDefine o formato em que a mensagem será apresentada. Se omisso, o padrá é DATA_HORA - NIVEL - MENSAGEM. Para maiores opções veja: Atributos de log -moduloNome 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. -ignore_consoleLista com os níveis de severidade a serem ignorados para apresentação na tela, registrando apenas no arquivo (quando informado no parametrolog_file_path) e obedecendo ao nível mínimo estabelecido no parametrolog_level. Note que omitir o parametrolog_file_pathe incluir um nível na lsitaignore_consoleimplica em ignorar/suprimir esse nível de mensagem de qualquer apresentação. -ignore_fileMesma lógica do parametroignore_console, mas com lógica invertida: suprime o registro do nível do arquivo e demonstra apenas na tela.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âmetroexit. 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:
</span> <span class="sd"> log.erro('Essa mensagem apenas resulta em uma mensagem de nível ERROR')</span> <span class="sd"> log.erro('Essa mensagem resulta em uma mensagem de nível ERRO e encerra o script com código de retorno -1', exit=-1)</span> <span class="sd">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. Para retornar ao comportamente padrão do comando print, ou interromper o manipulador, faça chamada ao método.stop_logging()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:
</span> <span class="sd"> log.add('Mensagem 1# ') ## não será exibida/registrada</span> <span class="sd"> log.add('Mensagem 2# ') ## não será exibida/registrada</span> <span class="sd"> log.info('Mensagem 3) ## será exibida/registrada como nível "info" e com texto: "Mensagem 1# Mensagem 2# Mensagem 3"</span> <span class="sd">3) Os métodos que exibem as mensagens (
.debug(),.info(),.aviso(),.erro(),.critico()) possuem 3 parametros:message,corte=None,exit=None.-
message: posicional e obrigatório. corresponde à mensagem a ser exibida -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 -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 script4) O método
.filtra()possui 3 parametros posicionais, todos opcionais:log_file,dh_ini,dh_fim.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 paradh_fiménow()e paradh_iniénow()menos 1 hora.Caso queira filtrar os registro de outro arquivo de log, que não seja o do script corrente, informe o endereço do arquivo no primeiro parametro.
E caso queira alterar alterar o período de filtragem, informe nos parametros 2 e 3 a data/hora de início e fim do período. Estes dois parametros aceitam tanto um objeto do tipo
datetimecomo uma string (que será convertida para datetime), desde que ela esteja no formatodd/mm/aaaa hh:mm:[ss](segundos são opcionais).Considerando que os parametros são posicionais, caso queira omitir apenas um dos parametros, preencha a posição do parametro a ser omitido com
None.A saída dessa função retorna um objeto, que pode ser salvo em disco ou impresso na tela.
5) Exemplos de uso:
``` from lbx_toolkit import lbx_logger import logging import os from pathlib import Path
DirBase = Path('./') # diretório corrente do script BaseName = os.path.splitext(os.path.basename(file))[0] # nome do script sem extensão LogFile = Path(DirBase, BaseName + '.log') # salva logs no diretório corrente, em um arquivo nomeado com nome do script + extensão ".log"
### instancia o manipulador para tratar todas as mensagens (nível DEBUG acima), # mas suprime a apresentação em tela das mensagens de nível "DEBUG" na tela, # apenas registrando-as somente no arquivo # e sumprime o registro no arquivo das mensagens de nível "ERROR", # mostrando-as apenas na tela log = lbx_logger(LogFile, logging.DEBUG, ignore_console=[logging.DEBUG], ignore_file=[logging.ERROR])
# Exemplo de mensagens de log log.debug('Esta é uma mensagem de debug') log.info('Esta é uma mensagem informativa') log.add('Esta mensagem não será exibida agora, mas acumulada no buffer# ') log.aviso('Esta é uma mensagem de aviso') log.erro('Esta é uma mensagem de erro') log.erro('Esta é uma mensagem erro muito comprida e será limitada a 40 caracteres, o restante será cortado e ingorado ao ser manipulado', 40) log.critico('Esta é uma mensagem crítica')
# Exemplo de função que gera uma exceção def funcao_com_erro(): raise ValueError('Este é um erro de exemplo')
# Testando redirecionamento de print e captura de exceção print('Mensagem de teste via print') try: funcao_com_erro() except Exception as e: print(f'Capturado um erro: {e}')
log.erro('Essa é uma mensagem de erro e abortará a execução do script', exit=1)
log.info('Essa mensagem não será exibida pois o script foi abortado na mensagem anterior')
# obtem os registros de log da última hora (comportamento padrão) filtra_log = log.search()
# obtem os registros das últimas 6 horas ultimas_6h = datetime.datetime.now() - datetime.timedelta(hours=6) ## carimbo de tempo de 6 horas atrás !!! requer>> import datetime filtra_log = log.search(None, ultimas_6h) # None no 1º parametro impõe o log do arquivo corrente como padrão (definido em 'LogFile' e apontado no instanciamento da classe)
# obtem os registros do dia 14/01/2020 até 3h atrás ultimas_3h = datetime.datetime.now() - datetime.timedelta(hours=3) ## carimbo de tempo de 6 horas atrás !!! requer>> import datetime filtra_log = log.search(None, '14/01/2020 00:00', ultimas_3h) #
# obtem os registros do horário comercial do dia 23/12/2023 do arquivo salvo em C:\temp\outro_arquivo.log Outro_Log = Path(r'c:\temp\outro_arquivo.log') filtra_log = log.search(Outro_Log, '23/12/2023 08:00', '23/12/2023 18:00') #
# salva conteúdo filtrado em um arquivo: filtrado = 'filtered_log.txt' with open(filtado, 'w', encoding='ISO-8859-1') as output_file: # indique o enconding conforme salvo (UTF-8 ou ISO-8859-1) output_file.writelines(filta_log)
# mostra o conteúdo filtrado na tela print(''.join(filtra_log))
# mostra o conteúdo filtrado na tela, listando apenas as os registros do nível "DEBUG" for line in filtered_lines: if "DEBUG" in line: print(line, end='') ``` """
class LevelFilter(logging.Filter):
def init(self, levels_to_ignore): self.levels_to_ignore = levels_to_ignore # # def filter(self, record): return record.levelno not in self.levels_to_ignore # # 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): self.ignore_file = [] if ignore_file is None else ignore_file
self.ignore_console = [] if ignore_console is None else ignore_console self.modulo = name if modulo is None else modulo self.logger = logging.getLogger(self.modulo) self.logger.setLevel(log_level) self.msg = '' self.log_file_path = log_file_path<span class="k">if</span> <span class="n">log_file_path</span><span class="p">:</span> <span class="c1"># Criando um handler para escrever em um arquivo de log</span> <span class="n">file_handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">FileHandler</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">log_file_path</span><span class="p">)</span> <span class="n">file_handler</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">log_level</span><span class="p">)</span> <span class="c1"># Sempre registrar tudo no arquivo</span> <span class="c1"># Criando um handler para exibir no console</span> <span class="n">console_handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">()</span> <span class="n">console_handler</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">log_level</span><span class="p">)</span> <span class="c1"># Registrar DEBUG e acima no console</span> <span class="c1"># Adicionando filtro para ignorar certos níveis no console e no arquivo</span> <span class="n">file_handler</span><span class="o">.</span><span class="n">addFilter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">LevelFilter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ignore_file</span><span class="p">))</span> <span class="n">console_handler</span><span class="o">.</span><span class="n">addFilter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">LevelFilter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ignore_console</span><span class="p">))</span> <span class="c1"># Definindo o formato das mensagens de log</span> <span class="n">formatter</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span><span class="n">formato_log</span><span class="p">)</span> <span class="n">file_handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">formatter</span><span class="p">)</span> <span class="n">console_handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">formatter</span><span class="p">)</span> <span class="c1"># Adicionando os handlers ao logger</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">file_handler</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">console_handler</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="c1"># Tudo direcionado para o console</span> <span class="n">console_handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">()</span> <span class="n">console_handler</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">log_level</span><span class="p">)</span> <span class="c1"># Registrar no console</span> <span class="c1"># Adicionando filtro para ignorar certos níveis no console e no arquivo</span> <span class="n">console_handler</span><span class="o">.</span><span class="n">addFilter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">LevelFilter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ignore_console</span><span class="p">))</span> <span class="c1"># Definindo o formato das mensagens de log</span> <span class="n">formatter</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span><span class="n">formato_log</span><span class="p">)</span> <span class="n">console_handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">formatter</span><span class="p">)</span> <span class="c1"># Adicionando o handler ao logger</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">console_handler</span><span class="p">)</span> <span class="c1"># Redirecionando exceções para o logger</span> <span class="n">sys</span><span class="o">.</span><span class="n">excepthook</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">handle_exception</span> <span class="c1"># Redirecionando saída padrão</span> <span class="bp">self</span><span class="o">.</span><span class="n">original_stdout</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="bp">self</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">handle_exception</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">exc_traceback</span><span class="p">):</span> <span class="k">if</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">exc_type</span><span class="p">,</span> <span class="ne">KeyboardInterrupt</span><span class="p">):</span> <span class="n">sys</span><span class="o">.</span><span class="n">__excepthook__</span><span class="p">(</span><span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">exc_traceback</span><span class="p">)</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"Exceção não prevista"</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="p">(</span><span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">exc_traceback</span><span class="p">))</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">print</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> <span class="c1"># Imprime diretamente na saída padrão</span> <span class="nb">print</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span> <span class="n">file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">original_stdout</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">corte</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="n">message</span> <span class="o">=</span> <span class="n">message</span><span class="p">[:</span><span class="n">corte</span><span class="p">]</span> <span class="k">if</span> <span class="n">corte</span> <span class="k">else</span> <span class="n">message</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">+</span> <span class="n">message</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="c1">#</span> <span class="c1"># </span> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> <span class="k">if</span> <span class="n">message</span><span class="o">.</span><span class="n">strip</span><span class="p">():</span> <span class="c1"># Ignorar mensagens vazias</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">flush</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">pass</span> <span class="c1"># Método necessário para compatibilidade com sys.stdout</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">debug</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">corte</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">+</span> <span class="n">message</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">[:</span><span class="n">corte</span><span class="p">]</span> <span class="k">if</span> <span class="n">corte</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="s1">''</span> <span class="k">if</span> <span class="n">exit</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">_exit</span><span class="p">(</span><span class="n">exit</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">corte</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">+</span> <span class="n">message</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">[:</span><span class="n">corte</span><span class="p">]</span> <span class="k">if</span> <span class="n">corte</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="s1">''</span> <span class="k">if</span> <span class="n">exit</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">_exit</span><span class="p">(</span><span class="n">exit</span><span class="p">)</span> <span class="c1">#</span> <span class="c1"># </span> <span class="k">def</span> <span class="nf">aviso</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">corte</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">+</span> <span class="n">message</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">[:</span><span class="n">corte</span><span class="p">]</span> <span class="k">if</span> <span class="n">corte</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="s1">''</span> <span class="k">if</span> <span class="n">exit</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">_exit</span><span class="p">(</span><span class="n">exit</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">erro</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">corte</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">+</span> <span class="n">message</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">[:</span><span class="n">corte</span><span class="p">]</span> <span class="k">if</span> <span class="n">corte</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="s1">''</span> <span class="k">if</span> <span class="n">exit</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">_exit</span><span class="p">(</span><span class="n">exit</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">critico</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">corte</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">exit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">+</span> <span class="n">message</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">message</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">[:</span><span class="n">corte</span><span class="p">]</span> <span class="k">if</span> <span class="n">corte</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="s1">''</span> <span class="k">if</span> <span class="n">exit</span><span class="p">:</span> <span class="n">os</span><span class="o">.</span><span class="n">_exit</span><span class="p">(</span><span class="n">exit</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">stop_logging</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="c1"># Restaurar o stdout original</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">original_stdout</span> <span class="c1"># Remover handlers do logger</span> <span class="n">handlers</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">handlers</span><span class="p">[:]</span> <span class="k">for</span> <span class="n">handler</span> <span class="ow">in</span> <span class="n">handlers</span><span class="p">:</span> <span class="n">handler</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">removeHandler</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">filtra</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">log_file</span><span class="p">,</span> <span class="n">dh_ini</span><span class="p">,</span> <span class="n">dh_fim</span><span class="p">):</span> <span class="c1"># Validar parametros de entrada</span> <span class="k">if</span> <span class="n">dh_ini</span><span class="p">:</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dh_ini</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">):</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">re</span><span class="o">.</span><span class="n">fullmatch</span><span class="p">(</span><span class="sa">r</span><span class="s1">'([0-3][0-9]/[0-1][0-2]/[1-2][0-9]</span><span class="si">{3}</span><span class="s1"> [0-2][0-9]\:[0-6][0-9])(\:[0-6][0-9]){0,1}'</span><span class="p">,</span> <span class="n">dh_ini</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Data/Hora início </span><span class="si">{</span><span class="n">dh_ini</span><span class="si">}</span><span class="s1"> em formato inválido. Informe um objeto do tipo "datetime" ou uma string no formato "dd/mm/aaaa hh:mm:[ss]"'</span><span class="p">)</span> <span class="k">return</span> <span class="kc">None</span> <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">dh_ini</span><span class="p">)</span> <span class="o">==</span> <span class="mi">16</span><span class="p">:</span> <span class="c1"># Formato 'dd/mm/yyyy hh:mm'</span> <span class="n">dh_ini</span> <span class="o">+=</span> <span class="s2">":00"</span> <span class="k">try</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">inicio</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">dh_ini</span><span class="p">,</span> <span class="s1">'</span><span class="si">%d</span><span class="s1">/%m/%Y %H:%M:%S'</span><span class="p">)</span> <span class="k">except</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Data/Hora início </span><span class="si">{</span><span class="n">dh_ini</span><span class="si">}</span><span class="s1"> em formato inválido. Informe um objeto do tipo "datetime" ou uma string no formato "dd/mm/aaaa hh:mm:[ss]"'</span><span class="p">)</span> <span class="k">return</span> <span class="kc">None</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">inicio</span> <span class="o">=</span> <span class="n">dh_ini</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">inicio</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span> <span class="o">-</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">hours</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="c1">## assume a última hora como intervalo, se omisso</span> <span class="k">if</span> <span class="n">dh_fim</span><span class="p">:</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dh_fim</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">):</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">re</span><span class="o">.</span><span class="n">fullmatch</span><span class="p">(</span><span class="sa">r</span><span class="s1">'([0-3][0-9]/[0-1][0-2]/[1-2][0-9]</span><span class="si">{3}</span><span class="s1"> [0-2][0-9]\:[0-6][0-9])(\:[0-6][0-9]){0,1}'</span><span class="p">,</span> <span class="n">dh_ini</span><span class="p">):</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Data/Hora fim </span><span class="si">{</span><span class="n">dh_fim</span><span class="si">}</span><span class="s1"> em formato inválido. Informe um objeto do tipo "datetime" ou uma string no formato "dd/mm/aaaa hh:mm:[ss]"'</span><span class="p">)</span> <span class="k">return</span> <span class="kc">None</span> <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">dh_fim</span><span class="p">)</span> <span class="o">==</span> <span class="mi">16</span><span class="p">:</span> <span class="c1"># Formato 'dd/mm/yyyy hh:mm'</span> <span class="n">dh_fim</span> <span class="o">+=</span> <span class="s2">":00"</span> <span class="k">try</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">fim</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">dh_fim</span><span class="p">,</span> <span class="s1">'</span><span class="si">%d</span><span class="s1">/%m/%Y %H:%M:%S'</span><span class="p">)</span> <span class="k">except</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Data/Hora fim </span><span class="si">{</span><span class="n">dh_fim</span><span class="si">}</span><span class="s1"> em formato inválido. Informe um objeto do tipo "datetime" ou uma string no formato "dd/mm/aaaa hh:mm:[ss]"'</span><span class="p">)</span> <span class="k">return</span> <span class="kc">None</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">fim</span> <span class="o">=</span> <span class="n">dh_fim</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">fim</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span> <span class="c1">## assume a última hora como intervalo, se omisso</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">log_file</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_file_path</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="s1">'Nenhum arquivo de log disponível. Log desta instância configurado apenas para exibição em tela, sem registro em arquivo'</span><span class="p">)</span> <span class="k">return</span> <span class="kc">None</span> <span class="k">elif</span> <span class="ow">not</span> <span class="n">log_file</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_file_path</span><span class="p">:</span> <span class="n">log_file_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_file_path</span> <span class="k">elif</span> <span class="n">log_file</span><span class="p">:</span> <span class="k">if</span> <span class="n">Path</span><span class="p">(</span><span class="n">log_file</span><span class="p">)</span><span class="o">.</span><span class="n">is_file</span><span class="p">():</span> <span class="n">log_file_path</span> <span class="o">=</span> <span class="n">log_file</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Arquivo de log </span><span class="si">{</span><span class="n">log_file</span><span class="si">}</span><span class="s1"> não existe!'</span><span class="p">)</span> <span class="k">return</span> <span class="kc">None</span> <span class="k">else</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="s1">'Erro validação arquivo de entrada. Abortando!'</span><span class="p">)</span> <span class="k">return</span> <span class="kc">None</span> <span class="c1"># Função para verificar se a linha está dentro do intervalo de tempo</span> <span class="k">def</span> <span class="nf">is_within_time_range</span><span class="p">(</span><span class="n">timestamp</span><span class="p">,</span> <span class="n">dh_inicio</span><span class="p">,</span> <span class="n">dh_fim</span><span class="p">):</span> <span class="k">return</span> <span class="n">dh_inicio</span> <span class="o"><=</span> <span class="n">timestamp</span> <span class="o"><=</span> <span class="n">dh_fim</span> <span class="c1"># Ler e filtrar o arquivo de log com a codificação ISO-8859-1</span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">log_file_path</span><span class="p">,</span> <span class="s1">'r'</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">'ISO-8859-1'</span><span class="p">)</span> <span class="k">as</span> <span class="n">log_file</span><span class="p">:</span> <span class="n">log_lines</span> <span class="o">=</span> <span class="n">log_file</span><span class="o">.</span><span class="n">readlines</span><span class="p">()</span> <span class="c1"># Variável para armazenar o último timestamp válido</span> <span class="n">last_valid_timestamp</span> <span class="o">=</span> <span class="kc">None</span> <span class="n">filtered_lines</span> <span class="o">=</span> <span class="p">[]</span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">log_lines</span><span class="p">:</span> <span class="k">try</span><span class="p">:</span> <span class="c1"># Extraia a data e a hora da linha</span> <span class="n">timestamp_str</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="s2">" "</span> <span class="o">+</span> <span class="n">line</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span> <span class="n">timestamp</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">timestamp_str</span><span class="p">,</span> <span class="s1">'%Y-%m-</span><span class="si">%d</span><span class="s1"> %H:%M:%S,</span><span class="si">%f</span><span class="s1">'</span><span class="p">)</span> <span class="n">last_valid_timestamp</span> <span class="o">=</span> <span class="n">timestamp</span> <span class="k">if</span> <span class="n">is_within_time_range</span><span class="p">(</span><span class="n">timestamp</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">inicio</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">fim</span><span class="p">):</span> <span class="n">filtered_lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> <span class="c1"># Caso a linha não tenha um carimbo de tempo, use o último timestamp válido</span> <span class="k">if</span> <span class="n">last_valid_timestamp</span> <span class="ow">and</span> <span class="n">is_within_time_range</span><span class="p">(</span><span class="n">last_valid_timestamp</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">inicio</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">fim</span><span class="p">):</span> <span class="n">filtered_lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span> <span class="c1"># Retornar o objeto contendo as linhas filtradas</span> <span class="k">return</span> <span class="n">filtered_lines</span>
</div>
misc
<div class="doc doc-contents ">
<h6 id="lbxtoolkit.misc--classe-misc">Classe <strong>misc</strong></h6>
Classe que reune pequenas funções uteis para agilizar tarefas comuns.
Sintaxe e exemplos de uso. Parametros omissos assume os valores padrão indicados abaixo:
Arquivo = seleciona_arquivo(DirBase, TiposArquivo=[('Todos os arquivos', '*.*')], Titulo='Selecionar arquivo')Diretório = seleciona_dir(DirBase=Path(r'./'), Titulo='Selecionar diretório'):NomeLimpo = normaliza('String # SEM Noção!') #>>> string_sem_nocaocmd_window = get_cmd_window()maximize_console()
<details class="quote">
<summary>Source code in <code>lbxtoolkit\__init__.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1270</span>
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
class misc: # Classe de miscelâneas """ #### Classe miscClasse que reune pequenas funções uteis para agilizar tarefas comuns.
Sintaxe e exemplos de uso. Parametros omissos assume os valores padrão indicados abaixo:
-Arquivo = seleciona_arquivo(DirBase, TiposArquivo=[('Todos os arquivos', '*.*')], Titulo='Selecionar arquivo')-Diretório = seleciona_dir(DirBase=Path(r'./'), Titulo='Selecionar diretório'):-NomeLimpo = normaliza('String # SEM Noção!') #>>> string_sem_nocao-cmd_window = get_cmd_window()-maximize_console()""" def init(self): pass # # def seleciona_arquivo(DirBase, TiposArquivo=[('Todos os arquivos', '.')], Titulo='Selecionar arquivo'): # Picker para selecionar arquivo root = tk.Tk() root.withdraw() # Esconde a janela principal do Tkinter Arquivo = filedialog.askopenfilename(initialdir=DirBase, filetypes=TiposArquivo, title=Titulo) Arquivo = Path(Arquivo) root.destroy() return Arquivo # # def seleciona_dir(DirBase=Path(r'./'), Titulo='Selecionar diretório'): # Picker para selecionar diretório root = tk.Tk() # objeto picker (Tkinter)para selecionar arquivos e diretórios root.withdraw() # Esconde a janela principal do Tkinter Diretorio = filedialog.askdirectory(initialdir=DirBase, title=Titulo) Diretorio = Path(Diretorio) root.destroy() return Diretorio # # def normaliza(Original): # Limpa e padroniza nomes Lixo = r'/\?%§ªº°`´^~:|"<>!@#$%¨&()+=-[]{}"' ' Normalizar = normalize('NFKD', Original).encode('ASCII', 'ignore').decode('ASCII') RemoverLixo = [c if c not in Lixo else '' for c in Normalizar]
Limpo = "".join(RemoverLixo) Limpo = re.sub(r'.(?=.*.)', '', Limpo) # troca todos os pontos por underline Limpo = re.sub(r'+', '_', Limpo) # limpa as reptições do underline return Limpo.lower() # # def get_cmd_window(): # Captura a referencia da janela atual para retornar o foco à ela depois de chamar os pickers pid = os.getpid() windows = gw.getWindowsWithTitle("") for window in windows: if window.title and window.visible and window.topleft: return window return None # # def maximize_console(): # Ajustar o buffer de console # os.system('mode con: cols=500 lines=100') # Obter o handle da janela do console kernel32 = ctypes.WinDLL('kernel32') user32 = ctypes.WinDLL('user32') hWnd = kernel32.GetConsoleWindow() if hWnd: # Definir as dimensões da tela user32.ShowWindow(hWnd, 3) # 3 = SW_MAXIMIZE
</div>
postgreSQL
<div class="doc doc-contents ">
<h6 id="lbxtoolkit.postgreSQL--classe-postgresql">Classe <strong>postgreSQL</strong></h6>
Recursos de interação com o banco de dados relacional PostgreSQL
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:
credenciais = { 'dbname': 'NOME_BANCO', 'user': 'USUARIO'', 'password': 'SENHA', 'host': 'IP_OU_DNS_SERVIDOR', 'port': 'PORTA_POSTGRESQL', ## padrão = 5432 }
conexao = postgreSQL.db(credenciais)
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.
Qualquer argumento de conexão previsto no pacote psycopg2 são aceitos como entrada no dicionário acima.
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.
from pathlib import Path
arquivo_csv = Path('./diretorio/arquivo_exemplo.csv')
dados = postgreSQL.csv_df(arquivo_csv, CsvDelim=',') # usando vírgula como separador. se omisso, assume ";'
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.
A assinatura da função é postgreSQL.db_insert_df([conexao], [dataframe_origem], [tabela_destino], Schema=None, Colunas=None, OnConflict=None)
É necessário que os nomes das colunas do dataframe coincidam com o nome das colunas da tabela. Não há como traduzir/compatibilizar (de-para) nomes de colunas entre o dataframe e a tabela.
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.
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.
O parametro opcional Colunas espera um objeto do tipo lista que contenha a relação das colunas a serem importadas.
As colunas listadas neste objeto precisam existir nas duas pontas (dataframe e tabela).
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.
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 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.
Exemplo de uso:
from lbx_toolkit import postgreSQL from pathlib import Pathcredenciais = { 'dbname': 'NOME_BANCO', 'user': 'USUARIO'',
'password': 'SENHA',
'host': 'IP_OU_DNS_SERVIDOR', 'port': 'PORTA_POSTGRESQL', ## padrão = 5432 }conexao = postgreSQL.db(credenciais)
arquivo_csv = Path('./diretorio/arquivo_exemplo.csv') dados = postgreSQL.csv_df(arquivo_csv, CsvDelim=',') # usando vírgula como separador. se omisso, assume ";'
postgreSQL.db_insert_df(conexao, dados, 'teste_table', Schema='meu_esquema', OnConflict='on conflict (coluna_chave_primaria) do nothing')
conexão com o banco precisa ser fechada explicitamente após a chamada do método, caso não seja mais utilizada:
conexao.close()
4) O método postgreSQl.db_select() executa consultas no banco de dados e retorna um cursor com o resultado.
A assinatura da função é postgreSQL.db_select([conexao], [query])
São permitidas apenas instruções de consulta (podendo serem complexas, por exemplo, com uso de CTE). 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.
O cursor é fechado no contexto do método, antes do retorno, não podendo ser manipulado após recebido como retorno da função.
A função retorna dois objetos, o primeiro contendo os dados do cursor, o segundo, contendo os nomes das respectivas colunas.
Exemplo de uso:
from lbx_toolkit import postgreSQL from pathlib import Pathcredenciais = { 'dbname': 'NOME_BANCO', 'user': 'USUARIO'',
'password': 'SENHA',
'host': 'IP_OU_DNS_SERVIDOR', 'port': 'PORTA_POSTGRESQL', ## padrão = 5432 }conexao = postgreSQL.db(credenciais)
query = 'select * from meu_esquema.teste_table'
dados, colunas = postgreSQL.db_select(conexao, query) conexao.close()
5) O método postgreSQl.db_update() executa updates no banco
A assinatura da função é postgreSQL.db_update([conexao], [query])
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.
A função retorna a quantidade de linhas alteradas.
Exemplo de uso:
from lbx_toolkit import postgreSQL from pathlib import Pathcredenciais = { 'dbname': 'NOME_BANCO', 'user': 'USUARIO'',
'password': 'SENHA',
'host': 'IP_OU_DNS_SERVIDOR', 'port': 'PORTA_POSTGRESQL', ## padrão = 5432 }conexao = postgreSQL.db(credenciais)
query = "update meu_esquema.teste_table set coluna='novo_valor' where pk='chave'"
result = postgreSQL.db_update(conexao, query) conexao.close()
<details class="quote">
<summary>Source code in <code>lbxtoolkit\__init__.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">494</span>
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
class postgreSQL: # Classe de acesso e interação com banco PostgreSQL """ #### Classe postgreSQLRecursos de interação com o banco de dados relacional PostgreSQL
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:``` credenciais = { 'dbname': 'NOME_BANCO', 'user': 'USUARIO'', 'password': 'SENHA', 'host': 'IP_OU_DNS_SERVIDOR', 'port': 'PORTA_POSTGRESQL', ## padrão = 5432 }
conexao = postgreSQL.db(credenciais) ```
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.Qualquer argumento de conexão previsto no pacote psycopg2 são aceitos como entrada no dicionário acima.
2) O método
postgreSQl.csv_df()lê arquivo texto do tipo CSV e o converte para o objeto Dataframe dopandas. 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çãoPathpara tratar o caminho do arquivo de origem.
</span> <span class="sd"> from pathlib import Path</span> <span class="sd"> arquivo_csv = Path('./diretorio/arquivo_exemplo.csv')</span> <span class="sd"> dados = postgreSQL.csv_df(arquivo_csv, CsvDelim=',') # usando vírgula como separador. se omisso, assume ";'</span> <span class="sd">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.A assinatura da função é
postgreSQL.db_insert_df([conexao], [dataframe_origem], [tabela_destino], Schema=None, Colunas=None, OnConflict=None)É necessário que os nomes das colunas do dataframe coincidam com o nome das colunas da tabela. Não há como traduzir/compatibilizar (de-para) nomes de colunas entre o dataframe e a tabela.
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. 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.O parametro opcional
Colunasespera um objeto do tipo lista que contenha a relação das colunas a serem importadas. As colunas listadas neste objeto precisam existir nas duas pontas (dataframe e tabela). 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.O último parametro opcional
OnConflictespera uma declaração para tratar o que fazer caso o dado a ser inserido já exista na tabela, baseado na cláusula 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.Exemplo de uso:
``` from lbx_toolkit import postgreSQL from pathlib import Path
credenciais = { 'dbname': 'NOME_BANCO', 'user': 'USUARIO'', 'password': 'SENHA', 'host': 'IP_OU_DNS_SERVIDOR', 'port': 'PORTA_POSTGRESQL', ## padrão = 5432 }
conexao = postgreSQL.db(credenciais)
arquivo_csv = Path('./diretorio/arquivo_exemplo.csv') dados = postgreSQL.csv_df(arquivo_csv, CsvDelim=',') # usando vírgula como separador. se omisso, assume ";'
postgreSQL.db_insert_df(conexao, dados, 'teste_table', Schema='meu_esquema', OnConflict='on conflict (coluna_chave_primaria) do nothing')
# conexão com o banco precisa ser fechada explicitamente após a chamada do método, caso não seja mais utilizada: conexao.close() ```
4) O método
postgreSQl.db_select()executa consultas no banco de dados e retorna umcursorcom o resultado.A assinatura da função é
postgreSQL.db_select([conexao], [query])São permitidas apenas instruções de consulta (podendo serem complexas, por exemplo, com uso de CTE). 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.
O
cursoré fechado no contexto do método, antes do retorno, não podendo ser manipulado após recebido como retorno da função.A função retorna dois objetos, o primeiro contendo os dados do cursor, o segundo, contendo os nomes das respectivas colunas.
Exemplo de uso:
``` from lbx_toolkit import postgreSQL from pathlib import Path
credenciais = { 'dbname': 'NOME_BANCO', 'user': 'USUARIO'', 'password': 'SENHA', 'host': 'IP_OU_DNS_SERVIDOR', 'port': 'PORTA_POSTGRESQL', ## padrão = 5432 }
conexao = postgreSQL.db(credenciais)
query = 'select * from meu_esquema.teste_table'
dados, colunas = postgreSQL.db_select(conexao, query) conexao.close() ```
5) O método
postgreSQl.db_update()executa updates no bancoA assinatura da função é
postgreSQL.db_update([conexao], [query])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.
A função retorna a quantidade de linhas alteradas.
Exemplo de uso:
``` from lbx_toolkit import postgreSQL from pathlib import Path
credenciais = { 'dbname': 'NOME_BANCO', 'user': 'USUARIO'', 'password': 'SENHA', 'host': 'IP_OU_DNS_SERVIDOR', 'port': 'PORTA_POSTGRESQL', ## padrão = 5432 }
conexao = postgreSQL.db(credenciais)
query = "update meu_esquema.teste_table set coluna='novo_valor' where pk='chave'"
result = postgreSQL.db_update(conexao, query) conexao.close() ```
"""
def init(self, config, logger=None): 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<span class="k">try</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Conexao</span> <span class="o">=</span> <span class="n">psycopg2</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="o">**</span><span class="n">config</span><span class="p">)</span> <span class="c1">## 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)</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="k">raise</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">csv_df</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">CsvPath</span><span class="p">,</span> <span class="n">CsvDelim</span><span class="o">=</span><span class="s1">';'</span><span class="p">):</span> <span class="c1"># Le arquivo CSV e gera Dataframe do Pandas</span> <span class="k">try</span><span class="p">:</span> <span class="n">DataFrame</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="n">CsvPath</span><span class="p">,</span> <span class="n">delimiter</span><span class="o">=</span><span class="n">CsvDelim</span><span class="p">)</span> <span class="c1"># Verifique se o delimitador é ';'</span> <span class="n">DataFrame</span><span class="o">.</span><span class="n">replace</span><span class="p">({</span><span class="n">np</span><span class="o">.</span><span class="n">nan</span><span class="p">:</span> <span class="kc">None</span><span class="p">},</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1">## troca 'NaN' por None (null no postgresql)</span> <span class="k">return</span> <span class="n">DataFrame</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="k">raise</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">db_insert_df</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">DataFrame</span><span class="p">,</span> <span class="n">Tabela</span><span class="p">,</span> <span class="n">Schema</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">Colunas</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">OnConflict</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> <span class="c1"># Insere os dados de um dataframe em uma tabela equivalente no banco (exige mesma estrutura de colunas)</span> <span class="c1"># Essa função exige que os nomes dos cabeçalhos das colunas do CSV sejam os mesmos das colunas da tabela de destino</span> <span class="n">Colunas</span> <span class="o">=</span> <span class="n">Colunas</span> <span class="ow">or</span> <span class="n">DataFrame</span><span class="o">.</span><span class="n">columns</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span> <span class="c1"># Caso não seja fornecida a lista de colunas, assume as colunas do DataFrame</span> <span class="n">Valores</span> <span class="o">=</span> <span class="p">[</span><span class="nb">tuple</span><span class="p">(</span><span class="n">Linha</span><span class="p">)</span> <span class="k">for</span> <span class="n">Linha</span> <span class="ow">in</span> <span class="n">DataFrame</span><span class="p">[</span><span class="n">Colunas</span><span class="p">]</span><span class="o">.</span><span class="n">values</span><span class="p">]</span> <span class="n">Schema</span> <span class="o">=</span> <span class="n">Schema</span> <span class="ow">or</span> <span class="s1">'public'</span> <span class="n">Query</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">'insert into </span><span class="si">{</span><span class="n">Schema</span><span class="si">}</span><span class="s1">.</span><span class="si">{</span><span class="n">Tabela</span><span class="si">}</span><span class="s1"> (</span><span class="si">{</span><span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">Colunas</span><span class="p">)</span><span class="si">}</span><span class="s1">) values %s '</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">OnConflict</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="n">Query</span> <span class="o">=</span> <span class="n">Query</span> <span class="o">+</span> <span class="n">OnConflict</span> <span class="k">try</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cursor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">Conexao</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span> <span class="n">execute_values</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">Cursor</span><span class="p">,</span> <span class="n">Query</span><span class="p">,</span> <span class="n">Valores</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">Conexao</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Conexao</span><span class="o">.</span><span class="n">rollback</span><span class="p">()</span> <span class="k">raise</span> <span class="k">finally</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cursor</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="c1">#Conexao.close() ## conexão precisa ser fechada explicitamente fora da classe</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">db_select</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">Query</span><span class="p">):</span> <span class="c1"># Retorna um cursor à partir de um select</span> <span class="n">BlackList</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'INSERT '</span><span class="p">,</span> <span class="s1">'DELETE '</span><span class="p">,</span> <span class="s1">'UPDATE '</span><span class="p">,</span> <span class="s1">'CREATE '</span><span class="p">,</span> <span class="s1">'DROP '</span><span class="p">,</span> <span class="s1">'MERGE '</span><span class="p">,</span> <span class="s1">'REPLACE '</span><span class="p">,</span> <span class="s1">'CALL '</span><span class="p">,</span> <span class="s1">'EXECUTE '</span><span class="p">]</span> <span class="k">if</span> <span class="nb">any</span><span class="p">(</span><span class="n">element</span> <span class="ow">in</span> <span class="n">Query</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="k">for</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">BlackList</span><span class="p">):</span> <span class="n">BlackListed</span> <span class="o">=</span> <span class="p">[</span><span class="n">element</span> <span class="k">for</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">BlackList</span> <span class="k">if</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">Query</span><span class="o">.</span><span class="n">upper</span><span class="p">()]</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">erro</span><span class="p">(</span><span class="sa">f</span><span class="s1">'</span><span class="si">{</span><span class="vm">__name__</span><span class="si">}</span><span class="s1">: Este método permite apenas consultas. A query informada possui as seguintes palavras reservadas não aceitas: </span><span class="si">{</span><span class="n">BlackListed</span><span class="si">}</span><span class="s1"> e não foi executada!'</span><span class="p">)</span> <span class="k">return</span> <span class="kc">None</span> <span class="k">else</span><span class="p">:</span> <span class="k">try</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cursor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">Conexao</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cursor</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">Query</span><span class="p">)</span> <span class="n">Dados</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cursor</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span> <span class="n">Colunas</span> <span class="o">=</span> <span class="p">[</span><span class="n">Col</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">Col</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cursor</span><span class="o">.</span><span class="n">description</span><span class="p">]</span> <span class="bp">self</span><span class="o">.</span><span class="n">Conexao</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cursor</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="k">return</span> <span class="n">Dados</span><span class="p">,</span> <span class="n">Colunas</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Conexao</span><span class="o">.</span><span class="n">rollback</span><span class="p">()</span> <span class="k">raise</span> <span class="c1">#</span> <span class="c1">#</span> <span class="k">def</span> <span class="nf">db_update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">Query</span><span class="p">):</span> <span class="c1"># Retorna um cursor à partir de um select</span> <span class="n">UpdRows</span> <span class="o">=</span> <span class="mi">0</span> <span class="n">BlackList</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'INSERT '</span><span class="p">,</span> <span class="s1">'DELETE '</span><span class="p">,</span> <span class="s1">'SELECT '</span><span class="p">,</span> <span class="s1">'CREATE '</span><span class="p">,</span> <span class="s1">'DROP '</span><span class="p">,</span> <span class="s1">'MERGE '</span><span class="p">,</span> <span class="s1">'REPLACE '</span><span class="p">,</span> <span class="s1">'CALL '</span><span class="p">,</span> <span class="s1">'EXECUTE '</span><span class="p">]</span> <span class="k">if</span> <span class="nb">any</span><span class="p">(</span><span class="n">element</span> <span class="ow">in</span> <span class="n">Query</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="k">for</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">BlackList</span><span class="p">):</span> <span class="n">BlackListed</span> <span class="o">=</span> <span class="p">[</span><span class="n">element</span> <span class="k">for</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">BlackList</span> <span class="k">if</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">Query</span><span class="o">.</span><span class="n">upper</span><span class="p">()]</span> <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">erro</span><span class="p">(</span><span class="sa">f</span><span class="s1">'</span><span class="si">{</span><span class="vm">__name__</span><span class="si">}</span><span class="s1">: Este método permite apenas updates. A query informada possui as seguintes palavras reservadas não aceitas: </span><span class="si">{</span><span class="n">BlackListed</span><span class="si">}</span><span class="s1"> e não foi executada!'</span><span class="p">)</span> <span class="k">return</span> <span class="kc">None</span> <span class="k">else</span><span class="p">:</span> <span class="k">try</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cursor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">Conexao</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cursor</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">Query</span><span class="p">)</span> <span class="n">UpdRows</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cursor</span><span class="o">.</span><span class="n">rowcount</span> <span class="bp">self</span><span class="o">.</span><span class="n">Conexao</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span> <span class="bp">self</span><span class="o">.</span><span class="n">Cursor</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> <span class="k">return</span> <span class="n">UpdRows</span> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">Err</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">Conexao</span><span class="o">.</span><span class="n">rollback</span><span class="p">()</span> <span class="k">raise</span>
</div>
</div>
</article>
</div>
</div>
</main>
<footer class="md-footer">
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file lbxtoolkit-2.1.0.tar.gz.
File metadata
- Download URL: lbxtoolkit-2.1.0.tar.gz
- Upload date:
- Size: 104.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 105961e3aadf780c51464d5a3760d29d7d89b777660a67ef8f5589d395ef92e8 |
|
| MD5 | 6111137338272bdb460cdfdbe5f42b8b |
|
| BLAKE2b-256 | b7eba8a2db36baeafbc7ae01771d69e9c5a1742990117ccb98ee91a48a2b9b88 |
File details
Details for the file lbxtoolkit-2.1.0-py3-none-any.whl.
File metadata
- Download URL: lbxtoolkit-2.1.0-py3-none-any.whl
- Upload date:
- Size: 65.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4f3575a1f07a78ce1a6bbd5a8723fb6a5d51e81dd3130638594e7af1130a1bc0 |
|
| MD5 | f360e071c870d712cf673d596cada1b0 |
|
| BLAKE2b-256 | 2842a5346ebd16d070fedd715c1202c50bd5d09e20f773d901bee50b0595d0c3 |
