implementation
函数的参数。
成员
- 下载
- download_and_extract
- execute
- extension_metadata
- 文件
- getenv
- is_dev_dependency
- 模块
- os
- 路径
- 阅读
- report_progress
- root_module_has_non_dev_dependency
- 手表
- 哪些
下载
unknown module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', block=True)将文件下载到所提供网址的输出路径,并返回一个包含
success
的结构体。如果下载成功完成,该标志为 true
;如果下载成功,则会返回一个包含 sha256
和 integrity
字段的文件哈希值。
参数
参数 | 说明 |
---|---|
url
|
string;或 string 的 Iterable;必需 引用同一文件的镜像网址列表。 |
output
|
string;Label;或 path;默认为输出文件的 '' 路径(相对于代码库目录)。 |
sha256
|
string;默认值为 '' 所下载文件的预期 SHA-256 哈希。此哈希值必须与所下载文件的 SHA-256 哈希值一致。省略 SHA-256 会带来安全风险,因为远程文件可能会发生变化。省略此字段最好会导致您的 build 变得非封闭。为了简化开发,您可以视需要进行设置,但应在发布前进行设置。 |
executable
|
bool;默认值为 False 在创建文件上设置可执行标志,默认值为 false。 |
allow_fail
|
bool;默认值为 False 如果设置此字段,请在返回值中指明错误,而不是在下载失败时引发错误 |
canonical_id
|
string;默认值为 '' 如果设置此字段,则缓存命中数将被限制为使用相同规范 ID 将文件添加到缓存的情况 |
auth
|
dict;默认值为 {} 可选 dict,用于指定部分网址的身份验证信息。 |
headers
|
dict;默认值为 {} 一个可选的 dict,用于为所有网址指定 http 标头。 |
integrity
|
字符串;默认值为 '' 预计所下载文件的校验和,采用子资源完整性格式。必须与所下载文件的校验和一致。由于远程文件可能会更改,因此省略校验和会带来安全风险。省略此字段最好会导致您的 build 变得非封闭。为了简化开发,您可以视需要进行设置,但应在发布前进行设置。 |
block
|
bool;默认值为 True 如果设置为 false,调用会立即返回,并且会返回一个包含单个方法(即 wait())的令牌,而不是常规返回值。该方法会在下载完成之前阻塞,并返回正常返回值或抛出异常。 |
download_and_extract
struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', rename_files={})将文件下载到所提供网址的输出路径,并提取该文件,然后返回一个包含
success
的结构体。如果下载成功完成,该标志为 true
;如果下载成功,则会返回一个包含 sha256
和 integrity
字段的文件哈希值。
参数
参数 | 说明 |
---|---|
url
|
string;或 string 的 Iterable;必需 引用同一文件的镜像网址列表。 |
output
|
string;Label;或 path;默认为将解压缩到的目录的 '' 路径(相对于代码库目录)。 |
sha256
|
string;默认值为 '' 所下载文件的预期 SHA-256 哈希。此哈希值必须与所下载文件的 SHA-256 哈希值一致。省略 SHA-256 会带来安全风险,因为远程文件可能会发生变化。省略此字段最好会导致您的 build 变得非封闭。为了简化开发,您可以视需要进行设置,但应在发布前进行设置。如果提供了存储区缓存,系统会首先检查是否存在具有给定哈希的文件;仅当未在缓存中找到该文件时,系统才会尝试下载。下载成功后,系统会将该文件添加到缓存中。 |
type
|
string;默认值为 '' 已下载文件的归档类型。默认情况下,归档类型根据网址的文件扩展名确定。如果文件没有扩展名,您可以明确指定“zip”“jar”“war”“aar”“tar”“tar.gz”“tgz”“tar.xz”“txz”“.tar.zst”“.tzst”“tar.bz2”或“.tbz” |
stripPrefix
|
string;默认值为 '' ,它是要从解压缩的文件中删除的目录前缀。 许多归档都包含一个顶级目录,其中包含归档中的所有文件。您可以使用此字段从提取的文件中删除此前缀,而无需在 build_file 中反复指定此前缀。
|
allow_fail
|
bool;默认值为 False 如果设置此字段,请在返回值中指明错误,而不是在下载失败时引发错误 |
canonical_id
|
string;默认值为 '' 如果设置此字段,则缓存命中数将被限制为使用相同规范 ID 将文件添加到缓存的情况 |
auth
|
dict;默认值为 {} 可选 dict,用于指定部分网址的身份验证信息。 |
headers
|
dict;默认值为 {} 一个可选的 dict,用于为所有网址指定 http 标头。 |
integrity
|
字符串;默认值为 '' 预计所下载文件的校验和,采用子资源完整性格式。必须与所下载文件的校验和一致。由于远程文件可能会更改,因此省略校验和会带来安全风险。省略此字段最好会导致您的 build 变得非封闭。为了简化开发,您可以视需要进行设置,但应在发布前进行设置。 |
rename_files
|
dict;默认值为 {} 可选的 dict,用于指定在提取过程中要重命名的文件。在对目录前缀进行任何调整之前,系统会将名称完全匹配某个键的归档条目重命名为该值。此 API 可用于提取包含非 Unicode 文件名的归档,或提取到不区分大小写的文件系统中同一路径的文件。 |
execute
exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")执行由参数列表指定的命令。该命令的执行时间受
timeout
限制(以秒为单位,默认为 600 秒)。此方法会返回包含命令输出的 exec_result
结构。environment
映射可用于替换某些要传递给进程的环境变量。
参数
参数 | 说明 |
---|---|
arguments
|
sequence;
required 参数列表,第一个元素应该是要执行的程序的路径。 |
timeout
|
int;默认为 600 命令的最大时长(以秒为单位,默认值为 600 秒)。 |
environment
|
dict;默认值为 {} 强制设置将某些环境变量传递给进程。 |
quiet
|
bool;默认值为 True 如果应输出 stdout 和 stderr 到终端。 |
working_directory
|
string;
默认为 "" 用于执行命令的工作目录。 可以是代码库根目录的相对路径,也可以是绝对路径。默认值为代码库根目录。 |
extension_metadata
extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None, reproducible=False)构建一个可从模块扩展程序的实现函数返回的不透明对象,以向 Bazel 提供扩展程序生成的代码库的相关元数据。
参数
参数 | 说明 |
---|---|
root_module_direct_deps
|
string;string;或 None ;默认值为 None 扩展程序视为根模块的直接依赖项的代码库的名称。如果根模块导入其他代码库,或者未通过 use_repo 导入所有这些代码库,则 Bazel 会在评估扩展程序时输出警告,指示用户运行 bazel mod tidy 以自动修复 use_repo 调用。此属性为 如果指定了
|
root_module_direct_dev_deps
|
string;string;或 None ;默认值为 None 扩展程序视为根模块的直接开发依赖项的代码库的名称。如果根模块导入其他代码库,或者未通过使用 use_extension(..., dev_dependency = True) 创建的扩展程序代理上的 use_repo 导入所有这些代码库,则 Bazel 会在评估扩展程序时输出警告,指示用户运行 bazel mod tidy 以自动修复 use_repo 调用。如果指定了
|
reproducible
|
bool;默认值为 False 声明此模块扩展可确保完全可重现,因此不应将其存储在锁定文件中。 |
文件
None
module_ctx.file(path, content='', executable=True, legacy_utf8=True)
在代码库目录中生成一个包含提供的内容的文件。
参数
参数 | 说明 |
---|---|
path
|
string;Label;或 path;指定要创建的文件的 路径(相对于代码库目录)。 |
content
|
string;默认值为 '' 要创建的文件的内容,默认情况下为空。 |
executable
|
bool;默认值为 True 在创建文件上设置可执行标志,默认值为 true。 |
legacy_utf8
|
bool;默认值为 True ,将文件内容编码为 UTF-8,默认值为 true。未来的版本将更改默认值并移除此参数。 |
getenv
string module_ctx.getenv(name, default=None)如果环境变量
name
存在,则返回字符串值;如果不存在,则返回 default
。增量构建时,对由 name
命名的变量的值所做的任何更改都会导致系统重新获取此代码库。
参数
参数 | 说明 |
---|---|
name
|
string;
required 所需环境变量的名称 |
default
|
string;或 None ;默认值为 None 找不到“name”时返回的默认值 |
None
。
is_dev_dependency
bool module_ctx.is_dev_dependency(tag)返回是否对通过
devDependency = True
调用 use_extension 的结果指定了指定的标记。
参数
参数 | 说明 |
---|---|
tag
|
bazel_module_tag;
required 从 bazel_module.tags 获取的标记。 |
模块
list module_ctx.modules外部依赖项图中使用此模块扩展程序的所有 Bazel 模块的列表,每个模块都是一个 bazel_module 对象,用于公开它为此扩展程序指定的所有标记。该字典的迭代顺序必定与从根模块开始的广度优先搜索相同。
os
repository_os module_ctx.os用于访问系统中信息的结构体。
path
path module_ctx.path(path)返回字符串、标签或路径中的路径。如果路径是相对路径,则将相对于代码库目录进行解析。如果路径是标签,则将解析为相应文件的路径。请注意,远程仓库在分析阶段执行,因此不能依赖于目标结果(标签应指向非生成的文件)。如果路径是路径,则将按原样返回该路径。
参数
参数 | 说明 |
---|---|
path
|
string;Label;或 path;
required 根据其创建路径的字符串、标签或路径 |
阅读
string module_ctx.read(path, *, watch='auto')读取文件系统中文件的内容。
参数
参数 | 说明 |
---|---|
path
|
string;Label;或 path;
required 要读取的文件的路径。 |
watch
|
string;
默认值为 'auto' 是否“监控”文件。可以是字符串“yes”、“no”或“auto”。传递“yes”等同于立即调用 watch() 方法;传递“no”不会尝试监视文件;传递“auto”只会在合法时尝试监视文件(如需了解详情,请参阅 watch() 文档)。
|
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根模块是否将此扩展用作非开发依赖项。
手表
None
module_ctx.watch(path)
指示 Bazel 监控对给定路径所做的更改,无论该路径是否存在,或者它是文件还是目录。对文件或目录所做的任何更改都将使此代码库或模块扩展程序失效,并导致系统下次重新提取或重新评估它。“更改”包括对文件内容的更改(如果路径是文件);如果路径是文件,但现在是目录,或者相反,路径开始或停止存在。请注意,如果路径是目录,则这不包括对该目录下的任何文件的更改。为此,请改用 path.readdir()
。
请注意,如果尝试监视当前正在提取的代码库内部或当前模块扩展程序的工作目录内部的路径,将会导致错误。模块扩展程序尝试监视当前 Bazel 工作区之外的路径也会导致错误。
参数
参数 | 说明 |
---|---|
path
|
string;Label;或 path;
required 要监控的文件的路径。 |
哪个
path module_ctx.which(program)返回相应程序的路径;如果路径中不存在此程序,则返回 None。
参数
参数 | 说明 |
---|---|
program
|
string;
required 要在路径中查找的程序。 |
None
。