/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-13 02:09:37 UTC
  • mto: This revision was merged to the branch mainline in revision 2004.
  • Revision ID: john@arbash-meinel.com-20060913020937-2df2f49f9a28ec43
Update HACKING and docstrings

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Exceptions for bzr, and reporting of them.
 
18
 
 
19
There are 3 different classes of error:
 
20
 
 
21
 * KeyboardInterrupt, and OSError with EPIPE - the program terminates 
 
22
   with an appropriate short message
 
23
 
 
24
 * User errors, indicating a problem caused by the user such as a bad URL.
 
25
   These are printed in a short form.
 
26
 
 
27
 * Internal unexpected errors, including most Python builtin errors
 
28
   and some raised from inside bzr.  These are printed with a full 
 
29
   traceback and an invitation to report the bug.
 
30
 
 
31
Exceptions are caught at a high level to report errors to the user, and
 
32
might also be caught inside the program.  Therefore it needs to be
 
33
possible to convert them to a meaningful string, and also for them to be
 
34
interrogated by the program.
 
35
 
 
36
Exceptions are defined such that the arguments given to the constructor
 
37
are stored in the object as properties of the same name.  When the
 
38
object is printed as a string, the doc string of the class is used as
 
39
a format string with the property dictionary available to it.
 
40
 
 
41
This means that exceptions can used like this:
 
42
 
 
43
>>> import sys
 
44
>>> try:
 
45
...   raise NotBranchError(path='/foo/bar')
 
46
... except:
 
47
...   print sys.exc_type
 
48
...   print sys.exc_value
 
49
...   path = getattr(sys.exc_value, 'path', None)
 
50
...   if path is not None:
 
51
...     print path
 
52
bzrlib.errors.NotBranchError
 
53
Not a branch: /foo/bar
 
54
/foo/bar
 
55
 
 
56
Therefore:
 
57
 
 
58
 * create a new exception class for any class of error that can be
 
59
   usefully distinguished.  If no callers are likely to want to catch
 
60
   one but not another, don't worry about them.
 
61
 
 
62
 * the __str__ method should generate something useful; BzrError provides
 
63
   a good default implementation
 
64
 
 
65
Exception strings should start with a capital letter and should not have a
 
66
final fullstop.
18
67
"""
19
68
 
20
 
 
21
 
from bzrlib import (
22
 
    osutils,
23
 
    symbol_versioning,
24
 
    )
25
 
from bzrlib.patches import (
26
 
    MalformedHunkHeader,
27
 
    MalformedLine,
28
 
    MalformedPatchHeader,
29
 
    PatchConflict,
30
 
    PatchSyntax,
31
 
    )
32
 
 
 
69
from warnings import warn
 
70
 
 
71
from bzrlib.patches import (PatchSyntax, 
 
72
                            PatchConflict, 
 
73
                            MalformedPatchHeader,
 
74
                            MalformedHunkHeader,
 
75
                            MalformedLine,)
 
76
 
 
77
 
 
78
# based on Scott James Remnant's hct error classes
33
79
 
34
80
# TODO: is there any value in providing the .args field used by standard
35
81
# python exceptions?   A list of values with no names seems less useful 
39
85
# constructed to make sure it will succeed.  But that says nothing about
40
86
# exceptions that are never raised.
41
87
 
42
 
# TODO: selftest assertRaises should probably also check that every error
43
 
# raised can be formatted as a string successfully, and without giving
44
 
# 'unprintable'.
 
88
# TODO: Convert all the other error classes here to BzrNewError, and eliminate
 
89
# the old one.
 
90
 
 
91
# TODO: The pattern (from hct) of using classes docstrings as message
 
92
# templates is cute but maybe not such a great idea - perhaps should have a
 
93
# separate static message_template.
45
94
 
46
95
 
47
96
class BzrError(StandardError):
48
 
    """
49
 
    Base class for errors raised by bzrlib.
50
 
 
51
 
    :cvar internal_error: if true (or absent) this was probably caused by a
52
 
    bzr bug and should be displayed with a traceback; if False this was
53
 
    probably a user or environment error and they don't need the gory details.
54
 
    (That can be overridden by -Derror on the command line.)
55
 
 
56
 
    :cvar _fmt: Format string to display the error; this is expanded
57
 
    by the instance's dict.
58
 
    """
59
 
    
60
 
    internal_error = False
61
 
 
62
 
    def __init__(self, msg=None, **kwds):
63
 
        """Construct a new BzrError.
64
 
 
65
 
        There are two alternative forms for constructing these objects.
66
 
        Either a preformatted string may be passed, or a set of named
67
 
        arguments can be given.  The first is for generic "user" errors which
68
 
        are not intended to be caught and so do not need a specific subclass.
69
 
        The second case is for use with subclasses that provide a _fmt format
70
 
        string to print the arguments.  
71
 
 
72
 
        Keyword arguments are taken as parameters to the error, which can 
73
 
        be inserted into the format string template.  It's recommended 
74
 
        that subclasses override the __init__ method to require specific 
75
 
        parameters.
76
 
 
77
 
        :param msg: If given, this is the literal complete text for the error,
78
 
        not subject to expansion.
