Sort by key #7963
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,171 +1,137 @@ | ||
| /// See: <https://github.com/PyCQA/isort/blob/12cc5fbd67eebf92eb2213b03c07b138ae1fb448/isort/sorting.py#L13> | ||
| use natord; | ||
| use std::cmp::Ordering; | ||
|
|
||
| use ruff_python_stdlib::str; | ||
|
|
||
| use super::settings::{RelativeImportsOrder, Settings}; | ||
|
|
||
| #[derive(Debug, PartialOrd, Ord, PartialEq, Eq, Copy, Clone)] | ||
| pub(crate) enum MemberType { | ||
| Constant, | ||
| Class, | ||
| Variable, | ||
| } | ||
|
|
||
| fn member_type(name: &str, settings: &Settings) -> MemberType { | ||
| if settings.constants.contains(name) { | ||
| // Ex) `CONSTANT` | ||
| MemberType::Constant | ||
| } else if settings.classes.contains(name) { | ||
| // Ex) `CLASS` | ||
| MemberType::Class | ||
| } else if settings.variables.contains(name) { | ||
| // Ex) `variable` | ||
| MemberType::Variable | ||
| } else if name.len() > 1 && str::is_cased_uppercase(name) { | ||
| // Ex) `CONSTANT` | ||
| MemberType::Constant | ||
| } else if name.chars().next().is_some_and(char::is_uppercase) { | ||
| // Ex) `Class` | ||
| MemberType::Class | ||
| } else { | ||
| // Ex) `variable` | ||
| MemberType::Variable | ||
| } | ||
| } | ||
|
|
||
| #[derive(Eq, PartialEq, Debug)] | ||
| pub(crate) struct NatOrdString(String); | ||
|
|
||
| impl Ord for NatOrdString { | ||
| fn cmp(&self, other: &Self) -> Ordering { | ||
| natord::compare(&self.0, &other.0) | ||
| } | ||
| } | ||
|
|
||
| impl PartialOrd for NatOrdString { | ||
| fn partial_cmp(&self, other: &Self) -> Option<Ordering> { | ||
| Some(self.cmp(other)) | ||
| } | ||
| } | ||
|
|
||
| #[derive(Eq, PartialEq, Debug)] | ||
| pub(crate) struct NatOrdStr<'a>(&'a str); | ||
|
|
||
| impl Ord for NatOrdStr<'_> { | ||
| fn cmp(&self, other: &Self) -> Ordering { | ||
| natord::compare(self.0, other.0) | ||
| } | ||
| } | ||
|
|
||
| impl PartialOrd for NatOrdStr<'_> { | ||
| fn partial_cmp(&self, other: &Self) -> Option<Ordering> { | ||
| Some(self.cmp(other)) | ||
| } | ||
| } | ||
|
|
||
| type ModuleKey<'a> = ( | ||
| i64, | ||
| Option<bool>, | ||
| Option<NatOrdString>, | ||
| Option<NatOrdStr<'a>>, | ||
| Option<NatOrdStr<'a>>, | ||
| Option<MemberKey<'a>>, | ||
| ); | ||
|
|
||
| pub(crate) fn module_key<'a>( | ||
| name: Option<&'a str>, | ||
| asname: Option<&'a str>, | ||
| level: Option<u32>, | ||
| first_alias: Option<(&'a str, Option<&'a str>)>, | ||
| settings: &Settings, | ||
| ) -> ModuleKey<'a> { | ||
| let level = level | ||
| .map(i64::from) | ||
| .map(|l| match settings.relative_imports_order { | ||
| RelativeImportsOrder::ClosestToFurthest => l, | ||
| RelativeImportsOrder::FurthestToClosest => -l, | ||
| }) | ||
| .unwrap_or_default(); | ||
| let force_to_top = name.map(|name| !settings.force_to_top.contains(name)); // `false` < `true` so we get forced to top first | ||
| let maybe_lower_case_name = name | ||
| .and_then(|name| (!settings.case_sensitive).then_some(NatOrdString(name.to_lowercase()))); | ||
|
There was a problem hiding this comment. Can we avoid allocating here ( There was a problem hiding this comment. I guess to do that we would need to use a use std::borrow::Cow;
struct NatOrdStr<'a>(Cow<'a, str>);whose contents are either owned or borrowed. I haven't played around with There was a problem hiding this comment. I think it's worth it given that these are gonna lower-cased in the majority of cases. There was a problem hiding this comment. Just pushed the modification, I had it ready just in case :) |
||
| let module_name = name.map(NatOrdStr); | ||
| let asname = asname.map(NatOrdStr); | ||
| let first_alias = first_alias.map(|(name, asname)| member_key(name, asname, settings)); | ||
|
|
||
| ( | ||
| level, | ||
| force_to_top, | ||
| maybe_lower_case_name, | ||
| module_name, | ||
| asname, | ||
| first_alias, | ||
| ) | ||
| } | ||
|
|
||
| type MemberKey<'a> = ( | ||
| bool, | ||
| Option<MemberType>, | ||
| Option<NatOrdString>, | ||
| NatOrdStr<'a>, | ||
| Option<NatOrdStr<'a>>, | ||
| ); | ||
|
|
||
| pub(crate) fn member_key<'a>( | ||
| name: &'a str, | ||
| asname: Option<&'a str>, | ||
| settings: &Settings, | ||
| ) -> MemberKey<'a> { | ||
| let not_star_import = name != "*"; // `false` < `true` so we get star imports first | ||
| let member_type = settings | ||
| .order_by_type | ||
| .then_some(member_type(name, settings)); | ||
| let maybe_lower_case_name = | ||
| (!settings.case_sensitive).then_some(NatOrdString(name.to_lowercase())); | ||
| let module_name = NatOrdStr(name); | ||
| let asname = asname.map(NatOrdStr); | ||
|
|
||
| ( | ||
| not_star_import, | ||
| member_type, | ||
| maybe_lower_case_name, | ||
| module_name, | ||
| asname, | ||
| ) | ||
| } | ||
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this logic still being captured in the refactor?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be because both
module_keyandmember_keyreturn a tuple with firstmaybe_lower_case_name(which isSome(name.to_lowercase())ifsettings.case_sensitiveis false, otherwiseNone) and then the module/member name.So if
settings.case_sensitiveis true, then we just compare the names usingnatord::compare, and if it's false we first compare the lowercase names withnatord::compare, and then the actual names.I guess the question is, is comparing two strings that have been turned into lowercase with
natord::comparethe same as comparing them directly withnatord::compare_ignore_case? I looked at the source code fornatord::compare_ignore_caseand they're just callingto_lowercaseon thechars individually, but apart from that it seems like what I did should be equivalent.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it is slightly different, because they also map integers to avoid sorting them lexicographically, right? For example, to avoid putting
module10beforemodule2.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh I thought you were talking about the fact that there are two function calls (one case sensitive and one case insensitive).
The correct natrural ordering (typically
module2comes beforemodule10) is indeed correctly captured in my refactor because I'm relying onnatord::compareto implement theOrdtrait for my types. Was that the question?