Skip to content

hooks

Hooks management.

Attributes

Functions:

get_hooks_handler()

Get the hook handler environment variable.

Returns:

Type Description
EventHooks

hook handler
Source code in pyrevitlib/pyrevit/loader/hooks.py 
13
14
15
16
17
18
19
def get_hooks_handler():
    """Get the hook handler environment variable.

    Returns:
        (EventHooks): hook handler
    """
    return envvars.get_pyrevit_env_var(envvars.HOOKSHANDLER_ENVVAR)

set_hooks_handler(handler)

Set the hook handler environment variable.

Parameters:

Name Type Description Default
handler EventHooks

hook handler

 required
Source code in pyrevitlib/pyrevit/loader/hooks.py 
22
23
24
25
26
27
28
def set_hooks_handler(handler):
    """Set the hook handler environment variable.

    Args:
        handler (EventHooks): hook handler
    """
    envvars.set_pyrevit_env_var(envvars.HOOKSHANDLER_ENVVAR, handler)

get_event_hooks()

Get all the event hooks.

Source code in pyrevitlib/pyrevit/loader/hooks.py 
31
32
33
34
35
36
def get_event_hooks():
    """Get all the event hooks."""
    hooks_handler = get_hooks_handler()
    if hooks_handler:
        return hooks_handler.GetAllEventHooks()
    return []

unregister_all_hooks()

Unregister all hooks.

Source code in pyrevitlib/pyrevit/loader/hooks.py 
39
40
41
42
def unregister_all_hooks():
    """Unregister all hooks."""
    hooks_handler = get_hooks_handler()
    hooks_handler.UnRegisterAllHooks(uiApp=HOST_APP.uiapp)

activate()

Activate all event hooks.

Source code in pyrevitlib/pyrevit/loader/hooks.py 
45
46
47
48
def activate():
    """Activate all event hooks."""
    hooks_handler = get_hooks_handler()
    hooks_handler.ActivateEventHooks(uiApp=HOST_APP.uiapp)

setup_hooks(session_id=None)

Setup the hooks for the given session.

If no session is specified, use the current one.

Parameters:

Name Type Description Default
session_id str

Session. Defaults to None.

 None
Source code in pyrevitlib/pyrevit/loader/hooks.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def setup_hooks(session_id=None):
    """Setup the hooks for the given session.

    If no session is specified, use the current one.

    Args:
        session_id (str, optional): Session. Defaults to None.
    """
    # make sure session id is availabe
    if not session_id:
        session_id = sessioninfo.get_session_uuid()

    hooks_handler = get_hooks_handler()
    if hooks_handler:
        # deactivate old
        hooks_handler.DeactivateEventHooks(uiApp=HOST_APP.uiapp)
    # setup new
    hooks_handler = EventHooks(session_id)
    set_hooks_handler(hooks_handler)
    unregister_all_hooks()