-
Notifications
You must be signed in to change notification settings - Fork 1.5k
[formatter] Fix missing blank lines before decorated classes in .pyi files #18888
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The code changes look good. Can you run |
MichaReiser
approved these changes
Jun 24, 2025
Thank you, this is great |
|
dcreager
added a commit
that referenced
this pull request
Jun 24, 2025
* main: [ty] Fix false positives when subscripting an object inferred as having an `Intersection` type (#18920) [`flake8-use-pathlib`] Add autofix for `PTH202` (#18763) [ty] Add relative import completion tests [ty] Clarify what "cursor" means [ty] Add a cursor test builder [ty] Enforce sort order of completions (#18917) [formatter] Fix missing blank lines before decorated classes in .pyi files (#18888) Apply fix availability and applicability when adding to `DiagnosticGuard` and remove `NoqaCode::rule` (#18834) py-fuzzer: allow relative executable paths (#18915) [ty] Change `environment.root` to accept multiple paths (#18913) [ty] Rename `src.root` setting to `environment.root` (#18760) Use file path for detecting package root (#18914) Consider virtual path for various server actions (#18910) [ty] Introduce `UnionType::try_from_elements` and `UnionType::try_map` (#18911) [ty] Support narrowing on `isinstance()`/`issubclass()` if the second argument is a dynamic, intersection, union or typevar type (#18900) [ty] Add decorator check for implicit attribute assignments (#18587) [`ruff`] Trigger `RUF037` for empty string and byte strings (#18862) [ty] Avoid duplicate diagnostic in unpacking (#18897) [`pyupgrade`] Extend version detection to include `sys.version_info.major` (`UP036`) (#18633) [`ruff`] Frozen Dataclass default should be valid (`RUF009`) (#18735)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes missing blank lines before decorated classes that follow functions in
.pyi
(stub) files.Problem: When a decorated class follows a function definition in a stub file, the formatter was incorrectly omitting the blank line before the class, resulting in formatting like:
Solution: Removed the
class_decorator_instead_of_empty_line
condition that was preventing blank lines from being inserted in this scenario. This condition was based on a Black quirk that was actually a bug and shouldn't be replicated.The fix is gated behind preview mode to ensure backward compatibility. When preview mode is enabled, decorated classes following functions now correctly get blank lines:
This brings Ruff's behavior in line with proper Python style guidelines and fixes the inconsistency where blank lines were added for other statement types but not decorated classes.
Test Plan
Manual Testing:
--preview
flag:cargo run --bin ruff_python_formatter -- --emit stdout --preview test.pyi
--preview
: old behavior preserved@lambda
,@final
, multiple decorators)Automated Testing:
decorated_class_after_function.pyi
with preview optionscargo test -p ruff_python_formatter
- all tests passPreview Mode Integration:
is_blank_line_before_decorated_class_in_stub_enabled()
preview functionCloses #18865