pdb.md

1> **Источник:** https://python-all.ru/3.10/library/pdb.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`pdb`](https://python-all.ru/3.10/library/pdb.html#module-pdb) – Отладчик Python89**Исходный код:** [Lib/pdb.py](https://python-all.ru/src/3.10/Lib/pdb.py)1011---1213Модуль [`pdb`](https://python-all.ru/3.10/library/pdb.html#module-pdb) определяет интерактивный отладчик исходного кода для программ на Python. Он поддерживает установку (условных) точек останова и пошаговое исполнение на уровне строк исходного кода, просмотр стековых фреймов, отображение исходного кода и выполнение произвольного кода Python в контексте любого фрейма. Также поддерживается посмертная отладка, и его можно вызывать программно.1415Отладчик расширяем – на самом деле он определён как класс [`Pdb`](https://python-all.ru/3.10/library/pdb.html#pdb.Pdb). В настоящее время это не документировано, но легко понять из исходного кода. Интерфейс расширения использует модули [`bdb`](https://python-all.ru/3.10/library/bdb.html#module-bdb) и [`cmd`](https://python-all.ru/3.10/library/cmd.html#module-cmd).1617> **См. также**18>19> **Модуль [`faulthandler`](https://python-all.ru/3.10/library/faulthandler.html#module-faulthandler)**20>21> Используется для явного вывода трассировок Python при сбое, по тайм-ауту или по сигналу пользователя.22>23> **Модуль [`traceback`](https://python-all.ru/3.10/library/traceback.html#module-traceback)**24>25> Стандартный интерфейс для извлечения, форматирования и вывода трассировок стека программ на Python.2627Приглашение отладчика – `(Pdb)`. Обычное использование для запуска программы под управлением отладчика:2829```python30>>> import pdb31>>> import mymodule32>>> pdb.run('mymodule.test()')33> <string>(0)?()34(Pdb) continue35> <string>(1)?()36(Pdb) continue37NameError: 'spam'38> <string>(1)?()39(Pdb)40```4142Изменено в версии 3.3: Автодополнение по табуляции через модуль [`readline`](https://python-all.ru/3.10/library/readline.html#module-readline) доступно для команд и их аргументов; например, текущие глобальные и локальные имена предлагаются как аргументы команды `p`.4344`pdb.py` также можно вызвать как скрипт для отладки других скриптов. Например:4546```python47python -m pdb myscript.py48```4950При вызове в качестве скрипта pdb автоматически переходит в режим посмертной отладки, если отлаживаемая программа завершается аварийно. После посмертной отладки (или после нормального завершения программы) pdb перезапускает программу. Автоматический перезапуск сохраняет состояние pdb (например, точки останова) и в большинстве случаев полезнее, чем выход из отладчика при завершении программы.5152Новое в версии 3.2: `pdb.py` теперь принимает опцию `-c`, которая выполняет команды, как если бы они были заданы в файле `.pdbrc`; см. [Команды отладчика](https://python-all.ru/3.10/library/pdb.html#debugger-commands).5354Новое в версии 3.7: `pdb.py` теперь принимает опцию `-m`, которая выполняет модули подобно тому, как это делает `python -m`. Как и в случае со скриптом, отладчик приостановит выполнение прямо перед первой строкой модуля.5556Типичное использование для входа в отладчик – вставить:5758```python59import pdb; pdb.set_trace()60```6162в место, где нужно войти в отладчик, а затем запустить программу. После этого можно пошагово выполнять код, следующий за этой инструкцией, и продолжить выполнение без отладчика с помощью команды [`continue`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-continue).6364Новое в версии 3.7: Встроенную [`breakpoint()`](https://python-all.ru/3.10/library/functions.html#breakpoint) при вызове со значениями по умолчанию можно использовать вместо `import pdb; pdb.set_trace()`.6566Типичное использование для анализа аварийно завершившейся программы:6768```python69>>> import pdb70>>> import mymodule71>>> mymodule.test()72Traceback (most recent call last):73  File "<stdin>", line 1, in <module>74  File "./mymodule.py", line 4, in test75    test2()76  File "./mymodule.py", line 3, in test277    print(spam)78NameError: spam79>>> pdb.pm()80> ./mymodule.py(3)test2()81-> print(spam)82(Pdb)83```8485Модуль определяет следующие функции; каждая из них запускает отладчик немного по-своему:8687#### `pdb.run(statement, globals=None, locals=None)`8889Выполняет *инструкцию* (заданную как строку или объект кода) под управлением отладчика. Приглашение отладчика появляется до выполнения любого кода; можно установить точки останова и ввести [`continue`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-continue), или пошагово пройти инструкцию с помощью [`step`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-step) или [`next`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-next) (все эти команды описаны ниже). Необязательные аргументы *globals* и *locals* задают окружение, в котором выполняется код; по умолчанию используется словарь модуля [`__main__`](https://python-all.ru/3.10/library/__main__.html#module-__main__). (См. описание встроенных функций [`exec()`](https://python-all.ru/3.10/library/functions.html#exec) или [`eval()`](https://python-all.ru/3.10/library/functions.html#eval).)9091#### `pdb.runeval(expression, globals=None, locals=None)`9293Вычисляет *выражение* (заданное как строка или объект кода) под управлением отладчика. Когда [`runeval()`](https://python-all.ru/3.10/library/pdb.html#pdb.runeval) возвращает результат, он возвращает значение *выражения*. В остальном эта функция аналогична [`run()`](https://python-all.ru/3.10/library/pdb.html#pdb.run).9495#### `pdb.runcall(function, *args, **kwds)`9697Вызывает *функцию* (объект функции или метода, а не строку) с заданными аргументами. Когда [`runcall()`](https://python-all.ru/3.10/library/pdb.html#pdb.runcall) возвращает управление, возвращается результат вызова функции. Приглашение отладчика появляется сразу после входа в функцию.9899#### `pdb.set_trace(*, header=None)`100101Входит в отладчик на фрейме стека вызова. Это полезно для жёсткого задания точки останова в определённом месте программы, даже если код не отлаживается другим способом (например, при сбое утверждения). Если передан *header*, он выводится на консоль непосредственно перед началом отладки.102103Изменено в версии 3.7: Добавлен именованный аргумент *header*.104105#### `pdb.post_mortem(traceback=None)`106107Запускает посмертную отладку для указанного объекта *traceback*. Если объект *traceback* не указан, используется объект traceback текущего обрабатываемого исключения (исключение должно обрабатываться, чтобы значение по умолчанию сработало).108109#### `pdb.pm()`110111Запускает посмертную отладку для traceback, найденного в [`sys.last_traceback`](https://python-all.ru/3.10/library/sys.html#sys.last_traceback).112113Функции `run*` и [`set_trace()`](https://python-all.ru/3.10/library/pdb.html#pdb.set_trace) являются псевдонимами для создания экземпляра класса [`Pdb`](https://python-all.ru/3.10/library/pdb.html#pdb.Pdb) и вызова одноимённого метода. Если требуется доступ к дополнительным возможностям, это нужно сделать самостоятельно:114115#### `class pdb.Pdb(completekey='tab', stdin=None, stdout=None, skip=None, nosigint=False, readrc=True)`116117[`Pdb`](https://python-all.ru/3.10/library/pdb.html#pdb.Pdb) – это класс отладчика.118119Аргументы *completekey*, *stdin* и *stdout* передаются базовому классу [`cmd.Cmd`](https://python-all.ru/3.10/library/cmd.html#cmd.Cmd); см. описание там.120121Аргумент *skip*, если задан, должен быть итерабельным с шаблонами имён модулей в стиле glob. Отладчик не будет входить в фреймы, происходящие из модуля, который соответствует одному из этих шаблонов. [1](https://python-all.ru/3.10/library/pdb.html#id3)122123По умолчанию Pdb устанавливает обработчик сигнала SIGINT (который отправляется, когда пользователь нажимает `Ctrl-C` на консоли) при вводе команды [`continue`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-continue). Это позволяет снова войти в отладчик, нажав `Ctrl-C`. Если требуется, чтобы Pdb не изменял обработчик SIGINT, установите *nosigint* в значение true.124125Аргумент *readrc* по умолчанию равен true и определяет, будет ли Pdb загружать файлы .pdbrc из файловой системы.126127Пример вызова для включения трассировки с *skip*:128129```python130import pdb; pdb.Pdb(skip=['django.*']).set_trace()131```132133Возбуждает [событие аудита](https://python-all.ru/3.10/library/sys.html#auditing) `pdb.Pdb` без аргументов.134135Новое в версии 3.1: аргумент *skip*.136137Новое в версии 3.2: Аргумент *nosigint*. Ранее обработчик SIGINT никогда не устанавливался Pdb.138139Изменено в версии 3.6: Добавлен аргумент *readrc*.140141#### `run(statement, globals=None, locals=None)`142143#### `runeval(expression, globals=None, locals=None)`144145#### `runcall(function, *args, **kwds)`146147#### `set_trace()`148149См. документацию по функциям, описанным выше.150151## Команды отладчика152153Команды, распознаваемые отладчиком, перечислены ниже. Большинство команд можно сократить до одной или двух букв, как указано; например, `h(elp)` означает, что для ввода команды help можно использовать `h` или `help` (но не `he` или `hel`, а также не `H` или `Help` или `HELP`). Аргументы команд должны разделяться пробельными символами (пробелами или табуляцией). Необязательные аргументы заключаются в квадратные скобки (`[]`) в синтаксисе команды; сами скобки вводить не нужно. Альтернативы в синтаксисе команды разделяются вертикальной чертой (`|`).154155Ввод пустой строки повторяет последнюю введённую команду. Исключение: если последней командой была [`list`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-list), то будут выведены следующие 11 строк.156157Команды, которые отладчик не распознает, считаются операторами Python и выполняются в контексте отлаживаемой программы. Операторы Python также можно начинать с восклицательного знака (`!`). Это мощный способ исследовать отлаживаемую программу; можно даже изменить переменную или вызвать функцию. Если в таком операторе возникает исключение, выводится его имя, но состояние отладчика не меняется.158159Отладчик поддерживает [псевдонимы](https://python-all.ru/3.10/library/pdb.html#debugger-aliases). Псевдонимы могут иметь параметры, что обеспечивает некоторую гибкость в зависимости от контекста.160161Несколько команд можно вводить в одной строке, разделяя их `;;`. (Одиночный `;` не используется, поскольку именно он является разделителем для нескольких команд в строке, передаваемой синтаксическому анализатору Python.) При разделении команд не применяется никакой интеллектуальный анализ; ввод разбивается по первой паре `;;`, даже если она находится внутри строки в кавычках. Обходной путь для строк с двойными точками с запятой – использовать неявную конкатенацию строк `';'';'` или `";"";"`.162163Если файл `.pdbrc` существует в домашнем каталоге пользователя или в текущем каталоге, он читается и выполняется так, как если бы он был введён в приглашении отладчика. Это особенно полезно для псевдонимов. Если оба файла существуют, сначала читается файл из домашнего каталога, и псевдонимы, определённые в нём, могут быть переопределены локальным файлом.164165Изменено в версии 3.2: `.pdbrc` теперь может содержать команды, продолжающие отладку, например [`continue`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-continue) или [`next`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-next). Ранее эти команды не действовали.166167#### `h(elp) [command]`168169Без аргументов выводит список доступных команд. С аргументом *команда* выводит справку по этой команде. `help pdb` отображает полную документацию (docstring модуля [`pdb`](https://python-all.ru/3.10/library/pdb.html#module-pdb)). Поскольку аргумент *команда* должен быть идентификатором, для получения справки по команде `!` необходимо ввести `help exec`.170171#### `w(here)`172173Печатает трассировку стека, причём самый новый фрейм находится внизу. Стрелка указывает на текущий фрейм, который определяет контекст большинства команд.174175#### `d(own) [count]`176177Переместить текущий кадр на *count* (по умолчанию один) уровней вниз по трассировке стека (к более новому кадру).178179#### `u(p) [count]`180181Переместить текущий кадр на *count* (по умолчанию один) уровней вверх по трассировке стека (к более старому кадру).182183#### `b(reak) [([filename:]lineno | function) [, condition]]`184185С аргументом *lineno* устанавливает точку остановки в текущем файле на указанной строке. С аргументом *function* устанавливает точку остановки на первом исполняемом операторе внутри этой функции. Номер строки может быть предварён именем файла и двоеточием, чтобы указать точку остановки в другом файле (возможно, ещё не загруженном). Файл ищется в [`sys.path`](https://python-all.ru/3.10/library/sys.html#sys.path). Обратите внимание: каждой точке остановки присваивается номер, на который ссылаются все остальные команды управления точками остановки.186187Если присутствует второй аргумент, это выражение, которое должно вычисляться в true (истина), чтобы точка останова сработала.188189Без аргумента выводит список всех точек останова, включая для каждой точки останова количество срабатываний, текущий счётчик игнорирования и связанное условие, если оно есть.190191#### `tbreak [([filename:]lineno | function) [, condition]]`192193Временная точка останова, которая удаляется автоматически при первом срабатывании. Аргументы такие же, как для [`break`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-break).194195#### `cl(ear) [filename:lineno | bpnumber ...]`196197С аргументом *filename:lineno* удаляет все точки останова на этой строке. С разделённым пробелами списком номеров точек останова удаляет указанные точки останова. Без аргумента удаляет все точки останова (но сначала запрашивает подтверждение).198199#### `disable [bpnumber ...]`200201Отключает точки останова, заданные разделённым пробелами списком номеров точек останова. Отключение точки останова означает, что она не может приостановить выполнение программы, но в отличие от удаления точки останова, она остаётся в списке точек останова и может быть (повторно) включена.202203#### `enable [bpnumber ...]`204205Включает указанные точки останова.206207#### `ignore bpnumber [count]`208209Устанавливает счётчик игнорирования для заданного номера точки останова. Если *count* опущен, счётчик игнорирования устанавливается в 0. Точка останова становится активной, когда счётчик игнорирования равен нулю. Если он не равен нулю, *count* уменьшается каждый раз, когда точка останова достигается, и точка останова не отключена, и любое связанное условие принимает значение true.210211#### `condition bpnumber [condition]`212213Устанавливает новое *condition* для точки останова – выражение, которое должно вычисляться в true, чтобы точка останова сработала. Если *condition* отсутствует, любое существующее условие удаляется; т.е. точка останова становится безусловной.214215#### `commands [bpnumber]`216217Задаёт список команд для точки останова с номером *bpnumber*. Сами команды вводятся на следующих строках. Введите строку, содержащую только `end`, чтобы завершить список команд. Пример:218219```python220(Pdb) commands 1221(com) p some_variable222(com) end223(Pdb)224```225226Чтобы удалить все команды из точки останова, введите `commands` и сразу за ним `end`; то есть не давайте никаких команд.227228Без аргумента *bpnumber* команда `commands` относится к последней установленной точке останова.229230Можно использовать команды точки останова для перезапуска программы. Просто используйте команду [`continue`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-continue), или [`step`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-step), или любую другую команду, которая возобновляет выполнение.231232Указание любой команды, возобновляющей выполнение ([`continue`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-continue), [`step`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-step), [`next`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-next), [`return`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-return), [`jump`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-jump), [`quit`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-quit) и их сокращения), завершает список команд (как если бы за этой командой сразу следовало end). Это происходит потому, что при каждом возобновлении выполнения (даже с помощью простого next или step) может быть встречена другая точка останова, у которой может быть свой список команд, что приводит к неоднозначности: какой список выполнять.233234Если в списке команд используется команда `silent`, обычное сообщение об остановке на точке останова не выводится. Это может быть полезно для точек останова, которые должны вывести определённое сообщение и затем продолжить выполнение. Если ни одна из других команд ничего не выводит, вы не увидите никаких признаков того, что точка останова была достигнута.235236#### `s(tep)`237238Выполняет текущую строку, останавливается при первой возможности (либо в вызываемой функции, либо на следующей строке в текущей функции).239240#### `n(ext)`241242Продолжает выполнение до следующей строки в текущей функции или до её возврата. (Разница между [`next`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-next) и [`step`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-step) в том, что [`step`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-step) останавливается внутри вызванной функции, тогда как [`next`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-next) выполняет вызванные функции (почти) на полной скорости, останавливаясь только на следующей строке в текущей функции.)243244#### `unt(il) [lineno]`245246Без аргумента продолжает выполнение до строки с номером, большим текущего.247248С *lineno* продолжает выполнение до строки с номером, большим или равным *lineno*. В обоих случаях также останавливается при возврате текущего фрейма.249250Изменено в версии 3.2: Добавлена возможность явно указывать номер строки.251252#### `r(eturn)`253254Продолжает выполнение до возврата текущей функции.255256#### `c(ont(inue))`257258Продолжает выполнение, останавливаясь только при встрече точки останова.259260#### `j(ump) lineno`261262Устанавливает следующую строку для выполнения. Доступно только в самом нижнем фрейме. Это позволяет вернуться назад и выполнить код снова, или перейти вперёд, пропустив ненужный код.263264Следует отметить, что не все переходы разрешены – например, нельзя перейти внутрь цикла [`for`](https://python-all.ru/3.10/reference/compound_stmts.html#for) или выйти из конструкции [`finally`](https://python-all.ru/3.10/reference/compound_stmts.html#finally).265266#### `l(ist) [first[, last]]`267268Выводит исходный код текущего файла. Без аргументов выводит 11 строк вокруг текущей строки или продолжает предыдущий вывод. С `.` в качестве аргумента выводит 11 строк вокруг текущей строки. С одним аргументом выводит 11 строк вокруг указанной строки. С двумя аргументами выводит заданный диапазон; если второй аргумент меньше первого, он интерпретируется как количество.269270Текущая строка в текущем фрейме помечается `->`. Если отлаживается исключение, строка, где оно было первоначально вызвано или распространено, помечается `>>`, если она отличается от текущей.271272Новое в версии 3.2: Маркер `>>`.273274#### `ll | longlist`275276Выводит весь исходный код текущей функции или фрейма. Интересные строки помечаются так же, как для [`list`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-list).277278Новое в версии 3.2.279280#### `a(rgs)`281282Печатает список аргументов текущей функции.283284#### `p expression`285286Вычисляет *expression* в текущем контексте и выводит его значение.287288> **Примечание**289>290> `print()` также можно использовать, но это не команда отладчика – выполняется функция Python [`print()`](https://python-all.ru/3.10/library/functions.html#print).291292#### `pp expression`293294Как команда [`p`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-p), но значение *expression* красиво выводится с помощью модуля [`pprint`](https://python-all.ru/3.10/library/pprint.html#module-pprint).295296#### `whatis expression`297298Выводит тип *expression*.299300#### `source expression`301302Пытается получить исходный код *expression* и отобразить его.303304Новое в версии 3.2.305306#### `display [expression]`307308Отображает значение *expression*, если оно изменилось, каждый раз при остановке выполнения в текущем фрейме.309310Без *expression* выводит все выражения для отображения в текущем фрейме.311312Новое в версии 3.2.313314#### `undisplay [expression]`315316Больше не показывать *выражение* в текущем фрейме. Без *выражения* очистить все display-выражения для текущего фрейма.317318Новое в версии 3.2.319320#### `interact`321322Запускает интерактивный интерпретатор (с использованием модуля [`code`](https://python-all.ru/3.10/library/code.html#module-code)), чьё глобальное пространство имён содержит все (глобальные и локальные) имена, найденные в текущей области видимости.323324Новое в версии 3.2.325326#### `alias [name [command]]`327328Создаёт псевдоним с именем *имя*, который выполняет *команду*. Команда *команда* *не* должна быть заключена в кавычки. Заменяемые параметры могут быть обозначены как `%1`, `%2` и так далее, а `%*` заменяется всеми параметрами. Если *команда* опущена, показывается текущий псевдоним для *имени*. Если аргументы не указаны, выводятся все псевдонимы.329330Псевдонимы могут быть вложенными и могут содержать всё, что можно ввести в приглашении pdb. Обратите внимание, что внутренние команды pdb *могут* быть переопределены псевдонимами. Такая команда затем скрывается, пока псевдоним не удалён. Псевдонимы рекурсивно применяются к первому слову командной строки; все остальные слова в строке остаются нетронутыми.331332В качестве примера – два полезных псевдонима (особенно если они помещены в файл `.pdbrc`):333334```python335# Вывести переменные экземпляра (использование "pi classInst")336alias pi for k in %1.__dict__.keys(): print(f"%1.{k} = {%1.__dict__[k]}")337# Вывести переменные экземпляра в self338alias ps pi self339```340341#### `unalias name`342343Удаляет указанный псевдоним *имя*.344345#### `! statement`346347Выполняет (однострочную) *инструкцию* в контексте текущего кадра стека. Восклицательный знак можно опустить, если первое слово инструкции не напоминает команду отладчика. Чтобы установить глобальную переменную, можно указать [`global`](https://python-all.ru/3.10/reference/simple_stmts.html#global) перед инструкцией присваивания в той же строке, например:348349```python350(Pdb) global list_options; list_options = ['-l']351(Pdb)352```353354#### `run [args ...]`355356#### `restart [args ...]`357358Перезапускает отлаживаемую программу Python. Если указаны *аргументы*, они разделяются с помощью [`shlex`](https://python-all.ru/3.10/library/shlex.html#module-shlex) и результат используется как новое [`sys.argv`](https://python-all.ru/3.10/library/sys.html#sys.argv). История, точки останова, действия и опции отладчика сохраняются. [`restart`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-restart) является псевдонимом для [`run`](https://python-all.ru/3.10/library/pdb.html#pdbcommand-run).359360#### `q(uit)`361362Выход из отладчика. Выполнение программы прерывается.363364#### `debug code`365366Входит в рекурсивный отладчик, который пошагово выполняет *код* (произвольное выражение или инструкцию для выполнения в текущем окружении).367368#### `retval`369370Печатает возвращаемое значение последнего возврата из функции.371372Сноски373374**[1](https://python-all.ru/3.10/library/pdb.html#id1)**375376Принадлежность фрейма к определённому модулю определяется значением `__name__` в глобальных переменных фрейма.377