You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Python-Auto_002dloading.html 6.5KB

3 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  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 6.5, http://www.gnu.org/software/texinfo/ -->
  14. <head>
  15. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  16. <title>Python Auto-loading (Debugging with GDB)</title>
  17. <meta name="description" content="Python Auto-loading (Debugging with GDB)">
  18. <meta name="keywords" content="Python Auto-loading (Debugging with GDB)">
  19. <meta name="resource-type" content="document">
  20. <meta name="distribution" content="global">
  21. <meta name="Generator" content="makeinfo">
  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="prev" title="TUI Windows In Python">
  28. <style type="text/css">
  29. <!--
  30. a.summary-letter {text-decoration: none}
  31. blockquote.indentedblock {margin-right: 0em}
  32. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
  33. blockquote.smallquotation {font-size: smaller}
  34. div.display {margin-left: 3.2em}
  35. div.example {margin-left: 3.2em}
  36. div.lisp {margin-left: 3.2em}
  37. div.smalldisplay {margin-left: 3.2em}
  38. div.smallexample {margin-left: 3.2em}
  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.nolinebreak {white-space: nowrap}
  50. span.roman {font-family: initial; font-weight: normal}
  51. span.sansserif {font-family: sans-serif; font-weight: normal}
  52. ul.no-bullet {list-style: none}
  53. -->
  54. </style>
  55. </head>
  56. <body lang="en">
  57. <a name="Python-Auto_002dloading"></a>
  58. <div class="header">
  59. <p>
  60. 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="prev">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>
  61. </div>
  62. <hr>
  63. <a name="Python-Auto_002dloading-1"></a>
  64. <h4 class="subsection">23.2.3 Python Auto-loading</h4>
  65. <a name="index-Python-auto_002dloading"></a>
  66. <p>When a new object file is read (for example, due to the <code>file</code>
  67. command, or because the inferior has loaded a shared library),
  68. <small>GDB</small> will look for Python support scripts in several ways:
  69. <samp><var>objfile</var>-gdb.py</samp> and <code>.debug_gdb_scripts</code> section.
  70. See <a href="Auto_002dloading-extensions.html#Auto_002dloading-extensions">Auto-loading extensions</a>.
  71. </p>
  72. <p>The auto-loading feature is useful for supplying application-specific
  73. debugging commands and scripts.
  74. </p>
  75. <p>Auto-loading can be enabled or disabled,
  76. and the list of auto-loaded scripts can be printed.
  77. </p>
  78. <dl compact="compact">
  79. <dd><a name="set-auto_002dload-python_002dscripts"></a><a name="index-set-auto_002dload-python_002dscripts"></a>
  80. </dd>
  81. <dt><code>set auto-load python-scripts [on|off]</code></dt>
  82. <dd><p>Enable or disable the auto-loading of Python scripts.
  83. </p>
  84. <a name="show-auto_002dload-python_002dscripts"></a><a name="index-show-auto_002dload-python_002dscripts"></a>
  85. </dd>
  86. <dt><code>show auto-load python-scripts</code></dt>
  87. <dd><p>Show whether auto-loading of Python scripts is enabled or disabled.
  88. </p>
  89. <a name="info-auto_002dload-python_002dscripts"></a><a name="index-info-auto_002dload-python_002dscripts"></a>
  90. <a name="index-print-list-of-auto_002dloaded-Python-scripts"></a>
  91. </dd>
  92. <dt><code>info auto-load python-scripts [<var>regexp</var>]</code></dt>
  93. <dd><p>Print the list of all Python scripts that <small>GDB</small> auto-loaded.
  94. </p>
  95. <p>Also printed is the list of Python scripts that were mentioned in
  96. the <code>.debug_gdb_scripts</code> section and were either not found
  97. (see <a href="dotdebug_005fgdb_005fscripts-section.html#dotdebug_005fgdb_005fscripts-section">dotdebug_gdb_scripts section</a>) or were not auto-loaded due to
  98. <code>auto-load safe-path</code> rejection (see <a href="Auto_002dloading.html#Auto_002dloading">Auto-loading</a>).
  99. This is useful because their names are not printed when <small>GDB</small>
  100. tries to load them and fails. There may be many of them, and printing
  101. an error message for each one is problematic.
  102. </p>
  103. <p>If <var>regexp</var> is supplied only Python scripts with matching names are printed.
  104. </p>
  105. <p>Example:
  106. </p>
  107. <div class="smallexample">
  108. <pre class="smallexample">(gdb) info auto-load python-scripts
  109. Loaded Script
  110. Yes py-section-script.py
  111. full name: /tmp/py-section-script.py
  112. No my-foo-pretty-printers.py
  113. </pre></div>
  114. </dd>
  115. </dl>
  116. <p>When reading an auto-loaded file or script, <small>GDB</small> sets the
  117. <em>current objfile</em>. This is available via the <code>gdb.current_objfile</code>
  118. function (see <a href="Objfiles-In-Python.html#Objfiles-In-Python">Objfiles In Python</a>). This can be useful for
  119. registering objfile-specific pretty-printers and frame-filters.
  120. </p>
  121. <hr>
  122. <div class="header">
  123. <p>
  124. 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="prev">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>
  125. </div>
  126. </body>
  127. </html>