《Python编程：从入门到实践》学习笔记——第10章 文件和异常

---

前言

Python初学者一枚，文章仅为个人学习记录，便于以后查看使用。

1 从文件中读取数据

每当需要分析或修改存储在文件中的信息时，读取文件都很有用，对数据分析应用程序来说尤其如此。

要使用文本文件中的信息，首先需要将信息读取到内存中。为此，你可以一次性读取文件的全部内容，也可以以每次一行的方式逐步读取。

1.1 读取整个文件

要读取文件，需要一个包含几行文本的文件。

下面首先来创建一个文件。
它包含精确到小数点后30位的圆周率值，且在小数点后每10位处都换行：

下面的程序打开并读取这个文件，再将其内容显示到屏幕上：

file_reader.py

with open('pi_digits.txt') as file_object:
    contents = file_object.read()
    print(contents)

要以任何方式使用文件——哪怕仅仅是打印其内容，都得先打开文件，这样才能访问它。

函数open()接受一个参数：要打开的文件的名称。Python在当前执行的文件所在的目录中查找指定的文件。
在这个示例中，当前运行的是file_reader.py，因此Python在file_reader.py所在的目录中查找pi_digits.txt。

函数open()返回一个表示文件的对象。Python将这个对象存储在我们将在后面使用的变量中。
open(‘pi_digits.txt’)返回一个表示文件pi_digits.txt的对
象。

关键字with在不再需要访问文件后将其关闭。通过使用前面所示的结构，可让Python去确定：你只管打开文件，并在需要时使用它，Python自会在合适的时候自动将其关闭。你也可以调用open()和close()来打开和关闭文件，但这样做时，如果程序存在bug，导致close()语句未执行，文件将不会关闭。未妥善地关闭文件可能会导致数据丢失或受损。如果在程序中过早地调用close()，你会发现需要使用文件时它已关闭（无法访问），这会导致更多的错误。

有了表示pi_digits.txt的文件对象后，我们使用方法read()（见程序第2行）读取这个文件的全部内容，并将其作为一个长长的字符串存储在变量contents中。这样，通过打印contents的值，就可将这个文本文件的全部内容显示出来：

输出：

相比于原始文件，该输出唯一不同的地方是末尾多了一个空行。因为read()到达文件末尾时返回一个空字符串，而将这个空字符串显示出来时就是一个空行。

要删除多出来的空行，可在print语句中使用rstrip()，Python方法rstrip()删除（剥除）字符串末尾的空白：

with open('pi_digits.txt') as file_object:
    contents = file_object.read()
    print(contents.rstrip())

1.2 文件路径

当你将类似pi_digits.txt这样的简单文件名传递给函数open()时，Python将在当前执行的文件（即.py程序文件）所在的目录中查找文件。

根据你组织文件的方式，有时可能要打开不在程序文件所属目录中的文件。Python只在当前文件夹查找，而不会在其子文件夹中查找。要让Python打开不与程序文件位于同一个目录中的文件，需要提供文件路径，它让Python到系统的特定位置去查找。

1.2.1 相对文件路径

如果文件所在文件夹位于程序所在文件夹中，可使用相对文件路径来打开该文件夹中的文件。相对文件路径让Python到指定的位置去查找，而该位置是相对于当前运行的程序所在目录的。

with open('text_files/filename.txt') as file_object:

▲▲▲关于在Windows系统中，文件路径中使用斜杠（/）和反斜杠（\）的问题（已测试）：关于Python读取文件的路径中斜杠问题

1.2.2 绝对文件路径

你还可以将文件在计算机中的准确位置告诉Python，这样就不用关心当前运行的程序存储在什么地方了。这称为绝对文件路径。在相对路径行不通时，可使用绝对路径。

绝对路径通常比相对路径更长，因此将其存储在一个变量中，再将该变量传递给open()会有所帮助。

示例：

file_path = '/home/ehmatthes/other_files/text_files/filename.txt' 
with open(file_path) as file_object:

通过使用绝对路径，可读取系统任何地方的文件。

就目前而言，最简单的做法是，要么将数据文件存储在程序文件所在的目录，要么将其存储在程序文件所在目录下的一个文件夹中。

1.3 逐行读取

