/brz/remove-bazaar

# Copyright (C) 2005, 2006 Canonical Ltd

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

"""Exceptions for bzr, and reporting of them.

"""

from bzrlib import (symbol_versioning,

                    osutils,)

from bzrlib.patches import (PatchSyntax, 

                            PatchConflict, 

                            MalformedPatchHeader,

                            MalformedHunkHeader,

                            MalformedLine,)

# TODO: is there any value in providing the .args field used by standard

# python exceptions?   A list of values with no names seems less useful 

# to me.

# TODO: Perhaps convert the exception to a string at the moment it's 

# constructed to make sure it will succeed.  But that says nothing about

# exceptions that are never raised.

# TODO: selftest assertRaises should probably also check that every error

# raised can be formatted as a string successfully, and without giving

# 'unprintable'.

class BzrError(StandardError):

    """

    Base class for errors raised by bzrlib.

    :cvar internal_error: if true (or absent) this was probably caused by a

    bzr bug and should be displayed with a traceback; if False this was

    probably a user or environment error and they don't need the gory details.

    (That can be overridden by -Derror on the command line.)

    :cvar _fmt: Format string to display the error; this is expanded

    by the instance's dict.

    """

    internal_error = False

    def __init__(self, msg=None, **kwds):

        """Construct a new BzrError.

        There are two alternative forms for constructing these objects.

        Either a preformatted string may be passed, or a set of named

        arguments can be given.  The first is for generic "user" errors which

        are not intended to be caught and so do not need a specific subclass.

        The second case is for use with subclasses that provide a _fmt format

        string to print the arguments.  

        Keyword arguments are taken as parameters to the error, which can 

        be inserted into the format string template.  It's recommended 

        that subclasses override the __init__ method to require specific 

        parameters.

        :param msg: If given, this is the literal complete text for the error,

        not subject to expansion.

        """

        StandardError.__init__(self)

        if msg is not None:

            # I was going to deprecate this, but it actually turns out to be

            # quite handy - mbp 20061103.

            self._preformatted_string = msg

        else:

            self._preformatted_string = None

            for key, value in kwds.items():

                setattr(self, key, value)

    def __str__(self):

        s = getattr(self, '_preformatted_string', None)

        if s is not None:

            # contains a preformatted message; must be cast to plain str

            return str(s)

        try:

            fmt = self._get_format_string()

            if fmt:

                s = fmt % self.__dict__

                # __str__() should always return a 'str' object

                # never a 'unicode' object.

                if isinstance(s, unicode):

                    return s.encode('utf8')

                return s

        except (AttributeError, TypeError, NameError, ValueError, KeyError), e:

            return 'Unprintable exception %s: dict=%r, fmt=%r, error=%s' \

                % (self.__class__.__name__,

                   self.__dict__,

                   getattr(self, '_fmt', None),

                   str(e))

    def _get_format_string(self):

        """Return format string for this exception or None"""

        fmt = getattr(self, '_fmt', None)

        if fmt is not None:

            return fmt

        fmt = getattr(self, '__doc__', None)

        if fmt is not None:

            symbol_versioning.warn("%s uses its docstring as a format, "

                    "it should use _fmt instead" % self.__class__.__name__,

                    DeprecationWarning)

            return fmt

        return 'Unprintable exception %s: dict=%r, fmt=%r' \

            % (self.__class__.__name__,

               self.__dict__,

               getattr(self, '_fmt', None),

               )

class BzrNewError(BzrError):

    """Deprecated error base class."""

    # base classes should override the docstring with their human-

    # readable explanation

    def __init__(self, *args, **kwds):

        # XXX: Use the underlying BzrError to always generate the args attribute

        # if it doesn't exist.  We can't use super here, because exceptions are

        # old-style classes in python2.4 (but new in 2.5).  --bmc, 20060426

        symbol_versioning.warn('BzrNewError was deprecated in bzr 0.13; '

             'please convert %s to use BzrError instead' 

             % self.__class__.__name__,

             DeprecationWarning,

             stacklevel=2)

        BzrError.__init__(self, *args)

        for key, value in kwds.items():

            setattr(self, key, value)

    def __str__(self):

        try:

            # __str__() should always return a 'str' object

            # never a 'unicode' object.

            s = self.__doc__ % self.__dict__

            if isinstance(s, unicode):

                return s.encode('utf8')

            return s

        except (TypeError, NameError, ValueError, KeyError), e:

            return 'Unprintable exception %s(%r): %s' \

                % (self.__class__.__name__,

                   self.__dict__, str(e))

