Method format_completion

src/click/shell_completion.py:306–312

Format a completion item into the form recognized by the shell script. This must be implemented by subclasses. :param item: Completion item to format.

(self, item: CompletionItem[str])

        return obj.shell_complete(ctx, incomplete)

    def format_completion(self, item: CompletionItem[str]) -> str:
        """Format a completion item into the form recognized by the
        shell script. This must be implemented by subclasses.

        :param item: Completion item to format.
        """
        raise NotImplementedError

    def complete(self) -> str:
        """Produce the completion data to send back to the shell.