Skip to content

[flake8-pytest-style] Fix defaults when lint.flake8-pytest-style config section is empty (PT001, PT023)#13292

Merged
AlexWaygood merged 2 commits intoastral-sh:ruff-0.7from
dizzy57:pytest-parentheses-style-options-default
Oct 8, 2024
Merged

[flake8-pytest-style] Fix defaults when lint.flake8-pytest-style config section is empty (PT001, PT023)#13292
AlexWaygood merged 2 commits intoastral-sh:ruff-0.7from
dizzy57:pytest-parentheses-style-options-default

Conversation

@dizzy57
Copy link
Copy Markdown
Contributor

@dizzy57 dizzy57 commented Sep 9, 2024 •
edited
Loading

Summary

The documentation states that lint.flake8-pytest-style.*-parentheses options default to false, but if the user provides an empty [lint.flake8-pytest-style] config section, those options are suddenly set to true.

This is a bug. After #12838 changed the defaults, Flake8PytestStyleOptions::try_into_settings wasn't updated and still relies on the preview mode to set the defaults.

Reproduction

% ruff --version
ruff 0.6.4

% cat example.py
import pytest


@pytest.fixture()
def parentheses(): ...


@pytest.fixture
def no_parentheses(): ...

% ruff check --select PT001 --output-format concise example.py
example.py:4:1: PT001 [*] Use `@pytest.fixture` over `@pytest.fixture()`
Found 1 error.
[*] 1 fixable with the `--fix` option.

% echo '[lint.flake8-pytest-style]' > ruff.toml

% ruff check --select PT001 --output-format concise example.py
example.py:8:1: PT001 [*] Use `@pytest.fixture()` over `@pytest.fixture`
Found 1 error.
[*] 1 fixable with the `--fix` option.

Test Plan

Manual testing, see reproduction section.

% ./target/debug/ruff check --select PT001 --output-format concise example.py
warning: Detected debug build without --no-cache.
example.py:4:1: PT001 [*] Use `@pytest.fixture` over `@pytest.fixture()`
Found 1 error.
[*] 1 fixable with the `--fix` option.

% echo '[lint.flake8-pytest-style]' > ruff.toml

% ./target/debug/ruff check --select PT001 --output-format concise example.py
warning: Detected debug build without --no-cache.
example.py:4:1: PT001 [*] Use `@pytest.fixture` over `@pytest.fixture()`
Found 1 error.
[*] 1 fixable with the `--fix` option.

Given the fact that this was the only reference to ruff_linter::settings::types::PreviewMode in crates/ruff_workspace/src/options.rs, looks like no other settings depend on the preview mode, and it doesn't make much sense to me to write any additional tests that verify there's no interaction between preview mode and other default values.

@dizzy57
[flake8-pytest-style] Fix defaults for empty `lint.flake8-pytest-st…
2a0d8ff 
…yle.*-parentheses` config (`PT001`, `PT023`)
@dizzy57 dizzy57 changed the title [flake8-pytest-style] Fix defaults for missing lint.flake8-pytest-style.*-parentheses configs (PT001, PT023) [flake8-pytest-style] Fix defaults when lint.flake8-pytest-style config section is empty (PT001, PT023) Sep 9, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Sep 9, 2024 •
edited
Loading

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

AlexWaygood
AlexWaygood approved these changes Sep 9, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Sorry we didn't catch this, that's on us :-(

Unfortunately, however, this is will be a breaking change for some users, so we'll have to merge this as part of the 0.7 release. That should come at some point in the next few weeks, though; shouldn't be too long to wait :)

@AlexWaygood AlexWaygood added this to the v0.7 milestone Sep 9, 2024
@MichaReiser MichaReiser added breaking Breaking API change configuration Related to settings and configuration labels Sep 9, 2024
@AlexWaygood AlexWaygood changed the base branch from main to ruff-0.7 October 8, 2024 13:10
@AlexWaygood AlexWaygood merged commit 91161b4 into astral-sh:ruff-0.7 Oct 8, 2024
@dizzy57 dizzy57 deleted the pytest-parentheses-style-options-default branch October 8, 2024 17:01
AlexWaygood pushed a commit that referenced this pull request Oct 17, 2024
@dizzy57 @AlexWaygood
[flake8-pytest-style] Fix defaults when lint.flake8-pytest-style …
2b87587 
…config section is empty (`PT001`, `PT023`) (#13292)
@BrewTestBot BrewTestBot mentioned this pull request Oct 17, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexWaygood AlexWaygood AlexWaygood approved these changes

Assignees

No one assigned

Labels

breaking Breaking API change configuration Related to settings and configuration

Projects

None yet

Milestone

v0.7

Development

Successfully merging this pull request may close these issues.

3 participants

@dizzy57 @AlexWaygood @MichaReiser