1. python主函數怎麼寫
一般來說,Python程序員可能是這樣寫main()函數的:
"""Mole docstring.
This serves as a long usage message.
"""import sysimport getoptdef main():
# parse command line options
try:
opts, args = getopt.getopt(sys.argv[1:], "h", ["help"]) except getopt.error, msg: print msg print "for help use --help"
sys.exit(2) # process options
for o, a in opts: if o in ("-h", "--help"): print __doc__
sys.exit(0) # process arguments
for arg in args:
process(arg) # process() is defined elsewhereif __name__ == "__main__":
main()
Guido也承認之前自己寫的main()函數也是類似的結構,但是這樣寫的靈活性還不夠高,尤其是需要解析復雜的命令行選項時。為此,他向大家提出了幾點建議。
添加可選的 argv 參數
首先,修改main()函數,使其接受一個可選參數 argv,支持在互動式shell中調用該函數:
def main(argv=None):
if argv is None:
argv = sys.argv # etc., replacing sys.argv with argv in the getopt() call.1234
這樣做,我們就可以動態地提供 argv 的值,這比下面這樣寫更加的靈活:
def main(argv=sys.argv):
# etc.12
這是因為在調用函數時,sys.argv 的值可能會發生變化;可選參數的默認值都是在定義main()函數時,就已經計算好的。
但是現在sys.exit()函數調用會產生問題:當main()函數調用sys.exit()時,互動式解釋器就會推出!解決辦法是讓main()函數的返回值指示退出狀態(exit status)。因此,最後面的那行代碼就變成了這樣:
if __name__ == "__main__":
sys.exit(main())12
並且,main()函數中的sys.exit(n)調用全部變成return n。
定義一個Usage()異常
另一個改進之處,就是定義一個Usage()異常,可以在main()函數最後的except子句捕捉該異常:
import sysimport getoptclass Usage(Exception):
def __init__(self, msg):
self.msg = msgdef main(argv=None):
if argv is None:
argv = sys.argv try: try:
opts, args = getopt.getopt(argv[1:], "h", ["help"]) except getopt.error, msg: raise Usage(msg) # more code, unchanged
except Usage, err: print >>sys.stderr, err.msg print >>sys.stderr, "for help use --help"
return 2if __name__ == "__main__":
sys.exit(main())
這樣main()函數就只有一個退出點(exit)了,這比之前兩個退出點的做法要好。而且,參數解析重構起來也更容易:在輔助函數中引發Usage的問題不大,但是使用return 2卻要求仔細處理返回值傳遞的問題。
2. 編寫測試用例的代碼時,經常會使用到函數, 那麼Python中函數是什麼 有什麼作用 如何使用 使用流程如何
簡言之,函數即包含一個功能的代碼塊。所有編程語言中,函數的定義都是通用的,不止python。
函數可以被重復使用,減少代碼冗餘。
編程中對函數的使用成為「調用」,可以單獨使用也可以直接用在計算中。簡言之,可以把函數當作一個返回值使用。
使用流程。舉個例子。這里有個求兩個數和的函數。你把你要求和的兩個數給函數,函數給你返回和。
3. Python其實很簡單 第十二章 函數與變數的作用域
在前面已經多次提到函數這個概念,之所以沒有解釋什麼是函數,是因為程序中的函數和數學中的函數差不多,如input()、range()等都是函數,這些都是Python的標准函數,直接使用就可以了。根據需要,用戶也可以自定義函數。
12.1 函數
函數的結構:
def 函數名(參數):
函數體
return 返回值
例如:數學中的函數f(x)=2x+5在Python中可以定義如下:
def f(x):
y=2*x+5
return(y)
如果x取值為3,可以使用如下語句調用函數:
f(3)
下面給出完整的程序代碼:
def f(x):
y=2*x+5
return(y)
res=f(3)
print(res)
運行結果:11
如上例中的x是函數f(x)的參數,有時也被稱為形式參數(簡稱形參),在函數被調用時,x被具體的值3替換y就是函數的返回值,這個值3也被稱為實際參數(簡稱實參)。
上例中的y是函數f(x)的返回值。並不是所有的函數都有參數和返回值。如下面的函數:
def func():
print('此為無參數傳遞、無返回值的函數')
func()
輸出結果:此為無參數傳遞、無返回值的函數
可以看出,該函數func()無參數,故調用時不用賦給參數值。
函數也可以有多個參數,如f(x,y)=x²+y²,可用Python語言定義如下:
def f(x,y):
z=x**2+y**2
return z
print(f(2,3)) #調用函數f(x,y)
輸出結果:13
也可以通過直接給參數列表中的參數賦值的方法,為參數添加默認值,如果用戶賦予參數值,則按照用戶賦值執行,否則使用默認值。例如:
def f(x,y=3):
z=x**2+y**2
return z
若調用時參數列表為(2,1),即x賦值為2,y賦值為1:
print(f(2,1))
輸出結果為:5
若調用時參數列表為(2),即x賦值為2,y賦值省缺,則y使用默認值:
print(f(2))
輸出結果為:13
回調函數,又稱函數回調,是將函數作為另一函數的參數。
例如:
def func(fun,m,n):
fun(m,n)
def f_add(m,n):
print('m+n=',m+n)
def f_mult(m,n):
print('m*n=',m*n)
func(f_add,2,3)
func(f_mult,2,3)
輸出結果:
m+n= 5
m*n= 6
在f_add(m,n)和f_mult(m,n)被定義前,func(fun,m,n)中的fun(m,n)就已經調用了這兩個函數,即「先調用後定義」,這也是回調函數的特點。
如果無法預知參數的個數,可以在參數前面加上*號,這種參數實際上對應元組類型。譬如,參會的人數事先不能確定,只能根據與會人員名單輸入:
def func(*names):
print('今天與會人員有:')
for name in names:
print(name)
func('張小兵','陳曉梅','李大海','王長江')
運行後,輸出結果為:
今天與會人員有:
張小兵
陳曉梅
李大海
王長江
參數為字典類型,需要在參數前面加上**號。
def func(**kwargs):
for i in kwargs:
print(i,kwargs[i])
func(a='a1',b='b1',c='c1')
輸出結果為:
a a1
b b1
c c1
一個有趣的實例:
def func(x,y,z,*args,**kwargs):
print(x,y,z)
print(args)
print(kwargs)
func('a','b','c','Python','is easy',py='python',j='java',ph='php')
輸出結果:
a b c # 前三個實參賦給前三個形參
('Python', 'is easy') # *args接收元組數據
{'py': 'python', 'j': 'java', 'ph': 'php'} # **kwargs接收字典數據
12.2 變數的作用域
變數的作用域即變數的有效范圍,可分為全局變數和局部變數。
局部變數
在函數中定義的變數就是局部變數,局部變數的作用域僅限於函數內部使用。
全局變數
在主程序中定義的變數就是全局變數,但在函數中用關鍵字global修飾的變數也可以當做全局變數來使用。
全局變數的作用域是整個程序,也就是說,全局變數可以在整個程序中可以訪問。
下面通過實例去討論:
程序1:
a=1 # a為全局變數
def a_add():
print('a的初值:',a) # 在函數中讀取a的值
a_add() # 調用函數a_add()
a+=1 # 主程序語句,a增加1
print('a現在的值是:',a) # 主程序語句,讀取a的值
運行結果:
a的初值: 1
a現在的值是: 2
這個結果和我們想像的一樣,全局變數a既可以在主程序中讀取,也可以在子程序(函數)中讀取。
程序2:
a=1
def a_add():
a+=1
print('a的初值:',a)
a_add()
print('a現在的值是:',a)
運行程序1時出現如下錯誤提示:
UnboundLocalError: local variable 'a' referenced before assignment
意思是:局部變數'a'在賦值之前被引用。
從語法上來講,該程序沒有錯誤。首先定義了一個全局變數a並賦值為1,又定義了一個函數a_add(),函數內的語句a+=1就是出錯的根源,雖然我們的初衷是想讓全局變數a的值增加1,但從錯誤提示看,這個語句中的a並不是全局變數,而是局部變數。看來,在函數中讀取全局變數的值是沒有問題的(在程序1中已經得到了驗證),但要在函數中改變全局變數的值是不行的(在程序2的錯誤提示a+=1中的a 是局部變數,而非全局變數)。
怎樣解決這個問題?
程序3:
a=1
def a_add(x):
x+=1
return x
print('a的初值:',a)
a=a_add(a)
print('a現在的值是:',a)
運行結果:
a的初值: 1
a現在的值是: 2
結果的確是正確的,但在函數a_add(x)中沒有調用變數a(沒有出現變數a)。
程序4:
a=1
def a_add(a):
a+=1
return a
print('a的初值:',a)
a=a_add(a)
print('a現在的值是:',a)
運行結果:
a的初值: 1
a現在的值是: 2
對比程序4和程序3不難發現,其實程序4隻是簡單的把函數的參數x變成了a,這個a的實質和程序3中的x還是一樣的。這進一步證實,函數中的a是局部變數,與主程序的全局變數a有著本質的區別。
程序5:
a=1
def a_add():
global a
a+=1
print('a的初值:',a)
a_add()
print('a現在的值是:',a)
運行結果:
a的初值: 1
a現在的值是: 2
程序5和程序2相比較,僅僅是在函數中添加了一個定義「global a」,此時的局部變數a就可以當做全局變數使用,由於它和全局變數a同名,自然也就不用區分a究竟是全局變數還是局部變數了,在主程序和該函數內都可以訪問、修改變數a的值了。
雖然使用global可使變數使用起來非常方便,但也容易引起混淆,故在使用過程中還是謹慎為好。
12.3 函數的遞歸與嵌套
遞歸,就是函數調用它自身。遞歸必須設置停止條件,否則函數將無法終止,形成死循環。
以計算階乘為例:
def func(n):
if n==1:
return 1
else:
return n*func(n-1) #func( )調用func( )
print(func(5))
運行結果為:120
嵌套,指在函數中調用另外的函數。這是程序中常見的一種結構,在此不再贅述。
匿名函數
Python中可以在參數前加上關鍵字lambda定義一個匿名函數,這樣的函數一般都屬於「一次性」的。
例如:
程序1:這是一個常規的函數定義和調用。
def f_add(x,y):
return x+y
print(f_add(2,3))
輸出結果:5
程序2:使用lambda定義匿名函數。
f_add=lambda x,y:x+y
print(f_add(2,3))
輸出結果:5
從上面的代碼可以看出,使用lambda僅僅減少了一行代碼。f_add=lambda x,y:x+y中的f_add不是變數名,而是函數名。程序1和程序2的print( )語句中的參數都是一樣的——調用函數f_add( )。所以,匿名函數並沒有太多的優點。
4. python中的函數是什麼
Python3 函數
函數是組織好的,可重復使用的,用來實現單一,或相關聯功能的代碼段。
函數能提高應用的模塊性,和代碼的重復利用率。你已經知道Python提供了許多內建函數,比如print()。但你也可以自己創建函數,這被叫做用戶自定義函數。
定義一個函數
你可以定義一個由自己想要功能的函數,以下是簡單的規則:
函數代碼塊以def關鍵詞開頭,後接函數標識符名稱和圓括弧()。
任何傳入參數和自變數必須放在圓括弧中間,圓括弧之間可以用於定義參數。
函數的第一行語句可以選擇性地使用文檔字元串—用於存放函數說明。
函數內容以冒號:起始,並且縮進。
return [表達式]結束函數,選擇性地返回一個值給調用方,不帶表達式的 return 相當於返回 None。
語法
Python 定義函數使用 def 關鍵字,一般格式如下:
默認情況下,參數值和參數名稱是按函數聲明中定義的順序匹配起來的。
實例
讓我們使用函數來輸出"Hello World!":
#!/usr/bin/python3
defhello():
print("Hello World!")
hello()
更復雜點的應用,函數中帶上參數變數:
實例(Python 3.0+)
比較兩個數,並返回較大的數:
#!/usr/bin/python3
def max(a, b): if a > b: return a
else: return b
a = 4b = 5print(max(a, b))
以上實例輸出結果:
實例(Python 3.0+)
計算面積函數:
#!/usr/bin/python3
# 計算面積函數def area(width, height): return width * height
def print_welcome(name): print("Welcome", name)
print_welcome("Runoob")w = 4h = 5print("width =", w, " height =", h, " area =", area(w, h))
以上實例輸出結果:
函數調用
定義一個函數:給了函數一個名稱,指定了函數里包含的參數,和代碼塊結構。
這個函數的基本結構完成以後,你可以通過另一個函數調用執行,也可以直接從 Python 命令提示符執行。
如下實例調用了printme()函數:
實例(Python 3.0+)
#!/usr/bin/python3
# 定義函數def printme( str ): # 列印任何傳入的字元串
print (str)
return
# 調用函數printme("我要調用用戶自定義函數!")printme("再次調用同一函數")
以上實例輸出結果:
參數傳遞
在 python 中,類型屬於對象,變數是沒有類型的:
以上代碼中,[1,2,3]是 List 類型,"Runoob"是 String 類型,而變數 a 是沒有類型,她僅僅是一個對象的引用(一個指針),可以是指向 List 類型對象,也可以是指向 String 類型對象。
可更改(mutable)與不可更改(immutable)對象
在 python 中,strings, tuples, 和 numbers 是不可更改的對象,而 list,dict 等則是可以修改的對象。
不可變類型:變數賦值a=5後再賦值a=10,這里實際是新生成一個 int 值對象 10,再讓 a 指向它,而 5 被丟棄,不是改變 a 的值,相當於新生成了 a。
可變類型:變數賦值la=[1,2,3,4]後再賦值la[2]=5則是將 list la 的第三個元素值更改,本身la沒有動,只是其內部的一部分值被修改了。
python 函數的參數傳遞:
不可變類型:類似 C++ 的值傳遞,如 整數、字元串、元組。如 fun(a),傳遞的只是 a 的值,沒有影響 a 對象本身。如果在 fun(a))內部修改 a 的值,則是新生成來一個 a。
可變類型:類似 C++ 的引用傳遞,如 列表,字典。如 fun(la),則是將 la 真正的傳過去,修改後 fun 外部的 la 也會受影響
python 中一切都是對象,嚴格意義我們不能說值傳遞還是引用傳遞,我們應該說傳不可變對象和傳可變對象。
python 傳不可變對象實例
通過id()函數來查看內存地址變化:
實例(Python 3.0+)
def change(a): print(id(a)) # 指向的是同一個對象
a=10
print(id(a)) # 一個新對象
a=1print(id(a))change(a)
以上實例輸出結果為:
可以看見在調用函數前後,形參和實參指向的是同一個對象(對象 id 相同),在函數內部修改形參後,形參指向的是不同的 id。
傳可變對象實例
可變對象在函數里修改了參數,那麼在調用這個函數的函數里,原始的參數也被改變了。例如:
實例(Python 3.0+)
#!/usr/bin/python3
# 可寫函數說明def changeme( mylist ): "修改傳入的列表"
mylist.append([1,2,3,4])
print ("函數內取值: ", mylist)
return
# 調用changeme函數mylist = [10,20,30]changeme( mylist )print ("函數外取值: ", mylist)
傳入函數的和在末尾添加新內容的對象用的是同一個引用。故輸出結果如下:
參數
以下是調用函數時可使用的正式參數類型:
必需參數
關鍵字參數
默認參數
不定長參數
必需參數
必需參數須以正確的順序傳入函數。調用時的數量必須和聲明時的一樣。
調用 printme() 函數,你必須傳入一個參數,不然會出現語法錯誤:
實例(Python 3.0+)
#!/usr/bin/python3
#可寫函數說明def printme( str ): "列印任何傳入的字元串"
print (str)
return
# 調用 printme 函數,不加參數會報錯printme()
以上實例輸出結果:
關鍵字參數
關鍵字參數和函數調用關系緊密,函數調用使用關鍵字參數來確定傳入的參數值。
使用關鍵字參數允許函數調用時參數的順序與聲明時不一致,因為 Python 解釋器能夠用參數名匹配參數值。
以下實例在函數 printme() 調用時使用參數名:
實例(Python 3.0+)
#!/usr/bin/python3
#可寫函數說明def printme( str ): "列印任何傳入的字元串"
print (str)
return
#調用printme函數printme( str = "菜鳥教程")
以上實例輸出結果:
以下實例中演示了函數參數的使用不需要使用指定順序:
實例(Python 3.0+)
#!/usr/bin/python3
#可寫函數說明def printinfo( name, age ): "列印任何傳入的字元串"
print ("名字: ", name)
print ("年齡: ", age)
return
#調用printinfo函數printinfo( age=50, name="runoob" )
以上實例輸出結果:
默認參數
調用函數時,如果沒有傳遞參數,則會使用默認參數。以下實例中如果沒有傳入 age 參數,則使用默認值:
實例(Python 3.0+)
#!/usr/bin/python3
#可寫函數說明def printinfo( name, age = 35 ): "列印任何傳入的字元串"
print ("名字: ", name)
print ("年齡: ", age)
return
#調用printinfo函數printinfo( age=50, name="runoob" )print ("------------------------")printinfo( name="runoob" )
以上實例輸出結果:
不定長參數
你可能需要一個函數能處理比當初聲明時更多的參數。這些參數叫做不定長參數,和上述 2 種參數不同,聲明時不會命名。基本語法如下:
加了星號*的參數會以元組(tuple)的形式導入,存放所有未命名的變數參數。
實例(Python 3.0+)
#!/usr/bin/python3
# 可寫函數說明def printinfo( arg1, *vartuple ): "列印任何傳入的參數"
print ("輸出: ")
print (arg1)
print (vartuple)
# 調用printinfo 函數printinfo( 70, 60, 50 )
以上實例輸出結果:
實例(Python 3.0+)
#!/usr/bin/python3
# 可寫函數說明def printinfo( arg1, *vartuple ): "列印任何傳入的參數"
print ("輸出: ")
print (arg1)
for var in vartuple: print (var)
return
# 調用printinfo 函數printinfo( 10 )printinfo( 70, 60, 50 )
以上實例輸出結果:
還有一種就是參數帶兩個星號**基本語法如下:
加了兩個星號**的參數會以字典的形式導入。
實例(Python 3.0+)
#!/usr/bin/python3
# 可寫函數說明def printinfo( arg1, **vardict ): "列印任何傳入的參數"
print ("輸出: ")
print (arg1)
print (vardict)
# 調用printinfo 函數printinfo(1, a=2,b=3)
以上實例輸出結果:
聲明函數時,參數中星號*可以單獨出現,例如:
如果單獨出現星號*後的參數必須用關鍵字傳入。
匿名函數
python 使用 lambda 來創建匿名函數。
所謂匿名,意即不再使用 def 語句這樣標準的形式定義一個函數。
lambda 只是一個表達式,函數體比 def 簡單很多。
lambda的主體是一個表達式,而不是一個代碼塊。僅僅能在lambda表達式中封裝有限的邏輯進去。
lambda 函數擁有自己的命名空間,且不能訪問自己參數列表之外或全局命名空間里的參數。
雖然lambda函數看起來只能寫一行,卻不等同於C或C++的內聯函數,後者的目的是調用小函數時不佔用棧內存從而增加運行效率。
語法
lambda 函數的語法只包含一個語句,如下:
如下實例:
實例(Python 3.0+)
#!/usr/bin/python3
# 可寫函數說明sum = lambda arg1, arg2: arg1 + arg2
# 調用sum函數print ("相加後的值為 : ", sum( 10, 20 ))print ("相加後的值為 : ", sum( 20, 20 ))
以上實例輸出結果:
return語句
return [表達式]語句用於退出函數,選擇性地向調用方返回一個表達式。不帶參數值的return語句返回None。之前的例子都沒有示範如何返回數值,以下實例演示了 return 語句的用法:
實例(Python 3.0+)
#!/usr/bin/python3
# 可寫函數說明def sum( arg1, arg2 ): # 返回2個參數的和."
total = arg1 + arg2
print ("函數內 : ", total)
return total
# 調用sum函數total = sum( 10, 20 )print ("函數外 : ", total)
以上實例輸出結果:
強制位置參數
Python3.8 新增了一個函數形參語法 / 用來指明函數形參必須使用指定位置參數,不能使用關鍵字參數的形式。
以下使用方法是正確的:
以下使用方法會發生錯誤:
5. Python中定義函數的使用方法
4.6. 定義函數
我們可以創建一個用來生成指定邊界的斐波那契數列的函數:
>>> def fib(n): # write Fibonacci series up to n
... """Print a Fibonacci series up to n."""
... a, b = 0, 1
... while a < n:
... print(a, end=' ')
... a, b = b, a+b
... print()
...
>>> # Now call the function we just defined:
... fib(2000)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597
關鍵字 def 引入了一個函數 定義。在其後必須跟有函數名和包括形式參數的圓括弧。函數體語句從下一行開始,必須是縮進的。
函數體的第一行語句可以是可選的字元串文本,這個字元串是函數的文檔字元串,或者稱為 docstring。(更多關於 docstrings 的信息請參考 文檔字元串) 有些工具通過 docstrings 自動生成在線的或可列印的文檔,或者讓用戶通過代碼交互瀏覽;在你的代碼中包含 docstrings 是一個好的實踐,讓它成為習慣吧。
函數 調用 會為函數局部變數生成一個新的符號表。確切的說,所有函數中的變數賦值都是將值存儲在局部符號表。變數引用首先在局部符號表中查找,然後是包含函數的局部符號表,然後是全局符號表,最後是內置名字表。因此,全局變數不能在函數中直接賦值(除非用 global 語句命名),盡管他們可以被引用。
函數引用的實際參數在函數調用時引入局部符號表,因此,實參總是 傳值調用 (這里的 值 總是一個對象 引用 ,而不是該對象的值)。[1] 一個函數被另一個函數調用時,一個新的局部符號表在調用過程中被創建。
一個函數定義會在當前符號表內引入函數名。函數名指代的值(即函數體)有一個被 Python 解釋器認定為 用戶自定義函數 的類型。 這個值可以賦予其他的名字(即變數名),然後它也可以被當作函數使用。這可以作為通用的重命名機制:
>>> fib
>>> f = fib
>>> f(100)
0 1 1 2 3 5 8 13 21 34 55 89
如果你使用過其他語言,你可能會反對說:fib 不是一個函數,而是一個方法,因為它並不返回任何值。事實上,沒有 return 語句的函數確實會返回一個值,雖然是一個相當令人厭煩的值(指 None )。這個值被稱為 None (這是一個內建名稱)。如果 None 值是唯一被書寫的值,那麼在寫的時候通常會被解釋器忽略(即不輸出任何內容)。如果你確實想看到這個值的輸出內容,請使用 print() 函數:
6. python3 定義函數
Python 有很多有用的內置函數, 但還是不能滿足程序員的需求, 所以需要 自定義函數 。
如何編寫 自定義函數 , 需要用到 def語句, 函數名, 括弧及參數, 冒號, 函數說明,內置縮進編碼模塊,return 語句 , 其中有一些也可省略不寫,後面會慢慢介紹。
編寫函數不可或缺的元素, 一定都要寫。函數名盡量寫得簡單易懂。
一般是對函數的描述說明。
這是編寫具體的 操作命令 的地方, 如果還未想好如何編寫, 可以使用 pass 來佔位,讓程序可以運行起來,防止調試出錯。
參數放在最後講, 是因為這裡面的東西還是很多的。首先看個例子。
如上的案例都是限制了參數個數的, 最多傳三個參數 name/age/city , 但是如果有一些特例,需要傳多個參數怎麼辦呢。 參數前面加個 * , 變成 可變參數 。
那如果想要傳多個包含名稱的參數,例如a=1,b=2,c=3......,那該怎麼寫呢。參數前面加個 ** , 變成 關鍵字參數 。
7. 用python編寫程序建立函數
每位數字都如上5.是什麼意思?
是加5吧
我把解密函數都給寫出來了
8. python中len函數
Python len() 方法返回字元串長度。
len()方法語法:
len( str )
返回值:
返回字元串長度。
以下實例展示了len()的使用方法:
#!/usr/bin/python
str = "this is string example....wow!!!";
print "字元串長度: ", len(str);
以上實例輸出結果如下:
字元串長度: 32
9. 在Python中定義Main函數
目錄
許多編程語言都有一個特殊的函數,當操作系統開始運行程序時會自動執行該函數。這個函數通常被命名為main(),並且依據語言標准具有特定的返回類型和參數。另一方面,Python解釋器從文件頂部開始執行腳本,並且沒有自動執行的特殊函數。
盡管如此,為程序的執行定義一個起始點有助於理解程序是如何運行的。Python程序員提出了幾種方式對此進行實現。
本文結束時,您將了解以下內容:
Python中的基本main()函數
一些Python腳本中,包含一個函數定義和一個條件語句,如下所示:
此代碼中,包含一個main()函數,在程序執行時列印Hello World!。此外,還包含一個條件(或if)語句,用於檢查__name__的值並將其與字元串"__main__"進行比較。當if語句為True時,Python解釋器將執行main()函數。更多關於Python條件語句的信息可以由此獲得。
這種代碼模式在Python文件中非常常見,它將作為腳本執行並導入另一個模塊。為了幫助理解這段代碼的執行方式,首先需要了解Python解釋器如何根據代碼的執行方式設置__name__。
Python中的執行模式
Python解釋器執行代碼有兩種方式:
更多內容可參考如何運行Python腳本。無論採用哪種方式,Python都會定義一個名為__name__的特殊變數,該變數包含一個字元串,其值取決於代碼的使用方式。
本文將如下示例文件保存為execution_methods.py,以 探索 代碼如何根據上下文改變行為:
在此文件中,定義了三個對print()函數的調用。前兩個列印一些介紹性短語。第三個print()會先列印短語The value __name__ is,之後將使用Python內置的repr()函數列印出__name__變數。
在Python中,repr()函數將對象轉化為供解釋器讀取的形式。上述示例通過使用repr()函數來強調__name__的值為字元串。更多關於repr()的內容可參考Python文檔。
在本文中,您將隨處可見文件(file),模塊(mole)和腳本(script)這三個字眼。實際上,三者之間並無太大的差別。不過,在強調代碼目的時,還是存在細微的差異:
「如何運行Python腳本」一文也討論了三者的差別。
基於命令行執行
在這類方法中,Python腳本將通過命令行來執行。
執行腳本時,無法與Python解釋器正在執行的代碼交互。關於如何通過命令行執行代碼的詳細信息對本文而言並不重要,但您可以通過展開下框閱讀更多有關Windows,Linux和macOS之間命令行差異的內容。
命令行環境
不同的操作系統在使用命令行執行代碼時存在細微的差異。
在Linux和macOS中,通常使用如下命令:
美元符號($)之前的內容可能有所不同,具體取決於您的用戶名和計算機名稱。您鍵入的命令位於$之後。在Linux或macOS上,Python3的可執行文件名為python3,因此可以通過輸入python3 script_name.py來運行python腳本。
在Windows上,命令提示符通常如下所示:
根據您的用戶名,>之前的內容可能會有所不同,您輸入的命令位於>之後。在Windows上,Python3的可執行文件通常為python。因此可以通過輸入python script_name.py來運行python腳本。
無論哪種操作系統,本文的Python腳本的輸出結果都是相同的。因此本文以Linux和macOS為例。
使用命令行執行execution_methods.py,如下所示:
在這個示例中,__name__具有值'__main__',其中引號(')表明該值為字元串類型。
請記住,在Python中,使用單引號(')和雙引號(")定義的字元串沒有區別。更多關於字元串的內容請參考Python的基本數據類型。
如果在腳本中包含"shebang行"並直接執行它(./execution_methods.py),或者使用IPython或Jupyter Notebook的%run,將會獲取相同的結果。
您還可以通過向命令行添加-m參數的方法實現以模塊的方式執行。通常情況下,推薦如下方式pip: python3 -m pip install package_name。
添加-m參數將會運行包中__main__.py的代碼。更多關於__main__.py文件的內容可參考如何將開源Python包發布到PyPI中。
在三種情況中,__name__都具有相同的值:字元串'__main__'。
技術細節:Python文檔中具體定義了__name__何時取值為'__main__'。
當通過標准輸入,腳本或者交互提示中讀取數據時,模塊的__name__將取值為'__main__'。(來源)
__name__與__doc__,__package__和其他屬性一起存儲在模塊的全局命名空間。更多關於屬性的信息可參考Python數據模型文檔,特別是關於模塊和包的信息,請參閱Python Import文檔。
導入模塊或解釋器
接下來是Python解釋器執行代碼的第二種方式:導入。在開發模塊或腳本時,可以使用import關鍵字導入他人已經構建的模塊。
在導入過程中,Python執行指定模塊中定義的語句(但僅在第一次導入模塊時)。要演示導入execution_methods.py文件的結果,需要啟動Python解釋器,然後導入execution_methods.py文件:
在此代碼輸出中,Python解釋器執行了三次print()函數調用。前兩行由於沒有變數,在輸出方面與在命令行上作為腳本執行時完全相同。但是第三個輸出存在差異。
當Python解釋器導入代碼時,__name__的值與要導入的模塊的名稱相同。您可以通過第三行的輸出了解這一點。__name__的值為'execution_methods',是Python導入的.py文件。
注意如果您在沒有退出Python時再次導入模塊,將不會有輸出。
注意:更多關於導入在Python中如何工作的內容請參考官方文檔和Python中的絕對和相對導入。
Main函數的最佳實踐
既然您已經了解兩種執行方式上的差異,那麼掌握一些最佳實踐方案還是很有用的。它們將適用於編寫作為腳本運行的代碼或者在另一個模塊導入的代碼。
如下是四種實踐方式:
將大部分代碼放入函數或類中
請記住,Python解釋器在導入模塊時會執行模塊中的所有代碼。有時如果想要實現用戶可控的代碼,會導致一些副作用,例如:
在這種情況下,想要實現用戶控制觸發此代碼的執行,而不是讓Python解釋器在導入模塊時執行代碼。
因此,最佳方法是將大部分代碼包含在函數或類中。這是因為當Python解釋器遇到def或class關鍵字時,它只存儲這些定義供以後使用,並且在用戶通知之前不會實際執行。
將如下代碼保存在best_practices.py以證明這個想法:
在此代碼中,首先從time模塊中導入sleep()。
在這個示例中,參數以秒的形式傳入sleep()函數中,解釋器將暫停一段時間再運行。隨後,使用print()函數列印關於代碼描述的語句。
之後,定義一個process_data()函數,執行如下五項操作:
在命令行中執行
當你將此文件作為腳本用命令行執行時會發生什麼呢?
Python解釋器將執行函數定義之外的from time import sleep和print(),之後將創建函數process_data()。然後,腳本將退出而不做任何進一步的操作,因為腳本沒有任何執行process_data()的代碼。
如下是這段腳本的執行結果:
我們在這里看到的輸出是第一個print()的結果。注意,從time導入和定義process_data()函數不產生結果。具體來說,調用定義在process_data()內部的print()不會列印結果。
導入模塊或解釋器執行
在會話(或其他模塊)中導入此文件時,Python解釋器將執行相同的步驟。
Python解釋器導入文件後,您可以使用已導入模塊中定義的任何變數,類或函數。為了證明這一點,我們將使用可交互的Python解釋器。啟動解釋器,然後鍵入import best_practices:
導入best_practices.py後唯一的輸出來自process_data()函數外定義的print()。導入模塊或解釋器執行與基於命令行執行類似。
使用__name__控制代碼的執行
如何實現基於命令行而不使用Python解釋器導入文件來執行呢?
您可以使用__name__來決定執行上下文,並且當__name__等於"__main__"時才執行process_data()。在best_practices.py文件中添加如下代碼:
這段代碼添加了一個條件語句來檢驗__name__的值。當值為"__main__"時,條件為True。記住當__name__變數的特殊值為"__main__"時意味著Python解釋器會執行腳本而不是將其導入。
條件語塊內添加了四行代碼(第12,13,14和15行):
現在,在命令行中運行best_practices.py,並觀察輸出的變化:
首先,輸出顯示了process_data()函數外的print()的調用結果。
之後,data的值被列印。因為當Python解釋器將文件作為腳本執行時,變數__name__具有值"__main__",因此條件語句被計算為True。
接下來,腳本將調用process_data()並傳入data進行修改。當process_data執行時,將輸出一些狀態信息。最終,將輸出modified_data的值。
現在您可以驗證從解釋器(或其他模塊)導入best_practices.py後發生的事情了。如下示例演示了這種情況:
注意,當前結果與將條件語句添加到文件末尾之前相同。因為此時__name__變數的值為"best_practices",因此條件語句結果為False,Python將不執行process_data()。
創建名為main()的函數來包含要運行的代碼
現在,您可以編寫作為腳本由從命令行執行並導入且沒有副作用的Python代碼。接下來,您將學習如何編寫代碼並使其他程序員能輕松地理解其含義。
許多語言,如C,C++,Java以及其他的一些語言,都會定義一個叫做main()的函數,當編譯程序時,操作系統會自動調用該函數。此函數通常被稱為入口點(entry point),因為它是程序進入執行的起始位置。
相比之下,Python沒有一個特殊的函數作為腳本的入口點。實際上在Python中可以將入口點定義成任何名稱。
盡管Python不要求將函數命名為main(),但是最佳的做法是將入口點函數命名為main()。這樣方便其他程序員定位程序的起點。
此外,main()函數應該包含Python解釋器執行文件時要運行的任何代碼。這比將代碼放入條件語塊中更好,因為用戶可以在導入模塊時重復使用main()函數。
修改best_practices.py文件如下所示:
在這個示例中,定義了一個main()函數,它包含了上面的條件語句塊。之後修改條件語塊執行main()。如果您將此代碼作為腳本運行或導入,將獲得與上一節相同的輸出。
在main()中調用其他函數
另一種常見的實現方式是在main()中調用其他函數,而不是直接將代碼寫入main()。這樣做的好處在於可以實現將幾個獨立運行的子任務整合。
例如,某個腳本有如下功能:
如果在單獨的函數中各自實現這些子任務,您(或其他用戶)可以很容易地實現代碼重用。之後您可以在main()函數中創建默認的工作流。
您可以根據自己的情況選擇是否使用此方案。將任務拆分為多個函數會使重用更容易,但會增加他人理解代碼的難度。
修改best_practices.py文件如下所示:
在此示例代碼中,文件的前10行具有與之前相同的內容。第12行的第二個函數創建並返回一些示例數據,第17行的第三個函數模擬將修改後的數據寫入資料庫。
第21行定義了main()函數。在此示例中,對main()做出修改,它將調用數據讀取,數據處理以及數據寫入等功能。
首先,從read_data_from_web()中創建data。將data作為參數傳入process_data(),之後將返回modified_data。最後,將modified_data傳入write_data_to_database()。
腳本的最後兩行是條件語塊用於驗證__name__,並且如果if語句為True,則執行main()。
在命令行中運行如下所示:
根據執行結果,Python解釋器在執行main()函數時,將依次執行read_data_from_web(),process_data()以及write_data_to_database()。當然,您也可以導入best_practices.py文件並重用process_data()作為不同的數據輸入源,如下所示:
在此示例中,導入了best_practices並且將其簡寫為bp。
導入過程會導致Python解釋器執行best_practices.py的全部代碼,因此輸出顯示解釋文件用途的信息。
然後,從文件中存儲數據而不是從Web中讀取數據。之後,可以重用best_practices.py文件中的process_data()和write_data_to_database()函數。在此情況下,可以利用代碼重寫來取代在main()函數中實現全部的代碼邏輯。
實踐總結
以下是Python中main()函數的四個關鍵最佳實踐:
結論
恭喜!您現在已經了解如何創建Python main()函數了。
本文介紹了如下內容:
現在,您可以開始編寫一些非常棒的關於Python main()函數代碼啦!