79
 
        """
80
 
        StandardError.__init__(self)
81
 
        if msg is not None:
82
 
            # I was going to deprecate this, but it actually turns out to be
83
 
            # quite handy - mbp 20061103.
84
 
            self._preformatted_string = msg
 
97
    
 
98
    is_user_error = True
 
99
    
 
100
    def __str__(self):
 
101
        # XXX: Should we show the exception class in 
 
102
        # exceptions that don't provide their own message?  
 
103
        # maybe it should be done at a higher level
 
104
        ## n = self.__class__.__name__ + ': '
 
105
        n = ''
 
106
        if len(self.args) == 1:
 
107
            return str(self.args[0])
 
108
        elif len(self.args) == 2:
 
109
            # further explanation or suggestions
 
110
            try:
 
111
                return n + '\n  '.join([self.args[0]] + self.args[1])
 
112
            except TypeError:
 
113
                return n + "%r" % self
85
114
        else:
86
 
            self._preformatted_string = None
87
 
            for key, value in kwds.items():
88
 
                setattr(self, key, value)
89
 
 
90
 
    def __str__(self):
91
 
        s = getattr(self, '_preformatted_string', None)
92
 
        if s is not None:
93
 
            # contains a preformatted message; must be cast to plain str
94
 
            return str(s)
95
 
        try:
96
 
            fmt = self._get_format_string()
97
 
            if fmt:
98
 
                s = fmt % self.__dict__
99
 
                # __str__() should always return a 'str' object
100
 
                # never a 'unicode' object.
101
 
                if isinstance(s, unicode):
102
 
                    return s.encode('utf8')
103
 
                return s
104
 
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
105
 
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%s' \
106
 
                % (self.__class__.__name__,
107
 
                   self.__dict__,
108
 
                   getattr(self, '_fmt', None),
109
 
                   str(e))
110
 
 
111
 
    def _get_format_string(self):
112
 
        """Return format string for this exception or None"""
113
 
        fmt = getattr(self, '_fmt', None)
114
 
        if fmt is not None:
115
 
            return fmt
116
 
        fmt = getattr(self, '__doc__', None)
117
 
        if fmt is not None:
118
 
            symbol_versioning.warn("%s uses its docstring as a format, "
119
 
                    "it should use _fmt instead" % self.__class__.__name__,
120
 
                    DeprecationWarning)
121
 
            return fmt
122
 
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
123
 
            % (self.__class__.__name__,
124
 
               self.__dict__,
125
 
               getattr(self, '_fmt', None),
126
 
               )
 
115
            return n + `self.args`
127
116
 
128
117
 
129
118
class BzrNewError(BzrError):
130
 
    """Deprecated error base class."""
 
119
    """bzr error"""
131
120
    # base classes should override the docstring with their human-
132
121
    # readable explanation
133
122
 
134
 
    def __init__(self, *args, **kwds):
135
 
        # XXX: Use the underlying BzrError to always generate the args
136
 
        # attribute if it doesn't exist.  We can't use super here, because
137
 
        # exceptions are old-style classes in python2.4 (but new in 2.5).
138
 
        # --bmc, 20060426
139
 
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
140
 
             'please convert %s to use BzrError instead'
141
 
             % self.__class__.__name__,
142
 
             DeprecationWarning,
143
 
             stacklevel=2)
144
 
        BzrError.__init__(self, *args)
 
123
    def __init__(self, **kwds):
145
124
        for key, value in kwds.items():
146
125
            setattr(self, key, value)
147
126
 
153
132
            if isinstance(s, unicode):
154
133
                return s.encode('utf8')
155
134
            return s
156
 
        except (TypeError, NameError, ValueError, KeyError), e:
157
 
            return 'Unprintable exception %s(%r): %s' \
158
 
                % (self.__class__.__name__,
159
 
                   self.__dict__, str(e))
160
 
 
161
 
 
162
 
class AlreadyBuilding(BzrError):
163
 
    
164
 
    _fmt = "The tree builder is already building a tree."
165
 
 
166
 
 
167
 
class BzrCheckError(BzrError):
168
 
    
169
 
    _fmt = "Internal check failed: %(message)s"
170
 
 
171
 
    internal_error = True
 
135
        except (NameError, ValueError, KeyError), e:
 
136
            return 'Unprintable exception %s: %s' \
 
137
                % (self.__class__.__name__, str(e))
 
138
 
 
139
 
 
140
class BzrCheckError(BzrNewError):
 
141
    """Internal check failed: %(message)s"""
 
142
 
 
143
    is_user_error = False
172
144
 
173
145
    def __init__(self, message):
174
 
        BzrError.__init__(self)
 
146
        BzrNewError.__init__(self)
175
147
        self.message = message
176
148
 
177
149
 
178
 
class DisabledMethod(BzrError):
179
 
 
180
 
    _fmt = "The smart server method '%(class_name)s' is disabled."
181
 
 
182
 
    internal_error = True
183
 
 
184
 
    def __init__(self, class_name):
185
 
        BzrError.__init__(self)
186
 
        self.class_name = class_name
187
 
 
188
 
 
189
 
class InvalidEntryName(BzrError):
190
 
    
191
 
    _fmt = "Invalid entry name: %(name)s"
192
 
 
193
 
    internal_error = True
 
150
class InvalidEntryName(BzrNewError):
 
151
    """Invalid entry name: %(name)s"""
 
152
 
 
153
    is_user_error = False
194
154
 
195
155
    def __init__(self, name):
196
 
        BzrError.__init__(self)
 
156
        BzrNewError.__init__(self)
197
157
        self.name = name
198
158
 
199
159
 
200
 
class InvalidRevisionNumber(BzrError):
201
 
    
202
 
    _fmt = "Invalid revision number %(revno)s"
203
 
 
 
160
class InvalidRevisionNumber(BzrNewError):
 
161
    """Invalid revision number %(revno)d"""
204
162
    def __init__(self, revno):
205
 
        BzrError.__init__(self)
 
163
        BzrNewError.__init__(self)
206
164
        self.revno = revno
207
165
 
208
166
 
209
 
class InvalidRevisionId(BzrError):
210
 
 
211
 
    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"
 
167
class InvalidRevisionId(BzrNewError):
 
168
    """Invalid revision-id {%(revision_id)s} in %(branch)s"""
212
169
 
213
170
    def __init__(self, revision_id, branch):
214
171
        # branch can be any string or object with __str__ defined
215
 
        BzrError.__init__(self)
 
172
        BzrNewError.__init__(self)
216
173
        self.revision_id = revision_id
217
174
        self.branch = branch
218
175
 
219
 
class ReservedId(BzrError):
220
 
 
221
 
    _fmt = "Reserved revision-id {%(revision_id)s}"
222
 
 
223
 
    def __init__(self, revision_id):
224
 
        self.revision_id = revision_id
225
 
 
226
 
class NoSuchId(BzrError):
227
 
 
228
 
    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."
 
176
 
 
177
class NoSuchId(BzrNewError):
 
178
    """The file id %(file_id)s is not present in the tree %(tree)s."""
229
179
    
230
180
    def __init__(self, tree, file_id):
231
 
        BzrError.__init__(self)
 
181
        BzrNewError.__init__(self)
232
182
        self.file_id = file_id
233
183
        self.tree = tree
234
184
 
235
185
 
236
 
class InventoryModified(BzrError):
237
 
 
238
 
    _fmt = ("The current inventory for the tree %(tree)r has been modified,"
239
 
            " so a clean inventory cannot be read without data loss.")
240
 
 
241
 
    internal_error = True
242
 
 
243
 
    def __init__(self, tree):
244
 
        self.tree = tree
245
 
 
246
 
 
247
 
class NoWorkingTree(BzrError):
248
 
 
249
 
    _fmt = "No WorkingTree exists for %(base)s."
 
186
class NoWorkingTree(BzrNewError):
 
187
    """No WorkingTree exists for %(base)s."""
250
188
    
251
189
    def __init__(self, base):
252
 
        BzrError.__init__(self)
 
190
        BzrNewError.__init__(self)
253
191
        self.base = base
254
192
 
255
193
 
256
 
class NotBuilding(BzrError):
257
 
 
258
 
    _fmt = "Not currently building a tree."
259
 
 
260
 
 
261
 
class NotLocalUrl(BzrError):
262
 
 
263
 
    _fmt = "%(url)s is not a local path."
264
 
 
 
194
class NotLocalUrl(BzrNewError):
 
195
    """%(url)s is not a local path."""
 
196
    
265
197
    def __init__(self, url):
 
198
        BzrNewError.__init__(self)
266
199
        self.url = url
267
200
 
268
201
 
269
 
class WorkingTreeAlreadyPopulated(BzrError):
270
 
 
271
 
    _fmt = """Working tree already populated in %(base)s"""
272
 
 
273
 
    internal_error = True
274
 
 
275
 
    def __init__(self, base):
276
 
        self.base = base
277
 
 
278
 
class BzrCommandError(BzrError):
 
202
class BzrCommandError(BzrNewError):
279
203
    """Error from user command"""
280
204
 
281
 
    internal_error = False
 
205
    is_user_error = True
282
206
 
283
207
    # Error from malformed user command; please avoid raising this as a
284
208
    # generic exception not caused by user input.
299
223
        return self.msg
300
224
 
301
225
 
302
 
class NotWriteLocked(BzrError):
303
 
 
304
 
    _fmt = """%(not_locked)r is not write locked but needs to be."""
305
 
 
306
 
    def __init__(self, not_locked):
307
 
        self.not_locked = not_locked
308
 
 
309
 
 
310
226
class BzrOptionError(BzrCommandError):
311
 
 
312
 
    _fmt = "Error in command line options"
313
 
 
314
 
 
315
 
class BadOptionValue(BzrError):
316
 
 
317
 
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
318
 
 
319
 
    def __init__(self, name, value):
320
 
        BzrError.__init__(self, name=name, value=value)
 
227
    """Error in command line options"""
321
228
 
322
229
    
323
 
class StrictCommitFailed(BzrError):
324
 
 
325
 
    _fmt = "Commit refused because there are unknown files in the tree"
 
230
class StrictCommitFailed(BzrNewError):
 
231
    """Commit refused because there are unknown files in the tree"""
326
232
 
327
233
 
328
234
# XXX: Should be unified with TransportError; they seem to represent the
329
235
# same thing
330
 
class PathError(BzrError):
331
 
    
332
 
    _fmt = "Generic path error: %(path)r%(extra)s)"
 
236
class PathError(BzrNewError):
 
237
    """Generic path error: %(path)r%(extra)s)"""
333
238
 
334
239
    def __init__(self, path, extra=None):
335
 
        BzrError.__init__(self)
 
240
        BzrNewError.__init__(self)
336
241
        self.path = path
337
242
        if extra:
338
243
            self.extra = ': ' + str(extra)
341
246
 
342
247
 
343
248
class NoSuchFile(PathError):
344
 
 
345
 
    _fmt = "No such file: %(path)r%(extra)s"
 
249
    """No such file: %(path)r%(extra)s"""
346
250
 
347
251
 
348
252
class FileExists(PathError):
349
 
 
350
 
    _fmt = "File exists: %(path)r%(extra)s"
351
 
 
352
 
 
353
 
class RenameFailedFilesExist(BzrError):
354
 
    """Used when renaming and both source and dest exist."""
355
 
 
356
 
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
357
 
            "%(extra)s")
358
 
 
359
 
    def __init__(self, source, dest, extra=None):
360
 
        BzrError.__init__(self)
361
 
        self.source = str(source)
362
 
        self.dest = str(dest)
363
 
        if extra:
364
 
            self.extra = ' ' + str(extra)
365
 
        else:
366
 
            self.extra = ''
367
 
 
368
 
 
369
 
class NotADirectory(PathError):
370
 
 
371
 
    _fmt = "%(path)r is not a directory %(extra)s"
372
 
 
373
 
 
374
 
class NotInWorkingDirectory(PathError):
375
 
 
376
 
    _fmt = "%(path)r is not in the working directory %(extra)s"
 
253
    """File exists: %(path)r%(extra)s"""
377
254
 
378
255
 
379
256
class DirectoryNotEmpty(PathError):
380
 
 
381
 
    _fmt = "Directory not empty: %(path)r%(extra)s"
382
 
 
383
 
 
384
 
class ReadingCompleted(BzrError):
385
 
    
386
 
    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "
387
 
            "called upon it - the request has been completed and no more "
388
 
            "data may be read.")
389
 
 
390
 
    internal_error = True
391
 
 
392
 
    def __init__(self, request):
393
 
        self.request = request
 
257
    """Directory not empty: %(path)r%(extra)s"""
394
258
 
395
259
 
396
260
class ResourceBusy(PathError):
397
 
 
398
 
    _fmt = "Device or resource busy: %(path)r%(extra)s"
 
261
    """Device or resource busy: %(path)r%(extra)s"""
399
262
 
400
263
 
401
264
class PermissionDenied(PathError):
402
 
 
403
 
    _fmt = "Permission denied: %(path)r%(extra)s"
 
265
    """Permission denied: %(path)r%(extra)s"""
404
266
 
405
267
 
406
268
class InvalidURL(PathError):
407
 
 
408
 
    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"
 
269
    """Invalid url supplied to transport: %(path)r%(extra)s"""
409
270
 
410
271
 
411
272
class InvalidURLJoin(PathError):
412
 
 
413
 
    _fmt = "Invalid URL join request: %(args)s%(extra)s"
 
273
    """Invalid URL join request: %(args)s%(extra)s"""
414
274
 
415
275
    def __init__(self, msg, base, args):
416
276
        PathError.__init__(self, base, msg)
417
 
        self.args = [base] + list(args)
418
 
 
419
 
 
420
 
class UnknownHook(BzrError):
421
 
 
422
 
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
423
 
 
424
 
    def __init__(self, hook_type, hook_name):
425
 
        BzrError.__init__(self)
426
 
        self.type = hook_type
427
 
        self.hook = hook_name
 
277
        self.args = [base]
 
278
        self.args.extend(args)
428
279
 
429
280
 
430
281
class UnsupportedProtocol(PathError):
431
 
 
432
 
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
 
282
    """Unsupported protocol for url "%(path)s"%(extra)s"""
433
283
 
434
284
    def __init__(self, url, extra):
435
285
        PathError.__init__(self, url, extra=extra)
436
286
 
437
287
 
438
 
class ShortReadvError(PathError):
439
 
 
440
 
    _fmt = ("readv() read %(actual)s bytes rather than %(length)s bytes"
441
 
            " at %(offset)s for %(path)s%(extra)s")
442
 
 
443
 
    internal_error = True
444
 
 
445
 
    def __init__(self, path, offset, length, actual, extra=None):
446
 
        PathError.__init__(self, path, extra=extra)
447
 
        self.offset = offset
448
 
        self.length = length
449
 
        self.actual = actual
450
 
 
451
 
 
452
 
class PathNotChild(BzrError):
453
 
 
454
 
    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"
455
 
 
456
 
    internal_error = True
 
288
class PathNotChild(BzrNewError):
 
289
    """Path %(path)r is not a child of path %(base)r%(extra)s"""
 
290
 
 
291
    is_user_error = False
457
292
 
458
293
    def __init__(self, path, base, extra=None):
459
 
        BzrError.__init__(self)
 
294
        BzrNewError.__init__(self)
460
295
        self.path = path
461
296
        self.base = base
462
297
        if extra:
466
301
 
467
302
 
468
303
class InvalidNormalization(PathError):
469
 
 
470
 
    _fmt = "Path %(path)r is not unicode normalized"
 
304
    """Path %(path)r is not unicode normalized"""
471
305
 
472
306
 
473
307
# TODO: This is given a URL; we try to unescape it but doing that from inside
474
308
# the exception object is a bit undesirable.
475
309
# TODO: Probably this behavior of should be a common superclass 
476
310
class NotBranchError(PathError):
477
 
 
478
 
    _fmt = "Not a branch: %(path)s"
 
311
    """Not a branch: %(path)s"""
479
312
 
480
313
    def __init__(self, path):
481
314
       import bzrlib.urlutils as urlutils
482
315
       self.path = urlutils.unescape_for_display(path, 'ascii')
483
316
 
484
317
 
485
 
class NoSubmitBranch(PathError):
486
 
 
487
 
    _fmt = 'No submit branch available for branch "%(path)s"'
488
 
 
489
 
    def __init__(self, branch):
490
 
       import bzrlib.urlutils as urlutils
491
 
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
492
 
 
493
 
 
494
318
class AlreadyBranchError(PathError):
495
 
 
496
 
    _fmt = "Already a branch: %(path)s."
 
319
    """Already a branch: %(path)s."""
497
320
 
498
321
 
499
322
class BranchExistsWithoutWorkingTree(PathError):
500
 
 
501
 
    _fmt = "Directory contains a branch, but no working tree \
502
 
(use bzr checkout if you wish to build a working tree): %(path)s"
 
323
    """Directory contains a branch, but no working tree \
 
