檔案

這個物件會在分析階段建立,代表會在執行階段讀取或寫入的檔案或目錄。這不是開啟的檔案控制代碼,無法用來直接讀取或寫入檔案內容。而是將這項功能傳遞至動作建立函式,在規則實作函式中建構動作圖。詳情請參閱規則頁面

在不使用 map_each 函式的情況下將 File 傳遞至 Args 物件時,系統會取得其 path 欄位的值,將該物件轉換為字串。

會員

basename

string File.basename

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

dirname

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

path

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()。如為其他類型的檔案,存取這個欄位時會發生錯誤。