|
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�O �
@ sF d Z ddlZddlZddlZddlmZ ddlmZmZ ddl m
Z
m Z m Z m
Z
mZmZmZmZmZmZmZmZ ddlmZmZ ddlmZmZ ddl m Z dd l m Z dd
l m!Z!m"Z" dd l#m$Z$ dd l%m&Z& e
rvdd
l'm(Z( ddl)m*Z* e �+e,�Z-dZ.e/ej0ej1fZ2e�3d�Z4G dd� de�Z5de de6fdd�Z7G dd� d�Z8G dd� d�Z9de:d ee$ de
e:e f fd d �Z;d d d!e9ddfd"d#�Z<d d d!e9ddfd$d%�Z=d d d!e9ddfd&d'�Z>d d d!e9ddfd(d)�Z?d d d!e9ddfd*d+�Z@d d d!e9ddfd,d-�ZAd d d.d/d0ee: d1ee: d2ee: dee: f d3d4�ZBd d de
e:e f fd5d6�ZCdS )7z�
sphinx.config
~~~~~~~~~~~~~
Build configuration file handling.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)� OrderedDict)�getenv�path) �
TYPE_CHECKING�Any�Callable�Dict� Generator�Iterator�List�
NamedTuple�Optional�Set�Tuple�Union)� ConfigError�ExtensionError)�_�__)�logging)� format_date)�cd� fs_encoding)�Tags)�NoneType)�Sphinx)�BuildEnvironmentzconf.pyz^((\d{4}-)?)(\d{4})(?=[ ,])c @ s. e Zd ZU eed< eed< eeef ed< dS )� ConfigValue�name�value�rebuildN)�__name__�
__module__� __qualname__�str�__annotations__r r �bool� r' r' �//usr/lib/python3/dist-packages/sphinx/config.pyr & s
r �obj�returnc C sj t | t�rdS t | t�r"| �� D ]\}}t|�r t|�s dS qdS t | tttf�r3tdd� | D ��S dS )z'Check if object is serializable or not.Fc s s � | ]}t |�V qd S �N)�is_serializable)�.0�ir' r' r( � <genexpr>5 s � z"is_serializable.<locals>.<genexpr>T) �
isinstance�UNSERIALIZABLE_TYPES�dict�itemsr, �list�tuple�set�all)r) �keyr r' r' r( r, , s
��r, c @ s> e Zd ZdZdeddfdd�Zdeeeef de fdd �Z
dS )
�ENUMz�Represents the candidates which a config value should be one of.
Example:
app.add_config_value('latex_show_urls', 'no', None, ENUM('no', 'footnote', 'inline'))
�
candidatesr* Nc G s
|| _ d S r+ �r: )�selfr: r' r' r( �__init__@ �
z
ENUM.__init__r c s. t |ttf�rt� fdd�|D ��S |� jv S )Nc 3 s � | ]}|� j v V qd S r+ r; )r- �item�r< r' r( r/ E � � z ENUM.match.<locals>.<genexpr>)r0 r4 r5 r7 r: )r< r r' r@ r( �matchC s
z
ENUM.match) r! r" r# �__doc__r$ r= r r r r& rB r' r' r' r( r9 : s r9 c
@ s* e Zd ZU dZi dddg f�dddg f�ddd egf�d
d d � d egf�d
ddg f�dddg f�dddg f�dddegf�dddegf�ddgdg f�dddegf�dddg f�dddg f�d d d � dg f�d d d idef�d!d"dg f�d#g dg f�i d$ddegf�d%d&dg f�d'd&dg f�d(ddg f�d)ddg f�d*dd egf�d+d,dg f�d-i dg f�d.g d g f�d/dd egf�d0ddg f�d1g dg f�d2g d g f�d3ddegf�d4ddegf�d5d&dg f�d6d7degf��i d8ddegf�d9i dg f�d:ddg f�d;ddg f�d<g dg f�d=g dg f�d>ddg f�d?d@dg f�dAi dg f�dBddg f�dCddegf�dDd&dg f�dEd&dg f�dFddg f�dGddegf�dHd&dg f�dIdJdg f��dKdLgdMdNgdO�dg fi�Zeee f e
dP< i i fdQeeef dReeef dSdfdTdU�Z e dydVedRedWe
dSd fdXdY��ZdZed[edSefd\d]�Zdzd^d_�Zdzd`da�ZdZedSefdbdc�ZdZedSefddde�ZdZed[edSdfdfdg�ZdZedSdfdhdi�ZdZedSefdjdk�ZdSeeddf fdldm�ZdZed,edneeef doedSdf
dpdq�Z dneee e f dSe e fdrds�Z dSefdtdu�Z dvedSdfdwdx�Z!dS ){�Configa� Configuration file abstraction.
The config object makes the values of all config values available as
attributes.
It is exposed via the :py:attr:`sphinx.application.Application.config` and
:py:attr:`sphinx.environment.Environment.config` attributes. For example,
to get the value of :confval:`language`, use either ``app.config.language``
or ``env.config.language``.
�project�Python�env�author�unknown�project_copyright� �html� copyrightc C � | j S r+ )rJ )�cr' r' r( �<lambda>` � zConfig.<lambda>�version�release�today� today_fmtN�language� locale_dirs�locales�figure_language_filenamez{root}.{language}{ext}� gettext_allow_fuzzy_translationsF�gettext�
master_doc�index�root_docc C rN r+ )r\ )�configr' r' r( rP m rQ �
source_suffixz.rst�restructuredtext�source_encodingz utf-8-sig�exclude_patterns� default_role�add_function_parenthesesT�add_module_names� trim_footnote_reference_space� show_authors�pygments_style�highlight_language�default�highlight_options�templates_path�template_bridge�
keep_warnings�suppress_warnings�modindex_common_prefix�
rst_epilog�
rst_prolog�trim_doctest_flags�primary_domain�py� needs_sphinx�needs_extensions� manpages_url�nitpicky�nitpick_ignore�nitpick_ignore_regex�numfig�numfig_secnum_depth� �
numfig_format�math_number_all�math_eqref_format� math_numfig�
tls_verify� tls_cacerts�
user_agent� smartquotes�smartquotes_action�qDe�smartquotes_excludes�ja�man�text)� languages�builders�
config_valuesr_ � overridesr* c C s~ t |�| _tj�� | _|| _|�dd �| _d| jv r6t | jd t
�r.| j� d�� d�|d< n| j� d�|d< |�dg �| _
d S )N�setup�
extensions�,)r2 r� rD r� �copy�values� _raw_config�getr� r0 r$ �pop�splitr� )r< r_ r� r' r' r( r= � s
zConfig.__init__�confdir�tagsc C s> t �|t�}t �|�sttd�| ��t||�}| ||p i �S )z/Create a Config object from configuration file.z4config directory doesn't contain a conf.py file (%s))r �join�CONFIG_FILENAME�isfiler r �eval_config_file)�clsr� r� r� �filename� namespacer' r' r( �read� s
�
z Config.readr r c
C sF t |t�s|S | j| d }| j| d tkr|S | j| d tthkr2|dkr*dS |dkr0dS |S t|�tu sB| j| d tgkrL|dkrHdS t|�S t |t�r]ttd�||d f ��t |t �rg|�
d �S t |t �r�zt |�W S ty� } z ttd
�||f �|�d }~ww t |d �r�|S |d ur�t |t�s�ttd �| ��|S )
Nr � �0F�1TzZcannot override dictionary config setting %r, ignoring (use %r to set individual elements)z
.key=valuer� z/invalid number %r for config value %r, ignoring�__call__zAcannot override config setting %r with unsupported type, ignoring)
r0 r$ r� r r& �typer2 �
ValueErrorr r4 r� �int�hasattr)r< r r �defvalue�excr' r' r( �convert_overrides� sN
�
����
�zConfig.convert_overridesc C s� g d�}|D ];}z!|| j v r| �|| j | �| j|< n
|| jv r(| j| | j|< W q tyA } z t�d|� W Y d}~qd}~ww dS )zs
Initialize some limited config variables before initializing i18n and loading
extensions.
)rw rp rV rW �%sN)r� r� �__dict__r� r� �logger�warning)r< � variablesr r� r' r' r( �pre_init_values� s
����zConfig.pre_init_valuesc C s� | j }| j�� D ]U\}}z9d|v r#|�dd�\}}||�|i �|< W q|| jvr2t�td�|� W qt |t
�r@| � ||�||< n|||< W q t y] } z t�d|� W Y d }~qd }~ww |D ]}|| jv rn|| | j
|< q`d S )N�.r z-unknown config value %r in override, ignoringr� )r� r� r3 r� �
setdefaultr� r� r� r r0 r$ r� r� r� )r< r_ �valnamer � realvalnamer8 r� r r' r' r( � init_values� s2
�
���
��zConfig.init_valuesc C sP |� d�r t|��|| jvrttd�| ��| j| d }t|d�r&|| �S |S )Nr zNo such config value: %sr r� )�
startswith�AttributeErrorr� r r� )r< r rk r' r' r( � __getattr__� s
zConfig.__getattr__c C s
t | |�S r+ )�getattr�r< r r' r' r( � __getitem__ r> zConfig.__getitem__c C s t | ||� d S r+ )�setattr�r< r r r' r' r( � __setitem__ � zConfig.__setitem__c C s t | |� d S r+ )�delattrr� r' r' r( � __delitem__ s zConfig.__delitem__c C s
|| j v S r+ )r� r� r' r' r( � __contains__ r> zConfig.__contains__c c s2 � | j �� D ]\}}t|t| |�|d �V qd S )Nr )r� r3 r r� r� r' r' r( �__iter__ s ��zConfig.__iter__r �typesc C s. || j v r
ttd�| ��|||f| j |< d S )Nz Config value %r already present)r� r r )r< r rk r r� r' r' r( �add s
z
Config.addc s" t � t�r� g� � fdd�| D �S )Nc 3 s � | ]
}|j � v r|V qd S r+ �r )r- r r� r' r( r/ ! s � z Config.filter.<locals>.<genexpr>)r0 r$ )r< r r' r� r( �filter s
z
Config.filterc C s� i }| j �� D ]\}}|�d�st|�sq|||< qi |d< | j�� D ]\}}t| |�}t|�s2d}||d df|d |< q#|S )z'Obtains serializable data for pickling.r r� Nr )r� r3 r� r, r� r� )r< r� r8 r �
real_valuer' r' r( � __getstate__# s
zConfig.__getstate__�statec C s | j �|� d S r+ )r� �update)r< r� r' r' r( � __setstate__: r� zConfig.__setstate__)NN)r* N)"r! r" r# rC r$ r r r� r r r% r= � classmethodr r� r� r� r� r� r� r� r� r& r� r r r� r r� r r
r� r� r� r' r' r' r( rD J s�
�
� ��
�
�
�
� �
� �
�
���
�
� �
�
�
�
� �
�
�
� �
�
!�
"� #� $�
%� &� '�
(�
)�
*�
+�
,�
-�
.�
/�
1� 2�
3�
4�
5� 6�
7�
8�9���,>
)
&"rD r� r� c C s, i }| |d< ||d< t t�| ���{ z't| d��}t|�� | �t�d�}t||� W d � n1 s3w Y W nJ t yP } z t
d�}t || �|�d}~w t yd } z t
d�}t |�|�d}~w t yk � t
y� } z
t
d�}t |t�� �|�d}~ww W d � |S 1 s�w Y |S ) zEvaluate a config file.�__file__r� �rb�execNz7There is a syntax error in your configuration file: %s
zKThe configuration file (or one of the modules it imports) called sys.exit()z=There is a programmable error in your configuration file:
%s)r r �dirname�open�compiler� �encoder r� � SyntaxErrorr r �
SystemExit� Exception� traceback�
format_exc)r� r� r� �f�code�err�msgr� r' r' r( r� > s< ���
� ���
��r� �appr r_ c C sx |j }t|t�rt|di�|_ dS t|ttf�r$tdd� |D ��|_ dS t|t�r1t|j �|_ dS t�t d| �� dS )z�Convert old styled source_suffix to new styled one.
* old style: str or list
* new style: a dict which maps from fileext to filetype
Nc S s g | ]}|d f�qS r+ r' )r- �sr' r' r( �
<listcomp>j s z)convert_source_suffix.<locals>.<listcomp>zeThe config value `source_suffix' expects a string, list of strings, or dictionary. But `%r' is given.)
r` r0 r$ r r4 r5 r2 r� r� r )r� r_ r` r' r' r( �convert_source_suffix[ s
�r� c C s8 |j }|rtdd� |�� D ��s|j|i|_ dS dS dS )z�Convert old styled highlight_options to new styled one.
* old style: options
* new style: a dict which maps from language name to options
c s s � | ]}t |t�V qd S r+ )r0 r2 )r- �vr' r' r( r/ { rA z,convert_highlight_options.<locals>.<genexpr>N)rl r7 r� rj )r� r_ �optionsr' r' r( �convert_highlight_optionst s �r� c C s4 t d�t d�t d�t d�d�}|�|j� ||_dS )z$Initialize :confval:`numfig_format`.z
Section %szFig. %szTable %sz
Listing %s)�section�figure�tablez
code-blockN)r r� r� )r� r_ r� r' r' r( �init_numfig_format� s �
r� c C sF t d�dur dD ]}||v r dtd� }t�||| �||< qdS dS )z�Correct values of copyright year that are not coherent with
the SOURCE_DATE_EPOCH environment variable (if set)
See https://reproducible-builds.org/specs/source-date-epoch/
�SOURCE_DATE_EPOCHN)rM �epub_copyrightz\g<1>%sz%Y)r r �copyright_year_re�sub)r� r_ �k�replacer' r' r( �correct_copyright_year� s ��r� c
C s~ |D ]�}|j |j \}}}t|d�r||�}|du r |s q|tu r"qt|t�r@|�|j�s?td�}t �
|j |j|j|j d�� qt
|j�t
|�u rJqt
|j�|v rRqtt
|j�jt
|j�f �tt
|�j�@ }|�t� |roq|r�td�}dd� |D �}t|�dkr�d � d
�|dd � �|d �} nd �|�} t �
|j |jt
|j�| d
�� qtd�}t �
|j |jt
|j�t
|�d�� qdS )z�Check all values for deviation from the default value's type, since
that can result in TypeErrors all over the place NB.
r� NzTThe config value `{name}` has to be a one of {candidates}, but `{current}` is given.)r �currentr: zNThe config value `{name}' has type `{current.__name__}'; expected {permitted}.c S s g | ]}d � |j��qS )z`{}')�formatr! )r- rO r' r' r( r� � s z'check_confval_types.<locals>.<listcomp>r� z {}, or {}z, ���z or )r r� � permittedzZThe config value `{name}' has type `{current.__name__}', defaults to `{default.__name__}'.)r r� rk )r� r r� r r0 r9 rB r r r� r� r� r: r� r6 � __bases__�discard�object�lenr� )
r� r_ �confvalrk r � annotationsr� � common_bases�wrapped_annotationsr� r' r' r( �check_confval_types� sZ
�� �
�
�
��r c C s8 |j }|r| j�|�st�td�|� d |_ d S d S d S )Nz%primary_domain %r not found, ignored.)ru �registry�
has_domainr� r� r )r� r_ ru r' r' r( �check_primary_domain� s
�r rG r �added�changed�removedc C s> | j jdkr d| jjvr d| jjv r t�td�� d| j _|S )zjAdjust root_doc to 'contents' to support an old project which does not have
any root_doc setting.
r] �contentszkSince v2.0, Sphinx uses "index" as root_doc by default. Please add "root_doc = 'contents'" to your conf.py.)r_ r^ rE �docnamesr� r� r )r� rG r r r r' r' r( �check_root_doc� s r
c C sx | j dtdd� | j dtdd� | j dtdd� | j dtdd� | j dtdd� | j dtdd� | � dt� dddd�S )Nz
config-initedi )�priorityzenv-get-outdated�builtinT)rR �parallel_read_safe�parallel_write_safe)�connectr� r� r� r� r r r
)r� r' r' r( r� � s �r� )DrC �rer� r� � collectionsr �osr r �typingr r r r r r
r r r
r r r �
sphinx.errorsr r �
sphinx.localer r � sphinx.utilr �sphinx.util.i18nr �sphinx.util.osutilr r �sphinx.util.tagsr �sphinx.util.typingr �sphinx.applicationr �sphinx.environmentr � getLoggerr! r� r� r� �
ModuleType� FunctionTyper1 r� r� r r& r, r9 rD r$ r� r� r� r� r� r r r
r� r' r' r' r( �<module> sR
8
"u
7��
