python如何创建公共utils-CFANZ编程社区

Python 如何创建公共 Utils：解决日期格式化问题

在 Python 开发中，常会遇到需要进行日期和时间操作的情况。这时候，我们可能会重复编写相同的代码来处理日期格式，这不仅浪费了时间，同时也影响了代码的可维护性。为了提高代码的复用性和整洁性，我们可以创建一个公共的 utils 模块，以便在多个项目中共享和使用。

1. 什么是公共 Utils？

公共 Utils 是指一组可重用的工具函数，这些函数通常在多个项目中都有需求。通过将这些函数集中到一个模块中，我们可以避免代码重复，提升项目的可维护性。

2. 具体问题描述

在本方案中，我们将面临一个具体问题：将不同格式的日期字符串转换为统一的 ISO 格式（YYYY-MM-DD）。我们希望创建一个公共的 utils 模块，提供一个函数来完成这项任务，并支持多种日期格式的输入。

3. 创建公共 Utils 模块

3.1 文件结构

首先，创建一个新的文件夹，命名为 my_utils，并在其中创建一个 date_utils.py 文件。文件夹结构如下：

my_utils/
    └── date_utils.py

3.2 编写 `date_utils.py`

在 date_utils.py 中，我们将编写一个日期格式化的函数。这个函数将接受一个日期字符串，并尝试将其转换为 ISO 格式。为了实现这一功能，我们可以使用 Python 内置的 datetime 模块。

以下是 date_utils.py 的代码示例：

# my_utils/date_utils.py
import datetime

def format_date(date_string):
    """
    将日期字符串转换为 ISO 格式 (YYYY-MM-DD)
    
    参数:
    date_string (str): 输入的日期字符串
    
    返回:
    str: 转换后的日期字符串 (YYYY-MM-DD) 或者错误信息
    """
    # 定义可能的日期格式
    date_formats = [
        "%Y-%m-%d",  # 2023-01-01
        "%d/%m/%Y",  # 31/12/2023
        "%m-%d-%Y",  # 12-31-2023
        "%B %d, %Y", # December 31, 2023
        "%b %d, %Y"  # Dec 31, 2023
    ]
    
    for date_format in date_formats:
        try:
            # 尝试解析输入的日期字符串
            parsed_date = datetime.datetime.strptime(date_string, date_format)
            # 返回符合 ISO 格式的日期字符串
            return parsed_date.date().isoformat()
        except ValueError:
            continue
    
    # 如果没有匹配的格式，返回错误信息
    return "日期格式不正确。"

3.3 代码解析

在上面的示例中，我们定义了一个名为 format_date 的函数。该函数接收一个日期字符串，尝试使用多种预定义的日期格式将其解析为 datetime 对象。如果解析成功，则返回 ISO 格式的日期字符串。如果所有格式都无法解析该字符串，则返回错误信息。

4. 使用公共 Utils 模块

4.1 创建测试脚本

为了测试我们刚刚创建的公共 Utils 模块，可以在项目根目录下创建一个新的测试脚本 test_date_utils.py，内容如下：

# test_date_utils.py
from my_utils.date_utils import format_date

def test_format_date():
    test_dates = [
        "2023-01-01",
        "31/12/2023",
        "12-31-2023",
        "December 31, 2023",
        "Dec 31, 2023",
        "Invalid Date"
    ]
    
    for date in test_dates:
        formatted_date = format_date(date)
        print(f"输入: {date} => 输出: {formatted_date}")

if __name__ == "__main__":
    test_format_date()

4.2 运行测试脚本

运行 test_date_utils.py 文件，输出应该如下所示：

输入: 2023-01-01 => 输出: 2023-01-01
输入: 31/12/2023 => 输出: 2023-12-31
输入: 12-31-2023 => 输出: 2023-12-31
输入: December 31, 2023 => 输出: 2023-12-31
输入: Dec 31, 2023 => 输出: 2023-12-31
输入: Invalid Date => 输出: 日期格式不正确。