rpa-suite 0.9.3__tar.gz → 0.9.4__tar.gz

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rpa_suite
-Version: 0.9.3
+Version: 0.9.4
 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
@@ -150,7 +150,7 @@ O módulo principal do rpa-suite é dividido em categorias. Cada categoria cont
         - **string_validator** - Funções para validação/varredura (strings, substrings, palavras)
 
 ## Release
-Versão: **Alpha 0.9.3**
+Versão: **Alpha 0.9.4**
 
 Lançamento: *20/02/2024*
 

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/README.md

@@ -125,7 +125,7 @@ O módulo principal do rpa-suite é dividido em categorias. Cada categoria cont
         - **string_validator** - Funções para validação/varredura (strings, substrings, palavras)
 
 ## Release
-Versão: **Alpha 0.9.3**
+Versão: **Alpha 0.9.4**
 
 Lançamento: *20/02/2024*
 

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/rpa_suite/clock/exec_at.py

@@ -8,7 +8,7 @@ def exec_at_hour(
                 fn_to_exec: Callable[..., Any],
                 *args,
                 **kwargs,
-                ) -> dict:
+                ) -> dict[str, bool]:
     
     """
     Timed function, executes the function at the specified time, by ``default`` it executes at runtime, optionally you can choose the time for execution.
@@ -65,35 +65,18 @@ def exec_at_hour(
     minutes: str
     moment_now: str
     
-    # Preprocessing
-    run = True
-    now = dt.now()
-    hours = str(now.hour) if now.hour > 10 else f"0{now.hour}"
-    minutes = str(now.minute) if now.minute > 10 else f"0{now.minute}"
-    moment_now = f'{hours}:{minutes}'
-    
-    if hour_to_exec == None:
+    try:
+        # Preprocessing
+        run = True
+        now = dt.now()
+        hours = str(now.hour) if now.hour > 10 else f"0{now.hour}"
+        minutes = str(now.minute) if now.minute > 10 else f"0{now.minute}"
+        moment_now = f'{hours}:{minutes}'
         
-        # Process
-        while run:
-            try:
-                fn_to_exec(*args, **kwargs)
-                run = False
-                result['tried'] = not run
-                result['success'] = True
-                success_print(f'{fn_to_exec.__name__}: Successfully executed!')
-                break
-                
-            except Exception as e:
-                run = False
-                result['tried'] = not run
-                result['success'] = False
-                error_print(f'An error occurred that prevented the function from executing: {fn_to_exec.__name__} correctly. Error: {str(e)}')
-                break
-    else:
-        # Executes the function call only at the time provided in the argument.
-        while run:
-            if moment_now == hour_to_exec:
+        if hour_to_exec == None:
+            
+            # Process
+            while run:
                 try:
                     fn_to_exec(*args, **kwargs)
                     run = False
@@ -108,11 +91,35 @@ def exec_at_hour(
                     result['success'] = False
                     error_print(f'An error occurred that prevented the function from executing: {fn_to_exec.__name__} correctly. Error: {str(e)}')
                     break
-            else:
-                time.sleep(30)
-                now = dt.now()
-                hours = str(now.hour) if now.hour > 10 else f"0{now.hour}"
-                minutes = str(now.minute) if now.minute > 10 else f"0{now.minute}"
-                moment_now = f'{hours}:{minutes}'
+        else:
+            # Executes the function call only at the time provided in the argument.
+            while run:
+                if moment_now == hour_to_exec:
+                    try:
+                        fn_to_exec(*args, **kwargs)
+                        run = False
+                        result['tried'] = not run
+                        result['success'] = True
+                        success_print(f'{fn_to_exec.__name__}: Successfully executed!')
+                        break
+                        
+                    except Exception as e:
+                        run = False
+                        result['tried'] = not run
+                        result['success'] = False
+                        error_print(f'An error occurred that prevented the function from executing: {fn_to_exec.__name__} correctly. Error: {str(e)}')
+                        break
+                else:
+                    time.sleep(30)
+                    now = dt.now()
+                    hours = str(now.hour) if now.hour > 10 else f"0{now.hour}"
+                    minutes = str(now.minute) if now.minute > 10 else f"0{now.minute}"
+                    moment_now = f'{hours}:{minutes}'
 
-    return result
+        return result
+    
+    except Exception as e:
+        
+        result['success'] = False
+        error_print(f'An error occurred on function from executing: {fn_to_exec.__name__}. Error: {str(e)}')
+        return result

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/rpa_suite/clock/waiter.py

@@ -7,7 +7,7 @@ def wait_for_exec(
                 fn_to_exec: Callable[..., Any],
                 *args,
                 **kwargs
-                ) -> dict:
+                ) -> dict[str, bool]:
     
     """
     Timer function, wait for a value in ``seconds`` to execute the function of the argument.
