lbxtoolkit 2.2.13__tar.gz → 2.3.0__tar.gz

{lbxtoolkit-2.2.13 → lbxtoolkit-2.3.0}/PKG-INFO

@@ -1,23 +1,24 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: lbxtoolkit
-Version: 2.2.13
+Version: 2.3.0
 Summary: 
 Author: Cristiano P. Ferrari
 Author-email: cristiano.ferrari@lbx.com.br
 Requires-Python: >=3.12,<4.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: msal (>=1.30.0,<2.0.0)
-Requires-Dist: numpy (>=2.0.1,<3.0.0)
-Requires-Dist: pandas (>=2.2.2,<3.0.0)
-Requires-Dist: psutil (>=6.0.0,<7.0.0)
-Requires-Dist: psycopg2 (>=2.9.9,<3.0.0)
-Requires-Dist: pygetwindow (>=0.0.9,<0.0.10)
-Requires-Dist: pywin32 (>=306,<307)
-Requires-Dist: requests (>=2.32.3,<3.0.0)
-Requires-Dist: selenium (>=4.23.1,<5.0.0)
-Requires-Dist: validators (>=0.33.0,<0.34.0)
-Requires-Dist: webdriver-manager (>=4.0.2,<5.0.0)
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: msal (>=1.30.0)
+Requires-Dist: numpy (>=2.0.1)
+Requires-Dist: pandas (>=2.2.2)
+Requires-Dist: psutil (>=6.0.0)
+Requires-Dist: psycopg2 (>=2.9.9)
+Requires-Dist: pygetwindow (>=0.0.9)
+Requires-Dist: pywin32 (>=306)
+Requires-Dist: requests (>=2.32.3)
+Requires-Dist: selenium (>=4.23.1)
+Requires-Dist: validators (>=0.33.0)
+Requires-Dist: webdriver-manager (>=4.0.2)
 Description-Content-Type: text/markdown
 
 <a id="lbxtoolkit"></a>

{lbxtoolkit-2.2.13 → lbxtoolkit-2.3.0}/lbxtoolkit/misc.py

@@ -1,4 +1,5 @@
 import os
+import sys
 import re 
 from pathlib import Path
 from unicodedata import normalize 
@@ -83,6 +84,49 @@ Sintaxe e exemplos de uso. Parametros omissos assume-se os valores padrão indic
             user32.ShowWindow(hWnd, 3)  # 3 = SW_MAXIMIZE  
         #
         #
+    def encontra_projeto_raiz(caminho_partida):
+        """Sobe a árvore procurando por .venv OU pyproject.toml como raiz do projeto"""
+        dir_atual = os.path.abspath(caminho_partida)
+        while True:
+            if (
+                os.path.isdir(os.path.join(dir_atual, '.venv')) or
+                os.path.isfile(os.path.join(dir_atual, 'pyproject.toml'))
+            ):
+                return dir_atual
+            novo_dir = os.path.dirname(dir_atual)
+            if novo_dir == dir_atual:
+                return None  # Chegou na raiz do sistema
+            dir_atual = novo_dir
+        #
+        #
+    def encontra_python_venv(raiz_projeto):
+        """Retorna o caminho do python da .venv se existir, senão None"""
+        if os.name == 'nt':
+            # Windows
+            python_venv = os.path.join(raiz_projeto, '.venv', 'Scripts', 'python.exe')
+        else:
+            # Linux/Mac
+            python_venv = os.path.join(raiz_projeto, '.venv', 'bin', 'python')
+        return python_venv if os.path.isfile(python_venv) else None 
+        #
+        #
+    def nome_modulo(script_path, raiz_projeto):
+        """
+        Dado o caminho absoluto do script (ex: C:/.../src/cnab/main.py)
+        e da raiz do projeto (ex: C:/...),
+        retorna o caminho do módulo python no formato pacote.subpacote.modulo
+        Exemplo: src.cnab.main
+        """
+        relpath = os.path.relpath(script_path, raiz_projeto)
+        if relpath.endswith('.py'):
+            relpath = relpath[:-3]  # remove .py
+        partes = []
+        for parte in relpath.replace("\\", "/").split("/"):
+            if parte not in ("", "__init__"):
+                partes.append(parte)
+        return ".".join(partes)
+        #
+        #
     @classmethod
     def cor(cls, text, color=None, style=None):
         """

{lbxtoolkit-2.2.13 → lbxtoolkit-2.3.0}/lbxtoolkit/service.py

@@ -42,7 +42,9 @@ O objetos mandatórios a serem inicilizados pelo **ConfigManager** são:
 -    **servicepath** = Objeto do Path com o caminho deste script
 -    **argparse_cfg** = Dicionário contendo os parametros de configuração (descrition, usage, add_help e formatter_classe) do módulo argparse (manipulado dos parametros de linha de comando)
 -    **argparse_opt** = Lista de dicionários com a configuração do argumentos de entrada aceitos (short, long, action, help)
--    **ambiente** = Definie o ambiente de excução: Linux, Windows [console] ou Serviço [Windows]        
+-    **ambiente** = Definie o ambiente de excução: Linux, Windows [console] ou Serviço [Windows]  
+-    **raiz_projeto** = A raiz do projeto para fins de execução por módulo (python -m) e não diretamente pelo script. Utilize `misc.encrontra_projeto_raiz` no módulo principal para obter essa informação 
+-    **modulo** = O nome do módulo quando o projeto for extrutura para execução por módulo. Utilize `misc.nome_modulo` no módulo principal para obter essa informação
 
 > [!NOTE]
 > Para ser funcional, é necessária que a classe local herde essa classe base e redefina (por sobrecarga) ao menos os métodos `on_run` e `args_parser()`. 
@@ -148,11 +150,21 @@ class ServicerConfig(Servicer):
 ```         
     """
     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
