rpa-suite 1.4.1__py3-none-any.whl → 1.4.2__py3-none-any.whl

rpa_suite/__init__.py

@@ -56,4 +56,5 @@
         ``regex``: Operações com expressões regulares
         ``validate``: Funções de validação de dados
 """
-from .suite import Suite as rpa
+
+from .suite import Suite as rpa

rpa_suite/core/__init__.py

@@ -1 +1,27 @@
-# rpa_suite/core/__init__.py
+# rpa_suite/core/__init__.py
+
+"""
+The Core module is where we can import all Sub-Objects used by the rpa_suite module separately, categorized by their respective classes based on functionality. However, we can also use them through the main rpa object using the following syntax:
+>>> from rpa_suite import rpa
+>>> rpa.clock.wait_for_exec()
+>>> rpa.file.screen_shot() ...
+among others.
+
+pt-br
+----------
+O módulo Core é de onde podemos importar todos os Sub-Objetos usados pelo módulo rpa_suite de forma separada, categorizados por suas respectivas classes com base na funcionalidade. No entanto, também podemos usá-los através do objeto principal rpa usando a seguinte sintaxe:
+>>> from rpa_suite import rpa
+>>> rpa.clock.wait_for_exec()
+>>> rpa.file.screen_shot() ...
+entre outros.
+
+"""
+from .clock import Clock
+from .date import Date
+from .dir import Directory
+from .email import Email
+from .file import File
+from .log import Log
+from .print import Print
+from .regex import Regex
+from .validate import Validate

rpa_suite/core/clock.py

@@ -7,6 +7,7 @@ from typing import Callable, Any
 
 
 class Clock():
+    
     """
     Class that provides utilities for time manipulation and stopwatch.
     
@@ -38,11 +39,12 @@ class Clock():
         >>> from rpa_suite import rpa
         >>> rpa.clock.exec_at_hour("14:30", minha_funcao)
     """
+
     def __init__(self):
         ...
-    
+
     def exec_at_hour(self,
-                hour_to_exec: str,
+                hour_to_exec: str | None,
                 fn_to_exec: Callable[..., Any],
                 *args,
                 **kwargs,
@@ -190,7 +192,8 @@ class Clock():
         >>> wait_for_exec(30, sum, 10, 5) -> 15 \n
             * NOTE:  `wait_for_exec` receives as first argument the time to wait (sec), then the function `sum` and finally the arguments that the function will use.
             
-        Description: pt-br
+        
+        pt-br
         ----------    
         Função temporizadora, aguardar um valor em ``segundos`` para executar a função do argumento.
         
@@ -257,8 +260,9 @@ class Clock():
         We have a sum function in the following format ``sum(a, b) -> return x``, where ``x`` is the result of the sum. We want to execute the sum and then wait `30 seconds` to continue the main code:
         >>> wait_for_exec(30, sum, 10, 5) -> 15 \n
             * NOTE:  `wait_for_exec` receives as first argument the time to wait (sec), then the function `sum` and finally the arguments that the function will use.
-            
-        Description: pt-br
+        
+        
+        pt-br
         ----------
         Função temporizadora, executa uma função e aguarda o tempo em ``segundos``
         

rpa_suite/core/email.py

@@ -99,28 +99,54 @@ class Email():
         ):
 
         """
-        Envia um e-mail utilizando o servidor SMTP especificado.
+        Sends an email using the specified SMTP server.
 
         Args:
-            smtp_server (str, optional): Endereço do servidor SMTP. 
+            smtp_server (str, optional): Address of the SMTP server. 
+                Default: "smtp.hostinger.com".
+            smtp_port (str, optional): Port of the SMTP server. 
+                Default: 465.
+            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. 
+                Default: "example123".
+            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. 
+                Default: [].
+            subject_title (str, optional): Title (subject) of the email. 
+                Default: 'test title'.
+            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. 
                 Padrão: "smtp.hostinger.com".
-            smtp_port (str, optional): Porta do servidor SMTP. 
+            smtp_port (str, opcional): Porta do servidor SMTP. 
                 Padrão: 465.
