2yibvdZddlmZddlZddlZddlmZmZmZm Z m Z m Z m Z m Z ejdk\r ddlmZmZnddlmZmZerddlZddlmZddlmZmZmZmZmZer$dd lmZdd lm Z dd l!m"Z"dd l#m$Z$dd l%m&Z&ddl'm(Z(er ddl)m*Z*m+Z+ne Z+e+dZ,e dZ-ej\dZ/d"dZ0e deZ1Gdde e1Z2e3de2jhDZ5e5D]Z6e7e2de6zd#dZ8Gdde e,e-fZ9Gdde:e e;e2fZ<Gdd ejzZ>d$d!Z?y)%z%Implements the plugin API for MkDocs.) annotationsN) TYPE_CHECKINGAnyCallableGenericLiteralMutableMappingTypeVaroverload) ) EntryPoint entry_points)utils)Config ConfigErrorsConfigWarnings LegacyConfigPlainConfigSchema) MkDocsConfig)LiveReloadServer)Files) Navigation)Page)TemplateContext) Concatenate ParamSpecPTmkdocs.pluginsctd}i}|D];}|j|vr|jjdr-|||j<=|S)z=Return a dict of all installed Plugins as {name: EntryPoint}.r )groupzmkdocs.contrib.)rnamevalue startswith)plugins pluginmapplugins P/var/www/html/content_weaver/venv/lib/python3.12/site-packages/mkdocs/plugins.py get_pluginsr*(sZ!12GI( ;;) # (?(?@Q(R !' &++ (  SomeConfig)boundceZdZUdZeZded<dZded<iZded<d Z d ed < d#d Z d Z d$ d%dZ d&dZ d'dZ d(dZd)dZd*dZd+dZ d,dZ d-dZd*dZd.dZ d/dZ d0dZ d1dZd2dZd3dZ d4dZ d5d Z d6d!Zd7d"Zy)8 BasePluginzI Plugin base class. All plugins should subclass this class. ztype[SomeConfig] config_classr config_schemer,configFboolsupports_multiple_instancescj|jd|jd}t||ft|S)z_Eliminates the need to write `config_class = FooConfig` when subclassing BasePlugin[FooConfig].[])r0)__name__typedict)clsr0r#s r)__class_getitem__zBasePlugin.__class_getitem__Hs5,,q!6!6 7q9D3&$L"ABBr+ct|jtstd|jd|jtur|jj |_yy)Nz config_class z2 must be a subclass of `mkdocs.config.base.Config`) issubclassr0r TypeErrorr_schemar2)r<s r)__init_subclass__zBasePlugin.__init_subclass__Ms\#**F3 0 011cd    < / # 0 0 8 8C  0r+Nc|jturt|j||_n|j||_|jj ||jj S)zJLoad config from a dict of options. Returns a tuple of (errors, warnings).)config_file_path)r0rr2r3 load_dictvalidate)selfoptionsrDs r) load_configzBasePlugin.load_configUsb    ,&t'9'9L\]DK++=M+NDK g&{{##%%r+cy)a The `startup` event runs once at the very beginning of an `mkdocs` invocation. New in MkDocs 1.4. The presence of an `on_startup` method (even if empty) migrates the plugin to the new system where the plugin object is kept across builds within one `mkdocs serve`. Note that for initializing variables, the `__init__` method is still preferred. For initializing per-build variables (and whenever in doubt), use the `on_config` event. Args: command: the command that MkDocs was invoked with, e.g. "serve" for `mkdocs serve`. dirty: whether `--dirty` flag was passed. Nr1rGcommanddirtys r) on_startupzBasePlugin.on_startupdr+cy)a The `shutdown` event runs once at the very end of an `mkdocs` invocation, before exiting. This event is relevant only for support of `mkdocs serve`, otherwise within a single build it's undistinguishable from `on_post_build`. New in MkDocs 1.4. The presence of an `on_shutdown` method (even if empty) migrates the plugin to the new system where the plugin object is kept across builds within one `mkdocs serve`. Note the `on_post_build` method is still preferred for cleanups, when possible, as it has a much higher chance of actually triggering. `on_shutdown` is "best effort" because it relies on detecting a graceful shutdown of MkDocs. Nr1rGs r) on_shutdownzBasePlugin.on_shutdownurOr+c|S)av The `serve` event is only called when the `serve` command is used during development. It runs only once, after the first build finishes. It is passed the `Server` instance which can be modified before it is activated. For example, additional files or directories could be added to the list of "watched" files for auto-reloading. Args: server: `livereload.Server` instance config: global configuration object builder: a callable which gets passed to each call to `server.watch` Returns: `livereload.Server` instance r1rGserverr3builders r)on_servezBasePlugin.on_serves $ r+c|S)aP The `config` event is the first event called on build and is run immediately after the user configuration is loaded and validated. Any alterations to the config should be made here. Args: config: global configuration object Returns: global configuration object r1rGr3s r) on_configzBasePlugin.on_configs  r+cy)z The `pre_build` event does not alter any variables. Use this event to call pre-build scripts. Args: config: global configuration object Nr1rYs r) on_pre_buildzBasePlugin.on_pre_buildrOr+c|S)a The `files` event is called after the files collection is populated from the `docs_dir`. Use this event to add, remove, or alter files in the collection. Note that Page objects have not yet been associated with the file objects in the collection. Use [Page Events](plugins.md#page-events) to manipulate page specific data. Args: files: global files collection config: global configuration object Returns: global files collection r1rGfilesr3s r)on_fileszBasePlugin.on_filess  r+c|S)aQ The `nav` event is called after the site navigation is created and can be used to alter the site navigation. Args: nav: global navigation object config: global configuration object files: global files collection Returns: global navigation object r1rGnavr3r_s r)on_navzBasePlugin.on_navs  r+c|S)a The `env` event is called after the Jinja template environment is created and can be used to alter the [Jinja environment](https://jinja.palletsprojects.com/en/latest/api/#jinja2.Environment). Args: env: global Jinja environment config: global configuration object files: global files collection Returns: global Jinja Environment r1rGenvr3r_s r)on_envzBasePlugin.on_envs  r+cy)z The `post_build` event does not alter any variables. Use this event to call post-build scripts. Args: config: global configuration object Nr1rYs r) on_post_buildzBasePlugin.on_post_buildrOr+cy)a The `build_error` event is called after an exception of any kind is caught by MkDocs during the build process. Use this event to clean things up before MkDocs terminates. Note that any other events which were scheduled to run after the error will have been skipped. See [Handling Errors](plugins.md#handling-errors) for more details. Args: error: exception raised Nr1rGerrors r)on_build_errorzBasePlugin.on_build_errorrOr+c|S)a The `pre_template` event is called immediately after the subject template is loaded and can be used to alter the template. Args: template: a Jinja2 [Template](https://jinja.palletsprojects.com/en/latest/api/#jinja2.Template) object template_name: string filename of template config: global configuration object Returns: a Jinja2 [Template](https://jinja.palletsprojects.com/en/latest/api/#jinja2.Template) object r1rGtemplate template_namer3s r)on_pre_templatezBasePlugin.on_pre_templates r+c|S)a The `template_context` event is called immediately after the context is created for the subject template and can be used to alter the context for that specific template only. Args: context: dict of template context variables template_name: string filename of template config: global configuration object Returns: dict of template context variables r1rGcontextrrr3s r)on_template_contextzBasePlugin.on_template_context r+c|S)a The `post_template` event is called after the template is rendered, but before it is written to disc and can be used to alter the output of the template. If an empty string is returned, the template is skipped and nothing is is written to disc. Args: output_content: output of rendered template as string template_name: string filename of template config: global configuration object Returns: output of rendered template as string r1rGoutput_contentrrr3s r)on_post_templatezBasePlugin.on_post_template!s "r+c|S)a The `pre_page` event is called before any actions are taken on the subject page and can be used to alter the `Page` instance. Args: page: `mkdocs.structure.pages.Page` instance config: global configuration object files: global files collection Returns: `mkdocs.structure.pages.Page` instance r1rGpager3r_s r) on_pre_pagezBasePlugin.on_pre_page6s  r+cy)a > DEPRECATED: Instead of this event, prefer one of these alternatives: > > * Since MkDocs 1.6, instead set `content_bytes`/`content_string` of a `File` inside [`on_files`][]. > * Usually (although it's not an exact alternative), `on_page_markdown` can serve the same purpose. The `on_page_read_source` event can replace the default mechanism to read the contents of a page's source from the filesystem. Args: page: `mkdocs.structure.pages.Page` instance config: global configuration object Returns: The raw source for a page as unicode string. If `None` is returned, the default loading from a file will be performed. Nr1rGrr3s r)on_page_read_sourcezBasePlugin.on_page_read_sourceEs$r+c|S)a The `page_markdown` event is called after the page's markdown is loaded from file and can be used to alter the Markdown source text. The meta- data has been stripped off and is available as `page.meta` at this point. Args: markdown: Markdown source text of page as string page: `mkdocs.structure.pages.Page` instance config: global configuration object files: global files collection Returns: Markdown source text of page as string r1rGmarkdownrr3r_s r)on_page_markdownzBasePlugin.on_page_markdownYs "r+c|S)a The `page_content` event is called after the Markdown text is rendered to HTML (but before being passed to a template) and can be used to alter the HTML body of the page. Args: html: HTML rendered from Markdown source as string page: `mkdocs.structure.pages.Page` instance config: global configuration object files: global files collection Returns: HTML rendered from Markdown source as string r1rGhtmlrr3r_s r)on_page_contentzBasePlugin.on_page_contentls " r+c|S)a The `page_context` event is called after the context for a page is created and can be used to alter the context for that specific page only. Args: context: dict of template context variables page: `mkdocs.structure.pages.Page` instance config: global configuration object nav: global navigation object Returns: dict of template context variables r1rGrvrr3rcs r)on_page_contextzBasePlugin.on_page_contextrxr+c|S)a The `post_page` event is called after the template is rendered, but before it is written to disc and can be used to alter the output of the page. If an empty string is returned, the page is skipped and nothing is written to disc. Args: output: output of rendered template as string page: `mkdocs.structure.pages.Page` instance config: global configuration object Returns: output of rendered template as string r1rGoutputrr3s r) on_post_pagezBasePlugin.on_post_pages  r+)r0z type[Config]N)rHzdict[str, Any]rD str | Nonereturnz#tuple[ConfigErrors, ConfigWarnings]rLz&Literal['build', 'gh-deploy', 'serve']rMr4rNonerr)rUrr3rrVrrzLiveReloadServer | None)r3rrzMkDocsConfig | Noner3rrr)r_rr3rrz Files | None)rcrr3rr_rrzNavigation | None)rgjinja2.Environmentr3rr_rrzjinja2.Environment | Nonerm Exceptionrr)rqjinja2.Templaterrstrr3rrzjinja2.Template | None)rvrrrrr3rrTemplateContext | None)r{rrrrr3rrr)rrr3rr_rrz Page | Nonerrr3rrr) rrrrr3rr_rrr) rrrrr3rr_rrr) rvrrrr3rrcrrr)rrrrr3rrr) r9 __module__ __qualname____doc__rr0__annotations__r2r3r5r=rBrIrNrRrWrZr\r`rdrhrjrnrsrwr|rrrrrrr1r+r)r/r/:s &2L"1')M$)FJ(--aC 9GK &% &9C & , & " "&6BMU ,  "-9BG "%5AJO "$   '>AKW "&=@JV $!8;EQ * ()-7CLQ &%)3?HM &&48BNU_ $r+r/c#JK|]}|jds|ddyw)on_r Nr%).0ks r) rs!IQ\\%5HquIs# #rcfd}|S)a A decorator to set an event priority for an event handler method. Recommended priority values: `100` "first", `50` "early", `0` "default", `-50` "late", `-100` "last". As different plugins discover more precise relations to each other, the values should be further tweaked. Usage example: ```python @plugins.event_priority(-100) # Wishing to run this after all other plugins' `on_files` events. def on_files(self, files, config, **kwargs): ... ``` New in MkDocs 1.4. Recommended shim for backwards compatibility: ```python try: from mkdocs.plugins import event_priority except ImportError: event_priority = lambda priority: lambda f: f # No-op fallback ``` c|_|Sr)mkdocs_priority) event_methodprioritys r) decoratorz!event_priority..decorators'/ $r+r1)rrs` r)event_priorityrs6 r+c(eZdZdZddZddZddZy) CombinedEventa` A descriptor that allows defining multiple event handlers and declaring them under one event's name. Usage example: ```python @plugins.event_priority(100) def _on_page_markdown_1(self, markdown: str, **kwargs): ... @plugins.event_priority(-50) def _on_page_markdown_2(self, markdown: str, **kwargs): ... on_page_markdown = plugins.CombinedEvent(_on_page_markdown_1, _on_page_markdown_2) ``` NOTE: The names of the sub-methods **can't** start with `on_`; instead they can start with `_on_` like in the the above example, or anything else. c||_yr)methods)rGrs r)__init__zCombinedEvent.__init__s  r+cDtt|jd)Nz object is not callable)r@r:r9)rGinstanceargskwargss r)__call__zCombinedEvent.__call__s 4:..11HIJJr+Nc>tfd|jDS)Nc3BK|]}|jywr)__get__)rfrowners r)rz(CombinedEvent.__get__..sPaqyy59Ps)rr)rGrrs ``r)rzCombinedEvent.__get__sP4<<PQQr+)rz Callable[Concatenate[Any, P], T])rr/rzP.argsrzP.kwargsrrr)r9rrrrrrr1r+r)rrs*KRr+rceZdZUdZded<dfd Z d d dZd!fd Zd"fd Ze d#dZ e d$d Z dd%d Z d&d Z dd Z d'd Z d(dZd)dZd*dZd+dZd,dZd)dZd-dZ d.dZ d/dZ d0dZd1dZd2dZ d3dZd4dZ d5dZd6dZxZS)7PluginCollectionz A collection of plugins. In addition to being a dict of Plugin instances, each event method is registered upon being added. All registered methods for a given event can then be run in order by calling `run_event`. r_current_plugincpt||i|tDcic]}|gc}|_i|_ycc}wr)superrEVENTSevents_event_origins)rGrrr __class__s r)rzPluginCollection.__init__s9 $)&)AG1HA!R%1H 352Is 3ct|tr&|jD]}|j|||y |j|}|dk(r^t |dk(rP|j jtt|d}|xsd}tjd|d|dtj||d |r ||j |<y y #t$rYy wxYw) zRegister a method for an event. plugin_namepage_read_source zBMultiple 'on_page_read_source' handlers can't work (both plugins 'z' and 'z' registered one).ct|dd S)Nrr)getattr)ms r)z2PluginCollection._register_event.. sCTVW8X7Xr+)keyN) isinstancerr_register_eventrlenrgetnextiterlogwarningrinsortr@)rG event_namemethodrsubrplugin1plugin2s r)rz PluginCollection._register_events fm ,~~ O$$Z+$N O[[,F//CK14D--11$tF|2DkR%4 &&-YggY>PR LL-X Y2=D''/!sC C"!C"c"t||Sr)r __getitem__)rGrrs r)rzPluginCollection.__getitem__sw"3''r+ct|||dt|DD]2}t||d}t |s|j |dd||4y)Nc3DK|]}|jds|yw)rNr)rxs r)rz/PluginCollection.__setitem__..sHALL4G1Hs  r r)r __setitem__dirrcallabler)rGrr$rrrs r)rzPluginCollection.__setitem__s] C'Hc%jH NJUJ5F$$Z^V$M Nr+c yrr1)rGr#rs r) run_eventzPluginCollection.run_event r+c yrr1)rGr#itemrs r)rzPluginCollection.run_event#rr+c N|du}|j|D]}|jj|d|_tj t jkr&tjd|d|jd|r ||fi|}n|di|}||}d|_|S)a[ Run all registered methods of an event. `item` is the object to be modified or replaced and returned by the event method. If it isn't given the event method creates a new object to be returned. All other keywords are variables for context, but would not generally be modified by the event method. Nrz Running `z` event from plugin ''r1) rrrrrgetEffectiveLevelloggingDEBUGdebug)rGr#rr pass_itemrresults r)rzPluginCollection.run_event's$ kk$' F#'#6#6#:#:6;#OD $$&'--7 IdV+@AUAU@VVWXY//)&)!  $ r+c*|jd||S)Nstartup)rLrMrrKs r)rNzPluginCollection.on_startup?s~~i~FFr+c$|jdS)NshutdownrrQs r)rRzPluginCollection.on_shutdownBs~~j))r+c,|jd|||S)Nserve)r3rVrrTs r)rWzPluginCollection.on_serveEs~~gvfg~NNr+c&|jd|S)Nr3rrYs r)rZzPluginCollection.on_configJs~~h//r+c(|jd|S)N pre_buildr3rrYs r)r\zPluginCollection.on_pre_buildMs~~k&~99r+c*|jd||S)Nr_rrr^s r)r`zPluginCollection.on_filesPs~~guV~<dHTd d  & := GS   ! 58 BN  LL``&*`4@`IN` ` [Z&Z15Z?KZR\Z Z Mr+rc,eZdZdZdfd ZddZxZS)PrefixedLoggerz(A logger adapter to prefix log messages.c4t||i||_y)z Initialize the logger adapter. Arguments: prefix: The string to insert in front of every message. logger: The logger instance. N)rrprefix)rGr%loggerrs r)rzPrefixedLogger.__init__s $ r+c(|jd||fS)z Process the message. Arguments: msg: The message: kwargs: Remaining arguments. Returns: The processed message. z: )r%)rGmsgrs r)processzPrefixedLogger.processs++b&..r+)r%rr&zlogging.Loggerrr)r(rrzMutableMapping[str, Any]rztuple[str, Any])r9rrrrr)r r!s@r)r#r#s2  /r+r#cptjd|}t|jddd|S)a Return a logger for plugins. Arguments: name: The name to use with `logging.getLogger`. Returns: A logger configured to work well in MkDocs, prefixing each message with the plugin package name. Example: ```python from mkdocs.plugins import get_plugin_logger log = get_plugin_logger(__name__) log.info("My plugin message") ``` zmkdocs.plugins..rr)r getLoggerr#split)r#r&s r)get_plugin_loggerr.s8&  7 8F $**S!,Q/ 88r+)rzdict[str, EntryPoint])rfloatrzCallable[[T], T])r#rrr#)@r __future__rrsystypingrrrrrr r r version_infoimportlib.metadatarrimportlib_metadatajinja2.environmentjinja2mkdocsrmkdocs.config.baserrrrrmkdocs.config.defaultsrmkdocs.livereloadrmkdocs.structure.filesrmkdocs.structure.navrmkdocs.structure.pagesrmkdocs.utils.templatesrtyping_extensionsrrrrr,rr*r,r/tuple__dict__rrdelattrrrr;rr LoggerAdapterr#r.r1r+r)rEs8+" dddw;;;dd32,/+688I cN CLg() \ 0 f$fR Ij11I I #A J "#DRGAqDMRBYMt^CO<YMx/W**/89r+