Method read_input

cmd2/cmd2.py:3522–3574

Read a line of input with optional completion and history. :param prompt: prompt to display to user :param history: optional Sequence of strings to use for up-arrow history. The passed in history will not be edited. It is the caller's responsibility to add th

(
        self,
        prompt: str = "",
        *,
        history: Sequence[str] | None = None,
        preserve_quotes: bool = False,
        choices: Iterable[Any] | None = None,
        choices_provider: UnboundChoicesProvider[CmdOrSetT] | None = None,
        completer: UnboundCompleter[CmdOrSetT] | None = None,
        parser: Cmd2ArgumentParser | None = None,
    )

        return Cmd2Completer(self, custom_settings=settings)

    def read_input(
        self,
        prompt: str = "",
        *,
        history: Sequence[str] | None = None,
        preserve_quotes: bool = False,
        choices: Iterable[Any] | None = None,
        choices_provider: UnboundChoicesProvider[CmdOrSetT] | None = None,
        completer: UnboundCompleter[CmdOrSetT] | None = None,
        parser: Cmd2ArgumentParser | None = None,
    ) -> str:
        """Read a line of input with optional completion and history.

        :param prompt: prompt to display to user
        :param history: optional Sequence of strings to use for up-arrow history. The passed in history
                        will not be edited. It is the caller's responsibility to add the returned input
                        to history if desired. Defaults to None.
        :param preserve_quotes: if True, then quoted tokens will keep their quotes when processed by
                                ArgparseCompleter. This is helpful in cases when you're completing
                                flag-like tokens (e.g. -o, --option) and you don't want them to be
                                treated as argparse flags when quoted. Set this to True if you plan
                                on passing the string to argparse with the tokens still quoted.

        A maximum of one of these should be provided:
        :param choices: iterable of accepted values for single argument
        :param choices_provider: function that provides choices for single argument
        :param completer: completion function that provides choices for single argument
        :param parser: an argument parser which supports the completion of multiple arguments
        :return: the line read from stdin with all trailing new lines removed
        :raises EOFError: if the input stream is closed or the user signals EOF (e.g., Ctrl+D)
        :raises Exception: any other exceptions raised by prompt()
        """
        completer_to_use = self._resolve_completer(
            preserve_quotes=preserve_quotes,
            choices=choices,
            choices_provider=choices_provider,
            completer=completer,
            parser=parser,
        )

        temp_session: PromptSession[str] = PromptSession(
            auto_suggest=self.main_session.auto_suggest,
            complete_style=self.main_session.complete_style,
            complete_in_thread=self.main_session.complete_in_thread,
            complete_while_typing=self.main_session.complete_while_typing,
            completer=completer_to_use,
            history=InMemoryHistory(history) if history is not None else InMemoryHistory(),
            key_bindings=self.main_session.key_bindings,
            input=self.main_session.input,
            output=self.main_session.output,
        )

        return self._read_raw_input(prompt, temp_session)

    def read_secret(
        self,