feat: add support for PEP 517 config settings in Python builds

This commit is contained in:
2026-02-28 14:07:17 -06:00
parent 73a994ac53
commit 421ca362ac
3 changed files with 227 additions and 1 deletions
+22
View File
@@ -614,6 +614,13 @@ pub fn create_interactive() -> Result<PackageSpec> {
.prompt()?;
}
if matches!(build_type, BuildType::Python) && show_advanced {
flags.config_settings = prompt_repeating_list(
"PEP 517 config-setting",
"Format: KEY=VALUE (repeat keys to pass multiple values)",
)?;
}
if matches!(build_type, BuildType::Bin) {
flags.binary_type = prompt_optional_text(
"Binary type (optional):",
@@ -1222,6 +1229,19 @@ pub fn spec_to_minimal_toml(spec: &PackageSpec) -> anyhow::Result<String> {
),
);
}
if !spec.build.flags.config_settings.is_empty() {
flags_tbl.insert(
"config_setting".into(),
Value::Array(
spec.build
.flags
.config_settings
.iter()
.map(|s| Value::String(s.clone()))
.collect(),
),
);
}
if spec.build.flags.bindir != defaults.bindir {
flags_tbl.insert(
"bindir".into(),
@@ -1445,6 +1465,7 @@ mod tests {
flags.makefile_commands = vec!["make".into()];
flags.makefile_install_commands = vec!["make DESTDIR=$DESTDIR install".into()];
flags.cargs = vec!["--locked".into()];
flags.config_settings = vec!["editable_mode=compat".into()];
flags.rustflags = vec!["-Ctarget-cpu=native".into()];
flags.cxxflags = vec!["-O2".into(), "-fno-rtti".into()];
flags.target = "x86_64-unknown-linux-gnu".into();
@@ -1501,6 +1522,7 @@ mod tests {
assert!(toml.contains("makefile_commands = ["));
assert!(toml.contains("makefile_install_commands = ["));
assert!(toml.contains("cargs = ["));
assert!(toml.contains("config_setting = ["));
assert!(toml.contains("rustflags = ["));
assert!(toml.contains("cxxflags = ["));
assert!(toml.contains("target = \"x86_64-unknown-linux-gnu\""));
+112
View File
@@ -531,6 +531,17 @@ impl PackageSpec {
self.build.flags.configure_lib32 = vec![s.to_string()];
}
}
"config_setting" | "config_settings" | "config-setting" | "config-settings" => {
if let Some(arr) = v.as_array() {
self.build.flags.config_settings = arr
.iter()
.filter_map(|x| x.as_str())
.map(String::from)
.collect();
} else if let Some(s) = v.as_str() {
self.build.flags.config_settings = vec![s.to_string()];
}
}
"configure_file" | "configure-file" => {
if let Some(s) = v.as_str() {
self.build.flags.configure_file = s.to_string();
@@ -706,6 +717,18 @@ impl PackageSpec {
}
}
}
"config_setting" | "config_settings" | "config-setting" | "config-settings" => {
for v in values {
if let Some(arr) = v.as_array() {
self.build
.flags
.config_settings
.extend(arr.iter().filter_map(|x| x.as_str()).map(String::from));
} else if let Some(s) = v.as_str() {
self.build.flags.config_settings.push(s.to_string());
}
}
}
"configure_file" | "configure-file" => {
if let Some(s) = values.last().and_then(|v| v.as_str()) {
self.build.flags.configure_file = s.to_string();
@@ -1358,6 +1381,45 @@ type = "python"
assert!(matches!(spec.build.build_type, BuildType::Python));
}
#[test]
fn parse_python_config_settings_from_spec() {
let tmp = tempfile::tempdir().unwrap();
let path = tmp.path().join("pkg.toml");
std::fs::write(
&path,
r#"
[package]
name = "foo"
version = "1.0"
description = "d"
homepage = "h"
license = "MIT"
[source]
url = "https://example.com/foo.tar.gz"
sha256 = "skip"
extract_dir = "foo"
[build]
type = "python"
[build.flags]
config-setting = ["editable_mode=compat", "setup-args=--plat-name=x86_64"]
"#,
)
.unwrap();
let spec = PackageSpec::from_file(&path).unwrap();
assert_eq!(
spec.build.flags.config_settings,
vec![
"editable_mode=compat".to_string(),
"setup-args=--plat-name=x86_64".to_string()
]
);
}
#[test]
fn parse_multiple_licenses() {
let tmp = tempfile::tempdir().unwrap();
@@ -1601,6 +1663,7 @@ no_compress_man = true
skip_tests = true
keep = ["etc/locale.gen"]
configure_file = "configure.gnu"
config-setting = ["editable_mode=compat"]
post_configure = ["echo configured"]
"#,
)
@@ -1666,6 +1729,12 @@ post_configure = ["echo configured"]
"build.flags.configure_file".to_string(),
vec![toml::Value::String("build-aux/configure".to_string())],
);
config.appends.insert(
"build.flags.config-setting".to_string(),
vec![toml::Value::String(
"setup-args=--plat-name=x86_64".to_string(),
)],
);
config.appends.insert(
"build.flags.post_configure".to_string(),
vec![toml::Value::String("touch configured.stamp".to_string())],
@@ -1754,6 +1823,18 @@ post_configure = ["echo configured"]
.contains(&"tools".to_string())
);
assert_eq!(spec.build.flags.configure_file, "build-aux/configure");
assert!(
spec.build
.flags
.config_settings
.contains(&"editable_mode=compat".to_string())
);
assert!(
spec.build
.flags
.config_settings
.contains(&"setup-args=--plat-name=x86_64".to_string())
);
assert!(
spec.build
.flags
@@ -2689,6 +2770,16 @@ pub struct BuildFlags {
pub build_32: bool,
#[serde(default)]
pub configure: Vec<String>,
/// PEP 517 config settings for Python builds (each entry is `KEY=VALUE` or `KEY`).
#[serde(
default,
alias = "config-setting",
alias = "config-settings",
alias = "config_setting",
alias = "config_settings",
deserialize_with = "deserialize_string_or_array_no_split"
)]
pub config_settings: Vec<String>,
/// Configure arguments used only for the lib32 build variant (replaces `configure` when set).
#[serde(default, alias = "configure-lib32", alias = "configure_lib32")]
pub configure_lib32: Vec<String>,
@@ -2911,6 +3002,7 @@ impl Default for BuildFlags {
skip_tests: false,
build_32: false,
configure: Vec::new(),
config_settings: Vec::new(),
configure_lib32: Vec::new(),
configure_file: String::new(),
cc: default_cc(),
@@ -2977,6 +3069,26 @@ where
}
}
fn deserialize_string_or_array_no_split<'de, D>(
deserializer: D,
) -> std::result::Result<Vec<String>, D::Error>
where
D: Deserializer<'de>,
{
#[derive(Deserialize)]
#[serde(untagged)]
enum StringOrArray {
String(String),
Array(Vec<String>),
}
match Option::<StringOrArray>::deserialize(deserializer)? {
Some(StringOrArray::String(s)) => Ok(vec![s]),
Some(StringOrArray::Array(a)) => Ok(a),
None => Ok(Vec::new()),
}
}
fn deserialize_boolish<'de, D>(deserializer: D) -> std::result::Result<bool, D::Error>
where
D: Deserializer<'de>,