1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
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
54
57
Base class for errors raised by bzrlib.
56
59
: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.)
60
should be displayed with a traceback; if False (or absent) this was
61
probably a user or environment error and they don't need the gory
62
details. (That can be overridden by -Derror on the command line.)
61
64
:cvar _fmt: Format string to display the error; this is expanded
62
by the instance's dict.
65
by the instance's dict.
65
68
internal_error = False
140
143
"""Return format string for this exception or None"""
141
144
fmt = getattr(self, '_fmt', None)
142
145
if fmt is not None:
147
unicode_fmt = unicode(fmt) #_fmt strings should be ascii
148
if type(fmt) == unicode:
149
trace.mutter("Unicode strings in error.fmt are deprecated")
150
return gettext(unicode_fmt)
144
151
fmt = getattr(self, '__doc__', None)
145
152
if fmt is not None:
146
153
symbol_versioning.warn("%s uses its docstring as a format, "
622
629
_fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
624
def __init__(self, url, extra):
631
def __init__(self, url, extra=""):
625
632
PathError.__init__(self, url, extra=extra)
713
720
self.bzrdir = bzrdir
714
721
PathError.__init__(self, path=path)
724
return '<%s %r>' % (self.__class__.__name__, self.__dict__)
716
726
def _format(self):
717
727
# XXX: Ideally self.detail would be a property, but Exceptions in
718
728
# Python 2.4 have to be old-style classes so properties don't work.
723
733
self.bzrdir.open_repository()
724
734
except NoRepositoryPresent:
737
# Just ignore unexpected errors. Raising arbitrary errors
738
# during str(err) can provoke strange bugs. Concretely
739
# Launchpad's codehosting managed to raise NotBranchError
740
# here, and then get stuck in an infinite loop/recursion
741
# trying to str() that error. All this error really cares
742
# about that there's no working repository there, and if
743
# open_repository() fails, there probably isn't.
727
746
self.detail = ': location is a repository'
783
802
_fmt = 'File "%(path)s" is not in branch %(branch_base)s.'
804
# use PathNotChild instead
805
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 3, 0)))
785
806
def __init__(self, branch, path):
786
807
BzrError.__init__(self)
787
808
self.branch = branch
850
871
"""Construct a new AlreadyVersionedError.
852
873
:param path: This is the path which is versioned,
853
which should be in a user friendly form.
874
which should be in a user friendly form.
854
875
:param context_info: If given, this is information about the context,
855
which could explain why this is expected to not be versioned.
876
which could explain why this is expected to not be versioned.
857
878
BzrError.__init__(self)
871
892
"""Construct a new NotVersionedError.
873
894
:param path: This is the path which is not versioned,
874
which should be in a user friendly form.
895
which should be in a user friendly form.
875
896
:param context_info: If given, this is information about the context,
876
which could explain why this is expected to be versioned.
897
which could explain why this is expected to be versioned.
878
899
BzrError.__init__(self)
947
968
# original exception is available as e.original_error
949
970
# New code should prefer to raise specific subclasses
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.
971
def __init__(self, msg):
957
975
class LockActive(LockError):
1075
1091
self.target = target
1094
class LockCorrupt(LockError):
1096
_fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
1097
"Use 'bzr break-lock' to clear it")
1099
internal_error = False
1101
def __init__(self, corruption_info, file_data=None):
1102
self.corruption_info = corruption_info
1103
self.file_data = file_data
1078
1106
class LockNotHeld(LockError):
1080
1108
_fmt = "Lock not held: %(lock)s"
1119
1147
BzrError.__init__(self, files=files, files_str=files_str)
1150
class ExcludesUnsupported(BzrError):
1152
_fmt = ('Excluding paths during commit is not supported by '
1153
'repository at %(repository)r.')
1155
def __init__(self, repository):
1156
BzrError.__init__(self, repository=repository)
1122
1159
class BadCommitMessageEncoding(BzrError):
1124
1161
_fmt = 'The specified commit message contains characters unsupported by '\
1180
1217
class InvalidRevisionSpec(BzrError):
1182
1219
_fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1183
" %(branch)s%(extra)s")
1220
" %(branch_url)s%(extra)s")
1185
1222
def __init__(self, spec, branch, extra=None):
1186
1223
BzrError.__init__(self, branch=branch, spec=spec)
1224
self.branch_url = getattr(branch, 'user_url', str(branch))
1188
1226
self.extra = '\n' + str(extra)
1381
1419
class WeaveParentMismatch(WeaveError):
1383
_fmt = "Parents are mismatched between two revisions. %(message)s"
1421
_fmt = "Parents are mismatched between two revisions. %(msg)s"
1386
1424
class WeaveInvalidChecksum(WeaveError):
1388
_fmt = "Text did not match it's checksum: %(message)s"
1426
_fmt = "Text did not match its checksum: %(msg)s"
1391
1429
class WeaveTextDiffers(WeaveError):
1685
1723
class InvalidHttpResponse(TransportError):
1687
_fmt = "Invalid http response for %(path)s: %(msg)s"
1725
_fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1689
1727
def __init__(self, path, msg, orig_error=None):
1690
1728
self.path = path
1729
if orig_error is None:
1732
# This is reached for obscure and unusual errors so we want to
1733
# preserve as much info as possible to ease debug.
1734
orig_error = ': %r' % (orig_error,)
1691
1735
TransportError.__init__(self, msg, orig_error=orig_error)
1700
1744
InvalidHttpResponse.__init__(self, path, msg)
1747
class HttpBoundaryMissing(InvalidHttpResponse):
1748
"""A multipart response ends with no boundary marker.
1750
This is a special case caused by buggy proxies, described in
1751
<https://bugs.launchpad.net/bzr/+bug/198646>.
1754
_fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
1756
def __init__(self, path, msg):
1757
InvalidHttpResponse.__init__(self, path, msg)
1703
1760
class InvalidHttpContentType(InvalidHttpResponse):
1705
1762
_fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1733
1790
_fmt = "Working tree has conflicts."
1793
class ConfigContentError(BzrError):
1795
_fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1797
def __init__(self, filename):
1798
BzrError.__init__(self)
1799
self.filename = filename
1736
1802
class ParseConfigError(BzrError):
1804
_fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1738
1806
def __init__(self, errors, filename):
1739
if filename is None:
1741
message = "Error(s) parsing config file %s:\n%s" % \
1742
(filename, ('\n'.join(e.msg for e in errors)))
1743
BzrError.__init__(self, message)
1807
BzrError.__init__(self)
1808
self.filename = filename
1809
self.errors = '\n'.join(e.msg for e in errors)
1812
class ConfigOptionValueError(BzrError):
1814
_fmt = """Bad value "%(value)s" for option "%(name)s"."""
1816
def __init__(self, name, value):
1817
BzrError.__init__(self, name=name, value=value)
1746
1820
class NoEmailInUsername(BzrError):
1755
1829
class SigningFailed(BzrError):
1757
_fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1831
_fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1759
1833
def __init__(self, command_line):
1760
1834
BzrError.__init__(self, command_line=command_line)
1837
class SignatureVerificationFailed(BzrError):
1839
_fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1841
def __init__(self, error):
1842
BzrError.__init__(self, error=error)
1845
class DependencyNotPresent(BzrError):
1847
_fmt = 'Unable to import library "%(library)s": %(error)s'
1849
def __init__(self, library, error):
1850
BzrError.__init__(self, library=library, error=error)
1853
class GpgmeNotInstalled(DependencyNotPresent):
1855
_fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1857
def __init__(self, error):
1858
DependencyNotPresent.__init__(self, 'gpgme', error)
1763
1861
class WorkingTreeNotRevision(BzrError):
1765
1863
_fmt = ("The working tree for %(basedir)s has changed since"
1925
2023
_fmt = "Moving the root directory is not supported at this time"
2026
class TransformRenameFailed(BzrError):
2028
_fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
2030
def __init__(self, from_path, to_path, why, errno):
2031
self.from_path = from_path
2032
self.to_path = to_path
1928
2037
class BzrMoveFailedError(BzrError):
1930
_fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
2039
_fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
2040
"%(_has_extra)s%(extra)s")
1932
2042
def __init__(self, from_path='', to_path='', extra=None):
1933
2043
from bzrlib.osutils import splitpath
1934
2044
BzrError.__init__(self)
1936
self.extra = ': ' + str(extra)
2046
self.extra, self._has_extra = extra, ': '
2048
self.extra = self._has_extra = ''
1940
2050
has_from = len(from_path) > 0
1941
2051
has_to = len(to_path) > 0
1963
2073
class BzrRenameFailedError(BzrMoveFailedError):
1965
_fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2075
_fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2076
"%(_has_extra)s%(extra)s")
1967
2078
def __init__(self, from_path, to_path, extra=None):
1968
2079
BzrMoveFailedError.__init__(self, from_path, to_path, extra)
1970
2082
class BzrRemoveChangedFilesError(BzrError):
1971
2083
"""Used when user is trying to remove changed files."""
1975
2087
"Use --keep to not delete them, or --force to delete them regardless.")
1977
2089
def __init__(self, tree_delta):
2090
symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2091
"BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
1978
2092
BzrError.__init__(self)
1979
2093
self.changes_as_text = tree_delta.get_changes_as_text()
1980
2094
#self.paths_as_string = '\n'.join(changed_files)
1989
2103
class BzrBadParameterMissing(BzrBadParameter):
1991
_fmt = "Parameter $(param)s is required but not present."
2105
_fmt = "Parameter %(param)s is required but not present."
1994
2108
class BzrBadParameterUnicode(BzrBadParameter):
2002
2116
_fmt = "Parameter %(param)s contains a newline."
2005
class DependencyNotPresent(BzrError):
2007
_fmt = 'Unable to import library "%(library)s": %(error)s'
2009
def __init__(self, library, error):
2010
BzrError.__init__(self, library=library, error=error)
2013
2119
class ParamikoNotPresent(DependencyNotPresent):
2015
2121
_fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2359
class GhostTagsNotSupported(BzrError):
2361
_fmt = "Ghost tags not supported by format %(format)r."
2363
def __init__(self, format):
2364
self.format = format
2253
2367
class BinaryFile(BzrError):
2255
2369
_fmt = "File is binary but should be text."
2619
2733
This is distinct from ErrorFromSmartServer so that it is possible to
2620
2734
distinguish between the following two cases:
2621
- ErrorFromSmartServer was uncaught. This is logic error in the client
2622
and so should provoke a traceback to the user.
2623
- ErrorFromSmartServer was caught but its error_tuple could not be
2624
translated. This is probably because the server sent us garbage, and
2625
should not provoke a traceback.
2736
- ErrorFromSmartServer was uncaught. This is logic error in the client
2737
and so should provoke a traceback to the user.
2738
- ErrorFromSmartServer was caught but its error_tuple could not be
2739
translated. This is probably because the server sent us garbage, and
2740
should not provoke a traceback.
2628
2743
_fmt = "Server sent an unexpected error: %(error_tuple)r"
2684
2799
_fmt = "Container has multiple records with the same name: %(name)s"
2686
2801
def __init__(self, name):
2802
self.name = name.decode("utf-8")
2690
2805
class NoDestinationAddress(InternalBzrError):
2835
2950
more = ' ' + more
2836
2951
import bzrlib.urlutils as urlutils
2837
display_url = urlutils.unescape_for_display(
2838
tree.user_url, 'ascii')
2952
user_url = getattr(tree, "user_url", None)
2953
if user_url is None:
2954
display_url = str(tree)
2956
display_url = urlutils.unescape_for_display(user_url, 'ascii')
2839
2957
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2960
class ShelvedChanges(UncommittedChanges):
2962
_fmt = ('Working tree "%(display_url)s" has shelved changes'
2963
' (See bzr shelve --list).%(more)s')
2842
2966
class MissingTemplateVariable(BzrError):
2844
2968
_fmt = 'Variable {%(name)s} is not available.'
2913
3037
self.user_encoding = osutils.get_user_encoding()
3040
class NoSuchConfig(BzrError):
3042
_fmt = ('The "%(config_id)s" configuration does not exist.')
3044
def __init__(self, config_id):
3045
BzrError.__init__(self, config_id=config_id)
3048
class NoSuchConfigOption(BzrError):
3050
_fmt = ('The "%(option_name)s" configuration option does not exist.')
3052
def __init__(self, option_name):
3053
BzrError.__init__(self, option_name=option_name)
2916
3056
class NoSuchAlias(BzrError):
2918
3058
_fmt = ('The alias "%(alias_name)s" does not exist.')
3002
3142
_fmt = "Shelf corrupt."
3145
class DecompressCorruption(BzrError):
3147
_fmt = "Corruption while decompressing repository file%(orig_error)s"
3149
def __init__(self, orig_error=None):
3150
if orig_error is not None:
3151
self.orig_error = ", %s" % (orig_error,)
3153
self.orig_error = ""
3154
BzrError.__init__(self)
3005
3157
class NoSuchShelfId(BzrError):
3007
3159
_fmt = 'No changes are shelved with id "%(shelf_id)d".'
3134
3286
def __init__(self, bzrdir):
3135
3287
self.bzrdir = bzrdir
3290
class NoWhoami(BzrError):
3292
_fmt = ('Unable to determine your name.\n'
3293
"Please, set your name with the 'whoami' command.\n"
3294
'E.g. bzr whoami "Your Name <name@example.com>"')
3297
class InvalidPattern(BzrError):
3299
_fmt = ('Invalid pattern(s) found. %(msg)s')
3301
def __init__(self, msg):
3305
class RecursiveBind(BzrError):
3307
_fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3308
'Please use `bzr unbind` to fix.')
3310
def __init__(self, branch_url):
3311
self.branch_url = branch_url
3314
# FIXME: I would prefer to define the config related exception classes in
3315
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3316
class OptionExpansionLoop(BzrError):
3318
_fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3320
def __init__(self, string, refs):
3321
self.string = string
3322
self.refs = '->'.join(refs)
3325
class ExpandingUnknownOption(BzrError):
3327
_fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3329
def __init__(self, name, string):
3331
self.string = string
3334
class NoCompatibleInter(BzrError):
3336
_fmt = ('No compatible object available for operations from %(source)r '
3339
def __init__(self, source, target):
3340
self.source = source
3341
self.target = target
3344
class HpssVfsRequestNotAllowed(BzrError):
3346
_fmt = ("VFS requests over the smart server are not allowed. Encountered: "
3347
"%(method)s, %(arguments)s.")
3349
def __init__(self, method, arguments):
3350
self.method = method
3351
self.arguments = arguments