2bi$Y
% S r SSKrSSKrSSKJr Sr\\S' \R S:X a \R " \R 5 rO \
" \ S35 eSSK r SSKJ
r
JrJr SSKJrJrJrJr SS KJr SS
KJr S rS r\R4 r " S
S\ 5 r " S S\5 r " S S\
5 r " S S\R 5 r \RB RD r#\RH /\#l% \RL \#l' \4S\(S\RL 4S jjr"\RB RR r*\RL \RV /\*l% \RX \*l' S\RL S\(4S jr)\RB RZ r.\RL \R^ \RH \" \\ \ 5 \R` " \RH 5 /\.l% \RX \.l' S\RL S\1S\(S \ S\(4
S jr2\RB Rf r4\RL \Rj \RH \" \\ \ 5 \R` " \RH 5 /\4l% \RX \4l' S\RL S \(S\(S \ S\(4
S jr3\RB Rl r7\RL \Rj /\7l% \RX \7l' S\RL S \Rj S\84S jr6\RB Rr r:\RL \R` " \ 5 /\:l% \RX \:l' S\RL S\ 4S! jr9\RB Rv r<\RL \" \\ \ 5 /\\RL \R` " \ 5 /\>l% \RX \>l' S\RL S$\ S\84S% jr=\RB R~ r@\RL \R` " \ 5 /\@l% \RX \@l' S\RL S$\ S\84S& jr?\RB R rB\R /\Bl% \RX \Bl' S'\1S\84S( jrD " S) S*5 rE\ S+:X Ga \"" 5 rFSS,KGJHrH \H" 5 rI\E" \R 5 rK\KR S-5 \" S.S/S09rM\R " S15 rO\IR S25 \IR S35 \IR S45 \IR S55 \IR S65 \IR S75 \IR S85 \IR S95 \IR S:5 \IR S;5 \IR S<5 \IR S=5 \IR S>5 \IR S?5 \IR S@5 \IR SA5 \IR SB5 \IR 5 \KR 5 \KR 5 \KR SC5 \ R " SD5 \KR 5 \KR SE5 \ R " SD5 \KR 5 \KR SF5 \ R " SD5 \KR 5 \KR 5 \KR 5 \KR SG5 \ R " SD5 \KR 5 \KR 5 \KR 5 \KR SH5 \ R " SD5 \KR 5 \IR 5 \IR SI5 \IR SJ5 \KR SK5 \ R " SD5 \KR SL5 \KR SM\R " SN5 5 \KR 5 \ R " SD5 \KR 5 \ R " SD5 \IR SO5 \KR SK5 \ R " SD5 \KR SL5 \KR SP\R " SN5 5 \ R " SD5 \KR 5 \ R " SD5 \IR SQ5 \KR SR\R " SS5 ST9 \ R " SD5 \KR 5 \KR 5 \Q" SU5 gg)VzLight wrapper around the Win32 Console API - this module should only be imported on Windows
The API that this module wraps is documented at https://docs.microsoft.com/en-us/windows/console/console-functions
N)Anywindllwin32z can only be imported on Windows) Structurebyrefwintypes)IO
NamedTupleTypecast) ColorSystem)Stylei c \ rS rSrSrg)LegacyWindowsError N)__name__
__module__ __qualname____firstlineno____static_attributes__r ڑ/builddir/build/BUILDROOT/alt-python313-pip-23.3.1-3.el8.x86_64/opt/alt/python313/lib/python3.13/site-packages/pip/_vendor/rich/_win32_console.pyr r s r r c J \ rS rSr% Sr\\S' \\S' \SS S\4S j5 r Sr
g )
WindowsCoordinates zCoordinates in the Windows Console API are (y, x), not (x, y).
This class is intended to prevent that confusion.
Rows and columns are indexed from 0.
This class can be used in place of wintypes._COORD in arguments and argtypes.
rowcolvaluereturnc B [ UR UR 5 $ )a Converts a WindowsCoordinates into a wintypes _COORD structure.
This classmethod is internally called by ctypes to perform the conversion.
Args:
value (WindowsCoordinates): The input coordinates to convert.
Returns:
wintypes._COORD: The converted coordinates struct.
)COORDr r )clsr s r
from_param WindowsCoordinates.from_param* s UYY **r r N) r r r r __doc__int__annotations__ classmethodr# r% r r r r r r s4
H H
+ 3
+
+
+r r c ^ \ rS rSrS\4S\4S\R 4S\R 4S\4/rSr g) CONSOLE_SCREEN_BUFFER_INFO8 dwSizedwCursorPosition wAttributessrWindowdwMaximumWindowSizer N)
r r r r r# r WORD
SMALL_RECT_fields_r r r r r, r, 8 s; 5 U#
& X(() & Hr r, c L \ rS rSrS\R
4S\R 4/rSrg)CONSOLE_CURSOR_INFOB r. bVisibler N) r r r r r DWORDBOOLr5 r r r r r7 r7 B s 8>>*Z ,GHHr r7 handler! c H [ [ R [ U 5 5 $ )zRetrieves a handle to the specified standard device (standard input, standard output, or standard error).
Args:
handle (int): Integer identifier for the handle. Defaults to -11 (stdout).
Returns:
wintypes.HANDLE: The handle
)r r HANDLE
_GetStdHandle)r< s r GetStdHandler@ M s v!6 77r
std_handlec [ R " 5 n[ [ X5 5 nU( d [ S5 eUR
$ )a Retrieves the current input mode of a console's input buffer
or the current output mode of a console screen buffer.
Args:
std_handle (wintypes.HANDLE): A handle to the console input buffer or the console screen buffer.
Raises:
LegacyWindowsError: If any error occurs while calling the Windows console API.
Returns:
int: Value representing the current console mode as documented at
https://docs.microsoft.com/en-us/windows/console/getconsolemode#parameters
z)Unable to get legacy Windows Console Mode)r r: bool_GetConsoleModer r )rA console_modesuccesss r GetConsoleModerG ^ s: >>#L?:<=G !LMM r charlengthstartc [ R " UR 5 5 n[ R " U5 n[ R " S5 n[ U UUU[
U5 5 UR $ )a Writes a character to the console screen buffer a specified number of times, beginning at the specified coordinates.
Args:
std_handle (wintypes.HANDLE): A handle to the console input buffer or the console screen buffer.
char (str): The character to write. Must be a string of length 1.
length (int): The number of times to write the character.
start (WindowsCoordinates): The coordinates to start writing at.
Returns:
int: The number of characters written.
r )ctypesc_charencoder r: _FillConsoleOutputCharacterWr r )rA rH rI rJ characternum_characters num_writtens r FillConsoleOutputCharacterrS s^ "
dkkm,I ^^F+N..#K
k r
attributesc [ R " U5 n[ R " U5 n[ R " S5 n[ XXC[ U5 5 UR
$ )aH Sets the character attributes for a specified number of character cells,
beginning at the specified coordinates in a screen buffer.
Args:
std_handle (wintypes.HANDLE): A handle to the console input buffer or the console screen buffer.
attributes (int): Integer value representing the foreground and background colours of the cells.
length (int): The number of cells to set the output attribute of.
start (WindowsCoordinates): The coordinates of the first cell whose attributes are to be set.
Returns:
int: The number of cells whose attributes were actually set.
r )r r: r3 _FillConsoleOutputAttributer r )rA rT rI rJ num_cells style_attrsrR s r FillConsoleOutputAttributerY sP $ v&I--
+K..#K 53E r c * [ [ X5 5 $ )ad Set the colour attributes for all text written after this function is called.
Args:
std_handle (wintypes.HANDLE): A handle to the console input buffer or the console screen buffer.
attributes (int): Integer value representing the foreground and background colours.
Returns:
bool: True if the attribute was set successfully, otherwise False.
)rC _SetConsoleTextAttribute)rA rT s r SetConsoleTextAttributer\ s (@ AAr c D [ 5 n[ U [ U5 5 U$ )a] Retrieves information about the specified console screen buffer.
Args:
std_handle (wintypes.HANDLE): A handle to the console input buffer or the console screen buffer.
Returns:
CONSOLE_SCREEN_BUFFER_INFO: A CONSOLE_SCREEN_BUFFER_INFO ctype struct contain information about
screen size, cursor position, colour attributes, and more.)r, _GetConsoleScreenBufferInfor )rA console_screen_buffer_infos r GetConsoleScreenBufferInfor` s# ">r cursor_infoc > [ [ U [ U5 5 5 $ )av Get the cursor info - used to get cursor visibility and width
Args:
std_handle (wintypes.HANDLE): A handle to the console input buffer or the console screen buffer.
cursor_info (CONSOLE_CURSOR_INFO): CONSOLE_CURSOR_INFO ctype struct that receives information
about the console's cursor.
Returns:
bool: True if the function succeeds, otherwise False.
)rC _GetConsoleCursorInfor rA re s r GetConsoleCursorInfori s %j% 2DE FFr c > [ [ U [ U5 5 5 $ )a_ Set the cursor info - used for adjusting cursor visibility and width
Args:
std_handle (wintypes.HANDLE): A handle to the console input buffer or the console screen buffer.
cursor_info (CONSOLE_CURSOR_INFO): CONSOLE_CURSOR_INFO ctype struct containing the new cursor info.
Returns:
bool: True if the function succeeds, otherwise False.
)rC _SetConsoleCursorInfor rh s r SetConsoleCursorInforl * s %j% 2DE FFr titlec * [ [ U 5 5 $ )zSets the title of the current console window
Args:
title (str): The new title of the console window.
Returns:
bool: True if the function succeeds, otherwise False.
)rC _SetConsoleTitle)rm s r SetConsoleTitlerp > s ' ((r c $ \ rS rSrSrSr/ SQrS S jr\S\ 4S j5 r
\S\ 4S j5 r S
\ SS4S jr
S
\ S \SS4S
jrS\ SS4S jrS S jrS S jrS S jrS S jrS S jrS S jrS\SS4S jrS S jrS S jrS S jrS\ SS4S jr S\4S jr S r g)!LegacyWindowsTermiJ an This class allows interaction with the legacy Windows Console API. It should only be used in the context
of environments where virtual terminal processing is not available. However, if it is used in a Windows environment,
the entire API should work.
Args:
file (IO[str]): The file which the Windows Console API HANDLE is retrieved from, defaults to sys.stdout.
)r r rs
r! Nc $ [ [ 5 nX l [ U5 R nX0l US- U l US- S- U l U R U R S- - U l Xl UR U l
UR U l g )Nry r ) r@ STDOUT_handler` r0
_default_text
_default_fore
_default_back_default_attrs_filewriteflush)selffiler< default_texts r __init__LegacyWindowsTerm.__init__i s f% 1&9EE ) )A - *a /1 4 " 0 0D4F4F!4K L
ZZ
ZZ
r c [ U R 5 R n[ [ [
UR 5 [ [
UR 5 S9$ )ztReturns the current position of the cursor (0-based)
Returns:
WindowsCoordinates: The current cursor position.
r r )r` r r/ r r r( YX)r coords r cursor_position!LegacyWindowsTerm.cursor_positionw s; 2$,,?PP!d3&8d3>PQQr c [ U R 5 R n[ [ [
UR 5 [ [
UR 5 S9$ )zReturns the current size of the console screen buffer, in character columns and rows
Returns:
WindowsCoordinates: The width and height of the screen as WindowsCoordinates.
r )r` r r. r r r( r r )r screen_sizes r r LegacyWindowsTerm.screen_size s@ 8 E L L !S+--(d3
.F
r textc F U R U5 U R 5 g)zWrite text directly to the terminal without any modification of styles
Args:
text (str): The text to write to the console
N)r r )r r s r
write_text LegacyWindowsTerm.write_text s
4
r stylec UR nUR nUR ( a XCpCU( a UR [ R
5 R nUb UOSnUR ( a XPR - nUR ( a XPR ) - nU R U nO U R nU( a@ UR [ R
5 R nUb UOSnU R U nO U R nUc eUc e[ U R [ R " XVS- - 5 S9 U R# U5 [ U R U R$ S9 g)zuWrite styled text to the terminal.
Args:
text (str): The text to write
style (Style): The style of the text
Nry r r )rT )colorbgcolorreverse downgrader
WINDOWSnumberbold
BRIGHT_BITdimANSI_TO_WINDOWSr r r\ r rL c_ushortr r )r r r r r forebacks r write_styled LegacyWindowsTerm.write_styled s0 -- == $7 ??;#6#67>>D +4Dzzoo-yy ..''-D%%D $$[%8%89@@D +4D''-D%%D LLV__TQY5G%H
9K9KLr new_positionc n UR S: d UR S: a g[ U R US9 g)zSet the position of the cursor
Args:
new_position (WindowsCoordinates): The WindowsCoordinates representing the new position of the cursor.
r Nra )r r rd r )r r s r move_cursor_to LegacyWindowsTerm.move_cursor_to s0 a <#3#3a#7 lCr c U R nU R nUR n[ UR SS9n[ U R SX4S9 [ U R U R UUS9 g)z@Erase all content on the line the cursor is currently located atr r rI rJ N) r r r r r rS r rY r )r r r cells_to_erasestart_coordinatess r
erase_line LegacyWindowsTerm.erase_line sg && ..$ .?3F3FA N" LL#n
# LL !#
r c U R nU R R UR -
n[ U R SX!S9 [ U R U R UUS9 g)zBErase all content from the cursor position to the end of that liner r N)r r r rS r rY r )r r r s r erase_end_of_line#LegacyWindowsTerm.erase_end_of_line s\ .. ))--0C0CC" LL#n
# LL !!
r c U R u p[ US5 n[ U R SX#S9 [ U R U R
X#S9 g)zDErase all content from the cursor position to the start of that liner r r N)r r rS r rY r )r r r rJ s r erase_start_of_line%LegacyWindowsTerm.erase_start_of_line sD ''"3*"4<<SN" LL$--c
r c U R n[ U R [ UR S-
UR
S9S9 g)z Move the cursor up a single cellrv r r Nr rd r r r r r r s r move_cursor_up LegacyWindowsTerm.move_cursor_up s: .. LL%#''!+ 1D1D
r c U R n[ U R [ UR S- UR
S9S9 g)z"Move the cursor down a single cellrv r r Nr r s r move_cursor_down"LegacyWindowsTerm.move_cursor_down s; .. LL%#''!+#''
r c U R u pX R R S-
:X a US-
nSnOUS-
n[ U R [ XS9S9 g)zIMove the cursor forward a single cell. Wrap to the next line if required.rv r r r Nr r r rd r r r r r s r move_cursor_forward%LegacyWindowsTerm.move_cursor_forward sT '' ""&&* * 1HCC 1HC LL!3!E
r columnc Z U R u p#[ U R [ X!5 S9 g)zMove cursor to the column specified by the zero-based column index, staying on the same row
Args:
column (int): The zero-based column index to move the cursor to.
r N)r rd r r )r r r _s r move_cursor_to_column'LegacyWindowsTerm.move_cursor_to_column s% %% 6H6UVr c U R u pUS:X a US- nU R R S-
nOUS- n[ U R [ XS9S9 g)zNMove the cursor backward a single cell. Wrap to the previous line if required.r rv r r Nr r s r move_cursor_backward&LegacyWindowsTerm.move_cursor_backward sU '' !8 1HC""&&*C 1HC LL!3!E
r c ` U R 5 n[ USS9n[ U R US9 g)zHide the cursorr r. r9 re N_get_cursor_sizer7 rl r )r current_cursor_sizeinvisible_cursors r hide_cursor LegacyWindowsTerm.hide_cursor$ s/ " 3 3 5.6ITUV T\\7GHr c ` U R 5 n[ USS9n[ U R US9 g)zShow the cursorrv r r Nr )r r visible_cursors r show_cursor LegacyWindowsTerm.show_cursor* s- " 3 3 5,4GRST T\\~Fr rm c F [ U5 S: d S5 e[ U5 g)zaSet the title of the terminal window
Args:
title (str): The new title of the console window
z.Console title must be less than 255 charactersN)lenrp )r rm s r set_titleLegacyWindowsTerm.set_title0 s$ 5zC Q!QQ r c h [ 5 n[ U R US9 [ UR 5 $ )zEGet the percentage of the character cell that is filled by the cursorr )r7 ri r r( r. )r re s r r "LegacyWindowsTerm._get_cursor_size9 s) )+ T\\{C;%%&&r )r r r r r r r r )r zIO[str]r! N)r! N) r r r r r' r r r propertyr r r strr r r r r r r r r r r( r r r r r r r r r r rr rr J s JO& R!3 R R
/
s t %M %MU %Mt %MND+= D$ D
WC WD W
I G s t '# 'r rr __main__)ConsolezWin32 Console Examplesblackred)r r zblack on greenzChecking colour outputz[on red]on red!z [blue]blue!z[yellow]yellow!z[bold yellow]bold yellow!z [bright_yellow]bright_yellow!z%[dim bright_yellow]dim bright_yellow!z[italic cyan]italic cyan!z'[bold white on blue]bold white on blue!z7[reverse bold white on blue]reverse bold white on blue!z'[bold black on cyan]bold black on cyan!z [black on green]black on green!z [blue on green]blue on green!z [white on black]white on black!z [black on white]black on white!z'[#1BB152 on #DA812D]#1BB152 on #DA812D!zChecking cursor movementz"went back and wrapped to prev linerv zwe go upzand downzwe went up and back 2zwe went down and back 2zChecking line erasingz(
...Deleting to the start of the line...z?The red arrow shows the cursor location, and direction of erase z)
...Now the whole line will be erased...zI'm going to disappear!z
black on cyan)r
)^r' rL systypingr r r) platform
LibraryLoaderWinDLL ImportErrorr timer r r r r
r r pip._vendor.rich.colorr
pip._vendor.rich.styler r "ENABLE_VIRTUAL_TERMINAL_PROCESSING_COORDr# Exceptionr r r, r7 kernel32r@ r? r: argtypesr> restyper( rG rD LPDWORDr; FillConsoleOutputCharacterWrO rM POINTERr rS rY rV r3 r\ r[ rC r` r^ rd rc ri rg rl rk SetConsoleTitleWro LPCWSTRrp rr r< pip._vendor.rich.consoler consolestdouttermr r parseheadingruleprintr r sleepr r r r r r r r r r r r r s>
<<7
!
!&--
0F
"BC
DD - - - - . ( %& " + +0 I&** I ,,
NN
!
& 8 8(// 8 //00 $OOX-=-=> "-- x 3 , & J J OO
MM NNe()
NN8>>" ) % (0}} $
< %oo H H OO MM NNe()
NN8>>" ( $ '/mm #
6 "??BB OO MM% ! $,==
B
B-5]]
B
B %oo H H OO
NN-.( $ '/mm #
&
&
& #OO D D OOe()& " %-MM ! ? ?); ? ? << OO
NN&'" !)
G
G.A
G
G << OO
NN&'" !)
G G.A G G ??33 % - - . #== )3 )4 )s' s'l z
^F0iG SZZ (DNN+, /Ekk*+G LL)* MM#$ MM- MM#$ MM-. MM12 MM9: MM-. MM;< MMKL MM;< MM34 MM12 MM34 MM34 MM;< LL+, MMO OO89JJqMOOJ JJqMOOJ JJqM OO+,JJqM OO-.JJqM MMO LL() MM=>OOUVJJqM r"c5;;~67 JJqM JJqM MM89OOUVJJqM r"c5;;~67JJqM JJqM MM?@/u{{?7STJJqMOO $Km r