深入理解Python中的try-except语句，避免代码崩溃的噩梦

不管是开发Python、Java、JavaScript程序，还是写C++、PHP、GO、Ruby代码。都离不开try … except异常处理。至于为什么，一切为了程序/产品/项目的稳定运行。如果一个程序项目或者说小一点一个文件中没有一个try-except处理，那么这个程序是有漏洞的、是不稳定的，很容易就会崩溃的程序。

而我们经常在代码开发时，特别是框架项目开发时，多个模块（文件）是会存在调用的情况，有单向的，也有双向的。而在此时如果程序发生异常，try-except只会基于当前位置进行信息打印（我说的是Except as e），很难去定位到模块调用，也就是源头文件的位置。今天分享的内容就是如何定位源头文件及行数。

Python try-except例子：

在这个例子中，我们将除法运算代码封装到了一个名为divide的函数中。函数的第一个参数a表示被除数，第二个参数b表示除数。在函数体中，我们使用try except语句对除以0的异常进行了处理。如果程序没有遇到ZeroDivisionError异常，那么函数将成功计算结果并返回。如果程序遇到ZeroDivisionError异常，我们将输出具体的错误信息并返回None。

def divide(a, b):
    try:
        c = a / b
        return c
    except ZeroDivisionError as e:
        print(e)
        return None

# 调用函数进行除法运算
result = divide(10, 0)
print(result)

输出结果：

Divide by zero error

定位源头文件（报错源）

大多时候我们在大工程或者复杂程序里，仅仅打印e只能简单的显示出程序出错的信息，有时我们仅仅根据这个信息很难定位，错误究竟发生在哪一个文件、哪一行代码，这时候比较笨的调试方法就是去掉try-except再跑一次让程序崩溃显示出具体的信息。

而比较快速便捷的定位错误信息就是定位到发生错误具体的行和文件，其实我们可以利用错误对象e，它其实是有相关的属性可调用的。

def divide(a, b):
    try:
        c = a / b
        return c
    except ZeroDivisionError as e:
        # 通过e的属性打印具体文件名称和行号
        print(f"Error Occurred At, 
              f"File: {e.__traceback__.tb_frame.f_code.co_filename}, "
              f"Line: {e.__traceback__.tb_lineno}")
        print("Divide by zero error")
        return None

# 调用函数进行除法运算
result = divide(10, 0)
print(result)

输出结果：

Error Occurred At, File: 文件路径, Line: 错误行号
Divide by zero error
None

或者还可以借助内置模块traceback实现

import traceback
import sys

def divide(a, b):
    try:
        c = a / b
        return c
    except ZeroDivisionError as e:
        # 借助traceback实现 
        tb_list = traceback.extract_tb(sys.exc_info()[2])
        filename, line_no, func_name, code_str = tb_list[-1]
        print(f"Error Occurred At, 
              f"File: {filename}, "
              f"Line: {line_no}")
        print("Divide by zero error")
        return None

# 调用函数进行除法运算
result = divide(10, 0)
print(result)

进阶用法

这个时候还会有一些问题，就是源头报错文件是一个三方库或者内置库，比如文件位置是python环境site-packages中，那我们打印出来并没有太大的用处，我们想打印的是我们自己写的代码报错位置，而不是内置模块或安装的第三方模块报错的位置信息，只有找到自定义代码位置，才好进行优化修正。

可以使用traceback.extract_stack()替换traceback.extract_tb()，以排除第三方库的源代码位置。

import traceback
import sys

def divide(a, b):
    try:
        c = a / b
        return c
    except ZeroDivisionError as e:
        # 借助traceback实现 
        tb_list = traceback.extract_stack()[:-1]  # 最后一项是当前调用的位置，而不是异常发生的位置
        filename, line_no, func_name, code_str = tb_list[-1]
        print(f"Error Occurred At, 
              f"File: {filename}, "
              f"Line: {line_no}")
        print("Divide by zero error")
        return None

# 调用函数进行除法运算
result = divide(10, 0)
print(result)

使用traceback.extract_stack()方法获取异常发生的完整堆栈信息。然后，使用list slicing来去掉最后一个元素，因为这个元素代表当前调用的位置，而不是异常发生的位置。最后一个元素通常是包含你的调用代码的位置，所以你不想把它包含进来。然后，从可用的堆栈信息中提取最后一个源代码文件名、行号、函数名和代码行来确定异常发生的位置。

这个方法不会包含第三方库的源代码位置，并且只会提取与你的代码相关的源代码位置。

还可以使用Python标准库中的inspect模块的currentframe()函数来获取当前帧。然后，你可以使用traceback.extract_stack()方法来提取堆栈信息，然后使用堆栈信息来逐步比较源文件路径，以找到与当前工程相关的源文件路径。

import os
import inspect
import traceback


def get_project_traceback():
    # 获取当前帧
    frame = inspect.currentframe()
    # 提取堆栈信息（前两个元素是filter和get_project_traceback函数本身的位置）
    tb_list = traceback.extract_stack(frame)[2:]
    # 找到与当前工程相关的源文件路径
    for filename, line_no, func_name, code_str in reversed(tb_list):
        if os.getcwd() in filename:
            return filename, line_no, func_name, code_str
    # 如果都没有找到，则返回最后一个源文件
    filename, line_no, func_name, code_str = tb_list[-1]
    return filename, line_no, func_name, code_str

def divide(a, b):
    try:
        c = a / b
        return c
    except ZeroDivisionError as e:
        filename, line_no, func_name, code_str = get_project_traceback()
        print(f"Error Occurred At, 
              f"File: {filename}, "
              f"Line: {line_no}")
        print("Divide by zero error")
        return None

# 调用函数进行除法运算
result = divide(10, 0)
print(result)

上述代码中，get_project_traceback函数首先使用inspect.currentframe()函数获取当前帧，然后使用traceback.extract_stack(frame)方法提取堆栈信息，前两个元素是filter和get_project_traceback函数本身的位置，所以从第3个元素开始获取。接着，函数使用os.getcwd()来获取当前工程的路径，并逐个比较每个源文件路径，找到与当前工程相关的源文件路径。如果都没有找到，则返回最后一个源文件。

在主代码块中，通过调用get_project_traceback函数来获取与当前工程相关的堆栈信息。当一个异常发生时，该代码段将获取该异常的信息并使用get_project_traceback函数来打印与当前工程相关的堆栈信息。

今天分享了笔者在工作学习当中遇到的try-except问题，希望对大家有帮助！也欢迎大家积极评论，互帮互助！