kernmini 0.1.0__tar.gz

kernmini-0.1.0/CHANGELOG.md

@@ -0,0 +1,8 @@
+<!-- do not remove -->
+
+## 0.1.0
+
+### New Features
+
+- Init release
+

kernmini-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.

kernmini-0.1.0/MANIFEST.in

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

kernmini-0.1.0/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: kernmini
+Version: 0.1.0
+Summary: Everything a Jupyter kernel needs except the language
+Author-email: Jeremy Howard <github@jhoward.fastmail.fm>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/AnswerDotAI/kernmini
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyzmq>=25.1
+Requires-Dist: microio>=0.1.2
+Requires-Dist: watchpid>=0.1.0
+Requires-Dist: fastcore>=2.1.6
+Requires-Dist: jupywire>=0.0.1
+Provides-Extra: dev
+Requires-Dist: fastship; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# kernmini
+
+Everything a Jupyter kernel needs except the language.
+
+kernmini is the language-agnostic core of a Jupyter kernel: connection files, HMAC-signed wire sessions, the full socket thread cast (shell/control async routers, IOPub with a bounded queue and JEP 65 welcomes, stdin routing, heartbeat), busy/idle and abort discipline, stop-on-error, interrupts, JEP 91 subshells, kernelspec installation, and process lifecycle (signal handling, process-group isolation and teardown, parent-watch crash safety). A kernel author supplies only an executor (the *shell*) and gets a correct, tested kernel around it.
+
+[ipymini](https://github.com/AnswerDotAI/ipymini) is the reference kernel (IPython). Its integration suite is kernmini's main proving ground.
+
+## A complete kernel
+
+```python
+from contextlib import contextmanager
+from kernmini import run_kernel
+
+class EchoShell:
+    def __init__(self, request_input=None, **kw): self.execution_count,self._stream = 0,None
+
+    def set_stream_sender(self, sender): self._stream = sender
+
+    @contextmanager
+    def execution_context(self, allow_stdin, silent): yield
+
+    def kernel_info(self):
+        return dict(implementation="echokernel", implementation_version="0.0.1", banner="echo",
+            language_info=dict(name="echo", version="1.0", mimetype="text/plain", file_extension=".txt"))
+
+    async def execute(self, code, silent=False, store_history=True, user_expressions=None, allow_stdin=False):
+        self.execution_count += 1
+        if self._stream: self._stream("stdout", f"echo: {code}\n")
+        return dict(execution_count=self.execution_count, result={"text/plain": code.upper()})
+
+run_kernel(connection_file, EchoShell, subshells=False)
+```
+
+That's the whole kernel. Every Jupyter client (JupyterLab, nbclient, jupygate, ...) can now launch it, execute against it, stream its output, and interrupt and shut it down. `kernmini.install_kernelspec(name, argv, display_name, language)` registers it with Jupyter.
+
+The shell contract is documented in `DEV.md`. Beyond the four members above, everything is opt-in by capability: implement `complete`/`inspect`/`is_complete`/`history` for language services, `debug_request` for a DAP debugger, `interrupt` for language-specific sync interruption, `bind_kernel` for a backref, and pass `subshells=True` when the shell supports concurrent instances.
+
+## Install
+
+```bash
+pip install kernmini
+```

kernmini-0.1.0/README.md

@@ -0,0 +1,43 @@
+# kernmini
+
+Everything a Jupyter kernel needs except the language.
+
+kernmini is the language-agnostic core of a Jupyter kernel: connection files, HMAC-signed wire sessions, the full socket thread cast (shell/control async routers, IOPub with a bounded queue and JEP 65 welcomes, stdin routing, heartbeat), busy/idle and abort discipline, stop-on-error, interrupts, JEP 91 subshells, kernelspec installation, and process lifecycle (signal handling, process-group isolation and teardown, parent-watch crash safety). A kernel author supplies only an executor (the *shell*) and gets a correct, tested kernel around it.
+
+[ipymini](https://github.com/AnswerDotAI/ipymini) is the reference kernel (IPython). Its integration suite is kernmini's main proving ground.
+
+## A complete kernel
+
+```python
+from contextlib import contextmanager
+from kernmini import run_kernel
+
+class EchoShell:
+    def __init__(self, request_input=None, **kw): self.execution_count,self._stream = 0,None
+
+    def set_stream_sender(self, sender): self._stream = sender
+
+    @contextmanager
+    def execution_context(self, allow_stdin, silent): yield
+
+    def kernel_info(self):
+        return dict(implementation="echokernel", implementation_version="0.0.1", banner="echo",
+            language_info=dict(name="echo", version="1.0", mimetype="text/plain", file_extension=".txt"))
+
+    async def execute(self, code, silent=False, store_history=True, user_expressions=None, allow_stdin=False):
+        self.execution_count += 1
+        if self._stream: self._stream("stdout", f"echo: {code}\n")
+        return dict(execution_count=self.execution_count, result={"text/plain": code.upper()})
+
+run_kernel(connection_file, EchoShell, subshells=False)
+```
+
+That's the whole kernel. Every Jupyter client (JupyterLab, nbclient, jupygate, ...) can now launch it, execute against it, stream its output, and interrupt and shut it down. `kernmini.install_kernelspec(name, argv, display_name, language)` registers it with Jupyter.
+
+The shell contract is documented in `DEV.md`. Beyond the four members above, everything is opt-in by capability: implement `complete`/`inspect`/`is_complete`/`history` for language services, `debug_request` for a DAP debugger, `interrupt` for language-specific sync interruption, `bind_kernel` for a backref, and pass `subshells=True` when the shell supports concurrent instances.
+
+## Install
+
+```bash
+pip install kernmini
+```

kernmini-0.1.0/kernmini/__init__.py

@@ -0,0 +1,17 @@
+"""Everything a Jupyter kernel needs except the language.
+
+kernmini is the language-agnostic core of a Jupyter kernel: connection files, HMAC-signed wire
+sessions, the socket thread cast (shell/control routers, IOPub, stdin, heartbeat), busy/idle and
+abort discipline, interrupts, subshells (JEP 91), and process lifecycle. A kernel supplies a
+*shell*: an execution layer built by the `shell_factory` passed to `MiniKernel`/`run_kernel`.
+See DEV.md for the shell contract; `ipymini` is the reference implementation (IPython), and a
+minimal shell needs only `execute`, `execution_count`, `execution_context`, and
+`set_stream_sender`.
+"""
+
+__version__ = "0.1.0"
+
+from .kernel import MiniKernel, run_kernel
+from .session import MiniSession
+from .concur import unlock, subshell
+from .kernelspec import install_kernelspec, install_kernelspec_dir

kernmini-0.1.0/kernmini/concur.py

@@ -0,0 +1,30 @@
+"In-cell opt-ins for concurrent execution: unlock() and subshell()."
+
+import contextvars
+from contextlib import contextmanager
+
+_release = contextvars.ContextVar("kernmini_release", default=None)
+_subshell = contextvars.ContextVar("kernmini_subshell", default=None)
+
+
+def unlock()->bool:
+    "Let queued shell messages run while the current cell awaits; irreversible for the rest of the cell."
+    release = _release.get()
+    if release is None: return False
+    release()
+    return True
+
+
+@contextmanager
+def subshell():
+    "Run execute_requests arriving from this cell's client session in a fresh subshell while the body runs."
+    sub = _subshell.get()
+    if sub is None: raise RuntimeError("subshell() only works inside a cell running under a kernmini kernel")
+    subs = sub.kernel.subshells
+    session = ((sub.kernel.current_parent() or {}).get("header") or {}).get("session")
+    sid = subs.create()
+    try:
+        subs.set_route_override(sid, session)
+        try: yield sid
+        finally: subs.clear_route_override()
+    finally: subs.delete(sid)

kernmini-0.1.0/kernmini/debug.py

@@ -0,0 +1,81 @@
+"Debug infrastructure for kernels: env flags, logging/faulthandler setup, message tracing, and debugger cell-filename hashing."
+
+import faulthandler, logging, os, signal, sys, tempfile
+from dataclasses import dataclass
+
+
+def envbool(name: str) -> bool:
+    v = (os.environ.get(name) or "").strip().lower()
+    return v not in ("", "0", "false", "no")
+
+
+@dataclass(frozen=True)
+class DebugFlags:
+    enabled: bool = False
+    trace_msgs: bool = False
+
+    @classmethod
+    def from_env(cls, prefix: str = "KERNMINI") -> "DebugFlags": return cls(enabled=envbool(f"{prefix}_DEBUG"), trace_msgs=envbool(f"{prefix}_DEBUG_MSGS"))
+
+
+def setup_debug(flags: DebugFlags):
+    "Initialize debug infrastructure: logging, faulthandler, SIGUSR1 handler."
+    if not flags.enabled: return
+    root = logging.getLogger()
+    fmt = "%(asctime)s %(levelname)s %(name)s: %(message)s"
+    if not root.handlers: logging.basicConfig(level=logging.DEBUG, stream=sys.__stderr__, format=fmt)
+    faulthandler.enable(file=sys.__stderr__)
+    if hasattr(signal, "SIGUSR1"): faulthandler.register(signal.SIGUSR1, file=sys.__stderr__)
+
+
+def trace_msg(logger, prefix: str, msg: dict, *, enabled: bool = True):
+    "Log message flow at high level: msg_type, msg_id, subshell_id."
+    if not enabled: return
+    h = msg.get("header") or {}
+    logger.warning("%s type=%s id=%s subshell=%r", prefix, h.get("msg_type"), h.get("msg_id"), h.get("subshell_id"))
+
+
+def murmur2_x86(data: str, seed: int) -> int:
+    "Return Murmur2 x86 hash of UTF-8 `data` with `seed`."
+    m = 0x5BD1E995
+    data_bytes = data.encode("utf-8")
+    length = len(data_bytes)
+    h = seed ^ length
+    rounded_end = length & 0xFFFFFFFC
+    for i in range(0, rounded_end, 4):
+        k = int.from_bytes(data_bytes[i : i + 4], "little")
+        k = (k * m) & 0xFFFFFFFF
+        k ^= k >> 24
+        k = (k * m) & 0xFFFFFFFF
+
+        h = (h * m) & 0xFFFFFFFF
+        h ^= k
+
+    val = length & 0x03
+    k = 0
+    if val >= 3: k = data_bytes[rounded_end + 2] << 16
+    if val >= 2: k |= data_bytes[rounded_end + 1] << 8
+    if val >= 1:
+        k |= data_bytes[rounded_end]
+        h ^= k
+        h = (h * m) & 0xFFFFFFFF
+
+    h ^= h >> 13
+    h = (h * m) & 0xFFFFFFFF
+    h ^= h >> 15
+    return h
+
+
+DEBUG_HASH_SEED = 0xC70F6907
+
+
+def debug_tmp_directory() -> str: return os.path.join(tempfile.gettempdir(), f"kernmini_{os.getpid()}")
+
+
+def debug_cell_filename(code: str, ext: str = ".py") -> str:
+    "Compute debug cell filename (hash matches ipykernel's scheme, so frontends map breakpoints); respects KERNMINI_CELL_NAME."
+    cell_name = os.environ.get("KERNMINI_CELL_NAME")
+    if cell_name is None:
+        name = murmur2_x86(code, DEBUG_HASH_SEED)
+        cell_name = os.path.join(debug_tmp_directory(), f"{name}{ext}")
+    return cell_name