módulo_ctx

Informar un problema Ver fuente Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Es el contexto de la extensión del módulo que contiene funciones auxiliares e información sobre etiquetas pertinentes en todo el gráfico de dependencias. Obtienes un objeto module_ctx como argumento para la función implementation cuando creas una extensión de módulo.

Miembros

descargar

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

Descarga un archivo en la ruta de acceso de salida para la URL proporcionada y devuelve un struct que contiene success, una marca que es true si la descarga se completó correctamente y, si se completó correctamente, un hash del archivo con los campos sha256 y integrity. Cuando el usuario especifica sha256 o integrity, se recomienda establecer un canonical_id explícito. p.ej., get_default_canonical_id

Parámetros

Parámetro Descripción
url cadena o iterable de cadenas; obligatorio
Es una lista de URLs duplicadas que hacen referencia al mismo archivo.
output cadena, Label o ruta de acceso; el valor predeterminado es ''
ruta de acceso al archivo de salida, relativa al directorio del repositorio
sha256 string; El valor predeterminado es ''
Es el hash SHA-256 esperado del archivo descargado. Debe coincidir con el hash SHA-256 del archivo descargado. Omitir el SHA-256 es un riesgo de seguridad, ya que los archivos remotos pueden cambiar. En el mejor de los casos, si omites este campo, tu compilación no será hermética. Es opcional para facilitar el desarrollo, pero se debe configurar antes del envío. Si se proporciona, primero se verificará la caché del repositorio para ver si hay un archivo con el hash determinado. Solo se intentará una descarga si no se encuentra el archivo en la caché. Después de una descarga exitosa, el archivo se agregará a la caché.
executable bool; el valor predeterminado es False
Establece la marca de ejecución en el archivo creado. El valor predeterminado es falso.
allow_fail bool; El valor predeterminado es False
Si se configura, indica el error en el valor de devolución en lugar de generar un error para las descargas fallidas.
canonical_id cadena; el valor predeterminado es ''
Si se configura, restringe los aciertos de caché a aquellos casos en los que el archivo se agregó a la caché con el mismo ID canónico. De forma predeterminada, el almacenamiento en caché usa la suma de verificación (sha256 o integrity).
auth dict; El valor predeterminado es {}
Es un diccionario opcional que especifica la información de autenticación para algunas de las URLs.
headers dict; el valor predeterminado es {}
Es un diccionario opcional que especifica encabezados HTTP para todas las URLs.
integrity cadena; el valor predeterminado es ''
Suma de comprobación esperada del archivo descargado, en formato de Subresource Integrity. Debe coincidir con la suma de verificación del archivo descargado. Omitir la suma de verificación es un riesgo de seguridad, ya que los archivos remotos pueden cambiar. En el mejor de los casos, si omites este campo, tu compilación no será hermética. Es opcional para facilitar el desarrollo, pero se debe configurar antes del envío. Si se proporciona, primero se verificará la caché del repositorio para ver si hay un archivo con la suma de verificación determinada. Solo se intentará una descarga si no se encuentra el archivo en la caché. Después de una descarga exitosa, el archivo se agregará a la caché.
block bool; el valor predeterminado es True
Si se establece en falso, la llamada se devuelve de inmediato y, en lugar del valor de devolución normal, devuelve un token con un solo método, wait(), que se bloquea hasta que finaliza la descarga y devuelve el valor de devolución habitual o arroja una excepción como de costumbre.

download_and_extract

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

Descarga un archivo en la ruta de acceso de salida para la URL proporcionada, lo extrae y devuelve un struct que contiene success, una marca que es true si la descarga se completó correctamente y, si se completó correctamente, un hash del archivo con los campos sha256 y integrity. Cuando el usuario especifica sha256 o integrity, se recomienda establecer un canonical_id explícito. p.ej., get_default_canonical_id

Parámetros

