Team Ai
Apppublic

parthtamu/rag-code-assistant

sourceHugging Faceupdated 7mo agoView on Hugging Face
0likes
asyncio-dev.html587 linesDownload Raw Back to docs
1<!DOCTYPE html>2 3<html lang="en" data-content_root="../">4  <head>5    <meta charset="utf-8" />6    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />7<meta property="og:title" content="Developing with asyncio" />8<meta property="og:type" content="website" />9<meta property="og:url" content="https://docs.python.org/3/library/asyncio-dev.html" />10<meta property="og:site_name" content="Python documentation" />11<meta property="og:description" content="Asynchronous programming is different from classic “sequential” programming. This page lists common mistakes and traps and explains how to avoid them. Debug Mode: By default asyncio runs in product..." />12<meta property="og:image:width" content="1146" />13<meta property="og:image:height" content="600" />14<meta property="og:image" content="https://docs.python.org/3.15/_images/social_previews/summary_library_asyncio-dev_686102cd.png" />15<meta property="og:image:alt" content="Asynchronous programming is different from classic “sequential” programming. This page lists common mistakes and traps and explains how to avoid them. Debug Mode: By default asyncio runs in product..." />16<meta name="description" content="Asynchronous programming is different from classic “sequential” programming. This page lists common mistakes and traps and explains how to avoid them. Debug Mode: By default asyncio runs in product..." />17<meta name="twitter:card" content="summary_large_image" />18<meta name="theme-color" content="#3776ab">19 20    <title>Developing with asyncio &#8212; Python 3.15.0a6 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">21    22    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />23    <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=234b1a7c" />24    <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=89a2f22a" />25    <link rel="stylesheet" type="text/css" href="../_static/profiling-sampling-visualization.css?v=0c2600ae" />26    <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=5349f25f" />27    28    <script src="../_static/documentation_options.js?v=6b7c9ff5"></script>29    <script src="../_static/doctools.js?v=9bcbadda"></script>30    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>31    <script src="../_static/profiling-sampling-visualization.js?v=9811ed04"></script>32    33    <script src="../_static/sidebar.js"></script>34    35    <link rel="search" type="application/opensearchdescription+xml"36          title="Search within Python 3.15.0a6 documentation"37          href="../_static/opensearch.xml"/>38    <link rel="author" title="About these documents" href="../about.html" />39    <link rel="index" title="Index" href="../genindex.html" />40    <link rel="search" title="Search" href="../search.html" />41    <link rel="copyright" title="Copyright" href="../copyright.html" />42    <link rel="next" title="socket — Low-level networking interface" href="socket.html" />43    <link rel="prev" title="Low-level API Index" href="asyncio-llapi-index.html" />44    45      46      <script defer file-types="bz2,epub,zip" data-domain="docs.python.org" src="https://analytics.python.org/js/script.file-downloads.outbound-links.js"></script>47      48      <link rel="canonical" href="https://docs.python.org/3/library/asyncio-dev.html">49      50    51 52    53    <style>54      @media only screen {55        table.full-width-table {56            width: 100%;57        }58      }59    </style>60<link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">61    <link rel="shortcut icon" type="image/png" href="../_static/py.svg">62            <script type="text/javascript" src="../_static/copybutton.js"></script>63            <script type="text/javascript" src="../_static/menu.js"></script>64            <script type="text/javascript" src="../_static/search-focus.js"></script>65            <script type="text/javascript" src="../_static/themetoggle.js"></script> 66            <script type="text/javascript" src="../_static/rtd_switcher.js"></script>67            <meta name="readthedocs-addons-api-version" content="1">68 69  </head>70<body>71<div class="mobile-nav">72    <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"73           aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">74    <nav class="nav-content" role="navigation">75        <label for="menuToggler" class="toggler__label">76            <span></span>77        </label>78        <span class="nav-items-wrapper">79            <a href="https://www.python.org/" class="nav-logo">80                <img src="../_static/py.svg" alt="Python logo">81            </a>82            <span class="version_switcher_placeholder"></span>83            <form role="search" class="search" action="../search.html" method="get">84                <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">85                    <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>86                </svg>87                <input placeholder="Quick search" aria-label="Quick search" type="search" name="q">88                <input type="submit" value="Go">89            </form>90        </span>91    </nav>92    <div class="menu-wrapper">93        <nav class="menu" role="navigation" aria-label="main navigation">94            <div class="language_switcher_placeholder"></div>95            96<label class="theme-selector-label">97    Theme98    <select class="theme-selector" oninput="activateTheme(this.value)">99        <option value="auto" selected>Auto</option>100        <option value="light">Light</option>101        <option value="dark">Dark</option>102    </select>103</label>104  <div>105    <h3><a href="../contents.html">Table of Contents</a></h3>106    <ul>107<li><a class="reference internal" href="#">Developing with asyncio</a><ul>108<li><a class="reference internal" href="#debug-mode">Debug Mode</a></li>109<li><a class="reference internal" href="#concurrency-and-multithreading">Concurrency and Multithreading</a></li>110<li><a class="reference internal" href="#running-blocking-code">Running Blocking Code</a></li>111<li><a class="reference internal" href="#logging">Logging</a></li>112<li><a class="reference internal" href="#detect-never-awaited-coroutines">Detect never-awaited coroutines</a></li>113<li><a class="reference internal" href="#detect-never-retrieved-exceptions">Detect never-retrieved exceptions</a></li>114</ul>115</li>116</ul>117 118  </div>119  <div>120    <h4>Previous topic</h4>121    <p class="topless"><a href="asyncio-llapi-index.html"122                          title="previous chapter">Low-level API Index</a></p>123  </div>124  <div>125    <h4>Next topic</h4>126    <p class="topless"><a href="socket.html"127                          title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">socket</span></code> — Low-level networking interface</a></p>128  </div>129  <script>130    document.addEventListener('DOMContentLoaded', () => {131        const title = document.querySelector('meta[property="og:title"]').content;132        const elements = document.querySelectorAll('.improvepage');133        const pageurl = window.location.href.split('?')[0];134        elements.forEach(element => {135            const url = new URL(element.href.split('?')[0].replace("-nojs", ""));136            url.searchParams.set('pagetitle', title);137            url.searchParams.set('pageurl', pageurl);138            url.searchParams.set('pagesource', "library/asyncio-dev.rst");139            element.href = url.toString();140        });141    });142  </script>143  <div role="note" aria-label="source link">144    <h3>This page</h3>145    <ul class="this-page-menu">146      <li><a href="../bugs.html">Report a bug</a></li>147      <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>148      <li>149        <a href="https://github.com/python/cpython/blob/main/Doc/library/asyncio-dev.rst?plain=1"150            rel="nofollow">Show source151        </a>152      </li>153      154    </ul>155  </div>156        </nav>157    </div>158</div>159 160  161    <div class="related" role="navigation" aria-label="Related">162      <h3>Navigation</h3>163      <ul>164        <li class="right" style="margin-right: 10px">165          <a href="../genindex.html" title="General Index"166             accesskey="I">index</a></li>167        <li class="right" >168          <a href="../py-modindex.html" title="Python Module Index"169             >modules</a> |</li>170        <li class="right" >171          <a href="socket.html" title="socket — Low-level networking interface"172             accesskey="N">next</a> |</li>173        <li class="right" >174          <a href="asyncio-llapi-index.html" title="Low-level API Index"175             accesskey="P">previous</a> |</li>176 177          <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>178          <li><a href="https://www.python.org/">Python</a> &#187;</li>179          <li class="switchers">180            <div class="language_switcher_placeholder"></div>181            <div class="version_switcher_placeholder"></div>182          </li>183          <li>184              185          </li>186    <li id="cpython-language-and-version">187      <a href="../index.html">3.15.0a6 Documentation</a> &#187;188    </li>189 190          <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>191          <li class="nav-item nav-item-2"><a href="ipc.html" >Networking and Interprocess Communication</a> &#187;</li>192          <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>193        <li class="nav-item nav-item-this"><a href="">Developing with asyncio</a></li>194                <li class="right">195                    196 197    <div class="inline-search" role="search">198        <form class="inline-search" action="../search.html" method="get">199          <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">200          <input type="submit" value="Go">201        </form>202    </div>203                     |204                </li>205            <li class="right">206<label class="theme-selector-label">207    Theme208    <select class="theme-selector" oninput="activateTheme(this.value)">209        <option value="auto" selected>Auto</option>210        <option value="light">Light</option>211        <option value="dark">Dark</option>212    </select>213</label> |</li>214            215      </ul>216    </div>    217 218    <div class="document">219      <div class="documentwrapper">220        <div class="bodywrapper">221          <div class="body" role="main">222            223  <section id="developing-with-asyncio">224<span id="asyncio-dev"></span><h1>Developing with asyncio<a class="headerlink" href="#developing-with-asyncio" title="Link to this heading">¶</a></h1>225<p>Asynchronous programming is different from classic “sequential”226programming.</p>227<p>This page lists common mistakes and traps and explains how228to avoid them.</p>229<section id="debug-mode">230<span id="asyncio-debug-mode"></span><h2>Debug Mode<a class="headerlink" href="#debug-mode" title="Link to this heading">¶</a></h2>231<p>By default asyncio runs in production mode.  In order to ease232the development asyncio has a <em>debug mode</em>.</p>233<p>There are several ways to enable asyncio debug mode:</p>234<ul class="simple">235<li><p>Setting the <span class="target" id="index-0"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONASYNCIODEBUG"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">PYTHONASYNCIODEBUG</span></code></a> environment variable to <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p></li>236<li><p>Using the <a class="reference internal" href="devmode.html#devmode"><span class="std std-ref">Python Development Mode</span></a>.</p></li>237<li><p>Passing <code class="docutils literal notranslate"><span class="pre">debug=True</span></code> to <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">asyncio.run()</span></code></a>.</p></li>238<li><p>Calling <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.set_debug" title="asyncio.loop.set_debug"><code class="xref py py-meth docutils literal notranslate"><span class="pre">loop.set_debug()</span></code></a>.</p></li>239</ul>240<p>In addition to enabling the debug mode, consider also:</p>241<ul>242<li><p>setting the log level of the <a class="reference internal" href="#asyncio-logger"><span class="std std-ref">asyncio logger</span></a> to243<a class="reference internal" href="logging.html#logging.DEBUG" title="logging.DEBUG"><code class="xref py py-const docutils literal notranslate"><span class="pre">logging.DEBUG</span></code></a>, for example the following snippet of code244can be run at startup of the application:</p>245<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">logging</span><span class="o">.</span><span class="n">basicConfig</span><span class="p">(</span><span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>246</pre></div>247</div>248</li>249<li><p>configuring the <a class="reference internal" href="warnings.html#module-warnings" title="warnings: Issue warning messages and control their disposition."><code class="xref py py-mod docutils literal notranslate"><span class="pre">warnings</span></code></a> module to display250<a class="reference internal" href="exceptions.html#ResourceWarning" title="ResourceWarning"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ResourceWarning</span></code></a> warnings.  One way of doing that is by251using the <a class="reference internal" href="../using/cmdline.html#cmdoption-W"><code class="xref std std-option docutils literal notranslate"><span class="pre">-W</span></code></a> <code class="docutils literal notranslate"><span class="pre">default</span></code> command line option.</p></li>252</ul>253<p>When the debug mode is enabled:</p>254<ul class="simple">255<li><p>Many non-threadsafe asyncio APIs (such as <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.call_soon" title="asyncio.loop.call_soon"><code class="xref py py-meth docutils literal notranslate"><span class="pre">loop.call_soon()</span></code></a> and256<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.call_at" title="asyncio.loop.call_at"><code class="xref py py-meth docutils literal notranslate"><span class="pre">loop.call_at()</span></code></a> methods) raise an exception if they are called257from a wrong thread.</p></li>258<li><p>The execution time of the I/O selector is logged if it takes too long to259perform an I/O operation.</p></li>260<li><p>Callbacks taking longer than 100 milliseconds are logged.  The261<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.slow_callback_duration" title="asyncio.loop.slow_callback_duration"><code class="xref py py-attr docutils literal notranslate"><span class="pre">loop.slow_callback_duration</span></code></a> attribute can be used to set the262minimum execution duration in seconds that is considered “slow”.</p></li>263</ul>264</section>265<section id="concurrency-and-multithreading">266<span id="asyncio-multithreading"></span><h2>Concurrency and Multithreading<a class="headerlink" href="#concurrency-and-multithreading" title="Link to this heading">¶</a></h2>267<p>An event loop runs in a thread (typically the main thread) and executes268all callbacks and Tasks in its thread.  While a Task is running in the269event loop, no other Tasks can run in the same thread.  When a Task270executes an <code class="docutils literal notranslate"><span class="pre">await</span></code> expression, the running Task gets suspended, and271the event loop executes the next Task.</p>272<p>To schedule a <a class="reference internal" href="../glossary.html#term-callback"><span class="xref std std-term">callback</span></a> from another OS thread, the273<a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.call_soon_threadsafe" title="asyncio.loop.call_soon_threadsafe"><code class="xref py py-meth docutils literal notranslate"><span class="pre">loop.call_soon_threadsafe()</span></code></a> method should be used. Example:</p>274<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">loop</span><span class="o">.</span><span class="n">call_soon_threadsafe</span><span class="p">(</span><span class="n">callback</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span>275</pre></div>276</div>277<p>Almost all asyncio objects are not thread safe, which is typically278not a problem unless there is code that works with them from outside279of a Task or a callback.  If there’s a need for such code to call a280low-level asyncio API, the <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.call_soon_threadsafe" title="asyncio.loop.call_soon_threadsafe"><code class="xref py py-meth docutils literal notranslate"><span class="pre">loop.call_soon_threadsafe()</span></code></a> method281should be used, e.g.:</p>282<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">loop</span><span class="o">.</span><span class="n">call_soon_threadsafe</span><span class="p">(</span><span class="n">fut</span><span class="o">.</span><span class="n">cancel</span><span class="p">)</span>283</pre></div>284</div>285<p>To schedule a coroutine object from a different OS thread, the286<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> function should be used. It returns a287<a class="reference internal" href="concurrent.futures.html#concurrent.futures.Future" title="concurrent.futures.Future"><code class="xref py py-class docutils literal notranslate"><span class="pre">concurrent.futures.Future</span></code></a> to access the result:</p>288<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">coro_func</span><span class="p">():</span>289     <span class="k">return</span> <span class="k">await</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">42</span><span class="p">)</span>290 291<span class="c1"># Later in another OS thread:</span>292 293<span class="n">future</span> <span class="o">=</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">run_coroutine_threadsafe</span><span class="p">(</span><span class="n">coro_func</span><span class="p">(),</span> <span class="n">loop</span><span class="p">)</span>294<span class="c1"># Wait for the result:</span>295<span class="n">result</span> <span class="o">=</span> <span class="n">future</span><span class="o">.</span><span class="n">result</span><span class="p">()</span>296</pre></div>297</div>298<p>To handle signals the event loop must be299run in the main thread.</p>300<p>The <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.run_in_executor" title="asyncio.loop.run_in_executor"><code class="xref py py-meth docutils literal notranslate"><span class="pre">loop.run_in_executor()</span></code></a> method can be used with a301<a class="reference internal" href="concurrent.futures.html#concurrent.futures.ThreadPoolExecutor" title="concurrent.futures.ThreadPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">concurrent.futures.ThreadPoolExecutor</span></code></a> or302<a class="reference internal" href="concurrent.futures.html#concurrent.futures.InterpreterPoolExecutor" title="concurrent.futures.InterpreterPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">InterpreterPoolExecutor</span></code></a> to execute303blocking code in a different OS thread without blocking the OS thread304that the event loop runs in.</p>305<p>There is currently no way to schedule coroutines or callbacks directly306from a different process (such as one started with307<a class="reference internal" href="multiprocessing.html#module-multiprocessing" title="multiprocessing: Process-based parallelism."><code class="xref py py-mod docutils literal notranslate"><span class="pre">multiprocessing</span></code></a>). The <a class="reference internal" href="asyncio-eventloop.html#asyncio-event-loop-methods"><span class="std std-ref">Event Loop Methods</span></a>308section lists APIs that can read from pipes and watch file descriptors309without blocking the event loop. In addition, asyncio’s310<a class="reference internal" href="asyncio-subprocess.html#asyncio-subprocess"><span class="std std-ref">Subprocess</span></a> APIs provide a way to start a311process and communicate with it from the event loop. Lastly, the312aforementioned <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.run_in_executor" title="asyncio.loop.run_in_executor"><code class="xref py py-meth docutils literal notranslate"><span class="pre">loop.run_in_executor()</span></code></a> method can also be used313with a <a class="reference internal" href="concurrent.futures.html#concurrent.futures.ProcessPoolExecutor" title="concurrent.futures.ProcessPoolExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">concurrent.futures.ProcessPoolExecutor</span></code></a> to execute314code in a different process.</p>315</section>316<section id="running-blocking-code">317<span id="asyncio-handle-blocking"></span><h2>Running Blocking Code<a class="headerlink" href="#running-blocking-code" title="Link to this heading">¶</a></h2>318<p>Blocking (CPU-bound) code should not be called directly.  For example,319if a function performs a CPU-intensive calculation for 1 second,320all concurrent asyncio Tasks and IO operations would be delayed321by 1 second.</p>322<p>An executor can be used to run a task in a different thread,323including in a different interpreter, or even in324a different process to avoid blocking the OS thread with the325event loop.  See the <a class="reference internal" href="asyncio-eventloop.html#asyncio.loop.run_in_executor" title="asyncio.loop.run_in_executor"><code class="xref py py-meth docutils literal notranslate"><span class="pre">loop.run_in_executor()</span></code></a> method for more326details.</p>327</section>328<section id="logging">329<span id="asyncio-logger"></span><h2>Logging<a class="headerlink" href="#logging" title="Link to this heading">¶</a></h2>330<p>asyncio uses the <a class="reference internal" href="logging.html#module-logging" title="logging: Flexible event logging system for applications."><code class="xref py py-mod docutils literal notranslate"><span class="pre">logging</span></code></a> module and all logging is performed331via the <code class="docutils literal notranslate"><span class="pre">&quot;asyncio&quot;</span></code> logger.</p>332<p>The default log level is <a class="reference internal" href="logging.html#logging.INFO" title="logging.INFO"><code class="xref py py-const docutils literal notranslate"><span class="pre">logging.INFO</span></code></a>, which can be easily333adjusted:</p>334<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;asyncio&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">WARNING</span><span class="p">)</span>335</pre></div>336</div>337<p>Network logging can block the event loop. It is recommended to use338a separate thread for handling logs or use non-blocking IO. For example,339see <a class="reference internal" href="../howto/logging-cookbook.html#blocking-handlers"><span class="std std-ref">Dealing with handlers that block</span></a>.</p>340</section>341<section id="detect-never-awaited-coroutines">342<span id="asyncio-coroutine-not-scheduled"></span><h2>Detect never-awaited coroutines<a class="headerlink" href="#detect-never-awaited-coroutines" title="Link to this heading">¶</a></h2>343<p>When a coroutine function is called, but not awaited344(e.g. <code class="docutils literal notranslate"><span class="pre">coro()</span></code> instead of <code class="docutils literal notranslate"><span class="pre">await</span> <span class="pre">coro()</span></code>)345or the coroutine is not scheduled with <a class="reference internal" href="asyncio-task.html#asyncio.create_task" title="asyncio.create_task"><code class="xref py py-meth docutils literal notranslate"><span class="pre">asyncio.create_task()</span></code></a>, asyncio346will emit a <a class="reference internal" href="exceptions.html#RuntimeWarning" title="RuntimeWarning"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeWarning</span></code></a>:</p>347<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">asyncio</span>348 349<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">test</span><span class="p">():</span>350    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;never scheduled&quot;</span><span class="p">)</span>351 352<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">():</span>353    <span class="n">test</span><span class="p">()</span>354 355<span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">main</span><span class="p">())</span>356</pre></div>357</div>358<p>Output:</p>359<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">test</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">7</span><span class="p">:</span> <span class="ne">RuntimeWarning</span><span class="p">:</span> <span class="n">coroutine</span> <span class="s1">&#39;test&#39;</span> <span class="n">was</span> <span class="n">never</span> <span class="n">awaited</span>360  <span class="n">test</span><span class="p">()</span>361</pre></div>362</div>363<p>Output in debug mode:</p>364<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">test</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">7</span><span class="p">:</span> <span class="ne">RuntimeWarning</span><span class="p">:</span> <span class="n">coroutine</span> <span class="s1">&#39;test&#39;</span> <span class="n">was</span> <span class="n">never</span> <span class="n">awaited</span>365<span class="n">Coroutine</span> <span class="n">created</span> <span class="n">at</span> <span class="p">(</span><span class="n">most</span> <span class="n">recent</span> <span class="n">call</span> <span class="n">last</span><span class="p">)</span>366  <span class="n">File</span> <span class="s2">&quot;../t.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">9</span><span class="p">,</span> <span class="ow">in</span> <span class="o">&lt;</span><span class="n">module</span><span class="o">&gt;</span>367    <span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">main</span><span class="p">(),</span> <span class="n">debug</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>368 369  <span class="o">&lt;</span> <span class="o">..</span> <span class="o">&gt;</span>370 371  <span class="n">File</span> <span class="s2">&quot;../t.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">7</span><span class="p">,</span> <span class="ow">in</span> <span class="n">main</span>372    <span class="n">test</span><span class="p">()</span>373  <span class="n">test</span><span class="p">()</span>374</pre></div>375</div>376<p>The usual fix is to either await the coroutine or call the377<a class="reference internal" href="asyncio-task.html#asyncio.create_task" title="asyncio.create_task"><code class="xref py py-meth docutils literal notranslate"><span class="pre">asyncio.create_task()</span></code></a> function:</p>378<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">():</span>379    <span class="k">await</span> <span class="n">test</span><span class="p">()</span>380</pre></div>381</div>382</section>383<section id="detect-never-retrieved-exceptions">384<h2>Detect never-retrieved exceptions<a class="headerlink" href="#detect-never-retrieved-exceptions" title="Link to this heading">¶</a></h2>385<p>If a <a class="reference internal" href="asyncio-future.html#asyncio.Future.set_exception" title="asyncio.Future.set_exception"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Future.set_exception()</span></code></a> is called but the Future object is386never awaited on, the exception would never be propagated to the387user code.  In this case, asyncio would emit a log message when the388Future object is garbage collected.</p>389<p>Example of an unhandled exception:</p>390<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">asyncio</span>391 392<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">bug</span><span class="p">():</span>393    <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;not consumed&quot;</span><span class="p">)</span>394 395<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">():</span>396    <span class="n">asyncio</span><span class="o">.</span><span class="n">create_task</span><span class="p">(</span><span class="n">bug</span><span class="p">())</span>397 398<span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">main</span><span class="p">())</span>399</pre></div>400</div>401<p>Output:</p>402<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">Task</span> <span class="n">exception</span> <span class="n">was</span> <span class="n">never</span> <span class="n">retrieved</span>403<span class="n">future</span><span class="p">:</span> <span class="o">&lt;</span><span class="n">Task</span> <span class="n">finished</span> <span class="n">coro</span><span class="o">=&lt;</span><span class="n">bug</span><span class="p">()</span> <span class="n">done</span><span class="p">,</span> <span class="n">defined</span> <span class="n">at</span> <span class="n">test</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">3</span><span class="o">&gt;</span>404  <span class="n">exception</span><span class="o">=</span><span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;not consumed&#39;</span><span class="p">)</span><span class="o">&gt;</span>405 406<span class="n">Traceback</span> <span class="p">(</span><span class="n">most</span> <span class="n">recent</span> <span class="n">call</span> <span class="n">last</span><span class="p">):</span>407  <span class="n">File</span> <span class="s2">&quot;test.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">4</span><span class="p">,</span> <span class="ow">in</span> <span class="n">bug</span>408    <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;not consumed&quot;</span><span class="p">)</span>409<span class="ne">Exception</span><span class="p">:</span> <span class="ow">not</span> <span class="n">consumed</span>410</pre></div>411</div>412<p><a class="reference internal" href="#asyncio-debug-mode"><span class="std std-ref">Enable the debug mode</span></a> to get the413traceback where the task was created:</p>414<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">main</span><span class="p">(),</span> <span class="n">debug</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>415</pre></div>416</div>417<p>Output in debug mode:</p>418<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">Task</span> <span class="n">exception</span> <span class="n">was</span> <span class="n">never</span> <span class="n">retrieved</span>419<span class="n">future</span><span class="p">:</span> <span class="o">&lt;</span><span class="n">Task</span> <span class="n">finished</span> <span class="n">coro</span><span class="o">=&lt;</span><span class="n">bug</span><span class="p">()</span> <span class="n">done</span><span class="p">,</span> <span class="n">defined</span> <span class="n">at</span> <span class="n">test</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">3</span><span class="o">&gt;</span>420    <span class="n">exception</span><span class="o">=</span><span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;not consumed&#39;</span><span class="p">)</span> <span class="n">created</span> <span class="n">at</span> <span class="n">asyncio</span><span class="o">/</span><span class="n">tasks</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">321</span><span class="o">&gt;</span>421 422<span class="n">source_traceback</span><span class="p">:</span> <span class="n">Object</span> <span class="n">created</span> <span class="n">at</span> <span class="p">(</span><span class="n">most</span> <span class="n">recent</span> <span class="n">call</span> <span class="n">last</span><span class="p">):</span>423  <span class="n">File</span> <span class="s2">&quot;../t.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">9</span><span class="p">,</span> <span class="ow">in</span> <span class="o">&lt;</span><span class="n">module</span><span class="o">&gt;</span>424    <span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">main</span><span class="p">(),</span> <span class="n">debug</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>425 426<span class="o">&lt;</span> <span class="o">..</span> <span class="o">&gt;</span>427 428<span class="n">Traceback</span> <span class="p">(</span><span class="n">most</span> <span class="n">recent</span> <span class="n">call</span> <span class="n">last</span><span class="p">):</span>429  <span class="n">File</span> <span class="s2">&quot;../t.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">4</span><span class="p">,</span> <span class="ow">in</span> <span class="n">bug</span>430    <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;not consumed&quot;</span><span class="p">)</span>431<span class="ne">Exception</span><span class="p">:</span> <span class="ow">not</span> <span class="n">consumed</span>432</pre></div>433</div>434</section>435</section>436 437 438            <div class="clearer"></div>439          </div>440        </div>441      </div>442      <div class="sphinxsidebar" role="navigation" aria-label="Main">443        <div class="sphinxsidebarwrapper">444  <div>445    <h3><a href="../contents.html">Table of Contents</a></h3>446    <ul>447<li><a class="reference internal" href="#">Developing with asyncio</a><ul>448<li><a class="reference internal" href="#debug-mode">Debug Mode</a></li>449<li><a class="reference internal" href="#concurrency-and-multithreading">Concurrency and Multithreading</a></li>450<li><a class="reference internal" href="#running-blocking-code">Running Blocking Code</a></li>451<li><a class="reference internal" href="#logging">Logging</a></li>452<li><a class="reference internal" href="#detect-never-awaited-coroutines">Detect never-awaited coroutines</a></li>453<li><a class="reference internal" href="#detect-never-retrieved-exceptions">Detect never-retrieved exceptions</a></li>454</ul>455</li>456</ul>457 458  </div>459  <div>460    <h4>Previous topic</h4>461    <p class="topless"><a href="asyncio-llapi-index.html"462                          title="previous chapter">Low-level API Index</a></p>463  </div>464  <div>465    <h4>Next topic</h4>466    <p class="topless"><a href="socket.html"467                          title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">socket</span></code> — Low-level networking interface</a></p>468  </div>469  <script>470    document.addEventListener('DOMContentLoaded', () => {471        const title = document.querySelector('meta[property="og:title"]').content;472        const elements = document.querySelectorAll('.improvepage');473        const pageurl = window.location.href.split('?')[0];474        elements.forEach(element => {475            const url = new URL(element.href.split('?')[0].replace("-nojs", ""));476            url.searchParams.set('pagetitle', title);477            url.searchParams.set('pageurl', pageurl);478            url.searchParams.set('pagesource', "library/asyncio-dev.rst");479            element.href = url.toString();480        });481    });482  </script>483  <div role="note" aria-label="source link">484    <h3>This page</h3>485    <ul class="this-page-menu">486      <li><a href="../bugs.html">Report a bug</a></li>487      <li><a class="improvepage" href="../improve-page-nojs.html">Improve this page</a></li>488      <li>489        <a href="https://github.com/python/cpython/blob/main/Doc/library/asyncio-dev.rst?plain=1"490            rel="nofollow">Show source491        </a>492      </li>493      494    </ul>495  </div>496        </div>497<div id="sidebarbutton" title="Collapse sidebar">498<span>«</span>499</div>500 501      </div>502      <div class="clearer"></div>503    </div>  504    <div class="related" role="navigation" aria-label="Related">505      <h3>Navigation</h3>506      <ul>507        <li class="right" style="margin-right: 10px">508          <a href="../genindex.html" title="General Index"509             >index</a></li>510        <li class="right" >511          <a href="../py-modindex.html" title="Python Module Index"512             >modules</a> |</li>513        <li class="right" >514          <a href="socket.html" title="socket — Low-level networking interface"515             >next</a> |</li>516        <li class="right" >517          <a href="asyncio-llapi-index.html" title="Low-level API Index"518             >previous</a> |</li>519 520          <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>521          <li><a href="https://www.python.org/">Python</a> &#187;</li>522          <li class="switchers">523            <div class="language_switcher_placeholder"></div>524            <div class="version_switcher_placeholder"></div>525          </li>526          <li>527              528          </li>529    <li id="cpython-language-and-version">530      <a href="../index.html">3.15.0a6 Documentation</a> &#187;531    </li>532 533          <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>534          <li class="nav-item nav-item-2"><a href="ipc.html" >Networking and Interprocess Communication</a> &#187;</li>535          <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>536        <li class="nav-item nav-item-this"><a href="">Developing with asyncio</a></li>537                <li class="right">538                    539 540    <div class="inline-search" role="search">541        <form class="inline-search" action="../search.html" method="get">542          <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">543          <input type="submit" value="Go">544        </form>545    </div>546                     |547                </li>548            <li class="right">549<label class="theme-selector-label">550    Theme551    <select class="theme-selector" oninput="activateTheme(this.value)">552        <option value="auto" selected>Auto</option>553        <option value="light">Light</option>554        <option value="dark">Dark</option>555    </select>556</label> |</li>557            558      </ul>559    </div>  560    <div class="footer">561    &copy; <a href="../copyright.html">Copyright</a> 2001 Python Software Foundation.562    <br>563    This page is licensed under the Python Software Foundation License Version 2.564    <br>565    Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.566    <br>567    568      See <a href="/license.html">History and License</a> for more information.<br>569    570    571    <br>572 573    The Python Software Foundation is a non-profit corporation.574<a href="https://www.python.org/psf/donations/">Please donate.</a>575<br>576    <br>577      Last updated on Mar 10, 2026 (08:58 UTC).578    579      <a href="/bugs.html">Found a bug</a>?580    581    <br>582 583    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.584    </div>585 586  </body>587</html>