os.walk 是 Python 标准库 os 模块中的一个函数,用于生成目录树下的所有文件名。它是一个非常有用的工具,特别是在需要递归遍历目录结构时。下面是对 os.walk 的详细解释和使用示例。
函数签名
os.walk(top, topdown=True, onerror=None, followlinks=False)
参数
- top:需要遍历的目录的路径。
- topdown:可选参数,默认为 True。如果为 True,则先遍历顶层目录,再遍历子目录;如果为 False,则先遍历子目录,再遍历顶层目录。
- onerror:可选参数,是一个函数。如果在遍历目录时发生错误,会调用这个函数,传递一个 OSError 实例。如果未提供该参数,错误将被忽略。
- followlinks:可选参数,默认为 False。如果为 True,则会遍历目录中的符号链接。
返回值
os.walk 返回一个生成器,每次迭代生成一个三元组 (dirpath, dirnames, filenames):
- dirpath:当前遍历的目录路径。
- dirnames:当前目录下的子目录列表。
- filenames:当前目录下的文件列表。
示例
以下是一个使用 os.walk 的示例,遍历一个目录并打印出所有的文件和目录:
import os
import re# 指定要遍历的目录为当前目录
top_directory = os.getcwd()
# 指定要遍历的目录
# top_directory = '/path/to/directory'# 遍历目录
for dirpath, dirnames, filenames in os.walk(top_directory):print(f'当前目录路径: {dirpath}')print(f'子目录: {dirnames}')print(f'文件: {filenames}')print('------------------------')
示例解释
- os.walk(top_directory) 返回一个生成器。
- 每次迭代生成一个三元组 (dirpath, dirnames, filenames)。
- dirpath 是当前遍历的目录路径。
- dirnames 是当前目录下的子目录列表。
- filenames 是当前目录下的文件列表。
递归删除目录中的所有文件
以下是一个使用 os.walk 递归删除目录中所有文件的示例:
import osdef delete_files_in_directory(directory):for dirpath, dirnames, filenames in os.walk(directory, topdown=False):for filename in filenames:file_path = os.path.join(dirpath, filename)os.remove(file_path)print(f'已删除文件: {file_path}')for dirname in dirnames:dir_path = os.path.join(dirpath, dirname)os.rmdir(dir_path)print(f'已删除目录: {dir_path}')# 指定要删除文件的目录
directory_to_clean = '/path/to/directory'# 删除目录中的所有文件
delete_files_in_directory(directory_to_clean)