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

rpa_suite/core/dir.py

@@ -8,9 +8,7 @@ import os, shutil
 from typing import Union
 
 
-
-class Directory():
-
+class Directory:
     """
     Class that provides utilities for directory management, including creating, deleting, and manipulating directories.
 
@@ -22,7 +20,7 @@ class Directory():
 
     Methods:
         create_temp_dir: Creates a temporary directory for file operations.
-        
+
     The Directory class is part of RPA Suite and can be accessed through the rpa object:
         >>> from rpa_suite import rpa
         >>> rpa.directory.create_temp_dir(path_to_create='my_folder', name_temp_dir='temp_dir')
@@ -43,7 +41,7 @@ class Directory():
 
     Métodos:
         create_temp_dir: Cria um diretório temporário para operações com arquivos.
-        
+
     A classe Directory é parte do RPA Suite e pode ser acessada através do objeto rpa:
         >>> from rpa_suite import rpa
         >>> rpa.directory.create_temp_dir(path_to_create='minha_pasta', name_temp_dir='temp_dir')
@@ -53,13 +51,14 @@ class Directory():
         name_temp_dir (str): O nome do diretório temporário a ser criado. O padrão é 'temp'.
     """
 
-    def __init__(self):
-        ...
-
-    def create_temp_dir(self,
-                        path_to_create: str = 'default',
-                        name_temp_dir: str='temp') -> dict[str, Union[bool, str, None]]:
+    def __init__(self): ...
 
