← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jason Spashett
  • Date: 2010-06-18 11:07:07 UTC
  • mto: This revision was merged to the branch mainline in revision 5315.
  • Revision ID: jason@spashett.com-20100618110707-me59kfy33lux7doc
Take away removal of --profile-imports from bzr script. Instead ignore this in global options bzrlib/commands.py run_bzr

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
29
29
        errors,
30
30
        lockdir,
31
31
        lockable_files,
 
32
        remote,
32
33
        repository,
33
34
        revision as _mod_revision,
34
35
        rio,
49
50
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
51
from bzrlib.hooks import HookPoint, Hooks
51
52
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
53
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
54
from bzrlib import registry
54
55
from bzrlib.symbol_versioning import (
55
56
    deprecated_in,
197
198
        return self.supports_tags() and self.tags.get_tag_dict()
198
199
 
199
200
    def get_config(self):
 
201
        """Get a bzrlib.config.BranchConfig for this Branch.
 
202
 
 
203
        This can then be used to get and set configuration options for the
 
204
        branch.
 
205
 
 
206
        :return: A bzrlib.config.BranchConfig.
 
207
        """
200
208
        return BranchConfig(self)
201
209
 
202
210
    def _get_config(self):
295
303
    def lock_read(self):
296
304
        """Lock the branch for read operations.
297
305
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
 
306
        :return: A bzrlib.lock.LogicalLockResult.
300
307
        """
301
308
        raise NotImplementedError(self.lock_read)
302
309
 
962
969
                raise errors.NoSuchRevision(self, stop_revision)
963
970
        return other_history[self_len:stop_revision]
964
971
 
965
 
    @needs_write_lock
966
972
    def update_revisions(self, other, stop_revision=None, overwrite=False,
967
973
                         graph=None):
968
974
        """Pull in new perfect-fit revisions.
1017
1023
            self._extend_partial_history(distance_from_last)
1018
1024
        return self._partial_revision_history_cache[distance_from_last]
1019
1025
 
1020
 
    @needs_write_lock
1021
1026
    def pull(self, source, overwrite=False, stop_revision=None,
1022
1027
             possible_transports=None, *args, **kwargs):
1023
1028
        """Mirror source into this branch.
1266
1271
                revno = 1
1267
1272
        destination.set_last_revision_info(revno, revision_id)
1268
1273
 
1269
 
    @needs_read_lock
1270
1274
    def copy_content_into(self, destination, revision_id=None):
1271
1275
        """Copy the content of self into destination.
1272
1276
 
1273
1277
        revision_id: if not None, the revision history in the new branch will
1274
1278
                     be truncated to end with revision_id.
1275
1279
        """
1276
 
        self.update_references(destination)
1277
 
        self._synchronize_history(destination, revision_id)
1278
 
        try:
1279
 
            parent = self.get_parent()
1280
 
        except errors.InaccessibleParent, e:
1281
 
            mutter('parent was not accessible to copy: %s', e)
1282
 
        else:
1283
 
            if parent:
1284
 
                destination.set_parent(parent)
1285
 
        if self._push_should_merge_tags():
1286
 
            self.tags.merge_to(destination.tags)
 
1280
        return InterBranch.get(self, destination).copy_content_into(
 
1281
            revision_id=revision_id)
1287
1282
 
1288
1283
    def update_references(self, target):
1289
1284
        if not getattr(self._format, 'supports_reference_locations', False):
1357
1352
        """
1358
1353
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1359
1354
        # clone call. Or something. 20090224 RBC/spiv.
 
1355
        # XXX: Should this perhaps clone colocated branches as well, 
 
1356
        # rather than just the default branch? 20100319 JRV
1360
1357
        if revision_id is None:
1361
1358
            revision_id = self.last_revision()
1362
1359
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1532
1529
        """Return the current default format."""
1533
1530
        return klass._default_format
1534
1531
 
1535
 
    def get_reference(self, a_bzrdir):
 
1532
    def get_reference(self, a_bzrdir, name=None):
1536
1533
        """Get the target reference of the branch in a_bzrdir.
1537
1534
 
1538
1535
        format probing must have been completed before calling
1540
1537
        in a_bzrdir is correct.
1541
1538
 
1542
1539
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1540
        :param name: Name of the colocated branch to fetch
1543
1541
        :return: None if the branch is not a reference branch.
1544
1542
        """
1545
1543
        return None
1546
1544
 
1547
1545
    @classmethod
1548
 
    def set_reference(self, a_bzrdir, to_branch):
 
1546
    def set_reference(self, a_bzrdir, name, to_branch):
1549
1547
        """Set the target reference of the branch in a_bzrdir.
1550
1548
 
1551
1549
        format probing must have been completed before calling
1553
1551
        in a_bzrdir is correct.
1554
1552
 
1555
1553
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1554
        :param name: Name of colocated branch to set, None for default
1556
1555
        :param to_branch: branch that the checkout is to reference
1557
1556
        """
1558
1557
        raise NotImplementedError(self.set_reference)
2168
2167
        """See BranchFormat.get_format_description()."""
2169
2168
        return "Checkout reference format 1"
2170
2169
 
2171
 
    def get_reference(self, a_bzrdir):
 
2170
    def get_reference(self, a_bzrdir, name=None):
2172
2171
        """See BranchFormat.get_reference()."""
2173
 
        transport = a_bzrdir.get_branch_transport(None)
 
2172
        transport = a_bzrdir.get_branch_transport(None, name=name)
2174
2173
        return transport.get_bytes('location')
2175
2174
 
2176
 
    def set_reference(self, a_bzrdir, to_branch):
 
2175
    def set_reference(self, a_bzrdir, name, to_branch):
2177
2176
        """See BranchFormat.set_reference()."""
2178
 
        transport = a_bzrdir.get_branch_transport(None)
 
2177
        transport = a_bzrdir.get_branch_transport(None, name=name)
2179
2178
        location = transport.put_bytes('location', to_branch.base)
2180
2179
 
2181
2180
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2232
2231
                raise AssertionError("wrong format %r found for %r" %
2233
2232
                    (format, self))
2234
2233
        if location is None:
2235
 
            location = self.get_reference(a_bzrdir)
 
2234
            location = self.get_reference(a_bzrdir, name)
2236
2235
        real_bzrdir = bzrdir.BzrDir.open(
2237
2236
            location, possible_transports=possible_transports)
2238
2237
        result = real_bzrdir.open_branch(name=name, 
2276
2275
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
2276
 
2278
2277
 
2279
 
class BranchWriteLockResult(object):
 
2278
class BranchWriteLockResult(LogicalLockResult):
2280
2279
    """The result of write locking a branch.
2281
2280
 
2282
2281
    :ivar branch_token: The token obtained from the underlying branch lock, or
2285
2284
    """
2286
2285
 
2287
2286
    def __init__(self, unlock, branch_token):
 
2287
        LogicalLockResult.__init__(self, unlock)
2288
2288
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
2289
 
2291
 
    def __str__(self):
 
2290
    def __repr__(self):
2292
2291
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2293
2292
            self.unlock)
2294
2293
 
2379
2378
    def lock_read(self):
2380
2379
        """Lock the branch for read operations.
2381
2380
 
2382
 
        :return: An object with an unlock method which will release the lock
2383
 
            obtained.
 
2381
        :return: A bzrlib.lock.LogicalLockResult.
2384
2382
        """
2385
2383
        if not self.is_locked():
2386
2384
            self._note_lock('r')
2394
2392
            took_lock = False
2395
2393
        try:
2396
2394
            self.control_files.lock_read()
2397
 
            return self
 
2395
            return LogicalLockResult(self.unlock)
2398
2396
        except:
2399
2397
            if took_lock:
2400
2398
                self.repository.unlock()
3186
3184
    _optimisers = []
3187
3185
    """The available optimised InterBranch types."""
3188
3186
 
3189
 
    @staticmethod
3190
 
    def _get_branch_formats_to_test():
3191
 
        """Return a tuple with the Branch formats to use when testing."""
3192
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
3187
    @classmethod
 
3188
    def _get_branch_formats_to_test(klass):
 
3189
        """Return an iterable of format tuples for testing.
 
3190
        
 
3191
        :return: An iterable of (from_format, to_format) to use when testing
 
3192
            this InterBranch class. Each InterBranch class should define this
 
3193
            method itself.
 
3194
        """
 
3195
        raise NotImplementedError(klass._get_branch_formats_to_test)
3193
3196
 
 
3197
    @needs_write_lock
3194
3198
    def pull(self, overwrite=False, stop_revision=None,
3195
3199
             possible_transports=None, local=False):
3196
3200
        """Mirror source into target branch.
3201
3205
        """
3202
3206
        raise NotImplementedError(self.pull)
3203
3207
 
 
3208
    @needs_write_lock
3204
3209
    def update_revisions(self, stop_revision=None, overwrite=False,
3205
3210
                         graph=None):
3206
3211
        """Pull in new perfect-fit revisions.
3214
3219
        """
3215
3220
        raise NotImplementedError(self.update_revisions)
3216
3221
 
 
3222
    @needs_write_lock
3217
3223
    def push(self, overwrite=False, stop_revision=None,
3218
3224
             _override_hook_source_branch=None):
3219
3225
        """Mirror the source branch into the target branch.
3224
3230
 
3225
3231
 
3226
3232
class GenericInterBranch(InterBranch):
3227
 
    """InterBranch implementation that uses public Branch functions.
3228
 
    """
3229
 
 
3230
 
    @staticmethod
3231
 
    def _get_branch_formats_to_test():
3232
 
        return BranchFormat._default_format, BranchFormat._default_format
3233
 
 
 
3233
    """InterBranch implementation that uses public Branch functions."""
 
3234
 
 
3235
    @classmethod
 
3236
    def is_compatible(klass, source, target):
 
3237
        # GenericBranch uses the public API, so always compatible
 
3238
        return True
 
3239
 
 
3240
    @classmethod
 
3241
    def _get_branch_formats_to_test(klass):
 
3242
        return [(BranchFormat._default_format, BranchFormat._default_format)]
 
3243
 
 
3244
    @classmethod
 
3245
    def unwrap_format(klass, format):
 
3246
        if isinstance(format, remote.RemoteBranchFormat):
 
3247
            format._ensure_real()
 
3248
            return format._custom_format
 
3249
        return format                                                                                                  
 
3250
 
 
3251
    @needs_write_lock
 
3252
    def copy_content_into(self, revision_id=None):
 
3253
        """Copy the content of source into target
 
3254
 
 
3255
        revision_id: if not None, the revision history in the new branch will
 
3256
                     be truncated to end with revision_id.
 
3257
        """
 
3258
        self.source.update_references(self.target)
 
3259
        self.source._synchronize_history(self.target, revision_id)
 
3260
        try:
 
3261
            parent = self.source.get_parent()
 
3262
        except errors.InaccessibleParent, e:
 
3263
            mutter('parent was not accessible to copy: %s', e)
 
3264
        else:
 
3265
            if parent:
 
3266
                self.target.set_parent(parent)
 
3267
        if self.source._push_should_merge_tags():
 
3268
            self.source.tags.merge_to(self.target.tags)
 
3269
 
 
3270
    @needs_write_lock
3234
3271
    def update_revisions(self, stop_revision=None, overwrite=False,
3235
3272
        graph=None):
3236
3273
        """See InterBranch.update_revisions()."""
3237
 
        self.source.lock_read()
3238
 
        try:
3239
 
            other_revno, other_last_revision = self.source.last_revision_info()
3240
 
            stop_revno = None # unknown
3241
 
            if stop_revision is None:
3242
 
                stop_revision = other_last_revision
3243
 
                if _mod_revision.is_null(stop_revision):
3244
 
                    # if there are no commits, we're done.
3245
 
                    return
3246
 
                stop_revno = other_revno
3247
 
 
3248
 
            # what's the current last revision, before we fetch [and change it
3249
 
            # possibly]
3250
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3251
 
            # we fetch here so that we don't process data twice in the common
3252
 
            # case of having something to pull, and so that the check for
3253
 
            # already merged can operate on the just fetched graph, which will
3254
 
            # be cached in memory.
3255
 
            self.target.fetch(self.source, stop_revision)
3256
 
            # Check to see if one is an ancestor of the other
3257
 
            if not overwrite:
3258
 
                if graph is None:
3259
 
                    graph = self.target.repository.get_graph()
3260
 
                if self.target._check_if_descendant_or_diverged(
3261
 
                        stop_revision, last_rev, graph, self.source):
3262
 
                    # stop_revision is a descendant of last_rev, but we aren't
3263
 
                    # overwriting, so we're done.
3264
 
                    return
3265
 
            if stop_revno is None:
3266
 
                if graph is None:
3267
 
                    graph = self.target.repository.get_graph()
3268
 
                this_revno, this_last_revision = \
3269
 
                        self.target.last_revision_info()
3270
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3271
 
                                [(other_last_revision, other_revno),
3272
 
                                 (this_last_revision, this_revno)])
