rpa-suite 1.3.3__py3-none-any.whl → 1.3.5__py3-none-any.whl

rpa_suite/core/validate.py

@@ -0,0 +1,220 @@
+# /mail_validator.py
+
+import email_validator
+from rpa_suite.functions._printer import error_print, success_print
+
+
+class Validate():
+    
+    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
+        Returns a dictionary with the respective data:
+            * 'success': bool - represents if the list is 100% valid
+            * 'valid_emails': list - list of valid emails
+            * 'invalid_emails': list - list of invalid emails
+            * '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
+        result: 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:
+                try:
+                    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.')
+
+        except Exception as 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
+        }
+        
+        return result
+
+
+    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
+        a dictionary with all information that may be necessary about the validation.
+        Respectively being:
+            * '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
+        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
+        result: dict = {
+            'is_found': False,
+            'number_occurrences': 0,
+            'positions': []
+        }
+
+        # Preprocessing
+        result['is_found'] = False
+
+        # Process
+        try:
+            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
+                    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
+                        
+                except Exception as e:
+                    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
+                    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
+                        
+                except Exception as 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)}')
+
+        # Postprocessing
+        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.')
+
+        return result
+

rpa_suite/{log → functions}/__create_log_dir.py

@@ -2,7 +2,7 @@
 
 import os
 from typing import Union
-from rpa_suite.log.printer import error_print, alert_print, success_print
+from rpa_suite.functions._printer import error_print, alert_print, success_print
 
 
 def _create_log_dir(path_to_create: str = 'default', name_log_dir: str='logs') -> dict[str, Union[bool, str, None]]:
@@ -38,15 +38,13 @@ def _create_log_dir(path_to_create: str = 'default', name_log_dir: str='logs') -
         * '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,
     }
-
-
+    
     try:
         # by 'default', defines path to local script execution path
         if path_to_create == 'default':
@@ -64,7 +62,7 @@ def _create_log_dir(path_to_create: str = 'default', name_log_dir: str='logs') -
             result['success'] = True
             result['path_created'] = fr'{full_path}'
 
-            success_print(f"Dir:'{full_path}' created!")
+            success_print(f"Diretório:'{full_path}' foi criado com sucesso.")
 
         except FileExistsError:
             result['success'] = False
@@ -74,7 +72,7 @@ def _create_log_dir(path_to_create: str = 'default', name_log_dir: str='logs') -
         except PermissionError:
             result['success'] = False
             result['path_created'] = None
-            alert_print(f"Permission Denied: Not Able to create: '{full_path}'.")
+            alert_print(f"Permissão negada: não é possível criar o diretório '{full_path}'.")
 
     except Exception as e:
         result['success'] = False

rpa_suite/{file → functions}/__create_ss_dir.py

@@ -2,13 +2,13 @@
 
 import os
 from typing import Union
-from rpa_suite.log.printer import error_print, alert_print, success_print
+from rpa_suite.functions._printer import error_print, alert_print, success_print
 
 
 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
+    Function responsible for creating a screenshots directory to work with your screenshot files. \n
 
     Parameters:
     ----------

rpa_suite/functions/__init__.py

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

rpa_suite/{log → functions}/_functions_logger.py

@@ -2,7 +2,7 @@
 
 import logging
 from ._logger import file_handler
-from rpa_suite.log.printer import error_print, success_print
+from rpa_suite.functions._printer import error_print, success_print
 
 
 def log_start_run_debug(msg_start_loggin: str) -> None: # represent start application
@@ -17,7 +17,7 @@ def log_start_run_debug(msg_start_loggin: str) -> None: # represent start applic
         success_print(f'{msg_start_loggin}')
 
     except Exception as e:
-        error_print(f'Error to execute function:{log_start_run_debug.__name__}! Error: {str(e)}')
+        error_print(f'Erro durante a função: {log_start_run_debug.__name__}! Error: {str(e)}')
 
 
 def log_debug(msg) -> None:
@@ -30,7 +30,7 @@ def log_debug(msg) -> None:
         logging.debug(msg)
 
     except Exception as e:
-        error_print(f'Error to execute function:{log_debug.__name__}! Error: {str(e)}')
+        error_print(f'Erro durante a função: {log_debug.__name__}! Error: {str(e)}')
 
 def log_info(msg) -> None:
 
@@ -42,7 +42,7 @@ def log_info(msg) -> None:
         logging.info(msg)
 
     except Exception as e:
-        error_print(f'Error to execute function:{log_debug.__name__}! Error: {str(e)}')
+        error_print(f'Erro durante a função: {log_debug.__name__}! Error: {str(e)}')
         
 def log_info(msg) -> None:
 
@@ -54,7 +54,7 @@ def log_info(msg) -> None:
         logging.info(msg)
 
     except Exception as e:
-        error_print(f'Error to execute function:{log_info.__name__}! Error: {str(e)}')
+        error_print(f'Erro durante a função: {log_info.__name__}! Error: {str(e)}')
 
 
 def log_warning(msg) -> None:
@@ -67,7 +67,7 @@ def log_warning(msg) -> None:
         logging.warning(msg)
 
     except Exception as e:
-        error_print(f'Error to execute function:{log_warning.__name__}! Error: {str(e)}')
+        error_print(f'Erro durante a função: {log_warning.__name__}! Error: {str(e)}')
 
 
 def log_error(msg) -> None:
@@ -80,7 +80,7 @@ def log_error(msg) -> None:
         logging.error(msg)
 
     except Exception as e:
-        error_print(f'Error to execute function:{log_error.__name__}! Error: {str(e)}')
+        error_print(f'Erro durante a função: {log_error.__name__}! Error: {str(e)}')
 
 
 def log_critical(msg) -> None:
@@ -93,4 +93,4 @@ def log_critical(msg) -> None:
         logging.critical(msg)
 
     except Exception as e:
-        error_print(f'Error to execute function:{log_critical.__name__}! Error: {str(e)}')
+        error_print(f'Erro durante a função: {log_critical.__name__}! Error: {str(e)}')

rpa_suite/{log → functions}/_logger.py

@@ -7,7 +7,7 @@ from colorlog import ColoredFormatter
 from typing import Optional as Op
 from ._variables import file_handler, stream_handler
 from .__create_log_dir import _create_log_dir
-from rpa_suite.log.printer import error_print
+from rpa_suite.functions._printer import error_print
 
 
 class Filters(Filter):
@@ -29,7 +29,7 @@ class Filters(Filter):
                 input()"""
                 for word in string_words:
                     if word in record.msg:
-                        record.msg = 'Log with filtered words!'
+                        record.msg = 'Log Alterado devido a palavra Filtrada!'
                         return True
 
         return True
@@ -109,5 +109,5 @@ def config_logger(name_app:str = 'Logger', path_dir:str = None, name_log_dir:str
 
     except Exception as e:
 
-        error_print(f'Error to execute function:{config_logger.__name__}! Error: {str(e)}.')
+        error_print(f'Houve um erro durante a execução da função: {config_logger.__name__}! Error: {str(e)}.')
         return None