click.shell_completion.BashComplete Class Reference

Inheritance diagram for click.shell_completion.BashComplete:

Collaboration diagram for click.shell_completion.BashComplete:

Public Member Functions
str	source (self)
tuple[list[str], str]	get_completion_args (self)
str	format_completion (self, CompletionItem item)
Public Member Functions inherited from click.shell_completion.ShellComplete
None	__init__ (self, Command cli, cabc.MutableMapping[str, t.Any] ctx_args, str prog_name, str complete_var)
str	func_name (self)
dict[str, t.Any]	source_vars (self)
list[CompletionItem]	get_completions (self, list[str] args, str incomplete)
str	complete (self)

Static Public Attributes
str	name = "bash"
	source_template = _SOURCE_BASH
Static Public Attributes inherited from click.shell_completion.ShellComplete
t	name .ClassVar[str]
t	source_template .ClassVar[str]

Static Protected Member Functions
None	_check_version ()

Additional Inherited Members
Public Attributes inherited from click.shell_completion.ShellComplete
	cli
	ctx_args
	prog_name
	complete_var
	func_name

Detailed Description

Shell completion for Bash.

Member Function Documentation

format_completion()

str click.shell_completion.BashComplete.format_completion	(		self,
		CompletionItem	item
	)

Format a completion item into the form recognized by the
shell script. This must be implemented by subclasses.

:param item: Completion item to format.

Reimplemented from click.shell_completion.ShellComplete.

get_completion_args()

tuple[list[str], str] click.shell_completion.BashComplete.get_completion_args

(

self

)

Use the env vars defined by the shell script to return a
tuple of ``args, incomplete``. This must be implemented by
subclasses.

Reimplemented from click.shell_completion.ShellComplete.

source()

str click.shell_completion.BashComplete.source

(

self

)

Produce the shell script that defines the completion
function. By default this ``%``-style formats
:attr:`source_template` with the dict returned by
:meth:`source_vars`.

Reimplemented from click.shell_completion.ShellComplete.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/click/shell_completion.py