rpa-suite 1.6.2__py3-none-any.whl → 1.6.3__py3-none-any.whl

rpa_suite/core/print.py

@@ -3,9 +3,14 @@
 # imports third party
 from colorama import Fore
 
+class PrintError(Exception):
+    """Custom exception for Print errors."""
+    def __init__(self, message):
+        super().__init__(f'Print Error: {message}')
 
 # Windows bash colors
 class Colors:
+    """Color constants for console output formatting."""
     black = f"{Fore.BLACK}"
     blue = f"{Fore.BLUE}"
     green = f"{Fore.GREEN}"
@@ -26,7 +31,9 @@ class Print:
     This class offers functionalities for:
         - Printing success messages in green
         - Printing alert messages in yellow
-        - Additional printing methods can be added for other message types
+        - Printing information messages in cyan
+        - Printing error messages in red
+        - Additional printing methods for other message types
 
     The Print class is part of the RPA Suite and can be used to enhance the visibility of console outputs.
 
@@ -34,164 +41,180 @@ class Print:
     ----------
         >>> from rpa_suite import rpa
         >>> rpa.alert_print('Hello World')
-
-    pt-br
-    ----
-
-    Classe que fornece métodos para impressão formatada no console, permitindo que diferentes tipos de mensagens sejam exibidas com cores específicas.
-
-    Esta classe oferece funcionalidades para:
-        - Imprimir mensagens de sucesso em verde
-        - Imprimir mensagens de alerta em amarelo
-        - Métodos de impressão adicionais podem ser adicionados para outros tipos de mensagens
-
-    A classe Print é parte do RPA Suite e pode ser usada para aumentar a visibilidade das saídas do console.
-
-    Exemplo de uso:
-    ----------
-    >>> from rpa_suite import rpa
-    >>> rpa.alert_print('Hello World')
     """
 
     colors: Colors = Colors
 
-    def __init__(self): ...
+    def __init__(self) -> None:
+        """Initialize the Print class.""" 
+        pass
 
     def success_print(self, string_text: str, color=Colors.green, ending="\n") -> None:
         """
-        Print that indicates ``SUCCESS``. Customized with the color Green \n
+        Print that indicates SUCCESS. Customized with the color Green.
 
-        Return:
-        ----------
-            >>> type:None
+        Parameters:
+        -----------
+        ``string_text: str``
+            The text to be printed.
+        
+        ``color``
+            The color to use for printing. Default is green.
+        
+        ``ending: str``
+            The string appended after the text. Default is newline.
 
-        pt-br
-        ----------
-        Print  que indica ``SUCESSO``. Personalizado com a cor Verde \n
-
-        Retorno:
+        Return:
         ----------
-            >>> type:None
+            >>> type: None
         """
         print(f"{color}{string_text}{Colors.default}", end=ending)
 
     def alert_print(self, string_text: str, color=Colors.yellow, ending="\n") -> None:
         """
-        Print that indicates ``ALERT``. Customized with the color Yellow \n
+        Print that indicates ALERT. Customized with the color Yellow.
 
-        Return:
-        ----------
-            >>> type:None
+        Parameters:
+        -----------
+        ``string_text: str``
+            The text to be printed.
+        
+        ``color``
+            The color to use for printing. Default is yellow.
+        
+        ``ending: str``
+            The string appended after the text. Default is newline.
 
-        pt-br
-        ----------
-        Print que indica ``ALERTA``. Personalizado com a cor Amarelo \n
-        Retorno:
+        Return:
         ----------
-            >>> type:None
+            >>> type: None
         """
         print(f"{color}{string_text}{Colors.default}", end=ending)
 
     def info_print(self, string_text: str, color=Colors.cyan, ending="\n") -> None:
         """
-        Print that indicates ``INFORMATION``. Customized with the color Cyan \n
+        Print that indicates INFORMATION. Customized with the color Cyan.
 
-        Return:
-        ----------
-            >>> type:None
+        Parameters:
+        -----------
+        ``string_text: str``
+            The text to be printed.
+        
+        ``color``
+            The color to use for printing. Default is cyan.
+        
+        ``ending: str``
+            The string appended after the text. Default is newline.
 
