Skip to content

Detect an unnamed requirement is user-specified #10084

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions news/9204.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
New resolver: Detect an unnamed requirement is user-specified (by building its
metadata for the project name) so it can be correctly ordered in the resolver.
46 changes: 43 additions & 3 deletions src/pip/_internal/resolution/resolvelib/factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
Iterator,
List,
Mapping,
NamedTuple,
Optional,
Sequence,
Set,
Expand Down Expand Up @@ -38,7 +39,10 @@
from pip._internal.models.wheel import Wheel
from pip._internal.operations.prepare import RequirementPreparer
from pip._internal.req.constructors import install_req_from_link_and_ireq
from pip._internal.req.req_install import InstallRequirement
from pip._internal.req.req_install import (
InstallRequirement,
check_invalid_constraint_type,
)
from pip._internal.resolution.base import InstallRequirementProvider
from pip._internal.utils.compatibility_tags import get_supported
from pip._internal.utils.hashes import Hashes
Expand Down Expand Up @@ -81,6 +85,12 @@ class ConflictCause(Protocol):
Cache = Dict[Link, C]


class CollectedRootRequirements(NamedTuple):
requirements: List[Requirement]
constraints: Dict[str, Constraint]
user_requested: Dict[str, int]


class Factory:
def __init__(
self,
Expand Down Expand Up @@ -408,7 +418,7 @@ def find_candidates(
and all(req.is_satisfied_by(c) for req in requirements[identifier])
)

def make_requirement_from_install_req(
def _make_requirement_from_install_req(
self, ireq: InstallRequirement, requested_extras: Iterable[str]
) -> Optional[Requirement]:
if not ireq.match_markers(requested_extras):
Expand Down Expand Up @@ -440,6 +450,36 @@ def make_requirement_from_install_req(
return UnsatisfiableRequirement(canonicalize_name(ireq.name))
return self.make_requirement_from_candidate(cand)

def collect_root_requirements(
self, root_ireqs: List[InstallRequirement]
) -> CollectedRootRequirements:
collected = CollectedRootRequirements([], {}, {})
for i, ireq in enumerate(root_ireqs):
if ireq.constraint:
# Ensure we only accept valid constraints
problem = check_invalid_constraint_type(ireq)
if problem:
raise InstallationError(problem)
if not ireq.match_markers():
continue
assert ireq.name, "Constraint must be named"
name = canonicalize_name(ireq.name)
if name in collected.constraints:
collected.constraints[name] &= ireq
else:
collected.constraints[name] = Constraint.from_ireq(ireq)
else:
req = self._make_requirement_from_install_req(
ireq,
requested_extras=(),
)
if req is None:
continue
if ireq.user_supplied and req.name not in collected.user_requested:
collected.user_requested[req.name] = i
collected.requirements.append(req)
return collected

def make_requirement_from_candidate(
self, candidate: Candidate
) -> ExplicitRequirement:
Expand All @@ -452,7 +492,7 @@ def make_requirement_from_spec(
requested_extras: Iterable[str] = (),
) -> Optional[Requirement]:
ireq = self._make_install_req_from_spec(specifier, comes_from)
return self.make_requirement_from_install_req(ireq, requested_extras)
return self._make_requirement_from_install_req(ireq, requested_extras)

def make_requires_python_requirement(
self, specifier: Optional[SpecifierSet]
Expand Down
46 changes: 7 additions & 39 deletions src/pip/_internal/resolution/resolvelib/resolver.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,9 @@
from pip._vendor.resolvelib.structs import DirectedGraph

from pip._internal.cache import WheelCache
from pip._internal.exceptions import InstallationError
from pip._internal.index.package_finder import PackageFinder
from pip._internal.operations.prepare import RequirementPreparer
from pip._internal.req.req_install import (
InstallRequirement,
check_invalid_constraint_type,
)
from pip._internal.req.req_install import InstallRequirement
from pip._internal.req.req_set import RequirementSet
from pip._internal.resolution.base import BaseResolver, InstallRequirementProvider
from pip._internal.resolution.resolvelib.provider import PipProvider
Expand All @@ -28,7 +24,7 @@
from pip._internal.utils.filetypes import is_archive_file
from pip._internal.utils.misc import dist_is_editable

from .base import Candidate, Constraint, Requirement
from .base import Candidate, Requirement
from .factory import Factory

if TYPE_CHECKING:
Expand Down Expand Up @@ -78,41 +74,13 @@ def __init__(
def resolve(
self, root_reqs: List[InstallRequirement], check_supported_wheels: bool
) -> RequirementSet:

constraints: Dict[str, Constraint] = {}
user_requested: Dict[str, int] = {}
requirements = []
for i, req in enumerate(root_reqs):
if req.constraint:
# Ensure we only accept valid constraints
problem = check_invalid_constraint_type(req)
if problem:
raise InstallationError(problem)
if not req.match_markers():
continue
assert req.name, "Constraint must be named"
name = canonicalize_name(req.name)
if name in constraints:
constraints[name] &= req
else:
constraints[name] = Constraint.from_ireq(req)
else:
if req.user_supplied and req.name:
canonical_name = canonicalize_name(req.name)
if canonical_name not in user_requested:
user_requested[canonical_name] = i
r = self.factory.make_requirement_from_install_req(
req, requested_extras=()
)
if r is not None:
requirements.append(r)

collected = self.factory.collect_root_requirements(root_reqs)
provider = PipProvider(
factory=self.factory,
constraints=constraints,
constraints=collected.constraints,
ignore_dependencies=self.ignore_dependencies,
upgrade_strategy=self.upgrade_strategy,
user_requested=user_requested,
user_requested=collected.user_requested,
)
if "PIP_RESOLVER_DEBUG" in os.environ:
reporter: BaseReporter = PipDebuggingReporter()
Expand All @@ -126,13 +94,13 @@ def resolve(
try:
try_to_avoid_resolution_too_deep = 2000000
result = self._result = resolver.resolve(
requirements, max_rounds=try_to_avoid_resolution_too_deep
collected.requirements, max_rounds=try_to_avoid_resolution_too_deep
)

except ResolutionImpossible as e:
error = self.factory.get_installation_error(
cast("ResolutionImpossible[Requirement, Candidate]", e),
constraints,
collected.constraints,
)
raise error from e

Expand Down
29 changes: 29 additions & 0 deletions tests/functional/test_new_resolver.py
Original file line number Diff line number Diff line change
Expand Up @@ -1843,3 +1843,32 @@ def test_new_resolver_modifies_installed_incompatible(script):
"d==1",
)
assert_installed(script, d="1", c="2", b="2", a="2")


def test_new_resolver_transitively_depends_on_unnamed_local(script):
create_basic_wheel_for_package(script, name="certbot-docs", version="1")
certbot = create_test_package_with_setup(
script,
name="certbot",
version="99.99.0.dev0",
extras_require={"docs": ["certbot-docs"]}
)
certbot_apache = create_test_package_with_setup(
script,
name="certbot-apache",
version="99.99.0.dev0",
install_requires=["certbot>=99.99.0.dev0"],
)

script.pip(
"install",
"--no-cache-dir", "--no-index",
"--find-links", script.scratch_path,
f"{certbot}[docs]", certbot_apache,
)
assert_installed(
script,
certbot="99.99.0.dev0",
certbot_apache="99.99.0.dev0",
certbot_docs="1",
)