126
127
Basically we keep looking up until we find the control directory or
127
128
run into the root. If there isn't one, raises NotBranchError.
129
If there is one and it is either an unrecognised format or an unsupported
130
format, UnknownFormatError or UnsupportedFormatError are raised.
128
131
If there is one, it is returned, along with the unused portion of url.
130
t = get_transport(url)
133
return _Branch(t), t.relpath(url)
134
except NotBranchError:
136
new_t = t.clone('..')
137
if new_t.base == t.base:
138
# reached the root, whatever that may be
139
raise NotBranchError(path=url)
133
control, relpath = bzrdir.BzrDir.open_containing(url)
134
return control.open_branch(), relpath
137
@deprecated_function(zero_eight)
143
138
def initialize(base):
144
"""Create a new branch, rooted at 'base' (url)"""
145
t = get_transport(base)
146
return _Branch(t, init=True)
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)
148
147
def setup_caching(self, cache_root):
149
148
"""Subclasses that care about caching should override this, and set
150
149
up cached stores located under cache_root.
152
self.cache_root = cache_root
155
class _Branch(Branch):
156
"""A branch stored in the actual filesystem.
158
Note that it's "local" in the context of the filesystem; it doesn't
159
really matter if it's on an nfs/smb/afs/coda/... share, as long as
160
it's writable, and can be accessed via the normal filesystem API.
166
If _lock_mode is true, a positive count of the number of times the
170
Lock object from bzrlib.lock.
172
# We actually expect this class to be somewhat short-lived; part of its
173
# purpose is to try to isolate what bits of the branch logic are tied to
174
# filesystem access, so that in a later step, we can extricate them to
175
# a separarte ("storage") class.
179
_inventory_weave = None
181
# Map some sort of prefix into a namespace
182
# stuff like "revno:10", "revid:", etc.
183
# This should match a prefix with a function which accepts
184
REVISION_NAMESPACES = {}
186
def push_stores(self, branch_to):
187
"""Copy the content of this branches store to branch_to."""
188
if (self._branch_format != branch_to._branch_format
189
or self._branch_format != 4):
190
from bzrlib.fetch import greedy_fetch
191
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
192
self, self._branch_format, branch_to, branch_to._branch_format)
193
greedy_fetch(to_branch=branch_to, from_branch=self,
194
revision=self.last_revision())
197
store_pairs = ((self.text_store, branch_to.text_store),
198
(self.inventory_store, branch_to.inventory_store),
199
(self.revision_store, branch_to.revision_store))
201
for from_store, to_store in store_pairs:
202
copy_all(from_store, to_store)
203
except UnlistableStore:
204
raise UnlistableBranch(from_store)
206
def __init__(self, transport, init=False,
207
relax_version_check=False):
208
"""Create new branch object at a particular location.
210
transport -- A Transport object, defining how to access files.
211
(If a string, transport.transport() will be used to
212
create a Transport object)
214
init -- If True, create new control files in a previously
215
unversioned directory. If False, the branch must already
218
relax_version_check -- If true, the usual check for the branch
219
version is not applied. This is intended only for
220
upgrade/recovery type use; it's not guaranteed that
221
all operations will work on old format branches.
223
In the test suite, creation of new trees is tested using the
224
`ScratchBranch` class.
226
assert isinstance(transport, Transport), \
227
"%r is not a Transport" % transport
228
self._transport = transport
231
self._check_format(relax_version_check)
233
def get_store(name, compressed=True, prefixed=False):
234
# FIXME: This approach of assuming stores are all entirely compressed
235
# or entirely uncompressed is tidy, but breaks upgrade from
236
# some existing branches where there's a mixture; we probably
237
# still want the option to look for both.
238
relpath = self._rel_controlfilename(name)
240
store = CompressedTextStore(self._transport.clone(relpath),
243
store = TextStore(self._transport.clone(relpath),
245
#if self._transport.should_cache():
246
# cache_path = os.path.join(self.cache_root, name)
247
# os.mkdir(cache_path)
248
# store = bzrlib.store.CachedStore(store, cache_path)
250
def get_weave(name, prefixed=False):
251
relpath = self._rel_controlfilename(name)
252
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
253
if self._transport.should_cache():
254
ws.enable_cache = True
257
if self._branch_format == 4:
258
self.inventory_store = get_store('inventory-store')
259
self.text_store = get_store('text-store')
260
self.revision_store = get_store('revision-store')
261
elif self._branch_format == 5:
262
self.control_weaves = get_weave('')
263
self.weave_store = get_weave('weaves')
264
self.revision_store = get_store('revision-store', compressed=False)
265
elif self._branch_format == 6:
266
self.control_weaves = get_weave('')
267
self.weave_store = get_weave('weaves', prefixed=True)
268
self.revision_store = get_store('revision-store', compressed=False,
270
self.revision_store.register_suffix('sig')
271
self._transaction = None
274
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
281
if self._lock_mode or self._lock:
282
# XXX: This should show something every time, and be suitable for
283
# headless operation and embedding
284
warn("branch %r was not explicitly unlocked" % self)
287
# TODO: It might be best to do this somewhere else,
288
# but it is nice for a Branch object to automatically
289
# cache it's information.
290
# Alternatively, we could have the Transport objects cache requests
291
# See the earlier discussion about how major objects (like Branch)
292
# should never expect their __del__ function to run.
293
if hasattr(self, 'cache_root') and self.cache_root is not None:
296
shutil.rmtree(self.cache_root)
299
self.cache_root = None
303
return self._transport.base
306
base = property(_get_base, doc="The URL for the root of this branch.")
308
def _finish_transaction(self):
309
"""Exit the current transaction."""
310
if self._transaction is None:
311
raise errors.LockError('Branch %s is not in a transaction' %
313
transaction = self._transaction
314
self._transaction = None
317
def get_transaction(self):
318
"""Return the current active transaction.
320
If no transaction is active, this returns a passthrough object
321
for which all data is immedaitely flushed and no caching happens.
323
if self._transaction is None:
324
return transactions.PassThroughTransaction()
326
return self._transaction
328
def _set_transaction(self, new_transaction):
329
"""Set a new active transaction."""
330
if self._transaction is not None:
331
raise errors.LockError('Branch %s is in a transaction already.' %
333
self._transaction = new_transaction
151
NOTE: This is unused.
155
def get_config(self):
156
return BranchConfig(self)
159
return self.get_config().get_nickname()
161
def _set_nick(self, nick):
162
self.get_config().set_user_option('nickname', nick)
164
nick = property(_get_nick, _set_nick)
167
raise NotImplementedError(self.is_locked)
335
169
def lock_write(self):
336
mutter("lock write: %s (%s)", self, self._lock_count)
337
# TODO: Upgrade locking to support using a Transport,
338
# and potentially a remote locking protocol
340
if self._lock_mode != 'w':
341
raise LockError("can't upgrade to a write lock from %r" %
343
self._lock_count += 1
345
self._lock = self._transport.lock_write(
346
self._rel_controlfilename('branch-lock'))
347
self._lock_mode = 'w'
349
self._set_transaction(transactions.PassThroughTransaction())
170
raise NotImplementedError(self.lock_write)
351
172
def lock_read(self):
352
mutter("lock read: %s (%s)", self, self._lock_count)
354
assert self._lock_mode in ('r', 'w'), \
355
"invalid lock mode %r" % self._lock_mode
356
self._lock_count += 1
358
self._lock = self._transport.lock_read(
359
self._rel_controlfilename('branch-lock'))
360
self._lock_mode = 'r'
362
self._set_transaction(transactions.ReadOnlyTransaction())
363
# 5K may be excessive, but hey, its a knob.
364
self.get_transaction().set_cache_size(5000)
173
raise NotImplementedError(self.lock_read)
366
175
def unlock(self):
367
mutter("unlock: %s (%s)", self, self._lock_count)
368
if not self._lock_mode:
369
raise LockError('branch %r is not locked' % (self))
371
if self._lock_count > 1:
372
self._lock_count -= 1
374
self._finish_transaction()
377
self._lock_mode = self._lock_count = None
176
raise NotImplementedError(self.unlock)
178
def peek_lock_mode(self):
179
"""Return lock mode for the Branch: 'r', 'w' or None"""
180
raise NotImplementedError(self.peek_lock_mode)
182
def get_physical_lock_status(self):
183
raise NotImplementedError(self.get_physical_lock_status)
379
185
def abspath(self, name):
380
186
"""Return absolute filename for something in the branch
382
188
XXX: Robert Collins 20051017 what is this used for? why is it a branch
383
189
method and not a tree method.
385
return self._transport.abspath(name)
387
def _rel_controlfilename(self, file_or_path):
388
if not isinstance(file_or_path, basestring):
389
file_or_path = '/'.join(file_or_path)
390
if file_or_path == '':
392
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
394
def controlfilename(self, file_or_path):
395
"""Return location relative to branch."""
396
return self._transport.abspath(self._rel_controlfilename(file_or_path))
399
def controlfile(self, file_or_path, mode='r'):
400
"""Open a control file for this branch.
402
There are two classes of file in the control directory: text
403
and binary. binary files are untranslated byte streams. Text
404
control files are stored with Unix newlines and in UTF-8, even
405
if the platform or locale defaults are different.
407
Controlfiles should almost never be opened in write mode but
408
rather should be atomically copied and replaced using atomicfile.
412
relpath = self._rel_controlfilename(file_or_path)
413
#TODO: codecs.open() buffers linewise, so it was overloaded with
414
# a much larger buffer, do we need to do the same for getreader/getwriter?
416
return self._transport.get(relpath)
418
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
420
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
422
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
191
raise NotImplementedError(self.abspath)
193
def bind(self, other):
194
"""Bind the local branch the other branch.
196
:param other: The branch to bind to
199
raise errors.UpgradeRequired(self.base)
202
def fetch(self, from_branch, last_revision=None, pb=None):
203
"""Copy revisions from from_branch into this branch.
205
:param from_branch: Where to copy from.
206
:param last_revision: What revision to stop at (None for at the end
208
:param pb: An optional progress bar to use.
210
Returns the copied revision count and the failed revisions in a tuple:
213
if self.base == from_branch.base:
216
nested_pb = ui.ui_factory.nested_progress_bar()
424
raise BzrError("invalid controlfile mode %r" % mode)
426
def put_controlfile(self, path, f, encode=True):
427
"""Write an entry as a controlfile.
429
:param path: The path to put the file, relative to the .bzr control
431
:param f: A file-like or string object whose contents should be copied.
432
:param encode: If true, encode the contents as utf-8
434
self.put_controlfiles([(path, f)], encode=encode)
436
def put_controlfiles(self, files, encode=True):
437
"""Write several entries as controlfiles.
439
:param files: A list of [(path, file)] pairs, where the path is the directory
440
underneath the bzr control directory
441
:param encode: If true, encode the contents as utf-8
445
for path, f in files:
447
if isinstance(f, basestring):
448
f = f.encode('utf-8', 'replace')
221
from_branch.lock_read()
223
if last_revision is None:
224
pb.update('get source history')
225
from_history = from_branch.revision_history()
227
last_revision = from_history[-1]
450
f = codecs.getwriter('utf-8')(f, errors='replace')
451
path = self._rel_controlfilename(path)
452
ctrl_files.append((path, f))
453
self._transport.put_multi(ctrl_files)
455
def _make_control(self):
456
from bzrlib.inventory import Inventory
457
from bzrlib.weavefile import write_weave_v5
458
from bzrlib.weave import Weave
460
# Create an empty inventory
462
# if we want per-tree root ids then this is the place to set
463
# them; they're not needed for now and so ommitted for
465
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
466
empty_inv = sio.getvalue()
468
bzrlib.weavefile.write_weave_v5(Weave(), sio)
469
empty_weave = sio.getvalue()
471
dirs = [[], 'revision-store', 'weaves']
473
"This is a Bazaar-NG control directory.\n"
474
"Do not change any files in this directory.\n"),
475
('branch-format', BZR_BRANCH_FORMAT_6),
476
('revision-history', ''),
479
('pending-merges', ''),
480
('inventory', empty_inv),
481
('inventory.weave', empty_weave),
482
('ancestry.weave', empty_weave)
484
cfn = self._rel_controlfilename
485
self._transport.mkdir_multi([cfn(d) for d in dirs])
486
self.put_controlfiles(files)
487
mutter('created control directory in ' + self._transport.base)
489
def _check_format(self, relax_version_check):
490
"""Check this branch format is supported.
492
The format level is stored, as an integer, in
493
self._branch_format for code that needs to check it later.
495
In the future, we might need different in-memory Branch
496
classes to support downlevel branches. But not yet.
499
fmt = self.controlfile('branch-format', 'r').read()
501
raise NotBranchError(path=self.base)
502
mutter("got branch format %r", fmt)
503
if fmt == BZR_BRANCH_FORMAT_6:
504
self._branch_format = 6
505
elif fmt == BZR_BRANCH_FORMAT_5:
506
self._branch_format = 5
507
elif fmt == BZR_BRANCH_FORMAT_4:
508
self._branch_format = 4
510
if (not relax_version_check
511
and self._branch_format not in (5, 6)):
512
raise errors.UnsupportedFormatError(
513
'sorry, branch format %r not supported' % fmt,
514
['use a different bzr version',
515
'or remove the .bzr directory'
516
' and "bzr init" again'])
518
def get_root_id(self):
519
"""Return the id of this branches root"""
520
inv = self.read_working_inventory()
521
return inv.root.file_id
523
def set_root_id(self, file_id):
524
inv = self.read_working_inventory()
525
orig_root_id = inv.root.file_id
526
del inv._byid[inv.root.file_id]
527
inv.root.file_id = file_id
528
inv._byid[inv.root.file_id] = inv.root
531
if entry.parent_id in (None, orig_root_id):
532
entry.parent_id = inv.root.file_id
533
self._write_inventory(inv)
536
def read_working_inventory(self):
537
"""Read the working inventory."""
538
# ElementTree does its own conversion from UTF-8, so open in
540
f = self.controlfile('inventory', 'rb')
541
return bzrlib.xml5.serializer_v5.read_inventory(f)
544
def _write_inventory(self, inv):
545
"""Update the working inventory.
547
That is to say, the inventory describing changes underway, that
548
will be committed to the next revision.
550
from cStringIO import StringIO
552
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
554
# Transport handles atomicity
555
self.put_controlfile('inventory', sio)
557
mutter('wrote working inventory')
559
inventory = property(read_working_inventory, _write_inventory, None,
560
"""Inventory for the working copy.""")
563
def add(self, files, ids=None):
564
"""Make files versioned.
566
Note that the command line normally calls smart_add instead,
567
which can automatically recurse.
569
This puts the files in the Added state, so that they will be
570
recorded by the next commit.
573
List of paths to add, relative to the base of the tree.
576
If set, use these instead of automatically generated ids.
577
Must be the same length as the list of files, but may
578
contain None for ids that are to be autogenerated.
580
TODO: Perhaps have an option to add the ids even if the files do
583
TODO: Perhaps yield the ids and paths as they're added.
585
# TODO: Re-adding a file that is removed in the working copy
586
# should probably put it back with the previous ID.
587
if isinstance(files, basestring):
588
assert(ids is None or isinstance(ids, basestring))
594
ids = [None] * len(files)
596
assert(len(ids) == len(files))
598
inv = self.read_working_inventory()
599
for f,file_id in zip(files, ids):
600
if is_control_file(f):
601
raise BzrError("cannot add control file %s" % quotefn(f))
606
raise BzrError("cannot add top-level %r" % f)
608
fullpath = os.path.normpath(self.abspath(f))
611
kind = file_kind(fullpath)
613
# maybe something better?
614
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
616
if not InventoryEntry.versionable_kind(kind):
617
raise BzrError('cannot add: not a versionable file ('
618
'i.e. regular file, symlink or directory): %s' % quotefn(f))
621
file_id = gen_file_id(f)
622
inv.add_path(f, kind=kind, file_id=file_id)
624
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
626
self._write_inventory(inv)
629
def print_file(self, file, revno):
630
"""Print `file` to stdout."""
631
tree = self.revision_tree(self.get_rev_id(revno))
632
# use inventory as it was in that revision
633
file_id = tree.inventory.path2id(file)
635
raise BzrError("%r is not present in revision %s" % (file, revno))
636
tree.print_file(file_id)
638
# FIXME: this doesn't need to be a branch method
639
def set_inventory(self, new_inventory_list):
640
from bzrlib.inventory import Inventory, InventoryEntry
641
inv = Inventory(self.get_root_id())
642
for path, file_id, parent, kind in new_inventory_list:
643
name = os.path.basename(path)
646
# fixme, there should be a factory function inv,add_??
647
if kind == 'directory':
648
inv.add(inventory.InventoryDirectory(file_id, name, parent))
650
inv.add(inventory.InventoryFile(file_id, name, parent))
651
elif kind == 'symlink':
652
inv.add(inventory.InventoryLink(file_id, name, parent))
654
raise BzrError("unknown kind %r" % kind)
655
self._write_inventory(inv)
658
"""Return all unknown files.
660
These are files in the working directory that are not versioned or
661
control files or ignored.
663
>>> from bzrlib.workingtree import WorkingTree
664
>>> b = ScratchBranch(files=['foo', 'foo~'])
665
>>> map(str, b.unknowns())
668
>>> list(b.unknowns())
670
>>> WorkingTree(b.base, b).remove('foo')
671
>>> list(b.unknowns())
674
return self.working_tree().unknowns()
677
def append_revision(self, *revision_ids):
678
for revision_id in revision_ids:
679
mutter("add {%s} to revision-history" % revision_id)
680
rev_history = self.revision_history()
681
rev_history.extend(revision_ids)
682
self.set_revision_history(rev_history)
685
def set_revision_history(self, rev_history):
686
self.put_controlfile('revision-history', '\n'.join(rev_history))
688
def has_revision(self, revision_id):
689
"""True if this branch has a copy of the revision.
691
This does not necessarily imply the revision is merge
692
or on the mainline."""
693
return (revision_id is None
694
or self.revision_store.has_id(revision_id))
697
def get_revision_xml_file(self, revision_id):
698
"""Return XML file object for revision object."""
699
if not revision_id or not isinstance(revision_id, basestring):
700
raise InvalidRevisionId(revision_id)
702
return self.revision_store.get(revision_id)
703
except (IndexError, KeyError):
704
raise bzrlib.errors.NoSuchRevision(self, revision_id)
707
get_revision_xml = get_revision_xml_file
709
def get_revision_xml(self, revision_id):
710
return self.get_revision_xml_file(revision_id).read()
713
def get_revision(self, revision_id):
714
"""Return the Revision object for a named revision"""
715
xml_file = self.get_revision_xml_file(revision_id)
718
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
719
except SyntaxError, e:
720
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
724
assert r.revision_id == revision_id
229
# no history in the source branch
230
last_revision = _mod_revision.NULL_REVISION
231
return self.repository.fetch(from_branch.repository,
232
revision_id=last_revision,
235
if nested_pb is not None:
239
def get_bound_location(self):
240
"""Return the URL of the branch we are bound to.
242
Older format branches cannot bind, please be sure to use a metadir
247
def get_commit_builder(self, parents, config=None, timestamp=None,
248
timezone=None, committer=None, revprops=None,
250
"""Obtain a CommitBuilder for this branch.
252
:param parents: Revision ids of the parents of the new revision.
253
:param config: Optional configuration to use.
254
:param timestamp: Optional timestamp recorded for commit.
255
:param timezone: Optional timezone for timestamp.
256
:param committer: Optional committer to set for commit.
257
:param revprops: Optional dictionary of revision properties.
258
:param revision_id: Optional revision id.
262
config = self.get_config()
264
return self.repository.get_commit_builder(self, parents, config,
265
timestamp, timezone, committer, revprops, revision_id)
267
def get_master_branch(self):
268
"""Return the branch we are bound to.
270
:return: Either a Branch, or None
727
274
def get_revision_delta(self, revno):
728
275
"""Return the delta for one revision.
1197
465
if revno < 1 or revno > self.revno():
1198
466
raise InvalidRevisionNumber(revno)
1200
def sign_revision(self, revision_id, gpg_strategy):
1201
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1202
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1205
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1206
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1210
class ScratchBranch(_Branch):
1211
"""Special test class: a branch that cleans up after itself.
1213
>>> b = ScratchBranch()
1217
>>> b._transport.__del__()
1222
def __init__(self, files=[], dirs=[], transport=None):
1223
"""Make a test branch.
1225
This creates a temporary directory and runs init-tree in it.
1227
If any files are listed, they are created in the working copy.
1229
if transport is None:
1230
transport = bzrlib.transport.local.ScratchTransport()
1231
super(ScratchBranch, self).__init__(transport, init=True)
1233
super(ScratchBranch, self).__init__(transport)
1236
self._transport.mkdir(d)
1239
self._transport.put(f, 'content of %s' % f)
1244
>>> orig = ScratchBranch(files=["file1", "file2"])
1245
>>> clone = orig.clone()
1246
>>> if os.name != 'nt':
1247
... os.path.samefile(orig.base, clone.base)
1249
... orig.base == clone.base
1252
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1255
from shutil import copytree
1256
from tempfile import mkdtemp
1259
copytree(self.base, base, symlinks=True)
1260
return ScratchBranch(
1261
transport=bzrlib.transport.local.ScratchTransport(base))
469
def clone(self, *args, **kwargs):
470
"""Clone this branch into to_bzrdir preserving all semantic values.
472
revision_id: if not None, the revision history in the new branch will
473
be truncated to end with revision_id.
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)
521
self.copy_content_into(result, revision_id=revision_id)
525
def sprout(self, to_bzrdir, revision_id=None):
526
"""Create a new line of development from the branch, into to_bzrdir.
528
revision_id: if not None, the revision history in the new branch will
529
be truncated to end with revision_id.
531
result = self._format.initialize(to_bzrdir)
532
self.copy_content_into(result, revision_id=revision_id)
533
result.set_parent(self.bzrdir.root_transport.base)
537
def copy_content_into(self, destination, revision_id=None):
538
"""Copy the content of self into destination.
540
revision_id: if not None, the revision history in the new branch will
541
be truncated to end with revision_id.
543
new_history = self.revision_history()
544
if revision_id is not None:
546
new_history = new_history[:new_history.index(revision_id) + 1]
548
rev = self.repository.get_revision(revision_id)
549
new_history = rev.get_history(self.repository)[1:]
550
destination.set_revision_history(new_history)
552
parent = self.get_parent()
553
except errors.InaccessibleParent, e:
554
mutter('parent was not accessible to copy: %s', e)
557
destination.set_parent(parent)
561
"""Check consistency of the branch.
563
In particular this checks that revisions given in the revision-history
564
do actually match up in the revision graph, and that they're all
565
present in the repository.
567
Callers will typically also want to check the repository.
569
:return: A BranchCheckResult.
571
mainline_parent_id = None
572
for revision_id in self.revision_history():
574
revision = self.repository.get_revision(revision_id)
575
except errors.NoSuchRevision, e:
576
raise errors.BzrCheckError("mainline revision {%s} not in repository"
578
# In general the first entry on the revision history has no parents.
579
# But it's not illegal for it to have parents listed; this can happen
580
# in imports from Arch when the parents weren't reachable.
581
if mainline_parent_id is not None:
582
if mainline_parent_id not in revision.parent_ids:
583
raise errors.BzrCheckError("previous revision {%s} not listed among "
585
% (mainline_parent_id, revision_id))
586
mainline_parent_id = revision_id
587
return BranchCheckResult(self)
589
def _get_checkout_format(self):
590
"""Return the most suitable metadir for a checkout of this branch.
591
Weaves are used if this branch's repostory uses weaves.
593
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
594
from bzrlib import repository
595
format = bzrdir.BzrDirMetaFormat1()
596
format.repository_format = repository.RepositoryFormat7()
598
format = self.repository.bzrdir.cloning_metadir()
601
def create_checkout(self, to_location, revision_id=None,
603
"""Create a checkout of a branch.
605
:param to_location: The url to produce the checkout at
606
:param revision_id: The revision to check out
607
:param lightweight: If True, produce a lightweight checkout, otherwise,
608
produce a bound branch (heavyweight checkout)
609
:return: The tree of the created checkout
611
t = transport.get_transport(to_location)
614
except errors.FileExists:
617
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
618
BranchReferenceFormat().initialize(checkout, self)
620
format = self._get_checkout_format()
621
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
622
to_location, force_new_tree=False, format=format)
623
checkout = checkout_branch.bzrdir
624
checkout_branch.bind(self)
625
# pull up to the specified revision_id to set the initial
626
# branch tip correctly, and seed it with history.
627
checkout_branch.pull(self, stop_revision=revision_id)
628
return checkout.create_workingtree(revision_id)
631
class BranchFormat(object):
632
"""An encapsulation of the initialization and open routines for a format.
634
Formats provide three things:
635
* An initialization routine,
639
Formats are placed in an dict by their format string for reference
640
during branch opening. Its not required that these be instances, they
641
can be classes themselves with class methods - it simply depends on
642
whether state is needed for a given format or not.
644
Once a format is deprecated, just deprecate the initialize and open
645
methods on the format class. Do not deprecate the object, as the
646
object will be created every time regardless.
649
_default_format = None
650
"""The default format used for new branches."""
653
"""The known formats."""
656
def find_format(klass, a_bzrdir):
657
"""Return the format for the branch object in a_bzrdir."""
659
transport = a_bzrdir.get_branch_transport(None)
660
format_string = transport.get("format").read()
661
return klass._formats[format_string]
663
raise NotBranchError(path=transport.base)
665
raise errors.UnknownFormatError(format=format_string)
668
def get_default_format(klass):
669
"""Return the current default format."""
670
return klass._default_format
672
def get_format_string(self):
673
"""Return the ASCII format string that identifies this format."""
674
raise NotImplementedError(self.get_format_string)
676
def get_format_description(self):
677
"""Return the short format description for this format."""
678
raise NotImplementedError(self.get_format_string)
680
def initialize(self, a_bzrdir):
681
"""Create a branch of this format in a_bzrdir."""
682
raise NotImplementedError(self.initialize)
684
def is_supported(self):
685
"""Is this format supported?
687
Supported formats can be initialized and opened.
688
Unsupported formats may not support initialization or committing or
689
some other features depending on the reason for not being supported.
693
def open(self, a_bzrdir, _found=False):
694
"""Return the branch object for a_bzrdir
696
_found is a private parameter, do not use it. It is used to indicate
697
if format probing has already be done.
699
raise NotImplementedError(self.open)
702
def register_format(klass, format):
703
klass._formats[format.get_format_string()] = format
706
def set_default_format(klass, format):
707
klass._default_format = format
710
def unregister_format(klass, format):
711
assert klass._formats[format.get_format_string()] is format
712
del klass._formats[format.get_format_string()]
715
return self.get_format_string().rstrip()
718
class BzrBranchFormat4(BranchFormat):
719
"""Bzr branch format 4.
722
- a revision-history file.
723
- a branch-lock lock file [ to be shared with the bzrdir ]
726
def get_format_description(self):
727
"""See BranchFormat.get_format_description()."""
728
return "Branch format 4"
730
def initialize(self, a_bzrdir):
731
"""Create a branch of this format in a_bzrdir."""
732
mutter('creating branch in %s', a_bzrdir.transport.base)
733
branch_transport = a_bzrdir.get_branch_transport(self)
734
utf8_files = [('revision-history', ''),
737
control_files = lockable_files.LockableFiles(branch_transport,
738
'branch-lock', lockable_files.TransportLock)
739
control_files.create_lock()
740
control_files.lock_write()
742
for file, content in utf8_files:
743
control_files.put_utf8(file, content)
745
control_files.unlock()
746
return self.open(a_bzrdir, _found=True)
749
super(BzrBranchFormat4, self).__init__()
750
self._matchingbzrdir = bzrdir.BzrDirFormat6()
752
def open(self, a_bzrdir, _found=False):
753
"""Return the branch object for a_bzrdir
755
_found is a private parameter, do not use it. It is used to indicate
756
if format probing has already be done.
759
# we are being called directly and must probe.
760
raise NotImplementedError
761
return BzrBranch(_format=self,
762
_control_files=a_bzrdir._control_files,
764
_repository=a_bzrdir.open_repository())
767
return "Bazaar-NG branch format 4"
770
class BzrBranchFormat5(BranchFormat):
771
"""Bzr branch format 5.
774
- a revision-history file.
776
- a lock dir guarding the branch itself
777
- all of this stored in a branch/ subdirectory
778
- works with shared repositories.
780
This format is new in bzr 0.8.
783
def get_format_string(self):
784
"""See BranchFormat.get_format_string()."""
785
return "Bazaar-NG branch format 5\n"
787
def get_format_description(self):
788
"""See BranchFormat.get_format_description()."""
789
return "Branch format 5"
791
def initialize(self, a_bzrdir):
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)
795
utf8_files = [('revision-history', ''),
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, )
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"
835
class BranchReferenceFormat(BranchFormat):
836
"""Bzr branch reference format.
838
Branch references are used in implementing checkouts, they
839
act as an alias to the real branch which is at some other url.
846
def get_format_string(self):
847
"""See BranchFormat.get_format_string()."""
848
return "Bazaar-NG Branch Reference Format 1\n"
850
def get_format_description(self):
851
"""See BranchFormat.get_format_description()."""
852
return "Checkout reference format 1"
854
def initialize(self, a_bzrdir, target_branch=None):
855
"""Create a branch of this format in a_bzrdir."""
856
if target_branch is None:
857
# this format does not implement branch itself, thus the implicit
858
# creation contract must see it as uninitializable
859
raise errors.UninitializableFormat(self)
860
mutter('creating branch reference in %s', a_bzrdir.transport.base)
861
branch_transport = a_bzrdir.get_branch_transport(self)
862
branch_transport.put_bytes('location',
863
target_branch.bzrdir.root_transport.base)
864
branch_transport.put_bytes('format', self.get_format_string())
865
return self.open(a_bzrdir, _found=True)
868
super(BranchReferenceFormat, self).__init__()
869
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
871
def _make_reference_clone_function(format, a_branch):
872
"""Create a clone() routine for a branch dynamically."""
873
def clone(to_bzrdir, revision_id=None):
874
"""See Branch.clone()."""
875
return format.initialize(to_bzrdir, a_branch)
876
# cannot obey revision_id limits when cloning a reference ...
877
# FIXME RBC 20060210 either nuke revision_id for clone, or
878
# emit some sort of warning/error to the caller ?!
881
def open(self, a_bzrdir, _found=False):
882
"""Return the branch that the branch reference in a_bzrdir points at.
884
_found is a private parameter, do not use it. It is used to indicate
885
if format probing has already be done.
888
format = BranchFormat.find_format(a_bzrdir)
889
assert format.__class__ == self.__class__
890
transport = a_bzrdir.get_branch_transport(None)
891
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
892
result = real_bzrdir.open_branch()
893
# this changes the behaviour of result.clone to create a new reference
894
# rather than a copy of the content of the branch.
895
# I did not use a proxy object because that needs much more extensive
896
# testing, and we are only changing one behaviour at the moment.
897
# If we decide to alter more behaviours - i.e. the implicit nickname
898
# then this should be refactored to introduce a tested proxy branch
899
# and a subclass of that for use in overriding clone() and ....
901
result.clone = self._make_reference_clone_function(result)
905
# formats which have no format string are not discoverable
906
# and not independently creatable, so are not registered.
907
__default_format = BzrBranchFormat5()
908
BranchFormat.register_format(__default_format)
909
BranchFormat.register_format(BranchReferenceFormat())
910
BranchFormat.set_default_format(__default_format)
911
_legacy_formats = [BzrBranchFormat4(),
914
class BzrBranch(Branch):
915
"""A branch stored in the actual filesystem.
917
Note that it's "local" in the context of the filesystem; it doesn't
918
really matter if it's on an nfs/smb/afs/coda/... share, as long as
919
it's writable, and can be accessed via the normal filesystem API.
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.
939
self.bzrdir = bzrdir.BzrDir.open(transport.base)
941
self.bzrdir = a_bzrdir
942
self._transport = self.bzrdir.transport.clone('..')
943
self._base = self._transport.base
944
self._format = _format
945
if _control_files is None:
946
raise ValueError('BzrBranch _control_files is None')
947
self.control_files = _control_files
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().",
974
self.repository = _repository
977
return '%s(%r)' % (self.__class__.__name__, self.base)
984
base = property(_get_base, doc="The URL for the root of this branch.")
986
def _finish_transaction(self):
987
"""Exit the current transaction."""
988
return self.control_files._finish_transaction()
990
def get_transaction(self):
991
"""Return the current active transaction.
993
If no transaction is active, this returns a passthrough object
994
for which all data is immediately flushed and no caching happens.
996
# this is an explicit function so that we can do tricky stuff
997
# when the storage in rev_storage is elsewhere.
998
# we probably need to hook the two 'lock a location' and
999
# 'have a transaction' together more delicately, so that
1000
# we can have two locks (branch and storage) and one transaction
1001
# ... and finishing the transaction unlocks both, but unlocking
1002
# does not. - RBC 20051121
1003
return self.control_files.get_transaction()
1005
def _set_transaction(self, transaction):
1006
"""Set a new active transaction."""
1007
return self.control_files._set_transaction(transaction)
1009
def abspath(self, name):
1010
"""See Branch.abspath."""
1011
return self.control_files._transport.abspath(name)
1013
def _check_format(self, format):
1014
"""Identify the branch format if needed.
1016
The format is stored as a reference to the format object in
1017
self._format for code that needs to check it later.
1019
The format parameter is either None or the branch format class
1020
used to open this branch.
1022
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1025
format = BranchFormat.find_format(self.bzrdir)
1026
self._format = format
1027
mutter("got branch format %s", self._format)
1030
def get_root_id(self):
1031
"""See Branch.get_root_id."""
1032
tree = self.repository.revision_tree(self.last_revision())
1033
return tree.inventory.root.file_id
1035
def is_locked(self):
1036
return self.control_files.is_locked()
1038
def lock_write(self):
1039
self.repository.lock_write()
1041
self.control_files.lock_write()
1043
self.repository.unlock()
1046
def lock_read(self):
1047
self.repository.lock_read()
1049
self.control_files.lock_read()
1051
self.repository.unlock()
1055
# TODO: test for failed two phase locks. This is known broken.
1057
self.control_files.unlock()
1059
self.repository.unlock()
1061
def peek_lock_mode(self):
1062
if self.control_files._lock_count == 0:
1065
return self.control_files._lock_mode
1067
def get_physical_lock_status(self):
1068
return self.control_files.get_physical_lock_status()
1071
def print_file(self, file, revision_id):
1072
"""See Branch.print_file."""
1073
return self.repository.print_file(file, revision_id)
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)
1085
def set_revision_history(self, rev_history):
1086
"""See Branch.set_revision_history."""
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,
1123
"""Create a new revision history that will finish with revision_id.
1125
:param revision_id: the new tip to use.
1126
:param last_rev: The previous last_revision. If not None, then this
1127
must be a ancestory of revision_id, or DivergedBranches is raised.
1128
:param other_branch: The other branch that DivergedBranches should
1129
raise with respect to.
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,
1174
def basis_tree(self):
1175
"""See Branch.basis_tree."""
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()
1189
def pull(self, source, overwrite=False, stop_revision=None):
1190
"""See Branch.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
1206
def get_parent(self):
1207
"""See Branch.get_parent."""
1209
_locs = ['parent', 'pull', 'x-pull']
1210
assert self.base[-1] == '/'
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)
1226
def get_push_location(self):
1227
"""See Branch.get_push_location."""
1228
push_loc = self.get_config().get_user_option('push_location')
1231
def set_push_location(self, location):
1232
"""See Branch.set_push_location."""
1233
self.get_config().set_user_option('push_location', location,
1237
def set_parent(self, url):
1238
"""See Branch.set_parent."""
1239
# TODO: Maybe delete old location files?
1240
# URLs should never be unicode, even on the local fs,
1241
# FIXUP this and get_parent in a future branch format bump:
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')
1247
if isinstance(url, unicode):
1249
url = url.encode('ascii')
1250
except UnicodeEncodeError:
1251
raise bzrlib.errors.InvalidURL(url,
1252
"Urls must be 7-bit ascii, "
1253
"use bzrlib.urlutils.escape")
1255
url = urlutils.relative_url(self.base, url)
1256
self.control_files.put('parent', StringIO(url + '\n'))
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)
1265
class BzrBranch5(BzrBranch):
1266
"""A format 5 branch. This supports new features over plan branches.
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)
1282
def pull(self, source, overwrite=False, stop_revision=None):
1283
"""Updates branch.pull to be bound branch aware."""
1284
bound_location = self.get_bound_location()
1285
if source.base != bound_location:
1286
# not pulling from master, so we need to update master.
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)
1293
def get_bound_location(self):
1295
return self.control_files.get_utf8('bound').read()[:-1]
1296
except errors.NoSuchFile:
1300
def get_master_branch(self):
1301
"""Return the branch we are bound to.
1303
:return: Either a Branch, or None
1305
This could memoise the branch, but if thats done
1306
it must be revalidated on each new lock.
1307
So for now we just don't memoise it.
1308
# RBC 20060304 review this decision.
1310
bound_loc = self.get_bound_location()
1314
return Branch.open(bound_loc)
1315
except (errors.NotBranchError, errors.ConnectionError), e:
1316
raise errors.BoundBranchConnectionFailure(
1320
def set_bound_location(self, location):
1321
"""Set the target where this branch is bound to.
1323
:param location: URL to the target branch
1326
self.control_files.put_utf8('bound', location+'\n')
1329
self.control_files._transport.delete('bound')
1335
def bind(self, other):
1336
"""Bind this branch to the branch other.
1338
This does not push or pull data between the branches, though it does
1339
check for divergence to raise an error when the branches are not
1340
either the same, or one a prefix of the other. That behaviour may not
1341
be useful, so that check may be removed in future.
1343
:param other: The branch to bind to
1346
# TODO: jam 20051230 Consider checking if the target is bound
1347
# It is debatable whether you should be able to bind to
1348
# a branch which is itself bound.
1349
# Committing is obviously forbidden,
1350
# but binding itself may not be.
1351
# Since we *have* to check at commit time, we don't
1352
# *need* to check here
1354
# we want to raise diverged if:
1355
# last_rev is not in the other_last_rev history, AND
1356
# other_last_rev is not in our history, and do it without pulling
1358
last_rev = self.last_revision()
1359
if last_rev is not None:
1362
other_last_rev = other.last_revision()
1363
if other_last_rev is not None:
1364
# neither branch is new, we have to do some work to
1365
# ascertain diversion.
1366
remote_graph = other.repository.get_revision_graph(
1368
local_graph = self.repository.get_revision_graph(last_rev)
1369
if (last_rev not in remote_graph and
1370
other_last_rev not in local_graph):
1371
raise errors.DivergedBranches(self, other)
1374
self.set_bound_location(other.base)
1378
"""If bound, unbind"""
1379
return self.set_bound_location(None)
1383
"""Synchronise this branch with the master branch if any.
1385
:return: None or the last_revision that was pivoted out during the
1388
master = self.get_master_branch()
1389
if master is not None:
1390
old_tip = self.last_revision()
1391
self.pull(master, overwrite=True)
1392
if old_tip in self.repository.get_ancestry(self.last_revision()):
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)
1428
class BranchCheckResult(object):
1429
"""Results of checking branch consistency.
1434
def __init__(self, branch):
1435
self.branch = branch
1437
def report_results(self, verbose):
1438
"""Report the check results via trace.note.
1440
:param verbose: Requests more detailed display of what was checked,
1443
note('checked branch %s format %s',
1445
self.branch._format)
1264
1448
######################################################################
1268
def is_control_file(filename):
1269
## FIXME: better check
1270
filename = os.path.normpath(filename)
1271
while filename != '':
1272
head, tail = os.path.split(filename)
1273
## mutter('check %r for control file' % ((head, tail), ))
1274
if tail == bzrlib.BZRDIR:
1276
if filename == head:
1283
def gen_file_id(name):
1284
"""Return new file id.
1286
This should probably generate proper UUIDs, but for the moment we
1287
cope with just randomness because running uuidgen every time is
1290
from binascii import hexlify
1291
from time import time
1293
# get last component
1294
idx = name.rfind('/')
1296
name = name[idx+1 : ]
1297
idx = name.rfind('\\')
1299
name = name[idx+1 : ]
1301
# make it not a hidden file
1302
name = name.lstrip('.')
1304
# remove any wierd characters; we don't escape them but rather
1305
# just pull them out
1306
name = re.sub(r'[^\w.]', '', name)
1308
s = hexlify(rand_bytes(8))
1309
return '-'.join((name, compact_date(time()), s))
1313
"""Return a new tree-root file id."""
1314
return gen_file_id('TREE_ROOT')
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
