73
72
arguments can be given. The first is for generic "user" errors which
74
73
are not intended to be caught and so do not need a specific subclass.
75
74
The second case is for use with subclasses that provide a _fmt format
76
string to print the arguments.
75
string to print the arguments.
78
Keyword arguments are taken as parameters to the error, which can
79
be inserted into the format string template. It's recommended
80
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
83
82
:param msg: If given, this is the literal complete text for the error,
84
not subject to expansion.
83
not subject to expansion. 'msg' is used instead of 'message' because
84
python evolved and, in 2.6, forbids the use of 'message'.
86
86
StandardError.__init__(self)
87
87
if msg is not None:
93
93
for key, value in kwds.items():
94
94
setattr(self, key, value)
97
97
s = getattr(self, '_preformatted_string', None)
99
# contains a preformatted message; must be cast to plain str
99
# contains a preformatted message
102
102
fmt = self._get_format_string()
104
104
d = dict(self.__dict__)
105
# special case: python2.5 puts the 'message' attribute in a
106
# slot, so it isn't seen in __dict__
107
d['message'] = getattr(self, 'message', 'no message')
109
106
# __str__() should always return a 'str' object
110
107
# never a 'unicode' object.
111
if isinstance(s, unicode):
112
return s.encode('utf8')
114
109
except (AttributeError, TypeError, NameError, ValueError, KeyError), e:
115
110
return 'Unprintable exception %s: dict=%r, fmt=%r, error=%r' \
667
700
# TODO: This is given a URL; we try to unescape it but doing that from inside
668
701
# the exception object is a bit undesirable.
669
# TODO: Probably this behavior of should be a common superclass
702
# TODO: Probably this behavior of should be a common superclass
670
703
class NotBranchError(PathError):
672
_fmt = 'Not a branch: "%(path)s".'
705
_fmt = 'Not a branch: "%(path)s"%(detail)s.'
674
def __init__(self, path):
707
def __init__(self, path, detail=None, bzrdir=None):
675
708
import bzrlib.urlutils as urlutils
676
self.path = urlutils.unescape_for_display(path, 'ascii')
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)
679
733
class NoSubmitBranch(PathError):
762
816
class IncompatibleRepositories(BzrError):
764
_fmt = "Repository %(target)s is not compatible with repository"\
767
def __init__(self, source, target):
768
BzrError.__init__(self, target=target, source=source)
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
_fmt = "%(target)s\n" \
825
"is not compatible with\n" \
829
def __init__(self, source, target, details=None):
831
details = "(no details)"
832
BzrError.__init__(self, target=target, source=source, details=details)
771
835
class IncompatibleRevision(BzrError):
773
837
_fmt = "Revision is not compatible with %(repo_format)s"
775
839
def __init__(self, repo_format):
1199
1265
not_ancestor_id=not_ancestor_id)
1202
class InstallFailed(BzrError):
1204
def __init__(self, revisions):
1205
revision_str = ", ".join(str(r) for r in revisions)
1206
msg = "Could not install revisions:\n%s" % revision_str
1207
BzrError.__init__(self, msg)
1208
self.revisions = revisions
1211
1268
class AmbiguousBase(BzrError):
1213
1270
def __init__(self, bases):
1214
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1271
symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
"as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1216
1273
msg = ("The correct base is unclear, because %s are all equally close"
1217
1274
% ", ".join(bases))
1218
1275
BzrError.__init__(self, msg)
1443
1516
self.options = options
1519
class RetryWithNewPacks(BzrError):
1520
"""Raised when we realize that the packs on disk have changed.
1522
This is meant as more of a signaling exception, to trap between where a
1523
local error occurred and the code that can actually handle the error and
1524
code that can retry appropriately.
1527
internal_error = True
1529
_fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1532
def __init__(self, context, reload_occurred, exc_info):
1533
"""create a new RetryWithNewPacks error.
1535
:param reload_occurred: Set to True if we know that the packs have
1536
already been reloaded, and we are failing because of an in-memory
1537
cache miss. If set to True then we will ignore if a reload says
1538
nothing has changed, because we assume it has already reloaded. If
1539
False, then a reload with nothing changed will force an error.
1540
:param exc_info: The original exception traceback, so if there is a
1541
problem we can raise the original error (value from sys.exc_info())
1543
BzrError.__init__(self)
1544
self.reload_occurred = reload_occurred
1545
self.exc_info = exc_info
1546
self.orig_error = exc_info[1]
1547
# TODO: The global error handler should probably treat this by
1548
# raising/printing the original exception with a bit about
1549
# RetryWithNewPacks also not being caught
1552
class RetryAutopack(RetryWithNewPacks):
1553
"""Raised when we are autopacking and we find a missing file.
1555
Meant as a signaling exception, to tell the autopack code it should try
1559
internal_error = True
1561
_fmt = ("Pack files have changed, reload and try autopack again."
1562
" context: %(context)s %(orig_error)s")
1446
1565
class NoSuchExportFormat(BzrError):
1448
1567
_fmt = "Export format %(format)r not supported"
1450
1569
def __init__(self, format):
1587
1714
_fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1589
def __init__(self, source, target, is_permanent=False, qual_proto=None):
1716
def __init__(self, source, target, is_permanent=False):
1590
1717
self.source = source
1591
1718
self.target = target
1592
1719
if is_permanent:
1593
1720
self.permanently = ' permanently'
1595
1722
self.permanently = ''
1596
self._qualified_proto = qual_proto
1597
1723
TransportError.__init__(self)
1599
def _requalify_url(self, url):
1600
"""Restore the qualified proto in front of the url"""
1601
# When this exception is raised, source and target are in
1602
# user readable format. But some transports may use a
1603
# different proto (http+urllib:// will present http:// to
1604
# the user. If a qualified proto is specified, the code
1605
# trapping the exception can get the qualified urls to
1606
# properly handle the redirection themself (creating a
1607
# new transport object from the target url for example).
1608
# But checking that the scheme of the original and
1609
# redirected urls are the same can be tricky. (see the
1610
# FIXME in BzrDir.open_from_transport for the unique use
1612
if self._qualified_proto is None:
1615
# The TODO related to NotBranchError mention that doing
1616
# that kind of manipulation on the urls may not be the
1617
# exception object job. On the other hand, this object is
1618
# the interface between the code and the user so
1619
# presenting the urls in different ways is indeed its
1622
proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1623
return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1626
def get_source_url(self):
1627
return self._requalify_url(self.source)
1629
def get_target_url(self):
1630
return self._requalify_url(self.target)
1633
1726
class TooManyRedirections(TransportError):
2105
2218
_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.")
2108
2227
class LocalRequiresBoundBranch(BzrError):
2110
2229
_fmt = "Cannot perform local-only commits on unbound branches."
2113
class MissingProgressBarFinish(BzrError):
2115
_fmt = "A nested progress bar was not 'finished' correctly."
2118
class InvalidProgressBarType(BzrError):
2120
_fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2121
" is not a supported type Select one of: %(valid_types)s")
2123
def __init__(self, bar_type, valid_types):
2124
BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2127
2232
class UnsupportedOperation(BzrError):
2129
2234
_fmt = ("The method %(mname)s is not supported on"
2189
2294
self.text = text
2192
class MalformedHeader(BadBundle):
2297
class MalformedHeader(BadBundle):
2194
2299
_fmt = "Malformed bzr revision-bundle header: %(text)r"
2197
class MalformedPatches(BadBundle):
2302
class MalformedPatches(BadBundle):
2199
2304
_fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2202
class MalformedFooter(BadBundle):
2307
class MalformedFooter(BadBundle):
2204
2309
_fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2207
2312
class UnsupportedEOLMarker(BadBundle):
2209
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2314
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2211
2316
def __init__(self):
2212
# XXX: BadBundle's constructor assumes there's explanatory text,
2317
# XXX: BadBundle's constructor assumes there's explanatory text,
2213
2318
# but for this there is not
2214
2319
BzrError.__init__(self)
2217
2322
class IncompatibleBundleFormat(BzrError):
2219
2324
_fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2221
2326
def __init__(self, bundle_format, other):
2482
2612
self.error_args = error_tuple[1:]
2615
class UnknownErrorFromSmartServer(BzrError):
2616
"""An ErrorFromSmartServer could not be translated into a typical bzrlib
2619
This is distinct from ErrorFromSmartServer so that it is possible to
2620
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.
2628
_fmt = "Server sent an unexpected error: %(error_tuple)r"
2630
internal_error = False
2632
def __init__(self, error_from_smart_server):
2635
:param error_from_smart_server: An ErrorFromSmartServer instance.
2637
self.error_from_smart_server = error_from_smart_server
2638
self.error_tuple = error_from_smart_server.error_tuple
2485
2641
class ContainerError(BzrError):
2486
2642
"""Base class of container errors."""
2658
2826
class UncommittedChanges(BzrError):
2660
_fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2828
_fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2829
' (See bzr status).%(more)s')
2662
def __init__(self, tree):
2831
def __init__(self, tree, more=None):
2663
2836
import bzrlib.urlutils as urlutils
2664
2837
display_url = urlutils.unescape_for_display(
2665
tree.bzrdir.root_transport.base, 'ascii')
2666
BzrError.__init__(self, tree=tree, display_url=display_url)
2838
tree.user_url, 'ascii')
2839
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2669
2842
class MissingTemplateVariable(BzrError):
2706
2879
class CommandAvailableInPlugin(StandardError):
2708
2881
internal_error = False
2710
2883
def __init__(self, cmd_name, plugin_metadata, provider):
2712
2885
self.plugin_metadata = plugin_metadata
2713
2886
self.cmd_name = cmd_name
2714
2887
self.provider = provider
2716
2889
def __str__(self):
2718
_fmt = ('"%s" is not a standard bzr command. \n'
2891
_fmt = ('"%s" is not a standard bzr command. \n'
2719
2892
'However, the following official plugin provides this command: %s\n'
2720
2893
'You can install it by going to: %s'
2721
% (self.cmd_name, self.plugin_metadata['name'],
2894
% (self.cmd_name, self.plugin_metadata['name'],
2722
2895
self.plugin_metadata['url']))
2727
2900
class NoPluginAvailable(BzrError):
2731
class NotATerminal(BzrError):
2733
_fmt = 'Unable to ask for a password without real terminal.'
2736
2904
class UnableEncodePath(BzrError):
2790
2960
def __init__(self, unknowns):
2791
2961
BzrError.__init__(self, unknowns_str=", ".join(unknowns))
2964
class HookFailed(BzrError):
2965
"""Raised when a pre_change_branch_tip hook function fails anything other
2966
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
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2973
"%(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)
2980
self.hook_stage = hook_stage
2981
self.hook_name = hook_name
2982
self.exc_info = exc_info
2983
self.exc_type = exc_info[0]
2984
self.exc_value = exc_info[1]
2985
self.exc_tb = exc_info[2]
2986
self.traceback_text = ''.join(traceback.format_tb(self.exc_tb))
2989
class TipChangeRejected(BzrError):
2990
"""A pre_change_branch_tip hook function may raise this to cleanly and
2991
explicitly abort a change to a branch tip.
2994
_fmt = u"Tip change rejected: %(msg)s"
2996
def __init__(self, msg):
3000
class ShelfCorrupt(BzrError):
3002
_fmt = "Shelf corrupt."
3005
class NoSuchShelfId(BzrError):
3007
_fmt = 'No changes are shelved with id "%(shelf_id)d".'
3009
def __init__(self, shelf_id):
3010
BzrError.__init__(self, shelf_id=shelf_id)
3013
class InvalidShelfId(BzrError):
3015
_fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3017
def __init__(self, invalid_id):
3018
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
class UserAbort(BzrError):
3031
_fmt = 'The user aborted the operation.'
3034
class MustHaveWorkingTree(BzrError):
3036
_fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3038
def __init__(self, format, url):
3039
BzrError.__init__(self, format=format, url=url)
3042
class NoSuchView(BzrError):
3043
"""A view does not exist.
3046
_fmt = u"No such view: %(view_name)s."
3048
def __init__(self, view_name):
3049
self.view_name = view_name
3052
class ViewsNotSupported(BzrError):
3053
"""Views are not supported by a tree format.
3056
_fmt = ("Views are not supported by %(tree)s;"
3057
" use 'bzr upgrade' to change your tree to a later format.")
3059
def __init__(self, tree):
3063
class FileOutsideView(BzrError):
3065
_fmt = ('Specified file "%(file_name)s" is outside the current view: '
3068
def __init__(self, file_name, view_files):
3069
self.file_name = file_name
3070
self.view_str = ", ".join(view_files)
3073
class UnresumableWriteGroup(BzrError):
3075
_fmt = ("Repository %(repository)s cannot resume write group "
3076
"%(write_groups)r: %(reason)s")
3078
internal_error = True
3080
def __init__(self, repository, write_groups, reason):
3081
self.repository = repository
3082
self.write_groups = write_groups
3083
self.reason = reason
3086
class UnsuspendableWriteGroup(BzrError):
3088
_fmt = ("Repository %(repository)s cannot suspend a write group.")
3090
internal_error = True
3092
def __init__(self, repository):
3093
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