main.py
. They can be defined in that same file or imported. No decorators or special syntax are required.
_
(underscore).
main.py
file has become cluttered with too many handler functions, you can organize them more effectively using the init_handlers
method. This method allows you to register handler functions from other modules. You can pass a single imported module or a list of modules to the init_handlers method to register multiple handlers simultaneously:
_
prefix as described before to prevent exposing unwanted functions to front-end.init_handlers
within other modules, which allows for a sequence of registrations:
main.py
.
state
argument in the handler, which will provide you with a WriterState
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
.
handle_click
, his new counter value will be 5. Other sessions remain unaffected.
=
, +=
, etc). This is because Python doesn’t offer a performant, reliable mechanism to detect mutations. See the two examples below.
subscribe_mutation
is compatible with event handler signature. It will accept all the arguments
of the event handler (context
, payload
, …).payload
argument.
For example, the wf-change
event in a Text Input component is triggered every time the value changes. As a payload, it includes the new value.
print
function to output results.
handle_fast
will accumulate all mutations and send to the front-end after the function returns. For long-running tasks, Framework will periodically check state and provide partial updates to the user.
async
keyword syntax.
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.
async def
, or objects with an __await__
method. This makes it easy to integrate with asynchronous libraries and frameworks.
context
argument provides additional information about the event.
The context provide the id of component that trigger the event in target
field.
event
field.
keyVariable
and valueVariable
.