| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687 |
- """A single place for constructing and exposing the main parser
- """
- import os
- import sys
- from typing import List, Tuple
- from pip._internal.cli import cmdoptions
- from pip._internal.cli.parser import ConfigOptionParser, UpdatingDefaultsHelpFormatter
- from pip._internal.commands import commands_dict, get_similar_commands
- from pip._internal.exceptions import CommandError
- from pip._internal.utils.misc import get_pip_version, get_prog
- __all__ = ["create_main_parser", "parse_command"]
- def create_main_parser() -> ConfigOptionParser:
- """Creates and returns the main parser for pip's CLI"""
- parser = ConfigOptionParser(
- usage="\n%prog <command> [options]",
- add_help_option=False,
- formatter=UpdatingDefaultsHelpFormatter(),
- name="global",
- prog=get_prog(),
- )
- parser.disable_interspersed_args()
- parser.version = get_pip_version()
- # add the general options
- gen_opts = cmdoptions.make_option_group(cmdoptions.general_group, parser)
- parser.add_option_group(gen_opts)
- # so the help formatter knows
- parser.main = True # type: ignore
- # create command listing for description
- description = [""] + [
- f"{name:27} {command_info.summary}"
- for name, command_info in commands_dict.items()
- ]
- parser.description = "\n".join(description)
- return parser
- def parse_command(args: List[str]) -> Tuple[str, List[str]]:
- parser = create_main_parser()
- # Note: parser calls disable_interspersed_args(), so the result of this
- # call is to split the initial args into the general options before the
- # subcommand and everything else.
- # For example:
- # args: ['--timeout=5', 'install', '--user', 'INITools']
- # general_options: ['--timeout==5']
- # args_else: ['install', '--user', 'INITools']
- general_options, args_else = parser.parse_args(args)
- # --version
- if general_options.version:
- sys.stdout.write(parser.version)
- sys.stdout.write(os.linesep)
- sys.exit()
- # pip || pip help -> print_help()
- if not args_else or (args_else[0] == "help" and len(args_else) == 1):
- parser.print_help()
- sys.exit()
- # the subcommand name
- cmd_name = args_else[0]
- if cmd_name not in commands_dict:
- guess = get_similar_commands(cmd_name)
- msg = [f'unknown command "{cmd_name}"']
- if guess:
- msg.append(f'maybe you meant "{guess}"')
- raise CommandError(" - ".join(msg))
- # all the args without the subcommand
- cmd_args = args[:]
- cmd_args.remove(cmd_name)
- return cmd_name, cmd_args
|
