Skip to content

gh-76075: Correct datetime.timestamp documentation #131202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 20, 2025
Merged

gh-76075: Correct datetime.timestamp documentation #131202

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
516fa84
Clean up timestamp docs
StanFromIreland Mar 13, 2025
9b70a5a
Update datetime.rst
StanFromIreland May 20, 2025
e39c97d
Suggestion
StanFromIreland May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions Doc/library/datetime.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1485,13 +1485,6 @@ Instance methods:
instance. The return value is a :class:`float` similar to that
returned by :func:`time.time`.

Naive :class:`.datetime` instances are assumed to represent local
time and this method relies on the platform C :c:func:`mktime`
function to perform the conversion. Since :class:`.datetime`
supports wider range of values than :c:func:`mktime` on many
platforms, this method may raise :exc:`OverflowError` or :exc:`OSError`
for times far in the past or far in the future.

For aware :class:`.datetime` instances, the return value is computed
as::

Expand All @@ -1503,6 +1496,10 @@ Instance methods:
The :meth:`timestamp` method uses the :attr:`.fold` attribute to
disambiguate the times during a repeated interval.

.. versionchanged:: 3.6
This method no longer relies on the platform C :c:func:`mktime`
function to perform conversions.

.. note::

There is no method to obtain the POSIX timestamp directly from a
Expand Down
Loading