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,
688
700
# TODO: This is given a URL; we try to unescape it but doing that from inside
689
701
# the exception object is a bit undesirable.
690
# TODO: Probably this behavior of should be a common superclass
702
# TODO: Probably this behavior of should be a common superclass
691
703
class NotBranchError(PathError):
693
_fmt = 'Not a branch: "%(path)s".'
705
_fmt = 'Not a branch: "%(path)s"%(detail)s.'
695
def __init__(self, path):
707
def __init__(self, path, detail=None, bzrdir=None):
696
708
import bzrlib.urlutils as urlutils
697
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)
700
733
class NoSubmitBranch(PathError):
1224
1265
not_ancestor_id=not_ancestor_id)
1227
class InstallFailed(BzrError):
1229
def __init__(self, revisions):
1230
revision_str = ", ".join(str(r) for r in revisions)
1231
msg = "Could not install revisions:\n%s" % revision_str
1232
BzrError.__init__(self, msg)
1233
self.revisions = revisions
1236
1268
class AmbiguousBase(BzrError):
1238
1270
def __init__(self, bases):
1239
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)
1241
1273
msg = ("The correct base is unclear, because %s are all equally close"
1242
1274
% ", ".join(bases))
1243
1275
BzrError.__init__(self, msg)
1468
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")
1471
1565
class NoSuchExportFormat(BzrError):
1473
1567
_fmt = "Export format %(format)r not supported"
1475
1569
def __init__(self, format):
1530
1624
class SmartMessageHandlerError(InternalBzrError):
1532
_fmt = "The message handler raised an exception: %(exc_value)s."
1626
_fmt = ("The message handler raised an exception:\n"
1627
"%(traceback_text)s")
1534
1629
def __init__(self, exc_info):
1535
self.exc_type, self.exc_value, self.tb = exc_info
1631
self.exc_type, self.exc_value, self.exc_tb = exc_info
1632
self.exc_info = exc_info
1633
traceback_strings = traceback.format_exception(
1634
self.exc_type, self.exc_value, self.exc_tb)
1635
self.traceback_text = ''.join(traceback_strings)
1538
1638
# A set of semi-meaningful errors which can be thrown
1539
1639
class TransportNotPossible(TransportError):
1612
1714
_fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1614
def __init__(self, source, target, is_permanent=False, qual_proto=None):
1716
def __init__(self, source, target, is_permanent=False):
1615
1717
self.source = source
1616
1718
self.target = target
1617
1719
if is_permanent:
1618
1720
self.permanently = ' permanently'
1620
1722
self.permanently = ''
1621
self._qualified_proto = qual_proto
1622
1723
TransportError.__init__(self)
1624
def _requalify_url(self, url):
1625
"""Restore the qualified proto in front of the url"""
1626
# When this exception is raised, source and target are in
1627
# user readable format. But some transports may use a
1628
# different proto (http+urllib:// will present http:// to
1629
# the user. If a qualified proto is specified, the code
1630
# trapping the exception can get the qualified urls to
1631
# properly handle the redirection themself (creating a
1632
# new transport object from the target url for example).
1633
# But checking that the scheme of the original and
1634
# redirected urls are the same can be tricky. (see the
1635
# FIXME in BzrDir.open_from_transport for the unique use
1637
if self._qualified_proto is None:
1640
# The TODO related to NotBranchError mention that doing
1641
# that kind of manipulation on the urls may not be the
1642
# exception object job. On the other hand, this object is
1643
# the interface between the code and the user so
1644
# presenting the urls in different ways is indeed its
1647
proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1648
return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1651
def get_source_url(self):
1652
return self._requalify_url(self.source)
1654
def get_target_url(self):
1655
return self._requalify_url(self.target)
1658
1726
class TooManyRedirections(TransportError):
2130
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.")
2133
2227
class LocalRequiresBoundBranch(BzrError):
2135
2229
_fmt = "Cannot perform local-only commits on unbound branches."
2138
class MissingProgressBarFinish(BzrError):
2140
_fmt = "A nested progress bar was not 'finished' correctly."
2143
class InvalidProgressBarType(BzrError):
2145
_fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2146
" is not a supported type Select one of: %(valid_types)s")
2148
def __init__(self, bar_type, valid_types):
2149
BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2152
2232
class UnsupportedOperation(BzrError):
2154
2234
_fmt = ("The method %(mname)s is not supported on"
2214
2294
self.text = text
2217
class MalformedHeader(BadBundle):
2297
class MalformedHeader(BadBundle):
2219
2299
_fmt = "Malformed bzr revision-bundle header: %(text)r"
2222
class MalformedPatches(BadBundle):
2302
class MalformedPatches(BadBundle):
2224
2304
_fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2227
class MalformedFooter(BadBundle):
2307
class MalformedFooter(BadBundle):
2229
2309
_fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2232
2312
class UnsupportedEOLMarker(BadBundle):
2234
_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"
2236
2316
def __init__(self):
2237
# XXX: BadBundle's constructor assumes there's explanatory text,
2317
# XXX: BadBundle's constructor assumes there's explanatory text,
2238
2318
# but for this there is not
2239
2319
BzrError.__init__(self)
2242
2322
class IncompatibleBundleFormat(BzrError):
2244
2324
_fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2246
2326
def __init__(self, bundle_format, other):
2726
2826
class UncommittedChanges(BzrError):
2728
_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')
2730
def __init__(self, tree):
2831
def __init__(self, tree, more=None):
2731
2836
import bzrlib.urlutils as urlutils
2732
2837
display_url = urlutils.unescape_for_display(
2733
2838
tree.bzrdir.root_transport.base, 'ascii')
2734
BzrError.__init__(self, tree=tree, display_url=display_url)
2839
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2737
2842
class MissingTemplateVariable(BzrError):
2774
2879
class CommandAvailableInPlugin(StandardError):
2776
2881
internal_error = False
2778
2883
def __init__(self, cmd_name, plugin_metadata, provider):
2780
2885
self.plugin_metadata = plugin_metadata
2781
2886
self.cmd_name = cmd_name
2782
2887
self.provider = provider
2784
2889
def __str__(self):
2786
_fmt = ('"%s" is not a standard bzr command. \n'
2891
_fmt = ('"%s" is not a standard bzr command. \n'
2787
2892
'However, the following official plugin provides this command: %s\n'
2788
2893
'You can install it by going to: %s'
2789
% (self.cmd_name, self.plugin_metadata['name'],
2894
% (self.cmd_name, self.plugin_metadata['name'],
2790
2895
self.plugin_metadata['url']))
2795
2900
class NoPluginAvailable(BzrError):
2799
class NotATerminal(BzrError):
2801
_fmt = 'Unable to ask for a password without real terminal.'
2804
2904
class UnableEncodePath(BzrError):
2862
2964
class HookFailed(BzrError):
2863
2965
"""Raised when a pre_change_branch_tip hook function fails anything other
2864
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.
2867
2972
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2868
2973
"%(traceback_text)s%(exc_value)s")
2870
def __init__(self, hook_stage, hook_name, exc_info):
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)
2871
2979
import traceback
2872
2980
self.hook_stage = hook_stage
2873
2981
self.hook_name = hook_name
2882
2990
"""A pre_change_branch_tip hook function may raise this to cleanly and
2883
2991
explicitly abort a change to a branch tip.
2886
2994
_fmt = u"Tip change rejected: %(msg)s"
2888
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