← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inter.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

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."""
19
19
 
20
20
 
21
 
from bzrlib.errors import NoCompatibleInter
22
 
 
23
 
 
24
21
class InterObject(object):
25
22
    """This class represents operations taking place between two objects.
26
23
 
27
24
    Its instances have methods like join or copy_content or fetch, and contain
28
 
    references to the source and target objects these operations can be
 
25
    references to the source and target objects these operations can be 
29
26
    carried out between.
30
27
 
31
28
    Often we will provide convenience methods on the objects which carry out
32
29
    operations with another of similar type - they will always forward to
33
 
    a subclass of InterObject - i.e.
 
30
    a subclass of InterObject - i.e. 
34
31
    InterVersionedFile.get(other).method_name(parameters).
35
32
 
36
 
    If the source and target objects implement the locking protocol -
 
33
    If the source and target objects implement the locking protocol - 
37
34
    lock_read, lock_write, unlock, then the InterObject's lock_read,
38
35
    lock_write and unlock methods may be used (optionally in conjunction with
39
36
    the needs_read_lock and needs_write_lock decorators.)
48
45
 
49
46
    def __init__(self, source, target):
50
47
        """Construct a default InterObject instance. Please use 'get'.
51
 
 
52
 
        Only subclasses of InterObject should call
 
48
        
 
49
        Only subclasses of InterObject should call 
53
50
        InterObject.__init__ - clients should call InterFOO.get where FOO
54
51
        is the base type of the objects they are interacting between. I.e.
55
52
        InterVersionedFile or InterRepository.
78
75
                       the InterObject instance.
79
76
        :param target: the object to be the 'target' member of
80
77
                       the InterObject instance.
81
 
 
82
78
        If an optimised worker exists it will be used otherwise
83
79
        a default Inter worker instance will be created.
84
80
        """
85
81
        for provider in reversed(klass._optimisers):
86
82
            if provider.is_compatible(source, target):
87
83
                return provider(source, target)
88
 
        raise NoCompatibleInter(source, target)
 
84
        return klass(source, target)
89
85
 
90
86
    def lock_read(self):
91
87
        """Take out a logical read lock.