读取文件时，常常需要检查其中的每一行：你可能要在文件中查找特定的信息，或者要以某种方式修改文件中的文本。

要以每次一行的方式检查文件，可对文件对象使用for循环：

filename = 'pi_digits.txt'

with open(filename) as file_object:
    for line in file_object:
        print(line)

我们打印每一行时，发现空白行更多了：

因为在这个文件中，每行的末尾都有一个看不见的换行符，而print语句也会加上一个换行符，因此每行末尾都有两个换行符：一个来自文件，另一个来自print语句。

要消除这些多余的空白行，可在print语句中使用rstrip()：

filename = 'pi_digits.txt'

with open(filename) as file_object:
    for line in file_object:
        print(line.rstrip())

现在，输出又与文件内容完全相同了：

1.4 创建一个包含文件各行内容的列表

使用关键字with时，open()返回的文件对象只在with代码块内可用。

如果要在with代码块外访问文件的内容，可在with代码块内将文件的各行存储在一个列表中，并在with代码块外使用该列表：你可以立即处理文件的各个部分，也可推迟到程序后面再处理。

示例：

filename = 'pi_digits.txt'

with open(filename) as file_object:
    lines = file_object.readlines()

for line in lines:
    print(line.rstrip())

第3行中的方法readlines()从文件中读取每一行，并将其存储在一个列表中；接下来，该列表被存储到变量lines中；在with代码块外，我们依然可以使用这个变量。在第6行，我们使用一个简单的for循环来打印lines中的各行。由于列表lines的每个元素都对应于文件中的一行，因此输出与文件内容完全一致。

1.5 使用文件的内容

将文件读取到内存中后，就可以以任何方式使用这些数据了。

我们将创建一个字符串，它包含文件中存储的所有数字，且没有任何空格：

filename = 'pi_digits.txt'

with open(filename) as file_object:
    lines = file_object.readlines()

pi_string1 = ''
pi_string2 = ''
for line in lines:
    pi_string1 += line.rstrip()
    pi_string2 += line.strip()

print(pi_string1)
print(len(pi_string1))

print(pi_string2)
print(len(pi_string2))

rstrip()删除每行末尾的换行符（见第9行）。
在变量pi_string存储的字符串中，包含原来位于每行左边的空格，为删除这些空格，可使用strip()（见第10行）。

输出：

▲▲▲注意：读取文本文件时，Python将其中的所有文本都解读为字符串。如果你读取的是数字，并要将其作为数值使用，就必须使用函数int()将其转换为整数，或使用函数float()将其转换为浮点数。

1.6 大型文件（本文pi_thousand_digits.txt只取小数点后1000）

前面我们分析的都是一个只有三行的文本文件，但这些代码示例也可处理大得多的文件。

示例：

filename2 = 'text_files/pi_thousand_digits.txt'

with open(filename2) as file_object:
    lines2 = file_object.readlines()

pi_string3 = ''
pi_string4 = ''

for line2 in lines2:
    pi_string3 += line2.rstrip()
    pi_string4 += line2.strip()

print(pi_string3[:50] + "...")
print(len(pi_string3))

print(pi_string4[:50] + "...")
print(len(pi_string4))

第13行print(pi_string3[:50] + “…”)和16行print(pi_string4[:50] + “…”)，只显示前50个数字

输出：

对于你可处理的数据量，Python没有任何限制；只要系统的内存足够多，你想处理多少数据都可以。

1.7 判断圆周率值中是否包含某个数字组成的字符串

可将生日表示为一个由数字组成的字符串，再检查这个字符串是否包含在pi_string中：

filename = 'text_files/pi_thousand_digits.txt'

with open(filename) as file_object:
    lines = file_object.readlines()

pi_string = ''
for line in lines:
    pi_string += line.rstrip()

birthday = input("Enter your birthday, in the form mmddyy: ")
if birthday in pi_string:
    print("Your birthday appears in the first million digits of pi!")
else:
    print("Your birthday does not appear in the first million digits of pi.")

输出：

2 写入文件

保存数据的最简单的方式之一是将其写入到文件中。通过将输出写入文件，即便关闭包含程序输出的终端窗口，这些输出也依然存在：你可以在程序结束运行后查看这些输出，可与别人分享输出文件，还可编写程序来将这些输出读取到内存中并进行处理。

