Skip to content
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

Warn if [python-repos] is set during lockfile generation #12800

Merged
merged 3 commits into from
Sep 9, 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
20 changes: 20 additions & 0 deletions src/python/pants/backend/python/goals/lockfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
from pants.engine.rules import Get, MultiGet, collect_rules, goal_rule, rule
from pants.engine.target import TransitiveTargets, TransitiveTargetsRequest, UnexpandedTargets
from pants.engine.unions import UnionMembership, union
from pants.python.python_repos import PythonRepos
from pants.python.python_setup import PythonSetup
from pants.util.logging import LogLevel
from pants.util.ordered_set import FrozenOrderedSet
Expand Down Expand Up @@ -327,7 +328,13 @@ async def generate_lockfiles_goal(
union_membership: UnionMembership,
generate_lockfiles_subsystem: GenerateLockfilesSubsystem,
python_setup: PythonSetup,
python_repos: PythonRepos,
) -> GenerateLockfilesGoal:
if python_repos.repos:
warn_python_repos("repos")
if python_repos.indexes != [python_repos.pypi_index]:
warn_python_repos("indexes")

specified_user_resolves, specified_tool_sentinels = determine_resolves_to_generate(
python_setup.resolves_to_lockfiles.keys(),
union_membership[PythonToolLockfileSentinel],
Expand Down Expand Up @@ -359,6 +366,19 @@ async def generate_lockfiles_goal(
return GenerateLockfilesGoal(exit_code=0)


def warn_python_repos(option: str) -> None:
logger.warning(
f"The option `[python-repos].{option}` is configured, but it does not currently work "
"with lockfile generation. Lockfile generation will fail if the relevant requirements "
"cannot be located on PyPI.\n\n"
"If lockfile generation fails, you can disable lockfiles by setting "
"`[tool].lockfile = '<none>'`, e.g. setting `[black].lockfile`. You can also manually "
"generate a lockfile, such as by using pip-compile or `pip freeze`. Set the "
"`[tool].lockfile` option to the path you manually generated. When manually maintaining "
"lockfiles, set `[python-setup].invalid_lockfile_behavior = 'ignore'."
)


class AmbiguousResolveNamesError(Exception):
def __init__(self, ambiguous_names: list[str]) -> None:
if len(ambiguous_names) == 1:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,11 @@ def register_options(cls, register):
"To use a custom lockfile, set this option to a file path relative to the "
f"build root, then run `./pants generate-lockfiles "
f"--resolve={cls.options_scope}`.\n\n"
""
"Lockfile generation currently does not wire up the `[python-repos]` options. "
"If lockfile generation fails, you can manually generate a lockfile, such as "
"by using pip-compile or `pip freeze`. Set this option to the path to your "
"manually generated lockfile. When manually maintaining lockfiles, set "
"`[python-setup].invalid_lockfile_behavior = 'ignore'`."
),
)

Expand Down
4 changes: 3 additions & 1 deletion src/python/pants/python/python_repos.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ class PythonRepos(Subsystem):
"custom cheeseshops when resolving requirements."
)

pypi_index = "https://pypi.org/simple/"

@classmethod
def register_options(cls, register):
super().register_options(register)
Expand All @@ -30,7 +32,7 @@ def register_options(cls, register):
"--indexes",
advanced=True,
type=list,
default=["https://pypi.org/simple/"],
default=[cls.pypi_index],
help=(
"URLs of code repository indexes to look for requirements. If set to an empty "
"list, then Pex will use no indices (meaning it will not use PyPI). The values "
Expand Down