Change --script to --requirements-from-script

Author: SnoopJ

src/pip/_internal/cli/cmdoptions.py

@@ -443,17 +443,16 @@ def requirements() -> Option:
     )
 
 
-# NOTE:2024-10-05:snoopj:it's simplest to allow exactly one file for a first pass
-# https://github.com/pypa/pip/issues/12891
-def scripts() -> Option:
+def requirements_from_scripts() -> Option:
     return Option(
         "-s",
-        "--script",
+        "--requirements-from-script",
         action="append",
         default=[],
-        dest="scripts",
+        dest="requirements_from_scripts",
         metavar="file",
-        help="Install PEP 723 inline dependencies of the given script file. ",
+        help="Install dependencies of the given script file"
+        "as defined by PEP 723 inline metadata. ",
     )
 
 

src/pip/_internal/cli/req_command.py

@@ -12,6 +12,8 @@
 from optparse import Values
 from typing import Any
 
+from pip._vendor.packaging.requirements import Requirement
+
 from pip._internal.build_env import SubprocessBuildEnvironmentInstaller
 from pip._internal.cache import WheelCache
 from pip._internal.cli import cmdoptions
@@ -47,7 +49,6 @@
     TempDirectoryTypeRegistry,
     tempdir_kinds,
 )
-from pip._vendor.packaging.requirements import Requirement
 
 logger = logging.getLogger(__name__)
 
@@ -293,11 +294,11 @@ def get_requirements(
                 )
                 requirements.append(req_to_add)
 
-        if options.scripts:
-            if len(options.scripts) > 1:
-                raise CommandError("--script can only be given once")
+        if options.requirements_from_scripts:
+            if len(options.requirements_from_scripts) > 1:
+                raise CommandError("--requirements-from-script can only be given once")
 
-            script = options.scripts[0]
+            script = options.requirements_from_scripts[0]
             script_metadata = pep723_metadata(script)
 
             script_requires_python = script_metadata.get("requires-python", "")
@@ -315,7 +316,7 @@ def get_requirements(
                     )
 
             for req in script_metadata.get("dependencies", []):
-                requirements.append(
+                requirements.append(  # noqa: PERF401
                     InstallRequirement(Requirement(req), comes_from=None)
                 )
 
@@ -328,7 +329,7 @@ def get_requirements(
             or options.editables
             or options.requirements
             or options.dependency_groups
-            or options.scripts
+            or options.requirements_from_scripts
         ):
             opts = {"name": self.name}
             if options.find_links:

src/pip/_internal/commands/download.py

@@ -37,7 +37,7 @@ class DownloadCommand(RequirementCommand):
     def add_options(self) -> None:
         self.cmd_opts.add_option(cmdoptions.constraints())
         self.cmd_opts.add_option(cmdoptions.requirements())
-        self.cmd_opts.add_option(cmdoptions.scripts())
+        self.cmd_opts.add_option(cmdoptions.requirements_from_scripts())
         self.cmd_opts.add_option(cmdoptions.no_deps())
         self.cmd_opts.add_option(cmdoptions.global_options())
         self.cmd_opts.add_option(cmdoptions.no_binary())

src/pip/_internal/commands/install.py

@@ -87,7 +87,7 @@ class InstallCommand(RequirementCommand):
     def add_options(self) -> None:
         self.cmd_opts.add_option(cmdoptions.requirements())
         self.cmd_opts.add_option(cmdoptions.constraints())
-        self.cmd_opts.add_option(cmdoptions.scripts())
+        self.cmd_opts.add_option(cmdoptions.requirements_from_scripts())
         self.cmd_opts.add_option(cmdoptions.no_deps())
         self.cmd_opts.add_option(cmdoptions.pre())
 

src/pip/_internal/commands/wheel.py

@@ -62,7 +62,7 @@ def add_options(self) -> None:
         self.cmd_opts.add_option(cmdoptions.constraints())
         self.cmd_opts.add_option(cmdoptions.editable())
         self.cmd_opts.add_option(cmdoptions.requirements())
-        self.cmd_opts.add_option(cmdoptions.scripts())
+        self.cmd_opts.add_option(cmdoptions.requirements_from_scripts())
         self.cmd_opts.add_option(cmdoptions.src())
         self.cmd_opts.add_option(cmdoptions.ignore_requires_python())
         self.cmd_opts.add_option(cmdoptions.no_deps())

tests/functional/test_install_script.py

@@ -30,7 +30,7 @@ def test_script_file(script: PipTestEnvironment) -> None:
             """
         )
     )
-    result = script.pip("install", "--script", script_path)
+    result = script.pip("install", "--requirements-from-script", script_path)
 
     # NOTE:2024-10-05:snoopj:assertions same as in test_requirements_file
     result.did_create(script.site_packages / "INITools-0.2.dist-info")