.bzl 檔案

回報問題 Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

所有 .bzl 檔案都提供全域方法。

成員

analysis_test_transition

transition analysis_test_transition(settings)

建立要套用至分析測試規則依附元件的設定轉換。這個轉場效果只能套用至含有 analysis_test = True 的規則屬性。這類規則的功能受限 (例如,依附元件樹狀結構的大小受限),因此使用此函式建立的轉場,潛在範圍會比使用 transition() 建立的轉場受限。

這項功能主要用來促進分析測試架構核心程式庫。如需最佳做法,請參閱說明文件 (或實作方式)。

參數

參數 說明
settings dict;必要
包含配置設定相關資訊的字典,此設定轉換應指定這些設定。鍵是建構設定標籤,值則是新的轉換後值。所有其他設定則維持不變。用於宣告分析測試必須設定的特定設定,才能通過測試。

切面

Aspect aspect(implementation, attr_aspects=[], toolchains_aspects=[], attrs={}, required_providers=[], required_aspect_providers=[], provides=[], requires=[], fragments=[], host_fragments=[], toolchains=[], incompatible_use_toolchain_transition=False, doc=None, *, apply_to_generating_rules=False, exec_compatible_with=[], exec_groups=None, subrules=[])

建立新的面向。此函式的結果必須儲存在全域值中。詳情請參閱「Aspects」簡介

參數

參數 說明
implementation function; 必要
Starlark 函式,用於實作此面向,其中有兩個參數:Target (要套用面向的目標) 和 ctx (建立目標的規則背景)。目標屬性可透過 ctx.rule 欄位使用。這個函式會在分析階段評估,每次將某個面向套用至目標時都會評估。
attr_aspects 字串序列;預設為 []
。屬性名稱清單。此面向會沿著目標屬性中指定的依附元件 (使用這些名稱) 傳播。常見的值包括 depsexports。清單也可以包含單一字串 "*",以便沿著目標的所有依附元件傳播。
toolchains_aspects sequence;預設為 []
。工具鍊類型的清單。切面會套用至符合這些工具鍊類型的目標工具鍊。
attrs dict; 預設為 {}
宣告各個面向的所有屬性的字典。它會將屬性名稱對應至屬性物件,例如 attr.labelattr.string (請參閱 attr 模組)。切面屬性可做為 ctx 參數欄位的實作函式使用。

_ 開頭的隱含屬性必須具有預設值,且型別為 labellabel_list

明確屬性必須是 string 類型,且必須使用 values 限制。明確的屬性會限制相片,僅可與具有相同名稱、類型和有效值的規則一起使用。

宣告的屬性會將 None 轉換為預設值。

required_providers sequence;預設為 []
。 這個屬性可讓切面限制其傳播範圍,只限於規則宣傳其必要供應器的目標。這個值必須是清單,且只能包含個別供應商或供應商清單,不能同時包含兩者。舉例來說,[[FooInfo], [BarInfo], [BazInfo, QuxInfo]] 是有效值,而 [FooInfo, BarInfo, [BazInfo, QuxInfo]] 則不是有效值。

未巢狀的供應商清單會自動轉換為一份包含一份供應商清單的清單。也就是說,[FooInfo, BarInfo] 會自動轉換為 [[FooInfo, BarInfo]]

如要讓部分規則 (例如 some_rule) 的目標對象對某個面向可見,some_rule 必須宣傳至少一個必要供應者清單中的所有供應者。舉例來說,如果某個面向的 required_providers[[FooInfo], [BarInfo], [BazInfo, QuxInfo]],則只有在 some_rule 提供 FooInfo BarInfo BazInfo QuxInfo 時,這個面向才能看到 some_rule 目標。

required_aspect_providers sequence;預設值為 []
。 這個屬性可讓這個面向檢查其他面向。這個值必須是清單,且只能包含個別供應商或供應商清單,不能同時包含兩者。舉例來說,[[FooInfo], [BarInfo], [BazInfo, QuxInfo]] 是有效值,而 [FooInfo, BarInfo, [BazInfo, QuxInfo]] 則不是有效值。

未巢狀的供應商清單會自動轉換為包含一個供應商清單的清單。也就是說,[FooInfo, BarInfo] 會自動轉換為 [[FooInfo, BarInfo]]

