← 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: 2009-04-09 20:23:07 UTC
  • mfrom: (4265.1.4 bbc-merge)
  • Revision ID: pqm@pqm.ubuntu.com-20090409202307-n0depb16qepoe21o
(jam) Change _fetch_uses_deltas = False for CHK repos until we can
        write a better fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hooks.py
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007, 2008 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
21
22
lazy_import(globals(), """
22
23
import textwrap
23
24
 
40
41
    'BzrDirHooks')
41
42
known_hooks.register_lazy(('bzrlib.commands', 'Command.hooks'),
42
43
    'bzrlib.commands', 'CommandHooks')
43
 
known_hooks.register_lazy(('bzrlib.info', 'hooks'),
44
 
    'bzrlib.info', 'InfoHooks')
45
44
known_hooks.register_lazy(('bzrlib.lock', 'Lock.hooks'), 'bzrlib.lock',
46
45
    'LockHooks')
47
 
known_hooks.register_lazy(('bzrlib.merge', 'Merger.hooks'), 'bzrlib.merge',
48
 
    'MergeHooks')
49
46
known_hooks.register_lazy(('bzrlib.msgeditor', 'hooks'), 'bzrlib.msgeditor',
50
47
    'MessageEditorHooks')
51
48
known_hooks.register_lazy(('bzrlib.mutabletree', 'MutableTree.hooks'),
57
54
known_hooks.register_lazy(
58
55
    ('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks'),
59
56
    'bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilderHooks')
60
 
known_hooks.register_lazy(
61
 
    ('bzrlib.merge_directive', 'BaseMergeDirective.hooks'),
62
 
    'bzrlib.merge_directive', 'MergeDirectiveHooks')
63
57
 
64
58
 
65
59
def known_hooks_key_to_object((module_name, member_name)):
182
176
    :ivar introduced: A version tuple specifying what version the hook was
183
177
        introduced in. None indicates an unknown version.
184
178
    :ivar deprecated: A version tuple specifying what version the hook was
185
 
        deprecated or superseded in. None indicates that the hook is not
186
 
        superseded or deprecated. If the hook is superseded then the doc
 
179
        deprecated or superceded in. None indicates that the hook is not
 
180
        superceded or deprecated. If the hook is superceded then the doc
187
181
        should describe the recommended replacement hook to register for.
188
182
    :ivar doc: The docs for using the hook.
189
183
    """
220
214
        strings.append('Introduced in: %s' % introduced_string)
221
215
        if self.deprecated:
222
216
            deprecated_string = _format_version_tuple(self.deprecated)
223
 
            strings.append('Deprecated in: %s' % deprecated_string)
 
217
        else:
 
218
            deprecated_string = 'Not deprecated'
 
219
        strings.append('Deprecated in: %s' % deprecated_string)
224
220
        strings.append('')
225
 
        strings.extend(textwrap.wrap(self.__doc__,
226
 
            break_long_words=False))
 
221
        strings.extend(textwrap.wrap(self.__doc__))
227
222
        strings.append('')
228
223
        return '\n'.join(strings)
229
224
 
278
273
 
279
274
See `Using hooks`_ in the User Guide for examples.
280
275
 
281
 
.. _Using hooks: ../user-guide/hooks.html
 
276
.. _Using hooks: ../user-guide/index.html#using-hooks
282
277
 
283
278
The class that contains each hook is given before the hooks it supplies. For
284
279
instance, BranchHooks as the class is the hooks class for