原生

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

內建模組，可支援原生規則和其他套件輔助函式。所有原生規則都會顯示為此模組中的函式，例如 native.cc_library。請注意，原生模組只能在載入階段中使用 (例如巨集，不適用於規則導入)。屬性會忽略 None 值，就像未設定屬性一樣。
您還可以使用下列函式：

成員

existing_rule

unknown native.existing_rule(name)

傳回不可變動的字典類似物件，用於描述在這個執行緒套件中例項化的規則屬性，如果沒有該名稱的規則例項，則傳回 None。

在此，不可變動的字典類型物件是指深層不可變動的物件 x，可支援字典類型的疊代作業、len(x)、name in x、x[name]、x.get(name)、x.items()、x.keys() 和 x.values()。

結果包含每個屬性的項目，但私人屬性 (名稱不以字母開頭) 和幾個無法表示的舊版屬性類型除外。此外，字典中包含規則例項的 name 和 kind (例如 'cc_binary') 項目。

結果的值代表屬性值，如下所示：

  • 屬性類型為 str、int 和 bool 時，會以原樣表示。
  • 針對同一套件中的目標，標籤會轉換為 ':foo' 形式的字串，對於其他套件中的目標，則會轉換為 '//pkg:name' 形式的字串。
  • 清單會以元組表示，且字典會轉換為可變動的新字典。這些元素的元素會以遞迴方式轉換。
  • select 值會傳回，且內容會按照上述方式轉換。
  • 在規則例項化期間未指定值，且系統已計算出預設值的屬性，會從結果中排除。(直到分析階段才能計算運算預設值)。

請盡可能只在 規則完成器符號巨集的實作函式中使用這個函式。不建議在其他情境中使用此函式，且在未來的 Bazel 版本中會停用此函式；這會導致 BUILD 檔案變得脆弱且依序依賴。此外，請注意，這與將規則屬性值從內部格式轉換為 Starlark 的其他兩種轉換方式略有不同：一種是運算預設值使用，另一種是 ctx.attr.foo 使用。

參數

參數 說明
name 字串； 必要
目標名稱。

existing_rules

unknown native.existing_rules()

傳回不可變動的字典類型物件，描述目前在這個執行緒套件中已例項化的規則。類似字典的物件每個項目都會將規則執行個體的名稱對應至 existing_rule(name) 會傳回的結果。

此處的「類似字典物件」意指一個非常不可變的物件 x，支援類似字典的疊代、len(x)、name in x、x[name]、x.get(name)、x.items()、x.keys() 和 x.values()。

如果可能，請只在規則最終符號巨集的實作函式中使用這個函式。不建議在其他情境中使用此函式，且將在未來的 Bazel 版本中停用；這會導致 BUILD 檔案變得脆弱且依序依賴。

exports_files

None native.exports_files(srcs, visibility=None, licenses=None)

指定屬於此套件且要匯出至其他套件的檔案清單。

參數

參數 說明
srcs string 的序列； 必要
要匯出的檔案清單。
visibility sequence；或 None； 預設為 None
您可以指定可見度宣告。指定的目標就能看到這些檔案。如果未指定可見度，則所有套件都能看到這些檔案。
licenses 字串的序列；或 None；預設為 None
要指定的授權。

glob

sequence native.glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)

Glob 會傳回目前套件中每個檔案的新、可變更、已排序清單，這些檔案必須符合下列條件：
  • 至少符合 include 中的一個模式。
  • 不符合 exclude 中的任何模式 (預設為 [])。
如果啟用 exclude_directories 引數 (設為 1)，系統就會從結果中略過目錄類型檔案 (預設為 1)。

參數

參數 說明
include 字串的序列；預設為 []
。 您要納入的 glob 模式清單。
exclude 字串的序列；預設為 []
。 您要排除的 glob 模式清單。
exclude_directories int； 預設為 1
標示是否要排除目錄。
allow_empty 預設值為 unbound
Glob 模式是否允許不相符。如果 `allow_empty` 為 False，則每個個別的加入模式都必須符合某個項目，且最終結果也必須非空白 (排除 `exclude` 模式的符合項目後)。

module_name

string native.module_name()

