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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
#!/usr/bin/env python
"""
path
~~~~
:copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import os
import sys
import shutil
from codecs import open
FILESYSTEMENCODING = sys.getfilesystemencoding() or sys.getdefaultencoding()
class path(str):
@property
def parent(self):
"""
The name of the directory the file or directory is in.
"""
return self.__class__(os.path.dirname(self))
def abspath(self):
"""
Returns the absolute path.
"""
return self.__class__(os.path.abspath(self))
def isabs(self):
"""
Returns ``True`` if the path is absolute.
"""
return os.path.isabs(self)
def isdir(self):
"""
Returns ``True`` if the path is a directory.
"""
return os.path.isdir(self)
def isfile(self):
"""
Returns ``True`` if the path is a file.
"""
return os.path.isfile(self)
def islink(self):
"""
Returns ``True`` if the path is a symbolic link.
"""
return os.path.islink(self)
def ismount(self):
"""
Returns ``True`` if the path is a mount point.
"""
return os.path.ismount(self)
def rmtree(self, ignore_errors=False, onerror=None):
"""
Removes the file or directory and any files or directories it may
contain.
:param ignore_errors:
If ``True`` errors are silently ignored, otherwise an exception
is raised in case an error occurs.
:param onerror:
A callback which gets called with the arguments `func`, `path` and
`exc_info`. `func` is one of :func:`os.listdir`, :func:`os.remove`
or :func:`os.rmdir`. `path` is the argument to the function which
caused it to fail and `exc_info` is a tuple as returned by
:func:`sys.exc_info`.
"""
shutil.rmtree(self, ignore_errors=ignore_errors, onerror=onerror)
def copytree(self, destination, symlinks=False):
"""
Recursively copy a directory to the given `destination`. If the given
`destination` does not exist it will be created.
:param symlinks:
If ``True`` symbolic links in the source tree result in symbolic
links in the destination tree otherwise the contents of the files
pointed to by the symbolic links are copied.
"""
shutil.copytree(self, destination, symlinks=symlinks)
def movetree(self, destination):
"""
Recursively move the file or directory to the given `destination`
similar to the Unix "mv" command.
If the `destination` is a file it may be overwritten depending on the
:func:`os.rename` semantics.
"""
shutil.move(self, destination)
move = movetree
def unlink(self):
"""
Removes a file.
"""
os.unlink(self)
def write_text(self, text, **kwargs):
"""
Writes the given `text` to the file.
"""
f = open(self, 'w', **kwargs)
try:
f.write(text)
finally:
f.close()
def text(self, **kwargs):
"""
Returns the text in the file.
"""
f = open(self, mode='r', **kwargs)
try:
return f.read()
finally:
f.close()
def bytes(self):
"""
Returns the bytes in the file.
"""
f = open(self, mode='rb')
try:
return f.read()
finally:
f.close()
def write_bytes(self, bytes, append=False):
"""
Writes the given `bytes` to the file.
:param append:
If ``True`` given `bytes` are added at the end of the file.
"""
if append:
mode = 'ab'
else:
mode = 'wb'
f = open(self, mode=mode)
try:
f.write(bytes)
finally:
f.close()
def exists(self):
"""
Returns ``True`` if the path exist.
"""
return os.path.exists(self)
def lexists(self):
"""
Returns ``True`` if the path exists unless it is a broken symbolic
link.
"""
return os.path.lexists(self)
def makedirs(self, mode=int('0777', 8)):
"""
Recursively create directories.
"""
os.makedirs(self, mode)
def joinpath(self, *args):
"""
Joins the path with the argument given and returns the result.
"""
return self.__class__(os.path.join(self, *map(self.__class__, args)))
__div__ = __truediv__ = joinpath
def __repr__(self):
return '{}({})'.format(self.__class__.__name__, str.__repr__(self))
|
