python3__异常、调试、单元测试、文档测试

喜欢ヅ旅行 2022-04-16 01:35 281阅读 0赞

# 1.异常 #

## 1.1.异常处理 ##

> python内置了一套**try...except...else...finally...**的错误处理机制。
> 
> ①当认为某个代码块可能出错，可通过**try来运行此段代码**，若出错则跳转到except语句块，执行完except之后，若有finally语句块则执行finally语句块，至此，执行完毕。此外，except之后可以加一个else,当没有错误发生时，会自动执行else语句。
> 
> ②处理异常的方式又多种，如下代码。
> 
> ③异常是一个class，所有的异常类型均继承自BaseException,**except不但捕获该类型的错误，还将其子类“一网打尽”**（ValueError --> UnicodeError）
> 
> ④**常见的错误类型和继承关系**如下：
> 
>     BaseException
>      +-- SystemExit
>      +-- KeyboardInterrupt
>      +-- GeneratorExit
>      +-- Exception
>           +-- StopIteration
>           +-- StopAsyncIteration
>           +-- ArithmeticError
>           |    +-- FloatingPointError
>           |    +-- OverflowError
>           |    +-- ZeroDivisionError
>           +-- AssertionError
>           +-- AttributeError
>           +-- BufferError
>           +-- EOFError
>           +-- ImportError
>           |    +-- ModuleNotFoundError
>           +-- LookupError
>           |    +-- IndexError
>           |    +-- KeyError
>           +-- MemoryError
>           +-- NameError
>           |    +-- UnboundLocalError
>           +-- OSError
>           |    +-- BlockingIOError
>           |    +-- ChildProcessError
>           |    +-- ConnectionError
>           |    |    +-- BrokenPipeError
>           |    |    +-- ConnectionAbortedError
>           |    |    +-- ConnectionRefusedError
>           |    |    +-- ConnectionResetError
>           |    +-- FileExistsError
>           |    +-- FileNotFoundError
>           |    +-- InterruptedError
>           |    +-- IsADirectoryError
>           |    +-- NotADirectoryError
>           |    +-- PermissionError
>           |    +-- ProcessLookupError
>           |    +-- TimeoutError
>           +-- ReferenceError
>           +-- RuntimeError
>           |    +-- NotImplementedError
>           |    +-- RecursionError
>           +-- SyntaxError
>           |    +-- IndentationError
>           |         +-- TabError
>           +-- SystemError
>           +-- TypeError
>           +-- ValueError
>           |    +-- UnicodeError
>           |         +-- UnicodeDecodeError
>           |         +-- UnicodeEncodeError
>           |         +-- UnicodeTranslateError
>           +-- Warning
>                +-- DeprecationWarning
>                +-- PendingDeprecationWarning
>                +-- RuntimeWarning
>                +-- SyntaxWarning
>                +-- UserWarning
>                +-- FutureWarning
>                +-- ImportWarning
>                +-- UnicodeWarning
>                +-- BytesWarning
>                +-- ResourceWarning
> 
> ⑤异常的捕获还有一个巨大的好处，就是**可以跨越多层调用**，即：不需要再每个可能出错的地方去捕获错误，只要在合适的层次去捕获错误即可

try:
        print("try__")
        result = 10/int("a")
        # result = 10/0
        print("result:%s" % result)
    
    # 方式一
    # except ValueError as e:
    #     print("ValueError:", e)
    # except ZeroDivisionError as e:
    #     print("ZeroDivisionError:", e)
    
    # 方式二
    # except (ValueError, ZeroDivisionError) as e:
    #     print("Error:", e)
    
    # 方式三：不推荐
    except Exception as e:
        print("Exception:", e)
    
    else：
        print("No error!")
    finally:
        print("finally都会执行")
    print("end")

## 1.2.记录异常 ##

> 【问题】若不捕获异常，python解释器会打印出错误堆栈，同时程序也会被结束；
> 
> 既然可以捕获异常，将错误的堆栈打印出来，然后分析错误原因，同时可以让程序继续执行下去。python内置的**logging模块**可以非常容易的记录错误信息（日志），方便事后排查。