class AlreadyBuilding(BzrError):

    _fmt = "The tree builder is already building a tree."

class BzrCheckError(BzrError):

    _fmt = "Internal check failed: %(message)s"

    internal_error = True

    def __init__(self, message):

        BzrError.__init__(self)

        self.message = message

class InvalidEntryName(BzrError):

    _fmt = "Invalid entry name: %(name)s"

    internal_error = True

    def __init__(self, name):

        BzrError.__init__(self)

        self.name = name

class InvalidRevisionNumber(BzrError):

    _fmt = "Invalid revision number %(revno)s"

    def __init__(self, revno):

        BzrError.__init__(self)

        self.revno = revno

class InvalidRevisionId(BzrError):

    _fmt = "Invalid revision-id {%(revision_id)s} in %(branch)s"

    def __init__(self, revision_id, branch):

        # branch can be any string or object with __str__ defined

        BzrError.__init__(self)

        self.revision_id = revision_id

        self.branch = branch

class ReservedId(BzrError):

    _fmt = "Reserved revision-id {%(revision_id)s}"

    def __init__(self, revision_id):

        self.revision_id = revision_id

class NoSuchId(BzrError):

    _fmt = "The file id %(file_id)s is not present in the tree %(tree)s."

    def __init__(self, tree, file_id):

        BzrError.__init__(self)

        self.file_id = file_id

        self.tree = tree

class InventoryModified(BzrError):

    _fmt = ("The current inventory for the tree %(tree)r has been modified, "

            "so a clean inventory cannot be read without data loss.")

    internal_error = True

    def __init__(self, tree):

        self.tree = tree

class NoWorkingTree(BzrError):

    _fmt = "No WorkingTree exists for %(base)s."

    def __init__(self, base):

        BzrError.__init__(self)

        self.base = base

class NotBuilding(BzrError):

    _fmt = "Not currently building a tree."

class NotLocalUrl(BzrError):

    _fmt = "%(url)s is not a local path."

    def __init__(self, url):

        self.url = url

class WorkingTreeAlreadyPopulated(BzrError):

    _fmt = """Working tree already populated in %(base)s"""

    internal_error = True

    def __init__(self, base):

        self.base = base

class BzrCommandError(BzrError):

    """Error from user command"""

    internal_error = False

    # Error from malformed user command; please avoid raising this as a

    # generic exception not caused by user input.

    #

    # I think it's a waste of effort to differentiate between errors that

    # are not intended to be caught anyway.  UI code need not subclass

    # BzrCommandError, and non-UI code should not throw a subclass of

    # BzrCommandError.  ADHB 20051211

    def __init__(self, msg):

        # Object.__str__() must return a real string

        # returning a Unicode string is a python error.

        if isinstance(msg, unicode):

            self.msg = msg.encode('utf8')

        else:

            self.msg = msg

    def __str__(self):

        return self.msg

class NotWriteLocked(BzrError):

    _fmt = """%(not_locked)r is not write locked but needs to be."""

    def __init__(self, not_locked):

        self.not_locked = not_locked

class BzrOptionError(BzrCommandError):

    _fmt = "Error in command line options"

class BadOptionValue(BzrError):

    _fmt = """Bad value "%(value)s" for option "%(name)s"."""

    def __init__(self, name, value):

        BzrError.__init__(self, name=name, value=value)

class StrictCommitFailed(BzrError):

    _fmt = "Commit refused because there are unknown files in the tree"

# XXX: Should be unified with TransportError; they seem to represent the

# same thing

class PathError(BzrError):

    _fmt = "Generic path error: %(path)r%(extra)s)"

    def __init__(self, path, extra=None):

        BzrError.__init__(self)

        self.path = path

        if extra:

            self.extra = ': ' + str(extra)

        else:

            self.extra = ''

class NoSuchFile(PathError):

    _fmt = "No such file: %(path)r%(extra)s"

class FileExists(PathError):

    _fmt = "File exists: %(path)r%(extra)s"

