scandir 1.10.0

walk()

scandir.walk() 的 API 与 os.walk() 完全相同，所以只需阅读 Python 文档。

scandir()

scandir() 和它产生的 DirEntry 对象的完整文档可以在此处找到。但以下是一个简要的总结。

scandir(path=’.’) -> 给定路径的 DirEntry 对象的迭代器

与 listdir 类似，scandir 调用操作系统的目录迭代系统调用以获取给定 path 中的文件名，但它与 listdir 有两点不同

• 它返回轻量级的 DirEntry 对象，而不是裸露的文件名字符串，这些对象包含文件名字符串并提供简单的方法，允许访问操作系统可能返回的额外数据。

• 它返回一个生成器而不是列表，因此 scandir 作为真正的迭代器而不是立即返回完整列表。

scandir() 为 path 中的每个文件和子目录生成一个 DirEntry 对象。就像 listdir 一样，跳过了 '.' 和 '..' 伪目录，并且条目按系统依赖的顺序生成。每个 DirEntry 对象都有以下属性和方法

• name：条目的文件名，相对于 scandir path 参数（对应于 os.listdir 的返回值）

• path：条目的完整路径名（不一定是绝对路径）- 等同于 os.path.join(scandir_path, entry.name)

• is_dir(*, follow_symlinks=True)：类似于 pathlib.Path.is_dir()，但返回值在 DirEntry 对象上缓存；大多数情况下不需要系统调用；如果 follow_symlinks 为 False，则不跟随符号链接

• is_file(*, follow_symlinks=True)：类似于 pathlib.Path.is_file()，但返回值在 DirEntry 对象上缓存；大多数情况下不需要系统调用；如果 follow_symlinks 为 False，则不跟随符号链接

• is_symlink()：类似于 pathlib.Path.is_symlink()，但返回值在 DirEntry 对象上缓存；大多数情况下不需要系统调用

• stat(*, follow_symlinks=True)：类似于 os.stat()，但返回值在 DirEntry 对象上缓存；在 Windows 上不需要系统调用（除了符号链接）；如果 follow_symlinks 为 False，则不跟随符号链接（如 os.lstat()）

• inode()：返回条目的inode号；返回值在 DirEntry 对象上缓存

以下是一个非常简单的 scandir() 示例，展示了 DirEntry.name 属性和 DirEntry.is_dir() 方法的使用

def subdirs(path):
    """Yield directory names not starting with '.' under given path."""
    for entry in os.scandir(path):
        if not entry.name.startswith('.') and entry.is_dir():
            yield entry.name

此 subdirs() 函数在使用 scandir 时比在 Windows 和 POSIX 系统上使用 os.listdir() 和 os.path.isdir() 快得多，特别是在中等大小或大型目录中。