-        pt-br
-        ----------
-        Print que indica ``INFORMATIVO``. Personalizado com a cor Ciano \n
-        Retorno:
+        Return:
         ----------
-            >>> type:None
+            >>> type: None
         """
         print(f"{color}{string_text}{Colors.default}", end=ending)
 
     def error_print(self, string_text: str, color=Colors.red, ending="\n") -> None:
         """
-        Print that indicates ``ERROR``. Customized with the color Red \n
+        Print that indicates ERROR. Customized with the color Red.
 
-        Return:
-        ----------
-            >>> type:None
+        Parameters:
+        -----------
+        ``string_text: str``
+            The text to be printed.
+        
+        ``color``
+            The color to use for printing. Default is red.
+        
+        ``ending: str``
+            The string appended after the text. Default is newline.
 
-        pt-br
-        ----------
-        Print que indica ``ERRO``. Personalizado com a cor Vermelho \n
-        Retorno:
+        Return:
         ----------
-            >>> type:None
+            >>> type: None
         """
         print(f"{color}{string_text}{Colors.default}", end=ending)
 
     def magenta_print(self, string_text: str, color=Colors.magenta, ending="\n") -> None:
         """
-        Print customized with the color Magenta \n
+        Print customized with the color Magenta.
 
-        Return:
-        ----------
-            >>> type:None
+        Parameters:
+        -----------
+        ``string_text: str``
+            The text to be printed.
+        
+        ``color``
+            The color to use for printing. Default is magenta.
+        
+        ``ending: str``
+            The string appended after the text. Default is newline.
 
-        pt-br
-        ----------
-        Print personalizado com a cor Magenta \n
-        Retorno:
+        Return:
         ----------
-            >>> type:None
+            >>> type: None
         """
         print(f"{color}{string_text}{Colors.default}", end=ending)
 
     def blue_print(self, string_text: str, color=Colors.blue, ending="\n") -> None:
         """
-        Print customized with the color Blue \n
+        Print customized with the color Blue.
 
-        Return:
-        ----------
-            >>> type:None
+        Parameters:
+        -----------
+        ``string_text: str``
+            The text to be printed.
+        
+        ``color``
+            The color to use for printing. Default is blue.
+        
+        ``ending: str``
+            The string appended after the text. Default is newline.
 
-        pt-br
-        ----------
-        Print personalizado com a cor Azul \n
-        Retorno:
+        Return:
         ----------
-            >>> type:None
+            >>> type: None
         """
         print(f"{color}{string_text}{Colors.default}", end=ending)
 
     def print_call_fn(self, string_text: str, color=Colors.call_fn, ending="\n") -> None:
         """
-        Print customized for function called (log) \n
-        Color: Magenta Light
-        Return:
-        ----------
-            >>> type:None
+        Print customized for function called (log).
+        Color: Light Magenta
 
-        pt-br
-        ----------
-        Print personalizado para log de chamada de função. \n
-        Cor: Magenta Light
-        Retorno:
+        Parameters:
+        -----------
+        ``string_text: str``
+            The text to be printed.
+        
+        ``color``
+            The color to use for printing. Default is light magenta.
+        
+        ``ending: str``
+            The string appended after the text. Default is newline.
+
+        Return:
         ----------
-            >>> type:None
+            >>> type: None
         """
         print(f"{color}{string_text}{Colors.default}", end=ending)
 
     def print_retur_fn(self, string_text: str, color=Colors.retur_fn, ending="\n") -> None:
         """
-        Print customized for function return (log) \n
-        Color: Yellow Light
-        Return:
-        ----------
-            >>> type:None
+        Print customized for function return (log).
+        Color: Light Yellow
 
-        pt-br
-        ----------
-        Print personalizado para log de chamada de função. \n
-        Cor: Yellow Light
-        Retorno:
+        Parameters:
+        -----------
+        ``string_text: str``
+            The text to be printed.
+        
+        ``color``
+            The color to use for printing. Default is light yellow.
+        
+        ``ending: str``
+            The string appended after the text. Default is newline.
+
+        Return:
         ----------
