utils 代码库规则

以下函数可以从 @bazel_tools//tools/build_defs/repo:utils.bzl 加载。

用于在提取后操控外部代码库的实用程序。

设置

这些实用程序旨在供其他代码库规则使用。可以通过以下方式加载它们：

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

不确定

maybe(repo_rule, name, kwargs)

此实用函数仅用于添加尚不存在的代码库。

这是为了实现 https://bazel.build/rules/deploying#dependencies 中载述的安全 repositories.bzl 宏。

参数

repo_rule 必填。

代码库规则函数。

name 必填。

要创建的代码库的名称。

kwargs 可选属性。

传递给 repo_rule 函数的剩余参数。

返回

Nothing 会根据需要定义仓库。

parse_netrc

parse_netrc(contents, filename)

用于解析至少一个基本 .netrc 文件的实用函数。

参数

contents 必填。

解析器的输入。

filename 可选属性。默认值为 None

文件名（如果有）。

返回

使用提供的相关信息将机器名称映射到字典

patch

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

实现修补已提取的代码库。

此规则旨在用于代码库规则的实现函数。如果未指定参数 patches、patch_tool、patch_args、patch_cmds 和 patch_cmds_win，则它们取自 ctx.attr。

参数

ctx 必填。

调用此实用函数的代码库规则的代码库上下文。
patches 可选属性。默认值为 None

要应用的补丁文件。字符串、标签或路径的列表。

patch_cmds 可选属性。默认值为 None

要运行修补的 Bash 命令，逐一向 bash -c 传递一个命令。字符串列表

patch_cmds_win 可选属性。默认值为 None

要运行修补的 Powershell 命令，一次向 Powershell /c 传递一个命令。字符串列表。如果此参数的布尔值为 false，系统将使用 patch_cmds 并忽略此参数。

patch_tool 可选属性。默认值为 None

为了应用补丁而要执行的补丁工具的路径。字符串。

patch_args 可选属性。默认值为 None

需要传递给补丁工具的参数。字符串列表。

auth 可选属性。默认值为 None

用于指定某些网址的身份验证信息的可选字典。

read_netrc

read_netrc(ctx, filename)

用于解析至少一个基本 .netrc 文件的实用函数。

参数

ctx 必填。

调用此实用函数的代码库规则的代码库上下文。
filename 必填。

要读取的 .netrc 文件的名称

返回

使用提供的相关信息将机器名称映射到字典

read_user_netrc

read_user_netrc(ctx)

读取用户的默认 netrc 文件。

参数

ctx 必填。

调用此实用函数的代码库规则的代码库上下文。

返回

dict，利用所提供的相关信息将机器名称映射到字典。

update_attrs

update_attrs(orig, keys, override)

用于更改指定属性并将其添加到特定代码库规则调用的实用函数。

这可让规则可重现。

参数

orig 必填。

记录（显式或隐式）通过特定规则调用实际设置的属性

keys 必填。

此规则中定义的完整属性集

override 必填。

要替换或添加到原始属性的字典

返回

包含插入/已更新替换项的键的属性字典

use_netrc

use_netrc(netrc, urls, patterns)

根据已解析的 netrc 文件和网址列表计算身份验证字典。

参数

netrc 必填。

已解析为字典的 netrc 文件（例如，从 read_netrc 中获取）

urls 必填。

网址列表。

patterns 必填。

授权格式网址的可选字典

返回

dict 适合作为 ctx.download 的 auth 参数；更确切地说，当 netrc 文件提供登录名和密码时，该 dict 会将所有网址映射到包含相应登录名、密码和可选授权格式以及“type”与“basic”或“pattern”的映射的 dict。

workspace_and_buildfile

workspace_and_buildfile(ctx)

用于写入 WORKSPACE 和 BUILD 文件（如果请求）的实用函数。

此规则旨在用于代码库规则的实现功能。它假定 ctx.attr 中存在参数 name、build_file、build_file_content、workspace_file 和 workspace_file_content；后四个参数可能具有 None 值。

参数

ctx 必填。

调用此实用函数的代码库规则的代码库上下文。