admin_console.ainput.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module admin_console.ainput</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="admin_console.html"><font color="#ffffff">admin_console</font></a>.ainput</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python3.10/site-packages/admin_console/ainput.py">/usr/lib/python3.10/site-packages/admin_console/ainput.py</a></font></td></tr></table>
    <p><tt>ainput.py<br>
Tools&nbsp;for&nbsp;creating&nbsp;a&nbsp;simple&nbsp;text&nbsp;user&nbsp;interfaces&nbsp;in&nbsp;Unix-like&nbsp;systems&nbsp;with&nbsp;using&nbsp;asyncio<br>
Doesn't&nbsp;support&nbsp;Windows&nbsp;or&nbsp;any&nbsp;non-POSIX&nbsp;terminals</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
    
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="asyncio.html">asyncio</a><br>
<a href="io.html">io</a><br>
</td><td width="25%" valign=top><a href="os.html">os</a><br>
<a href="re.html">re</a><br>
</td><td width="25%" valign=top><a href="sys.html">sys</a><br>
<a href="termios.html">termios</a><br>
</td><td width="25%" valign=top><a href="traceback.html">traceback</a><br>
<a href="tty.html">tty</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="admin_console.ainput.html#AsyncRawInput">AsyncRawInput</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="enum.html#Enum">enum.Enum</a>(<a href="builtins.html#object">builtins.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="admin_console.ainput.html#colors">colors</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="logging.html#Handler">logging.Handler</a>(<a href="logging.html#Filterer">logging.Filterer</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="admin_console.ainput.html#ARILogHandler">ARILogHandler</a>
</font></dt></dl>
</dd>
</dl>
 <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="ARILogHandler">class <strong>ARILogHandler</strong></a>(<a href="logging.html#Handler">logging.Handler</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#ARILogHandler">ARILogHandler</a>(ari:&nbsp;admin_console.ainput.<a href="#AsyncRawInput">AsyncRawInput</a>,&nbsp;level=0)<br>
&nbsp;<br>
Custom&nbsp;logging&nbsp;handler&nbsp;for&nbsp;displaying&nbsp;log&nbsp;messages&nbsp;in&nbsp;the&nbsp;terminal.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="admin_console.ainput.html#ARILogHandler">ARILogHandler</a></dd>
<dd><a href="logging.html#Handler">logging.Handler</a></dd>
<dd><a href="logging.html#Filterer">logging.Filterer</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="ARILogHandler-__init__"><strong>__init__</strong></a>(self, ari: admin_console.ainput.AsyncRawInput, level=0)</dt><dd><tt>Initializes&nbsp;the&nbsp;instance&nbsp;-&nbsp;basically&nbsp;setting&nbsp;the&nbsp;formatter&nbsp;to&nbsp;None<br>
and&nbsp;the&nbsp;filter&nbsp;list&nbsp;to&nbsp;empty.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-emit"><strong>emit</strong></a>(self, record: logging.LogRecord)</dt><dd><tt>Do&nbsp;whatever&nbsp;it&nbsp;takes&nbsp;to&nbsp;actually&nbsp;log&nbsp;the&nbsp;specified&nbsp;logging&nbsp;record.<br>
&nbsp;<br>
This&nbsp;version&nbsp;is&nbsp;intended&nbsp;to&nbsp;be&nbsp;implemented&nbsp;by&nbsp;subclasses&nbsp;and&nbsp;so<br>
raises&nbsp;a&nbsp;NotImplementedError.</tt></dd></dl>

<hr>
Methods inherited from <a href="logging.html#Handler">logging.Handler</a>:<br>
<dl><dt><a name="ARILogHandler-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return&nbsp;repr(self).</tt></dd></dl>

<dl><dt><a name="ARILogHandler-acquire"><strong>acquire</strong></a>(self)</dt><dd><tt>Acquire&nbsp;the&nbsp;I/O&nbsp;thread&nbsp;lock.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-close"><strong>close</strong></a>(self)</dt><dd><tt>Tidy&nbsp;up&nbsp;any&nbsp;resources&nbsp;used&nbsp;by&nbsp;the&nbsp;handler.<br>
&nbsp;<br>
This&nbsp;version&nbsp;removes&nbsp;the&nbsp;handler&nbsp;from&nbsp;an&nbsp;internal&nbsp;map&nbsp;of&nbsp;handlers,<br>
_handlers,&nbsp;which&nbsp;is&nbsp;used&nbsp;for&nbsp;handler&nbsp;lookup&nbsp;by&nbsp;name.&nbsp;Subclasses<br>
should&nbsp;ensure&nbsp;that&nbsp;this&nbsp;gets&nbsp;called&nbsp;from&nbsp;overridden&nbsp;<a href="#ARILogHandler-close">close</a>()<br>
methods.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-createLock"><strong>createLock</strong></a>(self)</dt><dd><tt>Acquire&nbsp;a&nbsp;thread&nbsp;lock&nbsp;for&nbsp;serializing&nbsp;access&nbsp;to&nbsp;the&nbsp;underlying&nbsp;I/O.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-flush"><strong>flush</strong></a>(self)</dt><dd><tt>Ensure&nbsp;all&nbsp;logging&nbsp;output&nbsp;has&nbsp;been&nbsp;flushed.<br>
&nbsp;<br>
This&nbsp;version&nbsp;does&nbsp;nothing&nbsp;and&nbsp;is&nbsp;intended&nbsp;to&nbsp;be&nbsp;implemented&nbsp;by<br>
subclasses.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-format"><strong>format</strong></a>(self, record)</dt><dd><tt>Format&nbsp;the&nbsp;specified&nbsp;record.<br>
&nbsp;<br>
If&nbsp;a&nbsp;formatter&nbsp;is&nbsp;set,&nbsp;use&nbsp;it.&nbsp;Otherwise,&nbsp;use&nbsp;the&nbsp;default&nbsp;formatter<br>
for&nbsp;the&nbsp;module.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-get_name"><strong>get_name</strong></a>(self)</dt></dl>

<dl><dt><a name="ARILogHandler-handle"><strong>handle</strong></a>(self, record)</dt><dd><tt>Conditionally&nbsp;emit&nbsp;the&nbsp;specified&nbsp;logging&nbsp;record.<br>
&nbsp;<br>
Emission&nbsp;depends&nbsp;on&nbsp;filters&nbsp;which&nbsp;may&nbsp;have&nbsp;been&nbsp;added&nbsp;to&nbsp;the&nbsp;handler.<br>
Wrap&nbsp;the&nbsp;actual&nbsp;emission&nbsp;of&nbsp;the&nbsp;record&nbsp;with&nbsp;acquisition/release&nbsp;of<br>
the&nbsp;I/O&nbsp;thread&nbsp;lock.&nbsp;Returns&nbsp;whether&nbsp;the&nbsp;filter&nbsp;passed&nbsp;the&nbsp;record&nbsp;for<br>
emission.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-handleError"><strong>handleError</strong></a>(self, record)</dt><dd><tt>Handle&nbsp;errors&nbsp;which&nbsp;occur&nbsp;during&nbsp;an&nbsp;<a href="#ARILogHandler-emit">emit</a>()&nbsp;call.<br>
&nbsp;<br>
This&nbsp;method&nbsp;should&nbsp;be&nbsp;called&nbsp;from&nbsp;handlers&nbsp;when&nbsp;an&nbsp;exception&nbsp;is<br>
encountered&nbsp;during&nbsp;an&nbsp;<a href="#ARILogHandler-emit">emit</a>()&nbsp;call.&nbsp;If&nbsp;raiseExceptions&nbsp;is&nbsp;false,<br>
exceptions&nbsp;get&nbsp;silently&nbsp;ignored.&nbsp;This&nbsp;is&nbsp;what&nbsp;is&nbsp;mostly&nbsp;wanted<br>
for&nbsp;a&nbsp;logging&nbsp;system&nbsp;-&nbsp;most&nbsp;users&nbsp;will&nbsp;not&nbsp;care&nbsp;about&nbsp;errors&nbsp;in<br>
the&nbsp;logging&nbsp;system,&nbsp;they&nbsp;are&nbsp;more&nbsp;interested&nbsp;in&nbsp;application&nbsp;errors.<br>
You&nbsp;could,&nbsp;however,&nbsp;replace&nbsp;this&nbsp;with&nbsp;a&nbsp;custom&nbsp;handler&nbsp;if&nbsp;you&nbsp;wish.<br>
The&nbsp;record&nbsp;which&nbsp;was&nbsp;being&nbsp;processed&nbsp;is&nbsp;passed&nbsp;in&nbsp;to&nbsp;this&nbsp;method.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-release"><strong>release</strong></a>(self)</dt><dd><tt>Release&nbsp;the&nbsp;I/O&nbsp;thread&nbsp;lock.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-setFormatter"><strong>setFormatter</strong></a>(self, fmt)</dt><dd><tt>Set&nbsp;the&nbsp;formatter&nbsp;for&nbsp;this&nbsp;handler.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-setLevel"><strong>setLevel</strong></a>(self, level)</dt><dd><tt>Set&nbsp;the&nbsp;logging&nbsp;level&nbsp;of&nbsp;this&nbsp;handler.&nbsp;&nbsp;level&nbsp;must&nbsp;be&nbsp;an&nbsp;int&nbsp;or&nbsp;a&nbsp;str.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-set_name"><strong>set_name</strong></a>(self, name)</dt></dl>

<hr>
Data descriptors inherited from <a href="logging.html#Handler">logging.Handler</a>:<br>
<dl><dt><strong>name</strong></dt>
</dl>
<hr>
Methods inherited from <a href="logging.html#Filterer">logging.Filterer</a>:<br>
<dl><dt><a name="ARILogHandler-addFilter"><strong>addFilter</strong></a>(self, filter)</dt><dd><tt>Add&nbsp;the&nbsp;specified&nbsp;filter&nbsp;to&nbsp;this&nbsp;handler.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-filter"><strong>filter</strong></a>(self, record)</dt><dd><tt>Determine&nbsp;if&nbsp;a&nbsp;record&nbsp;is&nbsp;loggable&nbsp;by&nbsp;consulting&nbsp;all&nbsp;the&nbsp;filters.<br>
&nbsp;<br>
The&nbsp;default&nbsp;is&nbsp;to&nbsp;allow&nbsp;the&nbsp;record&nbsp;to&nbsp;be&nbsp;logged;&nbsp;any&nbsp;filter&nbsp;can&nbsp;veto<br>
this&nbsp;and&nbsp;the&nbsp;record&nbsp;is&nbsp;then&nbsp;dropped.&nbsp;Returns&nbsp;a&nbsp;zero&nbsp;value&nbsp;if&nbsp;a&nbsp;record<br>
is&nbsp;to&nbsp;be&nbsp;dropped,&nbsp;else&nbsp;non-zero.<br>
&nbsp;<br>
..&nbsp;versionchanged::&nbsp;3.2<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;Allow&nbsp;filters&nbsp;to&nbsp;be&nbsp;just&nbsp;callables.</tt></dd></dl>

<dl><dt><a name="ARILogHandler-removeFilter"><strong>removeFilter</strong></a>(self, filter)</dt><dd><tt>Remove&nbsp;the&nbsp;specified&nbsp;filter&nbsp;from&nbsp;this&nbsp;handler.</tt></dd></dl>

<hr>
Data descriptors inherited from <a href="logging.html#Filterer">logging.Filterer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="AsyncRawInput">class <strong>AsyncRawInput</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#AsyncRawInput">AsyncRawInput</a>(history:&nbsp;list&nbsp;=&nbsp;None,&nbsp;history_limit:&nbsp;int&nbsp;=&nbsp;30,&nbsp;stdin:&nbsp;_io.TextIOWrapper&nbsp;=&nbsp;&amp;lt;_io.TextIOWrapper&nbsp;name='&amp;lt;stdin&amp;gt;'&nbsp;mode='r'&nbsp;encoding='utf-8'&amp;gt;,&nbsp;stdout:&nbsp;_io.TextIOWrapper&nbsp;=&nbsp;&amp;lt;_io.TextIOWrapper&nbsp;name='&amp;lt;stdout&amp;gt;'&nbsp;mode='w'&nbsp;encoding='utf-8'&amp;gt;,&nbsp;*,&nbsp;loop=None)<br>
&nbsp;<br>
Main&nbsp;class&nbsp;for&nbsp;asynchronous&nbsp;input&nbsp;and&nbsp;proper&nbsp;output&nbsp;handling<br>
&nbsp;<br>
Before&nbsp;using&nbsp;its&nbsp;features,&nbsp;self.<a href="#AsyncRawInput-prepare">prepare</a>()&nbsp;should&nbsp;be&nbsp;called<br>
self.<a href="#AsyncRawInput-end">end</a>()&nbsp;is&nbsp;called&nbsp;on&nbsp;<a href="builtins.html#object">object</a>&nbsp;destruction&nbsp;handler<br>
&nbsp;<br>
self.<strong>loop</strong>&nbsp;:&nbsp;asyncio.BaseEventLoop<br>
&nbsp;&nbsp;&nbsp;&nbsp;Event&nbsp;loop&nbsp;attached&nbsp;to&nbsp;the&nbsp;IO&nbsp;handler<br>
self.<strong>is_reading</strong>&nbsp;:&nbsp;bool<br>
&nbsp;&nbsp;&nbsp;&nbsp;Whether&nbsp;or&nbsp;not&nbsp;the&nbsp;user&nbsp;input&nbsp;is&nbsp;currently&nbsp;receiving<br>
self.<strong>stdin</strong>&nbsp;:&nbsp;io.TextIOWrapper<br>
&nbsp;&nbsp;&nbsp;&nbsp;File-like&nbsp;<a href="builtins.html#object">object</a>&nbsp;handling&nbsp;the&nbsp;terminal&nbsp;input<br>
self.<strong>stdout</strong>&nbsp;:&nbsp;io.TextIOWrapper<br>
&nbsp;&nbsp;&nbsp;&nbsp;File-like&nbsp;<a href="builtins.html#object">object</a>&nbsp;handling&nbsp;the&nbsp;terminal&nbsp;output<br>
self.<strong>read_lastinp</strong>&nbsp;:&nbsp;list<br>
&nbsp;&nbsp;&nbsp;&nbsp;List&nbsp;of&nbsp;str,&nbsp;containing&nbsp;each&nbsp;character&nbsp;for&nbsp;a&nbsp;mutable&nbsp;Unicode&nbsp;string<br>
&nbsp;&nbsp;&nbsp;&nbsp;Represents&nbsp;an&nbsp;unentered&nbsp;user&nbsp;input&nbsp;displaying&nbsp;on&nbsp;the&nbsp;terminal<br>
self.<strong>read_lastprompt</strong>&nbsp;:&nbsp;str<br>
&nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;prompt.&nbsp;Text&nbsp;prepending&nbsp;the&nbsp;user&nbsp;input&nbsp;line.<br>
&nbsp;&nbsp;&nbsp;&nbsp;To&nbsp;format&nbsp;a&nbsp;prompt,&nbsp;set&nbsp;self.<strong>prompt_formats</strong><br>
self.<strong>old_tcattrs</strong>&nbsp;:&nbsp;list<br>
&nbsp;&nbsp;&nbsp;&nbsp;List&nbsp;of&nbsp;control&nbsp;terminal&nbsp;arguments&nbsp;that&nbsp;have&nbsp;been&nbsp;set&nbsp;before&nbsp;<a href="#AsyncRawInput-prepare">prepare</a>()&nbsp;called<br>
self.<strong>history</strong>&nbsp;:&nbsp;list<br>
&nbsp;&nbsp;&nbsp;&nbsp;List&nbsp;of&nbsp;previous&nbsp;user&nbsp;inputs<br>
self.<strong>history_limit</strong>&nbsp;:&nbsp;int<br>
&nbsp;&nbsp;&nbsp;&nbsp;Threshold&nbsp;of&nbsp;automatic&nbsp;entry&nbsp;deletion&nbsp;of&nbsp;old&nbsp;user&nbsp;inputs<br>
self.<strong>cursor</strong>&nbsp;:&nbsp;int<br>
&nbsp;&nbsp;&nbsp;&nbsp;Current&nbsp;position&nbsp;of&nbsp;the&nbsp;user&nbsp;terminal&nbsp;cursor.<br>
self.<strong>echo</strong>&nbsp;:&nbsp;bool&nbsp;=&nbsp;True<br>
&nbsp;&nbsp;&nbsp;&nbsp;Whether&nbsp;or&nbsp;not&nbsp;the&nbsp;user&nbsp;input&nbsp;is&nbsp;shown&nbsp;on&nbsp;the&nbsp;terminal.&nbsp;Don't&nbsp;modify&nbsp;it&nbsp;manually<br>
self.<strong>ctrl_c</strong>&nbsp;:&nbsp;(async)&nbsp;function<br>
&nbsp;&nbsp;&nbsp;&nbsp;Async&nbsp;callback&nbsp;that&nbsp;is&nbsp;called&nbsp;when&nbsp;Ctrl&nbsp;+&nbsp;C&nbsp;is&nbsp;pressed&nbsp;in&nbsp;the&nbsp;terminal<br>
self.<strong>keystrokes</strong>&nbsp;:&nbsp;dict<br>
&nbsp;&nbsp;&nbsp;&nbsp;Mapping&nbsp;of&nbsp;keystroke&nbsp;handlers.<br>
&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;"raw&nbsp;keystroke&nbsp;code":&nbsp;async&nbsp;callable&nbsp;}<br>
self.<strong>prompt_formats</strong>&nbsp;:&nbsp;tuple(str,&nbsp;str)<br>
&nbsp;&nbsp;&nbsp;&nbsp;Formatting&nbsp;header,&nbsp;footer&nbsp;pair&nbsp;for&nbsp;displaying&nbsp;a&nbsp;prompt.<br>
self.<strong>input_formats</strong>&nbsp;:&nbsp;tuple(str,&nbsp;str)<br>
&nbsp;&nbsp;&nbsp;&nbsp;Formatting&nbsp;header,&nbsp;footer&nbsp;pair&nbsp;for&nbsp;displaying&nbsp;a&nbsp;user&nbsp;input<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="AsyncRawInput-__del__"><strong>__del__</strong></a>(self)</dt></dl>

<dl><dt><a name="AsyncRawInput-__init__"><strong>__init__</strong></a>(self, history: list = None, history_limit: int = 30, stdin: _io.TextIOWrapper = &lt;_io.TextIOWrapper name='&lt;stdin&gt;' mode='r' encoding='utf-8'&gt;, stdout: _io.TextIOWrapper = &lt;_io.TextIOWrapper name='&lt;stdout&gt;' mode='w' encoding='utf-8'&gt;, *, loop=None)</dt><dd><tt>Parameters<br>
----------<br>
history&nbsp;:&nbsp;list<br>
&nbsp;&nbsp;&nbsp;&nbsp;List&nbsp;of&nbsp;str&nbsp;containing&nbsp;previous&nbsp;user&nbsp;input<br>
history_limit&nbsp;:&nbsp;int&nbsp;=&nbsp;30<br>
&nbsp;&nbsp;&nbsp;&nbsp;Max&nbsp;amount&nbsp;of&nbsp;elements&nbsp;in&nbsp;history&nbsp;list,&nbsp;when&nbsp;exceeded&nbsp;the&nbsp;old&nbsp;values&nbsp;gets&nbsp;deleted.<br>
stdin&nbsp;:&nbsp;io.TextIOWrapper&nbsp;=&nbsp;sys.stdin<br>
&nbsp;&nbsp;&nbsp;&nbsp;File-like&nbsp;<a href="builtins.html#object">object</a>&nbsp;handling&nbsp;standard&nbsp;input.&nbsp;Should&nbsp;be&nbsp;tty-like&nbsp;file<br>
stdout&nbsp;:&nbsp;io.TextIOWrapper&nbsp;=&nbsp;sys.stdout<br>
&nbsp;&nbsp;&nbsp;&nbsp;File-like&nbsp;<a href="builtins.html#object">object</a>&nbsp;handling&nbsp;standard&nbsp;output.</tt></dd></dl>

<dl><dt><a name="AsyncRawInput-add_keystroke"><strong>add_keystroke</strong></a>(self, keystroke: str, asyncfunction)</dt><dd><tt>Add&nbsp;a&nbsp;new&nbsp;keystroke&nbsp;to&nbsp;the&nbsp;terminal<br>
&nbsp;<br>
Parameters<br>
----------<br>
keystroke&nbsp;:&nbsp;str<br>
&nbsp;&nbsp;&nbsp;&nbsp;Raw&nbsp;keystroke&nbsp;code.&nbsp;For&nbsp;example,&nbsp;tab&nbsp;keystroke&nbsp;will&nbsp;be:&nbsp;"\t",&nbsp;Ctrl&nbsp;+&nbsp;F&nbsp;will&nbsp;be&nbsp;"\x06"<br>
asyncfunction&nbsp;:&nbsp;async&nbsp;function<br>
&nbsp;&nbsp;&nbsp;&nbsp;Async&nbsp;callback&nbsp;called&nbsp;without&nbsp;arguments</tt></dd></dl>

<dl><dt><a name="AsyncRawInput-end"><strong>end</strong></a>(self)</dt><dd><tt>Disables&nbsp;raw&nbsp;mode,&nbsp;restoring&nbsp;the&nbsp;old&nbsp;TTY&nbsp;settings&nbsp;for&nbsp;standard&nbsp;input<br>
Unhooks&nbsp;the&nbsp;SIGWINCH&nbsp;signal&nbsp;handler.</tt></dd></dl>

<dl><dt><a name="AsyncRawInput-get_interrupt_handler"><strong>get_interrupt_handler</strong></a>(self) -&gt; Callable[[Any], Coroutine[Any, Any, Any]]</dt></dl>

<dl><dt><a name="AsyncRawInput-get_terminal_size"><strong>get_terminal_size</strong></a>(self) -&gt; Union[os.terminal_size, Tuple[int, int]]</dt></dl>

<dl><dt><a name="AsyncRawInput-move_cursor"><strong>move_cursor</strong></a>(self, at: int, *, flush=True, redraw=False)</dt><dd><tt>Moves&nbsp;the&nbsp;cursor&nbsp;across&nbsp;the&nbsp;current&nbsp;line.<br>
Parameter&nbsp;at&nbsp;starts&nbsp;from&nbsp;1,&nbsp;which&nbsp;means&nbsp;that&nbsp;at=1&nbsp;is&nbsp;the&nbsp;first&nbsp;character&nbsp;of&nbsp;the&nbsp;terminal&nbsp;line</tt></dd></dl>

<dl><dt><a name="AsyncRawInput-move_input_cursor"><strong>move_input_cursor</strong></a>(self, at_char: int)</dt><dd><tt>Sets&nbsp;the&nbsp;cursor's&nbsp;input&nbsp;position&nbsp;at&nbsp;specified&nbsp;character.&nbsp;Scrolls&nbsp;the&nbsp;input&nbsp;horizontally&nbsp;when&nbsp;necessary.</tt></dd></dl>

<dl><dt><a name="AsyncRawInput-on_terminal_resize"><strong>on_terminal_resize</strong></a>(self)</dt></dl>

<dl><dt><a name="AsyncRawInput-prepare"><strong>prepare</strong></a>(self)</dt><dd><tt>Enables&nbsp;raw&nbsp;mode,&nbsp;saving&nbsp;the&nbsp;old&nbsp;TTY&nbsp;settings.&nbsp;Disables&nbsp;blocking&nbsp;mode&nbsp;for&nbsp;standard&nbsp;input<br>
Hooks&nbsp;up&nbsp;the&nbsp;SIGWINCH&nbsp;signal&nbsp;handler,&nbsp;which&nbsp;will&nbsp;redraw&nbsp;the&nbsp;prompt&nbsp;line&nbsp;if&nbsp;any.</tt></dd></dl>

<dl><dt>async <a name="AsyncRawInput-prompt_keystroke"><strong>prompt_keystroke</strong></a>(self, prompt=': ', echo=True) -&gt; str</dt><dd><tt>Start&nbsp;reading&nbsp;a&nbsp;single&nbsp;character&nbsp;from&nbsp;a&nbsp;terminal.&nbsp;Not&nbsp;handling&nbsp;the&nbsp;keystrokes.<br>
&nbsp;<br>
Parameters<br>
----------<br>
prompt&nbsp;:&nbsp;str<br>
&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;text&nbsp;that&nbsp;is&nbsp;displayed&nbsp;before&nbsp;user&nbsp;input<br>
echo&nbsp;:&nbsp;bool<br>
&nbsp;&nbsp;&nbsp;&nbsp;Whether&nbsp;or&nbsp;not&nbsp;a&nbsp;user&nbsp;input&nbsp;will&nbsp;be&nbsp;displayed.<br>
&nbsp;<br>
Returns<br>
-------<br>
str<br>
&nbsp;&nbsp;&nbsp;&nbsp;Resulting&nbsp;pressed&nbsp;keystroke</tt></dd></dl>

<dl><dt>async <a name="AsyncRawInput-prompt_line"><strong>prompt_line</strong></a>(self, prompt='&gt; ', echo=True, history_disabled=False, prompt_formats={}, input_formats={})</dt><dd><tt>Start&nbsp;reading&nbsp;a&nbsp;single-line&nbsp;user&nbsp;input&nbsp;with&nbsp;prompt&nbsp;from&nbsp;<a href="#AsyncRawInput">AsyncRawInput</a>.stdin.<br>
Asynchronous&nbsp;version&nbsp;of&nbsp;input(prompt),&nbsp;handling&nbsp;the&nbsp;keystrokes.<br>
In&nbsp;addition&nbsp;to&nbsp;Python's&nbsp;input(prompt)&nbsp;function,&nbsp;the&nbsp;input&nbsp;is&nbsp;not&nbsp;wrapped<br>
into&nbsp;the&nbsp;new&nbsp;line&nbsp;when&nbsp;overflowed,&nbsp;instead&nbsp;it&nbsp;hides&nbsp;the&nbsp;leftmost&nbsp;characters,<br>
as&nbsp;well&nbsp;as&nbsp;handling&nbsp;the&nbsp;controlling&nbsp;terminal's&nbsp;resizing.<br>
To&nbsp;register&nbsp;a&nbsp;keystroke,&nbsp;use&nbsp;<a href="#AsyncRawInput">AsyncRawInput</a>.<a href="#AsyncRawInput-add_keystroke">add_keystroke</a>(code,&nbsp;asyncfunction)<br>
&nbsp;<br>
Parameters<br>
----------<br>
prompt&nbsp;:&nbsp;str<br>
&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;text&nbsp;that&nbsp;is&nbsp;displayed&nbsp;before&nbsp;user&nbsp;input<br>
echo&nbsp;:&nbsp;bool<br>
&nbsp;&nbsp;&nbsp;&nbsp;Whether&nbsp;or&nbsp;not&nbsp;a&nbsp;user&nbsp;input&nbsp;will&nbsp;be&nbsp;displayed.&nbsp;Set&nbsp;to&nbsp;False&nbsp;when&nbsp;prompting&nbsp;a&nbsp;password<br>
history_disabled&nbsp;:&nbsp;bool<br>
&nbsp;&nbsp;&nbsp;&nbsp;Whether&nbsp;or&nbsp;not&nbsp;a&nbsp;new&nbsp;entry&nbsp;should&nbsp;not&nbsp;be&nbsp;added&nbsp;on&nbsp;successful&nbsp;user&nbsp;input.&nbsp;Set&nbsp;to&nbsp;True&nbsp;when&nbsp;prompting&nbsp;a&nbsp;password<br>
prompt_formats&nbsp;:&nbsp;dict<br>
&nbsp;&nbsp;&nbsp;&nbsp;Dictionary&nbsp;of&nbsp;text&nbsp;formatting&nbsp;settings&nbsp;that&nbsp;are&nbsp;passed&nbsp;into&nbsp;format_term<br>
&nbsp;&nbsp;&nbsp;&nbsp;self.<strong>prompt_formats</strong>&nbsp;=&nbsp;<a href="#-format_term">format_term</a>(**prompt_formats)<br>
input_formats&nbsp;:&nbsp;dict<br>
&nbsp;&nbsp;&nbsp;&nbsp;Dictionary&nbsp;of&nbsp;text&nbsp;formatting&nbsp;settings&nbsp;that&nbsp;are&nbsp;passed&nbsp;into&nbsp;format_term<br>
&nbsp;&nbsp;&nbsp;&nbsp;self.<strong>input_formats</strong>&nbsp;=&nbsp;<a href="#-format_term">format_term</a>(**input_formats)</tt></dd></dl>

<dl><dt><a name="AsyncRawInput-redraw_lastinp"><strong>redraw_lastinp</strong></a>(self, at: int, force_redraw_prompt=False)</dt><dd><tt>Redisplay&nbsp;a&nbsp;user&nbsp;input&nbsp;at&nbsp;specified&nbsp;position&nbsp;on&nbsp;current&nbsp;cursor&nbsp;line.<br>
If&nbsp;force_redraw_prompt&nbsp;is&nbsp;True,&nbsp;redraws&nbsp;the&nbsp;whole&nbsp;line&nbsp;entirely&nbsp;(including&nbsp;the&nbsp;prompt)&nbsp;regardless&nbsp;of&nbsp;scrolling&nbsp;state</tt></dd></dl>

<dl><dt><a name="AsyncRawInput-remove_keystroke"><strong>remove_keystroke</strong></a>(self, keystroke: str)</dt><dd><tt>Remove&nbsp;a&nbsp;keystroke&nbsp;from&nbsp;the&nbsp;terminal<br>
&nbsp;<br>
Parameters&nbsp;:&nbsp;str<br>
&nbsp;&nbsp;&nbsp;&nbsp;Raw&nbsp;keystroke&nbsp;code.</tt></dd></dl>

<dl><dt><a name="AsyncRawInput-set_interrupt_handler"><strong>set_interrupt_handler</strong></a>(self, callback)</dt><dd><tt>Sets&nbsp;the&nbsp;callback&nbsp;for&nbsp;Ctrl&nbsp;+&nbsp;C&nbsp;keystroke<br>
&nbsp;<br>
Parameters<br>
----------<br>
callback&nbsp;:&nbsp;coroutine&nbsp;or&nbsp;regular&nbsp;function<br>
&nbsp;&nbsp;&nbsp;&nbsp;(async)&nbsp;callback,&nbsp;called&nbsp;without&nbsp;arguments</tt></dd></dl>

<dl><dt><a name="AsyncRawInput-write"><strong>write</strong></a>(self, msg: str, **formats)</dt><dd><tt>Write&nbsp;a&nbsp;formatted&nbsp;text&nbsp;to&nbsp;a&nbsp;terminal&nbsp;without&nbsp;CRLF.<br>
Don't&nbsp;use&nbsp;it&nbsp;when&nbsp;a&nbsp;user&nbsp;input&nbsp;is&nbsp;prompted<br>
&nbsp;<br>
Parameters<br>
----------<br>
msg&nbsp;:&nbsp;str<br>
&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;text&nbsp;without&nbsp;CRLF.<br>
**formats&nbsp;:&nbsp;keyword&nbsp;arguments<br>
&nbsp;&nbsp;&nbsp;&nbsp;Formatting&nbsp;arguments&nbsp;passed&nbsp;as&nbsp;<a href="#-format_term">format_term</a>(**formats)</tt></dd></dl>

<dl><dt><a name="AsyncRawInput-writeln"><strong>writeln</strong></a>(self, msg: str, **formats)</dt><dd><tt>Show&nbsp;a&nbsp;message&nbsp;on&nbsp;the&nbsp;terminal,&nbsp;preserving&nbsp;a&nbsp;user&nbsp;prompt&nbsp;if&nbsp;any.<br>
&nbsp;<br>
Parameters<br>
----------<br>
msg&nbsp;:&nbsp;str<br>
&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;message&nbsp;text.<br>
**formats&nbsp;:&nbsp;keyword&nbsp;arguments<br>
&nbsp;&nbsp;&nbsp;&nbsp;Formatting&nbsp;arguments&nbsp;passed&nbsp;as&nbsp;<a href="#-format_term">format_term</a>(**formats)</tt></dd></dl>

<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="colors">class <strong>colors</strong></a>(<a href="enum.html#Enum">enum.Enum</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#colors">colors</a>(value,&nbsp;names=None,&nbsp;*,&nbsp;module=None,&nbsp;qualname=None,&nbsp;type=None,&nbsp;start=1)<br>
&nbsp;<br>
ANSI&nbsp;terminal&nbsp;<a href="#colors">colors</a><br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="admin_console.ainput.html#colors">colors</a></dd>
<dd><a href="enum.html#Enum">enum.Enum</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>BLACK</strong> = &lt;colors.BLACK: 0&gt;</dl>

<dl><dt><strong>BLUE</strong> = &lt;colors.BLUE: 4&gt;</dl>

<dl><dt><strong>CYAN</strong> = &lt;colors.CYAN: 6&gt;</dl>

<dl><dt><strong>GREEN</strong> = &lt;colors.GREEN: 2&gt;</dl>

<dl><dt><strong>MAGENTA</strong> = &lt;colors.MAGENTA: 5&gt;</dl>

<dl><dt><strong>RED</strong> = &lt;colors.RED: 1&gt;</dl>

<dl><dt><strong>WHITE</strong> = &lt;colors.WHITE: 7&gt;</dl>

<dl><dt><strong>YELLOW</strong> = &lt;colors.YELLOW: 3&gt;</dl>

<hr>
Data descriptors inherited from <a href="enum.html#Enum">enum.Enum</a>:<br>
<dl><dt><strong>name</strong></dt>
<dd><tt>The&nbsp;name&nbsp;of&nbsp;the&nbsp;Enum&nbsp;member.</tt></dd>
</dl>
<dl><dt><strong>value</strong></dt>
<dd><tt>The&nbsp;value&nbsp;of&nbsp;the&nbsp;Enum&nbsp;member.</tt></dd>
</dl>
<hr>
Readonly properties inherited from <a href="enum.html#EnumMeta">enum.EnumMeta</a>:<br>
<dl><dt><strong>__members__</strong></dt>
<dd><tt>Returns&nbsp;a&nbsp;mapping&nbsp;of&nbsp;member&nbsp;name-&gt;value.<br>
&nbsp;<br>
This&nbsp;mapping&nbsp;lists&nbsp;all&nbsp;enum&nbsp;members,&nbsp;including&nbsp;aliases.&nbsp;Note&nbsp;that&nbsp;this<br>
is&nbsp;a&nbsp;read-only&nbsp;view&nbsp;of&nbsp;the&nbsp;internal&nbsp;mapping.</tt></dd>
</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt><a name="-carriage_return"><strong>carriage_return</strong></a>(arg) -&gt; str</dt><dd><tt>Convert&nbsp;plain&nbsp;newline&nbsp;to&nbsp;CR&nbsp;+&nbsp;LF<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-------<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;str<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converted&nbsp;string<br>
&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;arg.replace('<br>
',&nbsp;'<br>
')</tt></dd></dl>
 <dl><dt><a name="-format_term"><strong>format_term</strong></a>(*, bold=False, italic=False, underline=False, blink=False, fgcolor: Union[admin_console.ainput.colors, int] = None, bgcolor: Union[admin_console.ainput.colors, int] = None, **unused) -&gt; (&lt;class 'str'&gt;, &lt;class 'str'&gt;)</dt><dd><tt>Returns&nbsp;a&nbsp;tuple(ansi_escape_start:&nbsp;str,&nbsp;ansi_escape_end:&nbsp;str)&nbsp;for&nbsp;specified&nbsp;format<br>
Tip:&nbsp;"%stext%s"&nbsp;%&nbsp;<a href="#-format_term">format_term</a>(args...)<br>
&nbsp;<br>
Parameters<br>
----------<br>
bold&nbsp;:&nbsp;bool&nbsp;=&nbsp;False<br>
&nbsp;&nbsp;&nbsp;&nbsp;Formatted&nbsp;text&nbsp;appears&nbsp;bold&nbsp;(on&nbsp;some&nbsp;terminals&nbsp;also&nbsp;appears&nbsp;with&nbsp;bright&nbsp;color)<br>
italic&nbsp;:&nbsp;bool&nbsp;=&nbsp;False<br>
&nbsp;&nbsp;&nbsp;&nbsp;Formatted&nbsp;text&nbsp;appears&nbsp;italic<br>
underline&nbsp;:&nbsp;bool&nbsp;=&nbsp;False<br>
&nbsp;&nbsp;&nbsp;&nbsp;Formatted&nbsp;text&nbsp;appears&nbsp;with&nbsp;underline<br>
blink&nbsp;:&nbsp;bool&nbsp;=&nbsp;False<br>
&nbsp;&nbsp;&nbsp;&nbsp;Formatted&nbsp;text&nbsp;will&nbsp;blink&nbsp;fast&nbsp;if&nbsp;True<br>
fgcolor&nbsp;:&nbsp;<a href="#colors">colors</a>&nbsp;or&nbsp;int&nbsp;=&nbsp;None<br>
&nbsp;&nbsp;&nbsp;&nbsp;Set&nbsp;foreground&nbsp;(font)&nbsp;color<br>
&nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;enum&nbsp;<a href="#colors">colors</a>&nbsp;specified,&nbsp;formatted&nbsp;text&nbsp;will&nbsp;have&nbsp;an&nbsp;8-color&nbsp;format<br>
&nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;integer&nbsp;specified,&nbsp;formatted&nbsp;text&nbsp;will&nbsp;have&nbsp;an&nbsp;256-color&nbsp;format<br>
bgcolor&nbsp;:&nbsp;<a href="#colors">colors</a>&nbsp;of&nbsp;int&nbsp;=&nbsp;None<br>
&nbsp;&nbsp;&nbsp;&nbsp;Set&nbsp;background&nbsp;(fill)&nbsp;color<br>
&nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;enum&nbsp;<a href="#colors">colors</a>&nbsp;specified,&nbsp;formatted&nbsp;text&nbsp;will&nbsp;have&nbsp;an&nbsp;8-color&nbsp;format<br>
&nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;integer&nbsp;specified,&nbsp;formatted&nbsp;text&nbsp;will&nbsp;have&nbsp;an&nbsp;256-color&nbsp;format<br>
&nbsp;<br>
Example<br>
-------<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#AsyncRawInput">AsyncRawInput</a>.writeln("%sHello&nbsp;world!%s"&nbsp;%&nbsp;<a href="#-format_term">format_term</a>(italic=True,&nbsp;fgcolor=<a href="#colors">colors</a>.GREEN,&nbsp;bgcolor=<a href="#colors">colors</a>.BLACK))</tt></dd></dl>
 <dl><dt><a name="-rawprint"><strong>rawprint</strong></a>(*args, sep=' ', **kwargs)</dt><dd><tt>Standard&nbsp;print&nbsp;wrapper,&nbsp;but&nbsp;with&nbsp;end='<br>
'</tt></dd></dl>
 <dl><dt><a name="-truelen"><strong>truelen</strong></a>(text: str) -&gt; int</dt><dd><tt>Returns&nbsp;amount&nbsp;of&nbsp;visible-on-terminal&nbsp;characters&nbsp;in&nbsp;the&nbsp;string</tt></dd></dl>
 <dl><dt><a name="-truelen_list"><strong>truelen_list</strong></a>(seq: Sequence[str]) -&gt; int</dt><dd><tt>Returns&nbsp;amount&nbsp;of&nbsp;visible-on-terminal&nbsp;characters&nbsp;in&nbsp;the&nbsp;sequence&nbsp;of&nbsp;strings</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
    
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>Any</strong> = typing.Any<br>
<strong>CRITICAL</strong> = 50<br>
<strong>Callable</strong> = typing.Callable<br>
<strong>Coroutine</strong> = typing.Coroutine<br>
<strong>DEBUG</strong> = 10<br>
<strong>ERROR</strong> = 40<br>
<strong>INFO</strong> = 20<br>
<strong>MutableSequence</strong> = typing.MutableSequence<br>
<strong>NOTSET</strong> = 0<br>
<strong>Optional</strong> = typing.Optional<br>
<strong>SIGWINCH</strong> = &lt;Signals.SIGWINCH: 28&gt;<br>
<strong>Sequence</strong> = typing.Sequence<br>
<strong>Tuple</strong> = typing.Tuple<br>
<strong>Union</strong> = typing.Union<br>
<strong>WARNING</strong> = 30<br>
<strong>ansi_escape</strong> = re.compile('(\\x9B|\\x1B\\[)[0-?]*[ -\\/]*[@-~]')<br>
<strong>do_backspace</strong> = '<font color="#c040c0">\x08\x1b</font>[0K'<br>
<strong>next_word</strong> = re.compile('\\w+\\W+(\\w+)')<br>
<strong>prev_word</strong> = re.compile('(\\w+) *$')</td></tr></table>
</body></html>