43
54
Base class for errors raised by bzrlib.
45
56
:cvar internal_error: if True this was probably caused by a bzr bug and
46
should be displayed with a traceback; if False (or absent) this was
47
probably a user or environment error and they don't need the gory
48
details. (That can be overridden by -Derror on the command line.)
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.)
50
61
:cvar _fmt: Format string to display the error; this is expanded
51
by the instance's dict.
62
by the instance's dict.
54
65
internal_error = False
95
106
# __str__() should always return a 'str' object
96
107
# never a 'unicode' object.
99
pass # just bind to 'e' for formatting below
102
return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
103
% (self.__class__.__name__,
105
getattr(self, '_fmt', None),
109
except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
110
return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
111
% (self.__class__.__name__,
113
getattr(self, '_fmt', None),
108
116
def __unicode__(self):
109
117
u = self._format()
132
140
"""Return format string for this exception or None"""
133
141
fmt = getattr(self, '_fmt', None)
134
142
if fmt is not None:
135
from bzrlib.i18n import gettext
136
return gettext(unicode(fmt)) # _fmt strings should be ascii
144
fmt = getattr(self, '__doc__', None)
146
symbol_versioning.warn("%s uses its docstring as a format, "
147
"it should use _fmt instead" % self.__class__.__name__,
150
return 'Unprintable exception %s: dict=%r, fmt=%r' \
151
% (self.__class__.__name__,
153
getattr(self, '_fmt', None),
138
156
def __eq__(self, other):
139
157
if self.__class__ is not other.__class__:
152
170
internal_error = True
173
class BzrNewError(BzrError):
174
"""Deprecated error base class."""
175
# base classes should override the docstring with their human-
176
# readable explanation
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).
183
symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '
184
'please convert %s to use BzrError instead'
185
% self.__class__.__name__,
188
BzrError.__init__(self, *args)
189
for key, value in kwds.items():
190
setattr(self, key, value)
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')
200
except (TypeError, NameError, ValueError, KeyError), e:
201
return 'Unprintable exception %s(%r): %r' \
202
% (self.__class__.__name__,
155
206
class AlreadyBuilding(BzrError):
157
208
_fmt = "The tree builder is already building a tree."
700
751
self.path = urlutils.unescape_for_display(branch.base, 'ascii')
703
class AlreadyControlDirError(PathError):
705
_fmt = 'A control directory already exists: "%(path)s".'
708
754
class AlreadyBranchError(PathError):
710
756
_fmt = 'Already a branch: "%(path)s".'
713
class InvalidBranchName(PathError):
715
_fmt = "Invalid branch name: %(name)s"
717
def __init__(self, name):
718
BzrError.__init__(self)
722
class ParentBranchExists(AlreadyBranchError):
724
_fmt = 'Parent branch already exists: "%(path)s".'
727
759
class BranchExistsWithoutWorkingTree(PathError):
729
761
_fmt = 'Directory contains a branch, but no working tree \
758
790
self.path = bzrdir.transport.clone('..').base
793
class FileInWrongBranch(BzrError):
795
_fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
797
# use PathNotChild instead
798
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 3, 0)))
799
def __init__(self, branch, path):
800
BzrError.__init__(self)
802
self.branch_base = branch.base
761
806
class UnsupportedFormatError(BzrError):
763
808
_fmt = "Unsupported branch format: %(format)s\nPlease run 'bzr upgrade'"
1258
1296
not_ancestor_id=not_ancestor_id)
1299
class AmbiguousBase(BzrError):
1301
def __init__(self, bases):
1302
symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1303
"as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1304
msg = ("The correct base is unclear, because %s are all equally close"
1306
BzrError.__init__(self, msg)
1261
1310
class NoCommits(BranchError):
1263
1312
_fmt = "Branch %(branch)s has no commits."
1674
1716
class InvalidHttpResponse(TransportError):
1676
_fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1718
_fmt = "Invalid http response for %(path)s: %(msg)s"
1678
1720
def __init__(self, path, msg, orig_error=None):
1679
1721
self.path = path
1680
if orig_error is None:
1683
# This is reached for obscure and unusual errors so we want to
1684
# preserve as much info as possible to ease debug.
1685
orig_error = ': %r' % (orig_error,)
1686
1722
TransportError.__init__(self, msg, orig_error=orig_error)
1695
1731
InvalidHttpResponse.__init__(self, path, msg)
1698
class HttpBoundaryMissing(InvalidHttpResponse):
1699
"""A multipart response ends with no boundary marker.
1701
This is a special case caused by buggy proxies, described in
1702
<https://bugs.launchpad.net/bzr/+bug/198646>.
1705
_fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
1707
def __init__(self, path, msg):
1708
InvalidHttpResponse.__init__(self, path, msg)
1711
1734
class InvalidHttpContentType(InvalidHttpResponse):
1713
1736
_fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1741
1764
_fmt = "Working tree has conflicts."
1744
class ConfigContentError(BzrError):
1746
_fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1748
def __init__(self, filename):
1749
BzrError.__init__(self)
1750
self.filename = filename
1753
1767
class ParseConfigError(BzrError):
1755
_fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1757
1769
def __init__(self, errors, filename):
1758
BzrError.__init__(self)
1759
self.filename = filename
1760
self.errors = '\n'.join(e.msg for e in errors)
1763
class ConfigOptionValueError(BzrError):
1765
_fmt = ('Bad value "%(value)s" for option "%(name)s".\n'
1766
'See ``bzr help %(name)s``')
1768
def __init__(self, name, value):
1769
BzrError.__init__(self, name=name, value=value)
1770
if filename is None:
1772
message = "Error(s) parsing config file %s:\n%s" % \
1773
(filename, ('\n'.join(e.msg for e in errors)))
1774
BzrError.__init__(self, message)
1772
1777
class NoEmailInUsername(BzrError):
1781
1786
class SigningFailed(BzrError):
1783
_fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1788
_fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1785
1790
def __init__(self, command_line):
1786
1791
BzrError.__init__(self, command_line=command_line)
1789
class SignatureVerificationFailed(BzrError):
1791
_fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1793
def __init__(self, error):
1794
BzrError.__init__(self, error=error)
1797
class DependencyNotPresent(BzrError):
1799
_fmt = 'Unable to import library "%(library)s": %(error)s'
1801
def __init__(self, library, error):
1802
BzrError.__init__(self, library=library, error=error)
1805
class GpgmeNotInstalled(DependencyNotPresent):
1807
_fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1809
def __init__(self, error):
1810
DependencyNotPresent.__init__(self, 'gpgme', error)
1813
1794
class WorkingTreeNotRevision(BzrError):
1815
1796
_fmt = ("The working tree for %(basedir)s has changed since"
2031
2012
BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2015
class BzrRemoveChangedFilesError(BzrError):
2016
"""Used when user is trying to remove changed files."""
2018
_fmt = ("Can't safely remove modified or unknown files:\n"
2019
"%(changes_as_text)s"
2020
"Use --keep to not delete them, or --force to delete them regardless.")
2022
def __init__(self, tree_delta):
2023
symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2024
"BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
2025
BzrError.__init__(self)
2026
self.changes_as_text = tree_delta.get_changes_as_text()
2027
#self.paths_as_string = '\n'.join(changed_files)
2028
#self.paths_as_string = '\n'.join([quotefn(p) for p in changed_files])
2034
2031
class BzrBadParameterNotString(BzrBadParameter):
2036
2033
_fmt = "Parameter %(param)s is not a string or unicode string."
2669
2666
This is distinct from ErrorFromSmartServer so that it is possible to
2670
2667
distinguish between the following two cases:
2672
- ErrorFromSmartServer was uncaught. This is logic error in the client
2673
and so should provoke a traceback to the user.
2674
- ErrorFromSmartServer was caught but its error_tuple could not be
2675
translated. This is probably because the server sent us garbage, and
2676
should not provoke a traceback.
2668
- ErrorFromSmartServer was uncaught. This is logic error in the client
2669
and so should provoke a traceback to the user.
2670
- ErrorFromSmartServer was caught but its error_tuple could not be
2671
translated. This is probably because the server sent us garbage, and
2672
should not provoke a traceback.
2679
2675
_fmt = "Server sent an unexpected error: %(error_tuple)r"
2885
2889
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2888
class StoringUncommittedNotSupported(BzrError):
2890
_fmt = ('Branch "%(display_url)s" does not support storing uncommitted'
2893
def __init__(self, branch):
2894
import bzrlib.urlutils as urlutils
2895
user_url = getattr(branch, "user_url", None)
2896
if user_url is None:
2897
display_url = str(branch)
2899
display_url = urlutils.unescape_for_display(user_url, 'ascii')
2900
BzrError.__init__(self, branch=branch, display_url=display_url)
2903
2892
class ShelvedChanges(UncommittedChanges):
2905
2894
_fmt = ('Working tree "%(display_url)s" has shelved changes'
3044
3033
BzrError.__init__(self, unknowns_str=", ".join(unknowns))
3036
class HookFailed(BzrError):
3037
"""Raised when a pre_change_branch_tip hook function fails anything other
3038
than TipChangeRejected.
3040
Note that this exception is no longer raised, and the import is only left
3041
to be nice to code which might catch it in a plugin.
3044
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
3045
"%(traceback_text)s%(exc_value)s")
3047
def __init__(self, hook_stage, hook_name, exc_info, warn=True):
3049
symbol_versioning.warn("BzrError HookFailed has been deprecated "
3050
"as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
3052
self.hook_stage = hook_stage
3053
self.hook_name = hook_name
3054
self.exc_info = exc_info
3055
self.exc_type = exc_info[0]
3056
self.exc_value = exc_info[1]
3057
self.exc_tb = exc_info[2]
3058
self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
3047
3061
class TipChangeRejected(BzrError):
3048
3062
"""A pre_change_branch_tip hook function may raise this to cleanly and
3049
3063
explicitly abort a change to a branch tip.
3243
3245
class ExpandingUnknownOption(BzrError):
3245
_fmt = 'Option "%(name)s" is not defined while expanding "%(string)s".'
3247
_fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3247
3249
def __init__(self, name, string):
3248
3250
self.name = name
3249
3251
self.string = string
3252
class IllegalOptionName(BzrError):
3254
_fmt = 'Option "%(name)s" is not allowed.'
3256
def __init__(self, name):
3260
class NoCompatibleInter(BzrError):
3262
_fmt = ('No compatible object available for operations from %(source)r '
3265
def __init__(self, source, target):
3266
self.source = source
3267
self.target = target
3270
class HpssVfsRequestNotAllowed(BzrError):
3272
_fmt = ("VFS requests over the smart server are not allowed. Encountered: "
3273
"%(method)s, %(arguments)s.")
3275
def __init__(self, method, arguments):
3276
self.method = method
3277
self.arguments = arguments
3280
class UnsupportedKindChange(BzrError):
3282
_fmt = ("Kind change from %(from_kind)s to %(to_kind)s for "
3283
"%(path)s not supported by format %(format)r")
3285
def __init__(self, path, from_kind, to_kind, format):
3287
self.from_kind = from_kind
3288
self.to_kind = to_kind
3289
self.format = format
3292
class MissingFeature(BzrError):
3294
_fmt = ("Missing feature %(feature)s not provided by this "
3295
"version of Bazaar or any plugin.")
3297
def __init__(self, feature):
3298
self.feature = feature
3301
class PatchSyntax(BzrError):
3302
"""Base class for patch syntax errors."""
3305
class BinaryFiles(BzrError):
3307
_fmt = 'Binary files section encountered.'
3309
def __init__(self, orig_name, mod_name):
3310
self.orig_name = orig_name
3311
self.mod_name = mod_name
3314
class MalformedPatchHeader(PatchSyntax):
3316
_fmt = "Malformed patch header. %(desc)s\n%(line)r"
3318
def __init__(self, desc, line):
3323
class MalformedHunkHeader(PatchSyntax):
3325
_fmt = "Malformed hunk header. %(desc)s\n%(line)r"
3327
def __init__(self, desc, line):
3332
class MalformedLine(PatchSyntax):
3334
_fmt = "Malformed line. %(desc)s\n%(line)r"
3336
def __init__(self, desc, line):
3341
class PatchConflict(BzrError):
3343
_fmt = ('Text contents mismatch at line %(line_no)d. Original has '
3344
'"%(orig_line)s", but patch says it should be "%(patch_line)s"')
3346
def __init__(self, line_no, orig_line, patch_line):
3347
self.line_no = line_no
3348
self.orig_line = orig_line.rstrip('\n')
3349
self.patch_line = patch_line.rstrip('\n')
3352
class FeatureAlreadyRegistered(BzrError):
3354
_fmt = 'The feature %(feature)s has already been registered.'
3356
def __init__(self, feature):
3357
self.feature = feature
3360
class ChangesAlreadyStored(BzrCommandError):
3362
_fmt = ('Cannot store uncommitted changes because this branch already'
3363
' stores uncommitted changes.')
added
removed
bzrlib/errors.py
