Pular para conteúdo

File

As ações de arquivo permitem interagir com ficheiros e pastas no host do robô.

Observação: os retornos das ações viram variáveis de estado — por exemplo, se a ação retorna {'filename': 'a.txt'} você acessa como $filename no fluxo.

Abaixo documentamos apenas as ações anotadas com @decorators.robotaction em file.py.

Ações

file.copy

Copia um arquivo ou pasta.

Parâmetros:
  • source — caminho do arquivo ou pasta de origem.
  • destination — caminho de destino.
Retornar:

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.
Retornar:

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.
Retornar:

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ô).
Retornar:

nenhum.

file.file_exists

Verifica se um arquivo existe.

Parâmetros:
  • path — caminho a verificar.
Retornar:
  • exists — boolean (True/False).

file.folder_exists

Verifica se uma pasta existe.

Parâmetros:
  • path — caminho a verificar.
Retornar:
  • exists — boolean (True/False).

file.get_file_extension

Retorna a extensão do arquivo (sem o ponto).

Parâmetros:
  • filepath — caminho ou nome do arquivo.
Retornar:
  • extension — extensão (ex.: pdf, txt).

file.get_filename

Retorna o nome do arquivo a partir do filepath (resolve assets internamente).

Parâmetros:
  • filepath — caminho ou referência no assets.
Retornar:
  • filename — nome do arquivo (ex.: document.pdf).

file.is_pdf_by_magic

Verifica se o arquivo começa com os bytes mágicos %PDF- (independente da extensão).

Parâmetros:

path - caminho do arquivo no disco.

Retornar:

is_pdf - True quando o cabeçalho corresponde a um PDF.

magic_hex - representação hexadecimal dos bytes lidos no início do arquivo.

Exceções:

FileNotFoundException: se path não existir ou não for um arquivo.

file.is_zip_by_magic

Verifica se o arquivo começa com assinaturas de arquivo ZIP (cabeçalho PK e variantes), independente da extensão.

Parâmetros:

path - caminho do arquivo no disco.

Retornar:

is_zip - True quando o cabeçalho corresponde a assinatura ZIP local/arquivo vazio.

magic_hex - representação hexadecimal dos bytes lidos no início do arquivo.

Exceções:

FileNotFoundException: se path não existir ou não for um arquivo.

file.list

Lista todos os itens (arquivos e pastas) que correspondem a um padrão.

Parâmetros:
  • path — caminho ou padrão.
Retornar:
  • items — lista de itens (caminhos).
  • items_count — total de itens.

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).
Retornar:
  • files — lista de caminhos de arquivos.
  • files_count — número de arquivos retornados.

file.list_folders

Lista apenas as pastas que correspondem a um padrão.

Parâmetros:
  • path — caminho ou padrão.
Retornar:
  • folders — lista de pastas.
  • folders_count — número de pastas.

file.move

Move um arquivo ou pasta.

Parâmetros:
  • source — caminho de origem.
  • destination — caminho de destino.
Retornar:

nenhum.

Exceções:
  • FileNotFoundException se origem/destino incorreto ou falha ao mover.

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 \).
Retornar:
  • 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.rename

Renomeia um arquivo ou pasta (internamente chama file.move).

Parâmetros:
  • source — caminho atual.
  • destination — novo caminho/nome.
Retornar:

nenhum.

file.size

Retorna o tamanho de um arquivo em bytes, KB e MB.

Parâmetros:
  • path — caminho do arquivo.
Retornar:
  • size — bytes.
  • sizeKB — kilobytes (float).
  • sizeMB — megabytes (float).

file.to_base64

Converte o conteúdo do arquivo para string base64.

Parâmetros:
  • filepath — caminho ou referência no assets.
Retornar:
  • base64 — string base64 do conteúdo do arquivo.

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.
Retornar:

nenhum.

file.zip

Cria um arquivo ZIP a partir de um único arquivo ou de todos os arquivos dentro de uma pasta.

Parâmetros:

source - caminho do arquivo ou pasta a compactar.

zip_file - caminho de destino do arquivo .zip a ser criado.

Retornar:

Esta ação não dá retorno

Exceções:

FileNotFoundException: se source não existir.