【python 学习】代码插桩调试

Python 代码插桩方法

什么是插桩技术？

插桩技术是指在保持原有程序逻辑完整性的基础上，在程序中加入探针，通过探针来收集代码在执行过程中的信息（函数参数，返回值、变量变化信息、函数调用顺序等等）。插桩技术在调试代码的过程中也非常实用。通常实现方法是在特定位置插入代码段，从而收集程序运行时的动态上下文信息。

使用插桩调试

使用插桩技术调试程序，可以有效的查看程序执行过程，并发现代码的逻辑错误（如果代码存在语法错误，编译器会报告该类错误）。逻辑错误往往难以发现，只是运行结果存在问题，但是程序可以正常运行。

例如：最近在写迪杰斯特拉算法和双向迪杰斯特拉算法，两种方法都使用python实现，都能正常运行。一开始，单次运行，两者给出的最短路径都是一样的，以为应该没什么问题，所以写了个测试片段，两个程序执行500次，看一下效率，然后就发现，这500次里，总有些时候，双向迪杰斯特拉和迪杰斯特拉算法的路径不一致，而且迪杰斯特拉算法的效果更好，故疯狂找原因。这时候就想到了插桩技术！

python插桩的一种实现方法

简单地说就是在某些想要输出变量或者函数调用过程的位置，插入一些代码片段。

    print_log = open("./logfile.txt", "a", encoding='utf-8')	# 打开一个txt文件作为输出
    print(datetime.datetime.now().strftime('%Y-%m-%d  %H:%M:%S'), file=print_log)
    print("var1:", var1, "function1:", function1, file=print_log)
    print("condition1:", condition1, file=print_log)

这个框架是这样的，利用print函数，将程序运行中的信息输出到txt文件中。

import time
def dijkstra(graph, start, target):
    print_log = open("./logfile.txt", "a", encoding='utf-8')	# 打开一个txt文件作为输出
    print(datetime.datetime.now().strftime('%Y-%m-%d  %H:%M:%S'), file=print_log)
    print("\n", file=print_log)
    
    if condition is True：
    	print("condition:", condition, file=print_log)
        ...
        var1 = ?
        var2 = ?
        print("var1", var1, "var2", var2, file=print_log)
        ...
        return path
    
def main():
    print_log = open("./logfile.txt", "a", encoding='utf-8')
    print(datetime.datetime.now().strftime('%Y-%m-%d  %H:%M:%S'), file=print_log)
    print("\n", file=print_log)
    print("graph:", graph, "start:", start, "target:", target, file=print_log)
    dijs_path = dijkstra(graph, start, target)
    print("result:", dijs_path)    
    

方式二

有的人可能希望不喜欢上述代码插桩的输出格式：

上述代码插桩的输出格式是，程序运行的开始先输出一个程序运行的起始时间，然后开始运行，并输出自己想要的变量变动过程。

print ("[%s] %s 修改第 %d 个值，修改后值为:%d" % (time.ctime(time.time()),threadName,counter,list[counter-1]))

该行代码的输出风格为：

[Fri Dec  1 09:54:06 2023] Thread-1 修改第 12 个值，修改后值为:1
[Fri Dec  1 09:54:07 2023] Thread-2 修改第 12 个值，修改后值为:2
[Fri Dec  1 09:54:07 2023] Thread-1 修改第 11 个值，修改后值为:1
[Fri Dec  1 09:54:08 2023] Thread-3 修改第 12 个值，修改后值为:3
[Fri Dec  1 09:54:08 2023] Thread-1 修改第 10 个值，修改后值为:1
[Fri Dec  1 09:54:09 2023] Thread-2 修改第 11 个值，修改后值为:2

总体框架：

import time
def dijkstra(graph, start, target):
    print_log = open("./logfile.txt", "a", encoding='utf-8')	# 打开一个txt文件作为输出
    print(datetime.datetime.now().strftime('%Y-%m-%d  %H:%M:%S'), file=print_log)
    print("\n", file=print_log)
    
    if condition is True：
    	print("condition:", condition, file=print_log)
        ...
        var1 = ?
        var2 = ?
        print("var1", var1, "var2", var2, file=print_log)
        ...
        return path
    
def main():
    print_log = open("./logfile.txt", "a", encoding='utf-8')
    print(datetime.datetime.now().strftime('%Y-%m-%d  %H:%M:%S'), file=print_log)
    print("\n", file=print_log)
    print ("[%s] %s 修改第 %d 个值，修改后值为:%d" % (time.ctime(time.time()),threadName,counter,list[counter-1]), file=print_log)
    dijs_path = dijkstra(graph, start, target)
    print("result:", dijs_path)