-            email_user (str, optional): Usuário (e-mail) para autenticação no servidor SMTP. 
-                Padrão: "bot@vettracode.com".
-            email_password (str, optional): Senha para autenticação no servidor SMTP. 
-                Padrão: "Bot@#2025".
-            email_to (str, optional): Endereço de e-mail do destinatário. 
-                Padrão: "camilo.costa1993@gmail.com".
-            attachments (list[str], optional): Lista de caminhos de arquivos para anexar ao e-mail. 
+            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. 
+                Padrão: "example123".
+            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. 
                 Padrão: [].
-            subject_title (str, optional): Título (assunto) do e-mail. 
-                Padrão: 'titulo teste'.
-            body_message (str, optional): Corpo da mensagem do e-mail, em formato HTML. 
+            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. 
                 Padrão: '<p>mensagem de teste</p>'.
 
         Returns:
-            None: Esta função não retorna nenhum valor explicitamente, mas imprime mensagens de sucesso ou falha no envio do e-mail.
+            Nenhum: Esta função não retorna explicitamente nenhum valor, mas imprime mensagens de sucesso ou falha ao enviar o email.
         """
 
         try:

rpa_suite/core/file.py

@@ -7,54 +7,55 @@ from typing import Dict, List, Union
 
 class File():
     """
-    Class that provides utilities for file management, including creating, deleting, and manipulating files.
+    Class that provides utilities for file management, including creation, deletion, and manipulation of files.
 
     This class offers functionalities for:
-        - Creating files
-        - Deleting files
-        - Reading and writing file content
-        - File path management
+        - Creating and deleting flag files
+        - Counting files in a directory
+        - Capturing screenshots and managing their paths
 
     Methods:
-        create_file: Creates a new file with specified content
-        delete_file: Deletes a specified file
-        read_file: Reads content from a specified file
-        write_file: Writes content to a specified file
+        screen_shot: Creates a screenshot and saves it in a specified directory
+        count_files: Counts the number of files in a specified directory
+        flag_create: Creates a flag file
+        flag_delete: Deletes a flag file
 
-    The File class is part of RPA Suite and can be accessed through the rpa object:
+    The File class is part of the RPA Suite and can be accessed through the rpa object:
         >>> from rpa_suite import rpa
-        >>> rpa.file.create_file('example.txt', 'Hello, World!')
+        >>> rpa.file.screen_shot('example')
 
     Parameters:
-        file_name (str): The name of the file to be created or manipulated
-        content (str): The content to be written to the file
-        path (str): The directory path where the file should be created or deleted
+        file_name (str): The name of the screenshot file
+        path_dir (str): The path of the directory where the screenshot should be saved
+        save_with_date (bool): Indicates if the file name should include the date
+        delay (int): The wait time before capturing the screen
 
     pt-br
     ----------
     Classe que fornece utilitários para gerenciamento de arquivos, incluindo criação, exclusão e manipulação de arquivos.
 
     Esta classe oferece funcionalidades para:
-        - Criar arquivos
-        - Excluir arquivos
-        - Ler e escrever conteúdo de arquivos
-        - Gerenciamento de caminhos de arquivos
+        - Criar e excluir arquivos de flag
+        - Contar arquivos em um diretório
+        - Capturar screenshots e gerenciar seus caminhos
 
     Métodos:
-        create_file: Cria um novo arquivo com o conteúdo especificado
-        delete_file: Exclui um arquivo especificado
-        read_file: Lê o conteúdo de um arquivo especificado
-        write_file: Escreve conteúdo em um arquivo especificado
+        screen_shot: Cria uma captura de tela e a salva em um diretório especificado
+        count_files: Conta o número de arquivos em um diretório especificado
+        flag_create: Cria um arquivo de flag
+        flag_delete: Exclui um arquivo de flag
 
     A classe File é parte do RPA Suite e pode ser acessada através do objeto rpa:
         >>> from rpa_suite import rpa
-        >>> rpa.file.create_file('exemplo.txt', 'Olá, Mundo!')
+        >>> rpa.file.screen_shot('exemplo')
 
     Parâmetros:
