← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inter.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-05-19 06:14:38 UTC
  • mfrom: (1704.2.23 bzr.mbp.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060519061438-6300caf3926c3cff
(mbp) small fixes

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/inter.py
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
18
"""Inter-object utility class."""
22
22
    """This class represents operations taking place between two objects.
23
23
 
24
24
    Its instances have methods like join or copy_content or fetch, and contain
25
 
    references to the source and target objects these operations can be
 
25
    references to the source and target objects these operations can be 
26
26
    carried out between.
27
27
 
28
28
    Often we will provide convenience methods on the objects which carry out
29
29
    operations with another of similar type - they will always forward to
30
 
    a subclass of InterObject - i.e.
 
30
    a subclass of InterObject - i.e. 
31
31
    InterVersionedFile.get(other).method_name(parameters).
32
 
 
33
 
    If the source and target objects implement the locking protocol -
34
 
    lock_read, lock_write, unlock, then the InterObject's lock_read,
35
 
    lock_write and unlock methods may be used (optionally in conjunction with
36
 
    the needs_read_lock and needs_write_lock decorators.)
37
 
 
38
 
    When looking for an inter, the most recently registered types are tested
39
 
    first.  So typically the most generic and slowest InterObjects should be
40
 
    registered first.
41
32
    """
42
33
 
43
 
    # _optimisers = list()
44
 
    # Each concrete InterObject type should have its own optimisers list.
 
34
    # _optimisers = set()
 
35
    # Each concrete InterObject type should have its own optimisers set.
45
36
 
46
37
    def __init__(self, source, target):
47
38
        """Construct a default InterObject instance. Please use 'get'.
48
 
 
49
 
        Only subclasses of InterObject should call
 
39
        
 
40
        Only subclasses of InterObject should call 
50
41
        InterObject.__init__ - clients should call InterFOO.get where FOO
51
42
        is the base type of the objects they are interacting between. I.e.
52
43
        InterVersionedFile or InterRepository.
56
47
        self.source = source
57
48
        self.target = target
58
49
 
59
 
    def _double_lock(self, lock_source, lock_target):
60
 
        """Take out two locks, rolling back the first if the second throws."""
61
 
        lock_source()
62
 
        try:
63
 
            lock_target()
64
 
        except Exception:
65
 
            # we want to ensure that we don't leave source locked by mistake.
66
 
            # and any error on target should not confuse source.
67
 
            self.source.unlock()
68
 
            raise
69
 
 
70
50
    @classmethod
71
51
    def get(klass, source, target):
72
52
        """Retrieve a Inter worker object for these objects.
78
58
        If an optimised worker exists it will be used otherwise
79
59
        a default Inter worker instance will be created.
80
60
        """
81
 
        for provider in reversed(klass._optimisers):
 
61
        for provider in klass._optimisers:
82
62
            if provider.is_compatible(source, target):
83
63
                return provider(source, target)
84
64
        return klass(source, target)
85
65
 
86
 
    def lock_read(self):
87
 
        """Take out a logical read lock.
88
 
 
89
 
        This will lock the source branch and the target branch. The source gets
90
 
        a read lock and the target a read lock.
91
 
        """
92
 
        self._double_lock(self.source.lock_read, self.target.lock_read)
93
 
 
94
 
    def lock_write(self):
95
 
        """Take out a logical write lock.
96
 
 
97
 
        This will lock the source branch and the target branch. The source gets
98
 
        a read lock and the target a write lock.
99
 
        """
100
 
        self._double_lock(self.source.lock_read, self.target.lock_write)
101
 
 
102
66
    @classmethod
103
67
    def register_optimiser(klass, optimiser):
104
68
        """Register an InterObject optimiser."""
105
 
        klass._optimisers.append(optimiser)
106
 
 
107
 
    def unlock(self):
108
 
        """Release the locks on source and target."""
109
 
        try:
110
 
            self.target.unlock()
111
 
        finally:
112
 
            self.source.unlock()
 
69
        klass._optimisers.add(optimiser)
113
70
 
114
71
    @classmethod
115
72
    def unregister_optimiser(klass, optimiser):