async-kernel 0.14.0__tar.gz → 0.15.0__tar.gz

{async_kernel-0.14.0 → async_kernel-0.15.0}/.github/workflows/ci.yml

@@ -38,8 +38,7 @@ jobs:
           - "3.11"
           - "3.12"
           - "3.13"
-          - "3.14"
-          # - "3.14t" #  re-enabled when free-threading becomes more widely supported.
+          - "3.14t"
     steps:
       - name: Checkout
         uses: actions/checkout@v6
@@ -54,6 +53,10 @@ jobs:
       - name: Install the project
         run: uv sync --locked --dev
 
+      - if: ${{ startsWith(matrix.os, 'windows') && !endsWith(matrix.python-version, 't')}}
+        # Pyside does not have free-threaded binary
+        run: uv sync --locked --dev --group gui
+
       - name: Run tests
         timeout-minutes: 5
         run: uv run pytest -vvl --maxfail=1 --reruns 1
@@ -75,7 +78,10 @@ jobs:
 
       - name: Run tests with coverage
         timeout-minutes: 5
-        run: uv run pytest --cov --cov-report=xml --junitxml=junit.xml -o junit_family=legacy  --cov-fail-under=100 --cov-report markdown-append:$GITHUB_STEP_SUMMARY
+        run: |
+          uv sync --locked --dev
+          uv pip install orjson>=3.10.16
+          uv run pytest --cov --cov-report=xml --junitxml=junit.xml -o junit_family=legacy  --cov-fail-under=100 --cov-report markdown-append:$GITHUB_STEP_SUMMARY
 
       - name: Upload coverage reports to Codecov
         if: ${{ !cancelled() }}

{async_kernel-0.14.0 → async_kernel-0.15.0}/.github/workflows/enforce-label.yml

@@ -1,12 +1,9 @@
 name: Enforce PR label
 
-concurrency:
-  group: label-${{ github.ref }}
-  cancel-in-progress: true
-
 on:
   pull_request:
     types: [labeled, unlabeled, opened, edited, synchronize]
+
 jobs:
   enforce-label:
     runs-on: ubuntu-latest

{async_kernel-0.14.0 → async_kernel-0.15.0}/.vscode/launch.json

@@ -26,6 +26,36 @@
       },
       "justMyCode": true,
       "args": ["-X dev", "Wd"]
+    },
+    {
+      "name": "Jupyterlab",
+      "type": "debugpy",
+      "request": "launch",
+      "args": [
+        "--notebook-dir=docs/notebooks",
+        "--no-browser",
+        "--ServerApp.token=''",
+        "--port=9991"
+      ],
+      "cwd": "${workspaceFolder}",
+      "justMyCode": false,
+      "module": "jupyterlab",
+      "presentation": {
+        "hidden": false
+      }
+    },
+    {
+      "name": "Editor Browser",
+      "type": "editor-browser",
+      "request": "launch",
+      "url": "http://localhost:9991",
+      "webRoot": "${workspaceFolder}"
+    }
+  ],
+  "compounds": [
+    {
+      "name": "Python and Jupyterlab",
+      "configurations": ["Jupyterlab", "Editor Browser"]
     }
   ]
 }

{async_kernel-0.14.0 → async_kernel-0.15.0}/CHANGELOG.md

