存储库规则的上下文，其中包含辅助函数和属性相关信息。创建代码库规则时，您会获得一个 repository_ctx 对象，该对象将用作 implementation 函数的参数。
成员
- attr
- delete
- download
- download_and_extract
- 执行
- 提取
- 文件
- 名称
- 操作系统
- 补丁
- path
- read
- report_progress
- symlink
- 模板
- workspace_root
attr
struct repository_ctx.attr
删除
bool repository_ctx.delete(path)
参数
| 参数 | 说明 |
|---|---|
path
|
字符串；或路径；
必需 要删除的文件的路径（相对于代码库目录）或绝对路径。可以是路径或字符串。 |
下载
struct repository_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')
success（如果下载成功，则为 true）和文件的哈希（如果成功，则包含 sha256 和 integrity 字段）。
参数
| 参数 | 说明 |
|---|---|
url
|
字符串；或字符串的可迭代对象；
必需 引用同一文件的镜像网址列表。 |
output
|
字符串；或标签；或路径；
默认为 ''输出文件的路径（相对于代码库目录）。 |
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
|
字符串；或字符串的可迭代对象；
必需 引用同一文件的镜像网址列表。 |
output
|
字符串；或标签；或路径；
默认值为 ''将要解压缩归档文件的目录的路径（相对于代码库目录）。 |
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”“.ar”或“.deb”。 |
stripPrefix
|
默认为 ''要从提取的文件中剥离的目录前缀。 许多归档都包含一个顶级目录，其中包含归档中的所有文件。您无需在 build_file 中反复指定此前缀，只需使用此字段即可从提取的文件中剥离此前缀。
|
allow_fail
|
默认值为 False如果设置此字段，请在返回值中指明错误，而不是在下载失败时引发错误 |
canonical_id
|
默认值为 ''如果设置此字段，则缓存命中数会限制为文件以相同规范 ID 添加到缓存的情况 |
auth
|
默认值为 {}一个可选字典，用于指定部分网址的身份验证信息。 |
integrity
|
默认为 ''下载的文件的预期校验和，采用子资源完整性格式。必须与所下载文件的校验和一致。由于远程文件可能会更改，因此省略校验和会带来安全风险。省略此字段的效果充其量是使 build 不具有密封性。此属性是可选的，可简化开发流程，但应在发布前进行设置。 |
rename_files
|
默认值为 {}可选字典，用于指定在提取过程中要重命名的文件。在调整任何目录前缀之前，名称与键完全匹配的归档条目将重命名为相应值。这可用于提取包含非 Unicode 文件名的归档文件，或提取的文件在不区分大小写的文件系统中会提取到相同路径的归档文件。 |
execute
exec_result repository_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")
timeout 限制（以秒为单位，默认 600 秒）。此方法会返回包含命令输出的 exec_result 结构。environment 映射可用于替换要传递给进程的一些环境变量。
参数
| 参数 | 说明 |
|---|---|
arguments
|
必需 实参列表，第一个元素应为要执行的程序的路径。 |
timeout
|
默认为 600命令的最大时长（以秒为单位，默认为 600 秒）。 |
environment
|
默认值为 {}强制设置将某些环境变量传递给进程。 |
quiet
|
默认值为 True确定是否应将标准输出和标准错误输出到终端。 |
working_directory
|
默认为 ""用于执行命令的工作目录。 可以是相对于代码库根目录的相对路径，也可以是绝对路径。 |
extract
None repository_ctx.extract(archive, output='', stripPrefix='', *, rename_files={})参数
| 参数 | 说明 |
|---|---|
archive
|
字符串；或标签；或路径；
必需 要解压缩的归档文件的路径（相对于代码库目录）。 |
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)参数
| 参数 | 说明 |
|---|---|
patch_file
|
字符串；或标签；或路径；
必需 要应用的补丁文件，可以是标签、相对路径或绝对路径。如果是相对路径，则会解析为代码库目录。 |
strip
|
默认值为 0从文件名中剥离指定数量的前导组件。 |
路径
path repository_ctx.path(path)
参数
| 参数 | 说明 |
|---|---|
path
|
字符串；或标签；或路径；
必需 用于创建路径的字符串、标签或路径 |
read
string repository_ctx.read(path)
参数
| 参数 | 说明 |
|---|---|
path
|
字符串；或标签；或路径；
必需 要从中读取的文件的路径。 |
report_progress
None repository_ctx.report_progress(status='')参数
| 参数 | 说明 |
|---|---|
status
|
字符串；
默认为 ''描述提取进度当前状态的字符串 |
符号链接
None repository_ctx.symlink(target, link_name)参数
| 参数 | 说明 |
|---|---|
target
|
string；Label；或 path；
required 符号链接应指向的路径。 |
link_name
|
string；Label；或 path；
required 要创建的符号链接的路径（相对于代码库目录）。 |
模板
None repository_ctx.template(path, template, substitutions={}, executable=True)template 生成新文件。substitutions 的键每次出现在 template 中时，都会替换为相应的值。结果会写入 path。可选的 executable 参数（默认为 true）可用于开启或关闭可执行位。
参数
| 参数 | 说明 |
|---|---|
path
|
字符串；或标签；或路径；
必需 要创建的文件相对于代码库目录的路径。 |
template
|
string；Label；或 path；
required 路径。 |
substitutions
|
默认值为 {}在展开模板时要进行的替换。 |
executable
|
默认值为 True请在创建的文件上设置可执行标志，默认值为 true。 |
哪个
path repository_ctx.which(program)
参数
| 参数 | 说明 |
|---|---|
program
|
必需 要在路径中查找的程序。 |
None。
workspace_root
path repository_ctx.workspace_root