MODULE.bazel 文件

报告问题

MODULE.bazel 文件中提供的方法。

成员

archive_override

None archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)

指定此依赖项应来自特定位置的归档文件（zip、gzip 等），而不是来自注册表。此指令仅在根模块中有效；换言之，如果某个模块被其他模块用作依赖项，该指令自己的替换项会被忽略。

参数

参数 说明
module_name required
要应用此替换的 Bazel 模块依赖项的名称。
urls string；或 string 的 Iterable；必需
归档文件的网址；可以是 http(s):// 或 file:// 网址。
integrity 默认值为 ''
归档文件的预期校验和（采用子资源完整性格式）。
strip_prefix 默认为 ''
要从解压缩的文件中删除的目录前缀。
patches 可迭代字符串；默认值为 []
指向要应用于此模块的补丁文件的标签列表。补丁文件必须存在于顶级项目的源代码树中。它们按列表顺序应用。
patch_cmds 可迭代字符串；默认值为 []
应用补丁后要应用于 Linux/Macos 的 Bash 命令序列。
patch_strip 默认值为 0
与 Unix 补丁的 --strip 参数相同。

bazel_dep

None bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)

声明对另一个 Bazel 模块的直接依赖项。

参数

参数 说明
name required
要作为直接依赖项添加的模块的名称。
version 默认为 ''
要作为直接依赖项添加的模块的版本。
max_compatibility_level 默认值为 -1
支持将模块添加为直接依赖项的最大 compatibility_level。模块的版本会隐含所支持的最低兼容性级别以及未指定此属性时的最高兼容性级别。
repo_name 默认值为 ''
表示此依赖项的外部代码库的名称。默认情况下，这是模块的名称。
dev_dependency 默认值为 False
如果为 true，如果当前模块不是根模块或已启用“--ignore_dev_dependency”，则此依赖项将被忽略。

git_override

None git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0)

指定依赖项应来自 Git 代码库的特定提交。此指令仅在根模块中有效；换言之，如果某个模块被其他模块用作依赖项，该指令自己的替换项会被忽略。

参数

参数 说明
module_name required
要应用此替换的 Bazel 模块依赖项的名称。
remote required
：远程 Git 代码库的网址。
commit 默认值为 ''
应签出的提交。
patches 可迭代字符串；默认值为 []
指向要应用于此模块的补丁文件的标签列表。补丁文件必须存在于顶级项目的源代码树中。它们按列表顺序应用。
patch_cmds 可迭代字符串；默认值为 []
应用补丁后要应用于 Linux/Macos 的 Bash 命令序列。
patch_strip 默认值为 0
与 Unix 补丁的 --strip 参数相同。

local_path_override

None local_path_override(module_name, path)

指定依赖项应来自本地磁盘上的特定目录。此指令仅在根模块中有效；换言之，如果某个模块被其他模块用作依赖项，该指令自己的替换项会被忽略。

参数

参数 说明
module_name required
要应用此替换的 Bazel 模块依赖项的名称。
path required
此模块所在目录的路径。

module

None module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])

声明当前 Bazel 代码库表示的 Bazel 模块的某些属性。这些属性要么是模块的基本元数据（例如名称和版本），要么会影响当前模块及其依赖项的行为。

最多只能调用一次。仅当此模块是根模块时（例如，不被其他模块依赖时），才能省略此属性。

参数

参数 说明
name 默认值为 ''
模块名称。仅当此模块是根模块（例如，不被其他模块依赖）时，才能省略。有效的模块名称必须满足以下条件：1) 只能包含小写字母 (a-z)、数字 (0-9)、点 (.)、连字符 (-) 和下划线 (_)；2) 以小写字母开头；3) 以小写字母或数字结尾。
version 默认值为 ''
模块的版本。仅当此模块是根模块（例如，不被其他模块依赖）时，才能省略。版本必须采用宽松的 SemVer 格式；请参阅文档了解详情。
compatibility_level 默认值为 0
模块的兼容性级别；每次引入不兼容的重大更改时，都应更改此级别。就 SemVer 而言，这本质上是模块的“主要版本”，只不过它并未嵌入版本字符串本身，而是作为单独的字段存在。具有不同兼容性级别的模块会参与版本解析，就像它们是具有不同名称的模块一样，但最终的依赖关系图不能包含名称相同但兼容性级别不同的多个模块（除非 multiple_version_override 有效）。如需了解详情，请参阅相关文档。
repo_name 默认值为 ''
表示此模块的代码库的名称，如模块本身所示。默认情况下，代码库的名称是模块的名称。如果项目一直使用与其模块名称不同的代码库名称，则可以指定此属性，以简化迁移过程。
bazel_compatibility 可迭代 string；默认值为 []
一个 Bazel 版本列表，可让用户声明哪些 Bazel 版本与此模块兼容。这不会影响依赖项解析，但 bzlmod 将使用此信息来检查当前的 Bazel 版本是否兼容。此值的格式为以英文逗号分隔的一些限制条件值的字符串。支持三个限制条件：<=X.X.X：Bazel 版本必须等于或低于 X.X.X。当较新版本中存在已知的不兼容更改时使用。>=X.X.X：Bazel 版本必须等于或高于 X.X.X.当 X.X.X 中存在破坏您的 bug 时使用，但在后续版本中已修复。

