深入理解 Python 中的 init.py
更新日期： 2024 年 10 月 11 日
在 Python 編程中，模組（Module） 和 套件（Package） 是組織和管理程式碼的基本單位。
當你開始構建更大、更複雜的專案時，瞭解如何使用模組和套件來組織程式碼是至關重要的。
在這個過程中，__init__.py 文件扮演了關鍵的角色。
本文將為新手詳細介紹 Python 中的 __init__.py 文件，解釋其作用和用法，並提供實際的示例。
什麼是 __init__.py？
__init__.py 是一個特殊的 Python 文件，位於套件目錄中。
它的存在告訴 Python，該目錄應被視為一個套件，而非普通的資料夾。
自 Python 3.3 起，即使目錄中沒有 __init__.py，Python 也能將其視為套件（稱為「隱式套件」）。
然而，為了兼容性和明確性，建議在套件目錄中添加 __init__.py 文件。
為什麼需要 __init__.py？
- 標識套件：
__init__.py文件的主要作用是標識包含它的目錄是一個 Python 套件。 - 初始化代碼：可以在
__init__.py中編寫初始化代碼，在匯入套件時自動執行。 - 控制匯出行為：使用
__all__列表定義套件匯入時的默認成員。 - 組織命名空間：可以在
__init__.py中導入子模組，方便使用。
創建套件與 __init__.py
範例套件結構
假設我們想創建一個名為 my_package 的套件，包含以下結構：
my_package/
├── __init__.py
├── module_a.py
└── module_b.py__init__.py：套件初始化文件。module_a.py：模組 A。module_b.py：模組 B。
創建模組
module_a.py：
def func_a():
print("這是 module_a 中的 func_a")module_b.py：
def func_b():
print("這是 module_b 中的 func_b")編寫 __init__.py
__init__.py 文件可以是空的，但我們也可以在其中進行一些設置。
空的 __init__.py
# 空文件這種情況下，my_package 只是單純地標識為一個套件。
在 __init__.py 中導入模組
我們可以在 __init__.py 中導入套件內的模組，以便在匯入套件時可以直接使用模組中的內容。
# my_package/__init__.py
from .module_a import func_a
from .module_b import func_b使用套件與 __init__.py
匯入套件
在主程式中，我們可以這樣匯入並使用套件：
# main.py
import my_package
my_package.func_a() # 輸出：這是 module_a 中的 func_a
my_package.func_b() # 輸出：這是 module_b 中的 func_b注意：由於我們在 __init__.py 中導入了 func_a 和 func_b，因此可以直接使用 my_package.func_a() 的方式調用。
匯入特定函式
也可以使用 from...import 語句：
from my_package import func_a
func_a() # 輸出：這是 module_a 中的 func_a使用 __all__ 控制匯出內容
在 __init__.py 中，我們可以使用 __all__ 列表來定義當使用 from my_package import * 時，哪些模組或函式會被匯入。
# my_package/__init__.py
__all__ = ['func_a']
from .module_a import func_a
from .module_b import func_b此時，在主程式中：
from my_package import *
func_a() # 可以使用
func_b() # NameError: name 'func_b' is not defined__init__.py 的其他用途
初始化代碼
__init__.py 中的代碼會在套件被匯入時自動執行，可以用於初始化套件所需的資源。
# my_package/__init__.py
print("初始化 my_package 套件")當匯入套件時，會輸出：
初始化 my_package 套件設定套件級別的變數或函式
可以在 __init__.py 中定義全局變數、函式或類，供套件的使用者直接使用。
# my_package/__init__.py
from .module_a import func_a
from .module_b import func_b
def package_func():
print("這是 my_package 套件中的函式")使用：
import my_package
my_package.package_func() # 輸出：這是 my_package 套件中的函式子套件與多層次套件
__init__.py 也適用於子套件的情況。
套件結構
my_package/
├── __init__.py
├── sub_package/
│ ├── __init__.py
│ └── module_c.py
├── module_a.py
└── module_b.pysub_package/module_c.py：
def func_c():
print("這是 module_c 中的 func_c")使用子套件
匯入子套件中的模組：
from my_package.sub_package import module_c
module_c.func_c() # 輸出：這是 module_c 中的 func_c或者在 sub_package/__init__.py 中導入：
# my_package/sub_package/__init__.py
from .module_c import func_c然後在主程式中：
from my_package.sub_package import func_c
func_c() # 輸出：這是 module_c 中的 func_c__init__.py 在 Python 3.3 之後的變化
自 Python 3.3 起，即使目錄中沒有 __init__.py 文件，Python 也能將其視為套件，這稱為「隱式套件」。
然而，為了兼容性和明確性，建議始終在套件目錄中包含 __init__.py 文件。
為什麼仍然需要 __init__.py？
- 明確性：明確指出該目錄是 Python 套件，增加程式碼的可讀性。
- 向後兼容：在較舊版本的 Python 中，沒有
__init__.py的目錄不被視為套件。 - 控制匯出行為：可以使用
__all__和初始化代碼等功能。
注意事項
- 避免在
__init__.py中執行過多代碼：__init__.py中的代碼會在匯入時執行，過多的代碼可能影響性能。 - 使用相對匯入：在套件內部，使用相對匯入（如
from .module_a import func_a）可以提高模組的可重用性。 - 管理命名空間：通過在
__init__.py中導入模組和函式，可以簡化套件的使用方式。
總結
__init__.py 是 Python 套件中重要的組成部分，負責標識套件、初始化套件、控制匯出行為等功能。
通過合理地使用 __init__.py，你可以更好地組織程式碼，提升專案的可維護性和可讀性。
希望通過本文的介紹，你能夠深入理解 __init__.py 的作用，並在實際開發中靈活運用。
進一步學習
- 官方文檔：Python 模組和套件
- 學習虛擬環境：瞭解如何使用
venv或virtualenv來管理專案的依賴和環境。 - 包的發佈：學習如何將自己的套件發佈到 PyPI，供他人安裝和使用。