template_ctx

Um objeto de contexto transmitido para a função de expansão do modelo de ação.

Membros

args

Args template_ctx.args()

Retorna um objeto Args que pode ser usado para criar linhas de comando com eficiência de memória.

declare_file

File template_ctx.declare_file(filename, *, directory)

Declara que a implementação cria um arquivo com o nome especificado no diretório indicado.

Além de declarar um arquivo, é necessário criar uma ação que emita o arquivo. Para criar essa ação, transmita o objeto File retornado para a função de construção da ação.

Parâmetros

Parâmetro Descrição
filename string; required
The relative path of the file within the directory.
directory Arquivo; obrigatório
O diretório em que o arquivo será criado.

run

None template_ctx.run(*, outputs, inputs=[], executable, tools=None, arguments=[], progress_message=None)

Cria uma ação que executa um arquivo executável.

Parâmetros

Parâmetro Descrição
outputs sequência de arquivos; obrigatório
Lista dos arquivos de saída da ação.
inputs sequência de arquivos; ou depset; o padrão é []
Lista ou depset dos arquivos de entrada da ação.
executable Arquivo; ou string; ou FilesToRunProvider; obrigatório
O arquivo executável a ser chamado pela ação.
tools sequência; ou depset; ou None; o padrão é None
Lista ou depset de todas as ferramentas necessárias para a ação. As ferramentas são entradas executáveis que podem ter seus próprios runfiles, que são disponibilizados automaticamente para a ação.

Quando uma lista é fornecida, ela pode ser uma coleção heterogênea de:

  • Files
  • instâncias FilesToRunProvider
  • depsets de Files
Files de ctx.executable e FilesToRunProviders que estão diretamente na lista terão seus runfiles adicionados automaticamente. Todas as ferramentas são adicionadas implicitamente como entradas.

arguments sequência; o padrão é []
Argumentos de linha de comando da ação. Precisa ser uma lista de strings ou actions.args() objetos.
progress_message string; ou None; o padrão é None
Mensagem de progresso a ser mostrada ao usuário durante a build.