324
(use bzr checkout if you wish to build a working tree): %(path)s"""
503
325
 
504
326
 
505
327
class AtomicFileAlreadyClosed(PathError):
506
 
 
507
 
    _fmt = ("'%(function)s' called on an AtomicFile after it was closed:"
508
 
            " %(path)s")
 
328
    """'%(function)s' called on an AtomicFile after it was closed: %(path)s"""
509
329
 
510
330
    def __init__(self, path, function):
511
331
        PathError.__init__(self, path=path, extra=None)
513
333
 
514
334
 
515
335
class InaccessibleParent(PathError):
516
 
 
517
 
    _fmt = ("Parent not accessible given base %(base)s and"
518
 
            " relative path %(path)s")
 
336
    """Parent not accessible given base %(base)s and relative path %(path)s"""
519
337
 
520
338
    def __init__(self, path, base):
521
339
        PathError.__init__(self, path)
522
340
        self.base = base
523
341
 
524
342
 
525
 
class NoRepositoryPresent(BzrError):
526
 
 
527
 
    _fmt = "No repository present: %(path)r"
 
343
class NoRepositoryPresent(BzrNewError):
 
344
    """No repository present: %(path)r"""
528
345
    def __init__(self, bzrdir):
529
 
        BzrError.__init__(self)
 
346
        BzrNewError.__init__(self)
530
347
        self.path = bzrdir.transport.clone('..').base
531
348
 
532
349
 
533
 
class FileInWrongBranch(BzrError):
534
 
 
535
 
    _fmt = "File %(path)s in not in branch %(branch_base)s."
 
350
class FileInWrongBranch(BzrNewError):
 
351
    """File %(path)s in not in branch %(branch_base)s."""
536
352
 
537
353
    def __init__(self, branch, path):
538
 
        BzrError.__init__(self)
 
354
        BzrNewError.__init__(self)
539
355
        self.branch = branch
540
356
        self.branch_base = branch.base
541
357
        self.path = path
542
358
 
543
359
 
544
 
class UnsupportedFormatError(BzrError):
545
 
 
546
 
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
547
 
 
548
 
 
549
 
class UnknownFormatError(BzrError):
550
 
    
551
 
    _fmt = "Unknown branch format: %(format)r"
552
 
 
553
 
 
554
 
class IncompatibleFormat(BzrError):
555
 
    
556
 
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
360
class UnsupportedFormatError(BzrNewError):
 
361
    """Unsupported branch format: %(format)s"""
 
362
 
 
363
 
 
364
class UnknownFormatError(BzrNewError):
 
365
    """Unknown branch format: %(format)r"""
 
366
 
 
367
 
 
368
class IncompatibleFormat(BzrNewError):
 
369
    """Format %(format)s is not compatible with .bzr version %(bzrdir)s."""
557
370
 
558
371
    def __init__(self, format, bzrdir_format):
559
 
        BzrError.__init__(self)
 
372
        BzrNewError.__init__(self)
560
373
        self.format = format
561
374
        self.bzrdir = bzrdir_format
562
375
 
563
376
 
564
 
class IncompatibleRepositories(BzrError):
565
 
 
566
 
    _fmt = "Repository %(target)s is not compatible with repository"\
567
 
        " %(source)s"
568
 
 
569
 
    def __init__(self, source, target):
570
 
        BzrError.__init__(self, target=target, source=source)
571
 
 
572
 
 
573
 
class IncompatibleRevision(BzrError):
574
 
    
575
 
    _fmt = "Revision is not compatible with %(repo_format)s"
576
 
 
577
 
    def __init__(self, repo_format):
578
 
        BzrError.__init__(self)
579
 
        self.repo_format = repo_format
580
 
 
581
 
 
582
 
class AlreadyVersionedError(BzrError):
583
 
    """Used when a path is expected not to be versioned, but it is."""
584
 
 
585
 
    _fmt = "%(context_info)s%(path)s is already versioned"
586
 
 
587
 
    def __init__(self, path, context_info=None):
588
 
        """Construct a new AlreadyVersionedError.
589
 
 
590
 
        :param path: This is the path which is versioned,
591
 
        which should be in a user friendly form.
592
 
        :param context_info: If given, this is information about the context,
593
 
        which could explain why this is expected to not be versioned.
594
 
        """
595
 
        BzrError.__init__(self)
596
 
        self.path = path
597
 
        if context_info is None:
598
 
            self.context_info = ''
599
 
        else:
600
 
            self.context_info = context_info + ". "
601
 
 
602
 
 
603
 
class NotVersionedError(BzrError):
604
 
    """Used when a path is expected to be versioned, but it is not."""
605
 
 
606
 
    _fmt = "%(context_info)s%(path)s is not versioned"
607
 
 
608
 
    def __init__(self, path, context_info=None):
609
 
        """Construct a new NotVersionedError.
610
 
 
611
 
        :param path: This is the path which is not versioned,
612
 
        which should be in a user friendly form.
613
 
        :param context_info: If given, this is information about the context,
614
 
        which could explain why this is expected to be versioned.
615
 
        """
616
 
        BzrError.__init__(self)
617
 
        self.path = path
618
 
        if context_info is None:
619
 
            self.context_info = ''
620
 
        else:
621
 
            self.context_info = context_info + ". "
622
 
 
623
 
 
624
 
class PathsNotVersionedError(BzrError):
625
 
    """Used when reporting several paths which are not versioned"""
626
 
 
627
 
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
 
377
class NotVersionedError(BzrNewError):
 
378
    """%(path)s is not versioned"""
 
379
    def __init__(self, path):
 
380
        BzrNewError.__init__(self)
 
381
        self.path = path
 
382
 
 
383
 
 
384
class PathsNotVersionedError(BzrNewError):
 
385
    # used when reporting several paths are not versioned
 
386
    """Path(s) are not versioned: %(paths_as_string)s"""
628
387
 
629
388
    def __init__(self, paths):
630
389
        from bzrlib.osutils import quotefn
631
 
        BzrError.__init__(self)
 
390
        BzrNewError.__init__(self)
632
391
        self.paths = paths
633
392
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
634
393
 
635
394
 
636
 
class PathsDoNotExist(BzrError):
637
 
 
638
 
    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"
 
395
class PathsDoNotExist(BzrNewError):
 
396
    """Path(s) do not exist: %(paths_as_string)s"""
639
397
 
640
398
    # used when reporting that paths are neither versioned nor in the working
641
399
    # tree
642
400
 
643
 
    def __init__(self, paths, extra=None):
 
401
    def __init__(self, paths):
644
402
        # circular import
645
403
        from bzrlib.osutils import quotefn
646
 
        BzrError.__init__(self)
 
404
        BzrNewError.__init__(self)
647
405
        self.paths = paths
648
406
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
649
 
        if extra:
650
 
            self.extra = ': ' + str(extra)
651
 
        else:
652
 
            self.extra = ''
653
 
 
654
 
 
655
 
class BadFileKindError(BzrError):
656
 
 
657
 
    _fmt = 'Cannot operate on "%(filename)s" of unsupported kind "%(kind)s"'
658
 
 
659
 
    def __init__(self, filename, kind):
660
 
        BzrError.__init__(self, filename=filename, kind=kind)
661
 
 
662
 
 
663
 
class ForbiddenControlFileError(BzrError):
664
 
 
665
 
    _fmt = "Cannot operate on %(filename)s because it is a control file"
666
 
 
667
 
 
668
 
class LockError(BzrError):
669
 
 
670
 
    _fmt = "Lock error: %(msg)s"
671
 
 
672
 
    internal_error = True
673
 
 
 
407
 
 
408
 
 
409
class BadFileKindError(BzrNewError):
 
410
    """Cannot operate on %(filename)s of unsupported kind %(kind)s"""
 
411
 
 
412
 
 
413
class ForbiddenControlFileError(BzrNewError):
 
414
    """Cannot operate on %(filename)s because it is a control file"""
 
415
 
 
416
 
 
417
class LockError(BzrNewError):
 
418
    """Lock error: %(message)s"""
674
419
    # All exceptions from the lock/unlock functions should be from
675
420
    # this exception class.  They will be translated as necessary. The
676
421
    # original exception is available as e.original_error
677
422
    #
678
423
    # New code should prefer to raise specific subclasses
679
424
    def __init__(self, message):
680
 
        # Python 2.5 uses a slot for StandardError.message,
681
 
        # so use a different variable name
682
 
        # so it is exposed in self.__dict__
683
 
        self.msg = message
684
 
 
685
 
 
686
 
class LockActive(LockError):
687
 
 
688
 
    _fmt = "The lock for '%(lock_description)s' is in use and cannot be broken."
689
 
 
690
 
    internal_error = False
691
 
 
692
 
    def __init__(self, lock_description):
693
 
        self.lock_description = lock_description
 
425
        self.message = message
694
426
 
695
427
 
696
428
class CommitNotPossible(LockError):
697
 
 
698
 
    _fmt = "A commit was attempted but we do not have a write lock open."
699
 
 
 
429
    """A commit was attempted but we do not have a write lock open."""
700
430
    def __init__(self):
701
431
        pass
702
432
 
703
433
 
704
434
class AlreadyCommitted(LockError):
705
 
 
706
 
    _fmt = "A rollback was requested, but is not able to be accomplished."
707
 
 
 
435
    """A rollback was requested, but is not able to be accomplished."""
708
436
    def __init__(self):
709
437
        pass
710
438
 
711
439
 
712
440
class ReadOnlyError(LockError):
713
 
 
714
 
    _fmt = "A write attempt was made in a read only transaction on %(obj)s"
715
 
 
716
 
    # TODO: There should also be an error indicating that you need a write
717
 
    # lock and don't have any lock at all... mbp 20070226
718
 
 
 
441
    """A write attempt was made in a read only transaction on %(obj)s"""
719
442
    def __init__(self, obj):
720
443
        self.obj = obj
721
444
 
722
445
 
723
 
class ReadOnlyLockError(LockError):
724
 
 
725
 
    _fmt = "Cannot acquire write lock on %(fname)s. %(msg)s"
726
 
 
727
 
    def __init__(self, fname, msg):
728
 
        LockError.__init__(self, '')
729
 
        self.fname = fname
730
 
        self.msg = msg
731
 
 
732
 
 
733
 
class OutSideTransaction(BzrError):
734
 
 
735
 
    _fmt = ("A transaction related operation was attempted after"
736
 
            " the transaction finished.")
 
446
class OutSideTransaction(BzrNewError):
 
447
    """A transaction related operation was attempted after the transaction finished."""
737
448
 
738
449
 
739
450
class ObjectNotLocked(LockError):
 
451
    """%(obj)r is not locked"""
740
452
 
741
 
    _fmt = "%(obj)r is not locked"
 
453
    is_user_error = False
742
454
 
743
455
    # this can indicate that any particular object is not locked; see also
744
456
    # LockNotHeld which means that a particular *lock* object is not held by
748
460
 
749
461
 
750
462
class ReadOnlyObjectDirtiedError(ReadOnlyError):
751
 
 
752
 
    _fmt = "Cannot change object %(obj)r in read only transaction"
753
 
 
 
463
    """Cannot change object %(obj)r in read only transaction"""
754
464
    def __init__(self, obj):
755
465
        self.obj = obj
756
466
 
757
467
 
758
468
class UnlockableTransport(LockError):
759
 
 
760
 
    _fmt = "Cannot lock: transport is read only: %(transport)s"
761
 
 
 
469
    """Cannot lock: transport is read only: %(transport)s"""
762
470
    def __init__(self, transport):
763
471
        self.transport = transport
764
472
 
765
473
 
766
474
class LockContention(LockError):
767
 
 
768
 
    _fmt = "Could not acquire lock %(lock)s"
769
 
    # TODO: show full url for lock, combining the transport and relative
770
 
    # bits?
771
 
 
772
 
    internal_error = False
773
 
 
 
475
    """Could not acquire lock %(lock)s"""
 
476
    # TODO: show full url for lock, combining the transport and relative bits?
774
477
    def __init__(self, lock):
775
478
        self.lock = lock
776
479
 
777
480
 
778
481
class LockBroken(LockError):
779
 
 
780
 
    _fmt = ("Lock was broken while still open: %(lock)s"
781
 
            " - check storage consistency!")
782
 
 
783
 
    internal_error = False
784
 
 
 
482
    """Lock was broken while still open: %(lock)s - check storage consistency!"""
785
483
    def __init__(self, lock):
786
484
        self.lock = lock
787
485
 
788
486
 
789
487
class LockBreakMismatch(LockError):
790
 
 
791
 
    _fmt = ("Lock was released and re-acquired before being broken:"
792
 
            " %(lock)s: held by %(holder)r, wanted to break %(target)r")
793
 
 
794
 
    internal_error = False
795
 
 
 
488
    """Lock was released and re-acquired before being broken: %(lock)s: held by %(holder)r, wanted to break %(target)r"""
796
489
    def __init__(self, lock, holder, target):
797
490
        self.lock = lock
798
491
        self.holder = holder
800
493
 
801
494
 
802
495
class LockNotHeld(LockError):
803
 
 
804
 
    _fmt = "Lock not held: %(lock)s"
805
 
 
806
 
    internal_error = False
807
 
 
 
496
    """Lock not held: %(lock)s"""
808
497
    def __init__(self, lock):
809
498
        self.lock = lock
810
499
 
811
500
 
812
 
class TokenLockingNotSupported(LockError):
813
 
 
814
 
    _fmt = "The object %(obj)s does not support token specifying a token when locking."
815
 
 
816
 
    internal_error = True
817
 
 
818
 
    def __init__(self, obj):
819
 
        self.obj = obj
820
 
 
821
 
 
822
 
class TokenMismatch(LockBroken):
823
 
 
824
 
    _fmt = "The lock token %(given_token)r does not match lock token %(lock_token)r."
825
 
 
826
 
    internal_error = True
827
 
 
828
 
    def __init__(self, given_token, lock_token):
829
 
        self.given_token = given_token
830
 
        self.lock_token = lock_token
831
 
 
832
 
 
833
 
class PointlessCommit(BzrError):
834
 
 
835
 
    _fmt = "No changes to commit"
836
 
 
837
 
 
838
 
class UpgradeReadonly(BzrError):
839
 
 
840
 
    _fmt = "Upgrade URL cannot work with readonly URLs."
841
 
 
842
 
 
843
 
class UpToDateFormat(BzrError):
844
 
 
845
 
    _fmt = "The branch format %(format)s is already at the most recent format."
 
501
class PointlessCommit(BzrNewError):
 
502
    """No changes to commit"""
 
503
 
 
504
 
 
505
class UpgradeReadonly(BzrNewError):
 
506
    """Upgrade URL cannot work with readonly URL's."""
 
