14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
17
"""Support for plugin hooking logic."""
19
from bzrlib import registry
19
from __future__ import absolute_import
20
25
from bzrlib.lazy_import import lazy_import
21
from bzrlib.symbol_versioning import deprecated_method
22
26
lazy_import(globals(), """
25
29
from bzrlib import (
26
_format_version_tuple,
29
from bzrlib.help_topics import help_as_plain_text
30
_format_version_tuple,
34
from bzrlib.i18n import gettext
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.msgeditor', 'hooks'), 'bzrlib.msgeditor',
50
known_hooks.register_lazy(('bzrlib.mutabletree', 'MutableTree.hooks'),
51
'bzrlib.mutabletree', 'MutableTreeHooks')
52
known_hooks.register_lazy(('bzrlib.smart.client', '_SmartClient.hooks'),
53
'bzrlib.smart.client', 'SmartClientHooks')
54
known_hooks.register_lazy(('bzrlib.smart.server', 'SmartTCPServer.hooks'),
55
'bzrlib.smart.server', 'SmartServerHooks')
56
known_hooks.register_lazy(
57
('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks'),
58
'bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilderHooks')
59
known_hooks.register_lazy(
60
('bzrlib.merge_directive', '_BaseMergeDirective.hooks'),
61
'bzrlib.merge_directive', 'MergeDirectiveHooks')
38
class KnownHooksRegistry(registry.Registry):
39
# known_hooks registry contains
40
# tuple of (module, member name) which is the hook point
41
# module where the specific hooks are defined
42
# callable to get the empty specific Hooks for that attribute
44
def register_lazy_hook(self, hook_module_name, hook_member_name,
45
hook_factory_member_name):
46
self.register_lazy((hook_module_name, hook_member_name),
47
hook_module_name, hook_factory_member_name)
49
def iter_parent_objects(self):
50
"""Yield (hook_key, (parent_object, attr)) tuples for every registered
51
hook, where 'parent_object' is the object that holds the hook
54
This is useful for resetting/restoring all the hooks to a known state,
55
as is done in bzrlib.tests.TestCase._clear_hooks.
57
for key in self.keys():
58
yield key, self.key_to_parent_and_attribute(key)
60
def key_to_parent_and_attribute(self, (module_name, member_name)):
61
"""Convert a known_hooks key to a (parent_obj, attr) pair.
63
:param key: A tuple (module_name, member_name) as found in the keys of
64
the known_hooks registry.
65
:return: The parent_object of the hook and the name of the attribute on
66
that parent object where the hook is kept.
68
parent_mod, parent_member, attr = pyutils.calc_parent_name(module_name,
70
return pyutils.get_named_object(parent_mod, parent_member), attr
73
_builtin_known_hooks = (
74
('bzrlib.branch', 'Branch.hooks', 'BranchHooks'),
75
('bzrlib.controldir', 'ControlDir.hooks', 'ControlDirHooks'),
76
('bzrlib.commands', 'Command.hooks', 'CommandHooks'),
77
('bzrlib.config', 'ConfigHooks', '_ConfigHooks'),
78
('bzrlib.info', 'hooks', 'InfoHooks'),
79
('bzrlib.lock', 'Lock.hooks', 'LockHooks'),
80
('bzrlib.merge', 'Merger.hooks', 'MergeHooks'),
81
('bzrlib.msgeditor', 'hooks', 'MessageEditorHooks'),
82
('bzrlib.mutabletree', 'MutableTree.hooks', 'MutableTreeHooks'),
83
('bzrlib.smart.client', '_SmartClient.hooks', 'SmartClientHooks'),
84
('bzrlib.smart.server', 'SmartTCPServer.hooks', 'SmartServerHooks'),
85
('bzrlib.status', 'hooks', 'StatusHooks'),
86
('bzrlib.transport', 'Transport.hooks', 'TransportHooks'),
87
('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks',
88
'RioVersionInfoBuilderHooks'),
89
('bzrlib.merge_directive', 'BaseMergeDirective.hooks',
90
'MergeDirectiveHooks'),
93
known_hooks = KnownHooksRegistry()
94
for (_hook_module, _hook_attribute, _hook_class) in _builtin_known_hooks:
95
known_hooks.register_lazy_hook(_hook_module, _hook_attribute, _hook_class)
96
del _builtin_known_hooks, _hook_module, _hook_attribute, _hook_class
64
99
def known_hooks_key_to_object((module_name, member_name)):
95
113
FOO hook is triggered.
116
def __init__(self, module=None, member_name=None):
117
"""Create a new hooks dictionary.
119
:param module: The module from which this hooks dictionary should be loaded
120
(used for lazy hooks)
121
:param member_name: Name under which this hooks dictionary should be loaded.
122
(used for lazy hooks)
99
124
dict.__init__(self)
100
125
self._callable_names = {}
102
def create_hook(self, hook):
103
"""Create a hook which can have callbacks registered for it.
105
:param hook: The hook to create. An object meeting the protocol of
106
bzrlib.hooks.HookPoint. It's name is used as the key for future
126
self._lazy_callable_names = {}
127
self._module = module
128
self._member_name = member_name
130
def add_hook(self, name, doc, introduced, deprecated=None):
131
"""Add a hook point to this dictionary.
133
:param name: The name of the hook, for clients to use when registering.
134
:param doc: The docs for the hook.
135
:param introduced: When the hook was introduced (e.g. (0, 15)).
136
:param deprecated: When the hook was deprecated, None for
109
if hook.name in self:
110
raise errors.DuplicateKey(hook.name)
111
self[hook.name] = hook
140
raise errors.DuplicateKey(name)
142
callbacks = _lazy_hooks.setdefault(
143
(self._module, self._member_name, name), [])
146
hookpoint = HookPoint(name=name, doc=doc, introduced=introduced,
147
deprecated=deprecated, callbacks=callbacks)
148
self[name] = hookpoint
114
151
"""Generate the documentation for this Hooks instance.
144
181
the code names are rarely meaningful for end users and this is not
145
182
intended for debugging.
147
return self._callable_names.get(a_callable, "No hook name")
184
name = self._callable_names.get(a_callable, None)
185
if name is None and a_callable is not None:
186
name = self._lazy_callable_names.get((a_callable.__module__,
187
a_callable.__name__),
190
return 'No hook name'
194
def install_named_hook_lazy(self, hook_name, callable_module,
195
callable_member, name):
196
"""Install a_callable in to the hook hook_name lazily, and label it.
198
:param hook_name: A hook name. See the __init__ method for the complete
200
:param callable_module: Name of the module in which the callable is
202
:param callable_member: Member name of the callable.
203
:param name: A name to associate the callable with, to show users what
207
hook = self[hook_name]
209
raise errors.UnknownHook(self.__class__.__name__, hook_name)
211
hook_lazy = getattr(hook, "hook_lazy")
212
except AttributeError:
213
raise errors.UnsupportedOperation(self.install_named_hook_lazy,
216
hook_lazy(callable_module, callable_member, name)
218
self.name_hook_lazy(callable_module, callable_member, name)
149
220
def install_named_hook(self, hook_name, a_callable, name):
150
221
"""Install a_callable in to the hook hook_name, and label it name.
152
:param hook_name: A hook name. See the __init__ method of BranchHooks
153
for the complete list of hooks.
223
:param hook_name: A hook name. See the __init__ method for the complete
154
225
:param a_callable: The callable to be invoked when the hook triggers.
155
226
The exact signature will depend on the hook - see the __init__
156
method of BranchHooks for details on each hook.
227
method for details on each hook.
157
228
:param name: A name to associate a_callable with, to show users what is
169
240
if name is not None:
170
241
self.name_hook(a_callable, name)
243
def uninstall_named_hook(self, hook_name, label):
244
"""Uninstall named hooks.
246
:param hook_name: Hook point name
247
:param label: Label of the callable to uninstall
250
hook = self[hook_name]
252
raise errors.UnknownHook(self.__class__.__name__, hook_name)
254
uninstall = getattr(hook, "uninstall")
255
except AttributeError:
256
raise errors.UnsupportedOperation(self.uninstall_named_hook, self)
172
260
def name_hook(self, a_callable, name):
173
261
"""Associate name with a_callable to show users what is running."""
174
262
self._callable_names[a_callable] = name
264
def name_hook_lazy(self, callable_module, callable_member, callable_name):
265
self._lazy_callable_names[(callable_module, callable_member)]= \
177
269
class HookPoint(object):
178
270
"""A single hook that clients can register to be called back when it fires.
180
272
:ivar name: The name of the hook.
273
:ivar doc: The docs for using the hook.
181
274
:ivar introduced: A version tuple specifying what version the hook was
182
275
introduced in. None indicates an unknown version.
183
276
:ivar deprecated: A version tuple specifying what version the hook was
184
277
deprecated or superseded in. None indicates that the hook is not
185
278
superseded or deprecated. If the hook is superseded then the doc
186
279
should describe the recommended replacement hook to register for.
187
:ivar doc: The docs for using the hook.
190
def __init__(self, name, doc, introduced, deprecated):
282
def __init__(self, name, doc, introduced, deprecated=None, callbacks=None):
191
283
"""Create a HookPoint.
193
285
:param name: The name of the hook, for clients to use when registering.
added
removed
bzrlib/hooks.py
