X~ dZddlZddlZddlmZddlmZmZmZm Z m Z m Z ddl m Z mZdZdZ ej"eZddZdd Zdd Zd Zd Zefd ZGddeZy)a; Interactive terminal prompts. The :mod:`~humanfriendly.prompts` module enables interaction with the user (operator) by asking for confirmation (:func:`prompt_for_confirmation()`) and asking to choose from a list of options (:func:`prompt_for_choice()`). It works by rendering interactive prompts on the terminal. N)interactive_prompt)HIGHLIGHT_COLOR ansi_strip ansi_wrapconnected_to_terminalterminal_supports_colorswarning)format concatenate) MAX_ATTEMPTSTooManyInvalidRepliesloggerprepare_friendly_promptsprepare_prompt_textprompt_for_choiceprompt_for_confirmationprompt_for_input retry_limit cZt|d}|rdn|dnd}|dt|tzz }tjd t |j t D]}t|d |d }|jd vrtjd |y|jdvrtjd|y|s |tjd|rdnd|cS|rd|znd}tjd|rdnd||ttd|rdnd |y)a Prompt the user for confirmation. :param question: The text that explains what the user is confirming (a string). :param default: The default value (a boolean) or :data:`None`. :param padding: Refer to the documentation of :func:`prompt_for_input()`. :returns: - If the user enters 'yes' or 'y' then :data:`True` is returned. - If the user enters 'no' or 'n' then :data:`False` is returned. - If the user doesn't enter any text or standard input is not connected to a terminal (which makes it impossible to prompt the user) the value of the keyword argument ``default`` is returned (if that value is not :data:`None`). :raises: - Any exceptions raised by :func:`retry_limit()`. - Any exceptions raised by :func:`prompt_for_input()`. When `default` is :data:`False` and the user doesn't enter any text an error message is printed and the prompt is repeated: >>> prompt_for_confirmation("Are you sure?") Are you sure? [y/n] Error: Please enter 'yes' or 'no' (there's no default choice). Are you sure? [y/n] The same thing happens when the user enters text that isn't recognized: >>> prompt_for_confirmation("Are you sure?") Are you sure? [y/n] about what? Error: Please enter 'yes' or 'no' (the text 'about what?' is not recognized). Are you sure? [y/n] Tboldz[Y/n]Nz[y/N]z[y/n]z %s )colorz5Requesting interactive confirmation from terminal: %rpaddingstrip)yyesz#Confirmation granted by reply (%r).)nnoz"Confirmation denied by reply (%r).F,Default choice selected by empty reply (%r).granteddeniedzthe text '%s' is not recognizedthere's no default choice&Got %s reply (%s), retrying (%i/%i) ..invalidemptyz6{indent}Error: Please enter 'yes' or 'no' ({details}). )indentdetails) rrrdebugrrstriprrlowerr r )questiondefaultr prompt_texthintattemptreplyr+s :/usr/lib/python3.12/site-packages/humanfriendly/prompts.pyrr6s L&hT:K7g.A7wD6/OLLLK LLH*U`JaJhJhJjk= b'N ;;=L ( LL> F [[]k ) LL=u EW0 LLG&-8 =N 95@%@  LLA&+' , 0 L")3r7 D%!c >|rdnd}t|}t|dk(rtjd|d|dS|s t d|rdndj dj t |d Dcgc]\}}d ||fz||k(rd ndzc}}d g}t|d }tjdttt|tD]}t|d|d }|s|tjd||cS|jrFt|dz } d| cxkrt|kr$nn!tjd|| ||| cSg} |D]h}|j} |j} | | k(rtjd||ccS| | vsIt| dkDsX| j!|jt| dk(r!tjd| d|| dcS| rt#d|t| } nG|jrt#dt|} n!|r|j%s t#d|} nd} tjd|rdnd| |t&t)d|| ycc}}w)a Prompt the user to select a choice from a group of options. :param choices: A sequence of strings with available options. :param default: The default choice if the user simply presses Enter (expected to be a string, defaults to :data:`None`). :param padding: Refer to the documentation of :func:`~humanfriendly.prompts.prompt_for_input()`. :returns: The string corresponding to the user's choice. :raises: - :exc:`~exceptions.ValueError` if `choices` is an empty sequence. - Any exceptions raised by :func:`~humanfriendly.prompts.retry_limit()`. - Any exceptions raised by :func:`~humanfriendly.prompts.prompt_for_input()`. When no options are given an exception is raised: >>> prompt_for_choice([]) Traceback (most recent call last): File "humanfriendly/prompts.py", line 148, in prompt_for_choice raise ValueError("Can't prompt for choice without any options!") ValueError: Can't prompt for choice without any options! If a single option is given the user isn't prompted: >>> prompt_for_choice(['only one choice']) 'only one choice' Here's what the actual prompt looks like by default: >>> prompt_for_choice(['first option', 'second option']) 1. first option 2. second option Enter your choice as a number or unique substring (Control-C aborts): second 'second option' If you don't like the whitespace (empty lines and indentation): >>> prompt_for_choice(['first option', 'second option'], padding=False) 1. first option 2. second option Enter your choice as a number or unique substring (Control-C aborts): first 'first option' r)rz=Skipping interactive prompt because there's only option (%r).rz,Can't prompt for choice without any options!z  )startz %i. %sz (default choice)zFEnter your choice as a number or unique substring (Control-C aborts): Trz=Requesting interactive choice on terminal (options are %s) ..rNr"z+Option (%r) selected by numeric reply (%s).z,Option (%r) selected by reply (exact match).z6Option (%r) selected by reply (substring match on %r).z*text '%s' matches more than one choice: %sznumber %i is not a valid choicez#text '%s' doesn't match any choicesr%r&r'r(z%sError: Invalid input (%s).)listlenrr, ValueErrorjoin enumeraterr mapreprrrisdigitintr.appendr isspacer r )choicesr0rr*ichoicer1r3r4indexmatches lower_reply lower_choicer+s r5rrxs~`SF7mG 7|q TV]^_V`aqz GHH$6$44 &wa8 8 61f+ %7AR*=XZ [8  Q6K&k=K LLPSw/02= b'N, LLG QN ]]_JNEE(CL( JGTYN\abu~%F++-K!<<>Ll* KVT  ,[1AA1Ev& w<1  LLQSZ[\S]_d e1:  !MuVabiVjk !BCJOu}} !FN5 LLA&+' , 0 2FG DO! s5JcXtd} |rd|z}|jdd} t|}|tjj d|r tjj d ||s|S|jS#|tjj d|r tjj dwwxYw#t $rL}t|tr|tjd||cYd}~Stjddd}~wwxYw)a Prompt the user for input (free form text). :param question: An explanation of what is expected from the user (a string). :param default: The return value if the user doesn't enter any text or standard input is not connected to a terminal (which makes it impossible to prompt the user). :param padding: Render empty lines before and after the prompt to make it stand out from the surrounding text? (a boolean, defaults to :data:`True`) :param strip: Strip leading/trailing whitespace from the user's reply? :returns: The text entered by the user (a string) or the value of the `default` argument. :raises: - :exc:`~exceptions.KeyboardInterrupt` when the program is interrupted_ while the prompt is active, for example because the user presses Control-C_. - :exc:`~exceptions.EOFError` when reading from `standard input`_ fails, for example because the user presses Control-D_ or because the standard input stream is redirected (only if `default` is :data:`None`). .. _Control-C: https://en.wikipedia.org/wiki/Control-C#In_command-line_environments .. _Control-D: https://en.wikipedia.org/wiki/End-of-transmission_character#Meaning_in_Unix .. _interrupted: https://en.wikipedia.org/wiki/Unix_signal#SIGINT .. _standard input: https://en.wikipedia.org/wiki/Standard_streams#Standard_input_.28stdin.29 Nr9z z6Got EOF from terminal, returning default value (%r) ..z0Interactive prompt was interrupted by exception!T)exc_info) rreplacersysstderrwrite BaseException isinstanceEOFErrorrr,r r)r/r0rrr4es r5rrs6 E' hH''e4H '&x0E}   &    &5{{}K}   &    &    a "w': LLQSZ [N NNMX\N ]  s;C B AC ACC D))D$D) D$$D)c ttjr%t|fdt tj i|S|S)a Wrap a text to be rendered as an interactive prompt in ANSI escape sequences. :param prompt_text: The text to render on the prompt (a string). :param options: Any keyword arguments are passed on to :func:`.ansi_wrap()`. :returns: The resulting prompt text (a string). ANSI escape sequences are only used when the standard output stream is connected to a terminal. When the standard input stream is connected to a terminal any escape sequences are wrapped in "readline hints". readline_hints)rrPstdoutrrstdin)r1optionss r5rr8s<( 3 k ^2G 2R ^V] ^r6c, ddl}y#t$rYywxYw)u Make interactive prompts more user friendly. The prompts presented by :func:`python2:raw_input()` (in Python 2) and :func:`python3:input()` (in Python 3) are not very user friendly by default, for example the cursor keys (:kbd:`←`, :kbd:`↑`, :kbd:`→` and :kbd:`↓`) and the :kbd:`Home` and :kbd:`End` keys enter characters instead of performing the action you would expect them to. By simply importing the :mod:`readline` module these prompts become much friendlier (as mentioned in the Python standard library documentation). This function is called by the other functions in this module to enable user friendly prompts. rN)readline ImportError)r]s r5rrIs     s  c#Kt|D] }|dz d}||z}tj|t|w)a  Allow the user to provide valid input up to `limit` times. :param limit: The maximum number of attempts (a number, defaults to :data:`MAX_ATTEMPTS`). :returns: A generator of numbers starting from one. :raises: :exc:`TooManyInvalidReplies` when an interactive prompt receives repeated invalid input (:data:`MAX_ATTEMPTS`). This function returns a generator for interactive prompts that want to repeat on invalid input without getting stuck in infinite loops. r8zTReceived too many invalid replies on interactive prompt, giving up! (tried %i times))rangerr r )limitrGmsg formatted_msgs r5rr_sD5\!e  `C%KM NN=!  ..s?AceZdZdZy)r zLRaised by interactive prompts when they've received too many invalid inputs.N)__name__ __module__ __qualname____doc__r6r5r r vsVr6r )NT)NTT)rhloggingrPhumanfriendly.compatrhumanfriendly.terminalrrrrrr humanfriendly.textr r __all__r getLoggerrerrrrrrr Exceptionr rir6r5rqs 43  W   8 $?DDoEdK\" ,#/.WIWr6