pdb.md

1> **Источник:** https://python-all.ru/3.1/library/pdb.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 26.2. `pdb` – отладчик Python89Модуль `pdb` определяет интерактивный отладчик исходного кода для программ на Python. Он поддерживает установку (условных) точек останова и пошаговое выполнение на уровне строк исходного кода, просмотр стековых кадров, вывод исходного кода и выполнение произвольного кода Python в контексте любого стекового кадра. Также поддерживается посмертная отладка, и его можно вызывать из программы.1011Отладчик расширяем – фактически он определён как класс [`Pdb`](https://python-all.ru/3.1/library/pdb.html#pdb.Pdb). В настоящее время это не документировано, но легко понять, прочитав исходный код. Интерфейс расширения использует модули [`bdb`](https://python-all.ru/3.1/library/bdb.html#module-bdb) (недокументированный) и [`cmd`](https://python-all.ru/3.1/library/cmd.html#module-cmd).1213Приглашение отладчика – `(Pdb)`. Обычно для запуска программы под управлением отладчика используется:1415```python16>>> import pdb17>>> import mymodule18>>> pdb.run('mymodule.test()')19> <string>(0)?()20(Pdb) continue21> <string>(1)?()22(Pdb) continue23NameError: 'spam'24> <string>(1)?()25(Pdb)26```2728`pdb.py` также можно вызвать как скрипт для отладки других скриптов. Например:2930```python31python3 -m pdb myscript.py32```3334При запуске как скрипта pdb автоматически переходит в режим посмертной отладки, если отлаживаемая программа завершается аварийно. После посмертной отладки (или после нормального завершения программы) pdb перезапускает программу. Автоматический перезапуск сохраняет состояние pdb (например, точки останова) и в большинстве случаев полезнее, чем выход из отладчика при завершении программы.3536Обычный способ войти в отладчик из работающей программы – вставить3738```python39import pdb; pdb.set_trace()40```4142в том месте, где нужно войти в отладчик. Затем можно выполнять код по шагам после этого оператора и продолжить выполнение без отладчика с помощью команды `c`.4344Типичное использование для анализа аварийно завершившейся программы:4546```python47>>> import pdb48>>> import mymodule49>>> mymodule.test()50Traceback (most recent call last):51  File "<stdin>", line 1, in ?52  File "./mymodule.py", line 4, in test53    test2()54  File "./mymodule.py", line 3, in test255    print(spam)56NameError: spam57>>> pdb.pm()58> ./mymodule.py(3)test2()59-> print(spam)60(Pdb)61```6263Модуль определяет следующие функции; каждая из них запускает отладчик немного по-своему:6465#### `pdb.run(statement[, globals[, locals]])`6667Выполняет6869*statement*7071(заданный строкой) под управлением отладчика. Приглашение отладчика появляется перед выполнением любого кода; можно установить точки останова и ввести7273`continue`7475, или выполнять оператор по шагам с помощью7677`step`7879или8081`next`8283(все эти команды описаны ниже). Необязательные аргументы8485*globals*8687и8889*locals*9091задают окружение, в котором выполняется код; по умолчанию используется словарь модуля9293[`__main__`](https://python-all.ru/3.1/library/__main__.html#module-__main__)9495. (См. описание встроенных функций9697[`exec()`](https://python-all.ru/3.1/library/functions.html#exec)9899или100101[`eval()`](https://python-all.ru/3.1/library/functions.html#eval)102103.)104105#### `pdb.runeval(expression[, globals[, locals]])`106107Вычисляет108109*expression*110111(заданный строкой) под управлением отладчика. Когда112113[`runeval()`](https://python-all.ru/3.1/library/pdb.html#pdb.runeval)114115возвращает управление, возвращается значение выражения. В остальном эта функция аналогична116117[`run()`](https://python-all.ru/3.1/library/pdb.html#pdb.run)118119.120121#### `pdb.runcall(function[, argument, ...])`122123Вызывает124125*function*126127(объект функции или метода, не строку) с указанными аргументами. Когда128129[`runcall()`](https://python-all.ru/3.1/library/pdb.html#pdb.runcall)130131возвращает управление, возвращается то, что вернул вызов функции. Приглашение отладчика появляется сразу после входа в функцию.132133#### `pdb.set_trace()`134135Выполняет вход в отладчик на стековом фрейме вызвавшей функции. Это полезно для установки точки останова в заданном месте программы, даже если в остальном код не отлаживается (например, при ошибке утверждения).136137#### `pdb.post_mortem([traceback])`138139Запускает посмертную отладку для указанного объекта140141*traceback*142143. Если объект144145*traceback*146147не указан, используется объект traceback текущего обрабатываемого исключения (исключение должно обрабатываться, чтобы значение по умолчанию сработало).148149#### `pdb.pm()`150151Входит в режим посмертной отладки по трассировке, находящейся в152153[`sys.last_traceback`](https://python-all.ru/3.1/library/sys.html#sys.last_traceback)154155.156157Функции `run*` и [`set_trace()`](https://python-all.ru/3.1/library/pdb.html#pdb.set_trace) являются псевдонимами для создания экземпляра класса [`Pdb`](https://python-all.ru/3.1/library/pdb.html#pdb.Pdb) и вызова метода с тем же именем. Если нужно получить доступ к дополнительным возможностям, придётся сделать это самостоятельно:158159#### `class pdb.Pdb(completekey='tab', stdin=None, stdout=None, skip=None)`160161[`Pdb`](https://python-all.ru/3.1/library/pdb.html#pdb.Pdb) – это класс отладчика.162163Аргументы *completekey*, *stdin* и *stdout* передаются базовому классу [`cmd.Cmd`](https://python-all.ru/3.1/library/cmd.html#cmd.Cmd); см. описание там.164165Аргумент *skip*, если задан, должен быть итерабельным с шаблонами имён модулей в стиле glob. Отладчик не будет входить в фреймы, происходящие из модуля, который соответствует одному из этих шаблонов. [\[1\]](https://python-all.ru/3.1/library/pdb.html#id3)166167Пример вызова для включения трассировки с *skip*:168169```python170import pdb; pdb.Pdb(skip=['django.*']).set_trace()171```172173Новое в версии 3.1: аргумент *skip*.174175#### `run(statement[, globals[, locals]])`176177#### `runeval(expression[, globals[, locals]])`178179#### `runcall(function[, argument, ...])`180181#### `set_trace()`182183См. документацию по функциям, описанным выше.184185## 26.2.1. Команды отладчика186187Отладчик распознаёт следующие команды. Большинство команд можно сократить до одной или двух букв; например, `h(elp)` означает, что для ввода команды help можно использовать как `h`, так и `help` (но не `he` или `hel`, а также не `H`, `Help` или `HELP`). Аргументы команд должны разделяться пробельными символами (пробелами или табуляцией). Необязательные аргументы заключаются в квадратные скобки (`[]`) в синтаксисе команд; сами квадратные скобки вводить не нужно. Альтернативы в синтаксисе команд разделяются вертикальной чертой (`|`).188189Ввод пустой строки повторяет последнюю введённую команду. Исключение: если последней командой была `list`, то выводятся следующие 11 строк.190191Команды, которые отладчик не распознает, считаются операторами Python и выполняются в контексте отлаживаемой программы. Операторы Python также можно начинать с восклицательного знака (`!`). Это мощный способ исследовать отлаживаемую программу; можно даже изменить переменную или вызвать функцию. Если в таком операторе возникает исключение, выводится его имя, но состояние отладчика не меняется.192193Несколько команд можно ввести в одной строке, разделив их точкой с запятой `;;`. (Одиночная `;` не используется, так как она является разделителем для нескольких команд в строке, передаваемой парсеру Python.) Никакой интеллектуальный анализ при разделении команд не применяется; входная строка разбивается по первой `;;` паре, даже если она находится внутри строки в кавычках.194195Отладчик поддерживает псевдонимы. Псевдонимы могут иметь параметры, что обеспечивает определённый уровень адаптируемости к контексту исследования.196197Если файл `.pdbrc` существует в домашнем каталоге пользователя или в текущем каталоге, он читается и выполняется так, как если бы он был введён в приглашении отладчика. Это особенно полезно для псевдонимов. Если оба файла существуют, сначала читается файл из домашнего каталога, и определённые в нём псевдонимы могут быть переопределены локальным файлом.198199**h(elp) \[*command*\]**200201Без аргумента выводит список доступных команд. С аргументом202203*command*204205выводит справку об этой команде.206207`help pdb`208209выводит полный файл документации; если определена переменная окружения210211**PAGER**212213, вывод направляется через эту команду. Поскольку аргумент214215*command*216217должен быть идентификатором, для получения справки по команде218219`!`220221необходимо ввести222223`help exec`224225.226227**w(here)**228229Печатает трассировку стека, причём самый новый фрейм находится внизу. Стрелка указывает на текущий фрейм, который определяет контекст большинства команд.230231**d(own)**232233Перемещает текущий кадр на один уровень вниз по стеку вызовов (к более новому кадру).234235**u(p)**236237Перемещает текущий кадр на один уровень вверх по стеку вызовов (к более старому кадру).238239**b(reak) \[\[*имя\_файла*:\]*номер\_строки* | *функция*\[, *условие*\]\]**240241С аргументом *номер\_строки* устанавливает точку останова в этой строке текущего файла. С аргументом *функция* устанавливает точку останова на первом исполняемом операторе внутри этой функции. Номер строки может быть указан с префиксом из имени файла и двоеточия, чтобы задать точку останова в другом файле (возможно, ещё не загруженном). Файл ищется в `sys.path`. Обратите внимание, что каждой точке останова присваивается номер, на который ссылаются все остальные команды для точек останова.242243Если присутствует второй аргумент, это выражение, которое должно быть истинным, прежде чем точка останова сработает.244245Без аргументов выводит список всех точек останова, включая для каждой из них количество срабатываний, текущий счётчик игнорирования и связанное условие, если есть.246247**tbreak \[\[*имя\_файла*:\]*номер\_строки* | *функция*\[, *условие*\]\]**248249Временная точка останова, которая автоматически удаляется при первом срабатывании. Аргументы те же, что и для break.250251**cl(ear) \[*имя\_файла:номер\_строки* | *номер\_точки\_останова* \[*номер\_точки\_останова ...*\]\]**252253С аргументом254255*filename:lineno*256257удаляет все точки останова на этой строке. С разделённым пробелами списком номеров точек останова удаляет указанные точки останова. Без аргумента удаляет все точки останова (но сначала запрашивает подтверждение).258259**disable \[*номер\_точки\_останова* \[*номер\_точки\_останова ...*\]\]**260261Отключает точки останова, заданные в виде разделённого пробелами списка номеров. Отключение точки останова означает, что она не может остановить выполнение программы, но, в отличие от её удаления, она остаётся в списке точек останова и может быть (повторно) включена.262263**enable \[*номер\_точки\_останова* \[*номер\_точки\_останова ...*\]\]**264265Включает указанные точки останова.266267**ignore *номер\_точки\_останова* \[*счётчик*\]**268269Устанавливает счётчик игнорирования для указанного номера точки останова. Если счётчик опущен, счётчик игнорирования устанавливается в 0. Точка останова становится активной, когда счётчик игнорирования равен нулю. Если он не равен нулю, счётчик уменьшается на 1 каждый раз при достижении точки останова, при условии что она не отключена и любое связанное условие истинно.270271**condition *номер\_точки\_останова* \[*условие*\]**272273Условие – это выражение, которое должно быть истинным, прежде чем точка останова сработает. Если условие отсутствует, любое существующее условие удаляется; т.е. точка останова становится безусловной.274275**commands \[*номер\_точки\_останова*\]**276277Задаёт список команд для точки останова с номером *bpnumber*. Сами команды вводятся на следующих строках. Введите строку, содержащую только ‘end’, чтобы завершить список команд. Пример:278279```python280(Pdb) commands 1281(com) print some_variable282(com) end283(Pdb)284```285286Чтобы удалить все команды из точки останова, введите commands и сразу за ним end; то есть не вводите никаких команд.287288Без аргумента *bpnumber* команда commands относится к последней установленной точке останова.289290Можно использовать команды точки останова для перезапуска программы. Просто используйте команду continue, step или любую другую команду, возобновляющую выполнение.291292Указание любой команды, возобновляющей выполнение (в настоящее время continue, step, next, return, jump, quit и их сокращения), завершает список команд (как если бы после этой команды сразу следовал end). Это связано с тем, что при каждом возобновлении выполнения (даже с помощью простого next или step) можно встретить другую точку остановки, у которой может быть свой список команд, что приводит к неоднозначности относительно того, какой список выполнять.293294Если в списке команд используется команда ‘silent’, обычное сообщение об остановке на точке останова не выводится. Это может быть удобно для точек останова, которые должны выводить определённое сообщение и затем продолжать. Если никакие другие команды ничего не выводят, вы не увидите признака того, что точка останова была достигнута.295296**s(tep)**297298Выполняет текущую строку, останавливается при первой возможности (либо в вызываемой функции, либо на следующей строке в текущей функции).299300**n(ext)**301302Продолжает выполнение до достижения следующей строки в текущей функции или до её возврата. (Разница между303304`next`305306и307308`step`309310в том, что311312`step`313314останавливается внутри вызванной функции, тогда как315316`next`317318выполняет вызванные функции (почти) на полной скорости, останавливаясь только на следующей строке в текущей функции.)319320**unt(il)**321322Продолжает выполнение до строки с номером, большим текущего, или до возврата из текущего фрейма.323324**r(eturn)**325326Продолжает выполнение до возврата текущей функции.327328**c(ont(inue))**329330Продолжает выполнение, останавливаясь только при встрече точки останова.331332**j(ump) *номер\_строки***333334Устанавливает следующую строку, которая будет выполнена. Доступно только в самом нижнем фрейме. Это позволяет перепрыгнуть назад и выполнить код снова, или перепрыгнуть вперёд, пропуская код, который не требуется выполнять.335336Следует учесть, что разрешены не все прыжки – например, невозможно перепрыгнуть в середину цикла [`for`](https://python-all.ru/3.1/reference/compound_stmts.html#for) или за пределы блока [`finally`](https://python-all.ru/3.1/reference/compound_stmts.html#finally).337338**l(ist) \[*первая*\[, *последняя*\]\]**339340Выводит исходный код текущего файла. Без аргументов выводит 11 строк вокруг текущей строки или продолжает предыдущий вывод. С одним аргументом выводит 11 строк вокруг указанной строки. С двумя аргументами выводит заданный диапазон; если второй аргумент меньше первого, он интерпретируется как количество строк.341342**a(rgs)**343344Печатает список аргументов текущей функции.345346**p(rint) *выражение***347348Вычисляет349350*выражение*351352в текущем контексте и выводит его значение.353354**pp *выражение***355356Подобно команде357358`p`359360, но значение выражения красиво выводится с помощью модуля361362[`pprint`](https://python-all.ru/3.1/library/pprint.html#module-pprint)363364.365366**alias \[*имя* \[команда\]\]**367368Создаёт псевдоним с именем *name*, который выполняет *команду*. Команда *не* должна заключаться в кавычки. Заменяемые параметры можно обозначать с помощью `%1`, `%2` и так далее, а `%*` заменяется всеми параметрами. Если команда не указана, показывается текущий псевдоним для *name*. Если аргументы не указаны, выводятся все псевдонимы.369370Псевдонимы могут быть вложенными и могут содержать всё, что можно законно ввести в приглашении pdb. Обратите внимание, что внутренние команды pdb *могут* быть переопределены псевдонимами. Такая команда становится скрытой, пока псевдоним не будет удалён. Псевдонимизация рекурсивно применяется к первому слову командной строки; все остальные слова в строке остаются без изменений.371372В качестве примера, вот два полезных псевдонима (особенно если поместить их в файл `.pdbrc`):373374```python375#Вывести переменные экземпляра (использование "pi classInst")376alias pi for k in %1.__dict__.keys(): print("%1.",k,"=",%1.__dict__[k])377#Вывести переменные экземпляра в self378alias ps pi self379```380381**unalias *имя***382383Удаляет указанный псевдоним.384385**\[!\]*инструкция***386387Выполняет (однострочную) *инструкцию* в контексте текущего кадра стека. Восклицательный знак можно опустить, если первое слово инструкции не похоже на команду отладчика. Чтобы установить глобальную переменную, можно добавить перед командой присваивания команду `global` на той же строке, например:388389```python390(Pdb) global list_options; list_options = ['-l']391(Pdb)392```393394**run \[*аргументы* ...\]**395396Перезапускает отлаживаемую программу Python. Если указан аргумент, он разбивается с помощью “shlex”, и результат используется как новый sys.argv. История, точки останова, действия и параметры отладчика сохраняются. “restart” – псевдоним для “run”.397398**q(uit)**399400Выход из отладчика. Выполняемая программа прерывается.401402Сноски403404| [\[1\]](https://python-all.ru/3.1/library/pdb.html#id1) | Считается ли кадр происходящим из определённого модуля, определяется по `__name__` в глобальных переменных кадра. |405| --- | --- |406