你想了解如何使用 Python 列出目录中的文件吗？在本文中，你将了解如何以 4 种不同的方式进行操作，以便你可以选择自己喜欢的一种。

在所有示例中，我们将列出具有以下结构的目录中的文件。我们将调用目录test_dir：

.
├── data
│   └── tech.txt
└── report.txt

1 directory, 2 files

如何使用 Python os.listdir() 列出目录中的文件

Python OS 模块允许执行操作系统任务。该模块带有多种功能，可用于创建、删除和获取文件和目录。OS 模块有一个名为listdir()的函数，它允许列出目录中的文件和子目录。

import os 

directory = '/Users/elio/temp/test_dir'
file_paths = os.listdir(directory) 
print(file_paths)

导入 OS 模块后，我们设置目录路径并将其传递给listdir()函数，该函数列出目录中存在的所有文件。

请注意，listdir()函数返回我们传递给它的目录中的文件和子目录列表，但它不会列出任何子目录中的文件。

事实上，下面的输出不包括数据目录中的tech.txt文件：

注意：如果你使用的是 Windows，则可以根据计算机上test_dir目录的位置设置目录变量的值。

让我们在最后一个 print() 函数之前添加以下 Python 语句以显示file_paths变量的类型。

print(type(file_paths))

当你执行该程序时，你将在输出中看到以下内容，表明file_paths变量是一个Python 列表。

从os.listdir()的输出中，我们不知道listdir()返回的列表的给定元素是文件还是目录，而无需进行任何额外检查。

Python os.walk() 函数如何工作？

要查看所有子目录中的文件列表，我们可以使用基于OS 模块的walk( ) 函数的不同方法。此函数递归地列出文件和子目录。

在使用os.walk()获取测试目录中的文件列表之前，让我们打开 Python shell 了解os.walk()的工作原理。

>>> import os 
>>> dir_content = os.walk( '.' ) 
>>> dir_content 
<generator object walk at 0x7fd09008c430 >

当我们将当前目录（由点标识）传递给os.walk时，我们会得到一个生成器对象。

让我们通过使用next() 函数来了解更多关于生成器对象的信息。

>>> next (dir_content) 
( '.' , [ 'data' ], [ 'report.txt' ])

现在我们可以看到 os.walk() 生成一个Python 元组，其中第一个元素是当前目录，第二个元素是传递给它的目录中的子目录列表，第三个元素是该目录中的文件列表。

让我们再次调用next()函数

>>> next (dir_content) 
( './data' , [], [ 'tech.txt' ])

os.walk()函数自上而下遍历目录，因此当我们第二次调用next ()函数时，我们将它应用于数据子目录。

如果你再次调用next() ，你会得到一个 StopIteration 异常，因为考虑到子目录数据不包含任何子目录，生成器对象中没有更多的值。

>>> next(dir_content)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

如何使用 Python os.walk() 递归地列出目录中的文件

现在我们已经了解了os.walk()的工作原理，让我们编写一些代码来获取我们测试目录中所有文件的列表。

import os

directory = '/Users/elio/temp/test_dir'
file_paths = []
for dir_path, dirs, files in os.walk(directory):
    file_paths.extend([os.path.join(dir_path, file) for file in files])

print(file_paths)

输出：

在上面的示例中，我们使用了三个新变量：

• dir_path — 用于存储生成器对象返回的目录（还记得我们在上一节中看到的有关os.walk()的内容）。
• dirs — 用于存储生成器对象返回的子目录。
• files —用于存储生成器对象返回的文件。

函数os.path.join()通过将目录路径与文件名连接起来返回给定文件的完整路径。

我们还在for 循环中使用了列表理解。

如何使用 Glob Python 模块列出目录中的文件

glob 模块可以返回匹配特定模式的文件的路径。该模块还允许在目录中列出文件。该模块使用通配符来搜索文件。

例如，如果我们只想列出文本文件，那么我们使用通配符 ( .txt )。

import glob 

directory = '/Users/elio/temp/test_dir/*'
file_paths = glob.glob(directory) 
print(file_paths)

导入 glob 模块后，我们指定了目录的路径，我们使用通配符(*)表示搜索所有文件和目录。

然后我们将它传递给 glob.glob 函数：

如果你只想匹配 .txt 文件，你可以更新以下行：

directory = '/Users/elio/temp/test_dir/*.txt'

使用 Python glob 模块列出目录中文件的一个好处是，这种方法会自动包含每个文件的完整路径。

在我们之前看到的os.listdir()和os.walk()示例中，情况并非如此。

使用 Glob Python 模块以递归方式显示目录中的文件

在我们在上一节末尾创建的程序的输出中，你看不到数据目录中的文件tech.txt 。为此，你必须递归地列出文件。

要使用 Python glob 模块递归地列出目录中的文件，你必须将递归参数传递给 glob.glob() 函数并将其设置为 True。递归参数默认为 False。你还必须在你使用的模式中使用双星号。

我们将对上一节的代码进行两个更改：

• 用双星号 (**)替换目录变量末尾的星号。
• 将附加参数传递给glob函数 ( recursive = True )。

import glob 

directory = '/Users/elio/temp/test_dir/**'
file_paths = glob.glob(directory, recursive= True ) 
print (file_paths)

我们在传递给glob()函数的目录模式中使用的双星号仅在recursive为 True 时适用。

使用 Python PathLib 模块列出目录中的文件

PathLib 是另一个提供强大功能来处理文件的 Python 模块。

我们将使用Path()类来定义目录的路径，然后我们将使用iterdir()来遍历目录。

然后，我们使用is_file()方法来检查我们是否正在处理文件。

import pathlib 
 
directory = '/Users/elio/temp/test_dir/'
file_paths = [] 

for file in pathlib.Path(directory).iterdir(): 
    if file.is_file(): 
        file_paths.append(file) 

print(file_paths)

请注意，上面的代码仅列出当前目录中的文件。它不通过子目录。

要列出当前目录和子目录中的文件，请修改上面的代码以使其递归。

让我们看一个例子：

from pathlib import Path

directory = Path('/Users/elio/temp/test_dir/')
file_paths = []
for file in directory.rglob('*'):
    if file.is_file():
        file_paths.append(str(file))

print(file_paths)

这次在输出中你还可以在数据子目录中看到文件tech.txt 。

在 Python 中，glob.glob()是一个函数，它返回与给定模式匹配的文件路径列表。rglob () 函数类似，但它在指定路径下的所有目录中递归搜索匹配项。

在输出中，我们还得到了数据目录下的tech.txt文件，因为我们使用了rglob()函数。

尝试通过将rglob('*')替换为glob('*')来更新之前的代码，并确认在输出中你只看到文件report.txt。换句话说，该行为不再是递归的。

结论

在本文中，你学习了如何使用 Python 列出目录中的文件。

我们已经看到使用 OS、Glob 和 Pathlib 模块列出文件的不同方式。

如果你发现我的任何文章对你有帮助或者有用，麻烦点赞或者转发。 谢谢！