|
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�! � @ s d Z ddlZddlZddlZddlZddlmZ ddlmZmZm Z m
Z
ddl m Z ddl
Z
ddlmZ ddlmZ ddlmZ dd lmZ dd
lmZ erTdd lmZ e�e�Z e � Z d Z d
e de ddfdd�Z!G dd� d�Z"d
e de#fdd�Z$G dd� d�Z%dS )z�
sphinx.theming
~~~~~~~~~~~~~~
Theming support for HTML builders.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�path)�
TYPE_CHECKING�Any�Dict�List)�ZipFile)� package_dir)�
ThemeError)�__)�logging)� ensuredir)�Sphinxz
theme.conf�filename� targetdir�returnc
C s� t |� t| ��C}|�� D ]5}|�d�rq
t�||�}t t�|�� tt�|�d��}|�|� |�� W d � n1 s=w Y q
W d � dS 1 sNw Y 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/usr/lib/python3/dist-packages/sphinx/theming.py� extract_zip% s
���"�r c @ s� e Zd ZdZdededdddfdd �Zdee fd
d �Zefd eded
e de fdd�Z
i fde ee f de ee f fdd�Z ddd�Z
dS )�Themez�A Theme is a set of HTML templates and configurations.
This class supports both theme directory and theme archive (zipped theme).r �
theme_path�factory�HTMLThemeFactoryr Nc
C s* || _ d | _d | _t�|�rd | _|| _nt�d�| _t�| j|�| _t || j� t
� � | _ | j �
t�| jt�� z | j �dd�}W n+ t
jyX } z ttd�| �|�d }~w t
jym } z ttd�| �|�d }~ww |dkr�z |�|�| _W d S ty� } z ttd�||f �|�d }~ww d S )N�sxt�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__8 s@
��������zTheme.__init__c C s$ | j du r | jgS | jg| j �� S )z�Return 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: X s
zTheme.get_theme_dirs�section�defaultc
C s� z| j �||�W S tjtjfy@ } z(| jr%| j�|||�W Y d}~S |tu r4tt d�||f �|�|W Y d}~S d}~ww )zdReturn the value for a theme configuration setting, searching the
base theme chain.
Nz:setting %s.%s occurs in none of the searched theme configs)
r1 r3 r/ r5 r4 r) �
get_config� NODEFAULTr r
)r7 r< r r= r8 r r r r> a s ����zTheme.get_config� overridesc C s| | j r | j �� }ni }z |�| j�d�� W n
tjy Y nw |�� D ]\}}||vr7t�t d�| � q%|||< q%|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@ rA �option�valuer r r rB q s �
zTheme.get_optionsc C sB | j rzt�| j � W n ty Y nw | jr | j�� dS dS )z Remove temporary directories.N)r* �shutil�rmtree� Exceptionr) �cleanupr; r r r rL � s ��z
Theme.cleanup�r N)�__name__�
__module__� __qualname__�__doc__�strr9 r r: r? r r> r rB rL r r r r r! 3 s &r! c C sR z t | ��}t|�� v W d � W S 1 sw Y W dS ty( Y dS w )zBCheck whether the specified file is an archived theme file or not.NF)r r2 r rK )r �fr r r �is_archived_theme� s
(� �rT c @ s� e Zd ZdZddd�Zd dd �Zd
eddfd d �Zd
eddfdd�Zd dd�Z d dd�Z
d
eddfdd�Z dede eef fdd�Z
d
edefdd�ZdS ) r$ z A factory class for HTML Themes.�appr
r Nc C s< || _ |jj| _| �� t|jdd �r | �|jj� d S d S )N�html_theme_path) rU �registry� html_themes�themes�load_builtin_themes�getattrr1 �load_additional_themesrV )r7 rU r r r r9 � s
�zHTMLThemeFactory.__init__c C s2 | � t�td��}|�� D ] \}}|| j|< q
dS )zLoad built-in themes.rY N)� find_themesr r r rD rY )r7 rY r r& r r r rZ � s �z$HTMLThemeFactory.load_builtin_themes� theme_pathsc C sJ |D ] }t �t �| jj|��}| �|�}|�� D ] \}}|| j|< qqdS )z7Load additional themes placed at specified directories.N)r �abspathr rU �confdirr] rD rY )r7 r^ r" �abs_theme_pathrY r r& r r r r\ � s
��z'HTMLThemeFactory.load_additional_themesr c C s" |dkr
| � � dS | �|� 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 }t�|�� d�| jd< dS )zLoad alabaster theme.r Nrb )rb r r �get_pathrY )r7 rb r r r rc � s z%HTMLThemeFactory.load_alabaster_themec C s> zddl }|�� }t�|d�| jd< W dS ty Y dS w )z+Load sphinx_rtd_theme theme (if installed).r N�sphinx_rtd_theme)rh �get_html_theme_pathr r rY � ImportError)r7 rh r" r r r �load_sphinx_rtd_theme� s �z&HTMLThemeFactory.load_sphinx_rtd_themec C sD t �d|�}zt|�}| jj�| j|j� W dS ty! Y dS w )zjTry to load a theme using entry_points.
Sphinx refers to ``sphinx_themes`` entry_points.
zsphinx.html_themesN)�
pkg_resources�iter_entry_points�nextrU rW �load_extension� module_name�
StopIteration)r7 r � entry_points� entry_pointr r r rd � s �z$HTMLThemeFactory.load_external_themer" c C s� i }t �|�s |S t�|�D ]9}t �||�}t �|�r:|�� �d�r:t|�r1|dd� }|||< qt �
t d�|� qt �t �|t ��rG|||< q|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 rT rE rF r
r2 )r7 r" rY r �pathnamer r r r r] � s
��z HTMLThemeFactory.find_themesc C sj || j vr
| �|� || j vr |dkr t�td�� | �� || j vr+ttd�| ��t|| j | | d�S )z Create an instance of theme.rh 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# )rY rf rE rF r
rk r r! re r r r r6 � s
zHTMLThemeFactory.create)rU r
r NrM )rN rO rP rQ r9 rZ rR r\ rf rc rk rd r r] r! r6 r r r r r$ � s
r$ )&rQ r/ ru rI r- r �typingr r r r �zipfiler rl �sphinxr �
sphinx.errorsr �
sphinx.localer
� sphinx.utilr �sphinx.util.osutilr �sphinx.applicationr
� getLoggerrN rE �objectr? r2 rR r r! �boolrT r$ r r r r �<module> s.
]