HOWTO · Python

在 Python 中從另一個檔案匯入變數

本教程演示瞭如何在 Python 中從另一個檔案匯入變數。

本頁內容

若要使用另一個 Python 檔案中定義的變數,可以匯入該模組後讀取變數,也可以使用 from module import name 直接綁定名稱。該模組必須能透過 Python 的匯入路徑找到。小型專案可以將兩個檔案放在同一個目錄,並從該專案執行負責匯入的指令碼。

使用 from ... import ... 匯入特定名稱

假設 config.py 定義了 greeting = "Hello, World!"。負責匯入的檔案可以使用 from config import greeting,接著直接使用 greeting。模組名稱就是不含 .py 的檔名。只需要少數名稱時,這種寫法很方便。若要匯入多個已知名稱,可以用逗號分隔,例如 from config import greeting, language。

執行以下範例:

本節中的程式碼以及顯示的標籤或輸出仍為英文。

from pathlib import Path
from tempfile import TemporaryDirectory
import sys

with TemporaryDirectory() as directory:
    project = Path(directory)
    (project / "config.py").write_text('greeting = "Hello, World!"\n', encoding="utf-8")
    sys.path.insert(0, str(project))
    from config import greeting
    print(greeting)

此範例提供給執行環境協調器執行;本撰寫資料包未提供執行結果。

匯入模組並存取其中的變數

若希望每次使用時都能看出來源模組,請使用 import config,然後讀取 config.greeting。模組名稱前綴能清楚標示名稱的來源;當不同模組定義了同名名稱時,也能減少衝突。一般匯入會在匯入執行時綁定匯入的名稱;之後即使來源模組中的值有所變動,分開匯入的名稱也不會成為指向該值的即時連結。

使用 importlib 動態匯入模組

如果模組名稱要在執行期間才決定,例如根據設定或使用者選擇,就可以使用 importlib。若模組名稱已知,一般匯入寫法更短,也更容易理解。以下是完整獨立的動態匯入寫法:

本節中的程式碼以及顯示的標籤或輸出仍為英文。

from pathlib import Path
from tempfile import TemporaryDirectory
import importlib
import sys

with TemporaryDirectory() as directory:
    project = Path(directory)
    (project / "config.py").write_text('greeting = "Hello, World!"\n', encoding="utf-8")
    sys.path.insert(0, str(project))
    module_name = "config"
    module = importlib.import_module(module_name)
    print(module.greeting)

importlib.import_module() 會傳回模組物件,因此要透過該物件存取變數。匯入系統仍必須能找到該模組。

讓其他目錄中的模組可供匯入

Python 會搜尋匯入路徑中的目錄,不會任意搜尋所有檔案。一種簡單的目錄配置是讓 project/main.py 與 project/settings/config.py 並存;啟動時所在的環境與套件設定,會決定能否匯入 settings.config。若使用一般套件,請視需要加入 __init__.py,並使用套件名稱,例如 from settings.config import greeting。從不同目錄執行程式可能改變 Python 搜尋的位置,因此最好以一致的方式啟動專案。

若要執行獨立指令碼,也可以刻意採用備援做法:在匯入模組之前,先將包含該模組的目錄加入 sys.path。可行時,請從穩定的位置取得目錄路徑,不要假設目前工作目錄就是正確位置:

本節中的程式碼以及顯示的標籤或輸出仍為英文。

from pathlib import Path
from tempfile import TemporaryDirectory
import sys

with TemporaryDirectory() as directory:
    project = Path(directory)
    settings_directory = project / "settings"
    settings_directory.mkdir()
    (settings_directory / "config.py").write_text('greeting = "Hello, World!"\n', encoding="utf-8")
    sys.path.insert(0, str(settings_directory))
    from config import greeting
    print(greeting)

這會將目錄加入 sys.path,而不是將模組檔案本身加入其中。對於需要長期維護的應用程式,使用套件匯入或安裝套件,通常比在應用程式程式碼中修改匯入路徑更容易管理。

執行範例並排除問題

請以匯入時使用的確切名稱儲存模組,並確認大小寫一致;也要確保變數是在模組頂層定義。如果 Python 顯示 ModuleNotFoundError,請檢查檔名、目錄配置、啟動指令碼的方式,以及包含該模組的目錄是否位於匯入路徑中。如果 Python 因名稱而顯示 ImportError,請確認拼字是否與模組中定義的名稱一致。避免將自己的檔案命名為標準函式庫模組的名稱,否則 Python 可能載入錯誤的模組。

依賴項固定時,直接匯入最合適。若只需簡潔地使用少數名稱,請選擇 from config import greeting;若保留可見的模組命名空間能讓程式更清楚,則使用 import config。只有在模組名稱確實取決於執行期間的資料時,才使用 importlib。