introduce code transformation to simplify writing ui.sub_pages demos #5274
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.
Motivation
Writing demos for Single Page Applications (SPAs) with
ui.sub_pages
has been cumbersome and unnatural. Demo code doesn't match what users should actually write in their own applications:FakeSubPages
and manual workarounds (sub_pages.link(), FakeArguments, etc.) instead of the clean, straightforward API (ui.link(), ui.sub_pages())Implementation
This PR introduces an automatic code transformation system that allows demo authors to write natural, idiomatic NiceGUI code while still supporting browser-based demo execution:
website/documentation/code_extraction.py
):ui.sub_pages()
→FakeSubPages.init()
,ui.link()
→pages.link()
# TRANSFORM
comments for complex cases (e.g., parameterized routes)website/documentation/demo.py
):website/documentation/content/sub_pages_documentation.py
):Progress