introduce name filtering for marker iteration again

Author: RonnyPfannschmidt

_pytest/fixtures.py

@@ -988,7 +988,7 @@ def getfixtureinfo(self, node, func, cls, funcargs=True):
             argnames = getfuncargnames(func, cls=cls)
         else:
             argnames = ()
-        usefixtures = flatten(mark.args for mark in node.iter_markers() if mark.name == "usefixtures")
+        usefixtures = flatten(mark.args for mark in node.iter_markers(name="usefixtures"))
         initialnames = argnames
         initialnames = tuple(usefixtures) + initialnames
         fm = node.session._fixturemanager

_pytest/mark/evaluate.py

@@ -35,7 +35,7 @@ def wasvalid(self):
         return not hasattr(self, 'exc')
 
     def _get_marks(self):
-        return [x for x in self.item.iter_markers() if x.name == self._mark_name]
+        return list(self.item.iter_markers(name=self._mark_name))
 
     def invalidraise(self, exc):
         raises = self.get('raises')

_pytest/nodes.py

@@ -183,20 +183,32 @@ def add_marker(self, marker):
         self.keywords[marker.name] = marker
         self.own_markers.append(marker)
 
-    def iter_markers(self):
+    def iter_markers(self, name=None):
         """
+        :param name: if given, filter the results by the name attribute
+
         iterate over all markers of the node
         """
-        return (x[1] for x in self.iter_markers_with_node())
+        return (x[1] for x in self.iter_markers_with_node(name=name))
 
-    def iter_markers_with_node(self):
+    def iter_markers_with_node(self, name=None):
         """
+        :param name: if given, filter the results by the name attribute
+
         iterate over all markers of the node
         returns sequence of tuples (node, mark)
         """
         for node in reversed(self.listchain()):
             for mark in node.own_markers:
-                yield node, mark
+                if name is None or getattr(mark, 'name', None) == name:
+                    yield node, mark
+
+    def get_closest_marker(self, name, default=None):
+        """return the first marker matching the name
+        :param default: fallback return value of no marker was found
+        :param name: name to filter by
+        """
+        return next(self.iter_markers(name=name), default)
 
     def get_marker(self, name):
         """ get a marker object from this node or None if
@@ -206,7 +218,7 @@ def get_marker(self, name):
 
           deprecated
         """
-        markers = [x for x in self.iter_markers() if x.name == name]
+        markers = list(self.iter_markers(name=name))
         if markers:
             return MarkInfo(markers)
 

_pytest/python.py

@@ -118,9 +118,8 @@ def pytest_generate_tests(metafunc):
         if hasattr(metafunc.function, attr):
             msg = "{0} has '{1}', spelling should be 'parametrize'"
             raise MarkerError(msg.format(metafunc.function.__name__, attr))
-    for marker in metafunc.definition.iter_markers():
-        if marker.name == 'parametrize':
-            metafunc.parametrize(*marker.args, **marker.kwargs)
+    for marker in metafunc.definition.iter_markers(name='parametrize'):
+        metafunc.parametrize(*marker.args, **marker.kwargs)
 
 
 def pytest_configure(config):

_pytest/skipping.py

@@ -64,9 +64,7 @@ def pytest_runtest_setup(item):
         item._skipped_by_mark = True
         skip(eval_skipif.getexplanation())
 
-    for skip_info in item.iter_markers():
-        if skip_info.name != 'skip':
-            continue
+    for skip_info in item.iter_markers(name='skip'):
         item._skipped_by_mark = True
         if 'reason' in skip_info.kwargs:
             skip(skip_info.kwargs['reason'])

_pytest/warnings.py

@@ -60,10 +60,9 @@ def catch_warnings_for_item(item):
         for arg in inifilters:
             _setoption(warnings, arg)
 
-        for mark in item.iter_markers():
-            if mark.name == 'filterwarnings':
-                for arg in mark.args:
-                    warnings._setoption(arg)
+        for mark in item.iter_markers(name='filterwarnings'):
+            for arg in mark.args:
+                warnings._setoption(arg)
 
         yield
 

changelog/3446.feature

@@ -0,0 +1 @@
+introduce node.get_closest_marker(name, default=None) to support simple marker usage setups.

changelog/3459.feature

@@ -0,0 +1 @@
+Introduce optional name based filtering for iter_markers

doc/en/example/markers.rst

@@ -330,7 +330,7 @@ specifies via named environments::
             "env(name): mark test to run only on named environment")
 
     def pytest_runtest_setup(item):
-        envnames = [mark.args[0] for mark in item.iter_markers() if mark.name == "env"]
+        envnames = [mark.args[0] for mark in item.iter_markers(name='env')]
         if envnames:
             if item.config.getoption("-E") not in envnames:
                 pytest.skip("test requires env in %r" % envnames)
@@ -402,10 +402,9 @@ Below is the config file that will be used in the next examples::
     import sys
 
     def pytest_runtest_setup(item):
-        for marker in item.iter_markers():
-            if marker.name == 'my_marker':
-                print(marker)
-                sys.stdout.flush()
+        for marker in item.iter_markers(name='my_marker'):
+            print(marker)
+            sys.stdout.flush()
 
 A custom marker can have its argument set, i.e. ``args`` and ``kwargs`` properties, defined by either invoking it as a callable or using ``pytest.mark.MARKER_NAME.with_args``. These two methods achieve the same effect most of the time.
 
@@ -458,10 +457,9 @@ test function.  From a conftest file we can read it like this::
     import sys
 
     def pytest_runtest_setup(item):
-        for mark in item.iter_markers():
-            if mark.name == 'glob':
-                print ("glob args=%s kwargs=%s" %(mark.args, mark.kwargs))
-                sys.stdout.flush()
+        for mark in item.iter_markers(name='glob'):
+            print ("glob args=%s kwargs=%s" %(mark.args, mark.kwargs))
+            sys.stdout.flush()
 
 Let's run this without capturing output and see what we get::
 

doc/en/usage.rst

@@ -274,10 +274,9 @@ Alternatively, you can integrate this functionality with custom markers:
 
     def pytest_collection_modifyitems(session, config, items):
         for item in items:
-            for marker in item.iter_markers():
-                if marker.name == 'test_id':
-                    test_id = marker.args[0]
-                    item.user_properties.append(('test_id', test_id))
+            for marker in item.iter_markers(name='test_id'):
+                test_id = marker.args[0]
+                item.user_properties.append(('test_id', test_id))
 
 And in your tests: