Commitb0bf48a

authored

[3.14] Add documentation for remote debugging with pdb (GH-134260) (#134398)

1 parent64047f7 commitb0bf48aCopy full SHA for b0bf48a

File tree

+21

-2

lines changed

+21

-2

lines changed

Lines changed: 19 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -80,7 +80,7 @@ The debugger's prompt is ``(Pdb)``, which is the indicator that you are in debug
`80`	`80`	You can also invoke:mod:`pdb` from the command line to debug other scripts. For
`81`	`81`	`example::`
`82`	`82`
`83`		`- python -m pdb [-c command] (-m module \| pyfile) [args ...]`
	`83`	`+ python -m pdb [-c command] (-m module \|-p pid \|pyfile) [args ...]`
`84`	`84`
`85`	`85`	`When invoked as a module, pdb will automatically enter post-mortem debugging if`
`86`	`86`	`the program being debugged exits abnormally. After post-mortem debugging (or`
`@@ -104,6 +104,24 @@ useful than quitting the debugger upon program's exit.`
`104`	`104`	`..versionchanged::3.7`
`105`	`105`	Added the ``-m`` option.
`106`	`106`
	`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`	`+`
`107`	`125`	`Typical usage to execute a statement under control of the debugger is::`
`108`	`126`
`109`	`127`	`>>> import pdb`

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -3490,7 +3490,8 @@ def help():`
`3490`	`3490`	`_usage="""\`
`3491`	`3491`	`Debug the Python program given by pyfile. Alternatively,`
`3492`	`3492`	`an executable module or package to debug can be specified using`
`3493`		`-the -m switch.`
	`3493`	`+the -m switch. You can also attach to a running Python process`
	`3494`	`+using the -p option with its PID.`
`3494`	`3495`
`3495`	`3496`	`Initial commands are read from .pdbrc files in your home directory`
`3496`	`3497`	`and in the current directory, if they exist. Commands supplied with`

Comments

(0)