/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Vincent Ladeuil
  • Date: 2010-04-06 10:12:42 UTC
  • mto: This revision was merged to the branch mainline in revision 5135.
  • Revision ID: v.ladeuil+lp@free.fr-20100406101242-rcg0zelo6y2ca808
Some more cleanup and typos.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
63
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
64
 
65
65
 
66
 
class Branch(bzrdir.ControlComponent):
 
66
# TODO: Maybe include checks for common corruption of newlines, etc?
 
67
 
 
68
# TODO: Some operations like log might retrieve the same revisions
 
69
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
70
# cache in memory to make this faster.  In general anything can be
 
71
# cached in memory between lock and unlock operations. .. nb thats
 
72
# what the transaction identity map provides
 
73
 
 
74
 
 
75
######################################################################
 
76
# branch objects
 
77
 
 
78
class Branch(object):
67
79
    """Branch holding a history of revisions.
68
80
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
81
    base
 
82
        Base directory/url of the branch.
72
83
 
73
84
    hooks: An instance of BranchHooks.
74
85
    """
76
87
    # - RBC 20060112
77
88
    base = None
78
89
 
79
 
    @property
80
 
    def control_transport(self):
81
 
        return self._transport
82
 
 
83
 
    @property
84
 
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
86
 
 
87
90
    def __init__(self, *ignored, **ignored_too):
88
91
        self.tags = self._format.make_tags(self)
89
92
        self._revision_history_cache = None
104
107
        """Activate the branch/repository from url as a fallback repository."""
105
108
        repo = self._get_fallback_repository(url)
106
109
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
110
            raise errors.UnstackableLocationError(self.base, url)
108
111
        self.repository.add_fallback_repository(repo)
109
112
 
110
113
    def break_lock(self):
283
286
        new_history.reverse()
284
287
        return new_history
285
288
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
289
    def lock_write(self):
293
290
        raise NotImplementedError(self.lock_write)
294
291
 
295
292
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
300
 
        """
301
293
        raise NotImplementedError(self.lock_read)
302
294
 
303
295
    def unlock(self):
428
420
            * 'include' - the stop revision is the last item in the result
429
421
            * 'with-merges' - include the stop revision and all of its
430
422
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
423
        :param direction: either 'reverse' or 'forward':
434
424
            * reverse means return the start_revision_id first, i.e.
435
425
              start at the most recent revision and go backwards in history
457
447
        # start_revision_id.
458
448
        if self._merge_sorted_revisions_cache is None:
459
449
            last_revision = self.last_revision()
460
 
            known_graph = self.repository.get_known_graph_ancestry(
461
 
                [last_revision])
 
450
            last_key = (last_revision,)
 
451
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
452
                [last_key])
462
453
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
 
                last_revision)
 
454
                last_key)
464
455
        filtered = self._filter_merge_sorted_revisions(
465
456
            self._merge_sorted_revisions_cache, start_revision_id,
466
457
            stop_revision_id, stop_rule)
467
 
        # Make sure we don't return revisions that are not part of the
468
 
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
470
458
        if direction == 'reverse':
471
459
            return filtered
472
460
        if direction == 'forward':
509
497
                       node.end_of_merge)
510
498
                if rev_id == stop_revision_id:
511
499
                    return
512
 
        elif stop_rule == 'with-merges-without-common-ancestry':
513
 
            # We want to exclude all revisions that are already part of the
514
 
            # stop_revision_id ancestry.
515
 
            graph = self.repository.get_graph()
516
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
517
 
                                                    [stop_revision_id])
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                if rev_id not in ancestors:
521
 
                    continue
522
 
                yield (rev_id, node.merge_depth, node.revno,
523
 
                       node.end_of_merge)
524
500
        elif stop_rule == 'with-merges':
525
501
            stop_rev = self.repository.get_revision(stop_revision_id)
526
502
            if stop_rev.parent_ids:
549
525
        else:
550
526
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
527
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
553
 
        # If we started from a dotted revno, we want to consider it as a tip
554
 
        # and don't want to yield revisions that are not part of its
555
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
556
 
        # uninteresting descendants of the first parent of our tip before the
557
 
        # tip itself.
558
 
        first = rev_iter.next()
559
 
        (rev_id, merge_depth, revno, end_of_merge) = first
560
 
        yield first
561
 
        if not merge_depth:
562
 
            # We start at a mainline revision so by definition, all others
563
 
            # revisions in rev_iter are ancestors
564
 
            for node in rev_iter:
565
 
                yield node
566
 
 
567
 
        clean = False
568
 
        whitelist = set()
569
 
        pmap = self.repository.get_parent_map([rev_id])
570
 
        parents = pmap.get(rev_id, [])
571
 
        if parents:
572
 
            whitelist.update(parents)
573
 
        else:
574
 
            # If there is no parents, there is nothing of interest left
575
 
 
576
 
            # FIXME: It's hard to test this scenario here as this code is never
577
 
            # called in that case. -- vila 20100322
578
 
            return
579
 
 
580
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
 
            if not clean:
582
 
                if rev_id in whitelist:
583
 
                    pmap = self.repository.get_parent_map([rev_id])
584
 
                    parents = pmap.get(rev_id, [])
585
 
                    whitelist.remove(rev_id)
586
 
                    whitelist.update(parents)
587
 
                    if merge_depth == 0:
588
 
                        # We've reached the mainline, there is nothing left to
589
 
                        # filter
590
 
                        clean = True
591
 
                else:
592
 
                    # A revision that is not part of the ancestry of our
593
 
                    # starting revision.
594
 
                    continue
595
 
            yield (rev_id, merge_depth, revno, end_of_merge)
596
 
 
597
528
    def leave_lock_in_place(self):
598
529
        """Tell this branch object not to release the physical lock when this
