Python存储与读写二进制文件的示例代码_Python

技术背景

一般情况下我们会选择使用明文形式来存储数据，如json、txt、csv等等。如果是需要压缩率较高的存储格式，还可以选择使用hdf5或者npz等格式。还有一种比较紧凑的数据存储格式，就是直接按照二进制格式存储。这种格式下，存储的数据之间没有间隔符，在没有压缩的情况下应该是体积最小的存储类型。

使用方法

在python中，我们可以使用numpy.tofile()功能，直接将numpy数组类型存储到一个二进制文件中。读取的时候，虽然可以直接使用open(file_name, 'rb')来进行读取，但是为了适配大量io的场景，这里我们使用内存映射mmap的形式来进行数据读取。

完整示例

如下是一个完整的示例代码，相关的功能直接用注释的形式在代码中标记：

import numpy as np
import mmap
import resource
# 获取页数据量大小（单位：字节）
page_size = resource.getpagesize()
# 定义单精度浮点数数据占用字节（单位：字节）
data_size = 4
# 计算页存储数据数量（num_float32）
page_fnum = int(page_size/data_size)
print ("the page_size is: {}".format(page_size))
print ("corresponding float32 numbers should be: {}".format(page_fnum))
# 生成示例数据，使用page_fnum+4大小的数据量定义两页数据
tmp_arr = np.arange(page_fnum+4).astype(np.float32)
# 数据存储路径
tmp_file = '/tmp/tmp.dat'
# 将数组存储到二进制文件中
tmp_arr.tofile(tmp_file)
# 每次从二进制文件中读取4个数据
read_num = 4
with open(tmp_file, 'rb') as file:
    # 第一页数据的内存映射
    mm = mmap.mmap(file.fileno(), 0, access=mmap.access_read, offset=0)
    # 第一页数据的1、2、3、4位数据
    print (np.frombuffer(mm.read(data_size*read_num), dtype='<f4'))
    # 第一页数据的5、6、7、8位数据
    print (np.frombuffer(mm.read(data_size*read_num), dtype='<f4'))
    # 第二页数据的内存映射
    mm = mmap.mmap(file.fileno(), 0, access=mmap.access_read, offset=page_size)
    # 第二页数据的1~4位数据
    print (np.frombuffer(mm.read(data_size*read_num), dtype='<f4'))
    # 第二页数据的5~8位数据
    print (np.frombuffer(mm.read(data_size*read_num), dtype='<f4'))
    # 关闭内存映射
    mm.close()
# 退出文件io

该脚本的输出结果为：

the page_size is: 4096
corresponding float32 numbers should be: 1024
[0. 1. 2. 3.]
[4. 5. 6. 7.]
[1024. 1025. 1026. 1027.]
[]

结果解析

我们打印的第一个数据是页大小，这里显示是4096个字节。而一个单精度浮点数占4个字节，所以一页存了1024个单精度浮点数，也就是第二个打印输出的结果。由于我们定义的numpy数组是一个从0开始的递增数组，因此第一页数据的前8位数字就是从0到7。而第二页的数据是1024~1027一共4个浮点数，占16个字节。所以我们在第二页第二次使用numpy.frombuffer()去读取数据的时候，得到的是一个空的数组。此外我们可以查看一下这个二进制文件的大小：

in [1]: import os
in [2]: os.path.getsize('/tmp/tmp.dat')
out[2]: 4112

一共是4112个字节，刚好是4096+16个字节。

总结概要

本文介绍了一种在python中将numpy数组转存为一个紧凑的二进制格式的文件，及其使用内存映射的形式进行读取的方案。一个二进制的数据流，不仅可以更加方便页形式的内存映射，相比于传统的numpy单精度浮点数数组还有一个可哈希的特性。总体来说是一个对于高性能计算十分友好的存储格式，在cudasponge中作为一个分子动力学模拟轨迹输出的格式使用。