CompletionProposal

class CompletionProposal(*args, **kwargs)

Interface for completion proposals.

This interface is used to denote that an object is capable of being a completion proposal for Completion.

Currently, no method or functions are required but additional methods may be added in the future. Proposals created by CompletionProvider can use IMPLEMENT_INTERFACE to implement this with None for the interface init function.

Methods

class CompletionProposal
get_typed_text() str | None

Gets the typed-text for the proposal, if supported by the implementation.

Implementing this virtual-function is optional, but can be useful to allow external tooling to compare results.

Added in version 5.6.

Virtual Methods

class CompletionProposal
do_get_typed_text() str | None

Gets the typed-text for the proposal, if supported by the implementation.

Implementing this virtual-function is optional, but can be useful to allow external tooling to compare results.

Added in version 5.6.