3
T'íc ã @ s d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlm Z m
Z
m Z m Z m
Z
ddlZddlmZ ddlmZmZ d d
gZd d Zejd
dedddZG dd dZeje e eeee
e e f dddZeje e dddZejdde e
e e f e
ee eddf dd d Z ejddeed d d Z ejddeed d!d"Z ej e e e e
ddf d#d$d%Z ejedd&d'Z ejd(d)d*ddd+d,Z!ejedd d-d.Z"ejd
de d/d0d1d2Z#ejed/d3d4d5Z$ejd6d7 Z%dS )8z Sphinx test fixtures for pytesté 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 xt D ]}| jd| qW dS )zRegister custom markersÚmarkersN)ÚDEFAULT_ENABLED_MARKERSZaddinivalue_line)ÚconfigÚmarker© r ú9/tmp/pip-build-gk9425m9/sphinx/sphinx/testing/fixtures.pyÚpytest_configure s
r Úsession)Úscope)Úreturnc C s d S )Nr r r r r Úrootdir s r c @ sP e Zd ZU i Zeeeeef f eeedddZeeee f dddZ
dS )Ú SharedResult)ÚkeyÚapp_r c C s2 || j krd S |jj |jj d}|| j |< d S )N)ÚstatusÚwarning)ÚcacheÚ_statusÚgetvalueÚ_warning)Úselfr r Údatar r r Ústore& s
zSharedResult.store)r r c C s2 || j kri S | j | }t|d t|d dS )Nr r )r r )r r )r! r r" r r r Úrestore/ s
zSharedResult.restoreN) Ú__name__Ú
__module__Ú __qualname__r r Ústrr r r# r r$ r r r r r # s
r )ÚrequestÚ test_paramsÚ
shared_resultÚsphinx_test_tempdirr r c s, t | jdr| jjd}n | jjd}i i }|dk rxx@tt|D ]0}x t|jD ]\}} | |< qTW |j|j qDW fddt
j D }
|d rÐd|kr¬t j
d|d |d< |j|d } |j| |jd d
} ||jd| |d< }
|r |
j r |d | }|j|
td d
|
|S )zp
Parameters that are specified by 'pytest.mark.sphinx' for
sphinx.application.Sphinx initialization
Ú iter_markersZsphinxNc s g | ] } | qS r r )Ú.0Úi)Úpargsr r ú
<listcomp>Q 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Únoder- Ú
get_markerÚreversedÚlistÚ enumerateÚargsÚupdateÚkwargsÚsortedÚkeysÚpytestÚ Exceptionr$ ÚpopÚgetÚexistsÚcopytreer )r) r* r+ r, r r
r> Úinfor/ Úar< r$ r3 r2 Z
testroot_pathr )r0 r r5 9 s.
r5 )r) r c C sl t | jdr| jjd}n | jjd}|r0|jni }ddi}|j| |d rht|d t rhtj 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" )
r6 r7 rI r8 r> r= Ú
isinstancer( rA rB )r) Úenvr> Úresultr r r r* i s
r* Úfunction)r* r5 Úmake_appr+ r c c s |\}}|||}|V t d|jdd t d|jj t d|j t d|j t dd|jj t d d|jj | d
r|j | d
| d S ) z9
Provides the 'sphinx.application.Sphinx' object
z # testroot:r3 r4 z
# builder:z # srcdir:z # outdir:z # status:Ú
z
# warning:r+ N)
ÚprintrD ZbuilderÚnamer2 Zoutdirr r r r# )r* r5 rN r+ r< r> r r r r Úapp s
rR )rR r c C s | j S )zJ
Back-compatibility for testing with previous @with_app decorator
)r )rR r r r r s r c C s | j S )zJ
Back-compatibility for testing with previous @with_app decorator
)r )rR r r r r ¡ s r )r* Ú monkeypatchr c # sb |j ddd g tjdd
} fdd}|V |tjdd
< xt D ] }|j qNW 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 )Nr )Úxr r r Ú<lambda>° s zmake_app.<locals>.<lambda>Nc sN t t }}|jd| |jd| t| |} j| d rJt|}|S )Nr r r+ )r Ú
setdefaultr Úappendr )r< r> r r r )Úappsr* r r Úmakeµ s
zmake_app.<locals>.make)ÚsetattrÚsysÚpathr9 Úcleanup)r* rS ZsyspathrY r r )rX r* r rN © s rN c C s t S )N)r r r r r r+ Å s r+ ÚmoduleT)r Zautousec C s t jj d S )N)r r Úclearr r r r Ú_shared_result_cacheÊ s r` c C sR t | jdd}y |r,tj|dgttd dS W n tk
rB Y nX tjd 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 ÚOSErrorrA Úskip)rR ra r r r Úif_graphviz_foundÏ s rj z util.path)Útmpdir_factoryr c C s | j }tj|j S )z8
Temporary directory wrapped with `path` class.
)Z getbasetempr
r\ Úabspath)rk Útmpdirr r r r, à s r, )rm r c C s
t j| S )z
Temporary directory wrapped with `path` class.
This fixture is for back-compatibility with old test implementation.
)r
r\ )rm r r r Útempdiré s rn c c sD zt tj} dV W dx&t tjD ]}|| kr"tjj| q"W X dS )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: r[ ÚmodulesrC )Z
sysmodulesÚmodnamer r r Úrollback_sysmodulesò s
rq )&Ú__doc__rf r[ Ú collectionsr Úior r Útypingr r r r r rA Zsphinx.testingr
Zsphinx.testing.utilr r r r Zfixturer( r r r5 r* rR r r rN r+ r` rj r, rn rq r r r r Ú<module> sP
.