Skip to content

Commit 6856a04

Browse files
Add documentation for remote debugging with pdb (#134260)
* Mention remote debugging via -p PID in usage text Adds a brief note to the pdb help summary about attaching to a running process using the -p option, making the remote debugging feature more visible. * Mention remote debugging in pdb.rst
1 parent 2f0570c commit 6856a04

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

Doc/library/pdb.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ The debugger's prompt is ``(Pdb)``, which is the indicator that you are in debug
8080
You can also invoke :mod:`pdb` from the command line to debug other scripts. For
8181
example::
8282

83-
python -m pdb [-c command] (-m module | pyfile) [args ...]
83+
python -m pdb [-c command] (-m module | -p pid | pyfile) [args ...]
8484

8585
When invoked as a module, pdb will automatically enter post-mortem debugging if
8686
the program being debugged exits abnormally. After post-mortem debugging (or
@@ -104,6 +104,24 @@ useful than quitting the debugger upon program's exit.
104104
.. versionchanged:: 3.7
105105
Added the ``-m`` option.
106106

107+
.. option:: -p, --pid <pid>
108+
109+
Attach to the process with the specified PID.
110+
111+
.. versionadded:: 3.14
112+
113+
114+
To attach to a running Python process for remote debugging, use the ``-p`` or
115+
``--pid`` option with the target process's PID::
116+
117+
python -m pdb -p 1234
118+
119+
.. note::
120+
121+
Attaching to a process that is blocked in a system call or waiting for I/O
122+
will only work once the next bytecode instruction is executed or when the
123+
process receives a signal.
124+
107125
Typical usage to execute a statement under control of the debugger is::
108126

109127
>>> import pdb

Lib/pdb.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3489,7 +3489,8 @@ def help():
34893489
_usage = """\
34903490
Debug the Python program given by pyfile. Alternatively,
34913491
an executable module or package to debug can be specified using
3492-
the -m switch.
3492+
the -m switch. You can also attach to a running Python process
3493+
using the -p option with its PID.
34933494
34943495
Initial commands are read from .pdbrc files in your home directory
34953496
and in the current directory, if they exist. Commands supplied with

0 commit comments

Comments
 (0)