$gPdZddlmZddlZddlZddlmZddlmZm Z m Z m Z m Z m Z mZmZmZmZddlmZmZddlmZmZddlmZdd lmZdd lmZdd lmZdd l m!Z!m"Z"m#Z#m$Z$m%Z%dd l&m'Z'ddl(m)Z)ej*dkrddl+m,Z,nddl-m,Z,erddlm.Z.e Z/Gdde0Z1Gdde0Z2d!d"dZ3GddZ4Gdd Z5dS)#z\Base module for handlers. This module contains the base classes for implementing handlers. ) annotationsN)Path) TYPE_CHECKINGAnyBinaryIOClassVarIterableIteratorMappingMutableMappingSequencecast)Elementtostring) EnvironmentFileSystemLoader)Markdown)TocTreeprocessor)Markup)AutorefsInlineProcessor)HeadingShiftingTreeprocessor HighlighterIdPrependingTreeprocessorMkdocstringsInnerExtensionParagraphStrippingTreeprocessor) Inventory)get_template_logger)  entry_points)AutorefsHookInterfaceceZdZdZdS)CollectionErrorz8An exception raised when some collection of data failed.N__name__ __module__ __qualname____doc__Z/var/www/html/netbox-4.1.3/venv/lib/python3.11/site-packages/mkdocstrings/handlers/base.pyr$r$*sBBBBr+r$ceZdZdZdS)ThemeNotSupportedz5An exception raised to tell a theme is not supported.Nr%r*r+r,r.r..s????r+r.seqr attribute str | Nonereturnboolc\t|Stfd|DS)aXCheck if at least one of the item in the sequence evaluates to true. The `any` builtin as a filter for Jinja templates. Arguments: seq: An iterable object. attribute: The attribute name to use on each object of the iterable. Returns: A boolean telling if any object of the iterable evaluated to True. Nc3(K|] }|V dSNr*).0_r0s r, zdo_any..@s'))q|))))))r+)any)r/r0s `r,do_anyr;2s93xx ))))S))) ) ))r+ceZdZUdZdZded< dZded< dZded < iZd ed < dZ ded < dZ dDdEdZ e dDdFdZ dGd!ZdHd$ZdId%ZdDdJd'ZdKd)ZdLd+Z dMdd d,dNd5Zd dd d6dOd<ZdPd>ZdQdBZdQdCZd S)R BaseHandleraThe base handler class. Inherit from this class to implement a handler. You will have to implement the `collect` and `render` methods. You can also implement the `teardown` method, and override the `update_env` method, to add more filters to the Jinja environment, making them available in your Jinja templates. To define a fallback theme, add a `fallback_theme` class-variable. To add custom CSS, add an `extra_css` variable or create an 'style.css' file beside the templates. strnamedefaultdomainFr3enable_inventoryzClassVar[dict]fallback_configfallback_themeNhandlerthemecustom_templatesr1r2Nonecg}||}|||z ||}|D]}|||z |jrJ|j|kr?|||jz |D]}|||jz  |D]D}|dz } | r)|xjd| dzz c_nE|)|dt||z |z tdt|d |_ t|j j d <t|j|j jd <g|_d|_dS) aqInitialize the object. If the given theme is not supported (it does not exist), it will look for a `fallback_theme` attribute in `self` to use as a fallback theme. Arguments: handler: The name of the handler. theme: The name of theme to use. custom_templates: Directory containing custom templates. z style.css zutf-8encodingNrTF) autoescapeloader auto_reloadr:log)get_templates_dirappendget_extended_templates_dirsrEis_file extra_css read_textinsertrrrenvr;filtersrr@globals _headings_md) selfrFrGrHpaths themes_dirextended_templates_dirs templates_dirpathcss_paths r,__init__zBaseHandler.__init___s++G44  Z%'(((#'"B"B7"K"K4 0 0M LL. / / / /   B4#6%#?#? LLd&99 : : :"9 B B  ]T-@@AAAA  Dk)H!! $););W);)M)M"MM   ' LLD!122Wz;BaseHandler.get_extended_templates_dirs..s+JJJy   ""JJJr+r )r^rFdiscovered_extensionss r,rTz'BaseHandler.get_extended_templates_dirss6!-3V73V3V3V W W WJJ4IJJJJr+tuple[str, ...]cdS)zReturn the possible identifiers (HTML anchors) for a collected item. Arguments: data: The collected data. Returns: The HTML anchors (without '#'), or an empty tuple if this item doesn't have an anchor. r*r*)r^rvs r, get_anchorszBaseHandler.get_anchorss rr+)strip_paragraph autoref_hooktext heading_levelinthtml_idrrAutorefsHookInterface | NonercJ|jj}||tj_|o|dz|t j_||tj_|r!||jj tj_ t|j |d|tj_d|t j_d|tj_d|jj tj_ |jS#d|tj_d|t j_d|tj_d|jj tj_ |jwxYw)aRender Markdown text; for use inside templates. Arguments: text: The text to convert. heading_level: The base heading level to start all Markdown headings from. html_id: The HTML id of the element that's considered the parent of this element. strip_paragraph: Whether to exclude the

