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

Исходный код: Lib/pdb.py

Модуль 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 также можно вызвать как скрипт для отладки других скриптов. Например:

python -m pdb myscript.py

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

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

import pdb; pdb.set_trace()

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

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

>>> import pdb
>>> import mymodule
>>> mymodule.test()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  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[, locals]])¶

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

pdb.runeval(expression[, globals[, locals]])¶

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

pdb.runcall(function[, argument, ...])¶

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

pdb.set_trace()¶

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

pdb.post_mortem([traceback])¶

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

pdb.pm()¶

Запускает посмертную отладку для traceback, найденного в sys.last_traceback.

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

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

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

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

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

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

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

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

run(statement[, globals[, locals]])¶

runeval(expression[, globals[, locals]])¶

runcall(function[, argument, ...])¶

set_trace()¶

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

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

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

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

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

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

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

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

h(elp) [команда]

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

w(here)

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

d(own)

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

u(p)

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

b(reak) [[имя_файла:]номер_строки | функция[, условие]]

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

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

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

tbreak [[имя_файла:]номер_строки | функция[, условие]]

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

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

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

disable [bpnumber [bpnumber …]]

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

enable [bpnumber [bpnumber …]]

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

ignore номер_точки_останова [счётчик]

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

condition номер_точки_останова [условие]

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

commands [номер_точки_останова]

Задаёт список команд для точки останова с номером 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’, обычное сообщение об остановке на точке останова не выводится. Это может быть удобно для точек останова, которые должны выводить определённое сообщение и затем продолжать. Если никакие другие команды ничего не выводят, вы не увидите признака того, что точка останова была достигнута.

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

s(tep)

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

n(ext)

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

unt(il)

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

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

r(eturn)

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

c(ont(inue))

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

j(ump) номер_строки

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

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

l(ist) [первая[, последняя]]

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

a(rgs)

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

p выражение

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

Примечание

print также может использоваться, но это не команда отладчика – выполняется инструкция Python print.

pp выражение

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

alias [имя [команда]]

Создаёт псевдоним с именем 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 имя

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

[!]инструкция

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

(Pdb) global list_options; list_options = ['-l']
(Pdb)

run [аргументы …]

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

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

q(uit)

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

Сноски

1

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