@@ -74,7 +74,7 @@ def exec_and_wait(
                 fn_to_exec: Callable[..., Any],
                 *args,
                 **kwargs
-                ) -> dict:
+                ) -> dict[str, bool]:
     
     """
     Timer function, executes a function and waits for the time in ``seconds``

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/rpa_suite/date/date.py

@@ -1,9 +1,10 @@
 import datetime as dt
+from typing import Optional as Op
+from typing import Tuple
 from rpa_suite.log.printer import error_print
 
 
-        
-def get_hms() -> tuple:
+def get_hms() -> Tuple[Op[str], Op[str], Op[str]]:
     
     """
     Function to return hour, minute and second. The return is in the form of a tuple with strings being able to store and use the values individually.
@@ -63,10 +64,14 @@ def get_hms() -> tuple:
                 hours[1:]
                 
         return hours, minutes, seconds
+    
     except Exception as e:
-        return error_print(f'Unable to capture the time. Error: {str(e)}')
 
-def get_dma() -> tuple:
+        error_print(f'Unable to capture the time. Error: {str(e)}')
+        return None, None, None
+
+
+def get_dma() -> Tuple[Op[str], Op[str], Op[str]]:
     """
     Function to return day, month and year. The return is in the form of a tuple with strings being able to store and use the values individually.
     
@@ -112,4 +117,6 @@ def get_dma() -> tuple:
         return day_got, month_got, year_got
     
     except Exception as e:
-        return error_print(f'Unable to capture the time. Error: {str(e)}')
+
+        error_print(f'Unable to capture the time. Error: {str(e)}')
+        return None, None, None

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/rpa_suite/email/sender_smtp.py

@@ -122,6 +122,7 @@ def send_email(
             
     # Add Attachment
     if attachments:
+        result['qt_attach'] = 0
         result['attchament'] = True
         for path_to_attach in attachments:
             file_name = os.path.basename(path_to_attach)
@@ -170,7 +171,7 @@ def send_email(
         server_by_smtp.quit()
         result['success'] = True
         success_print(f'Email(s) Sent!')
-        
+
 
     except smtplib.SMTPException as e:
         result['success'] = False

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/rpa_suite/file/counter.py

@@ -1,53 +1,53 @@
 import os
+from typing import Dict, List, Union
 from rpa_suite.log.printer import error_print, success_print
 
+
 def count_files(
-                dir_to_count: list[str], 
-                type_extension: str = '*'
-                ) -> dict:
-    
+    dir_to_count: List[str], 
+    type_extension: str = '*'
+) -> Dict[str, Union[bool, int]]:
+
     """
     Function responsible for counting files within a folder, considers subfolders to do the count, searches by file type, being all files by default. \n
-    
+
     Parameters:
     ----------
     ``dir_to_count: list`` - should be a list, accepts more than one path to count files.
     ``type_extension: str`` - should be a string with the format/extension of the type of file you want to be searched for counting, if empty by default will be used ``*`` which will count all files.
 
-    
     Return:
     ----------
     >>> type:dict
         * 'success': bool - represents if the action was performed successfully
         * 'qt': int - number that represents the quantity of files that were counted
-        
+
     Description: pt-br
     ----------
     Função responsavel por fazer a contagem de arquivos dentro de uma pasta, considera subpastas para fazer a contagem, busca por tipo de arquivo, sendo todos arquivos por default. \n
-    
+
     Parametros:
     ----------
     ``dir_to_count: list`` - deve ser uma lista, aceita mais de um caminho para contar arquivos.
     ``type_extension: str`` - deve ser uma string com o formato/extensão do tipo de arquivo que deseja ser buscado para contagem, se vazio por default sera usado ``*`` que contará todos arquivos.
 
-    
     Retorno:
     ----------
     >>> type:dict
         * 'success': bool - representa se ação foi realizada com sucesso
         * 'qt': int - numero que representa a quantidade de arquivos que foram contados
     """
-    
+
     # Local Variables
     result: dict = {
         'success': bool,
         'qt': int
     }
-    
+
     # Preprocessing
-    result['qt'] = 0
     result['success'] = False
-    
+    result['qt'] = 0
+
     # Process
     try:
         for dir in dir_to_count:
@@ -57,9 +57,10 @@ def count_files(
                         result['qt'] += 1
         result['success'] = True
         success_print(f'Function: {count_files.__name__} counted {result["qt"]} files.')
-        
+
     except Exception as e:
         result['success'] = False
         error_print(f'Error when trying to count files! Error: {str(e)}')
-        
-    return result
+
+    finally:
+        return result

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/rpa_suite/log/loggin.py

@@ -4,7 +4,7 @@ from loguru import logger
 def logging_decorator(
                     fn: Callable
                     ) -> Callable:
-    
+
     """
     Function responsible for displaying log message in the console for functions that are called. \n
     Displays function name, and the result of the function in case of return, without return returns None.

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/rpa_suite/log/printer.py

