| Server IP : 46.101.140.223 / Your IP : 216.73.217.61 Web Server : nginx/1.22.1 System : Linux debian-s-1vcpu-1gb-fra1-01 6.1.0-49-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.174-1 (2026-05-26) x86_64 User : deploy-others ( 1001) PHP Version : 8.2.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /proc/thread-self/root/lib/python3/dist-packages/mkdocs/__pycache__/ |
Upload File : |
�
2ȅc�F � �H � d Z ddlmZ ddlZddlZddlmZmZmZm Z m
Z
m Z m Z m
Z
mZmZmZmZ ej dk r ddlmZmZ nddlmZmZ ej dk rddlmZ nddlmZ ddlZdd lm Z dd
l m Z m Z m Z m!Z!m"Z" dd l#m$Z$ dd l%m&Z& dd
l'm(Z( ddl)m*Z* erddl+m,Z, ej- d� � Z.d!d�Z/ ede �� � Z0 G d� de
e0 � � Z1 e2d� e1j3 D � � � � Z4e4D ]Z5 e6e1de5z � � � ed� � Z7d"d �Z8 G d � d e9e e:e1f � � Z;dS )#z(
Implements the plugin API for MkDocs.
� )� annotationsN) �
TYPE_CHECKING�Any�Callable�Dict�Generic�List�MutableMapping�Optional�Tuple�Type�TypeVar�overload)� �
)�
EntryPoint� entry_points)r � )�Literal)�utils)�Config� ConfigErrors�ConfigWarnings� LegacyConfig�PlainConfigSchema)�LiveReloadServer)�Files)�
Navigation)�Page)� MkDocsConfig�mkdocs.plugins�return�Dict[str, EntryPoint]c � � t d�� � } i }| D ]0}|j |v r|j � d� � r�&|||j < �1|S )z=Return a dict of all installed Plugins as {name: EntryPoint}.r! )�groupzmkdocs.contrib.)r �name�value�
startswith)�plugins� pluginmap�plugins �0/usr/lib/python3/dist-packages/mkdocs/plugins.py� get_pluginsr- 2 sf � � �!1�2�2�2�G� �I�� (� (�� �;�)� #� #�� �(?�(?�@Q�(R�(R� #� �!'� �&�+� � � �� �
SomeConfig)�boundc � � e Zd ZU dZeZded< dZded< i Zded< d Z d
ed < dNd
�Z
d� Z dOdPd�Z dQd�Z
dRd �ZdSd#�ZdTd%�ZdUd&�ZdVd*�ZdWd.�ZdXd2�ZdUd3�ZdYd6�ZdZd<�Zd[d?�Zd\dA�Zd]dE�Zd^dF�Zd_dH�Z d`dJ�Z dadK�Z dbdM�Z dS )c�
BasePluginzI
Plugin base class.
All plugins should subclass this class.
zType[SomeConfig]� config_class� r �
config_schemer/ �configF�bool�supports_multiple_instances� Type[Config]c �f � | j � d|j � d�}t || ft |�� � � � S )z^Eliminates the need to write `config_class = FooConfig` when subclassing BasePlugin[FooConfig]�[�])r3 )�__name__�type�dict)�clsr3 r& s r, �__class_getitem__z BasePlugin.__class_getitem__S s< � ��,�9�9� �!6�9�9�9���D�3�&�$�L�"A�"A�"A�B�B�Br. c � � t | j t � � st d| j � d�� � �| j t ur| j j | _ d S d S )Nz
config_class z2 must be a subclass of `mkdocs.config.base.Config`)�
issubclassr3 r � TypeErrorr �_schemar5 )r@ s r, �__init_subclass__z BasePlugin.__init_subclass__X sf � ��#�*�F�3�3� ��d�� 0�d�d�d�� �
� � �<� /� /� #� 0� 8�C� � � � 0� /r. N�options�Dict[str, Any]�config_file_path�
Optional[str]r" �#Tuple[ConfigErrors, ConfigWarnings]c �� � | j t u r t | j |�� � | _ n| � |�� � | _ | j � |� � | j � � � S )zJLoad config from a dict of options. Returns a tuple of (errors, warnings).)rI )r3 r r5 r6 � load_dict�validate)�selfrG rI s r, � load_configzBasePlugin.load_config` so � �
� � � ,� ,�&�t�'9�L\�]�]�]�D�K�K� �+�+�=M�+�N�N�D�K� � � � �g�&�&�&��{�#�#�%�%�%r. �command�&Literal['build', 'gh-deploy', 'serve']�dirty�Nonec � � dS )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.
Parameters:
command: the command that MkDocs was invoked with, e.g. "serve" for `mkdocs serve`.
dirty: whether `--dirtyreload` or `--dirty` flags were passed.
Nr4 )rO rQ rS s r, �
on_startupzBasePlugin.on_startupp � � � � r. c � � dS )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.
Nr4 )rO s r, � on_shutdownzBasePlugin.on_shutdown� rW r. �serverr r �builderr �Optional[LiveReloadServer]c � � |S )a|
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.
Parameters:
server: `livereload.Server` instance
config: global configuration object
builder: a callable which gets passed to each call to `server.watch`
Returns:
`livereload.Server` instance
r4 )rO rZ r6 r[ s r, �on_servezBasePlugin.on_serve� s � �$ �
r. �Optional[Config]c � � |S )aV
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.
Parameters:
config: global configuration object
Returns:
global configuration object
r4 �rO r6 s r, � on_configzBasePlugin.on_config� s � � �
r. c � � dS )z�
The `pre_build` event does not alter any variables. Use this event to call
pre-build scripts.
Parameters:
config: global configuration object
Nr4 ra s r, � on_pre_buildzBasePlugin.on_pre_build� rW r. �filesr �Optional[Files]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.
Parameters:
files: global files collection
config: global configuration object
Returns:
global files collection
r4 )rO re r6 s r, �on_fileszBasePlugin.on_files� s � � � r. �navr �Optional[Navigation]c � � |S )aW
The `nav` event is called after the site navigation is created and can
be used to alter the site navigation.
Parameters:
nav: global navigation object
config: global configuration object
files: global files collection
Returns:
global navigation object
r4 )rO ri r6 re s r, �on_navzBasePlugin.on_nav� s � � �
r. �env�jinja2.Environment� Optional[jinja2.Environment]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).
Parameters:
env: global Jinja environment
config: global configuration object
files: global files collection
Returns:
global Jinja Environment
r4 )rO rm r6 re s r, �on_envzBasePlugin.on_env� s � � �
r. c � � dS )z�
The `post_build` event does not alter any variables. Use this event to call
post-build scripts.
Parameters:
config: global configuration object
Nr4 ra s r, �
on_post_buildzBasePlugin.on_post_build� rW r. �error� Exceptionc � � dS )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.
Parameters:
error: exception raised
Nr4 )rO rt s r, �on_build_errorzBasePlugin.on_build_error� rW r. �template�jinja2.Template�
template_name�str�Optional[jinja2.Template]c � � |S )a�
The `pre_template` event is called immediately after the subject template is
loaded and can be used to alter the template.
Parameters:
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
r4 )rO rx rz r6 s r, �on_pre_templatezBasePlugin.on_pre_template
s � � �r. �context�Optional[Dict[str, Any]]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.
Parameters:
context: dict of template context variables
template_name: string filename of template
config: global configuration object
Returns:
dict of template context variables
r4 )rO r rz r6 s r, �on_template_contextz BasePlugin.on_template_context � � � �r. �output_contentc � � |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.
Parameters:
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
r4 )rO r� rz r6 s r, �on_post_templatezBasePlugin.on_post_template- s
� �" � r. �pager �Optional[Page]c � � |S )am
The `pre_page` event is called before any actions are taken on the subject
page and can be used to alter the `Page` instance.
Parameters:
page: `mkdocs.nav.Page` instance
config: global configuration object
files: global files collection
Returns:
`mkdocs.nav.Page` instance
r4 )rO r� r6 re s r, � on_pre_pagezBasePlugin.on_pre_pageB s � � � r. c � � dS )a�
The `on_page_read_source` event can replace the default mechanism to read
the contents of a page's source from the filesystem.
Parameters:
page: `mkdocs.nav.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.
Nr4 )rO r� r6 s r, �on_page_read_sourcez BasePlugin.on_page_read_sourceQ s � � �tr. �markdownc � � |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.
Parameters:
markdown: Markdown source text of page as string
page: `mkdocs.nav.Page` instance
config: global configuration object
files: global files collection
Returns:
Markdown source text of page as string
r4 )rO r� r� r6 re s r, �on_page_markdownzBasePlugin.on_page_markdown` s � �" �r. �htmlc � � |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.
Parameters:
html: HTML rendered from Markdown source as string
page: `mkdocs.nav.Page` instance
config: global configuration object
files: global files collection
Returns:
HTML rendered from Markdown source as string
r4 )rO r� r� r6 re s r, �on_page_contentzBasePlugin.on_page_contents s � �" � 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.
Parameters:
context: dict of template context variables
page: `mkdocs.nav.Page` instance
config: global configuration object
nav: global navigation object
Returns:
dict of template context variables
r4 )rO r r� r6 ri s r, �on_page_contextzBasePlugin.on_page_context� r� r. �outputc � � |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.
Parameters:
output: output of rendered template as string
page: `mkdocs.nav.Page` instance
config: global configuration object
Returns:
output of rendered template as string
r4 )rO r� r� r6 s r, � on_post_pagezBasePlugin.on_post_page� s � � �
r. )r3 r9 �N)rG rH rI rJ r" rK )rQ rR rS r7 r" rT �r" rT )rZ r r6 r r[ r r" r\ )r6 r r" r_ )r6 r r" rT )re r r6 r r" rf )ri r r6 r re r r" rj )rm rn r6 r re r r" ro )rt ru r" rT )rx ry rz r{ r6 r r" r| )r rH rz r{ r6 r r" r� )r� r{ rz r{ r6 r r" rJ )r� r r6 r re r r" r� )r� r r6 r r" rJ )
r� r{ r� r r6 r re r r" rJ )
r� r{ r� r r6 r re r r" rJ )
r rH r� r r6 r ri r r" r� )r� r{ r� r r6 r r" rJ ) r= �
__module__� __qualname__�__doc__r r3 �__annotations__r5 r6 r8 rA rF rP rV rY r^ rb rd rh rl rq rs rw r~ r� r� r� r� r� r� r� r� r4 r. r, r2 r2 E s- � � � � � � �� � &2�L�1�1�1�1�')�M�)�)�)�)��F�����(-� �-�-�-�-�a�C� C� C� C�
9� 9� 9� JN� &� &� &� &� &� � � � �" � � � �"� � � �, � � � � � � � �� � � �"� � � �"� � � �$ � � � �
�
�
�
� � � � �"� � � �$ � � � �*
�
�
�
�
�
�
�
� � � � �&� � � �&� � � �$� � � � � r. r2 c # �T K � | ]#}|� d � � �|dd� V � �$dS )�on_r N�r( ��.0�ks r, � <genexpr>r� � s; � � � �I�I��Q�\�\�%�5H�5H�I�q����u�I�I�I�I�I�Ir. r� �T�priority�float�Callable[[T], T]c � � � � fd�}|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.
```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 � �� �| _ | S r� )�mkdocs_priority)� event_methodr� s �r, � decoratorz!event_priority.<locals>.decorator� s �� �'/� �$��r. r4 )r� r� s ` r, �event_priorityr� � s$ �� �0 � � � � � �r. c � � � e Zd ZdZd� fd� Zdd �Zd� fd � Zd� fd� Zedd d�� � Z ed d�� � Z dd d�Z � xZ
S ) �PluginCollectionz�
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" rT c �f �� t � � j |i |�� d� t D � � | _ d S )Nc � � i | ]}|g ��S r4 r4 r� s r, �
<dictcomp>z-PluginCollection.__init__.<locals>.<dictcomp>� s � �1H�1H�1H�A�!�R�1H�1H�1Hr. )�super�__init__�EVENTS�events)rO �args�kwargs� __class__s �r, r� zPluginCollection.__init__� s8 �� ������$�)�&�)�)�)�1H�1H��1H�1H�1H�� � � r. �
event_namer{ �methodr c �L � t j | j | |d� �� � dS )z Register a method for an event.c �& � t | dd� � S )Nr� r )�getattr)�ms r, �<lambda>z2PluginCollection._register_event.<locals>.<lambda>� s � �G�A�GX�Z[�<\�<\�;\� r. )�keyN)r �insortr� )rO r� r� s r, �_register_eventz PluginCollection._register_event� s7 � �
� � �K�
� #�V�1\�1\�
�
�
�
�
�
r. r� r2 c �F �� t � � � |� � S r� )r� � __getitem__)rO r� r� s �r, r� z PluginCollection.__getitem__� s �� ��w�w�"�"�3�'�'�'r. r' c � �� t � � � ||� � d� t |� � D � � D ]@}t ||d � � }t |� � r | � |dd � |� � �Ad S )Nc 3 �D K � | ]}|� d � � �|V � � dS )r� Nr� )r� �xs r, r� z/PluginCollection.__setitem__.<locals>.<genexpr>� s3 � � � �H�H��A�L�L��4G�4G�H�1�H�H�H�H�H�Hr. r )r� � __setitem__�dirr� �callabler� )rO r� r' r� r� r� s �r, r� z PluginCollection.__setitem__� s� �� �
�����C��'�'�'�H�H�c�%�j�j�H�H�H� =� =�J� �U�J��5�5�F��� � �
=��$�$�Z����^�V�<�<�<�� =� =r. Nr& �itemr c � � d S r� r4 �rO r& r� r� s r, � run_eventzPluginCollection.run_event� � � � �r. r� c � � d S r� r4 r� s r, r� zPluginCollection.run_event� r� r. c �� � |du}| j | }|r.t � dt |� � � d|� d�� � |D ]}|r
||fi |��}n |di |��}|�|}�|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.
NzRunning z `z` eventsr4 )r� �log�debug�len)rO r& r� r� � pass_itemr� r� �results r, r� zPluginCollection.run_event� s� � � ��$� ���T�"�� � @� �I�I�>��V���>�>��>�>�>� ?� ?� ?� � � �F��
*� ���/�/��/�/��� ��)�)�&�)�)���!� ���� r. r� )r� r{ r� r r" rT )r� r{ r" r2 )r� r{ r' r2 r" rT r� )r& r{ r� rT r" r )r& r{ r� r� r" r� )r& r{ ) r= r� r� r� r� r� r� r� r r� �
__classcell__)r� s @r, r� r� � s� �� � � � � �� �I� I� I� I� I� I�
�
�
�
� (� (� (� (� (� (�=� =� =� =� =� =� � � � � � �X� � � � � � �X� �� � � � � � � � r. r� )r" r# )r� r� r" r� )<r� �
__future__r �logging�sys�typingr r r r r r r
r r r
r r � version_info�importlib.metadatar r �importlib_metadatar �typing_extensions�jinja2.environment�jinja2�mkdocsr �mkdocs.config.baser r r r r �mkdocs.livereloadr �mkdocs.structure.filesr �mkdocs.structure.navr �mkdocs.structure.pagesr �mkdocs.config.defaultsr � getLoggerr� r- r/ r2 �tuple�__dict__r� r� �delattrr� r� r? r{ r� r4 r. r, �<module>r� s ��� � #� "� "� "� "� "� ����
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
� ��w� � �;�;�;�;�;�;�;�;�;�;�;�;�;�;�;�;�;���v� � � � � � � � � �)�)�)�)�)�)� � � � � � � � � � � d� d� d� d� d� d� d� d� d� d� d� d� d� d� .� .� .� .� .� .� (� (� (� (� (� (� +� +� +� +� +� +� '� '� '� '� '� '�� 4�3�3�3�3�3�3� �g��(�)�)��
�
�
�
� �W�\��
0�
0�
0�
�b� b� b� b� b���$� b� b� b�J
��I�I�j� 1�I�I�I� I� I��
� #� #�A� �G�J��� �"�"�"�"� �G�C�L�L�� � � � �>;� ;� ;� ;� ;�t�^�C��O� <� ;� ;� ;� ;� ;r.