Attr

7.3 · 7.2 · 7.1 · 7.0 · 6.5

這是頂層模組，用於定義規則或面向的屬性結構定義。每個函式都會傳回代表單一屬性架構的物件。這些物件會用做 rule() 和 aspect() 的 attrs 字典引數值。

如要進一步瞭解如何定義和使用屬性，請參閱「規則」頁面。

成員

bool

Attribute attr.bool(default=False, doc=None, mandatory=False)

為布林屬性建立結構定義。對應的 ctx.attr 屬性會是 bool 類型。

參數

參數 說明
default 預設值為 False
如果在例項化規則時未提供此屬性的值，則會使用預設值。
doc string 或 None； 預設為 None
。 說明屬性，可由說明文件產生工具擷取。
mandatory 預設為 False
如果為 true，則必須明確指定值 (即使有 default 也一樣)。

int

Attribute attr.int(default=0, doc=None, mandatory=False, values=[])

為整數屬性建立結構定義。這個值必須落在帶正負號的 32 位元範圍內。對應的 ctx.attr 屬性將為 int 類型。

參數

參數 說明
default 預設值為 0
如果在例項化規則時未提供此屬性的值，則會使用預設值。
doc string 或 None； 預設為 None
。 說明屬性，可由說明文件產生工具擷取。
mandatory 預設為 False
如果為 true，則必須明確指定值 (即使有 default 也一樣)。
values 序列 int；預設為 []
。 屬性可用的值清單。如果指定任何其他值，就會發生錯誤。

int_list

Attribute attr.int_list(mandatory=False, allow_empty=True, *, default=[], doc=None)

為整數清單屬性建立結構定義。每個元素都必須位於 32 位元簽署範圍內。

參數

參數 說明
mandatory 預設為 False
如果為 true，則必須明確指定值 (即使有 default 也一樣)。
allow_empty 預設為 True
如果屬性可為空白，則為 True。
default int 的 sequence；預設值為 []
如果在規則例項化時沒有指定此屬性的值，系統會使用預設值。
doc string; 或 None；預設為 None
可透過說明文件產生工具擷取的屬性說明。

標籤

Attribute attr.label(default=None, doc=None, executable=False, allow_files=None, allow_single_file=None, mandatory=False, providers=[], allow_rules=None, cfg=None, aspects=[])

建立標籤屬性的結構定義。這是依附元件屬性。

此屬性含有專屬的 Label 值。如果您提供字串來取代 Label，系統會使用標籤建構函式進行轉換。標籤路徑的相對部分 (包括可能已重新命名的存放區) 會根據已實例化的目標套件解析。

在分析時間 (規則的實作函式內)，從 ctx.attr 擷取屬性值時，標籤會替換為對應的 Target。這可讓您存取目前目標依附元件的提供者。

除了一般來源檔案外，這類屬性通常用於參照工具，例如編譯器。這類工具會視為依附元件，就像來源檔案一樣。為避免使用者每次在 BUILD 檔案中使用規則時，都必須指定工具的標籤，您可以將標準工具的標籤做為此屬性的 default 值進行硬式編碼。如果您也想防止使用者覆寫這個預設值，可以為屬性指定以底線開頭的名稱，將其設為私人。詳情請參閱「規則」頁面。

參數

參數 說明
default Label；或 字串；或 LateBoundDefault；或 NativeComputedDefault；或 函式；或 None； 預設值為 None
如果在例項化規則時未提供這個屬性的值，則會使用這個預設值。請使用字串或 Label 函式指定預設值，例如 attr.label(default = "//a:b")。
doc string 或 None； 預設為 None
。 說明屬性，可由說明文件產生工具擷取。
executable 預設為 False
如果依附元件必須可執行，則為 True。也就是說，標籤必須參照可執行檔案，或輸出可執行檔案的規則。使用 ctx.executable.<attribute_name> 存取標籤。
allow_files bool；或 字串的序列；或 None；預設為 None
。是否允許 File 目標。可以是 True、False (預設值)，或是允許的副檔名清單 (例如 [".cc", ".cpp"])。
allow_single_file 預設為 None
這與 allow_files 類似，但標籤必須對應至單一 File。透過 ctx.file.<attribute_name> 存取。
mandatory 預設為 False
如果為 true，則必須明確指定值 (即使有 default 也一樣)。
providers 預設值為 []
必須由此屬性中顯示的任何依附元件提供。

