mirror of
https://github.com/astral-sh/uv.git
synced 2025-11-24 05:17:05 +00:00
Add extra-build-dependencies hint for any missing module on build failure (#15252)
Alternative to https://github.com/astral-sh/uv/pull/15251. As suggested in https://github.com/astral-sh/uv/issues/15118#issuecomment-3175735416 ## Test Plan `cargo test` --------- Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>
This commit is contained in:
parent
4bc6c77f02
commit
e7b55fefbf
10 changed files with 1687 additions and 40 deletions
1
Cargo.lock
generated
1
Cargo.lock
generated
|
|
@ -4927,6 +4927,7 @@ dependencies = [
|
||||||
"uv-distribution",
|
"uv-distribution",
|
||||||
"uv-distribution-types",
|
"uv-distribution-types",
|
||||||
"uv-fs",
|
"uv-fs",
|
||||||
|
"uv-normalize",
|
||||||
"uv-pep440",
|
"uv-pep440",
|
||||||
"uv-pep508",
|
"uv-pep508",
|
||||||
"uv-pypi-types",
|
"uv-pypi-types",
|
||||||
|
|
|
||||||
|
|
@ -3,6 +3,7 @@ extend-exclude = [
|
||||||
"**/snapshots/",
|
"**/snapshots/",
|
||||||
"ecosystem/**",
|
"ecosystem/**",
|
||||||
"scripts/**/*.in",
|
"scripts/**/*.in",
|
||||||
|
"crates/uv-build-frontend/src/pipreqs/mapping",
|
||||||
]
|
]
|
||||||
ignore-hidden = false
|
ignore-hidden = false
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -22,6 +22,7 @@ uv-configuration = { workspace = true }
|
||||||
uv-distribution = { workspace = true }
|
uv-distribution = { workspace = true }
|
||||||
uv-distribution-types = { workspace = true }
|
uv-distribution-types = { workspace = true }
|
||||||
uv-fs = { workspace = true }
|
uv-fs = { workspace = true }
|
||||||
|
uv-normalize = { workspace = true }
|
||||||
uv-pep440 = { workspace = true }
|
uv-pep440 = { workspace = true }
|
||||||
uv-pep508 = { workspace = true }
|
uv-pep508 = { workspace = true }
|
||||||
uv-pypi-types = { workspace = true }
|
uv-pypi-types = { workspace = true }
|
||||||
|
|
|
||||||
|
|
@ -46,9 +46,10 @@ static LD_NOT_FOUND_RE: LazyLock<Regex> = LazyLock::new(|| {
|
||||||
static WHEEL_NOT_FOUND_RE: LazyLock<Regex> =
|
static WHEEL_NOT_FOUND_RE: LazyLock<Regex> =
|
||||||
LazyLock::new(|| Regex::new(r"error: invalid command 'bdist_wheel'").unwrap());
|
LazyLock::new(|| Regex::new(r"error: invalid command 'bdist_wheel'").unwrap());
|
||||||
|
|
||||||
/// e.g. `ModuleNotFoundError: No module named 'torch'`
|
/// e.g. `ModuleNotFoundError`
|
||||||
static TORCH_NOT_FOUND_RE: LazyLock<Regex> =
|
static MODULE_NOT_FOUND: LazyLock<Regex> = LazyLock::new(|| {
|
||||||
LazyLock::new(|| Regex::new(r"ModuleNotFoundError: No module named 'torch'").unwrap());
|
Regex::new("ModuleNotFoundError: No module named ['\"]([^'\"]+)['\"]").unwrap()
|
||||||
|
});
|
||||||
|
|
||||||
/// e.g. `ModuleNotFoundError: No module named 'distutils'`
|
/// e.g. `ModuleNotFoundError: No module named 'distutils'`
|
||||||
static DISTUTILS_NOT_FOUND_RE: LazyLock<Regex> =
|
static DISTUTILS_NOT_FOUND_RE: LazyLock<Regex> =
|
||||||
|
|
@ -130,6 +131,59 @@ pub struct MissingHeaderCause {
|
||||||
version_id: Option<String>,
|
version_id: Option<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Extract the package name from a version specifier string.
|
||||||
|
/// Uses PEP 508 naming rules but more lenient for hinting purposes.
|
||||||
|
fn extract_package_name(version_id: &str) -> &str {
|
||||||
|
// https://peps.python.org/pep-0508/#names
|
||||||
|
// ^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$ with re.IGNORECASE
|
||||||
|
// Since we're only using this for a hint, we're more lenient than what we would be doing if this was used for parsing
|
||||||
|
let end = version_id
|
||||||
|
.char_indices()
|
||||||
|
.take_while(|(_, char)| matches!(char, 'A'..='Z' | 'a'..='z' | '0'..='9' | '.' | '-' | '_'))
|
||||||
|
.last()
|
||||||
|
.map_or(0, |(i, c)| i + c.len_utf8());
|
||||||
|
|
||||||
|
if end == 0 {
|
||||||
|
version_id
|
||||||
|
} else {
|
||||||
|
&version_id[..end]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Write a hint about missing build dependencies.
|
||||||
|
fn hint_build_dependency(
|
||||||
|
f: &mut std::fmt::Formatter<'_>,
|
||||||
|
display_name: &str,
|
||||||
|
package_name: &str,
|
||||||
|
package: &str,
|
||||||
|
) -> std::fmt::Result {
|
||||||
|
let table_key = if package_name.contains('.') {
|
||||||
|
format!("\"{package_name}\"")
|
||||||
|
} else {
|
||||||
|
package_name.to_string()
|
||||||
|
};
|
||||||
|
write!(
|
||||||
|
f,
|
||||||
|
"This error likely indicates that `{}` depends on `{}`, but doesn't declare it as a build dependency. \
|
||||||
|
If `{}` is a first-party package, consider adding `{}` to its `{}`. \
|
||||||
|
Otherwise, either add it to your `pyproject.toml` under:\n\
|
||||||
|
\n\
|
||||||
|
[tool.uv.extra-build-dependencies]\n\
|
||||||
|
{} = [\"{}\"]\n\
|
||||||
|
\n\
|
||||||
|
or `{}` into the environment and re-run with `{}`.",
|
||||||
|
display_name.cyan(),
|
||||||
|
package.cyan(),
|
||||||
|
package_name.cyan(),
|
||||||
|
package.cyan(),
|
||||||
|
"build-system.requires".green(),
|
||||||
|
table_key.cyan(),
|
||||||
|
package.cyan(),
|
||||||
|
format!("uv pip install {package}").green(),
|
||||||
|
"--no-build-isolation".green(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
impl Display for MissingHeaderCause {
|
impl Display for MissingHeaderCause {
|
||||||
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
|
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
|
||||||
match &self.missing_library {
|
match &self.missing_library {
|
||||||
|
|
@ -190,29 +244,15 @@ impl Display for MissingHeaderCause {
|
||||||
if let (Some(package_name), Some(package_version)) =
|
if let (Some(package_name), Some(package_version)) =
|
||||||
(&self.package_name, &self.package_version)
|
(&self.package_name, &self.package_version)
|
||||||
{
|
{
|
||||||
write!(
|
hint_build_dependency(
|
||||||
f,
|
f,
|
||||||
"This error likely indicates that `{}` depends on `{}`, but doesn't declare it as a build dependency. If `{}` is a first-party package, consider adding `{}` to its `{}`. Otherwise, `{}` into the environment and re-run with `{}`.",
|
&format!("{package_name}@{package_version}"),
|
||||||
format!("{package_name}@{package_version}").cyan(),
|
package_name.as_str(),
|
||||||
package.cyan(),
|
package,
|
||||||
package_name.cyan(),
|
|
||||||
package.cyan(),
|
|
||||||
"build-system.requires".green(),
|
|
||||||
format!("uv pip install {package}").green(),
|
|
||||||
"--no-build-isolation".green(),
|
|
||||||
)
|
)
|
||||||
} else if let Some(version_id) = &self.version_id {
|
} else if let Some(version_id) = &self.version_id {
|
||||||
write!(
|
let package_name = extract_package_name(version_id);
|
||||||
f,
|
hint_build_dependency(f, package_name, package_name, package)
|
||||||
"This error likely indicates that `{}` depends on `{}`, but doesn't declare it as a build dependency. If `{}` is a first-party package, consider adding `{}` to its `{}`. Otherwise, `{}` into the environment and re-run with `{}`.",
|
|
||||||
version_id.cyan(),
|
|
||||||
package.cyan(),
|
|
||||||
version_id.cyan(),
|
|
||||||
package.cyan(),
|
|
||||||
"build-system.requires".green(),
|
|
||||||
format!("uv pip install {package}").green(),
|
|
||||||
"--no-build-isolation".green(),
|
|
||||||
)
|
|
||||||
} else {
|
} else {
|
||||||
write!(
|
write!(
|
||||||
f,
|
f,
|
||||||
|
|
@ -347,13 +387,22 @@ impl Error {
|
||||||
Some(MissingLibrary::Linker(library.to_string()))
|
Some(MissingLibrary::Linker(library.to_string()))
|
||||||
} else if WHEEL_NOT_FOUND_RE.is_match(line.trim()) {
|
} else if WHEEL_NOT_FOUND_RE.is_match(line.trim()) {
|
||||||
Some(MissingLibrary::BuildDependency("wheel".to_string()))
|
Some(MissingLibrary::BuildDependency("wheel".to_string()))
|
||||||
} else if TORCH_NOT_FOUND_RE.is_match(line.trim()) {
|
|
||||||
Some(MissingLibrary::BuildDependency("torch".to_string()))
|
|
||||||
} else if DISTUTILS_NOT_FOUND_RE.is_match(line.trim()) {
|
} else if DISTUTILS_NOT_FOUND_RE.is_match(line.trim()) {
|
||||||
Some(MissingLibrary::DeprecatedModule(
|
Some(MissingLibrary::DeprecatedModule(
|
||||||
"distutils".to_string(),
|
"distutils".to_string(),
|
||||||
Version::new([3, 12]),
|
Version::new([3, 12]),
|
||||||
))
|
))
|
||||||
|
} else if let Some(caps) = MODULE_NOT_FOUND.captures(line.trim()) {
|
||||||
|
if let Some(module_match) = caps.get(1) {
|
||||||
|
let module_name = module_match.as_str();
|
||||||
|
let package_name = match crate::pipreqs::MODULE_MAPPING.lookup(module_name) {
|
||||||
|
Some(package) => package.to_string(),
|
||||||
|
None => module_name.to_string(),
|
||||||
|
};
|
||||||
|
Some(MissingLibrary::BuildDependency(package_name))
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
}
|
||||||
} else {
|
} else {
|
||||||
None
|
None
|
||||||
}
|
}
|
||||||
|
|
@ -565,7 +614,7 @@ mod test {
|
||||||
.to_string()
|
.to_string()
|
||||||
.replace("exit status: ", "exit code: ");
|
.replace("exit status: ", "exit code: ");
|
||||||
let formatted = anstream::adapter::strip_str(&formatted);
|
let formatted = anstream::adapter::strip_str(&formatted);
|
||||||
insta::assert_snapshot!(formatted, @r###"
|
insta::assert_snapshot!(formatted, @r#"
|
||||||
Failed building wheel through setup.py (exit code: 0)
|
Failed building wheel through setup.py (exit code: 0)
|
||||||
|
|
||||||
[stderr]
|
[stderr]
|
||||||
|
|
@ -576,8 +625,13 @@ mod test {
|
||||||
|
|
||||||
error: invalid command 'bdist_wheel'
|
error: invalid command 'bdist_wheel'
|
||||||
|
|
||||||
hint: This error likely indicates that `pygraphviz-1.11` depends on `wheel`, but doesn't declare it as a build dependency. If `pygraphviz-1.11` is a first-party package, consider adding `wheel` to its `build-system.requires`. Otherwise, `uv pip install wheel` into the environment and re-run with `--no-build-isolation`.
|
hint: This error likely indicates that `pygraphviz-1.11` depends on `wheel`, but doesn't declare it as a build dependency. If `pygraphviz-1.11` is a first-party package, consider adding `wheel` to its `build-system.requires`. Otherwise, either add it to your `pyproject.toml` under:
|
||||||
"###);
|
|
||||||
|
[tool.uv.extra-build-dependencies]
|
||||||
|
"pygraphviz-1.11" = ["wheel"]
|
||||||
|
|
||||||
|
or `uv pip install wheel` into the environment and re-run with `--no-build-isolation`.
|
||||||
|
"#);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
|
|
||||||
|
|
@ -3,6 +3,7 @@
|
||||||
//! <https://packaging.python.org/en/latest/specifications/source-distribution-format/>
|
//! <https://packaging.python.org/en/latest/specifications/source-distribution-format/>
|
||||||
|
|
||||||
mod error;
|
mod error;
|
||||||
|
mod pipreqs;
|
||||||
|
|
||||||
use std::borrow::Cow;
|
use std::borrow::Cow;
|
||||||
use std::ffi::OsString;
|
use std::ffi::OsString;
|
||||||
|
|
|
||||||
32
crates/uv-build-frontend/src/pipreqs.rs
Normal file
32
crates/uv-build-frontend/src/pipreqs.rs
Normal file
|
|
@ -0,0 +1,32 @@
|
||||||
|
use std::str::FromStr;
|
||||||
|
use std::sync::LazyLock;
|
||||||
|
|
||||||
|
use rustc_hash::FxHashMap;
|
||||||
|
use uv_normalize::PackageName;
|
||||||
|
|
||||||
|
/// A mapping from module name to PyPI package name.
|
||||||
|
pub(crate) struct ModuleMap<'a>(FxHashMap<&'a str, PackageName>);
|
||||||
|
|
||||||
|
impl<'a> ModuleMap<'a> {
|
||||||
|
/// Generate a [`ModuleMap`] from a string representation, encoded in `${module}:{package}` format.
|
||||||
|
fn from_str(source: &'a str) -> Self {
|
||||||
|
let mut mapping = FxHashMap::default();
|
||||||
|
for line in source.lines() {
|
||||||
|
if let Some((module, package)) = line.split_once(':') {
|
||||||
|
let module = module.trim();
|
||||||
|
let package = PackageName::from_str(package.trim()).unwrap();
|
||||||
|
mapping.insert(module, package);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Self(mapping)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Look up a PyPI package name for a given module name.
|
||||||
|
pub(crate) fn lookup(&self, module: &str) -> Option<&PackageName> {
|
||||||
|
self.0.get(module)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A mapping from module name to PyPI package name.
|
||||||
|
pub(crate) static MODULE_MAPPING: LazyLock<ModuleMap> =
|
||||||
|
LazyLock::new(|| ModuleMap::from_str(include_str!("pipreqs/mapping")));
|
||||||
201
crates/uv-build-frontend/src/pipreqs/LICENSE
Normal file
201
crates/uv-build-frontend/src/pipreqs/LICENSE
Normal file
|
|
@ -0,0 +1,201 @@
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright {yyyy} {name of copyright owner}
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
1156
crates/uv-build-frontend/src/pipreqs/mapping
Normal file
1156
crates/uv-build-frontend/src/pipreqs/mapping
Normal file
File diff suppressed because it is too large
Load diff
|
|
@ -4954,7 +4954,7 @@ fn no_build_isolation() -> Result<()> {
|
||||||
uv_snapshot!(context.filters(), context.pip_install()
|
uv_snapshot!(context.filters(), context.pip_install()
|
||||||
.arg("-r")
|
.arg("-r")
|
||||||
.arg("requirements.in")
|
.arg("requirements.in")
|
||||||
.arg("--no-build-isolation"), @r###"
|
.arg("--no-build-isolation"), @r#"
|
||||||
success: false
|
success: false
|
||||||
exit_code: 1
|
exit_code: 1
|
||||||
----- stdout -----
|
----- stdout -----
|
||||||
|
|
@ -4969,8 +4969,13 @@ fn no_build_isolation() -> Result<()> {
|
||||||
File "<string>", line 8, in <module>
|
File "<string>", line 8, in <module>
|
||||||
ModuleNotFoundError: No module named 'setuptools'
|
ModuleNotFoundError: No module named 'setuptools'
|
||||||
|
|
||||||
hint: This usually indicates a problem with the package or the build environment.
|
hint: This error likely indicates that `anyio` depends on `setuptools`, but doesn't declare it as a build dependency. If `anyio` is a first-party package, consider adding `setuptools` to its `build-system.requires`. Otherwise, either add it to your `pyproject.toml` under:
|
||||||
"###
|
|
||||||
|
[tool.uv.extra-build-dependencies]
|
||||||
|
anyio = ["setuptools"]
|
||||||
|
|
||||||
|
or `uv pip install setuptools` into the environment and re-run with `--no-build-isolation`.
|
||||||
|
"#
|
||||||
);
|
);
|
||||||
|
|
||||||
// Install `setuptools` and `wheel`.
|
// Install `setuptools` and `wheel`.
|
||||||
|
|
@ -5022,7 +5027,7 @@ fn respect_no_build_isolation_env_var() -> Result<()> {
|
||||||
uv_snapshot!(context.filters(), context.pip_install()
|
uv_snapshot!(context.filters(), context.pip_install()
|
||||||
.arg("-r")
|
.arg("-r")
|
||||||
.arg("requirements.in")
|
.arg("requirements.in")
|
||||||
.env(EnvVars::UV_NO_BUILD_ISOLATION, "yes"), @r###"
|
.env(EnvVars::UV_NO_BUILD_ISOLATION, "yes"), @r#"
|
||||||
success: false
|
success: false
|
||||||
exit_code: 1
|
exit_code: 1
|
||||||
----- stdout -----
|
----- stdout -----
|
||||||
|
|
@ -5037,8 +5042,13 @@ fn respect_no_build_isolation_env_var() -> Result<()> {
|
||||||
File "<string>", line 8, in <module>
|
File "<string>", line 8, in <module>
|
||||||
ModuleNotFoundError: No module named 'setuptools'
|
ModuleNotFoundError: No module named 'setuptools'
|
||||||
|
|
||||||
hint: This usually indicates a problem with the package or the build environment.
|
hint: This error likely indicates that `anyio` depends on `setuptools`, but doesn't declare it as a build dependency. If `anyio` is a first-party package, consider adding `setuptools` to its `build-system.requires`. Otherwise, either add it to your `pyproject.toml` under:
|
||||||
"###
|
|
||||||
|
[tool.uv.extra-build-dependencies]
|
||||||
|
anyio = ["setuptools"]
|
||||||
|
|
||||||
|
or `uv pip install setuptools` into the environment and re-run with `--no-build-isolation`.
|
||||||
|
"#
|
||||||
);
|
);
|
||||||
|
|
||||||
// Install `setuptools` and `wheel`.
|
// Install `setuptools` and `wheel`.
|
||||||
|
|
@ -8663,7 +8673,7 @@ fn install_build_isolation_package() -> Result<()> {
|
||||||
uv_snapshot!(context.filters(), context.pip_install()
|
uv_snapshot!(context.filters(), context.pip_install()
|
||||||
.arg("--no-build-isolation-package")
|
.arg("--no-build-isolation-package")
|
||||||
.arg("iniconfig")
|
.arg("iniconfig")
|
||||||
.arg(package.path()), @r###"
|
.arg(package.path()), @r#"
|
||||||
success: false
|
success: false
|
||||||
exit_code: 1
|
exit_code: 1
|
||||||
----- stdout -----
|
----- stdout -----
|
||||||
|
|
@ -8678,8 +8688,13 @@ fn install_build_isolation_package() -> Result<()> {
|
||||||
File "<string>", line 8, in <module>
|
File "<string>", line 8, in <module>
|
||||||
ModuleNotFoundError: No module named 'hatchling'
|
ModuleNotFoundError: No module named 'hatchling'
|
||||||
|
|
||||||
hint: This usually indicates a problem with the package or the build environment.
|
hint: This error likely indicates that `iniconfig` depends on `hatchling`, but doesn't declare it as a build dependency. If `iniconfig` is a first-party package, consider adding `hatchling` to its `build-system.requires`. Otherwise, either add it to your `pyproject.toml` under:
|
||||||
"###
|
|
||||||
|
[tool.uv.extra-build-dependencies]
|
||||||
|
iniconfig = ["hatchling"]
|
||||||
|
|
||||||
|
or `uv pip install hatchling` into the environment and re-run with `--no-build-isolation`.
|
||||||
|
"#
|
||||||
);
|
);
|
||||||
|
|
||||||
// Install `hatchinling`, `hatch-vs` for iniconfig
|
// Install `hatchinling`, `hatch-vs` for iniconfig
|
||||||
|
|
|
||||||
|
|
@ -1410,7 +1410,12 @@ fn sync_build_isolation_package() -> Result<()> {
|
||||||
File "<string>", line 8, in <module>
|
File "<string>", line 8, in <module>
|
||||||
ModuleNotFoundError: No module named 'hatchling'
|
ModuleNotFoundError: No module named 'hatchling'
|
||||||
|
|
||||||
hint: This usually indicates a problem with the package or the build environment.
|
hint: This error likely indicates that `source-distribution` depends on `hatchling`, but doesn't declare it as a build dependency. If `source-distribution` is a first-party package, consider adding `hatchling` to its `build-system.requires`. Otherwise, either add it to your `pyproject.toml` under:
|
||||||
|
|
||||||
|
[tool.uv.extra-build-dependencies]
|
||||||
|
source-distribution = ["hatchling"]
|
||||||
|
|
||||||
|
or `uv pip install hatchling` into the environment and re-run with `--no-build-isolation`.
|
||||||
help: `source-distribution` was included because `project` (v0.1.0) depends on `source-distribution`
|
help: `source-distribution` was included because `project` (v0.1.0) depends on `source-distribution`
|
||||||
"#);
|
"#);
|
||||||
|
|
||||||
|
|
@ -1500,7 +1505,12 @@ fn sync_build_isolation_extra() -> Result<()> {
|
||||||
File "<string>", line 8, in <module>
|
File "<string>", line 8, in <module>
|
||||||
ModuleNotFoundError: No module named 'hatchling'
|
ModuleNotFoundError: No module named 'hatchling'
|
||||||
|
|
||||||
hint: This usually indicates a problem with the package or the build environment.
|
hint: This error likely indicates that `source-distribution` depends on `hatchling`, but doesn't declare it as a build dependency. If `source-distribution` is a first-party package, consider adding `hatchling` to its `build-system.requires`. Otherwise, either add it to your `pyproject.toml` under:
|
||||||
|
|
||||||
|
[tool.uv.extra-build-dependencies]
|
||||||
|
source-distribution = ["hatchling"]
|
||||||
|
|
||||||
|
or `uv pip install hatchling` into the environment and re-run with `--no-build-isolation`.
|
||||||
help: `source-distribution` was included because `project[compile]` (v0.1.0) depends on `source-distribution`
|
help: `source-distribution` was included because `project[compile]` (v0.1.0) depends on `source-distribution`
|
||||||
"#);
|
"#);
|
||||||
|
|
||||||
|
|
@ -1521,7 +1531,12 @@ fn sync_build_isolation_extra() -> Result<()> {
|
||||||
File "<string>", line 8, in <module>
|
File "<string>", line 8, in <module>
|
||||||
ModuleNotFoundError: No module named 'hatchling'
|
ModuleNotFoundError: No module named 'hatchling'
|
||||||
|
|
||||||
hint: This usually indicates a problem with the package or the build environment.
|
hint: This error likely indicates that `source-distribution` depends on `hatchling`, but doesn't declare it as a build dependency. If `source-distribution` is a first-party package, consider adding `hatchling` to its `build-system.requires`. Otherwise, either add it to your `pyproject.toml` under:
|
||||||
|
|
||||||
|
[tool.uv.extra-build-dependencies]
|
||||||
|
source-distribution = ["hatchling"]
|
||||||
|
|
||||||
|
or `uv pip install hatchling` into the environment and re-run with `--no-build-isolation`.
|
||||||
help: `source-distribution` was included because `project[compile]` (v0.1.0) depends on `source-distribution`
|
help: `source-distribution` was included because `project[compile]` (v0.1.0) depends on `source-distribution`
|
||||||
"#);
|
"#);
|
||||||
|
|
||||||
|
|
@ -2328,6 +2343,176 @@ fn sync_extra_build_dependencies_sources_from_child() -> Result<()> {
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn sync_build_dependencies_module_error_hints() -> Result<()> {
|
||||||
|
let context = TestContext::new("3.12").with_filtered_counts();
|
||||||
|
|
||||||
|
// Write a test package that arbitrarily requires `anyio` at build time
|
||||||
|
let child = context.temp_dir.child("child");
|
||||||
|
child.create_dir_all()?;
|
||||||
|
let child_pyproject_toml = child.child("pyproject.toml");
|
||||||
|
child_pyproject_toml.write_str(indoc! {r#"
|
||||||
|
[project]
|
||||||
|
name = "child"
|
||||||
|
version = "0.1.0"
|
||||||
|
requires-python = ">=3.9"
|
||||||
|
|
||||||
|
[build-system]
|
||||||
|
requires = ["hatchling"]
|
||||||
|
backend-path = ["."]
|
||||||
|
build-backend = "build_backend"
|
||||||
|
"#})?;
|
||||||
|
let build_backend = child.child("build_backend.py");
|
||||||
|
build_backend.write_str(indoc! {r"
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from hatchling.build import *
|
||||||
|
import anyio
|
||||||
|
"})?;
|
||||||
|
child.child("src/child/__init__.py").touch()?;
|
||||||
|
|
||||||
|
let parent = &context.temp_dir;
|
||||||
|
let pyproject_toml = parent.child("pyproject.toml");
|
||||||
|
pyproject_toml.write_str(indoc! {r#"
|
||||||
|
[project]
|
||||||
|
name = "parent"
|
||||||
|
version = "0.1.0"
|
||||||
|
requires-python = ">=3.9"
|
||||||
|
dependencies = ["child"]
|
||||||
|
|
||||||
|
[tool.uv.sources]
|
||||||
|
child = { path = "child" }
|
||||||
|
"#})?;
|
||||||
|
|
||||||
|
context.venv().arg("--clear").assert().success();
|
||||||
|
// Running `uv sync` should fail due to missing build-dependencies
|
||||||
|
uv_snapshot!(context.filters(), context.sync(), @r#"
|
||||||
|
success: false
|
||||||
|
exit_code: 1
|
||||||
|
----- stdout -----
|
||||||
|
|
||||||
|
----- stderr -----
|
||||||
|
Resolved [N] packages in [TIME]
|
||||||
|
× Failed to build `child @ file://[TEMP_DIR]/child`
|
||||||
|
├─▶ The build backend returned an error
|
||||||
|
╰─▶ Call to `build_backend.build_wheel` failed (exit status: 1)
|
||||||
|
|
||||||
|
[stderr]
|
||||||
|
Traceback (most recent call last):
|
||||||
|
File "<string>", line 8, in <module>
|
||||||
|
File "[TEMP_DIR]/child/build_backend.py", line 4, in <module>
|
||||||
|
import anyio
|
||||||
|
ModuleNotFoundError: No module named 'anyio'
|
||||||
|
|
||||||
|
hint: This error likely indicates that `child@0.1.0` depends on `anyio`, but doesn't declare it as a build dependency. If `child` is a first-party package, consider adding `anyio` to its `build-system.requires`. Otherwise, either add it to your `pyproject.toml` under:
|
||||||
|
|
||||||
|
[tool.uv.extra-build-dependencies]
|
||||||
|
child = ["anyio"]
|
||||||
|
|
||||||
|
or `uv pip install anyio` into the environment and re-run with `--no-build-isolation`.
|
||||||
|
help: `child` was included because `parent` (v0.1.0) depends on `child`
|
||||||
|
"#);
|
||||||
|
|
||||||
|
// Adding `extra-build-dependencies` should solve the issue
|
||||||
|
pyproject_toml.write_str(indoc! {r#"
|
||||||
|
[project]
|
||||||
|
name = "parent"
|
||||||
|
version = "0.1.0"
|
||||||
|
requires-python = ">=3.9"
|
||||||
|
dependencies = ["child"]
|
||||||
|
|
||||||
|
[tool.uv.sources]
|
||||||
|
child = { path = "child" }
|
||||||
|
|
||||||
|
[tool.uv.extra-build-dependencies]
|
||||||
|
child = ["anyio"]
|
||||||
|
"#})?;
|
||||||
|
|
||||||
|
context.venv().arg("--clear").assert().success();
|
||||||
|
uv_snapshot!(context.filters(), context.sync(), @r"
|
||||||
|
success: true
|
||||||
|
exit_code: 0
|
||||||
|
----- stdout -----
|
||||||
|
|
||||||
|
----- stderr -----
|
||||||
|
warning: The `extra-build-dependencies` option is experimental and may change without warning. Pass `--preview-features extra-build-dependencies` to disable this warning.
|
||||||
|
Resolved [N] packages in [TIME]
|
||||||
|
Prepared [N] packages in [TIME]
|
||||||
|
Installed [N] packages in [TIME]
|
||||||
|
+ child==0.1.0 (from file://[TEMP_DIR]/child)
|
||||||
|
");
|
||||||
|
|
||||||
|
// Assert pipreqs module name to package name lookup works.
|
||||||
|
build_backend.write_str(indoc! {r"
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from hatchling.build import *
|
||||||
|
import anyio
|
||||||
|
import sklearn
|
||||||
|
"})?;
|
||||||
|
|
||||||
|
context.venv().arg("--clear").assert().success();
|
||||||
|
// Running `uv sync` should fail due to missing build-dependencies
|
||||||
|
uv_snapshot!(context.filters(), context.sync().arg("--reinstall"), @r#"
|
||||||
|
success: false
|
||||||
|
exit_code: 1
|
||||||
|
----- stdout -----
|
||||||
|
|
||||||
|
----- stderr -----
|
||||||
|
warning: The `extra-build-dependencies` option is experimental and may change without warning. Pass `--preview-features extra-build-dependencies` to disable this warning.
|
||||||
|
Resolved [N] packages in [TIME]
|
||||||
|
× Failed to build `child @ file://[TEMP_DIR]/child`
|
||||||
|
├─▶ The build backend returned an error
|
||||||
|
╰─▶ Call to `build_backend.build_wheel` failed (exit status: 1)
|
||||||
|
|
||||||
|
[stderr]
|
||||||
|
Traceback (most recent call last):
|
||||||
|
File "<string>", line 8, in <module>
|
||||||
|
File "[TEMP_DIR]/child/build_backend.py", line 5, in <module>
|
||||||
|
import sklearn
|
||||||
|
ModuleNotFoundError: No module named 'sklearn'
|
||||||
|
|
||||||
|
hint: This error likely indicates that `child@0.1.0` depends on `scikit-learn`, but doesn't declare it as a build dependency. If `child` is a first-party package, consider adding `scikit-learn` to its `build-system.requires`. Otherwise, either add it to your `pyproject.toml` under:
|
||||||
|
|
||||||
|
[tool.uv.extra-build-dependencies]
|
||||||
|
child = ["scikit-learn"]
|
||||||
|
|
||||||
|
or `uv pip install scikit-learn` into the environment and re-run with `--no-build-isolation`.
|
||||||
|
help: `child` was included because `parent` (v0.1.0) depends on `child`
|
||||||
|
"#);
|
||||||
|
|
||||||
|
// Adding `extra-build-dependencies` should solve the issue
|
||||||
|
pyproject_toml.write_str(indoc! {r#"
|
||||||
|
[project]
|
||||||
|
name = "parent"
|
||||||
|
version = "0.1.0"
|
||||||
|
requires-python = ">=3.9"
|
||||||
|
dependencies = ["child"]
|
||||||
|
|
||||||
|
[tool.uv.sources]
|
||||||
|
child = { path = "child" }
|
||||||
|
|
||||||
|
[tool.uv.extra-build-dependencies]
|
||||||
|
child = ["anyio", "scikit-learn"]
|
||||||
|
"#})?;
|
||||||
|
|
||||||
|
context.venv().arg("--clear").assert().success();
|
||||||
|
uv_snapshot!(context.filters(), context.sync(), @r"
|
||||||
|
success: true
|
||||||
|
exit_code: 0
|
||||||
|
----- stdout -----
|
||||||
|
|
||||||
|
----- stderr -----
|
||||||
|
warning: The `extra-build-dependencies` option is experimental and may change without warning. Pass `--preview-features extra-build-dependencies` to disable this warning.
|
||||||
|
Resolved [N] packages in [TIME]
|
||||||
|
Prepared [N] packages in [TIME]
|
||||||
|
Installed [N] packages in [TIME]
|
||||||
|
+ child==0.1.0 (from file://[TEMP_DIR]/child)
|
||||||
|
");
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
/// Avoid using incompatible versions for build dependencies that are also part of the resolved
|
/// Avoid using incompatible versions for build dependencies that are also part of the resolved
|
||||||
/// environment. This is a very subtle issue, but: when locking, we don't enforce platform
|
/// environment. This is a very subtle issue, but: when locking, we don't enforce platform
|
||||||
/// compatibility. So, if we reuse the resolver state to install, and the install itself has to
|
/// compatibility. So, if we reuse the resolver state to install, and the install itself has to
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue