118
102
if master is not None:
119
103
master.break_lock()
121
def _check_stackable_repo(self):
122
if not self.repository._format.supports_external_lookups:
123
raise errors.UnstackableRepositoryFormat(self.repository._format,
124
self.repository.base)
127
def open(base, _unsupported=False, possible_transports=None):
106
@deprecated_method(zero_eight)
107
def open_downlevel(base):
108
"""Open a branch which may be of an old format."""
109
return Branch.open(base, _unsupported=True)
112
def open(base, _unsupported=False):
128
113
"""Open the branch rooted at base.
130
115
For instance, if the branch is at URL/.bzr/branch,
131
116
Branch.open(URL) -> a Branch instance.
133
control = bzrdir.BzrDir.open(base, _unsupported,
134
possible_transports=possible_transports)
135
return control.open_branch(_unsupported)
138
def open_from_transport(transport, _unsupported=False):
139
"""Open the branch rooted at transport"""
140
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
141
return control.open_branch(_unsupported)
144
def open_containing(url, possible_transports=None):
118
control = bzrdir.BzrDir.open(base, _unsupported)
119
return control.open_branch(_unsupported)
122
def open_containing(url):
145
123
"""Open an existing branch which contains url.
147
125
This probes for a branch at url, and searches upwards from there.
149
127
Basically we keep looking up until we find the control directory or
150
128
run into the root. If there isn't one, raises NotBranchError.
151
If there is one and it is either an unrecognised format or an unsupported
129
If there is one and it is either an unrecognised format or an unsupported
152
130
format, UnknownFormatError or UnsupportedFormatError are raised.
153
131
If there is one, it is returned, along with the unused portion of url.
155
control, relpath = bzrdir.BzrDir.open_containing(url,
133
control, relpath = bzrdir.BzrDir.open_containing(url)
157
134
return control.open_branch(), relpath
159
def _push_should_merge_tags(self):
160
"""Should _basic_push merge this branch's tags into the target?
162
The default implementation returns False if this branch has no tags,
163
and True the rest of the time. Subclasses may override this.
165
return self.supports_tags() and self.tags.get_tag_dict()
137
@deprecated_function(zero_eight)
138
def initialize(base):
139
"""Create a new working tree and branch, rooted at 'base' (url)
141
NOTE: This will soon be deprecated in favour of creation
144
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
146
@deprecated_function(zero_eight)
147
def setup_caching(self, cache_root):
148
"""Subclasses that care about caching should override this, and set
149
up cached stores located under cache_root.
151
NOTE: This is unused.
167
155
def get_config(self):
168
156
return BranchConfig(self)
170
def _get_config(self):
171
"""Get the concrete config for just the config in this branch.
173
This is not intended for client use; see Branch.get_config for the
178
:return: An object supporting get_option and set_option.
180
raise NotImplementedError(self._get_config)
182
def _get_fallback_repository(self, url):
183
"""Get the repository we fallback to at url."""
184
url = urlutils.join(self.base, url)
185
a_bzrdir = bzrdir.BzrDir.open(url,
186
possible_transports=[self.bzrdir.root_transport])
187
return a_bzrdir.open_branch().repository
189
def _get_tags_bytes(self):
190
"""Get the bytes of a serialised tags dict.
192
Note that not all branches support tags, nor do all use the same tags
193
logic: this method is specific to BasicTags. Other tag implementations
194
may use the same method name and behave differently, safely, because
195
of the double-dispatch via
196
format.make_tags->tags_instance->get_tags_dict.
198
:return: The bytes of the tags file.
199
:seealso: Branch._set_tags_bytes.
201
return self._transport.get_bytes('tags')
203
def _get_nick(self, local=False, possible_transports=None):
204
config = self.get_config()
205
# explicit overrides master, but don't look for master if local is True
206
if not local and not config.has_explicit_nickname():
208
master = self.get_master_branch(possible_transports)
209
if master is not None:
210
# return the master branch value
212
except errors.BzrError, e:
213
# Silently fall back to local implicit nick if the master is
215
mutter("Could not connect to bound branch, "
216
"falling back to local nick.\n " + str(e))
217
return config.get_nickname()
159
return self.get_config().get_nickname()
219
161
def _set_nick(self, nick):
220
self.get_config().set_user_option('nickname', nick, warn_masked=True)
162
self.get_config().set_user_option('nickname', nick)
222
164
nick = property(_get_nick, _set_nick)
224
166
def is_locked(self):
225
167
raise NotImplementedError(self.is_locked)
227
def _lefthand_history(self, revision_id, last_rev=None,
229
if 'evil' in debug.debug_flags:
230
mutter_callsite(4, "_lefthand_history scales with history.")
231
# stop_revision must be a descendant of last_revision
232
graph = self.repository.get_graph()
233
if last_rev is not None:
234
if not graph.is_ancestor(last_rev, revision_id):
235
# our previous tip is not merged into stop_revision
236
raise errors.DivergedBranches(self, other_branch)
237
# make a new revision history from the graph
238
parents_map = graph.get_parent_map([revision_id])
239
if revision_id not in parents_map:
240
raise errors.NoSuchRevision(self, revision_id)
241
current_rev_id = revision_id
243
check_not_reserved_id = _mod_revision.check_not_reserved_id
244
# Do not include ghosts or graph origin in revision_history
245
while (current_rev_id in parents_map and
246
len(parents_map[current_rev_id]) > 0):
247
check_not_reserved_id(current_rev_id)
248
new_history.append(current_rev_id)
249
current_rev_id = parents_map[current_rev_id][0]
250
parents_map = graph.get_parent_map([current_rev_id])
251
new_history.reverse()
254
169
def lock_write(self):
255
170
raise NotImplementedError(self.lock_write)
267
182
def get_physical_lock_status(self):
268
183
raise NotImplementedError(self.get_physical_lock_status)
271
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
272
"""Return the revision_id for a dotted revno.
274
:param revno: a tuple like (1,) or (1,1,2)
275
:param _cache_reverse: a private parameter enabling storage
276
of the reverse mapping in a top level cache. (This should
277
only be done in selective circumstances as we want to
278
avoid having the mapping cached multiple times.)
279
:return: the revision_id
280
:raises errors.NoSuchRevision: if the revno doesn't exist
282
rev_id = self._do_dotted_revno_to_revision_id(revno)
284
self._partial_revision_id_to_revno_cache[rev_id] = revno
287
def _do_dotted_revno_to_revision_id(self, revno):
288
"""Worker function for dotted_revno_to_revision_id.
290
Subclasses should override this if they wish to
291
provide a more efficient implementation.
294
return self.get_rev_id(revno[0])
295
revision_id_to_revno = self.get_revision_id_to_revno_map()
296
revision_ids = [revision_id for revision_id, this_revno
297
in revision_id_to_revno.iteritems()
298
if revno == this_revno]
299
if len(revision_ids) == 1:
300
return revision_ids[0]
302
revno_str = '.'.join(map(str, revno))
303
raise errors.NoSuchRevision(self, revno_str)
306
def revision_id_to_dotted_revno(self, revision_id):
307
"""Given a revision id, return its dotted revno.
309
:return: a tuple like (1,) or (400,1,3).
311
return self._do_revision_id_to_dotted_revno(revision_id)
313
def _do_revision_id_to_dotted_revno(self, revision_id):
314
"""Worker function for revision_id_to_revno."""
315
# Try the caches if they are loaded
316
result = self._partial_revision_id_to_revno_cache.get(revision_id)
317
if result is not None:
319
if self._revision_id_to_revno_cache:
320
result = self._revision_id_to_revno_cache.get(revision_id)
322
raise errors.NoSuchRevision(self, revision_id)
323
# Try the mainline as it's optimised
325
revno = self.revision_id_to_revno(revision_id)
327
except errors.NoSuchRevision:
328
# We need to load and use the full revno map after all
329
result = self.get_revision_id_to_revno_map().get(revision_id)
331
raise errors.NoSuchRevision(self, revision_id)
335
def get_revision_id_to_revno_map(self):
336
"""Return the revision_id => dotted revno map.
338
This will be regenerated on demand, but will be cached.
340
:return: A dictionary mapping revision_id => dotted revno.
341
This dictionary should not be modified by the caller.
343
if self._revision_id_to_revno_cache is not None:
344
mapping = self._revision_id_to_revno_cache
346
mapping = self._gen_revno_map()
347
self._cache_revision_id_to_revno(mapping)
348
# TODO: jam 20070417 Since this is being cached, should we be returning
350
# I would rather not, and instead just declare that users should not
351
# modify the return value.
354
def _gen_revno_map(self):
355
"""Create a new mapping from revision ids to dotted revnos.
357
Dotted revnos are generated based on the current tip in the revision
359
This is the worker function for get_revision_id_to_revno_map, which
360
just caches the return value.
362
:return: A dictionary mapping revision_id => dotted revno.
364
revision_id_to_revno = dict((rev_id, revno)
365
for rev_id, depth, revno, end_of_merge
366
in self.iter_merge_sorted_revisions())
367
return revision_id_to_revno
370
def iter_merge_sorted_revisions(self, start_revision_id=None,
371
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
372
"""Walk the revisions for a branch in merge sorted order.
374
Merge sorted order is the output from a merge-aware,
375
topological sort, i.e. all parents come before their
376
children going forward; the opposite for reverse.
378
:param start_revision_id: the revision_id to begin walking from.
379
If None, the branch tip is used.
380
:param stop_revision_id: the revision_id to terminate the walk
381
after. If None, the rest of history is included.
382
:param stop_rule: if stop_revision_id is not None, the precise rule
383
to use for termination:
384
* 'exclude' - leave the stop revision out of the result (default)
385
* 'include' - the stop revision is the last item in the result
386
* 'with-merges' - include the stop revision and all of its
387
merged revisions in the result
388
:param direction: either 'reverse' or 'forward':
389
* reverse means return the start_revision_id first, i.e.
390
start at the most recent revision and go backwards in history
391
* forward returns tuples in the opposite order to reverse.
392
Note in particular that forward does *not* do any intelligent
393
ordering w.r.t. depth as some clients of this API may like.
394
(If required, that ought to be done at higher layers.)
396
:return: an iterator over (revision_id, depth, revno, end_of_merge)
399
* revision_id: the unique id of the revision
400
* depth: How many levels of merging deep this node has been
402
* revno_sequence: This field provides a sequence of
403
revision numbers for all revisions. The format is:
404
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
405
branch that the revno is on. From left to right the REVNO numbers
406
are the sequence numbers within that branch of the revision.
407
* end_of_merge: When True the next node (earlier in history) is
408
part of a different merge.
410
# Note: depth and revno values are in the context of the branch so
411
# we need the full graph to get stable numbers, regardless of the
413
if self._merge_sorted_revisions_cache is None:
414
last_revision = self.last_revision()
415
graph = self.repository.get_graph()
416
parent_map = dict(((key, value) for key, value in
417
graph.iter_ancestry([last_revision]) if value is not None))
418
revision_graph = repository._strip_NULL_ghosts(parent_map)
419
revs = tsort.merge_sort(revision_graph, last_revision, None,
421
# Drop the sequence # before caching
422
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
424
filtered = self._filter_merge_sorted_revisions(
425
self._merge_sorted_revisions_cache, start_revision_id,
426
stop_revision_id, stop_rule)
427
if direction == 'reverse':
429
if direction == 'forward':
430
return reversed(list(filtered))
432
raise ValueError('invalid direction %r' % direction)
434
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
435
start_revision_id, stop_revision_id, stop_rule):
436
"""Iterate over an inclusive range of sorted revisions."""
437
rev_iter = iter(merge_sorted_revisions)
438
if start_revision_id is not None:
439
for rev_id, depth, revno, end_of_merge in rev_iter:
440
if rev_id != start_revision_id:
443
# The decision to include the start or not
444
# depends on the stop_rule if a stop is provided
446
iter([(rev_id, depth, revno, end_of_merge)]),
449
if stop_revision_id is None:
450
for rev_id, depth, revno, end_of_merge in rev_iter:
451
yield rev_id, depth, revno, end_of_merge
452
elif stop_rule == 'exclude':
453
for rev_id, depth, revno, end_of_merge in rev_iter:
454
if rev_id == stop_revision_id:
456
yield rev_id, depth, revno, end_of_merge
457
elif stop_rule == 'include':
458
for rev_id, depth, revno, end_of_merge in rev_iter:
459
yield rev_id, depth, revno, end_of_merge
460
if rev_id == stop_revision_id:
462
elif stop_rule == 'with-merges':
463
stop_rev = self.repository.get_revision(stop_revision_id)
464
if stop_rev.parent_ids:
465
left_parent = stop_rev.parent_ids[0]
467
left_parent = _mod_revision.NULL_REVISION
468
for rev_id, depth, revno, end_of_merge in rev_iter:
469
if rev_id == left_parent:
471
yield rev_id, depth, revno, end_of_merge
473
raise ValueError('invalid stop_rule %r' % stop_rule)
475
def leave_lock_in_place(self):
476
"""Tell this branch object not to release the physical lock when this
479
If lock_write doesn't return a token, then this method is not supported.
481
self.control_files.leave_in_place()
483
def dont_leave_lock_in_place(self):
484
"""Tell this branch object to release the physical lock when this
485
object is unlocked, even if it didn't originally acquire it.
487
If lock_write doesn't return a token, then this method is not supported.
489
self.control_files.dont_leave_in_place()
185
def abspath(self, name):
186
"""Return absolute filename for something in the branch
188
XXX: Robert Collins 20051017 what is this used for? why is it a branch
189
method and not a tree method.
191
raise NotImplementedError(self.abspath)
491
193
def bind(self, other):
492
194
"""Bind the local branch the other branch.
569
277
The delta is relative to its mainline predecessor, or the
570
278
empty tree for revision 1.
280
assert isinstance(revno, int)
572
281
rh = self.revision_history()
573
282
if not (1 <= revno <= len(rh)):
574
raise errors.InvalidRevisionNumber(revno)
283
raise InvalidRevisionNumber(revno)
575
284
return self.repository.get_revision_delta(rh[revno-1])
577
def get_stacked_on_url(self):
578
"""Get the URL this branch is stacked against.
580
:raises NotStacked: If the branch is not stacked.
581
:raises UnstackableBranchFormat: If the branch does not support
584
raise NotImplementedError(self.get_stacked_on_url)
286
def get_root_id(self):
287
"""Return the id of this branches root"""
288
raise NotImplementedError(self.get_root_id)
586
290
def print_file(self, file, revision_id):
587
291
"""Print `file` to stdout."""
588
292
raise NotImplementedError(self.print_file)
294
def append_revision(self, *revision_ids):
295
raise NotImplementedError(self.append_revision)
590
297
def set_revision_history(self, rev_history):
591
298
raise NotImplementedError(self.set_revision_history)
593
def set_stacked_on_url(self, url):
594
"""Set the URL this branch is stacked against.
596
:raises UnstackableBranchFormat: If the branch does not support
598
:raises UnstackableRepositoryFormat: If the repository does not support
601
if not self._format.supports_stacking():
602
raise errors.UnstackableBranchFormat(self._format, self.base)
603
self._check_stackable_repo()
606
old_url = self.get_stacked_on_url()
607
except (errors.NotStacked, errors.UnstackableBranchFormat,
608
errors.UnstackableRepositoryFormat):
611
# repositories don't offer an interface to remove fallback
612
# repositories today; take the conceptually simpler option and just
614
self.repository = self.bzrdir.find_repository()
615
# for every revision reference the branch has, ensure it is pulled
617
source_repository = self._get_fallback_repository(old_url)
618
for revision_id in chain([self.last_revision()],
619
self.tags.get_reverse_tag_dict()):
620
self.repository.fetch(source_repository, revision_id,
623
self._activate_fallback_location(url)
624
# write this out after the repository is stacked to avoid setting a
625
# stacked config that doesn't work.
626
self._set_config_location('stacked_on_location', url)
629
def _set_tags_bytes(self, bytes):
630
"""Mirror method for _get_tags_bytes.
632
:seealso: Branch._get_tags_bytes.
634
return _run_with_write_locked_target(self, self._transport.put_bytes,
637
def _cache_revision_history(self, rev_history):
638
"""Set the cached revision history to rev_history.
640
The revision_history method will use this cache to avoid regenerating
641
the revision history.
643
This API is semi-public; it only for use by subclasses, all other code
644
should consider it to be private.
646
self._revision_history_cache = rev_history
648
def _cache_revision_id_to_revno(self, revision_id_to_revno):
649
"""Set the cached revision_id => revno map to revision_id_to_revno.
651
This API is semi-public; it only for use by subclasses, all other code
652
should consider it to be private.
654
self._revision_id_to_revno_cache = revision_id_to_revno
656
def _clear_cached_state(self):
657
"""Clear any cached data on this branch, e.g. cached revision history.
659
This means the next call to revision_history will need to call
660
_gen_revision_history.
662
This API is semi-public; it only for use by subclasses, all other code
663
should consider it to be private.
665
self._revision_history_cache = None
666
self._revision_id_to_revno_cache = None
667
self._last_revision_info_cache = None
668
self._merge_sorted_revisions_cache = None
670
def _gen_revision_history(self):
671
"""Return sequence of revision hashes on to this branch.
673
Unlike revision_history, this method always regenerates or rereads the
674
revision history, i.e. it does not cache the result, so repeated calls
677
Concrete subclasses should override this instead of revision_history so
678
that subclasses do not need to deal with caching logic.
680
This API is semi-public; it only for use by subclasses, all other code
681
should consider it to be private.
683
raise NotImplementedError(self._gen_revision_history)
686
300
def revision_history(self):
687
"""Return sequence of revision ids on this branch.
689
This method will cache the revision history for as long as it is safe to
692
if 'evil' in debug.debug_flags:
693
mutter_callsite(3, "revision_history scales with history.")
694
if self._revision_history_cache is not None:
695
history = self._revision_history_cache
697
history = self._gen_revision_history()
698
self._cache_revision_history(history)
301
"""Return sequence of revision hashes on to this branch."""
302
raise NotImplementedError(self.revision_history)
702
305
"""Return current revision number for this branch.
750
334
common_index = min(self_len, other_len) -1
751
335
if common_index >= 0 and \
752
336
self_history[common_index] != other_history[common_index]:
753
raise errors.DivergedBranches(self, other)
337
raise DivergedBranches(self, other)
755
339
if stop_revision is None:
756
340
stop_revision = other_len
342
assert isinstance(stop_revision, int)
758
343
if stop_revision > other_len:
759
344
raise errors.NoSuchRevision(self, stop_revision)
760
345
return other_history[self_len:stop_revision]
763
def update_revisions(self, other, stop_revision=None, overwrite=False,
347
def update_revisions(self, other, stop_revision=None):
765
348
"""Pull in new perfect-fit revisions.
767
350
:param other: Another Branch to pull from
768
351
:param stop_revision: Updated until the given revision
769
:param overwrite: Always set the branch pointer, rather than checking
770
to see if it is a proper descendant.
771
:param graph: A Graph object that can be used to query history
772
information. This can be None.
775
return InterBranch.get(other, self).update_revisions(stop_revision,
778
def import_last_revision_info(self, source_repo, revno, revid):
779
"""Set the last revision info, importing from another repo if necessary.
781
This is used by the bound branch code to upload a revision to
782
the master branch first before updating the tip of the local branch.
784
:param source_repo: Source repository to optionally fetch from
785
:param revno: Revision number of the new tip
786
:param revid: Revision id of the new tip
788
if not self.repository.has_same_location(source_repo):
789
self.repository.fetch(source_repo, revision_id=revid)
790
self.set_last_revision_info(revno, revid)
354
raise NotImplementedError(self.update_revisions)
792
356
def revision_id_to_revno(self, revision_id):
793
357
"""Given a revision id, return its revno"""
794
if _mod_revision.is_null(revision_id):
358
if revision_id is None:
796
360
history = self.revision_history()
798
362
return history.index(revision_id) + 1
799
363
except ValueError:
800
raise errors.NoSuchRevision(self, revision_id)
364
raise bzrlib.errors.NoSuchRevision(self, revision_id)
802
366
def get_rev_id(self, revno, history=None):
803
367
"""Find the revision id of the specified revno."""
805
return _mod_revision.NULL_REVISION
806
370
if history is None:
807
371
history = self.revision_history()
808
372
if revno <= 0 or revno > len(history):
809
raise errors.NoSuchRevision(self, revno)
373
raise bzrlib.errors.NoSuchRevision(self, revno)
810
374
return history[revno - 1]
812
def pull(self, source, overwrite=False, stop_revision=None,
813
possible_transports=None, _override_hook_target=None):
814
"""Mirror source into this branch.
816
This branch is considered to be 'local', having low latency.
818
:returns: PullResult instance
376
def pull(self, source, overwrite=False, stop_revision=None):
820
377
raise NotImplementedError(self.pull)
822
def push(self, target, overwrite=False, stop_revision=None):
823
"""Mirror this branch into target.
825
This branch is considered to be 'local', having low latency.
827
raise NotImplementedError(self.push)
829
379
def basis_tree(self):
830
380
"""Return `Tree` object for last revision."""
831
381
return self.repository.revision_tree(self.last_revision())
383
def rename_one(self, from_rel, to_rel):
386
This can change the directory or the filename or both.
388
raise NotImplementedError(self.rename_one)
390
def move(self, from_paths, to_name):
393
to_name must exist as a versioned directory.
395
If to_name exists and is a directory, the files are moved into
396
it, keeping their old names. If it is a directory,
398
Note that to_name is only the last component of the new name;
399
this doesn't change the directory.
401
This returns a list of (from_path, to_path) pairs for each
404
raise NotImplementedError(self.move)
833
406
def get_parent(self):
834
407
"""Return the parent location of the branch.
836
This is the default location for pull/missing. The usual
409
This is the default location for push/pull/missing. The usual
837
410
pattern is that the user can override it by specifying a
840
parent = self._get_parent_location()
843
# This is an old-format absolute path to a local branch
845
if parent.startswith('/'):
846
parent = urlutils.local_path_to_url(parent.decode('utf8'))
848
return urlutils.join(self.base[:-1], parent)
849
except errors.InvalidURLJoin, e:
850
raise errors.InaccessibleParent(parent, self.base)
852
def _get_parent_location(self):
853
raise NotImplementedError(self._get_parent_location)
855
def _set_config_location(self, name, url, config=None,
856
make_relative=False):
858
config = self.get_config()
862
url = urlutils.relative_url(self.base, url)
863
config.set_user_option(name, url, warn_masked=True)
865
def _get_config_location(self, name, config=None):
867
config = self.get_config()
868
location = config.get_user_option(name)
413
raise NotImplementedError(self.get_parent)
873
415
def get_submit_branch(self):
874
416
"""Return the submit location of the branch.
964
458
self.check_real_revno(revno)
966
460
def check_real_revno(self, revno):
968
462
Check whether a revno corresponds to a real revision.
969
463
Zero (the NULL revision) is considered invalid
971
465
if revno < 1 or revno > self.revno():
972
raise errors.InvalidRevisionNumber(revno)
466
raise InvalidRevisionNumber(revno)
975
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
469
def clone(self, *args, **kwargs):
976
470
"""Clone this branch into to_bzrdir preserving all semantic values.
978
Most API users will want 'create_clone_on_transport', which creates a
979
new bzrdir and branch on the fly.
981
472
revision_id: if not None, the revision history in the new branch will
982
473
be truncated to end with revision_id.
984
result = to_bzrdir.create_branch()
985
if repository_policy is not None:
986
repository_policy.configure_branch(result)
475
# for API compatibility, until 0.8 releases we provide the old api:
476
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
477
# after 0.8 releases, the *args and **kwargs should be changed:
478
# def clone(self, to_bzrdir, revision_id=None):
479
if (kwargs.get('to_location', None) or
480
kwargs.get('revision', None) or
481
kwargs.get('basis_branch', None) or
482
(len(args) and isinstance(args[0], basestring))):
483
# backwards compatibility api:
484
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
485
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
488
basis_branch = args[2]
490
basis_branch = kwargs.get('basis_branch', None)
492
basis = basis_branch.bzrdir
497
revision_id = args[1]
499
revision_id = kwargs.get('revision', None)
504
# no default to raise if not provided.
505
url = kwargs.get('to_location')
506
return self.bzrdir.clone(url,
507
revision_id=revision_id,
508
basis=basis).open_branch()
510
# generate args by hand
512
revision_id = args[1]
514
revision_id = kwargs.get('revision_id', None)
518
# no default to raise if not provided.
519
to_bzrdir = kwargs.get('to_bzrdir')
520
result = self._format.initialize(to_bzrdir)
987
521
self.copy_content_into(result, revision_id=revision_id)
991
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
525
def sprout(self, to_bzrdir, revision_id=None):
992
526
"""Create a new line of development from the branch, into to_bzrdir.
994
to_bzrdir controls the branch format.
996
528
revision_id: if not None, the revision history in the new branch will
997
529
be truncated to end with revision_id.
999
result = to_bzrdir.create_branch()
1000
if repository_policy is not None:
1001
repository_policy.configure_branch(result)
531
result = self._format.initialize(to_bzrdir)
1002
532
self.copy_content_into(result, revision_id=revision_id)
1003
533
result.set_parent(self.bzrdir.root_transport.base)
1006
def _synchronize_history(self, destination, revision_id):
1007
"""Synchronize last revision and revision history between branches.
1009
This version is most efficient when the destination is also a
1010
BzrBranch6, but works for BzrBranch5, as long as the destination's
1011
repository contains all the lefthand ancestors of the intended
1012
last_revision. If not, set_last_revision_info will fail.
1014
:param destination: The branch to copy the history into
1015
:param revision_id: The revision-id to truncate history at. May
1016
be None to copy complete history.
1018
source_revno, source_revision_id = self.last_revision_info()
1019
if revision_id is None:
1020
revno, revision_id = source_revno, source_revision_id
1021
elif source_revision_id == revision_id:
1022
# we know the revno without needing to walk all of history
1023
revno = source_revno
1025
# To figure out the revno for a random revision, we need to build
1026
# the revision history, and count its length.
1027
# We don't care about the order, just how long it is.
1028
# Alternatively, we could start at the current location, and count
1029
# backwards. But there is no guarantee that we will find it since
1030
# it may be a merged revision.
1031
revno = len(list(self.repository.iter_reverse_revision_history(
1033
destination.set_last_revision_info(revno, revision_id)
1035
536
@needs_read_lock
1036
537
def copy_content_into(self, destination, revision_id=None):
1037
538
"""Copy the content of self into destination.
1092
589
def _get_checkout_format(self):
1093
590
"""Return the most suitable metadir for a checkout of this branch.
1094
Weaves are used if this branch's repository uses weaves.
591
Weaves are used if this branch's repostory uses weaves.
1096
593
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1097
from bzrlib.repofmt import weaverepo
594
from bzrlib import repository
1098
595
format = bzrdir.BzrDirMetaFormat1()
1099
format.repository_format = weaverepo.RepositoryFormat7()
596
format.repository_format = repository.RepositoryFormat7()
1101
format = self.repository.bzrdir.checkout_metadir()
1102
format.set_branch_format(self._format)
598
format = self.repository.bzrdir.cloning_metadir()
1105
def create_clone_on_transport(self, to_transport, revision_id=None,
1107
"""Create a clone of this branch and its bzrdir.
1109
:param to_transport: The transport to clone onto.
1110
:param revision_id: The revision id to use as tip in the new branch.
1111
If None the tip is obtained from this branch.
1112
:param stacked_on: An optional URL to stack the clone on.
1114
# XXX: Fix the bzrdir API to allow getting the branch back from the
1115
# clone call. Or something. 20090224 RBC/spiv.
1116
dir_to = self.bzrdir.clone_on_transport(to_transport,
1117
revision_id=revision_id, stacked_on=stacked_on)
1118
return dir_to.open_branch()
1120
def create_checkout(self, to_location, revision_id=None,
1121
lightweight=False, accelerator_tree=None,
601
def create_checkout(self, to_location, revision_id=None,
1123
603
"""Create a checkout of a branch.
1125
605
:param to_location: The url to produce the checkout at
1126
606
:param revision_id: The revision to check out
1127
607
:param lightweight: If True, produce a lightweight checkout, otherwise,
1128
608
produce a bound branch (heavyweight checkout)
1129
:param accelerator_tree: A tree which can be used for retrieving file
1130
contents more quickly than the revision tree, i.e. a workingtree.
1131
The revision tree will be used for cases where accelerator_tree's
1132
content is different.
1133
:param hardlink: If true, hard-link files from accelerator_tree,
1135
609
:return: The tree of the created checkout
1137
611
t = transport.get_transport(to_location)
614
except errors.FileExists:
1140
format = self._get_checkout_format()
1141
checkout = format.initialize_on_transport(t)
1142
from_branch = BranchReferenceFormat().initialize(checkout, self)
617
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
618
BranchReferenceFormat().initialize(checkout, self)
1144
620
format = self._get_checkout_format()
1145
621
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1146
622
to_location, force_new_tree=False, format=format)
1147
623
checkout = checkout_branch.bzrdir
1148
624
checkout_branch.bind(self)
1149
# pull up to the specified revision_id to set the initial
625
# pull up to the specified revision_id to set the initial
1150
626
# branch tip correctly, and seed it with history.
1151
627
checkout_branch.pull(self, stop_revision=revision_id)
1153
tree = checkout.create_workingtree(revision_id,
1154
from_branch=from_branch,
1155
accelerator_tree=accelerator_tree,
1157
basis_tree = tree.basis_tree()
1158
basis_tree.lock_read()
1160
for path, file_id in basis_tree.iter_references():
1161
reference_parent = self.reference_parent(file_id, path)
1162
reference_parent.create_checkout(tree.abspath(path),
1163
basis_tree.get_reference_revision(file_id, path),
1170
def reconcile(self, thorough=True):
1171
"""Make sure the data stored in this branch is consistent."""
1172
from bzrlib.reconcile import BranchReconciler
1173
reconciler = BranchReconciler(self, thorough=thorough)
1174
reconciler.reconcile()
1177
def reference_parent(self, file_id, path):
1178
"""Return the parent branch for a tree-reference file_id
1179
:param file_id: The file_id of the tree reference
1180
:param path: The path of the file_id in the tree
1181
:return: A branch associated with the file_id
1183
# FIXME should provide multiple branches, based on config
1184
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1186
def supports_tags(self):
1187
return self._format.supports_tags()
1189
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1191
"""Ensure that revision_b is a descendant of revision_a.
1193
This is a helper function for update_revisions.
1195
:raises: DivergedBranches if revision_b has diverged from revision_a.
1196
:returns: True if revision_b is a descendant of revision_a.
1198
relation = self._revision_relations(revision_a, revision_b, graph)
1199
if relation == 'b_descends_from_a':
1201
elif relation == 'diverged':
1202
raise errors.DivergedBranches(self, other_branch)
1203
elif relation == 'a_descends_from_b':
1206
raise AssertionError("invalid relation: %r" % (relation,))
1208
def _revision_relations(self, revision_a, revision_b, graph):
1209
"""Determine the relationship between two revisions.
1211
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1213
heads = graph.heads([revision_a, revision_b])
1214
if heads == set([revision_b]):
1215
return 'b_descends_from_a'
1216
elif heads == set([revision_a, revision_b]):
1217
# These branches have diverged
1219
elif heads == set([revision_a]):
1220
return 'a_descends_from_b'
1222
raise AssertionError("invalid heads: %r" % (heads,))
628
return checkout.create_workingtree(revision_id)
1225
631
class BranchFormat(object):
1259
659
transport = a_bzrdir.get_branch_transport(None)
1260
660
format_string = transport.get("format").read()
1261
661
return klass._formats[format_string]
1262
except errors.NoSuchFile:
1263
raise errors.NotBranchError(path=transport.base)
663
raise NotBranchError(path=transport.base)
1264
664
except KeyError:
1265
raise errors.UnknownFormatError(format=format_string, kind='branch')
665
raise errors.UnknownFormatError(format=format_string)
1268
668
def get_default_format(klass):
1269
669
"""Return the current default format."""
1270
670
return klass._default_format
1272
def get_reference(self, a_bzrdir):
1273
"""Get the target reference of the branch in a_bzrdir.
1275
format probing must have been completed before calling
1276
this method - it is assumed that the format of the branch
1277
in a_bzrdir is correct.
1279
:param a_bzrdir: The bzrdir to get the branch data from.
1280
:return: None if the branch is not a reference branch.
1285
def set_reference(self, a_bzrdir, to_branch):
1286
"""Set the target reference of the branch in a_bzrdir.
1288
format probing must have been completed before calling
1289
this method - it is assumed that the format of the branch
1290
in a_bzrdir is correct.
1292
:param a_bzrdir: The bzrdir to set the branch reference for.
1293
:param to_branch: branch that the checkout is to reference
1295
raise NotImplementedError(self.set_reference)
1297
672
def get_format_string(self):
1298
673
"""Return the ASCII format string that identifies this format."""
1299
674
raise NotImplementedError(self.get_format_string)
1301
676
def get_format_description(self):
1302
677
"""Return the short format description for this format."""
1303
raise NotImplementedError(self.get_format_description)
1305
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1307
"""Initialize a branch in a bzrdir, with specified files
1309
:param a_bzrdir: The bzrdir to initialize the branch in
1310
:param utf8_files: The files to create as a list of
1311
(filename, content) tuples
1312
:param set_format: If True, set the format with
1313
self.get_format_string. (BzrBranch4 has its format set
1315
:return: a branch in this format
1317
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1318
branch_transport = a_bzrdir.get_branch_transport(self)
1320
'metadir': ('lock', lockdir.LockDir),
1321
'branch4': ('branch-lock', lockable_files.TransportLock),
1323
lock_name, lock_class = lock_map[lock_type]
1324
control_files = lockable_files.LockableFiles(branch_transport,
1325
lock_name, lock_class)
1326
control_files.create_lock()
1327
control_files.lock_write()
1329
utf8_files += [('format', self.get_format_string())]
1331
for (filename, content) in utf8_files:
1332
branch_transport.put_bytes(
1334
mode=a_bzrdir._get_file_mode())
1336
control_files.unlock()
1337
return self.open(a_bzrdir, _found=True)
678
raise NotImplementedError(self.get_format_string)
1339
680
def initialize(self, a_bzrdir):
1340
681
"""Create a branch of this format in a_bzrdir."""
1344
685
"""Is this format supported?
1346
687
Supported formats can be initialized and opened.
1347
Unsupported formats may not support initialization or committing or
688
Unsupported formats may not support initialization or committing or
1348
689
some other features depending on the reason for not being supported.
1352
def make_tags(self, branch):
1353
"""Create a tags object for branch.
1355
This method is on BranchFormat, because BranchFormats are reflected
1356
over the wire via network_name(), whereas full Branch instances require
1357
multiple VFS method calls to operate at all.
1359
The default implementation returns a disabled-tags instance.
1361
Note that it is normal for branch to be a RemoteBranch when using tags
1364
return DisabledTags(branch)
1366
def network_name(self):
1367
"""A simple byte string uniquely identifying this format for RPC calls.
1369
MetaDir branch formats use their disk format string to identify the
1370
repository over the wire. All in one formats such as bzr < 0.8, and
1371
foreign formats like svn/git and hg should use some marker which is
1372
unique and immutable.
1374
raise NotImplementedError(self.network_name)
1376
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
693
def open(self, a_bzrdir, _found=False):
1377
694
"""Return the branch object for a_bzrdir
1379
:param a_bzrdir: A BzrDir that contains a branch.
1380
:param _found: a private parameter, do not use it. It is used to
1381
indicate if format probing has already be done.
1382
:param ignore_fallbacks: when set, no fallback branches will be opened
1383
(if there are any). Default is to open fallbacks.
696
_found is a private parameter, do not use it. It is used to indicate
697
if format probing has already be done.
1385
699
raise NotImplementedError(self.open)
1388
702
def register_format(klass, format):
1389
"""Register a metadir format."""
1390
703
klass._formats[format.get_format_string()] = format
1391
# Metadir formats have a network name of their format string, and get
1392
# registered as class factories.
1393
network_format_registry.register(format.get_format_string(), format.__class__)
1396
706
def set_default_format(klass, format):
1397
707
klass._default_format = format
1399
def supports_stacking(self):
1400
"""True if this format records a stacked-on branch."""
1404
710
def unregister_format(klass, format):
711
assert klass._formats[format.get_format_string()] is format
1405
712
del klass._formats[format.get_format_string()]
1407
714
def __str__(self):
1408
return self.get_format_description().rstrip()
1410
def supports_tags(self):
1411
"""True if this format supports tags stored in the branch"""
1412
return False # by default
1415
class BranchHooks(Hooks):
1416
"""A dictionary mapping hook name to a list of callables for branch hooks.
1418
e.g. ['set_rh'] Is the list of items to be called when the
1419
set_revision_history function is invoked.
1423
"""Create the default hooks.
1425
These are all empty initially, because by default nothing should get
1428
Hooks.__init__(self)
1429
self.create_hook(HookPoint('set_rh',
1430
"Invoked whenever the revision history has been set via "
1431
"set_revision_history. The api signature is (branch, "
1432
"revision_history), and the branch will be write-locked. "
1433
"The set_rh hook can be expensive for bzr to trigger, a better "
1434
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1435
self.create_hook(HookPoint('open',
1436
"Called with the Branch object that has been opened after a "
1437
"branch is opened.", (1, 8), None))
1438
self.create_hook(HookPoint('post_push',
1439
"Called after a push operation completes. post_push is called "
1440
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1441
"bzr client.", (0, 15), None))
1442
self.create_hook(HookPoint('post_pull',
1443
"Called after a pull operation completes. post_pull is called "
1444
"with a bzrlib.branch.PullResult object and only runs in the "
1445
"bzr client.", (0, 15), None))
1446
self.create_hook(HookPoint('pre_commit',
1447
"Called after a commit is calculated but before it is is "
1448
"completed. pre_commit is called with (local, master, old_revno, "
1449
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1450
"). old_revid is NULL_REVISION for the first commit to a branch, "
1451
"tree_delta is a TreeDelta object describing changes from the "
1452
"basis revision. hooks MUST NOT modify this delta. "
1453
" future_tree is an in-memory tree obtained from "
1454
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1455
"tree.", (0,91), None))
1456
self.create_hook(HookPoint('post_commit',
1457
"Called in the bzr client after a commit has completed. "
1458
"post_commit is called with (local, master, old_revno, old_revid, "
1459
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1460
"commit to a branch.", (0, 15), None))
1461
self.create_hook(HookPoint('post_uncommit',
1462
"Called in the bzr client after an uncommit completes. "
1463
"post_uncommit is called with (local, master, old_revno, "
1464
"old_revid, new_revno, new_revid) where local is the local branch "
1465
"or None, master is the target branch, and an empty branch "
1466
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1467
self.create_hook(HookPoint('pre_change_branch_tip',
1468
"Called in bzr client and server before a change to the tip of a "
1469
"branch is made. pre_change_branch_tip is called with a "
1470
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1471
"commit, uncommit will all trigger this hook.", (1, 6), None))
1472
self.create_hook(HookPoint('post_change_branch_tip',
1473
"Called in bzr client and server after a change to the tip of a "
1474
"branch is made. post_change_branch_tip is called with a "
1475
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1476
"commit, uncommit will all trigger this hook.", (1, 4), None))
1477
self.create_hook(HookPoint('transform_fallback_location',
1478
"Called when a stacked branch is activating its fallback "
1479
"locations. transform_fallback_location is called with (branch, "
1480
"url), and should return a new url. Returning the same url "
1481
"allows it to be used as-is, returning a different one can be "
1482
"used to cause the branch to stack on a closer copy of that "
1483
"fallback_location. Note that the branch cannot have history "
1484
"accessing methods called on it during this hook because the "
1485
"fallback locations have not been activated. When there are "
1486
"multiple hooks installed for transform_fallback_location, "
1487
"all are called with the url returned from the previous hook."
1488
"The order is however undefined.", (1, 9), None))
1491
# install the default hooks into the Branch class.
1492
Branch.hooks = BranchHooks()
1495
class ChangeBranchTipParams(object):
1496
"""Object holding parameters passed to *_change_branch_tip hooks.
1498
There are 5 fields that hooks may wish to access:
1500
:ivar branch: the branch being changed
1501
:ivar old_revno: revision number before the change
1502
:ivar new_revno: revision number after the change
1503
:ivar old_revid: revision id before the change
1504
:ivar new_revid: revision id after the change
1506
The revid fields are strings. The revno fields are integers.
1509
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1510
"""Create a group of ChangeBranchTip parameters.
1512
:param branch: The branch being changed.
1513
:param old_revno: Revision number before the change.
1514
:param new_revno: Revision number after the change.
1515
:param old_revid: Tip revision id before the change.
1516
:param new_revid: Tip revision id after the change.
1518
self.branch = branch
1519
self.old_revno = old_revno
1520
self.new_revno = new_revno
1521
self.old_revid = old_revid
1522
self.new_revid = new_revid
1524
def __eq__(self, other):
1525
return self.__dict__ == other.__dict__
1528
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1529
self.__class__.__name__, self.branch,
1530
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
715
return self.get_format_string().rstrip()
1533
718
class BzrBranchFormat4(BranchFormat):
1637
787
def get_format_description(self):
1638
788
"""See BranchFormat.get_format_description()."""
1639
789
return "Branch format 5"
1641
791
def initialize(self, a_bzrdir):
1642
792
"""Create a branch of this format in a_bzrdir."""
793
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
794
branch_transport = a_bzrdir.get_branch_transport(self)
1643
795
utf8_files = [('revision-history', ''),
1644
796
('branch-name', ''),
1646
return self._initialize_helper(a_bzrdir, utf8_files)
1648
def supports_tags(self):
1652
class BzrBranchFormat6(BranchFormatMetadir):
1653
"""Branch format with last-revision and tags.
1655
Unlike previous formats, this has no explicit revision history. Instead,
1656
this just stores the last-revision, and the left-hand history leading
1657
up to there is the history.
1659
This format was introduced in bzr 0.15
1660
and became the default in 0.91.
1663
def _branch_class(self):
1666
def get_format_string(self):
1667
"""See BranchFormat.get_format_string()."""
1668
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1670
def get_format_description(self):
1671
"""See BranchFormat.get_format_description()."""
1672
return "Branch format 6"
1674
def initialize(self, a_bzrdir):
1675
"""Create a branch of this format in a_bzrdir."""
1676
utf8_files = [('last-revision', '0 null:\n'),
1677
('branch.conf', ''),
1680
return self._initialize_helper(a_bzrdir, utf8_files)
1682
def make_tags(self, branch):
1683
"""See bzrlib.branch.BranchFormat.make_tags()."""
1684
return BasicTags(branch)
1688
class BzrBranchFormat7(BranchFormatMetadir):
1689
"""Branch format with last-revision, tags, and a stacked location pointer.
1691
The stacked location pointer is passed down to the repository and requires
1692
a repository format with supports_external_lookups = True.
1694
This format was introduced in bzr 1.6.
1697
def _branch_class(self):
1700
def get_format_string(self):
1701
"""See BranchFormat.get_format_string()."""
1702
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1704
def get_format_description(self):
1705
"""See BranchFormat.get_format_description()."""
1706
return "Branch format 7"
1708
def initialize(self, a_bzrdir):
1709
"""Create a branch of this format in a_bzrdir."""
1710
utf8_files = [('last-revision', '0 null:\n'),
1711
('branch.conf', ''),
1714
return self._initialize_helper(a_bzrdir, utf8_files)
798
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
800
control_files.create_lock()
801
control_files.lock_write()
802
control_files.put_utf8('format', self.get_format_string())
804
for file, content in utf8_files:
805
control_files.put_utf8(file, content)
807
control_files.unlock()
808
return self.open(a_bzrdir, _found=True, )
1716
810
def __init__(self):
1717
super(BzrBranchFormat7, self).__init__()
1718
self._matchingbzrdir.repository_format = \
1719
RepositoryFormatKnitPack5RichRoot()
1721
def make_tags(self, branch):
1722
"""See bzrlib.branch.BranchFormat.make_tags()."""
1723
return BasicTags(branch)
1725
def supports_stacking(self):
811
super(BzrBranchFormat5, self).__init__()
812
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
814
def open(self, a_bzrdir, _found=False):
815
"""Return the branch object for a_bzrdir
817
_found is a private parameter, do not use it. It is used to indicate
818
if format probing has already be done.
821
format = BranchFormat.find_format(a_bzrdir)
822
assert format.__class__ == self.__class__
823
transport = a_bzrdir.get_branch_transport(None)
824
control_files = lockable_files.LockableFiles(transport, 'lock',
826
return BzrBranch5(_format=self,
827
_control_files=control_files,
829
_repository=a_bzrdir.find_repository())
832
return "Bazaar-NG Metadir branch format 5"
1729
835
class BranchReferenceFormat(BranchFormat):
1853
917
Note that it's "local" in the context of the filesystem; it doesn't
1854
918
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1855
919
it's writable, and can be accessed via the normal filesystem API.
1857
:ivar _transport: Transport for file operations on this branch's
1858
control files, typically pointing to the .bzr/branch directory.
1859
:ivar repository: Repository for this branch.
1860
:ivar base: The url of the base directory for this branch; the one
1861
containing the .bzr directory.
1864
def __init__(self, _format=None,
1865
_control_files=None, a_bzrdir=None, _repository=None,
1866
ignore_fallbacks=False):
1867
"""Create new branch object at a particular location."""
922
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
923
relax_version_check=DEPRECATED_PARAMETER, _format=None,
924
_control_files=None, a_bzrdir=None, _repository=None):
925
"""Create new branch object at a particular location.
927
transport -- A Transport object, defining how to access files.
929
init -- If True, create new control files in a previously
930
unversioned directory. If False, the branch must already
933
relax_version_check -- If true, the usual check for the branch
934
version is not applied. This is intended only for
935
upgrade/recovery type use; it's not guaranteed that
936
all operations will work on old format branches.
1868
938
if a_bzrdir is None:
1869
raise ValueError('a_bzrdir must be supplied')
939
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1871
941
self.bzrdir = a_bzrdir
1872
self._base = self.bzrdir.transport.clone('..').base
1873
# XXX: We should be able to just do
1874
# self.base = self.bzrdir.root_transport.base
1875
# but this does not quite work yet -- mbp 20080522
942
self._transport = self.bzrdir.transport.clone('..')
943
self._base = self._transport.base
1876
944
self._format = _format
1877
945
if _control_files is None:
1878
946
raise ValueError('BzrBranch _control_files is None')
1879
947
self.control_files = _control_files
1880
self._transport = _control_files._transport
948
if deprecated_passed(init):
949
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
950
"deprecated as of bzr 0.8. Please use Branch.create().",
954
# this is slower than before deprecation, oh well never mind.
956
self._initialize(transport.base)
957
self._check_format(_format)
958
if deprecated_passed(relax_version_check):
959
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
960
"relax_version_check parameter is deprecated as of bzr 0.8. "
961
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
965
if (not relax_version_check
966
and not self._format.is_supported()):
967
raise errors.UnsupportedFormatError(format=fmt)
968
if deprecated_passed(transport):
969
warn("BzrBranch.__init__(transport=XXX...): The transport "
970
"parameter is deprecated as of bzr 0.8. "
971
"Please use Branch.open, or bzrdir.open_branch().",
1881
974
self.repository = _repository
1882
Branch.__init__(self)
1884
976
def __str__(self):
1885
977
return '%s(%r)' % (self.__class__.__name__, self.base)
1939
1072
"""See Branch.print_file."""
1940
1073
return self.repository.print_file(file, revision_id)
1942
def _write_revision_history(self, history):
1943
"""Factored out of set_revision_history.
1945
This performs the actual writing to disk.
1946
It is intended to be called by BzrBranch5.set_revision_history."""
1947
self._transport.put_bytes(
1948
'revision-history', '\n'.join(history),
1949
mode=self.bzrdir._get_file_mode())
1076
def append_revision(self, *revision_ids):
1077
"""See Branch.append_revision."""
1078
for revision_id in revision_ids:
1079
mutter("add {%s} to revision-history" % revision_id)
1080
rev_history = self.revision_history()
1081
rev_history.extend(revision_ids)
1082
self.set_revision_history(rev_history)
1951
1084
@needs_write_lock
1952
1085
def set_revision_history(self, rev_history):
1953
1086
"""See Branch.set_revision_history."""
1954
if 'evil' in debug.debug_flags:
1955
mutter_callsite(3, "set_revision_history scales with history.")
1956
check_not_reserved_id = _mod_revision.check_not_reserved_id
1957
for rev_id in rev_history:
1958
check_not_reserved_id(rev_id)
1959
if Branch.hooks['post_change_branch_tip']:
1960
# Don't calculate the last_revision_info() if there are no hooks
1962
old_revno, old_revid = self.last_revision_info()
1963
if len(rev_history) == 0:
1964
revid = _mod_revision.NULL_REVISION
1966
revid = rev_history[-1]
1967
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1968
self._write_revision_history(rev_history)
1969
self._clear_cached_state()
1970
self._cache_revision_history(rev_history)
1971
for hook in Branch.hooks['set_rh']:
1972
hook(self, rev_history)
1973
if Branch.hooks['post_change_branch_tip']:
1974
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1976
def _synchronize_history(self, destination, revision_id):
1977
"""Synchronize last revision and revision history between branches.
1979
This version is most efficient when the destination is also a
1980
BzrBranch5, but works for BzrBranch6 as long as the revision
1981
history is the true lefthand parent history, and all of the revisions
1982
are in the destination's repository. If not, set_revision_history
1985
:param destination: The branch to copy the history into
1986
:param revision_id: The revision-id to truncate history at. May
1987
be None to copy complete history.
1989
if not isinstance(destination._format, BzrBranchFormat5):
1990
super(BzrBranch, self)._synchronize_history(
1991
destination, revision_id)
1993
if revision_id == _mod_revision.NULL_REVISION:
1996
new_history = self.revision_history()
1997
if revision_id is not None and new_history != []:
1999
new_history = new_history[:new_history.index(revision_id) + 1]
2001
rev = self.repository.get_revision(revision_id)
2002
new_history = rev.get_history(self.repository)[1:]
2003
destination.set_revision_history(new_history)
2006
def set_last_revision_info(self, revno, revision_id):
2007
"""Set the last revision of this branch.
2009
The caller is responsible for checking that the revno is correct
2010
for this revision id.
2012
It may be possible to set the branch last revision to an id not
2013
present in the repository. However, branches can also be
2014
configured to check constraints on history, in which case this may not
2017
revision_id = _mod_revision.ensure_null(revision_id)
2018
# this old format stores the full history, but this api doesn't
2019
# provide it, so we must generate, and might as well check it's
2021
history = self._lefthand_history(revision_id)
2022
if len(history) != revno:
2023
raise AssertionError('%d != %d' % (len(history), revno))
2024
self.set_revision_history(history)
2026
def _gen_revision_history(self):
2027
history = self._transport.get_bytes('revision-history').split('\n')
2028
if history[-1:] == ['']:
2029
# There shouldn't be a trailing newline, but just in case.
2034
def generate_revision_history(self, revision_id, last_rev=None,
1087
self.control_files.put_utf8(
1088
'revision-history', '\n'.join(rev_history))
1089
transaction = self.get_transaction()
1090
history = transaction.map.find_revision_history()
1091
if history is not None:
1092
# update the revision history in the identity map.
1093
history[:] = list(rev_history)
1094
# this call is disabled because revision_history is
1095
# not really an object yet, and the transaction is for objects.
1096
# transaction.register_dirty(history)
1098
transaction.map.add_revision_history(rev_history)
1099
# this call is disabled because revision_history is
1100
# not really an object yet, and the transaction is for objects.
1101
# transaction.register_clean(history)
1104
def revision_history(self):
1105
"""See Branch.revision_history."""
1106
transaction = self.get_transaction()
1107
history = transaction.map.find_revision_history()
1108
if history is not None:
1109
# mutter("cache hit for revision-history in %s", self)
1110
return list(history)
1111
decode_utf8 = cache_utf8.decode
1112
history = [decode_utf8(l.rstrip('\r\n')) for l in
1113
self.control_files.get('revision-history').readlines()]
1114
transaction.map.add_revision_history(history)
1115
# this call is disabled because revision_history is
1116
# not really an object yet, and the transaction is for objects.
1117
# transaction.register_clean(history, precious=True)
1118
return list(history)
1121
def generate_revision_history(self, revision_id, last_rev=None,
2035
1122
other_branch=None):
2036
1123
"""Create a new revision history that will finish with revision_id.
2038
1125
:param revision_id: the new tip to use.
2039
1126
:param last_rev: The previous last_revision. If not None, then this
2040
1127
must be a ancestory of revision_id, or DivergedBranches is raised.
2041
1128
:param other_branch: The other branch that DivergedBranches should
2042
1129
raise with respect to.
2044
self.set_revision_history(self._lefthand_history(revision_id,
2045
last_rev, other_branch))
1131
# stop_revision must be a descendant of last_revision
1132
stop_graph = self.repository.get_revision_graph(revision_id)
1133
if last_rev is not None and last_rev not in stop_graph:
1134
# our previous tip is not merged into stop_revision
1135
raise errors.DivergedBranches(self, other_branch)
1136
# make a new revision history from the graph
1137
current_rev_id = revision_id
1139
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1140
new_history.append(current_rev_id)
1141
current_rev_id_parents = stop_graph[current_rev_id]
1143
current_rev_id = current_rev_id_parents[0]
1145
current_rev_id = None
1146
new_history.reverse()
1147
self.set_revision_history(new_history)
1150
def update_revisions(self, other, stop_revision=None):
1151
"""See Branch.update_revisions."""
1154
if stop_revision is None:
1155
stop_revision = other.last_revision()
1156
if stop_revision is None:
1157
# if there are no commits, we're done.
1159
# whats the current last revision, before we fetch [and change it
1161
last_rev = self.last_revision()
1162
# we fetch here regardless of whether we need to so that we pickup
1164
self.fetch(other, stop_revision)
1165
my_ancestry = self.repository.get_ancestry(last_rev)
1166
if stop_revision in my_ancestry:
1167
# last_revision is a descendant of stop_revision
1169
self.generate_revision_history(stop_revision, last_rev=last_rev,
2047
1174
def basis_tree(self):
2048
1175
"""See Branch.basis_tree."""
2049
1176
return self.repository.revision_tree(self.last_revision())
1178
@deprecated_method(zero_eight)
1179
def working_tree(self):
1180
"""Create a Working tree object for this branch."""
1182
from bzrlib.transport.local import LocalTransport
1183
if (self.base.find('://') != -1 or
1184
not isinstance(self._transport, LocalTransport)):
1185
raise NoWorkingTree(self.base)
1186
return self.bzrdir.open_workingtree()
2051
1188
@needs_write_lock
2052
def pull(self, source, overwrite=False, stop_revision=None,
2053
_hook_master=None, run_hooks=True, possible_transports=None,
2054
_override_hook_target=None):
2057
:param _hook_master: Private parameter - set the branch to
2058
be supplied as the master to pull hooks.
2059
:param run_hooks: Private parameter - if false, this branch
2060
is being called because it's the master of the primary branch,
2061
so it should not run its hooks.
2062
:param _override_hook_target: Private parameter - set the branch to be
2063
supplied as the target_branch to pull hooks.
2065
result = PullResult()
2066
result.source_branch = source
2067
if _override_hook_target is None:
2068
result.target_branch = self
2070
result.target_branch = _override_hook_target
1189
def pull(self, source, overwrite=False, stop_revision=None):
1190
"""See Branch.pull."""
2071
1191
source.lock_read()
2073
# We assume that during 'pull' the local repository is closer than
2075
graph = self.repository.get_graph(source.repository)
2076
result.old_revno, result.old_revid = self.last_revision_info()
2077
self.update_revisions(source, stop_revision, overwrite=overwrite,
2079
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2080
result.new_revno, result.new_revid = self.last_revision_info()
2082
result.master_branch = _hook_master
2083
result.local_branch = result.target_branch
2085
result.master_branch = result.target_branch
2086
result.local_branch = None
2088
for hook in Branch.hooks['post_pull']:
1193
old_count = len(self.revision_history())
1195
self.update_revisions(source, stop_revision)
1196
except DivergedBranches:
1200
self.set_revision_history(source.revision_history())
1201
new_count = len(self.revision_history())
1202
return new_count - old_count
2091
1204
source.unlock()
2094
def _get_parent_location(self):
1206
def get_parent(self):
1207
"""See Branch.get_parent."""
2095
1209
_locs = ['parent', 'pull', 'x-pull']
1210
assert self.base[-1] == '/'
2096
1211
for l in _locs:
2098
return self._transport.get_bytes(l).strip('\n')
2099
except errors.NoSuchFile:
1213
parent = self.control_files.get(l).read().strip('\n')
1216
# This is an old-format absolute path to a local branch
1217
# turn it into a url
1218
if parent.startswith('/'):
1219
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1221
return urlutils.join(self.base[:-1], parent)
1222
except errors.InvalidURLJoin, e:
1223
raise errors.InaccessibleParent(parent, self.base)
2104
def push(self, target, overwrite=False, stop_revision=None,
2105
_override_hook_source_branch=None):
2108
This is the basic concrete implementation of push()
2110
:param _override_hook_source_branch: If specified, run
2111
the hooks passing this Branch as the source, rather than self.
2112
This is for use of RemoteBranch, where push is delegated to the
2113
underlying vfs-based Branch.
2115
# TODO: Public option to disable running hooks - should be trivial but
2117
return _run_with_write_locked_target(
2118
target, self._push_with_bound_branches, target, overwrite,
2120
_override_hook_source_branch=_override_hook_source_branch)
2122
def _push_with_bound_branches(self, target, overwrite,
2124
_override_hook_source_branch=None):
2125
"""Push from self into target, and into target's master if any.
2127
This is on the base BzrBranch class even though it doesn't support
2128
bound branches because the *target* might be bound.
2131
if _override_hook_source_branch:
2132
result.source_branch = _override_hook_source_branch
2133
for hook in Branch.hooks['post_push']:
2136
bound_location = target.get_bound_location()
2137
if bound_location and target.base != bound_location:
2138
# there is a master branch.
2140
# XXX: Why the second check? Is it even supported for a branch to
2141
# be bound to itself? -- mbp 20070507
2142
master_branch = target.get_master_branch()
2143
master_branch.lock_write()
2145
# push into the master from this branch.
2146
self._basic_push(master_branch, overwrite, stop_revision)
2147
# and push into the target branch from this. Note that we push from
2148
# this branch again, because its considered the highest bandwidth
2150
result = self._basic_push(target, overwrite, stop_revision)
2151
result.master_branch = master_branch
2152
result.local_branch = target
2156
master_branch.unlock()
2159
result = self._basic_push(target, overwrite, stop_revision)
2160
# TODO: Why set master_branch and local_branch if there's no
2161
# binding? Maybe cleaner to just leave them unset? -- mbp
2163
result.master_branch = target
2164
result.local_branch = None
2168
def _basic_push(self, target, overwrite, stop_revision):
2169
"""Basic implementation of push without bound branches or hooks.
2171
Must be called with self read locked and target write locked.
2173
result = BranchPushResult()
2174
result.source_branch = self
2175
result.target_branch = target
2176
result.old_revno, result.old_revid = target.last_revision_info()
2177
if result.old_revid != self.last_revision():
2178
# We assume that during 'push' this repository is closer than
2180
graph = self.repository.get_graph(target.repository)
2181
target.update_revisions(self, stop_revision, overwrite=overwrite,
2183
if self._push_should_merge_tags():
2184
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2185
result.new_revno, result.new_revid = target.last_revision_info()
2188
def get_stacked_on_url(self):
2189
raise errors.UnstackableBranchFormat(self._format, self.base)
1226
def get_push_location(self):
1227
"""See Branch.get_push_location."""
1228
push_loc = self.get_config().get_user_option('push_location')
2191
1231
def set_push_location(self, location):
2192
1232
"""See Branch.set_push_location."""
2193
self.get_config().set_user_option(
2194
'push_location', location,
2195
store=_mod_config.STORE_LOCATION_NORECURSE)
1233
self.get_config().set_user_option('push_location', location,
2197
1236
@needs_write_lock
2198
1237
def set_parent(self, url):
2200
1239
# TODO: Maybe delete old location files?
2201
1240
# URLs should never be unicode, even on the local fs,
2202
1241
# FIXUP this and get_parent in a future branch format bump:
2203
# read and rewrite the file. RBC 20060125
1242
# read and rewrite the file, and have the new format code read
1243
# using .get not .get_utf8. RBC 20060125
1245
self.control_files._transport.delete('parent')
2205
1247
if isinstance(url, unicode):
2207
1249
url = url.encode('ascii')
2208
1250
except UnicodeEncodeError:
2209
raise errors.InvalidURL(url,
1251
raise bzrlib.errors.InvalidURL(url,
2210
1252
"Urls must be 7-bit ascii, "
2211
1253
"use bzrlib.urlutils.escape")
2212
1255
url = urlutils.relative_url(self.base, url)
2213
self._set_parent_location(url)
1256
self.control_files.put('parent', StringIO(url + '\n'))
2215
def _set_parent_location(self, url):
2217
self._transport.delete('parent')
2219
self._transport.put_bytes('parent', url + '\n',
2220
mode=self.bzrdir._get_file_mode())
1258
@deprecated_function(zero_nine)
1259
def tree_config(self):
1260
"""DEPRECATED; call get_config instead.
1261
TreeConfig has become part of BranchConfig."""
1262
return TreeConfig(self)
2223
1265
class BzrBranch5(BzrBranch):
2224
"""A format 5 branch. This supports new features over plain branches.
1266
"""A format 5 branch. This supports new features over plan branches.
2226
1268
It has support for a master_branch which is the data for bound branches.
1276
super(BzrBranch5, self).__init__(_format=_format,
1277
_control_files=_control_files,
1279
_repository=_repository)
2229
1281
@needs_write_lock
2230
def pull(self, source, overwrite=False, stop_revision=None,
2231
run_hooks=True, possible_transports=None,
2232
_override_hook_target=None):
2233
"""Pull from source into self, updating my master if any.
2235
:param run_hooks: Private parameter - if false, this branch
2236
is being called because it's the master of the primary branch,
2237
so it should not run its hooks.
1282
def pull(self, source, overwrite=False, stop_revision=None):
1283
"""Updates branch.pull to be bound branch aware."""
2239
1284
bound_location = self.get_bound_location()
2240
master_branch = None
2241
if bound_location and source.base != bound_location:
1285
if source.base != bound_location:
2242
1286
# not pulling from master, so we need to update master.
2243
master_branch = self.get_master_branch(possible_transports)
2244
master_branch.lock_write()
2247
# pull from source into master.
2248
master_branch.pull(source, overwrite, stop_revision,
2250
return super(BzrBranch5, self).pull(source, overwrite,
2251
stop_revision, _hook_master=master_branch,
2252
run_hooks=run_hooks,
2253
_override_hook_target=_override_hook_target)
2256
master_branch.unlock()
1287
master_branch = self.get_master_branch()
1289
master_branch.pull(source)
1290
source = master_branch
1291
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
2258
1293
def get_bound_location(self):
2260
return self._transport.get_bytes('bound')[:-1]
1295
return self.control_files.get_utf8('bound').read()[:-1]
2261
1296
except errors.NoSuchFile:
2264
1299
@needs_read_lock
2265
def get_master_branch(self, possible_transports=None):
1300
def get_master_branch(self):
2266
1301
"""Return the branch we are bound to.
2268
1303
:return: Either a Branch, or None
2270
1305
This could memoise the branch, but if thats done
2330
1379
return self.set_bound_location(None)
2332
1381
@needs_write_lock
2333
def update(self, possible_transports=None):
2334
"""Synchronise this branch with the master branch if any.
1383
"""Synchronise this branch with the master branch if any.
2336
1385
:return: None or the last_revision that was pivoted out during the
2339
master = self.get_master_branch(possible_transports)
1388
master = self.get_master_branch()
2340
1389
if master is not None:
2341
old_tip = _mod_revision.ensure_null(self.last_revision())
1390
old_tip = self.last_revision()
2342
1391
self.pull(master, overwrite=True)
2343
if self.repository.get_graph().is_ancestor(old_tip,
2344
_mod_revision.ensure_null(self.last_revision())):
1392
if old_tip in self.repository.get_ancestry(self.last_revision()):
2350
class BzrBranch7(BzrBranch5):
2351
"""A branch with support for a fallback repository."""
2353
def _open_hook(self):
2354
if self._ignore_fallbacks:
2357
url = self.get_stacked_on_url()
2358
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2359
errors.UnstackableBranchFormat):
2362
for hook in Branch.hooks['transform_fallback_location']:
2363
url = hook(self, url)
2365
hook_name = Branch.hooks.get_hook_name(hook)
2366
raise AssertionError(
2367
"'transform_fallback_location' hook %s returned "
2368
"None, not a URL." % hook_name)
2369
self._activate_fallback_location(url)
2371
def __init__(self, *args, **kwargs):
2372
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2373
super(BzrBranch7, self).__init__(*args, **kwargs)
2374
self._last_revision_info_cache = None
2375
self._partial_revision_history_cache = []
2377
def _clear_cached_state(self):
2378
super(BzrBranch7, self)._clear_cached_state()
2379
self._last_revision_info_cache = None
2380
self._partial_revision_history_cache = []
2382
def _last_revision_info(self):
2383
revision_string = self._transport.get_bytes('last-revision')
2384
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2385
revision_id = cache_utf8.get_cached_utf8(revision_id)
2387
return revno, revision_id
2389
def _write_last_revision_info(self, revno, revision_id):
2390
"""Simply write out the revision id, with no checks.
2392
Use set_last_revision_info to perform this safely.
2394
Does not update the revision_history cache.
2395
Intended to be called by set_last_revision_info and
2396
_write_revision_history.
2398
revision_id = _mod_revision.ensure_null(revision_id)
2399
out_string = '%d %s\n' % (revno, revision_id)
2400
self._transport.put_bytes('last-revision', out_string,
2401
mode=self.bzrdir._get_file_mode())
2404
def set_last_revision_info(self, revno, revision_id):
2405
revision_id = _mod_revision.ensure_null(revision_id)
2406
old_revno, old_revid = self.last_revision_info()
2407
if self._get_append_revisions_only():
2408
self._check_history_violation(revision_id)
2409
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2410
self._write_last_revision_info(revno, revision_id)
2411
self._clear_cached_state()
2412
self._last_revision_info_cache = revno, revision_id
2413
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2415
def _synchronize_history(self, destination, revision_id):
2416
"""Synchronize last revision and revision history between branches.
2418
:see: Branch._synchronize_history
2420
# XXX: The base Branch has a fast implementation of this method based
2421
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2422
# that uses set_revision_history. This class inherits from BzrBranch5,
2423
# but wants the fast implementation, so it calls
2424
# Branch._synchronize_history directly.
2425
Branch._synchronize_history(self, destination, revision_id)
2427
def _check_history_violation(self, revision_id):
2428
last_revision = _mod_revision.ensure_null(self.last_revision())
2429
if _mod_revision.is_null(last_revision):
2431
if last_revision not in self._lefthand_history(revision_id):
2432
raise errors.AppendRevisionsOnlyViolation(self.base)
2434
def _gen_revision_history(self):
2435
"""Generate the revision history from last revision
2437
last_revno, last_revision = self.last_revision_info()
2438
self._extend_partial_history(stop_index=last_revno-1)
2439
return list(reversed(self._partial_revision_history_cache))
2441
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2442
"""Extend the partial history to include a given index
2444
If a stop_index is supplied, stop when that index has been reached.
2445
If a stop_revision is supplied, stop when that revision is
2446
encountered. Otherwise, stop when the beginning of history is
2449
:param stop_index: The index which should be present. When it is
2450
present, history extension will stop.
2451
:param revision_id: The revision id which should be present. When
2452
it is encountered, history extension will stop.
2454
repo = self.repository
2455
if len(self._partial_revision_history_cache) == 0:
2456
iterator = repo.iter_reverse_revision_history(self.last_revision())
2458
start_revision = self._partial_revision_history_cache[-1]
2459
iterator = repo.iter_reverse_revision_history(start_revision)
2460
#skip the last revision in the list
2461
next_revision = iterator.next()
2462
for revision_id in iterator:
2463
self._partial_revision_history_cache.append(revision_id)
2464
if (stop_index is not None and
2465
len(self._partial_revision_history_cache) > stop_index):
2467
if revision_id == stop_revision:
2470
def _write_revision_history(self, history):
2471
"""Factored out of set_revision_history.
2473
This performs the actual writing to disk, with format-specific checks.
2474
It is intended to be called by BzrBranch5.set_revision_history.
2476
if len(history) == 0:
2477
last_revision = 'null:'
2479
if history != self._lefthand_history(history[-1]):
2480
raise errors.NotLefthandHistory(history)
2481
last_revision = history[-1]
2482
if self._get_append_revisions_only():
2483
self._check_history_violation(last_revision)
2484
self._write_last_revision_info(len(history), last_revision)
2487
def _set_parent_location(self, url):
2488
"""Set the parent branch"""
2489
self._set_config_location('parent_location', url, make_relative=True)
2492
def _get_parent_location(self):
2493
"""Set the parent branch"""
2494
return self._get_config_location('parent_location')
2496
def set_push_location(self, location):
2497
"""See Branch.set_push_location."""
2498
self._set_config_location('push_location', location)
2500
def set_bound_location(self, location):
2501
"""See Branch.set_push_location."""
2503
config = self.get_config()
2504
if location is None:
2505
if config.get_user_option('bound') != 'True':
2508
config.set_user_option('bound', 'False', warn_masked=True)
2511
self._set_config_location('bound_location', location,
2513
config.set_user_option('bound', 'True', warn_masked=True)
2516
def _get_bound_location(self, bound):
2517
"""Return the bound location in the config file.
2519
Return None if the bound parameter does not match"""
2520
config = self.get_config()
2521
config_bound = (config.get_user_option('bound') == 'True')
2522
if config_bound != bound:
2524
return self._get_config_location('bound_location', config=config)
2526
def get_bound_location(self):
2527
"""See Branch.set_push_location."""
2528
return self._get_bound_location(True)
2530
def get_old_bound_location(self):
2531
"""See Branch.get_old_bound_location"""
2532
return self._get_bound_location(False)
2534
def get_stacked_on_url(self):
2535
# you can always ask for the URL; but you might not be able to use it
2536
# if the repo can't support stacking.
2537
## self._check_stackable_repo()
2538
stacked_url = self._get_config_location('stacked_on_location')
2539
if stacked_url is None:
2540
raise errors.NotStacked(self)
2543
def set_append_revisions_only(self, enabled):
2548
self.get_config().set_user_option('append_revisions_only', value,
2551
def _get_append_revisions_only(self):
2552
value = self.get_config().get_user_option('append_revisions_only')
2553
return value == 'True'
2556
def generate_revision_history(self, revision_id, last_rev=None,
2558
"""See BzrBranch5.generate_revision_history"""
2559
history = self._lefthand_history(revision_id, last_rev, other_branch)
2560
revno = len(history)
2561
self.set_last_revision_info(revno, revision_id)
2564
def get_rev_id(self, revno, history=None):
2565
"""Find the revision id of the specified revno."""
2567
return _mod_revision.NULL_REVISION
2569
last_revno, last_revision_id = self.last_revision_info()
2570
if revno <= 0 or revno > last_revno:
2571
raise errors.NoSuchRevision(self, revno)
2573
if history is not None:
2574
return history[revno - 1]
2576
index = last_revno - revno
2577
if len(self._partial_revision_history_cache) <= index:
2578
self._extend_partial_history(stop_index=index)
2579
if len(self._partial_revision_history_cache) > index:
2580
return self._partial_revision_history_cache[index]
2582
raise errors.NoSuchRevision(self, revno)
2585
def revision_id_to_revno(self, revision_id):
2586
"""Given a revision id, return its revno"""
2587
if _mod_revision.is_null(revision_id):
2590
index = self._partial_revision_history_cache.index(revision_id)
2592
self._extend_partial_history(stop_revision=revision_id)
2593
index = len(self._partial_revision_history_cache) - 1
2594
if self._partial_revision_history_cache[index] != revision_id:
2595
raise errors.NoSuchRevision(self, revision_id)
2596
return self.revno() - index
2599
class BzrBranch6(BzrBranch7):
2600
"""See BzrBranchFormat6 for the capabilities of this branch.
2602
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2606
def get_stacked_on_url(self):
2607
raise errors.UnstackableBranchFormat(self._format, self.base)
2610
######################################################################
2611
# results of operations
2614
class _Result(object):
2616
def _show_tag_conficts(self, to_file):
2617
if not getattr(self, 'tag_conflicts', None):
2619
to_file.write('Conflicting tags:\n')
2620
for name, value1, value2 in self.tag_conflicts:
2621
to_file.write(' %s\n' % (name, ))
2624
class PullResult(_Result):
2625
"""Result of a Branch.pull operation.
2627
:ivar old_revno: Revision number before pull.
2628
:ivar new_revno: Revision number after pull.
2629
:ivar old_revid: Tip revision id before pull.
2630
:ivar new_revid: Tip revision id after pull.
2631
:ivar source_branch: Source (local) branch object. (read locked)
2632
:ivar master_branch: Master branch of the target, or the target if no
2634
:ivar local_branch: target branch if there is a Master, else None
2635
:ivar target_branch: Target/destination branch object. (write locked)
2636
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2640
# DEPRECATED: pull used to return the change in revno
2641
return self.new_revno - self.old_revno
2643
def report(self, to_file):
2645
if self.old_revid == self.new_revid:
2646
to_file.write('No revisions to pull.\n')
2648
to_file.write('Now on revision %d.\n' % self.new_revno)
2649
self._show_tag_conficts(to_file)
2652
class BranchPushResult(_Result):
2653
"""Result of a Branch.push operation.
2655
:ivar old_revno: Revision number (eg 10) of the target before push.
2656
:ivar new_revno: Revision number (eg 12) of the target after push.
2657
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2659
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2661
:ivar source_branch: Source branch object that the push was from. This is
2662
read locked, and generally is a local (and thus low latency) branch.
2663
:ivar master_branch: If target is a bound branch, the master branch of
2664
target, or target itself. Always write locked.
2665
:ivar target_branch: The direct Branch where data is being sent (write
2667
:ivar local_branch: If the target is a bound branch this will be the
2668
target, otherwise it will be None.
2672
# DEPRECATED: push used to return the change in revno
2673
return self.new_revno - self.old_revno
2675
def report(self, to_file):
2676
"""Write a human-readable description of the result."""
2677
if self.old_revid == self.new_revid:
2678
note('No new revisions to push.')
2680
note('Pushed up to revision %d.' % self.new_revno)
2681
self._show_tag_conficts(to_file)
1398
class BranchTestProviderAdapter(object):
1399
"""A tool to generate a suite testing multiple branch formats at once.
1401
This is done by copying the test once for each transport and injecting
1402
the transport_server, transport_readonly_server, and branch_format
1403
classes into each copy. Each copy is also given a new id() to make it
1407
def __init__(self, transport_server, transport_readonly_server, formats):
1408
self._transport_server = transport_server
1409
self._transport_readonly_server = transport_readonly_server
1410
self._formats = formats
1412
def adapt(self, test):
1413
result = TestSuite()
1414
for branch_format, bzrdir_format in self._formats:
1415
new_test = deepcopy(test)
1416
new_test.transport_server = self._transport_server
1417
new_test.transport_readonly_server = self._transport_readonly_server
1418
new_test.bzrdir_format = bzrdir_format
1419
new_test.branch_format = branch_format
1420
def make_new_test_id():
1421
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1422
return lambda: new_id
1423
new_test.id = make_new_test_id()
1424
result.addTest(new_test)
2684
1428
class BranchCheckResult(object):
2701
1445
self.branch._format)
2704
class Converter5to6(object):
2705
"""Perform an in-place upgrade of format 5 to format 6"""
2707
def convert(self, branch):
2708
# Data for 5 and 6 can peacefully coexist.
2709
format = BzrBranchFormat6()
2710
new_branch = format.open(branch.bzrdir, _found=True)
2712
# Copy source data into target
2713
new_branch._write_last_revision_info(*branch.last_revision_info())
2714
new_branch.set_parent(branch.get_parent())
2715
new_branch.set_bound_location(branch.get_bound_location())
2716
new_branch.set_push_location(branch.get_push_location())
2718
# New branch has no tags by default
2719
new_branch.tags._set_tag_dict({})
2721
# Copying done; now update target format
2722
new_branch._transport.put_bytes('format',
2723
format.get_format_string(),
2724
mode=new_branch.bzrdir._get_file_mode())
2726
# Clean up old files
2727
new_branch._transport.delete('revision-history')
2729
branch.set_parent(None)
2730
except errors.NoSuchFile:
2732
branch.set_bound_location(None)
2735
class Converter6to7(object):
2736
"""Perform an in-place upgrade of format 6 to format 7"""
2738
def convert(self, branch):
2739
format = BzrBranchFormat7()
2740
branch._set_config_location('stacked_on_location', '')
2741
# update target format
2742
branch._transport.put_bytes('format', format.get_format_string())
2746
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2747
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2750
_run_with_write_locked_target will attempt to release the lock it acquires.
2752
If an exception is raised by callable, then that exception *will* be
2753
propagated, even if the unlock attempt raises its own error. Thus
2754
_run_with_write_locked_target should be preferred to simply doing::
2758
return callable(*args, **kwargs)
2763
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2764
# should share code?
2767
result = callable(*args, **kwargs)
2769
exc_info = sys.exc_info()
2773
raise exc_info[0], exc_info[1], exc_info[2]
2779
class InterBranch(InterObject):
2780
"""This class represents operations taking place between two branches.
2782
Its instances have methods like pull() and push() and contain
2783
references to the source and target repositories these operations
2784
can be carried out on.
2788
"""The available optimised InterBranch types."""
2791
def _get_branch_formats_to_test():
2792
"""Return a tuple with the Branch formats to use when testing."""
2793
raise NotImplementedError(self._get_branch_formats_to_test)
2795
def update_revisions(self, stop_revision=None, overwrite=False,
2797
"""Pull in new perfect-fit revisions.
2799
:param stop_revision: Updated until the given revision
2800
:param overwrite: Always set the branch pointer, rather than checking
2801
to see if it is a proper descendant.
2802
:param graph: A Graph object that can be used to query history
2803
information. This can be None.
2806
raise NotImplementedError(self.update_revisions)
2809
class GenericInterBranch(InterBranch):
2810
"""InterBranch implementation that uses public Branch functions.
2814
def _get_branch_formats_to_test():
2815
return BranchFormat._default_format, BranchFormat._default_format
2817
def update_revisions(self, stop_revision=None, overwrite=False,
2819
"""See InterBranch.update_revisions()."""
2820
self.source.lock_read()
2822
other_revno, other_last_revision = self.source.last_revision_info()
2823
stop_revno = None # unknown
2824
if stop_revision is None:
2825
stop_revision = other_last_revision
2826
if _mod_revision.is_null(stop_revision):
2827
# if there are no commits, we're done.
2829
stop_revno = other_revno
2831
# what's the current last revision, before we fetch [and change it
2833
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2834
# we fetch here so that we don't process data twice in the common
2835
# case of having something to pull, and so that the check for
2836
# already merged can operate on the just fetched graph, which will
2837
# be cached in memory.
2838
self.target.fetch(self.source, stop_revision)
2839
# Check to see if one is an ancestor of the other
2842
graph = self.target.repository.get_graph()
2843
if self.target._check_if_descendant_or_diverged(
2844
stop_revision, last_rev, graph, self.source):
2845
# stop_revision is a descendant of last_rev, but we aren't
2846
# overwriting, so we're done.
2848
if stop_revno is None:
2850
graph = self.target.repository.get_graph()
2851
this_revno, this_last_revision = \
2852
self.target.last_revision_info()
2853
stop_revno = graph.find_distance_to_null(stop_revision,
2854
[(other_last_revision, other_revno),
2855
(this_last_revision, this_revno)])
2856
self.target.set_last_revision_info(stop_revno, stop_revision)
2858
self.source.unlock()
2861
def is_compatible(self, source, target):
2862
# GenericBranch uses the public API, so always compatible
2866
InterBranch.register_optimiser(GenericInterBranch)
1448
######################################################################
1452
@deprecated_function(zero_eight)
1453
def is_control_file(*args, **kwargs):
1454
"""See bzrlib.workingtree.is_control_file."""
1455
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
