Method select

cmd2/cmd2.py:4541–4605

Present a menu to the user. Modeled after the bash shell's SELECT. Returns the item chosen. Argument ``opts`` can be: | a single string -> will be split into one-word options | a list of strings -> will be offered as options | a list of tuples -> int

(self, opts: str | Iterable[str] | Iterable[tuple[Any, str | None]], prompt: str = "Your choice? ")

        return True

    def select(self, opts: str | Iterable[str] | Iterable[tuple[Any, str | None]], prompt: str = "Your choice? ") -> Any:
        """Present a menu to the user.

        Modeled after the bash shell's SELECT.  Returns the item chosen.

        Argument ``opts`` can be:

          | a single string -> will be split into one-word options
          | a list of strings -> will be offered as options
          | a list of tuples -> interpreted as (value, text), so
                                that the return value can differ from
                                the text advertised to the user
        """
        local_opts: Iterable[str] | Iterable[tuple[Any, str | None]]
        if isinstance(opts, str):
            local_opts = cast(list[tuple[Any, str | None]], list(zip(opts.split(), opts.split(), strict=False)))
        else:
            local_opts = opts
        fulloptions: list[tuple[Any, str]] = []
        for opt in local_opts:
            if isinstance(opt, str):
                fulloptions.append((opt, opt))
            else:
                try:
                    val = opt[0]
                    text = str(opt[1]) if len(opt) > 1 and opt[1] is not None else str(val)
                    fulloptions.append((val, text))
                except (IndexError, TypeError):
                    fulloptions.append((opt[0], str(opt[0])))

        if self._is_tty_session(self.main_session):
            try:
                while True:
                    with create_app_session(input=self.main_session.input, output=self.main_session.output):
                        result = choice(message=prompt, options=fulloptions)
                    if result is not None:
                        return result
            except KeyboardInterrupt:
                self.poutput("^C")
                raise

        # Non-interactive fallback
        for idx, (_, text) in enumerate(fulloptions):
            self.poutput("  %2d. %s" % (idx + 1, text))  # noqa: UP031

        while True:
            try:
                response = self.read_input(prompt)
            except EOFError:
                response = ""
                self.poutput()
            except KeyboardInterrupt:
                self.poutput("^C")
                raise

            if not response:
                continue