pip._internal.cli.autocompletion Namespace Reference

Functions
None	autocomplete ()
Optional[str]	get_path_completion_type (List[str] cwords, int cword, Iterable[Any] opts)
Iterable[str]	auto_complete_paths (str current, str completion_type)

Detailed Description

Logic that powers autocompletion installed by ``pip completion``.

Function Documentation

auto_complete_paths()

Iterable[str] pip._internal.cli.autocompletion.auto_complete_paths	(	str	current,
		str	completion_type
	)

If ``completion_type`` is ``file`` or ``path``, list all regular files
and directories starting with ``current``; otherwise only list directories
starting with ``current``.

:param current: The word to be completed
:param completion_type: path completion type(``file``, ``path`` or ``dir``)
:return: A generator of regular files and/or directories

autocomplete()

None pip._internal.cli.autocompletion.autocomplete

(

)

Entry Point for completion of main and subcommand options.

get_path_completion_type()

Optional[str] pip._internal.cli.autocompletion.get_path_completion_type	(	List[str]	cwords,
		int	cword,
		Iterable[Any]	opts
	)

Get the type of path completion (``file``, ``dir``, ``path`` or None)

:param cwords: same as the environmental variable ``COMP_WORDS``
:param cword: same as the environmental variable ``COMP_CWORD``
:param opts: The available options to check
:return: path completion type (``file``, ``dir``, ``path`` or None)