Документация Python неофициальный перевод
Содержание страницы

26.2. pdb – Отладчик Pythonpdb – The Python Debugger

Модуль pdb определяет интерактивный отладчик исходного кода для программ на Python. Он поддерживает установку (условных) точек останова и пошаговое выполнение на уровне строк исходного кода, просмотр стековых фреймов, вывод исходного кода и выполнение произвольного кода Python в контексте любого стекового фрейма. Также поддерживается посмертная отладка и возможность вызова под управлением программы.

Отладчик расширяем – он фактически определён как класс Pdb. В настоящее время это не документировано, но легко понять, прочитав исходный код. Интерфейс расширения использует модули bdb и cmd.

Приглашение отладчика – (Pdb). Обычно для запуска программы под управлением отладчика используется:

>>> import pdb
>>> import mymodule
>>> pdb.run('mymodule.test()')
> <string>(0)?()
(Pdb) continue
> <string>(1)?()
(Pdb) continue
NameError: 'spam'
> <string>(1)?()
(Pdb)

pdb.py также можно вызвать как скрипт для отладки других скриптов. Например:

python3 -m pdb myscript.py

При вызове в качестве скрипта pdb автоматически переходит в режим посмертной отладки, если отлаживаемая программа завершается аварийно. После посмертной отладки (или после нормального завершения программы) pdb перезапускает программу. Автоматический перезапуск сохраняет состояние pdb (например, точки останова) и в большинстве случаев полезнее, чем выход из отладчика при завершении программы.

Новое в версии 3.2: pdb.py теперь принимает параметр -c, который выполняет команды так, как если бы они были заданы в файле .pdbrc; см. Команды отладчика.

Обычный способ войти в отладчик из работающей программы – вставить

import pdb; pdb.set_trace()

в том месте, где нужно войти в отладчик. После этого можно пошагово выполнять код, следующий за этим оператором, и продолжить выполнение без отладчика с помощью команды continue.

Типичное использование для анализа аварийно завершившейся программы:

>>> import pdb
>>> import mymodule
>>> mymodule.test()
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
  File "./mymodule.py", line 4, in test
    test2()
  File "./mymodule.py", line 3, in test2
    print(spam)
NameError: spam
>>> pdb.pm()
> ./mymodule.py(3)test2()
-> print(spam)
(Pdb)

Модуль определяет следующие функции; каждая из них запускает отладчик немного по-своему:

pdb.run(statement, globals=None, locals=None)

Выполняет statement (заданный как строка или объект кода) под управлением отладчика. Приглашение отладчика появляется перед выполнением любого кода; можно установить точки останова и ввести continue, или пошагово выполнить оператор с помощью step или next (все эти команды описаны ниже). Необязательные аргументы globals и locals задают окружение, в котором выполняется код; по умолчанию используется словарь модуля __main__. (См. описание встроенных функций exec() или eval().)

pdb.runeval(expression, globals=None, locals=None)

Вычисляет expression (заданное как строка или объект кода) под управлением отладчика. Когда runeval() возвращает результат, она возвращает значение выражения. В остальном эта функция аналогична run().

pdb.runcall(function, *args, **kwds)

Вызывает function (объект функции или метода, не строка) с заданными аргументами. Когда runcall() возвращает результат, она возвращает то, что вернул вызов функции. Приглашение отладчика появляется сразу после входа в функцию.

pdb.set_trace()

Выполняет вход в отладчик на стековом фрейме вызвавшей функции. Это полезно для установки точки останова в заданном месте программы, даже если в остальном код не отлаживается (например, при ошибке утверждения).

pdb.post_mortem(traceback=None)

Запускает посмертную отладку для указанного объекта traceback. Если объект traceback не указан, используется объект traceback текущего обрабатываемого исключения (исключение должно обрабатываться, чтобы значение по умолчанию сработало).

pdb.pm()

Входит в режим посмертной отладки по трассировке, находящейся в sys.last_traceback.

Функции run* и set_trace() являются псевдонимами для создания экземпляра класса Pdb и вызова метода с тем же именем. Если нужно получить доступ к дополнительным возможностям, придётся сделать это самостоятельно:

