Method _run_python

cmd2/cmd2.py:4862–5007

Run an interactive Python shell or execute a pyscript file. Called by do_py() and do_run_pyscript(). If pyscript is None, then this function runs an interactive Python shell. Otherwise, it runs the pyscript file. :param pyscript: optional path to a pyscript file to

(self, *, pyscript: str | None = None)

            readline.set_completer(cmd2_env.completer)

    def _run_python(self, *, pyscript: str | None = None) -> bool | None:
        """Run an interactive Python shell or execute a pyscript file.

        Called by do_py() and do_run_pyscript().

        If pyscript is None, then this function runs an interactive Python shell.
        Otherwise, it runs the pyscript file.

        :param pyscript: optional path to a pyscript file to run. This is intended only to be used by do_run_pyscript()
                         after it sets up sys.argv for the script. (Defaults to None)
        :return: True if running of commands should stop
        """
        self.last_result = False

        # Replace print() in the embedded Python environment. Standard print() writes to
        # sys.stdout, which bypasses cmd2 redirection (e.g., run_pyscript script.py > out.txt).
        # Using self.print_to(self.stdout) ensures output is capturable and respects 'allow_style'
        # without requiring the user to have access to 'self'.
        def py_print(
            *objects: Any,
            sep: str = " ",
            end: str = "\n",
            file: IO[str] | None = None,
            flush: bool = False,  # noqa: ARG001
        ) -> None:
            """Print objects to a stream, defaulting to self.stdout.

            This is used as the print() function within interactive Python shells and pyscripts.
            It wraps cmd2's print_to() method to honor output redirection and style settings.

            :param objects: objects to print (including Rich objects)
            :param sep: string to write between printed text. Defaults to " ".
            :param end: string to write at end of printed text. Defaults to a newline.
            :param file: file stream being written to. Defaults to self.stdout.
            :param flush: ignored as Rich-based output is flushed automatically. Defaults to False.
            """
            if file is None:
                file = self.stdout

            self.print_to(file, *objects, sep=sep, end=end)

        # Replace quit/exit in the embedded Python environment. Standard sys.exit()
        # would kill the entire application process; raising EmbeddedConsoleExit
        # allows the interpreter to return gracefully to the cmd2 prompt.
        def py_quit() -> None:
            """Exit an interactive Python shell or pyscript."""
            raise EmbeddedConsoleExit

        from .py_bridge import PyBridge

        add_to_history = self.scripts_add_to_history if pyscript else True
        py_bridge = PyBridge(self, add_to_history=add_to_history)
        saved_sys_path = None

        if self.in_pyscript():
            self.perror("Recursively entering interactive Python shells is not allowed")
            return None