代码库 ctx

报告问题 查看源代码

包含辅助函数和属性相关信息的代码库规则的上下文。创建仓库规则时，您需要获得仓库_ctx 对象作为 implementation 函数的参数。

成员

属性

struct repository_ctx.attr

用于访问属性值的结构体。值由用户提供（如果未提供，则使用默认值）。

删除

bool repository_ctx.delete(path)

删除文件或目录。返回一个布尔值，指示此调用是否实际删除了文件或目录。

参数

参数 说明
path string；或 path； required
要删除的文件的路径（相对于代码库目录或绝对路径）。可以是路径或字符串。

下载

struct repository_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')

将文件下载到所提供网址的输出路径，并返回一个包含 success 的结构体。如果下载成功完成，该标志为 true；如果下载成功，则会返回一个包含 sha256 和 integrity 字段的文件哈希值。

参数

参数 说明
url string；或 string 的 Iterable；必需
引用同一文件的镜像网址列表。
output string；Label；或 path；默认为输出文件的 ''
路径（相对于代码库目录）。
sha256 默认值为 ''
所下载文件的预期 SHA-256 哈希。此哈希值必须与所下载文件的 SHA-256 哈希值一致。省略 SHA-256 会带来安全风险，因为远程文件可能会发生变化。省略此字段最好会导致您的 build 变得非封闭。为了简化开发，您可以视需要进行设置，但应在发布前进行设置。
executable 默认值为 False
请在创建的文件上设置可执行标志，默认值为 false。
allow_fail 默认值为 False
如果设置此字段，请在返回值中指明错误，而不是在下载失败时引发错误
canonical_id 默认值为 ''
如果设置此字段，则缓存命中数会限制为文件以相同规范 ID 添加到缓存的情况
auth 默认值为 {}
可选字典，用于指定部分网址的身份验证信息。
integrity 默认值为 ''
预计所下载文件的校验和（子资源完整性格式）。必须与所下载文件的校验和一致。由于远程文件可能会更改，因此省略校验和会带来安全风险。省略此字段最好会导致您的 build 变得非封闭。为了简化开发，您可以视需要进行设置，但应在发布前进行设置。

download_and_extract

struct repository_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})

将文件下载到所提供网址的输出路径，并提取该文件，然后返回一个包含 success 的结构体。如果下载成功完成，该标志为 true；如果下载成功，则会返回一个包含 sha256 和 integrity 字段的文件哈希值。

参数

参数 说明
url string；或 string 的 Iterable；必需
引用同一文件的镜像网址列表。
output string；Label；或 path；默认为将解压缩到的目录的 ''
路径（相对于代码库目录）。
sha256 默认值为 ''
所下载文件的预期 SHA-256 哈希。此哈希值必须与所下载文件的 SHA-256 哈希值一致。省略 SHA-256 会带来安全风险，因为远程文件可能会发生变化。省略此字段最好会导致您的 build 变得非封闭。为了简化开发，您可以视需要进行设置，但应在发布前进行设置。如果提供了存储区缓存，系统会首先检查是否存在具有给定哈希的文件；仅当未在缓存中找到该文件时，系统才会尝试下载。下载成功后，系统会将该文件添加到缓存中。
type 默认为 ''
已下载文件的归档类型。默认情况下，归档类型根据网址的文件扩展名确定。如果文件没有扩展名，您可以明确指定“zip”“jar”“war”“aar”“tar”“tar.gz”“tgz”“tar.xz”“txz”“.tar.zst”“.tzst”“tar.bz2”或“.tbz”
stripPrefix 默认为 ''
是从解压缩的文件中删除的目录前缀。 许多归档都包含一个顶级目录，其中包含归档中的所有文件。您可以使用此字段从提取的文件中删除此前缀，而无需在 build_file 中反复指定此前缀。
allow_fail 默认值为 False
如果设置此字段，请在返回值中指明错误，而不是在下载失败时引发错误
canonical_id 默认值为 ''
如果设置此字段，则缓存命中数会限制为文件以相同规范 ID 添加到缓存的情况
auth 默认值为 {}
可选字典，用于指定部分网址的身份验证信息。
integrity 默认值为 ''
预计所下载文件的校验和（子资源完整性格式）。必须与所下载文件的校验和一致。由于远程文件可能会更改，因此省略校验和会带来安全风险。省略此字段最好会导致您的 build 变得非封闭。为了简化开发，您可以视需要进行设置，但应在发布前进行设置。
rename_files 默认值为 {}
可选字典，用于指定在提取过程中要重命名的文件。在对目录前缀进行任何调整之前，系统会将名称完全匹配某个键的归档条目重命名为该值。此 API 可用于提取包含非 Unicode 文件名的归档，或提取到不区分大小写的文件系统中同一路径的文件。

execute

exec_result repository_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")

