Method shell_cmd_complete

cmd2/cmd2.py:2291–2316

Perform completion of executables either in a user's path or a given path. :param text: the string prefix we are attempting to match (all matches must begin with it) :param line: the current input line with leading whitespace removed :param begidx: the beginning index of the

(
        self, text: str, line: str, begidx: int, endidx: int, *, complete_blank: bool = False
    )

        return Completions(items=items, allow_finalization=allow_finalization)

    def shell_cmd_complete(
        self, text: str, line: str, begidx: int, endidx: int, *, complete_blank: bool = False
    ) -> Completions:
        """Perform completion of executables either in a user's path or a given path.

        :param text: the string prefix we are attempting to match (all matches must begin with it)
        :param line: the current input line with leading whitespace removed
        :param begidx: the beginning index of the prefix text
        :param endidx: the ending index of the prefix text
        :param complete_blank: If True, then a blank will complete all shell commands in a user's path. If False, then
                               no completion is performed. Defaults to False to match Bash shell behavior.
        :return: a Completions object
        """
        # Don't complete anything if no shell command has been started
        if not complete_blank and not text:
            return Completions()

        # If there are no path characters in the search text, then do shell command completion in the user's path
        if not text.startswith("~") and os.path.sep not in text:
            items = [CompletionItem(exe) for exe in utils.get_exes_in_path(text)]
            return Completions(items=items)

        # Otherwise look for executables in the given path
        return self.path_complete(
            text, line, begidx, endidx, path_filter=lambda path: os.path.isdir(path) or os.access(path, os.X_OK)
        )

    def _redirect_complete(self, text: str, line: str, begidx: int, endidx: int, compfunc: BoundCompleter) -> Completions:
        """First completion function for all commands, called by complete().