Ações do Arquivo
Ações de arquivo são ações que podem interagir com arquivos e pastas em seu computador.
Ações
file.copy
Copie um arquivo ou pasta.
Parâmetros:
Ações de Arquivo
As ações de arquivo permitem interagir com arquivos e pastas no host do robô.
Observação: os retornos das ações são mapeados para variáveis de estado — por exemplo, se a ação retorna {'filename': 'a.txt'}
você acessa com $filename
no fluxo.
Métodos expostos
Documentamos abaixo apenas as ações anotadas com @decorators.robotaction
encontradas em file.py
.
file.copy
Copia um arquivo ou pasta.
Parâmetros:
- source
— caminho do arquivo ou pasta de origem.
- destination
— caminho de destino.
Retorno: nenhum.
Exceções:
- FileNotFoundException
se origem/destino incorreto ou cópia falhar.
file.create_folder
Cria uma nova pasta (apenas a última parte do caminho é criada).
Parâmetros:
- path
— caminho da nova pasta.
Retorno: nenhum.
Exceções:
- FileNotFoundException
se o caminho não puder ser criado.
file.delete
Exclui arquivo ou pasta.
Parâmetros:
- path
— caminho do arquivo ou pasta a remover.
Retorno: nenhum.
Exceções:
- FileNotFoundException
se o caminho não existir.
file.download
Faz o download de um arquivo a partir de uma URL para o caminho especificado.
Parâmetros:
- url
— URL de onde baixar.
- filepath
— caminho destino local (no host do robô).
Retorno: nenhum.
file.move
Move um arquivo ou pasta.
Parâmetros:
- source
— caminho de origem.
- destination
— caminho de destino.
Retorno: nenhum.
Exceções:
- FileNotFoundException
se origem/destino incorreto ou falha ao mover.
file.rename
Renomeia um arquivo ou pasta (internamente chama file.move
).
Parâmetros:
- source
— caminho atual.
- destination
— novo caminho/nome.
Retorno: nenhum.
file.file_exists
Verifica se um arquivo existe.
Parâmetros:
- path
— caminho a verificar.
Retorno (variável de estado):
- exists
— boolean (True
/False
).
file.folder_exists
Verifica se uma pasta existe.
Parâmetros:
- path
— caminho a verificar.
Retorno (variável de estado):
- exists
— boolean (True
/False
).
file.newest_file
Retorna o caminho do arquivo mais novo em uma pasta (ou padrão com *
).
Parâmetros:
- path
— caminho da pasta (pode terminar com /
ou \
).
Retorno (variável de estado):
- path
— caminho completo do arquivo mais recente.
Observação: se a pasta não existir ou não houver arquivos, a ação pode lançar erro.
file.list_files
Lista todos os arquivos que correspondem a um padrão (suporta *
).
Parâmetros:
- path
— caminho ou padrão (ex.: c:/temp/*.txt
).
Retorno (variáveis de estado):
- files
— lista de caminhos de arquivos.
- files_count
— número de arquivos retornados.
file.list
Lista todos os itens (arquivos e pastas) que correspondem a um padrão.
Parâmetros:
- path
— caminho ou padrão.
Retorno:
- items
— lista de itens (caminhos).
- items_count
— total de itens.
file.list_folders
Lista apenas as pastas que correspondem a um padrão.
Parâmetros:
- path
— caminho ou padrão.
Retorno:
- folders
— lista de pastas.
- folders_count
— número de pastas.
file.size
Retorna o tamanho de um arquivo em bytes, KB e MB.
Parâmetros:
- path
— caminho do arquivo.
Retorno:
- size
— bytes.
- sizeKB
— kilobytes (float).
- sizeMB
— megabytes (float).
file.unzip
Descompacta um arquivo ZIP para a pasta de destino.
Parâmetros:
- zip_file
— caminho do arquivo .zip.
- extract_folder
— pasta destino onde os arquivos serão extraídos.
Retorno: nenhum.
file.get_filename
Retorna o nome do arquivo a partir do filepath
(resolve assets internamente).
Parâmetros:
- filepath
— caminho ou referência no assets.
Retorno:
- filename
— nome do arquivo (ex.: document.pdf
).
file.get_file_extension
Retorna a extensão do arquivo (sem o ponto).
Parâmetros:
- filepath
— caminho ou nome do arquivo.
Retorno:
- extension
— extensão (ex.: pdf
, txt
).
file.to_base64
Converte o conteúdo do arquivo para string base64.
Parâmetros:
- filepath
— caminho ou referência no assets.
Retorno:
- base64
— string base64 do conteúdo do arquivo.
Se quiser, posso adicionar exemplos curtos de uso para algumas dessas ações (ex.: file.get_filename
e file.to_base64
) mostrando como ler as variáveis de estado com $filename
ou $base64
.