执行由参数列表指定的命令。该命令的执行时间受 timeout 限制（以秒为单位，默认为 600 秒）。此方法会返回包含命令输出的 exec_result 结构。environment 映射可用于替换某些要传递给进程的环境变量。

参数

参数 说明
arguments required
参数列表，第一个元素应该是要执行的程序的路径。
timeout 默认为 600
命令的最大时长（以秒为单位，默认值为 600 秒）。
environment 默认值为 {}
强制设置将某些环境变量传递给进程。
quiet 默认值为 True
如果应输出 stdout 和 stderr 到终端。
working_directory 默认为 ""
用于执行命令的工作目录。 可以是代码库根目录的相对路径，也可以是绝对路径。

extract

None repository_ctx.extract(archive, output='', stripPrefix='', *, rename_files={})

将归档文件解压缩到代码库目录。

参数

参数 说明
archive string；Label；或 path； required
将解压缩的归档文件的路径（相对于代码库目录）。
output string；Label；或 path；默认为将解压缩到的目录的 ''
路径（相对于代码库目录）。
stripPrefix 默认为 ''
是从解压缩的文件中删除的目录前缀。 许多归档都包含一个顶级目录，其中包含归档中的所有文件。您可以使用此字段从提取的文件中删除此前缀，而无需在 build_file 中反复指定此前缀。
rename_files 默认值为 {}
可选字典，用于指定在提取过程中要重命名的文件。在对目录前缀进行任何调整之前，系统会将名称完全匹配某个键的归档条目重命名为该值。此 API 可用于提取包含非 Unicode 文件名的归档，或提取到不区分大小写的文件系统中同一路径的文件。

文件

None repository_ctx.file(path, content='', executable=True, legacy_utf8=True)

在代码库目录中生成一个包含提供的内容的文件。

参数

参数 说明
path string；Label；或 path；指定要创建的文件的
路径（相对于代码库目录）。
content 默认为 ''
要创建的文件的内容，默认为为空。
executable 默认值为 True
请在创建的文件上设置可执行标志，默认值为 true。
legacy_utf8 默认为 True
将文件内容编码为 UTF-8，默认为 true。未来的版本将更改默认值并移除此参数。

name

string repository_ctx.name

此规则创建的外部代码库的名称。

os

repository_os repository_ctx.os

用于访问系统中信息的结构体。

patch

None repository_ctx.patch(patch_file, strip=0)

将补丁文件应用于外部代码库的根目录。补丁文件应该是标准的统一差异格式文件。Bazel 原生补丁实现不支持模糊匹配和二进制补丁（如补丁命令行工具）。

参数

参数 说明
patch_file string；Label；或 path； required
要应用的补丁文件，可以是标签、相对路径或绝对路径。如果是相对路径，则会解析为代码库目录。
strip 默认为 0
从文件名中删除指定数量的前导组件。

path

path repository_ctx.path(path)

返回字符串、标签或路径中的路径。如果路径是相对路径，则将相对于代码库目录进行解析。如果路径是标签，则将解析为相应文件的路径。请注意，远程仓库在分析阶段执行，因此不能依赖于目标结果（标签应指向非生成的文件）。如果路径是路径，则将按原样返回该路径。

参数

参数 说明
path string；Label；或 path； required
根据其创建路径的字符串、标签或路径

阅读

string repository_ctx.read(path)

读取文件系统中文件的内容。

参数

参数 说明
path string；Label；或 path； required
要读取的文件的路径。

report_progress

None repository_ctx.report_progress(status='')

更新提取此代码库或模块扩展程序的进度状态

参数

参数 说明
status string；默认值为 ''
字符串，描述提取进度的当前状态 

None repository_ctx.symlink(target, link_name)

在文件系统上创建符号链接。

参数

参数 说明
target string；Label；或 path； required
符号链接应指向的路径。
string；Label；或 path； required
要创建的符号链接的路径（相对于代码库目录）。

模板

None repository_ctx.template(path, template, substitutions={}, executable=True)

使用 template 生成新文件。substitutions 的键每次出现在 template 中时，都会替换为相应的值。结果采用 path 编写。可通过设置可选的 executable 参数（默认为 true）来开启或关闭可执行位。

参数

参数 说明
path string；Label；或 path；指定要创建的文件的
路径（相对于代码库目录）。
template string；Label；或 path； required
路径。
substitutions 默认为 {}
展开模板时的替代变量。
executable 默认值为 True
请在创建的文件上设置可执行标志，默认值为 true。

哪个

path repository_ctx.which(program)

返回相应程序的路径；如果路径中不存在此程序，则返回 None。

参数

参数 说明
program 必需
要在路径中找到的程序。
可能会返回 None。

workspace_root

path repository_ctx.workspace_root

指向 bazel 调用的根工作区的路径。