API Reference

This page contains the complete API reference for dowhen.

Core Module

dowhen.bp()

Return type:: Callback

dowhen.clear_all()[source]

Return type:: None

dowhen.do(func)

Return type:: Callback

dowhen.get_source_hash(entity)[source]

dowhen.goto(target)

Return type:: Callback

dowhen.when(entity, *identifiers, condition=None, source_hash=None)

Callback Module

class dowhen.callback.Callback(func, **kwargs)[source]

Bases: object

classmethod do(func)[source]

Return type:: Callback

classmethod goto(target)[source]

Return type:: Callback

classmethod bp()[source]

Return type:: Callback

when(entity, *identifiers, condition=None, source_hash=None)[source]

Return type:: EventHandler

dowhen.callback.bp()

Return type:: Callback

dowhen.callback.do(func)

Return type:: Callback

dowhen.callback.goto(target)

Return type:: Callback

Trigger Module

class dowhen.trigger.Trigger(events, condition=None, is_global=False)[source]

Bases: object

classmethod unify_identifiers(entity, *identifiers)[source]

Unify identifiers by resolving relative line numbers.

Return type:: tuple[Union[int, str, Pattern, Literal['<start>', '<return>'], None, tuple[Union[int, str, Pattern, Literal['<start>', '<return>'], None], ...]], ...]

classmethod when(entity, *identifiers, condition=None, source_hash=None)[source]

bp()[source]

Return type:: EventHandler

do(func)[source]

Return type:: EventHandler

goto(target)[source]

Return type:: EventHandler

has_event(frame)[source]

Return type:: bool | Any

should_fire(frame)[source]

Return type:: bool | Any

dowhen.trigger.when(entity, *identifiers, condition=None, source_hash=None)

Handler Module

class dowhen.handler.EventHandler(trigger, callback)[source]

Bases: object

disable()[source]

Return type:: None

enable()[source]

Return type:: None

submit()[source]

Return type:: None

remove()[source]

Return type:: None

bp()[source]

Return type:: EventHandler

do(func)[source]

Return type:: EventHandler

goto(target)[source]

Return type:: EventHandler