pyufunc.get_time_diff_in_unit#

pyufunc.get_time_diff_in_unit(start_time, end_time, unit='seconds')#

Calculate the time difference between two datetime objects/strings.

Parameters:

  • start_time (Union[datetime.datetime, str]) – datetime object or string

  • end_time (Union[datetime.datetime, str]) – datetime object or string

  • unit (str) –

    time unit to be calculated. Defaults to “seconds”.

    Candidates: [“seconds”, “minutes”, “hours”, “days”, “second”, “minute”,

    ”hour”, “day”, “week”, “weeks”, “month”, “months”, “year”, “years”]

Returns:

the time difference in the desired unit

Return type:

float

Example

>>> from pyufunc import get_time_diff_in_unit
>>> get_time_diff_in_unit("2024-02-06 11:11:11", "2024-02-07 11:11:11", "days")
Time difference between 2024-02-06 11:11:11 and 2024-02-07 11:11:11: 1.0 days
1.0 days

>>> get_time_diff_in_unit("2024-02-06 11:11:11", "2024-02-07 11:11:11", "hours")
Time difference between 2024-02-06 11:11:11 and 2024-02-07 11:11:11: 24.0 hours
24.0 hours

>>> get_time_diff_in_unit("2024-02-06 11:11:11", "2024-02-07 11:11:11", "minutes")
Time difference between 2024-02-06 11:11:11 and 2024-02-07 11:11:11: 1440.0 minutes
1440.0 minutes

>>> get_time_diff_in_unit("2024-02-06 11:11:11", "2024-02-07 11:11:11", "seconds")
Time difference between 2024-02-06 11:11:11 and 2024-02-07 11:11:11: 86400.0 seconds
86400.0 seconds

>>> get_time_diff_in_unit(datetime.now(), datetime.now() - datetime.timedelta(60), "day")
Time difference between 2024-02-06 11:11:11 and 2023-12-08 11:11:11: 60.0 days
60.0 days