pdb.md

1> **Источник:** https://python-all.ru/3.4/library/pdb.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 27.3. [`pdb`](https://python-all.ru/3.4/library/pdb.html#module-pdb) – Отладчик Python89**Исходный код:** [Lib/pdb.py](https://python-all.ru/src/3.4/Lib/pdb.py)1011---1213Модуль [`pdb`](https://python-all.ru/3.4/library/pdb.html#module-pdb) определяет интерактивный отладчик исходного кода для программ на Python. Он поддерживает установку (условных) точек останова и пошаговое выполнение на уровне строк исходного кода, просмотр стековых фреймов, вывод исходного кода и выполнение произвольного кода Python в контексте любого стекового фрейма. Также поддерживается посмертная отладка и возможность вызова под управлением программы.1415Отладчик расширяем – он фактически определён как класс [`Pdb`](https://python-all.ru/3.4/library/pdb.html#pdb.Pdb). В настоящее время это не документировано, но легко понять, прочитав исходный код. Интерфейс расширения использует модули [`bdb`](https://python-all.ru/3.4/library/bdb.html#module-bdb) и [`cmd`](https://python-all.ru/3.4/library/cmd.html#module-cmd).1617Приглашение отладчика – `(Pdb)`. Обычно для запуска программы под управлением отладчика используется:1819```python20>>> import pdb21>>> import mymodule22>>> pdb.run('mymodule.test()')23> <string>(0)?()24(Pdb) continue25> <string>(1)?()26(Pdb) continue27NameError: 'spam'28> <string>(1)?()29(Pdb)30```3132Изменено в версии 3.3: Автодополнение по табуляции через модуль [`readline`](https://python-all.ru/3.4/library/readline.html#module-readline) доступно для команд и аргументов команд, например, текущие глобальные и локальные имена предлагаются в качестве аргументов команды `p`.3334`pdb.py` также можно вызвать как скрипт для отладки других скриптов. Например:3536```python37python3 -m pdb myscript.py38```3940При вызове в качестве скрипта pdb автоматически переходит в режим посмертной отладки, если отлаживаемая программа завершается аварийно. После посмертной отладки (или после нормального завершения программы) pdb перезапускает программу. Автоматический перезапуск сохраняет состояние pdb (например, точки останова) и в большинстве случаев полезнее, чем выход из отладчика при завершении программы.4142Новое в версии 3.2: `pdb.py` теперь принимает опцию `-c`, которая выполняет команды так, как если бы они были заданы в файле `.pdbrc`; см. [*Команды отладчика*](https://python-all.ru/3.4/library/pdb.html#debugger-commands).4344Обычный способ войти в отладчик из работающей программы – вставить4546```python47import pdb; pdb.set_trace()48```4950в том месте, где нужно войти в отладчик. После этого можно пошагово выполнять код, следующий за этим оператором, и продолжить выполнение без отладчика с помощью команды [`continue`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-continue).5152Типичное использование для анализа аварийно завершившейся программы:5354```python55>>> import pdb56>>> import mymodule57>>> mymodule.test()58Traceback (most recent call last):59  File "<stdin>", line 1, in ?60  File "./mymodule.py", line 4, in test61    test2()62  File "./mymodule.py", line 3, in test263    print(spam)64NameError: spam65>>> pdb.pm()66> ./mymodule.py(3)test2()67-> print(spam)68(Pdb)69```7071Модуль определяет следующие функции; каждая из них запускает отладчик немного по-своему:7273#### `pdb.run(statement, globals=None, locals=None)`7475Выполняет *statement* (заданный как строка или объект кода) под управлением отладчика. Приглашение отладчика появляется перед выполнением любого кода; можно установить точки останова и ввести [`continue`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-continue), или пошагово выполнить оператор с помощью [`step`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-step) или [`next`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-next) (все эти команды описаны ниже). Необязательные аргументы *globals* и *locals* задают окружение, в котором выполняется код; по умолчанию используется словарь модуля [`__main__`](https://python-all.ru/3.4/library/__main__.html#module-__main__). (См. описание встроенных функций [`exec()`](https://python-all.ru/3.4/library/functions.html#exec) или [`eval()`](https://python-all.ru/3.4/library/functions.html#eval).)7677#### `pdb.runeval(expression, globals=None, locals=None)`7879Вычисляет *expression* (заданное как строка или объект кода) под управлением отладчика. Когда [`runeval()`](https://python-all.ru/3.4/library/pdb.html#pdb.runeval) возвращает результат, она возвращает значение выражения. В остальном эта функция аналогична [`run()`](https://python-all.ru/3.4/library/pdb.html#pdb.run).8081#### `pdb.runcall(function, *args, **kwds)`8283Вызывает *function* (объект функции или метода, не строка) с заданными аргументами. Когда [`runcall()`](https://python-all.ru/3.4/library/pdb.html#pdb.runcall) возвращает результат, она возвращает то, что вернул вызов функции. Приглашение отладчика появляется сразу после входа в функцию.8485#### `pdb.set_trace()`8687Выполняет вход в отладчик на стековом фрейме вызвавшей функции. Это полезно для установки точки останова в заданном месте программы, даже если в остальном код не отлаживается (например, при ошибке утверждения).8889#### `pdb.post_mortem(traceback=None)`9091Запускает посмертную отладку для указанного объекта *traceback*. Если объект *traceback* не указан, используется объект traceback текущего обрабатываемого исключения (исключение должно обрабатываться, чтобы значение по умолчанию сработало).9293#### `pdb.pm()`9495Входит в режим посмертной отладки по трассировке, находящейся в [`sys.last_traceback`](https://python-all.ru/3.4/library/sys.html#sys.last_traceback).9697Функции `run*` и [`set_trace()`](https://python-all.ru/3.4/library/pdb.html#pdb.set_trace) являются псевдонимами для создания экземпляра класса [`Pdb`](https://python-all.ru/3.4/library/pdb.html#pdb.Pdb) и вызова метода с тем же именем. Если нужно получить доступ к дополнительным возможностям, придётся сделать это самостоятельно:9899#### `class pdb.Pdb(completekey='tab', stdin=None, stdout=None, skip=None, nosigint=False)`100101[`Pdb`](https://python-all.ru/3.4/library/pdb.html#pdb.Pdb) – это класс отладчика.102103Аргументы *completekey*, *stdin* и *stdout* передаются базовому классу [`cmd.Cmd`](https://python-all.ru/3.4/library/cmd.html#cmd.Cmd); см. описание там.104105Аргумент *skip*, если задан, должен быть итерабельным с шаблонами имён модулей в стиле glob. Отладчик не будет входить в фреймы, происходящие из модуля, который соответствует одному из этих шаблонов. [\[1\]](https://python-all.ru/3.4/library/pdb.html#id3)106107По умолчанию Pdb устанавливает обработчик сигнала SIGINT (который посылается, когда пользователь нажимает `Ctrl-C` на консоли) при вводе команды `continue`. Это позволяет снова войти в отладчик, нажав `Ctrl-C`. Если нужно, чтобы Pdb не трогал обработчик SIGINT, установите *nosigint* в true.108109Пример вызова для включения трассировки с *skip*:110111```python112import pdb; pdb.Pdb(skip=['django.*']).set_trace()113```114115Новое в версии 3.1: аргумент *skip*.116117Новое в версии 3.2: Аргумент *nosigint*. Ранее обработчик SIGINT никогда не устанавливался Pdb.118119#### `run(statement, globals=None, locals=None)`120121#### `runeval(expression, globals=None, locals=None)`122123#### `runcall(function, *args, **kwds)`124125#### `set_trace()`126127См. документацию по функциям, описанным выше.128129## 27.3.1. Команды отладчика130131Команды, распознаваемые отладчиком, перечислены ниже. Большинство команд можно сократить до одной или двух букв, как указано; например, `h(elp)` означает, что для ввода команды help можно использовать как `h`, так и `help` (но не `he` или `hel`, а также не `H`, `Help` или `HELP`). Аргументы команд должны разделяться пробельными символами (пробелами или табуляциями). Необязательные аргументы заключаются в квадратные скобки (`[]`) в синтаксисе команды; сами квадратные скобки вводить не нужно. Альтернативы в синтаксисе команды разделяются вертикальной чертой (`|`).132133Ввод пустой строки повторяет последнюю введённую команду. Исключение: если последней командой была [`list`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-list), то выводятся следующие 11 строк.134135Команды, которые отладчик не распознает, считаются операторами Python и выполняются в контексте отлаживаемой программы. Операторы Python также можно начинать с восклицательного знака (`!`). Это мощный способ исследовать отлаживаемую программу; можно даже изменить переменную или вызвать функцию. Если в таком операторе возникает исключение, выводится его имя, но состояние отладчика не меняется.136137Отладчик поддерживает [*псевдонимы*](https://python-all.ru/3.4/library/pdb.html#debugger-aliases). Псевдонимы могут иметь параметры, что обеспечивает некоторую гибкость в зависимости от контекста.138139Несколько команд можно ввести в одной строке, разделив их `;;`. (Одиночный `;` не используется, так как он является разделителем для нескольких команд в строке, передаваемой парсеру Python.) При разделении команд не применяется никакая интеллектуальная обработка; входная строка разбивается по первой паре `;;`, даже если она находится внутри строки в кавычках.140141Если файл `.pdbrc` существует в домашнем каталоге пользователя или в текущем каталоге, он считывается и выполняется так, как если бы он был введён в приглашении отладчика. Это особенно полезно для псевдонимов. Если существуют оба файла, сначала считывается файл из домашнего каталога, и определённые в нём псевдонимы могут быть переопределены локальным файлом.142143Изменено в версии 3.2: `.pdbrc` теперь может содержать команды, которые продолжают отладку, такие как [`continue`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-continue) или [`next`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-next). Ранее эти команды не действовали.144145**`h(elp)``[command]`**146147Без аргументов выводит список доступных команд. С аргументом *command* выводит справку об этой команде. `help pdb` выводит полную документацию (строку документации модуля [`pdb`](https://python-all.ru/3.4/library/pdb.html#module-pdb)). Поскольку аргумент *command* должен быть идентификатором, для получения справки по команде `!` необходимо ввести `help exec`.148149**`w(here)`**150151Печатает трассировку стека, причём самый новый фрейм находится внизу. Стрелка указывает на текущий фрейм, который определяет контекст большинства команд.152153**`d(own)``[count]`**154155Переместить текущий кадр на *count* (по умолчанию один) уровней вниз по трассировке стека (к более новому кадру).156157**`u(p)``[count]`**158159Переместить текущий кадр на *count* (по умолчанию один) уровней вверх по трассировке стека (к более старому кадру).160161**`b(reak)``[([filename:]lineno | function) [, condition]]`**162163С аргументом *lineno* устанавливает точку остановки на этой строке в текущем файле. С аргументом *function* устанавливает точку остановки на первом выполняемом операторе в этой функции. Номер строки может быть указан с префиксом имени файла и двоеточием, чтобы задать точку остановки в другом файле (возможно, ещё не загруженном). Файл ищется в [`sys.path`](https://python-all.ru/3.4/library/sys.html#sys.path). Обратите внимание, что каждой точке остановки присваивается номер, на который ссылаются все остальные команды для точек остановки.164165Если присутствует второй аргумент, это выражение, которое должно вычисляться в true (истина), чтобы точка останова сработала.166167Без аргумента выводит список всех точек останова, включая для каждой точки останова количество срабатываний, текущий счётчик игнорирования и связанное условие, если оно есть.168169**`tbreak``[([filename:]lineno | function) [, condition]]`**170171Временная точка остановки, которая удаляется автоматически при первом срабатывании. Аргументы те же, что и для [`break`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-break).172173**`cl(ear)``[filename:lineno | bpnumber [bpnumber ...]]`**174175С аргументом *filename:lineno* удаляет все точки останова на этой строке. С разделённым пробелами списком номеров точек останова удаляет указанные точки останова. Без аргумента удаляет все точки останова (но сначала запрашивает подтверждение).176177**`disable``[bpnumber [bpnumber ...]]`**178179Отключает точки останова, заданные разделённым пробелами списком номеров точек останова. Отключение точки останова означает, что она не может приостановить выполнение программы, но в отличие от удаления точки останова, она остаётся в списке точек останова и может быть (повторно) включена.180181**`enable``[bpnumber [bpnumber ...]]`**182183Включает указанные точки останова.184185**`ignore``bpnumber [count]`**186187Устанавливает счётчик игнорирования для заданного номера точки останова. Если счётчик не указан, счётчик игнорирования устанавливается в 0. Точка останова становится активной, когда счётчик игнорирования равен нулю. Если он не равен нулю, счётчик уменьшается каждый раз, когда точка останова достигается, и она не отключена, и любое связанное с ней условие истинно.188189**`condition``bpnumber [condition]`**190191Устанавливает новое *condition* для точки останова – выражение, которое должно вычисляться в true, чтобы точка останова сработала. Если *condition* отсутствует, любое существующее условие удаляется; т.е. точка останова становится безусловной.192193**`commands``[bpnumber]`**194195Задаёт список команд для точки остановки с номером *bpnumber*. Сами команды указываются на следующих строках. Введите строку, содержащую только `end`, чтобы завершить список команд. Пример:196197```python198(Pdb) commands 1199(com) p some_variable200(com) end201(Pdb)202```203204Чтобы удалить все команды из точки остановки, введите commands и сразу за ним `end`; то есть не указывайте никаких команд.205206Без аргумента *bpnumber* команда commands относится к последней установленной точке останова.207208Можно использовать команды точки останова, чтобы снова запустить программу. Просто используйте команду continue, или step, или любую другую команду, возобновляющую выполнение.209210Указание любой команды, возобновляющей выполнение (в настоящее время continue, step, next, return, jump, quit и их сокращения), завершает список команд (как если бы после этой команды сразу следовал end). Это связано с тем, что при каждом возобновлении выполнения (даже с помощью простого next или step) можно встретить другую точку остановки, у которой может быть свой список команд, что приводит к неоднозначности относительно того, какой список выполнять.211212Если в списке команд используется команда ‘silent’, обычное сообщение об остановке на точке останова не выводится. Это может быть удобно для точек останова, которые должны выводить определённое сообщение и затем продолжать. Если никакие другие команды ничего не выводят, вы не увидите признака того, что точка останова была достигнута.213214**`s(tep)`**215216Выполняет текущую строку, останавливается при первой возможности (либо в вызываемой функции, либо на следующей строке в текущей функции).217218**`n(ext)`**219220Продолжает выполнение до тех пор, пока не будет достигнута следующая строка в текущей функции или пока функция не вернётся. (Разница между [`next`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-next) и [`step`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-step) в том, что [`step`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-step) останавливается внутри вызванной функции, а [`next`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-next) выполняет вызванные функции (почти) на полной скорости, останавливаясь только на следующей строке в текущей функции.)221222**`unt(il)``[lineno]`**223224Без аргумента продолжает выполнение до строки с номером, большим текущего.225226С номером строки продолжает выполнение до достижения строки с номером, большим или равным указанному. В обоих случаях также останавливается при возврате из текущего фрейма.227228Изменено в версии 3.2: Добавлена возможность явно указывать номер строки.229230**`r(eturn)`**231232Продолжает выполнение до возврата текущей функции.233234**`c(ont(inue))`**235236Продолжает выполнение, останавливаясь только при встрече точки останова.237238**`j(ump)``lineno`**239240Устанавливает следующую строку для выполнения. Доступно только в самом нижнем фрейме. Это позволяет вернуться назад и выполнить код снова, или перейти вперёд, пропустив ненужный код.241242Следует отметить, что не все переходы разрешены – например, нельзя перейти в середину цикла [`for`](https://python-all.ru/3.4/reference/compound_stmts.html#for) или выйти из блока [`finally`](https://python-all.ru/3.4/reference/compound_stmts.html#finally).243244**`l(ist)``[first[, last]]`**245246Выводит исходный код текущего файла. Без аргументов выводит 11 строк вокруг текущей строки или продолжает предыдущий вывод. С `.` в качестве аргумента выводит 11 строк вокруг текущей строки. С одним аргументом выводит 11 строк вокруг указанной строки. С двумя аргументами выводит заданный диапазон; если второй аргумент меньше первого, он интерпретируется как количество.247248Текущая строка в текущем фрейме помечается `->`. Если отлаживается исключение, строка, где оно было первоначально вызвано или распространено, помечается `>>`, если она отличается от текущей.249250Новое в версии 3.2: Маркер `>>`.251252**`ll``| longlist`**253254Выводит весь исходный код текущей функции или фрейма. Интересные строки помечаются так же, как для [`list`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-list).255256Новое в версии 3.2.257258**`a(rgs)`**259260Печатает список аргументов текущей функции.261262**`p``expression`**263264Вычисляет *выражение* в текущем контексте и выводит его значение.265266> **Примечание**267>268> `print()` также можно использовать, но это не команда отладчика – она выполняет функцию Python [`print()`](https://python-all.ru/3.4/library/functions.html#print).269270**`pp``expression`**271272Как команда [`p`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-p), но значение выражения красиво выводится с помощью модуля [`pprint`](https://python-all.ru/3.4/library/pprint.html#module-pprint).273274**`whatis``expression`**275276Выводит тип *выражения*.277278**`source``expression`**279280Пытается получить исходный код для указанного объекта и отобразить его.281282Новое в версии 3.2.283284**`display``[expression]`**285286Отображает значение выражения, если оно изменилось, каждый раз при остановке выполнения в текущем фрейме.287288Без выражения выводит список всех отображаемых выражений для текущего фрейма.289290Новое в версии 3.2.291292**`undisplay``[expression]`**293294Больше не отображает выражение в текущем фрейме. Без выражения очищает все отображаемые выражения для текущего фрейма.295296Новое в версии 3.2.297298**`interact`**299300Запускает интерактивный интерпретатор (с помощью модуля [`code`](https://python-all.ru/3.4/library/code.html#module-code)), глобальное пространство имён которого содержит все (глобальные и локальные) имена, найденные в текущей области видимости.301302Новое в версии 3.2.303304**`alias``[name [command]]`**305306Создаёт псевдоним с именем *name*, который выполняет *команду*. Команда *не* должна заключаться в кавычки. Заменяемые параметры могут обозначаться как `%1`, `%2` и так далее, а `%*` заменяется всеми параметрами. Если команда не указана, показывается текущий псевдоним для *name*. Если аргументы не указаны, выводятся все псевдонимы.307308Псевдонимы могут быть вложенными и могут содержать всё, что можно ввести в приглашении pdb. Обратите внимание, что внутренние команды pdb *могут* быть переопределены псевдонимами. Такая команда затем скрывается, пока псевдоним не удалён. Псевдонимы рекурсивно применяются к первому слову командной строки; все остальные слова в строке остаются нетронутыми.309310В качестве примера, вот два полезных псевдонима (особенно если поместить их в файл `.pdbrc`):311312```python313# Вывести переменные экземпляра (использование "pi classInst")314alias pi for k in %1.__dict__.keys(): print("%1.",k,"=",%1.__dict__[k])315# Вывести переменные экземпляра в self316alias ps pi self317```318319**`unalias``name`**320321Удаляет указанный псевдоним.322323**`!``statement`**324325Выполняет (однострочную) *инструкцию* в контексте текущего кадра стека. Восклицательный знак можно опустить, если первое слово инструкции не похоже на команду отладчика. Чтобы задать глобальную переменную, можно добавить оператор [`global`](https://python-all.ru/3.4/reference/simple_stmts.html#global) перед командой присваивания в той же строке, например:326327```python328(Pdb) global list_options; list_options = ['-l']329(Pdb)330```331332**`run``[args ...]`**333334**`restart``[args ...]`**335336Перезапускает отлаживаемую программу Python. Если указан аргумент, он разбивается с помощью [`shlex`](https://python-all.ru/3.4/library/shlex.html#module-shlex), и результат используется как новый [`sys.argv`](https://python-all.ru/3.4/library/sys.html#sys.argv). История, точки останова, действия и параметры отладчика сохраняются. [`restart`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-restart) является псевдонимом для [`run`](https://python-all.ru/3.4/library/pdb.html#pdbcommand-run).337338**`q(uit)`**339340Выход из отладчика. Выполнение программы прерывается.341342Сноски343344| [\[1\]](https://python-all.ru/3.4/library/pdb.html#id1) | Считается ли кадр происходящим из определённого модуля, определяется по `__name__` в глобальных переменных кадра. |345| --- | --- |346