2.1 写入空文件

要将文本写入文件，你在调用open()时需要提供另一个实参，告诉Python你要写入打开的文件。

write_message.py

filename = 'programming.txt'

with open(filename, 'w') as file_object:
    file_object.write("I love programming.")

在这个示例中，调用open()时提供了两个实参（见第3行）。第一个实参是要打开的文件的名称；第二个实参（‘w’）告诉Python，我们要以写入模式打开这个文件。

打开文件时，可指定读取模式（‘r’）、写入模式（‘w’）、附加模式（‘a’）或让你能够读取和写入文件的模式（‘r+’）。
如果你省略了模式实参，Python将以默认的只读模式打开文件。

如果你要写入的文件不存在，函数open()将自动创建它。
然而，以写入（‘w’）模式打开文件时千万要小心，因为如果指定的文件已经存在，Python将在返回文件对象前清空该文件。

这个程序没有终端输出，但如果你打开文件programming.txt，将看到其中包含如下一行内容：

programming.txt

I love programming.

▲▲▲注意：Python只能将字符串写入文本文件。要将数值数据存储到文本文件中，必须先使用函数str()将其转换为字符串格式。

2.2 写入多行

函数write()不会在你写入的文本末尾添加换行符，因此如果你写入多行时没有指定换行符，文件看起来可能不是你希望的那样：

filename = 'programming.txt'

with open(filename, 'w') as file_object:
    file_object.write("I love programming.")
    file_object.write("I love creating new games.")

打开programming.txt，将发现两行内容挤在一起。

programming.txt

I love programming.I love creating new games.

要让每个字符串都单独占一行，需要在write()语句中包含换行符：

programming.txt

I love programming.
I love creating new games.

像显示到终端的输出一样，还可以使用空格、制表符和空行来设置这些输出的格式。

2.3 附加到文件

如果你要给文件添加内容，而不是覆盖原有的内容，可以附加模式打开文件。你以附加模式打开文件时，Python不会在返回文件对象前清空文件，而你写入到文件的行都将添加到文件末尾。

如果指定的文件不存在，Python将为你创建一个空文件。

write_message.py

filename = 'programming.txt'

with open(filename, 'a') as file_object:
    file_object.write("I also love finding meaning in large datasets.\n")
    file_object.write("I love creating apps that can run in a browser.\n")

在第3行中，我们打开文件时指定了实参’a’，以便将内容附加到文件末尾，而不是覆盖文件原来的内容。

programming.txt

I love programming.
I love creating new games.
I also love finding meaning in large datasets.
I love creating apps that can run in a browser.

动手试一试 10-4

访客名单：编写一个 while 循环，提示用户输入其名字。用户输入其名字后，在屏幕上打印一句问候语，并将一条访问记录添加到文件 guest_book.txt 中。确保这个文件中的每条记录都独占一行。

filename = 'guest_book.txt'


with open(filename, 'a') as file_object:
    while True:
        name = input("Please enter your name: ")

        if name == 'quit':
            break
        else:
            print("Hello, " + name + "!")
            file_object.write(name + " visited.\n")

输出：

guest_book.txt

Edward visited.
Nancy visited.
Alphonse visited.

3 异常

Python使用被称为异常的特殊对象来管理程序执行期间发生的错误。

每当发生让Python不知所措的错误时，它都会创建一个异常对象。如果你编写了处理该异常的代码，程序将继续运行；如果你未对异常进行处理，程序将停止，并显示一个traceback，其中包含有关异常的报告。

异常是使用try-except代码块处理的。try-except代码块让Python执行指定的操作，同时告诉Python发生异常时怎么办。使用了try-except代码块时，即便出现异常，程序也将继续运行：显示你编写的友好的错误消息，而不是令用户迷惑的traceback。

3.1 ZeroDivisionError 异常

你可能知道不能将一个数字除以0，但我们还是让Python这样做吧：

print(5/0)

显然，Python无法这样做，因此你将看到一个traceback：

在上述traceback中，最后一行指出的错误ZeroDivisionError是一个异常对象。Python无法按你的要求做时，就会创建这种对象。在这种情况下，Python将停止运行程序，并指出引发了哪种异常，而我们可根据这些信息对程序进行修改。

