template_ctx

Nocturno · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.7
Es un objeto de contexto que se pasa a la función de expansión de la plantilla de acción.

Miembros

args

Args template_ctx.args()

Devuelve un objeto Args que se puede usar para compilar líneas de comandos eficientes en el uso de memoria.

declare_file

File template_ctx.declare_file(filename, *, directory)

Declara que la implementación crea un archivo con el nombre de archivo determinado dentro del directorio especificado.

Recuerda que, además de declarar un archivo, debes crear por separado una acción que emita el archivo. Para crear esa acción, deberás pasar el objeto File que se devolvió a la función de construcción de la acción.

Parámetros

Parámetro Descripción
filename string; obligatorio
Es la ruta de acceso relativa del archivo dentro del directorio.
directory Archivo; obligatorio
Es el directorio en el que se debe crear el archivo.

run

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

Crea una acción que ejecuta un archivo ejecutable.

Parámetros

Parámetro Descripción
outputs sequence de Files; obligatorio
Lista de los archivos de salida de la acción.
inputs sequence de Files o depset; el valor predeterminado es []
Lista o depset de los archivos de entrada de la acción.
executable File, string o FilesToRunProvider; obligatorio
Es el archivo ejecutable al que llamará la acción.
tools sequence, depset o None; el valor predeterminado es None
Lista o depset de las herramientas que necesita la acción. Las herramientas son entradas ejecutables que pueden tener sus propios archivos ejecutables, los cuales se ponen a disposición de la acción automáticamente.

Cuando se proporciona una lista, puede ser una colección heterogénea de los siguientes elementos:

  • File s
  • FilesToRunProvider instancias
  • depsets de Files
Los Files de ctx.executable y los FilesToRunProviders que se encuentran directamente en la lista tendrán sus archivos ejecutables agregados automáticamente. Todas las herramientas se agregan de forma implícita como entradas.

arguments sequence; el valor predeterminado es []
Son los argumentos de la línea de comandos de la acción. Debe ser una lista de cadenas o de objetos actions.args().
progress_message cadena o None; el valor predeterminado es None
Mensaje de progreso que se muestra al usuario durante la compilación.