Python 自动化指南(繁琐工作自动化)第二版:十、组织文件

2023-04-04 09:45:19 浏览数 (1)

原文:https://automatetheboringstuff.com/2e/chapter10/ 在前一章中,你学习了如何在 Python 中创建和写入新文件。您的程序也可以组织硬盘上预先存在的文件。也许你有过这样的经历:浏览一个装满几十个、几百个、甚至几千个文件的文件夹,然后手动复制、重命名、移动或压缩它们。或者考虑这样的任务:

  • 在文件夹的每个子文件夹中复制所有 PDF 文件(仅复制 PDF 文件)
  • 删除包含数百个名为spam001.txtspam002.txtspam003.txt等文件的文件夹中每个文件的文件名中的前导零
  • 将几个文件夹的内容压缩到一个 ZIP 文件中(这可以是一个简单的备份系统)

所有这些无聊的东西都在乞求用 Python 实现自动化。通过给你的计算机编程来完成这些任务,你可以把它变成一个从不出错的快速工作的档案管理员。

当您开始处理文件时,您可能会发现能够快速查看扩展名(. txt,。pdf,。jpg等等)的一个文件。在 MacOS 和 Linux 上,你的文件浏览器很可能会自动显示扩展名。在 Windows 中,文件扩展名可能会默认隐藏。要显示扩展,请转到开始 -> 控制面板 -> 外观和个性化 -> 文件夹选项。在查看选项卡的高级设置下,取消选中隐藏已知文件类型的扩展名复选框。

shutil模块

shutil(或 Shell 实用工具)模块具有让您在 Python 程序中复制、移动、重命名和删除文件的函数。要使用shutil函数,首先需要使用import shutil

复制文件和文件夹

shutil模块提供复制文件和整个文件夹的功能。

调用shutil.copy(,目的)会将路径源的文件复制到路径目的的文件夹中。源和目的都可以是字符串或Path对象。)如果目的地是一个文件名,它将被用作复制文件的新名称。这个函数返回被复制文件的一个字符串或Path对象。

在交互式 Shell 中输入以下内容,看看shutil.copy()是如何工作的:

代码语言:javascript复制
   >>> import shutil, os
   >>> from pathlib import Path
   >>> p = Path.home()
   >>> shutil.copy(p / 'spam.txt', p / 'some_folder') # ➊
   'C:\Users\Al\some_folder\spam.txt'
   >>> shutil.copy(p / 'eggs.txt', p / 'some_folder/eggs2.txt') # ➋
   WindowsPath('C:/Users/Al/some_folder/eggs2.txt')

第一个shutil.copy()调用将位于C:UsersAlspam.txt的文件复制到文件夹C:UsersAlsome_folder中。返回值是新复制的文件的路径。注意,由于文件夹被指定为目的地 ➊,原始的spam.txt文件名被用作新的复制文件的文件名。第二个shutil.copy()调用 ➋ 也将位于C:UsersAleggs.txt的文件复制到文件夹c:usersalsome_folder中,但将复制的文件命名为eggs2.txt

shutil.copy()将复制单个文件,shutil.copytree()将复制整个文件夹以及其中包含的每个文件夹和文件。调用shutil.copytree(,目的)会将路径源下的文件夹,连同其所有文件和子文件夹,复制到路径目的下的文件夹。源和目的参数都是字符串。该函数返回被复制文件夹的路径字符串。

在交互式 Shell 中输入以下内容:

代码语言:javascript复制
>>> import shutil, os
>>> from pathlib import Path
>>> p = Path.home()
>>> shutil.copytree(p / 'spam', p / 'spam_backup')
WindowsPath('C:/Users/Al/spam_backup')

shutil.copytree()调用创建一个名为spam_backup的新文件夹,其内容与原来的spam文件夹相同。您现在已经安全地备份了您珍贵的垃圾邮件。

移动和重命名文件和文件夹

调用shutil.move(,目的地)会将路径源的文件或文件夹移动到路径目的地并将返回一串新位置的绝对路径。

如果目的地指向一个文件夹,则源文件被移动到目的地并保持其当前文件名。例如,在交互式 Shell 中输入以下内容:

代码语言:javascript复制
>>> import shutil
>>> shutil.move('C:\bacon.txt', 'C:\eggs')
'C:\eggs\bacon.txt'

假设一个名为eggs的文件夹已经存在于C:目录中,这个shutil.move()调用表示“将C:bacon.txt移动到文件夹C:eggs

如果在C:eggs中已经有了一个bacon.txt文件,它就会被覆盖。由于很容易以这种方式意外覆盖文件,所以在使用move()时应该小心。

目的地路径也可以指定文件名。在下面的例子中,源文件被移动并且被重命名。

代码语言:javascript复制
>>> shutil.move('C:\bacon.txt', 'C:\eggs\new_bacon.txt')
'C:\eggs\new_bacon.txt'

这一行写道,“将C:bacon.txt移动到文件夹C:eggs中,并且在你这样做的时候,将那个bacon.txt文件重命名为new_bacon.txt

前面的两个例子都是在假设在C:目录中有一个文件夹eggs的情况下工作的。但如果没有eggs文件夹,那么move()会将bacon.txt重命名为一个名为eggs的文件。

代码语言:javascript复制
>>> shutil.move('C:\bacon.txt', 'C:\eggs')
'C:\eggs'

这里,move()C:目录中找不到名为eggs的文件夹,因此假设目的地必须指定文件名,而不是文件夹。所以bacon.txt文本文件被重命名为eggs (一个没有txt文件扩展名的文本文件) 可能不是您想要的!这可能是你程序中一个很难发现的错误,因为move()调用可以愉快地做一些可能与你期望的完全不同的事情。这也是使用move()时要小心的另一个原因。

最后,组成目的地的文件夹必须已经存在,否则 Python 会抛出异常。在交互式 Shell 中输入以下内容:

代码语言:javascript复制
>>> shutil.move('spam.txt', 'c:\does_not_exist\eggs\ham')
Traceback (most recent call last):
  --snip--
FileNotFoundError: [Errno 2] No such file or directory: 'c:\does_not_exist\
eggs\ham'

Python 在不存在的目录(does_not_exist)下寻找eggsham。它没有找到不存在的目录,所以它不能将spam.txt移动到您指定的路径。

永久删除文件和文件夹

您可以使用os模块中的功能删除单个文件或单个空文件夹,而要删除文件夹及其所有内容,您可以使用shutil模块。

  • 调用os.unlink(path)会删除路径的文件。
  • 调用os.rmdir(path)会删除路径的文件夹。该文件夹必须没有任何文件或文件夹。
  • 调用shutil.rmtree(path)会删除路径的文件夹,其中包含的所有文件和文件夹也会被删除。

在程序中使用这些函数时要小心!首先运行程序,注释掉这些调用,并添加print()调用来显示将要删除的文件,这通常是一个好主意。下面是一个 Python 程序,它旨在删除带有txt文件扩展名的文件。但有一个错别字(粗体突出显示),导致它删除rxt。文件改为:

代码语言:javascript复制
import os
from pathlib import Path
for filename in Path.home().glob('*.rxt'):
    os.unlink(filename)

如果你有任何以rxt结尾的重要文件,它们会被意外地永久删除。相反,您应该首先像这样运行程序:

代码语言:javascript复制
import os
from pathlib import Path
for filename in Path.home().glob('*.rxt'):
    #os.unlink(filename)
    print(filename)

现在os.unlink()调用被注释了,所以 Python 忽略了它。相反,您将打印已被删除的文件的文件名。首先运行这个版本的程序会显示你不小心让程序删除了rxt文件而不是txt文件。

一旦您确定程序按预期工作,删除print(filename)行并取消对os.unlink(filename)行的注释。然后再次运行该程序来实际删除文件。

使用send2trash模块的安全删除

由于 Python 内置的shutil.rmtree()函数会不可逆地删除文件和文件夹,使用起来可能会很危险。删除文件和文件夹的一个更好的方法是使用第三方send2trash模块。你可以从终端窗口运行pip install --user send2trash来安装这个模块。(关于如何安装第三方模块的更深入的解释,请参见附录 A 。)

使用send2trash比 Python 的常规删除功能安全得多,因为它会将文件夹和文件发送到你电脑的垃圾桶或回收站,而不是永久删除它们。如果您程序中的一个 BUG 删除了您不想删除的带有send2trash的东西,您可以稍后从回收站恢复它。