+    def create_temp_dir(
+        self,
+        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
 
@@ -69,12 +68,14 @@ class Directory():
 
         ``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.
 
+        ``display_message: bool`` - should be a bool to display messages on terminal, by default False.
+
         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
@@ -85,22 +86,24 @@ class Directory():
 
         ``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.
 
+        ``display_message: bool`` - deve ser um bool para exibir mensagens no terminal, por padrão False.
+
         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,
+            "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
@@ -112,38 +115,45 @@ class Directory():
                 # 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.")
+                if display_message:
+                    success_print(f"Directory:'{full_path}' successfully created.")
 
             except FileExistsError:
-                result['success'] = False
-                result['path_created'] = None
-                alert_print(f"Diretório:'{full_path}' já existe.")
+                result["success"] = False
+                result["path_created"] = None
+                if display_message:
+                    alert_print(f"Directory:'{full_path}' already exists.")
 
             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"Permission denied: Not possible to create Directory '{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)}')
-            
+            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(self,
-                        path_to_delete: str = 'default',
-                        name_temp_dir: str='temp',
-                        delete_files: bool = False) -> dict[str, Union[bool, str, None]]:
-
+    def delete_temp_dir(
+        self,
+        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.
@@ -157,7 +167,7 @@ class Directory():
         >>> 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
@@ -179,13 +189,13 @@ class Directory():
 
         # Local Variables
         result: dict = {
-            'success': bool,
-            'path_deleted': str,
+            "success": bool,
+            "path_deleted": str,
         }
 
         try:
             # by 'default', defines path to local script execution path
-            if path_to_delete == 'default':
+            if path_to_delete == "default":
                 path_to_delete: str = os.getcwd()
 
             # Build path to new dir
@@ -206,24 +216,30 @@ class Directory():
                         # Delete the directory only
                         os.rmdir(full_path)
 
-                    result['success'] = True
-                    result['path_deleted'] = fr'{full_path}'
+                    result["success"] = True
+                    result["path_deleted"] = rf"{full_path}"
 
-                    success_print(f"Diretório:'{full_path}' foi deletado com sucesso.")
+                    if display_message:
+                        success_print(f"Directory:'{full_path}' successfully delete.")
                 else:
-                    result['success'] = False
-                    result['path_deleted'] = None
-                    alert_print(f"Diretório:'{full_path}' não existe.")
+                    result["success"] = False
+                    result["path_deleted"] = None
+                    if display_message:
+                        alert_print(f"Directory:'{full_path}' don't exists.")
 
             except PermissionError:
-                result['success'] = False
-                result['path_deleted'] = None
-                alert_print(f"Permissão negada: não é possível deletar o diretório '{full_path}'.")
+                result["success"] = False
+                result["path_deleted"] = None
+                alert_print(
+                    f"Permission denied: Not possible to delete Directory '{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)}')
-            
+            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/core/email.py

@@ -12,20 +12,19 @@ from email.mime.base import MIMEBase
 from email import encoders
 
 
-class Email():
-    
+class Email:
     """
     Class that provides utilities for sending emails via SMTP protocol.
-    
+
     This class offers functionalities for:
         - Sending emails with attachments
         - HTML message formatting
         - SMTP server configuration
         - Email validation
-        
+
     Methods:
         send_smtp: Sends an email through specified SMTP server
-        
+
     The Email class is part of RPA Suite and can be accessed through the rpa object:
         >>> from rpa_suite import rpa
         >>> rpa.email.send_smtp(
@@ -50,16 +49,16 @@ class Email():
     pt-br
     ----------
     Classe que fornece utilitários para envio de emails via protocolo SMTP.
-    
+
     Esta classe oferece funcionalidades para:
         - Envio de emails com anexos
         - Formatação de mensagens em HTML
         - Configuração de servidor SMTP
         - Validação de email
-        
+
     Métodos:
         send_smtp: Envia um email através do servidor SMTP especificado
-        
+
     A classe Email é parte do RPA Suite e pode ser acessada através do objeto rpa:
         >>> from rpa_suite import rpa
         >>> rpa.email.send_smtp(
@@ -71,80 +70,76 @@ class Email():
         ... )
     """
 
+    smtp_server: str = ("smtp.hostinger.com",)
+    smtp_port: str = (465,)
+    email_user: str = ("your_email@email.com",)
+    email_password: str = ("password",)
+    email_to: str = ("to@email.com",)
+    attachments: list[str] = ([],)
+    subject_title: str = ("Test title",)
+    body_message: str = "<p>Testing message body</p>"
+    auth_tls: bool = (False,)
 
-    smtp_server:str = "smtp.hostinger.com",
-    smtp_port:str = 465,
-    email_user:str = "your_email@email.com",
-    email_password:str = "password",
-    email_to: str = "to@email.com",
-    attachments: list[str] = [],
-    subject_title: str = 'Test title',
-    body_message: str = '<p>Testing message body</p>'
-    auth_tls: bool = False,
-
-
-    def __init__(self):
-        ...
+    def __init__(self): ...
 
     def send_smtp(
         self,
-        email_user:str,
-        email_password:str,
+        email_user: str,
+        email_password: str,
         email_to: str,
-        subject_title: str = 'Test title',
-        body_message: str = '<p>Testing message body</p>',
+        subject_title: str = "Test title",
+        body_message: str = "<p>Testing message body</p>",
         attachments: list[str] = [],
-        smtp_server:str = "smtp.hostinger.com",
-        smtp_port:str = 465,
+        smtp_server: str = "smtp.hostinger.com",
+        smtp_port: str = 465,
         auth_tls: bool = False,
         display_message: bool = True,
-        ):
-
+    ):
         """
         Sends an email using the specified SMTP server.
 
         Args:
-            smtp_server (str, optional): Address of the SMTP server. 
+            smtp_server (str, optional): Address of the SMTP server.
                 Default: "smtp.hostinger.com".
-            smtp_port (str, optional): Port of the SMTP server. 
+            smtp_port (str, optional): Port of the SMTP server.
                 Default: 465.
-            email_user (str, optional): User (email) for authentication on the SMTP server. 
+            email_user (str, optional): User (email) for authentication on the SMTP server.
                 Default: "example@email.com".
-            email_password (str, optional): Password for authentication on the SMTP server. 
+            email_password (str, optional): Password for authentication on the SMTP server.
                 Default: "example123".
-            email_to (str, optional): Email address of the recipient. 
+            email_to (str, optional): Email address of the recipient.
                 Default: "person@email.com".
-            attachments (list[str], optional): List of file paths to attach to the email. 
+            attachments (list[str], optional): List of file paths to attach to the email.
                 Default: [].
-            subject_title (str, optional): Title (subject) of the email. 
+            subject_title (str, optional): Title (subject) of the email.
                 Default: 'test title'.
-            body_message (str, optional): Body of the email message, in HTML format. 
+            body_message (str, optional): Body of the email message, in HTML format.
                 Default: '<p>test message</p>'.
 
         Returns:
             None: This function does not explicitly return any value, but prints success or failure messages when sending the email.
-        
+
         pt-br
         ------
-        
+
         Envia um email usando o servidor SMTP especificado.
 
         Args:
-            smtp_server (str, opcional): Endereço do servidor SMTP. 
+            smtp_server (str, opcional): Endereço do servidor SMTP.
                 Padrão: "smtp.hostinger.com".
-            smtp_port (str, opcional): Porta do servidor SMTP. 
+            smtp_port (str, opcional): Porta do servidor SMTP.
                 Padrão: 465.
-            email_user (str, opcional): Usuário (email) para autenticação no servidor SMTP. 
+            email_user (str, opcional): Usuário (email) para autenticação no servidor SMTP.
                 Padrão: "example@email.com".
-            email_password (str, opcional): Senha para autenticação no servidor SMTP. 
+            email_password (str, opcional): Senha para autenticação no servidor SMTP.
                 Padrão: "example123".
-            email_to (str, opcional): Endereço de email do destinatário. 
+            email_to (str, opcional): Endereço de email do destinatário.
                 Padrão: "person@email.com".
-            attachments (list[str], opcional): Lista de caminhos de arquivos para anexar ao email. 
+            attachments (list[str], opcional): Lista de caminhos de arquivos para anexar ao email.
                 Padrão: [].
-            subject_title (str, opcional): Título (assunto) do email. 
+            subject_title (str, opcional): Título (assunto) do email.
                 Padrão: 'título de teste'.
-            body_message (str, opcional): Corpo da mensagem do email, em formato HTML. 
+            body_message (str, opcional): Corpo da mensagem do email, em formato HTML.
                 Padrão: '<p>mensagem de teste</p>'.
 
         Returns:
@@ -164,13 +159,17 @@ class Email():
 
             # Criando a mensagem
             msg = MIMEMultipart()
-            msg['From'] = self.email_user
-            msg['To'] = ', '.join(self.email_to) if isinstance(self.email_to, list) else self.email_to
-            msg['Subject'] = str(self.subject_title)
+            msg["From"] = self.email_user
+            msg["To"] = (
+                ", ".join(self.email_to)
+                if isinstance(self.email_to, list)
+                else self.email_to
+            )
+            msg["Subject"] = str(self.subject_title)
 
             # Corpo do e-mail
             body = str(self.body_message)
-            msg.attach(MIMEText(body, 'html'))
+            msg.attach(MIMEText(body, "html"))
 
             # Anexos (opcional)
             if self.attachments:
@@ -191,7 +190,9 @@ class Email():
                             msg.attach(part)
 
                     except Exception as e:
-                        error_print(f"Erro ao anexar o arquivo {attachment_path}: {str(e)}")
+                        error_print(
+                            f"Erro ao anexar o arquivo {attachment_path}: {str(e)}"
+                        )
 
             try:
                 if self.auth_tls:
@@ -206,7 +207,8 @@ class Email():
 
                 # Enviando o e-mail
                 server.sendmail(self.email_user, self.email_to, msg.as_string())
-                if display_message: success_print("E-mail enviado com sucesso!")
+                if display_message:
+                    success_print("E-mail enviado com sucesso!")
 
                 # Encerrando a conexão
                 server.quit()