Python文件操作与模块：数据持久化与代码复用

引言

在前面的文章中，我们学习了Python的基本数据类型、控制流和函数，这些知识足以让你编写出许多有趣的程序。然而，程序运行时产生的数据通常是临时的，一旦程序结束，这些数据就会丢失。为了让数据能够持久化存储，我们需要学习如何进行文件操作。此外，随着程序变得越来越复杂，将代码组织成模块和包变得至关重要，这有助于提高代码的可维护性和复用性。

本篇文章将带你深入了解Python的文件操作，包括文件的读写、追加等，并介绍Python的模块和包机制，让你能够更好地组织和管理你的代码。

1. 文件操作：持久化你的数据

文件操作是编程中非常常见的任务，它允许程序与外部文件进行交互，读取文件内容或将数据写入文件。在Python中，文件操作通常遵循以下步骤：打开文件、读/写文件、关闭文件。

1.1 打开文件：`open()`函数

在进行文件操作之前，你需要使用内置的open()函数打开一个文件。open()函数返回一个文件对象，你可以通过这个对象来执行读写操作。

open(file, mode=\'r\', encoding=None)

file：要打开的文件路径（可以是相对路径或绝对路径）。
mode：打开文件的模式。常见的模式有：
- 'r'：读取模式（默认）。文件必须存在。
- 'w'：写入模式。如果文件不存在则创建，如果文件存在则清空内容。
- 'a'：追加模式。如果文件不存在则创建，如果文件存在则在文件末尾追加内容。
- 'x'：独占创建模式。如果文件已存在则会引发FileExistsError。
- 'b'：二进制模式（例如，'rb', 'wb'）。用于处理非文本文件（如图片、视频）。
- 't'：文本模式（默认）。用于处理文本文件。
encoding：指定文件的编码格式，例如'utf-8'、'gbk'。对于文本文件，强烈建议指定编码，以避免乱码问题。

# 以读取模式打开文件
try:
    file = open("example.txt", "r", encoding="utf-8")
    print("文件打开成功！")
    file.close()
except FileNotFoundError:
    print("文件不存在。")

# 以写入模式打开文件（如果文件不存在则创建，存在则清空）
file = open("new_file.txt", "w", encoding="utf-8")
print("新文件已创建或清空。")
file.close()

1.2 写入文件

文件对象提供了write()和writelines()方法用于写入数据。

file.write(string)：将字符串写入文件。返回写入的字符数。
file.writelines(list_of_strings)：将字符串列表写入文件。不会自动添加换行符。

# 写入新文件
with open("output.txt", "w", encoding="utf-8") as file:
    file.write("Hello, Python file operations!\n")
    file.write("This is a new line.\n")

# 追加内容到文件
with open("output.txt", "a", encoding="utf-8") as file:
    file.write("Appending a third line.\n")

# 写入多行
lines = ["First line.\n", "Second line.\n", "Third line.\n"]
with open("multi_lines.txt", "w", encoding="utf-8") as file:
    file.writelines(lines)

最佳实践：使用with语句

为了确保文件在使用后被正确关闭，即使发生错误，也强烈建议使用with语句。with语句会在代码块执行完毕后自动关闭文件，无需手动调用close()方法。

1
2
3

with open("my_document.txt", "w", encoding="utf-8") as f:
    f.write("这是使用with语句写入的内容。")
# 文件在with块结束后自动关闭

1.3 读取文件

文件对象提供了read()、readline()和readlines()方法用于读取数据。

file.read(size=-1)：读取文件中的所有内容，并作为字符串返回。size参数可选，表示读取的字节数。
file.readline()：读取文件中的一行内容，包括换行符。
file.readlines()：读取文件中的所有行，并作为字符串列表返回，每行包含换行符。

# 假设 output.txt 包含以下内容：
# Hello, Python file operations!
# This is a new line.
# Appending a third line.

with open("output.txt", "r", encoding="utf-8") as file:
    content = file.read()
    print("\n--- 全部内容 ---")
    print(content)

with open("output.txt", "r", encoding="utf-8") as file:
    print("\n--- 逐行读取 ---")
    line1 = file.readline()
    line2 = file.readline()
    print(line1, end="") # end="" 避免print额外添加换行符
    print(line2, end="")

with open("output.txt", "r", encoding="utf-8") as file:
    print("\n--- 读取所有行 ---")
    all_lines = file.readlines()
    for line in all_lines:
        print(line, end="")

1.4 文件指针

文件指针指示了当前读写操作的位置。你可以使用file.tell()获取当前位置，使用file.seek(offset, whence)来移动文件指针。

offset：偏移量。
whence：可选参数，表示偏移的起始位置：
- 0（默认）：从文件开头开始。
- 1：从当前位置开始。
- 2：从文件末尾开始。

with open("output.txt", "rb") as file: # 使用二进制模式，因为seek在文本模式下行为复杂
    print("初始位置:", file.tell()) # 0
    file.read(5) # 读取5个字节
    print("读取5字节后位置:", file.tell()) # 5
    file.seek(0) # 移动到文件开头
    print("移动到开头后位置:", file.tell()) # 0
    file.seek(2, 1) # 从当前位置向后移动2个字节
    print("从当前位置移动2字节后位置:", file.tell()) # 2

2. 模块与包：组织你的代码

随着你的Python程序变得越来越大，将所有代码都放在一个文件中会变得难以管理。Python提供了模块（Modules）和包（Packages）的机制，帮助你更好地组织和复用代码。

2.1 模块（Modules）

模块是一个包含Python代码的文件（以.py为扩展名）。模块可以定义函数、类和变量，也可以包含可执行的代码。通过模块，你可以将相关的代码组织在一起，并在其他文件中导入和使用它们。

创建模块：

假设你有一个名为my_module.py的文件：

# my_module.py

def greet(name):
    return f"Hello, {name}!"

PI = 3.14159

class MyClass:
    def __init__(self, value):
        self.value = value

    def get_value(self):
        return self.value

if __name__ == "__main__":
    print("这是my_module模块被直接执行时输出的内容")
    print(greet("World"))

导入模块：import语句

你可以使用import语句在另一个Python文件中导入并使用这个模块。

# main.py
import my_module

print(my_module.greet("Alice")) # Hello, Alice!
print(my_module.PI) # 3.14159

obj = my_module.MyClass(100)
print(obj.get_value()) # 100

其他导入方式：

import module_name as alias： 为模块设置别名。
1
2
import my_module as mm
print(mm.greet("Bob"))
from module_name import item_name： 导入模块中的特定项（函数、变量、类）。
1
2
3
from my_module import greet, PI
print(greet("Charlie"))
print(PI)
from module_name import *（不推荐）： 导入模块中的所有项。这会污染当前命名空间，可能导致名称冲突。

2.2 包（Packages）

包是一种组织模块的方式，它是一个包含多个模块和其他子包的目录。包的目录中必须包含一个名为__init__.py的特殊文件（可以是空文件），它告诉Python这是一个包。

创建包结构：

my_package/
├── __init__.py
├── module_a.py
└── sub_package/
    ├── __init__.py
    └── module_b.py

my_package/module_a.py:

1
2
3

# my_package/module_a.py
def func_a():
    print("Function A from module_a")

my_package/sub_package/module_b.py:

1
2
3

# my_package/sub_package/module_b.py
def func_b():
    print("Function B from module_b")

导入包中的模块：

# main.py
from my_package import module_a
from my_package.sub_package import module_b

module_a.func_a()
module_b.func_b()

2.3 Python标准库

Python拥有一个庞大而功能丰富的标准库，提供了各种模块来处理常见任务，例如：

os：与操作系统交互，如文件路径操作、目录管理。
sys：提供对解释器相关变量和函数的访问。
math：数学函数。
random：生成随机数。
datetime：处理日期和时间。
json：处理JSON数据。
re：正则表达式。

import os
import datetime

# 获取当前工作目录
current_dir = os.getcwd()
print("当前工作目录:", current_dir)

# 获取当前日期和时间
now = datetime.datetime.now()
print("当前时间:", now)

总结

本篇文章深入探讨了Python的文件操作和模块与包机制。文件操作是实现数据持久化的关键，让你能够读取和写入外部文件，从而保存和加载程序数据。而模块和包则提供了强大的代码组织和复用能力，帮助你构建结构清晰、易于维护的大型项目。

掌握文件操作和模块化编程是成为一名合格Python开发者的重要一步。多加实践，尝试编写一些需要读写文件或组织成多个模块的小项目，你将能够更好地理解和运用这些知识。在接下来的文章中，我们将转向Node.js，探索JavaScript在服务器端的应用。

参考文献

[1] 菜鸟教程. Python 文件I/O. https://www.runoob.com/python/python-file-io.html
[2] 菜鸟教程. Python 模块. https://www.runoob.com/python/python-modules.html
[3] Python官方文档. 模块. https://docs.python.org/zh-cn/3/tutorial/modules.html

阿舰的博客