-        file_name (str): O nome do arquivo a ser criado ou manipulado
-        content (str): O conteúdo a ser escrito no arquivo
-        path (str): O caminho do diretório onde o arquivo deve ser criado ou excluído
+        file_name (str): O nome do arquivo de captura de tela
+        path_dir (str): O caminho do diretório onde a captura de tela deve ser salva
+        save_with_date (bool): Indica se o nome do arquivo deve incluir a data
+        delay (int): O tempo de espera antes de capturar a tela
     """
+    
     def __init__(self):
         self.__create_ss_dir = create_ss_dir
 
@@ -64,7 +65,7 @@ class File():
                     save_with_date: bool = True,
                     delay: int = 1, 
                     use_default_path_and_name: bool = True,
-                    name_ss_dir:str = None,
+                    name_ss_dir:str | None = None,
                     display_message: bool = False) -> str | None:
 
         """
@@ -72,10 +73,13 @@ class File():
 
         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`.
+        ``path_dir: str`` - should be a string, not have a default path.
         ``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).
+        ``use_default_path_and_name: bool`` - should be a boolean, by default `True`
+        ``name_ss_dir: str`` - should be a string, by default type `None`
+        ``display_message`` - should be a boolean, by default `False`
 
         Return:
         ----------
@@ -88,10 +92,13 @@ class File():
 
         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`.
+        ``file_path: str`` - deve ser uma string, não tem um caminho padrão.
         ``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).
+        ``use_default_path_and_name: bool`` - deve ser um booleano, por padrão `True`
+        ``name_ss_dir: str`` - deve ser uma string, por padrão do tipo `None`
+        ``display_message`` - deve ser um booleano, por padrão `False`
         
         Retorno:
         ----------
@@ -149,7 +156,7 @@ class File():
 
     def flag_create(self,
                     name_file: str = 'running.flag',
-                    path_to_create: str = None,
+                    path_to_create: str | None = None,
                     display_message: bool = True) -> None:
         """
         Cria um arquivo de sinalização indicando que o robô está em execução.
@@ -172,7 +179,7 @@ class File():
 
     def flag_delete(self,
                     name_file: str = 'running.flag',
-                    path_to_delete: str = None,
+                    path_to_delete: str | None = None,
                     display_message: bool = True,) -> None:
         
         """
@@ -241,7 +248,7 @@ class File():
         # Process
         try:
             for dir in dir_to_count:
-                for current_dir, sub_dir, files in os.walk(dir):
+                for _, _, files in os.walk(dir):
                     for file in files:
                         if type_extension == '*' or file.endswith(f'.{type_extension}'):
                             result['qt'] += 1

rpa_suite/suite.py

@@ -9,6 +9,7 @@ from .core.regex import Regex
 from .core.validate import Validate
 from colorama import Fore
 
+
 # Windows bash colors
 class Colors():
 
@@ -134,8 +135,6 @@ class Suite():
     def __init__(self):
         ...
     
