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-2021 Free Software Foundation, Inc. 4 5Permission is granted to copy, distribute and/or modify this document 6under the terms of the GNU Free Documentation License, Version 1.3 or 7any later version published by the Free Software Foundation; with the 8Invariant Sections being "Free Software" and "Free Software Needs 9Free Documentation", with the Front-Cover Texts being "A GNU Manual," 10and with the Back-Cover Texts as in (a) below. 11 12(a) The FSF's Back-Cover Text is: "You are free to copy and modify 13this GNU Manual. Buying copies from GNU Press supports the FSF in 14developing GNU and promoting software freedom." --> 15<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ --> 16<head> 17<title>Debugging with GDB: Python API</title> 18 19<meta name="description" content="Debugging with GDB: Python API"> 20<meta name="keywords" content="Debugging with GDB: Python API"> 21<meta name="resource-type" content="document"> 22<meta name="distribution" content="global"> 23<meta name="Generator" content="makeinfo"> 24<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 25<link href="index.html#Top" rel="start" title="Top"> 26<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index"> 27<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> 28<link href="Python.html#Python" rel="up" title="Python"> 29<link href="Basic-Python.html#Basic-Python" rel="next" title="Basic Python"> 30<link href="Python-Commands.html#Python-Commands" rel="previous" title="Python Commands"> 31<style type="text/css"> 32<!-- 33a.summary-letter {text-decoration: none} 34blockquote.smallquotation {font-size: smaller} 35div.display {margin-left: 3.2em} 36div.example {margin-left: 3.2em} 37div.indentedblock {margin-left: 3.2em} 38div.lisp {margin-left: 3.2em} 39div.smalldisplay {margin-left: 3.2em} 40div.smallexample {margin-left: 3.2em} 41div.smallindentedblock {margin-left: 3.2em; font-size: smaller} 42div.smalllisp {margin-left: 3.2em} 43kbd {font-style:oblique} 44pre.display {font-family: inherit} 45pre.format {font-family: inherit} 46pre.menu-comment {font-family: serif} 47pre.menu-preformatted {font-family: serif} 48pre.smalldisplay {font-family: inherit; font-size: smaller} 49pre.smallexample {font-size: smaller} 50pre.smallformat {font-family: inherit; font-size: smaller} 51pre.smalllisp {font-size: smaller} 52span.nocodebreak {white-space:nowrap} 53span.nolinebreak {white-space:nowrap} 54span.roman {font-family:serif; font-weight:normal} 55span.sansserif {font-family:sans-serif; font-weight:normal} 56ul.no-bullet {list-style: none} 57--> 58</style> 59 60 61</head> 62 63<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"> 64<a name="Python-API"></a> 65<div class="header"> 66<p> 67Next: <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> [<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> 68</div> 69<hr> 70<a name="Python-API-1"></a> 71<h4 class="subsection">23.2.2 Python API</h4> 72<a name="index-python-api"></a> 73<a name="index-programming-in-python"></a> 74 75<p>You can get quick online help for <small>GDB</small>’s Python API by issuing 76the command <kbd>python help (gdb)</kbd><!-- /@w -->. 77</p> 78<p>Functions and methods which have two or more optional arguments allow 79them to be specified using keyword syntax. This allows passing some 80optional arguments while skipping others. Example: 81<code><span class="nolinebreak">gdb.some_function</span> ('foo', bar = 1, baz = 2)</code><!-- /@w -->. 82</p> 83<table class="menu" border="0" cellspacing="0"> 84<tr><td align="left" valign="top">• <a href="Basic-Python.html#Basic-Python" accesskey="1">Basic Python</a>:</td><td> </td><td align="left" valign="top">Basic Python Functions. 85</td></tr> 86<tr><td align="left" valign="top">• <a href="Exception-Handling.html#Exception-Handling" accesskey="2">Exception Handling</a>:</td><td> </td><td align="left" valign="top">How Python exceptions are translated. 87</td></tr> 88<tr><td align="left" valign="top">• <a href="Values-From-Inferior.html#Values-From-Inferior" accesskey="3">Values From Inferior</a>:</td><td> </td><td align="left" valign="top">Python representation of values. 89</td></tr> 90<tr><td align="left" valign="top">• <a href="Types-In-Python.html#Types-In-Python" accesskey="4">Types In Python</a>:</td><td> </td><td align="left" valign="top">Python representation of types. 91</td></tr> 92<tr><td align="left" valign="top">• <a href="Pretty-Printing-API.html#Pretty-Printing-API" accesskey="5">Pretty Printing API</a>:</td><td> </td><td align="left" valign="top">Pretty-printing values. 93</td></tr> 94<tr><td align="left" valign="top">• <a href="Selecting-Pretty_002dPrinters.html#Selecting-Pretty_002dPrinters" accesskey="6">Selecting Pretty-Printers</a>:</td><td> </td><td align="left" valign="top">How GDB chooses a pretty-printer. 95</td></tr> 96<tr><td align="left" valign="top">• <a href="Writing-a-Pretty_002dPrinter.html#Writing-a-Pretty_002dPrinter" accesskey="7">Writing a Pretty-Printer</a>:</td><td> </td><td align="left" valign="top">Writing a Pretty-Printer. 97</td></tr> 98<tr><td align="left" valign="top">• <a href="Type-Printing-API.html#Type-Printing-API" accesskey="8">Type Printing API</a>:</td><td> </td><td align="left" valign="top">Pretty-printing types. 99</td></tr> 100<tr><td align="left" valign="top">• <a href="Frame-Filter-API.html#Frame-Filter-API" accesskey="9">Frame Filter API</a>:</td><td> </td><td align="left" valign="top">Filtering Frames. 101</td></tr> 102<tr><td align="left" valign="top">• <a href="Frame-Decorator-API.html#Frame-Decorator-API">Frame Decorator API</a>:</td><td> </td><td align="left" valign="top">Decorating Frames. 103</td></tr> 104<tr><td align="left" valign="top">• <a href="Writing-a-Frame-Filter.html#Writing-a-Frame-Filter">Writing a Frame Filter</a>:</td><td> </td><td align="left" valign="top">Writing a Frame Filter. 105</td></tr> 106<tr><td align="left" valign="top">• <a href="Unwinding-Frames-in-Python.html#Unwinding-Frames-in-Python">Unwinding Frames in Python</a>:</td><td> </td><td align="left" valign="top">Writing frame unwinder. 107</td></tr> 108<tr><td align="left" valign="top">• <a href="Xmethods-In-Python.html#Xmethods-In-Python">Xmethods In Python</a>:</td><td> </td><td align="left" valign="top">Adding and replacing methods of C++ classes. 109</td></tr> 110<tr><td align="left" valign="top">• <a href="Xmethod-API.html#Xmethod-API">Xmethod API</a>:</td><td> </td><td align="left" valign="top">Xmethod types. 111</td></tr> 112<tr><td align="left" valign="top">• <a href="Writing-an-Xmethod.html#Writing-an-Xmethod">Writing an Xmethod</a>:</td><td> </td><td align="left" valign="top">Writing an xmethod. 113</td></tr> 114<tr><td align="left" valign="top">• <a href="Inferiors-In-Python.html#Inferiors-In-Python">Inferiors In Python</a>:</td><td> </td><td align="left" valign="top">Python representation of inferiors (processes) 115</td></tr> 116<tr><td align="left" valign="top">• <a href="Events-In-Python.html#Events-In-Python">Events In Python</a>:</td><td> </td><td align="left" valign="top">Listening for events from <small>GDB</small>. 117</td></tr> 118<tr><td align="left" valign="top">• <a href="Threads-In-Python.html#Threads-In-Python">Threads In Python</a>:</td><td> </td><td align="left" valign="top">Accessing inferior threads from Python. 119</td></tr> 120<tr><td align="left" valign="top">• <a href="Recordings-In-Python.html#Recordings-In-Python">Recordings In Python</a>:</td><td> </td><td align="left" valign="top">Accessing recordings from Python. 121</td></tr> 122<tr><td align="left" valign="top">• <a href="Commands-In-Python.html#Commands-In-Python">Commands In Python</a>:</td><td> </td><td align="left" valign="top">Implementing new commands in Python. 123</td></tr> 124<tr><td align="left" valign="top">• <a href="Parameters-In-Python.html#Parameters-In-Python">Parameters In Python</a>:</td><td> </td><td align="left" valign="top">Adding new <small>GDB</small> parameters. 125</td></tr> 126<tr><td align="left" valign="top">• <a href="Functions-In-Python.html#Functions-In-Python">Functions In Python</a>:</td><td> </td><td align="left" valign="top">Writing new convenience functions. 127</td></tr> 128<tr><td align="left" valign="top">• <a href="Progspaces-In-Python.html#Progspaces-In-Python">Progspaces In Python</a>:</td><td> </td><td align="left" valign="top">Program spaces. 129</td></tr> 130<tr><td align="left" valign="top">• <a href="Objfiles-In-Python.html#Objfiles-In-Python">Objfiles In Python</a>:</td><td> </td><td align="left" valign="top">Object files. 131</td></tr> 132<tr><td align="left" valign="top">• <a href="Frames-In-Python.html#Frames-In-Python">Frames In Python</a>:</td><td> </td><td align="left" valign="top">Accessing inferior stack frames from Python. 133</td></tr> 134<tr><td align="left" valign="top">• <a href="Blocks-In-Python.html#Blocks-In-Python">Blocks In Python</a>:</td><td> </td><td align="left" valign="top">Accessing blocks from Python. 135</td></tr> 136<tr><td align="left" valign="top">• <a href="Symbols-In-Python.html#Symbols-In-Python">Symbols In Python</a>:</td><td> </td><td align="left" valign="top">Python representation of symbols. 137</td></tr> 138<tr><td align="left" valign="top">• <a href="Symbol-Tables-In-Python.html#Symbol-Tables-In-Python">Symbol Tables In Python</a>:</td><td> </td><td align="left" valign="top">Python representation of symbol tables. 139</td></tr> 140<tr><td align="left" valign="top">• <a href="Line-Tables-In-Python.html#Line-Tables-In-Python">Line Tables In Python</a>:</td><td> </td><td align="left" valign="top">Python representation of line tables. 141</td></tr> 142<tr><td align="left" valign="top">• <a href="Breakpoints-In-Python.html#Breakpoints-In-Python">Breakpoints In Python</a>:</td><td> </td><td align="left" valign="top">Manipulating breakpoints using Python. 143</td></tr> 144<tr><td align="left" valign="top">• <a href="Finish-Breakpoints-in-Python.html#Finish-Breakpoints-in-Python">Finish Breakpoints in Python</a>:</td><td> </td><td align="left" valign="top">Setting Breakpoints on function return 145 using Python. 146</td></tr> 147<tr><td align="left" valign="top">• <a href="Lazy-Strings-In-Python.html#Lazy-Strings-In-Python">Lazy Strings In Python</a>:</td><td> </td><td align="left" valign="top">Python representation of lazy strings. 148</td></tr> 149<tr><td align="left" valign="top">• <a href="Architectures-In-Python.html#Architectures-In-Python">Architectures In Python</a>:</td><td> </td><td align="left" valign="top">Python representation of architectures. 150</td></tr> 151<tr><td align="left" valign="top">• <a href="Registers-In-Python.html#Registers-In-Python">Registers In Python</a>:</td><td> </td><td align="left" valign="top">Python representation of registers. 152</td></tr> 153<tr><td align="left" valign="top">• <a href="TUI-Windows-In-Python.html#TUI-Windows-In-Python">TUI Windows In Python</a>:</td><td> </td><td align="left" valign="top">Implementing new TUI windows. 154</td></tr> 155</table> 156 157<hr> 158<div class="header"> 159<p> 160Next: <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> [<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> 161</div> 162 163 164 165</body> 166</html> 167