módulo_ctx

El contexto de la extensión del módulo que contiene funciones auxiliares e información sobre las etiquetas pertinentes del gráfico de dependencias. Cuando creas una extensión de módulo, obtienes un objeto module_ctx como argumento para la función implementation.

Miembros

• descargar
• download_and_extract
• ejecutar
• extension_metadata
• archivo
• is_dev_dependency
• modules
• SO
• path
• leer
• report_progress
• cuál

descarga

struct module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')

Descarga un archivo en la ruta de salida para la URL proporcionada y muestra una struct que contiene success, una marca que es true si la descarga se completó correctamente y, si se realizó correctamente, un hash del archivo con los campos sha256 y integrity.

Parámetros

Parámetro	Descripción
url	string; or Iterable of strings; obligatorio Lista de URLs duplicadas que hacen referencia al mismo archivo.
output	string; or Label; or path; predeterminado = '' de salida al archivo de salida, en relación con el directorio del repositorio.
sha256	predeterminado = '' el hash SHA-256 esperado del archivo descargado. Debe coincidir con el hash SHA-256 del archivo descargado. Omitir el SHA-256 representa un riesgo de seguridad, ya que pueden cambiar los archivos remotos. En el mejor de los casos, omitir este campo hará que tu compilación no sea hermética. Es opcional facilitar el desarrollo, pero se debe configurar antes del envío.
executable	predeterminado = Falso establece la marca ejecutable en el archivo creado; es falso de forma predeterminada.
allow_fail	predeterminado = Falso Si se configura, indica el error en el valor que se muestra en lugar de generar un error para las descargas con errores
canonical_id	predeterminado = '' Si se configura, restringe los aciertos de caché a aquellos casos en los que el archivo se haya agregado a la caché con el mismo ID canónico
auth	default = {} Un diccionario opcional que especifica la información de autenticación para algunas de las URL.
integrity	predeterminado = '' Suma de comprobación esperada del archivo descargado, en formato de integridad de los subrecursos. Debe coincidir con la suma de comprobación del archivo descargado. Omitir la suma de comprobación representa un riesgo de seguridad, ya que pueden cambiar los archivos remotos. En el mejor de los casos, omitir este campo hará que tu compilación no sea hermética. Es opcional facilitar el desarrollo, pero se debe configurar antes del envío.

download_and_extract

struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})

Descarga un archivo en la ruta de salida para la URL proporcionada, lo extrae y muestra un struct que contiene success, una marca true si la descarga se completó correctamente y, si se realizó correctamente, un hash del archivo con los campos sha256 y integrity.

Parámetros

Parámetro	Descripción
url	string; or Iterable of strings; obligatorio Lista de URLs duplicadas que hacen referencia al mismo archivo.
output	string; or Label; or path; predeterminado = '' la ruta de acceso al directorio donde se descomprimirá el archivo, en relación con el directorio del repositorio.
sha256	predeterminado = '' el hash SHA-256 esperado del archivo descargado. Debe coincidir con el hash SHA-256 del archivo descargado. Omitir el SHA-256 representa un riesgo de seguridad, ya que pueden cambiar los archivos remotos. En el mejor de los casos, omitir este campo hará que tu compilación no sea hermética. Es opcional facilitar el desarrollo, pero se debe configurar antes del envío. Si se proporciona, primero se verificará la caché del repositorio en busca de un archivo con el hash determinado. solo se intentará realizar una descarga si el archivo no se encuentra en la caché. Si la descarga se realiza correctamente, el archivo se agregará a la caché.
type	predeterminado = '' el tipo de archivo del archivo descargado. De forma predeterminada, el tipo de archivo se determina a partir de la extensión de archivo de la URL. Si el archivo no tiene extensión, puedes especificar explícitamente “zip”, “jar”, “war”, “aar”, “tar”, “tar.gz”, “tgz”, “tar.xz”, “txz”, “.tar.zst”, “.tzst”, “tar.bz2”, “.ar” o “.deb” aquí.
stripPrefix	predeterminado = '' un prefijo de directorio para quitar de los archivos extraídos. Muchos archivos contienen un directorio de nivel superior que contiene todos los archivos en el archivo. En lugar de necesitar especificar este prefijo una y otra vez en build_file, se puede usar este campo para quitarlo de los archivos extraídos.
allow_fail	predeterminado = Falso Si se configura, indica el error en el valor que se muestra en lugar de generar un error para las descargas con errores
canonical_id	predeterminado = '' Si se configura, restringe los aciertos de caché a aquellos casos en los que el archivo se haya agregado a la caché con el mismo ID canónico
auth	default = {} Un diccionario opcional que especifica la información de autenticación para algunas de las URL.
integrity	predeterminado = '' Suma de comprobación esperada del archivo descargado, en formato de integridad de los subrecursos. Debe coincidir con la suma de comprobación del archivo descargado. Omitir la suma de comprobación representa un riesgo de seguridad, ya que pueden cambiar los archivos remotos. En el mejor de los casos, omitir este campo hará que tu compilación no sea hermética. Es opcional facilitar el desarrollo, pero se debe configurar antes del envío.
rename_files	default = {} Un dict opcional que especifica los archivos a los que se les debe cambiar el nombre durante la extracción. Se cambiará el nombre de las entradas de archivo con nombres que coincidan exactamente con una clave por el valor, antes de cualquier ajuste del prefijo del directorio. Se puede usar para extraer archivos que contengan nombres que no sean Unicode o que tengan archivos que se extraerían en la misma ruta de acceso en sistemas de archivos que no distinguen mayúsculas de minúsculas.

