Automatically detect the best shell

Author: tony

tests/test_cli.py

@@ -407,7 +407,7 @@ def test_load_zsh_autotitle_warning(cli_args, tmpdir, monkeypatch):
         assert 'Please set' not in result.output
 
 
-@pytest.mark.parametrize("cli_cmd", ['shell', ('shell', '--use-pdb')])
+@pytest.mark.parametrize("cli_cmd", ['shell', ('shell', '--pdb')])
 @pytest.mark.parametrize(
     "cli_args,inputs,env,expected_output",
     [
@@ -516,7 +516,7 @@ def test_shell(
         assert expected_output.format(**template_ctx) in result.output
 
 
-@pytest.mark.parametrize("cli_cmd", ['shell', ('shell', '--use-pdb')])
+@pytest.mark.parametrize("cli_cmd", ['shell', ('shell', '--pdb')])
 @pytest.mark.parametrize(
     "cli_args,inputs,env,template_ctx,exception,message",
     [

tmuxp/cli.py

@@ -671,20 +671,22 @@ def startup(config_dir):
     'command',
     help='Instead of opening shell, execute python code in libtmux and exit',
 )
-@click.option(
-    '--use-pdb/--no-pdb',
-    'use_pdb',
-    help='Use pdb / breakpoint() instead of code.interact()',
-    default=False,
-)
 @click.option(
     '--use-pythonrc/--no-startup',
     'use_pythonrc',
     help='Load the PYTHONSTARTUP environment variable and ~/.pythonrc.py script.',
     default=False,
 )
+@click.option('--pdb', 'shell', flag_value='pdb', help='Use plain pdb')
+@click.option(
+    '--code', 'shell', flag_value='code', help='Use stdlib\'s code.interact()'
+)
+@click.option('--ptipython', 'shell', flag_value='pdb', help='Use ptpython + ipython')
+@click.option('--ptpython', 'shell', flag_value='pdb', help='Use ptpython')
+@click.option('--ipython', 'shell', flag_value='pdb', help='Use ipython')
+@click.option('--bpython', 'shell', flag_value='pdb', help='Use bpython')
 def command_shell(
-    session_name, window_name, socket_name, socket_path, command, use_pdb, use_pythonrc
+    session_name, window_name, socket_name, socket_path, command, shell, use_pythonrc
 ):
     """Launch python shell for tmux server, session, window and pane.
 
@@ -713,7 +715,7 @@ def command_shell(
     if command is not None:
         exec(command)
     else:
-        if use_pdb or (os.getenv('PYTHONBREAKPOINT') and PY3 and PYMINOR >= 7):
+        if shell == 'pdb' or (os.getenv('PYTHONBREAKPOINT') and PY3 and PYMINOR >= 7):
             from ._compat import breakpoint as tmuxp_breakpoint
 
             tmuxp_breakpoint()
@@ -727,6 +729,7 @@ def command_shell(
                 window=window,
                 pane=pane,
                 use_pythonrc=use_pythonrc,
+                shell=shell,
             )
 
 

tmuxp/shell.py

@@ -9,6 +9,7 @@
 
 import logging
 import os
+import traceback
 
 logger = logging.getLogger(__name__)
 
@@ -51,12 +52,132 @@ def has_ptipython():
     return True
 
 
-def launch(shell='best', use_pythonrc=False, **kwargs):
-    import code
+def has_bpython():
+    try:
+        from bpython import embed  # NOQA F841
+    except ImportError:
+        return False
+    return True
+
+
+def detect_best_shell():
+    if has_ptipython():
+        return 'ptipython'
+    elif has_ptpython():
+        return 'ptpython'
+    elif has_ipython():
+        return 'ipython'
+    elif has_bpython():
+        return 'bpython'
+    return 'code'
+
+
+def get_bpython(options, extra_args):
+    try:
+        from bpython import embed  # NOQA F841
+    except ImportError:
+        return traceback.format_exc()
+
+    def launch_bpython():
+        imported_objects = get_launch_args(**options)
+        kwargs = {}
+        if extra_args:
+            kwargs['args'] = extra_args
+        embed(imported_objects, **kwargs)
+
+    return launch_bpython
+
+
+def get_ipython_arguments():
+    ipython_args = 'IPYTHON_ARGUMENTS'
+    return os.environ.get(ipython_args, '').split()
+
+
+def get_ipython(options, **extra_args):
+    try:
+        from IPython import start_ipython
+
+        def launch_ipython():
+            imported_objects = get_launch_args(**options)
+            ipython_arguments = extra_args or get_ipython_arguments()
+            start_ipython(argv=ipython_arguments, user_ns=imported_objects)
+
+        return launch_ipython
+    except ImportError:
+        str_exc = traceback.format_exc()
+        # IPython < 0.11
+        # Explicitly pass an empty list as arguments, because otherwise
+        # IPython would use sys.argv from this script.
+        # Notebook not supported for IPython < 0.11.
+        try:
+            from IPython.Shell import IPShell
+        except ImportError:
+            return str_exc + "\n" + traceback.format_exc()
+
+        def launch_ipython():
+            imported_objects = get_launch_args(**options)
+            shell = IPShell(argv=[], user_ns=imported_objects)
+            shell.mainloop()
+
+        return launch_ipython
+
 
+def get_ptpython(self, options):
+    try:
+        from ptpython.repl import embed, run_config
+    except ImportError:
+        tb = traceback.format_exc()
+        try:  # prompt_toolkit < v0.27
+            from prompt_toolkit.contrib.repl import embed, run_config
+        except ImportError:
+            return tb
+
+    def run_ptpython():
+        imported_objects = get_launch_args(**options)
+        history_filename = os.path.expanduser('~/.ptpython_history')
+        embed(
+            globals=imported_objects,
+            history_filename=history_filename,
+            vi_mode=options['vi_mode'],
+            configure=run_config,
+        )
+
+    return run_ptpython
+
+
+def get_ptipython(options):
+    """Based on django-extensions
+
+    Run renamed to launch, get_imported_objects renamed to get_launch_args
+    """
+    try:
+        from ptpython.ipython import embed
+        from ptpython.repl import run_config
+    except ImportError:
+        tb = traceback.format_exc()
+        try:  # prompt_toolkit < v0.27
+            from prompt_toolkit.contrib.ipython import embed
+            from prompt_toolkit.contrib.repl import run_config
+        except ImportError:
+            return tb
+
+    def launch_ptipython():
+        imported_objects = get_launch_args(**options)
+        history_filename = os.path.expanduser('~/.ptpython_history')
+        embed(
+            user_ns=imported_objects,
+            history_filename=history_filename,
+            vi_mode=options['vi_mode'],
+            configure=run_config,
+        )
+
+    return launch_ptipython
+
+
+def get_launch_args(**kwargs):
     import libtmux
 
-    imported_objects = {
+    return {
         'libtmux': libtmux,
         'Server': libtmux.Server,
         'Session': libtmux.Session,
@@ -68,6 +189,10 @@ def launch(shell='best', use_pythonrc=False, **kwargs):
         'pane': kwargs.get('pane'),
     }
 
+
+def get_code(use_pythonrc, imported_objects):
+    import code
+
     try:
         # Try activating rlcompleter, because it's handy.
         import readline
@@ -108,4 +233,28 @@ def launch(shell='best', use_pythonrc=False, **kwargs):
 
                 traceback.print_exc()
 
-    code.interact(local=imported_objects)
+    def launch_code():
+        code.interact(local=imported_objects)
+
+    return launch_code
+
+
+def launch(shell='best', use_pythonrc=False, **kwargs):
+    # Also allowing passing shell='code' to force using code.interact
+    imported_objects = get_launch_args(**kwargs)
+
+    if shell == 'best':
+        shell = detect_best_shell()
+
+    if shell == 'ptipython':
+        launch = get_ptipython(options=kwargs)
+    elif shell == 'ptpython':
+        launch = get_ptpython(options=kwargs)
+    elif shell == 'ipython':
+        launch = get_ipython(options=kwargs)
+    elif shell == 'bpython':
+        launch = get_bpython(options=kwargs)
+    else:
+        launch = get_code(use_pythonrc=use_pythonrc, imported_objects=imported_objects)
+
+    launch()