feat: support cargo --locked flag (#234)

* feat: support cargo --locked flag

* [review] use generic cargo_manifest_args, no build_rust

* [review] add changelog entry

* [review] update set correctly

Author: tommilligan

CHANGELOG.md

@@ -5,6 +5,9 @@
 ### Packaging
 - Increase minimum `setuptools` version to 62.4. [#222](https://github.com/PyO3/setuptools-rust/pull/246)
 
+### Added
+- Add `cargo_manifest_args` to support locked, frozen and offline builds. [#234](https://github.com/PyO3/setuptools-rust/pull/234)
+
 ### Fixed
 - If the sysconfig for `BLDSHARED` has no flags, `setuptools-rust` won't crash anymore. [#241](https://github.com/PyO3/setuptools-rust/pull/241)
 

setuptools_rust/build.py

@@ -505,6 +505,9 @@ def _cargo_args(
         if ext.args is not None:
             args.extend(ext.args)
 
+        if ext.cargo_manifest_args is not None:
+            args.extend(ext.cargo_manifest_args)
+
         return args
 
 

setuptools_rust/clean.py

@@ -17,6 +17,8 @@ def initialize_options(self) -> None:
     def run_for_extension(self, ext: RustExtension) -> None:
         # build cargo command
         args = ["cargo", "clean", "--manifest-path", ext.path]
+        if ext.cargo_manifest_args:
+            args.extend(ext.cargo_manifest_args)
 
         if not ext.quiet:
             print(" ".join(args), file=sys.stderr)

setuptools_rust/extension.py

@@ -68,6 +68,12 @@ class RustExtension:
         args: A list of extra arguments to be passed to Cargo. For example,
             ``args=["--no-default-features"]`` will disable the default
             features listed in ``Cargo.toml``.
+        cargo_manifest_args: A list of extra arguments to be passed to Cargo.
+            These arguments will be passed to every ``cargo`` command, not just
+            ``cargo build``. For valid options, see
+            `the Cargo Book <https://doc.rust-lang.org/cargo/commands/cargo-build.html#manifest-options>`_.
+            For example, ``cargo_manifest_args=["--locked"]`` will require
+            ``Cargo.lock`` files are up to date.
         features: A list of Cargo features to also build.
         rustc_flags: A list of additional flags passed to rustc.
         rust_version: Minimum Rust compiler version required for this
@@ -109,6 +115,7 @@ def __init__(
         target: Union[str, Dict[str, str]],
         path: str = "Cargo.toml",
         args: Optional[List[str]] = None,
+        cargo_manifest_args: Optional[List[str]] = None,
         features: Optional[List[str]] = None,
         rustc_flags: Optional[List[str]] = None,
         rust_version: Optional[str] = None,
@@ -130,6 +137,7 @@ def __init__(
         self.name = name
         self.target = target
         self.args = args
+        self.cargo_manifest_args = cargo_manifest_args
         self.rustc_flags = rustc_flags
         self.binding = binding
         self.rust_version = rust_version
@@ -223,6 +231,8 @@ def _metadata(self) -> "_CargoMetadata":
                 "--format-version",
                 "1",
             ]
+            if self.cargo_manifest_args:
+                metadata_command.extend(self.cargo_manifest_args)
             self._cargo_metadata = json.loads(subprocess.check_output(metadata_command))
         return self._cargo_metadata
 

setuptools_rust/setuptools_ext.py

@@ -2,7 +2,7 @@
 import subprocess
 from distutils import log
 from distutils.command.clean import clean
-from typing import List, Tuple, Type, cast
+from typing import List, Set, Tuple, Type, cast
 
 from setuptools.command.build_ext import build_ext
 from setuptools.command.install import install
@@ -48,15 +48,27 @@ def initialize_options(self) -> None:
         def make_distribution(self) -> None:
             if self.vendor_crates:
                 manifest_paths = []
+
+                # Collate cargo manifest options together.
+                # We can cheat here, as the only valid options are the simple strings
+                # --frozen, --locked, or --offline.
+                #
+                # https://doc.rust-lang.org/cargo/commands/cargo-build.html#manifest-options
+                cargo_manifest_args: Set[str] = set()
                 for ext in self.distribution.rust_extensions:
                     manifest_paths.append(ext.path)
+                    if ext.cargo_manifest_args:
+                        cargo_manifest_args.update(ext.cargo_manifest_args)
+
                 if manifest_paths:
                     base_dir = self.distribution.get_fullname()
                     dot_cargo_path = os.path.join(base_dir, ".cargo")
                     self.mkpath(dot_cargo_path)
                     cargo_config_path = os.path.join(dot_cargo_path, "config.toml")
                     vendor_path = os.path.join(dot_cargo_path, "vendor")
                     command = ["cargo", "vendor"]
+                    if cargo_manifest_args:
+                        command.extend(sorted(cargo_manifest_args))
                     # additional Cargo.toml for extension 1..n
                     for extra_path in manifest_paths[1:]:
                         command.append("--sync")