Reglas del repositorio de utilidades

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

Las siguientes funciones se pueden cargar desde @bazel_tools//tools/build_defs/repo:utils.bzl.

Son utilidades para manipular repositorios externos una vez que se recuperan.

Configuración

Estas utilidades están diseñadas para que las usen otras reglas del repositorio. Se pueden cargar de la siguiente manera.

load(
    "@bazel_tools//tools/build_defs/repo:utils.bzl",
    "workspace_and_buildfile",
    "patch",
    "update_attrs",
)

download_remote_files

load("@bazel//tools/build_defs/repo:utils.bzl", "download_remote_files")

download_remote_files(ctx, auth)

Función de utilidad para descargar archivos remotos.

Esta regla está diseñada para usarse en la función de implementación de una regla de repositorio. Se supone que los parámetros remote_file_urls y remote_file_integrity están presentes en ctx.attr.

Parámetros

ctx ya no sea necesario.

Es el contexto del repositorio de la regla del repositorio que llama a esta función de utilidad.

auth Opcional. El valor predeterminado es None.

Es un diccionario opcional que especifica la información de autenticación para algunas de las URLs.

get_auth

load("@bazel//tools/build_defs/repo:utils.bzl", "get_auth")

get_auth(ctx, urls)

Función de utilidad para obtener el diccionario de autenticación correcto para una lista de URLs del archivo .netrc.

Admite los atributos opcionales netrc y auth_patterns si están disponibles.

Parámetros

ctx ya no sea necesario.

Es el contexto del repositorio de la regla del repositorio que llama a esta función de utilidad.

urls ya no sea necesario.

Es la lista de URLs que se leerán.

Muestra

Es el diccionario de autenticación que se puede pasar a repository_ctx.download.

tal vez

load("@bazel//tools/build_defs/repo:utils.bzl", "maybe")

maybe(repo_rule, name, **kwargs)

Función de utilidad para agregar un repositorio solo si aún no está presente.

Esto sirve para implementar la macro safe_repositories.bzl que se documenta en https://bazel.build/rules/deploying#dependencies.

Parámetros

repo_rule ya no sea necesario.

función de regla del repositorio.

name ya no sea necesario.

Nombre del repositorio que se creará.

kwargs Opcional.

Son los argumentos restantes que se pasan a la función repo_rule.

Muestra

Nada. Define el repositorio cuando es necesario como efecto secundario.

parse_netrc

load("@bazel//tools/build_defs/repo:utils.bzl", "parse_netrc")

parse_netrc(contents, filename)

Función de utilidad para analizar al menos un archivo .netrc básico.

Parámetros

contents ya no sea necesario.

entrada para el analizador.

filename Opcional. El valor predeterminado es "a .netrc file".

Nombre de archivo que se usará en los mensajes de error, si corresponde.

Muestra

Es un diccionario que asigna nombres de máquinas a un diccionario con la información proporcionada sobre ellas.

patch

load("@bazel//tools/build_defs/repo:utils.bzl", "patch")

patch(ctx, patches, patch_cmds, patch_cmds_win, patch_tool, patch_args, auth)

Implementación de la aplicación de parches a un repositorio ya extraído.

Esta regla está diseñada para usarse en la función de implementación de una regla de repositorio. Si no se especifican los parámetros patches, patch_tool, patch_args, patch_cmds y patch_cmds_win, se toman de ctx.attr.

Parámetros

ctx ya no sea necesario.

Es el contexto del repositorio de la regla del repositorio que llama a esta función de utilidad.

patches Opcional. El valor predeterminado es None.

Son los archivos de parche que se aplicarán. Lista de cadenas, etiquetas o rutas.

patch_cmds Opcional. El valor predeterminado es None.

Comandos de Bash para ejecutar parches, que se pasan de a uno a bash -c. Lista de strings

patch_cmds_win Opcional. El valor predeterminado es None.

Comandos de PowerShell que se ejecutan para aplicar parches, y se pasan uno a la vez a powershell /c. Es una lista de cadenas. Si el valor booleano de este parámetro es falso, se usará patch_cmds y se ignorará este parámetro.

patch_tool Opcional. El valor predeterminado es None.

Ruta de acceso a la herramienta de parches que se ejecutará para aplicar parches. String.

patch_args Opcional. El valor predeterminado es None.

Son los argumentos que se pasarán a la herramienta de parche. Es una lista de cadenas.

auth Opcional. El valor predeterminado es None.

Es un diccionario opcional que especifica la información de autenticación para algunas de las URLs.

read_netrc

load("@bazel//tools/build_defs/repo:utils.bzl", "read_netrc")

read_netrc(ctx, filename)

Función de utilidad para analizar al menos un archivo .netrc básico.

Parámetros

ctx ya no sea necesario.

Es el contexto del repositorio de la regla del repositorio que llama a esta función de utilidad.

filename ya no sea necesario.

Nombre del archivo .netrc que se leerá

Muestra

Es un diccionario que asigna nombres de máquinas a un diccionario con la información proporcionada sobre ellas.

read_user_netrc

load("@bazel//tools/build_defs/repo:utils.bzl", "read_user_netrc")

read_user_netrc(ctx)

Lee el archivo .netrc predeterminado del usuario.

Parámetros

ctx ya no sea necesario.

Es el contexto del repositorio de la regla del repositorio que llama a esta función de utilidad.

Muestra

Es un diccionario que asigna nombres de máquinas a un diccionario con la información proporcionada sobre ellas.

update_attrs

load("@bazel//tools/build_defs/repo:utils.bzl", "update_attrs")

update_attrs(orig, keys, override)

Es una función de utilidad para alterar y agregar los atributos especificados a una invocación de regla de repositorio en particular.

Se usa para que una regla sea reproducible.

Parámetros

orig ya no sea necesario.

Es un diccionario de atributos establecidos realmente (ya sea de forma explícita o implícita) por una invocación de regla en particular.

keys ya no sea necesario.

conjunto completo de atributos definidos en esta regla

override ya no sea necesario.

Es un diccionario de atributos para anular o agregar al original.

Muestra

Es un diccionario de atributos con las claves de la anulación insertadas o actualizadas.

use_netrc

load("@bazel//tools/build_defs/repo:utils.bzl", "use_netrc")

use_netrc(netrc, urls, patterns)

Calcula un diccionario de autenticación a partir de un archivo .netrc analizado y una lista de URLs.

Parámetros

netrc ya no sea necesario.

Un archivo .netrc ya analizado en un diccionario, p. ej., como se obtuvo de read_netrc

urls ya no sea necesario.

una lista de URLs.

patterns ya no sea necesario.

Diccionario opcional de URL a patrones de autorización

Muestra

Es un diccionario adecuado como argumento de autenticación para ctx.download; más precisamente, el diccionario asignará todas las URLs en las que el archivo .netrc proporciona el acceso y la contraseña a un diccionario que contiene el acceso, la contraseña y el patrón de autorización opcional correspondientes, así como la asignación de "type" a "basic" o "pattern".

workspace_and_buildfile

load("@bazel//tools/build_defs/repo:utils.bzl", "workspace_and_buildfile")

workspace_and_buildfile(ctx)

Función de utilidad para escribir un archivo BUILD.

Esta regla está diseñada para usarse en la función de implementación de una regla de repositorio. Se supone que los parámetros name, build_file y build_file_content están presentes en ctx.attr; los dos últimos posiblemente con el valor None.

Parámetros

ctx ya no sea necesario.

Es el contexto del repositorio de la regla del repositorio que llama a esta función de utilidad.