| <html lang="en"> |
| <head> |
| <title>Python Commands - Debugging with GDB</title> |
| <meta http-equiv="Content-Type" content="text/html"> |
| <meta name="description" content="Debugging with GDB"> |
| <meta name="generator" content="makeinfo 4.13"> |
| <link title="Top" rel="start" href="index.html#Top"> |
| <link rel="up" href="Python.html#Python" title="Python"> |
| <link rel="next" href="Python-API.html#Python-API" title="Python API"> |
| <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> |
| <!-- |
| Copyright (C) 1988-2019 Free Software Foundation, Inc. |
| |
| Permission is granted to copy, distribute and/or modify this document |
| under the terms of the GNU Free Documentation License, Version 1.3 or |
| any later version published by the Free Software Foundation; with the |
| Invariant Sections being ``Free Software'' and ``Free Software Needs |
| Free Documentation'', with the Front-Cover Texts being ``A GNU Manual,'' |
| and with the Back-Cover Texts as in (a) below. |
| |
| (a) The FSF's Back-Cover Text is: ``You are free to copy and modify |
| this GNU Manual. Buying copies from GNU Press supports the FSF in |
| developing GNU and promoting software freedom.'' |
| --> |
| <meta http-equiv="Content-Style-Type" content="text/css"> |
| <style type="text/css"><!-- |
| pre.display { font-family:inherit } |
| pre.format { font-family:inherit } |
| pre.smalldisplay { font-family:inherit; font-size:smaller } |
| pre.smallformat { font-family:inherit; font-size:smaller } |
| pre.smallexample { font-size:smaller } |
| pre.smalllisp { font-size:smaller } |
| span.sc { font-variant:small-caps } |
| span.roman { font-family:serif; font-weight:normal; } |
| span.sansserif { font-family:sans-serif; font-weight:normal; } |
| --></style> |
| </head> |
| <body> |
| <div class="node"> |
| <a name="Python-Commands"></a> |
| <p> |
| Next: <a rel="next" accesskey="n" href="Python-API.html#Python-API">Python API</a>, |
| Up: <a rel="up" accesskey="u" href="Python.html#Python">Python</a> |
| <hr> |
| </div> |
| |
| <h4 class="subsection">23.2.1 Python Commands</h4> |
| |
| <p><a name="index-python-commands-1839"></a><a name="index-commands-to-access-python-1840"></a> |
| <span class="sc">gdb</span> provides two commands for accessing the Python interpreter, |
| and one related setting: |
| |
| |
| <a name="index-python_002dinteractive-1841"></a> |
| <a name="index-pi-1842"></a> |
| <dl><dt><code>python-interactive </code><span class="roman">[</span><var>command</var><span class="roman">]</span><dt><code>pi </code><span class="roman">[</span><var>command</var><span class="roman">]</span><dd>Without an argument, the <code>python-interactive</code> command can be used |
| to start an interactive Python prompt. To return to <span class="sc">gdb</span>, |
| type the <code>EOF</code> character (e.g., <kbd>Ctrl-D</kbd> on an empty prompt). |
| |
| <p>Alternatively, a single-line Python command can be given as an |
| argument and evaluated. If the command is an expression, the result |
| will be printed; otherwise, nothing will be printed. For example: |
| |
| <pre class="smallexample"> (gdb) python-interactive 2 + 3 |
| 5 |
| </pre> |
| <p><a name="index-python-1843"></a><a name="index-py-1844"></a><br><dt><code>python </code><span class="roman">[</span><var>command</var><span class="roman">]</span><dt><code>py </code><span class="roman">[</span><var>command</var><span class="roman">]</span><dd>The <code>python</code> command can be used to evaluate Python code. |
| |
| <p>If given an argument, the <code>python</code> command will evaluate the |
| argument as a Python command. For example: |
| |
| <pre class="smallexample"> (gdb) python print 23 |
| 23 |
| </pre> |
| <p>If you do not provide an argument to <code>python</code>, it will act as a |
| multi-line command, like <code>define</code>. In this case, the Python |
| script is made up of subsequent command lines, given after the |
| <code>python</code> command. This command list is terminated using a line |
| containing <code>end</code>. For example: |
| |
| <pre class="smallexample"> (gdb) python |
| Type python script |
| End with a line saying just "end". |
| >print 23 |
| >end |
| 23 |
| </pre> |
| <p><a name="index-set-python-print_002dstack-1845"></a><br><dt><code>set python print-stack</code><dd>By default, <span class="sc">gdb</span> will print only the message component of a |
| Python exception when an error occurs in a Python script. This can be |
| controlled using <code>set python print-stack</code>: if <code>full</code>, then |
| full Python stack printing is enabled; if <code>none</code>, then Python stack |
| and message printing is disabled; if <code>message</code>, the default, only |
| the message component of the error is printed. |
| </dl> |
| |
| <p>It is also possible to execute a Python script from the <span class="sc">gdb</span> |
| interpreter: |
| |
| <dl> |
| <dt><code>source </code><samp><span class="file">script-name</span></samp><dd>The script name must end with ‘<samp><span class="samp">.py</span></samp>’ and <span class="sc">gdb</span> must be configured |
| to recognize the script language based on filename extension using |
| the <code>script-extension</code> setting. See <a href="Extending-GDB.html#Extending-GDB">Extending GDB</a>. |
| </dl> |
| |
| </body></html> |
| |
