/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: 2010-01-25 10:18:24 UTC
  • mto: This revision was merged to the branch mainline in revision 4986.
  • Revision ID: john@arbash-meinel.com-20100125101824-qbamf96fz199iro9
we need to install the latest testtools as well

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)
483
704
 
484
705
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
485
706
 
486
 
    def __init__(self, path, detail=None, controldir=None):
487
 
       from . import urlutils
 
707
    def __init__(self, path, detail=None, bzrdir=None):
 
708
       import bzrlib.urlutils as urlutils
488
709
       path = urlutils.unescape_for_display(path, 'ascii')
489
710
       if detail is not None:
490
711
           detail = ': ' + detail
491
712
       self.detail = detail
492
 
       self.controldir = controldir
 
713
       self.bzrdir = bzrdir
493
714
       PathError.__init__(self, path=path)
494
715
 
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.
 
716
    def _format(self):
 
717
        # XXX: Ideally self.detail would be a property, but Exceptions in
 
718
        # Python 2.4 have to be old-style classes so properties don't work.
 
719
        # Instead we override _format.
500
720
        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__
 
721
            if self.bzrdir is not None:
 
722
                try:
 
723
                    self.bzrdir.open_repository()
 
724
                except NoRepositoryPresent:
 
725
                    self.detail = ''
 
726
                else:
 
727
                    self.detail = ': location is a repository'
519
728
            else:
520
 
                return ': location is a repository'
521
 
        return ''
 
729
                self.detail = ''
 
730
        return PathError._format(self)
522
731
 
523
732
 
524
733
class NoSubmitBranch(PathError):
526
735
    _fmt = 'No submit branch available for branch "%(path)s"'
527
736
 
528
737
    def __init__(self, branch):
529
 
       from . import urlutils
 
738
       import bzrlib.urlutils as urlutils
530
739
       self.path = urlutils.unescape_for_display(branch.base, 'ascii')
531
740
 
532
741
 
533
 
class AlreadyControlDirError(PathError):
534
 
 
535
 
    _fmt = 'A control directory already exists: "%(path)s".'
536
 
 
537
 
 
538
742
class AlreadyBranchError(PathError):
539
743
 
540
744
    _fmt = 'Already a branch: "%(path)s".'
541
745
 
542
746
 
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
747
class BranchExistsWithoutWorkingTree(PathError):
558
748
 
559
749
    _fmt = 'Directory contains a branch, but no working tree \
560
 
(use brz checkout if you wish to build a working tree): "%(path)s"'
 
750
(use bzr checkout if you wish to build a working tree): "%(path)s"'
561
751
 
562
752
 
563
753
class AtomicFileAlreadyClosed(PathError):
583
773
class NoRepositoryPresent(BzrError):
584
774
 
585
775
    _fmt = 'No repository present: "%(path)s"'
586
 
    def __init__(self, controldir):
587
 
        BzrError.__init__(self)
588
 
        self.path = controldir.transport.clone('..').base
 
776
    def __init__(self, bzrdir):
 
777
        BzrError.__init__(self)
 
778
        self.path = bzrdir.transport.clone('..').base
 
779
 
 
780
 
 
781
class FileInWrongBranch(BzrError):
 
782
 
 
783
    _fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
 
784
 
 
785
    def __init__(self, branch, path):
 
786
        BzrError.__init__(self)
 
787
        self.branch = branch
 
788
        self.branch_base = branch.base
 
789
        self.path = path
589
790
 
590
791
 
591
792
class UnsupportedFormatError(BzrError):
592
793
 
593
 
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'brz upgrade'"
 
794
    _fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
594
795
 
595
796
 
596
797
class UnknownFormatError(BzrError):
604
805
 
605
806
class IncompatibleFormat(BzrError):
606
807
 
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
 
808
    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."
 
809
 
 
810
    def __init__(self, format, bzrdir_format):
 
811
        BzrError.__init__(self)
 
812
        self.format = format
 
813
        self.bzrdir = bzrdir_format
625
814
 
626
815
 
627
816
class IncompatibleRepositories(BzrError):
661
850
        """Construct a new AlreadyVersionedError.
662
851
 
663
852
        :param path: This is the path which is versioned,
664
 
            which should be in a user friendly form.
 
853
        which should be in a user friendly form.
665
854
        :param context_info: If given, this is information about the context,
666
 
            which could explain why this is expected to not be versioned.
 
855
        which could explain why this is expected to not be versioned.
667
856
        """
668
857
        BzrError.__init__(self)
669
858
        self.path = path
682
871
        """Construct a new NotVersionedError.
683
872
 
684
873
        :param path: This is the path which is not versioned,
685
 
            which should be in a user friendly form.
 
874
        which should be in a user friendly form.
686
875
        :param context_info: If given, this is information about the context,
687
 
            which could explain why this is expected to be versioned.
 
876
        which could explain why this is expected to be versioned.
688
877
        """
689
878
        BzrError.__init__(self)
690
879
        self.path = path
700
889
    _fmt = "Path(s) are not versioned: %(paths_as_string)s"
701
890
 
702
891
    def __init__(self, paths):
703
 
        from breezy.osutils import quotefn
 
892
        from bzrlib.osutils import quotefn
704
893
        BzrError.__init__(self)
705
894
        self.paths = paths
706
895
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
715
904
 
716
905
    def __init__(self, paths, extra=None):
717
906
        # circular import
718
 
        from breezy.osutils import quotefn
 
907
        from bzrlib.osutils import quotefn
719
908
        BzrError.__init__(self)
720
909
        self.paths = paths
721
910
        self.paths_as_string = ' '.join([quotefn(p) for p in paths])
