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
622
622
_fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'
624
def __init__(self, url, extra=""):
624
def __init__(self, url, extra):
625
625
PathError.__init__(self, url, extra=extra)
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
864
829
"""Construct a new AlreadyVersionedError.
866
831
:param path: This is the path which is versioned,
867
which should be in a user friendly form.
832
which should be in a user friendly form.
868
833
:param context_info: If given, this is information about the context,
869
which could explain why this is expected to not be versioned.
834
which could explain why this is expected to not be versioned.
871
836
BzrError.__init__(self)
885
850
"""Construct a new NotVersionedError.
887
852
:param path: This is the path which is not versioned,
888
which should be in a user friendly form.
853
which should be in a user friendly form.
889
854
:param context_info: If given, this is information about the context,
890
which could explain why this is expected to be versioned.
855
which could explain why this is expected to be versioned.
892
857
BzrError.__init__(self)
961
926
# original exception is available as e.original_error
963
928
# New code should prefer to raise specific subclasses
964
def __init__(self, msg):
929
def __init__(self, message):
930
# Python 2.5 uses a slot for StandardError.message,
931
# so use a different variable name. We now work around this in
932
# BzrError.__str__, but this member name is kept for compatability.
968
936
class LockActive(LockError):
1084
1054
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
1057
class LockNotHeld(LockError):
1101
1059
_fmt = "Lock not held: %(lock)s"
1140
1098
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
1101
class BadCommitMessageEncoding(BzrError):
1154
1103
_fmt = 'The specified commit message contains characters unsupported by '\
1210
1159
class InvalidRevisionSpec(BzrError):
1212
_fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1213
" %(branch_url)s%(extra)s")
1161
_fmt = ("Requested revision: %(spec)r does not exist in branch:"
1162
" %(branch)s%(extra)s")
1215
1164
def __init__(self, spec, branch, extra=None):
1216
1165
BzrError.__init__(self, branch=branch, spec=spec)
1217
self.branch_url = getattr(branch, 'user_url', str(branch))
1219
1167
self.extra = '\n' + str(extra)
1299
1247
class AmbiguousBase(BzrError):
1301
1249
def __init__(self, bases):
1302
symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1303
"as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1250
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1304
1252
msg = ("The correct base is unclear, because %s are all equally close"
1305
1253
% ", ".join(bases))
1306
1254
BzrError.__init__(self, msg)
1328
1276
class BoundBranchOutOfDate(BzrError):
1330
1278
_fmt = ("Bound branch %(branch)s is out of date with master branch"
1331
" %(master)s.%(extra_help)s")
1333
1281
def __init__(self, branch, master):
1334
1282
BzrError.__init__(self)
1335
1283
self.branch = branch
1336
1284
self.master = master
1337
self.extra_help = ''
1340
1287
class CommitToDoubleBoundBranch(BzrError):
1412
1359
class WeaveParentMismatch(WeaveError):
1414
_fmt = "Parents are mismatched between two revisions. %(msg)s"
1361
_fmt = "Parents are mismatched between two revisions. %(message)s"
1417
1364
class WeaveInvalidChecksum(WeaveError):
1419
_fmt = "Text did not match its checksum: %(msg)s"
1366
_fmt = "Text did not match it's checksum: %(message)s"
1422
1369
class WeaveTextDiffers(WeaveError):
1716
1663
class InvalidHttpResponse(TransportError):
1718
_fmt = "Invalid http response for %(path)s: %(msg)s%(orig_error)s"
1665
_fmt = "Invalid http response for %(path)s: %(msg)s"
1720
1667
def __init__(self, path, msg, orig_error=None):
1721
1668
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
1669
TransportError.__init__(self, msg, orig_error=orig_error)
1737
1678
InvalidHttpResponse.__init__(self, path, msg)
1740
class HttpBoundaryMissing(InvalidHttpResponse):
1741
"""A multipart response ends with no boundary marker.
1743
This is a special case caused by buggy proxies, described in
1744
<https://bugs.launchpad.net/bzr/+bug/198646>.
1747
_fmt = "HTTP MIME Boundary missing for %(path)s: %(msg)s"
1749
def __init__(self, path, msg):
1750
InvalidHttpResponse.__init__(self, path, msg)
1753
1681
class InvalidHttpContentType(InvalidHttpResponse):
1755
1683
_fmt = 'Invalid http Content-type "%(ctype)s" for %(path)s: %(msg)s'
1783
1711
_fmt = "Working tree has conflicts."
1786
class ConfigContentError(BzrError):
1788
_fmt = "Config file %(filename)s is not UTF-8 encoded\n"
1790
def __init__(self, filename):
1791
BzrError.__init__(self)
1792
self.filename = filename
1795
1714
class ParseConfigError(BzrError):
1797
_fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
1799
1716
def __init__(self, errors, filename):
1800
BzrError.__init__(self)
1801
self.filename = filename
1802
self.errors = '\n'.join(e.msg for e in errors)
1805
class ConfigOptionValueError(BzrError):
1807
_fmt = """Bad value "%(value)s" for option "%(name)s"."""
1809
def __init__(self, name, value):
1810
BzrError.__init__(self, name=name, value=value)
1717
if filename is None:
1719
message = "Error(s) parsing config file %s:\n%s" % \
1720
(filename, ('\n'.join(e.msg for e in errors)))
1721
BzrError.__init__(self, message)
1813
1724
class NoEmailInUsername(BzrError):
1822
1733
class SigningFailed(BzrError):
1824
_fmt = 'Failed to GPG sign data with command "%(command_line)s"'
1735
_fmt = 'Failed to gpg sign data with command "%(command_line)s"'
1826
1737
def __init__(self, command_line):
1827
1738
BzrError.__init__(self, command_line=command_line)
1830
class SignatureVerificationFailed(BzrError):
1832
_fmt = 'Failed to verify GPG signature data with error "%(error)s"'
1834
def __init__(self, error):
1835
BzrError.__init__(self, error=error)
1838
class DependencyNotPresent(BzrError):
1840
_fmt = 'Unable to import library "%(library)s": %(error)s'
1842
def __init__(self, library, error):
1843
BzrError.__init__(self, library=library, error=error)
1846
class GpgmeNotInstalled(DependencyNotPresent):
1848
_fmt = 'python-gpgme is not installed, it is needed to verify signatures'
1850
def __init__(self, error):
1851
DependencyNotPresent.__init__(self, 'gpgme', error)
1854
1741
class WorkingTreeNotRevision(BzrError):
1856
1743
_fmt = ("The working tree for %(basedir)s has changed since"
2016
1903
_fmt = "Moving the root directory is not supported at this time"
2019
class TransformRenameFailed(BzrError):
2021
_fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
2023
def __init__(self, from_path, to_path, why, errno):
2024
self.from_path = from_path
2025
self.to_path = to_path
2030
1906
class BzrMoveFailedError(BzrError):
2032
_fmt = ("Could not move %(from_path)s%(operator)s %(to_path)s"
2033
"%(_has_extra)s%(extra)s")
1908
_fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
2035
1910
def __init__(self, from_path='', to_path='', extra=None):
2036
1911
from bzrlib.osutils import splitpath
2037
1912
BzrError.__init__(self)
2039
self.extra, self._has_extra = extra, ': '
1914
self.extra = ': ' + str(extra)
2041
self.extra = self._has_extra = ''
2043
1918
has_from = len(from_path) > 0
2044
1919
has_to = len(to_path) > 0
2066
1941
class BzrRenameFailedError(BzrMoveFailedError):
2068
_fmt = ("Could not rename %(from_path)s%(operator)s %(to_path)s"
2069
"%(_has_extra)s%(extra)s")
1943
_fmt = "Could not rename %(from_path)s%(operator)s %(to_path)s%(extra)s"
2071
1945
def __init__(self, from_path, to_path, extra=None):
2072
1946
BzrMoveFailedError.__init__(self, from_path, to_path, extra)
2075
1948
class BzrRemoveChangedFilesError(BzrError):
2076
1949
"""Used when user is trying to remove changed files."""
2080
1953
"Use --keep to not delete them, or --force to delete them regardless.")
2082
1955
def __init__(self, tree_delta):
2083
symbol_versioning.warn(symbol_versioning.deprecated_in((2, 3, 0)) %
2084
"BzrRemoveChangedFilesError", DeprecationWarning, stacklevel=2)
2085
1956
BzrError.__init__(self)
2086
1957
self.changes_as_text = tree_delta.get_changes_as_text()
2087
1958
#self.paths_as_string = '\n'.join(changed_files)
2109
1980
_fmt = "Parameter %(param)s contains a newline."
1983
class DependencyNotPresent(BzrError):
1985
_fmt = 'Unable to import library "%(library)s": %(error)s'
1987
def __init__(self, library, error):
1988
BzrError.__init__(self, library=library, error=error)
2112
1991
class ParamikoNotPresent(DependencyNotPresent):
2114
1993
_fmt = "Unable to import paramiko (required for sftp support): %(error)s"
2718
2597
This is distinct from ErrorFromSmartServer so that it is possible to
2719
2598
distinguish between the following two cases:
2721
- ErrorFromSmartServer was uncaught. This is logic error in the client
2722
and so should provoke a traceback to the user.
2723
- ErrorFromSmartServer was caught but its error_tuple could not be
2724
translated. This is probably because the server sent us garbage, and
2725
should not provoke a traceback.
2599
- ErrorFromSmartServer was uncaught. This is logic error in the client
2600
and so should provoke a traceback to the user.
2601
- ErrorFromSmartServer was caught but its error_tuple could not be
2602
translated. This is probably because the server sent us garbage, and
2603
should not provoke a traceback.
2728
2606
_fmt = "Server sent an unexpected error: %(error_tuple)r"
2855
2733
def __init__(self, bzrdir):
2856
2734
import bzrlib.urlutils as urlutils
2857
display_url = urlutils.unescape_for_display(bzrdir.user_url,
2735
display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2859
2737
BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2935
2813
more = ' ' + more
2936
2814
import bzrlib.urlutils as urlutils
2937
user_url = getattr(tree, "user_url", None)
2938
if user_url is None:
2939
display_url = str(tree)
2941
display_url = urlutils.unescape_for_display(user_url, 'ascii')
2815
display_url = urlutils.unescape_for_display(
2816
tree.bzrdir.root_transport.base, 'ascii')
2942
2817
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2945
class ShelvedChanges(UncommittedChanges):
2947
_fmt = ('Working tree "%(display_url)s" has shelved changes'
2948
' (See bzr shelve --list).%(more)s')
2951
2820
class MissingTemplateVariable(BzrError):
2953
2822
_fmt = 'Variable {%(name)s} is not available.'
3022
2891
self.user_encoding = osutils.get_user_encoding()
3025
class NoSuchConfig(BzrError):
3027
_fmt = ('The "%(config_id)s" configuration does not exist.')
3029
def __init__(self, config_id):
3030
BzrError.__init__(self, config_id=config_id)
3033
class NoSuchConfigOption(BzrError):
3035
_fmt = ('The "%(option_name)s" configuration option does not exist.')
3037
def __init__(self, option_name):
3038
BzrError.__init__(self, option_name=option_name)
3041
2894
class NoSuchAlias(BzrError):
3043
2896
_fmt = ('The alias "%(alias_name)s" does not exist.')
3089
2942
class HookFailed(BzrError):
3090
2943
"""Raised when a pre_change_branch_tip hook function fails anything other
3091
2944
than TipChangeRejected.
3093
Note that this exception is no longer raised, and the import is only left
3094
to be nice to code which might catch it in a plugin.
3097
2947
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
3098
2948
"%(traceback_text)s%(exc_value)s")
3100
def __init__(self, hook_stage, hook_name, exc_info, warn=True):
3102
symbol_versioning.warn("BzrError HookFailed has been deprecated "
3103
"as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2950
def __init__(self, hook_stage, hook_name, exc_info):
3104
2951
import traceback
3105
2952
self.hook_stage = hook_stage
3106
2953
self.hook_name = hook_name
3127
2974
_fmt = "Shelf corrupt."
3130
class DecompressCorruption(BzrError):
3132
_fmt = "Corruption while decompressing repository file%(orig_error)s"
3134
def __init__(self, orig_error=None):
3135
if orig_error is not None:
3136
self.orig_error = ", %s" % (orig_error,)
3138
self.orig_error = ""
3139
BzrError.__init__(self)
3142
2977
class NoSuchShelfId(BzrError):
3144
2979
_fmt = 'No changes are shelved with id "%(shelf_id)d".'
3240
3075
def __init__(self, source_branch, target_branch):
3241
3076
self.source_branch = source_branch
3242
3077
self.target_branch = target_branch
3245
class NoRoundtrippingSupport(BzrError):
3247
_fmt = ("Roundtripping is not supported between %(source_branch)r and "
3248
"%(target_branch)r.")
3250
internal_error = True
3252
def __init__(self, source_branch, target_branch):
3253
self.source_branch = source_branch
3254
self.target_branch = target_branch
3257
class FileTimestampUnavailable(BzrError):
3259
_fmt = "The filestamp for %(path)s is not available."
3261
internal_error = True
3263
def __init__(self, path):
3267
class NoColocatedBranchSupport(BzrError):
3269
_fmt = ("%(bzrdir)r does not support co-located branches.")
3271
def __init__(self, bzrdir):
3272
self.bzrdir = bzrdir
3275
class NoWhoami(BzrError):
3277
_fmt = ('Unable to determine your name.\n'
3278
"Please, set your name with the 'whoami' command.\n"
3279
'E.g. bzr whoami "Your Name <name@example.com>"')
3282
class InvalidPattern(BzrError):
3284
_fmt = ('Invalid pattern(s) found. %(msg)s')
3286
def __init__(self, msg):
3290
class RecursiveBind(BzrError):
3292
_fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3293
'Please use `bzr unbind` to fix.')
3295
def __init__(self, branch_url):
3296
self.branch_url = branch_url
3299
# FIXME: I would prefer to define the config related exception classes in
3300
# config.py but the lazy import mechanism proscribes this -- vila 20101222
3301
class OptionExpansionLoop(BzrError):
3303
_fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
3305
def __init__(self, string, refs):
3306
self.string = string
3307
self.refs = '->'.join(refs)
3310
class ExpandingUnknownOption(BzrError):
3312
_fmt = 'Option %(name)s is not defined while expanding "%(string)s".'
3314
def __init__(self, name, string):
3316
self.string = string
3319
class NoCompatibleInter(BzrError):
3321
_fmt = ('No compatible object available for operations from %(source)r '
3324
def __init__(self, source, target):
3325
self.source = source
3326
self.target = target