mirror of
https://github.com/astral-sh/uv.git
synced 2025-07-07 13:25:00 +00:00
Move requirements.txt distribution into separate file (#4500)
## Summary No functional changes, but this has outgrown being in the module root.
This commit is contained in:
Charlie Marsh
GitHub
parent
7946509931
commit
ddacede7db
2 changed files with 149 additions and 140 deletions
|
|
@ -1,20 +1,17 @@
|
|||
use std::borrow::Cow;
|
||||
use std::fmt::Display;
|
||||
use std::path::Path;
|
||||
|
||||
use itertools::Itertools;
|
||||
|
||||
use distribution_types::{DistributionMetadata, Name, ResolvedDist, Verbatim, VersionOrUrlRef};
|
||||
use pep508_rs::{split_scheme, Scheme};
|
||||
use distribution_types::{DistributionMetadata, Name, ResolvedDist, VersionOrUrlRef};
|
||||
use pypi_types::HashDigest;
|
||||
use uv_distribution::Metadata;
|
||||
use uv_normalize::{ExtraName, GroupName, PackageName};
|
||||
|
||||
pub use crate::resolution::display::{AnnotationStyle, DisplayResolutionGraph};
|
||||
pub use crate::resolution::graph::ResolutionGraph;
|
||||
pub(crate) use crate::resolution::requirements_txt::RequirementsTxtDist;
|
||||
|
||||
mod display;
|
||||
mod graph;
|
||||
mod requirements_txt;
|
||||
|
||||
/// A pinned package with its resolved distribution and metadata. The [`ResolvedDist`] refers to a
|
||||
/// specific distribution (e.g., a specific wheel), while the [`Metadata23`] refers to the metadata
|
||||
|
|
@ -53,137 +50,3 @@ impl Display for AnnotatedDist {
|
|||
Display::fmt(&self.dist, f)
|
||||
}
|
||||
}
|
||||
|
||||
/// A pinned package with its resolved distribution and all the extras that were pinned for it.
|
||||
#[derive(Debug, Clone)]
|
||||
pub(crate) struct RequirementsTxtDist {
|
||||
pub(crate) dist: ResolvedDist,
|
||||
pub(crate) extras: Vec<ExtraName>,
|
||||
pub(crate) hashes: Vec<HashDigest>,
|
||||
}
|
||||
|
||||
impl RequirementsTxtDist {
|
||||
/// Convert the [`RequirementsTxtDist`] to a requirement that adheres to the `requirements.txt`
|
||||
/// format.
|
||||
///
|
||||
/// This typically results in a PEP 508 representation of the requirement, but will write an
|
||||
/// unnamed requirement for relative paths, which can't be represented with PEP 508 (but are
|
||||
/// supported in `requirements.txt`).
|
||||
pub(crate) fn to_requirements_txt(&self, include_extras: bool) -> Cow<str> {
|
||||
// If the URL is editable, write it as an editable requirement.
|
||||
if self.dist.is_editable() {
|
||||
if let VersionOrUrlRef::Url(url) = self.dist.version_or_url() {
|
||||
let given = url.verbatim();
|
||||
return Cow::Owned(format!("-e {given}"));
|
||||
}
|
||||
}
|
||||
|
||||
// If the URL is not _definitively_ an absolute `file://` URL, write it as a relative path.
|
||||
if self.dist.is_local() {
|
||||
if let VersionOrUrlRef::Url(url) = self.dist.version_or_url() {
|
||||
let given = url.verbatim();
|
||||
match split_scheme(&given) {
|
||||
Some((scheme, path)) => {
|
||||
match Scheme::parse(scheme) {
|
||||
Some(Scheme::File) => {
|
||||
if path
|
||||
.strip_prefix("//localhost")
|
||||
.filter(|path| path.starts_with('/'))
|
||||
.is_some()
|
||||
{
|
||||
// Always absolute; nothing to do.
|
||||
} else if let Some(path) = path.strip_prefix("//") {
|
||||
// Strip the prefix, to convert, e.g., `file://flask-3.0.3-py3-none-any.whl` to `flask-3.0.3-py3-none-any.whl`.
|
||||
//
|
||||
// However, we should allow any of the following:
|
||||
// - `file:///flask-3.0.3-py3-none-any.whl`
|
||||
// - `file://C:\Users\user\flask-3.0.3-py3-none-any.whl`
|
||||
// - `file:///C:\Users\user\flask-3.0.3-py3-none-any.whl`
|
||||
if !path.starts_with("${PROJECT_ROOT}")
|
||||
&& !Path::new(path).has_root()
|
||||
{
|
||||
return Cow::Owned(path.to_string());
|
||||
}
|
||||
} else {
|
||||
// Ex) `file:./flask-3.0.3-py3-none-any.whl`
|
||||
return given;
|
||||
}
|
||||
}
|
||||
Some(_) => {}
|
||||
None => {
|
||||
// Ex) `flask @ C:\Users\user\flask-3.0.3-py3-none-any.whl`
|
||||
return given;
|
||||
}
|
||||
}
|
||||
}
|
||||
None => {
|
||||
// Ex) `flask @ flask-3.0.3-py3-none-any.whl`
|
||||
return given;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if self.extras.is_empty() || !include_extras {
|
||||
self.dist.verbatim()
|
||||
} else {
|
||||
let mut extras = self.extras.clone();
|
||||
extras.sort_unstable();
|
||||
extras.dedup();
|
||||
Cow::Owned(format!(
|
||||
"{}[{}]{}",
|
||||
self.name(),
|
||||
extras.into_iter().join(", "),
|
||||
self.version_or_url().verbatim()
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn to_comparator(&self) -> RequirementsTxtComparator {
|
||||
if self.dist.is_editable() {
|
||||
if let VersionOrUrlRef::Url(url) = self.dist.version_or_url() {
|
||||
return RequirementsTxtComparator::Url(url.verbatim());
|
||||
}
|
||||
}
|
||||
|
||||
RequirementsTxtComparator::Name(self.name())
|
||||
}
|
||||
}
|
||||
|
||||
impl From<&AnnotatedDist> for RequirementsTxtDist {
|
||||
fn from(annotated: &AnnotatedDist) -> Self {
|
||||
Self {
|
||||
dist: annotated.dist.clone(),
|
||||
extras: if let Some(extra) = annotated.extra.clone() {
|
||||
vec![extra]
|
||||
} else {
|
||||
vec![]
|
||||
},
|
||||
hashes: annotated.hashes.clone(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
|
||||
pub(crate) enum RequirementsTxtComparator<'a> {
|
||||
Url(Cow<'a, str>),
|
||||
Name(&'a PackageName),
|
||||
}
|
||||
|
||||
impl Name for RequirementsTxtDist {
|
||||
fn name(&self) -> &PackageName {
|
||||
self.dist.name()
|
||||
}
|
||||
}
|
||||
|
||||
impl DistributionMetadata for RequirementsTxtDist {
|
||||
fn version_or_url(&self) -> VersionOrUrlRef {
|
||||
self.dist.version_or_url()
|
||||
}
|
||||
}
|
||||
|
||||
impl Display for RequirementsTxtDist {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
Display::fmt(&self.dist, f)
|
||||
}
|
||||
}
|
||||
|
|
|
|||
146
crates/uv-resolver/src/resolution/requirements_txt.rs
Normal file
146
crates/uv-resolver/src/resolution/requirements_txt.rs
Normal file
|
|
@ -0,0 +1,146 @@
|
|||
use std::borrow::Cow;
|
||||
use std::fmt::Display;
|
||||
use std::path::Path;
|
||||
|
||||
use itertools::Itertools;
|
||||
|
||||
use distribution_types::{DistributionMetadata, Name, ResolvedDist, Verbatim, VersionOrUrlRef};
|
||||
use pep508_rs::{split_scheme, Scheme};
|
||||
use pypi_types::HashDigest;
|
||||
use uv_normalize::{ExtraName, PackageName};
|
||||
|
||||
use crate::resolution::AnnotatedDist;
|
||||
|
||||
/// A pinned package with its resolved distribution and all the extras that were pinned for it.
|
||||
#[derive(Debug, Clone)]
|
||||
pub(crate) struct RequirementsTxtDist {
|
||||
pub(crate) dist: ResolvedDist,
|
||||
pub(crate) extras: Vec<ExtraName>,
|
||||
pub(crate) hashes: Vec<HashDigest>,
|
||||
}
|
||||
|
||||
impl RequirementsTxtDist {
|
||||
/// Convert the [`RequirementsTxtDist`] to a requirement that adheres to the `requirements.txt`
|
||||
/// format.
|
||||
///
|
||||
/// This typically results in a PEP 508 representation of the requirement, but will write an
|
||||
/// unnamed requirement for relative paths, which can't be represented with PEP 508 (but are
|
||||
/// supported in `requirements.txt`).
|
||||
pub(crate) fn to_requirements_txt(&self, include_extras: bool) -> Cow<str> {
|
||||
// If the URL is editable, write it as an editable requirement.
|
||||
if self.dist.is_editable() {
|
||||
if let VersionOrUrlRef::Url(url) = self.dist.version_or_url() {
|
||||
let given = url.verbatim();
|
||||
return Cow::Owned(format!("-e {given}"));
|
||||
}
|
||||
}
|
||||
|
||||
// If the URL is not _definitively_ an absolute `file://` URL, write it as a relative path.
|
||||
if self.dist.is_local() {
|
||||
if let VersionOrUrlRef::Url(url) = self.dist.version_or_url() {
|
||||
let given = url.verbatim();
|
||||
match split_scheme(&given) {
|
||||
Some((scheme, path)) => {
|
||||
match Scheme::parse(scheme) {
|
||||
Some(Scheme::File) => {
|
||||
if path
|
||||
.strip_prefix("//localhost")
|
||||
.filter(|path| path.starts_with('/'))
|
||||
.is_some()
|
||||
{
|
||||
// Always absolute; nothing to do.
|
||||
} else if let Some(path) = path.strip_prefix("//") {
|
||||
// Strip the prefix, to convert, e.g., `file://flask-3.0.3-py3-none-any.whl` to `flask-3.0.3-py3-none-any.whl`.
|
||||
//
|
||||
// However, we should allow any of the following:
|
||||
// - `file:///flask-3.0.3-py3-none-any.whl`
|
||||
// - `file://C:\Users\user\flask-3.0.3-py3-none-any.whl`
|
||||
// - `file:///C:\Users\user\flask-3.0.3-py3-none-any.whl`
|
||||
if !path.starts_with("${PROJECT_ROOT}")
|
||||
&& !Path::new(path).has_root()
|
||||
{
|
||||
return Cow::Owned(path.to_string());
|
||||
}
|
||||
} else {
|
||||
// Ex) `file:./flask-3.0.3-py3-none-any.whl`
|
||||
return given;
|
||||
}
|
||||
}
|
||||
Some(_) => {}
|
||||
None => {
|
||||
// Ex) `flask @ C:\Users\user\flask-3.0.3-py3-none-any.whl`
|
||||
return given;
|
||||
}
|
||||
}
|
||||
}
|
||||
None => {
|
||||
// Ex) `flask @ flask-3.0.3-py3-none-any.whl`
|
||||
return given;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if self.extras.is_empty() || !include_extras {
|
||||
self.dist.verbatim()
|
||||
} else {
|
||||
let mut extras = self.extras.clone();
|
||||
extras.sort_unstable();
|
||||
extras.dedup();
|
||||
Cow::Owned(format!(
|
||||
"{}[{}]{}",
|
||||
self.name(),
|
||||
extras.into_iter().join(", "),
|
||||
self.version_or_url().verbatim()
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn to_comparator(&self) -> RequirementsTxtComparator {
|
||||
if self.dist.is_editable() {
|
||||
if let VersionOrUrlRef::Url(url) = self.dist.version_or_url() {
|
||||
return RequirementsTxtComparator::Url(url.verbatim());
|
||||
}
|
||||
}
|
||||
|
||||
RequirementsTxtComparator::Name(self.name())
|
||||
}
|
||||
}
|
||||
|
||||
impl From<&AnnotatedDist> for RequirementsTxtDist {
|
||||
fn from(annotated: &AnnotatedDist) -> Self {
|
||||
Self {
|
||||
dist: annotated.dist.clone(),
|
||||
extras: if let Some(extra) = annotated.extra.clone() {
|
||||
vec![extra]
|
||||
} else {
|
||||
vec![]
|
||||
},
|
||||
hashes: annotated.hashes.clone(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
|
||||
pub(crate) enum RequirementsTxtComparator<'a> {
|
||||
Url(Cow<'a, str>),
|
||||
Name(&'a PackageName),
|
||||
}
|
||||
|
||||
impl Name for RequirementsTxtDist {
|
||||
fn name(&self) -> &PackageName {
|
||||
self.dist.name()
|
||||
}
|
||||
}
|
||||
|
||||
impl DistributionMetadata for RequirementsTxtDist {
|
||||
fn version_or_url(&self) -> VersionOrUrlRef {
|
||||
self.dist.version_or_url()
|
||||
}
|
||||
}
|
||||
|
||||
impl Display for RequirementsTxtDist {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
Display::fmt(&self.dist, f)
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue