MODULE.bazel 文件中提供的方法。
成员
- archive_override
- bazel_dep
- git_override
- include
- inject_repo
- local_path_override
- 模块
- multiple_version_override
- override_repo
- register_execution_platforms
- register_toolchains
- single_version_override
- use_extension
- use_repo
- use_repo_rule
archive_override
None archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)参数
| 参数 | 说明 |
|---|---|
module_name
|
string；
必需 要应用此替换项的 Bazel 模块依赖项的名称。 |
urls
|
string;或 string 的 Iterable；
必需 归档的网址；可以是 http(s):// 或 file:// 网址。 |
integrity
|
字符串；
默认为 ''归档文件的预期校验和，采用子资源完整性格式。 |
strip_prefix
|
字符串；
默认为 ''要从提取的文件中剥离的目录前缀。 |
patches
|
字符串可迭代；
默认值为 []指向要应用于此模块的补丁文件的标签列表。补丁文件必须存在于顶级项目的源代码树中。它们按列表顺序应用。 |
patch_cmds
|
字符串的可迭代对象；默认为 []在应用补丁后在 Linux/Macos 上应用的 Bash 命令序列。 |
patch_strip
|
int;
默认值为 0与 Unix 补丁的 --strip 参数相同。 |
bazel_dep
None bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)参数
| 参数 | 说明 |
|---|---|
name
|
string;
required 要添加为直接依赖项的模块的名称。 |
version
|
string;
默认值为 ''要作为直接依赖项添加的模块的版本。 |
max_compatibility_level
|
int;
默认值为 -1支持将模块添加为直接依赖项的最大 compatibility_level。模块的版本暗含了支持的最低兼容性级别以及未指定此属性的最高级别。
|
repo_name
|
string；
默认值为 ''表示此依赖项的外部代码库的名称。默认情况下，这是模块的名称。 |
dev_dependency
|
bool；
默认为 False如果为 true，当当前模块不是根模块或启用了 `--ignore_dev_dependency` 时，系统会忽略此依赖项。 |
git_override
None git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0, init_submodules=False, strip_prefix='')参数
| 参数 | 说明 |
|---|---|
module_name
|
string;
必需 要应用此替换项的 Bazel 模块依赖项的名称。 |
remote
|
string;
必需 远程 Git 代码库的网址。 |
commit
|
string;
默认值为 ''应签出的提交。 |
patches
|
字符串的可迭代对象；默认为 []指向要为此模块应用的补丁文件的标签列表。补丁文件必须存在于顶级项目的源代码树中。系统会按照列表顺序应用这些规则。 |
patch_cmds
|
字符串可迭代；
默认值为 []应用补丁后，要应用于 Linux/Macos 的一系列 Bash 命令。 |
patch_strip
|
int;
默认值为 0与 Unix 补丁的 --strip 参数相同。 |
init_submodules
|
bool；
默认值为 False是否应递归初始化提取的代码库中的 git 子模块。 |
strip_prefix
|
string;
默认值为 ''要从提取的文件中删除的目录前缀。这可用于定位到 git 代码库的子目录。请注意，子目录必须具有自己的“MODULE.bazel”文件，其模块名称与传递到此“git_override”的“module_name”参数相同。 |
包含
None include(label)include() 的行为方式就像包含的文件以文本形式放置在 include() 调用的位置一样，只不过变量绑定（例如用于 use_extension 的绑定）仅在其所在的文件中可见，而不会显示在任何包含或包含的文件中。只有根模块可以使用 include()；如果 bazel_dep 的 MODULE 文件使用 include()，则会出错。
只能包含主代码库中的文件。
借助 include()，您可以将根模块文件划分为多个部分，以避免出现巨大的 MODULE.bazel 文件，或更好地管理对各个语义段的访问控制。
参数
| 参数 | 说明 |
|---|---|
label
|
string;
必需 指向要包含的文件的标签。标签必须指向主代码库中的文件；换句话说，它必须以双斜杠 ( //) 开头。
|
inject_repo
None inject_repo(extension_proxy, *args, **kwargs)请改用 override_repo 替换现有代码库。
参数
| 参数 | 说明 |
|---|---|
extension_proxy
|
module_extension_proxy;
必需use_extension 调用返回的模块扩展程序代理对象。
|
args
|
必需 对当前模块可见且应注入到 扩展程序。 |
kwargs
|
必需 要注入到扩展程序中的新代码库，其中值是当前模块范围内代码库的名称，键是这些代码库在扩展程序中的显示名称。 |
local_path_override
None local_path_override(module_name, path)参数
| 参数 | 说明 |
|---|---|
module_name
|
string;
必需 要应用此替换项的 Bazel 模块依赖项的名称。 |
path
|
string；
必需 此模块所在目录的路径。 |
module
None module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])最多只能调用一次它，如果调用，它必须是 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
|
string;
默认值为 ''覆盖此模块的注册表；应使用指定的注册表，而不是从默认的注册表列表中查找此模块。 |
override_repo
None override_repo(extension_proxy, *args, **kwargs)请改用 inject_repo 添加新的代码库。
参数
| 参数 | 说明 |
|---|---|
extension_proxy
|
module_extension_proxy;
必需use_extension 调用返回的模块扩展程序代理对象。
|
args
|
必需 扩展程序中应替换为 名称。 |
kwargs
|
必需 要应用于扩展程序生成的代码库的替换项，其中值是当前模块范围内的代码库的名称，键是它们将在扩展程序中替换的代码库的名称。 |
register_execution_platforms
None register_execution_platforms(dev_dependency=False, *platform_labels)@ 或 // 开头）。如需了解详情，请参阅工具链解析。可扩展为多个目标的模式（例如 :all）将按名称的字典顺序注册。
参数
| 参数 | 说明 |
|---|---|
dev_dependency
|
bool；
默认为 False如果为 true，则如果当前模块不是根模块或启用了 `--ignore_dev_dependency`，系统将不会注册执行平台。 |
platform_labels
|
string 的序列；
必需 要注册的目标模式。 |
register_toolchains
None register_toolchains(dev_dependency=False, *toolchain_labels)@ 或 // 开头）。如需了解详情，请参阅工具链解决方案。展开为多个目标的模式（例如 :all）将按目标名称（而非工具链实现的名称）按字典顺序注册。
参数
| 参数 | 说明 |
|---|---|
dev_dependency
|
bool；
默认为 False如果为 true，则如果当前模块不是根模块或启用了 `--ignore_dev_dependency`，系统将不会注册工具链。 |
toolchain_labels
|
string 的序列；
必需 要注册的目标模式。 |
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，则模块扩展程序的此用法将与此模块和其他模块中的所有其他用法隔离。为此用途创建的代码不会影响其他用途，并且扩展程序为此用途生成的代码库将与扩展程序生成的所有其他代码库区分开来。 此参数目前处于实验阶段，仅适用于标志 |
use_repo
None use_repo(extension_proxy, *args, **kwargs)参数
| 参数 | 说明 |
|---|---|
extension_proxy
|
module_extension_proxy;
必需use_extension 调用返回的模块扩展程序代理对象。
|
args
|
必填 要导入的代码库的名称。 |
kwargs
|
必需 指定要以其他名称导入到当前模块范围内的特定代码库。键应为当前作用域中要使用的名称，而值应为模块扩展程序导出的原始名称。 |
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 文件必须导出具有此名称的符号。 |