758
947
    # original exception is available as e.original_error
759
948
    #
760
949
    # New code should prefer to raise specific subclasses
761
 
    def __init__(self, msg):
762
 
        self.msg = msg
 
950
    def __init__(self, message):
 
951
        # Python 2.5 uses a slot for StandardError.message,
 
952
        # so use a different variable name.  We now work around this in
 
953
        # BzrError.__str__, but this member name is kept for compatability.
 
954
        self.msg = message
763
955
 
764
956
 
765
957
class LockActive(LockError):
849
1041
class LockContention(LockError):
850
1042
 
851
1043
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
 
1044
    # TODO: show full url for lock, combining the transport and relative
 
1045
    # bits?
852
1046
 
853
1047
    internal_error = False
854
1048
 
881
1075
        self.target = target
882
1076
 
883
1077
 
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
1078
class LockNotHeld(LockError):
897
1079
 
898
1080
    _fmt = "Lock not held: %(lock)s"
922
1104
        self.lock_token = lock_token
923
1105
 
924
1106
 
 
1107
class PointlessCommit(BzrError):
 
1108
 
 
1109
    _fmt = "No changes to commit"
 
1110
 
 
1111
 
 
1112
class CannotCommitSelectedFileMerge(BzrError):
 
1113
 
 
1114
    _fmt = 'Selected-file commit of merges is not supported yet:'\
 
1115
        ' files %(files_str)s'
 
1116
 
 
1117
    def __init__(self, files):
 
1118
        files_str = ', '.join(files)
 
1119
        BzrError.__init__(self, files=files, files_str=files_str)
 
1120
 
 
1121
 
 
1122
class BadCommitMessageEncoding(BzrError):
 
1123
 
 
1124
    _fmt = 'The specified commit message contains characters unsupported by '\
 
1125
        'the current encoding.'
 
1126
 
 
1127
 
925
1128
class UpgradeReadonly(BzrError):
926
1129
 
927
1130
    _fmt = "Upgrade URL cannot work with readonly URLs."
936
1139
        self.format = format
937
1140
 
938
1141
 
 
1142
class StrictCommitFailed(Exception):
 
1143
 
 
1144
    _fmt = "Commit refused because there are unknowns in the tree."
 
1145
 
 
1146
 
939
1147
class NoSuchRevision(InternalBzrError):
940
1148
 
941
1149
    _fmt = "%(branch)s has no revision %(revision)s"
971
1179
 
972
1180
class InvalidRevisionSpec(BzrError):
973
1181
 
974
 
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
975
 
            " %(branch_url)s%(extra)s")
 
1182
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1183
            " %(branch)s%(extra)s")
976
1184
 
977
1185
    def __init__(self, spec, branch, extra=None):
978
1186
        BzrError.__init__(self, branch=branch, spec=spec)
979
 
        self.branch_url = getattr(branch, 'user_url', str(branch))
980
1187
        if extra:
981
1188
            self.extra = '\n' + str(extra)
982
1189
        else:
983
1190
            self.extra = ''
984
1191
 
985
1192
 
 
1193
class HistoryMissing(BzrError):
 
1194
 
 
1195
    _fmt = "%(branch)s is missing %(object_type)s {%(object_id)s}"
 
1196
 
 
1197
 
986
1198
class AppendRevisionsOnlyViolation(BzrError):
987
1199
 
988
1200
    _fmt = ('Operation denied because it would change the main history,'
990
1202
           ' branch "%(location)s".')
991
1203
 
992
1204
    def __init__(self, location):
993
 
       import breezy.urlutils as urlutils
 
1205
       import bzrlib.urlutils as urlutils
994
1206
       location = urlutils.unescape_for_display(location, 'ascii')
995
1207
       BzrError.__init__(self, location=location)
996
1208
 
1053
1265
            not_ancestor_id=not_ancestor_id)
1054
1266
 
1055
1267
 
 
1268
class AmbiguousBase(BzrError):
 
1269
 
 
1270
    def __init__(self, bases):
 
1271
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1272
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
 
1273
        msg = ("The correct base is unclear, because %s are all equally close"
 
1274
                % ", ".join(bases))
 
1275
        BzrError.__init__(self, msg)
 
1276
        self.bases = bases
 
1277
 
 
1278
 
1056
1279
class NoCommits(BranchError):
1057
1280
 
1058
1281
    _fmt = "Branch %(branch)s has no commits."
1074
1297
class BoundBranchOutOfDate(BzrError):
1075
1298
 
1076
1299
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1077
 
            " %(master)s.%(extra_help)s")
 
1300
            " %(master)s.")
1078
1301
 
1079
1302
    def __init__(self, branch, master):
1080
1303
        BzrError.__init__(self)
1081
1304
        self.branch = branch
1082
1305
        self.master = master
1083
 
        self.extra_help = ''
1084
1306
 
1085
1307
 
1086
1308
class CommitToDoubleBoundBranch(BzrError):
1116
1338
        self.error = error
1117
1339
 
1118
1340
 
 
1341
class WeaveError(BzrError):
 
1342
 
 
1343
    _fmt = "Error in processing weave: %(msg)s"
 
1344
 
 
1345
    def __init__(self, msg=None):
 
1346
        BzrError.__init__(self)
 
1347
        self.msg = msg
 
1348
 
 
1349
 
 
1350
class WeaveRevisionAlreadyPresent(WeaveError):
 
1351
 
 
1352
    _fmt = "Revision {%(revision_id)s} already present in %(weave)s"
 
1353
 
 
1354
    def __init__(self, revision_id, weave):
 
1355
 
 
1356
        WeaveError.__init__(self)
 
1357
        self.revision_id = revision_id
 
