] | |||||| } | || 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, r9 r8 r )
r; r1 r- r. r* r/ r0 r9 r8 _prompts
r r< zPromptBase.askj sC 6 # %%
wwv6666r 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" r9 s r render_defaultzPromptBase.render_default s NNNN$4555r c | j }d|_ | j rR| j rKd | j }d| d}| d | |d |dk rb| j r[t |t | j
f r?| d | | }| | | | j |S )zMake prompt text.
Args:
default (DefaultType): Default value.
Returns:
Text: Text to display in prompt.
r+ /[] zprompt.choices.)
r1 copyendr0 r* joinappendr/ r5 r6 r) rE
prompt_suffix)r" r9 r1 _choicesr* _defaults r make_promptzPromptBase.make_prompt s !!##
5 5xx --H%(oooG MM# MM'#3 4 4 4
sNN!
7S$*<$=>>
MM# **733H MM( # # #
d()))
r c 2 | ||| 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. r8 )input)r; r- r1 r. r8 s r get_inputzPromptBase.get_input s $ }}Vhv}FFFr valuec 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 | } | | }n"# t $ r t | j w xY w| j )| | st | j |S )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 s
?'+'9'9%'@'@LL ? ? ?!$"=>> > ? < #D,=,=e,D,D #!$"=>> >s , A errorc : | j | dS )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 dS )z,Hook to display something before the prompt.Nr r% s r
pre_promptzPromptBase.pre_prompt s r r8 c d S r r )r" r8 s r __call__zPromptBase.__call__ s r c d S r r )r" r9 r8 s r ri zPromptBase.__call__ s r r? c B | | | }| | j || j | }|dk r|dk r|S | | }|S # t $ r }| || Y d}~d}~ww xY w)zRun the prompt loop.
Args:
default (Any, optional): Optional default value.
Returns:
PromptType: Processed value.
Trg r+ .N)rf rR rU r- r. r` r rd )r" r9 r8 r1 rV r_ ra s r ri zPromptBase.__call__ s $ OO %%g..FNN4< vNVVE{{w#~~
$ # 4 4U ; ;
$# #
&&ue444
s A4 4
B >BB )r+ r )r N)$r r r r r6 r) type__annotations__r] r^ rO r* r r r r
boolr# classmethodr
r r r r r< r r rE rR rU rZ r` r rd rf ri r r r r( r( s
M4 IK M#'GXd3i
''' ) &* '+ ! !) ) )) '" )
) $s)$
) ) )
) ) ) ),
&* '+ ! !#' '"
$s)$
{J& ' X [
&* '+ ! !#' '"
$s)$
X [ "7 &* '+ ! !#'"7 "7 "7"7 '" "7
"7 $s)$
"7 "7 "7 "7 "7
"7 "7 "7 ["7H 6k 6d 6 6 6 6 ; 4 > $( G GG G G
G
G G G [G&
-#
-$
-
-
-
- c j ."s "? "t " " " "; ; ; ; 59 (6"2 j X BF % /7/? z;& ' X
*- $ $ $3 $hv6F $RU $ $ $ $ $ $r r( c e Zd ZdZeZdS )PromptzbA prompt that returns a str.
Example:
>>> name = Prompt.ask("Enter your name")
N)r r r r r6 r) r r r rq rq s MMMr rq c e Zd ZdZeZdZdS ) 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 ZdZeZdZdS ) 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 Z e Zd ZU dZeZdZddgZee e
d< de de fdZ
d e defd
Zd S ) ConfirmzuA yes / no confirmation prompt.
Example:
>>> if Confirm.ask("Continue"):
run_job()
z#[prompt.invalid]Please enter Y or Nynr* r9 r c P | j \ }}t |rd| dnd| dd S )z8Render the default as (y) or (n) rather than True/False.rB rC rD r3 )r* r )r" r9 yesnos r rE zConfirm.render_defaultO s: ,R'8JJJJJy2yyy@PQQQQr rV c | }|| j vrt | j || j d k S )zConvert choices to a bool.r )rX lowerr* r r] rY s r r` zConfirm.process_responseT sJ
##%% $ $!$"=>> > Q''r N)r r r r rn r) r] r* r r6 rm r r rE r` r r r ry ry B s M B sGT#Y###Rk Rd R R R R
(c (d ( ( ( ( ( (r ry __main__)rc zRun [i]prompt[/i] tests?T)r9 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
r+ r r- r
textr r r r Exceptionr r r( r6 rq rt rs rw rv rn ry r pip._vendor.richrc r< resultr. lenfruitr r r r s] Q Q Q Q Q Q Q Q Q Q Q Q Q Q Q Q Q Q Q Q
W\
"
"
gm$$ : : : : :) : : : k }$ }$ }$ }$ }$$ }$ }$ }$@ Z_ S S S S S
3 S S S E E E E E*U# E E E( ( ( ( (j ( ( (4 z&&&&&&{{-t{<< , S ]]HRS # F {{v|| EQ R R R
S !!! 8 zzO " H s8}}!! E6 7 7 7 8 &(&&'''
?4O4O4O
PP
u !!!!! *+++++7 r