/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: Andrew Bennetts
  • Date: 2010-01-18 07:00:11 UTC
  • mto: (4973.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4975.
  • Revision ID: andrew.bennetts@canonical.com-20100118070011-zu374wvd0lcgai5a
Move news_merge plugin from contrib to bzrlib/plugins, change it to be enabled via a 'news_merge_files' config option, move more code out of the __init__ to minimise overhead, and add lots of docstrings, add NEWS entry.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/errors.py
1
 
# Copyright (C) 2005-2013, 2016 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
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
17
17
"""Exceptions for bzr, and reporting of them.
18
18
"""
19
19
 
20
 
from __future__ import absolute_import
 
20
from bzrlib import (
 
21
    osutils,
 
22
    symbol_versioning,
 
23
    )
 
24
from bzrlib.patches import (
 
25
    MalformedHunkHeader,
 
26
    MalformedLine,
 
27
    MalformedPatchHeader,
 
28
    PatchConflict,
 
29
    PatchSyntax,
 
30
    )
21
31
 
22
 
from .sixish import (
23
 
    PY3,
24
 
    )
25
32
 
26
33
# TODO: is there any value in providing the .args field used by standard
27
34
# python exceptions?   A list of values with no names seems less useful
36
43
# 'unprintable'.
37
44
 
38
45
 
39
 
# return codes from the brz program
 
46
# return codes from the bzr program
40
47
EXIT_OK = 0
41
48
EXIT_ERROR = 3
42
49
EXIT_INTERNAL_ERROR = 4
43
50
 
44
51
 
45
 
class BzrError(Exception):
 
52
class BzrError(StandardError):
46
53
    """
47
 
    Base class for errors raised by breezy.
 
54
    Base class for errors raised by bzrlib.
48
55
 
49
 
    :cvar internal_error: if True this was probably caused by a brz bug and
50
 
        should be displayed with a traceback; if False (or absent) this was
51
 
        probably a user or environment error and they don't need the gory
52
 
        details.  (That can be overridden by -Derror on the command line.)
 
56
    :cvar internal_error: if True this was probably caused by a bzr bug and
 
57
    should be displayed with a traceback; if False (or absent) this was
 
58
    probably a user or environment error and they don't need the gory details.
 
59
    (That can be overridden by -Derror on the command line.)
53
60
 
54
61
    :cvar _fmt: Format string to display the error; this is expanded
55
 
        by the instance's dict.
 
62
    by the instance's dict.
56
63
    """
57
64
 
58
65
    internal_error = False
76
83
           not subject to expansion. 'msg' is used instead of 'message' because
77
84
           python evolved and, in 2.6, forbids the use of 'message'.
78
85
        """
79
 
        Exception.__init__(self)
 
86
        StandardError.__init__(self)
80
87
        if msg is not None:
81
88
            # I was going to deprecate this, but it actually turns out to be
82
89
            # quite handy - mbp 20061103.
91
98
        if s is not None:
92
99
            # contains a preformatted message
93
100
            return s
94
 
        err = None
95
101
        try:
96
102
            fmt = self._get_format_string()
97
103
            if fmt:
100
106
                # __str__() should always return a 'str' object
101
107
                # never a 'unicode' object.
102
108
                return s
103
 
        except Exception as e:
104
 
            err = e
105
 
        return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
109
        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
 
110
            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
 
111
                % (self.__class__.__name__,
 
112
                   self.__dict__,
 
113
                   getattr(self, '_fmt', None),
 
114
                   e)
 
115
 
 
116
    def __unicode__(self):
 
117
        u = self._format()
 
118
        if isinstance(u, str):
 
119
            # Try decoding the str using the default encoding.
 
120
            u = unicode(u)
 
121
        elif not isinstance(u, unicode):
 
122
            # Try to make a unicode object from it, because __unicode__ must
 
123
            # return a unicode object.
 
124
            u = unicode(u)
 
125
        return u
 
126
 
 
127
    def __str__(self):
 
128
        s = self._format()
 
129
        if isinstance(s, unicode):
 
130
            s = s.encode('utf8')
 
131
        else:
 
132
            # __str__ must return a str.
 
133
            s = str(s)
 
134
        return s
 
135
 
 
136
    def __repr__(self):
 
137
        return '%s(%s)' % (self.__class__.__name__, str(self))
 
138
 
 
139
    def _get_format_string(self):
 
140
        """Return format string for this exception or None"""
 
141
        fmt = getattr(self, '_fmt', None)
 
142
        if fmt is not None:
 
143
            return fmt
 
144
        fmt = getattr(self, '__doc__', None)
 
145
        if fmt is not None:
 
146
            symbol_versioning.warn("%s uses its docstring as a format, "
 
147
                    "it should use _fmt instead" % self.__class__.__name__,
 
148
                    DeprecationWarning)
 
149
            return fmt
 
150
        return 'Unprintable exception %s: dict=%r, fmt=%r' \
106
151
            % (self.__class__.__name__,
107
152
               self.__dict__,
108
153
               getattr(self, '_fmt', None),
109
 
               err)
110
 
 
111
 
    if PY3:
112
 
        __str__ = _format
113
 
    else:
114
 
        def __str__(self):
115
 
            return self._format().encode('utf-8')
116
 
 
117
 
        __unicode__ = _format
118
 
 
119
 
    def __repr__(self):
120
 
        return '%s(%s)' % (self.__class__.__name__, str(self))
121
 
 
122
 
    def _get_format_string(self):
123
 
        """Return format string for this exception or None"""
124
 
        fmt = getattr(self, '_fmt', None)
125
 
        if fmt is not None:
126
 
            from breezy.i18n import gettext
127
 
            return gettext(fmt) # _fmt strings should be ascii
 
154
               )
128
155
 
129
156
    def __eq__(self, other):
130
157
        if self.__class__ is not other.__class__:
131
158
            return NotImplemented
132
159
        return self.__dict__ == other.__dict__
133
160
 
134
 
    def __hash__(self):
135
 
        return id(self)
136
 
 
137
161
 
138
162
class InternalBzrError(BzrError):
139
163
    """Base class for errors that are internal in nature.
146
170
    internal_error = True
147
171
 
148
172
 
 
173
class BzrNewError(BzrError):
 
174
    """Deprecated error base class."""
 
175
    # base classes should override the docstring with their human-
 
176
    # readable explanation
 
177
 
 
178
    def __init__(self, *args, **kwds):
 
179
        # XXX: Use the underlying BzrError to always generate the args
 
180
        # attribute if it doesn't exist.  We can't use super here, because
 
181
        # exceptions are old-style classes in python2.4 (but new in 2.5).
 
182
        # --bmc, 20060426
 
183
        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
 
184
             'please convert %s to use BzrError instead'
 
185
             % self.__class__.__name__,
 
186
             DeprecationWarning,
 
187
             stacklevel=2)
 
188
        BzrError.__init__(self, *args)
 
189
        for key, value in kwds.items():
 
190
            setattr(self, key, value)
 
191
 
 
192
    def __str__(self):
 
193
        try:
 
194
            # __str__() should always return a 'str' object
 
195
            # never a 'unicode' object.
 
196
            s = self.__doc__ % self.__dict__
 
197
            if isinstance(s, unicode):
 
198
                return s.encode('utf8')
 
199
            return s
 
200
        except (TypeError, NameError, ValueError, KeyError), e:
 
201
            return 'Unprintable exception %s(%r): %r' \
 
202
                % (self.__class__.__name__,
 
203
                   self.__dict__, e)
 
204
 
 
205
 
 
206
class AlreadyBuilding(BzrError):
 
207
 
 
208
    _fmt = "The tree builder is already building a tree."
 
209
 
 
210
 
149
211
class BranchError(BzrError):
150
212
    """Base class for concrete 'errors about a branch'."""
151
213
 
162
224
        self.msg = msg
163
225
 
164
226
 
165
 