import logging
    
    
    def foo(s):
        return 10/int(s)
    
    
    def bar(s):
        return foo(s)*2
    
    
    def main():
        try:
            bar("0")
        except Exception as e:
            logging.exception(e)
    
        # bar("0")
    
    
    if "__main__" == __name__:
    
        main()
        print("End")
        # print(logging.INFO)
        # print("2End")

## 1.3.抛出异常 ##

> ①异常时一个class，捕获一个异常就是捕获到该class的一个**实例**。因此，异常可自行定义，并抛出
> 
> ②特殊形式：捕获异常的目的仅仅是为了记录一下，便于后续追踪。但当前函数不知道如何处理该错误，所以，最恰当的方式是继续往上抛出，让顶层调用者去处理。**raise语句不带参数就会把当前错误原样抛出**。此外，在raise的过程中还可以把一种错误类型转换成另外一种类型。

def foo(s):
        n = int(s)
        if 0 == n:
            raise ValueError("invalid value===%s" % s)
        return 10/n
    
    
    def bar():
        try:
            foo("0")
        except ValueError as e:
            print("ValueError!", e)
            raise
    
    
    if "__main__" == __name__:
    
        bar()

# 2.调试 #

## 2.1.print语句打印错误信息 ##

> 最简单的调试方式是直接通过**print打印**相关引用的信息来进行判断，但该种方式在使用过程中存在一个问题：程序写完之后还需要逐行删除或注释。

## 2.2.assert断言 ##

> ①通过print来辅助查看的地方均可通过**assert断言**来替代；若断言失败，则抛出AssertionError异常。
> 
> ②启用python解释器时，可通过**参数-O来关闭assert**。（python -O a.py）

def foo(s):
        n = int(s)
        assert n != 0
        return 10/n
    
    
    if "__main__" == __name__:
    
        foo("0")
    
    # Traceback (most recent call last):
    #   File "E:/...程序调试.py", line 15, in <module>
    #     foo("0")
    #   File "E:/...程序调试.py", line 9, in foo
    #     assert n!= 0
    # AssertionError

## 2.3.logging调试 ##

> 将print()替换成**logging**是第3种进行调试的方式，与assert相比更加人性化，不会直接抛出异常，而且可以输出到文件中。
> 
> ①引用形式
> 
> **import logging**
> 
> ②指定记录信息的级别
> 
> **logging.basicConfig(level=logging.INFO)**
> 
> 信息的级别主要包括（debug, info, warning, error等级别）
> 
> ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FkbWluX21heGlu_size_16_color_FFFFFF_t_70][]

import logging
    logging.basicConfig(level=logging.INFO)  # 指定记录信息的级别
    
    s = "0"
    n = int(s)
    logging.info("n= %d" % n)
    print(10/n)

## 2.4.pdb调试 ##

> 该种调试的方式适用于linux\\ubuntu运行环境中。pdb的具体使用方式类似于C或C++在linux等环境中的gdb调试。**python -m pdb err.p**y（启动文件调试）**l**（查看代码）**n**（单步执行代码）**p** 变量名称（查看变量）**q**（结束调试）**b**（设置断点）**c**（设置断点之后，继续执行）
> 
> 或者通过**import pdb**,并在可能出错的代码出添加**pdb.set\_trace()**，相当于添加断点，当程序运行到此处的时候直接进入pdb调试环境。
> 
> ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FkbWluX21heGlu_size_16_color_FFFFFF_t_70 1][]

a = 10
    
    def c():
        print("this is c function!")
    
    b = 20
    a, b = b, a
    print(a, b)

# 3.单元测试 #

> 单元测试是用来对一个模块、一个函数或一个类进行正确性检验的测试工作。（其实就是**测试用例在测试模块中的一个汇总**）
> 
> \[意义\]若对某个函数进行修改之后，只需要再运行一遍单元测试，若通过，说明我们的修改不会对原有的函数的行为造成影响，如果测试不通过，说明对函数的修改与原有的行为不一致，要么修改代码，要么修改测试。该种以测试为驱动的开发模式最大的好处就是**确保一个程序模块的行为符合我们设计的测试用例**。
> 
> 假设在测试过程中需求启动一个数据库，此时可在**setUp()**中链接数据库，在**tearDown()**中关闭数据库，此时便可以避免在每一个测试函数中重复相同的数据库链接代码。
> 
> 【注意】：
> 
> ①编写单元测试，测试类需要继承自**unittest.TestCase**类
> 
> ②以**test开头的方法**被识别为测试方法
> 
> ③测试中最常用的断言是**assertEqual()**：判断是否相等
> 
> ④**assertRaises(KeyError)**：抛出指定类型的error
> 
> ⑤**assertTrue()**：断言是否为真
> 
> ⑥setUp()和tearDown()：分别在每调用一个测试函数方法的前后都会被执行

