solara 1.30.1__py2.py3-none-any.whl → 1.31.0__py2.py3-none-any.whl

solara/website/pages/documentation/api/routing/use_route.py

@@ -1,80 +0,0 @@
-"""
-# use_route
-"""
-
-import solara
-from solara.website.utils import apidoc
-
-title = "use_route"
-
-
-@solara.component
-def Fruit():
-    # this gets all routes in fruit's children
-    route, routes = solara.use_route()
-
-    if route is None:
-        with solara.Link("banana") as main:
-            solara.Button("Fruit not found, go to banana")
-        return main
-
-    if route.path == "/":
-        with solara.Link("banana") as main:
-            solara.Button("Choose a fruit, I recomment banana")
-        return main
-
-    with solara.VBox() as main:
-        with solara.HBox():
-            for route_fruit in routes[1:]:
-                with solara.Link(solara.resolve_path(route_fruit)):
-                    solara.Button(route_fruit.path)
-
-            with solara.Link("/documentation/api/routing/use_route/fruit/nofruit", nofollow=True):
-                solara.Button("Wrong fruit")
-            with solara.Link("/documentation/api/routing/use_route/not-routed", nofollow=True):
-                solara.Button("Wrong url")
-        solara.Success(f"You chose {route.path}")
-    return main
-
-
-@solara.component
-def Page():
-    # this gets the top level routes, '/' and 'fruit'
-    route_current, routes_all = solara.use_route()
-    with solara.VBox() as main:
-        with solara.Card("Navigation using buttons"):
-            with solara.HBox():
-                for route in routes_all:
-                    with solara.Link(route):
-                        solara.Button(route.path, color="red" if route_current == route else None)
-        with solara.Card("Content decided by route:"):
-            if route_current is None:
-                solara.Error("Page does not exist")
-                with solara.Link("fruit/kiwi"):
-                    solara.Button("Go to fruit/kiwi")
-            elif route_current.path == "/":
-                with solara.Link("fruit/banana"):
-                    solara.Button("Go to fruit/banana")
-            elif route_current.path == "fruit":
-                Fruit()
-            else:
-                solara.Error(f"Unknown route: {route_current.path}")
-    return main
-
-
-routes = [
-    solara.Route(path="/"),
-    solara.Route(
-        path="fruit",
-        component=Fruit,
-        children=[
-            solara.Route(path="/"),
-            solara.Route(path="kiwi"),
-            solara.Route(path="banana"),
-            solara.Route(path="apple"),
-        ],
-    ),
-]
-
-sources = [Fruit.f, Page.f]  # type: ignore
-__doc__ += apidoc(solara.use_route)  # type: ignore

solara/website/pages/documentation/api/routing/use_router.py

@@ -1,15 +0,0 @@
-"""
-# use_router
-
-"""
-import solara
-from solara.website.components import NoPage
-from solara.website.utils import apidoc
-
-title = "use_router"
-
-
-Page = NoPage
-
-
-__doc__ += apidoc(solara.use_router)  # type: ignore

solara/website/pages/documentation/api/utilities/__init__.py

@@ -1,9 +0,0 @@
-import solara
-from solara.website.components import NoPage, SubCategoryLayout
-
-Page = NoPage
-
-
-@solara.component
-def Layout(children=[]):
-    SubCategoryLayout(children=children)

solara/website/pages/documentation/api/utilities/component_vue.py

@@ -1,11 +0,0 @@
-"""# component_vue
-
-"""
-import solara
-import solara.autorouting
-from solara.website.components import NoPage
-from solara.website.utils import apidoc
-
-title = "component_vue"
-Page = NoPage
-__doc__ += apidoc(solara.component_vue)  # type: ignore

solara/website/pages/documentation/api/utilities/computed.py

@@ -1,16 +0,0 @@
-"""
-# computed
-
-"""
-
-import solara
-from solara.website.components import NoPage
-from solara.website.utils import apidoc
-
-title = "computed"
-
-
-Page = NoPage
-
-
-__doc__ += apidoc(solara.lab.computed)  # type: ignore

