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,
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):
639
class UnstackableLocationError(BzrError):
641
_fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
643
def __init__(self, branch_url, target_url):
644
BzrError.__init__(self)
645
self.branch_url = branch_url
646
self.target_url = target_url
639
649
class UnstackableRepositoryFormat(BzrError):
641
651
_fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
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):
1004
1041
class LockContention(LockError):
1006
_fmt = 'Could not acquire lock "%(lock)s"'
1043
_fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
1007
1044
# TODO: show full url for lock, combining the transport and relative
1010
1047
internal_error = False
1012
def __init__(self, lock):
1049
def __init__(self, lock, msg=''):
1013
1050
self.lock = lock
1016
1054
class LockBroken(LockError):
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)
1890
1923
class CantMoveRoot(BzrError):
1892
1925
_fmt = "Moving the root directory is not supported at this time"
1928
class TransformRenameFailed(BzrError):
1930
_fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
1932
def __init__(self, from_path, to_path, why, errno):
1933
self.from_path = from_path
1934
self.to_path = to_path
1895
1939
class BzrMoveFailedError(BzrError):
2002
2046
class BadConversionTarget(BzrError):
2004
_fmt = "Cannot convert to format %(format)s. %(problem)s"
2048
_fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
2006
def __init__(self, problem, format):
2051
def __init__(self, problem, format, from_format=None):
2007
2052
BzrError.__init__(self)
2008
2053
self.problem = problem
2009
2054
self.format = format
2055
self.from_format = from_format or '(unspecified)'
2012
2058
class NoDiffFound(BzrError):
2089
2135
class OutOfDateTree(BzrError):
2091
_fmt = "Working tree is out of date, please run 'bzr update'."
2137
_fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
2093
def __init__(self, tree):
2139
def __init__(self, tree, more=None):
2094
2144
BzrError.__init__(self)
2095
2145
self.tree = tree
2098
2149
class PublicBranchOutOfDate(BzrError):
2166
2229
_fmt = "To use this feature you must upgrade your repository at %(path)s."
2232
class RichRootUpgradeRequired(UpgradeRequired):
2234
_fmt = ("To use this feature you must upgrade your branch at %(path)s to"
2235
" a format which supports rich roots.")
2169
2238
class LocalRequiresBoundBranch(BzrError):
2171
2240
_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
2243
class UnsupportedOperation(BzrError):
2185
2245
_fmt = ("The method %(mname)s is not supported on"
2245
2305
self.text = text
2248
class MalformedHeader(BadBundle):
2308
class MalformedHeader(BadBundle):
2250
2310
_fmt = "Malformed bzr revision-bundle header: %(text)r"
2253
class MalformedPatches(BadBundle):
2313
class MalformedPatches(BadBundle):
2255
2315
_fmt = "Malformed patches in bzr revision-bundle: %(text)r"
2258
class MalformedFooter(BadBundle):
2318
class MalformedFooter(BadBundle):
2260
2320
_fmt = "Malformed footer in bzr revision-bundle: %(text)r"
2263
2323
class UnsupportedEOLMarker(BadBundle):
2265
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2325
_fmt = "End of line marker was not \\n in bzr revision-bundle"
2267
2327
def __init__(self):
2268
# XXX: BadBundle's constructor assumes there's explanatory text,
2328
# XXX: BadBundle's constructor assumes there's explanatory text,
2269
2329
# but for this there is not
2270
2330
BzrError.__init__(self)
2273
2333
class IncompatibleBundleFormat(BzrError):
2275
2335
_fmt = "Bundle format %(bundle_format)s is incompatible with %(other)s"
2277
2337
def __init__(self, bundle_format, other):
2528
2580
self.branch = branch
2583
class InvalidLineInBugsProperty(BzrError):
2585
_fmt = ("Invalid line in bugs property: '%(line)s'")
2587
def __init__(self, line):
2591
class InvalidBugStatus(BzrError):
2593
_fmt = ("Invalid bug status: '%(status)s'")
2595
def __init__(self, status):
2596
self.status = status
2531
2599
class UnexpectedSmartServerResponse(BzrError):
2533
2601
_fmt = "Could not understand response from smart server: %(response_tuple)r"
2769
2837
class UncommittedChanges(BzrError):
2771
_fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
2839
_fmt = ('Working tree "%(display_url)s" has uncommitted changes'
2840
' (See bzr status).%(more)s')
2773
def __init__(self, tree):
2842
def __init__(self, tree, more=None):
2774
2847
import bzrlib.urlutils as urlutils
2775
2848
display_url = urlutils.unescape_for_display(
2776
tree.bzrdir.root_transport.base, 'ascii')
2777
BzrError.__init__(self, tree=tree, display_url=display_url)
2849
tree.user_url, 'ascii')
2850
BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
2853
class ShelvedChanges(UncommittedChanges):
2855
_fmt = ('Working tree "%(display_url)s" has shelved changes'
2856
' (See bzr shelve --list).%(more)s')
2780
2859
class MissingTemplateVariable(BzrError):
2817
2896
class CommandAvailableInPlugin(StandardError):
2819
2898
internal_error = False
2821
2900
def __init__(self, cmd_name, plugin_metadata, provider):
2823
2902
self.plugin_metadata = plugin_metadata
2824
2903
self.cmd_name = cmd_name
2825
2904
self.provider = provider
2827
2906
def __str__(self):
2829
_fmt = ('"%s" is not a standard bzr command. \n'
2908
_fmt = ('"%s" is not a standard bzr command. \n'
2830
2909
'However, the following official plugin provides this command: %s\n'
2831
2910
'You can install it by going to: %s'
2832
% (self.cmd_name, self.plugin_metadata['name'],
2911
% (self.cmd_name, self.plugin_metadata['name'],
2833
2912
self.plugin_metadata['url']))
2838
2917
class NoPluginAvailable(BzrError):
2842
class NotATerminal(BzrError):
2844
_fmt = 'Unable to ask for a password without real terminal.'
2847
2921
class UnableEncodePath(BzrError):
2891
2965
_fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2893
2967
def __init__(self, host, port, orig_error):
2968
# nb: in python2.4 socket.error doesn't have a useful repr
2894
2969
BzrError.__init__(self, host=host, port=port,
2895
orig_error=orig_error[1])
2970
orig_error=repr(orig_error.args))
2898
2973
class UnknownRules(BzrError):
2906
2981
class HookFailed(BzrError):
2907
2982
"""Raised when a pre_change_branch_tip hook function fails anything other
2908
2983
than TipChangeRejected.
2985
Note that this exception is no longer raised, and the import is only left
2986
to be nice to code which might catch it in a plugin.
2911
2989
_fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2912
2990
"%(traceback_text)s%(exc_value)s")
2914
def __init__(self, hook_stage, hook_name, exc_info):
2992
def __init__(self, hook_stage, hook_name, exc_info, warn=True):
2994
symbol_versioning.warn("BzrError HookFailed has been deprecated "
2995
"as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2915
2996
import traceback
2916
2997
self.hook_stage = hook_stage
2917
2998
self.hook_name = hook_name
2966
3055
def __init__(self, format, url):
2967
3056
BzrError.__init__(self, format=format, url=url)
3059
class NoSuchView(BzrError):
3060
"""A view does not exist.
3063
_fmt = u"No such view: %(view_name)s."
3065
def __init__(self, view_name):
3066
self.view_name = view_name
3069
class ViewsNotSupported(BzrError):
3070
"""Views are not supported by a tree format.
3073
_fmt = ("Views are not supported by %(tree)s;"
3074
" use 'bzr upgrade' to change your tree to a later format.")
3076
def __init__(self, tree):
3080
class FileOutsideView(BzrError):
3082
_fmt = ('Specified file "%(file_name)s" is outside the current view: '
3085
def __init__(self, file_name, view_files):
3086
self.file_name = file_name
3087
self.view_str = ", ".join(view_files)
3090
class UnresumableWriteGroup(BzrError):
3092
_fmt = ("Repository %(repository)s cannot resume write group "
3093
"%(write_groups)r: %(reason)s")
3095
internal_error = True
3097
def __init__(self, repository, write_groups, reason):
3098
self.repository = repository
3099
self.write_groups = write_groups
3100
self.reason = reason
3103
class UnsuspendableWriteGroup(BzrError):
3105
_fmt = ("Repository %(repository)s cannot suspend a write group.")
3107
internal_error = True
3109
def __init__(self, repository):
3110
self.repository = repository
3113
class LossyPushToSameVCS(BzrError):
3115
_fmt = ("Lossy push not possible between %(source_branch)r and "
3116
"%(target_branch)r that are in the same VCS.")
3118
internal_error = True
3120
def __init__(self, source_branch, target_branch):
3121
self.source_branch = source_branch
3122
self.target_branch = target_branch
3125
class NoRoundtrippingSupport(BzrError):
3127
_fmt = ("Roundtripping is not supported between %(source_branch)r and "
3128
"%(target_branch)r.")
3130
internal_error = True
3132
def __init__(self, source_branch, target_branch):
3133
self.source_branch = source_branch
3134
self.target_branch = target_branch
3137
class FileTimestampUnavailable(BzrError):
3139
_fmt = "The filestamp for %(path)s is not available."
3141
internal_error = True
3143
def __init__(self, path):
3147
class NoColocatedBranchSupport(BzrError):
3149
_fmt = ("%(bzrdir)r does not support co-located branches.")
3151
def __init__(self, bzrdir):
3152
self.bzrdir = bzrdir
3154
class NoWhoami(BzrError):
3156
_fmt = ('Unable to determine your name.\n'
3157
"Please, set your name with the 'whoami' command.\n"
3158
'E.g. bzr whoami "Your Name <name@example.com>"')