Python中列出目录下所有文件的方法

技术背景

在Python编程中，经常需要列出目录下的所有文件，根据不同的需求，可能只需要列出当前目录下的文件，也可能需要递归列出子目录下的所有文件。Python提供了多种方法来实现这一功能，下面将详细介绍这些方法。

实现步骤

1. os.listdir()方法

os.listdir() 可以返回目录下的所有内容，包括文件和目录。使用 os.path.isfile() 可以过滤出其中的文件。

from os import listdir
from os.path import isfile, join
mypath = '.'  # 当前目录
onlyfiles = [f for f in listdir(mypath) if isfile(join(mypath, f))]

2. os.walk()方法

os.walk() 可以递归遍历目录树，对于每个目录，它会返回一个三元组 (dirpath, dirnames, filenames)。

from os import walk
mypath = '.'
f = []
for (dirpath, dirnames, filenames) in walk(mypath):
    f.extend(filenames)
    break  # 只获取顶层目录的文件

或者使用更简洁的写法：

from os import walk
filenames = next(walk(mypath), (None, None, []))[2]  # [] if no file

3. glob模块

glob 模块可以进行模式匹配和扩展。

import glob
# 列出当前目录下所有文件和目录
print(glob.glob("*"))
# 列出当前目录下所有 .txt 文件
print(glob.glob("*.txt"))

4. pathlib模块（Python 3.4+）

pathlib 提供了面向对象的文件系统路径操作方式。

import pathlib
root_dir = "root_dir"
root_dir_instance = pathlib.Path(root_dir)
# 列出根目录下所有直接子项的名称
print([item.name for item in root_dir_instance.glob("*")])
# 列出根目录下所有文件的路径
print([os.path.join(item.parent.name, item.name) for item in root_dir_instance.glob("*") if not item.is_dir()])

5. os.scandir()方法（Python 3.5+）

os.scandir() 返回一个迭代器，包含目录中的条目。

import os
root_dir = os.path.join(".", "root_dir")
scandir_iterator = os.scandir(root_dir)
# 列出根目录下所有条目路径
print([item.path for item in scandir_iterator])

核心代码

使用 os.listdir() 过滤文件

from os import listdir
from os.path import isfile, join
mypath = '.'
onlyfiles = [f for f in listdir(mypath) if isfile(join(mypath, f))]
print(onlyfiles)

使用 os.walk() 递归获取文件

from os import walk
mypath = '.'
file_paths = []
for root, dirs, files in walk(mypath):
    for file in files:
        file_paths.append(os.path.join(root, file))
print(file_paths)

使用 glob 模块匹配文件

import glob
# 列出当前目录下所有 .txt 文件
txt_files = glob.glob("*.txt")
print(txt_files)

使用 pathlib 模块获取文件

import pathlib
folder = '.'
file_list = [f for f in pathlib.Path(folder).glob('*') if f.is_file()]
print(file_list)

最佳实践

• 根据需求选择合适的方法：如果只需要列出当前目录下的文件，os.listdir() 或 os.scandir() 是不错的选择；如果需要递归列出子目录下的文件，os.walk() 或 glob 模块更合适；如果需要面向对象的路径操作，pathlib 模块是首选。
• 考虑性能：对于大型目录树，os.walk() 和 glob.iglob() 可能更高效，因为它们使用了生成器。
• 错误处理：在实际应用中，应该添加适当的错误处理代码，以确保程序的健壮性。

常见问题

1. 如何处理递归深度问题？

在使用递归方法（如 os.walk()）时，如果目录树的深度过大，可能会导致栈溢出。可以考虑使用迭代方法或调整递归深度限制。

2. 如何处理路径分隔符问题？

不同操作系统使用不同的路径分隔符（Windows 使用 \，Unix/Linux 使用 /）。可以使用 os.path.join() 或 pathlib 模块来处理路径，以确保代码的跨平台兼容性。

3. 如何过滤特定类型的文件？

可以使用 os.path.splitext() 或 fnmatch 模块来过滤特定类型的文件。例如，过滤出所有 .txt 文件：

import os
import fnmatch
mypath = '.'
txt_files = [f for f in os.listdir(mypath) if fnmatch.fnmatch(f, '*.txt')]
print(txt_files)