module_ctx

模块扩展程序的上下文，其中包含辅助函数以及有关依赖项图中相关标记的信息。创建模块扩展时，您会获得一个 module_ctx 对象，该对象将用作 implementation 函数的实参。

成员

下载

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

将文件下载到所提供网址的输出路径，并返回一个结构体，其中包含 success（如果下载成功，则为 true）和文件的哈希（如果成功，则包含 sha256 和 integrity 字段）。

参数

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

download_and_extract

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

将文件下载到所提供网址的输出路径，对其进行解压缩，然后返回一个结构体，其中包含 success（如果下载成功，则为 true）标志，以及文件的哈希（如果成功，则包含 sha256 和 integrity 字段）。

参数

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

execute

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

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

参数

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

extension_metadata

extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None)

构造一个不透明对象，可从模块扩展程序的实现函数返回，以向 Bazel 提供有关扩展程序生成的代码库的元数据。

参数

参数 说明
root_module_direct_deps sequence of strings; or string; or None; default = None
扩展程序认为是根模块的直接依赖项的代码库的名称。如果根模块导入了其他代码库，或者未通过 use_repo 导入所有这些代码库，则 Bazel 会在评估扩展程序时输出警告和修复命令。

如果指定了 root_module_direct_deps 和 root_module_direct_dev_deps 之一，则必须同时指定另一个。这两个参数指定的列表必须互不相交。

root_module_direct_deps 和 root_module_direct_dev_deps 中只有一个可以设置为特殊值 "all"，该值会被视为指定了由扩展程序生成的所有代码库名称的列表。

root_module_direct_dev_deps sequence of strings; or string; or None； 默认值为 None
扩展程序视为根模块的直接开发依赖项的代码库的名称。如果根模块通过使用 use_extension(..., dev_dependency = True) 创建的扩展程序代理上的 use_repo 导入其他代码库，或者未导入所有这些代码库，则在评估扩展程序时，Bazel 会输出警告和修复命令。

如果指定了 root_module_direct_deps 和 root_module_direct_dev_deps 之一，则必须同时指定另一个。这两个参数指定的列表必须互不相交。

root_module_direct_deps 和 root_module_direct_dev_deps 中只有一个可以设置为特殊值 "all"，该值会被视为指定了由扩展程序生成的所有代码库名称的列表。

文件

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

在代码库目录中使用所提供的内容生成文件。

参数

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

is_dev_dependency

bool module_ctx.is_dev_dependency(tag)

返回使用 devDependency = True 调用 use_extension 的结果中是否指定了给定标记。

参数

参数 说明
tag bazel_module_tag； 必需
从 bazel_module.tags 获取的标记。

is_isolated

bool module_ctx.is_isolated

扩展程序的这种特定用法是否已指定 isolate = True，因此与所有其他用法隔离。

模块

list module_ctx.modules

外部依赖关系图中使用此模块扩展程序的所有 Bazel 模块的列表，每个模块都是一个 bazel_module 对象，用于公开它为此扩展程序指定的所有标记。该字典的迭代顺序必定与从根模块开始的广度优先搜索相同。

os

repository_os module_ctx.os

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

路径

path module_ctx.path(path)

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

参数

参数 说明
path string; or Label; or path； 必需
要根据其创建路径的字符串、标签或路径

read

string module_ctx.read(path)

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

参数

参数 说明
path string; or Label; or path； 必需
要从中读取的文件的路径。

report_progress

None module_ctx.report_progress(status='')

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

参数

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

root_module_has_non_dev_dependency

bool module_ctx.root_module_has_non_dev_dependency

根模块是否将此扩展用作非开发依赖项。

哪个

path module_ctx.which(program)

返回相应程序的路径，如果路径中没有此类程序，则返回 None。

参数

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