LTdZddlmZddlmZddlmZddlZddlmZddlm Z ddl m Z Gd d e jZ y) a{Cloud SDK markdown document token renderer. This is different from the other renderers: (1) The output is a list of (token, text) tuples returned by TokenRenderer.Finish(). (2) A token is an empty object that conveys font style and embellishment by convention using the token name. Callers set up a style sheet indexed by tokens to control how the embellishments are rendered, e.g. color. (3) The rendering is constrained by width and height. Tokens generated by this module: Token.Markdown.Bold: bold text Token.Markdown.BoldItalic: bold+italic text Token.Markdown.Code: code text for command line examples Token.Markdown.Definition: definition list item (flag or subcommand or choice) Token.Markdown.Italic: italic text Token.Markdown.Normal: normal text Token.Markdown.Section: section header Token.Markdown.Truncated: the last token => indicates truncation Token.Markdown.Value: definition list item value (flag value) The Token objects self-define on first usage. Don't champion this pattern in the Cloud SDK. Usage: from six.moves import StringIO from googlecloudsdk.core.document_renderers import token_renderer from googlecloudsdk.core.document_renderers import render_document markdown = tokens = render_document.MarkdownRenderer( token_renderer.TokenRenderer(width=W, height=H), StringIO(markdown)).Run() )absolute_import)division)unicode_literalsN) console_attr)renderer)TokenceZdZdZdZej jej jej jej jej jdZ dZ dZdZdZGdd eZd fd Zd Zd!d Zd Zd!dZdZdZdZd"dZdZdZdZd!dZdZ dZ!d#dZ"dZ#dZ$d$dZ%dZ&d%dZ'd&dZ(xZ)S)' TokenRenderera\Renders markdown to a list of lines where each line is a list of Tokens. Attributes: _attr: console_attr.ConsoleAttr object. _bullet: List of bullet characters indexed by list level modulo #bullets. _compact: Compact representation if True. Saves rendering real estate. _csi: The control sequence indicator character. Token does not have control sequences. This renderer uses them internally to manage font styles and attributes (bold, code, italic). _current_token_type: current default Token.Markdown.* type _fill: The number of characters in the current output line. _height: The height of the output window, 0 to disable height checks. _ignore_paragraph: Ignore paragraph markdown until the next non-space _AddToken. _ignore_width: True if the next output word should ignore _width. _indent: List of left indentations in characters indexed by _level. _level: The section or list level counting from 0. _tokens: The list of output tokens _truncated: The number of output lines exceeded the output height. _rows: current rows in table )BCINZrceZdZdZddZy)TokenRenderer.IndentzSecond line indent stack.cX|rdntj|_|j|_y)Nr)r INDENTindentsecond_line_indent)selfcompacts Appends a definition list definition item to the current line.=rrN) rCsplitrkrr0 DefinitionrAr1ValuerZ)rr`partss r_AddDefinitionzTokenRenderer._AddDefinitions >>$ D JJsA ENN58U^^667 5zA~ nnS%..//0 nnU1Xu~~334MMOrczd|_|jr(|j|jd|_yy)z/Flushes the current collection of Fill() lines.FrN)r5r/rZContentrs r_FlushzTokenRenderer._Flushs/D zz mmo llndjrc|j|kr|j|kr|j}|xjdz c_|jt|jk\r)|jj|j |j|j |z|j|j_|jdkDr_|j|j |j|j k(r,|j|jxj dz c_|j|jj }||j|j_|,|j|jxj |zc_|j|kryy||_|C|j|jj |z|j|j_yy)aSets the markdown list level and indentations. Args: level: int, The desired markdown list level. indent: int, The new indentation. second_line_indent: int, The second line indentation. This is subtracted from the prevailing indent to decrease the indentation of the next input line for this effect: SECOND LINE INDENT ON THE NEXT LINE PREVAILING INDENT ON SUBSEQUENT LINES rN)r7rAr6rDr$rr)rlevelrr prev_levelvalues r _SetIndentzTokenRenderer._SetIndents {{U KK% [[  q ;;#dll+ + ,,  dkkm , LL $ + +f 4 T[[!( KK!O Z(;;||J'../ ,,t{{ # * *a / * T[[)007< T[[!4  ) ,,t{{ # 6 6:L L 6+ KK% 0dk  ' LL % 8 8;M M T[[!( (rc0|j|jj|jz|_|j d|jz|zt jj|j|jd|_y)zXDisplays line as an indented example. Args: line: The example line text. r@rN) r6r7rrr/rkrr0r1rZrx)rlines rExamplezTokenRenderer.ExampleGsf dkk*11DKK?DJNN3#d*ENN,A,ABMMOLLNDJrc@|j|jD]z}|jsi|js |js,|j |jj dz |_nd|_|jd|jz|jj|}|j|jz }|dz|k\rg|js[|j||f|j |jj |_|jd|jzn9d|_ |jr&|xjdz c_|jd|xj|z c_|j|}y)zAdds a line to the output, splitting to stay within the output width. This is close to textwrap.wrap() except that control sequence characters don't count in the width computation. Args: line: The text line. rrr@)rJFN) Blankrrr/r7r.r6rrkr)rGrEr5rZ)rrrNrRrOs rFillzTokenRenderer.FillSs* JJL  ZZ ;;dmm||DKK077!;$*$+ sTZZ'(jj%%d+e++ *i !) !$*<*< i0 1\\$++.55  sTZZ'(" :: **/* ..  jjEj nnT'rcZ|j|j|jS)z'Finishes all output document rendering.)rzFontr8rys rFinishzTokenRenderer.FinishrsKKMIIK ;;rc|d|_nd|z}|xj|zc_|jdtjzdtjzzdtjzzz}|dtjzzrd}na|dtjzdtjzzk(rd}n4|dtjzk(rd}n|dtjzk(rd}nd}|j |zS)aReturns the font embellishment control sequence for attr. Args: attr: None to reset to the default font, otherwise one of renderer.BOLD, renderer.ITALIC, or renderer.CODE. Returns: The font embellishment control sequence. rrr rr rr)_fontrBOLDCODEITALICr+)rattrmaskfont embellishments rrzTokenRenderer.Fontxs |dj $Yd jjDj :: hmm X]] 23qHOO7KL D qHMM!"m 1 %!x*>? @m !x}}$ %m !x& 'mm 99} $$rcd|dk(r|jdry|j|j|j|dkDrJd|dz z}|j ||j r%d|_|xjt|z c_|j |tjj|j r6d|_|xj|jj|z c_n|j|jd|_g|_y)zsRenders a heading. Args: level: The heading level counting from 1. heading: The heading text. rz(1)Nrz Tr)endswithrzLinerrkr.r4r/rArr0r\r)rGrZrr7r;)rr|headingrs rHeadingzTokenRenderer.Headings zg&&u- KKMIIKIIK qyuqy!f nnV !% c&k! NN7ENN223 }}#d jjDJJ++G44j mmoJJLDKDJrc|jry|j|js!|j|j yy)z$Renders a paragraph separating line.N)r4rz HaveBlankrrZrys rrzTokenRenderer.Lines8  KKM >>  jjl mmo rc|j|s||_y|r|j|y|x|rQ|j|dd|jd|j|j z|j |y|j|dd|jy|dkDrdnd}|j||d|jd|j|j z|j|dz t|jzz|j|jdz|_ d |_ y) zRenders a bullet or definition list item. Args: level: The list nesting level, 0 if not currently in a list. definition: Bullet list if None, definition list item otherwise. end: End of list if True. Nr)rrr@rrrT) rzr7rrkr6rrvrr-rArr/r5)rr| definitionendrs rListzTokenRenderer.Lists KKM dk  ooe    aA> sT\\%0CCCD J' aA> AIq1f ooeFqoA nn  U#66 6 LL%!)s4<<'88 9 :<<&--1djdrcd|t|kr!||}|dk7r |S|dz }|t|kr!|S)zSkip space characters starting at line[index]. Args: line: The string. index: The starting index in string. Returns: The index in line after spaces or len(line) at end of string. r@r)rA)rrindexcs r _SkipSpacezTokenRenderer._SkipSpacesH #d)  u+a c L qje #d)  LrcP|jj||d}|sd}||zS)zSkip the control sequence at line[index]. Args: line: The string. index: The starting index in string. Returns: The index in line after the control sequence or len(line) at end of string. Nr)r)GetControlSequenceLen)rrrns r_SkipControlSequencez"TokenRenderer._SkipControlSequences0 ((ef6A a 19rcd}|t|krU||}|dz }||vr|dz }n2||vr |dz}|dkr$ |S||jk(r|j||}|t|krU|S)aJSkip a [...] nested bracket group starting at line[index]. Args: line: The string. index: The starting index in string. open_chars: The open nesting characters. close_chars: The close nesting characters. Returns: The index in line after the nesting group or len(line) at end of string. rr)rAr+r)rrr open_chars close_charsnestrs r _SkipNestzTokenRenderer._SkipNests D #d)  u+a qje j      19  L  >))$6 #d)  Lrc.d}|rdD]}|j|\}}}|jj|} |t|z| z|jk\s |dk7r|dk(r|dk7r,||j zt|z| z|jk\r|dk(r|j |d}||k7r3||j z}|j|j d|z|j ||z|t|| zz }|}|}n|r|S)a"Splits a wide SYNOPSIS section group string._out. Args: group: The wide group string to split. indent: The prevailing left indent. running_width: The width of the line in progress. Returns: The running_width after the group has been split and written. r@)z | z : r@,r) partitionr)rGrArE SPLIT_INDENTrkrZ) rr_r running_widthprev_delimiter delimiterpart_ remainderws r_SplitWideSynopsisGroupz%TokenRenderer._SplitWideSynopsisGroups,N /)"__Y7a JJ # #D ) S0 01 4 D$S 3D---N0CCaG  s " NN> * N f $"T%6%66M MMO NN3. / ~,-^,q00 " 50 : rcg}|j|d}|}|t|kr||}|dk(re|}|j||}|t|dz kr)||dk(r!||dzdk(r|j||dz}nU|j||||}n>|dvr|j||}n'||jk(r|j ||}n|dz }|t|kr|t|kr|j||d|j djdz }|} |jd| z||jz }|D]} |jj| dz} | | z|jk\rL|} |j|jd| z| | z|jk\r|j| || } |jd| z| | z } |j|jy)acRenders NAME and SYNOPSIS lines as a second line indent. Collapses adjacent spaces to one space, deletes trailing space, and doesn't split top-level nested [...] or (...) groups. Also detects and does not count terminal control sequences. Args: line: The NAME or SYNOPSIS text. is_synopsis: if it is the synopsis section rr@r|[(N)rrArDrr+rr6rrkrr)rGrErZr) rr is_synopsisgroupsribegrrrrr_rs rSynopsiszTokenRenderer.SynopsisDsF a A C c$i- q'a c OOD! $ TQ DGsNtAE{c7IoodAE*! --S &# 9 NN4 #  >  % %dA . Q c$i-  SY mmDJ\\!_ # #a 'FMNN3&' dkkF ** ! !% (1 ,a !  +   s]*+ A $++ -66V] -  nnS5[!qm MMOMMOrcR|j|dz|z|jy)zAdds an indented table line to the output. Args: line: The line to add. A newline will be added. indent: The number of characters to indent the table. r@N)rkrZ)rrrs r TableLinezTokenRenderer.TableLine|s" NN6C<$&'MMOr)rzutf-8T)N)rN)NF)rz)])F)r)*rr r!r"r*rr0BoldCodeItalicr1 BoldItalicrhrrrHrFobjectr$rrTrZrerkrCrvrzrrrrrrrrrrrrrr __classcell__)r>s@rr r Bs2 # >>   >>   >> >> >> $ $ . &,,v,&-^06( + Z > %<:  D" 4)V6prr )r" __future__rrrr]googlecloudsdk.core.consoler&googlecloudsdk.core.document_renderersrprompt_toolkit.tokenrRendererr r#rrrs6 %N'' 4;&B H%%B r