Skip to content

allow state mutation with contextmanager from normal (non-background) events #5938

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

Merged
adhami3310 merged 3 commits into from
Oct 30, 2025
Merged

allow state mutation with contextmanager from normal (non-background) events #5938

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7878e02
add config option to allow state mutation with contextmanager from no…
benedikt-bartscher Oct 29, 2025
86896fe
fix codespell
benedikt-bartscher Oct 29, 2025
4cf6303
make state contextmanager a no-op by default, drop config option
benedikt-bartscher Oct 29, 2025
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
10 changes: 4 additions & 6 deletions reflex/state.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2189,14 +2189,12 @@ def dict(
async def __aenter__(self) -> BaseState:
"""Enter the async context manager protocol.

This should not be used for the State class, but exists for
type-compatibility with StateProxy.
This is a no-op for the State class and mainly used in background-tasks/StateProxy.

Raises:
TypeError: always, because async contextmanager protocol is only supported for background task.
Returns:
The unmodified state (self)
"""
msg = "Only background task should use `async with self` to modify state."
raise TypeError(msg)
return self

async def __aexit__(self, *exc_info: Any) -> None:
"""Exit the async context manager protocol.
Expand Down
Loading