507
 
 
508
 
 
509
class UpToDateFormat(BzrNewError):
 
510
    """The branch format %(format)s is already at the most recent format."""
846
511
 
847
512
    def __init__(self, format):
848
 
        BzrError.__init__(self)
 
513
        BzrNewError.__init__(self)
849
514
        self.format = format
850
515
 
851
516
 
852
517
class StrictCommitFailed(Exception):
853
 
 
854
 
    _fmt = "Commit refused because there are unknowns in the tree."
855
 
 
856
 
 
857
 
class NoSuchRevision(BzrError):
858
 
 
859
 
    _fmt = "Branch %(branch)s has no revision %(revision)s"
860
 
 
861
 
    internal_error = True
 
518
    """Commit refused because there are unknowns in the tree."""
 
519
 
 
520
 
 
521
class NoSuchRevision(BzrNewError):
 
522
    """Branch %(branch)s has no revision %(revision)s"""
 
523
 
 
524
    is_user_error = False
862
525
 
863
526
    def __init__(self, branch, revision):
864
 
        BzrError.__init__(self, branch=branch, revision=revision)
865
 
 
866
 
 
867
 
class NotLeftParentDescendant(BzrError):
868
 
 
869
 
    _fmt = ("Revision %(old_revision)s is not the left parent of"
870
 
            " %(new_revision)s, but branch %(branch_location)s expects this")
871
 
 
872
 
    internal_error = True
873
 
 
874
 
    def __init__(self, branch, old_revision, new_revision):
875
 
        BzrError.__init__(self, branch_location=branch.base,
876
 
                          old_revision=old_revision,
877
 
                          new_revision=new_revision)
878
 
 
879
 
 
880
 
class NoSuchRevisionSpec(BzrError):
881
 
 
882
 
    _fmt = "No namespace registered for string: %(spec)r"
 
527
        BzrNewError.__init__(self, branch=branch, revision=revision)
 
528
 
 
529
 
 
530
class NoSuchRevisionSpec(BzrNewError):
 
531
    """No namespace registered for string: %(spec)r"""
883
532
 
884
533
    def __init__(self, spec):
885
 
        BzrError.__init__(self, spec=spec)
886
 
 
887
 
 
888
 
class NoSuchRevisionInTree(NoSuchRevision):
889
 
    """When using Tree.revision_tree, and the revision is not accessible."""
890
 
    
891
 
    _fmt = "The revision id %(revision_id)s is not present in the tree %(tree)s."
892
 
 
893
 
    def __init__(self, tree, revision_id):
894
 
        BzrError.__init__(self)
895
 
        self.tree = tree
896
 
        self.revision_id = revision_id
897
 
 
898
 
 
899
 
class InvalidRevisionSpec(BzrError):
900
 
 
901
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
902
 
            " %(branch)s%(extra)s")
 
534
        BzrNewError.__init__(self, spec=spec)
 
535
 
 
536
 
 
537
class InvalidRevisionSpec(BzrNewError):
 
538
    """Requested revision: '%(spec)s' does not exist in branch:
 
539
%(branch)s%(extra)s"""
903
540
 
904
541
    def __init__(self, spec, branch, extra=None):
905
 
        BzrError.__init__(self, branch=branch, spec=spec)
 
542
        BzrNewError.__init__(self, branch=branch, spec=spec)
906
543
        if extra:
907
544
            self.extra = '\n' + str(extra)
908
545
        else:
910
547
 
911
548
 
912
549
class HistoryMissing(BzrError):
913
 
 
914
 
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
915
 
 
916
 
 
917
 
class AppendRevisionsOnlyViolation(BzrError):
918
 
 
919
 
    _fmt = ('Operation denied because it would change the main history,'
920
 
           ' which is not permitted by the append_revisions_only setting on'
921
 
           ' branch "%(location)s".')
922
 
 
923
 
    def __init__(self, location):
924
 
       import bzrlib.urlutils as urlutils
925
 
       location = urlutils.unescape_for_display(location, 'ascii')
926
 
       BzrError.__init__(self, location=location)
927
 
 
928
 
 
929
 
class DivergedBranches(BzrError):
930
 
 
931
 
    _fmt = ("These branches have diverged."
932
 
            " Use the merge command to reconcile them.")
933
 
 
934
 
    internal_error = False
 
550
    def __init__(self, branch, object_type, object_id):
 
551
        self.branch = branch
 
552
        BzrError.__init__(self,
 
553
                          '%s is missing %s {%s}'
 
554
                          % (branch, object_type, object_id))
 
555
 
 
556
 
 
557
class DivergedBranches(BzrNewError):
 
558
    "These branches have diverged.  Use the merge command to reconcile them."""
 
559
 
 
560
    is_user_error = True
935
561
 
936
562
    def __init__(self, branch1, branch2):
937
563
        self.branch1 = branch1
938
564
        self.branch2 = branch2
939
565
 
940
566
 
941
 
class NotLefthandHistory(BzrError):
942
 
 
943
 
    _fmt = "Supplied history does not follow left-hand parents"
944
 
 
945
 
    internal_error = True
946
 
 
947
 
    def __init__(self, history):
948
 
        BzrError.__init__(self, history=history)
949
 
 
950
 
 
951
 
class UnrelatedBranches(BzrError):
952
 
 
953
 
    _fmt = ("Branches have no common ancestor, and"
954
 
            " no merge base revision was specified.")
955
 
 
956
 
    internal_error = False
957
 
 
958
 
 
959
 
class NoCommonAncestor(BzrError):
960
 
    
961
 
    _fmt = "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
 
567
class UnrelatedBranches(BzrNewError):
 
568
    "Branches have no common ancestor, and no merge base revision was specified."
 
569
 
 
570
    is_user_error = True
 
571
 
 
572
 
 
573
class NoCommonAncestor(BzrNewError):
 
574
    "Revisions have no common ancestor: %(revision_a)s %(revision_b)s"
962
575
 
963
576
    def __init__(self, revision_a, revision_b):
964
577
        self.revision_a = revision_a
966
579
 
967
580
 
968
581
class NoCommonRoot(BzrError):
969
 
 
970
 
    _fmt = ("Revisions are not derived from the same root: "
971
 
           "%(revision_a)s %(revision_b)s.")
972
 
 
973
582
    def __init__(self, revision_a, revision_b):
974
 
        BzrError.__init__(self, revision_a=revision_a, revision_b=revision_b)
 
583
        msg = "Revisions are not derived from the same root: %s %s." \
 
584
            % (revision_a, revision_b) 
 
585
        BzrError.__init__(self, msg)
 
586
 
975
587
 
976
588
 
977
589
class NotAncestor(BzrError):
978
 
 
979
 
    _fmt = "Revision %(rev_id)s is not an ancestor of %(not_ancestor_id)s"
980
 
 
981
590
    def __init__(self, rev_id, not_ancestor_id):
982
 
        BzrError.__init__(self, rev_id=rev_id,
983
 
            not_ancestor_id=not_ancestor_id)
 
591
        msg = "Revision %s is not an ancestor of %s" % (not_ancestor_id, 
 
592
                                                        rev_id)
 
593
        BzrError.__init__(self, msg)
 
594
        self.rev_id = rev_id
 
595
        self.not_ancestor_id = not_ancestor_id
984
596
 
985
597
 
986
598
class InstallFailed(BzrError):
987
 
 
988
599
    def __init__(self, revisions):
989
 
        revision_str = ", ".join(str(r) for r in revisions)
990
 
        msg = "Could not install revisions:\n%s" % revision_str
 
600
        msg = "Could not install revisions:\n%s" % " ,".join(revisions)
991
601
        BzrError.__init__(self, msg)
992
602
        self.revisions = revisions
993
603
 
994
604
 
995
605
class AmbiguousBase(BzrError):
996
 
 
997
606
    def __init__(self, bases):
998
607
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
999
608
                DeprecationWarning)
1000
 
        msg = ("The correct base is unclear, because %s are all equally close"
1001
 
                % ", ".join(bases))
 
609
        msg = "The correct base is unclear, because %s are all equally close" %\
 
610
            ", ".join(bases)
1002
611
        BzrError.__init__(self, msg)
1003
612
        self.bases = bases
1004
613
 
1005
614
 
1006
 
class NoCommits(BzrError):
1007
 
 
1008
 
    _fmt = "Branch %(branch)s has no commits."
 
615
class NoCommits(BzrNewError):
 
616
    """Branch %(branch)s has no commits."""
1009
617
 
1010
618
    def __init__(self, branch):
1011
 
        BzrError.__init__(self, branch=branch)
 
619
        BzrNewError.__init__(self, branch=branch)
1012
620
 
1013
621
 
1014
622
class UnlistableStore(BzrError):
1015
 
 
1016
623
    def __init__(self, store):
1017
624
        BzrError.__init__(self, "Store %s is not listable" % store)
1018
625
 
1019
626
 
1020
627
 
1021
628
class UnlistableBranch(BzrError):
1022
 
 
1023
629
    def __init__(self, br):
1024
630
        BzrError.__init__(self, "Stores for branch %s are not listable" % br)
1025
631
 
1026
632
 
1027
 
class BoundBranchOutOfDate(BzrError):
1028
 
 
1029
 
    _fmt = ("Bound branch %(branch)s is out of date"
1030
 
            " with master branch %(master)s.")
1031
 
 
 
633
class BoundBranchOutOfDate(BzrNewError):
 
634
    """Bound branch %(branch)s is out of date with master branch %(master)s."""
1032
635
    def __init__(self, branch, master):
1033
 
        BzrError.__init__(self)
 
636
        BzrNewError.__init__(self)
1034
637
        self.branch = branch
1035
638
        self.master = master
1036
639
 
1037
640
        
1038
 
class CommitToDoubleBoundBranch(BzrError):
1039
 
 
1040
 
    _fmt = ("Cannot commit to branch %(branch)s."
1041
 
            " It is bound to %(master)s, which is bound to %(remote)s.")
1042
 
 
 
641
class CommitToDoubleBoundBranch(BzrNewError):
 
642
    """Cannot commit to branch %(branch)s. It is bound to %(master)s, which is bound to %(remote)s."""
1043
643
    def __init__(self, branch, master, remote):
1044
 
        BzrError.__init__(self)
 
644
        BzrNewError.__init__(self)
1045
645
        self.branch = branch
1046
646
        self.master = master
1047
647
        self.remote = remote
1048
648
 
1049
649
 
1050
 
class OverwriteBoundBranch(BzrError):
1051
 
 
1052
 
    _fmt = "Cannot pull --overwrite to a branch which is bound %(branch)s"
1053
 
 
 
650
class OverwriteBoundBranch(BzrNewError):
 
651
    """Cannot pull --overwrite to a branch which is bound %(branch)s"""
1054
652
    def __init__(self, branch):
1055
 
        BzrError.__init__(self)
 
653
        BzrNewError.__init__(self)
1056
654
        self.branch = branch
1057
655
 
1058
656
 
1059
 
class BoundBranchConnectionFailure(BzrError):
1060
 
 
1061
 
    _fmt = ("Unable to connect to target of bound branch %(branch)s"
1062
 
            " => %(target)s: %(error)s")
1063
 
 
 
657
class BoundBranchConnectionFailure(BzrNewError):
 
658
    """Unable to connect to target of bound branch %(branch)s => %(target)s: %(error)s"""
