27.6. trace —跟踪或跟踪Python语句执行¶

27.6.1. 命令行用法¶

trace 模块可以从命令行调用。它可以是简单的

python -m trace --count -C . somefile.py ...

以上将执行 somefile.py 并生成在执行期间导入到当前目录中的所有Python模块的注释列表。

--help¶

显示使用和退出。

--version¶

显示模块的版本并退出。

27.6.2. 程序接口¶

class trace.Trace(count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(), ignoredirs=(), infile=None, outfile=None, timing=False)¶

创建一个对象以跟踪单个语句或表达式的执行。所有参数都是可选的。 count 启用行号计数。 trace 启用线路执行跟踪。 countfuncs 启用运行期间调用的函数的列表。 countcallers 启用呼叫关系跟踪。 ignoremods 是要忽略的模块或程序包的列表。 ignoredirs 是其模块或包应该被忽略的目录的列表。 infile 是从其读取存储的计数信息的文件的名称。 outfile 是要写入更新计数信息的文件的名称。 timing 启用相对于显示跟踪开始时的时间戳。

run(cmd)¶

执行命令并使用当前跟踪参数从执行中收集统计信息。 cmd 必须是字符串或代码对象，适合传入 exec()。

runctx(cmd, globals=None, locals=None)¶

在定义的全局和本地环境中，使用当前跟踪参数执行命令并收集执行的统计信息。如果没有定义，globals 和 locals 默认为空字典。

runfunc(func, *args, **kwds)¶

在具有当前跟踪参数的 Trace 对象的控制下调用具有给定参数的 func。

results()¶

返回包含给定 Trace 实例的所有先前对 run，runctx 和 runfunc 的调用的累积结果的 CoverageResults 对象。不复位累积的跟踪结果。

class trace.CoverageResults¶

覆盖结果的容器，由 Trace.results() 创建。不应该由用户直接创建。

update(other)¶

合并来自另一个 CoverageResults 对象的数据。

write_results(show_missing=True, summary=False, coverdir=None)¶

写覆盖结果。设置 show_missing 以显示没有命中的行。设置 summary 以在输出中包括每个模块的coverage概要。 coverdir 指定覆盖结果文件将输出到的目录。如果 None，每个源文件的结果放在其目录中。

一个简单的示例演示使用编程接口:

import sys
import trace

# create a Trace object, telling it what to ignore, and whether to
# do tracing or line-counting or both.
tracer = trace.Trace(
    ignoredirs=[sys.prefix, sys.exec_prefix],
    trace=0,
    count=1)

# run the new command using the given tracer
tracer.run('main()')

# make a report, placing output in the current directory
r = tracer.results()
r.write_results(show_missing=True, coverdir=".")