!%ldZddlmZmZer ddlmZddlmZddlm Z ddlm Z m Z GddZ d S) z,Base utilities for documentation generation.) TYPE_CHECKINGAny)App) HelpPanel) CommandSpec) format_doc format_usagec eZdZdZeddddeedzdeeeeffdZedeedzded edeefd Z eded dd dd e de f dZ eddd e dee fdZ edddede dzfdZeddde dzfdZeddedeededefdZe ddeee dfd e deeeee dfffdZedddd e fdZdS) BaseDocGeneratorz>Base class for documentation generators with shared utilities.Nappr command_chainreturnc|s|jd}|}|}n.|r|dn |jd}d|}|}|||fS)adGet 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 r app_name full_commandtitles /Users/kimhansen/Desktop/03 Workspace/ceo-agents/chl-effectiveness/mcp-servers/whoop/.venv/lib/python3.11/site-packages/cyclopts/docs/base.py get_app_infozBaseDocGenerator.get_app_infos`  !x{H#LEE+8I}Q''chqkH88M22L Eu,, command_namerc|r||gzS||gS)arBuild 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. )r rrs rbuild_command_chainz$BaseDocGenerator.build_command_chain+s$$  , L>1 1l+ +rsubapp parent_appinclude_hiddenc||jvs ||jvrdSt|t|sdS|s |jsdSdS)aCheck 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)rrrrs rshould_skip_commandz$BaseDocGenerator.should_skip_commandBs^( :1 1 1\ZE^5^5^4&$z"2"233 4 fk 4urpanelrc6|r|jSd|jDS)aKFilter 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. c\g|])}|jrtd|jD'|*S)c3vK|]4}|dp|dp|dkV5dS)--help --version-hN) startswith.0ns r zBBaseDocGenerator.filter_help_entries...wsL#v#vijALL$:$:$dall;>W>W$d[\`d[d#v#v#v#v#v#vrnamesallr0es r z8BaseDocGenerator.filter_help_entries..tsU   G !$#v#vnonu#v#v#v v v    r)entries)r'rs rfilter_help_entriesz$BaseDocGenerator.filter_help_entriesas7  !=   ]    r help_formatc&t||}|S)aExtract 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_descriptionz$BaseDocGenerator.extract_descriptionzs !k22 rcT|j|jr|jndSt|g}|S)zExtract usage string. Parameters ---------- app : App The App instance. Returns ------- Optional[Any] The extracted usage object, or None. N)usager )r r@s r extract_usagezBaseDocGenerator.extract_usages3 9 # 3399t 3S"%% r$ usage_textprefixcV|sdSd|vr(|dd}|rd|nd}|dd}t |dkr|r|d|d|d}n|r|d|}n|d|}|S)apFormat 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)rCr rDrparts usage_lines rformat_usage_linez"BaseDocGenerator.format_usage_lines$ 2 z ! !#++Hb99??AAJ2?Gsxx ...R   q)) u::>>m>">>\>>E!H>>JJ  2"33\33JJ"11Z11J!!!rFhelp_panels_with_groupscggggd}|D]\}}|s |r|js|jdkr||s\d|jD}|rHt|||j|j|j}|d||f{|d||f|jdkr$|j}|dkr|d||f|r"|d vr|d ||fg}g} |jD]?} | jo| jd u} | r|| *| | @|rCt||d|j|j}|d||f| rCt|| d |j|j}|d ||f|S)aCategorize 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 argumentsoptionsgroupedcommandc\g|])}|jrtd|jD'|*S)c3K|]}|dvV dS))r+r,r-Nrr/s rr2z@BaseDocGenerator.categorize_panels...s)/d/dWX5R0R/d/d/d/d/d/drr3r6s rr8z6BaseDocGenerator.categorize_panels..sU((( !(-0/d/d\]\c/d/d/d,d,d((((r)r9rr=formatrQ parameter ArgumentsrR) ParametersOptionsrTNr\rS) r%rXr9r$rr=appendrequireddefault) rOrresultgroupr'filtered_entries panel_copyrargsoptsentry is_positionals rcategorize_panelsz"BaseDocGenerator.categorize_panelssy$!rbRPP30 F0 FLE5! e EJ |y((%>((!&((($ (G%0T%[[$4"'+(-(9#(< &&& z*115*2EFFF:&--uen====,, K'';'..u~>>>>Fu,EEE9%,,eU^<<<<DD!&//(-(P5=D;P (/ KK.... KK....H%0T%[[$( IZchco&&& {+22E:3FGGGF%0T%[[$( uGXafam&&& y)00%1DEEE rc#4K|jsdS|jD]r\}}||jvs ||jvrt |t r||n|}t |t|sb|s|jsl||fVsdS)aIterate 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 rr app_or_specrs riterate_commandsz!BaseDocGenerator.iterate_commands s$}  F!$!4!4!6!6   D+s&&$#2D*D*D2rArNdictrhrnrrrr r sHH--%-S D0@-ERUWZ\_R_L`---\-4,49t+;,3,Z],bfgjbk,,,\,,#u%aejn\< ;  c   \ 0SS4Z\$5S4Z\&!"!"c!"$s)!"S!"[^!"!"!"\!"FW\EE!%eC,<&=!>EPTE c4c;./00 1EEE\EN!!e!T!!!\!!!rr N) rrtypingrr cyclopts.corer cyclopts.helprcyclopts.command_specrrr r rrrr}s22%%%%%%%%(!!!!!!''''''------22222222bbbbbbbbbbr