MODULE.bazel 文件

报告问题 每夜 build · 8.2 · 8.1 · 8.0 · 7.6 · 7.5

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

成员

archive_override

None archive_override(module_name, **kwargs)

指定此依赖项应来自特定位置的归档文件（zip、gzip 等），而不是来自注册表。实际上，此依赖项将由 http_archive 规则提供支持。

此指令仅在根模块中生效；换句话说，如果某个模块被其他模块用作依赖项，系统会忽略该模块自己的替换项。

参数

参数 说明
module_name string; 必需
要应用此替换项的 Bazel 模块依赖项的名称。
kwargs 必需
所有其他参数都会转发到底层 http_archive 代码库规则。请注意，不应指定 name 属性；请改用 module_name。

bazel_dep

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

声明对其他 Bazel 模块的直接依赖项。

参数

参数 说明
name string; required
要添加为直接依赖项的模块的名称。
version string； 默认为 ''
要添加为直接依赖项的模块的版本。
max_compatibility_level int； 默认为 -1
要添加为直接依赖项的模块支持的 compatibility_level 上限。模块的版本暗示支持的最低 compatibility_level，以及如果未指定此属性则为最高 compatibility_level。
repo_name 字符串；或 None； 默认为 ''
表示此依赖项的外部代码库的名称。默认情况下，此值为模块的名称。可设置为 None，以将此依赖项设为“nodep”依赖项：在这种情况下，只有当目标模块通过其他方式已存在于依赖项图中时，才会遵循此 bazel_dep 规范。
dev_dependency bool； 默认为 False
如果为 true，当当前模块不是根模块或 --ignore_dev_dependency 处于启用状态时，系统会忽略此依赖项。

git_override

None git_override(module_name, **kwargs)

指定此依赖项应来自 Git 代码库中的某个提交，而不是来自注册库。实际上，此依赖项将由 git_repository 规则提供支持。

此指令仅在根模块中生效；换句话说，如果某个模块被其他模块用作依赖项，系统会忽略该模块自己的替换项。

参数

参数 说明
module_name string; 必需
要应用此替换项的 Bazel 模块依赖项的名称。
kwargs 必需
所有其他参数都会转发到底层 git_repository 代码库规则。请注意，不应指定 name 属性；请改用 module_name。

包含

None include(label)

包含其他类似 MODULE.bazel 文件的内容。实际上，include() 的行为就像包含的文件以文本形式放置在 include() 调用的位置一样，但变量绑定（例如用于 use_extension 的绑定）仅在其所在的文件中可见，而不是在任何包含的文件或包含文件中可见。

只有根模块可以使用 include()；如果 bazel_dep 的 MODULE 文件使用 include()，则会出错。

只能包含主代码库中的文件。

借助 include()，您可以将根模块文件划分为多个部分，以避免出现巨大的 MODULE.bazel 文件，或更好地管理对各个语义段的访问控制。

参数