class pdb.Pdb(completekey='tab', stdin=None, stdout=None, skip=None, nosigint=False)

Pdb – это класс отладчика.

Аргументы completekey, stdin и stdout передаются базовому классу cmd.Cmd; см. описание там.

Аргумент skip, если задан, должен быть итерабельным с шаблонами имён модулей в стиле glob. Отладчик не будет входить в фреймы, происходящие из модуля, который соответствует одному из этих шаблонов. [1]

By default, Pdb sets a handler for the SIGINT signal (which is sent when the user presses Ctrl-C on the console) when you give a continue command. This allows you to break into the debugger again by pressing Ctrl-C. If you want Pdb not to touch the SIGINT handler, set nosigint tot true.

Пример вызова для включения трассировки с skip:

import pdb; pdb.Pdb(skip=['django.*']).set_trace()

Новое в версии 3.1: Аргумент skip.

Новое в версии 3.2: Аргумент nosigint. Ранее обработчик SIGINT никогда не устанавливался Pdb.

run(statement, globals=None, locals=None)
runeval(expression, globals=None, locals=None)
runcall(function, *args, **kwds)
set_trace()

См. документацию по функциям, описанным выше.

26.2.1. Команды отладчикаDebugger Commands

Команды, распознаваемые отладчиком, перечислены ниже. Большинство команд можно сократить до одной или двух букв, как указано; например, h(elp) означает, что для ввода команды help можно использовать как h, так и help (но не he или hel, а также не H, Help или HELP). Аргументы команд должны разделяться пробельными символами (пробелами или табуляциями). Необязательные аргументы заключаются в квадратные скобки ([]) в синтаксисе команды; сами квадратные скобки вводить не нужно. Альтернативы в синтаксисе команды разделяются вертикальной чертой (|).

Ввод пустой строки повторяет последнюю введённую команду. Исключение: если последней командой была list, то выводятся следующие 11 строк.

Команды, которые отладчик не распознает, считаются операторами Python и выполняются в контексте отлаживаемой программы. Операторы Python также можно начинать с восклицательного знака (!). Это мощный способ исследовать отлаживаемую программу; можно даже изменить переменную или вызвать функцию. Если в таком операторе возникает исключение, выводится его имя, но состояние отладчика не меняется.

Отладчик поддерживает псевдонимы. Псевдонимы могут иметь параметры, что обеспечивает некоторую гибкость в зависимости от контекста.

Несколько команд можно ввести в одной строке, разделив их ;;. (Одиночный ; не используется, так как он является разделителем для нескольких команд в строке, передаваемой парсеру Python.) При разделении команд не применяется никакая интеллектуальная обработка; входная строка разбивается по первой паре ;;, даже если она находится внутри строки в кавычках.

Если файл .pdbrc существует в домашнем каталоге пользователя или в текущем каталоге, он считывается и выполняется так, как если бы он был введён в приглашении отладчика. Это особенно полезно для псевдонимов. Если существуют оба файла, сначала считывается файл из домашнего каталога, и определённые в нём псевдонимы могут быть переопределены локальным файлом.

Изменено в версии 3.2: .pdbrc теперь может содержать команды для продолжения отладки, такие как continue или next. Ранее эти команды не действовали.

h(elp) [command]

Без аргументов выводит список доступных команд. С аргументом command выводит справку об этой команде. help pdb выводит полную документацию (строку документации модуля pdb). Поскольку аргумент command должен быть идентификатором, для получения справки по команде ! необходимо ввести help exec.

w(here)

Печатает трассировку стека, причём самый новый фрейм находится внизу. Стрелка указывает на текущий фрейм, который определяет контекст большинства команд.

d(own) [count]

Переместить текущий кадр на count (по умолчанию один) уровней вниз по трассировке стека (к более новому кадру).

u(p) [count]

Переместить текущий кадр на count (по умолчанию один) уровней вверх по трассировке стека (к более старому кадру).

b(reak) [([filename:]lineno | function) [, condition]]

