72
73
arguments can be given. The first is for generic "user" errors which
73
74
are not intended to be caught and so do not need a specific subclass.
74
75
The second case is for use with subclasses that provide a _fmt format
75
string to print the arguments.
76
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
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
82
83
:param msg: If given, this is the literal complete text for the error,
700
688
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
689
# the exception object is a bit undesirable.
702
# TODO: Probably this behavior of should be a common superclass
690
# TODO: Probably this behavior of should be a common superclass
703
691
class NotBranchError(PathError):
705
_fmt = 'Not a branch: "%(path)s"%(detail)s.'
693
_fmt = 'Not a branch: "%(path)s".'
707
def __init__(self, path, detail=None, bzrdir=None):
695
def __init__(self, path):
708
696
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)
697
self.path = urlutils.unescape_for_display(path, 'ascii')
733
700
class NoSubmitBranch(PathError):
1265
1224
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
1268
1236
class AmbiguousBase(BzrError):
1270
1238
def __init__(self, bases):
1271
symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
"as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1239
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1273
1241
msg = ("The correct base is unclear, because %s are all equally close"
1274
1242
% ", ".join(bases))
1275
1243
BzrError.__init__(self, msg)
1516
1483
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")
1565
1486
class NoSuchExportFormat(BzrError):
1567
1488
_fmt = "Export format %(format)r not supported"
1569
1490
def __init__(self, format):
1624
1545
class SmartMessageHandlerError(InternalBzrError):
1626
_fmt = ("The message handler raised an exception:\n"
1627
"%(traceback_text)s")
1547
_fmt = "The message handler raised an exception: %(exc_value)s."
1629
1549
def __init__(self, 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)
1550
self.exc_type, self.exc_value, self.tb = exc_info
1638
1553
# A set of semi-meaningful errors which can be thrown
1639
1554
class TransportNotPossible(TransportError):
1714
1627
_fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1716
def __init__(self, source, target, is_permanent=False):
1629
def __init__(self, source, target, is_permanent=False, qual_proto=None):
1717
1630
self.source = source
1718
1631
self.target = target
1719
1632
if is_permanent:
1720
1633
self.permanently = ' permanently'
1722
1635
self.permanently = ''
1636
self._qualified_proto = qual_proto
1723
1637
TransportError.__init__(self)
1639
def _requalify_url(self, url):
1640
"""Restore the qualified proto in front of the url"""
1641
# When this exception is raised, source and target are in
1642
# user readable format. But some transports may use a
1643
# different proto (http+urllib:// will present http:// to
1644
# the user. If a qualified proto is specified, the code
1645
# trapping the exception can get the qualified urls to
1646
# properly handle the redirection themself (creating a
1647
# new transport object from the target url for example).
1648
# But checking that the scheme of the original and
1649
# redirected urls are the same can be tricky. (see the
1650
# FIXME in BzrDir.open_from_transport for the unique use
1652
if self._qualified_proto is None:
1655
# The TODO related to NotBranchError mention that doing
1656
# that kind of manipulation on the urls may not be the
1657
# exception object job. On the other hand, this object is
1658
# the interface between the code and the user so
1659
# presenting the urls in different ways is indeed its
1662
proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1663
return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1666
def get_source_url(self):
1667
return self._requalify_url(self.source)
1669
def get_target_url(self):
1670
return self._requalify_url(self.target)
1726
1673
class TooManyRedirections(TransportError):
2229
2146
_fmt = "To use this feature you must upgrade your repository at %(path)s."
2232
class RichRootUpgradeRequired(UpgradeRequired):
2234
_fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2235
" a format which supports rich roots.")
2238
2149
class LocalRequiresBoundBranch(BzrError):
2240
2151
_fmt = "Cannot perform local-only commits on unbound branches."
2154
class MissingProgressBarFinish(BzrError):
2156
_fmt = "A nested progress bar was not 'finished' correctly."
2159
class InvalidProgressBarType(BzrError):
2161
_fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2162
" is not a supported type Select one of: %(valid_types)s")
2164
def __init__(self, bar_type, valid_types):
2165
BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2243
2168
class UnsupportedOperation(BzrError):
2245
2170
_fmt = ("The method %(mname)s is not supported on"
2305
2230
self.text = text
2308
class MalformedHeader(BadBundle):
2233
class MalformedHeader(BadBundle):
2310
2235
_fmt = "Malformed bzr revision-bundle header: %(text)r"
2313
class MalformedPatches(BadBundle):
2238
class MalformedPatches(BadBundle):
2315
2240
_fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2318
class MalformedFooter(BadBundle):
2243
class MalformedFooter(BadBundle):
2320
2245
_fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2323
2248
class UnsupportedEOLMarker(BadBundle):
2325
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2250
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2327
2252
def __init__(self):
2328
# XXX: BadBundle's constructor assumes there's explanatory text,
2253
# XXX: BadBundle's constructor assumes there's explanatory text,
2329
2254
# but for this there is not
2330
2255
BzrError.__init__(self)
2333
2258
class IncompatibleBundleFormat(BzrError):
2335
2260
_fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2337
2262
def __init__(self, bundle_format, other):
2837
2742
class UncommittedChanges(BzrError):
2839
_fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2840
' (See bzr status).%(more)s')
2744
_fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2842
def __init__(self, tree, more=None):
2746
def __init__(self, tree):
2847
2747
import bzrlib.urlutils as urlutils
2848
2748
display_url = urlutils.unescape_for_display(
2849
tree.user_url, 'ascii')
2850
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2749
tree.bzrdir.root_transport.base, 'ascii')
2750
BzrError.__init__(self, tree=tree, display_url=display_url)
2853
2753
class MissingTemplateVariable(BzrError):
2890
2790
class CommandAvailableInPlugin(StandardError):
2892
2792
internal_error = False
2894
2794
def __init__(self, cmd_name, plugin_metadata, provider):
2896
2796
self.plugin_metadata = plugin_metadata
2897
2797
self.cmd_name = cmd_name
2898
2798
self.provider = provider
2900
2800
def __str__(self):
2902
_fmt = ('"%s" is not a standard bzr command. \n'
2802
_fmt = ('"%s" is not a standard bzr command. \n'
2903
2803
'However, the following official plugin provides this command: %s\n'
2904
2804
'You can install it by going to: %s'
2905
% (self.cmd_name, self.plugin_metadata['name'],
2805
% (self.cmd_name, self.plugin_metadata['name'],
2906
2806
self.plugin_metadata['url']))
2911
2811
class NoPluginAvailable(BzrError):
2815
class NotATerminal(BzrError):
2817
_fmt = 'Unable to ask for a password without real terminal.'
2915
2820
class UnableEncodePath(BzrError):
2975
2879
class HookFailed(BzrError):
2976
2880
"""Raised when a pre_change_branch_tip hook function fails anything other
2977
2881
than TipChangeRejected.
2979
Note that this exception is no longer raised, and the import is only left
2980
to be nice to code which might catch it in a plugin.
2983
2884
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2984
2885
"%(traceback_text)s%(exc_value)s")
2986
def __init__(self, hook_stage, hook_name, exc_info, warn=True):
2988
symbol_versioning.warn("BzrError HookFailed has been deprecated "
2989
"as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2887
def __init__(self, hook_stage, hook_name, exc_info):
2990
2888
import traceback
2991
2889
self.hook_stage = hook_stage
2992
2890
self.hook_name = hook_name
3001
2899
"""A pre_change_branch_tip hook function may raise this to cleanly and
3002
2900
explicitly abort a change to a branch tip.
3005
2903
_fmt = u"Tip change rejected: %(msg)s"
3007
2905
def __init__(self, msg):
3011
class ShelfCorrupt(BzrError):
3013
_fmt = "Shelf corrupt."
3016
class NoSuchShelfId(BzrError):
3018
_fmt = 'No changes are shelved with id "%(shelf_id)d".'
3020
def __init__(self, shelf_id):
3021
BzrError.__init__(self, shelf_id=shelf_id)
3024
class InvalidShelfId(BzrError):
3026
_fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3028
def __init__(self, invalid_id):
3029
BzrError.__init__(self, invalid_id=invalid_id)
3032
class JailBreak(BzrError):
3034
_fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3036
def __init__(self, url):
3037
BzrError.__init__(self, url=url)
3040
class UserAbort(BzrError):
3042
_fmt = 'The user aborted the operation.'
3045
class MustHaveWorkingTree(BzrError):
3047
_fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3049
def __init__(self, format, url):
3050
BzrError.__init__(self, format=format, url=url)
3053
class NoSuchView(BzrError):
3054
"""A view does not exist.
3057
_fmt = u"No such view: %(view_name)s."
3059
def __init__(self, view_name):
3060
self.view_name = view_name
3063
class ViewsNotSupported(BzrError):
3064
"""Views are not supported by a tree format.
3067
_fmt = ("Views are not supported by %(tree)s;"
3068
" use 'bzr upgrade' to change your tree to a later format.")
3070
def __init__(self, tree):
3074
class FileOutsideView(BzrError):
3076
_fmt = ('Specified file "%(file_name)s" is outside the current view: '
3079
def __init__(self, file_name, view_files):
3080
self.file_name = file_name
3081
self.view_str = ", ".join(view_files)
3084
class UnresumableWriteGroup(BzrError):
3086
_fmt = ("Repository %(repository)s cannot resume write group "
3087
"%(write_groups)r: %(reason)s")
3089
internal_error = True
3091
def __init__(self, repository, write_groups, reason):
3092
self.repository = repository
3093
self.write_groups = write_groups
3094
self.reason = reason
3097
class UnsuspendableWriteGroup(BzrError):
3099
_fmt = ("Repository %(repository)s cannot suspend a write group.")
3101
internal_error = True
3103
def __init__(self, repository):
3104
self.repository = repository
3107
class LossyPushToSameVCS(BzrError):
3109
_fmt = ("Lossy push not possible between %(source_branch)r and "
3110
"%(target_branch)r that are in the same VCS.")
3112
internal_error = True
3114
def __init__(self, source_branch, target_branch):
3115
self.source_branch = source_branch
3116
self.target_branch = target_branch
3119
class NoRoundtrippingSupport(BzrError):
3121
_fmt = ("Roundtripping is not supported between %(source_branch)r and "
3122
"%(target_branch)r.")
3124
internal_error = True
3126
def __init__(self, source_branch, target_branch):
3127
self.source_branch = source_branch
3128
self.target_branch = target_branch
3131
class FileTimestampUnavailable(BzrError):
3133
_fmt = "The filestamp for %(path)s is not available."
3135
internal_error = True
3137
def __init__(self, path):
3141
class NoColocatedBranchSupport(BzrError):
3143
_fmt = ("%(bzrdir)r does not support co-located branches.")
3145
def __init__(self, bzrdir):
3146
self.bzrdir = bzrdir
3148
class NoWhoami(BzrError):
3150
_fmt = ('Unable to determine your name.\n'
3151
"Please, set your name with the 'whoami' command.\n"
3152
'E.g. bzr whoami "Your Name <name@example.com>"')