Python/apps/py-cutils: cutils/util/walk.py annotate

annotate cutils/util/walk.py @ 195:e5f6f4db9157

Use the imported "scandir()" implementation instead always the "os.scandir"

author	Franz Glasner <fzglas.hg@dom66.de>
date	Thu, 16 Jan 2025 19:31:57 +0100
parents	188de62caac6
children	0f4febf646f5

rev	line source
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	1 # -- coding: utf-8 --
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	2 # :-
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	3 # :Copyright: (c) 2020-2025 Franz Glasner
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	4 # :License: BSD-3-Clause
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	5 # :-
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	6 r"""Utility sub-module to implement a heavily customized :func:`os.walk`.
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	7
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	8 """
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	9
178 dac26a2d9de5 Cleanup: remove non used walk-code Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	10 __all__ = ["ScanDir"]
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	11
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	12
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	13 import os
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	14 try:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	15 from os import scandir
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	16 except ImportError:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	17 try:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	18 from scandir import scandir
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	19 except ImportError:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	20 scandir = None
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	21
164 a813094ae4f5 Move PY2 from cutils.util.constants into cutils.util Franz Glasner <fzglas.hg@dom66.de> parents: 162 diff changeset	22 from . import PY2
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	23
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	24
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	25 class WalkDirEntry(object):
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	26
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	27 """A :class:`os.DirEntry` alike to be used in :func:`walk` and for
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	28 its results.
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	29
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	30 """
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	31
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	32 __slots__ = ("_name", "_fsname", "_path", "_fspath", "_is_symlink",
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	33 "_is_dir", "_stat_result")
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	34
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	35 def __init__(self, name):
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	36 self._name = name
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	37 if PY2:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	38 assert isinstance(name, bytes)
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	39 self._fsname = name
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	40 else:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	41 self._fsname = os.fsencode(name)
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	42 self._path = None
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	43 self._fspath = None
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	44 self._is_symlink = self._is_dir = self._stat_result = None
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	45
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	46 @property
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	47 def name(self):
192 188de62caac6 Comment WalkDirEntry properties somewhat Franz Glasner <fzglas.hg@dom66.de> parents: 178 diff changeset	48 """The native name"""
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	49 return self._name
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	50
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	51 @property
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	52 def fsname(self):
192 188de62caac6 Comment WalkDirEntry properties somewhat Franz Glasner <fzglas.hg@dom66.de> parents: 178 diff changeset	53 """The name as bytes"""
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	54 return self._fsname
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	55
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	56 @property
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	57 def path(self):
192 188de62caac6 Comment WalkDirEntry properties somewhat Franz Glasner <fzglas.hg@dom66.de> parents: 178 diff changeset	58 """Always native"""
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	59 return self._path
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	60
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	61 @property
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	62 def fspath(self):
192 188de62caac6 Comment WalkDirEntry properties somewhat Franz Glasner <fzglas.hg@dom66.de> parents: 178 diff changeset	63 """Always bytes"""
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	64 if self._path is not None:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	65 if self._fspath is None:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	66 if PY2:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	67 assert isinstance(self._path, bytes)
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	68 self._fspath = self._path
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	69 else:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	70 self._fspath = os.fsencode(self._path)
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	71 return self._fspath
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	72
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	73 @property
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	74 def is_symlink(self):
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	75 return self._is_symlink
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	76
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	77 @property
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	78 def is_dir(self):
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	79 return self._is_dir
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	80
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	81 @property
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	82 def stat(self):
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	83 return self._stat_result
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	84
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	85 def __repr__(self):
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	86 tag = ""
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	87 if self._is_symlink:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	88 tag += "l"
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	89 if self._is_dir:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	90 tag += "d"
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	91 if tag:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	92 return "<WalkDirEntry %r (%s)>" % (self._name, tag)
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	93 return "<WalkDirEntry %r>" % (self._name,)
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	94
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	95 @classmethod
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	96 def from_direntry(cls_, entry):
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	97 w = cls_(entry.name)
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	98 w._path = entry.path
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	99 try:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	100 w._is_dir = entry.is_dir(follow_symlinks=True)
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	101 except OSError:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	102 #
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	103 # If is_dir() raises an OSError, consider that the entry
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	104 # is not a directory, same behaviour than os.path.isdir().
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	105 #
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	106 w._is_dir = False
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	107 try:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	108 w._is_symlink = entry.is_symlink()
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	109 except OSError:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	110 #
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	111 # If is_symlink() raises an OSError, consider that the entry
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	112 # is not a symbolic link, same behaviour than os.path.islink().
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	113 #
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	114 w._is_symlink = False
156 481cc9b26861 Calculate "stat()" for directories also in a WalkDirEntry Franz Glasner <fzglas.hg@dom66.de> parents: 155 diff changeset	115 # Do not supress errors here and (consistently) follow symlinks
481cc9b26861 Calculate "stat()" for directories also in a WalkDirEntry Franz Glasner <fzglas.hg@dom66.de> parents: 155 diff changeset	116 w._stat_result = entry.stat(follow_symlinks=True)
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	117 return w
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	118
162 29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	119 @classmethod
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	120 def from_path_name(cls_, path, name):
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	121 w = cls_(name)
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	122 w._path = os.path.join(path, name)
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	123 try:
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	124 w._is_dir = os.path.isdir(w._path)
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	125 except OSError:
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	126 #
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	127 # If is_dir() raises an OSError, consider that the entry
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	128 # is not a directory, same behaviour than os.path.isdir().
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	129 #
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	130 w._is_dir = False
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	131 try:
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	132 w._is_symlink = os.path.islink(w._path)
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	133 except OSError:
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	134 #
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	135 # If is_symlink() raises an OSError, consider that the entry
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	136 # is not a symbolic link, same behaviour than os.path.islink().
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	137 #
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	138 w._is_symlink = False
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	139 w._stat_result = os.stat(w._path)
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	140 return w
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	141
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	142 @staticmethod
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	143 def sort_key(entry):
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	144 return entry._fsname
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	145
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	146
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	147 if scandir:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	148
178 dac26a2d9de5 Cleanup: remove non used walk-code Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	149 class ScanDir(object):
175 506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	150
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	151 """An :func:`os.scandir` wrapper that is always an iterator and
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	152 a context manager.
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	153
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	154 """
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	155
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	156 __slots__ = ("_scandir_it", )
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	157
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	158 def __init__(self, path):
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	159 super(ScanDir, self).__init__()
195 e5f6f4db9157 Use the imported "scandir()" implementation instead always the "os.scandir" Franz Glasner <fzglas.hg@dom66.de> parents: 192 diff changeset	160 self._scandir_it = scandir(path)
175 506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	161
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	162 def __iter__(self):
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	163 return self
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	164
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	165 def __next__(self):
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	166 return WalkDirEntry.from_direntry(next(self._scandir_it))
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	167
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	168 if PY2:
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	169 next = __next__
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	170
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	171 def __enter__(self):
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	172 return self
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	173
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	174 def __exit__(self, args, *kwds):
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	175 if hasattr(self._scandir_it, "close"):
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	176 self._scandir_it.close()
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	177
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	178 else:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	179
178 dac26a2d9de5 Cleanup: remove non used walk-code Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	180 class ScanDir(object):
175 506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	181
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	182 """An :func:`os.scandir` wrapper that is always an iterator and
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	183 a context manager.
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	184
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	185 """
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	186
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	187 __slots__ = ("_listdir_it", "_path")
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	188
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	189 def __init__(self, path):
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	190 super(ScanDir, self).__init__()
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	191 self._listdir_it = iter(os.listdir(path))
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	192 self._path = path
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	193
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	194 def __iter__(self):
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	195 return self
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	196
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	197 def __next__(self):
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	198 return WalkDirEntry.from_path_name(self._path,
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	199 next(self._listdir_it))
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	200
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	201 if PY2:
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	202 next = __next__
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	203
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	204 def __enter__(self):
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	205 return self
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	206
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	207 def __exit__(self, args, *kwds):
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	208 pass

Mercurial > hgrepos > Python > apps > py-cutils

annotate cutils/util/walk.py @ 195:e5f6f4db9157