# myStudent.py
    class Student(object):
        def __init__(self, name, score):
            self.name = name
            self.score = score
        def get_grade(self):
            if self.score < 0 or self.score > 100:
                raise ValueError("score should be [0, 100]")
            if self.score >= 60 and self.score < 80:
                return 'B'
            if self.score >= 80:
                return 'A'
            return 'C'
    
    
    # test_module.py
    class TestStudent(unittest.TestCase):
        def setUp(self):
            print("setUp...")
    
        def tearDown(self):
            print("tearDown...")
    
        def test_80_to_100(self):
            s1 = Student('Bart', 80)
            s2 = Student('Lisa', 100)
            self.assertEqual(s1.get_grade(), 'A')
            self.assertEqual(s2.get_grade(), 'A')
    
        def test_60_to_80(self):
            s1 = Student('Bart', 60)
            s2 = Student('Lisa', 79)
            self.assertEqual(s1.get_grade(), 'B')
            self.assertEqual(s2.get_grade(), 'B')
    
        def test_0_to_60(self):
            s1 = Student('Bart', 0)
            s2 = Student('Lisa', 59)
            self.assertEqual(s1.get_grade(), 'C')
            self.assertEqual(s2.get_grade(), 'C')
    
        def test_invalid(self):
            s1 = Student('Bart', -1)
            s2 = Student('Lisa', 101)
            with self.assertRaises(ValueError):
                s1.get_grade()
            with self.assertRaises(ValueError):
                s2.get_grade()
    
    if __name__ == '__main__':
        unittest.main()
    
        # Testing started at 20:09 ...
        # D:\anaconda\python.exe "D:\PyCharm\PyCharm 2018.1.4\helpers\pycharm\_jb_unittest_runner.py" --target test_module.TestStudent
        # Launching unittests with arguments python -m unittest test_module.TestStudent in E:\Python\04.课程代码\老男孩\SevenWeek
        # setUp...
        # tearDown...
        # setUp...
        # tearDown...
        # setUp...
        # tearDown...
        # setUp...
        # tearDown...

# 4.文档测试 #

> 在python当中python的“文档测试”（**doctest**）模块可以直接提取注释中的代码并执行测试。doctest严格按照python交互式命令的输入与输出判断测试结果是否正确。只有测试异常的时候，可以用**...**表示中间一大段烦人的输出。
> 
> doctest非常有用，**不但可以用来测试，还可以直接用作测试代码**。通过某些文档生成工具就可以自动把包含doctest的注释提取出来。用户在看文档的时候，同时也可看到doctest。

class Dict(dict):
        """
        Simple dict but also support access as x.y style
    
        >>> d1 = Dict()
        >>> d1["x"] = 100
        >>> d1.x
        100
        >>> d1.y = 200
        >>> d1["y"]
        200
        >>> d2 = Dict(a=1, b=2, c="3")
        >>> d2.c
        '3'
        >>> d2["empty"]
        Traceback (most recent call last):
            ...
        KeyError: 'empty'
        >>> d2.empty
        Traceback (most recent call last):
            ...
        AttributeError: 'Dict' object has no attribute 'empty'
        """
        def __init__(self, **kwargs):
            super(Dict, self).__init__(**kwargs)
    
        def __getattr__(self, key):
            try:
                return self[key]
            except KeyError:
                raise AttributeError(r"'Dict' object has no attribute '%s'" % key)
    
        def __setattr__(self, key, value):
            self[key] = value
    
    
    if __name__ == '__main__':
        import doctest
    
        doctest.testmod()

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FkbWluX21heGlu_size_16_color_FFFFFF_t_70]: /images/20220416/3470e1c6b1fe408fa85dc4751dd8173e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FkbWluX21heGlu_size_16_color_FFFFFF_t_70 1]: /images/20220416/3ac7ad62d0384ced86bff9b242ccf80f.png