o X@sdZddlmZddlmZddlmZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlZddlZddlmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlZddlmZddlm Z ddlm!Z!Gdddej"Z"Gddde"Z#Gddde"Z$Gddde"Z%e&'dZ(ej)ddde(dkre(nddZ*ddZ+ej,dd Z-d!d"Z.d#d$Z/dad%d&Z0dbd'd(Z1d)d*Z2d+d,Z3 -  dcd.d/Z4d0d1Z5d2d3Z6ddd4d5Z7ded6d7Z8d8d9Z9d:d;Z:dfdZ<   dgd?d@Z= dhdAdBZ>dCdDZ?dEdFZ@ejAdGd-d-dfdHdIZBdJdKZCdLdMZDGdNdOdOeEZFGdPdQdQeEZGGdRdSdSeEZHGdTdUdUeEZIdidVdWZJGdXdYdYeEZKdZd[ZLGd\d]d]ejMZN ^  djd_d`ZOdS)kz9General console printing utilities used by the Cloud SDK.)absolute_import)division)unicode_literalsN) exceptions)log) properties) console_attr) console_pager)prompt_completer)encoding)files) platformsinput)map)rangec@seZdZdZdS)ErrorzBase exception for the module.N)__name__ __module__ __qualname____doc__rrC/tmp/google-cloud-sdk/lib/googlecloudsdk/core/console/console_io.pyr3src eZdZdZfddZZS)RequiredPromptErrorzEAn exception for when a prompt cannot silenced with the --quiet flag.ctt|ddS)NzThis prompt could not be answered because you are not in an interactive session. Please re-run the command without the --quiet flag to respond to the prompts.)superr__init__self __class__rrr; zRequiredPromptError.__init__rrrrr __classcell__rrr rr8rcr)UnattendedPromptError2An exception for when a prompt cannot be answered.cr)NzThis prompt could not be answered because you are not in an interactive session. You can re-run the command with the --quiet flag to accept default answers for all prompts.)rr&rrr rrrEr"zUnattendedPromptError.__init__r#rrr rr&Br%r&cs&eZdZdZdZdfdd ZZS)OperationCancelledErrorr'zAborted by user.Ncstt||p |jdSN)rr(rDEFAULT_MESSAGE)rmessager rrrQs z OperationCancelledError.__init__r))rrrrr*rr$rrr rr(Lsr(FP)replace_whitespacedrop_whitespacebreak_on_hyphenswidthcCsddd|DS)zText wrap the given message and correctly handle newlines in the middle. Args: message: str, The message to wrap. It may have newlines in the middle of it. Returns: str, The wrapped message.  cSg|]}t|qSr)TEXTWRAPfill).0linerrr jz_DoWrap..)join splitlinesr+rrr_DoWrap`s r<ccs(tj|8_tVtj|7_dS)z'Temporarily narrows the global wrapper.N)r3r0) narrow_byrrr _NarrowWrapmsr>cCsztWStyYdSwr))rEOFErrorrrrr _GetInputus  r@cCs*|dkr t|dS|rt|St|S)a,Returns the contents of the specified file or stdin if path is '-'. Args: path: str, The path of the file to read. binary: bool, True to open the file in binary mode. Raises: Error: If the file cannot be read or is larger than max_bytes. Returns: The contents of the file. -)binary) ReadStdinr ReadBinaryFileContentsReadFileContents)pathrBrrrReadFromFileOrStdin|s    rGcCs*|rtStj}tjrt|}|S)aReads data from stdin, correctly accounting for encoding. Anything that needs to read sys.stdin must go through this method. Args: binary: bool, True to read raw bytes, False to read text. Returns: A text string if binary is False, otherwise a byte string. ) r ReadStdinBytessysstdinreadsixPY2rDecode)rBdatarrrrCs    rCcCsztjs WdS|rtjsWdS|rtjsWdSWn ty(YdSw|rCttj d}ttj d}|sC|rA|dkrCdSdS)aDetermines if the current terminal session is interactive. sys.stdin must be a terminal input stream. Args: output: If True then sys.stdout must also be a terminal output stream. error: If True then sys.stderr must also be a terminal output stream. heuristic: If True then we also do some additional heuristics to check if we are in an interactive context. Checking home path for example. Returns: True if the current terminal session is interactive. FHOMEHOMEPATH/T) rIrJisattystdoutstderrAttributeErrorr GetEncodedValueosenviron)outputerror heuristichomehomepathrrr IsInteractives"   r_cCs*tjtjjkrttkrdSdS)z.GetAnswer)rrgrhrirjr(interactive_ux_styleGetInteractiveUXStylesTESTINGname"_TestPromptContinuePromptGenerator$_NormalPromptContinuePromptGeneratorrIrUry) r+rmrnrorprqstyleprompt_generatorpromptrzendingr}r{rr|rPromptContinues6   rcCs^~~~t}|r|t|d|sd}|r|d7}n|d7}|t||ddfS)z>Generates prompts for prompt continue under normal conditions.z zDo you want to continuez (Y/n)? z (y/N)? zPlease enter 'y' or 'n': r1)ioStringIOryr<getvalue)r+rmrnrorprqbufrrrr5s rcCs"~~~ttj|||ddddfS)z1Generates prompts for prompt continue under test.)r+rmrqr1N) JsonUXStub UXElementTypePROMPT_CONTINUErlrrrrLsrcCstjjjr dS|rtddrtj||dStjjj tjjj j j kr5tjttj|dtStjt|tS)a;Prompts the user for a string. Args: message: str, The prompt to print before the question. choices: callable or list, A callable with no arguments that returns the list of all choices, or the list of choices. Returns: str, The string entered by the user, or None if prompts are disabled. NTrfchoicesr;)rrgrhrirjr_r PromptCompleterInputr~rrrrrIrUryrrPROMPT_RESPONSEr<r@)r+rrrrPromptResponseYs   rcCsB|pd}|r|r |d7}|dj|d7}n|d7}t||dp |S)aPrompts the user for a string, allowing a default. Unlike PromptResponse, this also appends a ': ' to the prompt. If 'default' is specified, the default is also written written into the prompt (e.g. if message is "message" and default is "default", the prompt would be "message (default): "). The default is returned if the user simply presses enter (no input) or an EOF is received. Args: message: str, The prompt to print before the question. default: str, The default value (if any). choices: callable or list, A callable with no arguments that returns the list of all choices, or the list of choices. Returns: str, The string entered by the user, or the default if no value was entered or prompts are disabled. rr z({default}): rn: r)formatr)r+rnrrrrPromptWithDefaultpsrcCsVzt|WStyYnw|sdSz ttt||dWSty*YdSw)aParses answer and returns 1-based index in options list. Args: answer: str, The answer input by the user to be parsed as a choice. options: [object], A list of objects to select. Their str() method will be used to select them via freeform text. allow_freeform: bool, A flag which, if defined, will allow the user to input the choice as a str, not just as a number. If not set, only numbers will be accepted. Returns: int, The 1-indexed value in the options list that corresponds to the answer that was given, or None if the selection is invalid. Note that this function does not do any validation that the value is a valid index (in the case that an integer answer was given) N)int ValueErrorlistrstrindex)r{optionsallow_freeformrrr _ParseAnswers   rcCs|tt|||S)a<Checks if there is a suitable close choice to suggest. Args: suggester: object, An object which has methods AddChoices and GetSuggestion which is used to detect if an answer which is not present in the options list is a likely typo, and to provide a suggestion accordingly. answer: str, The freeform answer input by the user as a choice. options: [object], A list of objects to select. Their str() method will be used to compare them to answer. Returns: str, the closest option in options to answer, or None otherwise. ) AddChoicesrr GetSuggestion) suggesterr{rrrr_SuggestFreeformAnswers rcCsJ|dur|n|d|}t|D]\}}|dj|dt|dqdS)aJPrints the options provided to stderr. Args: options: [object], A list of objects to print as choices. Their str() method will be used to display them. write: f(x)->None, A function to call to write the data. limit: int, If set, will only print the first number of options equal to the given limit. Nz [{index}] {option} r)roption) enumeraterrL text_type)rrylimitlimited_optionsirrrr _PrintOptionss   r2csp|std|r |dgn|}t|}|dur+d|kr!|ks+ntdj||dtjjjr4|Stjjj }|tjjj j j kr]ddt jttj|d d |Dd d nt jj|rkt|d |tkrt|td |t} dj| ddj|dnt|s|rdnd|durdndj|ddfdd} |  t} | dus| s|dur҈d |r||dkrt|S| dkrt|| qt| ||} |r| |krt| dur| dkr| |krd | dS|r#|r#t|| |} | dur#dj| | dd |r/dj|dndj|dq) aiPrompt the user to select a choice from a list of items. Args: options: [object], A list of objects to print as choices. Their six.text_type() method will be used to display them. default: int, The default index to return if prompting is disabled or if they do not enter a choice. message: str, An optional message to print before the choices are displayed. prompt_string: str, A string to print when prompting the user to enter a choice. If not given, a default prompt is used. allow_freeform: bool, A flag which, if defined, will allow the user to input the choice as a str, not just as a number. If not set, only numbers will be accepted. freeform_suggester: object, An object which has methods AddChoices and GetSuggestion which is used to detect if an answer which is not present in the options list is a likely typo, and to provide a suggestion accordingly. cancel_option: bool, A flag indicating whether an option to cancel the operation should be added to the end of the list of choices. Raises: ValueError: If no options are given or if the default is not in the range of available options. OperationCancelledError: If a `cancel` option is selected by user. Returns: The index of the item in the list that was chosen, or the default if prompts are disabled. z%You must provide at least one option.cancelNrz^Default option [{default}] is not a valid index for the options list [{maximum} options given])rnmaximumcSdSr)rxrrr zPromptChoice..cSr2r)rLr)r5orrrr7r8z PromptChoice..)r+rmrr1)rz%Did not print [{truncated}] options. ) truncatedzMToo many options [{maximum}]. Enter "list" at prompt to print choices fully. )rzHPlease enter numeric choice or text value (must exactly match list item)z Please enter your numeric choicerz ({default}): rrcstdSr))r<rrm suffix_stringryrr _PrintPrompt+z"PromptChoice.._PrintPromptTrz4[{answer}] not in list. Did you mean [{suggestion}]?)r{ suggestionzOPlease enter a value between 1 and {maximum}, or a value present in the list: z/Please enter a value between 1 and {maximum}: )rlenrrrgrhrirjr~rrrrrIrUryrr PROMPT_CHOICEr<PROMPT_OPTIONS_OVERFLOWrr@r(rr)rrnr+rmrfreeform_suggester cancel_optionrrrrr{ num_choicerrrr PromptChoices         rc Cstjjjr dStjjj}|tjjjjj kr.dd}t j t tj||||ddnt j j }|r<|t|d |t|t}||rL|S|t|d|r]tddr]|Sq=) aPrompts the user for a string that must pass a validator. Args: validator: function, A validation function that accepts a string and returns a boolean value indicating whether or not the user input is valid. error_message: str, Error message to display when user input does not pass in a valid string. prompt_string: str, A string to print when prompting the user to enter a choice. If not given, a default prompt is used. message: str, An optional message to print before prompting. allow_invalid: bool, Allow returning the answer if validation fails. Returns: str, The string entered by the user, or the default if no value was entered or prompts are disabled. NcSrr)rrrrrrprz%PromptWithValidator..) error_messagermr+ allow_invalidr1TFr)rrgrhrirjr~rrrrrIrUryrrPROMPT_WITH_VALIDATORr<r@r) validatorrrmr+rrryr{rrrPromptWithValidatorXs0 rc sfdd}td||S)aExpands {key} => value for key, value in kwargs. Details: * {{}} expands to {} * {} expands to {} * {key} values are recursively expanded before substitution into the result Args: s: str, The string to format. **kwargs: {str:str}, A dict of strings for named parameters. Returns: str, The lazily-formatted string. cs|ddd}|d}|ddd}|r!|r!|||S|}|dur/|dSt|r6|}|t|fi|S)z7Returns one replacement string for LazyFormat re.sub().rNr)groupgetcallable LazyFormat)matchprefixrsuffixvaluekwargsrr _Replacements    z LazyFormat.._Replacementz(\{+)(\w+)(\}+))resub)srrrrrrs rcCsftd%}d}|}tjjj}|rd}d}||||dWdS1s,wYdS)aFormats an action a user must initiate to complete a command. Some actions can't be prompted or initiated by gcloud itself, but they must be completed to accomplish the task requested of gcloud; the canonical example is that after installation or update, the user must restart their shell for all aspects of the update to take effect. Unlike most console output, such instructions need to be highlighted in some way. Using this function ensures that all such instances are highlighted the *same* way. Args: s: str, The message to format. It shouldn't begin or end with newlines. Returns: str, The formatted message. This should be printed starting on its own line, and followed by a newline. z ==> z r1N)r>rrg accessibility screen_readerrjr9wrap)rwrapper separatorrrrrrFormatRequiredUserActions $r<cCsntjjj}|tjjjjjkrtS|tjjjj jkr!t ||S|s*tjj j r/t||St|||||S)a%A simple progress bar for tracking completion of an action. This progress bar works without having to use any control characters. It prints the action that is being done, and then fills a progress bar below it. You should not print anything else on the output stream during this time as it will cause the progress bar to break on lines. Progress bars can be stacked into a group. first=True marks the first bar in the group and last=True marks the last bar in the group. The default assumes a singleton bar with first=True and last=True. This class can also be used in a context manager. Args: label: str, The action that is being performed. stream: The output stream to write to, stderr by default. total_ticks: int, The number of ticks wide to make the progress bar. first: bool, True if this is the first bar in a stacked group. last: bool, True if this is the last bar in a stacked group. screen_reader: bool, override for screen reader accessibility property toggle. Returns: The progress bar. )rrgrhr~rrOFFrNoOpProgressBarr_StubProgressBarrrrj_TextPercentageProgressBar_NormalProgressBar)labelstream total_ticksfirstlastrrrrr ProgressBars  rcsxdustkrtddtt|DSfdd}t|}g}d}|D]}||}||||||7}q%t|S)aSplits a progress bar into logical sections. Wraps the original callback so that each of the subsections can use the full range of 0 to 1 to indicate its progress. The overall progress bar will display total progress based on the weights of the tasks. Args: original_callback: f(float), The original callback for the progress bar. weights: [float], The weights of the tasks to create. These can be any numbers you want and the split will be based on their proportions to each other. Raises: ValueError: If the weights don't add up to 1. Returns: (f(float), ), A tuple of callback functions, in order, for the subtasks. NcSsg|]}tqSr)DefaultProgressBarCallback)r5_rrrr7sz$SplitProgressBar..csfdd}|S)Ncs|dSr)r) done_fraction) already_doneoriginal_callbackweightrrCallbackrz8SplitProgressBar..MakeCallback..Callbackr)rrrr)rrr MakeCallbacksz&SplitProgressBar..MakeCallbackr)rtuplerrsumappend)rweightsrtotal callbacksrrnormalized_weightrrrSplitProgressBars  rcCs~dSr)r)progress_factorrrrrsrc@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)rabA simple progress bar for tracking completion of an action. This progress bar works without having to use any control characters. It prints the action that is being done, and then fills a progress bar below it. You should not print anything else on the output stream during this time as it will cause the progress bar to break on lines. Progress bars can be stacked into a group. first=True marks the first bar in the group and last=True marks the last bar in the group. The default assumes a singleton bar with first=True and last=True. This class can also be used in a context manager. c Cs||_||_d|_||_||_||_t}||_ |j j |j j kp*|j j |j j k|_|jr:tdds:d|_d|_|jd}t||krP|d|dd}nt||krb|t|}|d|7}|j j |j j} |j j|j j } d j| || d |_dS) aCreates a progress bar for the given action. Args: label: str, The action that is being performed. stream: The output stream to write to, stderr by default. total_ticks: int, The number of ticks wide to make the progress bar. first: bool, True if this is the first bar in a stacked group. last: bool, True if this is the last bar in a stacked group. rTrfrNrz...rz{left} {label} {right})leftrright) _raw_label_stream_ticks_written _total_ticks_first_lastr ConsoleAttrGetBoxLineCharacters_boxd_drd_vrd_dld_vl_redrawr_rd_hr_label) rrrrrrattrmax_label_widthdiffrrrrrr%s2        z_NormalProgressBar.__init__cCs|js|jr.|jr |jjn|jj}|jr|jjn|jj}dj||jj|j |d}| || |j d| |jj d|_ dS)z:Starts the progress bar by writing the top rule and label.z{left}{middle}{right} )rmiddlerr1rN)rrr r r r rrrr_Writerd_urr)rrrrulerrrStartMs   z_NormalProgressBar.StartcCst|j|}||j}t||j|j}|dkrH||jj||j|7_||jkrA|js4|js6dnd}||jj ||j dSdS)aSets the current progress of the task. This method has no effect if the progress bar has already progressed past the progress you call it with (since the progress bar cannot back up). Args: progress_factor: float, The current progress as a float between 0 and 1. rr1 N) rrrminrr rrrd_ulrflush)rrexpected_ticks new_ticksendrrr SetProgressYs  z_NormalProgressBar.SetProgresscC|ddSMark the progress as done.rNr!rrrrFinishoz_NormalProgressBar.FinishcCs|j|dSr)rryrmsgrrrrsz_NormalProgressBar._WritecC ||Sr)rrrrr __enter__vz_NormalProgressBar.__enter__cG |dSr)r&rargsrrr__exit__z z_NormalProgressBar.__exit__N rrrrrrr!r&rr.r4rrrrrs(  rc@sJeZdZdZdddZddZddZd d Zd d Zd dZ ddZ dS)r+A progress bar that outputs nothing at all.@cCs ||_||_d|_|d|_dS)aCreates a progress bar for the given action. Args: label: str, The action that is being performed. stream: The output stream to write to, stderr by default. percentage_display_increments: Minimum change in percetnage to display new progress rY@N)rr_last_percentage_percentage_display_increments)rrrpercentage_display_incrementsrrrrs z#_TextPercentageProgressBar.__init__cCs||jdSr))rrrrrrrr+z _TextPercentageProgressBar.StartcCsHt|d}||j|jk}|s|dkr"|d|d||_dSdS)Ng?z{0:.0f}%r9)rr:r;rr)rrshould_update_progressrrrr!s    z&_TextPercentageProgressBar.SetProgresscCr"r#r%rrrrr&r'z!_TextPercentageProgressBar.FinishcCs|j|ddS)Nr1r(r)rrrrrz!_TextPercentageProgressBar._WritecCr,r)r-rrrrr.r/z$_TextPercentageProgressBar.__enter__cGr0r)r1r2rrrr4r5z#_TextPercentageProgressBar.__exit__N)r8r6rrrrr~s   rc@@eZdZdZddZddZddZdd Zd d Zd d Z dS)rr7cCrr)rrrrrrzNoOpProgressBar.__init__cCrr)rrrrrrr?zNoOpProgressBar.StartcCrr)rrrrrrr!r?zNoOpProgressBar.SetProgresscCr"r#r%rrrrr&r'zNoOpProgressBar.FinishcCr,r)r-rrrrr.r/zNoOpProgressBar.__enter__cGr0r)r1r2rrrr4r5zNoOpProgressBar.__exit__N rrrrrrr!r&r.r4rrrrrs rc@r>)rzA progress bar that only prints deterministic start and end points. No UX about progress should be exposed here. This is strictly for being able to tell that the progress bar was invoked, not what it actually looks like. cCs||_||_dSr))rr)rrrrrrrs z_StubProgressBar.__init__cCs|jttj|jddS)Nr;)rryrr PROGRESS_BARrrrrrrsz_StubProgressBar.StartcCrr)rr@rrrr!r?z_StubProgressBar.SetProgresscCs|d|jddS)r$rr1N)r!rryrrrrr&s z_StubProgressBar.FinishcCr,r)r-rrrrr.r/z_StubProgressBar.__enter__cGr0r)r1r2rrrr4r5z_StubProgressBar.__exit__NrArrrrrs rc Cstdds|s tj}||dS|stj|tj}|rt t j dd}|dkr-d}n|s=dD] }t |r<|}nq1|rt t j dd}d|pKd }tt j d|tj|tjdd }t} |j|| d ||dur}tt j dddSt|||dS) a$Run a user specified pager or fall back to the internal pager. Args: contents: The entire contents of the text lines to page. out: The output stream, log.out (effectively) if None. prompt: The page break prompt. check_pager: Checks the PAGER env var and uses it if True. T)rZNPAGERrA)lesspagerLESSz-Rrr)rJshellr)r_routryfile_only_loggerinforIrTr rWrXrYr FindExecutableOnPathSetEncodedValue subprocessPopenPIPErGetConsoleAttr GetEncoding communicateencodewaitr PagerRun) contentsrHr check_pagerrEcommand less_origrDpencrrrMores<      r]c@s0eZdZdZddZddZddZdd Zd S) TickableProgressBarz;A thread safe progress bar with a discrete number of tasks.cOs*d|_||_t|i||_t|_dS)Nr) completedrr _progress_bar threadingLock_lock)rrr3rrrrrszTickableProgressBar.__init__cCs|j|Sr))r`r.rrrrr.s zTickableProgressBar.__enter__cCs|j|||dSr))r`r4)rexc_type exc_value tracebackrrrr4rzTickableProgressBar.__exit__cCsN|j|jd7_|j|j|jWddS1s wYdS)Nr)rcr_r`r!rrrrrTick s"zTickableProgressBar.TickN)rrrrrr.r4rgrrrrr^s  r^cKspt}|j|d<tt|t|}|r td|j||D]}||d}|r2|||<q$t |S)z/Generates a stub message for UX console output.uxz%Extraneous args for Ux Element {}: {}N) collections OrderedDictrrset GetDataFieldsrrrjsondumps)ux_typerrZ extra_argsfieldvalrrrr&s    rc@s<eZdZdZdZdZdZdZdZdZ dZ d d Z d d Z d S)rz#Describes the type of a ux element.)rr+)rr+aborted_messagestatus)rr+rtsucceeded_stages failed_stage)rr+rmrq)rr+)r+rmr)rrmr+rcGs ~||_dSr) _data_fields)rordinal data_fieldsrrrrAs zUXElementType.__init__cCs|jS)z@Returns the ordered list of additional fields in the UX Element.ryrrrrrlHszUXElementType.GetDataFieldsN) rrrrrBPROGRESS_TRACKERSTAGED_PROGRESS_TRACKERrrrrrrlrrrrr5s rInvalid PasswordcCsvtjjjr dSt|}t|}t|r|ntj}t|r7||s7t j t |dt|}||r$||S)z2Prompt user for password with optional validation.Nr1) rrgrhrirjrL ensure_strgetpassrrIrUryr<)rrvalidation_callableencoder_callable str_promptpass_wdencoderrrrPromptPasswordMs   r)F)FFF)NNTFFN)NN)NNNr))NNNFNF)NF)NNT)rNN)Pr __future__rrrri contextlibenumrrrmrXrrMrItextwrapragooglecloudsdk.corerrrgooglecloudsdk.core.consolerr r googlecloudsdk.core.utilr r r rL six.movesrrrrrr&r(rP GetTermSize_CONSOLE_WIDTH TextWrapperr3r<contextmanagerr>r@rGrCr_rerkrrrrrrrrrrrrrrtrrrobjectrrrrr]r^rEnumrrrrrrs                     +   O '  z .$ &'h, /