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.
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,
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):
700
690
# TODO: This is given a URL; we try to unescape it but doing that from inside
701
691
# the exception object is a bit undesirable.
702
# TODO: Probably this behavior of should be a common superclass
692
# TODO: Probably this behavior of should be a common superclass
703
693
class NotBranchError(PathError):
705
_fmt = 'Not a branch: "%(path)s"%(detail)s.'
695
_fmt = 'Not a branch: "%(path)s".'
707
def __init__(self, path, detail=None, bzrdir=None):
697
def __init__(self, path):
708
698
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)
699
self.path = urlutils.unescape_for_display(path, 'ascii')
733
702
class NoSubmitBranch(PathError):
1260
1226
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
1263
1238
class AmbiguousBase(BzrError):
1265
1240
def __init__(self, bases):
1266
symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
1267
"as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1241
warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1268
1243
msg = ("The correct base is unclear, because %s are all equally close"
1269
1244
% ", ".join(bases))
1270
1245
BzrError.__init__(self, msg)
2224
2166
_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
2169
class LocalRequiresBoundBranch(BzrError):
2235
2171
_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)
2238
2183
class UnsupportedOperation(BzrError):
2240
2185
_fmt = ("The method %(mname)s is not supported on"
2300
2245
self.text = text
2303
class MalformedHeader(BadBundle):
2248
class MalformedHeader(BadBundle):
2305
2250
_fmt = "Malformed bzr revision-bundle header: %(text)r"
2308
class MalformedPatches(BadBundle):
2253
class MalformedPatches(BadBundle):
2310
2255
_fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2313
class MalformedFooter(BadBundle):
2258
class MalformedFooter(BadBundle):
2315
2260
_fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2318
2263
class UnsupportedEOLMarker(BadBundle):
2320
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2265
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2322
2267
def __init__(self):
2323
# XXX: BadBundle's constructor assumes there's explanatory text,
2268
# XXX: BadBundle's constructor assumes there's explanatory text,
2324
2269
# but for this there is not
2325
2270
BzrError.__init__(self)
2328
2273
class IncompatibleBundleFormat(BzrError):
2330
2275
_fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2332
2277
def __init__(self, bundle_format, other):
2832
2757
class UncommittedChanges(BzrError):
2834
_fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2835
' (See bzr status).%(more)s')
2759
_fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2837
def __init__(self, tree, more=None):
2761
def __init__(self, tree):
2842
2762
import bzrlib.urlutils as urlutils
2843
2763
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')
2764
tree.bzrdir.root_transport.base, 'ascii')
2765
BzrError.__init__(self, tree=tree, display_url=display_url)
2854
2768
class MissingTemplateVariable(BzrError):
2891
2805
class CommandAvailableInPlugin(StandardError):
2893
2807
internal_error = False
2895
2809
def __init__(self, cmd_name, plugin_metadata, provider):
2897
2811
self.plugin_metadata = plugin_metadata
2898
2812
self.cmd_name = cmd_name
2899
2813
self.provider = provider
2901
2815
def __str__(self):
2903
_fmt = ('"%s" is not a standard bzr command. \n'
2817
_fmt = ('"%s" is not a standard bzr command. \n'
2904
2818
'However, the following official plugin provides this command: %s\n'
2905
2819
'You can install it by going to: %s'
2906
% (self.cmd_name, self.plugin_metadata['name'],
2820
% (self.cmd_name, self.plugin_metadata['name'],
2907
2821
self.plugin_metadata['url']))
2912
2826
class NoPluginAvailable(BzrError):
2830
class NotATerminal(BzrError):
2832
_fmt = 'Unable to ask for a password without real terminal.'
2916
2835
class UnableEncodePath(BzrError):
2960
2879
_fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2962
2881
def __init__(self, host, port, orig_error):
2963
# nb: in python2.4 socket.error doesn't have a useful repr
2964
2882
BzrError.__init__(self, host=host, port=port,
2965
orig_error=repr(orig_error.args))
2883
orig_error=orig_error[1])
2968
2886
class UnknownRules(BzrError):
2976
2894
class HookFailed(BzrError):
2977
2895
"""Raised when a pre_change_branch_tip hook function fails anything other
2978
2896
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
2899
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2985
2900
"%(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)
2902
def __init__(self, hook_stage, hook_name, exc_info):
2991
2903
import traceback
2992
2904
self.hook_stage = hook_stage
2993
2905
self.hook_name = hook_name
3050
2954
def __init__(self, format, url):
3051
2955
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