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
- extraer
- archivo
- getenv
- is_dev_dependency
- modules
- SO
- path
- leer
- report_progress
- root_module_has_non_dev_dependency
- reloj
- cuál
descarga
unknown module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', block=True)
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
. Cuando el usuario especifica sha256
o integrity
, se recomienda configurar un canonical_id
explícito. p.ej., get_default_canonical_id
Parámetros
Parámetro | Descripción |
---|---|
url
|
string; o iterable de string;
obligatorio Lista de URLs duplicadas que hacen referencia al mismo archivo. |
output
|
string; o Etiqueta; o path;
la configuración predeterminada es '' de salida al archivo de salida, en relación con el directorio del repositorio. |
sha256
|
string;
el valor predeterminado es '' 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é. |
executable
|
bool;
el valor predeterminado es False Establece la marca ejecutable en el archivo creado; es falso de forma predeterminada. |
allow_fail
|
bool;
el valor predeterminado es False 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
|
string;
el valor predeterminado es '' 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. De forma predeterminada, el almacenamiento en caché usa la suma de verificación ( sha256 o integrity ).
|
auth
|
dict;
el valor predeterminado es {} Un diccionario opcional que especifica la información de autenticación para algunas de las URL. |
headers
|
dict;
el valor predeterminado es {} Un diccionario opcional que especifica encabezados HTTP para todas las URL. |
integrity
|
string;
el valor predeterminado es '' 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. Si se proporciona, primero se verificará la caché del repositorio en busca de un archivo con la suma de comprobación determinada. 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é. |
block
|
bool;
el valor predeterminado es True Si se establece como false, la llamada muestra inmediatamente y, en lugar del valor normal que se muestra, muestra un token con un solo método, wait(), que se bloquea hasta que finaliza la descarga y muestra el valor de retorno habitual o arroja como de costumbre. |
download_and_extract
struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', rename_files={})
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
. Cuando el usuario especifica sha256
o integrity
, se recomienda configurar un canonical_id
explícito. p.ej., get_default_canonical_id
Parámetros
Parámetro | Descripción |
---|---|
url
|
string; o iterable de string;
obligatorio Lista de URLs duplicadas que hacen referencia al mismo archivo. |
output
|
string; o Etiqueta; o path;
la configuración predeterminada es '' La ruta de acceso al directorio donde se descomprimirá el archivo, en relación con el directorio del repositorio. |
sha256
|
string;
el valor predeterminado es '' 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
|
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 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”, “.tbz”, “.ar” o “.deb” aquí. |
stripPrefix
|
string;
el valor predeterminado es '' Un prefijo de directorio para quitar 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
|
bool;
el valor predeterminado es False 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
|
string;
el valor predeterminado es '' 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. De forma predeterminada, el almacenamiento en caché usa la suma de comprobación ( sha256 o integrity ).
|
auth
|
dict;
el valor predeterminado es {} Un diccionario opcional que especifica la información de autenticación para algunas de las URL. |
headers
|
dict;
el valor predeterminado es {} Un diccionario opcional que especifica encabezados HTTP para todas las URL. |
integrity
|
string;
el valor predeterminado es '' 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. Si se proporciona, primero se verificará la caché del repositorio en busca de un archivo con la suma de comprobación determinada. 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é. |
rename_files
|
dict;
el valor predeterminado es {} 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="")
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
|
secuencia;
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 de 600 segundos). |
environment
|
dict;
el valor predeterminado es {} Fuerza algunas variables de entorno para que se pasen al proceso. |
quiet
|
bool;
el valor predeterminado es True Si stdout y stderr se deben imprimir en la terminal, |
working_directory
|
string;
el valor predeterminado es "" Directorio de trabajo para la ejecución del comando. Puede ser absoluta o relativa a la raíz del repositorio. 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)
Parámetros
Parámetro | Descripción |
---|---|
root_module_direct_deps
|
secuencia de strings; o string; o None ;
la configuración predeterminada 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 a través de use_repo , Bazel imprimirá una advertencia cuando se evalúe la extensión y le indicará al usuario que ejecute bazel mod tidy para corregir automáticamente las llamadas a use_repo . Si aparece en Si se especifica Exactamente uno de los valores |
root_module_direct_dev_deps
|
secuencia de strings; o string; o None ;
la configuración predeterminada es None 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 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 y le indicará al usuario que ejecute bazel mod tidy para corregir automáticamente las llamadas a use_repo . Si se especifica Exactamente uno de los valores |
reproducible
|
bool;
el valor predeterminado es False Indica que la extensión de este 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='', stripPrefix='', *, rename_files={}, watch_archive='auto')
Parámetros
Parámetro | Descripción |
---|---|
archive
|
string; o Etiqueta; o path;
obligatorio ruta de acceso al archivo que se desempaquetará, en relación con el directorio del repositorio. |
output
|
string; o Etiqueta; o path;
la configuración predeterminada es '' la ruta de acceso al directorio donde se descomprimirá el archivo, en relación con el directorio del repositorio. |
stripPrefix
|
string;
el valor predeterminado es '' 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.
|
rename_files
|
dict;
el valor predeterminado es {} 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. |
watch_archive
|
string;
el valor predeterminado es 'auto' si quieres mirar el archivo. Puede ser "sí", "no" o "automático". Cómo pasar "sí" equivale a invocar inmediatamente el método watch() . pasar un “no” no intenta visualizar el archivo; pasando "auto" solo intentará mirar 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=True)
Parámetros
Parámetro | Descripción |
---|---|
path
|
string; o Etiqueta; o path;
obligatorio Ruta del archivo que se creará, en relación con el directorio del repositorio. |
content
|
string;
el valor predeterminado es '' El contenido del archivo que se creará, vacío de forma predeterminada. |
executable
|
bool;
el valor predeterminado es True Establece la marca ejecutable en el archivo creado; verdadero de forma predeterminada. |
legacy_utf8
|
bool;
el valor predeterminado es True Codifica el contenido del archivo en UTF-8, verdadero de forma predeterminada. Las versiones futuras cambiarán el valor predeterminado y quitarán este parámetro. |
getenv
string module_ctx.getenv(name, default=None)
name
como una cadena si existe o default
si no existe. Cuando compilas de forma incremental, cualquier cambio en el valor de la variable nombrada por name
hará que se vuelva a recuperar este repositorio.
Parámetros
Parámetro | Descripción |
---|---|
name
|
string;
obligatorio Nombre de la variable de entorno deseada. |
default
|
string; o None ;
el valor predeterminado es None Valor predeterminado que se muestra si no se encuentra name .
|
None
.
is_dev_dependency
bool module_ctx.is_dev_dependency(tag)
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
os
repository_os module_ctx.os
ruta de acceso
path module_ctx.path(path)
Parámetros
Parámetro | Descripción |
---|---|
path
|
string; o Etiqueta; o path;
obligatoriostring , Label o path a partir de los cuales se crea una ruta.
|
read
string module_ctx.read(path, *, watch='auto')
Parámetros
Parámetro | Descripción |
---|---|
path
|
string; o Etiqueta; o path;
obligatorio Es la ruta de acceso del archivo del que se leerá. |
watch
|
string;
el valor predeterminado es 'auto' Indica si se debe mirar el archivo. Puede ser "sí", "no" o "automático". Cómo pasar "sí" equivale a invocar inmediatamente el método watch() . pasar un “no” no intenta visualizar el archivo; pasando "auto" solo intentará mirar 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='')
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
reloj
None
module_ctx.watch(path)
“Cambios” incluir cambios en el contenido del archivo (si la ruta es un archivo); si la ruta de acceso fuera un archivo, pero ahora es un directorio o viceversa; y si la ruta comienza o deja de existir. En particular, esto no incluye cambios en los archivos del directorio si la ruta es un directorio. Para hacerlo, usa path.readdir()
.
Ten en cuenta que, si intentas observar las rutas de acceso dentro del repositorio que se está recuperando actualmente o dentro del directorio de trabajo de la extensión del módulo actual, se producirá 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
|
string; o Etiqueta; o path;
obligatorio Ruta de acceso del archivo que se debe supervisar. |
cuál
path module_ctx.which(program)
path
del programa correspondiente o None
si no existe ese programa en la ruta de acceso.
Parámetros
Parámetro | Descripción |
---|---|
program
|
string;
obligatorio Programa para encontrar en la ruta. |
None
.