Python学习记录——12.文件处理

野性酷女 2023-05-31 02:33 10阅读 0赞

## 1.文件处理 ##

读写文件是最常见的IO操作。Python内置了读写文件的函数，用法和C是兼容的。

读写文件前，先必须了解一下，在磁盘上读写文件的功能都是由操作系统提供的，现代操作系统不允许普通的程序直接操作磁盘，所以，读写文件就是请求操作系统打开一个文件对象（通常称为文件描述符），然后，通过操作系统提供的接口从这个文件对象中读取数据（读文件），或者把数据写入这个文件对象（写文件）。

**读文件**

要以读文件的模式打开一个文件对象，使用Python内置的`open()`函数，传入文件名和标示符：

>>> f = open('/Users/michael/test.txt', 'r')

标示符’r’表示读，这样，我们就成功地打开了一个文件。

如果文件不存在，`open()`函数就会抛出一个`IOError`的错误，并且给出错误码和详细的信息告诉你文件不存在：

>>> f=open('/Users/michael/notfound.txt', 'r')
    Traceback (most recent call last):
      File "<stdin>", line 1, in <module>
    FileNotFoundError: [Errno 2] No such file or directory: '/Users/michael/notfound.txt'

如果文件打开成功，接下来，调用`read()`方法可以一次读取文件的全部内容，Python把内容读到内存，用一个`str`对象表示：

>>> f.read()
    'Hello, world!'

最后一步是调用`close()`方法关闭文件。文件使用完毕后必须关闭，因为文件对象会占用操作系统的资源，并且操作系统同一时间能打开的文件数量也是有限的：

>>> f.close()

由于文件读写时都有可能产生`IOError`，一旦出错，后面的`f.close()`就不会调用。所以，为了保证无论是否出错都能正确地关闭文件，我们可以使用`try ... finally`来实现：

try:
        f = open('/path/to/file', 'r')
        print(f.read())
    finally:
        if f:
            f.close()

但是每次都这么写实在太繁琐，所以，Python引入了`with`语句来自动帮我们调用`close()`方法：

with open('/path/to/file', 'r') as f:
        print(f.read())

这和前面的`try ... finally`是一样的，但是代码更佳简洁，并且不必调用`f.close()`方法。

调用`read()`会一次性读取文件的全部内容，如果文件有10G，内存就爆了，所以，要保险起见，可以反复调用`read(size)`方法，每次最多读取size个字节的内容。另外，调用`readline()`可以每次读取一行内容，调用`readlines()`一次读取所有内容并按行返回`list`。因此，要根据需要决定怎么调用。

如果文件很小，`read()`一次性读取最方便；如果不能确定文件大小，反复调用`read(size)`比较保险；如果是配置文件，调用`readlines()`最方便：

for line in f.readlines():
        print(line.strip()) # 把末尾的'\n'删掉

**file-like Object**

像`open()`函数返回的这种有个`read()`方法的对象，在Python中统称为file-like Object。除了file外，还可以是内存的字节流，网络流，自定义流等等。file-like Object不要求从特定类继承，只要写个`read()`方法就行。

`StringIO`就是在内存中创建的file-like Object，常用作临时缓冲。

**二进制文件**

前面讲的默认都是读取文本文件，并且是UTF-8编码的文本文件。要读取二进制文件，比如图片、视频等等，用`'rb'`模式打开文件即可：

>>> f = open('/Users/michael/test.jpg', 'rb')
    >>> f.read()
    b'\xff\xd8\xff\xe1\x00\x18Exif\x00\x00...' # 十六进制表示的字节

**字符编码**

要读取非UTF-8编码的文本文件，需要给`open()`函数传入`encoding`参数，例如，读取GBK编码的文件：

>>> f = open('/Users/michael/gbk.txt', 'r', encoding='gbk')
    >>> f.read()
    '测试'

遇到有些编码不规范的文件，你可能会遇到`UnicodeDecodeError`，因为在文本文件中可能夹杂了一些非法编码的字符。遇到这种情况，`open()`函数还接收一个`errors`参数，表示如果遇到编码错误后如何处理。最简单的方式是直接忽略：

>>> f = open('/Users/michael/gbk.txt', 'r', encoding='gbk', errors='ignore')

**写文件**

写文件和读文件是一样的，唯一区别是调用`open()`函数时，传入标识符`'w'`或者`'wb'`表示写文本文件或写二进制文件：

