Merge pull request #11117 from q0w/opt-check

Opt to check build dependencies

Author: pradyunsg

news/11116.bugfix.rst

@@ -0,0 +1 @@
+Change the build environment dependency checking to be opt-in.

src/pip/_internal/cli/cmdoptions.py

@@ -749,6 +749,15 @@ def _handle_no_cache_dir(
     "if this option is used.",
 )
 
+check_build_deps: Callable[..., Option] = partial(
+    Option,
+    "--check-build-dependencies",
+    dest="check_build_deps",
+    action="store_true",
+    default=False,
+    help="Check the build dependencies when PEP517 is used.",
+)
+
 
 def _handle_no_use_pep517(
     option: Option, opt: str, value: str, parser: OptionParser

src/pip/_internal/cli/req_command.py

@@ -293,6 +293,7 @@ def make_requirement_preparer(
             src_dir=options.src_dir,
             download_dir=download_dir,
             build_isolation=options.build_isolation,
+            check_build_deps=options.check_build_deps,
             build_tracker=build_tracker,
             session=session,
             progress_bar=options.progress_bar,

src/pip/_internal/commands/download.py

@@ -49,6 +49,7 @@ def add_options(self) -> None:
         self.cmd_opts.add_option(cmdoptions.no_build_isolation())
         self.cmd_opts.add_option(cmdoptions.use_pep517())
         self.cmd_opts.add_option(cmdoptions.no_use_pep517())
+        self.cmd_opts.add_option(cmdoptions.check_build_deps())
         self.cmd_opts.add_option(cmdoptions.ignore_requires_python())
 
         self.cmd_opts.add_option(

src/pip/_internal/commands/install.py

@@ -189,6 +189,7 @@ def add_options(self) -> None:
         self.cmd_opts.add_option(cmdoptions.no_build_isolation())
         self.cmd_opts.add_option(cmdoptions.use_pep517())
         self.cmd_opts.add_option(cmdoptions.no_use_pep517())
+        self.cmd_opts.add_option(cmdoptions.check_build_deps())
 
         self.cmd_opts.add_option(cmdoptions.config_settings())
         self.cmd_opts.add_option(cmdoptions.install_options())

src/pip/_internal/commands/wheel.py

@@ -57,6 +57,7 @@ def add_options(self) -> None:
         self.cmd_opts.add_option(cmdoptions.no_build_isolation())
         self.cmd_opts.add_option(cmdoptions.use_pep517())
         self.cmd_opts.add_option(cmdoptions.no_use_pep517())
+        self.cmd_opts.add_option(cmdoptions.check_build_deps())
         self.cmd_opts.add_option(cmdoptions.constraints())
         self.cmd_opts.add_option(cmdoptions.editable())
         self.cmd_opts.add_option(cmdoptions.requirements())

src/pip/_internal/distributions/base.py

@@ -31,6 +31,9 @@ def get_metadata_distribution(self) -> BaseDistribution:
 
     @abc.abstractmethod
     def prepare_distribution_metadata(
-        self, finder: PackageFinder, build_isolation: bool
+        self,
+        finder: PackageFinder,
+        build_isolation: bool,
+        check_build_deps: bool,
     ) -> None:
         raise NotImplementedError()

src/pip/_internal/distributions/installed.py

@@ -15,6 +15,9 @@ def get_metadata_distribution(self) -> BaseDistribution:
         return self.req.satisfied_by
 
     def prepare_distribution_metadata(
-        self, finder: PackageFinder, build_isolation: bool
+        self,
+        finder: PackageFinder,
+        build_isolation: bool,
+        check_build_deps: bool,
     ) -> None:
         pass

src/pip/_internal/distributions/sdist.py

@@ -22,7 +22,10 @@ def get_metadata_distribution(self) -> BaseDistribution:
         return self.req.get_dist()
 
     def prepare_distribution_metadata(
-        self, finder: PackageFinder, build_isolation: bool
+        self,
+        finder: PackageFinder,
+        build_isolation: bool,
+        check_build_deps: bool,
     ) -> None:
         # Load pyproject.toml, to determine whether PEP 517 is to be used
         self.req.load_pyproject_toml()
@@ -43,7 +46,9 @@ def prepare_distribution_metadata(
             self.req.isolated_editable_sanity_check()
             # Install the dynamic build requirements.
             self._install_build_reqs(finder)
-        elif self.req.use_pep517:
+        # Check if the current environment provides build dependencies
+        should_check_deps = self.req.use_pep517 and check_build_deps
+        if should_check_deps:
             pyproject_requires = self.req.pyproject_requires
             assert pyproject_requires is not None
             conflicting, missing = self.req.build_env.check_requirements(

src/pip/_internal/distributions/wheel.py

@@ -26,6 +26,9 @@ def get_metadata_distribution(self) -> BaseDistribution:
         return get_wheel_distribution(wheel, canonicalize_name(self.req.name))
 
     def prepare_distribution_metadata(
-        self, finder: PackageFinder, build_isolation: bool
+        self,
+        finder: PackageFinder,
+        build_isolation: bool,
+        check_build_deps: bool,
     ) -> None:
         pass