1358
        self.weave = weave
 
1359
 
 
1360
 
 
1361
class WeaveRevisionNotPresent(WeaveError):
 
1362
 
 
1363
    _fmt = "Revision {%(revision_id)s} not present in %(weave)s"
 
1364
 
 
1365
    def __init__(self, revision_id, weave):
 
1366
        WeaveError.__init__(self)
 
1367
        self.revision_id = revision_id
 
1368
        self.weave = weave
 
1369
 
 
1370
 
 
1371
class WeaveFormatError(WeaveError):
 
1372
 
 
1373
    _fmt = "Weave invariant violated: %(what)s"
 
1374
 
 
1375
    def __init__(self, what):
 
1376
        WeaveError.__init__(self)
 
1377
        self.what = what
 
1378
 
 
1379
 
 
1380
class WeaveParentMismatch(WeaveError):
 
1381
 
 
1382
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1383
 
 
1384
 
 
1385
class WeaveInvalidChecksum(WeaveError):
 
1386
 
 
1387
    _fmt = "Text did not match it's checksum: %(message)s"
 
1388
 
 
1389
 
 
1390
class WeaveTextDiffers(WeaveError):
 
1391
 
 
1392
    _fmt = ("Weaves differ on text content. Revision:"
 
1393
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1394
 
 
1395
    def __init__(self, revision_id, weave_a, weave_b):
 
1396
        WeaveError.__init__(self)
 
1397
        self.revision_id = revision_id
 
1398
        self.weave_a = weave_a
 
1399
        self.weave_b = weave_b
 
1400
 
 
1401
 
 
1402
class WeaveTextDiffers(WeaveError):
 
1403
 
 
1404
    _fmt = ("Weaves differ on text content. Revision:"
 
1405
            " {%(revision_id)s}, %(weave_a)s, %(weave_b)s")
 
1406
 
 
1407
    def __init__(self, revision_id, weave_a, weave_b):
 
1408
        WeaveError.__init__(self)
 
1409
        self.revision_id = revision_id
 
1410
        self.weave_a = weave_a
 
1411
        self.weave_b = weave_b
 
1412
 
 
1413
 
1119
1414
class VersionedFileError(BzrError):
1120
1415
 
1121
1416
    _fmt = "Versioned file error"
1143
1438
 
1144
1439
class VersionedFileInvalidChecksum(VersionedFileError):
1145
1440
 
1146
 
    _fmt = "Text did not match its checksum: %(msg)s"
 
1441
    _fmt = "Text did not match its checksum: %(message)s"
 
1442
 
 
1443
 
 
1444
class KnitError(InternalBzrError):
 
1445
 
 
1446
    _fmt = "Knit error"
 
1447
 
 
1448
 
 
1449
class KnitCorrupt(KnitError):
 
1450
 
 
1451
    _fmt = "Knit %(filename)s corrupt: %(how)s"
 
1452
 
 
1453
    def __init__(self, filename, how):
 
1454
        KnitError.__init__(self)
 
1455
        self.filename = filename
 
1456
        self.how = how
 
1457
 
 
1458
 
 
1459
class SHA1KnitCorrupt(KnitCorrupt):
 
1460
 
 
1461
    _fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
 
1462
        "match expected sha-1. key %(key)s expected sha %(expected)s actual "
 
1463
        "sha %(actual)s")
 
1464
 
 
1465
    def __init__(self, filename, actual, expected, key, content):
 
1466
        KnitError.__init__(self)
 
1467
        self.filename = filename
 
1468
        self.actual = actual
 
1469
        self.expected = expected
 
1470
        self.key = key
 
1471
        self.content = content
 
1472
 
 
1473
 
 
1474
class KnitDataStreamIncompatible(KnitError):
 
1475
    # Not raised anymore, as we can convert data streams.  In future we may
 
1476
    # need it again for more exotic cases, so we're keeping it around for now.
 
1477
 
 
1478
    _fmt = "Cannot insert knit data stream of format \"%(stream_format)s\" into knit of format \"%(target_format)s\"."
 
1479
 
 
1480
    def __init__(self, stream_format, target_format):
 
1481
        self.stream_format = stream_format
 
1482
        self.target_format = target_format
 
1483
 
 
1484
 
 
1485
class KnitDataStreamUnknown(KnitError):
 
1486
    # Indicates a data stream we don't know how to handle.
 
1487
 
 
1488
    _fmt = "Cannot parse knit data stream of format \"%(stream_format)s\"."
 
1489
 
 
1490
    def __init__(self, stream_format):
 
1491
        self.stream_format = stream_format
 
1492
 
 
1493
 
 
1494
class KnitHeaderError(KnitError):
 
1495
 
 
1496
    _fmt = 'Knit header error: %(badline)r unexpected for file "%(filename)s".'
 
1497
 
 
1498
    def __init__(self, badline, filename):
 
1499
        KnitError.__init__(self)
 
1500
        self.badline = badline
 
1501
        self.filename = filename
 
1502
 
 
1503
class KnitIndexUnknownMethod(KnitError):
 
1504
    """Raised when we don't understand the storage method.
 
1505
 
 
1506
    Currently only 'fulltext' and 'line-delta' are supported.
 
1507
    """
 
1508
 
 
1509
    _fmt = ("Knit index %(filename)s does not have a known method"
 
1510
            " in options: %(options)r")
 
1511
 
 
1512
    def __init__(self, filename, options):
 
1513
        KnitError.__init__(self)
 
1514
        self.filename = filename
 
1515
        self.options = options
1147
1516
 
1148
1517
 
1149
1518
class RetryWithNewPacks(BzrError):
1171
1540
            problem we can raise the original error (value from sys.exc_info())