ejecutar

exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")

Ejecuta el comando proporcionado por la lista de argumentos. El tiempo de ejecución del comando está limitado por timeout (en segundos, el valor predeterminado es 600 segundos). Este método muestra una estructura exec_result que contiene el resultado del comando. El mapa environment se puede usar para anular algunas variables de entorno que se pasarán al proceso.

Parámetros

Parámetro	Descripción
arguments	obligatorio Lista de argumentos. El primer elemento debe ser la ruta de acceso al programa que se ejecutará.
timeout	valor predeterminado = 600 la duración máxima del comando en segundos (el valor predeterminado es 600 segundos).
environment	default = {} fuerce la configuración de algunas variables de entorno para que se pasen al proceso.
quiet	default = True Si stdout y stderr se deben imprimir en la terminal,
working_directory	default = "" Directorio de trabajo para la ejecución del comando. Puede ser absoluta o relativa a la raíz del repositorio.

extension_metadata

extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None)

Construye un objeto opaco que se puede mostrar desde la función de implementación de la extensión del módulo para proporcionar metadatos sobre los repositorios generados por la extensión para Bazel.

Parámetros

Parámetro	Descripción
root_module_direct_deps	sequence of strings; or string; or None; predeterminado = Ninguno Son los nombres de los repositorios que la extensión considera dependencias directas del módulo raíz. Si el módulo raíz importa repositorios adicionales o no importa todos estos a través de use_repo, Bazel imprimirá una advertencia y un comando de corrección cuando se evalúe la extensión. Si se especifica root_module_direct_deps o root_module_direct_dev_deps, el otro también debe especificarse. Las listas especificadas por estos dos parámetros deben ser inconexas. Se puede establecer exactamente uno de los valores root_module_direct_deps o root_module_direct_dev_deps en el valor especial "all", que se trata como si se especificara como valor una lista con los nombres de todos los repositorios generados por la extensión.
root_module_direct_dev_deps	sequence of strings; or string; or None; predeterminado = Ninguno Los nombres de los repositorios que la extensión considera como dependencias directas del desarrollo del módulo raíz. Si el módulo raíz importa repositorios adicionales o no importa todos estos a través de use_repo en un proxy de extensión creado con root_module_direct_deps y se especifica root_module_direct_dev_deps, también se debe especificar el otro. Las listas especificadas por estos dos parámetros deben ser inconexas. Se puede establecer exactamente uno de los valores root_module_direct_deps o root_module_direct_dev_deps en el valor especial "all", que se trata como si se especificara como valor una lista con los nombres de todos los repositorios generados por la extensión.

archivo

None module_ctx.file(path, content='', executable=True, legacy_utf8=True)

Genera un archivo en el directorio del repositorio con el contenido proporcionado.

Parámetros

Parámetro	Descripción
path	string; or Label; or path; obligatorio la ruta de acceso del archivo que se creará, en relación con el directorio del repositorio.
content	predeterminado = '' el contenido del archivo que se creará, vacío de forma predeterminada.
executable	default = True establece la marca ejecutable en el archivo creado (true) de forma predeterminada.
legacy_utf8	default = True para codificar el contenido del archivo en UTF-8, el valor predeterminado es verdadero. Las versiones futuras cambiarán el valor predeterminado y quitarán este parámetro.

is_dev_dependency

bool module_ctx.is_dev_dependency(tag)

Muestra si se especificó la etiqueta determinada en el resultado de una llamada use_extension con devDependency = True.

Parámetros

Parámetro	Descripción
tag	bazel_module_tag; obligatorio Una etiqueta obtenida de bazel_module.tags.

modules

list module_ctx.modules

Una lista de todos los módulos de Bazel en el gráfico de dependencias externas, cada uno de los cuales es un objeto bazel_module que expone todas las etiquetas que especificó para la extensión de este módulo. Se garantiza que el orden de iteración de este diccionario será el mismo que el de la búsqueda en amplitud a partir del módulo raíz.

os

repository_os module_ctx.os

Es un struct para acceder a la información del sistema.

ruta de acceso

path module_ctx.path(path)

Muestra una ruta de acceso de una cadena, etiqueta o ruta de acceso. Si la ruta es relativa, se resolverá en relación con el directorio del repositorio. Si la ruta es una etiqueta, se resolverá en la ruta del archivo correspondiente. Ten en cuenta que los repositorios remotos se ejecutan durante la fase de análisis y, por lo tanto, no pueden depender de un resultado objetivo (la etiqueta debe apuntar a un archivo no generado). Si la ruta es una ruta de acceso, la mostrará tal como es.

Parámetros

Parámetro	Descripción
path	string; or Label; or path; obligatorio cadena, etiqueta o ruta desde la que crear una ruta

read

string module_ctx.read(path)

Lee el contenido de un archivo en el sistema de archivos.

Parámetros

Parámetro	Descripción
path	string; or Label; or path; obligatorio la ruta de acceso del archivo desde el que se leerá.

report_progress

None module_ctx.report_progress(status='')

Actualiza el estado de progreso de la recuperación de la extensión de este repositorio o módulo

Parámetros

Parámetro	Descripción
status	string; predeterminado = '' Cadena que describe el estado actual del progreso de la recuperación

cuál

path module_ctx.which(program)

Muestra la ruta de acceso del programa correspondiente o None si no existe tal programa en la ruta.

Parámetros

Parámetro	Descripción
program	obligatorio Programa para encontrar en la ruta.

Es posible que se muestre None.