class documentation

class CompletionItem:

View In Hierarchy

Represents a completion value and metadata about the value. The default metadata is type to indicate special shell handling, and help if a shell supports showing a help string next to the value.

Arbitrary parameters can be passed when creating the object, and accessed using item.attr. If an attribute wasn't passed, accessing it returns None.

Parameters
valueThe completion suggestion.
typeTells the shell script to provide special completion support for the type. Click uses "dir" and "file".
helpString shown next to the value if supported.
**kwargsArbitrary metadata. The built-in implementations don't use this, but custom type completions paired with custom shell support could use it.
Method __getattr__ Undocumented
Method __init__ Undocumented
Class Variable __slots__ Undocumented
Instance Variable ​_info Undocumented
Instance Variable help Undocumented
Instance Variable type Undocumented
Instance Variable value Undocumented
def __getattr__(self, name):

Undocumented

Parameters
name:strUndocumented
Returns
t.AnyUndocumented
def __init__(self, value, type='plain', help=None, **kwargs):

Undocumented

Parameters
value:t.AnyUndocumented
type:strUndocumented
help:t.Optional[str]Undocumented
**kwargs:t.AnyUndocumented
__slots__: tuple[str, ...] =

Undocumented

_info =

Undocumented

help =

Undocumented

type =

Undocumented

value =

Undocumented