安装完send2trash后,在交互式 Shell 中输入以下内容:

代码语言:javascript复制
>>> import send2trash
>>> baconFile = open('bacon.txt', 'a')   # creates the file
>>> baconFile.write('Bacon is not a vegetable.')
25
>>> baconFile.close()
>>> send2trash.send2trash('bacon.txt')

一般来说,你应该总是使用send2trash.send2trash()函数来删除文件和文件夹。但是,虽然将文件发送到回收站可以让您稍后恢复它们,但它不会像永久删除它们那样释放磁盘空间。如果你想让你的程序释放磁盘空间,使用osshutil函数删除文件和文件夹。注意send2trash()函数只能将文件发送到回收站;它不能从中提取文件。

遍历目录树

假设您想要重命名某个文件夹中的每个文件以及该文件夹的每个子文件夹中的每个文件。也就是说,您想要遍历目录树,在遍历的过程中接触每个文件。为此编写一个程序可能会变得很棘手;幸运的是,Python 提供了一个函数来为您处理这个过程。

我们来看看C:delicious文件夹及其内容,如图图 10-1 所示。

图 10-1:包含三个文件夹和四个文件的示例文件夹

下面是一个使用图 10-1 中目录树上的os.walk()函数的示例程序:

代码语言:javascript复制
import os
for folderName, subfolders, filenames in os.walk('C:\delicious'):
    print('The current folder is '   folderName)
    for subfolder in subfolders:
        print('SUBFOLDER OF '   folderName   ': '   subfolder)
    for filename in filenames:
        print('FILE INSIDE '   folderName   ': '  filename)
    print('')

os.walk()函数传递一个字符串值:文件夹的路径。您可以在for循环语句中使用os.walk()来遍历目录树,就像您如何使用range()函数来遍历一系列数字一样。与range()不同,os.walk()函数将在循环的每次迭代中返回三个值:

  • 当前文件夹名称的字符串
  • 当前文件夹中文件夹的字符串列表
  • 当前文件夹中文件的字符串列表

(我说的当前文件夹是指当前for循环迭代的文件夹。程序当前的工作目录并不os.walk()改变。)

就像你可以在代码for i in range(10):中选择变量名i一样,你也可以为前面列出的三个值选择变量名。我通常用foldernamesubfoldersfilenames这些名字。

当您运行该程序时,它将输出以下内容:

代码语言:javascript复制
The current folder is C:delicious
SUBFOLDER OF C:delicious: cats 
SUBFOLDER OF C:delicious: walnut
FILE INSIDE C:delicious: spam.txt
The current folder is C:deliciouscats
FILE INSIDE C:deliciouscats: catnames.txt
FILE INSIDE C:deliciouscats: zophie.jpg
The current folder is C:deliciouswalnut
SUBFOLDER OF C:deliciouswalnut: waffles
The current folder is C:deliciouswalnutwaffles
FILE INSIDE C:deliciouswalnutwaffles: butter.txt.

由于os.walk()返回了subfolderfilename变量的字符串列表,您可以在它们自己的for循环中使用这些列表。用您自己的定制代码替换print()函数调用。(或者,如果您不需要其中一个或两个,请移除for环。)

zipfile模块压缩文件

你可能熟悉 ZIP 文件(带有zip文件扩展名),可以保存很多其他文件的压缩内容。压缩文件会减小其大小,这在通过互联网传输文件时非常有用。由于一个 ZIP 文件也可以包含多个文件和子文件夹,这是将几个文件打包成一个文件的简便方法。这个被称为存档文件的文件可以被附加到电子邮件中。

您的 Python 程序可以使用zipfile模块中的函数创建和打开(或提取 ) ZIP 文件。假设你有一个名为example.zip的 ZIP 文件,其内容如图图 10-2 所示。

图 10-2:example.zip的内容

你可以从nostarch.com/automatestuff2下载这个 ZIP 文件,或者使用你电脑上已经有的 ZIP 文件。

读取 ZIP 文件

