Automatically detect the best shell

Author: tony

tests/test_cli.py

@@ -516,7 +516,13 @@ def test_shell(
         assert expected_output.format(**template_ctx) in result.output
 
 
-@pytest.mark.parametrize("cli_cmd", ['shell', ('shell', '--pdb')])
+@pytest.mark.parametrize(
+    "cli_cmd",
+    [
+        'shell',
+        ('shell', '--pdb'),
+    ],
+)
 @pytest.mark.parametrize(
     "cli_args,inputs,env,template_ctx,exception,message",
     [
@@ -605,12 +611,23 @@ def test_shell_target_missing(
             assert message.format(**template_ctx) in result.output
 
 
+@pytest.mark.parametrize(
+    "cli_cmd",
+    [
+        # 'shell',
+        # ('shell', '--pdb'),
+        ('shell', '--code'),
+        # ('shell', '--bpython'),
+        # ('shell', '--ptipython'),
+        # ('shell', '--ptpython'),
+        # ('shell', '--ipython'),
+    ],
+)
 @pytest.mark.parametrize(
     "cli_args,inputs,env,message",
     [
         (
             [
-                'shell',
                 '-L{SOCKET_NAME}',
             ],
             [],
@@ -619,7 +636,6 @@ def test_shell_target_missing(
         ),
         (
             [
-                'shell',
                 '-L{SOCKET_NAME}',
             ],
             [],
@@ -629,6 +645,7 @@ def test_shell_target_missing(
     ],
 )
 def test_shell_plus(
+    cli_cmd,
     cli_args,
     inputs,
     env,
@@ -652,7 +669,9 @@ def test_shell_plus(
         SERVER_SOCKET_NAME=server.socket_name,
     )
 
-    cli_args[:] = [cli_arg.format(**template_ctx) for cli_arg in cli_args]
+    cli_cmd = list(cli_cmd) if isinstance(cli_cmd, (list, tuple)) else [cli_cmd]
+    cli_args = cli_cmd + [cli_arg.format(**template_ctx) for cli_arg in cli_args]
+
     for k, v in env.items():
         monkeypatch.setenv(k, v.format(**template_ctx))
 

tmuxp/cli.py

@@ -671,22 +671,44 @@ def startup(config_dir):
     'command',
     help='Instead of opening shell, execute python code in libtmux and exit',
 )
+@click.option(
+    '--best',
+    'shell',
+    flag_value='best',
+    help='Use best shell available in site packages',
+    default=True,
+)
+@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='ptipython', help='Use ptpython + ipython'
+)
+@click.option('--ptpython', 'shell', flag_value='ptpython', help='Use ptpython')
+@click.option('--ipython', 'shell', flag_value='ipython', help='Use ipython')
+@click.option('--bpython', 'shell', flag_value='bpython', help='Use bpython')
 @click.option(
     '--use-pythonrc/--no-startup',
     'use_pythonrc',
-    help='Load the PYTHONSTARTUP environment variable and ~/.pythonrc.py script.',
+    help='Load PYTHONSTARTUP env var and ~/.pythonrc.py script in --code',
     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()'
+    '--use-vi-mode/--no-vi-mode',
+    'use_vi_mode',
+    help='Use vi-mode in ptpython/ptipython',
+    default=False,
 )
-@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, shell, use_pythonrc
+    session_name,
+    window_name,
+    socket_name,
+    socket_path,
+    command,
+    shell,
+    use_pythonrc,
+    use_vi_mode,
 ):
     """Launch python shell for tmux server, session, window and pane.
 
@@ -724,12 +746,14 @@ def command_shell(
             from .shell import launch
 
             launch(
+                shell=shell,
+                use_pythonrc=use_pythonrc,  # shell: code
+                use_vi_mode=use_vi_mode,  # shell: ptpython, ptipython
+                # tmux environment / libtmux variables
                 server=server,
                 session=session,
                 window=window,
                 pane=pane,
-                use_pythonrc=use_pythonrc,
-                shell=shell,
             )
 
 

tmuxp/shell.py

@@ -72,11 +72,11 @@ def detect_best_shell():
     return 'code'
 
 
-def get_bpython(options, extra_args):
-    try:
-        from bpython import embed  # NOQA F841
-    except ImportError:
-        return traceback.format_exc()
+def get_bpython(options, extra_args=None):
+    if extra_args is None:
+        extra_args = {}
+
+    from bpython import embed  # NOQA F841
 
     def launch_bpython():
         imported_objects = get_launch_args(**options)
@@ -104,15 +104,11 @@ def launch_ipython():
 
         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()
+        from IPython.Shell import IPShell
 
         def launch_ipython():
             imported_objects = get_launch_args(**options)
@@ -122,30 +118,26 @@ def launch_ipython():
         return launch_ipython
 
 
-def get_ptpython(self, options):
+def get_ptpython(options, vi_mode=False):
     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
+        from prompt_toolkit.contrib.repl import embed, run_config
 
-    def run_ptpython():
+    def launch_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'],
+            vi_mode=vi_mode,
             configure=run_config,
         )
 
-    return run_ptpython
+    return launch_ptpython
 
 
-def get_ptipython(options):
+def get_ptipython(options, vi_mode=False):
     """Based on django-extensions
 
     Run renamed to launch, get_imported_objects renamed to get_launch_args
@@ -154,20 +146,17 @@ def get_ptipython(options):
         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
+        # prompt_toolkit < v0.27
+        from prompt_toolkit.contrib.ipython import embed
+        from prompt_toolkit.contrib.repl import run_config
 
     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'],
+            vi_mode=vi_mode,
             configure=run_config,
         )
 
@@ -239,17 +228,17 @@ def launch_code():
     return launch_code
 
 
-def launch(shell='best', use_pythonrc=False, **kwargs):
+def launch(shell='best', use_pythonrc=False, use_vi_mode=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)
+        launch = get_ptipython(options=kwargs, vi_mode=use_vi_mode)
     elif shell == 'ptpython':
-        launch = get_ptpython(options=kwargs)
+        launch = get_ptpython(options=kwargs, vi_mode=use_vi_mode)
     elif shell == 'ipython':
         launch = get_ipython(options=kwargs)
     elif shell == 'bpython':