123
129
format, UnknownFormatError or UnsupportedFormatError are raised.
124
130
If there is one, it is returned, along with the unused portion of url.
126
control, relpath = bzrdir.BzrDir.open_containing(url)
132
control, relpath = bzrdir.BzrDir.open_containing(url,
127
134
return control.open_branch(), relpath
130
@deprecated_function(zero_eight)
131
def initialize(base):
132
"""Create a new working tree and branch, rooted at 'base' (url)
134
NOTE: This will soon be deprecated in favour of creation
137
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
139
def setup_caching(self, cache_root):
140
"""Subclasses that care about caching should override this, and set
141
up cached stores located under cache_root.
143
# seems to be unused, 2006-01-13 mbp
144
warn('%s is deprecated' % self.setup_caching)
145
self.cache_root = cache_root
136
def get_config(self):
137
return BranchConfig(self)
147
139
def _get_nick(self):
148
cfg = self.tree_config()
149
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
140
return self.get_config().get_nickname()
151
142
def _set_nick(self, nick):
152
cfg = self.tree_config()
153
cfg.set_option(nick, "nickname")
154
assert cfg.get_option("nickname") == nick
143
self.get_config().set_user_option('nickname', nick, warn_masked=True)
156
145
nick = property(_get_nick, _set_nick)
148
raise NotImplementedError(self.is_locked)
158
150
def lock_write(self):
159
raise NotImplementedError('lock_write is abstract')
151
raise NotImplementedError(self.lock_write)
161
153
def lock_read(self):
162
raise NotImplementedError('lock_read is abstract')
154
raise NotImplementedError(self.lock_read)
164
156
def unlock(self):
165
raise NotImplementedError('unlock is abstract')
157
raise NotImplementedError(self.unlock)
167
159
def peek_lock_mode(self):
168
160
"""Return lock mode for the Branch: 'r', 'w' or None"""
169
161
raise NotImplementedError(self.peek_lock_mode)
163
def get_physical_lock_status(self):
164
raise NotImplementedError(self.get_physical_lock_status)
167
def get_revision_id_to_revno_map(self):
168
"""Return the revision_id => dotted revno map.
170
This will be regenerated on demand, but will be cached.
172
:return: A dictionary mapping revision_id => dotted revno.
173
This dictionary should not be modified by the caller.
175
if self._revision_id_to_revno_cache is not None:
176
mapping = self._revision_id_to_revno_cache
178
mapping = self._gen_revno_map()
179
self._cache_revision_id_to_revno(mapping)
180
# TODO: jam 20070417 Since this is being cached, should we be returning
182
# I would rather not, and instead just declare that users should not
183
# modify the return value.
186
def _gen_revno_map(self):
187
"""Create a new mapping from revision ids to dotted revnos.
189
Dotted revnos are generated based on the current tip in the revision
191
This is the worker function for get_revision_id_to_revno_map, which
192
just caches the return value.
194
:return: A dictionary mapping revision_id => dotted revno.
196
last_revision = self.last_revision()
197
revision_graph = repository._old_get_graph(self.repository,
199
merge_sorted_revisions = tsort.merge_sort(
204
revision_id_to_revno = dict((rev_id, revno)
205
for seq_num, rev_id, depth, revno, end_of_merge
206
in merge_sorted_revisions)
207
return revision_id_to_revno
209
def leave_lock_in_place(self):
210
"""Tell this branch object not to release the physical lock when this
213
If lock_write doesn't return a token, then this method is not supported.
215
self.control_files.leave_in_place()
217
def dont_leave_lock_in_place(self):
218
"""Tell this branch object to release the physical lock when this
219
object is unlocked, even if it didn't originally acquire it.
221
If lock_write doesn't return a token, then this method is not supported.
223
self.control_files.dont_leave_in_place()
225
@deprecated_method(deprecated_in((0, 16, 0)))
171
226
def abspath(self, name):
172
227
"""Return absolute filename for something in the branch
174
229
XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
230
method and not a tree method.
177
raise NotImplementedError('abspath is abstract')
232
raise NotImplementedError(self.abspath)
179
234
def bind(self, other):
180
235
"""Bind the local branch the other branch.
233
def get_master_branch(self):
284
def get_old_bound_location(self):
285
"""Return the URL of the branch we used to be bound to
287
raise errors.UpgradeRequired(self.base)
289
def get_commit_builder(self, parents, config=None, timestamp=None,
290
timezone=None, committer=None, revprops=None,
292
"""Obtain a CommitBuilder for this branch.
294
:param parents: Revision ids of the parents of the new revision.
295
:param config: Optional configuration to use.
296
:param timestamp: Optional timestamp recorded for commit.
297
:param timezone: Optional timezone for timestamp.
298
:param committer: Optional committer to set for commit.
299
:param revprops: Optional dictionary of revision properties.
300
:param revision_id: Optional revision id.
304
config = self.get_config()
306
return self.repository.get_commit_builder(self, parents, config,
307
timestamp, timezone, committer, revprops, revision_id)
309
def get_master_branch(self, possible_transports=None):
234
310
"""Return the branch we are bound to.
236
312
:return: Either a Branch, or None
240
def get_root_id(self):
241
"""Return the id of this branches root"""
242
raise NotImplementedError('get_root_id is abstract')
316
def get_revision_delta(self, revno):
317
"""Return the delta for one revision.
319
The delta is relative to its mainline predecessor, or the
320
empty tree for revision 1.
322
rh = self.revision_history()
323
if not (1 <= revno <= len(rh)):
324
raise errors.InvalidRevisionNumber(revno)
325
return self.repository.get_revision_delta(rh[revno-1])
244
327
def print_file(self, file, revision_id):
245
328
"""Print `file` to stdout."""
246
raise NotImplementedError('print_file is abstract')
248
def append_revision(self, *revision_ids):
249
raise NotImplementedError('append_revision is abstract')
329
raise NotImplementedError(self.print_file)
251
331
def set_revision_history(self, rev_history):
252
raise NotImplementedError('set_revision_history is abstract')
332
raise NotImplementedError(self.set_revision_history)
334
def _cache_revision_history(self, rev_history):
335
"""Set the cached revision history to rev_history.
337
The revision_history method will use this cache to avoid regenerating
338
the revision history.
340
This API is semi-public; it only for use by subclasses, all other code
341
should consider it to be private.
343
self._revision_history_cache = rev_history
345
def _cache_revision_id_to_revno(self, revision_id_to_revno):
346
"""Set the cached revision_id => revno map to revision_id_to_revno.
348
This API is semi-public; it only for use by subclasses, all other code
349
should consider it to be private.
351
self._revision_id_to_revno_cache = revision_id_to_revno
353
def _clear_cached_state(self):
354
"""Clear any cached data on this branch, e.g. cached revision history.
356
This means the next call to revision_history will need to call
357
_gen_revision_history.
359
This API is semi-public; it only for use by subclasses, all other code
360
should consider it to be private.
362
self._revision_history_cache = None
363
self._revision_id_to_revno_cache = None
365
def _gen_revision_history(self):
366
"""Return sequence of revision hashes on to this branch.
368
Unlike revision_history, this method always regenerates or rereads the
369
revision history, i.e. it does not cache the result, so repeated calls
372
Concrete subclasses should override this instead of revision_history so
373
that subclasses do not need to deal with caching logic.
375
This API is semi-public; it only for use by subclasses, all other code
376
should consider it to be private.
378
raise NotImplementedError(self._gen_revision_history)
254
381
def revision_history(self):
255
"""Return sequence of revision hashes on to this branch."""
256
raise NotImplementedError('revision_history is abstract')
382
"""Return sequence of revision ids on this branch.
384
This method will cache the revision history for as long as it is safe to
387
if 'evil' in debug.debug_flags:
388
mutter_callsite(3, "revision_history scales with history.")
389
if self._revision_history_cache is not None:
390
history = self._revision_history_cache
392
history = self._gen_revision_history()
393
self._cache_revision_history(history)
259
397
"""Return current revision number for this branch.
498
641
result.set_parent(self.bzrdir.root_transport.base)
502
def copy_content_into(self, destination, revision_id=None):
503
"""Copy the content of self into destination.
505
revision_id: if not None, the revision history in the new branch will
506
be truncated to end with revision_id.
644
def _synchronize_history(self, destination, revision_id):
645
"""Synchronize last revision and revision history between branches.
647
This version is most efficient when the destination is also a
648
BzrBranch5, but works for BzrBranch6 as long as the revision
649
history is the true lefthand parent history, and all of the revisions
650
are in the destination's repository. If not, set_revision_history
653
:param destination: The branch to copy the history into
654
:param revision_id: The revision-id to truncate history at. May
655
be None to copy complete history.
657
if revision_id == _mod_revision.NULL_REVISION:
508
659
new_history = self.revision_history()
509
if revision_id is not None:
660
if revision_id is not None and new_history != []:
511
662
new_history = new_history[:new_history.index(revision_id) + 1]
512
663
except ValueError:
513
664
rev = self.repository.get_revision(revision_id)
514
665
new_history = rev.get_history(self.repository)[1:]
515
666
destination.set_revision_history(new_history)
516
parent = self.get_parent()
518
destination.set_parent(parent)
669
def copy_content_into(self, destination, revision_id=None):
670
"""Copy the content of self into destination.
672
revision_id: if not None, the revision history in the new branch will
673
be truncated to end with revision_id.
675
self._synchronize_history(destination, revision_id)
677
parent = self.get_parent()
678
except errors.InaccessibleParent, e:
679
mutter('parent was not accessible to copy: %s', e)
682
destination.set_parent(parent)
683
self.tags.merge_to(destination.tags)
687
"""Check consistency of the branch.
689
In particular this checks that revisions given in the revision-history
690
do actually match up in the revision graph, and that they're all
691
present in the repository.
693
Callers will typically also want to check the repository.
695
:return: A BranchCheckResult.
697
mainline_parent_id = None
698
last_revno, last_revision_id = self.last_revision_info()
699
real_rev_history = list(self.repository.iter_reverse_revision_history(
701
real_rev_history.reverse()
702
if len(real_rev_history) != last_revno:
703
raise errors.BzrCheckError('revno does not match len(mainline)'
704
' %s != %s' % (last_revno, len(real_rev_history)))
705
# TODO: We should probably also check that real_rev_history actually
706
# matches self.revision_history()
707
for revision_id in real_rev_history:
709
revision = self.repository.get_revision(revision_id)
710
except errors.NoSuchRevision, e:
711
raise errors.BzrCheckError("mainline revision {%s} not in repository"
713
# In general the first entry on the revision history has no parents.
714
# But it's not illegal for it to have parents listed; this can happen
715
# in imports from Arch when the parents weren't reachable.
716
if mainline_parent_id is not None:
717
if mainline_parent_id not in revision.parent_ids:
718
raise errors.BzrCheckError("previous revision {%s} not listed among "
720
% (mainline_parent_id, revision_id))
721
mainline_parent_id = revision_id
722
return BranchCheckResult(self)
724
def _get_checkout_format(self):
725
"""Return the most suitable metadir for a checkout of this branch.
726
Weaves are used if this branch's repository uses weaves.
728
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
729
from bzrlib.repofmt import weaverepo
730
format = bzrdir.BzrDirMetaFormat1()
731
format.repository_format = weaverepo.RepositoryFormat7()
733
format = self.repository.bzrdir.checkout_metadir()
734
format.set_branch_format(self._format)
737
def create_checkout(self, to_location, revision_id=None,
738
lightweight=False, accelerator_tree=None,
740
"""Create a checkout of a branch.
742
:param to_location: The url to produce the checkout at
743
:param revision_id: The revision to check out
744
:param lightweight: If True, produce a lightweight checkout, otherwise,
745
produce a bound branch (heavyweight checkout)
746
:param accelerator_tree: A tree which can be used for retrieving file
747
contents more quickly than the revision tree, i.e. a workingtree.
748
The revision tree will be used for cases where accelerator_tree's
749
content is different.
750
:param hardlink: If true, hard-link files from accelerator_tree,
752
:return: The tree of the created checkout
754
t = transport.get_transport(to_location)
757
format = self._get_checkout_format()
758
checkout = format.initialize_on_transport(t)
759
from_branch = BranchReferenceFormat().initialize(checkout, self)
761
format = self._get_checkout_format()
762
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
763
to_location, force_new_tree=False, format=format)
764
checkout = checkout_branch.bzrdir
765
checkout_branch.bind(self)
766
# pull up to the specified revision_id to set the initial
767
# branch tip correctly, and seed it with history.
768
checkout_branch.pull(self, stop_revision=revision_id)
770
tree = checkout.create_workingtree(revision_id,
771
from_branch=from_branch,
772
accelerator_tree=accelerator_tree,
774
basis_tree = tree.basis_tree()
775
basis_tree.lock_read()
777
for path, file_id in basis_tree.iter_references():
778
reference_parent = self.reference_parent(file_id, path)
779
reference_parent.create_checkout(tree.abspath(path),
780
basis_tree.get_reference_revision(file_id, path),
787
def reconcile(self, thorough=True):
788
"""Make sure the data stored in this branch is consistent."""
789
from bzrlib.reconcile import BranchReconciler
790
reconciler = BranchReconciler(self, thorough=thorough)
791
reconciler.reconcile()
794
def reference_parent(self, file_id, path):
795
"""Return the parent branch for a tree-reference file_id
796
:param file_id: The file_id of the tree reference
797
:param path: The path of the file_id in the tree
798
:return: A branch associated with the file_id
800
# FIXME should provide multiple branches, based on config
801
return Branch.open(self.bzrdir.root_transport.clone(path).base)
803
def supports_tags(self):
804
return self._format.supports_tags()
521
807
class BranchFormat(object):
549
841
transport = a_bzrdir.get_branch_transport(None)
550
842
format_string = transport.get("format").read()
551
843
return klass._formats[format_string]
553
raise NotBranchError(path=transport.base)
844
except errors.NoSuchFile:
845
raise errors.NotBranchError(path=transport.base)
555
raise errors.UnknownFormatError(format_string)
847
raise errors.UnknownFormatError(format=format_string, kind='branch')
558
850
def get_default_format(klass):
559
851
"""Return the current default format."""
560
852
return klass._default_format
854
def get_reference(self, a_bzrdir):
855
"""Get the target reference of the branch in a_bzrdir.
857
format probing must have been completed before calling
858
this method - it is assumed that the format of the branch
859
in a_bzrdir is correct.
861
:param a_bzrdir: The bzrdir to get the branch data from.
862
:return: None if the branch is not a reference branch.
867
def set_reference(self, a_bzrdir, to_branch):
868
"""Set the target reference of the branch in a_bzrdir.
870
format probing must have been completed before calling
871
this method - it is assumed that the format of the branch
872
in a_bzrdir is correct.
874
:param a_bzrdir: The bzrdir to set the branch reference for.
875
:param to_branch: branch that the checkout is to reference
877
raise NotImplementedError(self.set_reference)
562
879
def get_format_string(self):
563
880
"""Return the ASCII format string that identifies this format."""
564
881
raise NotImplementedError(self.get_format_string)
566
883
def get_format_description(self):
567
884
"""Return the short format description for this format."""
568
raise NotImplementedError(self.get_format_string)
885
raise NotImplementedError(self.get_format_description)
887
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
889
"""Initialize a branch in a bzrdir, with specified files
891
:param a_bzrdir: The bzrdir to initialize the branch in
892
:param utf8_files: The files to create as a list of
893
(filename, content) tuples
894
:param set_format: If True, set the format with
895
self.get_format_string. (BzrBranch4 has its format set
897
:return: a branch in this format
899
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
900
branch_transport = a_bzrdir.get_branch_transport(self)
902
'metadir': ('lock', lockdir.LockDir),
903
'branch4': ('branch-lock', lockable_files.TransportLock),
905
lock_name, lock_class = lock_map[lock_type]
906
control_files = lockable_files.LockableFiles(branch_transport,
907
lock_name, lock_class)
908
control_files.create_lock()
909
control_files.lock_write()
911
utf8_files += [('format', self.get_format_string())]
913
for (filename, content) in utf8_files:
914
branch_transport.put_bytes(
916
mode=control_files._file_mode)
918
control_files.unlock()
919
return self.open(a_bzrdir, _found=True)
570
921
def initialize(self, a_bzrdir):
571
922
"""Create a branch of this format in a_bzrdir."""
572
raise NotImplementedError(self.initialized)
923
raise NotImplementedError(self.initialize)
574
925
def is_supported(self):
575
926
"""Is this format supported?
600
951
def unregister_format(klass, format):
601
assert klass._formats[format.get_format_string()] is format
602
952
del klass._formats[format.get_format_string()]
604
954
def __str__(self):
605
955
return self.get_format_string().rstrip()
957
def supports_tags(self):
958
"""True if this format supports tags stored in the branch"""
959
return False # by default
962
class BranchHooks(Hooks):
963
"""A dictionary mapping hook name to a list of callables for branch hooks.
965
e.g. ['set_rh'] Is the list of items to be called when the
966
set_revision_history function is invoked.
970
"""Create the default hooks.
972
These are all empty initially, because by default nothing should get
976
# Introduced in 0.15:
977
# invoked whenever the revision history has been set
978
# with set_revision_history. The api signature is
979
# (branch, revision_history), and the branch will
982
# invoked after a push operation completes.
983
# the api signature is
985
# containing the members
986
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
987
# where local is the local target branch or None, master is the target
988
# master branch, and the rest should be self explanatory. The source
989
# is read locked and the target branches write locked. Source will
990
# be the local low-latency branch.
991
self['post_push'] = []
992
# invoked after a pull operation completes.
993
# the api signature is
995
# containing the members
996
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
997
# where local is the local branch or None, master is the target
998
# master branch, and the rest should be self explanatory. The source
999
# is read locked and the target branches write locked. The local
1000
# branch is the low-latency branch.
1001
self['post_pull'] = []
1002
# invoked before a commit operation takes place.
1003
# the api signature is
1004
# (local, master, old_revno, old_revid, future_revno, future_revid,
1005
# tree_delta, future_tree).
1006
# old_revid is NULL_REVISION for the first commit to a branch
1007
# tree_delta is a TreeDelta object describing changes from the basis
1008
# revision, hooks MUST NOT modify this delta
1009
# future_tree is an in-memory tree obtained from
1010
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1011
self['pre_commit'] = []
1012
# invoked after a commit operation completes.
1013
# the api signature is
1014
# (local, master, old_revno, old_revid, new_revno, new_revid)
1015
# old_revid is NULL_REVISION for the first commit to a branch.
1016
self['post_commit'] = []
1017
# invoked after a uncommit operation completes.
1018
# the api signature is
1019
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1020
# local is the local branch or None, master is the target branch,
1021
# and an empty branch recieves new_revno of 0, new_revid of None.
1022
self['post_uncommit'] = []
1024
# Invoked after the tip of a branch changes.
1025
# the api signature is
1026
# (params) where params is a ChangeBranchTipParams with the members
1027
# (branch, old_revno, new_revno, old_revid, new_revid)
1028
self['post_change_branch_tip'] = []
1031
# install the default hooks into the Branch class.
1032
Branch.hooks = BranchHooks()
1035
class ChangeBranchTipParams(object):
1036
"""Object holding parameters passed to *_change_branch_tip hooks.
1038
There are 5 fields that hooks may wish to access:
1040
:ivar branch: the branch being changed
1041
:ivar old_revno: revision number before the change
1042
:ivar new_revno: revision number after the change
1043
:ivar old_revid: revision id before the change
1044
:ivar new_revid: revision id after the change
1046
The revid fields are strings. The revno fields are integers.
1049
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1050
"""Create a group of ChangeBranchTip parameters.
1052
:param branch: The branch being changed.
1053
:param old_revno: Revision number before the change.
1054
:param new_revno: Revision number after the change.
1055
:param old_revid: Tip revision id before the change.
1056
:param new_revid: Tip revision id after the change.
1058
self.branch = branch
1059
self.old_revno = old_revno
1060
self.new_revno = new_revno
1061
self.old_revid = old_revid
1062
self.new_revid = new_revid
608
1065
class BzrBranchFormat4(BranchFormat):
609
1066
"""Bzr branch format 4.
805
1313
Note that it's "local" in the context of the filesystem; it doesn't
806
1314
really matter if it's on an nfs/smb/afs/coda/... share, as long as
807
1315
it's writable, and can be accessed via the normal filesystem API.
1317
:ivar _transport: Transport for file operations on this branch's
1318
control files, typically pointing to the .bzr/branch directory.
1319
:ivar repository: Repository for this branch.
1320
:ivar base: The url of the base directory for this branch; the one
1321
containing the .bzr directory.
810
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
811
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1324
def __init__(self, _format=None,
812
1325
_control_files=None, a_bzrdir=None, _repository=None):
813
"""Create new branch object at a particular location.
815
transport -- A Transport object, defining how to access files.
817
init -- If True, create new control files in a previously
818
unversioned directory. If False, the branch must already
821
relax_version_check -- If true, the usual check for the branch
822
version is not applied. This is intended only for
823
upgrade/recovery type use; it's not guaranteed that
824
all operations will work on old format branches.
1326
"""Create new branch object at a particular location."""
1327
Branch.__init__(self)
826
1328
if a_bzrdir is None:
827
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1329
raise ValueError('a_bzrdir must be supplied')
829
1331
self.bzrdir = a_bzrdir
830
self._transport = self.bzrdir.transport.clone('..')
831
self._base = self._transport.base
1332
self._base = self.bzrdir.transport.clone('..').base
1333
# XXX: We should be able to just do
1334
# self.base = self.bzrdir.root_transport.base
1335
# but this does not quite work yet -- mbp 20080522
832
1336
self._format = _format
833
1337
if _control_files is None:
834
raise BzrBadParameterMissing('_control_files')
1338
raise ValueError('BzrBranch _control_files is None')
835
1339
self.control_files = _control_files
836
if deprecated_passed(init):
837
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
838
"deprecated as of bzr 0.8. Please use Branch.create().",
842
# this is slower than before deprecation, oh well never mind.
844
self._initialize(transport.base)
845
self._check_format(_format)
846
if deprecated_passed(relax_version_check):
847
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
848
"relax_version_check parameter is deprecated as of bzr 0.8. "
849
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
853
if (not relax_version_check
854
and not self._format.is_supported()):
855
raise errors.UnsupportedFormatError(
856
'sorry, branch format %r not supported' % fmt,
857
['use a different bzr version',
858
'or remove the .bzr directory'
859
' and "bzr init" again'])
860
if deprecated_passed(transport):
861
warn("BzrBranch.__init__(transport=XXX...): The transport "
862
"parameter is deprecated as of bzr 0.8. "
863
"Please use Branch.open, or bzrdir.open_branch().",
1340
self._transport = _control_files._transport
866
1341
self.repository = _repository
868
1343
def __str__(self):
871
1346
__repr__ = __str__
874
# TODO: It might be best to do this somewhere else,
875
# but it is nice for a Branch object to automatically
876
# cache it's information.
877
# Alternatively, we could have the Transport objects cache requests
878
# See the earlier discussion about how major objects (like Branch)
879
# should never expect their __del__ function to run.
880
# XXX: cache_root seems to be unused, 2006-01-13 mbp
881
if hasattr(self, 'cache_root') and self.cache_root is not None:
883
shutil.rmtree(self.cache_root)
886
self.cache_root = None
888
1348
def _get_base(self):
1349
"""Returns the directory containing the control directory."""
889
1350
return self._base
891
1352
base = property(_get_base, doc="The URL for the root of this branch.")
893
def _finish_transaction(self):
894
"""Exit the current transaction."""
895
return self.control_files._finish_transaction()
897
def get_transaction(self):
898
"""Return the current active transaction.
900
If no transaction is active, this returns a passthrough object
901
for which all data is immediately flushed and no caching happens.
903
# this is an explicit function so that we can do tricky stuff
904
# when the storage in rev_storage is elsewhere.
905
# we probably need to hook the two 'lock a location' and
906
# 'have a transaction' together more delicately, so that
907
# we can have two locks (branch and storage) and one transaction
908
# ... and finishing the transaction unlocks both, but unlocking
909
# does not. - RBC 20051121
910
return self.control_files.get_transaction()
912
def _set_transaction(self, transaction):
913
"""Set a new active transaction."""
914
return self.control_files._set_transaction(transaction)
1354
@deprecated_method(deprecated_in((0, 16, 0)))
916
1355
def abspath(self, name):
917
1356
"""See Branch.abspath."""
918
return self.control_files._transport.abspath(name)
920
def _check_format(self, format):
921
"""Identify the branch format if needed.
923
The format is stored as a reference to the format object in
924
self._format for code that needs to check it later.
926
The format parameter is either None or the branch format class
927
used to open this branch.
929
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
932
format = BzrBranchFormat.find_format(self.bzrdir)
933
self._format = format
934
mutter("got branch format %s", self._format)
937
def get_root_id(self):
938
"""See Branch.get_root_id."""
939
tree = self.repository.revision_tree(self.last_revision())
940
return tree.inventory.root.file_id
942
def lock_write(self):
943
# TODO: test for failed two phase locks. This is known broken.
944
self.control_files.lock_write()
945
self.repository.lock_write()
1357
return self._transport.abspath(name)
1359
def is_locked(self):
1360
return self.control_files.is_locked()
1362
def lock_write(self, token=None):
1363
repo_token = self.repository.lock_write()
1365
token = self.control_files.lock_write(token=token)
1367
self.repository.unlock()
947
1371
def lock_read(self):
948
# TODO: test for failed two phase locks. This is known broken.
949
self.control_files.lock_read()
950
1372
self.repository.lock_read()
1374
self.control_files.lock_read()
1376
self.repository.unlock()
952
1379
def unlock(self):
953
1380
# TODO: test for failed two phase locks. This is known broken.
954
self.repository.unlock()
955
self.control_files.unlock()
1382
self.control_files.unlock()
1384
self.repository.unlock()
1385
if not self.control_files.is_locked():
1386
# we just released the lock
1387
self._clear_cached_state()
957
1389
def peek_lock_mode(self):
958
1390
if self.control_files._lock_count == 0:
961
1393
return self.control_files._lock_mode
1395
def get_physical_lock_status(self):
1396
return self.control_files.get_physical_lock_status()
963
1398
@needs_read_lock
964
1399
def print_file(self, file, revision_id):
965
1400
"""See Branch.print_file."""
966
1401
return self.repository.print_file(file, revision_id)
969
def append_revision(self, *revision_ids):
970
"""See Branch.append_revision."""
971
for revision_id in revision_ids:
972
mutter("add {%s} to revision-history" % revision_id)
973
rev_history = self.revision_history()
974
rev_history.extend(revision_ids)
975
self.set_revision_history(rev_history)
1403
def _write_revision_history(self, history):
1404
"""Factored out of set_revision_history.
1406
This performs the actual writing to disk.
1407
It is intended to be called by BzrBranch5.set_revision_history."""
1408
self._transport.put_bytes(
1409
'revision-history', '\n'.join(history),
1410
mode=self.control_files._file_mode)
977
1412
@needs_write_lock
978
1413
def set_revision_history(self, rev_history):
979
1414
"""See Branch.set_revision_history."""
980
self.control_files.put_utf8(
981
'revision-history', '\n'.join(rev_history))
982
transaction = self.get_transaction()
983
history = transaction.map.find_revision_history()
984
if history is not None:
985
# update the revision history in the identity map.
986
history[:] = list(rev_history)
987
# this call is disabled because revision_history is
988
# not really an object yet, and the transaction is for objects.
989
# transaction.register_dirty(history)
991
transaction.map.add_revision_history(rev_history)
992
# this call is disabled because revision_history is
993
# not really an object yet, and the transaction is for objects.
994
# transaction.register_clean(history)
996
def get_revision_delta(self, revno):
997
"""Return the delta for one revision.
999
The delta is relative to its mainline predecessor, or the
1000
empty tree for revision 1.
1002
assert isinstance(revno, int)
1003
rh = self.revision_history()
1004
if not (1 <= revno <= len(rh)):
1005
raise InvalidRevisionNumber(revno)
1007
# revno is 1-based; list is 0-based
1009
new_tree = self.repository.revision_tree(rh[revno-1])
1011
old_tree = EmptyTree()
1013
old_tree = self.repository.revision_tree(rh[revno-2])
1014
return compare_trees(old_tree, new_tree)
1017
def revision_history(self):
1018
"""See Branch.revision_history."""
1019
transaction = self.get_transaction()
1020
history = transaction.map.find_revision_history()
1021
if history is not None:
1022
mutter("cache hit for revision-history in %s", self)
1023
return list(history)
1024
history = [l.rstrip('\r\n') for l in
1025
self.control_files.get_utf8('revision-history').readlines()]
1026
transaction.map.add_revision_history(history)
1027
# this call is disabled because revision_history is
1028
# not really an object yet, and the transaction is for objects.
1029
# transaction.register_clean(history, precious=True)
1030
return list(history)
1033
def update_revisions(self, other, stop_revision=None):
1415
if 'evil' in debug.debug_flags:
1416
mutter_callsite(3, "set_revision_history scales with history.")
1417
self._write_revision_history(rev_history)
1418
self._clear_cached_state()
1419
self._cache_revision_history(rev_history)
1420
for hook in Branch.hooks['set_rh']:
1421
hook(self, rev_history)
1423
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1424
"""Run the post_change_branch_tip hooks."""
1425
hooks = Branch.hooks['post_change_branch_tip']
1428
new_revno, new_revid = self.last_revision_info()
1429
params = ChangeBranchTipParams(
1430
self, old_revno, new_revno, old_revid, new_revid)
1435
def set_last_revision_info(self, revno, revision_id):
1436
"""Set the last revision of this branch.
1438
The caller is responsible for checking that the revno is correct
1439
for this revision id.
1441
It may be possible to set the branch last revision to an id not
1442
present in the repository. However, branches can also be
1443
configured to check constraints on history, in which case this may not
1446
revision_id = _mod_revision.ensure_null(revision_id)
1447
old_revno, old_revid = self.last_revision_info()
1448
# this old format stores the full history, but this api doesn't
1449
# provide it, so we must generate, and might as well check it's
1451
history = self._lefthand_history(revision_id)
1452
if len(history) != revno:
1453
raise AssertionError('%d != %d' % (len(history), revno))
1454
self.set_revision_history(history)
1455
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1457
def _gen_revision_history(self):
1458
history = self._transport.get_bytes('revision-history').split('\n')
1459
if history[-1:] == ['']:
1460
# There shouldn't be a trailing newline, but just in case.
1464
def _lefthand_history(self, revision_id, last_rev=None,
1466
if 'evil' in debug.debug_flags:
1467
mutter_callsite(4, "_lefthand_history scales with history.")
1468
# stop_revision must be a descendant of last_revision
1469
graph = self.repository.get_graph()
1470
if last_rev is not None:
1471
if not graph.is_ancestor(last_rev, revision_id):
1472
# our previous tip is not merged into stop_revision
1473
raise errors.DivergedBranches(self, other_branch)
1474
# make a new revision history from the graph
1475
parents_map = graph.get_parent_map([revision_id])
1476
if revision_id not in parents_map:
1477
raise errors.NoSuchRevision(self, revision_id)
1478
current_rev_id = revision_id
1480
# Do not include ghosts or graph origin in revision_history
1481
while (current_rev_id in parents_map and
1482
len(parents_map[current_rev_id]) > 0):
1483
new_history.append(current_rev_id)
1484
current_rev_id = parents_map[current_rev_id][0]
1485
parents_map = graph.get_parent_map([current_rev_id])
1486
new_history.reverse()
1490
def generate_revision_history(self, revision_id, last_rev=None,
1492
"""Create a new revision history that will finish with revision_id.
1494
:param revision_id: the new tip to use.
1495
:param last_rev: The previous last_revision. If not None, then this
1496
must be a ancestory of revision_id, or DivergedBranches is raised.
1497
:param other_branch: The other branch that DivergedBranches should
1498
raise with respect to.
1500
self.set_revision_history(self._lefthand_history(revision_id,
1501
last_rev, other_branch))
1504
def update_revisions(self, other, stop_revision=None, overwrite=False):
1034
1505
"""See Branch.update_revisions."""
1035
1506
other.lock_read()
1508
other_last_revno, other_last_revision = other.last_revision_info()
1037
1509
if stop_revision is None:
1038
stop_revision = other.last_revision()
1039
if stop_revision is None:
1510
stop_revision = other_last_revision
1511
if _mod_revision.is_null(stop_revision):
1040
1512
# if there are no commits, we're done.
1042
1514
# whats the current last revision, before we fetch [and change it
1044
last_rev = self.last_revision()
1045
# we fetch here regardless of whether we need to so that we pickup
1516
last_rev = _mod_revision.ensure_null(self.last_revision())
1517
# we fetch here so that we don't process data twice in the common
1518
# case of having something to pull, and so that the check for
1519
# already merged can operate on the just fetched graph, which will
1520
# be cached in memory.
1047
1521
self.fetch(other, stop_revision)
1048
my_ancestry = self.repository.get_ancestry(last_rev)
1049
if stop_revision in my_ancestry:
1050
# last_revision is a descendant of stop_revision
1052
# stop_revision must be a descendant of last_revision
1053
stop_graph = self.repository.get_revision_graph(stop_revision)
1054
if last_rev is not None and last_rev not in stop_graph:
1055
# our previous tip is not merged into stop_revision
1056
raise errors.DivergedBranches(self, other)
1057
# make a new revision history from the graph
1058
current_rev_id = stop_revision
1060
while current_rev_id not in (None, NULL_REVISION):
1061
new_history.append(current_rev_id)
1062
current_rev_id_parents = stop_graph[current_rev_id]
1064
current_rev_id = current_rev_id_parents[0]
1066
current_rev_id = None
1067
new_history.reverse()
1068
self.set_revision_history(new_history)
1522
# Check to see if one is an ancestor of the other
1524
heads = self.repository.get_graph().heads([stop_revision,
1526
if heads == set([last_rev]):
1527
# The current revision is a decendent of the target,
1530
elif heads == set([stop_revision, last_rev]):
1531
# These branches have diverged
1532
raise errors.DivergedBranches(self, other)
1533
elif heads != set([stop_revision]):
1534
raise AssertionError("invalid heads: %r" % heads)
1535
if other_last_revision == stop_revision:
1536
self.set_last_revision_info(other_last_revno,
1537
other_last_revision)
1539
# TODO: jam 2007-11-29 Is there a way to determine the
1540
# revno without searching all of history??
1542
self.generate_revision_history(stop_revision)
1544
self.generate_revision_history(stop_revision,
1545
last_rev=last_rev, other_branch=other)
1072
@deprecated_method(zero_eight)
1073
def pullable_revisions(self, other, stop_revision):
1074
"""Please use bzrlib.missing instead."""
1075
other_revno = other.revision_id_to_revno(stop_revision)
1077
return self.missing_revisions(other, other_revno)
1078
except DivergedBranches, e:
1080
pullable_revs = get_intervening_revisions(self.last_revision(),
1083
assert self.last_revision() not in pullable_revs
1084
return pullable_revs
1085
except bzrlib.errors.NotAncestor:
1086
if is_ancestor(self.last_revision(), stop_revision, self):
1091
1549
def basis_tree(self):
1092
1550
"""See Branch.basis_tree."""
1093
1551
return self.repository.revision_tree(self.last_revision())
1095
@deprecated_method(zero_eight)
1096
def working_tree(self):
1097
"""Create a Working tree object for this branch."""
1098
from bzrlib.workingtree import WorkingTree
1099
from bzrlib.transport.local import LocalTransport
1100
if (self.base.find('://') != -1 or
1101
not isinstance(self._transport, LocalTransport)):
1102
raise NoWorkingTree(self.base)
1103
return self.bzrdir.open_workingtree()
1105
1553
@needs_write_lock
1106
def pull(self, source, overwrite=False, stop_revision=None):
1107
"""See Branch.pull."""
1554
def pull(self, source, overwrite=False, stop_revision=None,
1555
_hook_master=None, run_hooks=True, possible_transports=None):
1558
:param _hook_master: Private parameter - set the branch to
1559
be supplied as the master to push hooks.
1560
:param run_hooks: Private parameter - if false, this branch
1561
is being called because it's the master of the primary branch,
1562
so it should not run its hooks.
1564
result = PullResult()
1565
result.source_branch = source
1566
result.target_branch = self
1108
1567
source.lock_read()
1110
old_count = len(self.revision_history())
1112
self.update_revisions(source,stop_revision)
1113
except DivergedBranches:
1117
self.set_revision_history(source.revision_history())
1118
new_count = len(self.revision_history())
1119
return new_count - old_count
1569
result.old_revno, result.old_revid = self.last_revision_info()
1570
self.update_revisions(source, stop_revision, overwrite=overwrite)
1571
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1572
result.new_revno, result.new_revid = self.last_revision_info()
1574
result.master_branch = _hook_master
1575
result.local_branch = self
1577
result.master_branch = self
1578
result.local_branch = None
1580
for hook in Branch.hooks['post_pull']:
1121
1583
source.unlock()
1123
def get_parent(self):
1124
"""See Branch.get_parent."""
1586
def _get_parent_location(self):
1126
1587
_locs = ['parent', 'pull', 'x-pull']
1127
1588
for l in _locs:
1129
return self.control_files.get_utf8(l).read().strip('\n')
1590
return self._transport.get_bytes(l).strip('\n')
1591
except errors.NoSuchFile:
1134
def get_push_location(self):
1135
"""See Branch.get_push_location."""
1136
config = bzrlib.config.BranchConfig(self)
1137
push_loc = config.get_user_option('push_location')
1596
def push(self, target, overwrite=False, stop_revision=None,
1597
_override_hook_source_branch=None):
1600
This is the basic concrete implementation of push()
1602
:param _override_hook_source_branch: If specified, run
1603
the hooks passing this Branch as the source, rather than self.
1604
This is for use of RemoteBranch, where push is delegated to the
1605
underlying vfs-based Branch.
1607
# TODO: Public option to disable running hooks - should be trivial but
1611
result = self._push_with_bound_branches(target, overwrite,
1613
_override_hook_source_branch=_override_hook_source_branch)
1618
def _push_with_bound_branches(self, target, overwrite,
1620
_override_hook_source_branch=None):
1621
"""Push from self into target, and into target's master if any.
1623
This is on the base BzrBranch class even though it doesn't support
1624
bound branches because the *target* might be bound.
1627
if _override_hook_source_branch:
1628
result.source_branch = _override_hook_source_branch
1629
for hook in Branch.hooks['post_push']:
1632
bound_location = target.get_bound_location()
1633
if bound_location and target.base != bound_location:
1634
# there is a master branch.
1636
# XXX: Why the second check? Is it even supported for a branch to
1637
# be bound to itself? -- mbp 20070507
1638
master_branch = target.get_master_branch()
1639
master_branch.lock_write()
1641
# push into the master from this branch.
1642
self._basic_push(master_branch, overwrite, stop_revision)
1643
# and push into the target branch from this. Note that we push from
1644
# this branch again, because its considered the highest bandwidth
1646
result = self._basic_push(target, overwrite, stop_revision)
1647
result.master_branch = master_branch
1648
result.local_branch = target
1652
master_branch.unlock()
1655
result = self._basic_push(target, overwrite, stop_revision)
1656
# TODO: Why set master_branch and local_branch if there's no
1657
# binding? Maybe cleaner to just leave them unset? -- mbp
1659
result.master_branch = target
1660
result.local_branch = None
1664
def _basic_push(self, target, overwrite, stop_revision):
1665
"""Basic implementation of push without bound branches or hooks.
1667
Must be called with self read locked and target write locked.
1669
result = PushResult()
1670
result.source_branch = self
1671
result.target_branch = target
1672
result.old_revno, result.old_revid = target.last_revision_info()
1673
target.update_revisions(self, stop_revision, overwrite)
1674
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1675
result.new_revno, result.new_revid = target.last_revision_info()
1678
def get_parent(self):
1679
"""See Branch.get_parent."""
1680
parent = self._get_parent_location()
1683
# This is an old-format absolute path to a local branch
1684
# turn it into a url
1685
if parent.startswith('/'):
1686
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1688
return urlutils.join(self.base[:-1], parent)
1689
except errors.InvalidURLJoin, e:
1690
raise errors.InaccessibleParent(parent, self.base)
1140
1692
def set_push_location(self, location):
1141
1693
"""See Branch.set_push_location."""
1142
config = bzrlib.config.LocationConfig(self.base)
1143
config.set_user_option('push_location', location)
1694
self.get_config().set_user_option(
1695
'push_location', location,
1696
store=_mod_config.STORE_LOCATION_NORECURSE)
1145
1698
@needs_write_lock
1146
1699
def set_parent(self, url):
1279
1839
return self.set_bound_location(None)
1281
1841
@needs_write_lock
1842
def update(self, possible_transports=None):
1283
1843
"""Synchronise this branch with the master branch if any.
1285
1845
:return: None or the last_revision that was pivoted out during the
1288
master = self.get_master_branch()
1848
master = self.get_master_branch(possible_transports)
1289
1849
if master is not None:
1290
old_tip = self.last_revision()
1850
old_tip = _mod_revision.ensure_null(self.last_revision())
1291
1851
self.pull(master, overwrite=True)
1292
if old_tip in self.repository.get_ancestry(self.last_revision()):
1852
if self.repository.get_graph().is_ancestor(old_tip,
1853
_mod_revision.ensure_null(self.last_revision())):
1298
class BranchTestProviderAdapter(object):
1299
"""A tool to generate a suite testing multiple branch formats at once.
1301
This is done by copying the test once for each transport and injecting
1302
the transport_server, transport_readonly_server, and branch_format
1303
classes into each copy. Each copy is also given a new id() to make it
1307
def __init__(self, transport_server, transport_readonly_server, formats):
1308
self._transport_server = transport_server
1309
self._transport_readonly_server = transport_readonly_server
1310
self._formats = formats
1312
def adapt(self, test):
1313
result = TestSuite()
1314
for branch_format, bzrdir_format in self._formats:
1315
new_test = deepcopy(test)
1316
new_test.transport_server = self._transport_server
1317
new_test.transport_readonly_server = self._transport_readonly_server
1318
new_test.bzrdir_format = bzrdir_format
1319
new_test.branch_format = branch_format
1320
def make_new_test_id():
1321
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1322
return lambda: new_id
1323
new_test.id = make_new_test_id()
1324
result.addTest(new_test)
1859
class BzrBranch6(BzrBranch5):
1861
def __init__(self, *args, **kwargs):
1862
super(BzrBranch6, self).__init__(*args, **kwargs)
1863
self._last_revision_info_cache = None
1864
self._partial_revision_history_cache = []
1866
def _clear_cached_state(self):
1867
super(BzrBranch6, self)._clear_cached_state()
1868
self._last_revision_info_cache = None
1869
self._partial_revision_history_cache = []
1872
def last_revision_info(self):
1873
"""Return information about the last revision.
1875
:return: A tuple (revno, revision_id).
1877
if self._last_revision_info_cache is None:
1878
self._last_revision_info_cache = self._last_revision_info()
1879
return self._last_revision_info_cache
1881
def _last_revision_info(self):
1882
revision_string = self._transport.get_bytes('last-revision')
1883
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1884
revision_id = cache_utf8.get_cached_utf8(revision_id)
1886
return revno, revision_id
1888
def _write_last_revision_info(self, revno, revision_id):
1889
"""Simply write out the revision id, with no checks.
1891
Use set_last_revision_info to perform this safely.
1893
Does not update the revision_history cache.
1894
Intended to be called by set_last_revision_info and
1895
_write_revision_history.
1897
revision_id = _mod_revision.ensure_null(revision_id)
1898
out_string = '%d %s\n' % (revno, revision_id)
1899
self._transport.put_bytes('last-revision', out_string,
1900
mode=self.control_files._file_mode)
1903
def set_last_revision_info(self, revno, revision_id):
1904
revision_id = _mod_revision.ensure_null(revision_id)
1905
old_revno, old_revid = self.last_revision_info()
1906
if self._get_append_revisions_only():
1907
self._check_history_violation(revision_id)
1908
self._write_last_revision_info(revno, revision_id)
1909
self._clear_cached_state()
1910
self._last_revision_info_cache = revno, revision_id
1911
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1913
def _check_history_violation(self, revision_id):
1914
last_revision = _mod_revision.ensure_null(self.last_revision())
1915
if _mod_revision.is_null(last_revision):
1917
if last_revision not in self._lefthand_history(revision_id):
1918
raise errors.AppendRevisionsOnlyViolation(self.base)
1920
def _gen_revision_history(self):
1921
"""Generate the revision history from last revision
1923
self._extend_partial_history()
1924
return list(reversed(self._partial_revision_history_cache))
1926
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1927
"""Extend the partial history to include a given index
1929
If a stop_index is supplied, stop when that index has been reached.
1930
If a stop_revision is supplied, stop when that revision is
1931
encountered. Otherwise, stop when the beginning of history is
1934
:param stop_index: The index which should be present. When it is
1935
present, history extension will stop.
1936
:param revision_id: The revision id which should be present. When
1937
it is encountered, history extension will stop.
1939
repo = self.repository
1940
if len(self._partial_revision_history_cache) == 0:
1941
iterator = repo.iter_reverse_revision_history(self.last_revision())
1943
start_revision = self._partial_revision_history_cache[-1]
1944
iterator = repo.iter_reverse_revision_history(start_revision)
1945
#skip the last revision in the list
1946
next_revision = iterator.next()
1947
for revision_id in iterator:
1948
self._partial_revision_history_cache.append(revision_id)
1949
if (stop_index is not None and
1950
len(self._partial_revision_history_cache) > stop_index):
1952
if revision_id == stop_revision:
1955
def _write_revision_history(self, history):
1956
"""Factored out of set_revision_history.
1958
This performs the actual writing to disk, with format-specific checks.
1959
It is intended to be called by BzrBranch5.set_revision_history.
1961
if len(history) == 0:
1962
last_revision = 'null:'
1964
if history != self._lefthand_history(history[-1]):
1965
raise errors.NotLefthandHistory(history)
1966
last_revision = history[-1]
1967
if self._get_append_revisions_only():
1968
self._check_history_violation(last_revision)
1969
self._write_last_revision_info(len(history), last_revision)
1972
def _set_parent_location(self, url):
1973
"""Set the parent branch"""
1974
self._set_config_location('parent_location', url, make_relative=True)
1977
def _get_parent_location(self):
1978
"""Set the parent branch"""
1979
return self._get_config_location('parent_location')
1981
def set_push_location(self, location):
1982
"""See Branch.set_push_location."""
1983
self._set_config_location('push_location', location)
1985
def set_bound_location(self, location):
1986
"""See Branch.set_push_location."""
1988
config = self.get_config()
1989
if location is None:
1990
if config.get_user_option('bound') != 'True':
1993
config.set_user_option('bound', 'False', warn_masked=True)
1996
self._set_config_location('bound_location', location,
1998
config.set_user_option('bound', 'True', warn_masked=True)
2001
def _get_bound_location(self, bound):
2002
"""Return the bound location in the config file.
2004
Return None if the bound parameter does not match"""
2005
config = self.get_config()
2006
config_bound = (config.get_user_option('bound') == 'True')
2007
if config_bound != bound:
2009
return self._get_config_location('bound_location', config=config)
2011
def get_bound_location(self):
2012
"""See Branch.set_push_location."""
2013
return self._get_bound_location(True)
2015
def get_old_bound_location(self):
2016
"""See Branch.get_old_bound_location"""
2017
return self._get_bound_location(False)
2019
def set_append_revisions_only(self, enabled):
2024
self.get_config().set_user_option('append_revisions_only', value,
2027
def _get_append_revisions_only(self):
2028
value = self.get_config().get_user_option('append_revisions_only')
2029
return value == 'True'
2031
def _synchronize_history(self, destination, revision_id):
2032
"""Synchronize last revision and revision history between branches.
2034
This version is most efficient when the destination is also a
2035
BzrBranch6, but works for BzrBranch5, as long as the destination's
2036
repository contains all the lefthand ancestors of the intended
2037
last_revision. If not, set_last_revision_info will fail.
2039
:param destination: The branch to copy the history into
2040
:param revision_id: The revision-id to truncate history at. May
2041
be None to copy complete history.
2043
source_revno, source_revision_id = self.last_revision_info()
2044
if revision_id is None:
2045
revno, revision_id = source_revno, source_revision_id
2046
elif source_revision_id == revision_id:
2047
# we know the revno without needing to walk all of history
2048
revno = source_revno
2050
# To figure out the revno for a random revision, we need to build
2051
# the revision history, and count its length.
2052
# We don't care about the order, just how long it is.
2053
# Alternatively, we could start at the current location, and count
2054
# backwards. But there is no guarantee that we will find it since
2055
# it may be a merged revision.
2056
revno = len(list(self.repository.iter_reverse_revision_history(
2058
destination.set_last_revision_info(revno, revision_id)
2060
def _make_tags(self):
2061
return BasicTags(self)
2064
def generate_revision_history(self, revision_id, last_rev=None,
2066
"""See BzrBranch5.generate_revision_history"""
2067
history = self._lefthand_history(revision_id, last_rev, other_branch)
2068
revno = len(history)
2069
self.set_last_revision_info(revno, revision_id)
2072
def get_rev_id(self, revno, history=None):
2073
"""Find the revision id of the specified revno."""
2075
return _mod_revision.NULL_REVISION
2077
last_revno, last_revision_id = self.last_revision_info()
2078
if revno <= 0 or revno > last_revno:
2079
raise errors.NoSuchRevision(self, revno)
2081
if history is not None:
2082
return history[revno - 1]
2084
index = last_revno - revno
2085
if len(self._partial_revision_history_cache) <= index:
2086
self._extend_partial_history(stop_index=index)
2087
if len(self._partial_revision_history_cache) > index:
2088
return self._partial_revision_history_cache[index]
2090
raise errors.NoSuchRevision(self, revno)
2093
def revision_id_to_revno(self, revision_id):
2094
"""Given a revision id, return its revno"""
2095
if _mod_revision.is_null(revision_id):
2098
index = self._partial_revision_history_cache.index(revision_id)
2100
self._extend_partial_history(stop_revision=revision_id)
2101
index = len(self._partial_revision_history_cache) - 1
2102
if self._partial_revision_history_cache[index] != revision_id:
2103
raise errors.NoSuchRevision(self, revision_id)
2104
return self.revno() - index
1328
2107
######################################################################
1332
@deprecated_function(zero_eight)
1333
def ScratchBranch(*args, **kwargs):
1334
"""See bzrlib.bzrdir.ScratchDir."""
1335
d = ScratchDir(*args, **kwargs)
1336
return d.open_branch()
1339
@deprecated_function(zero_eight)
1340
def is_control_file(*args, **kwargs):
1341
"""See bzrlib.workingtree.is_control_file."""
1342
return bzrlib.workingtree.is_control_file(*args, **kwargs)
2108
# results of operations
2111
class _Result(object):
2113
def _show_tag_conficts(self, to_file):
2114
if not getattr(self, 'tag_conflicts', None):
2116
to_file.write('Conflicting tags:\n')
2117
for name, value1, value2 in self.tag_conflicts:
2118
to_file.write(' %s\n' % (name, ))
2121
class PullResult(_Result):
2122
"""Result of a Branch.pull operation.
2124
:ivar old_revno: Revision number before pull.
2125
:ivar new_revno: Revision number after pull.
2126
:ivar old_revid: Tip revision id before pull.
2127
:ivar new_revid: Tip revision id after pull.
2128
:ivar source_branch: Source (local) branch object.
2129
:ivar master_branch: Master branch of the target, or None.
2130
:ivar target_branch: Target/destination branch object.
2134
# DEPRECATED: pull used to return the change in revno
2135
return self.new_revno - self.old_revno
2137
def report(self, to_file):
2139
if self.old_revid == self.new_revid:
2140
to_file.write('No revisions to pull.\n')
2142
to_file.write('Now on revision %d.\n' % self.new_revno)
2143
self._show_tag_conficts(to_file)
2146
class PushResult(_Result):
2147
"""Result of a Branch.push operation.
2149
:ivar old_revno: Revision number before push.
2150
:ivar new_revno: Revision number after push.
2151
:ivar old_revid: Tip revision id before push.
2152
:ivar new_revid: Tip revision id after push.
2153
:ivar source_branch: Source branch object.
2154
:ivar master_branch: Master branch of the target, or None.
2155
:ivar target_branch: Target/destination branch object.
2159
# DEPRECATED: push used to return the change in revno
2160
return self.new_revno - self.old_revno
2162
def report(self, to_file):
2163
"""Write a human-readable description of the result."""
2164
if self.old_revid == self.new_revid:
2165
to_file.write('No new revisions to push.\n')
2167
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2168
self._show_tag_conficts(to_file)
2171
class BranchCheckResult(object):
2172
"""Results of checking branch consistency.
2177
def __init__(self, branch):
2178
self.branch = branch
2180
def report_results(self, verbose):
2181
"""Report the check results via trace.note.
2183
:param verbose: Requests more detailed display of what was checked,
2186
note('checked branch %s format %s',
2188
self.branch._format)
2191
class Converter5to6(object):
2192
"""Perform an in-place upgrade of format 5 to format 6"""
2194
def convert(self, branch):
2195
# Data for 5 and 6 can peacefully coexist.
2196
format = BzrBranchFormat6()
2197
new_branch = format.open(branch.bzrdir, _found=True)
2199
# Copy source data into target
2200
new_branch._write_last_revision_info(*branch.last_revision_info())
2201
new_branch.set_parent(branch.get_parent())
2202
new_branch.set_bound_location(branch.get_bound_location())
2203
new_branch.set_push_location(branch.get_push_location())
2205
# New branch has no tags by default
2206
new_branch.tags._set_tag_dict({})
2208
# Copying done; now update target format
2209
new_branch._transport.put_bytes('format',
2210
format.get_format_string(),
2211
mode=new_branch.control_files._file_mode)
2213
# Clean up old files
2214
new_branch._transport.delete('revision-history')
2216
branch.set_parent(None)
2217
except errors.NoSuchFile:
2219
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
