← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2010-04-10 09:22:04 UTC
  • mto: This revision was merged to the branch mainline in revision 5142.
  • Revision ID: robertc@robertcollins.net-20100410092204-jrdwwf7vtfr0t41k
``bzrlib.mutabletree.MutableTree.commit`` will now support a passed in
config as in previous versions of bzrlib. (Robert Collins)

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):
417
420
            * 'include' - the stop revision is the last item in the result
418
421
            * 'with-merges' - include the stop revision and all of its
419
422
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
423
        :param direction: either 'reverse' or 'forward':
423
424
            * reverse means return the start_revision_id first, i.e.
424
425
              start at the most recent revision and go backwards in history
446
447
        # start_revision_id.
447
448
        if self._merge_sorted_revisions_cache is None:
448
449
            last_revision = self.last_revision()
449
 
            known_graph = self.repository.get_known_graph_ancestry(
450
 
                [last_revision])
 
450
            last_key = (last_revision,)
 
451
            known_graph = self.repository.revisions.get_known_graph_ancestry(
 
452
                [last_key])
451
453
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
452
 
                last_revision)
 
454
                last_key)
453
455
        filtered = self._filter_merge_sorted_revisions(
454
456
            self._merge_sorted_revisions_cache, start_revision_id,
455
457
            stop_revision_id, stop_rule)
456
458
        # Make sure we don't return revisions that are not part of the
457
459
        # start_revision_id ancestry.
458
 
        filtered = self._filter_start_non_ancestors(filtered)
 
460
        filtered = self._filter_non_ancestors(filtered)
459
461
        if direction == 'reverse':
460
462
            return filtered
461
463
        if direction == 'forward':
498
500
                       node.end_of_merge)
499
501
                if rev_id == stop_revision_id:
500
502
                    return
501
 
        elif stop_rule == 'with-merges-without-common-ancestry':
502
 
            # We want to exclude all revisions that are already part of the
503
 
            # stop_revision_id ancestry.
504
 
            graph = self.repository.get_graph()
505
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
 
                                                    [stop_revision_id])
507
 
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
509
 
                if rev_id not in ancestors:
510
 
                    continue
511
 
                yield (rev_id, node.merge_depth, node.revno,
512
 
                       node.end_of_merge)
513
503
        elif stop_rule == 'with-merges':
514
504
            stop_rev = self.repository.get_revision(stop_revision_id)
515
505
            if stop_rev.parent_ids:
538
528
        else:
539
529
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
530
 
541
 
    def _filter_start_non_ancestors(self, rev_iter):
 
531
    def _filter_non_ancestors(self, rev_iter):
542
532
        # If we started from a dotted revno, we want to consider it as a tip
543
533
        # and don't want to yield revisions that are not part of its
544
534
        # ancestry. Given the order guaranteed by the merge sort, we will see
605
595
        :param other: The branch to bind to
606
596
        :type other: Branch
607
597
        """
608
 
        raise errors.UpgradeRequired(self.user_url)
 
598
        raise errors.UpgradeRequired(self.base)
609
599
 
610
600
    def set_append_revisions_only(self, enabled):
611
601
        if not self._format.supports_set_append_revisions_only():
612
 
            raise errors.UpgradeRequired(self.user_url)
 
602
            raise errors.UpgradeRequired(self.base)
613
603
        if enabled:
614
604
            value = 'True'
615
605
        else:
663
653
    def get_old_bound_location(self):
664
654
        """Return the URL of the branch we used to be bound to
665
655
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
656
        raise errors.UpgradeRequired(self.base)
667
657
 
668
658
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
659
                           timezone=None, committer=None, revprops=None,
747
737
            stacking.
