Add package scoped fixtures #2283

AUTHORS

@@ -87,6 +87,7 @@ Hugo van Kemenade
 Hui Wang (coldnight)
 Ian Bicking
 Ian Lesperance
+Ionuț Turturică
 Jaap Broekhuizen
 Jan Balster
 Janne Vanhala
@@ -190,6 +191,7 @@ Tareq Alayan
 Ted Xiao
 Thomas Grainger
 Thomas Hisch
+Tim Strazny
 Tom Dalton
 Tom Viner
 Trevor Bekolay

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>`_)
 

_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
 

_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))

_pytest/fixtures.py

@@ -36,6 +36,7 @@ def pytest_sessionstart(session):
     import _pytest.nodes
 
     scopename2class.update({
+        'package': _pytest.python.Package,
         'class': _pytest.python.Class,
         'module': _pytest.python.Module,
         'function': _pytest.nodes.Item,
@@ -48,6 +49,7 @@ def pytest_sessionstart(session):
 
 
 scope2props = dict(session=())
+scope2props["package"] = ("fspath",)
 scope2props["module"] = ("fspath", "module")
 scope2props["class"] = scope2props["module"] + ("cls",)
 scope2props["instance"] = scope2props["class"] + ("instance", )
@@ -156,9 +158,11 @@ def get_parametrized_fixture_keys(item, scopenum):
                 continue
             if scopenum == 0:    # session
                 key = (argname, param_index)
-            elif scopenum == 1:  # module
+            elif scopenum == 1:  # package
                 key = (argname, param_index, item.fspath)
-            elif scopenum == 2:  # class
+            elif scopenum == 2:  # module
+                key = (argname, param_index, item.fspath)
+            elif scopenum == 3:  # class
                 key = (argname, param_index, item.fspath, item.cls)
             yield key
 
@@ -596,7 +600,7 @@ class ScopeMismatchError(Exception):
     """
 
 
-scopes = "session module class function".split()
+scopes = "session package module class function".split()
 scopenum_function = scopes.index("function")
 
 

_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

_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

_pytest/main.py

@@ -405,17 +405,30 @@ def collect(self):
 
     def _collect(self, arg):
         names = self._parsearg(arg)
-        path = names.pop(0)
-        if path.check(dir=1):
+        argpath = names.pop(0)
+        paths = []
+        if argpath.check(dir=1):
             assert not names, "invalid arg %r" % (arg,)
-            for path in path.visit(fil=lambda x: x.check(file=1),
-                                   rec=self._recurse, bf=True, sort=True):
-                for x in self._collectfile(path):
-                    yield x
+            for path in argpath.visit(fil=lambda x: x.check(file=1),
+                                      rec=self._recurse, bf=True, sort=True):
+                pkginit = path.dirpath().join('__init__.py')
+                if pkginit.exists() and not any(x in pkginit.parts() for x in paths):
+                    for x in self._collectfile(pkginit):
+                        yield x
+                        paths.append(x.fspath.dirpath())
+
+                if not any(x in path.parts() for x in paths):
+                    for x in self._collectfile(path):
+                        yield x
         else:
-            assert path.check(file=1)
-            for x in self.matchnodes(self._collectfile(path), names):
-                yield x
+            assert argpath.check(file=1)
+            pkginit = argpath.dirpath().join('__init__.py')
+            if not self.isinitpath(argpath) and pkginit.exists():
+                for x in self._collectfile(pkginit):
+                    yield x
+            else:
+                for x in self.matchnodes(self._collectfile(argpath), names):
+                    yield x
 
     def _collectfile(self, path):
         ihook = self.gethookproxy(path)

_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
 

_pytest/mark/structures.py

@@ -1,4 +1,9 @@
-from collections import namedtuple, MutableMapping as MappingMixin
+import sys
+if sys.version_info >= (3, 4):
+    from collections.abc import MutableMapping as MappingMixin
+else:
+    from collections import MutableMapping as MappingMixin
+from collections import namedtuple
 import warnings
 from operator import attrgetter
 import inspect

_pytest/python.py

@@ -17,6 +17,7 @@
 from _pytest.config import hookimpl
 
 import _pytest
+from _pytest.main import Session
 import pluggy
 from _pytest import fixtures
 from _pytest import nodes
@@ -157,7 +158,7 @@ def pytest_collect_file(path, parent):
     ext = path.ext
     if ext == ".py":
         if not parent.session.isinitpath(path):
-            for pat in parent.config.getini('python_files'):
+            for pat in parent.config.getini('python_files') + ['__init__.py']:
                 if path.fnmatch(pat):
                     break
             else:
@@ -167,9 +168,24 @@ def pytest_collect_file(path, parent):
 
 
 def pytest_pycollect_makemodule(path, parent):
+    if path.basename == '__init__.py':
+        return Package(path, parent)
     return Module(path, parent)
 
 
+def pytest_ignore_collect(path, config):
+    # Skip duplicate packages.
+    keepduplicates = config.getoption("keepduplicates")
+    if keepduplicates:
+        duplicate_paths = config.pluginmanager._duplicatepaths
+        if path.basename == '__init__.py':
+            if path in duplicate_paths:
+                return True
+            else:
+                duplicate_paths.add(path)
+
+
+
 @hookimpl(hookwrapper=True)
 def pytest_pycollect_makeitem(collector, name, obj):
     outcome = yield
@@ -475,6 +491,38 @@ def setup(self):
             self.addfinalizer(teardown_module)
 
 
+class Package(Session, Module):
+
+    def __init__(self, fspath, parent=None, config=None, session=None, nodeid=None):
+        session = parent.session
+        nodes.FSCollector.__init__(
+            self, fspath, parent=parent,
+            config=config, session=session, nodeid=nodeid)
+        self.name = fspath.pyimport().__name__
+        self.trace = session.trace
+        self._norecursepatterns = session._norecursepatterns
+        #keepduplicates = session.config.getoption("keepduplicates")
+        #if not keepduplicates:
+        for path in list(session.config.pluginmanager._duplicatepaths):
+            if path.dirname == fspath.dirname and path != fspath:
+                session.config.pluginmanager._duplicatepaths.remove(path)
+        pass
+
+    def isinitpath(self, path):
+        return path in self.session._initialpaths
+
+    def collect(self):
+        path = self.fspath.dirpath()
+        pkg_prefix = None
+        for path in path.visit(fil=lambda x: 1,
+                               rec=self._recurse, bf=True, sort=True):
+            if pkg_prefix and pkg_prefix in path.parts():
+                continue
+            for x in self._collectfile(path):
+                yield x
+                if isinstance(x, Package):
+                    pkg_prefix = path.dirpath()
+
 def _get_xunit_setup_teardown(holder, attr_name, param_obj=None):
     """
     Return a callable to perform xunit-style setup or teardown if

_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

changelog/2283.feature

@@ -0,0 +1 @@
+Pytest now supports package-level fixtures.

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.

changelog/3348.bugfix.rst

@@ -0,0 +1 @@
+``pytest.raises`` now raises ``TypeError`` when receiving an unknown keyword argument.

changelog/3360.trivial

@@ -0,0 +1,2 @@
+record_property is no longer experimental, removing the warnings was forgotten.
+

changelog/3372.bugfix.rst

@@ -0,0 +1 @@
+``pytest.raises`` now works with exception classes that look like iterables.