+        """
+        variáveis abaixo são mandatórias e precisa inicializadas no ConfigManager.inicialize() do módulo principal/pai:
+            - log
+            - argparse_cfg
+            - argparse_opt
+            - ambiente
+            - raiz_projeto
+            - modulo
+        """
         # 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')         
+        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:
@@ -161,7 +173,7 @@ class ServicerConfig(Servicer):
             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]') 
-                
+                      
         self.on_init_pre() ## método opcional a ser definito por sobrecarga na função local
 
         # Argumentos padrão obrigatórios       
@@ -208,7 +220,7 @@ class ServicerConfig(Servicer):
             servicemanager.PrepareToHostSingle(ServicoWindows)
             servicemanager.StartServiceCtrlDispatcher()
         elif len(sys.argv) > 1 and sys.argv[1] == 'install':
-                ServicoWindows.SvcInstall()
+                ServicoWindows.SvcInstall()      
         elif len(sys.argv) > 1 and sys.argv[1] == 'remove':
                 ServicoWindows.SvcRemove()            
         else:

{lbxtoolkit-2.2.13 → lbxtoolkit-2.3.0}/lbxtoolkit/service_windows.py

@@ -22,6 +22,20 @@ Gerencia a instalação e execução de um daemon como um serviço do windows. T
 - `SvcRemove`: Remove o serviço do windows configurado à partir de `SvcInstall`
 - `SvcStop`: Para/Interrompe a execução do serviço do windows criado por este script (método herdado da classe pai _win32serviceutil.ServiceFramework_ invocado automaticamente pela chamada do service manager do windows)
 - `SvcDoRun`: Inicializa a execução do serviço do windows criado por este script (método herdado da classe pai _win32serviceutil.ServiceFramework_ invocado autoamticamente pela chamada do service manager do windwos)