如要讓其他面向 (例如 other_aspect) 對此面向可見,other_aspect 必須提供至少一個清單中的所有供應者。在 [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] 的範例中,只有在 other_aspect 提供 FooInfo BarInfo 同時提供 BazInfo QuxInfo 時,這個面向才能看到 other_aspect

provides sequence; 預設為 []
implementation 函式必須傳回的供應器清單。

如果實作函式省略傳回值中列出的任何提供者類型,則會發生錯誤。不過,實作函式可能會傳回此處未列出的其他供應工具。

清單中的每個元素都是 provider() 傳回的 *Info 物件,但舊版提供者會以其字串名稱表示。如果規則的目標用於宣告必要提供者的目標的依附元件,則不必在此指定該提供者。只要實作函式傳回即可。不過,雖然這不是必要條件,但我們建議您指定該值。不過,資產required_providers 欄位確實需要在這裡指定提供者。

requires 切面序列;預設為 []
。 必須在這個切面之前傳播的切面清單。
fragments 字串序列;預設值為 []
。 列出子項在目標設定中所需的設定片段名稱。
host_fragments 字串序列;預設值為 []
。 主機設定中,此面向主機的元素所需的設定片段名稱清單。
toolchains sequence; 預設為 []
如果已設定,則為此面向的工具鍊組合。清單中可包含 String、Label 或 StarlarkToolchainTypeApi 物件,任意組合。系統會檢查目前的平台,並透過 ctx.toolchain 將工具鍊提供給面向實作。
incompatible_use_toolchain_transition bool;預設值為 False
。已淘汰,不再使用,應予以移除。
doc stringNone; 預設為 None
說明說明文件產生工具可擷取的層面。
apply_to_generating_rules bool; 預設為 False
如果為 true,則在套用至輸出檔案時,會改為套用至輸出檔案的產生規則。

舉例來說,假設某個層面會透過屬性 `deps` 傳播,並套用至目標 `alpha`。假設 `alpha` 有 `deps = [':beta_output']`,其中 `beta_output` 是目標 `beta` 的已宣告輸出內容。假設 `beta` 有目標 `charlie` 做為其中一個 `deps`。如果層面為 `apply_to_generating_rules=True`,則層面會透過 `alpha`、`beta` 和 `charlie` 傳播。如果為 False,則層面只會傳播至 `alpha`。

預設為 False。

exec_compatible_with 字串sequence;預設為 []
執行平台的限制清單,適用於該切面的所有執行個體。
exec_groups dictNone;預設為 None
。執行群組名稱 (字串) 與 exec_group 的字典。如果設定這個項目,讓切面在單一執行個體內的多個執行平台中執行動作。詳情請參閱執行群組說明文件
subrules 子規則序列; 預設為 []
(實驗功能):這個面向使用的子規則清單。

configuration_field

LateBoundDefault configuration_field(fragment, name)

參照 label 類型的屬性的遲交預設值。如果值需要先建立設定才能判斷值,則為「延遲繫結」。任何使用此值做為值的屬性都必須是私有屬性

以下是範例使用方式:

定義規則屬性:

'_foo': attr.label(default=configuration_field(fragment='java', name='toolchain'))

在規則實作中存取:

  def _rule_impl(ctx):
    foo_info = ctx.attr._foo
    ...

參數

參數 說明
fragment 字串; 必要
包含延遲繫結值的設定片段名稱。
name string; 必填
從設定片段取得的值名稱。

露點

depset depset(direct=None, order="default", *, transitive=None)

建立 depsetdirect 參數是 depset 的直接元素清單,而 transitive 參數則是 depset 的清單,其中元素會成為所建立 depset 的間接元素。order 參數會指定將 depset 轉換為清單時,元素的傳回順序。詳情請參閱「Depset 總覽」。

依據 type(x) 運算式取得的 depset 所有元素 (直接和間接) 都必須屬於相同類型。

由於以雜湊為基礎的集合會在疊代期間用於消除重複項目,因此 depset 的所有元素都應可雜湊。不過,目前並未在所有建構函式中一致檢查此不變量。使用 --incompatible_always_check_depset_elements 標記啟用一致檢查功能,這將成為日後版本的預設行為;請參閱 Issue 10313

此外,元素目前必須為不可變動,但這項限制日後將會放寬。

建立的 depset 順序應與其 transitive depset 順序相容"default" 順序與任何其他順序相容,所有其他順序只與自身相容。

參數

