Python包中__init__.py檔案的作用與用法範例詳解

前言

在Python工程中，我們經常可以看到帶有“__init__.py”檔案的目錄，在PyCharm中，帶有這個檔案的目錄被認為是Python的包目錄，與目錄的圖示有不一樣的顯示。如下圖所示， dir_example是一個空白目錄，圖示是個資料夾圖示，而init_example下有_init__.py檔案，其圖示是一個包。

那麼這個檔案的作用是什麼，我們平時如何使用呢？

一、__init__.py檔案簡介

Python 定義了兩種型別的包，常規包和名稱空間包。常規包是傳統的包，因為它們存在於 Python 3.2 和更早的版本中。一個常規包通常被實現為一個包含__init__.py 檔案的目錄。當一個常規包被匯入時，這個__init__.py檔案被隱式執行，它所定義的物件被繫結到包的名稱空間中。

這是Python官方檔案中對__init__.py檔案的描述，其實它的意思很簡單，就是說Python檔案都是按照目錄當作不同的模組來組織的，這個目錄被認為是Python包目錄，Python會通過搜尋該目錄下的檔案來匯入相關的模組。但是並不是所有的目錄都會被搜尋新增，只有當目錄中包含__init__.py檔案時，這個目錄才會被Python當作是一個包目錄，進而搜尋新增裡面的檔案。這樣做可以讓程式設計者自己控制哪些目錄可以被Python匯入成包。

當某個目錄中包含__init__.py檔案時，Python在引入這個模組之前，會首先執行這個檔案。因此，這個檔案也可以被程式設計者用來控制定義包級別的變數。

綜上所述，__init__.py檔案最主要的作用是2個：

當目錄下包含這個檔案時，Python會將其當作成包目錄，進而可以使用import xx.xx的方式匯入目錄下的檔案或者模組。

使用__init__.py檔案可以控制模組匯入時的變數和內容，便於程式設計者的控制。

下面我們看幾個例子即可。

二、__init__.py檔案的使用案例

2.1、沒有__init__.py檔案的目錄，使用import xx.xx會報錯嗎？

看版本，在較低的版本中（如3.2及以下），沒有__init__.py檔案的目錄不能使用import xx.xx匯入相關模組，但是後面的版本可以。

2.2、在__init__.py檔案中定義變數或者邏輯將在匯入時候被執行

例如，我們有如下的目錄結構：

init_example/ a_pkg/

                                 __init__.py

                                a.py

                   init_test.py

即init_example工程下有個init_test.py檔案和a_pkg目錄，a_pkg目錄下有__init__.py檔案和一個a.py檔案。

我們在a_pkg目錄下的__init__.py檔案定義：

print("Hey, I am a __init__.py file")

那麼，如果我們在init_test.py中內容如下：

from a_pkg import *

執行init_test.py我們可以得到如下結果：

Hey, I am a __init__.py file

因為在from a_pkg import *時候，會首先執行a_pkg目錄下的__init__.py檔案。

2.3、在__init__.py檔案中定義變數或者方法，可以被直接匯入使用

還是上面的目錄，假如我們在a_pkg目錄下的a.py定義如下內容：

def a_method():
        print("I am a_pkg!")

在a_pkg目錄下的__init__.py檔案定義：

from a_pkg.a import a_method

那麼，我們在init_test.py中引入a_pkg可以直接引入a_method方法：

from init_example.a_pkg import a_method a_method()

會列印如下內容：

I am a_pkg!

2.4、在__init__.py檔案中使用__all__方法

__all__方法可以在__init__.py檔案定義一些包或者變數，可以在使用

from init_example.a_pkg import *

時定義*表達的內容。

例如還是上面的內容，但是我們在a_pkg目錄下的__init__.py檔案定義：

__all__ = ["a"]

那麼，我們在init_test.py中使用下面的語句可以引入a模組：

from a_pkg import *
a.a_method()

這時候依然會列印如下內容：

I am a_pkg!

總結

到此這篇關於Python包中__init__.py檔案的作用與用法的文章就介紹到這了,更多相關Python包__init__.py檔案用法內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！