3
T'íc! ã @ s( d Z ddlZddlZddlZddlZddlmZ ddlmZmZm Z m
Z
ddl m Z yddl
mZ W n ek
r ddlmZ Y nX ddlmZ ddlmZ dd lmZ dd
lmZ dd lmZ erÒdd lm Z ej e Z e Z!d
Z"e#e#ddddZ$G dd dZ%e#e&dddZ'G dd dZ(dS )z"Theming support for HTML builders.é N)Úpath)Ú
TYPE_CHECKINGÚAnyÚDictÚList)ÚZipFile)Ú entry_points)Ú package_dir)Ú
ThemeError)Ú__)Úlogging)Ú ensuredir)ÚSphinxz
theme.conf)ÚfilenameÚ targetdirÚreturnc C s t | t| j}xb|j D ]V}|jdr,q tj||}t tj| ttj|d}|j|j | W dQ R X q W W dQ R X dS )z%Extract zip file to target directory.ú/ÚwbN)
r
r ÚnamelistÚendswithr ÚjoinÚdirnameÚopenÚwriteÚread)r r ÚarchiveÚnameÚentryÚfp© r ú0/tmp/pip-build-gk9425m9/sphinx/sphinx/theming.pyÚ extract_zip s
r! c @ s e Zd ZdZeedddddZee ddd Zefeee e d
d d Z
i fe ee f e ee f d
ddZ ddddZ
dS )ÚThemezA Theme is a set of HTML templates and configurations.
This class supports both theme directory and theme archive (zipped theme).ÚHTMLThemeFactoryN)r Ú
theme_pathÚfactoryr c C sJ || _ d | _d | _tj|r*d | _|| _n(tjd| _tj| j|| _t || j t
j | _ | j j
tj| jt y| j jdd}W nj t
jk
rº } zttd| |W Y d d }~X n6 t
jk
rî } zttd| |W Y d d }~X nX |dkrFy|j|| _W n: tk
rD } z ttd||f |W Y d d }~X nX d S )NZsxtÚthemeÚinheritz%theme %r doesn't have "theme" settingz'theme %r doesn't have "inherit" settingÚnonez(no theme named %r found, inherited by %r)r ÚbaseÚrootdirr ÚisdirÚthemedirÚtempfileÚmkdtempr r! Ú configparserÚRawConfigParserÚconfigr Ú THEMECONFÚgetÚNoSectionErrorr
r Ú
NoOptionErrorÚcreate)Úselfr r$ r% r' Úexcr r r Ú__init__3 s.
"$
zTheme.__init__)r c C s( | j dkr| jgS | jg| j j S dS )zReturn a list of theme directories, beginning with this theme's,
then the base theme's, then that one's base theme's, etc.
N)r) r, Úget_theme_dirs)r7 r r r r: S s
zTheme.get_theme_dirs)Úsectionr Údefaultr c C sx y| j j||S tjtjfk
rr } z@| jr>| jj|||S |tkr^tt d||f |n|S W Y dd}~X nX dS )zdReturn the value for a theme configuration setting, searching the
base theme chain.
z:setting %s.%s occurs in none of the searched theme configsN)
r1 r3 r/ r5 r4 r) Ú
get_configÚ NODEFAULTr
r )r7 r; r r< r8 r r r r= \ s zTheme.get_config)Ú overridesr c C s | j r| j j }ni }y|j| jjd W n tjk
rB Y nX x8|j D ],\}}||krrtjt d| qN|||< qNW |S )z6Return a dictionary of theme options and their values.Úoptionsz!unsupported theme option %r given)
r) Ú get_optionsÚupdater1 Úitemsr/ r4 ÚloggerÚwarningr )r7 r? r@ ÚoptionÚvaluer r r rA l s zTheme.get_optionsc C s@ | j r,ytj| j W n tk
r* Y nX | jr<| jj dS )z Remove temporary directories.N)r* ÚshutilÚrmtreeÚ Exceptionr) Úcleanup)r7 r r r rK s z
Theme.cleanup)Ú__name__Ú
__module__Ú __qualname__Ú__doc__Ústrr9 r r: r> r r= r rA rK r r r r r" . s $r" )r r c C s: y t | }t|j kS Q R X W n tk
r4 dS X dS )zBCheck whether the specified file is an archived theme file or not.NF)r r2 r rJ )r Úfr r r Úis_archived_theme s
rR c @ s¢ e Zd ZdZdddddZdddd Zedd
d d Zedd
ddZddddZ ddddZ
edd
ddZ ee eef dddZ
eed
ddZdS )r# z A factory class for HTML Themes.r N)Úappr c C s8 || _ |jj| _| j t|jdd r4| j|jj d S )NÚhtml_theme_path) rS ÚregistryZ html_themesÚthemesÚload_builtin_themesÚgetattrr1 Úload_additional_themesrT )r7 rS r r r r9 s
zHTMLThemeFactory.__init__)r c C s6 | j tjtd}x |j D ]\}}|| j|< q W dS )zLoad built-in themes.rV N)Ú find_themesr r r rC rV )r7 rV r r& r r r rW s z$HTMLThemeFactory.load_builtin_themes)Ú theme_pathsr c C sR xL|D ]D}t jt j| jj|}| j|}x |j D ]\}}|| j|< q4W qW dS )z7Load additional themes placed at specified directories.N)r Úabspathr rS ZconfdirrZ rC rV )r7 r[ r$ Zabs_theme_pathrV r r& r r r rY ¤ s
z'HTMLThemeFactory.load_additional_themes)r r c C s |dkr| j n
| j| dS )z,Try to load a theme with the specified name.Ú alabasterN)Úload_alabaster_themeÚload_external_theme)r7 r r r r Úload_extra_theme¬ s
z!HTMLThemeFactory.load_extra_themec C s" ddl }tj|j d| jd< dS )zLoad alabaster theme.r Nr] )r] r r Úget_pathrV )r7 r] r r r r^ ³ s z%HTMLThemeFactory.load_alabaster_themec C s@ y&ddl }|j }tj|d| jd< W n tk
r: Y nX dS )z+Load sphinx_rtd_theme theme (if installed).r NÚsphinx_rtd_theme)rb Zget_html_theme_pathr r rV Ú ImportError)r7 rb r$ r r r Úload_sphinx_rtd_theme¸ s z&HTMLThemeFactory.load_sphinx_rtd_themec C sP t dd}y,|| }| jjj| j|j | jjj dS tk
rJ Y nX dS )zjTry to load a theme using entry_points.
Sphinx refers to ``sphinx_themes`` entry_points.
zsphinx.html_themes)ÚgroupN)r rS rU Zload_extensionÚmoduler1 Zpost_init_valuesÚKeyError)r7 r Ztheme_entry_pointsZ entry_pointr r r r_ Á s
z$HTMLThemeFactory.load_external_theme)r$ r c C s i }t j|s|S xtj|D ]r}t j||}t j|rv|j jdrvt|rd|dd
}|||< qt j
t d| q t jt j|t r |||< q W |S )z'Search themes from specified directory.z.zipNé zAfile %r on theme path is not a valid zipfile or contains no themeéüÿÿÿ)
r r+ ÚosÚlistdirr ÚisfileÚlowerr rR rD rE r r2 )r7 r$ rV r Úpathnamer r r r rZ Ð s
z HTMLThemeFactory.find_themesc C sj || j kr| j| || j kr<|dkr<tjtd | j || j krVttd| t|| j | | dS )z Create an instance of theme.rb zKsphinx_rtd_theme (< 0.3.0) found. It will not be available since Sphinx-6.0z-no theme named %r found (missing theme.conf?))r% )rV r` rD rE r rd r
r" )r7 r r r r r6 å s
zHTMLThemeFactory.create)rL rM rN rO r9 rW rP rY r` r^ rd r_ r rZ r" r6 r r r r r# s r# ))rO r/ rj rH r- r Útypingr r r r Úzipfiler Zimportlib_metadatar rc Zimportlib.metadataZsphinxr Z
sphinx.errorsr
Z
sphinx.localer Z sphinx.utilr Zsphinx.util.osutilr
Zsphinx.applicationr Ú getLoggerrL rD Úobjectr> r2 rP r! r" ÚboolrR r# r r r r Ú<module> s2
]