File: //usr/lib/python3/dist-packages/sphinx/testing/__pycache__/fixtures.cpython-310.pyc
o
�$�aA � @ s$ d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlm Z m
Z
m Z m Z m
Z
ddlZddlmZ ddlmZmZ d d
gZd d � Zejd
d�defdd��ZG dd� d�Zejde de dededede
e e f f dd��Zejde de fdd��Zejdd�de de
e e f d e
dede eddf f
d d ��Z ejdd�d edefd d ��Z ejdd�d edefd!d"��Z e�� de d#e de e
ddf fd$d ��Z ejdefd%d��Z ejd&d'd(�d5d)d*��Z!ejd eddfd+d,��Z"ejd
d�d-e dd.fd/d��Z#ejd0edd.fd1d2��Z$ejd3d4� �Z%dS )6z�
sphinx.testing.fixtures
~~~~~~~~~~~~~~~~~~~~~~~
Sphinx test fixtures for pytest
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�
namedtuple)�StringIO)�PIPE)�Any�Callable�Dict� Generator�Tuple)�util)�
SphinxTestApp�#SphinxTestAppWrapperForSkipBuildingz�sphinx(builder, testroot=None, freshenv=False, confoverrides=None, tags=None, docutilsconf=None, parallel=0): arguments to initialize the sphinx test application.z0test_params(shared_result=...): test parameters.c C s t D ]}| �d|� qdS )zRegister custom markers�markersN)�DEFAULT_ENABLED_MARKERS�addinivalue_line)�config�marker� r �9/usr/lib/python3/dist-packages/sphinx/testing/fixtures.py�pytest_configure s �r �session)�scope�returnc C s d S �Nr r r r r �rootdir& s r c @ sZ e Zd ZU i Zeeeeef f ed< dededefdd�Z dedeee
f fdd�Z d S )
� SharedResult�cache�key�app_r c C s2 || j v rd S |j�� |j�� d�}|| j |< d S )N��status�warning)r �_status�getvalue�_warning)�selfr r �datar r r �store. s
�zSharedResult.storec C s2 || j vri S | j | }t|d �t|d �d�S )Nr r r )r r )r$ r r% r r r �restore7 s
�zSharedResult.restoreN) �__name__�
__module__� __qualname__r r �str�__annotations__r r r& r r' r r r r r + s
r �request� test_params�
shared_result�sphinx_test_tempdirc s t | jd�r
| j�d�}n| j�d�}i � i }|dur8tt|��D ]}t|j�D ]\}} | � |< q(|�|j � q!� fdd�t
� � � �D �}
|d rdd|v rRt �
d��|d |d< |�|d �} |�| � |�d d
�} ||�d| � |d< }
|r�|
�� s�|d | }|�|
� td d
�|
|�S )zp
Parameters that are specified by 'pytest.mark.sphinx' for
sphinx.application.Sphinx initialization
� iter_markers�sphinxNc s g | ]}� | �qS r r )�.0�i��pargsr r �
<listcomp>Y s z app_params.<locals>.<listcomp>r/ �srcdirz:You can not specify shared_result and srcdir in same time.�testroot�rootztest-�
app_paramsz args,kwargs)�hasattr�noder1 �
get_marker�reversed�list� enumerate�args�update�kwargs�sorted�keys�pytest� Exceptionr' �pop�get�exists�copytreer )r- r. r/ r0 r r
rD �infor4 �arB r' r9 r8 �
testroot_pathr r5 r r; A s.
r; c C sj t | jd�r
| j�d�}n| j�d�}|r|jni }ddi}|�|� |d r3t|d t�s3t� d��|S )au
Test parameters that are specified by 'pytest.mark.test_params'
:param Union[str] shared_result:
If the value is provided, app._status and app._warning objects will be
shared in the parametrized test functions and/or test functions that
have same 'shared_result' value.
**NOTE**: You can not specify both shared_result and srcdir.
�get_closest_markerr. r/ Nz@You can only provide a string type of value for "shared_result" )
r< r= rP r> rD rC �
isinstancer+ rG rH )r- �envrD �resultr r r r. q s �
�function�make_appc c s� � |\}}||i |��}|V t d|�dd�� t d|jj� t d|j� t d|j� t dd|j�� � t d d|j�� � | d
rM|� | d
|� d S d S ) z9
Provides the 'sphinx.application.Sphinx' object
z # testroot:r9 r: z
# builder:z # srcdir:z # outdir:z # status:�
z
# warning:r/ N)
�printrJ �builder�namer8 �outdirr! r" r# r& )r. r; rU r/ rB rD r r r r �app� s � �r[ c C � | j S �zJ
Back-compatibility for testing with previous @with_app decorator
)r! �r[ r r r r � � r c C r\ r] )r# r^ r r r r � r_ r � monkeypatchc # s` � |� ddd� � g � tjdd� }� �fdd�}|V |tjdd�< t� �D ]}|�� q'dS )z�
Provides make_app function to initialize SphinxTestApp instance.
if you want to initialize 'app' in your test function. please use this
instead of using SphinxTestApp class directory.
zsphinx.application.abspathc S s | S r r )�xr r r �<lambda>� s zmake_app.<locals>.<lambda>Nc sR t � t � }}|�d|� |�d|� t| i |��}� �|� �d r't|�}|S )Nr r r/ )r �
setdefaultr �appendr )rB rD r r r ��appsr. r r �make� s
zmake_app.<locals>.make)�setattr�sys�pathr? �cleanup)r. r` �syspathrg r r re r rU � s �
�c C s t � S r )r r r r r r/ � s �moduleT)r �autousec C s t j�� d S r )r r �clearr r r r �_shared_result_cache� s rp c C sR t | jdd�}z|rtj|dgttd� W dS W n ty! Y nw t�d� dS )zt
The test will be skipped when using 'if_graphviz_found' fixture and graphviz
dot command is not found.
� graphviz_dot� z-V)�stdout�stderrNz graphviz "dot" is not available)�getattrr �
subprocess�runr �OSErrorrG �skip)r[ rq r r r �if_graphviz_found� s � �rz �tmpdir_factoryz util.pathc C s | � � }t�|��� S )z8
Temporary directory wrapped with `path` class.
)� getbasetempr
rj �abspath)r{ �tmpdirr r r r0 � s r~ c C s
t �| �S )z�
Temporary directory wrapped with `path` class.
This fixture is for back-compatibility with old test implementation.
)r
rj )r~ r r r �tempdir� s
r c
c sd � z t tj�} dV W t tj�D ] }|| vr tj�|� qdS t tj�D ] }|| vr0tj�|� q$w )z�
Rollback sys.modules to its value before testing to unload modules
during tests.
For example, used in test_ext_autosummary.py to permit unloading the
target module to clear its cache.
N)r@ ri �modulesrI )�
sysmodules�modnamer r r �rollback_sysmodules� s �
�� ��r� )r N)&�__doc__rv ri � collectionsr �ior r �typingr r r r r rG �sphinx.testingr
�sphinx.testing.utilr r r r �fixturer+ r r r; r. r[ r r rU r/ rp rz r0 r r� r r r r �<module> sf
�
��
�/
� �
"