1
# Copyright (C) 2005-2010 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
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Exceptions for bzr, and reporting of them.
33
33
# TODO: is there any value in providing the .args field used by standard
34
# python exceptions? A list of values with no names seems less useful
34
# python exceptions? A list of values with no names seems less useful
37
# TODO: Perhaps convert the exception to a string at the moment it's
37
# TODO: Perhaps convert the exception to a string at the moment it's
38
38
# constructed to make sure it will succeed. But that says nothing about
39
39
# exceptions that are never raised.
72
72
arguments can be given. The first is for generic "user" errors which
73
73
are not intended to be caught and so do not need a specific subclass.
74
74
The second case is for use with subclasses that provide a _fmt format
75
string to print the arguments.
75
string to print the arguments.
77
Keyword arguments are taken as parameters to the error, which can
78
be inserted into the format string template. It's recommended
79
that subclasses override the __init__ method to require specific
77
Keyword arguments are taken as parameters to the error, which can
78
be inserted into the format string template. It's recommended
79
that subclasses override the __init__ method to require specific
82
82
:param msg: If given, this is the literal complete text for the error,
477
477
def __init__(self, name, value):
478
478
BzrError.__init__(self, name=name, value=value)
481
481
class StrictCommitFailed(BzrError):
483
483
_fmt = "Commit refused because there are unknown files in the tree"
486
486
# XXX: Should be unified with TransportError; they seem to represent the
488
488
# RBC 20060929: I think that unifiying with TransportError would be a mistake
489
# - this is finer than a TransportError - and more useful as such. It
489
# - this is finer than a TransportError - and more useful as such. It
490
490
# differentiates between 'transport has failed' and 'operation on a transport
492
492
class PathError(BzrError):
494
494
_fmt = "Generic path error: %(path)r%(extra)s)"
496
496
def __init__(self, path, extra=None):
639
class UnstackableLocationError(BzrError):
641
_fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
643
def __init__(self, branch_url, target_url):
644
BzrError.__init__(self)
645
self.branch_url = branch_url
646
self.target_url = target_url
649
639
class UnstackableRepositoryFormat(BzrError):
651
641
_fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
700
690
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
691
# the exception object is a bit undesirable.
702
# TODO: Probably this behavior of should be a common superclass
692
# TODO: Probably this behavior of should be a common superclass
703
693
class NotBranchError(PathError):
705
_fmt = 'Not a branch: "%(path)s"%(detail)s.'
695
_fmt = 'Not a branch: "%(path)s".'
707
def __init__(self, path, detail=None, bzrdir=None):
697
def __init__(self, path):
708
698
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
# 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.
720
if self.detail is None:
721
if self.bzrdir is not None:
723
self.bzrdir.open_repository()
724
except NoRepositoryPresent:
727
self.detail = ': location is a repository'
730
return PathError._format(self)
699
self.path = urlutils.unescape_for_display(path, 'ascii')
733
702
class NoSubmitBranch(PathError):
816
785
class IncompatibleRepositories(BzrError):
817
"""Report an error that two repositories are not compatible.
819
Note that the source and target repositories are permitted to be strings:
820
this exception is thrown from the smart server and may refer to a
821
repository the client hasn't opened.
824
787
_fmt = "%(target)s\n" \
825
788
"is not compatible with\n" \
1041
1004
class LockContention(LockError):
1043
_fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
1006
_fmt = 'Could not acquire lock "%(lock)s"'
1044
1007
# TODO: show full url for lock, combining the transport and relative
1047
1010
internal_error = False
1049
def __init__(self, lock, msg=''):
1012
def __init__(self, lock):
1050
1013
self.lock = lock
1054
1016
class LockBroken(LockError):
1169
1131
class NoSuchRevisionInTree(NoSuchRevision):
1170
1132
"""When using Tree.revision_tree, and the revision is not accessible."""
1172
1134
_fmt = "The revision id {%(revision_id)s} is not present in the tree %(tree)s."
1174
1136
def __init__(self, tree, revision_id):
1180
1142
class InvalidRevisionSpec(BzrError):
1182
_fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1144
_fmt = ("Requested revision: %(spec)r does not exist in branch:"
1183
1145
" %(branch)s%(extra)s")
1185
1147
def __init__(self, spec, branch, extra=None):
1210
1172
class DivergedBranches(BzrError):
1212
1174
_fmt = ("These branches have diverged."
1213
" Use the missing command to see how.\n"
1214
"Use the merge command to reconcile them.")
1175
" Use the merge command to reconcile them.")
1216
1177
def __init__(self, branch1, branch2):
1217
1178
self.branch1 = branch1
1265
1226
not_ancestor_id=not_ancestor_id)
1229
class InstallFailed(BzrError):
1231
def __init__(self, revisions):
1232
revision_str = ", ".join(str(r) for r in revisions)
1233
msg = "Could not install revisions:\n%s" % revision_str
1234
BzrError.__init__(self, msg)
1235
self.revisions = revisions
1268
1238
class AmbiguousBase(BzrError):
1270
1240
def __init__(self, bases):
1271
symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
"as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1241
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1273
1243
msg = ("The correct base is unclear, because %s are all equally close"
1274
1244
% ", ".join(bases))
1275
1245
BzrError.__init__(self, msg)
1297
1267
class BoundBranchOutOfDate(BzrError):
1299
1269
_fmt = ("Bound branch %(branch)s is out of date with master branch"
1300
" %(master)s.%(extra_help)s")
1302
1272
def __init__(self, branch, master):
1303
1273
BzrError.__init__(self)
1304
1274
self.branch = branch
1305
1275
self.master = master
1306
self.extra_help = ''
1309
1278
class CommitToDoubleBoundBranch(BzrError):
1311
1280
_fmt = ("Cannot commit to branch %(branch)s."
1415
1384
class VersionedFileError(BzrError):
1417
1386
_fmt = "Versioned file error"
1420
1389
class RevisionNotPresent(VersionedFileError):
1422
1391
_fmt = 'Revision {%(revision_id)s} not present in "%(file_id)s".'
1424
1393
def __init__(self, revision_id, file_id):
1481
1450
def __init__(self, stream_format, target_format):
1482
1451
self.stream_format = stream_format
1483
1452
self.target_format = target_format
1486
1455
class KnitDataStreamUnknown(KnitError):
1487
1456
# Indicates a data stream we don't know how to handle.
1665
1634
self.port = ':%s' % port
1668
# XXX: This is also used for unexpected end of file, which is different at the
1669
# TCP level from "connection reset".
1670
1637
class ConnectionReset(TransportError):
1672
1639
_fmt = "Connection closed: %(msg)s %(orig_error)s"
1763
1730
class WorkingTreeNotRevision(BzrError):
1765
_fmt = ("The working tree for %(basedir)s has changed since"
1732
_fmt = ("The working tree for %(basedir)s has changed since"
1766
1733
" the last commit, but weave merge requires that it be"
2035
2002
class BadConversionTarget(BzrError):
2037
_fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2004
_fmt = "Cannot convert to format %(format)s. %(problem)s"
2040
def __init__(self, problem, format, from_format=None):
2006
def __init__(self, problem, format):
2041
2007
BzrError.__init__(self)
2042
2008
self.problem = problem
2043
2009
self.format = format
2044
self.from_format = from_format or '(unspecified)'
2047
2012
class NoDiffFound(BzrError):
2084
2049
_fmt = """This tree contains left-over files from a failed operation.
2085
2050
Please examine %(limbo_dir)s to see if it contains any files you wish to
2086
2051
keep, and delete it when you are done."""
2088
2053
def __init__(self, limbo_dir):
2089
2054
BzrError.__init__(self)
2090
2055
self.limbo_dir = limbo_dir
2124
2089
class OutOfDateTree(BzrError):
2126
_fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
2091
_fmt = "Working tree is out of date, please run 'bzr update'."
2128
def __init__(self, tree, more=None):
2093
def __init__(self, tree):
2133
2094
BzrError.__init__(self)
2134
2095
self.tree = tree
2138
2098
class PublicBranchOutOfDate(BzrError):
2177
2137
def __init__(self, repo):
2178
2138
BzrError.__init__(self)
2179
self.repo_path = repo.user_url
2139
self.repo_path = repo.bzrdir.root_transport.base
2182
2142
class InconsistentDelta(BzrError):
2192
2152
self.reason = reason
2195
class InconsistentDeltaDelta(InconsistentDelta):
2196
"""Used when we get a delta that is not valid."""
2198
_fmt = ("An inconsistent delta was supplied: %(delta)r"
2199
"\nreason: %(reason)s")
2201
def __init__(self, delta, reason):
2202
BzrError.__init__(self)
2204
self.reason = reason
2207
2155
class UpgradeRequired(BzrError):
2209
2157
_fmt = "To use this feature you must upgrade your branch at %(path)s."
2218
2166
_fmt = "To use this feature you must upgrade your repository at %(path)s."
2221
class RichRootUpgradeRequired(UpgradeRequired):
2223
_fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2224
" a format which supports rich roots.")
2227
2169
class LocalRequiresBoundBranch(BzrError):
2229
2171
_fmt = "Cannot perform local-only commits on unbound branches."
2174
class InvalidProgressBarType(BzrError):
2176
_fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2177
" is not a supported type Select one of: %(valid_types)s")
2179
def __init__(self, bar_type, valid_types):
2180
BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2232
2183
class UnsupportedOperation(BzrError):
2234
2185
_fmt = ("The method %(mname)s is not supported on"
2285
2236
self.text = text
2288
class BadBundle(BzrError):
2239
class BadBundle(BzrError):
2290
2241
_fmt = "Bad bzr revision-bundle: %(text)r"
2292
2243
def __init__(self, text):
2294
2245
self.text = text
2297
class MalformedHeader(BadBundle):
2248
class MalformedHeader(BadBundle):
2299
2250
_fmt = "Malformed bzr revision-bundle header: %(text)r"
2302
class MalformedPatches(BadBundle):
2253
class MalformedPatches(BadBundle):
2304
2255
_fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2307
class MalformedFooter(BadBundle):
2258
class MalformedFooter(BadBundle):
2309
2260
_fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2312
2263
class UnsupportedEOLMarker(BadBundle):
2314
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2265
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2316
2267
def __init__(self):
2317
# XXX: BadBundle's constructor assumes there's explanatory text,
2268
# XXX: BadBundle's constructor assumes there's explanatory text,
2318
2269
# but for this there is not
2319
2270
BzrError.__init__(self)
2322
2273
class IncompatibleBundleFormat(BzrError):
2324
2275
_fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2326
2277
def __init__(self, bundle_format, other):
2355
2306
self.transport = transport
2309
class NoSmartServer(NotBranchError):
2311
_fmt = "No smart server available at %(url)s"
2313
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
2314
def __init__(self, url):
2358
2318
class UnknownSSH(BzrError):
2360
2320
_fmt = "Unrecognised value for BZR_SSH environment variable: %(vendor)s"
2542
2502
class MalformedBugIdentifier(BzrError):
2544
_fmt = ('Did not understand bug identifier %(bug_id)s: %(reason)s. '
2545
'See "bzr help bugs" for more information on this feature.')
2504
_fmt = "Did not understand bug identifier %(bug_id)s: %(reason)s"
2547
2506
def __init__(self, bug_id, reason):
2548
2507
self.bug_id = bug_id
2569
2528
self.branch = branch
2572
class InvalidLineInBugsProperty(BzrError):
2574
_fmt = ("Invalid line in bugs property: '%(line)s'")
2576
def __init__(self, line):
2580
class InvalidBugStatus(BzrError):
2582
_fmt = ("Invalid bug status: '%(status)s'")
2584
def __init__(self, status):
2585
self.status = status
2588
2531
class UnexpectedSmartServerResponse(BzrError):
2590
2533
_fmt = "Could not understand response from smart server: %(response_tuple)r"
2645
2588
class UnknownContainerFormatError(ContainerError):
2647
2590
_fmt = "Unrecognised container format: %(container_format)r"
2649
2592
def __init__(self, container_format):
2650
2593
self.container_format = container_format
2755
2698
def __init__(self, bzrdir):
2756
2699
import bzrlib.urlutils as urlutils
2757
display_url = urlutils.unescape_for_display(bzrdir.user_url,
2700
display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
2759
2702
BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2826
2769
class UncommittedChanges(BzrError):
2828
_fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2829
' (See bzr status).%(more)s')
2771
_fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2831
def __init__(self, tree, more=None):
2773
def __init__(self, tree):
2836
2774
import bzrlib.urlutils as urlutils
2837
2775
display_url = urlutils.unescape_for_display(
2838
tree.user_url, 'ascii')
2839
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2776
tree.bzrdir.root_transport.base, 'ascii')
2777
BzrError.__init__(self, tree=tree, display_url=display_url)
2842
2780
class MissingTemplateVariable(BzrError):
2879
2817
class CommandAvailableInPlugin(StandardError):
2881
2819
internal_error = False
2883
2821
def __init__(self, cmd_name, plugin_metadata, provider):
2885
2823
self.plugin_metadata = plugin_metadata
2886
2824
self.cmd_name = cmd_name
2887
2825
self.provider = provider
2889
2827
def __str__(self):
2891
_fmt = ('"%s" is not a standard bzr command. \n'
2829
_fmt = ('"%s" is not a standard bzr command. \n'
2892
2830
'However, the following official plugin provides this command: %s\n'
2893
2831
'You can install it by going to: %s'
2894
% (self.cmd_name, self.plugin_metadata['name'],
2832
% (self.cmd_name, self.plugin_metadata['name'],
2895
2833
self.plugin_metadata['url']))
2900
2838
class NoPluginAvailable(BzrError):
2842
class NotATerminal(BzrError):
2844
_fmt = 'Unable to ask for a password without real terminal.'
2904
2847
class UnableEncodePath(BzrError):
2948
2891
_fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2950
2893
def __init__(self, host, port, orig_error):
2951
# nb: in python2.4 socket.error doesn't have a useful repr
2952
2894
BzrError.__init__(self, host=host, port=port,
2953
orig_error=repr(orig_error.args))
2895
orig_error=orig_error[1])
2956
2898
class UnknownRules(BzrError):
2964
2906
class HookFailed(BzrError):
2965
2907
"""Raised when a pre_change_branch_tip hook function fails anything other
2966
2908
than TipChangeRejected.
2968
Note that this exception is no longer raised, and the import is only left
2969
to be nice to code which might catch it in a plugin.
2972
2911
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2973
2912
"%(traceback_text)s%(exc_value)s")
2975
def __init__(self, hook_stage, hook_name, exc_info, warn=True):
2977
symbol_versioning.warn("BzrError HookFailed has been deprecated "
2978
"as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2914
def __init__(self, hook_stage, hook_name, exc_info):
2979
2915
import traceback
2980
2916
self.hook_stage = hook_stage
2981
2917
self.hook_name = hook_name
3018
2954
BzrError.__init__(self, invalid_id=invalid_id)
3021
class JailBreak(BzrError):
3023
_fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3025
def __init__(self, url):
3026
BzrError.__init__(self, url=url)
3029
2957
class UserAbort(BzrError):
3031
2959
_fmt = 'The user aborted the operation.'
3042
2970
class NoSuchView(BzrError):
3043
2971
"""A view does not exist.
3046
2974
_fmt = u"No such view: %(view_name)s."
3048
2976
def __init__(self, view_name):
3086
3014
class UnsuspendableWriteGroup(BzrError):
3088
3016
_fmt = ("Repository %(repository)s cannot suspend a write group.")
3090
3018
internal_error = True
3092
3020
def __init__(self, repository):
3093
3021
self.repository = repository
3096
class LossyPushToSameVCS(BzrError):
3098
_fmt = ("Lossy push not possible between %(source_branch)r and "
3099
"%(target_branch)r that are in the same VCS.")
3101
internal_error = True
3103
def __init__(self, source_branch, target_branch):
3104
self.source_branch = source_branch
3105
self.target_branch = target_branch
3108
class NoRoundtrippingSupport(BzrError):
3110
_fmt = ("Roundtripping is not supported between %(source_branch)r and "
3111
"%(target_branch)r.")
3113
internal_error = True
3115
def __init__(self, source_branch, target_branch):
3116
self.source_branch = source_branch
3117
self.target_branch = target_branch
3120
class FileTimestampUnavailable(BzrError):
3122
_fmt = "The filestamp for %(path)s is not available."
3124
internal_error = True
3126
def __init__(self, path):
3130
class NoColocatedBranchSupport(BzrError):
3132
_fmt = ("%(bzrdir)r does not support co-located branches.")
3134
def __init__(self, bzrdir):
3135
self.bzrdir = bzrdir