預設資訊

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
執行檔案描述元，用於說明此目標執行時需要的檔案 (透過 run 指令或做為工具依附元件)。
data_runfiles runfiles 或 None；預設值為 None

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

檔案描述元，用於說明這個目標透過 data 屬性為依附元件時需要執行的執行檔案。
default_runfiles runfiles 或 None；預設值為 None

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

runfiles 描述項，說明這個目標在透過 data 屬性以外的任何屬性為依附元件時，需要執行的 runfiles。
executable 檔案或 None；預設為 None
。如果這個規則標示為 executable 或 test，則代表這是 File 物件，代表應執行的檔案，以便執行目標。根據預設，這是預先宣告的輸出 ctx.outputs.executable。

data_runfiles

runfiles DefaultInfo.data_runfiles

runfiles 描述元，說明在目標為 data 依附元件屬性時，執行時所需的檔案。在大多數情況下，請改用 default_runfiles 參數。詳情請參閱「要避免執行的檔案功能」。 可能會傳回 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 物件，內含目標的執行檔和執行檔案相關資訊。 可能會傳回 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)，這兩者適用於結構體以外的值，且不會污染結構體欄位命名空間。

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)。