3273
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3274
 
        finally:
3275
 
            self.source.unlock()
3276
 
 
 
3274
        other_revno, other_last_revision = self.source.last_revision_info()
 
3275
        stop_revno = None # unknown
 
3276
        if stop_revision is None:
 
3277
            stop_revision = other_last_revision
 
3278
            if _mod_revision.is_null(stop_revision):
 
3279
                # if there are no commits, we're done.
 
3280
                return
 
3281
            stop_revno = other_revno
 
3282
 
 
3283
        # what's the current last revision, before we fetch [and change it
 
3284
        # possibly]
 
3285
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3286
        # we fetch here so that we don't process data twice in the common
 
3287
        # case of having something to pull, and so that the check for
 
3288
        # already merged can operate on the just fetched graph, which will
 
3289
        # be cached in memory.
 
3290
        self.target.fetch(self.source, stop_revision)
 
3291
        # Check to see if one is an ancestor of the other
 
3292
        if not overwrite:
 
3293
            if graph is None:
 
3294
                graph = self.target.repository.get_graph()
 
3295
            if self.target._check_if_descendant_or_diverged(
 
3296
                    stop_revision, last_rev, graph, self.source):
 
3297
                # stop_revision is a descendant of last_rev, but we aren't
 
3298
                # overwriting, so we're done.
 
