如何在 Python 中获取文件名和行号

Python 2023-05-16

在 Python 中获取文件名和行号是一项常见且非常有用的任务。这通常用于调试和错误报告，以确定代码中出现了哪些问题。本文将介绍如何使用 Python 获取文件名和行号，并提供一些示例和注意事项。

获取当前文件名和行号

获取当前文件名和行号是获取调试信息的第一步。Python 提供了一个内置模块 inspect，它包含各种有用的函数和类，用于审查 Python 源代码的运行时信息。其中一个函数是 getframeinfo，它返回一个 FrameInfo 对象，其中包含当前帧的文件名和行号。

以下是一个示例：

import inspect

def current_line():
    frameinfo = inspect.getframeinfo(inspect.currentframe())
    return (frameinfo.filename, frameinfo.lineno)

print(current_line())

结果将是当前文件名和行号的元组。

获取调用者的文件名和行号

除了获取当前文件名和行号，还可以获取调用者的文件名和行号。这对于通过日志或错误报告跟踪错误非常有用。要获取调用者的文件名和行号，可以使用 getframeinfo 函数的 stack 方法。它返回调用者的堆栈帧列表，其中包含其他帧信息对象。

以下是一个示例：

import inspect

def caller_line():
    frameinfo = inspect.getframeinfo(inspect.stack()[1][0])
    return (frameinfo.filename, frameinfo.lineno)

def demo():
    print(caller_line())

demo()

在这个例子中，我们定义了两个函数。caller_line 函数使用 inspect.stack 返回的堆栈帧列表来获取调用者的文件名和行号。它使用 [1][0] 告诉 inspect.stack 返回的堆栈帧列表中的第二个帧，因为第一个帧是当前帧。

demo 函数调用 caller_line 函数，并打印返回的元组。

注意事项

在使用 inspect 模块时，请注意以下事项：

inspect.currentframe 返回当前帧，而 inspect.stack 返回堆栈帧列表。在大多数情况下，您应该使用 inspect.stack 而不是 inspect.currentframe。
使用 inspect 标准库会导致一些性能问题，因此不应在生产代码中频繁使用。如果您要执行复杂的审计任务，请考虑使用专门的工具，例如 PyCharm。
在某些情况下，inspect 模块可能会返回错误的行号。这是由于 Python 解释器的优化措施导致的。如果遇到此问题，请确保您使用的是最新版本的 Python，并尝试在调试模式下运行。
当使用 inspect.stack 时，确保您知道代码的运行路径。使用 os.path.abspath 来转换相对路径和绝对路径。

代码示例

以下是一个使用 inspect 模块的完整示例代码，包括获取当前文件名和行号，调用者的文件名和行号，以及在迭代器中获取行号：

import inspect
import os

def get_current_file_and_line():
    frameinfo = inspect.getframeinfo(inspect.currentframe())
    return (frameinfo.filename, frameinfo.lineno)

def get_caller_file_and_line():
    frameinfo = inspect.getframeinfo(inspect.stack()[1][0])
    return (frameinfo.filename, frameinfo.lineno)

def get_line_number_in_file(file_path, line_number):
    with open(file_path, "r") as file:
        lines = file.readlines()
        return lines[line_number - 1]

def demo():
    print("Current file and line:", get_current_file_and_line())
    print("Caller file and line:", get_caller_file_and_line())
    print("Line number in file:", get_line_number_in_file(os.path.abspath(__file__), get_current_file_and_line()[1]))

demo()