From 1c5b887dfd7ecfa7cc7ac315ebf7e57e3ce5a677 Mon Sep 17 00:00:00 2001
From: Bruno Oliveira <nicoddemus@gmail.com>
Date: Fri, 8 Dec 2017 09:04:42 -0200
Subject: [PATCH 01/18] Fix spelling of pytest in CHANGELOG
---
CHANGELOG.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index eabd28be1..5c2ed1759 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -157,10 +157,10 @@ Bug Fixes
<https://github.com/pytest-dev/pytest/issues/2124>`_)
- If an exception happens while loading a plugin, pytest no longer hides the
- original traceback. In python2 it will show the original traceback with a new
- message that explains in which plugin. In python3 it will show 2 canonized
+ original traceback. In Python 2 it will show the original traceback with a new
+ message that explains in which plugin. In Python 3 it will show 2 canonized
exceptions, the original exception while loading the plugin in addition to an
- exception that PyTest throws about loading a plugin. (`#2491
+ exception that pytest throws about loading a plugin. (`#2491
<https://github.com/pytest-dev/pytest/issues/2491>`_)
- ``capsys`` and ``capfd`` can now be used by other fixtures. (`#2709
From 38fb6aae7830837209c40ec1a4ccb68950bc107c Mon Sep 17 00:00:00 2001
From: Bruno Oliveira <nicoddemus@gmail.com>
Date: Fri, 8 Dec 2017 18:34:29 -0200
Subject: [PATCH 02/18] Change capture docs to use namedtuple
---
doc/en/capture.rst | 18 +++++++++++-------
1 file changed, 11 insertions(+), 7 deletions(-)
diff --git a/doc/en/capture.rst b/doc/en/capture.rst
index a87b57f8f..3315065c5 100644
--- a/doc/en/capture.rst
+++ b/doc/en/capture.rst
@@ -92,14 +92,14 @@ an example test function that performs some output related checks:
.. code-block:: python
def test_myoutput(capsys): # or use "capfd" for fd-level
- print ("hello")
+ print("hello")
sys.stderr.write("world\n")
- out, err = capsys.readouterr()
- assert out == "hello\n"
- assert err == "world\n"
- print ("next")
- out, err = capsys.readouterr()
- assert out == "next\n"
+ captured = capsys.readouterr()
+ assert captured.out == "hello\n"
+ assert captured.err == "world\n"
+ print("next")
+ captured = capsys.readouterr()
+ assert captured.out == "next\n"
The ``readouterr()`` call snapshots the output so far -
and capturing will be continued. After the test
@@ -117,6 +117,10 @@ system level output streams (FD1 and FD2).
.. versionadded:: 3.3
+The return value from ``readouterr`` changed to a ``namedtuple`` with two attributes, ``out`` and ``err``.
+
+.. versionadded:: 3.3
+
If the code under test writes non-textual data, you can capture this using
the ``capsysbinary`` fixture which instead returns ``bytes`` from
the ``readouterr`` method. The ``capfsysbinary`` fixture is currently only
From 65f5383106d4fbe7680bf154673198d68f590f9a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jurko=20Gospodneti=C4=87?= <jurko.gospodnetic@pke.hr>
Date: Fri, 1 Dec 2017 13:21:06 +0100
Subject: [PATCH 03/18] fix comment & docstring typos, line wrapping & wording
---
_pytest/pytester.py | 319 ++++++++++++++++++++++----------------------
1 file changed, 159 insertions(+), 160 deletions(-)
diff --git a/_pytest/pytester.py b/_pytest/pytester.py
index f2dd5994f..70436b246 100644
--- a/_pytest/pytester.py
+++ b/_pytest/pytester.py
@@ -1,4 +1,4 @@
-""" (disabled by default) support for testing pytest and pytest plugins. """
+"""(disabled by default) support for testing pytest and pytest plugins."""
from __future__ import absolute_import, division, print_function
import codecs
@@ -76,8 +76,8 @@ class LsofFdLeakChecker(object):
try:
py.process.cmdexec("lsof -v")
except (py.process.cmdexec.Error, UnicodeDecodeError):
- # cmdexec may raise UnicodeDecodeError on Windows systems
- # with locale other than english:
+ # cmdexec may raise UnicodeDecodeError on Windows systems with
+ # locale other than English:
# https://bitbucket.org/pytest-dev/py/issues/66
return False
else:
@@ -132,7 +132,7 @@ def getexecutable(name, cache={}):
if "2.5.2" in err:
executable = None # http://bugs.jython.org/issue1790
elif popen.returncode != 0:
- # Handle pyenv's 127.
+ # handle pyenv's 127
executable = None
cache[name] = executable
return executable
@@ -157,9 +157,10 @@ def anypython(request):
@pytest.fixture
def _pytest(request):
- """ Return a helper which offers a gethookrecorder(hook)
- method which returns a HookRecorder instance which helps
- to make assertions about called hooks.
+ """Return a helper which offers a gethookrecorder(hook) method which
+ returns a HookRecorder instance which helps to make assertions about called
+ hooks.
+
"""
return PytestArg(request)
@@ -193,8 +194,8 @@ class ParsedCall:
class HookRecorder:
"""Record all hooks called in a plugin manager.
- This wraps all the hook calls in the plugin manager, recording
- each call before propagating the normal calls.
+ This wraps all the hook calls in the plugin manager, recording each call
+ before propagating the normal calls.
"""
@@ -262,7 +263,7 @@ class HookRecorder:
def matchreport(self, inamepart="",
names="pytest_runtest_logreport pytest_collectreport", when=None):
- """ return a testreport whose dotted import path matches """
+ """return a testreport whose dotted import path matches"""
values = []
for rep in self.getreports(names=names):
try:
@@ -341,14 +342,14 @@ class RunResult:
Attributes:
- :ret: The return value.
- :outlines: List of lines captured from stdout.
- :errlines: List of lines captures from stderr.
+ :ret: the return value
+ :outlines: list of lines captured from stdout
+ :errlines: list of lines captures from stderr
:stdout: :py:class:`LineMatcher` of stdout, use ``stdout.str()`` to
- reconstruct stdout or the commonly used
- ``stdout.fnmatch_lines()`` method.
- :stderrr: :py:class:`LineMatcher` of stderr.
- :duration: Duration in seconds.
+ reconstruct stdout or the commonly used ``stdout.fnmatch_lines()``
+ method
+ :stderrr: :py:class:`LineMatcher` of stderr
+ :duration: duration in seconds
"""
@@ -361,8 +362,10 @@ class RunResult:
self.duration = duration
def parseoutcomes(self):
- """ Return a dictionary of outcomestring->num from parsing
- the terminal output that the test process produced."""
+ """Return a dictionary of outcomestring->num from parsing the terminal
+ output that the test process produced.
+
+ """
for line in reversed(self.outlines):
if 'seconds' in line:
outcomes = rex_outcome.findall(line)
@@ -374,8 +377,10 @@ class RunResult:
raise ValueError("Pytest terminal report not found")
def assert_outcomes(self, passed=0, skipped=0, failed=0, error=0):
- """ assert that the specified outcomes appear with the respective
- numbers (0 means it didn't occur) in the text output from a test run."""
+ """Assert that the specified outcomes appear with the respective
+ numbers (0 means it didn't occur) in the text output from a test run.
+
+ """
d = self.parseoutcomes()
obtained = {
'passed': d.get('passed', 0),
@@ -389,21 +394,18 @@ class RunResult:
class Testdir:
"""Temporary test directory with tools to test/run pytest itself.
- This is based on the ``tmpdir`` fixture but provides a number of
- methods which aid with testing pytest itself. Unless
- :py:meth:`chdir` is used all methods will use :py:attr:`tmpdir` as
- current working directory.
+ This is based on the ``tmpdir`` fixture but provides a number of methods
+ which aid with testing pytest itself. Unless :py:meth:`chdir` is used all
+ methods will use :py:attr:`tmpdir` as their current working directory.
Attributes:
- :tmpdir: The :py:class:`py.path.local` instance of the temporary
- directory.
+ :tmpdir: The :py:class:`py.path.local` instance of the temporary directory.
:plugins: A list of plugins to use with :py:meth:`parseconfig` and
- :py:meth:`runpytest`. Initially this is an empty list but
- plugins can be added to the list. The type of items to add to
- the list depend on the method which uses them so refer to them
- for details.
+ :py:meth:`runpytest`. Initially this is an empty list but plugins can
+ be added to the list. The type of items to add to the list depends on
+ the method using them so refer to them for details.
"""
@@ -429,10 +431,9 @@ class Testdir:
def finalize(self):
"""Clean up global state artifacts.
- Some methods modify the global interpreter state and this
- tries to clean this up. It does not remove the temporary
- directory however so it can be looked at after the test run
- has finished.
+ Some methods modify the global interpreter state and this tries to
+ clean this up. It does not remove the temporary directory however so
+ it can be looked at after the test run has finished.
"""
sys.path[:], sys.meta_path[:] = self._savesyspath
@@ -495,17 +496,15 @@ class Testdir:
def makefile(self, ext, *args, **kwargs):
"""Create a new file in the testdir.
- ext: The extension the file should use, including the dot.
- E.g. ".py".
+ ext: The extension the file should use, including the dot, e.g. `.py`.
- args: All args will be treated as strings and joined using
- newlines. The result will be written as contents to the
- file. The name of the file will be based on the test
- function requesting this fixture.
+ args: All args will be treated as strings and joined using newlines.
+ The result will be written as contents to the file. The name of the
+ file will be based on the test function requesting this fixture.
E.g. "testdir.makefile('.txt', 'line1', 'line2')"
- kwargs: Each keyword is the name of a file, while the value of
- it will be written as contents of the file.
+ kwargs: Each keyword is the name of a file, while the value of it will
+ be written as contents of the file.
E.g. "testdir.makefile('.ini', pytest='[pytest]\naddopts=-rs\n')"
"""
@@ -535,14 +534,16 @@ class Testdir:
def syspathinsert(self, path=None):
"""Prepend a directory to sys.path, defaults to :py:attr:`tmpdir`.
- This is undone automatically after the test.
+ This is undone automatically when this object dies at the end of each
+ test.
+
"""
if path is None:
path = self.tmpdir
sys.path.insert(0, str(path))
- # a call to syspathinsert() usually means that the caller
- # wants to import some dynamically created files.
- # with python3 we thus invalidate import caches.
+ # a call to syspathinsert() usually means that the caller wants to
+ # import some dynamically created files, thus with python3 we
+ # invalidate its import caches
self._possibly_invalidate_import_caches()
def _possibly_invalidate_import_caches(self):
@@ -562,8 +563,8 @@ class Testdir:
def mkpydir(self, name):
"""Create a new python package.
- This creates a (sub)directory with an empty ``__init__.py``
- file so that is recognised as a python package.
+ This creates a (sub)directory with an empty ``__init__.py`` file so it
+ gets recognised as a python package.
"""
p = self.mkdir(name)
@@ -576,10 +577,10 @@ class Testdir:
"""Return the collection node of a file.
:param config: :py:class:`_pytest.config.Config` instance, see
- :py:meth:`parseconfig` and :py:meth:`parseconfigure` to
- create the configuration.
+ :py:meth:`parseconfig` and :py:meth:`parseconfigure` to create the
+ configuration
- :param arg: A :py:class:`py.path.local` instance of the file.
+ :param arg: a :py:class:`py.path.local` instance of the file
"""
session = Session(config)
@@ -593,11 +594,10 @@ class Testdir:
def getpathnode(self, path):
"""Return the collection node of a file.
- This is like :py:meth:`getnode` but uses
- :py:meth:`parseconfigure` to create the (configured) pytest
- Config instance.
+ This is like :py:meth:`getnode` but uses :py:meth:`parseconfigure` to
+ create the (configured) pytest Config instance.
- :param path: A :py:class:`py.path.local` instance of the file.
+ :param path: a :py:class:`py.path.local` instance of the file
"""
config = self.parseconfigure(path)
@@ -611,8 +611,8 @@ class Testdir:
def genitems(self, colitems):
"""Generate all test items from a collection node.
- This recurses into the collection node and returns a list of
- all the test items contained within.
+ This recurses into the collection node and returns a list of all the
+ test items contained within.
"""
session = colitems[0].session
@@ -624,10 +624,10 @@ class Testdir:
def runitem(self, source):
"""Run the "test_func" Item.
- The calling test instance (the class which contains the test
- method) must provide a ``.getrunner()`` method which should
- return a runner which can run the test protocol for a single
- item, like e.g. :py:func:`_pytest.runner.runtestprotocol`.
+ The calling test instance (class containing the test method) must
+ provide a ``.getrunner()`` method which should return a runner which
+ can run the test protocol for a single item, e.g.
+ :py:func:`_pytest.runner.runtestprotocol`.
"""
# used from runner functional tests
@@ -641,14 +641,14 @@ class Testdir:
"""Run a test module in process using ``pytest.main()``.
This run writes "source" into a temporary file and runs
- ``pytest.main()`` on it, returning a :py:class:`HookRecorder`
- instance for the result.
+ ``pytest.main()`` on it, returning a :py:class:`HookRecorder` instance
+ for the result.
- :param source: The source code of the test module.
+ :param source: the source code of the test module
- :param cmdlineargs: Any extra command line arguments to use.
+ :param cmdlineargs: any extra command line arguments to use
- :return: :py:class:`HookRecorder` instance of the result.
+ :return: :py:class:`HookRecorder` instance of the result
"""
p = self.makepyfile(source)
@@ -658,13 +658,9 @@ class Testdir:
def inline_genitems(self, *args):
"""Run ``pytest.main(['--collectonly'])`` in-process.
- Returns a tuple of the collected items and a
- :py:class:`HookRecorder` instance.
-
- This runs the :py:func:`pytest.main` function to run all of
- pytest inside the test process itself like
- :py:meth:`inline_run`. However the return value is a tuple of
- the collection items and a :py:class:`HookRecorder` instance.
+ Runs the :py:func:`pytest.main` function to run all of pytest inside
+ the test process itself like :py:meth:`inline_run`, but returns a
+ tuple of the collected items and a :py:class:`HookRecorder` instance.
"""
rec = self.inline_run("--collect-only", *args)
@@ -674,24 +670,24 @@ class Testdir:
def inline_run(self, *args, **kwargs):
"""Run ``pytest.main()`` in-process, returning a HookRecorder.
- This runs the :py:func:`pytest.main` function to run all of
- pytest inside the test process itself. This means it can
- return a :py:class:`HookRecorder` instance which gives more
- detailed results from then run then can be done by matching
- stdout/stderr from :py:meth:`runpytest`.
+ Runs the :py:func:`pytest.main` function to run all of pytest inside
+ the test process itself. This means it can return a
+ :py:class:`HookRecorder` instance which gives more detailed results
+ from that run than can be done by matching stdout/stderr from
+ :py:meth:`runpytest`.
- :param args: Any command line arguments to pass to
- :py:func:`pytest.main`.
+ :param args: command line arguments to pass to :py:func:`pytest.main`
- :param plugin: (keyword-only) Extra plugin instances the
- ``pytest.main()`` instance should use.
+ :param plugin: (keyword-only) extra plugin instances the
+ ``pytest.main()`` instance should use
+
+ :return: a :py:class:`HookRecorder` instance
- :return: A :py:class:`HookRecorder` instance.
"""
- # When running py.test inline any plugins active in the main
- # test process are already imported. So this disables the
- # warning which will trigger to say they can no longer be
- # rewritten, which is fine as they are already rewritten.
+ # When running py.test inline any plugins active in the main test
+ # process are already imported. So this disables the warning which
+ # will trigger to say they can no longer be rewritten, which is fine as
+ # they have already been rewritten.
orig_warn = AssertionRewritingHook._warn_already_imported
def revert():
@@ -717,8 +713,8 @@ class Testdir:
pass
reprec.ret = ret
- # typically we reraise keyboard interrupts from the child run
- # because it's our user requesting interruption of the testing
+ # typically we reraise keyboard interrupts from the child run because
+ # it's our user requesting interruption of the testing
if ret == 2 and not kwargs.get("no_reraise_ctrlc"):
calls = reprec.getcalls("pytest_keyboard_interrupt")
if calls and calls[-1].excinfo.type == KeyboardInterrupt:
@@ -726,8 +722,10 @@ class Testdir:
return reprec
def runpytest_inprocess(self, *args, **kwargs):
- """ Return result of running pytest in-process, providing a similar
- interface to what self.runpytest() provides. """
+ """Return result of running pytest in-process, providing a similar
+ interface to what self.runpytest() provides.
+
+ """
if kwargs.get("syspathinsert"):
self.syspathinsert()
now = time.time()
@@ -759,7 +757,7 @@ class Testdir:
return res
def runpytest(self, *args, **kwargs):
- """ Run pytest inline or in a subprocess, depending on the command line
+ """Run pytest inline or in a subprocess, depending on the command line
option "--runpytest" and return a :py:class:`RunResult`.
"""
@@ -780,13 +778,13 @@ class Testdir:
def parseconfig(self, *args):
"""Return a new pytest Config instance from given commandline args.
- This invokes the pytest bootstrapping code in _pytest.config
- to create a new :py:class:`_pytest.core.PluginManager` and
- call the pytest_cmdline_parse hook to create new
+ This invokes the pytest bootstrapping code in _pytest.config to create
+ a new :py:class:`_pytest.core.PluginManager` and call the
+ pytest_cmdline_parse hook to create a new
:py:class:`_pytest.config.Config` instance.
- If :py:attr:`plugins` has been populated they should be plugin
- modules which will be registered with the PluginManager.
+ If :py:attr:`plugins` has been populated they should be plugin modules
+ to be registered with the PluginManager.
"""
args = self._ensure_basetemp(args)
@@ -802,9 +800,8 @@ class Testdir:
def parseconfigure(self, *args):
"""Return a new pytest configured Config instance.
- This returns a new :py:class:`_pytest.config.Config` instance
- like :py:meth:`parseconfig`, but also calls the
- pytest_configure hook.
+ This returns a new :py:class:`_pytest.config.Config` instance like
+ :py:meth:`parseconfig`, but also calls the pytest_configure hook.
"""
config = self.parseconfig(*args)
@@ -815,14 +812,14 @@ class Testdir:
def getitem(self, source, funcname="test_func"):
"""Return the test item for a test function.
- This writes the source to a python file and runs pytest's
- collection on the resulting module, returning the test item
- for the requested function name.
+ This writes the source to a python file and runs pytest's collection on
+ the resulting module, returning the test item for the requested
+ function name.
- :param source: The module source.
+ :param source: the module source
- :param funcname: The name of the test function for which the
- Item must be returned.
+ :param funcname: the name of the test function for which to return a
+ test item
"""
items = self.getitems(source)
@@ -835,9 +832,8 @@ class Testdir:
def getitems(self, source):
"""Return all test items collected from the module.
- This writes the source to a python file and runs pytest's
- collection on the resulting module, returning all test items
- contained within.
+ This writes the source to a python file and runs pytest's collection on
+ the resulting module, returning all test items contained within.
"""
modcol = self.getmodulecol(source)
@@ -846,17 +842,17 @@ class Testdir:
def getmodulecol(self, source, configargs=(), withinit=False):
"""Return the module collection node for ``source``.
- This writes ``source`` to a file using :py:meth:`makepyfile`
- and then runs the pytest collection on it, returning the
- collection node for the test module.
+ This writes ``source`` to a file using :py:meth:`makepyfile` and then
+ runs the pytest collection on it, returning the collection node for the
+ test module.
- :param source: The source code of the module to collect.
+ :param source: the source code of the module to collect
- :param configargs: Any extra arguments to pass to
- :py:meth:`parseconfigure`.
+ :param configargs: any extra arguments to pass to
+ :py:meth:`parseconfigure`
- :param withinit: Whether to also write a ``__init__.py`` file
- to the temporary directory to ensure it is a package.
+ :param withinit: whether to also write an ``__init__.py`` file to the
+ same directory to ensure it is a package
"""
kw = {self.request.function.__name__: Source(source).strip()}
@@ -871,13 +867,12 @@ class Testdir:
def collect_by_name(self, modcol, name):
"""Return the collection node for name from the module collection.
- This will search a module collection node for a collection
- node matching the given name.
+ This will search a module collection node for a collection node
+ matching the given name.
- :param modcol: A module collection node, see
- :py:meth:`getmodulecol`.
+ :param modcol: a module collection node; see :py:meth:`getmodulecol`
- :param name: The name of the node to return.
+ :param name: the name of the node to return
"""
if modcol not in self._mod_collections:
@@ -889,8 +884,8 @@ class Testdir:
def popen(self, cmdargs, stdout, stderr, **kw):
"""Invoke subprocess.Popen.
- This calls subprocess.Popen making sure the current working
- directory is the PYTHONPATH.
+ This calls subprocess.Popen making sure the current working directory
+ is in the PYTHONPATH.
You probably want to use :py:meth:`run` instead.
@@ -908,8 +903,7 @@ class Testdir:
def run(self, *cmdargs):
"""Run a command with arguments.
- Run a process using subprocess.Popen saving the stdout and
- stderr.
+ Run a process using subprocess.Popen saving the stdout and stderr.
Returns a :py:class:`RunResult`.
@@ -952,14 +946,15 @@ class Testdir:
print("couldn't print to %s because of encoding" % (fp,))
def _getpytestargs(self):
- # we cannot use "(sys.executable,script)"
- # because on windows the script is e.g. a pytest.exe
+ # we cannot use `(sys.executable, script)` because on Windows the
+ # script is e.g. `pytest.exe`
return (sys.executable, PYTEST_FULLPATH) # noqa
def runpython(self, script):
"""Run a python script using sys.executable as interpreter.
Returns a :py:class:`RunResult`.
+
"""
return self.run(sys.executable, script)
@@ -970,12 +965,11 @@ class Testdir:
def runpytest_subprocess(self, *args, **kwargs):
"""Run pytest as a subprocess with given arguments.
- Any plugins added to the :py:attr:`plugins` list will added
- using the ``-p`` command line option. Addtionally
- ``--basetemp`` is used put any temporary files and directories
- in a numbered directory prefixed with "runpytest-" so they do
- not conflict with the normal numberd pytest location for
- temporary files and directories.
+ Any plugins added to the :py:attr:`plugins` list will added using the
+ ``-p`` command line option. Additionally ``--basetemp`` is used put
+ any temporary files and directories in a numbered directory prefixed
+ with "runpytest-" so they do not conflict with the normal numbered
+ pytest location for temporary files and directories.
Returns a :py:class:`RunResult`.
@@ -998,8 +992,8 @@ class Testdir:
def spawn_pytest(self, string, expect_timeout=10.0):
"""Run pytest using pexpect.
- This makes sure to use the right pytest and sets up the
- temporary directory locations.
+ This makes sure to use the right pytest and sets up the temporary
+ directory locations.
The pexpect child is returned.
@@ -1013,6 +1007,7 @@ class Testdir:
"""Run a command using pexpect.
The pexpect child is returned.
+
"""
pexpect = pytest.importorskip("pexpect", "3.0")
if hasattr(sys, 'pypy_version_info') and '64' in platform.machine():
@@ -1039,8 +1034,10 @@ class LineComp:
self.stringio = py.io.TextIO()
def assert_contains_lines(self, lines2):
- """ assert that lines2 are contained (linearly) in lines1.
- return a list of extralines found.
+ """Assert that lines2 are contained (linearly) in lines1.
+
+ Return a list of extralines found.
+
"""
__tracebackhide__ = True
val = self.stringio.getvalue()
@@ -1056,8 +1053,8 @@ class LineMatcher:
This is a convenience class to test large texts like the output of
commands.
- The constructor takes a list of lines without their trailing
- newlines, i.e. ``text.splitlines()``.
+ The constructor takes a list of lines without their trailing newlines, i.e.
+ ``text.splitlines()``.
"""
@@ -1077,18 +1074,19 @@ class LineMatcher:
return lines2
def fnmatch_lines_random(self, lines2):
- """Check lines exist in the output using ``fnmatch.fnmatch``, in any order.
+ """Check lines exist in the output using in any order.
+
+ Lines are checked using ``fnmatch.fnmatch``. The argument is a list of
+ lines which have to occur in the output, in any order.
- The argument is a list of lines which have to occur in the
- output, in any order.
"""
self._match_lines_random(lines2, fnmatch)
def re_match_lines_random(self, lines2):
"""Check lines exist in the output using ``re.match``, in any order.
- The argument is a list of lines which have to occur in the
- output, in any order.
+ The argument is a list of lines which have to occur in the output, in
+ any order.
"""
self._match_lines_random(lines2, lambda name, pat: re.match(pat, name))
@@ -1096,8 +1094,8 @@ class LineMatcher:
def _match_lines_random(self, lines2, match_func):
"""Check lines exist in the output.
- The argument is a list of lines which have to occur in the
- output, in any order. Each line can contain glob whildcards.
+ The argument is a list of lines which have to occur in the output, in
+ any order. Each line can contain glob whildcards.
"""
lines2 = self._getlines(lines2)
@@ -1114,6 +1112,7 @@ class LineMatcher:
"""Return all lines following the given line in the text.
The given line can contain glob wildcards.
+
"""
for i, line in enumerate(self.lines):
if fnline == line or fnmatch(line, fnline):
@@ -1130,10 +1129,9 @@ class LineMatcher:
def fnmatch_lines(self, lines2):
"""Search captured text for matching lines using ``fnmatch.fnmatch``.
- The argument is a list of lines which have to match and can
- use glob wildcards. If they do not match a pytest.fail() is
- called. The matches and non-matches are also printed on
- stdout.
+ The argument is a list of lines which have to match and can use glob
+ wildcards. If they do not match a pytest.fail() is called. The
+ matches and non-matches are also printed on stdout.
"""
self._match_lines(lines2, fnmatch, 'fnmatch')
@@ -1144,21 +1142,22 @@ class LineMatcher:
The argument is a list of lines which have to match using ``re.match``.
If they do not match a pytest.fail() is called.
- The matches and non-matches are also printed on
- stdout.
+ The matches and non-matches are also printed on stdout.
+
"""
self._match_lines(lines2, lambda name, pat: re.match(pat, name), 're.match')
def _match_lines(self, lines2, match_func, match_nickname):
"""Underlying implementation of ``fnmatch_lines`` and ``re_match_lines``.
- :param list[str] lines2: list of string patterns to match. The actual format depends on
- ``match_func``.
- :param match_func: a callable ``match_func(line, pattern)`` where line is the captured
- line from stdout/stderr and pattern is the matching pattern.
+ :param list[str] lines2: list of string patterns to match. The actual
+ format depends on ``match_func``
+ :param match_func: a callable ``match_func(line, pattern)`` where line
+ is the captured line from stdout/stderr and pattern is the matching
+ pattern
+ :param str match_nickname: the nickname for the match function that
+ will be logged to stdout when a match occurs
- :param str match_nickname: the nickname for the match function that will be logged
- to stdout when a match occurs.
"""
lines2 = self._getlines(lines2)
lines1 = self.lines[:]
From 57fcd3f57e824249b8786df5e75748673f3273ae Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jurko=20Gospodneti=C4=87?= <jurko.gospodnetic@pke.hr>
Date: Fri, 8 Dec 2017 20:06:22 +0100
Subject: [PATCH 04/18] remove corpse code comments
---
_pytest/pytester.py | 7 -------
1 file changed, 7 deletions(-)
diff --git a/_pytest/pytester.py b/_pytest/pytester.py
index 70436b246..6e37d8b31 100644
--- a/_pytest/pytester.py
+++ b/_pytest/pytester.py
@@ -27,7 +27,6 @@ PYTEST_FULLPATH = os.path.abspath(pytest.__file__.rstrip("oc")).replace("$py.cla
def pytest_addoption(parser):
- # group = parser.getgroup("pytester", "pytester (self-tests) options")
parser.addoption('--lsof',
action="store_true", dest="lsof", default=False,
help=("run FD checks if lsof is available"))
@@ -977,12 +976,6 @@ class Testdir:
p = py.path.local.make_numbered_dir(prefix="runpytest-",
keep=None, rootdir=self.tmpdir)
args = ('--basetemp=%s' % p, ) + args
- # for x in args:
- # if '--confcutdir' in str(x):
- # break
- # else:
- # pass
- # args = ('--confcutdir=.',) + args
plugins = [x for x in self.plugins if isinstance(x, str)]
if plugins:
args = ('-p', plugins[0]) + args
From 596937e610719fcaf7269959d8b20d49b6381c99 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jurko=20Gospodneti=C4=87?= <jurko.gospodnetic@pke.hr>
Date: Fri, 8 Dec 2017 20:17:14 +0100
Subject: [PATCH 05/18] remove extra whitespace
---
_pytest/pytester.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/_pytest/pytester.py b/_pytest/pytester.py
index 6e37d8b31..0b25d839b 100644
--- a/_pytest/pytester.py
+++ b/_pytest/pytester.py
@@ -32,7 +32,7 @@ def pytest_addoption(parser):
help=("run FD checks if lsof is available"))
parser.addoption('--runpytest', default="inprocess", dest="runpytest",
- choices=("inprocess", "subprocess", ),
+ choices=("inprocess", "subprocess"),
help=("run pytest sub runs in tests using an 'inprocess' "
"or 'subprocess' (python -m main) method"))
@@ -975,7 +975,7 @@ class Testdir:
"""
p = py.path.local.make_numbered_dir(prefix="runpytest-",
keep=None, rootdir=self.tmpdir)
- args = ('--basetemp=%s' % p, ) + args
+ args = ('--basetemp=%s' % p,) + args
plugins = [x for x in self.plugins if isinstance(x, str)]
if plugins:
args = ('-p', plugins[0]) + args
From f0bfe9de3d957867c56a4b7b514226d992049c2a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jurko=20Gospodneti=C4=87?= <jurko.gospodnetic@pke.hr>
Date: Fri, 1 Dec 2017 13:28:39 +0100
Subject: [PATCH 06/18] shorten some test code
---
testing/acceptance_test.py | 4 ++--
testing/test_conftest.py | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/testing/acceptance_test.py b/testing/acceptance_test.py
index a7838545b..21d17453b 100644
--- a/testing/acceptance_test.py
+++ b/testing/acceptance_test.py
@@ -215,8 +215,8 @@ class TestGeneralUsage(object):
assert not result.ret
def test_issue109_sibling_conftests_not_loaded(self, testdir):
- sub1 = testdir.tmpdir.mkdir("sub1")
- sub2 = testdir.tmpdir.mkdir("sub2")
+ sub1 = testdir.mkdir("sub1")
+ sub2 = testdir.mkdir("sub2")
sub1.join("conftest.py").write("assert 0")
result = testdir.runpytest(sub2)
assert result.ret == EXIT_NOTESTSCOLLECTED
diff --git a/testing/test_conftest.py b/testing/test_conftest.py
index c0411b723..dd54e0c5b 100644
--- a/testing/test_conftest.py
+++ b/testing/test_conftest.py
@@ -84,7 +84,7 @@ def test_conftest_in_nonpkg_with_init(tmpdir):
def test_doubledash_considered(testdir):
conf = testdir.mkdir("--option")
- conf.join("conftest.py").ensure()
+ conf.ensure("conftest.py")
conftest = PytestPluginManager()
conftest_setinitial(conftest, [conf.basename, conf.basename])
values = conftest._getconftestmodules(conf)
From 7feab7391d2e4e53829f29fe898e3169b5a5b3e6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jurko=20Gospodneti=C4=87?= <jurko.gospodnetic@pke.hr>
Date: Wed, 6 Dec 2017 15:22:45 +0100
Subject: [PATCH 07/18] simplify test_pdb_collection_failure_is_shown test data
setup code
---
testing/test_pdb.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/testing/test_pdb.py b/testing/test_pdb.py
index 70a5c3c5b..a565cbd0d 100644
--- a/testing/test_pdb.py
+++ b/testing/test_pdb.py
@@ -338,7 +338,7 @@ class TestPDB(object):
self.flush(child)
def test_pdb_collection_failure_is_shown(self, testdir):
- p1 = testdir.makepyfile("""xxx """)
+ p1 = testdir.makepyfile("xxx")
result = testdir.runpytest_subprocess("--pdb", p1)
result.stdout.fnmatch_lines([
"*NameError*xxx*",
From 41a6ec6f317965b4546ddc50d2ffcde259546fe5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jurko=20Gospodneti=C4=87?= <jurko.gospodnetic@pke.hr>
Date: Fri, 8 Dec 2017 21:27:53 +0100
Subject: [PATCH 08/18] touch up test_cmdline_python_namespace_package() test
code
---
testing/acceptance_test.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/testing/acceptance_test.py b/testing/acceptance_test.py
index 21d17453b..ff3dda4e5 100644
--- a/testing/acceptance_test.py
+++ b/testing/acceptance_test.py
@@ -624,10 +624,9 @@ class TestInvocationVariants(object):
for p in search_path:
monkeypatch.syspath_prepend(p)
- os.chdir('world')
# mixed module and filenames:
+ os.chdir('world')
result = testdir.runpytest("--pyargs", "-v", "ns_pkg.hello", "ns_pkg/world")
- testdir.chdir()
assert result.ret == 0
result.stdout.fnmatch_lines([
"*test_hello.py::test_hello*PASSED*",
@@ -638,6 +637,7 @@ class TestInvocationVariants(object):
])
# specify tests within a module
+ testdir.chdir()
result = testdir.runpytest("--pyargs", "-v", "ns_pkg.world.test_world::test_other")
assert result.ret == 0
result.stdout.fnmatch_lines([
From dd64f1a4a9b5443aeeb5ec9f4aecc970bd71151d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jurko=20Gospodneti=C4=87?= <jurko.gospodnetic@pke.hr>
Date: Fri, 8 Dec 2017 23:34:00 +0100
Subject: [PATCH 09/18] fix tox.ini comment typos
---
tox.ini | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/tox.ini b/tox.ini
index 900b602dc..38ebaf69f 100644
--- a/tox.ini
+++ b/tox.ini
@@ -138,7 +138,7 @@ commands =
basepython = python
usedevelop = True
skipsdist = True
-# ensure the given pyargs cant mean anytrhing else
+# ensure the given pyargs can't mean anything else
changedir = doc/
deps =
PyYAML
From 852b96714e2f64826ae293657f20ec88c769f6d3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jurko=20Gospodneti=C4=87?= <jurko.gospodnetic@pke.hr>
Date: Fri, 8 Dec 2017 23:48:58 +0100
Subject: [PATCH 10/18] use spaces consistently instead of some of them being
---
testing/acceptance_test.py | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/testing/acceptance_test.py b/testing/acceptance_test.py
index ff3dda4e5..b4277e46d 100644
--- a/testing/acceptance_test.py
+++ b/testing/acceptance_test.py
@@ -603,11 +603,11 @@ class TestInvocationVariants(object):
# The structure of the test directory is now:
# .
# ├── hello
- # │ └── ns_pkg
- # │ ├── __init__.py
- # │ └── hello
- # │ ├── __init__.py
- # │ └── test_hello.py
+ # │ └── ns_pkg
+ # │ ├── __init__.py
+ # │ └── hello
+ # │ ├── __init__.py
+ # │ └── test_hello.py
# └── world
# └── ns_pkg
# ├── __init__.py
From 8e8a953ac67b74c2ee4ccefe9afa7abbd886cbba Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jurko=20Gospodneti=C4=87?= <jurko.gospodnetic@pke.hr>
Date: Sat, 9 Dec 2017 13:31:12 +0100
Subject: [PATCH 11/18] fix test name typo
---
testing/test_pytester.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/testing/test_pytester.py b/testing/test_pytester.py
index 9508c2954..cba267f57 100644
--- a/testing/test_pytester.py
+++ b/testing/test_pytester.py
@@ -141,7 +141,7 @@ def test_inline_run_clean_modules(testdir):
assert result2.ret == EXIT_TESTSFAILED
-def test_assert_outcomes_after_pytest_erro(testdir):
+def test_assert_outcomes_after_pytest_error(testdir):
testdir.makepyfile("def test_foo(): assert True")
result = testdir.runpytest('--unexpected-argument')
From 73bc6bacfa20ca783c46e7a6169b07e294b90fbd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jurko=20Gospodneti=C4=87?= <jurko.gospodnetic@pke.hr>
Date: Fri, 8 Dec 2017 23:09:52 +0100
Subject: [PATCH 12/18] add changelog entry
---
changelog/3015.trivial | 1 +
1 file changed, 1 insertion(+)
create mode 100644 changelog/3015.trivial
diff --git a/changelog/3015.trivial b/changelog/3015.trivial
new file mode 100644
index 000000000..a63ba06e6
--- /dev/null
+++ b/changelog/3015.trivial
@@ -0,0 +1 @@
+Code cleanup.
From 3b85e0c3a985427376429a36b81e1aaea55c0887 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jurko=20Gospodneti=C4=87?= <jurko.gospodnetic@pke.hr>
Date: Mon, 11 Dec 2017 15:10:04 +0100
Subject: [PATCH 13/18] simplify test_conftest_found_with_double_dash() test
code
---
testing/test_conftest.py | 6 +-----
1 file changed, 1 insertion(+), 5 deletions(-)
diff --git a/testing/test_conftest.py b/testing/test_conftest.py
index dd54e0c5b..f0f187606 100644
--- a/testing/test_conftest.py
+++ b/testing/test_conftest.py
@@ -270,11 +270,7 @@ def test_conftest_found_with_double_dash(testdir):
parser.addoption("--hello-world", action="store_true")
"""))
p = sub.join("test_hello.py")
- p.write(py.std.textwrap.dedent("""
- import pytest
- def test_hello(found):
- assert found == 1
- """))
+ p.write("def test_hello(): pass")
result = testdir.runpytest(str(p) + "::test_hello", "-h")
result.stdout.fnmatch_lines("""
*--hello-world*
From cb0ba18f5381ba60a4693a71f3c1c1470631ec60 Mon Sep 17 00:00:00 2001
From: Srinivas Reddy Thatiparthy <thatiparthysreenivas@gmail.com>
Date: Mon, 11 Dec 2017 22:53:12 +0530
Subject: [PATCH 14/18] remove '_ast' module; and redirect '_ast' references to
'ast'
---
_pytest/_code/source.py | 14 +++++---------
_pytest/assertion/rewrite.py | 5 ++---
2 files changed, 7 insertions(+), 12 deletions(-)
diff --git a/_pytest/_code/source.py b/_pytest/_code/source.py
index 2638c598b..322c72afb 100644
--- a/_pytest/_code/source.py
+++ b/_pytest/_code/source.py
@@ -1,19 +1,15 @@
from __future__ import absolute_import, division, generators, print_function
+import ast
+from ast import PyCF_ONLY_AST as _AST_FLAG
from bisect import bisect_right
import sys
import six
import inspect
import tokenize
import py
-cpy_compile = compile
-try:
- import _ast
- from _ast import PyCF_ONLY_AST as _AST_FLAG
-except ImportError:
- _AST_FLAG = 0
- _ast = None
+cpy_compile = compile
class Source(object):
@@ -209,7 +205,7 @@ def compile_(source, filename=None, mode='exec', flags=generators.compiler_flag,
retrieval of the source code for the code object
and any recursively created code objects.
"""
- if _ast is not None and isinstance(source, _ast.AST):
+ if isinstance(source, ast.AST):
# XXX should Source support having AST?
return cpy_compile(source, filename, mode, flags, dont_inherit)
_genframe = sys._getframe(1) # the caller
@@ -322,7 +318,7 @@ def get_statement_startend2(lineno, node):
# AST's line numbers start indexing at 1
values = []
for x in ast.walk(node):
- if isinstance(x, _ast.stmt) or isinstance(x, _ast.ExceptHandler):
+ if isinstance(x, ast.stmt) or isinstance(x, ast.ExceptHandler):
values.append(x.lineno - 1)
for name in "finalbody", "orelse":
val = getattr(x, name, None)
diff --git a/_pytest/assertion/rewrite.py b/_pytest/assertion/rewrite.py
index f64358f49..92deb6539 100644
--- a/_pytest/assertion/rewrite.py
+++ b/_pytest/assertion/rewrite.py
@@ -1,7 +1,6 @@
"""Rewrite assertion AST to produce nice error messages"""
from __future__ import absolute_import, division, print_function
import ast
-import _ast
import errno
import itertools
import imp
@@ -914,7 +913,7 @@ class AssertionRewriter(ast.NodeVisitor):
def visit_Compare(self, comp):
self.push_format_context()
left_res, left_expl = self.visit(comp.left)
- if isinstance(comp.left, (_ast.Compare, _ast.BoolOp)):
+ if isinstance(comp.left, (ast.Compare, ast.BoolOp)):
left_expl = "({0})".format(left_expl)
res_variables = [self.variable() for i in range(len(comp.ops))]
load_names = [ast.Name(v, ast.Load()) for v in res_variables]
@@ -925,7 +924,7 @@ class AssertionRewriter(ast.NodeVisitor):
results = [left_res]
for i, op, next_operand in it:
next_res, next_expl = self.visit(next_operand)
- if isinstance(next_operand, (_ast.Compare, _ast.BoolOp)):
+ if isinstance(next_operand, (ast.Compare, ast.BoolOp)):
next_expl = "({0})".format(next_expl)
results.append(next_res)
sym = binop_map[op.__class__]
From c2cd239d35c8f3a1be3f86ea1dc5f83ea8431fd6 Mon Sep 17 00:00:00 2001
From: Srinivas Reddy Thatiparthy <thatiparthysreenivas@gmail.com>
Date: Mon, 11 Dec 2017 23:24:47 +0530
Subject: [PATCH 15/18] remove _ast reference from test cases as well
---
testing/code/test_source.py | 7 ++-----
1 file changed, 2 insertions(+), 5 deletions(-)
diff --git a/testing/code/test_source.py b/testing/code/test_source.py
index 8eda68a6e..fcce3fa96 100644
--- a/testing/code/test_source.py
+++ b/testing/code/test_source.py
@@ -8,13 +8,10 @@ import _pytest._code
import py
import pytest
from _pytest._code import Source
-from _pytest._code.source import _ast
+from _pytest._code.source import ast
-if _ast is not None:
- astonly = pytest.mark.nothing
-else:
- astonly = pytest.mark.xfail("True", reason="only works with AST-compile")
+astonly = pytest.mark.nothing
failsonjython = pytest.mark.xfail("sys.platform.startswith('java')")
From 7792587b3f01113f7197e3db52d05a238197cbae Mon Sep 17 00:00:00 2001
From: Srinivas Reddy Thatiparthy <thatiparthysreenivas@gmail.com>
Date: Tue, 12 Dec 2017 00:03:38 +0530
Subject: [PATCH 16/18] remove unnecessary import
---
_pytest/assertion/util.py | 6 +-----
1 file changed, 1 insertion(+), 5 deletions(-)
diff --git a/_pytest/assertion/util.py b/_pytest/assertion/util.py
index 511d98ef1..1d562686d 100644
--- a/_pytest/assertion/util.py
+++ b/_pytest/assertion/util.py
@@ -5,11 +5,7 @@ import pprint
import _pytest._code
import py
import six
-try:
- from collections import Sequence
-except ImportError:
- Sequence = list
-
+from collections import Sequence
u = six.text_type
From fc544dc66078364c176451476fc17a3def2b3772 Mon Sep 17 00:00:00 2001
From: Srinivas Reddy Thatiparthy <thatiparthysreenivas@gmail.com>
Date: Tue, 12 Dec 2017 00:10:49 +0530
Subject: [PATCH 17/18] remove redundant checking because
* isinstance([], Sequence) is True
* isinstance((), Sequence) is True
---
_pytest/assertion/util.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_pytest/assertion/util.py b/_pytest/assertion/util.py
index 1d562686d..5a380ae09 100644
--- a/_pytest/assertion/util.py
+++ b/_pytest/assertion/util.py
@@ -109,7 +109,7 @@ def assertrepr_compare(config, op, left, right):
summary = u('%s %s %s') % (ecu(left_repr), op, ecu(right_repr))
def issequence(x):
- return (isinstance(x, (list, tuple, Sequence)) and not isinstance(x, basestring))
+ return isinstance(x, Sequence) and not isinstance(x, basestring)
def istext(x):
return isinstance(x, basestring)
From fc5ec5807ef5835e094fb52e2f073b3f5beeac1f Mon Sep 17 00:00:00 2001
From: Bruno Oliveira <nicoddemus@gmail.com>
Date: Mon, 11 Dec 2017 17:40:35 -0200
Subject: [PATCH 18/18] Add changelog for 3018
---
changelog/3018.trivial | 1 +
1 file changed, 1 insertion(+)
create mode 100644 changelog/3018.trivial
diff --git a/changelog/3018.trivial b/changelog/3018.trivial
new file mode 100644
index 000000000..8b4b4176b
--- /dev/null
+++ b/changelog/3018.trivial
@@ -0,0 +1 @@
+Clean up code by replacing imports and references of `_ast` to `ast`.