index.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  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="Python HOWTOs" />
  7. <meta property="og:type" content="website" />
  8. <meta property="og:url" content="https://docs.python.org/3/howto/index.html" />
  9. <meta property="og:site_name" content="Python documentation" />
  10. <meta property="og:description" content="Python HOWTOs are documents that cover a single, specific topic, and attempt to cover it fairly completely. Modelled on the Linux Documentation Project’s HOWTO collection, this collection is an eff..." />
  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="Python HOWTOs are documents that cover a single, specific topic, and attempt to cover it fairly completely. Modelled on the Linux Documentation Project’s HOWTO collection, this collection is an eff..." />
  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>Python HOWTOs &#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="How to port Python 2 Code to Python 3" href="pyporting.html" />
  34. <link rel="prev" title="Installing Python Modules" href="../installing/index.html" />
  35. <link rel="canonical" href="https://docs.python.org/3/howto/index.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="../installing/index.html"
  85. title="previous chapter">Installing Python Modules</a></p>
  86. </div>
  87. <div>
  88. <h4>Next topic</h4>
  89. <p class="topless"><a href="pyporting.html"
  90. title="next chapter">How to port Python 2 Code to Python 3</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/howto/index.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="pyporting.html" title="How to port Python 2 Code to Python 3"
  117. accesskey="N">next</a> |</li>
  118. <li class="right" >
  119. <a href="../installing/index.html" title="Installing Python Modules"
  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-this"><a href="">Python HOWTOs</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="python-howtos">
  158. <h1>Python HOWTOs<a class="headerlink" href="#python-howtos" title="Permalink to this headline">¶</a></h1>
  159. <p>Python HOWTOs are documents that cover a single, specific topic,
  160. and attempt to cover it fairly completely. Modelled on the Linux
  161. Documentation Project’s HOWTO collection, this collection is an
  162. effort to foster documentation that’s more detailed than the
  163. Python Library Reference.</p>
  164. <p>Currently, the HOWTOs are:</p>
  165. <div class="toctree-wrapper compound">
  166. <ul>
  167. <li class="toctree-l1"><a class="reference internal" href="pyporting.html">How to port Python 2 Code to Python 3</a></li>
  168. <li class="toctree-l1"><a class="reference internal" href="cporting.html">Porting Extension Modules to Python 3</a></li>
  169. <li class="toctree-l1"><a class="reference internal" href="curses.html">Curses Programming with Python</a></li>
  170. <li class="toctree-l1"><a class="reference internal" href="descriptor.html">Descriptor HowTo Guide</a></li>
  171. <li class="toctree-l1"><a class="reference internal" href="enum.html">Enum HOWTO</a></li>
  172. <li class="toctree-l1"><a class="reference internal" href="functional.html">Functional Programming HOWTO</a></li>
  173. <li class="toctree-l1"><a class="reference internal" href="logging.html">Logging HOWTO</a></li>
  174. <li class="toctree-l1"><a class="reference internal" href="logging-cookbook.html">Logging Cookbook</a></li>
  175. <li class="toctree-l1"><a class="reference internal" href="regex.html">Regular Expression HOWTO</a></li>
  176. <li class="toctree-l1"><a class="reference internal" href="sockets.html">Socket Programming HOWTO</a></li>
  177. <li class="toctree-l1"><a class="reference internal" href="sorting.html">Sorting HOW TO</a></li>
  178. <li class="toctree-l1"><a class="reference internal" href="unicode.html">Unicode HOWTO</a></li>
  179. <li class="toctree-l1"><a class="reference internal" href="urllib2.html">HOWTO Fetch Internet Resources Using The urllib Package</a></li>
  180. <li class="toctree-l1"><a class="reference internal" href="argparse.html">Argparse Tutorial</a></li>
  181. <li class="toctree-l1"><a class="reference internal" href="ipaddress.html">An introduction to the ipaddress module</a></li>
  182. <li class="toctree-l1"><a class="reference internal" href="clinic.html">Argument Clinic How-To</a></li>
  183. <li class="toctree-l1"><a class="reference internal" href="instrumentation.html">Instrumenting CPython with DTrace and SystemTap</a></li>
  184. <li class="toctree-l1"><a class="reference internal" href="perf_profiling.html">Python support for the Linux <code class="docutils literal notranslate"><span class="pre">perf</span></code> profiler</a></li>
  185. <li class="toctree-l1"><a class="reference internal" href="annotations.html">Annotations Best Practices</a></li>
  186. <li class="toctree-l1"><a class="reference internal" href="isolating-extensions.html">Isolating Extension Modules</a></li>
  187. </ul>
  188. </div>
  189. </section>
  190. <div class="clearer"></div>
  191. </div>
  192. </div>
  193. </div>
  194. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  195. <div class="sphinxsidebarwrapper">
  196. <div>
  197. <h4>Previous topic</h4>
  198. <p class="topless"><a href="../installing/index.html"
  199. title="previous chapter">Installing Python Modules</a></p>
  200. </div>
  201. <div>
  202. <h4>Next topic</h4>
  203. <p class="topless"><a href="pyporting.html"
  204. title="next chapter">How to port Python 2 Code to Python 3</a></p>
  205. </div>
  206. <div role="note" aria-label="source link">
  207. <h3>This Page</h3>
  208. <ul class="this-page-menu">
  209. <li><a href="../bugs.html">Report a Bug</a></li>
  210. <li>
  211. <a href="https://github.com/python/cpython/blob/main/Doc/howto/index.rst"
  212. rel="nofollow">Show Source
  213. </a>
  214. </li>
  215. </ul>
  216. </div>
  217. </div>
  218. </div>
  219. <div class="clearer"></div>
  220. </div>
  221. <div class="related" role="navigation" aria-label="related navigation">
  222. <h3>Navigation</h3>
  223. <ul>
  224. <li class="right" style="margin-right: 10px">
  225. <a href="../genindex.html" title="General Index"
  226. >index</a></li>
  227. <li class="right" >
  228. <a href="../py-modindex.html" title="Python Module Index"
  229. >modules</a> |</li>
  230. <li class="right" >
  231. <a href="pyporting.html" title="How to port Python 2 Code to Python 3"
  232. >next</a> |</li>
  233. <li class="right" >
  234. <a href="../installing/index.html" title="Installing Python Modules"
  235. >previous</a> |</li>
  236. <li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
  237. <li><a href="https://www.python.org/">Python</a> &#187;</li>
  238. <li class="switchers">
  239. <div class="language_switcher_placeholder"></div>
  240. <div class="version_switcher_placeholder"></div>
  241. </li>
  242. <li>
  243. </li>
  244. <li id="cpython-language-and-version">
  245. <a href="../index.html">3.12.0 Documentation</a> &#187;
  246. </li>
  247. <li class="nav-item nav-item-this"><a href="">Python HOWTOs</a></li>
  248. <li class="right">
  249. <div class="inline-search" role="search">
  250. <form class="inline-search" action="../search.html" method="get">
  251. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
  252. <input type="submit" value="Go" />
  253. </form>
  254. </div>
  255. |
  256. </li>
  257. <li class="right">
  258. <label class="theme-selector-label">
  259. Theme
  260. <select class="theme-selector" oninput="activateTheme(this.value)">
  261. <option value="auto" selected>Auto</option>
  262. <option value="light">Light</option>
  263. <option value="dark">Dark</option>
  264. </select>
  265. </label> |</li>
  266. </ul>
  267. </div>
  268. <div class="footer">
  269. &copy; <a href="../copyright.html">Copyright</a> 2001-2023, Python Software Foundation.
  270. <br />
  271. This page is licensed under the Python Software Foundation License Version 2.
  272. <br />
  273. Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
  274. <br />
  275. See <a href="/license.html">History and License</a> for more information.<br />
  276. <br />
  277. The Python Software Foundation is a non-profit corporation.
  278. <a href="https://www.python.org/psf/donations/">Please donate.</a>
  279. <br />
  280. <br />
  281. Last updated on Oct 02, 2023.
  282. <a href="/bugs.html">Found a bug</a>?
  283. <br />
  284. Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.5.0.
  285. </div>
  286. </body>
  287. </html>