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</title> 18 19<meta name="description" content="Debugging with GDB: Python"> 20<meta name="keywords" content="Debugging with GDB: Python"> 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="Extending-GDB.html#Extending-GDB" rel="up" title="Extending GDB"> 29<link href="Python-Commands.html#Python-Commands" rel="next" title="Python Commands"> 30<link href="Auto_002dloading-sequences.html#Auto_002dloading-sequences" rel="previous" title="Auto-loading sequences"> 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"></a> 65<div class="header"> 66<p> 67Next: <a href="Guile.html#Guile" accesskey="n" rel="next">Guile</a>, Previous: <a href="Sequences.html#Sequences" accesskey="p" rel="previous">Sequences</a>, Up: <a href="Extending-GDB.html#Extending-GDB" accesskey="u" rel="up">Extending GDB</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="Extending-GDB-using-Python"></a> 71<h3 class="section">23.2 Extending <small>GDB</small> using Python</h3> 72<a name="index-python-scripting"></a> 73<a name="index-scripting-with-python"></a> 74 75<p>You can extend <small>GDB</small> using the <a href="http://www.python.org/">Python programming language</a>. This feature is available only if 76<small>GDB</small> was configured using <samp>--with-python</samp>. 77<small>GDB</small> can be built against either Python 2 or Python 3; which 78one you have depends on this configure-time option. 79</p> 80<a name="index-python-directory"></a> 81<p>Python scripts used by <small>GDB</small> should be installed in 82<samp><var>data-directory</var>/python</samp>, where <var>data-directory</var> is 83the data directory as determined at <small>GDB</small> startup (see <a href="Data-Files.html#Data-Files">Data Files</a>). 84This directory, known as the <em>python directory</em>, 85is automatically added to the Python Search Path in order to allow 86the Python interpreter to locate all scripts installed at this location. 87</p> 88<p>Additionally, <small>GDB</small> commands and convenience functions which 89are written in Python and are located in the 90<samp><var>data-directory</var>/python/gdb/command</samp> or 91<samp><var>data-directory</var>/python/gdb/function</samp> directories are 92automatically imported when <small>GDB</small> starts. 93</p> 94<table class="menu" border="0" cellspacing="0"> 95<tr><td align="left" valign="top">• <a href="Python-Commands.html#Python-Commands" accesskey="1">Python Commands</a>:</td><td> </td><td align="left" valign="top">Accessing Python from <small>GDB</small>. 96</td></tr> 97<tr><td align="left" valign="top">• <a href="Python-API.html#Python-API" accesskey="2">Python API</a>:</td><td> </td><td align="left" valign="top">Accessing <small>GDB</small> from Python. 98</td></tr> 99<tr><td align="left" valign="top">• <a href="Python-Auto_002dloading.html#Python-Auto_002dloading" accesskey="3">Python Auto-loading</a>:</td><td> </td><td align="left" valign="top">Automatically loading Python code. 100</td></tr> 101<tr><td align="left" valign="top">• <a href="Python-modules.html#Python-modules" accesskey="4">Python modules</a>:</td><td> </td><td align="left" valign="top">Python modules provided by <small>GDB</small>. 102</td></tr> 103</table> 104 105 106 107 108</body> 109</html> 110