mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-04 02:48:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Fixed #22598 -- Allowed make_aware() to work with ambiguous datetime

Browse source
This commit is contained in:
Josh Smeaton 2015-03-31 16:58:37 +11:00 • committed by Tim Graham
parent 269a5dbdd3
commit 143255c8bb
4 changed files with 59 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/ref/utils.txt
View file

@ -947,20 +947,37 @@ appropriate entities.
Returns ``True`` if ``value`` is naive, ``False`` if it is aware. This
function assumes that ``value`` is a :class:`~datetime.datetime`.
.. function:: make_aware(value, timezone=None)
.. function:: make_aware(value, timezone=None, is_dst=None)
Returns an aware :class:`~datetime.datetime` that represents the same
point in time as ``value`` in ``timezone``, ``value`` being a naive
:class:`~datetime.datetime`. If ``timezone`` is set to ``None``, it
defaults to the :ref:`current time zone <default-current-time-zone>`.
This function can raise an exception if ``value`` doesn't exist or is
ambiguous because of DST transitions.
When pytz_ is installed, the exception ``pytz.AmbiguousTimeError``
will be raised if you try to make ``value`` aware during a DST transition
where the same time occurs twice (when reverting from DST). Setting
``is_dst`` to ``True`` or ``False`` will avoid the exception by choosing if
the time is pre-transition or post-transition respectively.
When pytz_ is installed, the exception ``pytz.NonExistentTimeError``
will be raised if you try to make ``value`` aware during a DST transition
such that the time never occurred (when entering into DST). Setting
``is_dst`` to ``True`` or ``False`` will avoid the exception by moving the
hour backwards or forwards by 1 respectively. For example, ``is_dst=True``
would change a non-existent time of 2:30 to 1:30 and ``is_dst=False``
would change the time to 3:30.
``is_dst`` has no effect when ``pytz`` is not installed.
.. versionchanged:: 1.8
In older versions of Django, ``timezone`` was a required argument.
.. versionchanged:: 1.9
The ``is_dst`` argument was added.
.. function:: make_naive(value, timezone=None)
Returns an naive :class:`~datetime.datetime` that represents in