application.hook Module

Python and Lua scripting support.

See Plugin Scripting Hooks for an introduction.

class wpull.application.hook.Actions

Bases: enum.Enum

Actions for handling responses and errors.

NORMAL

normal

Use Wpull’s original behavior.

RETRY

retry

Retry this item (as if an error has occurred).

FINISH

finish

Consider this item as done; don’t do any further processing on it.

STOP

stop

Raises HookStop to stop the Engine from running.

class wpull.application.hook.EventDispatcher

Bases: collections.abc.Mapping

add_listener(name: str, callback)

is_registered(name: str) → bool

notify(name: str, *args, **kwargs)

register(name: str)

remove_listener(name: str, callback)

unregister(name: str)

exception wpull.application.hook.HookAlreadyConnectedError

Bases: ValueError

A callback is already connected to the hook.

exception wpull.application.hook.HookDisconnected

Bases: RuntimeError

No callback is connected.

class wpull.application.hook.HookDispatcher(event_dispatcher_transclusion: typing.Union=None)

Bases: collections.abc.Mapping

Dynamic callback hook system.

call(name: str, *args, **kwargs)

Invoke the callback.

call_async(name: str, *args, **kwargs)

Invoke the callback.

connect(name, callback)

Add callback to hook.

disconnect(name: str)

Remove callback from hook.

is_connected(name: str) → bool

Return whether the hook is connected.

is_registered(name: str) → bool

register(name: str)

Register hooks that can be connected.

unregister(name: str)

Unregister hook.

exception wpull.application.hook.HookStop

Bases: Exception

Stop the engine.

Raise this exception as a more graceful alternative to sys.exit().

class wpull.application.hook.HookableMixin

Bases: object

connect_plugin(plugin: wpull.application.plugin.WpullPlugin)