下面我们将告诉Python，发生这种错误时怎么办；这样，如果再次发生这样的错误，我们就有备无患了。

3.2 如何使用 try-except 代码块

当你认为可能发生了错误时，可编写一个try-except代码块来处理可能引发的异常。你让Python尝试运行一些代码，并告诉它如果这些代码引发了指定的异常，该怎么办。

处理ZeroDivisionError异常的try-except代码块类似于下面这样：

try:
    print(5/0)
except ZeroDivisionError:
    print("You can't divide by zero!")

如果try代码块中的代码运行起来没有问题，Python将跳过except代码块；如果try代码块中的代码导致了错误，Python将查找这样的except代码块，并运行其中的代码，即其中指定的错误与引发的错误相同。

输出：

如果try-except代码块后面还有其他代码，程序将接着运行，因为已经告诉了Python如何处理这种错误。

3.3 使用异常避免崩溃

发生错误时，如果程序还有工作没有完成，妥善地处理错误就尤其重要。这种情况经常会出现在要求用户提供输入的程序中；如果程序能够妥善地处理无效输入，就能再提示用户提供有效输入，而不至于崩溃。

示例：

print("Give me two numbers, and I will fivide them.")
print("Enter 'q' to quit.")

while True:
    first_number = input("\nFirst number: ")
    if first_number == 'q':
        break
    second_number = input("Second number: ")
    if second_number == 'q':
        break
    answer = int(first_number) / int(second_number)
    print(answer)

这个程序没有采取任何处理错误的措施，因此让它执行除数为0的除法运算时，它将崩溃：

程序崩溃可不好，但让用户看到traceback也不是好主意。不懂技术的用户会被它们搞糊涂，而且如果用户怀有恶意，他会通过traceback获悉你不希望他知道的信息。例如，他将知道你的程序文件的名称，还将看到部分不能正确运行的代码。有时候，训练有素的攻击者可根据这些信息判断出可对你的代码发起什么样的攻击。

3.4 else 代码块

通过将可能引发错误的代码放在try-except代码块中，可提高这个程序抵御错误的能力。错误是执行除法运算的代码行导致的，因此我们需要将它放到try-except代码块中。

示例：

print("Give me two numbers, and I will fivide them.")
print("Enter 'q' to quit.")

while True:
    first_number = input("\nFirst number: ")
    if first_number == 'q':
        break
    second_number = input("Second number: ")
    if second_number == 'q':
        break
    try:
        answer = int(first_number) / int(second_number)
    except ZeroDivisionError:
        print("You can't divide by 0!")
    else:
        print(answer)

我们让Python尝试执行try代码块中的除法运算（见第9行），这个代码块只包含可能导致错误的代码。依赖于try代码块成功执行的代码都放在else代码块中；在这个示例中，如果除法运算成功，我们就使用else代码块来打印结果（见第13行）。

except代码块告诉Python，出现ZeroDivisionError异常时该怎么办（见第11行）。如果try代码块因除零错误而失败，我们就打印一条友好的消息，告诉用户如何避免这种错误。程序将继续运行，用户根本看不到traceback。

输出：

try-except-else代码块的工作原理大致如下：Python尝试执行try代码块中的代码；只有可能引发异常的代码才需要放在try语句中。有时候，有一些仅在try代码块成功执行时才需要运行的代码；这些代码应放在else代码块中。except代码块告诉Python，如果它尝试运行try代码块中的代码时引发了指定的异常，该怎么办。

3.5 FileNotFoundError 异常

使用文件时，一种常见的问题是找不到文件：你要查找的文件可能在其他地方、文件名可能不正确或者这个文件根本就不存在。

示例：

filename = 'alice.txt'

with open(filename) as f_obj:
    contents = f_obj.read()

输出：

在上述traceback中，最后一行报告了FileNotFoundError异常，这是Python找不到要打开的文件时创建的异常。在这个示例中，这个错误是函数open()导致的，因此要处理这个错误，必须将try语句放在包含open()的代码行之前：

filename = 'alice.txt'

try:
    with open(filename) as f_obj:
        contents = f_obj.read()
except FileNotFoundError:
    msg = "Sorry, the file " + filename + " does not exist."
    print(msg)

