R`i', d dl mZmZmZmZmZmZmZmZ ddl m
Z
ddl m Z ddl
mZmZ ed Z ed Z G d d e Z G d
d e Z G d d
ee Z G d dee Z G d dee Z G d dee Z G d dee Z e dk( rd dl m Z e jA dd r ejA dd Z!e!dk\ re!d k rn e d ' e d e! ejA d d! Z" e#e" d k\ rn e d" ( e d#e" ejA d$g d%& Z$ e d'e$ y) e d( y)y))* )AnyGenericListOptionalTextIOTypeVarUnionoverload ) get_console)Console)TextTextType
PromptType DefaultTypec e Zd ZdZy) PromptErrorz/Exception base class for prompt related errors.N)__name__
__module__ __qualname____doc__ /builddir/build/BUILDROOT/alt-python312-pip-23.3.1-3.el8.x86_64/opt/alt/python312/lib/python3.12/site-packages/pip/_vendor/rich/prompt.pyr r s 9r r c , e Zd ZdZdeddfdZdefdZy)InvalidResponsezException to indicate a response was invalid. Raise this within process_response() to indicate an error
and provide an error message.
Args:
message (Union[str, Text]): Error message.
messagereturnNc || _ y Nr )selfr s r __init__zInvalidResponse.__init__ s r c | j S r r! r" s r __rich__zInvalidResponse.__rich__ s ||r )r r r r r r# r& r r r r r s& T ( r r c e Zd ZU dZeZeed< dZdZ dZ
dZ e e
e ed< d(dddd d d
d ed e e d
ede e
e dededdfdZee d(dddd d ddd ed e e d
ede e
e dededede e deeef fd Zee d(dddd d ddd ed e e d
ede e
e dedede e defd Ze d(dddd d dddd ed e e d
ede e
e dededede e defd ZdedefdZdedefdZ e d)d ed ed
ede e def
d Z d edefd Z d edefd Z d ed e ddfd!Z!d*d"Z"edd#de e defd$ Z#edd#dede e deeef fd% Z#ddd&dede e defd'Z#y)+
PromptBasea Ask the user for input until a valid response is received. This is the base class, see one of
the concrete classes for examples.
Args:
prompt (TextType, optional): Prompt text. Defaults to "".
console (Console, optional): A Console instance or None to use global console. Defaults to None.
password (bool, optional): Enable password input. Defaults to False.
choices (List[str], optional): A list of valid choices. Defaults to None.
show_default (bool, optional): Show default in prompt. Defaults to True.
show_choices (bool, optional): Show choices in prompt. Defaults to True.
response_typez*[prompt.invalid]Please enter a valid valuezA[prompt.invalid.choice]Please select one of the available optionsz: NchoicesFTconsolepasswordr* show_default show_choicespromptr, r- r. r/ r c |xs
t | _ t |t rt j
|d n|| _ || _ ||| _ || _ || _
y )Nr0 style) r r,
isinstancestrr from_markupr0 r- r* r. r/ )r" r0 r, r- r* r. r/ s r r# zPromptBase.__init__5 s` /+- &#&
V8 4
!
"DL ( (r )r, r- r* r. r/ streamdefaultr7 c y r r ) clsr0 r, r- r* r. r/ r8 r7 s r askzPromptBase.askK s r c y r r )r: r0 r, r- r* r. r/ r7 s r r; zPromptBase.ask[ s r .)r, r- r* r. r/ r8 r7 c 2 | |||||| } | || S )a Shortcut to construct and run a prompt loop and return the result.
Example:
>>> filename = Prompt.ask("Enter a filename")
Args:
prompt (TextType, optional): Prompt text. Defaults to "".
console (Console, optional): A Console instance or None to use global console. Defaults to None.
password (bool, optional): Enable password input. Defaults to False.
choices (List[str], optional): A list of valid choices. Defaults to None.
show_default (bool, optional): Show default in prompt. Defaults to True.
show_choices (bool, optional): Show choices in prompt. Defaults to True.
stream (TextIO, optional): Optional text file open for reading to get input. Defaults to None.
r+ r8 r7 r )
r: r0 r, r- r* r. r/ r8 r7 _prompts
r r; zPromptBase.askj s/ 6 %%
wv66r c " t d| dd S )zTurn the supplied default in to a Text instance.
Args:
default (DefaultType): Default value.
Returns:
Text: Text containing rendering of default value.
()prompt.default)r )r" r8 s r render_defaultzPromptBase.render_default s ayN$455r c | j j }d|_ | j rP| j rDdj | j }d| d}|j
d |j
|d |dk7 r[| j rOt |t | j f r3|j
d | j | }|j
| |j
| j |S )zMake prompt text.
Args:
default (DefaultType): Default value.
Returns:
Text: Text to display in prompt.
/[] zprompt.choices.)
r0 copyendr/ r* joinappendr. r4 r5 r) rD
prompt_suffix)r" r8 r0 _choicesr* _defaults r make_promptzPromptBase.make_prompt s !!#
xx -H(1oG MM# MM'#3 4
sN!!7S$*<*<$=> MM# **73H MM( #
d(()
r c * |j ||| S )zGet input from user.
Args:
console (Console): Console instance.
prompt (TextType): Prompt text.
password (bool): Enable password entry.
Returns:
str: String from user.
)r- r7 )input)r: r, r0 r- r7 s r get_inputzPromptBase.get_input s $ }}Vhv}FFr valuec V | j J |j | j v S )zCheck value is in the list of valid choices.
Args:
value (str): Value entered by user.
Returns:
bool: True if choice was valid, otherwise False.
)r* stripr" rV s r check_choicezPromptBase.check_choice s) ||'''{{} ,,r c |j } | j | }| j
&| j
| st | j |S # t $ r t | j w xY w)a Process response from user, convert to prompt type.
Args:
value (str): String typed by user.
Raises:
InvalidResponse: If ``value`` is invalid.
Returns:
PromptType: The value to be returned from ask method.
)rX r)
ValueErrorr validate_error_messager* rZ illegal_choice_message)r" rV return_values r process_responsezPromptBase.process_response sv
?'+'9'9%'@L << #D,=,=e,D!$"="=> >
?!$"="=> > ?s A A6errorc : | j j | y)zCalled to handle validation error.
Args:
value (str): String entered by user.
error (InvalidResponse): Exception instance the initiated the error.
N)r, print)r" rV ra s r on_validate_errorz PromptBase.on_validate_error s
5!r c y)z,Hook to display something before the prompt.Nr r% s r
pre_promptzPromptBase.pre_prompt s r r7 c y r r )r" r7 s r __call__zPromptBase.__call__ s r c y r r )r" r8 r7 s r ri zPromptBase.__call__ s r r> c ( | j | j | }| j | j || j | }|dk( r|dk7 r|S | j | }|S # t $ r }| j || Y d}~d}~ww xY w)zRun the prompt loop.
Args:
default (Any, optional): Optional default value.
Returns:
PromptType: Processed value.
rg rF .N)rf rR rU r, r- r` r rd )r" r8 r7 r0 rV r_ ra s r ri zPromptBase.__call__ s OO %%g.FNN4<< vNVE{w#~
$ # 4 4U ;
$# #
&&ue4
s A, , B5B B)rF r )r N)$r r r r r5 r) type__annotations__r] r^ rO r* r r r r
boolr# classmethodr
r r r r r; r r rD rR rU rZ r` r rd rf ri r r r r( r( s
M4 IK M#'GXd3i
' ) &* '+ ! !)) '" )
) $s)$
) ) )
),
&* '+ ! !#' '"
$s)$
{J& '
&* '+ ! !#' '"
$s)$
"7 &* '+ ! !#'"7"7 '" "7
"7 $s)$
"7 "7 "7 "7 "7
"7 "7H 6k 6d 6 ; 4 > $( GG G G
G
G G&
-#
-$
- c j ."s "? "t "; 59 (6"2 j BF % /7/? z;& '
*- $3 $hv6F $RU $r r( c e Zd ZdZeZy)PromptzbA prompt that returns a str.
Example:
>>> name = Prompt.ask("Enter your name")
N)r r r r r5 r) r r r rq rq s Mr rq c e Zd ZdZeZdZy) IntPromptzA prompt that returns an integer.
Example:
>>> burrito_count = IntPrompt.ask("How many burritos do you want to order")
z3[prompt.invalid]Please enter a valid integer numberN)r r r r intr) r] r r r rs rs * s M Rr rs c e Zd ZdZeZdZy) FloatPromptzyA prompt that returns a float.
Example:
>>> temperature = FloatPrompt.ask("Enter desired temperature")
z%[prompt.invalid]Please enter a numberN)r r r r floatr) r] r r r rv rv 6 s M Dr rv c R e Zd ZU dZeZdZddgZee e
d< de de fdZ
d e defd
Zy ) ConfirmzuA yes / no confirmation prompt.
Example:
>>> if Confirm.ask("Continue"):
run_job()
z#[prompt.invalid]Please enter Y or Nynr* r8 r c ^ | j \ }}t |r d| dd S d| dd S )z8Render the default as (y) or (n) rather than True/False.rA rB rC r2 )r* r )r" r8 yesnos r rD zConfirm.render_defaultO s: ,,R'auAJ@PQQ2$ay@PQQr rV c |j j }|| j vrt | j || j d k( S )zConvert choices to a bool.r )rX lowerr* r r] rY s r r` zConfirm.process_responseT sF
##% $!$"="=> > Q''r N)r r r r rn r) r] r* r r5 rm r r rD r` r r r ry ry B sO M B sGT#Y#Rk Rd R
(c (d (r ry __main__)rc zRun [i]prompt[/i] tests?T)r8 z6:rocket: Enter a number between [b]1[/b] and [b]10[/b]
z=:pile_of_poo: [prompt.invalid]Number must be between 1 and 10znumber=z=Please enter a password [cyan](must be at least 5 characters))r- z"[prompt.invalid]password too shortz password=z
Enter a fruit)appleorangepear)r* zfruit=z[b]OK :loudly_crying_face:N)%typingr r r r r r r r
rF r r, r
textr r r r Exceptionr r r( r5 rq rt rs rv rn ry r pip._vendor.richrc r; resultr- lenfruitr r r r s Q Q Q
\
"
m$ :) : k }$$ }$@ Z_ S
3 S E*S/ E(j (4 z&{{-t{< ]]HRS # F {v| Q R
x ! zzO " H 8}! 6 7 ( &'
?4O
P
ui ! *+9 r