/breezy/trunk

To get this branch, use:
bzr branch https://code.breezy-vcs.org/breezy/trunk

« back to all changes in this revision

Viewing changes to breezy/bzr/__init__.py

  • Committer: Jelmer Vernooij
  • Date: 2017-07-23 22:06:41 UTC
  • mfrom: (6738 trunk)
  • mto: This revision was merged to the branch mainline in revision 6739.
  • Revision ID: jelmer@jelmer.uk-20170723220641-69eczax9bmv8d6kk
Merge trunk, address review comments.

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
from __future__ import absolute_import
 
18
 
 
19
from .. import (
 
20
    config,
 
21
    errors,
 
22
    controldir,
 
23
    pyutils,
 
24
    registry,
 
25
    )
 
26
 
 
27
class BzrProber(controldir.Prober):
 
28
    """Prober for formats that use a .bzr/ control directory."""
 
29
 
 
30
    formats = registry.FormatRegistry(controldir.network_format_registry)
 
31
    """The known .bzr formats."""
 
32
 
 
33
    @classmethod
 
34
    def probe_transport(klass, transport):
 
35
        """Return the .bzrdir style format present in a directory."""
 
36
        try:
 
37
            format_string = transport.get_bytes(".bzr/branch-format")
 
38
            # GZ 2017-06-09: Where should format strings get decoded...
 
39
            format_text = format_string.decode("ascii")
 
40
        except errors.NoSuchFile:
 
41
            raise errors.NotBranchError(path=transport.base)
 
42
        try:
 
43
            first_line = format_text[:format_text.index("\n")+1]
 
44
        except ValueError:
 
45
            first_line = format_text
 
46
        try:
 
47
            cls = klass.formats.get(first_line)
 
48
        except KeyError:
 
49
            raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
 
50
        return cls.from_string(format_text)
 
51
 
 
52
    @classmethod
 
53
    def known_formats(cls):
 
54
        result = set()
 
55
        for name, format in cls.formats.items():
 
56
            if callable(format):
 
57
                format = format()
 
58
            result.add(format)
 
59
        return result
 
60
 
 
61
 
 
62
controldir.ControlDirFormat.register_prober(BzrProber)
 
63
 
 
64
 
 
65
class RemoteBzrProber(controldir.Prober):
 
66
    """Prober for remote servers that provide a Bazaar smart server."""
 
67
 
 
68
    @classmethod
 
69
    def probe_transport(klass, transport):
 
70
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
71
        try:
 
72
            medium = transport.get_smart_medium()
 
73
        except (NotImplementedError, AttributeError,
 
74
                errors.TransportNotPossible, errors.NoSmartMedium,
 
75
                errors.SmartProtocolError):
 
76
            # no smart server, so not a branch for this format type.
 
77
            raise errors.NotBranchError(path=transport.base)
 
78
        else:
 
79
            # Decline to open it if the server doesn't support our required
 
80
            # version (3) so that the VFS-based transport will do it.
 
81
            if medium.should_probe():
 
82
                try:
 
83
                    server_version = medium.protocol_version()
 
84
                except errors.SmartProtocolError:
 
85
                    # Apparently there's no usable smart server there, even though
 
86
                    # the medium supports the smart protocol.
 
87
                    raise errors.NotBranchError(path=transport.base)
 
88
                if server_version != '2':
 
89
                    raise errors.NotBranchError(path=transport.base)
 
90
            from .remote import RemoteBzrDirFormat
 
91
            return RemoteBzrDirFormat()
 
92
 
 
93
    @classmethod
 
94
    def known_formats(cls):
 
95
        from .remote import RemoteBzrDirFormat
 
96
        return {RemoteBzrDirFormat()}
 
97
 
 
98
 
 
99
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
 
100
 
 
101
# Register bzr formats
 
102
BzrProber.formats.register_lazy(
 
103
    "Bazaar-NG meta directory, format 1\n",
 
104
    __name__ + '.bzrdir', 'BzrDirMetaFormat1')
 
