jupywire 0.1.0__tar.gz

jupywire-0.1.0/CHANGELOG.md

@@ -0,0 +1,8 @@
+<!-- do not remove -->
+
+## 0.1.0
+
+### New Features
+
+- init release ([#1](https://github.com/AnswerDotAI/jupywire/issues/1))
+

jupywire-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

jupywire-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+include CHANGELOG.md

jupywire-0.1.0/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: jupywire
+Version: 0.1.0
+Summary: Minimal Jupyter protocol commons: wire-format sessions and kernel-client call conventions
+Author-email: Jeremy Howard <github@jhoward.fastmail.fm>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/AnswerDotAI/jupywire
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastcore>=2.1.18
+Provides-Extra: dev
+Requires-Dist: fastship; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: jupyter_client>=8.0; extra == "dev"
+Dynamic: license-file
+
+# jupywire
+
+Minimal Jupyter protocol commons: wire-format sessions (message construction, HMAC signing, frame serialize/deserialize) and kernel-client call conventions, shared by kernmini, jupygate, jupyasyncclient, and conkernelclient.
+
+## What's here
+
+- `jupywire.session`: `Session` — Jupyter protocol messages: construction, HMAC signing, frame (de)serialization, replay protection — plus the websocket JSON/binary frame helpers (`dumps`/`loads`, `serialize_binary_message`/`deserialize_binary_message`) and `validate_string_dict`.
+- `jupywire.connect`: `write_connection_file` — kernel connection files with random free-port selection, written 0600.
+- `jupywire.ops`: `EvalOps` — a mixin giving any kernel client the calling conventions (`eval`, `ipy`, the `ipyfuncs` service methods, `xpush`/`retr`/`xenv`) over one abstract `reply` method supplied by the transport.
+
+## Install
+
+```bash
+pip install jupywire
+```
+
+
+## Credits
+
+`jupywire.session` and `jupywire.connect` are adapted from [jupyter_client](https://github.com/jupyter/jupyter_client) (`jupyter_client.session`, `jupyter_client.connect`, `jupyter_client.client`), Copyright (c) Jupyter Development Team, distributed under the terms of the Modified BSD License (BSD-3-Clause); see that project's COPYING.md.
+
+The adaptations are trimmed, traitlets-free mirrors that stay wire-compatible. Divergences are noted in each module's docstring.

jupywire-0.1.0/README.md

@@ -0,0 +1,22 @@
+# jupywire
+
+Minimal Jupyter protocol commons: wire-format sessions (message construction, HMAC signing, frame serialize/deserialize) and kernel-client call conventions, shared by kernmini, jupygate, jupyasyncclient, and conkernelclient.
+
+## What's here
+
+- `jupywire.session`: `Session` — Jupyter protocol messages: construction, HMAC signing, frame (de)serialization, replay protection — plus the websocket JSON/binary frame helpers (`dumps`/`loads`, `serialize_binary_message`/`deserialize_binary_message`) and `validate_string_dict`.
+- `jupywire.connect`: `write_connection_file` — kernel connection files with random free-port selection, written 0600.
+- `jupywire.ops`: `EvalOps` — a mixin giving any kernel client the calling conventions (`eval`, `ipy`, the `ipyfuncs` service methods, `xpush`/`retr`/`xenv`) over one abstract `reply` method supplied by the transport.
+
+## Install
+
+```bash
+pip install jupywire
+```
+
+
+## Credits
+
+`jupywire.session` and `jupywire.connect` are adapted from [jupyter_client](https://github.com/jupyter/jupyter_client) (`jupyter_client.session`, `jupyter_client.connect`, `jupyter_client.client`), Copyright (c) Jupyter Development Team, distributed under the terms of the Modified BSD License (BSD-3-Clause); see that project's COPYING.md.
+
+The adaptations are trimmed, traitlets-free mirrors that stay wire-compatible. Divergences are noted in each module's docstring.

jupywire-0.1.0/jupywire/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

jupywire-0.1.0/jupywire/connect.py

@@ -0,0 +1,55 @@
+"""Kernel connection files: `write_connection_file` with random free-port selection.
+
+Adapted from `jupyter_client.connect` (BSD-3-Clause, Copyright (c) Jupyter Development Team; see
+the Credits section of the README). Trimmed: no CurveZMQ key support, `ip` defaults to 127.0.0.1
+rather than probing local interfaces, and `secure_write` is inlined as an 0600 open.
+"""
+
+import json, os, socket, stat, tempfile
+
+
+def _secure_open(fname: str):
+    "Open `fname` for writing, created 0600 (the file carries the kernel's signing key)."
+    return os.fdopen(os.open(fname, os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600), "w")
+
+def write_connection_file(fname=None, shell_port=0, iopub_port=0, stdin_port=0, hb_port=0, control_port=0,
+    ip="", key=b"", transport="tcp", signature_scheme="hmac-sha256", kernel_name="", **kwargs) -> tuple[str, dict]:
+    "Write a Jupyter connection-file JSON dict to `fname` (0600), picking random free ports for any left 0; returns `(fname, cfg)`."
+    if not ip: ip = "127.0.0.1"
+    if not fname:
+        fd, fname = tempfile.mkstemp(".json")
+        os.close(fd)
+    ports, sockets = [], []
+    ports_needed = sum(int(p <= 0) for p in (shell_port, iopub_port, stdin_port, control_port, hb_port))
+    if transport == "tcp":
+        for _ in range(ports_needed):
+            sock = socket.socket()
+            sock.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, b"\0" * 8)  # 8 null bytes = struct.pack('ii', (0,0))
+            sock.bind((ip, 0))
+            sockets.append(sock)
+        for sock in sockets:
+            port = sock.getsockname()[1]
+            sock.close()
+            ports.append(port)
+    else:  # ipc: sequentially numbered paths that don't exist yet
+        N = 1
+        for _ in range(ports_needed):
+            while os.path.exists(f"{ip}-{N!s}"): N += 1
+            ports.append(N)
+            N += 1
+    if shell_port <= 0: shell_port = ports.pop(0)
+    if iopub_port <= 0: iopub_port = ports.pop(0)
+    if stdin_port <= 0: stdin_port = ports.pop(0)
+    if control_port <= 0: control_port = ports.pop(0)
+    if hb_port <= 0: hb_port = ports.pop(0)
+    cfg = dict(shell_port=shell_port, iopub_port=iopub_port, stdin_port=stdin_port, control_port=control_port,
+        hb_port=hb_port, ip=ip, key=key.decode(), transport=transport, signature_scheme=signature_scheme, kernel_name=kernel_name)
+    cfg.update(kwargs)
+    with _secure_open(fname) as f: f.write(json.dumps(cfg, indent=2))
+    if hasattr(stat, "S_ISVTX"):
+        # sticky-bit the parent dir, so only the owner can remove the file (EPERM etc suppressed: we may not own the dir)
+        runtime_dir = os.path.dirname(fname)
+        if runtime_dir:
+            try: os.chmod(runtime_dir, os.stat(runtime_dir).st_mode | stat.S_ISVTX)
+            except OSError: pass
+    return fname, cfg

jupywire-0.1.0/jupywire/ops.py

@@ -0,0 +1,91 @@
+"""Client-side call conventions for a Jupyter kernel: `eval`, `ipy`, and friends over one abstract `reply` seam.
+
+`EvalOps` is a mixin for kernel clients (conkernelclient's `ConKernelClient`, jupyasyncclient's
+`JupyAsyncKernelClient`): the inheritor supplies `reply(code, user_expressions=, timeout=,
+priority=, **kw)` awaiting its transport's `execute_reply` message, and gets the whole calling
+surface: `eval` (call a kernel-side function by name, result reconstructed by repr), `ipy`
+(`get_ipython()` methods), the generated `ipyfuncs` service methods, `xpush`/`retr`/`xenv`.
+`priority=` routes via a dedicated subshell: only hosts that create one set `self.priority`, and
+`reply` implementations assert otherwise. `_pre_ipy` is a liveness hook (default no-op).
+"""
+
+import asyncio
+from ast import literal_eval
+from fastcore.utils import rtoken_hex, nested_idx
+from fastcore.ansi import strip_ansi
+from fastcore.nbio import preferred_out
+
+class EvalException(Exception): pass
+
+_prims = str, int, float, complex, bool, tuple, list, dict, set, frozenset
+
+def try_eval(s, typ:str|None=None):
+    "Like `literal_eval`, but wraps in dynamic class named `typ` if succeeds, and returns `s` if fails"
+    try:
+        res = literal_eval(s)
+        if typ and isinstance(res, _prims): res = type(typ, (type(res),), {})(res)
+        return res
+    except: return s
+
+
+class EvalOps:
+    "Kernel-client calling conventions over the inheritor's `reply`: see the module docstring."
+    priority = None   # a subshell id for out-of-band evals; only hosts that create one (e.g. solveit) set it
+
+    def reply(self, code, user_expressions=None, timeout=None, priority=False, **kw):
+        "The transport seam: run `code`, returning an awaitable of the `execute_reply` message."
+        raise NotImplementedError
+
+    def _pre_ipy(self): pass   # liveness hook: transports may raise their dead-kernel error here
+
+    async def eval(self, func:str, *args, _timeout=60, _literal=True, _priority=False, _call=True, _msg_id=None, **kw):
+        "Result of running `func(*args, **kw)`"
+        if _priority: assert self.priority, 'no priority subshell configured'
+        vname = f'__{rtoken_hex(4)}'
+        if _call:
+            code = f'''import asyncio
+{vname} = {func}(*{args!r}, **{kw!r})
+if asyncio.iscoroutine({vname}): {vname} = await {vname}
+'''
+        else: code = f'{vname} = {func}'
+        exprs = dict(__res=vname, __typ=f"type({vname}).__name__", __del=f"globals().pop('{vname}', None)")
+        kw2 = dict(user_expressions=exprs, timeout=_timeout, store_history=False, priority=_priority)
+        if _msg_id is not None: kw2['msg_id'] = _msg_id
+        try: cts = (await self.reply(code, **kw2))['content']
+        except TimeoutError: return 'timeout'
+        except TypeError as e: raise EvalException(f"Eval failed: {e}")  # e.g. kernel not running
+        if cts['status']!='ok': return strip_ansi('\n'.join(cts.get('traceback', ['err'])))
+        typ = nested_idx(cts, 'user_expressions', '__typ', 'data', 'text/plain')
+        if typ: typ = typ.strip("'")
+        res = nested_idx(cts, 'user_expressions', '__res', 'data')
+        if not res: return res
+        res = preferred_out(res, html1st=False)[1]
+        try: return try_eval(res, typ) if _literal else res
+        except Exception as e: return str(e)
+
+    async def ipy(self, meth, *args, priority=False, timeout=5, **kwargs):
+        if not hasattr(self, '_ipylock'): self._ipylock = asyncio.Lock()
+        self._pre_ipy()
+        async with self._ipylock: return await self.eval('get_ipython().'+meth, _priority=priority, _timeout=timeout, *args, **kwargs)
+
+    async def xpush(self, priority=False, **kwargs): await self.reply(f'get_ipython().push({kwargs!r})', priority=priority)
+
+    async def retr(self, nm:str, priority=False):
+        "Retrieve a single variable value"
+        return await self.eval(nm, _call=False, _priority=priority, _timeout=60)
+
+    async def xenv(self, priority=False, **kw):
+        "Put all of `kw` in os.environ"
+        code = 'import os as __os\n'
+        code += '\n'.join(f'__os.environ[{k!r}]={str(v)!r}' for k,v in kw.items())
+        return await self.reply(code, priority=priority)
+
+
+def _mk_ipy(meth):
+    async def f(self, *args, priority=False, **kwargs): return await self.ipy(meth, *args, priority=priority, **kwargs)
+    f.__name__ = meth
+    setattr(EvalOps, meth, f)
+
+_ipy_funcs = ['user_items', 'get_vars', 'eval_exprs', 'get_schemas', 'publish', 'ranked_complete', 'sig_help']
+for o in _ipy_funcs: _mk_ipy(o)
+

jupywire-0.1.0/jupywire/session.py

@@ -0,0 +1,184 @@
+"""Jupyter wire-format sessions: message construction, HMAC signing, and (de)serialization.
+
+Adapted from `jupyter_client.session` (BSD-3-Clause, Copyright (c) Jupyter Development Team;
+see the Credits section of the README), trimmed to the surface this ecosystem needs and stripped
+of traitlets. Wire-compatible with jupyter_client: same frame layout (`<IDS|MSG>` delimiter, hex
+HMAC signature, header/parent/metadata/content JSON, raw buffer frames), same replay protection
+("Duplicate Signature"), same error strings. Deliberate simplifications, none of which change
+bytes on the wire: header dates stay ISO-8601 strings on deserialize (jupyter_client converts
+them to datetimes client-side); no v4-protocol adaptation (our kernels speak 5.3 only); no fork
+guard. Socket-facing `send`/`recv` live with the transports (kernmini's `MiniSession` subclass);
+the websocket JSON/binary helpers below are the frame layer jupygate's channel protocol uses.
+"""
+
+import hashlib, hmac, json, numbers, os, uuid
+from binascii import b2a_base64
+from collections.abc import Iterable
+from datetime import date, datetime, timezone
+from fastcore.basics import xdumps, revive_dates
+from fastcore.nbio import pack_frames, unpack_frames
+
+
+DELIM = b"<IDS|MSG>"
+protocol_version = "5.3"
+
+
+def utcnow() -> datetime: return datetime.now(timezone.utc)
+
+
+def json_default(obj):
+    "JSON serializer mirroring `jupyter_client.jsonutil.json_default`: ISO-8601 Z-suffix datetimes, b64 bytes, listified iterables, coerced numerics."
+    if isinstance(obj, datetime):
+        if obj.tzinfo is None: obj = obj.replace(tzinfo=timezone.utc)
+        return obj.isoformat().replace("+00:00", "Z")
+    if isinstance(obj, date): return obj.isoformat()
+    if isinstance(obj, bytes): return b2a_base64(obj, newline=False).decode("ascii")
+    if isinstance(obj, Iterable): return list(obj)
+    if isinstance(obj, numbers.Integral): return int(obj)
+    if isinstance(obj, numbers.Real): return float(obj)
+    raise TypeError(f"Object of type {type(obj).__name__} is not JSON serializable")
+
+
+def json_packer(obj) -> bytes:
+    return json.dumps(obj, default=json_default, ensure_ascii=False, allow_nan=False,
+        separators=(",", ":")).encode("utf8", errors="surrogateescape")
+
+
+def extract_header(msg_or_header: dict) -> dict:
+    "Given a message or header, return the header."
+    if not msg_or_header: return {}
+    if "header" in msg_or_header: return msg_or_header["header"]
+    if "msg_id" in msg_or_header: return msg_or_header
+    raise KeyError("no header found")
+
+
+def _bytes(m) -> bytes:
+    "A frame as bytes, whether it arrived as bytes or a non-copying frame (e.g. zmq.Frame), without importing any transport."
+    return m if isinstance(m, bytes) else m.bytes
+
+
+class Session:
+    "Build, sign, serialize, and deserialize Jupyter protocol messages over one session identity."
+
+    def __init__(self, key: bytes | None = None, signature_scheme: str = "hmac-sha256", username: str = "",
+        session: str | None = None, digest_history_size: int = 2**16):
+        self.session = session or str(uuid.uuid4())
+        self.username = username or os.environ.get("USER", "username")
+        self.metadata = {}
+        if key is None: key = uuid.uuid4().hex.encode("ascii")  # jupyter_client parity: a fresh random key when unspecified
+        if key:
+            if not signature_scheme.startswith("hmac-"): raise ValueError(f"unsupported signature scheme: {signature_scheme!r}")
+            digest = signature_scheme.removeprefix("hmac-")
+            if digest not in hashlib.algorithms_available: raise ValueError(f"unsupported digest: {digest!r}")
+            self.auth = hmac.HMAC(key, digestmod=getattr(hashlib, digest))
+        else: self.auth = None
+        self.digest_history = set()
+        self.digest_history_size = digest_history_size
+        self.message_count = 0
+        self.pack, self.unpack = json_packer, json.loads
+
+    @property
+    def msg_id(self) -> str:
+        n = self.message_count
+        self.message_count += 1
+        return f"{self.session}_{os.getpid()}_{n}"
+
+    @property
+    def bsession(self) -> bytes: return self.session.encode("ascii")
+
+    def msg_header(self, msg_type: str) -> dict:
+        return dict(msg_id=self.msg_id, msg_type=msg_type, username=self.username, session=self.session,
+            date=utcnow(), version=protocol_version)
+
+    def msg(self, msg_type: str, content: dict | None = None, parent: dict | None = None,
+        header: dict | None = None, metadata: dict | None = None) -> dict:
+        "Return the nested message dict (the pre-wire form; `serialize` makes the frame list)."
+        header = self.msg_header(msg_type) if header is None else header
+        parent_h = {} if parent is None else extract_header(parent)
+        msg = dict(header=header, msg_id=header["msg_id"], msg_type=header["msg_type"], parent_header=parent_h,
+            content=content or {}, metadata=self.metadata.copy())
+        if metadata is not None: msg["metadata"].update(metadata)
+        return msg
+
+    def sign(self, msg_list: list) -> bytes:
+        "Hex HMAC digest of the [p_header,p_parent,p_metadata,p_content] frames; b'' when unauthenticated."
+        if self.auth is None: return b""
+        h = self.auth.copy()
+        for m in msg_list: h.update(_bytes(m))
+        return h.hexdigest().encode()
+
+    def serialize(self, msg: dict, ident: list[bytes] | bytes | None = None) -> list[bytes]:
+        "Frame list [ident..., DELIM, signature, p_header, p_parent, p_metadata, p_content] for `msg`."
+        content = msg.get("content", {})
+        if content is None: content = self.pack({})
+        elif isinstance(content, dict): content = self.pack(content)
+        elif isinstance(content, str): content = content.encode("utf8")
+        elif not isinstance(content, bytes): raise TypeError(f"content incorrect type: {type(content)}")
+        real_message = [self.pack(msg["header"]), self.pack(msg["parent_header"]), self.pack(msg["metadata"]), content]
+        to_send = list(ident) if isinstance(ident, list) else [ident] if ident is not None else []
+        to_send.append(DELIM)
+        to_send.append(self.sign(real_message))
+        to_send.extend(real_message)
+        return to_send
+
+    def feed_identities(self, msg_list: list, copy: bool = True) -> tuple[list[bytes], list]:
+        "Split a received frame list at DELIM into (idents, remainder)."
+        for idx, m in enumerate(msg_list):
+            if _bytes(m) == DELIM: return [bytes(_bytes(i)) for i in msg_list[:idx]], msg_list[idx + 1:]
+        raise ValueError("DELIM not in msg_list")
+
+    def _add_digest(self, signature: bytes):
+        if self.digest_history_size == 0: return
+        self.digest_history.add(signature)
+        if len(self.digest_history) > self.digest_history_size:
+            import random
+            to_cull = random.sample(tuple(sorted(self.digest_history)), len(self.digest_history) // 10)
+            self.digest_history.difference_update(to_cull)
+
+    def deserialize(self, msg_list: list, content: bool = True, copy: bool = True) -> dict:
+        "Verify signature and unpack a [signature, p_header, p_parent, p_metadata, p_content, buffer...] frame list."
+        msg_list = [_bytes(m) for m in msg_list[:5]] + list(msg_list[5:])
+        if self.auth is not None:
+            signature = msg_list[0]
+            if not signature: raise ValueError("Unsigned Message")
+            if signature in self.digest_history: raise ValueError("Duplicate Signature: %r" % signature)
+            if content: self._add_digest(signature)  # only record when unpacking, not peeking
+            if not hmac.compare_digest(signature, self.sign(msg_list[1:5])): raise ValueError("Invalid Signature: %r" % signature)
+        if len(msg_list) < 5: raise TypeError("malformed message, must have at least 5 elements")
+        header = self.unpack(msg_list[1])
+        content_v = self.unpack(msg_list[4]) if content else msg_list[4]
+        bufs = [memoryview(_bytes(b)) for b in msg_list[5:]]
+        return dict(header=header, msg_id=header["msg_id"], msg_type=header["msg_type"], parent_header=self.unpack(msg_list[2]),
+            metadata=self.unpack(msg_list[3]), content=content_v, buffers=bufs)
+
+
+def dumps(msg): return xdumps(msg)
+
+def loads(s: str):
+    msg = json.loads(s)
+    if isinstance(msg, dict):
+        for k in ("header", "parent_header"):
+            if isinstance(msg.get(k), dict): msg[k] = revive_dates(msg[k])
+    return msg
+
+
+def serialize_binary_message(msg):
+    msg = msg.copy()
+    buffers = msg.pop("buffers")
+    return pack_frames(dumps(msg).encode("utf8"), buffers)
+
+
+def deserialize_binary_message(bmsg: bytes):
+    body, bufs = unpack_frames(bmsg)
+    msg = loads(body.decode("utf8"))
+    msg["buffers"] = [memoryview(b) for b in bufs]
+    return msg
+
+
+def validate_string_dict(dct: dict[str, str]) -> None:
+    """Validate that the input is a dict with string keys and values.
+
+    Raises ValueError if not."""
+    for k, v in dct.items():
+        if not isinstance(k, str): raise ValueError("key %r in dict must be a string" % k)
+        if not isinstance(v, str): raise ValueError("value %r in dict must be a string" % v)

jupywire-0.1.0/jupywire.egg-info/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: jupywire
+Version: 0.1.0
+Summary: Minimal Jupyter protocol commons: wire-format sessions and kernel-client call conventions
+Author-email: Jeremy Howard <github@jhoward.fastmail.fm>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/AnswerDotAI/jupywire
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastcore>=2.1.18
+Provides-Extra: dev
+Requires-Dist: fastship; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: jupyter_client>=8.0; extra == "dev"
+Dynamic: license-file
+
+# jupywire
+
+Minimal Jupyter protocol commons: wire-format sessions (message construction, HMAC signing, frame serialize/deserialize) and kernel-client call conventions, shared by kernmini, jupygate, jupyasyncclient, and conkernelclient.
+
+## What's here
+
+- `jupywire.session`: `Session` — Jupyter protocol messages: construction, HMAC signing, frame (de)serialization, replay protection — plus the websocket JSON/binary frame helpers (`dumps`/`loads`, `serialize_binary_message`/`deserialize_binary_message`) and `validate_string_dict`.
+- `jupywire.connect`: `write_connection_file` — kernel connection files with random free-port selection, written 0600.
+- `jupywire.ops`: `EvalOps` — a mixin giving any kernel client the calling conventions (`eval`, `ipy`, the `ipyfuncs` service methods, `xpush`/`retr`/`xenv`) over one abstract `reply` method supplied by the transport.
+
+## Install
+
+```bash
+pip install jupywire
+```
+
+
+## Credits
+
+`jupywire.session` and `jupywire.connect` are adapted from [jupyter_client](https://github.com/jupyter/jupyter_client) (`jupyter_client.session`, `jupyter_client.connect`, `jupyter_client.client`), Copyright (c) Jupyter Development Team, distributed under the terms of the Modified BSD License (BSD-3-Clause); see that project's COPYING.md.
+
+The adaptations are trimmed, traitlets-free mirrors that stay wire-compatible. Divergences are noted in each module's docstring.

jupywire-0.1.0/jupywire.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+CHANGELOG.md
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+jupywire/__init__.py
+jupywire/connect.py
+jupywire/ops.py
+jupywire/session.py
+jupywire.egg-info/PKG-INFO
+jupywire.egg-info/SOURCES.txt
+jupywire.egg-info/dependency_links.txt
+jupywire.egg-info/requires.txt
+jupywire.egg-info/top_level.txt
+tests/test_session.py

jupywire-0.1.0/jupywire.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

jupywire-0.1.0/jupywire.egg-info/requires.txt

@@ -0,0 +1,8 @@
+fastcore>=2.1.18
+
+[dev]
+fastship
+build
+twine
+pytest
+jupyter_client>=8.0

jupywire-0.1.0/jupywire.egg-info/top_level.txt

@@ -0,0 +1 @@
+jupywire

jupywire-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "jupywire"
+dynamic = ["version"]
+description = "Minimal Jupyter protocol commons: wire-format sessions and kernel-client call conventions"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Apache-2.0" }
+authors = [{name = "Jeremy Howard", email = "github@jhoward.fastmail.fm"}]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+]
+
+dependencies = ['fastcore>=2.1.18']
+
+[project.optional-dependencies]
+dev = [
+  "fastship",
+  "build",
+  "twine",
+  "pytest",
+  "jupyter_client>=8.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/AnswerDotAI/jupywire"
+
+[tool.setuptools.dynamic]
+version = { attr = "jupywire.__version__" }
+
+[tool.setuptools.packages.find]
+include = ["jupywire"]

jupywire-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

jupywire-0.1.0/tests/test_session.py

@@ -0,0 +1,128 @@
+"Wire-format tests, cross-verified against jupyter_client (dev dep): same bytes, same signatures, same errors."
+import json, os, stat
+from datetime import datetime, timezone, date
+
+import pytest
+from jupyter_client.session import Session as JCSession
+
+from jupywire.session import (Session, json_default, json_packer, serialize_binary_message,
+    deserialize_binary_message, validate_string_dict, dumps, loads, DELIM)
+from jupywire.connect import write_connection_file
+
+KEY = b"secret-key"
+
+def _wire(sess, msg, ident=None):
+    frames = sess.serialize(msg, ident=ident)
+    idents, rest = sess.feed_identities(frames)
+    return idents, list(rest)
+
+def test_sign_matches_jupyter_client():
+    s, jc = Session(key=KEY), JCSession(key=KEY)
+    frames = [b'{"a":1}', b'{}', b'{}', b'{"code":"6*7"}']
+    assert s.sign(frames) == jc.sign(frames)
+    assert Session(key=b"").sign(frames) == b""
+
+
+def test_roundtrip_via_jupyter_client():
+    s, jc = Session(key=KEY, session="abc"), JCSession(key=KEY, session="abc")
+    msg = s.msg("execute_request", dict(code="6*7", silent=False))
+    wire = s.serialize(msg)
+    assert wire[0] == DELIM
+    idents, rest = jc.feed_identities(wire)
+    got = jc.deserialize(rest)
+    assert got["content"] == msg["content"] and got["msg_type"] == "execute_request"
+    # and the reverse: jupyter_client-built frames verify and unpack here
+    jmsg = jc.msg("kernel_info_request")
+    idents, rest = s.feed_identities(jc.serialize(jmsg))
+    got = s.deserialize(rest)
+    assert got["msg_id"] == jmsg["header"]["msg_id"]
+
+
+
+def test_json_default_parity():
+    from jupyter_client.jsonutil import json_default as jc_default
+    aware = datetime(2026, 1, 2, 3, 4, 5, tzinfo=timezone.utc)
+    for v in (aware, date(2026, 1, 2), b"some bytes", {1, 2, 3}): assert json_default(v) == jc_default(v)
+    naive = datetime(2026, 1, 2, 3, 4, 5)
+    assert json_default(naive) == "2026-01-02T03:04:05Z"  # naive treated as UTC (jupyter_client's local-time reading is deprecated)
+    with pytest.raises(TypeError): json_default(object())
+    assert json.loads(json_packer(dict(b=b"xy", t=aware)).decode()) == json.loads(
+        json.dumps(dict(b=b"xy", t=aware), default=jc_default))
+
+
+def test_default_key_is_random_like_jupyter_client():
+    a, b = Session(), Session()
+    assert a.auth is not None and b.auth is not None
+    assert a.sign([b"x"]) != b.sign([b"x"])
+    assert Session(session="abc").bsession == b"abc"
+
+
+def test_binary_message_roundtrip():
+    s = Session(key=KEY)
+    msg = s.msg("display_data", dict(data={"text/plain": "hi"}))
+    msg["buffers"] = [b"bufone", b"buftwo"]
+    got = deserialize_binary_message(serialize_binary_message(msg))
+    assert got["content"] == msg["content"]
+    assert [bytes(b) for b in got["buffers"]] == [b"bufone", b"buftwo"]
+    assert loads(dumps(s.msg("status", dict(execution_state="idle"))))["content"]["execution_state"] == "idle"
+
+
+def test_validate_string_dict():
+    validate_string_dict(dict(a="b"))
+    with pytest.raises(ValueError): validate_string_dict({"a": 1})
+    with pytest.raises(ValueError): validate_string_dict({1: "a"})
+
+
+def test_write_connection_file(tmp_path):
+    fname = str(tmp_path/"kernel.json")
+    fname2, cfg = write_connection_file(fname, ip="127.0.0.1", key=b"deadbeef")
+    assert fname2 == fname and os.path.exists(fname)
+    assert stat.S_IMODE(os.stat(fname).st_mode) == 0o600
+    on_disk = json.loads(open(fname).read())
+    ports = [cfg[k] for k in ("shell_port", "iopub_port", "stdin_port", "control_port", "hb_port")]
+    assert len(set(ports)) == 5 and all(p > 0 for p in ports)
+    assert on_disk == cfg
+    assert cfg["key"] == "deadbeef" and cfg["transport"] == "tcp" and cfg["ip"] == "127.0.0.1"
+    from jupyter_client.connect import write_connection_file as jc_wcf
+    _, jc_cfg = jc_wcf(str(tmp_path/"jc.json"), ip="127.0.0.1", key=b"deadbeef")
+    assert set(cfg) == set(jc_cfg)
+
+
+def test_content_coercions():
+    "Bytes b64-encode, dates ISO-format, and iterables listify at pack time, as jupyter_client does (image display bundles rely on this)"
+    from binascii import b2a_base64
+    from datetime import date
+    s = Session(key=b"k")
+    png = b"\x89PNG fake bytes"
+    msg = s.msg("display_data", dict(data={"image/png": png}, when=date(2026, 8, 4), tags={"a"}))
+    _, rest = _wire(s, msg)
+    c = s.deserialize(rest)["content"]
+    assert c["data"]["image/png"] == b2a_base64(png, newline=False).decode("ascii")
+    assert c["when"] == "2026-08-04"
+    assert c["tags"] == ["a"]
+    jcs = pytest.importorskip("jupyter_client.session")
+    js = jcs.Session(key=b"k")
+    _, jrest = js.feed_identities(js.serialize(js.msg("display_data", msg["content"])))
+    assert js.deserialize(jrest)["content"] == c
+
+
+def test_replay_tamper_unsigned():
+    s = Session(key=b"secret")
+    _, rest = _wire(s, s.msg("a_request", dict(x=1)))
+    s.deserialize(list(rest))
+    with pytest.raises(ValueError, match="Duplicate Signature"): s.deserialize(list(rest))
+    bad = list(rest)
+    bad[0], bad[4] = b"0" * len(bad[0]), b'{"x":2}'
+    with pytest.raises(ValueError, match="Invalid Signature"): s.deserialize(bad)
+    with pytest.raises(ValueError, match="Unsigned Message"): s.deserialize([b""] + list(rest)[1:])
+
+
+def test_parent_and_buffers():
+    s = Session(key=b"k")
+    parent = s.msg("a_request", {})
+    reply = s.msg("a_reply", dict(status="ok"), parent=parent)
+    frames = s.serialize(reply) + [b"rawbuf"]
+    _, rest = s.feed_identities(frames)
+    out = s.deserialize(rest)
+    assert out["parent_header"]["msg_id"] == parent["header"]["msg_id"]
+    assert bytes(out["buffers"][0]) == b"rawbuf"