Merge pull request #277 from messense/simplify-install_rust_extension

Simplify `install_rust_extension` and `bdist_wheel_rust_extension`

Author: messense

examples/hello-world-script/Cargo.lock

@@ -0,0 +1,12 @@
+[package]
+name = "hello-world-script"
+version = "0.1.0"
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+
+[profile.release-lto]
+inherits = "release"
+lto = true

examples/hello-world-script/Cargo.toml

@@ -0,0 +1,2 @@
+include Cargo.toml
+recursive-include src *

examples/hello-world-script/MANIFEST.in

@@ -0,0 +1,21 @@
+from os.path import dirname
+
+import nox
+
+SETUPTOOLS_RUST = dirname(dirname(dirname(__file__)))
+
+
+@nox.session()
+def test(session: nox.Session):
+    session.install(SETUPTOOLS_RUST)
+    session.install("--no-build-isolation", ".")
+    session.run("hello-world-script", *session.posargs)
+
+
+@nox.session()
+def setuptools_install(session: nox.Session):
+    session.install("setuptools")
+    with session.chdir(SETUPTOOLS_RUST):
+        session.run("python", "setup.py", "install")
+    session.run("python", "setup.py", "install")
+    session.run("hello-world-script", *session.posargs)

examples/hello-world-script/hello_world/__init__.py

@@ -0,0 +1,2 @@
+[build-system]
+requires = ["setuptools", "wheel", "setuptools-rust"]

examples/hello-world-script/noxfile.py

@@ -0,0 +1,18 @@
+from setuptools import setup
+
+from setuptools_rust import RustExtension, Binding
+
+setup(
+    name="hello-world-script",
+    version="1.0",
+    rust_extensions=[
+        RustExtension(
+            {"hello-world-script": "hello_world.hello-world-script"},
+            binding=Binding.Exec,
+            script=True,
+            args=["--profile", "release-lto"],
+        )
+    ],
+    # rust extensions are not zip safe, just like C-extensions.
+    zip_safe=False,
+)

examples/hello-world-script/pyproject.toml

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}

examples/hello-world-script/pytest.ini

@@ -39,6 +39,25 @@ def add_rust_extension(dist: Distribution) -> None:
     sdist_boolean_options.append("vendor-crates")
     sdist_negative_opt["no-vendor-crates"] = "vendor-crates"
 
+    # Patch dist to include console_scripts for Exec binding
+    console_scripts = []
+    for ext in dist.rust_extensions:  # type: ignore[attr-defined]
+        console_scripts.extend(ext.entry_points())
+
+    if console_scripts:
+        if not dist.entry_points:  # type: ignore[attr-defined]
+            dist.entry_points = {"console_scripts": console_scripts}  # type: ignore[attr-defined]
+        else:
+            ep_scripts = dist.entry_points.get("console_scripts")  # type: ignore[attr-defined]
+            if ep_scripts:
+                for script in console_scripts:
+                    if script not in ep_scripts:
+                        ep_scripts.append(console_scripts)
+            else:
+                ep_scripts = console_scripts
+
+            dist.entry_points["console_scripts"] = ep_scripts  # type: ignore[attr-defined]
+
     class sdist_rust_extension(sdist_base_class):  # type: ignore[misc,valid-type]
         user_options = sdist_options
         boolean_options = sdist_boolean_options
@@ -152,53 +171,16 @@ def run(self) -> None:
 
     install_base_class = cast(Type[install], dist.cmdclass.get("install", install))
 
-    # this is required because, install directly access distribution's
-    # ext_modules attr to check if dist has ext modules
+    # this is required to make install_scripts compatible with RustBin
     class install_rust_extension(install_base_class):  # type: ignore[misc,valid-type]
-        def finalize_options(self) -> None:
-            ext_modules = self.distribution.ext_modules
-
-            # all ext modules
-            mods = []
-            if self.distribution.ext_modules:
-                mods.extend(self.distribution.ext_modules)
-            if self.distribution.rust_extensions:
-                mods.extend(self.distribution.rust_extensions)
-
-                scripts = []
-                for ext in self.distribution.rust_extensions:
-                    scripts.extend(ext.entry_points())
-
-                if scripts:
-                    if not self.distribution.entry_points:
-                        self.distribution.entry_points = {"console_scripts": scripts}
-                    else:
-                        ep_scripts = self.distribution.entry_points.get(
-                            "console_scripts"
-                        )
-                        if ep_scripts:
-                            for script in scripts:
-                                if script not in ep_scripts:
-                                    ep_scripts.append(scripts)
-                        else:
-                            ep_scripts = scripts
-
-                        self.distribution.entry_points["console_scripts"] = ep_scripts
-
-            self.distribution.ext_modules = mods
-
-            install_base_class.finalize_options(self)
-
-            # restore ext_modules
-            self.distribution.ext_modules = ext_modules
-
         def run(self) -> None:
             install_base_class.run(self)
             install_rustbin = False
             if self.distribution.rust_extensions:
-                for ext in self.distribution.rust_extensions:
-                    if isinstance(ext, RustBin):
-                        install_rustbin = True
+                install_rustbin = any(
+                    isinstance(ext, RustBin)
+                    for ext in self.distribution.rust_extensions
+                )
             if install_rustbin:
                 self.run_command("install_scripts")
 
@@ -265,29 +247,6 @@ def initialize_options(self) -> None:
                 super().initialize_options()
                 self.target = os.getenv("CARGO_BUILD_TARGET")
 
-            def finalize_options(self) -> None:
-                scripts = []
-                for ext in self.distribution.rust_extensions:
-                    scripts.extend(ext.entry_points())
-
-                if scripts:
-                    if not self.distribution.entry_points:
-                        self.distribution.entry_points = {"console_scripts": scripts}
-                    else:
-                        ep_scripts = self.distribution.entry_points.get(
-                            "console_scripts"
-                        )
-                        if ep_scripts:
-                            for script in scripts:
-                                if script not in ep_scripts:
-                                    ep_scripts.append(scripts)
-                        else:
-                            ep_scripts = scripts
-
-                        self.distribution.entry_points["console_scripts"] = ep_scripts
-
-                bdist_wheel_base_class.finalize_options(self)
-
             def get_tag(self) -> Tuple[str, str, str]:
                 python, abi, plat = super().get_tag()
                 arch_flags = os.getenv("ARCHFLAGS")