一学就废|Python基础碎片，Pathlib模块

模块简介

pathlib是 Python 的标准库模块之一，用于处理文件系统路径。它提供了一种面向对象的方式来操作路径，使得路径操作更加直观、简洁和易读。与传统的os.path模块相比， pathlib更加现代化，功能也更强大。

pathlib模块在处理文件系统路径时提供了极大的便利，尤其是在需要跨平台、自动化或组织文件结构的场景中。它不仅简化了路径操作，还提高了代码的可读性和可维护性。无论是数据处理、自动化脚本，还是项目构建，pathlib都是一个非常实用的工具。

Python Pathlib 模块的基本用法

Python path lib 模块提供了一种面向对象的方式来处理文件系统路径。以下是我们如何使用它比使用旧的 os 和 os. path 模块更有效地执行常见的文件系统操作。

pathlib的用途主要有以下几方面

1. 路径操作： pathlib提供了丰富的方法来处理路径，如拼接路径、获取文件名、获取父路径、检查路径是否存在等。
2. 文件和目录操作：可以创建、删除文件和目录，以及读取目录内容。
3. 跨平台支持：pathlib会根据操作系统（如 Windows 使用反斜杠 \ ，而 Linux 和 macOS 使用正斜杠 / ）自动选择合适的路径分隔符，使得代码具有更好的跨平台性。
4. 提高代码可读性：通过面向对象的方式操作路径，代码更加简洁易懂。

导入主类

在我们可以使用pathlib的任何特性之前，我们需要从模块中导入Path类.

from pathlib import Path

创建路径对象

pathlib提供了Path类，用于表示文件系统路径，可以通过以下方式创建路径对象。

# 创建路径对象
path = Path('/home/user/documents/file.txt')

路径拼接

使用 / 运算符可以方便地拼接路径，而无需手动处理路径分隔符。

base_path = Path('/home/user')
file_name = 'file.txt'
full_path = base_path / 'documents' / file_name
print(full_path)  # 输出: /home/user/documents/file.txt

获取路径信息

#获取文件名
print(path.name)  # 输出: file.txt

#获取文件扩展名
print(path.suffix)  # 输出: .txt

# 获取父路径
print(path.parent)  # 输出: /home/user/documents

# 获取绝对路径
print(path.absolute())  # 输出: /home/user/documents/file.txt

检查路径状态

# 检查路径是否存在
print(path.exists())  # 输出: True 或 False

# 检查是否是文件
print(path.is_file())  # 输出: True 或 False

# 检查是否是目录
print(path.is_dir())  # 输出: True 或 False

文件和目录操作

# 创建目录
new_dir = Path('/home/user/new_folder')
new_dir.mkdir()  # 创建目录

# 删除文件或目录
path.unlink()  # 删除文件
new_dir.rmdir()  # 删除空目录

# 读取列出文件夹目录内容
for item in new_dir.iterdir():
    print(item)  # 输出目录中的文件和子目录

文件夹下查找文件

我们可以使用rgrob()方法列出文件夹和子文件夹中的所有 Python文件(. py)，该方法递归搜索子文件夹。

from pathlib import Path

p = Path(r'D:\Anaconda')

files = p.rglob('*.py')
for f in files:
    print(f)

输出
D:\Anaconda\cwp.py
D:\Anaconda\Lib\abc.py
D:\Anaconda\Lib\aifc.py
D:\Anaconda\Lib\antigravity.py

读写文件

# 读取文件内容
content = path.read_text()  # 读取文本文件内容
print(content)

# 写入文件内容
path.write_text('Hello, pathlib!')  # 写入文本内容

应用场景

pathlib模块在Python开发中非常实用，尤其是在涉及文件系统操作的场景中。以下是一些常见的应用场景，Python 开发者可以在这些场景中使用pathlib模块来简化代码并提高开发效率。

文件和目录管理

场景描述：
• 创建、删除、移动文件和目录。
• 遍历目录结构，查找特定文件或子目录。
• 检查文件或目录是否存在。

from pathlib import Path