С аргументом lineno устанавливает точку остановки на этой строке в текущем файле. С аргументом function устанавливает точку остановки на первом выполняемом операторе в этой функции. Номер строки может быть указан с префиксом имени файла и двоеточием, чтобы задать точку остановки в другом файле (возможно, ещё не загруженном). Файл ищется в sys.path. Обратите внимание, что каждой точке остановки присваивается номер, на который ссылаются все остальные команды для точек остановки.

Если присутствует второй аргумент, это выражение, которое должно вычисляться в true (истина), чтобы точка останова сработала.

Без аргумента выводит список всех точек останова, включая для каждой точки останова количество срабатываний, текущий счётчик игнорирования и связанное условие, если оно есть.

tbreak [([filename:]lineno | function) [, condition]]

Временная точка остановки, которая удаляется автоматически при первом срабатывании. Аргументы те же, что и для break.

cl(ear) [filename:lineno | bpnumber [bpnumber ...]]

С аргументом filename:lineno удаляет все точки останова на этой строке. С разделённым пробелами списком номеров точек останова удаляет указанные точки останова. Без аргумента удаляет все точки останова (но сначала запрашивает подтверждение).

disable [bpnumber [bpnumber ...]]

Отключает точки останова, заданные разделённым пробелами списком номеров точек останова. Отключение точки останова означает, что она не может приостановить выполнение программы, но в отличие от удаления точки останова, она остаётся в списке точек останова и может быть (повторно) включена.

enable [bpnumber [bpnumber ...]]

Включает указанные точки останова.

ignore bpnumber [count]

Устанавливает счётчик игнорирования для заданного номера точки останова. Если счётчик не указан, счётчик игнорирования устанавливается в 0. Точка останова становится активной, когда счётчик игнорирования равен нулю. Если он не равен нулю, счётчик уменьшается каждый раз, когда точка останова достигается, и она не отключена, и любое связанное с ней условие истинно.

condition bpnumber [condition]

Устанавливает новое condition для точки останова – выражение, которое должно вычисляться в true, чтобы точка останова сработала. Если condition отсутствует, любое существующее условие удаляется; т.е. точка останова становится безусловной.

commands [bpnumber]

Задаёт список команд для точки остановки с номером bpnumber. Сами команды указываются на следующих строках. Введите строку, содержащую только end, чтобы завершить список команд. Пример:

(Pdb) commands 1
(com) print some_variable
(com) end
(Pdb)

Чтобы удалить все команды из точки остановки, введите commands и сразу за ним end; то есть не указывайте никаких команд.

Без аргумента bpnumber команда commands относится к последней установленной точке останова.

Можно использовать команды точки останова, чтобы снова запустить программу. Просто используйте команду continue, или step, или любую другую команду, возобновляющую выполнение.

Указание любой команды, возобновляющей выполнение (в настоящее время continue, step, next, return, jump, quit и их сокращения), завершает список команд (как если бы после этой команды сразу следовал end). Это связано с тем, что при каждом возобновлении выполнения (даже с помощью простого next или step) можно встретить другую точку остановки, у которой может быть свой список команд, что приводит к неоднозначности относительно того, какой список выполнять.

Если в списке команд используется команда ‘silent’, обычное сообщение об остановке на точке останова не выводится. Это может быть удобно для точек останова, которые должны выводить определённое сообщение и затем продолжать. Если никакие другие команды ничего не выводят, вы не увидите признака того, что точка останова была достигнута.

s(tep)

Выполняет текущую строку, останавливается при первой возможности (либо в вызываемой функции, либо на следующей строке в текущей функции).

n(ext)

Продолжает выполнение до тех пор, пока не будет достигнута следующая строка в текущей функции или пока функция не вернётся. (Разница между next и step в том, что step останавливается внутри вызванной функции, а next выполняет вызванные функции (почти) на полной скорости, останавливаясь только на следующей строке в текущей функции.)

unt(il) [lineno]

Без аргумента продолжает выполнение до строки с номером, большим текущего.

С номером строки продолжает выполнение до достижения строки с номером, большим или равным указанному. В обоих случаях также останавливается при возврате из текущего фрейма.

Изменено в версии 3.2: Разрешено указывать явный номер строки.

