Skip to content

Commit

Permalink
Deprecate the version/extra_requirements options on python tools. (pa…
Browse files Browse the repository at this point in the history
…ntsbuild#19204)

It wasn't clear if they would need to stick around after 
removing the tool lockfile functionality, but it's now clear
that they have no use in that post-tool-lockfile world.
  • Loading branch information
benjyw authored May 31, 2023
1 parent 71c6fe6 commit 4c3c574
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/python/pants/backend/python/subsystems/python_tool_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,25 @@ class PythonToolRequirementsBase(Subsystem):
version = StrOption(
advanced=True,
default=lambda cls: cls.default_version,
removal_version="2.18.0.dev1",
removal_hint=lambda cls: softwrap(
f"""\
Custom tool versions are now installed from named resolves, as
described at {doc_url("python-lockfiles")}.
"""
),
help="Requirement string for the tool.",
)
extra_requirements = StrListOption(
advanced=True,
default=lambda cls: cls.default_extra_requirements,
removal_version="2.18.0.dev1",
removal_hint=lambda cls: softwrap(
f"""\
Custom tool versions are now installed from named resolves, as
described at {doc_url("python-lockfiles")}.
"""
),
help="Any additional requirement strings to use with the tool. This is useful if the "
"tool allows you to install plugins or if you need to constrain a dependency to "
"a certain version.",
Expand Down

0 comments on commit 4c3c574

Please sign in to comment.