solara/website/pages/documentation/api/utilities/display.py

@@ -1,15 +0,0 @@
-"""
-# display
-
-"""
-import solara
-from solara.website.components import NoPage
-from solara.website.utils import apidoc
-
-title = "display"
-
-
-Page = NoPage
-
-
-__doc__ += apidoc(solara.display)  # type: ignore

solara/website/pages/documentation/api/utilities/get_kernel_id.py

@@ -1,16 +0,0 @@
-"""
-# get_kernel_id
-
-"""
-
-import solara
-from solara.website.components import NoPage
-from solara.website.utils import apidoc
-
-title = "get_kernel_id"
-
-
-Page = NoPage
-
-
-__doc__ += apidoc(solara.get_kernel_id)  # type: ignore

solara/website/pages/documentation/api/utilities/get_session_id.py

@@ -1,16 +0,0 @@
-"""
-# get_session_id
-
-"""
-
-import solara
-from solara.website.components import NoPage
-from solara.website.utils import apidoc
-
-title = "get_session_id"
-
-
-Page = NoPage
-
-
-__doc__ += apidoc(solara.get_session_id)  # type: ignore

solara/website/pages/documentation/api/utilities/memoize.py

@@ -1,36 +0,0 @@
-"""#Memoize
-
-"""
-import time
-
-import solara
-import solara.lab
-from solara.website.utils import apidoc
-
-# make sure the cache is only created once
-storage = solara.cache.Memory(max_items=2)
-
-
-@solara.component
-def Page():
-    x, set_x = solara.use_state(5)
-
-    @solara.memoize(storage=storage)
-    def long_running_function(x: int) -> int:
-        """This function takes a long time to run."""
-        time.sleep(3)
-        return x**2
-
-    result = long_running_function.use_thread(x)
-
-    with solara.Card("Expensive computation") as main:
-        solara.Markdown("We cache 2 values. Each computation takes 3 seconds. If you go back to a cached value, you will see the result immediately.")
-        solara.IntSlider("x", value=x, on_value=set_x)
-        if result.state == solara.ResultState.FINISHED:
-            solara.Markdown(f"Square of {x} is {result.value}")
-        else:
-            solara.Markdown("Running...")
-    return main
-
-
-__doc__ += apidoc(solara.memoize)  # type: ignore

solara/website/pages/documentation/api/utilities/on_kernel_start.py

@@ -1,27 +0,0 @@
-"""
-# on_kernel_start
-
-Run a function when a virtual kernel (re)starts and optionally run a cleanup function on shutdown.
-
-```python
-def on_kernel_start(f: Callable[[], Optional[Callable[[], None]]]) -> Callable[[], None]:
-    ...
-```
-
-`f` will be called on each virtual kernel (re)start. This (usually) happens each time a browser tab connects to the server
-[see solara server for more details](https://solara.dev/docs/understanding/solara-server).
-The (optional) function returned by `f` will be called on kernel shutdown.
-
-Note that the cleanup functions are called in reverse order with respect to the order in which they were registered
-(e.g. the cleanup function of the last call to `on_kernel_start` will be called first on kernel shutdown).
-
-The return value of on_kernel_start is a cleanup function that will remove the callback from the list of callbacks to be called on kernel start.
-
-During hot reload, the callbacks that are added from scripts or modules that will be reloaded will be removed before the app is loaded
-again. This can cause the order of the callbacks to be different than at first run.
-"""
-
-from solara.website.components import NoPage
-
-title = "on_kernel_start"
-Page = NoPage

solara/website/pages/documentation/api/utilities/reactive.py

@@ -1,15 +0,0 @@
-"""
-# reactive
-
-"""
-import solara
-from solara.website.components import NoPage
-from solara.website.utils import apidoc
-
-title = "reactive"
-
-
-Page = NoPage
-
-
-__doc__ += apidoc(solara.reactive)  # type: ignore

solara/website/pages/documentation/api/utilities/widget.py

@@ -1,104 +0,0 @@
-"""
-
-# Component.widget
-
-Create a classic ipywidget from a component.
-
-```python
-def widget(self, **kwargs):
-    ...
-```
-
-
-This will create a widget from the component. The widget will be a
-subclass of `ipywidgets.VBox` and `ipywidgets.ValueWidget`.
-
-Example
-
-```python
-import solara
-widget = solara.FileDownload.widget(data="some text data", filename="solara-demo.txt")
-```
-
-This is very useful if you are migrating your application from a classic
-ipywidget to solara. See [also the ipywidgets tutorial](/documentation/getting_started/tutorials/ipywidgets).
-
-The `ipywidgets.ValueWidget` is used to enable the use of the widget in
-interact, or interactive. The `ipywidgets.VBox` is used to enable
-nesting of widgets.
-
-All keyword arguments will be passed to the component.
-Each argument pair of `on_<name>` and `<name>` will
-be added as a trait in the widget.
-
-For example,
-
-```solara
-import solara
-import ipywidgets as widgets
-import random
-
-
-countries_demo_data = {
-    "Netherlands": ["Amsterdam", "Rotterdam", "The Hague"],
-    "Germany": ["Berlin", "Hamburg", "Munich"],
-    "France": ["Paris", "Marseille", "Lyon"],
-}
-
-
-# this component can be used in a component three, but ...
-@solara.component
-def LocationSelect(value, on_value, countries=countries_demo_data):
-    country, city = value
-    cities = countries.get(country, [])
-    # reset to None if not in the list of countries
-    if city not in cities:
-        city = None
-        # update the state if we changed/reset city
-        on_value((country, city))
-
-    with solara.Card("Location"):
-        solara.Select(label="country",
-                      values=list(countries),
-                      value=country,
-                      on_value=lambda country: on_value((country, city)),
-        )
-        solara.Select(label="city",
-                      values=cities,
-                      value=city,
-                      on_value=lambda city: on_value((country, city)),
-        )
-
-
-# Using .widget(...) we can create a widget from it.
-# For use with interact:
-@widgets.interact(location=LocationSelect.widget(value=("Netherlands", "Amsterdam")))
-def f(size=3.4, location=None):
-    print(size, location)
-
-
-# Or to add to your VBox:
-widgets.VBox(
-    [LocationSelect.widget(value=("Netherlands", "Amsterdam"))]
-)
-
-# this is how you'd use it as a component
-@solara.component
-def Page():
-    value, set_value = solara.use_state(("Netherlands", "Amsterdam"))
-    def pick():
-        country = random.choice(list(countries_demo_data))
-        city = random.choice(countries_demo_data[country])
-        set_value((country, city))
-
-    LocationSelect(value=value, on_value=set_value)
-    solara.Button("Pick random place", on_click=pick)
-
-```
-
-"""
-
-from solara.website.components import NoPage
-
-Page = NoPage
-title = "widget"

solara/website/pages/documentation/components/__init__.py

@@ -1,12 +0,0 @@
-import solara
-from solara.website.components import CategoryLayout, Gallery
-
-
-@solara.component
-def Page(route_external=None):
-    Gallery(route_external)
-
-
-@solara.component
-def Layout(children=[]):
-    CategoryLayout(children=children)

solara/website/pages/documentation/components/advanced/__init__.py

@@ -1,9 +0,0 @@
-import solara
-from solara.website.components import NoPage, SubCategoryLayout
-
-Page = NoPage
-
-
-@solara.component
-def Layout(children=[]):
-    SubCategoryLayout(children=children)

solara/website/pages/documentation/components/advanced/link.py

@@ -1,28 +0,0 @@
-"""# Link
-
-"""
-import solara
-from solara.website.utils import apidoc
-
-routes = [
-    solara.Route(path="/"),
-    solara.Route(path="kiwi"),
-    solara.Route(path="banana"),
-    solara.Route(path="apple"),
-]
-
-
-@solara.component
-def Page():
-    route_current, routes = solara.use_route()
-    with solara.VBox() as main:
-        solara.Info("Note the address bar in the browser. It should change to the path of the link.")
-        with solara.HBox():
-            for route in routes:
-                with solara.Link(route):
-                    current = route_current is route
-                    solara.Button(f"Go to {route.path}", color="red" if current else None)
-    return main
-
-
-__doc__ += apidoc(solara.Link.f)  # type: ignore

