Skip to content

Commit b35b36e

Browse files
bpo-31327: Update time documentation to reflect possible errors (GH-31460)
As per the comments, this mirrors the [datetime documentation](https://docs.python.org/3/library/datetime.htmlGH-datetime.datetime.fromtimestamp). ``` >>> import time >>> time.localtime(999999999999999999999) Traceback (most recent call last): File "<stdin>", line 1, in <module> OverflowError: timestamp out of range for platform time_t >>> time.localtime(-3600) Traceback (most recent call last): File "<stdin>", line 1, in <module> OSError: [Errno 22] Invalid argument ``` (cherry picked from commit c83fc9c) Co-authored-by: slateny <[email protected]>
1 parent 3bc8019 commit b35b36e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Doc/library/time.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,12 @@ Functions
259259
:const:`None`, the current time as returned by :func:`.time` is used. The dst
260260
flag is set to ``1`` when DST applies to the given time.
261261

262+
:func:`localtime` may raise :exc:`OverflowError`, if the timestamp is
263+
outside the range of values supported by the platform C :c:func:`localtime`
264+
or :c:func:`gmtime` functions, and :exc:`OSError` on :c:func:`localtime` or
265+
:c:func:`gmtime` failure. It's common for this to be restricted to years
266+
between 1970 and 2038.
267+
262268

263269
.. function:: mktime(t)
264270

0 commit comments

Comments
 (0)