← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/decorators.py

[merge] update from bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/decorators.py
 
1
# Copyright (C) 2005 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
__all__ = ['needs_read_lock',
 
19
           'needs_write_lock',
 
20
           ]
 
21
 
 
22
def needs_read_lock(unbound):
 
23
    """Decorate unbound to take out and release a read lock.
 
24
 
 
25
    This decorator can be applied to methods of any class with lock_read() and
 
26
    unlock() methods.
 
27
    
 
28
    Typical usage:
 
29
        
 
30
    class Branch(...):
 
31
        @needs_read_lock
 
32
        def branch_method(self, ...):
 
33
            stuff
 
34
    """
 
35
    def decorated(self, *args, **kwargs):
 
36
        self.lock_read()
 
37
        try:
 
38
            return unbound(self, *args, **kwargs)
 
39
        finally:
 
40
            self.unlock()
 
41
    decorated.__doc__ = unbound.__doc__
 
42
    decorated.__name__ = unbound.__name__
 
43
    return decorated
 
44
 
 
45
 
 
46
def needs_write_lock(unbound):
 
47
    """Decorate unbound to take out and release a write lock."""
 
48
    def decorated(self, *args, **kwargs):
 
49
        self.lock_write()
 
50
        try:
 
51
            return unbound(self, *args, **kwargs)
 
52
        finally:
 
53
            self.unlock()
 
54
    decorated.__doc__ = unbound.__doc__
 
55
    decorated.__name__ = unbound.__name__
 
56
    return decorated
 
57