1172
1541
        """
1173
1542
        BzrError.__init__(self)
1174
 
        self.context = context
1175
1543
        self.reload_occurred = reload_occurred
1176
1544
        self.exc_info = exc_info
1177
1545
        self.orig_error = exc_info[1]
1259
1627
 
1260
1628
    def __init__(self, exc_info):
1261
1629
        import traceback
1262
 
        # GZ 2010-08-10: Cycle with exc_tb/exc_info affects at least one test
1263
1630
        self.exc_type, self.exc_value, self.exc_tb = exc_info
1264
1631
        self.exc_info = exc_info
1265
1632
        traceback_strings = traceback.format_exception(
1304
1671
    _fmt = "Connection closed: %(msg)s %(orig_error)s"
1305
1672
 
1306
1673
 
1307
 
class ConnectionTimeout(ConnectionError):
1308
 
 
1309
 
    _fmt = "Connection Timeout: %(msg)s%(orig_error)s"
1310
 
 
1311
 
 
1312
1674
class InvalidRange(TransportError):
1313
1675
 
1314
1676
    _fmt = "Invalid range access in %(path)s at %(offset)s: %(msg)s"
1321
1683
 
1322
1684
class InvalidHttpResponse(TransportError):
1323
1685
 
1324
 
    _fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
 
1686
    _fmt = "Invalid http response for %(path)s: %(msg)s"
1325
1687
 
1326
1688
    def __init__(self, path, msg, orig_error=None):
1327
1689
        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
1690
        TransportError.__init__(self, msg, orig_error=orig_error)
1335
1691
 
1336
1692
 
1343
1699
        InvalidHttpResponse.__init__(self, path, msg)
1344
1700
 
1345
1701
 
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
1702
class InvalidHttpContentType(InvalidHttpResponse):
1360
1703
 
1361
1704
    _fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1389
1732
    _fmt = "Working tree has conflicts."
1390
1733
 
1391
1734
 
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)
 
1735
class ParseConfigError(BzrError):
 
1736
 
 
1737
    def __init__(self, errors, filename):
 
1738
        if filename is None:
 
1739
            filename = ""
 
1740
        message = "Error(s) parsing config file %s:\n%s" % \
 
1741
            (filename, ('\n'.join(e.msg for e in errors)))
 
1742
        BzrError.__init__(self, message)
 
1743
 
 
1744
 
 
1745
class NoEmailInUsername(BzrError):
 
1746
 
 
1747
    _fmt = "%(username)r does not seem to contain a reasonable email address"
 
1748
 
 
1749
    def __init__(self, username):
 
1750
        BzrError.__init__(self)
 
1751
        self.username = username
 
1752
 
 
1753
 
 
1754
class SigningFailed(BzrError):
 
1755
 
 
1756
    _fmt = 'Failed to gpg sign data with command "%(command_line)s"'
 
1757
 
 
1758
    def __init__(self, command_line):
 
1759
        BzrError.__init__(self, command_line=command_line)
1398
1760
 
1399
1761
 
1400
1762
class WorkingTreeNotRevision(BzrError):
1518
1880
        self.prefix = prefix
1519
1881
 
1520
1882
 
1521
 
class MalformedTransform(InternalBzrError):
 
1883
class MalformedTransform(BzrError):
1522
1884
 
1523
1885
    _fmt = "Tree transform is malformed %(conflicts)r"
1524
1886
 
1562
1924
    _fmt = "Moving the root directory is not supported at this time"
1563
1925
 
1564
1926
 
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
1927
class BzrMoveFailedError(BzrError):
1577
1928
 
1578
 
    _fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
1579
 
        "%(_has_extra)s%(extra)s")
 
1929
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1580
1930
 
1581
1931
    def __init__(self, from_path='', to_path='', extra=None):
1582
 
        from breezy.osutils import splitpath
 
1932
        from bzrlib.osutils import splitpath
1583
1933
        BzrError.__init__(self)
1584
1934
        if extra:
1585
 
            self.extra, self._has_extra = extra, ': '
 
1935
            self.extra = ': ' + str(extra)
1586
1936
        else:
1587
 
            self.extra = self._has_extra = ''
 
1937
            self.extra = ''
1588
1938
 
1589
1939
        has_from = len(from_path) > 0
1590
1940
        has_to = len(to_path) > 0
1611
1961
 
1612
1962
class BzrRenameFailedError(BzrMoveFailedError):
1613
1963
 
1614
 
    _fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
1615
 
        "%(_has_extra)s%(extra)s")
 
1964
    _fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
1616
1965
 
1617
1966
    def __init__(self, from_path, to_path, extra=None):
1618
1967
        BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1619
1968
 
 
1969
class BzrRemoveChangedFilesError(BzrError):
 
1970
    """Used when user is trying to remove changed files."""
 
1971
 
 
1972
    _fmt = ("Can't safely remove modified or unknown files:\n"
 
1973
        "%(changes_as_text)s"
 
1974
        "Use --keep to not delete them, or --force to delete them regardless.")
 
1975
 
 
1976
    def __init__(self, tree_delta):
 
1977
        BzrError.__init__(self)
 
1978
        self.changes_as_text = tree_delta.get_changes_as_text()
 
1979
        #self.paths_as_string = '\n'.join(changed_files)
 
1980
        #self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
 
1981
 
1620
1982
 
1621
1983
class BzrBadParameterNotString(BzrBadParameter):
1622
1984
 
1625
1987
 
1626
1988
class BzrBadParameterMissing(BzrBadParameter):
1627
1989
 
1628
 
    _fmt = "Parameter %(param)s is required but not present."
 
1990
    _fmt = "Parameter $(param)s is required but not present."
1629
1991
 
1630
1992
 
1631
1993
class BzrBadParameterUnicode(BzrBadParameter):
1639
2001
    _fmt = "Parameter %(param)s contains a newline."
1640
2002
 
1641
2003
 
 
2004
class DependencyNotPresent(BzrError):
 
2005
 
 
2006
    _fmt = 'Unable to import library "%(library)s": %(error)s'
 
2007
 
 
2008
    def __init__(self, library, error):
 
2009
        BzrError.__init__(self, library=library, error=error)
 
2010
 
 
2011
 
1642
2012
class ParamikoNotPresent(DependencyNotPresent):
1643
2013
 
1644
2014
    _fmt = "Unable to import paramiko (required for sftp support): %(error)s"
1654
2024
 
1655
2025
class UninitializableFormat(BzrError):
1656
2026
 
1657
 
    _fmt = "Format %(format)s cannot be initialised by this version of brz."
 
2027
    _fmt = "Format %(format)s cannot be initialised by this version of bzr."
1658
2028
 
1659
2029
    def __init__(self, format):
1660
2030
        BzrError.__init__(self)
1703
2073
 
1704
2074
 
1705
2075
class ExistingContent(BzrError):
1706
 
    # Added in breezy 0.92, used by VersionedFile.add_lines.
 
2076
    # Added in bzrlib 0.92, used by VersionedFile.add_lines.
1707
2077
 
1708
2078
    _fmt = "The content being inserted is already present."
1709
2079
 
1752
2122
 
1753
2123
class OutOfDateTree(BzrError):
1754
2124
 
1755
 
    _fmt = "Working tree is out of date, please run 'brz update'.%(more)s"
 
2125
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
1756
2126
 
1757
2127
    def __init__(self, tree, more=None):
1758
2128
        if more is None:
1770
2140
        '"%(revstring)s".'
1771
2141
 
1772
2142
    def __init__(self, public_location, revstring):
1773
 
        import breezy.urlutils as urlutils
 
2143
        import bzrlib.urlutils as urlutils
1774
2144
        public_location = urlutils.unescape_for_display(public_location,
1775
2145
                                                        'ascii')
1776
2146
        BzrError.__init__(self, public_location=public_location,
1787
2157
    _fmt = "Format error in conflict listings"
1788
2158
 
1789
2159
 
 
2160
class CorruptDirstate(BzrError):
 
2161
 
 
2162
    _fmt = ("Inconsistency in dirstate file %(dirstate_path)s.\n"
 
2163
            "Error: %(description)s")
 
2164
 
 
2165
    def __init__(self, dirstate_path, description):
 
2166
        BzrError.__init__(self)
 
2167
        self.dirstate_path = dirstate_path
 
2168
        self.description = description
 
2169
 
 
2170
 
1790
2171
class CorruptRepository(BzrError):
1791
2172
 
1792
2173
    _fmt = ("An error has been detected in the repository %(repo_path)s.\n"
1793
 
            "Please run brz reconcile on this repository.")
 
2174
            "Please run bzr reconcile on this repository.")
1794
2175
 
1795
2176
    def __init__(self, repo):
1796
2177
        BzrError.__init__(self)
1797
 
        self.repo_path = repo.user_url
 
2178
        self.repo_path = repo.bzrdir.root_transport.base
1798
2179
 
1799
2180
 
1800
2181
class InconsistentDelta(BzrError):
1858
2239
        self.tname = type(method_self).__name__
1859
2240
 
1860
2241
 
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)
 
2242
class CannotSetRevisionId(UnsupportedOperation):
 
2243
    """Raised when a commit is attempting to set a revision id but cant."""
1867
2244
 
1868
2245
 
1869
2246
class NonAsciiRevisionId(UnsupportedOperation):
1872
2249
    """
