如何在 Python 中删除文件或文件夹?

Posted

技术标签:

【中文标题】如何在 Python 中删除文件或文件夹?【英文标题】:How to delete a file or folder in Python? 【发布时间】:2011-10-23 05:18:03 【问题描述】:

【问题讨论】:

【参考方案1】:

os.remove() 删除文件。

os.rmdir() 删除一个空目录。

shutil.rmtree() 删除目录及其所有内容。


Python 3.4+ pathlib 模块中的Path 对象也公开了这些实例方法:

pathlib.Path.unlink() 删除文件或符号链接。

pathlib.Path.rmdir() 删除一个空目录。

【讨论】:

os.rmdir() 在 Windows 上也会删除目录符号链接,即使目标目录不为空 如果文件不存在,os.remove() 会抛出异常,因此可能需要先检查os.path.isfile(),或者包裹在try 中。 我希望 Path.unlink 1/ 是递归的 2/ 添加一个选项来忽略 FileNotfoundError。 只是为了完成...如果文件不存在,os.remove() 抛出的异常是FileNotFoundError @Jérôme 我认为 missing_ok=True, added 在 3.8 中解决了这个问题!【参考方案2】:

使用

shutil.rmtree(path[, ignore_errors[, onerror]])

(请参阅shutil 上的完整文档)和/或

os.remove

os.rmdir

(os 上的完整文档。)

【讨论】:

请将 pathlib 接口(自 Python 3.4 起新增)添加到您的列表中。【参考方案3】:

这是一个同时使用os.removeshutil.rmtree 的强大函数:

def remove(path):
    """ param <path> could either be relative or absolute. """
    if os.path.isfile(path) or os.path.islink(path):
        os.remove(path)  # remove the file
    elif os.path.isdir(path):
        shutil.rmtree(path)  # remove dir and all contains
    else:
        raise ValueError("file  is not a file or dir.".format(path))

【讨论】:

即8 行代码模拟 ISO C remove(path); 调用。 @Kaz 同意烦人,但删除处理树木吗? :-) os.path.islink(file_path): 一个错误,应该是os.path.islink(path):【参考方案4】:

删除文件的 Python 语法

import os
os.remove("/tmp/<file_name>.txt")

或者

import os
os.unlink("/tmp/<file_name>.txt")

或者

pathlib Python 库版本 >= 3.4

file_to_rem = pathlib.Path("/tmp/<file_name>.txt")
file_to_rem.unlink()

Path.unlink(missing_ok=False)

用于删除文件或符号链接的取消链接方法。

如果 missing_ok 为 false(默认值),如果路径不存在,则会引发 FileNotFoundError。 如果 missing_ok 为真,则 FileNotFoundError 异常将被忽略(与 POSIX rm -f 命令的行为相同)。 在 3.8 版更改:添加了 missing_ok 参数。

最佳实践

    首先,检查文件或文件夹是否存在,然后只删除该文件。这可以通过两种方式实现: 一种。 os.path.isfile("/path/to/file") 湾。使用exception handling.

示例os.path.isfile

#!/usr/bin/python
import os
myfile="/tmp/foo.txt"

## If file exists, delete it ##
if os.path.isfile(myfile):
    os.remove(myfile)
else:    ## Show an error ##
    print("Error: %s file not found" % myfile)

异常处理

#!/usr/bin/python
import os

## Get input ##
myfile= raw_input("Enter file name to delete: ")

## Try to delete the file ##
try:
    os.remove(myfile)
except OSError as e:  ## if failed, report it back to the user ##
    print ("Error: %s - %s." % (e.filename, e.strerror))

各自的输出

输入要删除的文件名:demo.txt 错误:demo.txt - 没有这样的文件或目录。 输入要删除的文件名:rrr.txt 错误:rrr.txt - 不允许操作。 输入要删除的文件名:foo.txt

删除文件夹的 Python 语法

shutil.rmtree()

shutil.rmtree() 的示例

#!/usr/bin/python
import os
import sys
import shutil

# Get directory name
mydir= raw_input("Enter directory name: ")

## Try to remove tree; if failed show an error using try...except on screen
try:
    shutil.rmtree(mydir)
except OSError as e:
    print ("Error: %s - %s." % (e.filename, e.strerror))

【讨论】:

