【Python】os.scandir()函数示例以及和os.listdir()函数的对比优势

在 Python 中，os.scandir() 函数是一个用来列出指定目录下的条目（包括文件和子目录）的高效方式。它返回一个迭代器，不仅可以迭代目录中的所有条目，还能访问每个条目的文件属性，如文件类型、文件大小等，而不需要额外的系统调用。这种方法比使用 os.listdir() 更高效，特别是需要访问这些文件属性时。

基本用法

os.scandir() 函数位于 os 模块中，因此首先需要导入 os 模块。以下是其基本语法：

import os

with os.scandir(path) as entries:
    for entry in entries:
        # 使用 entry 对象

参数

• path：要列出其条目的目录的路径。如果未指定或为 None，则默认为当前工作目录。

返回值

• 返回一个 os.DirEntry 对象的迭代器，每个 DirEntry 对象代表目录中的一个条目（文件或子目录）。

DirEntry 对象

每个 DirEntry 对象都提供以下属性和方法，用于获取条目的信息：

• name：返回目录条目的名称（不包括其路径）。
• path：返回条目的完整路径名。
• is_file()：如果条目是一个文件，则返回 True。
• is_dir()：如果条目是一个目录，则返回 True。
• is_symlink()：如果条目是一个符号链接，则返回 True。
• stat()：返回条目的 os.stat() 结果，这是获取文件属性的一种方式。

示例

下面是如何使用 os.scandir() 列出一个目录中所有文件和子目录的示例，同时检查它们是文件还是目录：

import os

path = '/path/to/directory'  # 指定目录的路径

with os.scandir(path) as entries:
    for entry in entries:
        if entry.is_file():
            print(f'{entry.name} is a file.')
        elif entry.is_dir():
            print(f'{entry.name} is a directory.')

这个例子中，我们遍历了指定路径下的所有条目，并打印出了每个条目是文件还是目录的信息。

使用场景

os.scandir() 非常适合于需要高效遍历大量文件的场景，尤其是当你需要检查文件属性（如检查是否为目录、获取文件大小等）时。与 os.listdir() 相比，os.scandir() 在处理大型目录时可以显著提高效率和响应速度。

总之，os.scandir() 是 Python 中处理文件和目录遍历的一个强大工具，特别适用于需要优化文件系统操作性能的应用程序。