}c1dZddlZddlZddlmZddlmZddlmZddlm Z m Z m Z m Z m Z ddlZddlmZddlmZmZd d gZd Zejd defdZGddZejde de dededede e e ff dZejde de fdZejd de de e e fde dede eddff dZejd dedefdZejd dedefdZejde d e de e ddffd!Zejdefd"Z ejd#d$%d.d&Z!ejdeddfd'Z"ejd d(e dd)fd*Z#ejd+edd)fd,Z$ejd-Z%dS)/zSphinx test fixtures for pytestN) namedtuple)StringIO)PIPE)AnyCallableDict GeneratorTuple)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.cFtD]}|d|dS)zRegister custom markersmarkersN)DEFAULT_ENABLED_MARKERSaddinivalue_line)configmarkers 7lib/python3.11/site-packages/sphinx/testing/fixtures.pypytest_configurers4)33 6222233session)scopereturncdSNrrrrootdirrs 4rcreZdZUiZeeeeeffed<dededefdZ dedeee ffdZ dS) SharedResultcachekeyapp_rc||jvrdS|j|jd}||j|<dS)Nstatuswarning)r _statusgetvalue_warning)selfr!r"datas rstorezSharedResult.store&sU $*   Fl++--}--//   3rc||jvriS|j|}t|dt|ddS)Nr%r&r$)r r)r*r!r+s rrestorezSharedResult.restore/sN dj  Iz#tH~..Y00   rN) __name__ __module__ __qualname__r rstr__annotations__r rr,rr.rrrrr#s')E4T#s(^# $)))Mc 3 4X #6      rrrequest test_params shared_resultsphinx_test_tempdirrcii}tt|jdD];}t |jD] \}}||< ||j<fdt D} |drSd|vrtj d|d|d<| |d} || | dd} ||d| z x|d<} |r1| s|d| zz } | | t#d d | |S) zp Parameters that are specified by 'pytest.mark.sphinx' for sphinx.application.Sphinx initialization sphinxc g|] }| Srr).0ipargss r zapp_params..Ls 3 3 3E!H 3 3 3rr6srcdirz:You can not specify shared_result and srcdir in same time.testrootrootztest- app_paramsz args,kwargs)reversedlistnode iter_markers enumerateargsupdatekwargssortedkeyspytest Exceptionr.popgetexistscopytreer)r4r5r6r7rrJinfor<arHr.r@r? testroot_pathr=s @rrBrB9s EFgl77AABBCC##di((  DAqE!HH dk"""" 3 3 3 3fUZZ\\22 3 3 3D?# v  ;"$:;; ;&7x'' O(DEE gzz*f--H 3fjj86T6T TTF8v'v}}'7X#56 v&&& 2:lM 2 24 @ @@rc|jd}|r|jni}ddi}|||dr/t |dt st jd|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. r5r6Nz@You can only provide a string type of value for "shared_result" )rEget_closest_markerrJrI isinstancer2rMrN)r4envrJresults rr5r5ds , ) )- 8 8C &SZZBFF MM&7 6/3JC(P(P7 677 7 MrfunctionrBmake_appc#K|\}}||i|}|Vtd|ddtd|jjtd|jtd|jtdd|jztd d|jz|d r| |d |d Sd S) z9 Provides the 'sphinx.application.Sphinx' object z # testroot:r@rAz # builder:z # srcdir:z # outdir:z # status: z # warning:r6N) printrPbuildernamer?outdirr'r(r)r,)r5rBr\r6rHrJr"s rapprc|s LD& 8T $V $ $D JJJ -J77888 , )*** +t{### +t{### +tdl33555666 ,t}55777888?#@K8$?????@@rrcc|jSzJ Back-compatibility for testing with previous @with_app decorator )r'rcs rr%r%s ;rc|jSre)r)rfs rr&r&s <r monkeypatchc#K|ddgtjdd}fd}|V|tjdd<tD]}|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|Srr)xs rzmake_app..srNctt}}|d||d|t|i|}|drt |}|S)Nr%r&r6)r setdefaultr appendr )rHrJr%r&r"appsr5s rmakezmake_app..makes"**hjj(F+++)W---!42622 D  ' =6t<>rmoduleT)rautousecBtjdSr)rr clearrrr_shared_result_cacher|srct|jdd} |r%tj|dgttdSn#t $rYnwxYwt jddS)zt The test will be skipped when using 'if_graphviz_found' fixture and graphviz dot command is not found. graphviz_dotz-V)stdoutstderrNzgraphviz "dot" is not available)getattrr subprocessrunrOSErrorrMskip)rcr~s rif_graphviz_foundrs 3:~r::L   NL$/T J J J J F        K122222s%A A  A tmpdir_factoryz util.pathcv|}tj|S)z8 Temporary directory wrapped with `path` class. ) getbasetempr rtabspath)rtmpdirs rr7r7s1  ' ' ) )F 9V   $ $ & &&rrc*tj|S)z Temporary directory wrapped with `path` class. This fixture is for back-compatibility with old test implementation. )r rt)rs rtempdirrs 9V  rc#LK ttj}dVttjD]%}||vrtj|&dS#ttjD]%}||vrtj|&wxYw)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)rDrsmodulesrO) sysmodulesmodnames rrollback_sysmodulesrs)#+&&  CK(( ) )Gj( ) ((( ) )tCK(( ) )Gj( ) ((( )s A""AB#)rN)&__doc__rrs collectionsriorrtypingrrrr r rMsphinx.testingr sphinx.testing.utilr r rrfixturer2rrrBr5rcr%r&r\r6r|rr7rrrrrrs"%% """"""88888888888888 RRRRRRRR `7 333 i   !         ,'A'A$'A|'A$''A25'A:?d :K'A'A'A'AT.j!!!@T@uT4Z'8@H@#@(1-t2K(L@@@"!@(j!!! ("!j!!!8"!$SYxt?S5T6|h---.- 3= 3T 3 3 3 3 i   '' '''! 'CK)))))r