async-kernel 0.18.3__tar.gz → 0.19.0__tar.gz

{async_kernel-0.18.3 → async_kernel-0.19.0}/.github/workflows/ci.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Type checking with basedpyright
         run: |
           uv sync
-          uvx basedpyright@1.39.3
+          uvx basedpyright@1.39.6
 
   test:
     needs: type-checking
@@ -47,8 +47,7 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v7
         with:
-          enable-cache: true
-          version: "0.9.26"
+          version-file: "pyproject.toml"
           python-version: ${{ matrix.python-version }}
 
       - name: Install the project
@@ -73,8 +72,7 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v7
         with:
-          enable-cache: true
-          version: "0.9.26"
+          version-file: "pyproject.toml"
           python-version: "3.13"
 
       - name: Run tests with coverage
@@ -103,12 +101,11 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v7
         with:
-          enable-cache: true
-          version: "0.9.26"
+          version-file: "pyproject.toml"
 
       - name: Docs build strict
         timeout-minutes: 5
         run: |
           uv sync --group docs
-          uv run async-kernel -a async-docs --shell.timeout=1
+          uv run async-kernel install --name=async-docs --timeout=1
           uv run mkdocs build -s

{async_kernel-0.18.3 → async_kernel-0.19.0}/.github/workflows/new_release.yml

@@ -33,8 +33,7 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v7
         with:
-          enable-cache: true
-          version: "0.9.26"
+          version-file: "pyproject.toml"
 
       - name: Create a new branch, generate the changelog and release notes.
         run: |

{async_kernel-0.18.3 → async_kernel-0.19.0}/.github/workflows/publish-docs.yml

@@ -29,8 +29,7 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v7
         with:
-          enable-cache: true
-          version: "0.9.26"
+          version-file: "pyproject.toml"
 
       - name: Checkout
         uses: actions/checkout@v6
@@ -40,7 +39,7 @@ jobs:
       - name: Install the project
         run: |
           uv sync --group docs
-          uv run async-kernel -a async-docs --shell.timeout=1    # The 'async-docs' kernel is specified as the kernel for mkdocs-jupyter
+          uv run async-kernel install --name=async-docs --timeout=1    # The 'async-docs' kernel is specified as the kernel for mkdocs-jupyter
 
       - name: Version info
         id: version

{async_kernel-0.18.3 → async_kernel-0.19.0}/.github/workflows/publish-to-pypi.yml

@@ -33,8 +33,7 @@ jobs:
           ref: main
       - uses: astral-sh/setup-uv@v7
         with:
-          enable-cache: true
-          version: "0.9.26"
+          version-file: "pyproject.toml"
 
       - name: Build a binary wheel and a source tarball
         run: uv build

{async_kernel-0.18.3 → async_kernel-0.19.0}/.gitignore

@@ -13,3 +13,4 @@ data_kernelspec
 .pytest_cache
 _version.py
 release_notes.md
+.venv

{async_kernel-0.18.3 → async_kernel-0.19.0}/CHANGELOG.md

