Skip to content

uv init: Make uv_build the default build backend (from hatchling) #14661

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

Merged
zanieb merged 2 commits into from
Jul 16, 2025
Merged

uv init: Make uv_build the default build backend (from hatchling) #14661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f63fd4
Switch the `uv init` default build backend from hatchling to uv_build
konstin Jul 16, 2025
3ae2f9d
Update and cleanup tests
konstin Jul 16, 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
14 changes: 7 additions & 7 deletions crates/uv-build-backend/src/metadata.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ impl PyProjectToml {
///
/// ```toml
/// [build-system]
/// requires = ["uv_build>=0.4.15,<5"]
/// requires = ["uv_build>=0.4.15,<0.5"]
/// build-backend = "uv_build"
/// ```
pub fn check_build_system(&self, uv_version: &str) -> Vec<String> {
Expand Down Expand Up @@ -826,7 +826,7 @@ mod tests {
{payload}

[build-system]
requires = ["uv_build>=0.4.15,<5"]
requires = ["uv_build>=0.4.15,<0.5"]
build-backend = "uv_build"
"#
}
Expand Down Expand Up @@ -909,7 +909,7 @@ mod tests {
foo-bar = "foo:bar"

[build-system]
requires = ["uv_build>=0.4.15,<5"]
requires = ["uv_build>=0.4.15,<0.5"]
build-backend = "uv_build"
"#
};
Expand Down Expand Up @@ -1036,7 +1036,7 @@ mod tests {
foo-bar = "foo:bar"

[build-system]
requires = ["uv_build>=0.4.15,<5"]
requires = ["uv_build>=0.4.15,<0.5"]
build-backend = "uv_build"
"#
};
Expand Down Expand Up @@ -1104,7 +1104,7 @@ mod tests {
let contents = extend_project("");
let pyproject_toml = PyProjectToml::parse(&contents).unwrap();
assert_snapshot!(
pyproject_toml.check_build_system("1.0.0+test").join("\n"),
pyproject_toml.check_build_system("0.4.15+test").join("\n"),
@""
);
}
Expand Down Expand Up @@ -1135,7 +1135,7 @@ mod tests {
version = "0.1.0"

[build-system]
requires = ["uv_build>=0.4.15,<5", "wheel"]
requires = ["uv_build>=0.4.15,<0.5", "wheel"]
build-backend = "uv_build"
"#};
let pyproject_toml = PyProjectToml::parse(contents).unwrap();
Expand Down Expand Up @@ -1171,7 +1171,7 @@ mod tests {
version = "0.1.0"

[build-system]
requires = ["uv_build>=0.4.15,<5"]
requires = ["uv_build>=0.4.15,<0.5"]
build-backend = "setuptools"
"#};
let pyproject_toml = PyProjectToml::parse(contents).unwrap();
Expand Down
21 changes: 2 additions & 19 deletions crates/uv/src/commands/project/init.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,6 @@ pub(crate) async fn init(
printer: Printer,
preview: PreviewMode,
) -> Result<ExitStatus> {
if build_backend == Some(ProjectBuildBackend::Uv) && preview.is_disabled() {
warn_user_once!("The uv build backend is experimental and may change without warning");
}
match init_kind {
InitKind::Script => {
let Some(path) = explicit_path.as_deref() else {
Expand Down Expand Up @@ -596,7 +593,6 @@ async fn init_project(
author_from,
no_readme,
package,
preview,
)?;

if let Some(workspace) = workspace {
Expand Down Expand Up @@ -724,7 +720,6 @@ impl InitProjectKind {
author_from: Option<AuthorFrom>,
no_readme: bool,
package: bool,
preview: PreviewMode,
) -> Result<()> {
match self {
InitProjectKind::Application => InitProjectKind::init_application(
Expand All @@ -739,7 +734,6 @@ impl InitProjectKind {
author_from,
no_readme,
package,
preview,
),
InitProjectKind::Library => InitProjectKind::init_library(
name,
Expand All @@ -753,7 +747,6 @@ impl InitProjectKind {
author_from,
no_readme,
package,
preview,
),
}
}
Expand All @@ -772,7 +765,6 @@ impl InitProjectKind {
author_from: Option<AuthorFrom>,
no_readme: bool,
package: bool,
preview: PreviewMode,
) -> Result<()> {
fs_err::create_dir_all(path)?;

Expand Down Expand Up @@ -805,11 +797,7 @@ impl InitProjectKind {
}

// Add a build system
let build_backend = match build_backend {
Some(build_backend) => build_backend,
None if preview.is_enabled() => ProjectBuildBackend::Uv,
None => ProjectBuildBackend::Hatch,
};
let build_backend = build_backend.unwrap_or(ProjectBuildBackend::Uv);
Copy link
Member Author

@konstin konstin Jul 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could have this as enum default but I like having this explicit since we're doing a multi-step change of defaults.

pyproject.push('\n');
pyproject.push_str(&pyproject_build_system(name, build_backend));
pyproject_build_backend_prerequisites(name, path, build_backend)?;
Expand Down Expand Up @@ -859,7 +847,6 @@ impl InitProjectKind {
author_from: Option<AuthorFrom>,
no_readme: bool,
package: bool,
preview: PreviewMode,
) -> Result<()> {
if !package {
return Err(anyhow!("Library projects must be packaged"));
Expand All @@ -880,11 +867,7 @@ impl InitProjectKind {
);

// Always include a build system if the project is packaged.
let build_backend = match build_backend {
Some(build_backend) => build_backend,
None if preview.is_enabled() => ProjectBuildBackend::Uv,
None => ProjectBuildBackend::Hatch,
};
let build_backend = build_backend.unwrap_or(ProjectBuildBackend::Uv);
pyproject.push('\n');
pyproject.push_str(&pyproject_build_system(name, build_backend));
pyproject_build_backend_prerequisites(name, path, build_backend)?;
Expand Down
17 changes: 2 additions & 15 deletions crates/uv/tests/it/build.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1439,7 +1439,6 @@ fn build_fast_path() -> Result<()> {
let built_by_uv = current_dir()?.join("../../scripts/packages/built-by-uv");

uv_snapshot!(context.build()
.arg("--preview")
.arg(&built_by_uv)
.arg("--out-dir")
.arg(context.temp_dir.join("output1")), @r###"
Expand All @@ -1465,7 +1464,6 @@ fn build_fast_path() -> Result<()> {
.assert(predicate::path::is_file());

uv_snapshot!(context.build()
.arg("--preview")
.arg(&built_by_uv)
.arg("--out-dir")
.arg(context.temp_dir.join("output2"))
Expand All @@ -1485,7 +1483,6 @@ fn build_fast_path() -> Result<()> {
.assert(predicate::path::is_file());

uv_snapshot!(context.build()
.arg("--preview")
.arg(&built_by_uv)
.arg("--out-dir")
.arg(context.temp_dir.join("output3"))
Expand All @@ -1505,7 +1502,6 @@ fn build_fast_path() -> Result<()> {
.assert(predicate::path::is_file());

uv_snapshot!(context.build()
.arg("--preview")
.arg(&built_by_uv)
.arg("--out-dir")
.arg(context.temp_dir.join("output4"))
Expand Down Expand Up @@ -1545,7 +1541,6 @@ fn build_list_files() -> Result<()> {
// By default, we build the wheel from the source dist, which we need to do even for the list
// task.
uv_snapshot!(context.build()
.arg("--preview")
.arg(&built_by_uv)
.arg("--out-dir")
.arg(context.temp_dir.join("output1"))
Expand Down Expand Up @@ -1601,7 +1596,6 @@ fn build_list_files() -> Result<()> {
.assert(predicate::path::missing());

uv_snapshot!(context.build()
.arg("--preview")
.arg(&built_by_uv)
.arg("--out-dir")
.arg(context.temp_dir.join("output2"))
Expand Down Expand Up @@ -1670,7 +1664,6 @@ fn build_list_files_errors() -> Result<()> {
// In CI, we run with link mode settings.
filters.push(("--link-mode <LINK_MODE> ", ""));
uv_snapshot!(filters, context.build()
.arg("--preview")
.arg(&built_by_uv)
.arg("--out-dir")
.arg(context.temp_dir.join("output1"))
Expand All @@ -1694,7 +1687,6 @@ fn build_list_files_errors() -> Result<()> {
// Windows normalization
filters.push(("/crates/uv/../../", "/"));
uv_snapshot!(filters, context.build()
.arg("--preview")
.arg(&anyio_local)
.arg("--out-dir")
.arg(context.temp_dir.join("output2"))
Expand Down Expand Up @@ -1987,12 +1979,7 @@ fn force_pep517() -> Result<()> {
// We need to use a real `uv_build` package.
let context = TestContext::new("3.12").with_exclude_newer("2025-05-27T00:00:00Z");

context
.init()
.arg("--build-backend")
.arg("uv")
.assert()
.success();
context.init().assert().success();

let pyproject_toml = context.temp_dir.child("pyproject.toml");
pyproject_toml.write_str(indoc! {r#"
Expand Down Expand Up @@ -2026,7 +2013,7 @@ fn force_pep517() -> Result<()> {

----- stderr -----
Building source distribution...
Error: Missing module directory for `does_not_exist` in `src`. Found: `temp`
Error: Missing source directory at: `src`
× Failed to build `[TEMP_DIR]/`
├─▶ The build backend returned an error
╰─▶ Call to `uv_build.build_sdist` failed (exit status: 1)
Expand Down
20 changes: 9 additions & 11 deletions crates/uv/tests/it/build_backend.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,7 @@ fn preserve_executable_bit() -> Result<()> {
let project_dir = context.temp_dir.path().join("preserve_executable_bit");
context
.init()
.arg("--build-backend")
.arg("uv")
.arg("--lib")
.arg(&project_dir)
.assert()
.success();
Expand Down Expand Up @@ -296,7 +295,7 @@ fn rename_module() -> Result<()> {
module-name = "bar"

[build-system]
requires = ["uv_build>=0.5,<0.8"]
requires = ["uv_build>=0.7,<10000"]
build-backend = "uv_build"
"#})?;

Expand Down Expand Up @@ -377,7 +376,7 @@ fn rename_module_editable_build() -> Result<()> {
module-name = "bar"

[build-system]
requires = ["uv_build>=0.5,<0.8"]
requires = ["uv_build>=0.7,<10000"]
build-backend = "uv_build"
"#})?;

Expand Down Expand Up @@ -436,7 +435,7 @@ fn build_module_name_normalization() -> Result<()> {
version = "1.0.0"

[build-system]
requires = ["uv_build>=0.5,<0.8"]
requires = ["uv_build>=0.7,<10000"]
build-backend = "uv_build"

[tool.uv.build-backend]
Expand Down Expand Up @@ -548,7 +547,7 @@ fn build_sdist_with_long_path() -> Result<()> {
version = "1.0.0"

[build-system]
requires = ["uv_build>=0.7,<0.8"]
requires = ["uv_build>=0.7,<10000"]
build-backend = "uv_build"
"#})?;
context
Expand Down Expand Up @@ -591,7 +590,7 @@ fn sdist_error_without_module() -> Result<()> {
version = "1.0.0"

[build-system]
requires = ["uv_build>=0.7,<0.8"]
requires = ["uv_build>=0.7,<10000"]
build-backend = "uv_build"
"#})?;

Expand Down Expand Up @@ -661,7 +660,7 @@ fn complex_namespace_packages() -> Result<()> {
module-name = "{project_name_dist_info}.{part_name}"

[build-system]
requires = ["uv_build>=0.5.15,<10000"]
requires = ["uv_build>=0.7,<10000"]
build-backend = "uv_build"
"#
};
Expand Down Expand Up @@ -770,8 +769,7 @@ fn symlinked_file() -> Result<()> {
let project = context.temp_dir.child("project");
context
.init()
.arg("--build-backend")
.arg("uv")
.arg("--lib")
.arg(project.path())
.assert()
.success();
Expand All @@ -783,7 +781,7 @@ fn symlinked_file() -> Result<()> {
license-files = ["LICENSE"]

[build-system]
requires = ["uv_build>=0.5.15,<10000"]
requires = ["uv_build>=0.7,<10000"]
build-backend = "uv_build"
"#
})?;
Expand Down
8 changes: 8 additions & 0 deletions crates/uv/tests/it/common/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,6 +655,14 @@ impl TestContext {
));
// For wiremock tests
filters.push((r"127\.0\.0\.1:\d*".to_string(), "[LOCALHOST]".to_string()));
// Avoid breaking the tests when bumping the uv version
filters.push((
format!(
r#"requires = \["uv_build>={},<[0-9.]+"\]"#,
uv_version::version()
),
r#"requires = ["uv_build>=[CURRENT_VERSION],<[NEXT_BREAKING]"]"#.to_string(),
));

Self {
root: ChildPath::new(root.path()),
Expand Down
Loading
Loading