Merge pull request #3387 from nicoddemus/merge-master-into-features

Merge master into features
pytest-dev · Apr 12, 2018 · f79b032 · f79b032
2 parents 372bcdb + 10a7160
commit f79b032
Show file tree

Hide file tree

Showing 57 changed files with 107 additions and 126 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -190,6 +190,7 @@ Tareq Alayan
 Ted Xiao
 Thomas Grainger
 Thomas Hisch
+Tim Strazny
 Tom Dalton
 Tom Viner
 Trevor Bekolay

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -136,7 +136,7 @@ Trivial/Internal Changes
 - Internal ``mark.py`` module has been turned into a package. (`#3250
   <https://github.com/pytest-dev/pytest/issues/3250>`_)
 
-- ``pytest`` now depends on the `more_itertools
+- ``pytest`` now depends on the `more-itertools
   <https://github.com/erikrose/more-itertools>`_ package. (`#3265
   <https://github.com/pytest-dev/pytest/issues/3265>`_)
 

diff --git a/_pytest/assertion/util.py b/_pytest/assertion/util.py
@@ -5,7 +5,7 @@
 import _pytest._code
 import py
 import six
-from collections import Sequence
+from ..compat import Sequence
 
 u = six.text_type
 

diff --git a/_pytest/compat.py b/_pytest/compat.py
@@ -38,6 +38,14 @@
 PY36 = sys.version_info[:2] >= (3, 6)
 MODULE_NOT_FOUND_ERROR = 'ModuleNotFoundError' if PY36 else 'ImportError'
 
+if _PY3:
+    from collections.abc import MutableMapping as MappingMixin  # noqa
+    from collections.abc import Sequence  # noqa
+else:
+    # those raise DeprecationWarnings in Python >=3.7
+    from collections import MutableMapping as MappingMixin  # noqa
+    from collections import Sequence  # noqa
+
 
 def _format_args(func):
     return str(signature(func))

diff --git a/_pytest/hookspec.py b/_pytest/hookspec.py
@@ -413,14 +413,15 @@ def pytest_fixture_post_finalizer(fixturedef, request):
 
 
 def pytest_sessionstart(session):
-    """ before session.main() is called.
+    """ called after the ``Session`` object has been created and before performing collection
+    and entering the run test loop.
 
     :param _pytest.main.Session session: the pytest session object
     """
 
 
 def pytest_sessionfinish(session, exitstatus):
-    """ whole test run finishes.
+    """ called after whole test run finished, right before returning the exit status to the system.
 
     :param _pytest.main.Session session: the pytest session object
     :param int exitstatus: the status which pytest will return to the system

diff --git a/_pytest/junitxml.py b/_pytest/junitxml.py
@@ -245,11 +245,6 @@ def record_property(request):
         def test_function(record_property):
             record_property("example_key", 1)
     """
-    request.node.warn(
-        code='C3',
-        message='record_property is an experimental feature',
-    )
-
     def append_property(name, value):
         request.node.user_properties.append((name, value))
     return append_property

diff --git a/_pytest/mark/__init__.py b/_pytest/mark/__init__.py
@@ -20,7 +20,8 @@ class MarkerError(Exception):
 
 
 def param(*values, **kw):
-    """Specify a parameter in a `pytest.mark.parametrize`_ call.
+    """Specify a parameter in `pytest.mark.parametrize`_ calls or
+    :ref:`parametrized fixtures <fixture-parametrize-marks>`.
 
     .. code-block:: python
 

diff --git a/_pytest/mark/structures.py b/_pytest/mark/structures.py
@@ -1,12 +1,12 @@
-from collections import namedtuple, MutableMapping as MappingMixin
+import inspect
 import warnings
+from collections import namedtuple
 from operator import attrgetter
-import inspect
 
 import attr
 
 from ..deprecated import MARK_PARAMETERSET_UNPACKING, MARK_INFO_ATTRIBUTE
-from ..compat import NOTSET, getfslineno
+from ..compat import NOTSET, getfslineno, MappingMixin
 from six.moves import map, reduce
 
 

diff --git a/_pytest/python_api.py b/_pytest/python_api.py
@@ -2,6 +2,7 @@
 import sys
 
 import py
+from six import binary_type, text_type
 from six.moves import zip, filterfalse
 from more_itertools.more import always_iterable
 
