26.5. trace – трассировка и отслеживание выполнения операторов Python¶trace – Trace or track Python statement execution

26.5.1. Использование командной строки¶Command-Line Usage

Модуль trace можно вызвать из командной строки. Например, так:

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

Приведённая выше команда выполнит somefile.py и создаст аннотированные списки всех модулей Python, импортированных во время выполнения, в текущем каталоге.

--help¶

Показать справку и выйти.

--version¶

Отображает версию модуля и завершает работу.

26.5.2. Программный интерфейс¶Programmatic Interface

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)¶

Вызывает func с заданными аргументами под управлением объекта Trace с текущими параметрами трассировки.

results()¶

Возвращает объект CoverageResults, содержащий накопленные результаты всех предыдущих вызовов run, runctx и runfunc для данного экземпляра Trace. Не сбрасывает накопленные результаты трассировки.

class trace.CoverageResults¶

Контейнер для результатов покрытия, создаваемый вызовом Trace.results(). Не должен создаваться напрямую пользователем.

update(other)¶

Объединяет данные из другого объекта CoverageResults.

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

Записывает результаты покрытия. Установите show_missing, чтобы показывать строки, которые не были выполнены. Установите summary, чтобы включить в вывод сводку покрытия по модулям. coverdir задает каталог, в который будут выводиться файлы результатов покрытия. Если None, результаты для каждого исходного файла помещаются в его каталог.

Простой пример, демонстрирующий использование программного интерфейса:

import sys
import trace

# создать объект Trace, указав, что игнорировать и нужно ли
# выполнять трассировку или подсчёт строк, или и то и другое
tracer = trace.Trace(
    ignoredirs=[sys.prefix, sys.exec_prefix],
    trace=0,
    count=1)

# запустить новую команду с помощью указанного трассировщика
tracer.run('main()')

# сформировать отчёт, помещая вывод в текущий каталог
r = tracer.results()
r.write_results(show_missing=True, coverdir=".")