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):
816
775
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
_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)
777
_fmt = "Repository %(target)s is not compatible with repository"\
780
def __init__(self, source, target):
781
BzrError.__init__(self, target=target, source=source)
835
784
class IncompatibleRevision(BzrError):
837
786
_fmt = "Revision is not compatible with %(repo_format)s"
839
788
def __init__(self, repo_format):
1265
1212
not_ancestor_id=not_ancestor_id)
1215
class InstallFailed(BzrError):
1217
def __init__(self, revisions):
1218
revision_str = ", ".join(str(r) for r in revisions)
1219
msg = "Could not install revisions:\n%s" % revision_str
1220
BzrError.__init__(self, msg)
1221
self.revisions = revisions
1268
1224
class AmbiguousBase(BzrError):
1270
1226
def __init__(self, bases):
1271
symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
"as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1227
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1273
1229
msg = ("The correct base is unclear, because %s are all equally close"
1274
1230
% ", ".join(bases))
1275
1231
BzrError.__init__(self, msg)
1516
1456
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
1459
class NoSuchExportFormat(BzrError):
1567
1461
_fmt = "Export format %(format)r not supported"
1569
1463
def __init__(self, format):
1624
1518
class SmartMessageHandlerError(InternalBzrError):
1626
_fmt = ("The message handler raised an exception:\n"
1627
"%(traceback_text)s")
1520
_fmt = "The message handler raised an exception: %(exc_value)s."
1629
1522
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)
1523
self.exc_type, self.exc_value, self.tb = exc_info
1638
1526
# A set of semi-meaningful errors which can be thrown
1639
1527
class TransportNotPossible(TransportError):
1714
1600
_fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1716
def __init__(self, source, target, is_permanent=False):
1602
def __init__(self, source, target, is_permanent=False, qual_proto=None):
1717
1603
self.source = source
1718
1604
self.target = target
1719
1605
if is_permanent:
1720
1606
self.permanently = ' permanently'
1722
1608
self.permanently = ''
1609
self._qualified_proto = qual_proto
1723
1610
TransportError.__init__(self)
1612
def _requalify_url(self, url):
1613
"""Restore the qualified proto in front of the url"""
1614
# When this exception is raised, source and target are in
1615
# user readable format. But some transports may use a
1616
# different proto (http+urllib:// will present http:// to
1617
# the user. If a qualified proto is specified, the code
1618
# trapping the exception can get the qualified urls to
1619
# properly handle the redirection themself (creating a
1620
# new transport object from the target url for example).
1621
# But checking that the scheme of the original and
1622
# redirected urls are the same can be tricky. (see the
1623
# FIXME in BzrDir.open_from_transport for the unique use
1625
if self._qualified_proto is None:
1628
# The TODO related to NotBranchError mention that doing
1629
# that kind of manipulation on the urls may not be the
1630
# exception object job. On the other hand, this object is
1631
# the interface between the code and the user so
1632
# presenting the urls in different ways is indeed its
1635
proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1636
return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1639
def get_source_url(self):
1640
return self._requalify_url(self.source)
1642
def get_target_url(self):
1643
return self._requalify_url(self.target)
1726
1646
class TooManyRedirections(TransportError):
2218
2118
_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
2121
class LocalRequiresBoundBranch(BzrError):
2229
2123
_fmt = "Cannot perform local-only commits on unbound branches."
2126
class MissingProgressBarFinish(BzrError):
2128
_fmt = "A nested progress bar was not 'finished' correctly."
2131
class InvalidProgressBarType(BzrError):
2133
_fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2134
" is not a supported type Select one of: %(valid_types)s")
2136
def __init__(self, bar_type, valid_types):
2137
BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2232
2140
class UnsupportedOperation(BzrError):
2234
2142
_fmt = ("The method %(mname)s is not supported on"
2294
2202
self.text = text
2297
class MalformedHeader(BadBundle):
2205
class MalformedHeader(BadBundle):
2299
2207
_fmt = "Malformed bzr revision-bundle header: %(text)r"
2302
class MalformedPatches(BadBundle):
2210
class MalformedPatches(BadBundle):
2304
2212
_fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2307
class MalformedFooter(BadBundle):
2215
class MalformedFooter(BadBundle):
2309
2217
_fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2312
2220
class UnsupportedEOLMarker(BadBundle):
2314
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2222
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2316
2224
def __init__(self):
2317
# XXX: BadBundle's constructor assumes there's explanatory text,
2225
# XXX: BadBundle's constructor assumes there's explanatory text,
2318
2226
# but for this there is not
2319
2227
BzrError.__init__(self)
2322
2230
class IncompatibleBundleFormat(BzrError):
2324
2232
_fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2326
2234
def __init__(self, bundle_format, other):
2464
2381
self.patch_type = patch_type
2467
class TargetNotBranch(BzrError):
2468
"""A merge directive's target branch is required, but isn't a branch"""
2470
_fmt = ("Your branch does not have all of the revisions required in "
2471
"order to merge this merge directive and the target "
2472
"location specified in the merge directive is not a branch: "
2475
def __init__(self, location):
2476
BzrError.__init__(self)
2477
self.location = location
2480
2384
class UnsupportedInventoryKind(BzrError):
2482
2386
_fmt = """Unsupported entry kind %(kind)s"""
2484
2388
def __init__(self, kind):
2612
2495
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
2641
2498
class ContainerError(BzrError):
2642
2499
"""Base class of container errors."""
2826
2671
class UncommittedChanges(BzrError):
2828
_fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2829
' (See bzr status).%(more)s')
2673
_fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2831
def __init__(self, tree, more=None):
2675
def __init__(self, tree):
2836
2676
import bzrlib.urlutils as urlutils
2837
2677
display_url = urlutils.unescape_for_display(
2838
tree.user_url, 'ascii')
2839
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2678
tree.bzrdir.root_transport.base, 'ascii')
2679
BzrError.__init__(self, tree=tree, display_url=display_url)
2842
2682
class MissingTemplateVariable(BzrError):
2879
2719
class CommandAvailableInPlugin(StandardError):
2881
2721
internal_error = False
2883
2723
def __init__(self, cmd_name, plugin_metadata, provider):
2885
2725
self.plugin_metadata = plugin_metadata
2886
2726
self.cmd_name = cmd_name
2887
2727
self.provider = provider
2889
2729
def __str__(self):
2891
_fmt = ('"%s" is not a standard bzr command. \n'
2731
_fmt = ('"%s" is not a standard bzr command. \n'
2892
2732
'However, the following official plugin provides this command: %s\n'
2893
2733
'You can install it by going to: %s'
2894
% (self.cmd_name, self.plugin_metadata['name'],
2734
% (self.cmd_name, self.plugin_metadata['name'],
2895
2735
self.plugin_metadata['url']))
2900
2740
class NoPluginAvailable(BzrError):
2744
class NotATerminal(BzrError):
2746
_fmt = 'Unable to ask for a password without real terminal.'
2904
2749
class UnableEncodePath(BzrError):
2964
2807
class HookFailed(BzrError):
2965
2808
"""Raised when a pre_change_branch_tip hook function fails anything other
2966
2809
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
2812
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2973
2813
"%(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)
2815
def __init__(self, hook_stage, hook_name, exc_info):
2979
2816
import traceback
2980
2817
self.hook_stage = hook_stage
2981
2818
self.hook_name = hook_name
2990
2827
"""A pre_change_branch_tip hook function may raise this to cleanly and
2991
2828
explicitly abort a change to a branch tip.
2994
2831
_fmt = u"Tip change rejected: %(msg)s"
2996
2833
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