748
738
        """
749
739
        if not self._format.supports_stacking():
750
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
740
            raise errors.UnstackableBranchFormat(self._format, self.base)
751
741
        # XXX: Changing from one fallback repository to another does not check
752
742
        # that all the data you need is present in the new fallback.
753
743
        # Possibly it should.
904
894
 
905
895
    def unbind(self):
906
896
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
897
        raise errors.UpgradeRequired(self.base)
908
898
 
909
899
    def last_revision(self):
910
900
        """Return last revision id, or NULL_REVISION."""
1070
1060
        try:
1071
1061
            return urlutils.join(self.base[:-1], parent)
1072
1062
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
1063
            raise errors.InaccessibleParent(parent, self.base)
1074
1064
 
1075
1065
    def _get_parent_location(self):
1076
1066
        raise NotImplementedError(self._get_parent_location)
1554
1544
        """Return the short format description for this format."""
1555
1545
        raise NotImplementedError(self.get_format_description)
1556
1546
 
1557
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
 
        hooks = Branch.hooks['post_branch_init']
1559
 
        if not hooks:
1560
 
            return
1561
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1562
 
        for hook in hooks:
1563
 
            hook(params)
1564
 
 
1565
1547
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
1548
                           lock_type='metadir', set_format=True):
1567
1549
        """Initialize a branch in a bzrdir, with specified files
1575
1557
            elsewhere)
1576
1558
        :return: a branch in this format
