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.info', 'hooks'),
45
'bzrlib.info', 'InfoHooks')
46
known_hooks.register_lazy(('bzrlib.lock', 'Lock.hooks'), 'bzrlib.lock',
48
known_hooks.register_lazy(('bzrlib.merge', 'Merger.hooks'), 'bzrlib.merge',
50
known_hooks.register_lazy(('bzrlib.msgeditor', 'hooks'), 'bzrlib.msgeditor',
52
known_hooks.register_lazy(('bzrlib.mutabletree', 'MutableTree.hooks'),
53
'bzrlib.mutabletree', 'MutableTreeHooks')
54
known_hooks.register_lazy(('bzrlib.smart.client', '_SmartClient.hooks'),
55
'bzrlib.smart.client', 'SmartClientHooks')
56
known_hooks.register_lazy(('bzrlib.smart.server', 'SmartTCPServer.hooks'),
57
'bzrlib.smart.server', 'SmartServerHooks')
58
known_hooks.register_lazy(
59
('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks'),
60
'bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilderHooks')
61
known_hooks.register_lazy(
62
('bzrlib.merge_directive', '_BaseMergeDirective.hooks'),
63
'bzrlib.merge_directive', 'MergeDirectiveHooks')
96
66
def known_hooks_key_to_object((module_name, member_name)):
116
97
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
101
dict.__init__(self)
128
102
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
104
def create_hook(self, hook):
154
105
"""Create a hook which can have callbacks registered for it.
198
149
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
151
def install_named_hook(self, hook_name, a_callable, name):
225
152
"""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
154
:param hook_name: A hook name. See the __init__ method of BranchHooks
155
for the complete list of hooks.
229
156
:param a_callable: The callable to be invoked when the hook triggers.
230
157
The exact signature will depend on the hook - see the __init__
231
method for details on each hook.
158
method of BranchHooks for details on each hook.
232
159
:param name: A name to associate a_callable with, to show users what is
added
removed
bzrlib/hooks.py
