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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rpa_suite
-Version: 0.9.4
+Version: 1.0.0
 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
@@ -22,6 +22,7 @@ License-File: LICENSE
 Requires-Dist: loguru
 Requires-Dist: colorama
 Requires-Dist: email_validator
+Requires-Dist: colorlog
 
 ![RPA Suite](https://raw.githubusercontent.com/CamiloCCarvalho/rpa_suite/3e1ccd0acad654916466f03c2b8f166dc8d360d4/logo-rpa-suite.svg)
 
@@ -126,6 +127,7 @@ No setup do nosso projeto já estão inclusas as dependências, só será necess
 - colorama
 - loguru
 - email-validator
+- colorlog
   
 ## Estrutura do módulo
 O módulo principal do rpa-suite é dividido em categorias. Cada categoria contém módulos com funções destinadas a cada tipo de tarefa
@@ -141,7 +143,7 @@ O módulo principal do rpa-suite é dividido em categorias. Cada categoria cont
         - **counter** - Funções para contagem de arquivos
         - **temp_dir** - Funções para diretórios temporários
     - **log**
-        - **loggin** - Funções decoradoras com log de execução das funções
+        - **logger** - Objeto de log, cria diretório/arquivo de log integrado aos prints
         - **printer** - Funções print personalizados (alerta, erro, sucesso, informativo)
     - **regex**
         - **list_from_text** - Funções para gerar listas, dividindo texto usando padrão regex
@@ -150,7 +152,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.4**
+Versão: **Beta 1.0.0**
 
 Lançamento: *20/02/2024*
 

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

@@ -101,6 +101,7 @@ No setup do nosso projeto já estão inclusas as dependências, só será necess
 - colorama
 - loguru
 - email-validator
+- colorlog
   
 ## Estrutura do módulo
 O módulo principal do rpa-suite é dividido em categorias. Cada categoria contém módulos com funções destinadas a cada tipo de tarefa
@@ -116,7 +117,7 @@ O módulo principal do rpa-suite é dividido em categorias. Cada categoria cont
         - **counter** - Funções para contagem de arquivos
         - **temp_dir** - Funções para diretórios temporários
     - **log**
-        - **loggin** - Funções decoradoras com log de execução das funções
+        - **logger** - Objeto de log, cria diretório/arquivo de log integrado aos prints
         - **printer** - Funções print personalizados (alerta, erro, sucesso, informativo)
     - **regex**
         - **list_from_text** - Funções para gerar listas, dividindo texto usando padrão regex
@@ -125,7 +126,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.4**
+Versão: **Beta 1.0.0**
 
 Lançamento: *20/02/2024*
 

rpa_suite-1.0.0/rpa_suite/log/__create_log_dir.py

@@ -0,0 +1,81 @@
+import os
+from typing import Union
+from rpa_suite.log.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]]:
+
+    """
+    Function responsible for creating a logger directory to work with files ``.log``. \n
+
+    Parameters:
+    ----------
+    ``path_to_create: str`` - should be a string with the full path pointing to the folder where the logger 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_log_dir: str`` - should be a string representing the name of the logger 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 de logger para trabalhar com arquivos de log. \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_log_dir: str`` - deve ser uma string representando o nome do diretório de logger 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_log_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}'
+
+            success_print(f"Diretório:'{full_path}' foi criado com sucesso.")
+
+        except FileExistsError:
+            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}'.")
+
+    except Exception as e:
+        result['success'] = False
+        result['path_created'] = None
+        error_print(f'Error capturing current path to create logger directory! Error: {str(e)}')
+        
+    finally:
+        return result

rpa_suite-1.0.0/rpa_suite/log/_variables.py

@@ -0,0 +1,8 @@
+from logging import FileHandler, StreamHandler
+from typing import Optional
+
+# Variável global para o manipulador de arquivo
+file_handler: Optional[FileHandler] = None
+
+# Variável global para o manipulador de stream stdout/stdin/buffer
+stream_handler: Optional[StreamHandler] = None

rpa_suite-1.0.0/rpa_suite/log/functions_logger.py

@@ -0,0 +1,94 @@
+import logging
+from .logger import file_handler
+from rpa_suite.log.printer import error_print, success_print
+
+
+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.
+    """
+
+    try:
+        global file_handler
+        file_handler.stream.write(f'\n{msg_start_loggin}\n')
+        success_print(f'{msg_start_loggin}')
+
+    except Exception as e:
+        error_print(f'Erro durante a função: {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:
+        logging.debug(msg)
+
+    except Exception as e:
+        error_print(f'Erro durante a função: {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:
+        logging.info(msg)
+
+    except Exception as e:
+        error_print(f'Erro durante a função: {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:
+        logging.info(msg)
+
+    except Exception as e:
+        error_print(f'Erro durante a função: {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:
+        logging.warning(msg)
+
+    except Exception as e:
+        error_print(f'Erro durante a função: {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:
+        logging.error(msg)
+
+    except Exception as e:
+        error_print(f'Erro durante a função: {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:
+        logging.critical(msg)
+
+    except Exception as e:
+        error_print(f'Erro durante a função: {log_critical.__name__}! Error: {str(e)}')

rpa_suite-0.9.4/rpa_suite/log/loggin.py → rpa_suite-1.0.0/rpa_suite/log/log_decorator.py

@@ -8,28 +8,28 @@ def logging_decorator(
     """
     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

rpa_suite-1.0.0/rpa_suite/log/logger.py

@@ -0,0 +1,111 @@
+import logging
+from logging import CRITICAL, ERROR, WARNING, INFO, DEBUG
+from logging import FileHandler, StreamHandler, Filter
+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
+
+
+class Filters(Filter):
+
+    word_filter: Op[list[str]]
+
+    def filter(self, record):
+
+        if len(self.word_filter) > 0:
+
+            for words in self.word_filter:
+
+
+                string_words: list[str] = [str(word) for word in words]
+                """print(words)
+                print(type(words))
+                print(string_words)
+                print(type(string_words))
+                input()"""
+                for word in string_words:
+                    if word in record.msg:
+                        record.msg = 'Log Alterado devido a palavra Filtrada!'
+                        return True
+
+        return True
+
+
+def config_logger(name_app:str = 'Logger', path_dir:str = None, name_log_dir:str = None, name_file_log: str = 'log', use_default_path_and_name: bool = True, filter_words: list[str] = None) -> Op[FileHandler]:
+
+    """
+    Function responsible for create a object logger with fileHandler and streamHandler
+    """
+
+    global file_handler, stream_handler
+
+    try:
+
+
+        if not use_default_path_and_name:
+            result_tryed: dict = _create_log_dir(path_dir, name_log_dir)
+            path_dir = result_tryed['path_created']
+        else:
+            if path_dir == None and name_log_dir == None:
+                result_tryed: dict = _create_log_dir()
+                path_dir = result_tryed['path_created']
+
+
+        # configuração de objetos logger
+        file_handler = FileHandler(
+            filename=fr'{path_dir}\{name_file_log}.log',
+            mode='a',
+            encoding='utf-8'
+        )
+        stream_handler = StreamHandler()
+
+        # Crie um formatador
+        formatter = ColoredFormatter(
+            "%(log_color)s%(levelname)s ->%(reset)s %(log_color)s%(message)s%(reset)s",
+            datefmt=None,
+            reset=True,
+            log_colors={
+                'DEBUG':    'cyan',
+                'INFO':     'green',
+                'WARNING':  'yellow',
+                'ERROR':    'red',
+                'CRITICAL': 'red',
+            },
+            force_color=True
+        )
+        stream_handler.setFormatter(formatter)
+
+        # ATRIBUIÇÕES
+        new_filter: Op[Filters] = None
+        if filter_words is not None:
+            new_filter: Filters = Filters()
+            new_filter.word_filter = [filter_words]
+
+        if new_filter is not None:
+            file_handler.addFilter(new_filter)
+
+        file_handler.setLevel(DEBUG)
+        
+        # Obtenha o logger
+        logger = logging.getLogger(__name__)
+
+        # Adicione o manipulador de stream ao logger
+        logger.addHandler(stream_handler)
+
+        # terminando de inplementar configuração para o logger
+        FORMAT = '%(levelname)s!%(asctime)s: %(message)s'
+        logging.basicConfig(
+            level=DEBUG, # level from stream_handler
+            #format='%(levelname)s - %(asctime)s - %(message)s',
+            format=FORMAT,
+            handlers=[file_handler, stream_handler],
+            datefmt='%d.%m.%y %H:%M',
+        )
+        return file_handler
+
+    except Exception as e:
+
+        error_print(f'Houve um erro durante a execução da função: {config_logger.__name__}! Error: {str(e)}.')
+        return None

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

@@ -1,29 +1,41 @@
+
 """MODULE CLOCK"""
 from .clock.waiter import wait_for_exec, exec_and_wait
 from .clock.exec_at import exec_at_hour
 
+
 """MODULE DATE"""
 from .date.date import get_hms, get_dma
 
+
 """MODULE EMAIL"""
 from .email.sender_smtp import send_email
 
+
 """MODULE FILE"""
 from .file.counter import count_files
 from .file.temp_dir import create_temp_dir, delete_temp_dir
 
+
 """MODULE LOG"""
 # from .log.loggin import logging_decorator
 from .log.printer import alert_print, success_print, error_print, info_print, print_call_fn, print_retur_fn, magenta_print, blue_print
 
+from .log.logger import config_logger
+from .log.functions_logger import log_start_run_debug, log_debug, log_info, log_warning, log_error, log_critical 
+
+
 """MODULE REGEX"""
 from .regex.list_from_text import create_list_using_regex
 
+
 """MODULE VALIDATE"""
 from .validate.mail_validator import valid_emails
 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.
 
@@ -66,7 +78,7 @@ class Rpa_suite():
     delete_temp_dir = delete_temp_dir
     #clear_temp_dir = clear_temp_dir
 
-    # log
+    # log - printer
     alert_print = alert_print
     success_print = success_print
     error_print = error_print
@@ -75,6 +87,15 @@ class Rpa_suite():
     print_retur_fn = print_retur_fn
     magenta_print = magenta_print
     blue_print = blue_print
+    
+    # log - logger with file and prints
+    config_logger = config_logger
+    log_start_run_debug = log_start_run_debug
+    log_debug = log_debug
+    log_info = log_info
+    log_warning = log_warning
+    log_error = log_error
+    log_critical = log_critical
 
     # regex
     create_list_using_regex = create_list_using_regex
@@ -88,10 +109,10 @@ class Rpa_suite():
 
 # Define function to return this instance
 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.4 → rpa_suite-1.0.0}/rpa_suite.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rpa-suite
-Version: 0.9.4
+Version: 1.0.0
 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
@@ -22,6 +22,7 @@ License-File: LICENSE
 Requires-Dist: loguru
 Requires-Dist: colorama
 Requires-Dist: email_validator
+Requires-Dist: colorlog
 
 ![RPA Suite](https://raw.githubusercontent.com/CamiloCCarvalho/rpa_suite/3e1ccd0acad654916466f03c2b8f166dc8d360d4/logo-rpa-suite.svg)
 
@@ -126,6 +127,7 @@ No setup do nosso projeto já estão inclusas as dependências, só será necess
 - colorama
 - loguru
 - email-validator
+- colorlog
   
 ## Estrutura do módulo
 O módulo principal do rpa-suite é dividido em categorias. Cada categoria contém módulos com funções destinadas a cada tipo de tarefa
@@ -141,7 +143,7 @@ O módulo principal do rpa-suite é dividido em categorias. Cada categoria cont
         - **counter** - Funções para contagem de arquivos
         - **temp_dir** - Funções para diretórios temporários
     - **log**
-        - **loggin** - Funções decoradoras com log de execução das funções
+        - **logger** - Objeto de log, cria diretório/arquivo de log integrado aos prints
         - **printer** - Funções print personalizados (alerta, erro, sucesso, informativo)
     - **regex**
         - **list_from_text** - Funções para gerar listas, dividindo texto usando padrão regex
@@ -150,7 +152,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.4**
+Versão: **Beta 1.0.0**
 
 Lançamento: *20/02/2024*
 

{rpa_suite-0.9.4 → rpa_suite-1.0.0}/rpa_suite.egg-info/SOURCES.txt

@@ -19,8 +19,12 @@ rpa_suite/email/sender_smtp.py
 rpa_suite/file/__init__.py
 rpa_suite/file/counter.py
 rpa_suite/file/temp_dir.py
+rpa_suite/log/__create_log_dir.py
 rpa_suite/log/__init__.py
-rpa_suite/log/loggin.py
+rpa_suite/log/_variables.py
+rpa_suite/log/functions_logger.py
+rpa_suite/log/log_decorator.py
+rpa_suite/log/logger.py
 rpa_suite/log/printer.py
 rpa_suite/regex/__init__.py
 rpa_suite/regex/list_from_text.py

{rpa_suite-0.9.4 → rpa_suite-1.0.0}/rpa_suite.egg-info/requires.txt

@@ -1,3 +1,4 @@
 loguru
 colorama
 email_validator
+colorlog

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

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='rpa_suite',
-    version='0.9.4',
+    version='1.0.0',
     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',
@@ -24,5 +24,5 @@ setup(
         'Topic :: Software Development :: Libraries :: Python Modules'
     ],
     keywords='basic-tools, email-tools, email-validation, file-tools, simple-functions, rpa-tools, rpa-functions, Tools, Rpa, Automation, RPA, Automação, Python, Ferramentas de RPA, Automação de Processos, Biblioteca Python para RPA',
-    install_requires=['loguru', 'colorama', 'email_validator'],
+    install_requires=['loguru', 'colorama', 'email_validator', 'colorlog'],
 )