@@ -584,7 +585,8 @@ def raises(expected_exception, *args, **kwargs):
 
     """
     __tracebackhide__ = True
-    for exc in filterfalse(isclass, always_iterable(expected_exception)):
+    base_type = (type, text_type, binary_type)
+    for exc in filterfalse(isclass, always_iterable(expected_exception, base_type)):
         msg = ("exceptions must be old-style classes or"
                " derived from BaseException, not %s")
         raise TypeError(msg % type(exc))
@@ -597,6 +599,10 @@ def raises(expected_exception, *args, **kwargs):
             message = kwargs.pop("message")
         if "match" in kwargs:
             match_expr = kwargs.pop("match")
+        if kwargs:
+            msg = 'Unexpected keyword arguments passed to pytest.raises: '
+            msg += ', '.join(kwargs.keys())
+            raise TypeError(msg)
         return RaisesContext(expected_exception, message, match_expr)
     elif isinstance(args[0], str):
         code, = args

diff --git a/changelog/1478.feature b/changelog/1478.feature
diff --git a/changelog/1642.feature.rst b/changelog/1642.feature.rst
diff --git a/changelog/1713.doc.rst b/changelog/1713.doc.rst
diff --git a/changelog/2370.bugfix.rst b/changelog/2370.bugfix.rst
diff --git a/changelog/2405.feature.rst b/changelog/2405.feature.rst
diff --git a/changelog/2770.feature b/changelog/2770.feature
diff --git a/changelog/2770.removal.rst b/changelog/2770.removal.rst
diff --git a/changelog/3034.feature b/changelog/3034.feature
diff --git a/changelog/3084.removal b/changelog/3084.removal
diff --git a/changelog/3139.feature b/changelog/3139.feature
diff --git a/changelog/3149.feature b/changelog/3149.feature
diff --git a/changelog/3156.feature b/changelog/3156.feature
diff --git a/changelog/3189.feature b/changelog/3189.feature
diff --git a/changelog/3190.feature b/changelog/3190.feature
diff --git a/changelog/3198.feature.rst b/changelog/3198.feature.rst
diff --git a/changelog/3204.feature b/changelog/3204.feature
diff --git a/changelog/3213.feature b/changelog/3213.feature
diff --git a/changelog/3228.trivial.rst b/changelog/3228.trivial.rst
diff --git a/changelog/3236.feature.rst b/changelog/3236.feature.rst
diff --git a/changelog/3245.trivial.rst b/changelog/3245.trivial.rst
diff --git a/changelog/3246.trival.rst b/changelog/3246.trival.rst
diff --git a/changelog/3250.trivial.rst b/changelog/3250.trivial.rst
diff --git a/changelog/3255.feature.rst b/changelog/3255.feature.rst
diff --git a/changelog/3265.trivial.rst b/changelog/3265.trivial.rst
diff --git a/changelog/3268.trivial b/changelog/3268.trivial
diff --git a/changelog/3291.trivial.rst b/changelog/3291.trivial.rst
diff --git a/changelog/3292.trivial.rst b/changelog/3292.trivial.rst
diff --git a/changelog/3296.feature b/changelog/3296.feature
diff --git a/changelog/3296.trivial b/changelog/3296.trivial
diff --git a/changelog/3297.bugfix.rst b/changelog/3297.bugfix.rst
diff --git a/changelog/3304.trivial b/changelog/3304.trivial
diff --git a/changelog/3308.trivial.rst b/changelog/3308.trivial.rst
diff --git a/changelog/3312.feature b/changelog/3312.feature
diff --git a/changelog/3314.bugfix.rst b/changelog/3314.bugfix.rst
diff --git a/changelog/3339.trivial b/changelog/3339.trivial
@@ -0,0 +1 @@
+Import some modules from ``collections`` instead of ``collections.abc`` as the former modules trigger ``DeprecationWarning`` in Python 3.7.
diff --git a/changelog/3348.bugfix.rst b/changelog/3348.bugfix.rst
@@ -0,0 +1 @@
+``pytest.raises`` now raises ``TypeError`` when receiving an unknown keyword argument.
diff --git a/changelog/3360.trivial b/changelog/3360.trivial
@@ -0,0 +1,2 @@
+record_property is no longer experimental, removing the warnings was forgotten.
+
diff --git a/changelog/3372.bugfix.rst b/changelog/3372.bugfix.rst
@@ -0,0 +1 @@
+``pytest.raises`` now works with exception classes that look like iterables.
diff --git a/doc/en/development_guide.rst b/doc/en/development_guide.rst
@@ -2,7 +2,7 @@
 Development Guide
 =================
 
-Some general guidelines regarding development in pytest for core maintainers and general contributors. Nothing here
+Some general guidelines regarding development in pytest for maintainers and contributors. Nothing here
 is set in stone and can't be changed, feel free to suggest improvements or changes in the workflow.
 
 
@@ -37,72 +37,19 @@ Any question, feature, bug or proposal is welcome as an issue. Users are encoura
 GitHub issues should use labels to categorize them. Labels should be created sporadically, to fill a niche; we should
 avoid creating labels just for the sake of creating them.
 
-Here is a list of labels and a brief description mentioning their intent.
+Each label should include a description in the GitHub's interface stating its purpose.
 
+Temporary labels
+~~~~~~~~~~~~~~~~ 
 
-**Type**
+To classify issues for a special event it is encouraged to create a temporary label. This helps those involved to find
+the relevant issues to work on. Examples of that are sprints in Python events or global hacking events.
 
-* ``type: backward compatibility``: issue that will cause problems with old pytest versions.
-* ``type: bug``: problem that needs to be addressed.
-* ``type: deprecation``: feature that will be deprecated in the future.
-* ``type: docs``: documentation missing or needing clarification.
-* ``type: enhancement``: new feature or API change, should be merged into ``features``.
-* ``type: feature-branch``: new feature or API change, should be merged into ``features``.
-* ``type: infrastructure``: improvement to development/releases/CI structure.
-* ``type: performance``: performance or memory problem/improvement.
-* ``type: proposal``: proposal for a new feature, often to gather opinions or design the API around the new feature.
-* ``type: question``: question regarding usage, installation, internals or how to test something.
-* ``type: refactoring``: internal improvements to the code.
-* ``type: regression``: indicates a problem that was introduced in a release which was working previously.
+* ``temporary: EP2017 sprint``: candidate issues or PRs tackled during the EuroPython 2017
 
-**Status**
+Issues created at those events should have other relevant labels added as well.
 
-* ``status: critical``: grave problem or usability issue that affects lots of users.
-* ``status: easy``: easy issue that is friendly to new contributors.
-* ``status: help wanted``: core developers need help from experts on this topic.
-* ``status: needs information``: reporter needs to provide more information; can be closed after 2 or more weeks of inactivity.
-
-**Topic**
-
-* ``topic: collection``
-* ``topic: fixtures``
-* ``topic: parametrize``
-* ``topic: reporting``
-* ``topic: selection``
-* ``topic: tracebacks``
-
-**Plugin (internal or external)**
-
-* ``plugin: cache``
-* ``plugin: capture``
-* ``plugin: doctests``
-* ``plugin: junitxml``
-* ``plugin: monkeypatch``
-* ``plugin: nose``
-* ``plugin: pastebin``
-* ``plugin: pytester``
-* ``plugin: tmpdir``
-* ``plugin: unittest``
-* ``plugin: warnings``
-* ``plugin: xdist``
-
-
-**OS**
-
-Issues specific to a single operating system. Do not use as a means to indicate where an issue originated from, only
-for problems that happen **only** in that system.
-
-* ``os: linux``
-* ``os: mac``
-* ``os: windows``
-
-**Temporary**
-
-Used to classify issues for limited time, to help find issues related in events for example.
-They should be removed after they are no longer relevant.
-
-* ``temporary: EP2017 sprint``:
-* ``temporary: sprint-candidate``:
+Those labels should be removed after they are no longer relevant.
 
 
 .. include:: ../../HOWTORELEASE.rst
diff --git a/doc/en/example/reportingdemo.rst b/doc/en/example/reportingdemo.rst
@@ -358,7 +358,7 @@ get on the terminal - we are working on that)::
     >   int(s)
     E   ValueError: invalid literal for int() with base 10: 'qwe'
     
-    <0-codegen $PYTHON_PREFIX/lib/python3.5/site-packages/_pytest/python_api.py:609>:1: ValueError
+    <0-codegen $PYTHON_PREFIX/lib/python3.5/site-packages/_pytest/python_api.py:613>:1: ValueError
     ______________________ TestRaises.test_raises_doesnt _______________________
     
     self = <failure_demo.TestRaises object at 0xdeadbeef>

diff --git a/doc/en/fixture.rst b/doc/en/fixture.rst
@@ -294,7 +294,7 @@ The fixtures requested by ``test_foo`` will be instantiated in the following ord
 
 1. ``s1``: is the highest-scoped fixture (``session``).
 2. ``m1``: is the second highest-scoped fixture (``module``).
-3. ``tempdir``: is a ``function``-scoped fixture, required by ``f1``: it needs to be instantiated at this point
+3. ``tmpdir``: is a ``function``-scoped fixture, required by ``f1``: it needs to be instantiated at this point
    because it is a dependency of ``f1``.
 4. ``f1``: is the first ``function``-scoped fixture in ``test_foo`` parameter list.
 5. ``f2``: is the last ``function``-scoped fixture in ``test_foo`` parameter list.
@@ -623,6 +623,40 @@ Running the above tests results in the following test IDs being used::
    
    ======================= no tests ran in 0.12 seconds =======================
 
+.. _`fixture-parametrize-marks`:
+
+Using marks with parametrized fixtures
+--------------------------------------
+
+:func:`pytest.param` can be used to apply marks in values sets of parametrized fixtures in the same way
+that they can be used with :ref:`@pytest.mark.parametrize <@pytest.mark.parametrize>`.
+
+Example::
+
+    # content of test_fixture_marks.py
+    import pytest
+    @pytest.fixture(params=[0, 1, pytest.param(2, marks=pytest.mark.skip)])
+    def data_set(request):
+        return request.param
+
+    def test_data(data_set):
+        pass
+
+Running this test will *skip* the invocation of ``data_set`` with value ``2``::
+
+    $ pytest test_fixture_marks.py -v
+    =========================== test session starts ============================
+    platform linux -- Python 3.x.y, pytest-3.x.y, py-1.x.y, pluggy-0.x.y -- $PYTHON_PREFIX/bin/python3.5
+    cachedir: .pytest_cache
+    rootdir: $REGENDOC_TMPDIR, inifile:
+    collecting ... collected 3 items
+    
+    test_fixture_marks.py::test_data[0] PASSED                           [ 33%]
+    test_fixture_marks.py::test_data[1] PASSED                           [ 66%]
+    test_fixture_marks.py::test_data[2] SKIPPED                          [100%]
+    
+    =================== 2 passed, 1 skipped in 0.12 seconds ====================
+
 .. _`interdependent fixtures`:
 
 Modularity: using fixtures from a fixture function

diff --git a/doc/en/reference.rst b/doc/en/reference.rst
@@ -529,6 +529,8 @@ Initialization hooks called for plugins and ``conftest.py`` files.
 .. autofunction:: pytest_addhooks
 .. autofunction:: pytest_configure
 .. autofunction:: pytest_unconfigure
+.. autofunction:: pytest_sessionstart
+.. autofunction:: pytest_sessionfinish
 
 Test running hooks
 ~~~~~~~~~~~~~~~~~~

diff --git a/doc/en/writing_plugins.rst b/doc/en/writing_plugins.rst
@@ -85,8 +85,8 @@ sub directory but not for other directories::
 
 Here is how you might run it::
 
-     pytest test_flat.py   # will not show "setting up"
-     pytest a/test_sub.py  # will show "setting up"
+     pytest test_flat.py --capture=no  # will not show "setting up"
+     pytest a/test_sub.py --capture=no  # will show "setting up"
 
 .. note::
     If you have ``conftest.py`` files which do not reside in a

diff --git a/setup.py b/setup.py
@@ -60,7 +60,7 @@ def main():
         'six>=1.10.0',
         'setuptools',
         'attrs>=17.4.0',
-        'more_itertools>=4.0.0',
+        'more-itertools>=4.0.0',
     ]
     # if _PYTEST_SETUP_SKIP_PLUGGY_DEP is set, skip installing pluggy;
     # used by tox.ini to test with pluggy master
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Import some modules from ``collections`` instead of ``collections.abc`` as the former modules trigger ``DeprecationWarning`` in Python 3.7.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		``pytest.raises`` now raises ``TypeError`` when receiving an unknown keyword argument.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		record_property is no longer experimental, removing the warnings was forgotten.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		``pytest.raises`` now works with exception classes that look like iterables.