默认信息

报告问题 查看来源 Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

一种提供有关目标直接文件和传递文件的一般信息的提供程序。每种规则类型都有此提供程序，即使规则的实现函数未明确返回此提供程序也是如此。每个 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
一个 depset 的 File 对象，表示在 Bazel 命令行中指定此目标时要构建的默认输出。默认值为所有预先声明的输出。
runfiles runfiles；或 None； 默认值为 None
runfiles 描述符，用于描述相应目标在运行时（通过 run 命令或作为工具依赖项）所需的文件。
data_runfiles runfiles；或 None； 默认值为 None

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

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

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

runfiles 描述符，用于描述此目标在通过除 data 属性以外的任何属性作为依赖项运行时所需的 runfiles。
executable 文件；或 None； 默认值为 None
如果相应规则标记为 executable 或 test，则这是一个 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。

files_to_run

FilesToRunProvider DefaultInfo.files_to_run

一个 FilesToRunProvider 对象，包含有关目标可执行文件和 runfile 的信息。 可能会返回 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_indent(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)。