1577
1559
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1560
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1579
1561
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1580
1562
        lock_map = {
1581
1563
            'metadir': ('lock', lockdir.LockDir),
1603
1585
        finally:
1604
1586
            if lock_taken:
1605
1587
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
 
1588
        return self.open(a_bzrdir, name, _found=True)
1609
1589
 
1610
1590
    def initialize(self, a_bzrdir, name=None):
1611
1591
        """Create a branch of this format in a_bzrdir.
1771
1751
            "should return a tag name or None if no tag name could be "
1772
1752
            "determined. The first non-None tag name returned will be used.",
1773
1753
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
1775
 
            "Called after new branch initialization completes. "
1776
 
            "post_branch_init is called with a "
1777
 
            "bzrlib.branch.BranchInitHookParams. "
1778
 
            "Note that init, branch and checkout (both heavyweight and "
1779
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1780
 
        self.create_hook(HookPoint('post_switch',
1781
 
            "Called after a checkout switches branch. "
1782
 
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1784
1754
 
1785
1755
 
1786
1756
 
1826
1796
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1797
 
1828
1798
 
1829
 
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
1831
 
 
1832
 
    There are 4 fields that hooks may wish to access:
1833
 
 
1834
 
    :ivar format: the branch format
1835
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
 
    :ivar name: name of colocated branch, if any (or None)
1837
 
    :ivar branch: the branch created
1838
 
 
1839
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
 
    the checkout, hence they are different from the corresponding fields in
1841
 
    branch, which refer to the original branch.
1842
 
    """
1843
 
 
1844
 
    def __init__(self, format, a_bzrdir, name, branch):
1845
 
        """Create a group of BranchInitHook parameters.
1846
 
 
1847
 
        :param format: the branch format
1848
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1849
 
            initialized
1850
 
        :param name: name of colocated branch, if any (or None)
1851
 
        :param branch: the branch created
1852
 
 
1853
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1854
 
        to the checkout, hence they are different from the corresponding fields
1855
 
        in branch, which refer to the original branch.
1856
 
        """
1857
 
        self.format = format
1858
 
        self.bzrdir = a_bzrdir
1859
 
        self.name = name
1860
 
        self.branch = branch
1861
 
 
1862
 
    def __eq__(self, other):
1863
 
        return self.__dict__ == other.__dict__
1864
 
 
1865
 
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
1872
 
 
1873
 
 
1874
 
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
1876
 
 
1877
 
    There are 4 fields that hooks may wish to access:
1878
 
 
1879
 
    :ivar control_dir: BzrDir of the checkout to change
1880
 
    :ivar to_branch: branch that the checkout is to reference
1881
 
    :ivar force: skip the check for local commits in a heavy checkout
1882
 
    :ivar revision_id: revision ID to switch to (or None)
1883
 
    """
1884
 
 
1885
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1886
 
        """Create a group of SwitchHook parameters.
1887
 
 
1888
 
        :param control_dir: BzrDir of the checkout to change
1889
 
        :param to_branch: branch that the checkout is to reference
1890
 
        :param force: skip the check for local commits in a heavy checkout
1891
 
        :param revision_id: revision ID to switch to (or None)
1892
 
        """
1893
 
        self.control_dir = control_dir
1894
 
        self.to_branch = to_branch
1895
 
        self.force = force
1896
 
        self.revision_id = revision_id
1897
 
 
1898
 
    def __eq__(self, other):
1899
 
        return self.__dict__ == other.__dict__
1900
 
 
1901
 
    def __repr__(self):
1902
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
 
            self.control_dir, self.to_branch,
1904
 
            self.revision_id)
1905
 
 
1906
 
 
1907
1799
class BzrBranchFormat4(BranchFormat):
1908
1800
    """Bzr branch format 4.
1909
1801
 
1968
1860
            if format.__class__ != self.__class__:
1969
1861
                raise AssertionError("wrong format %r found for %r" %
1970
1862
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1863
        try:
 
1864
            transport = a_bzrdir.get_branch_transport(None, name=name)
1973
1865
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1866
                                                         lockdir.LockDir)
1975
1867
            return self._branch_class()(_format=self,
2173
2065
            # this format does not implement branch itself, thus the implicit
2174
2066
            # creation contract must see it as uninitializable
2175
2067
            raise errors.UninitializableFormat(self)
2176
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2068
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
2177
2069
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2178
2070
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
2071
            target_branch.bzrdir.root_transport.base)
2180
2072
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
 
2073
        return self.open(
2182
2074
            a_bzrdir, name, _found=True,
2183
2075
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
2076
 
2187
2077
    def __init__(self):
2188
2078
        super(BranchReferenceFormat, self).__init__()
2304
2194
 
2305
2195
    def __str__(self):
2306
2196
        if self.name is None:
2307
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
 
2197
            return '%s(%r)' % (self.__class__.__name__, self.base)
2308
2198
        else:
2309
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2310
 
                self.name)
 
2199
            return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2311
2200
 
2312
2201
    __repr__ = __str__
2313
2202
 
2528
2417
        return result
2529
2418
 
2530
2419
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2420
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2421
 
2533
2422
    def set_push_location(self, location):
2534
2423
        """See Branch.set_push_location."""
2724
2613
        if _mod_revision.is_null(last_revision):
2725
2614
            return
2726
2615
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2616
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2617
 
2729
2618
    def _gen_revision_history(self):
2730
2619
        """Generate the revision history from last revision
2830
2719
        if branch_location is None:
2831
2720
            return Branch.reference_parent(self, file_id, path,
2832
2721
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2722
        branch_location = urlutils.join(self.base, branch_location)
2834
2723
        return Branch.open(branch_location,
2835
2724
                           possible_transports=possible_transports)
2836
2725
 
2882
2771
        return stacked_url
2883
2772
 
2884
2773
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2774
        value = self.get_config().get_user_option('append_revisions_only')
 
2775
        return value == 'True'
2887
2776
 
2888
2777
    @needs_write_lock
2889
2778
    def generate_revision_history(self, revision_id, last_rev=None,
2951
2840
    """
2952
2841
 
2953
2842
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2843
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2844
 
2956
2845
 
2957
2846
######################################################################
3044
2933
        :param verbose: Requests more detailed display of what was checked,
3045
2934
            if any.
3046
2935
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
 
2936
        note('checked branch %s format %s', self.branch.base,
3048
2937
            self.branch._format)
3049
2938
        for error in self.errors:
3050
2939
            note('found error:%s', error)
3379
3268
        if local and not bound_location:
3380
3269
            raise errors.LocalRequiresBoundBranch()
3381
3270
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3271
        if not local and bound_location and self.source.base != bound_location:
3383
3272
            # not pulling from master, so we need to update master.
3384
3273
            master_branch = self.target.get_master_branch(possible_transports)
3385
3274
            master_branch.lock_write()