Search.setIndex({"docnames": ["api/client", "api/index", "api/kernelspec", "api/manager", "api/provisioners", "index", "kernels", "messaging", "pending-kernels", "provisioning", "wrapperkernels"], "filenames": ["api/client.rst", "api/index.rst", "api/kernelspec.rst", "api/manager.rst", "api/provisioners.rst", "index.rst", "kernels.rst", "messaging.rst", "pending-kernels.rst", "provisioning.rst", "wrapperkernels.rst"], "titles": ["client - communicating with kernels", "jupyter_client API", "kernelspec - discovering kernels", "manager - starting, stopping, signalling", "kernel provisioner apis", "Jupyter Client 7.4", "Making kernels for Jupyter", "Messaging in Jupyter", "Pending Kernels", "Customizing the kernel\u2019s runtime environment", "Making simple Python wrapper kernels"], "terms": {"messag": [0, 3, 4, 5, 10], "jupyt": [0, 2, 9, 10], "The": [0, 2, 3, 4, 5, 6, 8, 10], "specif": [0, 2, 4, 6, 7, 9], "class": [0, 2, 3, 4, 7, 9, 10], "jupyter_cli": [0, 2, 3, 4, 5, 7, 9], "kernelcli": [0, 1, 3, 9], "kwarg": [0, 3, 4, 9], "ani": [0, 3, 4, 6, 7, 9, 10], "singl": [0, 3, 5, 7, 9], "host": [0, 3, 9], "via": [0, 4, 6, 7, 9], "zmq": [0, 7], "channel": [0, 3, 5, 6], "There": [0, 6, 7, 9], "ar": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10], "five": [0, 6, 7], "associ": [0, 4, 6, 7], "each": [0, 4, 6, 7], "shell": [0, 5, 6], "request": [0, 2, 4, 9, 10], "repli": [0, 10], "call": [0, 2, 3, 4, 7, 8, 9], "iopub": [0, 5, 6], "publish": [0, 7], "result": [0, 8, 9, 10], "frontend": [0, 6, 7, 10], "hb": [0, 6], "monitor": [0, 7], "": [0, 2, 4, 5, 6, 7, 8, 10], "heartbeat": [0, 5, 6], "stdin": [0, 5, 6], "raw_input": [0, 7, 10], "control": [0, 1, 5, 6, 9, 10], "manag": [0, 1, 4, 5, 8], "can": [0, 2, 3, 4, 6, 7, 8, 9, 10], "sent": [0, 7, 10], "expos": [0, 2, 3, 6, 7, 9], "method": [0, 2, 3, 4, 7, 8, 9, 10], "execut": [0, 6, 10], "complet": [0, 4, 6, 9, 10], "histori": [0, 10], "etc": [0, 9], "These": [0, 2, 6, 7, 9], "onli": [0, 3, 6, 7, 9, 10], "send": [0, 3, 4, 6, 7, 9, 10], "thei": [0, 2, 5, 6, 7, 9, 10], "don": [0, 7], "t": [0, 6, 7, 9], "wait": [0, 4, 7, 8, 9], "To": [0, 6, 7, 9, 10], "get": [0, 3, 7, 9, 10], "us": [0, 2, 3, 4, 5, 6, 7, 9, 10], "e": [0, 3, 6, 7, 8, 9, 10], "g": [0, 3, 6, 7, 8, 10], "get_shell_msg": 0, "fetch": [0, 7], "from": [0, 2, 3, 4, 6, 7, 8, 9, 10], "load_connection_fil": 0, "connection_fil": [0, 6, 9, 10], "option": [0, 3, 4, 5, 6, 7, 9], "str": [0, 3, 4, 7, 9, 10], "none": [0, 2, 3, 4, 8, 9, 10], "load": [0, 2, 4, 6, 7], "connect": [0, 3, 4, 5, 9], "info": [0, 9, 10], "json": [0, 2, 4, 6, 7, 9, 10], "dict": [0, 2, 4, 7, 9, 10], "self": [0, 9, 10], "paramet": [0, 3, 4, 10], "unicod": [0, 6, 9], "path": [0, 2, 6, 7, 10], "file": [0, 3, 5, 7, 9, 10], "If": [0, 2, 3, 4, 6, 7, 9, 10], "unspecifi": 0, "load_connection_info": 0, "union": [0, 4], "int": [0, 4, 7, 9, 10], "byte": [0, 4, 7], "contain": [0, 5, 6, 7, 9, 10], "typic": [0, 3, 4, 7, 9], "thi": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10], "data": 0, "come": [0, 6, 7], "i": [0, 2, 3, 4, 6, 7, 8, 9, 10], "dictionari": [0, 2, 6, 7, 10], "connection_info": [0, 4], "see": [0, 3, 4, 6, 7, 9, 10], "spec": [0, 2, 3, 4, 5, 7, 10], "detail": [0, 5, 6, 7, 10], "start_channel": 0, "bool": [0, 3, 4, 7, 9, 10], "true": [0, 3, 4, 7, 8, 9, 10], "start": [0, 1, 2, 4, 5, 6, 7, 8, 10], "creat": [0, 3, 4, 6, 7, 8, 9, 10], "do": [0, 3, 6, 7, 9], "exist": [0, 4, 6, 7, 9], "them": [0, 6, 7, 8], "activ": [0, 3, 7], "run": [0, 3, 4, 6, 7, 8, 9, 10], "thread": [0, 7, 8], "port": [0, 3, 6, 7], "number": [0, 3, 6, 9, 10], "0": [0, 3, 4, 6, 8, 9, 10], "being": [0, 3, 7, 10], "random": [0, 3, 6], "you": [0, 2, 6, 7, 9, 10], "must": [0, 3, 4, 7, 10], "first": [0, 3, 4, 7, 10], "start_kernel": [0, 3, 8], "have": [0, 2, 3, 5, 6, 7, 9, 10], "been": [0, 4, 7, 9], "stop": [0, 1, 5, 7, 10], "runtimeerror": [0, 8], "rais": [0, 2, 4, 7, 8, 9], "code": [0, 4, 6, 10], "silent": [0, 7, 10], "fals": [0, 2, 3, 4, 7, 9, 10], "store_histori": [0, 7, 10], "user_express": [0, 7, 10], "allow_stdin": [0, 7, 10], "stop_on_error": [0, 7], "A": [0, 2, 3, 4, 6, 10], "string": [0, 2, 3, 7, 10], "languag": [0, 2, 6, 7, 9, 10], "default": [0, 2, 3, 4, 6, 7, 8, 9, 10], "set": [0, 2, 6, 7, 8, 10], "quietli": [0, 7], "possibl": [0, 3, 4, 7], "forc": [0, 3, 7], "store": [0, 7], "command": [0, 4, 6, 7, 9], "map": [0, 2, 3, 7, 9, 10], "name": [0, 2, 3, 4, 6, 7, 9, 10], "express": [0, 7, 10], "evalu": [0, 7, 10], "user": [0, 2, 6, 7, 9, 10], "valu": [0, 4, 6, 7, 9, 10], "return": [0, 2, 3, 4, 7, 8, 9, 10], "format": [0, 5], "repr": 0, "flag": [0, 3, 7], "whether": [0, 3, 4, 6, 7, 9, 10], "some": [0, 4, 7, 9], "notebook": [0, 2, 6, 7], "support": [0, 3, 7, 9], "stdinnotimplementederror": 0, "abort": [0, 7], "queue": [0, 7], "an": [0, 2, 4, 6, 7, 8, 9, 10], "except": [0, 2, 7, 8, 9], "encount": [0, 7], "type": [0, 3, 6, 7, 9, 10], "msg_id": [0, 7], "cursor_po": [0, 10], "tab": [0, 7], "text": [0, 6, 7, 10], "namespac": [0, 2, 6, 7, 9], "context": [0, 3, 7], "which": [0, 2, 3, 4, 6, 7, 9], "anyth": [0, 7], "between": [0, 7, 9], "variabl": [0, 2, 4, 6, 7], "entir": [0, 4, 7], "cell": [0, 6, 7, 10], "posit": [0, 7, 10], "cursor": [0, 7], "block": [0, 3, 7, 8], "where": [0, 4, 7, 8, 9, 10], "wa": [0, 2, 3, 4, 7, 9], "len": [0, 9], "inspect": [0, 7], "detail_level": [0, 7, 10], "metadata": [0, 2, 6, 9], "inform": [0, 4, 7, 9, 10], "about": [0, 6, 7], "object": [0, 2, 3, 7, 8, 9, 10], "It": [0, 3, 4, 7, 9, 10], "up": [0, 3, 6, 7, 10], "determin": [0, 4, 7, 9], "appropri": [0, 2, 4, 7, 9], "level": [0, 2, 7], "introspect": [0, 6, 10], "2": [0, 2, 8, 9], "raw": [0, 7, 10], "output": [0, 6, 10], "hist_access_typ": [0, 7, 10], "rang": [0, 7], "entri": [0, 4, 9], "list": [0, 2, 3, 4, 6, 7], "input": [0, 6, 10], "well": [0, 2, 3, 7, 9], "fill": 0, "session": [0, 7, 10], "param": [0, 9], "tail": [0, 7], "n": [0, 7, 10], "search": [0, 5, 6, 7], "pattern": [0, 7, 10], "For": [0, 3, 6, 7, 9], "line": [0, 6, 7, 10], "integ": [0, 4, 7], "neg": [0, 7], "ones": [0, 3, 7], "count": [0, 7, 10], "back": [0, 6, 7, 9], "current": [0, 2, 4, 6, 7, 9, 10], "final": [0, 7, 9, 10], "exclud": 0, "glob": [0, 7], "syntax": 0, "id": [0, 3, 4, 7, 8, 9], "comm_info": 0, "target_nam": [0, 7], "comm": 0, "is_complet": 0, "ask": [0, 7, 9], "readi": [0, 7, 8, 10], "should": [0, 2, 3, 4, 6, 7, 9, 10], "respons": [0, 4, 7, 9], "input_request": [0, 7], "shutdown": [0, 3, 4, 9, 10], "restart": [0, 3, 4, 7, 10], "immedi": [0, 3, 4, 6, 7, 8, 9], "upon": [0, 7, 9], "receipt": 0, "empti": [0, 7], "safe": [0, 7], "assum": [0, 7], "ha": [0, 4, 6, 7, 9, 10], "shut": [0, 3, 7, 8], "down": [0, 3, 8], "forcefulli": [0, 3, 7], "termin": [0, 4, 6, 7, 9], "still": [0, 3, 4, 6, 7, 9], "aliv": [0, 6, 7], "function": [0, 1, 2, 4, 7, 9, 10], "regist": [0, 4, 7], "python": [0, 4, 5, 6, 9], "atexit": 0, "modul": [0, 2, 5, 9, 10], "ensur": [0, 4, 7, 8], "truli": 0, "done": [0, 7, 8], "all": [0, 2, 3, 4, 5, 7, 8, 9, 10], "normal": [0, 7], "oper": [0, 3, 4, 6, 7, 9], "blockingkernelcli": [0, 1], "api": [0, 3, 6, 9], "get_": 0, "_msg": 0, "arriv": [0, 7], "within": [0, 7, 9], "timeout": 0, "second": [0, 7, 9], "execute_interact": 0, "interact": [0, 7, 8, 9], "redisplai": 0, "prompt": [0, 6, 10], "relai": 0, "ipython": [0, 6, 7, 10], "detect": [0, 7], "rich": [0, 7], "displai": [0, 2, 6, 10], "pass": [0, 3, 4, 6, 7, 10], "custom": [0, 4, 5], "output_hook": 0, "callabl": 0, "everi": [0, 7], "produc": [0, 7], "instead": [0, 7, 9], "new": [0, 2, 3, 6, 7, 9, 10], "version": [0, 3, 4, 5, 10], "5": [0, 4, 9], "float": [0, 4, 9], "when": [0, 2, 3, 4, 6, 7, 8, 9], "msg": [0, 7], "specifi": [0, 3, 4, 6, 7, 9], "stdin_hook": 0, "await": [0, 8, 9], "stdin_request": [0, 7], "getpass": 0, "get_iopub_msg": 0, "get_stdin_msg": 0, "get_control_msg": 0, "wait_for_readi": 0, "futur": [0, 6, 7, 8], "time": [0, 4, 7, 8, 9], "until": [0, 7, 8], "receiv": [0, 7], "exit": [0, 3, 4, 7], "di": 0, "out": [0, 4, 6, 7, 8], "befor": [0, 3, 6, 7, 8, 10], "flush": 0, "is_al": [0, 3, 4], "process": [0, 2, 3, 4, 7, 9], "asynckernelcli": [0, 1], "async": [0, 4, 9], "ident": [0, 7], "describ": [0, 6, 7, 10], "abov": [0, 6, 7], "kernelspec": [1, 3, 4, 5, 6, 7, 9, 10], "discov": [1, 5, 9], "kernel": [1, 5], "kernelspecmanag": [1, 2, 4], "nosuchkernel": [1, 2], "find_kernel_spec": [1, 2], "get_kernel_spec": [1, 2], "install_kernel_spec": [1, 2], "signal": [1, 4, 5, 6, 7, 9], "kernelmanag": [1, 3, 4, 8, 9], "multikernelmanag": [1, 8], "multipl": [1, 7, 10], "util": [1, 9], "client": [1, 2, 3, 6, 7, 9], "commun": [1, 3, 4, 5, 6, 7, 9], "provision": [1, 3, 5], "kernelprovisionerbas": [1, 3, 4], "localprovision": [1, 3, 4], "kernelprovisionerfactori": [1, 4, 9], "argv": [2, 6, 9, 10], "argument": [2, 3, 4, 6, 7, 10], "env": [2, 4, 6, 9], "extra": [2, 7], "environ": [2, 4, 5, 6, 7], "declar": 2, "addit": [2, 4, 6, 9, 10], "launch": [2, 3, 4, 9, 10], "display_nam": [2, 6, 9, 10], "ui": [2, 6, 7, 10], "implement": [2, 4, 5, 6, 7, 10], "help": [2, 7, 9], "pick": [2, 3], "need": [2, 4, 6, 7, 9, 10], "instanc": [2, 3, 4, 6, 7, 9], "aid": [2, 6], "select": [2, 6, 7, 9], "filter": 2, "ad": [2, 6, 7, 8, 10], "here": [2, 3, 6, 9, 10], "tool": [2, 6, 9], "read": [2, 4, 6, 7], "write": [2, 6, 7, 10], "concret": [2, 4], "re": [2, 4, 7, 9, 10], "field": [2, 6, 7, 10], "supported_vers": 2, "your": [2, 6, 10], "recogn": [2, 7], "add": [2, 7, 9, 10], "mytool": 2, "1": [2, 3, 6, 8, 9, 10], "top": [2, 7], "resource_dir": 2, "directori": [2, 6, 9, 10], "resourc": [2, 4, 9], "icon": 2, "to_json": 2, "serialis": [2, 6], "get_all_spec": 2, "form": [2, 7], "kernel_nam": [2, 3], "itself": [2, 6, 7], "given": [2, 3, 6, 7, 9, 10], "found": [2, 3, 4, 6, 7], "source_dir": 2, "replac": [2, 6, 7], "prefix": [2, 6, 7], "instal": [2, 4, 9, 10], "copi": [2, 7], "its": [2, 3, 4, 7, 8, 9, 10], "basenam": 2, "attempt": [2, 3, 8], "systemwid": 2, "registri": 2, "doe": [2, 7, 9], "permiss": 2, "oserror": 2, "share": [2, 6, 7, 9], "sy": [2, 6, 7], "insid": [2, 6, 7], "virtual": [2, 7], "conda": 2, "subprocess": [3, 4, 9], "popen": [3, 4, 9], "gener": [3, 5], "unless": [3, 7], "indic": [3, 4, 7], "otherwis": [3, 4, 7, 9], "separ": [3, 6, 7, 9], "kw": [3, 7], "keyword": [3, 4], "build": 3, "kernel_cmd": 3, "interrupt_kernel": [3, 8], "interrupt": [3, 6], "unlik": [3, 6, 7], "signal_kernel": [3, 4], "platform": 3, "group": [3, 9], "usual": [3, 7], "includ": [3, 4, 6, 7, 9, 10], "spawn": 3, "note": [3, 4, 5, 6, 9, 10], "sinc": [3, 6, 7, 9], "sigterm": [3, 4], "window": [3, 6, 7], "unix": [3, 6], "system": [3, 6, 7], "configur": [3, 4, 7, 9], "our": [3, 7], "blocking_cli": 3, "make": [3, 5, 7], "my": 3, "shutdown_kernel": [3, 8], "cleanli": 3, "over": [3, 6, 7], "fail": [3, 7], "forcibli": 3, "now": [3, 7, 9, 10], "forcibl": 3, "kill": [3, 4, 9], "skip": 3, "nice": 3, "Will": 3, "after": [3, 6, 7, 9, 10], "clean": [3, 7, 10], "restart_kernel": [3, 8], "were": 3, "without": [3, 7, 8], "chanc": [3, 9], "cleanup": [3, 4], "action": [3, 7, 8], "issu": [3, 4, 7], "In": [3, 7, 8, 9, 10], "case": [3, 4, 6, 7, 9], "differ": [3, 4, 6, 7, 9, 10], "perform": [3, 4, 7, 9], "newport": 3, "old": 3, "decid": [3, 7], "same": [3, 6, 7, 9], "again": [3, 10], "chosen": [3, 6], "written": [3, 6, 7, 10], "newli": 3, "happen": [3, 7], "overwrit": 3, "those": [3, 4, 7, 9], "identifi": [3, 4, 6, 7, 9], "uuid": [3, 7], "caller": 3, "kernel_id": [3, 4, 9], "one": [3, 4, 7, 9], "arg": 3, "new_kernel_id": 3, "list_kernel_id": 3, "get_kernel": 3, "remove_kernel": 3, "remov": [3, 7], "mainli": 3, "so": [3, 5, 6, 7, 9, 10], "alreadi": [3, 10], "dead": [3, 7], "shutdown_al": [3, 8], "run_kernel": 3, "iter": 3, "kernel_cli": 3, "runtim": [4, 5, 7], "provis": [4, 5], "provisioner_bas": 4, "abstract": [4, 9], "base": [4, 6, 7, 9, 10], "defin": [4, 7], "kernelprovision": 4, "major": [4, 7], "requir": [4, 5, 6, 7, 9], "subclass": [4, 9, 10], "while": [4, 7, 8, 9], "other": [4, 6, 7, 8, 9, 10], "provid": [4, 5, 7, 9, 10], "common": [4, 5, 7, 8], "awar": 4, "superclass": [4, 9], "mani": [4, 7], "model": [4, 8, 9], "pariti": 4, "previou": [4, 9], "directli": [4, 9], "kernel_spec": 4, "properti": [4, 8], "has_process": 4, "assert": 4, "follow": [4, 6, 7, 8, 9, 10], "launch_kernel": 4, "poll": [4, 9], "check": [4, 6, 7], "finish_shutdown": 4, "kill_kernel": 4, "gracefulli": 4, "respect": [4, 7], "send_sign": [4, 9], "signum": [4, 9], "accomplish": [4, 9], "sigkil": [4, 9], "cannot": [4, 9], "caught": 4, "preced": [4, 7], "subsequ": 4, "allow": [4, 6, 7, 9], "indirectli": [4, 9], "dure": [4, 7, 10], "grace": 4, "cmd": 4, "sequenc": [4, 7], "alloc": 4, "behalf": [4, 7], "cleanup_resourc": 4, "part": [4, 7], "shutdown_request": [4, 7], "request_shutdown": 4, "primarili": 4, "scenario": [4, 7, 8], "mai": [4, 6, 7, 9, 10], "prepar": 4, "pre_launch": [4, 9], "step": [4, 5, 7, 9], "appli": [4, 7], "substitut": [4, 6], "also": [4, 6, 7, 9, 10], "advis": 4, "local": [4, 6, 9], "_finalize_env": 4, "abil": [4, 9], "pre_start_kernel": 4, "potenti": [4, 9], "updat": [4, 5], "post_launch": 4, "post_start_kernel": 4, "get_provisioner_info": 4, "captur": 4, "necessari": [4, 6, 7, 9], "persist": [4, 7], "rel": [4, 9], "enabl": [4, 7, 9], "applic": [4, 7, 9], "relev": [4, 7, 10], "like": [4, 6, 7, 8, 9, 10], "disast": 4, "recoveri": 4, "high": 4, "avail": [4, 6, 7], "attribut": [4, 6, 10], "alwai": [4, 7], "proper": 4, "serial": [4, 7], "load_provisioner_info": 4, "provisioner_info": 4, "invers": [4, 7], "establish": 4, "presum": 4, "remot": [4, 7, 8], "origin": [4, 7], "deseri": [4, 7], "get_shutdown_wait_tim": [4, 9], "recommend": [4, 7, 9], "vari": 4, "phase": 4, "what": [4, 7, 9], "prior": [4, 7, 9], "sure": 4, "super": [4, 9], "__apply_env_substitut": 4, "substitution_valu": 4, "walk": 4, "stanza": [4, 9], "privat": 4, "intend": [4, 7], "overridden": 4, "local_provision": 4, "abc": 4, "box": 4, "lifecycl": [4, 9], "serv": 4, "refer": [4, 5, 7, 9, 10], "factori": 4, "singleton": 4, "valid": [4, 6, 7], "kernel_provision": [4, 9], "confirm": [4, 9], "default_provisioner_nam": [4, 9], "present": [4, 6, 7, 9, 10], "jupyter_default_provisioner_nam": 4, "is_provisioner_avail": 4, "entry_point": [4, 9], "referenc": [4, 6, 9], "cach": 4, "warn": 4, "create_provisioner_inst": 4, "parent": 4, "instanti": 4, "fabric": 4, "correspond": [4, 6, 7, 9], "trait": [4, 8], "modulenotfounderror": 4, "packag": [5, 7, 9, 10], "authorit": [5, 7], "descript": [5, 7], "protocol": [5, 6], "strongli": [5, 7], "encourag": [5, 7], "keep": [5, 7], "evolv": [5, 7], "we": [5, 7, 9], "introduct": 5, "compat": 5, "wire": [5, 6], "router": 5, "dealer": 5, "pub": 5, "sub": [5, 9], "changelog": 5, "handl": [5, 7, 9, 10], "simpl": [5, 6, 7], "wrapper": [5, 6], "exampl": [5, 6, 7, 9], "relationship": 5, "discoveri": 5, "backward": [5, 7], "pend": 5, "how": [5, 6, 7, 9], "work": [5, 6, 7], "index": [5, 7], "page": [5, 7], "program": [6, 7], "peopl": 6, "sever": [6, 7], "At": 6, "startup": [6, 7, 9], "three": 6, "reus": 6, "machineri": [6, 10], "just": [6, 7], "much": [6, 9], "simpler": 6, "target": [6, 7, 9, 10], "driven": 6, "more": [6, 7, 9, 10], "initi": [6, 7], "might": [6, 7], "contribut": 6, "know": [6, 7], "xeu": 6, "librari": [6, 7, 10], "c": [6, 7], "author": [6, 9], "logic": [6, 7], "auto": 6, "simplest": 6, "solut": 6, "most": [6, 7, 8], "script": [6, 7], "document": [6, 7], "cling": 6, "juniperkernel": 6, "access": [6, 10], "look": 6, "someth": [6, 7], "control_port": [6, 7], "50160": 6, "shell_port": [6, 7], "57503": 6, "transport": [6, 7], "tcp": 6, "signature_schem": 6, "hmac": [6, 7], "sha256": [6, 7], "stdin_port": [6, 7], "52597": 6, "hb_port": [6, 7], "42540": 6, "ip": 6, "127": 6, "iopub_port": [6, 7], "40885": 6, "kei": [6, 7, 8, 9, 10], "a0436f6c": 6, "1916": 6, "498b": 6, "8eb9": 6, "e81ab9368e84": 6, "_port": 6, "bind": [6, 10], "zeromq": [6, 7], "address": [6, 9], "socket": [6, 7], "would": [6, 7, 9], "cryptograph": 6, "sign": 6, "signatur": [6, 7], "calcul": [6, 7], "go": [6, 9], "event": 6, "loop": 6, "listen": [6, 7], "echo": [6, 7, 10], "pars": 6, "textual": 6, "blog": 6, "post": 6, "ihaskel": 6, "haskel": 6, "simple_kernel": 6, "locat": [6, 7], "usr": [6, 9], "programdata": 6, "linux": [6, 7], "mac": 6, "appdata": 6, "take": [6, 7, 8, 9, 10], "prioriti": 6, "ignor": [6, 7, 10], "wai": [6, 7, 8, 9], "filesystem": 6, "sensit": 6, "show": [6, 7], "url": [6, 7], "place": [6, 7, 9, 10], "ascii": 6, "letter": 6, "hyphen": 6, "period": 6, "_": 6, "underscor": 6, "jupyter_path": 6, "j": 6, "logo": 6, "imag": [6, 7, 9], "chang": [6, 7, 8], "import": [6, 7, 9, 10], "arbitrari": [6, 7], "charact": [6, 7], "match": [6, 7], "across": 6, "machin": [6, 7], "julia": 6, "properli": [6, 7], "even": [6, 7], "aren": 6, "under": [6, 8], "interrupt_mod": [6, 7, 9], "either": [6, 7, 8, 9], "suppos": 6, "facil": 6, "sigint": 6, "posix": 6, "interrupt_request": [6, 7], "mode": [6, 7], "env_var": 6, "administr": 6, "circumst": 6, "python3": [6, 7], "m": [6, 9, 10], "f": [6, 9, 10], "3": 6, "consol": [6, 7, 10], "qt": [6, 7], "bash": [6, 10], "qtconsol": [6, 7], "offer": 6, "dropdown": 6, "menu": [6, 7], "button": 6, "explain": 7, "basic": 7, "design": 7, "low": 7, "layer": [7, 9], "develop": 7, "independ": 7, "diagram": 7, "simultan": 7, "dedic": 7, "incom": 7, "made": [7, 8], "broadcast": 7, "own": [7, 9, 10], "print": 7, "traceback": 7, "addition": 7, "multi": 7, "want": [7, 9], "abl": 7, "collabor": 7, "both": 7, "uniform": 7, "manner": [7, 9], "act": 7, "keyboard": 7, "illustr": [7, 9], "figur": 7, "black": 7, "outlin": 7, "around": 7, "central": 7, "practic": 7, "special": 7, "widget": 7, "tag": 7, "enough": 7, "below": [7, 10], "avoid": 7, "behind": 7, "smoother": 7, "experi": 7, "long": [7, 8], "finish": [7, 8], "expens": 7, "bytestr": 7, "actual": 7, "reason": 7, "represent": 7, "compos": [7, 9], "uniqu": [7, 9, 10], "date": 7, "usernam": 7, "label": 7, "variou": [7, 9], "meaning": 7, "per": 7, "iso": 7, "8601": 7, "timestamp": 7, "msg_type": 7, "entiti": [7, 9], "state": [7, 8, 9], "among": 7, "reconnect": 7, "particular": 7, "regener": 7, "disconnect": 7, "than": [7, 9, 10], "accident": 7, "omit": 7, "canon": 7, "mandatori": 7, "anoth": [7, 9], "direct": 7, "parent_head": 7, "caus": 7, "_repli": 7, "rout": 7, "right": 7, "often": 7, "extens": [7, 9], "bodi": 7, "Its": 7, "structur": 7, "dictat": [7, 9], "binari": 7, "offici": 7, "parallel": 7, "ipywidget": 7, "combin": 7, "togeth": 7, "repres": 7, "choic": 7, "along": [7, 9], "busi": 7, "idl": 7, "although": [7, 9], "sensibl": 7, "behaviour": 7, "answer": [7, 9], "unexpect": 7, "known": [7, 9], "break": 7, "section": [7, 9, 10], "talk": 7, "non": 7, "consum": 7, "least": 7, "six": 7, "blob": 7, "b": 7, "u": 7, "d": [7, 9], "delimit": 7, "baddad42": 7, "xf0": 7, "x9f": 7, "x90": 7, "xb1": 7, "front": 7, "zero": 7, "piec": 7, "compon": 7, "topic": 7, "subscrib": 7, "execute_result": 7, "display_data": 7, "irrelev": 7, "becaus": [7, 9], "convent": 7, "possibli": [7, 10], "authent": 7, "disabl": 7, "By": [7, 9], "hash": 7, "comput": 7, "hex": 7, "digest": 7, "concaten": 7, "onc": [7, 8, 9], "digestmod": 7, "hashlib": 7, "serialized_dict": 7, "hexdigest": 7, "four": 7, "frame": 7, "order": 7, "turn": 7, "msgpack": 7, "pickl": 7, "altern": 7, "As": [7, 9], "natur": [7, 9], "func": 7, "few": 7, "point": [7, 9], "automat": 7, "construct": 7, "extend": 7, "conveni": 7, "handler": 7, "_request": 7, "execute_request": 7, "execute_repli": 7, "ok": [7, 10], "successfulli": 7, "remain": 7, "due": 7, "success": 7, "enam": 7, "No": 7, "execution_count": [7, 10], "regardless": 7, "prove": [7, 9], "consid": [7, 9], "reserv": 7, "thu": [7, 9], "intern": [7, 9], "sourc": [7, 10], "boolean": 7, "popul": 7, "queu": 7, "user_vari": 7, "redund": 7, "multilin": 7, "deserv": 7, "explan": 7, "past": 7, "had": 7, "notion": 7, "put": 7, "good": [7, 9], "esoter": 7, "instrument": 7, "acquir": [7, 9], "network": 7, "But": 7, "knowledg": 7, "featur": 7, "retriev": 7, "standard": 7, "nameerror": 7, "foo": 7, "obtain": 7, "purpos": 7, "depend": 7, "outcom": 7, "monoton": 7, "increas": [7, 10], "execute_input": 7, "One": 7, "OR": 7, "global": 7, "did": 7, "classifi": 7, "though": 7, "yet": [7, 9], "trigger": 7, "pager": 7, "pane": 7, "view": 7, "alongsid": 7, "mime": 7, "bundl": 7, "plain": [7, 10], "mimebundl": 7, "set_next_input": 7, "next": 7, "interfac": [7, 10], "main": 7, "insert": 7, "edit_mag": 7, "edit": 7, "filenam": 7, "py": [7, 9, 10], "line_numb": 7, "ask_exit": 7, "instruct": 7, "left": 7, "close": 7, "keepkernel": 7, "inspect_request": 7, "desir": 7, "equival": [7, 9], "x": [7, 10], "object_info_request": 7, "renam": 7, "move": [7, 8], "lex": 7, "widespread": 7, "bug": 7, "ambigu": 7, "presenc": 7, "astral": 7, "plane": 7, "encod": 7, "codepoint": 7, "tooltip": 7, "inspect_repli": 7, "succeed": 7, "noth": 7, "object_info_repli": 7, "decis": 7, "complete_request": 7, "isal": 7, "favor": 7, "complete_repli": 7, "isalnum": 7, "isalpha": 7, "accept": [7, 9], "cursor_end": 7, "cursor_start": 7, "plugin": 7, "matched_text": 7, "explicitli": 7, "history_request": 7, "els": [7, 9], "transform": 7, "far": [7, 10], "give": 7, "last": 7, "wildcard": 7, "duplic": 7, "history_repli": 7, "tupl": 7, "enter": [7, 10], "style": 7, "continu": [7, 8, 10], "further": [7, 8], "expect": 7, "incomplet": 7, "invalid": 7, "soonest": 7, "unknown": 7, "promptli": 7, "fallback": 7, "heurist": 7, "blank": 7, "overrid": [7, 9, 10], "is_complete_request": 7, "is_complete_repli": 7, "indent": 7, "hint": 7, "autoindent": 7, "rule": 7, "status": 7, "connect_request": 7, "connect_repli": 7, "comm_info_request": 7, "comm_info_repli": 7, "comm_id": 7, "core": 7, "kernel_info_request": 7, "kernel_info_repli": 7, "increment": [7, 10], "incompat": 7, "minor": 7, "protocol_vers": 7, "y": 7, "z": 7, "__version__": 7, "implementation_vers": [7, 10], "language_info": [7, 10], "7": [7, 8, 9], "mimetyp": [7, 10], "dot": 7, "file_extens": [7, 10], "pygment": 7, "lexer": 7, "highlight": 7, "pygments_lex": [7, 10], "codemirror": 7, "codemirror_mod": [7, 10], "nbconvert": 7, "export": 7, "nbconvert_export": 7, "banner": [7, 10], "desplai": 7, "tell": 7, "debugg": 7, "help_link": 7, "ipython_vers": 7, "language_vers": [7, 10], "choos": 7, "quit": 7, "uppercas": 7, "magic": [7, 10], "gui": 7, "ctrl": 7, "shortcut": 7, "ipythonqt": 7, "lose": 7, "inlin": 7, "minut": 7, "saniti": 7, "leav": 7, "strai": 7, "shutdown_repli": 7, "thank": 7, "inact": 7, "simpli": [7, 9, 10], "respond": 7, "catch": 7, "callback": 7, "notifi": 7, "interrupt_repli": 7, "breakpoint": 7, "debug_request": 7, "debug_repli": 7, "adapt": 7, "39": 7, "later": [7, 10], "prevent": 7, "dumpcel": 7, "debuginfo": 7, "inspectvari": 7, "submit": [7, 9], "sourcepath": 7, "dump": 7, "reload": 7, "stage": 7, "isstart": 7, "hashmethod": 7, "murmur2": 7, "hashse": 7, "seed": 7, "tmpfileprefix": 7, "temporari": 7, "tmpfilesuffix": 7, "suffix": 7, "source_breakpoint": 7, "stoppedthread": 7, "richrend": 7, "render": 7, "exceptionpath": 7, "node": [7, 9], "tree": 7, "schema": 7, "meant": [7, 9], "variablesrefer": 7, "richinspectvari": 7, "variablenam": 7, "frameid": 7, "hit": 7, "reprensent": 7, "consist": [7, 9], "bring": 7, "html": 7, "svg": 7, "question": 7, "displayhook": 7, "probabl": [7, 9], "On": 7, "hand": [7, 9], "could": [7, 9], "who": 7, "v4": 7, "v5": 7, "pair": 7, "transient": 7, "introduc": [7, 9], "live": 7, "whole": 7, "interpret": 7, "third": [7, 9], "parti": [7, 9], "conflict": 7, "width": 7, "height": 7, "png": 7, "640": 7, "480": 7, "expand": 7, "fulli": 7, "display_id": 7, "abcd": 7, "unpack": 7, "doubl": 7, "update_display_data": 7, "regard": [7, 9], "regular": 7, "nteract": 7, "let": 7, "portion": 7, "_in": 7, "pyin": 7, "free": 7, "accord": 7, "capabl": 7, "understand": 7, "_n": 7, "hook": 7, "occur": [7, 9, 10], "similar": 7, "pyerr": 7, "exactli": 7, "execution_st": 7, "begin": 7, "shall": 7, "caveat": 7, "asynchron": 7, "background": [7, 8], "undefin": 7, "area": 7, "visibl": 7, "clear_output": 7, "anim": 7, "minim": 7, "flicker": 7, "behavior": [7, 9], "debug_ev": 7, "With": 7, "goe": 7, "opposit": 7, "press": 7, "r": 7, "readlin": 7, "input_repli": 7, "password": 7, "shouldn": 7, "obscur": 7, "neutral": 7, "symbol": 7, "lower": 7, "everyth": 7, "believ": 7, "ping": 7, "req": 7, "rep": 7, "symmetr": 7, "comm_open": 7, "my_comm": 7, "maintain": 7, "constructor": 7, "comm_clos": 7, "inconsist": 7, "synchron": 7, "counterpart": 7, "essenti": 7, "cours": 7, "comm_msg": 7, "destroi": 7, "opt": [7, 8], "resolv": 7, "surrog": 7, "ness": 7, "especi": 7, "javascript": 7, "report": 7, "utf": 7, "16": 7, "maco": 7, "\ud835\udc1a": 7, "1d41a": 7, "two": [7, 9], "drift": 7, "Not": 7, "howev": 7, "lost": 7, "similarli": [7, 9], "incorrect": 7, "thing": [7, 9, 10], "claim": 7, "earlier": 7, "behav": 7, "correctli": 7, "popular": 7, "\ud862\udf4e\ud862\udf4e\ud862\udf4e\ud862\udf4e\ud862\udf4e": 7, "10": 7, "Then": 7, "\ud862\udf4e\ud862\udf4e": 7, "affect": 7, "2017": 7, "06": 7, "jupyterlab": 7, "24": 7, "cocalc": 7, "discuss": 7, "github": 7, "advantag": 8, "task": 8, "manageri": 8, "intermedi": 8, "anytim": 8, "kernel_manag": 8, "through": [8, 10], "collect": 8, "use_pending_kernel": 8, "stop_kernel": 8, "becom": [8, 9], "releas": 9, "kubernet": 9, "hadoop": 9, "yarn": 9, "slurm": 9, "pod": 9, "resid": 9, "essenc": 9, "todai": 9, "enhanc": 9, "limit": 9, "framework": 9, "ti": 9, "therebi": 9, "usabl": 9, "agnost": 9, "kind": 9, "convei": 9, "relat": 9, "nor": 9, "affin": 9, "mere": 9, "vehicl": 9, "landscap": 9, "side": 9, "effect": 9, "That": 9, "said": 9, "hypothet": 9, "speak": 9, "slurmprovision": 9, "impos": 9, "constraint": 9, "server": 9, "edg": 9, "cluster": 9, "mitig": 9, "leverag": 9, "gatewai": 9, "enterpris": 9, "alter": 9, "mechan": 9, "config": 9, "item": 9, "content": 9, "provisioner_nam": 9, "k8": 9, "image_nam": 9, "my_docker_org": 9, "max_cpu": 9, "4": 9, "deriv": 9, "consumpt": 9, "my_packag": 9, "k8sprovision": 9, "built": 9, "retain": 9, "wish": 9, "impact": 9, "approach": 9, "sens": 9, "interest": 9, "adjust": 9, "amount": 9, "rbacprovision": 9, "verifi": 9, "role": 9, "thrown": 9, "def": [9, 10], "user_in_rol": 9, "permissionerror": 9, "critic": 9, "ll": 9, "familiar": 9, "rest": 9, "Or": 9, "coupl": 9, "endpoint": 9, "prototyp": 9, "notic": 9, "_get_application_id": 9, "te": 9, "doesn": 9, "app": 9, "_query_app_state_by_id": 9, "application_id": 9, "yarnprovision": 9, "initial_st": 9, "elif": 9, "tantamount": 9, "ahead": 9, "primari": 9, "tend": 9, "longer": 9, "notif": 9, "ignore_final_st": 9, "_query_app_by_nam": 9, "state_condit": 9, "last_known_st": 9, "final_st": 9, "log": 9, "applicationid": 9, "assign": 9, "kernelid": 9, "debug": 9, "retri": 9, "yarn_shutdown_wait_tim": 9, "__name__": [9, 10], "setup": 9, "rbac": 9, "acm": 9, "manual": 9, "programmat": 9, "end": [9, 10], "vision": 9, "et": 9, "al": 9, "pertain": 9, "find": 9, "rbac_kernel": 9, "ipykernel_launch": 9, "data_scientist": 9, "colon": 9, "easili": 10, "hy": 10, "calysto": 10, "repl": 10, "tty": 10, "pexpect": 10, "bash_kernel": 10, "metakernel": 10, "easier": 10, "processkernel": 10, "easi": 10, "octav": 10, "ipykernel": 10, "kernelbas": 10, "mykernel": 10, "rather": 10, "do_execut": 10, "record": 10, "implicitli": 10, "send_respons": 10, "error": 10, "statu": 10, "__main__": 10, "kernelapp": 10, "ipkernelapp": 10, "launch_inst": 10, "kernel_class": 10, "anywher": 10, "try": 10, "test": 10, "mykernelnam": 10, "echo_kernel": 10, "condens": 10, "echokernel": 10, "stdout": 10, "op": 10, "txt": 10, "parrot": 10, "stream_cont": 10, "iopub_socket": 10, "stream": 10, "payload": 10, "improv": 10, "mycustomkernel": 10, "do_complet": 10, "do_inspect": 10, "less": 10, "do_histori": 10, "concern": 10, "definit": 10, "shown": 10, "do_is_complet": 10, "do_shutdown": 10, "care": 10, "afterward": 10}, "objects": {"": [[10, 0, 1, "", "MyCustomKernel"], [10, 0, 1, "", "MyKernel"], [1, 3, 0, "-", "jupyter_client"]], "MyCustomKernel": [[10, 1, 1, "", "do_complete"], [10, 1, 1, "", "do_history"], [10, 1, 1, "", "do_inspect"], [10, 1, 1, "", "do_is_complete"], [10, 1, 1, "", "do_shutdown"]], "MyKernel": [[10, 2, 1, "", "banner"], [10, 1, 1, "", "do_execute"], [10, 2, 1, "", "implementation"], [10, 2, 1, "", "implementation_version"], [10, 2, 1, "", "language_info"]], "jupyter_client": [[0, 0, 1, "", "AsyncKernelClient"], [0, 0, 1, "", "BlockingKernelClient"], [0, 0, 1, "", "KernelClient"], [3, 0, 1, "", "KernelManager"], [3, 0, 1, "", "MultiKernelManager"], [2, 3, 0, "-", "kernelspec"], [3, 5, 1, "", "run_kernel"]], "jupyter_client.BlockingKernelClient": [[0, 1, 1, "", "execute_interactive"], [0, 1, 1, "", "get_control_msg"], [0, 1, 1, "", "get_iopub_msg"], [0, 1, 1, "", "get_shell_msg"], [0, 1, 1, "", "get_stdin_msg"], [0, 1, 1, "", "is_alive"], [0, 1, 1, "", "wait_for_ready"]], "jupyter_client.KernelClient": [[0, 1, 1, "", "comm_info"], [0, 1, 1, "", "complete"], [0, 1, 1, "", "execute"], [0, 1, 1, "", "history"], [0, 1, 1, "", "input"], [0, 1, 1, "", "inspect"], [0, 1, 1, "", "is_complete"], [0, 1, 1, "", "load_connection_file"], [0, 1, 1, "", "load_connection_info"], [0, 1, 1, "", "shutdown"], [0, 1, 1, "", "start_channels"]], "jupyter_client.KernelManager": [[3, 1, 1, "", "blocking_client"], [3, 1, 1, "", "client"], [3, 1, 1, "", "interrupt_kernel"], [3, 1, 1, "", "is_alive"], [3, 2, 1, "", "kernel_name"], [3, 2, 1, "", "provisioner"], [3, 1, 1, "", "restart_kernel"], [3, 1, 1, "", "shutdown_kernel"], [3, 1, 1, "", "signal_kernel"], [3, 1, 1, "", "start_kernel"]], "jupyter_client.MultiKernelManager": [[3, 1, 1, "", "get_kernel"], [3, 1, 1, "", "list_kernel_ids"], [3, 1, 1, "", "remove_kernel"], [3, 1, 1, "", "shutdown_all"], [3, 1, 1, "", "start_kernel"]], "jupyter_client.kernelspec": [[2, 0, 1, "", "KernelSpec"], [2, 0, 1, "", "KernelSpecManager"], [2, 4, 1, "", "NoSuchKernel"], [2, 5, 1, "", "find_kernel_specs"], [2, 5, 1, "", "get_kernel_spec"], [2, 5, 1, "", "install_kernel_spec"]], "jupyter_client.kernelspec.KernelSpec": [[2, 2, 1, "", "argv"], [2, 2, 1, "", "display_name"], [2, 2, 1, "", "env"], [2, 2, 1, "", "language"], [2, 2, 1, "", "metadata"], [2, 2, 1, "", "resource_dir"], [2, 1, 1, "", "to_json"]], "jupyter_client.kernelspec.KernelSpecManager": [[2, 1, 1, "", "find_kernel_specs"], [2, 1, 1, "", "get_all_specs"], [2, 1, 1, "", "get_kernel_spec"], [2, 1, 1, "", "install_kernel_spec"]], "jupyter_client.kernelspec.NoSuchKernel": [[2, 2, 1, "", "name"]], "jupyter_client.provisioning": [[4, 3, 0, "-", "factory"], [4, 3, 0, "-", "local_provisioner"], [4, 3, 0, "-", "provisioner_base"]], "jupyter_client.provisioning.factory": [[4, 0, 1, "", "KernelProvisionerFactory"]], "jupyter_client.provisioning.factory.KernelProvisionerFactory": [[4, 1, 1, "", "create_provisioner_instance"], [4, 2, 1, "", "default_provisioner_name"], [4, 1, 1, "", "is_provisioner_available"]], "jupyter_client.provisioning.local_provisioner": [[4, 0, 1, "", "LocalProvisioner"]], "jupyter_client.provisioning.provisioner_base": [[4, 0, 1, "", "KernelProvisionerBase"]], "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase": [[4, 1, 1, "", "__apply_env_substitutions"], [4, 1, 1, "", "_finalize_env"], [4, 1, 1, "", "cleanup"], [4, 2, 1, "", "connection_info"], [4, 1, 1, "", "get_provisioner_info"], [4, 1, 1, "", "get_shutdown_wait_time"], [4, 6, 1, "", "has_process"], [4, 2, 1, "", "kernel_id"], [4, 2, 1, "", "kernel_spec"], [4, 1, 1, "", "kill"], [4, 1, 1, "", "launch_kernel"], [4, 1, 1, "", "load_provisioner_info"], [4, 1, 1, "", "poll"], [4, 1, 1, "", "post_launch"], [4, 1, 1, "", "pre_launch"], [4, 1, 1, "", "send_signal"], [4, 1, 1, "", "shutdown_requested"], [4, 1, 1, "", "terminate"], [4, 1, 1, "", "wait"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:attribute", "3": "py:module", "4": "py:exception", "5": "py:function", "6": "py:property"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "module", "Python module"], "4": ["py", "exception", "Python exception"], "5": ["py", "function", "Python function"], "6": ["py", "property", "Python property"]}, "titleterms": {"client": [0, 5], "commun": 0, "kernel": [0, 2, 3, 4, 6, 7, 8, 9, 10], "jupyter_cli": 1, "api": [1, 4, 5, 7], "jupyt": [1, 5, 6, 7], "kernelspec": 2, "discov": 2, "manag": [3, 9], "start": 3, "stop": 3, "signal": 3, "multikernelmanag": 3, "control": [3, 7], "multipl": 3, "util": 3, "function": 3, "provision": [4, 9], "7": 5, "4": [5, 7], "user": 5, "document": 5, "develop": 5, "indic": 5, "tabl": 5, "make": [6, 10], "connect": [6, 7], "file": 6, "handl": 6, "messag": [6, 7], "spec": 6, "version": 7, "introduct": 7, "gener": 7, "format": 7, "header": 7, "parent": 7, "metadata": 7, "content": 7, "buffer": 7, "A": 7, "full": 7, "compat": [7, 9], "The": [7, 9], "wire": 7, "protocol": 7, "python": [7, 10], "shell": 7, "router": 7, "dealer": 7, "channel": 7, "request": 7, "repli": 7, "execut": 7, "counter": 7, "prompt": 7, "number": 7, "result": 7, "payload": 7, "deprec": 7, "introspect": 7, "complet": 7, "histori": 7, "code": 7, "comm": 7, "info": 7, "shutdown": 7, "interrupt": 7, "debug": 7, "addit": 7, "dap": 7, "iopub": 7, "pub": 7, "sub": 7, "stream": 7, "stdout": 7, "stderr": 7, "etc": 7, "displai": 7, "data": 7, "updat": 7, "input": 7, "error": 7, "statu": 7, "clear": 7, "output": 7, "event": 7, "stdin": 7, "heartbeat": 7, "custom": [7, 9], "open": 7, "tear": 7, "down": 7, "side": 7, "effect": 7, "changelog": 7, "5": 7, "draft": 7, "3": 7, "2": 7, "1": 7, "0": 7, "note": 7, "cursor_po": 7, "unicod": 7, "offset": 7, "pend": 8, "how": 8, "thei": 8, "work": 8, "us": 8, "": 9, "runtim": 9, "environ": 9, "provis": 9, "relationship": 9, "discoveri": 9, "backward": 9, "implement": 9, "extend": 9, "localprovision": 9, "kernelprovisionerbas": 9, "regist": 9, "your": 9, "deploi": 9, "list": 9, "avail": 9, "simpl": 10, "wrapper": 10, "requir": 10, "step": 10, "exampl": 10, "option": 10}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"client - communicating with kernels": [[0, "client-communicating-with-kernels"]], "jupyter_client API": [[1, "module-jupyter_client"]], "Jupyter API": [[1, null]], "kernelspec - discovering kernels": [[2, "kernelspec-discovering-kernels"]], "manager - starting, stopping, signalling": [[3, "manager-starting-stopping-signalling"]], "multikernelmanager - controlling multiple kernels": [[3, "multikernelmanager-controlling-multiple-kernels"]], "Utility functions": [[3, "utility-functions"]], "kernel provisioner apis": [[4, "kernel-provisioner-apis"]], "Jupyter Client 7.4": [[5, "jupyter-client-version"]], "User Documentation": [[5, null]], "Developer documentation": [[5, null]], "API": [[5, null]], "Indices and tables": [[5, "indices-and-tables"]], "Making kernels for Jupyter": [[6, "making-kernels-for-jupyter"]], "Connection files": [[6, "connection-files"]], "Handling messages": [[6, "handling-messages"]], "Kernel specs": [[6, "kernel-specs"]], "Messaging in Jupyter": [[7, "messaging-in-jupyter"]], "Versioning": [[7, "versioning"]], "Introduction": [[7, "introduction"]], "General Message Format": [[7, "general-message-format"]], "Message Header": [[7, "message-header"]], "Parent header": [[7, "parent-header"]], "Metadata": [[7, "metadata"]], "Content": [[7, "content"]], "Buffers": [[7, "buffers"]], "A full message": [[7, "a-full-message"]], "Compatibility": [[7, "compatibility"]], "The Wire Protocol": [[7, "the-wire-protocol"]], "Python API": [[7, "python-api"]], "Messages on the shell (ROUTER/DEALER) channel": [[7, "messages-on-the-shell-router-dealer-channel"]], "Request-Reply": [[7, "request-reply"]], "Execute": [[7, "execute"]], "Execution counter (prompt number)": [[7, "execution-counter-prompt-number"]], "Execution results": [[7, "execution-results"], [7, "id6"]], "Payloads (DEPRECATED)": [[7, "payloads-deprecated"]], "Execution payloads": [[7, null]], "Introspection": [[7, "introspection"]], "Completion": [[7, "completion"]], "History": [[7, "history"]], "Code completeness": [[7, "code-completeness"]], "Connect": [[7, "connect"]], "Comm info": [[7, "comm-info"]], "Kernel info": [[7, "kernel-info"]], "Messages on the Control (ROUTER/DEALER) channel": [[7, "messages-on-the-control-router-dealer-channel"]], "Kernel shutdown": [[7, "kernel-shutdown"]], "Kernel interrupt": [[7, "kernel-interrupt"]], "Debug request": [[7, "debug-request"]], "Additions to the DAP": [[7, "additions-to-the-dap"]], "Messages on the IOPub (PUB/SUB) channel": [[7, "messages-on-the-iopub-pub-sub-channel"]], "Streams (stdout,  stderr, etc)": [[7, "streams-stdout-stderr-etc"]], "Display Data": [[7, "display-data"]], "Update Display Data": [[7, "update-display-data"]], "Code inputs": [[7, "code-inputs"]], "Execution errors": [[7, "execution-errors"]], "Kernel status": [[7, "kernel-status"]], "Clear output": [[7, "clear-output"]], "Debug event": [[7, "debug-event"]], "Messages on the stdin (ROUTER/DEALER) channel": [[7, "messages-on-the-stdin-router-dealer-channel"]], "Heartbeat for kernels": [[7, "heartbeat-for-kernels"]], "Custom Messages": [[7, "custom-messages"]], "Opening a Comm": [[7, "opening-a-comm"]], "Comm Messages": [[7, "comm-messages"]], "Tearing Down Comms": [[7, "tearing-down-comms"]], "Output Side Effects": [[7, "output-side-effects"]], "Changelog": [[7, "changelog"]], "5.5 (draft)": [[7, "draft"]], "5.4": [[7, "id9"]], "5.3": [[7, "id10"]], "5.2": [[7, "id11"]], "5.1": [[7, "id12"]], "5.0": [[7, "id13"]], "4.1": [[7, "id14"]], "Notes": [[7, "notes"]], "cursor_pos and unicode offsets": [[7, "cursor-pos-and-unicode-offsets"]], "Pending Kernels": [[8, "pending-kernels"]], "How they work": [[8, "how-they-work"]], "Using pending kernels": [[8, "using-pending-kernels"]], "Customizing the kernel\u2019s runtime environment": [[9, "customizing-the-kernel-s-runtime-environment"]], "Kernel Provisioning": [[9, "kernel-provisioning"]], "The kernel manager and kernel provisioner relationship": [[9, "the-kernel-manager-and-kernel-provisioner-relationship"]], "Discovery": [[9, "discovery"]], "Backwards Compatibility": [[9, "backwards-compatibility"]], "Implementing a custom provisioner": [[9, "implementing-a-custom-provisioner"]], "Extending LocalProvisioner": [[9, "extending-localprovisioner"]], "Extending KernelProvisionerBase": [[9, "extending-kernelprovisionerbase"]], "Registering your custom provisioner": [[9, "registering-your-custom-provisioner"]], "Deploying your custom provisioner": [[9, "deploying-your-custom-provisioner"]], "Listing available kernel provisioners": [[9, "listing-available-kernel-provisioners"]], "Making simple Python wrapper kernels": [[10, "making-simple-python-wrapper-kernels"]], "Required steps": [[10, "required-steps"]], "Example": [[10, "example"]], "Optional steps": [[10, "optional-steps"]]}, "indexentries": {"asynckernelclient (class in jupyter_client)": [[0, "jupyter_client.AsyncKernelClient"]], "blockingkernelclient (class in jupyter_client)": [[0, "jupyter_client.BlockingKernelClient"]], "kernelclient (class in jupyter_client)": [[0, "jupyter_client.KernelClient"]], "comm_info() (jupyter_client.kernelclient method)": [[0, "jupyter_client.KernelClient.comm_info"]], "complete() (jupyter_client.kernelclient method)": [[0, "jupyter_client.KernelClient.complete"]], "execute() (jupyter_client.kernelclient method)": [[0, "jupyter_client.KernelClient.execute"]], "execute_interactive() (jupyter_client.blockingkernelclient method)": [[0, "jupyter_client.BlockingKernelClient.execute_interactive"]], "get_control_msg() (jupyter_client.blockingkernelclient method)": [[0, "jupyter_client.BlockingKernelClient.get_control_msg"]], "get_iopub_msg() (jupyter_client.blockingkernelclient method)": [[0, "jupyter_client.BlockingKernelClient.get_iopub_msg"]], "get_shell_msg() (jupyter_client.blockingkernelclient method)": [[0, "jupyter_client.BlockingKernelClient.get_shell_msg"]], "get_stdin_msg() (jupyter_client.blockingkernelclient method)": [[0, "jupyter_client.BlockingKernelClient.get_stdin_msg"]], "history() (jupyter_client.kernelclient method)": [[0, "jupyter_client.KernelClient.history"]], "input() (jupyter_client.kernelclient method)": [[0, "jupyter_client.KernelClient.input"]], "inspect() (jupyter_client.kernelclient method)": [[0, "jupyter_client.KernelClient.inspect"]], "is_alive() (jupyter_client.blockingkernelclient method)": [[0, "jupyter_client.BlockingKernelClient.is_alive"]], "is_complete() (jupyter_client.kernelclient method)": [[0, "jupyter_client.KernelClient.is_complete"]], "load_connection_file() (jupyter_client.kernelclient method)": [[0, "jupyter_client.KernelClient.load_connection_file"]], "load_connection_info() (jupyter_client.kernelclient method)": [[0, "jupyter_client.KernelClient.load_connection_info"]], "shutdown() (jupyter_client.kernelclient method)": [[0, "jupyter_client.KernelClient.shutdown"]], "start_channels() (jupyter_client.kernelclient method)": [[0, "jupyter_client.KernelClient.start_channels"]], "wait_for_ready() (jupyter_client.blockingkernelclient method)": [[0, "jupyter_client.BlockingKernelClient.wait_for_ready"]], "jupyter_client": [[1, "module-jupyter_client"]], "module": [[1, "module-jupyter_client"], [2, "module-jupyter_client.kernelspec"], [4, "module-jupyter_client.provisioning.factory"], [4, "module-jupyter_client.provisioning.local_provisioner"], [4, "module-jupyter_client.provisioning.provisioner_base"]], "kernelspec (class in jupyter_client.kernelspec)": [[2, "jupyter_client.kernelspec.KernelSpec"]], "kernelspecmanager (class in jupyter_client.kernelspec)": [[2, "jupyter_client.kernelspec.KernelSpecManager"]], "nosuchkernel": [[2, "jupyter_client.kernelspec.NoSuchKernel"]], "argv (jupyter_client.kernelspec.kernelspec attribute)": [[2, "jupyter_client.kernelspec.KernelSpec.argv"]], "display_name (jupyter_client.kernelspec.kernelspec attribute)": [[2, "jupyter_client.kernelspec.KernelSpec.display_name"]], "env (jupyter_client.kernelspec.kernelspec attribute)": [[2, "jupyter_client.kernelspec.KernelSpec.env"]], "find_kernel_specs() (in module jupyter_client.kernelspec)": [[2, "jupyter_client.kernelspec.find_kernel_specs"]], "find_kernel_specs() (jupyter_client.kernelspec.kernelspecmanager method)": [[2, "jupyter_client.kernelspec.KernelSpecManager.find_kernel_specs"]], "get_all_specs() (jupyter_client.kernelspec.kernelspecmanager method)": [[2, "jupyter_client.kernelspec.KernelSpecManager.get_all_specs"]], "get_kernel_spec() (in module jupyter_client.kernelspec)": [[2, "jupyter_client.kernelspec.get_kernel_spec"]], "get_kernel_spec() (jupyter_client.kernelspec.kernelspecmanager method)": [[2, "jupyter_client.kernelspec.KernelSpecManager.get_kernel_spec"]], "install_kernel_spec() (in module jupyter_client.kernelspec)": [[2, "jupyter_client.kernelspec.install_kernel_spec"]], "install_kernel_spec() (jupyter_client.kernelspec.kernelspecmanager method)": [[2, "jupyter_client.kernelspec.KernelSpecManager.install_kernel_spec"]], "jupyter_client.kernelspec": [[2, "module-jupyter_client.kernelspec"]], "language (jupyter_client.kernelspec.kernelspec attribute)": [[2, "jupyter_client.kernelspec.KernelSpec.language"]], "metadata (jupyter_client.kernelspec.kernelspec attribute)": [[2, "jupyter_client.kernelspec.KernelSpec.metadata"]], "name (jupyter_client.kernelspec.nosuchkernel attribute)": [[2, "jupyter_client.kernelspec.NoSuchKernel.name"]], "resource_dir (jupyter_client.kernelspec.kernelspec attribute)": [[2, "jupyter_client.kernelspec.KernelSpec.resource_dir"]], "to_json() (jupyter_client.kernelspec.kernelspec method)": [[2, "jupyter_client.kernelspec.KernelSpec.to_json"]], "kernelmanager (class in jupyter_client)": [[3, "jupyter_client.KernelManager"]], "multikernelmanager (class in jupyter_client)": [[3, "jupyter_client.MultiKernelManager"]], "blocking_client() (jupyter_client.kernelmanager method)": [[3, "jupyter_client.KernelManager.blocking_client"]], "client() (jupyter_client.kernelmanager method)": [[3, "jupyter_client.KernelManager.client"]], "get_kernel() (jupyter_client.multikernelmanager method)": [[3, "jupyter_client.MultiKernelManager.get_kernel"]], "interrupt_kernel() (jupyter_client.kernelmanager method)": [[3, "jupyter_client.KernelManager.interrupt_kernel"]], "is_alive() (jupyter_client.kernelmanager method)": [[3, "jupyter_client.KernelManager.is_alive"]], "kernel_name (jupyter_client.kernelmanager attribute)": [[3, "jupyter_client.KernelManager.kernel_name"]], "list_kernel_ids() (jupyter_client.multikernelmanager method)": [[3, "jupyter_client.MultiKernelManager.list_kernel_ids"]], "provisioner (jupyter_client.kernelmanager attribute)": [[3, "jupyter_client.KernelManager.provisioner"]], "remove_kernel() (jupyter_client.multikernelmanager method)": [[3, "jupyter_client.MultiKernelManager.remove_kernel"]], "restart_kernel() (jupyter_client.kernelmanager method)": [[3, "jupyter_client.KernelManager.restart_kernel"]], "run_kernel() (in module jupyter_client)": [[3, "jupyter_client.run_kernel"]], "shutdown_all() (jupyter_client.multikernelmanager method)": [[3, "jupyter_client.MultiKernelManager.shutdown_all"]], "shutdown_kernel() (jupyter_client.kernelmanager method)": [[3, "jupyter_client.KernelManager.shutdown_kernel"]], "signal_kernel() (jupyter_client.kernelmanager method)": [[3, "jupyter_client.KernelManager.signal_kernel"]], "start_kernel() (jupyter_client.kernelmanager method)": [[3, "jupyter_client.KernelManager.start_kernel"]], "start_kernel() (jupyter_client.multikernelmanager method)": [[3, "jupyter_client.MultiKernelManager.start_kernel"]], "kernelprovisionerbase (class in jupyter_client.provisioning.provisioner_base)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase"]], "kernelprovisionerfactory (class in jupyter_client.provisioning.factory)": [[4, "jupyter_client.provisioning.factory.KernelProvisionerFactory"]], "localprovisioner (class in jupyter_client.provisioning.local_provisioner)": [[4, "jupyter_client.provisioning.local_provisioner.LocalProvisioner"]], "__apply_env_substitutions() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.__apply_env_substitutions"]], "_finalize_env() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase._finalize_env"]], "cleanup() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.cleanup"]], "connection_info (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase attribute)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.connection_info"]], "create_provisioner_instance() (jupyter_client.provisioning.factory.kernelprovisionerfactory method)": [[4, "jupyter_client.provisioning.factory.KernelProvisionerFactory.create_provisioner_instance"]], "default_provisioner_name (jupyter_client.provisioning.factory.kernelprovisionerfactory attribute)": [[4, "jupyter_client.provisioning.factory.KernelProvisionerFactory.default_provisioner_name"]], "get_provisioner_info() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.get_provisioner_info"]], "get_shutdown_wait_time() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.get_shutdown_wait_time"]], "has_process (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase property)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.has_process"]], "is_provisioner_available() (jupyter_client.provisioning.factory.kernelprovisionerfactory method)": [[4, "jupyter_client.provisioning.factory.KernelProvisionerFactory.is_provisioner_available"]], "jupyter_client.provisioning.factory": [[4, "module-jupyter_client.provisioning.factory"]], "jupyter_client.provisioning.local_provisioner": [[4, "module-jupyter_client.provisioning.local_provisioner"]], "jupyter_client.provisioning.provisioner_base": [[4, "module-jupyter_client.provisioning.provisioner_base"]], "kernel_id (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase attribute)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.kernel_id"]], "kernel_spec (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase attribute)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.kernel_spec"]], "kill() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.kill"]], "launch_kernel() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.launch_kernel"]], "load_provisioner_info() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.load_provisioner_info"]], "poll() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.poll"]], "post_launch() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.post_launch"]], "pre_launch() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.pre_launch"]], "send_signal() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.send_signal"]], "shutdown_requested() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.shutdown_requested"]], "terminate() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.terminate"]], "wait() (jupyter_client.provisioning.provisioner_base.kernelprovisionerbase method)": [[4, "jupyter_client.provisioning.provisioner_base.KernelProvisionerBase.wait"]], "jupyter_path": [[6, "index-0"]], "environment variable": [[6, "index-0"]], "mycustomkernel (built-in class)": [[10, "MyCustomKernel"]], "mykernel (built-in class)": [[10, "MyKernel"]], "banner (mykernel attribute)": [[10, "MyKernel.banner"]], "do_complete() (mycustomkernel method)": [[10, "MyCustomKernel.do_complete"]], "do_execute() (mykernel method)": [[10, "MyKernel.do_execute"]], "do_history() (mycustomkernel method)": [[10, "MyCustomKernel.do_history"]], "do_inspect() (mycustomkernel method)": [[10, "MyCustomKernel.do_inspect"]], "do_is_complete() (mycustomkernel method)": [[10, "MyCustomKernel.do_is_complete"]], "do_shutdown() (mycustomkernel method)": [[10, "MyCustomKernel.do_shutdown"]], "implementation (mykernel attribute)": [[10, "MyKernel.implementation"]], "implementation_version (mykernel attribute)": [[10, "MyKernel.implementation_version"]], "language_info (mykernel attribute)": [[10, "MyKernel.language_info"]]}})