140
134
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)
142
144
def destroy_repository(self):
143
145
"""Destroy the repository in this ControlDir."""
144
146
raise NotImplementedError(self.destroy_repository)
146
def create_branch(self, name=None):
148
def create_branch(self, name=None, repository=None,
149
append_revisions_only=None):
147
150
"""Create a branch in this ControlDir.
149
152
:param name: Name of the colocated branch to create, None for
150
153
the default branch.
154
:param append_revisions_only: Whether this branch should only allow
155
appending new revisions to its history.
152
157
The controldirs format will control what branch format is created.
153
158
For more control see BranchFormatXX.create(a_controldir).
205
217
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
220
def open_branch(self, name=None, unsupported=False,
248
221
ignore_fallbacks=False):
249
222
"""Open the branch object at this ControlDir if one is present.
364
348
:param create_tree_if_local: If true, a working-tree will be created
365
349
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:
351
raise NotImplementedError(self.sprout)
464
353
def push_branch(self, source, revision_id=None, overwrite=False,
465
354
remember=False, create_prefix=False):
564
457
:param preserve_stacking: When cloning a stacked branch, stack the
565
458
new branch on top of the other branch's stacked-on branch.
567
return self.clone_on_transport(get_transport(url),
460
return self.clone_on_transport(_mod_transport.get_transport(url),
568
461
revision_id=revision_id,
569
462
force_new_repo=force_new_repo,
570
463
preserve_stacking=preserve_stacking)
572
465
def clone_on_transport(self, transport, revision_id=None,
573
466
force_new_repo=False, preserve_stacking=False, stacked_on=None,
574
create_prefix=False, use_existing_dir=True):
467
create_prefix=False, use_existing_dir=True, no_tree=False):
575
468
"""Clone this bzrdir and its contents to transport verbatim.
577
470
:param transport: The transport for the location to produce the clone
586
479
:param create_prefix: Create any missing directories leading up to
588
481
:param use_existing_dir: Use an existing directory if one exists.
482
:param no_tree: If set to true prevents creation of a working tree.
590
484
raise NotImplementedError(self.clone_on_transport)
487
class ControlComponentFormat(object):
488
"""A component that can live inside of a .bzr meta directory."""
490
upgrade_recommended = False
492
def get_format_string(self):
493
"""Return the format of this format, if usable in meta directories."""
494
raise NotImplementedError(self.get_format_string)
496
def get_format_description(self):
497
"""Return the short description for this format."""
498
raise NotImplementedError(self.get_format_description)
500
def is_supported(self):
501
"""Is this format supported?
503
Supported formats must be initializable and openable.
504
Unsupported formats may not support initialization or committing or
505
some other features depending on the reason for not being supported.
509
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
511
"""Give an error or warning on old formats.
513
:param allow_unsupported: If true, allow opening
514
formats that are strongly deprecated, and which may
515
have limited functionality.
517
:param recommend_upgrade: If true (default), warn
518
the user through the ui object that they may wish
519
to upgrade the object.
521
if not allow_unsupported and not self.is_supported():
522
# see open_downlevel to open legacy branches.
523
raise errors.UnsupportedFormatError(format=self)
524
if recommend_upgrade and self.upgrade_recommended:
525
ui.ui_factory.recommend_upgrade(
526
self.get_format_description(), basedir)
529
class ControlComponentFormatRegistry(registry.FormatRegistry):
530
"""A registry for control components (branch, workingtree, repository)."""
532
def __init__(self, other_registry=None):
533
super(ControlComponentFormatRegistry, self).__init__(other_registry)
534
self._extra_formats = []
536
def register(self, format):
537
"""Register a new format."""
538
super(ControlComponentFormatRegistry, self).register(
539
format.get_format_string(), format)
541
def remove(self, format):
542
"""Remove a registered format."""
543
super(ControlComponentFormatRegistry, self).remove(
544
format.get_format_string())
546
def register_extra(self, format):
547
"""Register a format that can not be used in a metadir.
549
This is mainly useful to allow custom repository formats, such as older
550
Bazaar formats and foreign formats, to be tested.
552
self._extra_formats.append(registry._ObjectGetter(format))
554
def remove_extra(self, format):
555
"""Remove an extra format.
557
self._extra_formats.remove(registry._ObjectGetter(format))
559
def register_extra_lazy(self, module_name, member_name):
560
"""Register a format lazily.
562
self._extra_formats.append(
563
registry._LazyObjectGetter(module_name, member_name))
565
def _get_extra(self):
566
"""Return all "extra" formats, not usable in meta directories."""
568
for getter in self._extra_formats:
576
"""Return all formats, even those not usable in metadirs.
579
for name in self.keys():
584
return result + self._get_extra()
586
def _get_all_modules(self):
587
"""Return a set of the modules providing objects."""
589
for name in self.keys():
590
modules.add(self._get_module(name))
591
for getter in self._extra_formats:
592
modules.add(getter.get_module())
596
class Converter(object):
597
"""Converts a disk format object from one format to another."""
599
def convert(self, to_convert, pb):
600
"""Perform the conversion of to_convert, giving feedback via pb.
602
:param to_convert: The disk object to convert.
603
:param pb: a progress bar to use for progress information.
606
def step(self, message):
607
"""Update the pb by a step."""
609
self.pb.update(message, self.count, self.total)
593
612
class ControlDirFormat(object):
594
613
"""An encapsulation of the initialization and open routines for a format.
659
681
def is_supported(self):
660
682
"""Is this format supported?
662
Supported formats must be initializable and openable.
684
Supported formats must be openable.
663
685
Unsupported formats may not support initialization or committing or
664
686
some other features depending on the reason for not being supported.
690
def is_initializable(self):
691
"""Whether new control directories of this format can be initialized.
693
return self.is_supported()
695
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
697
"""Give an error or warning on old formats.
699
:param allow_unsupported: If true, allow opening
700
formats that are strongly deprecated, and which may
701
have limited functionality.
703
:param recommend_upgrade: If true (default), warn
704
the user through the ui object that they may wish
705
to upgrade the object.
707
if not allow_unsupported and not self.is_supported():
708
# see open_downlevel to open legacy branches.
709
raise errors.UnsupportedFormatError(format=self)
710
if recommend_upgrade and self.upgrade_recommended:
711
ui.ui_factory.recommend_upgrade(
712
self.get_format_description(), basedir)
668
714
def same_model(self, target_format):
669
715
return (self.repository_format.rich_root_data ==
670
716
target_format.rich_root_data)
810
857
class Prober(object):
811
"""Abstract class that can be used to detect a particular kind of
858
"""Abstract class that can be used to detect a particular kind of
812
859
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
861
At the moment this just contains a single method to probe a particular
862
transport, but it may be extended in the future to e.g. avoid
816
863
multiple levels of probing for Subversion repositories.
865
See BzrProber and RemoteBzrProber in bzrlib.bzrdir for the
866
probers that detect .bzr/ directories and Bazaar smart servers,
869
Probers should be registered using the register_server_prober or
870
register_prober methods on ControlDirFormat.
819
873
def probe_transport(self, transport):
added
removed
bzrlib/controldir.py
