~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/errors.py

  • Committer: John Arbash Meinel
  • Date: 2010-08-13 19:08:57 UTC
  • mto: (5050.17.7 2.2)
  • mto: This revision was merged to the branch mainline in revision 5379.
  • Revision ID: john@arbash-meinel.com-20100813190857-mvzwnimrxvm0zimp
Lots of documentation updates.

We had a lot of http links pointing to the old domain. They should
all now be properly updated to the new domain. (only bazaar-vcs.org
entry left is for pqm, which seems to still reside at the old url.)

Also removed one 'TODO' doc entry about switching to binary xdelta, since
we basically did just that with groupcompress.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
636
636
        self.url = url
637
637
 
638
638
 
 
639
class UnstackableLocationError(BzrError):
 
640
 
 
641
    _fmt = "The branch '%(branch_url)s' cannot be stacked on '%(target_url)s'."
 
642
 
 
643
    def __init__(self, branch_url, target_url):
 
644
        BzrError.__init__(self)
 
645
        self.branch_url = branch_url
 
646
        self.target_url = target_url
 
647
 
 
648
 
639
649
class UnstackableRepositoryFormat(BzrError):
640
650
 
641
651
    _fmt = ("The repository '%(url)s'(%(format)s) is not a stackable format. "
692
702
# TODO: Probably this behavior of should be a common superclass
693
703
class NotBranchError(PathError):
694
704
 
695
 
    _fmt = 'Not a branch: "%(path)s".'
 
705
    _fmt = 'Not a branch: "%(path)s"%(detail)s.'
696
706
 
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
 
712
       self.detail = detail
 
713
       self.bzrdir = bzrdir
 
714
       PathError.__init__(self, path=path)
 
715
 
 
716
    def _format(self):
 
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:
 
722
                try:
 
723
                    self.bzrdir.open_repository()
 
724
                except NoRepositoryPresent:
 
725
                    self.detail = ''
 
726
                else:
 
727
                    self.detail = ': location is a repository'
 
728
            else:
 
729
                self.detail = ''
 
730
        return PathError._format(self)
700
731
 
701
732
 
702
733
class NoSubmitBranch(PathError):
783
814
 
784
815
 
785
816
class IncompatibleRepositories(BzrError):
 
817
    """Report an error that two repositories are not compatible.
 
818
 
 
819
    Note that the source and target repositories are permitted to be strings:
 
820
    this exception is thrown from the smart server and may refer to a
 
821
    repository the client hasn't opened.
 
822
    """
786
823
 
787
824
    _fmt = "%(target)s\n" \
788
825
            "is not compatible with\n" \
910
947
    # original exception is available as e.original_error
911
948
    #
912
949
    # New code should prefer to raise specific subclasses
913
 
    def __init__(self, message):
914
 
        # Python 2.5 uses a slot for StandardError.message,
915
 
        # so use a different variable name.  We now work around this in
916
 
        # BzrError.__str__, but this member name is kept for compatability.
917
 
        self.msg = message
 
950
    def __init__(self, msg):
 
951
        self.msg = msg
918
952
 
919
953
 
920
954
class LockActive(LockError):
1004
1038
class LockContention(LockError):
1005
1039
 
1006
1040
    _fmt = 'Could not acquire lock "%(lock)s": %(msg)s'
1007
 
    # TODO: show full url for lock, combining the transport and relative
1008
 
    # bits?
1009
1041
 
1010
1042
    internal_error = False
1011
1043
 
1142
1174
 
1143
1175
class InvalidRevisionSpec(BzrError):
1144
1176
 
1145
 
    _fmt = ("Requested revision: %(spec)r does not exist in branch:"
 
1177
    _fmt = ("Requested revision: '%(spec)s' does not exist in branch:"
1146
1178
            " %(branch)s%(extra)s")
1147
1179
 
1148
1180
    def __init__(self, spec, branch, extra=None):
1231
1263
class AmbiguousBase(BzrError):
1232
1264
 
1233
1265
    def __init__(self, bases):
1234
 
        warn("BzrError AmbiguousBase has been deprecated as of bzrlib 0.8.",
1235
 
                DeprecationWarning)
 
1266
        symbol_versioning.warn("BzrError AmbiguousBase has been deprecated "
 
1267
            "as of bzrlib 0.8.", DeprecationWarning, stacklevel=2)
1236
1268
        msg = ("The correct base is unclear, because %s are all equally close"
1237
1269
                % ", ".join(bases))
1238
1270
        BzrError.__init__(self, msg)
1260
1292
class BoundBranchOutOfDate(BzrError):
1261
1293
 
1262
1294
    _fmt = ("Bound branch %(branch)s is out of date with master branch"
1263
 
            " %(master)s.")
 
1295
            " %(master)s.%(extra_help)s")
1264
1296
 
1265
1297
    def __init__(self, branch, master):
1266
1298
        BzrError.__init__(self)
1267
1299
        self.branch = branch
1268
1300
        self.master = master
 
1301
        self.extra_help = ''
1269
1302
 
1270
1303
 
1271
1304
class CommitToDoubleBoundBranch(BzrError):
1342
1375
 
1343
1376
class WeaveParentMismatch(WeaveError):
1344
1377
 
1345
 
    _fmt = "Parents are mismatched between two revisions. %(message)s"
 
1378
    _fmt = "Parents are mismatched between two revisions. %(msg)s"
1346
1379
 
1347
1380
 
1348
1381
class WeaveInvalidChecksum(WeaveError):
1349
1382
 
1350
 
    _fmt = "Text did not match it's checksum: %(message)s"
 
1383
    _fmt = "Text did not match it's checksum: %(msg)s"
1351
1384
 
1352
1385
 
1353
1386
class WeaveTextDiffers(WeaveError):
1401
1434
 
1402
1435
class VersionedFileInvalidChecksum(VersionedFileError):
1403
1436
 
1404
 
    _fmt = "Text did not match its checksum: %(message)s"
 
1437
    _fmt = "Text did not match its checksum: %(msg)s"
1405
1438
 
1406
1439
 
1407
1440
class KnitError(InternalBzrError):
1887
1920
    _fmt = "Moving the root directory is not supported at this time"
1888
1921
 
1889
1922
 
 
1923
class TransformRenameFailed(BzrError):
 
1924
 
 
1925
    _fmt = "Failed to rename %(from_path)s to %(to_path)s: %(why)s"
 
1926
 
 
1927
    def __init__(self, from_path, to_path, why, errno):
 
1928
        self.from_path = from_path
 
1929
        self.to_path = to_path
 
1930
        self.why = why
 
1931
        self.errno = errno
 
1932
 
 
1933
 
1890
1934
class BzrMoveFailedError(BzrError):
1891
1935
 
1892
1936
    _fmt = "Could not move %(from_path)s%(operator)s %(to_path)s%(extra)s"
1996
2040
 
1997
2041
class BadConversionTarget(BzrError):
1998
2042
 
1999
 
    _fmt = "Cannot convert to format %(format)s.  %(problem)s"
 
2043
    _fmt = "Cannot convert from format %(from_format)s to format %(format)s." \
 
2044
            "    %(problem)s"
2000
2045
 
2001
 
    def __init__(self, problem, format):
 
2046
    def __init__(self, problem, format, from_format=None):
2002
2047
        BzrError.__init__(self)
2003
2048
        self.problem = problem
2004
2049
        self.format = format
 
2050
        self.from_format = from_format or '(unspecified)'
2005
2051
 
2006
2052
 
2007
2053
class NoDiffFound(BzrError):
2083
2129
 
2084
2130
class OutOfDateTree(BzrError):
2085
2131
 
2086
 
    _fmt = "Working tree is out of date, please run 'bzr update'."
 
2132
    _fmt = "Working tree is out of date, please run 'bzr update'.%(more)s"
2087
2133
 
2088
 
    def __init__(self, tree):
 
2134
    def __init__(self, tree, more=None):
 
2135
        if more is None:
 
2136
            more = ''
 
2137
        else:
 
2138
            more = ' ' + more
2089
2139
        BzrError.__init__(self)
2090
2140
        self.tree = tree
 
2141
        self.more = more
2091
2142
 
2092
2143
 
2093
2144
class PublicBranchOutOfDate(BzrError):
2131
2182
 
2132
2183
    def __init__(self, repo):
2133
2184
        BzrError.__init__(self)
2134
 
        self.repo_path = repo.bzrdir.root_transport.base
 
2185
        self.repo_path = repo.user_url
2135
2186
 
2136
2187
 
2137
2188
class InconsistentDelta(BzrError):
2147
2198
        self.reason = reason
2148
2199
 
2149
2200
 
 
2201
class InconsistentDeltaDelta(InconsistentDelta):
 
2202
    """Used when we get a delta that is not valid."""
 
2203
 
 
2204
    _fmt = ("An inconsistent delta was supplied: %(delta)r"
 
2205
            "\nreason: %(reason)s")
 
2206
 
 
2207
    def __init__(self, delta, reason):
 
2208
        BzrError.__init__(self)
 
2209
        self.delta = delta
 
2210
        self.reason = reason
 
2211
 
 
2212
 
2150
2213
class UpgradeRequired(BzrError):
2151
2214
 
2152
2215
    _fmt = "To use this feature you must upgrade your branch at %(path)s."
2697
2760
 
2698
2761
    def __init__(self, bzrdir):
2699
2762
        import bzrlib.urlutils as urlutils
2700
 
        display_url = urlutils.unescape_for_display(bzrdir.root_transport.base,
 
2763
        display_url = urlutils.unescape_for_display(bzrdir.user_url,
2701
2764
                                                    'ascii')
2702
2765
        BzrError.__init__(self, bzrdir=bzrdir, display_url=display_url)
2703
2766
 
2768
2831
 
2769
2832
class UncommittedChanges(BzrError):
2770
2833
 
2771
 
    _fmt = 'Working tree "%(display_url)s" has uncommitted changes.'
 
2834
    _fmt = ('Working tree "%(display_url)s" has uncommitted changes'
 
2835
            ' (See bzr status).%(more)s')
2772
2836
 
2773
 
    def __init__(self, tree):
 
2837
    def __init__(self, tree, more=None):
 
2838
        if more is None:
 
2839
            more = ''
 
2840
        else:
 
2841
            more = ' ' + more
2774
2842
        import bzrlib.urlutils as urlutils
2775
2843
        display_url = urlutils.unescape_for_display(
2776
 
            tree.bzrdir.root_transport.base, 'ascii')
2777
 
        BzrError.__init__(self, tree=tree, display_url=display_url)
 
2844
            tree.user_url, 'ascii')
 
2845
        BzrError.__init__(self, tree=tree, display_url=display_url, more=more)
 
2846
 
 
2847
 
 
2848
class ShelvedChanges(UncommittedChanges):
 
2849
 
 
2850
    _fmt = ('Working tree "%(display_url)s" has shelved changes'
 
2851
            ' (See bzr shelve --list).%(more)s')
2778
2852
 
2779
2853
 
2780
2854
class MissingTemplateVariable(BzrError):
2886
2960
    _fmt = 'Cannot bind address "%(host)s:%(port)i": %(orig_error)s.'
2887
2961
 
2888
2962
    def __init__(self, host, port, orig_error):
 
2963
        # nb: in python2.4 socket.error doesn't have a useful repr
2889
2964
        BzrError.__init__(self, host=host, port=port,
2890
 
            orig_error=orig_error[1])
 
2965
            orig_error=repr(orig_error.args))
