← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hooks.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-19 17:53:37 UTC
  • mto: This revision was merged to the branch mainline in revision 4466.
  • Revision ID: john@arbash-meinel.com-20090619175337-uozt3bntdd48lh4z
Update time_graph to use X:1 ratios rather than 0.xxx ratios.
It is just easier to track now that the new code is much faster.

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
 
44
45
    'bzrlib.info', 'InfoHooks')
45
46
known_hooks.register_lazy(('bzrlib.lock', 'Lock.hooks'), 'bzrlib.lock',
46
47
    'LockHooks')
47
 
known_hooks.register_lazy(('bzrlib.merge', 'Merger.hooks'), 'bzrlib.merge',
48
 
    'MergeHooks')
49
48
known_hooks.register_lazy(('bzrlib.msgeditor', 'hooks'), 'bzrlib.msgeditor',
50
49
    'MessageEditorHooks')
51
50
known_hooks.register_lazy(('bzrlib.mutabletree', 'MutableTree.hooks'),
54
53
    'bzrlib.smart.client', 'SmartClientHooks')
55
54
known_hooks.register_lazy(('bzrlib.smart.server', 'SmartTCPServer.hooks'),
56
55
    'bzrlib.smart.server', 'SmartServerHooks')
57
 
known_hooks.register_lazy(('bzrlib.status', 'hooks'),
58
 
    'bzrlib.status', 'StatusHooks')
59
56
known_hooks.register_lazy(
60
57
    ('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks'),
61
58
    'bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilderHooks')
62
59
known_hooks.register_lazy(
63
 
    ('bzrlib.merge_directive', 'BaseMergeDirective.hooks'),
 
60
    ('bzrlib.merge_directive', '_BaseMergeDirective.hooks'),
64
61
    'bzrlib.merge_directive', 'MergeDirectiveHooks')
65
62
 
66
63
 
181
178
    """A single hook that clients can register to be called back when it fires.
182
179
 
183
180
    :ivar name: The name of the hook.
184
 
    :ivar doc: The docs for using the hook.
185
181
    :ivar introduced: A version tuple specifying what version the hook was
186
182
        introduced in. None indicates an unknown version.
187
183
    :ivar deprecated: A version tuple specifying what version the hook was
188
184
        deprecated or superseded in. None indicates that the hook is not
189
185
        superseded or deprecated. If the hook is superseded then the doc
190
186
        should describe the recommended replacement hook to register for.
 
187
    :ivar doc: The docs for using the hook.
191
188
    """
192
189
 
193
190
    def __init__(self, name, doc, introduced, deprecated):
222
219
        strings.append('Introduced in: %s' % introduced_string)
223
220
        if self.deprecated:
224
221
            deprecated_string = _format_version_tuple(self.deprecated)
225
 
            strings.append('Deprecated in: %s' % deprecated_string)
 
222
        else:
 
223
            deprecated_string = 'Not deprecated'
 
224
        strings.append('Deprecated in: %s' % deprecated_string)
226
225
        strings.append('')
227
 
        strings.extend(textwrap.wrap(self.__doc__,
228
 
            break_long_words=False))
 
226
        strings.extend(textwrap.wrap(self.__doc__))
229
227
        strings.append('')
230
228
        return '\n'.join(strings)
231
229
 
278
276
 
279
277
  yyy.hooks.install_named_hook("xxx", ...)
280
278
 
281
 
See :doc:`Using hooks<../user-guide/hooks>` in the User Guide for examples.
 
279
See `Using hooks`_ in the User Guide for examples.
 
280
 
 
281
.. _Using hooks: ../user-guide/index.html#using-hooks
282
282
 
283
283
The class that contains each hook is given before the hooks it supplies. For
284
284
instance, BranchHooks as the class is the hooks class for