1
# Copyright (C) 2007-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Support for plugin hooking logic."""
24
from bzrlib.lazy_import import lazy_import
25
lazy_import(globals(), """
29
_format_version_tuple,
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.info', 'hooks', 'InfoHooks'),
76
('bzrlib.lock', 'Lock.hooks', 'LockHooks'),
77
('bzrlib.merge', 'Merger.hooks', 'MergeHooks'),
78
('bzrlib.msgeditor', 'hooks', 'MessageEditorHooks'),
79
('bzrlib.mutabletree', 'MutableTree.hooks', 'MutableTreeHooks'),
80
('bzrlib.smart.client', '_SmartClient.hooks', 'SmartClientHooks'),
81
('bzrlib.smart.server', 'SmartTCPServer.hooks', 'SmartServerHooks'),
82
('bzrlib.status', 'hooks', 'StatusHooks'),
83
('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks',
84
'RioVersionInfoBuilderHooks'),
85
('bzrlib.merge_directive', 'BaseMergeDirective.hooks',
86
'MergeDirectiveHooks'),
89
known_hooks = KnownHooksRegistry()
90
for (_hook_module, _hook_attribute, _hook_class) in _builtin_known_hooks:
91
known_hooks.register_lazy_hook(_hook_module, _hook_attribute, _hook_class)
92
del _builtin_known_hooks, _hook_module, _hook_attribute, _hook_class
95
def known_hooks_key_to_object((module_name, member_name)):
96
"""Convert a known_hooks key to a object.
98
:param key: A tuple (module_name, member_name) as found in the keys of
99
the known_hooks registry.
100
:return: The object this specifies.
102
return pyutils.get_named_object(module_name, member_name)
105
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3)))
106
def known_hooks_key_to_parent_and_attribute(key):
107
"""See KnownHooksRegistry.key_to_parent_and_attribute."""
108
return known_hooks.key_to_parent_and_attribute(key)
112
"""A dictionary mapping hook name to a list of callables.
114
e.g. ['FOO'] Is the list of items to be called when the
115
FOO hook is triggered.
118
def __init__(self, module=None, member_name=None):
119
"""Create a new hooks dictionary.
121
:param module: The module from which this hooks dictionary should be loaded
122
(used for lazy hooks)
123
:param member_name: Name under which this hooks dictionary should be loaded.
124
(used for lazy hooks)
127
self._callable_names = {}
128
self._module = module
129
self._member_name = member_name
131
def add_hook(self, name, doc, introduced, deprecated=None):
132
"""Add a hook point to this dictionary.
134
:param name: The name of the hook, for clients to use when registering.
135
:param doc: The docs for the hook.
136
:param introduced: When the hook was introduced (e.g. (0, 15)).
137
:param deprecated: When the hook was deprecated, None for
141
raise errors.DuplicateKey(name)
143
callbacks = _lazy_hooks.setdefault(
144
(self._module, self._member_name, name), [])
147
hookpoint = HookPoint(name=name, doc=doc, introduced=introduced,
148
deprecated=deprecated, callbacks=callbacks)
149
self[name] = hookpoint
151
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
152
def create_hook(self, hook):
153
"""Create a hook which can have callbacks registered for it.
155
:param hook: The hook to create. An object meeting the protocol of
156
bzrlib.hooks.HookPoint. It's name is used as the key for future
159
if hook.name in self:
160
raise errors.DuplicateKey(hook.name)
161
self[hook.name] = hook
164
"""Generate the documentation for this Hooks instance.
166
This introspects all the individual hooks and returns their docs as well.
168
hook_names = sorted(self.keys())
170
name = self.__class__.__name__
171
hook_docs.append(name)
172
hook_docs.append("-"*len(name))
174
for hook_name in hook_names:
175
hook = self[hook_name]
177
hook_docs.append(hook.docs())
178
except AttributeError:
181
strings.append(hook_name)
182
strings.append("~" * len(hook_name))
184
strings.append("An old-style hook. For documentation see the __init__ "
185
"method of '%s'\n" % (name,))
186
hook_docs.extend(strings)
187
return "\n".join(hook_docs)
189
def get_hook_name(self, a_callable):
190
"""Get the name for a_callable for UI display.
192
If no name has been registered, the string 'No hook name' is returned.
193
We use a fixed string rather than repr or the callables module because
194
the code names are rarely meaningful for end users and this is not
195
intended for debugging.
197
return self._callable_names.get(a_callable, "No hook name")
199
def install_named_hook_lazy(self, hook_name, callable_module,
200
callable_member, name):
201
"""Install a_callable in to the hook hook_name lazily, and label it.
203
:param hook_name: A hook name. See the __init__ method for the complete
205
:param callable_module: Name of the module in which the callable is
207
:param callable_member: Member name of the callable.
208
:param name: A name to associate the callable with, to show users what
212
hook = self[hook_name]
214
raise errors.UnknownHook(self.__class__.__name__, hook_name)
216
hook_lazy = getattr(hook, "hook_lazy")
217
except AttributeError:
218
raise errors.UnsupportedOperation(self.install_named_hook_lazy,
221
hook_lazy(callable_module, callable_member, name)
223
def install_named_hook(self, hook_name, a_callable, name):
224
"""Install a_callable in to the hook hook_name, and label it name.
226
:param hook_name: A hook name. See the __init__ method for the complete
228
:param a_callable: The callable to be invoked when the hook triggers.
229
The exact signature will depend on the hook - see the __init__
230
method for details on each hook.
231
:param name: A name to associate a_callable with, to show users what is
235
hook = self[hook_name]
237
raise errors.UnknownHook(self.__class__.__name__, hook_name)
239
# list hooks, old-style, not yet deprecated but less useful.
240
hook.append(a_callable)
241
except AttributeError:
242
hook.hook(a_callable, name)
244
self.name_hook(a_callable, name)
246
def uninstall_named_hook(self, hook_name, label):
247
"""Uninstall named hooks.
249
:param hook_name: Hook point name
250
:param label: Label of the callable to uninstall
253
hook = self[hook_name]
255
raise errors.UnknownHook(self.__class__.__name__, hook_name)
257
uninstall = getattr(hook, "uninstall")
258
except AttributeError:
259
raise errors.UnsupportedOperation(self.install_named_hook_lazy,
264
def name_hook(self, a_callable, name):
265
"""Associate name with a_callable to show users what is running."""
266
self._callable_names[a_callable] = name
269
class HookPoint(object):
270
"""A single hook that clients can register to be called back when it fires.
272
:ivar name: The name of the hook.
273
:ivar doc: The docs for using the hook.
274
:ivar introduced: A version tuple specifying what version the hook was
275
introduced in. None indicates an unknown version.
276
: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
279
should describe the recommended replacement hook to register for.
282
def __init__(self, name, doc, introduced, deprecated=None, callbacks=None):
283
"""Create a HookPoint.
285
:param name: The name of the hook, for clients to use when registering.
286
:param doc: The docs for the hook.
287
:param introduced: When the hook was introduced (e.g. (0, 15)).
288
:param deprecated: When the hook was deprecated, None for
293
self.introduced = introduced
294
self.deprecated = deprecated
295
if callbacks is None:
298
self._callbacks = callbacks
301
"""Generate the documentation for this HookPoint.
303
:return: A string terminated in \n.
306
strings.append(self.name)
307
strings.append('~'*len(self.name))
310
introduced_string = _format_version_tuple(self.introduced)
312
introduced_string = 'unknown'
313
strings.append('Introduced in: %s' % introduced_string)
315
deprecated_string = _format_version_tuple(self.deprecated)
316
strings.append('Deprecated in: %s' % deprecated_string)
318
strings.extend(textwrap.wrap(self.__doc__,
319
break_long_words=False))
321
return '\n'.join(strings)
323
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))
339
def hook(self, callback, callback_label):
340
"""Register a callback to be called when this HookPoint fires.
342
:param callback: The callable to use when this HookPoint fires.
343
: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)
365
return (callback.get_obj() for callback, name in self._callbacks)
368
return len(self._callbacks)
372
strings.append("<%s(" % type(self).__name__)
373
strings.append(self.name)
374
strings.append("), callbacks=[")
375
callbacks = self._callbacks
376
for (callback, callback_name) in callbacks:
377
strings.append(repr(callback.get_obj()))
379
strings.append(callback_name)
381
if len(callbacks) == 1:
384
return ''.join(strings)
395
A hook of type *xxx* of class *yyy* needs to be registered using::
397
yyy.hooks.install_named_hook("xxx", ...)
399
See :doc:`Using hooks<../user-guide/hooks>` in the User Guide for examples.
401
The class that contains each hook is given before the hooks it supplies. For
402
instance, BranchHooks as the class is the hooks class for
403
`bzrlib.branch.Branch.hooks`.
405
Each description also indicates whether the hook runs on the client (the
406
machine where bzr was invoked) or the server (the machine addressed by
407
the branch URL). These may be, but are not necessarily, the same machine.
409
Plugins (including hooks) are run on the server if all of these is true:
411
* The connection is via a smart server (accessed with a URL starting with
412
"bzr://", "bzr+ssh://" or "bzr+http://", or accessed via a "http://"
413
URL when a smart server is available via HTTP).
415
* The hook is either server specific or part of general infrastructure rather
416
than client specific code (such as commit).
420
def hooks_help_text(topic):
421
segments = [_help_prefix]
422
for hook_key in sorted(known_hooks.keys()):
423
hooks = known_hooks_key_to_object(hook_key)
424
segments.append(hooks.docs())
425
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