class IncompatibleVersion(BzrError):
166
 
 
167
 
    _fmt = 'API %(api)s is not compatible; one of versions %(wanted)r '\
168
 
           'is required, but current version is %(current)r.'
169
 
 
170
 
    def __init__(self, api, wanted, current):
 
227
class DirstateCorrupt(BzrError):
 
228
 
 
229
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
 
230
 
 
231
    def __init__(self, state, msg):
 
232
        BzrError.__init__(self)
 
233
        self.state = state
 
234
        self.msg = msg
 
235
 
 
236
 
 
237
class DisabledMethod(InternalBzrError):
 
238
 
 
239
    _fmt = "The smart server method '%(class_name)s' is disabled."
 
240
 
 
241
    def __init__(self, class_name):
 
242
        BzrError.__init__(self)
 
243
        self.class_name = class_name
 
244
 
 
245
 
 
246
class IncompatibleAPI(BzrError):
 
247
 
 
248
    _fmt = 'The API for "%(api)s" is not compatible with "%(wanted)s". '\
 
249
        'It supports versions "%(minimum)s" to "%(current)s".'
 
250
 
 
251
    def __init__(self, api, wanted, minimum, current):
171
252
        self.api = api
172
253
        self.wanted = wanted
 
254
        self.minimum = minimum
173
255
        self.current = current
174
256
 
175
257
 
222
304
class RootMissing(InternalBzrError):
223
305
 
224
306
    _fmt = ("The root entry of a tree must be the first entry supplied to "
225
 
        "the commit builder.")
 
307
        "record_entry_contents.")
226
308
 
227
309
 
228
310
class NoPublicBranch(BzrError):
230
312
    _fmt = 'There is no public branch set for "%(branch_url)s".'
231
313
 
232
314
    def __init__(self, branch):
233
 
        from . import urlutils
 
315
        import bzrlib.urlutils as urlutils
234
316
        public_location = urlutils.unescape_for_display(branch.base, 'ascii')
235
317
        BzrError.__init__(self, branch_url=public_location)
236
318
 
237
319
 
 
320
class NoHelpTopic(BzrError):
 
321
 
 
322
    _fmt = ("No help could be found for '%(topic)s'. "
 
323
        "Please use 'bzr help topics' to obtain a list of topics.")
 
324
 
 
325
    def __init__(self, topic):
 
326
        self.topic = topic
 
327
 
 
328
 
238
329
class NoSuchId(BzrError):
239
330
 
240
331
    _fmt = 'The file id "%(file_id)s" is not present in the tree %(tree)s.'
245
336
        self.tree = tree
246
337
 
247
338
 
 
339
class NoSuchIdInRepository(NoSuchId):
 
340
 
 
341
    _fmt = ('The file id "%(file_id)s" is not present in the repository'
 
342
            ' %(repository)r')
 
343
 
 
344
    def __init__(self, repository, file_id):
 
345
        BzrError.__init__(self, repository=repository, file_id=file_id)
 
346
 
 
347
 
248
348
class NotStacked(BranchError):
249
349
 
250
350
    _fmt = "The branch '%(branch)s' is not stacked."
268
368
        self.base = base
269
369
 
270
370
 
 
371
class NotBuilding(BzrError):
 
372
 
 
373
    _fmt = "Not currently building a tree."
 
374
 
 
375
 
271
376
class NotLocalUrl(BzrError):
272
377
 
273
378
    _fmt = "%(url)s is not a local path."
304
409
        self.not_locked = not_locked
305
410
 
306
411
 
 
412
class BzrOptionError(BzrCommandError):
 
413
 
 
414
    _fmt = "Error in command line options"
 
415
 
 
416
 
 
417
class BadIndexFormatSignature(BzrError):
 
418
 
 
419
    _fmt = "%(value)s is not an index of type %(_type)s."
 
420
 
 
421
    def __init__(self, value, _type):
 
422
        BzrError.__init__(self)
 
423
        self.value = value
 
424
        self._type = _type
 
425
 
 
426
 
 
427
class BadIndexData(BzrError):
 
428
 
 
429
    _fmt = "Error in data for index %(value)s."
 
430
 
 
431
    def __init__(self, value):
 
432
        BzrError.__init__(self)
 
433
        self.value = value
 
434
 
 
435
 
 
436
class BadIndexDuplicateKey(BzrError):
 
437
 
 
438
    _fmt = "The key '%(key)s' is already in index '%(index)s'."
 
439
 
 
440
    def __init__(self, key, index):
 
441
        BzrError.__init__(self)
 
442
        self.key = key
 
443
        self.index = index
 
444
 
 
445
 
 
446
class BadIndexKey(BzrError):
 
447
 
 
448
    _fmt = "The key '%(key)s' is not a valid key."
 
449
 
 
450
    def __init__(self, key):
 
451
        BzrError.__init__(self)
 
452
        self.key = key
 
453
 
 
454
 
 
455
class BadIndexOptions(BzrError):
 
456
 
 
457
    _fmt = "Could not parse options for index %(value)s."
 
458
 
 
459
    def __init__(self, value):
 
460
        BzrError.__init__(self)
 
461
        self.value = value
 
462
 
 
463
 
 
464
class BadIndexValue(BzrError):
 
465
 
 
466
    _fmt = "The value '%(value)s' is not a valid value."
 
467
 
 
468
    def __init__(self, value):
 
469
        BzrError.__init__(self)
 
470
        self.value = value
 
471
 
 
472
 
 
473
class BadOptionValue(BzrError):
 
474
 
 
475
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
 
476
 
 
477
    def __init__(self, name, value):
 
478
        BzrError.__init__(self, name=name, value=value)
 
479
 
 
480
 
307
481
class StrictCommitFailed(BzrError):
308
482
 
309
483
    _fmt = "Commit refused because there are unknown files in the tree"
342
516
    """Used when renaming and both source and dest exist."""
343
517
 
344
518
    _fmt = ("Could not rename %(source)s => %(dest)s because both files exist."
345
 
            " (Use --after to tell brz about a rename that has already"
 
519
            " (Use --after to tell bzr about a rename that has already"
346
520
            " happened)%(extra)s")
347
521
 
348
522
    def __init__(self, source, dest, extra=None):
395
569
    _fmt = 'Permission denied: "%(path)s"%(extra)s'
396
570
 
397
571
 
 
572
class InvalidURL(PathError):
 
573
 
 
574
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
575
 
 
576
 
 
577
class InvalidURLJoin(PathError):
 
578
 
 
579
    _fmt = "Invalid URL join request: %(reason)s: %(base)r + %(join_args)r"
 
580
 
 
581
    def __init__(self, reason, base, join_args):
 
582
        self.reason = reason
 
583
        self.base = base
 
584
        self.join_args = join_args
 
585
        PathError.__init__(self, base, reason)
 
586
 
 
587
 
 
588
class InvalidRebaseURLs(PathError):
 
589
 
 
590
    _fmt = "URLs differ by more than path: %(from_)r and %(to)r"
 
591
 
 
592
    def __init__(self, from_, to):
 
593
        self.from_ = from_
 
594
        self.to = to
 
595
        PathError.__init__(self, from_, 'URLs differ by more than path.')
 
596
 
 
597
 
398
598
class UnavailableRepresentation(InternalBzrError):
399
599
 
400
600
    _fmt = ("The encoding '%(wanted)s' is not available for key %(key)s which "
407
607
        self.key = key
408
608
 
409
609
 
 
610
class UnknownHook(BzrError):
 
611
 
 
612
    _fmt = "The %(type)s hook '%(hook)s' is unknown in this version of bzrlib."
 
613
 
 
614
    def __init__(self, hook_type, hook_name):
 
615
        BzrError.__init__(self)
 
616
        self.type = hook_type
 
617
        self.hook = hook_name
 
618
 
 
619
 
410
620
class UnsupportedProtocol(PathError):
411
621
 
412
622
    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
413
623
 
414
 
    def __init__(self, url, extra=""):
 
624
    def __init__(self, url, extra):
415
625
        PathError.__init__(self, url, extra=extra)
416
626
 
417
627
 
 
628
class UnstackableBranchFormat(BzrError):
 
629
 
 
630
    _fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
 
631
        "You will need to upgrade the branch to permit branch stacking.")
 
