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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Support for plugin hooking logic."""
19
from bzrlib import registry
20
from bzrlib.lazy_import import lazy_import
21
from bzrlib.symbol_versioning import deprecated_method
22
lazy_import(globals(), """
26
_format_version_tuple,
29
from bzrlib.help_topics import help_as_plain_text
33
known_hooks = registry.Registry()
34
known_hooks.register_lazy(('bzrlib.branch', 'Branch.hooks'), 'bzrlib.branch',
36
known_hooks.register_lazy(('bzrlib.bzrdir', 'BzrDir.hooks'), 'bzrlib.bzrdir',
38
known_hooks.register_lazy(('bzrlib.commands', 'Command.hooks'),
39
'bzrlib.commands', 'CommandHooks')
40
known_hooks.register_lazy(('bzrlib.lock', 'Lock.hooks'), 'bzrlib.lock',
42
known_hooks.register_lazy(('bzrlib.mutabletree', 'MutableTree.hooks'),
43
'bzrlib.mutabletree', 'MutableTreeHooks')
44
known_hooks.register_lazy(('bzrlib.smart.client', '_SmartClient.hooks'),
45
'bzrlib.smart.client', 'SmartClientHooks')
46
known_hooks.register_lazy(('bzrlib.smart.server', 'SmartTCPServer.hooks'),
47
'bzrlib.smart.server', 'SmartServerHooks')
50
def known_hooks_key_to_object((module_name, member_name)):
51
"""Convert a known_hooks key to a object.
53
:param key: A tuple (module_name, member_name) as found in the keys of
54
the known_hooks registry.
55
:return: The object this specifies.
57
return registry._LazyObjectGetter(module_name, member_name).get_obj()
60
def known_hooks_key_to_parent_and_attribute((module_name, member_name)):
61
"""Convert a known_hooks key to a object.
63
:param key: A tuple (module_name, member_name) as found in the keys of
64
the known_hooks registry.
65
:return: The object this specifies.
67
member_list = member_name.rsplit('.', 1)
68
if len(member_list) == 2:
69
parent_name, attribute = member_list
72
attribute = member_name
73
parent = known_hooks_key_to_object((module_name, parent_name))
74
return parent, attribute
78
"""A dictionary mapping hook name to a list of callables.
80
e.g. ['FOO'] Is the list of items to be called when the
81
FOO hook is triggered.
86
self._callable_names = {}
88
def create_hook(self, hook):
89
"""Create a hook which can have callbacks registered for it.
91
:param hook: The hook to create. An object meeting the protocol of
92
bzrlib.hooks.HookPoint. It's name is used as the key for future
96
raise errors.DuplicateKey(hook.name)
97
self[hook.name] = hook
100
"""Generate the documentation for this Hooks instance.
102
This introspects all the individual hooks and returns their docs as well.
104
hook_names = sorted(self.keys())
106
name = self.__class__.__name__
107
hook_docs.append(name)
108
hook_docs.append("-"*len(name))
110
for hook_name in hook_names:
111
hook = self[hook_name]
113
hook_docs.append(hook.docs())
114
except AttributeError:
117
strings.append(hook_name)
118
strings.append("~" * len(hook_name))
120
strings.append("An old-style hook. For documentation see the __init__ "
121
"method of '%s'\n" % (name,))
122
hook_docs.extend(strings)
123
return "\n".join(hook_docs)
125
def get_hook_name(self, a_callable):
126
"""Get the name for a_callable for UI display.
128
If no name has been registered, the string 'No hook name' is returned.
129
We use a fixed string rather than repr or the callables module because
130
the code names are rarely meaningful for end users and this is not
131
intended for debugging.
133
return self._callable_names.get(a_callable, "No hook name")
135
def install_named_hook(self, hook_name, a_callable, name):
136
"""Install a_callable in to the hook hook_name, and label it name.
138
:param hook_name: A hook name. See the __init__ method of BranchHooks
139
for the complete list of hooks.
140
:param a_callable: The callable to be invoked when the hook triggers.
141
The exact signature will depend on the hook - see the __init__
142
method of BranchHooks for details on each hook.
143
:param name: A name to associate a_callable with, to show users what is
147
hook = self[hook_name]
149
raise errors.UnknownHook(self.__class__.__name__, hook_name)
151
# list hooks, old-style, not yet deprecated but less useful.
152
hook.append(a_callable)
153
except AttributeError:
154
hook.hook(a_callable, name)
156
self.name_hook(a_callable, name)
158
def name_hook(self, a_callable, name):
159
"""Associate name with a_callable to show users what is running."""
160
self._callable_names[a_callable] = name
163
class HookPoint(object):
164
"""A single hook that clients can register to be called back when it fires.
166
:ivar name: The name of the hook.
167
:ivar introduced: A version tuple specifying what version the hook was
168
introduced in. None indicates an unknown version.
169
:ivar deprecated: A version tuple specifying what version the hook was
170
deprecated or superceded in. None indicates that the hook is not
171
superceded or deprecated. If the hook is superceded then the doc
172
should describe the recommended replacement hook to register for.
173
:ivar doc: The docs for using the hook.
176
def __init__(self, name, doc, introduced, deprecated):
177
"""Create a HookPoint.
179
:param name: The name of the hook, for clients to use when registering.
180
:param doc: The docs for the hook.
181
:param introduced: When the hook was introduced (e.g. (0, 15)).
182
:param deprecated: When the hook was deprecated, None for
187
self.introduced = introduced
188
self.deprecated = deprecated
190
self._callback_names = {}
193
"""Generate the documentation for this HookPoint.
195
:return: A string terminated in \n.
198
strings.append(self.name)
199
strings.append('~'*len(self.name))
202
introduced_string = _format_version_tuple(self.introduced)
204
introduced_string = 'unknown'
205
strings.append('Introduced in: %s' % introduced_string)
207
deprecated_string = _format_version_tuple(self.deprecated)
209
deprecated_string = 'Not deprecated'
210
strings.append('Deprecated in: %s' % deprecated_string)
212
strings.extend(textwrap.wrap(self.__doc__))
214
return '\n'.join(strings)
216
def __eq__(self, other):
217
return (type(other) == type(self) and
218
other.__dict__ == self.__dict__)
220
def hook(self, callback, callback_label):
221
"""Register a callback to be called when this HookPoint fires.
223
:param callback: The callable to use when this HookPoint fires.
224
:param callback_label: A label to show in the UI while this callback is
227
self._callbacks.append(callback)
228
if callback_label is not None:
229
self._callback_names[callback] = callback_label
232
return iter(self._callbacks)
235
return len(self._callbacks)
239
strings.append("<%s(" % type(self).__name__)
240
strings.append(self.name)
241
strings.append("), callbacks=[")
242
for callback in self._callbacks:
243
strings.append(repr(callback))
245
strings.append(self._callback_names[callback])
247
if len(self._callbacks) == 1:
250
return ''.join(strings)
261
A hook of type *xxx* of class *yyy* needs to be registered using::
263
yyy.hooks.install_named_hook("xxx", ...)
265
See `Using hooks`_ in the User Guide for examples.
267
.. _Using hooks: ../user-guide/index.html#using-hooks
269
The class that contains each hook is given before the hooks it supplies. For
270
instance, BranchHooks as the class is the hooks class for
271
`bzrlib.branch.Branch.hooks`.
273
Each description also indicates whether the hook runs on the client (the
274
machine where bzr was invoked) or the server (the machine addressed by
275
the branch URL). These may be, but are not necessarily, the same machine.
277
Plugins (including hooks) are run on the server if all of these is true:
279
* The connection is via a smart server (accessed with a URL starting with
280
"bzr://", "bzr+ssh://" or "bzr+http://", or accessed via a "http://"
281
URL when a smart server is available via HTTP).
283
* The hook is either server specific or part of general infrastructure rather
284
than client specific code (such as commit).
288
def hooks_help_text(topic):
289
segments = [_help_prefix]
290
for hook_key in sorted(known_hooks.keys()):
291
hooks = known_hooks_key_to_object(hook_key)
292
segments.append(hooks.docs())
293
return '\n'.join(segments)
added
removed
bzrlib/hooks.py
