32
33
known_hooks = registry.Registry()
33
# known_hooks registry contains
34
# tuple of (module, member name) which is the hook point
35
# module where the specific hooks are defined
36
# callable to get the empty specific Hooks for that attribute
37
34
known_hooks.register_lazy(('bzrlib.branch', 'Branch.hooks'), 'bzrlib.branch',
39
36
known_hooks.register_lazy(('bzrlib.bzrdir', 'BzrDir.hooks'), 'bzrlib.bzrdir',
41
38
known_hooks.register_lazy(('bzrlib.commands', 'Command.hooks'),
42
39
'bzrlib.commands', 'CommandHooks')
43
known_hooks.register_lazy(('bzrlib.info', 'hooks'),
44
'bzrlib.info', 'InfoHooks')
45
40
known_hooks.register_lazy(('bzrlib.lock', 'Lock.hooks'), 'bzrlib.lock',
47
known_hooks.register_lazy(('bzrlib.merge', 'Merger.hooks'), 'bzrlib.merge',
49
known_hooks.register_lazy(('bzrlib.msgeditor', 'hooks'), 'bzrlib.msgeditor',
51
42
known_hooks.register_lazy(('bzrlib.mutabletree', 'MutableTree.hooks'),
52
43
'bzrlib.mutabletree', 'MutableTreeHooks')
53
44
known_hooks.register_lazy(('bzrlib.smart.client', '_SmartClient.hooks'),
54
45
'bzrlib.smart.client', 'SmartClientHooks')
55
46
known_hooks.register_lazy(('bzrlib.smart.server', 'SmartTCPServer.hooks'),
56
47
'bzrlib.smart.server', 'SmartServerHooks')
57
known_hooks.register_lazy(('bzrlib.status', 'hooks'),
58
'bzrlib.status', 'StatusHooks')
59
48
known_hooks.register_lazy(
60
49
('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks'),
61
50
'bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilderHooks')
62
known_hooks.register_lazy(
63
('bzrlib.merge_directive', 'BaseMergeDirective.hooks'),
64
'bzrlib.merge_directive', 'MergeDirectiveHooks')
67
53
def known_hooks_key_to_object((module_name, member_name)):
181
167
"""A single hook that clients can register to be called back when it fires.
183
169
:ivar name: The name of the hook.
184
:ivar doc: The docs for using the hook.
185
170
:ivar introduced: A version tuple specifying what version the hook was
186
171
introduced in. None indicates an unknown version.
187
172
:ivar deprecated: A version tuple specifying what version the hook was
188
deprecated or superseded in. None indicates that the hook is not
189
superseded or deprecated. If the hook is superseded then the doc
173
deprecated or superceded in. None indicates that the hook is not
174
superceded or deprecated. If the hook is superceded then the doc
190
175
should describe the recommended replacement hook to register for.
176
:ivar doc: The docs for using the hook.
193
179
def __init__(self, name, doc, introduced, deprecated):
222
208
strings.append('Introduced in: %s' % introduced_string)
223
209
if self.deprecated:
224
210
deprecated_string = _format_version_tuple(self.deprecated)
225
strings.append('Deprecated in: %s' % deprecated_string)
212
deprecated_string = 'Not deprecated'
213
strings.append('Deprecated in: %s' % deprecated_string)
226
214
strings.append('')
227
strings.extend(textwrap.wrap(self.__doc__,
228
break_long_words=False))
215
strings.extend(textwrap.wrap(self.__doc__))
229
216
strings.append('')
230
217
return '\n'.join(strings)
279
266
yyy.hooks.install_named_hook("xxx", ...)
281
See :doc:`Using hooks<../user-guide/hooks>` in the User Guide for examples.
268
See `Using hooks`_ in the User Guide for examples.
270
.. _Using hooks: ../user-guide/index.html#using-hooks
283
272
The class that contains each hook is given before the hooks it supplies. For
284
273
instance, BranchHooks as the class is the hooks class for