b.h.HookPoint(object) : class documentation

Part of bzrlib.hooks View In Hierarchy

A single hook that clients can register to be called back when it fires.
Instance VariablesnameThe name of the hook.
docThe docs for using the hook.
introducedA version tuple specifying what version the hook was introduced in. None indicates an unknown version.
deprecatedA 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.
ParametersnameThe name of the hook, for clients to use when registering.
docThe docs for the hook.
introducedWhen the hook was introduced (e.g. (0, 15)).
deprecatedWhen the hook was deprecated, None for not-deprecated.
def docs(self):
Generate the documentation for this HookPoint.

        :return: A string terminated in 
.
        
def __eq__(self, other):
Undocumented
def hook_lazy(self, callback_module, callback_member, callback_label):
Lazily register a callback to be called when this HookPoint fires.
Parameterscallback_moduleModule of the callable to use when this HookPoint fires.
callback_memberMember name of the callback.
callback_labelA label to show in the UI while this callback is processing.
def hook(self, callback, callback_label):
Register a callback to be called when this HookPoint fires.
ParameterscallbackThe callable to use when this HookPoint fires.
callback_labelA label to show in the UI while this callback is processing.
def uninstall(self, label):
Uninstall the callback with the specified label.
ParameterslabelLabel of the entry to uninstall
def __iter__(self):
Undocumented
def __len__(self):
Undocumented
def __repr__(self):
Undocumented
API Documentation for Bazaar, generated by pydoctor at 2018-08-15 00:17:27.