要读取 ZIP 文件的内容,首先必须创建一个ZipFile对象(注意大写字母ZF )。ZipFile对象在概念上类似于你在前一章看到的由open()函数返回的File对象:它们是程序与文件交互的值。要创建一个ZipFile对象,调用zipfile.ZipFile()函数,传递给它 ZIP 文件的文件名的字符串。注意zipfile是 Python 模块的名字,ZipFile()是函数的名字。

例如,在交互式 Shell 中输入以下内容:

代码语言:javascript复制
   >>> import zipfile, os
   >>> from pathlib import Path
   >>> p = Path.home()
   >>> exampleZip = zipfile.ZipFile(p / 'example.zip')
   >>> exampleZip.namelist()
   ['spam.txt', 'cats/', 'cats/catnames.txt', 'cats/zophie.jpg']
   >>> spamInfo = exampleZip.getinfo('spam.txt')
   >>> spamInfo.file_size
   13908
   >>> spamInfo.compress_size
   3828
   >>> f'Compressed file is {round(spamInfo.file_size / spamInfo # ➊
   .compress_size, 2)}x smaller!'
   )
   'Compressed file is 3.63x smaller!'
   >>> exampleZip.close()

一个ZipFile对象有一个namelist()方法,该方法返回 ZIP 文件中包含的所有文件和文件夹的字符串列表。这些字符串可以传递给getinfo() ZipFile方法,以返回一个关于该特定文件的ZipInfo对象。ZipInfo对象有自己的属性,比如以字节为单位的file_sizecompress_size,分别保存原始文件大小和压缩文件大小的整数。一个ZipFile对象代表一个完整的归档文件,而一个ZipInfo对象保存着归档文件中的文件的有用信息。

中的命令通过将原始文件大小除以压缩文件大小来计算example.zip的压缩效率,并打印该信息。 # ➊

从 ZIP 文件中提取

ZipFile对象的extractall()方法将所有文件和文件夹从一个 ZIP 文件提取到当前工作目录。

代码语言:javascript复制
   >>> import zipfile, os
   >>> from pathlib import Path
   >>> p = Path.home()
   >>> exampleZip = zipfile.ZipFile(p / 'example.zip')
   >>> exampleZip.extractall() # ➊
   >>> exampleZip.close()

运行完这段代码后,example.zip的内容会被提取到C:。或者,您可以向extractall()传递一个文件夹名,让它将文件提取到当前工作目录之外的文件夹中。如果传递给extractall()方法的文件夹不存在,它将被创建。例如,如果您将在 ➊ 的调用替换为exampleZip.extractall('C:\delicious'),代码会将文件从example.zip提取到一个新创建的C:delicious文件夹中。

用于ZipFile对象的extract()方法将从 ZIP 文件中提取一个文件。继续交互式 Shell 示例:

代码语言:javascript复制
>>> exampleZip.extract('spam.txt')
'C:\spam.txt'
>>> exampleZip.extract('spam.txt', 'C:\some\new\folders')
'C:\some\new\folders\spam.txt'
>>> exampleZip.close()

传递给extract()的字符串必须与namelist()返回的列表中的一个字符串匹配。或者,您可以向extract()传递第二个参数,将文件提取到当前工作目录之外的文件夹中。如果第二个参数是一个尚不存在的文件夹,Python 将创建该文件夹。extract()返回的值是文件被提取到的绝对路径。

创建并添加到 ZIP 文件

要创建你自己的压缩 ZIP 文件,你必须通过传递第二个参数'w'写模式下打开ZipFile对象。(这类似于通过将'w'传递给open()函数以写模式打开一个文本文件。)

当您传递一个路径到一个ZipFile对象的write()方法时,Python 将压缩该路径下的文件并将其添加到 ZIP 文件中。write()方法的第一个参数是要添加的文件名的字符串。第二个参数是压缩类型参数,它告诉计算机应该使用什么算法来压缩文件;您总是可以将该值设置为zipfile.ZIP_DEFLATED。(这指定了deflate压缩算法,该算法适用于所有类型的数据。)在交互式 Shell 中输入以下内容:

代码语言:javascript复制
>>> import zipfile
>>> newZip = zipfile.ZipFile('new.zip', 'w')
>>> newZip.write('spam.txt', compress_type=zipfile.ZIP_DEFLATED)
>>> newZip.close()