632
 
 
633
    def __init__(self, format, url):
 
634
        BzrError.__init__(self)
 
635
        self.format = format
 
636
        self.url = url
 
637
 
 
638
 
418
639
class UnstackableLocationError(BzrError):
419
640
 
420
641
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
459
680
 
460
681
    _fmt = 'Path "%(path)s" is not a child of path "%(base)s"%(extra)s'
461
682
 
462
 
    internal_error = False
 
683
    internal_error = True
463
684
 
464
685
    def __init__(self, path, base, extra=None):
465
686
        BzrError.__init__(self)
481
702
# TODO: Probably this behavior of should be a common superclass
482
703
class NotBranchError(PathError):
483
704
 
484
 
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
485
 
 
486
 
    def __init__(self, path, detail=None, controldir=None):
487
 
       from . import urlutils
488
 
       path = urlutils.unescape_for_display(path, 'ascii')
489
 
       if detail is not None:
490
 
           detail = ': ' + detail
491
 
       self.detail = detail
492
 
       self.controldir = controldir
493
 
       PathError.__init__(self, path=path)
494
 
 
495
 
    def __repr__(self):
496
 
        return '<%s %r>' % (self.__class__.__name__, self.__dict__)
497
 
 
498
 
    def _get_format_string(self):
499
 
        # GZ 2017-06-08: Not the best place to lazy fill detail in.
500
 
        if self.detail is None:
501
 
           self.detail = self._get_detail()
502
 
        return super(NotBranchError, self)._get_format_string()
503
 
 
504
 
    def _get_detail(self):
505
 
        if self.controldir is not None:
506
 
            try:
507
 
                self.controldir.open_repository()
508
 
            except NoRepositoryPresent:
509
 
                return ''
510
 
            except Exception as e:
511
 
                # Just ignore unexpected errors.  Raising arbitrary errors
512
 
                # during str(err) can provoke strange bugs.  Concretely
513
 
                # Launchpad's codehosting managed to raise NotBranchError
514
 
                # here, and then get stuck in an infinite loop/recursion
515
 
                # trying to str() that error.  All this error really cares
516
 
                # about that there's no working repository there, and if
517
 
                # open_repository() fails, there probably isn't.
518
 
                return ': ' + e.__class__.__name__
519
 
            else:
520
 
                return ': location is a repository'
521
 
        return ''
 
705
    _fmt = 'Not a branch: "%(path)s".'
 
706
 
 
707
    def __init__(self, path):
 
708
       import bzrlib.urlutils as urlutils
 
709
       self.path = urlutils.unescape_for_display(path, 'ascii')
522
710
 
523
711
 
524
712
class NoSubmitBranch(PathError):
526
714
    _fmt = 'No submit branch available for branch "%(path)s"'
527
715
 
528
716
    def __init__(self, branch):
529
 
       from . import urlutils
 
717
       import bzrlib.urlutils as urlutils
530
718
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
531
719
 
532
720
 
533
 
class AlreadyControlDirError(PathError):
534
 
 
535
 
    _fmt = 'A control directory already exists: "%(path)s".'
536
 
 
537
 
 
538
721
class AlreadyBranchError(PathError):
539
722
 
540
723
    _fmt = 'Already a branch: "%(path)s".'
541
724
 
542
725
 
543
 
class InvalidBranchName(PathError):
544
 
 
545
 
    _fmt = "Invalid branch name: %(name)s"
546
 
 
547
 
    def __init__(self, name):
548
 
        BzrError.__init__(self)
549
 
        self.name = name
550
 
 
551
 
 
552
 
class ParentBranchExists(AlreadyBranchError):
553
 
 
554
 
    _fmt = 'Parent branch already exists: "%(path)s".'
555
 
 
556
 
 
557
726
class BranchExistsWithoutWorkingTree(PathError):
558
727
 
559
728
    _fmt = 'Directory contains a branch, but no working tree \
560
 
(use brz checkout if you wish to build a working tree): "%(path)s"'
 
729
(use bzr checkout if you wish to build a working tree): "%(path)s"'
561
730
 
562
731
 
563
732
class AtomicFileAlreadyClosed(PathError):
583
752
class NoRepositoryPresent(BzrError):
584
753
 
585
754
    _fmt = 'No repository present: "%(path)s"'
586
 
    def __init__(self, controldir):
587
 
        BzrError.__init__(self)
588
 
        self.path = controldir.transport.clone('..').base
 
755
    def __init__(self, bzrdir):
 
756
        BzrError.__init__(self)
 
757
        self.path = bzrdir.transport.clone('..').base
 
758
 
 
759
 
 
760
class FileInWrongBranch(BzrError):
 
761
 
 
762
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
763
 
 
764
    def __init__(self, branch, path):
 
765
        BzrError.__init__(self)
 
766
        self.branch = branch
 
767
        self.branch_base = branch.base
 
768
        self.path = path
589
769
 
590
770
 
591
771
class UnsupportedFormatError(BzrError):
592
772
 
593
 
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'brz upgrade'"
 
773
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
594
774
 
595
775
 
596
776
class UnknownFormatError(BzrError):
604
784
 
605
785
class IncompatibleFormat(BzrError):
606
786
 
607
 
    _fmt = "Format %(format)s is not compatible with .bzr version %(controldir)s."
608
 
 
609
 
    def __init__(self, format, controldir_format):
610
 
        BzrError.__init__(self)
611
 
        self.format = format
612
 
        self.controldir = controldir_format
613
 
 
614
 
 
615
 
class ParseFormatError(BzrError):
616
 
 
617
 
    _fmt = "Parse error on line %(lineno)d of %(format)s format: %(line)s"
618
 
 
619
 
    def __init__(self, format, lineno, line, text):
620
 
        BzrError.__init__(self)
621
 
        self.format = format
622
 
        self.lineno = lineno
623
 
        self.line = line
624
 
        self.text = text
 
787
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
788
 
 
789
    def __init__(self, format, bzrdir_format):
 
790
        BzrError.__init__(self)
 
791
        self.format = format
 
792
        self.bzrdir = bzrdir_format
625
793
 
626
794
 
627
795
class IncompatibleRepositories(BzrError):
661
829
        """Construct a new AlreadyVersionedError.
662
830
 
663
831
        :param path: This is the path which is versioned,
664
 
            which should be in a user friendly form.
 
832
        which should be in a user friendly form.
665
833
        :param context_info: If given, this is information about the context,
666
 
            which could explain why this is expected to not be versioned.
 
834
        which could explain why this is expected to not be versioned.
667
835
        """
668
836
        BzrError.__init__(self)
669
837
        self.path = path
682
850
        """Construct a new NotVersionedError.
683
851
 
684
852
        :param path: This is the path which is not versioned,
685
 
            which should be in a user friendly form.
 
853
        which should be in a user friendly form.
686
854
        :param context_info: If given, this is information about the context,
687
 
            which could explain why this is expected to be versioned.
 
855
        which could explain why this is expected to be versioned.
688
856
        """
689
857
        BzrError.__init__(self)
690
858
        self.path = path
700
868
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
701
869
 
702
870
    def __init__(self, paths):
703
 
        from breezy.osutils import quotefn
 
871
        from bzrlib.osutils import quotefn
704
872
        BzrError.__init__(self)
705
873
        self.paths = paths
706
874
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
715
883
 
716
884
    def __init__(self, paths, extra=None):
717
885
        # circular import
718
 
        from breezy.osutils import quotefn
 
886
        from bzrlib.osutils import quotefn
719
887
        BzrError.__init__(self)
720
888
        self.paths = paths
721
889
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
758
926
    # original exception is available as e.original_error
759
927
    #
