config

回報問題 查看來源 Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

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

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

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

成員

bool

BuildSetting config.bool(flag=False)

布林型別的建構設定

參數

參數 說明
flag 預設值為 False
這個建構設定是否可在指令列上呼叫。

exec

ExecTransitionFactory config.exec(exec_group=None)

建立執行作業轉換。

參數

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

int

BuildSetting config.int(flag=False)

整數類型的建構設定

參數

參數 說明
flag 預設值為 False
這個建構設定是否可在指令列上呼叫。

字串

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

字串型別的建構設定

參數

參數 說明
flag 預設值為 False
這個建構設定是否可在指令列上呼叫。
allow_multiple 預設值為 False
已淘汰,請改用 string_list 設定和 repeatable = True。如果已設定,則允許在指令列上多次設定這個標記。在轉場效果和建構設定實作函式中存取的旗標值會是字串清單。系統會保留插入順序和重複值。如要採取不同做法,可以在建構設定實作函式中後續處理這份清單。

string_list

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

字串清單類型的建構設定。在指令列中,使用以半形逗號分隔的值傳遞清單,例如 --//my/setting=foo,bar

參數

參數 說明
flag 預設值為 False
這個建構設定是否可在指令列上呼叫。
repeatable 預設值為 False
如果設定此旗標,系統就不會預期以半形逗號分隔的值,而是允許在指令列上多次設定此旗標,並將每個值視為單一字串,加入清單值。系統會保留插入順序和重複值。如要採取不同做法,可以在建構設定實作函式中後續處理這份清單。