feat: run_button #1514
Merged
feat: run_button #1514
Conversation
This file contains 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
Adds `mo.ui.run_button()`, which can be used to trigger computations when a button is pressed and ONLY when a button is pressed. When the button is pressed, its value is set to `True` and its descendants are run. After its descendants have run, marimo automatically sets the button's value back to False. In this way, cells can gate computations on `run_button.value` -- updates to other variables won't spuriously cause the cell to run. Caveat: The button's value is only reset to `False` when the runtime is configured to autorun cells, since the lazy runtime doesn't know when the button's descendants will/have been run. This should be fine in practice, since `ui.run_button` has no real use in lazy kernels anyway.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
akshayka
commented
May 28, 2024
Comment on lines
+382
to
+384
| def _on_update_completion(self) -> None: | ||
| """Callback to run after the kernel has processed a value update.""" | ||
| return |
There was a problem hiding this comment.
This method acts as a post execution hook; the runtime calls it after setting UI element values.
akshayka
commented
May 28, 2024
Comment on lines
+107
to
+115
| if isinstance(ctx, KernelRuntimeContext) and ctx.lazy: | ||
| # Resetting to False in lazy kernels makes the button pointless, | ||
| # since its value hasn't been read by downstream cells on update | ||
| # completion. | ||
| # | ||
| # The right thing to do would be to somehow set to False after | ||
| # all cells that were marked stale because of the update were run, | ||
| # but that's too complicated. | ||
| return |
There was a problem hiding this comment.
Special case for lazy kernels, since we don't when descendants will run
mscolnick
reviewed
May 29, 2024
docs/api/inputs/run_button.md
Outdated
|
|
||
| @app.cell | ||
| def __(): | ||
| mo.stop(b.value, "Click `run` to submit the slider's value") |
There was a problem hiding this comment.
should this be mo.stop(not b.value).
not sure if this hides to much, but could put a stop on the button too?
b.stop(fallback=None)
# Run thingor maybe b.gate(), b.clicked()
There was a problem hiding this comment.
Oops yes it should.
Something like that could be nice — maybe b.gate() ... might add in a follow-up
mscolnick
reviewed
May 29, 2024
mscolnick
previously approved these changes
May 29, 2024
mscolnick
approved these changes
May 29, 2024
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
Adds
mo.ui.run_button(), which can be used to trigger computations when a button is pressed and ONLY when a button is pressed.🔍 Description of Changes
When the button is pressed, its value is set to
Trueand its descendants are run. After its descendants have run, marimo automatically sets the button's value back to False. In this way, cells can gate computations onrun_button.value-- updates to other variables won't spuriously cause the cell to run.Caveat: The button's value is only reset to
Falsewhen the runtime is configured to autorun cells, since the lazy runtime doesn't know when the button's descendants will/have been run. This should be fine in practice, sinceui.run_buttonhas no real use in lazy kernels anyway.The implementation reuses the frontend plugin for
mo.ui.button().📋 Checklist
📜 Reviewers
@mscolnick