utils 代码库规则

7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

提取后用于处理外部代码库的实用程序。

设置

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

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

get_auth

get_auth(ctx, urls)

用于从 .netrc 文件中为网址列表获取正确的 auth 字典的实用函数。

支持可选的 netrc 和 auth_patterns 属性(如果有)。

参数

ctx 必需。

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

urls 必需。

要读取的网址列表

返回

可传递给 repository_ctx.download 的 auth 字典

可能

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

文件名(如果有)。

返回

使用 dict 将机器名称映射到包含相应机器名称的 dict

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 必需。

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

返回

dict 用于将机器名称映射到包含相应机器名称的 dict。

update_attrs

update_attrs(orig, keys, override)

用于更改和向特定代码库规则调用添加指定属性的实用函数。

这用于使规则可重现。

参数

orig 必需。

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

keys 必需。

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

override 必需。

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

返回

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

use_netrc

use_netrc(netrc, urls, patterns)

根据解析的 netrc 文件和网址列表计算 auth 字典。

参数

netrc 必需。

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

urls 必填字段。

网址列表。

patterns 必填字段。

授权模式的网址(可选)

返回

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

workspace_and_buildfile

workspace_and_buildfile(ctx)

用于编写 WORKSPACE 和(如果需要)BUILD 文件的实用函数。

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

参数

ctx 必需。

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