mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-14 06:15:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Refactor magic trailing comma (#5339)

Browse source 
## Summary

This is small refactoring to reuse the code that detects the magic
trailing comma across functions. I make this change now to avoid copying
code in a later PR. @MichaReiser is planning on making a larger
refactoring later that integrates with the join nodes builder

## Test Plan

No functional changes. The magic trailing comma behaviour is checked by
the fixtures.
This commit is contained in:
konstin 2023-06-23 18:53:55 +02:00 • committed by GitHub
parent cb580f960f
commit 4b65446de6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 28 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

13
crates/ruff_python_formatter/src/expression/expr_dict.rs
View file

@ -1,12 +1,10 @@
use crate::builders::use_magic_trailing_comma;
use crate::comments::{dangling_node_comments, leading_comments, Comments};
use crate::context::PyFormatContext;
use crate::expression::parentheses::{
default_expression_needs_parentheses, NeedsParentheses, Parentheses, Parenthesize,
};
use crate::prelude::*;
use crate::trivia::Token;
use crate::trivia::{first_non_trivia_token, TokenKind};
use crate::USE_MAGIC_TRAILING_COMMA;
use crate::{FormatNodeRule, PyFormatter};
use ruff_formatter::format_args;
use ruff_formatter::{write, Buffer, FormatResult};
@ -69,14 +67,7 @@ impl FormatNodeRule<ExprDict> for FormatExprDict {
}
[.., last] => last,
};
let magic_trailing_comma = USE_MAGIC_TRAILING_COMMA
&& matches!(
first_non_trivia_token(last.range().end(), f.context().contents()),
Some(Token {
kind: TokenKind::Comma,
..
})
);
let magic_trailing_comma = use_magic_trailing_comma(f, last.range());
debug_assert_eq!(keys.len(), values.len());

14
crates/ruff_python_formatter/src/expression/expr_tuple.rs
View file

@ -1,11 +1,10 @@
use crate::builders::use_magic_trailing_comma;
use crate::comments::{dangling_node_comments, Comments};
use crate::context::PyFormatContext;
use crate::expression::parentheses::{
default_expression_needs_parentheses, NeedsParentheses, Parentheses, Parenthesize,
};
use crate::trivia::Token;
use crate::trivia::{first_non_trivia_token, TokenKind};
use crate::{AsFormat, FormatNodeRule, FormattedIterExt, PyFormatter, USE_MAGIC_TRAILING_COMMA};
use crate::{AsFormat, FormatNodeRule, FormattedIterExt, PyFormatter};
use ruff_formatter::formatter::Formatter;
use ruff_formatter::prelude::{
block_indent, group, if_group_breaks, soft_block_indent, soft_line_break_or_space, text,
@ -88,14 +87,7 @@ impl FormatNodeRule<ExprTuple> for FormatExprTuple {
[.., last] => last,
};
let magic_trailing_comma = USE_MAGIC_TRAILING_COMMA
&& matches!(
first_non_trivia_token(last.range().end(), f.context().contents()),
Some(Token {
kind: TokenKind::Comma,
..
})
);
let magic_trailing_comma = use_magic_trailing_comma(f, last.range());
if magic_trailing_comma {
// A magic trailing comma forces us to print in expanded mode since we have more than