760
928
    # New code should prefer to raise specific subclasses
761
 
    def __init__(self, msg):
762
 
        self.msg = msg
 
929
    def __init__(self, message):
 
930
        # Python 2.5 uses a slot for StandardError.message,
 
931
        # so use a different variable name.  We now work around this in
 
932
        # BzrError.__str__, but this member name is kept for compatability.
 
933
        self.msg = message
763
934
 
764
935
 
765
936
class LockActive(LockError):
849
1020
class LockContention(LockError):
850
1021
 
851
1022
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1023
    # TODO: show full url for lock, combining the transport and relative
 
1024
    # bits?
852
1025
 
853
1026
    internal_error = False
854
1027
 
881
1054
        self.target = target
882
1055
 
883
1056
 
884
 
class LockCorrupt(LockError):
885
 
 
886
 
    _fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
887
 
            "Use 'brz break-lock' to clear it")
888
 
 
889
 
    internal_error = False
890
 
 
891
 
    def __init__(self, corruption_info, file_data=None):
892
 
        self.corruption_info = corruption_info
893
 
        self.file_data = file_data
894
 
 
895
 
 
896
1057
class LockNotHeld(LockError):
897
1058
 
898
1059
    _fmt = "Lock not held: %(lock)s"
922
1083
        self.lock_token = lock_token
923
1084
 
924
1085
 
 
1086
class PointlessCommit(BzrError):
 
1087
 
 
1088
    _fmt = "No changes to commit"
 
1089
 
 
1090
 
 
1091
class CannotCommitSelectedFileMerge(BzrError):
 
1092
 
 
1093
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
1094
        ' files %(files_str)s'
 
1095
 
 
1096
    def __init__(self, files):
 
1097
        files_str = ', '.join(files)
 
1098
        BzrError.__init__(self, files=files, files_str=files_str)
 
1099
 
 
1100
 
 
1101
class BadCommitMessageEncoding(BzrError):
 
1102
 
 
1103
    _fmt = 'The specified commit message contains characters unsupported by '\
 
1104
        'the current encoding.'
 
1105
 
 
1106
 
925
1107
class UpgradeReadonly(BzrError):
926
1108
 
927
1109
    _fmt = "Upgrade URL cannot work with readonly URLs."
936
1118
        self.format = format
937
1119
 
938
1120
 
 
1121
class StrictCommitFailed(Exception):
 
1122
 
 
1123
    _fmt = "Commit refused because there are unknowns in the tree."
 
1124
 
 
1125
 
939
1126
class NoSuchRevision(InternalBzrError):
940
1127
 
941
1128
    _fmt = "%(branch)s has no revision %(revision)s"
971
1158
 
972
1159
class InvalidRevisionSpec(BzrError):
973
1160
 
974
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
975
 
            " %(branch_url)s%(extra)s")
 
1161
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1162
            " %(branch)s%(extra)s")
976
1163
 
977
1164
    def __init__(self, spec, branch, extra=None):
978
1165
        BzrError.__init__(self, branch=branch, spec=spec)
979
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
980
1166
        if extra:
981
1167
            self.extra = '\n' + str(extra)
982
1168
        else:
983
1169
            self.extra = ''
984
1170
 
985
1171
 
 
1172
class HistoryMissing(BzrError):
 
1173
 
 
1174
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1175
 
 
1176
 
986
1177
class AppendRevisionsOnlyViolation(BzrError):
987
1178
 
988
1179
    _fmt = ('Operation denied because it would change the main history,'
990
1181
           ' branch "%(location)s".')
991
1182
 
992
1183
    def __init__(self, location):
993
 
       import breezy.urlutils as urlutils
 
1184
       import bzrlib.urlutils as urlutils
994
1185
       location = urlutils.unescape_for_display(location, 'ascii')
995
1186
       BzrError.__init__(self, location=location)
996
1187
 
1053
1244
            not_ancestor_id=not_ancestor_id)
1054
1245
 
1055
1246
 
 
1247
class AmbiguousBase(BzrError):
 
1248
 
 
1249
    def __init__(self, bases):
 
1250
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1251
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1252
        msg = ("The correct base is unclear, because %s are all equally close"
 
1253
                % ", ".join(bases))
 
1254
        BzrError.__init__(self, msg)
 
1255
        self.bases = bases
 
1256
 
 
1257
 
1056
1258
class NoCommits(BranchError):
1057
1259
 
1058
1260
    _fmt = "Branch %(branch)s has no commits."
1074
1276
class BoundBranchOutOfDate(BzrError):
1075
1277
 
1076
1278
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1077
 
            " %(master)s.%(extra_help)s")
 
1279
            " %(master)s.")
1078
1280
 
1079
1281
    def __init__(self, branch, master):
1080
1282
        BzrError.__init__(self)
1081
1283
        self.branch = branch
1082
1284
        self.master = master
1083
 
        self.extra_help = ''
1084
1285
 
1085
1286
 
1086
1287
class CommitToDoubleBoundBranch(BzrError):
1116
1317
        self.error = error
1117
1318
 
1118
1319
 
 
1320
class WeaveError(BzrError):
 
1321
 
 
1322
    _fmt = "Error in processing weave: %(msg)s"
 
1323
 
 
1324
    def __init__(self, msg=None):
 
1325
        BzrError.__init__(self)
 
1326
        self.msg = msg
 
1327
 
 
1328
 
 
1329
class WeaveRevisionAlreadyPresent(WeaveError):
 
1330
 
 
1331
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1332
 
 
1333
    def __init__(self, revision_id, weave):
 
1334
 
 
1335
        WeaveError.__init__(self)
 
1336
        self.revision_id = revision_id
 
1337
        self.weave = weave
 
1338
 
 
1339
 
 
1340
class WeaveRevisionNotPresent(WeaveError):
 
1341
 
 
1342
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
1343
 
 
1344
    def __init__(self, revision_id, weave):
 
1345
        WeaveError.__init__(self)
 
1346
        self.revision_id = revision_id
 
1347
        self.weave = weave
 
1348
 
 
1349
 
 
1350
class WeaveFormatError(WeaveError):
 
1351
 
 
1352
    _fmt = "Weave invariant violated: %(what)s"
 
1353
 
 
1354
    def __init__(self, what):
 
1355
        WeaveError.__init__(self)
 
1356
        self.what = what
 
1357
 
 
1358
 
 
1359
class WeaveParentMismatch(WeaveError):
 
1360
 
 
1361
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1362
 
 
1363
 
 
1364
class WeaveInvalidChecksum(WeaveError):
 
1365
 
 
1366
    _fmt = "Text did not match it's checksum: %(message)s"
 
1367
 
 
1368
 
 
1369
class WeaveTextDiffers(WeaveError):
 
