模塊,包介紹
在計算機程序的開發(fā)過程中,隨著程序代碼越寫越多,在一個文件里代碼就會越來越長,越來越不容易維護。
為了編寫可維護的代碼,我們把很多函數(shù)分組,分別放到不同的文件里,這樣,每個文件包含的代碼就相對較少,很多編程語言都采用這種組織代碼的方式。在Python中,一個.py文件就稱之為一個模塊(Module)。
最大的好處是大大提高了代碼的可維護性。其次,編寫代碼不必從零開始。當一個模塊編寫完畢,就可以被其他地方引用。我們在編寫程序的時候,也經(jīng)常引用其他模塊,包括Python內(nèi)置的模塊和來自第三方的模塊。
使用模塊還可以避免函數(shù)名和變量名沖突。相同名字的函數(shù)和變量完全可以分別存在不同的模塊中,因此,我們自己在編寫模塊時,不必考慮名字會與其他模塊沖突。但是也要注意,盡量不要與內(nèi)置函數(shù)名字沖突。
你也許還想到,如果不同的人編寫的模塊名相同怎么辦?為了避免模塊名沖突,Python又引入了按目錄來組織模塊的方法,稱為包(Package)。
舉個例子,一個abc.py
的文件就是一個名字叫abc
的模塊,一個xyz.py
的文件就是一個名字叫xyz
的模塊。
現(xiàn)在,假設我們的abc
和xyz
這兩個模塊名字與其他模塊沖突了,于是我們可以通過包來組織模塊,避免沖突。方法是選擇一個頂層包名,比如mycompany
,按照如下目錄存放:
mycompany
├─ __init__.py
├─ abc.py
└─ xyz.py
引入了包以后,只要頂層的包名不與別人沖突,那所有模塊都不會與別人沖突。現(xiàn)在,abc.py
模塊的名字就變成了mycompany.abc
,類似的,xyz.py
的模塊名變成了mycompany.xyz
。
請注意,每一個包目錄下面都會有一個__init__.py
的文件,這個文件是必須存在的,否則,Python就把這個目錄當成普通目錄,而不是一個包。__init__.py
可以是空文件,也可以有Python代碼,因為__init__.py
本身就是一個模塊,而它的模塊名就是mycompany
。
類似的,可以有多級目錄,組成多級層次的包結(jié)構(gòu)。比如如下的目錄結(jié)構(gòu):
mycompany
├─ web
│ ├─ __init__.py
│ ├─ utils.py
│ └─ www.py
├─ __init__.py
├─ abc.py
└─ utils.py
文件www.py的模塊名就是mycompany.web.www,兩個文件utils.py的模塊名分別是mycompany.utils和mycompany.web.utils。
自己創(chuàng)建模塊時要注意命名,不能和Python自帶的模塊名稱沖突。例如,系統(tǒng)自帶了sys模塊,自己的模塊就不可命名為sys.py,否則將無法導入系統(tǒng)自帶的sys模塊。?。?!
使用模塊
Python本身就內(nèi)置了很多非常有用的模塊,只要安裝完畢,這些模塊就可以立刻使用。我們以內(nèi)建的sys
模塊為例,編寫一個hello
的模塊:
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
' a test module '
__author__ = 'OJay'
import sys
deftest():
args = sys.argv
if len(args)==1:
print('Hello, world!')
elif len(args)==2:
print('Hello, %s!' % args[1])
else:
print('Too many arguments!')
if __name__=='__main__':
test()
第1行和第2行是標準注釋,第1行注釋可以讓這個hello.py
文件直接在Unix/Linux/Mac上運行,第2行注釋表示.py文件本身使用標準UTF-8編碼;
第4行是一個字符串,表示模塊的文檔注釋,任何模塊代碼的第一個字符串都被視為模塊的文檔注釋;
第6行使用__author__
變量把作者寫進去,這樣當你公開源代碼后別人就可以瞻仰你的大名;
以上就是Python模塊的標準文件模板,當然也可以全部刪掉不寫,但是,按標準辦事肯定沒錯。后面開始就是真正的代碼部分。
使用sys模塊的第一步,就是導入該模塊:import sys
導入sys
模塊后,我們就有了變量sys
指向該模塊,利用sys
這個變量,就可以訪問sys
模塊的所有功能。
sys
模塊有一個argv
變量,用list存儲了命令行的所有參數(shù)。argv
至少有一個元素,因為第一個參數(shù)永遠是該.py文件的名稱,例如:
運行python3 hello.py
獲得的sys.argv
就是['hello.py']
;
運行python3 hello.py Michael
獲得的sys.argv
就是['hello.py', 'Michael']
。
注意到最后這兩行代碼:
if __name__=='__main__':
test()
當我們在命令行運行hello模塊文件時,Python解釋器把一個特殊變量__name__置為__main__,而如果在其他地方導入該hello模塊時,if判斷將失敗,因此,這種if測試可以讓一個模塊通過命令行運行時執(zhí)行一些額外的代碼,最常見的就是運行測試。
作用域
在一個模塊中,我們可能會定義很多函數(shù)和變量,但有的函數(shù)和變量我們希望給別人使用,有的函數(shù)和變量我們希望僅僅在模塊內(nèi)部使用。在Python中,是通過_
前綴來實現(xiàn)的。
- 正常的函數(shù)和變量名是公開的(public),可以被直接引用,比如:
abc
,x123
,PI
等; - 類似
__xxx__
這樣的變量是特殊變量,可以被直接引用,但是有特殊用途,比如上面的__author__
,__name__
就是特殊變量; - 類似
_xxx
和__xxx
這樣的函數(shù)或變量就是非公開的(private),不應該被直接引用,比如_abc
,__abc
等。
之所以我們說,private函數(shù)和變量“不應該”被直接引用,而不是“不能”被直接引用,是因為Python并沒有一種方法可以完全限制訪問private函數(shù)或變量,全靠我們程序猿的自覺。private函數(shù)或變量不應該被別人引用,那它們有什么用呢?請看例子:
def _private_1(name):
return 'Hello, %s' % name
def _private_2(name):
return 'Hi, %s' % name
def greeting(name):
if len(name) > 3:
return _private_1(name)
else:
return _private_2(name)
我們在模塊里公開greeting()
函數(shù),而把內(nèi)部邏輯用private函數(shù)隱藏起來了,這樣,調(diào)用greeting()
函數(shù)不用關(guān)心內(nèi)部的private函數(shù)細節(jié),這也是一種非常有用的代碼封裝和抽象的方法,即: 外部不需要引用的函數(shù)全部定義成private,只有外部需要引用的函數(shù)才定義為public。
安裝第三方模塊
在Python中,安裝第三方模塊,是通過包管理工具pip完成的。要安裝一個第三方庫,必須先知道該庫的名稱
pip install XXX
在使用Python時,我們經(jīng)常需要用到很多第三方庫,例如,Pillow,MySQL驅(qū)動程序,Web框架Flask,科學計算Numpy等。用pip一個一個安裝費時費力,還需要考慮兼容性。
推薦直接使用Anaconda,這是一個基于Python的數(shù)據(jù)處理和科學計算平臺,它已經(jīng)內(nèi)置了許多非常有用的第三方庫,我們裝上Anaconda,就相當于把數(shù)十個第三方模塊自動安裝好了,非常簡單易用。
附上其他文章的鏈接:
本文內(nèi)容屬于筆記,大部分內(nèi)容源自 廖雪峰老師的博客, 非常推薦大家去他的網(wǎng)站學習!