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 o conteúdo do arquivo diretamente. 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 de regras para mais informações.
Quando um File
é transmitido a um objeto Args
sem usar uma função map_each
, ele é convertido em uma string usando o valor do campo path
.
Membros
- basename
- dirname (em inglês)
- extensão
- is_directory
- is_source
- proprietário
- path
- raiz
- short_path
- tree_relative_path
basename
string File.basenameO nome base deste arquivo. Esse é o nome do arquivo que está no diretório.
dirname
string File.dirnameO nome do diretório que contém o arquivo. Ele é retirado de path e é sempre relativo ao diretório de execução.
extensão
string File.extensionA extensão do arquivo, após (não incluindo) o ponto mais à direita. String vazia se o nome básico do arquivo não incluir pontos.
is_directory
bool File.is_directoryRetorna verdadeiro se for um diretório.
is_source
bool File.is_sourceRetorna verdadeiro se este for um arquivo de origem, ou seja, se ele não for gerado.
proprietário
Label File.ownerUm rótulo de um destino que produz esse arquivo. Pode retornar
None
.
caminho
string File.pathO caminho de execução desse arquivo, relativo ao diretório de execução do espaço de trabalho. Ele consiste em duas partes: uma primeira parte opcional chamada de raiz (consulte também o módulo raiz) e a segunda parte, que é o
short_path
. A raiz pode estar vazia, o que geralmente acontece com arquivos não gerados. Para arquivos gerados, ele geralmente contém um fragmento de caminho específico da configuração que codifica itens como a arquitetura de CPU de destino usada durante a criação do arquivo. Use 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.rootA raiz em que o arquivo está localizado.
short_path
string File.short_pathO caminho deste arquivo em relação à raiz. Isso exclui a raiz mencionada anteriormente, ou seja, fragmentos do caminho específicos da configuração. Esse também é o caminho em que o arquivo é mapeado se ele estiver nos arquivos de execução de um binário.
tree_relative_path
string File.tree_relative_pathO caminho desse arquivo em relação à raiz da árvore do ancestral, se o campo is_directory do ancestral for verdadeiro.
tree_relative_path
só está disponível para arquivos abertos de um diretório em um comando de ação, ou seja, Args.add_all(). Para outros tipos de arquivos, é um erro acessar esse campo.