reflection.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
  6. <meta property="og:title" content="Reflection" />
  7. <meta property="og:type" content="website" />
  8. <meta property="og:url" content="https://docs.python.org/3/c-api/reflection.html" />
  9. <meta property="og:site_name" content="Python documentation" />
  10. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />
  11. <meta property="og:image:alt" content="Python documentation" />
  12. <meta property="og:image:width" content="200" />
  13. <meta property="og:image:height" content="200" />
  14. <meta name="theme-color" content="#3776ab" />
  15. <title>Reflection &#8212; Python 3.12.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
  16. <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
  17. <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?digest=b37c26da2f7529d09fe70b41c4b2133fe4931a90" />
  18. <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css" />
  19. <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
  20. <script src="../_static/jquery.js"></script>
  21. <script src="../_static/underscore.js"></script>
  22. <script src="../_static/doctools.js"></script>
  23. <script src="../_static/sidebar.js"></script>
  24. <link rel="search" type="application/opensearchdescription+xml"
  25. title="Search within Python 3.12.0 documentation"
  26. href="../_static/opensearch.xml"/>
  27. <link rel="author" title="About these documents" href="../about.html" />
  28. <link rel="index" title="Index" href="../genindex.html" />
  29. <link rel="search" title="Search" href="../search.html" />
  30. <link rel="copyright" title="Copyright" href="../copyright.html" />
  31. <link rel="next" title="Codec registry and support functions" href="codec.html" />
  32. <link rel="prev" title="String conversion and formatting" href="conversion.html" />
  33. <link rel="canonical" href="https://docs.python.org/3/c-api/reflection.html" />
  34. <style>
  35. @media only screen {
  36. table.full-width-table {
  37. width: 100%;
  38. }
  39. }
  40. </style>
  41. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
  42. <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />
  43. <script type="text/javascript" src="../_static/copybutton.js"></script>
  44. <script type="text/javascript" src="../_static/menu.js"></script>
  45. <script type="text/javascript" src="../_static/themetoggle.js"></script>
  46. </head>
  47. <body>
  48. <div class="mobile-nav">
  49. <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
  50. aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
  51. <nav class="nav-content" role="navigation">
  52. <label for="menuToggler" class="toggler__label">
  53. <span></span>
  54. </label>
  55. <span class="nav-items-wrapper">
  56. <a href="https://www.python.org/" class="nav-logo">
  57. <img src="../_static/py.svg" alt="Logo"/>
  58. </a>
  59. <span class="version_switcher_placeholder"></span>
  60. <form role="search" class="search" action="../search.html" method="get">
  61. <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
  62. <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>
  63. </svg>
  64. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
  65. <input type="submit" value="Go"/>
  66. </form>
  67. </span>
  68. </nav>
  69. <div class="menu-wrapper">
  70. <nav class="menu" role="navigation" aria-label="main navigation">
  71. <div class="language_switcher_placeholder"></div>
  72. <label class="theme-selector-label">
  73. Theme
  74. <select class="theme-selector" oninput="activateTheme(this.value)">
  75. <option value="auto" selected>Auto</option>
  76. <option value="light">Light</option>
  77. <option value="dark">Dark</option>
  78. </select>
  79. </label>
  80. <div>
  81. <h4>Previous topic</h4>
  82. <p class="topless"><a href="conversion.html"
  83. title="previous chapter">String conversion and formatting</a></p>
  84. </div>
  85. <div>
  86. <h4>Next topic</h4>
  87. <p class="topless"><a href="codec.html"
  88. title="next chapter">Codec registry and support functions</a></p>
  89. </div>
  90. <div role="note" aria-label="source link">
  91. <h3>This Page</h3>
  92. <ul class="this-page-menu">
  93. <li><a href="../bugs.html">Report a Bug</a></li>
  94. <li>
  95. <a href="https://github.com/python/cpython/blob/main/Doc/c-api/reflection.rst"
  96. rel="nofollow">Show Source
  97. </a>
  98. </li>
  99. </ul>
  100. </div>
  101. </nav>
  102. </div>
  103. </div>
  104. <div class="related" role="navigation" aria-label="related navigation">
  105. <h3>Navigation</h3>
  106. <ul>
  107. <li class="right" style="margin-right: 10px">
  108. <a href="../genindex.html" title="General Index"
  109. accesskey="I">index</a></li>
  110. <li class="right" >
  111. <a href="../py-modindex.html" title="Python Module Index"
  112. >modules</a> |</li>
  113. <li class="right" >
  114. <a href="codec.html" title="Codec registry and support functions"
  115. accesskey="N">next</a> |</li>
  116. <li class="right" >
  117. <a href="conversion.html" title="String conversion and formatting"
  118. accesskey="P">previous</a> |</li>
  119. <li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
  120. <li><a href="https://www.python.org/">Python</a> &#187;</li>
  121. <li class="switchers">
  122. <div class="language_switcher_placeholder"></div>
  123. <div class="version_switcher_placeholder"></div>
  124. </li>
  125. <li>
  126. </li>
  127. <li id="cpython-language-and-version">
  128. <a href="../index.html">3.12.0 Documentation</a> &#187;
  129. </li>
  130. <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
  131. <li class="nav-item nav-item-2"><a href="utilities.html" accesskey="U">Utilities</a> &#187;</li>
  132. <li class="nav-item nav-item-this"><a href="">Reflection</a></li>
  133. <li class="right">
  134. <div class="inline-search" role="search">
  135. <form class="inline-search" action="../search.html" method="get">
  136. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
  137. <input type="submit" value="Go" />
  138. </form>
  139. </div>
  140. |
  141. </li>
  142. <li class="right">
  143. <label class="theme-selector-label">
  144. Theme
  145. <select class="theme-selector" oninput="activateTheme(this.value)">
  146. <option value="auto" selected>Auto</option>
  147. <option value="light">Light</option>
  148. <option value="dark">Dark</option>
  149. </select>
  150. </label> |</li>
  151. </ul>
  152. </div>
  153. <div class="document">
  154. <div class="documentwrapper">
  155. <div class="bodywrapper">
  156. <div class="body" role="main">
  157. <section id="reflection">
  158. <span id="id1"></span><h1>Reflection<a class="headerlink" href="#reflection" title="Permalink to this headline">¶</a></h1>
  159. <dl class="c function">
  160. <dt class="sig sig-object c" id="c.PyEval_GetBuiltins">
  161. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyEval_GetBuiltins</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyEval_GetBuiltins" title="Permalink to this definition">¶</a><br /></dt>
  162. <dd><em class="refcount">Return value: Borrowed reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Return a dictionary of the builtins in the current execution frame,
  163. or the interpreter of the thread state if no frame is currently executing.</p>
  164. </dd></dl>
  165. <dl class="c function">
  166. <dt class="sig sig-object c" id="c.PyEval_GetLocals">
  167. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyEval_GetLocals</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyEval_GetLocals" title="Permalink to this definition">¶</a><br /></dt>
  168. <dd><em class="refcount">Return value: Borrowed reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Return a dictionary of the local variables in the current execution frame,
  169. or <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if no frame is currently executing.</p>
  170. </dd></dl>
  171. <dl class="c function">
  172. <dt class="sig sig-object c" id="c.PyEval_GetGlobals">
  173. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyEval_GetGlobals</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyEval_GetGlobals" title="Permalink to this definition">¶</a><br /></dt>
  174. <dd><em class="refcount">Return value: Borrowed reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Return a dictionary of the global variables in the current execution frame,
  175. or <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if no frame is currently executing.</p>
  176. </dd></dl>
  177. <dl class="c function">
  178. <dt class="sig sig-object c" id="c.PyEval_GetFrame">
  179. <a class="reference internal" href="frame.html#c.PyFrameObject" title="PyFrameObject"><span class="n"><span class="pre">PyFrameObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyEval_GetFrame</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyEval_GetFrame" title="Permalink to this definition">¶</a><br /></dt>
  180. <dd><em class="refcount">Return value: Borrowed reference.</em><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Return the current thread state’s frame, which is <code class="docutils literal notranslate"><span class="pre">NULL</span></code> if no frame is
  181. currently executing.</p>
  182. <p>See also <a class="reference internal" href="init.html#c.PyThreadState_GetFrame" title="PyThreadState_GetFrame"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyThreadState_GetFrame()</span></code></a>.</p>
  183. </dd></dl>
  184. <dl class="c function">
  185. <dt class="sig sig-object c" id="c.PyEval_GetFuncName">
  186. <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyEval_GetFuncName</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">func</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyEval_GetFuncName" title="Permalink to this definition">¶</a><br /></dt>
  187. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Return the name of <em>func</em> if it is a function, class or instance object, else the
  188. name of <em>func</em>s type.</p>
  189. </dd></dl>
  190. <dl class="c function">
  191. <dt class="sig sig-object c" id="c.PyEval_GetFuncDesc">
  192. <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyEval_GetFuncDesc</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">func</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyEval_GetFuncDesc" title="Permalink to this definition">¶</a><br /></dt>
  193. <dd><em class="stableabi"> Part of the <a class="reference internal" href="stable.html#stable"><span class="std std-ref">Stable ABI</span></a>.</em><p>Return a description string, depending on the type of <em>func</em>.
  194. Return values include “()” for functions and methods, ” constructor”,
  195. ” instance”, and ” object”. Concatenated with the result of
  196. <a class="reference internal" href="#c.PyEval_GetFuncName" title="PyEval_GetFuncName"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyEval_GetFuncName()</span></code></a>, the result will be a description of
  197. <em>func</em>.</p>
  198. </dd></dl>
  199. </section>
  200. <div class="clearer"></div>
  201. </div>
  202. </div>
  203. </div>
  204. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  205. <div class="sphinxsidebarwrapper">
  206. <div>
  207. <h4>Previous topic</h4>
  208. <p class="topless"><a href="conversion.html"
  209. title="previous chapter">String conversion and formatting</a></p>
  210. </div>
  211. <div>
  212. <h4>Next topic</h4>
  213. <p class="topless"><a href="codec.html"
  214. title="next chapter">Codec registry and support functions</a></p>
  215. </div>
  216. <div role="note" aria-label="source link">
  217. <h3>This Page</h3>
  218. <ul class="this-page-menu">
  219. <li><a href="../bugs.html">Report a Bug</a></li>
  220. <li>
  221. <a href="https://github.com/python/cpython/blob/main/Doc/c-api/reflection.rst"
  222. rel="nofollow">Show Source
  223. </a>
  224. </li>
  225. </ul>
  226. </div>
  227. </div>
  228. </div>
  229. <div class="clearer"></div>
  230. </div>
  231. <div class="related" role="navigation" aria-label="related navigation">
  232. <h3>Navigation</h3>
  233. <ul>
  234. <li class="right" style="margin-right: 10px">
  235. <a href="../genindex.html" title="General Index"
  236. >index</a></li>
  237. <li class="right" >
  238. <a href="../py-modindex.html" title="Python Module Index"
  239. >modules</a> |</li>
  240. <li class="right" >
  241. <a href="codec.html" title="Codec registry and support functions"
  242. >next</a> |</li>
  243. <li class="right" >
  244. <a href="conversion.html" title="String conversion and formatting"
  245. >previous</a> |</li>
  246. <li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
  247. <li><a href="https://www.python.org/">Python</a> &#187;</li>
  248. <li class="switchers">
  249. <div class="language_switcher_placeholder"></div>
  250. <div class="version_switcher_placeholder"></div>
  251. </li>
  252. <li>
  253. </li>
  254. <li id="cpython-language-and-version">
  255. <a href="../index.html">3.12.0 Documentation</a> &#187;
  256. </li>
  257. <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
  258. <li class="nav-item nav-item-2"><a href="utilities.html" >Utilities</a> &#187;</li>
  259. <li class="nav-item nav-item-this"><a href="">Reflection</a></li>
  260. <li class="right">
  261. <div class="inline-search" role="search">
  262. <form class="inline-search" action="../search.html" method="get">
  263. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
  264. <input type="submit" value="Go" />
  265. </form>
  266. </div>
  267. |
  268. </li>
  269. <li class="right">
  270. <label class="theme-selector-label">
  271. Theme
  272. <select class="theme-selector" oninput="activateTheme(this.value)">
  273. <option value="auto" selected>Auto</option>
  274. <option value="light">Light</option>
  275. <option value="dark">Dark</option>
  276. </select>
  277. </label> |</li>
  278. </ul>
  279. </div>
  280. <div class="footer">
  281. &copy; <a href="../copyright.html">Copyright</a> 2001-2023, Python Software Foundation.
  282. <br />
  283. This page is licensed under the Python Software Foundation License Version 2.
  284. <br />
  285. Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
  286. <br />
  287. See <a href="/license.html">History and License</a> for more information.<br />
  288. <br />
  289. The Python Software Foundation is a non-profit corporation.
  290. <a href="https://www.python.org/psf/donations/">Please donate.</a>
  291. <br />
  292. <br />
  293. Last updated on Oct 02, 2023.
  294. <a href="/bugs.html">Found a bug</a>?
  295. <br />
  296. Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.5.0.
  297. </div>
  298. </body>
  299. </html>