Skip to content
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.

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

feat: allow disabling mutation detection per reactive instance #984

Open
wants to merge 3 commits into
base: 12-23-feat_change_mutation_detection_and_allow_reactive_boolean_defaults
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions solara/components/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,4 @@
logger = logging.getLogger("solara.components")
logger.warning(f"Default container {main.default_container} not found in solara.components. Defaulting to Column.")

# TODO: When Solara 2.0 releases Column should be replaced with Fragment
reacton.core._default_container = _container or Column # noqa: F405
reacton.core._default_container = _container or Fragment # noqa: F405
3 changes: 2 additions & 1 deletion solara/components/head_tag.vue
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<template><span></span></template>
<template>
</template>

<script>
module.exports = {
Expand Down
3 changes: 2 additions & 1 deletion solara/hooks/use_reactive.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ def use_reactive(
value: Union[T, solara.Reactive[T]],
on_change: Optional[Callable[[T], None]] = None,
equals: Callable[[Any, Any], bool] = solara.util.equals_extra,
disable_mutation_detection: bool = False,
) -> solara.Reactive[T]:
"""Creates a reactive variable with the a local component scope.

Expand Down Expand Up @@ -111,7 +112,7 @@ def create():

store: ValueBase[T]

if solara.settings.storage.mutation_detection is True:
if not disable_mutation_detection and solara.settings.storage.mutation_detection is True:
shared_store = SharedStore[StoreValue[T]](
StoreValue[T](private=value, public=_PublicValueNotSet(), get_traceback=None, set_value=_SetValueNotSet(), set_traceback=None),
unwrap=lambda x: x.private,
Expand Down
4 changes: 2 additions & 2 deletions solara/reactive.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
T = TypeVar("T")


def reactive(value: T, equals: Callable[[Any, Any], bool] = solara.util.equals_extra) -> Reactive[T]:
def reactive(value: T, equals: Callable[[Any, Any], bool] = solara.util.equals_extra, disable_mutation_detection=False) -> Reactive[T]:
"""Creates a new Reactive object with the given initial value.

Reactive objects are mostly used to manage global or application-wide state in
Expand Down Expand Up @@ -96,4 +96,4 @@ def Page():
Whenever the counter value changes, `CounterDisplay` automatically updates to display the new value.

"""
return Reactive(value, equals=equals)
return Reactive(value, equals=equals, disable_mutation_detection=disable_mutation_detection)
5 changes: 2 additions & 3 deletions solara/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,8 @@ class Config:

class MainSettings(BaseSettings):
check_hooks: str = "warn"
allow_reactive_boolean: bool = True
# TODO: also change default_container in solara/components/__init__.py
default_container: Optional[str] = "Column"
allow_reactive_boolean: bool = False
default_container: Optional[str] = "Fragment"

class Config:
env_prefix = "solara_"
Expand Down
30 changes: 21 additions & 9 deletions solara/toestand.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@

import solara
import solara.settings
import solara.server.settings
from solara import _using_solara_server
from solara.util import nullcontext

Expand Down Expand Up @@ -372,7 +373,9 @@ def __init__(self, default_value: S, key=None, equals: Callable[[Any, Any], bool
self.default_value = default_value
self._unwrap = unwrap
self.equals = equals
self._mutation_detection = solara.settings.storage.mutation_detection
self._mutation_detection = solara.settings.storage.mutation_detection is True or (
solara.settings.storage.mutation_detection is None and not solara.server.settings.main.mode == "production"
)
if self._mutation_detection:
frame = _find_outside_solara_frame()
if frame is not None:
Expand Down Expand Up @@ -468,27 +471,36 @@ def mutation_detection_storage(default_value: S, key=None, equals=None) -> Value
return MutateDetectorStore[S](kernel_store, equals=equals or default_equals)


def default_storage(default_value: S, key=None, equals=None) -> ValueBase[S]:
# in solara v2 we will also do this when mutation_detection is None
# and we do not run on production mode
if solara.settings.storage.mutation_detection is True:
def default_storage(default_value: S, key=None, equals=None, disable_mutation_detection=False) -> ValueBase[S]:
# We use mutation detection if it is explicitly enabled, or if it is not explicitly disabled and
# We aren't running in production mode
if not disable_mutation_detection and (
solara.settings.storage.mutation_detection is True
or (solara.settings.storage.mutation_detection is None and not solara.server.settings.main.mode == "production")
):
return mutation_detection_storage(default_value, key=key, equals=equals)
else:
return KernelStoreValue[S](default_value, key=key, equals=equals or equals_extra)


def _call_storage_factory(default_value: S, key=None, equals=None) -> ValueBase[S]:
def _call_storage_factory(default_value: S, key=None, equals=None, disable_mutation_detection=False) -> ValueBase[S]:
factory = solara.settings.storage.get_factory()
return factory(default_value, key=key, equals=equals)
try:
return factory(default_value, key=key, equals=equals, disable_mutation_detection=disable_mutation_detection)
except TypeError as e:
if "unexpected keyword argument 'disable_mutation_detection'" in str(e):
logger.warning("The custom storage factory %s does not support disable_mutation_detection", factory.__name__)
return factory(default_value, key=key, equals=equals)
raise TypeError from e


class Reactive(ValueBase[S]):
_storage: ValueBase[S]

def __init__(self, default_value: Union[S, ValueBase[S]], key=None, equals=None):
def __init__(self, default_value: Union[S, ValueBase[S]], key=None, equals=None, disable_mutation_detection=False):
super().__init__()
if not isinstance(default_value, ValueBase):
self._storage = _call_storage_factory(default_value, key=key, equals=equals)
self._storage = _call_storage_factory(default_value, key=key, equals=equals, disable_mutation_detection=disable_mutation_detection)
else:
self._storage = default_value
self.__post__init__()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,56 +10,54 @@

@solara.component
def Page():
with solara.Column(gap=0):
title = "Build your Jupyter dashboard using Solara"
solara.Meta(property="og:title", content=title)
solara.Meta(name="twitter:title", content=title)
solara.Title(title)
title = "Build your Jupyter dashboard using Solara"
solara.Meta(property="og:title", content=title)
solara.Meta(name="twitter:title", content=title)
solara.Title(title)

img = "https://dxhl76zpt6fap.cloudfront.net/public/docs/tutorial/jupyter-dashboard1.webp"
solara.Meta(name="twitter:image", content=img)
solara.Meta(property="og:image", content=img)
img = "https://dxhl76zpt6fap.cloudfront.net/public/docs/tutorial/jupyter-dashboard1.webp"
solara.Meta(name="twitter:image", content=img)
solara.Meta(property="og:image", content=img)

description = "Learn how to build a Jupyter dashboard and deploy it as a web app using Solara."
solara.Meta(name="description", property="og:description", content=description)
solara.Meta(name="twitter:description", content=description)
tags = [
"jupyter",
"jupyter dashboard",
"dashboard",
"web app",
"deploy",
"solara",
]
solara.Meta(name="keywords", content=", ".join(tags))
with solara.Column():
Notebook(
Path(HERE / "_jupyter_dashboard_1.ipynb"),
show_last_expressions=True,
execute=False,
outputs={
"a7d17a84": None, # empty output (7)
# original: https://github.com/widgetti/solara/assets/1765949/e844acdb-c77d-4df4-ba4c-a629f92f18a3
"82f1d2f7": solara.Image("https://dxhl76zpt6fap.cloudfront.net/pages/docs/content/60-jupyter-dashboard-part1/map.webp"), # map (11)
"3e7ea361": None, # (13)
# original: https://github.com/widgetti/solara/assets/1765949/daaa3a46-61f5-431f-8003-b42b5915da4b
"56055643": solara.Image("https://dxhl76zpt6fap.cloudfront.net/pages/docs/content/60-jupyter-dashboard-part1/view.webp"), # View (15)
# original: https://github.com/widgetti/solara/assets/1765949/2f4daf0f-b7d8-4f70-b04a-c27542cffdb0
"c78010ec": solara.Image("https://dxhl76zpt6fap.cloudfront.net/pages/docs/content/60-jupyter-dashboard-part1/page.webp"), # Page (20)
# original: https://github.com/widgetti/solara/assets/1765949/a691d9f1-f07b-4e06-b21b-20980476ad64
"18290364": solara.Image("https://dxhl76zpt6fap.cloudfront.net/pages/docs/content/60-jupyter-dashboard-part1/controls.webp"), # Controls
"0ca68fe8": None,
"fef5d187": None,
# original: https://github.com/widgetti/solara/assets/1765949/f0075ad1-808d-458c-8797-e460ce4dc06d
"af686391": solara.Image("https://dxhl76zpt6fap.cloudfront.net/pages/docs/content/60-jupyter-dashboard-part1/full-app.webp"), # Full app
},
)
solara.Markdown(
"""
Explore this app live at [solara.dev](/apps/jupyter-dashboard-1).
description = "Learn how to build a Jupyter dashboard and deploy it as a web app using Solara."
solara.Meta(name="description", property="og:description", content=description)
solara.Meta(name="twitter:description", content=description)
tags = [
"jupyter",
"jupyter dashboard",
"dashboard",
"web app",
"deploy",
"solara",
]
solara.Meta(name="keywords", content=", ".join(tags))
Notebook(
Path(HERE / "_jupyter_dashboard_1.ipynb"),
show_last_expressions=True,
execute=False,
outputs={
"a7d17a84": None, # empty output (7)
# original: https://github.com/widgetti/solara/assets/1765949/e844acdb-c77d-4df4-ba4c-a629f92f18a3
"82f1d2f7": solara.Image("https://dxhl76zpt6fap.cloudfront.net/pages/docs/content/60-jupyter-dashboard-part1/map.webp"), # map (11)
"3e7ea361": None, # (13)
# original: https://github.com/widgetti/solara/assets/1765949/daaa3a46-61f5-431f-8003-b42b5915da4b
"56055643": solara.Image("https://dxhl76zpt6fap.cloudfront.net/pages/docs/content/60-jupyter-dashboard-part1/view.webp"), # View (15)
# original: https://github.com/widgetti/solara/assets/1765949/2f4daf0f-b7d8-4f70-b04a-c27542cffdb0
"c78010ec": solara.Image("https://dxhl76zpt6fap.cloudfront.net/pages/docs/content/60-jupyter-dashboard-part1/page.webp"), # Page (20)
# original: https://github.com/widgetti/solara/assets/1765949/a691d9f1-f07b-4e06-b21b-20980476ad64
"18290364": solara.Image("https://dxhl76zpt6fap.cloudfront.net/pages/docs/content/60-jupyter-dashboard-part1/controls.webp"), # Controls
"0ca68fe8": None,
"fef5d187": None,
# original: https://github.com/widgetti/solara/assets/1765949/f0075ad1-808d-458c-8797-e460ce4dc06d
"af686391": solara.Image("https://dxhl76zpt6fap.cloudfront.net/pages/docs/content/60-jupyter-dashboard-part1/full-app.webp"), # Full app
},
)
solara.Markdown(
"""
Explore this app live at [solara.dev](/apps/jupyter-dashboard-1).

Don’t miss the next tutorial and stay updated with the latest techniques and insights by subscribing to our newsletter.
"""
)
location = solara.use_router().path
MailChimp(location=location)
Don’t miss the next tutorial and stay updated with the latest techniques and insights by subscribing to our newsletter.
"""
)
location = solara.use_router().path
MailChimp(location=location)
1 change: 0 additions & 1 deletion solara/widgets/vue/navigator.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<template>
<span></span>
</template>
<script>
Expand Down
4 changes: 2 additions & 2 deletions tests/unit/toestand_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -852,13 +852,13 @@ def Test():

box, rc = solara.render(Test(), handle_error=False)

if solara.settings.storage.mutation_detection:
if solara.settings.storage.mutation_detection is not False:
# a copy is made, so get a reference to the actual used object
df = get_storage(store).value.public
assert rc.find(v.Alert).widget.children[0] == repr(id(df))
df2 = df2.copy()
store.set(df2)
if solara.settings.storage.mutation_detection:
if solara.settings.storage.mutation_detection is not False:
df2 = get_storage(store).value.public
assert rc.find(v.Alert).widget.children[0] == repr(id(df2))

Expand Down
Loading