Charlie Marsh
8071a23863
This allows us to enforce type safety within the resolver. For example, in the index, we can remove `String` as a key type and enforce that callers _must_ present us with a `PackageId`. (This actually caught one bug, where we were using the SHA rather than the package ID. That bug shouldn't have had any effect given where it was, since those are 1:1, but it's still problematic.)
66 lines
1.9 KiB
Rust
66 lines
1.9 KiB
Rust
use std::str::FromStr;
|
|
|
|
use serde::{Deserialize, Deserializer, Serialize};
|
|
|
|
use crate::{validate_and_normalize_owned, validate_and_normalize_ref, InvalidNameError};
|
|
|
|
/// The normalized name of a package.
|
|
///
|
|
/// Converts the name to lowercase and collapses any run of the characters `-`, `_` and `.`
|
|
/// down to a single `-`, e.g., `---`, `.`, and `__` all get converted to just `-`.
|
|
///
|
|
/// See: <https://packaging.python.org/en/latest/specifications/name-normalization/>
|
|
#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize)]
|
|
pub struct PackageName(String);
|
|
|
|
impl PackageName {
|
|
/// Create a validated, normalized package name.
|
|
pub fn new(name: String) -> Result<Self, InvalidNameError> {
|
|
validate_and_normalize_owned(name).map(Self)
|
|
}
|
|
|
|
/// Escape this name with underscores (`_`) instead of dashes (`-`)
|
|
///
|
|
/// See: <https://packaging.python.org/en/latest/specifications/recording-installed-packages/#recording-installed-packages>
|
|
pub fn as_dist_info_name(&self) -> String {
|
|
self.0.replace('-', "_")
|
|
}
|
|
}
|
|
|
|
impl From<&PackageName> for PackageName {
|
|
/// Required for `WaitMap::wait`.
|
|
fn from(package_name: &PackageName) -> Self {
|
|
package_name.clone()
|
|
}
|
|
}
|
|
|
|
impl FromStr for PackageName {
|
|
type Err = InvalidNameError;
|
|
|
|
fn from_str(name: &str) -> Result<Self, Self::Err> {
|
|
validate_and_normalize_ref(name).map(Self)
|
|
}
|
|
}
|
|
|
|
impl<'de> Deserialize<'de> for PackageName {
|
|
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
|
where
|
|
D: Deserializer<'de>,
|
|
{
|
|
let s = String::deserialize(deserializer)?;
|
|
Self::from_str(&s).map_err(serde::de::Error::custom)
|
|
}
|
|
}
|
|
|
|
impl std::fmt::Display for PackageName {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
self.0.fmt(f)
|
|
}
|
|
}
|
|
|
|
impl AsRef<str> for PackageName {
|
|
fn as_ref(&self) -> &str {
|
|
&self.0
|
|
}
|
|
}
|