1370
 
 
1371
    _fmt = ("Weaves differ on text content. Revision:"
 
1372
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1373
 
 
1374
    def __init__(self, revision_id, weave_a, weave_b):
 
1375
        WeaveError.__init__(self)
 
1376
        self.revision_id = revision_id
 
1377
        self.weave_a = weave_a
 
1378
        self.weave_b = weave_b
 
1379
 
 
1380
 
 
1381
class WeaveTextDiffers(WeaveError):
 
1382
 
 
1383
    _fmt = ("Weaves differ on text content. Revision:"
 
1384
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1385
 
 
1386
    def __init__(self, revision_id, weave_a, weave_b):
 
1387
        WeaveError.__init__(self)
 
1388
        self.revision_id = revision_id
 
1389
        self.weave_a = weave_a
 
1390
        self.weave_b = weave_b
 
1391
 
 
1392
 
1119
1393
class VersionedFileError(BzrError):
1120
1394
 
1121
1395
    _fmt = "Versioned file error"
1143
1417
 
1144
1418
class VersionedFileInvalidChecksum(VersionedFileError):
1145
1419
 
1146
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1420
    _fmt = "Text did not match its checksum: %(message)s"
 
1421
 
 
1422
 
 
1423
class KnitError(InternalBzrError):
 
1424
 
 
1425
    _fmt = "Knit error"
 
1426
 
 
1427
 
 
1428
class KnitCorrupt(KnitError):
 
1429
 
 
1430
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
1431
 
 
1432
    def __init__(self, filename, how):
 
1433
        KnitError.__init__(self)
 
1434
        self.filename = filename
 
1435
        self.how = how
 
1436
 
 
1437
 
 
1438
class SHA1KnitCorrupt(KnitCorrupt):
 
1439
 
 
1440
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1441
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1442
        "sha %(actual)s")
 
1443
 
 
1444
    def __init__(self, filename, actual, expected, key, content):
 
1445
        KnitError.__init__(self)
 
1446
        self.filename = filename
 
1447
        self.actual = actual
 
1448
        self.expected = expected
 
1449
        self.key = key
 
1450
        self.content = content
 
1451
 
 
1452
 
 
1453
class KnitDataStreamIncompatible(KnitError):
 
1454
    # Not raised anymore, as we can convert data streams.  In future we may
 
1455
    # need it again for more exotic cases, so we're keeping it around for now.
 
1456
 
 
1457
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1458
 
 
1459
    def __init__(self, stream_format, target_format):
 
1460
        self.stream_format = stream_format
 
1461
        self.target_format = target_format
 
1462
 
 
1463
 
 
1464
class KnitDataStreamUnknown(KnitError):
 
1465
    # Indicates a data stream we don't know how to handle.
 
1466
 
 
1467
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1468
 
 
1469
    def __init__(self, stream_format):
 
1470
        self.stream_format = stream_format
 
1471
 
 
1472
 
 
1473
class KnitHeaderError(KnitError):
 
1474
 
 
1475
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1476
 
 
1477
    def __init__(self, badline, filename):
 
1478
        KnitError.__init__(self)
 
1479
        self.badline = badline
 
1480
        self.filename = filename
 
1481
 
 
1482
class KnitIndexUnknownMethod(KnitError):
 
1483
    """Raised when we don't understand the storage method.
 
1484
 
 
1485
    Currently only 'fulltext' and 'line-delta' are supported.
 
1486
    """
 
1487
 
 
1488
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1489
            " in options: %(options)r")
 
1490
 
 
1491
    def __init__(self, filename, options):
 
1492
        KnitError.__init__(self)
 
1493
        self.filename = filename
 
1494
        self.options = options
1147
1495
 
1148
1496
 
1149
1497
class RetryWithNewPacks(BzrError):
1171
1519
            problem we can raise the original error (value from sys.exc_info())
1172
1520
        """
1173
1521
        BzrError.__init__(self)
1174
 
        self.context = context
1175
1522
        self.reload_occurred = reload_occurred
1176
1523
        self.exc_info = exc_info
1177
1524
        self.orig_error = exc_info[1]
1259
1606
 
1260
1607
    def __init__(self, exc_info):
1261
1608
        import traceback
1262
 
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1263
1609
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1264
1610
        self.exc_info = exc_info
1265
1611
        traceback_strings = traceback.format_exception(
1304
1650
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1305
1651
 
1306
1652
 
1307
 
class ConnectionTimeout(ConnectionError):
1308
 
 
1309
 
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
1310
 
 
1311
 
 
1312
1653
class InvalidRange(TransportError):
1313
1654
 
1314
1655
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1321
1662
 
1322
1663
class InvalidHttpResponse(TransportError):
1323
1664
 
1324
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1665
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1325
1666
 
1326
1667
    def __init__(self, path, msg, orig_error=None):
1327
1668
        self.path = path
1328
 
        if orig_error is None:
1329
 
            orig_error = ''
1330
 
        else:
1331
 
            # This is reached for obscure and unusual errors so we want to
1332
 
            # preserve as much info as possible to ease debug.
1333
 
            orig_error = ': %r' % (orig_error,)
1334
1669
        TransportError.__init__(self, msg, orig_error=orig_error)
1335
1670
 
1336
1671
 
1343
1678
        InvalidHttpResponse.__init__(self, path, msg)
1344
1679
 
1345
1680
 
1346
 
class HttpBoundaryMissing(InvalidHttpResponse):
1347
 
    """A multipart response ends with no boundary marker.
1348
 
 
1349
 
    This is a special case caused by buggy proxies, described in
1350
 
    <https://bugs.launchpad.net/bzr/+bug/198646>.