105
BzrProber.formats.register_lazy(
 
106
    "Bazaar meta directory, format 1 (with colocated branches)\n",
 
107
    __name__ + '.bzrdir', 'BzrDirMetaFormat1Colo')
 
108
 
 
109
 
 
110
def register_metadir(registry, key,
 
111
         repository_format, help, native=True, deprecated=False,
 
112
         branch_format=None,
 
113
         tree_format=None,
 
114
         hidden=False,
 
115
         experimental=False,
 
116
         alias=False, bzrdir_format=None):
 
117
    """Register a metadir subformat.
 
118
 
 
119
    These all use a meta bzrdir, but can be parameterized by the
 
120
    Repository/Branch/WorkingTreeformats.
 
121
 
 
122
    :param repository_format: The fully-qualified repository format class
 
123
        name as a string.
 
124
    :param branch_format: Fully-qualified branch format class name as
 
125
        a string.
 
126
    :param tree_format: Fully-qualified tree format class name as
 
127
        a string.
 
128
    """
 
129
    if bzrdir_format is None:
 
130
        bzrdir_format = 'breezy.bzr.bzrdir.BzrDirMetaFormat1'
 
131
    # This should be expanded to support setting WorkingTree and Branch
 
132
    # formats, once the API supports that.
 
133
    def _load(full_name):
 
134
        mod_name, factory_name = full_name.rsplit('.', 1)
 
135
        try:
 
136
            factory = pyutils.get_named_object(mod_name, factory_name)
 
137
        except ImportError as e:
 
138
            raise ImportError('failed to load %s: %s' % (full_name, e))
 
139
        except AttributeError:
 
140
            raise AttributeError('no factory %s in module %r'
 
141
                % (full_name, sys.modules[mod_name]))
 
142
        return factory()
 
143
 
 
144
    def helper():
 
145
        bd = _load(bzrdir_format)
 
146
        if branch_format is not None:
 
147
            bd.set_branch_format(_load(branch_format))
 
148
        if tree_format is not None:
 
149
            bd.workingtree_format = _load(tree_format)
 
150
        if repository_format is not None:
 
151
            bd.repository_format = _load(repository_format)
 
152
        return bd
 
153
    registry.register(key, helper, help, native, deprecated, hidden,
 
154
        experimental, alias)
 
155
 
 
156
register_metadir(controldir.format_registry, 'knit',
 
157
    'breezy.bzr.knitrepo.RepositoryFormatKnit1',
 
158
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
159
    branch_format='breezy.bzr.fullhistory.BzrBranchFormat5',
 
160
    tree_format='breezy.bzr.workingtree_3.WorkingTreeFormat3',
 
161
    hidden=True,
 
162
    deprecated=True)
 
163
register_metadir(controldir.format_registry, 'dirstate',
 
164
    'breezy.bzr.knitrepo.RepositoryFormatKnit1',
 
165
    help='Format using dirstate for working trees. '
 
166
        'Compatible with bzr 0.8 and '
 
167
        'above when accessed over the network. Introduced in bzr 0.15.',
 
168
    branch_format='breezy.bzr.fullhistory.BzrBranchFormat5',
 
169
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat4',
 
170
    hidden=True,
 
171
    deprecated=True)
 
172
register_metadir(controldir.format_registry, 'dirstate-tags',
 
173
    'breezy.bzr.knitrepo.RepositoryFormatKnit1',
 
174
    help='Variant of dirstate with support for tags. '
 
175
        'Introduced in bzr 0.15.',
 
176
    branch_format='breezy.bzr.branch.BzrBranchFormat6',
 
177
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat4',
 
178
    hidden=True,
 
179
    deprecated=True)
 
180
register_metadir(controldir.format_registry, 'rich-root',
 
181
    'breezy.bzr.knitrepo.RepositoryFormatKnit4',
 
182
    help='Variant of dirstate with better handling of tree roots. '
 
183
        'Introduced in bzr 1.0',
 
184
    branch_format='breezy.bzr.branch.BzrBranchFormat6',
 
185
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat4',
 
186
    hidden=True,
 
187
    deprecated=True)
 
