Skip to content

[Feature Request] PreProcess and PostProcess Callback Hooks #3471

@BSd3v

Description

@BSd3v

I'd like to request PreProcess and PostProcess hooks to be used within the scope of a callback.

Essentially, this would allow developers to intercept specific things before and after a callback function is called. The PostProcess would be placed before the response was sent back to the client.

This could potentially solve issues like this: #262


Here is an example of how this could potentially work, though the hooks wouldnt be inside the callbacks:

import dash
from dash import html, Input, Output, dcc, ctx
import time

server_side_stores = {}

def my_preprocess(args, kwargs, input_state_list):
    # Log and update args with server-side store data if available
    for i in range(len(args)):
        if 'id' in input_state_list[i]:
            store_id = input_state_list[i]['id']
            if store_id in server_side_stores:
                args[i] = server_side_stores[store_id]
    return args, kwargs

def my_postprocess(output_list, response):
    # Log and update server-side store with response data
    for i in range(len(output_list)):
        if 'id' in output_list[i]:
            store_id = output_list[i]['id']
            server_side_stores[store_id] = response[i]
            response[i] = {"timestamp": time.time()}
    return response

class MyStore(dcc.Store):
    def __init__(self, id, data, *args, **kwargs):
        server_side_stores[id] = data
        timestamped_data = {"timestamp": time.time()}
        super().__init__(id=id, data=timestamped_data, *args, **kwargs)

app = dash.Dash(__name__, suppress_callback_exceptions=True)

app.layout = html.Div(
    [
        MyStore(id="my-store", data={"key": "value"}),
        dcc.Input(id="input", type="text"),
        html.Div(id="output"),
    ],
    style={"padding": 50},
)

@app.callback(
    Output("output", "children"),
    Input("my-store", "data"),
)
def update_input(store_data):
    # Preprocess
    args, kwargs = my_preprocess(
        [store_data], {}, ctx.inputs_list+ctx.states_list
    )
    result = f"Original data: {args[0]}, Store timestamp: {store_data['timestamp']}"
    return result

@app.callback(
    Output("my-store", "data"),
    Input("input", "value"),
    prevent_initial_call=True,
)
def update_store(input_value):
    # Postprocess
    resp = my_postprocess([ctx.outputs_list], [{"key": input_value}])
    return resp[0]

if __name__ == "__main__":
    app.run(debug=True)

I recommend adding the hooks to the _callback.py in _initialize_context after the func_args, func_kwargs are set and in _prepare_response. With the currently displayed pattern, there could be some potential performance drawbacks, so we might need to look at streamlining how these are iterated.

This could also be narrowed down to only the callbacks that need to be transformed/augmented in place.


This could also be used to allow dataframes to be returned from a callback, data validation on the frontend, etc.

Metadata

Metadata

Assignees

Labels

P2considered for next cyclefeaturesomething new

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions