Skip to content

Commit 992c43f

Browse files
committed
Issue python#22117: Fix rounding in _PyTime_FromSecondsObject()
* Rename _PyTime_FromObject() to _PyTime_FromSecondsObject() * Add _PyTime_AsNanosecondsObject() and _testcapi.pytime_fromsecondsobject() * Add unit tests
1 parent 79644f9 commit 992c43f

5 files changed

Lines changed: 211 additions & 86 deletions

File tree

‎Include/pytime.h‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,15 +121,18 @@ typedef PY_INT64_T _PyTime_t;
121121

122122
/* Convert a Python float or int to a timetamp.
123123
Raise an exception and return -1 on error, return 0 on success. */
124-
PyAPI_FUNC(int) _PyTime_FromObject(_PyTime_t *t,
124+
PyAPI_FUNC(int) _PyTime_FromSecondsObject(_PyTime_t *t,
125125
PyObject *obj,
126126
_PyTime_round_t round);
127127

128128
/* Convert timestamp to a number of milliseconds (10^-3 seconds). */
129-
PyAPI_FUNC(_PyTime_t)
130-
_PyTime_AsMilliseconds(_PyTime_t t,
129+
PyAPI_FUNC(_PyTime_t) _PyTime_AsMilliseconds(_PyTime_t t,
131130
_PyTime_round_t round);
132131

132+
/* Convert timestamp to a number of nanoseconds (10^-9 seconds) as a Python int
133+
object. */
134+
PyAPI_FUNC(PyObject *) _PyTime_AsNanosecondsObject(_PyTime_t t);
135+
133136
/* Convert a timestamp to a timeval structure. */
134137
PyAPI_FUNC(int) _PyTime_AsTimeval(_PyTime_t t,
135138
struct timeval *tv,

‎Lib/test/test_time.py‎

Lines changed: 173 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
from test import support
2-
import time
3-
import unittest
2+
import enum
43
import locale
5-
import sysconfig
6-
import sys
74
import platform
5+
import sys
6+
import sysconfig
7+
import time
8+
import unittest
89
try:
910
import threading
1011
except ImportError:
@@ -14,8 +15,15 @@
1415
SIZEOF_INT = sysconfig.get_config_var('SIZEOF_INT') or 4
1516
TIME_MAXYEAR = (1 << 8 * SIZEOF_INT - 1) - 1
1617
TIME_MINYEAR = -TIME_MAXYEAR - 1
17-
_PyTime_ROUND_DOWN = 0
18-
_PyTime_ROUND_UP = 1
18+
19+
20+
class _PyTime(enum.IntEnum):
21+
# Round towards zero
22+
ROUND_DOWN = 0
23+
# Round away from zero
24+
ROUND_UP = 1
25+
26+
ALL_ROUNDING_METHODS = (_PyTime.ROUND_UP, _PyTime.ROUND_DOWN)
1927

2028

2129
class TimeTestCase(unittest.TestCase):
@@ -596,23 +604,23 @@ def test_time_t(self):
596604
from _testcapi import pytime_object_to_time_t
597605
for obj, time_t, rnd in (
598606
# Round towards zero
599-
(0, 0, _PyTime_ROUND_DOWN),
600-
(-1, -1, _PyTime_ROUND_DOWN),
601-
(-1.0, -1, _PyTime_ROUND_DOWN),
602-
(-1.9, -1, _PyTime_ROUND_DOWN),
603-
(1.0, 1, _PyTime_ROUND_DOWN),
604-
(1.9, 1, _PyTime_ROUND_DOWN),
607+
(0, 0, _PyTime.ROUND_DOWN),
608+
(-1, -1, _PyTime.ROUND_DOWN),
609+
(-1.0, -1, _PyTime.ROUND_DOWN),
610+
(-1.9, -1, _PyTime.ROUND_DOWN),
611+
(1.0, 1, _PyTime.ROUND_DOWN),
612+
(1.9, 1, _PyTime.ROUND_DOWN),
605613
# Round away from zero
606-
(0, 0, _PyTime_ROUND_UP),
607-
(-1, -1, _PyTime_ROUND_UP),
608-
(-1.0, -1, _PyTime_ROUND_UP),
609-
(-1.9, -2, _PyTime_ROUND_UP),
610-
(1.0, 1, _PyTime_ROUND_UP),
611-
(1.9, 2, _PyTime_ROUND_UP),
614+
(0, 0, _PyTime.ROUND_UP),
615+
(-1, -1, _PyTime.ROUND_UP),
616+
(-1.0, -1, _PyTime.ROUND_UP),
617+
(-1.9, -2, _PyTime.ROUND_UP),
618+
(1.0, 1, _PyTime.ROUND_UP),
619+
(1.9, 2, _PyTime.ROUND_UP),
612620
):
613621
self.assertEqual(pytime_object_to_time_t(obj, rnd), time_t)
614622

615-
rnd = _PyTime_ROUND_DOWN
623+
rnd = _PyTime.ROUND_DOWN
616624
for invalid in self.invalid_values:
617625
self.assertRaises(OverflowError,
618626
pytime_object_to_time_t, invalid, rnd)
@@ -622,44 +630,44 @@ def test_timeval(self):
622630
from _testcapi import pytime_object_to_timeval
623631
for obj, timeval, rnd in (
624632
# Round towards zero
625-
(0, (0, 0), _PyTime_ROUND_DOWN),
626-
(-1, (-1, 0), _PyTime_ROUND_DOWN),
627-
(-1.0, (-1, 0), _PyTime_ROUND_DOWN),
628-
(1e-6, (0, 1), _PyTime_ROUND_DOWN),
629-
(1e-7, (0, 0), _PyTime_ROUND_DOWN),
630-
(-1e-6, (-1, 999999), _PyTime_ROUND_DOWN),
631-
(-1e-7, (-1, 999999), _PyTime_ROUND_DOWN),
632-
(-1.2, (-2, 800000), _PyTime_ROUND_DOWN),
633-
(0.9999999, (0, 999999), _PyTime_ROUND_DOWN),
634-
(0.0000041, (0, 4), _PyTime_ROUND_DOWN),
635-
(1.1234560, (1, 123456), _PyTime_ROUND_DOWN),
636-
(1.1234569, (1, 123456), _PyTime_ROUND_DOWN),
637-
(-0.0000040, (-1, 999996), _PyTime_ROUND_DOWN),
638-
(-0.0000041, (-1, 999995), _PyTime_ROUND_DOWN),
639-
(-1.1234560, (-2, 876544), _PyTime_ROUND_DOWN),
640-
(-1.1234561, (-2, 876543), _PyTime_ROUND_DOWN),
633+
(0, (0, 0), _PyTime.ROUND_DOWN),
634+
(-1, (-1, 0), _PyTime.ROUND_DOWN),
635+
(-1.0, (-1, 0), _PyTime.ROUND_DOWN),
636+
(1e-6, (0, 1), _PyTime.ROUND_DOWN),
637+
(1e-7, (0, 0), _PyTime.ROUND_DOWN),
638+
(-1e-6, (-1, 999999), _PyTime.ROUND_DOWN),
639+
(-1e-7, (-1, 999999), _PyTime.ROUND_DOWN),
640+
(-1.2, (-2, 800000), _PyTime.ROUND_DOWN),
641+
(0.9999999, (0, 999999), _PyTime.ROUND_DOWN),
642+
(0.0000041, (0, 4), _PyTime.ROUND_DOWN),
643+
(1.1234560, (1, 123456), _PyTime.ROUND_DOWN),
644+
(1.1234569, (1, 123456), _PyTime.ROUND_DOWN),
645+
(-0.0000040, (-1, 999996), _PyTime.ROUND_DOWN),
646+
(-0.0000041, (-1, 999995), _PyTime.ROUND_DOWN),
647+
(-1.1234560, (-2, 876544), _PyTime.ROUND_DOWN),
648+
(-1.1234561, (-2, 876543), _PyTime.ROUND_DOWN),
641649
# Round away from zero
642-
(0, (0, 0), _PyTime_ROUND_UP),
643-
(-1, (-1, 0), _PyTime_ROUND_UP),
644-
(-1.0, (-1, 0), _PyTime_ROUND_UP),
645-
(1e-6, (0, 1), _PyTime_ROUND_UP),
646-
(1e-7, (0, 1), _PyTime_ROUND_UP),
647-
(-1e-6, (-1, 999999), _PyTime_ROUND_UP),
648-
(-1e-7, (-1, 999999), _PyTime_ROUND_UP),
649-
(-1.2, (-2, 800000), _PyTime_ROUND_UP),
650-
(0.9999999, (1, 0), _PyTime_ROUND_UP),
651-
(0.0000041, (0, 5), _PyTime_ROUND_UP),
652-
(1.1234560, (1, 123457), _PyTime_ROUND_UP),
653-
(1.1234569, (1, 123457), _PyTime_ROUND_UP),
654-
(-0.0000040, (-1, 999996), _PyTime_ROUND_UP),
655-
(-0.0000041, (-1, 999995), _PyTime_ROUND_UP),
656-
(-1.1234560, (-2, 876544), _PyTime_ROUND_UP),
657-
(-1.1234561, (-2, 876543), _PyTime_ROUND_UP),
650+
(0, (0, 0), _PyTime.ROUND_UP),
651+
(-1, (-1, 0), _PyTime.ROUND_UP),
652+
(-1.0, (-1, 0), _PyTime.ROUND_UP),
653+
(1e-6, (0, 1), _PyTime.ROUND_UP),
654+
(1e-7, (0, 1), _PyTime.ROUND_UP),
655+
(-1e-6, (-1, 999999), _PyTime.ROUND_UP),
656+
(-1e-7, (-1, 999999), _PyTime.ROUND_UP),
657+
(-1.2, (-2, 800000), _PyTime.ROUND_UP),
658+
(0.9999999, (1, 0), _PyTime.ROUND_UP),
659+
(0.0000041, (0, 5), _PyTime.ROUND_UP),
660+
(1.1234560, (1, 123457), _PyTime.ROUND_UP),
661+
(1.1234569, (1, 123457), _PyTime.ROUND_UP),
662+
(-0.0000040, (-1, 999996), _PyTime.ROUND_UP),
663+
(-0.0000041, (-1, 999995), _PyTime.ROUND_UP),
664+
(-1.1234560, (-2, 876544), _PyTime.ROUND_UP),
665+
(-1.1234561, (-2, 876543), _PyTime.ROUND_UP),
658666
):
659667
with self.subTest(obj=obj, round=rnd, timeval=timeval):
660668
self.assertEqual(pytime_object_to_timeval(obj, rnd), timeval)
661669

662-
rnd = _PyTime_ROUND_DOWN
670+
rnd = _PyTime.ROUND_DOWN
663671
for invalid in self.invalid_values:
664672
self.assertRaises(OverflowError,
665673
pytime_object_to_timeval, invalid, rnd)
@@ -669,38 +677,38 @@ def test_timespec(self):
669677
from _testcapi import pytime_object_to_timespec
670678
for obj, timespec, rnd in (
671679
# Round towards zero
672-
(0, (0, 0), _PyTime_ROUND_DOWN),
673-
(-1, (-1, 0), _PyTime_ROUND_DOWN),
674-
(-1.0, (-1, 0), _PyTime_ROUND_DOWN),
675-
(1e-9, (0, 1), _PyTime_ROUND_DOWN),
676-
(1e-10, (0, 0), _PyTime_ROUND_DOWN),
677-
(-1e-9, (-1, 999999999), _PyTime_ROUND_DOWN),
678-
(-1e-10, (-1, 999999999), _PyTime_ROUND_DOWN),
679-
(-1.2, (-2, 800000000), _PyTime_ROUND_DOWN),
680-
(0.9999999999, (0, 999999999), _PyTime_ROUND_DOWN),
681-
(1.1234567890, (1, 123456789), _PyTime_ROUND_DOWN),
682-
(1.1234567899, (1, 123456789), _PyTime_ROUND_DOWN),
683-
(-1.1234567890, (-2, 876543211), _PyTime_ROUND_DOWN),
684-
(-1.1234567891, (-2, 876543210), _PyTime_ROUND_DOWN),
680+
(0, (0, 0), _PyTime.ROUND_DOWN),
681+
(-1, (-1, 0), _PyTime.ROUND_DOWN),
682+
(-1.0, (-1, 0), _PyTime.ROUND_DOWN),
683+
(1e-9, (0, 1), _PyTime.ROUND_DOWN),
684+
(1e-10, (0, 0), _PyTime.ROUND_DOWN),
685+
(-1e-9, (-1, 999999999), _PyTime.ROUND_DOWN),
686+
(-1e-10, (-1, 999999999), _PyTime.ROUND_DOWN),
687+
(-1.2, (-2, 800000000), _PyTime.ROUND_DOWN),
688+
(0.9999999999, (0, 999999999), _PyTime.ROUND_DOWN),
689+
(1.1234567890, (1, 123456789), _PyTime.ROUND_DOWN),
690+
(1.1234567899, (1, 123456789), _PyTime.ROUND_DOWN),
691+
(-1.1234567890, (-2, 876543211), _PyTime.ROUND_DOWN),
692+
(-1.1234567891, (-2, 876543210), _PyTime.ROUND_DOWN),
685693
# Round away from zero
686-
(0, (0, 0), _PyTime_ROUND_UP),
687-
(-1, (-1, 0), _PyTime_ROUND_UP),
688-
(-1.0, (-1, 0), _PyTime_ROUND_UP),
689-
(1e-9, (0, 1), _PyTime_ROUND_UP),
690-
(1e-10, (0, 1), _PyTime_ROUND_UP),
691-
(-1e-9, (-1, 999999999), _PyTime_ROUND_UP),
692-
(-1e-10, (-1, 999999999), _PyTime_ROUND_UP),
693-
(-1.2, (-2, 800000000), _PyTime_ROUND_UP),
694-
(0.9999999999, (1, 0), _PyTime_ROUND_UP),
695-
(1.1234567890, (1, 123456790), _PyTime_ROUND_UP),
696-
(1.1234567899, (1, 123456790), _PyTime_ROUND_UP),
697-
(-1.1234567890, (-2, 876543211), _PyTime_ROUND_UP),
698-
(-1.1234567891, (-2, 876543210), _PyTime_ROUND_UP),
694+
(0, (0, 0), _PyTime.ROUND_UP),
695+
(-1, (-1, 0), _PyTime.ROUND_UP),
696+
(-1.0, (-1, 0), _PyTime.ROUND_UP),
697+
(1e-9, (0, 1), _PyTime.ROUND_UP),
698+
(1e-10, (0, 1), _PyTime.ROUND_UP),
699+
(-1e-9, (-1, 999999999), _PyTime.ROUND_UP),
700+
(-1e-10, (-1, 999999999), _PyTime.ROUND_UP),
701+
(-1.2, (-2, 800000000), _PyTime.ROUND_UP),
702+
(0.9999999999, (1, 0), _PyTime.ROUND_UP),
703+
(1.1234567890, (1, 123456790), _PyTime.ROUND_UP),
704+
(1.1234567899, (1, 123456790), _PyTime.ROUND_UP),
705+
(-1.1234567890, (-2, 876543211), _PyTime.ROUND_UP),
706+
(-1.1234567891, (-2, 876543210), _PyTime.ROUND_UP),
699707
):
700708
with self.subTest(obj=obj, round=rnd, timespec=timespec):
701709
self.assertEqual(pytime_object_to_timespec(obj, rnd), timespec)
702710

703-
rnd = _PyTime_ROUND_DOWN
711+
rnd = _PyTime.ROUND_DOWN
704712
for invalid in self.invalid_values:
705713
self.assertRaises(OverflowError,
706714
pytime_object_to_timespec, invalid, rnd)
@@ -759,5 +767,91 @@ def test_short_times(self):
759767
self.assertIs(lt.tm_zone, None)
760768

761769

770+
@support.cpython_only
771+
class TestPyTime_t(unittest.TestCase):
772+
def test_FromSecondsObject(self):
773+
from _testcapi import pytime_fromsecondsobject
774+
SEC_TO_NS = 10 ** 9
775+
MAX_SEC = 2 ** 63 // 10 ** 9
776+
777+
# Conversion giving the same result for all rounding methods
778+
for rnd in ALL_ROUNDING_METHODS:
779+
for obj, ts in (
780+
# integers
781+
(0, 0),
782+
(1, SEC_TO_NS),
783+
(-3, -3 * SEC_TO_NS),
784+
785+
# float: subseconds
786+
(0.0, 0),
787+
(1e-9, 1),
788+
(1e-6, 10 ** 3),
789+
(1e-3, 10 ** 6),
790+
791+
# float: seconds
792+
(2.0, 2 * SEC_TO_NS),
793+
(123.0, 123 * SEC_TO_NS),
794+
(-7.0, -7 * SEC_TO_NS),
795+
796+
# nanosecond are kept for value <= 2^23 seconds
797+
(2**22 - 1e-9, 4194303999999999),
798+
(2**22, 4194304000000000),
799+
(2**22 + 1e-9, 4194304000000001),
800+
(2**23 - 1e-9, 8388607999999999),
801+
(2**23, 8388608000000000),
802+
803+
# start loosing precision for value > 2^23 seconds
804+
(2**23 + 1e-9, 8388608000000002),
805+
806+
# nanoseconds are lost for value > 2^23 seconds
807+
(2**24 - 1e-9, 16777215999999998),
808+
(2**24, 16777216000000000),
809+
(2**24 + 1e-9, 16777216000000000),
810+
(2**25 - 1e-9, 33554432000000000),
811+
(2**25 , 33554432000000000),
812+
(2**25 + 1e-9, 33554432000000000),
813+
814+
# close to 2^63 nanoseconds
815+
(9223372036, 9223372036 * SEC_TO_NS),
816+
(9223372036.0, 9223372036 * SEC_TO_NS),
817+
(-9223372036, -9223372036 * SEC_TO_NS),
818+
(-9223372036.0, -9223372036 * SEC_TO_NS),
819+
):
820+
with self.subTest(obj=obj, round=rnd, timestamp=ts):
821+
self.assertEqual(pytime_fromsecondsobject(obj, rnd), ts)
822+
823+
with self.subTest(round=rnd):
824+
with self.assertRaises(OverflowError):
825+
pytime_fromsecondsobject(9223372037, rnd)
826+
pytime_fromsecondsobject(9223372037.0, rnd)
827+
pytime_fromsecondsobject(-9223372037, rnd)
828+
pytime_fromsecondsobject(-9223372037.0, rnd)
829+
830+
# Conversion giving different results depending on the rounding method
831+
UP = _PyTime.ROUND_UP
832+
DOWN = _PyTime.ROUND_DOWN
833+
for obj, ts, rnd in (
834+
# close to zero
835+
( 1e-10, 1, UP),
836+
( 1e-10, 0, DOWN),
837+
(-1e-10, 0, DOWN),
838+
(-1e-10, -1, UP),
839+
840+
# test rounding of the last nanosecond
841+
( 1.1234567899, 1123456790, UP),
842+
( 1.1234567899, 1123456789, DOWN),
843+
(-1.1234567899, -1123456789, DOWN),
844+
(-1.1234567899, -1123456790, UP),
845+
846+
# close to 1 second
847+
( 0.9999999999, 1000000000, UP),
848+
( 0.9999999999, 999999999, DOWN),
849+
(-0.9999999999, -999999999, DOWN),
850+
(-0.9999999999, -1000000000, UP),
851+
):
852+
with self.subTest(obj=obj, round=rnd, timestamp=ts):
853+
self.assertEqual(pytime_fromsecondsobject(obj, rnd), ts)
854+
855+
762856
if __name__ == "__main__":
763857
unittest.main()

‎Modules/_testcapimodule.c‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3378,6 +3378,22 @@ return_result_with_error(PyObject *self, PyObject *args)
33783378
Py_RETURN_NONE;
33793379
}
33803380

3381+
static PyObject *
3382+
test_pytime_fromsecondsobject(PyObject *self, PyObject *args)
3383+
{
3384+
PyObject *obj;
3385+
int round;
3386+
_PyTime_t ts;
3387+
3388+
if (!PyArg_ParseTuple(args, "Oi", &obj, &round))
3389+
return NULL;
3390+
if (check_time_rounding(round) < 0)
3391+
return NULL;
3392+
if (_PyTime_FromSecondsObject(&ts, obj, round) == -1)
3393+
return NULL;
3394+
return _PyTime_AsNanosecondsObject(ts);
3395+
}
3396+
33813397

33823398
static PyMethodDef TestMethods[] = {
33833399
{"raise_exception", raise_exception, METH_VARARGS},
@@ -3541,6 +3557,7 @@ static PyMethodDef TestMethods[] = {
35413557
return_null_without_error, METH_NOARGS},
35423558
{"return_result_with_error",
35433559
return_result_with_error, METH_NOARGS},
3560+
{"pytime_fromsecondsobject", test_pytime_fromsecondsobject, METH_VARARGS},
35443561
{NULL, NULL} /* sentinel */
35453562
};
35463563

‎Modules/timemodule.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ static PyObject *
221221
time_sleep(PyObject *self, PyObject *obj)
222222
{
223223
_PyTime_t secs;
224-
if (_PyTime_FromObject(&secs, obj, _PyTime_ROUND_UP))
224+
if (_PyTime_FromSecondsObject(&secs, obj, _PyTime_ROUND_UP))
225225
return NULL;
226226
if (secs < 0) {
227227
PyErr_SetString(PyExc_ValueError,

0 commit comments

Comments
 (0)