bzrlib.hooks.HookPoint : API documentation

A single hook that clients can register to be called back when it fires.

Instance Variables	name	The name of the hook.
	doc	The docs for using the hook.
	introduced	A version tuple specifying what version the hook was introduced in. None indicates an unknown version.
	deprecated	A version tuple specifying what version the hook was deprecated or superseded in. None indicates that the hook is not superseded or deprecated. If the hook is superseded then the doc should describe the recommended replacement hook to register for.

Method	__init__	Create a HookPoint.
Method	docs	Generate the documentation for this HookPoint.
Method	__eq__	Undocumented
Method	hook_lazy	Lazily register a callback to be called when this HookPoint fires.
Method	hook	Register a callback to be called when this HookPoint fires.
Method	uninstall	Uninstall the callback with the specified label.
Method	__iter__	Undocumented
Method	__len__	Undocumented
Method	__repr__	Undocumented

def __init__(self, name, doc, introduced, deprecated=None, callbacks=None):

Create a HookPoint.

Parameters	name	The name of the hook, for clients to use when registering.
	doc	The docs for the hook.
	introduced	When the hook was introduced (e.g. (0, 15)).
	deprecated	When the hook was deprecated, None for not-deprecated.

def docs(self):

Generate the documentation for this HookPoint.

        :return: A string terminated in 
.

def hook_lazy(self, callback_module, callback_member, callback_label):

Lazily register a callback to be called when this HookPoint fires.

Parameters	callback_module	Module of the callable to use when this HookPoint fires.
	callback_member	Member name of the callback.
	callback_label	A label to show in the UI while this callback is processing.

def hook(self, callback, callback_label):

Parameters	callback	The callable to use when this HookPoint fires.
	callback_label	A label to show in the UI while this callback is processing.

def uninstall(self, label):

Uninstall the callback with the specified label.

Parameters label Label of the entry to uninstall

b.h.HookPoint(object) : class documentation