1
# Copyright (C) 2010, 2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""ControlDir is the basic control directory class.
19
The ControlDir class is the base for the control directory used
20
by all bzr and foreign formats. For the ".bzr" implementation,
21
see bzrlib.bzrdir.BzrDir.
25
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
34
revision as _mod_revision,
35
transport as _mod_transport,
38
from bzrlib.push import (
41
from bzrlib.trace import (
44
from bzrlib.transport import (
50
from bzrlib import registry
53
class ControlComponent(object):
54
"""Abstract base class for control directory components.
56
This provides interfaces that are common across controldirs,
57
repositories, branches, and workingtree control directories.
59
They all expose two urls and transports: the *user* URL is the
60
one that stops above the control directory (eg .bzr) and that
61
should normally be used in messages, and the *control* URL is
62
under that in eg .bzr/checkout and is used to read the control
65
This can be used as a mixin and is intended to fit with
70
def control_transport(self):
71
raise NotImplementedError
74
def control_url(self):
75
return self.control_transport.base
78
def user_transport(self):
79
raise NotImplementedError
83
return self.user_transport.base
86
class ControlDir(ControlComponent):
87
"""A control directory.
89
While this represents a generic control directory, there are a few
90
features that are present in this interface that are currently only
91
supported by one of its implementations, BzrDir.
93
These features (bound branches, stacked branches) are currently only
94
supported by Bazaar, but could be supported by other version control
95
systems as well. Implementations are required to raise the appropriate
96
exceptions when an operation is requested that is not supported.
98
This also makes life easier for API users who can rely on the
99
implementation always allowing a particular feature to be requested but
100
raising an exception when it is not supported, rather than requiring the
101
API users to check for magic attributes to see what features are supported.
104
def can_convert_format(self):
105
"""Return true if this controldir is one whose format we can convert
109
def list_branches(self):
110
"""Return a sequence of all branches local to this control directory.
114
return [self.open_branch()]
115
except (errors.NotBranchError, errors.NoRepositoryPresent):
118
def is_control_filename(self, filename):
119
"""True if filename is the name of a path which is reserved for
122
:param filename: A filename within the root transport of this
125
This is true IF and ONLY IF the filename is part of the namespace reserved
126
for bzr control dirs. Currently this is the '.bzr' directory in the root
127
of the root_transport. it is expected that plugins will need to extend
128
this in the future - for instance to make bzr talk with svn working
131
raise NotImplementedError(self.is_control_filename)
133
def needs_format_conversion(self, format=None):
134
"""Return true if this controldir needs convert_format run on it.
136
For instance, if the repository format is out of date but the
137
branch and working tree are not, this should return True.
139
:param format: Optional parameter indicating a specific desired
140
format we plan to arrive at.
142
raise NotImplementedError(self.needs_format_conversion)
144
def create_repository(self, shared=False):
145
"""Create a new repository in this control directory.
147
:param shared: If a shared repository should be created
148
:return: The newly created repository
150
raise NotImplementedError(self.create_repository)
152
def destroy_repository(self):
153
"""Destroy the repository in this ControlDir."""
154
raise NotImplementedError(self.destroy_repository)
156
def create_branch(self, name=None, repository=None):
157
"""Create a branch in this ControlDir.
159
:param name: Name of the colocated branch to create, None for
162
The controldirs format will control what branch format is created.
163
For more control see BranchFormatXX.create(a_controldir).
165
raise NotImplementedError(self.create_branch)
167
def destroy_branch(self, name=None):
168
"""Destroy a branch in this ControlDir.
170
:param name: Name of the branch to destroy, None for the default
173
raise NotImplementedError(self.destroy_branch)
175
def create_workingtree(self, revision_id=None, from_branch=None,
176
accelerator_tree=None, hardlink=False):
177
"""Create a working tree at this ControlDir.
179
:param revision_id: create it as of this revision id.
180
:param from_branch: override controldir branch
181
(for lightweight checkouts)
182
:param accelerator_tree: A tree which can be used for retrieving file
183
contents more quickly than the revision tree, i.e. a workingtree.
184
The revision tree will be used for cases where accelerator_tree's
185
content is different.
187
raise NotImplementedError(self.create_workingtree)
189
def destroy_workingtree(self):
190
"""Destroy the working tree at this ControlDir.
192
Formats that do not support this may raise UnsupportedOperation.
194
raise NotImplementedError(self.destroy_workingtree)
196
def destroy_workingtree_metadata(self):
197
"""Destroy the control files for the working tree at this ControlDir.
199
The contents of working tree files are not affected.
200
Formats that do not support this may raise UnsupportedOperation.
202
raise NotImplementedError(self.destroy_workingtree_metadata)
204
def get_branch_reference(self, name=None):
205
"""Return the referenced URL for the branch in this controldir.
207
:param name: Optional colocated branch name
208
:raises NotBranchError: If there is no Branch.
209
:raises NoColocatedBranchSupport: If a branch name was specified
210
but colocated branches are not supported.
211
:return: The URL the branch in this controldir references if it is a
212
reference branch, or None for regular branches.
215
raise errors.NoColocatedBranchSupport(self)
218
def open_branch(self, name=None, unsupported=False,
219
ignore_fallbacks=False):
220
"""Open the branch object at this ControlDir if one is present.
222
If unsupported is True, then no longer supported branch formats can
225
TODO: static convenience version of this?
227
raise NotImplementedError(self.open_branch)
229
def open_repository(self, _unsupported=False):
230
"""Open the repository object at this ControlDir if one is present.
232
This will not follow the Branch object pointer - it's strictly a direct
233
open facility. Most client code should use open_branch().repository to
236
:param _unsupported: a private parameter, not part of the api.
237
TODO: static convenience version of this?
239
raise NotImplementedError(self.open_repository)
241
def find_repository(self):
242
"""Find the repository that should be used.
244
This does not require a branch as we use it to find the repo for
245
new branches as well as to hook existing branches up to their
248
raise NotImplementedError(self.find_repository)
250
def open_workingtree(self, _unsupported=False,
251
recommend_upgrade=True, from_branch=None):
252
"""Open the workingtree object at this ControlDir if one is present.
254
:param recommend_upgrade: Optional keyword parameter, when True (the
255
default), emit through the ui module a recommendation that the user
256
upgrade the working tree when the workingtree being opened is old
257
(but still fully supported).
258
:param from_branch: override controldir branch (for lightweight
261
raise NotImplementedError(self.open_workingtree)
263
def has_branch(self, name=None):
264
"""Tell if this controldir contains a branch.
266
Note: if you're going to open the branch, you should just go ahead
267
and try, and not ask permission first. (This method just opens the
268
branch and discards it, and that's somewhat expensive.)
271
self.open_branch(name)
273
except errors.NotBranchError:
276
def has_workingtree(self):
277
"""Tell if this controldir contains a working tree.
279
This will still raise an exception if the controldir has a workingtree
280
that is remote & inaccessible.
282
Note: if you're going to open the working tree, you should just go ahead
283
and try, and not ask permission first. (This method just opens the
284
workingtree and discards it, and that's somewhat expensive.)
287
self.open_workingtree(recommend_upgrade=False)
289
except errors.NoWorkingTree:
292
def cloning_metadir(self, require_stacking=False):
293
"""Produce a metadir suitable for cloning or sprouting with.
295
These operations may produce workingtrees (yes, even though they're
296
"cloning" something that doesn't have a tree), so a viable workingtree
297
format must be selected.
299
:require_stacking: If True, non-stackable formats will be upgraded
300
to similar stackable formats.
301
:returns: a ControlDirFormat with all component formats either set
302
appropriately or set to None if that component should not be
305
raise NotImplementedError(self.cloning_metadir)
307
def checkout_metadir(self):
308
"""Produce a metadir suitable for checkouts of this controldir."""
309
return self.cloning_metadir()
311
def sprout(self, url, revision_id=None, force_new_repo=False,
312
recurse='down', possible_transports=None,
313
accelerator_tree=None, hardlink=False, stacked=False,
314
source_branch=None, create_tree_if_local=True):
315
"""Create a copy of this controldir prepared for use as a new line of
318
If url's last component does not exist, it will be created.
320
Attributes related to the identity of the source branch like
321
branch nickname will be cleaned, a working tree is created
322
whether one existed before or not; and a local branch is always
325
if revision_id is not None, then the clone operation may tune
326
itself to download less data.
327
:param accelerator_tree: A tree which can be used for retrieving file
328
contents more quickly than the revision tree, i.e. a workingtree.
329
The revision tree will be used for cases where accelerator_tree's
330
content is different.
331
:param hardlink: If true, hard-link files from accelerator_tree,
333
:param stacked: If true, create a stacked branch referring to the
334
location of this control directory.
335
:param create_tree_if_local: If true, a working-tree will be created
336
when working locally.
338
operation = cleanup.OperationWithCleanups(self._sprout)
339
return operation.run(url, revision_id=revision_id,
340
force_new_repo=force_new_repo, recurse=recurse,
341
possible_transports=possible_transports,
342
accelerator_tree=accelerator_tree, hardlink=hardlink,
343
stacked=stacked, source_branch=source_branch,
344
create_tree_if_local=create_tree_if_local)
346
def _sprout(self, op, url, revision_id=None, force_new_repo=False,
347
recurse='down', possible_transports=None,
348
accelerator_tree=None, hardlink=False, stacked=False,
349
source_branch=None, create_tree_if_local=True):
350
add_cleanup = op.add_cleanup
351
fetch_spec_factory = fetch.FetchSpecFactory()
352
if revision_id is not None:
353
fetch_spec_factory.add_revision_ids([revision_id])
354
fetch_spec_factory.source_branch_stop_revision_id = revision_id
355
target_transport = _mod_transport.get_transport(url,
357
target_transport.ensure_base()
358
cloning_format = self.cloning_metadir(stacked)
359
# Create/update the result branch
360
result = cloning_format.initialize_on_transport(target_transport)
361
source_branch, source_repository = self._find_source_repo(
362
add_cleanup, source_branch)
363
fetch_spec_factory.source_branch = source_branch
364
# if a stacked branch wasn't requested, we don't create one
365
# even if the origin was stacked
366
if stacked and source_branch is not None:
367
stacked_branch_url = self.root_transport.base
369
stacked_branch_url = None
370
repository_policy = result.determine_repository_policy(
371
force_new_repo, stacked_branch_url, require_stacking=stacked)
372
result_repo, is_new_repo = repository_policy.acquire_repository()
373
add_cleanup(result_repo.lock_write().unlock)
374
fetch_spec_factory.source_repo = source_repository
375
fetch_spec_factory.target_repo = result_repo
376
if stacked or (len(result_repo._fallback_repositories) != 0):
377
target_repo_kind = fetch.TargetRepoKinds.STACKED
379
target_repo_kind = fetch.TargetRepoKinds.EMPTY
381
target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
382
fetch_spec_factory.target_repo_kind = target_repo_kind
383
if source_repository is not None:
384
fetch_spec = fetch_spec_factory.make_fetch_spec()
385
result_repo.fetch(source_repository, fetch_spec=fetch_spec)
387
if source_branch is None:
388
# this is for sprouting a controldir without a branch; is that
390
# Not especially, but it's part of the contract.
391
result_branch = result.create_branch()
393
result_branch = source_branch.sprout(result,
394
revision_id=revision_id, repository_policy=repository_policy,
395
repository=result_repo)
396
mutter("created new branch %r" % (result_branch,))
398
# Create/update the result working tree
399
if (create_tree_if_local and
400
isinstance(target_transport, local.LocalTransport) and
401
(result_repo is None or result_repo.make_working_trees())):
402
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
403
hardlink=hardlink, from_branch=result_branch)
406
if wt.path2id('') is None:
408
wt.set_root_id(self.open_workingtree.get_root_id())
409
except errors.NoWorkingTree:
415
if recurse == 'down':
418
basis = wt.basis_tree()
419
elif result_branch is not None:
420
basis = result_branch.basis_tree()
421
elif source_branch is not None:
422
basis = source_branch.basis_tree()
423
if basis is not None:
424
add_cleanup(basis.lock_read().unlock)
425
subtrees = basis.iter_references()
428
for path, file_id in subtrees:
429
target = urlutils.join(url, urlutils.escape(path))
430
sublocation = source_branch.reference_parent(file_id, path)
431
sublocation.bzrdir.sprout(target,
432
basis.get_reference_revision(file_id, path),
433
force_new_repo=force_new_repo, recurse=recurse,
437
def _find_source_repo(self, add_cleanup, source_branch):
438
"""Find the source branch and repo for a sprout operation.
440
This is helper intended for use by _sprout.
442
:returns: (source_branch, source_repository). Either or both may be
443
None. If not None, they will be read-locked (and their unlock(s)
444
scheduled via the add_cleanup param).
446
if source_branch is not None:
447
add_cleanup(source_branch.lock_read().unlock)
448
return source_branch, source_branch.repository
450
source_branch = self.open_branch()
451
source_repository = source_branch.repository
452
except errors.NotBranchError:
455
source_repository = self.open_repository()
456
except errors.NoRepositoryPresent:
457
source_repository = None
459
add_cleanup(source_repository.lock_read().unlock)
461
add_cleanup(source_branch.lock_read().unlock)
462
return source_branch, source_repository
464
def push_branch(self, source, revision_id=None, overwrite=False,
465
remember=False, create_prefix=False):
466
"""Push the source branch into this ControlDir."""
468
# If we can open a branch, use its direct repository, otherwise see
469
# if there is a repository without a branch.
471
br_to = self.open_branch()
472
except errors.NotBranchError:
473
# Didn't find a branch, can we find a repository?
474
repository_to = self.find_repository()
476
# Found a branch, so we must have found a repository
477
repository_to = br_to.repository
479
push_result = PushResult()
480
push_result.source_branch = source
482
# We have a repository but no branch, copy the revisions, and then
484
repository_to.fetch(source.repository, revision_id=revision_id)
485
br_to = source.clone(self, revision_id=revision_id)
486
if source.get_push_location() is None or remember:
487
source.set_push_location(br_to.base)
488
push_result.stacked_on = None
489
push_result.branch_push_result = None
490
push_result.old_revno = None
491
push_result.old_revid = _mod_revision.NULL_REVISION
492
push_result.target_branch = br_to
493
push_result.master_branch = None
494
push_result.workingtree_updated = False
496
# We have successfully opened the branch, remember if necessary:
497
if source.get_push_location() is None or remember:
498
source.set_push_location(br_to.base)
500
tree_to = self.open_workingtree()
501
except errors.NotLocalUrl:
502
push_result.branch_push_result = source.push(br_to,
503
overwrite, stop_revision=revision_id)
504
push_result.workingtree_updated = False
505
except errors.NoWorkingTree:
506
push_result.branch_push_result = source.push(br_to,
507
overwrite, stop_revision=revision_id)
508
push_result.workingtree_updated = None # Not applicable
512
push_result.branch_push_result = source.push(
513
tree_to.branch, overwrite, stop_revision=revision_id)
517
push_result.workingtree_updated = True
518
push_result.old_revno = push_result.branch_push_result.old_revno
519
push_result.old_revid = push_result.branch_push_result.old_revid
520
push_result.target_branch = \
521
push_result.branch_push_result.target_branch
524
def _get_tree_branch(self, name=None):
525
"""Return the branch and tree, if any, for this bzrdir.
527
:param name: Name of colocated branch to open.
529
Return None for tree if not present or inaccessible.
530
Raise NotBranchError if no branch is present.
531
:return: (tree, branch)
534
tree = self.open_workingtree()
535
except (errors.NoWorkingTree, errors.NotLocalUrl):
537
branch = self.open_branch(name=name)
540
branch = self.open_branch(name=name)
545
def get_config(self):
546
"""Get configuration for this ControlDir."""
547
raise NotImplementedError(self.get_config)
549
def check_conversion_target(self, target_format):
550
"""Check that a bzrdir as a whole can be converted to a new format."""
551
raise NotImplementedError(self.check_conversion_target)
553
def clone(self, url, revision_id=None, force_new_repo=False,
554
preserve_stacking=False):
555
"""Clone this bzrdir and its contents to url verbatim.
557
:param url: The url create the clone at. If url's last component does
558
not exist, it will be created.
559
:param revision_id: The tip revision-id to use for any branch or
560
working tree. If not None, then the clone operation may tune
561
itself to download less data.
562
:param force_new_repo: Do not use a shared repository for the target
563
even if one is available.
564
:param preserve_stacking: When cloning a stacked branch, stack the
565
new branch on top of the other branch's stacked-on branch.
567
return self.clone_on_transport(_mod_transport.get_transport(url),
568
revision_id=revision_id,
569
force_new_repo=force_new_repo,
570
preserve_stacking=preserve_stacking)
572
def clone_on_transport(self, transport, revision_id=None,
573
force_new_repo=False, preserve_stacking=False, stacked_on=None,
574
create_prefix=False, use_existing_dir=True, no_tree=False):
575
"""Clone this bzrdir and its contents to transport verbatim.
577
:param transport: The transport for the location to produce the clone
578
at. If the target directory does not exist, it will be created.
579
:param revision_id: The tip revision-id to use for any branch or
580
working tree. If not None, then the clone operation may tune
581
itself to download less data.
582
:param force_new_repo: Do not use a shared repository for the target,
583
even if one is available.
584
:param preserve_stacking: When cloning a stacked branch, stack the
585
new branch on top of the other branch's stacked-on branch.
586
:param create_prefix: Create any missing directories leading up to
588
:param use_existing_dir: Use an existing directory if one exists.
589
:param no_tree: If set to true prevents creation of a working tree.
591
raise NotImplementedError(self.clone_on_transport)
594
class ControlComponentFormat(object):
595
"""A component that can live inside of a .bzr meta directory."""
597
def get_format_string(self):
598
"""Return the format of this format, if usable in meta directories."""
599
raise NotImplementedError(self.get_format_string)
601
def get_format_description(self):
602
"""Return the short description for this format."""
603
raise NotImplementedError(self.get_format_description)
606
class ControlComponentFormatRegistry(registry.FormatRegistry):
607
"""A registry for control components (branch, workingtree, repository)."""
609
def __init__(self, other_registry=None):
610
super(ControlComponentFormatRegistry, self).__init__(other_registry)
611
self._extra_formats = []
613
def register(self, format):
614
"""Register a new format."""
615
super(ControlComponentFormatRegistry, self).register(
616
format.get_format_string(), format)
618
def remove(self, format):
619
"""Remove a registered format."""
620
super(ControlComponentFormatRegistry, self).remove(
621
format.get_format_string())
623
def register_extra(self, format):
624
"""Register a format that can not be used in a metadir.
626
This is mainly useful to allow custom repository formats, such as older
627
Bazaar formats and foreign formats, to be tested.
629
self._extra_formats.append(registry._ObjectGetter(format))
631
def remove_extra(self, format):
632
"""Remove an extra format.
634
self._extra_formats.remove(registry._ObjectGetter(format))
636
def register_extra_lazy(self, module_name, member_name):
637
"""Register a format lazily.
639
self._extra_formats.append(
640
registry._LazyObjectGetter(module_name, member_name))
642
def _get_extra(self):
643
"""Return all "extra" formats, not usable in meta directories."""
645
for getter in self._extra_formats:
653
"""Return all formats, even those not usable in metadirs.
656
for name in self.keys():
661
return result + self._get_extra()
663
def _get_all_modules(self):
664
"""Return a set of the modules providing objects."""
666
for name in self.keys():
667
modules.add(self._get_module(name))
668
for getter in self._extra_formats:
669
modules.add(getter.get_module())
673
class Converter(object):
674
"""Converts a disk format object from one format to another."""
676
def convert(self, to_convert, pb):
677
"""Perform the conversion of to_convert, giving feedback via pb.
679
:param to_convert: The disk object to convert.
680
:param pb: a progress bar to use for progress information.
683
def step(self, message):
684
"""Update the pb by a step."""
686
self.pb.update(message, self.count, self.total)
689
class ControlDirFormat(object):
690
"""An encapsulation of the initialization and open routines for a format.
692
Formats provide three things:
693
* An initialization routine,
697
Formats are placed in a dict by their format string for reference
698
during controldir opening. These should be subclasses of ControlDirFormat
701
Once a format is deprecated, just deprecate the initialize and open
702
methods on the format class. Do not deprecate the object, as the
703
object will be created every system load.
705
:cvar colocated_branches: Whether this formats supports colocated branches.
706
:cvar supports_workingtrees: This control directory can co-exist with a
710
_default_format = None
711
"""The default format used for new control directories."""
714
"""The registered server format probers, e.g. RemoteBzrProber.
716
This is a list of Prober-derived classes.
720
"""The registered format probers, e.g. BzrProber.
722
This is a list of Prober-derived classes.
725
colocated_branches = False
726
"""Whether co-located branches are supported for this control dir format.
729
supports_workingtrees = True
730
"""Whether working trees can exist in control directories of this format.
733
fixed_components = False
734
"""Whether components can not change format independent of the control dir.
737
def get_format_description(self):
738
"""Return the short description for this format."""
739
raise NotImplementedError(self.get_format_description)
741
def get_converter(self, format=None):
742
"""Return the converter to use to convert controldirs needing converts.
744
This returns a bzrlib.controldir.Converter object.
746
This should return the best upgrader to step this format towards the
747
current default format. In the case of plugins we can/should provide
748
some means for them to extend the range of returnable converters.
750
:param format: Optional format to override the default format of the
753
raise NotImplementedError(self.get_converter)
755
def is_supported(self):
756
"""Is this format supported?
758
Supported formats must be initializable and openable.
759
Unsupported formats may not support initialization or committing or
760
some other features depending on the reason for not being supported.
764
def same_model(self, target_format):
765
return (self.repository_format.rich_root_data ==
766
target_format.rich_root_data)
769
def register_format(klass, format):
770
"""Register a format that does not use '.bzr' for its control dir.
773
raise errors.BzrError("ControlDirFormat.register_format() has been "
774
"removed in Bazaar 2.4. Please upgrade your plugins.")
777
def register_prober(klass, prober):
778
"""Register a prober that can look for a control dir.
781
klass._probers.append(prober)
784
def unregister_prober(klass, prober):
785
"""Unregister a prober.
788
klass._probers.remove(prober)
791
def register_server_prober(klass, prober):
792
"""Register a control format prober for client-server environments.
794
These probers will be used before ones registered with
795
register_prober. This gives implementations that decide to the
796
chance to grab it before anything looks at the contents of the format
799
klass._server_probers.append(prober)
803
return self.get_format_description().rstrip()
806
def known_formats(klass):
807
"""Return all the known formats.
810
for prober_kls in klass._probers + klass._server_probers:
811
result.update(prober_kls.known_formats())
815
def find_format(klass, transport, _server_formats=True):
816
"""Return the format present at transport."""
818
_probers = klass._server_probers + klass._probers
820
_probers = klass._probers
821
for prober_kls in _probers:
822
prober = prober_kls()
824
return prober.probe_transport(transport)
825
except errors.NotBranchError:
826
# this format does not find a control dir here.
828
raise errors.NotBranchError(path=transport.base)
830
def initialize(self, url, possible_transports=None):
831
"""Create a control dir at this url and return an opened copy.
833
While not deprecated, this method is very specific and its use will
834
lead to many round trips to setup a working environment. See
835
initialize_on_transport_ex for a [nearly] all-in-one method.
837
Subclasses should typically override initialize_on_transport
838
instead of this method.
840
return self.initialize_on_transport(
841
_mod_transport.get_transport(url, possible_transports))
843
def initialize_on_transport(self, transport):
844
"""Initialize a new controldir in the base directory of a Transport."""
845
raise NotImplementedError(self.initialize_on_transport)
847
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
848
create_prefix=False, force_new_repo=False, stacked_on=None,
849
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
850
shared_repo=False, vfs_only=False):
851
"""Create this format on transport.
853
The directory to initialize will be created.
855
:param force_new_repo: Do not use a shared repository for the target,
856
even if one is available.
857
:param create_prefix: Create any missing directories leading up to
859
:param use_existing_dir: Use an existing directory if one exists.
860
:param stacked_on: A url to stack any created branch on, None to follow
861
any target stacking policy.
862
:param stack_on_pwd: If stack_on is relative, the location it is
864
:param repo_format_name: If non-None, a repository will be
865
made-or-found. Should none be found, or if force_new_repo is True
866
the repo_format_name is used to select the format of repository to
868
:param make_working_trees: Control the setting of make_working_trees
869
for a new shared repository when one is made. None to use whatever
870
default the format has.
871
:param shared_repo: Control whether made repositories are shared or
873
:param vfs_only: If True do not attempt to use a smart server
874
:return: repo, controldir, require_stacking, repository_policy. repo is
875
None if none was created or found, controldir is always valid.
876
require_stacking is the result of examining the stacked_on
877
parameter and any stacking policy found for the target.
879
raise NotImplementedError(self.initialize_on_transport_ex)
881
def network_name(self):
882
"""A simple byte string uniquely identifying this format for RPC calls.
884
Bzr control formats use this disk format string to identify the format
885
over the wire. Its possible that other control formats have more
886
complex detection requirements, so we permit them to use any unique and
887
immutable string they desire.
889
raise NotImplementedError(self.network_name)
891
def open(self, transport, _found=False):
892
"""Return an instance of this format for the dir transport points at.
894
raise NotImplementedError(self.open)
897
def _set_default_format(klass, format):
898
"""Set default format (for testing behavior of defaults only)"""
899
klass._default_format = format
902
def get_default_format(klass):
903
"""Return the current default format."""
904
return klass._default_format
907
class Prober(object):
908
"""Abstract class that can be used to detect a particular kind of
911
At the moment this just contains a single method to probe a particular
912
transport, but it may be extended in the future to e.g. avoid
913
multiple levels of probing for Subversion repositories.
915
See BzrProber and RemoteBzrProber in bzrlib.bzrdir for the
916
probers that detect .bzr/ directories and Bazaar smart servers,
919
Probers should be registered using the register_server_prober or
920
register_prober methods on ControlDirFormat.
923
def probe_transport(self, transport):
924
"""Return the controldir style format present in a directory.
926
:raise UnknownFormatError: If a control dir was found but is
927
in an unknown format.
928
:raise NotBranchError: If no control directory was found.
929
:return: A ControlDirFormat instance.
931
raise NotImplementedError(self.probe_transport)
934
def known_formats(cls):
935
"""Return the control dir formats known by this prober.
937
Multiple probers can return the same formats, so this should
940
:return: A set of known formats.
942
raise NotImplementedError(cls.known_formats)
945
class ControlDirFormatInfo(object):
947
def __init__(self, native, deprecated, hidden, experimental):
948
self.deprecated = deprecated
951
self.experimental = experimental
954
class ControlDirFormatRegistry(registry.Registry):
955
"""Registry of user-selectable ControlDir subformats.
957
Differs from ControlDirFormat._formats in that it provides sub-formats,
958
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
962
"""Create a ControlDirFormatRegistry."""
963
self._aliases = set()
964
self._registration_order = list()
965
super(ControlDirFormatRegistry, self).__init__()
968
"""Return a set of the format names which are aliases."""
969
return frozenset(self._aliases)
971
def register(self, key, factory, help, native=True, deprecated=False,
972
hidden=False, experimental=False, alias=False):
973
"""Register a ControlDirFormat factory.
975
The factory must be a callable that takes one parameter: the key.
976
It must produce an instance of the ControlDirFormat when called.
978
This function mainly exists to prevent the info object from being
981
registry.Registry.register(self, key, factory, help,
982
ControlDirFormatInfo(native, deprecated, hidden, experimental))
984
self._aliases.add(key)
985
self._registration_order.append(key)
987
def register_lazy(self, key, module_name, member_name, help, native=True,
988
deprecated=False, hidden=False, experimental=False, alias=False):
989
registry.Registry.register_lazy(self, key, module_name, member_name,
990
help, ControlDirFormatInfo(native, deprecated, hidden, experimental))
992
self._aliases.add(key)
993
self._registration_order.append(key)
995
def set_default(self, key):
996
"""Set the 'default' key to be a clone of the supplied key.
998
This method must be called once and only once.
1000
registry.Registry.register(self, 'default', self.get(key),
1001
self.get_help(key), info=self.get_info(key))
1002
self._aliases.add('default')
1004
def set_default_repository(self, key):
1005
"""Set the FormatRegistry default and Repository default.
1007
This is a transitional method while Repository.set_default_format
1010
if 'default' in self:
1011
self.remove('default')
1012
self.set_default(key)
1013
format = self.get('default')()
1015
def make_bzrdir(self, key):
1016
return self.get(key)()
1018
def help_topic(self, topic):
1020
default_realkey = None
1021
default_help = self.get_help('default')
1023
for key in self._registration_order:
1024
if key == 'default':
1026
help = self.get_help(key)
1027
if help == default_help:
1028
default_realkey = key
1030
help_pairs.append((key, help))
1032
def wrapped(key, help, info):
1034
help = '(native) ' + help
1035
return ':%s:\n%s\n\n' % (key,
1036
textwrap.fill(help, initial_indent=' ',
1037
subsequent_indent=' ',
1038
break_long_words=False))
1039
if default_realkey is not None:
1040
output += wrapped(default_realkey, '(default) %s' % default_help,
1041
self.get_info('default'))
1042
deprecated_pairs = []
1043
experimental_pairs = []
1044
for key, help in help_pairs:
1045
info = self.get_info(key)
1048
elif info.deprecated:
1049
deprecated_pairs.append((key, help))
1050
elif info.experimental:
1051
experimental_pairs.append((key, help))
1053
output += wrapped(key, help, info)
1054
output += "\nSee :doc:`formats-help` for more about storage formats."
1056
if len(experimental_pairs) > 0:
1057
other_output += "Experimental formats are shown below.\n\n"
1058
for key, help in experimental_pairs:
1059
info = self.get_info(key)
1060
other_output += wrapped(key, help, info)
1063
"No experimental formats are available.\n\n"
1064
if len(deprecated_pairs) > 0:
1065
other_output += "\nDeprecated formats are shown below.\n\n"
1066
for key, help in deprecated_pairs:
1067
info = self.get_info(key)
1068
other_output += wrapped(key, help, info)
1071
"\nNo deprecated formats are available.\n\n"
1073
"\nSee :doc:`formats-help` for more about storage formats."
1075
if topic == 'other-formats':
1081
# Please register new formats after old formats so that formats
1082
# appear in chronological order and format descriptions can build
1084
format_registry = ControlDirFormatRegistry()
1086
network_format_registry = registry.FormatRegistry()
1087
"""Registry of formats indexed by their network name.
1089
The network name for a ControlDirFormat is an identifier that can be used when
1090
referring to formats with smart server operations. See
1091
ControlDirFormat.network_name() for more detail.
added
removed
bzrlib/controldir.py
