trace --- 跟踪或记录 Python 语句的执行¶
源代码 ： Lib/trace.py
The trace module allows you to trace program execution, generate
annotated statement coverage listings, print caller/callee relationships and
list functions executed during a program run. It can be used in another program
or from the command line.
参见
- Coverage.py
流行的第三方代码覆盖工具，可输出 HTML ，并提供分支覆盖等高级功能。
命令行用法¶
The trace module can be invoked from the command line. It can be as
simple as
python -m trace --count -C . somefile.py ...
上述命令将执行 somefile.py ，并在当前目录生成执行期间所有已导入 Python 模块的带注解列表。
- --help¶
显示用法并退出。
- --version¶
显示模块版本并退出。
Added in version 3.8: 加入了 --module 选项，允许运行可执行模块。
主要的可选参数¶
At least one of the following options must be specified when invoking
trace. The --listfuncs option is mutually exclusive with
the --trace and --count options. When
--listfuncs is provided, neither --count nor
--trace are accepted, and vice versa.
- -c, --count¶
在程序完成时生成一组带有注解的报表文件，显示每个语句被执行的次数。 参见下面的
-coverdir、-file和-no-report。
- -t, --trace¶
执行时显示每一行。
- -l, --listfuncs¶
显示程序运行时执行到的函数。
- -T, --trackcalls¶
显示程序运行时暴露出来的调用关系。
修饰器¶
- -C, --coverdir=<dir>¶
报表文件的所在目录。
package.module的覆盖率报表将被写入文件dir/package/module.cover。
- -m, --missing¶
生成带注解的报表时，用
>>>>>>标记未执行的行。
- -g, --timing¶
在每一行前面加上时间，自程序运行算起。只在跟踪时有用。
过滤器¶
以下参数可重复多次。
- --ignore-module=<mod>¶
忽略给出的模块名及其子模块（若为包）。参数可为逗号分隔的名称列表。
- --ignore-dir=<dir>¶
忽略指定目录及其子目录下的所有模块和包。参数可为
os.pathsep分隔的目录列表。
编程接口¶
- 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 可以显示相对于跟踪开始时间的时间戳。
- runctx(cmd, globals=None, locals=None)¶
在定义的全局和局部环境中，执行命令并收集当前跟踪参数下的执行统计数据。若没有定义 globals 和 locals ，则默认为空字典。
- results()¶
返回一个
CoverageResults对象，包含之前对指定Trace实例调用run、runctx和runfunc的累积结果。 累积的跟踪结果不会重置。
- class trace.CoverageResults¶
存放代码覆盖结果的容器，由
Trace.results()创建。用户不应直接去创建。- update(other)¶
从另一个
CoverageResults对象中合并代码覆盖数据。
- write_results(show_missing=True, summary=False, coverdir=None, *, ignore_missing_files=False)¶
写入代码覆盖结果。设置 show_missing 可显示未命中的行。设置*summary* 可在输出中包含每个模块的覆盖率摘要信息。 coverdir 可指定覆盖率结果文件的输出目录，为
None则结果将置于源文件所在目录中。如果 ignore_missing_files 为
True，则对于已不存在文件的覆盖计数将被静默地忽略。 在其他情况下，文件不存在将引发FileNotFoundError。在 3.13 版本发生变更: 增加了 ignore_missing_files 形参。
以下例子简单演示了编程接口的用法：
import sys
import trace
# 创建一个 Trace 对象，告诉它要忽略什么，
# 及是否执行跟踪或行计数或者两者均执行。
tracer = trace.Trace(
ignoredirs=[sys.prefix, sys.exec_prefix],
trace=0,
count=1)
# 使用给定的 tracer 运行新命令
tracer.run('main()')
# 生成报告，将输出放入当前目录
r = tracer.results()
r.write_results(show_missing=True, coverdir=".")