18
18
"""Support for plugin hooking logic."""
19
from bzrlib import registry
24
20
from bzrlib.lazy_import import lazy_import
21
from bzrlib.symbol_versioning import deprecated_method
25
22
lazy_import(globals(), """
28
25
from bzrlib import (
29
_format_version_tuple,
26
_format_version_tuple,
29
from bzrlib.help_topics import help_as_plain_text
36
class KnownHooksRegistry(registry.Registry):
37
# known_hooks registry contains
38
# tuple of (module, member name) which is the hook point
39
# module where the specific hooks are defined
40
# callable to get the empty specific Hooks for that attribute
42
def register_lazy_hook(self, hook_module_name, hook_member_name,
43
hook_factory_member_name):
44
self.register_lazy((hook_module_name, hook_member_name),
45
hook_module_name, hook_factory_member_name)
47
def iter_parent_objects(self):
48
"""Yield (hook_key, (parent_object, attr)) tuples for every registered
49
hook, where 'parent_object' is the object that holds the hook
52
This is useful for resetting/restoring all the hooks to a known state,
53
as is done in bzrlib.tests.TestCase._clear_hooks.
55
for key in self.keys():
56
yield key, self.key_to_parent_and_attribute(key)
58
def key_to_parent_and_attribute(self, (module_name, member_name)):
59
"""Convert a known_hooks key to a (parent_obj, attr) pair.
61
:param key: A tuple (module_name, member_name) as found in the keys of
62
the known_hooks registry.
63
:return: The parent_object of the hook and the name of the attribute on
64
that parent object where the hook is kept.
66
parent_mod, parent_member, attr = pyutils.calc_parent_name(module_name,
68
return pyutils.get_named_object(parent_mod, parent_member), attr
71
_builtin_known_hooks = (
72
('bzrlib.branch', 'Branch.hooks', 'BranchHooks'),
73
('bzrlib.bzrdir', 'BzrDir.hooks', 'BzrDirHooks'),
74
('bzrlib.commands', 'Command.hooks', 'CommandHooks'),
75
('bzrlib.config', 'ConfigHooks', '_ConfigHooks'),
76
('bzrlib.info', 'hooks', 'InfoHooks'),
77
('bzrlib.lock', 'Lock.hooks', 'LockHooks'),
78
('bzrlib.merge', 'Merger.hooks', 'MergeHooks'),
79
('bzrlib.msgeditor', 'hooks', 'MessageEditorHooks'),
80
('bzrlib.mutabletree', 'MutableTree.hooks', 'MutableTreeHooks'),
81
('bzrlib.smart.client', '_SmartClient.hooks', 'SmartClientHooks'),
82
('bzrlib.smart.server', 'SmartTCPServer.hooks', 'SmartServerHooks'),
83
('bzrlib.status', 'hooks', 'StatusHooks'),
84
('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks',
85
'RioVersionInfoBuilderHooks'),
86
('bzrlib.merge_directive', 'BaseMergeDirective.hooks',
87
'MergeDirectiveHooks'),
90
known_hooks = KnownHooksRegistry()
91
for (_hook_module, _hook_attribute, _hook_class) in _builtin_known_hooks:
92
known_hooks.register_lazy_hook(_hook_module, _hook_attribute, _hook_class)
93
del _builtin_known_hooks, _hook_module, _hook_attribute, _hook_class
33
known_hooks = registry.Registry()
34
# known_hooks registry contains
35
# tuple of (module, member name) which is the hook point
36
# module where the specific hooks are defined
37
# callable to get the empty specific Hooks for that attribute
38
known_hooks.register_lazy(('bzrlib.branch', 'Branch.hooks'), 'bzrlib.branch',
40
known_hooks.register_lazy(('bzrlib.bzrdir', 'BzrDir.hooks'), 'bzrlib.bzrdir',
42
known_hooks.register_lazy(('bzrlib.commands', 'Command.hooks'),
43
'bzrlib.commands', 'CommandHooks')
44
known_hooks.register_lazy(('bzrlib.lock', 'Lock.hooks'), 'bzrlib.lock',
46
known_hooks.register_lazy(('bzrlib.msgeditor', 'hooks'), 'bzrlib.msgeditor',
48
known_hooks.register_lazy(('bzrlib.mutabletree', 'MutableTree.hooks'),
49
'bzrlib.mutabletree', 'MutableTreeHooks')
50
known_hooks.register_lazy(('bzrlib.smart.client', '_SmartClient.hooks'),
51
'bzrlib.smart.client', 'SmartClientHooks')
52
known_hooks.register_lazy(('bzrlib.smart.server', 'SmartTCPServer.hooks'),
53
'bzrlib.smart.server', 'SmartServerHooks')
54
known_hooks.register_lazy(
55
('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks'),
56
'bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilderHooks')
96
59
def known_hooks_key_to_object((module_name, member_name)):
100
63
the known_hooks registry.
101
64
:return: The object this specifies.
103
return pyutils.get_named_object(module_name, member_name)
106
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3)))
107
def known_hooks_key_to_parent_and_attribute(key):
108
"""See KnownHooksRegistry.key_to_parent_and_attribute."""
109
return known_hooks.key_to_parent_and_attribute(key)
66
return registry._LazyObjectGetter(module_name, member_name).get_obj()
69
def known_hooks_key_to_parent_and_attribute((module_name, member_name)):
70
"""Convert a known_hooks key to a object.
72
:param key: A tuple (module_name, member_name) as found in the keys of
73
the known_hooks registry.
74
:return: The object this specifies.
76
member_list = member_name.rsplit('.', 1)
77
if len(member_list) == 2:
78
parent_name, attribute = member_list
81
attribute = member_name
82
parent = known_hooks_key_to_object((module_name, parent_name))
83
return parent, attribute
112
86
class Hooks(dict):
116
90
FOO hook is triggered.
119
def __init__(self, module=None, member_name=None):
120
"""Create a new hooks dictionary.
122
:param module: The module from which this hooks dictionary should be loaded
123
(used for lazy hooks)
124
:param member_name: Name under which this hooks dictionary should be loaded.
125
(used for lazy hooks)
127
94
dict.__init__(self)
128
95
self._callable_names = {}
129
self._module = module
130
self._member_name = member_name
132
def add_hook(self, name, doc, introduced, deprecated=None):
133
"""Add a hook point to this dictionary.
135
:param name: The name of the hook, for clients to use when registering.
136
:param doc: The docs for the hook.
137
:param introduced: When the hook was introduced (e.g. (0, 15)).
138
:param deprecated: When the hook was deprecated, None for
142
raise errors.DuplicateKey(name)
144
callbacks = _lazy_hooks.setdefault(
145
(self._module, self._member_name, name), [])
148
hookpoint = HookPoint(name=name, doc=doc, introduced=introduced,
149
deprecated=deprecated, callbacks=callbacks)
150
self[name] = hookpoint
152
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
153
97
def create_hook(self, hook):
154
98
"""Create a hook which can have callbacks registered for it.
198
142
return self._callable_names.get(a_callable, "No hook name")
200
def install_named_hook_lazy(self, hook_name, callable_module,
201
callable_member, name):
202
"""Install a_callable in to the hook hook_name lazily, and label it.
204
:param hook_name: A hook name. See the __init__ method for the complete
206
:param callable_module: Name of the module in which the callable is
208
:param callable_member: Member name of the callable.
209
:param name: A name to associate the callable with, to show users what
213
hook = self[hook_name]
215
raise errors.UnknownHook(self.__class__.__name__, hook_name)
217
hook_lazy = getattr(hook, "hook_lazy")
218
except AttributeError:
219
raise errors.UnsupportedOperation(self.install_named_hook_lazy,
222
hook_lazy(callable_module, callable_member, name)
224
144
def install_named_hook(self, hook_name, a_callable, name):
225
145
"""Install a_callable in to the hook hook_name, and label it name.
227
:param hook_name: A hook name. See the __init__ method for the complete
147
:param hook_name: A hook name. See the __init__ method of BranchHooks
148
for the complete list of hooks.
229
149
:param a_callable: The callable to be invoked when the hook triggers.
230
150
The exact signature will depend on the hook - see the __init__
231
method for details on each hook.
151
method of BranchHooks for details on each hook.
232
152
:param name: A name to associate a_callable with, to show users what is
270
173
"""A single hook that clients can register to be called back when it fires.
272
175
:ivar name: The name of the hook.
273
:ivar doc: The docs for using the hook.
274
176
:ivar introduced: A version tuple specifying what version the hook was
275
177
introduced in. None indicates an unknown version.
276
178
:ivar deprecated: A version tuple specifying what version the hook was
277
deprecated or superseded in. None indicates that the hook is not
278
superseded or deprecated. If the hook is superseded then the doc
179
deprecated or superceded in. None indicates that the hook is not
180
superceded or deprecated. If the hook is superceded then the doc
279
181
should describe the recommended replacement hook to register for.
182
:ivar doc: The docs for using the hook.
282
def __init__(self, name, doc, introduced, deprecated=None, callbacks=None):
185
def __init__(self, name, doc, introduced, deprecated):
283
186
"""Create a HookPoint.
285
188
:param name: The name of the hook, for clients to use when registering.
313
214
strings.append('Introduced in: %s' % introduced_string)
314
215
if self.deprecated:
315
216
deprecated_string = _format_version_tuple(self.deprecated)
316
strings.append('Deprecated in: %s' % deprecated_string)
218
deprecated_string = 'Not deprecated'
219
strings.append('Deprecated in: %s' % deprecated_string)
317
220
strings.append('')
318
strings.extend(textwrap.wrap(self.__doc__,
319
break_long_words=False))
221
strings.extend(textwrap.wrap(self.__doc__))
320
222
strings.append('')
321
223
return '\n'.join(strings)
323
225
def __eq__(self, other):
324
return (type(other) == type(self) and other.__dict__ == self.__dict__)
326
def hook_lazy(self, callback_module, callback_member, callback_label):
327
"""Lazily register a callback to be called when this HookPoint fires.
329
:param callback_module: Module of the callable to use when this
331
:param callback_member: Member name of the callback.
332
:param callback_label: A label to show in the UI while this callback is
335
obj_getter = registry._LazyObjectGetter(callback_module,
337
self._callbacks.append((obj_getter, callback_label))
226
return (type(other) == type(self) and
227
other.__dict__ == self.__dict__)
339
229
def hook(self, callback, callback_label):
340
230
"""Register a callback to be called when this HookPoint fires.
343
233
:param callback_label: A label to show in the UI while this callback is
346
obj_getter = registry._ObjectGetter(callback)
347
self._callbacks.append((obj_getter, callback_label))
349
def uninstall(self, label):
350
"""Uninstall the callback with the specified label.
352
:param label: Label of the entry to uninstall
354
entries_to_remove = []
355
for entry in self._callbacks:
356
(entry_callback, entry_label) = entry
357
if entry_label == label:
358
entries_to_remove.append(entry)
359
if entries_to_remove == []:
360
raise KeyError("No entry with label %r" % label)
361
for entry in entries_to_remove:
362
self._callbacks.remove(entry)
236
self._callbacks.append(callback)
237
if callback_label is not None:
238
self._callback_names[callback] = callback_label
364
240
def __iter__(self):
365
return (callback.get_obj() for callback, name in self._callbacks)
241
return iter(self._callbacks)
367
243
def __len__(self):
368
244
return len(self._callbacks)
423
300
hooks = known_hooks_key_to_object(hook_key)
424
301
segments.append(hooks.docs())
425
302
return '\n'.join(segments)
428
# Lazily registered hooks. Maps (module, name, hook_name) tuples
429
# to lists of tuples with objectgetters and names
433
def install_lazy_named_hook(hookpoints_module, hookpoints_name, hook_name,
435
"""Install a callable in to a hook lazily, and label it name.
437
:param hookpoints_module: Module name of the hook points.
438
:param hookpoints_name: Name of the hook points.
439
:param hook_name: A hook name.
440
:param callable: a callable to call for the hook.
441
:param name: A name to associate a_callable with, to show users what is
444
key = (hookpoints_module, hookpoints_name, hook_name)
445
obj_getter = registry._ObjectGetter(a_callable)
446
_lazy_hooks.setdefault(key, []).append((obj_getter, name))
added
removed
bzrlib/hooks.py
