mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-03 05:35:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Update pdb docs for arguments (GH-102965)

Browse source 
(cherry picked from commit 027223db96)

Co-authored-by: gaogaotiantian <gaogaotiantian@hotmail.com>
This commit is contained in:
Miss Islington (bot) 2023-03-25 14:42:28 -07:00 • committed by GitHub
parent aae91fa63c
commit e1094c6e6a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

42
Doc/library/pdb.rst
View file

@ -125,7 +125,7 @@ slightly different way:
Evaluate the *expression* (given as a string or a code object) under debugger Evaluate the *expression* (given as a string or a code object) under debugger
control. When :func:`runeval` returns, it returns the value of the control. When :func:`runeval` returns, it returns the value of the
expression. Otherwise this function is similar to :func:`run`. *expression*. Otherwise this function is similar to :func:`run`.
.. function:: runcall(function, *args, **kwds) .. function:: runcall(function, *args, **kwds)
@ -178,7 +178,7 @@ access further features, you have to do this yourself:
that matches one of these patterns. [1]_ that matches one of these patterns. [1]_
By default, Pdb sets a handler for the SIGINT signal (which is sent when the By default, Pdb sets a handler for the SIGINT signal (which is sent when the
user presses :kbd:`Ctrl-C` on the console) when you give a ``continue`` command. user presses :kbd:`Ctrl-C` on the console) when you give a :pdbcmd:`continue` command.
This allows you to break into the debugger again by pressing :kbd:`Ctrl-C`. If you This allows you to break into the debugger again by pressing :kbd:`Ctrl-C`. If you
want Pdb not to touch the SIGINT handler, set *nosigint* to true. want Pdb not to touch the SIGINT handler, set *nosigint* to true.
@ -328,9 +328,9 @@ can be overridden by the local file.
.. pdbcommand:: ignore bpnumber [count] .. pdbcommand:: ignore bpnumber [count]
Set the ignore count for the given breakpoint number. If count is omitted, Set the ignore count for the given breakpoint number. If *count* is omitted,
the ignore count is set to 0. A breakpoint becomes active when the ignore the ignore count is set to 0. A breakpoint becomes active when the ignore
count is zero. When non-zero, the count is decremented each time the count is zero. When non-zero, the *count* is decremented each time the
breakpoint is reached and the breakpoint is not disabled and any associated breakpoint is reached and the breakpoint is not disabled and any associated
condition evaluates to true. condition evaluates to true.
@ -369,7 +369,7 @@ can be overridden by the local file.
breakpoint—which could have its own command list, leading to ambiguities about breakpoint—which could have its own command list, leading to ambiguities about
which list to execute. which list to execute.
If you use the 'silent' command in the command list, the usual message about If you use the ``silent`` command in the command list, the usual message about
stopping at a breakpoint is not printed. This may be desirable for breakpoints stopping at a breakpoint is not printed. This may be desirable for breakpoints
that are to print a specific message and then continue. If none of the other that are to print a specific message and then continue. If none of the other
commands print anything, you see no sign that the breakpoint was reached. commands print anything, you see no sign that the breakpoint was reached.
@ -392,8 +392,8 @@ can be overridden by the local file.
Without argument, continue execution until the line with a number greater Without argument, continue execution until the line with a number greater
than the current one is reached. than the current one is reached.
With a line number, continue execution until a line with a number greater or With *lineno*, continue execution until a line with a number greater or
equal to that is reached. In both cases, also stop when the current frame equal to *lineno* is reached. In both cases, also stop when the current frame
returns. returns.
.. versionchanged:: 3.2 .. versionchanged:: 3.2
@ -446,7 +446,7 @@ can be overridden by the local file.
.. pdbcommand:: p expression .. pdbcommand:: p expression
Evaluate the *expression* in the current context and print its value. Evaluate *expression* in the current context and print its value.
.. note:: .. note::
@ -456,32 +456,32 @@ can be overridden by the local file.
.. pdbcommand:: pp expression .. pdbcommand:: pp expression
Like the :pdbcmd:`p` command, except the value of the expression is Like the :pdbcmd:`p` command, except the value of *expression* is
pretty-printed using the :mod:`pprint` module. pretty-printed using the :mod:`pprint` module.
.. pdbcommand:: whatis expression .. pdbcommand:: whatis expression
Print the type of the *expression*. Print the type of *expression*.
.. pdbcommand:: source expression .. pdbcommand:: source expression
Try to get source code for the given object and display it. Try to get source code of *expression* and display it.
.. versionadded:: 3.2 .. versionadded:: 3.2
.. pdbcommand:: display [expression] .. pdbcommand:: display [expression]
Display the value of the expression if it changed, each time execution stops Display the value of *expression* if it changed, each time execution stops
in the current frame. in the current frame.
Without expression, list all display expressions for the current frame. Without *expression*, list all display expressions for the current frame.
.. versionadded:: 3.2 .. versionadded:: 3.2
.. pdbcommand:: undisplay [expression] .. pdbcommand:: undisplay [expression]
Do not display the expression any more in the current frame. Without Do not display *expression* anymore in the current frame. Without
expression, clear all display expressions for the current frame. *expression*, clear all display expressions for the current frame.
.. versionadded:: 3.2 .. versionadded:: 3.2
@ -497,10 +497,10 @@ can be overridden by the local file.
.. pdbcommand:: alias [name [command]] .. pdbcommand:: alias [name [command]]
Create an alias called *name* that executes *command*. The command must Create an alias called *name* that executes *command*. The *command* must
*not* be enclosed in quotes. Replaceable parameters can be indicated by *not* be enclosed in quotes. Replaceable parameters can be indicated by
``%1``, ``%2``, and so on, while ``%*`` is replaced by all the parameters. ``%1``, ``%2``, and so on, while ``%*`` is replaced by all the parameters.
If no command is given, the current alias for *name* is shown. If no If *command* is omitted, the current alias for *name* is shown. If no
arguments are given, all aliases are listed. arguments are given, all aliases are listed.
Aliases may be nested and can contain anything that can be legally typed at Aliases may be nested and can contain anything that can be legally typed at
@ -519,7 +519,7 @@ can be overridden by the local file.
.. pdbcommand:: unalias name .. pdbcommand:: unalias name
Delete the specified alias. Delete the specified alias *name*.
.. pdbcommand:: ! statement .. pdbcommand:: ! statement
@ -535,7 +535,7 @@ can be overridden by the local file.
.. pdbcommand:: run [args ...] .. pdbcommand:: run [args ...]
restart [args ...] restart [args ...]
Restart the debugged Python program. If an argument is supplied, it is split Restart the debugged Python program. If *args* is supplied, it is split
with :mod:`shlex` and the result is used as the new :data:`sys.argv`. with :mod:`shlex` and the result is used as the new :data:`sys.argv`.
History, breakpoints, actions and debugger options are preserved. History, breakpoints, actions and debugger options are preserved.
:pdbcmd:`restart` is an alias for :pdbcmd:`run`. :pdbcmd:`restart` is an alias for :pdbcmd:`run`.
@ -546,8 +546,8 @@ can be overridden by the local file.
.. pdbcommand:: debug code .. pdbcommand:: debug code
Enter a recursive debugger that steps through the code Enter a recursive debugger that steps through *code*
argument (which is an arbitrary expression or statement to be (which is an arbitrary expression or statement to be
executed in the current environment). executed in the current environment).
.. pdbcommand:: retval .. pdbcommand:: retval