这段代码将创建一个名为new.zip的新 ZIP 文件,其中包含了spam.txt的压缩内容。

请记住,就像写入文件一样,写入模式将擦除 ZIP 文件的所有现有内容。如果您想简单地将文件添加到现有的 ZIP 文件中,将'a'作为第二个参数传递给zipfile.ZipFile()以在附加模式下打开 ZIP 文件。

项目:将美式日期的文件重命名为欧式日期

假设你的老板给你发了几千封电子邮件,文件名称中带有美式日期(MM-DD-YYYY),并需要将它们重命名为欧式日期(DD-MM-YYYY)。手工完成这项无聊的任务可能要花一整天的时间!让我们写一个程序来代替它。

这个程序是这样做的:

  1. 它在当前工作目录的所有文件名中搜索美式日期。
  2. 当找到一个文件时,它会重命名该文件,并交换月份和日期,使其具有欧洲风格。

这意味着代码需要执行以下操作:

  1. 创建一个可以识别美式日期文本模式的正则表达式。
  2. 调用os.listdir()找到工作目录中的所有文件。
  3. 循环遍历每个文件名,使用正则表达式检查它是否有日期。
  4. 如果它有日期,用shutil.move()重命名文件。

对于这个项目,打开一个新的文件编辑器窗口,将您的代码保存为renameDates.py

第一步:为美式日期创建一个正则表达式

该程序的第一部分将需要导入必要的模块,并创建一个正则表达式,可以识别MM-DD-YYYY日期。待办事项会提醒你在这个程序中还剩下什么要写。将它们输入为TODO使得使用 Mu 编辑器的CTRL-F查找功能很容易找到它们。使您的代码看起来像下面这样:

代码语言:javascript复制
   #! python3
   # renameDates.py - Renames filenames with American MM-DD-YYYY date format
   # to European DD-MM-YYYY.
   import shutil, os, re # ➊
   # Create a regex that matches files with the American date format.
   datePattern = re.compile(r"""^(.*?) # all text before the date # ➋
       ((0|1)?d)-                     # one or two digits for the month
       ((0|1|2|3)?d)-                 # one or two digits for the day
       ((19|20)dd)                   # four digits for the year
       (.*?)$                          # all text after the date
       """, re.VERBOSE➌)
   # TODO: Loop over the files in the working directory.
   # TODO: Skip files without a date.
   # TODO: Get the different parts of the filename.
   # TODO: Form the European-style filename.
   # TODO: Get the full, absolute file paths.
   # TODO: Rename the files.

从这一章,你知道了shutil.move()函数可以用来重命名文件:它的参数是要重命名的文件名和新文件名。因为这个函数存在于shutil模块中,你必须导入那个模块 ➊。

但是在重命名文件之前,您需要确定要重命名哪些文件。带日期的文件名如spam4-4-1984.txt01-03-2014eggs.zip要改名,不带日期的文件名如littlebrother.epub可以忽略。

您可以使用正则表达式来识别这种模式。在顶部导入re模块后,调用re.compile()创建一个Regex对象 ➋。为第二个参数 ➌ 传递re.VERBOSE将允许正则表达式字符串中的空白和注释,使其更具可读性。

正则表达式字符串以^(.*?)开头,匹配文件名开头的任何可能在日期之前的文本。((0|1)?d)组匹配月份。第一个数字可以是01,所以正则表达式匹配十二月的12和二月的02。这个数字也是可选的,因此月份可以是四月的044。当天的组是((0|1|2|3)?d)并且遵循类似的逻辑;30331都是有效的天数。(是的,这个正则表达式将接受一些无效日期,如4-31-20142-29-20130-15-2014。约会有很多棘手的特例,很容易被忽略。但是为了简单起见,这个程序中的正则表达式已经足够好了。)

虽然 1885 年是一个有效的年份,但你可以只查找 20 世纪或 21 世纪的年份。这将防止您的程序意外地将非日期文件名与类似日期的格式匹配,例如10-10-1000.txt

正则表达式的(.*?)$部分将匹配日期之后的任何文本。

第二步:从文件名中识别日期部分

