封装 Python 时间处理库：创建您自己的 TimeUtil 类

简介

在日常的Python开发中，处理时间和日期的需求是非常常见的。尽管Python内置了 datetime 和 time 模块，但在某些情况下，它们可能不够直观和易用。为了解决这个问题，我们封装一个名为 TimeUtil 的时间处理类，通过提供一组易于使用的方法来简化常见的时间相关任务。在本博客文章中，我们将介绍 TimeUtil 的功能，并通过一些实际示例说明如何在各种场景中使用它。

功能

1. 时间的加减：TimeUtil 支持在 datetime 对象的基础上增加或减少年份、月份、天数、小时、分钟和秒。
2. 计算昨天、明天、一周后和一个月后的日期。
3. 将字符串转换为 datetime 对象。
4. 将 datetime 对象转换为字符串。
5. 将时间戳转换为字符串格式的时间。
6. 将字符串格式的时间转换为时间戳。
7. 将时间戳转换为 datetime 对象。
8. 两时间（datetime对象）之差
9. 计算工作日数

代码封装

#!/usr/bin/python3
# -*- coding: utf-8 -*-
# @Author: Hui
# @Desc: { 时间工具类模块 }
# @Date: 2022/11/26 16:08

import time
from datetime import datetime
from typing import Union

from dateutil.relativedelta import relativedelta

from enums import TimeFormatEnum


class TimeUtil(object):
    """时间工具类"""

    def __init__(self, datetime_obj: datetime = None, format_str: str = TimeFormatEnum.DateTime.value):
        """
        时间工具类初始化
        Args:
            datetime_obj: 待处理的datetime对象，不传时默认取当前时间
            format_str: 时间格式化字符串
        """
        self.datetime_obj = datetime_obj or datetime.now()
        self.format_str = format_str

    @property
    def yesterday(self) -> datetime:
        """获取昨天的日期"""
        return self.sub_time(days=1)

    @property
    def tomorrow(self) -> datetime:
        """获取明天的日期"""
        return self.add_time(days=1)

    @property
    def week_later(self) -> datetime:
        """获取一周后的日期"""
        return self.add_time(days=7)

    @property
    def month_later(self) -> datetime:
        """获取一个月后的日期"""
        return self.add_time(months=1)

    def add_time(self, years=0, months=0, days=0, hours=0, minutes=0, seconds=0, **kwargs) -> datetime:
        """增加指定时间"""
        return self.datetime_obj + relativedelta(
            years=years, months=months, days=days, hours=hours, minutes=minutes, seconds=seconds, **kwargs
        )

    def sub_time(self, years=0, months=0, days=0, hours=0, minutes=0, seconds=0, **kwargs) -> datetime:
        """减去指定时间"""
        return self.datetime_obj - relativedelta(
            years=years, months=months, days=days, hours=hours, minutes=minutes, seconds=seconds, **kwargs
        )

    def str_to_datetime(self, date_str: str, format_str: str = None) -> datetime:
        """将时间字符串转换为 datetime 对象"""
        format_str = format_str or self.format_str
        return datetime.strptime(date_str, format_str)

    def datetime_to_str(self, format_str: str = None) -> str:
        """将 datetime 对象转换为时间字符串"""
        format_str = format_str or self.format_str
        return self.datetime_obj.strftime(format_str)

    def timestamp_to_str(self, timestamp: float, format_str: str = None) -> str:
        """将时间戳转换为时间字符串"""
        format_str = format_str or self.format_str
        return datetime.fromtimestamp(timestamp).strftime(format_str)

    def str_to_timestamp(self, time_str: str, format_str: str = None) -> float:
        """将时间字符串转换为时间戳"""
        format_str = format_str or self.format_str
        return time.mktime(time.strptime(time_str, format_str))

    @staticmethod
    def timestamp_to_datetime(timestamp: float) -> datetime:
        """将时间戳转换为 datetime 对象"""
        return datetime.fromtimestamp(timestamp)

    @property
    def timestamp(self) -> float:
        """获取 datetime 对象的时间戳"""
        return self.datetime_obj.timestamp()
  
    def difference_in_detail(self, datetime_obj: datetime):
        """
        计算两个日期之间的差值详情
        Args:
            datetime_obj: 时间对象

        Returns: DateDiff
        """
        delta = relativedelta(self.datetime_obj, datetime_obj)

        return DateDiff(
            years=abs(delta.years),
            months=abs(delta.months),
            days=abs(delta.days),
            hours=abs(delta.hours),
            minutes=abs(delta.minutes),
            seconds=abs(delta.seconds),
        )


    def count_weekdays_between(self, datetime_obj: datetime, include_end_date: bool = True) -> int:
        """计算两个日期之间的工作日数量

        Args:
            datetime_obj: datetime 对象
            include_end_date: 是否包含结束日期（默认为 True）

        Returns:
            两个日期之间的工作日数量
        """
        # 确保 start_date 是较小的日期，end_date 是较大的日期
        start_date = min(self.datetime_obj, datetime_obj)
        end_date = max(self.datetime_obj, datetime_obj)

        # 如果不包含结束日期，将 end_date 减去一天
        if not include_end_date:
            end_date = end_date - relativedelta(days=1)

        # 计算两个日期之间的天数
        days_between = abs((end_date - start_date).days)

        # 计算完整周数，每周有5个工作日
        weeks_between = days_between // 7
        weekdays = weeks_between * 5

        # 计算剩余的天数
        remaining_days = days_between % 7
        # 遍历剩余的天数，检查每天是否为工作日，如果是，则累加工作日数量
        for day_offset in range(remaining_days + 1):
            if (start_date + relativedelta(days=day_offset)).weekday() < 5:
                weekdays += 1

        return weekdays

