rpa-suite 1.5.3__py3-none-any.whl → 1.5.4__py3-none-any.whl

rpa_suite/core/validate.py

@@ -7,8 +7,7 @@ from rpa_suite.functions._printer import error_print, success_print
 import email_validator
 
 
-class Validate():
-
+class Validate:
     """
     Class responsible for validating email addresses and searching for words within text.
 
@@ -30,22 +29,17 @@ class Validate():
 
     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 emails(self,
-                    email_list: list[str],
-                    display_message: bool = False
-                    ) -> dict:
-        
+
+    def __init__(self): ...
+
+    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
-        
+
         Parameters:
         ------------
         ``email_list: list`` a list of strings containing the emails to be validated
-        
+
         Return:
         ------------
         >>> type: dict
@@ -56,15 +50,15 @@ 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
@@ -76,23 +70,22 @@ class Validate():
             * 'qt_invalids': int - quantidade de emails invalidos
             * 'map_validation' - mapa da validação de cada email
         """
-        
+
         # Local Variables
         result: dict = {
-            'success': bool,
-            'valid_emails': list,
-            'invalid_emails': list,
-            'qt_valids': int,
-            'qt_invalids': int,
-            'map_validation': list[dict]
+            "success": bool,
+            "valid_emails": list,
+            "invalid_emails": list,
+            "qt_valids": int,
+            "qt_invalids": int,
+            "map_validation": list[dict],
         }
 
-        
         # Preprocessing
         validated_emails: list = []
         invalid_emails: list = []
         map_validation: list[dict] = []
-        
+
         # Process
         try:
             for email in email_list:
@@ -100,52 +93,51 @@ class Validate():
                     v = email_validator.validate_email(email)
                     validated_emails.append(email)
                     map_validation.append(v)
-                    
+
                 except email_validator.EmailNotValidError:
                     invalid_emails.append(email)
-            
-            if display_message: success_print(f'Function: {self.emails.__name__} executed.')
+
+            if display_message:
+                success_print(f"Function: {self.emails.__name__} executed.")
 
         except Exception as e:
-            error_print(f'Error when trying to validate email list: {str(e)}')
+            error_print(f"Error when trying to validate email list: {str(e)}")
 
-        
         # Postprocessing
         result = {
-            'success': len(invalid_emails) == 0,
-            'valid_emails': validated_emails,
-            'invalid_emails': invalid_emails,
-            'qt_valids': len(validated_emails),
-            'qt_invalids': len(invalid_emails),
-            'map_validation': map_validation
+            "success": len(invalid_emails) == 0,
+            "valid_emails": validated_emails,
+            "invalid_emails": invalid_emails,
+            "qt_valids": len(validated_emails),
+            "qt_invalids": len(invalid_emails),
+            "map_validation": map_validation,
         }
-        
-        return result
 
+        return result
 