1351
 
    """
1352
 
 
1353
 
    _fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
1354
 
 
1355
 
    def __init__(self, path, msg):
1356
 
        InvalidHttpResponse.__init__(self, path, msg)
1357
 
 
1358
 
 
1359
1681
class InvalidHttpContentType(InvalidHttpResponse):
1360
1682
 
1361
1683
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1389
1711
    _fmt = "Working tree has conflicts."
1390
1712
 
1391
1713
 
1392
 
class DependencyNotPresent(BzrError):
1393
 
 
1394
 
    _fmt = 'Unable to import library "%(library)s": %(error)s'
1395
 
 
1396
 
    def __init__(self, library, error):
1397
 
        BzrError.__init__(self, library=library, error=error)
 
1714
class ParseConfigError(BzrError):
 
1715
 
 
1716
    def __init__(self, errors, filename):
 
1717
        if filename is None:
 
1718
            filename = ""
 
1719
        message = "Error(s) parsing config file %s:\n%s" % \
 
1720
            (filename, ('\n'.join(e.msg for e in errors)))
 
1721
        BzrError.__init__(self, message)
 
1722
 
 
1723
 
 
1724
class NoEmailInUsername(BzrError):
 
1725
 
 
1726
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1727
 
 
1728
    def __init__(self, username):
 
1729
        BzrError.__init__(self)
 
1730
        self.username = username
 
1731
 
 
1732
 
 
1733
class SigningFailed(BzrError):
 
1734
 
 
1735
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1736
 
 
1737
    def __init__(self, command_line):
 
1738
        BzrError.__init__(self, command_line=command_line)
1398
1739
 
1399
1740
 
1400
1741
class WorkingTreeNotRevision(BzrError):
1518
1859
        self.prefix = prefix
1519
1860
 
1520
1861
 
1521
 
class MalformedTransform(InternalBzrError):
 
1862
class MalformedTransform(BzrError):
1522
1863
 
1523
1864
    _fmt = "Tree transform is malformed %(conflicts)r"
1524
1865
 
1562
1903
    _fmt = "Moving the root directory is not supported at this time"
1563
1904
 
1564
1905
 
1565
 
class TransformRenameFailed(BzrError):
1566
 
 
1567
 
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1568
 
 
1569
 
    def __init__(self, from_path, to_path, why, errno):
1570
 
        self.from_path = from_path
1571
 
        self.to_path = to_path
1572
 
        self.why = why
1573
 
        self.errno = errno
1574
 
 
1575
 
 
1576
1906
class BzrMoveFailedError(BzrError):
1577
1907
 
1578
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
1579
 
        "%(_has_extra)s%(extra)s")
 
1908
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1580
1909
 
1581
1910
    def __init__(self, from_path='', to_path='', extra=None):
1582
 
        from breezy.osutils import splitpath
 
1911
        from bzrlib.osutils import splitpath
1583
1912
        BzrError.__init__(self)
1584
1913
        if extra:
1585
 
            self.extra, self._has_extra = extra, ': '
 
1914
            self.extra = ': ' + str(extra)
1586
1915
        else:
1587
 
            self.extra = self._has_extra = ''
 
1916
            self.extra = ''
1588
1917
 
1589
1918
        has_from = len(from_path) > 0
1590
1919
        has_to = len(to_path) > 0
1611
1940
 
1612
1941
class BzrRenameFailedError(BzrMoveFailedError):
1613
1942
 
1614
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
1615
 
        "%(_has_extra)s%(extra)s")
 
1943
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
1616
1944
 
1617
1945
    def __init__(self, from_path, to_path, extra=None):
1618
1946
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1619
1947
 
 
1948
class BzrRemoveChangedFilesError(BzrError):
 
1949
    """Used when user is trying to remove changed files."""
 
1950
 
 
1951
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1952
        "%(changes_as_text)s"
 
1953
        "Use --keep to not delete them, or --force to delete them regardless.")
 
1954
 
 
1955
    def __init__(self, tree_delta):
 
1956
        BzrError.__init__(self)
 
1957
        self.changes_as_text = tree_delta.get_changes_as_text()
 
1958
        #self.paths_as_string = '\n'.join(changed_files)
 
1959
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
1960
 
1620
1961
 
1621
1962
class BzrBadParameterNotString(BzrBadParameter):
1622
1963
 
1625
1966
 
1626
1967
class BzrBadParameterMissing(BzrBadParameter):
1627
1968
 
1628
 
    _fmt = "Parameter %(param)s is required but not present."
 
1969
    _fmt = "Parameter $(param)s is required but not present."
1629
1970
 
1630
1971
 
1631
1972
class BzrBadParameterUnicode(BzrBadParameter):
1639
1980
    _fmt = "Parameter %(param)s contains a newline."
1640
1981
 
1641
1982
 
 
1983
class DependencyNotPresent(BzrError):
 
1984
 
 
1985
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
1986
 
 
1987
    def __init__(self, library, error):
 
1988
        BzrError.__init__(self, library=library, error=error)
 
1989
 
 
1990
 
1642
1991
class ParamikoNotPresent(DependencyNotPresent):
1643
1992
 
1644
1993
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
1654
2003
 
1655
2004
class UninitializableFormat(BzrError):
1656
2005
 
1657
 
    _fmt = "Format %(format)s cannot be initialised by this version of brz."
 
2006
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
1658
2007
 
1659
2008
    def __init__(self, format):
1660
2009
        BzrError.__init__(self)
1703
2052
 
1704
2053
 
1705
2054
class ExistingContent(BzrError):
1706
 
    # Added in breezy 0.92, used by VersionedFile.add_lines.
 
2055
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
1707
2056
 
1708
2057
    _fmt = "The content being inserted is already present."
1709
2058
 
1752
2101
 
1753
2102
class OutOfDateTree(BzrError):
1754
2103
 
1755
 
    _fmt = "Working tree is out of date, please run 'brz update'.%(more)s"
 
2104
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
1756
2105
 
1757
2106
    def __init__(self, tree, more=None):
1758
2107
        if more is None:
1770
2119
        '"%(revstring)s".'
1771
2120
 
1772
2121
    def __init__(self, public_location, revstring):
1773
 
        import breezy.urlutils as urlutils
 
2122
        import bzrlib.urlutils as urlutils
1774
2123
        public_location = urlutils.unescape_for_display(public_location,
1775
2124
                                                        'ascii')
1776
2125
        BzrError.__init__(self, public_location=public_location,
1787
2136
    _fmt = "Format error in conflict listings"
1788
2137
 
1789
2138
 
 
2139
class CorruptDirstate(BzrError):
 
2140
 
 
2141
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2142
            "Error: %(description)s")
 
2143
 
 
2144
    def __init__(self, dirstate_path, description):
 
2145
        BzrError.__init__(self)
 
2146
        self.dirstate_path = dirstate_path
 
2147
        self.description = description
 
2148
 
 
2149
 
1790
2150
class CorruptRepository(BzrError):
1791
2151
 
1792
2152
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
1793
 
            "Please run brz reconcile on this repository.")
 
2153
            "Please run bzr reconcile on this repository.")
1794
2154
 
1795
2155
    def __init__(self, repo):
1796
2156
        BzrError.__init__(self)
1797
 
        self.repo_path = repo.user_url
 
2157
        self.repo_path = repo.bzrdir.root_transport.base
1798
2158
 
1799
2159
 
1800
2160
class InconsistentDelta(BzrError):
1858
2218
        self.tname = type(method_self).__name__
1859
2219
 
1860
2220
 
1861
 
class FetchLimitUnsupported(UnsupportedOperation):
1862
 
 
1863
 
    fmt = ("InterBranch %(interbranch)r does not support fetching limits.")
1864
 
 
1865
 
    def __init__(self, interbranch):
1866
 
        BzrError.__init__(self, interbranch=interbranch)
 
2221
class CannotSetRevisionId(UnsupportedOperation):
 
2222
    """Raised when a commit is attempting to set a revision id but cant."""
1867
2223
 
1868
2224
 
1869
2225
class NonAsciiRevisionId(UnsupportedOperation):
1872
2228
    """
1873
2229
 
1874
2230
 
1875
 
class GhostTagsNotSupported(BzrError):
1876
 
 
1877
 
    _fmt = "Ghost tags not supported by format %(format)r."
1878
 
 
1879
 
    def __init__(self, format):
1880
 
        self.format = format
1881
 
 
1882
 
 
1883
2231
class BinaryFile(BzrError):
1884
2232
 
1885
2233
    _fmt = "File is binary but should be text."
1987
2335
 
1988
2336
class UnknownSSH(BzrError):
1989
2337
 
1990
 
    _fmt = "Unrecognised value for BRZ_SSH environment variable: %(vendor)s"
 
2338
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
1991
2339
 
1992
2340
    def __init__(self, vendor):
1993
2341
        BzrError.__init__(self)
1997
2345
class SSHVendorNotFound(BzrError):
1998
2346
 
1999
2347
    _fmt = ("Don't know how to handle SSH connections."
2000
 
            " Please set BRZ_SSH environment variable.")
 
2348
            " Please set BZR_SSH environment variable.")
2001
2349
 
2002
2350
 
2003
2351
class GhostRevisionsHaveNoRevno(BzrError):
2133
2481
        self.other_tree = other_tree
2134
2482
 
2135
2483
 
 
2484
class BadReferenceTarget(InternalBzrError):
 
2485
 
 
2486
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2487
           "%(reason)s"
 
2488
 
 
2489
    def __init__(self, tree, other_tree, reason):
 
2490
        self.tree = tree
 
2491
        self.other_tree = other_tree
 
2492
        self.reason = reason
 
2493
 
 
2494
 
2136
2495
class NoSuchTag(BzrError):
2137
2496
 
2138
2497
    _fmt = "No such tag: %(tag_name)s"
2144
2503
class TagsNotSupported(BzrError):
2145
2504
 
2146
2505
    _fmt = ("Tags not supported by %(branch)s;"
2147
 
            " you may be able to use brz upgrade.")
 
2506
            " you may be able to use bzr upgrade.")
2148
2507
 
2149
2508
    def __init__(self, branch):
2150
2509
        self.branch = branch
2158
2517
        self.tag_name = tag_name
2159
2518
 
2160
2519
 
 
2520
class MalformedBugIdentifier(BzrError):
 
2521
 
 
2522
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2523
            'See "bzr help bugs" for more information on this feature.')
 
2524
 
 
2525
    def __init__(self, bug_id, reason):
 
2526
        self.bug_id = bug_id
 
2527
        self.reason = reason
 
2528
 
 
2529
 
 
2530
class InvalidBugTrackerURL(BzrError):
 
2531
 
 
2532
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2533
            "contain {id}: %(url)s")
 
2534
 
 
2535
    def __init__(self, abbreviation, url):
 
2536
        self.abbreviation = abbreviation
 
2537
        self.url = url
 
2538
 
 
2539
 
 
2540
class UnknownBugTrackerAbbreviation(BzrError):
 
2541
 
 
2542
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2543
            "on %(branch)s")
 
2544
 
 
2545
    def __init__(self, abbreviation, branch):
 
2546
        self.abbreviation = abbreviation
 
2547
        self.branch = branch
 
2548
 
 
2549
 
 
2550
class InvalidLineInBugsProperty(BzrError):
 
2551
 
 
2552
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2553
 
 
2554
    def __init__(self, line):
 
