Don't include the cargo target directory in wheels built from sdists

Author: ngoldbaum

src/binding_generator/mod.rs

@@ -386,6 +386,7 @@ where
             writer,
             &context.project.project_layout,
             context.project.pyproject_toml.as_ref(),
+            &context.project.target_dir,
         )
         .context("Failed to add the python module to the package")?;
     }

src/module_writer/mod.rs

@@ -119,6 +119,7 @@ pub fn write_python_part(
     writer: &mut VirtualWriter<WheelWriter>,
     project_layout: &ProjectLayout,
     pyproject_toml: Option<&PyProjectToml>,
+    target_dir: &Path,
 ) -> Result<()> {
     let python_dir = &project_layout.python_dir;
     let mut python_packages = Vec::new();
@@ -133,11 +134,23 @@ pub fn write_python_part(
         python_packages.push(package_path);
     }
 
+    // Skip the cargo target directory unless it contains a python package (#3319)
+    let target_dir = target_dir
+        .normalize()
+        .ok()
+        .map(|dir| dir.into_path_buf())
+        .filter(|dir| {
+            !python_packages
+                .iter()
+                .any(|package| package.starts_with(dir))
+        });
+
     for absolute in WalkBuilder::new(&project_layout.project_root)
         .hidden(false)
         .parents(false)
         .git_global(false)
         .git_exclude(false)
+        .filter_entry(move |entry| target_dir.as_deref() != Some(entry.path()))
         .build()
     {
         let absolute = match absolute {

tests/common/other.rs

@@ -274,6 +274,15 @@ pub fn check_sdist_mtimes(
 }
 
 fn build_wheel_files(package: impl AsRef<Path>, unique_name: &str) -> Result<ZipArchive<File>> {
+    let target_dir = crate::common::shared_target_dir(&package);
+    build_wheel_files_with_target_dir(package, target_dir, unique_name)
+}
+
+fn build_wheel_files_with_target_dir(
+    package: impl AsRef<Path>,
+    target_dir: PathBuf,
+    unique_name: &str,
+) -> Result<ZipArchive<File>> {
     let manifest_path = package.as_ref().join("Cargo.toml");
     let wheel_directory = Path::new("test-crates").join("wheels").join(unique_name);
 
@@ -285,7 +294,7 @@ fn build_wheel_files(package: impl AsRef<Path>, unique_name: &str) -> Result<Zip
         cargo: CargoOptions {
             manifest_path: Some(manifest_path),
             quiet: true,
-            target_dir: Some(crate::common::shared_target_dir(&package)),
+            target_dir: Some(target_dir),
             ..Default::default()
         },
         platform: PlatformOptions {
@@ -737,6 +746,31 @@ pub fn test_unreadable_dir() -> Result<()> {
     Ok(())
 }
 
+/// Test that a target directory inside the python package isn't packaged outside of git.
+///
+/// See https://github.com/PyO3/maturin/issues/3319
+pub fn test_target_dir_in_python_package() -> Result<()> {
+    let temp_dir = tempfile::tempdir()?;
+    let project_dir = temp_dir.path().join("bin-with-python-module");
+    copy_dir_recursive(
+        Path::new("test-crates/bin-with-python-module"),
+        &project_dir,
+    )?;
+
+    let target_dir = project_dir.join("bin_with_python_module/target");
+    let wheel = build_wheel_files_with_target_dir(
+        &project_dir,
+        target_dir,
+        "wheel-files-bin-with-python-module-target-dir",
+    )?;
+    let package_files: Vec<_> = wheel
+        .file_names()
+        .filter(|name| name.starts_with("bin_with_python_module/"))
+        .collect();
+    assert_eq!(package_files, ["bin_with_python_module/__init__.py"]);
+    Ok(())
+}
+
 /// Test that building wheels from an sdist works correctly.
 /// This simulates the `maturin build --sdist` workflow: build sdist first,
 /// unpack it, then build wheels from the unpacked sdist.

tests/run/wheel.rs

@@ -65,3 +65,8 @@ fn pyo3_wheel_record_has_normalized_paths() {
         "wheel-record-pyo3-mixed-include-exclude",
     ))
 }
+
+#[test]
+fn target_dir_in_python_package() {
+    handle_result(other::test_target_dir_in_python_package())
+}