pdb — Дебаггер Python

Команды отладчика

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

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

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

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

Несколько команд могут быть введены в одной строке, разделённые ;;. (Один ; не используется, так как это разделитель нескольких команд в строке, которая передаётся парсеру Python.) Никакая обработка не применяется для разделения команд; вход разбивается на первой паре ;; , даже если она находится посредине строковой константы. Решение для строк с двойными точкой с запятой — использовать неявное конкатенацию строк ';'';' или ";"";".

Для задания временной глобальной переменной используйте удобную переменную. Удобная переменная — это переменная, имя которой начинается с $. Например, $foo = 1 задаёт глобальную переменную $foo, которую вы можете использовать в сеансе отладчика. Удобные переменные очищаются при возобновлении выполнения программы, поэтому они менее склонны к вмешательству в вашу программу по сравнению с использованием обычных переменных, таких как foo = 1.

Существуют три предопределённые удобные переменные:

• $_frame: текущая рамка, которую вы отлаживаете
• $_retval: возвращаемое значение, если рамка возвращается
• $_exception: исключение, если рамка вызывает исключение

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

h(elp) [command]

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

w(here)

Выводит трассировку стека, причём наиболее последняя рамка находится внизу. Стрелка (>) указывает текущую рамку, которая определяет контекст большинства команд.

d(own) [count]

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

u(p) [count]

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

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

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

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

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

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

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

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

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

disable bpnumber [bpnumber ...]

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

enable bpnumber [bpnumber ...]

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

ignore bpnumber [count]

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

condition bpnumber [condition]

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

commands [bpnumber]

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

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

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

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

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

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

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

s(tep)

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

n(ext)

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

unt(il) [lineno]

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

С аргументом lineno продолжить выполнение до строки с номером, равным или большим 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 expression

Оценить выражение в текущем контексте и вывести его значение.

Примечание

print() также может быть использован, но это не команда отладчика — это выполняет функцию Python print().

pp expression

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

whatis expression

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

source expression

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

Добавлена в версии 3.2.

display [expression]

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

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

Примечание

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

Пример:

lst = []
breakpoint()
pass
lst.append(1)
print(lst)

Отображение не заметит, что lst изменился, потому что результат оценки изменяется на месте lst.append(1) перед сравнением:

> example.py(3)<module>()
-> pass
(Pdb) display lst
display lst: []
(Pdb) n
> example.py(4)<module>()
-> lst.append(1)
(Pdb) n
> example.py(5)<module>()
-> print(lst)
(Pdb)

Вы можете использовать некоторые трюки с механизмом копирования, чтобы это сработало:

> example.py(3)<module>()
-> pass
(Pdb) display lst[:]
display lst[:]: []
(Pdb) n
> example.py(4)<module>()
-> lst.append(1)
(Pdb) n
> example.py(5)<module>()
-> print(lst)
display lst[:]: [1]  [old: []]
(Pdb)

Добавлена в версии 3.2.

undisplay [expression]

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

Добавлена в версии 3.2.

interact

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

Добавлена в версии 3.2.

alias [name [command]]

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

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

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

# Print instance variables (usage "pi classInst")
alias pi for k in %1.__dict__.keys(): print(f"%1.{k} = {%1.__dict__[k]}")
# Print instance variables in self
alias ps pi self

unalias name

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

! statement

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

(Pdb) ! n=42
(Pdb)

Для установки глобальной переменной вы можете добавить перед командой присваивания инструкцию global в той же строке, например:

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

run [args ...]

restart [args ...]

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

q(uit)

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

debug code

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

retval

Вывести возвращаемое значение последнего возврата текущей функции.

Примечания