o vJ@sdZddlmZddlmZddlmZddlZddlZddlmZddl Z dZ Gdd d e ej e ZGd d d eZGd d d e ZGdddeZGddde ZdS)aMultiline output for Cloud SDK. This module contains a set of classes that are useful for managing console output that can be updated that spans multiple lines. Currently only SimpleSuffixConsoleOutput is offered which only supports updating the last added message. SimpleSuffixConsoleOutput is basically a collection of semantically distinct messages to be outputted to the console. These messages all have a suffix, and SimpleSuffixConsoleOutput supports updating the suffix of the last added message. Calling UpdateConsole on a SimpleSuffixConsoleOutput will update these messages and any changes to the console. Example usage: # Example for a simple spinner spinner = ['|', '/', '-', '\\'] num_spinner_marks = len(spinner) # Define a ConsoleOutput message output = SimpleSuffixConsoleOutput(sys.stderr) # Add the message you want to be displayed for the spinner and update the # console to show the message. message = sscm.AddMessage('Instance is being created...') output.UpdateConsole() > Instance is being created # Start the spinner by updating the message and then updating the console. for i in range(20): output.UpdateMessage(message, spinner[i % num_spinner_marks]) output.UpdateConsole() time.sleep(0.1) > Instance is being created...| > Instance is being created.../ > ... output.UpdateMessage(message, 'done\n') output.UpdateConsole() > Instance is being created...done )absolute_import)division)unicode_literalsN) console_attrc@seZdZdZddZdS) ConsoleOutputzManages the printing and formatting of multiline console output. It is up to implementations of this metaclass to determine how different messages will added to the output. cCsdS)AUpdates the console output to show any updated or added messages.Nselfr r B/tmp/google-cloud-sdk/lib/googlecloudsdk/core/console/multiline.py UpdateConsoleRszConsoleOutput.UpdateConsoleN)__name__ __module__ __qualname____doc__r r r r r rKs rcsTeZdZdZfddZ  dddZ  ddd Zd d Zd d ZddZ Z S)SimpleSuffixConsoleOutputaA simple, suffix-only implementation of ConsoleOutput. In this context, simple means that only updating the last line is supported. This means that this is supported in all ASCII environments as it only relies on carriage returns ('\r') for modifying output. Suffix-only means that only modifying the ending of messages is supported, either via a detail_message_callback or by modifying the suffix of a SuffixConsoleMessage. cs.||_g|_d|_t|_tt|dS)IConstructor. Args: stream: The output stream to write to. rN) _stream _messages_last_print_index threadingLock_locksuperr__init__r stream __class__r r ras  z"SimpleSuffixConsoleOutput.__init__NrcCs:|j|j|||dWdS1swYdS)a;Adds a SuffixConsoleMessage to the SimpleSuffixConsoleOutput object. Args: message: str, The message that will be displayed. detail_message_callback: func() -> str, A no argument function that will be called and the result will be appended to the message on each call to UpdateConsole. indentation_level: int, The indentation level of the message. Each indentation is represented by two spaces. Returns: SuffixConsoleMessage, a message object that can be used to dynamically change the printed message. detail_message_callbackindentation_levelNr _AddMessage)r messager!r"r r r AddMessagems$z$SimpleSuffixConsoleOutput.AddMessagecCs"t||j||d}|j||S)Nr )SuffixConsoleMessagerrappend)r r%r!r"console_messager r r r$s z%SimpleSuffixConsoleOutput._AddMessagecCsp|std||jvrtd|jr||jdkrtd|j||WddS1s1wYdS)z5Updates the suffix of the given SuffixConsoleMessage.A message must be passed.8The given message does not belong to this output object.z+Only the last added message can be updated.N) ValueErrorrr _UpdateSuffix)r r% new_suffixr r r UpdateMessages  "z'SimpleSuffixConsoleOutput.UpdateMessagecC4|j |WddS1swYdSNr_UpdateConsoler r r r r  "z'SimpleSuffixConsoleOutput.UpdateConsolecCsl|jr4|jt|jdkr*|j|jdD] }||jdqt|jd|_|j|jdSdS)rr, N)rrlenPrintrwrite)r r%r r r r4sz(SimpleSuffixConsoleOutput._UpdateConsole)Nr) rrrrrr&r$r0r r4 __classcell__r r rr rWs      rc@sdeZdZdZ  dddZddZdd d Zd d ZeddZ ddZ ddZ ddZ ddZ dS)r'z/A suffix-only implementation of ConsoleMessage.NrcCsx||_||_||_tdd|_|jdkrd|_||_||_d|_ |jt |dkr1d|_ d|_ g|_ d|_ dS)a%Constructor. Args: message: str, the message that this object represents. stream: The output stream to write to. suffix: str, The suffix that will be appended to the very end of the message. detail_message_callback: func() -> str, A no argument function that will be called and the result will be added after the message and before the suffix on every call to Print(). indentation_level: int, The indentation level of the message. Each indentation is represented by two spaces. rr6FTN)r_message_suffixr ConsoleAttr GetTermSize_console_width_detail_message_callback_level _no_outputINDENTATION_WIDTH _num_lines_lines _has_printed)r r%rsuffixr!r"r r r rs  zSuffixConsoleMessage.__init__cCst|tjs td||_dS)z$Updates the suffix for this message.2expected a string or other character buffer objectN) isinstancesix string_types TypeErrorr>)r rIr r r r.s  z"SuffixConsoleMessage._UpdateSuffixFcCs,|jdks|jr dS|}|sdS|jr|r7d|_||||_t|j|_|jD]}| |q-dS||}t|}||jkrV|j d|D]}| |qMn8| |}|j|dkr~||jd}||d|dD]}| |qun|j d|D]}| |q||_||_dS)aPrints out the message to the console. The implementation of this function assumes that when called, the cursor position of the terminal is on the same line as the last line that this function printed (and nothing more). The exception for this is if this is the first time that print is being called on this message or if print_all is True. The implementation should also return the cursor to the last line of the printed message. The cursor position in this case should be at the end of printed text to avoid text being overwritten. Args: print_all: bool, if the entire message should be printed instead of just updating the message. rNTr7r6r,) rArD GetMessagerH _ClearLine_SplitMessageIntoLinesrGr8rF _WriteLinerr:_GetNumMatchingLines)r print_allr%line new_lines new_num_linesmatching_lineslines_to_printr r r r9s@              zSuffixConsoleMessage.PrintcCs.|jr|}|r|j||jS|j|jSr2)rBr=r>)r detail_messager r r rO(s  zSuffixConsoleMessage.GetMessagecC|jt|jSz=The effective width when the indentation level is considered.rArErCr r r r effective_width/z$SuffixConsoleMessage.effective_widthcCsBd}ttt||jD]}|||j|kr|S|d7}q |S)Nrr6)rangeminr8rFrG)r rVrXir r r rS4s z)SuffixConsoleMessage._GetNumMatchingLinescCsbg}d}|t|kr/|||||j||j7}|t|kr)|dd7<|t|ks |S)?Converts message into a list of strs, each representing a line.rr,r7)r8r(r^)r r%linesposr r r rQ<s    z+SuffixConsoleMessage._SplitMessageIntoLinescC|jdd|jdSNz {}  rr:formatrAr r r r rPIzSuffixConsoleMessage._ClearLinecCs(|j|jtd||jdSNrh)rr:rCrEflushr rUr r r rRLszSuffixConsoleMessage._WriteLine)r<Nr)F)rrrrrr.r9rOpropertyr^rSrQrPrRr r r r r's * H  r'csTeZdZdZfddZdddZdddZd d Zd d Zd dZ ddZ Z S)MultilineConsoleOutputaAn implementation of ConsoleOutput which supports multiline updates. This means all messages can be updated and actually have their output be updated on the terminal. The main difference between this class and the simple suffix version is that updates here are updates to the entire message as this provides more flexibility. This class accepts messages containing ANSI escape codes. The width calculations will be handled correctly currently only in this class. cs:||_g|_d|_t|_d|_d|_tt | dS)rrFN) rrrrrr_last_total_lines_may_have_updaterrprrrr r r]s zMultilineConsoleOutput.__init__rcCs8|j|j||dWdS1swYdS)aAdds a MultilineConsoleMessage to the MultilineConsoleOutput object. Args: message: str, The message that will be displayed. indentation_level: int, The indentation level of the message. Each indentation is represented by two spaces. Returns: MultilineConsoleMessage, a message object that can be used to dynamically change the printed message. r"Nr#)r r%r"r r r r&ks  $z!MultilineConsoleOutput.AddMessagecCs&d|_t||j|d}|j||S)NTrs)rrMultilineConsoleMessagerrr()r r%r"r)r r r r$|s z"MultilineConsoleOutput._AddMessagecCsZ|std||jvrtd|j||d|_WddS1s&wYdS)z9Updates the message of the given MultilineConsoleMessage.r*r+TN)r-rr_UpdateMessagerr)r r% new_messager r r r0s  "z$MultilineConsoleOutput.UpdateMessagecCr1r2r3r r r r r r5z$MultilineConsoleOutput.UpdateConsolecCs d|S)zEReturns an ANSI control sequences that moves the cursor up num_lines.z[{}A)rj)r num_linesr r r _GetAnsiCursorUpSequence z/MultilineConsoleOutput._GetAnsiCursorUpSequencecCs|jsdS|jr|j||jd}d}|jD] }|j}||7}|js'|r1||jO}| q|jd|q||_d|_dS)rNrFr7) rrrqrr:rxrrw has_updatenum_lines_changedr9)r total_linesforce_print_restr%rwr r r r4s     z%MultilineConsoleOutput._UpdateConsoler) rrrrrr&r$r0r rxr4r;r r rr rpQs    rpc@s~eZdZdZdddZeddZeddZed d Zed d Z d dZ ddZ ddZ eddZ ddZddZdS)rtz-A multiline implementation of ConsoleMessage.rcCs~||_t|_|jdd|_|jdkrd|_||_d|_|jt|dkr,d|_d|_ g|_ d|_ d|_ | |dS)aConstructor. Args: message: str, the message that this object represents. stream: The output stream to write to. indentation_level: int, The indentation level of the message. Each indentation is represented by two spaces. rr6FTN)rrGetConsoleAttr _console_attrr@rArCrDrEr=rG _has_update_num_lines_changedru)r r%rr"r r r rs  z MultilineConsoleMessage.__init__cC|jSr2)rGr r r r rdzMultilineConsoleMessage.linescCs t|jSr2)r8rGr r r r rwryz!MultilineConsoleMessage.num_linescCrr2)rr r r r rzrz"MultilineConsoleMessage.has_updatecCrr2)rr r r r r{rz)MultilineConsoleMessage.num_lines_changedcCsdt|tjs td||jkr0||_|jrdSt|j}||j|_d|_ |t|jk|_ dSdS)z,Updates the message for this Message object.rJNT) rKrLrMrNr=rDr8rGrQrr)r rv num_old_linesr r r rus   z&MultilineConsoleMessage._UpdateMessagecCs6|j||j}tt|D] }||d7<q|S)rcr7)r SplitLiner^r`r8)r r%rdrbr r r rQsz.MultilineConsoleMessage._SplitMessageIntoLinescCs2|jrdS|jD] }|||qd|_dS)zPrints out the message to the console. The implementation of this function assumes that when called, the cursor position of the terminal is where the message should start printing. NF)rDrGrPrRrrnr r r r9s    zMultilineConsoleMessage.PrintcCr[r\r]r r r r r^ r_z'MultilineConsoleMessage.effective_widthcCrfrgrir r r r rPrkz"MultilineConsoleMessage._ClearLinecCs|j|jtd|dSrl)rr:rCrErnr r r rRsz"MultilineConsoleMessage._WriteLineNr~)rrrrrrordrwrzr{rurQr9r^rPrRr r r r rts$ "       rt)r __future__rrrabcrgooglecloudsdk.core.consolerrLrEwith_metaclassABCMetaobjectrrr'rprtr r r r s ,    V%a