-            >>> type:None
+            >>> type: None
         """
         print(f"{color}{string_text}{Colors.default}", end=ending)

rpa_suite/core/regex.py

@@ -4,8 +4,12 @@
 import re
 
 # imports internal
-from rpa_suite.functions._printer import error_print, success_print
+from rpa_suite.functions._printer import success_print
 
+class RegexError(Exception):
+    """Custom exception for Regex errors."""
+    def __init__(self, message):
+        super().__init__(f'Regex Error: {message}')
 
 class Regex:
     """
@@ -16,19 +20,11 @@ class Regex:
         - Validating strings against specific patterns
 
     The Regex class is part of the RPA Suite and can be used to enhance text processing capabilities.
-
-    pt-br
-    ----------
-    Classe que fornece utilitários para trabalhar com expressões regulares.
-
-    Esta classe oferece funcionalidades para:
-        - Buscar padrões em texto
-        - Validar strings contra padrões específicos
-
-    A classe Regex é parte do RPA Suite e pode ser usada para aprimorar as capacidades de processamento de texto.
     """
 
-    def __init__(self): ...
+    def __init__(self) -> None:
+        """Initialize the Regex class."""
+        pass
 
     def check_pattern_in_text(
         self,
@@ -38,19 +34,25 @@ class Regex:
         display_message: bool = False,
     ) -> bool:
         """
-        Function responsible for searching in a string ``origin_text`` a pattern ``pattern_to_search`` and returning True if the pattern is found, otherwise False. ``case_sensitive`` used for exact cases or cases with diferencce upper and lower cases
+        Function responsible for searching for a pattern in a text string and returning True if the pattern is found, otherwise False.
 
-        Return:
-        ----------
-        A boolean indicating whether the pattern was found in the text.
+        Parameters:
+        -----------
+        ``origin_text: str``
+            The text where the search should be performed.
 
-        Description: pt-br
-        ----------
-        Função responsável por buscar em um texto de leitura humana uma string ``origin_text`` por um padrão ``pattern_to_search`` e retornar True se o padrão for encontrado, caso contrário, False. ``case_sensitive`` usado para casos exatos ou casos com diferença entre caixa alta e baixa nos caracteres.
+        ``pattern_to_search: str``
+            The regex pattern to search for in the text.
+
+        ``case_sensitive: bool``
+            Whether the search should be case sensitive. Default is True.
+
+        ``display_message: bool``
+            Whether to display success/failure messages. Default is False.
 
-        Retorno:
+        Return:
         ----------
-        Um booleano indicando se o padrão foi encontrado no texto.
+        A boolean indicating whether the pattern was found in the text.
         """
 
         try:
@@ -85,8 +87,6 @@ class Regex:
                     return False
 
         except Exception as e:
-
-            error_print(
-                f"Error function: {self.check_pattern_in_text.__name__} when trying to check pattern in text. Error: {str(e)}"
-            )
-            return False
+            RegexError(
+                f"Error in function: {self.check_pattern_in_text.__name__} when trying to check pattern in text. Error: {str(e)}"
+            ) from e

rpa_suite/core/validate.py

@@ -4,8 +4,12 @@
 import email_validator
 
 # imports internal
-from rpa_suite.functions._printer import error_print, success_print
+from rpa_suite.functions._printer import success_print
 
+class ValidateError(Exception):
+    """Custom exception for Validate errors."""
+    def __init__(self, message):
+        super().__init__(f'Validate Error: {message}')
 
 class Validate:
     """
@@ -17,24 +21,15 @@ class Validate:
         - Return a dictionary with information about the validity of the emails, including lists of valid and invalid emails, as well as counts for each category.
 
     The class uses the email_validator library to perform rigorous validation of email addresses, ensuring that the provided data is correct and ready for use in applications that require email communication. Additionally, it provides methods for searching words in text, enhancing its utility for text processing.
