Invert defaults for pytest-fixture-no-parentheses and `pytest-mark-…

…no-parentheses` (#280)
m-burst · Apr 1, 2024 · 87ac31f · 87ac31f
1 parent 705c2ad
commit 87ac31f
Show file tree

Hide file tree

Showing 17 changed files with 90 additions and 76 deletions.
diff --git a/README.md b/README.md
@@ -83,6 +83,10 @@ MIT
 
 **Unreleased**
 
+* **BREAKING:** invert default values for `pytest-fixture-no-parentheses` and `pytest-mark-no-parentheses`
+  to conform with `pytest` official style
+  * If you get a lot of [PT001] or [PT023] violations after upgrading, consider setting explicit values
+    for these configuration options
 * require at least Python 3.8.1
 * support Python 3.12
 

diff --git a/docs/rules/PT001.md b/docs/rules/PT001.md
@@ -1,25 +1,25 @@
 # PT001
 
-`use @pytest.fixture() over @pytest.fixture`
+`use @pytest.fixture over @pytest.fixture()`
 
 ## Configuration
 
 * `pytest-fixture-no-parentheses`  
 Boolean flag specifying whether `@pytest.fixture()` without parameters
 should have parentheses.  
-If the option is set to false (the default), `@pytest.fixture()` is valid
-and `@pytest.fixture` is an error.  
-If set to true, `@pytest.fixture` is valid and `@pytest.fixture()` is
+If the option is set to true (the default), `@pytest.fixture` is valid
+and `@pytest.fixture()` is an error.  
+If set to false, `@pytest.fixture()` is valid and `@pytest.fixture` is
 an error.
 
 ## Examples
 
-Bad code (assuming `pytest-fixture-no-parentheses` set to false):
+Bad code (assuming `pytest-fixture-no-parentheses` set to true):
 
 ```python
 import pytest
 
-@pytest.fixture
+@pytest.fixture()
 def my_fixture():
     ...
 ```
@@ -29,7 +29,7 @@ Good code:
 ```python
 import pytest
 
-@pytest.fixture()
+@pytest.fixture
 def my_fixture():
     ...
 ```

diff --git a/docs/rules/PT023.md b/docs/rules/PT023.md
@@ -1,25 +1,25 @@
 # PT023
 
-`use @pytest.mark.foo() over @pytest.mark.foo`
+`use @pytest.mark.foo over @pytest.mark.foo()`
 
 ## Configuration
 
 * `pytest-mark-no-parentheses`  
 Boolean flag specifying whether `@pytest.mark.foo()` without parameters
 should have parentheses.  
-If the option is set to false (the default), `@pytest.mark.foo()` is valid
-and `@pytest.mark.foo` is an error.  
-If set to true, `@pytest.mark.foo` is valid and `@pytest.mark.foo()` is
+If the option is set to true (the default), `@pytest.mark.foo` is valid
+and `@pytest.mark.foo()` is an error.  
+If set to false, `@pytest.mark.foo()` is valid and `@pytest.mark.foo` is
 an error.
 
 ## Examples
 
-Bad code (assuming `pytest-mark-no-parentheses` set to false):
+Bad code (assuming `pytest-mark-no-parentheses` set to true):
 
 ```python
 import pytest
 
-@pytest.mark.foo
+@pytest.mark.foo()
 def test_something():
     ...
 ```
@@ -29,7 +29,7 @@ Good code:
 ```python
 import pytest
 
-@pytest.mark.foo()
+@pytest.mark.foo
 def test_something():
     ...
 ```

diff --git a/flake8_pytest_style/config.py b/flake8_pytest_style/config.py
@@ -32,7 +32,7 @@ class Config(NamedTuple):
 
 
 DEFAULT_CONFIG = Config(
-    fixture_parentheses=True,
+    fixture_parentheses=False,
     raises_require_match_for=[
         'BaseException',
         'Exception',
@@ -45,5 +45,5 @@ class Config(NamedTuple):
     parametrize_names_type=ParametrizeNamesType.TUPLE,
     parametrize_values_type=ParametrizeValuesType.LIST,
     parametrize_values_row_type=ParametrizeValuesRowType.TUPLE,
-    mark_parentheses=True,
+    mark_parentheses=False,
 )
diff --git a/tests/test_PT001_incorrect_fixture_parentheses_style.py b/tests/test_PT001_incorrect_fixture_parentheses_style.py
@@ -4,6 +4,10 @@
 from flake8_pytest_style.errors import IncorrectFixtureParenthesesStyle
 from flake8_pytest_style.visitors import FixturesVisitor
 
+# make the configs independent of the actual default
+_CONFIG_WITHOUT_PARENS = DEFAULT_CONFIG._replace(fixture_parentheses=False)
+_CONFIG_WITH_PARENS = DEFAULT_CONFIG._replace(fixture_parentheses=True)
+
 
 def test_ok_no_parameters():
     code = """
@@ -13,7 +17,7 @@ def test_ok_no_parameters():
         def my_fixture():
             return 0
     """
-    assert_not_error(FixturesVisitor, code, config=DEFAULT_CONFIG)
+    assert_not_error(FixturesVisitor, code, config=_CONFIG_WITH_PARENS)
 
 
 def test_ok_with_parameters():
@@ -24,7 +28,7 @@ def test_ok_with_parameters():
         def my_fixture():
             return 0
     """
-    assert_not_error(FixturesVisitor, code, config=DEFAULT_CONFIG)
+    assert_not_error(FixturesVisitor, code, config=_CONFIG_WITH_PARENS)
 
 
 def test_ok_without_parens():
@@ -35,8 +39,7 @@ def test_ok_without_parens():
         def my_fixture():
             return 0
     """
-    config = DEFAULT_CONFIG._replace(fixture_parentheses=False)
-    assert_not_error(FixturesVisitor, code, config=config)
+    assert_not_error(FixturesVisitor, code, config=_CONFIG_WITHOUT_PARENS)
 
 
 def test_error_without_parens():
@@ -51,7 +54,7 @@ def my_fixture():
         FixturesVisitor,
         code,
         IncorrectFixtureParenthesesStyle,
-        config=DEFAULT_CONFIG,
+        config=_CONFIG_WITH_PARENS,
         expected_parens='()',
         actual_parens='',
     )
@@ -65,12 +68,11 @@ def test_error_with_parens():
         def my_fixture():
             return 0
     """
-    config = DEFAULT_CONFIG._replace(fixture_parentheses=False)
     assert_error(
         FixturesVisitor,
         code,
         IncorrectFixtureParenthesesStyle,
-        config=config,
+        config=_CONFIG_WITHOUT_PARENS,
         expected_parens='',
         actual_parens='()',
     )
diff --git a/tests/test_PT002_fixture_positional_args.py b/tests/test_PT002_fixture_positional_args.py
@@ -9,7 +9,7 @@ def test_ok_no_args():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def my_fixture():
             return 0
     """

diff --git a/tests/test_PT003_extraneous_scope_function.py b/tests/test_PT003_extraneous_scope_function.py
@@ -9,7 +9,7 @@ def test_ok_no_scope():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def my_fixture():
             return 0
     """

diff --git a/tests/test_PT004_missing_fixture_name_underscore.py b/tests/test_PT004_missing_fixture_name_underscore.py
@@ -9,7 +9,7 @@ def test_ok_simple():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def _patch_something(mocker):
             mocker.patch('some.thing')
     """
@@ -20,7 +20,7 @@ def test_ok_with_return():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def _patch_something(mocker):
             if something:
                 return
@@ -33,7 +33,7 @@ def test_ok_with_yield():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def _activate_context():
             with context:
                 yield
@@ -48,7 +48,7 @@ def test_ok_abstract_with_import_abc():
         import pytest
 
         class BaseTest:
-            @pytest.fixture()
+            @pytest.fixture
             @abc.abstractmethod
             def my_fixture():
                 raise NotImplementedError
@@ -63,7 +63,7 @@ def test_ok_abstract_with_from_import():
         import pytest
 
         class BaseTest:
-            @pytest.fixture()
+            @pytest.fixture
             @abstractmethod
             def my_fixture():
                 raise NotImplementedError
@@ -75,7 +75,7 @@ def test_ok_ignoring_yield_from():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def my_fixture():
             yield from some_generator()
     """
@@ -86,7 +86,7 @@ def test_error_simple():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def patch_something(mocker):
             mocker.patch('some.thing')
     """
@@ -103,7 +103,7 @@ def test_error_with_yield():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def activate_context():
             with context:
                 yield

diff --git a/tests/test_PT005_incorrect_fixture_name_underscore.py b/tests/test_PT005_incorrect_fixture_name_underscore.py
@@ -9,7 +9,7 @@ def test_ok_with_return():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def my_fixture(mocker):
             return 0
     """
@@ -20,7 +20,7 @@ def test_ok_with_yield():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def activate_context():
             with get_context() as context:
                 yield context
@@ -30,7 +30,7 @@ def activate_context():
 
 def test_ok_nested_function():
     code = """
-        @pytest.fixture()
+        @pytest.fixture
         def _any_fixture(mocker):
             def nested_function():
                 return 1
@@ -47,7 +47,7 @@ def test_ok_abstract_with_import_abc():
         import pytest
 
         class BaseTest:
-            @pytest.fixture()
+            @pytest.fixture
             @abc.abstractmethod
             def _my_fixture():
                 return NotImplemented
@@ -62,7 +62,7 @@ def test_ok_abstract_with_from_import():
         import pytest
 
         class BaseTest:
-            @pytest.fixture()
+            @pytest.fixture
             @abstractmethod
             def _my_fixture():
                 return NotImplemented
@@ -74,7 +74,7 @@ def test_error_with_return():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def _my_fixture(mocker):
             return 0
     """
@@ -91,7 +91,7 @@ def test_error_with_yield():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def _activate_context():
             with get_context() as context:
                 yield context
@@ -109,7 +109,7 @@ def test_error_with_conditional_yield_from():
     code = """
         import pytest
 
-        @pytest.fixture()
+        @pytest.fixture
         def _activate_context():
             if some_condition:
                 with get_context() as context:

diff --git a/tests/test_PT020_deprecated_yield_fixture.py b/tests/test_PT020_deprecated_yield_fixture.py
@@ -4,6 +4,10 @@
 from flake8_pytest_style.errors import DeprecatedYieldFixture
 from flake8_pytest_style.visitors import FixturesVisitor
 
+# make the configs independent of the actual default
+_CONFIG_WITHOUT_PARENS = DEFAULT_CONFIG._replace(fixture_parentheses=False)
+_CONFIG_WITH_PARENS = DEFAULT_CONFIG._replace(fixture_parentheses=True)
+
 
 def test_ok_no_parameters():
     code = """
@@ -13,7 +17,7 @@ def test_ok_no_parameters():
         def my_fixture():
             return 0
     """
-    assert_not_error(FixturesVisitor, code, config=DEFAULT_CONFIG)
+    assert_not_error(FixturesVisitor, code, config=_CONFIG_WITH_PARENS)
 
 
 def test_ok_without_parens():
@@ -24,28 +28,30 @@ def test_ok_without_parens():
         def my_fixture():
             return 0
     """
-    config = DEFAULT_CONFIG._replace(fixture_parentheses=False)
-    assert_not_error(FixturesVisitor, code, config=config)
+    assert_not_error(FixturesVisitor, code, config=_CONFIG_WITHOUT_PARENS)
 
 
 def test_error_without_parens():
     code = """
         import pytest
 
-        @pytest.yield_fixture()
+        @pytest.yield_fixture
         def my_fixture():
             return 0
     """
-    assert_error(FixturesVisitor, code, DeprecatedYieldFixture, config=DEFAULT_CONFIG)
+    assert_error(
+        FixturesVisitor, code, DeprecatedYieldFixture, config=_CONFIG_WITHOUT_PARENS
+    )
 
 
 def test_error_with_parens():
     code = """
         import pytest
 
-        @pytest.yield_fixture
+        @pytest.yield_fixture()
         def my_fixture():
             return 0
     """
-    config = DEFAULT_CONFIG._replace(fixture_parentheses=False)
-    assert_error(FixturesVisitor, code, DeprecatedYieldFixture, config=config)
+    assert_error(
+        FixturesVisitor, code, DeprecatedYieldFixture, config=_CONFIG_WITH_PARENS
+    )