參數 說明
direct sequenceNone;預設為 None
。depset 的直接元素清單。
order string;預設為 "default"
新依附元件的周遊策略。如要查看可能的值,請參閱這裡
transitive depsetsequence;或是 None;預設為 None
這個依附元件清單將含有元素將成為 Depset 的間接元素。

exec_group

exec_group exec_group(toolchains=[], exec_compatible_with=[])

建立執行群組,可用於在規則導入期間為特定執行平台建立動作。

參數

參數 說明
toolchains sequence;預設為 []
。這個執行群組所需的工具鍊組合。清單可包含字串、標籤或 StarlarkToolchainTypeApi 物件,且可任意組合。
exec_compatible_with 字串序列;預設值為 []
。 執行平台的限制清單。

exec_transition

transition exec_transition(implementation, inputs, outputs)

用於定義執行轉換作業的 transition() 專屬版本。如要瞭解最佳做法,請參閱說明文件 (或其實作)。只能透過 Bazel 內建項目使用。

參數

參數 說明
implementation 可呼叫;必要
inputs 字串序列; 必要
outputs 字串序列; 必要

module_extension

unknown module_extension(implementation, *, tag_classes={}, doc=None, environ=[], os_dependent=False, arch_dependent=False)

建立新的模組擴充功能。將其儲存為全域值,以匯出並用於具有 use_extension 的 MODULE.bazel 檔案。

參數

參數 說明
implementation callable; required
實作此模組擴充功能的函式。必須採用單一參數 module_ctx。系統會在建構作業開始時呼叫這個函式一次,以判斷可用的套件集。
tag_classes dict;預設值為 {}
這個字典會宣告擴充功能使用的所有標記類別。它會將標記類別名稱對應至 tag_class 物件。
doc 字串None;預設為 None
。 說明模組擴充功能,可由說明文件產生工具擷取。
environ 字串序列;預設為 []
。提供此模組擴充功能依附的環境變數清單。如果清單中的環境變數有所變更,擴充功能就會重新評估。
os_dependent bool;預設值為 False
表示這項擴充功能是否與 OS 無關
arch_dependent bool; 預設值為 False
指出這個擴充功能是否會依架構而異

供應商

unknown provider(doc=None, *, fields=None, init=None)

定義提供者符號,這個函式產生的值必須儲存在全域值中,才能在規則或切面實作中使用。可透過呼叫產生的值作為函式,將提供者執行個體化,或直接做為索引鍵使用,從目標擷取該供應器的例項。範例:
MyInfo = provider()
...
def _my_library_impl(ctx):
    ...
    my_info = MyInfo(x = 2, y = 3)
    # my_info.x == 2
    # my_info.y == 3
    ...

如需使用供應器的完整指南,請參閱「規則 (供應器)」。

如未指定 init,系統會傳回 Provider 可呼叫值。

如果指定 init,則會傳回 2 個元素的元組:Provider 可呼叫值和原始建構函式可呼叫值。詳情請參閱 規則 (自訂供應商的自訂初始化作業),以及下方 init 參數的討論內容。

參數

參數 說明
doc 字串None; 預設值為 None
提供者說明,可由文件產生工具擷取。
fields 字串序列;或 字典;或 None;預設為 None
。 如果指定,則會限制允許的欄位集。
可能的值包括:
  • 欄位清單:
    provider(fields = ['a', 'b'])

  • 字典欄位名稱 -> 說明文件:
    provider(
           fields = { 'a' : 'Documentation for a', 'b' : 'Documentation for b' })
所有欄位均為選填欄位。
init 可呼叫;或 None;預設為 None
可選擇的回呼,用於預先處理及在例項化期間驗證供應器的欄位值。如果指定 initprovider() 會傳回 2 個元素的元組:一般提供者符號和原始建構函式

以下提供詳細說明。如需直覺的討論和用途,請參閱「規則 (供應者的自訂初始化作業)」。

P 為呼叫 provider() 所建立的供應工具符號。概念上來說,P 的例項是透過呼叫預設建構函式 c(*args, **kwargs) 產生,而該函式會執行以下操作:

  • 如果 args 非空白,就會發生錯誤。
  • 如果在呼叫 provider() 時指定 fields 參數,且 kwargs 包含 fields 中未列出的任何鍵,就會發生錯誤。
  • 否則,c 會傳回新例項,其中 kwargs 中的每個 k: v 項目都包含名為 k 的欄位,且值為 v
