← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hooks.py

  • Committer: Robert Collins
  • Date: 2009-03-16 07:44:05 UTC
  • mto: This revision was merged to the branch mainline in revision 4149.
  • Revision ID: robertc@robertcollins.net-20090316074405-t9guvf13rj4mlhuk
More test fallout, but all caught now.

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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
18
"""Support for plugin hooking logic."""
 
19
from bzrlib.lazy_import import lazy_import
19
20
from bzrlib import registry
20
 
from bzrlib.lazy_import import lazy_import
 
21
from bzrlib.symbol_versioning import deprecated_method, one_five
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
 
known_hooks.register_lazy(('bzrlib.bzrdir', 'BzrDir.hooks'), 'bzrlib.bzrdir',
40
 
    'BzrDirHooks')
41
36
known_hooks.register_lazy(('bzrlib.commands', 'Command.hooks'),
42
37
    'bzrlib.commands', 'CommandHooks')
43
 
known_hooks.register_lazy(('bzrlib.info', 'hooks'),
44
 
    'bzrlib.info', 'InfoHooks')
45
38
known_hooks.register_lazy(('bzrlib.lock', 'Lock.hooks'), 'bzrlib.lock',
46
39
    '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
40
known_hooks.register_lazy(('bzrlib.mutabletree', 'MutableTree.hooks'),
52
41
    'bzrlib.mutabletree', 'MutableTreeHooks')
53
42
known_hooks.register_lazy(('bzrlib.smart.client', '_SmartClient.hooks'),
54
43
    'bzrlib.smart.client', 'SmartClientHooks')
55
44
known_hooks.register_lazy(('bzrlib.smart.server', 'SmartTCPServer.hooks'),
56
45
    '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')
63
46
 
64
47
 
65
48
def known_hooks_key_to_object((module_name, member_name)):
147
130
        """
148
131
        return self._callable_names.get(a_callable, "No hook name")
149
132
 
 
133
    @deprecated_method(one_five)
 
134
    def install_hook(self, hook_name, a_callable):
 
135
        """Install a_callable in to the hook hook_name.
 
136
 
 
137
        :param hook_name: A hook name. See the __init__ method of BranchHooks
 
138
            for the complete list of hooks.
 
139
        :param a_callable: The callable to be invoked when the hook triggers.
 
140
            The exact signature will depend on the hook - see the __init__
 
141
            method of BranchHooks for details on each hook.
 
142
        """
 
143
        self.install_named_hook(hook_name, a_callable, None)
 
144
 
150
145
    def install_named_hook(self, hook_name, a_callable, name):
151
146
        """Install a_callable in to the hook hook_name, and label it name.
152
147
 
182
177
    :ivar introduced: A version tuple specifying what version the hook was
183
178
        introduced in. None indicates an unknown version.
184
179
    :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
 
180
        deprecated or superceded in. None indicates that the hook is not
 
181
        superceded or deprecated. If the hook is superceded then the doc
187
182
        should describe the recommended replacement hook to register for.
188
183
    :ivar doc: The docs for using the hook.
189
184
    """
220
215
        strings.append('Introduced in: %s' % introduced_string)
221
216
        if self.deprecated:
222
217
            deprecated_string = _format_version_tuple(self.deprecated)
223
 
            strings.append('Deprecated in: %s' % deprecated_string)
 
218
        else:
 
219
            deprecated_string = 'Not deprecated'
 
220
        strings.append('Deprecated in: %s' % deprecated_string)
224
221
        strings.append('')
225
 
        strings.extend(textwrap.wrap(self.__doc__,
226
 
            break_long_words=False))
 
222
        strings.extend(textwrap.wrap(self.__doc__))
227
223
        strings.append('')
228
224
        return '\n'.join(strings)
229
225
 
278
274
 
279
275
See `Using hooks`_ in the User Guide for examples.
280
276
 
281
 
.. _Using hooks: ../user-guide/hooks.html
 
277
.. _Using hooks: ../user-guide/index.html#using-hooks
282
278
 
283
279
The class that contains each hook is given before the hooks it supplies. For
284
280
instance, BranchHooks as the class is the hooks class for