Python错误、调试和测试

错误处理

在程序运行过程中，如果发生了错误，可以实现约定返回一个错误代码，这样就可以知道是否有错、以及出错的原因。

• try。。。except。。。finally。。。的错误处理机制
  • 当我们认为某些代码可能会出错时，可以用try来运行这段代码，
    如果执行出错，则后续代码不会继续执行，而是直接跳转至错误处理代码，即except语句块，执行完except后，如果有finally语句块，则执行finnally语句块，至此执行完毕
    没有发生错误则不执行except语句块，但是finally语句块只要有就执行
  • 如果发生了不同类型的错误，应该由不同的except语句块处理
  • 如果没有错误发生，可以在except语句块后面加一个else，当没有错误发生时，会自动执行else语句
  • python的错误类型都继承自BaseException，所以在使用except是需要注意，它不但捕获该类型的错误，还把其子类也‘一网打尽’
  • 常见错误类型和继承关系 https://docs.python.org/3/library/exceptions.html#exception-hierarchy
  • 使用try。。。except。。。finally可以跨越多层调用
    例如，如果函数A调用函数B，B调用C，结果C报错了，这时只要A捕获到了，就可以处理
    即：不需要在每个可能出错的地方去捕获错误，只要在合适的层次去捕获错误就可以了
• 调用栈
  • 如果错误没有被捕获，它就会一直往上抛，最后被python解释器捕获，打印一个错误信息，然后程序退出
  • 出错的时候，一定要分析错误的调用栈信息，才能定位错误的位置。
• 记录错误
  • python内置的logging模块可以非常容易的记录错误信息
  • 同样是出错，但是程序打印完错误信息后会继续执行，并正常退出
    …try:…except…:
    logging.exception(e)
  • 通过配置，logging还可以把错误记录到日志文件里
• 抛出错误
  • 因为错误是class，捕获一个错误就是捕获该class的一个实例，因此，错误并不是凭空产生的，而是有意创建并抛出的
  • 如果要抛出错误，首先根据需要，可以定义一个错误的class，选择好继承关系，然后，用raise语句抛出一个错误的实例
    只有在必要的时候才定义我们自己的错误类型，可以使用python内置的尽量是用内置的
  • raise语言如果不带参数，就会把当前错误原样抛出
  • 此外，在except中raise一个Error，还可以把一种类型的错误转化成另一种类型
• 触发异常
  • raise [Exception [, args [, traceback]]]
    语句中 Exception 是异常的类型（例如，NameError）参数标准异常中任一种，args 是自已提供的异常参数。
    最后一个参数是可选的（在实践中很少使用），如果存在，是跟踪异常对象。

调试

• 第一种：使用print()把所有可能有问题的变量打印出来
  • 用print()最大的坏处是将来还得删掉它，想想程序里到处都是print()，运行结果也会包含很多垃圾信息。
• 第二种：断言
  • 凡是用print()来辅助查看的地方，都可以用断言（assert）代替
    assert n != 0,‘n is zero！s’ #意思是，表达式n != 0应该是True，否则，根据程序运行的逻辑，后面的代码肯定会出错
  • 如果断言失败，assert语句本身会抛出AssertionError
  • 启动python解释器时使用-0参数可以关闭assert
    python -0 err.py
    关闭后，可以把所有assert语句当成pass来看
• 第三种：logging
  • 与assert相比，logging不会抛出错误，而且可以输出到文件
    • logging.info()就可以输出一段文本
    • 配置
      import logging
      logging.basicConfig(level = logging.INFO)
  • 优点
    允许指定记录信息的级别，有debug、info、warning、error等几个级别
    可以通过简单的配置，一条语句可以同时输出到不同的地方，例如consol和文件
• 第四种：pdb
  • pdb是python的调试器，让程序以单步方式运行，可以随时查看运行状态
    • python -m pdb err.py 启动
    • 启动后输入数字查看代码，输入n可以单步执行代码
    • 任何时候都可以输入命令‘P 变量名 ’来查看变量
    • 输入命令q结束调试，退出程序
  • 这种通过pdb在命令行调试的方法理论上是万能的，但实在是太麻烦了，如果有一千行代码，要运行到第999行得敲多少命令啊
• 第五种：pdb.set_trace()
  • 也是使用pdb，但是不需要单步执行，只需要import pdb ，然后再可能出错的地方放一个pdb.set_trace()，就可以设置一个断点
  • 运行代码，程序会自动在pdb.set_trace()暂停并进入pdb调试环境，可以使用p查看变量，或者使用命令c继续运行
• 第六种：IDE
  • 如果要比较爽地设置断点、单步执行，就需要一个支持调试功能的IDE。目前比较好的Python IDE有：
  • Visual Studio Code：https://code.visualstudio.com/，需要安装Python插件。
  • PyCharm：http://www.jetbrains.com/pycharm/
  • 另外，Eclipse加上pydev插件也可以调试Python程序
• 最常使用logging和断言

单元测试

• 编写单元测试，需要引入python自带的unittest模块
  • 测试类需要从unittest.TestCase继承
  • 以test开头的方法就是测试方法，不以test开头的方法不被认为是测试方法，测试的时候不会被执行
    对每一类测试都需要编写一个test_xxx()方法
• unittest.TestCase有很多内置的条件判断，只需要调用这些方法就可以断言输出的是否是我们期望的
  • 最常用的断言是asserEqual()
    self.assertEqual(abs(-1), 1) # 断言函数返回的结果与1相等
  • 另一种常用断言是期待抛出指定类型的Error
    • 比如通过d[‘empty’]访问不存在的key时，断言会抛出keyError
      with self.assertRaises(KeyError)：
      value = d.empty
    • 通过d.empty访问不存在的key时，期待抛出AttributeError
      with self.assertRaises(AttributeError):
      value = d.empty
• 运行单元测试
  • 第一种方法是在单元测试文件的最后加上两行代码
    if__name__==‘main’:
    unittest.main()
    然后就可以把单元测试文件当成正常python文件执行
  • 另一种方法是执行时加上-m unittest命令，直接执行
    python -m unittest mydict_test
    这种方法可以一次批量运行很多单元测试，且可以让工具自动运行这些单元测试，比较推荐
  • setUp和tearDown
    可以在单元测试中编写两个特殊的setUp()和tearDown()方法，这两个方法会分别在每调用一个测试方法的前后分别被执行
    可以在setUp()方法中连接数据库，在tearDown()方法中关闭数据库，这样不必在每个测试方法中重复相同的代码

文档测试

文档测试非常有用，不但可以用来测试，还可以直接作为示例代码。通过某些文档生成工具，就可以自动把包含文档测试的注释提取出来。用户看文档的时候，同时也看到了文档测试。