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,
33
from bzrlib.i18n import gettext
37
class KnownHooksRegistry(registry.Registry):
38
# known_hooks registry contains
39
# tuple of (module, member name) which is the hook point
40
# module where the specific hooks are defined
41
# callable to get the empty specific Hooks for that attribute
43
def register_lazy_hook(self, hook_module_name, hook_member_name,
44
hook_factory_member_name):
45
self.register_lazy((hook_module_name, hook_member_name),
46
hook_module_name, hook_factory_member_name)
48
def iter_parent_objects(self):
49
"""Yield (hook_key, (parent_object, attr)) tuples for every registered
50
hook, where 'parent_object' is the object that holds the hook
53
This is useful for resetting/restoring all the hooks to a known state,
54
as is done in bzrlib.tests.TestCase._clear_hooks.
56
for key in self.keys():
57
yield key, self.key_to_parent_and_attribute(key)
59
def key_to_parent_and_attribute(self, (module_name, member_name)):
60
"""Convert a known_hooks key to a (parent_obj, attr) pair.
62
:param key: A tuple (module_name, member_name) as found in the keys of
63
the known_hooks registry.
64
:return: The parent_object of the hook and the name of the attribute on
65
that parent object where the hook is kept.
67
parent_mod, parent_member, attr = pyutils.calc_parent_name(module_name,
69
return pyutils.get_named_object(parent_mod, parent_member), attr
72
_builtin_known_hooks = (
73
('bzrlib.branch', 'Branch.hooks', 'BranchHooks'),
74
('bzrlib.controldir', 'ControlDir.hooks', 'ControlDirHooks'),
75
('bzrlib.commands', 'Command.hooks', 'CommandHooks'),
76
('bzrlib.config', 'ConfigHooks', '_ConfigHooks'),
77
('bzrlib.info', 'hooks', 'InfoHooks'),
78
('bzrlib.lock', 'Lock.hooks', 'LockHooks'),
79
('bzrlib.merge', 'Merger.hooks', 'MergeHooks'),
80
('bzrlib.msgeditor', 'hooks', 'MessageEditorHooks'),
81
('bzrlib.mutabletree', 'MutableTree.hooks', 'MutableTreeHooks'),
82
('bzrlib.smart.client', '_SmartClient.hooks', 'SmartClientHooks'),
83
('bzrlib.smart.server', 'SmartTCPServer.hooks', 'SmartServerHooks'),
84
('bzrlib.status', 'hooks', 'StatusHooks'),
85
('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks',
86
'RioVersionInfoBuilderHooks'),
87
('bzrlib.merge_directive', 'BaseMergeDirective.hooks',
88
'MergeDirectiveHooks'),
91
known_hooks = KnownHooksRegistry()
92
for (_hook_module, _hook_attribute, _hook_class) in _builtin_known_hooks:
93
known_hooks.register_lazy_hook(_hook_module, _hook_attribute, _hook_class)
94
del _builtin_known_hooks, _hook_module, _hook_attribute, _hook_class
97
def known_hooks_key_to_object((module_name, member_name)):
98
"""Convert a known_hooks key to a object.
100
:param key: A tuple (module_name, member_name) as found in the keys of
101
the known_hooks registry.
102
:return: The object this specifies.
104
return pyutils.get_named_object(module_name, member_name)
107
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3)))
108
def known_hooks_key_to_parent_and_attribute(key):
109
"""See KnownHooksRegistry.key_to_parent_and_attribute."""
110
return known_hooks.key_to_parent_and_attribute(key)
114
"""A dictionary mapping hook name to a list of callables.
116
e.g. ['FOO'] Is the list of items to be called when the
117
FOO hook is triggered.
120
def __init__(self, module=None, member_name=None):
121
"""Create a new hooks dictionary.
123
:param module: The module from which this hooks dictionary should be loaded
124
(used for lazy hooks)
125
:param member_name: Name under which this hooks dictionary should be loaded.
126
(used for lazy hooks)
129
self._callable_names = {}
130
self._lazy_callable_names = {}
131
self._module = module
132
self._member_name = member_name
134
def add_hook(self, name, doc, introduced, deprecated=None):
135
"""Add a hook point to this dictionary.
137
:param name: The name of the hook, for clients to use when registering.
138
:param doc: The docs for the hook.
139
:param introduced: When the hook was introduced (e.g. (0, 15)).
140
:param deprecated: When the hook was deprecated, None for
144
raise errors.DuplicateKey(name)
146
callbacks = _lazy_hooks.setdefault(
147
(self._module, self._member_name, name), [])
150
hookpoint = HookPoint(name=name, doc=doc, introduced=introduced,
151
deprecated=deprecated, callbacks=callbacks)
152
self[name] = hookpoint
154
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
155
def create_hook(self, hook):
156
"""Create a hook which can have callbacks registered for it.
158
:param hook: The hook to create. An object meeting the protocol of
159
bzrlib.hooks.HookPoint. It's name is used as the key for future
162
if hook.name in self:
163
raise errors.DuplicateKey(hook.name)
164
self[hook.name] = hook
167
"""Generate the documentation for this Hooks instance.
169
This introspects all the individual hooks and returns their docs as well.
171
hook_names = sorted(self.keys())
173
name = self.__class__.__name__
174
hook_docs.append(name)
175
hook_docs.append("-"*len(name))
177
for hook_name in hook_names:
178
hook = self[hook_name]
180
hook_docs.append(hook.docs())
181
except AttributeError:
184
strings.append(hook_name)
185
strings.append("~" * len(hook_name))
187
strings.append("An old-style hook. For documentation see the __init__ "
188
"method of '%s'\n" % (name,))
189
hook_docs.extend(strings)
190
return "\n".join(hook_docs)
192
def get_hook_name(self, a_callable):
193
"""Get the name for a_callable for UI display.
195
If no name has been registered, the string 'No hook name' is returned.
196
We use a fixed string rather than repr or the callables module because
197
the code names are rarely meaningful for end users and this is not
198
intended for debugging.
200
name = self._callable_names.get(a_callable, None)
201
if name is None and a_callable is not None:
202
name = self._lazy_callable_names.get((a_callable.__module__,
203
a_callable.__name__),
206
return 'No hook name'
210
def install_named_hook_lazy(self, hook_name, callable_module,
211
callable_member, name):
212
"""Install a_callable in to the hook hook_name lazily, and label it.
214
:param hook_name: A hook name. See the __init__ method for the complete
216
:param callable_module: Name of the module in which the callable is
218
:param callable_member: Member name of the callable.
219
:param name: A name to associate the callable with, to show users what
223
hook = self[hook_name]
225
raise errors.UnknownHook(self.__class__.__name__, hook_name)
227
hook_lazy = getattr(hook, "hook_lazy")
228
except AttributeError:
229
raise errors.UnsupportedOperation(self.install_named_hook_lazy,
232
hook_lazy(callable_module, callable_member, name)
234
self.name_hook_lazy(callable_module, callable_member, name)
236
def install_named_hook(self, hook_name, a_callable, name):
237
"""Install a_callable in to the hook hook_name, and label it name.
239
:param hook_name: A hook name. See the __init__ method for the complete
241
:param a_callable: The callable to be invoked when the hook triggers.
242
The exact signature will depend on the hook - see the __init__
243
method for details on each hook.
244
:param name: A name to associate a_callable with, to show users what is
248
hook = self[hook_name]
250
raise errors.UnknownHook(self.__class__.__name__, hook_name)
252
# list hooks, old-style, not yet deprecated but less useful.
253
hook.append(a_callable)
254
except AttributeError:
255
hook.hook(a_callable, name)
257
self.name_hook(a_callable, name)
259
def uninstall_named_hook(self, hook_name, label):
260
"""Uninstall named hooks.
262
:param hook_name: Hook point name
263
:param label: Label of the callable to uninstall
266
hook = self[hook_name]
268
raise errors.UnknownHook(self.__class__.__name__, hook_name)
270
uninstall = getattr(hook, "uninstall")
271
except AttributeError:
272
raise errors.UnsupportedOperation(self.uninstall_named_hook, self)
276
def name_hook(self, a_callable, name):
277
"""Associate name with a_callable to show users what is running."""
278
self._callable_names[a_callable] = name
280
def name_hook_lazy(self, callable_module, callable_member, callable_name):
281
self._lazy_callable_names[(callable_module, callable_member)]= \
285
class HookPoint(object):
286
"""A single hook that clients can register to be called back when it fires.
288
:ivar name: The name of the hook.
289
:ivar doc: The docs for using the hook.
290
:ivar introduced: A version tuple specifying what version the hook was
291
introduced in. None indicates an unknown version.
292
:ivar deprecated: A version tuple specifying what version the hook was
293
deprecated or superseded in. None indicates that the hook is not
294
superseded or deprecated. If the hook is superseded then the doc
295
should describe the recommended replacement hook to register for.
298
def __init__(self, name, doc, introduced, deprecated=None, callbacks=None):
299
"""Create a HookPoint.
301
:param name: The name of the hook, for clients to use when registering.
302
:param doc: The docs for the hook.
303
:param introduced: When the hook was introduced (e.g. (0, 15)).
304
:param deprecated: When the hook was deprecated, None for
309
self.introduced = introduced
310
self.deprecated = deprecated
311
if callbacks is None:
314
self._callbacks = callbacks
317
"""Generate the documentation for this HookPoint.
319
:return: A string terminated in \n.
322
strings.append(self.name)
323
strings.append('~'*len(self.name))
326
introduced_string = _format_version_tuple(self.introduced)
328
introduced_string = 'unknown'
329
strings.append(gettext('Introduced in: %s') % introduced_string)
331
deprecated_string = _format_version_tuple(self.deprecated)
332
strings.append(gettext('Deprecated in: %s') % deprecated_string)
334
strings.extend(textwrap.wrap(self.__doc__,
335
break_long_words=False))
337
return '\n'.join(strings)
339
def __eq__(self, other):
340
return (type(other) == type(self) and other.__dict__ == self.__dict__)
342
def hook_lazy(self, callback_module, callback_member, callback_label):
343
"""Lazily register a callback to be called when this HookPoint fires.
345
:param callback_module: Module of the callable to use when this
347
:param callback_member: Member name of the callback.
348
:param callback_label: A label to show in the UI while this callback is
351
obj_getter = registry._LazyObjectGetter(callback_module,
353
self._callbacks.append((obj_getter, callback_label))
355
def hook(self, callback, callback_label):
356
"""Register a callback to be called when this HookPoint fires.
358
:param callback: The callable to use when this HookPoint fires.
359
:param callback_label: A label to show in the UI while this callback is
362
obj_getter = registry._ObjectGetter(callback)
363
self._callbacks.append((obj_getter, callback_label))
365
def uninstall(self, label):
366
"""Uninstall the callback with the specified label.
368
:param label: Label of the entry to uninstall
370
entries_to_remove = []
371
for entry in self._callbacks:
372
(entry_callback, entry_label) = entry
373
if entry_label == label:
374
entries_to_remove.append(entry)
375
if entries_to_remove == []:
376
raise KeyError("No entry with label %r" % label)
377
for entry in entries_to_remove:
378
self._callbacks.remove(entry)
381
return (callback.get_obj() for callback, name in self._callbacks)
384
return len(self._callbacks)
388
strings.append("<%s(" % type(self).__name__)
389
strings.append(self.name)
390
strings.append("), callbacks=[")
391
callbacks = self._callbacks
392
for (callback, callback_name) in callbacks:
393
strings.append(repr(callback.get_obj()))
395
strings.append(callback_name)
397
if len(callbacks) == 1:
400
return ''.join(strings)
411
A hook of type *xxx* of class *yyy* needs to be registered using::
413
yyy.hooks.install_named_hook("xxx", ...)
415
See :doc:`Using hooks<../user-guide/hooks>` in the User Guide for examples.
417
The class that contains each hook is given before the hooks it supplies. For
418
instance, BranchHooks as the class is the hooks class for
419
`bzrlib.branch.Branch.hooks`.
421
Each description also indicates whether the hook runs on the client (the
422
machine where bzr was invoked) or the server (the machine addressed by
423
the branch URL). These may be, but are not necessarily, the same machine.
425
Plugins (including hooks) are run on the server if all of these is true:
427
* The connection is via a smart server (accessed with a URL starting with
428
"bzr://", "bzr+ssh://" or "bzr+http://", or accessed via a "http://"
429
URL when a smart server is available via HTTP).
431
* The hook is either server specific or part of general infrastructure rather
432
than client specific code (such as commit).
436
def hooks_help_text(topic):
437
segments = [_help_prefix]
438
for hook_key in sorted(known_hooks.keys()):
439
hooks = known_hooks_key_to_object(hook_key)
440
segments.append(hooks.docs())
441
return '\n'.join(segments)
444
# Lazily registered hooks. Maps (module, name, hook_name) tuples
445
# to lists of tuples with objectgetters and names
449
def install_lazy_named_hook(hookpoints_module, hookpoints_name, hook_name,
451
"""Install a callable in to a hook lazily, and label it name.
453
:param hookpoints_module: Module name of the hook points.
454
:param hookpoints_name: Name of the hook points.
455
:param hook_name: A hook name.
456
:param callable: a callable to call for the hook.
457
:param name: A name to associate a_callable with, to show users what is
460
key = (hookpoints_module, hookpoints_name, hook_name)
461
obj_getter = registry._ObjectGetter(a_callable)
462
_lazy_hooks.setdefault(key, []).append((obj_getter, name))
added
removed
bzrlib/hooks.py
