Merge pull request #223 from davidhewitt/fix-vendor

ci: fix sdist vendor test

Author: messense

.github/workflows/ci.yml

@@ -34,9 +34,9 @@ jobs:
         with:
           python-version: "3.x"
 
-      - run: pip install tox
+      - run: pip install nox
 
-      - run: tox -e mypy
+      - run: nox -s mypy
 
   pytest:
     runs-on: "ubuntu-latest"
@@ -48,9 +48,9 @@ jobs:
         with:
           python-version: "3.x"
 
-      - run: pip install tox
+      - run: pip install nox
 
-      - run: tox -e pytest
+      - run: nox -s test
 
   build:
     name:  ${{ matrix.python-version }} ${{ matrix.platform.os }}-${{ matrix.platform.python-architecture }}
@@ -127,13 +127,9 @@ jobs:
 
       - name: Test sdist vendor Rust crates
         shell: bash
-        run: |
-          cd examples/namespace_package
-          python setup.py sdist --vendor-crates
-          cd dist
-          tar -zxf namespace_package-0.1.0.tar.gz
-          cd namespace_package-0.1.0
-          cargo build --offline --target ${{ matrix.platform.rust-target }}
+        run: nox -s test-sdist-vendor
+        env:
+          CARGO_BUILD_TARGET: ${{ matrix.platform.rust-target }}
 
   test-abi3:
     runs-on: ${{ matrix.os }}

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## Unreleased
+
+### Fixed
+- Fix building sdist with vendored dependencies on Windows. [#223](https://github.com/PyO3/setuptools-rust/pull/223)
+
 ## 1.2.0 (2022-03-22)
 ### Packaging
 - Drop support for Python 3.6. [#209](https://github.com/PyO3/setuptools-rust/pull/209)

examples/namespace_package/src/lib.rs

@@ -8,7 +8,7 @@ fn rust_func() -> usize {
 
 /// A Python module implemented in Rust.
 #[pymodule]
-fn rust(py: Python, m: &PyModule) -> PyResult<()> {
+fn rust(_py: Python, m: &PyModule) -> PyResult<()> {
     m.add_wrapped(wrap_pyfunction!(rust_func))?;
 
     Ok(())

noxfile.py

@@ -1,4 +1,7 @@
+import os
+import tarfile
 from glob import glob
+from pathlib import Path
 
 import nox
 
@@ -7,3 +10,28 @@
 def test_examples(session: nox.Session):
     for example in glob("examples/*/noxfile.py"):
         session.run("nox", "-f", example, external=True)
+
+
+@nox.session(name="test-sdist-vendor")
+def test_sdist_vendor(session: nox.Session):
+    session.install(".")
+    namespace_package = Path(__file__).parent / "examples" / "namespace_package"
+    os.chdir(namespace_package)
+    session.run("python", "setup.py", "sdist", "--vendor-crates", external=True)
+    dist = namespace_package / "dist"
+    with tarfile.open(str(dist / "namespace_package-0.1.0.tar.gz")) as tf:
+        tf.extractall(str(dist))
+    os.chdir(dist / "namespace_package-0.1.0")
+    session.run("cargo", "build", "--offline", external=True)
+
+
+@nox.session()
+def mypy(session: nox.Session):
+    session.install("mypy", "fat_macho", "types-setuptools", ".")
+    session.run("mypy", "setuptools_rust", *session.posargs)
+
+
+@nox.session()
+def test(session: nox.Session):
+    session.install("pytest", ".")
+    session.run("pytest", "setuptools_rust", *session.posargs)

setuptools_rust/setuptools_ext.py

@@ -3,6 +3,7 @@
 import sys
 from distutils import log
 from distutils.command.clean import clean
+from pathlib import Path
 from typing import List, Tuple, Type, cast
 
 from setuptools.command.build_ext import build_ext
@@ -68,18 +69,9 @@ def make_distribution(self) -> None:
                     # set --manifest-path before vendor_path and after --sync to workaround that
                     # See https://docs.rs/clap/latest/clap/struct.Arg.html#method.multiple for detail
                     command.extend(["--manifest-path", manifest_paths[0], vendor_path])
-                    cargo_config = subprocess.check_output(command)
-                    base_dir_bytes = (
-                        base_dir.encode(sys.getfilesystemencoding()) + os.sep.encode()
-                    )
-                    if os.sep == "\\":
-                        # TOML escapes backslash \
-                        base_dir_bytes += os.sep.encode()
-                    cargo_config = cargo_config.replace(base_dir_bytes, b"")
-                    if os.altsep:
-                        cargo_config = cargo_config.replace(
-                            base_dir_bytes + os.altsep.encode(), b""
-                        )
+                    subprocess.run(command, check=True)
+
+                    cargo_config = _CARGO_VENDOR_CONFIG
 
                     # Check whether `.cargo/config`/`.cargo/config.toml` already exists
                     existing_cargo_config = None
@@ -90,18 +82,18 @@ def make_distribution(self) -> None:
                         if filename in self.filelist.files:
                             existing_cargo_config = filename
                             break
+
                     if existing_cargo_config:
                         cargo_config_path = os.path.join(
                             base_dir, existing_cargo_config
                         )
                         # Append vendor config to original cargo config
                         with open(existing_cargo_config, "rb") as f:
-                            cargo_config = f.read() + b"\n" + cargo_config
+                            cargo_config += f.read() + b"\n"
 
                     with open(cargo_config_path, "wb") as f:
                         f.write(cargo_config)
-                    self.filelist.append(vendor_path)
-                    self.filelist.append(cargo_config_path)
+
             super().make_distribution()
 
     dist.cmdclass["sdist"] = sdist_rust_extension
@@ -287,3 +279,12 @@ def rust_extensions(
     if has_rust_extensions:
         patch_distutils_build()
         add_rust_extension(dist)
+
+
+_CARGO_VENDOR_CONFIG = b"""
+[source.crates-io]
+replace-with = "vendored-sources"
+
+[source.vendored-sources]
+directory = ".cargo/vendor"
+"""