接下来,程序必须遍历从os.listdir()返回的文件名字符串列表,并根据正则表达式匹配它们。应该跳过任何没有日期的文件。对于有日期的文件名,匹配的文本将存储在几个变量中。用以下代码填充程序中的前三个TODO:

代码语言:javascript复制
#! python3
# renameDates.py - Renames filenames with American MM-DD-YYYY date format
# to European DD-MM-YYYY.
--snip--
# Loop over the files in the working directory.
for amerFilename in os.listdir('.'):
    mo = datePattern.search(amerFilename)
    # Skip files without a date.
     if mo == None: # ➊
         continue # ➋
     # Get the different parts of the filename. # ➌
    beforePart = mo.group(1)
    monthPart  = mo.group(2)
    dayPart    = mo.group(4)
    yearPart   = mo.group(6)
    afterPart  = mo.group(8)
--snip--

如果从search()方法返回的Match对象是None➊,那么amerFilename中的文件名与正则表达式不匹配。continue语句 ➋ 将跳过循环的剩余部分,继续下一个文件名。

否则,正则表达式组中匹配的各种字符串将存储在名为beforePartmonthPartdayPartyearPartafterPart、、的变量中。这些变量中的字符串将在下一步中用于形成欧式文件名。

为了保持组号不变,尝试从头开始阅读正则表达式,并在每次遇到左括号时向上计数。不用考虑代码,只要写出正则表达式的大纲就可以了。这可以帮助你将这些群体形象化。这里有一个例子:

代码语言:javascript复制
datePattern = re.compile(r"""^(1) # all text before the date
    (2 (3) )-                     # one or two digits for the month
    (4 (5) )-                     # one or two digits for the day
    (6 (7) )                      # four digits for the year
    (8)$                          # all text after the date
    """, re.VERBOSE)

这里,数字18代表你写的正则表达式中的组。只使用括号和组号来概述正则表达式,可以让您在继续程序的其余部分之前对正则表达式有一个更清晰的理解。

第三步:形成新的文件名,并将文件重命名

最后一步,用欧式日期连接上一步中变量的字符串:日期在月份之前。用以下代码填充程序中剩余的三个TODO:

代码语言:javascript复制
#! python3
# renameDates.py - Renames filenames with American MM-DD-YYYY date format # to European DD-MM-YYYY.
--snip--
     # Form the European-style filename.
     euroFilename = beforePart   dayPart   '-'   monthPart   '-'   yearPart   # ➊
                    afterPart
     # Get the full, absolute file paths.
     absWorkingDir = os.path.abspath('.')
     amerFilename = os.path.join(absWorkingDir, amerFilename)
     euroFilename = os.path.join(absWorkingDir, euroFilename)
     # Rename the files.
     print(f'Renaming "{amerFilename}" to "{euroFilename}"...') # ➋
     #shutil.move(amerFilename, euroFilename)   # uncomment after testing # ➌

将串接的字符串存储在名为euroFilename➊ 的变量中。然后,将amerFilename中的原始文件名和新的euroFilename变量传递给shutil.move()函数,以重命名文件 ➌。

这个程序注释掉了shutil.move()调用,而是打印将被重命名为 ➋ 的文件名。首先像这样运行程序可以让您仔细检查文件是否被正确地重命名。然后,您可以取消对shutil.move()调用的注释,并再次运行程序来实际重命名文件。

类似程序的创意

还有许多其他原因可能会导致您想要重命名大量文件。

  • 在文件名的开头添加前缀,如添加spam_eggs.txt重命名为spam_eggs.txt
  • 将带有欧式日期的文件名更改为美式日期
  • 删除文件中的零,如spam0042.txt

项目:将文件夹备份成 ZIP 文件

假设您正在处理一个项目,该项目的文件保存在一个名为C:AlsPythonBook的文件夹中。您担心丢失您的工作,所以您想要创建整个文件夹的 ZIP 文件“快照”。您希望保留不同的版本,所以您希望 ZIP 文件的文件名在每次创建时递增;比如AlsPythonBook_1.zipAlsPythonBook_2.zipAlsPythonBook_3.zip等等。您可以手动完成这项工作,但是这很烦人,而且您可能会不小心弄错 ZIP 文件的名称。运行一个程序来替你完成这个无聊的任务会简单得多。

