-
Notifications
You must be signed in to change notification settings - Fork 729
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
Allow .dist-info
names with dashes for post releases
#7208
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
use std::borrow::Cow; | ||
use std::fmt; | ||
use std::fmt::{Display, Formatter}; | ||
|
||
/// The normalized name of a `.dist-info` directory. | ||
/// | ||
/// Like [`PackageName`](crate::PackageName), but without restrictions on the set of allowed | ||
/// characters, etc. | ||
/// | ||
/// See: <https://github.com/pypa/pip/blob/111eed14b6e9fba7c78a5ec2b7594812d17b5d2b/src/pip/_vendor/packaging/utils.py#L45> | ||
#[derive(Debug, Default, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)] | ||
pub struct DistInfoName<'a>(Cow<'a, str>); | ||
|
||
impl<'a> DistInfoName<'a> { | ||
/// Create a validated, normalized extra name. | ||
pub fn new(name: &'a str) -> Self { | ||
if Self::is_normalized(name) { | ||
Self(Cow::Borrowed(name)) | ||
} else { | ||
Self(Cow::Owned(Self::normalize(name))) | ||
} | ||
} | ||
|
||
/// Normalize a `.dist-info` name, converting it to lowercase and collapsing runs | ||
/// of `-`, `_`, and `.` down to a single `-`. | ||
fn normalize(name: impl AsRef<str>) -> String { | ||
let mut normalized = String::with_capacity(name.as_ref().len()); | ||
let mut last = None; | ||
for char in name.as_ref().bytes() { | ||
match char { | ||
b'A'..=b'Z' => { | ||
normalized.push(char.to_ascii_lowercase() as char); | ||
} | ||
b'-' | b'_' | b'.' => { | ||
if matches!(last, Some(b'-' | b'_' | b'.')) { | ||
continue; | ||
} | ||
normalized.push('-'); | ||
} | ||
_ => { | ||
normalized.push(char as char); | ||
} | ||
} | ||
last = Some(char); | ||
} | ||
normalized | ||
} | ||
|
||
/// Returns `true` if the name is already normalized. | ||
fn is_normalized(name: impl AsRef<str>) -> bool { | ||
let mut last = None; | ||
for char in name.as_ref().bytes() { | ||
match char { | ||
b'A'..=b'Z' => { | ||
// Uppercase characters need to be converted to lowercase. | ||
return false; | ||
} | ||
b'_' | b'.' => { | ||
// `_` and `.` are normalized to `-`. | ||
return false; | ||
} | ||
b'-' => { | ||
if matches!(last, Some(b'-')) { | ||
// Runs of `-` are normalized to a single `-`. | ||
return false; | ||
} | ||
} | ||
_ => {} | ||
} | ||
last = Some(char); | ||
} | ||
true | ||
} | ||
} | ||
|
||
impl Display for DistInfoName<'_> { | ||
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { | ||
self.0.fmt(f) | ||
} | ||
} | ||
|
||
impl AsRef<str> for DistInfoName<'_> { | ||
fn as_ref(&self) -> &str { | ||
&self.0 | ||
} | ||
} | ||
|
||
#[cfg(test)] | ||
mod tests { | ||
use super::*; | ||
|
||
#[test] | ||
fn normalize() { | ||
let inputs = [ | ||
"friendly-bard", | ||
"Friendly-Bard", | ||
"FRIENDLY-BARD", | ||
"friendly.bard", | ||
"friendly_bard", | ||
"friendly--bard", | ||
"friendly-.bard", | ||
"FrIeNdLy-._.-bArD", | ||
]; | ||
for input in inputs { | ||
assert_eq!(DistInfoName::normalize(input), "friendly-bard"); | ||
} | ||
} | ||
} |
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.
Why extra name?
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 is, tragically, a typo.