-    def word(self,
-                origin_text: str,
-                searched_word: str,
-                case_sensitivy: bool = True,
-                search_by: str = 'string',
-                display_message: bool = False
-                ) -> dict:
-        
+    def word(
+        self,
+        origin_text: str,
+        searched_word: str,
+        case_sensitivy: bool = True,
+        search_by: str = "string",
+        display_message: bool = False,
+    ) -> dict:
         """
         Function responsible for searching for a string, substring or word within a provided text. \n
-        
+
         Parameters:
         -----------
         ``origin_text: str`` \n
-            
+
             * 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
-        
+
         Return:
         -----------
         >>> type:dict
@@ -154,28 +146,28 @@ class Validate():
             * 'is_found': bool -  if the pattern was found in at least one case
             * 'number_occurrences': int - represents the number of times this pattern was found
             * 'positions': list[set(int, int), ...] - represents all positions where the pattern appeared in the original text
-            
+
         About `Positions`:
         -----------
         >>> 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
@@ -184,62 +176,73 @@ class Validate():
             * '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
-        result: dict = {
-            'is_found': False,
-            'number_occurrences': 0,
-            'positions': []
-        }
+        result: dict = {"is_found": False, "number_occurrences": 0, "positions": []}
 
         # Preprocessing
-        result['is_found'] = False
+        result["is_found"] = False
 
         # Process
         try:
-            if search_by == 'word':
+            if search_by == "word":
                 origin_words = origin_text.split()
                 try:
                     if case_sensitivy:
-                        result['number_occurrences'] = origin_words.count(searched_word)
-                        result['is_found'] = result['number_occurrences'] > 0
+                        result["number_occurrences"] = origin_words.count(searched_word)
+                        result["is_found"] = result["number_occurrences"] > 0
                     else:
                         words_lowercase = [word.lower() for word in origin_words]
                         searched_word_lower = searched_word.lower()
-                        result['number_occurrences'] = words_lowercase.count(searched_word_lower)
-                        result['is_found'] = result['number_occurrences'] > 0
-                        
+                        result["number_occurrences"] = words_lowercase.count(
+                            searched_word_lower
+                        )
+                        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)}')
-                    
-            elif search_by == 'string':
+                    return error_print(
+                        f"Unable to complete the search: {searched_word}. Error: {str(e)}"
+                    )
+
+            elif search_by == "string":
                 try:
                     if case_sensitivy:
-                        result['number_occurrences'] = origin_text.count(searched_word)
-                        result['is_found'] = result['number_occurrences'] > 0
+                        result["number_occurrences"] = origin_text.count(searched_word)
+                        result["is_found"] = result["number_occurrences"] > 0
                     else:
                         origin_text_lower = origin_text.lower()
                         searched_word_lower = searched_word.lower()
-                        result['number_occurrences'] = origin_text_lower.count(searched_word_lower)
-                        result['is_found'] = result['number_occurrences'] > 0
-                        
+                        result["number_occurrences"] = origin_text_lower.count(
+                            searched_word_lower
+                        )
+                        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 error_print(
+                        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)}')
+            return error_print(
+                f"Unable to search for: {searched_word}. Error: {str(e)}"
+            )
 
         # Postprocessing
-        if result['is_found']:
-            if display_message: success_print(f'Function: {self.word.__name__} found: {result["number_occurrences"]} occurrences for "{searched_word}".')
+        if result["is_found"]:
+            if display_message:
+                success_print(
+                    f'Function: {self.word.__name__} found: {result["number_occurrences"]} occurrences for "{searched_word}".'
+                )
         else:
-            if display_message: success_print(f'Function: {self.word.__name__} found no occurrences of "{searched_word}" during the search.')
+            if display_message:
+                success_print(
+                    f'Function: {self.word.__name__} found no occurrences of "{searched_word}" during the search.'
+                )
 
         return result
-

rpa_suite/functions/__create_ss_dir.py

@@ -8,9 +8,9 @@ import os
 from typing import Union
 
 
-
-def __create_ss_dir(path_to_create: str = 'default', name_ss_dir: str='screenshots') -> dict[str, Union[bool, str, None]]:
-
+def __create_ss_dir(
+    path_to_create: str = "default", name_ss_dir: str = "screenshots"
+) -> dict[str, Union[bool, str, None]]:
     """
     Function responsible for creating a screenshots directory to work with your screenshot files. \n
 