3299
                return
 
3300
        if stop_revno is None:
 
3301
            if graph is None:
 
3302
                graph = self.target.repository.get_graph()
 
3303
            this_revno, this_last_revision = \
 
3304
                    self.target.last_revision_info()
 
3305
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3306
                            [(other_last_revision, other_revno),
 
3307
                             (this_last_revision, this_revno)])
 
3308
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3309
 
 
3310
    @needs_write_lock
3277
3311
    def pull(self, overwrite=False, stop_revision=None,
3278
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3312
             possible_transports=None, run_hooks=True,
3279
3313
             _override_hook_target=None, local=False):
3280
 
        """See Branch.pull.
 
3314
        """Pull from source into self, updating my master if any.
3281
3315
 
3282
 
        :param _hook_master: Private parameter - set the branch to
3283
 
            be supplied as the master to pull hooks.
3284
3316
        :param run_hooks: Private parameter - if false, this branch
3285
3317
            is being called because it's the master of the primary branch,
3286
3318
            so it should not run its hooks.
3287
 
        :param _override_hook_target: Private parameter - set the branch to be
3288
 
            supplied as the target_branch to pull hooks.
3289
 
        :param local: Only update the local branch, and not the bound branch.
3290
3319
        """
3291
 
        # This type of branch can't be bound.
3292
 
        if local:
 
3320
        bound_location = self.target.get_bound_location()
 
3321
        if local and not bound_location:
3293
3322
            raise errors.LocalRequiresBoundBranch()
3294
 
        result = PullResult()
3295
 
        result.source_branch = self.source
3296
 
        if _override_hook_target is None:
3297
 
            result.target_branch = self.target
3298
 
        else:
3299
 
            result.target_branch = _override_hook_target
3300
 
        self.source.lock_read()
 
3323
        master_branch = None
 
3324
        if not local and bound_location and self.source.user_url != bound_location:
 
3325
            # not pulling from master, so we need to update master.
 
3326
            master_branch = self.target.get_master_branch(possible_transports)
 
3327
            master_branch.lock_write()
3301
3328
        try:
3302
 
            # We assume that during 'pull' the target repository is closer than
3303
 
            # the source one.
3304
 
            self.source.update_references(self.target)
3305
 
            graph = self.target.repository.get_graph(self.source.repository)
3306
 
            # TODO: Branch formats should have a flag that indicates 
3307
 
            # that revno's are expensive, and pull() should honor that flag.
3308
 
            # -- JRV20090506
3309
 
            result.old_revno, result.old_revid = \
3310
 
                self.target.last_revision_info()
3311
 
            self.target.update_revisions(self.source, stop_revision,
3312
 
                overwrite=overwrite, graph=graph)
3313
 
            # TODO: The old revid should be specified when merging tags, 
3314
 
            # so a tags implementation that versions tags can only 
3315
 
            # pull in the most recent changes. -- JRV20090506
3316
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3317
 
                overwrite)
3318
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3319
 
            if _hook_master:
3320
 
                result.master_branch = _hook_master
3321
 
                result.local_branch = result.target_branch
3322
 
            else:
3323
 
                result.master_branch = result.target_branch
3324
 
                result.local_branch = None
3325
 
            if run_hooks:
3326
 
                for hook in Branch.hooks['post_pull']:
3327
 
                    hook(result)
 
3329
            if master_branch:
 
3330
                # pull from source into master.
 
3331
                master_branch.pull(self.source, overwrite, stop_revision,
 
3332
                    run_hooks=False)
 
3333
            return self._pull(overwrite,
 
3334
                stop_revision, _hook_master=master_branch,
 
3335
                run_hooks=run_hooks,
 
3336
                _override_hook_target=_override_hook_target)
3328
3337
        finally:
3329
 
            self.source.unlock()
3330
 
        return result
 
3338
            if master_branch:
 
3339
                master_branch.unlock()
3331
3340
 
3332
3341
    def push(self, overwrite=False, stop_revision=None,
3333
3342
             _override_hook_source_branch=None):
3395
3404
            _run_hooks()
3396
3405
            return result
3397
3406
 
3398
 
    @classmethod
3399
 
    def is_compatible(self, source, target):
3400
 
        # GenericBranch uses the public API, so always compatible
3401
 
        return True
3402
 
 
3403
 
 
3404
 
class InterToBranch5(GenericInterBranch):
3405
 
 
3406
 
    @staticmethod
3407
 
    def _get_branch_formats_to_test():
3408
 
        return BranchFormat._default_format, BzrBranchFormat5()
3409
 
 
3410
 
    def pull(self, overwrite=False, stop_revision=None,
3411
 
             possible_transports=None, run_hooks=True,
 
3407
    def _pull(self, overwrite=False, stop_revision=None,
 
3408
             possible_transports=None, _hook_master=None, run_hooks=True,
3412
3409
             _override_hook_target=None, local=False):
3413
 
        """Pull from source into self, updating my master if any.
