Skip to content

Commit

Permalink
Add --use-deprecated=backtrack-on-build-failures
Browse files Browse the repository at this point in the history
This serves as an opt-out from build failures causing the entire
installation to abort.
  • Loading branch information
pradyunsg committed Dec 12, 2021
1 parent 5494275 commit f35b53e
Show file tree
Hide file tree
Showing 6 changed files with 65 additions and 0 deletions.
26 changes: 26 additions & 0 deletions src/pip/_internal/cli/req_command.py
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,30 @@ def determine_resolver_variant(options: Values) -> str:

return "2020-resolver"

@staticmethod
def determine_build_failure_suppression(options: Values) -> bool:
"""Determines whether build failures should be suppressed and backtracked on."""
if "backtrack-on-build-failures" not in options.deprecated_features_enabled:
return False

if "legacy-resolver" in options.deprecated_features_enabled:
raise CommandError("Cannot backtrack with legacy resolver.")

deprecated(
reason=(
"Backtracking on build failures can mask issues related to how "
"a package generates metadata or builds a wheel."
),
gone_in="22.2",
replacement=(
"avoiding known-bad versions by explicitly telling pip to ignore them "
"(either directly as a requirements, or via a constraints file)."
),
feature_flag=None,
issue=10655,
)
return True

@classmethod
def make_requirement_preparer(
cls,
Expand Down Expand Up @@ -321,6 +345,7 @@ def make_resolver(
isolated=options.isolated_mode,
use_pep517=use_pep517,
)
suppress_build_failures = cls.determine_build_failure_suppression(options)
resolver_variant = cls.determine_resolver_variant(options)
# The long import name and duplicated invocation is needed to convince
# Mypy into correctly typechecking. Otherwise it would complain the
Expand All @@ -340,6 +365,7 @@ def make_resolver(
force_reinstall=force_reinstall,
upgrade_strategy=upgrade_strategy,
py_version_info=py_version_info,
suppress_build_failures=suppress_build_failures,
)
import pip._internal.resolution.legacy.resolver

Expand Down
16 changes: 16 additions & 0 deletions src/pip/_internal/resolution/resolvelib/factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
from pip._internal.exceptions import (
DistributionNotFound,
InstallationError,
InstallationSubprocessError,
MetadataInconsistent,
UnsupportedPythonVersion,
UnsupportedWheel,
Expand Down Expand Up @@ -96,6 +97,7 @@ def __init__(
force_reinstall: bool,
ignore_installed: bool,
ignore_requires_python: bool,
suppress_build_failures: bool,
py_version_info: Optional[Tuple[int, ...]] = None,
) -> None:
self._finder = finder
Expand All @@ -106,6 +108,7 @@ def __init__(
self._use_user_site = use_user_site
self._force_reinstall = force_reinstall
self._ignore_requires_python = ignore_requires_python
self._suppress_build_failures = suppress_build_failures

self._build_failures: Cache[InstallationError] = {}
self._link_candidate_cache: Cache[LinkCandidate] = {}
Expand Down Expand Up @@ -193,6 +196,13 @@ def _make_candidate_from_link(
logger.warning("Discarding %s. %s", link, e)
self._build_failures[link] = e
return None
except InstallationSubprocessError as e:
if not self._suppress_build_failures:
raise
logger.warning("Discarding %s due to build failure: %e", link, e)
self._build_failures[link] = e
return None

base: BaseCandidate = self._editable_candidate_cache[link]
else:
if link not in self._link_candidate_cache:
Expand All @@ -208,6 +218,12 @@ def _make_candidate_from_link(
logger.warning("Discarding %s. %s", link, e)
self._build_failures[link] = e
return None
except InstallationSubprocessError as e:
if not self._suppress_build_failures:
raise
logger.warning("Discarding %s due to build failure: %e", link, e)
self._build_failures[link] = e
return None
base = self._link_candidate_cache[link]

if not extras:
Expand Down
2 changes: 2 additions & 0 deletions src/pip/_internal/resolution/resolvelib/resolver.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ def __init__(
ignore_requires_python: bool,
force_reinstall: bool,
upgrade_strategy: str,
suppress_build_failures: bool,
py_version_info: Optional[Tuple[int, ...]] = None,
):
super().__init__()
Expand All @@ -61,6 +62,7 @@ def __init__(
force_reinstall=force_reinstall,
ignore_installed=ignore_installed,
ignore_requires_python=ignore_requires_python,
suppress_build_failures=suppress_build_failures,
py_version_info=py_version_info,
)
self.ignore_dependencies = ignore_dependencies
Expand Down
19 changes: 19 additions & 0 deletions tests/functional/test_new_resolver.py
Original file line number Diff line number Diff line change
Expand Up @@ -2329,6 +2329,25 @@ def test_new_resolver_do_not_backtrack_on_build_failure(
assert "egg_info" in result.stderr


def test_new_resolver_flag_permits_backtracking_on_build_failure(
script: PipTestEnvironment,
) -> None:
create_basic_sdist_for_package(script, "pkg1", "2.0", fails_egg_info=True)
create_basic_wheel_for_package(script, "pkg1", "1.0")

script.pip(
"install",
"--use-deprecated=backtrack-on-build-failures",
"--no-cache-dir",
"--no-index",
"--find-links",
script.scratch_path,
"pkg1",
)

script.assert_installed(pkg1="1.0")


def test_new_resolver_works_when_failing_package_builds_are_disallowed(
script: PipTestEnvironment,
) -> None:
Expand Down
1 change: 1 addition & 0 deletions tests/unit/resolution_resolvelib/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ def factory(finder: PackageFinder, preparer: RequirementPreparer) -> Iterator[Fa
force_reinstall=False,
ignore_installed=False,
ignore_requires_python=False,
suppress_build_failures=False,
py_version_info=None,
)

Expand Down
1 change: 1 addition & 0 deletions tests/unit/resolution_resolvelib/test_resolver.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ def resolver(preparer: RequirementPreparer, finder: PackageFinder) -> Resolver:
ignore_requires_python=False,
force_reinstall=False,
upgrade_strategy="to-satisfy-only",
suppress_build_failures=False,
)
return resolver

Expand Down

0 comments on commit f35b53e

Please sign in to comment.