multiple_version_override

None multiple_version_override(module_name, versions, registry='')

指定某个依赖项仍应来自注册表，但允许其多个版本共存。如需了解详情，请参阅相关文档。此指令仅在根模块中有效；换言之，如果某个模块被其他模块用作依赖项，该指令自己的替换项会被忽略。

参数

参数 说明
module_name required
要应用此替换的 Bazel 模块依赖项的名称。
versions 字符串可迭代；必需
明确指定允许共存的版本。这些版本必须已存在于依赖关系图预选择中。此模块的依赖项将“升级”到具有相同兼容性级别且允许的最高版本，而如果依赖项的版本高于同一兼容性级别的任何允许版本，则会导致错误。
registry 默认值为 ''
替换此模块的注册表；应使用指定的注册表，而不是从默认的注册表列表中查找此模块。

register_execution_platforms

None register_execution_platforms(dev_dependency=False, *platform_labels)

指定选择此模块时要注册的已定义的执行平台。应为绝对目标模式（即以 @ 或 // 开头）。如需了解详情，请参阅工具链解析。

参数

参数 说明
dev_dependency 默认值为 False
如果为 true，如果当前模块不是根模块或已启用“--ignore_dev_dependency”，则执行平台将不会注册。
platform_labels string 的 sequence；必需
要注册的平台的标签。

register_toolchains

None register_toolchains(dev_dependency=False, *toolchain_labels)

指定要在选择此模块时注册的已定义工具链。应为绝对目标模式（即以 @ 或 // 开头）。如需了解详情，请参阅工具链解析。

参数

参数 说明
dev_dependency 默认值为 False
如果为 true，则当当前模块不是根模块或已启用“--ignore_dev_dependency”时，系统不会注册工具链。
toolchain_labels string 的 sequence；必需
要注册的工具链的标签。标签可以包含 :all，在这种情况下，软件包中提供工具链的所有目标都将按名称的字典顺序注册。

single_version_override

None single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)

指定依赖项仍应来自注册表，但应固定其版本、覆盖其注册表或应用的补丁列表。此指令仅在根模块中有效；换言之，如果某个模块被其他模块用作依赖项，该指令自己的替换项会被忽略。

参数

参数 说明
module_name required
要应用此替换的 Bazel 模块依赖项的名称。
version 默认值为 ''
替换依赖关系图中此模块的声明版本。换言之，此模块将“固定”到此替换版本。如果只覆盖注册表或补丁，则可以省略此属性。
registry 默认值为 ''
替换此模块的注册表；应使用指定的注册表，而不是从默认的注册表列表中查找此模块。
patches 可迭代字符串；默认值为 []
指向要应用于此模块的补丁文件的标签列表。补丁文件必须存在于顶级项目的源代码树中。它们按列表顺序应用。
patch_cmds 可迭代字符串；默认值为 []
应用补丁后要应用于 Linux/Macos 的 Bash 命令序列。
patch_strip 默认值为 0
与 Unix 补丁的 --strip 参数相同。

use_extension

module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)

返回一个代表模块扩展程序的代理对象；您可以调用其方法来创建模块扩展程序标记。

参数

参数 说明
extension_bzl_file required
Starlark 文件的标签，用于定义模块扩展名。
extension_name required
要使用的模块扩展的名称。Starlark 文件必须导出具有此名称的符号。
dev_dependency 默认值为 False
如果为 true，如果当前模块不是根模块或已启用“--ignore_dev_dependency”，系统会忽略这种模块扩展用法。
isolate 默认值为 False
实验性。此参数处于实验阶段，随时可能发生变化。请勿依赖它。可以通过设置 ---experimental_isolated_extension_usages
在实验性的基础上启用该功能。如果设置为 true，则模块扩展的这种用法将与此模块和其他模块中的所有其他用法隔离开来。针对此使用情况创建的标记不会影响其他使用情况，并且该扩展程序针对此使用情况生成的代码库将与该扩展程序生成的所有其他代码库不同。

此参数目前处于实验阶段，仅可通过标志 --experimental_isolated_extension_usages 使用。

use_repo

None use_repo(extension_proxy, *args, **kwargs)

将给定模块扩展程序生成的一个或多个代码库导入当前模块的作用域中。

参数

参数 说明
extension_proxy required
use_extension 调用返回的模块扩展代理对象。
args required
要导入的代码库的名称。
kwargs required
以不同的名称指定要导入到当前模块范围内的特定代码库。键应该是要在当前范围内使用的名称，而值应该是模块扩展程序导出的原始名称。

use_repo_rule

repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)

返回可在 MODULE.bazel 文件中作为代码库规则直接调用的代理值（一次或多次）。以这种方式创建的代码库只有当前模块使用代理上的 name 属性声明的名称下可见。隐式布尔值 dev_dependency 属性还可用于代理，以指明仅在当前模块为根模块时才会创建某个代码库。

参数

参数 说明
repo_rule_bzl_file required
Starlark 文件中的定义代码库规则的标签。
repo_rule_name required
要使用的代码库规则的名称。Starlark 文件必须导出具有此名称的符号。