B [u\I@sdZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl m Z m Z ddddZ d d Zd d Zd dZGdddeZGdddejZdS)zV This plugin provides advanced doctest support and enables the testing of .rst files. N) OutputCheckerFIX#%z\.\.)ZtxtZtexrstcCs|jdddd|jdddd|jddd d d |jd dd dd |jdddd|dd|jdddddgd|dd|jddddd|jdddd |jd!d d d |jd"d dd dS)#Nz--doctest-plus store_truezWenable running doctests with additional features not found in the normal doctest plugin)actionhelpz --doctest-rstz-enable running doctests in .rst documentationz--doctest-plus-atolZstorez/set the absolute tolerance for float comparisong:0yE>)r r defaultz--doctest-plus-rtolz/set the relative tolerance for float comparisongh㈵>z--text-file-formatzZText file format for narrative documentation. Options accepted are 'txt', 'tex', and 'rst'text_file_formatz changing default format for docsdoctest_optionflagszoption flags for doctestsargsELLIPSISZNORMALIZE_WHITESPACE)typer doctest_plusdoctest_norecursedirszDlike the norecursedirs option but applies only to doctest collection doctest_rstz)Run the doctests in the rst documentationF)r doctest_plus_atoldoctest_plus_rtol)Z addoptionZaddini)parserrr8lib/python3.7/site-packages/pytest_doctestplus/plugin.pypytest_addoptions8   rcCs0|jd}d}x|D]}|tj|O}qW|S)Nr r)configgetinidoctestZOPTIONFLAGS_BY_NAME)parentZoptionflags_strZflag_intZflag_strrrrget_optionflagsMs   rc s$ttdtdt_ttdtdt_tt_tdj dj j olj j }dks|sdsj j sdSGfdddj}Gfdd d jtj}Gfd d d tjj t||d pj jj jp d dj dS)Nrr REMOTE_DATArrcseZdZfddZdS)z+pytest_configure..DocTestModulePlusc3s |jjdkrdS|jjdkrXy|jj|j}Wq|tk rT|jj|j}Yq|Xn$y|j}Wnt k rzdSXt |t B}t }t jd|td}xd||D]V}|jrdddkrx&|jD]}|jrd|jt j<qW|j|||VqWdS) Nzsetup.pyz conftest.pyF)verbose optionflagsZchecker remote_datanoneanyT)fspathbasenamerZ _conftestZimportconftestAttributeError pluginmanagerZ_importconftestZpyimport ImportErrorrrDocTestFinderPlusrZ DebugRunnerrfindZexamples getoptionoptionsgetSKIP DoctestItemname)selfmoduler-finderZrunnertestZexample)rrdoctest_pluginrrcollectos.     z3pytest_configure..DocTestModulePlus.collectN)__name__ __module__ __qualname__r7r)rrr6rrDocTestModulePlushsr;cs*eZdZddZfddZddZdS)z-pytest_configure..DocTestTextfilePluscSsdS)Nr)r2rrrobjsz1pytest_configure..DocTestTextfilePlus.objc sNi|_|}t|tB}tjt|jd|t|j ddddd\}}dS)NF)Z getfixtureTzutf-8)Zmodule_relativer!r extraglobsZraise_on_errorr encoding) ZfuncargsZ_setup_fixturesrrrZtestfilestrr%dictZgetfuncargvalue)r2Zfixture_requestr-ZfailedZtot)DocTestParserPlusr6rrruntests    z5pytest_configure..DocTestTextfilePlus.runtestcSs|jdd|jfS)a] Overwrite pytest's ``DoctestItem`` because ``DocTestTextfilePlus`` does not have a ``dtest`` attribute which is used by pytest>=3.2.0 to return the location of the tests. For details see `pytest-dev/pytest#2651 `_. Nz [doctest] %s)r%r1)r2rrr reportinfos z8pytest_configure..DocTestTextfilePlus.reportinfoN)r8r9r:r<rBrCr)rAr6rrDocTestTextfilePluss rDcs eZdZdZdfdd ZdS)z+pytest_configure..DocTestParserPlusa An extension to the builtin DocTestParser that handles the special directives for skipping tests. The directives are: - ``.. doctest-skip::``: Skip the next doctest chunk. - ``.. doctest-requires:: module1, module2``: Skip the next doctest chunk if the given modules/packages are not installed. - ``.. doctest-skip-all``: Skip all subsequent doctests. Ncstjj|||d}g}d}d}jjp.d}|tkrBt|ntd |tdtdx|D]~}t |t j r|rg}d}| } tfdd| Drd}qht| sqh| d d} fd d| D} t| d kr| d p| d } n| d } | r:| d } | dks4| d kr:tjd kr:d}qhfdd| D} t| d krn| d pj| d } n| d } | rtd| d }qht |tjrh|s|st|sd|jtj<dddkrh|jrhd|jtj<qhW|S)N)r1Fr zKfile format '{}' is not recognized, assuming '{}' as the comment character.rcs"g|]}td|qS)z{} doctest-skip-all)rematchformatstrip).0x) comment_charrr szEpytest_configure..DocTestParserPlus.parse..Tcsg|]}td|qS)z{}\s+doctest-skip\s*::(\s+.*)?)rErFrG)rI last_line)rKrrrLsrrZwin32csg|]}td|qS)z!{}\s+doctest-requires\s*::\s+(.*))rErFrG)rIrN)rKrrrLsz\s*,?\s*r"r#r$)r DocTestParserparseoptionr rcomment_characterswarningswarnrG isinstancesixZ string_typesrH splitlinesr$lengroupsysplatformrEsplitZExampler*check_required_modulesr-r/r,r.)r2sr1resultZrequiredZ skip_nextZskip_allZ file_formatentrylinesZ last_linesZmatchesrFZmarker)rr)rKrrPs`              z1pytest_configure..DocTestParserPlus.parse)N)r8r9r:__doc__rPr)rrrrrAsrArr Z doctestplus)maxfloatrr,rZrtolZatolrZregister_optionflagr(Z getpluginrQZdoctestmodulesrZ DoctestModuler0pytestZModulerOregister DoctestPlusrr Z unregister)rZrun_regular_doctestr;rDr)rArrr6rpytest_configureUs(   )!\rhc@s$eZdZddZddZddZdS)rgcCs4||_||_||_|r$d||_nd|_g|_dS)a doctest_module_item_cls should be a class inheriting `pytest.doctest.DoctestItem` and `pytest.File`. This class handles running of a single doctest found in a Python module. This is passed in as an argument because the actual class to be used may not be available at import time, depending on whether or not the doctest plugin for py.test is available. z.{}z.rstN)_doctest_module_item_cls_doctest_textfile_item_cls_run_rst_doctestsrG_text_file_ext _ignore_paths)r2Zdoctest_module_item_clsZdoctest_textfile_item_clsZrun_rst_doctestsr rrr__init__s zDoctestPlus.__init__cCsX|jd|d}|dk r&||kr&dSx,|dD]}|j|dr2|j|Pq2WdS)z@Skip paths that match any of the doctest_norecursedirs patterns.collect_ignore)pathNTr)fnmatchF)Z_getconftest_pathlistdirpathrZcheckrmappend)r2rprropatternrrrpytest_ignore_collect,s   z!DoctestPlus.pytest_ignore_collectcCsx |jD]}|||krdSqW|jdkrF|jdkr:dS|||S|jr|j|jkrt|t j j }|j drzdSd|krt |d|dddd}tdd ||dDrdS|||SdS) aImplements an enhanced version of the doctest module from py.test (specifically, as enabled by the --doctest-modules option) which supports skipping all doctests in a specific docstring by way of a special ``__doctest_skip__`` module-level variable. It can also skip tests that have special requirements by way of ``__doctest_requires__``. ``__doctest_skip__`` should be a list of functions, classes, or class methods whose docstrings should be ignored when collecting doctests. This also supports wildcard patterns. For example, to run doctests in a class's docstring, but skip all doctests in its modules use, at the module level:: __doctest_skip__ = ['ClassName.*'] You may also use the string ``'.'`` in ``__doctest_skip__`` to refer to the module itself, in case its module-level docstring contains doctests. ``__doctest_requires__`` should be a dictionary mapping wildcard patterns (in the same format as ``__doctest_skip__``) to a list of one or more modules that should be *importable* in order for the tests to run. For example, if some tests require the scipy module to work they will be skipped unless ``import scipy`` is possible. It is also possible to use a tuple of wildcard patterns as a key in this dict:: __doctest_requires__ = {('func1', 'func2'): ['scipy']} Nz.pyzconf.py_Zdocsrcss |]}|dp|dkVqdS)rvZapiN) startswith)rIrJrrr }sz2DoctestPlus.pytest_collect_file..)rmcommonZextr&rirkrlr?r\osrpseprxrXindexr$rj)r2rprZ ignore_pathpartsZ docs_indexrrrpytest_collect_file@s       zDoctestPlus.pytest_collect_fileN)r8r9r:rnrurrrrrrgsrgc@s*eZdZdZiZeddZdddZdS)r*zExtension to the default `doctest.DoctestFinder` that supports ``__doctest_skip__`` magic. See `pytest_collect_file` for more details. c Csbx\|D]T}||jkr"|j|s"dSyt|Wntk rNd|j|<dSXd|j|<qWdS)NFT) _import_cacheimp find_moduler))clsmodsmodrrrr]s    z(DocTestFinderPlus.check_required_modulesNcsztj|||}tds*tdrvdkrDtdrDjntdtffdd}tt ||}|S)N__doctest_skip____doctest_requires__r8zLDocTestFinder.find: name must be given when obj.__name__ doesn't exist: {!r}c sxRtdgD]B}|dkrdS|dkr4|jkr4dSt|jd|frdSqWtdi}x\t|D]N\}}t|ts|f}x4|D],}t|jd|fsq|sdSqWqlWdS)Nr*F.rT) getattrr1rqjoinrVZ iteritemsrUtupler])r5ZpatZreqsZpatsr)r1r<r2rr test_filters$     z+DocTestFinderPlus.find..test_filter) r DocTestFinderr+hasattrr8 ValueErrorrGrlistfilter)r2r<r1r3Zglobsr=Ztestsrr)r1r<r2rr+s  zDocTestFinderPlus.find)NNNN)r8r9r:rbr classmethodr]r+rrrrr*s  r*)rbrVrrqrr{rErZrSreZoutput_checkerrrrRrrrhobjectrgrr*rrrrs&1Cn