utils 代码库规则

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

maybe

maybe(repo_rule, name, kwargs)

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

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

参数

repo_rule 必需。

代码库规则函数。

name 必需。

要创建的代码库的名称。

kwargs 可选。

传递给 repo_rule 函数的其余实参。

parse_netrc

parse_netrc(contents, filename)

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

参数

contents 必需。

解析器的输入。

filename 可选。默认值为 None

要在错误消息中使用的文件名(如果有)。

patch

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

实现对已提取的代码库进行补丁。

此规则旨在用于代码库规则的实现函数中。如果未指定参数 patchespatch_toolpatch_argspatch_cmdspatch_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 必需。

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

update_attrs

update_attrs(orig, keys, override)

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

这用于使规则可重现。

参数

orig 必需。

由特定规则调用实际设置的属性(显式或隐式)的字典

keys 必需。

在此规则上定义的完整属性集

override 必需。

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

use_netrc

use_netrc(netrc, urls, patterns)

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

参数

netrc 必需。

已解析为字典的 netrc 文件,例如从 read_netrc 获取的文件

urls 必需。

网址列表。

patterns 必需。

网址到授权模式的可选字典

workspace_and_buildfile

workspace_and_buildfile(ctx)

实用函数,用于写入 WORKSPACE 文件,以及在需要时写入 BUILD 文件。

此规则旨在用于代码库规则的实现函数中。 它假定参数 namebuild_filebuild_file_contentworkspace_fileworkspace_file_content 存在于 ctx.attr 中;后四个参数的值可能为 None。

参数

ctx 必需。

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