Python.html 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  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</title>
  16. <meta name="description" content="Debugging with GDB: Python">
  17. <meta name="keywords" content="Debugging with GDB: Python">
  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="Extending-GDB.html#Extending-GDB" rel="up" title="Extending GDB">
  26. <link href="Python-Commands.html#Python-Commands" rel="next" title="Python Commands">
  27. <link href="Auto_002dloading-sequences.html#Auto_002dloading-sequences" rel="previous" title="Auto-loading sequences">
  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"></a>
  59. <div class="header">
  60. <p>
  61. Next: <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> &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="Extending-GDB-using-Python"></a>
  65. <h3 class="section">23.2 Extending <small>GDB</small> using Python</h3>
  66. <a name="index-python-scripting"></a>
  67. <a name="index-scripting-with-python"></a>
  68. <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
  69. <small>GDB</small> was configured using <samp>--with-python</samp>.
  70. <small>GDB</small> can be built against either Python 2 or Python 3; which
  71. one you have depends on this configure-time option.
  72. </p>
  73. <a name="index-python-directory"></a>
  74. <p>Python scripts used by <small>GDB</small> should be installed in
  75. <samp><var>data-directory</var>/python</samp>, where <var>data-directory</var> is
  76. the data directory as determined at <small>GDB</small> startup (see <a href="Data-Files.html#Data-Files">Data Files</a>).
  77. This directory, known as the <em>python directory</em>,
  78. is automatically added to the Python Search Path in order to allow
  79. the Python interpreter to locate all scripts installed at this location.
  80. </p>
  81. <p>Additionally, <small>GDB</small> commands and convenience functions which
  82. are written in Python and are located in the
  83. <samp><var>data-directory</var>/python/gdb/command</samp> or
  84. <samp><var>data-directory</var>/python/gdb/function</samp> directories are
  85. automatically imported when <small>GDB</small> starts.
  86. </p>
  87. <table class="menu" border="0" cellspacing="0">
  88. <tr><td align="left" valign="top">&bull; <a href="Python-Commands.html#Python-Commands" accesskey="1">Python Commands</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Accessing Python from <small>GDB</small>.
  89. </td></tr>
  90. <tr><td align="left" valign="top">&bull; <a href="Python-API.html#Python-API" accesskey="2">Python API</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Accessing <small>GDB</small> from Python.
  91. </td></tr>
  92. <tr><td align="left" valign="top">&bull; <a href="Python-Auto_002dloading.html#Python-Auto_002dloading" accesskey="3">Python Auto-loading</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Automatically loading Python code.
  93. </td></tr>
  94. <tr><td align="left" valign="top">&bull; <a href="Python-modules.html#Python-modules" accesskey="4">Python modules</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Python modules provided by <small>GDB</small>.
  95. </td></tr>
  96. </table>
  97. </body>
  98. </html>