2555
        self.line = line
 
2556
 
 
2557
 
 
2558
class InvalidBugStatus(BzrError):
 
2559
 
 
2560
    _fmt = ("Invalid bug status: '%(status)s'")
 
2561
 
 
2562
    def __init__(self, status):
 
2563
        self.status = status
 
2564
 
 
2565
 
2161
2566
class UnexpectedSmartServerResponse(BzrError):
2162
2567
 
2163
2568
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2186
2591
 
2187
2592
 
2188
2593
class UnknownErrorFromSmartServer(BzrError):
2189
 
    """An ErrorFromSmartServer could not be translated into a typical breezy
 
2594
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2190
2595
    error.
2191
2596
 
2192
2597
    This is distinct from ErrorFromSmartServer so that it is possible to
2193
2598
    distinguish between the following two cases:
2194
 
 
2195
 
    - ErrorFromSmartServer was uncaught.  This is logic error in the client
2196
 
      and so should provoke a traceback to the user.
2197
 
    - ErrorFromSmartServer was caught but its error_tuple could not be
2198
 
      translated.  This is probably because the server sent us garbage, and
2199
 
      should not provoke a traceback.
 
2599
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2600
        and so should provoke a traceback to the user.
 
2601
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2602
        translated.  This is probably because the server sent us garbage, and
 
2603
        should not provoke a traceback.
2200
2604
    """
2201
2605
 
2202
2606
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2258
2662
    _fmt = "Container has multiple records with the same name: %(name)s"
2259
2663
 
2260
2664
    def __init__(self, name):
2261
 
        self.name = name.decode("utf-8")
 
2665
        self.name = name
 
2666
 
 
2667
 
 
2668
class NoDestinationAddress(InternalBzrError):
 
2669
 
 
2670
    _fmt = "Message does not have a destination address."
2262
2671
 
2263
2672
 
2264
2673
class RepositoryDataStreamError(BzrError):
2269
2678
        self.reason = reason
2270
2679
 
2271
2680
 
 
2681
class SMTPError(BzrError):
 
2682
 
 
2683
    _fmt = "SMTP error: %(error)s"
 
2684
 
 
2685
    def __init__(self, error):
 
2686
        self.error = error
 
2687
 
 
2688
 
 
2689
class NoMessageSupplied(BzrError):
 
2690
 
 
2691
    _fmt = "No message supplied."
 
2692
 
 
2693
 
 
2694
class NoMailAddressSpecified(BzrError):
 
2695
 
 
2696
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2697
 
 
2698
 
 
2699
class UnknownMailClient(BzrError):
 
2700
 
 
2701
    _fmt = "Unknown mail client: %(mail_client)s"
 
2702
 
 
2703
    def __init__(self, mail_client):
 
2704
        BzrError.__init__(self, mail_client=mail_client)
 
2705
 
 
2706
 
 
2707
class MailClientNotFound(BzrError):
 
2708
 
 
2709
    _fmt = "Unable to find mail client with the following names:"\
 
2710
        " %(mail_command_list_string)s"
 
2711
 
 
2712
    def __init__(self, mail_command_list):
 
2713
        mail_command_list_string = ', '.join(mail_command_list)
 
2714
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2715
                          mail_command_list_string=mail_command_list_string)
 
2716
 
 
2717
class SMTPConnectionRefused(SMTPError):
 
2718
 
 
2719
    _fmt = "SMTP connection to %(host)s refused"
 
2720
 
 
2721
    def __init__(self, error, host):
 
2722
        self.error = error
 
2723
        self.host = host
 
2724
 
 
2725
 
 
2726
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2727
 
 
2728
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2729
 
 
2730
 
 
2731
class BzrDirError(BzrError):
 
2732
 
 
2733
    def __init__(self, bzrdir):
 
2734
        import bzrlib.urlutils as urlutils
 
2735
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2736
                                                    'ascii')
 
2737
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2738
 
 
2739
 
 
2740
class UnsyncedBranches(BzrDirError):
 
2741
 
 
2742
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2743
            " bzr help sync-for-reconfigure.")
 
2744
 
 
2745
    def __init__(self, bzrdir, target_branch):
 
2746
        BzrDirError.__init__(self, bzrdir)
 
2747
        import bzrlib.urlutils as urlutils
 
2748
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2749
                                                        'ascii')
 
2750
 
 
2751
 
 
2752
class AlreadyBranch(BzrDirError):
 
2753
 
 
2754
    _fmt = "'%(display_url)s' is already a branch."
 
2755
 
 
2756
 
 
2757
class AlreadyTree(BzrDirError):
 
2758
 
 
2759
    _fmt = "'%(display_url)s' is already a tree."
 
2760
 
 
2761
 
 
2762
class AlreadyCheckout(BzrDirError):
 
2763
 
 
2764
    _fmt = "'%(display_url)s' is already a checkout."
 
2765
 
 
2766
 
 
2767
class AlreadyLightweightCheckout(BzrDirError):
 
2768
 
 
2769
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2770
 
 
2771
 
 
2772
class AlreadyUsingShared(BzrDirError):
 
2773
 
 
2774
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2775
 
 
2776
 
 
2777
class AlreadyStandalone(BzrDirError):
 
2778
 
 
2779
    _fmt = "'%(display_url)s' is already standalone."
 
2780
 
 
2781
 
 
2782
class AlreadyWithTrees(BzrDirError):
 
2783
 
 
2784
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2785
            "working trees.")
 
2786
 
 
2787
 
 
2788
class AlreadyWithNoTrees(BzrDirError):
 
2789
 
 
2790
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2791
            "working trees.")
 
2792
 
 
2793
 
 
2794
class ReconfigurationNotSupported(BzrDirError):
 
2795
 
 
2796
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2797
 
 
2798
 
 
2799
class NoBindLocation(BzrDirError):
 
2800
 
 
2801
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2802
 
 
2803
 
2272
2804
class UncommittedChanges(BzrError):
2273
2805
 
2274
2806
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2275
 
            ' (See brz status).%(more)s')
 
2807
            ' (See bzr status).%(more)s')
2276
2808
 
2277
2809
    def __init__(self, tree, more=None):
2278
2810
        if more is None:
2279
2811
            more = ''
2280
2812
        else:
2281
2813
            more = ' ' + more
2282
 
        import breezy.urlutils as urlutils
2283
 
        user_url = getattr(tree, "user_url", None)
2284
 
        if user_url is None:
2285
 
            display_url = str(tree)
2286
 
        else:
2287
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
 
2814
        import bzrlib.urlutils as urlutils
 
2815
        display_url = urlutils.unescape_for_display(
 
2816
            tree.bzrdir.root_transport.base, 'ascii')
2288
2817
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2289
2818
 
2290
2819
 
2291
 
class StoringUncommittedNotSupported(BzrError):
2292
 
 
2293
 
    _fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
2294
 
            ' changes.')
2295
 
 
2296
 
    def __init__(self, branch):
2297
 
        import breezy.urlutils as urlutils
2298
 
        user_url = getattr(branch, "user_url", None)
2299
 
        if user_url is None:
2300
 
            display_url = str(branch)
2301
 
        else:
2302
 
            display_url = urlutils.unescape_for_display(user_url, 'ascii')
2303
 
        BzrError.__init__(self, branch=branch, display_url=display_url)
2304
 
 
2305
 
 
2306
 
class ShelvedChanges(UncommittedChanges):
2307
 
 
2308
 
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
2309
 
            ' (See brz shelve --list).%(more)s')
 
2820
class MissingTemplateVariable(BzrError):
 
2821
 
 
2822
    _fmt = 'Variable {%(name)s} is not available.'
 
2823
 
 
2824
    def __init__(self, name):
 
2825
        self.name = name
 
2826
 
 
2827
 
 
2828
class NoTemplate(BzrError):
 
2829
 
 
2830
    _fmt = 'No template specified.'
2310
2831
 
2311
2832
 
