\OdZddlmZddlmZddlmZddlZddlZddlmZddlm Z ddlm Z dd lm Z dd lm Z dd l mZdd lmZdd lmZddlmZddlZgdZGdde j,ZGdde j,ZGdde j,ZGddeZGddeZGddeZGdde j,ZGdde j,Zy) zA collection of CLI walkers.)absolute_import)division)unicode_literalsN)actions) arg_parsers)cli_tree)markdown)walker) properties)render_document)files) pkg_resources)z favicon.icoz index.htmlz _menu_.cssz _menu_.jsz _title_.htmlc:eZdZdZdZdZ dfd ZdZdZxZ S)DevSiteGeneratoraGenerates DevSite reference HTML in a directory hierarchy. This implements gcloud meta generate-help-docs --manpage-dir=DIRECTORY. Attributes: _directory: The DevSite reference output directory. _need_section_tag[]: _need_section_tag[i] is True if there are section subitems at depth i. This prevents the creation of empty 'section:' tags in the '_toc' files. _toc_root: The root TOC output stream. _toc_main: The current main (just under root) TOC output stream. z/sdk/gcloud/referencez _toc.yamlc&tt| ||||_t j |jg|_tjj|j|j}t j||_ |jjd|jjd|jjd|jz|jjdd|_y)a0Constructor. Args: cli: The Cloud SDK CLI object. directory: The devsite output directory path name. hidden: Boolean indicating whether to consider the hidden CLI. progress_callback: f(float), The function to call to update the progress bar or None for no progress bar. restrict: Restricts the walk to the command/group dotted paths in this list. For example, restrict=['gcloud.alpha.test', 'gcloud.topic'] restricts the walk to the 'gcloud topic' and 'gcloud alpha test' commands/groups. restricttoc: z- title: "gcloud Reference" path: %s z section: N)superr__init__ _directoryr MakeDir_need_section_tagospathjoin_TOC FileWriter _toc_rootwrite _REFERENCE _toc_main)selfcli directoryhiddenprogress_callbackrtoc_path __class__s *lib/googlecloudsdk/calliope/walker_util.pyrzDevSiteGenerator.__init__>s  D*3*BDO MM$//"Dww||DOOTYY7H%%h/DNNN"NN89NN$//9:NN(DNc fd}|j rEtjjjg dd t j dn-tjjjg dd tjj rdn ddz}d}tjjjjr2tjjjj}tjjjjd t j|5}tj |}t#j$d d j t'j(||| dddtjjjj|||S#1swYExYw) aEUpdates the TOC and Renders a DevSite doc for each node in the CLI tree. Args: node: group/command CommandCommon info. parent: The parent Visit() return value, None at the top level. is_group: True if node is a group, otherwise its is a command. Returns: The parent value, ignored here. c tdz }|sydj}|tjk\r4jjd|tjk\r4|dk(r,rԉjrjj t jjj}tj|}|_|jd|jd|z|jddjjgddzzd j|<j}d }r|j|d djjgddzjgzd yj}d |dz z}j|dz r&dj|dz <|jd |zd}|j|d|d|j|ddjjgddzd j|<y)zUpdates the DevSIte TOC.N Frz- title: "%s" r/Tz z - include:  z %ssection: z - title: "z" z path: )lenrrappendr#closerrrr rr!r"r ) depthtitler)tocindentcommandr&is_groupr$s r+ _UpdateTOCz*DevSiteGenerator.Visit.._UpdateTOCfs 'lQe hhwe S//0 0 %%e, S//0 0 !  ^^ NN "WW\\)TYY7(  *#$. ))H  ))%- . ))NSXXt.?'!"+.M%NN O*.$  'nn  ))((DOO,wqr{:dii[HI  nn#  ! !%!) ,.3$  + ))NV+ ,  iivu56 ii$chh/@712;/N&O P'/dU#r,r/Nmoder3index.htmluniversedevsiter0)styler8finout command_node)GetPathrrrrr rr VALUEScoreuniverse_domainIsExplicitlySetGetSetrr Markdownr RenderDocumentioStringIO) r$nodeparentr<r=rrLfmdr;r&s ` ` @@r+VisitzDevSiteGenerator.VisitZs|,/^llnG'',,t==i mmIE*'',,t?2?i  Y8EO O--==?"))..>>BBDo**..z:   $ 1   T "b$$!kk"o  **..?L M s )AG??Hc|jj|jr|jjyy)z5Closes the TOC files after the CLI tree walk is done.N)r r6r#)r$s r+DonezDevSiteGenerator.Dones.NN ~~ nnr,FNN) __name__ __module__ __qualname____doc__r"rrrXrZ __classcell__r*s@r+rr.s, '* $LP8]~r,rc,eZdZdZ dfd ZdZxZS)HelpTextGeneratorzuGenerates help text files in a directory hierarchy. Attributes: _directory: The help text output directory. c~tt| |||||_t j |jy)a2Constructor. Args: cli: The Cloud SDK CLI object. directory: The Help Text output directory path name. hidden: Boolean indicating whether to consider the hidden CLI. progress_callback: f(float), The function to call to update the progress bar or None for no progress bar. restrict: Restricts the walk to the command/group dotted paths in this list. For example, restrict=['gcloud.alpha.test', 'gcloud.topic'] restricts the walk to the 'gcloud topic' and 'gcloud alpha test' commands/groups. )r(rN)rrcrrr rr$r%r&r'r(rr*s r+rzHelpTextGenerator.__init__s;  T+ 08, DO MM$//"r,c2|j}|r.tjj|jg|dd}n-tjj|jg|dd}t j |dtjj||rdn|d}t j|5}tj|}tjdtj||ddd|S#1swY|SxYw) a3Renders a help text doc for each node in the CLI tree. Args: node: group/command CommandCommon info. parent: The parent Visit() return value, None at the top level. is_group: True if node is a group, otherwise its is a command. Returns: The parent value, ignored here. r/Nr3r>r?GROUPtext)rErFrG)rIrrrrr rrr rPr rQrRrS) r$rTrUr<r;r&rrVrWs r+rXzHelpTextGenerator.VisitsllnG'',,t==i'',,t?2?i MM)%( 77<< h7GBK HD   $ 1   T "b$$6r{{2AN  M  Ms AD  Dr[r\r]r^r_rrXr`ras@r+rcrcsLP#,r,rcc*eZdZdZdfd ZdZxZS)DocumentGeneratorzGenerates style manpage files with suffix in an output directory. All files will be generated in one directory. Attributes: _directory: The document output directory. _style: The document style. _suffix: The output file suffix. ctt| ||||_||_||_t j|jy)aConstructor. Args: cli: The Cloud SDK CLI object. directory: The manpage output directory path name. style: The document style. suffix: The generate document file suffix. None for .
. restrict: Restricts the walk to the command/group dotted paths in this list. For example, restrict=['gcloud.alpha.test', 'gcloud.topic'] restricts the walk to the 'gcloud topic' and 'gcloud alpha test' commands/groups. rN)rrkrr_style_suffixr r)r$r%r&rEsuffixrr*s r+rzDocumentGenerator.__init__s? T+C(+CDODKDL MM$//"r,c |jdk(rtj|}nd}|j}tj j |jdj ||jz}tj|5}tj|}tj|jdj |tj |||ddd|S#1swY|SxYw)a1Renders document file for each node in the CLI tree. Args: node: group/command CommandCommon info. parent: The parent Visit() return value, None at the top level. is_group: True if node is a group, otherwise its is a command. Returns: The parent value, ignored here. linterN_r0)rEr8rFrGcommand_metadata)rmrGetCommandMetaDatarIrrrrrnr rr rPr rQrRrS) r$rTrUr< meta_datar;rrVrWs r+rXzDocumentGenerator.Visits {{h,,T2iillnG 77<<'): ;dll JD   $ 1   T "b$$ !kk"o$   M  Ms AC99D)Nriras@r+rkrks#&r,rkc2eZdZdZdZdZ dfd ZxZS) HtmlGeneratorzGenerates HTML manpage files with suffix .html in an output directory. The output directory will contain a man1 subdirectory containing all of the HTML manpage files. ctdfdjd|gjdy)zWrites the command menu tree HTML on out. Args: command: dict, The tree (nested dict) of command/group names. out: stream, The output stream. c$dj|S)Nrr)r)rs r+ConvertPathToIdentifierz.ConvertPathToIdentifierDs XXd^r,c (t|}|dkrdnd}|dzdz}|jd}||gz} jdjd|z|| ||jd g|jd gz}|ry jd t |d D] } ||  jdjd|dzz jdjd|zy jdy)zVisit each command and group in the CLI command tree. Args: command: dict, The tree (nested dict) of command/group names. prefix: [str], The subcommand arg prefix. r/visibler'_name_zT{indent}
  • {name}r0)r: visibilitynameitemcommandsgroupsz
      c |dS)Nr~)xs r+zFHtmlGenerator.WriteHtmlMenu..WalkCommandTree.._s( r,)keyz{indent}
    )r:z{indent}
    • z N)r4getr!formatsorted) r;prefixlevelrr:rargsrcrzWalkCommandTreerGs r+rz4HtmlGenerator.WriteHtmlMenu..WalkCommandTreeGs&ke % 9jqy1}f [[ "d tf_d ii 44:F6\#*40 5;5 Z,w{{8R/HHh  (&; man page tree navigation
      z
    N)r!)r$r;rGrzrs `@@r+ WriteHtmlMenuzHtmlGenerator.WriteHtmlMenu<s=>IIGR IIr,ct|j||}tjtj j |d5}|j||dddtD]L}tjd|}tjtj j |||Ny#1swY_xYw)z&Generates html nav files in directory.z _menu_.htmlNz+googlecloudsdk.api_lib.meta.help_html_data.) CommandTreeGeneratorWalkr rrrrr_HELP_HTML_DATA_FILESr GetResourceWriteBinaryFileContents) r$r&r%r'rtreerG file_name file_contentss r+_GenerateHtmlNavzHtmlGenerator._GenerateHtmlNav~s  $ ) )&( ;D   "'',,y-@ AS s# B* #// 7m ## '',,y) ,m + B As CC c^tt| ||dd||j||||y)a-Constructor. Args: cli: The Cloud SDK CLI object. directory: The HTML output directory path name. hidden: Boolean indicating whether to consider the hidden CLI. progress_callback: f(float), The function to call to update the progress bar or None for no progress bar. restrict: Restricts the walk to the command/group dotted paths in this list. For example, restrict=['gcloud.alpha.test', 'gcloud.topic'] restricts the walk to the 'gcloud topic' and 'gcloud alpha test' commands/groups. htmlrBr&rErorN)rrwrrres r+rzHtmlGenerator.__init__s>  -'  ( )S&(;r,r[)r\r]r^r_rrrr`ras@r+rwrw5s% @D LP<