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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
18
"""Inter-object utility class."""
22
22
"""This class represents operations taking place between two objects.
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.
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).
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.)
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
# Each concrete InterObject type should have its own optimisers set.
43
# _optimisers = list()
44
# Each concrete InterObject type should have its own optimisers list.
42
46
def __init__(self, source, target):
43
47
"""Construct a default InterObject instance. Please use 'get'.
45
Only subclasses of InterObject should call
49
Only subclasses of InterObject should call
46
50
InterObject.__init__ - clients should call InterFOO.get where FOO
47
51
is the base type of the objects they are interacting between. I.e.
48
52
InterVersionedFile or InterRepository.
74
78
If an optimised worker exists it will be used otherwise
75
79
a default Inter worker instance will be created.
77
for provider in klass._optimisers:
81
for provider in reversed(klass._optimisers):
78
82
if provider.is_compatible(source, target):
79
83
return provider(source, target)
80
84
return klass(source, target)
99
103
def register_optimiser(klass, optimiser):
100
104
"""Register an InterObject optimiser."""
101
klass._optimisers.add(optimiser)
105
klass._optimisers.append(optimiser)
103
107
def unlock(self):
104
108
"""Release the locks on source and target."""