-    
-    
     def success_print(self,
                         string_text: str,
                         color=Colors.green,

{rpa_suite-1.4.1.dist-info → rpa_suite-1.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rpa_suite
-Version: 1.4.1
+Version: 1.4.2
 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
@@ -186,7 +186,7 @@ Lançamento: *20/02/2024*
 
 Status: Em desenvolvimento.
 
-### Notas da atualização: 1.4.1
+### Notas da atualização: 1.4.2
 
 - Correções de bugs em diversas funções relacionadas a tempo: *exec_at_hour* , *wait_for_exec* , *exec_and_wait*
 - Correções de bugs com tempo superior a 10 minutos nas funções de data: *get_hms* e *get_dma*

{rpa_suite-1.4.1.dist-info → rpa_suite-1.4.2.dist-info}/RECORD

@@ -1,11 +1,11 @@
-rpa_suite/__init__.py,sha256=FltmvZSoiSq67rk1Oq1dMdrO-lOgHDidhkF7WPm4ybE,2297
-rpa_suite/suite.py,sha256=nZxXonIVFNdJo7EFoCfhc7lZA_svz0DBoApeca_bDCo,10120
-rpa_suite/core/__init__.py,sha256=VROMsrhKGMqUlstH8cEqp5fwRVC12d3U3_XoxoKOzyg,28
-rpa_suite/core/clock.py,sha256=DlKSSG9W0SG4mtpbmxh3-OMsSBg8ZqMyn9gBxEF-tvI,13799
+rpa_suite/__init__.py,sha256=BDRCB6CggcWSh2wOgPuxL5iPDRRYuPibTaEG7eLMyhc,2297
+rpa_suite/suite.py,sha256=WnCJ-AZ99NxnoS10E7_qX_0eg886B2IDekj6Cl1HFVA,10110
+rpa_suite/core/__init__.py,sha256=1XkytWVpVwyP8Dmm4UsXE625P5i7MOOXJBsQOPfCqiE,1046
+rpa_suite/core/clock.py,sha256=sTaYknZo46-L199k3utQdJ2b2IyL7FEkQu_dgwbdVMo,13800
 rpa_suite/core/date.py,sha256=PBU999Acxiwoep029ElqKSzK6T4DrF3eIP-LB_J-BbM,6568
 rpa_suite/core/dir.py,sha256=y6YDyRYQdf9Bj0z3Gs6ugNZ0tKWYgWdDI5R5BjjRIEY,9783
-rpa_suite/core/email.py,sha256=0bK70FSzsWhe2UvTHlnW_o9-c2rX7Beugr2kt2TXTwM,7429
-rpa_suite/core/file.py,sha256=AdpktNTXvHTsRHhm0F1JdG7xDsYvRCv_6j2vZubxqss,10945
+rpa_suite/core/email.py,sha256=kQJAc6Nb9y7jo-oBAo8X1EZS2y-_gTJRoRc9ylS04CE,8675
+rpa_suite/core/file.py,sha256=xuXaV_jon8hJ1Fb2j5DukXfnAzZRmtFgVJhTQs8dptU,11572
 rpa_suite/core/log.py,sha256=cfnThg3cKCRZ4InXPSThKNVuHbN6c06l3wilU0NuDck,17802
 rpa_suite/core/print.py,sha256=tLHIKo6LDTrV91gWKvwlTrxb1idgx3EV_fIRkqtzWBM,6389
 rpa_suite/core/regex.py,sha256=wsTxe8-baKul2Fv1-fycXZ-DVa5krhkc9qMkP04giGs,3303
@@ -18,8 +18,8 @@ rpa_suite/functions/_logger.py,sha256=gTYO9JlbX5_jDfu_4FTTajJw3_GotE2BHUbDDB1Hf5
 rpa_suite/functions/_printer.py,sha256=r72zeobAi2baVbYgbfFH0h5-WMv4tSDGPNlcpZen7O0,3949
 rpa_suite/functions/_variables.py,sha256=vCcktifFUriBQTyUaayZW8BlE8Gr7VP-tFbfomKOS5U,312
 rpa_suite/functions/_variables_uru.py,sha256=xRqYp49l1fFNrHczOmJ6Pqw1PKIWs0f9kxlgvuYGYys,303
-rpa_suite-1.4.1.dist-info/licenses/LICENSE,sha256=5D8PIbs31iGd9i1_MDNg4SzaQnp9sEIULALh2y3WyMI,1102
-rpa_suite-1.4.1.dist-info/METADATA,sha256=gnpgfEeLIbREvsy37hvOwzPV5HzqZ0TbhAKM9zpqYT8,9351
-rpa_suite-1.4.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-rpa_suite-1.4.1.dist-info/top_level.txt,sha256=HYkDtg-kJNAr3F2XAIPyJ-QBbNhk7q6jrqsFt10lz4Y,10
-rpa_suite-1.4.1.dist-info/RECORD,,
+rpa_suite-1.4.2.dist-info/licenses/LICENSE,sha256=5D8PIbs31iGd9i1_MDNg4SzaQnp9sEIULALh2y3WyMI,1102
+rpa_suite-1.4.2.dist-info/METADATA,sha256=Tin3NzbSIPyO5n2MYjC7GExxMDIeyhm6UPi1H9iL0N8,9351
+rpa_suite-1.4.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+rpa_suite-1.4.2.dist-info/top_level.txt,sha256=HYkDtg-kJNAr3F2XAIPyJ-QBbNhk7q6jrqsFt10lz4Y,10
+rpa_suite-1.4.2.dist-info/RECORD,,