U \ShT@sdZddlmZddlZddlZddlmZddlmZddl m Z m Z m Z ddl Z ddlmZddlmZmZd d gZd d Ze jd dddddZGdddZe dddddddddZe dddddZe jddddd dd!d"d#d$Ze jddd%d&d'd(d)Ze jddd%d&d'd*d+Ze ddd,d-d.d/Ze ddd0d1Ze jd2d3d4d5dd6d7Ze d%d5d'd8d9Z e jd ddd:d;dd?d@Z"e dAdBZ#dS)CzSphinx test fixtures for pytest) annotationsN) namedtuple)StringIO)AnyCallable Generator)util) SphinxTestApp#SphinxTestAppWrapperForSkipBuildingzsphinx(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.cCstD]}|d|qdS)zRegister custom markersmarkersN)DEFAULT_ENABLED_MARKERSZaddinivalue_line)configmarkerrJ/root/rtd-docs/venv/lib/python3.8/site-packages/sphinx/testing/fixtures.pypytest_configuresrsession)scopez str | None)returncCsdSNrrrrrrootdirsrc@s<eZdZUiZded<ddddddZdd d d d Zd S) SharedResultzdict[str, dict[str, str]]cachestrr r)keyapp_rcCs2||jkrdS|j|jd}||j|<dS)Nstatuswarning)r_statusgetvalue_warning)selfrrdatarrrstore's  zSharedResult.storezdict[str, StringIO])rrcCs2||jkriS|j|}t|dt|ddS)Nrrr)rr)r"rr#rrrrestore0s     zSharedResult.restoreN)__name__ __module__ __qualname__r__annotations__r$r%rrrrr$s   rrdictrztuple[dict, dict])request test_params shared_resultsphinx_test_tempdirrrcsii}tt|jdD],}t|jD]\}}||<q*||jqfddt D} |drd|kr~t d|d|d<| |d} || | dd} ||d| |d<} |r| s|d | } | | td d | |S) zp Parameters that are specified by 'pytest.mark.sphinx' for sphinx.application.Sphinx initialization Zsphinxcsg|] }|qSrr).0iZpargsrr Mszapp_params..r-srcdirz:You can not specify shared_result and srcdir in same time.testrootrootztest- app_paramsz args,kwargs)reversedlistnodeZ iter_markers enumerateargsupdatekwargssortedkeyspytest Exceptionr%popgetexistscopytreer)r+r,r-r.rr=infor0ar;r%r4r3Z testroot_pathrr1rr6:s&         r6)r+rcCsP|jd}|r|jni}ddi}|||drLt|dtsLtd|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. r,r-Nz@You can only provide a string type of value for "shared_result" )r9Zget_closest_markerr=r< isinstancerr@rA)r+envr=resultrrrr,es   r,functionrz$Generator[SphinxTestApp, None, None])r,r6make_appr-rccs|\}}|||}|Vtd|ddtd|jjtd|jtd|jtdd|jtd d|j|d r| |d |d S) z9 Provides the 'sphinx.application.Sphinx' object z # testroot:r4r5z # builder:z # srcdir:z # outdir:z # status: z # warning:r-N) printrCZbuildernamer3Zoutdirrr r!r$)r,r6rLr-r;r=rrrrapp}s   rPr r)rPrcCs|jSzJ Back-compatibility for testing with previous @with_app decorator )rrPrrrrsrcCs|jSrQ)r!rRrrrrsrzGenerator[Callable, None, None])r, monkeypatchrc#s^|dddgtjdd}fdd}|V|tjdd<tD] }|qLdS)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.abspathcSs|Srr)xrrrzmake_app..NcsNtt}}|d||d|t||}|drJt|}|S)Nrrr-)r setdefaultr appendr )r;r=rrrZappsr,rrmakes    zmake_app..make)setattrsyspathr7cleanup)r,rSZsyspathrZrrrYrrLs  rLcCstSr)rrrrrr-sr-moduleT)rZautouseNonecCstjdSr)rrclearrrrr_shared_result_cachesrbcCsRt|jdd}z |r,tj|dgddWdSWntk rBYnXtddS)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 subprocessrunOSErrorr@skip)rPrcrrrif_graphviz_founds rkz util.path)tmpdir_factoryrcCs|}t|S)z8 Temporary directory wrapped with `path` class. )Z getbasetemprr]abspath)rltmpdirrrrr.sr.)rnrcCs t|S)z Temporary directory wrapped with `path` class. This fixture is for back-compatibility with old test implementation. )rr])rnrrrtempdirsroc cs@zttj}dVW5ttjD]}||kr tj|q XdS)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)r8r\modulesrB)modnameZ sysmodulesrrrrollback_sysmoduless   rr)$__doc__ __future__rrgr\ collectionsriortypingrrrr@Zsphinx.testingrZsphinx.testing.utilr r r rZfixturerrr6r,rPrrrLr-rbrkr.rorrrrrrsP      *