建议进行异常处理而不是检查,因为文件可以在两行之间删除或更改(TOCTOU:en.wikipedia.org/wiki/Time_of_check_to_time_of_use)请参阅 Python 常见问题解答docs.python.org/3/glossary.html#term-eafp 在 Python 中,EAFP 比 LBYL 更受欢迎。 在最后一个示例中捕获异常有什么意义?【参考方案5】:

您可以使用内置的 pathlib 模块(需要 Python 3.4+,但 PyPI 上有旧版本的反向移植:pathlibpathlib2)。

要删除文件,可以使用unlink 方法:

import pathlib
path = pathlib.Path(name_of_file)
path.unlink()

rmdir 方法删除一个文件夹:

import pathlib
path = pathlib.Path(name_of_folder)
path.rmdir()

【讨论】:

一个非空目录呢? @Pranasas 不幸的是,pathlib 中似乎没有任何东西(本机)可以处理删除非空目录。但是你可以使用shutil.rmtree。其他几个答案中都提到了它,所以我没有包括它。【参考方案6】:
import os

folder = '/Path/to/yourDir/'
fileList = os.listdir(folder)

for f in fileList:
    filePath = folder + '/'+f

    if os.path.isfile(filePath):
        os.remove(filePath)

    elif os.path.isdir(filePath):
        newFileList = os.listdir(filePath)
        for f1 in newFileList:
            insideFilePath = filePath + '/' + f1

            if os.path.isfile(insideFilePath):
                os.remove(insideFilePath)

【讨论】:

这将只删除文件夹和子文件夹中的文件,保持文件夹结构不变..【参考方案7】:

如何在 Python 中删除文件或文件夹?

对于 Python 3,要单独删除文件和目录,请分别使用 unlinkrmdir Path 对象方法:

from pathlib import Path
dir_path = Path.home() / 'directory' 
file_path = dir_path / 'file'

file_path.unlink() # remove file

dir_path.rmdir()   # remove directory

请注意,您还可以对 Path 对象使用相对路径,并且可以使用 Path.cwd 检查当前工作目录。

要在 Python 2 中删除单个文件和目录,请参阅下面标记的部分。

要删除包含内容的目录,请使用shutil.rmtree,并注意这在 Python 2 和 3 中可用:

from shutil import rmtree

rmtree(dir_path)

演示

Python 3.4 中的新功能是 Path 对象。

让我们用一个来创建目录和文件来演示用法。请注意,我们使用/ 加入路径的各个部分,这可以解决操作系统之间的问题以及在 Windows 上使用反斜杠的问题(您需要将反斜杠加倍,如 \\ 或使用原始字符串, 比如r"foo\bar"):

from pathlib import Path

# .home() is new in 3.5, otherwise use os.path.expanduser('~')
directory_path = Path.home() / 'directory'
directory_path.mkdir()

file_path = directory_path / 'file'
file_path.touch()

现在:

>>> file_path.is_file()
True

现在让我们删除它们。首先是文件:

>>> file_path.unlink()     # remove file
>>> file_path.is_file()
False
>>> file_path.exists()
False

我们可以使用 globbing 删除多个文件 - 首先让我们为此创建几个文件:

>>> (directory_path / 'foo.my').touch()
>>> (directory_path / 'bar.my').touch()

然后只需遍历 glob 模式:

>>> for each_file_path in directory_path.glob('*.my'):
...     print(f'removing each_file_path')
...     each_file_path.unlink()
... 
removing ~/directory/foo.my
removing ~/directory/bar.my

现在,演示删除目录:

>>> directory_path.rmdir() # remove directory
>>> directory_path.is_dir()
False
>>> directory_path.exists()
False

如果我们想删除一个目录及其中的所有内容怎么办? 对于此用例,请使用 shutil.rmtree

让我们重新创建目录和文件:

file_path.parent.mkdir()
file_path.touch()

请注意 rmdir 除非为空,否则会失败,这就是 rmtree 如此方便的原因:

>>> directory_path.rmdir()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "~/anaconda3/lib/python3.6/pathlib.py", line 1270, in rmdir
    self._accessor.rmdir(self)
  File "~/anaconda3/lib/python3.6/pathlib.py", line 387, in wrapped
    return strfunc(str(pathobj), *args)
OSError: [Errno 39] Directory not empty: '/home/username/directory'

现在,导入 rmtree 并将目录传递给函数:

from shutil import rmtree
rmtree(directory_path)      # remove everything 

我们可以看到整个东西都被删除了:

>>> directory_path.exists()
False

Python 2