在这个示例中，try代码块引发FileNotFoundError异常，因此Python找出与该错误匹配的except代码块，并运行其中的代码。最终的结果是显示一条友好的错误消息，而不是traceback:

如果文件不存在，这个程序什么都不做，因此错误处理代码的意义不大。下面来看看在你使用多个文件时，异常处理可提供什么样的帮助。

3.6 分析文本

你可以分析包含整本书的文本文件。

很多经典文学作品都是以简单文本文件的方式提供的，因为它们不受版权限制。本节使用的文本来自项目Gutenberg（http://gutenberg.org/），这个项目提供了一系列不受版权限制的文学作品，如果你要在编程项目中使用文学文本，这是一个很不错的资源。

使用方法split()，它根据一个字符串创建一个单词列表。下面是对只包含童话名"Alice in Wonderland"的字符串调用方法split()的结果：

方法split()以空格为分隔符将字符串分拆成多个部分，并将这些部分都存储到一个列表中。结果是一个包含字符串中所有单词的列表，虽然有些单词可能包含标点。

计算前面编写的程序生成的guest_book.txt中包含多少个单词:

filename = 'guest_book.txt'

try:
    with open(filename) as f_obj:
        contents = f_obj.read()
except FileNotFoundError:
    msg = "Sorry, the file " + filename + " does not exist."
    print(msg)
else:
    # 计算文件大致包含多少个单词
    words = contents.split()
    num_words = len(words)
    print("The file " + filename + " has about " + str(num_words) + " words.")

输出：

3.7 使用多个文件

下面多分析几本书。这样做之前，我们先将这个程序的大部分代码移到一个名为count_words()的函数中，这样对多本书进行分析时将更容易：

def count_words(filename):
    """计算一个文件中大致包含多少个单词"""
    try:
        with open(filename) as f_obj:
            contents = f_obj.read()
    except FileNotFoundError:
        msg = "Sorry, the file " + filename + " does not exist."
        print(msg)
    else:
        # 计算文件大致包含多少个单词
        words = contents.split()
        num_words = len(words)
        print("The file " + filename + " has about " + str(
            num_words) + " words.")


filename = 'guest_book.txt'
count_words(filename)

接下来计算多个文件大致分别包含多少个单词，其中filename.txt不在程序所在的目录中：

def count_words(filename):
	--snip--

filenames = ['learning_python.txt', 'filename.txt',
            'guest_book.txt', 'programming.txt']
for filename in filenames:
    count_words(filename)

输出：

在这个示例中，使用try-except代码块提供了两个重要的优点：避免让用户看到traceback；让程序能够继续分析能够找到的其他文件。

如果不捕获因找不到filename.txt而引发的FileNotFoundError异常，用户将看到完整的traceback，而程序将在尝试分析filename后停止运行——根本不分析guest.txt和programming.txt。

3.8 发生异常时直接 pass

在前一个示例中，我们告诉用户有一个文件找不到。但并非每次捕获到异常时都需要告诉用户，有时候你希望程序在发生异常时一声不吭，就像什么都没有发生一样继续运行。

要让程序在失败时一声不吭，可像通常那样编写try代码块，但在except代码块中明确地告诉Python什么都不要做。Python有一个pass语句，可在代码块中使用它来让Python什么都不要做：

def count_words(filename):
	"""计算一个文件中大致包含多少个单词"""
    try:
    	--snip--
        except FileNotFoundError:
        pass
    else:
    	--snip--

filenames = ['learning_python.txt', 'filename.txt',
            'guest_book.txt', 'programming.txt']
for filename in filenames:
    count_words(filename)

现在，出现FileNotFoundError异常时，将执行except代码块中的代码，但什么都不会发生。这种错误发生时，不会出现traceback，也没有任何输出。用户将看到存在的每个文件包含多少个单词，但没有任何迹象表明有一个文件未找到：

pass语句还充当了占位符，它提醒你在程序的某个地方什么都没有做，并且以后也许要在这里做些什么。
例如，在这个程序中，我们可能决定将找不到的文件的名称写入到文件missing_files.txt中。用户看不到这个文件，但我们可以读取这个文件，进而处理所有文件找不到的问题。

3.9 决定报告哪些错误

