Question

我目前正在使用Python构建一个非常复杂的系统，当我调试时，我经常将简单的print语句放在几个脚本中。为了保持概述，我经常还要打印出print语句所在的文件名和行号。我当然可以手动完成，或者使用类似的东西：

from inspect import currentframe, getframeinfo
print getframeinfo(currentframe()).filename + ':' + str(getframeinfo(currentframe()).lineno) + ' - ', 'what I actually want to print out here'

打印的内容如下：

filenameX.py:273 - 我实际想要在这里打印出来

为了使它更简单，我希望能够做到这样的事情：

print debuginfo(), 'what I actually want to print out here'

所以我把它放在一个函数中并尝试着：

from debugutil import debuginfo
print debuginfo(), 'what I actually want to print out here'
print debuginfo(), 'and something else here'

不幸的是，我得到了：

debugutil.py:3 - what I actually want to print out here
debugutil.py:3 - and something else here

它打印出我定义函数的文件名和行号，而不是我调用debuginfo（）的行。这很明显，因为代码位于debugutil.py文件中。

所以我的问题实际上是：如何获取调用此debuginfo（）函数的文件名和行号？欢迎提供所有提示！

Answer 1

函数inspect.stack()返回frame records列表，从调用者开始并移出，您可以使用它来获取所需信息：

from inspect import getframeinfo, stack

def debuginfo(message):
    caller = getframeinfo(stack()[1][0])
    print "%s:%d - %s" % (caller.filename, caller.lineno, message)

def grr(arg):
    debuginfo(arg)

grr("aargh")

<强>输出：

example.py:8 - aargh

Answer 2

如果将跟踪代码放在另一个函数中，然后从主代码中调用它，那么您需要确保从祖父母而不是父代或跟踪函数本身获取堆栈信息

下面是3级深度系统的示例，以进一步阐明我的意思。我的主要函数调用了跟踪函数，该函数又调用了另一个函数来完成工作。

######################################

import sys, os, inspect, time
time_start = 0.0                    # initial start time

def trace_libary_init():
    global time_start

    time_start = time.time()      # when the program started

def trace_library_do(relative_frame, msg=""):
    global time_start

    time_now = time.time()

        # relative_frame is 0 for current function (this one), 
        # 1 for direct parent, or 2 for grand parent.. 

    total_stack         = inspect.stack()                   # total complete stack
    total_depth         = len(total_stack)                  # length of total stack
    frameinfo           = total_stack[relative_frame][0]    # info on rel frame
    relative_depth      = total_depth - relative_frame      # length of stack there

        # Information on function at the relative frame number

    func_name           = frameinfo.f_code.co_name
    filename            = os.path.basename(frameinfo.f_code.co_filename)
    line_number         = frameinfo.f_lineno                # of the call
    func_firstlineno    = frameinfo.f_code.co_firstlineno

    fileline            = "%s:%d" % (filename, line_number)
    time_diff           = time_now - time_start

    print("%13.6f %-20s %-24s %s" % (time_diff, fileline, func_name, msg))

################################

def trace_do(msg=""):
    trace_library_do(1, "trace within interface function")
    trace_library_do(2, msg)
    # any common tracing stuff you might want to do...

################################

def main(argc, argv):
    rc=0
    trace_libary_init()
    for i in range(3):
        trace_do("this is at step %i" %i)
        time.sleep((i+1) * 0.1)         # in 1/10's of a second
    return rc

rc=main(sys.argv.__len__(), sys.argv)
sys.exit(rc)

这将打印如下内容：

$ python test.py 
    0.000005 test.py:39           trace_do         trace within interface func
    0.001231 test.py:49           main             this is at step 0
    0.101541 test.py:39           trace_do         trace within interface func
    0.101900 test.py:49           main             this is at step 1
    0.302469 test.py:39           trace_do         trace within interface func
    0.302828 test.py:49           main             this is at step 2

顶部的trace_library_do（）函数是您可以放入库中，然后从其他跟踪函数调用它的示例。相对深度值控制要打印的python堆栈中的哪个条目。

我展示了在该函数中提取其他一些有趣的值，例如函数开始的行号，总堆栈深度以及文件的完整路径。我没有显示它，但是该函数中的全局变量和局部变量也可以在inspect中使用，以及到您下面的所有其他函数的完整堆栈跟踪。我上面显示的内容有足够的信息来进行分层的呼叫/返回定时跟踪。实际上，从这里创建您自己的源代码级调试器的主要部分并没有那么多，而且几乎都只是坐在那里等待使用。

我确定有人会反对我正在使用内部字段以及检查结构返回的数据，因为很可能会有访问函数为您执行相同的操作。但是我是通过在python调试器中逐步检查这种类型的代码而发现它们的，并且它们至少在这里起作用。我正在运行python 2.7.12，如果您运行的是其他版本，则结果可能会非常好。

无论如何，我强烈建议您将检查代码导入自己的某些python代码中，并查看它可以为您提供的内容-特别是如果您可以在一个好的python调试器中单步执行代码。您将学到很多有关python如何工作的知识，并了解该语言的好处以及使之成为现实的幕后事情。

带有时间戳的完整源代码级别跟踪是一种增强您对代码执行情况的理解的好方法，尤其是在动态实时环境中。这种跟踪代码的优点在于，一旦编写了跟踪代码，就无需调试器支持即可看到它。

Answer 3

printstack 软件包现在可以为您做到这一点：

import printstack

print('Hello!')

# Hello!          File "/link/to/your/file.py", line 3, in <module>

PyCharm 将自动使文件链接可点击/可关注。

通过 pip install printstack 安装。

Answer 4

只需将您发布的代码放入函数中：

from inspect import currentframe, getframeinfo

def my_custom_debuginfo(message):
    print getframeinfo(currentframe()).filename + ':' + str(getframeinfo(currentframe()).lineno) + ' - ', message

然后根据需要使用它：

# ... some code here ...
my_custom_debuginfo('what I actually want to print out here')
# ... more code ...

我建议您将该功能放在一个单独的模块中，这样您就可以在每次需要时重复使用它。

Answer 5

发现此问题是一个与之相关的问题，但我想获得更多详细信息：执行（而且我不想安装整个调用图包）。

如果需要更多详细信息，可以使用标准库模块traceback检索完整的追溯，并使用traceback.extract_stack()存放堆栈对象（元组列表）或使用进行打印traceback.print_stack()。这更适合我的需求，希望对其他人有帮助！

Answer 6

使用字符串插值更新已接受的答案并显示调用者的函数名称。

import inspect
def debuginfo(message):
    caller = inspect.getframeinfo(inspect.stack()[1][0])
    print(f"{caller.filename}:{caller.function}:{caller.lineno} - {message}")

Python调试：获取调用函数的文件名和行号？

6 个答案: