這是用於建立設定轉換和建構設定描述符的頂層模組,可說明規則屬於哪種建構設定 (如有)。
例如:下列規則會設定 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"
。