@@ -25,7 +25,7 @@ def __create_ss_dir(path_to_create: str = 'default', name_ss_dir: str='screensho
     >>> type:dict
         * 'success': bool - represents case the action was performed successfully
         * 'path_created': str - path of the directory that was created on the process
-        
+
     Description: pt-br
     ----------
     Função responsavel por criar diretório de screenshots para trabalhar com seus arquivos de sreenshot. \n
@@ -42,16 +42,16 @@ def __create_ss_dir(path_to_create: str = 'default', name_ss_dir: str='screensho
         * 'success': bool - representa se ação foi realizada com sucesso
         * 'path_created': str - path do diretório que foi criado no processo
     """
-    
+
     # Local Variables
     result: dict = {
-        'success': bool,
-        'path_created': str,
+        "success": bool,
+        "path_created": str,
     }
-    
+
     try:
         # by 'default', defines path to local script execution path
-        if path_to_create == 'default':
+        if path_to_create == "default":
             path_to_create: str = os.getcwd()
 
         # Build path to new dir
@@ -63,25 +63,29 @@ def __create_ss_dir(path_to_create: str = 'default', name_ss_dir: str='screensho
             # Successefully created
             os.makedirs(full_path, exist_ok=False)
 
-            result['success'] = True
-            result['path_created'] = fr'{full_path}'
+            result["success"] = True
+            result["path_created"] = rf"{full_path}"
 
             success_print(f"Diretório:'{full_path}' foi criado com sucesso.")
 
         except FileExistsError:
-            result['success'] = False
-            result['path_created'] = full_path
+            result["success"] = False
+            result["path_created"] = full_path
             # alert_print(f"Diretório:'{full_path}' já existe.")
 
         except PermissionError:
-            result['success'] = False
-            result['path_created'] = None
-            alert_print(f"Permissão negada: não é possível criar o diretório '{full_path}'.")
+            result["success"] = False
+            result["path_created"] = None
+            alert_print(
+                f"Permissão negada: não é possível criar o diretório '{full_path}'."
+            )
 
     except Exception as e:
-        result['success'] = False
-        result['path_created'] = None
-        error_print(f'Error capturing current path to create screenshots directory! Error: {str(e)}')
-        
+        result["success"] = False
+        result["path_created"] = None
+        error_print(
+            f"Error capturing current path to create screenshots directory! Error: {str(e)}"
+        )
+
     finally:
         return result

rpa_suite/functions/__init__.py

@@ -1 +1 @@
-# rpa_suite/functions/__init__.py
+# rpa_suite/functions/__init__.py

rpa_suite/functions/_printer.py

@@ -5,18 +5,18 @@ from colorama import Fore
 
 
 # Windows bash colors
-class Colors():
-    black     = f'{Fore.BLACK}'
-    blue      = f'{Fore.BLUE}'
-    green     = f'{Fore.GREEN}'
-    cyan      = f'{Fore.CYAN}'
-    red       = f'{Fore.RED}'
-    magenta   = f'{Fore.MAGENTA}'
-    yellow    = f'{Fore.YELLOW}'
-    white     = f'{Fore.WHITE}'
-    default   = f'{Fore.WHITE}'
-    call_fn   = f'{Fore.LIGHTMAGENTA_EX}'
-    retur_fn  = f'{Fore.LIGHTYELLOW_EX}'
+class Colors:
+    black = f"{Fore.BLACK}"
+    blue = f"{Fore.BLUE}"
+    green = f"{Fore.GREEN}"
+    cyan = f"{Fore.CYAN}"
+    red = f"{Fore.RED}"
+    magenta = f"{Fore.MAGENTA}"
+    yellow = f"{Fore.YELLOW}"
+    white = f"{Fore.WHITE}"
+    default = f"{Fore.WHITE}"
+    call_fn = f"{Fore.LIGHTMAGENTA_EX}"
+    retur_fn = f"{Fore.LIGHTYELLOW_EX}"
 
 
 def success_print(string_text: str, color=Colors.green, ending="\n") -> None:
@@ -35,7 +35,7 @@ def success_print(string_text: str, color=Colors.green, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    print(f'{color}{string_text}{Colors.default}', end=ending) 
+    print(f"{color}{string_text}{Colors.default}", end=ending)
 
 
 def alert_print(string_text: str, color=Colors.yellow, ending="\n") -> None:
@@ -53,7 +53,7 @@ def alert_print(string_text: str, color=Colors.yellow, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    print(f'{color}{string_text}{Colors.default}', end=ending) 
+    print(f"{color}{string_text}{Colors.default}", end=ending)
 
 
 def info_print(string_text: str, color=Colors.cyan, ending="\n") -> None:
@@ -71,7 +71,7 @@ def info_print(string_text: str, color=Colors.cyan, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    print(f'{color}{string_text}{Colors.default}', end=ending) 
+    print(f"{color}{string_text}{Colors.default}", end=ending)
 
 
 def error_print(string_text: str, color=Colors.red, ending="\n") -> None:
@@ -89,7 +89,7 @@ def error_print(string_text: str, color=Colors.red, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    print(f'{color}{string_text}{Colors.default}', end=ending) 
+    print(f"{color}{string_text}{Colors.default}", end=ending)
 
 
 def magenta_print(string_text: str, color=Colors.magenta, ending="\n") -> None:
@@ -107,7 +107,7 @@ def magenta_print(string_text: str, color=Colors.magenta, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    print(f'{color}{string_text}{Colors.default}', end=ending) 
+    print(f"{color}{string_text}{Colors.default}", end=ending)
 
 
 def blue_print(string_text: str, color=Colors.blue, ending="\n") -> None:
@@ -125,7 +125,7 @@ def blue_print(string_text: str, color=Colors.blue, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    print(f'{color}{string_text}{Colors.default}', end=ending)
+    print(f"{color}{string_text}{Colors.default}", end=ending)
 
 
 def print_call_fn(string_text: str, color=Colors.call_fn, ending="\n") -> None:
@@ -144,7 +144,7 @@ def print_call_fn(string_text: str, color=Colors.call_fn, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    print(f'{color}{string_text}{Colors.default}', end=ending)
+    print(f"{color}{string_text}{Colors.default}", end=ending)
 
 
 def print_retur_fn(string_text: str, color=Colors.retur_fn, ending="\n") -> None:
@@ -163,4 +163,4 @@ def print_retur_fn(string_text: str, color=Colors.retur_fn, ending="\n") -> None
     ----------
         >>> type:None
     """
-    print(f'{color}{string_text}{Colors.default}', end=ending)
+    print(f"{color}{string_text}{Colors.default}", end=ending)