参数 说明
label string； 必需
指向要包含的文件的标签。标签必须指向主代码库中的文件；换句话说，它必须以双斜杠 (//) 开头。文件名必须以 .MODULE.bazel 结尾，且不得以 . 开头。

inject_repo

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

将一个或多个新代码库注入给定的模块扩展。 如果当前模块不是根模块或 --ignore_dev_dependency 处于启用状态，则系统会忽略此参数。

请改用 override_repo 替换现有代码库。

参数

参数 说明
extension_proxy module_extension_proxy; 必需
use_extension 调用返回的模块扩展程序代理对象。
args 必需
当前模块可见的代码库，应以相同的名称注入到扩展程序中。
kwargs 必需
要注入到扩展程序中的新代码库，其中值是当前模块范围内代码库的名称，键是这些代码库在扩展程序中的显示名称。

您可以通过作为额外关键字参数传递的字面量字典指定非有效标识符键，例如：inject_repo(extension_proxy, **{"foo.2": "foo"})。

local_path_override

None local_path_override(module_name, path)

指定此依赖项应来自本地磁盘上的某个目录，而不是来自注册表。实际上，此依赖项将由 local_repository 规则提供支持。

此指令仅在根模块中生效；换句话说，如果某个模块被其他模块用作依赖项，系统会忽略该模块自己的替换项。

参数

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

module

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

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

此方法最多应调用一次，如果调用，则必须是 MODULE.bazel 文件中的第一个指令。只有当此模块是根模块（即不会被其他模块依赖）时，才能省略它。

参数

参数 说明
name string； 默认为 ''
模块的名称。只有当此模块是根模块（即不会被其他模块依赖）时，才能省略。有效的模块名称必须：1) 仅包含小写字母 (a-z)、数字 (0-9)、句点 (.)、连字符 (-) 和下划线 (_)；2) 以小写字母开头；3) 以小写字母或数字结尾。
version string； 默认为 ''
模块的版本。只有当此模块是根模块（即不会被其他模块依赖）时，才能省略。版本必须采用宽松的 SemVer 格式；如需了解详情，请参阅文档。
compatibility_level int； 默认为 0
模块的兼容性级别；每次引入不兼容的主要更改时，都应更改此值。从 SemVer 的角度来看，这实际上是模块的“主要版本”，只不过它不是嵌入在版本字符串本身中，而是作为单独的字段存在。具有不同兼容性级别的模块在版本解析中参与的方式与具有不同名称的模块相同，但最终的依赖项图不能包含多个名称相同但兼容性级别不同的模块（除非 multiple_version_override 生效）。如需了解详情，请参阅文档。
repo_name 字符串； 默认为 ''
表示此模块的代码库的名称（由模块本身看到）。默认情况下，代码库的名称与模块的名称相同。您可以指定此值，以便为一直使用与其模块名称不同的代码库名称的项目简化迁移。
bazel_compatibility 字符串的可迭代对象； 默认为 []
Bazel 版本列表，允许用户声明哪些 Bazel 版本与此模块兼容。这不会影响依赖项解析，但 bzlmod 会使用此信息来检查您当前的 Bazel 版本是否兼容。此值的格式为由英文逗号分隔的若干约束条件值组成的字符串。支持三种约束条件：<=X.X.X：Bazel 版本必须等于或低于 X.X.X。当较新版本中存在已知的不兼容更改时，使用此约束条件。>=X.X.X：Bazel 版本必须等于或高于 X.X.X。当您依赖于仅在 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 string; 必需
要应用此替换项的 Bazel 模块依赖项的名称。
versions 字符串的可迭代对象； 必需
明确指定允许共存的版本。这些版本必须已存在于依赖项图预选中。此模块的依赖项将“升级”到同一兼容性级别中允许的最近较高版本，而版本高于同一兼容性级别中允许的任何版本的依赖项将导致错误。
registry 字符串； 默认为 ''
替换此模块的注册表；应使用给定注册表，而不是从默认注册表列表中查找此模块。

override_repo

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

使用当前模块可见的给定代码库替换给定模块扩展程序定义的一个或多个代码库。如果当前模块不是根模块或已启用 `--ignore_dev_dependency`，则会忽略此值。

请改用 inject_repo 添加新的代码库。

参数

参数 说明
extension_proxy module_extension_proxy; 必需
use_extension 调用返回的模块扩展程序代理对象。
args 必需
扩展程序中应使用当前模块中同名代码库替换的代码库。
kwargs 必需
要应用于扩展程序生成的代码库的替换项，其中值是当前模块范围内的代码库的名称，键是它们将在扩展程序中替换的代码库的名称。

您可以通过作为额外关键字参数传递的字面量字典指定非有效标识符键，例如：override_repo(extension_proxy, **{"foo.2": "foo"})。

register_execution_platforms

None register_execution_platforms(dev_dependency=False, *platform_labels)

指定在选择此模块时要注册的已定义执行平台。应为绝对目标模式（即以 @ 或 // 开头）。如需了解详情，请参阅工具链解析。展开为多个目标（例如 :all）的模式将按名称的字典顺序注册。