-
-    pt-br
-    ----
-    Classe responsável pela validação de endereços de e-mail e pela busca de palavras dentro de textos.
-
-    Esta classe oferece funcionalidades para:
-        - Validar uma lista de e-mails, verificando se cada um deles está em conformidade com os padrões de formatação de e-mail.
-        - Buscar palavras ou padrões específicos dentro de um texto fornecido, fornecendo informações sobre suas ocorrências.
-        - Retornar um dicionário com informações sobre a validade dos e-mails, incluindo listas de e-mails válidos e inválidos, bem como contagens de cada categoria.
-
-    A classe utiliza a biblioteca email_validator para realizar a validação rigorosa dos endereços de e-mail, garantindo que os dados fornecidos estejam corretos e prontos para uso em aplicações que requerem comunicação via e-mail. Além disso, fornece métodos para busca de palavras em textos, aumentando sua utilidade para o processamento de texto.
     """
 
-    def __init__(self): ...
+    def __init__(self) -> None: 
+        """Initialize the Validate class."""
+        pass
 
     def emails(self, email_list: list[str], display_message: bool = False) -> dict:
         """
-        Function responsible for rigorously validating a list of emails using the email_validator library. \n
+        Function responsible for rigorously validating a list of emails using the email_validator library.
 
         Parameters:
         ------------
@@ -50,25 +45,6 @@ class Validate:
             * 'qt_valids': int - number of valid emails
             * 'qt_invalids': int - number of invalid emails
             * 'map_validation' - map of the validation of each email
-
-        Description: pt-br
-        ----------
-        Função responsavel por validar de forma rigorosa lista de emails usando a biblioteca email_validator. \n
-
-        Paramentros:
-        ------------
-        ``email_list: list`` uma lista de strings contendo os emails a serem validados
-
-        Retorno:
-        ------------
-        >>> type: dict
-        Retorna um dicionário com os respectivos dados:
-            * 'success': bool - representa se a lista é 100% valida
-            * 'valid_emails': list - lista de emails validos
-            * 'invalid_emails': list - lista de emails invalidos
-            * 'qt_valids': int - quantidade de emails validos
-            * 'qt_invalids': int - quantidade de emails invalidos
-            * 'map_validation' - mapa da validação de cada email
         """
 
         # Local Variables
@@ -101,7 +77,7 @@ class Validate:
                 success_print(f"Function: {self.emails.__name__} executed.")
 
         except Exception as e:
-            error_print(f"Error when trying to validate email list: {str(e)}")
+            raise ValidateError(f"Error when trying to validate email list: {str(e)}") from e
 
         # Postprocessing
         result = {
@@ -124,19 +100,17 @@ class Validate:
         display_message: bool = False,
     ) -> dict:
         """
-        Function responsible for searching for a string, substring or word within a provided text. \n
+        Function responsible for searching for a string, substring or word within a provided text.
 
         Parameters:
         -----------
-        ``origin_text: str`` \n
+        ``origin_text: str`` 
+            It is the text where the search should be made, in string format.
 
-            * It is the text where the search should be made, in string format. \n
-
-        ``search_by: str`` accepts the values: \n
-
-            * 'string' - can find a requested writing excerpt. (default) \n
-            * 'word' - finds only the word written out exclusively. \n
-            * 'regex' - find regex patterns, [ UNDER DEVELOPMENT ...] \n
+        ``search_by: str`` accepts the values:
+            * 'string' - can find a requested writing excerpt. (default)
+            * 'word' - finds only the word written out exclusively.
+            * 'regex' - find regex patterns, [ UNDER DEVELOPMENT ...]
 
         Return:
         -----------
@@ -151,36 +125,6 @@ class Validate:
         -----------
         >>> type: list[set(int, int), ...]
             * at `index = 0` we find the first occurrence of the text, and the occurrence is composed of a PAIR of numbers in a set, the other indexes represent other positions where occurrences were found if any.
