HOWTO · Python
如何獲得當前 Python 指令碼檔案的資料夾路徑
本貼士介紹瞭如何來獲得 Python 當前指令碼檔案的資料夾路徑。
本頁內容
若要取得正在執行的 Python 指令碼所在的資料夾,請使用 os.path.dirname(os.path.abspath(__file__)),或 Path(__file__).resolve().parent。兩種寫法都以 __file__(與指令碼相關的路徑)為起點,取得該路徑所屬的資料夾。接著可用這個資料夾組合出指令碼旁檔案的路徑。
取得目前指令碼所在的資料夾
指令碼所在的資料夾,就是包含其 .py 檔案的資料夾。__file__ 提供指令碼路徑;先套用 os.path.abspath(),再套用 os.path.dirname(),即可取得絕對資料夾路徑。當指令碼需要使用附近的設定、輸入或資料檔案時,這個路徑就很實用。如果 __file__ 是相對路徑,os.path.abspath() 會以程序的工作目錄為基準解析,因此結果可能取決於啟動 Python 時所在的位置。如果 __file__ 已是絕對路徑,工作目錄就不會決定它的位置。
請從已儲存的 Python 檔案執行以下範例:
本節中的程式碼以及顯示的標籤或輸出仍為英文。
import os
script_path = os.path.abspath(__file__)
script_directory = os.path.dirname(script_path)
directory, filename = os.path.split(script_path)
print("Script directory:", script_directory)
print("Directory and filename:", directory, filename)
Script directory: /work
Directory and filename: /work case-0.py
os.path.abspath() 會根據目前程序的環境將指令碼路徑轉成絕對路徑,而 os.path.dirname() 會取出其中的資料夾部分。os.path.split() 會分別傳回資料夾與檔名。輸出的資料夾會依檔案的儲存位置而異,因此沒有可通用照抄的固定輸出。
區分指令碼資料夾與工作目錄
工作目錄是程序用來解析相對路徑的位置,例如 open("data.csv")。可用 os.getcwd() 查詢。它可能是終端機目前所在的資料夾、IDE 設定的資料夾,或由父程序選定的資料夾,不一定是指令碼所在的資料夾。
相較之下,__file__ 指的是正在執行的 Python 檔案路徑。假設指令碼位於 /projects/tool,但啟動時的工作目錄是 /tmp,那麼以相對路徑開啟 data.csv 時,Python 會從 /tmp 尋找;以指令碼資料夾組合出的路徑則會指向 /projects/tool。請依檔案預期的位置選擇基準。若檔案與指令碼放在一起,可用 os.path.join(script_directory, "data.csv") 將檔名接到取得的指令碼資料夾路徑上。
從 __file__ 得到絕對路徑,不代表檔案一定存在,也無法處理所有符號連結或部署環境相關問題。這個路徑提供一個可用來組合其他路徑的位置;請依應用程式的需求確認或開啟組合後的路徑。
使用 os.path 取得指令碼所在的資料夾
上一個範例保留了中間值,讓每個操作都更清楚。若只需要指令碼所在的資料夾,可將呼叫合併為 os.path.dirname(os.path.abspath(__file__))。若資料夾與檔名都需要使用,請保留 os.path.split() 的結果,不要丟棄檔名。
要組合出同一資料夾中其他檔案的路徑,請使用 os.path.join(),不要用斜線串接字串。這樣 Python 會依照平台的路徑分隔符號規則處理。例如,os.path.join(script_directory, "settings.json") 會建立以指令碼資料夾為基準的路徑。若直接將相對檔名傳給 open(),Python 則會以工作目錄為基準解析。
使用 pathlib 取得指令碼所在的資料夾
pathlib 使用路徑物件表達相同操作。在已儲存的指令碼中,Path(__file__).resolve().parent 會取得指令碼所在的資料夾:resolve() 會取得解析後的絕對路徑,而 .parent 會選出其父資料夾。使用 / 可附加子路徑,例如 script_directory / "settings.json";接著可將產生的 Path 傳給接受路徑類物件的 API,包括 open()。
對應的寫法是 Path(__file__).resolve().parent;使用前請從 pathlib 匯入 Path。如果周邊程式碼已使用 Path 物件,選用 pathlib 會較自然;若處理的是字串路徑,或現有 API 預期接收字串,則可使用 os.path。這兩種作法都不會變更程序的工作目錄。
處理 Notebook 與其他執行環境
Python 通常會在執行已儲存的指令碼時定義 __file__,但互動式直譯器與 Notebook 核心可能沒有這個變數。在這些環境中,上述以指令碼為基礎的寫法無法以可攜的方式識別 Notebook 檔案。os.getcwd() 仍會回報程序的工作目錄,可用來尋找相對於核心目前位置的檔案,但不能代替 Notebook 的原始檔案路徑。
如果要處理的檔案不是正在執行的指令碼,請從該檔案已知的路徑開始,而不是從 __file__ 開始;接著使用 os.path.dirname() 或 Path 物件的 .parent 取得其資料夾。請明確指出路徑來源,讓後續讀者能分辨它代表的是指令碼、其他檔案,還是程序的工作目錄。