o Ni @sdZddlmZddlZddlZddlZddlmZddlm Z ddl m Z ddl Z ddl mZmZe rHddlmZmZdd lmZdd l mZd d gZdBddZe jdddCddZGdddZe jdDd#d$Zed"d%Ze jdEd&dZe jdFd*d+Ze jdGd.d/Ze jdGd0d1Z e jdHd3d'Z!e jdId4dZ"e jd5d6d7dJd8d9Z#e jdKd:d;Z$e jdddLd>dZ%e jdMd@dAZ&dS)NzSphinx test fixtures for pytest) annotationsN) namedtuple)StringIO) TYPE_CHECKING) SphinxTestApp#SphinxTestAppWrapperForSkipBuilding)CallableIterator)Path)Anyzsphinx(buildername="html", *, testroot="root", srcdir=None, confoverrides=None, freshenv=False, warningiserror=False, tags=None, verbosity=0, parallel=0, builddir=None, docutils_conf=None): arguments to initialize the sphinx test application.z0test_params(shared_result=...): test parameters.config pytest.ConfigreturnNonecCstD]}|d|qdS)zRegister custom markersmarkersN)DEFAULT_ENABLED_MARKERSaddinivalue_line)r markerrK/home/ubuntu/.local/lib/python3.10/site-packages/sphinx/testing/fixtures.pypytest_configure&srsession)scope Path | NonecCsdSNrrrrrrootdir,src@s.eZdZUiZded<dd d Zdd d ZdS) SharedResultzdict[str, dict[str, str]]cachekeystrapp_rrr cCs2||jvrdS|j|jd}||j|<dS)Nstatuswarning)rr"getvaluer#)selfrr datarrrstore4s zSharedResult.storedict[str, StringIO]cCs2||jvriS|j|}t|dt|ddS)Nr"r#r!)rr)r%rr&rrrrestore=s    zSharedResult.restoreN)rrr rrr )rrrr()__name__ __module__ __qualname__r__annotations__r'r)rrrrr1s   rrequestr test_paramsdict[str, Any] shared_resultsphinx_test_tempdirrr _app_paramsc sii}tt|jdD]}tt|jO||jqfddt D}|drNd|vr]szapp_params..r1srcdirz:You can not specify shared_result and srcdir in same time.testrootrootztest-)reversedlistnode iter_markersdict enumerateargsupdatekwargssortedkeyspytestfailr)popgetexistsshutilcopytreer3) r.r/r1r2rrEinforCmsgr)r;r: testroot_pathrr7r app_paramsGs&        rRz args,kwargscCsT|jd}|r |jni}ddi}|||dr(t|dts(d}t||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/r1Nz?You can only provide a string type of value for "shared_result")r?get_closest_markerrErD isinstancerrH Exception)r.envrEresultrPrrrr/xs   make_appCallable[[], SphinxTestApp]Iterator[SphinxTestApp]ccs|\}}||i|}|Vtd|ddtd|jjtd|jtd|jtdd|jtd d|j|d rM| |d |d Sd S) z9 Provides the 'sphinx.application.Sphinx' object z # testroot:r;r<z # builder:z # srcdir:z # outdir:z # status: z # warning:r1N) printrKbuildernamer:outdirr"r$r#r')r/rRrXr1rCrEr rrrapps   r`rrcC|jSzJ Back-compatibility for testing with previous @with_app decorator )r"r`rrrr"r"cCrarb)r#rcrrrr#rdr#%Iterator[Callable[[], SphinxTestApp]]c#sNgtj}d fdd }|V|tjdd<tD]}|qdS) 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. rCr rErrcsZtt}}|d||d|drt|i|}nt|i|}||S)Nr"r#r1)r setdefaultrrappend)rCrEr"r#r appsr/rrmakes   zmake_app..makeN)rCr rEr rr)syspathcopyr=cleanup)r/syspathrjr rrhrrXs    cCstSr)rrrrrr1smoduleT)rautousecCstjdSr)rrclearrrrr_shared_result_cachesrscCsRt|jdd}z|rtj|dgdddWdSWn ty!YnwtddS) zt The test will be skipped when using 'if_graphviz_found' fixture and graphviz dot command is not found. graphviz_dotz-VTF)capture_outputcheckNzgraphviz "dot" is not available)getattrr subprocessrunOSErrorrHskip)r`rtrrrif_graphviz_founds r}tmp_path_factorypytest.TempPathFactorycCs|S)zTemporary directory.) getbasetemp)r~rrrr2sIterator[None]c csdttj}zdVWttjD] }||vrtj|qdSttjD] }||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>rkmodulesrJ) sysmodulesmodnamerrrrollback_sysmoduless   r)r r rr)rr) r.r r/r0r1rr2rrr rr3)r.r rr0) r/r0rRr3rXrYr1rrrZ)r`rrr)r/r0rre)rr)rr)r`rrr)r~rrr )rr)'__doc__ __future__rrMryrk collectionsriortypingrrHsphinx.testing.utilrrcollections.abcrr pathlibr r rrfixturerrrRr3r/r`r"r#rXr1rsr}r2rrrrrsX           -