1873
2250
 
1874
2251
 
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
2252
class BinaryFile(BzrError):
1884
2253
 
1885
2254
    _fmt = "File is binary but should be text."
1987
2356
 
1988
2357
class UnknownSSH(BzrError):
1989
2358
 
1990
 
    _fmt = "Unrecognised value for BRZ_SSH environment variable: %(vendor)s"
 
2359
    _fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
1991
2360
 
1992
2361
    def __init__(self, vendor):
1993
2362
        BzrError.__init__(self)
1997
2366
class SSHVendorNotFound(BzrError):
1998
2367
 
1999
2368
    _fmt = ("Don't know how to handle SSH connections."
2000
 
            " Please set BRZ_SSH environment variable.")
 
2369
            " Please set BZR_SSH environment variable.")
2001
2370
 
2002
2371
 
2003
2372
class GhostRevisionsHaveNoRevno(BzrError):
2133
2502
        self.other_tree = other_tree
2134
2503
 
2135
2504
 
 
2505
class BadReferenceTarget(InternalBzrError):
 
2506
 
 
2507
    _fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
 
2508
           "%(reason)s"
 
2509
 
 
2510
    def __init__(self, tree, other_tree, reason):
 
2511
        self.tree = tree
 
2512
        self.other_tree = other_tree
 
2513
        self.reason = reason
 
2514
 
 
2515
 
2136
2516
class NoSuchTag(BzrError):
2137
2517
 
2138
2518
    _fmt = "No such tag: %(tag_name)s"
2144
2524
class TagsNotSupported(BzrError):
2145
2525
 
2146
2526
    _fmt = ("Tags not supported by %(branch)s;"
2147
 
            " you may be able to use brz upgrade.")
 
2527
            " you may be able to use bzr upgrade.")
2148
2528
 
2149
2529
    def __init__(self, branch):
2150
2530
        self.branch = branch
2158
2538
        self.tag_name = tag_name
