理解python中的if __name__ == '__main__'
1.摘要
通俗的理解:假如你叫小明的.py,在朋友眼中,你是小明;在你自己眼中,你是你自己。name == 'main'
(name == '小明')
(name == 'main')
if name == 'main'
的意思是:當的.py檔案被直接執行時,之下的程式碼塊將被執行;當的.py檔案以模組形式被匯入時,之下的程式碼塊不被執行。if name == 'main'
if name == 'main'
2.程式入口
對於很多程式語言來說,程式都必須要有一個入口,比如C,C ++,以及完全面向物件的程式語言的Java,C#等。如果你接觸過這些語言,對於程式入口這個概念應該很好理解,C ,C ++都需要有一個主函式作為程式的入口,也就是程式的執行會從主函式開始。同樣,Java和C#必須要有一個包含主要方法的主類,作為程式入口。
而Python的則不同,它屬於指令碼語言,不像編譯型語言那樣先將程式編譯成二進位制再執行,而是動態的逐行解釋執行。也就是從指令碼第一行開始執行,沒有統一的入口。
一個Python的原始碼檔案(的.py)除了可以被直接執行外,還可以作為模組(也就是庫),被其他的.py檔案匯入。不管是直接執行還是被匯入,的.py檔案的最頂層程式碼都會被執行(Python的用縮排來區分程式碼層次),而當一個的.py檔案作為模組被匯入時,我們可能不希望一部分程式碼被執行。
2.1一個.py檔案被其他.py檔案引用
假設我們有一個const.py檔案,內容如下:
<span style="color:#737373"><code class="language-python">PI = 3.14 def main(): print("PI:", PI) main() # 執行結果:PI: 3.14</code></span>
- 1
- 2
- 3
- 4
- 五
- 6
- 7
- 8
現在,我們寫一個用於計算圓面積的area.py檔案,area.py檔案需要用到const.py檔案中的PI變數從const.py中,我們把PI變數匯入area.py:
<span style="color:#737373"><code>from const import PI def calc<em>round<em>area</em></em><em><em>(radius):</em></em><em><em> return PI <em> (radius *</em> 2) def main(): print("round area: ", calc<em>round<em>area(2)) main() ''' 執行結果: PI: 3.14 round area: 12.56 '''</em></em></em></em></code></span>
- 1
- 2
- 3
- 4
- 五
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
2.2修改const.py,新增if name == "main"
我們看到const.py中的主要函式也被運行了,實際上我們不希望它被執行,因為const.py提供的主函式只是為了測試常量定義。這時派上了用場,我們把const.py改一下,新增:if name == 'main'
if name == "main"
<em><em><em><code class="language-python">PI = 3.14
def main():
print("PI:", PI)
if <strong>name</strong> == "<strong>main</strong>":
main()</code></em></em></em>
- 1
- 2
- 3
- 4
- 五
- 6
- 7
執行const.py,輸出如下:
<em><em><em><code class="language-python">PI: 3.14</code></em></em></em>
- 1
執行area.py,輸出如下:
<em><em><em><code class="language-python">round area: 12.56</code></em></em></em>
- 1
如上,可以我們看到相當於Python的模擬的程式入口,Python的本身並沒有這麼規定,這只是一種編碼習慣。由於模組之間相互引用,不同模組可能有這樣的定義,而程式入口只有一個到底。哪個程式入口被選中,取決於這的值。if name == 'main'
name
3。 name
3.1 name
反映一個包的結構
name
是內建變數,可用於反映一個包的結構假設我們有一個包一,包的結構如下:
<em><em><em><code>a
├── b
│ ├── c.py
│ └── <strong>init</strong>.py
└── <strong>init</strong>.py</code></em></em></em>
- 1
- 2
- 3
- 4
- 五
在包一中,檔案的內容都為:c.py,init.py,init.py
<em><em><em><code class="language-python">print(<strong>name</strong>)</code></em></em></em>
- 1
當一個檔案的.py(模組)被其他的.py檔案(模組)匯入時,我們在命令列執行
<em><em><em><code class="language-shell">python -c "import a.b.c"</code></em></em></em>
- 1
輸出結果:
<em><em><em><code>a
a.b
a.b.c</code></em></em></em>
- 1
- 2
- 3
由此可見,name
可以清晰地反映一個模組在包中的層次。
3.2 name
表示當前模組的名字
name
是內建變數,可用於表示當前模組的名字。我們直接執行一個的.py檔案(模組)
<em><em><em><code>python a/b/c.py</code></em></em></em>
- 1
輸出結果:
<em><em><em><code><strong>main</strong></code></em></em></em>
- 1
由此我們可知:如果一個的.py檔案(模組)被直接執行時,則其沒有包結構,其name
值為main
,即模組名為main
。
所以,的意思是:當的.py檔案被直接執行時,之下的程式碼塊將被執行;當的.py檔案以模組形式被匯入時,之下的程式碼塊不被執行。if name == 'main'
if name == 'main'
if name == 'main'
4. main.py
檔案與python -m
Python中的-m引數用於將一個模組或者包作為一個指令碼執行,而main.py
檔案相當於是一個包的“入口程式“。
4.1執行Python程式的兩種方式
python xxx.py
,直接執行xxx.py檔案python -m xxx.py
,把xxx.py當做模組執行
假設我們有一個檔案run.py,內容如下:
<em><em><em><code>import sys
print(sys.path)</code></em></em></em>
- 1
- 2
- 3
我們用直接執行的方式啟動
<em><em><em><code>python run.py</code></em></em></em>
- 1
輸出結果(為了說明問題,輸出結果只截取了重要部分,下同):
<em><em><em><code>['/home/huoty/aboutme/pythonstudy/main', ...]</code></em></em></em>
- 1
然後以模組的方式執行:
<em><em><em><code class="language-shell">python -m run.py</code></em></em></em>
- 1
輸出內容
<em><em><em><code>['', ...]
/usr/bin/python: No module named run.py</code></em></em></em>
- 1
- 2
由於輸出結果只列出了關鍵的部分,應該很容易看出他們之間的差異:
-
直接執行方式是把run.py檔案所在的目錄放到了sys.path的屬性中
-
以模組方式執行是把你輸入命令的目錄(也就是當前工作路徑),放到了sys.path屬性中。
以模組方式執行還有一個不同的地方:多出了一行No module named run.py
。的錯誤實際上以模組方式執行時,巨蟒先對run.py執行一遍進口,所以print(sys.path)
被成功執行,然後Python中才嘗試執行run.py模組,但是在路徑變數中並沒有run.py這個模組,所以報錯。正確的執行方式,應該是python -m run
。
4.2 main.py
的作用
仍然先看例子,假設我們有如下一個包封裝:
<em><em><em><code>package
├── <strong>init</strong>.py
└── <strong>main</strong>.py</code></em></em></em>
- 1
- 2
- 3
其中,檔案init.py
的內容
<em><em><em><code>import sys
print("<strong>init</strong>")
print(sys.path)</code></em></em></em>
- 1
- 2
- 3
- 4
其中,檔案main.py
的內容
<em><em><em><code>import sys
print("<strong>main</strong>")
print(sys.path)</code></em></em></em>
- 1
- 2
- 3
- 4
接下來,我們執行這個包,使用python -m package
執行,輸出結果:
<em><em><em><code><strong>init</strong>
['', ...]
<strong>main</strong>
['', ...]</code></em></em></em>
- 1
- 2
- 3
- 4
- 五
使用python package
執行,輸出結果:
<em><em><em><code><strong>main</strong>
['package', ...]</code></em></em></em>
- 1
- 2
總結一下
-
當加上-m引數時,Python的會把當前工作目錄新增到sys.path中中;而不加-m時,Python中則會把指令碼所在目錄新增到sys.path中中。
-
當加上-m引數時,巨蟒會先將模組或者包匯入,然後再執行。
-
__main
.py
檔案是一個包或者目錄的入口程式。的英文不管用python package
還是用python -m package
執行,__main
.py
檔案總是被執行。