188
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
 
189
    'breezy.bzr.knitrepo.RepositoryFormatKnit3',
 
190
    help='Variant of dirstate with support for nested trees. '
 
191
         'Introduced in 0.15.',
 
192
    branch_format='breezy.bzr.branch.BzrBranchFormat6',
 
193
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat4',
 
194
    experimental=True,
 
195
    hidden=True,
 
196
    )
 
197
register_metadir(controldir.format_registry, 'pack-0.92',
 
198
    'breezy.bzr.knitpack_repo.RepositoryFormatKnitPack1',
 
199
    help='Pack-based format used in 1.x series. Introduced in 0.92. '
 
200
        'Interoperates with bzr repositories before 0.92 but cannot be '
 
201
        'read by bzr < 0.92. '
 
202
        ,
 
203
    branch_format='breezy.bzr.branch.BzrBranchFormat6',
 
204
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat4',
 
205
    deprecated=True,
 
206
    )
 
207
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
 
208
    'breezy.bzr.knitpack_repo.RepositoryFormatKnitPack3',
 
209
    help='Pack-based format used in 1.x series, with subtree support. '
 
210
        'Introduced in 0.92. Interoperates with '
 
211
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
212
        ,
 
213
    branch_format='breezy.bzr.branch.BzrBranchFormat6',
 
214
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat4',
 
215
    hidden=True,
 
216
    deprecated=True,
 
217
    experimental=True,
 
218
    )
 
219
register_metadir(controldir.format_registry, 'rich-root-pack',
 
220
    'breezy.bzr.knitpack_repo.RepositoryFormatKnitPack4',
 
221
    help='A variant of pack-0.92 that supports rich-root data '
 
222
         '(needed for bzr-svn and bzr-git). Introduced in 1.0.',
 
223
    branch_format='breezy.bzr.branch.BzrBranchFormat6',
 
224
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat4',
 
225
    hidden=True,
 
226
    deprecated=True,
 
227
    )
 
228
register_metadir(controldir.format_registry, '1.6',
 
229
    'breezy.bzr.knitpack_repo.RepositoryFormatKnitPack5',
 
230
    help='A format that allows a branch to indicate that there is another '
 
231
         '(stacked) repository that should be used to access data that is '
 
232
         'not present locally.',
 
233
    branch_format='breezy.bzr.branch.BzrBranchFormat7',
 
234
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat4',
 
235
    hidden=True,
 
236
    deprecated=True,
 
237
    )
 
238
register_metadir(controldir.format_registry, '1.6.1-rich-root',
 
239
    'breezy.bzr.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
 
240
    help='A variant of 1.6 that supports rich-root data '
 
241
         '(needed for bzr-svn and bzr-git).',
 
242
    branch_format='breezy.bzr.branch.BzrBranchFormat7',
 
243
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat4',
 
244
    hidden=True,
 
245
    deprecated=True,
 
246
    )
 
247
register_metadir(controldir.format_registry, '1.9',
 
248
    'breezy.bzr.knitpack_repo.RepositoryFormatKnitPack6',
 
249
    help='A repository format using B+tree indexes. These indexes '
 
250
         'are smaller in size, have smarter caching and provide faster '
 
251
         'performance for most operations.',
 
252
    branch_format='breezy.bzr.branch.BzrBranchFormat7',
 
253
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat4',
 
254
    hidden=True,
 
255
    deprecated=True,
 
256
    )
 
257
register_metadir(controldir.format_registry, '1.9-rich-root',
 
258
    'breezy.bzr.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
259
    help='A variant of 1.9 that supports rich-root data '
 
260
         '(needed for bzr-svn and bzr-git).',
 
261
    branch_format='breezy.bzr.branch.BzrBranchFormat7',
 
262
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat4',
 
263
    hidden=True,
 
264
    deprecated=True,
 
265
    )
 
