Split out shell, launch into shell by default unless BREAKPOINT entered

Author: tony

tmuxp/cli.py

@@ -21,7 +21,7 @@
 
 from . import config, exc, log, util
 from .__about__ import __version__
-from ._compat import string_types
+from ._compat import PY3, PYMINOR, string_types
 from .workspacebuilder import WorkspaceBuilder, freeze
 
 logger = logging.getLogger(__name__)
@@ -671,7 +671,15 @@ def startup(config_dir):
     'command',
     help='Instead of opening shell, execute python code in libtmux and exit',
 )
-def command_shell(session_name, window_name, socket_name, socket_path, command):
+@click.option(
+    '--use-pdb/--no-pdb',
+    'use_pdb',
+    help='Use pdb / breakpoint() instead of code.interact()',
+    default=False,
+)
+def command_shell(
+    session_name, window_name, socket_name, socket_path, command, use_pdb
+):
     """Launch python shell for tmux server, session, window and pane.
 
     Priority given to loaded session/wndow/pane objects:
@@ -699,9 +707,15 @@ def command_shell(session_name, window_name, socket_name, socket_path, command):
     if command is not None:
         exec(command)
     else:
-        from ._compat import breakpoint as tmuxp_breakpoint
+        if use_pdb or (os.getenv('PYTHONBREAKPOINT') and PY3 and PYMINOR >= 7):
+            from ._compat import breakpoint as tmuxp_breakpoint
+
+            tmuxp_breakpoint()
+            return
+        else:
+            from .shell import launch
 
-        tmuxp_breakpoint()
+            launch(server=server, session=session, window=window, pane=pane)
 
 
 @cli.command(name='shell_plus')

tmuxp/shell.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+"""Utility and helper methods for tmuxp.
+
+tmuxp.shell
+~~~~~~~~~~~
+
+"""
+from __future__ import absolute_import, unicode_literals
+
+import logging
+import os
+
+logger = logging.getLogger(__name__)
+
+
+def launch(shell=None, best=True, use_pythonrc=False, **kwargs):
+    import code
+
+    import libtmux
+
+    imported_objects = {
+        'libtmux': libtmux,
+        'Server': libtmux.Server,
+        'Session': libtmux.Session,
+        'Window': libtmux.Window,
+        'Pane': libtmux.Pane,
+        'server': kwargs.get('server'),
+        'session': kwargs.get('session'),
+        'window': kwargs.get('window'),
+        'pane': kwargs.get('pane'),
+    }
+
+    try:
+        # Try activating rlcompleter, because it's handy.
+        import readline
+    except ImportError:
+        pass
+    else:
+        # We don't have to wrap the following import in a 'try', because
+        # we already know 'readline' was imported successfully.
+        import rlcompleter
+
+        readline.set_completer(rlcompleter.Completer(imported_objects).complete)
+        # Enable tab completion on systems using libedit (e.g. macOS).
+        # These lines are copied from Lib/site.py on Python 3.4.
+        readline_doc = getattr(readline, '__doc__', '')
+        if readline_doc is not None and 'libedit' in readline_doc:
+            readline.parse_and_bind("bind ^I rl_complete")
+        else:
+            readline.parse_and_bind("tab:complete")
+
+    # We want to honor both $PYTHONSTARTUP and .pythonrc.py, so follow system
+    # conventions and get $PYTHONSTARTUP first then .pythonrc.py.
+    if use_pythonrc:
+        for pythonrc in set(
+            [os.environ.get("PYTHONSTARTUP"), os.path.expanduser('~/.pythonrc.py')]
+        ):
+            if not pythonrc:
+                continue
+            if not os.path.isfile(pythonrc):
+                continue
+            with open(pythonrc) as handle:
+                pythonrc_code = handle.read()
+            # Match the behavior of the cpython shell where an error in
+            # PYTHONSTARTUP prints an exception and continues.
+            try:
+                exec(compile(pythonrc_code, pythonrc, 'exec'), imported_objects)
+            except Exception:
+                import traceback
+
+                traceback.print_exc()
+
+    code.interact(local=imported_objects)