Esse objeto é criado durante a fase de análise para representar um arquivo ou diretório que será lido ou gravado durante a fase de execução. Ele não é um identificador de arquivo aberto e não pode ser usado para ler ou gravar diretamente o conteúdo do arquivo. Em vez disso, use-o para construir o gráfico de ações em uma função de implementação de regras, transmitindo-o para funções de criação de ações. Consulte a
página Regras para mais informações.
Quando um File
é transmitido para um objeto Args
sem usar uma função map_each
, ele é convertido em uma string usando o valor do campo path
.
Membros
nome de base
string File.basename
O nome base deste arquivo. Esse é o nome do arquivo que está no diretório.
dirname
string File.dirname
O nome do diretório que contém esse arquivo. Ele é extraído do
path e está sempre relativo ao diretório de execução.
extensão
string File.extension
A extensão desse arquivo, após (não incluindo) o ponto mais à direita. String vazia se o nome de base do arquivo não inclui pontos.
is_directory
bool File.is_directory
Retorna true se for um diretório.
is_source
bool File.is_source
Retorna "true" se este for um arquivo de origem, ou seja, não tiver sido gerado.
proprietário
Label File.owner
Um rótulo de um destino que produz esse arquivo.
Pode retornar
None
.
caminho
string File.path
O caminho de execução desse arquivo, relativo ao diretório de execução do espaço de trabalho. Ele consiste em duas partes: a primeira parte opcional chamada
raiz (veja também o módulo
raiz) e a segunda, o
short_path
. A raiz pode estar vazia, o que normalmente acontece com arquivos não gerados. Para arquivos gerados, ele geralmente contém um fragmento de caminho específico da configuração que codifica coisas como a arquitetura da CPU de destino usada na criação do arquivo em questão. Use o
short_path
para o caminho em que o arquivo é mapeado, se ele estiver nos arquivos de execução de um binário.
root
root File.root
A raiz abaixo da qual o arquivo reside.
short_path
string File.short_path
O caminho deste arquivo em relação à raiz. Isso exclui a
root mencionada acima, ou seja, fragmentos específicos da configuração do caminho. Esse também é o caminho sob o qual o arquivo será mapeado se estiver nos arquivos de execução de um binário.
tree_relative_path
string File.tree_relative_path
O caminho desse arquivo relativo à raiz da árvore do ancestral, se o campo
is_directory do ancestral for verdadeiro.
tree_relative_path
só está disponível para arquivos expandidos de um diretório em um comando de ação, ou seja,
Args.add_all(). Para outros tipos de arquivos, acessar esse campo é um erro.