对于这个项目,打开一个新的文件编辑器窗口,保存为backupZip.py

第一步:计算 ZIP 文件的名字

这个程序的代码将被放入一个名为backupToZip()的函数中。这将使得将函数复制并粘贴到其他需要该功能的 Python 程序中变得容易。程序结束时,将调用该函数来执行备份。让你的程序看起来像这样:

代码语言:javascript复制
   #! python3
   # backupToZip.py - Copies an entire folder and its contents into
   # a ZIP file whose filename increments.
   import zipfile, os # ➊
   def backupToZip(folder):
       # Back up the entire contents of "folder" into a ZIP file.
       folder = os.path.abspath(folder)   # make sure folder is absolute
       # Figure out the filename this code should use based on
       # what files already exist.
       number = 1 # ➋
       while True: # ➌
           zipFilename = os.path.basename(folder)   '_'   str(number)   '.zip'
           if not os.path.exists(zipFilename):
               break
           number = number   1
       # TODO: Create the ZIP file. # ➍
       # TODO: Walk the entire folder tree and compress the files in each folder.
       print('Done.')
backupToZip('C:\delicious')

先做基本的:添加 Shebang(#!)行,描述程序做什么,导入zipfileos模块 ➊。

定义一个只接受一个参数folderbackupToZip()函数。此参数是应备份其内容的文件夹的字符串路径。该函数将确定它将创建的 ZIP 文件的文件名;然后该函数将创建文件,遍历folder文件夹,并将每个子文件夹和文件添加到 ZIP 文件中。在源代码中为这些步骤写下TODO注释,提醒自己以后再做 ➍。

第一部分,命名 ZIP 文件,使用绝对路径的基本名folder。如果正在备份的文件夹是C:delicious,ZIP 文件的名称应该是delicious_N.zip,其中N = 1 是第一次运行程序,N = 2 是第二次,以此类推。

你可以通过检查delicious_1.zip是否已经存在,再检查delicious_2.zip是否已经存在来确定N应该是什么,以此类推。对 ➋ 使用一个名为number的变量,并在调用os.path.exists()的循环中保持递增,以检查文件是否存在 ➌。找到的第一个不存在的文件名将导致循环break,因为它将找到新 zip 的文件名。

第二步:新建 ZIP 文件

接下来,让我们创建 ZIP 文件。让您的程序看起来像下面这样:

代码语言:javascript复制
#! python3
# backupToZip.py - Copies an entire folder and its contents into
# a ZIP file whose filename increments.
--snip--
    while True:
        zipFilename = os.path.basename(folder)   '_'   str(number)   '.zip'
        if not os.path.exists(zipFilename):
            break
        number = number   1
    # Create the ZIP file.
    print(f'Creating {zipFilename}...')
     backupZip = zipfile.ZipFile(zipFilename, 'w') # ➊
     # TODO: Walk the entire folder tree and compress the files in each folder.
     print('Done.')
backupToZip('C:\delicious')

既然新的 ZIP 文件的名称存储在zipFilename变量中,您可以调用zipfile.ZipFile()来实际创建 ZIP 文件 ➊。确保将'w'作为第二个参数传递,以便以写模式打开 ZIP 文件。

第三步:遍历目录树,添加到 ZIP 文件

现在您需要使用os.walk()函数列出文件夹及其子文件夹中的每个文件。让您的程序看起来像下面这样:

代码语言:javascript复制
#! python3
# backupToZip.py - Copies an entire folder and its contents into
# a ZIP file whose filename increments.
--snip--
     # Walk the entire folder tree and compress the files in each folder.
     for foldername, subfolders, filenames in os.walk(folder): # ➊
         print(f'Adding files in {foldername}...')
         # Add the current folder to the ZIP file.
         backupZip.write(foldername) # ➋
         # Add all the files in this folder to the ZIP file.
         for filename in filenames: # ➌
            newBase = os.path.basename(folder)   '_'
            if filename.startswith(newBase) and filename.endswith('.zip'):
                continue   # don't back up the backup ZIP files
             backupZip.write(os.path.join(foldername, filename))
     backupZip.close()
     print('Done.')
backupToZip('C:\delicious')

您可以在一个for循环 ➊ 中使用os.walk(),在每次迭代中,它将返回迭代的当前文件夹名称、该文件夹中的子文件夹以及该文件夹中的文件名。

for循环中,文件夹被添加到 ZIP 文件 ➋ 中。嵌套的for循环可以遍历filenames列表 ➌ 中的每个文件名。除了以前制作的备份 ZIP 文件之外,这些文件都被添加到 ZIP 文件中。

当您运行这个程序时,它将产生类似如下的输出:

代码语言:javascript复制
Creating delicious_1.zip...
Adding files in C:delicious...
Adding files in C:deliciouscats...
Adding files in C:deliciouswaffles...
Adding files in C:deliciouswalnut...
Adding files in C:deliciouswalnutwaffles...
Done.

第二次运行时,它会将C:delicious中的所有文件放入一个名为delicious_2.zip的 ZIP 文件中,以此类推。

类似程序的创意

您可以遍历目录树,并在其他几个程序中将文件添加到压缩的 ZIP 存档中。例如,您可以编写执行以下操作的程序:

  • 遍历目录树,只归档带有某些扩展名的文件,比如txtpy,别的什么都没有。
  • 遍历目录树,归档除了txtpy之外的每个文件。
  • 在目录树中查找文件数量最多的文件夹或使用磁盘空间最多的文件夹。

总结

即使你是一个有经验的计算机用户,你也可能用鼠标和键盘手工处理文件。现代文件资源管理器使得处理几个文件变得很容易。但有时你需要使用电脑的文件管理器来执行一项需要几个小时的任务。

osshutil模块提供复制、移动、重命名和删除文件的功能。删除文件时,您可能希望使用send2trash模块将文件移动到回收站或回收站,而不是永久删除它们。当编写处理文件的程序时,最好注释掉执行实际复制/移动/重命名/删除的代码,并添加一个print()调用,这样你就可以运行程序并验证它到底会做什么。

通常,您不仅需要对一个文件夹中的文件执行这些操作,还需要对该文件夹中的每个文件夹执行这些操作,依此类推。os.walk()函数为您处理文件夹间的跋涉,这样您就可以专注于程序需要对其中的文件做什么。

zipfile模块给你一种在 Python 中压缩和解压 ZIP 存档文件的方法。结合osshutil的文件处理功能,zipfile可以轻松打包硬盘上任意位置的多个文件。这些 ZIP 文件比许多单独的文件更容易上传到网站或作为电子邮件附件发送。*

本书的前几章已经提供了源代码供你复制。但是当你写你自己的程序时,它们第一次可能不会完美地出来。下一章关注一些 Python 模块,它们将帮助你分析和调试你的程序,这样你就可以快速地让它们正常工作。

练习题

  1. shutil.copy()shutil.copytree()有什么区别?
  2. 什么函数是用来重命名文件的?
  3. send2trashshutil模块中的删除功能有什么区别?
  4. ZipFile对象有一个close()方法,就像File对象的close()方法一样。什么ZipFile方法等同于File对象的open()方法?

实践项目

为了练习,编写程序来完成以下任务。

选择性复制

写一个程序,遍历一个文件夹树,搜索某个文件扩展名的文件(比如pdf。jpg)。将这些文件从它们所在的任何位置复制到一个新文件夹中。

删除不需要的文件

一些不需要但数量庞大的文件或文件夹占据了硬盘的大部分空间,这种情况并不少见。如果你想在你的电脑上释放空间,你可以通过删除大量不需要的文件来获得最大的回报。但首先你必须找到他们。

编写一个程序,遍历文件夹树,搜索特别大的文件或文件夹——比如文件大小超过 100MB 的。(记住,要获得文件的大小,可以使用os模块中的os.path.getsize()。)打印这些文件及其到屏幕的绝对路径。

填补空白

编写一个程序,在单个文件夹中查找带有给定前缀的所有文件,如spam001.txtspam002.txt等,并定位编号中的任何空白(如是否有spam001.txtspam003.txt,但没有spam002.txt )。让程序重命名所有后面的文件,以缩小这个差距。

作为一个额外的挑战,编写另一个程序,可以将间隙插入到编号文件中,以便可以添加新文件。*

0 人点赞