python __init__.py 的學(xué)習(xí)（轉(zhuǎn)）

Python雜談: init.py的作用

我們經(jīng)常在python的模塊目錄中會看到 "init.py" 這個文件，那么它到底有什么作用呢逐工？

1. 標(biāo)識該目錄是一個python的模塊包（module package）

如果你是使用python的相關(guān)IDE來進(jìn)行開發(fā)嫉戚，那么如果目錄中存在該文件对嚼，該目錄就會被識別為 module package 机蔗。

2. 簡化模塊導(dǎo)入操作

假設(shè)我們的模塊包的目錄結(jié)構(gòu)如下：

[

復(fù)制代碼

](javascript:void(0); "復(fù)制代碼")

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">.
└── mypackage
├── subpackage_1
│ ├── test11.py
│ └── test12.py
├── subpackage_2
│ ├── test21.py
│ └── test22.py
└── subpackage_3
├── test31.py
└── test32.py</pre>

[

復(fù)制代碼

](javascript:void(0); "復(fù)制代碼")

如果我們使用最直接的導(dǎo)入方式背传，將整個文件拷貝到工程目錄下剩盒，然后直接導(dǎo)入：

[

復(fù)制代碼

](javascript:void(0); "復(fù)制代碼")

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from mypackage.subpackage_1 import test11 from mypackage.subpackage_1 import test12 from mypackage.subpackage_2 import test21 from mypackage.subpackage_2 import test22 from mypackage.subpackage_3 import test31 from mypackage.subpackage_3 import test32</pre>

[

復(fù)制代碼

](javascript:void(0); "復(fù)制代碼")

當(dāng)然這個例子里面文件比較少谷婆，如果模塊比較大，目錄比較深的話辽聊，可能自己都記不清該如何導(dǎo)入纪挎。（很有可能，哪怕只想導(dǎo)入一個模塊都要在目錄中找很久）

這種情況下跟匆，init.py 就很有作用了异袄。我們先來看看該文件是如何工作的。

2.1 init.py 是怎么工作的玛臂？

實際上烤蜕，如果目錄中包含了 init.py 時，當(dāng)用 import 導(dǎo)入該目錄時迹冤，會執(zhí)行 init.py 里面的代碼讽营。

我們在mypackage目錄下增加一個 init.py 文件來做一個實驗：

[

復(fù)制代碼

](javascript:void(0); "復(fù)制代碼")

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">.
└── mypackage
├── init.py
├── subpackage_1
│ ├── test11.py
│ └── test12.py
├── subpackage_2
│ ├── test21.py
│ └── test22.py
└── subpackage_3
├── test31.py
└── test32.py</pre>

[

復(fù)制代碼

](javascript:void(0); "復(fù)制代碼")

mypackage/init.py 里面加一個print，如果執(zhí)行了該文件就會輸出：

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">print("You have imported mypackage")</pre>

下面直接用交互模式進(jìn)行 import

很顯然叁巨，init.py 在包被導(dǎo)入時會被執(zhí)行斑匪。

2.2 控制模塊導(dǎo)入

我們再做一個實驗，在 mypackage/init.py 添加以下語句：

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from subpackage_1 import test11</pre>

我們導(dǎo)入 mypackage 試試:

[

復(fù)制代碼

](javascript:void(0); "復(fù)制代碼")

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">>>> import mypackage
Traceback (most recent call last):
File "<stdin>", line 1, in <module> File "/home/taopeng/Workspace/Test/mypackage/init.py", line 2, in <module>
from subpackage_1 import test11
ImportError: No module named 'subpackage_1'</pre>

[

復(fù)制代碼

](javascript:void(0); "復(fù)制代碼")

報錯了。蚀瘸。狡蝶。怎么回事？

原來贮勃，在我們執(zhí)行import時贪惹，當(dāng)前目錄是不會變的（就算是執(zhí)行子目錄的文件），還是需要完整的包名寂嘉。

綜上奏瞬，我們可以在init.py 指定默認(rèn)需要導(dǎo)入的模塊

2.3 偷懶的導(dǎo)入方法

有時候我們在做導(dǎo)入時會偷懶，將包中的所有內(nèi)容導(dǎo)入

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">from mypackage import *</pre>

這是怎么實現(xiàn)的呢泉孩？ **all **變量就是干這個工作的硼端。

all 關(guān)聯(lián)了一個模塊列表，當(dāng)執(zhí)行** from xx import * **時寓搬，就會導(dǎo)入列表中的模塊珍昨。我們將 init.py 修改為。

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">all = ['subpackage_1', 'subpackage_2']</pre>

這里沒有包含 subpackage_3句喷，是為了證明 **all **起作用了镣典，而不是導(dǎo)入了所有子目錄。

[

復(fù)制代碼

](javascript:void(0); "復(fù)制代碼")

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">>>> from mypackage import *

dir()
['builtins', 'doc', 'loader', 'name', 'package', 'spec', 'subpackage_1', 'subpackage_2'] >>>
dir(subpackage_1)
['doc', 'loader', 'name', 'package', 'path', 'spec']</pre>

[

復(fù)制代碼

](javascript:void(0); "復(fù)制代碼")

子目錄的中的模塊沒有導(dǎo)入Ｍ偾怼Ｐ执骸！

該例子中的導(dǎo)入等價于

因此锡溯，導(dǎo)入操作會繼續(xù)查找 subpackage_1 和 subpackage_2 中的 init.py 并執(zhí)行赶舆。（但是此時不會執(zhí)行** import ***）

我們在 subpackage_1 下添加 init.py 文件:

再來導(dǎo)入試試

[

復(fù)制代碼

](javascript:void(0); "復(fù)制代碼")

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">>>> from mypackage import *

dir()
['builtins', 'doc', 'loader', 'name', 'package', 'spec', 'subpackage_1', 'subpackage_2'] >>>
dir(subpackage_1)
['all', 'builtins', 'cached', 'doc', 'file', 'loader', 'name', 'package', 'path', 'spec', 'test11']</pre>

[

復(fù)制代碼

](javascript:void(0); "復(fù)制代碼")

如果想要導(dǎo)入子包的所有模塊，則需要更精確指定趾唱。

<pre style="margin: 0px; padding: 0px; white-space: pre-wrap; overflow-wrap: break-word; font-family: "Courier New" !important; font-size: 12px !important;">>>> from mypackage.subpackage_1 import *

dir()
['builtins', 'doc', 'loader', 'name', 'package', 'spec', 'test11', 'test12']</pre>

3. 配置模塊的初始化操作

在了解了 init.py 的工作原理后涌乳，應(yīng)該能理解該文件就是一個正常的python代碼文件。

因此可以將初始化代碼放入該文件中甜癞。

python init.py 的學(xué)習(xí)（轉(zhuǎn)）

python init.py 的學(xué)習(xí)（轉(zhuǎn)）

Python雜談: init.py的作用

1. 標(biāo)識該目錄是一個python的模塊包（module package）

2. 簡化模塊導(dǎo)入操作

2.1 init.py 是怎么工作的玛臂？

2.2 控制模塊導(dǎo)入

2.3 偷懶的導(dǎo)入方法

3. 配置模塊的初始化操作