599
530
        object is unlocked.
616
547
        :param other: The branch to bind to
617
548
        :type other: Branch
618
549
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
 
550
        raise errors.UpgradeRequired(self.base)
620
551
 
621
552
    def set_append_revisions_only(self, enabled):
622
553
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
 
554
            raise errors.UpgradeRequired(self.base)
624
555
        if enabled:
625
556
            value = 'True'
626
557
        else:
674
605
    def get_old_bound_location(self):
675
606
        """Return the URL of the branch we used to be bound to
676
607
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
608
        raise errors.UpgradeRequired(self.base)
678
609
 
679
610
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
611
                           timezone=None, committer=None, revprops=None,
758
689
            stacking.
759
690
        """
760
691
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
692
            raise errors.UnstackableBranchFormat(self._format, self.base)
762
693
        # XXX: Changing from one fallback repository to another does not check
763
694
        # that all the data you need is present in the new fallback.
764
695
        # Possibly it should.
915
846
 
916
847
    def unbind(self):
917
848
        """Older format branches cannot bind or unbind."""
918
 
        raise errors.UpgradeRequired(self.user_url)
 
849
        raise errors.UpgradeRequired(self.base)
919
850
 
920
851
    def last_revision(self):
921
852
        """Return last revision id, or NULL_REVISION."""
1081
1012
        try:
1082
1013
            return urlutils.join(self.base[:-1], parent)
1083
1014
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1015
            raise errors.InaccessibleParent(parent, self.base)
1085
1016
 
1086
1017
    def _get_parent_location(self):
1087
1018
        raise NotImplementedError(self._get_parent_location)
1565
1496
        """Return the short format description for this format."""
1566
1497
        raise NotImplementedError(self.get_format_description)
1567
1498
 
1568
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
 
        hooks = Branch.hooks['post_branch_init']
1570
 
        if not hooks:
1571
 
            return
1572
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1573
 
        for hook in hooks:
1574
 
            hook(params)
1575
 
 
1576
1499
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
1500
                           lock_type='metadir', set_format=True):
1578
1501
        """Initialize a branch in a bzrdir, with specified files
1586
1509
            elsewhere)
1587
1510
        :return: a branch in this format
1588
1511
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1512
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1590
1513
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1591
1514
        lock_map = {
1592
1515
            'metadir': ('lock', lockdir.LockDir),
1614
1537
        finally:
1615
1538
            if lock_taken:
1616
1539
                control_files.unlock()
1617
 
        branch = self.open(a_bzrdir, name, _found=True)
1618
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1619
 
        return branch
 
1540
        return self.open(a_bzrdir, name, _found=True)
1620
1541
 
1621
1542
    def initialize(self, a_bzrdir, name=None):
1622
1543
        """Create a branch of this format in a_bzrdir.
1782
1703
            "should return a tag name or None if no tag name could be "
1783
1704
            "determined. The first non-None tag name returned will be used.",
1784
1705
            (2, 2), None))