1064
659
    def __init__(self, branch, target, error):
1065
 
        BzrError.__init__(self)
 
660
        BzrNewError.__init__(self)
1066
661
        self.branch = branch
1067
662
        self.target = target
1068
663
        self.error = error
1069
664
 
1070
665
 
1071
 
class WeaveError(BzrError):
1072
 
 
1073
 
    _fmt = "Error in processing weave: %(message)s"
 
666
class WeaveError(BzrNewError):
 
667
    """Error in processing weave: %(message)s"""
1074
668
 
1075
669
    def __init__(self, message=None):
1076
 
        BzrError.__init__(self)
 
670
        BzrNewError.__init__(self)
1077
671
        self.message = message
1078
672
 
1079
673
 
1080
674
class WeaveRevisionAlreadyPresent(WeaveError):
1081
 
 
1082
 
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
1083
 
 
 
675
    """Revision {%(revision_id)s} already present in %(weave)s"""
1084
676
    def __init__(self, revision_id, weave):
1085
677
 
1086
678
        WeaveError.__init__(self)
1089
681
 
1090
682
 
1091
683
class WeaveRevisionNotPresent(WeaveError):
1092
 
 
1093
 
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
684
    """Revision {%(revision_id)s} not present in %(weave)s"""
1094
685
 
1095
686
    def __init__(self, revision_id, weave):
1096
687
        WeaveError.__init__(self)
1099
690
 
1100
691
 
1101
692
class WeaveFormatError(WeaveError):
1102
 
 
1103
 
    _fmt = "Weave invariant violated: %(what)s"
 
693
    """Weave invariant violated: %(what)s"""
1104
694
 
1105
695
    def __init__(self, what):
1106
696
        WeaveError.__init__(self)
1108
698
 
1109
699
 
1110
700
class WeaveParentMismatch(WeaveError):
1111
 
 
1112
 
    _fmt = "Parents are mismatched between two revisions."
 
701
    """Parents are mismatched between two revisions."""
1113
702
    
1114
703
 
1115
704
class WeaveInvalidChecksum(WeaveError):
1116
 
 
1117
 
    _fmt = "Text did not match it's checksum: %(message)s"
1118
 
 
1119
 
 
1120
 
