134
140
raise NotImplementedError(self.needs_format_conversion)
136
def create_repository(self, shared=False):
137
"""Create a new repository in this control directory.
139
:param shared: If a shared repository should be created
140
:return: The newly created repository
142
raise NotImplementedError(self.create_repository)
144
142
def destroy_repository(self):
145
143
"""Destroy the repository in this ControlDir."""
146
144
raise NotImplementedError(self.destroy_repository)
148
def create_branch(self, name=None, repository=None):
146
def create_branch(self, name=None):
149
147
"""Create a branch in this ControlDir.
151
149
:param name: Name of the colocated branch to create, None for
207
205
raise errors.NoColocatedBranchSupport(self)
208
def get_branch_transport(self, branch_format, name=None):
209
"""Get the transport for use by branch format in this ControlDir.
211
Note that bzr dirs that do not support format strings will raise
212
IncompatibleFormat if the branch format they are given has
213
a format string, and vice versa.
215
If branch_format is None, the transport is returned with no
216
checking. If it is not None, then the returned transport is
217
guaranteed to point to an existing directory ready for use.
219
raise NotImplementedError(self.get_branch_transport)
221
def get_repository_transport(self, repository_format):
222
"""Get the transport for use by repository format in this ControlDir.
224
Note that bzr dirs that do not support format strings will raise
225
IncompatibleFormat if the repository format they are given has
226
a format string, and vice versa.
228
If repository_format is None, the transport is returned with no
229
checking. If it is not None, then the returned transport is
230
guaranteed to point to an existing directory ready for use.
232
raise NotImplementedError(self.get_repository_transport)
234
def get_workingtree_transport(self, tree_format):
235
"""Get the transport for use by workingtree format in this ControlDir.
237
Note that bzr dirs that do not support format strings will raise
238
IncompatibleFormat if the workingtree format they are given has a
239
format string, and vice versa.
241
If workingtree_format is None, the transport is returned with no
242
checking. If it is not None, then the returned transport is
243
guaranteed to point to an existing directory ready for use.
245
raise NotImplementedError(self.get_workingtree_transport)
210
247
def open_branch(self, name=None, unsupported=False,
211
248
ignore_fallbacks=False):
212
249
"""Open the branch object at this ControlDir if one is present.
327
364
:param create_tree_if_local: If true, a working-tree will be created
328
365
when working locally.
330
raise NotImplementedError(self.sprout)
367
target_transport = get_transport(url, possible_transports)
368
target_transport.ensure_base()
369
cloning_format = self.cloning_metadir(stacked)
370
# Create/update the result branch
371
result = cloning_format.initialize_on_transport(target_transport)
372
# if a stacked branch wasn't requested, we don't create one
373
# even if the origin was stacked
374
stacked_branch_url = None
375
if source_branch is not None:
377
stacked_branch_url = self.root_transport.base
378
source_repository = source_branch.repository
381
source_branch = self.open_branch()
382
source_repository = source_branch.repository
384
stacked_branch_url = self.root_transport.base
385
except errors.NotBranchError:
388
source_repository = self.open_repository()
389
except errors.NoRepositoryPresent:
390
source_repository = None
391
repository_policy = result.determine_repository_policy(
392
force_new_repo, stacked_branch_url, require_stacking=stacked)
393
result_repo, is_new_repo = repository_policy.acquire_repository()
394
is_stacked = stacked or (len(result_repo._fallback_repositories) != 0)
395
if is_new_repo and revision_id is not None and not is_stacked:
396
fetch_spec = graph.PendingAncestryResult(
397
[revision_id], source_repository)
400
if source_repository is not None:
401
# Fetch while stacked to prevent unstacked fetch from
403
if fetch_spec is None:
404
result_repo.fetch(source_repository, revision_id=revision_id)
406
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
408
if source_branch is None:
409
# this is for sprouting a controldir without a branch; is that
411
# Not especially, but it's part of the contract.
412
result_branch = result.create_branch()
414
result_branch = source_branch.sprout(result,
415
revision_id=revision_id, repository_policy=repository_policy)
416
mutter("created new branch %r" % (result_branch,))
418
# Create/update the result working tree
419
if (create_tree_if_local and
420
isinstance(target_transport, local.LocalTransport) and
421
(result_repo is None or result_repo.make_working_trees())):
422
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
426
if wt.path2id('') is None:
428
wt.set_root_id(self.open_workingtree.get_root_id())
429
except errors.NoWorkingTree:
435
if recurse == 'down':
437
basis = wt.basis_tree()
439
subtrees = basis.iter_references()
440
elif result_branch is not None:
441
basis = result_branch.basis_tree()
443
subtrees = basis.iter_references()
444
elif source_branch is not None:
445
basis = source_branch.basis_tree()
447
subtrees = basis.iter_references()
452
for path, file_id in subtrees:
453
target = urlutils.join(url, urlutils.escape(path))
454
sublocation = source_branch.reference_parent(file_id, path)
455
sublocation.bzrdir.sprout(target,
456
basis.get_reference_revision(file_id, path),
457
force_new_repo=force_new_repo, recurse=recurse,
460
if basis is not None:
332
464
def push_branch(self, source, revision_id=None, overwrite=False,
333
465
remember=False, create_prefix=False):
436
564
:param preserve_stacking: When cloning a stacked branch, stack the
437
565
new branch on top of the other branch's stacked-on branch.
439
return self.clone_on_transport(_mod_transport.get_transport(url),
567
return self.clone_on_transport(get_transport(url),
440
568
revision_id=revision_id,
441
569
force_new_repo=force_new_repo,
442
570
preserve_stacking=preserve_stacking)
444
572
def clone_on_transport(self, transport, revision_id=None,
445
573
force_new_repo=False, preserve_stacking=False, stacked_on=None,
446
create_prefix=False, use_existing_dir=True, no_tree=False):
574
create_prefix=False, use_existing_dir=True):
447
575
"""Clone this bzrdir and its contents to transport verbatim.
449
577
:param transport: The transport for the location to produce the clone
458
586
:param create_prefix: Create any missing directories leading up to
460
588
:param use_existing_dir: Use an existing directory if one exists.
461
:param no_tree: If set to true prevents creation of a working tree.
463
590
raise NotImplementedError(self.clone_on_transport)
466
class ControlComponentFormat(object):
467
"""A component that can live inside of a .bzr meta directory."""
469
upgrade_recommended = False
471
def get_format_string(self):
472
"""Return the format of this format, if usable in meta directories."""
473
raise NotImplementedError(self.get_format_string)
475
def get_format_description(self):
476
"""Return the short description for this format."""
477
raise NotImplementedError(self.get_format_description)
479
def is_supported(self):
480
"""Is this format supported?
482
Supported formats must be initializable and openable.
483
Unsupported formats may not support initialization or committing or
484
some other features depending on the reason for not being supported.
488
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
490
"""Give an error or warning on old formats.
492
:param allow_unsupported: If true, allow opening
493
formats that are strongly deprecated, and which may
494
have limited functionality.
496
:param recommend_upgrade: If true (default), warn
497
the user through the ui object that they may wish
498
to upgrade the object.
500
if not allow_unsupported and not self.is_supported():
501
# see open_downlevel to open legacy branches.
502
raise errors.UnsupportedFormatError(format=self)
503
if recommend_upgrade and self.upgrade_recommended:
504
ui.ui_factory.recommend_upgrade(
505
self.get_format_description(), basedir)
508
class ControlComponentFormatRegistry(registry.FormatRegistry):
509
"""A registry for control components (branch, workingtree, repository)."""
511
def __init__(self, other_registry=None):
512
super(ControlComponentFormatRegistry, self).__init__(other_registry)
513
self._extra_formats = []
515
def register(self, format):
516
"""Register a new format."""
517
super(ControlComponentFormatRegistry, self).register(
518
format.get_format_string(), format)
520
def remove(self, format):
521
"""Remove a registered format."""
522
super(ControlComponentFormatRegistry, self).remove(
523
format.get_format_string())
525
def register_extra(self, format):
526
"""Register a format that can not be used in a metadir.
528
This is mainly useful to allow custom repository formats, such as older
529
Bazaar formats and foreign formats, to be tested.
531
self._extra_formats.append(registry._ObjectGetter(format))
533
def remove_extra(self, format):
534
"""Remove an extra format.
536
self._extra_formats.remove(registry._ObjectGetter(format))
538
def register_extra_lazy(self, module_name, member_name):
539
"""Register a format lazily.
541
self._extra_formats.append(
542
registry._LazyObjectGetter(module_name, member_name))
544
def _get_extra(self):
545
"""Return all "extra" formats, not usable in meta directories."""
547
for getter in self._extra_formats:
555
"""Return all formats, even those not usable in metadirs.
558
for name in self.keys():
563
return result + self._get_extra()
565
def _get_all_modules(self):
566
"""Return a set of the modules providing objects."""
568
for name in self.keys():
569
modules.add(self._get_module(name))
570
for getter in self._extra_formats:
571
modules.add(getter.get_module())
575
class Converter(object):
576
"""Converts a disk format object from one format to another."""
578
def convert(self, to_convert, pb):
579
"""Perform the conversion of to_convert, giving feedback via pb.
581
:param to_convert: The disk object to convert.
582
:param pb: a progress bar to use for progress information.
585
def step(self, message):
586
"""Update the pb by a step."""
588
self.pb.update(message, self.count, self.total)
591
593
class ControlDirFormat(object):
592
594
"""An encapsulation of the initialization and open routines for a format.
669
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
671
"""Give an error or warning on old formats.
673
:param allow_unsupported: If true, allow opening
674
formats that are strongly deprecated, and which may
675
have limited functionality.
677
:param recommend_upgrade: If true (default), warn
678
the user through the ui object that they may wish
679
to upgrade the object.
681
if not allow_unsupported and not self.is_supported():
682
# see open_downlevel to open legacy branches.
683
raise errors.UnsupportedFormatError(format=self)
684
if recommend_upgrade and self.upgrade_recommended:
685
ui.ui_factory.recommend_upgrade(
686
self.get_format_description(), basedir)
688
668
def same_model(self, target_format):
689
669
return (self.repository_format.rich_root_data ==
690
670
target_format.rich_root_data)
831
810
class Prober(object):
832
"""Abstract class that can be used to detect a particular kind of
811
"""Abstract class that can be used to detect a particular kind of
833
812
control directory.
835
At the moment this just contains a single method to probe a particular
836
transport, but it may be extended in the future to e.g. avoid
814
At the moment this just contains a single method to probe a particular
815
transport, but it may be extended in the future to e.g. avoid
837
816
multiple levels of probing for Subversion repositories.
839
See BzrProber and RemoteBzrProber in bzrlib.bzrdir for the
840
probers that detect .bzr/ directories and Bazaar smart servers,
843
Probers should be registered using the register_server_prober or
844
register_prober methods on ControlDirFormat.
847
819
def probe_transport(self, transport):
added
removed
bzrlib/controldir.py
