檔案

回報問題 查看來源 夜間 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

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

如果將 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。

owner

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