Reactive API DocumentationΒΆ

Endpoint New base class for creating interface layers.
RelationBase A base class for relation implementations.
all_flags_set Assert that all desired_flags are set
any_file_changed Check if any of the given files have changed since the last time this was called.
any_flags_set Assert that any of the desired_flags are set
clear_flag Clear / deactivate a flag.
collect_metrics Register the decorated function to run for the collect_metrics hook.
data_changed Check if the given set of data has changed since the previous call.
endpoint_from_flag The object used for interacting with relations tied to a flag, or None.
endpoint_from_name The object used for interacting with the named relations, or None.
hook Register the decorated function to run when the current hook matches any of the hook_patterns.
is_flag_set Assert that a flag is set
main This is the main entry point for the reactive framework.
meter_status_changed Register the decorated function to run when a meter status change has been detected.
not_unless Assert that the decorated function can only be called if the desired_flags are active.
register_trigger Register a trigger to set or clear a flag when a given flag is set.
scopes These are the recommended scope values for relation implementations.
set_flag Set the given flag as active.
toggle_flag Helper that calls either set_flag() or clear_flag(), depending on the value of should_set.
when Alias for when_all().
when_all Register the decorated function to run when all of desired_flags are active.
when_any Register the decorated function to run when any of desired_flags are active.
when_file_changed Register the decorated function to run when one or more files have changed.
when_none Register the decorated function to run when none of desired_flags are active.
when_not Alias for when_none().
when_not_all Register the decorated function to run when one or more of the desired_flags are not active.