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

annotate cutils/util/walk.py @ 274:224725fd9f2f

WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...)

author	Franz Glasner <fzglas.hg@dom66.de>
date	Wed, 19 Feb 2025 16:42:44 +0100
parents	c02a57df2a29
children	f7850ff5cbe0

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
196 0f4febf646f5 Prepare for more Python2/3 compatibility: everywhere import print_function and absolute_import Franz Glasner <fzglas.hg@dom66.de> parents: 195 diff changeset	10 from __future__ import print_function, absolute_import
0f4febf646f5 Prepare for more Python2/3 compatibility: everywhere import print_function and absolute_import Franz Glasner <fzglas.hg@dom66.de> parents: 195 diff changeset	11
0f4febf646f5 Prepare for more Python2/3 compatibility: everywhere import print_function and absolute_import Franz Glasner <fzglas.hg@dom66.de> parents: 195 diff changeset	12
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	13 __all__ = ["WalkDirEntry", "ScanDir", "getfsencoding"]
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	14
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	15
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	16 import os
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 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	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 try:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	21 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	22 except ImportError:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	23 scandir = None
273 c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	24 import stat
198 c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding> Franz Glasner <fzglas.hg@dom66.de> parents: 196 diff changeset	25 import sys
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	26
164 a813094ae4f5 Move PY2 from cutils.util.constants into cutils.util Franz Glasner <fzglas.hg@dom66.de> parents: 162 diff changeset	27 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	28
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	29
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	30 _notset = object()
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	31
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	32
198 c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding> Franz Glasner <fzglas.hg@dom66.de> parents: 196 diff changeset	33 _FSENCODING = sys.getfilesystemencoding()
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding> Franz Glasner <fzglas.hg@dom66.de> parents: 196 diff changeset	34
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding> Franz Glasner <fzglas.hg@dom66.de> parents: 196 diff changeset	35
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	36 if PY2:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	37
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	38 def _unix_path(s):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	39 if isinstance(s, bytes):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	40 return s.replace(b"\\", b"/")
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	41 return s.replace(u"\\", u"/")
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	42
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	43 else:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	44
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	45 def _unix_path(s):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	46 return s.replace("\\", "/")
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	47
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	48
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	49 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	50
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	51 """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	52 its results.
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	53
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	54 """
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	55
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	56 __slots__ = ("_name", "_path", # encoded as given in the ctor
273 c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	57 "_is_symlink", "_is_reg", "_is_dir", "_stat_result",
c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	58 "_stat_errno", "_stat_errstr",
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	59 "_alt_fsname", "_alt_u8name")
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	60
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	61 def __init__(self, name, path):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	62 self._name = name # the name as given in the constructor
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	63 """The name exactly as given in the ctor"""
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	64 self._path = _unix_path(path)
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	65 """The path as given in the ctor -- but normalized to have slashes"""
273 c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	66 self._is_symlink = self._is_reg = self._is_dir = self._stat_result = \
266 0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	67 self._stat_errno = self._stat_errstr = None
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	68 self._alt_fsname = self._alt_u8name = _notset
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	69
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	70 @property
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	71 def name(self):
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	72 """The original name exactly as given in the ctor"""
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	73 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	74
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	75 @property
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	76 def path(self):
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	77 """The original path exactly as given in the ctor."""
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	78 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	79
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	80 @property
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	81 def fsname(self):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	82 """The name as bytes for the filesystem.
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	83
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	84 :rtype: bytes or None
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	85
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	86 """
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	87 if PY2:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	88 if isinstance(self._name, bytes):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	89 return self._name
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	90 try:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	91 return self._name.encode(_FSENCODING, "strict")
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	92 except UnicodeError:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	93 return None
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	94 else:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	95 return os.fsencode(self._name)
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	96
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	97 @property
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	98 def alt_fsname(self):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	99 """Alternative and "escaped" filesystem name -- always bytes.
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	100
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	101 :rtype: bytes
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	102
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	103 """
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	104 if self._alt_fsname is _notset:
203 3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	105 self._alt_fsname = WalkDirEntry.alt_fs(self._name)
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	106 return self._alt_fsname
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	107
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	108 @property
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	109 def fspath(self):
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	110 """Always bytes.
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	111
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	112 :rtype: bytes or None
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	113
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	114 """
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	115 if PY2:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	116 if isinstance(self._path, bytes):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	117 return self._path
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	118 try:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	119 return self._path.encode(_FSENCODING, "strict")
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	120 except UnicodeError:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	121 return None
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	122 else:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	123 return os.fsencode(self._path)
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	124
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	125 @property
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	126 def alt_fspath(self):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	127 """Alternative and "escaped" filesystem path -- always bytes.
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	128
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	129 :rtype: bytes
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	130
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	131 """
203 3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	132 return WalkDirEntry.alt_fs(self._path)
3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	133
3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	134 @staticmethod
3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	135 def alt_fs(what):
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	136 if PY2:
203 3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	137 if isinstance(what, bytes):
3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	138 return what
3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	139 return what.encode(_FSENCODING, "backslashreplace")
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	140 else:
203 3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	141 return os.fsencode(what)
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	142
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	143 @property
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	144 def uname(self):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	145 """Always "real", strictly encoded Unicode or `None` if this is not
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	146 possible.
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	147
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	148 :rtype: text or None
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	149
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	150 """
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	151 if PY2:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	152 if isinstance(self._name, bytes):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	153 try:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	154 return self._name.decode(_FSENCODING, "strict")
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	155 except UnicodeError:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	156 return None
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	157 else:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	158 return self._name
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	159 else:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	160 try:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	161 self._name.encode("utf-8", "strict")
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	162 except UnicodeError:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	163 return None
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	164 return self._name
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	165
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	166 @property
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	167 def upath(self):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	168 """Always "real", strictly encoded Unicode or `None` if this is not
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	169 possible.
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	170
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	171 :rtype: text or None
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	172
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	173 """
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	174 if PY2:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	175 if isinstance(self._path, bytes):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	176 try:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	177 return self._path.decode(_FSENCODING, "strict")
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	178 except UnicodeError:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	179 return None
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	180 else:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	181 return self._path
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	182 else:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	183 try:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	184 self._path.encode("utf-8", "strict")
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	185 except UnicodeError:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	186 return None
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	187 return self._path
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	188
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	189 @property
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	190 def u8name(self):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	191 """`.uname` as UTF-8 or `None` (as strict as `uname`)"""
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	192 n = self.uname
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	193 return n if n is None else n.encode("utf-8", "strict")
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	194
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	195 @property
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	196 def u8path(self):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	197 """`.upath` as UTF-8 or `None` (as strict as `upath`"""
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	198 p = self.upath
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	199 return p if p is None else p.encode("utf-8", "strict")
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	200
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	201 @property
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	202 def alt_u8name(self):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	203 if self._alt_u8name is _notset:
203 3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	204 self._alt_u8name = WalkDirEntry.alt_u8(self._name)
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	205 return self._alt_u8name
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	206
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	207 @property
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	208 def alt_u8path(self):
203 3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	209 return WalkDirEntry.alt_u8(self._path)
3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	210
3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	211 @staticmethod
3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	212 def alt_u8(what):
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	213 if PY2:
203 3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	214 if isinstance(what, bytes):
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	215 try:
203 3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	216 return (what.decode(_FSENCODING, "strict")
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	217 .encode("utf-8", "strict"))
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	218 except UnicodeError:
203 3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	219 return (WalkDirEntry.surrogate_decode(what)
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	220 .encode("ascii", "backslashreplace"))
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	221 else:
203 3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	222 return what.encode("ascii", "backslashreplace")
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	223 else:
203 3a85f7bbe0b1 Common static method for some alternative encodings Franz Glasner <fzglas.hg@dom66.de> parents: 201 diff changeset	224 return what.encode("utf-8", "backslashreplace")
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	225
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	226 @property
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	227 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	228 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	229
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	230 @property
273 c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	231 def is_reg(self):
c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	232 return self._is_reg
c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	233
c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	234 @property
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	235 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	236 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	237
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	238 @property
274 224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	239 def is_chr(self):
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	240 return (stat.S_ISCHR(self._stat_result.st_mode)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	241 if self._stat_result is not None
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	242 else False)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	243
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	244 @property
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	245 def is_blk(self):
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	246 return (stat.S_ISBLK(self._stat_result.st_mode)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	247 if self._stat_result is not None
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	248 else False)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	249
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	250 @property
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	251 def is_fifo(self):
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	252 return (stat.S_ISFIFO(self._stat_result.st_mode)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	253 if self._stat_result is not None
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	254 else False)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	255
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	256 @property
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	257 def is_socket(self):
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	258 return (stat.S_ISSOCK(self._stat_result.st_mode)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	259 if self._stat_result is not None
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	260 else False)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	261
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	262 @property
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	263 def is_door(self):
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	264 test = getattr(stat, "S_ISDOOR", None)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	265 return (test(self._stat_result.st_mode)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	266 if test and (self._stat_result is not None)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	267 else False)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	268
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	269 @property
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	270 def is_eventport(self):
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	271 test = getattr(stat, "S_ISPORT", None)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	272 return (test(self._stat_result.st_mode)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	273 if test and (self._stat_result is not None)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	274 else False)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	275
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	276 @property
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	277 def is_whiteout(self):
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	278 test = getattr(stat, "S_ISWHT", None)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	279 return (test(self._stat_result.st_mode)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	280 if test and (self._stat_result is not None)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	281 else False)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	282
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	283 @property
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	284 def is_special(self):
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	285 """Anything besides a regular file and a directory"""
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	286 if self._stat_result is None:
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	287 return False
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	288 return not (self.is_reg or self.is_dir)
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	289
224725fd9f2f WalkDirEntry: add support for special files (character and block special, FIFO, socket, door, whiteout, event port, ...) Franz Glasner <fzglas.hg@dom66.de> parents: 273 diff changeset	290 @property
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	291 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	292 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	293
266 0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	294 @property
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	295 def stat_errno(self):
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	296 return self._stat_errno
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	297
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	298 @property
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	299 def stat_errstr(self):
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	300 return self._stat_errstr
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	301
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	302 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	303 tag = ""
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	304 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	305 tag += "l"
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	306 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	307 tag += "d"
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	308 if tag:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	309 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	310 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	311
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	312 @classmethod
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	313 def from_direntry(cls_, entry):
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	314 w = cls_(entry.name, entry.path)
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	315 try:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	316 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	317 except OSError:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	318 #
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	319 # 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	320 # 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	321 #
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	322 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	323 try:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	324 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	325 except OSError:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	326 #
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	327 # 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	328 # 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	329 #
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	330 w._is_symlink = False
266 0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	331 # Consistently follow symlinks
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	332 try:
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	333 w._stat_result = entry.stat(follow_symlinks=True)
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	334 except OSError as e:
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	335 w._stat_result = None
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	336 w._stat_errno = e.errno
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	337 w._stat_errstr = e.strerror
273 c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	338 w._is_reg = False
c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	339 else:
c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	340 w._is_reg = stat.S_ISREG(w._stat_result.st_mode)
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	341 return w
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	342
162 29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	343 @classmethod
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	344 def from_path_name(cls_, path, name, _do_stat=True):
265 188f448ab5e9 FIX: typo in docs Franz Glasner <fzglas.hg@dom66.de> parents: 221 diff changeset	345 """`_do_stat` is to be used only for testing purposes"""
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	346 w = cls_(name, os.path.join(path, name))
162 29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	347 try:
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	348 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	349 except OSError:
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	350 #
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	351 # 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	352 # 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	353 #
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	354 w._is_dir = False
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	355 try:
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	356 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	357 except OSError:
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	358 #
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	359 # 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	360 # 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	361 #
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	362 w._is_symlink = False
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	363 if _do_stat:
266 0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	364 try:
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	365 w._stat_result = os.stat(w._path)
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	366 except OSError as e:
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	367 w._stat_result = None
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	368 w._stat_errno = e.errno
0add8276e6b8 treesum: Handle errors like broken symlinks properly Franz Glasner <fzglas.hg@dom66.de> parents: 265 diff changeset	369 w._stat_errstr = e.strerror
273 c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	370 w._is_reg = False
c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	371 else:
c02a57df2a29 treesum: - WalkDirEntry tests with a FIFO special file - WalkDirEntry.is_reg Franz Glasner <fzglas.hg@dom66.de> parents: 266 diff changeset	372 w._is_reg = stat.S_ISREG(w._stat_result.st_mode)
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	373 return w
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	374
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	375 @classmethod
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	376 def from_readlink(cls_, path):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	377 w = cls_(os.path.basename(path), path)
162 29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	378 return w
29dd5528174c Implement walk._walk() using os.listdir() also. Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	379
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	380 @staticmethod
221 ca9d5a0dc9bb Rename WalkDirEntry.sort_key and WalkDirEntry.alt_sort_key Franz Glasner <fzglas.hg@dom66.de> parents: 203 diff changeset	381 def sort_key_fs(entry):
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	382 return entry.alt_fsname # because it should never throw
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	383
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	384 @staticmethod
221 ca9d5a0dc9bb Rename WalkDirEntry.sort_key and WalkDirEntry.alt_sort_key Franz Glasner <fzglas.hg@dom66.de> parents: 203 diff changeset	385 def sort_key_u8(entry):
201 58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	386 return entry.alt_u8name # because it should never throw
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	387
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	388 if PY2:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	389
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	390 @staticmethod
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	391 def surrogate_decode(what):
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	392 """Decode the bytes object `what` using surrogates from :pep:`383`
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	393 for all non-ASCII octets.
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	394
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	395 """
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	396 uwhat = []
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	397 assert isinstance(what, bytes)
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	398 for ch in what:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	399 chcode = ord(ch)
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	400 if chcode <= 0x7f:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	401 uwhat.append(unichr(chcode)) # noqa: F821 unichr
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	402 else:
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	403 uwhat.append(unichr(0xDC00 + chcode)) # noqa: F821 unichr
58d93453c307 Much more encoding-related methods for DirWalkEntry and some unittests Franz Glasner <fzglas.hg@dom66.de> parents: 199 diff changeset	404 return u"".join(uwhat)
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	405
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	406
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	407 if scandir:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	408
178 dac26a2d9de5 Cleanup: remove non used walk-code Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	409 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	410
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	411 """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	412 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	413
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	414 """
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	415
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	416 __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	417
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	418 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	419 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	420 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	421
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	422 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	423 return self
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	424
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	425 def __next__(self):
199 b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	426 if self._scandir_it is None:
b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	427 raise StopIteration("closed")
175 506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	428 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	429
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	430 if PY2:
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	431 next = __next__
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	432
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	433 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	434 return self
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	435
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	436 def __exit__(self, args, *kwds):
199 b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	437 self.close()
b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	438
b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	439 def close(self):
b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	440 if self._scandir_it is not None:
b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	441 if hasattr(self._scandir_it, "close"):
b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	442 self._scandir_it.close()
b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	443 self._scandir_it = None
175 506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	444
121 2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	445 else:
2dc26a2f3d1c A heavily customized "os.walk()" alike to support the coming treeview implementation Franz Glasner <fzglas.hg@dom66.de> parents: diff changeset	446
178 dac26a2d9de5 Cleanup: remove non used walk-code Franz Glasner <fzglas.hg@dom66.de> parents: 177 diff changeset	447 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	448
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	449 """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	450 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	451
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	452 """
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	453
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	454 __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	455
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	456 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	457 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	458 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	459 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	460
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	461 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	462 return self
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	463
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	464 def __next__(self):
199 b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	465 if self._listdir_it is None:
b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	466 raise StopIteration("closed")
175 506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	467 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	468 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	469
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	470 if PY2:
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	471 next = __next__
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	472
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	473 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	474 return self
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	475
506d895a8500 Implement cutils.util.walk.Scandir as a wrapper for os.scandir() Franz Glasner <fzglas.hg@dom66.de> parents: 164 diff changeset	476 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	477 pass
198 c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding> Franz Glasner <fzglas.hg@dom66.de> parents: 196 diff changeset	478
199 b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	479 def close(self):
b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	480 pass
b2aba84ca426 Implement a "close()" method for cutils.util.walk.ScanDir. Franz Glasner <fzglas.hg@dom66.de> parents: 198 diff changeset	481
198 c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding> Franz Glasner <fzglas.hg@dom66.de> parents: 196 diff changeset	482
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding> Franz Glasner <fzglas.hg@dom66.de> parents: 196 diff changeset	483 def getfsencoding():
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding> Franz Glasner <fzglas.hg@dom66.de> parents: 196 diff changeset	484 """Return the stored _FSENCODING of this module"""
c1e875ba4bdc Put the effective filesystem encoding into the treesum digest file using FSENCODING = <encoding> Franz Glasner <fzglas.hg@dom66.de> parents: 196 diff changeset	485 return _FSENCODING

Mercurial > hgrepos > Python > apps > py-cutils

annotate cutils/util/walk.py @ 274:224725fd9f2f