class FilesExist(PathError):

    """Used when reporting that files do exist"""

    _fmt = "File%(plural)s exist: %(paths_as_string)s%(extra)s"

    def __init__(self, paths, extra=None):

        # circular import

        from bzrlib.osutils import quotefn

        BzrError.__init__(self)

        self.paths = paths

        self.paths_as_string = ' '.join(paths)

        if extra:

            self.extra = ': ' + str(extra)

        else:

            self.extra = ''

        if len(paths) > 1:

            self.plural = 's'

        else:

            self.plural = ''

class NotADirectory(PathError):

    _fmt = "%(path)r is not a directory %(extra)s"

class NotInWorkingDirectory(PathError):

    _fmt = "%(path)r is not in the working directory %(extra)s"

class DirectoryNotEmpty(PathError):

    _fmt = "Directory not empty: %(path)r%(extra)s"

class ReadingCompleted(BzrError):

    _fmt = ("The MediumRequest '%(request)s' has already had finish_reading "

            "called upon it - the request has been completed and no more "

            "data may be read.")

    internal_error = True

    def __init__(self, request):

        self.request = request

class ResourceBusy(PathError):

    _fmt = "Device or resource busy: %(path)r%(extra)s"

class PermissionDenied(PathError):

    _fmt = "Permission denied: %(path)r%(extra)s"

class InvalidURL(PathError):

    _fmt = "Invalid url supplied to transport: %(path)r%(extra)s"

class InvalidURLJoin(PathError):

    _fmt = "Invalid URL join request: %(args)s%(extra)s"

    def __init__(self, msg, base, args):

        PathError.__init__(self, base, msg)

        self.args = [base] + list(args)

class UnsupportedProtocol(PathError):

    _fmt = 'Unsupported protocol for url "%(path)s"%(extra)s'

    def __init__(self, url, extra):

        PathError.__init__(self, url, extra=extra)

class ShortReadvError(PathError):

    _fmt = "readv() read %(actual)s bytes rather than %(length)s bytes at %(offset)s for %(path)s%(extra)s"

    internal_error = True

    def __init__(self, path, offset, length, actual, extra=None):

        PathError.__init__(self, path, extra=extra)

        self.offset = offset

        self.length = length

        self.actual = actual

class PathNotChild(BzrError):

    _fmt = "Path %(path)r is not a child of path %(base)r%(extra)s"

    internal_error = True

    def __init__(self, path, base, extra=None):

        BzrError.__init__(self)

        self.path = path

        self.base = base

        if extra:

            self.extra = ': ' + str(extra)

        else:

            self.extra = ''

class InvalidNormalization(PathError):

    _fmt = "Path %(path)r is not unicode normalized"

# TODO: This is given a URL; we try to unescape it but doing that from inside

# the exception object is a bit undesirable.

# TODO: Probably this behavior of should be a common superclass 

class NotBranchError(PathError):

    _fmt = "Not a branch: %(path)s"

    def __init__(self, path):

       import bzrlib.urlutils as urlutils

       self.path = urlutils.unescape_for_display(path, 'ascii')

class AlreadyBranchError(PathError):

    _fmt = "Already a branch: %(path)s."

class BranchExistsWithoutWorkingTree(PathError):

    _fmt = "Directory contains a branch, but no working tree \

(use bzr checkout if you wish to build a working tree): %(path)s"

class AtomicFileAlreadyClosed(PathError):

    _fmt = "'%(function)s' called on an AtomicFile after it was closed: %(path)s"

    def __init__(self, path, function):

        PathError.__init__(self, path=path, extra=None)

        self.function = function

class InaccessibleParent(PathError):

    _fmt = "Parent not accessible given base %(base)s and relative path %(path)s"

    def __init__(self, path, base):

        PathError.__init__(self, path)

        self.base = base

class NoRepositoryPresent(BzrError):

    _fmt = "No repository present: %(path)r"

    def __init__(self, bzrdir):

        BzrError.__init__(self)

        self.path = bzrdir.transport.clone('..').base

class FileInWrongBranch(BzrError):

    _fmt = "File %(path)s in not in branch %(branch_base)s."

    def __init__(self, branch, path):

        BzrError.__init__(self)

        self.branch = branch

        self.branch_base = branch.base

        self.path = path

class UnsupportedFormatError(BzrError):

    _fmt = "Unsupported branch format: %(format)s"

class UnknownFormatError(BzrError):

    _fmt = "Unknown branch format: %(format)r"

class IncompatibleFormat(BzrError):

    _fmt = "Format %(format)s is not compatible with .bzr version %(bzrdir)s."

    def __init__(self, format, bzrdir_format):

        BzrError.__init__(self)

        self.format = format

        self.bzrdir = bzrdir_format

