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

rpa_suite/file/counter.py

@@ -1,69 +0,0 @@
-# /counter.py
-
-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 = '*',
-    display_message: bool = False,
-) -> 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': False,
-        'qt': 0
-    }
-
-
-    # Process
-    try:
-        for dir in dir_to_count:
-            for current_dir, sub_dir, files in os.walk(dir):
-                for file in files:
-                    if type_extension == '*' or file.endswith(f'.{type_extension}'):
-                        result['qt'] += 1
-        result['success'] = True
-        
-        if display_message:
-            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)}')
-
-    finally:
-        return result

rpa_suite/file/file_flag.py

@@ -1,103 +0,0 @@
-# /file_flag.py
-
-import os, time
-from rpa_suite import suite as rpa
-
-
-def file_flag_create(display_message: bool = True, path_to_create: str = None, name_file: str = 'running.flag') -> None:
-    """
-    Function responsible for create a file flag on root directory by default. Path, name file and display message was optional. \n
-
-    Parameters:
-    ----------
-    ``display_message: bool`` - should be boolean, True prints message on console.
-    ``path_to_create: str`` - should be a string, by default use root dir with "os.getcwd()".
-    ``name_file: str`` - should be a string, by default "running.flag".
-
-    Return:
-    ----------
-    >>> type:bool
-        * 'bool' - represents the result of performance this action
-
-    Description: pt-br
-    ----------
-    Função responsável por criar um arquivo de flag na raiz do projeto por padrão. O diretório, o nome do arquivo e a possibilidade de imprimir no console a mensagem de sucesso, são opcionais.
-
-    Parâmetros:
-    ----------
-    ``display_message: bool`` - deve ser booleano, True para o caso de imprimir no console a mensagem de resultado.
-    ``path_to_create: str`` - deve ser string, por padrão usa como raiz do projeto o comando "os.getcwd()".
-    ``name_file: str`` - deve ser string, por padrão "running.flag".
-    
-    Retorno:
-    ----------
-    >>> tipo: bool
-        * 'bool' - representa o resultado performado da ação
-    """
-    
-    try:
-        if path_to_create == None:
-            path_origin: str = os.getcwd()
-            full_path_with_name = fr'{path_origin}/{name_file}'
-        else:
-            full_path_with_name = fr'{path_to_create}/{name_file}'
-            
-        with open(full_path_with_name, 'w', encoding='utf-8') as file:
-            file.write('[T-BOT Crédit Simulation] running in realtime, waiting finish to new execution')
-            
-        if display_message: rpa.success_print("Flag file created.")
-        return True
-    
-    except Exception as e:
-        rpa.error_print(f'Erro na função file_scheduling_create: {str(e)}')
-        return False
-
-
-def file_flag_delete(display_message: bool = True, path_to_delete: str = None, name_file: str = 'running.flag') -> None:
-    """
-    Function responsible for delete a file flag on root directory by default. Path, name file and display message was optional. \n
-
-    Parameters:
-    ----------
-    ``display_message: bool`` - should be boolean, True prints message on console.
-    ``path_to_delete: str`` - should be a string, by default use root dir with "os.getcwd()".
-    ``name_file: str`` - should be a string, by default "running.flag".
-
-    Return:
-    ----------
-    >>> type:bool
-        * 'bool' - represents the result of performance this action
-
-    Description: pt-br
-    ----------
-    Função responsável por deletar um arquivo de flag na raiz do projeto por padrão. O diretório, o nome do arquivo e a possibilidade de imprimir no console a mensagem de sucesso, são opcionais.
-
-    Parâmetros:
-    ----------
-    ``display_message: bool`` - deve ser booleano, True para o caso de imprimir no console a mensagem de resultado.
-    ``path_to_delete: str`` - deve ser string, por padrão usa como raiz do projeto o comando "os.getcwd()".
-    ``name_file: str`` - deve ser string, por padrão "running.flag".
-    
-    Retorno:
-    ----------
-    >>> tipo: bool
-        * 'bool' - representa o resultado performado da ação
-    """
-    
-    try:
-
-        if path_to_delete == None:
-            path_origin: str = os.getcwd()
-            full_path_with_name = fr'{path_origin}/{name_file}'
-        else:
-            full_path_with_name = fr'{path_to_delete}/{name_file}'
-            
-        if os.path.exists(full_path_with_name):
-            os.remove(full_path_with_name)
-            if display_message: print("Flag file deleted.")
-        else:
-            rpa.alert_print("Flag file not found.")
-
-    except Exception as e:
-        rpa.error_print(f'Erro na função file_scheduling_delete: {str(e)}')
-        time.sleep(1)