@@ -1,4 +1,4 @@
-from colorama import Fore, Back, Style
+from colorama import Fore
 
 # Windows bash colors
 class Colors():
@@ -18,29 +18,30 @@ class Colors():
 def success_print(string_text: str, color=Colors.green, ending="\n") -> None:
     """
     Print that indicates ``SUCCESS``. Customized with the color Green \n
-    
+
     Return:
     ----------
         >>> type:None
-        
+
     pt-br
     ----------
     Print  que indica ``SUCESSO``. Personalizado com a cor Verde \n
-    
+
     Retorno:
     ----------
         >>> type:None
     """
-    return 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:
     """
     Print that indicates ``ALERT``. Customized with the color Yellow \n
-    
+
     Return:
     ----------
         >>> type:None
-    
+
     pt-br
     ----------
     Print que indica ``ALERTA``. Personalizado com a cor Amarelo \n
@@ -48,16 +49,17 @@ def alert_print(string_text: str, color=Colors.yellow, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    return 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:
     """
     Print that indicates ``INFORMATION``. Customized with the color Cyan \n
-    
+
     Return:
     ----------
         >>> type:None
-        
+
     pt-br
     ----------
     Print que indica ``INFORMATIVO``. Personalizado com a cor Ciano \n
@@ -65,16 +67,17 @@ def info_print(string_text: str, color=Colors.cyan, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    return 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:
     """
     Print that indicates ``ERROR``. Customized with the color Red \n
-    
+
     Return:
     ----------
         >>> type:None
-        
+
     pt-br
     ----------
     Print que indica ``ERRO``. Personalizado com a cor Vermelho \n
@@ -82,16 +85,17 @@ def error_print(string_text: str, color=Colors.red, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    return 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:
     """
     Print customized with the color Magenta \n
-    
+
     Return:
     ----------
         >>> type:None
-    
+
     pt-br
     ----------
     Print personalizado com a cor Magenta \n
@@ -99,16 +103,17 @@ def magenta_print(string_text: str, color=Colors.magenta, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    return 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:
     """
     Print customized with the color Blue \n
-    
+
     Return:
     ----------
         >>> type:None
-    
+
     pt-br
     ----------
     Print personalizado com a cor Azul \n
@@ -116,7 +121,8 @@ def blue_print(string_text: str, color=Colors.blue, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    return 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:
     """
@@ -125,7 +131,7 @@ def print_call_fn(string_text: str, color=Colors.call_fn, ending="\n") -> None:
     Return:
     ----------
         >>> type:None
-    
+
     pt-br
     ----------
     Print personalizado para log de chamada de função. \n
@@ -134,7 +140,8 @@ def print_call_fn(string_text: str, color=Colors.call_fn, ending="\n") -> None:
     ----------
         >>> type:None
     """
-    return 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:
     """
@@ -143,7 +150,7 @@ def print_retur_fn(string_text: str, color=Colors.retur_fn, ending="\n") -> None
     Return:
     ----------
         >>> type:None
-    
+
     pt-br
     ----------
     Print personalizado para log de chamada de função. \n
@@ -152,4 +159,4 @@ def print_retur_fn(string_text: str, color=Colors.retur_fn, ending="\n") -> None
     ----------
         >>> type:None
     """
-    return print(f'{color} {string_text} {Colors.default}', end=ending)
+    print(f'{color} {string_text} {Colors.default}', end=ending)

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/rpa_suite/regex/list_from_text.py

@@ -3,9 +3,10 @@ from typing import Any
 from rpa_suite.log.printer import error_print, success_print
 
 def create_list_using_regex(origin_text: str, division_pattern: str) -> list[str] | Any:
+
     """
     Function responsible for searching in a string ``origin_text`` a pattern ``division_pattern`` and dividing the original text into substrings generating a list of strings, also does the cleaning and treatment to keep the list with the original strings, but divided
-    
+
     Return:
     ----------
     A list of strings divided by the pattern used in the argument passed as a parameter.
@@ -13,11 +14,12 @@ def create_list_using_regex(origin_text: str, division_pattern: str) -> list[str
     Description: pt-br
     ----------
     Função responsável por buscar em  um texto de leitura humana uma string ``origin_text`` por um padrão ``division_pattern`` e dividir o texto original em substrings gerando uma lista de strings, também faz a limpeza e tratamento para manter a lista com as strings originais, porem dividas
-    
+
     Retorno:
     ----------
     Uma lista de strings dividas pelo padrão utilizada no argumento passado como parametro.
     """
+
     try:
         # creates a delimiter and uses it to split the string based on the pattern
         text_with_delim = re.sub(division_pattern, r'\1<DELIMITADOR>', origin_text)
@@ -33,11 +35,11 @@ def create_list_using_regex(origin_text: str, division_pattern: str) -> list[str
         # Removes the delimiter \n both left and right from each element of the list
         messages_striped = [msg.strip() for i, msg in enumerate(messages)]
         messages_lstriped = [msg.lstrip() for msg in messages_striped]
-        
+
         # Removes the delimiter that has been placed between punctuation within the same pattern.
         messages_final = [msg.replace('\n', ' ') for msg in messages_lstriped]
         success_print(f'List generated successfully!')
         return messages_final
-            
+
     except Exception as e:
-        return error_print(f"Error when trying to create list using pattern-match (regex). Error: {str(e)}")
+        error_print(f"Error when trying to create list using pattern-match (regex). Error: {str(e)}")

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/rpa_suite/suite.py

@@ -26,46 +26,46 @@ from .validate.string_validator import search_in
 class Rpa_suite():
     """
     The ``Rpa_suite`` class is a generic representation of the modules, with the aim of centralizing all submodules for access through an instance of this representational Object. It contains variables pointed to the functions of the submodules present in the rpa-site.
-    
+
     Call
     ----------
     When calling the maintainer file of this class, an instance of this object will be invoked to be used or reused through another variable
-    
+
     Objective
     ----------
     Flexibility being able to call each submodule individually or by importing the representational object of all submodules.
-    
+
     Description: pt-br
     ----------
     Classe ``Rpa_suite`` é uma representação genérica do dos módulos, com objetivo de centralizar todos submódulos para acesso através de uma instância deste Objeto representacional. Ele contem variaveis apontadas para as funções dos submódulos presentes no rpa-site.
-    
+
     Chamada
     ----------
     Ao chamar o arquivo mantenedor desta classe, sera invocada uma instancia deste objeto para poder ser utilziado ou reutilizado através de outra variável
-    
+
     Objetivo
     ----------
     Flexibilidade podendo chamar cada submódulo de forma individual ou fazendo a importação do objeto representacional de todos submódulos.
     """
-    
+
     # clock
     wait_for_exec = wait_for_exec
     exec_and_wait = exec_and_wait
     exec_at_hour = exec_at_hour
-    
+
     # date
     get_hms = get_hms
     get_dma = get_dma
-    
+
     # email
     send_email = send_email
-    
+
     # file
     count_files = count_files
     create_temp_dir = create_temp_dir
     delete_temp_dir = delete_temp_dir
     #clear_temp_dir = clear_temp_dir
-    
+
     # log
     alert_print = alert_print
     success_print = success_print
@@ -75,19 +75,23 @@ class Rpa_suite():
     print_retur_fn = print_retur_fn
     magenta_print = magenta_print
     blue_print = blue_print
-    
+
     # regex
     create_list_using_regex = create_list_using_regex
-    
+
     # validate
     valid_emails = valid_emails
     search_in = search_in
-    
+
 # Create a instance of Rpa_suite
 
 
 # Define function to return this instance
-def invoke():
+def invoke() -> Rpa_suite:
+    
+    """
+    Function responsible for return a object Rpa_suite with access all modules by .name_module or use 'from rpa_suite import suite' to >>> suite.functions_avaliable()
+    """
+    
     suite = Rpa_suite()
     return suite
-

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/rpa_suite.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rpa-suite
-Version: 0.9.3
+Version: 0.9.4
 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
@@ -150,7 +150,7 @@ O módulo principal do rpa-suite é dividido em categorias. Cada categoria cont
         - **string_validator** - Funções para validação/varredura (strings, substrings, palavras)
 
 ## Release
-Versão: **Alpha 0.9.3**
+Versão: **Alpha 0.9.4**
 
 Lançamento: *20/02/2024*
 

{rpa_suite-0.9.3 → rpa_suite-0.9.4}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='rpa_suite',
-    version='0.9.3',
+    version='0.9.4',
     packages=find_packages(),
     description='Conjunto de ferramentas essenciais para Automação RPA com Python, que facilitam o dia a dia de desenvolvimento.',
     long_description_content_type='text/markdown',