|
Server : Apache System : Linux iad1-shared-b8-43 6.6.49-grsec-jammy+ #10 SMP Thu Sep 12 23:23:08 UTC 2024 x86_64 User : dh_edsupp ( 6597262) PHP Version : 8.2.26 Disable Function : NONE Directory : /lib/python3/dist-packages/sphinx/__pycache__/ |
Upload File : |
o
�$�a|V � @ s� d Z ddlZddlZddlmZ ddlmZ ddlmZm Z m
Z
m Z m Z m
Z
mZmZmZmZ ddlmZ ddlmZ ddlmZmZmZ dd lmZ dd
l m Z dd l m Z dd l m!Z! dd
l"m#Z# ddl$m%Z% ddl&m'Z' ddl(m)Z)m*Z*m+Z+ ddl,m-Z-m.Z. ddl/m0Z0 ddl1m2Z2m3Z3m4Z4 ddl5m6Z6 ddl7m8Z8 dd l9mZ: ddl;m<Z< ddl=m>Z> ddl?m@Z@ ddlAmBZBmCZC er�ddlDmEZE ddlFmGZG e>�HeI�ZJd d iZKG d d � d �ZLd d!d"e%d#dfd$d%�ZMd d!d#e eNe f fd&d'�ZOdS )(z�
sphinx.registry
~~~~~~~~~~~~~~~
Sphinx component registry.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�
import_module)�
MethodType)
�
TYPE_CHECKING�Any�Callable�Dict�Iterator�List�Optional�Tuple�Type�Union)�nodes)�Input)�Element�Node� TextElement)�Parser)� Directive)� Transform)�iter_entry_points)�Builder)�Config)�RemovedInSphinx60Warning)�Domain�Index�ObjType)�
GenericObject�Target)�BuildEnvironment)�ExtensionError� SphinxError�VersionRequirementError)� Extension)�__)�XRefRole)�logging)�prefixed_warnings)� RoleFunction� TitleGetter)�Sphinx)�
Documenterzsphinxjp.themecorez1.2c @ s e Zd Zdwdd�Zdxdee deddfdd �Zd
d d eddfd
d�Z d
d d edefdd�Z
dxdee deddfdd�Z dedefdd�Z
dedee fdd�Z dxded edee deddf
dd�Z dxded ed eeef deddf
d d �Z dxded ee deddfd d!�Zd"ddd"g dfd#ed$ed%ed&ed'ee d(ed)ededdfd*d+�Z " " dyd#ed$ed%ed'ee d(ededdfd,d-�Z dxd.ed/ededdfd0d1�Z dxd2ee deddfd3d4�Z d/edee fd5d6�Z!de"eee f fd7d8�Z#d
d d9ede fd:d;�Z$d/ede%ee& fd<d=�Z' dxd ed>ee(j) deddfd?d@�Z*dAee+ dBe,eef ddfdCdD�Z-dedee(j) fdEdF�Z.dedGe/de(j)fdHdI�Z0dJee1 ddfdKdL�Z2deee1 fdMdN�Z3dJee1 ddfdOdP�Z4deee1 fdQdR�Z5dSedTedU ddfdVdW�Z6dXedYee/ee/ge/f ddfdZd[�Z7d9ed\e/ddfd]d^�Z8d9ed\e/ddfd_d`�Z9d edefdadb�Z:dxd edceddeddfdedf�Z; dzdAee< dgedhe=deddf
didj�Z>d edke,eef dle,eef ddfdmdn�Z?d edoeddfdpdq�Z@d
d dreddfdsdt�ZAd
d de"eef fdudv�ZBdS ){�SphinxComponentRegistry�returnNc C s� i | _ i | _i | _g | _i | _i | _i | _i | _i | _i | _ i | _
i | _ d| _ i | _
g | _g | _g | _g | _i | _i | _i | _i | _i | _g | _d S )N�per_page)�autodoc_attrgettrs�builders� documenters� css_files�domains�domain_directives�domain_indices�domain_object_types� domain_roles�enumerable_nodes�html_inline_math_renderers�html_block_math_renderers�html_assets_policy� html_themes�js_files�latex_packages� latex_packages_after_hyperref�post_transforms�source_parsers�
source_inputs�
source_suffix� translators�translation_handlers�
transforms��self� rI �1/usr/lib/python3/dist-packages/sphinx/registry.py�__init__7 s0
z SphinxComponentRegistry.__init__F�builder�overridec C sf t �d|� t|d�sttd�| ��|j| jv r+|s+ttd�|j| j|j jf ��|| j|j< d S )Nz[app] adding builder: %r�namez(Builder class %s has no "name" attributez(Builder %r already exists (in module %s))�logger�debug�hasattrr r$ rN r0 �
__module__)rH rL rM rI rI rJ � add_builder� s
�z#SphinxComponentRegistry.add_builder�appr* rN c
C sn |d u rd S || j vr5td|�}zt|�}W n ty+ } z ttd�| �|�d }~ww | �||j� d S d S )Nzsphinx.buildersz?Builder name %s not registered or available through entry point)r0 r �next�
StopIterationr! r$ �load_extension� module_name)rH rT rN � entry_points� entry_point�excrI rI rJ �preload_builder� s
�����z'SphinxComponentRegistry.preload_builderc C s( || j vr
ttd�| ��| j | |�S )Nz Builder name %s not registered)r0 r! r$ )rH rT rN rI rI rJ �create_builder� s
z&SphinxComponentRegistry.create_builder�domainc C s> t �d|� |j| jv r|sttd�|j ��|| j|j< d S )Nz[app] adding domain: %rz domain %s already registered)rO rP rN r3 r r$ )rH r^ rM rI rI rJ �
add_domain� s z"SphinxComponentRegistry.add_domainc C s
|| j v S �N)r3 )rH r^ rI rI rJ �
has_domain� s
z"SphinxComponentRegistry.has_domain�envc c s� � | j �� D ]B}||�}|j�| j�|ji �� |j�| j�|ji �� |j �
| j �|jg �� | j �|ji ��
� D ]
\}}|�||� q:|V qd S r` )r3 �values�
directives�updater4 �getrN �rolesr7 �indices�extendr5 r6 �items�add_object_type)rH rb � DomainClassr^ rN �objtyperI rI rJ �create_domains� s � �z&SphinxComponentRegistry.create_domains�clsc C �f t �d|||f� || jvrttd�| ��| j�|i �}||v r-|s-ttd�||f ��|||< d S )Nz$[app] adding directive to domain: %r� domain %s not yet registeredz3The %r directive is already registered to domain %s)rO rP r3 r r$ r4 �
setdefault)rH r^ rN ro rM rd rI rI rJ �add_directive_to_domain� s
� z/SphinxComponentRegistry.add_directive_to_domain�rolec C rp )Nz [app] adding role to domain: %rrq z.The %r role is already registered to domain %s)rO rP r3 r r$ r7 rr )rH r^ rN rt rM rg rI rI rJ �add_role_to_domain� s
� z*SphinxComponentRegistry.add_role_to_domain�indexc C sh t �d||f� || jvrttd�| ��| j�|g �}||v r-|s-ttd�|j|f ��|�|� d S )Nz [app] adding index to domain: %rrq z/The %r index is already registered to domain %s) rO rP r3 r r$ r5 rr rN �append)rH r^ rv rM rh rI rI rJ �add_index_to_domain� s
�z+SphinxComponentRegistry.add_index_to_domain� �
directivename�rolename�
indextemplate�
parse_node�
ref_nodeclass�objname�doc_field_typesc
C s� t �d|||||||f� t|ttf|t|�|d��} | �d|| � | �d|t|d�� | j �
di �}
||
v rA|sAt t d�| ��t
|pE||�|
|< d S )Nz [app] adding object type: %r)r| r} r� �std��innernodeclassz(The %r object_type is already registered)rO rP �typer �object� staticmethodrs ru r% r6 rr r r$ r ) rH rz r{ r| r} r~ r r� rM � directive� object_typesrI rI rJ rk � s( ���� �z'SphinxComponentRegistry.add_object_typec C s� t �d|||||f� t|ttfd|i�}| �d||� | �d|t|d�� | j� di �}||v r;|s;t
t d�| ��t |p?||�||< d S )Nz [app] adding crossref type: %rr| r� r� z*The %r crossref_type is already registered)
rO rP r� r r� rs ru r% r6 rr r r$ r ) rH rz r{ r| r~ r rM r� r� rI rI rJ �add_crossref_type� s �� �z)SphinxComponentRegistry.add_crossref_type�suffix�filetypec C s: t �d||� || jv r|sttd�| ��|| j|< d S )Nz"[app] adding source_suffix: %r, %rz&source_suffix %r is already registered)rO rP rC r r$ )rH r� r� rM rI rI rJ �add_source_suffix s z)SphinxComponentRegistry.add_source_suffix�parserc C sD t �d|� |jD ]}|| jv r|sttd�| ��|| j|< q d S )Nz%[app] adding search source_parser: %rz*source_parser for %r is already registered)rO rP � supportedrA r r$ )rH r� rM r� rI rI rJ �add_source_parser
s
� �z)SphinxComponentRegistry.add_source_parserc
C s8 z| j | W S ty } z ttd�| �|�d }~ww )Nz#Source parser for %s not registered)rA �KeyErrorr! r$ )rH r� r[ rI rI rJ �get_source_parser s ��z)SphinxComponentRegistry.get_source_parserc C � | j S r` )rA rG rI rI rJ �get_source_parsers � z*SphinxComponentRegistry.get_source_parsers�filenamec C s( | � |�}|� }t|t�r|�|� |S r` )r� �
isinstance� SphinxParser�set_application)rH rT r� � parser_classr� rI rI rJ �create_source_parser! s
z,SphinxComponentRegistry.create_source_parserc C sP t �dt� z| j| W S ty' z| jd W Y S ty& Y Y d S w w )Nz9SphinxComponentRegistry.get_source_input() is deprecated.�*)�warnings�warnr rB r� )rH r� rI rI rJ �get_source_input( s � ��z(SphinxComponentRegistry.get_source_input�
translatorc C s8 t �d|� || jv r|sttd�| ��|| j|< d S )Nz.[app] Change of translator for the %s builder.z Translator for %r already exists)rO rP rD r r$ )rH rN r� rM rI rI rJ �add_translator5 s z&SphinxComponentRegistry.add_translator�node�kwargsc K sz t �d||� |�� D ]/\}}| j�|i �}z
|\}}||f||j< W q ty: } z ttd�||f �|�d }~ww d S )Nz)[app] adding translation_handlers: %r, %rzEkwargs for add_node() must be a (visit, depart) function tuple: %r=%r) rO rP rj rE rr �__name__�
ValueErrorr r$ ) rH r� r� � builder_name�handlersrE �visit�departr[ rI rI rJ �add_translation_handlers< s" ������z0SphinxComponentRegistry.add_translation_handlersc C s | j �|j|j�S r` )rD rf rN �default_translator_class)rH rL rI rI rJ �get_translator_classJ s
�z,SphinxComponentRegistry.get_translator_class�argsc G s� | � |�}|sJ d|j ��||� }| j�|jd �}|d u r&| j�|ji �}|�� D ] \}\}}t|d| t||�� |rHt|d| t||�� q*|S )Nztranslator not found for %s�visit_�depart_)r� rN rE rf �formatrj �setattrr ) rH rL r� �translator_classr� r� rN r� r� rI rI rJ �create_translatorN s
�z)SphinxComponentRegistry.create_translator� transformc C � t �d|� | j�|� d S )Nz[app] adding transform: %r)rO rP rF rw �rH r� rI rI rJ �
add_transform` � z%SphinxComponentRegistry.add_transformc C r� r` )rF rG rI rI rJ �get_transformsd r� z&SphinxComponentRegistry.get_transformsc C r� )Nz [app] adding post transform: %r)rO rP r@ rw r� rI rI rJ �add_post_transformg r� z*SphinxComponentRegistry.add_post_transformc C r� r` )r@ rG rI rI rJ �get_post_transformsk r� z+SphinxComponentRegistry.get_post_transformsrm �
documenterr+ c C � || j |< d S r` )r1 )rH rm r� rI rI rJ �add_documentern � z&SphinxComponentRegistry.add_documenter�typ�
attrgetterc C r� r` )r/ )rH r� r� rI rI rJ �add_autodoc_attrgetterq s z.SphinxComponentRegistry.add_autodoc_attrgetter�
attributesc K s | j �||f� d S r` )r2 rw �rH r� r� rI rI rJ �
add_css_filesu s z%SphinxComponentRegistry.add_css_filesc K s" t �d||� | j�||f� d S )Nz [app] adding js_file: %r, %r)rO rP r= rw r� rI rI rJ � add_js_filex s z#SphinxComponentRegistry.add_js_filec s" | j | j }t� fdd�|D ��S )Nc s g | ]
}|d � kr|�qS )r rI )�.0�x�rN rI rJ �
<listcomp>~ s z=SphinxComponentRegistry.has_latex_package.<locals>.<listcomp>)r> r? �bool)rH rN �packagesrI r� rJ �has_latex_package| s z)SphinxComponentRegistry.has_latex_package�options�after_hyperrefc C sP | � |�r t�d| � t�d|� |r | j�||f� d S | j�||f� d S )Nz#latex package '%s' already includedz [app] adding latex package: %r)r� rO r� rP r? rw r> )rH rN r� r� rI rI rJ �add_latex_package� s
z)SphinxComponentRegistry.add_latex_package�figtype� title_getterc C s@ t �d|||� || jv r|sttd�| ��||f| j|< d S )Nz*[app] adding enumerable node: (%r, %r, %r)z%enumerable_node %r already registered)rO rP r8 r r$ )rH r� r� r� rM rI rI rJ �add_enumerable_node� s z+SphinxComponentRegistry.add_enumerable_node�inline_renderers�block_renderersc C sB t �d|||� || jv rttd�| ��|| j|< || j|< d S )Nz+[app] adding html_math_renderer: %s, %r, %rz&math renderer %s is already registered)rO rP r9 r r$ r: )rH rN r� r� rI rI rJ �add_html_math_renderer� s �
z.SphinxComponentRegistry.add_html_math_renderer�
theme_pathc C r� r` )r< )rH rN r� rI rI rJ �add_html_theme� r� z&SphinxComponentRegistry.add_html_theme�extnamec C sd ||j v rdS |tv rt�td�|t| � dS td�| }t|��� zt|�}W n! tyJ } zt�td�t �
� � t td�| |�|�d}~ww t |dd�}|du r`t�td�|� i }n z||�}W n t
y} } z t
td�||f �|�d}~ww |du r�i }nt|t�s�t�td �|� i }t||fi |��|j |< W d � dS 1 s�w Y dS )
zLoad a Sphinx extension.Nz\the extension %r was already merged with Sphinx since version %s; this extension is ignored.z while setting up extension %s:zOriginal exception:
z Could not import extension %s�setupzMextension %r has no setup() function; is it really a Sphinx extension module?zpThe %s extension used by this project needs at least Sphinx v%s; it therefore cannot be built with this version.zuextension %r returned an unsupported object from its setup() function; it should return None or a metadata dictionary)�
extensions�EXTENSION_BLACKLISTrO �warningr$ r' r � ImportError�verbose� traceback�
format_excr �getattrr" r� �dictr# )rH rT r� �prefix�mod�errr� �metadatarI rI rJ rW � s^
�
����
� �����
�"�z&SphinxComponentRegistry.load_extensionc C s, ddl m} dd� |j�� D �}||d< |S )Nr )� ENV_VERSIONc S s& i | ]}|j �d �r|j|j d �qS )� env_version)r� rf rN )r� �extrI rI rJ �
<dictcomp>� s
�z:SphinxComponentRegistry.get_envversion.<locals>.<dictcomp>�sphinx)�sphinx.environmentr� r� rc )rH rT r� �
envversionrI rI rJ �get_envversion� s z&SphinxComponentRegistry.get_envversion)r- N)F)ry Nry F)NF)Cr� rR � __qualname__rK r r r� rS �strr\ r] r r_ ra r r rn r rs r
r( r% ru r rx r r r rk r� r� r r� r� r r� r� r
r r� r � NodeVisitorr� r r r� r� r r� r r� r� r� r� r� r� r� r� r� r� r r) r� r� r� rW r� rI rI rI rJ r, 6 s�
M ���
�
�
��
�
��
� ������
�����
� ��
�
�
��
� ���
�
�
�
� .r, rT r* �configr- c C s\ | j j�� D ] \}}|| jjvr|| jj|< q| jj| du r%|| jj|< q| jj| j _dS )zDMerge any user-specified source_suffix with any added by extensions.N)�registryrC rj r� )rT r� r� r� rI rI rJ �merge_source_suffix� s �r� c C s | j dtdd� dddd�S )Nz
config-initedi )�priority�builtinT)�version�parallel_read_safe�parallel_write_safe)�connectr� )rT rI rI rJ r� � s
�r� )P�__doc__r� r� � importlibr �typesr �typingr r r r r r r
r r r
�docutilsr � docutils.ior �docutils.nodesr r r �docutils.parsersr �docutils.parsers.rstr �docutils.transformsr �
pkg_resourcesr �sphinx.buildersr �
sphinx.configr �sphinx.deprecationr �sphinx.domainsr r r �sphinx.domains.stdr r r� r �
sphinx.errorsr r! r" �sphinx.extensionr# �
sphinx.localer$ �sphinx.parsersr� � sphinx.rolesr% � sphinx.utilr& �sphinx.util.loggingr' �sphinx.util.typingr( r) �sphinx.applicationr* �sphinx.ext.autodocr+ � getLoggerr� rO r� r, r� r� r� rI rI rI rJ �<module> sN
0
� "