Fe dZddlmZddlZddlZddlZddlmZddlm Z ddl m Z m Z m Z ddlZddlmZmZe r ddlmZdd lmZd d gZd Zej0d d"dZGddZej0 d#dZeddZej0d$dZej0 d%dZej0d&dZej0d&dZ ej0d'dZ!ej0d(dZ"ej0ddd)dZ#ej0d*dZ$ej0d d+d Z%ej0d!Z&y),zSphinx test fixtures for pytest) annotationsN) namedtuple)StringIO) TYPE_CHECKINGAnyCallable) SphinxTestApp#SphinxTestAppWrapperForSkipBuilding) Generator)Pathzsphinx(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>tD]}|jd|y)zRegister custom markersmarkersN)DEFAULT_ENABLED_MARKERSaddinivalue_line)configmarkers 9/usr/lib/python3/dist-packages/sphinx/testing/fixtures.pypytest_configurers!)3 623session)scopecyNrrrrootdirr#s rc,eZdZUiZded<ddZddZy) SharedResultzdict[str, dict[str, str]]cachec||jvry|jj|jjd}||j|<y)Nstatuswarning)r_statusgetvalue_warning)selfkeyapp_datas rstorezSharedResult.store+sG $**  ll++-}}--/  3rcz||jvriS|j|}t|dt|ddS)Nr!r"r )rr)r&r'r)s rrestorezSharedResult.restore4sB djj Izz#tH~.Y0  rN)r'strr(r returnr)r'r-r.zdict[str, StringIO])__name__ __module__ __qualname__r__annotations__r*r,rrrrr(s')E $) rr _app_paramsci}i}tt|jjdD]?}t |j D] \}} | ||< |j |jAt|jDcgc]}|| } }|drHd|vrd} tj| |d|d<|j|d} |j | |jdd} ||jd| z x|d<}|r.|js|d| zz }t!j"||t%| |Scc}w)zp Parameters that are specified by 'pytest.mark.sphinx' for sphinx.application.Sphinx initialization sphinx shared_resultsrcdirz:You can not specify shared_result and srcdir in same time.testrootrootztest-)reversedlistnode iter_markers enumerateargsupdatekwargssortedkeyspytest Exceptionr,popgetexistsshutilcopytreer3)request test_paramsr6sphinx_test_tempdirrpargsrAinfoiar?msgr,r8r7 testroot_paths r app_paramsrT>sV EFgll77ABC#dii( DAqE!H  dkk"# %UZZ\2 3E!H 3D 3?# v NC""3' '&7x'' O(DE gzz*f-H 3fjj86T TTF8vv}}7X#56  v. tV $$+ 4s Ez args,kwargsc|jjd}|r |jni}ddi}|j||dr*t |dt sd}t j||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. rLr6Nz?You can only provide a string type of value for "shared_result")r<get_closest_markerrAr@ isinstancer-rDrE)rKenvrAresultrRs rrLrLlsp ,, ) )- 8CSZZBFF MM& oz&2I3'OOs## Mrc#K|\}}||i|}|td|jddtd|jjtd|jtd|j tdd|j jztd d|jjz|d r|j|d |y y w) z9 Provides the 'sphinx.application.Sphinx' object z # testroot:r8r9z # builder:z # srcdir:z # outdir:z # status: z # warning:r6N) printrGbuildernamer7outdirr#r$r%r*)rLrTmake_appr6r?rAr(s rappras LD& T $V $D J -J78 , ))* +t{{# +t{{# +tdll33556 ,t}}55778?#K8$?$sC$C&c|jSzJ Back-compatibility for testing with previous @with_app decorator )r#ras rr!r!s ;;rc|jSrc)r%rds rr"r"s <<rc#Kgtjdd}fd}||tjddtD]}|jyw)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. Nctt}}|jd||jd|t|i|}j|dr t |}|S)Nr!r"r6)r setdefaultr appendr )r?rAr!r"r(appsrLs rmakezmake_app..makesb"*hj(F+)W-!4262 D  '6trmoduleT)rautousec@tjjyr)rrclearrrr_shared_result_cachervsrct|jdd} |rtj|dgdy t j dy#t$rY!wxYw)zt The test will be skipped when using 'if_graphviz_found' fixture and graphviz dot command is not found. graphviz_dotz-VT)capture_outputNzgraphviz "dot" is not available)getattrr subprocessrunOSErrorrDskip)rarxs rif_graphviz_foundrs\ 3::~r:L  NNL$/ E    KK12    sA AAc"|jS)zTemporary directory.) getbasetemp)tmp_path_factorys rrMrMs  ' ' ))rc#ZK ttj}dttjD]&}||vstjj|(y#ttjD]&}|vstjj|(wxYww)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;rlmodulesrF) sysmodulesmodnames rrollback_sysmodulesrs|)#++&  CKK( )Gj( ( )tCKK( )Gj( ( )s'B+A$ B+"B+$!B("B((B+)r.z str | None) rKrrLdictr6rrMr-rr-r.r3)rKrr.r) rLrrTztuple[dict, dict]r`rr6rr.z$Generator[SphinxTestApp, None, None])rar r.r)rLrrorr.zGenerator[Callable, None, None])r.r)r.None)rar r.r)rrr.r )'__doc__ __future__rrIr|rl collectionsriortypingrrrrDsphinx.testing.utilr r collections.abcr pathlibr rrfixturerrrTr3rLrar!r"r`r6rvrrMrrrrrs%"  "// R) `7 3 i !  ,'%$''%25'%:E'%'%T 6 .@#@(L@@(2h-. 3 3 i *!* ))r