如果未提供 init 回呼,呼叫符號 P 本身會視為呼叫預設建構函式 c;換句話說,P(*args, **kwargs) 會傳回 c(*args, **kwargs)。例如:
MyInfo = provider()
m = MyInfo(foo = 1)
會直接使 m 成為帶有 m.foo == 1MyInfo 執行個體。

但如果指定 init,呼叫 P(*args, **kwargs) 會改為執行下列步驟:

  1. 回呼會以 init(*args, **kwargs) 的形式叫用,也就是使用與傳遞至 P 時完全相同的位置和關鍵字引數。
  2. init 的傳回值應為字典 d,其索引鍵為欄位名稱字串。否則會發生錯誤。
  3. 系統會產生新的 P 例項,就像呼叫預設建構函式,並將 d 的項目做為關鍵字引數,如 c(**d) 所示。

注意:上述步驟表示如果 *args**kwargs 不符合 init 的簽章,或是 init 的內容評估失敗 (可能是透過呼叫 fail() 而故意造成),或是 init 的傳回值不是含有預期結構定義的字典,就會發生錯誤。

因此,init 回呼會允許位置引數和任意邏輯,用於預先處理和驗證,進而將一般提供者建構程序泛用化。不會讓您規避允許的 fields 清單。

指定 init 後,provider() 的回傳值會變成元組 (P, r),其中 r原始建構函式。事實上,r 的行為正是上述預設建構函式 c 的行為。通常,r 會繫結至名稱前面有底線的變數,因此只有目前的 .bzl 檔案可以直接存取該變數:

MyInfo, _new_myinfo = provider(init = ...)

repository_rule

callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc=None)

建立新的存放區規則。將其儲存在全域值中,以便從 module_extension() 實作函式載入及呼叫,或由 use_repo_rule() 使用。

參數

參數 說明
implementation 可呼叫的函式; 必填
實作此規則的函式。必須有單一參數 repository_ctx。系統會在規則的每個例項載入階段中呼叫此函式。
attrs dictNone;預設為 None
。用來宣告存放區規則的所有屬性。會從屬性名稱對應至屬性物件 (請參閱 attr 模組)。開頭為 _ 的屬性屬於私人性質,可用於為檔案加上標籤的隱含依附元件 (存放區規則無法依附於產生的成果)。系統會隱含新增 name 屬性,因此不必指定。

宣告的屬性會將 None 轉換為預設值。

local bool; 預設值為 False
表示此規則會從本機系統擷取所有內容,並應在每次擷取時重新評估。
environ 字串序列;預設值為 []
已淘汰。此參數已淘汰。請改為遷移至 repository_ctx.getenv
會提供此存放區規則依附的環境變數清單。如果這份清單中的環境變數有所變更,系統就會重新擷取存放區。
configure bool; 預設值為 False
表示存放區會檢查系統以便設定
remotable bool;預設值為 False
實驗功能。這個參數仍在實驗階段,可能隨時變更。請勿依賴這項功能。您可以設定 --experimental_repo_remote_exec
Compatible with remote execution,以實驗方式啟用這項功能。
doc 字串None;預設為 None
。 Repository 規則的說明,可由說明文件產生工具擷取。

規則

callable rule(implementation, *, test=unbound, attrs={}, outputs=None, executable=unbound, output_to_genfiles=False, fragments=[], host_fragments=[], _skylark_testable=False, toolchains=[], incompatible_use_toolchain_transition=False, doc=None, provides=[], dependency_resolution_rule=False, exec_compatible_with=[], analysis_test=False, build_setting=None, cfg=None, exec_groups=None, initializer=None, parent=None, extendable=None, subrules=[])

建立新規則,可從 BUILD 檔案或巨集呼叫,用於建立目標。

規則必須指派至 .bzl 檔案中的全域變數;全域變數的名稱就是規則的名稱。

測試規則的名稱必須以 _test 結尾,其餘規則則不得使用這個後置字串。(這項限制僅適用於規則,不適用於規則的目標)。

參數

