feat: Support for pytest_describe

Author: Leonidas Loucas

pylint_pytest/checkers/fixture.py

@@ -1,3 +1,4 @@
+import re
 import os
 import sys
 from pathlib import Path
@@ -10,6 +11,7 @@
 import pytest
 from ..utils import (
     _can_use_fixture,
+    _is_in_describe_section_when_enabled,
     _is_pytest_mark,
     _is_pytest_mark_usefixtures,
     _is_pytest_fixture,
@@ -72,6 +74,7 @@ class FixtureChecker(BasePytestChecker):
     _invoked_with_func_args = set()
     _invoked_with_usefixtures = set()
     _original_add_message = callable
+    enable_plugin = True
 
     def open(self):
         # patch VariablesChecker.add_message
@@ -217,6 +220,11 @@ def patch_add_message(self, msgid, line=None, node=None, args=None,
         '''
         - intercept and discard unwanted warning messages
         '''
+        if not FixtureChecker.enable_plugin:
+            FixtureChecker._original_add_message(
+                self, msgid, line, node, args, confidence, col_offset
+            )
+            return
         # check W0611 unused-import
         if msgid == 'unused-import':
             # actual attribute name is not passed as arg so...dirty hack
@@ -265,6 +273,12 @@ def patch_add_message(self, msgid, line=None, node=None, args=None,
                 node.name in FixtureChecker._pytest_fixtures:
             return
 
+        # check W0612 unused-variable
+        if msgid == 'unused-variable' and \
+                _is_in_describe_section_when_enabled(node):
+            return
+
+
         if int(pylint.__version__.split('.')[0]) >= 2:
             FixtureChecker._original_add_message(
                 self, msgid, line, node, args, confidence, col_offset)

pylint_pytest/utils.py

@@ -1,5 +1,49 @@
 import inspect
+import re
 import astroid
+import pytest
+import sys
+
+
+PYTEST_LT_7_0 = getattr(pytest, 'version_tuple', (0, 0)) < (7, 0)
+
+
+try:
+    import pytest_describe
+    PYTEST_DESCRIBE = True
+except ImportError:
+    PYTEST_DESCRIBE = False
+    describe_prefixes_option = ()
+
+
+if PYTEST_DESCRIBE:
+    describe_prefix = "describe"
+    try:
+        import _pytest.config.findpaths
+        config = _pytest.config.findpaths.determine_setup([], sys.argv[1:])
+        if config:
+            if PYTEST_LT_7_0:
+                describe_prefix = config[2].config.sections.get('tool:pytest', {}).get('describe_prefixes', describe_prefix)
+            else:
+                describe_prefix = config[2].get('describe_prefixes', describe_prefix)
+    finally:
+        describe_prefixes_option = tuple(describe_prefix.split(' '))
+
+
+describe_prefix_matcher = re.compile(fr'^{"|".join(describe_prefixes_option)}_.+$')
+
+
+def _is_in_describe_section_when_enabled(node):
+    import _pytest.config.findpaths
+    describe_prefix = "describe"
+    config = _pytest.config.findpaths.determine_setup([], sys.argv[1:])
+    if config:
+        if PYTEST_LT_7_0:
+            describe_prefix = config[2].config.sections.get('tool:pytest', {}).get('describe_prefixes', describe_prefix)
+        else:
+            describe_prefix = config[2].get('describe_prefixes', describe_prefix)
+    return (PYTEST_DESCRIBE and
+        (node.parent is not None and isinstance(node.parent, astroid.FunctionDef) and re.match(describe_prefix_matcher, node.parent.name)))
 
 
 def _is_pytest_mark_usefixtures(decorator):
@@ -84,7 +128,7 @@ def _can_use_fixture(function):
     if isinstance(function, astroid.FunctionDef):
 
         # test_*, *_test
-        if function.name.startswith('test_') or function.name.endswith('_test'):
+        if function.name.startswith('test_') or function.name.endswith('_test') or _is_in_describe_section_when_enabled(function):
             return True
 
         if function.decorators:

setup.cfg

@@ -4,6 +4,7 @@ test = pytest
 [tool:pytest]
 addopts = --verbose
 python_files = tests/test_*.py
+describe_prefixes = describe context
 
 [bdist_wheel]
-universal = 1
+universal = 1

setup.py

@@ -12,7 +12,7 @@
 
 setup(
     name='pylint-pytest',
-    version='1.1.2',
+    version='1.1.3',
     author='Reverb Chu',
     author_email='pylint-pytest@reverbc.tw',
     maintainer='Reverb Chu',
@@ -27,6 +27,9 @@
         'pylint',
         'pytest>=4.6',
     ],
+    extras_require={
+        'pytest_describe': ['pytest_describe'],
+    },
     python_requires='>=3.6',
     classifiers=[
         'Development Status :: 5 - Production/Stable',
@@ -43,6 +46,6 @@
         'Operating System :: OS Independent',
         'License :: OSI Approved :: MIT License',
     ],
-    tests_require=['pytest', 'pylint'],
+    tests_require=['pytest', 'pytest_describe', 'pylint'],
     keywords=['pylint', 'pytest', 'plugin'],
 )

tests/base_tester.py

@@ -28,6 +28,7 @@ class BasePytestTester(object):
 
     def run_linter(self, enable_plugin, file_path=None):
         self.enable_plugin = enable_plugin
+        self.CHECKER_CLASS.enable_plugin = enable_plugin
 
         # pylint: disable=protected-access
         if file_path is None:

tests/input/unused-argument/describe.py

@@ -0,0 +1,9 @@
+import pytest
+
+def describe_stuff():
+    @pytest.fixture()
+    def fix():
+        pass
+
+    def run(fix):
+        pass

tests/input/unused-argument/describe_nested.py

@@ -0,0 +1,10 @@
+import pytest
+
+def describe_stuff():
+    @pytest.fixture()
+    def fix():
+        pass
+
+    def context_more():
+        def run(fix):
+            pass

tests/input/unused-variable/describe.py

@@ -0,0 +1,9 @@
+import pytest
+
+def describe_stuff():
+    @pytest.fixture()
+    def fix():
+        pass
+
+    def run(fix):
+        pass

tests/input/unused-variable/describe_nested.py

@@ -0,0 +1,14 @@
+import pytest
+
+def describe_stuff():
+    @pytest.fixture()
+    def fix():
+        pass
+
+    def context_more():
+        @pytest.fixture()
+        def fix(fix):
+            pass
+
+        def run(fix):
+            pass

tests/test_unused_argument.py

@@ -28,3 +28,13 @@ def test_caller_not_a_test_func(self, enable_plugin):
     def test_args_and_kwargs(self, enable_plugin):
         self.run_linter(enable_plugin)
         self.verify_messages(2)
+
+    @pytest.mark.parametrize('enable_plugin', [True, False])
+    def test_describe(self, enable_plugin):
+        self.run_linter(enable_plugin)
+        self.verify_messages(0 if enable_plugin else 1)
+
+    @pytest.mark.parametrize('enable_plugin', [True, False])
+    def test_describe_nested(self, enable_plugin):
+        self.run_linter(enable_plugin)
+        self.verify_messages(0 if enable_plugin else 1)