2159
2539
 
2160
2540
 
 
2541
class MalformedBugIdentifier(BzrError):
 
2542
 
 
2543
    _fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
 
2544
            'See "bzr help bugs" for more information on this feature.')
 
2545
 
 
2546
    def __init__(self, bug_id, reason):
 
2547
        self.bug_id = bug_id
 
2548
        self.reason = reason
 
2549
 
 
2550
 
 
2551
class InvalidBugTrackerURL(BzrError):
 
2552
 
 
2553
    _fmt = ("The URL for bug tracker \"%(abbreviation)s\" doesn't "
 
2554
            "contain {id}: %(url)s")
 
2555
 
 
2556
    def __init__(self, abbreviation, url):
 
2557
        self.abbreviation = abbreviation
 
2558
        self.url = url
 
2559
 
 
2560
 
 
2561
class UnknownBugTrackerAbbreviation(BzrError):
 
2562
 
 
2563
    _fmt = ("Cannot find registered bug tracker called %(abbreviation)s "
 
2564
            "on %(branch)s")
 
2565
 
 
2566
    def __init__(self, abbreviation, branch):
 
2567
        self.abbreviation = abbreviation
 
2568
        self.branch = branch
 
2569
 
 
2570
 
 
2571
class InvalidLineInBugsProperty(BzrError):
 
2572
 
 
2573
    _fmt = ("Invalid line in bugs property: '%(line)s'")
 
2574
 
 
2575
    def __init__(self, line):
 
2576
        self.line = line
 
2577
 
 
2578
 
 
2579
class InvalidBugStatus(BzrError):
 
2580
 
 
2581
    _fmt = ("Invalid bug status: '%(status)s'")
 
2582
 
 
2583
    def __init__(self, status):
 
2584
        self.status = status
 
2585
 
 
2586
 
2161
2587
class UnexpectedSmartServerResponse(BzrError):
2162
2588
 
2163
2589
    _fmt = "Could not understand response from smart server: %(response_tuple)r"
2186
2612
 
2187
2613
 
2188
2614
class UnknownErrorFromSmartServer(BzrError):
2189
 
    """An ErrorFromSmartServer could not be translated into a typical breezy
 
2615
    """An ErrorFromSmartServer could not be translated into a typical bzrlib
2190
2616
    error.
2191
2617
 
2192
2618
    This is distinct from ErrorFromSmartServer so that it is possible to
2193
2619
    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.
 
2620
      - ErrorFromSmartServer was uncaught.  This is logic error in the client
 
2621
        and so should provoke a traceback to the user.
 
2622
      - ErrorFromSmartServer was caught but its error_tuple could not be
 
2623
        translated.  This is probably because the server sent us garbage, and
 
2624
        should not provoke a traceback.
