如何封裝Python時(shí)間處理庫創(chuàng)建自己的TimeUtil類

本文講解"怎么封裝Python時(shí)間處理庫創(chuàng)建自己的TimeUtil類"，希望能夠解決相關(guān)問題。

簡(jiǎn)介

在日常的Python開發(fā)中，處理時(shí)間和日期的需求是非常常見的。盡管Python內(nèi)置了 datetime 和 time 模塊，但在某些情況下，它們可能不夠直觀和易用。為了解決這個(gè)問題，我們封裝一個(gè)名為 TimeUtil 的時(shí)間處理類，通過提供一組易于使用的方法來簡(jiǎn)化常見的時(shí)間相關(guān)任務(wù)。

功能

• 時(shí)間的加減：TimeUtil 支持在 datetime 對(duì)象的基礎(chǔ)上增加或減少年份、月份、天數(shù)、小時(shí)、分鐘和秒。

• 計(jì)算昨天、明天、一周后和一個(gè)月后的日期。

• 將字符串轉(zhuǎn)換為 datetime 對(duì)象。

• 將 datetime 對(duì)象轉(zhuǎn)換為字符串。

• 將時(shí)間戳轉(zhuǎn)換為字符串格式的時(shí)間。

• 將字符串格式的時(shí)間轉(zhuǎn)換為時(shí)間戳。

• 將時(shí)間戳轉(zhuǎn)換為 datetime 對(duì)象。

• 兩時(shí)間（datetime對(duì)象）之差

• 計(jì)算工作日數(shù)

代碼封裝

#!/usr/bin/python3
# -*- coding: utf-8 -*-
# @Author: Hui
# @Desc: { 時(shí)間工具類模塊 }
# @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, TimeUnitEnum
class TimeUtil(object):
    """時(shí)間工具類"""
    UNITS_IN_SECONDS = {
        TimeUnitEnum.DAYS: 86400,
        TimeUnitEnum.HOURS: 3600,
        TimeUnitEnum.MINUTES: 60,
        TimeUnitEnum.SECONDS: 1,
    }
    def __init__(self, datetime_obj: datetime = None, format_str: str = TimeFormatEnum.DateTime.value):
        """
        時(shí)間工具類初始化
        Args:
            datetime_obj: 待處理的datetime對(duì)象，不傳時(shí)默認(rèn)取當(dāng)前時(shí)間
            format_str: 時(shí)間格式化字符串
        """
        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:
        """獲取一個(gè)月后的日期"""
        return self.add_time(months=1)
    def add_time(self, years=0, months=0, days=0, hours=0, minutes=0, seconds=0, **kwargs) -> datetime:
        """增加指定時(shí)間"""
        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:
        """減去指定時(shí)間"""
        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:
        """將時(shí)間字符串轉(zhuǎn)換為 datetime 對(duì)象"""
        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 對(duì)象轉(zhuǎn)換為時(shí)間字符串"""
        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:
        """將時(shí)間戳轉(zhuǎn)換為時(shí)間字符串"""
        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:
        """將時(shí)間字符串轉(zhuǎn)換為時(shí)間戳"""
        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:
        """將時(shí)間戳轉(zhuǎn)換為 datetime 對(duì)象"""
        return datetime.fromtimestamp(timestamp)
    @property
    def timestamp(self) -> float:
        """獲取 datetime 對(duì)象的時(shí)間戳"""
        return self.datetime_obj.timestamp()
    def difference(self, other_datetime_obj: datetime, unit: Union[TimeUnitEnum, str] = TimeUnitEnum.DAYS) -> int:
        """
        計(jì)算兩個(gè)日期之間的差值
        Args:
            other_datetime_obj: 另一個(gè) datetime 對(duì)象
            unit: 時(shí)間單位
        Raises:
            ValueError: 如果傳入unit不在枚舉范圍內(nèi)，會(huì)拋出ValueError異常
        Returns:
            兩個(gè)日期之間的差值，以指定的單位表示
        """
        if isinstance(unit, str):
            unit = TimeUnitEnum(unit)
        delta = abs(self.datetime_obj - other_datetime_obj)
        return int(delta.total_seconds() // self.UNITS_IN_SECONDS[unit])
    def difference_in_detail(self, datetime_obj: datetime):
        """
        計(jì)算兩個(gè)日期之間的差值詳情
        Args:
            datetime_obj: 時(shí)間對(duì)象
        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:
        """計(jì)算兩個(gè)日期之間的工作日數(shù)量
        Args:
            datetime_obj: datetime 對(duì)象
            include_end_date: 是否包含結(jié)束日期（默認(rèn)為 True）
        Returns:
            兩個(gè)日期之間的工作日數(shù)量
        """
        # 確保 start_date 是較小的日期，end_date 是較大的日期
        start_date = min(self.datetime_obj, datetime_obj)
        end_date = max(self.datetime_obj, datetime_obj)
        # 如果不包含結(jié)束日期，將 end_date 減去一天
        if not include_end_date:
            end_date = end_date - relativedelta(days=1)
        # 計(jì)算兩個(gè)日期之間的天數(shù)
        days_between = abs((end_date - start_date).days)
        # 計(jì)算完整周數(shù)，每周有5個(gè)工作日
        weeks_between = days_between // 7
        weekdays = weeks_between * 5
        # 計(jì)算剩余的天數(shù)
        remaining_days = days_between % 7
        # 遍歷剩余的天數(shù)，檢查每天是否為工作日，如果是，則累加工作日數(shù)量
        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: { 時(shí)間工具類案例 }