與此套件所在的 repo 相關聯的 Bazel 模組名稱。如果這個套件來自 WORKSPACE 中定義的存放區，而非 MODULE.bazel，則這個值會是空白。如果是模組擴充功能產生的 repo，則為代管擴充功能的模組名稱。這與 module_ctx.modules 中的 module.name 欄位相同。可能會傳回 None。

module_version

string native.module_version()

與此套件所在的 repo 相關聯的 Bazel 模組版本。如果這個套件來自 WORKSPACE 中定義的存放區，而非 MODULE.bazel，這裡會是空的。對於由模組擴充功能產生的存放區，這是代管擴充功能的模組版本。這與 module_ctx.modules 中的 module.version 欄位相同。可能會傳回 None。

package_group

None native.package_group(name, packages=[], includes=[])

這個函式會定義一組套件，並為群組指派標籤。您可以在 visibility 屬性中參照這個標籤。

參數

參數 說明
name 字串； 必填
此規則的專屬名稱。
packages 字串序列； 預設為 []
這個群組中完整的套件列舉。
includes 字串的序列；預設為 []
。 此套件中包含的其他套件群組。

package_name

string native.package_name()

要評估的套件名稱，不含存放區名稱。舉例來說，在 BUILD 檔案 some/package/BUILD 中，其值會是 some/package。如果 BUILD 檔案呼叫 .bzl 檔案中定義的函式，package_name() 會比對呼叫端 BUILD 檔案套件。

package_relative_label

Label native.package_relative_label(input)

根據目前初始化的套件 (也就是執行目前巨集的 BUILD 檔案)，將輸入字串轉換為 Label 物件。如果輸入內容已是 Label，則會以原樣傳回。

這個函式只能在評估 BUILD 檔案和該檔案直接或間接呼叫的巨集時呼叫；例如，可能不會在規則實作函式中呼叫。

此函式的結果會與透過將指定字串傳遞至 BUILD 檔案中所宣告目標的標籤值屬性所產生的 Label 值相同。

使用說明：這個函式與 Label() 的差異在於，Label() 會使用呼叫它的 .bzl 檔案套件的背景資訊，而非 BUILD 檔案的套件。如需參照已硬式編碼至巨集中的固定目標 (例如編譯器)，請使用 Label()。當您需要將 BUILD 檔案提供的標籤字串正規化為 Label 物件時，請使用 package_relative_label()。(除了 BUILD 檔案或呼叫的 .bzl 檔案，在套件內容中無法將字串轉換為 Label。因此，外部巨集應一律優先將 Label 物件傳遞至內部巨集，而非標籤字串。)

參數

參數 說明
input string；或 Label；必要
輸入標籤字串或標籤物件。如果傳遞 Label 物件，系統會原封不動地傳回該物件。

repo_name

string native.repo_name()

包含目前評估中的套件存放區的標準名稱，開頭沒有 @ 符號。

repository_name

string native.repository_name()

Experimental。這個 API 仍在實驗階段，可能隨時變更。請勿仰賴這項功能。您可以將 --+incompatible_enable_deprecated_label_apis
設為「已淘汰」，以便在實驗階段啟用這項功能。建議改用 repo_name，因為它不含多餘的前置 @ 符號，但在其他方面運作方式相同。

包含目前評估中的套件存放區的標準名稱，前面加上一個 @ 符號 (@)。舉例來說，在 WORKSPACE 段落 local_repository(name='local', path=...) 呼叫的套件中，會將其設為 @local。在主要存放區的套件中，會設為 @。

子檔案包

sequence native.subpackages(include, exclude=[], allow_empty=False)

傳回目前套件的每個直接子包的新可變動清單，不受檔案系統目錄深度影響。傳回的清單經過排序，且包含與目前套件相關的子套件名稱。建議您使用 bazel_skylib.subpackages 模組中的函式，而非直接呼叫這個函式。

參數

參數 說明
include 字串的序列； 必要
Glob 模式清單，用於在子套件掃描中加入。
exclude 字串的 sequence；預設為 []
要從子套件掃描作業中排除的 glob 模式清單。
allow_empty bool； 預設為 False
。 如果呼叫傳回空白清單，是否失敗。根據預設，空白清單表示 BUILD 檔案中對 subpackages() 的呼叫是多餘的，因此可能發生錯誤。如果設為 true，這個函式將可成功執行。