Python-API.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  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 API</title>
  16. <meta name="description" content="Debugging with GDB: Python API">
  17. <meta name="keywords" content="Debugging with GDB: Python API">
  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="Basic-Python.html#Basic-Python" rel="next" title="Basic Python">
  27. <link href="Python-Commands.html#Python-Commands" rel="previous" title="Python Commands">
  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-API"></a>
  59. <div class="header">
  60. <p>
  61. Next: <a href="Python-Auto_002dloading.html#Python-Auto_002dloading" accesskey="n" rel="next">Python Auto-loading</a>, Previous: <a href="Python-Commands.html#Python-Commands" accesskey="p" rel="previous">Python Commands</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-API-1"></a>
  65. <h4 class="subsection">23.2.2 Python API</h4>
  66. <a name="index-python-api"></a>
  67. <a name="index-programming-in-python"></a>
  68. <p>You can get quick online help for <small>GDB</small>&rsquo;s Python API by issuing
  69. the command <kbd>python&nbsp;help&nbsp;(gdb)</kbd><!-- /@w -->.
  70. </p>
  71. <p>Functions and methods which have two or more optional arguments allow
  72. them to be specified using keyword syntax. This allows passing some
  73. optional arguments while skipping others. Example:
  74. <code><span class="nolinebreak">gdb.some_function</span>&nbsp;('foo',&nbsp;bar&nbsp;=&nbsp;1,&nbsp;baz&nbsp;=&nbsp;2)</code><!-- /@w -->.
  75. </p>
  76. <table class="menu" border="0" cellspacing="0">
  77. <tr><td align="left" valign="top">&bull; <a href="Basic-Python.html#Basic-Python" accesskey="1">Basic Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Basic Python Functions.
  78. </td></tr>
  79. <tr><td align="left" valign="top">&bull; <a href="Exception-Handling.html#Exception-Handling" accesskey="2">Exception Handling</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">How Python exceptions are translated.
  80. </td></tr>
  81. <tr><td align="left" valign="top">&bull; <a href="Values-From-Inferior.html#Values-From-Inferior" accesskey="3">Values From Inferior</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Python representation of values.
  82. </td></tr>
  83. <tr><td align="left" valign="top">&bull; <a href="Types-In-Python.html#Types-In-Python" accesskey="4">Types In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Python representation of types.
  84. </td></tr>
  85. <tr><td align="left" valign="top">&bull; <a href="Pretty-Printing-API.html#Pretty-Printing-API" accesskey="5">Pretty Printing API</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Pretty-printing values.
  86. </td></tr>
  87. <tr><td align="left" valign="top">&bull; <a href="Selecting-Pretty_002dPrinters.html#Selecting-Pretty_002dPrinters" accesskey="6">Selecting Pretty-Printers</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">How GDB chooses a pretty-printer.
  88. </td></tr>
  89. <tr><td align="left" valign="top">&bull; <a href="Writing-a-Pretty_002dPrinter.html#Writing-a-Pretty_002dPrinter" accesskey="7">Writing a Pretty-Printer</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Writing a Pretty-Printer.
  90. </td></tr>
  91. <tr><td align="left" valign="top">&bull; <a href="Type-Printing-API.html#Type-Printing-API" accesskey="8">Type Printing API</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Pretty-printing types.
  92. </td></tr>
  93. <tr><td align="left" valign="top">&bull; <a href="Frame-Filter-API.html#Frame-Filter-API" accesskey="9">Frame Filter API</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Filtering Frames.
  94. </td></tr>
  95. <tr><td align="left" valign="top">&bull; <a href="Frame-Decorator-API.html#Frame-Decorator-API">Frame Decorator API</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Decorating Frames.
  96. </td></tr>
  97. <tr><td align="left" valign="top">&bull; <a href="Writing-a-Frame-Filter.html#Writing-a-Frame-Filter">Writing a Frame Filter</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Writing a Frame Filter.
  98. </td></tr>
  99. <tr><td align="left" valign="top">&bull; <a href="Unwinding-Frames-in-Python.html#Unwinding-Frames-in-Python">Unwinding Frames in Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Writing frame unwinder.
  100. </td></tr>
  101. <tr><td align="left" valign="top">&bull; <a href="Xmethods-In-Python.html#Xmethods-In-Python">Xmethods In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Adding and replacing methods of C++ classes.
  102. </td></tr>
  103. <tr><td align="left" valign="top">&bull; <a href="Xmethod-API.html#Xmethod-API">Xmethod API</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Xmethod types.
  104. </td></tr>
  105. <tr><td align="left" valign="top">&bull; <a href="Writing-an-Xmethod.html#Writing-an-Xmethod">Writing an Xmethod</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Writing an xmethod.
  106. </td></tr>
  107. <tr><td align="left" valign="top">&bull; <a href="Inferiors-In-Python.html#Inferiors-In-Python">Inferiors In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Python representation of inferiors (processes)
  108. </td></tr>
  109. <tr><td align="left" valign="top">&bull; <a href="Events-In-Python.html#Events-In-Python">Events In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Listening for events from <small>GDB</small>.
  110. </td></tr>
  111. <tr><td align="left" valign="top">&bull; <a href="Threads-In-Python.html#Threads-In-Python">Threads In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Accessing inferior threads from Python.
  112. </td></tr>
  113. <tr><td align="left" valign="top">&bull; <a href="Recordings-In-Python.html#Recordings-In-Python">Recordings In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Accessing recordings from Python.
  114. </td></tr>
  115. <tr><td align="left" valign="top">&bull; <a href="Commands-In-Python.html#Commands-In-Python">Commands In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Implementing new commands in Python.
  116. </td></tr>
  117. <tr><td align="left" valign="top">&bull; <a href="Parameters-In-Python.html#Parameters-In-Python">Parameters In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Adding new <small>GDB</small> parameters.
  118. </td></tr>
  119. <tr><td align="left" valign="top">&bull; <a href="Functions-In-Python.html#Functions-In-Python">Functions In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Writing new convenience functions.
  120. </td></tr>
  121. <tr><td align="left" valign="top">&bull; <a href="Progspaces-In-Python.html#Progspaces-In-Python">Progspaces In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Program spaces.
  122. </td></tr>
  123. <tr><td align="left" valign="top">&bull; <a href="Objfiles-In-Python.html#Objfiles-In-Python">Objfiles In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Object files.
  124. </td></tr>
  125. <tr><td align="left" valign="top">&bull; <a href="Frames-In-Python.html#Frames-In-Python">Frames In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Accessing inferior stack frames from Python.
  126. </td></tr>
  127. <tr><td align="left" valign="top">&bull; <a href="Blocks-In-Python.html#Blocks-In-Python">Blocks In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Accessing blocks from Python.
  128. </td></tr>
  129. <tr><td align="left" valign="top">&bull; <a href="Symbols-In-Python.html#Symbols-In-Python">Symbols In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Python representation of symbols.
  130. </td></tr>
  131. <tr><td align="left" valign="top">&bull; <a href="Symbol-Tables-In-Python.html#Symbol-Tables-In-Python">Symbol Tables In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Python representation of symbol tables.
  132. </td></tr>
  133. <tr><td align="left" valign="top">&bull; <a href="Line-Tables-In-Python.html#Line-Tables-In-Python">Line Tables In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Python representation of line tables.
  134. </td></tr>
  135. <tr><td align="left" valign="top">&bull; <a href="Breakpoints-In-Python.html#Breakpoints-In-Python">Breakpoints In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Manipulating breakpoints using Python.
  136. </td></tr>
  137. <tr><td align="left" valign="top">&bull; <a href="Finish-Breakpoints-in-Python.html#Finish-Breakpoints-in-Python">Finish Breakpoints in Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Setting Breakpoints on function return
  138. using Python.
  139. </td></tr>
  140. <tr><td align="left" valign="top">&bull; <a href="Lazy-Strings-In-Python.html#Lazy-Strings-In-Python">Lazy Strings In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Python representation of lazy strings.
  141. </td></tr>
  142. <tr><td align="left" valign="top">&bull; <a href="Architectures-In-Python.html#Architectures-In-Python">Architectures In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Python representation of architectures.
  143. </td></tr>
  144. <tr><td align="left" valign="top">&bull; <a href="Registers-In-Python.html#Registers-In-Python">Registers In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Python representation of registers.
  145. </td></tr>
  146. <tr><td align="left" valign="top">&bull; <a href="TUI-Windows-In-Python.html#TUI-Windows-In-Python">TUI Windows In Python</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Implementing new TUI windows.
  147. </td></tr>
  148. </table>
  149. <hr>
  150. <div class="header">
  151. <p>
  152. Next: <a href="Python-Auto_002dloading.html#Python-Auto_002dloading" accesskey="n" rel="next">Python Auto-loading</a>, Previous: <a href="Python-Commands.html#Python-Commands" accesskey="p" rel="previous">Python Commands</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>
  153. </div>
  154. </body>
  155. </html>