@@ -5,6 +5,52 @@ 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.15.0] - 2026-03-30
+
+### <!-- 0 --> 🏗️ Breaking changes
+
+- Provide cancellation in Pending by default [#386](https://github.com/fleming79/async-kernel/pull/386)
+
+- Use a standard dict for the user_ns (remove LastUpdatedDict) [#380](https://github.com/fleming79/async-kernel/pull/380)
+
+### <!-- 1 --> 🚀 Features
+
+- Replace aiologic.Lock with aiologic.lowlevel.create_thread_oncelock for improved performance [#389](https://github.com/fleming79/async-kernel/pull/389)
+
+- Convert Pending._done_callbacks from deque to list [#383](https://github.com/fleming79/async-kernel/pull/383)
+
+- Free-threading preliminary support. [#379](https://github.com/fleming79/async-kernel/pull/379)
+
+### <!-- 5 --> 📝 Documentation
+
+- Update docstrings [#384](https://github.com/fleming79/async-kernel/pull/384)
+
+- Add thread_safety.md [#381](https://github.com/fleming79/async-kernel/pull/381)
+
+### <!-- 6 --> 🌀 Miscellaneous
+
+- Change Pending.wait_sync signature to be the same as Pending.wait [#393](https://github.com/fleming79/async-kernel/pull/393)
+
+- Tidy up [#391](https://github.com/fleming79/async-kernel/pull/391)
+
+- Pending refactoring. [#390](https://github.com/fleming79/async-kernel/pull/390)
+
+- Use aiologic.lowlevel.create_async_waiter instead of Event for better performance. [#388](https://github.com/fleming79/async-kernel/pull/388)
+
+- Pending refactoring [#385](https://github.com/fleming79/async-kernel/pull/385)
+
+- Caller.queue_call optimizations [#382](https://github.com/fleming79/async-kernel/pull/382)
+
+- Add Kernel.run and refactor the interfaces. [#378](https://github.com/fleming79/async-kernel/pull/378)
+
+- Use Kernel._get_run_mode for all message types. [#377](https://github.com/fleming79/async-kernel/pull/377)
+
+- Add a VS Code launch config for to launch Jupyterlab [#376](https://github.com/fleming79/async-kernel/pull/376)
+
+- Upgrade uv.lock and run gui tests using windows. [#375](https://github.com/fleming79/async-kernel/pull/375)
+
+- Update uv.lock [#374](https://github.com/fleming79/async-kernel/pull/374)
+
 ## [0.14.0] - 2026-03-24
 
 ### <!-- 0 --> 🏗️ Breaking changes
@@ -17,6 +63,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Update readme [#371](https://github.com/fleming79/async-kernel/pull/371)
 
+### <!-- 6 --> 🌀 Miscellaneous
+
+- Prepare for release v0.14.0 [#373](https://github.com/fleming79/async-kernel/pull/373)
+
 ## [0.13.3] - 2026-03-23
 
 ### <!-- 0 --> 🏗️ Breaking changes
@@ -1037,6 +1087,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.15.0]: https://github.com/fleming79/async-kernel/compare/v0.14.0..v0.15.0
 [0.14.0]: https://github.com/fleming79/async-kernel/compare/v0.13.3..v0.14.0
 [0.13.3]: https://github.com/fleming79/async-kernel/compare/v0.13.2..v0.13.3
 [0.13.2]: https://github.com/fleming79/async-kernel/compare/v0.13.1..v0.13.2

{async_kernel-0.14.0 → async_kernel-0.15.0}/CONTRIBUTING.md

@@ -208,3 +208,14 @@ uv run mkdocs build -s
     tests can still fail for another os or python version.
 
 [^test-pypi]: This workflow also runs on push to the main branch, but will instead publish to [TestPyPI](https://test.pypi.org/project/async-kernel/).
+
+## VS code development
+
+Debug configurations are included to support debugging with VS Code.
+
+- Python: Debug Tests: This config is for attaching a debugger when launching tests.
+  The recommended way to debug tests.
+- Python and Jupyterlab (Requires VS Code >1.112.0): This provides a compound launch configuration
+  which starts Jupyterlab and Python. The built in browser launches attaches to the Jupyter session
+  (refresh may be required after the server has started). The advantage of this configuration
+  is that all Python processes are attached to the debugger whenever a kernel is opened.

{async_kernel-0.14.0 → async_kernel-0.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: async-kernel
-Version: 0.14.0
+Version: 0.15.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
@@ -29,6 +29,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Free Threading :: 1 - Unstable
 Classifier: Typing :: Typed
 Requires-Python: >=3.11
 Requires-Dist: aiologic>=0.16.0
@@ -38,7 +39,7 @@ Requires-Dist: ipython>=9.0
 Requires-Dist: jupyter-client>=8.8; sys_platform != 'emscripten'
 Requires-Dist: jupyter-core>=5.9.1
 Requires-Dist: matplotlib-inline>0.1
-Requires-Dist: orjson>=3.10.16
+Requires-Dist: orjson>=3.10.16; sys_platform == 'emscripten'
 Requires-Dist: outcome; sys_platform != 'emscripten'
 Requires-Dist: pyzmq>=27.0; sys_platform != 'emscripten'
 Requires-Dist: sniffio>=1.3.0; sys_platform != 'emscripten'
@@ -65,7 +66,7 @@ that provides concurrent message handling via an asynchronous backend (asyncio o
 
 The kernel provides two external interfaces:
 
-1. Direct ZMQ socket messaging via a configuration file and kernel spec - (Jupyter, VScode, etc).
+1. Direct ZMQ socket messaging via a configuration file and kernel spec - (Jupyter, VS Code, etc).
 2. An experimental callback style interface (Jupyterlite).
 
 ## Highlights
@@ -202,6 +203,16 @@ async-kernel -a async-qt --interface.host=qt --interface.backend=trio
 
 For further detail about kernel spec customisation see [command line and kernel configuration](https://fleming79.github.io/async-kernel/latest/usage/commands/).
 
+## Faster data serialization
+
+[orjson](https://github.com/ijl/orjson) (a fast JSON library) is supported and will be used by default if it has been installed.
+
+## Free-threading support
+
+async-kernel's Caller's are _thread-local_ and it's methods are _internally synchronised_[^4].
+
+[^4]: [free threading terminology](https://py-free-threading.github.io/documentation-principles/#free-threading-terminology)
+
 ## Origin
 
 async-kernel started as a [fork](https://github.com/ipython/ipykernel/commit/8322a7684b004ee95f07b2f86f61e28146a5996d)

{async_kernel-0.14.0 → async_kernel-0.15.0}/README.md

@@ -16,7 +16,7 @@ that provides concurrent message handling via an asynchronous backend (asyncio o
 
 The kernel provides two external interfaces:
 
-1. Direct ZMQ socket messaging via a configuration file and kernel spec - (Jupyter, VScode, etc).
+1. Direct ZMQ socket messaging via a configuration file and kernel spec - (Jupyter, VS Code, etc).
 2. An experimental callback style interface (Jupyterlite).
 
 ## Highlights
@@ -153,6 +153,16 @@ async-kernel -a async-qt --interface.host=qt --interface.backend=trio
 
 For further detail about kernel spec customisation see [command line and kernel configuration](https://fleming79.github.io/async-kernel/latest/usage/commands/).
 
+## Faster data serialization
+
+[orjson](https://github.com/ijl/orjson) (a fast JSON library) is supported and will be used by default if it has been installed.
+
+## Free-threading support
+
+async-kernel's Caller's are _thread-local_ and it's methods are _internally synchronised_[^4].
+
+[^4]: [free threading terminology](https://py-free-threading.github.io/documentation-principles/#free-threading-terminology)
+
 ## Origin
 
 async-kernel started as a [fork](https://github.com/ipython/ipykernel/commit/8322a7684b004ee95f07b2f86f61e28146a5996d)

async_kernel-0.15.0/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.15.0'
+__version_tuple__ = version_tuple = (0, 15, 0)
+
+__commit_id__ = commit_id = None

{async_kernel-0.14.0 → async_kernel-0.15.0}/docs/notebooks/caller.ipynb

@@ -15,7 +15,7 @@
     "\n",
     "_This notebook has the Python dependencies: `trio`, `matplotlib`_\n",
     "\n",
-    "`Caller` is a class that enables standard functions and coroutines to be called in the event loop of a `asyncio` or `trio` backend. Scheduling is thread-safe, methods that return `Pending` are thread-safe cancellable and awaitable."
+    "`Caller` is a thread-local class that coordinates the execution of functions and coroutines in the event loop of a `asyncio` or `trio` backend."
    ]
   },
   {
@@ -35,6 +35,7 @@
    "metadata": {},
    "source": [
     "A `Caller` instance can be started with one gui as a host to one backend started as a guest. \n",
+    "\n",
     "A second backend can also be started in the same thread with or without a host gui event loop.\n",
     "Potentially the same thread could have up to:\n",
     "\n",
@@ -77,11 +78,10 @@
    "id": "5",
    "metadata": {},
    "source": [
-    "There are three caller instances associated with the Kernel:\n",
+    "There are two caller instances associated with the Kernel:\n",
     "\n",
     "- Shell: The caller for the shell channel (normally the MainThread).\n",
-    "- Control: The caller for the control channel (a child of the shell).\n",
-    "- Shell thread_queue: A separate thread to handle shell messages in a separate thread (queued by message type and subshell_id)."
+    "- Control: The caller for the control channel (a child of the shell)."
    ]
   },
   {
@@ -89,7 +89,9 @@
    "id": "6",
    "metadata": {},
    "source": [
-    "Calling `Caller()` with no arguments will return the caller for the current thread (context in Pyodide). A runtime error will occur if when there is no backend running in the current thread (in Pyodide the main caller is always available)."
+    "Calling `Caller()` with no arguments will return the caller for the current thread (or context in Pyodide). \n",
+    "\n",
+    "A runtime error will occur if there is no event loop (backend) running in the current thread (unlikely in Pyodide which provides a running event loop)."
    ]
   },
   {
@@ -111,7 +113,7 @@
    "source": [
     "## Modifiers\n",
     "\n",
-    "There are four modifiers that determine the instance returned when calling `Caller`.\n",
+    "There are four modifiers that determine which instance is returned when calling `Caller`.\n",
     "\n",
     "- `CurrentThread` (default): Access the caller that belongs to the current thread (or context with Pyodide).\n",
     "- `MainThread`: Access main thread for the Caller.\n",
@@ -285,7 +287,9 @@
    "source": [
     "### Caller.call_using_backend\n",
     "\n",
-    "This method calls functions and coroutines using a specific asynchronous backend in the same thread. When the backend does not match the callers backend, it is run with the backend running as a guest."
+    "This method calls functions and coroutines using a specific asynchronous backend in the same thread. \n",
+    "\n",
+    "When the backend does not match the callers backend, it is run with the backend running as a guest."
    ]
   },
   {
@@ -490,10 +494,13 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "import anyio\n",
+    "\n",
     "async with caller.create_pending_group() as pg:\n",
-    "    caller.call_soon(asyncio.sleep, 0.01)\n",
-    "    caller.call_later(0, asyncio.sleep, 0)\n",
-    "    caller.to_thread(asyncio.sleep, 0.01)\n",
+    "    caller.call_soon(anyio.sleep, 0.01)\n",
+    "    caller.call_later(0, anyio.sleep, 0)\n",
+    "    caller.to_thread(anyio.sleep, 0.01)\n",
+    "    caller.call_using_backend(\"asyncio\", asyncio.sleep, 0.01)\n",
     "    caller.call_using_backend(\"trio\", trio.sleep, 0.01)\n",
     "    print(\"In context pending=\", len(pg.pending))\n",
     "\n",

{async_kernel-0.14.0 → async_kernel-0.15.0}/docs/reference/index.md

@@ -12,6 +12,6 @@ The reference section provides documentation for each module in async-kernel.
 ## Highlights
 
 - [Kernel][async_kernel.kernel.Kernel] - The kernel.
-- [Caller][async_kernel.caller.Caller] - Simplifies event loop management and call scheduling (thread-safe).
-- [Pending][async_kernel.pending.Pending] - Represents a pending result that can be set, awaited and cancelled (thread-safe).
+- [Caller][async_kernel.caller.Caller] - Simplifies event loop management and call scheduling.
+- [Pending][async_kernel.pending.Pending] - Represents a pending result (like an [asyncio.Future][] that can be awaited anywhere).
 - [command_line][async_kernel.command.command_line] - The command line interface.

async_kernel-0.15.0/docs/thread_safety.md

@@ -0,0 +1,40 @@
+# Thread Safety of Built-in Types
+
+- [Terminology](https://py-free-threading.github.io/documentation-principles/#free-threading-terminology)
+
+_aync-kernel_ utilises [aiologic](https://aiologic.readthedocs.io/latest/index.html) for its _thread-safe_ primitives.
+
+## [async_kernel.pending.Pending][]
+
+### Guarantees
+
+- **Internally synchronised**
+    - All Public methods can be safely called from any thread.
+    - Instance are sync/async awaitable from any thread with any backend.
+
+- **Limitations**
+
+    [add_done_callback][async_kernel.pending.Pending.add_done_callback]: The callback is called from the thread in which it is set
+    so should provide it's own synchronisation as needed.
+
+## [async_kernel.caller.Caller][]
+
+`Caller` is thread-local in CPython and context-local in Pyodide.
+
+### Guarantees
+
+- **Internally synchronised**
+
+- **Limitations**
+    - [queue_call][async_kernel.caller.Caller.queue_call] is internally synchronised per-function after
+      the first call (per-function) has returned.
+
+## [async_kernel.common.Fixed][]
+
+### Guarantees
+
+- **Internally synchronised**
+
+### Other classes
+
+TODO

{async_kernel-0.14.0 → async_kernel-0.15.0}/docs/usage/index.md

@@ -5,9 +5,19 @@ icon: material/note-text
 # subtitle: A sub title
 ---
 
-# Usage
+async-kernel feels like a standard kernel that offers advanced features that improved user experience.
+
+## Features
+
+- Separate handlers for msg_type and channel allow messages to be processed concurrently.
+- Code execution is top-level awaitable.
+- Choice of async backend (asyncio or trio).
+- Choice of asyncio event loop when started by anyio (not as a guest).
+- Optional gui host event loop.
+- Using [Caller.call_using_backend][async_kernel.caller.Caller.call_using_backend], code from any backend can be called in any thread.
+
+## [Command line](../usage/commands.md): Detail about command line usage including:
 
-- [Command line](../usage/commands.md): Detail about command line usage including:
     - Adding a kernel spec
     - Deleting a kernel spec
     - Starting a kernel

{async_kernel-0.14.0 → async_kernel-0.15.0}/mkdocs.yml

@@ -99,9 +99,10 @@ plugins:
             - https://ipywidgets.readthedocs.io/en/stable/objects.inv
             - https://jupyter-client.readthedocs.io/en/stable/objects.inv
             - https://anyio.readthedocs.io/en/stable/objects.inv
-            - http://aiologic.readthedocs.io/latest/objects.inv
+            - http://aiologic.readthedocs.io/stable/objects.inv
             - https://wrapt.readthedocs.io/en/master/objects.inv
             - https://trio.readthedocs.io/en/stable/objects.inv
+            - https://pyzmq.readthedocs.io/en/stable/objects.inv
           options:
             docstring_style: google
             docstring_options:
@@ -115,7 +116,6 @@ plugins:
             members_order: source
             merge_init_into_class: false
             parameter_headings: true
-            # preload_modules: [mkdocstrings]
             relative_crossrefs: true
             scoped_crossrefs: true
             separate_signature: true
@@ -184,7 +184,7 @@ nav:
       - "event_loop": reference/event_loop.md
       - "typing": reference/typing.md
       - "utils": reference/utils.md
-
+  - Thread safety: thread_safety.md
   - About:
       - about/index.md
 

{async_kernel-0.14.0 → async_kernel-0.15.0}/pyproject.toml

@@ -31,13 +31,14 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: Free Threading :: 1 - Unstable",
 ]
 requires-python = ">=3.11"
 dependencies = [
     "anyio>=4.12",
     "typing_extensions>=4.14",
     "aiologic>=0.16.0",
-    "orjson>=3.10.16",
+    "orjson>=3.10.16; sys_platform == 'emscripten'",
     "comm>=0.2",
     "ipython>=9.0",
     "traitlets>=5.14",

{async_kernel-0.14.0 → async_kernel-0.15.0}/src/async_kernel/asyncshell.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import builtins
 import contextlib
+import json
 import os
 import pathlib
 import sys
@@ -11,7 +12,6 @@ from typing import TYPE_CHECKING, Any, Literal, Self, overload
 
 import anyio
 import IPython.core.release
-import orjson
 from aiologic.lowlevel import async_checkpoint
 from IPython.core.completer import provisionalcompleter, rectify_completions
 from IPython.core.displayhook import DisplayHook
@@ -27,7 +27,7 @@ from typing_extensions import override
 import async_kernel
 from async_kernel import utils
 from async_kernel.caller import Caller
-from async_kernel.common import Fixed, LastUpdatedDict
+from async_kernel.common import Fixed
 from async_kernel.compiler import XCachingCompiler
 from async_kernel.event_loop.run import get_runtime_matplotlib_guis
 from async_kernel.pending import PendingManager
@@ -171,7 +171,7 @@ class AsyncInteractiveShell(InteractiveShell):
 
     Notable differences:
         - Supports a soft timeout specified via tags `timeout=<value in seconds>`[^1].
-        - `user_ns` and `user_global_ns` are same dictionary which is a fixed [async_kernel.common.LastUpdatedDict][].
+        - `user_ns` and `user_global_ns` are same dictionary which is a fixed [dict][].
 
         [^1]: When the execution time exceeds the timeout value, the code execution will "move on".
     """
@@ -194,7 +194,7 @@ class AsyncInteractiveShell(InteractiveShell):
     user_ns_hidden: Fixed[Self, dict] = Fixed(lambda c: c["owner"]._get_default_ns())
     user_global_ns: Fixed[Self, dict] = Fixed(lambda c: c["owner"]._user_ns)  # pyright: ignore[reportIncompatibleMethodOverride]
 
-    _user_ns: Fixed[Self, LastUpdatedDict] = Fixed(LastUpdatedDict)  # pyright: ignore[reportIncompatibleVariableOverride]
+    _user_ns: Fixed[Self, dict] = Fixed(dict)  # pyright: ignore[reportIncompatibleVariableOverride]
     _main_mod_cache = Fixed(dict)
     _stop_on_error_pool: Fixed[Self, set[Callable[[], object]]] = Fixed(set)
     _stop_on_error_info: Fixed[Self, dict[Literal["time", "execution_count"], Any]] = Fixed(dict)
@@ -726,7 +726,7 @@ class KernelMagics(Magics):
             connection_file = connection_file.name
         info = self.shell.kernel.get_connection_info()
         print(
-            orjson.dumps(info, option=orjson.OPT_INDENT_2).decode(),
+            json.dumps(info, indent=2),
             "Paste the above JSON into a file, and connect with:\n"
             + "    $> jupyter <app> --existing <file>\n"
             + "or, if you are local, you can connect with just:\n"