3414
 
 
 
3410
        """See Branch.pull.
 
3411
 
 
3412
        This function is the core worker, used by GenericInterBranch.pull to
 
3413
        avoid duplication when pulling source->master and source->local.
 
3414
 
 
3415
        :param _hook_master: Private parameter - set the branch to
 
3416
            be supplied as the master to pull hooks.
3415
3417
        :param run_hooks: Private parameter - if false, this branch
3416
3418
            is being called because it's the master of the primary branch,
3417
3419
            so it should not run its hooks.
 
3420
        :param _override_hook_target: Private parameter - set the branch to be
 
3421
            supplied as the target_branch to pull hooks.
 
3422
        :param local: Only update the local branch, and not the bound branch.
3418
3423
        """
3419
 
        bound_location = self.target.get_bound_location()
3420
 
        if local and not bound_location:
 
3424
        # This type of branch can't be bound.
 
3425
        if local:
3421
3426
            raise errors.LocalRequiresBoundBranch()
3422
 
        master_branch = None
3423
 
        if not local and bound_location and self.source.user_url != bound_location:
3424
 
            # not pulling from master, so we need to update master.
3425
 
            master_branch = self.target.get_master_branch(possible_transports)
3426
 
            master_branch.lock_write()
 
3427
        result = PullResult()
 