@@ -5,12 +5,38 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.19.0] - 2026-05-26
+
+### <!-- 0 --> 🏗️ Breaking changes
+
+- Add support for traitlets configuration with major refactoring. [#469](https://github.com/fleming79/async-kernel/pull/469)
+
+- Rename kernel_name to name [#459](https://github.com/fleming79/async-kernel/pull/459)
+
+### <!-- 1 --> 🚀 Features
+
+- Add timeout to PendingGroup and shield to Caller.wait. [#471](https://github.com/fleming79/async-kernel/pull/471)
+
+- Improve Kernel subclassing [#460](https://github.com/fleming79/async-kernel/pull/460)
+
+### <!-- 6 --> 🌀 Miscellaneous
+
+- Bump uv and basedpyright [#470](https://github.com/fleming79/async-kernel/pull/470)
+
+- Add message to task.cancel in task_factory [#461](https://github.com/fleming79/async-kernel/pull/461)
+
+- Linting [#458](https://github.com/fleming79/async-kernel/pull/458)
+
 ## [0.18.3] - 2026-05-06
 
 ### <!-- 1 --> 🚀 Features
 
 - Include default argument in pack_json_bytes  and pack_json_str. [#456](https://github.com/fleming79/async-kernel/pull/456)
 
+### <!-- 6 --> 🌀 Miscellaneous
+
+- Prepare for release v0.18.3 [#457](https://github.com/fleming79/async-kernel/pull/457)
+
 ## [0.18.2] - 2026-05-03
 
 ### <!-- 2 --> 🐛 Fixes
@@ -1283,6 +1309,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Bump the actions group across 1 directory with 2 updates [#3](https://github.com/fleming79/async-kernel/pull/3)
 
+[0.19.0]: https://github.com/fleming79/async-kernel/compare/v0.18.3..v0.19.0
 [0.18.3]: https://github.com/fleming79/async-kernel/compare/v0.18.2..v0.18.3
 [0.18.2]: https://github.com/fleming79/async-kernel/compare/v0.18.1..v0.18.2
 [0.18.1]: https://github.com/fleming79/async-kernel/compare/v0.18.0..v0.18.1

{async_kernel-0.18.3 → async_kernel-0.19.0}/CONTRIBUTING.md

@@ -25,7 +25,7 @@ Additional steps to build documentation (optional):
 
 ```bash
 uv sync --group docs
-uv run async-kernel -a async-docs --main_shell.timeout=1
+uv run async-kernel install --name=async-docs --timeout=1
 ```
 
 ### Running tests
@@ -100,7 +100,7 @@ The 'docs' group specified extra packages are required to build documentation.
 
 ```bash
 uv sync --group docs
-uv run async-kernel -a async-docs --main_shell.timeout=1
+uv run async-kernel install --name=async-docs --timeout=1
 ```
 
 #### Test the docs
@@ -114,10 +114,10 @@ uv run mkdocs build -s
     The command:
 
     ```bash
-    uv run async-kernel -a async-docs --main_shell.timeout=1
+    uv run async-kernel install --name=async-docs --timeout=1
     ```
 
-    Defines a new kernel spec with the name "async-docs" that sets the `shell.timeout` to 100ms.
+    Defines a new kernel spec with the name "async-docs" that sets the `timeout` to 1s.
 
     The "async-docs" named kernel spec is used by [mkdocs-jupyter](#notebooks) to convert the notebooks
     for inclusion in the usage section of the documentation.

{async_kernel-0.18.3 → async_kernel-0.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: async-kernel
-Version: 0.18.3
+Version: 0.19.0
 Summary: A concurrent python kernel for Jupyter supporting AnyIO, AsyncIO and Trio.
 Project-URL: Homepage, https://fleming79.github.io/async-kernel
 Project-URL: Documentation, https://fleming79.github.io/async-kernel
@@ -155,56 +155,20 @@ await event
 pip install async-kernel
 ```
 
-## Kernel specs
+## Kernelspecs
 
-A kernel spec with the name 'async' is added when async-kernel is installed.
+A kernelspec with the name 'async' is added when async-kernel is installed.
 
-Kernel specs can be added/removed via the command line.
-
-### Backends
-
-The backend set on the interface is the asynchronous library the kernel uses for message handling.
-It is also the asynchronous library directly available when executing code in cells or via a console[^3].
-
-[^3]:
-    Irrespective of the configured backend, functions/coroutines can be executed using a specific backend
-    with the method [`call_using_backend`](https://fleming79.github.io/async-kernel/latest/reference/caller/#async_kernel.caller.Caller.call_using_backend).
-
-#### Example - overwrite the 'async' kernel spec to use a trio backend
-
-```bash
-pip install trio
-async-kernel -a async --interface.backend=trio
-```
-
-### Gui event loop
-
-The kernel can be started with a gui event loop as the _host_ and the _backend_ running as a guest.
-
-#### asyncio backend
-
-```bash
-# tk
-async-kernel -a async-tk --interface.host=tk
-
-# qt
-pip install PySide6-Essentials
-async-kernel -a async-qt --interface.host=qt
-```
-
-#### trio backend
+Kernel specs can be installed/uninstalled via the command line.
 
 ```bash
-pip install trio
-# tk
-async-kernel -a async-tk --interface.host=tk --interface.backend=trio
+async-kernel install
 
-# qt
-pip install PySide6-Essentials
-async-kernel -a async-qt --interface.host=qt --interface.backend=trio
+# To install for a user
+async-kernel install --user
 ```
 
-For further detail about kernel spec customisation see [command line and kernel configuration](https://fleming79.github.io/async-kernel/latest/usage/commands/).
+For further detail about kernel spec customisation see [command line and kernel configuration](https://fleming79.github.io/async-kernel/latest/usage/commands/) and [custom kernel.ipynb](https://fleming79.github.io/async-kernel/latest/notebooks/custom_kernel/).
 
 ## Faster data serialization
 

{async_kernel-0.18.3 → async_kernel-0.19.0}/README.md

@@ -104,56 +104,20 @@ await event
 pip install async-kernel
 ```
 
-## Kernel specs
+## Kernelspecs
 
-A kernel spec with the name 'async' is added when async-kernel is installed.
+A kernelspec with the name 'async' is added when async-kernel is installed.
 
-Kernel specs can be added/removed via the command line.
-
-### Backends
-
-The backend set on the interface is the asynchronous library the kernel uses for message handling.
-It is also the asynchronous library directly available when executing code in cells or via a console[^3].
-
-[^3]:
-    Irrespective of the configured backend, functions/coroutines can be executed using a specific backend
-    with the method [`call_using_backend`](https://fleming79.github.io/async-kernel/latest/reference/caller/#async_kernel.caller.Caller.call_using_backend).
-
-#### Example - overwrite the 'async' kernel spec to use a trio backend
-
-```bash
-pip install trio
-async-kernel -a async --interface.backend=trio
-```
-
-### Gui event loop
-
-The kernel can be started with a gui event loop as the _host_ and the _backend_ running as a guest.
-
-#### asyncio backend
-
-```bash
-# tk
-async-kernel -a async-tk --interface.host=tk
-
-# qt
-pip install PySide6-Essentials
-async-kernel -a async-qt --interface.host=qt
-```
-
-#### trio backend
+Kernel specs can be installed/uninstalled via the command line.
 
 ```bash
-pip install trio
-# tk
-async-kernel -a async-tk --interface.host=tk --interface.backend=trio
+async-kernel install
 
-# qt
-pip install PySide6-Essentials
-async-kernel -a async-qt --interface.host=qt --interface.backend=trio
+# To install for a user
+async-kernel install --user
 ```
 
-For further detail about kernel spec customisation see [command line and kernel configuration](https://fleming79.github.io/async-kernel/latest/usage/commands/).
+For further detail about kernel spec customisation see [command line and kernel configuration](https://fleming79.github.io/async-kernel/latest/usage/commands/) and [custom kernel.ipynb](https://fleming79.github.io/async-kernel/latest/notebooks/custom_kernel/).
 
 ## Faster data serialization
 

{async_kernel-0.18.3 → async_kernel-0.19.0}/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.18.3'
-__version_tuple__ = version_tuple = (0, 18, 3)
+__version__ = version = '0.19.0'
+__version_tuple__ = version_tuple = (0, 19, 0)
 
 __commit_id__ = commit_id = None

{async_kernel-0.18.3 → async_kernel-0.19.0}/docs/notebooks/caller.ipynb

@@ -66,10 +66,6 @@
    },
    "outputs": [],
    "source": [
-    "import async_kernel\n",
-    "\n",
-    "assert async_kernel.utils.get_kernel() is get_ipython().kernel  # pyright: ignore[reportUndefinedVariable]\n",
-    "\n",
     "%callers"
    ]
   },
@@ -417,11 +413,13 @@
     "import random\n",
     "import time\n",
     "\n",
+    "import anyio\n",
     "import ipywidgets as ipw\n",
     "\n",
     "outputs = {}\n",
     "stop = ipw.RadioButtons(value=None, options=[\"Stop\"])\n",
     "box = ipw.VBox([stop])\n",
+    "await anyio.sleep(0.2)\n",
     "display(box)\n",
     "\n",
     "\n",

{async_kernel-0.18.3 → async_kernel-0.19.0}/docs/notebooks/concurrency.ipynb

@@ -61,11 +61,7 @@
     "import threading\n",
     "\n",
     "import ipywidgets as ipw\n",
-    "from aiologic import Event\n",
-    "\n",
-    "from async_kernel import utils\n",
-    "\n",
-    "kernel = utils.get_kernel()"
+    "from aiologic import Event"
    ]
   },
   {
@@ -368,6 +364,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "import asyncio  # noqa: F401  # pyright: ignore[reportUnusedImport]\n",
+    "\n",
     "%asyncio await asyncio.sleep(0) # This code gets run in an asyncio task \n",
     "%trio await trio.sleep(0) # trio run as line magic"
    ]
@@ -384,7 +382,7 @@
     "def print_info():\n",
     "    from aiologic.lowlevel import current_async_library\n",
     "    print(f\"\"\"\n",
-    "    Kernel backend: {get_ipython().kernel.interface.backend}\n",
+    "    Kernel backend: {get_ipython().kernel.parent.backend}\n",
     "    Current backend: { current_async_library()}\n",
     "    \"\"\")   \n",
     "\n",

async_kernel-0.19.0/docs/notebooks/custom_kernel.ipynb

@@ -0,0 +1,208 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "0",
+   "metadata": {},
+   "source": [
+    "# Kernel customisation (notebook)\n",
+    "\n",
+    "- [Using a uv virtual environment](#uv-managed-virtual-environment)\n",
+    "- [Storing a custom definition](#embed-the-custom-kernel-in-the-kernelspec-folder)\n",
+    "- [Configuration options](#configuration-options)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "1",
+   "metadata": {},
+   "source": [
+    "## uv managed virtual environment\n",
+    "\n",
+    "We can use uv to create a virtual environment for different versions of Python.\n",
+    "\n",
+    "Let's create a new virtual environment in the folder named \".venv_py315\" using uv.\n",
+    "\n",
+    "**Requires a recent version of uv to be installed.**"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%uv venv .venv_py315 --python 3.15 --clear\n",
+    "%uv pip install --directory .venv_py315 --python 3.15 async-kernel"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3",
+   "metadata": {},
+   "source": [
+    "Now we can write a kernel spec that uses uv to start the kernel from the virtual environment."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import pathlib\n",
+    "\n",
+    "from async_kernel.kernelspec import write_kernel_spec\n",
+    "\n",
+    "uv_path = pathlib.Path.cwd().joinpath(\".venv_py315\")\n",
+    "assert uv_path.exists()\n",
+    "\n",
+    "write_kernel_spec(\n",
+    "    name=\"async_3.15\",\n",
+    "    display_name=\"Python 3.15 (async)\",\n",
+    "    env={\"UV_PROJECT_ENVIRONMENT\": str(uv_path)},\n",
+    "    command=(\"uv\", \"run\", \"--module\", \"async_kernel\", \"start\"),\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "5",
+   "metadata": {},
+   "source": [
+    "The kernel spec with the display name \"Python 3.15 (async kernel)\" has been added. You will need to refresh the list of kernels for it to be available."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "6",
+   "metadata": {},
+   "source": [
+    "## Embed the custom kernel in the kernelspec folder\n",
+    "\n",
+    "\n",
+    "When a callable is passed as the argument `launcher` to the function `write_kernel_spec` it is saved as a python file in the kernel spec folder. It will be used as the 'launcher' for the kernelspec.\n",
+    "\n",
+    "Let's write a kernel that will echo (print) the code written to the cell. \n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "7",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import async_kernel.kernelspec\n",
+    "\n",
+    "\n",
+    "def launcher(settings: dict) -> None:\n",
+    "\n",
+    "    from async_kernel import Kernel\n",
+    "    from async_kernel.interface.zmq import ZMQInterface\n",
+    "\n",
+    "    class EchoKernel(Kernel):\n",
+    "        async def execute_request(self, job):\n",
+    "            print(job[\"msg\"][\"content\"][\"code\"])\n",
+    "            return {\"status\": \"ok\", \"execution_count\": 0, \"user_expressions\": {}}\n",
+    "\n",
+    "    ZMQInterface.launch_instance(kernel_class=EchoKernel)\n",
+    "\n",
+    "\n",
+    "# Write the kernel spec\n",
+    "async_kernel.kernelspec.write_kernel_spec(name=\"echo\", display_name=\"Echo kernel\", launcher=launcher)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "8",
+   "metadata": {},
+   "source": [
+    "### Customize the shell\n",
+    "\n",
+    "Sometimes it might be useful to customise the shell instead of the kernel.\n",
+    "\n",
+    "Lets write IPshell as an echo a bypass keyword \"# call\"."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import async_kernel.kernelspec\n",
+    "\n",
+    "\n",
+    "def launcher(settings: dict) -> None:\n",
+    "\n",
+    "    from traitlets import traitlets\n",
+    "\n",
+    "    from async_kernel.interface.zmq import ZMQInterface\n",
+    "    from async_kernel.shell import IPShell\n",
+    "\n",
+    "    class EchoShell(IPShell):\n",
+    "        @traitlets.default(\"banner1\")\n",
+    "        def _default_banner1(self) -> str:\n",
+    "            return \"Echo kernel with bypass\\n\"\n",
+    "\n",
+    "        def transform_cell(self, raw_cell):\n",
+    "            if raw_cell.startswith(\"# call\"):\n",
+    "                return super().transform_cell(raw_cell)\n",
+    "            return f'print(\"\"\"{raw_cell}\"\"\")'\n",
+    "\n",
+    "    ZMQInterface.launch_instance(shell_class=EchoShell)\n",
+    "\n",
+    "\n",
+    "# Write the kernel spec\n",
+    "async_kernel.kernelspec.write_kernel_spec(\n",
+    "    name=\"echo-shell-with-bypass\", display_name=\"Echo with bypass\", launcher=launcher\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "10",
+   "metadata": {},
+   "source": [
+    "## Configuration options\n",
+    "\n",
+    "Configuration is done using traitlets configuration. Configuration options are available from the command line."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "11",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "!async-kernel --help-all"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python (async)",
+   "language": "python",
+   "name": "async"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.12"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

async_kernel-0.19.0/docs/reference/ipshell.md

@@ -0,0 +1 @@
+::: async_kernel.shell.ipshell

async_kernel-0.19.0/docs/reference/shell.md

@@ -0,0 +1 @@
+::: async_kernel.shell.base