feat: bilingual docs, GitHub Pages deployment, and concurrency bug fixes#4
Merged
Conversation
Documentation (English / 日本語): - MkDocs Material + mkdocs-static-i18n + mkdocstrings covering the full public API: guides for waiting, iterating, deriving/composing, tasks/cancellation, and events/streams, plus an API reference. - Docstrings and type annotations for all AsyncValue methods. - GitHub Pages deployment workflow (docs.yml) and a strict docs build job in CI; bilingual READMEs; CHANGELOG; runnable examples/. Bug fixes (each with regression tests; suite grows 69 -> 92): - wait_value(held_for=) raised TimeoutError on a successful hold; eventual_values(held_for=) had the hold logic inverted. - Raising predicates crashed the assigning task and starved other waiters; they are now delivered to their own waiter only. - compose_values() silently swallowed _transform_ exceptions, freezing the output at its last good value. - move_on_when() leaked CancelledError when the trigger completed without awaiting, and swallowed trigger exceptions. - run_and_cancelling()/start_and_cancelling() masked body exceptions with background-task failures. - wait_any()/wait_all()/wait_any_map() leaked started tasks when a later callable raised synchronously. - MulticastQueue ended streams on a legitimate None broadcast. - periodic() drifted; now anchored to the absolute start+k*period grid. Housekeeping: requires-python >=3.10, CI matrix 3.10-3.14, py.typed, project metadata/URLs, pytest asyncio_mode=auto, version 0.1.0.
65a7b57 to
d2ea585
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Completes the library for public consumption: comprehensive bilingual documentation deployed to GitHub Pages, plus fixes for eight real concurrency bugs found during review — each verified by a repro and covered by regression tests (suite grows 69 → 92 tests).
Documentation (English / 日本語)
*.md/*.ja.md).AsyncValuemethods).docs.yml); Pages is already enabled with the 'GitHub Actions' source → deploys on merge to https://jrfk.github.io/asyncio-util/ (ja:/ja/).CHANGELOG.md, runnableexamples/, strict docs build in CI.Bug fixes (all with regression tests)
wait_value(held_for=)TimeoutErrorwhen the condition successfully heldeventual_values(held_for=)TimeoutErrorto the consumercompose_values()_transform_exceptions silently swallowed → output frozen at last good valuemove_on_when()CancelledError(body never ran) when the trigger completed without awaiting, e.g. an already-set event; trigger exceptions were swallowedrun_and_cancelling()/start_and_cancelling()wait_any()/wait_all()/wait_any_map()MulticastQueueNoneterminated listeners (sentinel collision)periodic()start + k*periodgridHousekeeping
requires-python >= 3.10(3.8/3.9 are EOL); CI matrix 3.10–3.14 + docs build job.py.typed, project metadata (description, keywords, classifiers, Pages URL),pytest asyncio_mode=auto, version 0.1.0.Test plan
uv run pytest— 92 tests pass (69 existing + 23 new regression tests)uv run mkdocs build --strict— clean, en + ja both builtexamples/*.pyrun with expected outputuv build— wheel includespy.typed