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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
|
import stat
from errno import ENOENT
from rpython.rlib import rgc
from rpython.rlib import rposix, rposix_scandir, rposix_stat
from pypy.interpreter.gateway import unwrap_spec, WrappedDefault, interp2app
from pypy.interpreter.error import OperationError, oefmt, wrap_oserror2
from pypy.interpreter.typedef import TypeDef, GetSetProperty
from pypy.interpreter.baseobjspace import W_Root
from pypy.module.posix.interp_posix import unwrap_fd, build_stat_result, _WIN32
def scandir(space, w_path=None):
"scandir(path='.') -> iterator of DirEntry objects for given path"
if space.is_none(w_path):
w_path = space.newunicode(u".")
if not _WIN32:
if space.isinstance_w(w_path, space.w_bytes):
path = space.bytes0_w(w_path)
result_is_bytes = True
else:
path = space.fsencode_w(w_path)
result_is_bytes = False
else:
if space.isinstance_w(w_path, space.w_bytes):
raise oefmt(space.w_TypeError, "os.scandir() doesn't support bytes path"
" on Windows, use Unicode instead")
path = space.unicode_w(w_path)
result_is_bytes = False
# 'path' is always bytes on posix and always unicode on windows
try:
dirp = rposix_scandir.opendir(path)
except OSError as e:
raise wrap_oserror2(space, e, w_path, eintr_retry=False)
path_prefix = path
if not _WIN32:
if len(path_prefix) > 0 and path_prefix[-1] != '/':
path_prefix += '/'
w_path_prefix = space.newbytes(path_prefix)
if not result_is_bytes:
w_path_prefix = space.fsdecode(w_path_prefix)
else:
if len(path_prefix) > 0 and path_prefix[-1] not in (u'\\', u'/', u':'):
path_prefix += u'\\'
w_path_prefix = space.newunicode(path_prefix)
if rposix.HAVE_FSTATAT:
dirfd = rposix.c_dirfd(dirp)
else:
dirfd = -1
return W_ScandirIterator(space, dirp, dirfd, w_path_prefix, result_is_bytes)
class W_ScandirIterator(W_Root):
_in_next = False
def __init__(self, space, dirp, dirfd, w_path_prefix, result_is_bytes):
self.space = space
self.dirp = dirp
self.dirfd = dirfd
self.w_path_prefix = w_path_prefix
self.result_is_bytes = result_is_bytes
@rgc.must_be_light_finalizer
def __del__(self):
if self.dirp:
rposix_scandir.closedir(self.dirp)
def iter_w(self):
return self
def fail(self, err=None):
dirp = self.dirp
if dirp:
self.dirfd = -1
self.dirp = rposix_scandir.NULL_DIRP
rposix_scandir.closedir(dirp)
if err is None:
raise OperationError(self.space.w_StopIteration, self.space.w_None)
else:
raise err
def next_w(self):
if not self.dirp:
raise self.fail()
if self._in_next:
raise self.fail(oefmt(self.space.w_RuntimeError,
"cannot use ScandirIterator from multiple threads concurrently"))
self._in_next = True
try:
#
space = self.space
while True:
try:
entry = rposix_scandir.nextentry(self.dirp)
except OSError as e:
raise self.fail(wrap_oserror2(space, e, self.w_path_prefix,
eintr_retry=False))
if not entry:
raise self.fail()
if not _WIN32:
name = rposix_scandir.get_name_bytes(entry)
if name != '.' and name != '..':
break
else:
name = rposix_scandir.get_name_unicode(entry)
if name != u'.' and name != u'..':
break
#
known_type = rposix_scandir.get_known_type(entry)
inode = rposix_scandir.get_inode(entry)
finally:
self._in_next = False
direntry = W_DirEntry(self, name, known_type, inode)
return direntry
W_ScandirIterator.typedef = TypeDef(
'posix.ScandirIterator',
__iter__ = interp2app(W_ScandirIterator.iter_w),
__next__ = interp2app(W_ScandirIterator.next_w),
)
W_ScandirIterator.typedef.acceptable_as_base_class = False
class FileNotFound(Exception):
pass
if not _WIN32:
assert 0 <= rposix_scandir.DT_UNKNOWN <= 255
assert 0 <= rposix_scandir.DT_REG <= 255
assert 0 <= rposix_scandir.DT_DIR <= 255
assert 0 <= rposix_scandir.DT_LNK <= 255
FLAG_STAT = 256
FLAG_LSTAT = 512
class W_DirEntry(W_Root):
w_path = None
def __init__(self, scandir_iterator, name, known_type, inode):
self.space = scandir_iterator.space
self.scandir_iterator = scandir_iterator
self.name = name # always bytes on Posix; always unicode on Windows
self.inode = inode
self.flags = known_type
#
if not _WIN32:
assert known_type == (known_type & 255)
w_name = self.space.newbytes(name)
if not scandir_iterator.result_is_bytes:
w_name = self.space.fsdecode(w_name)
else:
w_name = self.space.newunicode(name)
self.w_name = w_name
def descr_repr(self, space):
u = space.unicode_w(space.repr(self.w_name))
return space.newunicode(u"<DirEntry %s>" % u)
def fget_name(self, space):
return self.w_name
def fget_path(self, space):
w_path = self.w_path
if w_path is None:
w_path_prefix = self.scandir_iterator.w_path_prefix
w_path = space.add(w_path_prefix, self.w_name)
self.w_path = w_path
return w_path
# The internal methods, used to implement the public methods at
# the end of the class. Every method only calls methods *before*
# it in program order, so there is no cycle.
if not _WIN32:
def get_lstat(self):
"""Get the lstat() of the direntry."""
if (self.flags & FLAG_LSTAT) == 0:
# Unlike CPython, try to use fstatat() if possible
dirfd = self.scandir_iterator.dirfd
if rposix.HAVE_FSTATAT and dirfd != -1:
st = rposix_stat.fstatat(self.name, dirfd,
follow_symlinks=False)
else:
path = self.space.fsencode_w(self.fget_path(self.space))
st = rposix_stat.lstat(path)
self.d_lstat = st
self.flags |= FLAG_LSTAT
return self.d_lstat
def get_stat(self):
"""Get the stat() of the direntry. This is implemented in
such a way that it won't do both a stat() and a lstat().
"""
if (self.flags & FLAG_STAT) == 0:
# We don't have the 'd_stat'. If the known_type says the
# direntry is not a DT_LNK, then try to get and cache the
# 'd_lstat' instead. Then, or if we already have a
# 'd_lstat' from before, *and* if the 'd_lstat' is not a
# S_ISLNK, we can reuse it unchanged for 'd_stat'.
#
# Note how, in the common case where the known_type says
# it is a DT_REG or DT_DIR, then we call and cache lstat()
# and that's it. Also note that in a d_type-less OS or on
# a filesystem that always answer DT_UNKNOWN, this method
# will instead only call at most stat(), but not cache it
# as 'd_lstat'.
known_type = self.flags & 255
if (known_type != rposix_scandir.DT_UNKNOWN and
known_type != rposix_scandir.DT_LNK):
self.get_lstat() # fill the 'd_lstat' cache
have_lstat = True
else:
have_lstat = (self.flags & FLAG_LSTAT) != 0
if have_lstat:
# We have the lstat() but not the stat(). They are
# the same, unless the 'd_lstat' is a S_IFLNK.
must_call_stat = stat.S_ISLNK(self.d_lstat.st_mode)
else:
must_call_stat = True
if must_call_stat:
# Must call stat(). Try to use fstatat() if possible
dirfd = self.scandir_iterator.dirfd
if dirfd != -1 and rposix.HAVE_FSTATAT:
st = rposix_stat.fstatat(self.name, dirfd,
follow_symlinks=True)
else:
path = self.space.fsencode_w(self.fget_path(self.space))
st = rposix_stat.stat(path)
else:
st = self.d_lstat
self.d_stat = st
self.flags |= FLAG_STAT
return self.d_stat
def get_stat_or_lstat(self, follow_symlinks):
if follow_symlinks:
return self.get_stat()
else:
return self.get_lstat()
def check_mode(self, follow_symlinks):
"""Get the stat() or lstat() of the direntry, and return the
S_IFMT. If calling stat()/lstat() gives us ENOENT, return -1
instead; it is better to give up and answer "no, not this type"
to requests, rather than propagate the error.
"""
try:
st = self.get_stat_or_lstat(follow_symlinks)
except OSError as e:
if e.errno == ENOENT: # not found
return -1
raise wrap_oserror2(self.space, e, self.fget_path(self.space),
eintr_retry=False)
return stat.S_IFMT(st.st_mode)
else:
# Win32
stat_cached = False
def check_mode(self, follow_symlinks):
return self.flags
def get_stat_or_lstat(self, follow_symlinks): # 'follow_symlinks' ignored
if not self.stat_cached:
path = self.space.unicode0_w(self.fget_path(self.space))
self.d_stat = rposix_stat.stat(path)
self.stat_cached = True
return self.d_stat
def is_dir(self, follow_symlinks):
known_type = self.flags & 255
if not _WIN32 and known_type != rposix_scandir.DT_UNKNOWN:
if known_type == rposix_scandir.DT_DIR:
return True
elif follow_symlinks and known_type == rposix_scandir.DT_LNK:
pass # don't know in this case
else:
return False
return self.check_mode(follow_symlinks) == stat.S_IFDIR
def is_file(self, follow_symlinks):
known_type = self.flags & 255
if not _WIN32 and known_type != rposix_scandir.DT_UNKNOWN:
if known_type == rposix_scandir.DT_REG:
return True
elif follow_symlinks and known_type == rposix_scandir.DT_LNK:
pass # don't know in this case
else:
return False
return self.check_mode(follow_symlinks) == stat.S_IFREG
def is_symlink(self):
"""Check if the direntry is a symlink. May get the lstat()."""
known_type = self.flags & 255
if not _WIN32 and known_type != rposix_scandir.DT_UNKNOWN:
return known_type == rposix_scandir.DT_LNK
return self.check_mode(follow_symlinks=False) == stat.S_IFLNK
@unwrap_spec(follow_symlinks=bool)
def descr_is_dir(self, space, __kwonly__, follow_symlinks=True):
"""return True if the entry is a directory; cached per entry"""
return space.newbool(self.is_dir(follow_symlinks))
@unwrap_spec(follow_symlinks=bool)
def descr_is_file(self, space, __kwonly__, follow_symlinks=True):
"""return True if the entry is a file; cached per entry"""
return space.newbool(self.is_file(follow_symlinks))
def descr_is_symlink(self, space):
"""return True if the entry is a symbolic link; cached per entry"""
return space.newbool(self.is_symlink())
@unwrap_spec(follow_symlinks=bool)
def descr_stat(self, space, __kwonly__, follow_symlinks=True):
"""return stat_result object for the entry; cached per entry"""
try:
st = self.get_stat_or_lstat(follow_symlinks)
except OSError as e:
raise wrap_oserror2(space, e, self.fget_path(space),
eintr_retry=False)
return build_stat_result(space, st)
def descr_inode(self, space):
inode = self.inode
if inode is None: # _WIN32
try:
st = self.get_stat_or_lstat(follow_symlinks=False)
except OSError as e:
raise wrap_oserror2(space, e, self.fget_path(space),
eintr_retry=False)
inode = st.st_ino
return space.newint(inode)
W_DirEntry.typedef = TypeDef(
'posix.DirEntry',
__repr__ = interp2app(W_DirEntry.descr_repr),
name = GetSetProperty(W_DirEntry.fget_name,
doc="the entry's base filename, relative to "
'scandir() "path" argument'),
path = GetSetProperty(W_DirEntry.fget_path,
doc="the entry's full path name; equivalent to "
"os.path.join(scandir_path, entry.name)"),
is_dir = interp2app(W_DirEntry.descr_is_dir),
is_file = interp2app(W_DirEntry.descr_is_file),
is_symlink = interp2app(W_DirEntry.descr_is_symlink),
stat = interp2app(W_DirEntry.descr_stat),
inode = interp2app(W_DirEntry.descr_inode),
)
W_DirEntry.typedef.acceptable_as_base_class = False
|