本页面介绍了如何创建代码库规则,并提供了 。
外部代码库是指仅允许使用的规则
(位于 WORKSPACE
文件中),并在加载阶段启用非封闭操作
Vertex AI SDK。每条外部代码库规则都会创建自己的工作区,及其
自己的 BUILD
文件和工件。它们可用于依赖于第三方
库(例如 Maven 打包库),还可以生成 BUILD
文件
运行 Bazel 的主机特有的
创建仓库规则
在 .bzl
文件中,使用
repository_rule 函数,用于创建新
并将其存储在全局变量中。
自定义代码库规则的使用方式与原生代码库规则相同。它
具有必需的 name
属性,并且其 build 文件中存在每个目标
可以称为 @<name>//package:target
,其中 <name>
是
name
属性。
系统会在您明确构建规则时加载规则,或者规则的依赖项
和构建。在这种情况下,Bazel 将执行其 implementation
函数。这个
函数描述了如何创建代码库及其内容和 BUILD
文件。
属性
属性是规则参数,例如 url
或 sha256
。您必须列出
属性及其类型。
local_repository = repository_rule(
implementation=_impl,
local=True,
attrs={"path": attr.string(mandatory=True)})
如需访问属性,请使用 repository_ctx.attr.<attribute_name>
。
所有 repository_rule
都具有隐式定义的属性(就像 build 一样)
规则)。两个隐式属性是 name
(就像构建规则一样)和
repo_mapping
。代码库规则的名称可通过
repository_ctx.name
。repo_mapping
的含义与
原生代码库规则
local_repository
和
new_local_repository
。
如果属性名称以 _
开头,则该属性为私有属性,用户无法设置。
实现函数
每条代码库规则都需要一个 implementation
函数。它包含
规则的实际逻辑,并严格在加载阶段执行。
该函数只有一个输入参数 repository_ctx
。函数
会返回 None
,这表示在给定给定条件的情况下,规则可重现。
或包含该规则的一组参数的字典
会将该规则变为可重现的规则,从而生成相同的代码库。对于
例如,对于跟踪 git 代码库的规则,这意味着
指定的提交标识符,而不是最初的浮动分支
。
输入参数 repository_ctx
可用于
访问属性值和非封闭函数(查找二进制文件、
执行二进制文件、在代码库中创建文件或下载文件
来自互联网)。如需了解详情,请参阅库
上下文。示例:
def _impl(repository_ctx):
repository_ctx.symlink(repository_ctx.attr.path, "")
local_repository = repository_rule(
implementation=_impl,
...)
何时执行实现函数?
如果代码库声明为 local
,则更改依赖项
中的依赖关系图(包括 WORKSPACE
文件本身)将
触发实现函数的执行。
实现函数可以重启(如果它的依赖项) 缺少请求。实现函数的开头 都将在依赖项解析后重新执行为避免 不必要的重启(成本高昂,因为网络访问 标签参数会被预提取,前提是 标签参数可解析为现有文件。请注意,解析 仅在执行期间构造的字符串或标签的路径 也仍可能导致重启。
最后,对于非 local
代码库,只有以下
依赖项可能会导致重启:
- 定义代码库规则所需的
.bzl
文件。 WORKSPACE
文件中的代码库规则声明。- 使用
environ
声明的任何环境变量的值 的repository_rule
函数。这些环境变量的值可以在 命令行中--action_env
标记(但此标记会使相应构建的每个操作失效)。 - 标签使用和引用的任何文件的内容(例如,
//mypkg:label.txt
,而非mypkg/label.txt
)。
强制重新提取外部代码库
有时,外部仓库可能已经过时,
定义或依赖项。例如,提取源代码的代码库
跟踪第三方代码库的特定分支,并且新提交会
该分支提供的所有资源这种情况下,您可以让 bazel 重新获取
外部代码库。bazel sync
此外,有些规则会检查本地机器,
如果本地计算机升级,则会过时。在这里,你可以让 bazel 完成以下操作:
则只会重新提取
repository_rule
设置了 configure
属性,请使用 bazel sync --configure
。
示例
C++ 自动配置的工具链: 它使用仓库规则自动创建 为 Bazel 创建 C++ 配置文件,方法是查找本地 C++ 编译器 环境和 C++ 编译器支持的标志。
Go 代码库 使用多个
repository_rule
定义依赖项列表 使用 Go 规则所需的步骤。rules_jvm_external 用于创建 默认名为
@maven
的外部代码库,用于生成构建目标 传递依赖项树中的每个 Maven 工件。