參數 說明
implementation 函式; 必填
實作此規則的 Starlark 函式,必須具備以下一個參數:ctx。系統會在分析階段為每個規則例項呼叫這項函式。可存取使用者提供的屬性。必須建立動作,產生所有宣告的輸出內容。
test bool;預設值為 unbound
。是否為測試規則,也就是是否可成為 blaze test 指令的主體。所有測試規則都會自動視為「可執行」;您不必為測試規則明確設定 executable = True,因此不需要 (不建議) 採取這種做法。預設值為 False。詳情請參閱「 規則」頁面。
attrs dict; 預設值為 {}
這是宣告規則所有屬性的字典。它會將屬性名稱對應至屬性物件 (請參閱 attr 模組)。以 _ 開頭的屬性為私有,可用於在標籤上新增隱含的依附元件。系統會隱含新增 name 屬性,因此您不需要指定。系統會隱含新增 visibilitydeprecationtagstestonlyfeatures 屬性,且無法覆寫。大部分規則只需要幾個屬性。為限制記憶體用量,可宣告的屬性數量設有上限。

宣告的屬性會將 None 轉換為預設值。

outputs 字典;或 None;或函式;預設為 None
已淘汰。這個參數已淘汰,並將在近期內移除。請勿依賴這項功能。--incompatible_no_rule_outputs_param停用。使用這個標記,驗證您的程式碼是否與即將移除的標記相容。
這個參數已淘汰。請將規則遷移為改用 OutputGroupInfoattr.output

用於定義預先宣告輸出的結構定義。與 outputoutput_list 屬性不同,使用者不會為這些檔案指定標籤。如要進一步瞭解預先宣告的輸出內容,請參閱規則頁面

這個引數的值是字典,或是產生字典的回呼函式。回呼的運作方式與計算的依附元件屬性類似:函式的參數名稱會與規則屬性進行比對,舉例來說,如果您透過定義 def _my_func(srcs, deps): ... 傳遞 outputs = _my_func,函式便可存取屬性 srcsdeps。無論字典是直接指定或透過函式指定,都會解讀如下。

字典中的每個項目都會建立預先宣告的輸出內容,其中索引鍵是 ID,值則是決定輸出標籤的字串範本。在規則的實作函式中,這個 ID 會成為欄位名稱,用於在 ctx.outputs 中存取輸出的 File。輸出的標籤與規則具有相同的套件,而在產生套件之後的部分,則是用 ATTR 屬性的值以字串取代 "%{ATTR}" 格式的每個預留位置:

  • 字串類型的屬性會完整替換。
  • 標籤類型的屬性在套件後成為標籤的一部分,並減去副檔名。舉例來說,標籤 "//pkg:a/b.c" 會變成 "a/b"
  • 輸出類型屬性會成為套件後面的標籤部分,包括副檔名 (在上述範例中為 "a/b.c")。
  • 在預留位置中使用的所有清單型屬性 (例如 attr.label_list) 都必須只有一個元素。轉換與非清單版本 (attr.label) 相同。
  • 其他屬性類型可能不會顯示在預留位置中。
  • 特殊的非屬性預留位置 %{dirname}%{basename} 會展開至規則標籤的部分,但不包括套件。例如,在 "//pkg:a/b.c" 中,dirname 為 a,basename 為 b.c

在實務上,最常見的替換預留位置是 "%{name}"。舉例來說,如果目標名稱為「foo」,輸出字典 {"bin": "%{name}.exe"} 會預先宣告名為 foo.exe 的輸出項目,在實作函式中可透過 ctx.outputs.bin 存取。

executable bool; 預設為 unbound
是否將此規則視為可執行,也就是是否可成為 blaze run 指令的主體。預設值為 False。詳情請參閱 規則頁面
output_to_genfiles bool;預設值為 False
。 如果為 true,檔案會在 genfiles 目錄中產生,而非 bin 目錄。除非您需要為現有規則提供相容性 (例如產生 C++ 標頭檔案時),否則請勿設定此標記。
fragments 序列字串;預設值為 []
規則所需的設定片段名稱清單,在目標設定中加入規則。
host_fragments 字串序列;預設值為 []
。 列出規則在主機設定中所需的設定片段名稱。
_skylark_testable bool; 預設為 False
(實驗功能)

如果為 true,則此規則會公開其動作,供依附於此的規則透過 Actions 供應器進行檢查。提供者也可以呼叫 ctx.created_actions(),以存取規則本身。

這個方法只能用來測試 Starlark 規則的分析時間行為。我們日後可能會移除這個旗標。
toolchains sequence;預設為 []
如果已設定,則此規則需要的一系列工具鍊。清單可包含字串、標籤或 StarlarkToolchainTypeApi 物件,且可任意組合。查看目前的平台以找到工具鍊,並透過 ctx.toolchain 提供給規則實作。
incompatible_use_toolchain_transition bool;預設值為 False
已淘汰,因此已停用,應予以移除。
doc stringNone;預設為 None
。 說明規則,可供文件產生工具擷取。
provides sequence;預設值為 []
這是實作函式必須傳回的提供者清單。

