mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-03 02:12:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Rename ArgumentSeparator to ParameterSeparator (#6404)

Browse source 
To mirror the rename from `Arguments` to `Parameters`.
This commit is contained in:
Charlie Marsh 2023-08-07 15:46:28 -04:00 • committed by GitHub
parent 26098b8d91
commit 404e334fec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

4
crates/ruff_python_formatter/src/comments/placement.rs
View file

@ -12,7 +12,7 @@ use ruff_text_size::TextRange;
use crate::comments::visitor::{CommentPlacement, DecoratedComment}; use crate::comments::visitor::{CommentPlacement, DecoratedComment};
use crate::expression::expr_slice::{assign_comment_in_slice, ExprSliceCommentSection}; use crate::expression::expr_slice::{assign_comment_in_slice, ExprSliceCommentSection};
use crate::other::parameters::{ use crate::other::parameters::{
assign_argument_separator_comment_placement, find_argument_separators, assign_argument_separator_comment_placement, find_parameter_separators,
}; };
/// Manually attach comments to nodes that the default placement gets wrong. /// Manually attach comments to nodes that the default placement gets wrong.
@ -606,7 +606,7 @@ fn handle_parameters_separator_comment<'a>(
parameters: &Parameters, parameters: &Parameters,
locator: &Locator, locator: &Locator,
) -> CommentPlacement<'a> { ) -> CommentPlacement<'a> {
let (slash, star) = find_argument_separators(locator.contents(), parameters); let (slash, star) = find_parameter_separators(locator.contents(), parameters);
let comment_range = comment.slice().range(); let comment_range = comment.slice().range();
let placement = assign_argument_separator_comment_placement( let placement = assign_argument_separator_comment_placement(
slash.as_ref(), slash.as_ref(),

22
crates/ruff_python_formatter/src/other/parameters.rs
View file

@ -60,7 +60,7 @@ impl FormatNodeRule<Parameters> for FormatParameters {
kwarg, kwarg,
} = item; } = item;
let (slash, star) = find_argument_separators(f.context().source(), item); let (slash, star) = find_parameter_separators(f.context().source(), item);
let comments = f.context().comments().clone(); let comments = f.context().comments().clone();
let dangling = comments.dangling_comments(item); let dangling = comments.dangling_comments(item);
@ -318,7 +318,7 @@ impl Format<PyFormatContext<'_>> for CommentsAroundText<'_> {
/// ^ star following start /// ^ star following start
/// ``` /// ```
#[derive(Debug)] #[derive(Debug)]
pub(crate) struct ArgumentSeparator { pub(crate) struct ParameterSeparator {
/// The end of the last node or separator before this separator /// The end of the last node or separator before this separator
pub(crate) preceding_end: TextSize, pub(crate) preceding_end: TextSize,
/// The range of the separator itself /// The range of the separator itself
@ -330,10 +330,10 @@ pub(crate) struct ArgumentSeparator {
/// Finds slash and star in `f(a, /, b, *, c)` or `lambda a, /, b, *, c: 1`. /// Finds slash and star in `f(a, /, b, *, c)` or `lambda a, /, b, *, c: 1`.
/// ///
/// Returns the location of the slash and star separators, if any. /// Returns the location of the slash and star separators, if any.
pub(crate) fn find_argument_separators( pub(crate) fn find_parameter_separators(
contents: &str, contents: &str,
parameters: &Parameters, parameters: &Parameters,
) -> (Option<ArgumentSeparator>, Option<ArgumentSeparator>) { ) -> (Option<ParameterSeparator>, Option<ParameterSeparator>) {
// We only compute preceding_end and token location here since following_start depends on the // We only compute preceding_end and token location here since following_start depends on the
// star location, but the star location depends on slash's position // star location, but the star location depends on slash's position
let slash = if let Some(preceding_end) = parameters.posonlyargs.last().map(Ranged::end) { let slash = if let Some(preceding_end) = parameters.posonlyargs.last().map(Ranged::end) {
@ -388,7 +388,7 @@ pub(crate) fn find_argument_separators(
.expect("The function definition can't end here"); .expect("The function definition can't end here");
debug_assert!(star.kind() == SimpleTokenKind::Star, "{star:?}"); debug_assert!(star.kind() == SimpleTokenKind::Star, "{star:?}");
Some(ArgumentSeparator { Some(ParameterSeparator {
preceding_end, preceding_end,
separator: star.range, separator: star.range,
following_start: first_keyword_argument.start(), following_start: first_keyword_argument.start(),
@ -411,7 +411,7 @@ pub(crate) fn find_argument_separators(
}; };
debug_assert!(star.kind() == SimpleTokenKind::Star, "{star:?}"); debug_assert!(star.kind() == SimpleTokenKind::Star, "{star:?}");
Some(ArgumentSeparator { Some(ParameterSeparator {
preceding_end: parameters.range.start(), preceding_end: parameters.range.start(),
separator: star.range, separator: star.range,
following_start: first_keyword_argument.start(), following_start: first_keyword_argument.start(),
@ -434,7 +434,7 @@ pub(crate) fn find_argument_separators(
.or(parameters.vararg.as_ref().map(|first| first.start())) .or(parameters.vararg.as_ref().map(|first| first.start()))
.or(star.as_ref().map(|star| star.separator.start())) .or(star.as_ref().map(|star| star.separator.start()))
.unwrap_or(parameters.end()); .unwrap_or(parameters.end());
let slash = slash.map(|(preceding_end, slash)| ArgumentSeparator { let slash = slash.map(|(preceding_end, slash)| ParameterSeparator {
preceding_end, preceding_end,
separator: slash, separator: slash,
following_start: slash_following_start, following_start: slash_following_start,
@ -534,12 +534,12 @@ pub(crate) fn find_argument_separators(
/// ^^^^^^ keyword only parameters (kwargs) /// ^^^^^^ keyword only parameters (kwargs)
/// ``` /// ```
pub(crate) fn assign_argument_separator_comment_placement( pub(crate) fn assign_argument_separator_comment_placement(
slash: Option<&ArgumentSeparator>, slash: Option<&ParameterSeparator>,
star: Option<&ArgumentSeparator>, star: Option<&ParameterSeparator>,
comment_range: TextRange, comment_range: TextRange,
text_position: CommentLinePosition, text_position: CommentLinePosition,
) -> Option<ArgumentSeparatorCommentLocation> { ) -> Option<ArgumentSeparatorCommentLocation> {
if let Some(ArgumentSeparator { if let Some(ParameterSeparator {
preceding_end, preceding_end,
separator: slash, separator: slash,
following_start, following_start,
@ -578,7 +578,7 @@ pub(crate) fn assign_argument_separator_comment_placement(
} }
} }
if let Some(ArgumentSeparator { if let Some(ParameterSeparator {
preceding_end, preceding_end,
separator: star, separator: star,
following_start, following_start,