DefaultInfo

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。
提供有关目标直接和传递文件的一般信息的提供商。即使规则的实现函数未明确返回,每个规则类型也都有此提供程序。每个 DefaultInfo 实例都包含以下字段:
  • files
  • files_to_run
  • data_runfiles
  • default_runfiles
请参阅规则页面,查看有关如何使用此提供程序的大量指南。

会员

默认信息

DefaultInfo DefaultInfo(files=None, runfiles=None, data_runfiles=None, default_runfiles=None, executable=None)

DefaultInfo 构造函数。

参数

参数 说明
files depset; or None;默认值为 None
File 对象的 depset,表示在 bazel 命令行上指定此目标时要构建的默认输出。默认情况下,它是所有预先声明的输出。
runfiles runfiles; or None;默认值为 None
runfiles 描述符,用于描述此目标在运行(通过 run 命令或作为工具依赖项)时需要的文件。
data_runfiles runfiles; or None;默认值为 None

建议您避免使用此参数(请参阅要避免的 runfiles 功能

runfiles 描述符,用于描述此目标需要通过 data 属性运行的运行时文件。
default_runfiles runfiles; or None;默认值为 None

建议您避免使用此参数(请参阅要避免的 runfiles 功能

runfiles 描述符,用于描述此目标通过 data 属性以外的任何其他属性运行的依赖项时需要运行的 runfile。
executable File; or None;默认值 = None
如果此规则标记为 executabletest,则这是一个 File 对象,表示应运行目标的文件。默认情况下,它是预声明的输出 ctx.outputs.executable

data_runfiles

runfiles DefaultInfo.data_runfiles

runfiles 描述符,用于描述此目标在 data 依赖项属性的情况下运行时需要的文件。在大多数情况下,请改用 default_runfiles 参数。如需了解详情,请参阅要避免的 runfiles 功能。 可能会返回 None

default_runfiles

runfiles DefaultInfo.default_runfiles

runfiles 描述符,用于描述此目标在运行(通过 run 命令或作为工具依赖项)时需要的文件。 可能会返回 None

文件

depset DefaultInfo.files

depset File 对象,表示在 bazel 命令行上指定此目标时要构建的默认输出。默认情况下,它是所有预先声明的输出。 可能会返回 None

运行文件

FilesToRunProvider DefaultInfo.files_to_run

这是一个 FilesToRunProvider 对象,其中包含有关目标的可执行文件和运行文件的信息。 可能会返回 None

to_json

string DefaultInfo.to_json()

已弃用。此 API 已弃用,很快就会被移除。请勿依赖它。已通过 ---incompatible_struct_has_no_methods 将其停用。使用此标志可以验证您的代码是否与其即将移除的代码兼容。
根据结构体参数创建 JSON 字符串。仅当所有结构体元素(递归)均为字符串、整数、布尔值、其他结构体、这些类型的列表或包含这些字符串字符串键和值的字典时,此方法才有效。字符串中的引号和新行会进行转义。示例:
struct(key=123).to_json()
# {"key":123}

struct(key=True).to_json()
# {"key":true}

struct(key=[1, 2, 3]).to_json()
# {"key":[1,2,3]}

struct(key='text').to_json()
# {"key":"text"}

struct(key=struct(inner_key='text')).to_json()
# {"key":{"inner_key":"text"}}

struct(key=[struct(inner_key=1), struct(inner_key=2)]).to_json()
# {"key":[{"inner_key":1},{"inner_key":2}]}

struct(key=struct(inner_key=struct(inner_inner_key='text'))).to_json()
# {"key":{"inner_key":{"inner_inner_key":"text"}}}

已弃用:请改用 json.encode(x) 或 json.encode_缩进(x),它们适用于结构体以外的值,并且不会污染结构体字段命名空间。

to_proto

string DefaultInfo.to_proto()

已弃用。此 API 已弃用,很快就会被移除。请勿依赖它。已通过 ---incompatible_struct_has_no_methods 将其停用。使用此标志可以验证您的代码是否与其即将移除的代码兼容。
根据结构体参数创建文本消息。仅当所有结构元素(递归)均为字符串、整数、布尔值、其他结构体、字典或这些类型的列表时,此方法才适用。字符串中的引号和新行会进行转义。结构体键会按排序顺序进行迭代。示例:
struct(key=123).to_proto()
# key: 123

struct(key=True).to_proto()
# key: true

struct(key=[1, 2, 3]).to_proto()
# key: 1
# key: 2
# key: 3

struct(key='text').to_proto()
# key: "text"

struct(key=struct(inner_key='text')).to_proto()
# key {
#   inner_key: "text"
# }

struct(key=[struct(inner_key=1), struct(inner_key=2)]).to_proto()
# key {
#   inner_key: 1
# }
# key {
#   inner_key: 2
# }

struct(key=struct(inner_key=struct(inner_inner_key='text'))).to_proto()
# key {
#    inner_key {
#     inner_inner_key: "text"
#   }
# }

struct(foo={4: 3, 2: 1}).to_proto()
# foo: {
#   key: 4
#   value: 3
# }
# foo: {
#   key: 2
#   value: 1
# }

已弃用:改用 proto.encode_text(x)。