编写得很好且经过详尽测试的代码不容易出现内部错误，如语法或逻辑错误，但只要程序依赖于外部因素，如用户输入、存在指定的文件、有网络链接，就有可能出现异常。凭借经验可判断该在程序的什么地方包含异常处理块，以及出现错误时该向用户提供多少相关的信息。

4 存储数据

很多程序都要求用户输入某种信息，如让用户存储游戏首选项或提供要可视化的数据。不管专注的是什么，程序都把用户提供的信息存储在列表和字典等数据结构中。用户关闭程序时，你几乎总是要保存他们提供的信息；一种简单的方式是使用模块json来存储数据。

模块json让你能够将简单的Python数据结构转储到文件中，并在程序再次运行时加载该文件中的数据。你还可以使用json在Python程序之间分享数据。更重要的是，JSON数据格式并非Python专用的，这让你能够将以JSON格式存储的数据与使用其他编程语言的人分享。

4.1 使用 json.dump()和 json.load()

我们来编写一个存储一组数字的简短程序，再编写一个将这些数字读取到内存中的程序。第一个程序将使用json.dump()来存储这组数字，而第二个程序将使用json.load()。

4.1.1 json.dump()

函数json.dump()接受两个实参：要存储的数据以及可用于存储数据的文件对象。
使用json.dump()来存储数字列表：

import json

numbers = [2, 3, 5, 7, 11, 13]

filename = 'numbers.json'
with open(filename, 'w') as f_obj:
    json.dump(numbers, f_obj)

先导入模块json，再创建一个数字列表。在第5行，我们指定了要将该数字列表存储到其中的文件的名称。通常使用文件扩展名.json来指出文件存储的数据为JSON格式。接下来，我们以写入模式打开这个文件，让json能够将数据写入其中（见第6行）。在第7行，我们使用函数json.dump()将数字列表存储到文件numbers.json中。

这个程序没有输出，但我们可以打开文件numbers.json，看看其内容。数据的存储格式与Python中一样：

4.1.2 json.load()

下面使用json.load()将这个列表读取到内存中：

import json

filename = 'numbers.json'
with open(filename) as f_obj:
    numbers = json.load(f_obj)

print(numbers)

在第3行，我们确保读取的是前面写入的文件。这次我们以读取方式打开这个文件，因为Python只需读取这个文件（见第2行）。在第3行，我们使用函数json.load()加载存储在numbers.json中的信息，并将其存储到变量numbers中。
最后，我们打印恢复的数字列表，看看它是否与number_writer.py中创建的数字列表相同：

4.2 保存和读取用户生成的数据

对于用户生成的数据，使用json保存它们大有裨益，因为如果不以某种方式进行存储，等程序停止运行时用户的信息将丢失。

将保存和读取合并到一个程序中：

import json

# 如果以前存储了用户名，就加载它
# 否则，就提示用户输入用户名并存储它
filename = 'username.json'
try:
    with open(filename) as f_obj:
        username = json.load(f_obj)
except FileNotFoundError:
    username = input("What is your name? ")
    with open(filename, 'w') as f_obj:
        json.dump(username, f_obj)
        print("We will remember you when you come back, " + username + "!")
else:
    print("Welcome back, " + username + "!")

如果这个程序是首次运行，输出将如下：

否则，输出将如下：

4.3 重构

你经常会遇到这样的情况：代码能够正确地运行，但可做进一步的改进——将代码划分为一系列完成具体工作的函数。这样的过程被称为重构。
重构让代码更清晰、更易于理解、更容易扩展。

示例：

import json


def get_stored_username():
    """如果存储了用户名，就获取它"""
    filename = 'username.json'
    try:
        with open(filename) as f_obj:
            username = json.load(f_obj)
    except FileNotFoundError:
        return None
    else:
        return username


def get_new_username():
    """提示用户输入用户名"""
    username = input("What is your name? ")
    filename = 'username.json'
    with open(filename, 'w') as f_obj:
        json.dump(username, f_obj)
    return username


def greet_user():
    """问候用户，并指出其名字"""
    username = get_stored_username()
    if username:
        print("Welcome back, " + username + "!")
    else:
        username = get_new_username()
        print("We will remember you when you come back, " + username + "!")


greet_user()

输出1：

输出2：