# @Date: 2023/04/30 21:08
import time
from datetime import datetime
from utils.time import TimeUtil
# 創(chuàng)建一個(gè)TimeUtil實(shí)例，默認(rèn)使用當(dāng)前時(shí)間
time_util = TimeUtil()
print("昨天的日期:", time_util.yesterday)
print("明天的日期:", time_util.tomorrow)
print("一周后的日期:", time_util.week_later)
print("一個(gè)月后的日期:", 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
一個(gè)月后的日期: 2023-05-30 21:10:56.642787

這里使用 property 裝飾器讓一些獲取最近日期的方法使用起來變成獲取屬性值一樣，使用起來變得更簡(jiǎn)潔。

# 從現(xiàn)在開始增加10天
print("10天后的日期:", time_util.add_time(days=10))
# 從現(xiàn)在開始減少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 則是具體實(shí)現(xiàn)時(shí)間（datetime對(duì)象）加減運(yùn)算的方法，主要就是通過 python-dateutil 庫的 relativedelta 來封裝，相比內(nèi)置的 timedelta 來說可以更精準(zhǔn)的計(jì)算年、月之差。

# 將日期字符串轉(zhuǎn)換為datetime對(duì)象
date_str = "2023-05-01 12:00:00"
print("字符串轉(zhuǎn)換為datetime對(duì)象:", time_util.str_to_datetime(date_str))
# 將datetime對(duì)象轉(zhuǎn)換為日期字符串
print("datetime對(duì)象轉(zhuǎn)換為字符串:", time_util.datetime_to_str())
# 將時(shí)間戳轉(zhuǎn)換為時(shí)間字符串
timestamp = time.time()
print("時(shí)間戳轉(zhuǎn)換為時(shí)間字符串:", time_util.timestamp_to_str(timestamp))
# 將時(shí)間字符串轉(zhuǎn)換為時(shí)間戳
time_str = "2023-05-01 12:00:00"
print("時(shí)間字符串轉(zhuǎn)換為時(shí)間戳:", time_util.str_to_timestamp(time_str))
# 將時(shí)間戳轉(zhuǎn)換為datetime對(duì)象
print("時(shí)間戳轉(zhuǎn)換為datetime對(duì)象:", time_util.timestamp_to_datetime(timestamp))
# 獲取當(dāng)前時(shí)間的時(shí)間戳
print("當(dāng)前時(shí)間的時(shí)間戳:", time_util.timestamp)
>>>out
字符串轉(zhuǎn)換為datetime對(duì)象: 2023-05-01 12:00:00
datetime對(duì)象轉(zhuǎn)換為字符串: 2023-04-30 21:28:35
時(shí)間戳轉(zhuǎn)換為時(shí)間字符串: 2023-04-30 21:28:35
時(shí)間字符串轉(zhuǎn)換為時(shí)間戳: 1682913600.0
時(shí)間戳轉(zhuǎn)換為datetime對(duì)象: 2023-04-30 21:28:35.589926
當(dāng)前時(shí)間的時(shí)間戳: 1682861315.587173

這塊就是時(shí)間最常用的一些時(shí)間字符串、時(shí)間戳、datetime對(duì)象相互轉(zhuǎn)換的方法。

# 獲取兩個(gè)日期之間的差值
time_util = TimeUtil(datetime_obj=datetime(2023, 4, 24, 10, 30, 0))
datetime_obj = datetime(2023, 4, 29, 10, 30, 0)
delta_days = time_util.difference(datetime_obj, unit="days")
delta_hours = time_util.difference(datetime_obj, unit="hours")
delta_minutes = time_util.difference(datetime_obj, unit=TimeUnitEnum.MINUTES)
delta_seconds = time_util.difference(datetime_obj, unit=TimeUnitEnum.SECONDS)
print(f"兩個(gè)日期之間相差的天數(shù): {delta_days}")
print(f"兩個(gè)日期之間相差的小時(shí)數(shù): {delta_hours}")
print(f"兩個(gè)日期之間相差的分鐘數(shù): {delta_minutes}")
print(f"兩個(gè)日期之間相差的秒數(shù): {delta_seconds}")
>>>out
兩個(gè)日期之間相差的天數(shù): 5
兩個(gè)日期之間相差的小時(shí)數(shù): 120
兩個(gè)日期之間相差的分鐘數(shù): 7200
兩個(gè)日期之間相差的秒數(shù): 432000

date1 = datetime(2023, 4, 24)  # 2023年4月24日，星期一
date2 = datetime(2023, 5, 1)  # 2023年5月1日，星期一
time_util = TimeUtil(datetime_obj=date1)
# 計(jì)算兩個(gè)日期之間的工作日數(shù)量
weekday_count = time_util.count_weekdays_between(date2, include_end_date=True)
print(f"從 {date1} 到 {date2} 之間有 {weekday_count} 個(gè)工作日。(包含末尾日期)")
weekday_count = time_util.count_weekdays_between(date2, include_end_date=False)
print(f"從 {date1} 到 {date2} 之間有 {weekday_count} 個(gè)工作日。(不包含末尾日期)")
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 個(gè)工作日。(包含末尾日期)
從 2023-04-24 00:00:00 到 2023-05-01 00:00:00 之間有 5 個(gè)工作日。(不包含末尾日期)
DateDiff(years=0, months=0, days=7, hours=0, minutes=0, seconds=0)

最后就是根據(jù)兩時(shí)間對(duì)象計(jì)算計(jì)算差值，計(jì)算工作日數(shù)量等。

關(guān)于 "怎么封裝Python時(shí)間處理庫創(chuàng)建自己的TimeUtil類" 就介紹到此。希望多多支持碩編程。