class WeaveTextDiffers(WeaveError):
1121
 
 
1122
 
    _fmt = ("Weaves differ on text content. Revision:"
1123
 
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
1124
 
 
1125
 
    def __init__(self, revision_id, weave_a, weave_b):
1126
 
        WeaveError.__init__(self)
1127
 
        self.revision_id = revision_id
1128
 
        self.weave_a = weave_a
1129
 
        self.weave_b = weave_b
1130
 
 
1131
 
 
1132
 
class WeaveTextDiffers(WeaveError):
1133
 
 
1134
 
    _fmt = ("Weaves differ on text content. Revision:"
1135
 
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
1136
 
 
1137
 
    def __init__(self, revision_id, weave_a, weave_b):
1138
 
        WeaveError.__init__(self)
1139
 
        self.revision_id = revision_id
1140
 
        self.weave_a = weave_a
1141
 
        self.weave_b = weave_b
1142
 
 
1143
 
 
1144
 
class VersionedFileError(BzrError):
1145
 
    
1146
 
    _fmt = "Versioned file error"
 
705
    """Text did not match it's checksum: %(message)s"""
 
706
 
 
707
 
 
708
class WeaveTextDiffers(WeaveError):
 
709
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
710
 
 
711
    def __init__(self, revision_id, weave_a, weave_b):
 
712
        WeaveError.__init__(self)
 
713
        self.revision_id = revision_id
 
714
        self.weave_a = weave_a
 
715
        self.weave_b = weave_b
 
716
 
 
717
 
 
718
class WeaveTextDiffers(WeaveError):
 
719
    """Weaves differ on text content. Revision: {%(revision_id)s}, %(weave_a)s, %(weave_b)s"""
 
720
 
 
721
    def __init__(self, revision_id, weave_a, weave_b):
 
722
        WeaveError.__init__(self)
 
723
        self.revision_id = revision_id
 
724
        self.weave_a = weave_a
 
725
        self.weave_b = weave_b
 
726
 
 
727
 
 
728
class VersionedFileError(BzrNewError):
 
729
    """Versioned file error."""
1147
730
 
1148
731
 
1149
732
class RevisionNotPresent(VersionedFileError):
1150
 
    
1151
 
    _fmt = "Revision {%(revision_id)s} not present in %(file_id)s."
 
733
    """Revision {%(revision_id)s} not present in %(file_id)s."""
1152
734
 
1153
735
    def __init__(self, revision_id, file_id):
1154
736
        VersionedFileError.__init__(self)
1157
739
 
1158
740
 
1159
741
class RevisionAlreadyPresent(VersionedFileError):
1160
 
    
1161
 
    _fmt = "Revision {%(revision_id)s} already present in %(file_id)s."
 
742
    """Revision {%(revision_id)s} already present in %(file_id)s."""
1162
743
 
1163
744
    def __init__(self, revision_id, file_id):
1164
745
        VersionedFileError.__init__(self)
1166
747
        self.file_id = file_id
1167
748
 
1168
749
 
1169
 
class KnitError(BzrError):
1170
 
    
1171
 
    _fmt = "Knit error"
1172
 
 
1173
 
    internal_error = True
 
750
class KnitError(BzrNewError):
 
751
    """Knit error"""
1174
752
 
1175
753
 
1176
754
class KnitHeaderError(KnitError):
1177
 
 
1178
 
    _fmt = "Knit header error: %(badline)r unexpected for file %(filename)s"
1179
 
 
1180
 
    def __init__(self, badline, filename):
 
755
    """Knit header error: %(badline)r unexpected"""
 
756
 
 
757
    def __init__(self, badline):
1181
758
        KnitError.__init__(self)
1182
759
        self.badline = badline
1183
 
        self.filename = filename
1184
760
 
1185
761
 
1186
762
class KnitCorrupt(KnitError):
1187
 
 
1188
 
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
763
    """Knit %(filename)s corrupt: %(how)s"""
1189
764
 
1190
765
    def __init__(self, filename, how):
1191
766
        KnitError.__init__(self)
1193
768
        self.how = how
1194
769
 
1195
770
 
1196
 
class KnitIndexUnknownMethod(KnitError):
1197
 
    """Raised when we don't understand the storage method.
1198
 
 
1199
 
    Currently only 'fulltext' and 'line-delta' are supported.
1200
 
    """
1201
 
    
1202
 
    _fmt = ("Knit index %(filename)s does not have a known method"
1203
 
            " in options: %(options)r")
1204
 
 
1205
 
    def __init__(self, filename, options):
1206
 
        KnitError.__init__(self)
1207
 
        self.filename = filename
1208
 
        self.options = options
1209
 
 
1210
 
 
1211
 
class NoSuchExportFormat(BzrError):
1212
 
    
1213
 
    _fmt = "Export format %(format)r not supported"
1214
 
 
 
771
class NoSuchExportFormat(BzrNewError):
 
772
    """Export format %(format)r not supported"""
1215
773
    def __init__(self, format):
1216
 
        BzrError.__init__(self)
 
774
        BzrNewError.__init__(self)
1217
775
        self.format = format
1218
776
 
1219
777
 
1220
 
class TransportError(BzrError):
1221
 
    
1222
 
    _fmt = "Transport error: %(msg)s %(orig_error)s"
 
778
class TransportError(BzrNewError):
 
779
    """Transport error: %(msg)s %(orig_error)s"""
1223
780
 
1224
781
    def __init__(self, msg=None, orig_error=None):
1225
782
        if msg is None and orig_error is not None:
1230
787
            msg =  ''
1231
788
        self.msg = msg
1232
789
        self.orig_error = orig_error
1233
 
        BzrError.__init__(self)
1234
 
 
1235
 
 
1236
 
class TooManyConcurrentRequests(BzrError):
1237
 
 
1238
 
    _fmt = ("The medium '%(medium)s' has reached its concurrent request limit."
1239
 
            " Be sure to finish_writing and finish_reading on the"
1240
 
            " current request that is open.")
1241
 
 
1242
 
    internal_error = True
1243
 
 
1244
 
    def __init__(self, medium):
1245
 
        self.medium = medium
1246
 
 
1247
 
 
1248
 
class SmartProtocolError(TransportError):
1249
 
 
1250
 
    _fmt = "Generic bzr smart protocol error: %(details)s"
1251
 
 
1252
 
    def __init__(self, details):
1253
 
        self.details = details
 
790
        BzrNewError.__init__(self)
1254
791
 
1255
792
 
1256
793
# A set of semi-meaningful errors which can be thrown
1257
794
class TransportNotPossible(TransportError):
1258
 
 
1259
 
    _fmt = "Transport operation not possible: %(msg)s %(orig_error)s"
 
795
    """Transport operation not possible: %(msg)s %(orig_error)%"""
1260
796
 
1261
797
 
1262
798
class ConnectionError(TransportError):
1263
 
 
1264
 
    _fmt = "Connection error: %(msg)s %(orig_error)s"
1265
 
 
1266
 
 
1267
 
class SocketConnectionError(ConnectionError):
1268
 
 
1269
 
    _fmt = "%(msg)s %(host)s%(port)s%(orig_error)s"
1270
 
 
1271
 
    def __init__(self, host, port=None, msg=None, orig_error=None):
1272
 
        if msg is None:
1273
 
            msg = 'Failed to connect to'
1274
 
        if orig_error is None:
1275
 
            orig_error = ''
1276
 
        else:
1277
 
            orig_error = '; ' + str(orig_error)
1278
 
        ConnectionError.__init__(self, msg=msg, orig_error=orig_error)
1279
 
        self.host = host
1280
 
        if port is None:
1281
 
            self.port = ''
1282
 
        else:
1283
 
            self.port = ':%s' % port
 
799
    """Connection error: %(msg)s %(orig_error)s"""
1284
800
 
1285
801
 
1286
802
class ConnectionReset(TransportError):
1287
 
 
1288
 
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
 
803
    """Connection closed: %(msg)s %(orig_error)s"""
1289
804
 
1290
805
 
1291
806
class InvalidRange(TransportError):
1292
 
 
1293
 
    _fmt = "Invalid range access in %(path)s at %(offset)s."
 
807
    """Invalid range access in %(path)s at %(offset)s."""
1294
808
    
1295
809
    def __init__(self, path, offset):
1296
810
        TransportError.__init__(self, ("Invalid range access in %s at %d"
1300
814
 
1301
815
 
1302
816
class InvalidHttpResponse(TransportError):
1303
 
 
1304
 
    _fmt = "Invalid http response for %(path)s: %(msg)s"
 
817
    """Invalid http response for %(path)s: %(msg)s"""
1305
818
 
1306
819
    def __init__(self, path, msg, orig_error=None):
1307
820
        self.path = path
1309
822
 
1310
823
 
1311
824
class InvalidHttpRange(InvalidHttpResponse):
1312
 
 
1313
 
    _fmt = "Invalid http range %(range)r for %(path)s: %(msg)s"
 
825
    """Invalid http range "%(range)s" for %(path)s: %(msg)s"""
1314
826
    
1315
827
    def __init__(self, path, range, msg):
1316
828
        self.range = range
1318
830
 
1319
831
 
1320
832
class InvalidHttpContentType(InvalidHttpResponse):
1321
 
 
1322
 
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
 
833
    """Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s"""
1323
834
    
1324
835
    def __init__(self, path, ctype, msg):
1325
836
        self.ctype = ctype
1326
837
        InvalidHttpResponse.__init__(self, path, msg)
1327
838
 
1328
839
 
1329
 
class RedirectRequested(TransportError):
1330
 
 
1331
 
    _fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1332
 
 
1333
 
    def __init__(self, source, target, is_permament=False, qual_proto=None):
1334
 
        self.source = source
1335
 
        self.target = target
1336
 
        if is_permament:
1337
 
            self.permanently = ' permanently'
1338
 
        else:
1339
 
            self.permanently = ''
1340
 
        self.is_permament = is_permament
1341
 
        self._qualified_proto = qual_proto
1342
 
        TransportError.__init__(self)
1343
 
 
1344
 
    def _requalify_url(self, url):
1345
 
        """Restore the qualified proto in front of the url"""
1346
 
        # When this exception is raised, source and target are in
1347
 
        # user readable format. But some transports may use a
1348
 
        # different proto (http+urllib:// will present http:// to
1349
 
        # the user. If a qualified proto is specified, the code
1350
 
        # trapping the exception can get the qualified urls to
1351
 
        # properly handle the redirection themself (creating a
1352
 
        # new transport object from the target url for example).
1353
 
        # But checking that the scheme of the original and
1354
 
        # redirected urls are the same can be tricky. (see the
1355
 
        # FIXME in BzrDir.open_from_transport for the unique use
1356
 
        # case so far).
1357
 
        if self._qualified_proto is None:
1358
 
            return url
1359
 
 
1360
 
        # The TODO related to NotBranchError mention that doing
1361
 
        # that kind of manipulation on the urls may not be the
1362
 
        # exception object job. On the other hand, this object is
1363
 
        # the interface between the code and the user so
1364
 
        # presenting the urls in different ways is indeed its
1365
 
        # job...
1366
 
        import urlparse
1367
 
        proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1368
 
        return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1369
 
                                   query, fragment))
1370
 
 
1371
 
    def get_source_url(self):
1372
 
        return self._requalify_url(self.source)
1373
 
 
1374
 
    def get_target_url(self):
1375
 
        return self._requalify_url(self.target)
1376
 
 
1377
 
 
1378
 
class TooManyRedirections(TransportError):
1379
 
 
1380
 
    _fmt = "Too many redirections"
1381
 
 
1382
840
class ConflictsInTree(BzrError):
1383
 
 
1384
 
    _fmt = "Working tree has conflicts."
 
841
    def __init__(self):
 
842
        BzrError.__init__(self, "Working tree has conflicts.")
1385
843
 
1386
844
 
1387
845
class ParseConfigError(BzrError):
1388
 
 
1389
846
    def __init__(self, errors, filename):
1390
847
        if filename is None:
1391
848
            filename = ""
1394
851
        BzrError.__init__(self, message)
1395
852
 
1396
853
 
1397
 
class NoEmailInUsername(BzrError):
1398
 
 
1399
 
    _fmt = "%(username)r does not seem to contain a reasonable email address"
1400
 
 
1401
 
    def __init__(self, username):
1402
 
        BzrError.__init__(self)
1403
 
        self.username = username
1404
 
 
1405
 
 
1406
854
class SigningFailed(BzrError):
1407
 
 
1408
 
    _fmt = "Failed to gpg sign data with command %(command_line)r"
1409
 
 
1410
855
    def __init__(self, command_line):
1411
 
        BzrError.__init__(self, command_line=command_line)
 
856
        BzrError.__init__(self, "Failed to gpg sign data with command '%s'"
 
857
                               % command_line)
1412
858
 
1413
859
 
1414
860
class WorkingTreeNotRevision(BzrError):
1415
 
 
1416
 
    _fmt = ("The working tree for %(basedir)s has changed since" 
1417
 
            " the last commit, but weave merge requires that it be"
1418
 
            " unchanged")
1419
 
 
1420
861
    def __init__(self, tree):
1421
 
        BzrError.__init__(self, basedir=tree.basedir)
1422
 
 
1423
 
 
1424
 
class CantReprocessAndShowBase(BzrError):
1425
 
 
1426
 
    _fmt = ("Can't reprocess and show base, because reprocessing obscures "
1427
 
           "the relationship of conflicting lines to the base")
1428
 
 
1429
 
 
1430
 
class GraphCycleError(BzrError):
1431
 
 
1432
 
    _fmt = "Cycle in graph %(graph)r"
1433
 
 
 
862
        BzrError.__init__(self, "The working tree for %s has changed since"
 
863
                          " last commit, but weave merge requires that it be"
 
864
                          " unchanged." % tree.basedir)
 
865
 
 
866
 
 
867
class CantReprocessAndShowBase(BzrNewError):
 
868
    """Can't reprocess and show base.
 
869
Reprocessing obscures relationship of conflicting lines to base."""
 
870
 
 
871
 
 
872
class GraphCycleError(BzrNewError):
 
873
    """Cycle in graph %(graph)r"""
1434
874
    def __init__(self, graph):
1435
 
        BzrError.__init__(self)
 
875
        BzrNewError.__init__(self)
1436
876
        self.graph = graph
1437
877
 
1438
878
 
1439
 
class WritingCompleted(BzrError):
1440
 
 
1441
 
    _fmt = ("The MediumRequest '%(request)s' has already had finish_writing "
1442
 
            "called upon it - accept bytes may not be called anymore.")
1443
 
 
1444
 
    internal_error = True
1445
 
 
1446
 
    def __init__(self, request):
1447
 
        self.request = request
1448
 
 
1449
 
 
1450
 
class WritingNotComplete(BzrError):
1451
 
 
1452
 
    _fmt = ("The MediumRequest '%(request)s' has not has finish_writing "
1453
 
            "called upon it - until the write phase is complete no "
1454
 
            "data may be read.")
1455
 
 
1456
 
    internal_error = True
1457
 
 
1458
 
    def __init__(self, request):
1459
 
        self.request = request
1460
 
 
1461
 
 
1462
 
class NotConflicted(BzrError):
1463
 
 
1464
 
    _fmt = "File %(filename)s is not conflicted."
 
879
class NotConflicted(BzrNewError):
 
880
    """File %(filename)s is not conflicted."""
1465
881
 
1466
882
    def __init__(self, filename):
1467
 
        BzrError.__init__(self)
 
883
        BzrNewError.__init__(self)
1468
884
        self.filename = filename
1469
885
 
1470
886
 
1471
 
class MediumNotConnected(BzrError):
1472
 
 
1473
 
    _fmt = """The medium '%(medium)s' is not connected."""
1474
 
 
1475
 
    internal_error = True
1476
 
 
1477
 
    def __init__(self, medium):
1478
 
        self.medium = medium
1479
 
 
1480
 
 
1481
887
class MustUseDecorated(Exception):
1482
 
 
1483
 
    _fmt = "A decorating function has requested its original command be used."
1484
 
 
1485
 
 
1486
 
class NoBundleFound(BzrError):
1487
 
 
1488
 
    _fmt = "No bundle was found in %(filename)s"
1489
 
 
 
888
    """A decorating function has requested its original command be used.
 
889
    
 
890
    This should never escape bzr, so does not need to be printable.
 
891
    """
 
892
 
 
893
 
 
894
class NoBundleFound(BzrNewError):
 
895
    """No bundle was found in %(filename)s"""
1490
896
    def __init__(self, filename):
1491
 
        BzrError.__init__(self)
 
897
        BzrNewError.__init__(self)
1492
898
        self.filename = filename
1493
899
 
1494
900
 
1495
 
class BundleNotSupported(BzrError):
1496
 
 
1497
 
    _fmt = "Unable to handle bundle version %(version)s: %(msg)s"
1498
 
 
 
901
class BundleNotSupported(BzrNewError):
 
902
    """Unable to handle bundle version %(version)s: %(msg)s"""
1499
903
    def __init__(self, version, msg):
1500
 
        BzrError.__init__(self)
 
904
        BzrNewError.__init__(self)
1501
905
        self.version = version
1502
906
        self.msg = msg
1503
907
 
1504
908
 
1505
 
class MissingText(BzrError):
1506
 
 
1507
 
    _fmt = ("Branch %(base)s is missing revision"
1508
 
            " %(text_revision)s of %(file_id)s")
 
909
class MissingText(BzrNewError):
 
910
    """Branch %(base)s is missing revision %(text_revision)s of %(file_id)s"""
1509
911
 
1510
912
    def __init__(self, branch, text_revision, file_id):
1511
 
        BzrError.__init__(self)
 
913
        BzrNewError.__init__(self)
1512
914
        self.branch = branch
1513
915
        self.base = branch.base
1514
916
        self.text_revision = text_revision
1515
917
        self.file_id = file_id
1516
918
 
1517
919
 
1518
 
class DuplicateFileId(BzrError):
1519
 
 
1520
 
    _fmt = "File id {%(file_id)s} already exists in inventory as %(entry)s"
1521
 
 
1522
 
    def __init__(self, file_id, entry):
1523
 
        BzrError.__init__(self)
1524
 
        self.file_id = file_id
1525
 
        self.entry = entry
1526
 
 
1527
 
 
1528
 
class DuplicateKey(BzrError):
1529
 
 
1530
 
    _fmt = "Key %(key)s is already present in map"
1531
 
 
1532
 
 
1533
 
class MalformedTransform(BzrError):
1534
 
 
1535
 
    _fmt = "Tree transform is malformed %(conflicts)r"
1536
 
 
1537
 
 
1538
 
class NoFinalPath(BzrError):
1539
 
 
1540
 
    _fmt = ("No final name for trans_id %(trans_id)r\n"
1541
 
            "file-id: %(file_id)r\n"
1542
 
            "root trans-id: %(root_trans_id)r\n")
1543
 
 
1544
 
    def __init__(self, trans_id, transform):
1545
 
        self.trans_id = trans_id
1546
 
        self.file_id = transform.final_file_id(trans_id)
1547
 
        self.root_trans_id = transform.root
1548
 
 
1549
 
 
1550
 
class BzrBadParameter(BzrError):
1551
 
 
1552
 
    _fmt = "Bad parameter: %(param)r"
1553
 
 
1554
 
    # This exception should never be thrown, but it is a base class for all
1555
 
    # parameter-to-function errors.
1556
 
 
 
920
class DuplicateKey(BzrNewError):
 
921
    """Key %(key)s is already present in map"""
 
922
 
 
923
 
 
924
class MalformedTransform(BzrNewError):
 
925
    """Tree transform is malformed %(conflicts)r"""
 
926
 
 
927
 
 
928
class BzrBadParameter(BzrNewError):
 
929
    """A bad parameter : %(param)s is not usable.
 
930
    
 
931
    This exception should never be thrown, but it is a base class for all
 
932
    parameter-to-function errors.
 
933
    """
1557
934
    def __init__(self, param):
1558
 
        BzrError.__init__(self)
 
935
        BzrNewError.__init__(self)
1559
936
        self.param = param
1560
937
 
1561
938
 
1562
939
class BzrBadParameterNotUnicode(BzrBadParameter):
1563
 
 
1564
 
    _fmt = "Parameter %(param)s is neither unicode nor utf8."
1565
 
 
1566
 
 
1567
 
class ReusingTransform(BzrError):
1568
 
 
1569
 
    _fmt = "Attempt to reuse a transform that has already been applied."
1570
 
 
1571
 
 
1572
 
class CantMoveRoot(BzrError):
1573
 
 
1574
 
    _fmt = "Moving the root directory is not supported at this time"
1575
 
 
1576
 
 
1577
 
class BzrMoveFailedError(BzrError):
1578
 
 
1579
 
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1580
 
 
1581
 
    def __init__(self, from_path='', to_path='', extra=None):
1582
 
        BzrError.__init__(self)
1583
 
        if extra:
1584
 
            self.extra = ': ' + str(extra)
1585
 
        else:
1586
 
            self.extra = ''
1587
 
 
1588
 
        has_from = len(from_path) > 0
1589
 
        has_to = len(to_path) > 0
1590
 
        if has_from:
1591
 
            self.from_path = osutils.splitpath(from_path)[-1]
1592
 
        else:
1593
 
            self.from_path = ''
1594
 
 
1595
 
        if has_to:
1596
 
            self.to_path = osutils.splitpath(to_path)[-1]
1597
 
        else:
1598
 
            self.to_path = ''
1599
 
 
1600
 
        self.operator = ""
1601
 
        if has_from and has_to:
1602
 
            self.operator = " =>"
1603
 
        elif has_from:
1604
 
            self.from_path = "from " + from_path
1605
 
        elif has_to:
1606
 
            self.operator = "to"
1607
 
        else:
1608
 
            self.operator = "file"
1609
 
 
1610
 
 
1611
 
class BzrRenameFailedError(BzrMoveFailedError):
1612
 
 
1613
 
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
1614
 
 
1615
 
    def __init__(self, from_path, to_path, extra=None):
1616
 
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
 
940
    """Parameter %(param)s is neither unicode nor utf8."""
 
941
 
 
942
 
 
943
class ReusingTransform(BzrNewError):
 
944
    """Attempt to reuse a transform that has already been applied."""
 
945
 
 
946
 
 
947
class CantMoveRoot(BzrNewError):
 
948
    """Moving the root directory is not supported at this time"""
1617
949
 
1618
950
 
1619
951
class BzrBadParameterNotString(BzrBadParameter):
1620
 
 
1621
 
    _fmt = "Parameter %(param)s is not a string or unicode string."
 
952
    """Parameter %(param)s is not a string or unicode string."""
1622
953
 
1623
954
 
1624
955
class BzrBadParameterMissing(BzrBadParameter):
1625
 
 
1626
 
    _fmt = "Parameter $(param)s is required but not present."
 
956
    """Parameter $(param)s is required but not present."""
1627
957
 
1628
958
 
1629
959
class BzrBadParameterUnicode(BzrBadParameter):
1630
 
 
1631
 
    _fmt = ("Parameter %(param)s is unicode but"
1632
 
            " only byte-strings are permitted.")
 
960
    """Parameter %(param)s is unicode but only byte-strings are permitted."""
1633
961
 
1634
962
 
1635
963
class BzrBadParameterContainsNewline(BzrBadParameter):
1636
 
 
1637
 
    _fmt = "Parameter %(param)s contains a newline."
1638
 
 
1639
 
 
1640
 
class DependencyNotPresent(BzrError):
1641
 
 
1642
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
964
    """Parameter %(param)s contains a newline."""
 
965
 
 
966
 
 
967
class DependencyNotPresent(BzrNewError):
 
968
    """Unable to import library "%(library)s": %(error)s"""
1643
969
 
1644
970
    def __init__(self, library, error):
1645
 
        BzrError.__init__(self, library=library, error=error)
 
971
        BzrNewError.__init__(self, library=library, error=error)
1646
972
 
1647
973
 
1648
974
class ParamikoNotPresent(DependencyNotPresent):
1649
 
 
1650
 
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
 
975
    """Unable to import paramiko (required for sftp support): %(error)s"""
1651
976
 
1652
977
    def __init__(self, error):
1653
978
        DependencyNotPresent.__init__(self, 'paramiko', error)
1654
979
 
1655
980
 
1656
 
class PointlessMerge(BzrError):
1657
 
 
1658
 
    _fmt = "Nothing to merge."
1659
 
 
1660
 
 
1661
 
class UninitializableFormat(BzrError):
1662
 
 
1663
 
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
 
981
class PointlessMerge(BzrNewError):
 
982
    """Nothing to merge."""
 
983
 
 
984
 
 
985
class UninitializableFormat(BzrNewError):
 
986
    """Format %(format)s cannot be initialised by this version of bzr."""
1664
987
 
1665
988
    def __init__(self, format):
1666
 
        BzrError.__init__(self)
 
989
        BzrNewError.__init__(self)
1667
990
        self.format = format
1668
991
 
1669
992
 
1670
 
class BadConversionTarget(BzrError):
1671
 
 
1672
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
993
class BadConversionTarget(BzrNewError):
 
994
    """Cannot convert to format %(format)s.  %(problem)s"""
1673
995
 
1674
996
    def __init__(self, problem, format):
1675
 
        BzrError.__init__(self)
 
997
        BzrNewError.__init__(self)
1676
998
        self.problem = problem
1677
999
        self.format = format
1678
1000
 
1679
1001
 
1680
 
class NoDiff(BzrError):
1681
 
 
1682
 
    _fmt = "Diff is not installed on this machine: %(msg)s"
 
1002
class NoDiff(BzrNewError):
 
1003
    """Diff is not installed on this machine: %(msg)s"""
1683
1004
 
1684
1005
    def __init__(self, msg):
1685
 
        BzrError.__init__(self, msg=msg)
1686
 
 
1687
 
 
1688
 
class NoDiff3(BzrError):
1689
 
 
1690
 
    _fmt = "Diff3 is not installed on this machine."
1691
 
 
1692
 
 
1693
 
class ExistingLimbo(BzrError):
1694
 
 
1695
 
    _fmt = """This tree contains left-over files from a failed operation.
1696
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1697
 
    keep, and delete it when you are done."""
1698
 
    
1699
 
    def __init__(self, limbo_dir):
1700
 
       BzrError.__init__(self)
1701
 
       self.limbo_dir = limbo_dir
1702
 
 
1703
 
 
1704
 
class ImmortalLimbo(BzrError):
1705
 
 
1706
 
    _fmt = """Unable to delete transform temporary directory $(limbo_dir)s.
1707
 
    Please examine %(limbo_dir)s to see if it contains any files you wish to
1708
 
    keep, and delete it when you are done."""
1709
 
 
1710
 
    def __init__(self, limbo_dir):
1711
 
       BzrError.__init__(self)
1712
 
       self.limbo_dir = limbo_dir
1713
 
 
1714
 
 
1715
 
class OutOfDateTree(BzrError):
1716
 
 
1717
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
1006
        BzrNewError.__init__(self, msg=msg)
 
1007
 
 
1008
 
 
1009
class NoDiff3(BzrNewError):
 
1010
    """Diff3 is not installed on this machine."""
 
1011
 
 
1012
 
 
1013
class ExistingLimbo(BzrNewError):
 
1014
    """This tree contains left-over files from a failed operation.
 
1015
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1016
    keep, and delete it when you are done.
 
1017
    """
 
1018
    def __init__(self, limbo_dir):
 
1019
       BzrNewError.__init__(self)
 
1020
       self.limbo_dir = limbo_dir
 
1021
 
 
1022
 
 
1023
class ImmortalLimbo(BzrNewError):
 
1024
    """Unable to delete transform temporary directory $(limbo_dir)s.
 
1025
    Please examine %(limbo_dir)s to see if it contains any files you wish to
 
1026
    keep, and delete it when you are done.
 
1027
    """
 
1028
    def __init__(self, limbo_dir):
 
1029
       BzrNewError.__init__(self)
 
1030
       self.limbo_dir = limbo_dir
 
1031
 
 
1032
 
 
1033
class OutOfDateTree(BzrNewError):
 
1034
    """Working tree is out of date, please run 'bzr update'."""
1718
1035
 
1719
1036
    def __init__(self, tree):
1720
 
        BzrError.__init__(self)
 
1037
        BzrNewError.__init__(self)
1721
1038
        self.tree = tree
1722
1039
 
1723
1040
 
1724
 
class PublicBranchOutOfDate(BzrError):
1725
 
 
1726
 
    _fmt = 'Public branch "%(public_location)s" lacks revision '\
1727
 
        '"%(revstring)s".'
1728
 
 
1729
 
    def __init__(self, public_location, revstring):
1730
 
        import bzrlib.urlutils as urlutils
1731
 
        public_location = urlutils.unescape_for_display(public_location,
1732
 
                                                        'ascii')
1733
 
        BzrError.__init__(self, public_location=public_location,
1734
 
                          revstring=revstring)
1735
 
 
1736
 
 
1737
 
class MergeModifiedFormatError(BzrError):
1738
 
 
1739
 
    _fmt = "Error in merge modified format"
1740
 
 
1741
 
 
1742
 
class ConflictFormatError(BzrError):
1743
 
 
1744
 
    _fmt = "Format error in conflict listings"
1745
 
 
1746
 
 
1747
 
class CorruptRepository(BzrError):
1748
 
 
1749
 
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
1750
 
            "Please run bzr reconcile on this repository.")
 
1041
class MergeModifiedFormatError(BzrNewError):
 
1042
    """Error in merge modified format"""
 
1043
 
 
1044
 
 
1045
class ConflictFormatError(BzrNewError):
 
1046
    """Format error in conflict listings"""
 
1047
 
 
1048
 
 
1049
class CorruptRepository(BzrNewError):
 
1050
    """An error has been detected in the repository %(repo_path)s.
 
1051
Please run bzr reconcile on this repository."""
1751
1052
 
1752
1053
    def __init__(self, repo):
1753
 
        BzrError.__init__(self)
 
1054
        BzrNewError.__init__(self)
1754
1055
        self.repo_path = repo.bzrdir.root_transport.base
1755
1056
 
1756
1057
 
1757
 
class UpgradeRequired(BzrError):
1758
 
 
1759
 
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
 
1058
class UpgradeRequired(BzrNewError):
 
1059
    """To use this feature you must upgrade your branch at %(path)s."""
1760
1060
 
1761
1061
    def __init__(self, path):
1762
 
        BzrError.__init__(self)
 
1062
        BzrNewError.__init__(self)
1763
1063
        self.path = path
1764
1064
 
1765
1065
 
1766
 
class LocalRequiresBoundBranch(BzrError):
1767
 
 
1768
 
    _fmt = "Cannot perform local-only commits on unbound branches."
1769
 
 
1770
 
 
1771
 
class MissingProgressBarFinish(BzrError):
1772
 
 
1773
 
    _fmt = "A nested progress bar was not 'finished' correctly."
1774
 
 
1775
 
 
1776
 
class InvalidProgressBarType(BzrError):
1777
 
 
1778
 
    _fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
1779
 
            " is not a supported type Select one of: %(valid_types)s")
 
