Python-Commands.html 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 1988-2020 Free Software Foundation, Inc.
  4. Permission is granted to copy, distribute and/or modify this document
  5. under the terms of the GNU Free Documentation License, Version 1.3 or
  6. any later version published by the Free Software Foundation; with the
  7. Invariant Sections being "Free Software" and "Free Software Needs
  8. Free Documentation", with the Front-Cover Texts being "A GNU Manual,"
  9. and with the Back-Cover Texts as in (a) below.
  10. (a) The FSF's Back-Cover Text is: "You are free to copy and modify
  11. this GNU Manual. Buying copies from GNU Press supports the FSF in
  12. developing GNU and promoting software freedom." -->
  13. <!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
  14. <head>
  15. <title>Debugging with GDB: Python Commands</title>
  16. <meta name="description" content="Debugging with GDB: Python Commands">
  17. <meta name="keywords" content="Debugging with GDB: Python Commands">
  18. <meta name="resource-type" content="document">
  19. <meta name="distribution" content="global">
  20. <meta name="Generator" content="makeinfo">
  21. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  22. <link href="index.html#Top" rel="start" title="Top">
  23. <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
  24. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  25. <link href="Python.html#Python" rel="up" title="Python">
  26. <link href="Python-API.html#Python-API" rel="next" title="Python API">
  27. <link href="Python.html#Python" rel="previous" title="Python">
  28. <style type="text/css">
  29. <!--
  30. a.summary-letter {text-decoration: none}
  31. blockquote.smallquotation {font-size: smaller}
  32. div.display {margin-left: 3.2em}
  33. div.example {margin-left: 3.2em}
  34. div.indentedblock {margin-left: 3.2em}
  35. div.lisp {margin-left: 3.2em}
  36. div.smalldisplay {margin-left: 3.2em}
  37. div.smallexample {margin-left: 3.2em}
  38. div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
  39. div.smalllisp {margin-left: 3.2em}
  40. kbd {font-style:oblique}
  41. pre.display {font-family: inherit}
  42. pre.format {font-family: inherit}
  43. pre.menu-comment {font-family: serif}
  44. pre.menu-preformatted {font-family: serif}
  45. pre.smalldisplay {font-family: inherit; font-size: smaller}
  46. pre.smallexample {font-size: smaller}
  47. pre.smallformat {font-family: inherit; font-size: smaller}
  48. pre.smalllisp {font-size: smaller}
  49. span.nocodebreak {white-space:nowrap}
  50. span.nolinebreak {white-space:nowrap}
  51. span.roman {font-family:serif; font-weight:normal}
  52. span.sansserif {font-family:sans-serif; font-weight:normal}
  53. ul.no-bullet {list-style: none}
  54. -->
  55. </style>
  56. </head>
  57. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  58. <a name="Python-Commands"></a>
  59. <div class="header">
  60. <p>
  61. Next: <a href="Python-API.html#Python-API" accesskey="n" rel="next">Python API</a>, Up: <a href="Python.html#Python" accesskey="u" rel="up">Python</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
  62. </div>
  63. <hr>
  64. <a name="Python-Commands-1"></a>
  65. <h4 class="subsection">23.2.1 Python Commands</h4>
  66. <a name="index-python-commands"></a>
  67. <a name="index-commands-to-access-python"></a>
  68. <p><small>GDB</small> provides two commands for accessing the Python interpreter,
  69. and one related setting:
  70. </p>
  71. <dl compact="compact">
  72. <dd><a name="index-python_002dinteractive"></a>
  73. <a name="index-pi"></a>
  74. </dd>
  75. <dt><code>python-interactive <span class="roman">[</span><var>command</var><span class="roman">]</span></code></dt>
  76. <dt><code>pi <span class="roman">[</span><var>command</var><span class="roman">]</span></code></dt>
  77. <dd><p>Without an argument, the <code>python-interactive</code> command can be used
  78. to start an interactive Python prompt. To return to <small>GDB</small>,
  79. type the <code>EOF</code> character (e.g., <kbd>Ctrl-D</kbd> on an empty prompt).
  80. </p>
  81. <p>Alternatively, a single-line Python command can be given as an
  82. argument and evaluated. If the command is an expression, the result
  83. will be printed; otherwise, nothing will be printed. For example:
  84. </p>
  85. <div class="smallexample">
  86. <pre class="smallexample">(gdb) python-interactive 2 + 3
  87. 5
  88. </pre></div>
  89. <a name="index-python-1"></a>
  90. <a name="index-py"></a>
  91. </dd>
  92. <dt><code>python <span class="roman">[</span><var>command</var><span class="roman">]</span></code></dt>
  93. <dt><code>py <span class="roman">[</span><var>command</var><span class="roman">]</span></code></dt>
  94. <dd><p>The <code>python</code> command can be used to evaluate Python code.
  95. </p>
  96. <p>If given an argument, the <code>python</code> command will evaluate the
  97. argument as a Python command. For example:
  98. </p>
  99. <div class="smallexample">
  100. <pre class="smallexample">(gdb) python print 23
  101. 23
  102. </pre></div>
  103. <p>If you do not provide an argument to <code>python</code>, it will act as a
  104. multi-line command, like <code>define</code>. In this case, the Python
  105. script is made up of subsequent command lines, given after the
  106. <code>python</code> command. This command list is terminated using a line
  107. containing <code>end</code>. For example:
  108. </p>
  109. <div class="smallexample">
  110. <pre class="smallexample">(gdb) python
  111. &gt;print 23
  112. &gt;end
  113. 23
  114. </pre></div>
  115. <a name="index-set-python-print_002dstack"></a>
  116. </dd>
  117. <dt><code>set python print-stack</code></dt>
  118. <dd><p>By default, <small>GDB</small> will print only the message component of a
  119. Python exception when an error occurs in a Python script. This can be
  120. controlled using <code>set python print-stack</code>: if <code>full</code>, then
  121. full Python stack printing is enabled; if <code>none</code>, then Python stack
  122. and message printing is disabled; if <code>message</code>, the default, only
  123. the message component of the error is printed.
  124. </p></dd>
  125. </dl>
  126. <p>It is also possible to execute a Python script from the <small>GDB</small>
  127. interpreter:
  128. </p>
  129. <dl compact="compact">
  130. <dt><code>source <samp>script-name</samp></code></dt>
  131. <dd><p>The script name must end with &lsquo;<samp>.py</samp>&rsquo; and <small>GDB</small> must be configured
  132. to recognize the script language based on filename extension using
  133. the <code>script-extension</code> setting. See <a href="Extending-GDB.html#Extending-GDB">Extending GDB</a>.
  134. </p></dd>
  135. </dl>
  136. <hr>
  137. <div class="header">
  138. <p>
  139. Next: <a href="Python-API.html#Python-API" accesskey="n" rel="next">Python API</a>, Up: <a href="Python.html#Python" accesskey="u" rel="up">Python</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
  140. </div>
  141. </body>
  142. </html>