如果你使用的是 Python 2,有一个 backport of the pathlib module called pathlib2,可以用 pip 安装:

$ pip install pathlib2

然后您可以将库别名为pathlib

import pathlib2 as pathlib

或者直接导入Path 对象(如这里所示):

from pathlib2 import Path

如果太多,您可以使用 os.remove or os.unlink 删除文件

from os import unlink, remove
from os.path import join, expanduser

remove(join(expanduser('~'), 'directory/file'))

unlink(join(expanduser('~'), 'directory/file'))

您可以使用os.rmdir 删除目录:

from os import rmdir

rmdir(join(expanduser('~'), 'directory'))

请注意,还有一个 os.removedirs - 它只会递归删除空目录,但它可能适合您的用例。

【讨论】:

rmtree(directory_path) 适用于 python 3.6.6 但不适用于 python 3.5.2 - 你需要rmtree(str(directory_path)))【参考方案8】:

shutil.rmtree 是异步函数, 所以如果你想检查它何时完成,你可以使用 while...loop

import os
import shutil

shutil.rmtree(path)

while os.path.exists(path):
  pass

print('done')

【讨论】:

shutil.rmtree 不应该是异步的。但是,它可能出现在受病毒扫描程序干扰的 Windows 上。 @mhsmith 病毒扫描程序?这是疯狂的猜测,还是你真的知道它们会造成这种影响?如果是这样,这到底是如何工作的?【参考方案9】:

如果你喜欢写一个漂亮易读的代码,我推荐使用subprocess

import subprocess
subprocess.Popen("rm -r my_dir", shell=True)

如果您不是软件工程师,那么也许可以考虑使用 Jupyter;你可以简单地输入 bash 命令:

!rm -r my_dir

传统上,您使用shutil

import shutil
shutil.rmtree(my_dir) 

【讨论】:

子流程是避免的做法 我不会为此推荐subprocessshutil.rmtree 可以很好地完成 rm -r 的工作,另外还有在 Windows 上工作的额外好处。【参考方案10】:

删除文件:

os.unlink(path, *, dir_fd=None)

os.remove(path, *, dir_fd=None)

这两个函数在语义上是相同的。此函数删除(删除)文件路径。如果 path 不是文件并且是目录,则会引发异常。

删除文件夹:

shutil.rmtree(path, ignore_errors=False, onerror=None)

os.rmdir(path, *, dir_fd=None)

为了删除整个目录树,可以使用shutil.rmtree()os.rmdir 仅在目录为空且存在时有效。

对于向父级递归删除文件夹:

os.removedirs(name)

它会删除每个带有 self 的空父目录,直到父目录包含一些内容

例如。 os.removedirs('abc/xyz/pqr') 将按顺序删除目录 'abc/xyz/pqr', 'abc/xyz' 和 'abc' 如果它们是空的。

更多信息请查看官方文档:os.unlinkos.removeos.rmdirshutil.rmtreeos.removedirs

【讨论】:

【参考方案11】:

删除文件夹中的所有文件

import os
import glob

files = glob.glob(os.path.join('path/to/folder/*'))
files = glob.glob(os.path.join('path/to/folder/*.csv')) // It will give all csv files in folder
for file in files:
    os.remove(file)

删除目录中的所有文件夹

from shutil import rmtree
import os

// os.path.join()  # current working directory.

for dirct in os.listdir(os.path.join('path/to/folder')):
    rmtree(os.path.join('path/to/folder',dirct))

【讨论】:

【参考方案12】:

为避免Éric Araujo's comment 突出显示的TOCTOU 问题,您可以捕获异常以调用正确的方法:

def remove_file_or_dir(path: str) -> None:
    """ Remove a file or directory """
    try:
        shutil.rmtree(path)
    except NotADirectoryError:
        os.remove(path)

因为shutil.rmtree() 只会删除目录而os.remove()os.unlink() 只会删除文件。

【讨论】:

shutil.rmtree() 不仅会删除目录,还会删除其内容。【参考方案13】:

我个人的偏好是使用 pathlib 对象 - 它提供了一种更 Python 且不易出错的方式来与文件系统交互,尤其是在您开发跨平台代码时。

在这种情况下,您可以使用 pathlib3x - 它提供了最新的(在撰写此答案 Python 3.10.a0 之日)Python 3.6 或更高版本的 Python pathlib 的反向端口,以及一些附加功能,如“复制”, “copy2”、“copytree”、“rmtree”等...