示例Demo：

以下是使用 TimeUtil 库的一些示例：

#!/usr/bin/python3
# -*- coding: utf-8 -*-
# @Author: Hui
# @Desc: { 时间工具类案例 }
# @Date: 2023/04/30 21:08
import time
from datetime import datetime

from utils.time import TimeUtil


# 创建一个TimeUtil实例，默认使用当前时间
time_util = TimeUtil()

print("昨天的日期:", time_util.yesterday)

print("明天的日期:", time_util.tomorrow)

print("一周后的日期:", time_util.week_later)

print("一个月后的日期:", time_util.month_later)

>>>out
昨天的日期: 2023-04-29 21:10:56.642787
明天的日期: 2023-05-01 21:10:56.642787
一周后的日期: 2023-05-07 21:10:56.642787
一个月后的日期: 2023-05-30 21:10:56.642787

这里使用 property 装饰器让一些获取最近日期的方法使用起来变成获取属性值一样，使用起来变得更简洁。

# 从现在开始增加10天
print("10天后的日期:", time_util.add_time(days=10))

# 从现在开始减少5天
print("5天前的日期:", time_util.sub_time(days=5))

>>>out
10天后的日期: 2023-05-10 21:28:35.587173
5天前的日期: 2023-04-25 21:28:35.587173

add_time、sub_time 则是具体实现时间（datetime对象）加减运算的方法，主要就是通过 python-dateutil 库的 relativedelta 来封装，相比内置的 timedelta 来说可以更精准的计算年、月之差。

# 将日期字符串转换为datetime对象
date_str = "2023-05-01 12:00:00"
print("字符串转换为datetime对象:", time_util.str_to_datetime(date_str))

# 将datetime对象转换为日期字符串
print("datetime对象转换为字符串:", time_util.datetime_to_str())

# 将时间戳转换为时间字符串
timestamp = time.time()
print("时间戳转换为时间字符串:", time_util.timestamp_to_str(timestamp))

# 将时间字符串转换为时间戳
time_str = "2023-05-01 12:00:00"
print("时间字符串转换为时间戳:", time_util.str_to_timestamp(time_str))

# 将时间戳转换为datetime对象
print("时间戳转换为datetime对象:", time_util.timestamp_to_datetime(timestamp))

# 获取当前时间的时间戳
print("当前时间的时间戳:", time_util.timestamp)

>>>out
字符串转换为datetime对象: 2023-05-01 12:00:00
datetime对象转换为字符串: 2023-04-30 21:28:35
时间戳转换为时间字符串: 2023-04-30 21:28:35
时间字符串转换为时间戳: 1682913600.0
时间戳转换为datetime对象: 2023-04-30 21:28:35.589926
当前时间的时间戳: 1682861315.587173

这块就是时间最常用的一些时间字符串、时间戳、datetime对象相互转换的方法。

date1 = datetime(2023, 4, 24)  # 2023年4月24日，星期一
date2 = datetime(2023, 5, 1)  # 2023年5月1日，星期一
time_util = TimeUtil(datetime_obj=date1)

# 计算两个日期之间的工作日数量
weekday_count = time_util.count_weekdays_between(date2, include_end_date=True)
print(f"从 {date1} 到 {date2} 之间有 {weekday_count} 个工作日。(包含末尾日期)")

weekday_count = time_util.count_weekdays_between(date2, include_end_date=False)
print(f"从 {date1} 到 {date2} 之间有 {weekday_count} 个工作日。(不包含末尾日期)")

# 获取两个日期之间的差值
date_diff = time_util.difference_in_detail(date2)
print(date_diff)

>>>out
从 2023-04-24 00:00:00 到 2023-05-01 00:00:00 之间有 6 个工作日。(包含末尾日期)
从 2023-04-24 00:00:00 到 2023-05-01 00:00:00 之间有 5 个工作日。(不包含末尾日期)
DateDiff(years=0, months=0, days=7, hours=0, minutes=0, seconds=0)

最后就是根据两时间对象计算计算差值，计算工作日数量等。

感悟

一开始我想把时间工具类像excel工具类一样封装类方法来调用，后面发现好多方法都要共用datetime对象和格式化字符串，于是就封装成了实例对象操作方式，简化了传参方式。

使用实例对象操作的优势：

1. 可以通过对象保存状态，例如在初始化时可以传入一个特定的datetime对象或时间格式字符串，这样在其他方法中可以直接使用。
2. 更容易扩展和添加新功能。如果需要添加新的成员变量或方法，可以直接在类中进行，而无需改变已有的静态方法。

使用类对象操作类方法的优势：

1. 代码更简洁，不需要创建类的实例，可以直接调用静态方法。
2. 在某些情况下，静态方法可能执行速度更快，因为它们不需要创建实例对象。

总之，根据你的需求和编程风格来选择使用实例对象操作还是类对象操作类、静态方法。

虽然通过实例化时间工具类会比类对象直接操作静态方法更浪费内存开销，但让这个工具类单例化，就可以减少创建对象的开销。具体单例化可查看源代码，这里就不细说了。

class TimeUtil(metaclass=SingletonMetaCls):
    """时间工具类"""

    def __init__(self, datetime_obj: datetime = None, format_str: str = TimeFormatEnum.DateTime.value):
        """
        时间工具类初始化
        Args:
            datetime_obj: 待处理的datetime对象，不传时默认取当前时间
            format_str: 时间格式化字符串
        """
        self.datetime_obj = datetime_obj or datetime.now()
        self.format_str = format_str

源代码

HuiDBK/py-tools: 打造 Python 开发常用的工具，让Coding变得更简单 (github.com)