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
17
"""Support for plugin hooking logic."""
19
from __future__ import absolute_import
25
from .lazy_import import lazy_import
26
lazy_import(globals(), """
30
_format_version_tuple,
33
from breezy.i18n import gettext
37
class UnknownHook(errors.BzrError):
39
_fmt = "The %(type)s hook '%(hook)s' is unknown in this version of breezy."
41
def __init__(self, hook_type, hook_name):
42
errors.BzrError.__init__(self)
47
class KnownHooksRegistry(registry.Registry):
48
# known_hooks registry contains
49
# tuple of (module, member name) which is the hook point
50
# module where the specific hooks are defined
51
# callable to get the empty specific Hooks for that attribute
53
def register_lazy_hook(self, hook_module_name, hook_member_name,
54
hook_factory_member_name):
55
self.register_lazy((hook_module_name, hook_member_name),
56
hook_module_name, hook_factory_member_name)
58
def iter_parent_objects(self):
59
"""Yield (hook_key, (parent_object, attr)) tuples for every registered
60
hook, where 'parent_object' is the object that holds the hook
63
This is useful for resetting/restoring all the hooks to a known state,
64
as is done in breezy.tests.TestCase._clear_hooks.
66
for key in self.keys():
67
yield key, self.key_to_parent_and_attribute(key)
69
def key_to_parent_and_attribute(self, key):
70
"""Convert a known_hooks key to a (parent_obj, attr) pair.
72
:param key: A tuple (module_name, member_name) as found in the keys of
73
the known_hooks registry.
74
:return: The parent_object of the hook and the name of the attribute on
75
that parent object where the hook is kept.
77
parent_mod, parent_member, attr = pyutils.calc_parent_name(*key)
78
return pyutils.get_named_object(parent_mod, parent_member), attr
81
_builtin_known_hooks = (
82
('breezy.branch', 'Branch.hooks', 'BranchHooks'),
83
('breezy.controldir', 'ControlDir.hooks', 'ControlDirHooks'),
84
('breezy.commands', 'Command.hooks', 'CommandHooks'),
85
('breezy.config', 'ConfigHooks', '_ConfigHooks'),
86
('breezy.info', 'hooks', 'InfoHooks'),
87
('breezy.lock', 'Lock.hooks', 'LockHooks'),
88
('breezy.merge', 'Merger.hooks', 'MergeHooks'),
89
('breezy.msgeditor', 'hooks', 'MessageEditorHooks'),
90
('breezy.mutabletree', 'MutableTree.hooks', 'MutableTreeHooks'),
91
('breezy.bzr.smart.client', '_SmartClient.hooks', 'SmartClientHooks'),
92
('breezy.bzr.smart.server', 'SmartTCPServer.hooks', 'SmartServerHooks'),
93
('breezy.status', 'hooks', 'StatusHooks'),
94
('breezy.transport', 'Transport.hooks', 'TransportHooks'),
95
('breezy.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks',
96
'RioVersionInfoBuilderHooks'),
97
('breezy.merge_directive', 'BaseMergeDirective.hooks',
98
'MergeDirectiveHooks'),
101
known_hooks = KnownHooksRegistry()
102
for (_hook_module, _hook_attribute, _hook_class) in _builtin_known_hooks:
103
known_hooks.register_lazy_hook(_hook_module, _hook_attribute, _hook_class)
104
del _builtin_known_hooks, _hook_module, _hook_attribute, _hook_class
107
def known_hooks_key_to_object(key):
108
"""Convert a known_hooks key to a object.
110
:param key: A tuple (module_name, member_name) as found in the keys of
111
the known_hooks registry.
112
:return: The object this specifies.
114
return pyutils.get_named_object(*key)
118
"""A dictionary mapping hook name to a list of callables.
120
e.g. ['FOO'] Is the list of items to be called when the
121
FOO hook is triggered.
124
def __init__(self, module=None, member_name=None):
125
"""Create a new hooks dictionary.
127
:param module: The module from which this hooks dictionary should be loaded
128
(used for lazy hooks)
129
:param member_name: Name under which this hooks dictionary should be loaded.
130
(used for lazy hooks)
133
self._callable_names = {}
134
self._lazy_callable_names = {}
135
self._module = module
136
self._member_name = member_name
138
def add_hook(self, name, doc, introduced, deprecated=None):
139
"""Add a hook point to this dictionary.
141
:param name: The name of the hook, for clients to use when registering.
142
:param doc: The docs for the hook.
143
:param introduced: When the hook was introduced (e.g. (0, 15)).
144
:param deprecated: When the hook was deprecated, None for
148
raise errors.DuplicateKey(name)
150
callbacks = _lazy_hooks.setdefault(
151
(self._module, self._member_name, name), [])
154
hookpoint = HookPoint(name=name, doc=doc, introduced=introduced,
155
deprecated=deprecated, callbacks=callbacks)
156
self[name] = hookpoint
159
"""Generate the documentation for this Hooks instance.
161
This introspects all the individual hooks and returns their docs as well.
163
hook_names = sorted(self.keys())
165
name = self.__class__.__name__
166
hook_docs.append(name)
167
hook_docs.append("-"*len(name))
169
for hook_name in hook_names:
170
hook = self[hook_name]
172
hook_docs.append(hook.docs())
173
except AttributeError:
176
strings.append(hook_name)
177
strings.append("~" * len(hook_name))
179
strings.append("An old-style hook. For documentation see the __init__ "
180
"method of '%s'\n" % (name,))
181
hook_docs.extend(strings)
182
return "\n".join(hook_docs)
184
def get_hook_name(self, a_callable):
185
"""Get the name for a_callable for UI display.
187
If no name has been registered, the string 'No hook name' is returned.
188
We use a fixed string rather than repr or the callables module because
189
the code names are rarely meaningful for end users and this is not
190
intended for debugging.
192
name = self._callable_names.get(a_callable, None)
193
if name is None and a_callable is not None:
194
name = self._lazy_callable_names.get((a_callable.__module__,
195
a_callable.__name__),
198
return 'No hook name'
202
def install_named_hook_lazy(self, hook_name, callable_module,
203
callable_member, name):
204
"""Install a_callable in to the hook hook_name lazily, and label it.
206
:param hook_name: A hook name. See the __init__ method for the complete
208
:param callable_module: Name of the module in which the callable is
210
:param callable_member: Member name of the callable.
211
:param name: A name to associate the callable with, to show users what
215
hook = self[hook_name]
217
raise UnknownHook(self.__class__.__name__, hook_name)
219
hook_lazy = getattr(hook, "hook_lazy")
220
except AttributeError:
221
raise errors.UnsupportedOperation(self.install_named_hook_lazy,
224
hook_lazy(callable_module, callable_member, name)
226
self.name_hook_lazy(callable_module, callable_member, name)
228
def install_named_hook(self, hook_name, a_callable, name):
229
"""Install a_callable in to the hook hook_name, and label it name.
231
:param hook_name: A hook name. See the __init__ method for the complete
233
:param a_callable: The callable to be invoked when the hook triggers.
234
The exact signature will depend on the hook - see the __init__
235
method for details on each hook.
236
:param name: A name to associate a_callable with, to show users what is
240
hook = self[hook_name]
242
raise UnknownHook(self.__class__.__name__, hook_name)
244
# list hooks, old-style, not yet deprecated but less useful.
245
hook.append(a_callable)
246
except AttributeError:
247
hook.hook(a_callable, name)
249
self.name_hook(a_callable, name)
251
def uninstall_named_hook(self, hook_name, label):
252
"""Uninstall named hooks.
254
:param hook_name: Hook point name
255
:param label: Label of the callable to uninstall
258
hook = self[hook_name]
260
raise UnknownHook(self.__class__.__name__, hook_name)
262
uninstall = getattr(hook, "uninstall")
263
except AttributeError:
264
raise errors.UnsupportedOperation(self.uninstall_named_hook, self)
268
def name_hook(self, a_callable, name):
269
"""Associate name with a_callable to show users what is running."""
270
self._callable_names[a_callable] = name
272
def name_hook_lazy(self, callable_module, callable_member, callable_name):
273
self._lazy_callable_names[(callable_module, callable_member)]= \
277
class HookPoint(object):
278
"""A single hook that clients can register to be called back when it fires.
280
:ivar name: The name of the hook.
281
:ivar doc: The docs for using the hook.
282
:ivar introduced: A version tuple specifying what version the hook was
283
introduced in. None indicates an unknown version.
284
:ivar deprecated: A version tuple specifying what version the hook was
285
deprecated or superseded in. None indicates that the hook is not
286
superseded or deprecated. If the hook is superseded then the doc
287
should describe the recommended replacement hook to register for.
290
def __init__(self, name, doc, introduced, deprecated=None, callbacks=None):
291
"""Create a HookPoint.
293
:param name: The name of the hook, for clients to use when registering.
294
:param doc: The docs for the hook.
295
:param introduced: When the hook was introduced (e.g. (0, 15)).
296
:param deprecated: When the hook was deprecated, None for
301
self.introduced = introduced
302
self.deprecated = deprecated
303
if callbacks is None:
306
self._callbacks = callbacks
309
"""Generate the documentation for this HookPoint.
311
:return: A string terminated in \n.
314
strings.append(self.name)
315
strings.append('~'*len(self.name))
318
introduced_string = _format_version_tuple(self.introduced)
320
introduced_string = 'unknown'
321
strings.append(gettext('Introduced in: %s') % introduced_string)
323
deprecated_string = _format_version_tuple(self.deprecated)
324
strings.append(gettext('Deprecated in: %s') % deprecated_string)
326
strings.extend(textwrap.wrap(self.__doc__,
327
break_long_words=False))
329
return '\n'.join(strings)
331
def __eq__(self, other):
332
return (isinstance(other, type(self)) and other.__dict__ == self.__dict__)
334
def hook_lazy(self, callback_module, callback_member, callback_label):
335
"""Lazily register a callback to be called when this HookPoint fires.
337
:param callback_module: Module of the callable to use when this
339
:param callback_member: Member name of the callback.
340
:param callback_label: A label to show in the UI while this callback is
343
obj_getter = registry._LazyObjectGetter(callback_module,
345
self._callbacks.append((obj_getter, callback_label))
347
def hook(self, callback, callback_label):
348
"""Register a callback to be called when this HookPoint fires.
350
:param callback: The callable to use when this HookPoint fires.
351
:param callback_label: A label to show in the UI while this callback is
354
obj_getter = registry._ObjectGetter(callback)
355
self._callbacks.append((obj_getter, callback_label))
357
def uninstall(self, label):
358
"""Uninstall the callback with the specified label.
360
:param label: Label of the entry to uninstall
362
entries_to_remove = []
363
for entry in self._callbacks:
364
(entry_callback, entry_label) = entry
365
if entry_label == label:
366
entries_to_remove.append(entry)
367
if entries_to_remove == []:
368
raise KeyError("No entry with label %r" % label)
369
for entry in entries_to_remove:
370
self._callbacks.remove(entry)
373
return (callback.get_obj() for callback, name in self._callbacks)
376
return len(self._callbacks)
380
strings.append("<%s(" % type(self).__name__)
381
strings.append(self.name)
382
strings.append("), callbacks=[")
383
callbacks = self._callbacks
384
for (callback, callback_name) in callbacks:
385
strings.append(repr(callback.get_obj()))
387
strings.append(callback_name)
389
if len(callbacks) == 1:
392
return ''.join(strings)
403
A hook of type *xxx* of class *yyy* needs to be registered using::
405
yyy.hooks.install_named_hook("xxx", ...)
407
See :doc:`Using hooks<../user-guide/hooks>` in the User Guide for examples.
409
The class that contains each hook is given before the hooks it supplies. For
410
instance, BranchHooks as the class is the hooks class for
411
`breezy.branch.Branch.hooks`.
413
Each description also indicates whether the hook runs on the client (the
414
machine where bzr was invoked) or the server (the machine addressed by
415
the branch URL). These may be, but are not necessarily, the same machine.
417
Plugins (including hooks) are run on the server if all of these is true:
419
* The connection is via a smart server (accessed with a URL starting with
420
"bzr://", "bzr+ssh://" or "bzr+http://", or accessed via a "http://"
421
URL when a smart server is available via HTTP).
423
* The hook is either server specific or part of general infrastructure rather
424
than client specific code (such as commit).
428
def hooks_help_text(topic):
429
segments = [_help_prefix]
430
for hook_key in sorted(known_hooks.keys()):
431
hooks = known_hooks_key_to_object(hook_key)
432
segments.append(hooks.docs())
433
return '\n'.join(segments)
436
# Lazily registered hooks. Maps (module, name, hook_name) tuples
437
# to lists of tuples with objectgetters and names
441
def install_lazy_named_hook(hookpoints_module, hookpoints_name, hook_name,
443
"""Install a callable in to a hook lazily, and label it name.
445
:param hookpoints_module: Module name of the hook points.
446
:param hookpoints_name: Name of the hook points.
447
:param hook_name: A hook name.
448
:param callable: a callable to call for the hook.
449
:param name: A name to associate a_callable with, to show users what is
452
key = (hookpoints_module, hookpoints_name, hook_name)
453
obj_getter = registry._ObjectGetter(a_callable)
454
_lazy_hooks.setdefault(key, []).append((obj_getter, name))
added
removed
breezy/hooks.py
