UninstallCommand Class Reference

Inheritance diagram for UninstallCommand:

Collaboration diagram for UninstallCommand:

Public Member Functions
None	add_options (self)
int	run (self, Values options, List[str] args)
Public Member Functions inherited from Command
None	__init__ (self, str name, str summary, bool isolated=False)
None	handle_pip_version_check (self, Values options)
Tuple[Values, List[str]]	parse_args (self, List[str] args)
int	main (self, List[str] args)
Public Member Functions inherited from CommandContextMixIn
Generator[None, None, None]	main_context (self)
_T	enter_context (self, ContextManager[_T] context_provider)
Public Member Functions inherited from SessionCommandMixin
None	__init__ (self)
PipSession	get_default_session (self, Values options)

Data Fields
	cmd_opts
Data Fields inherited from Command
	name
	summary
	parser
	cmd_opts
	tempdir_registry
	verbosity

Static Public Attributes
str	usage
Static Public Attributes inherited from Command
str	usage = ""
bool	ignore_require_venv = False

Additional Inherited Members
Protected Member Functions inherited from Command
int	_main (self, List[str] args)
Protected Member Functions inherited from SessionCommandMixin
Optional[List[str]]	_get_index_urls (cls, Values options)
PipSession	_build_session (self, Values options, Optional[int] retries=None, Optional[int] timeout=None, bool fallback_to_certifi=False)
Protected Attributes inherited from CommandContextMixIn
	_in_main_context
	_main_context
Protected Attributes inherited from SessionCommandMixin
	_session

Detailed Description

Uninstall packages.

pip is able to uninstall most installed packages. Known exceptions are:

- Pure distutils packages installed with ``python setup.py install``, which
  leave behind no metadata to determine what files were installed.
- Script wrappers installed by ``python setup.py develop``.

Definition at line 25 of file uninstall.py.

Member Function Documentation

add_options()

None add_options

(

self

)

Reimplemented from Command.

Definition at line 40 of file uninstall.py.

    def add_options(self) -> None:
        self.cmd_opts.add_option(
            "-r",
            "--requirement",
            dest="requirements",
            action="append",
            default=[],
            metavar="file",
            help=(
                "Uninstall all the packages listed in the given requirements "
                "file.  This option can be used multiple times."
            ),
        )
        self.cmd_opts.add_option(
            "-y",
            "--yes",
            dest="yes",
            action="store_true",
            help="Don't ask for confirmation of uninstall deletions.",
        )
        self.cmd_opts.add_option(cmdoptions.root_user_action())
        self.cmd_opts.add_option(cmdoptions.override_externally_managed())
        self.parser.insert_option_group(0, self.cmd_opts)
 

References Command.cmd_opts, CacheCommand.cmd_opts, CompletionCommand.cmd_opts, ConfigurationCommand.cmd_opts, DebugCommand.cmd_opts, DownloadCommand.cmd_opts, FreezeCommand.cmd_opts, HashCommand.cmd_opts, IndexCommand.cmd_opts, InspectCommand.cmd_opts, InstallCommand.cmd_opts, ListCommand.cmd_opts, SearchCommand.cmd_opts, ShowCommand.cmd_opts, UninstallCommand.cmd_opts, WheelCommand.cmd_opts, and i.

run()

int run	(		self,
		Values	options,
		List[str]	args
	)

Reimplemented from Command.

Definition at line 64 of file uninstall.py.

    def run(self, options: Values, args: List[str]) -> int:
        session = self.get_default_session(options)
 
        reqs_to_uninstall = {}
        for name in args:
            req = install_req_from_line(
                name,
                isolated=options.isolated_mode,
            )
            if req.name:
                reqs_to_uninstall[canonicalize_name(req.name)] = req
            else:
                logger.warning(
                    "Invalid requirement: %r ignored -"
                    " the uninstall command expects named"
                    " requirements.",
                    name,
                )
        for filename in options.requirements:
            for parsed_req in parse_requirements(
                filename, options=options, session=session
            ):
                req = install_req_from_parsed_requirement(
                    parsed_req, isolated=options.isolated_mode
                )
                if req.name:
                    reqs_to_uninstall[canonicalize_name(req.name)] = req
        if not reqs_to_uninstall:
            raise InstallationError(
                f"You must give at least one requirement to {self.name} (see "
                f'"pip help {self.name}")'
            )
 
        if not options.override_externally_managed:
            check_externally_managed()
 
        protect_pip_from_modification_on_windows(
            modifying_pip="pip" in reqs_to_uninstall
        )
 
        for req in reqs_to_uninstall.values():
            uninstall_pathset = req.uninstall(
                auto_confirm=options.yes,
                verbose=self.verbosity > 0,
            )
            if uninstall_pathset:
                uninstall_pathset.commit()
        if options.root_user_action == "warn":
            warn_if_run_as_root()
        return SUCCESS

References SessionCommandMixin.get_default_session(), i, Command.verbosity, and RequirementPreparer.verbosity.

Here is the call graph for this function:

Field Documentation

cmd_opts

cmd_opts

Definition at line 62 of file uninstall.py.

Referenced by RequirementCommand.__init__(), CacheCommand.add_options(), CompletionCommand.add_options(), ConfigurationCommand.add_options(), DownloadCommand.add_options(), FreezeCommand.add_options(), HashCommand.add_options(), InspectCommand.add_options(), InstallCommand.add_options(), ListCommand.add_options(), SearchCommand.add_options(), ShowCommand.add_options(), UninstallCommand.add_options(), and WheelCommand.add_options().

usage

str usage

static

Initial value:

=  """
      %prog [options] <package> ...
      %prog [options] -r <requirements file> ..."""

Definition at line 36 of file uninstall.py.

---

The documentation for this class was generated from the following file:

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_internal/commands/uninstall.py