utils-global 1.8.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,29 @@
1
+ # Pacote automacao_utils
2
+
3
+ Este pacote contém módulos utilitários para automações baseadas em Selenium, facilitando operações comuns como downloads de arquivos, verificação de arquivos em uso, e detecção de erros.
4
+
5
+ ## Módulos Disponíveis
6
+
7
+ - [download_utils](./download_utils.md): Funções para gerenciamento de downloads e tratamento de erros
8
+ - [version_check](./version_check.md): Sistema de verificação de versões da biblioteca
9
+ - [selenium_utils](./selenium_utils.md): Utilitários para interação com iframes no Selenium
10
+ - [notificacao_utils](./notificacao_utils.md): Envio de notificações para o Microsoft Teams
11
+
12
+ ## Importação
13
+
14
+ ```python
15
+ # Importação básica
16
+ from automacao_utils import processar_download, DownloadErroException
17
+
18
+ # Importação específica
19
+ from automacao_utils.download_utils import renomear_arquivo, limpar_nome_arquivo
20
+ from automacao_utils.version_check import mostrar_ultima_versao
21
+ from automacao_utils.selenium_utils import garantir_iframe
22
+ from automacao_utils.notificacao_utils import enviar_msg_teams
23
+ ```
24
+
25
+ ## Versão Atual
26
+
27
+ A versão atual do pacote é `1.8.1`.
28
+
29
+ Para mais detalhes sobre cada módulo, consulte a documentação específica nos links acima.
@@ -0,0 +1,31 @@
1
+ """
2
+ Biblioteca de funções úteis para automações com Selenium.
3
+ Fornece utilitários para manipulação de arquivos, downloads e interações com Selenium.
4
+ """
5
+
6
+ # Versão do pacote
7
+ __version__ = "1.8.1"
8
+
9
+ # Funções de Download
10
+ from automacao_utils.download_utils import (
11
+ processar_download,
12
+ iniciar_monitoramento,
13
+ aguardar_download,
14
+ aguardar_carregamento,
15
+ renomear_arquivo,
16
+ is_file_in_use,
17
+ wait_for_file_access,
18
+ is_temp_file_growing,
19
+ limpar_nome_arquivo,
20
+ DownloadErroException
21
+ )
22
+
23
+ # Funções de Selenium
24
+ from automacao_utils.selenium_utils import garantir_iframe
25
+
26
+ # Funções de Notificações
27
+ from automacao_utils.notificacao_utils import enviar_msg_teams
28
+
29
+ # Funções de Movimentação de Arquivos
30
+ from automacao_utils.mover_arquivo_utils import mover_arquivo
31
+
@@ -0,0 +1,197 @@
1
+ # Módulo download_utils
2
+
3
+ Este módulo contém funções para gerenciamento de downloads e tratamento de erros em automações Selenium.
4
+
5
+ ## Classes
6
+
7
+ ### DownloadErroException
8
+
9
+ Exceção personalizada para erros durante o processo de download.
10
+
11
+ ```python
12
+ class DownloadErroException(Exception):
13
+ def __init__(self, mensagem, seletor_erro=None, codigo_erro="DESCONHECIDO", elemento_visivel=None):
14
+ super().__init__(mensagem)
15
+ self.mensagem = mensagem
16
+ self.seletor_erro = seletor_erro
17
+ self.codigo_erro = codigo_erro
18
+ self.elemento_visivel = elemento_visivel
19
+ ```
20
+
21
+ **Atributos:**
22
+ - `mensagem`: Mensagem detalhada do erro
23
+ - `seletor_erro`: Seletor(es) que foram passados como parâmetro na função (pode ser uma lista)
24
+ - `codigo_erro`: Código do erro (ex: "ELEMENTO", "TIMEOUT")
25
+ - `elemento_visivel`: Seletor específico que estava visível (quando há múltiplos seletores)
26
+
27
+ ## Funções Principais
28
+
29
+ ### processar_download
30
+
31
+ ```python
32
+ def processar_download(sb, dir_download, btn_download, nome_arquivo, seletor_carregamento=None,
33
+ seletores_erro=None):
34
+ ```
35
+
36
+ Processa o download de um arquivo, incluindo clique no botão, aguardo do download e tratamento de erros.
37
+
38
+ **Parâmetros:**
39
+ - `sb`: Instância do SeleniumBase
40
+ - `dir_download`: Diretório onde o arquivo será baixado
41
+ - `btn_download`: Seletor CSS do botão de download
42
+ - `nome_arquivo`: Nome a ser dado ao arquivo
43
+ - `seletor_carregamento`: Seletor CSS para indicador de carregamento (opcional)
44
+ - `seletores_erro`: Seletor(es) CSS para mensagens de erro (string ou lista)
45
+
46
+ **Retorno:**
47
+ - Caminho completo para o arquivo baixado
48
+
49
+ ### aguardar_download
50
+
51
+ ```python
52
+ def aguardar_download(sb, dir_download, handler, observer, seletores_erro=None, tempo_max_espera=180, intervalo=1):
53
+ ```
54
+
55
+ Aguarda o download de um arquivo ser concluído e retorna o caminho do arquivo.
56
+
57
+ **Parâmetros:**
58
+ - `sb`: Instância do SeleniumBase
59
+ - `dir_download`: Diretório onde o arquivo será baixado
60
+ - `handler`: Instância do manipulador de eventos de arquivo
61
+ - `observer`: Instância do observador de diretório
62
+ - `seletores_erro`: Seletor(es) CSS para mensagens de erro (string ou lista)
63
+ - `tempo_max_espera`: Tempo máximo de espera em segundos
64
+ - `intervalo`: Intervalo entre verificações em segundos
65
+
66
+ **Retorno:**
67
+ - Caminho completo para o arquivo baixado
68
+
69
+ **Exceções:**
70
+ - `DownloadErroException`: Quando ocorre um erro durante o download
71
+ - Exceções genéricas
72
+
73
+ ### aguardar_carregamento
74
+
75
+ ```python
76
+ def aguardar_carregamento(sb, seletor):
77
+ ```
78
+
79
+ Aguarda até que um elemento de carregamento desapareça ou apareça.
80
+
81
+ **Parâmetros:**
82
+ - `sb`: Instância do SeleniumBase
83
+ - `seletor`: Seletor CSS do elemento de carregamento
84
+
85
+ ### renomear_arquivo
86
+
87
+ ```python
88
+ def renomear_arquivo(caminho_arquivo, novo_nome):
89
+ ```
90
+
91
+ Renomeia um arquivo de forma segura, aguardando caso o arquivo esteja em uso.
92
+
93
+ **Parâmetros:**
94
+ - `caminho_arquivo`: Caminho do arquivo a ser renomeado
95
+ - `novo_nome`: Novo nome para o arquivo (sem extensão)
96
+
97
+ **Retorno:**
98
+ - Caminho do arquivo renomeado
99
+
100
+ ## Funções Auxiliares
101
+
102
+ ### is_file_in_use
103
+
104
+ ```python
105
+ def is_file_in_use(filepath):
106
+ ```
107
+
108
+ Verifica se um arquivo está em uso por outro processo.
109
+
110
+ **Parâmetros:**
111
+ - `filepath`: Caminho do arquivo a verificar
112
+
113
+ **Retorno:**
114
+ - `True` se o arquivo estiver em uso, `False` caso contrário
115
+
116
+ ### wait_for_file_access
117
+
118
+ ```python
119
+ def wait_for_file_access(filepath, max_retries=30, retry_interval=1):
120
+ ```
121
+
122
+ Aguarda até que um arquivo esteja disponível para acesso.
123
+
124
+ **Parâmetros:**
125
+ - `filepath`: Caminho do arquivo a verificar
126
+ - `max_retries`: Número máximo de tentativas
127
+ - `retry_interval`: Intervalo entre tentativas em segundos
128
+
129
+ **Retorno:**
130
+ - `True` se o arquivo estiver disponível, `False` se o timeout for atingido
131
+
132
+ ### limpar_nome_arquivo
133
+
134
+ ```python
135
+ def limpar_nome_arquivo(nome):
136
+ ```
137
+
138
+ Remove caracteres inválidos para nomes de arquivos.
139
+
140
+ **Parâmetros:**
141
+ - `nome`: Nome a ser limpo
142
+
143
+ **Retorno:**
144
+ - Nome limpo, sem caracteres inválidos
145
+
146
+ ## Exemplos de Uso
147
+
148
+ ### Exemplo Básico
149
+
150
+ ```python
151
+ from automacao_utils import processar_download
152
+
153
+ def baixar_relatorio(sb):
154
+ caminho_arquivo = processar_download(
155
+ sb=sb,
156
+ dir_download="C:/Downloads",
157
+ btn_download="#botao_download",
158
+ nome_arquivo="relatorio_mensal"
159
+ )
160
+
161
+ print(f"Arquivo baixado: {caminho_arquivo}")
162
+ return caminho_arquivo
163
+ ```
164
+
165
+ ### Exemplo com Tratamento de Erros
166
+
167
+ ```python
168
+ from automacao_utils import processar_download, DownloadErroException
169
+
170
+ def baixar_relatorio(sb):
171
+ try:
172
+ caminho_arquivo = processar_download(
173
+ sb=sb,
174
+ dir_download="C:/Downloads",
175
+ btn_download="#botao_download",
176
+ nome_arquivo="relatorio_mensal",
177
+ seletor_carregamento="#loader",
178
+ seletores_erro=["#mensagem_erro", "#outro_erro"]
179
+ )
180
+
181
+ print(f"Download concluído com sucesso: {caminho_arquivo}")
182
+ return caminho_arquivo
183
+
184
+ except DownloadErroException as e:
185
+ if e.codigo_erro == "ELEMENTO":
186
+ print(f"Erro: Elemento de erro detectado: {e.mensagem}")
187
+
188
+ # Identifica qual elemento específico foi encontrado
189
+ if e.elemento_visivel == "#mensagem_erro":
190
+ print("Erro de validação detectado")
191
+ elif e.elemento_visivel == "#outro_erro":
192
+ print("Outro tipo de erro encontrado")
193
+ else:
194
+ print(f"Erro desconhecido: {e.mensagem}")
195
+
196
+ return None
197
+ ```