2200
2625
    """
2201
2626
 
2202
2627
    _fmt = "Server sent an unexpected error: %(error_tuple)r"
2258
2683
    _fmt = "Container has multiple records with the same name: %(name)s"
2259
2684
 
2260
2685
    def __init__(self, name):
2261
 
        self.name = name.decode("utf-8")
 
2686
        self.name = name
 
2687
 
 
2688
 
 
2689
class NoDestinationAddress(InternalBzrError):
 
2690
 
 
2691
    _fmt = "Message does not have a destination address."
2262
2692
 
2263
2693
 
2264
2694
class RepositoryDataStreamError(BzrError):
2269
2699
        self.reason = reason
2270
2700
 
2271
2701
 
 
2702
class SMTPError(BzrError):
 
2703
 
 
2704
    _fmt = "SMTP error: %(error)s"
 
2705
 
 
2706
    def __init__(self, error):
 
2707
        self.error = error
 
2708
 
 
2709
 
 
2710
class NoMessageSupplied(BzrError):
 
2711
 
 
2712
    _fmt = "No message supplied."
 
2713
 
 
2714
 
 
2715
class NoMailAddressSpecified(BzrError):
 
2716
 
 
2717
    _fmt = "No mail-to address (--mail-to) or output (-o) specified."
 
2718
 
 
2719
 
 
2720
class UnknownMailClient(BzrError):
 
2721
 
 
2722
    _fmt = "Unknown mail client: %(mail_client)s"
 
2723
 
 
2724
    def __init__(self, mail_client):
 
2725
        BzrError.__init__(self, mail_client=mail_client)
 
2726
 
 
2727
 
 
2728
class MailClientNotFound(BzrError):
 
2729
 
 
2730
    _fmt = "Unable to find mail client with the following names:"\
 
2731
        " %(mail_command_list_string)s"
 
2732
 
 
2733
    def __init__(self, mail_command_list):
 
2734
        mail_command_list_string = ', '.join(mail_command_list)
 
2735
        BzrError.__init__(self, mail_command_list=mail_command_list,
 
2736
                          mail_command_list_string=mail_command_list_string)
 
2737
 
 
2738
class SMTPConnectionRefused(SMTPError):
 
2739
 
 
2740
    _fmt = "SMTP connection to %(host)s refused"
 
2741
 
 
2742
    def __init__(self, error, host):
 
2743
        self.error = error
 
2744
        self.host = host
 
2745
 
 
2746
 
 
2747
class DefaultSMTPConnectionRefused(SMTPConnectionRefused):
 
2748
 
 
2749
    _fmt = "Please specify smtp_server.  No server at default %(host)s."
 
2750
 
 
2751
 
 
2752
class BzrDirError(BzrError):
 
2753
 
 
2754
    def __init__(self, bzrdir):
 
2755
        import bzrlib.urlutils as urlutils
 
2756
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2757
                                                    'ascii')
 
2758
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
 
2759
 
 
2760
 
 
2761
class UnsyncedBranches(BzrDirError):
 
2762
 
 
2763
    _fmt = ("'%(display_url)s' is not in sync with %(target_url)s.  See"
 
2764
            " bzr help sync-for-reconfigure.")
 
2765
 
 
2766
    def __init__(self, bzrdir, target_branch):
 
2767
        BzrDirError.__init__(self, bzrdir)
 
2768
        import bzrlib.urlutils as urlutils
 
2769
        self.target_url = urlutils.unescape_for_display(target_branch.base,
 
2770
                                                        'ascii')
 
2771
 
 
2772
 
 
2773
class AlreadyBranch(BzrDirError):
 
2774
 
 
2775
    _fmt = "'%(display_url)s' is already a branch."
 
2776
 
 
2777
 
 
2778
class AlreadyTree(BzrDirError):
 
2779
 
 
2780
    _fmt = "'%(display_url)s' is already a tree."
 
2781
 
 
2782
 
 
2783
class AlreadyCheckout(BzrDirError):
 
2784
 
 
2785
    _fmt = "'%(display_url)s' is already a checkout."
 
2786
 
 
2787
 
 
2788
class AlreadyLightweightCheckout(BzrDirError):
 
2789
 
 
2790
    _fmt = "'%(display_url)s' is already a lightweight checkout."
 
2791
 
 
2792
 
 
2793
class AlreadyUsingShared(BzrDirError):
 
2794
 
 
2795
    _fmt = "'%(display_url)s' is already using a shared repository."
 
2796
 
 
2797
 
 
2798
class AlreadyStandalone(BzrDirError):
 
2799
 
 
2800
    _fmt = "'%(display_url)s' is already standalone."
 
2801
 
 
2802
 
 
2803
class AlreadyWithTrees(BzrDirError):
 
2804
 
 
2805
    _fmt = ("Shared repository '%(display_url)s' already creates "
 
2806
            "working trees.")
 
2807
 
 
2808
 
 
2809
class AlreadyWithNoTrees(BzrDirError):
 
2810
 
 
2811
    _fmt = ("Shared repository '%(display_url)s' already doesn't create "
 
2812
            "working trees.")
 
2813
 
 
2814
 
 
2815
class ReconfigurationNotSupported(BzrDirError):
 
2816
 
 
2817
    _fmt = "Requested reconfiguration of '%(display_url)s' is not supported."
 
2818
 
 
2819
 
 
2820
class NoBindLocation(BzrDirError):
 
2821
 
 
2822
    _fmt = "No location could be found to bind to at %(display_url)s."
 
2823
 
 
2824
 
2272
2825
class UncommittedChanges(BzrError):
2273
2826
 
2274
2827
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2275
 
            ' (See brz status).%(more)s')
 
2828
            ' (See bzr status).%(more)s')
2276
2829
 
2277
2830
    def __init__(self, tree, more=None):
2278
2831
        if more is None:
2279
2832
            more = ''
2280
2833
        else:
2281
2834
            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')
 
2835
        import bzrlib.urlutils as urlutils
 
2836
        display_url = urlutils.unescape_for_display(
 
2837
            tree.bzrdir.root_transport.base, 'ascii')
2288
2838
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2289
2839
 
2290
2840
 
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')
 
2841
class MissingTemplateVariable(BzrError):
 
2842
 
 
2843
    _fmt = 'Variable {%(name)s} is not available.'
 
2844
 
 
2845
    def __init__(self, name):
 
2846
        self.name = name
 
2847
 
 
2848
 
 
2849
class NoTemplate(BzrError):
 
2850
 
 
2851
    _fmt = 'No template specified.'
2310
2852
 
2311
2853
 
2312
2854
class UnableCreateSymlink(BzrError):
2324
2866
        self.path_str = path_str
2325
2867
 
2326
2868
 
 
2869
class UnsupportedTimezoneFormat(BzrError):
 
2870
 
 
2871
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
2872
            'options are "utc", "original", "local".')
 
2873
 
 
2874
    def __init__(self, timezone):
 
2875
        self.timezone = timezone
 
2876
 
 
2877
 
 
2878
class CommandAvailableInPlugin(StandardError):
 
2879
 
 
2880
    internal_error = False
 
2881
 
 
2882
    def __init__(self, cmd_name, plugin_metadata, provider):
 
2883
 
 
2884
        self.plugin_metadata = plugin_metadata
 
2885
        self.cmd_name = cmd_name
 
2886
        self.provider = provider
 
2887
 
 
2888
    def __str__(self):
 
2889
 
 
2890
        _fmt = ('"%s" is not a standard bzr command. \n'
 
2891
                'However, the following official plugin provides this command: %s\n'
 
2892
                'You can install it by going to: %s'
 
2893
                % (self.cmd_name, self.plugin_metadata['name'],
 
2894
                    self.plugin_metadata['url']))
 
2895
 
 
2896
        return _fmt
 
2897
 
 
2898
 
 
2899
class NoPluginAvailable(BzrError):
 
2900
    pass
 
2901
 
 
2902
 
2327
2903
class UnableEncodePath(BzrError):
2328
2904
 
2329
2905
    _fmt = ('Unable to encode %(kind)s path %(path)r in '
2330
2906
            'user encoding %(user_encoding)s')
2331
2907
 
2332
2908
    def __init__(self, path, kind):
2333
 
        from breezy.osutils import get_user_encoding
 
2909
        from bzrlib.osutils import get_user_encoding
2334
2910
        self.path = path
2335
2911
        self.kind = kind
2336
 
        self.user_encoding = get_user_encoding()
 
2912
        self.user_encoding = osutils.get_user_encoding()
2337
2913
 
2338
2914
 
2339
2915
class NoSuchAlias(BzrError):
2344
2920
        BzrError.__init__(self, alias_name=alias_name)
2345
2921
 
2346
2922
 
 
2923
class DirectoryLookupFailure(BzrError):
 
2924
    """Base type for lookup errors."""
 
2925
 
 
2926
    pass
 
2927
 
 
2928
 
 
2929
class InvalidLocationAlias(DirectoryLookupFailure):
 
2930
 
 
2931
    _fmt = '"%(alias_name)s" is not a valid location alias.'
 
2932
 
 
2933
    def __init__(self, alias_name):
 
2934
        DirectoryLookupFailure.__init__(self, alias_name=alias_name)
 
2935
 
 
2936
 
 
2937
class UnsetLocationAlias(DirectoryLookupFailure):
 
2938
 
 
2939
    _fmt = 'No %(alias_name)s location assigned.'
 
2940
 
 
2941
    def __init__(self, alias_name):
 
2942
        DirectoryLookupFailure.__init__(self, alias_name=alias_name[1:])
 
2943
 
 
2944
 
2347
2945
class CannotBindAddress(BzrError):
2348
2946
 
2349
2947
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2354
2952
            orig_error=repr(orig_error.args))
2355
2953
 
2356
2954
 
 
2955
class UnknownRules(BzrError):
 
2956
 
 
2957
    _fmt = ('Unknown rules detected: %(unknowns_str)s.')
 
2958
 
 
2959
    def __init__(self, unknowns):
 
2960
        BzrError.__init__(self, unknowns_str=", ".join(unknowns))
 
2961
 
 
2962
 
 
2963
class HookFailed(BzrError):
 
2964
    """Raised when a pre_change_branch_tip hook function fails anything other
 