rpa_suite/file/screen_shot.py

@@ -1,91 +0,0 @@
-# /screen_shot.py
-
-import os, time
-from datetime import datetime
-from rpa_suite.log.printer import error_print, success_print
-from .__create_ss_dir import __create_ss_dir
-from colorama import Fore
-
-
-
-def screen_shot(path_dir:str = None, file_name: str = 'screenshot', save_with_date: bool = True, delay: int = 1, use_default_path_and_name: bool = True, name_ss_dir:str = None, display_message: bool = False) -> str | None:
-
-    """
-    Function responsible for create a dir for screenshot, and file screenshot and save this in dir to create, if dir exists save it on original dir. By default uses date on file name. \n
-
-    Parameters:
-    ----------
-    ``file_path: str`` - should be a string, not have a default path.
-    ``file_name: str`` - should be a string, by default name is `screenshot`.
-    ``save_with_date: bool`` - should be a boolean, by default `True` save namefile with date `foo_dd_mm_yyyy-hh_mm_ss.png`.
-    ``delay: int`` - should be a int, by default 1 (represents seconds).
-
-    Return:
-    ----------
-    >>> type:str
-        * 'screenshot_path': str - represents the absulute path created for this file
-
-    Description: pt-br
-    ----------
-    Função responsável por criar um diretório para captura de tela, e arquivo de captura de tela e salvar isso no diretório a ser criado, se o diretório existir, salve-o no diretório original. Por padrão, usa a data no nome do arquivo.
-
-    Parâmetros:
-    ----------
-    ``file_path: str`` - deve ser uma string, não tem um caminho padrão.
-    ``file_name: str`` - deve ser uma string, por padrão o nome é `screenshot`.
-    ``save_with_date: bool`` - deve ser um booleano, por padrão `True` salva o nome do arquivo com a data `foo_dd_mm_yyyy-hh_mm_ss.png`.
-    ``delay: int`` - deve ser um int, por padrão 1 representado em segundo(s).
-    
-    Retorno:
-    ----------
-    >>> tipo: str
-        * 'screenshot_path': str - representa o caminho absoluto do arquivo criado
-    """
-
-    # proccess
-    try:
-        
-        try:
-            import pyautogui
-            import pyscreeze
-            
-        except ImportError:
-            raise ImportError(f"\nThe libraries ‘pyautogui’ and ‘Pillow’ are necessary to use this module. {Fore.YELLOW}Please install them with: ‘pip install pyautogui pillow‘{Fore.WHITE}")
-        
-        time.sleep(delay)
-
-        if not use_default_path_and_name:
-            result_tryed: dict = __create_ss_dir(path_dir, name_ss_dir)
-            path_dir = result_tryed['path_created']
-        else:
-            if path_dir == None and name_ss_dir == None:
-                result_tryed: dict = __create_ss_dir()
-                path_dir = result_tryed['path_created']
-
-        
-        if save_with_date: # use date on file name
-            image = pyautogui.screenshot()
-            file_name = f'{file_name}_{datetime.today().strftime("%d_%m_%Y-%H_%M_%S")}.png'
-            path_file_screenshoted = os.path.join(path_dir, file_name)
-            
-            image.save(path_file_screenshoted)
-            if display_message:
-                success_print(path_file_screenshoted)
-            
-            return path_file_screenshoted
-        
-        else: # not use date on file name
-            image = pyautogui.screenshot()
-            file_name = f'{file_name}.png'
-            path_file_screenshoted = os.path.join(path_dir, file_name)
-            
-            image.save(path_file_screenshoted)
-            if display_message:
-                success_print(path_file_screenshoted)
-                
-            return path_file_screenshoted
-    
-    except Exception as e:
-
-        error_print(f'Error to execute function:{screen_shot.__name__}! Error: {str(e)}')
-        return None

rpa_suite/file/temp_dir.py

