CINXE.COM

<!doctype html> <html class="no-js" lang="en" data-content_root="../"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="gevent.thread – Implementation of the standard thread module that spawns greenlets" href="gevent.thread.html" /><link rel="prev" title="gevent.signal – Cooperative implementation of special cases of signal.signal()" href="gevent.signal.html" />  <title>gevent.subprocess – Cooperative subprocess module - gevent 24.11.2.dev0 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a3258c64" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> <link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e405f49d" /> <style> body { --color-code-background: #eeeedd; --color-code-foreground: black; --color-brand-primary: #7c9a5e; --color-brand-content: #7c9a5e; --color-foreground-border: #b7d897; --font-stack: "SF Pro",-apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji"; --font-stack--monospace: "JetBrainsMono", "JetBrains Mono", "JetBrains Mono Regular", "JetBrainsMono-Regular", ui-monospace, profont, monospace; } @media not print { body[data-theme="dark"] { --color-code-background: #202020; --color-code-foreground: #d0d0d0; } @media (prefers-color-scheme: dark) { body:not([data-theme="light"]) { --color-code-background: #202020; --color-code-foreground: #d0d0d0; } } } </style><script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="python-gevent" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/api/gevent.subprocess.html" /><meta name="readthedocs-http-status" content="200" /></head> <body> <script> document.body.dataset.theme = localStorage.getItem("theme") || "auto"; </script> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-toc" viewBox="0 0 24 24"> <title>Contents</title> <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line> <line x1="3" y1="6" x2="21" y2="6"></line> <line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <symbol id="svg-sun" viewBox="0 0 24 24"> <title>Light mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> <circle cx="12" cy="12" r="5"></circle> <line x1="12" y1="1" x2="12" y2="3"></line> <line x1="12" y1="21" x2="12" y2="23"></line> <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> <line x1="1" y1="12" x2="3" y2="12"></line> <line x1="21" y1="12" x2="23" y2="12"></line> <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> </svg> </symbol> <symbol id="svg-moon" viewBox="0 0 24 24"> <title>Dark mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> <path stroke="none" d="M0 0h24v24H0z" fill="none" /> <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> </svg> </symbol> <symbol id="svg-sun-with-moon" viewBox="0 0 24 24"> <title>Auto light/dark, in light mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-custom-derived-from-feather-sun-and-tabler-moon"> <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/> <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/> <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/> <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/> <line x1="19" y1="14.05" x2="20.414" y2="15.464"/> <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/> <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/> <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/> <line x1="19" y1="5.05" x2="20.414" y2="3.636"/> <circle cx="14.5" cy="9.55" r="3.6"/> </svg> </symbol> <symbol id="svg-moon-with-sun" viewBox="0 0 24 24"> <title>Auto light/dark, in dark mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-custom-derived-from-feather-sun-and-tabler-moon"> <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/> <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/> <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/> <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/> <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/> <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/> <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/> <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/> <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/> <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/> </svg> </symbol> <symbol id="svg-pencil" viewBox="0 0 24 24"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code"> <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" /> <path d="M13.5 6.5l4 4" /> <path d="M20 21l2 -2l-2 -2" /> <path d="M17 17l-2 2l2 2" /> </svg> </symbol> <symbol id="svg-eye" viewBox="0 0 24 24"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code"> <path stroke="none" d="M0 0h24v24H0z" fill="none" /> <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" /> <path d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" /> <path d="M20 21l2 -2l-2 -2" /> <path d="M17 17l-2 2l2 2" /> </svg> </symbol> </svg> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> <label class="overlay sidebar-overlay" for="__navigation"> <div class="visually-hidden">Hide navigation sidebar</div> </label> <label class="overlay toc-overlay" for="__toc"> <div class="visually-hidden">Hide table of contents sidebar</div> </label> <a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a> <div class="page"> <header class="mobile-header"> <div class="header-left"> <label class="nav-overlay-icon" for="__navigation"> <div class="visually-hidden">Toggle site navigation sidebar</div> <svg><use href="#svg-menu"></use></svg> </label> </div> <div class="header-center"> <a href="../contents.html"><div class="brand">gevent 24.11.2.dev0 documentation</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> <label class="toc-overlay-icon toc-header-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <svg><use href="#svg-toc"></use></svg> </label> </div> </header> <aside class="sidebar-drawer"> <div class="sidebar-container"> <div class="sidebar-sticky"><a class="sidebar-brand" href="../contents.html"> <div class="sidebar-logo-container"> <img class="sidebar-logo" src="../_static/5564530.png" alt="Logo"/> </div> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> <input type="hidden" name="check_keywords" value="yes"> <input type="hidden" name="area" value="default"> </form> <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> <ul> <li class="toctree-l1"><a class="reference internal" href="../install.html">Installation and Requirements</a></li> <li class="toctree-l1 has-children"><a class="reference internal" href="../changelog.html">Changelog</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Changelog</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l2"><a class="reference internal" href="../changelog_1_5.html">Changes for 1.5</a></li> <li class="toctree-l2"><a class="reference internal" href="../changelog_1_4.html">Changes for 1.4</a></li> <li class="toctree-l2"><a class="reference internal" href="../changelog_1_3.html">Changes for 1.3</a></li> <li class="toctree-l2"><a class="reference internal" href="../changelog_1_2.html">Changes for 1.2</a></li> <li class="toctree-l2"><a class="reference internal" href="../changelog_1_1.html">Changes for 1.1</a></li> <li class="toctree-l2"><a class="reference internal" href="../changelog_1_0.html">Changes for 1.0</a></li> <li class="toctree-l2"><a class="reference internal" href="../changelog_pre.html">Changes before gevent 1.0</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../intro.html">Introduction</a></li> <li class="toctree-l1"><a class="reference internal" href="gevent.html"><code class="xref py py-mod docutils literal notranslate">gevent</code> – common functions</a></li> <li class="toctree-l1"><a class="reference internal" href="gevent.greenlet.html">Greenlet Objects</a></li> <li class="toctree-l1"><a class="reference internal" href="../servers.html">Implementing servers</a></li> <li class="toctree-l1 has-children"><a class="reference internal" href="../dns.html">Name Resolution (DNS)</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Name Resolution (DNS)</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l2"><a class="reference internal" href="gevent.resolver.thread.html"><code class="xref py py-mod docutils literal notranslate">gevent.resolver.thread</code> – thread based hostname resolver</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.resolver.ares.html"><code class="xref py py-mod docutils literal notranslate">gevent.resolver.ares</code> – c-ares based hostname resolver</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.resolver.dnspython.html"><code class="xref py py-mod docutils literal notranslate">gevent.resolver.dnspython</code> – Pure Python hostname resolver</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.resolver.blocking.html"><code class="xref py py-mod docutils literal notranslate">gevent.resolver.blocking</code> – Non-cooperative resolver</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../monitoring.html">Monitoring and Debugging gevent Applications</a></li> <li class="toctree-l1"><a class="reference internal" href="../loop_impls.html">Event Loop Implementations: libuv and libev</a></li> <li class="toctree-l1"><a class="reference internal" href="../configuration.html">Configuring gevent</a></li> </ul> <ul class="current"> <li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">API reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of API reference</div><svg><use href="#svg-arrow-right"></use></svg></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="gevent.html"><code class="xref py py-mod docutils literal notranslate">gevent</code> – common functions</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.timeout.html">Cooperative Timeouts Using <code class="docutils literal notranslate">gevent.Timeout</code></a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.greenlet.html">Greenlet Objects</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="gevent.socket.html"><code class="xref py py-mod docutils literal notranslate">gevent.socket</code> – Cooperative low-level networking interface</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of gevent.socket – Cooperative low-level networking interface</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l3"><a class="reference internal" href="gevent._socket3.html">Python 3 interface</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="gevent.ssl.html"><code class="xref py py-mod docutils literal notranslate">gevent.ssl</code> – Secure Sockets Layer (SSL/TLS) module</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.select.html"><code class="xref py py-mod docutils literal notranslate">gevent.select</code> – Waiting for I/O completion</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.selectors.html"><code class="xref py py-mod docutils literal notranslate">gevent.selectors</code> – High-level IO Multiplexing</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.event.html"><code class="xref py py-mod docutils literal notranslate">gevent.event</code> – Notifications of multiple listeners</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.queue.html"><code class="xref py py-mod docutils literal notranslate">gevent.queue</code> – Synchronized queues</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.local.html"><code class="xref py py-mod docutils literal notranslate">gevent.local</code> – Greenlet-local objects</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.lock.html"><code class="xref py py-mod docutils literal notranslate">gevent.lock</code> – Locking primitives</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.hub.html"><code class="docutils literal notranslate">gevent.hub</code> - The Event Loop and the Hub</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.core.html"><code class="xref py py-mod docutils literal notranslate">gevent.core</code> - (deprecated) event loop abstraction</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.html"><code class="xref py py-mod docutils literal notranslate">gevent</code> – common functions</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.backdoor.html"><code class="xref py py-mod docutils literal notranslate">gevent.backdoor</code> – Interactive greenlet-based network console that can be used in any process</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.baseserver.html"><code class="xref py py-mod docutils literal notranslate">gevent.baseserver</code> – Base class for implementing servers</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.builtins.html"><code class="xref py py-mod docutils literal notranslate">gevent.builtins</code> – gevent friendly implementations of builtin functions</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.contextvars.html"><code class="xref py py-mod docutils literal notranslate">gevent.contextvars</code> – Cooperative <code class="docutils literal notranslate">contextvars</code></a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.core.html"><code class="xref py py-mod docutils literal notranslate">gevent.core</code> - (deprecated) event loop abstraction</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.event.html"><code class="xref py py-mod docutils literal notranslate">gevent.event</code> – Notifications of multiple listeners</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.events.html"><code class="xref py py-mod docutils literal notranslate">gevent.events</code> – Publish/subscribe event infrastructure</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.exceptions.html"><code class="xref py py-mod docutils literal notranslate">gevent.exceptions</code> – Exceptions</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.fileobject.html"><code class="xref py py-mod docutils literal notranslate">gevent.fileobject</code> – Wrappers to make file-like objects cooperative</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.hub.html"><code class="docutils literal notranslate">gevent.hub</code> - The Event Loop and the Hub</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.local.html"><code class="xref py py-mod docutils literal notranslate">gevent.local</code> – Greenlet-local objects</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.lock.html"><code class="xref py py-mod docutils literal notranslate">gevent.lock</code> – Locking primitives</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.monkey.html"><code class="xref py py-mod docutils literal notranslate">gevent.monkey</code> – Make the standard library cooperative</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.os.html"><code class="xref py py-mod docutils literal notranslate">gevent.os</code> – Low-level operating system functions from <code class="xref py py-mod docutils literal notranslate">os</code></a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.pool.html"><code class="xref py py-mod docutils literal notranslate">gevent.pool</code> – Managing greenlets in a group</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.pywsgi.html"><code class="xref py py-mod docutils literal notranslate">gevent.pywsgi</code> – A pure-Python, gevent-friendly WSGI server</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.queue.html"><code class="xref py py-mod docutils literal notranslate">gevent.queue</code> – Synchronized queues</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.resolver.ares.html"><code class="xref py py-mod docutils literal notranslate">gevent.resolver.ares</code> – c-ares based hostname resolver</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.resolver.blocking.html"><code class="xref py py-mod docutils literal notranslate">gevent.resolver.blocking</code> – Non-cooperative resolver</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.resolver.dnspython.html"><code class="xref py py-mod docutils literal notranslate">gevent.resolver.dnspython</code> – Pure Python hostname resolver</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.resolver.thread.html"><code class="xref py py-mod docutils literal notranslate">gevent.resolver.thread</code> – thread based hostname resolver</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.select.html"><code class="xref py py-mod docutils literal notranslate">gevent.select</code> – Waiting for I/O completion</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.selectors.html"><code class="xref py py-mod docutils literal notranslate">gevent.selectors</code> – High-level IO Multiplexing</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.server.html"><code class="xref py py-mod docutils literal notranslate">gevent.server</code> – TCP/SSL server</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.signal.html"><code class="xref py py-mod docutils literal notranslate">gevent.signal</code> – Cooperative implementation of special cases of <code class="xref py py-func docutils literal notranslate">signal.signal()</code></a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="gevent.socket.html"><code class="xref py py-mod docutils literal notranslate">gevent.socket</code> – Cooperative low-level networking interface</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of gevent.socket – Cooperative low-level networking interface</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l3"><a class="reference internal" href="gevent._socket3.html">Python 3 interface</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="gevent.ssl.html"><code class="xref py py-mod docutils literal notranslate">gevent.ssl</code> – Secure Sockets Layer (SSL/TLS) module</a></li> <li class="toctree-l2 current current-page"><a class="current reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">gevent.subprocess</code> – Cooperative <code class="docutils literal notranslate">subprocess</code> module</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.thread.html"><code class="xref py py-mod docutils literal notranslate">gevent.thread</code> – Implementation of the standard <code class="xref py py-mod docutils literal notranslate">thread</code> module that spawns greenlets</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.threading.html"><code class="xref py py-mod docutils literal notranslate">gevent.threading</code> – Implementation of the standard <code class="xref py py-mod docutils literal notranslate">threading</code> using greenlets</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.threadpool.html"><code class="xref py py-mod docutils literal notranslate">gevent.threadpool</code> - A pool of native threads</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.time.html"><code class="xref py py-mod docutils literal notranslate">gevent.time</code> – Makes sleep gevent aware</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.util.html"><code class="xref py py-mod docutils literal notranslate">gevent.util</code> – Low-level utilities</a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.ares.html"><code class="xref py py-mod docutils literal notranslate">gevent.ares</code> – Backwards compatibility alias for <code class="xref py py-mod docutils literal notranslate">gevent.resolver.cares</code></a></li> <li class="toctree-l2"><a class="reference internal" href="gevent.wsgi.html"><code class="docutils literal notranslate">gevent.wsgi</code> – Historical note only; does not exist</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Examples</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l3"><a class="reference internal" href="../examples/concurrent_download.html">Example concurrent_download.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/dns_mass_resolve.html">Example dns_mass_resolve.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/echoserver.html">Example echoserver.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/geventsendfile.html">Example geventsendfile.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/portforwarder.html">Example portforwarder.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/processes.html">Example processes.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/psycopg2_pool.html">Example psycopg2_pool.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/threadpool.html">Example threadpool.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/udp_client.html">Example udp_client.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/udp_server.html">Example udp_server.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/unixsocket_client.html">Example unixsocket_client.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/unixsocket_server.html">Example unixsocket_server.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/webproxy.html">Example webproxy.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/webpy.html">Example webpy.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/wsgiserver.html">Example wsgiserver.py</a></li> <li class="toctree-l3"><a class="reference internal" href="../examples/wsgiserver_ssl.html">Example wsgiserver_ssl.py</a></li> </ul> </li> </ul> </li> </ul> <ul> <li class="toctree-l1 has-children"><a class="reference internal" href="../development/index.html">Development</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of Development</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l2"><a class="reference internal" href="../development/getting_started.html">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/installing_from_source.html">Installing From Source</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/running_tests.html">Running Tests</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/ci.html">Continuous integration</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/release_process.html">Release Process</a></li> </ul> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../success.html">Success stories</a></li> <li class="toctree-l1"><a class="reference internal" href="../community.html">Community</a></li> <li class="toctree-l1 has-children"><a class="reference internal" href="../older_releases.html">Information About Older Releases</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of Information About Older Releases</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l2 has-children"><a class="reference internal" href="../whatsnew_1_5.html">What’s new in gevent 1.5</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle navigation of What’s new in gevent 1.5</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l3"><a class="reference internal" href="../changelog_1_5.html">Changes for 1.5</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../whatsnew_1_4.html">What’s new in gevent 1.4</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle navigation of What’s new in gevent 1.4</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l3"><a class="reference internal" href="../changelog_1_4.html">Changes for 1.4</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../whatsnew_1_3.html">What’s new in gevent 1.3</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><div class="visually-hidden">Toggle navigation of What’s new in gevent 1.3</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l3"><a class="reference internal" href="../changelog_1_3.html">Changes for 1.3</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../whatsnew_1_2.html">What’s new in gevent 1.2</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><div class="visually-hidden">Toggle navigation of What’s new in gevent 1.2</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l3"><a class="reference internal" href="../changelog_1_2.html">Changes for 1.2</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../whatsnew_1_1.html">What’s new in gevent 1.1</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><div class="visually-hidden">Toggle navigation of What’s new in gevent 1.1</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l3"><a class="reference internal" href="../changelog_1_1.html">Changes for 1.1</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../whatsnew_1_0.html">What’s new in gevent 1.0</a><input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" role="switch" type="checkbox"/><label for="toctree-checkbox-14"><div class="visually-hidden">Toggle navigation of What’s new in gevent 1.0</div><svg><use href="#svg-arrow-right"></use></svg></label><ul> <li class="toctree-l3"><a class="reference internal" href="../changelog_1_0.html">Changes for 1.0</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../changelog_1_5.html">Changes for 1.5</a></li> <li class="toctree-l2"><a class="reference internal" href="../changelog_1_4.html">Changes for 1.4</a></li> <li class="toctree-l2"><a class="reference internal" href="../changelog_1_3.html">Changes for 1.3</a></li> <li class="toctree-l2"><a class="reference internal" href="../changelog_1_2.html">Changes for 1.2</a></li> <li class="toctree-l2"><a class="reference internal" href="../changelog_1_1.html">Changes for 1.1</a></li> <li class="toctree-l2"><a class="reference internal" href="../changelog_1_0.html">Changes for 1.0</a></li> <li class="toctree-l2"><a class="reference internal" href="../changelog_pre.html">Changes before gevent 1.0</a></li> </ul> </li> </ul> </div> </div> </div> </div> </aside> <div class="main"> <div class="content"> <div class="article-container"> <a href="#" class="back-to-top muted-link"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> </svg> Back to top </a> <div class="content-icon-container"> <div class="theme-toggle-container theme-toggle-content"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> <label class="toc-overlay-icon toc-content-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <svg><use href="#svg-toc"></use></svg> </label> </div> <article role="main" id="furo-main-content"> <section id="module-gevent.subprocess"> <h1><a class="reference internal" href="#module-gevent.subprocess" title="gevent.subprocess"><code class="xref py py-mod docutils literal notranslate">gevent.subprocess</code></a> – Cooperative <code class="docutils literal notranslate">subprocess</code> module<a class="headerlink" href="#module-gevent.subprocess" title="Link to this heading">¶</a></h1> Cooperative <code class="docutils literal notranslate">subprocess</code> module. <div class="admonition caution"> Caution On POSIX platforms, this module is not usable from native threads other than the main thread; attempting to do so will raise a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.13)"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a>. This module depends on libev’s fork watchers. On POSIX systems, fork watchers are implemented using signals, and the thread to which process-directed signals are delivered <a class="reference external" href="http://www.linuxprogrammingblog.com/all-about-linux-signals?page=11">is not defined</a>. Because each native thread has its own gevent/libev loop, this means that a fork watcher registered with one loop (thread) may never see the signal about a child it spawned if the signal is sent to a different thread. </div> <div class="admonition note"> Note The interface of this module is intended to match that of the standard library <a class="reference external" href="https://docs.python.org/3/library/subprocess.html#module-subprocess" title="(in Python v3.13)"><code class="xref py py-mod docutils literal notranslate">subprocess</code></a> module (with many backwards compatible extensions from Python 3 backported to Python 2). There are some small differences between the Python 2 and Python 3 versions of that module (the Python 2 <code class="docutils literal notranslate">TimeoutExpired</code> exception, notably, extends <code class="docutils literal notranslate">Timeout</code> and there is no <code class="docutils literal notranslate">SubprocessError</code>) and between the POSIX and Windows versions. The HTML documentation here can only describe one version; for definitive documentation, see the standard library or the source code. </div> <dl class="py exception"> <dt class="sig sig-object py" id="gevent.subprocess.CalledProcessError"> exception CalledProcessError(returncode, cmd, output=None, stderr=None)<a class="reference internal" href="../_modules/subprocess.html#CalledProcessError">[source]</a><a class="headerlink" href="#gevent.subprocess.CalledProcessError" title="Link to this definition">¶</a></dt> <dd>Bases: <a class="reference internal" href="#gevent.subprocess.SubprocessError" title="subprocess.SubprocessError"><code class="xref py py-class docutils literal notranslate">SubprocessError</code></a> Raised when run() is called with check=True and the process returns a non-zero exit status. <dl class="simple"> <dt>Attributes:</dt><dd>cmd, returncode, stdout, stderr, output </dd> </dl> <dl class="py property"> <dt class="sig sig-object py" id="gevent.subprocess.CalledProcessError.stdout"> property stdout<a class="headerlink" href="#gevent.subprocess.CalledProcessError.stdout" title="Link to this definition">¶</a></dt> <dd>Alias for output attribute, to match stderr </dd></dl> </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="gevent.subprocess.SubprocessError"> exception SubprocessError<a class="reference internal" href="../_modules/subprocess.html#SubprocessError">[source]</a><a class="headerlink" href="#gevent.subprocess.SubprocessError" title="Link to this definition">¶</a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">Exception</code></a> </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="gevent.subprocess.TimeoutExpired"> exception TimeoutExpired(cmd, timeout, output=None, stderr=None)<a class="reference internal" href="../_modules/subprocess.html#TimeoutExpired">[source]</a><a class="headerlink" href="#gevent.subprocess.TimeoutExpired" title="Link to this definition">¶</a></dt> <dd>Bases: <a class="reference internal" href="#gevent.subprocess.SubprocessError" title="subprocess.SubprocessError"><code class="xref py py-class docutils literal notranslate">SubprocessError</code></a> This exception is raised when the timeout expires while waiting for a child process. <dl class="simple"> <dt>Attributes:</dt><dd>cmd, output, stdout, stderr, timeout </dd> </dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="gevent.subprocess.CompletedProcess"> class CompletedProcess(args, returncode, stdout=None, stderr=None)<a class="reference internal" href="../_modules/gevent/subprocess.html#CompletedProcess">[source]</a><a class="headerlink" href="#gevent.subprocess.CompletedProcess" title="Link to this definition">¶</a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">object</code></a> A process that has finished running. This is returned by run(). <dl class="simple"> <dt>Attributes:</dt><dd><ul class="simple"> <li>args: The list or str args passed to run().</li> <li>returncode: The exit code of the process, negative for signals.</li> <li>stdout: The standard output (None if not captured).</li> <li>stderr: The standard error (None if not captured).</li> </ul> </dd> </dl> <div class="versionadded"> Added in version 1.2a1: This first appeared in Python 3.5 and is available to all Python versions in gevent. </div> <dl class="py method"> <dt class="sig sig-object py" id="gevent.subprocess.CompletedProcess.check_returncode"> check_returncode()<a class="reference internal" href="../_modules/gevent/subprocess.html#CompletedProcess.check_returncode">[source]</a><a class="headerlink" href="#gevent.subprocess.CompletedProcess.check_returncode" title="Link to this definition">¶</a></dt> <dd>Raise CalledProcessError if the exit code is non-zero. </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="gevent.subprocess.Popen"> class Popen(args, bufsize=-1, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=<object object>, shell=False, cwd=None, env=None, universal_newlines=None, startupinfo=None, creationflags=0, restore_signals=True, start_new_session=False, pass_fds=(), encoding=None, errors=None, text=None, group=None, extra_groups=None, user=None, umask=-1, pipesize=-1, process_group=None, threadpool=None)<a class="reference internal" href="../_modules/gevent/subprocess.html#Popen">[source]</a><a class="headerlink" href="#gevent.subprocess.Popen" title="Link to this definition">¶</a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">object</code></a> The underlying process creation and management in this module is handled by the Popen class. It offers a lot of flexibility so that developers are able to handle the less common cases not covered by the convenience functions. <div class="admonition seealso"> See also <a class="reference external" href="https://docs.python.org/3/library/subprocess.html#subprocess.Popen" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate">subprocess.Popen</code></a> This class should have the same interface as the standard library class. </div> <div class="admonition caution"> Caution The default values of some arguments, notably <code class="docutils literal notranslate">buffering</code>, differ between Python 2 and Python 3. For the most consistent behaviour across versions, it’s best to explicitly pass the desired values. </div> <div class="admonition caution"> Caution On Python 2, the <code class="docutils literal notranslate">read</code> method of the <code class="docutils literal notranslate">stdout</code> and <code class="docutils literal notranslate">stderr</code> attributes will not be buffered unless buffering is explicitly requested (e.g., <code class="xref py py-obj docutils literal notranslate">bufsize=-1</code>). This is different than the <code class="docutils literal notranslate">read</code> method of the standard library attributes, which will buffer internally even if no buffering has been requested. This matches the Python 3 behaviour. For portability, please explicitly request buffering if you want <code class="docutils literal notranslate">read(n)</code> to return all <code class="docutils literal notranslate">n</code> bytes, making more than one system call if needed. See <a class="reference external" href="https://github.com/gevent/gevent/issues/1701">issue 1701</a> for more context. </div> <div class="versionchanged"> Changed in version 1.2a1: Instances can now be used as context managers under Python 2.7. Previously this was restricted to Python 3. </div> <div class="versionchanged"> Changed in version 1.2a1: Instances now save the <code class="docutils literal notranslate">args</code> attribute under Python 2.7. Previously this was restricted to Python 3. </div> <div class="versionchanged"> Changed in version 1.2b1: Add the <code class="docutils literal notranslate">encoding</code> and <code class="docutils literal notranslate">errors</code> parameters for Python 3. </div> <div class="versionchanged"> Changed in version 1.3a1: Accept “path-like” objects for the cwd parameter on all platforms. This was added to Python 3.6. Previously with gevent, it only worked on POSIX platforms on 3.6. </div> <div class="versionchanged"> Changed in version 1.3a1: Add the <code class="docutils literal notranslate">text</code> argument as a synonym for <code class="docutils literal notranslate">universal_newlines</code>, as added on Python 3.7. </div> <div class="versionchanged"> Changed in version 1.3a2: Allow the same keyword arguments under Python 2 as Python 3: <code class="docutils literal notranslate">pass_fds</code>, <code class="docutils literal notranslate">start_new_session</code>, <code class="docutils literal notranslate">restore_signals</code>, <code class="docutils literal notranslate">encoding</code> and <code class="docutils literal notranslate">errors</code>. Under Python 2, <code class="docutils literal notranslate">encoding</code> and <code class="docutils literal notranslate">errors</code> are ignored because native handling of universal newlines is used. </div> <div class="versionchanged"> Changed in version 1.3a2: Under Python 2, <code class="docutils literal notranslate">restore_signals</code> defaults to <code class="docutils literal notranslate">False</code>. Previously it defaulted to <code class="docutils literal notranslate">True</code>, the same as it did in Python 3. </div> <div class="versionchanged"> Changed in version 20.6.0: Add the group, extra_groups, user, and umask arguments. These were added to Python 3.9, but are available in any gevent version, provided the underlying platform support is present. </div> <div class="versionchanged"> Changed in version 20.12.0: On Python 2 only, if unbuffered binary communication is requested, the <code class="docutils literal notranslate">stdin</code> attribute of this object will have a <code class="docutils literal notranslate">write</code> method that actually performs internal buffering and looping, similar to the standard library. It guarantees to write all the data given to it in a single call (but internally it may make many system calls and/or trips around the event loop to accomplish this). See <a class="extlink-issue reference external" href="https://github.com/gevent/gevent/issues/1711">issue #1711</a>. </div> <div class="versionchanged"> Changed in version 21.12.0: Added the <code class="docutils literal notranslate">pipesize</code> argument for compatibility with Python 3.10. This is ignored on all platforms. </div> <div class="versionchanged"> Changed in version 22.08.0: Added the <code class="docutils literal notranslate">process_group</code> and <code class="docutils literal notranslate">check</code> arguments for compatibility with Python 3.11. </div> <div class="versionchanged"> Changed in version 24.10.1: To match Python 3.13, <code class="docutils literal notranslate">stdout=STDOUT</code> now raises a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>. </div> <dl class="py method"> <dt class="sig sig-object py" id="gevent.subprocess.Popen.communicate"> communicate(input=None, timeout=None)<a class="reference internal" href="../_modules/gevent/subprocess.html#Popen.communicate">[source]</a><a class="headerlink" href="#gevent.subprocess.Popen.communicate" title="Link to this definition">¶</a></dt> <dd>Interact with process and return its output and error. <ul class="simple"> <li>Send input data to stdin.</li> <li>Read data from stdout and stderr, until end-of-file is reached.</li> <li>Wait for process to terminate.</li> </ul> The optional input argument should be a string to be sent to the child process, or None, if no data should be sent to the child. communicate() returns a tuple (stdout, stderr). <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">timeout – Under Python 2, this is a gevent extension; if given and it expires, we will raise <a class="reference internal" href="#gevent.subprocess.TimeoutExpired" title="gevent.subprocess.TimeoutExpired"><code class="xref py py-exc docutils literal notranslate">TimeoutExpired</code></a>, which extends <a class="reference internal" href="gevent.timeout.html#gevent.Timeout" title="gevent.timeout.Timeout"><code class="xref py py-exc docutils literal notranslate">gevent.timeout.Timeout</code></a> (note that this only extends <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#BaseException" title="(in Python v3.13)"><code class="xref py py-exc docutils literal notranslate">BaseException</code></a>, not <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><code class="xref py py-exc docutils literal notranslate">Exception</code></a>) Under Python 3, this raises the standard <a class="reference internal" href="#gevent.subprocess.TimeoutExpired" title="gevent.subprocess.TimeoutExpired"><code class="xref py py-exc docutils literal notranslate">TimeoutExpired</code></a> exception. </dd> </dl> <div class="versionchanged"> Changed in version 1.1a2: Under Python 2, if the timeout elapses, raise the <a class="reference internal" href="gevent.timeout.html#gevent.Timeout" title="gevent.timeout.Timeout"><code class="xref py py-exc docutils literal notranslate">gevent.timeout.Timeout</code></a> exception. Previously, we silently returned. </div> <div class="versionchanged"> Changed in version 1.1b5: Honor a timeout even if there’s no way to communicate with the child (stdin, stdout, and stderr are not pipes). </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="gevent.subprocess.Popen.kill"> kill()<a class="reference internal" href="../_modules/gevent/subprocess.html#Popen.kill">[source]</a><a class="headerlink" href="#gevent.subprocess.Popen.kill" title="Link to this definition">¶</a></dt> <dd>Kill the process with SIGKILL </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="gevent.subprocess.Popen.pipe_cloexec"> pipe_cloexec()<a class="reference internal" href="../_modules/gevent/subprocess.html#Popen.pipe_cloexec">[source]</a><a class="headerlink" href="#gevent.subprocess.Popen.pipe_cloexec" title="Link to this definition">¶</a></dt> <dd>Create a pipe with FDs set CLOEXEC. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="gevent.subprocess.Popen.poll"> poll()<a class="reference internal" href="../_modules/gevent/subprocess.html#Popen.poll">[source]</a><a class="headerlink" href="#gevent.subprocess.Popen.poll" title="Link to this definition">¶</a></dt> <dd>Check if child process has terminated. Set and return <code class="xref py py-attr docutils literal notranslate">returncode</code> attribute. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="gevent.subprocess.Popen.send_signal"> send_signal(sig)<a class="reference internal" href="../_modules/gevent/subprocess.html#Popen.send_signal">[source]</a><a class="headerlink" href="#gevent.subprocess.Popen.send_signal" title="Link to this definition">¶</a></dt> <dd>Send a signal to the process </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="gevent.subprocess.Popen.terminate"> terminate()<a class="reference internal" href="../_modules/gevent/subprocess.html#Popen.terminate">[source]</a><a class="headerlink" href="#gevent.subprocess.Popen.terminate" title="Link to this definition">¶</a></dt> <dd>Terminate the process with SIGTERM </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="gevent.subprocess.Popen.wait"> wait(timeout=None, _raise_exc=True)<a class="reference internal" href="../_modules/gevent/subprocess.html#Popen.wait">[source]</a><a class="headerlink" href="#gevent.subprocess.Popen.wait" title="Link to this definition">¶</a></dt> <dd>Wait for child process to terminate. Returns <code class="xref py py-attr docutils literal notranslate">returncode</code> attribute. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">timeout – The floating point number of seconds to wait. Under Python 2, this is a gevent extension, and we simply return if it expires. Under Python 3, if this time elapses without finishing the process, <a class="reference internal" href="#gevent.subprocess.TimeoutExpired" title="gevent.subprocess.TimeoutExpired"><code class="xref py py-exc docutils literal notranslate">TimeoutExpired</code></a> is raised. </dd> </dl> </dd></dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="gevent.subprocess.call"> call(args, *, stdin=None, stdout=None, stderr=None, shell=False, timeout=None) → returncode<a class="reference internal" href="../_modules/gevent/subprocess.html#call">[source]</a><a class="headerlink" href="#gevent.subprocess.call" title="Link to this definition">¶</a></dt> <dd>Run command with arguments. Wait for command to complete or timeout, then return the returncode attribute. The arguments are the same as for the Popen constructor. Example: <div class="highlight-default notranslate"><div class="highlight"><pre>retcode = call(["ls", "-l"]) </pre></div> </div> <div class="versionchanged"> Changed in version 1.2a1: The <code class="docutils literal notranslate">timeout</code> keyword argument is now accepted on all supported versions of Python (not just Python 3) and if it expires will raise a <a class="reference internal" href="#gevent.subprocess.TimeoutExpired" title="gevent.subprocess.TimeoutExpired"><code class="xref py py-exc docutils literal notranslate">TimeoutExpired</code></a> exception (under Python 2 this is a subclass of <a class="reference internal" href="gevent.timeout.html#gevent.Timeout" title="gevent.Timeout"><code class="xref py py-exc docutils literal notranslate">Timeout</code></a>). </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="gevent.subprocess.check_call"> check_call(args, *, stdin=None, stdout=None, stderr=None, shell=False, timeout=None) → 0<a class="reference internal" href="../_modules/gevent/subprocess.html#check_call">[source]</a><a class="headerlink" href="#gevent.subprocess.check_call" title="Link to this definition">¶</a></dt> <dd>Run command with arguments. Wait for command to complete. If the exit code was zero then return, otherwise raise <a class="reference internal" href="#gevent.subprocess.CalledProcessError" title="gevent.subprocess.CalledProcessError"><code class="xref py py-exc docutils literal notranslate">CalledProcessError</code></a>. The <code class="docutils literal notranslate">CalledProcessError</code> object will have the return code in the returncode attribute. The arguments are the same as for the Popen constructor. Example: <div class="highlight-default notranslate"><div class="highlight"><pre>retcode = check_call(["ls", "-l"]) </pre></div> </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="gevent.subprocess.check_output"> check_output(args, *, input=None, stdin=None, stderr=None, shell=False, universal_newlines=False, timeout=None) → output<a class="reference internal" href="../_modules/gevent/subprocess.html#check_output">[source]</a><a class="headerlink" href="#gevent.subprocess.check_output" title="Link to this definition">¶</a></dt> <dd>Run command with arguments and return its output. If the exit code was non-zero it raises a <a class="reference internal" href="#gevent.subprocess.CalledProcessError" title="gevent.subprocess.CalledProcessError"><code class="xref py py-exc docutils literal notranslate">CalledProcessError</code></a>. The <code class="docutils literal notranslate">CalledProcessError</code> object will have the return code in the returncode attribute and output in the output attribute. The arguments are the same as for the Popen constructor. Example: <div class="highlight-default notranslate"><div class="highlight"><pre>>>> check_output(["ls", "-1", "/dev/null"]) '/dev/null\n' </pre></div> </div> The <code class="docutils literal notranslate">stdout</code> argument is not allowed as it is used internally. To capture standard error in the result, use <code class="docutils literal notranslate">stderr=STDOUT</code>: <div class="highlight-default notranslate"><div class="highlight"><pre>>>> output = check_output(["/bin/sh", "-c", ... "ls -l non_existent_file ; exit 0"], ... stderr=STDOUT).decode('ascii').strip() >>> print(output.rsplit(':', 1)[1].strip()) No such file or directory </pre></div> </div> There is an additional optional argument, “input”, allowing you to pass a string to the subprocess’s stdin. If you use this argument you may not also use the Popen constructor’s “stdin” argument, as it too will be used internally. Example: <div class="highlight-default notranslate"><div class="highlight"><pre>>>> check_output(["sed", "-e", "s/foo/bar/"], ... input=b"when in the course of fooman events\n") 'when in the course of barman events\n' </pre></div> </div> If <code class="docutils literal notranslate">universal_newlines=True</code> is passed, the return value will be a string rather than bytes. <div class="versionchanged"> Changed in version 1.2a1: The <code class="docutils literal notranslate">timeout</code> keyword argument is now accepted on all supported versions of Python (not just Python 3) and if it expires will raise a <a class="reference internal" href="#gevent.subprocess.TimeoutExpired" title="gevent.subprocess.TimeoutExpired"><code class="xref py py-exc docutils literal notranslate">TimeoutExpired</code></a> exception (under Python 2 this is a subclass of <a class="reference internal" href="gevent.timeout.html#gevent.Timeout" title="gevent.Timeout"><code class="xref py py-exc docutils literal notranslate">Timeout</code></a>). </div> <div class="versionchanged"> Changed in version 1.2a1: The <code class="docutils literal notranslate">input</code> keyword argument is now accepted on all supported versions of Python, not just Python 3 </div> <div class="versionchanged"> Changed in version 22.08.0: Passing the <code class="docutils literal notranslate">check</code> keyword argument is forbidden, just as in Python 3.11. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="gevent.subprocess.getoutput"> getoutput(cmd, *, encoding=None, errors=None)<a class="reference internal" href="../_modules/subprocess.html#getoutput">[source]</a><a class="headerlink" href="#gevent.subprocess.getoutput" title="Link to this definition">¶</a></dt> <dd>Return output (stdout or stderr) of executing cmd in a shell. Like getstatusoutput(), except the exit status is ignored and the return value is a string containing the command’s output. Example: <div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> import subprocess >>> subprocess.getoutput('ls /bin/ls') '/bin/ls' </pre></div> </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="gevent.subprocess.getstatusoutput"> getstatusoutput(cmd, *, encoding=None, errors=None)<a class="reference internal" href="../_modules/subprocess.html#getstatusoutput">[source]</a><a class="headerlink" href="#gevent.subprocess.getstatusoutput" title="Link to this definition">¶</a></dt> <dd>Return (exitcode, output) of executing cmd in a shell. Execute the string ‘cmd’ in a shell with ‘check_output’ and return a 2-tuple (status, output). The locale encoding is used to decode the output and process newlines. A trailing newline is stripped from the output. The exit status for the command can be interpreted according to the rules for the function ‘wait’. Example: <div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> import subprocess >>> subprocess.getstatusoutput('ls /bin/ls') (0, '/bin/ls') >>> subprocess.getstatusoutput('cat /bin/junk') (1, 'cat: /bin/junk: No such file or directory') >>> subprocess.getstatusoutput('/bin/junk') (127, 'sh: /bin/junk: not found') >>> subprocess.getstatusoutput('/bin/kill $$') (-15, '') </pre></div> </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="gevent.subprocess.run"> run(args, *, stdin=None, input=None, stdout=None, stderr=None, shell=False, timeout=None, check=False) → <a class="reference internal" href="#gevent.subprocess.CompletedProcess" title="gevent.subprocess.CompletedProcess">CompletedProcess</a><a class="reference internal" href="../_modules/gevent/subprocess.html#run">[source]</a><a class="headerlink" href="#gevent.subprocess.run" title="Link to this definition">¶</a></dt> <dd>Run command with arguments and return a CompletedProcess instance. The returned instance will have attributes args, returncode, stdout and stderr. By default, stdout and stderr are not captured, and those attributes will be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them. If check is True and the exit code was non-zero, it raises a CalledProcessError. The CalledProcessError object will have the return code in the returncode attribute, and output & stderr attributes if those streams were captured. If timeout is given, and the process takes too long, a TimeoutExpired exception will be raised. There is an optional argument “input”, allowing you to pass a string to the subprocess’s stdin. If you use this argument you may not also use the Popen constructor’s “stdin” argument, as it will be used internally. The other arguments are the same as for the Popen constructor. If universal_newlines=True is passed, the “input” argument must be a string and stdout/stderr in the returned object will be strings rather than bytes. <div class="versionadded"> Added in version 1.2a1: This function first appeared in Python 3.5. It is available on all Python versions gevent supports. </div> <div class="versionchanged"> Changed in version 1.3a2: Add the <code class="docutils literal notranslate">capture_output</code> argument from Python 3.7. It automatically sets <code class="docutils literal notranslate">stdout</code> and <code class="docutils literal notranslate">stderr</code> to <code class="docutils literal notranslate">PIPE</code>. It is an error to pass either of those arguments along with <code class="docutils literal notranslate">capture_output</code>. </div> </dd></dl> </section> </article> </div> <footer> <div class="related-pages"> <a class="next-page" href="gevent.thread.html"> <div class="page-info"> <div class="context"> Next </div> <div class="title"><code class="xref py py-mod docutils literal notranslate">gevent.thread</code> – Implementation of the standard <code class="xref py py-mod docutils literal notranslate">thread</code> module that spawns greenlets</div> </div> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> </a> <a class="prev-page" href="gevent.signal.html"> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> <div class="page-info"> <div class="context"> Previous </div> <div class="title"><code class="xref py py-mod docutils literal notranslate">gevent.signal</code> – Cooperative implementation of special cases of <code class="xref py py-func docutils literal notranslate">signal.signal()</code></div> </div> </a> </div> <div class="bottom-of-page"> <div class="left-details"> <div class="copyright"> Copyright © 2009-2023, gevent contributors </div> Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s <a href="https://github.com/pradyunsg/furo">Furo</a> </div> <div class="right-details"> </div> </div> </footer> </div> <aside class="toc-drawer"> <div class="toc-sticky toc-scroll"> <div class="toc-title-container"> On this page </div> <div class="toc-tree-container"> <div class="toc-tree"> <ul> <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">gevent.subprocess</code> – Cooperative <code class="docutils literal notranslate">subprocess</code> module</a><ul> <li><a class="reference internal" href="#gevent.subprocess.CalledProcessError"><code class="docutils literal notranslate">CalledProcessError</code></a><ul> <li><a class="reference internal" href="#gevent.subprocess.CalledProcessError.stdout"><code class="docutils literal notranslate">CalledProcessError.stdout</code></a></li> </ul> </li> <li><a class="reference internal" href="#gevent.subprocess.SubprocessError"><code class="docutils literal notranslate">SubprocessError</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.TimeoutExpired"><code class="docutils literal notranslate">TimeoutExpired</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.CompletedProcess"><code class="docutils literal notranslate">CompletedProcess</code></a><ul> <li><a class="reference internal" href="#gevent.subprocess.CompletedProcess.check_returncode"><code class="docutils literal notranslate">CompletedProcess.check_returncode()</code></a></li> </ul> </li> <li><a class="reference internal" href="#gevent.subprocess.Popen"><code class="docutils literal notranslate">Popen</code></a><ul> <li><a class="reference internal" href="#gevent.subprocess.Popen.communicate"><code class="docutils literal notranslate">Popen.communicate()</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.Popen.kill"><code class="docutils literal notranslate">Popen.kill()</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.Popen.pipe_cloexec"><code class="docutils literal notranslate">Popen.pipe_cloexec()</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.Popen.poll"><code class="docutils literal notranslate">Popen.poll()</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.Popen.send_signal"><code class="docutils literal notranslate">Popen.send_signal()</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.Popen.terminate"><code class="docutils literal notranslate">Popen.terminate()</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.Popen.wait"><code class="docutils literal notranslate">Popen.wait()</code></a></li> </ul> </li> <li><a class="reference internal" href="#gevent.subprocess.call"><code class="docutils literal notranslate">call()</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.check_call"><code class="docutils literal notranslate">check_call()</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.check_output"><code class="docutils literal notranslate">check_output()</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.getoutput"><code class="docutils literal notranslate">getoutput()</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.getstatusoutput"><code class="docutils literal notranslate">getstatusoutput()</code></a></li> <li><a class="reference internal" href="#gevent.subprocess.run"><code class="docutils literal notranslate">run()</code></a></li> </ul> </li> </ul> </div> </div> </div> </aside> </div> </div><script src="../_static/documentation_options.js?v=32fdf4fc"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> </body> </html>