Skip to content

Instantly share code, notes, and snippets.

@corelon
Forked from MattDMo/ipy_repl.py
Last active March 16, 2020 19:16
Show Gist options
  • Save corelon/7bd461e5ffabbeb6d519 to your computer and use it in GitHub Desktop.
Save corelon/7bd461e5ffabbeb6d519 to your computer and use it in GitHub Desktop.
SublimeREPL ipy_repl.py for running IPython 4/Jupyter in Sublime Text
import os
import sys
import json
import socket
import threading
activate_this = os.environ.get("SUBLIMEREPL_ACTIVATE_THIS", None)
# turn off pager
os.environ['TERM'] = 'emacs'
if activate_this:
with open(activate_this, "r") as f:
exec(f.read(), {"__file__": activate_this})
try:
import IPython
IPYTHON = True
version = IPython.version_info[0]
except ImportError:
IPYTHON = False
if not IPYTHON:
# for virtualenvs w/o IPython
import code
code.InteractiveConsole().interact()
from traitlets.config.loader import Config
editor = "subl -w"
cfg = Config()
cfg.InteractiveShell.readline_use = False
cfg.InteractiveShell.autoindent = False
cfg.InteractiveShell.colors = "NoColor"
cfg.InteractiveShell.editor = os.environ.get("SUBLIMEREPL_EDITOR", editor)
# IPython 4.0.0
if version > 3:
try:
from jupyter_console.app import ZMQTerminalIPythonApp
def kernel_client(zmq_shell):
return zmq_shell.kernel_client
except ImportError:
raise ImportError("jupyter_console required for IPython 4")
# IPython 2-3
elif version > 1:
from IPython.terminal.console.app import ZMQTerminalIPythonApp
def kernel_client(zmq_shell):
return zmq_shell.kernel_client
else:
# Ipython 1.0
from IPython.frontend.terminal.console.app import ZMQTerminalIPythonApp
def kernel_client(zmq_shell):
return zmq_shell.kernel_manager
embedded_shell = ZMQTerminalIPythonApp(config=cfg, user_ns={})
embedded_shell.initialize()
if os.name == "nt":
# OMG what a fugly hack
import IPython.utils.io as io
io.stdout = io.IOStream(sys.__stdout__, fallback=io.devnull)
io.stderr = io.IOStream(sys.__stderr__, fallback=io.devnull)
embedded_shell.shell.show_banner() # ... my eyes, oh my eyes..
ac_port = int(os.environ.get("SUBLIMEREPL_AC_PORT", "0"))
ac_ip = os.environ.get("SUBLIMEREPL_AC_IP", "127.0.0.1")
if ac_port:
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.connect((ac_ip, ac_port))
def read_netstring(s):
size = 0
while True:
ch = s.recv(1)
if ch == b':':
break
size = size * 10 + int(ch)
msg = b""
while size != 0:
msg += s.recv(size)
size -= len(msg)
ch = s.recv(1)
assert ch == b','
return msg
def send_netstring(sock, msg):
payload = b"".join([str(len(msg)).encode("ascii"), b':', msg.encode("utf-8"), b','])
sock.sendall(payload)
def complete(zmq_shell, req):
kc = kernel_client(zmq_shell)
# Ipython 4
if version > 3:
msg_id = kc.complete(req['line'], req['cursor_pos'])
# Ipython 1-3
else:
msg_id = kc.shell_channel.complete(**req)
msg = kc.shell_channel.get_msg(timeout=50)
# end new stuff
if msg['parent_header']['msg_id'] == msg_id:
return msg["content"]["matches"]
return []
def handle():
while True:
msg = read_netstring(s).decode("utf-8")
try:
req = json.loads(msg)
completions = complete(embedded_shell, req)
result = (req["text"], completions)
res = json.dumps(result)
send_netstring(s, res)
except Exception:
send_netstring(s, b"[]")
if ac_port:
t = threading.Thread(target=handle)
t.start()
embedded_shell.start()
if ac_port:
s.close()
@MattDMo
Copy link

MattDMo commented Mar 16, 2020

Please see the original gist for a recent update that now works with all versions of IPython, both with and without Jupyter! Many thanks to @pe224 for the fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment