Merge pull request #2770 from plotly/feat/running-cb

Add running to regular callbacks.

Author: T4rk1n

.pylintrc

@@ -414,7 +414,7 @@ max-bool-expr=5
 max-branches=15
 
 # Maximum number of locals for function / method body
-max-locals=18
+max-locals=20
 
 # Maximum number of parents for a class (see R0901).
 max-parents=7

CHANGELOG.md

@@ -18,6 +18,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 - [#2758](https://github.com/plotly/dash/pull/2758)
   - exposing `setProps` to `dash_clientside.clientSide_setProps` to allow for JS code to interact directly with the dash eco-system
 - [#2730](https://github.com/plotly/dash/pull/2721) Load script files with `.mjs` ending as js modules
+- [#2770](https://github.com/plotly/dash/pull/2770) Add running to regular callbacks.
 
 ## [2.15.0] - 2024-01-31
 

dash/_callback.py

@@ -166,10 +166,6 @@ def callback(
                     "Progress and progress default needs to be of same length"
                 )
 
-        if running:
-            long_spec["running"] = coerce_to_list(running)
-            validate_long_inputs(x[0] for x in long_spec["running"])
-
         if cancel:
             cancel_inputs = coerce_to_list(cancel)
             validate_long_inputs(cancel_inputs)
@@ -188,6 +184,7 @@ def callback(
         **_kwargs,
         long=long_spec,
         manager=manager,
+        running=running,
     )
 
 
@@ -227,6 +224,7 @@ def insert_callback(
     prevent_initial_call,
     long=None,
     manager=None,
+    running=None,
     dynamic_creator=False,
 ):
     if prevent_initial_call is None:
@@ -251,6 +249,8 @@ def insert_callback(
         },
         "dynamic_creator": dynamic_creator,
     }
+    if running:
+        callback_spec["running"] = running
 
     callback_map[callback_id] = {
         "inputs": callback_spec["inputs"],
@@ -289,6 +289,14 @@ def register_callback(  # pylint: disable=R0914
 
     long = _kwargs.get("long")
     manager = _kwargs.get("manager")
+    running = _kwargs.get("running")
+    if running is not None:
+        if not isinstance(running[0], (list, tuple)):
+            running = [running]
+        running = {
+            "running": {str(r[0]): r[1] for r in running},
+            "runningOff": {str(r[0]): r[2] for r in running},
+        }
     allow_dynamic_callbacks = _kwargs.get("_allow_dynamic_callbacks")
 
     output_indices = make_grouping_by_index(output, list(range(grouping_len(output))))
@@ -305,6 +313,7 @@ def register_callback(  # pylint: disable=R0914
         long=long,
         manager=manager,
         dynamic_creator=allow_dynamic_callbacks,
+        running=running,
     )
 
     # pylint: disable=too-many-locals
@@ -389,11 +398,6 @@ def add_context(*args, **kwargs):
                         "job": job,
                     }
 
-                    running = long.get("running")
-
-                    if running:
-                        data["running"] = {str(r[0]): r[1] for r in running}
-                        data["runningOff"] = {str(r[0]): r[2] for r in running}
                     cancel = long.get("cancel")
                     if cancel:
                         data["cancel"] = cancel

dash/dash-renderer/src/actions/callbacks.ts

@@ -349,7 +349,8 @@ function handleServerside(
     long: LongCallbackInfo | undefined,
     additionalArgs: [string, string, boolean?][] | undefined,
     getState: any,
-    output: string
+    output: string,
+    running: any
 ): Promise<CallbackResponse> {
     if (hooks.request_pre) {
         hooks.request_pre(payload);
@@ -363,6 +364,11 @@ function handleServerside(
     let progressDefault: any;
     let moreArgs = additionalArgs;
 
+    if (running) {
+        sideUpdate(running.running, dispatch, paths);
+        runningOff = running.runningOff;
+    }
+
     const fetchCallback = () => {
         const headers = getCSRFHeader() as any;
         let url = `${urlBase(config)}_dash-update-component`;
@@ -497,12 +503,6 @@ function handleServerside(
                     if (data.progress) {
                         sideUpdate(data.progress, dispatch, paths);
                     }
-                    if (data.running) {
-                        sideUpdate(data.running, dispatch, paths);
-                    }
-                    if (!runningOff && data.runningOff) {
-                        runningOff = data.runningOff;
-                    }
                     if (!progressDefault && data.progressDefault) {
                         progressDefault = data.progressDefault;
                     }
@@ -717,7 +717,8 @@ export function executeCallback(
                             long,
                             additionalArgs.length ? additionalArgs : undefined,
                             getState,
-                            cb.callback.output
+                            cb.callback.output,
+                            cb.callback.running
                         );
 
                         if (newHeaders) {

dash/dash-renderer/src/types/callbacks.ts

@@ -13,6 +13,7 @@ export interface ICallbackDefinition {
     state: ICallbackProperty[];
     long?: LongCallbackInfo;
     dynamic_creator?: boolean;
+    running: any;
 }
 
 export interface ICallbackProperty {

dash/dash.py

@@ -1113,7 +1113,10 @@ def interpolate_index(self, **kwargs):
         )
 
     def dependencies(self):
-        return flask.jsonify(self._callback_list)
+        return flask.Response(
+            to_json(self._callback_list),
+            content_type="application/json",
+        )
 
     def clientside_callback(self, clientside_function, *args, **kwargs):
         """Create a callback that updates the output by calling a clientside

tests/integration/callbacks/test_basic_callback.py

@@ -791,3 +791,35 @@ def on_click(_):
     dash_duo.start_server(app)
 
     assert dash_duo.get_logs() == []
+
+
+def test_cbsc019_callback_running(dash_duo):
+    lock = Lock()
+    app = Dash(__name__)
+
+    app.layout = html.Div(
+        [
+            html.Div("off", id="running"),
+            html.Button("start", id="start"),
+            html.Div(id="output"),
+        ]
+    )
+
+    @app.callback(
+        Output("output", "children"),
+        Input("start", "n_clicks"),
+        running=[[Output("running", "children"), html.B("on", id="content"), "off"]],
+        prevent_initial_call=True,
+    )
+    def on_click(_):
+        with lock:
+            pass
+        return "done"
+
+    dash_duo.start_server(app)
+    with lock:
+        dash_duo.find_element("#start").click()
+        dash_duo.wait_for_text_to_equal("#content", "on")
+
+    dash_duo.wait_for_text_to_equal("#output", "done")
+    dash_duo.wait_for_text_to_equal("#running", "off")

tests/integration/long_callback/test_basic_long_callback016.py

@@ -7,7 +7,7 @@
 
 
 @pytest.mark.skipif(
-    sys.version_info < (3, 7), reason="Python 3.6 long callbacks tests hangs up"
+    sys.version_info < (3, 9), reason="Python 3.8 long callbacks tests hangs up"
 )
 def test_lcbc016_multi_page_cancel(dash_duo, manager):
     with setup_long_callback_app(manager, "app_page_cancel") as app: