Add tmuxp shell_plus (credits to django-extensions, license MIT)

Author: tony

tmuxp/cli.py

@@ -738,6 +738,151 @@ def command_shell(session_name, window_name, socket_name, socket_path, command):
         tmuxp_breakpoint()
 
 
+@cli.command(name='shell_plus')
+@click.argument('session_name', nargs=1, required=False)
+@click.argument('window_name', nargs=1, required=False)
+@click.option('-S', 'socket_path', help='pass-through for tmux -S')
+@click.option('-L', 'socket_name', help='pass-through for tmux -L')
+@click.option(
+    '-c',
+    'command',
+    help='Instead of opening shell, execute python code in libtmux and exit',
+)
+@click.option(
+    '--use-pythonrc/--no-startup',
+    'use_pythonrc',
+    help='Load the PYTHONSTARTUP environment variable and ~/.pythonrc.py script.',
+    default=False,
+)
+def command_shell_plus(
+    session_name,
+    window_name,
+    socket_name,
+    socket_path,
+    command,
+    use_pythonrc,
+):
+    """shell w/ tab completion.
+
+    Credits: django-extensions shell_plus.py 51fef74 (MIT License)
+    """
+    server = Server(socket_name=socket_name, socket_path=socket_path)
+
+    current_pane = None
+    if os.getenv('TMUX_PANE') is not None:
+        current_pane = next(
+            (
+                p
+                for p in server._list_panes()
+                if p.get('pane_id') == os.getenv('TMUX_PANE')
+            ),
+            None,
+        )
+
+    try:
+        if session_name:
+            session = server.find_where({'session_name': session_name})
+        elif current_pane is not None:
+            session = server.find_where({'session_id': current_pane['session_id']})
+        else:
+            session = server.list_sessions()[0]
+
+        if not session:
+            raise exc.TmuxpException('Session not found: %s' % session_name)
+    except exc.TmuxpException as e:
+        print(e)
+        return
+
+    try:
+        if window_name:
+            window = session.find_where({'window_name': window_name})
+            if not window:
+                raise exc.TmuxpException('Window not found: %s' % window_name)
+        elif current_pane is not None:
+            window = session.find_where({'window_id': current_pane['window_id']})
+        else:
+            window = session.list_windows()[0]
+
+    except exc.TmuxpException as e:
+        print(e)
+        return
+
+    try:
+        if current_pane is not None:
+            pane = window.find_where({'pane_id': current_pane['pane_id']})  # NOQA: F841
+        else:
+            pane = window.attached_pane  # NOQA: F841
+    except exc.TmuxpException as e:
+        print(e)
+        return
+
+    if command is not None:
+        exec(command)
+    else:
+        # Using normal Python shell
+        import code
+
+        # imported_objects = [pane, window, session, server]
+        import libtmux
+
+        imported_objects = {
+            'libtmux': libtmux,
+            'Server': libtmux.Server,
+            'Session': libtmux.Session,
+            'Window': libtmux.Window,
+            'Pane': libtmux.Pane,
+            'server': server,
+            'session': session,
+            'window': window,
+            'pane': 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()
+
+        def run_plain():
+            code.interact(local=imported_objects)
+
+        run_plain()
+
+
 @cli.command(name='freeze')
 @click.argument('session_name', nargs=1, required=False)
 @click.option('-S', 'socket_path', help='pass-through for tmux -S')