Skip to content

Add optional finish event to aset_progressively #426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
davidbrochart wants to merge 4 commits into
base: main
Choose a base branch
from
+8 −10
Open

Add optional finish event to aset_progressively #426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
db8124f
Add optional finish event to aset_progressively
davidbrochart Jul 2, 2026
ea506a1
Add kwargs to aset_progressively
davidbrochart Jul 2, 2026
f04474e
aset_progressively now accepts any arguments
davidbrochart Jul 2, 2026
ef24a2e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions jupyter_ydoc/ybasedoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,8 @@ async def aset_progressively(
self,
value: Any,
initialized: anyio.Event | asyncio.Event | None = None,
finish: anyio.Event | asyncio.Event | None = None,
**kwargs: Any,
) -> None:
"""
Sets the content of the document progressively, if supported by the document.
Expand Down
6 changes: 6 additions & 0 deletions jupyter_ydoc/ynotebook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,9 @@ async def aset_progressively(
self,
value: dict,
initialized: anyio.Event | asyncio.Event | None = None,
finish: anyio.Event | asyncio.Event | None = None,
delay_outputs_above_mb: float | None = None,
**kwargs: Any,
) -> None:
"""
Sets notebook content progressively in multiple transactions.
Expand All @@ -520,6 +522,8 @@ async def aset_progressively(
:type delay_outputs_above_mb: float, optional
:param initialized: An optional event to set when the notebook metada has been set.
:type value: Event
:param finish: An optional event set when to start setting the notebook cells.
:type value: Event
"""
if delay_outputs_above_mb is not None and delay_outputs_above_mb < 0:
msg = "delay_outputs_above_mb must be greater than or equal to 0"
Expand All @@ -532,6 +536,8 @@ async def aset_progressively(
try:
if next(gen) and initialized is not None:
initialized.set()
if finish is not None:
await finish.wait()
except StopIteration:
done = True
await anyio.lowlevel.checkpoint()
Expand Down
10 changes: 0 additions & 10 deletions tests/test_ydocs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.

import re
from typing import Any

import pytest
Expand Down Expand Up @@ -59,15 +58,6 @@ async def test_ybasedoc_aset_progressively_falls_back_to_aset():
doc = SimpleYDoc()
value = {"cells": []}

with pytest.raises(
TypeError,
match=re.escape(
"YBaseDoc.aset_progressively() got an unexpected keyword argument "
"'delay_outputs_above_mb'"
),
):
await doc.aset_progressively(value, delay_outputs_above_mb=0)

await doc.aset_progressively(value)

assert doc.aset_values == [value]
Expand Down
Loading