如果實作函式省略傳回值中列出的任何提供者類型,則會發生錯誤。但實作函式可能會傳回這裡未列出的其他供應商。

清單中的每個元素都是 provider() 傳回的 *Info 物件,但舊版提供者會以其字串名稱表示。如果規則的目標用於宣告必要提供者的目標的依附元件,則不必在此指定該提供者。實作函式即可傳回該程式碼。不過,雖然這不是必要條件,但我們建議您指定該值。不過,aspectrequired_providers 欄位需要指定提供者。

dependency_resolution_rule bool;預設值為 False
。如果設定了這項條件,即可透過具體化工具標示為可用的屬性,讓規則成為依附元件。設定此標記的規則中,每個屬性都必須標示為在 Materializers 中可用。這樣一來,標示為「已過時」的規則就不會依附未標示為「已過時」的規則。
exec_compatible_with 字串序列;預設為 []
。 執行平台的限制清單,適用於此規則類型的所有目標。
analysis_test bool; 預設值為 False
如果為 true,則系統會將此規則視為分析測試。

注意:分析測試規則主要是使用 Starlark 核心程式庫中的基礎架構定義。詳情請參閱「測試」一節。

如果將規則定義為分析測試規則,則可對其屬性使用透過 analysis_test_transition 定義的設定轉換,但選擇加入一些限制:

  • 這個規則的目標可能會有的間接相依項目數量有限。
  • 系統會將這項規則視為測試規則 (就像已設定 test=True 一樣)。這會取代 test 的值
  • 規則實作函式可能不會註冊動作。而是必須透過提供 AnalysisTestResultInfo 註冊通過/失敗結果。
build_setting BuildSetting」或 None;預設值為 None
如果已設定,請說明這項規則的 build setting 類型。請參閱 config 模組。如果設定此值,系統會自動將名為「build_setting_default」的必要屬性新增至此規則,類型則會對應至此處傳入的值。
cfg 預設為 None
如果已設定,則會指向規則在分析前套用至自身設定的設定轉換。
exec_groups dictNone;預設為 None
。執行群組名稱 (字串) 與 exec_group 的字典。如果設定這項功能,規則就能在單一目標內的多個執行平台上執行動作。詳情請參閱執行群組說明文件
initializer 預設為 None
Experimental:Stalark 函式會初始化規則的屬性。

系統會在載入時為每個規則例項呼叫這個函式。系統會使用 name 和規則定義的公開屬性值 (而非一般屬性,例如 tags) 呼叫此方法。

必須傳回從屬性名稱到所需值的字典。未傳回的屬性則不受影響。如果傳回 None 做為值,則會使用屬性定義中指定的預設值。

系統會先評估初始化項目,再評估屬性定義中指定的預設值。因此,如果初始化器簽章中的參數包含預設值,該參數會覆寫屬性定義中的預設值 (除非傳回 None)。

同樣地,如果初始化器簽章中的參數沒有預設值,該參數就會變成必要參數。在這種情況下,建議您省略屬性定義的預設/必要設定。

對於未處理的屬性,建議使用 **kwargs

在延伸規則的情況下,所有初始化器都會從子項開始,依序呼叫上層。每個初始化器只會傳遞其瞭解的公開屬性。

parent 預設為 None
Experimental:擴充的 Stalark 規則。設定公開屬性時,系統會合併和宣傳的供應商。規則會比對父項中的 executabletest。系統會合併 fragmentstoolchainsexec_compatible_withexec_groups 的值。您可能無法設定舊版或已淘汰的參數。系統會在此規則的傳入設定後,套用傳入設定轉換 (父項的 cfg)。
extendable bool;或標籤;或字串;或 None;預設為 None
實驗功能:允許清單的標籤,定義哪些規則可以擴充此規則。您也可以把這個參數設為 True/False,以一律允許/禁止擴充。Bazel 預設一律允許擴充功能。
subrules 子規則序列;預設值為 []
。 (實驗功能):這項規則使用的子規則清單。

選取

unknown select(x, no_match_error='')

select() 是輔助函式,可讓規則屬性可設定。詳情請參閱建構百科全書

參數

