140
138
raise NotImplementedError(self.needs_format_conversion)
140
def create_repository(self, shared=False):
141
"""Create a new repository in this control directory.
143
:param shared: If a shared repository should be created
144
:return: The newly created repository
146
raise NotImplementedError(self.create_repository)
142
148
def destroy_repository(self):
143
149
"""Destroy the repository in this ControlDir."""
144
150
raise NotImplementedError(self.destroy_repository)
146
def create_branch(self, name=None):
152
def create_branch(self, name=None, repository=None):
147
153
"""Create a branch in this ControlDir.
149
155
:param name: Name of the colocated branch to create, None for
205
211
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)
247
214
def open_branch(self, name=None, unsupported=False,
248
215
ignore_fallbacks=False):
249
216
"""Open the branch object at this ControlDir if one is present.
364
331
:param create_tree_if_local: If true, a working-tree will be created
365
332
when working locally.
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:
334
raise NotImplementedError(self.sprout)
464
336
def push_branch(self, source, revision_id=None, overwrite=False,
465
337
remember=False, create_prefix=False):
564
440
:param preserve_stacking: When cloning a stacked branch, stack the
565
441
new branch on top of the other branch's stacked-on branch.
567
return self.clone_on_transport(get_transport(url),
443
return self.clone_on_transport(_mod_transport.get_transport(url),
568
444
revision_id=revision_id,
569
445
force_new_repo=force_new_repo,
570
446
preserve_stacking=preserve_stacking)
572
448
def clone_on_transport(self, transport, revision_id=None,
573
449
force_new_repo=False, preserve_stacking=False, stacked_on=None,
574
create_prefix=False, use_existing_dir=True):
450
create_prefix=False, use_existing_dir=True, no_tree=False):
575
451
"""Clone this bzrdir and its contents to transport verbatim.
577
453
:param transport: The transport for the location to produce the clone
586
462
:param create_prefix: Create any missing directories leading up to
588
464
:param use_existing_dir: Use an existing directory if one exists.
465
:param no_tree: If set to true prevents creation of a working tree.
590
467
raise NotImplementedError(self.clone_on_transport)
470
class ControlComponentFormat(object):
471
"""A component that can live inside of a .bzr meta directory."""
473
upgrade_recommended = False
475
def get_format_string(self):
476
"""Return the format of this format, if usable in meta directories."""
477
raise NotImplementedError(self.get_format_string)
479
def get_format_description(self):
480
"""Return the short description for this format."""
481
raise NotImplementedError(self.get_format_description)
483
def is_supported(self):
484
"""Is this format supported?
486
Supported formats must be initializable and openable.
487
Unsupported formats may not support initialization or committing or
488
some other features depending on the reason for not being supported.
492
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
494
"""Give an error or warning on old formats.
496
:param allow_unsupported: If true, allow opening
497
formats that are strongly deprecated, and which may
498
have limited functionality.
500
:param recommend_upgrade: If true (default), warn
501
the user through the ui object that they may wish
502
to upgrade the object.
504
if not allow_unsupported and not self.is_supported():
505
# see open_downlevel to open legacy branches.
506
raise errors.UnsupportedFormatError(format=self)
507
if recommend_upgrade and self.upgrade_recommended:
508
ui.ui_factory.recommend_upgrade(
509
self.get_format_description(), basedir)
512
class ControlComponentFormatRegistry(registry.FormatRegistry):
513
"""A registry for control components (branch, workingtree, repository)."""
515
def __init__(self, other_registry=None):
516
super(ControlComponentFormatRegistry, self).__init__(other_registry)
517
self._extra_formats = []
519
def register(self, format):
520
"""Register a new format."""
521
super(ControlComponentFormatRegistry, self).register(
522
format.get_format_string(), format)
524
def remove(self, format):
525
"""Remove a registered format."""
526
super(ControlComponentFormatRegistry, self).remove(
527
format.get_format_string())
529
def register_extra(self, format):
530
"""Register a format that can not be used in a metadir.
532
This is mainly useful to allow custom repository formats, such as older
533
Bazaar formats and foreign formats, to be tested.
535
self._extra_formats.append(registry._ObjectGetter(format))
537
def remove_extra(self, format):
538
"""Remove an extra format.
540
self._extra_formats.remove(registry._ObjectGetter(format))
542
def register_extra_lazy(self, module_name, member_name):
543
"""Register a format lazily.
545
self._extra_formats.append(
546
registry._LazyObjectGetter(module_name, member_name))
548
def _get_extra(self):
549
"""Return all "extra" formats, not usable in meta directories."""
551
for getter in self._extra_formats:
559
"""Return all formats, even those not usable in metadirs.
562
for name in self.keys():
567
return result + self._get_extra()
569
def _get_all_modules(self):
570
"""Return a set of the modules providing objects."""
572
for name in self.keys():
573
modules.add(self._get_module(name))
574
for getter in self._extra_formats:
575
modules.add(getter.get_module())
579
class Converter(object):
580
"""Converts a disk format object from one format to another."""
582
def convert(self, to_convert, pb):
583
"""Perform the conversion of to_convert, giving feedback via pb.
585
:param to_convert: The disk object to convert.
586
:param pb: a progress bar to use for progress information.
589
def step(self, message):
590
"""Update the pb by a step."""
592
self.pb.update(message, self.count, self.total)
593
595
class ControlDirFormat(object):
594
596
"""An encapsulation of the initialization and open routines for a format.
673
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
675
"""Give an error or warning on old formats.
677
:param allow_unsupported: If true, allow opening
678
formats that are strongly deprecated, and which may
679
have limited functionality.
681
:param recommend_upgrade: If true (default), warn
682
the user through the ui object that they may wish
683
to upgrade the object.
685
if not allow_unsupported and not self.is_supported():
686
# see open_downlevel to open legacy branches.
687
raise errors.UnsupportedFormatError(format=self)
688
if recommend_upgrade and self.upgrade_recommended:
689
ui.ui_factory.recommend_upgrade(
690
self.get_format_description(), basedir)
668
692
def same_model(self, target_format):
669
693
return (self.repository_format.rich_root_data ==
670
694
target_format.rich_root_data)
810
835
class Prober(object):
811
"""Abstract class that can be used to detect a particular kind of
836
"""Abstract class that can be used to detect a particular kind of
812
837
control directory.
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
839
At the moment this just contains a single method to probe a particular
840
transport, but it may be extended in the future to e.g. avoid
816
841
multiple levels of probing for Subversion repositories.
843
See BzrProber and RemoteBzrProber in bzrlib.bzrdir for the
844
probers that detect .bzr/ directories and Bazaar smart servers,
847
Probers should be registered using the register_server_prober or
848
register_prober methods on ControlDirFormat.
819
851
def probe_transport(self, transport):
added
removed
bzrlib/controldir.py