1785
 
        self.create_hook(HookPoint('post_branch_init',
1786
 
            "Called after new branch initialization completes. "
1787
 
            "post_branch_init is called with a "
1788
 
            "bzrlib.branch.BranchInitHookParams. "
1789
 
            "Note that init, branch and checkout (both heavyweight and "
1790
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1791
 
        self.create_hook(HookPoint('post_switch',
1792
 
            "Called after a checkout switches branch. "
1793
 
            "post_switch is called with a "
1794
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1795
1706
 
1796
1707
 
1797
1708
 
1837
1748
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1749
 
1839
1750
 
1840
 
class BranchInitHookParams(object):
1841
 
    """Object holding parameters passed to *_branch_init hooks.
1842
 
 
1843
 
    There are 4 fields that hooks may wish to access:
1844
 
 
1845
 
    :ivar format: the branch format
1846
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
 
    :ivar name: name of colocated branch, if any (or None)
1848
 
    :ivar branch: the branch created
1849
 
 
1850
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
 
    the checkout, hence they are different from the corresponding fields in
1852
 
    branch, which refer to the original branch.
1853
 
    """
1854
 
 
1855
 
    def __init__(self, format, a_bzrdir, name, branch):
1856
 
        """Create a group of BranchInitHook parameters.
1857
 
 
1858
 
        :param format: the branch format
1859
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1860
 
            initialized
1861
 
        :param name: name of colocated branch, if any (or None)
1862
 
        :param branch: the branch created
1863
 
 
1864
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1865
 
        to the checkout, hence they are different from the corresponding fields
1866
 
        in branch, which refer to the original branch.
1867
 
        """
1868
 
        self.format = format
1869
 
        self.bzrdir = a_bzrdir
1870
 
        self.name = name
1871
 
        self.branch = branch
1872
 
 
1873
 
    def __eq__(self, other):
1874
 
        return self.__dict__ == other.__dict__
1875
 
 
1876
 
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
1883
 
 
1884
 
 
1885
 
class SwitchHookParams(object):
1886
 
    """Object holding parameters passed to *_switch hooks.
1887
 
 
1888
 
    There are 4 fields that hooks may wish to access:
1889
 
 
1890
 
    :ivar control_dir: BzrDir of the checkout to change
1891
 
    :ivar to_branch: branch that the checkout is to reference
1892
 
    :ivar force: skip the check for local commits in a heavy checkout
1893
 
    :ivar revision_id: revision ID to switch to (or None)
1894
 
    """
1895
 
 
1896
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1897
 
        """Create a group of SwitchHook parameters.
1898
 
 
1899
 
        :param control_dir: BzrDir of the checkout to change
1900
 
        :param to_branch: branch that the checkout is to reference
1901
 
        :param force: skip the check for local commits in a heavy checkout
1902
 
        :param revision_id: revision ID to switch to (or None)
1903
 
        """
1904
 
        self.control_dir = control_dir
1905
 
        self.to_branch = to_branch
1906
 
        self.force = force
1907
 
        self.revision_id = revision_id
1908
 
 
1909
 
    def __eq__(self, other):
1910
 
        return self.__dict__ == other.__dict__
1911
 
 
1912
 
    def __repr__(self):
1913
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
 
            self.control_dir, self.to_branch,
1915
 
            self.revision_id)
1916
 
 
1917
 
 
1918
1751
class BzrBranchFormat4(BranchFormat):
1919
1752
    """Bzr branch format 4.
1920
1753
 
1979
1812
            if format.__class__ != self.__class__:
1980
1813
                raise AssertionError("wrong format %r found for %r" %
1981
1814
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1815
        try:
 
1816
            transport = a_bzrdir.get_branch_transport(None, name=name)
1984
1817
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1818
                                                         lockdir.LockDir)
1986
1819
            return self._branch_class()(_format=self,
2184
2017
            # this format does not implement branch itself, thus the implicit
2185
2018
            # creation contract must see it as uninitializable
2186
2019
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2020
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
2188
2021
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2189
2022
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
2023
            target_branch.bzrdir.root_transport.base)
2191
2024
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
 
2025
        return self.open(
2193
2026
            a_bzrdir, name, _found=True,
2194
2027
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
2028
 
2198
2029
    def __init__(self):
2199
2030
        super(BranchReferenceFormat, self).__init__()
2276
2107
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
2108
 
2278
2109
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
 
2292
2110
class BzrBranch(Branch, _RelockDebugMixin):
2293
2111
    """A branch stored in the actual filesystem.
2294
2112
 
2328
2146
 
2329
2147
    def __str__(self):
2330
2148
        if self.name is None:
2331
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
 
2149
            return '%s(%r)' % (self.__class__.__name__, self.base)
2332
2150
        else:
2333
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2334
 
                self.name)
 
2151
            return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2335
2152
 
2336
2153
    __repr__ = __str__
2337
2154
 
2348
2165
        return self.control_files.is_locked()
2349
2166
 
2350
2167
    def lock_write(self, token=None):
2351
 
        """Lock the branch for write operations.
2352
 
 
2353
 
        :param token: A token to permit reacquiring a previously held and
2354
 
            preserved lock.
2355
 
        :return: A BranchWriteLockResult.
2356
 
        """
2357
2168
        if not self.is_locked():
2358
2169
            self._note_lock('w')
2359
2170
        # All-in-one needs to always unlock/lock.
2365
2176
        else:
2366
2177
            took_lock = False
2367
2178
        try:
2368
 
            return BranchWriteLockResult(self.unlock,
2369
 
                self.control_files.lock_write(token=token))
 
2179
            return self.control_files.lock_write(token=token)
2370
2180
        except:
2371
2181
            if took_lock:
2372
2182
                self.repository.unlock()
2373
2183
            raise
2374
2184
 
2375
2185
    def lock_read(self):
2376
 
        """Lock the branch for read operations.
2377
 
 
2378
 
        :return: An object with an unlock method which will release the lock
2379
 
            obtained.
2380
 
        """
2381
2186
        if not self.is_locked():
2382
2187
            self._note_lock('r')
2383
2188
        # All-in-one needs to always unlock/lock.
2390
2195
            took_lock = False
2391
2196
        try:
2392
2197
            self.control_files.lock_read()
2393
 
            return self
2394
2198
        except:
2395
2199
            if took_lock:
2396
2200
                self.repository.unlock()
2565
2369
        return result
2566
2370
 
2567
2371
    def get_stacked_on_url(self):
2568
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2372
        raise errors.UnstackableBranchFormat(self._format, self.base)
2569
2373
 
2570
2374
    def set_push_location(self, location):
2571
2375
        """See Branch.set_push_location."""
2761
2565
        if _mod_revision.is_null(last_revision):
2762
2566
            return
2763
2567
        if last_revision not in self._lefthand_history(revision_id):
2764
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2568
            raise errors.AppendRevisionsOnlyViolation(self.base)
2765
2569
 
2766
2570
    def _gen_revision_history(self):
2767
2571
        """Generate the revision history from last revision
2867
2671
        if branch_location is None:
2868
2672
            return Branch.reference_parent(self, file_id, path,
2869
2673
                                           possible_transports)
2870
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2674
        branch_location = urlutils.join(self.base, branch_location)
2871
2675
        return Branch.open(branch_location,
2872
2676
                           possible_transports=possible_transports)
2873
2677
 
2919
2723
        return stacked_url
2920
2724
 
2921
2725
    def _get_append_revisions_only(self):
2922
 
        return self.get_config(
2923
 
            ).get_user_option_as_bool('append_revisions_only')
 
2726
        value = self.get_config().get_user_option('append_revisions_only')
 
2727
        return value == 'True'
2924
2728
 
2925
2729
    @needs_write_lock
2926
2730
    def generate_revision_history(self, revision_id, last_rev=None,
2988
2792
    """
2989
2793
 
2990
2794
    def get_stacked_on_url(self):
2991
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2795
        raise errors.UnstackableBranchFormat(self._format, self.base)
2992
2796
 
2993
2797
 
2994
2798
######################################################################
3081
2885
        :param verbose: Requests more detailed display of what was checked,
3082
2886
            if any.
3083
2887
        """
3084
 
        note('checked branch %s format %s', self.branch.user_url,
 
2888
        note('checked branch %s format %s', self.branch.base,
3085
2889
            self.branch._format)
3086
2890
        for error in self.errors:
3087
2891
            note('found error:%s', error)
3416
3220
        if local and not bound_location:
3417
3221
            raise errors.LocalRequiresBoundBranch()
3418
3222
        master_branch = None
3419
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3223
        if not local and bound_location and self.source.base != bound_location:
3420
3224
            # not pulling from master, so we need to update master.
3421
3225
            master_branch = self.target.get_master_branch(possible_transports)
3422
3226
            master_branch.lock_write()