/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: Martin
  • Date: 2010-05-03 20:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 5204.
  • Revision ID: gzlist@googlemail.com-20100503205739-n326zdvevv0rmruh
Retain original stack and error message when translating to ValueError in bencode

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
16
16
 
17
17
 
18
18
"""Support for plugin hooking logic."""
 
19
from bzrlib import registry
19
20
from bzrlib.lazy_import import lazy_import
20
 
from bzrlib import registry
21
 
from bzrlib.symbol_versioning import deprecated_method, one_five
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)):
132
147
        """
133
148
        return self._callable_names.get(a_callable, "No hook name")
134
149
 
135
 
    @deprecated_method(one_five)
136
 
    def install_hook(self, hook_name, a_callable):
137
 
        """Install a_callable in to the hook hook_name.
138
 
 
139
 
        :param hook_name: A hook name. See the __init__ method of BranchHooks
140
 
            for the complete list of hooks.
141
 
        :param a_callable: The callable to be invoked when the hook triggers.
142
 
            The exact signature will depend on the hook - see the __init__
143
 
            method of BranchHooks for details on each hook.
144
 
        """
145
 
        self.install_named_hook(hook_name, a_callable, None)
146
 
 
147
150
    def install_named_hook(self, hook_name, a_callable, name):
148
151
        """Install a_callable in to the hook hook_name, and label it name.
149
152
 
179
182
    :ivar introduced: A version tuple specifying what version the hook was
180
183
        introduced in. None indicates an unknown version.
181
184
    :ivar deprecated: A version tuple specifying what version the hook was
182
 
        deprecated or superceded in. None indicates that the hook is not
183
 
        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
184
187
        should describe the recommended replacement hook to register for.
185
188
    :ivar doc: The docs for using the hook.
186
189
    """
217
220
        strings.append('Introduced in: %s' % introduced_string)
218
221
        if self.deprecated:
219
222
            deprecated_string = _format_version_tuple(self.deprecated)
220
 
        else:
221
 
            deprecated_string = 'Not deprecated'
222
 
        strings.append('Deprecated in: %s' % deprecated_string)
 
223
            strings.append('Deprecated in: %s' % deprecated_string)
223
224
        strings.append('')
224
 
        strings.extend(textwrap.wrap(self.__doc__))
 
225
        strings.extend(textwrap.wrap(self.__doc__,
 
226
            break_long_words=False))
225
227
        strings.append('')
226
228
        return '\n'.join(strings)
227
229
 
276
278
 
277
279
See `Using hooks`_ in the User Guide for examples.
278
280
 
279
 
.. _Using hooks: ../user-guide/index.html#using-hooks
 
281
.. _Using hooks: ../user-guide/hooks.html
280
282
 
281
283
The class that contains each hook is given before the hooks it supplies. For
282
284
instance, BranchHooks as the class is the hooks class for