3428
        result.source_branch = self.source
 
3429
        if _override_hook_target is None:
 
3430
            result.target_branch = self.target
 
3431
        else:
 
3432
            result.target_branch = _override_hook_target
 
3433
        self.source.lock_read()
3427
3434
        try:
3428
 
            if master_branch:
3429
 
                # pull from source into master.
3430
 
                master_branch.pull(self.source, overwrite, stop_revision,
3431
 
                    run_hooks=False)
3432
 
            return super(InterToBranch5, self).pull(overwrite,
3433
 
                stop_revision, _hook_master=master_branch,
3434
 
                run_hooks=run_hooks,
3435
 
                _override_hook_target=_override_hook_target)
 
3435
            # We assume that during 'pull' the target repository is closer than
 
3436
            # the source one.
 
3437
            self.source.update_references(self.target)
 
3438
            graph = self.target.repository.get_graph(self.source.repository)
 
3439
            # TODO: Branch formats should have a flag that indicates 
 
3440
            # that revno's are expensive, and pull() should honor that flag.
 
3441
            # -- JRV20090506
 
3442
            result.old_revno, result.old_revid = \
 
3443
                self.target.last_revision_info()
 
3444
            self.target.update_revisions(self.source, stop_revision,
 
3445
                overwrite=overwrite, graph=graph)
 
3446
            # TODO: The old revid should be specified when merging tags, 
 
3447
            # so a tags implementation that versions tags can only 
 
3448
            # pull in the most recent changes. -- JRV20090506
 
3449
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3450
                overwrite)
 
3451
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3452
            if _hook_master:
 
3453
                result.master_branch = _hook_master
 
3454
                result.local_branch = result.target_branch
 
3455
            else:
 
3456
                result.master_branch = result.target_branch
 
3457
                result.local_branch = None
 
3458
            if run_hooks:
 
3459
                for hook in Branch.hooks['post_pull']:
 
3460
                    hook(result)
3436
3461
        finally:
3437
 
            if master_branch:
3438
 
                master_branch.unlock()
 
3462
            self.source.unlock()
 
3463
        return result
3439
3464
 
3440
3465
 
3441
3466
InterBranch.register_optimiser(GenericInterBranch)
3442
 
InterBranch.register_optimiser(InterToBranch5)