Skip to content

Commit a707313

Browse files
committed
Updated docs
1 parent 31507a0 commit a707313

File tree

2 files changed

+561
-176
lines changed

2 files changed

+561
-176
lines changed

admin_console.ainput.html

+39-15
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@
199199
&nbsp;&nbsp;&nbsp;&nbsp;Current&nbsp;position&nbsp;of&nbsp;the&nbsp;user&nbsp;terminal&nbsp;cursor.<br>
200200
self.<strong>echo</strong>&nbsp;:&nbsp;bool&nbsp;=&nbsp;True<br>
201201
&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>
202-
self.<strong>ctrl_c</strong>&nbsp;:&nbsp;async&nbsp;function<br>
202+
self.<strong>ctrl_c</strong>&nbsp;:&nbsp;(async)&nbsp;function<br>
203203
&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>
204204
self.<strong>keystrokes</strong>&nbsp;:&nbsp;dict<br>
205205
&nbsp;&nbsp;&nbsp;&nbsp;Mapping&nbsp;of&nbsp;keystroke&nbsp;handlers.<br>
@@ -223,29 +223,51 @@
223223
stdout&nbsp;:&nbsp;io.TextIOWrapper&nbsp;=&nbsp;sys.stdout<br>
224224
&nbsp;&nbsp;&nbsp;&nbsp;File-like&nbsp;<a href="builtins.html#object">object</a>&nbsp;handling&nbsp;standard&nbsp;output.</tt></dd></dl>
225225

226-
<dl><dt><a name="AsyncRawInput-add_keystroke"><strong>add_keystroke</strong></a>(self, keystroke: str, awaitable)</dt><dd><tt>Add&nbsp;a&nbsp;new&nbsp;keystroke&nbsp;to&nbsp;the&nbsp;terminal<br>
226+
<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>
227227
&nbsp;<br>
228228
Parameters<br>
229229
----------<br>
230230
keystroke&nbsp;:&nbsp;str<br>
231231
&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>
232-
awaitable&nbsp;:&nbsp;async&nbsp;function<br>
232+
asyncfunction&nbsp;:&nbsp;async&nbsp;function<br>
233233
&nbsp;&nbsp;&nbsp;&nbsp;Async&nbsp;callback&nbsp;called&nbsp;without&nbsp;arguments</tt></dd></dl>
234234

235-
<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</tt></dd></dl>
235+
<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>
236+
Unhooks&nbsp;the&nbsp;SIGWINCH&nbsp;signal&nbsp;handler.</tt></dd></dl>
236237

237-
<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</tt></dd></dl>
238+
<dl><dt><a name="AsyncRawInput-get_interrupt_handler"><strong>get_interrupt_handler</strong></a>(self) -&gt; Callable[[Any], Coroutine[Any, Any, Any]]</dt></dl>
238239

239-
<dl><dt>async <a name="AsyncRawInput-prompt_keystroke"><strong>prompt_keystroke</strong></a>(self, prompt=': ', echo=True)</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>
240+
<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>
241+
242+
<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>
243+
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>
244+
245+
<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>
246+
247+
<dl><dt><a name="AsyncRawInput-on_terminal_resize"><strong>on_terminal_resize</strong></a>(self)</dt></dl>
248+
249+
<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>
250+
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>
251+
252+
<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>
240253
&nbsp;<br>
241254
Parameters<br>
242255
----------<br>
243256
prompt&nbsp;:&nbsp;str<br>
244257
&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;text&nbsp;that&nbsp;is&nbsp;displayed&nbsp;before&nbsp;user&nbsp;input<br>
245258
echo&nbsp;:&nbsp;bool<br>
246-
&nbsp;&nbsp;&nbsp;&nbsp;Whether&nbsp;or&nbsp;not&nbsp;a&nbsp;user&nbsp;input&nbsp;will&nbsp;be&nbsp;displayed.</tt></dd></dl>
247-
248-
<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.&nbsp;Asynchronous&nbsp;version&nbsp;of&nbsp;input(prompt),&nbsp;handling&nbsp;the&nbsp;keystrokes.<br>
259+
&nbsp;&nbsp;&nbsp;&nbsp;Whether&nbsp;or&nbsp;not&nbsp;a&nbsp;user&nbsp;input&nbsp;will&nbsp;be&nbsp;displayed.<br>
260+
&nbsp;<br>
261+
Returns<br>
262+
-------<br>
263+
str<br>
264+
&nbsp;&nbsp;&nbsp;&nbsp;Resulting&nbsp;pressed&nbsp;keystroke</tt></dd></dl>
265+
266+
<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>
267+
Asynchronous&nbsp;version&nbsp;of&nbsp;input(prompt),&nbsp;handling&nbsp;the&nbsp;keystrokes.<br>
268+
In&nbsp;addition&nbsp;to&nbsp;Python's&nbsp;input(prompt)&nbsp;function,&nbsp;the&nbsp;input&nbsp;is&nbsp;not&nbsp;wrapped<br>
269+
into&nbsp;the&nbsp;new&nbsp;line&nbsp;when&nbsp;overflowed,&nbsp;instead&nbsp;it&nbsp;hides&nbsp;the&nbsp;leftmost&nbsp;characters,<br>
270+
as&nbsp;well&nbsp;as&nbsp;handling&nbsp;the&nbsp;controlling&nbsp;terminal's&nbsp;resizing.<br>
249271
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>
250272
&nbsp;<br>
251273
Parameters<br>
@@ -263,19 +285,20 @@
263285
&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>
264286
&nbsp;&nbsp;&nbsp;&nbsp;self.<strong>input_formats</strong>&nbsp;=&nbsp;<a href="#-format_term">format_term</a>(**input_formats)</tt></dd></dl>
265287

