Event handlers

Events originate in the frontend. For example, when a user clicks a Button component. Using Builder, these events can be linked to event handlers.

Plain Python functions

Event handlers are Python functions accessible from main.py. They can be defined in that same file or imported. No decorators or special syntax required.

# This event handler will add an entry to the log
def handle_click()
    print("Hello")

To specify that a function isn't an event handler and should remain hidden to the frontend, prefix it with a _ (underscore).

# This function won't be visible in the frontend
# because its name starts with an underscore
def _reticulate(splines):
    r_splines = np.random.normal(size=(splines,100))
    return r_splines

Mutating state

In most cases, event handlers will modify the application state. State can be accessed by including the state argument in the handler, which will provide you with a StreamsyncState object for the session that invoked the handler.

Elements of state can be reached using the square brackets syntax state["my_element"]. Accessing keys that don't exist will return None.

def handle_click(state):
    state["counter"] += 1

The handler above receives the application state for the relevant session and mutates it. For example, if Bob's counter was 4, and he clicks on a Button linked to handle_click, his new counter value will be 5. Other sessions remain unaffected.

Mutation detection

When communicating with the frontend, Streamsync only sends state elements that have mutated.

To detect which elements have mutated, it relies on assignment (via operators such as =, +=, etc). This is because Python doesn't offer a performant, reliable mechanism to detect mutations. See the example below.

def handle_click(state):
    state["my_df"].sample(frac=1, random_state=random.seed())

    # The self-assignment is necessary when mutating
    # an existing object directly on state

    state["my_df"] = state["my_df"]

The following, arguably cleaner, code, also works as it naturally relies on assignment.

def handle_click(state):
    my_df = state["my_df"]
    my_df.sample(frac=1, random_state=random.seed())
    state["my_df"] = my_df # State assignmnet

Mutations are detected via assignment

Make sure you perform an assignment on the state element you're mutating, for the mutation to be detected.

Receiving a payload

Several events include additional data, known as the event's payload. The event handler can receive that data using the payload argument.

For example, the ss-change event in a Text Input component is triggered every time the value changes. As a payload, it includes the new value.

def handle_input_change(state, payload):
    state["value"] = payload

The content of the payload will vary depending on the event. For example, when a user takes a photo with a Webcam Capture, the picture they took is sent across as a PNG image.

def handle_webcam_capture(payload):
	image_file = payload
	with open(f"picture.png", "wb") as file_handle:
		file_handle.write(image_file)

Handling different payloads across events can be challenging, especially since the shape of the payload may vary. To simplify this process, Builder provides stub code that can help you get started with writing an event handler. You can access it by clicking the icon located next to the event when configuring the component's settings. This feature can help you quickly understand the structure of the payload and start writing the appropriate code to handle it.

Globals

You can use globals and module attributes, just as you would in a standard Python script. This is very convenient for storing a single copy of resource-intensive object.

my_ai = CatIdentifierAI()

def evaluate(state, payload):
    result = my_ai.process(payload)
    state["is_a_cat"] = result

Take into account that globals apply to all users. If you need to store data that's only relevant to a particular user, use application state.

Standard output

The standard output of an app is captured and shown in the code editor's log. You can use the standard print function to output results.

# Shown every time the app starts
print("Hello world")

def payload_inspector(state, payload):
    # Shown every time the event handler is executed
    print("Payload: " + repr(payload))

Execution flow

Event handlers run in a thread pool and are non-blocking. Each event is processed independently from each other.

State mutations are sent to the frontend after the function has finished executing. The code below will accumulate all mutations and send to the frontend after the function returns.

def handle_fast(state):
    state["text"] = "Hello"
    state["x"] += 3
    state["y"] += 2

However, for long-running tasks, Streamsync will periodically check state and provide partial updates to the user.

def handle_slowly(state):
    state["message"] = "Loading..."
    import time
    time.sleep(5)
    state["message"] = "Completed"

The code above will set message to "Loading...", then to "Completed".

Asynchronous Event Handlers

Streamsync supports asynchronous event handlers, allowing for non-blocking I/O operations directly within event handlers. This is particularly useful for tasks such as fetching data from a database, making HTTP requests, or performing any other I/O bound operation that can benefit from asynchronous execution.

Defining an Asynchronous Handler

An asynchronous event handler is defined with the standard async keyword syntax.

# An asynchronous event handler for performing an I/O bound operation
async def handle_async_click(state):
    data = await fetch_data()
    state["data"] = data

In the example above, fetch_data() is an asynchronous function that retrieves data, potentially from a remote source. The await keyword is used to wait for the operation to complete without blocking the main thread, allowing other tasks to run concurrently.

Awaitable Objects

You can use any awaitable object within an async event handler. This includes the output of any function defined with async def, or objects with an __await__ method. This makes it easy to integrate with asynchronous libraries and frameworks.

Context

The context argument provides additional information about the event. For example, if the event was triggered by a Button, the context will include target field that contains the id of the button.

def handle_click(state, context: dict):
	last_source_of_click = context['target']
	state["last_source_of_click"] = last_source_of_click

The repeater components have additional fields in the context, such as defined in keyVariable and valueVariable.

def handle_repeater_click(state, context: dict):
	key = context['keyVariable']
	state['repeater_content'][key]['last_action'] = 'Clicked'

more information in repeater chapter