-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathadmin_console.ainput.html
453 lines (402 loc) · 31.5 KB
/
admin_console.ainput.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
<!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> <br>
<font color="#ffffff" face="helvetica, arial"> <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 for creating a simple text user interfaces in Unix-like systems with using asyncio<br>
Doesn't support Windows or any non-POSIX terminals</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </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> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </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> <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> </tt></td>
<td colspan=2><tt><a href="#ARILogHandler">ARILogHandler</a>(ari: admin_console.ainput.<a href="#AsyncRawInput">AsyncRawInput</a>, level=0)<br>
<br>
Custom logging handler for displaying log messages in the terminal.<br> </tt></td></tr>
<tr><td> </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 the instance - basically setting the formatter to None<br>
and the filter list to empty.</tt></dd></dl>
<dl><dt><a name="ARILogHandler-emit"><strong>emit</strong></a>(self, record: logging.LogRecord)</dt><dd><tt>Do whatever it takes to actually log the specified logging record.<br>
<br>
This version is intended to be implemented by subclasses and so<br>
raises a 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 repr(self).</tt></dd></dl>
<dl><dt><a name="ARILogHandler-acquire"><strong>acquire</strong></a>(self)</dt><dd><tt>Acquire the I/O thread lock.</tt></dd></dl>
<dl><dt><a name="ARILogHandler-close"><strong>close</strong></a>(self)</dt><dd><tt>Tidy up any resources used by the handler.<br>
<br>
This version removes the handler from an internal map of handlers,<br>
_handlers, which is used for handler lookup by name. Subclasses<br>
should ensure that this gets called from overridden <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 a thread lock for serializing access to the underlying I/O.</tt></dd></dl>
<dl><dt><a name="ARILogHandler-flush"><strong>flush</strong></a>(self)</dt><dd><tt>Ensure all logging output has been flushed.<br>
<br>
This version does nothing and is intended to be implemented by<br>
subclasses.</tt></dd></dl>
<dl><dt><a name="ARILogHandler-format"><strong>format</strong></a>(self, record)</dt><dd><tt>Format the specified record.<br>
<br>
If a formatter is set, use it. Otherwise, use the default formatter<br>
for the 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 emit the specified logging record.<br>
<br>
Emission depends on filters which may have been added to the handler.<br>
Wrap the actual emission of the record with acquisition/release of<br>
the I/O thread lock. Returns whether the filter passed the record for<br>
emission.</tt></dd></dl>
<dl><dt><a name="ARILogHandler-handleError"><strong>handleError</strong></a>(self, record)</dt><dd><tt>Handle errors which occur during an <a href="#ARILogHandler-emit">emit</a>() call.<br>
<br>
This method should be called from handlers when an exception is<br>
encountered during an <a href="#ARILogHandler-emit">emit</a>() call. If raiseExceptions is false,<br>
exceptions get silently ignored. This is what is mostly wanted<br>
for a logging system - most users will not care about errors in<br>
the logging system, they are more interested in application errors.<br>
You could, however, replace this with a custom handler if you wish.<br>
The record which was being processed is passed in to this method.</tt></dd></dl>
<dl><dt><a name="ARILogHandler-release"><strong>release</strong></a>(self)</dt><dd><tt>Release the I/O thread lock.</tt></dd></dl>
<dl><dt><a name="ARILogHandler-setFormatter"><strong>setFormatter</strong></a>(self, fmt)</dt><dd><tt>Set the formatter for this handler.</tt></dd></dl>
<dl><dt><a name="ARILogHandler-setLevel"><strong>setLevel</strong></a>(self, level)</dt><dd><tt>Set the logging level of this handler. level must be an int or a 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 the specified filter to this handler.</tt></dd></dl>
<dl><dt><a name="ARILogHandler-filter"><strong>filter</strong></a>(self, record)</dt><dd><tt>Determine if a record is loggable by consulting all the filters.<br>
<br>
The default is to allow the record to be logged; any filter can veto<br>
this and the record is then dropped. Returns a zero value if a record<br>
is to be dropped, else non-zero.<br>
<br>
.. versionchanged:: 3.2<br>
<br>
Allow filters to be just callables.</tt></dd></dl>
<dl><dt><a name="ARILogHandler-removeFilter"><strong>removeFilter</strong></a>(self, filter)</dt><dd><tt>Remove the specified filter from this 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 for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if 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> <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> </tt></td>
<td colspan=2><tt><a href="#AsyncRawInput">AsyncRawInput</a>(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)<br>
<br>
Main class for asynchronous input and proper output handling<br>
<br>
Before using its features, self.<a href="#AsyncRawInput-prepare">prepare</a>() should be called<br>
self.<a href="#AsyncRawInput-end">end</a>() is called on <a href="builtins.html#object">object</a> destruction handler<br>
<br>
self.<strong>loop</strong> : asyncio.BaseEventLoop<br>
Event loop attached to the IO handler<br>
self.<strong>is_reading</strong> : bool<br>
Whether or not the user input is currently receiving<br>
self.<strong>stdin</strong> : io.TextIOWrapper<br>
File-like <a href="builtins.html#object">object</a> handling the terminal input<br>
self.<strong>stdout</strong> : io.TextIOWrapper<br>
File-like <a href="builtins.html#object">object</a> handling the terminal output<br>
self.<strong>read_lastinp</strong> : list<br>
List of str, containing each character for a mutable Unicode string<br>
Represents an unentered user input displaying on the terminal<br>
self.<strong>read_lastprompt</strong> : str<br>
A prompt. Text prepending the user input line.<br>
To format a prompt, set self.<strong>prompt_formats</strong><br>
self.<strong>old_tcattrs</strong> : list<br>
List of control terminal arguments that have been set before <a href="#AsyncRawInput-prepare">prepare</a>() called<br>
self.<strong>history</strong> : list<br>
List of previous user inputs<br>
self.<strong>history_limit</strong> : int<br>
Threshold of automatic entry deletion of old user inputs<br>
self.<strong>cursor</strong> : int<br>
Current position of the user terminal cursor.<br>
self.<strong>echo</strong> : bool = True<br>
Whether or not the user input is shown on the terminal. Don't modify it manually<br>
self.<strong>ctrl_c</strong> : (async) function<br>
Async callback that is called when Ctrl + C is pressed in the terminal<br>
self.<strong>keystrokes</strong> : dict<br>
Mapping of keystroke handlers.<br>
{ "raw keystroke code": async callable }<br>
self.<strong>prompt_formats</strong> : tuple(str, str)<br>
Formatting header, footer pair for displaying a prompt.<br>
self.<strong>input_formats</strong> : tuple(str, str)<br>
Formatting header, footer pair for displaying a user input<br> </tt></td></tr>
<tr><td> </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 = <_io.TextIOWrapper name='<stdin>' mode='r' encoding='utf-8'>, stdout: _io.TextIOWrapper = <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>, *, loop=None)</dt><dd><tt>Parameters<br>
----------<br>
history : list<br>
List of str containing previous user input<br>
history_limit : int = 30<br>
Max amount of elements in history list, when exceeded the old values gets deleted.<br>
stdin : io.TextIOWrapper = sys.stdin<br>
File-like <a href="builtins.html#object">object</a> handling standard input. Should be tty-like file<br>
stdout : io.TextIOWrapper = sys.stdout<br>
File-like <a href="builtins.html#object">object</a> handling standard output.</tt></dd></dl>
<dl><dt><a name="AsyncRawInput-add_keystroke"><strong>add_keystroke</strong></a>(self, keystroke: str, asyncfunction)</dt><dd><tt>Add a new keystroke to the terminal<br>
<br>
Parameters<br>
----------<br>
keystroke : str<br>
Raw keystroke code. For example, tab keystroke will be: "\t", Ctrl + F will be "\x06"<br>
asyncfunction : async function<br>
Async callback called without arguments</tt></dd></dl>
<dl><dt><a name="AsyncRawInput-end"><strong>end</strong></a>(self)</dt><dd><tt>Disables raw mode, restoring the old TTY settings for standard input<br>
Unhooks the SIGWINCH signal handler.</tt></dd></dl>
<dl><dt><a name="AsyncRawInput-get_interrupt_handler"><strong>get_interrupt_handler</strong></a>(self) -> Callable[[Any], Coroutine[Any, Any, Any]]</dt></dl>
<dl><dt><a name="AsyncRawInput-get_terminal_size"><strong>get_terminal_size</strong></a>(self) -> 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 the cursor across the current line.<br>
Parameter at starts from 1, which means that at=1 is the first character of the terminal 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 the cursor's input position at specified character. Scrolls the input horizontally when 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 raw mode, saving the old TTY settings. Disables blocking mode for standard input<br>
Hooks up the SIGWINCH signal handler, which will redraw the prompt line if any.</tt></dd></dl>
<dl><dt>async <a name="AsyncRawInput-prompt_keystroke"><strong>prompt_keystroke</strong></a>(self, prompt=': ', echo=True) -> str</dt><dd><tt>Start reading a single character from a terminal. Not handling the keystrokes.<br>
<br>
Parameters<br>
----------<br>
prompt : str<br>
The text that is displayed before user input<br>
echo : bool<br>
Whether or not a user input will be displayed.<br>
<br>
Returns<br>
-------<br>
str<br>
Resulting pressed keystroke</tt></dd></dl>
<dl><dt>async <a name="AsyncRawInput-prompt_line"><strong>prompt_line</strong></a>(self, prompt='> ', echo=True, history_disabled=False, prompt_formats={}, input_formats={})</dt><dd><tt>Start reading a single-line user input with prompt from <a href="#AsyncRawInput">AsyncRawInput</a>.stdin.<br>
Asynchronous version of input(prompt), handling the keystrokes.<br>
In addition to Python's input(prompt) function, the input is not wrapped<br>
into the new line when overflowed, instead it hides the leftmost characters,<br>
as well as handling the controlling terminal's resizing.<br>
To register a keystroke, use <a href="#AsyncRawInput">AsyncRawInput</a>.<a href="#AsyncRawInput-add_keystroke">add_keystroke</a>(code, asyncfunction)<br>
<br>
Parameters<br>
----------<br>
prompt : str<br>
The text that is displayed before user input<br>
echo : bool<br>
Whether or not a user input will be displayed. Set to False when prompting a password<br>
history_disabled : bool<br>
Whether or not a new entry should not be added on successful user input. Set to True when prompting a password<br>
prompt_formats : dict<br>
Dictionary of text formatting settings that are passed into format_term<br>
self.<strong>prompt_formats</strong> = <a href="#-format_term">format_term</a>(**prompt_formats)<br>
input_formats : dict<br>
Dictionary of text formatting settings that are passed into format_term<br>
self.<strong>input_formats</strong> = <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 a user input at specified position on current cursor line.<br>
If force_redraw_prompt is True, redraws the whole line entirely (including the prompt) regardless of scrolling state</tt></dd></dl>
<dl><dt><a name="AsyncRawInput-remove_keystroke"><strong>remove_keystroke</strong></a>(self, keystroke: str)</dt><dd><tt>Remove a keystroke from the terminal<br>
<br>
Parameters : str<br>
Raw keystroke code.</tt></dd></dl>
<dl><dt><a name="AsyncRawInput-set_interrupt_handler"><strong>set_interrupt_handler</strong></a>(self, callback)</dt><dd><tt>Sets the callback for Ctrl + C keystroke<br>
<br>
Parameters<br>
----------<br>
callback : coroutine or regular function<br>
(async) callback, called without arguments</tt></dd></dl>
<dl><dt><a name="AsyncRawInput-write"><strong>write</strong></a>(self, msg: str, **formats)</dt><dd><tt>Write a formatted text to a terminal without CRLF.<br>
Don't use it when a user input is prompted<br>
<br>
Parameters<br>
----------<br>
msg : str<br>
The text without CRLF.<br>
**formats : keyword arguments<br>
Formatting arguments passed as <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 a message on the terminal, preserving a user prompt if any.<br>
<br>
Parameters<br>
----------<br>
msg : str<br>
The message text.<br>
**formats : keyword arguments<br>
Formatting arguments passed as <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 for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if 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> <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> </tt></td>
<td colspan=2><tt><a href="#colors">colors</a>(value, names=None, *, module=None, qualname=None, type=None, start=1)<br>
<br>
ANSI terminal <a href="#colors">colors</a><br> </tt></td></tr>
<tr><td> </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> = <colors.BLACK: 0></dl>
<dl><dt><strong>BLUE</strong> = <colors.BLUE: 4></dl>
<dl><dt><strong>CYAN</strong> = <colors.CYAN: 6></dl>
<dl><dt><strong>GREEN</strong> = <colors.GREEN: 2></dl>
<dl><dt><strong>MAGENTA</strong> = <colors.MAGENTA: 5></dl>
<dl><dt><strong>RED</strong> = <colors.RED: 1></dl>
<dl><dt><strong>WHITE</strong> = <colors.WHITE: 7></dl>
<dl><dt><strong>YELLOW</strong> = <colors.YELLOW: 3></dl>
<hr>
Data descriptors inherited from <a href="enum.html#Enum">enum.Enum</a>:<br>
<dl><dt><strong>name</strong></dt>
<dd><tt>The name of the Enum member.</tt></dd>
</dl>
<dl><dt><strong>value</strong></dt>
<dd><tt>The value of the Enum 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 a mapping of member name->value.<br>
<br>
This mapping lists all enum members, including aliases. Note that this<br>
is a read-only view of the internal 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> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-carriage_return"><strong>carriage_return</strong></a>(arg) -> str</dt><dd><tt>Convert plain newline to CR + LF<br>
<br>
Returns<br>
-------<br>
str<br>
Converted string<br>
return arg.replace('<br>
', '<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) -> (<class 'str'>, <class 'str'>)</dt><dd><tt>Returns a tuple(ansi_escape_start: str, ansi_escape_end: str) for specified format<br>
Tip: "%stext%s" % <a href="#-format_term">format_term</a>(args...)<br>
<br>
Parameters<br>
----------<br>
bold : bool = False<br>
Formatted text appears bold (on some terminals also appears with bright color)<br>
italic : bool = False<br>
Formatted text appears italic<br>
underline : bool = False<br>
Formatted text appears with underline<br>
blink : bool = False<br>
Formatted text will blink fast if True<br>
fgcolor : <a href="#colors">colors</a> or int = None<br>
Set foreground (font) color<br>
If enum <a href="#colors">colors</a> specified, formatted text will have an 8-color format<br>
If integer specified, formatted text will have an 256-color format<br>
bgcolor : <a href="#colors">colors</a> of int = None<br>
Set background (fill) color<br>
If enum <a href="#colors">colors</a> specified, formatted text will have an 8-color format<br>
If integer specified, formatted text will have an 256-color format<br>
<br>
Example<br>
-------<br>
<a href="#AsyncRawInput">AsyncRawInput</a>.writeln("%sHello world!%s" % <a href="#-format_term">format_term</a>(italic=True, fgcolor=<a href="#colors">colors</a>.GREEN, 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 print wrapper, but with end='<br>
'</tt></dd></dl>
<dl><dt><a name="-truelen"><strong>truelen</strong></a>(text: str) -> int</dt><dd><tt>Returns amount of visible-on-terminal characters in the string</tt></dd></dl>
<dl><dt><a name="-truelen_list"><strong>truelen_list</strong></a>(seq: Sequence[str]) -> int</dt><dd><tt>Returns amount of visible-on-terminal characters in the sequence of 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> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </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> = <Signals.SIGWINCH: 28><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>