3
T'ícP ã @ s 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
rìdd
l'm(Z( ddl)m*Z* e j+e,Z-dZ.e/ej0ej1fZ2ej3dZ4G dd deZ5e e6dddZ7G dd dZ8G dd dZ9e:ee$ e
e:e f ddd Z;d e9dd d d Z<d e9dd d!d"Z=d e9dd d#d$Z>d e9dd d%d&Z?d e9dd d'd(Z@d e9dd d)d*ZAd d+ee: ee: ee: ee: d,d-d.ZBd e
e:e f d/d0d1ZCdS )2z"Build configuration file handling.é 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 eeeeef dS )Ú ConfigValueN)
Ú__name__Ú
__module__Ú __qualname__ÚstrÚnamer Úvaluer ÚboolÚrebuild© r& r& ú//tmp/pip-build-gk9425m9/sphinx/sphinx/config.pyr s
r )ÚobjÚreturnc C sn t | trdS t | trHxP| j D ] \}}t| s>t| r"dS q"W n"t | tttfrjtdd | 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>- 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 ZdZeddddZeeeef e dddZ
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'))
N)Ú
candidatesr) c G s
|| _ d S )N)r8 )Úselfr8 r& r& r' Ú__init__8 s z
ENUM.__init__)r# r) c s2 t |ttfr$t fdd|D S | jkS d S )Nc 3 s | ]}| j kV qd S )N)r8 )r+ Úitem)r9 r& r' r- = s z ENUM.match.<locals>.<genexpr>)r. r2 r3 r5 r8 )r9 r# r& )r9 r' Úmatch; s z
ENUM.match) r r r Ú__doc__r! r: r r r r$ r< r& r& r& r' r7 2 s r7 c 6 @ s> e Zd ZU dZddg fddg fddegfdd degfddg fddg fddg fd degfd degfd
gdg fd degfd d
g fddg fdd dg fddidefddg fg dg fd degfddg fddg fd dg fd dg fd degfddg fi dg fg dg fd degfd dg fg dg fg dg fd degfd degfddg fddegfd d egfi d g fd dg fd d g fg d g fg d g fd dg fddg fi dg fd dg fd degfddg fddg fd dg fd degfddg fddg fdgddgddg fd 4Zeee f i i feeef eeef d d d d Z
e dEeee d d d!d"Z
eeed#d$d%Zd d&d'd(Zd d&d)d*Zd d&d+d,Zeed-d.d/Zeed-d0d1Zeed d#d2d3Zed d-d4d5Zeed-d6d7Zeed d f d&d8d9Zeeeeef ed d:d;d<Z eee e f e e d=d>d?Z ed&d@dAZ ed dBdCdDZ!d S )FÚ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``.
ÚPythonÚenvÚunknownÚ Úhtmlc C s | j S )N)Úproject_copyright)Úcr& r& r' Ú<lambda>X s zConfig.<lambda>NZlocalesz{root}.{language}{ext}FÚgettextÚindexc C s | j S )N)Ú
master_doc)Úconfigr& r& r' rF e s z.rstZrestructuredtextz utf-8-sigTÚdefaultÚpyé ZqDeÚjaZmanÚtext)Ú languagesZbuilders)4ÚprojectÚauthorrD Ú copyrightÚversionÚreleaseÚtodayZ today_fmtÚlanguageÚ locale_dirsZfigure_language_filenameZ gettext_allow_fuzzy_translationsrI Úroot_docÚ
source_suffixZsource_encodingZexclude_patternsZ default_roleZadd_function_parenthesesZadd_module_namesZ trim_footnote_reference_spaceZ show_authorsZpygments_styleÚhighlight_languageÚhighlight_optionsZtemplates_pathZtemplate_bridgeZ
keep_warningsÚsuppress_warningsZmodindex_common_prefixZ
rst_epilogZ
rst_prologZtrim_doctest_flagsÚprimary_domainÚ needs_sphinxZneeds_extensionsZ manpages_urlZnitpickyZnitpick_ignoreZnitpick_ignore_regexZnumfigZnumfig_secnum_depthÚ
numfig_formatZmath_number_allZmath_eqref_formatZ math_numfigZ
tls_verifyZ tls_cacertsÚ
user_agentZ smartquotesZsmartquotes_actionZsmartquotes_excludes)rJ Ú overridesr) c C s~ t || _tjj | _|| _|jdd | _d| jkrlt | jd t
r\| jj dj d|d< n| jj d|d< |jdg | _
d S )NÚsetupÚ
extensionsú,)r0 rb r> Ú
config_valuesÚcopyÚvaluesÚ _raw_configÚgetrc r. r! ÚpopÚsplitrd )r9 rJ rb r& r& r' r: s
zConfig.__init__)Úconfdirrb Útagsr) c C s> t j|t}t j|s&ttd| 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)Úclsrm rb rn ÚfilenameÚ namespacer& r& r' Úread s
z Config.read)r" r# r) c C sh t |ts|S | j| d }| j| d tkr2|S | j| d tthkrh|dkrTdS |dkr`dS |S nüt|tks| j| d tgkr|dkrdS t|S nÆt |trÂttd||d f n¢t |t rÖ|j
d S t |t r(yt |S tk
r$ } z ttd
||f |W Y d d }~X nX n<t |r6|S |d k r`t |t r`ttd | n|S d S ) Nr é Ú0FÚ1TzZcannot override dictionary config setting %r, ignoring (use %r to set individual elements)z
.key=valuere z/invalid number %r for config value %r, ignoringzAcannot override config setting %r with unsupported type, ignoring)
r. r! rh r r$ Útyper0 Ú
ValueErrorr r2 rl ÚintÚcallable)r9 r" r# ZdefvalueÚexcr& r& r' Úconvert_overrides¨ s@
"
zConfig.convert_overrides)r) c C s ddddg}x~|D ]v}yB|| j kr<| j|| j | | j|< n|| jkrV| j| | j|< W q tk
r } ztjd| W Y dd}~X qX qW dS )zs
Initialize some limited config variables before initializing i18n and loading
extensions.
r_ r] rW rX z%sN)rb r Ú__dict__ri r{ ÚloggerÚwarning)r9 Ú variablesr" r~ r& r& r' Úpre_init_valuesÑ s
zConfig.pre_init_valuesc C sè | j }x¶| jj D ]¨\}}ypd|krH|jdd\}}||j|i |< wn || jkrdtjtd| wt |t
r| j ||||< n|||< W q t k
r¸ } ztjd| W Y d d }~X qX qW x$|D ] }|| jkrÄ|| | j
|< qÄW d S )NÚ.rM z-unknown config value %r in override, ignoringz%s)ri rb r1 rl Ú
setdefaultrh r r r r. r! r r{ r )r9 rJ Zvalnamer# Z realvalnamer6 r~ r" r& r& r' Ú init_valuesà s&
"
zConfig.init_valuesc C sD | j }x.|D ]&}|| jkr || jkr || | j|< q W td| dS )zc
Initialize additional config variables that are added after init_values() called.
N)ri r rh Úcheck_confval_types)r9 rJ r" r& r& r' Úpost_init_valuesö s
zConfig.post_init_values)r" r) c C sN |j drt||| jkr,ttd| | j| d }t|rJ|| S |S )Nr zNo such config value: %sr )Ú
startswithÚAttributeErrorrh r r} )r9 r" rK r& r& r' Ú __getattr__ s
zConfig.__getattr__c C s
t | |S )N)Úgetattr)r9 r" r& r& r' Ú __getitem__ s zConfig.__getitem__c C s t | || d S )N)Úsetattr)r9 r" r# r& r& r' Ú __setitem__ s zConfig.__setitem__c C s t | | d S )N)Údelattr)r9 r" r& r& r' Ú __delitem__ s zConfig.__delitem__c C s
|| j kS )N)rh )r9 r" r& r& r' Ú __contains__ s zConfig.__contains__c c s4 x.| j j D ] \}}t|t| ||d V q W d S )NrM )rh r1 r r )r9 r" r# r& r& r' Ú__iter__ s zConfig.__iter__)r" rK r% Útypesr) c C s0 || j kr ttd| n|||f| j |< d S )Nz Config value %r already present)rh r r )r9 r" rK r% r r& r& r' Úadd s
z
Config.add)r% r) c s" t tr g fdd| D S )Nc 3 s | ]}|j kr|V qd S )N)r% )r+ r# )r% r& r' r- $ s z Config.filter.<locals>.<genexpr>)r. r! )r9 r% r& )r% r' Úfilter! s
z
Config.filterc C s i }x4| j j D ]&\}}|jds6t| r.q|||< qW i |d< xB| jj D ]4\}}t| |}t|sld}||d df|d |< qNW |S )z'Obtains serializable data for pickling.r rh NrM )r r1 r r* rh r )r9 r r6 r# Ú
real_valuer& r& r' Ú __getstate__& s
zConfig.__getstate__)Ústater) c C s | j j| d S )N)r Úupdate)r9 r r& r& r' Ú __setstate__= s zConfig.__setstate__)NN)"r r r r= r! r r rf r r r: Ú classmethodr rv r r r r r r r r r$ r r r r r r r r
r r r r& r& r& r' r> B s
(
)
r> )rt rn r) c C s( i }| |d< ||d< t tj| ü y:t| d&}t|j | jtd}t|| W dQ R X W nº t k
r } z t
d}t || |W Y dd}~X n t k
rÈ } zt
d}t ||W Y dd}~X nR t k
rÜ Y n> t
k
r } z t
d}t |tj |W Y dd}~X nX W dQ R X |S ) zEvaluate a config file.Ú__file__rn Ú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Úcompilerv Úencoder r Ú SyntaxErrorr r Ú
SystemExitÚ ExceptionÚ tracebackÚ
format_exc)rt rn ru ÚfÚcodeÚerrÚmsgr~ r& r& r' rr A s( .rr r )ÚapprJ r) c C sr |j }t|tr t|di|_ nNt|ttfrDtdd |D |_ n*t|tr\t|j |_ ntjt d| dS )zConvert 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 fqS )Nr& )r+ Úsr& r& r' ú
<listcomp>m s z)convert_source_suffix.<locals>.<listcomp>zeThe config value `source_suffix' expects a string, list of strings, or dictionary. But `%r' is given.)
rZ r. r! r r2 r3 r0 r r r )r® rJ rZ r& r& r' Úconvert_source_suffix^ s
r± c C s2 |j }|r.tdd |j D r.|j|i|_ dS )zConvert 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 |tV qd S )N)r. r0 )r+ Úvr& r& r' r- ~ s z,convert_highlight_options.<locals>.<genexpr>N)r\ r5 rh r[ )r® rJ Úoptionsr& r& r' Úconvert_highlight_optionsw s r´ c C s4 t dt dt dt dd}|j|j ||_dS )z$Initialize :confval:`numfig_format`.z
Section %szFig. %szTable %sz
Listing %s)ÚsectionÚfigureÚtablez
code-blockN)r r r` )r® rJ r` r& r& r' Úinit_numfig_format s r¸ c C sF t ddk rBx4dD ],}||krdtd }tj||| ||< qW 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/
ZSOURCE_DATE_EPOCHNrS Úepub_copyrightz\g<1>%sz%Y)rS r¹ )r r Úcopyright_year_reÚsub)r® rJ ÚkÚreplacer& r& r' Úcorrect_copyright_year s
r¾ c
C s x|D ]}|j |j \}}}t|r0||}|dkr@| r@q|tkrJqt|tr|j|jstd}t j
|j |j|j|j ddd qt
|jt
|krqt
|j|kr®qtt
|jjt
|jf tt
|j@ }|jt |rèq|r`td}dd |D }t|d kr2d
j d j|dd
|d } n
d
j|} t j
|j |jt
|j| ddd qtd}t j
|j |jt
|jt
|ddd qW dS )zCheck all values for deviation from the default value's type, since
that can result in TypeErrors all over the place NB.
NzTThe config value `{name}` has to be a one of {candidates}, but `{current}` is given.)r" Úcurrentr8 T)ÚoncezNThe config value `{name}' has type `{current.__name__}'; expected {permitted}.c S s g | ]}d j |jqS )z`{}')Úformatr )r+ rE r& r& r' r° Á s z'check_confval_types.<locals>.<listcomp>rw z {}, or {}z, rM z or )r" r¿ Ú permittedzZThe config value `{name}' has type `{current.__name__}', defaults to `{default.__name__}'.)r" r¿ rK éÿÿÿÿrà )rh r" r} r r. r7 r< r# r r r rÁ r8 rz r4 Ú __bases__ÚdiscardÚobjectÚlenro )
r® rJ ZconfvalrK r% Ú annotationsr Z common_basesZwrapped_annotationsr r& r& r' r sL
r c C s2 |j }|r.| jj| r.tjtd| d |_ d S )Nz%primary_domain %r not found, ignored.)r^ ÚregistryZ
has_domainr r r )r® rJ r^ r& r& r' Úcheck_primary_domainÓ s rÊ r )r® r@ ÚaddedÚchangedÚremovedr) c C s> | j jdkr:d| jjkr:d| jjkr:tjtd d| j _|S )zjAdjust root_doc to 'contents' to support an old project which does not have
any root_doc setting.
rH ÚcontentszkSince v2.0, Sphinx uses "index" as root_doc by default. Please add "root_doc = 'contents'" to your conf.py.)rJ rY rQ Zdocnamesr r r )r® r@ rË rÌ rÍ r& r& r' Úcheck_root_docÚ s rÏ )r® r) c C sx | j dtdd | j dtdd | j dtdd | j dtdd | j dtdd | j dtdd | j dt ddddS )Nz
config-initedi )Úpriorityzenv-get-outdatedÚbuiltinT)rT Zparallel_read_safeZparallel_write_safe)Úconnectr± r´ r¸ r¾ r rÊ rÏ )r® r& r& r' rc é s rc )Dr= Úrer¨ r Ú collectionsr Úosr r Útypingr r r r r r
r r r
r r r Z
sphinx.errorsr r Z
sphinx.localer r Z sphinx.utilr Zsphinx.util.i18nr Zsphinx.util.osutilr r Zsphinx.util.tagsr Zsphinx.util.typingr Zsphinx.applicationr Zsphinx.environmentr Ú getLoggerr r rp rz Ú
ModuleTypeÚ FunctionTyper/ r£ rº r r$ r* r7 r> r! rr r± r´ r¸ r¾ r rÊ rÏ rc r& r& r& r' Ú<module> sH 8
7