codekingpro/portable-devtools

1# -*- coding: utf-8 -*-2"""3This module offers general convenience and utility functions for dealing with4datetimes.5 6.. versionadded:: 2.7.07"""8from __future__ import unicode_literals9 10from datetime import datetime, time11 12 13def today(tzinfo=None):14    """15    Returns a :py:class:`datetime` representing the current day at midnight16 17    :param tzinfo:18        The time zone to attach (also used to determine the current day).19 20    :return:21        A :py:class:`datetime.datetime` object representing the current day22        at midnight.23    """24 25    dt = datetime.now(tzinfo)26    return datetime.combine(dt.date(), time(0, tzinfo=tzinfo))27 28 29def default_tzinfo(dt, tzinfo):30    """31    Sets the ``tzinfo`` parameter on naive datetimes only32 33    This is useful for example when you are provided a datetime that may have34    either an implicit or explicit time zone, such as when parsing a time zone35    string.36 37    .. doctest::38 39        >>> from dateutil.tz import tzoffset40        >>> from dateutil.parser import parse41        >>> from dateutil.utils import default_tzinfo42        >>> dflt_tz = tzoffset("EST", -18000)43        >>> print(default_tzinfo(parse('2014-01-01 12:30 UTC'), dflt_tz))44        2014-01-01 12:30:00+00:0045        >>> print(default_tzinfo(parse('2014-01-01 12:30'), dflt_tz))46        2014-01-01 12:30:00-05:0047 48    :param dt:49        The datetime on which to replace the time zone50 51    :param tzinfo:52        The :py:class:`datetime.tzinfo` subclass instance to assign to53        ``dt`` if (and only if) it is naive.54 55    :return:56        Returns an aware :py:class:`datetime.datetime`.57    """58    if dt.tzinfo is not None:59        return dt60    else:61        return dt.replace(tzinfo=tzinfo)62 63 64def within_delta(dt1, dt2, delta):65    """66    Useful for comparing two datetimes that may have a negligible difference67    to be considered equal.68    """69    delta = abs(delta)70    difference = dt1 - dt271    return -delta <= difference <= delta72