utilities.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326
  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="Utilities" />
  7. <meta property="og:type" content="website" />
  8. <meta property="og:url" content="https://docs.python.org/3/c-api/utilities.html" />
  9. <meta property="og:site_name" content="Python documentation" />
  10. <meta property="og:description" content="The functions in this chapter perform various utility tasks, ranging from helping C code be more portable across platforms, using Python modules from C, and parsing function arguments and construct..." />
  11. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />
  12. <meta property="og:image:alt" content="Python documentation" />
  13. <meta name="description" content="The functions in this chapter perform various utility tasks, ranging from helping C code be more portable across platforms, using Python modules from C, and parsing function arguments and construct..." />
  14. <meta property="og:image:width" content="200" />
  15. <meta property="og:image:height" content="200" />
  16. <meta name="theme-color" content="#3776ab" />
  17. <title>Utilities &#8212; Python 3.12.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
  18. <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
  19. <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?digest=b37c26da2f7529d09fe70b41c4b2133fe4931a90" />
  20. <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css" />
  21. <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
  22. <script src="../_static/jquery.js"></script>
  23. <script src="../_static/underscore.js"></script>
  24. <script src="../_static/doctools.js"></script>
  25. <script src="../_static/sidebar.js"></script>
  26. <link rel="search" type="application/opensearchdescription+xml"
  27. title="Search within Python 3.12.0 documentation"
  28. href="../_static/opensearch.xml"/>
  29. <link rel="author" title="About these documents" href="../about.html" />
  30. <link rel="index" title="Index" href="../genindex.html" />
  31. <link rel="search" title="Search" href="../search.html" />
  32. <link rel="copyright" title="Copyright" href="../copyright.html" />
  33. <link rel="next" title="Operating System Utilities" href="sys.html" />
  34. <link rel="prev" title="Exception Handling" href="exceptions.html" />
  35. <link rel="canonical" href="https://docs.python.org/3/c-api/utilities.html" />
  36. <style>
  37. @media only screen {
  38. table.full-width-table {
  39. width: 100%;
  40. }
  41. }
  42. </style>
  43. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
  44. <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />
  45. <script type="text/javascript" src="../_static/copybutton.js"></script>
  46. <script type="text/javascript" src="../_static/menu.js"></script>
  47. <script type="text/javascript" src="../_static/themetoggle.js"></script>
  48. </head>
  49. <body>
  50. <div class="mobile-nav">
  51. <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
  52. aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
  53. <nav class="nav-content" role="navigation">
  54. <label for="menuToggler" class="toggler__label">
  55. <span></span>
  56. </label>
  57. <span class="nav-items-wrapper">
  58. <a href="https://www.python.org/" class="nav-logo">
  59. <img src="../_static/py.svg" alt="Logo"/>
  60. </a>
  61. <span class="version_switcher_placeholder"></span>
  62. <form role="search" class="search" action="../search.html" method="get">
  63. <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
  64. <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>
  65. </svg>
  66. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
  67. <input type="submit" value="Go"/>
  68. </form>
  69. </span>
  70. </nav>
  71. <div class="menu-wrapper">
  72. <nav class="menu" role="navigation" aria-label="main navigation">
  73. <div class="language_switcher_placeholder"></div>
  74. <label class="theme-selector-label">
  75. Theme
  76. <select class="theme-selector" oninput="activateTheme(this.value)">
  77. <option value="auto" selected>Auto</option>
  78. <option value="light">Light</option>
  79. <option value="dark">Dark</option>
  80. </select>
  81. </label>
  82. <div>
  83. <h4>Previous topic</h4>
  84. <p class="topless"><a href="exceptions.html"
  85. title="previous chapter">Exception Handling</a></p>
  86. </div>
  87. <div>
  88. <h4>Next topic</h4>
  89. <p class="topless"><a href="sys.html"
  90. title="next chapter">Operating System Utilities</a></p>
  91. </div>
  92. <div role="note" aria-label="source link">
  93. <h3>This Page</h3>
  94. <ul class="this-page-menu">
  95. <li><a href="../bugs.html">Report a Bug</a></li>
  96. <li>
  97. <a href="https://github.com/python/cpython/blob/main/Doc/c-api/utilities.rst"
  98. rel="nofollow">Show Source
  99. </a>
  100. </li>
  101. </ul>
  102. </div>
  103. </nav>
  104. </div>
  105. </div>
  106. <div class="related" role="navigation" aria-label="related navigation">
  107. <h3>Navigation</h3>
  108. <ul>
  109. <li class="right" style="margin-right: 10px">
  110. <a href="../genindex.html" title="General Index"
  111. accesskey="I">index</a></li>
  112. <li class="right" >
  113. <a href="../py-modindex.html" title="Python Module Index"
  114. >modules</a> |</li>
  115. <li class="right" >
  116. <a href="sys.html" title="Operating System Utilities"
  117. accesskey="N">next</a> |</li>
  118. <li class="right" >
  119. <a href="exceptions.html" title="Exception Handling"
  120. accesskey="P">previous</a> |</li>
  121. <li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
  122. <li><a href="https://www.python.org/">Python</a> &#187;</li>
  123. <li class="switchers">
  124. <div class="language_switcher_placeholder"></div>
  125. <div class="version_switcher_placeholder"></div>
  126. </li>
  127. <li>
  128. </li>
  129. <li id="cpython-language-and-version">
  130. <a href="../index.html">3.12.0 Documentation</a> &#187;
  131. </li>
  132. <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Python/C API Reference Manual</a> &#187;</li>
  133. <li class="nav-item nav-item-this"><a href="">Utilities</a></li>
  134. <li class="right">
  135. <div class="inline-search" role="search">
  136. <form class="inline-search" action="../search.html" method="get">
  137. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
  138. <input type="submit" value="Go" />
  139. </form>
  140. </div>
  141. |
  142. </li>
  143. <li class="right">
  144. <label class="theme-selector-label">
  145. Theme
  146. <select class="theme-selector" oninput="activateTheme(this.value)">
  147. <option value="auto" selected>Auto</option>
  148. <option value="light">Light</option>
  149. <option value="dark">Dark</option>
  150. </select>
  151. </label> |</li>
  152. </ul>
  153. </div>
  154. <div class="document">
  155. <div class="documentwrapper">
  156. <div class="bodywrapper">
  157. <div class="body" role="main">
  158. <section id="utilities">
  159. <span id="id1"></span><h1>Utilities<a class="headerlink" href="#utilities" title="Permalink to this headline">¶</a></h1>
  160. <p>The functions in this chapter perform various utility tasks, ranging from
  161. helping C code be more portable across platforms, using Python modules from C,
  162. and parsing function arguments and constructing Python values from C values.</p>
  163. <div class="toctree-wrapper compound">
  164. <ul>
  165. <li class="toctree-l1"><a class="reference internal" href="sys.html">Operating System Utilities</a></li>
  166. <li class="toctree-l1"><a class="reference internal" href="sys.html#system-functions">System Functions</a></li>
  167. <li class="toctree-l1"><a class="reference internal" href="sys.html#process-control">Process Control</a></li>
  168. <li class="toctree-l1"><a class="reference internal" href="import.html">Importing Modules</a></li>
  169. <li class="toctree-l1"><a class="reference internal" href="marshal.html">Data marshalling support</a></li>
  170. <li class="toctree-l1"><a class="reference internal" href="arg.html">Parsing arguments and building values</a><ul>
  171. <li class="toctree-l2"><a class="reference internal" href="arg.html#parsing-arguments">Parsing arguments</a><ul>
  172. <li class="toctree-l3"><a class="reference internal" href="arg.html#strings-and-buffers">Strings and buffers</a></li>
  173. <li class="toctree-l3"><a class="reference internal" href="arg.html#numbers">Numbers</a></li>
  174. <li class="toctree-l3"><a class="reference internal" href="arg.html#other-objects">Other objects</a></li>
  175. <li class="toctree-l3"><a class="reference internal" href="arg.html#api-functions">API Functions</a></li>
  176. </ul>
  177. </li>
  178. <li class="toctree-l2"><a class="reference internal" href="arg.html#building-values">Building values</a></li>
  179. </ul>
  180. </li>
  181. <li class="toctree-l1"><a class="reference internal" href="conversion.html">String conversion and formatting</a></li>
  182. <li class="toctree-l1"><a class="reference internal" href="reflection.html">Reflection</a></li>
  183. <li class="toctree-l1"><a class="reference internal" href="codec.html">Codec registry and support functions</a><ul>
  184. <li class="toctree-l2"><a class="reference internal" href="codec.html#codec-lookup-api">Codec lookup API</a></li>
  185. <li class="toctree-l2"><a class="reference internal" href="codec.html#registry-api-for-unicode-encoding-error-handlers">Registry API for Unicode encoding error handlers</a></li>
  186. </ul>
  187. </li>
  188. <li class="toctree-l1"><a class="reference internal" href="perfmaps.html">Support for Perf Maps</a></li>
  189. </ul>
  190. </div>
  191. </section>
  192. <div class="clearer"></div>
  193. </div>
  194. </div>
  195. </div>
  196. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  197. <div class="sphinxsidebarwrapper">
  198. <div>
  199. <h4>Previous topic</h4>
  200. <p class="topless"><a href="exceptions.html"
  201. title="previous chapter">Exception Handling</a></p>
  202. </div>
  203. <div>
  204. <h4>Next topic</h4>
  205. <p class="topless"><a href="sys.html"
  206. title="next chapter">Operating System Utilities</a></p>
  207. </div>
  208. <div role="note" aria-label="source link">
  209. <h3>This Page</h3>
  210. <ul class="this-page-menu">
  211. <li><a href="../bugs.html">Report a Bug</a></li>
  212. <li>
  213. <a href="https://github.com/python/cpython/blob/main/Doc/c-api/utilities.rst"
  214. rel="nofollow">Show Source
  215. </a>
  216. </li>
  217. </ul>
  218. </div>
  219. </div>
  220. </div>
  221. <div class="clearer"></div>
  222. </div>
  223. <div class="related" role="navigation" aria-label="related navigation">
  224. <h3>Navigation</h3>
  225. <ul>
  226. <li class="right" style="margin-right: 10px">
  227. <a href="../genindex.html" title="General Index"
  228. >index</a></li>
  229. <li class="right" >
  230. <a href="../py-modindex.html" title="Python Module Index"
  231. >modules</a> |</li>
  232. <li class="right" >
  233. <a href="sys.html" title="Operating System Utilities"
  234. >next</a> |</li>
  235. <li class="right" >
  236. <a href="exceptions.html" title="Exception Handling"
  237. >previous</a> |</li>
  238. <li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
  239. <li><a href="https://www.python.org/">Python</a> &#187;</li>
  240. <li class="switchers">
  241. <div class="language_switcher_placeholder"></div>
  242. <div class="version_switcher_placeholder"></div>
  243. </li>
  244. <li>
  245. </li>
  246. <li id="cpython-language-and-version">
  247. <a href="../index.html">3.12.0 Documentation</a> &#187;
  248. </li>
  249. <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
  250. <li class="nav-item nav-item-this"><a href="">Utilities</a></li>
  251. <li class="right">
  252. <div class="inline-search" role="search">
  253. <form class="inline-search" action="../search.html" method="get">
  254. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
  255. <input type="submit" value="Go" />
  256. </form>
  257. </div>
  258. |
  259. </li>
  260. <li class="right">
  261. <label class="theme-selector-label">
  262. Theme
  263. <select class="theme-selector" oninput="activateTheme(this.value)">
  264. <option value="auto" selected>Auto</option>
  265. <option value="light">Light</option>
  266. <option value="dark">Dark</option>
  267. </select>
  268. </label> |</li>
  269. </ul>
  270. </div>
  271. <div class="footer">
  272. &copy; <a href="../copyright.html">Copyright</a> 2001-2023, Python Software Foundation.
  273. <br />
  274. This page is licensed under the Python Software Foundation License Version 2.
  275. <br />
  276. Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
  277. <br />
  278. See <a href="/license.html">History and License</a> for more information.<br />
  279. <br />
  280. The Python Software Foundation is a non-profit corporation.
  281. <a href="https://www.python.org/psf/donations/">Please donate.</a>
  282. <br />
  283. <br />
  284. Last updated on Oct 02, 2023.
  285. <a href="/bugs.html">Found a bug</a>?
  286. <br />
  287. Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.5.0.
  288. </div>
  289. </body>
  290. </html>