1066
class LocalRequiresBoundBranch(BzrNewError):
 
1067
    """Cannot perform local-only commits on unbound branches."""
 
1068
 
 
1069
 
 
1070
class MissingProgressBarFinish(BzrNewError):
 
1071
    """A nested progress bar was not 'finished' correctly."""
 
1072
 
 
1073
 
 
1074
class InvalidProgressBarType(BzrNewError):
 
1075
    """Environment variable BZR_PROGRESS_BAR='%(bar_type)s is not a supported type
 
1076
Select one of: %(valid_types)s"""
1780
1077
 
1781
1078
    def __init__(self, bar_type, valid_types):
1782
 
        BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
1783
 
 
1784
 
 
1785
 
class UnsupportedOperation(BzrError):
1786
 
 
1787
 
    _fmt = ("The method %(mname)s is not supported on"
1788
 
            " objects of type %(tname)s.")
1789
 
 
 
1079
        BzrNewError.__init__(self, bar_type=bar_type, valid_types=valid_types)
 
1080
 
 
1081
 
 
1082
class UnsupportedOperation(BzrNewError):
 
1083
    """The method %(mname)s is not supported on objects of type %(tname)s."""
1790
1084
    def __init__(self, method, method_self):
1791
1085
        self.method = method
1792
1086
        self.mname = method.__name__
1793
1087
        self.tname = type(method_self).__name__
1794
1088
 
1795
1089
 
1796
 
class CannotSetRevisionId(UnsupportedOperation):
1797
 
    """Raised when a commit is attempting to set a revision id but cant."""
1798
 
 
1799
 
 
1800
 
class NonAsciiRevisionId(UnsupportedOperation):
1801
 
    """Raised when a commit is attempting to set a non-ascii revision id
1802
 
       but cant.
1803
 
    """
1804
 
 
1805
 
 
1806
 
class BinaryFile(BzrError):
1807
 
    
1808
 
    _fmt = "File is binary but should be text."
1809
 
 
1810
 
 
1811
 
class IllegalPath(BzrError):
1812
 
 
1813
 
    _fmt = "The path %(path)s is not permitted on this platform"
 
1090
class BinaryFile(BzrNewError):
 
1091
    """File is binary but should be text."""
 
1092
 
 
1093
 
 
1094
class IllegalPath(BzrNewError):
 
1095
    """The path %(path)s is not permitted on this platform"""
1814
1096
 
1815
1097
    def __init__(self, path):
1816
 
        BzrError.__init__(self)
 
