74
126
"""Branch holding a history of revisions.
77
Base directory/url of the branch.
129
Base directory of the branch.
135
If _lock_mode is true, a positive count of the number of times the
139
Lock object from bzrlib.lock.
79
# this is really an instance variable - FIXME move it there
83
def __init__(self, *ignored, **ignored_too):
84
raise NotImplementedError('The Branch class is abstract')
87
"""Break a lock if one is present from another instance.
89
Uses the ui factory to ask for confirmation if the lock may be from
92
This will probe the repository for its lock as well.
94
self.control_files.break_lock()
95
self.repository.break_lock()
96
master = self.get_master_branch()
97
if master is not None:
101
@deprecated_method(zero_eight)
102
def open_downlevel(base):
103
"""Open a branch which may be of an old format."""
104
return Branch.open(base, _unsupported=True)
107
def open(base, _unsupported=False):
108
"""Open the branch rooted at base.
110
For instance, if the branch is at URL/.bzr/branch,
111
Branch.open(URL) -> a Branch instance.
113
control = bzrdir.BzrDir.open(base, _unsupported)
114
return control.open_branch(_unsupported)
117
def open_containing(url):
118
"""Open an existing branch which contains url.
120
This probes for a branch at url, and searches upwards from there.
122
Basically we keep looking up until we find the control directory or
123
run into the root. If there isn't one, raises NotBranchError.
124
If there is one and it is either an unrecognised format or an unsupported
125
format, UnknownFormatError or UnsupportedFormatError are raised.
126
If there is one, it is returned, along with the unused portion of url.
128
control, relpath = bzrdir.BzrDir.open_containing(url)
129
return control.open_branch(), relpath
132
@deprecated_function(zero_eight)
133
def initialize(base):
134
"""Create a new working tree and branch, rooted at 'base' (url)
136
NOTE: This will soon be deprecated in favour of creation
139
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
141
@deprecated_function(zero_eight)
142
def setup_caching(self, cache_root):
143
"""Subclasses that care about caching should override this, and set
144
up cached stores located under cache_root.
146
NOTE: This is unused.
150
def get_config(self):
151
return bzrlib.config.BranchConfig(self)
154
return self.get_config().get_nickname()
156
def _set_nick(self, nick):
157
self.get_config().set_user_option('nickname', nick)
159
nick = property(_get_nick, _set_nick)
162
raise NotImplementedError(self.is_locked)
146
def __init__(self, base, init=False, find_root=True):
147
"""Create new branch object at a particular location.
149
base -- Base directory for the branch.
151
init -- If True, create new control files in a previously
152
unversioned directory. If False, the branch must already
155
find_root -- If true and init is false, find the root of the
156
existing branch containing base.
158
In the test suite, creation of new trees is tested using the
159
`ScratchBranch` class.
162
self.base = os.path.realpath(base)
165
self.base = find_branch_root(base)
167
self.base = os.path.realpath(base)
168
if not isdir(self.controlfilename('.')):
169
from errors import NotBranchError
170
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
171
['use "bzr init" to initialize a new working tree',
172
'current bzr can only operate from top-of-tree'])
175
self.text_store = ImmutableStore(self.controlfilename('text-store'))
176
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
177
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
181
return '%s(%r)' % (self.__class__.__name__, self.base)
188
if self._lock_mode or self._lock:
189
from warnings import warn
190
warn("branch %r was not explicitly unlocked" % self)
164
195
def lock_write(self):
165
raise NotImplementedError(self.lock_write)
197
if self._lock_mode != 'w':
198
from errors import LockError
199
raise LockError("can't upgrade to a write lock from %r" %
201
self._lock_count += 1
203
from bzrlib.lock import WriteLock
205
self._lock = WriteLock(self.controlfilename('branch-lock'))
206
self._lock_mode = 'w'
167
211
def lock_read(self):
168
raise NotImplementedError(self.lock_read)
213
assert self._lock_mode in ('r', 'w'), \
214
"invalid lock mode %r" % self._lock_mode
215
self._lock_count += 1
217
from bzrlib.lock import ReadLock
219
self._lock = ReadLock(self.controlfilename('branch-lock'))
220
self._lock_mode = 'r'
170
225
def unlock(self):
171
raise NotImplementedError(self.unlock)
173
def peek_lock_mode(self):
174
"""Return lock mode for the Branch: 'r', 'w' or None"""
175
raise NotImplementedError(self.peek_lock_mode)
177
def get_physical_lock_status(self):
178
raise NotImplementedError(self.get_physical_lock_status)
226
if not self._lock_mode:
227
from errors import LockError
228
raise LockError('branch %r is not locked' % (self))
230
if self._lock_count > 1:
231
self._lock_count -= 1
235
self._lock_mode = self._lock_count = None
180
238
def abspath(self, name):
181
"""Return absolute filename for something in the branch
183
XXX: Robert Collins 20051017 what is this used for? why is it a branch
184
method and not a tree method.
186
raise NotImplementedError(self.abspath)
188
def bind(self, other):
189
"""Bind the local branch the other branch.
191
:param other: The branch to bind to
194
raise errors.UpgradeRequired(self.base)
197
def fetch(self, from_branch, last_revision=None, pb=None):
198
"""Copy revisions from from_branch into this branch.
200
:param from_branch: Where to copy from.
201
:param last_revision: What revision to stop at (None for at the end
203
:param pb: An optional progress bar to use.
205
Returns the copied revision count and the failed revisions in a tuple:
208
if self.base == from_branch.base:
211
nested_pb = ui.ui_factory.nested_progress_bar()
216
from_branch.lock_read()
218
if last_revision is None:
219
pb.update('get source history')
220
from_history = from_branch.revision_history()
222
last_revision = from_history[-1]
224
# no history in the source branch
225
last_revision = revision.NULL_REVISION
226
return self.repository.fetch(from_branch.repository,
227
revision_id=last_revision,
230
if nested_pb is not None:
234
def get_bound_location(self):
235
"""Return the URL of the branch we are bound to.
237
Older format branches cannot bind, please be sure to use a metadir
242
def get_commit_builder(self, parents, config=None, timestamp=None,
243
timezone=None, committer=None, revprops=None,
245
"""Obtain a CommitBuilder for this branch.
247
:param parents: Revision ids of the parents of the new revision.
248
:param config: Optional configuration to use.
249
:param timestamp: Optional timestamp recorded for commit.
250
:param timezone: Optional timezone for timestamp.
251
:param committer: Optional committer to set for commit.
252
:param revprops: Optional dictionary of revision properties.
253
:param revision_id: Optional revision id.
257
config = self.get_config()
259
return self.repository.get_commit_builder(self, parents, config,
260
timestamp, timezone, committer, revprops, revision_id)
262
def get_master_branch(self):
263
"""Return the branch we are bound to.
265
:return: Either a Branch, or None
269
def get_revision_delta(self, revno):
270
"""Return the delta for one revision.
272
The delta is relative to its mainline predecessor, or the
273
empty tree for revision 1.
275
assert isinstance(revno, int)
239
"""Return absolute filename for something in the branch"""
240
return os.path.join(self.base, name)
243
def relpath(self, path):
244
"""Return path relative to this branch of something inside it.
246
Raises an error if path is not in this branch."""
247
return _relpath(self.base, path)
250
def controlfilename(self, file_or_path):
251
"""Return location relative to branch."""
252
if isinstance(file_or_path, types.StringTypes):
253
file_or_path = [file_or_path]
254
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
257
def controlfile(self, file_or_path, mode='r'):
258
"""Open a control file for this branch.
260
There are two classes of file in the control directory: text
261
and binary. binary files are untranslated byte streams. Text
262
control files are stored with Unix newlines and in UTF-8, even
263
if the platform or locale defaults are different.
265
Controlfiles should almost never be opened in write mode but
266
rather should be atomically copied and replaced using atomicfile.
269
fn = self.controlfilename(file_or_path)
271
if mode == 'rb' or mode == 'wb':
272
return file(fn, mode)
273
elif mode == 'r' or mode == 'w':
274
# open in binary mode anyhow so there's no newline translation;
275
# codecs uses line buffering by default; don't want that.
277
return codecs.open(fn, mode + 'b', 'utf-8',
280
raise BzrError("invalid controlfile mode %r" % mode)
284
def _make_control(self):
285
os.mkdir(self.controlfilename([]))
286
self.controlfile('README', 'w').write(
287
"This is a Bazaar-NG control directory.\n"
288
"Do not change any files in this directory.\n")
289
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
290
for d in ('text-store', 'inventory-store', 'revision-store'):
291
os.mkdir(self.controlfilename(d))
292
for f in ('revision-history', 'merged-patches',
293
'pending-merged-patches', 'branch-name',
295
self.controlfile(f, 'w').write('')
296
mutter('created control directory in ' + self.base)
297
Inventory().write_xml(self.controlfile('inventory','w'))
300
def _check_format(self):
301
"""Check this branch format is supported.
303
The current tool only supports the current unstable format.
305
In the future, we might need different in-memory Branch
306
classes to support downlevel branches. But not yet.
308
# This ignores newlines so that we can open branches created
309
# on Windows from Linux and so on. I think it might be better
310
# to always make all internal files in unix format.
311
fmt = self.controlfile('branch-format', 'r').read()
312
fmt.replace('\r\n', '')
313
if fmt != BZR_BRANCH_FORMAT:
314
raise BzrError('sorry, branch format %r not supported' % fmt,
315
['use a different bzr version',
316
'or remove the .bzr directory and "bzr init" again'])
320
def read_working_inventory(self):
321
"""Read the working inventory."""
323
# ElementTree does its own conversion from UTF-8, so open in
327
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
328
mutter("loaded inventory of %d items in %f"
329
% (len(inv), time.time() - before))
335
def _write_inventory(self, inv):
336
"""Update the working inventory.
338
That is to say, the inventory describing changes underway, that
339
will be committed to the next revision.
343
from bzrlib.atomicfile import AtomicFile
345
f = AtomicFile(self.controlfilename('inventory'), 'wb')
354
mutter('wrote working inventory')
357
inventory = property(read_working_inventory, _write_inventory, None,
358
"""Inventory for the working copy.""")
361
def add(self, files, verbose=False, ids=None):
362
"""Make files versioned.
364
Note that the command line normally calls smart_add instead.
366
This puts the files in the Added state, so that they will be
367
recorded by the next commit.
370
List of paths to add, relative to the base of the tree.
373
If set, use these instead of automatically generated ids.
374
Must be the same length as the list of files, but may
375
contain None for ids that are to be autogenerated.
377
TODO: Perhaps have an option to add the ids even if the files do
380
TODO: Perhaps return the ids of the files? But then again it
381
is easy to retrieve them if they're needed.
383
TODO: Adding a directory should optionally recurse down and
384
add all non-ignored children. Perhaps do that in a
387
# TODO: Re-adding a file that is removed in the working copy
388
# should probably put it back with the previous ID.
389
if isinstance(files, types.StringTypes):
390
assert(ids is None or isinstance(ids, types.StringTypes))
396
ids = [None] * len(files)
398
assert(len(ids) == len(files))
402
inv = self.read_working_inventory()
403
for f,file_id in zip(files, ids):
404
if is_control_file(f):
405
raise BzrError("cannot add control file %s" % quotefn(f))
410
raise BzrError("cannot add top-level %r" % f)
412
fullpath = os.path.normpath(self.abspath(f))
415
kind = file_kind(fullpath)
417
# maybe something better?
418
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
420
if kind != 'file' and kind != 'directory':
421
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
424
file_id = gen_file_id(f)
425
inv.add_path(f, kind=kind, file_id=file_id)
428
print 'added', quotefn(f)
430
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
432
self._write_inventory(inv)
437
def print_file(self, file, revno):
438
"""Print `file` to stdout."""
441
tree = self.revision_tree(self.lookup_revision(revno))
442
# use inventory as it was in that revision
443
file_id = tree.inventory.path2id(file)
445
raise BzrError("%r is not present in revision %d" % (file, revno))
446
tree.print_file(file_id)
451
def remove(self, files, verbose=False):
452
"""Mark nominated files for removal from the inventory.
454
This does not remove their text. This does not run on
456
TODO: Refuse to remove modified files unless --force is given?
458
TODO: Do something useful with directories.
460
TODO: Should this remove the text or not? Tough call; not
461
removing may be useful and the user can just use use rm, and
462
is the opposite of add. Removing it is consistent with most
463
other tools. Maybe an option.
465
## TODO: Normalize names
466
## TODO: Remove nested loops; better scalability
467
if isinstance(files, types.StringTypes):
473
tree = self.working_tree()
476
# do this before any modifications
480
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
481
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
483
# having remove it, it must be either ignored or unknown
484
if tree.is_ignored(f):
488
show_status(new_status, inv[fid].kind, quotefn(f))
491
self._write_inventory(inv)
496
# FIXME: this doesn't need to be a branch method
497
def set_inventory(self, new_inventory_list):
499
for path, file_id, parent, kind in new_inventory_list:
500
name = os.path.basename(path)
503
inv.add(InventoryEntry(file_id, name, kind, parent))
504
self._write_inventory(inv)
508
"""Return all unknown files.
510
These are files in the working directory that are not versioned or
511
control files or ignored.
513
>>> b = ScratchBranch(files=['foo', 'foo~'])
514
>>> list(b.unknowns())
517
>>> list(b.unknowns())
520
>>> list(b.unknowns())
523
return self.working_tree().unknowns()
526
def append_revision(self, revision_id):
527
from bzrlib.atomicfile import AtomicFile
529
mutter("add {%s} to revision-history" % revision_id)
530
rev_history = self.revision_history() + [revision_id]
532
f = AtomicFile(self.controlfilename('revision-history'))
534
for rev_id in rev_history:
541
def get_revision(self, revision_id):
542
"""Return the Revision object for a named revision"""
543
if not revision_id or not isinstance(revision_id, basestring):
544
raise ValueError('invalid revision-id: %r' % revision_id)
545
r = Revision.read_xml(self.revision_store[revision_id])
546
assert r.revision_id == revision_id
549
def get_revision_sha1(self, revision_id):
550
"""Hash the stored value of a revision, and return it."""
551
# In the future, revision entries will be signed. At that
552
# point, it is probably best *not* to include the signature
553
# in the revision hash. Because that lets you re-sign
554
# the revision, (add signatures/remove signatures) and still
555
# have all hash pointers stay consistent.
556
# But for now, just hash the contents.
557
return sha_file(self.revision_store[revision_id])
560
def get_inventory(self, inventory_id):
561
"""Get Inventory object by hash.
563
TODO: Perhaps for this and similar methods, take a revision
564
parameter which can be either an integer revno or a
566
i = Inventory.read_xml(self.inventory_store[inventory_id])
569
def get_inventory_sha1(self, inventory_id):
570
"""Return the sha1 hash of the inventory entry
572
return sha_file(self.inventory_store[inventory_id])
575
def get_revision_inventory(self, revision_id):
576
"""Return inventory of a past revision."""
577
if revision_id == None:
580
return self.get_inventory(self.get_revision(revision_id).inventory_id)
583
def revision_history(self):
584
"""Return sequence of revision hashes on to this branch.
586
>>> ScratchBranch().revision_history()
591
return [l.rstrip('\r\n') for l in
592
self.controlfile('revision-history', 'r').readlines()]
597
def common_ancestor(self, other, self_revno=None, other_revno=None):
600
>>> sb = ScratchBranch(files=['foo', 'foo~'])
601
>>> sb.common_ancestor(sb) == (None, None)
603
>>> commit.commit(sb, "Committing first revision", verbose=False)
604
>>> sb.common_ancestor(sb)[0]
606
>>> clone = sb.clone()
607
>>> commit.commit(sb, "Committing second revision", verbose=False)
608
>>> sb.common_ancestor(sb)[0]
610
>>> sb.common_ancestor(clone)[0]
612
>>> commit.commit(clone, "Committing divergent second revision",
614
>>> sb.common_ancestor(clone)[0]
616
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
618
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
620
>>> clone2 = sb.clone()
621
>>> sb.common_ancestor(clone2)[0]
623
>>> sb.common_ancestor(clone2, self_revno=1)[0]
625
>>> sb.common_ancestor(clone2, other_revno=1)[0]
628
my_history = self.revision_history()
629
other_history = other.revision_history()
630
if self_revno is None:
631
self_revno = len(my_history)
632
if other_revno is None:
633
other_revno = len(other_history)
634
indices = range(min((self_revno, other_revno)))
637
if my_history[r] == other_history[r]:
638
return r+1, my_history[r]
641
def enum_history(self, direction):
642
"""Return (revno, revision_id) for history of branch.
645
'forward' is from earliest to latest
646
'reverse' is from latest to earliest
276
648
rh = self.revision_history()
277
if not (1 <= revno <= len(rh)):
278
raise InvalidRevisionNumber(revno)
279
return self.repository.get_revision_delta(rh[revno-1])
281
def get_root_id(self):
282
"""Return the id of this branches root"""
283
raise NotImplementedError(self.get_root_id)
285
def print_file(self, file, revision_id):
286
"""Print `file` to stdout."""
287
raise NotImplementedError(self.print_file)
289
def append_revision(self, *revision_ids):
290
raise NotImplementedError(self.append_revision)
292
def set_revision_history(self, rev_history):
293
raise NotImplementedError(self.set_revision_history)
295
def revision_history(self):
296
"""Return sequence of revision hashes on to this branch."""
297
raise NotImplementedError('revision_history is abstract')
649
if direction == 'forward':
654
elif direction == 'reverse':
660
raise ValueError('invalid history direction', direction)
300
664
"""Return current revision number for this branch.
393
895
Note that to_name is only the last component of the new name;
394
896
this doesn't change the directory.
396
This returns a list of (from_path, to_path) pairs for each
399
raise NotImplementedError(self.move)
401
def get_parent(self):
402
"""Return the parent location of the branch.
404
This is the default location for push/pull/missing. The usual
405
pattern is that the user can override it by specifying a
408
raise NotImplementedError(self.get_parent)
410
def get_submit_branch(self):
411
"""Return the submit location of the branch.
413
This is the default location for bundle. The usual
414
pattern is that the user can override it by specifying a
417
return self.get_config().get_user_option('submit_branch')
419
def set_submit_branch(self, location):
420
"""Return the submit location of the branch.
422
This is the default location for bundle. The usual
423
pattern is that the user can override it by specifying a
426
self.get_config().set_user_option('submit_branch', location)
428
def get_push_location(self):
429
"""Return the None or the location to push this branch to."""
430
raise NotImplementedError(self.get_push_location)
432
def set_push_location(self, location):
433
"""Set a new push location for this branch."""
434
raise NotImplementedError(self.set_push_location)
436
def set_parent(self, url):
437
raise NotImplementedError(self.set_parent)
441
"""Synchronise this branch with the master branch if any.
443
:return: None or the last_revision pivoted out during the update.
447
def check_revno(self, revno):
449
Check whether a revno corresponds to any revision.
450
Zero (the NULL revision) is considered valid.
453
self.check_real_revno(revno)
900
## TODO: Option to move IDs only
901
assert not isinstance(from_paths, basestring)
902
tree = self.working_tree()
904
to_abs = self.abspath(to_name)
905
if not isdir(to_abs):
906
raise BzrError("destination %r is not a directory" % to_abs)
907
if not tree.has_filename(to_name):
908
raise BzrError("destination %r not in working directory" % to_abs)
909
to_dir_id = inv.path2id(to_name)
910
if to_dir_id == None and to_name != '':
911
raise BzrError("destination %r is not a versioned directory" % to_name)
912
to_dir_ie = inv[to_dir_id]
913
if to_dir_ie.kind not in ('directory', 'root_directory'):
914
raise BzrError("destination %r is not a directory" % to_abs)
916
to_idpath = inv.get_idpath(to_dir_id)
919
if not tree.has_filename(f):
920
raise BzrError("%r does not exist in working tree" % f)
921
f_id = inv.path2id(f)
923
raise BzrError("%r is not versioned" % f)
924
name_tail = splitpath(f)[-1]
925
dest_path = appendpath(to_name, name_tail)
926
if tree.has_filename(dest_path):
927
raise BzrError("destination %r already exists" % dest_path)
928
if f_id in to_idpath:
929
raise BzrError("can't move %r to a subdirectory of itself" % f)
931
# OK, so there's a race here, it's possible that someone will
932
# create a file in this interval and then the rename might be
933
# left half-done. But we should have caught most problems.
936
name_tail = splitpath(f)[-1]
937
dest_path = appendpath(to_name, name_tail)
938
print "%s => %s" % (f, dest_path)
939
inv.rename(inv.path2id(f), to_dir_id, name_tail)
941
os.rename(self.abspath(f), self.abspath(dest_path))
943
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
944
["rename rolled back"])
946
self._write_inventory(inv)
952
class ScratchBranch(Branch):
953
"""Special test class: a branch that cleans up after itself.
955
>>> b = ScratchBranch()
963
def __init__(self, files=[], dirs=[], base=None):
964
"""Make a test branch.
966
This creates a temporary directory and runs init-tree in it.
968
If any files are listed, they are created in the working copy.
972
base = tempfile.mkdtemp()
974
Branch.__init__(self, base, init=init)
976
os.mkdir(self.abspath(d))
455
def check_real_revno(self, revno):
457
Check whether a revno corresponds to a real revision.
458
Zero (the NULL revision) is considered invalid
460
if revno < 1 or revno > self.revno():
461
raise InvalidRevisionNumber(revno)
464
def clone(self, *args, **kwargs):
465
"""Clone this branch into to_bzrdir preserving all semantic values.
467
revision_id: if not None, the revision history in the new branch will
468
be truncated to end with revision_id.
470
# for API compatibility, until 0.8 releases we provide the old api:
471
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
472
# after 0.8 releases, the *args and **kwargs should be changed:
473
# def clone(self, to_bzrdir, revision_id=None):
474
if (kwargs.get('to_location', None) or
475
kwargs.get('revision', None) or
476
kwargs.get('basis_branch', None) or
477
(len(args) and isinstance(args[0], basestring))):
478
# backwards compatibility api:
479
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
480
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
483
basis_branch = args[2]
485
basis_branch = kwargs.get('basis_branch', None)
487
basis = basis_branch.bzrdir
492
revision_id = args[1]
494
revision_id = kwargs.get('revision', None)
499
# no default to raise if not provided.
500
url = kwargs.get('to_location')
501
return self.bzrdir.clone(url,
502
revision_id=revision_id,
503
basis=basis).open_branch()
505
# generate args by hand
507
revision_id = args[1]
509
revision_id = kwargs.get('revision_id', None)
513
# no default to raise if not provided.
514
to_bzrdir = kwargs.get('to_bzrdir')
515
result = self._format.initialize(to_bzrdir)
516
self.copy_content_into(result, revision_id=revision_id)
520
def sprout(self, to_bzrdir, revision_id=None):
521
"""Create a new line of development from the branch, into to_bzrdir.
523
revision_id: if not None, the revision history in the new branch will
524
be truncated to end with revision_id.
526
result = self._format.initialize(to_bzrdir)
527
self.copy_content_into(result, revision_id=revision_id)
528
result.set_parent(self.bzrdir.root_transport.base)
532
def copy_content_into(self, destination, revision_id=None):
533
"""Copy the content of self into destination.
535
revision_id: if not None, the revision history in the new branch will
536
be truncated to end with revision_id.
538
new_history = self.revision_history()
539
if revision_id is not None:
541
new_history = new_history[:new_history.index(revision_id) + 1]
543
rev = self.repository.get_revision(revision_id)
544
new_history = rev.get_history(self.repository)[1:]
545
destination.set_revision_history(new_history)
547
parent = self.get_parent()
548
except errors.InaccessibleParent, e:
549
mutter('parent was not accessible to copy: %s', e)
552
destination.set_parent(parent)
556
"""Check consistency of the branch.
558
In particular this checks that revisions given in the revision-history
559
do actually match up in the revision graph, and that they're all
560
present in the repository.
562
Callers will typically also want to check the repository.
564
:return: A BranchCheckResult.
566
mainline_parent_id = None
567
for revision_id in self.revision_history():
569
revision = self.repository.get_revision(revision_id)
570
except errors.NoSuchRevision, e:
571
raise errors.BzrCheckError("mainline revision {%s} not in repository"
573
# In general the first entry on the revision history has no parents.
574
# But it's not illegal for it to have parents listed; this can happen
575
# in imports from Arch when the parents weren't reachable.
576
if mainline_parent_id is not None:
577
if mainline_parent_id not in revision.parent_ids:
578
raise errors.BzrCheckError("previous revision {%s} not listed among "
580
% (mainline_parent_id, revision_id))
581
mainline_parent_id = revision_id
582
return BranchCheckResult(self)
584
def _get_checkout_format(self):
585
"""Return the most suitable metadir for a checkout of this branch.
586
Weaves are used if this branch's repostory uses weaves.
588
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
589
from bzrlib import repository
590
format = bzrdir.BzrDirMetaFormat1()
591
format.repository_format = repository.RepositoryFormat7()
593
format = self.repository.bzrdir.cloning_metadir()
596
def create_checkout(self, to_location, revision_id=None,
598
"""Create a checkout of a branch.
600
:param to_location: The url to produce the checkout at
601
:param revision_id: The revision to check out
602
:param lightweight: If True, produce a lightweight checkout, otherwise,
603
produce a bound branch (heavyweight checkout)
604
:return: The tree of the created checkout
606
t = transport.get_transport(to_location)
609
except errors.FileExists:
612
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
613
BranchReferenceFormat().initialize(checkout, self)
615
format = self._get_checkout_format()
616
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
617
to_location, force_new_tree=False, format=format)
618
checkout = checkout_branch.bzrdir
619
checkout_branch.bind(self)
620
if revision_id is not None:
621
rh = checkout_branch.revision_history()
622
new_rh = rh[:rh.index(revision_id) + 1]
623
checkout_branch.set_revision_history(new_rh)
624
return checkout.create_workingtree(revision_id)
627
class BranchFormat(object):
628
"""An encapsulation of the initialization and open routines for a format.
630
Formats provide three things:
631
* An initialization routine,
635
Formats are placed in an dict by their format string for reference
636
during branch opening. Its not required that these be instances, they
637
can be classes themselves with class methods - it simply depends on
638
whether state is needed for a given format or not.
640
Once a format is deprecated, just deprecate the initialize and open
641
methods on the format class. Do not deprecate the object, as the
642
object will be created every time regardless.
645
_default_format = None
646
"""The default format used for new branches."""
649
"""The known formats."""
652
def find_format(klass, a_bzrdir):
653
"""Return the format for the branch object in a_bzrdir."""
655
transport = a_bzrdir.get_branch_transport(None)
656
format_string = transport.get("format").read()
657
return klass._formats[format_string]
659
raise NotBranchError(path=transport.base)
661
raise errors.UnknownFormatError(format=format_string)
664
def get_default_format(klass):
665
"""Return the current default format."""
666
return klass._default_format
668
def get_format_string(self):
669
"""Return the ASCII format string that identifies this format."""
670
raise NotImplementedError(self.get_format_string)
672
def get_format_description(self):
673
"""Return the short format description for this format."""
674
raise NotImplementedError(self.get_format_string)
676
def initialize(self, a_bzrdir):
677
"""Create a branch of this format in a_bzrdir."""
678
raise NotImplementedError(self.initialize)
680
def is_supported(self):
681
"""Is this format supported?
683
Supported formats can be initialized and opened.
684
Unsupported formats may not support initialization or committing or
685
some other features depending on the reason for not being supported.
689
def open(self, a_bzrdir, _found=False):
690
"""Return the branch object for a_bzrdir
692
_found is a private parameter, do not use it. It is used to indicate
693
if format probing has already be done.
695
raise NotImplementedError(self.open)
698
def register_format(klass, format):
699
klass._formats[format.get_format_string()] = format
702
def set_default_format(klass, format):
703
klass._default_format = format
706
def unregister_format(klass, format):
707
assert klass._formats[format.get_format_string()] is format
708
del klass._formats[format.get_format_string()]
711
return self.get_format_string().rstrip()
714
class BzrBranchFormat4(BranchFormat):
715
"""Bzr branch format 4.
718
- a revision-history file.
719
- a branch-lock lock file [ to be shared with the bzrdir ]
722
def get_format_description(self):
723
"""See BranchFormat.get_format_description()."""
724
return "Branch format 4"
726
def initialize(self, a_bzrdir):
727
"""Create a branch of this format in a_bzrdir."""
728
mutter('creating branch in %s', a_bzrdir.transport.base)
729
branch_transport = a_bzrdir.get_branch_transport(self)
730
utf8_files = [('revision-history', ''),
733
control_files = LockableFiles(branch_transport, 'branch-lock',
735
control_files.create_lock()
736
control_files.lock_write()
738
for file, content in utf8_files:
739
control_files.put_utf8(file, content)
741
control_files.unlock()
742
return self.open(a_bzrdir, _found=True)
745
super(BzrBranchFormat4, self).__init__()
746
self._matchingbzrdir = bzrdir.BzrDirFormat6()
748
def open(self, a_bzrdir, _found=False):
749
"""Return the branch object for a_bzrdir
751
_found is a private parameter, do not use it. It is used to indicate
752
if format probing has already be done.
755
# we are being called directly and must probe.
756
raise NotImplementedError
757
return BzrBranch(_format=self,
758
_control_files=a_bzrdir._control_files,
760
_repository=a_bzrdir.open_repository())
763
return "Bazaar-NG branch format 4"
766
class BzrBranchFormat5(BranchFormat):
767
"""Bzr branch format 5.
770
- a revision-history file.
772
- a lock dir guarding the branch itself
773
- all of this stored in a branch/ subdirectory
774
- works with shared repositories.
776
This format is new in bzr 0.8.
779
def get_format_string(self):
780
"""See BranchFormat.get_format_string()."""
781
return "Bazaar-NG branch format 5\n"
783
def get_format_description(self):
784
"""See BranchFormat.get_format_description()."""
785
return "Branch format 5"
787
def initialize(self, a_bzrdir):
788
"""Create a branch of this format in a_bzrdir."""
789
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
790
branch_transport = a_bzrdir.get_branch_transport(self)
791
utf8_files = [('revision-history', ''),
794
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
795
control_files.create_lock()
796
control_files.lock_write()
797
control_files.put_utf8('format', self.get_format_string())
799
for file, content in utf8_files:
800
control_files.put_utf8(file, content)
802
control_files.unlock()
803
return self.open(a_bzrdir, _found=True, )
806
super(BzrBranchFormat5, self).__init__()
807
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
809
def open(self, a_bzrdir, _found=False):
810
"""Return the branch object for a_bzrdir
812
_found is a private parameter, do not use it. It is used to indicate
813
if format probing has already be done.
816
format = BranchFormat.find_format(a_bzrdir)
817
assert format.__class__ == self.__class__
818
transport = a_bzrdir.get_branch_transport(None)
819
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
820
return BzrBranch5(_format=self,
821
_control_files=control_files,
823
_repository=a_bzrdir.find_repository())
826
return "Bazaar-NG Metadir branch format 5"
829
class BranchReferenceFormat(BranchFormat):
830
"""Bzr branch reference format.
832
Branch references are used in implementing checkouts, they
833
act as an alias to the real branch which is at some other url.
840
def get_format_string(self):
841
"""See BranchFormat.get_format_string()."""
842
return "Bazaar-NG Branch Reference Format 1\n"
844
def get_format_description(self):
845
"""See BranchFormat.get_format_description()."""
846
return "Checkout reference format 1"
848
def initialize(self, a_bzrdir, target_branch=None):
849
"""Create a branch of this format in a_bzrdir."""
850
if target_branch is None:
851
# this format does not implement branch itself, thus the implicit
852
# creation contract must see it as uninitializable
853
raise errors.UninitializableFormat(self)
854
mutter('creating branch reference in %s', a_bzrdir.transport.base)
855
branch_transport = a_bzrdir.get_branch_transport(self)
856
branch_transport.put_bytes('location',
857
target_branch.bzrdir.root_transport.base)
858
branch_transport.put_bytes('format', self.get_format_string())
859
return self.open(a_bzrdir, _found=True)
862
super(BranchReferenceFormat, self).__init__()
863
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
865
def _make_reference_clone_function(format, a_branch):
866
"""Create a clone() routine for a branch dynamically."""
867
def clone(to_bzrdir, revision_id=None):
868
"""See Branch.clone()."""
869
return format.initialize(to_bzrdir, a_branch)
870
# cannot obey revision_id limits when cloning a reference ...
871
# FIXME RBC 20060210 either nuke revision_id for clone, or
872
# emit some sort of warning/error to the caller ?!
875
def open(self, a_bzrdir, _found=False):
876
"""Return the branch that the branch reference in a_bzrdir points at.
878
_found is a private parameter, do not use it. It is used to indicate
879
if format probing has already be done.
882
format = BranchFormat.find_format(a_bzrdir)
883
assert format.__class__ == self.__class__
884
transport = a_bzrdir.get_branch_transport(None)
885
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
886
result = real_bzrdir.open_branch()
887
# this changes the behaviour of result.clone to create a new reference
888
# rather than a copy of the content of the branch.
889
# I did not use a proxy object because that needs much more extensive
890
# testing, and we are only changing one behaviour at the moment.
891
# If we decide to alter more behaviours - i.e. the implicit nickname
892
# then this should be refactored to introduce a tested proxy branch
893
# and a subclass of that for use in overriding clone() and ....
895
result.clone = self._make_reference_clone_function(result)
899
# formats which have no format string are not discoverable
900
# and not independently creatable, so are not registered.
901
__default_format = BzrBranchFormat5()
902
BranchFormat.register_format(__default_format)
903
BranchFormat.register_format(BranchReferenceFormat())
904
BranchFormat.set_default_format(__default_format)
905
_legacy_formats = [BzrBranchFormat4(),
908
class BzrBranch(Branch):
909
"""A branch stored in the actual filesystem.
911
Note that it's "local" in the context of the filesystem; it doesn't
912
really matter if it's on an nfs/smb/afs/coda/... share, as long as
913
it's writable, and can be accessed via the normal filesystem API.
979
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
984
>>> orig = ScratchBranch(files=["file1", "file2"])
985
>>> clone = orig.clone()
986
>>> os.path.samefile(orig.base, clone.base)
988
>>> os.path.isfile(os.path.join(clone.base, "file1"))
991
base = tempfile.mkdtemp()
993
shutil.copytree(self.base, base, symlinks=True)
994
return ScratchBranch(base=base)
1000
"""Destroy the test branch, removing the scratch directory."""
1003
mutter("delete ScratchBranch %s" % self.base)
1004
shutil.rmtree(self.base)
1006
# Work around for shutil.rmtree failing on Windows when
1007
# readonly files are encountered
1008
mutter("hit exception in destroying ScratchBranch: %s" % e)
1009
for root, dirs, files in os.walk(self.base, topdown=False):
1011
os.chmod(os.path.join(root, name), 0700)
1012
shutil.rmtree(self.base)
916
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
917
relax_version_check=DEPRECATED_PARAMETER, _format=None,
918
_control_files=None, a_bzrdir=None, _repository=None):
919
"""Create new branch object at a particular location.
921
transport -- A Transport object, defining how to access files.
923
init -- If True, create new control files in a previously
924
unversioned directory. If False, the branch must already
927
relax_version_check -- If true, the usual check for the branch
928
version is not applied. This is intended only for
929
upgrade/recovery type use; it's not guaranteed that
930
all operations will work on old format branches.
933
self.bzrdir = bzrdir.BzrDir.open(transport.base)
935
self.bzrdir = a_bzrdir
936
self._transport = self.bzrdir.transport.clone('..')
937
self._base = self._transport.base
938
self._format = _format
939
if _control_files is None:
940
raise ValueError('BzrBranch _control_files is None')
941
self.control_files = _control_files
942
if deprecated_passed(init):
943
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
944
"deprecated as of bzr 0.8. Please use Branch.create().",
948
# this is slower than before deprecation, oh well never mind.
950
self._initialize(transport.base)
951
self._check_format(_format)
952
if deprecated_passed(relax_version_check):
953
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
954
"relax_version_check parameter is deprecated as of bzr 0.8. "
955
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
959
if (not relax_version_check
960
and not self._format.is_supported()):
961
raise errors.UnsupportedFormatError(format=fmt)
962
if deprecated_passed(transport):
963
warn("BzrBranch.__init__(transport=XXX...): The transport "
964
"parameter is deprecated as of bzr 0.8. "
965
"Please use Branch.open, or bzrdir.open_branch().",
968
self.repository = _repository
971
return '%s(%r)' % (self.__class__.__name__, self.base)
978
base = property(_get_base, doc="The URL for the root of this branch.")
980
def _finish_transaction(self):
981
"""Exit the current transaction."""
982
return self.control_files._finish_transaction()
984
def get_transaction(self):
985
"""Return the current active transaction.
987
If no transaction is active, this returns a passthrough object
988
for which all data is immediately flushed and no caching happens.
990
# this is an explicit function so that we can do tricky stuff
991
# when the storage in rev_storage is elsewhere.
992
# we probably need to hook the two 'lock a location' and
993
# 'have a transaction' together more delicately, so that
994
# we can have two locks (branch and storage) and one transaction
995
# ... and finishing the transaction unlocks both, but unlocking
996
# does not. - RBC 20051121
997
return self.control_files.get_transaction()
999
def _set_transaction(self, transaction):
1000
"""Set a new active transaction."""
1001
return self.control_files._set_transaction(transaction)
1003
def abspath(self, name):
1004
"""See Branch.abspath."""
1005
return self.control_files._transport.abspath(name)
1007
def _check_format(self, format):
1008
"""Identify the branch format if needed.
1010
The format is stored as a reference to the format object in
1011
self._format for code that needs to check it later.
1013
The format parameter is either None or the branch format class
1014
used to open this branch.
1016
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1019
format = BranchFormat.find_format(self.bzrdir)
1020
self._format = format
1021
mutter("got branch format %s", self._format)
1024
def get_root_id(self):
1025
"""See Branch.get_root_id."""
1026
tree = self.repository.revision_tree(self.last_revision())
1027
return tree.inventory.root.file_id
1029
def is_locked(self):
1030
return self.control_files.is_locked()
1032
def lock_write(self):
1033
self.repository.lock_write()
1035
self.control_files.lock_write()
1037
self.repository.unlock()
1040
def lock_read(self):
1041
self.repository.lock_read()
1043
self.control_files.lock_read()
1045
self.repository.unlock()
1049
# TODO: test for failed two phase locks. This is known broken.
1051
self.control_files.unlock()
1053
self.repository.unlock()
1055
def peek_lock_mode(self):
1056
if self.control_files._lock_count == 0:
1059
return self.control_files._lock_mode
1061
def get_physical_lock_status(self):
1062
return self.control_files.get_physical_lock_status()
1065
def print_file(self, file, revision_id):
1066
"""See Branch.print_file."""
1067
return self.repository.print_file(file, revision_id)
1070
def append_revision(self, *revision_ids):
1071
"""See Branch.append_revision."""
1072
for revision_id in revision_ids:
1073
mutter("add {%s} to revision-history" % revision_id)
1074
rev_history = self.revision_history()
1075
rev_history.extend(revision_ids)
1076
self.set_revision_history(rev_history)
1079
def set_revision_history(self, rev_history):
1080
"""See Branch.set_revision_history."""
1081
self.control_files.put_utf8(
1082
'revision-history', '\n'.join(rev_history))
1083
transaction = self.get_transaction()
1084
history = transaction.map.find_revision_history()
1085
if history is not None:
1086
# update the revision history in the identity map.
1087
history[:] = list(rev_history)
1088
# this call is disabled because revision_history is
1089
# not really an object yet, and the transaction is for objects.
1090
# transaction.register_dirty(history)
1092
transaction.map.add_revision_history(rev_history)
1093
# this call is disabled because revision_history is
1094
# not really an object yet, and the transaction is for objects.
1095
# transaction.register_clean(history)
1098
def revision_history(self):
1099
"""See Branch.revision_history."""
1100
transaction = self.get_transaction()
1101
history = transaction.map.find_revision_history()
1102
if history is not None:
1103
# mutter("cache hit for revision-history in %s", self)
1104
return list(history)
1105
decode_utf8 = cache_utf8.decode
1106
history = [decode_utf8(l.rstrip('\r\n')) for l in
1107
self.control_files.get('revision-history').readlines()]
1108
transaction.map.add_revision_history(history)
1109
# this call is disabled because revision_history is
1110
# not really an object yet, and the transaction is for objects.
1111
# transaction.register_clean(history, precious=True)
1112
return list(history)
1115
def generate_revision_history(self, revision_id, last_rev=None,
1117
"""Create a new revision history that will finish with revision_id.
1119
:param revision_id: the new tip to use.
1120
:param last_rev: The previous last_revision. If not None, then this
1121
must be a ancestory of revision_id, or DivergedBranches is raised.
1122
:param other_branch: The other branch that DivergedBranches should
1123
raise with respect to.
1125
# stop_revision must be a descendant of last_revision
1126
stop_graph = self.repository.get_revision_graph(revision_id)
1127
if last_rev is not None and last_rev not in stop_graph:
1128
# our previous tip is not merged into stop_revision
1129
raise errors.DivergedBranches(self, other_branch)
1130
# make a new revision history from the graph
1131
current_rev_id = revision_id
1133
while current_rev_id not in (None, revision.NULL_REVISION):
1134
new_history.append(current_rev_id)
1135
current_rev_id_parents = stop_graph[current_rev_id]
1137
current_rev_id = current_rev_id_parents[0]
1139
current_rev_id = None
1140
new_history.reverse()
1141
self.set_revision_history(new_history)
1144
def update_revisions(self, other, stop_revision=None):
1145
"""See Branch.update_revisions."""
1148
if stop_revision is None:
1149
stop_revision = other.last_revision()
1150
if stop_revision is None:
1151
# if there are no commits, we're done.
1153
# whats the current last revision, before we fetch [and change it
1155
last_rev = self.last_revision()
1156
# we fetch here regardless of whether we need to so that we pickup
1158
self.fetch(other, stop_revision)
1159
my_ancestry = self.repository.get_ancestry(last_rev)
1160
if stop_revision in my_ancestry:
1161
# last_revision is a descendant of stop_revision
1163
self.generate_revision_history(stop_revision, last_rev=last_rev,
1168
def basis_tree(self):
1169
"""See Branch.basis_tree."""
1170
return self.repository.revision_tree(self.last_revision())
1172
@deprecated_method(zero_eight)
1173
def working_tree(self):
1174
"""Create a Working tree object for this branch."""
1176
from bzrlib.transport.local import LocalTransport
1177
if (self.base.find('://') != -1 or
1178
not isinstance(self._transport, LocalTransport)):
1179
raise NoWorkingTree(self.base)
1180
return self.bzrdir.open_workingtree()
1183
def pull(self, source, overwrite=False, stop_revision=None):
1184
"""See Branch.pull."""
1187
old_count = len(self.revision_history())
1189
self.update_revisions(source,stop_revision)
1190
except DivergedBranches:
1194
self.set_revision_history(source.revision_history())
1195
new_count = len(self.revision_history())
1196
return new_count - old_count
1200
def get_parent(self):
1201
"""See Branch.get_parent."""
1203
_locs = ['parent', 'pull', 'x-pull']
1204
assert self.base[-1] == '/'
1207
parent = self.control_files.get(l).read().strip('\n')
1210
# This is an old-format absolute path to a local branch
1211
# turn it into a url
1212
if parent.startswith('/'):
1213
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1215
return urlutils.join(self.base[:-1], parent)
1216
except errors.InvalidURLJoin, e:
1217
raise errors.InaccessibleParent(parent, self.base)
1220
def get_push_location(self):
1221
"""See Branch.get_push_location."""
1222
push_loc = self.get_config().get_user_option('push_location')
1225
def set_push_location(self, location):
1226
"""See Branch.set_push_location."""
1227
self.get_config().set_user_option('push_location', location,
1231
def set_parent(self, url):
1232
"""See Branch.set_parent."""
1233
# TODO: Maybe delete old location files?
1234
# URLs should never be unicode, even on the local fs,
1235
# FIXUP this and get_parent in a future branch format bump:
1236
# read and rewrite the file, and have the new format code read
1237
# using .get not .get_utf8. RBC 20060125
1239
self.control_files._transport.delete('parent')
1241
if isinstance(url, unicode):
1243
url = url.encode('ascii')
1244
except UnicodeEncodeError:
1245
raise bzrlib.errors.InvalidURL(url,
1246
"Urls must be 7-bit ascii, "
1247
"use bzrlib.urlutils.escape")
1249
url = urlutils.relative_url(self.base, url)
1250
self.control_files.put('parent', StringIO(url + '\n'))
1252
@deprecated_function(zero_nine)
1253
def tree_config(self):
1254
"""DEPRECATED; call get_config instead.
1255
TreeConfig has become part of BranchConfig."""
1256
return TreeConfig(self)
1259
class BzrBranch5(BzrBranch):
1260
"""A format 5 branch. This supports new features over plan branches.
1262
It has support for a master_branch which is the data for bound branches.
1270
super(BzrBranch5, self).__init__(_format=_format,
1271
_control_files=_control_files,
1273
_repository=_repository)
1276
def pull(self, source, overwrite=False, stop_revision=None):
1277
"""Updates branch.pull to be bound branch aware."""
1278
bound_location = self.get_bound_location()
1279
if source.base != bound_location:
1280
# not pulling from master, so we need to update master.
1281
master_branch = self.get_master_branch()
1283
master_branch.pull(source)
1284
source = master_branch
1285
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1287
def get_bound_location(self):
1289
return self.control_files.get_utf8('bound').read()[:-1]
1290
except errors.NoSuchFile:
1294
def get_master_branch(self):
1295
"""Return the branch we are bound to.
1297
:return: Either a Branch, or None
1299
This could memoise the branch, but if thats done
1300
it must be revalidated on each new lock.
1301
So for now we just don't memoise it.
1302
# RBC 20060304 review this decision.
1304
bound_loc = self.get_bound_location()
1308
return Branch.open(bound_loc)
1309
except (errors.NotBranchError, errors.ConnectionError), e:
1310
raise errors.BoundBranchConnectionFailure(
1314
def set_bound_location(self, location):
1315
"""Set the target where this branch is bound to.
1317
:param location: URL to the target branch
1320
self.control_files.put_utf8('bound', location+'\n')
1323
self.control_files._transport.delete('bound')
1017
######################################################################
1021
def is_control_file(filename):
1022
## FIXME: better check
1023
filename = os.path.normpath(filename)
1024
while filename != '':
1025
head, tail = os.path.split(filename)
1026
## mutter('check %r for control file' % ((head, tail), ))
1027
if tail == bzrlib.BZRDIR:
1329
def bind(self, other):
1330
"""Bind the local branch the other branch.
1332
:param other: The branch to bind to
1335
# TODO: jam 20051230 Consider checking if the target is bound
1336
# It is debatable whether you should be able to bind to
1337
# a branch which is itself bound.
1338
# Committing is obviously forbidden,
1339
# but binding itself may not be.
1340
# Since we *have* to check at commit time, we don't
1341
# *need* to check here
1344
# we are now equal to or a suffix of other.
1346
# Since we have 'pulled' from the remote location,
1347
# now we should try to pull in the opposite direction
1348
# in case the local tree has more revisions than the
1350
# There may be a different check you could do here
1351
# rather than actually trying to install revisions remotely.
1352
# TODO: capture an exception which indicates the remote branch
1354
# If it is up-to-date, this probably should not be a failure
1356
# lock other for write so the revision-history syncing cannot race
1360
# if this does not error, other now has the same last rev we do
1361
# it can only error if the pull from other was concurrent with
1362
# a commit to other from someone else.
1364
# until we ditch revision-history, we need to sync them up:
1365
self.set_revision_history(other.revision_history())
1366
# now other and self are up to date with each other and have the
1367
# same revision-history.
1371
self.set_bound_location(other.base)
1375
"""If bound, unbind"""
1376
return self.set_bound_location(None)
1380
"""Synchronise this branch with the master branch if any.
1382
:return: None or the last_revision that was pivoted out during the
1385
master = self.get_master_branch()
1386
if master is not None:
1387
old_tip = self.last_revision()
1388
self.pull(master, overwrite=True)
1389
if old_tip in self.repository.get_ancestry(self.last_revision()):
1395
class BranchTestProviderAdapter(object):
1396
"""A tool to generate a suite testing multiple branch formats at once.
1398
This is done by copying the test once for each transport and injecting
1399
the transport_server, transport_readonly_server, and branch_format
1400
classes into each copy. Each copy is also given a new id() to make it
1404
def __init__(self, transport_server, transport_readonly_server, formats):
1405
self._transport_server = transport_server
1406
self._transport_readonly_server = transport_readonly_server
1407
self._formats = formats
1409
def adapt(self, test):
1410
result = TestSuite()
1411
for branch_format, bzrdir_format in self._formats:
1412
new_test = deepcopy(test)
1413
new_test.transport_server = self._transport_server
1414
new_test.transport_readonly_server = self._transport_readonly_server
1415
new_test.bzrdir_format = bzrdir_format
1416
new_test.branch_format = branch_format
1417
def make_new_test_id():
1418
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1419
return lambda: new_id
1420
new_test.id = make_new_test_id()
1421
result.addTest(new_test)
1425
class BranchCheckResult(object):
1426
"""Results of checking branch consistency.
1431
def __init__(self, branch):
1432
self.branch = branch
1434
def report_results(self, verbose):
1435
"""Report the check results via trace.note.
1437
:param verbose: Requests more detailed display of what was checked,
1440
note('checked branch %s format %s',
1442
self.branch._format)
1445
######################################################################
1449
@deprecated_function(zero_eight)
1450
def is_control_file(*args, **kwargs):
1451
"""See bzrlib.workingtree.is_control_file."""
1452
return bzrlib.workingtree.is_control_file(*args, **kwargs)
1029
if filename == head:
1036
def gen_file_id(name):
1037
"""Return new file id.
1039
This should probably generate proper UUIDs, but for the moment we
1040
cope with just randomness because running uuidgen every time is
1044
# get last component
1045
idx = name.rfind('/')
1047
name = name[idx+1 : ]
1048
idx = name.rfind('\\')
1050
name = name[idx+1 : ]
1052
# make it not a hidden file
1053
name = name.lstrip('.')
1055
# remove any wierd characters; we don't escape them but rather
1056
# just pull them out
1057
name = re.sub(r'[^\w.]', '', name)
1059
s = hexlify(rand_bytes(8))
1060
return '-'.join((name, compact_date(time.time()), s))
added
removed
bzrlib/branch.py