Parámetro Descripción
url cadena o iterable de cadenas; obligatorio
Es una lista de URLs duplicadas que hacen referencia al mismo archivo.
output cadena, Label o ruta de acceso; el valor predeterminado es ''
Ruta de acceso al directorio en el que se descomprimirá el archivo, relativa al directorio del repositorio.
sha256 string; El valor predeterminado es ''
Es el hash SHA-256 esperado del archivo descargado. Debe coincidir con el hash SHA-256 del archivo descargado. Omitir el SHA-256 es un riesgo de seguridad, ya que los archivos remotos pueden cambiar. En el mejor de los casos, si omites este campo, tu compilación no será hermética. Es opcional para facilitar el desarrollo, pero se debe configurar antes del envío. Si se proporciona, primero se verificará la caché del repositorio para ver si hay un archivo con el hash determinado. Solo se intentará una descarga si no se encuentra el archivo en la caché. Después de una descarga exitosa, el archivo se agregará a la caché.
type string; el valor predeterminado es ''
Es el tipo de archivo del archivo descargado. De forma predeterminada, el tipo de archivo se determina a partir de la extensión del archivo de la URL. Si el archivo no tiene extensión, puedes especificar explícitamente "zip", "jar", "war", "aar", "nupkg", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".tbz", ".ar" o ".deb" aquí.
strip_prefix string; El valor predeterminado es ''
Es un prefijo de directorio que se quitará de los archivos extraídos. Muchos archivos contienen un directorio de nivel superior que incluye todos los archivos del archivo. En lugar de tener que especificar este prefijo una y otra vez en el build_file, este campo se puede usar para quitarlo de los archivos extraídos.

Para la compatibilidad, este parámetro también se puede usar con el nombre obsoleto stripPrefix.

allow_fail bool; El valor predeterminado es False
Si se configura, indica el error en el valor de devolución en lugar de generar un error para las descargas fallidas.
canonical_id cadena; el valor predeterminado es ''
Si se configura, restringe los aciertos de caché a aquellos casos en los que el archivo se agregó a la caché con el mismo ID canónico. De forma predeterminada, el almacenamiento en caché usa la suma de verificación (sha256 o integrity).
auth dict; El valor predeterminado es {}
Es un diccionario opcional que especifica la información de autenticación para algunas de las URLs.
headers dict; el valor predeterminado es {}
Es un diccionario opcional que especifica encabezados HTTP para todas las URLs.
integrity cadena; el valor predeterminado es ''
Suma de comprobación esperada del archivo descargado, en formato de Subresource Integrity. Debe coincidir con la suma de verificación del archivo descargado. Omitir la suma de verificación es un riesgo de seguridad, ya que los archivos remotos pueden cambiar. En el mejor de los casos, si omites este campo, tu compilación no será hermética. Es opcional para facilitar el desarrollo, pero se debe configurar antes del envío. Si se proporciona, primero se verificará la caché del repositorio para ver si hay un archivo con la suma de verificación determinada. Solo se intentará una descarga si no se encuentra el archivo en la caché. Después de una descarga exitosa, el archivo se agregará a la caché.
rename_files dict; El valor predeterminado es {}
Es un diccionario opcional que especifica los archivos a los que se les cambiará el nombre durante la extracción. Las entradas del archivo con nombres que coincidan exactamente con una clave se cambiarán al valor antes de cualquier ajuste del prefijo del directorio. Se puede usar para extraer archivos que contienen nombres de archivo no Unicode o que tienen 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, 600 segundos de forma predeterminada). Este método devuelve 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 sequence: obligatorio
Lista de argumentos. El primer elemento debe ser la ruta de acceso al programa que se ejecutará.
timeout int; el valor predeterminado es 600
Duración máxima del comando en segundos (el valor predeterminado es 600 segundos).
environment dict; El valor predeterminado es {}
Fuerza la configuración de algunas variables de entorno para que se pasen al proceso. El valor puede ser None para quitar la variable de entorno.
quiet bool; el valor predeterminado es True
Indica si stdout y stderr se deben imprimir en la terminal.
working_directory cadena; el valor predeterminado es ""
Directorio de trabajo para la ejecución de comandos. Puede ser relativa a la raíz del repositorio o absoluta. La raíz del repositorio es la ubicación predeterminada.

extension_metadata

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

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

Parámetros

