預設資訊

回報問題 查看來源 夜間 · 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
當這個目標在 bazel 指令列上指定時，代表要建構的預設輸出內容的 depset File 物件。預設值為所有預先宣告的輸出內容。
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 參數。詳情請參閱「應避免使用的 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 物件，其中包含目標的可執行檔和執行檔相關資訊。 可能會傳回 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)。