← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hooks.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-09 17:27:46 UTC
  • mto: (5029.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5030.
  • Revision ID: v.ladeuil+lp@free.fr-20100209172746-6f4mvlnr2mac807j
Move NoSmartTransportServer to bzrlib.tests.test_server

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
 
54
55
    'bzrlib.smart.client', 'SmartClientHooks')
55
56
known_hooks.register_lazy(('bzrlib.smart.server', 'SmartTCPServer.hooks'),
56
57
    'bzrlib.smart.server', 'SmartServerHooks')
57
 
known_hooks.register_lazy(('bzrlib.status', 'hooks'),
58
 
    'bzrlib.status', 'StatusHooks')
59
58
known_hooks.register_lazy(
60
59
    ('bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilder.hooks'),
61
60
    'bzrlib.version_info_formats.format_rio', 'RioVersionInfoBuilderHooks')
62
61
known_hooks.register_lazy(
63
 
    ('bzrlib.merge_directive', 'BaseMergeDirective.hooks'),
 
62
    ('bzrlib.merge_directive', '_BaseMergeDirective.hooks'),
64
63
    'bzrlib.merge_directive', 'MergeDirectiveHooks')
65
64
 
66
65
 
181
180
    """A single hook that clients can register to be called back when it fires.
182
181
 
183
182
    :ivar name: The name of the hook.
184
 
    :ivar doc: The docs for using the hook.
185
183
    :ivar introduced: A version tuple specifying what version the hook was
186
184
        introduced in. None indicates an unknown version.
187
185
    :ivar deprecated: A version tuple specifying what version the hook was
188
186
        deprecated or superseded in. None indicates that the hook is not
189
187
        superseded or deprecated. If the hook is superseded then the doc
190
188
        should describe the recommended replacement hook to register for.
 
189
    :ivar doc: The docs for using the hook.
191
190
    """
192
191
 
193
192
    def __init__(self, name, doc, introduced, deprecated):
278
277
 
279
278
  yyy.hooks.install_named_hook("xxx", ...)
280
279
 
281
 
See :doc:`Using hooks<../user-guide/hooks>` in the User Guide for examples.
 
280
See `Using hooks`_ in the User Guide for examples.
 
281
 
 
282
.. _Using hooks: ../user-guide/hooks.html
282
283
 
283
284
The class that contains each hook is given before the hooks it supplies. For
284
285
instance, BranchHooks as the class is the hooks class for