2312
2833
class UnableCreateSymlink(BzrError):
2324
2845
        self.path_str = path_str
2325
2846
 
2326
2847
 
 
2848
class UnsupportedTimezoneFormat(BzrError):
 
2849
 
 
2850
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2851
            'options are "utc", "original", "local".')
 
2852
 
 
2853
    def __init__(self, timezone):
 
2854
        self.timezone = timezone
 
2855
 
 
2856
 
 
2857
class CommandAvailableInPlugin(StandardError):
 
2858
 
 
2859
    internal_error = False
 
2860
 
 
2861
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2862
 
 
2863
        self.plugin_metadata = plugin_metadata
 
2864
        self.cmd_name = cmd_name
 
2865
        self.provider = provider
 
2866
 
 
2867
    def __str__(self):
 
2868
 
 
2869
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2870
                'However, the following official plugin provides this command: %s\n'
 
2871
                'You can install it by going to: %s'
 
2872
                % (self.cmd_name, self.plugin_metadata['name'],
 
2873
                    self.plugin_metadata['url']))
 
2874
 
 
2875
        return _fmt
 
2876
 
 
2877
 
 
2878
class NoPluginAvailable(BzrError):
 
2879
    pass
 
2880
 
 
2881
 
2327
2882
class UnableEncodePath(BzrError):
2328
2883
 
2329
2884
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2330
2885
            'user encoding %(user_encoding)s')
2331
2886
 
2332
2887
    def __init__(self, path, kind):
2333
 
        from breezy.osutils import get_user_encoding
 
2888
        from bzrlib.osutils import get_user_encoding
2334
2889
        self.path = path
2335
2890
        self.kind = kind
2336
 
        self.user_encoding = get_user_encoding()
 
2891
        self.user_encoding = osutils.get_user_encoding()
2337
2892
 
2338
2893
 
2339
2894
class NoSuchAlias(BzrError):
2344
2899
        BzrError.__init__(self, alias_name=alias_name)
2345
2900
 
2346
2901
 
 
2902
class DirectoryLookupFailure(BzrError):
 
2903
    """Base type for lookup errors."""
 
2904
 
 
2905
    pass
 
2906
 
 
2907
 
 
2908
class InvalidLocationAlias(DirectoryLookupFailure):
 
2909
 
 
2910
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
2911
 
 
2912
    def __init__(self, alias_name):
 
2913
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
2914
 
 
2915
 
 
2916
class UnsetLocationAlias(DirectoryLookupFailure):
 
2917
 
 
2918
    _fmt = 'No %(alias_name)s location assigned.'
 
2919
 
 
2920
    def __init__(self, alias_name):
 
2921
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
2922
 
 
2923
 
2347
2924
class CannotBindAddress(BzrError):
2348
2925
 
2349
2926
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2354
2931
            orig_error=repr(orig_error.args))
2355
2932
 
2356
2933
 
 
2934
class UnknownRules(BzrError):
 
2935
 
 
2936
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
2937
 
 
2938
    def __init__(self, unknowns):
 
2939
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
2940
 
 
2941
 
 
2942
class HookFailed(BzrError):
 
2943
    """Raised when a pre_change_branch_tip hook function fails anything other
 
2944
    than TipChangeRejected.
 
2945
 
 
2946
    Note that this exception is no longer raised, and the import is only left
 
2947
    to be nice to code which might catch it in a plugin.
 
2948
    """
 
2949
 
 
2950
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
2951
            "%(traceback_text)s%(exc_value)s")
 
2952
 
 
2953
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
 
2954
        if warn:
 
2955
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
 
2956
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
 
2957
        import traceback
 
2958
        self.hook_stage = hook_stage
 
2959
        self.hook_name = hook_name
 
2960
        self.exc_info = exc_info
 
2961
        self.exc_type = exc_info[0]
 
2962
        self.exc_value = exc_info[1]
 
2963
        self.exc_tb = exc_info[2]
 
2964
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
2965
 
 
2966
 
2357
2967
class TipChangeRejected(BzrError):
2358
2968
    """A pre_change_branch_tip hook function may raise this to cleanly and
2359
2969
    explicitly abort a change to a branch tip.
2365
2975
        self.msg = msg
2366
2976
 
2367
2977
 
 
2978
class ShelfCorrupt(BzrError):
 
2979
 
 
2980
    _fmt = "Shelf corrupt."
 
2981
 
 
2982
 
 
2983
class NoSuchShelfId(BzrError):
 
2984
 
 
2985
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
2986
 
 
2987
    def __init__(self, shelf_id):
 
2988
        BzrError.__init__(self, shelf_id=shelf_id)
 
2989
 
 
2990
 
 
2991
class InvalidShelfId(BzrError):
 
2992
 
 
2993
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
2994
 
 
2995
    def __init__(self, invalid_id):
 
2996
        BzrError.__init__(self, invalid_id=invalid_id)
 
2997
 
 
2998
 
2368
2999
class JailBreak(BzrError):
2369
3000
 
2370
3001
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
2378
3009
    _fmt = 'The user aborted the operation.'
2379
3010
 
2380
3011
 
 
3012
class MustHaveWorkingTree(BzrError):
 
3013
 
 
3014
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
3015
 
 
3016
    def __init__(self, format, url):
 
3017
        BzrError.__init__(self, format=format, url=url)
 
3018
 
 
3019
 
 
3020
class NoSuchView(BzrError):
 
3021
    """A view does not exist.
 
3022
    """
 
3023
 
 
3024
    _fmt = u"No such view: %(view_name)s."
 
3025
 
 
3026
    def __init__(self, view_name):
 
3027
        self.view_name = view_name
 
3028
 
 
3029
 
 
3030
class ViewsNotSupported(BzrError):
 
3031
    """Views are not supported by a tree format.
 
3032
    """
 
3033
 
 
3034
    _fmt = ("Views are not supported by %(tree)s;"
 
3035
            " use 'bzr upgrade' to change your tree to a later format.")
 
3036
 
 
3037
    def __init__(self, tree):
 
3038
        self.tree = tree
 
3039
 
 
3040
 
 
3041
class FileOutsideView(BzrError):
 
3042
 
 
3043
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3044
            '%(view_str)s')
 
3045
 
 
3046
    def __init__(self, file_name, view_files):
 
3047
        self.file_name = file_name
 
3048
        self.view_str = ", ".join(view_files)
 
3049
 
 
3050
 
2381
3051
class UnresumableWriteGroup(BzrError):
2382
3052
 
2383
3053
    _fmt = ("Repository %(repository)s cannot resume write group "
2423
3093
    def __init__(self, source_branch, target_branch):
2424
3094
        self.source_branch = source_branch
2425
3095
        self.target_branch = target_branch
2426
 
 
2427
 
 
2428
 
class NoColocatedBranchSupport(BzrError):
2429
 
 
2430
 
    _fmt = ("%(controldir)r does not support co-located branches.")
2431
 
 
2432
 
    def __init__(self, controldir):
2433
 
        self.controldir = controldir
2434
 
 
2435
 
 
2436
 
class RecursiveBind(BzrError):
2437
 
 
2438
 
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
2439
 
        'Please use `brz unbind` to fix.')
2440
 
 
2441
 
    def __init__(self, branch_url):
2442
 
        self.branch_url = branch_url
2443
 
 
2444
 
 
2445
 
class UnsupportedKindChange(BzrError):
2446
 
 
2447
 
    _fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
2448
 
            "%(path)s not supported by format %(format)r")
2449
 
 
2450
 
    def __init__(self, path, from_kind, to_kind, format):
2451
 
        self.path = path
2452
 
        self.from_kind = from_kind
2453
 
        self.to_kind = to_kind
2454
 
        self.format = format
2455
 
 
2456
 
 
2457
 
class ChangesAlreadyStored(BzrCommandError):
2458
 
 
2459
 
    _fmt = ('Cannot store uncommitted changes because this branch already'
2460
 
            ' stores uncommitted changes.')