檔案

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

這個物件是在分析階段建立,用來代表在執行階段讀取或寫入的檔案或目錄。這不是開啟的檔案句柄,無法用於直接讀取或寫入檔案內容。您會將這個註解傳送至建立動作的函式,藉此在規則實作函式中建構動作圖。詳情請參閱「規則」頁面。

File 傳遞至 Args 物件時,如未使用 map_each 函式,系統會擷取 path 欄位的值,將該物件轉換為字串。

成員

basename

string File.basename

這個檔案的基礎名稱。這是目錄中的檔案名稱。

目錄名稱

string File.dirname

包含這個檔案的目錄名稱。這個值取自 path,一律以執行目錄為基準。

擴充功能

string File.extension

這個檔案的副檔名,緊接在最右邊的句號後方 (不含該符號)。如果檔案的底層名稱不含句點,則為空字串。

is_directory

bool File.is_directory

如果這是目錄,則傳回 true。

is_source

bool File.is_source

如果這是來源檔案 (也就是未產生),則傳回 true。

擁有者

Label File.owner

產生此檔案的目標標籤。可能會傳回 None

路徑

string File.path

相對於工作區執行目錄的此檔案執行路徑。其中包含兩個部分,可選用的第一個部分稱為「根層級」 (另請參閱模組),第二個部分則是 short_path。根目錄可能為空白,這通常是針對非產生的檔案。在產生的檔案中,通常會包含設定專屬的路徑片段,對類似建構上述檔案時使用的目標 CPU 架構進行編碼。如果檔案位於二進位檔的執行檔案中,請針對檔案對應的路徑使用 short_path

root

root File.root

這個檔案的根層級,

short_path

string File.short_path

相對於根目錄的檔案路徑。這會排除上述的「根」,也就是路徑的設定專屬片段。如果檔案位於二進位檔的執行檔案中,這也會是對應檔案的路徑。

tree_relative_path

string File.tree_relative_path

如果祖系的 is_directory 欄位為 true,則這個檔案的相對路徑即為祖系樹狀結構的根層級。tree_relative_path 僅適用於動作指令中目錄的展開檔案,也就是 Args.add_all()。如果是其他類型的檔案,存取這個欄位時會發生錯誤。