Parámetro Descripción
root_module_direct_deps sequence de strings, string o None; El valor predeterminado es None
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 repositorios a través de use_repo, Bazel imprimirá una advertencia cuando se evalúe la extensión, en la que se le indicará al usuario que ejecute bazel mod tidy para corregir las llamadas a use_repo automáticamente.

Si uno de los dos es root_module_direct_deps, se imprimirá una advertencia y un comando de corrección cuando se evalúe la extensión.

Si se especifica uno de los campos root_module_direct_deps y root_module_direct_dev_deps, también se debe especificar el otro. Las listas especificadas por estos dos parámetros deben ser disjuntas.

Se puede establecer exactamente uno de root_module_direct_deps y root_module_direct_dev_deps en el valor especial "all", que se trata como si se hubiera especificado una lista con los nombres de todos los repositorios generados por la extensión como el valor.

root_module_direct_dev_deps sequence de strings, string o None; el valor predeterminado es None
Son los nombres de los repositorios que la extensión considera que son dependencias de desarrollo directas del módulo raíz. Si el módulo raíz importa repositorios adicionales o no importa todos estos repositorios a través de use_repo en un proxy de extensión creado con use_extension(..., dev_dependency = True), Bazel imprimirá una advertencia cuando se evalúe la extensión, en la que se le indicará al usuario que ejecute bazel mod tidy para corregir las llamadas a use_repo automáticamente.

Si se especifica uno de los campos root_module_direct_deps y root_module_direct_dev_deps, también se debe especificar el otro. Las listas especificadas por estos dos parámetros deben ser disjuntas.

Se puede establecer exactamente uno de root_module_direct_deps y root_module_direct_dev_deps en el valor especial "all", que se trata como si se hubiera especificado una lista con los nombres de todos los repositorios generados por la extensión como el valor.

reproducible bool; el valor predeterminado es False
Indica que esta extensión del módulo garantiza una reproducibilidad completa, por lo que no se debe almacenar en el archivo de bloqueo.

extract

None module_ctx.extract(archive, output='', strip_prefix='', *, rename_files={}, watch_archive='auto')

Extrae un archivo en el directorio del repositorio.

Parámetros

Parámetro Descripción
archive cadena, Label o ruta de acceso; obligatorio
ruta de acceso al archivo que se descomprimirá, relativa al directorio del repositorio.
output cadena, Label o ruta de acceso; el valor predeterminado es ''
ruta de acceso al directorio en el que se descomprimirá el archivo, relativa al directorio del repositorio.
strip_prefix string; El valor predeterminado es ''
Prefijo de directorio que se quitará de los archivos extraídos. Muchos archivos contienen un directorio de nivel superior que incluye todos los archivos del archivo. En lugar de tener que especificar este prefijo una y otra vez en build_file, este campo se puede usar para quitarlo de los archivos extraídos.

Para la compatibilidad, este parámetro también se puede usar con el nombre obsoleto stripPrefix.

rename_files dict; El valor predeterminado es {}
Es un diccionario opcional que especifica los archivos a los que se les cambiará el nombre durante la extracción. Las entradas del archivo con nombres que coincidan exactamente con una clave se cambiarán al valor antes de cualquier ajuste del prefijo del directorio. Se puede usar para extraer archivos que contienen nombres de archivo no Unicode o que tienen archivos que se extraerían en la misma ruta de acceso en sistemas de archivos que no distinguen mayúsculas de minúsculas.
watch_archive string; El valor predeterminado es 'auto'
Indica si se debe observar el archivo. Puede ser la cadena "yes", "no" o "auto". Si se pasa "yes", es equivalente a invocar de inmediato el método watch(). Si se pasa "no", no se intenta observar el archivo. Si se pasa "auto", solo se intentará observar el archivo cuando sea legal hacerlo (consulta la documentación de watch() para obtener más información).

archivo

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

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

Parámetros

Parámetro Descripción
path cadena, Label o ruta de acceso; obligatorio
Ruta de acceso del archivo que se creará, relativa al directorio del repositorio.
content cadena; el valor predeterminado es ''
Es el contenido del archivo que se creará, vacío de forma predeterminada.
executable bool; el valor predeterminado es True
Establece la marca de ejecución en el archivo creado. El valor predeterminado es verdadero.
legacy_utf8 bool; El valor predeterminado es False
No se realiza ninguna operación. Este parámetro está obsoleto y se quitará en una versión futura de Bazel.

