← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hooks.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-02-05 21:53:22 UTC
  • mfrom: (3928.4.3 bug_295826)
  • Revision ID: pqm@pqm.ubuntu.com-20090205215322-dlhyepy2fid5i7w6
(jam) Minor tweak to setup.py documentation for bug #295826

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hooks.py
 
1
# Copyright (C) 2007, 2008 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
"""Support for plugin hooking logic."""
 
19
from bzrlib.lazy_import import lazy_import
 
20
from bzrlib.symbol_versioning import deprecated_method, one_five
 
21
lazy_import(globals(), """
 
22
from bzrlib import (
 
23
        errors,
 
24
        )
 
25
""")
 
26
 
 
27
 
 
28
class Hooks(dict):
 
29
    """A dictionary mapping hook name to a list of callables.
 
30
    
 
31
    e.g. ['FOO'] Is the list of items to be called when the
 
32
    FOO hook is triggered.
 
33
    """
 
34
 
 
35
    def __init__(self):
 
36
        dict.__init__(self)
 
37
        self._callable_names = {}
 
38
 
 
39
    def get_hook_name(self, a_callable):
 
40
        """Get the name for a_callable for UI display.
 
41
 
 
42
        If no name has been registered, the string 'No hook name' is returned.
 
43
        We use a fixed string rather than repr or the callables module because
 
44
        the code names are rarely meaningful for end users and this is not 
 
45
        intended for debugging.
 
46
        """
 
47
        return self._callable_names.get(a_callable, "No hook name")
 
48
 
 
49
    @deprecated_method(one_five)
 
50
    def install_hook(self, hook_name, a_callable):
 
51
        """Install a_callable in to the hook hook_name.
 
52
 
 
53
        :param hook_name: A hook name. See the __init__ method of BranchHooks
 
54
            for the complete list of hooks.
 
55
        :param a_callable: The callable to be invoked when the hook triggers.
 
56
            The exact signature will depend on the hook - see the __init__ 
 
57
            method of BranchHooks for details on each hook.
 
58
        """
 
59
        self.install_named_hook(hook_name, a_callable, None)
 
60
 
 
61
    def install_named_hook(self, hook_name, a_callable, name):
 
62
        """Install a_callable in to the hook hook_name, and label it name.
 
63
 
 
64
        :param hook_name: A hook name. See the __init__ method of BranchHooks
 
65
            for the complete list of hooks.
 
66
        :param a_callable: The callable to be invoked when the hook triggers.
 
67
            The exact signature will depend on the hook - see the __init__ 
 
68
            method of BranchHooks for details on each hook.
 
69
        :param name: A name to associate a_callable with, to show users what is
 
70
            running.
 
71
        """
 
72
        try:
 
73
            self[hook_name].append(a_callable)
 
74
        except KeyError:
 
75
            raise errors.UnknownHook(self.__class__.__name__, hook_name)
 
76
        if name is not None:
 
77
            self.name_hook(a_callable, name)
 
78
 
 
79
    def name_hook(self, a_callable, name):
 
80
        """Associate name with a_callable to show users what is running."""
 
81
        self._callable_names[a_callable] = name