参数

参数 说明
dev_dependency bool； 默认为 False
如果为 true，则如果当前模块不是根模块或启用了 `--ignore_dev_dependency`，系统将不会注册执行平台。
platform_labels 字符串的序列； 必需
要注册的目标模式。

register_toolchains

None register_toolchains(dev_dependency=False, *toolchain_labels)

指定在选择此模块时要注册的已定义工具链。应为绝对目标模式（即以 @ 或 // 开头）。如需了解详情，请参阅工具链解析。展开为多个目标（例如 :all）的模式将按目标名称（而非工具链实现的名称）按字典顺序注册。

参数

参数 说明
dev_dependency bool； 默认为 False
如果为 true，当当前模块不是根模块或启用了 `--ignore_dev_dependency` 时，系统不会注册工具链。
toolchain_labels 字符串的序列； 必需
要注册的目标模式。

single_version_override

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

指定依赖项应仍来自注册库，但其版本应固定，或其注册库应被替换，或应用补丁列表。此指令仅在根模块中生效；换句话说，如果某个模块被其他模块用作依赖项，则系统会忽略该模块自己的替换项。

参数

参数 说明
module_name string; 必需
要应用此替换项的 Bazel 模块依赖项的名称。
version string； 默认为 ''
替换依赖项图中声明的此模块的版本。也就是说，此模块将“固定”到此替换版本。如果只想替换注册表或补丁，则可以忽略此属性。
registry 字符串； 默认为 ''
替换此模块的注册表；应使用给定注册表，而不是从默认注册表列表中查找此模块。
patches 字符串的可迭代对象；默认为 []
指向要为此模块应用的补丁文件的标签列表。补丁文件必须存在于顶级项目的源代码树中。系统会按照列表顺序应用这些规则。

如果补丁对 MODULE.bazel 文件进行了更改，只有在根模块提供补丁文件时，这些更改才会生效。

patch_cmds 字符串的可迭代对象；默认为 []
在应用补丁后，要在 Linux/Macos 上应用的 Bash 命令序列。

对 MODULE.bazel 文件所做的更改将无效。

patch_strip int； 默认为 0
与 Unix 补丁的 --strip 参数相同。

use_extension

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

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

参数

参数 说明
extension_bzl_file string； 必需
定义模块扩展程序的 Starlark 文件的标签。
extension_name string； 必填
要使用的模块扩展程序的名称。Starlark 文件必须导出具有此名称的符号。
dev_dependency bool； 默认为 False
如果为 true，当当前模块不是根模块或启用了 `--ignore_dev_dependency` 时，系统会忽略模块扩展的此用法。
isolate bool； 默认值为 False
实验性。此参数目前处于实验阶段，随时可能发生变化。请勿依赖此功能。您可以通过设置 --experimental_isolated_extension_usages
以实验性方式启用此功能。如果为 true，则模块扩展程序的此用法将与此模块和其他模块中的所有其他用法隔离。为此用途创建的代码不会影响其他用途，并且扩展程序为此用途生成的代码库将与扩展程序生成的所有其他代码库区分开来。

此参数目前处于实验阶段，仅适用于标志 --experimental_isolated_extension_usages。

use_repo

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

将给定模块扩展程序生成的一个或多个代码库导入到当前模块的范围内。

参数

参数 说明
extension_proxy module_extension_proxy; 必需
use_extension 调用返回的模块扩展程序代理对象。
args 必填
要导入的代码库的名称。
kwargs 必需
指定要以其他名称导入当前模块范围内的特定代码库。键应为当前作用域中要使用的名称，而值应为模块扩展程序导出的原始名称。

您可以通过作为额外关键字参数传递的字面量字典指定非有效标识符键，例如：use_repo(extension_proxy, **{"foo.2": "foo"})。

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 string； 必需
定义代码库规则的 Starlark 文件的标签。
repo_rule_name string; 必填
要使用的代码库规则的名称。Starlark 文件必须导出具有此名称的符号。