solara/website/pages/documentation/components/advanced/meta.py

@@ -1,21 +0,0 @@
-"""# Meta
-"""
-
-import solara
-from solara.website.utils import apidoc
-
-
-@solara.component
-def Page():
-    with solara.VBox() as main:
-        solara.Info("Nothing to see here, only in this page's source code, or by looking at the google search results for this page.")
-        with solara.Head():
-            solara.Meta(
-                name="description",
-                content="The Meta component can be used to set the description of a page. This is useful for SEO, or crawlers that index your page.",
-            )
-
-    return main
-
-
-__doc__ += apidoc(solara.Meta.f)  # type: ignore

solara/website/pages/documentation/components/advanced/style.py

@@ -1,44 +0,0 @@
-"""
-# Style
-
-"""
-import solara
-from solara.website.utils import apidoc
-
-
-@solara.component
-def Page():
-    insert_css, set_insert_css = solara.use_state(True)
-
-    css = """
-    .mybutton {
-        font-family: Serif;
-    }
-
-    /* this selector has to be very specific to override the vuetify style */
-    .v-btn.mybutton {
-        color: #4CAF50; /* Green */
-    }
-    /* vuetify's background color css has very high CSS-specificity, so we use !important */
-    .mybutton {
-        background-color: #FF9800 !important; /* Orange */
-    }
-    """
-
-    with solara.VBox() as main:
-        solara.Checkbox(label="Use CSS", value=insert_css, on_value=set_insert_css)
-        solara.Markdown(
-            f"""
-## CSS Example that styles the button below
-```css
-{css}
-```
-"""
-        )
-        if insert_css:
-            solara.Style(css)
-        solara.Button(label="Advanced users might want to style this", icon_name="mdi-thumb-up", classes=["mybutton"])
-    return main
-
-
-__doc__ += apidoc(solara.Style.f)  # type: ignore

solara/website/pages/documentation/components/common.py

@@ -1,9 +0,0 @@
-import solara
-from solara.alias import rv
-
-
-@solara.component
-def ColorCard(title, color):
-    with rv.Card(style_=f"background-color: {color}; width: 100%; height: 100%") as main:
-        rv.CardTitle(children=[title])
-    return main

solara/website/pages/documentation/components/data/__init__.py

@@ -1,9 +0,0 @@
-import solara
-from solara.website.components import NoPage, SubCategoryLayout
-
-Page = NoPage
-
-
-@solara.component
-def Layout(children=[]):
-    SubCategoryLayout(children=children)

solara/website/pages/documentation/components/data/dataframe.py

@@ -1,44 +0,0 @@
-"""
-# DataFrame
-
-"""
-
-from typing import Any, Dict, Optional, cast
-
-import plotly
-
-import solara
-from solara.website.utils import apidoc
-
-df = plotly.data.iris()
-
-
-@solara.component
-def Page():
-    column, set_column = solara.use_state(cast(Optional[str], None))
-    cell, set_cell = solara.use_state(cast(Dict[str, Any], {}))
-
-    def on_action_column(column):
-        set_column(column)
-
-    def on_action_cell(column, row_index):
-        set_cell(dict(column=column, row_index=row_index))
-
-    column_actions = [solara.ColumnAction(icon="mdi-sunglasses", name="User column action", on_click=on_action_column)]
-    cell_actions = [solara.CellAction(icon="mdi-white-balance-sunny", name="User cell action", on_click=on_action_cell)]
-    solara.Markdown(
-        f"""
-        ## Demo
-
-        Below we show display the titanic dataset, and demonstrate a user column and cell action. Try clicking on the triple icon when hovering
-        above a column or cell. And see the following values changes:
-
-        * Column action on: `{column}`
-        * Cell action on: `{cell}`
-
-    """
-    )
-    solara.DataFrame(df, column_actions=column_actions, cell_actions=cell_actions)
-
-
-__doc__ += apidoc(solara.DataFrame.f)  # type: ignore