+
+A classe base possui ainda algumas dependÊncias que precisam ser inicializadas fora do contexto da classe configuradora/local. 
+Para isso, use classe ConfigManager.initialize(), disponível também no módulo `lbxtoolkit`.
+O objetos mandatórios a serem inicilizados pelo **ConfigManager** são:
+-    **log** = Objeto instanciado da classe lbx_logger, para manipular as entradas de log
+-    **daemon** = Objeto resultante do instanciamento da própria própria classe configuradora (deve ser inicializado após o instanciamento do objeto daemon, usando `ConfigManager.set()`)
+-    **config** = Dicionário contento os parametros (name, display_name e description) para instalar o serviço do windows
+-    **servicepath** = Objeto do Path com o caminho deste script
+-    **argparse_cfg** = Dicionário contendo os parametros de configuração (descrition, usage, add_help e formatter_classe) do módulo argparse (manipulado dos parametros de linha de comando)
+-    **argparse_opt** = Lista de dicionários com a configuração do argumentos de entrada aceitos (short, long, action, help)
+-    **ambiente** = Definie o ambiente de excução: Linux, Windows [console] ou Serviço [Windows]  
+-    **raiz_projeto** = A raiz do projeto para fins de execução por módulo (python -m) e não diretamente pelo script. Utilize `misc.encrontra_projeto_raiz` no módulo principal para obter essa informação 
+-    **modulo** = O nome do módulo quando o projeto for extrutura para execução por módulo. Utilize `misc.nome_modulo` no módulo principal para obter essa informação
+
     """
     _svc_name_ = None
     _svc_display_name_ = None
@@ -29,7 +43,9 @@ Gerencia a instalação e execução de um daemon como um serviço do windows. T
     def __init__(self, args):
         self.log = ConfigManager.get('log')
         self.daemon = ConfigManager.get('daemon')
-        self.config = ConfigManager.get('config')        
+        self.config = ConfigManager.get('config')  
+        self.raiz_projeto = ConfigManager.get('raiz_projeto')   
+        self.modulo = ConfigManager.get('modulo')                 
 
         if self.log is None or (not isinstance(self.log, lbx_logger) and not isinstance(self.log, SafeLogger)):
             raise ValueError(f'Argumento "log" é mandatório e deve ser uma instância de "lbxtoolkit.lbx_logger" ou "lbxtoolkit.SaffeLogger"')
@@ -39,6 +55,10 @@ Gerencia a instalação e execução de um daemon como um serviço do windows. T
             raise ValueError(f'Argumento "config" é mandatório e deve ser um dicionário contendo as chaves/valores para "name", "display_name" e "description"')
         elif [chave for chave in self.config if self.config[chave] is None]:
             raise ValueError(f'Argumento "config" ({self.config}) possui as seguintes chaves com valores inválidos [None]: {[chave for chave in self.config if self.config[chave] is None]:}')
+        elif self.raiz_projeto is None:
+            raise ValueError(f'Argumento "raiz_projeto" é mandatório e deve ser obtido usando "misc.encrontra_projeto_raiz" no módulo principal') 
+        elif self.modulo is None:
+            raise ValueError(f'Argumento "modulo" é mandatório e deve ser obtido usando "misc.nome_modulo" no módulo principal')         
 
         self._svc_name_ = self.config['name']
         self._svc_display_name_ = self.config['display_name']
@@ -61,9 +81,10 @@ Gerencia a instalação e execução de um daemon como um serviço do windows. T
 
             log = ConfigManager.get('log')
             daemon = ConfigManager.get('daemon')   
-            config = ConfigManager.get('config')   
-            service_path = ConfigManager.get('service_path') if ConfigManager.get('service_path') else os.path.abspath(sys.argv[0])                     
-
+            config = ConfigManager.get('config')  
+            raiz_projeto = ConfigManager.get('raiz_projeto')   
+            modulo = ConfigManager.get('modulo')       
+            
             if log is None or (not isinstance(log, lbx_logger) and not isinstance(log, SafeLogger)):
                 raise ValueError(f'Argumento "log" é mandatório e deve ser uma instância de "lbxtoolkit.lbx_logger" ou "lbxtoolkit.SaffeLogger"')
             elif daemon is None or not hasattr(daemon, 'run') or not hasattr(daemon, 'stop'):
@@ -77,6 +98,33 @@ Gerencia a instalação e execução de um daemon como um serviço do windows. T
             _svc_display_name_ = config['display_name']
             _svc_description_ = config['description']
 
+            ## para legado. suportar tanto a criação de execução direta do .py (originalmente) como por módulo
+            ## a lógica é que raiz_projeto e modulo só sejam definidos se o projeto foi estrutura para execução por módulo/entrypoint (pythom -m ou poetry run). 
+            #  neste caso, é esperado que service_path e python_path sejam nulos
+            ## por outro lado, se a execução for diretamente pelo script (python script.py), é esperado que raiz_projeto e modulo sejam nulos. se service_path e python_path forem nulos também, serão definidos arbitrariamente
+            if raiz_projeto and modulo: ## execução por módulo (novo)
+                service_path = None
+                python_path = None
+                wrapper = Path(raiz_projeto, f'wrapper_servico_{modulo}.bat') ## tem que ser igual a SvcRemove. Mudou lá, muda aqui.
+                wrapper_content = f"""
+@echo off
+REM ==================================================================================================================
+REM !!!!NÃO TOQUE NESSE ARQUIVO. NÃO O APAQUE NEM O MODIFIQUE.!!!!
+REM O serviço do windows [{config['display_name']}] que roda nesta máquina depende do conteúdo deste arquivo de lotes.
+REM ==================================================================================================================
+set PYTHONPATH=%~dp0
+"%~dp0.venv\\Scripts\\python.exe" -m {modulo} %*
+            """              
+                with open(wrapper, "w", encoding="utf-8") as file:
+                    file.write(wrapper_content)
+                service_cmd = f'{wrapper}'
+
+            else: ## execução direta do script (legado)
+                service_path = ConfigManager.get('service_path') if ConfigManager.get('service_path') else os.path.abspath(__file__)
+                python_path = ConfigManager.get('python_path') if ConfigManager.get('python_path') else os.path.join(os.getenv('VIRTUAL_ENV'), 'Scripts', 'python.exe') if os.getenv('VIRTUAL_ENV')  else sys.executable
+                service_cmd = f'{python_path} {service_path}'
+
+
             IP = socket.gethostbyname(socket.gethostname())
             Host = socket.gethostname()
             OS = platform.system()
@@ -98,19 +146,17 @@ Gerencia a instalação e execução de um daemon como um serviço do windows. T
                 if delete:
                     log.info(f'Excluindo serviço pre-existente [{_svc_display_name_} ({_svc_name_})] em {IP}/{Host}({Usuario}): {saida}')
             # Create the service
-            python_path = Path(os.path.join(os.getenv('VIRTUAL_ENV'), 'Scripts', 'python.exe'))
-            install = subprocess.run(
-                                        [
-                                            'sc', 
-                                            'create', 
-                                            _svc_name_,
-                                            'binPath=',
-                                            f'{python_path} {service_path}',
-                                            'DisplayName=', 
-                                            _svc_display_name_,
-                                            'start=delayed-auto',
-                                        ]
-                                    , capture_output=True)    
+            svc = [
+                    'sc', 
+                    'create', 
+                    _svc_name_,
+                    'binPath=',
+                    f'{service_cmd}',
+                    'DisplayName=', 
+                    _svc_display_name_,
+                    'start=delayed-auto',
+                ]
+            install = subprocess.run(svc, capture_output=True)    
             saida = install.stdout.decode('cp850').strip()
             log.info(f'Criando novo serviço [{_svc_display_name_} ({_svc_name_})] em {IP}/{Host}({Usuario}): {saida}')
             # Set the service description
@@ -138,7 +184,9 @@ Gerencia a instalação e execução de um daemon como um serviço do windows. T
 
             log = ConfigManager.get('log')
             daemon = ConfigManager.get('daemon')   
-            config = ConfigManager.get('config')                    
+            config = ConfigManager.get('config')   
+            raiz_projeto = ConfigManager.get('raiz_projeto')   
+            modulo = ConfigManager.get('modulo')                                    
 
             if log is None or (not isinstance(log, lbx_logger) and not isinstance(log, SafeLogger)):
                 raise ValueError(f'Argumento "log" é mandatório e deve ser uma instância de "lbxtoolkit.lbx_logger" ou "lbxtoolkit.SaffeLogger"')
@@ -172,6 +220,11 @@ Gerencia a instalação e execução de um daemon como um serviço do windows. T
                 saida = delete.stdout.decode('cp850').strip()
                 if delete:
                     log.info(f'Excluindo serviço pre-existente [{_svc_display_name_} ({_svc_name_})] em {IP}/{Host}({Usuario}): {saida}')
+                    if raiz_projeto and modulo: ## execução por módulo (novo)
+                        wrapper = Path(raiz_projeto, f'wrapper_servico_{modulo}.bat') ## tem que ser igual a SvcInstall. Mudou lá, muda aqui.
+                        if wrapper.exists():
+                            wrapper.unlink()                    
+              
         except Exception as Err:
             log.erro(f'Falha ao tentar excluir o serviço [{_svc_display_name_} ({_svc_name_})]')     
             raise 

lbxtoolkit-2.3.0/pyproject.toml

@@ -0,0 +1,31 @@
+[tool.poetry]
+name = "lbxtoolkit"
+version = "2.3.0"
+description = ""
+authors = ["Cristiano P. Ferrari <cristiano.ferrari@lbx.com.br>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = ">=3.12,<4.0"
+psutil = ">=6.0.0"
+psycopg2 = ">=2.9.9"
+pandas = ">=2.2.2"
+numpy = ">=2.0.1"
+msal = ">=1.30.0"
+requests = ">=2.32.3"
+selenium = ">=4.23.1"
+webdriver-manager = ">=4.0.2"
+validators = ">=0.33.0"
+pygetwindow = ">=0.0.9"
+pywin32 = ">=306"
+
+
+[tool.poetry.group.docs.dependencies]
+
+
+[tool.poetry.group.dev.dependencies]
+pydoc-markdown = ">=4.8.2"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

lbxtoolkit-2.2.13/pyproject.toml

@@ -1,31 +0,0 @@
-[tool.poetry]
-name = "lbxtoolkit"
-version = "2.2.13"
-description = ""
-authors = ["Cristiano P. Ferrari <cristiano.ferrari@lbx.com.br>"]
-readme = "README.md"
-
-[tool.poetry.dependencies]
-python = "^3.12"
-psutil = "^6.0.0"
-psycopg2 = "^2.9.9"
-pandas = "^2.2.2"
-numpy = "^2.0.1"
-msal = "^1.30.0"
-requests = "^2.32.3"
-selenium = "^4.23.1"
-webdriver-manager = "^4.0.2"
-validators = "^0.33.0"
-pygetwindow = "^0.0.9"
-pywin32 = "^306"
-
-
-[tool.poetry.group.docs.dependencies]
-
-
-[tool.poetry.group.dev.dependencies]
-pydoc-markdown = "^4.8.2"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"