Mr.Combet Webshell 🔥

Edit File Name : termios.html

<!DOCTYPE html>

<title>termios — POSIX style tty control &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />
 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />
 
 <script src="../_static/documentation_options.js?v=2c828074"></script>
 <script src="../_static/doctools.js?v=888ff710"></script>
 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.12.3 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="tty — Terminal control functions" href="tty.html" />
 <link rel="prev" title="grp — The group database" href="grp.html" />
 <link rel="canonical" href="https://docs.python.org/3/library/termios.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <nav class="nav-content" role="navigation">
 <label for="menuToggler" class="toggler__label">
 
 </label>
 
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Python logo"/>
 </a>
 
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <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>
 </svg>
 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
 <input type="submit" value="Go"/>
 </form>
 
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 
<label class="theme-selector-label">
 Theme
 <select class="theme-selector" oninput="activateTheme(this.value)">
 <option value="auto" selected>Auto</option>
 <option value="light">Light</option>
 <option value="dark">Dark</option>
 </select>
</label>
 <div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">termios</code> — POSIX style tty control</a><ul>
<li><a class="reference internal" href="#example">Example</a></li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="grp.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">grp</code> — The group database</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="tty.html"
 title="next chapter"><code class="xref py py-mod docutils literal notranslate">tty</code> — Terminal control functions</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/main/Doc/library/termios.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </nav>
 </div>
</div>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="tty.html" title="tty — Terminal control functions"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="grp.html" title="grp — The group database"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.12.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="unix.html" accesskey="U">Unix Specific Services</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">termios</code> — POSIX style tty control</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-termios">
<h1><a class="reference internal" href="#module-termios" title="termios: POSIX style tty control. (Unix)"><code class="xref py py-mod docutils literal notranslate">termios</code></a> — POSIX style tty control<a class="headerlink" href="#module-termios" title="Link to this heading">¶</a></h1>
<hr class="docutils" id="index-0" />
This module provides an interface to the POSIX calls for tty I/O control. For a
complete description of these calls, see <a class="manpage reference external" href="https://manpages.debian.org/termios(3)">termios(3)</a> Unix manual
page. It is only available for those Unix versions that support POSIX
termios style tty I/O control configured during installation.
<div class="availability docutils container">
<a class="reference internal" href="intro.html#availability">Availability</a>: Unix.
</div>
All functions in this module take a file descriptor fd as their first
argument. This can be an integer file descriptor, such as returned by
<code class="docutils literal notranslate">sys.stdin.fileno()</code>, or a <a class="reference internal" href="../glossary.html#term-file-object">file object</a>, such as <code class="docutils literal notranslate">sys.stdin</code> itself.
This module also defines all the constants needed to work with the functions
provided here; these have the same name as their counterparts in C. Please
refer to your system documentation for more information on using these terminal
control interfaces.
The module defines the following functions:
<dl class="py function">
<dt class="sig sig-object py" id="termios.tcgetattr">
termios.tcgetattr(fd)<a class="headerlink" href="#termios.tcgetattr" title="Link to this definition">¶</a></dt>
<dd>Return a list containing the tty attributes for file descriptor fd, as
follows: <code class="docutils literal notranslate">[iflag, oflag, cflag, lflag, ispeed, ospeed, cc]</code> where cc is a
list of the tty special characters (each a string of length 1, except the
items with indices <code class="xref py py-const docutils literal notranslate">VMIN</code> and <code class="xref py py-const docutils literal notranslate">VTIME</code>, which are integers when
these fields are defined). The interpretation of the flags and the speeds as
well as the indexing in the cc array must be done using the symbolic
constants defined in the <a class="reference internal" href="#module-termios" title="termios: POSIX style tty control. (Unix)"><code class="xref py py-mod docutils literal notranslate">termios</code></a> module.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="termios.tcsetattr">
termios.tcsetattr(fd, when, attributes)<a class="headerlink" href="#termios.tcsetattr" title="Link to this definition">¶</a></dt>
<dd>Set the tty attributes for file descriptor fd from the attributes, which is
a list like the one returned by <a class="reference internal" href="#termios.tcgetattr" title="termios.tcgetattr"><code class="xref py py-func docutils literal notranslate">tcgetattr()</code></a>. The when argument
determines when the attributes are changed:
<dl class="py data">
<dt class="sig sig-object py" id="termios.TCSANOW">
termios.TCSANOW<a class="headerlink" href="#termios.TCSANOW" title="Link to this definition">¶</a></dt>
<dd>Change attributes immediately.
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="termios.TCSADRAIN">
termios.TCSADRAIN<a class="headerlink" href="#termios.TCSADRAIN" title="Link to this definition">¶</a></dt>
<dd>Change attributes after transmitting all queued output.
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="termios.TCSAFLUSH">
termios.TCSAFLUSH<a class="headerlink" href="#termios.TCSAFLUSH" title="Link to this definition">¶</a></dt>
<dd>Change attributes after transmitting all queued output and
discarding all queued input.
</dd></dl>

