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

问题描述 投票：0回答：7

我目前正在用Python构建一个相当复杂的系统，当我调试时，我经常在几个脚本中放入简单的打印语句。为了保持概览，我经常还想打印出打印语句所在的文件名和行号。我当然可以手动执行此操作，或者使用类似的方法：

from inspect import currentframe, getframeinfo

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

打印出如下内容：

filenameX.py:273 - what I actually want to print out here

为了使其更简单，我希望能够执行以下操作：

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() 函数的文件名和行号？

python debugging line-numbers inspect
7个回答
114
投票

函数

inspect.stack()
返回一个帧记录列表，从调用者开始并移出，您可以使用它来获取您想要的信息：

from inspect import getframeinfo, stack

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

def grr(arg):
    debuginfo(arg)      # <-- stack()[1][0] for this line

grr("aargh")            # <-- stack()[2][0] for this line

输出：

example.py:8 - aargh
8
投票

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

下面是一个 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 堆栈中的哪个条目。

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

我确信有人会反对我使用带有检查结构返回的数据的内部字段，因为很可能有访问函数为您做同样的事情。但我通过在 python 调试器中单步执行此类代码找到了它们，并且它们至少在这里可以工作。我正在运行 python 2.7.12，如果您运行不同的版本，您的结果可能会非常不同。

无论如何，我强烈建议你将检查代码导入到你自己的一些Python代码中，并看看它能为你提供什么——特别是如果你可以在一个好的Python调试器中单步执行你的代码。您将学到很多关于 Python 工作原理的知识，并了解该语言的优点以及实现这一目标的幕后工作。

带有时间戳的完整源代码级别跟踪是增强您对代码正在执行的操作的理解的好方法，尤其是在动态实时环境中。这种类型的跟踪代码的优点在于，一旦编写完成，您就不需要调试器支持来查看它。

4
投票

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

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

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

import traceprint


def func():
    print('Hello from func!')

func()

#   File "/traceprint/examples/example.py", line 6, in <module>
#   File "/traceprint/examples/example.py", line 4, in func
# Hello from func!

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

通过

pip install traceprint
安装。

1
投票

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

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 ...

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

1
投票

发现这个问题是为了解决一些相关的问题，但我想要更多详细信息：执行（并且我不想安装整个调用图包）。

如果您想要更详细的信息，您可以使用标准库模块 traceback 检索完整的回溯，并使用 

traceback.extract_stack()
存储堆栈对象（元组列表）或使用 
traceback.print_stack()
打印出来。这更适合我的需求，希望对其他人有帮助！

1
投票

您可以使用logging模块中内置的python findCaller findCaller 函数，堆栈级别 argument 设置为 2。

前：

import logging

def get_caller_info():
    file_name, line_no, func_name, stack_info = logging.root.findCaller(stacklevel=2)
    print(f"{dict(file_name=file_name,line_no=line_no,func_name=func_name,stack_info=stack_info,)}")


if __name__ == "__main__":
    get_caller_info()

将会输出

{'文件名': 'C

最新问题
© www.soinside.com 2019 - 2024. All rights reserved.