>>> f = open('/Users/michael/test.txt', 'w')
    >>> f.write('Hello, world!')
    >>> f.close()

你可以反复调用`write()`来写入文件，但是务必要调用`f.close()`来关闭文件。当我们写文件时，操作系统往往不会立刻把数据写入磁盘，而是放到内存缓存起来，空闲的时候再慢慢写入。只有调用`close()`方法时，操作系统才保证把没有写入的数据全部写入磁盘。忘记调用`close()`的后果是数据可能只写了一部分到磁盘，剩下的丢失了。所以，还是用`with`语句来得保险：

with open('/Users/michael/test.txt', 'w') as f:
        f.write('Hello, world!')

要写入特定编码的文本文件，请给`open()`函数传入`encoding`参数，将字符串自动转换成指定编码。

细心的人会发现，以`'w'`模式写入文件时，如果文件已存在，会直接覆盖（相当于删掉后新写入一个文件）。如果我们希望追加到文件末尾怎么办？可以传入`'a'`以追加（append）模式写入。

## 2.文件处理的相关方法 ##

file 对象使用 open 函数来创建，下表列出了 file 对象常用的函数：

<table> 
 <thead> 
  <tr> 
   <th align="left">序号</th> 
   <th align="left">方法及描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">1</td> 
   <td align="left"><a href="https://www.w3cschool.cn/python/file-close.html" rel="nofollow">file.close()</a>关闭文件。关闭后文件不能再进行读写操作。</td> 
  </tr> 
  <tr> 
   <td align="left">2</td> 
   <td align="left"><a href="https://www.w3cschool.cn/python/file-flush.html" rel="nofollow">file.flush()</a>刷新文件内部缓冲，直接把内部缓冲区的数据立刻写入文件, 而不是被动的等待输出缓冲区写入。</td> 
  </tr> 
  <tr> 
   <td align="left">3</td> 
   <td align="left"><a href="https://www.w3cschool.cn/python/file-fileno.html" rel="nofollow">file.fileno()</a>返回一个整型的文件描述符(file descriptor FD 整型), 可以用在如os模块的read方法等一些底层操作上。</td> 
  </tr> 
  <tr> 
   <td align="left">4</td> 
   <td align="left"><a href="https://www.w3cschool.cn/python/file-isatty.html" rel="nofollow">file.isatty()</a>如果文件连接到一个终端设备返回 True，否则返回 False。</td> 
  </tr> 
  <tr> 
   <td align="left">5</td> 
   <td align="left"><a href="https://www.w3cschool.cn/python/file-next.html" rel="nofollow">file.next()</a>返回文件下一行。</td> 
  </tr> 
  <tr> 
   <td align="left">6</td> 
   <td align="left">[file.read(<a href="https://www.w3cschool.cn/python/python-file-read.html" rel="nofollow">size])</a>从文件读取指定的字节数，如果未给定或为负则读取所有。</td> 
  </tr> 
  <tr> 
   <td align="left">7</td> 
   <td align="left">[file.readline(<a href="https://www.w3cschool.cn/python/file-readline.html" rel="nofollow">size])</a>读取整行，包括 “\n” 字符。</td> 
  </tr> 
  <tr> 
   <td align="left">8</td> 
   <td align="left">[file.readlines(<a href="https://www.w3cschool.cn/python/file-readlines.html" rel="nofollow">sizehint])</a>读取所有行并返回列表，若给定sizeint&gt;0，返回总和大约为sizeint字节的行, 实际读取值可能比sizeint较大, 因为需要填充缓冲区。</td> 
  </tr> 
  <tr> 
   <td align="left">9</td> 
   <td align="left">[file.seek(offset<a href="https://www.w3cschool.cn/python/file-seek.html" rel="nofollow">, whence])</a>设置文件当前位置</td> 
  </tr> 
  <tr> 
   <td align="left">10</td> 
   <td align="left"><a href="https://www.w3cschool.cn/python/file-tell.html" rel="nofollow">file.tell()</a>返回文件当前位置。</td> 
  </tr> 
  <tr> 
   <td align="left">11</td> 
   <td align="left">[file.truncate(<a href="https://www.w3cschool.cn/python/file-truncate.html" rel="nofollow">size])</a>截取文件，截取的字节通过size指定，默认为当前文件位置。</td> 
  </tr> 
  <tr> 
   <td align="left">12</td> 
   <td align="left"><a href="https://www.w3cschool.cn/python/python-file-write.html" rel="nofollow">file.write(str)</a>将字符串写入文件，返回的是写入的字符。</td> 
  </tr> 
  <tr> 
   <td align="left">13</td> 
   <td align="left"><a href="https://www.w3cschool.cn/python/file-writelines.html" rel="nofollow">file.writelines(sequence)</a>向文件写入一个序列字符串列表，如果需要换行则要自己加入每行的换行符。</td> 
  </tr> 
 </tbody> 