1098
        BzrNewError.__init__(self)
1817
1099
        self.path = path
1818
1100
 
1819
1101
 
1820
 
class TestamentMismatch(BzrError):
1821
 
 
1822
 
    _fmt = """Testament did not match expected value.
1823
 
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured
1824
 
       {%(measured)s}"""
1825
 
 
 
1102
class TestamentMismatch(BzrNewError):
 
1103
    """Testament did not match expected value.  
 
1104
       For revision_id {%(revision_id)s}, expected {%(expected)s}, measured 
 
1105
       {%(measured)s}
 
1106
    """
1826
1107
    def __init__(self, revision_id, expected, measured):
1827
1108
        self.revision_id = revision_id
1828
1109
        self.expected = expected
1829
1110
        self.measured = measured
1830
1111
 
1831
1112
 
1832
 
class NotABundle(BzrError):
1833
 
    
1834
 
    _fmt = "Not a bzr revision-bundle: %(text)r"
 
1113
class NotABundle(BzrNewError):
 
1114
    """Not a bzr revision-bundle: %(text)r"""
1835
1115
 
1836
1116
    def __init__(self, text):
1837
 
        BzrError.__init__(self)
 
1117
        BzrNewError.__init__(self)
1838
1118
        self.text = text
1839
1119
 
1840
1120
 
1841
 
class BadBundle(BzrError): 
1842
 
    
1843
 
    _fmt = "Bad bzr revision-bundle: %(text)r"
 
1121
class BadBundle(BzrNewError): 
 
1122
    """Bad bzr revision-bundle: %(text)r"""
1844
1123
 
1845
1124
    def __init__(self, text):
1846
 
        BzrError.__init__(self)
 
1125
        BzrNewError.__init__(self)
1847
1126
        self.text = text
1848
1127
 
1849
1128
 
1850
1129
class MalformedHeader(BadBundle): 
1851
 
    
1852
 
    _fmt = "Malformed bzr revision-bundle header: %(text)r"
 
1130
    """Malformed bzr revision-bundle header: %(text)r"""
 
1131
 
 
1132
    def __init__(self, text):
 
1133
        BzrNewError.__init__(self)
 
1134
        self.text = text
1853
1135
 
1854
1136
 
1855
1137
class MalformedPatches(BadBundle): 
1856
 
    
1857
 
    _fmt = "Malformed patches in bzr revision-bundle: %(text)r"
 
1138
    """Malformed patches in bzr revision-bundle: %(text)r"""
 
1139
 
 
1140
    def __init__(self, text):
 
1141
        BzrNewError.__init__(self)
 
1142
        self.text = text
1858
1143
 
1859
1144
 
1860
1145
class MalformedFooter(BadBundle): 
1861
 
    
1862
 
    _fmt = "Malformed footer in bzr revision-bundle: %(text)r"
 
1146
    """Malformed footer in bzr revision-bundle: %(text)r"""
 
1147
 
 
1148
    def __init__(self, text):
 
1149
        BzrNewError.__init__(self)
 
1150
        self.text = text
1863
1151
 
1864
1152
 
1865
1153
class UnsupportedEOLMarker(BadBundle):
1866
 
    
1867
 
    _fmt = "End of line marker was not \\n in bzr revision-bundle"    
 
1154
    """End of line marker was not \\n in bzr revision-bundle"""    
1868
1155
 
1869
1156
    def __init__(self):
1870
 
        # XXX: BadBundle's constructor assumes there's explanatory text, 
1871
 
        # but for this there is not
1872
 
        BzrError.__init__(self)
1873
 
 
1874
 
 
1875
 
class IncompatibleBundleFormat(BzrError):
1876
 
    
1877
 
    _fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
1878
 
 
1879
 
    def __init__(self, bundle_format, other):
1880
 
        BzrError.__init__(self)
1881
 
        self.bundle_format = bundle_format
1882
 
        self.other = other
1883
 
 
1884
 
 
1885
 
class BadInventoryFormat(BzrError):
1886
 
    
1887
 
    _fmt = "Root class for inventory serialization errors"
 
1157
        BzrNewError.__init__(self)
 
1158
 
 
1159
 
 
1160
class BadInventoryFormat(BzrNewError):
 
1161
    """Root class for inventory serialization errors"""
1888
1162
 
1889
1163
 
1890
1164
class UnexpectedInventoryFormat(BadInventoryFormat):
1891
 
 
1892
 
    _fmt = "The inventory was not in the expected format:\n %(msg)s"
 
1165
    """The inventory was not in the expected format:\n %(msg)s"""
1893
1166
 
1894
1167
    def __init__(self, msg):
1895
1168
        BadInventoryFormat.__init__(self, msg=msg)
1896
1169
 
1897
1170
 
1898
 
class RootNotRich(BzrError):
1899
 
 
1900
 
    _fmt = """This operation requires rich root data storage"""
1901
 
 
1902
 
 
1903
 
class NoSmartMedium(BzrError):
1904
 
 
1905
 
    _fmt = "The transport '%(transport)s' cannot tunnel the smart protocol."
1906
 
 
1907
 
    internal_error = True
1908
 
 
1909
 
    def __init__(self, transport):
1910
 
        self.transport = transport
1911
 
 
1912
 
 
1913
 
class NoSmartServer(NotBranchError):
1914
 
 
1915
 
    _fmt = "No smart server available at %(url)s"
1916
 
 
1917
 
    def __init__(self, url):
1918
 
        self.url = url
1919
 
 
1920
 
 
1921
 
class UnknownSSH(BzrError):
1922
 
 
1923
 
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
 
1171
class UnknownSSH(BzrNewError):
 
1172
    """Unrecognised value for BZR_SSH environment variable: %(vendor)s"""
1924
1173
 
1925
1174
    def __init__(self, vendor):
1926
 
        BzrError.__init__(self)
 
1175
        BzrNewError.__init__(self)
1927
1176
        self.vendor = vendor
1928
1177
 
1929
1178
 
1930
 
class SSHVendorNotFound(BzrError):
1931
 
 
1932
 
    _fmt = ("Don't know how to handle SSH connections."
1933
 
            " Please set BZR_SSH environment variable.")
1934
 
 
1935
 
 
1936
 
class GhostRevisionUnusableHere(BzrError):
1937
 
 
1938
 
    _fmt = "Ghost revision {%(revision_id)s} cannot be used here."
 
1179
class GhostRevisionUnusableHere(BzrNewError):
 
1180
    """Ghost revision {%(revision_id)s} cannot be used here."""
1939
1181
 
1940
1182
    def __init__(self, revision_id):
1941
 
        BzrError.__init__(self)
 
1183
        BzrNewError.__init__(self)
1942
1184
        self.revision_id = revision_id
1943
1185
 
1944
1186
 
1945
 
class IllegalUseOfScopeReplacer(BzrError):
1946
 
 
1947
 
    _fmt = ("ScopeReplacer object %(name)r was used incorrectly:"
1948
 
            " %(msg)s%(extra)s")
1949
 
 
1950
 
    internal_error = True
 
1187
class IllegalUseOfScopeReplacer(BzrNewError):
 
1188
    """ScopeReplacer object %(name)r was used incorrectly: %(msg)s%(extra)s"""
 
1189
 
 
1190
    is_user_error = False
1951
1191
 
1952
1192
    def __init__(self, name, msg, extra=None):
1953
 
        BzrError.__init__(self)
 
1193
        BzrNewError.__init__(self)
1954
1194
        self.name = name
1955
1195
        self.msg = msg
1956
1196
        if extra:
1959
1199
            self.extra = ''
1960
1200
 
1961
1201
 
1962
 
class InvalidImportLine(BzrError):
1963
 
 
1964
 
    _fmt = "Not a valid import statement: %(msg)\n%(text)s"
1965
 
 
1966
 
    internal_error = True
 
1202
class InvalidImportLine(BzrNewError):
 
1203
    """Not a valid import statement: %(msg)\n%(text)s"""
 
1204
 
 
1205
    is_user_error = False
1967
1206
 
1968
1207
    def __init__(self, text, msg):
1969
 
        BzrError.__init__(self)
 
1208
        BzrNewError.__init__(self)
1970
1209
        self.text = text
1971
1210
        self.msg = msg
1972
1211
 
1973
1212
 
1974
 
class ImportNameCollision(BzrError):
1975
 
 
1976
 
    _fmt = ("Tried to import an object to the same name as"
1977
 
            " an existing object. %(name)s")
1978
 
 
1979
 
    internal_error = True
 
1213
class ImportNameCollision(BzrNewError):
 
1214
    """Tried to import an object to the same name as an existing object. %(name)s"""
 
1215
 
 
1216
    is_user_error = False
1980
1217
 
1981
1218
    def __init__(self, name):
1982
 
        BzrError.__init__(self)
 
1219
        BzrNewError.__init__(self)
1983
1220
        self.name = name
1984
 
 
1985
 
 
1986
 
class NotAMergeDirective(BzrError):
1987
 
    """File starting with %(firstline)r is not a merge directive"""
1988
 
    def __init__(self, firstline):
1989
 
        BzrError.__init__(self, firstline=firstline)
1990
 
 
1991
 
 
1992
 
class NoMergeSource(BzrError):
1993
 
    """Raise if no merge source was specified for a merge directive"""
1994
 
 
1995
 
    _fmt = "A merge directive must provide either a bundle or a public"\
1996
 
        " branch location."
1997
 
 
1998
 
 
1999
 
class PatchMissing(BzrError):
2000
 
    """Raise a patch type was specified but no patch supplied"""
2001
 
 
2002
 
    _fmt = "patch_type was %(patch_type)s, but no patch was supplied."
2003
 
 
2004
 
    def __init__(self, patch_type):
2005
 
        BzrError.__init__(self)
2006
 
        self.patch_type = patch_type
2007
 
 
2008
 
 
2009
 
class UnsupportedInventoryKind(BzrError):
2010
 
    
2011
 
    _fmt = """Unsupported entry kind %(kind)s"""
2012
 
 
2013
 
    def __init__(self, kind):
2014
 
        self.kind = kind
2015
 
 
2016
 
 
2017
 
class BadSubsumeSource(BzrError):
2018
 
 
2019
 
    _fmt = """Can't subsume %(other_tree)s into %(tree)s.  %(reason)s"""
2020
 
 
2021
 
    def __init__(self, tree, other_tree, reason):
2022
 
        self.tree = tree
2023
 
        self.other_tree = other_tree
2024
 
        self.reason = reason
2025
 
 
2026
 
 
2027
 
class SubsumeTargetNeedsUpgrade(BzrError):
2028
 
    
2029
 
    _fmt = """Subsume target %(other_tree)s needs to be upgraded."""
2030
 
 
2031
 
    def __init__(self, other_tree):
2032
 
        self.other_tree = other_tree
2033
 
 
2034
 
 
2035
 
class BadReferenceTarget(BzrError):
2036
 
 
2037
 
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s.  %(reason)s"
2038
 
 
2039
 
    internal_error = True
2040
 
 
2041
 
    def __init__(self, tree, other_tree, reason):
2042
 
        self.tree = tree
2043
 
        self.other_tree = other_tree
2044
 
        self.reason = reason
2045
 
 
2046
 
 
2047
 
class NoSuchTag(BzrError):
2048
 
 
2049
 
    _fmt = "No such tag: %(tag_name)s"
2050
 
 
2051
 
    def __init__(self, tag_name):
2052
 
        self.tag_name = tag_name
2053
 
 
2054
 
 
2055
 
class TagsNotSupported(BzrError):
2056
 
 
2057
 
    _fmt = ("Tags not supported by %(branch)s;"
2058
 
            " you may be able to use bzr upgrade --dirstate-tags.")
2059
 
 
2060
 
    def __init__(self, branch):
2061
 
        self.branch = branch
2062
 
 
2063
 
        
2064
 
class TagAlreadyExists(BzrError):
2065
 
 
2066
 
    _fmt = "Tag %(tag_name)s already exists."
2067
 
 
2068
 
    def __init__(self, tag_name):
2069
 
        self.tag_name = tag_name