`trace.md`

155 строк · 11.9 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.7/library/trace.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`trace`](https://python-all.ru/3.7/library/trace.html#module-trace) – трассировка или отслеживание выполнения инструкций Python89**Исходный код:** [Lib/trace.py](https://python-all.ru/src/3.7/Lib/trace.py)1011---1213Модуль [`trace`](https://python-all.ru/3.7/library/trace.html#module-trace) позволяет трассировать выполнение программы, создавать аннотированные списки покрытия инструкций, выводить отношения вызывающий/вызываемый и перечислять функции, выполненные во время запуска программы. Его можно использовать из другой программы или из командной строки.1415> **См. также**16>17> **[Coverage.py](https://python-all.ru/3.7/library/trace.html)**18>19> Популярный сторонний инструмент для оценки покрытия, который предоставляет HTML-вывод и расширенные возможности, такие как покрытие ветвлений.2021## Использование командной строки2223Модуль [`trace`](https://python-all.ru/3.7/library/trace.html#module-trace) можно вызвать из командной строки. Это может быть так же просто, как2425```python26python -m trace --count -C . somefile.py ...27```2829Приведённая выше команда выполнит `somefile.py` и создаст аннотированные списки всех модулей Python, импортированных во время выполнения, в текущем каталоге.3031#### `--help`3233Показать справку и выйти.3435#### `--version`3637Отображает версию модуля и завершает работу.3839### Основные опции4041При вызове [`trace`](https://python-all.ru/3.7/library/trace.html#module-trace) необходимо указать хотя бы одну из следующих опций. Опция [`--listfuncs`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-l) является взаимоисключающей с опциями [`--trace`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-t) и [`--count`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-c). Если указана [`--listfuncs`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-l), то ни [`--count`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-c), ни [`--trace`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-t) не принимаются, и наоборот.4243#### `-c, --count`4445Создаёт набор аннотированных файлов со списками после завершения программы, показывающих, сколько раз была выполнена каждая инструкция. См. также [`--coverdir`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-coverdir), [`--file`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-f) и [`--no-report`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-no-report) ниже.4647#### `-t, --trace`4849Отображает строки по мере их выполнения.5051#### `-l, --listfuncs`5253Отображает функции, выполненные при запуске программы.5455#### `-r, --report`5657Создаёт аннотированный список на основе предыдущего запуска программы, в котором использовались опции [`--count`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-c) и [`--file`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-f). При этом код не выполняется.5859#### `-T, --trackcalls`6061Отображает отношения вызовов, выявленные при запуске программы.6263### Модификаторы6465#### `-f, --file=<file>`6667Имя файла для накопления счётчиков в течение нескольких трассировок. Должна использоваться с опцией [`--count`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-c).6869#### `-C, --coverdir=<dir>`7071Каталог, в который помещаются файлы отчётов. Отчёт о покрытии для `package.module` записывается в файл `dir/package/module.cover`.7273#### `-m, --missing`7475При создании аннотированных списков помечать строки, которые не были выполнены, символом `>>>>>>`.7677#### `-s, --summary`7879При использовании [`--count`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-c) или [`--report`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-r) выводите краткую сводку в stdout для каждого обработанного файла.8081#### `-R, --no-report`8283Не создавать аннотированные листинги. Это полезно, если планируется выполнить несколько запусков с [`--count`](https://python-all.ru/3.7/library/trace.html#cmdoption-trace-c), а затем в конце сформировать единый набор аннотированных листингов.8485#### `-g, --timing`8687Добавлять к каждой строке время, прошедшее с момента запуска программы. Используется только при трассировке.8889### Фильтры9091Эти опции можно указывать несколько раз.9293#### `--ignore-module=<mod>`9495Игнорировать указанные имена модулей и их подмодули (если это пакет). Аргумент может быть списком имён, разделённых запятыми.9697#### `--ignore-dir=<dir>`9899Игнорировать все модули и пакеты в указанном каталоге и подкаталогах. Аргумент может быть списком каталогов, разделённых [`os.pathsep`](https://python-all.ru/3.7/library/os.html#os.pathsep).100101## Программный интерфейс102103#### `class trace.Trace(count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(), ignoredirs=(), infile=None, outfile=None, timing=False)`104105Создаёт объект для трассировки выполнения одного оператора или выражения. Все параметры необязательны. *count* включает подсчёт номеров строк. *trace* включает трассировку выполнения строк. *countfuncs* включает вывод списка функций, вызванных во время выполнения. *countcallers* включает отслеживание отношений вызовов. *ignoremods* – это список модулей или пакетов, которые следует игнорировать. *ignoredirs* – это список каталогов, модули или пакеты которых следует игнорировать. *infile* – имя файла, из которого считывается сохранённая информация о подсчётах. *outfile* – имя файла, в который записывается обновлённая информация о подсчётах. *timing* включает отображение временной метки относительно момента начала трассировки.106107> #### `run(cmd)`108>109> Выполняет команду и собирает статистику выполнения с текущими параметрами трассировки. *cmd* должен быть строкой или объектом кода, пригодным для передачи в [`exec()`](https://python-all.ru/3.7/library/functions.html#exec).110>111> #### `runctx(cmd, globals=None, locals=None)`112>113> Выполняет команду и собирает статистику выполнения с текущими параметрами трассировки в заданных глобальном и локальном окружениях. Если не заданы, *globals* и *locals* по умолчанию являются пустыми словарями.114>115> #### `runfunc(func, *args, **kwds)`116>117> Вызывает *func* с заданными аргументами под управлением объекта [`Trace`](https://python-all.ru/3.7/library/trace.html#trace.Trace) с текущими параметрами трассировки.118>119> #### `results()`120>121> Возвращает объект [`CoverageResults`](https://python-all.ru/3.7/library/trace.html#trace.CoverageResults), содержащий накопленные результаты всех предыдущих вызовов `run`, `runctx` и `runfunc` для данного экземпляра [`Trace`](https://python-all.ru/3.7/library/trace.html#trace.Trace). Не сбрасывает накопленные результаты трассировки.122123#### `class trace.CoverageResults`124125Контейнер для результатов покрытия, создаваемый [`Trace.results()`](https://python-all.ru/3.7/library/trace.html#trace.Trace.results). Не должен создаваться непосредственно пользователем.126127> #### `update(other)`128>129> Объединяет данные из другого объекта [`CoverageResults`](https://python-all.ru/3.7/library/trace.html#trace.CoverageResults).130>131> #### `write_results(show_missing=True, summary=False, coverdir=None)`132>133> Записывает результаты покрытия. Установите *show\_missing*, чтобы отображать строки, которые не были выполнены. Установите *summary*, чтобы включить в вывод сводку покрытия для каждого модуля. *coverdir* задаёт каталог, в который будут выведены файлы результатов покрытия. Если `None`, результаты для каждого исходного файла помещаются в его собственный каталог.134135Простой пример, демонстрирующий использование программного интерфейса:136137```python138import sys139import trace140141# создать объект Trace, указав, что игнорировать и нужно ли142# выполнять трассировку или подсчёт строк, или и то и другое143tracer = trace.Trace(144    ignoredirs=[sys.prefix, sys.exec_prefix],145    trace=0,146    count=1)147148# запустить новую команду с помощью указанного трассировщика149tracer.run('main()')150151# сформировать отчёт, помещая вывод в текущий каталог152r = tracer.results()153r.write_results(show_missing=True, coverdir=".")154```155