solara/website/pages/documentation/components/data/pivot_table.py

@@ -1,81 +0,0 @@
-"""
-# PivotTable
-
-Interactive [Pivot Table](https://en.wikipedia.org/wiki/Pivot_table) showing aggregated data in groups.
-
-We provide three version of the pivot table
-
-    * PivotTableView: Takes already aggregated data as input
-    * PivotTable: Takes a dataframe as input and aggregates it for you.
-    * PivotTableCard: Similar to PivotTable but with a card layout, and configuration options.
-
-"""
-
-import solara
-
-try:
-    import vaex.datasets
-
-    df = vaex.datasets.titanic()
-except Exception:
-    df = None
-    vaex = None
-
-
-@solara.component
-def View():
-    # select on the 2nd x axis, index=3, which means (pclass=2, survived=true)
-    # Note: the indices refer to the header_x and header_y
-    selected, on_selected = solara.use_state({"x": [1, 3]})
-    data = solara.PivotTableData(
-        {
-            "x": ["pclass", "survived"],
-            "y": ["sex"],
-            "agg": "count",
-            "values": [["5", "118"], ["139", "61"], ["12", "146"], ["94", "25"], ["110", "418"], ["106", "75"]],
-            "values_x": ["123", "200", "158", "119", "528", "181"],
-            "values_y": ["466", "843"],
-            "headers_x": [["1", "1", "2", "2", "3", "3"], ["false", "true", "false", "true", "false", "true"]],
-            "headers_y": [["female", "male"]],
-            "counts_x": 6,
-            "counts_y": 2,
-            "total": "1,309",
-        }
-    )
-    with solara.VBox() as main:
-        solara.Markdown(f"`selected = {selected}`")
-        solara.PivotTableView(data=data, selected=selected, on_selected=on_selected)
-    return main
-
-
-@solara.component
-def Page():
-    if vaex is None:
-        return solara.Markdown("This example requires vaex, please install it with `pip install vaex`")
-    with solara.Div() as main:
-        solara.Markdown("# Titanic")
-        selected, on_selected = solara.use_state({"x": [0, 0]})
-        solara.provide_cross_filter()
-        with solara.VBox():
-            type, set_type = solara.use_state("view")
-            with solara.ToggleButtonsSingle(type, on_value=set_type):
-                solara.Button("PivotTableView", value="view")
-                solara.Button("PivotTable", value="df")
-                solara.Button("PivotTableCard", value="card")
-            if type == "view":
-                solara.Markdown("# PivotTableView\nThis component will take aggregates data as input")
-                View()
-            elif type == "df":
-                solara.Markdown("# PivotTable\nThis component aggregates the dataframe for you")
-                solara.Markdown(f"`selected = {selected}`")
-                solara.PivotTable(df, ["pclass"], ["sex"], selected=selected, on_selected=on_selected)
-            elif type == "card":
-                solara.Markdown("# PivotTable\nThis component aggregates the dataframe for you, and gives a UI to configure the component")
-                solara.Markdown(f"`selected = {selected}`")
-                solara.PivotTableCard(df, ["pclass"], ["sex"], selected=selected, on_selected=on_selected)
-    return main
-
-
-Component = Page
-App = Component
-app = Page()

solara/website/pages/documentation/components/enterprise/__init__.py

@@ -1,9 +0,0 @@
-import solara
-from solara.website.components import NoPage, SubCategoryLayout
-
-Page = NoPage
-
-
-@solara.component
-def Layout(children=[]):
-    SubCategoryLayout(children=children)

solara/website/pages/documentation/components/enterprise/avatar.py

@@ -1,19 +0,0 @@
-"""
-# Avatar
-
-"""
-try:
-    from solara_enterprise import auth
-except ImportError:
-    auth = None
-from solara.website.components import NoPage
-from solara.website.utils import apidoc
-
-title = "Avatar"
-
-Page = NoPage
-
-if auth:
-    __doc__ += apidoc(auth.Avatar.f)  # type: ignore
-else:
-    __doc__ += "solara-enterprise not installed."