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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Exceptions for bzr, and reporting of them.
20
21
from bzrlib import (
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
691
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
692
# the exception object is a bit undesirable.
702
# TODO: Probably this behavior of should be a common superclass
693
# TODO: Probably this behavior of should be a common superclass
703
694
class NotBranchError(PathError):
705
_fmt = 'Not a branch: "%(path)s"%(detail)s.'
696
_fmt = 'Not a branch: "%(path)s".'
707
def __init__(self, path, detail=None, bzrdir=None):
698
def __init__(self, path):
708
699
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)
700
self.path = urlutils.unescape_for_display(path, 'ascii')
733
703
class NoSubmitBranch(PathError):
1265
1227
not_ancestor_id=not_ancestor_id)
1230
class InstallFailed(BzrError):
1232
def __init__(self, revisions):
1233
revision_str = ", ".join(str(r) for r in revisions)
1234
msg = "Could not install revisions:\n%s" % revision_str
1235
BzrError.__init__(self, msg)
1236
self.revisions = revisions
1268
1239
class AmbiguousBase(BzrError):
1270
1241
def __init__(self, bases):
1271
symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
"as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1242
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1273
1244
msg = ("The correct base is unclear, because %s are all equally close"
1274
1245
% ", ".join(bases))
1275
1246
BzrError.__init__(self, msg)
1527
1497
internal_error = True
1529
_fmt = ("Pack files have changed, reload and retry. context: %(context)s"
1499
_fmt = ("Pack files have changed, reload and retry. %(orig_error)s")
1532
def __init__(self, context, reload_occurred, exc_info):
1533
"""create a new RetryWithNewPacks error.
1501
def __init__(self, reload_occurred, exc_info):
1502
"""create a new RestartWithNewPacks error.
1535
1504
:param reload_occurred: Set to True if we know that the packs have
1536
1505
already been reloaded, and we are failing because of an in-memory
1549
1518
# 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
1521
class NoSuchExportFormat(BzrError):
1567
1523
_fmt = "Export format %(format)r not supported"
1569
1525
def __init__(self, format):
1624
1580
class SmartMessageHandlerError(InternalBzrError):
1626
_fmt = ("The message handler raised an exception:\n"
1627
"%(traceback_text)s")
1582
_fmt = "The message handler raised an exception: %(exc_value)s."
1629
1584
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)
1585
self.exc_type, self.exc_value, self.tb = exc_info
1638
1588
# A set of semi-meaningful errors which can be thrown
1639
1589
class TransportNotPossible(TransportError):
1714
1662
_fmt = '%(source)s is%(permanently)s redirected to %(target)s'
1716
def __init__(self, source, target, is_permanent=False):
1664
def __init__(self, source, target, is_permanent=False, qual_proto=None):
1717
1665
self.source = source
1718
1666
self.target = target
1719
1667
if is_permanent:
1720
1668
self.permanently = ' permanently'
1722
1670
self.permanently = ''
1671
self._qualified_proto = qual_proto
1723
1672
TransportError.__init__(self)
1674
def _requalify_url(self, url):
1675
"""Restore the qualified proto in front of the url"""
1676
# When this exception is raised, source and target are in
1677
# user readable format. But some transports may use a
1678
# different proto (http+urllib:// will present http:// to
1679
# the user. If a qualified proto is specified, the code
1680
# trapping the exception can get the qualified urls to
1681
# properly handle the redirection themself (creating a
1682
# new transport object from the target url for example).
1683
# But checking that the scheme of the original and
1684
# redirected urls are the same can be tricky. (see the
1685
# FIXME in BzrDir.open_from_transport for the unique use
1687
if self._qualified_proto is None:
1690
# The TODO related to NotBranchError mention that doing
1691
# that kind of manipulation on the urls may not be the
1692
# exception object job. On the other hand, this object is
1693
# the interface between the code and the user so
1694
# presenting the urls in different ways is indeed its
1697
proto, netloc, path, query, fragment = urlparse.urlsplit(url)
1698
return urlparse.urlunsplit((self._qualified_proto, netloc, path,
1701
def get_source_url(self):
1702
return self._requalify_url(self.source)
1704
def get_target_url(self):
1705
return self._requalify_url(self.target)
1726
1708
class TooManyRedirections(TransportError):
2218
2181
_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
2184
class LocalRequiresBoundBranch(BzrError):
2229
2186
_fmt = "Cannot perform local-only commits on unbound branches."
2189
class MissingProgressBarFinish(BzrError):
2191
_fmt = "A nested progress bar was not 'finished' correctly."
2194
class InvalidProgressBarType(BzrError):
2196
_fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2197
" is not a supported type Select one of: %(valid_types)s")
2199
def __init__(self, bar_type, valid_types):
2200
BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2232
2203
class UnsupportedOperation(BzrError):
2234
2205
_fmt = ("The method %(mname)s is not supported on"
2294
2265
self.text = text
2297
class MalformedHeader(BadBundle):
2268
class MalformedHeader(BadBundle):
2299
2270
_fmt = "Malformed bzr revision-bundle header: %(text)r"
2302
class MalformedPatches(BadBundle):
2273
class MalformedPatches(BadBundle):
2304
2275
_fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2307
class MalformedFooter(BadBundle):
2278
class MalformedFooter(BadBundle):
2309
2280
_fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2312
2283
class UnsupportedEOLMarker(BadBundle):
2314
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2285
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2316
2287
def __init__(self):
2317
# XXX: BadBundle's constructor assumes there's explanatory text,
2288
# XXX: BadBundle's constructor assumes there's explanatory text,
2318
2289
# but for this there is not
2319
2290
BzrError.__init__(self)
2322
2293
class IncompatibleBundleFormat(BzrError):
2324
2295
_fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2326
2297
def __init__(self, bundle_format, other):
2826
2777
class UncommittedChanges(BzrError):
2828
_fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2829
' (See bzr status).%(more)s')
2779
_fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2831
def __init__(self, tree, more=None):
2781
def __init__(self, tree):
2836
2782
import bzrlib.urlutils as urlutils
2837
2783
display_url = urlutils.unescape_for_display(
2838
tree.user_url, 'ascii')
2839
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2784
tree.bzrdir.root_transport.base, 'ascii')
2785
BzrError.__init__(self, tree=tree, display_url=display_url)
2842
2788
class MissingTemplateVariable(BzrError):
2879
2825
class CommandAvailableInPlugin(StandardError):
2881
2827
internal_error = False
2883
2829
def __init__(self, cmd_name, plugin_metadata, provider):
2885
2831
self.plugin_metadata = plugin_metadata
2886
2832
self.cmd_name = cmd_name
2887
2833
self.provider = provider
2889
2835
def __str__(self):
2891
_fmt = ('"%s" is not a standard bzr command. \n'
2837
_fmt = ('"%s" is not a standard bzr command. \n'
2892
2838
'However, the following official plugin provides this command: %s\n'
2893
2839
'You can install it by going to: %s'
2894
% (self.cmd_name, self.plugin_metadata['name'],
2840
% (self.cmd_name, self.plugin_metadata['name'],
2895
2841
self.plugin_metadata['url']))
2900
2846
class NoPluginAvailable(BzrError):
2850
class NotATerminal(BzrError):
2852
_fmt = 'Unable to ask for a password without real terminal.'
2904
2855
class UnableEncodePath(BzrError):
2964
2914
class HookFailed(BzrError):
2965
2915
"""Raised when a pre_change_branch_tip hook function fails anything other
2966
2916
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
2919
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2973
2920
"%(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)
2922
def __init__(self, hook_stage, hook_name, exc_info):
2979
2923
import traceback
2980
2924
self.hook_stage = hook_stage
2981
2925
self.hook_name = hook_name
3010
2954
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
2957
class UserAbort(BzrError):
3031
2959
_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