← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hooks.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hooks.py
1
 
# Copyright (C) 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2007-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
18
18
"""Support for plugin hooking logic."""
19
19
from bzrlib import registry
20
20
from bzrlib.lazy_import import lazy_import
21
 
from bzrlib.symbol_versioning import deprecated_method
22
21
lazy_import(globals(), """
23
22
import textwrap
24
23
 
31
30
 
32
31
 
33
32
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
34
37
known_hooks.register_lazy(('bzrlib.branch', 'Branch.hooks'), 'bzrlib.branch',
35
38
    'BranchHooks')
36
39
known_hooks.register_lazy(('bzrlib.bzrdir', 'BzrDir.hooks'), 'bzrlib.bzrdir',
37
40
    'BzrDirHooks')
38
41
known_hooks.register_lazy(('bzrlib.commands', 'Command.hooks'),
39
42
    'bzrlib.commands', 'CommandHooks')
 
43
known_hooks.register_lazy(('bzrlib.info', 'hooks'),
 
44
    'bzrlib.info', 'InfoHooks')
40
45
known_hooks.register_lazy(('bzrlib.lock', 'Lock.hooks'), 'bzrlib.lock',
41
46
    'LockHooks')
 
47
known_hooks.register_lazy(('bzrlib.merge', 'Merger.hooks'), 'bzrlib.merge',
 
48
    'MergeHooks')
 
49
known_hooks.register_lazy(('bzrlib.msgeditor', 'hooks'), 'bzrlib.msgeditor',
 
50
    'MessageEditorHooks')
42
51
known_hooks.register_lazy(('bzrlib.mutabletree', 'MutableTree.hooks'),
43
52
    'bzrlib.mutabletree', 'MutableTreeHooks')
44
53
known_hooks.register_lazy(('bzrlib.smart.client', '_SmartClient.hooks'),
45
54
    'bzrlib.smart.client', 'SmartClientHooks')
46
55
known_hooks.register_lazy(('bzrlib.smart.server', 'SmartTCPServer.hooks'),
47
56
    'bzrlib.smart.server', 'SmartServerHooks')
 
57
known_hooks.register_lazy(
 
58
    ('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks'),
 
59
    'bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilderHooks')
 
60
known_hooks.register_lazy(
 
61
    ('bzrlib.merge_directive', 'BaseMergeDirective.hooks'),
 
62
    'bzrlib.merge_directive', 'MergeDirectiveHooks')
48
63
 
49
64
 
50
65
def known_hooks_key_to_object((module_name, member_name)):
167
182
    :ivar introduced: A version tuple specifying what version the hook was
168
183
        introduced in. None indicates an unknown version.
169
184
    :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
 
185
        deprecated or superseded in. None indicates that the hook is not
 
186
        superseded or deprecated. If the hook is superseded then the doc
172
187
        should describe the recommended replacement hook to register for.
173
188
    :ivar doc: The docs for using the hook.
174
189
    """
205
220
        strings.append('Introduced in: %s' % introduced_string)
206
221
        if self.deprecated:
207
222
            deprecated_string = _format_version_tuple(self.deprecated)
208
 
        else:
209
 
            deprecated_string = 'Not deprecated'
210
 
        strings.append('Deprecated in: %s' % deprecated_string)
 
223
            strings.append('Deprecated in: %s' % deprecated_string)
211
224
        strings.append('')
212
 
        strings.extend(textwrap.wrap(self.__doc__))
 
225
        strings.extend(textwrap.wrap(self.__doc__,
 
226
            break_long_words=False))
213
227
        strings.append('')
214
228
        return '\n'.join(strings)
215
229
 
262
276
 
263
277
  yyy.hooks.install_named_hook("xxx", ...)
264
278
 
265
 
See `Using hooks`_ in the User Guide for examples.
266
 
 
267
 
.. _Using hooks: ../user-guide/index.html#using-hooks
 
279
See :doc:`Using hooks<../user-guide/hooks>` in the User Guide for examples.
268
280
 
269
281
The class that contains each hook is given before the hooks it supplies. For
270
282
instance, BranchHooks as the class is the hooks class for