← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inter.py

  • Committer: Martin Pool
  • Date: 2009-03-24 05:21:02 UTC
  • mfrom: (4192 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4202.
  • Revision ID: mbp@sourcefrog.net-20090324052102-8kk087b32tep3d9h
merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/inter.py
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
32
 
33
 
    If the source and target objects implement the locking protocol - 
 
33
    If the source and target objects implement the locking protocol -
34
34
    lock_read, lock_write, unlock, then the InterObject's lock_read,
35
35
    lock_write and unlock methods may be used (optionally in conjunction with
36
36
    the needs_read_lock and needs_write_lock decorators.)
45
45
 
46
46
    def __init__(self, source, target):
47
47
        """Construct a default InterObject instance. Please use 'get'.
48
 
        
49
 
        Only subclasses of InterObject should call 
 
48
 
 
49
        Only subclasses of InterObject should call
50
50
        InterObject.__init__ - clients should call InterFOO.get where FOO
51
51
        is the base type of the objects they are interacting between. I.e.
52
52
        InterVersionedFile or InterRepository.