class IncompatibleRevision(BzrError):

    _fmt = "Revision is not compatible with %(repo_format)s"

    def __init__(self, repo_format):

        BzrError.__init__(self)

        self.repo_format = repo_format

class AlreadyVersionedError(BzrError):

    """Used when a path is expected not to be versioned, but it is."""

    _fmt = "%(context_info)s%(path)s is already versioned"

    def __init__(self, path, context_info=None):

        """Construct a new NotVersionedError.

        :param path: This is the path which is versioned,

        which should be in a user friendly form.

        :param context_info: If given, this is information about the context,

        which could explain why this is expected to not be versioned.

        """

        BzrError.__init__(self)

        self.path = path

        if context_info is None:

            self.context_info = ''

        else:

            self.context_info = context_info + ". "

class NotVersionedError(BzrError):

    """Used when a path is expected to be versioned, but it is not."""

    _fmt = "%(context_info)s%(path)s is not versioned"

    def __init__(self, path, context_info=None):

        """Construct a new NotVersionedError.

        :param path: This is the path which is not versioned,

        which should be in a user friendly form.

        :param context_info: If given, this is information about the context,

        which could explain why this is expected to be versioned.

        """

        BzrError.__init__(self)

        self.path = path

        if context_info is None:

            self.context_info = ''

        else:

            self.context_info = context_info + ". "

class PathsNotVersionedError(BzrError):

    """Used when reporting several paths which are not versioned"""

    _fmt = "Path(s) are not versioned: %(paths_as_string)s"

    def __init__(self, paths):

        from bzrlib.osutils import quotefn

        BzrError.__init__(self)

        self.paths = paths

        self.paths_as_string = ' '.join([quotefn(p) for p in paths])

class PathsDoNotExist(BzrError):

    _fmt = "Path(s) do not exist: %(paths_as_string)s%(extra)s"

    # used when reporting that paths are neither versioned nor in the working

    # tree

    def __init__(self, paths, extra=None):

        # circular import

        from bzrlib.osutils import quotefn

        BzrError.__init__(self)

        self.paths = paths

        self.paths_as_string = ' '.join([quotefn(p) for p in paths])

        if extra:

            self.extra = ': ' + str(extra)

        else:

            self.extra = ''

class BadFileKindError(BzrError):

    _fmt = "Cannot operate on %(filename)s of unsupported kind %(kind)s"

class ForbiddenControlFileError(BzrError):

    _fmt = "Cannot operate on %(filename)s because it is a control file"

class LockError(BzrError):

    _fmt = "Lock error: %(message)s"

    internal_error = True

    # All exceptions from the lock/unlock functions should be from

    # this exception class.  They will be translated as necessary. The

    # original exception is available as e.original_error

    #

    # New code should prefer to raise specific subclasses

    def __init__(self, message):

        self.message = message

class CommitNotPossible(LockError):

    _fmt = "A commit was attempted but we do not have a write lock open."

    def __init__(self):

        pass

class AlreadyCommitted(LockError):

    _fmt = "A rollback was requested, but is not able to be accomplished."

    def __init__(self):

        pass

class ReadOnlyError(LockError):

    _fmt = "A write attempt was made in a read only transaction on %(obj)s"

    def __init__(self, obj):

        self.obj = obj

class OutSideTransaction(BzrError):

    _fmt = "A transaction related operation was attempted after the transaction finished."

class ObjectNotLocked(LockError):

    _fmt = "%(obj)r is not locked"

    # this can indicate that any particular object is not locked; see also

    # LockNotHeld which means that a particular *lock* object is not held by

    # the caller -- perhaps they should be unified.

    def __init__(self, obj):

        self.obj = obj

class ReadOnlyObjectDirtiedError(ReadOnlyError):

    _fmt = "Cannot change object %(obj)r in read only transaction"

    def __init__(self, obj):

        self.obj = obj

class UnlockableTransport(LockError):

    _fmt = "Cannot lock: transport is read only: %(transport)s"

    def __init__(self, transport):

        self.transport = transport

class LockContention(LockError):

    _fmt = "Could not acquire lock %(lock)s"

    # TODO: show full url for lock, combining the transport and relative

    # bits?

    internal_error = False

    def __init__(self, lock):

        self.lock = lock