13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
"""Exceptions for bzr, and reporting of them.
21
20
from bzrlib import (
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:
486
486
# XXX: Should be unified with TransportError; they seem to represent the
488
488
# RBC 20060929: I think that unifiying with TransportError would be a mistake
489
# - this is finer than a TransportError - and more useful as such. It
489
# - this is finer than a TransportError - and more useful as such. It
490
490
# differentiates between 'transport has failed' and 'operation on a transport
492
492
class PathError(BzrError):
494
494
_fmt = "Generic path error: %(path)r%(extra)s)"
496
496
def __init__(self, path, extra=None):
1226
1244
not_ancestor_id=not_ancestor_id)
1229
class InstallFailed(BzrError):
1231
def __init__(self, revisions):
1232
revision_str = ", ".join(str(r) for r in revisions)
1233
msg = "Could not install revisions:\n%s" % revision_str
1234
BzrError.__init__(self, msg)
1235
self.revisions = revisions
1238
1247
class AmbiguousBase(BzrError):
1240
1249
def __init__(self, bases):
1438
class SHA1KnitCorrupt(KnitCorrupt):
1440
_fmt = ("Knit %(filename)s corrupt: sha-1 of reconstructed text does not "
1441
"match expected sha-1. key %(key)s expected sha %(expected)s actual "
1444
def __init__(self, filename, actual, expected, key, content):
1445
KnitError.__init__(self)
1446
self.filename = filename
1447
self.actual = actual
1448
self.expected = expected
1450
self.content = content
1429
1453
class KnitDataStreamIncompatible(KnitError):
1430
1454
# Not raised anymore, as we can convert data streams. In future we may
1431
1455
# need it again for more exotic cases, so we're keeping it around for now.
1470
1494
self.options = options
1497
class RetryWithNewPacks(BzrError):
1498
"""Raised when we realize that the packs on disk have changed.
1500
This is meant as more of a signaling exception, to trap between where a
1501
local error occurred and the code that can actually handle the error and
1502
code that can retry appropriately.
1505
internal_error = True
1507
_fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1510
def __init__(self, context, reload_occurred, exc_info):
1511
"""create a new RetryWithNewPacks error.
1513
:param reload_occurred: Set to True if we know that the packs have
1514
already been reloaded, and we are failing because of an in-memory
1515
cache miss. If set to True then we will ignore if a reload says
1516
nothing has changed, because we assume it has already reloaded. If
1517
False, then a reload with nothing changed will force an error.
1518
:param exc_info: The original exception traceback, so if there is a
1519
problem we can raise the original error (value from sys.exc_info())
1521
BzrError.__init__(self)
1522
self.reload_occurred = reload_occurred
1523
self.exc_info = exc_info
1524
self.orig_error = exc_info[1]
1525
# TODO: The global error handler should probably treat this by
1526
# raising/printing the original exception with a bit about
1527
# RetryWithNewPacks also not being caught
1530
class RetryAutopack(RetryWithNewPacks):
1531
"""Raised when we are autopacking and we find a missing file.
1533
Meant as a signaling exception, to tell the autopack code it should try
1537
internal_error = True
1539
_fmt = ("Pack files have changed, reload and try autopack again."
1540
" context: %(context)s %(orig_error)s")
1473
1543
class NoSuchExportFormat(BzrError):
1475
1545
_fmt = "Export format %(format)r not supported"
1477
1547
def __init__(self, format):
1532
1602
class SmartMessageHandlerError(InternalBzrError):
1534
_fmt = "The message handler raised an exception: %(exc_value)s."
1604
_fmt = ("The message handler raised an exception:\n"
1605
"%(traceback_text)s")
1536
1607
def __init__(self, exc_info):
1537
self.exc_type, self.exc_value, self.tb = exc_info
1609
self.exc_type, self.exc_value, self.exc_tb = exc_info
1610
self.exc_info = exc_info
1611
traceback_strings = traceback.format_exception(
1612
self.exc_type, self.exc_value, self.exc_tb)
1613
self.traceback_text = ''.join(traceback_strings)
1540
1616
# A set of semi-meaningful errors which can be thrown
1541
1617
class TransportNotPossible(TransportError):
1614
1692
_fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1616
def __init__(self, source, target, is_permanent=False, qual_proto=None):
1694
def __init__(self, source, target, is_permanent=False):
1617
1695
self.source = source
1618
1696
self.target = target
1619
1697
if is_permanent:
1620
1698
self.permanently = ' permanently'
1622
1700
self.permanently = ''
1623
self._qualified_proto = qual_proto
1624
1701
TransportError.__init__(self)
1626
def _requalify_url(self, url):
1627
"""Restore the qualified proto in front of the url"""
1628
# When this exception is raised, source and target are in
1629
# user readable format. But some transports may use a
1630
# different proto (http+urllib:// will present http:// to
1631
# the user. If a qualified proto is specified, the code
1632
# trapping the exception can get the qualified urls to
1633
# properly handle the redirection themself (creating a
1634
# new transport object from the target url for example).
1635
# But checking that the scheme of the original and
1636
# redirected urls are the same can be tricky. (see the
1637
# FIXME in BzrDir.open_from_transport for the unique use
1639
if self._qualified_proto is None:
1642
# The TODO related to NotBranchError mention that doing
1643
# that kind of manipulation on the urls may not be the
1644
# exception object job. On the other hand, this object is
1645
# the interface between the code and the user so
1646
# presenting the urls in different ways is indeed its
1649
proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1650
return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1653
def get_source_url(self):
1654
return self._requalify_url(self.source)
1656
def get_target_url(self):
1657
return self._requalify_url(self.target)
1660
1704
class TooManyRedirections(TransportError):
1968
2013
class BadConversionTarget(BzrError):
1970
_fmt = "Cannot convert to format %(format)s. %(problem)s"
2015
_fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
1972
def __init__(self, problem, format):
2018
def __init__(self, problem, format, from_format=None):
1973
2019
BzrError.__init__(self)
1974
2020
self.problem = problem
1975
2021
self.format = format
2022
self.from_format = from_format or '(unspecified)'
1978
2025
class NoDiffFound(BzrError):
2132
2196
_fmt = "To use this feature you must upgrade your repository at %(path)s."
2199
class RichRootUpgradeRequired(UpgradeRequired):
2201
_fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2202
" a format which supports rich roots.")
2135
2205
class LocalRequiresBoundBranch(BzrError):
2137
2207
_fmt = "Cannot perform local-only commits on unbound branches."
2140
class MissingProgressBarFinish(BzrError):
2142
_fmt = "A nested progress bar was not 'finished' correctly."
2145
class InvalidProgressBarType(BzrError):
2147
_fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2148
" is not a supported type Select one of: %(valid_types)s")
2150
def __init__(self, bar_type, valid_types):
2151
BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2154
2210
class UnsupportedOperation(BzrError):
2156
2212
_fmt = ("The method %(mname)s is not supported on"
2216
2272
self.text = text
2219
class MalformedHeader(BadBundle):
2275
class MalformedHeader(BadBundle):
2221
2277
_fmt = "Malformed bzr revision-bundle header: %(text)r"
2224
class MalformedPatches(BadBundle):
2280
class MalformedPatches(BadBundle):
2226
2282
_fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2229
class MalformedFooter(BadBundle):
2285
class MalformedFooter(BadBundle):
2231
2287
_fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2234
2290
class UnsupportedEOLMarker(BadBundle):
2236
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2292
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2238
2294
def __init__(self):
2239
# XXX: BadBundle's constructor assumes there's explanatory text,
2295
# XXX: BadBundle's constructor assumes there's explanatory text,
2240
2296
# but for this there is not
2241
2297
BzrError.__init__(self)
2244
2300
class IncompatibleBundleFormat(BzrError):
2246
2302
_fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2248
2304
def __init__(self, bundle_format, other):
2499
2547
self.branch = branch
2550
class InvalidLineInBugsProperty(BzrError):
2552
_fmt = ("Invalid line in bugs property: '%(line)s'")
2554
def __init__(self, line):
2558
class InvalidBugStatus(BzrError):
2560
_fmt = ("Invalid bug status: '%(status)s'")
2562
def __init__(self, status):
2563
self.status = status
2502
2566
class UnexpectedSmartServerResponse(BzrError):
2504
2568
_fmt = "Could not understand response from smart server: %(response_tuple)r"
2522
2590
self.error_args = error_tuple[1:]
2593
class UnknownErrorFromSmartServer(BzrError):
2594
"""An ErrorFromSmartServer could not be translated into a typical bzrlib
2597
This is distinct from ErrorFromSmartServer so that it is possible to
2598
distinguish between the following two cases:
2599
- ErrorFromSmartServer was uncaught. This is logic error in the client
2600
and so should provoke a traceback to the user.
2601
- ErrorFromSmartServer was caught but its error_tuple could not be
2602
translated. This is probably because the server sent us garbage, and
2603
should not provoke a traceback.
2606
_fmt = "Server sent an unexpected error: %(error_tuple)r"
2608
internal_error = False
2610
def __init__(self, error_from_smart_server):
2613
:param error_from_smart_server: An ErrorFromSmartServer instance.
2615
self.error_from_smart_server = error_from_smart_server
2616
self.error_tuple = error_from_smart_server.error_tuple
2525
2619
class ContainerError(BzrError):
2526
2620
"""Base class of container errors."""
2698
2804
class UncommittedChanges(BzrError):
2700
_fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2806
_fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2807
' (See bzr status).%(more)s')
2702
def __init__(self, tree):
2809
def __init__(self, tree, more=None):
2703
2814
import bzrlib.urlutils as urlutils
2704
2815
display_url = urlutils.unescape_for_display(
2705
2816
tree.bzrdir.root_transport.base, 'ascii')
2706
BzrError.__init__(self, tree=tree, display_url=display_url)
2817
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2709
2820
class MissingTemplateVariable(BzrError):
2746
2857
class CommandAvailableInPlugin(StandardError):
2748
2859
internal_error = False
2750
2861
def __init__(self, cmd_name, plugin_metadata, provider):
2752
2863
self.plugin_metadata = plugin_metadata
2753
2864
self.cmd_name = cmd_name
2754
2865
self.provider = provider
2756
2867
def __str__(self):
2758
_fmt = ('"%s" is not a standard bzr command. \n'
2869
_fmt = ('"%s" is not a standard bzr command. \n'
2759
2870
'However, the following official plugin provides this command: %s\n'
2760
2871
'You can install it by going to: %s'
2761
% (self.cmd_name, self.plugin_metadata['name'],
2872
% (self.cmd_name, self.plugin_metadata['name'],
2762
2873
self.plugin_metadata['url']))
2767
2878
class NoPluginAvailable(BzrError):
2771
class NotATerminal(BzrError):
2773
_fmt = 'Unable to ask for a password without real terminal.'
2776
2882
class UnableEncodePath(BzrError):
2819
2926
_fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2821
2928
def __init__(self, host, port, orig_error):
2929
# nb: in python2.4 socket.error doesn't have a useful repr
2822
2930
BzrError.__init__(self, host=host, port=port,
2823
orig_error=orig_error[1])
2931
orig_error=repr(orig_error.args))
2826
2934
class UnknownRules(BzrError):
2854
2962
"""A pre_change_branch_tip hook function may raise this to cleanly and
2855
2963
explicitly abort a change to a branch tip.
2858
2966
_fmt = u"Tip change rejected: %(msg)s"
2860
2968
def __init__(self, msg):
2972
class ShelfCorrupt(BzrError):
2974
_fmt = "Shelf corrupt."
2977
class NoSuchShelfId(BzrError):
2979
_fmt = 'No changes are shelved with id "%(shelf_id)d".'
2981
def __init__(self, shelf_id):
2982
BzrError.__init__(self, shelf_id=shelf_id)
2985
class InvalidShelfId(BzrError):
2987
_fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
2989
def __init__(self, invalid_id):
2990
BzrError.__init__(self, invalid_id=invalid_id)
2993
class JailBreak(BzrError):
2995
_fmt = "An attempt to access a url outside the server jail was made: '%(url)s'."
2997
def __init__(self, url):
2998
BzrError.__init__(self, url=url)
3001
class UserAbort(BzrError):
3003
_fmt = 'The user aborted the operation.'
3006
class MustHaveWorkingTree(BzrError):
3008
_fmt = ("Branching '%(url)s'(%(format)s) must create a working tree.")
3010
def __init__(self, format, url):
3011
BzrError.__init__(self, format=format, url=url)
3014
class NoSuchView(BzrError):
3015
"""A view does not exist.
3018
_fmt = u"No such view: %(view_name)s."
3020
def __init__(self, view_name):
3021
self.view_name = view_name
3024
class ViewsNotSupported(BzrError):
3025
"""Views are not supported by a tree format.
3028
_fmt = ("Views are not supported by %(tree)s;"
3029
" use 'bzr upgrade' to change your tree to a later format.")
3031
def __init__(self, tree):
3035
class FileOutsideView(BzrError):
3037
_fmt = ('Specified file "%(file_name)s" is outside the current view: '
3040
def __init__(self, file_name, view_files):
3041
self.file_name = file_name
3042
self.view_str = ", ".join(view_files)
3045
class UnresumableWriteGroup(BzrError):
3047
_fmt = ("Repository %(repository)s cannot resume write group "
3048
"%(write_groups)r: %(reason)s")
3050
internal_error = True
3052
def __init__(self, repository, write_groups, reason):
3053
self.repository = repository
3054
self.write_groups = write_groups
3055
self.reason = reason
3058
class UnsuspendableWriteGroup(BzrError):
3060
_fmt = ("Repository %(repository)s cannot suspend a write group.")
3062
internal_error = True
3064
def __init__(self, repository):
3065
self.repository = repository
3068
class LossyPushToSameVCS(BzrError):
3070
_fmt = ("Lossy push not possible between %(source_branch)r and "
3071
"%(target_branch)r that are in the same VCS.")
3073
internal_error = True
3075
def __init__(self, source_branch, target_branch):
3076
self.source_branch = source_branch
3077
self.target_branch = target_branch