Vh!ddlmZddlZddlZddlmZddlmZm Z ddl m Z m Z ddl mZddlmZeZdd d d d Zd ZdZddZddZddZddZdZy)) annotationsN) constants) AnsibleErrorAnsibleParserError)to_text to_native) AnsibleLoader)Displaydoc plainexamples returndocsmetadata) DOCUMENTATIONEXAMPLESRETURNANSIBLE_METADATAcNtjD]\}}||k(s |cSy)z" reverse lookup of the dict above N)string_to_varsitems)valuekvs K/home/dcms/DCMS/lib/python3.12/site-packages/ansible/parsing/plugin_docs.py _var2stringrs*$$&1 :HcRtjDcic]}|dc}Scc}w)z? initialize a return dict for docs with the expected structure N)rvalues)rs r_init_doc_dictr!s#+224 5AtG 55 5s $ct}i} t|d5}t|j|j }ddd|r'tD]}|j|d|t|< |S#1swY4xYw#t $rA}d|dt |}|s t|||rtj|Yd}~|d}~wwxYw)z5 Read docs from 'sidecar' yaml file doc for a plugin rb file_nameNzUnable to parse yaml file '': orig_exc) ropenr readget_single_data Exceptionrrdisplayerrorrget) filenameverbose ignore_errorsdata file_datayamlfileemsgkeys rread_docstring_from_yaml_filer6&s  DI (D ! ]X%hmmoJZZ\I ]! AC(1 c4(@D$ % A K ] ] 6> ! M$S15 5  MM#  s. B*A7B7B<B C  7CC c t}t}d}tj|5}tj|j }|D]$}|j tjk(rC|jdk(r4|jtvr"|j|vrt|j}d|g|j tjk(s|j|j|j} | jdr| jd} | jdr| jd} |dk(rt!| ||<n t#| |j%||<d}' ddd|s t3|||}|S#t&$rM} d t)|d |d t+| } |s t-| | |rt.j1| Yd} ~ pd} ~ wwxYw#1swYsxYw) z Use tokenization to search for assignment of the documentation variables in the given file. Parse from YAML and return the resulting python structure or None together with examples as plain text. N)rbr )'"z'"r r!zUnable to parse docs 'z' in python file 'r#r$)setrtokenizer&generate_tokensreadlinetypeNAMEstartstringrSTRINGadd startswithlstripstriprr r(r)rrrr*r+read_docstring_from_python_file) r-r.r/seenr0 next_stringftokenstokenrr3r4s r!read_docstring_from_python_modulerP=s 5D  DK x +#A))!**5) #EzzX]]*;;!# (F5<<_cKc"0">K&5::+H& ##J/!LL.E##J/!KK.E/1(/D%/,9%8,T,d,d,f[)# S) #+#\ .x-P K%/U`alUmowzCDEzFG,"4S1"EE$#MM#. /I+#+#sDBG)5G)A?G)F1G) G&AG!G)!G&&G))G2c t} t|d5}tj|j }dddj D]}t |tjs|jD]} |j}|tvst|} t |jtjr#tj |j|| <nZ|dk(r#t#|jj|| <n2t%|jj|j'|| <tj)d| z  |S#1swY$xYw#t$r tjd|d|dYwxYw#t*$rB} d |d t-| } |s t/| | |rtj1| Yd} ~ |Sd} ~ wwxYw) z Use ast to search for assignment of the DOCUMENTATION and EXAMPLES variables in the given file. Parse DOCUMENTATION from YAML and return the YAML doc or None together with EXAMPLES, as plain text. r Nz0Building documentation, failed to assign id for z on z , skippingrr!zDocumentation assigned: %sz.Unable to parse documentation in python file 'r#r$)rr&astparser'body isinstanceAssigntargetsidAttributeErrorr*warningrrDict literal_evalrr r(debugr)rrr+) r-r.r/r0 b_module_dataMchildttheidvarkeyr3r4s rrJrJ{s  D" (D ! 0] -,,./A 0VV ME%,MA! ! .!/!6%ekk388<+.+;+;EKK+HDL$ 207u{{7H7H/IV 0=U[[=N=NZb/c/s/s/uV  &BV&KL+M M@ KG 0 0*!pqs{(|} !( IQS\]^S_`$S15 5  MM#  Ks^ F$E2F/F? E+ FCFE(#F+%FFFF G" 7GG"c0|jtjrt|||}nG|jtjrt |||}n|st dt|zs|st dt|zd|d<|S)zC returns a documentation dictionary from Ansible plugin docstrings )r.r/z Unknown documentation format: %sz%Unable to parse documentation for: %sNseealso)endswithCYAML_DOC_EXTENSIONSr6PYTHON_DOC_EXTENSIONSrPrr)r-r.r/ docstrings rread_docstringrks../1(G[hi   122 35h_lm = (@SSTT ]BYxEXXYY Ii rchd}d}d}g}t|d5}|D]}|r|r#|j|r|j|*|r|j|sn~|jjds_d}dt |t |jz dzz}|j||jdsd |vsd |vsd}d d d dj |j jd }t|| j}|S#1swYTxYw)z Quickly find short_description using string methods instead of node parsing. This does not return a full set of documentation strings and is intended for operations like ansible-doc -l. Fr9zshort_description:T r8r=:N.r!) r&rGappendrHlenjoinrIrstripr r() r-in_documentation capturingindent_detectiondoc_stub t_module_datalineshort_descriptionr0s r read_docstubr}s$IH h ( ! (D1A!BOOD)t7G'H[[]--.BC $I(+c$i#dkkm:L.Lq.P'Q$OOD)1sd{cTk#' # (((*00299#> *h ? O O QD K/((sA!D(7AD(D(D((D1)TT) __future__rrRr>ansiblerrgansible.errorsrr+ansible.module_utils.common.text.convertersrransible.parsing.yaml.loaderr ansible.utils.displayr r*rrrr6rPrJrkr}rrrs`# ";J5) )" 6 .;|,^*#r