summaryrefslogtreecommitdiff
path: root/fs/errors.py
blob: b216c64f411725d084773df5a0625c23509a717a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
"""

  fs.errors:  error class definitions for FS

"""

class FSError(Exception):
    """Base exception class for the FS module."""

    default_message = "Unspecified error"

    def __init__(self,msg=None,details=None):
        if msg is None:
            msg = self.default_message
        self.msg = msg
        self.details = details

    def __str__(self):
        keys = dict((k,str(v)) for k,v in self.__dict__.iteritems())
        return self.msg % keys

    def __unicode__(self):
        return unicode(str(self))


class PathError(FSError):
    """Exception for errors to do with a path string."""

    default_message = "Path is invalid: %(path)s"

    def __init__(self,path,**kwds):
        self.path = path
        super(ResourceError,self).__init__(**kwds)
 

class OperationFailedError(FSError):
    """Base exception class for errors associated with a specific operation."""
    
    default_message = "Unable to %(opname)s: unspecified error"

    def __init__(self,opname,path=None,**kwds):
        self.opname = opname
        self.path = path
        super(OperationFailedError,self).__init__(**kwds)


class UnsupportedError(OperationFailedError):
    """Exception raised for operations that are not supported by the FS."""
    default_message = "Unable to %(opname)s: not supported by this filesystem"


class ResourceError(FSError):
    """Base exception class for error associated with a specific resource."""

    default_message = "Unspecified resource error: %(path)s"

    def __init__(self,path,**kwds):
        self.path = path
        super(ResourceError,self).__init__(**kwds)


class NoSysPathError(ResourceError):
    """Exception raised when there is no syspath for a given path."""
    default_message = "No mapping to OS filesystem: %(path)s"


class ResourceNotFoundError(ResourceError):
    """Exception raised when a required resource is not found."""
    default_message = "Resource not found: %(path)s"


class DirectoryNotFoundError(ResourceNotFoundError):
    """Exception raised when a required directory is not found."""
    default_message = "Directory not found: %(path)s"


class FileNotFoundError(ResourceNotFoundError):
    """Exception raised when a required file is not found."""
    default_message = "File not found: %(path)s"


class ResourceInvalidError(ResourceError):
    """Exception raised when a required file is not found."""
    default_message = "Resource is invalid: %(path)s"


class DestinationExistsError(ResourceError):
    """Exception raised when a target destination already exists."""
    default_message = "Destination exists: %(path)s"


class DirectoryNotEmptyError(ResourceError):
    """Exception raised when a directory to be removed is not empty."""
    default_message = "Directory is not empty: %(path)s"


class ParentDirectoryMissingError(ResourceError):
    """Exception raised when a parent directory is missing."""
    default_message = "Parent directory is missing: %(path)s"


class ResourceLockedError(ResourceError):
    """Exception raised when a resource can't be used because it is locked."""
    default_message = "Resource is locked: %(path)s"