-
-        Description: pt-br
-        ----------
-        Função responsavel por fazer busca de uma string, sbustring ou palavra dentro de um texto fornecido. \n
-
-        Parametros:
-        -----------
-        ``origin_text: str`` \n
-
-            * É o texto onde deve ser feita a busca, no formato string. \n
-
-        ``search_by: str`` aceita os valores: \n
-
-            * 'string' - consegue encontrar um trecho de escrita solicitado. (default) \n
-            * 'word' - encontra apenas a palavra escrita por extenso exclusivamente. \n
-            * 'regex' - encontrar padrões de regex, [ EM DESENVOLVIMENTO ...] \n
-
-        Retorno:
-        -----------
-        >>> type:dict
-        um dicionário com todas informações que podem ser necessarias sobre a validação.
-        Sendo respectivamente:
-            * 'is_found': bool -  se o pattern foi encontrado em pelo menos um caso
-            * 'number_occurrences': int - representa o número de vezes que esse pattern foi econtrado
-            * 'positions': list[set(int, int), ...] - representa todas posições onde apareceu o pattern no texto original
-
-        Sobre o `Positions`:
-        -----------
-        >>> type: list[set(int, int), ...]
-            * no `index = 0` encontramos a primeira ocorrência do texto, e a ocorrência é composta por um PAR de números em um set, os demais indexes representam outras posições onde foram encontradas ocorrências caso hajam.
         """
 
         # Local Variables
@@ -204,7 +148,7 @@ class Validate:
                         result["is_found"] = result["number_occurrences"] > 0
 
                 except Exception as e:
-                    return error_print(f"Unable to complete the search: {searched_word}. Error: {str(e)}")
+                    return ValidateError(f"Unable to complete the search: {searched_word}. Error: {str(e)}")
 
             elif search_by == "string":
                 try:
@@ -218,10 +162,10 @@ class Validate:
                         result["is_found"] = result["number_occurrences"] > 0
 
                 except Exception as e:
-                    return error_print(f"Unable to complete the search: {searched_word}. Error: {str(e)}")
+                    return ValidateError(f"Unable to complete the search: {searched_word}. Error: {str(e)}")
 
         except Exception as e:
-            return error_print(f"Unable to search for: {searched_word}. Error: {str(e)}")
+            raise ValidateError(f"Unable to search for: {searched_word}. Error: {str(e)}") from e
 
         # Postprocessing
         if result["is_found"]:

rpa_suite/functions/__init__.py

@@ -1,3 +1,3 @@
 # rpa_suite/functions/__init__.py
 
-__version__ = "1.6.1"
+__version__ = "1.6.2"

rpa_suite/suite.py

@@ -22,6 +22,10 @@ import subprocess
 import sys
 import hashlib
 
+class SuiteError(Exception):
+    """Custom exception for Suite errors."""
+    def __init__(self, message):
+        super().__init__(f'SuiteError: {message}')
 
 # Windows bash colors
 class Colors:
@@ -107,6 +111,7 @@ class Suite:
         ``AsyncRunner``: Object AsyncRunner functions to run in Assyncronous
         ``Browser``: Object Browser automation functions (neeeds Selenium and Webdriver_Manager)
         ``Iris``: Object Iris automation functions to convert documents with OCR + IA based on ``docling``
+        ``Artemis``: Object Artemis automation functions to desktopbot similar Botcity with ``pyautogui``
 
     pt-br
     -----
@@ -140,6 +145,7 @@ class Suite:
         ``AsyncRunner``: Objeto AsyncRunner funções para rodar processos em assincronicidade
         ``Browser``: Objeto de Automação de Navegadores (necessario Selenium e Webdriver_Manager)
         ``Iris``: Objeto Iris Automação de funções para converter documentos com OCR + IA baseado em ``docling``
+        ``Artemis``: Objeto Artemis funções de automação para desktop similar ao Botcity com ``pyautogui``
     """
 
     # SUBMODULES
@@ -171,7 +177,13 @@ class Suite:
         from .core.iris import Iris
 
         iris: Iris = Iris
-        
+    
+    # from .iris import Iris
+    if importlib.util.find_spec("pyautogui"):
+        from .core.artemis import Artemis
+
+        artemis: Artemis = Artemis
+      
     # VARIABLES INTERNAL
     try:
         # old: __version__ = pkg_resources.get_distribution("rpa_suite").version

rpa_suite/utils/__init__.py

@@ -12,4 +12,4 @@ O módulo de utilitários da rpa-suite fornece uma coleção de funções e clas
 from .system import Tools
 
 
-__version__ = "1.6.1"
+__version__ = "1.6.2"