Python-Auto_002dloading.html 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  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 Auto-loading</title>
  16. <meta name="description" content="Debugging with GDB: Python Auto-loading">
  17. <meta name="keywords" content="Debugging with GDB: Python Auto-loading">
  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-modules.html#Python-modules" rel="next" title="Python modules">
  27. <link href="TUI-Windows-In-Python.html#TUI-Windows-In-Python" rel="previous" title="TUI Windows In 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-Auto_002dloading"></a>
  59. <div class="header">
  60. <p>
  61. Next: <a href="Python-modules.html#Python-modules" accesskey="n" rel="next">Python modules</a>, Previous: <a href="Python-API.html#Python-API" accesskey="p" rel="previous">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-Auto_002dloading-1"></a>
  65. <h4 class="subsection">23.2.3 Python Auto-loading</h4>
  66. <a name="index-Python-auto_002dloading"></a>
  67. <p>When a new object file is read (for example, due to the <code>file</code>
  68. command, or because the inferior has loaded a shared library),
  69. <small>GDB</small> will look for Python support scripts in several ways:
  70. <samp><var>objfile</var>-gdb.py</samp> and <code>.debug_gdb_scripts</code> section.
  71. See <a href="Auto_002dloading-extensions.html#Auto_002dloading-extensions">Auto-loading extensions</a>.
  72. </p>
  73. <p>The auto-loading feature is useful for supplying application-specific
  74. debugging commands and scripts.
  75. </p>
  76. <p>Auto-loading can be enabled or disabled,
  77. and the list of auto-loaded scripts can be printed.
  78. </p>
  79. <dl compact="compact">
  80. <dd><a name="set-auto_002dload-python_002dscripts"></a><a name="index-set-auto_002dload-python_002dscripts"></a>
  81. </dd>
  82. <dt><code>set auto-load python-scripts [on|off]</code></dt>
  83. <dd><p>Enable or disable the auto-loading of Python scripts.
  84. </p>
  85. <a name="show-auto_002dload-python_002dscripts"></a><a name="index-show-auto_002dload-python_002dscripts"></a>
  86. </dd>
  87. <dt><code>show auto-load python-scripts</code></dt>
  88. <dd><p>Show whether auto-loading of Python scripts is enabled or disabled.
  89. </p>
  90. <a name="info-auto_002dload-python_002dscripts"></a><a name="index-info-auto_002dload-python_002dscripts"></a>
  91. <a name="index-print-list-of-auto_002dloaded-Python-scripts"></a>
  92. </dd>
  93. <dt><code>info auto-load python-scripts [<var>regexp</var>]</code></dt>
  94. <dd><p>Print the list of all Python scripts that <small>GDB</small> auto-loaded.
  95. </p>
  96. <p>Also printed is the list of Python scripts that were mentioned in
  97. the <code>.debug_gdb_scripts</code> section and were either not found
  98. (see <a href="dotdebug_005fgdb_005fscripts-section.html#dotdebug_005fgdb_005fscripts-section">dotdebug_gdb_scripts section</a>) or were not auto-loaded due to
  99. <code>auto-load safe-path</code> rejection (see <a href="Auto_002dloading.html#Auto_002dloading">Auto-loading</a>).
  100. This is useful because their names are not printed when <small>GDB</small>
  101. tries to load them and fails. There may be many of them, and printing
  102. an error message for each one is problematic.
  103. </p>
  104. <p>If <var>regexp</var> is supplied only Python scripts with matching names are printed.
  105. </p>
  106. <p>Example:
  107. </p>
  108. <div class="smallexample">
  109. <pre class="smallexample">(gdb) info auto-load python-scripts
  110. Loaded Script
  111. Yes py-section-script.py
  112. full name: /tmp/py-section-script.py
  113. No my-foo-pretty-printers.py
  114. </pre></div>
  115. </dd>
  116. </dl>
  117. <p>When reading an auto-loaded file or script, <small>GDB</small> sets the
  118. <em>current objfile</em>. This is available via the <code>gdb.current_objfile</code>
  119. function (see <a href="Objfiles-In-Python.html#Objfiles-In-Python">Objfiles In Python</a>). This can be useful for
  120. registering objfile-specific pretty-printers and frame-filters.
  121. </p>
  122. <hr>
  123. <div class="header">
  124. <p>
  125. Next: <a href="Python-modules.html#Python-modules" accesskey="n" rel="next">Python modules</a>, Previous: <a href="Python-API.html#Python-API" accesskey="p" rel="previous">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>
  126. </div>
  127. </body>
  128. </html>