預設資訊

提供目標直接和遞移檔案一般資訊的供應商。每個規則類型都有這個提供者,即使規則的實作函式未明確傳回這個提供者也一樣。每個 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; or None; default = None
File 物件的 depset,代表在 bazel 指令列上指定這個目標時要建構的預設輸出內容。根據預設,這會是所有預先宣告的輸出內容。
runfiles runfiles; or None; default = None
執行檔案描述元,用來說明執行時需要的檔案 (透過 run 指令或工具依附元件)。
data_runfiles runfiles; or None; default = None

建議您避免使用這個參數 (請參閱「避免使用檔案功能」一文)

檔案描述元,用於說明這個目標在透過 data 屬性為依附元件時必須執行的執行檔案。
default_runfiles runfiles; or None; default = None

建議您避免使用這個參數 (請參閱「避免使用檔案功能」一文)

檔案描述元,說明這個目標在透過 data 屬性以外的任何屬性做為依附元件時,必須執行的執行檔案。
executable File; or None; default = None
如果這項規則標示為 executabletest,則此為 File 物件,代表應執行目標的檔案。根據預設,此為預先宣告的輸出 ctx.outputs.executable

data_runfiles

runfiles DefaultInfo.data_runfiles

執行檔案描述元,說明在其為 data 依附元件屬性的情況下執行時,這個目標需要的檔案。在大多數情況下,請改用 default_runfiles 參數。詳情請參閱「應避免使用的檔案功能」。 可能會傳回 None

default_runfiles

runfiles DefaultInfo.default_runfiles

執行檔案描述元,透過 run 指令或工具依附元件執行時,說明這項目標需要的檔案。可能會傳回 None

檔案

depset DefaultInfo.files

File 物件的 depset,代表在 bazel 指令列上指定這個目標時要建構的預設輸出內容。根據預設,這會是所有預先宣告的輸出內容。可能會傳回 None

files_to_run

FilesToRunProvider DefaultInfo.files_to_run

FilesToRunProvider 物件,內含目標執行檔和執行檔案的相關資訊。可能會傳回 None

to_json

string DefaultInfo.to_json()

已淘汰,這個 API 已淘汰,並將在近期內移除。請勿依附於此項目。透過 ---incompatible_struct_has_no_methods 停用。使用此旗標來驗證您的程式碼是否與即將移除的程式碼相容。
從結構參數建立 JSON 字串。只有在所有 struct 元素 (遞迴) 為字串、 int、布林值、其他結構、這些型別清單,或是包含這些型別字串鍵和值的字典時,才能使用此方法。字串中的引號和換行符號會逸出。範例:
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),其適用於 struct 以外的值,且不會汙染結構欄位命名空間。

to_proto

string DefaultInfo.to_proto()

已淘汰,這個 API 已淘汰,並將在近期內移除。請勿依附於此項目。透過 ---incompatible_struct_has_no_methods 停用。使用此旗標來驗證您的程式碼是否與即將移除的程式碼相容。
可從結構參數建立文字訊息。只有當所有 struct 元素 (遞迴) 為字串、 int、布林值、其他結構體或字典或這些類型的清單時,這個方法才有效。字串中的引號和換行符號會逸出。結構鍵會按照排序順序疊代。範例:
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)。