/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/hooks.py

  • Committer: Jelmer Vernooij
  • Date: 2009-04-06 21:01:10 UTC
  • mto: This revision was merged to the branch mainline in revision 4282.
  • Revision ID: jelmer@samba.org-20090406210110-3f2ektdpbhrpl9bf
Cope with revision.committer being None.

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
 
30
31
 
31
32
 
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',
38
35
    'BranchHooks')
39
36
known_hooks.register_lazy(('bzrlib.bzrdir', 'BzrDir.hooks'), 'bzrlib.bzrdir',
40
37
    'BzrDirHooks')
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',
46
41
    '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')
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'),
57
48
known_hooks.register_lazy(
58
49
    ('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks'),
59
50
    'bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilderHooks')
60
 
known_hooks.register_lazy(
61
 
    ('bzrlib.merge_directive', 'BaseMergeDirective.hooks'),
62
 
    'bzrlib.merge_directive', 'MergeDirectiveHooks')
63
51
 
64
52
 
65
53
def known_hooks_key_to_object((module_name, member_name)):
182
170
    :ivar introduced: A version tuple specifying what version the hook was
183
171
        introduced in. None indicates an unknown version.
184
172
    :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
 
173
        deprecated or superceded in. None indicates that the hook is not
 
174
        superceded or deprecated. If the hook is superceded then the doc
187
175
        should describe the recommended replacement hook to register for.
188
176
    :ivar doc: The docs for using the hook.
189
177
    """
220
208
        strings.append('Introduced in: %s' % introduced_string)
221
209
        if self.deprecated:
222
210
            deprecated_string = _format_version_tuple(self.deprecated)
223
 
            strings.append('Deprecated in: %s' % deprecated_string)
 
211
        else:
 
212
            deprecated_string = 'Not deprecated'
 
213
        strings.append('Deprecated in: %s' % deprecated_string)
224
214
        strings.append('')
225
 
        strings.extend(textwrap.wrap(self.__doc__,
226
 
            break_long_words=False))
 
215
        strings.extend(textwrap.wrap(self.__doc__))
227
216
        strings.append('')
228
217
        return '\n'.join(strings)
229
218
 
278
267
 
279
268
See `Using hooks`_ in the User Guide for examples.
280
269
 
281
 
.. _Using hooks: ../user-guide/hooks.html
 
270
.. _Using hooks: ../user-guide/index.html#using-hooks
282
271
 
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