python 除錯

twoP發表於2018-05-26

除錯

1、使用正常的 print（）進行輸出：

# printTest.py


def foo(s):
    n = int(s)
    print('>>> n = %d' % n)
    return 10 / n

def main():
    foo('0')

main()
複製程式碼

(venv) E:\pyplace\learn_python3\learn\two\除錯>python printTest.py
>>> n = 0
Traceback (most recent call last):
  File "printTest.py", line 9, in <module>
   ...
ZeroDivisionError: division by zero
複製程式碼

用 print() 不好的地方就是，程式中到處都是 print(),執行結果也包含很多垃圾資訊

2、使用斷言：

# assert.py


def foo(s):
    n = int(s)
    assert n != 0, 'n is zero!'
    return 10 / n

def main():
    foo('0')

main()
複製程式碼

E:\py\venv\Scripts\python.exe E:/pyplace/learn_python3/learn/two/除錯/assert.py
Traceback (most recent call last):
 ...
    assert n != 0, 'n is zero!'
AssertionError: n is zero!
複製程式碼

asset 的意思是，表示式 n != 0 應該是 true 。否則後面的程式碼會出錯如果斷言失敗，assert 就會丟擲 AssertionErrot

注意：

assert 和 print（）相比較好不到哪裡去，一樣在程式碼中會出現太多，並且輸出結果垃圾資訊多
不過 assert 可以使用 -O 引數來關閉 assert（大寫的O，不是零）

(venv) E:\pyplace\learn_python3\learn\two\除錯>python -O assert.py
Traceback (most recent call last):
...
  File "assert.py", line 4, in foo
    return 10 / n
ZeroDivisionError: division by zero
複製程式碼

關閉後，相當於把所有的 assert 語句當成 pass 來看（也就是跳過了）。

3、使用logging（把 print() 替換為 logging 是第3種方式）：

和 assert比較，不僅可以丟擲錯誤，還可以輸出到檔案

#loggingTest.py



import logging

logging.basicConfig(level= logging.INFO)  #  注意一定要寫這個，不然就不會輸出資訊
s = '0'
n = int(s)
logging.info('n = %d' % n)
print(10 / n)
複製程式碼

E:\py\venv\Scripts\python.exe E:/pyplace/learn_python3/learn/two/除錯/loggingTest.py
INFO:root:n = 0
Traceback (most recent call last):
  File "E:/pyplace/learn_python3/learn/two/除錯/loggingTest.py", line 7, in <module>
    print(10 / n)
ZeroDivisionError: division by zero
複製程式碼

logging.basicConfig(level= logging.INFO) # 注意一定要寫這個，不然就不會輸出 INFO 資訊

提示

logging 的好處，可以指定資訊的級別（debug， info, warning, error 等）
當我們指定 level = INFO 時， logging.debug 就不起作用，也就是隻能一個等級起作用。
loggging 的另外一個好處，通過簡單的配置，可以同時輸出到 console 和檔案

4、pdb （第4種方式，啟動 Python 的偵錯程式 pdb）

讓程式單步執行，可以隨時檢視執行狀態

# errTest.py


s = '0'
n = int(s)
print( 10 / n)
複製程式碼

(venv) E:\pyplace\learn_python3\learn\two\除錯>python -m pdb errTest.py
> e:\pyplace\learn_python3\learn\two\除錯\errtest.py(2)<module>()
-> s = '0'
複製程式碼

以引數 -m pdb 啟動後，pdb 定位到下一步執行的程式碼 -> s = '0'。輸入 l 命令參看程式碼：

(Pdb) l
  1
  2  -> s = '0'
  3     n = int(s)
  4     print( 10 / n)
複製程式碼

輸入 n 可以單步執行程式碼：

(Pdb) n
> e:\pyplace\learn_python3\learn\two\除錯\errtest.py(3)<module>()
-> n = int(s)
複製程式碼

再次輸入 n：

> e:\pyplace\learn_python3\learn\two\除錯\errtest.py(4)<module>()
-> print( 10 / n)
複製程式碼

任何時候都可以輸入 p + 變數名，來檢視變數：

(Pdb) p s
'0'
(Pdb) p n
0
複製程式碼

輸入命令 q 結束除錯，退出程式：

(Pdb) q

(venv) E:\pyplace\learn_python3\learn\two\除錯>
複製程式碼

通過 pdb 在命令列除錯的方法好像是萬能的，但實在是太麻煩。如果1k行程式碼，執行到999，需要多少命令啊。還好，我們還有另外一種除錯的方式。

5、pdb.set_trace()

這個方法也是 pdb,但是不需要單步執行，只需要 import pdb，在可能出錯的地方放置 pdb.set_trace(),就可以設定斷點

執行程式碼，程式自動在 pdb.set_trace() 暫停並進入 pdb 除錯環境，可以用 p 檢視變數，或者用 c 繼續執行程式：

# pdbTest.py


import pdb

s = '0'
n = int(s)
pdb.set_trace()
print(10 /n)

複製程式碼

(venv) E:\pyplace\learn_python3\learn\two\除錯>python pdbTest.py
> e:\pyplace\learn_python3\learn\two\除錯\pdbtest.py(6)<module>()
-> print(10 /n)
(Pdb) p n
0
(Pdb) c
Traceback (most recent call last):
  File "pdbTest.py", line 6, in <module>
    print(10 /n)
ZeroDivisionError: division by zero
複製程式碼

這個方式比直接啟動 pad 單步除錯效率高很多，但還不夠