Support installing requirements from inline script metadata (PEP 723) #13052
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This also lays the groundwork for potentially allowing the argument to be given multiple times, but I don't yet want to think about the additional complexity of multiple possibly-contradictory `requires-python` specifiers.
SnoopJ
commented
Oct 28, 2024
Comment on lines
+280
to
+304
| if options.scripts: | ||
| if len(options.scripts) > 1: | ||
| raise CommandError("--script can only be given once") | ||
|
|
||
| script = options.scripts[0] | ||
| script_metadata = pep723_metadata(script) | ||
|
|
||
| script_requires_python = script_metadata.get("requires-python", "") | ||
|
|
||
| if script_requires_python and not options.ignore_requires_python: | ||
| target_python = make_target_python(options) | ||
|
|
||
| if not check_requires_python( | ||
| requires_python=script_requires_python, | ||
| version_info=target_python.py_version_info, | ||
| ): | ||
| raise UnsupportedPythonVersion( | ||
| f"Script {script!r} requires a different Python: " | ||
| f"{target_python.py_version} not in {script_requires_python!r}" | ||
| ) | ||
|
|
||
| for req in script_metadata.get("dependencies", []): | ||
| requirements.append( | ||
| InstallRequirement(Requirement(req), comes_from=None) | ||
| ) |
There was a problem hiding this comment.
It feels ungraceful to put all of this logic here but I'm not really sure how I would plumb it into a separate function. Suggestions welcome
SnoopJ
commented
Oct 28, 2024
Comment on lines
+301
to
+302
| for req in script_metadata.get("dependencies", []): | ||
| requirements.append( |
There was a problem hiding this comment.
ruff is upset that I wrote a loop with .append() here (PERF401) but I don't know if a comprehension would really be justified here? I can maybe see the case for requirements.extend(...) but it still seems like it'd be harder to read to me. Looking for feedback.
Edit: here's a diff of the extend() version that passes the new tests:
diff --git a/src/pip/_internal/cli/req_command.py b/src/pip/_internal/cli/req_command.py
index 294dc9f40..1f972eba4 100644
--- a/src/pip/_internal/cli/req_command.py
+++ b/src/pip/_internal/cli/req_command.py
@@ -298,10 +298,10 @@ class RequirementCommand(IndexGroupCommand):
f"{target_python.py_version} not in {script_requires_python!r}"
)
- for req in script_metadata.get("dependencies", []):
- requirements.append(
- InstallRequirement(Requirement(req), comes_from=None)
- )
+ requirements.extend(
+ InstallRequirement(Requirement(req), comes_from=None)
+ for req in script_metadata.get("dependencies", [])
+ )
# If any requirement has hash options, enable hash checking.
if any(req.has_hash_options for req in requirements):
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This changeset adds support for installing requirements declared in a script using inline metadata as defined by PEP 723
I'm sure this still needs changes, but I'm at the point where I'm ready for a maintainer to point out to me how much I've missed 😅
Closes #12891