r(eturn)

Продолжает выполнение до возврата текущей функции.

c(ont(inue))

Продолжает выполнение, останавливаясь только при встрече точки останова.

j(ump) lineno

Устанавливает следующую строку для выполнения. Доступно только в самом нижнем фрейме. Это позволяет вернуться назад и выполнить код снова, или перейти вперёд, пропустив ненужный код.

Следует отметить, что не все переходы разрешены – например, нельзя перейти в середину цикла for или выйти из блока finally.

l(ist) [first[, last]]

Выводит исходный код текущего файла. Без аргументов выводит 11 строк вокруг текущей строки или продолжает предыдущий вывод. С . в качестве аргумента выводит 11 строк вокруг текущей строки. С одним аргументом выводит 11 строк вокруг указанной строки. С двумя аргументами выводит заданный диапазон; если второй аргумент меньше первого, он интерпретируется как количество.

Текущая строка в текущем фрейме помечается ->. Если отлаживается исключение, строка, где оно было первоначально вызвано или распространено, помечается >>, если она отличается от текущей.

Новое в версии 3.2: >> маркер.

ll | longlist

Выводит весь исходный код текущей функции или фрейма. Интересные строки помечаются так же, как для list.

Новое в версии 3.2.

a(rgs)

Печатает список аргументов текущей функции.

p(rint) expression

Вычисляет выражение в текущем контексте и выводит его значение.

pp expression

Как команда print, но значение выражения красиво печатается с помощью модуля pprint.

whatis expression

Выводит тип выражения.

source expression

Пытается получить исходный код для указанного объекта и отобразить его.

Новое в версии 3.2.

display [expression]

Отображает значение выражения, если оно изменилось, каждый раз при остановке выполнения в текущем фрейме.

Без выражения выводит список всех отображаемых выражений для текущего фрейма.

Новое в версии 3.2.

undisplay [expression]

Больше не отображает выражение в текущем фрейме. Без выражения очищает все отображаемые выражения для текущего фрейма.

Новое в версии 3.2.

interact

Запускает интерактивный интерпретатор (с помощью модуля code), глобальное пространство имён которого содержит все (глобальные и локальные) имена, найденные в текущей области видимости.

Новое в версии 3.2.

alias [name [command]]

Создаёт псевдоним с именем name, который выполняет команду. Команда не должна заключаться в кавычки. Заменяемые параметры могут обозначаться как %1, %2 и так далее, а %* заменяется всеми параметрами. Если команда не указана, показывается текущий псевдоним для name. Если аргументы не указаны, выводятся все псевдонимы.

Псевдонимы могут быть вложенными и могут содержать всё, что можно ввести в приглашении pdb. Обратите внимание, что внутренние команды pdb могут быть переопределены псевдонимами. Такая команда затем скрывается, пока псевдоним не удалён. Псевдонимы рекурсивно применяются к первому слову командной строки; все остальные слова в строке остаются нетронутыми.

В качестве примера, вот два полезных псевдонима (особенно если поместить их в файл .pdbrc):

# Вывести переменные экземпляра (использование "pi classInst")
alias pi for k in %1.__dict__.keys(): print("%1.",k,"=",%1.__dict__[k])
# Вывести переменные экземпляра в self
alias ps pi self
unalias name

Удаляет указанный псевдоним.

! statement

Выполняет (однострочную) инструкцию в контексте текущего кадра стека. Восклицательный знак можно опустить, если первое слово инструкции не похоже на команду отладчика. Чтобы задать глобальную переменную, можно добавить оператор global перед командой присваивания в той же строке, например:

(Pdb) global list_options; list_options = ['-l']
(Pdb)
run [args ...]
restart [args ...]

Перезапускает отлаживаемую программу Python. Если указан аргумент, он разбивается с помощью shlex, и результат используется как новый sys.argv. История, точки останова, действия и параметры отладчика сохраняются. restart является псевдонимом для run.

q(uit)

Выход из отладчика. Выполнение программы прерывается.

Сноски

[1]Считается ли кадр происходящим из определённого модуля, определяется по __name__ в глобальных переменных кадра.