它还包装了shutil.rmtree

$> python -m pip install pathlib3x
$> python
>>> import pathlib3x as pathlib

# delete a directory tree
>>> my_dir_to_delete=pathlib.Path('c:/temp/some_dir')
>>> my_dir_to_delete.rmtree(ignore_errors=True)

# delete a file
>>> my_file_to_delete=pathlib.Path('c:/temp/some_file.txt')
>>> my_file_to_delete.unlink(missing_ok=True)

您可以在github 或PyPi 上找到它


免责声明:我是 pathlib3x 库的作者。

【讨论】:

【参考方案14】:

在 Python 中删除文件或文件夹

在 Python 中有多种删除文件的方法,但最好的方法如下:

    os.remove() 删除文件。 os.unlink() 删除一个文件。它是 remove() 方法的 Unix 名称。 shutil.rmtree() 删除目录及其所有内容。 pathlib.Path.unlink() 删除单个文件 pathlib 模块在 Python 3.4 及更高版本中可用。

os.remove()

示例 1:使用 os.remove() 方法删除文件的基本示例。

import os
os.remove("test_file.txt")
print("File removed successfully")

示例 2:使用 os.path.isfile 检查文件是否存在并使用 os.remove 删除它

import os
#checking if file exist or not
if(os.path.isfile("test.txt")):
    #os.remove() function to remove the file
    os.remove("test.txt")
    #Printing the confirmation message of deletion
    print("File Deleted successfully")
else:
print("File does not exist")
#Showing the message instead of throwig an error

示例 3:删除具有特定扩展名的所有文件的 Python 程序

import os 
from os import listdir
my_path = 'C:\Python Pool\Test\'
for file_name in listdir(my_path):
    if file_name.endswith('.txt'):
        os.remove(my_path + file_name)

示例 4:删除文件夹内所有文件的 Python 程序

要删除特定目录中的所有文件,您只需使用 * 符号作为模式字符串。 #导入 os 和 glob 模块 导入操作系统,全局 #Loop遍历文件夹项目所有文件并一一删除 对于 glob.glob("pythonpool/*") 中的文件: os.remove(文件) print("已删除" + str(文件))

os.unlink()

os.unlink() 是 os.remove() 的别名或另一个名称。在 Unix 操作系统中,删除也称为取消链接。 注意:所有功能和语法与 os.unlink() 和 os.remove() 相同。它们都用于删除 Python 文件路径。 两者都是 Python 标准库中 os 模块中执行删除功能的方法。

shutil.rmtree()

示例 1:使用 shutil.rmtree() 删除文件的 Python 程序

import shutil 
import os 
# location 
location = "E:/Projects/PythonPool/"
# directory 
dir = "Test"
# path 
path = os.path.join(location, dir) 
# removing directory 
shutil.rmtree(path) 

示例 2:使用 shutil.rmtree() 删除文件的 Python 程序

import shutil 
import os 
location = "E:/Projects/PythonPool/"
dir = "Test"    
path = os.path.join(location, dir) 
shutil.rmtree(path) 

pathlib.Path.rmdir() 删除空目录

Pathlib 模块提供了与文件交互的不同方式。 Rmdir 是允许您删除空文件夹的路径功能之一。首先,您需要为目录选择 Path(),然后调用 rmdir() 方法将检查文件夹大小。如果它是空的,它会删除它。

这是删除空文件夹而不用担心丢失实际数据的好方法。

from pathlib import Path
q = Path('foldername')
q.rmdir()

【讨论】:

【参考方案15】:

这是我删除目录的功能。 “路径”需要完整的路径名。

import os

def rm_dir(path):
    cwd = os.getcwd()
    if not os.path.exists(os.path.join(cwd, path)):
        return False
    os.chdir(os.path.join(cwd, path))

    for file in os.listdir():
        print("file = " + file)
        os.remove(file)
    print(cwd)
    os.chdir(cwd)
    os.rmdir(os.path.join(cwd, path))

【讨论】:

以上是关于如何在 Python 中删除文件或文件夹?的主要内容,如果未能解决你的问题,请参考以下文章

Python如何删除文本文件中特定字符串之后或之前的特定行数

如何使用看门狗监视在Python中创建或删除的文件的时间

Python中如何删除一个文件

如何使用python opencv删除文件夹中的特定图像

如何从亚马逊 s3 存储桶中删除文件?

python脚本,批量删除文件或文件夹中特定字符