k7i>%nSrSSKJrJr \(a SSKJr SSKJr SSKJ r SSKJ r J r "SS5r g ) z,Base utilities for documentation generation.) TYPE_CHECKINGAny)App) HelpPanel) CommandSpec) format_doc format_usagec \rSrSrSr\SSSS\\S-S\\\\44Sjj5r \S\\S-S \S \S\\4S j5r \S \S SS SS\ S\ 4 Sj5r \SSS\ S\\ 4Sj5r\SSS\S\ S-4Sj5r\SSS\ S-4Sj5r\SS\S\\S\S\4Sjj5r\SS\\\ S4S\ S\\\\\ S444Sjj5r\SSSS\ 4Sjj5rSrg) BaseDocGenerator z>Base class for documentation generators with shared utilities.Nappr command_chainreturncU(dURSnUnUnO.U(aUSOURSnSRU5nUnX#U4$)a Get app name, full command path, and title. Parameters ---------- app : App The cyclopts App instance. command_chain : Optional[List[str]] Chain of parent commands leading to this app. Returns ------- Tuple[str, str, str] (app_name, full_command, title) r )namejoin)r rapp_name full_commandtitles L/home/james-whalen/.local/lib/python3.13/site-packages/cyclopts/docs/base.py get_app_infoBaseDocGenerator.get_app_infosR xx{H#LE+8}Q'chhqkH88M2L Eu,, command_namerc U(aX/-$X!/$)a Build command chain for a subcommand. Parameters ---------- command_chain : Optional[List[str]] Current command chain. command_name : str Name of the subcommand. app_name : str Name of the root app. Returns ------- List[str] Updated command chain. )rrrs rbuild_command_chain$BaseDocGenerator.build_command_chain+s$  >1 1+ +rsubapp parent_appinclude_hiddencXR;dXR;ag[U[U55(dgU(dUR(dgg)a@Check if a command should be skipped. Parameters ---------- command_name : str Name of the command. subapp : App The subcommand App instance. parent_app : App The parent App instance. include_hidden : bool Whether to include hidden commands. Returns ------- bool True if command should be skipped. TF) _help_flags_version_flags isinstancetypeshow)rr r!r"s rshould_skip_command$BaseDocGenerator.should_skip_commandBsB( 11 1\E^E^5^&$z"233fkkrpanelrcU(a UR$URVs/sH9nUR(a#[SUR55(aM7UPM; sn$s snf)zFilter help panel entries based on visibility settings. Parameters ---------- panel : HelpPanel The help panel to filter. include_hidden : bool Whether to include hidden entries. Returns ------- List[Any] Filtered panel entries. c3# UH9oRS5=(d URS5=(d US:Hv M; g7f)--help --version-hN) startswith.0ns r 7BaseDocGenerator.filter_help_entries..ws7#vnuijLL$:$dall;>W$d[\`d[d$dnusAA)entriesnamesall)r+r"es rfilter_help_entries$BaseDocGenerator.filter_help_entriesasW == ]] "GG#vnonunu#v v "   s 6A%A% help_formatc[X5nU$)zExtract app description. Parameters ---------- app : App The App instance. help_format : str Help format type. Returns ------- Optional[Any] The extracted description object, or None. )r)r r= descriptions rextract_description$BaseDocGenerator.extract_descriptionzs !2 rcvURbUR(a UR$S$[U/5nU$)zExtract usage string. Parameters ---------- app : App The App instance. Returns ------- Optional[Any] The extracted usage object, or None. N)usager )r rCs r extract_usageBaseDocGenerator.extract_usages4 99 # 399 3t 3S"% r usage_textprefixcU(dgSU;a URSS5R5nU(aSRU5OSnURSS5n[ U5S:a$U(aUSUSUS3nUR5$U(aUSU3nUR5$USU3nUR5$)aFormat usage line with proper command path. Parameters ---------- usage_text : str Raw usage text. command_chain : List[str] Command chain for the app. prefix : str Prefix for the usage line (e.g., "$"). Returns ------- str Formatted usage line. zUsage:rN)replacestriprsplitlen)rFrrGrparts usage_lines rformat_usage_line"BaseDocGenerator.format_usage_lines$ z !#++Hb9??AJ2?sxx .R   q) u:>m"81\N!E!H:>J !! "81\N3J!!#81ZL1J!!rhelp_panels_with_groupsc////S.nUGHAup4U(dU(aUR(dM'URS:XaU(dURVs/sH9nUR(a#[ SUR55(aM7UPM; nnU(aG[ U5"UUR URURS9nUSRX745 MMUSRX445 MURS:XdGMUR nUS:XaUSRX445 GM2U(aUS ;aUS RX445 GMW/n /n URHOn U R=(a U RS Ln U (aU RU 5 M>U RU 5 MQ U (a;[ U5"U SURURS9nUSRX745 U (dGM[ U5"U S URURS9nUS RX745 GMD U$s snf)aUCategorize help panels by type. Parameters ---------- help_panels_with_groups : List[Tuple[Any, HelpPanel]] List of (group, panel) tuples. include_hidden : bool Whether to include hidden panels. Returns ------- Dict[str, List[Tuple[Any, HelpPanel]]] Categorized panels with keys: 'commands', 'arguments', 'options', 'grouped'. )commands argumentsoptionsgroupedcommandc3*# UH oS;v M g7f))r.r/r0Nrr2s rr55BaseDocGenerator.categorize_panels..s/d\cWX5R0R\cs)r7rr?formatrU parameter ArgumentsrV) ParametersOptionsrXNr`rW) r(r\r7r8r9r'rr?appendrequireddefault) rSr"resultgroupr+r:filtered_entries panel_copyrargsoptsentry is_positionals rcategorize_panels"BaseDocGenerator.categorize_panelss $!rbRP3LE!eEJJ||y(%"'(!.A !C/d\]\c\c/d,d!.%( (%)%[$4"'++(-(9(9#(<< & z*1152EF(:&--un=, K';'..~>u,EE9%,,e^<DD!&(-(P5==D;P ( KK. KK. "/%)%[$( IZIZchcoco& {+22E3FGt%)%[$( uGXGXafamam& y)00%1DEa4d Y(s 6IIc#|# UR(dgURR5Hup#X R;dX R;aM%[ U[ 5(aUR U5OUn[ U[U55(dMiU(dUR(dMX$4v M g7f)aOIterate through app commands, yielding valid resolved subapps. Automatically resolves CommandSpec instances to App instances. Parameters ---------- app : App The App instance. include_hidden : bool Whether to include hidden commands. Yields ------ Tuple[str, App] (command_name, resolved_subapp) for each valid command. N) _commandsitemsr$r%r&rresolver'r()r r"r app_or_specr s riterate_commands!BaseDocGenerator.iterate_commands s$}} !$!4!4!6 D&$2D2D*D2EPTE c4c;./00 1EEN!e!T!!rr N) rztypingrr cyclopts.corer cyclopts.helprcyclopts.command_specrrr r rrrrs&2%!'-2bbr