2bi', S SK JrJrJrJrJrJrJrJr SSK J
r
SSK J r SSK
JrJr \" S5 r\" S5 r " S S \5 r " S
S \5 r " S S
\\ 5 r " S S\\ 5 r " S S\\ 5 r " S S\\ 5 r " S S\\ 5 r \ S:X a S SK J r \ RA SSS9( a \RA SS S9r!\!S: a \!S :: a O
\ " S 5 M' \ " S \! 35 \RA S SS!9r"\#" \"5 S : a O
\ " S"5 M' \ " S#\"< 35 \RA S$/ S%QS&9r$\ " S'\$< 35 g)\ " S(5 g)g))* )AnyGenericListOptionalTextIOTypeVarUnionoverload ) get_console)Console)TextTextType
PromptType DefaultTypec \ rS rSrSrSrg) PromptError z/Exception base class for prompt related errors. N)__name__
__module__ __qualname____firstlineno____doc____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/prompt.pyr r s 9r r c 8 \ rS rSrSrS\SS4S jrS\4S jrSrg) InvalidResponse zException 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 Xl g Nr! )selfr! s r __init__InvalidResponse.__init__ s r c U R $ r$ r% r& s r __rich__InvalidResponse.__rich__ s ||r r% ) r r r r r r r' r+ r r r r r r s& T ( r r c \ rS rSr% Sr\r\\S' Sr Sr
Sr Sr \
\\ \S' S*SS SS
S
S .S \S
\
\ S\S\
\\ S\S\SS4S jjjr\\ S*SS SS
S
SS.S \S
\
\ S\S\
\\ S\S\S\S\
\ S\\\4 4S jjj5 5 r\\ S*SS SS
S
SS.S \S
\
\ S\S\
\\ S\S\S\
\ S\4S jjj5 5 r\ S*SS SS
S
SSS.S \S
\
\ S\S\
\\ S\S\S\S\
\ S\4S jjj5 rS\S\4S jr S\S\4S jr \ S+S
\S \S\S\
\ S\4
S jj5 r S \S\4S jr S \S\4S jr S \S!\!SS4S" jr"S,S# jr#\SS$.S\
\ S\4S% jj5 r$\SS$.S\S\
\ S\\\4 4S& jj5 r$SSS'.S\S\
\ S\4S( jjr$S)r%g)-
PromptBase a\ 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: NchoicesFTconsolepasswordr1 show_default show_choicespromptr3 r4 r5 r6 r" c U=( d
[ 5 U l [ U[ 5 ( a [ R
" USS9OUU l X0l Ub X@l XPl X`l
g )Nr7 style) r r3
isinstancestrr from_markupr7 r4 r1 r5 r6 )r& r7 r3 r4 r1 r5 r6 s r r' PromptBase.__init__5 s[ /+- &#&&
V8 4
!
"L ( (r )r3 r4 r1 r5 r6 streamdefaultr? c g r$ r ) clsr7 r3 r4 r1 r5 r6 r@ r? s r askPromptBase.askK s r c g r$ r )rB r7 r3 r4 r1 r5 r6 r? s r rC rD [ s r .)r3 r4 r1 r5 r6 r@ r? c $ U " UUUUUUS9n U " XxS9$ )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.
r2 r@ r? r )
rB r7 r3 r4 r1 r5 r6 r@ r? _prompts
r rC rD j s- 6 %%
w66r c " [ SU S3S5 $ )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& r@ s r render_defaultPromptBase.render_default s ayN$455r c U R R 5 nSUl U R ( aU U R ( aD SR U R 5 nSU S3nUR
S5 UR
US5 US:w ae U R ( aT [ U[ U R 45 ( a3 UR
S5 U R U5 nUR
U5 UR
U R 5 U$ )zrMake prompt text.
Args:
default (DefaultType): Default value.
Returns:
Text: Text to display in prompt.
/[] zprompt.choices.)
r7 copyendr6 r1 joinappendr5 r; r< r0 rM
prompt_suffix)r& r@ r7 _choicesr1 _defaults r make_promptPromptBase.make_prompt s !!#
xx -H(1oG MM# MM'#3 4
sN!!7S$*<*<$=>> MM# **73H MM( #
d(()
r c " UR X#US9$ )zGet input from user.
Args:
console (Console): Console instance.
prompt (TextType): Prompt text.
password (bool): Enable password entry.
Returns:
str: String from user.
)r4 r? )input)rB r3 r7 r4 r? s r get_inputPromptBase.get_input s $ }}Vv}FFr valuec Z U R c eUR 5 U R ; $ )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.
)r1 stripr& rb s r check_choicePromptBase.check_choice s) ||'''{{} ,,r c UR 5 n U R U5 nU R
b+ U R
U5 ( d [ U R 5 eU$ ! [ a [ U R 5 ef = f)zProcess 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.
)rd r0
ValueErrorr validate_error_messager1 rf illegal_choice_message)r& rb return_values r process_responsePromptBase.process_response sy
?'+'9'9%'@L << #D,=,=e,D,D!$"="=> >
?!$"="=> > ?s A A=errorc : U R R U5 g)zCalled to handle validation error.
Args:
value (str): String entered by user.
error (InvalidResponse): Exception instance the initiated the error.
N)r3 print)r& rb ro s r on_validate_error PromptBase.on_validate_error s
5!r c g)z,Hook to display something before the prompt.Nr r* s r
pre_promptPromptBase.pre_prompt s r r? c g r$ r )r& r? s r __call__PromptBase.__call__ s r c g r$ r )r& r@ r? s r ry rz s r rG c & U R 5 U R U5 nU R U R X0R US9nUS:X a US:w a U$ U R U5 nU$ ! [ a nU R XF5 SnAM SnAff = f)z|Run the prompt loop.
Args:
default (Any, optional): Optional default value.
Returns:
PromptType: Processed value.
rw rP .N)ru r\ r` r3 r4 rm r rr )r& r@ r? r7 rb rl ro s r ry rz s OO %%g.FNN4<< vNVE{w#~
$ # 4 4U ;
$# #
&&u4
s A* *
B4B B)r1 r3 r4 r7 r6 r5 )rP r$ )r" N)&r r r r r r< r0 type__annotations__rj rk rY r1 r r r r
boolr' classmethodr
r r r r rC r r rM r\ r` rf rm r rr ru ry r 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 \ rS rSrSr\rSrg)Prompti zVA prompt that returns a str.
Example:
>>> name = Prompt.ask("Enter your name")
r N)r r r r r r< r0 r r r r r r s Mr r c \ rS rSrSr\rSrSrg) IntPrompti* z}A 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 numberr N) r r r r r intr0 rj r r r r r r * s M Rr r c \ rS rSrSr\rSrSrg) FloatPrompti6 zmA prompt that returns a float.
Example:
>>> temperature = FloatPrompt.ask("Enter desired temperature")
z%[prompt.invalid]Please enter a numberr N) r r r r r floatr0 rj r r r r r r 6 s M Dr r c ^ \ rS rSr% Sr\rSrSS/r\ \
\ S' S\ S\
4S jrS
\
S\4S jrS rg
)ConfirmiB zeA yes / no confirmation prompt.
Example:
>>> if Confirm.ask("Continue"):
run_job()
z#[prompt.invalid]Please enter Y or Nynr1 r@ r" c Z U R u p#[ U( a SU S3SS9$ SU S3SS9$ )z8Render the default as (y) or (n) rather than True/False.rJ rK rL r9 )r1 r )r& r@ yesnos r rM Confirm.render_defaultO s8 ,,'auAJ@PQQ2$ay@PQQr rb c UR 5 R 5 nXR ; a [ U R 5 eXR S :H $ )zConvert choices to a bool.r )rd lowerr1 r rj re s r rm Confirm.process_responseT sB
##% $!$"="=> > Q''r r N)r r r r r r r0 rj r1 r r< r~ r r rM rm r r r r r r B sO M B sGT#Y#Rk Rd R
(c (d (r r __main__)rq zRun [i]prompt[/i] tests?T)r@ 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))r4 z"[prompt.invalid]password too shortz password=z
Enter a fruit)appleorangepear)r1 zfruit=z[b]OK :loudly_crying_face:N)%typingr r r r r r r r
rP r r3 r
textr r r r Exceptionr r r. r< r r r r r r r pip._vendor.richrq rC resultr4 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