gooderp18绿色标准版
您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

562 行
31KB

  1. <!DOCTYPE html>
  2. <html lang="en" data-content_root="../">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
  6. <meta property="og:title" content="High-level API Index" />
  7. <meta property="og:type" content="website" />
  8. <meta property="og:url" content="https://docs.python.org/3/library/asyncio-api-index.html" />
  9. <meta property="og:site_name" content="Python documentation" />
  10. <meta property="og:description" content="This page lists all high-level async/await enabled asyncio APIs. Tasks: Utilities to run asyncio programs, create Tasks, and await on multiple things with timeouts.,, run(), Create event loop, run ..." />
  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="This page lists all high-level async/await enabled asyncio APIs. Tasks: Utilities to run asyncio programs, create Tasks, and await on multiple things with timeouts.,, run(), Create event loop, run ..." />
  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>High-level API Index &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
  18. <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
  19. <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />
  20. <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />
  21. <script src="../_static/documentation_options.js?v=2c828074"></script>
  22. <script src="../_static/doctools.js?v=888ff710"></script>
  23. <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
  24. <script src="../_static/sidebar.js"></script>
  25. <link rel="search" type="application/opensearchdescription+xml"
  26. title="Search within Python 3.12.3 documentation"
  27. href="../_static/opensearch.xml"/>
  28. <link rel="author" title="About these documents" href="../about.html" />
  29. <link rel="index" title="Index" href="../genindex.html" />
  30. <link rel="search" title="Search" href="../search.html" />
  31. <link rel="copyright" title="Copyright" href="../copyright.html" />
  32. <link rel="next" title="Low-level API Index" href="asyncio-llapi-index.html" />
  33. <link rel="prev" title="Extending" href="asyncio-extending.html" />
  34. <link rel="canonical" href="https://docs.python.org/3/library/asyncio-api-index.html" />
  35. <style>
  36. @media only screen {
  37. table.full-width-table {
  38. width: 100%;
  39. }
  40. }
  41. </style>
  42. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
  43. <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />
  44. <script type="text/javascript" src="../_static/copybutton.js"></script>
  45. <script type="text/javascript" src="../_static/menu.js"></script>
  46. <script type="text/javascript" src="../_static/search-focus.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="Python 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. <h3><a href="../contents.html">Table of Contents</a></h3>
  84. <ul>
  85. <li><a class="reference internal" href="#">High-level API Index</a><ul>
  86. <li><a class="reference internal" href="#tasks">Tasks</a></li>
  87. <li><a class="reference internal" href="#queues">Queues</a></li>
  88. <li><a class="reference internal" href="#subprocesses">Subprocesses</a></li>
  89. <li><a class="reference internal" href="#streams">Streams</a></li>
  90. <li><a class="reference internal" href="#synchronization">Synchronization</a></li>
  91. <li><a class="reference internal" href="#exceptions">Exceptions</a></li>
  92. </ul>
  93. </li>
  94. </ul>
  95. </div>
  96. <div>
  97. <h4>Previous topic</h4>
  98. <p class="topless"><a href="asyncio-extending.html"
  99. title="previous chapter">Extending</a></p>
  100. </div>
  101. <div>
  102. <h4>Next topic</h4>
  103. <p class="topless"><a href="asyncio-llapi-index.html"
  104. title="next chapter">Low-level API Index</a></p>
  105. </div>
  106. <div role="note" aria-label="source link">
  107. <h3>This Page</h3>
  108. <ul class="this-page-menu">
  109. <li><a href="../bugs.html">Report a Bug</a></li>
  110. <li>
  111. <a href="https://github.com/python/cpython/blob/main/Doc/library/asyncio-api-index.rst"
  112. rel="nofollow">Show Source
  113. </a>
  114. </li>
  115. </ul>
  116. </div>
  117. </nav>
  118. </div>
  119. </div>
  120. <div class="related" role="navigation" aria-label="related navigation">
  121. <h3>Navigation</h3>
  122. <ul>
  123. <li class="right" style="margin-right: 10px">
  124. <a href="../genindex.html" title="General Index"
  125. accesskey="I">index</a></li>
  126. <li class="right" >
  127. <a href="../py-modindex.html" title="Python Module Index"
  128. >modules</a> |</li>
  129. <li class="right" >
  130. <a href="asyncio-llapi-index.html" title="Low-level API Index"
  131. accesskey="N">next</a> |</li>
  132. <li class="right" >
  133. <a href="asyncio-extending.html" title="Extending"
  134. accesskey="P">previous</a> |</li>
  135. <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
  136. <li><a href="https://www.python.org/">Python</a> &#187;</li>
  137. <li class="switchers">
  138. <div class="language_switcher_placeholder"></div>
  139. <div class="version_switcher_placeholder"></div>
  140. </li>
  141. <li>
  142. </li>
  143. <li id="cpython-language-and-version">
  144. <a href="../index.html">3.12.3 Documentation</a> &#187;
  145. </li>
  146. <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
  147. <li class="nav-item nav-item-2"><a href="ipc.html" >Networking and Interprocess Communication</a> &#187;</li>
  148. <li class="nav-item nav-item-3"><a href="asyncio.html" accesskey="U"><code class="xref py py-mod docutils literal notranslate"><span class="pre">asyncio</span></code> — Asynchronous I/O</a> &#187;</li>
  149. <li class="nav-item nav-item-this"><a href="">High-level API Index</a></li>
  150. <li class="right">
  151. <div class="inline-search" role="search">
  152. <form class="inline-search" action="../search.html" method="get">
  153. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />
  154. <input type="submit" value="Go" />
  155. </form>
  156. </div>
  157. |
  158. </li>
  159. <li class="right">
  160. <label class="theme-selector-label">
  161. Theme
  162. <select class="theme-selector" oninput="activateTheme(this.value)">
  163. <option value="auto" selected>Auto</option>
  164. <option value="light">Light</option>
  165. <option value="dark">Dark</option>
  166. </select>
  167. </label> |</li>
  168. </ul>
  169. </div>
  170. <div class="document">
  171. <div class="documentwrapper">
  172. <div class="bodywrapper">
  173. <div class="body" role="main">
  174. <section id="high-level-api-index">
  175. <h1>High-level API Index<a class="headerlink" href="#high-level-api-index" title="Link to this heading">¶</a></h1>
  176. <p>This page lists all high-level async/await enabled asyncio APIs.</p>
  177. <section id="tasks">
  178. <h2>Tasks<a class="headerlink" href="#tasks" title="Link to this heading">¶</a></h2>
  179. <p>Utilities to run asyncio programs, create Tasks, and
  180. await on multiple things with timeouts.</p>
  181. <table class="full-width-table docutils align-default">
  182. <colgroup>
  183. <col style="width: 50.0%" />
  184. <col style="width: 50.0%" />
  185. </colgroup>
  186. <tbody>
  187. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-runner.html#asyncio.run" title="asyncio.run"><code class="xref py py-func docutils literal notranslate"><span class="pre">run()</span></code></a></p></td>
  188. <td><p>Create event loop, run a coroutine, close the loop.</p></td>
  189. </tr>
  190. <tr class="row-even"><td><p><a class="reference internal" href="asyncio-runner.html#asyncio.Runner" title="asyncio.Runner"><code class="xref py py-class docutils literal notranslate"><span class="pre">Runner</span></code></a></p></td>
  191. <td><p>A context manager that simplifies multiple async function calls.</p></td>
  192. </tr>
  193. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-task.html#asyncio.Task" title="asyncio.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a></p></td>
  194. <td><p>Task object.</p></td>
  195. </tr>
  196. <tr class="row-even"><td><p><a class="reference internal" href="asyncio-task.html#asyncio.TaskGroup" title="asyncio.TaskGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">TaskGroup</span></code></a></p></td>
  197. <td><p>A context manager that holds a group of tasks. Provides
  198. a convenient and reliable way to wait for all tasks in the group to
  199. finish.</p></td>
  200. </tr>
  201. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-task.html#asyncio.create_task" title="asyncio.create_task"><code class="xref py py-func docutils literal notranslate"><span class="pre">create_task()</span></code></a></p></td>
  202. <td><p>Start an asyncio Task, then returns it.</p></td>
  203. </tr>
  204. <tr class="row-even"><td><p><a class="reference internal" href="asyncio-task.html#asyncio.current_task" title="asyncio.current_task"><code class="xref py py-func docutils literal notranslate"><span class="pre">current_task()</span></code></a></p></td>
  205. <td><p>Return the current Task.</p></td>
  206. </tr>
  207. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-task.html#asyncio.all_tasks" title="asyncio.all_tasks"><code class="xref py py-func docutils literal notranslate"><span class="pre">all_tasks()</span></code></a></p></td>
  208. <td><p>Return all tasks that are not yet finished for an event loop.</p></td>
  209. </tr>
  210. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">await</span></code> <a class="reference internal" href="asyncio-task.html#asyncio.sleep" title="asyncio.sleep"><code class="xref py py-func docutils literal notranslate"><span class="pre">sleep()</span></code></a></p></td>
  211. <td><p>Sleep for a number of seconds.</p></td>
  212. </tr>
  213. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">await</span></code> <a class="reference internal" href="asyncio-task.html#asyncio.gather" title="asyncio.gather"><code class="xref py py-func docutils literal notranslate"><span class="pre">gather()</span></code></a></p></td>
  214. <td><p>Schedule and wait for things concurrently.</p></td>
  215. </tr>
  216. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">await</span></code> <a class="reference internal" href="asyncio-task.html#asyncio.wait_for" title="asyncio.wait_for"><code class="xref py py-func docutils literal notranslate"><span class="pre">wait_for()</span></code></a></p></td>
  217. <td><p>Run with a timeout.</p></td>
  218. </tr>
  219. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">await</span></code> <a class="reference internal" href="asyncio-task.html#asyncio.shield" title="asyncio.shield"><code class="xref py py-func docutils literal notranslate"><span class="pre">shield()</span></code></a></p></td>
  220. <td><p>Shield from cancellation.</p></td>
  221. </tr>
  222. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">await</span></code> <a class="reference internal" href="asyncio-task.html#asyncio.wait" title="asyncio.wait"><code class="xref py py-func docutils literal notranslate"><span class="pre">wait()</span></code></a></p></td>
  223. <td><p>Monitor for completion.</p></td>
  224. </tr>
  225. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-task.html#asyncio.timeout" title="asyncio.timeout"><code class="xref py py-func docutils literal notranslate"><span class="pre">timeout()</span></code></a></p></td>
  226. <td><p>Run with a timeout. Useful in cases when <code class="docutils literal notranslate"><span class="pre">wait_for</span></code> is not suitable.</p></td>
  227. </tr>
  228. <tr class="row-even"><td><p><a class="reference internal" href="asyncio-task.html#asyncio.to_thread" title="asyncio.to_thread"><code class="xref py py-func docutils literal notranslate"><span class="pre">to_thread()</span></code></a></p></td>
  229. <td><p>Asynchronously run a function in a separate OS thread.</p></td>
  230. </tr>
  231. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-task.html#asyncio.run_coroutine_threadsafe" title="asyncio.run_coroutine_threadsafe"><code class="xref py py-func docutils literal notranslate"><span class="pre">run_coroutine_threadsafe()</span></code></a></p></td>
  232. <td><p>Schedule a coroutine from another OS thread.</p></td>
  233. </tr>
  234. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">for</span> <span class="pre">in</span></code> <a class="reference internal" href="asyncio-task.html#asyncio.as_completed" title="asyncio.as_completed"><code class="xref py py-func docutils literal notranslate"><span class="pre">as_completed()</span></code></a></p></td>
  235. <td><p>Monitor for completion with a <code class="docutils literal notranslate"><span class="pre">for</span></code> loop.</p></td>
  236. </tr>
  237. </tbody>
  238. </table>
  239. <p class="rubric">Examples</p>
  240. <ul class="simple">
  241. <li><p><a class="reference internal" href="asyncio-task.html#asyncio-example-gather"><span class="std std-ref">Using asyncio.gather() to run things in parallel</span></a>.</p></li>
  242. <li><p><a class="reference internal" href="asyncio-task.html#asyncio-example-waitfor"><span class="std std-ref">Using asyncio.wait_for() to enforce a timeout</span></a>.</p></li>
  243. <li><p><a class="reference internal" href="asyncio-task.html#asyncio-example-task-cancel"><span class="std std-ref">Cancellation</span></a>.</p></li>
  244. <li><p><a class="reference internal" href="asyncio-task.html#asyncio-example-sleep"><span class="std std-ref">Using asyncio.sleep()</span></a>.</p></li>
  245. <li><p>See also the main <a class="reference internal" href="asyncio-task.html#coroutine"><span class="std std-ref">Tasks documentation page</span></a>.</p></li>
  246. </ul>
  247. </section>
  248. <section id="queues">
  249. <h2>Queues<a class="headerlink" href="#queues" title="Link to this heading">¶</a></h2>
  250. <p>Queues should be used to distribute work amongst multiple asyncio Tasks,
  251. implement connection pools, and pub/sub patterns.</p>
  252. <table class="full-width-table docutils align-default">
  253. <colgroup>
  254. <col style="width: 50.0%" />
  255. <col style="width: 50.0%" />
  256. </colgroup>
  257. <tbody>
  258. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-queue.html#asyncio.Queue" title="asyncio.Queue"><code class="xref py py-class docutils literal notranslate"><span class="pre">Queue</span></code></a></p></td>
  259. <td><p>A FIFO queue.</p></td>
  260. </tr>
  261. <tr class="row-even"><td><p><a class="reference internal" href="asyncio-queue.html#asyncio.PriorityQueue" title="asyncio.PriorityQueue"><code class="xref py py-class docutils literal notranslate"><span class="pre">PriorityQueue</span></code></a></p></td>
  262. <td><p>A priority queue.</p></td>
  263. </tr>
  264. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-queue.html#asyncio.LifoQueue" title="asyncio.LifoQueue"><code class="xref py py-class docutils literal notranslate"><span class="pre">LifoQueue</span></code></a></p></td>
  265. <td><p>A LIFO queue.</p></td>
  266. </tr>
  267. </tbody>
  268. </table>
  269. <p class="rubric">Examples</p>
  270. <ul class="simple">
  271. <li><p><a class="reference internal" href="asyncio-queue.html#asyncio-example-queue-dist"><span class="std std-ref">Using asyncio.Queue to distribute workload between several
  272. Tasks</span></a>.</p></li>
  273. <li><p>See also the <a class="reference internal" href="asyncio-queue.html#asyncio-queues"><span class="std std-ref">Queues documentation page</span></a>.</p></li>
  274. </ul>
  275. </section>
  276. <section id="subprocesses">
  277. <h2>Subprocesses<a class="headerlink" href="#subprocesses" title="Link to this heading">¶</a></h2>
  278. <p>Utilities to spawn subprocesses and run shell commands.</p>
  279. <table class="full-width-table docutils align-default">
  280. <colgroup>
  281. <col style="width: 50.0%" />
  282. <col style="width: 50.0%" />
  283. </colgroup>
  284. <tbody>
  285. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">await</span></code> <a class="reference internal" href="asyncio-subprocess.html#asyncio.create_subprocess_exec" title="asyncio.create_subprocess_exec"><code class="xref py py-func docutils literal notranslate"><span class="pre">create_subprocess_exec()</span></code></a></p></td>
  286. <td><p>Create a subprocess.</p></td>
  287. </tr>
  288. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">await</span></code> <a class="reference internal" href="asyncio-subprocess.html#asyncio.create_subprocess_shell" title="asyncio.create_subprocess_shell"><code class="xref py py-func docutils literal notranslate"><span class="pre">create_subprocess_shell()</span></code></a></p></td>
  289. <td><p>Run a shell command.</p></td>
  290. </tr>
  291. </tbody>
  292. </table>
  293. <p class="rubric">Examples</p>
  294. <ul class="simple">
  295. <li><p><a class="reference internal" href="asyncio-subprocess.html#asyncio-example-subprocess-shell"><span class="std std-ref">Executing a shell command</span></a>.</p></li>
  296. <li><p>See also the <a class="reference internal" href="asyncio-subprocess.html#asyncio-subprocess"><span class="std std-ref">subprocess APIs</span></a>
  297. documentation.</p></li>
  298. </ul>
  299. </section>
  300. <section id="streams">
  301. <h2>Streams<a class="headerlink" href="#streams" title="Link to this heading">¶</a></h2>
  302. <p>High-level APIs to work with network IO.</p>
  303. <table class="full-width-table docutils align-default">
  304. <colgroup>
  305. <col style="width: 50.0%" />
  306. <col style="width: 50.0%" />
  307. </colgroup>
  308. <tbody>
  309. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">await</span></code> <a class="reference internal" href="asyncio-stream.html#asyncio.open_connection" title="asyncio.open_connection"><code class="xref py py-func docutils literal notranslate"><span class="pre">open_connection()</span></code></a></p></td>
  310. <td><p>Establish a TCP connection.</p></td>
  311. </tr>
  312. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">await</span></code> <a class="reference internal" href="asyncio-stream.html#asyncio.open_unix_connection" title="asyncio.open_unix_connection"><code class="xref py py-func docutils literal notranslate"><span class="pre">open_unix_connection()</span></code></a></p></td>
  313. <td><p>Establish a Unix socket connection.</p></td>
  314. </tr>
  315. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">await</span></code> <a class="reference internal" href="asyncio-stream.html#asyncio.start_server" title="asyncio.start_server"><code class="xref py py-func docutils literal notranslate"><span class="pre">start_server()</span></code></a></p></td>
  316. <td><p>Start a TCP server.</p></td>
  317. </tr>
  318. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">await</span></code> <a class="reference internal" href="asyncio-stream.html#asyncio.start_unix_server" title="asyncio.start_unix_server"><code class="xref py py-func docutils literal notranslate"><span class="pre">start_unix_server()</span></code></a></p></td>
  319. <td><p>Start a Unix socket server.</p></td>
  320. </tr>
  321. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-stream.html#asyncio.StreamReader" title="asyncio.StreamReader"><code class="xref py py-class docutils literal notranslate"><span class="pre">StreamReader</span></code></a></p></td>
  322. <td><p>High-level async/await object to receive network data.</p></td>
  323. </tr>
  324. <tr class="row-even"><td><p><a class="reference internal" href="asyncio-stream.html#asyncio.StreamWriter" title="asyncio.StreamWriter"><code class="xref py py-class docutils literal notranslate"><span class="pre">StreamWriter</span></code></a></p></td>
  325. <td><p>High-level async/await object to send network data.</p></td>
  326. </tr>
  327. </tbody>
  328. </table>
  329. <p class="rubric">Examples</p>
  330. <ul class="simple">
  331. <li><p><a class="reference internal" href="asyncio-stream.html#asyncio-example-stream"><span class="std std-ref">Example TCP client</span></a>.</p></li>
  332. <li><p>See also the <a class="reference internal" href="asyncio-stream.html#asyncio-streams"><span class="std std-ref">streams APIs</span></a>
  333. documentation.</p></li>
  334. </ul>
  335. </section>
  336. <section id="synchronization">
  337. <h2>Synchronization<a class="headerlink" href="#synchronization" title="Link to this heading">¶</a></h2>
  338. <p>Threading-like synchronization primitives that can be used in Tasks.</p>
  339. <table class="full-width-table docutils align-default">
  340. <colgroup>
  341. <col style="width: 50.0%" />
  342. <col style="width: 50.0%" />
  343. </colgroup>
  344. <tbody>
  345. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-sync.html#asyncio.Lock" title="asyncio.Lock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Lock</span></code></a></p></td>
  346. <td><p>A mutex lock.</p></td>
  347. </tr>
  348. <tr class="row-even"><td><p><a class="reference internal" href="asyncio-sync.html#asyncio.Event" title="asyncio.Event"><code class="xref py py-class docutils literal notranslate"><span class="pre">Event</span></code></a></p></td>
  349. <td><p>An event object.</p></td>
  350. </tr>
  351. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-sync.html#asyncio.Condition" title="asyncio.Condition"><code class="xref py py-class docutils literal notranslate"><span class="pre">Condition</span></code></a></p></td>
  352. <td><p>A condition object.</p></td>
  353. </tr>
  354. <tr class="row-even"><td><p><a class="reference internal" href="asyncio-sync.html#asyncio.Semaphore" title="asyncio.Semaphore"><code class="xref py py-class docutils literal notranslate"><span class="pre">Semaphore</span></code></a></p></td>
  355. <td><p>A semaphore.</p></td>
  356. </tr>
  357. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-sync.html#asyncio.BoundedSemaphore" title="asyncio.BoundedSemaphore"><code class="xref py py-class docutils literal notranslate"><span class="pre">BoundedSemaphore</span></code></a></p></td>
  358. <td><p>A bounded semaphore.</p></td>
  359. </tr>
  360. <tr class="row-even"><td><p><a class="reference internal" href="asyncio-sync.html#asyncio.Barrier" title="asyncio.Barrier"><code class="xref py py-class docutils literal notranslate"><span class="pre">Barrier</span></code></a></p></td>
  361. <td><p>A barrier object.</p></td>
  362. </tr>
  363. </tbody>
  364. </table>
  365. <p class="rubric">Examples</p>
  366. <ul class="simple">
  367. <li><p><a class="reference internal" href="asyncio-sync.html#asyncio-example-sync-event"><span class="std std-ref">Using asyncio.Event</span></a>.</p></li>
  368. <li><p><a class="reference internal" href="asyncio-sync.html#asyncio-example-barrier"><span class="std std-ref">Using asyncio.Barrier</span></a>.</p></li>
  369. <li><p>See also the documentation of asyncio
  370. <a class="reference internal" href="asyncio-sync.html#asyncio-sync"><span class="std std-ref">synchronization primitives</span></a>.</p></li>
  371. </ul>
  372. </section>
  373. <section id="exceptions">
  374. <h2>Exceptions<a class="headerlink" href="#exceptions" title="Link to this heading">¶</a></h2>
  375. <table class="full-width-table docutils align-default">
  376. <colgroup>
  377. <col style="width: 50.0%" />
  378. <col style="width: 50.0%" />
  379. </colgroup>
  380. <tbody>
  381. <tr class="row-odd"><td><p><a class="reference internal" href="asyncio-exceptions.html#asyncio.CancelledError" title="asyncio.CancelledError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">asyncio.CancelledError</span></code></a></p></td>
  382. <td><p>Raised when a Task is cancelled. See also <a class="reference internal" href="asyncio-task.html#asyncio.Task.cancel" title="asyncio.Task.cancel"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Task.cancel()</span></code></a>.</p></td>
  383. </tr>
  384. <tr class="row-even"><td><p><a class="reference internal" href="asyncio-sync.html#asyncio.BrokenBarrierError" title="asyncio.BrokenBarrierError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">asyncio.BrokenBarrierError</span></code></a></p></td>
  385. <td><p>Raised when a Barrier is broken. See also <a class="reference internal" href="asyncio-sync.html#asyncio.Barrier.wait" title="asyncio.Barrier.wait"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Barrier.wait()</span></code></a>.</p></td>
  386. </tr>
  387. </tbody>
  388. </table>
  389. <p class="rubric">Examples</p>
  390. <ul class="simple">
  391. <li><p><a class="reference internal" href="asyncio-task.html#asyncio-example-task-cancel"><span class="std std-ref">Handling CancelledError to run code on cancellation request</span></a>.</p></li>
  392. <li><p>See also the full list of
  393. <a class="reference internal" href="asyncio-exceptions.html#asyncio-exceptions"><span class="std std-ref">asyncio-specific exceptions</span></a>.</p></li>
  394. </ul>
  395. </section>
  396. </section>
  397. <div class="clearer"></div>
  398. </div>
  399. </div>
  400. </div>
  401. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  402. <div class="sphinxsidebarwrapper">
  403. <div>
  404. <h3><a href="../contents.html">Table of Contents</a></h3>
  405. <ul>
  406. <li><a class="reference internal" href="#">High-level API Index</a><ul>
  407. <li><a class="reference internal" href="#tasks">Tasks</a></li>
  408. <li><a class="reference internal" href="#queues">Queues</a></li>
  409. <li><a class="reference internal" href="#subprocesses">Subprocesses</a></li>
  410. <li><a class="reference internal" href="#streams">Streams</a></li>
  411. <li><a class="reference internal" href="#synchronization">Synchronization</a></li>
  412. <li><a class="reference internal" href="#exceptions">Exceptions</a></li>
  413. </ul>
  414. </li>
  415. </ul>
  416. </div>
  417. <div>
  418. <h4>Previous topic</h4>
  419. <p class="topless"><a href="asyncio-extending.html"
  420. title="previous chapter">Extending</a></p>
  421. </div>
  422. <div>
  423. <h4>Next topic</h4>
  424. <p class="topless"><a href="asyncio-llapi-index.html"
  425. title="next chapter">Low-level API Index</a></p>
  426. </div>
  427. <div role="note" aria-label="source link">
  428. <h3>This Page</h3>
  429. <ul class="this-page-menu">
  430. <li><a href="../bugs.html">Report a Bug</a></li>
  431. <li>
  432. <a href="https://github.com/python/cpython/blob/main/Doc/library/asyncio-api-index.rst"
  433. rel="nofollow">Show Source
  434. </a>
  435. </li>
  436. </ul>
  437. </div>
  438. </div>
  439. <div id="sidebarbutton" title="Collapse sidebar">
  440. <span>«</span>
  441. </div>
  442. </div>
  443. <div class="clearer"></div>
  444. </div>
  445. <div class="related" role="navigation" aria-label="related navigation">
  446. <h3>Navigation</h3>
  447. <ul>
  448. <li class="right" style="margin-right: 10px">
  449. <a href="../genindex.html" title="General Index"
  450. >index</a></li>
  451. <li class="right" >
  452. <a href="../py-modindex.html" title="Python Module Index"
  453. >modules</a> |</li>
  454. <li class="right" >
  455. <a href="asyncio-llapi-index.html" title="Low-level API Index"
  456. >next</a> |</li>
  457. <li class="right" >
  458. <a href="asyncio-extending.html" title="Extending"
  459. >previous</a> |</li>
  460. <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
  461. <li><a href="https://www.python.org/">Python</a> &#187;</li>
  462. <li class="switchers">
  463. <div class="language_switcher_placeholder"></div>
  464. <div class="version_switcher_placeholder"></div>
  465. </li>
  466. <li>
  467. </li>
  468. <li id="cpython-language-and-version">
  469. <a href="../index.html">3.12.3 Documentation</a> &#187;
  470. </li>
  471. <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
  472. <li class="nav-item nav-item-2"><a href="ipc.html" >Networking and Interprocess Communication</a> &#187;</li>
  473. <li class="nav-item nav-item-3"><a href="asyncio.html" ><code class="xref py py-mod docutils literal notranslate"><span class="pre">asyncio</span></code> — Asynchronous I/O</a> &#187;</li>
  474. <li class="nav-item nav-item-this"><a href="">High-level API Index</a></li>
  475. <li class="right">
  476. <div class="inline-search" role="search">
  477. <form class="inline-search" action="../search.html" method="get">
  478. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />
  479. <input type="submit" value="Go" />
  480. </form>
  481. </div>
  482. |
  483. </li>
  484. <li class="right">
  485. <label class="theme-selector-label">
  486. Theme
  487. <select class="theme-selector" oninput="activateTheme(this.value)">
  488. <option value="auto" selected>Auto</option>
  489. <option value="light">Light</option>
  490. <option value="dark">Dark</option>
  491. </select>
  492. </label> |</li>
  493. </ul>
  494. </div>
  495. <div class="footer">
  496. &copy;
  497. <a href="../copyright.html">
  498. Copyright
  499. </a>
  500. 2001-2024, Python Software Foundation.
  501. <br />
  502. This page is licensed under the Python Software Foundation License Version 2.
  503. <br />
  504. Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
  505. <br />
  506. See <a href="/license.html">History and License</a> for more information.<br />
  507. <br />
  508. The Python Software Foundation is a non-profit corporation.
  509. <a href="https://www.python.org/psf/donations/">Please donate.</a>
  510. <br />
  511. <br />
  512. Last updated on Apr 09, 2024 (13:47 UTC).
  513. <a href="/bugs.html">Found a bug</a>?
  514. <br />
  515. Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
  516. </div>
  517. </body>
  518. </html>
上海开阖软件有限公司 沪ICP备12045867号-1