1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
# Copyright (C) 2007, 2008 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Support for plugin hooking logic."""
from bzrlib import registry
from bzrlib.lazy_import import lazy_import
from bzrlib.symbol_versioning import deprecated_method
lazy_import(globals(), """
import textwrap
from bzrlib import (
_format_version_tuple,
errors,
)
from bzrlib.help_topics import help_as_plain_text
""")
known_hooks = registry.Registry()
known_hooks.register_lazy(('bzrlib.branch', 'Branch.hooks'), 'bzrlib.branch',
'BranchHooks')
known_hooks.register_lazy(('bzrlib.bzrdir', 'BzrDir.hooks'), 'bzrlib.bzrdir',
'BzrDirHooks')
known_hooks.register_lazy(('bzrlib.commands', 'Command.hooks'),
'bzrlib.commands', 'CommandHooks')
known_hooks.register_lazy(('bzrlib.lock', 'Lock.hooks'), 'bzrlib.lock',
'LockHooks')
known_hooks.register_lazy(('bzrlib.mutabletree', 'MutableTree.hooks'),
'bzrlib.mutabletree', 'MutableTreeHooks')
known_hooks.register_lazy(('bzrlib.smart.client', '_SmartClient.hooks'),
'bzrlib.smart.client', 'SmartClientHooks')
known_hooks.register_lazy(('bzrlib.smart.server', 'SmartTCPServer.hooks'),
'bzrlib.smart.server', 'SmartServerHooks')
def known_hooks_key_to_object((module_name, member_name)):
"""Convert a known_hooks key to a object.
:param key: A tuple (module_name, member_name) as found in the keys of
the known_hooks registry.
:return: The object this specifies.
"""
return registry._LazyObjectGetter(module_name, member_name).get_obj()
def known_hooks_key_to_parent_and_attribute((module_name, member_name)):
"""Convert a known_hooks key to a object.
:param key: A tuple (module_name, member_name) as found in the keys of
the known_hooks registry.
:return: The object this specifies.
"""
member_list = member_name.rsplit('.', 1)
if len(member_list) == 2:
parent_name, attribute = member_list
else:
parent_name = None
attribute = member_name
parent = known_hooks_key_to_object((module_name, parent_name))
return parent, attribute
class Hooks(dict):
"""A dictionary mapping hook name to a list of callables.
e.g. ['FOO'] Is the list of items to be called when the
FOO hook is triggered.
"""
def __init__(self):
dict.__init__(self)
self._callable_names = {}
def create_hook(self, hook):
"""Create a hook which can have callbacks registered for it.
:param hook: The hook to create. An object meeting the protocol of
bzrlib.hooks.HookPoint. It's name is used as the key for future
lookups.
"""
if hook.name in self:
raise errors.DuplicateKey(hook.name)
self[hook.name] = hook
def docs(self):
"""Generate the documentation for this Hooks instance.
This introspects all the individual hooks and returns their docs as well.
"""
hook_names = sorted(self.keys())
hook_docs = []
name = self.__class__.__name__
hook_docs.append(name)
hook_docs.append("-"*len(name))
hook_docs.append("")
for hook_name in hook_names:
hook = self[hook_name]
try:
hook_docs.append(hook.docs())
except AttributeError:
# legacy hook
strings = []
strings.append(hook_name)
strings.append("~" * len(hook_name))
strings.append("")
strings.append("An old-style hook. For documentation see the __init__ "
"method of '%s'\n" % (name,))
hook_docs.extend(strings)
return "\n".join(hook_docs)
def get_hook_name(self, a_callable):
"""Get the name for a_callable for UI display.
If no name has been registered, the string 'No hook name' is returned.
We use a fixed string rather than repr or the callables module because
the code names are rarely meaningful for end users and this is not
intended for debugging.
"""
return self._callable_names.get(a_callable, "No hook name")
def install_named_hook(self, hook_name, a_callable, name):
"""Install a_callable in to the hook hook_name, and label it name.
:param hook_name: A hook name. See the __init__ method of BranchHooks
for the complete list of hooks.
:param a_callable: The callable to be invoked when the hook triggers.
The exact signature will depend on the hook - see the __init__
method of BranchHooks for details on each hook.
:param name: A name to associate a_callable with, to show users what is
running.
"""
try:
hook = self[hook_name]
except KeyError:
raise errors.UnknownHook(self.__class__.__name__, hook_name)
try:
# list hooks, old-style, not yet deprecated but less useful.
hook.append(a_callable)
except AttributeError:
hook.hook(a_callable, name)
if name is not None:
self.name_hook(a_callable, name)
def name_hook(self, a_callable, name):
"""Associate name with a_callable to show users what is running."""
self._callable_names[a_callable] = name
class HookPoint(object):
"""A single hook that clients can register to be called back when it fires.
:ivar name: The name of the hook.
:ivar introduced: A version tuple specifying what version the hook was
introduced in. None indicates an unknown version.
:ivar deprecated: A version tuple specifying what version the hook was
deprecated or superceded in. None indicates that the hook is not
superceded or deprecated. If the hook is superceded then the doc
should describe the recommended replacement hook to register for.
:ivar doc: The docs for using the hook.
"""
def __init__(self, name, doc, introduced, deprecated):
"""Create a HookPoint.
:param name: The name of the hook, for clients to use when registering.
:param doc: The docs for the hook.
:param introduced: When the hook was introduced (e.g. (0, 15)).
:param deprecated: When the hook was deprecated, None for
not-deprecated.
"""
self.name = name
self.__doc__ = doc
self.introduced = introduced
self.deprecated = deprecated
self._callbacks = []
self._callback_names = {}
def docs(self):
"""Generate the documentation for this HookPoint.
:return: A string terminated in \n.
"""
strings = []
strings.append(self.name)
strings.append('~'*len(self.name))
strings.append('')
if self.introduced:
introduced_string = _format_version_tuple(self.introduced)
else:
introduced_string = 'unknown'
strings.append('Introduced in: %s' % introduced_string)
if self.deprecated:
deprecated_string = _format_version_tuple(self.deprecated)
else:
deprecated_string = 'Not deprecated'
strings.append('Deprecated in: %s' % deprecated_string)
strings.append('')
strings.extend(textwrap.wrap(self.__doc__))
strings.append('')
return '\n'.join(strings)
def __eq__(self, other):
return (type(other) == type(self) and
other.__dict__ == self.__dict__)
def hook(self, callback, callback_label):
"""Register a callback to be called when this HookPoint fires.
:param callback: The callable to use when this HookPoint fires.
:param callback_label: A label to show in the UI while this callback is
processing.
"""
self._callbacks.append(callback)
if callback_label is not None:
self._callback_names[callback] = callback_label
def __iter__(self):
return iter(self._callbacks)
def __len__(self):
return len(self._callbacks)
def __repr__(self):
strings = []
strings.append("<%s(" % type(self).__name__)
strings.append(self.name)
strings.append("), callbacks=[")
for callback in self._callbacks:
strings.append(repr(callback))
strings.append("(")
strings.append(self._callback_names[callback])
strings.append("),")
if len(self._callbacks) == 1:
strings[-1] = ")"
strings.append("]>")
return ''.join(strings)
_help_prefix = \
"""
Hooks
=====
Introduction
------------
A hook of type *xxx* of class *yyy* needs to be registered using::
yyy.hooks.install_named_hook("xxx", ...)
See `Using hooks`_ in the User Guide for examples.
.. _Using hooks: ../user-guide/index.html#using-hooks
The class that contains each hook is given before the hooks it supplies. For
instance, BranchHooks as the class is the hooks class for
`bzrlib.branch.Branch.hooks`.
Each description also indicates whether the hook runs on the client (the
machine where bzr was invoked) or the server (the machine addressed by
the branch URL). These may be, but are not necessarily, the same machine.
Plugins (including hooks) are run on the server if all of these is true:
* The connection is via a smart server (accessed with a URL starting with
"bzr://", "bzr+ssh://" or "bzr+http://", or accessed via a "http://"
URL when a smart server is available via HTTP).
* The hook is either server specific or part of general infrastructure rather
than client specific code (such as commit).
"""
def hooks_help_text(topic):
segments = [_help_prefix]
for hook_key in sorted(known_hooks.keys()):
hooks = known_hooks_key_to_object(hook_key)
segments.append(hooks.docs())
return '\n'.join(segments)
|