</table>

## 3.文件的存储模块 ##

1.  **pickle模块**

在程序运行的过程中，所有的变量都是在内存中，比如，定义一个dict：

d = dict(name='Bob', age=20, score=88)

可以随时修改变量，比如把`name`改成`'Bill'`，但是一旦程序结束，变量所占用的内存就被操作系统全部回收。如果没有把修改后的`'Bill'`存储到磁盘上，下次重新运行程序，变量又被初始化为`'Bob'`。

我们把变量从内存中变成可存储或传输的过程称之为序列化，在Python中叫pickling，在其他语言中也被称之为serialization，marshalling，flattening等等，都是一个意思。

序列化之后，就可以把序列化后的内容写入磁盘，或者通过网络传输到别的机器上。

反过来，把变量内容从序列化的对象重新读到内存里称之为反序列化，即unpickling。

Python提供了`pickle`模块来实现序列化。

首先，我们尝试把一个对象序列化并写入文件：

>>> import pickle
    >>> d = dict(name='Bob', age=20, score=88)
    >>> pickle.dumps(d)
    b'\x80\x03}q\x00(X\x03\x00\x00\x00ageq\x01K\x14X\x05\x00\x00\x00scoreq\x02KXX\x04\x00\x00\x00nameq\x03X\x03\x00\x00\x00Bobq\x04u.'

`pickle.dumps()`方法把任意对象序列化成一个`bytes`，然后，就可以把这个`bytes`写入文件。或者用另一个方法`pickle.dump()`直接把对象序列化后写入一个file-like Object：

>>> f = open('dump.txt', 'wb')
    >>> pickle.dump(d, f)
    >>> f.close()

看看写入的`dump.txt`文件，一堆乱七八糟的内容，这些都是Python保存的对象内部信息。

当我们要把对象从磁盘读到内存时，可以先把内容读到一个`bytes`，然后用`pickle.loads()`方法反序列化出对象，也可以直接用`pickle.load()`方法从一个`file-like Object`中直接反序列化出对象。我们打开另一个Python命令行来反序列化刚才保存的对象：

>>> f = open('dump.txt', 'rb')
    >>> d = pickle.load(f)
    >>> f.close()
    >>> d
    { 'age': 20, 'score': 88, 'name': 'Bob'}

变量的内容又回来了！

当然，这个变量和原来的变量是完全不相干的对象，它们只是内容相同而已。

Pickle的问题和所有其他编程语言特有的序列化问题一样，就是它只能用于Python，并且可能不同版本的Python彼此都不兼容，因此，只能用Pickle保存那些不重要的数据，不能成功地反序列化也没关系。

1.  **marshal模块**

Python的marshal模块，顾名思义也是负责在Python数值与二进制字节对象之间进行转换的。但是，marshal模块仅供Python解析器内部用作对象的序列化，不推荐开发人员使用该模块处理Python对象的序列化和反序列化。

marshal模块不是通用的序列化/反序列化模块，而是以读写.pyc文件中的Python代码为目的设计的。marshal模块提供的函数可以读写二进制对象为Python数值。这里的二进制对象是Python字节定义的独特二进制格式，与所在机器的体系结构无关。

*  load(file)，从文件读取Python数值并返回该值loads(bytes)，将读入的字节对象转换为Python数值
 *  dump(value, file\[, version\])，将Python数值写入到文件
 *  dumps(value\[, version\])，将读入的Python数值转换为一个字节对象
 *  version，当前marshal模块使用的二进制格式的版本
 *  事实上，要序列化或反序列化Python对象，建议使用pickle模块。如在RPC调用中对Python对象进行远程传输，则使用pickle模块。

如果要对Python对象进行持久化，则使用shelve模块。

## 4.JSON ##

**JSON**

如果我们要在不同的编程语言之间传递对象，就必须把对象序列化为标准格式，比如XML，但更好的方法是序列化为JSON，因为JSON表示出来就是一个字符串，可以被所有语言读取，也可以方便地存储到磁盘或者通过网络传输。JSON不仅是标准格式，并且比XML更快，而且可以直接在Web页面中读取，非常方便。