這個引數的格式為提供者清單的清單，也就是 provider() 傳回的 *Info 物件 (如果是舊版提供者，則為其字串名稱)。依附元件必須傳回至少一個內部清單中所提及的所有供應者。為了方便起見，這個引數也可以是單一層級的供應器清單，在這種情況下，系統會將其包裝在包含一個元素的外部清單中。依附元件的規則並不需要在其 provides 參數中宣告這些供應器，但這項做法被視為最佳做法。
allow_rules 字串的 sequence；或是 None；預設值為 None
允許使用哪些規則目標 (類別名稱)。這項功能已淘汰 (僅保留供相容性使用)，請改用供應工具。
cfg 預設值為 None
屬性的「設定」。可以是 "exec"，表示依附元件是為 execution platform 建構；或是 "target"，表示依附元件是為 target platform 建構。這兩者之間的差異，最常見的例子就是在建構行動應用程式時，target platform 是 Android 或 iOS，而 execution platform 則是 Linux、macOS 或 Windows。如果 executable 為 True，則必須使用這個參數，以免在目標設定中不小心建構主機工具。"target" 沒有語意效果，因此如果 executable 為 False，請勿設定 "target"，除非這有助於釐清您的意圖。
aspects Aspect 的序列；預設值為 []
。 應套用至此屬性指定的相依項目或相依項目的面向。

label_keyed_string_dict

Attribute attr.label_keyed_string_dict(allow_empty=True, *, default={}, doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])

為儲存字典的屬性建立結構定義，其中鍵為標籤，值為字串。這是依附元件屬性。

此屬性含有專屬的 Label 值。若提供字串來取代 Label，將會使用標籤建構函式轉換該字串。標籤路徑的相對部分 (包括可能已重新命名的存放區) 會根據已實例化的目標套件解析。

在分析時間 (規則的實作函式內)，從 ctx.attr 擷取屬性值時，標籤會替換為對應的 Target。這樣一來，您就能存取目前目標依附元件的供應工具。

參數

參數 說明
allow_empty 預設為 True
如果屬性可為空白，則為 True。
default 字典或函式；預設值為 {}
如果在例項化規則時未提供這個屬性的值，就會使用這個預設值。請使用字串或 Label 函式指定預設值，例如 attr.label_keyed_string_dict(default = {"//a:b": "value", "//a:c": "string"})。
doc string; 或 None；預設為 None
可透過說明文件產生工具擷取的屬性說明。
allow_files 字串的 bool; 或 sequence；預設為 None
是否允許 File 目標。None可以是 True、False (預設)，或是允許的副檔名清單 (例如 [".cc", ".cpp"])。
allow_rules 字串的序列；或 None；預設為 None
。 允許的規則目標 (類別名稱)。這項功能已淘汰 (僅保留供相容性使用)，請改用供應工具。
providers 預設為 []
此屬性中出現的任何依附元件必須提供的供應器。

這個引數的格式為提供者清單的清單，也就是 provider() 傳回的 *Info 物件 (如果是舊版提供者，則為其字串名稱)。依附元件必須傳回至少一個內部清單中所提及的所有供應者。為了方便起見，這項引數也可能是單一的提供者清單，在這種情況下，會納入具有一個元素的外部清單。但依附元件規則「不一定」會在 provides 參數中宣傳這些供應商，但這是最佳做法。
flags 字串的序列；預設為 []
。已淘汰，將會移除。
mandatory 預設為 False
如果為 true，則必須明確指定值 (即使有 default 也一樣)。
cfg 預設為 None
屬性的設定。可以是 "exec"，表示依附元件是為 execution platform 建構；或是 "target"，表示依附元件是為 target platform 建構。這兩者之間的差異，最常見的例子就是在建構行動應用程式時，target platform 是 Android 或 iOS，而 execution platform 則是 Linux、macOS 或 Windows。
aspects Aspect 的 sequence；預設為 []
應套用至這項屬性指定的依附元件或依附元件。

label_list

Attribute attr.label_list(allow_empty=True, *, default=[], doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])

為標籤清單屬性建立結構定義。這是依附元件屬性。對應的 ctx.attr 屬性將為 Target 的 清單類型。

此屬性含有專屬的 Label 值。如果您提供字串來取代 Label，系統會使用標籤建構函式進行轉換。標籤路徑的相對部分 (包括可能已重新命名的存放區) 會根據已實例化的目標套件解析。

在分析期間 (在規則的實作函式中)，從 ctx.attr 擷取屬性值時，標籤會由對應的 Target 取代。這樣一來，您就能存取目前目標依附元件的供應工具。

參數

參數 說明
allow_empty 預設為 True
如果屬性可為空白，則為 True。
default 標籤的 sequence；或函式；預設值為 []
。如果在規則例項化時沒有指定此屬性的值，則可使用預設值。使用字串或 Label 函式指定預設值，例如 attr.label_list(default = ["//a:b", "//a:c"])。
doc string; 或 None；預設為 None
可透過說明文件產生工具擷取的屬性說明。
allow_files bool；或 字串的序列；或 None；預設為 None
。是否允許 File 目標。可以是 True、False (預設)，或是允許的副檔名清單 (例如 [".cc", ".cpp"])。
allow_rules 字串的序列；或 None；預設為 None
。 允許的規則目標 (類別名稱)。這項功能已淘汰 (僅保留供相容性使用)，請改用供應工具。
providers 預設為 []
此屬性中出現的任何依附元件必須提供的供應器。

