預設資訊

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

建議您不要使用這個參數 (請參閱「應避免的執行檔案功能」)

說明這個目標必須透過 data 屬性執行的依附元件時,必須執行的執行檔案描述元。
default_runfiles runfiles; or 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

depsetFile 物件,代表在 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(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 參數建立簡訊。只有在所有結構元素 (遞迴) 是字串、整數、布林值、其他結構體、字典或這些類型的清單時,才能使用此方法。字串中的引號和新行會逸出。結構鍵會依排序順序疊代。範例:
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)。