參數 說明
x dict;必要
將設定條件對應至值的 指示。每個鍵都是用於識別 config_setting 或 constraint_value 執行個體的標籤或標籤字串。如要瞭解何時應使用標籤而非字串,請參閱 巨集說明文件
no_match_error 字串;預設為 ''
。 如果沒有任何條件符合,可選擇回報自訂錯誤。

子規則

Subrule subrule(implementation, attrs={}, toolchains=[], fragments=[], subrules=[])

建構子規則的新例項。這個函式的結果必須儲存在全域變數中,才能使用。

參數

參數 說明
implementation function; 必要
Starlark 函式,用於實作此子規則
attrs dict; 預設為 {}
用於宣告子規則的所有 (私人) 屬性的字典。

子規則只能包含標籤類型 (例如標籤或標籤清單) 的私人屬性。與這些標籤相對應的已解析值會由 Bazel 自動傳遞至子規則的實作函式,並做為命名引數使用 (因此,實作函式必須接受與屬性名稱相符的命名參數)。這些值的類型如下:

  • FilesToRunProvider 適用於標籤屬性,且含有 executable=True
  • File 適用於標籤屬性,且含有 allow_single_file=True
  • Target 用於所有其他標籤屬性
  • [Target] 適用於所有標籤清單屬性
toolchains sequence;預設為 []
如果已設定,則這個子規則需要一組工具鍊。清單可包含字串、標籤或 StarlarkToolchainTypeApi 物件,且可任意組合。查看目前的平台後即可找到工具鍊,並透過 ctx.toolchains 提供給子規則實作。請注意,如果設定此參數,就必須為消耗規則啟用 AEG。如果您尚未遷移至 AEG,請參閱 https://bazel.build/extending/auto-exec-groups#migration-aegs。
fragments 字串序列;預設為 []
。 列出子規則在目標設定中所需的設定片段名稱。
subrules Subrulesequence;預設值為 []
這個子規則所需的其他子規則清單。

tag_class

tag_class tag_class(attrs={}, *, doc=None)

建立新的 tag_class 物件,定義標記類別的屬性結構定義,該標記類別是模組擴充功能可使用的資料物件。

參數

參數 說明
attrs dict; 預設為 {}
用於宣告此標記類別的所有屬性的字典。會從屬性名稱對應至屬性物件 (請參閱 attr 模組)。

請注意,與 rule()aspect()repository_rule() 不同,宣告的屬性不會將 None 轉換為預設值。如要使用預設值,呼叫端必須完全省略該屬性。

doc string; 或 None;預設值為 None
這是可透過說明文件產生工具擷取的標記類別說明。

顯示設定

None visibility(value)

設定目前正在初始化的 .bzl 模組的載入可見度。

模組的載入瀏覽權限可控管其他 BUILD 和 .bzl 檔案是否能夠載入該模組。(這與底層 .bzl 來源檔案的目標可見度不同,後者會決定檔案是否會顯示為其他目標的依附元件)。載入可見度會在套件層級運作:如要載入模組,進行載入的檔案必須位於已授予模組可見度的套件中。無論可見性為何,模組一律會在其自身套件中載入。

每個 .bzl 檔案只能呼叫 visibility() 一次,且只能在頂層呼叫,而非在函式內呼叫。建議的樣式是將這個呼叫放在 load() 陳述式和任何用於判斷引數的簡短邏輯下方。

如果 --check_bzl_visibility 旗標設為 false,載入瀏覽權限違規事件時,系統會發出警告,但不會失敗版本。

參數

參數 說明
value 必要
套件規格字串清單,或單一套件規格字串。

套件規格的格式與 package_group 相同,但不允許使用排除套件規格。也就是說,規格可能包含以下格式:

  • "//foo":套件 //foo
  • "//foo/...":套件 //foo 及其所有子套件。
  • "public""private":分別代表所有套件或沒有套件

不允許使用「@」語法;所有規格都會相對於目前模組的存放區進行解讀。

如果 value 是字串清單,則可向此模組授予瀏覽權限的套件組合,就是由各規格代表的套件組合所組成的聯集。(空白清單的作用與 private 相同)。如果 value 是單一字串,系統會將其視為單一清單 [value]

請注意,旗標 --incompatible_package_group_has_public_syntax--incompatible_fix_package_group_reporoot_syntax 對這個引數沒有任何影響。"public""private" 值一律可用,而 "//..." 一律會解讀為「目前存放區中的所有套件」。