266-
<dl><dt><a name="AsyncRawInput-redraw_lastinp"><strong>redraw_lastinp</strong></a>(self, at: int)</dt><dd><tt>Redisplay&nbsp;a&nbsp;user&nbsp;prompt&nbsp;at&nbsp;specified&nbsp;position&nbsp;on&nbsp;current&nbsp;cursor&nbsp;line.</tt></dd></dl>
288+
<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>
289+
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>
267290

268291
<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>
269292
&nbsp;<br>
270293
Parameters&nbsp;:&nbsp;str<br>
271294
&nbsp;&nbsp;&nbsp;&nbsp;Raw&nbsp;keystroke&nbsp;code.</tt></dd></dl>
272295

273-
<dl><dt><a name="AsyncRawInput-set_interrupt_handler"><strong>set_interrupt_handler</strong></a>(self, awaitable)</dt><dd><tt>Sets&nbsp;the&nbsp;callback&nbsp;for&nbsp;Ctrl&nbsp;+&nbsp;C&nbsp;keystroke<br>
296+
<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>
274297
&nbsp;<br>
275298
Parameters<br>
276299
----------<br>
277-
awaitable&nbsp;:&nbsp;coroutine&nbsp;function<br>
278-
&nbsp;&nbsp;&nbsp;&nbsp;async&nbsp;callback,&nbsp;called&nbsp;without&nbsp;arguments</tt></dd></dl>
300+
callback&nbsp;:&nbsp;coroutine&nbsp;or&nbsp;regular&nbsp;function<br>
301+
&nbsp;&nbsp;&nbsp;&nbsp;(async)&nbsp;callback,&nbsp;called&nbsp;without&nbsp;arguments</tt></dd></dl>
279302

280303
<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>
281304
Don't&nbsp;use&nbsp;it&nbsp;when&nbsp;a&nbsp;user&nbsp;input&nbsp;is&nbsp;prompted<br>
@@ -416,12 +439,13 @@
416439
<strong>MutableSequence</strong> = typing.MutableSequence<br>
417440
<strong>NOTSET</strong> = 0<br>
418441
<strong>Optional</strong> = typing.Optional<br>
442+
<strong>SIGWINCH</strong> = &lt;Signals.SIGWINCH: 28&gt;<br>
419443
<strong>Sequence</strong> = typing.Sequence<br>
420444
<strong>Tuple</strong> = typing.Tuple<br>
421445
<strong>Union</strong> = typing.Union<br>
422446
<strong>WARNING</strong> = 30<br>
423-
<strong>__warningregistry__</strong> = {'version': 0}<br>
424447
<strong>ansi_escape</strong> = re.compile('(\\x9B|\\x1B\\[)[0-?]*[ -\\/]*[@-~]')<br>
425448
<strong>do_backspace</strong> = '<font color="#c040c0">\x08\x1b</font>[0K'<br>
426-
<strong>loop</strong> = &lt;_UnixSelectorEventLoop running=False closed=False debug=False&gt;</td></tr></table>
449+
<strong>next_word</strong> = re.compile('\\w+\\W+(\\w+)')<br>
450+
<strong>prev_word</strong> = re.compile('(\\w+) *$')</td></tr></table>
427451
</body></html>

0 commit comments

Comments
 (0)