2891
2966
 
2892
2967
 
2893
2968
class UnknownRules(BzrError):
2901
2976
class HookFailed(BzrError):
2902
2977
    """Raised when a pre_change_branch_tip hook function fails anything other
2903
2978
    than TipChangeRejected.
 
2979
 
 
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.
2904
2982
    """
2905
2983
 
2906
2984
    _fmt = ("Hook '%(hook_name)s' during %(hook_stage)s failed:\n"
2907
2985
            "%(traceback_text)s%(exc_value)s")
2908
2986
 
2909
 
    def __init__(self, hook_stage, hook_name, exc_info):
 
2987
    def __init__(self, hook_stage, hook_name, exc_info, warn=True):
 
2988
        if warn:
 
2989
            symbol_versioning.warn("BzrError HookFailed has been deprecated "
 
2990
                "as of bzrlib 2.1.", DeprecationWarning, stacklevel=2)
2910
2991
        import traceback
2911
2992
        self.hook_stage = hook_stage
2912
2993
        self.hook_name = hook_name
3034
3115
    def __init__(self, source_branch, target_branch):
3035
3116
        self.source_branch = source_branch
3036
3117
        self.target_branch = target_branch
 
3118
 
 
3119
 
 
3120
class NoRoundtrippingSupport(BzrError):
 
