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,
83
not subject to expansion. 'msg' is used instead of 'message' because
84
python evolved and, in 2.6, forbids the use of 'message'.
84
not subject to expansion.
86
86
StandardError.__init__(self)
87
87
if msg is not None:
700
680
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
681
# the exception object is a bit undesirable.
702
# TODO: Probably this behavior of should be a common superclass
682
# TODO: Probably this behavior of should be a common superclass
703
683
class NotBranchError(PathError):
705
_fmt = 'Not a branch: "%(path)s"%(detail)s.'
685
_fmt = 'Not a branch: "%(path)s".'
707
def __init__(self, path, detail=None, bzrdir=None):
687
def __init__(self, path):
708
688
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)
689
self.path = urlutils.unescape_for_display(path, 'ascii')
733
692
class NoSubmitBranch(PathError):
1260
1216
not_ancestor_id=not_ancestor_id)
1219
class InstallFailed(BzrError):
1221
def __init__(self, revisions):
1222
revision_str = ", ".join(str(r) for r in revisions)
1223
msg = "Could not install revisions:\n%s" % revision_str
1224
BzrError.__init__(self, msg)
1225
self.revisions = revisions
1263
1228
class AmbiguousBase(BzrError):
1265
1230
def __init__(self, bases):
1266
symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1267
"as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1231
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1268
1233
msg = ("The correct base is unclear, because %s are all equally close"
1269
1234
% ", ".join(bases))
1270
1235
BzrError.__init__(self, msg)
1511
1460
self.options = options
1514
class RetryWithNewPacks(BzrError):
1515
"""Raised when we realize that the packs on disk have changed.
1517
This is meant as more of a signaling exception, to trap between where a
1518
local error occurred and the code that can actually handle the error and
1519
code that can retry appropriately.
1522
internal_error = True
1524
_fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1527
def __init__(self, context, reload_occurred, exc_info):
1528
"""create a new RetryWithNewPacks error.
1530
:param reload_occurred: Set to True if we know that the packs have
1531
already been reloaded, and we are failing because of an in-memory
1532
cache miss. If set to True then we will ignore if a reload says
1533
nothing has changed, because we assume it has already reloaded. If
1534
False, then a reload with nothing changed will force an error.
1535
:param exc_info: The original exception traceback, so if there is a
1536
problem we can raise the original error (value from sys.exc_info())
1538
BzrError.__init__(self)
1539
self.reload_occurred = reload_occurred
1540
self.exc_info = exc_info
1541
self.orig_error = exc_info[1]
1542
# TODO: The global error handler should probably treat this by
1543
# raising/printing the original exception with a bit about
1544
# RetryWithNewPacks also not being caught
1547
class RetryAutopack(RetryWithNewPacks):
1548
"""Raised when we are autopacking and we find a missing file.
1550
Meant as a signaling exception, to tell the autopack code it should try
1554
internal_error = True
1556
_fmt = ("Pack files have changed, reload and try autopack again."
1557
" context: %(context)s %(orig_error)s")
1560
1463
class NoSuchExportFormat(BzrError):
1562
1465
_fmt = "Export format %(format)r not supported"
1564
1467
def __init__(self, format):
1619
1522
class SmartMessageHandlerError(InternalBzrError):
1621
_fmt = ("The message handler raised an exception:\n"
1622
"%(traceback_text)s")
1524
_fmt = "The message handler raised an exception: %(exc_value)s."
1624
1526
def __init__(self, exc_info):
1626
self.exc_type, self.exc_value, self.exc_tb = exc_info
1627
self.exc_info = exc_info
1628
traceback_strings = traceback.format_exception(
1629
self.exc_type, self.exc_value, self.exc_tb)
1630
self.traceback_text = ''.join(traceback_strings)
1527
self.exc_type, self.exc_value, self.tb = exc_info
1633
1530
# A set of semi-meaningful errors which can be thrown
1634
1531
class TransportNotPossible(TransportError):
1709
1604
_fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1711
def __init__(self, source, target, is_permanent=False):
1606
def __init__(self, source, target, is_permanent=False, qual_proto=None):
1712
1607
self.source = source
1713
1608
self.target = target
1714
1609
if is_permanent:
1715
1610
self.permanently = ' permanently'
1717
1612
self.permanently = ''
1613
self._qualified_proto = qual_proto
1718
1614
TransportError.__init__(self)
1616
def _requalify_url(self, url):
1617
"""Restore the qualified proto in front of the url"""
1618
# When this exception is raised, source and target are in
1619
# user readable format. But some transports may use a
1620
# different proto (http+urllib:// will present http:// to
1621
# the user. If a qualified proto is specified, the code
1622
# trapping the exception can get the qualified urls to
1623
# properly handle the redirection themself (creating a
1624
# new transport object from the target url for example).
1625
# But checking that the scheme of the original and
1626
# redirected urls are the same can be tricky. (see the
1627
# FIXME in BzrDir.open_from_transport for the unique use
1629
if self._qualified_proto is None:
1632
# The TODO related to NotBranchError mention that doing
1633
# that kind of manipulation on the urls may not be the
1634
# exception object job. On the other hand, this object is
1635
# the interface between the code and the user so
1636
# presenting the urls in different ways is indeed its
1639
proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1640
return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1643
def get_source_url(self):
1644
return self._requalify_url(self.source)
1646
def get_target_url(self):
1647
return self._requalify_url(self.target)
1721
1650
class TooManyRedirections(TransportError):
2224
2122
_fmt = "To use this feature you must upgrade your repository at %(path)s."
2227
class RichRootUpgradeRequired(UpgradeRequired):
2229
_fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2230
" a format which supports rich roots.")
2233
2125
class LocalRequiresBoundBranch(BzrError):
2235
2127
_fmt = "Cannot perform local-only commits on unbound branches."
2130
class MissingProgressBarFinish(BzrError):
2132
_fmt = "A nested progress bar was not 'finished' correctly."
2135
class InvalidProgressBarType(BzrError):
2137
_fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2138
" is not a supported type Select one of: %(valid_types)s")
2140
def __init__(self, bar_type, valid_types):
2141
BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2238
2144
class UnsupportedOperation(BzrError):
2240
2146
_fmt = ("The method %(mname)s is not supported on"
2300
2206
self.text = text
2303
class MalformedHeader(BadBundle):
2209
class MalformedHeader(BadBundle):
2305
2211
_fmt = "Malformed bzr revision-bundle header: %(text)r"
2308
class MalformedPatches(BadBundle):
2214
class MalformedPatches(BadBundle):
2310
2216
_fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2313
class MalformedFooter(BadBundle):
2219
class MalformedFooter(BadBundle):
2315
2221
_fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2318
2224
class UnsupportedEOLMarker(BadBundle):
2320
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2226
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2322
2228
def __init__(self):
2323
# XXX: BadBundle's constructor assumes there's explanatory text,
2229
# XXX: BadBundle's constructor assumes there's explanatory text,
2324
2230
# but for this there is not
2325
2231
BzrError.__init__(self)
2328
2234
class IncompatibleBundleFormat(BzrError):
2330
2236
_fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2332
2238
def __init__(self, bundle_format, other):
2618
2512
self.error_args = error_tuple[1:]
2621
class UnknownErrorFromSmartServer(BzrError):
2622
"""An ErrorFromSmartServer could not be translated into a typical bzrlib
2625
This is distinct from ErrorFromSmartServer so that it is possible to
2626
distinguish between the following two cases:
2627
- ErrorFromSmartServer was uncaught. This is logic error in the client
2628
and so should provoke a traceback to the user.
2629
- ErrorFromSmartServer was caught but its error_tuple could not be
2630
translated. This is probably because the server sent us garbage, and
2631
should not provoke a traceback.
2634
_fmt = "Server sent an unexpected error: %(error_tuple)r"
2636
internal_error = False
2638
def __init__(self, error_from_smart_server):
2641
:param error_from_smart_server: An ErrorFromSmartServer instance.
2643
self.error_from_smart_server = error_from_smart_server
2644
self.error_tuple = error_from_smart_server.error_tuple
2647
2515
class ContainerError(BzrError):
2648
2516
"""Base class of container errors."""
2832
2688
class UncommittedChanges(BzrError):
2834
_fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2835
' (See bzr status).%(more)s')
2690
_fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2837
def __init__(self, tree, more=None):
2692
def __init__(self, tree):
2842
2693
import bzrlib.urlutils as urlutils
2843
2694
display_url = urlutils.unescape_for_display(
2844
tree.user_url, 'ascii')
2845
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2848
class ShelvedChanges(UncommittedChanges):
2850
_fmt = ('Working tree "%(display_url)s" has shelved changes'
2851
' (See bzr shelve --list).%(more)s')
2695
tree.bzrdir.root_transport.base, 'ascii')
2696
BzrError.__init__(self, tree=tree, display_url=display_url)
2854
2699
class MissingTemplateVariable(BzrError):
2891
2736
class CommandAvailableInPlugin(StandardError):
2893
2738
internal_error = False
2895
2740
def __init__(self, cmd_name, plugin_metadata, provider):
2897
2742
self.plugin_metadata = plugin_metadata
2898
2743
self.cmd_name = cmd_name
2899
2744
self.provider = provider
2901
2746
def __str__(self):
2903
_fmt = ('"%s" is not a standard bzr command. \n'
2748
_fmt = ('"%s" is not a standard bzr command. \n'
2904
2749
'However, the following official plugin provides this command: %s\n'
2905
2750
'You can install it by going to: %s'
2906
% (self.cmd_name, self.plugin_metadata['name'],
2751
% (self.cmd_name, self.plugin_metadata['name'],
2907
2752
self.plugin_metadata['url']))
2912
2757
class NoPluginAvailable(BzrError):
2761
class NotATerminal(BzrError):
2763
_fmt = 'Unable to ask for a password without real terminal.'
2916
2766
class UnableEncodePath(BzrError):
2976
2824
class HookFailed(BzrError):
2977
2825
"""Raised when a pre_change_branch_tip hook function fails anything other
2978
2826
than TipChangeRejected.
2980
Note that this exception is no longer raised, and the import is only left
2981
to be nice to code which might catch it in a plugin.
2984
2829
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2985
2830
"%(traceback_text)s%(exc_value)s")
2987
def __init__(self, hook_stage, hook_name, exc_info, warn=True):
2989
symbol_versioning.warn("BzrError HookFailed has been deprecated "
2990
"as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2832
def __init__(self, hook_stage, hook_name, exc_info):
2991
2833
import traceback
2992
2834
self.hook_stage = hook_stage
2993
2835
self.hook_name = hook_name
3002
2844
"""A pre_change_branch_tip hook function may raise this to cleanly and
3003
2845
explicitly abort a change to a branch tip.
3006
2848
_fmt = u"Tip change rejected: %(msg)s"
3008
2850
def __init__(self, msg):
3012
class ShelfCorrupt(BzrError):
3014
_fmt = "Shelf corrupt."
3017
class NoSuchShelfId(BzrError):
3019
_fmt = 'No changes are shelved with id "%(shelf_id)d".'
3021
def __init__(self, shelf_id):
3022
BzrError.__init__(self, shelf_id=shelf_id)
3025
class InvalidShelfId(BzrError):
3027
_fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
3029
def __init__(self, invalid_id):
3030
BzrError.__init__(self, invalid_id=invalid_id)
3033
class JailBreak(BzrError):
3035
_fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
3037
def __init__(self, url):
3038
BzrError.__init__(self, url=url)
3041
class UserAbort(BzrError):
3043
_fmt = 'The user aborted the operation.'
3046
class MustHaveWorkingTree(BzrError):
3048
_fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3050
def __init__(self, format, url):
3051
BzrError.__init__(self, format=format, url=url)
3054
class NoSuchView(BzrError):
3055
"""A view does not exist.
3058
_fmt = u"No such view: %(view_name)s."
3060
def __init__(self, view_name):
3061
self.view_name = view_name
3064
class ViewsNotSupported(BzrError):
3065
"""Views are not supported by a tree format.
3068
_fmt = ("Views are not supported by %(tree)s;"
3069
" use 'bzr upgrade' to change your tree to a later format.")
3071
def __init__(self, tree):
3075
class FileOutsideView(BzrError):
3077
_fmt = ('Specified file "%(file_name)s" is outside the current view: '
3080
def __init__(self, file_name, view_files):
3081
self.file_name = file_name
3082
self.view_str = ", ".join(view_files)
3085
class UnresumableWriteGroup(BzrError):
3087
_fmt = ("Repository %(repository)s cannot resume write group "
3088
"%(write_groups)r: %(reason)s")
3090
internal_error = True
3092
def __init__(self, repository, write_groups, reason):
3093
self.repository = repository
3094
self.write_groups = write_groups
3095
self.reason = reason
3098
class UnsuspendableWriteGroup(BzrError):
3100
_fmt = ("Repository %(repository)s cannot suspend a write group.")
3102
internal_error = True
3104
def __init__(self, repository):
3105
self.repository = repository
3108
class LossyPushToSameVCS(BzrError):
3110
_fmt = ("Lossy push not possible between %(source_branch)r and "
3111
"%(target_branch)r that are in the same VCS.")
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 NoRoundtrippingSupport(BzrError):
3122
_fmt = ("Roundtripping is not supported between %(source_branch)r and "
3123
"%(target_branch)r.")
3125
internal_error = True
3127
def __init__(self, source_branch, target_branch):
3128
self.source_branch = source_branch
3129
self.target_branch = target_branch
3132
class FileTimestampUnavailable(BzrError):
3134
_fmt = "The filestamp for %(path)s is not available."
3136
internal_error = True
3138
def __init__(self, path):
3142
class NoColocatedBranchSupport(BzrError):
3144
_fmt = ("%(bzrdir)r does not support co-located branches.")
3146
def __init__(self, bzrdir):
3147
self.bzrdir = bzrdir
3150
class NoWhoami(BzrError):
3152
_fmt = ('Unable to determine your name.\n'
3153
"Please, set your name with the 'whoami' command.\n"
3154
'E.g. bzr whoami "Your Name <name@example.com>"')
3157
class InvalidPattern(BzrError):
3159
_fmt = ('Invalid pattern(s) found. %(msg)s')
3161
def __init__(self, msg):
3165
class RecursiveBind(BzrError):
3167
_fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
3168
'Please use `bzr unbind` to fix.')
3170
def __init__(self, branch_url):
3171
self.branch_url = branch_url