Python 调试

2017-08-01 14:19:30

程序能一次写完并正常运行的概率很小，基本不超过1%。总会有各种各样的bug需要修正。有的bug很简单，看看错误信息就知道，有的bug很复杂，我们需要知道出错时，哪些变量的值是正确的，哪些变量的值是错误的，因此，需要一整套调试程序的手段来修复bug。

一、print()

将所有有可能出错的变量全部打印出来看看。简单直接，粗暴有效。

用print()最大的坏处是将来还得删掉它，想想程序里到处都是print()，运行结果也会包含很多垃圾信息。所以，我们又有第二种方法。

二、assert

凡是用print()来辅助查看的地方，都可以用断言（assert）来替代。assert是python的保留字，语法为：

assert expression [, arguments]

expression：表达式
arguments ：异常参数，其实就是在断言表达式后添加字符串信息，用来解释断言并更好的知道是哪里出了问题

assert 的含义是我下断言表达式为真，如果断言失败，assert语句本身就会抛出AssertionError，使程序崩溃，并输出断言信息。

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

def main():
    foo('0')

$ python3 err.py
Traceback (most recent call last):
  ...
AssertionError: n is zero!

程序中如果到处充斥着assert，和print()相比也好不到哪去。不过，启动Python解释器时可以用-O参数来关闭assert，关闭后，可以把所有的assert语句当成pass来看。

三、logging

把print()替换为logging是第3种方式，和assert比，logging不会抛出错误，而且可以输出到文件。

简单的将日志打印到屏幕

import logging

logging.info('this is info')
logging.warning('this is warning')

# WARNING:root:this is warning

这里只打印了waring中的信息是因为配置中的level默认为warning，只会打印等级大于等于level的内容。日志级别大小关系为：CRITICAL > ERROR > WARNING > INFO > DEBUG 。

这就是logging的好处，它允许你指定记录信息的级别，有debug，info，warning，error等几个级别，当我们指定level=INFO时，logging.debug就不起作用了。同理，指定level=WARNING后，debug和info就不起作用了。这样一来，你可以放心地输出不同级别的信息，也不用删除，最后统一控制输出哪个级别的信息。

通过logging.basicConfig函数对日志的输出格式及方式做相关配置

import logging

logging.basicConfig(level=logging.WARNING,
                    format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
                    filename='myapp.log',
                    filemode='w')

logging.critical('This is critical message')
logging.debug('This is debug message')
logging.info('This is info message')
logging.warning('This is warning message')

# myapp.log
# 2017-08-01 19:27:34,664 Blackboard.py[line:8] CRITICAL This is critical message
# 2017-08-01 19:27:34,665 Blackboard.py[line:11] WARNING This is warning message

logging.basicConfig(**kwargs)

level: 设置日志级别，默认为logging.WARNING
filename: 指定日志文件名
filemode: 和file函数意义相同，指定日志文件的打开模式，'w'或'a'
format: 指定输出的格式和内容，format可以输出很多有用信息，如上例所示:
    %(levelno)s: 打印日志级别的数值
%(levelname)s: 打印日志级别名称
    %(pathname)s: 打印当前执行程序的路径，其实就是sys.argv[0]
    %(filename)s: 打印当前执行程序名
%(funcName)s: 打印日志的当前函数
%(lineno)d: 打印日志的当前行号
%(asctime)s: 打印日志的时间
%(thread)d: 打印线程ID
%(threadName)s: 打印线程名称
%(process)d: 打印进程ID
%(message)s: 打印日志信息
datefmt: 指定时间格式，同time.strftime()
stream: 指定将日志的输出流，可以指定输出到sys.stderr,sys.stdout或者文件，默认输出到sys.stderr，当stream和filename同时指定时，stream被忽略

将日志同时输出到文件和屏幕

import logging

logging.basicConfig(level=logging.DEBUG,
                format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
                datefmt='%a, %d %b %Y %H:%M:%S',
                filename='myapp.log',
                filemode='w')


#定义一个StreamHandler，将INFO级别或更高的日志信息打印到标准错误，并将其添加到当前的日志处理对象
console = logging.StreamHandler()
console.setLevel(logging.INFO)
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
console.setFormatter(formatter)
logging.getLogger('').addHandler(console)

logging.debug('This is debug message')
logging.info('This is info message')
logging.warning('This is warning message')

# myapp.log
# Tue, 01 Aug 2017 19:47:20 Blackboard.py[line:17] DEBUG This is debug message
# Tue, 01 Aug 2017 19:47:20 Blackboard.py[line:18] INFO This is info message
# Tue, 01 Aug 2017 19:47:20 Blackboard.py[line:19] WARNING This is warning message

# 屏幕输出:
# root        : INFO     This is info message
# root        : WARNING  This is warning message

这里经过实测，屏幕输出的优先级必须高于等于文件的优先级，如果比文件的优先级还低的话，以basicconfig的level为准。换句话说就是basicconfig设置了level的最低值。

四、使用调试器进行调试

可以使用pdb进行调试或者使用IDE进行更方便的设置断点的调试。