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.
72
72
arguments can be given. The first is for generic "user" errors which
73
73
are not intended to be caught and so do not need a specific subclass.
74
74
The second case is for use with subclasses that provide a _fmt format
75
string to print the arguments.
75
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
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
82
82
:param msg: If given, this is the literal complete text for the error,
690
700
# TODO: This is given a URL; we try to unescape it but doing that from inside
691
701
# the exception object is a bit undesirable.
692
# TODO: Probably this behavior of should be a common superclass
702
# TODO: Probably this behavior of should be a common superclass
693
703
class NotBranchError(PathError):
695
_fmt = 'Not a branch: "%(path)s".'
705
_fmt = 'Not a branch: "%(path)s"%(detail)s.'
697
def __init__(self, path):
707
def __init__(self, path, detail=None, bzrdir=None):
698
708
import bzrlib.urlutils as urlutils
699
self.path = urlutils.unescape_for_display(path, 'ascii')
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)
702
733
class NoSubmitBranch(PathError):
1226
1265
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
1268
class AmbiguousBase(BzrError):
1240
1270
def __init__(self, bases):
1241
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1271
symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1272
"as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1243
1273
msg = ("The correct base is unclear, because %s are all equally close"
1244
1274
% ", ".join(bases))
1245
1275
BzrError.__init__(self, msg)
2166
2218
_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.")
2169
2227
class LocalRequiresBoundBranch(BzrError):
2171
2229
_fmt = "Cannot perform local-only commits on unbound branches."
2174
class InvalidProgressBarType(BzrError):
2176
_fmt = ("Environment variable BZR_PROGRESS_BAR='%(bar_type)s"
2177
" is not a supported type Select one of: %(valid_types)s")
2179
def __init__(self, bar_type, valid_types):
2180
BzrError.__init__(self, bar_type=bar_type, valid_types=valid_types)
2183
2232
class UnsupportedOperation(BzrError):
2185
2234
_fmt = ("The method %(mname)s is not supported on"
2245
2294
self.text = text
2248
class MalformedHeader(BadBundle):
2297
class MalformedHeader(BadBundle):
2250
2299
_fmt = "Malformed bzr revision-bundle header: %(text)r"
2253
class MalformedPatches(BadBundle):
2302
class MalformedPatches(BadBundle):
2255
2304
_fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2258
class MalformedFooter(BadBundle):
2307
class MalformedFooter(BadBundle):
2260
2309
_fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2263
2312
class UnsupportedEOLMarker(BadBundle):
2265
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2314
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2267
2316
def __init__(self):
2268
# XXX: BadBundle's constructor assumes there's explanatory text,
2317
# XXX: BadBundle's constructor assumes there's explanatory text,
2269
2318
# but for this there is not
2270
2319
BzrError.__init__(self)
2273
2322
class IncompatibleBundleFormat(BzrError):
2275
2324
_fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2277
2326
def __init__(self, bundle_format, other):
2757
2826
class UncommittedChanges(BzrError):
2759
_fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2828
_fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2829
' (See bzr status).%(more)s')
2761
def __init__(self, tree):
2831
def __init__(self, tree, more=None):
2762
2836
import bzrlib.urlutils as urlutils
2763
2837
display_url = urlutils.unescape_for_display(
2764
tree.bzrdir.root_transport.base, 'ascii')
2765
BzrError.__init__(self, tree=tree, display_url=display_url)
2838
tree.user_url, 'ascii')
2839
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2768
2842
class MissingTemplateVariable(BzrError):
2805
2879
class CommandAvailableInPlugin(StandardError):
2807
2881
internal_error = False
2809
2883
def __init__(self, cmd_name, plugin_metadata, provider):
2811
2885
self.plugin_metadata = plugin_metadata
2812
2886
self.cmd_name = cmd_name
2813
2887
self.provider = provider
2815
2889
def __str__(self):
2817
_fmt = ('"%s" is not a standard bzr command. \n'
2891
_fmt = ('"%s" is not a standard bzr command. \n'
2818
2892
'However, the following official plugin provides this command: %s\n'
2819
2893
'You can install it by going to: %s'
2820
% (self.cmd_name, self.plugin_metadata['name'],
2894
% (self.cmd_name, self.plugin_metadata['name'],
2821
2895
self.plugin_metadata['url']))
2826
2900
class NoPluginAvailable(BzrError):
2830
class NotATerminal(BzrError):
2832
_fmt = 'Unable to ask for a password without real terminal.'
2835
2904
class UnableEncodePath(BzrError):
2894
2964
class HookFailed(BzrError):
2895
2965
"""Raised when a pre_change_branch_tip hook function fails anything other
2896
2966
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.
2899
2972
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2900
2973
"%(traceback_text)s%(exc_value)s")
2902
def __init__(self, hook_stage, hook_name, exc_info):
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)
2903
2979
import traceback
2904
2980
self.hook_stage = hook_stage
2905
2981
self.hook_name = hook_name
2934
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)
2937
3029
class UserAbort(BzrError):
2939
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