getenv

string module_ctx.getenv(name, default=None)

Devuelve el valor de una variable de entorno name como una cadena si existe, o default si no existe.

Cuando se compila de forma incremental, cualquier cambio en el valor de la variable denominada por name hará que se vuelva a recuperar este repositorio.

Parámetros

Parámetro Descripción
name cadena; obligatorio
Nombre de la variable de entorno deseada.
default cadena o None; El valor predeterminado es None
Valor predeterminado que se devolverá si no se encuentra name.
Puede devolver None.

is_dev_dependency

bool module_ctx.is_dev_dependency(tag)

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

Parámetros

Parámetro Descripción
tag bazel_module_tag; required
Es una etiqueta obtenida de bazel_module.tags.

modules

list module_ctx.modules

Es una lista de todos los módulos de Bazel en el gráfico de dependencias externas que usan esta extensión de módulo. Cada uno de ellos es un objeto bazel_module que expone todas las etiquetas que especificó para esta extensión. Se garantiza que el orden de iteración de este diccionario es el mismo que el de la búsqueda en amplitud que comienza desde el módulo raíz.

os

repository_os module_ctx.os

Es una estructura para acceder a la información del sistema.

ruta de acceso

path module_ctx.path(path)

Devuelve una ruta de acceso a partir de una cadena, una etiqueta o una ruta de acceso. Si la ruta de acceso 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 de destino (la etiqueta debe apuntar a un archivo no generado). Si la ruta de acceso es una ruta, la devolverá tal cual.

Parámetros

Parámetro Descripción
path cadena, etiqueta o ruta de acceso; obligatorio
string, Label o path desde el cual se creará una ruta de acceso.

read

string module_ctx.read(path, *, watch='auto')

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

Parámetros

Parámetro Descripción
path cadena, Label o ruta de acceso obligatorio
Ruta de acceso del archivo desde el que se leerá.
watch string; El valor predeterminado es 'auto'
Indica si se debe observar el archivo. Puede ser la cadena "yes", "no" o "auto". Si se pasa "yes", es equivalente a invocar de inmediato el método watch(). Si se pasa "no", no se intenta observar el archivo. Si se pasa "auto", solo se intentará observar el archivo cuando sea legal hacerlo (consulta la documentación de watch() para obtener más información).

report_progress

None module_ctx.report_progress(status='')

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

Parámetros

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

root_module_has_non_dev_dependency

bool module_ctx.root_module_has_non_dev_dependency

Indica si el módulo raíz usa esta extensión como una dependencia que no es de desarrollo.

reloj

None module_ctx.watch(path)

Indica a Bazel que supervise los cambios en la ruta de acceso determinada, independientemente de si existe o no, o de si es un archivo o un directorio. Cualquier cambio en el archivo o directorio invalidará esta extensión del repositorio o del módulo, y hará que se vuelva a recuperar o evaluar la próxima vez.

Los "cambios" incluyen los cambios en el contenido del archivo (si la ruta es un archivo), si la ruta era un archivo, pero ahora es un directorio, o viceversa, y si la ruta comienza o deja de existir. En particular, no incluye cambios en ningún archivo del directorio si la ruta es un directorio. Para ello, usa path.readdir().

Ten en cuenta que intentar observar rutas dentro del repo que se está recuperando o dentro del directorio de trabajo de la extensión del módulo actual generará un error. Una extensión de módulo que intente observar una ruta fuera del espacio de trabajo actual de Bazel también generará un error.

Parámetros

Parámetro Descripción
path cadena, Label o ruta; obligatorio
Ruta del archivo que se supervisará.

cuál

path module_ctx.which(program)

Devuelve el path del programa correspondiente o None si no hay tal programa en la ruta de acceso.

Parámetros

Parámetro Descripción
program string; obligatorio
Programa que se debe buscar en la ruta de acceso.
Puede devolver None.