Args

以節省記憶體的方式，封裝建構指令列部分或全部所需的資料。

動作經常需要大型指令列，其中包含從傳遞依附元件累積的值。舉例來說，連結器指令列可能會列出所有連結的程式庫所需的每個物件檔案。最佳做法是在 depset 中儲存這類傳遞資料，以便多個目標共用。不過，如果規則作者必須將這些 depset 轉換為字串清單，才能建構動作指令行，這就會破壞這項記憶體共用最佳化功能。

因此，除了字串之外，動作建構函式也接受 Args 物件。每個 Args 物件都代表字串和 depset 的串接，以及用於操作資料的選用轉換。Args 物件不會處理封裝的 depset，直到執行階段才會計算指令列。這有助於在分析階段完成後，再延遲執行任何耗用大量資源的複製作業。詳情請參閱「最佳化效能」頁面。

Args 是透過呼叫 ctx.actions.args() 建構。這些值可做為 ctx.actions.run() 或 ctx.actions.run_shell() 的 arguments 參數傳遞。Args 物件的每個變異會將值附加至最終指令列。

map_each 功能可讓您自訂項目轉換為字串的方式。如果您未提供 map_each 函式，標準轉換方式如下：

• 已是字串的值會維持原樣。
• File 物件會轉換為其 File.path 值。
• Label 物件會轉換為字串表示法，在主存放區的上下文中解析時，會解析回相同的物件。字串表示法會盡可能使用存放區的明顯名稱，而非存放區的正式名稱，因此這種表示法適合用於 BUILD 檔案。雖然無法保證具體的表示形式，但典型例子包括 //foo:bar、@repo//foo:bar 和 @@canonical_name~//foo:bar.bzl。
• 所有其他類型都會以未指定的方式轉換為字串。因此，請避免將非字串或 File 類型的值傳遞至 add()，如果您將這些值傳遞至 add_all() 或 add_joined()，則應提供 map_each 函式。

使用字串格式設定 (format、format_each 和 format_joined 參數的 add*() 方法) 時，系統會以與字串 % 替換相同的方式解讀格式範本，但範本必須有且僅有一個替換預留位置，且該預留位置必須為 %s。您可以使用 %% 逸出文字百分比。格式會在值轉換為字串後套用，如下所示。

每個 add*() 方法都有一個可接受額外位置參數的替代表單，也就是在其餘引數之前插入的「arg name」字串。如果序列為空白，add_all 和 add_joined 就不會新增額外字串。舉例來說，相同用法可將 --foo val1 val2 val3 --bar 或 --bar 新增至指令列，這取決於指定序列是否包含 val1..val3 或為空白。

如果指令列的大小會超過系統允許的最大大小，引數就會溢出至參數檔案。請參閱 use_param_file() 和 set_param_file_format()。

範例：假設我們想要產生以下指令列：

--foo foo1.txt foo2.txt ... fooN.txt --bar bar1.txt,bar2.txt,...,barM.txt --baz

# foo_deps and bar_deps are depsets containing
# File objects for the foo and bar .txt files.
args = ctx.actions.args()
args.add_all("--foo", foo_deps)
args.add_joined("--bar", bar_deps, join_with=",")
args.add("--baz")
ctx.actions.run(
  ...
  arguments = [args],
  ...
)

成員

• 新增
• add_all
• add_joined
• set_param_file_format
• use_param_file

add

Args Args.add(arg_name_or_value, value=unbound, *, format=None)

參數

add_all

Args Args.add_all(arg_name_or_values, values=unbound, *, map_each=None, format_each=None, before_each=None, omit_if_empty=True, uniquify=False, expand_directories=True, terminate_with=None, allow_closure=False)

大部分的處理作業會在要附加的引數清單上進行，如下列步驟所示：

1. 每個目錄 File 項目都會由該目錄中遞迴包含的所有 File 取代。
2. 如果提供 map_each，系統會將其套用至每個項目，並將產生的字串清單串連起來，形成初始引數清單。否則，初始引數清單是將標準轉換套用至每個項目的結果。
3. 清單中的每個引數都會以 format_each 格式化 (如有)。
4. 如果 uniquify 為 true，系統會移除重複的引數。系統會保留第一個出現的值。
5. 如果提供 before_each 字串，系統會將其插入清單中每個現有引數之前，做為新的引數。這實際上會將此處要附加的引數數量加倍。
6. 除了清單為空白且 omit_if_empty 為 true (預設值) 的情況外，如果有指定引數名稱和 terminate_with，系統會分別將這些引數插入為第一個和最後一個引數。

參數

add_joined

Args Args.add_joined(arg_name_or_values, values=unbound, *, join_with, map_each=None, format_each=None, format_joined=None, omit_if_empty=True, uniquify=False, expand_directories=True, allow_closure=False)

處理方式與 add_all() 類似，但從 values 衍生的引數清單會合併為單一引數，就像是透過 join_with.join(...) 一樣，然後使用指定的 format_joined 字串範本格式化。與 add_all() 不同，此函式沒有 before_each 或 terminate_with 參數，因為在將項目合併為單一引數時，這些參數通常不實用。

如果篩選後沒有字串可彙整為引數，且 omit_if_empty 為 true (預設值)，則不會進行任何處理。否則，如果沒有要彙整的字串，但 omit_if_empty 為 false，彙整的字串會是空字串。

參數

set_param_file_format

Args Args.set_param_file_format(format)

參數

use_param_file

Args Args.use_param_file(param_file_arg, *, use_always=False)

為提高效率，Bazel 可能會選擇在執行期間略過將參數檔案寫入輸出樹狀結構的動作。如果您正在偵錯動作，並想檢查 param 檔案，請將 --materialize_param_files 傳遞至建構項目。

參數