floraachy
/
pytest2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

regendoc and invocation fixes

This commit is contained in:
Ronny Pfannschmidt 2018-06-27 08:28:21 +02:00
parent 8a6345515b
commit 17e01993d9
2 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/en/writing_plugins.rst
View File

@ -390,32 +390,41 @@ additionally it is possible to copy examples for a example folder before running
.. code:: ini .. code:: ini
# contents of pytest.ini # content of pytest.ini
[pytest] [pytest]
pytester_example_dir = . pytester_example_dir = .
.. code:: python .. code:: python
# contents of test_example.py # content of test_example.py
def test_plugin(testdir): def test_plugin(testdir):
testdir.copy_example("test_example.py") testdir.copy_example("test_example.py")
testdir.runpytest("-k 'not test_plugin'") testdir.runpytest("-k", "test_example")
def test_example(): def test_example():
pass pass
.. code:: .. code::
$ pytest -k test_plugin $ pytest
=========================== test session starts ============================ =========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y
rootdir: $REGENDOC_TMPDIR, inifile: rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini
collected 0 items collected 2 items
test_example.py .. [100%]
============================= warnings summary =============================
test_example.py::test_plugin
$REGENDOC_TMPDIR/test_example.py:4: PytestExerimentalApiWarning: testdir.copy_example is an experimental api that may change over time
testdir.copy_example("test_example.py")
-- Docs: http://doc.pytest.org/en/latest/warnings.html
=================== 2 passed, 1 warnings in 0.12 seconds ===================
======================= no tests ran in 0.12 seconds =======================
For more information about the result object that ``runpytest()`` returns, and For more information about the result object that ``runpytest()`` returns, and
the methods that it provides please check out the :py:class:`RunResult the methods that it provides please check out the :py:class:`RunResult
<_pytest.pytester.RunResult>` documentation. <_pytest.pytester.RunResult>` documentation.

10
src/_pytest/experiments.py
View File

@ -1,5 +1,13 @@
class PytestExerimentalApiWarning(FutureWarning): class PytestExerimentalApiWarning(FutureWarning):
"warning category used to denote experiments in pytest" "warning category used to denote experiments in pytest"
@classmethod
def simple(cls, apiname):
return cls(
"{apiname} is an experimental api that may change over time".format(
apiname=apiname
)
)
PYTESTER_COPY_EXAMPLE = PytestExerimentalApiWarning()
PYTESTER_COPY_EXAMPLE = PytestExerimentalApiWarning.simple("testdir.copy_example")