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._module = module
131
self._member_name = member_name
133
def add_hook(self, name, doc, introduced, deprecated=None):
134
"""Add a hook point to this dictionary.
136
:param name: The name of the hook, for clients to use when registering.
137
:param doc: The docs for the hook.
138
:param introduced: When the hook was introduced (e.g. (0, 15)).
139
:param deprecated: When the hook was deprecated, None for
143
raise errors.DuplicateKey(name)
145
callbacks = _lazy_hooks.setdefault(
146
(self._module, self._member_name, name), [])
149
hookpoint = HookPoint(name=name, doc=doc, introduced=introduced,
150
deprecated=deprecated, callbacks=callbacks)
151
self[name] = hookpoint
153
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
154
def create_hook(self, hook):
155
"""Create a hook which can have callbacks registered for it.
157
:param hook: The hook to create. An object meeting the protocol of
158
bzrlib.hooks.HookPoint. It's name is used as the key for future
161
if hook.name in self:
162
raise errors.DuplicateKey(hook.name)
163
self[hook.name] = hook
166
"""Generate the documentation for this Hooks instance.
168
This introspects all the individual hooks and returns their docs as well.
170
hook_names = sorted(self.keys())
172
name = self.__class__.__name__
173
hook_docs.append(name)
174
hook_docs.append("-"*len(name))
176
for hook_name in hook_names:
177
hook = self[hook_name]
179
hook_docs.append(hook.docs())
180
except AttributeError:
183
strings.append(hook_name)
184
strings.append("~" * len(hook_name))
186
strings.append("An old-style hook. For documentation see the __init__ "
187
"method of '%s'\n" % (name,))
188
hook_docs.extend(strings)
189
return "\n".join(hook_docs)
191
def get_hook_name(self, a_callable):
192
"""Get the name for a_callable for UI display.
194
If no name has been registered, the string 'No hook name' is returned.
195
We use a fixed string rather than repr or the callables module because
196
the code names are rarely meaningful for end users and this is not
197
intended for debugging.
199
return self._callable_names.get(a_callable, "No hook name")
201
def install_named_hook_lazy(self, hook_name, callable_module,
202
callable_member, name):
203
"""Install a_callable in to the hook hook_name lazily, and label it.
205
:param hook_name: A hook name. See the __init__ method for the complete
207
:param callable_module: Name of the module in which the callable is
209
:param callable_member: Member name of the callable.
210
:param name: A name to associate the callable with, to show users what
214
hook = self[hook_name]
216
raise errors.UnknownHook(self.__class__.__name__, hook_name)
218
hook_lazy = getattr(hook, "hook_lazy")
219
except AttributeError:
220
raise errors.UnsupportedOperation(self.install_named_hook_lazy,
223
hook_lazy(callable_module, callable_member, name)
225
def install_named_hook(self, hook_name, a_callable, name):
226
"""Install a_callable in to the hook hook_name, and label it name.
228
:param hook_name: A hook name. See the __init__ method for the complete
230
:param a_callable: The callable to be invoked when the hook triggers.
231
The exact signature will depend on the hook - see the __init__
232
method for details on each hook.
233
:param name: A name to associate a_callable with, to show users what is
237
hook = self[hook_name]
239
raise errors.UnknownHook(self.__class__.__name__, hook_name)
241
# list hooks, old-style, not yet deprecated but less useful.
242
hook.append(a_callable)
243
except AttributeError:
244
hook.hook(a_callable, name)
246
self.name_hook(a_callable, name)
248
def uninstall_named_hook(self, hook_name, label):
249
"""Uninstall named hooks.
251
:param hook_name: Hook point name
252
:param label: Label of the callable to uninstall
255
hook = self[hook_name]
257
raise errors.UnknownHook(self.__class__.__name__, hook_name)
259
uninstall = getattr(hook, "uninstall")
260
except AttributeError:
261
raise errors.UnsupportedOperation(self.uninstall_named_hook, self)
265
def name_hook(self, a_callable, name):
266
"""Associate name with a_callable to show users what is running."""
267
self._callable_names[a_callable] = name
270
class HookPoint(object):
271
"""A single hook that clients can register to be called back when it fires.
273
:ivar name: The name of the hook.
274
:ivar doc: The docs for using the hook.
275
:ivar introduced: A version tuple specifying what version the hook was
276
introduced in. None indicates an unknown version.
277
:ivar deprecated: A version tuple specifying what version the hook was
278
deprecated or superseded in. None indicates that the hook is not
279
superseded or deprecated. If the hook is superseded then the doc
280
should describe the recommended replacement hook to register for.
283
def __init__(self, name, doc, introduced, deprecated=None, callbacks=None):
284
"""Create a HookPoint.
286
:param name: The name of the hook, for clients to use when registering.
287
:param doc: The docs for the hook.
288
:param introduced: When the hook was introduced (e.g. (0, 15)).
289
:param deprecated: When the hook was deprecated, None for
294
self.introduced = introduced
295
self.deprecated = deprecated
296
if callbacks is None:
299
self._callbacks = callbacks
302
"""Generate the documentation for this HookPoint.
304
:return: A string terminated in \n.
307
strings.append(self.name)
308
strings.append('~'*len(self.name))
311
introduced_string = _format_version_tuple(self.introduced)
313
introduced_string = 'unknown'
314
strings.append(gettext('Introduced in: %s') % introduced_string)
316
deprecated_string = _format_version_tuple(self.deprecated)
317
strings.append(gettext('Deprecated in: %s') % deprecated_string)
319
strings.extend(textwrap.wrap(self.__doc__,
320
break_long_words=False))
322
return '\n'.join(strings)
324
def __eq__(self, other):
325
return (type(other) == type(self) and other.__dict__ == self.__dict__)
327
def hook_lazy(self, callback_module, callback_member, callback_label):
328
"""Lazily register a callback to be called when this HookPoint fires.
330
:param callback_module: Module of the callable to use when this
332
:param callback_member: Member name of the callback.
333
:param callback_label: A label to show in the UI while this callback is
336
obj_getter = registry._LazyObjectGetter(callback_module,
338
self._callbacks.append((obj_getter, callback_label))
340
def hook(self, callback, callback_label):
341
"""Register a callback to be called when this HookPoint fires.
343
:param callback: The callable to use when this HookPoint fires.
344
:param callback_label: A label to show in the UI while this callback is
347
obj_getter = registry._ObjectGetter(callback)
348
self._callbacks.append((obj_getter, callback_label))
350
def uninstall(self, label):
351
"""Uninstall the callback with the specified label.
353
:param label: Label of the entry to uninstall
355
entries_to_remove = []
356
for entry in self._callbacks:
357
(entry_callback, entry_label) = entry
358
if entry_label == label:
359
entries_to_remove.append(entry)
360
if entries_to_remove == []:
361
raise KeyError("No entry with label %r" % label)
362
for entry in entries_to_remove:
363
self._callbacks.remove(entry)
366
return (callback.get_obj() for callback, name in self._callbacks)
369
return len(self._callbacks)
373
strings.append("<%s(" % type(self).__name__)
374
strings.append(self.name)
375
strings.append("), callbacks=[")
376
callbacks = self._callbacks
377
for (callback, callback_name) in callbacks:
378
strings.append(repr(callback.get_obj()))
380
strings.append(callback_name)
382
if len(callbacks) == 1:
385
return ''.join(strings)
396
A hook of type *xxx* of class *yyy* needs to be registered using::
398
yyy.hooks.install_named_hook("xxx", ...)
400
See :doc:`Using hooks<../user-guide/hooks>` in the User Guide for examples.
402
The class that contains each hook is given before the hooks it supplies. For
403
instance, BranchHooks as the class is the hooks class for
404
`bzrlib.branch.Branch.hooks`.
406
Each description also indicates whether the hook runs on the client (the
407
machine where bzr was invoked) or the server (the machine addressed by
408
the branch URL). These may be, but are not necessarily, the same machine.
410
Plugins (including hooks) are run on the server if all of these is true:
412
* The connection is via a smart server (accessed with a URL starting with
413
"bzr://", "bzr+ssh://" or "bzr+http://", or accessed via a "http://"
414
URL when a smart server is available via HTTP).
416
* The hook is either server specific or part of general infrastructure rather
417
than client specific code (such as commit).
421
def hooks_help_text(topic):
422
segments = [_help_prefix]
423
for hook_key in sorted(known_hooks.keys()):
424
hooks = known_hooks_key_to_object(hook_key)
425
segments.append(hooks.docs())
426
return '\n'.join(segments)
429
# Lazily registered hooks. Maps (module, name, hook_name) tuples
430
# to lists of tuples with objectgetters and names
434
def install_lazy_named_hook(hookpoints_module, hookpoints_name, hook_name,
436
"""Install a callable in to a hook lazily, and label it name.
438
:param hookpoints_module: Module name of the hook points.
439
:param hookpoints_name: Name of the hook points.
440
:param hook_name: A hook name.
441
:param callable: a callable to call for the hook.
442
:param name: A name to associate a_callable with, to show users what is
445
key = (hookpoints_module, hookpoints_name, hook_name)
446
obj_getter = registry._ObjectGetter(a_callable)
447
_lazy_hooks.setdefault(key, []).append((obj_getter, name))
added
removed
bzrlib/hooks.py
