1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008 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
54
Base class for errors raised by bzrlib.
56
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
59
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.)
61
61
:cvar _fmt: Format string to display the error; this is expanded
62
by the instance's dict.
62
by the instance's dict.
65
65
internal_error = False
702
702
# TODO: Probably this behavior of should be a common superclass
703
703
class NotBranchError(PathError):
705
_fmt = 'Not a branch: "%(path)s"%(detail)s.'
705
_fmt = 'Not a branch: "%(path)s".'
707
def __init__(self, path, detail=None, bzrdir=None):
707
def __init__(self, path):
708
708
import bzrlib.urlutils as urlutils
709
path = urlutils.unescape_for_display(path, 'ascii')
710
if detail is not None:
711
detail = ': ' + detail
714
PathError.__init__(self, path=path)
717
return '<%s %r>' % (self.__class__.__name__, self.__dict__)
720
# XXX: Ideally self.detail would be a property, but Exceptions in
721
# Python 2.4 have to be old-style classes so properties don't work.
722
# Instead we override _format.
723
if self.detail is None:
724
if self.bzrdir is not None:
726
self.bzrdir.open_repository()
727
except NoRepositoryPresent:
730
# Just ignore unexpected errors. Raising arbitrary errors
731
# during str(err) can provoke strange bugs. Concretely
732
# Launchpad's codehosting managed to raise NotBranchError
733
# here, and then get stuck in an infinite loop/recursion
734
# trying to str() that error. All this error really cares
735
# about that there's no working repository there, and if
736
# open_repository() fails, there probably isn't.
739
self.detail = ': location is a repository'
742
return PathError._format(self)
709
self.path = urlutils.unescape_for_display(path, 'ascii')
745
712
class NoSubmitBranch(PathError):
795
762
_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
764
def __init__(self, branch, path):
800
765
BzrError.__init__(self)
801
766
self.branch = branch
830
795
class IncompatibleRepositories(BzrError):
831
"""Report an error that two repositories are not compatible.
833
Note that the source and target repositories are permitted to be strings:
834
this exception is thrown from the smart server and may refer to a
835
repository the client hasn't opened.
838
797
_fmt = "%(target)s\n" \
839
798
"is not compatible with\n" \
864
823
"""Construct a new AlreadyVersionedError.
866
825
:param path: This is the path which is versioned,
867
which should be in a user friendly form.
826
which should be in a user friendly form.
868
827
:param context_info: If given, this is information about the context,
869
which could explain why this is expected to not be versioned.
828
which could explain why this is expected to not be versioned.
871
830
BzrError.__init__(self)
885
844
"""Construct a new NotVersionedError.
887
846
:param path: This is the path which is not versioned,
888
which should be in a user friendly form.
847
which should be in a user friendly form.
889
848
:param context_info: If given, this is information about the context,
890
which could explain why this is expected to be versioned.
849
which could explain why this is expected to be versioned.
892
851
BzrError.__init__(self)
961
920
# original exception is available as e.original_error
963
922
# New code should prefer to raise specific subclasses
964
def __init__(self, msg):
923
def __init__(self, message):
924
# Python 2.5 uses a slot for StandardError.message,
925
# so use a different variable name. We now work around this in
926
# BzrError.__str__, but this member name is kept for compatability.
968
930
class LockActive(LockError):
1084
1048
self.target = target
1087
class LockCorrupt(LockError):
1089
_fmt = ("Lock is apparently held, but corrupted: %(corruption_info)s\n"
1090
"Use 'bzr break-lock' to clear it")
1092
internal_error = False
1094
def __init__(self, corruption_info, file_data=None):
1095
self.corruption_info = corruption_info
1096
self.file_data = file_data
1099
1051
class LockNotHeld(LockError):
1101
1053
_fmt = "Lock not held: %(lock)s"
1140
1092
BzrError.__init__(self, files=files, files_str=files_str)
1143
class ExcludesUnsupported(BzrError):
1145
_fmt = ('Excluding paths during commit is not supported by '
1146
'repository at %(repository)r.')
1148
def __init__(self, repository):
1149
BzrError.__init__(self, repository=repository)
1152
1095
class BadCommitMessageEncoding(BzrError):
1154
1097
_fmt = 'The specified commit message contains characters unsupported by '\
1210
1153
class InvalidRevisionSpec(BzrError):
1212
_fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1213
" %(branch_url)s%(extra)s")
1155
_fmt = ("Requested revision: %(spec)r does not exist in branch:"
1156
" %(branch)s%(extra)s")
1215
1158
def __init__(self, spec, branch, extra=None):
1216
1159
BzrError.__init__(self, branch=branch, spec=spec)
1217
self.branch_url = getattr(branch, 'user_url', str(branch))
1219
1161
self.extra = '\n' + str(extra)
1299
1241
class AmbiguousBase(BzrError):
1301
1243
def __init__(self, bases):
1302
symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1303
"as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1244
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1304
1246
msg = ("The correct base is unclear, because %s are all equally close"
1305
1247
% ", ".join(bases))
1306
1248
BzrError.__init__(self, msg)
1328
1270
class BoundBranchOutOfDate(BzrError):
1330
1272
_fmt = ("Bound branch %(branch)s is out of date with master branch"
1331
" %(master)s.%(extra_help)s")
1333
1275
def __init__(self, branch, master):
1334
1276
BzrError.__init__(self)
1335
1277
self.branch = branch
1336
1278
self.master = master
1337
self.extra_help = ''
1340
1281
class CommitToDoubleBoundBranch(BzrError):
1412
1353
class WeaveParentMismatch(WeaveError):
1414
_fmt = "Parents are mismatched between two revisions. %(msg)s"
1355
_fmt = "Parents are mismatched between two revisions. %(message)s"
1417
1358
class WeaveInvalidChecksum(WeaveError):
1419
_fmt = "Text did not match its checksum: %(msg)s"
1360
_fmt = "Text did not match it's checksum: %(message)s"
1422
1363
class WeaveTextDiffers(WeaveError):
1716
1657
class InvalidHttpResponse(TransportError):
1718
_fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1659
_fmt = "Invalid http response for %(path)s: %(msg)s"
1720
1661
def __init__(self, path, msg, orig_error=None):
1721
1662
self.path = path
1722
if orig_error is None:
1725
# This is reached for obscure and unusual errors so we want to
1726
# preserve as much info as possible to ease debug.
1727
orig_error = ': %r' % (orig_error,)
1728
1663
TransportError.__init__(self, msg, orig_error=orig_error)
1770
1705
_fmt = "Working tree has conflicts."
1773
class ConfigContentError(BzrError):
1775
_fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1777
def __init__(self, filename):
1778
BzrError.__init__(self)
1779
self.filename = filename
1782
1708
class ParseConfigError(BzrError):
1784
_fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1786
1710
def __init__(self, errors, filename):
1787
BzrError.__init__(self)
1788
self.filename = filename
1789
self.errors = '\n'.join(e.msg for e in errors)
1711
if filename is None:
1713
message = "Error(s) parsing config file %s:\n%s" % \
1714
(filename, ('\n'.join(e.msg for e in errors)))
1715
BzrError.__init__(self, message)
1792
1718
class NoEmailInUsername(BzrError):
1801
1727
class SigningFailed(BzrError):
1803
_fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1729
_fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1805
1731
def __init__(self, command_line):
1806
1732
BzrError.__init__(self, command_line=command_line)
1809
class SignatureVerificationFailed(BzrError):
1811
_fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1813
def __init__(self, error):
1814
BzrError.__init__(self, error=error)
1817
class DependencyNotPresent(BzrError):
1819
_fmt = 'Unable to import library "%(library)s": %(error)s'
1821
def __init__(self, library, error):
1822
BzrError.__init__(self, library=library, error=error)
1825
class GpgmeNotInstalled(DependencyNotPresent):
1827
_fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1829
def __init__(self, error):
1830
DependencyNotPresent.__init__(self, 'gpgme', error)
1833
1735
class WorkingTreeNotRevision(BzrError):
1835
1737
_fmt = ("The working tree for %(basedir)s has changed since"
1995
1897
_fmt = "Moving the root directory is not supported at this time"
1998
class TransformRenameFailed(BzrError):
2000
_fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
2002
def __init__(self, from_path, to_path, why, errno):
2003
self.from_path = from_path
2004
self.to_path = to_path
2009
1900
class BzrMoveFailedError(BzrError):
2011
_fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
2012
"%(_has_extra)s%(extra)s")
1902
_fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
2014
1904
def __init__(self, from_path='', to_path='', extra=None):
2015
1905
from bzrlib.osutils import splitpath
2016
1906
BzrError.__init__(self)
2018
self.extra, self._has_extra = extra, ': '
1908
self.extra = ': ' + str(extra)
2020
self.extra = self._has_extra = ''
2022
1912
has_from = len(from_path) > 0
2023
1913
has_to = len(to_path) > 0
2045
1935
class BzrRenameFailedError(BzrMoveFailedError):
2047
_fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2048
"%(_has_extra)s%(extra)s")
1937
_fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2050
1939
def __init__(self, from_path, to_path, extra=None):
2051
1940
BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2054
1942
class BzrRemoveChangedFilesError(BzrError):
2055
1943
"""Used when user is trying to remove changed files."""
2059
1947
"Use --keep to not delete them, or --force to delete them regardless.")
2061
1949
def __init__(self, tree_delta):
2062
symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2063
"BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
2064
1950
BzrError.__init__(self)
2065
1951
self.changes_as_text = tree_delta.get_changes_as_text()
2066
1952
#self.paths_as_string = '\n'.join(changed_files)
2088
1974
_fmt = "Parameter %(param)s contains a newline."
1977
class DependencyNotPresent(BzrError):
1979
_fmt = 'Unable to import library "%(library)s": %(error)s'
1981
def __init__(self, library, error):
1982
BzrError.__init__(self, library=library, error=error)
2091
1985
class ParamikoNotPresent(DependencyNotPresent):
2093
1987
_fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2113
2007
class BadConversionTarget(BzrError):
2115
_fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2009
_fmt = "Cannot convert to format %(format)s. %(problem)s"
2118
def __init__(self, problem, format, from_format=None):
2011
def __init__(self, problem, format):
2119
2012
BzrError.__init__(self)
2120
2013
self.problem = problem
2121
2014
self.format = format
2122
self.from_format = from_format or '(unspecified)'
2125
2017
class NoDiffFound(BzrError):
2697
2589
This is distinct from ErrorFromSmartServer so that it is possible to
2698
2590
distinguish between the following two cases:
2700
- ErrorFromSmartServer was uncaught. This is logic error in the client
2701
and so should provoke a traceback to the user.
2702
- ErrorFromSmartServer was caught but its error_tuple could not be
2703
translated. This is probably because the server sent us garbage, and
2704
should not provoke a traceback.
2591
- ErrorFromSmartServer was uncaught. This is logic error in the client
2592
and so should provoke a traceback to the user.
2593
- ErrorFromSmartServer was caught but its error_tuple could not be
2594
translated. This is probably because the server sent us garbage, and
2595
should not provoke a traceback.
2707
2598
_fmt = "Server sent an unexpected error: %(error_tuple)r"
2834
2725
def __init__(self, bzrdir):
2835
2726
import bzrlib.urlutils as urlutils
2836
display_url = urlutils.unescape_for_display(bzrdir.user_url,
2727
display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2838
2729
BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2914
2805
more = ' ' + more
2915
2806
import bzrlib.urlutils as urlutils
2916
user_url = getattr(tree, "user_url", None)
2917
if user_url is None:
2918
display_url = str(tree)
2920
display_url = urlutils.unescape_for_display(user_url, 'ascii')
2807
display_url = urlutils.unescape_for_display(
2808
tree.bzrdir.root_transport.base, 'ascii')
2921
2809
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2924
class ShelvedChanges(UncommittedChanges):
2926
_fmt = ('Working tree "%(display_url)s" has shelved changes'
2927
' (See bzr shelve --list).%(more)s')
2930
2812
class MissingTemplateVariable(BzrError):
2932
2814
_fmt = 'Variable {%(name)s} is not available.'
3001
2883
self.user_encoding = osutils.get_user_encoding()
3004
class NoSuchConfig(BzrError):
3006
_fmt = ('The "%(config_id)s" configuration does not exist.')
3008
def __init__(self, config_id):
3009
BzrError.__init__(self, config_id=config_id)
3012
class NoSuchConfigOption(BzrError):
3014
_fmt = ('The "%(option_name)s" configuration option does not exist.')
3016
def __init__(self, option_name):
3017
BzrError.__init__(self, option_name=option_name)
3020
2886
class NoSuchAlias(BzrError):
3022
2888
_fmt = ('The alias "%(alias_name)s" does not exist.')
3052
2918
_fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
3054
2920
def __init__(self, host, port, orig_error):
3055
# nb: in python2.4 socket.error doesn't have a useful repr
3056
2921
BzrError.__init__(self, host=host, port=port,
3057
orig_error=repr(orig_error.args))
2922
orig_error=orig_error[1])
3060
2925
class UnknownRules(BzrError):
3068
2933
class HookFailed(BzrError):
3069
2934
"""Raised when a pre_change_branch_tip hook function fails anything other
3070
2935
than TipChangeRejected.
3072
Note that this exception is no longer raised, and the import is only left
3073
to be nice to code which might catch it in a plugin.
3076
2938
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
3077
2939
"%(traceback_text)s%(exc_value)s")
3079
def __init__(self, hook_stage, hook_name, exc_info, warn=True):
3081
symbol_versioning.warn("BzrError HookFailed has been deprecated "
3082
"as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2941
def __init__(self, hook_stage, hook_name, exc_info):
3083
2942
import traceback
3084
2943
self.hook_stage = hook_stage
3085
2944
self.hook_name = hook_name
3106
2965
_fmt = "Shelf corrupt."
3109
class DecompressCorruption(BzrError):
3111
_fmt = "Corruption while decompressing repository file%(orig_error)s"
3113
def __init__(self, orig_error=None):
3114
if orig_error is not None:
3115
self.orig_error = ", %s" % (orig_error,)
3117
self.orig_error = ""
3118
BzrError.__init__(self)
3121
2968
class NoSuchShelfId(BzrError):
3123
2970
_fmt = 'No changes are shelved with id "%(shelf_id)d".'
3219
3066
def __init__(self, source_branch, target_branch):
3220
3067
self.source_branch = source_branch
3221
3068
self.target_branch = target_branch
3224
class NoRoundtrippingSupport(BzrError):
3226
_fmt = ("Roundtripping is not supported between %(source_branch)r and "
3227
"%(target_branch)r.")
3229
internal_error = True
3231
def __init__(self, source_branch, target_branch):
3232
self.source_branch = source_branch
3233
self.target_branch = target_branch
3236
class FileTimestampUnavailable(BzrError):
3238
_fmt = "The filestamp for %(path)s is not available."
3240
internal_error = True
3242
def __init__(self, path):
3246
class NoColocatedBranchSupport(BzrError):
3248
_fmt = ("%(bzrdir)r does not support co-located branches.")
3250
def __init__(self, bzrdir):
3251
self.bzrdir = bzrdir
3254
class NoWhoami(BzrError):
3256
_fmt = ('Unable to determine your name.\n'
3257
"Please, set your name with the 'whoami' command.\n"
3258
'E.g. bzr whoami "Your Name <name@example.com>"')
3261
class InvalidPattern(BzrError):
3263
_fmt = ('Invalid pattern(s) found. %(msg)s')
3265
def __init__(self, msg):
3269
class RecursiveBind(BzrError):
3271
_fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3272
'Please use `bzr unbind` to fix.')
3274
def __init__(self, branch_url):
3275
self.branch_url = branch_url
3278
# FIXME: I would prefer to define the config related exception classes in
3279
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3280
class OptionExpansionLoop(BzrError):
3282
_fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3284
def __init__(self, string, refs):
3285
self.string = string
3286
self.refs = '->'.join(refs)
3289
class ExpandingUnknownOption(BzrError):
3291
_fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3293
def __init__(self, name, string):
3295
self.string = string
3298
class NoCompatibleInter(BzrError):
3300
_fmt = ('No compatible object available for operations from %(source)r '
3303
def __init__(self, source, target):
3304
self.source = source
3305
self.target = target