2965
    than TipChangeRejected.
 
2966
 
 
2967
    Note that this exception is no longer raised, and the import is only left
 
2968
    to be nice to code which might catch it in a plugin.
 
2969
    """
 
2970
 
 
2971
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
 
2972
            "%(traceback_text)s%(exc_value)s")
 
2973
 
 
2974
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
 
2975
        if warn:
 
2976
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
 
2977
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
 
2978
        import traceback
 
2979
        self.hook_stage = hook_stage
 
2980
        self.hook_name = hook_name
 
2981
        self.exc_info = exc_info
 
2982
        self.exc_type = exc_info[0]
 
2983
        self.exc_value = exc_info[1]
 
2984
        self.exc_tb = exc_info[2]
 
2985
        self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
 
2986
 
 
2987
 
2357
2988
class TipChangeRejected(BzrError):
2358
2989
    """A pre_change_branch_tip hook function may raise this to cleanly and
2359
2990
    explicitly abort a change to a branch tip.
2365
2996
        self.msg = msg
2366
2997
 
2367
2998
 
 
2999
class ShelfCorrupt(BzrError):
 
3000
 
 
3001
    _fmt = "Shelf corrupt."
 
3002
 
 
3003
 
 
3004
class NoSuchShelfId(BzrError):
 
3005
 
 
3006
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
 
3007
 
 
3008
    def __init__(self, shelf_id):
 
3009
        BzrError.__init__(self, shelf_id=shelf_id)
 
3010
 
 
3011
 
 
3012
class InvalidShelfId(BzrError):
 
3013
 
 
3014
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
 
3015
 
 
3016
    def __init__(self, invalid_id):
 
3017
        BzrError.__init__(self, invalid_id=invalid_id)
 
3018
 
 
3019
 
2368
3020
class JailBreak(BzrError):
2369
3021
 
2370
3022
    _fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
2378
3030
    _fmt = 'The user aborted the operation.'
2379
3031
 
2380
3032
 
 
3033
class MustHaveWorkingTree(BzrError):
 
3034
 
 
3035
    _fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
 
3036
 
 
3037
    def __init__(self, format, url):
 
3038
        BzrError.__init__(self, format=format, url=url)
 
3039
 
 
3040
 
 
3041
class NoSuchView(BzrError):
 
3042
    """A view does not exist.
 
3043
    """
 
3044
 
 
3045
    _fmt = u"No such view: %(view_name)s."
 
3046
 
 
3047
    def __init__(self, view_name):
 
3048
        self.view_name = view_name
 
3049
 
 
3050
 
 
3051
class ViewsNotSupported(BzrError):
 
3052
    """Views are not supported by a tree format.
 
3053
    """
 
3054
 
 
3055
    _fmt = ("Views are not supported by %(tree)s;"
 
3056
            " use 'bzr upgrade' to change your tree to a later format.")
 
3057
 
 
3058
    def __init__(self, tree):
 
3059
        self.tree = tree
 
3060
 
 
3061
 
 
3062
class FileOutsideView(BzrError):
 
3063
 
 
3064
    _fmt = ('Specified file "%(file_name)s" is outside the current view: '
 
3065
            '%(view_str)s')
 
3066
 
 
3067
    def __init__(self, file_name, view_files):
 
3068
        self.file_name = file_name
 
3069
        self.view_str = ", ".join(view_files)
 
3070
 
 
3071
 
2381
3072
class UnresumableWriteGroup(BzrError):
2382
3073
 
2383
3074
    _fmt = ("Repository %(repository)s cannot resume write group "
2425
3116
        self.target_branch = target_branch
2426
3117
 
2427
3118
 
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):
 
3119
class FileTimestampUnavailable(BzrError):
 
3120
 
 
3121
    _fmt = "The filestamp for %(path)s is not available."
 
3122
 
 
3123
    internal_error = True
 
3124
 
 
3125
    def __init__(self, path):
2451
3126
        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.')