</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="termios.tcsendbreak">
termios.tcsendbreak(fd, duration)<a class="headerlink" href="#termios.tcsendbreak" title="Link to this definition">¶</a></dt>
<dd>Send a break on file descriptor fd. A zero duration sends a break for
0.25–0.5 seconds; a nonzero duration has a system dependent meaning.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="termios.tcdrain">
termios.tcdrain(fd)<a class="headerlink" href="#termios.tcdrain" title="Link to this definition">¶</a></dt>
<dd>Wait until all output written to file descriptor fd has been transmitted.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="termios.tcflush">
termios.tcflush(fd, queue)<a class="headerlink" href="#termios.tcflush" title="Link to this definition">¶</a></dt>
<dd>Discard queued data on file descriptor fd. The queue selector specifies
which queue: <code class="xref py py-const docutils literal notranslate">TCIFLUSH</code> for the input queue, <code class="xref py py-const docutils literal notranslate">TCOFLUSH</code> for the
output queue, or <code class="xref py py-const docutils literal notranslate">TCIOFLUSH</code> for both queues.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="termios.tcflow">
termios.tcflow(fd, action)<a class="headerlink" href="#termios.tcflow" title="Link to this definition">¶</a></dt>
<dd>Suspend or resume input or output on file descriptor fd. The action
argument can be <code class="xref py py-const docutils literal notranslate">TCOOFF</code> to suspend output, <code class="xref py py-const docutils literal notranslate">TCOON</code> to restart
output, <code class="xref py py-const docutils literal notranslate">TCIOFF</code> to suspend input, or <code class="xref py py-const docutils literal notranslate">TCION</code> to restart input.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="termios.tcgetwinsize">
termios.tcgetwinsize(fd)<a class="headerlink" href="#termios.tcgetwinsize" title="Link to this definition">¶</a></dt>
<dd>Return a tuple <code class="docutils literal notranslate">(ws_row, ws_col)</code> containing the tty window size for file
descriptor fd. Requires <code class="xref py py-const docutils literal notranslate">termios.TIOCGWINSZ</code> or
<code class="xref py py-const docutils literal notranslate">termios.TIOCGSIZE</code>.
<div class="versionadded">
New in version 3.11.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="termios.tcsetwinsize">
termios.tcsetwinsize(fd, winsize)<a class="headerlink" href="#termios.tcsetwinsize" title="Link to this definition">¶</a></dt>
<dd>Set the tty window size for file descriptor fd from winsize, which is
a two-item tuple <code class="docutils literal notranslate">(ws_row, ws_col)</code> like the one returned by
<a class="reference internal" href="#termios.tcgetwinsize" title="termios.tcgetwinsize"><code class="xref py py-func docutils literal notranslate">tcgetwinsize()</code></a>. Requires at least one of the pairs
(<code class="xref py py-const docutils literal notranslate">termios.TIOCGWINSZ</code>, <code class="xref py py-const docutils literal notranslate">termios.TIOCSWINSZ</code>);
(<code class="xref py py-const docutils literal notranslate">termios.TIOCGSIZE</code>, <code class="xref py py-const docutils literal notranslate">termios.TIOCSSIZE</code>) to be defined.
<div class="versionadded">
New in version 3.11.
</div>
</dd></dl>

<div class="admonition seealso">
See also
<dl class="simple">
<dt>Module <a class="reference internal" href="tty.html#module-tty" title="tty: Utility functions that perform common terminal control operations. (Unix)"><code class="xref py py-mod docutils literal notranslate">tty</code></a></dt><dd>Convenience functions for common terminal control operations.
</dd>
</dl>
</div>
<section id="example">
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
Here’s a function that prompts for a password with echoing turned off. Note the
technique using a separate <a class="reference internal" href="#termios.tcgetattr" title="termios.tcgetattr"><code class="xref py py-func docutils literal notranslate">tcgetattr()</code></a> call and a <a class="reference internal" href="../reference/compound_stmts.html#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> …
<a class="reference internal" href="../reference/compound_stmts.html#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> statement to ensure that the old tty attributes are restored
exactly no matter what happens:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>def getpass(prompt=&quot;Password: &quot;):
 import termios, sys
 fd = sys.stdin.fileno()
 old = termios.tcgetattr(fd)
 new = termios.tcgetattr(fd)
 new[3] = new[3] &amp; ~termios.ECHO # lflags
 try:
 termios.tcsetattr(fd, termios.TCSADRAIN, new)
 passwd = input(prompt)
 finally:
 termios.tcsetattr(fd, termios.TCSADRAIN, old)
 return passwd
</pre></div>
</div>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">termios</code> — POSIX style tty control</a><ul>
<li><a class="reference internal" href="#example">Example</a></li>
</ul>
</li>
</ul>

</div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="tty.html" title="tty — Terminal control functions"
 >next</a> |</li>
 <li class="right" >
 <a href="grp.html" title="grp — The group database"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="unix.html" >Unix Specific Services</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">termios</code> — POSIX style tty control</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />
 <input type="submit" value="Go" />
 </form>
 </div>
 |
 </li>
 <li class="right">
<label class="theme-selector-label">
 Theme
 <select class="theme-selector" oninput="activateTheme(this.value)">
 <option value="auto" selected>Auto</option>
 <option value="light">Light</option>
 <option value="dark">Dark</option>
 </select>
</label> |</li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; 
 <a href="../copyright.html">
 
 Copyright
 
 </a>
 2001-2024, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 
 Last updated on Apr 09, 2024 (13:47 UTC).
 
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
 </div>

</body>
</html>