tag from around the whole output. Returns: An HTML string. z--rr>FN)r]treeprocessorsrr@shift_byr id_prefixrstripinlinePatternsrhookrconvertreset)r^rrrrrrs r,do_convert_markdownzBaseHandler.do_convert_markdownsN(0ER389BCJC]wY]~056@ET6;<B  VIUDH #$;$@ A F $(**40011IJN7< = FGIN49 : DINN:? @ FIMDH #$;$@ A F HNN     JKN7< = FGIN49 : DINN:? @ FIMDH #$;$@ A F HNN    s ;&D!!BF")rolehidden toc_labelcontentrrr attributesc ^td||}|+t|tr|n|}|d||r|d||j||r(td|dStd||}|tdtt|j j d}|j r| ||d|jr|||dt!|d } | d d ks Jd | | d |} t| S)afRender an HTML heading and register it for the table of contents. For use inside templates. Arguments: content: The HTML within the heading. heading_level: The level of heading (e.g. 3 -> `h3`). role: An optional role for the object bound to this heading. hidden: If True, only register it for the table of contents, don't render anything. toc_label: The title to use in the table of contents ('data-toc-label' attribute). **attributes: Any extra HTML attributes of the heading. Returns: An HTML string. hNzdata-toc-labelz data-rolezidzmkdocstrings-placeholdertocunicoderLzz*Bug in mkdocstrings: failed to replace in )r isinstancerunescapesetr\rSformatrrr]r use_anchors add_anchoruse_permalinks add_permalinkrcountreplace) r^rrrrrrelrhtml_with_placeholderhtmls r, do_headingzBaseHandler.do_heading"sB(((* 5 5  .8&.I.IV((***wI +++  & FF; % % % b!!!  G,--44Z5EFF F(((* 5 5 '455666#TX%) rr?rrrr?rr3rrr2r)rrrrrr1rr3rr1rr?r2r)r2r)rrrorr2rI)r&r'r(r)r@__annotations__rBrCrDrErVre classmethodrmruryr|rRrTrrrrrrr*r+r,r=r=Cs  DNNNN3F\"""""4&(O((((HNTI0"0"0"0"0"d $ [(""""" " " " "    ZZZZZ8 K K K K     # !&59######T  $??????B 6 6 6 6 ( ( ( ( ( (r+r=c\eZdZdZddZdd Zdd Zdd ZdddZe ddZ ddZ dS)Handlersa A collection of handlers. Do not instantiate this directly. [The plugin][mkdocstrings.plugin.MkdocstringsPlugin] will keep one instance of this for the purpose of caching. Use [mkdocstrings.plugin.MkdocstringsPlugin.get_handler][] for convenient access. rorr2rIcn||_i|_t|jdd|_dS)aInitialize the object. Arguments: config: Configuration options for `mkdocs` and `mkdocstrings`, read from `mkdocs.yml`. See the source code of [mkdocstrings.plugin.MkdocstringsPlugin.on_config][] to see what's in this dictionary. mkdocs site_name)projectN)_config _handlersr inventory)r^ros r,rezHandlers.__init__s4 13$-dl86L[6Y$Z$Z$Zr+rnr?rc|jD]T}t|di} ||||}n#t $rYJwxYw|r|cSUdS)aReturn the canonical HTML anchor for the identifier, if any of the seen handlers can collect it. Arguments: identifier: The identifier (one that [collect][mkdocstrings.handlers.base.BaseHandler.collect] can accept). Returns: A tuple of strings - anchors without '#', or an empty tuple if there isn't any identifier familiar with it. rDr*)rvaluesgetattrrrur$)r^rnrFrDanchorss r,rzHandlers.get_anchorss~,,..  G%g/@"EEO !--gooj/.Z.Z[["      rs)A A%$A%cD|jd}d|vr|dS|dS)a-Return the handler name defined in an "autodoc" instruction YAML configuration, or the global default handler. Arguments: config: A configuration dictionary, obtained from YAML below the "autodoc" instruction. Returns: The name of the handler to use. mkdocstringsrFdefault_handler)r)r^ro global_configs r,get_handler_namezHandlers.get_handler_names2 ^4   )$ $.//r+r@cx|jddi}|r||iSiS)a Return the global configuration of the given handler. Arguments: name: The name of the handler to get the global configuration of. Returns: The global configuration of the given handler. It can be an empty dictionary. rhandlers)rget)r^r@rs r,get_handler_configzHandlers.get_handler_configsA</33JCC  *<<b)) ) r+Nhandler_config dict | Noner=cJ||jvr|||}||jt jd|}|jd |jd|jdd|jddd||j|<|j|S) a)Get a handler thanks to its name. This function dynamically imports a module named "mkdocstrings.handlers.NAME", calls its `get_handler` method to get an instance of a handler, and caches it in dictionary. It means that during one run (for each reload when serving, or once when building), a handler is instantiated only once, and reused for each "autodoc" instruction asking for it. Arguments: name: The name of the handler. Really, it's the name of the Python module holding it. handler_config: Configuration passed to the handler. Returns: An instance of a subclass of [`BaseHandler`][mkdocstrings.handlers.base.BaseHandler], as instantiated by the `get_handler` method of the handler's module. Nzmkdocstrings_handlers. theme_namerrHrconfig_file_path)rGrHrr*)rrupdater importlib import_module get_handler)r^r@rmodules r,rzHandlers.get_handlers t~ % %%!%!8!8!>!>  ! !$, / / /,-Ld-L-LMMF#56#5$l<0!%n!=>P!Q!%h!78J!K$$! $$DN4 ~d##r+Iterable[BaseHandler]c4|jS)zGet the handlers that were encountered so far throughout the build. Returns: An iterable of instances of [`BaseHandler`][mkdocstrings.handlers.base.BaseHandler] (usable only to loop through it). )rrr{s r, seen_handlerszHandlers.seen_handlerss~$$&&&r+ct|jD]}||jdS)z1Teardown all cached handlers and clear the cache.N)rr|rr)r^rFs r,r|zHandlers.teardownsC)  G        r+)rorr2rI)rnr?r2r)rorr2r?)r@r?r2rr6)r@r?rrr2r=)r2rr) r&r'r(r)rerrrrpropertyrr|r*r+r,rrs [ [ [ [& 0 0 0 0    $$$$$:'''X'r+rr6)r/r r0r1r2r3)6r) __future__rrsyspathlibrtypingrrrrr r r r r rxml.etree.ElementTreerrjinja2rrmarkdownrmarkdown.extensions.tocr markupsafermkdocs_autorefs.referencesrmkdocstrings.handlers.renderingrrrrrmkdocstrings.inventoryrmkdocstrings.loggersr version_infoimportlib_metadatar!importlib.metadatar"rq Exceptionr$r.r;r=rr*r+r,r s #""""" vvvvvvvvvvvvvvvvvvvvvvvv3333333300000000444444>>>>>>-,,,,,444444g/////////////A@@@@@@ CCCCCiCCC@@@@@ @@@*****"@(@(@(@(@(@(@(@(F llllllllllr+