VhddlmZddlmZddlZddlZddlZddlZddlZddl Z ddl Z ddl m cm ZddlmZddlmZddlmZddlmZddlmZdd lmZmZmZmZdd lm Z m!Z!dd l"m#Z#dd l$m%Z%dd l&m'Z'ddl(m)Z)ddl*m+Z+ddl,m-Z-ddl.m/Z/ddl0m1Z1ddl m2Z2m3Z3ddl4m5Z5m6Z6ddl7m8Z8ddl9m:Z:ddl;mZ>m?Z?m@Z@e<ZAejdzZCgdZDiZEgdZFddddd d!d"d#ZGd$d%d&d&d'ZHejejejejejejd(ZOd)ZPGd*d+eQZRd,ZSd-ZTGd.d/eeRZUd0ZVd1ZWd4d2ZXeYd3k(reXyy)5) annotations)CLIN)Path) constants)context)option_helpers)list_collection_dirs) AnsibleErrorAnsibleOptionsErrorAnsibleParserErrorAnsiblePluginNotFound) to_nativeto_text) is_sequence) json_dump) yaml_dump) string_types) read_docstub) from_yaml) AnsibleDumper) list_plugins) action_loaderfragment_loader)AnsibleCollectionConfigAnsibleCollectionRef)_get_collection_name_from_path)stringc)Display)get_plugin_docs get_docstringget_versioned_doclink)rolekeyword)PlayRoleBlockTaskHandler) inventorylookupmodulezzzzzzz)BLINKBOLDHIDENORMALRESETREVERSE UNDERLINEz*%s*z`%s`z[%s])r-r2MODULEPLUGIN)r3REFLINKDEPCONSTANTr4c tjt|y#t$rC}tjt j t dt|zd}~wwxYw)NzXWe could not convert all the documentation into JSON as there was a conversion issue: %s)displayr TypeErrorvvv traceback format_excr r)textes ?/home/dcms/DCMS/lib/python3.12/site-packages/ansible/cli/doc.pyjdumprBTslF $( F I((*+uyBCDyEEF FFs! A->A((A-ceZdZdZej Dcgc]}d|z c}}Zej Dcgc]}d|z c}}ezZdZdZ dZ ddZ dd Z d Z d Zdd Zdd Zycc}}wcc}}w) RoleMixinzA mixin containing all methods relevant to role argument specification functionality. Note: The methods for actual display of role data are not present here. mainargument_specsc|r#tjj|d|d}n tjj|d}|D]E}tjj||}tjj|sC|}niS t |d5} t | j |} | i} ddd| S#1swY SxYw#ttf$r} td|d|d| d} ~ wwxYw) a Load and process the YAML for the first found of a set of role files :param str root: The root path to get the files from :param str files: List of candidate file names in order of precedence :param str role_name: The name of the role for which we want the argspec data. :param str collection: collection name or None in case of stand alone roles :returns: A dict that contains the data requested, empty if no data found rolesmetaNr) file_namezCould not read the role 'z' (at )orig_exc) ospathjoinexistsopenrreadIOErrorOSErrorr ) selfrootfiles role_name collection meta_pathspecfile full_pathrPfdatar@s rA_load_role_datazRoleMixin._load_role_datags  T7IvFI T62I H Y9Iww~~i(    <I mdC A T:<D    ! m$yZ^%_jkl l ms6 C! C C CCCD'C;;DcH|j||j||}|d=|S)a~Load the roles metadata from the source file. :param str role_name: The name of the role for which we want the argspec data. :param str role_path: Path to the role/collection root. :param str collection: collection name or None in case of stand alone roles :returns: A dict of all role meta data, except ``argument_specs`` or an empty dict rF)raROLE_METADATA_FILES)rWrZ role_pathr[r`s rA_load_metadatazRoleMixin._load_metadatas/##It/G/GT^_ ! " c |j||j||}|jdi}|S#t$r}d|dt ||d}Yd}~|Sd}~wwxYw)aLoad the role argument spec data from the source file. :param str role_name: The name of the role for which we want the argspec data. :param str role_path: Path to the role/collection root. :param str collection: collection name or None in case of stand alone roles We support two files containing the role arg spec data: either meta/main.yml or meta/argument_spec.yml. The argument_spec.yml file will take precedence over the meta/main.yml file, if it exists. Data is NOT combined between the two files. :returns: A dict of all data underneath the ``argument_specs`` top-level YAML key in the argspec data file. Empty dict is returned if there is no data. rFzFailed to process role (): )error exceptionN)raROLE_ARGSPEC_FILESget Exceptionr)rWrZrdr[r`r@s rA _load_argspeczRoleMixin._load_argspecsk  l'' 43J3JIWabD88,b1D   lBKYWX\ZijkD  ls04 AAANct}t}|D]}tjj|s#tj|D]}tjj ||}|j D]s}tjj |d|} tjj| sD|||vr)||vr%|j||j|d|f|S)aFind all non-collection roles that have an argument spec file. Note that argument specs do not actually need to exist within the spec file. :param role_paths: A tuple of one or more role paths. When a role with the same name is found in multiple paths, only the first-found role is returned. :param name_filters: A tuple of one or more role names used to filter the results. :returns: A set of tuples consisting of: role name, full role path rIN) setrOrPisdirlistdirrQrkrRadd) rW role_paths name_filtersfound found_namesrPentryrdr]r^s rA_find_all_normal_rolesz RoleMixin._find_all_normal_rolesse  D77==&D) GGLLu5 !% 7 7 H " Y IIww~~i0'/5L3H$K7 + 6!& 5$ *B C     * rfc t}t|}|D]e}t|d}t|}tj j |d}tj j|s\t j|D]} |jD]} tj j || d| } tj j| sE||j| ||fn|D]} t| jddk(rG| jd\} }}dj | |g|k(sL| |k(sR|j| ||fg| | k(sm|j| ||fh|S)aFind all collection roles with an argument spec file. Note that argument specs do not actually need to exist within the spec file. :param name_filters: A tuple of one or more role names used to filter the results. These might be fully qualified with the collection name (e.g., community.general.roleA) or not (e.g., roleA). :param collection_filter: A list of strings containing the FQCN of a collection which will be used to limit results. This filter will take precedence over the name_filters. :returns: A set of tuples consisting of: role name, collection name, collection path ) coll_filtersurrogate_or_stricterrorsrHrI.) rpr rrrOrPrQrRrrrkrslensplit)rWrucollection_filterrv b_colldirsb_pathrPcollname roles_dirrxr]r^fqcnnscolr"s rA_find_all_collection_rolesz$RoleMixin._find_all_collection_roless`)6GH   "F6*?@D5f=H T73Iww~~i(ZZ 2"E%)$;$;"$&GGLLE68$T 77>>)4+3 % 5(D*A B-9!KD'*4::c?';q'@:>**S/S$+.88RI+>(+JuX\},1IIuh6M,N)-(- 5(D2I(J !K"""  "0 rfc|r|jdr|d}nddi}i|d<|rdj||g}||d<n|}|jD]#}||xsi}|jdd|d|<%||fS) a3Build a summary dict for a role. Returns a simplified role arg spec containing only the role entry points and their short descriptions, and the role collection name (if applicable). :param role: The simple role name. :param collection: The collection containing the role (None or empty string if N/A). :param meta: dictionary with galaxy information (None or empty string if N/A). :param argspec: The complete role argspec data dict. :returns: A tuple with the FQCN role name and a summary dict. galaxy_info description UNDOCUMENTED entry_pointsrr[short_description)rlrQkeys) rWr"r[rIargspecsummaryrep entry_specs rA_build_summaryzRoleMixin._build_summarys DHH]+=)G$n5G"$ 88Z./D$.GL !D,,. RB *J*4..9Lb*QGN #B ' Rgrfc,|rdj||g}n|}i}||d<||d<d|vr|j|||fSi|d<|jD]}|||k(s ||xsi} | |d|<t|djdk(rd}||fS)NrrPr[rirr)rQupdaterr) rWr"rPr[r entry_pointrdocrrs rA _build_doczRoleMixin._build_doc!s 88Z./DDF &L g  JJw c{#%C lln 9&" *;!(!2J.8C'+ 9 3~&++-.!3c{rfc |j}|j}|s|j|}n t}|j |}i}||zD]t\}}} |j || |} |j|| |} d| vr'|r| dtjd|d| ddY|j||| | \} }||| <v|S#t $r1} tjd|dt| di} Yd} ~ d} ~ wwxYw) aReturn a dict describing the listing of all roles with arg specs. :param role_paths: A tuple of one or more role paths. :returns: A dict indexed by role name, with 'collection' and 'entry_points' keys per role. Example return: results = { 'roleA': { 'collection': '', 'entry_points': { 'main': 'Short description for main' } }, 'a.b.c.roleB': { 'collection': 'a.b.c', 'entry_points': { 'main': 'Short description for main', 'alternate': 'Short description for alternate entry point' } 'x.y.z.roleB': { 'collection': 'x.y.z', 'entry_points': { 'main': 'Short description for main', } }, } )rzNo metadata for role ( ) due to: TNrirjSkipping role () _get_roles_path_get_collection_filterryrprrermr:r<rrnwarningr)rWfail_on_errors roles_pathrrH collrolesresultr"r[rdrIr@rrrs rA_create_role_listzRoleMixin._create_role_list8s+<))+  779 // ;EEE33FW3X ,1I,= # 'D*i **4JG ((y*EG'!!!+..OOtWU\M]$^`de //j$PMD'"F4L# #&   dIVWLY[_` s C D 'DD cL|j}|j||}|j|}i}||zD]d\}} } |j|| | } d| vr'|r| dtj d|d| ddE|j || | | |\} } | s`| || <f|S)a :param role_names: A tuple of one or more role names. :param role_paths: A tuple of one or more role paths. :param entry_point: A role entry point name for filtering. :param fail_on_errors: When set to False, include errors in the JSON output instead of raising errors :returns: A dict indexed by role name, with 'collection', 'entry_points', and 'path' keys per role. )rurirjrrT)rryrrnr:rr)rW role_namesrrrrHrrr"r[rdrrrs rA_create_role_doczRoleMixin._create_role_docus))+ ++JZ+P333L ,1I,= # 'D*i((y*EG'!!!+..OOtWU\M]$^`deiWkZID#"t  # rfN)NN)T)NT)__name__ __module__ __qualname____doc__CYAML_FILENAME_EXTENSIONSrcrkrarernryrrrrr).0r@s00rArDrD\s01/I/IJ!6A:J898R8RS1*Q.SVii"H 2#J(T>.;zcKSs A( A.rDc>|jds t|}|S)N)httpz..) startswithr!)urls rA_doclinkrs >>. )#C( Jrfc|D]}|tvr6|jtvr |tjvrt d|ztj r|tvsZt||z}g|tjvr t||}|tvrt|t|}t|j|td}|S)z$ add ascii formatting or delimiters z!Invalid format value supplied: %sr/) ref_styleupperSTYLEr COLOR_CODESKeyErrorANSIBLE_NOCOLORNOCOLORr)stringargsstyles rA_formatrsP  !ekkm5&@URSR_R_E_>FG G   &0 amm #VU+F i VYu%56F"'u{{}!5vuXOF!P$ MrfceZdZdZdZdZejdZejdZ ejdZ ejdZ ejdZ ejd Z ejd Zejd Zd Zejd ezZejdezZejdezZejdezZejdZejdZejdZdZejdZejdZejdZejdZfdZedZedZ e!dZ"fdZ#fdZ$dZ%d Z&d!Z'ed"Z(ed#Z)d$Z*d%Z+d9d&Z,d'Z-ed(Z.fd)Z/ed*Z0ed+Z1ed,Z2ed-Z3ed.Z4ed/Z5d0Z6ed1Z7ed:d2Z8ed3Z9ed;d4Z:edd8Z>xZ?S)?DocCLIa displays information on modules installed in Ansible libraries. It displays a terse listing of plugins and their short descriptions, provides a printout of their DOCUMENTATION strings, and it can create a short "snippet" which can be pasted into a playbook. z ansible-doc) r+docuri version_addedversion_added_collectionrnow_date plainexamples returndocsr[ plugin_namez\bI\(([^)]+)\)z\bB\(([^)]+)\)z\bM\(([^)]+)\)z\bP\(([^#)]+)#([a-z]+)\)z\bL\(([^)]+), *([^)]+)\)z\bU\(([^)]+)\)z\bR\(([^)]+), *([^)]+)\)z\bC\(([^)]+)\)z\(((?:[^\\)]+|\\.)+)\)z\bOz\bVz\bEz\bRVz\bHORIZONTALLINE\bz\\(.)z%^([^.]+\.[^.]+\.[^#]+)#([a-z]+):(.*)$zignore:z .. note::z .. seealso::z:\w+?:`z .. \w+?::cJtt| |t|_yr)superr__init__rp plugin_list)rWr __class__s rArzDocCLI.__init__s fd$T*5rfcltjjd|jd}d|dS)N\1`')r _UNESCAPEsubgroup)matcherr?s rA_tty_ify_sem_simlezDocCLI._tty_ify_sem_simles1##E7==+;<4&{rfcvtjjd|jd}d}d|vr|j dd\}}tj j |}|r4|jd}|jd}|jd}nD|jtjr!|ttjd}dx}}ndx}}d}d|vr|j dd\}}||d|}|r+|r)|dvrdnd }||d |}|d k(r ||d |d }d|d|dSd|dS)Nrr=rr:)r"r+playbook plugin r", z entrypointrz' (of rLr) rrrrr_FQCN_TYPE_PREFIX_REmatchr_IGNORE_MARKERr) rr?valuem plugin_fqcn plugin_type entrypoint plugin_suffixplugins rA_tty_ify_sem_complexzDocCLI._tty_ify_sem_complexsc##E7==+;< $;**S!,KD%  ' ' - -d 3 ''!*K''!*K771:D __V22 3F11234D(* *K+(* *K+ $;#zz#q1 J  V1UG$D ;"-1O"OBU^M#}]O1[MBFf$)?"82j\=tfF6(!, ,4&{rfc@|jjtdd|}|jjtdd|}|jjtdd|}|j jd|}|j jd|}|jjtdd|}|jjtdd|}|jjtd d |}|jj|j|}|jj|j|}|jj|j|}|jj|j|}|j jd j#d |}|j$jd |}|j&jtdd|}|j(jd|}|j*jd|}t-j|j d|}t-j|j d|}|S)Nrr2r-r3z\1 <\2>z[\1]r4r5z`\1'r8z {0} z -------------z See also:zNote:boldrrcPtdt|jdzdS)N%srr6)rrrrs rAz DocCLI.tty_ify..swux 7K/KV'Trfc t|jddtt|jdddS)Nrz )rrrrs rArz DocCLI.tty_ify.. s-aggaj'(STSZSZ[\S]J^`fBg(hrf)_ITALICrr_BOLD_MODULE_URL_LINK_PLUGIN_REF_CONST_SEM_OPTION_NAMEr_SEM_OPTION_VALUEr_SEM_ENV_VARIABLE_SEM_RET_VALUE_RULERformat _RST_SEEALSO _RST_NOTE _RST_ROLES_RST_DIRECTIVESre)clsr?ts rAtty_ifyzDocCLI.tty_ifys KKOOGE;7 > IIMM'%0! 4 KKOOGE84a 8 HHLL " IIMM*a ( KKOOG$5x@! D HHLL. 2 JJNN77J7 ;  $ $S%=%=q A  ! ! % %c&<&  t_=$I  K t[u[i$VY]YbYbckYl$l  n t^LRW^j$uyD%D  EtXlEXb$@;$N  P0u[a$z  |   !6|UZat'm ! nrfcXtt| |}|jt_|Sr)rrpost_process_args verbosityr:)rWoptionsrs rAr2zDocCLI.post_process_argsZs'7@#--rfc td|jD}tj|z dz }g}g}tj drt |jD]}t||}|jd}|djdrN|ddk(rF|d d vr?|dd d|d<dj|}|jd |||t||fz|jd |||t||fznt |jD]}tj||} t| |kDr| d|d z} |jd}|djdrP|jd r?|dd d|d<dj|}|jd |||t| | fz|jd |||t| | fzt|dkDr"|jd|j|tj!dj|y)Nc32K|]}t|ywrrrxs rA z-DocCLI.display_plugin_list..ds6!s1v6r r_ransibler)builtinlegacyz %-*s %-*.*s...)ansible.builtin.zansible.legacy.z DEPRECATED: )maxrr:columnsrCLIARGSsortedrrrrQappendrrr extendpager) rWresultsdisplace linelimitr? deprecatedrfilenamepbreakrs rAdisplay_plugin_listzDocCLI.display_plugin_listas26w||~66OOh.2   ??< ( 0 h$WV_5 c*":((-&)y2HVTUYZoMo!'ABF2J XXf-F%%mxTWX`Tack6l&lmKK 69cRZm]e0f fg h!0 `~~gfo6t9y( +e3Dc*":((-&2C2CDk2l!'ABF2J XXf-F%%mxTWX\T]_c6d&deKK 69cRViY]0^ ^_ ` z?Q  KK ( KK #  TYYt_%rfct|j}t}|D].}||djD]}|j|0d}d}|rt d|D}t j |z |z dz }g} t|D]}||drq| jd|z| jd||djD]2\}} t| |kDr| d|dz} | jd ||| fz4|| jd |ztjd j| y) zDisplay all roles we can find with a valid argument specification. Output is: fqcn role name, entry point, short description rrc32K|]}t|ywrr7r8s rAr:z2DocCLI._display_available_roles..s?SV?r;r<%s:z specs:NrBz %-*s: %srrD)listrrprsrEr:rFrHrIitemsrrrKrQ) rW list_jsonrHentry_point_namesr"r max_role_len max_ep_lenrNr?rs rA_display_available_roleszDocCLI._display_available_rolessX Y^^%&E 3D(~>CCE 3 !%%k2 3 3  ?->??JOOl2Z?!C 5M )D~. EDL) J')24)H)N)N)PR%K4y9,#JY/%7KK*k41P PQR  D4K( )  TYYt_%rfcXt|j}g}|D]E} d||vr#tjd|d||dd.||j |||z }Gt jdj|y#t $r}t d|z|d}~wwxYw)NrizSkipping role 'z ' due to: TzRole '%srMrD) rVrr:rget_role_man_textr rrKrQ)rW role_jsonrHr?r"r@s rA_display_role_doczDocCLI._display_role_docsY^^%& JD Jio-OOtYW[_]dMe$fhlm..tYt_EE  J  TYYt_% & J(t)) rr`descskeyr#kdatapobj obj_class loaded_classfavisiblekr@s rA_get_keywords_docszDocCLI._get_keywords_docss%%'; '>y'I *1,d*K $)D/"="==l+2248".!*4!j 1,AF18W1EgF;FBejjl+%AQx'!!H%"S m; tj|||   }|s t!||||<l|S#t $r(} tjt| Yd} ~ d} ~ wt$r} |sddt| zi||<Yd} ~ tjtj|d|dt| d} |rtj| n t| Yd} ~ d} ~ wwxYw#t$r} dd t| zi||<Yd} ~ Nd} ~ wwxYw) Nr3rriz:Missing documentation or could not parse documentation: %srz; missing documentation (or could not parse documentation): rDzNo valid documentation foundz*Cannot serialize documentation as JSON: %s)rrrrrrGr r:rrrmr<r=r>r _combine_plugin_docr)rWrnamesfail_okrr plugin_docsrrrrmetadatar@msgdocss rA_get_plugins_docszDocCLI._get_plugins_docs)s$$[1 ! 'FC ,;J6S^`fhw{B{J{JKV{WZ[{[<]8]J%+24R*SK'--fk3 WacklD!dO #'K C! 'F?)  ! - ,%+24ps|}~s4+AK' I0023`kmsu~@AvBCOOC(&s++) ,,!+24`clmnco4o*pK'sB,B 5 E EB55 ED>AD>>E E-E((E-c,tjd}tjdmtjj tjdd}tjj |r|f|z}|tjdfz}|S)ao Add any 'roles' subdir in playbook dir to the roles search path. And as a last resort, add the playbook dir itself. Order being: - 'roles' subdir of playbook dir - DEFAULT_ROLES_PATH (default in cliargs) - playbook dir (basedir) NOTE: This matches logic in RoleDefinition._load_role_path() method. rbasedirrH)rrGrOrPrQrq)rWrsubdirs rArzDocCLI._get_roles_pathTsv__\2 ??9 % 1WW\\'//)"tj} tj| j|d | <|j!| d} |j#| | | dv||d | <n|rE|dk(rtj}n|d k(r|jd }n|j!||}nt%tjddk(r td|dk(r'tjtjd}n_|d k(r7|jtjdtjd| }n#|j#|tjd}|r t'|yg} |t(j*vr|r|r|j-|nVtjdrn|t.vr!t1ddj3t.z|j5D]1\}} tj7|||d}| j9|3n|j5D]W\}}tjE|||d|d|d|d}|r| j9|@t<j?d|zYnj|d k(r;tjdr|r|jG|n>|r<|jI|n*|r(tjKtjM|} | r$tjOdj3| y#t:$r9}t<j?djA|tC|Yd}~nd}~wwxYw) Nrrrr"r r!r#rYrz)Unknown or undocumentable plugin type: %sallr")rrr#)testfilter)rrFrrzEMissing name(s), incorrect options passed for detailed documentation.rz>Snippets are only available for the following plugin types: %srrz,Unable to construct a snippet for '{0}': {1}examplesreturnrz.No valid documentation was retrieved from '%s'r)(rrrunrrGrxboolrplaybook_pathsr*r rrrrerrrrrBrDOCUMENTABLE_PLUGINSrRr/r rQrWformat_snippetrI ValueErrorr:rrrformat_plugin_docr\r`r  _dump_yamlrK)rWrrdo_jsonlistingno_failrrptypesptyperHr plugin_namesr?rdoc_datatextretr@rs rArz DocCLI.runxs fd!//),oof-335 //-0KGOOF4K//,/N7??:3N7??+>??@ ??< (G __Z (GG 5< # 2 n ,%&QT_&_` ` ??6 "#FDK TF? 22'2JE)-)>)>uzz|W__]jMk}D)>*EDK&i'"113E)/)B)B5::<)PDK&#'#5#5eT#BL)-)?)?|^cgy^yLS)?*TDK& Ti',,.&--U-C))+w?7??6*+q0)*qrri'001HI&,,W__V-DgooVcFdu|,}--k7??6;RS  $KVSDa444t,,T2__^4"(2*,8:>))H:M,NOO-1JJL1(1&,&;&;FKQYZ_Q`&aG !KK01-1JJLg("(":":6;;CE?HU_L`;CH;MxXbOc#e# KK0#OO,\_e,efg&??:.411$7**40~~f&7&7&=> RWWT]+; *V#OO-::@&QR:TVVVs:R$$ S&-.S!!S&cttd|z}|j}i}|D]}|jt |t |j S)Nr)r{r_get_paths_with_contextrrrHr)rrpathsr path_contexts rAget_all_plugins_of_typezDocCLI.get_all_plugins_of_typesW k(AB..0! 6L NN< 4 5 6glln%%rfc ^ttd|z}|j|ddd}|jst dj |||j }|j} t|ttjddkD||\}}}}|yt#|t$j'|||j(|j+d d |j+dd S#t$r<tjtj t |d |d |d wxYw)Nrz.pyT)mod_typeignore_deprecated check_aliasesz$unable to load {0} plugin named {1} r3r)rcollection_namerrz at zB has a documentation formatting error or is missing documentation.rUNKNOWNr)name namespacerr)r{rfind_plugin_with_contextresolvedr rplugin_resolved_pathplugin_resolved_collectionr rrrGrmr:r<r=r>dictrnamespace_from_plugin_filepath package_pathrl)rrrrrPrr__s rAget_plugin_metadatazDocCLI.get_plugin_metadatas= k(AB00u`dtx0yELL[Zefg g.. ;; W+HoPWP_P_`kPlopPpqAGGM!))#s3 r>Hrfc@|dk(r|tvrd|d<nd|d<||||dS)Nr+T has_actionF)rrrr)r)rrrrrrs rArzDocCLI._combine_plugin_docs: ( "&$(L!$)L! Yabbrfc |dk(r;|jdijdrtdj|g}|dk(r t|}nd|vr t |}|j ddj |S)z9 return heavily commented plugin use to insert into play r)r4rzThe {0} inventory plugin does not take YAML type config source that can be used with the "auto" plugin so a snippet cannot be created.r*rrD)rlrr_do_lookup_snippet_do_yaml_snippetrIrQ)rrrr?s rArzDocCLI.format_snippet#s + %#'')R*@*D*DX*N))/9 9 ( "%c*D # #C(D Byyrfc|d}||d<||d<||d< tj|||}|S#t$r<}tj t j td|z|d}~wwxYw)Nr[rrrz*Unable to retrieve documentation from '%s'rM)r get_man_textrmr:r<r=r>r ) rrrrrrrr?r@s rArzDocCLI.format_plugin_doc7sl+ -O&L"J d&&sO[ID   d KK ,,. /KvVabc c ds/ A47A//A4ci}|jjD]}d}tt|j|d}d} t |}|t|j dd}|j||jz} tjD]/} | j| } | jr t | }1|rtj|d||rt|t sd} n |j#ddj%} | ||<|S#t $r }|}Yd}~d}~wwxYw#t $r }|}Yd}~d}~wwxYw)Nrrr=z' has a documentation formatting error: rrzINVALID SHORT DESCRIPTION)rrrrrrmr with_namesuffixrDOC_EXTENSIONS with_suffixrRr:r isinstancerrlr) rWrrrrrPdocerrorr@basebasefile extensiondocfilers rArz$DocCLI._get_plugin_list_descriptionsNsQll'') !FCIdll6&:1&=>?HH "8, {||C(,#--dX__.DE!"!1!1%I&229=G%">>+".w"7C %QWYa bcjd3%ww24OPVVX E&MA !D 7  %%#$%s0 D'.D?' D<0D77D<? EEEcg}|jdD]%}t|d}||vs|j|'tjj |S)z; Returns a string suitable for printing of the search path F)subdirsr|r}) _get_pathsrrIrOrrQ)finderretis rA print_pathszDocCLI.print_pathsusZ ""5"1 A"78A| 1  zzs##rfcFt||dtjdS)Nz'')default_flow_style default_styleDumperrD)rrrstrip)struct flow_styles rArzDocCLI._dump_yamls Jd[hippquvvrfc tjdj|jdDcgc]}||z c}Scc}w)NrD)rr rQr)r?indentlines rA _indent_lineszDocCLI._indent_liness5~~dii4::dCS(T4$(TUVV(Ts A c8|dk(rd}|dk(ry|r|d|}d|S)Nansible.builtin ansible-core historicalz of zversion rd)rrs rA_format_version_addedzDocCLI._format_version_addeds4 #'8 8'5 $ ,# #*79QRM,//rfc g}|jdD]U}tj||f|d|zz|dddd|}|r|jd|zr||d}|j ||}d}Wdj |S)Nz rFT)initial_indentsubsequent_indentbreak_on_hyphensbreak_long_wordsdrop_whitespacerrD)rtextwrapfillrrIrQ) r?limitr r  initial_extrakwargsr paragraphwrappeds rA warp_fillzDocCLI.warp_fillsF+ ImmIut^VY\iViEi~O5:UdhtlrtG!3!3C-4G!H!-.1 MM' ".NM yy  rfcb t|D]}t||}|jdd} t| tst d| zd} d} | r't jrd} || dt|dd } n%t jrd } || dt|d } d |vr t d |jddtt|t|z t|z dz} |dt|dzzz} | | z}t|d rt|d dD]\}}t|tst d|d|dt||dk(rI|j| t j#t j%||| |t| z|jt j#t j%||||n{t|d tst d|dt|d |j| t j#t j%|d || |t| z|d =g}dD])}||vs|j||j|f+| s |s d|vrd|d<i}dD]}||vs||s|j|Dcgc] }t|c}||<t j&D]W}||D]M}t(j*dkDr0d|vr,t j-|d|j/dd|d<||vsK||=OYd|vr`|dr[g|d<|dD]K}d|vr1|dj|d d!|d j1d"d zd#8|dj|M|d=|r:|jt j3t j5d$|i||jdd}|jd%d}t|D]}|j7d"rt||rC|jt j3|d&t j5||d'(|f|jt j3t j5|||i||r,|s*|j|d)t j-|||D]8\}}|j||d*t j9||||dz||:ycc}w)+NrequiredFz8Incorrect value for 'Required', a boolean is needed.: %s rrrrred-yellowrzCAll (sub-)options and return values must have a 'description' fieldrrrz"Expected string in description of z at index z, got )r r rr r )r4 suboptionscontainsspecr)enviniyamlvarsr#rrversion_added_collecitonradded_inclioptionrz--%sr>)rr'set_viar: T)rz added in: r)rHrpoprrr rrrrIrErr enumeraterrrrr IGNOREr:r3rrlrrrr add_fields)r?fieldsr opt_indent return_values base_indentmanooptr opt_leadinr inline_indent extra_indent sub_indent entry_idxrxrsubkeyconfconfigitemignorer&rrrsubdatas rAr-zDocCLI.add_fieldssc fAvay/Cwwz51Hh-"#]`h#hiiJC$$!$J#. GAvu>%;PRW3@T^nqr~n+;+A%AB F$4$4V^^E5JEblAK$4%LMM"#m"4lC&YZ\`aderas\t'uvv C&"2"26>>#mBT3UW\+8Jfijvfw#3#yyzM"JG AS=%%vswwv&?@ AMis6J!%IDC 1S=S[;>776?#K4DJ#KDL"(--1$(L1D&0014D9P393O3OPTUdPegkgogoqKM[h\4]Z 0%~$(L 11 1|E  U u:0Cs*U **CK6TWX^T_TgTghkmpTqKq+rsU **3/ 0 J F001B1BItCT1UWabc GGOT:M'*ww/I4'P $C[ b<<$s1v&KK 4 4FDUDUVYZ[V\imDUDn5oq{ |}KK 4 4V5F5F3q6{5SU_ `a bS F ROLE: r- (rPrLrrrz- %sz ENTRY POINT: rrrrr4Optionsr (%s indicates it is required):rr attributesFz The role z's argument spec z contains the key "attributes", which will not be displayed by ansible-doc in the future. This was unintentionally allowed when plugin attributes were added, but the feature does not map well to role argument specs.z2.20r)versionr ATTRIBUTES:rUr2)authorr)rr rr EXAMPLES:rr Unable to parse examples sectionrMN)r:rFrEintrIrrlrrVrrr rrr-r*rOrrrrrrtuplerQrrrmr ) rWr"r_r?r/padrrrrrrr@s rAr^zDocCLI.get_role_man_text sr! oo$GOOc#h.3 v)> f@UVW$^4? aKN+K8CDww*+) KKO KK V0LdS T KKOww}%c-0$7 .E /0E!ODKKv'7'7t8LednCM'7(N!NOO Bwwy! GIv69Zefevev^a}B:CCD!!$ (:E:Nww|U+""v%7 }EPP#$5 # B GM6:;\*//1kAKKOKK 0 0PQ S^@_1`bgjkbk}GCM!1!OPKK 4 4V5F5Fsz}|jtjtj!tA||d/z |d:z|Bd?| vrod@| vrj| d@dAvrdBnd}|jtjtj!| d@jC|d| d?|d/z |dd2d3z|| j'd }|%| d?j=d8rdC| d?d| d@|d<}|D|jtjtj!||d/z |d:z|d:z| d?j=d8sJdD| d?j?ddE| d@dF}|jtjtj!tA||d/z |d:z|dG| vrdH| vrd | vr|jtjtj!| dG|d/z |dd2d3z||jtjtj!| d |d/z |d:z|d:z|jtjtj!| dH|d/z |d:z|d:zdI| vsd | vs|jtjtj!dJ| dIz|d/z |dd2d3z||jtjtj!| d |d/z |d:z|d:z|jtjtj!tAdK| dIz|d/z |d:z|d:z|d4=|j'dLdr|jddMjE|jdL}|jtdNd dOtjtj!||dPz d|zztG|D]@} || r| tjvr|jdt| jd }t|| tHrR|j|dQtjtj!|| |tK| d>zz |Rnt|| ttLfr)|j|dQdMjE|| nP|jdS|ztj9tj;|| dtK| d>zzz|| =C|j'dTdr|jd|jtdUd t|dTtHr/|j|jdTjOn- |jtQ|jdTd>dV|j'dXdrg|jd|jtdYd tj5||jdX||dt j"dk(Z|jd[d[jE|S#t.$r} t1d| d} ~ wwxYw#tR$r} tUdW| d} ~ wwxYw)\Nrz rrArBz> rrrrCrPrLrrrrrrrrr%rOFz DEPRECATED: r7removed_at_daterG removed_in Tz+Invalid deprecation documentation structurerMrrz * note:z/ This module has a corresponding action plugin.r4OPTIONSrErr)r2rFrHrUr2rInoteszNOTES:z* seealsoz SEE ALSO:r+z Module %srCz,The official documentation on the %s module.z zcollections/%s_module.htmlrrrrr)r+r"rz"The official documentation on the z collections/r>z.htmlrlinkrefzAnsible documentation [%s]z/#stq=%s&stp=1 requirementsrz REQUIREMENTS:z%s r)rKz%s: rrLrMrNrzRETURN VALUES:)r0r2rD)+rrr,rrGr:rFrErOrIrrr*rrVrr r3rrlrr<get_deprecated_msg_from_configrr rr-rrrrrr!titlerQrHrrrPrrrmr )rrrr/r1r?rQrrrr@rnoter=r relative_urlrreqheaders rArzDocCLI.get_man_text^sE 3i )@(BB   oo$GOOc#h.3 k&7&7&97377=CY[a;bdgdkdklvdwxy c-($ /GGM*EWW]+,E B BD KK(()=uU`t(A B B   q $::377?T`;acfcjcjlFHVdWXC O 77< ' KK> ?#l+T2$C ,==)sS_O`B`eqy|~JzKfK69,6G 6RC %l3bKKqxx'N'NsS_O`bf'g gh D3|#445L! 77< ' KKO KK V47hh i 779e $ KKO KK 625VabararZ]x}5~~    dCGGI$6zPWPaPaefPf  h 77< ' KKO KK v6 7&++- g B F,,V^^GEAI{<[-\^cfg^gyC?I-KL F001B1B3|CTUVCW1XZdef  g L! 777E " KKO KK&1 2G  s F,,V^^D-A519Pdnqvdv%5%xyH~001CD'Cd8nF\F\]`beghFi'i  F$4$4V^^DYZfDg5h$)AIj5>Pdn%5%pq%-4*?15m1DL^1^IdfMKK 0 0TR_M`MfMfMhjwy}GzHAI2J % *Sb/D:Pdn!1!pq"&((="9K"*tH~/H/HI[/\VZ[cVdfjkxfy|I'J ". F$4$4V^^K5P$)AIj5>Pdnqvdv%5%xyH~001CDCG>CYCYZ]_bdeCfhlmzh{'|  F$4$4V^^DYZfDg5h$)AIj5>Pdn%5%pqt^$=D;PKK 0 0V 1M % *Sb/D:Pdn!1!pqKK 0 0]@S1T % *u:L`jmr`r!1!tuKK 0 0V 1M % *u:L`jmr`r!1!tud]}'<KK 0 0@\_cdi_j@j1k % *Sb/D:Pdn!1!pqKK 0 0]@S1T % *u:L`jmr`r!1!tuKK 0 0@UVfimnsitVt@u1v % *u:L`jmr`r!1!tuQ) uVI 77>5 ) KKO))CGGN34C KK86FDTDTU[UcUcdgUhjortjtFJ*4EUE6<66 7 Aq6Q&--/ KKOQWWY/F#a&,/ 0@0@PSTUPVAWY^befgbhklblYmBL0@1MNOCFT5M2  #a&0ABC FVOf.B.B6CTCTUXYZU[C\^aehijeknoeo^p.qqrA  77?E * KKO KK V4 5#o. = CGGO4::<=]KK #''/*B1af gh 77< ' KKO KK 0&9 :   dCGGL$95*\`gngxgx|}g}   Dyyo b&'T_`aab\!],-OZ[\\]s05r#,s# r>, r99r> s ss)FT)Fr)rrr)FrF)rr)@rrrrrr,r compilerrrrrrrr_SEM_PARAMETER_STRINGrrrrrrrrrrrr r staticmethodrr classmethodr r$r2rRr\r`rerrrrrrrrrrrrrrrrrrrr-r^r __classcell__)rs@rArrsYV DVF bjj*+G BJJ( )Ebjj*+Gbjj45G BJJ2 3E 2::' (D 2::1 2D RZZ) *F5!rzz&+@"@A" 6,A#AB" 6,A#ABRZZ*? ?@N RZZ- .F 8$I%2::&NON <(I2::o.LJ'J bjj.O! 8B4nl-&^ &D& JJAAF ()V"$jX&&  6   c c&,%N $ $wwWW00 ! !efefNSjWWrfrc g}tj|d}|jd}|r)|jd|z|jd|zn3|jd|jd|jdzd}d j |d z}t j |z }t|d jD]}|d |}t|d trtj|d } n'tjd j|d } |jdd} t| tstd| zd|z}|r6| rd| z} |jd|ddtj| ||| rd} n|jdd} |j|d | ddtj| ||d|S)Nrr+z - name: %sz %s:z# %s:rr# rr4rrrF7Incorrect value for 'Required', a boolean is needed: %srUz (required) %sz 20z # rKz (required)rNone9z # r)r  max_lines)rr rlrIrjustr:rFrHrrrrQrrr) rr?mdescr+rQsubdentrr3r4rrrs rArrs D NN323 4E WWX F  LE*+ Gv&' Gcggh@@A Cjjq!G OOc !E C N'') *~)nQ c-(, 7>>#m"45D>>#((3}+=">?D77:u-(D)VYaab b AI &- KK63C3CD%cj3C3kl m&'')V4 KK!Wf6F6FtUfmyz6F6{| }-~0 Krfc g}d|jd|jdz}g}t|djD]}|d|}|jd|d|jddd |jd d |d vr |d |zz }R|jdd}t |t st d|z|rd}n|jdd}|jddvr |d|d|dz }|d|d|z }|dz }|r"|j||jd |j||S)Nz lookup('%s', rrr4rk(rrrhrr)_terms_raw_listz< %s >rFrlz rrn)rstrrz='rrrL)rlrHrrIrrrrJ)rr?snippetcommentr3r4rrs rArr&sE D#''&/ BBGG C N'') *0)nQCGGFH,Esww}^`Gabc + + x1~ %G 77:u-(D)VYaab b "Gggi0G 776?/ / a1 1G Aw/ /G+0. sNG G BKK Krfc.tj|yr)r cli_executor)rs rArErELs rf__main__r)Z __future__r ansible.clirryrbrOos.pathr rr=ansible.plugins.loaderrrrpathlibrr?rrransible.cli.argumentsrr%ansible.collections.listr ansible.errorsr r r r +ansible.module_utils.common.text.convertersrr'ansible.module_utils.common.collectionsr ansible.module_utils.common.jsonr ansible.module_utils.common.yamlransible.module_utils.sixransible.parsing.plugin_docsransible.parsing.utils.yamlransible.parsing.yaml.dumperransible.plugins.listrrransible.utils.collection_loaderrr2ansible.utils.collection_loader._collection_finderransible.utils.colorransible.utils.displayransible.utils.plugin_docsrr r!r:rr*rvrwr/rrCOLOR_DOC_MODULECOLOR_DOC_REFERENCECOLOR_DOC_LINKCOLOR_DOC_DEPRECATEDCOLOR_DOC_CONSTANTCOLOR_DOC_PLUGINrrBobjectrDrrrrrrErrdrfrArs_#  .."<9ggJ?661405-AY]')[[ )''*>> 9  ,           ! !$$    Fttn 2CS)CL"*Z#L zFrf