1
# Copyright (C) 2007, 2008 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Support for plugin hooking logic."""
19
from bzrlib.lazy_import import lazy_import
20
from bzrlib import registry
21
from bzrlib.symbol_versioning import deprecated_method, one_five
22
lazy_import(globals(), """
26
_format_version_tuple,
32
known_hooks = registry.Registry()
33
known_hooks.register_lazy(('bzrlib.branch', 'Branch.hooks'), 'bzrlib.branch',
35
known_hooks.register_lazy(('bzrlib.commands', 'Command.hooks'),
36
'bzrlib.commands', 'CommandHooks')
37
known_hooks.register_lazy(('bzrlib.mutabletree', 'MutableTree.hooks'),
38
'bzrlib.mutabletree', 'MutableTreeHooks')
39
known_hooks.register_lazy(('bzrlib.smart.client', '_SmartClient.hooks'),
40
'bzrlib.smart.client', 'SmartClientHooks')
41
known_hooks.register_lazy(('bzrlib.smart.server', 'SmartTCPServer.hooks'),
42
'bzrlib.smart.server', 'SmartServerHooks')
45
def known_hooks_key_to_object((module_name, member_name)):
46
"""Convert a known_hooks key to a object.
48
:param key: A tuple (module_name, member_name) as found in the keys of
49
the known_hooks registry.
50
:return: The object this specifies.
52
return registry._LazyObjectGetter(module_name, member_name).get_obj()
55
def known_hooks_key_to_parent_and_attribute((module_name, member_name)):
56
"""Convert a known_hooks key to a object.
58
:param key: A tuple (module_name, member_name) as found in the keys of
59
the known_hooks registry.
60
:return: The object this specifies.
62
member_list = member_name.rsplit('.', 1)
63
if len(member_list) == 2:
64
parent_name, attribute = member_list
67
attribute = member_name
68
parent = known_hooks_key_to_object((module_name, parent_name))
69
return parent, attribute
73
"""A dictionary mapping hook name to a list of callables.
75
e.g. ['FOO'] Is the list of items to be called when the
76
FOO hook is triggered.
81
self._callable_names = {}
83
def create_hook(self, hook):
84
"""Create a hook which can have callbacks registered for it.
86
:param hook: The hook to create. An object meeting the protocol of
87
bzrlib.hooks.HookPoint. It's name is used as the key for future
91
raise errors.DuplicateKey(hook.name)
92
self[hook.name] = hook
95
"""Generate the documentation for this Hooks instance.
97
This introspects all the individual hooks and returns their docs as well.
99
hook_names = sorted(self.keys())
101
name = self.__class__.__name__
102
hook_docs.append(name)
103
hook_docs.append("="*len(name))
105
for hook_name in hook_names:
106
hook = self[hook_name]
108
hook_docs.append(hook.docs())
109
except AttributeError:
112
strings.append(hook_name)
113
strings.append("-" * len(hook_name))
115
strings.append("An old-style hook. For documentation see the __init__ "
116
"method of '%s'\n" % (name,))
117
hook_docs.extend(strings)
118
return "\n".join(hook_docs)
120
def get_hook_name(self, a_callable):
121
"""Get the name for a_callable for UI display.
123
If no name has been registered, the string 'No hook name' is returned.
124
We use a fixed string rather than repr or the callables module because
125
the code names are rarely meaningful for end users and this is not
126
intended for debugging.
128
return self._callable_names.get(a_callable, "No hook name")
130
@deprecated_method(one_five)
131
def install_hook(self, hook_name, a_callable):
132
"""Install a_callable in to the hook hook_name.
134
:param hook_name: A hook name. See the __init__ method of BranchHooks
135
for the complete list of hooks.
136
:param a_callable: The callable to be invoked when the hook triggers.
137
The exact signature will depend on the hook - see the __init__
138
method of BranchHooks for details on each hook.
140
self.install_named_hook(hook_name, a_callable, None)
142
def install_named_hook(self, hook_name, a_callable, name):
143
"""Install a_callable in to the hook hook_name, and label it name.
145
:param hook_name: A hook name. See the __init__ method of BranchHooks
146
for the complete list of hooks.
147
:param a_callable: The callable to be invoked when the hook triggers.
148
The exact signature will depend on the hook - see the __init__
149
method of BranchHooks for details on each hook.
150
:param name: A name to associate a_callable with, to show users what is
154
hook = self[hook_name]
156
raise errors.UnknownHook(self.__class__.__name__, hook_name)
158
# list hooks, old-style, not yet deprecated but less useful.
159
hook.append(a_callable)
160
except AttributeError:
161
hook.hook(a_callable, name)
163
self.name_hook(a_callable, name)
165
def name_hook(self, a_callable, name):
166
"""Associate name with a_callable to show users what is running."""
167
self._callable_names[a_callable] = name
170
class HookPoint(object):
171
"""A single hook that clients can register to be called back when it fires.
173
:ivar name: The name of the hook.
174
:ivar introduced: A version tuple specifying what version the hook was
175
introduced in. None indicates an unknown version.
176
:ivar deprecated: A version tuple specifying what version the hook was
177
deprecated or superceded in. None indicates that the hook is not
178
superceded or deprecated. If the hook is superceded then the doc
179
should describe the recommended replacement hook to register for.
180
:ivar doc: The docs for using the hook.
183
def __init__(self, name, doc, introduced, deprecated):
184
"""Create a HookPoint.
186
:param name: The name of the hook, for clients to use when registering.
187
:param doc: The docs for the hook.
188
:param introduced: When the hook was introduced (e.g. (0, 15)).
189
:param deprecated: When the hook was deprecated, None for
194
self.introduced = introduced
195
self.deprecated = deprecated
197
self._callback_names = {}
200
"""Generate the documentation for this HookPoint.
202
:return: A string terminated in \n.
205
strings.append(self.name)
206
strings.append('-'*len(self.name))
209
introduced_string = _format_version_tuple(self.introduced)
211
introduced_string = 'unknown'
212
strings.append('Introduced in: %s' % introduced_string)
214
deprecated_string = _format_version_tuple(self.deprecated)
216
deprecated_string = 'Not deprecated'
217
strings.append('Deprecated in: %s' % deprecated_string)
219
strings.extend(textwrap.wrap(self.__doc__))
221
return '\n'.join(strings)
223
def hook(self, callback, callback_label):
224
"""Register a callback to be called when this HookPoint fires.
226
:param callback: The callable to use when this HookPoint fires.
227
:param callback_label: A label to show in the UI while this callback is
230
self._callbacks.append(callback)
231
self._callback_names[callback] = callback_label
234
return iter(self._callbacks)
238
strings.append("<%s(" % type(self).__name__)
239
strings.append(self.name)
240
strings.append("), callbacks=[")
241
for callback in self._callbacks:
242
strings.append(repr(callback))
244
strings.append(self._callback_names[callback])
246
if len(self._callbacks) == 1:
249
return ''.join(strings)
added
removed
bzrlib/hooks.py
