class CompletionItem:
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 | |
value | The completion suggestion. |
type | Tells the shell script to provide special completion support for the type. Click uses "dir" and "file". |
help | String shown next to the value if supported. |
**kwargs | Arbitrary 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 |