這個引數的格式為提供者清單的清單，也就是 provider() 傳回的 *Info 物件 (如果是舊版提供者，則為其字串名稱)。依附元件必須傳回至少一個內部清單中所提及的所有供應者。為了方便起見，這個引數也可以是單一層級的供應器清單，在這種情況下，系統會將其包裝在包含一個元素的外部清單中。依附元件的規則並不需要在其 provides 參數中宣告這些供應器，但這項做法被視為最佳做法。
flags 字串的序列；預設為 []
。已淘汰，將會移除。
mandatory 預設為 False
如果為 true，則必須明確指定值 (即使有 default 也一樣)。
cfg 預設為 None
屬性的設定。可以是 "exec"，表示依附元件是為 execution platform 建構；或是 "target"，表示依附元件是為 target platform 建構。常見差異範例是建構行動應用程式，其中 target platform 為 Android 或 iOS，而 execution platform 為 Linux、macOS 或 Windows。
aspects Aspect 的 sequence；預設為 []
應套用至這項屬性指定的依附元件或依附元件。

output

Attribute attr.output(doc=None, mandatory=False)

為輸出 (標籤) 屬性建立結構定義。

此屬性含有專屬的 Label 值。如果您提供字串來取代 Label，系統會使用標籤建構函式進行轉換。標籤路徑的相對部分 (包括 (可能重新命名) 的存放區) 已針對例項化目標的套件進行解析。

在分析期間，您可以使用 ctx.outputs 擷取對應的 File。

參數

參數 說明
doc string 或 None； 預設為 None
。 說明屬性，可由說明文件產生工具擷取。
mandatory 預設為 False
如果為 true，則必須明確指定值 (即使有 default 也一樣)。

output_list

Attribute attr.output_list(allow_empty=True, *, doc=None, mandatory=False)

為輸出項目清單屬性建立結構定義。

此屬性含有專屬的 Label 值。如果您提供字串來取代 Label，系統會使用標籤建構函式進行轉換。標籤路徑的相對部分 (包括可能已重新命名的存放區) 會根據已實例化的目標套件解析。

在分析期間，您可以使用 ctx.outputs 擷取對應的 File。

參數

參數 說明
allow_empty 預設值為 True
如果屬性可以留空，則傳回 True。
doc string 或 None； 預設為 None
。 說明屬性，可由說明文件產生工具擷取。
mandatory 預設值為 False
如果設為 true，就必須明確指定該值，即使該值具有 default 也一樣。

字串

Attribute attr.string(default='', doc=None, mandatory=False, values=[])

為 string 屬性建立結構定義。

參數

參數 說明
default 字串或原生計算預設值；預設值為 ''
。 如果在例項化規則時未提供此屬性的值，則會使用這個預設值。
doc string; 或 None；預設為 None
可透過說明文件產生工具擷取的屬性說明。
mandatory 預設值為 False
如果設為 true，就必須明確指定該值，即使該值具有 default 也一樣。
values 字串的序列； 預設為 []
。 屬性允許的值清單。如果提供任何其他值，系統就會擲回錯誤。

string_dict

Attribute attr.string_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)

為儲存字典的屬性建立結構定義，其中的鍵和值為字串。

參數

參數 說明
allow_empty 預設為 True
如果屬性可為空白，則為 True。
default 預設值為 {}
如果在例項化規則時未提供此屬性的值，則會使用預設值。
doc string 或 None； 預設為 None
。 說明屬性，可由說明文件產生工具擷取。
mandatory 預設為 False
如果為 true，則必須明確指定值 (即使有 default 也一樣)。

string_list

Attribute attr.string_list(mandatory=False, allow_empty=True, *, default=[], doc=None)

為字串清單屬性建立結構定義。

參數

參數 說明
mandatory 預設為 False
如果為 true，則必須明確指定值 (即使有 default 也一樣)。
allow_empty 預設為 True
如果屬性可為空白，則為 True。
default 字串的序列或 NativeComputedDefault；預設值為 []
。 如果在例項化規則時未提供此屬性的值，則會使用這個預設值。
doc string 或 None； 預設為 None
。 說明屬性，可由說明文件產生工具擷取。

string_list_dict

Attribute attr.string_list_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)

為保存字典的屬性建立結構定義，其中的鍵是字串，值是字串清單。

參數

參數 說明
allow_empty 預設為 True
如果屬性可為空白，則為 True。
default 預設值為 {}
如果沒有為這項屬性指定任何值，系統會使用預設值。
doc string 或 None； 預設為 None
。 說明屬性，可由說明文件產生工具擷取。
mandatory 預設為 False
如果為 true，則必須明確指定值 (即使有 default 也一樣)。