266
register_metadir(controldir.format_registry, '1.14',
 
267
    'breezy.bzr.knitpack_repo.RepositoryFormatKnitPack6',
 
268
    help='A working-tree format that supports content filtering.',
 
269
    branch_format='breezy.bzr.branch.BzrBranchFormat7',
 
270
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat5',
 
271
    hidden=True,
 
272
    deprecated=True,
 
273
    )
 
274
register_metadir(controldir.format_registry, '1.14-rich-root',
 
275
    'breezy.bzr.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
276
    help='A variant of 1.14 that supports rich-root data '
 
277
         '(needed for bzr-svn and bzr-git).',
 
278
    branch_format='breezy.bzr.branch.BzrBranchFormat7',
 
279
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat5',
 
280
    hidden=True,
 
281
    deprecated=True,
 
282
    )
 
283
# The following un-numbered 'development' formats should always just be aliases.
 
284
register_metadir(controldir.format_registry, 'development-subtree',
 
285
    'breezy.bzr.groupcompress_repo.RepositoryFormat2aSubtree',
 
286
    help='Current development format, subtree variant. Can convert data to and '
 
287
        'from pack-0.92-subtree (and anything compatible with '
 
288
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
289
        'this format can only be read by bzr.dev. Please read '
 
290
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
291
        'before use.',
 
292
    branch_format='breezy.bzr.branch.BzrBranchFormat7',
 
293
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat6',
 
294
    experimental=True,
 
295
    hidden=True,
 
296
    alias=False, # Restore to being an alias when an actual development subtree format is added
 
297
                 # This current non-alias status is simply because we did not introduce a
 
298
                 # chk based subtree format.
 
299
    )
 
300
register_metadir(controldir.format_registry, 'development5-subtree',
 
301
    'breezy.bzr.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
 
302
    help='Development format, subtree variant. Can convert data to and '
 
303
        'from pack-0.92-subtree (and anything compatible with '
 
304
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
305
        'this format can only be read by bzr.dev. Please read '
 
306
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
307
        'before use.',
 
308
    branch_format='breezy.bzr.branch.BzrBranchFormat7',
 
309
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat6',
 
310
    experimental=True,
 
311
    hidden=True,
 
312
    alias=False,
 
313
    )
 
314
 
 
315
register_metadir(controldir.format_registry, 'development-colo',
 
316
    'breezy.bzr.groupcompress_repo.RepositoryFormat2a',
 
317
    help='The 2a format with experimental support for colocated branches.\n',
 
318
    branch_format='breezy.bzr.branch.BzrBranchFormat7',
 
319
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat6',
 
320
    experimental=True,
 
321
    bzrdir_format='breezy.bzr.bzrdir.BzrDirMetaFormat1Colo',
 
322
    )
 
323
 
 
324
 
 
325
# And the development formats above will have aliased one of the following:
 
326
 
 
327
# Finally, the current format.
 
328
register_metadir(controldir.format_registry, '2a',
 
329
    'breezy.bzr.groupcompress_repo.RepositoryFormat2a',
 
330
    help='Format for the bzr 2.0 series.\n'
 
331
        'Uses group-compress storage.\n'
 
332
        'Provides rich roots which are a one-way transition.\n',
 
333
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
 
334
        # 'rich roots. Supported by bzr 1.16 and later.',
 
335
    branch_format='breezy.bzr.branch.BzrBranchFormat7',
 
336
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat6',
 
337
    experimental=False,
 
338
    )
 
339
 
 
340
# The following format should be an alias for the rich root equivalent
 
341
# of the default format
 
342
register_metadir(controldir.format_registry, 'default-rich-root',
 
343
    'breezy.bzr.groupcompress_repo.RepositoryFormat2a',
 
344
    branch_format='breezy.bzr.branch.BzrBranchFormat7',
 
345
    tree_format='breezy.bzr.workingtree_4.WorkingTreeFormat6',
 
346
    alias=True,
 
347
    hidden=True,
 
348
    help='Same as 2a.')
 
349
 
 
350
 
 
351
# The current format that is made on 'bzr init'.
 
352
format_name = config.GlobalStack().get('default_format')
 
353
controldir.format_registry.set_default(format_name)