config

回報問題 查看原始碼 Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

這是用於建立設定轉換和建構設定描述符的頂層模組,可說明規則屬於哪種建構設定 (如有)。

例如:透過設定 rule() 函式的 build_setting 參數,將下列規則標示為建構設定。具體來說,這是 int 類型的建構設定,且為 flag,表示可透過指令列呼叫這項建構設定。

  my_rule = rule(
    implementation = _impl,
    build_setting = config.int(flag = True),
    ...
  )

成員

bool

BuildSetting config.bool(flag=False)

布林型建構設定

參數

參數 說明
flag bool; 預設為 False
。 是否可以在指令列上呼叫此建構設定。

exec

ExecTransitionFactory config.exec(exec_group=None)

建立執行轉換。

參數

參數 說明
exec_group 字串;或 None; 預設為 None
這個轉換作業會使用的執行平台所屬的執行群組名稱。如未提供,這個執行項目會使用目標的預設執行平台。

int

BuildSetting config.int(flag=False)

整數型建構設定

參數

參數 說明
flag bool; 預設為 False
。 是否可以在指令列上呼叫此建構設定。

transition config.none()

建立移除所有設定的轉場效果,並取消設定所有標記。適用於依附元件只有資料,且不含任何需要建構的程式碼,但建議只分析一次。

字串

BuildSetting config.string(flag=False, allow_multiple=False)

字串型建構設定

參數

參數 說明
flag bool; 預設為 False
。 是否可以在指令列上呼叫此建構設定。
allow_multiple bool;預設值為 False
。已淘汰,請改用 string_list 設定搭配 repeatable = True。如果已設定,則可在指令列上多次設定此標記。在轉換和建構設定實作函式中存取的旗標值,將是字串清單。同時保留廣告訂單和重複的值。如果需要其他行為,可以在建構設定實作函式中對這份清單進行後續處理。

string_list

BuildSetting config.string_list(flag=False, repeatable=False)

字串清單型態的建構設定。在指令列上傳遞清單,並使用 --//my/setting=foo,bar 等逗號分隔的值。

參數

參數 說明
flag bool; 預設為 False
。 是否可以在指令列上呼叫此建構設定。
repeatable bool;預設值為 False
。如果設定這個值,而不是預期使用半形逗號分隔值,可以在指令列上多次設定這個標記,並將每個個別值視為一個字串並新增至清單值。廣告訂單和重複值都會保留。如果需要其他行為,可以在建構設定實作函式中對這份清單進行後續處理。

目標

transition config.target()

建立目標轉場效果。這是無操作轉場效果,適用於需要轉場物件,但不想實際變更任何內容的情況。等同於 attr.label() 中的 cfg = "target"