@@ -1,176 +0,0 @@
-# /temp_dir.py
-
-import os, shutil
-from typing import Union
-from rpa_suite.log.printer import error_print, alert_print, success_print
-
-
-def create_temp_dir(path_to_create: str = 'default', name_temp_dir: str='temp', display_message: bool = False) -> dict[str, Union[bool, str, None]]:
-
-    """
-    Function responsible for creating a temporary directory to work with files and etc. \n
-
-    Parameters:
-    ----------
-    ``path_to_create: str`` - should be a string with the full path pointing to the folder where the temporary folder should be created, if it is empty the ``default`` value will be used which will create a folder in the current directory where the file containing this function was called.
-
-    ``name_temp_dir: str`` - should be a string representing the name of the temporary directory to be created. If it is empty, the ``temp`` value will be used as the default directory name.
-
-    Return:
-    ----------
-    >>> 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 temporário para trabalhar com arquivos e etc. \n
-
-    Parametros:
-    ----------
-    ``path_to_create: str`` - deve ser uma string com o path completo apontando para a pasta onde deve ser criada a pasta temporaria, se estiver vazio sera usado valor ``default`` que criará pasta no diretório atual onde o arquivo contendo esta função foi chamada.
-
-    ``name_temp_dir: str`` - deve ser uma string representando o nome do diretório temporário a ser criado. Se estiver vazio, o valor ``temp`` será usado como o nome padrão do diretório.
-
-    Retorno:
-    ----------
-    >>> type:dict
-        * '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':
-            path_to_create: str = os.getcwd()
-
-        # Build path to new dir
-        full_path: str = os.path.join(path_to_create, name_temp_dir)
-
-        # Create dir in this block
-        try:
-
-            # Successefully created
-            os.makedirs(full_path, exist_ok=False)
-
-            result['success'] = True
-            result['path_created'] = fr'{full_path}'
-
-            if display_message:
-                success_print(f"Dir:'{full_path}' Created!")
-
-        except FileExistsError:
-            result['success'] = False
-            result['path_created'] = None
-            alert_print(f"Dir:'{full_path}' already exists.")
-
-        except PermissionError:
-            result['success'] = False
-            result['path_created'] = None
-            alert_print(f"Permission Denied: Not Able to create dir:'{full_path}'.")
-
-    except Exception as e:
-        result['success'] = False
-        result['path_created'] = None
-        error_print(f'Error capturing current path to create temporary directory! Error: {str(e)}')
-        
-    finally:
-        return result
-
-
-def delete_temp_dir(path_to_delete: str = 'default', name_temp_dir: str='temp', delete_files: bool = False, display_message: bool = False) -> dict[str, Union[bool, str, None]]:
-
-    """
-    Function responsible for deleting a temporary directory. \n
-    
-    Parameters:
-    ----------
-    ``path_to_delete: str`` - should be a string with the full path pointing to the folder where the temporary folder should be deleted, if it is empty the ``default`` value will be used which will delete a folder in the current directory where the file containing this function was called.
-
-    ``name_temp_dir: str`` - should be a string representing the name of the temporary directory to be deleted. If it is empty, the ``temp`` value will be used as the default directory name.
-
-    ``delete_files: bool`` - should be a boolean indicating whether to delete files in the directory. If it is False, files in the directory will not be deleted.
-
-    Return:
-    ----------
-    >>> type:dict
-        * 'success': bool - represents case the action was performed successfully
-        * 'path_deleted': str - path of the directory that was deleted on the process
-        
-    Description: pt-br
-    ----------
-    Função responsavel por deletar diretório temporário. \n
-
-    Parametros:
-    ----------
-    ``path_to_delete: str`` - deve ser uma string com o path completo apontando para a pasta onde deve ser deletada a pasta temporaria, se estiver vazio sera usado valor ``default`` que deletará pasta no diretório atual onde o arquivo contendo esta função foi chamada.
-
-    ``name_temp_dir: str`` - deve ser uma string representando o nome do diretório temporário a ser deletado. Se estiver vazio, o valor ``temp`` será usado como o nome padrão do diretório.
-
-    ``delete_files: bool`` - deve ser um booleano indicando se deve deletar arquivos no diretório. Se for False, arquivos no diretório não serão deletados.
-
-    Retorno:
-    ----------
-    >>> type:dict
-        * 'success': bool - representa se ação foi realizada com sucesso
-        * 'path_deleted': str - path do diretório que foi deletado no processo
-    """
-
-    # Local Variables
-    result: dict = {
-        'success': bool,
-        'path_deleted': str,
-    }
-
-    try:
-        # by 'default', defines path to local script execution path
-        if path_to_delete == 'default':
-            path_to_delete: str = os.getcwd()
-
-        # Build path to new dir
-        full_path: str = os.path.join(path_to_delete, name_temp_dir)
-
-        # Delete dir in this block
-        try:
-
-            # Check if directory exists
-            if os.path.exists(full_path):
-
-                # Check if delete_files is True
-                if delete_files:
-                    # Delete all files in the directory
-                    shutil.rmtree(full_path)
-
-                else:
-                    # Delete the directory only
-                    os.rmdir(full_path)
-
-                result['success'] = True
-                result['path_deleted'] = fr'{full_path}'
-
-                if display_message:
-                    success_print(f"Dir:'{full_path}' Deleted!")
-                    
-            else:
-                result['success'] = False
-                result['path_deleted'] = None
-                alert_print(f"Dir:'{full_path}' Don't exists.")
-
-        except PermissionError:
-            result['success'] = False
-            result['path_deleted'] = None
-            alert_print(f"Permission Denied: Not Able to delete dir: '{full_path}'.")
-
-    except Exception as e:
-        result['success'] = False
-        result['path_deleted'] = None
-        error_print(f'Error capturing current path to delete temporary directory! Error: {str(e)}')
-        
-    finally:
-        return result

rpa_suite/log/__init__.py

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

rpa_suite/log/functions_logger_uru.py

@@ -1,172 +0,0 @@
-# /functions_logger_uru.py
-
-from loguru import logger
-from rpa_suite.log.printer import error_print, alert_print
-import inspect, os
-
-def log_start_run_debug(msg_start_loggin: str) -> None: # represent start application
-
-    """
-    Function responsable to generate ``start run log level debug``, in file and print on terminal the same log captured on this call.
-    """
-
-    file_h: False
-
-    try:
-
-        from .logger_uru import config_logger
-        file_h = config_logger()
-
-    except Exception as e:
-
-        error_print(f'To use log_start_run_debug you need instance file_handler using file "logger_uru" on one file in your project! Error: {str(e)}')
-
-    try:
-        try:
-            if file_h:
-                with open(file_h, 'a') as f:
-                    f.write('\n')
-
-        except Exception as e:
-            alert_print(f"Don't able to break_row for initial log!")
-
-        # logger.debug(f'{msg_start_loggin}')
-        frame = inspect.currentframe().f_back
-        full_path_filename = frame.f_code.co_filename
-
-        # Obtenha o nome do arquivo e o nome da pasta
-        filename = os.path.basename(full_path_filename)
-        foldername = os.path.basename(os.path.dirname(full_path_filename))
-
-        # Combine o nome da pasta e o nome do arquivo
-        filename = os.path.join(foldername, filename)
-        lineno = frame.f_lineno
-
-        # Vincule o nome do arquivo e a linha à mensagem de log
-        logger.bind(filename=filename, lineno=lineno).debug(f'{msg_start_loggin}')
-
-    except Exception as e:
-        error_print(f'Error to execute function:{log_start_run_debug.__name__}! Error: {str(e)}')
-
-
-def log_debug(msg) -> None:
-
-    """
-    Function responsable to generate log level ``debug``, in file and print on terminal the same log captured on this call.
-    """
-
-    try:
-        frame = inspect.currentframe().f_back
-        full_path_filename = frame.f_code.co_filename
-
-        # Obtem o nome do arquivo e o nome da pasta
-        filename = os.path.basename(full_path_filename)
-        foldername = os.path.basename(os.path.dirname(full_path_filename))
-
-        # Combina o nome da pasta e o nome do arquivo
-        filename = os.path.join(foldername, filename)
-        lineno = frame.f_lineno
-
-        # Vincula o nome do arquivo e a linha à mensagem de log
-        logger.bind(filename=filename, lineno=lineno).debug(msg)
-
-    except Exception as e:
-        error_print(f'Error to execute function:{log_debug.__name__}! Error: {str(e)}')
-
-def log_info(msg) -> None:
-
-    """
-    Function responsable to generate log level ``info``, in file and print on terminal the same log captured on this call.
-    """
-
-    try:
-        frame = inspect.currentframe().f_back
-        full_path_filename = frame.f_code.co_filename
-
-        # Obtem o nome do arquivo e o nome da pasta
-        filename = os.path.basename(full_path_filename)
-        foldername = os.path.basename(os.path.dirname(full_path_filename))
-
-        # Combina o nome da pasta e o nome do arquivo
-        filename = os.path.join(foldername, filename)
-        lineno = frame.f_lineno
-
-        # Vincula o nome do arquivo e a linha à mensagem de log
-        logger.bind(filename=filename, lineno=lineno).info(msg)
-
-    except Exception as e:
-        error_print(f'Error to execute function:{log_info.__name__}! Error: {str(e)}')
-
-def log_warning(msg) -> None:
-
-    """
-    Function responsable to generate log level ``warning``, in file and print on terminal the same log captured on this call.
-    """
-
-    try:
-        frame = inspect.currentframe().f_back
-        full_path_filename = frame.f_code.co_filename
-
-        # Obtenha o nome do arquivo e o nome da pasta
-        filename = os.path.basename(full_path_filename)
-        foldername = os.path.basename(os.path.dirname(full_path_filename))
-
-        # Combine o nome da pasta e o nome do arquivo
-        filename = os.path.join(foldername, filename)
-        lineno = frame.f_lineno
-
-        # Vincule o nome do arquivo e a linha à mensagem de log
-        logger.bind(filename=filename, lineno=lineno).warning(msg)
-
-    except Exception as e:
-        error_print(f'Error to execute function:{log_warning.__name__}! Error: {str(e)}')
-
-
-def log_error(msg) -> None:
-
-    """
-    Function responsable to generate log level ``error``, in file and print on terminal the same log captured on this call.
-    """
-
-    try:
-        frame = inspect.currentframe().f_back
-        full_path_filename = frame.f_code.co_filename
-
-        # Obtenha o nome do arquivo e o nome da pasta
-        filename = os.path.basename(full_path_filename)
-        foldername = os.path.basename(os.path.dirname(full_path_filename))
-
-        # Combine o nome da pasta e o nome do arquivo
-        filename = os.path.join(foldername, filename)
-        lineno = frame.f_lineno
-
-        # Vincule o nome do arquivo e a linha à mensagem de log
-        logger.bind(filename=filename, lineno=lineno).error(msg)
-
-    except Exception as e:
-        error_print(f'Error to execute function:{log_error.__name__}! Error: {str(e)}')
-
-
-def log_critical(msg) -> None:
-
-    """
-    Function responsable to generate log level ``critical``, in file and print on terminal the same log captured on this call.
-    """
-
-    try:
-        frame = inspect.currentframe().f_back
-        full_path_filename = frame.f_code.co_filename
-
-        # Obtenha o nome do arquivo e o nome da pasta
-        filename = os.path.basename(full_path_filename)
-        foldername = os.path.basename(os.path.dirname(full_path_filename))
-
-        # Combine o nome da pasta e o nome do arquivo
-        filename = os.path.join(foldername, filename)
-        lineno = frame.f_lineno
-
-        # Vincule o nome do arquivo e a linha à mensagem de log
-        logger.bind(filename=filename, lineno=lineno).critical(msg)
-
-    except Exception as e:
-        error_print(f'Error to execute function:{log_critical.__name__}! Error: {str(e)}')

rpa_suite/log/log_decorator.py

@@ -1,37 +0,0 @@
-# /log_decorator.py
-
-from typing import Callable
-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.
-
-    Return:
-    ----------
-    A ``wrapper`` function with python decoration ``@logger.catch`` that received:
-        * ``*args and **kwargs`` in the call parameters as an argument to result in the Log.
-
-    Description: pt-br
-    ----------
-    Função responsavel por exibir mensagem de log no console para funções que são chamadas. \n
-    Exibe nome da função, e o resultado da função em caso de retorno, sem retorno devolve None.
-
-    Retorno:
-    ----------
-    Uma função ``wrapper`` com decoração ``@logger.catch`` do python que recebeu:
-        * ``*args e **kwargs`` nos parametros de chamada como argumento para resultar no Log.
-    """
-
-    @logger.catch
-    def wrapper(*args, **kwargs):
-        logger.info('Function Called: {}', fn.__name__)
-        result = fn(*args, **kwargs)
-        logger.info('Function {} returned: {}', fn.__name__, result)
-        return result
-
-    return wrapper