interactive.py

#!/usr/bin/env python3
 
 
 
"""
interactive
-----------
 
Defines a function embed() that can be used to drop into an interactive python
shell from within a steering file or python module. If available, IPython will
be used. Use Ctrl+D to exit the shell.
 
    >>> import interactive
    >>> interactive.embed()
    In [1]:
 
See framework/examples/interactive_python.py for an example.
"""
 
from traitlets.config.loader import Config
from IPython.terminal.prompts import Prompts, Token
from IPython import embed  # noqa
 
 
class Basf2IPythonPrompt(Prompts):
    """Provide slightly customized prompts when running basf2 interactively"""
 
    def in_prompt_tokens(self, cli=None):
        """Input prompt"""
        return [(Token.Prompt, "basf2 in ["),
                (Token.PromptNum, str(self.shell.execution_count)),
                (Token.Prompt, ']: ')]
 
    def out_prompt_tokens(self):
        """Output prompt"""
        return [(Token.OutPrompt, "basf2 out["),
                (Token.OutPromptNum, str(self.shell.execution_count)),
                (Token.OutPrompt, ']: ')]
 
 
def basf2_shell_config():
    """Return a config object customizing the shell prompt for basf2"""
    c = Config()
    c.TerminalInteractiveShell.prompts_class = Basf2IPythonPrompt
    return c
 
 
if __name__ == '__main__':
    from basf2 import basf2label
    from basf2 import *  # noqa
    embed(config=basf2_shell_config(), header=f"Welcome to {basf2label}")