# 创建目录
output_dir = Path("output")
output_dir.mkdir(exist_ok=True)  # 如果目录已存在，不会报错

# 遍历目录
for file in output_dir.iterdir():
    if file.is_file():
        print(f"Found file: {file.name}")

# 删除文件
(file := output_dir / "example.txt").unlink()

# 删除目录
output_dir.rmdir()  # 只能删除空目录

数据处理和分析

场景描述：
• 在数据科学项目中，经常需要加载、处理和保存数据文件（如 CSV、JSON、Excel 等）。
• 自动化数据文件的读取和存储路径。

from pathlib import Path
import pandas as pd

# 数据文件路径
data_dir = Path("data")
input_file = data_dir / "input.csv"
output_file = data_dir / "output.csv"

# 读取数据
df = pd.read_csv(input_file)

# 处理数据
df['new_column'] = df['existing_column'] * 2

# 保存数据
df.to_csv(output_file, index=False)

日志文件管理

场景描述：
• 创建日志文件目录。
• 按日期或模块组织日志文件。
• 检查日志文件是否存在，或者清理旧的日志文件。

from pathlib import Path
from datetime import datetime

# 日志目录
log_dir = Path("logs")
log_dir.mkdir(exist_ok=True)

# 创建日志文件
log_file = log_dir / f"log_{datetime.now().strftime('%Y%m%d')}.txt"
log_file.touch()

# 写入日志
log_file.write_text("This is a log message.\n")

自动化脚本

场景描述：
• 编写自动化脚本时，需要处理文件路径、查找特定文件、复制或移动文件等。
• 自动化任务的输入和输出路径管理。

from pathlib import Path
import shutil

# 源目录和目标目录
source_dir = Path("source")
target_dir = Path("target")
target_dir.mkdir(exist_ok=True)

# 复制文件
for file in source_dir.glob("*.txt"):
    shutil.copy(file, target_dir / file.name)

项目构建和部署

场景描述：
• 在项目构建过程中，需要组织文件结构，将资源文件复制到目标目录。
• 在部署时，检查配置文件是否存在，或者创建默认配置文件。

from pathlib import Path

# 项目目录结构
project_dir = Path("my_project")
project_dir.mkdir(exist_ok=True)

# 创建子目录
src_dir = project_dir / "src"
src_dir.mkdir(exist_ok=True)

# 创建默认配置文件
config_file = project_dir / "config.json"
if not config_file.exists():
    config_file.write_text('{"key": "value"}')

测试和开发工具

场景描述：
• 在测试中，需要创建临时文件或目录来模拟真实环境。
• 在开发工具中，动态生成代码文件或资源文件。

from pathlib import Path
import tempfile

# 创建临时目录
with tempfile.TemporaryDirectory() as temp_dir:
    temp_path = Path(temp_dir)
    temp_file = temp_path / "test_file.txt"
    temp_file.write_text("This is a test file.")
    print(temp_file.read_text())

跨平台开发

场景描述：
• 在跨平台项目中，路径分隔符和文件系统行为可能不同。
• 使用pathlib可以自动处理这些差异，确保代码在不同操作系统上都能正常运行。

from pathlib import Path

# 自动处理路径分隔符
file_path = Path("folder") / "subfolder" / "file.txt"
print(file_path)  # 在 Windows 上输出: folder\subfolder\file.txt
                  # 在 Linux/macOS 上输出: folder/subfolder/file.txt

总结

pathlib模块在处理文件系统路径时提供了极大的便利，尤其是在需要跨平台、自动化或组织文件结构的场景中。它不仅简化了路径操作，还提高了代码的可读性和可维护性。无论是数据处理、自动化脚本，还是项目构建，pathlib都是一个非常实用的工具。

虽然pathlib是处理文件路径的首选工具，但在某些特定场景下，其他库可能更适合：

• os.path ：适合简单的路径操作或维护旧代码。
• PyFilesystem或fs ：适合需要操作多种存储系统。
• glob ：适合简单的文件搜索。
• shutil ：适合文件内容操作。
• pathy ：适合需要支持云存储的路径操作。