Skip to content

feat: Relative path support in LockFile #4788

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.

Sign up for GitHub

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

feat: Relative path support in LockFile #4788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
14309f2
chore: Update to changes in rattler_lock API
hunger Oct 18, 2025
726aa31
chore: Make sure the `non-pep508-extensions` feature is enabled
hunger Oct 18, 2025
48c5dd8
pixi_core: Handle conversion of relative paths in requirements
hunger Oct 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ ordermap = "0.5.7"
parking_lot = "0.12.4"
pathdiff = "0.2.3"
pep440_rs = "0.7.3"
pep508_rs = "0.9.2"
pep508_rs = { version = "0.9.2", features = ["non-pep508-extensions"] }
percent-encoding = "2.3.1"
pin-project-lite = "0.2.16"
pixi = { path = "crates/pixi" }
Expand Down Expand Up @@ -190,7 +190,9 @@ uv-install-wheel = { git = "https://github.com/astral-sh/uv", tag = "0.8.5" }
uv-installer = { git = "https://github.com/astral-sh/uv", tag = "0.8.5" }
uv-normalize = { git = "https://github.com/astral-sh/uv", tag = "0.8.5" }
uv-pep440 = { git = "https://github.com/astral-sh/uv", tag = "0.8.5" }
uv-pep508 = { git = "https://github.com/astral-sh/uv", tag = "0.8.5" }
uv-pep508 = { git = "https://github.com/astral-sh/uv", tag = "0.8.5", features = [
"non-pep508-extensions",
] }
uv-platform-tags = { git = "https://github.com/astral-sh/uv", tag = "0.8.5" }
uv-pypi-types = { git = "https://github.com/astral-sh/uv", tag = "0.8.5" }
uv-python = { git = "https://github.com/astral-sh/uv", tag = "0.8.5" }
Expand Down
3 changes: 1 addition & 2 deletions crates/pixi_core/src/activation.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,6 @@ pub(crate) async fn initialize_env_variables(
mod tests {
use super::*;
use std::path::Path;
use std::str::FromStr;

#[test]
fn test_metadata_env() {
Expand Down Expand Up @@ -703,7 +702,7 @@ packages:
"#,
platform = Platform::current()
);
let lock_file = LockFile::from_str(mock_lock).unwrap();
let lock_file = LockFile::from_str_with_base_directory(mock_lock, None).unwrap();
let env = run_activation(
&default_env,
&CurrentEnvVarBehavior::Include,
Expand Down
78 changes: 45 additions & 33 deletions crates/pixi_core/src/lock_file/resolve/pypi.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ use pypi_modifiers::{
use rattler_digest::{Md5, Sha256, parse_digest_from_hex};
use rattler_lock::{
PackageHashes, PypiPackageData, PypiPackageEnvironmentData, PypiSourceTreeHashable, UrlOrPath,
Verbatim,
};
use typed_path::Utf8TypedPathBuf;
use url::Url;
Expand Down Expand Up @@ -140,17 +141,18 @@ fn process_uv_path_url(
path_url: &uv_pep508::VerbatimUrl,
install_path: &Path,
project_root: &Path,
) -> Result<Utf8TypedPathBuf, ProcessPathUrlError> {
) -> Result<(String, Utf8TypedPathBuf), ProcessPathUrlError> {
let given = path_url
.given()
.ok_or_else(|| ProcessPathUrlError::NoGivenPath(path_url.to_string()))?;
.ok_or_else(|| ProcessPathUrlError::NoGivenPath(path_url.to_string()))?
.to_string();
let keep_abs = if given.starts_with("file://") {
// Processed by UV this is a file url
// don't keep it absolute as the origin is 1) and relative paths are impossible
// we are assuming the intention was to keep it relative
false
} else {
let path = PathBuf::from(given);
let path = PathBuf::from(&given);
// Determine if the path was given as an absolute path
path.is_absolute()
};
Expand Down Expand Up @@ -183,9 +185,9 @@ fn process_uv_path_url(
Ok(if cfg!(windows) {
// Replace backslashes with forward slashes on Windows because pathdiff can
// return paths with backslashes.
Utf8TypedPathBuf::from(path_str.replace("\\", "/"))
(given, Utf8TypedPathBuf::from(path_str.replace("\\", "/")))
} else {
Utf8TypedPathBuf::from(path_str)
(given, Utf8TypedPathBuf::from(path_str))
})
}

Expand Down Expand Up @@ -886,27 +888,25 @@ async fn lock_pypi_packages(
)
.into_diagnostic()
.context("cannot convert registry dist")?;
(url_or_path, hash)
(Verbatim::new(url_or_path), hash)
}
BuiltDist::DirectUrl(dist) => {
let url = dist.url.to_url();
let direct_url = Url::parse(&format!("direct+{url}"))
.into_diagnostic()
.context("cannot create direct url")?;

(UrlOrPath::Url(direct_url), None)
(Verbatim::new(UrlOrPath::Url(direct_url)), None)
}
BuiltDist::Path(dist) => {
let (given, path) = process_uv_path_url(
&dist.url,
&dist.install_path,
abs_project_root,
)
.into_diagnostic()?;
(Verbatim::new_with_given(UrlOrPath::Path(path), given), None)
}
BuiltDist::Path(dist) => (
UrlOrPath::Path(
process_uv_path_url(
&dist.url,
&dist.install_path,
abs_project_root,
)
.into_diagnostic()?,
),
None,
),
};

let metadata = registry_client
Expand Down Expand Up @@ -964,20 +964,22 @@ async fn lock_pypi_packages(
get_url_or_path(&reg.index, &reg.file.url, abs_project_root)
.into_diagnostic()
.context("cannot convert registry sdist")?;
(url_or_path, hash, false)
(Verbatim::new(url_or_path), hash, false)
}
SourceDist::DirectUrl(direct) => {
let url = direct.url.to_url();
let direct_url = Url::parse(&format!("direct+{url}"))
.into_diagnostic()
.context("could not create direct-url")?;
(direct_url.into(), hash, false)
(Verbatim::new(direct_url.into()), hash, false)
}
SourceDist::Git(git) => {
// convert resolved source dist into a pinned git spec
let pinned_git_spec = into_pinned_git_spec(git.clone());
(
pinned_git_spec.into_locked_git_url().to_url().into(),
Verbatim::new(
pinned_git_spec.into_locked_git_url().to_url().into(),
),
hash,
false,
)
Expand All @@ -996,7 +998,7 @@ async fn lock_pypi_packages(
};

// process the path or url that we get back from uv
let install_path = process_uv_path_url(
let (given, install_path) = process_uv_path_url(
&path.url,
&path.install_path,
abs_project_root,
Expand All @@ -1006,7 +1008,8 @@ async fn lock_pypi_packages(
// Create the url for the lock file. This is based on the passed in URL
// instead of from the source path to copy the path that was passed in
// from the requirement.
let url_or_path = UrlOrPath::Path(install_path);
let url_or_path =
Verbatim::new_with_given(UrlOrPath::Path(install_path), given);
(url_or_path, hash, false)
}
SourceDist::Directory(dir) => {
Expand All @@ -1023,14 +1026,15 @@ async fn lock_pypi_packages(
};

// process the path or url that we get back from uv
let install_path =
let (given, install_path) =
process_uv_path_url(&dir.url, &dir.install_path, abs_project_root)
.into_diagnostic()?;

// Create the url for the lock file. This is based on the passed in URL
// instead of from the source path to copy the path that was passed in
// from the requirement.
let url_or_path = UrlOrPath::Path(install_path);
let url_or_path =
Verbatim::new_with_given(UrlOrPath::Path(install_path), given);
(url_or_path, hash, dir.editable.unwrap_or(false))
}
};
Expand All @@ -1045,8 +1049,11 @@ async fn lock_pypi_packages(
.transpose()
.into_diagnostic()?,
location,
requires_dist: to_requirements(metadata.requires_dist.iter())
.into_diagnostic()?,
requires_dist: to_requirements(
metadata.requires_dist.iter(),
abs_project_root,
)
.into_diagnostic()?,
hash,
editable,
}
Expand Down Expand Up @@ -1075,9 +1082,10 @@ mod tests {
let url = uv_pep508::VerbatimUrl::parse_url("file:///a/b/c")
.unwrap()
.with_given("./b/c");
let path =
let (given, path) =
process_uv_path_url(&url, &PathBuf::from("/a/b/c"), &PathBuf::from("/a")).unwrap();
assert_eq!(path.as_str(), "./b/c");
assert_eq!(given, "./b/c");
}

// In this case we want to make the path relative to the project_root or lock
Expand All @@ -1088,9 +1096,10 @@ mod tests {
let url = uv_pep508::VerbatimUrl::parse_url("file:///a/b/c")
.unwrap()
.with_given("./b/c");
let path =
let (given, path) =
process_uv_path_url(&url, &PathBuf::from("/a/c/z"), &PathBuf::from("/a/b/f")).unwrap();
assert_eq!(path.as_str(), "../../c/z");
assert_eq!(given, "./b/c");
}

// In this case we want to make the path relative to the project_root or lock
Expand All @@ -1101,7 +1110,7 @@ mod tests {
let url = uv_pep508::VerbatimUrl::parse_url("file://C/a/b/c")
.unwrap()
.with_given("./b/c");
let path =
let (given, path) =
process_uv_path_url(&url, &PathBuf::from("C:\\a\\b\\c"), &PathBuf::from("C:\\a"))
.unwrap();
assert_eq!(path.as_str(), "./b/c");
Expand All @@ -1115,13 +1124,14 @@ mod tests {
let url = uv_pep508::VerbatimUrl::parse_url("file://C/a/b/c")
.unwrap()
.with_given("./b/c");
let path = process_uv_path_url(
let (given, path) = process_uv_path_url(
&url,
&PathBuf::from("C:\\a\\c\\z"),
&PathBuf::from("C:\\a\\b\\f"),
)
.unwrap();
assert_eq!(path.as_str(), "../../c/z");
assert_eq!(given, "./b/c");
}

// In this case we want to keep the absolute path
Expand All @@ -1131,9 +1141,10 @@ mod tests {
let url = uv_pep508::VerbatimUrl::parse_url("file:///a/b/c")
.unwrap()
.with_given("/a/b/c");
let path =
let (given, path) =
process_uv_path_url(&url, &PathBuf::from("/a/b/c"), &PathBuf::from("/a")).unwrap();
assert_eq!(path.as_str(), "/a/b/c");
assert_eq!(given, "/a/b/c");
}

// In this case we want to keep the absolute path
Expand All @@ -1143,9 +1154,10 @@ mod tests {
let url = uv_pep508::VerbatimUrl::parse_url("file://C/a/b/c")
.unwrap()
.with_given("C:\\a\\b\\c");
let path =
let (given, path) =
process_uv_path_url(&url, &PathBuf::from("C:\\a\\b\\c"), &PathBuf::from("C:\\a"))
.unwrap();
assert_eq!(path.as_str(), "C:/a/b/c");
assert_eq!(given, "C:\\a\\b\\c");
}
}
16 changes: 8 additions & 8 deletions crates/pixi_core/src/lock_file/satisfiability/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ fn verify_pypi_no_build(
// violations
for (_, packages) in locked_environment.pypi_packages_by_platform() {
for (package, _) in packages {
let extension = match &package.location {
let extension = match package.location.inner() {
// Get the extension from the url
UrlOrPath::Url(url) => {
if url.scheme().starts_with("git+") {
Expand Down Expand Up @@ -778,7 +778,7 @@ pub(crate) fn pypi_satifisfies_editable(
"editable requirement cannot be from registry, url, git or path (non-directory)"
)
}
RequirementSource::Directory { install_path, .. } => match &locked_data.location {
RequirementSource::Directory { install_path, .. } => match locked_data.location.inner() {
// If we have an url requirement locked, but the editable is requested, this does not
// satifsfy
UrlOrPath::Url(url) => Err(Box::new(PlatformUnsat::EditablePackageIsUrl(
Expand Down Expand Up @@ -848,7 +848,7 @@ pub(crate) fn pypi_satifisfies_requirement(
}
}
RequirementSource::Url { url: spec_url, .. } => {
if let UrlOrPath::Url(locked_url) = &locked_data.location {
if let UrlOrPath::Url(locked_url) = locked_data.location.inner() {
// Url may not start with git, and must start with direct+
if locked_url.as_str().starts_with("git+")
|| !locked_url.as_str().starts_with("direct+")
Expand Down Expand Up @@ -879,7 +879,7 @@ pub(crate) fn pypi_satifisfies_requirement(
} => {
let repository = git.repository();
let reference = git.reference();
match &locked_data.location {
match locked_data.location.inner() {
UrlOrPath::Url(url) => {
if let Ok(pinned_git_spec) = LockedGitUrl::new(url.clone()).to_pinned_git_spec()
{
Expand Down Expand Up @@ -950,7 +950,7 @@ pub(crate) fn pypi_satifisfies_requirement(
}
RequirementSource::Path { install_path, .. }
| RequirementSource::Directory { install_path, .. } => {
if let UrlOrPath::Path(locked_path) = &locked_data.location {
if let UrlOrPath::Path(locked_path) = locked_data.location.inner() {
let install_path =
Utf8TypedPathBuf::from(install_path.to_string_lossy().to_string());
let project_root =
Expand Down Expand Up @@ -1361,7 +1361,7 @@ pub(crate) async fn verify_package_platform_satisfiability(
if pypi_packages_visited.insert(idx) {
// If this is path based package we need to check if the source tree hash still
// matches. and if it is a directory
if let UrlOrPath::Path(path) = &record.0.location {
if let UrlOrPath::Path(path) = record.0.location.inner() {
let absolute_path = if path.is_absolute() {
Cow::Borrowed(Path::new(path.as_str()))
} else {
Expand Down Expand Up @@ -1854,7 +1854,7 @@ mod tests {
use insta::Settings;
use miette::{IntoDiagnostic, NarratableReportHandler};
use pep440_rs::{Operator, Version};
use rattler_lock::LockFile;
use rattler_lock::{LockFile, Verbatim};
use rstest::rstest;

use super::*;
Expand Down Expand Up @@ -2094,7 +2094,7 @@ mod tests {
let locked_data = PypiPackageData {
name: "mypkg".parse().unwrap(),
version: Version::from_str("0.1.0").unwrap(),
location: UrlOrPath::Path("C:\\Users\\username\\mypkg.tar.gz".into()),
location: Verbatim::new(UrlOrPath::Path("C:\\Users\\username\\mypkg.tar.gz".into())),
hash: None,
requires_dist: vec![],
requires_python: None,
Expand Down
2 changes: 1 addition & 1 deletion crates/pixi_install_pypi/src/conversions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ pub fn convert_to_dist(
lock_file_dir: &Path,
) -> Result<Dist, ConvertToUvDistError> {
// Figure out if it is a url from the registry or a direct url
let dist = match &pkg.location {
let dist = match pkg.location.inner() {
UrlOrPath::Url(url) if is_direct_url(url.scheme()) => {
let url_without_direct = strip_direct_scheme(url);
let pkg_name = to_uv_normalize(&pkg.name)?;
Expand Down
8 changes: 4 additions & 4 deletions crates/pixi_install_pypi/src/plan/validation.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ pub(crate) fn need_reinstall(
// Check if the installed version is the same as the required version
match installed {
InstalledDist::Registry(reg) => {
if !matches!(locked.location, UrlOrPath::Url(_)) {
if !matches!(locked.location.inner(), UrlOrPath::Url(_)) {
return Ok(ValidateCurrentInstall::Reinstall(
NeedReinstall::SourceMismatch {
locked_location: locked.location.to_string(),
Expand Down Expand Up @@ -84,7 +84,7 @@ pub(crate) fn need_reinstall(
match result {
Ok(url) => {
// Convert the locked location, which can be a path or a url, to a url
let locked_url = match &locked.location {
let locked_url = match locked.location.inner() {
// Fine if it is already a url
UrlOrPath::Url(url) => url.clone(),
// Do some path mangling if it is actually a path to get it into a url
Expand Down Expand Up @@ -157,7 +157,7 @@ pub(crate) fn need_reinstall(
let lock_file_dir = typed_path::Utf8TypedPathBuf::from(
lock_file_dir.to_string_lossy().as_ref(),
);
let locked_url = match &locked.location {
let locked_url = match locked.location.inner() {
// Remove `direct+` scheme if it is there so we can compare the required to
// the installed url
UrlOrPath::Url(url) => strip_direct_scheme(url).into_owned(),
Expand Down Expand Up @@ -225,7 +225,7 @@ pub(crate) fn need_reinstall(

// Try to parse the locked git url, this can be any url, so this may fail
// in practice it always seems to succeed, even with a non-git url
let locked_git_url = match &locked.location {
let locked_git_url = match locked.location.inner() {
UrlOrPath::Url(url) => {
// is it a git url?
if LockedGitUrl::is_locked_git_url(url) {
Expand Down
Loading
Loading