rpa-suite 1.4.6__tar.gz → 1.4.9__tar.gz

{rpa_suite-1.4.6 → rpa_suite-1.4.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rpa_suite
-Version: 1.4.6
+Version: 1.4.9
 Summary: Conjunto de ferramentas essenciais para Automação RPA com Python, que facilitam o dia a dia de desenvolvimento.
 Author: Camilo Costa de Carvalho
 Author-email: camilo.carvalho@triasoftware.com.br
@@ -26,6 +26,7 @@ Requires-Dist: typing
 Requires-Dist: pillow
 Requires-Dist: pyautogui
 Requires-Dist: requests
+Requires-Dist: setuptools
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -64,7 +65,7 @@ Dynamic: summary
 - [Dependências](#dependências)
 - [Estrutura do módulo](#estrutura-do-módulo)
 - [Release](#release)
-  - [Notas da atualização: 1.4.6](#notas-da-atualização-146)
+  - [Notas da atualização: 1.4.9](#notas-da-atualização-149)
 - [Mais Sobre](#mais-sobre)
 
 ## Destaque
@@ -155,6 +156,7 @@ No setup do nosso projeto já estão inclusas as dependências, só será necess
 - pillow
 - pyautogui
 - typing
+- setuptools
 
   opcionalmente para automação de navegador:
 
@@ -169,23 +171,29 @@ No caso da função de screenshot é necessario ter as libs 'pyautogui' 'pillow'
 O módulo principal do rpa-suite é dividido em categorias. Cada categoria contém módulos com funções destinadas a categoria:
 
 - **rpa_suite**
+  
   - **clock**
     - **exec_at_hour** - Função que executa uma função no horário especificado "xx:yy", permitindo agendamento de tarefas com precisão.
     - **wait_for_exec** - Função que aguarda um tempo em segundos antes de executar a função passada como argumento.
     - **exec_and_wait** - Função que executa uma função e, em seguida, aguarda um tempo em segundos antes de continuar.
+  
   - **date**
     - **get_hms** - Função que retorna hora, minuto e segundo formatados como strings.
     - **get_dmy** - Função que retorna dia, mês e ano formatados como strings.
+  
   - **email**
     - **send_smtp** - Função para envio de emails via SMTP com suporte a anexos e mensagens HTML, configurável e personalizável.
+
   - **file**
     - **screen_shot** - Função para capturar screenshots, criando diretórios e arquivos com nomes e caminhos personalizáveis.
     - **flag_create** - Função para criar arquivos de flag indicando execução de processos.
     - **flag_delete** - Função para deletar arquivos de flag após a execução de processos.
     - **count_files** - Função para contar arquivos em diretórios, com suporte a extensões específicas.
+
   - **directory**
     - **create_temp_dir** - Função para criar diretórios temporários com nomes e caminhos personalizáveis.
     - **delete_temp_dir** - Função para deletar diretórios temporários, com opção de remover arquivos contidos.
+
   - **log**
     - **config_logger** - Função para configurar logs com suporte a arquivos e streams, utilizando a biblioteca Loguru.
     - **log_start_run_debug** - Função para registrar logs de início de execução em nível de depuração.
@@ -194,6 +202,7 @@ O módulo principal do rpa-suite é dividido em categorias. Cada categoria cont
     - **log_warning** - Função para registrar logs em nível de aviso.
     - **log_error** - Função para registrar logs em nível de erro.
     - **log_critical** - Função para registrar logs em nível crítico.
+
   - **printer**
     - **success_print** - Função para imprimir mensagens de sucesso com destaque em verde.
     - **alert_print** - Função para imprimir mensagens de alerta com destaque em amarelo.
@@ -201,18 +210,32 @@ O módulo principal do rpa-suite é dividido em categorias. Cada categoria cont
     - **error_print** - Função para imprimir mensagens de erro com destaque em vermelho.
   - **regex**
     - **check_pattern_in_text** - Função para verificar a presença de padrões em textos, com suporte a case-sensitive.
+  
   - **validate**
     - **emails** - Função para validar listas de emails, retornando listas de emails válidos e inválidos.
     - **word** - Função para buscar palavras ou padrões específicos em textos, com suporte a contagem de ocorrências.
+  
   - **browser**
     - **start_browser** - Função para iniciar o navegador Chrome com suporte a depuração remota.
     - **find_ele** - Função para localizar elementos na página utilizando estratégias de localização do Selenium.
     - **get** - Função para navegar para URLs específicas.
     - **close_browser** - Função para fechar o navegador e encerrar processos relacionados.
 
+  - **parallel**
+    - **run** - Função para iniciar um processo em paralelo.
+    - **is_running** - Função para capturar o status atual do processo que esta rodando em paralelo.
+    - **get_result** - Função para coletar o retorno da execução em paralelo junto com resultado da função ou funções que foram enviadas a este processo com retorno em forma de dict.
+    - **terminate** - Função para finalizar o processo paralelo mantendo apenas o processo principal do seu código, também é chamada de forma automatica esta função ao final de um procesos paralelo ou no final da função "get_result".
+
+  - **async**
+    - **run** - Função para iniciar a execução assíncrona de uma função mantendo o fluxo principal da aplicação.
+    - **is_running** - Função para verificar se a tarefa assíncrona ainda está em execução.
+    - **get_result** - Função para obter o resultado da execução assíncrona, incluindo tempo de execução e status, com suporte a timeout.
+    - **cancel** - Função para cancelar a tarefa assíncrona em execução.
+
 ## Release
 
-Versão: **Beta 1.4.6**
+Versão: **Beta 1.4.9**
 
 Lançamento: *20/02/2024*
 
@@ -220,10 +243,12 @@ Lançamento: *20/02/2024*
 
 Status: Em desenvolvimento.
 
-### Notas da atualização: 1.4.6
+### Notas da atualização: 1.4.9
 
 - Mudança dos submodulos para Objetos, agora Rpa_suite é um Objeto de Suite que compoe diversos sub-objetos separados pelas mesmas categorias anteriormente ja definidas
 - Reformulada a arquitetura do projeto para melhor coeção e menos subpastas e arquivos, agora a estrutura é mais simples e de melhor manutenção contendo apenas uma pasta core para o nucleo de nossos modulos, e uma pasta utils com ferramentas utilitarias que vamos adicionar varias novidades
+- Adicionado SubModulo Parallel com função dedicada a rodar um processo em paralelo com seu fluxo principal podendo recuperar o resultado da execução em paralelo a qualquer momento e setando timeout ou deixando o tempo indefinido para aguardar a resposta.
+- Adicionado SubModulo AsyncRunnner com função dedicada a facilitar uso de funções assincronas podendo recuperar seus resultados usando menos código, é um modulo simples porem poupa-nos tempo. 
 - Adicionado setor utils com funcionalidade de tornar o diretorio atual em um importavel relativo para o python
 - Adicionado Automação de Navegadores! Sim estamos devendo esta feature a bastante tempo, porem estamos com a primeira versão disponivel, em breve teremos mais recursos e disponibilidade para outros navegadores, atualmente suporte apenas para *Chrome.*
 - Mantemos o alerta! **get_dma** atualizada e **renomeada** para **get_dmy** para manter o padrão em ingles

{rpa_suite-1.4.6 → rpa_suite-1.4.9}/README.md

@@ -25,7 +25,7 @@
 - [Dependências](#dependências)
 - [Estrutura do módulo](#estrutura-do-módulo)
 - [Release](#release)
-  - [Notas da atualização: 1.4.6](#notas-da-atualização-146)
+  - [Notas da atualização: 1.4.9](#notas-da-atualização-149)
 - [Mais Sobre](#mais-sobre)
 
 ## Destaque
@@ -116,6 +116,7 @@ No setup do nosso projeto já estão inclusas as dependências, só será necess
 - pillow
 - pyautogui
 - typing
+- setuptools
 
   opcionalmente para automação de navegador:
 
@@ -130,23 +131,29 @@ No caso da função de screenshot é necessario ter as libs 'pyautogui' 'pillow'
 O módulo principal do rpa-suite é dividido em categorias. Cada categoria contém módulos com funções destinadas a categoria:
 
 - **rpa_suite**
+  
   - **clock**
     - **exec_at_hour** - Função que executa uma função no horário especificado "xx:yy", permitindo agendamento de tarefas com precisão.
     - **wait_for_exec** - Função que aguarda um tempo em segundos antes de executar a função passada como argumento.
     - **exec_and_wait** - Função que executa uma função e, em seguida, aguarda um tempo em segundos antes de continuar.
+  
   - **date**
     - **get_hms** - Função que retorna hora, minuto e segundo formatados como strings.
     - **get_dmy** - Função que retorna dia, mês e ano formatados como strings.
+  
   - **email**
     - **send_smtp** - Função para envio de emails via SMTP com suporte a anexos e mensagens HTML, configurável e personalizável.
+
   - **file**
     - **screen_shot** - Função para capturar screenshots, criando diretórios e arquivos com nomes e caminhos personalizáveis.
     - **flag_create** - Função para criar arquivos de flag indicando execução de processos.
     - **flag_delete** - Função para deletar arquivos de flag após a execução de processos.
     - **count_files** - Função para contar arquivos em diretórios, com suporte a extensões específicas.
+
   - **directory**
     - **create_temp_dir** - Função para criar diretórios temporários com nomes e caminhos personalizáveis.
     - **delete_temp_dir** - Função para deletar diretórios temporários, com opção de remover arquivos contidos.
+
   - **log**
     - **config_logger** - Função para configurar logs com suporte a arquivos e streams, utilizando a biblioteca Loguru.
     - **log_start_run_debug** - Função para registrar logs de início de execução em nível de depuração.
@@ -155,6 +162,7 @@ O módulo principal do rpa-suite é dividido em categorias. Cada categoria cont
     - **log_warning** - Função para registrar logs em nível de aviso.
     - **log_error** - Função para registrar logs em nível de erro.
     - **log_critical** - Função para registrar logs em nível crítico.
+
   - **printer**
     - **success_print** - Função para imprimir mensagens de sucesso com destaque em verde.
     - **alert_print** - Função para imprimir mensagens de alerta com destaque em amarelo.
@@ -162,18 +170,32 @@ O módulo principal do rpa-suite é dividido em categorias. Cada categoria cont
     - **error_print** - Função para imprimir mensagens de erro com destaque em vermelho.
   - **regex**
     - **check_pattern_in_text** - Função para verificar a presença de padrões em textos, com suporte a case-sensitive.
+  
   - **validate**
     - **emails** - Função para validar listas de emails, retornando listas de emails válidos e inválidos.
     - **word** - Função para buscar palavras ou padrões específicos em textos, com suporte a contagem de ocorrências.
+  
   - **browser**
     - **start_browser** - Função para iniciar o navegador Chrome com suporte a depuração remota.
     - **find_ele** - Função para localizar elementos na página utilizando estratégias de localização do Selenium.
     - **get** - Função para navegar para URLs específicas.
     - **close_browser** - Função para fechar o navegador e encerrar processos relacionados.
 
+  - **parallel**
+    - **run** - Função para iniciar um processo em paralelo.
+    - **is_running** - Função para capturar o status atual do processo que esta rodando em paralelo.
+    - **get_result** - Função para coletar o retorno da execução em paralelo junto com resultado da função ou funções que foram enviadas a este processo com retorno em forma de dict.
+    - **terminate** - Função para finalizar o processo paralelo mantendo apenas o processo principal do seu código, também é chamada de forma automatica esta função ao final de um procesos paralelo ou no final da função "get_result".
+
+  - **async**
+    - **run** - Função para iniciar a execução assíncrona de uma função mantendo o fluxo principal da aplicação.
+    - **is_running** - Função para verificar se a tarefa assíncrona ainda está em execução.
+    - **get_result** - Função para obter o resultado da execução assíncrona, incluindo tempo de execução e status, com suporte a timeout.
+    - **cancel** - Função para cancelar a tarefa assíncrona em execução.
+
 ## Release
 
-Versão: **Beta 1.4.6**
+Versão: **Beta 1.4.9**
 
 Lançamento: *20/02/2024*
 
@@ -181,10 +203,12 @@ Lançamento: *20/02/2024*
 
 Status: Em desenvolvimento.
 
-### Notas da atualização: 1.4.6
+### Notas da atualização: 1.4.9
 
 - Mudança dos submodulos para Objetos, agora Rpa_suite é um Objeto de Suite que compoe diversos sub-objetos separados pelas mesmas categorias anteriormente ja definidas
 - Reformulada a arquitetura do projeto para melhor coeção e menos subpastas e arquivos, agora a estrutura é mais simples e de melhor manutenção contendo apenas uma pasta core para o nucleo de nossos modulos, e uma pasta utils com ferramentas utilitarias que vamos adicionar varias novidades
+- Adicionado SubModulo Parallel com função dedicada a rodar um processo em paralelo com seu fluxo principal podendo recuperar o resultado da execução em paralelo a qualquer momento e setando timeout ou deixando o tempo indefinido para aguardar a resposta.
+- Adicionado SubModulo AsyncRunnner com função dedicada a facilitar uso de funções assincronas podendo recuperar seus resultados usando menos código, é um modulo simples porem poupa-nos tempo. 
 - Adicionado setor utils com funcionalidade de tornar o diretorio atual em um importavel relativo para o python
 - Adicionado Automação de Navegadores! Sim estamos devendo esta feature a bastante tempo, porem estamos com a primeira versão disponivel, em breve teremos mais recursos e disponibilidade para outros navegadores, atualmente suporte apenas para *Chrome.*
 - Mantemos o alerta! **get_dma** atualizada e **renomeada** para **get_dmy** para manter o padrão em ingles

{rpa_suite-1.4.6 → rpa_suite-1.4.9}/rpa_suite/__init__.py

@@ -1,4 +1,5 @@
 # rpa_suite/__init__.py
+
 """
     RPA Suite is a Python module that provides a set of tools for process automation.
     
@@ -59,5 +60,6 @@
         ``Browser``: Objeto de Automação de Navegadores (necessario Selenium e Webdriver_Manager)
 """
 
+# allows importing the rpa_suite module without the package name
 from .suite import rpa
 rpa

{rpa_suite-1.4.6 → rpa_suite-1.4.9}/rpa_suite/core/__init__.py

@@ -32,6 +32,8 @@ from .log import Log
 from .print import Print
 from .regex import Regex
 from .validate import Validate
+from .parallel import ParallelRunner
+from .asyncrun import AsyncRunner
 
 
 

rpa_suite-1.4.9/rpa_suite/core/asyncrun.py

@@ -0,0 +1,140 @@
+# rpa_suite/core/asyncrun.py
+
+# imports third-party
+from typing import Any, Callable, Dict, Optional, TypeVar, Generic
+import asyncio
+import time
+import traceback
+from functools import wraps
+
+
+T = TypeVar('T')
+
+
+class AsyncRunner(Generic[T]):
+    """
+    Class to execute asynchronous functions while maintaining the main application flow.
+    
+    Allows executing asynchronous functions and retrieving their results later.
+    Optimized for I/O bound operations (network, files, etc).
+    """
+    
+    def __init__(self):
+        """Start AsyncRunner."""
+        self._task = None
+        self._start_time = None
+        self._result = {}
+
+    @staticmethod
+    def _to_async(func: Callable) -> Callable:
+        """
+        Converts a synchronous function into an asynchronous one if necessary.
+        
+        Args:
+            func: The function to be converted.
+        
+        Returns:
+            A callable that is asynchronous.
+        """
+        @wraps(func)
+        async def wrapper(*args, **kwargs):
+            if asyncio.iscoroutinefunction(func):
+                return await func(*args, **kwargs)
+            return await asyncio.to_thread(func, *args, **kwargs)
+        return wrapper
+
+    async def _execute_function(self, function, args, kwargs):
+        """
+        Executes the function and manages results/errors.
+        
+        Args:
+            function: The function to be executed.
+            args: Positional arguments for the function.
+            kwargs: Keyword arguments for the function.
+        """
+        try:
+            async_func = self._to_async(function)
+            result = await async_func(*args, **kwargs)
+            
+            self._result = {
+                'status': 'success',
+                'result': result,
+                'success': True
+            }
+            
+        except Exception as e:
+            self._result = {
+                'status': 'error',
+                'error': str(e),
+                'traceback': traceback.format_exc(),
+                'success': False
+            }
+
+    def run(self, function: Callable[..., T], *args, **kwargs) -> 'AsyncRunner[T]':
+        """
+        Starts the execution of the function asynchronously.
+        
+        Args:
+            function: The function to be executed.
+            *args: Positional arguments for the function.
+            **kwargs: Keyword arguments for the function.
+        
+        Returns:
+            self: Returns the instance itself.
+        """
+        self._result.clear()
+        self._start_time = time.time()
+        
+        # Creates and schedules the asynchronous task
+        loop = asyncio.get_event_loop()
+        self._task = loop.create_task(self._execute_function(function, args, kwargs))
+        
+        return self
+
+    def is_running(self) -> bool:
+        """
+        Checks if the task is still running.
+        
+        Returns:
+            True if the task is running, False otherwise.
+        """
+        return self._task is not None and not self._task.done()
+
+    async def get_result(self, timeout: Optional[float] = None) -> Dict[str, Any]:
+        """
+        Retrieves the result of the asynchronous execution.
+        
+        Args:
+            timeout: Maximum time (in seconds) to wait.
+        
+        Returns:
+            A dictionary with the result or error information.
+        """
+        if self._task is None:
+            return {
+                'success': False,
+                'error': 'No task has been started',
+                'execution_time': 0
+            }
+
+        try:
+            await asyncio.wait_for(self._task, timeout=timeout)
+            
+        except asyncio.TimeoutError:
+            self._task.cancel()
+            return {
+                'success': False,
+                'error': f'Operation canceled due to timeout after {time.time() - self._start_time:.2f} seconds',
+                'execution_time': time.time() - self._start_time
+            }
+
+        result = dict(self._result)
+        result['execution_time'] = time.time() - self._start_time
+        return result
+
+    def cancel(self) -> None:
+        """
+        Cancels the running task.
+        """
+        if self.is_running():
+            self._task.cancel()

{rpa_suite-1.4.6 → rpa_suite-1.4.9}/rpa_suite/core/browser.py

@@ -1,16 +1,19 @@
-# default import
-import os, requests
+# rpa_suite/core/browser.py
 
-# imports
+# imports internal
 from rpa_suite.functions._printer import error_print, alert_print, success_print
 
+# imports external
 from selenium import webdriver
 from selenium.webdriver.common.by import By
 from selenium.webdriver.chrome.options import Options
 from selenium.webdriver.support.ui import WebDriverWait
 from selenium.webdriver.support import expected_conditions as EC
 from webdriver_manager.chrome import ChromeDriverManager
+
+# imports third-party
 from time import sleep
+import os, requests
 
 
 class Browser():
@@ -166,7 +169,7 @@ class Browser():
             error_print(f'Erro ao iniciar navegador: {str(e)}.')
 
 
-    def find_ele(self, value, by=By.XPATH, timeout=12, display_message=True):
+    def find_ele(self, value: str, by:By=By.XPATH, timeout=12, display_message=True):
         """
         Locate and return a web element on the page using the specified locator strategy.
         Args:

{rpa_suite-1.4.6 → rpa_suite-1.4.9}/rpa_suite/core/clock.py

@@ -1,8 +1,12 @@
+# rpa_suite/core/clock.py
 
+# imports internal
+from rpa_suite.functions._printer import error_print, success_print
+
+# imports third-party
 import time
 from typing import Callable, Any
 from datetime import datetime as dt
-from rpa_suite.functions._printer import error_print, success_print
 from typing import Callable, Any
 
 

{rpa_suite-1.4.6 → rpa_suite-1.4.9}/rpa_suite/core/date.py

@@ -1,11 +1,16 @@
-# /date.py
+# rpa_suite/core/date.py
 
+# imports internal
+from rpa_suite.functions._printer import error_print
+
+# imports third-party
 import datetime as dt
 from typing import Optional as Op
 from typing import Tuple
-from rpa_suite.functions._printer import error_print
+
 
 class Date():
+    
     """
     Class that provides utilities for date manipulation and formatting.
     

{rpa_suite-1.4.6 → rpa_suite-1.4.9}/rpa_suite/core/dir.py

@@ -1,7 +1,12 @@
+# rpa_suite/core/dir.py
 
+# imports internal
+from rpa_suite.functions._printer import error_print, alert_print, success_print
+
+# imports third-party
 import os, shutil
 from typing import Union
-from rpa_suite.functions._printer import error_print, alert_print, success_print
+
 
 
 class Directory():

{rpa_suite-1.4.6 → rpa_suite-1.4.9}/rpa_suite/core/email.py

@@ -1,13 +1,15 @@
-# /sender_smtp.py
+# rpa_suite/core/email.py
 
-import smtplib, os
+# imports internal
+from rpa_suite.functions._printer import alert_print, error_print, success_print
+
+# imports third-party
+import smtplib
 from email.mime.image import MIMEImage
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
 from email.mime.base import MIMEBase
 from email import encoders
-from rpa_suite.functions._printer import alert_print, error_print, success_print
-from rpa_suite.core.validate import email_validator
 
 
 class Email():

{rpa_suite-1.4.6 → rpa_suite-1.4.9}/rpa_suite/core/file.py

@@ -1,10 +1,18 @@
-import os, time
-from datetime import datetime
+# rpa_suite/core/file.py
+
+# imports internal
 from rpa_suite.functions._printer import error_print, success_print, alert_print
 from rpa_suite.functions.__create_ss_dir import __create_ss_dir as create_ss_dir
+
+# imports external
 from colorama import Fore
+
+# imports third-party
+import os, time
+from datetime import datetime
 from typing import Dict, List, Union
 
+
 class File():
     """
     Class that provides utilities for file management, including creation, deletion, and manipulation of files.

{rpa_suite-1.4.6 → rpa_suite-1.4.9}/rpa_suite/core/log.py

@@ -1,6 +1,13 @@
-from typing import Optional as Op
+# rpa_suite/core/log.py
+
+# imports internal
 from rpa_suite.functions._printer import error_print, alert_print, success_print
+
+# imports external
 from loguru import logger
+
+# imports third-party
+from typing import Optional as Op
 import sys, os, inspect