3121
 
 
3122
    _fmt = ("Roundtripping is not supported between %(source_branch)r and "
 
3123
            "%(target_branch)r.")
 
3124
 
 
3125
    internal_error = True
 
3126
 
 
3127
    def __init__(self, source_branch, target_branch):
 
3128
        self.source_branch = source_branch
 
3129
        self.target_branch = target_branch
 
3130
 
 
3131
 
 
3132
class FileTimestampUnavailable(BzrError):
 
3133
 
 
3134
    _fmt = "The filestamp for %(path)s is not available."
 
3135
 
 
3136
    internal_error = True
 
3137
 
 
3138
    def __init__(self, path):
 
3139
        self.path = path
 
3140
 
 
3141
 
 
3142
class NoColocatedBranchSupport(BzrError):
 
3143
 
 
3144
    _fmt = ("%(bzrdir)r does not support co-located branches.")
 
3145
 
 
3146
    def __init__(self, bzrdir):
 
3147
        self.bzrdir = bzrdir
 
3148
 
 
3149
 
 
3150
class NoWhoami(BzrError):
 
3151
 
 
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>"')
 
3155
 
 
3156
 
 
3157
class InvalidPattern(BzrError):
 
3158
 
 
3159
    _fmt = ('Invalid pattern(s) found. %(msg)s')
 
3160
 
 
3161
    def __init__(self, msg):
 
3162
        self.msg = msg
 
3163
 
 
3164
 
 
3165
class RecursiveBind(BzrError):
 
3166
 
 
3167
    _fmt = ('Branch "%(branch_url)s" appears to be bound to itself. '
 
3168
        'Please use `bzr unbind` to fix.')
 
3169
 
 
3170
    def __init__(self, branch_url):
 
3171
        self.branch_url = branch_url
 
3172