【Python】pysnooper模块对代码进行调试

r囧r小猫 2021-11-11 21:24 377阅读 0赞

一般情况下，在编写Python代码时，如果想弄清楚为什么Python代码没有按照预期执行的原因，比如你想知道哪些是正在运行，哪些没有运行，以及局部变量的值是什么...  
通常我们会使用包含断点和观察模式等功能成熟的调试器，或者直接使用 print 语句打印出来。今天和大家分享一个“贫民版”调试工具——PySnooper  
PySnooper允许你执行以上相同的操作，只需为要调试的函数添加一个装饰器即可，而不需要构建正确的print打印。你还将得到函数的详细日志，包括运行了哪些代码行、何时运行以及何时更改了局部变量。  
PySnooper 使用起来十分简单，开发者可以在任何庞大的代码库中使用它，而无需进行任何设置。你只需添加装饰器，并为日志输出地址指定路径，方法是将其路径指定为第一个参数。  
目前，PySnooper在GitHub上已经获得7047个Star，371个Fork（GitHub地址：https://github.com/cool-RR/PySnooper）

参照具体案例：

''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
    #作者：cacho_37967865
    #博客：https://blog.csdn.net/sinat_37967865
    #文件：PySnooperModel.py
    #日期：2019-06-01
    #备注：pip install pysnooper  “贫民版”调试工具——PySnooper  
    '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
    
    import pysnooper
    import random
    
    
    #@pysnooper.snoop()                       # 只要添加一个装饰器
    #@pysnooper.snoop(depth=2)                # 显示函数调用的函数的snoop行：
    @pysnooper.snoop(prefix='ZZZ--> ')        # 运行日志前面显示ZZZ--> ，突出显示这个是运行日志
    def number_to_bits(number):
        if number:
            bits = []
            while number:
                number, remainder = divmod(number, 2)
                bits.insert(0, remainder)
            return bits
        else:
            return [0]
    
    
    # 跟踪核心代码+变量的运行（with ）
    def foo():
        lst = []
        for i in range(10):
            lst.append(random.randrange(1, 1000))
    
        with pysnooper.snoop():
            lower = min(lst)
            upper = max(lst)
            mid = (lower + upper) / 2
            print(lower, mid, upper)
    
    
    # 将函数运行的详细日志存储到日志
    @pysnooper.snoop('./log/file.log')
    def output():
        lst = []
        for i in range(10):
            lst.append(random.randrange(1, 1000))
    
    if __name__ == "__main__":
        number_to_bits(6)
        foo()
        output()