JSON表示的对象就是标准的JavaScript语言的对象，JSON和Python内置的数据类型对应如下：

<table> 
 <thead> 
  <tr> 
   <th align="left">JSON类型</th> 
   <th align="left">Python类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">{}</td> 
   <td align="left">dict</td> 
  </tr> 
  <tr> 
   <td align="left">[]</td> 
   <td align="left">list</td> 
  </tr> 
  <tr> 
   <td align="left">“string”</td> 
   <td align="left">str</td> 
  </tr> 
  <tr> 
   <td align="left">1234.56</td> 
   <td align="left">int或float</td> 
  </tr> 
  <tr> 
   <td align="left">true/false</td> 
   <td align="left">True/False</td> 
  </tr> 
  <tr> 
   <td align="left">null</td> 
   <td align="left">None</td> 
  </tr> 
 </tbody> 
</table>

Python内置的`json`模块提供了非常完善的Python对象到JSON格式的转换。我们先看看如何把Python对象变成一个JSON：

>>> import json
    >>> d = dict(name='Bob', age=20, score=88)
    >>> json.dumps(d)
    '{"age": 20, "score": 88, "name": "Bob"}'

`dumps()`方法返回一个`str`，内容就是标准的JSON。类似的，`dump()`方法可以直接把JSON写入一个`file-like Object`。

要把JSON反序列化为Python对象，用`loads()`或者对应的`load()`方法，前者把JSON的字符串反序列化，后者从`file-like Object`中读取字符串并反序列化：

>>> json_str = '{"age": 20, "score": 88, "name": "Bob"}'
    >>> json.loads(json_str)
    { 'age': 20, 'score': 88, 'name': 'Bob'}

由于JSON标准规定JSON编码是UTF-8，所以我们总是能正确地在Python的`str`与JSON的字符串之间转换。

**JSON进阶**

Python的`dict`对象可以直接序列化为JSON的`{}`，不过，很多时候，我们更喜欢用`class`表示对象，比如定义`Student`类，然后序列化：

import json
    
    class Student(object):
        def __init__(self, name, age, score):
            self.name = name
            self.age = age
            self.score = score
    
    s = Student('Bob', 20, 88)
    print(json.dumps(s))

运行代码，毫不留情地得到一个`TypeError`：

Traceback (most recent call last):
      ...
    TypeError: <__main__.Student object at 0x10603cc50> is not JSON serializable

错误的原因是`Student`对象不是一个可序列化为JSON的对象。

如果连`class`的实例对象都无法序列化为JSON，这肯定不合理！

别急，仔细看看`dumps()`方法的参数列表，可以发现，除了第一个必须的`obj`参数外，`dumps()`方法还提供了一大堆的可选参数：

https://docs.python.org/3/library/json.html\#json.dumps

这些可选参数就是让我们来定制JSON序列化。前面的代码之所以无法把`Student`类实例序列化为JSON，是因为默认情况下，`dumps()`方法不知道如何将`Student`实例变为一个JSON的`{}`对象。

可选参数`default`就是把任意一个对象变成一个可序列为JSON的对象，我们只需要为`Student`专门写一个转换函数，再把函数传进去即可：

def student2dict(std):
        return { 
            'name': std.name,
            'age': std.age,
            'score': std.score
        }

这样，`Student`实例首先被`student2dict()`函数转换成`dict`，然后再被顺利序列化为JSON：

>>> print(json.dumps(s, default=student2dict))
    { "age": 20, "name": "Bob", "score": 88}

不过，下次如果遇到一个`Teacher`类的实例，照样无法序列化为JSON。我们可以偷个懒，把任意`class`的实例变为`dict`：

print(json.dumps(s, default=lambda obj: obj.__dict__))

因为通常`class`的实例都有一个`__dict__`属性，它就是一个`dict`，用来存储实例变量。也有少数例外，比如定义了`__slots__`的class。

同样的道理，如果我们要把JSON反序列化为一个`Student`对象实例，`loads()`方法首先转换出一个`dict`对象，然后，我们传入的`object_hook`函数负责把`dict`转换为`Student`实例：

def dict2student(d):
        return Student(d['name'], d['age'], d['score'])

运行结果如下：

>>> json_str = '{"age": 20, "score": 88, "name": "Bob"}'
    >>> print(json.loads(json_str, object_hook=dict2student))
    <__main__.Student object at 0x10cd3c190>

打印出的是反序列化的`Student`实例对象。