默认信息

报告问题 查看源代码 每夜 build · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

提供有关目标的直接文件和传递文件的一般信息的提供程序。每种规则类型都有此提供程序，即使规则的实现函数未明确返回此提供程序也是如此。每个 DefaultInfo 实例都包含以下字段：

  • files
  • files_to_run
  • data_runfiles
  • default_runfiles
如需有关如何使用此提供程序的详细指南，请参阅规则页面。

成员

DefaultInfo

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

DefaultInfo 构造函数。

参数

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

建议您避免使用此参数（请参阅“应避免使用 runfile 功能”）

runfiles 描述符，用于描述当此目标通过 data 属性作为依赖项时需要运行的 runfiles。
default_runfiles runfiles；或 None；默认值为 None

建议您避免使用此参数（请参阅“应避免使用 runfile 功能”）

runfiles 描述符，用于描述当此目标通过 data 属性以外的任何属性作为依赖项时需要运行的 runfiles。
executable 文件；或 None； 默认值为 None
如果此规则标记为 executable 或 test，则此值为 File 对象，表示应执行的文件以运行目标。默认情况下，它是预声明的输出 ctx.outputs.executable。

data_runfiles

runfiles DefaultInfo.data_runfiles

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

default_runfiles

runfiles DefaultInfo.default_runfiles

runfiles 描述符，用于描述此目标在运行时所需的文件（通过 run 命令或作为工具依赖项提供）。 可能会返回 None。

文件

depset DefaultInfo.files

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

files_to_run

FilesToRunProvider DefaultInfo.files_to_run

FilesToRunProvider 对象，包含目标的可执行文件和 runfile 的相关信息。 可以返回 None。

to_json

string DefaultInfo.to_json()

已弃用。此 API 已废弃，很快就会被移除。请勿依赖此功能。此选项已通过 ---incompatible_struct_has_no_methods 停用。使用此标志可验证您的代码是否与即将移除的 API 兼容。
从结构体参数创建 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_indent(x)，它们适用于结构体以外的值，并且不会污染结构体字段命名空间。

to_proto

string DefaultInfo.to_proto()

已弃用。此 API 已废弃，很快就会被移除。请勿依赖它。在 ---incompatible_struct_has_no_methods 中，此功能处于停用状态。使用此标志可验证您的代码是否与即将移除的 API 兼容。
根据结构体参数创建文本消息。只有当所有结构体元素（递归）均为字符串、整数、布尔值、其他结构体或字典或这些类型的列表时，此方法才有效。字符串中的引号和换行符会被转义。结构体键会按排序顺序迭代。示例：
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)。