Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1 | /* Time module */ |
| 2 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 3 | #include "Python.h" |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 4 | |
Guido van Rossum | 87ce7bb | 1998-06-09 16:30:31 +0000 | [diff] [blame] | 5 | #include <ctype.h> |
| 6 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 7 | #ifdef HAVE_SYS_TIMES_H |
| 8 | #include <sys/times.h> |
| 9 | #endif |
| 10 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 11 | #ifdef HAVE_SYS_TYPES_H |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 12 | #include <sys/types.h> |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 13 | #endif |
| 14 | |
| 15 | #if defined(HAVE_SYS_RESOURCE_H) |
| 16 | #include <sys/resource.h> |
| 17 | #endif |
Guido van Rossum | 6d946f9 | 1992-08-14 13:49:30 +0000 | [diff] [blame] | 18 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 19 | #ifdef QUICKWIN |
| 20 | #include <io.h> |
| 21 | #endif |
| 22 | |
Guido van Rossum | 7bf22de | 1997-12-02 20:34:19 +0000 | [diff] [blame] | 23 | #if defined(__WATCOMC__) && !defined(__QNX__) |
Guido van Rossum | bceeac8 | 1996-05-23 22:53:47 +0000 | [diff] [blame] | 24 | #include <i86.h> |
| 25 | #else |
Guido van Rossum | cac6c72 | 1996-09-06 13:34:02 +0000 | [diff] [blame] | 26 | #ifdef MS_WINDOWS |
Mark Hammond | 975e392 | 2002-07-16 01:29:19 +0000 | [diff] [blame] | 27 | #define WIN32_LEAN_AND_MEAN |
Guido van Rossum | 258ccd4 | 2001-03-02 06:53:29 +0000 | [diff] [blame] | 28 | #include <windows.h> |
Mark Hammond | 975e392 | 2002-07-16 01:29:19 +0000 | [diff] [blame] | 29 | #include "pythread.h" |
Guido van Rossum | cac6c72 | 1996-09-06 13:34:02 +0000 | [diff] [blame] | 30 | #endif /* MS_WINDOWS */ |
Guido van Rossum | 7bf22de | 1997-12-02 20:34:19 +0000 | [diff] [blame] | 31 | #endif /* !__WATCOMC__ || __QNX__ */ |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 32 | |
| 33 | /* Forward declarations */ |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 34 | static int pysleep(_PyTime_t); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 35 | static PyObject* floattime(_Py_clock_info_t *info); |
| 36 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 37 | static PyObject * |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 38 | time_time(PyObject *self, PyObject *unused) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 39 | { |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 40 | return floattime(NULL); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 41 | } |
| 42 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 43 | PyDoc_STRVAR(time_doc, |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 44 | "time() -> floating point number\n\ |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 45 | \n\ |
| 46 | Return the current time in seconds since the Epoch.\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 47 | Fractions of a second may be present if the system clock provides them."); |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 48 | |
Victor Stinner | 85fdfa8 | 2012-01-27 00:38:48 +0100 | [diff] [blame] | 49 | #if defined(HAVE_CLOCK) |
| 50 | |
| 51 | #ifndef CLOCKS_PER_SEC |
| 52 | #ifdef CLK_TCK |
| 53 | #define CLOCKS_PER_SEC CLK_TCK |
| 54 | #else |
| 55 | #define CLOCKS_PER_SEC 1000000 |
| 56 | #endif |
| 57 | #endif |
| 58 | |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 59 | static PyObject * |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 60 | floatclock(_Py_clock_info_t *info) |
Victor Stinner | 85fdfa8 | 2012-01-27 00:38:48 +0100 | [diff] [blame] | 61 | { |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 62 | clock_t value; |
| 63 | value = clock(); |
| 64 | if (value == (clock_t)-1) { |
Victor Stinner | 85fdfa8 | 2012-01-27 00:38:48 +0100 | [diff] [blame] | 65 | PyErr_SetString(PyExc_RuntimeError, |
| 66 | "the processor time used is not available " |
| 67 | "or its value cannot be represented"); |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 68 | return NULL; |
Victor Stinner | 85fdfa8 | 2012-01-27 00:38:48 +0100 | [diff] [blame] | 69 | } |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 70 | if (info) { |
| 71 | info->implementation = "clock()"; |
| 72 | info->resolution = 1.0 / (double)CLOCKS_PER_SEC; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 73 | info->monotonic = 1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 74 | info->adjustable = 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 75 | } |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 76 | return PyFloat_FromDouble((double)value / CLOCKS_PER_SEC); |
Victor Stinner | 85fdfa8 | 2012-01-27 00:38:48 +0100 | [diff] [blame] | 77 | } |
| 78 | #endif /* HAVE_CLOCK */ |
| 79 | |
Victor Stinner | f427a14 | 2014-10-22 12:33:23 +0200 | [diff] [blame] | 80 | #ifdef MS_WINDOWS |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 81 | #define WIN32_PERF_COUNTER |
Victor Stinner | 9122fdd | 2011-07-04 13:55:40 +0200 | [diff] [blame] | 82 | /* Win32 has better clock replacement; we have our own version, due to Mark |
| 83 | Hammond and Tim Peters */ |
Victor Stinner | 5488449 | 2014-08-29 16:51:33 +0200 | [diff] [blame] | 84 | static PyObject* |
| 85 | win_perf_counter(_Py_clock_info_t *info) |
Guido van Rossum | 3917c22 | 1997-04-02 05:35:28 +0000 | [diff] [blame] | 86 | { |
Victor Stinner | 8b30201 | 2012-02-07 23:29:46 +0100 | [diff] [blame] | 87 | static LONGLONG cpu_frequency = 0; |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 88 | static LONGLONG ctrStart; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 89 | LARGE_INTEGER now; |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 90 | double diff; |
Guido van Rossum | 3917c22 | 1997-04-02 05:35:28 +0000 | [diff] [blame] | 91 | |
Victor Stinner | 8b30201 | 2012-02-07 23:29:46 +0100 | [diff] [blame] | 92 | if (cpu_frequency == 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 93 | LARGE_INTEGER freq; |
Victor Stinner | 8b30201 | 2012-02-07 23:29:46 +0100 | [diff] [blame] | 94 | QueryPerformanceCounter(&now); |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 95 | ctrStart = now.QuadPart; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 96 | if (!QueryPerformanceFrequency(&freq) || freq.QuadPart == 0) { |
Victor Stinner | 5488449 | 2014-08-29 16:51:33 +0200 | [diff] [blame] | 97 | PyErr_SetFromWindowsErr(0); |
| 98 | return NULL; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 99 | } |
Victor Stinner | 8b30201 | 2012-02-07 23:29:46 +0100 | [diff] [blame] | 100 | cpu_frequency = freq.QuadPart; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 101 | } |
| 102 | QueryPerformanceCounter(&now); |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 103 | diff = (double)(now.QuadPart - ctrStart); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 104 | if (info) { |
| 105 | info->implementation = "QueryPerformanceCounter()"; |
| 106 | info->resolution = 1.0 / (double)cpu_frequency; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 107 | info->monotonic = 1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 108 | info->adjustable = 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 109 | } |
Victor Stinner | 5488449 | 2014-08-29 16:51:33 +0200 | [diff] [blame] | 110 | return PyFloat_FromDouble(diff / (double)cpu_frequency); |
Guido van Rossum | 3917c22 | 1997-04-02 05:35:28 +0000 | [diff] [blame] | 111 | } |
Victor Stinner | f427a14 | 2014-10-22 12:33:23 +0200 | [diff] [blame] | 112 | #endif /* MS_WINDOWS */ |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 113 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 114 | #if defined(WIN32_PERF_COUNTER) || defined(HAVE_CLOCK) |
| 115 | #define PYCLOCK |
| 116 | static PyObject* |
| 117 | pyclock(_Py_clock_info_t *info) |
| 118 | { |
| 119 | #ifdef WIN32_PERF_COUNTER |
Victor Stinner | 5488449 | 2014-08-29 16:51:33 +0200 | [diff] [blame] | 120 | return win_perf_counter(info); |
| 121 | #else |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 122 | return floatclock(info); |
Victor Stinner | 5488449 | 2014-08-29 16:51:33 +0200 | [diff] [blame] | 123 | #endif |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 124 | } |
| 125 | |
Victor Stinner | 9122fdd | 2011-07-04 13:55:40 +0200 | [diff] [blame] | 126 | static PyObject * |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 127 | time_clock(PyObject *self, PyObject *unused) |
Victor Stinner | 9122fdd | 2011-07-04 13:55:40 +0200 | [diff] [blame] | 128 | { |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 129 | return pyclock(NULL); |
Victor Stinner | 9122fdd | 2011-07-04 13:55:40 +0200 | [diff] [blame] | 130 | } |
Victor Stinner | 9122fdd | 2011-07-04 13:55:40 +0200 | [diff] [blame] | 131 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 132 | PyDoc_STRVAR(clock_doc, |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 133 | "clock() -> floating point number\n\ |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 134 | \n\ |
| 135 | Return the CPU time or real time since the start of the process or since\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 136 | the first call to clock(). This has as much precision as the system\n\ |
| 137 | records."); |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 138 | #endif |
| 139 | |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 140 | #ifdef HAVE_CLOCK_GETTIME |
| 141 | static PyObject * |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 142 | time_clock_gettime(PyObject *self, PyObject *args) |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 143 | { |
| 144 | int ret; |
Victor Stinner | b8d0169 | 2012-04-13 23:44:05 +0200 | [diff] [blame] | 145 | int clk_id; |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 146 | struct timespec tp; |
| 147 | |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 148 | if (!PyArg_ParseTuple(args, "i:clock_gettime", &clk_id)) |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 149 | return NULL; |
| 150 | |
| 151 | ret = clock_gettime((clockid_t)clk_id, &tp); |
Antoine Pitrou | 2c08560 | 2012-01-18 01:41:44 +0100 | [diff] [blame] | 152 | if (ret != 0) { |
Victor Stinner | a734af3 | 2014-07-31 13:07:17 +0200 | [diff] [blame] | 153 | PyErr_SetFromErrno(PyExc_OSError); |
Antoine Pitrou | 2c08560 | 2012-01-18 01:41:44 +0100 | [diff] [blame] | 154 | return NULL; |
| 155 | } |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 156 | return PyFloat_FromDouble(tp.tv_sec + tp.tv_nsec * 1e-9); |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 157 | } |
| 158 | |
| 159 | PyDoc_STRVAR(clock_gettime_doc, |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 160 | "clock_gettime(clk_id) -> floating point number\n\ |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 161 | \n\ |
| 162 | Return the time of the specified clock clk_id."); |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 163 | #endif /* HAVE_CLOCK_GETTIME */ |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 164 | |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 165 | #ifdef HAVE_CLOCK_SETTIME |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 166 | static PyObject * |
| 167 | time_clock_settime(PyObject *self, PyObject *args) |
| 168 | { |
Victor Stinner | b8d0169 | 2012-04-13 23:44:05 +0200 | [diff] [blame] | 169 | int clk_id; |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 170 | PyObject *obj; |
Victor Stinner | b3b4544 | 2015-03-28 04:09:41 +0100 | [diff] [blame] | 171 | _PyTime_t t; |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 172 | struct timespec tp; |
| 173 | int ret; |
| 174 | |
| 175 | if (!PyArg_ParseTuple(args, "iO:clock_settime", &clk_id, &obj)) |
| 176 | return NULL; |
| 177 | |
Victor Stinner | 02937aa | 2015-03-28 05:02:39 +0100 | [diff] [blame] | 178 | if (_PyTime_FromSecondsObject(&t, obj, _PyTime_ROUND_FLOOR) < 0) |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 179 | return NULL; |
Victor Stinner | b3b4544 | 2015-03-28 04:09:41 +0100 | [diff] [blame] | 180 | |
| 181 | if (_PyTime_AsTimespec(t, &tp) == -1) |
| 182 | return NULL; |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 183 | |
| 184 | ret = clock_settime((clockid_t)clk_id, &tp); |
| 185 | if (ret != 0) { |
Victor Stinner | a734af3 | 2014-07-31 13:07:17 +0200 | [diff] [blame] | 186 | PyErr_SetFromErrno(PyExc_OSError); |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 187 | return NULL; |
| 188 | } |
| 189 | Py_RETURN_NONE; |
| 190 | } |
| 191 | |
| 192 | PyDoc_STRVAR(clock_settime_doc, |
| 193 | "clock_settime(clk_id, time)\n\ |
| 194 | \n\ |
| 195 | Set the time of the specified clock clk_id."); |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 196 | #endif /* HAVE_CLOCK_SETTIME */ |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 197 | |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 198 | #ifdef HAVE_CLOCK_GETRES |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 199 | static PyObject * |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 200 | time_clock_getres(PyObject *self, PyObject *args) |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 201 | { |
| 202 | int ret; |
Victor Stinner | b8d0169 | 2012-04-13 23:44:05 +0200 | [diff] [blame] | 203 | int clk_id; |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 204 | struct timespec tp; |
| 205 | |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 206 | if (!PyArg_ParseTuple(args, "i:clock_getres", &clk_id)) |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 207 | return NULL; |
| 208 | |
| 209 | ret = clock_getres((clockid_t)clk_id, &tp); |
Antoine Pitrou | 2c08560 | 2012-01-18 01:41:44 +0100 | [diff] [blame] | 210 | if (ret != 0) { |
Victor Stinner | a734af3 | 2014-07-31 13:07:17 +0200 | [diff] [blame] | 211 | PyErr_SetFromErrno(PyExc_OSError); |
Antoine Pitrou | 2c08560 | 2012-01-18 01:41:44 +0100 | [diff] [blame] | 212 | return NULL; |
| 213 | } |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 214 | |
| 215 | return PyFloat_FromDouble(tp.tv_sec + tp.tv_nsec * 1e-9); |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 216 | } |
| 217 | |
| 218 | PyDoc_STRVAR(clock_getres_doc, |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 219 | "clock_getres(clk_id) -> floating point number\n\ |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 220 | \n\ |
| 221 | Return the resolution (precision) of the specified clock clk_id."); |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 222 | #endif /* HAVE_CLOCK_GETRES */ |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 223 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 224 | static PyObject * |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 225 | time_sleep(PyObject *self, PyObject *obj) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 226 | { |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 227 | _PyTime_t secs; |
Victor Stinner | 869e177 | 2015-03-30 03:49:14 +0200 | [diff] [blame] | 228 | if (_PyTime_FromSecondsObject(&secs, obj, _PyTime_ROUND_CEILING)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 229 | return NULL; |
Victor Stinner | 7f53a50 | 2011-07-05 22:00:25 +0200 | [diff] [blame] | 230 | if (secs < 0) { |
| 231 | PyErr_SetString(PyExc_ValueError, |
| 232 | "sleep length must be non-negative"); |
| 233 | return NULL; |
| 234 | } |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 235 | if (pysleep(secs) != 0) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 236 | return NULL; |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 237 | Py_RETURN_NONE; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 238 | } |
| 239 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 240 | PyDoc_STRVAR(sleep_doc, |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 241 | "sleep(seconds)\n\ |
| 242 | \n\ |
| 243 | Delay execution for a given number of seconds. The argument may be\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 244 | a floating point number for subsecond precision."); |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 245 | |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 246 | static PyStructSequence_Field struct_time_type_fields[] = { |
Alexander Belopolsky | 69f3fd0 | 2010-06-05 15:04:51 +0000 | [diff] [blame] | 247 | {"tm_year", "year, for example, 1993"}, |
| 248 | {"tm_mon", "month of year, range [1, 12]"}, |
| 249 | {"tm_mday", "day of month, range [1, 31]"}, |
| 250 | {"tm_hour", "hours, range [0, 23]"}, |
| 251 | {"tm_min", "minutes, range [0, 59]"}, |
| 252 | {"tm_sec", "seconds, range [0, 61])"}, |
| 253 | {"tm_wday", "day of week, range [0, 6], Monday is 0"}, |
| 254 | {"tm_yday", "day of year, range [1, 366]"}, |
| 255 | {"tm_isdst", "1 if summer time is in effect, 0 if not, and -1 if unknown"}, |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 256 | {"tm_zone", "abbreviation of timezone name"}, |
| 257 | {"tm_gmtoff", "offset from UTC in seconds"}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 258 | {0} |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 259 | }; |
| 260 | |
| 261 | static PyStructSequence_Desc struct_time_type_desc = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 262 | "time.struct_time", |
Alexander Belopolsky | 69f3fd0 | 2010-06-05 15:04:51 +0000 | [diff] [blame] | 263 | "The time value as returned by gmtime(), localtime(), and strptime(), and\n" |
| 264 | " accepted by asctime(), mktime() and strftime(). May be considered as a\n" |
| 265 | " sequence of 9 integers.\n\n" |
| 266 | " Note that several fields' values are not the same as those defined by\n" |
| 267 | " the C language standard for struct tm. For example, the value of the\n" |
| 268 | " field tm_year is the actual year, not year - 1900. See individual\n" |
| 269 | " fields' descriptions for details.", |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 270 | struct_time_type_fields, |
| 271 | 9, |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 272 | }; |
Tim Peters | 9ad4b68 | 2002-02-13 05:14:18 +0000 | [diff] [blame] | 273 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 274 | static int initialized; |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 275 | static PyTypeObject StructTimeType; |
| 276 | |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 277 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 278 | static PyObject * |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 279 | tmtotuple(struct tm *p |
| 280 | #ifndef HAVE_STRUCT_TM_TM_ZONE |
Victor Stinner | 0d659e5 | 2017-04-25 01:22:42 +0200 | [diff] [blame] | 281 | , const char *zone, time_t gmtoff |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 282 | #endif |
| 283 | ) |
Guido van Rossum | 87ce7bb | 1998-06-09 16:30:31 +0000 | [diff] [blame] | 284 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 285 | PyObject *v = PyStructSequence_New(&StructTimeType); |
| 286 | if (v == NULL) |
| 287 | return NULL; |
Tim Peters | 9ad4b68 | 2002-02-13 05:14:18 +0000 | [diff] [blame] | 288 | |
Christian Heimes | 217cfd1 | 2007-12-02 14:31:20 +0000 | [diff] [blame] | 289 | #define SET(i,val) PyStructSequence_SET_ITEM(v, i, PyLong_FromLong((long) val)) |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 290 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 291 | SET(0, p->tm_year + 1900); |
| 292 | SET(1, p->tm_mon + 1); /* Want January == 1 */ |
| 293 | SET(2, p->tm_mday); |
| 294 | SET(3, p->tm_hour); |
| 295 | SET(4, p->tm_min); |
| 296 | SET(5, p->tm_sec); |
| 297 | SET(6, (p->tm_wday + 6) % 7); /* Want Monday == 0 */ |
| 298 | SET(7, p->tm_yday + 1); /* Want January, 1 == 1 */ |
| 299 | SET(8, p->tm_isdst); |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 300 | #ifdef HAVE_STRUCT_TM_TM_ZONE |
| 301 | PyStructSequence_SET_ITEM(v, 9, |
| 302 | PyUnicode_DecodeLocale(p->tm_zone, "surrogateescape")); |
| 303 | SET(10, p->tm_gmtoff); |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 304 | #else |
| 305 | PyStructSequence_SET_ITEM(v, 9, |
| 306 | PyUnicode_DecodeLocale(zone, "surrogateescape")); |
Victor Stinner | 0d659e5 | 2017-04-25 01:22:42 +0200 | [diff] [blame] | 307 | PyStructSequence_SET_ITEM(v, 10, _PyLong_FromTime_t(gmtoff)); |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 308 | #endif /* HAVE_STRUCT_TM_TM_ZONE */ |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 309 | #undef SET |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 310 | if (PyErr_Occurred()) { |
| 311 | Py_XDECREF(v); |
| 312 | return NULL; |
| 313 | } |
Guido van Rossum | 98bf58f | 2001-10-18 20:34:25 +0000 | [diff] [blame] | 314 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 315 | return v; |
Guido van Rossum | 87ce7bb | 1998-06-09 16:30:31 +0000 | [diff] [blame] | 316 | } |
| 317 | |
Fred Drake | f901abd | 2004-08-03 17:58:55 +0000 | [diff] [blame] | 318 | /* Parse arg tuple that can contain an optional float-or-None value; |
| 319 | format needs to be "|O:name". |
| 320 | Returns non-zero on success (parallels PyArg_ParseTuple). |
| 321 | */ |
| 322 | static int |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 323 | parse_time_t_args(PyObject *args, const char *format, time_t *pwhen) |
Fred Drake | f901abd | 2004-08-03 17:58:55 +0000 | [diff] [blame] | 324 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 325 | PyObject *ot = NULL; |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 326 | time_t whent; |
Fred Drake | f901abd | 2004-08-03 17:58:55 +0000 | [diff] [blame] | 327 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 328 | if (!PyArg_ParseTuple(args, format, &ot)) |
| 329 | return 0; |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 330 | if (ot == NULL || ot == Py_None) { |
| 331 | whent = time(NULL); |
| 332 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 333 | else { |
Victor Stinner | 02937aa | 2015-03-28 05:02:39 +0100 | [diff] [blame] | 334 | if (_PyTime_ObjectToTime_t(ot, &whent, _PyTime_ROUND_FLOOR) == -1) |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 335 | return 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 336 | } |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 337 | *pwhen = whent; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 338 | return 1; |
Fred Drake | f901abd | 2004-08-03 17:58:55 +0000 | [diff] [blame] | 339 | } |
| 340 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 341 | static PyObject * |
Peter Schneider-Kamp | 416d413 | 2000-07-10 12:15:54 +0000 | [diff] [blame] | 342 | time_gmtime(PyObject *self, PyObject *args) |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 343 | { |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 344 | time_t when; |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 345 | struct tm buf; |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 346 | |
| 347 | if (!parse_time_t_args(args, "|O:gmtime", &when)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 348 | return NULL; |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 349 | |
| 350 | errno = 0; |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 351 | if (_PyTime_gmtime(when, &buf) != 0) |
| 352 | return NULL; |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 353 | #ifdef HAVE_STRUCT_TM_TM_ZONE |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 354 | return tmtotuple(&buf); |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 355 | #else |
| 356 | return tmtotuple(&buf, "UTC", 0); |
| 357 | #endif |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 358 | } |
| 359 | |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 360 | #ifndef HAVE_TIMEGM |
| 361 | static time_t |
| 362 | timegm(struct tm *p) |
| 363 | { |
| 364 | /* XXX: the following implementation will not work for tm_year < 1970. |
| 365 | but it is likely that platforms that don't have timegm do not support |
| 366 | negative timestamps anyways. */ |
| 367 | return p->tm_sec + p->tm_min*60 + p->tm_hour*3600 + p->tm_yday*86400 + |
| 368 | (p->tm_year-70)*31536000 + ((p->tm_year-69)/4)*86400 - |
| 369 | ((p->tm_year-1)/100)*86400 + ((p->tm_year+299)/400)*86400; |
| 370 | } |
| 371 | #endif |
| 372 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 373 | PyDoc_STRVAR(gmtime_doc, |
Christian Heimes | 9a37159 | 2007-12-28 14:08:13 +0000 | [diff] [blame] | 374 | "gmtime([seconds]) -> (tm_year, tm_mon, tm_mday, tm_hour, tm_min,\n\ |
Fred Drake | 193a3f6 | 2002-03-12 21:38:49 +0000 | [diff] [blame] | 375 | tm_sec, tm_wday, tm_yday, tm_isdst)\n\ |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 376 | \n\ |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 377 | Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.\n\ |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 378 | GMT). When 'seconds' is not passed in, convert the current time instead.\n\ |
| 379 | \n\ |
| 380 | If the platform supports the tm_gmtoff and tm_zone, they are available as\n\ |
| 381 | attributes only."); |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 382 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 383 | static PyObject * |
Peter Schneider-Kamp | 416d413 | 2000-07-10 12:15:54 +0000 | [diff] [blame] | 384 | time_localtime(PyObject *self, PyObject *args) |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 385 | { |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 386 | time_t when; |
| 387 | struct tm buf; |
| 388 | |
| 389 | if (!parse_time_t_args(args, "|O:localtime", &when)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 390 | return NULL; |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 391 | if (_PyTime_localtime(when, &buf) != 0) |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 392 | return NULL; |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 393 | #ifdef HAVE_STRUCT_TM_TM_ZONE |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 394 | return tmtotuple(&buf); |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 395 | #else |
| 396 | { |
| 397 | struct tm local = buf; |
| 398 | char zone[100]; |
Victor Stinner | 0d659e5 | 2017-04-25 01:22:42 +0200 | [diff] [blame] | 399 | time_t gmtoff; |
Steve Dower | c3c6f71 | 2016-12-14 11:22:05 -0800 | [diff] [blame] | 400 | strftime(zone, sizeof(zone), "%Z", &buf); |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 401 | gmtoff = timegm(&buf) - when; |
| 402 | return tmtotuple(&local, zone, gmtoff); |
| 403 | } |
| 404 | #endif |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 405 | } |
| 406 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 407 | PyDoc_STRVAR(localtime_doc, |
Christian Heimes | 9a37159 | 2007-12-28 14:08:13 +0000 | [diff] [blame] | 408 | "localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,\n\ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 409 | tm_sec,tm_wday,tm_yday,tm_isdst)\n\ |
Martin v. Löwis | b3cfc1d | 2001-12-02 12:27:43 +0000 | [diff] [blame] | 410 | \n\ |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 411 | Convert seconds since the Epoch to a time tuple expressing local time.\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 412 | When 'seconds' is not passed in, convert the current time instead."); |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 413 | |
Alexander Belopolsky | 38e2996 | 2010-10-01 14:18:49 +0000 | [diff] [blame] | 414 | /* Convert 9-item tuple to tm structure. Return 1 on success, set |
| 415 | * an exception and return 0 on error. |
| 416 | */ |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 417 | static int |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 418 | gettmarg(PyObject *args, struct tm *p, const char *format) |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 419 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 420 | int y; |
Guido van Rossum | cfbaecc | 1998-08-25 14:51:12 +0000 | [diff] [blame] | 421 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 422 | memset((void *) p, '\0', sizeof(struct tm)); |
Guido van Rossum | b908126 | 2007-08-25 03:14:09 +0000 | [diff] [blame] | 423 | |
Alexander Belopolsky | 610e544 | 2011-01-06 21:57:06 +0000 | [diff] [blame] | 424 | if (!PyTuple_Check(args)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 425 | PyErr_SetString(PyExc_TypeError, |
| 426 | "Tuple or struct_time argument required"); |
| 427 | return 0; |
| 428 | } |
Skip Montanaro | 41cfce9 | 2007-08-24 21:11:00 +0000 | [diff] [blame] | 429 | |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 430 | if (!PyArg_ParseTuple(args, format, |
Alexander Belopolsky | 610e544 | 2011-01-06 21:57:06 +0000 | [diff] [blame] | 431 | &y, &p->tm_mon, &p->tm_mday, |
| 432 | &p->tm_hour, &p->tm_min, &p->tm_sec, |
| 433 | &p->tm_wday, &p->tm_yday, &p->tm_isdst)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 434 | return 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 435 | p->tm_year = y - 1900; |
| 436 | p->tm_mon--; |
| 437 | p->tm_wday = (p->tm_wday + 1) % 7; |
| 438 | p->tm_yday--; |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 439 | #ifdef HAVE_STRUCT_TM_TM_ZONE |
| 440 | if (Py_TYPE(args) == &StructTimeType) { |
| 441 | PyObject *item; |
| 442 | item = PyTuple_GET_ITEM(args, 9); |
Victor Stinner | 6e67695 | 2017-04-26 13:51:48 +0200 | [diff] [blame] | 443 | p->tm_zone = item == Py_None ? NULL : (char*)PyUnicode_AsUTF8(item); |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 444 | item = PyTuple_GET_ITEM(args, 10); |
| 445 | p->tm_gmtoff = item == Py_None ? 0 : PyLong_AsLong(item); |
| 446 | if (PyErr_Occurred()) |
| 447 | return 0; |
| 448 | } |
| 449 | #endif /* HAVE_STRUCT_TM_TM_ZONE */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 450 | return 1; |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 451 | } |
| 452 | |
Alexander Belopolsky | 38e2996 | 2010-10-01 14:18:49 +0000 | [diff] [blame] | 453 | /* Check values of the struct tm fields before it is passed to strftime() and |
| 454 | * asctime(). Return 1 if all values are valid, otherwise set an exception |
| 455 | * and returns 0. |
| 456 | */ |
Victor Stinner | ef12810 | 2010-10-07 01:00:52 +0000 | [diff] [blame] | 457 | static int |
| 458 | checktm(struct tm* buf) |
Alexander Belopolsky | 38e2996 | 2010-10-01 14:18:49 +0000 | [diff] [blame] | 459 | { |
Victor Stinner | ef12810 | 2010-10-07 01:00:52 +0000 | [diff] [blame] | 460 | /* Checks added to make sure strftime() and asctime() does not crash Python by |
| 461 | indexing blindly into some array for a textual representation |
| 462 | by some bad index (fixes bug #897625 and #6608). |
| 463 | |
| 464 | Also support values of zero from Python code for arguments in which |
| 465 | that is out of range by forcing that value to the lowest value that |
| 466 | is valid (fixed bug #1520914). |
| 467 | |
| 468 | Valid ranges based on what is allowed in struct tm: |
| 469 | |
| 470 | - tm_year: [0, max(int)] (1) |
| 471 | - tm_mon: [0, 11] (2) |
| 472 | - tm_mday: [1, 31] |
| 473 | - tm_hour: [0, 23] |
| 474 | - tm_min: [0, 59] |
| 475 | - tm_sec: [0, 60] |
| 476 | - tm_wday: [0, 6] (1) |
| 477 | - tm_yday: [0, 365] (2) |
| 478 | - tm_isdst: [-max(int), max(int)] |
| 479 | |
| 480 | (1) gettmarg() handles bounds-checking. |
| 481 | (2) Python's acceptable range is one greater than the range in C, |
Alexander Belopolsky | 38e2996 | 2010-10-01 14:18:49 +0000 | [diff] [blame] | 482 | thus need to check against automatic decrement by gettmarg(). |
| 483 | */ |
| 484 | if (buf->tm_mon == -1) |
| 485 | buf->tm_mon = 0; |
| 486 | else if (buf->tm_mon < 0 || buf->tm_mon > 11) { |
| 487 | PyErr_SetString(PyExc_ValueError, "month out of range"); |
| 488 | return 0; |
| 489 | } |
| 490 | if (buf->tm_mday == 0) |
| 491 | buf->tm_mday = 1; |
| 492 | else if (buf->tm_mday < 0 || buf->tm_mday > 31) { |
| 493 | PyErr_SetString(PyExc_ValueError, "day of month out of range"); |
| 494 | return 0; |
| 495 | } |
| 496 | if (buf->tm_hour < 0 || buf->tm_hour > 23) { |
| 497 | PyErr_SetString(PyExc_ValueError, "hour out of range"); |
| 498 | return 0; |
| 499 | } |
| 500 | if (buf->tm_min < 0 || buf->tm_min > 59) { |
| 501 | PyErr_SetString(PyExc_ValueError, "minute out of range"); |
| 502 | return 0; |
| 503 | } |
| 504 | if (buf->tm_sec < 0 || buf->tm_sec > 61) { |
| 505 | PyErr_SetString(PyExc_ValueError, "seconds out of range"); |
| 506 | return 0; |
| 507 | } |
| 508 | /* tm_wday does not need checking of its upper-bound since taking |
| 509 | ``% 7`` in gettmarg() automatically restricts the range. */ |
| 510 | if (buf->tm_wday < 0) { |
| 511 | PyErr_SetString(PyExc_ValueError, "day of week out of range"); |
| 512 | return 0; |
| 513 | } |
| 514 | if (buf->tm_yday == -1) |
| 515 | buf->tm_yday = 0; |
| 516 | else if (buf->tm_yday < 0 || buf->tm_yday > 365) { |
| 517 | PyErr_SetString(PyExc_ValueError, "day of year out of range"); |
| 518 | return 0; |
| 519 | } |
| 520 | return 1; |
| 521 | } |
| 522 | |
Victor Stinner | c1f32ca | 2011-10-14 02:36:13 +0200 | [diff] [blame] | 523 | #ifdef MS_WINDOWS |
| 524 | /* wcsftime() doesn't format correctly time zones, see issue #10653 */ |
| 525 | # undef HAVE_WCSFTIME |
| 526 | #endif |
Alexander Belopolsky | cf77454 | 2012-10-02 18:39:16 -0400 | [diff] [blame] | 527 | #define STRFTIME_FORMAT_CODES \ |
| 528 | "Commonly used format codes:\n\ |
| 529 | \n\ |
| 530 | %Y Year with century as a decimal number.\n\ |
| 531 | %m Month as a decimal number [01,12].\n\ |
| 532 | %d Day of the month as a decimal number [01,31].\n\ |
| 533 | %H Hour (24-hour clock) as a decimal number [00,23].\n\ |
| 534 | %M Minute as a decimal number [00,59].\n\ |
| 535 | %S Second as a decimal number [00,61].\n\ |
| 536 | %z Time zone offset from UTC.\n\ |
| 537 | %a Locale's abbreviated weekday name.\n\ |
| 538 | %A Locale's full weekday name.\n\ |
| 539 | %b Locale's abbreviated month name.\n\ |
| 540 | %B Locale's full month name.\n\ |
| 541 | %c Locale's appropriate date and time representation.\n\ |
| 542 | %I Hour (12-hour clock) as a decimal number [01,12].\n\ |
| 543 | %p Locale's equivalent of either AM or PM.\n\ |
| 544 | \n\ |
| 545 | Other codes may be available on your platform. See documentation for\n\ |
| 546 | the C library strftime function.\n" |
Victor Stinner | c1f32ca | 2011-10-14 02:36:13 +0200 | [diff] [blame] | 547 | |
Guido van Rossum | 8d8c1ee | 1995-09-13 17:38:35 +0000 | [diff] [blame] | 548 | #ifdef HAVE_STRFTIME |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 549 | #ifdef HAVE_WCSFTIME |
| 550 | #define time_char wchar_t |
| 551 | #define format_time wcsftime |
| 552 | #define time_strlen wcslen |
| 553 | #else |
| 554 | #define time_char char |
| 555 | #define format_time strftime |
| 556 | #define time_strlen strlen |
| 557 | #endif |
| 558 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 559 | static PyObject * |
Peter Schneider-Kamp | 416d413 | 2000-07-10 12:15:54 +0000 | [diff] [blame] | 560 | time_strftime(PyObject *self, PyObject *args) |
Guido van Rossum | 8d8c1ee | 1995-09-13 17:38:35 +0000 | [diff] [blame] | 561 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 562 | PyObject *tup = NULL; |
| 563 | struct tm buf; |
| 564 | const time_char *fmt; |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 565 | #ifdef HAVE_WCSFTIME |
| 566 | wchar_t *format; |
| 567 | #else |
| 568 | PyObject *format; |
| 569 | #endif |
Victor Stinner | ef12810 | 2010-10-07 01:00:52 +0000 | [diff] [blame] | 570 | PyObject *format_arg; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 571 | size_t fmtlen, buflen; |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 572 | time_char *outbuf = NULL; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 573 | size_t i; |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 574 | PyObject *ret = NULL; |
Guido van Rossum | 8d8c1ee | 1995-09-13 17:38:35 +0000 | [diff] [blame] | 575 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 576 | memset((void *) &buf, '\0', sizeof(buf)); |
Guido van Rossum | 1f41f84 | 1998-04-27 19:04:26 +0000 | [diff] [blame] | 577 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 578 | /* Will always expect a unicode string to be passed as format. |
| 579 | Given that there's no str type anymore in py3k this seems safe. |
| 580 | */ |
Victor Stinner | ef12810 | 2010-10-07 01:00:52 +0000 | [diff] [blame] | 581 | if (!PyArg_ParseTuple(args, "U|O:strftime", &format_arg, &tup)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 582 | return NULL; |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 583 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 584 | if (tup == NULL) { |
| 585 | time_t tt = time(NULL); |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 586 | if (_PyTime_localtime(tt, &buf) != 0) |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 587 | return NULL; |
Alexander Belopolsky | 38e2996 | 2010-10-01 14:18:49 +0000 | [diff] [blame] | 588 | } |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 589 | else if (!gettmarg(tup, &buf, |
| 590 | "iiiiiiiii;strftime(): illegal time tuple argument") || |
| 591 | !checktm(&buf)) |
| 592 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 593 | return NULL; |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 594 | } |
Guido van Rossum | 10b164a | 2001-09-25 13:59:01 +0000 | [diff] [blame] | 595 | |
Victor Stinner | 36b82d8 | 2013-06-25 02:33:53 +0200 | [diff] [blame] | 596 | #if defined(_MSC_VER) || defined(sun) || defined(_AIX) |
Victor Stinner | 73ea29c | 2011-01-08 01:56:31 +0000 | [diff] [blame] | 597 | if (buf.tm_year + 1900 < 1 || 9999 < buf.tm_year + 1900) { |
Victor Stinner | 6f0e4f9 | 2011-03-21 02:14:53 +0100 | [diff] [blame] | 598 | PyErr_SetString(PyExc_ValueError, |
| 599 | "strftime() requires year in [1; 9999]"); |
Alexander Belopolsky | 0dd06f4 | 2011-01-08 01:23:02 +0000 | [diff] [blame] | 600 | return NULL; |
Alexander Belopolsky | c64708a | 2011-01-07 19:59:19 +0000 | [diff] [blame] | 601 | } |
Victor Stinner | 73ea29c | 2011-01-08 01:56:31 +0000 | [diff] [blame] | 602 | #endif |
Alexander Belopolsky | c64708a | 2011-01-07 19:59:19 +0000 | [diff] [blame] | 603 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 604 | /* Normalize tm_isdst just in case someone foolishly implements %Z |
| 605 | based on the assumption that tm_isdst falls within the range of |
| 606 | [-1, 1] */ |
| 607 | if (buf.tm_isdst < -1) |
| 608 | buf.tm_isdst = -1; |
| 609 | else if (buf.tm_isdst > 1) |
| 610 | buf.tm_isdst = 1; |
Brett Cannon | d1080a3 | 2004-03-02 04:38:10 +0000 | [diff] [blame] | 611 | |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 612 | #ifdef HAVE_WCSFTIME |
Victor Stinner | beb4135b | 2010-10-07 01:02:42 +0000 | [diff] [blame] | 613 | format = PyUnicode_AsWideCharString(format_arg, NULL); |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 614 | if (format == NULL) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 615 | return NULL; |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 616 | fmt = format; |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 617 | #else |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 618 | /* Convert the unicode string to an ascii one */ |
Victor Stinner | 1b57967 | 2011-12-17 05:47:23 +0100 | [diff] [blame] | 619 | format = PyUnicode_EncodeLocale(format_arg, "surrogateescape"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 620 | if (format == NULL) |
| 621 | return NULL; |
| 622 | fmt = PyBytes_AS_STRING(format); |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 623 | #endif |
Amaury Forgeot d'Arc | b5be6d4 | 2009-03-02 23:52:57 +0000 | [diff] [blame] | 624 | |
Stefan Krah | 4aea7d3 | 2012-02-27 16:30:26 +0100 | [diff] [blame] | 625 | #if defined(MS_WINDOWS) && !defined(HAVE_WCSFTIME) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 626 | /* check that the format string contains only valid directives */ |
Steve Dower | e5b5895 | 2015-09-06 19:20:51 -0700 | [diff] [blame] | 627 | for (outbuf = strchr(fmt, '%'); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 628 | outbuf != NULL; |
Victor Stinner | 5a3ff79 | 2011-10-16 19:08:23 +0200 | [diff] [blame] | 629 | outbuf = strchr(outbuf+2, '%')) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 630 | { |
Steve Dower | e5b5895 | 2015-09-06 19:20:51 -0700 | [diff] [blame] | 631 | if (outbuf[1] == '#') |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 632 | ++outbuf; /* not documented by python, */ |
Steve Dower | e5b5895 | 2015-09-06 19:20:51 -0700 | [diff] [blame] | 633 | if (outbuf[1] == '\0') |
| 634 | break; |
| 635 | if ((outbuf[1] == 'y') && buf.tm_year < 0) { |
Tim Golden | 6e51b8f | 2013-11-12 12:36:54 +0000 | [diff] [blame] | 636 | PyErr_SetString(PyExc_ValueError, |
| 637 | "format %y requires year >= 1900 on Windows"); |
| 638 | Py_DECREF(format); |
| 639 | return NULL; |
| 640 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 641 | } |
Victor Stinner | 93965f7 | 2013-11-23 14:59:33 +0100 | [diff] [blame] | 642 | #elif (defined(_AIX) || defined(sun)) && defined(HAVE_WCSFTIME) |
Steve Dower | e5b5895 | 2015-09-06 19:20:51 -0700 | [diff] [blame] | 643 | for (outbuf = wcschr(fmt, '%'); |
Victor Stinner | 55329f8 | 2013-11-17 23:39:21 +0100 | [diff] [blame] | 644 | outbuf != NULL; |
| 645 | outbuf = wcschr(outbuf+2, '%')) |
| 646 | { |
Steve Dower | e5b5895 | 2015-09-06 19:20:51 -0700 | [diff] [blame] | 647 | if (outbuf[1] == L'\0') |
| 648 | break; |
Victor Stinner | 55329f8 | 2013-11-17 23:39:21 +0100 | [diff] [blame] | 649 | /* Issue #19634: On AIX, wcsftime("y", (1899, 1, 1, 0, 0, 0, 0, 0, 0)) |
| 650 | returns "0/" instead of "99" */ |
| 651 | if (outbuf[1] == L'y' && buf.tm_year < 0) { |
| 652 | PyErr_SetString(PyExc_ValueError, |
| 653 | "format %y requires year >= 1900 on AIX"); |
Victor Stinner | 55329f8 | 2013-11-17 23:39:21 +0100 | [diff] [blame] | 654 | return NULL; |
| 655 | } |
| 656 | } |
Amaury Forgeot d'Arc | b5be6d4 | 2009-03-02 23:52:57 +0000 | [diff] [blame] | 657 | #endif |
| 658 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 659 | fmtlen = time_strlen(fmt); |
Guido van Rossum | c222ec2 | 1999-02-23 00:00:10 +0000 | [diff] [blame] | 660 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 661 | /* I hate these functions that presume you know how big the output |
| 662 | * will be ahead of time... |
| 663 | */ |
| 664 | for (i = 1024; ; i += i) { |
| 665 | outbuf = (time_char *)PyMem_Malloc(i*sizeof(time_char)); |
| 666 | if (outbuf == NULL) { |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 667 | PyErr_NoMemory(); |
| 668 | break; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 669 | } |
Steve Dower | 57ab1cd | 2015-09-22 14:51:42 -0700 | [diff] [blame] | 670 | #if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__) |
| 671 | errno = 0; |
| 672 | #endif |
Steve Dower | d9ef74e | 2015-05-22 15:08:34 -0700 | [diff] [blame] | 673 | _Py_BEGIN_SUPPRESS_IPH |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 674 | buflen = format_time(outbuf, i, fmt, &buf); |
Steve Dower | d9ef74e | 2015-05-22 15:08:34 -0700 | [diff] [blame] | 675 | _Py_END_SUPPRESS_IPH |
Victor Stinner | 136ea49 | 2011-12-17 22:37:18 +0100 | [diff] [blame] | 676 | #if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__) |
Steve Dower | 97cded9 | 2015-09-08 19:12:51 -0700 | [diff] [blame] | 677 | /* VisualStudio .NET 2005 does this properly */ |
| 678 | if (buflen == 0 && errno == EINVAL) { |
| 679 | PyErr_SetString(PyExc_ValueError, "Invalid format string"); |
| 680 | PyMem_Free(outbuf); |
| 681 | break; |
| 682 | } |
Victor Stinner | 136ea49 | 2011-12-17 22:37:18 +0100 | [diff] [blame] | 683 | #endif |
Steve Dower | 97cded9 | 2015-09-08 19:12:51 -0700 | [diff] [blame] | 684 | if (buflen > 0 || i >= 256 * fmtlen) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 685 | /* If the buffer is 256 times as long as the format, |
| 686 | it's probably not failing for lack of room! |
| 687 | More likely, the format yields an empty result, |
| 688 | e.g. an empty format, or %Z when the timezone |
| 689 | is unknown. */ |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 690 | #ifdef HAVE_WCSFTIME |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 691 | ret = PyUnicode_FromWideChar(outbuf, buflen); |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 692 | #else |
Victor Stinner | 1b57967 | 2011-12-17 05:47:23 +0100 | [diff] [blame] | 693 | ret = PyUnicode_DecodeLocaleAndSize(outbuf, buflen, |
| 694 | "surrogateescape"); |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 695 | #endif |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 696 | PyMem_Free(outbuf); |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 697 | break; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 698 | } |
| 699 | PyMem_Free(outbuf); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 700 | } |
Victor Stinner | b290478 | 2010-09-29 10:34:19 +0000 | [diff] [blame] | 701 | #ifdef HAVE_WCSFTIME |
| 702 | PyMem_Free(format); |
| 703 | #else |
| 704 | Py_DECREF(format); |
| 705 | #endif |
| 706 | return ret; |
Guido van Rossum | 8d8c1ee | 1995-09-13 17:38:35 +0000 | [diff] [blame] | 707 | } |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 708 | |
Martin v. Löwis | 1b01ccd | 2009-05-30 06:13:40 +0000 | [diff] [blame] | 709 | #undef time_char |
| 710 | #undef format_time |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 711 | PyDoc_STRVAR(strftime_doc, |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 712 | "strftime(format[, tuple]) -> string\n\ |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 713 | \n\ |
| 714 | Convert a time tuple to a string according to a format specification.\n\ |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 715 | See the library reference manual for formatting codes. When the time tuple\n\ |
Alexander Belopolsky | cf77454 | 2012-10-02 18:39:16 -0400 | [diff] [blame] | 716 | is not present, current time as returned by localtime() is used.\n\ |
| 717 | \n" STRFTIME_FORMAT_CODES); |
Guido van Rossum | 8d8c1ee | 1995-09-13 17:38:35 +0000 | [diff] [blame] | 718 | #endif /* HAVE_STRFTIME */ |
| 719 | |
Guido van Rossum | d3c46d5 | 2002-07-19 17:06:47 +0000 | [diff] [blame] | 720 | static PyObject * |
| 721 | time_strptime(PyObject *self, PyObject *args) |
| 722 | { |
Victor Stinner | dbe28d2 | 2016-12-09 00:38:53 +0100 | [diff] [blame] | 723 | PyObject *module, *func, *result; |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 724 | _Py_IDENTIFIER(_strptime_time); |
Guido van Rossum | d3c46d5 | 2002-07-19 17:06:47 +0000 | [diff] [blame] | 725 | |
Victor Stinner | dbe28d2 | 2016-12-09 00:38:53 +0100 | [diff] [blame] | 726 | module = PyImport_ImportModuleNoBlock("_strptime"); |
| 727 | if (!module) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 728 | return NULL; |
Victor Stinner | dbe28d2 | 2016-12-09 00:38:53 +0100 | [diff] [blame] | 729 | |
| 730 | func = _PyObject_GetAttrId(module, &PyId__strptime_time); |
| 731 | Py_DECREF(module); |
| 732 | if (!func) { |
| 733 | return NULL; |
| 734 | } |
| 735 | |
| 736 | result = PyObject_Call(func, args, NULL); |
| 737 | Py_DECREF(func); |
| 738 | return result; |
Guido van Rossum | d3c46d5 | 2002-07-19 17:06:47 +0000 | [diff] [blame] | 739 | } |
| 740 | |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 741 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 742 | PyDoc_STRVAR(strptime_doc, |
Brett Cannon | 20def8b | 2003-07-01 05:16:08 +0000 | [diff] [blame] | 743 | "strptime(string, format) -> struct_time\n\ |
Martin v. Löwis | b3cfc1d | 2001-12-02 12:27:43 +0000 | [diff] [blame] | 744 | \n\ |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 745 | Parse a string to a time tuple according to a format specification.\n\ |
Alexander Belopolsky | cf77454 | 2012-10-02 18:39:16 -0400 | [diff] [blame] | 746 | See the library reference manual for formatting codes (same as\n\ |
| 747 | strftime()).\n\ |
| 748 | \n" STRFTIME_FORMAT_CODES); |
Guido van Rossum | d3c46d5 | 2002-07-19 17:06:47 +0000 | [diff] [blame] | 749 | |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 750 | static PyObject * |
| 751 | _asctime(struct tm *timeptr) |
| 752 | { |
| 753 | /* Inspired by Open Group reference implementation available at |
| 754 | * http://pubs.opengroup.org/onlinepubs/009695399/functions/asctime.html */ |
Serhiy Storchaka | 2d06e84 | 2015-12-25 19:53:18 +0200 | [diff] [blame] | 755 | static const char wday_name[7][4] = { |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 756 | "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" |
| 757 | }; |
Serhiy Storchaka | 2d06e84 | 2015-12-25 19:53:18 +0200 | [diff] [blame] | 758 | static const char mon_name[12][4] = { |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 759 | "Jan", "Feb", "Mar", "Apr", "May", "Jun", |
| 760 | "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" |
| 761 | }; |
Victor Stinner | 499dfcf | 2011-03-21 13:26:24 +0100 | [diff] [blame] | 762 | return PyUnicode_FromFormat( |
| 763 | "%s %s%3d %.2d:%.2d:%.2d %d", |
| 764 | wday_name[timeptr->tm_wday], |
| 765 | mon_name[timeptr->tm_mon], |
| 766 | timeptr->tm_mday, timeptr->tm_hour, |
| 767 | timeptr->tm_min, timeptr->tm_sec, |
| 768 | 1900 + timeptr->tm_year); |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 769 | } |
Guido van Rossum | 87ce7bb | 1998-06-09 16:30:31 +0000 | [diff] [blame] | 770 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 771 | static PyObject * |
Peter Schneider-Kamp | 416d413 | 2000-07-10 12:15:54 +0000 | [diff] [blame] | 772 | time_asctime(PyObject *self, PyObject *args) |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 773 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 774 | PyObject *tup = NULL; |
| 775 | struct tm buf; |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 776 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 777 | if (!PyArg_UnpackTuple(args, "asctime", 0, 1, &tup)) |
| 778 | return NULL; |
| 779 | if (tup == NULL) { |
| 780 | time_t tt = time(NULL); |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 781 | if (_PyTime_localtime(tt, &buf) != 0) |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 782 | return NULL; |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 783 | } |
| 784 | else if (!gettmarg(tup, &buf, |
| 785 | "iiiiiiiii;asctime(): illegal time tuple argument") || |
| 786 | !checktm(&buf)) |
| 787 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 788 | return NULL; |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 789 | } |
Alexander Belopolsky | b9588b5 | 2011-01-04 16:34:30 +0000 | [diff] [blame] | 790 | return _asctime(&buf); |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 791 | } |
| 792 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 793 | PyDoc_STRVAR(asctime_doc, |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 794 | "asctime([tuple]) -> string\n\ |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 795 | \n\ |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 796 | Convert a time tuple to a string, e.g. 'Sat Jun 06 16:26:11 1998'.\n\ |
| 797 | When the time tuple is not present, current time as returned by localtime()\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 798 | is used."); |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 799 | |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 800 | static PyObject * |
Peter Schneider-Kamp | 416d413 | 2000-07-10 12:15:54 +0000 | [diff] [blame] | 801 | time_ctime(PyObject *self, PyObject *args) |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 802 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 803 | time_t tt; |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 804 | struct tm buf; |
| 805 | if (!parse_time_t_args(args, "|O:ctime", &tt)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 806 | return NULL; |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 807 | if (_PyTime_localtime(tt, &buf) != 0) |
Alexander Belopolsky | 5da468f | 2011-01-04 17:15:52 +0000 | [diff] [blame] | 808 | return NULL; |
Victor Stinner | c1b5d34 | 2012-01-27 00:08:48 +0100 | [diff] [blame] | 809 | return _asctime(&buf); |
Guido van Rossum | 9e90a67 | 1993-06-24 11:10:19 +0000 | [diff] [blame] | 810 | } |
| 811 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 812 | PyDoc_STRVAR(ctime_doc, |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 813 | "ctime(seconds) -> string\n\ |
| 814 | \n\ |
| 815 | Convert a time in seconds since the Epoch to a string in local time.\n\ |
Thomas Wouters | fe38525 | 2001-01-19 23:16:56 +0000 | [diff] [blame] | 816 | This is equivalent to asctime(localtime(seconds)). When the time tuple is\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 817 | not present, current time as returned by localtime() is used."); |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 818 | |
Guido van Rossum | 60cd813 | 1998-03-06 17:16:21 +0000 | [diff] [blame] | 819 | #ifdef HAVE_MKTIME |
Barry Warsaw | 9a2a8a8 | 1996-12-06 23:32:14 +0000 | [diff] [blame] | 820 | static PyObject * |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 821 | time_mktime(PyObject *self, PyObject *tup) |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 822 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 823 | struct tm buf; |
| 824 | time_t tt; |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 825 | if (!gettmarg(tup, &buf, |
| 826 | "iiiiiiiii;mktime(): illegal time tuple argument")) |
| 827 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 828 | return NULL; |
Oren Milman | 1d1d3e9 | 2017-08-20 18:35:36 +0300 | [diff] [blame] | 829 | } |
Victor Stinner | 1ac4261 | 2014-02-21 09:27:17 +0100 | [diff] [blame] | 830 | #ifdef _AIX |
| 831 | /* year < 1902 or year > 2037 */ |
| 832 | if (buf.tm_year < 2 || buf.tm_year > 137) { |
| 833 | /* Issue #19748: On AIX, mktime() doesn't report overflow error for |
| 834 | * timestamp < -2^31 or timestamp > 2**31-1. */ |
| 835 | PyErr_SetString(PyExc_OverflowError, |
| 836 | "mktime argument out of range"); |
| 837 | return NULL; |
| 838 | } |
| 839 | #else |
Alexander Belopolsky | b7d40d1 | 2011-01-11 01:21:25 +0000 | [diff] [blame] | 840 | buf.tm_wday = -1; /* sentinel; original value ignored */ |
Victor Stinner | 1ac4261 | 2014-02-21 09:27:17 +0100 | [diff] [blame] | 841 | #endif |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 842 | tt = mktime(&buf); |
Alexander Belopolsky | b7d40d1 | 2011-01-11 01:21:25 +0000 | [diff] [blame] | 843 | /* Return value of -1 does not necessarily mean an error, but tm_wday |
Ezio Melotti | 1392500 | 2011-03-16 11:05:33 +0200 | [diff] [blame] | 844 | * cannot remain set to -1 if mktime succeeded. */ |
Victor Stinner | 9303749 | 2013-06-25 22:54:35 +0200 | [diff] [blame] | 845 | if (tt == (time_t)(-1) |
| 846 | #ifndef _AIX |
| 847 | /* Return value of -1 does not necessarily mean an error, but |
| 848 | * tm_wday cannot remain set to -1 if mktime succeeded. */ |
| 849 | && buf.tm_wday == -1 |
| 850 | #else |
| 851 | /* on AIX, tm_wday is always sets, even on error */ |
| 852 | #endif |
| 853 | ) |
| 854 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 855 | PyErr_SetString(PyExc_OverflowError, |
| 856 | "mktime argument out of range"); |
| 857 | return NULL; |
| 858 | } |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 859 | return PyFloat_FromDouble((double)tt); |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 860 | } |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 861 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 862 | PyDoc_STRVAR(mktime_doc, |
Guido van Rossum | 0ef577b | 1998-06-27 20:38:36 +0000 | [diff] [blame] | 863 | "mktime(tuple) -> floating point number\n\ |
| 864 | \n\ |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 865 | Convert a time tuple in local time to seconds since the Epoch.\n\ |
| 866 | Note that mktime(gmtime(0)) will not generally return zero for most\n\ |
| 867 | time zones; instead the returned value will either be equal to that\n\ |
| 868 | of the timezone or altzone attributes on the time module."); |
Guido van Rossum | 60cd813 | 1998-03-06 17:16:21 +0000 | [diff] [blame] | 869 | #endif /* HAVE_MKTIME */ |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 870 | |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 871 | #ifdef HAVE_WORKING_TZSET |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 872 | static void PyInit_timezone(PyObject *module); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 873 | |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 874 | static PyObject * |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 875 | time_tzset(PyObject *self, PyObject *unused) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 876 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 877 | PyObject* m; |
Fred Drake | 9bb7432 | 2002-04-01 14:49:59 +0000 | [diff] [blame] | 878 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 879 | m = PyImport_ImportModuleNoBlock("time"); |
| 880 | if (m == NULL) { |
| 881 | return NULL; |
| 882 | } |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 883 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 884 | tzset(); |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 885 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 886 | /* Reset timezone, altzone, daylight and tzname */ |
| 887 | PyInit_timezone(m); |
| 888 | Py_DECREF(m); |
Victor Stinner | 2ff51b8 | 2013-07-17 21:42:45 +0200 | [diff] [blame] | 889 | if (PyErr_Occurred()) |
| 890 | return NULL; |
Tim Peters | 1b6f7a9 | 2004-06-20 02:50:16 +0000 | [diff] [blame] | 891 | |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 892 | Py_RETURN_NONE; |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 893 | } |
| 894 | |
| 895 | PyDoc_STRVAR(tzset_doc, |
R. David Murray | 4d55bf9 | 2010-12-14 00:55:46 +0000 | [diff] [blame] | 896 | "tzset()\n\ |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 897 | \n\ |
| 898 | Initialize, or reinitialize, the local timezone to the value stored in\n\ |
| 899 | os.environ['TZ']. The TZ environment variable should be specified in\n\ |
Neal Norwitz | dc8e194 | 2004-07-20 22:34:37 +0000 | [diff] [blame] | 900 | standard Unix timezone format as documented in the tzset man page\n\ |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 901 | (eg. 'US/Eastern', 'Europe/Amsterdam'). Unknown timezones will silently\n\ |
| 902 | fall back to UTC. If the TZ environment variable is not set, the local\n\ |
| 903 | timezone is set to the systems best guess of wallclock time.\n\ |
| 904 | Changing the TZ environment variable without calling tzset *may* change\n\ |
| 905 | the local timezone used by methods such as localtime, but this behaviour\n\ |
| 906 | should not be relied on."); |
| 907 | #endif /* HAVE_WORKING_TZSET */ |
| 908 | |
Victor Stinner | ae58649 | 2014-09-02 23:18:25 +0200 | [diff] [blame] | 909 | static PyObject * |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 910 | pymonotonic(_Py_clock_info_t *info) |
Victor Stinner | b94b266 | 2012-01-18 01:50:21 +0100 | [diff] [blame] | 911 | { |
Victor Stinner | 4bfb460 | 2015-03-27 22:27:24 +0100 | [diff] [blame] | 912 | _PyTime_t t; |
| 913 | double d; |
| 914 | if (_PyTime_GetMonotonicClockWithInfo(&t, info) < 0) { |
Victor Stinner | ae58649 | 2014-09-02 23:18:25 +0200 | [diff] [blame] | 915 | assert(info != NULL); |
Victor Stinner | 071eca3 | 2012-03-15 01:17:09 +0100 | [diff] [blame] | 916 | return NULL; |
| 917 | } |
Victor Stinner | 4bfb460 | 2015-03-27 22:27:24 +0100 | [diff] [blame] | 918 | d = _PyTime_AsSecondsDouble(t); |
| 919 | return PyFloat_FromDouble(d); |
Victor Stinner | 8b30201 | 2012-02-07 23:29:46 +0100 | [diff] [blame] | 920 | } |
| 921 | |
Victor Stinner | 071eca3 | 2012-03-15 01:17:09 +0100 | [diff] [blame] | 922 | static PyObject * |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 923 | time_monotonic(PyObject *self, PyObject *unused) |
Victor Stinner | 071eca3 | 2012-03-15 01:17:09 +0100 | [diff] [blame] | 924 | { |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 925 | return pymonotonic(NULL); |
Victor Stinner | 071eca3 | 2012-03-15 01:17:09 +0100 | [diff] [blame] | 926 | } |
| 927 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 928 | PyDoc_STRVAR(monotonic_doc, |
| 929 | "monotonic() -> float\n\ |
Victor Stinner | 8b30201 | 2012-02-07 23:29:46 +0100 | [diff] [blame] | 930 | \n\ |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 931 | Monotonic clock, cannot go backward."); |
Victor Stinner | ec919cc | 2012-03-15 00:58:32 +0100 | [diff] [blame] | 932 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 933 | static PyObject* |
| 934 | perf_counter(_Py_clock_info_t *info) |
| 935 | { |
Victor Stinner | 5488449 | 2014-08-29 16:51:33 +0200 | [diff] [blame] | 936 | #ifdef WIN32_PERF_COUNTER |
| 937 | return win_perf_counter(info); |
| 938 | #else |
Victor Stinner | ae58649 | 2014-09-02 23:18:25 +0200 | [diff] [blame] | 939 | return pymonotonic(info); |
Victor Stinner | 5488449 | 2014-08-29 16:51:33 +0200 | [diff] [blame] | 940 | #endif |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 941 | } |
| 942 | |
| 943 | static PyObject * |
| 944 | time_perf_counter(PyObject *self, PyObject *unused) |
| 945 | { |
| 946 | return perf_counter(NULL); |
| 947 | } |
| 948 | |
| 949 | PyDoc_STRVAR(perf_counter_doc, |
| 950 | "perf_counter() -> float\n\ |
| 951 | \n\ |
| 952 | Performance counter for benchmarking."); |
| 953 | |
| 954 | static PyObject* |
| 955 | py_process_time(_Py_clock_info_t *info) |
| 956 | { |
| 957 | #if defined(MS_WINDOWS) |
| 958 | HANDLE process; |
| 959 | FILETIME creation_time, exit_time, kernel_time, user_time; |
| 960 | ULARGE_INTEGER large; |
| 961 | double total; |
| 962 | BOOL ok; |
| 963 | |
| 964 | process = GetCurrentProcess(); |
| 965 | ok = GetProcessTimes(process, &creation_time, &exit_time, &kernel_time, &user_time); |
| 966 | if (!ok) |
| 967 | return PyErr_SetFromWindowsErr(0); |
| 968 | |
| 969 | large.u.LowPart = kernel_time.dwLowDateTime; |
| 970 | large.u.HighPart = kernel_time.dwHighDateTime; |
| 971 | total = (double)large.QuadPart; |
| 972 | large.u.LowPart = user_time.dwLowDateTime; |
| 973 | large.u.HighPart = user_time.dwHighDateTime; |
| 974 | total += (double)large.QuadPart; |
| 975 | if (info) { |
| 976 | info->implementation = "GetProcessTimes()"; |
| 977 | info->resolution = 1e-7; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 978 | info->monotonic = 1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 979 | info->adjustable = 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 980 | } |
| 981 | return PyFloat_FromDouble(total * 1e-7); |
| 982 | #else |
| 983 | |
| 984 | #if defined(HAVE_SYS_RESOURCE_H) |
| 985 | struct rusage ru; |
| 986 | #endif |
| 987 | #ifdef HAVE_TIMES |
| 988 | struct tms t; |
| 989 | static long ticks_per_second = -1; |
| 990 | #endif |
| 991 | |
| 992 | #if defined(HAVE_CLOCK_GETTIME) \ |
| 993 | && (defined(CLOCK_PROCESS_CPUTIME_ID) || defined(CLOCK_PROF)) |
| 994 | struct timespec tp; |
| 995 | #ifdef CLOCK_PROF |
| 996 | const clockid_t clk_id = CLOCK_PROF; |
| 997 | const char *function = "clock_gettime(CLOCK_PROF)"; |
| 998 | #else |
| 999 | const clockid_t clk_id = CLOCK_PROCESS_CPUTIME_ID; |
| 1000 | const char *function = "clock_gettime(CLOCK_PROCESS_CPUTIME_ID)"; |
| 1001 | #endif |
| 1002 | |
| 1003 | if (clock_gettime(clk_id, &tp) == 0) { |
| 1004 | if (info) { |
| 1005 | struct timespec res; |
| 1006 | info->implementation = function; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1007 | info->monotonic = 1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1008 | info->adjustable = 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1009 | if (clock_getres(clk_id, &res) == 0) |
| 1010 | info->resolution = res.tv_sec + res.tv_nsec * 1e-9; |
| 1011 | else |
| 1012 | info->resolution = 1e-9; |
| 1013 | } |
| 1014 | return PyFloat_FromDouble(tp.tv_sec + tp.tv_nsec * 1e-9); |
| 1015 | } |
| 1016 | #endif |
| 1017 | |
| 1018 | #if defined(HAVE_SYS_RESOURCE_H) |
| 1019 | if (getrusage(RUSAGE_SELF, &ru) == 0) { |
| 1020 | double total; |
| 1021 | total = ru.ru_utime.tv_sec + ru.ru_utime.tv_usec * 1e-6; |
| 1022 | total += ru.ru_stime.tv_sec + ru.ru_stime.tv_usec * 1e-6; |
| 1023 | if (info) { |
| 1024 | info->implementation = "getrusage(RUSAGE_SELF)"; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1025 | info->monotonic = 1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1026 | info->adjustable = 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1027 | info->resolution = 1e-6; |
| 1028 | } |
| 1029 | return PyFloat_FromDouble(total); |
| 1030 | } |
| 1031 | #endif |
| 1032 | |
| 1033 | #ifdef HAVE_TIMES |
| 1034 | if (times(&t) != (clock_t)-1) { |
| 1035 | double total; |
| 1036 | |
| 1037 | if (ticks_per_second == -1) { |
| 1038 | #if defined(HAVE_SYSCONF) && defined(_SC_CLK_TCK) |
| 1039 | ticks_per_second = sysconf(_SC_CLK_TCK); |
| 1040 | if (ticks_per_second < 1) |
| 1041 | ticks_per_second = -1; |
| 1042 | #elif defined(HZ) |
| 1043 | ticks_per_second = HZ; |
| 1044 | #else |
| 1045 | ticks_per_second = 60; /* magic fallback value; may be bogus */ |
| 1046 | #endif |
| 1047 | } |
| 1048 | |
| 1049 | if (ticks_per_second != -1) { |
| 1050 | total = (double)t.tms_utime / ticks_per_second; |
| 1051 | total += (double)t.tms_stime / ticks_per_second; |
| 1052 | if (info) { |
| 1053 | info->implementation = "times()"; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1054 | info->monotonic = 1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1055 | info->adjustable = 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1056 | info->resolution = 1.0 / ticks_per_second; |
| 1057 | } |
| 1058 | return PyFloat_FromDouble(total); |
| 1059 | } |
| 1060 | } |
| 1061 | #endif |
| 1062 | |
Victor Stinner | 53e22bf | 2016-07-08 17:55:01 +0200 | [diff] [blame] | 1063 | /* Currently, Python 3 requires clock() to build: see issue #22624 */ |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1064 | return floatclock(info); |
| 1065 | #endif |
| 1066 | } |
| 1067 | |
| 1068 | static PyObject * |
| 1069 | time_process_time(PyObject *self, PyObject *unused) |
| 1070 | { |
| 1071 | return py_process_time(NULL); |
| 1072 | } |
| 1073 | |
| 1074 | PyDoc_STRVAR(process_time_doc, |
| 1075 | "process_time() -> float\n\ |
| 1076 | \n\ |
| 1077 | Process time for profiling: sum of the kernel and user-space CPU time."); |
| 1078 | |
| 1079 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1080 | static PyObject * |
| 1081 | time_get_clock_info(PyObject *self, PyObject *args) |
| 1082 | { |
| 1083 | char *name; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1084 | _Py_clock_info_t info; |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1085 | PyObject *obj = NULL, *dict, *ns; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1086 | |
| 1087 | if (!PyArg_ParseTuple(args, "s:get_clock_info", &name)) |
| 1088 | return NULL; |
| 1089 | |
| 1090 | #ifdef Py_DEBUG |
| 1091 | info.implementation = NULL; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1092 | info.monotonic = -1; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1093 | info.adjustable = -1; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1094 | info.resolution = -1.0; |
| 1095 | #else |
| 1096 | info.implementation = ""; |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1097 | info.monotonic = 0; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1098 | info.adjustable = 0; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1099 | info.resolution = 1.0; |
| 1100 | #endif |
| 1101 | |
| 1102 | if (strcmp(name, "time") == 0) |
| 1103 | obj = floattime(&info); |
| 1104 | #ifdef PYCLOCK |
| 1105 | else if (strcmp(name, "clock") == 0) |
| 1106 | obj = pyclock(&info); |
| 1107 | #endif |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1108 | else if (strcmp(name, "monotonic") == 0) |
| 1109 | obj = pymonotonic(&info); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1110 | else if (strcmp(name, "perf_counter") == 0) |
| 1111 | obj = perf_counter(&info); |
| 1112 | else if (strcmp(name, "process_time") == 0) |
| 1113 | obj = py_process_time(&info); |
| 1114 | else { |
| 1115 | PyErr_SetString(PyExc_ValueError, "unknown clock"); |
| 1116 | return NULL; |
| 1117 | } |
| 1118 | if (obj == NULL) |
| 1119 | return NULL; |
| 1120 | Py_DECREF(obj); |
| 1121 | |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1122 | dict = PyDict_New(); |
| 1123 | if (dict == NULL) |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1124 | return NULL; |
| 1125 | |
| 1126 | assert(info.implementation != NULL); |
| 1127 | obj = PyUnicode_FromString(info.implementation); |
| 1128 | if (obj == NULL) |
| 1129 | goto error; |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1130 | if (PyDict_SetItemString(dict, "implementation", obj) == -1) |
| 1131 | goto error; |
| 1132 | Py_CLEAR(obj); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1133 | |
Benjamin Peterson | 49a69e4 | 2012-05-01 09:38:34 -0400 | [diff] [blame] | 1134 | assert(info.monotonic != -1); |
| 1135 | obj = PyBool_FromLong(info.monotonic); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1136 | if (obj == NULL) |
| 1137 | goto error; |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1138 | if (PyDict_SetItemString(dict, "monotonic", obj) == -1) |
| 1139 | goto error; |
| 1140 | Py_CLEAR(obj); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1141 | |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1142 | assert(info.adjustable != -1); |
| 1143 | obj = PyBool_FromLong(info.adjustable); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1144 | if (obj == NULL) |
| 1145 | goto error; |
Victor Stinner | 2b89fdf | 2012-06-12 22:46:37 +0200 | [diff] [blame] | 1146 | if (PyDict_SetItemString(dict, "adjustable", obj) == -1) |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1147 | goto error; |
| 1148 | Py_CLEAR(obj); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1149 | |
| 1150 | assert(info.resolution > 0.0); |
| 1151 | assert(info.resolution <= 1.0); |
| 1152 | obj = PyFloat_FromDouble(info.resolution); |
| 1153 | if (obj == NULL) |
| 1154 | goto error; |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1155 | if (PyDict_SetItemString(dict, "resolution", obj) == -1) |
| 1156 | goto error; |
| 1157 | Py_CLEAR(obj); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1158 | |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1159 | ns = _PyNamespace_New(dict); |
| 1160 | Py_DECREF(dict); |
| 1161 | return ns; |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1162 | |
| 1163 | error: |
Victor Stinner | bda4b88 | 2012-06-12 22:11:44 +0200 | [diff] [blame] | 1164 | Py_DECREF(dict); |
| 1165 | Py_XDECREF(obj); |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1166 | return NULL; |
| 1167 | } |
| 1168 | |
| 1169 | PyDoc_STRVAR(get_clock_info_doc, |
| 1170 | "get_clock_info(name: str) -> dict\n\ |
| 1171 | \n\ |
| 1172 | Get information of the specified clock."); |
Victor Stinner | 8b30201 | 2012-02-07 23:29:46 +0100 | [diff] [blame] | 1173 | |
Victor Stinner | 8f5cdfa | 2017-04-20 13:41:09 +0200 | [diff] [blame] | 1174 | #if !defined(HAVE_TZNAME) || defined(__GLIBC__) || defined(__CYGWIN__) |
Martin v. Löwis | d218dc1 | 2008-04-07 03:17:54 +0000 | [diff] [blame] | 1175 | static void |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 1176 | get_zone(char *zone, int n, struct tm *p) |
| 1177 | { |
| 1178 | #ifdef HAVE_STRUCT_TM_TM_ZONE |
| 1179 | strncpy(zone, p->tm_zone ? p->tm_zone : " ", n); |
| 1180 | #else |
| 1181 | tzset(); |
| 1182 | strftime(zone, n, "%Z", p); |
| 1183 | #endif |
| 1184 | } |
| 1185 | |
| 1186 | static int |
| 1187 | get_gmtoff(time_t t, struct tm *p) |
| 1188 | { |
| 1189 | #ifdef HAVE_STRUCT_TM_TM_ZONE |
| 1190 | return p->tm_gmtoff; |
| 1191 | #else |
| 1192 | return timegm(p) - t; |
| 1193 | #endif |
| 1194 | } |
Victor Stinner | 8f5cdfa | 2017-04-20 13:41:09 +0200 | [diff] [blame] | 1195 | #endif /* !defined(HAVE_TZNAME) || defined(__GLIBC__) || defined(__CYGWIN__) */ |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 1196 | |
| 1197 | static void |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1198 | PyInit_timezone(PyObject *m) { |
| 1199 | /* This code moved from PyInit_time wholesale to allow calling it from |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1200 | time_tzset. In the future, some parts of it can be moved back |
| 1201 | (for platforms that don't HAVE_WORKING_TZSET, when we know what they |
| 1202 | are), and the extraneous calls to tzset(3) should be removed. |
| 1203 | I haven't done this yet, as I don't want to change this code as |
| 1204 | little as possible when introducing the time.tzset and time.tzsetwall |
| 1205 | methods. This should simply be a method of doing the following once, |
| 1206 | at the top of this function and removing the call to tzset() from |
| 1207 | time_tzset(): |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1208 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1209 | #ifdef HAVE_TZSET |
| 1210 | tzset() |
| 1211 | #endif |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1212 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1213 | And I'm lazy and hate C so nyer. |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1214 | */ |
Guido van Rossum | 10b164a | 2001-09-25 13:59:01 +0000 | [diff] [blame] | 1215 | #if defined(HAVE_TZNAME) && !defined(__GLIBC__) && !defined(__CYGWIN__) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1216 | PyObject *otz0, *otz1; |
| 1217 | tzset(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1218 | PyModule_AddIntConstant(m, "timezone", timezone); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1219 | #ifdef HAVE_ALTZONE |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1220 | PyModule_AddIntConstant(m, "altzone", altzone); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1221 | #else |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1222 | PyModule_AddIntConstant(m, "altzone", timezone-3600); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1223 | #endif |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1224 | PyModule_AddIntConstant(m, "daylight", daylight); |
Victor Stinner | 1b57967 | 2011-12-17 05:47:23 +0100 | [diff] [blame] | 1225 | otz0 = PyUnicode_DecodeLocale(tzname[0], "surrogateescape"); |
| 1226 | otz1 = PyUnicode_DecodeLocale(tzname[1], "surrogateescape"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1227 | PyModule_AddObject(m, "tzname", Py_BuildValue("(NN)", otz0, otz1)); |
Guido van Rossum | 10b164a | 2001-09-25 13:59:01 +0000 | [diff] [blame] | 1228 | #else /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1229 | { |
Guido van Rossum | 234f942 | 1993-06-17 12:35:49 +0000 | [diff] [blame] | 1230 | #define YEAR ((time_t)((365 * 24 + 6) * 3600)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1231 | time_t t; |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 1232 | struct tm p; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1233 | long janzone, julyzone; |
| 1234 | char janname[10], julyname[10]; |
| 1235 | t = (time((time_t *)0) / YEAR) * YEAR; |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 1236 | _PyTime_localtime(t, &p); |
| 1237 | get_zone(janname, 9, &p); |
| 1238 | janzone = -get_gmtoff(t, &p); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1239 | janname[9] = '\0'; |
| 1240 | t += YEAR/2; |
Alexander Belopolsky | 3e7a3cb | 2016-09-28 17:31:35 -0400 | [diff] [blame] | 1241 | _PyTime_localtime(t, &p); |
| 1242 | get_zone(julyname, 9, &p); |
| 1243 | julyzone = -get_gmtoff(t, &p); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1244 | julyname[9] = '\0'; |
Guido van Rossum | 10b164a | 2001-09-25 13:59:01 +0000 | [diff] [blame] | 1245 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1246 | if( janzone < julyzone ) { |
| 1247 | /* DST is reversed in the southern hemisphere */ |
| 1248 | PyModule_AddIntConstant(m, "timezone", julyzone); |
| 1249 | PyModule_AddIntConstant(m, "altzone", janzone); |
| 1250 | PyModule_AddIntConstant(m, "daylight", |
| 1251 | janzone != julyzone); |
| 1252 | PyModule_AddObject(m, "tzname", |
| 1253 | Py_BuildValue("(zz)", |
| 1254 | julyname, janname)); |
| 1255 | } else { |
| 1256 | PyModule_AddIntConstant(m, "timezone", janzone); |
| 1257 | PyModule_AddIntConstant(m, "altzone", julyzone); |
| 1258 | PyModule_AddIntConstant(m, "daylight", |
| 1259 | janzone != julyzone); |
| 1260 | PyModule_AddObject(m, "tzname", |
| 1261 | Py_BuildValue("(zz)", |
| 1262 | janname, julyname)); |
| 1263 | } |
| 1264 | } |
Tim Peters | 26ae7cd | 2001-03-20 03:26:49 +0000 | [diff] [blame] | 1265 | #ifdef __CYGWIN__ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1266 | tzset(); |
| 1267 | PyModule_AddIntConstant(m, "timezone", _timezone); |
| 1268 | PyModule_AddIntConstant(m, "altzone", _timezone-3600); |
| 1269 | PyModule_AddIntConstant(m, "daylight", _daylight); |
| 1270 | PyModule_AddObject(m, "tzname", |
| 1271 | Py_BuildValue("(zz)", _tzname[0], _tzname[1])); |
Tim Peters | 26ae7cd | 2001-03-20 03:26:49 +0000 | [diff] [blame] | 1272 | #endif /* __CYGWIN__ */ |
Guido van Rossum | 10b164a | 2001-09-25 13:59:01 +0000 | [diff] [blame] | 1273 | #endif /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/ |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1274 | } |
| 1275 | |
| 1276 | |
| 1277 | static PyMethodDef time_methods[] = { |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 1278 | {"time", time_time, METH_NOARGS, time_doc}, |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1279 | #ifdef PYCLOCK |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 1280 | {"clock", time_clock, METH_NOARGS, clock_doc}, |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1281 | #endif |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 1282 | #ifdef HAVE_CLOCK_GETTIME |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 1283 | {"clock_gettime", time_clock_gettime, METH_VARARGS, clock_gettime_doc}, |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 1284 | #endif |
| 1285 | #ifdef HAVE_CLOCK_SETTIME |
Victor Stinner | 30d7947 | 2012-04-03 00:45:07 +0200 | [diff] [blame] | 1286 | {"clock_settime", time_clock_settime, METH_VARARGS, clock_settime_doc}, |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 1287 | #endif |
| 1288 | #ifdef HAVE_CLOCK_GETRES |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 1289 | {"clock_getres", time_clock_getres, METH_VARARGS, clock_getres_doc}, |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 1290 | #endif |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1291 | {"sleep", time_sleep, METH_O, sleep_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1292 | {"gmtime", time_gmtime, METH_VARARGS, gmtime_doc}, |
| 1293 | {"localtime", time_localtime, METH_VARARGS, localtime_doc}, |
| 1294 | {"asctime", time_asctime, METH_VARARGS, asctime_doc}, |
| 1295 | {"ctime", time_ctime, METH_VARARGS, ctime_doc}, |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1296 | #ifdef HAVE_MKTIME |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 1297 | {"mktime", time_mktime, METH_O, mktime_doc}, |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1298 | #endif |
| 1299 | #ifdef HAVE_STRFTIME |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1300 | {"strftime", time_strftime, METH_VARARGS, strftime_doc}, |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1301 | #endif |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1302 | {"strptime", time_strptime, METH_VARARGS, strptime_doc}, |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1303 | #ifdef HAVE_WORKING_TZSET |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1304 | {"tzset", time_tzset, METH_NOARGS, tzset_doc}, |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1305 | #endif |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1306 | {"monotonic", time_monotonic, METH_NOARGS, monotonic_doc}, |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1307 | {"process_time", time_process_time, METH_NOARGS, process_time_doc}, |
| 1308 | {"perf_counter", time_perf_counter, METH_NOARGS, perf_counter_doc}, |
| 1309 | {"get_clock_info", time_get_clock_info, METH_VARARGS, get_clock_info_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1310 | {NULL, NULL} /* sentinel */ |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1311 | }; |
| 1312 | |
| 1313 | |
| 1314 | PyDoc_STRVAR(module_doc, |
| 1315 | "This module provides various functions to manipulate time values.\n\ |
| 1316 | \n\ |
| 1317 | There are two standard representations of time. One is the number\n\ |
| 1318 | of seconds since the Epoch, in UTC (a.k.a. GMT). It may be an integer\n\ |
| 1319 | or a floating point number (to represent fractions of seconds).\n\ |
| 1320 | The Epoch is system-defined; on Unix, it is generally January 1st, 1970.\n\ |
| 1321 | The actual value can be retrieved by calling gmtime(0).\n\ |
| 1322 | \n\ |
| 1323 | The other representation is a tuple of 9 integers giving local time.\n\ |
| 1324 | The tuple items are:\n\ |
Alexander Belopolsky | 03163ac | 2011-05-02 12:20:52 -0400 | [diff] [blame] | 1325 | year (including century, e.g. 1998)\n\ |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1326 | month (1-12)\n\ |
| 1327 | day (1-31)\n\ |
| 1328 | hours (0-23)\n\ |
| 1329 | minutes (0-59)\n\ |
| 1330 | seconds (0-59)\n\ |
| 1331 | weekday (0-6, Monday is 0)\n\ |
| 1332 | Julian day (day in the year, 1-366)\n\ |
| 1333 | DST (Daylight Savings Time) flag (-1, 0 or 1)\n\ |
| 1334 | If the DST flag is 0, the time is given in the regular time zone;\n\ |
| 1335 | if it is 1, the time is given in the DST time zone;\n\ |
| 1336 | if it is -1, mktime() should guess based on the date and time.\n\ |
| 1337 | \n\ |
| 1338 | Variables:\n\ |
| 1339 | \n\ |
| 1340 | timezone -- difference in seconds between UTC and local standard time\n\ |
| 1341 | altzone -- difference in seconds between UTC and local DST time\n\ |
| 1342 | daylight -- whether local time should reflect DST\n\ |
| 1343 | tzname -- tuple of (standard time zone name, DST time zone name)\n\ |
| 1344 | \n\ |
| 1345 | Functions:\n\ |
| 1346 | \n\ |
| 1347 | time() -- return current time in seconds since the Epoch as a float\n\ |
| 1348 | clock() -- return CPU time since process start as a float\n\ |
| 1349 | sleep() -- delay for a number of seconds given as a float\n\ |
| 1350 | gmtime() -- convert seconds since Epoch to UTC tuple\n\ |
| 1351 | localtime() -- convert seconds since Epoch to local time tuple\n\ |
| 1352 | asctime() -- convert time tuple to string\n\ |
| 1353 | ctime() -- convert time in seconds to string\n\ |
| 1354 | mktime() -- convert local time tuple to seconds since Epoch\n\ |
| 1355 | strftime() -- convert time tuple to string according to format specification\n\ |
| 1356 | strptime() -- parse string to time tuple according to format specification\n\ |
| 1357 | tzset() -- change the local timezone"); |
| 1358 | |
| 1359 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1360 | |
| 1361 | static struct PyModuleDef timemodule = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1362 | PyModuleDef_HEAD_INIT, |
| 1363 | "time", |
| 1364 | module_doc, |
| 1365 | -1, |
| 1366 | time_methods, |
| 1367 | NULL, |
| 1368 | NULL, |
| 1369 | NULL, |
| 1370 | NULL |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1371 | }; |
| 1372 | |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1373 | PyMODINIT_FUNC |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1374 | PyInit_time(void) |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1375 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1376 | PyObject *m; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1377 | m = PyModule_Create(&timemodule); |
| 1378 | if (m == NULL) |
| 1379 | return NULL; |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1380 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1381 | /* Set, or reset, module variables like time.timezone */ |
| 1382 | PyInit_timezone(m); |
Guido van Rossum | d11b62e | 2003-03-14 21:51:36 +0000 | [diff] [blame] | 1383 | |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 1384 | #ifdef CLOCK_REALTIME |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 1385 | PyModule_AddIntMacro(m, CLOCK_REALTIME); |
Benjamin Peterson | 37098cd | 2016-09-13 22:55:09 -0700 | [diff] [blame] | 1386 | #endif |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 1387 | #ifdef CLOCK_MONOTONIC |
| 1388 | PyModule_AddIntMacro(m, CLOCK_MONOTONIC); |
| 1389 | #endif |
| 1390 | #ifdef CLOCK_MONOTONIC_RAW |
| 1391 | PyModule_AddIntMacro(m, CLOCK_MONOTONIC_RAW); |
| 1392 | #endif |
| 1393 | #ifdef CLOCK_HIGHRES |
| 1394 | PyModule_AddIntMacro(m, CLOCK_HIGHRES); |
| 1395 | #endif |
| 1396 | #ifdef CLOCK_PROCESS_CPUTIME_ID |
| 1397 | PyModule_AddIntMacro(m, CLOCK_PROCESS_CPUTIME_ID); |
| 1398 | #endif |
| 1399 | #ifdef CLOCK_THREAD_CPUTIME_ID |
| 1400 | PyModule_AddIntMacro(m, CLOCK_THREAD_CPUTIME_ID); |
| 1401 | #endif |
Alexander Belopolsky | 18f3a9b | 2016-09-11 22:55:16 -0400 | [diff] [blame] | 1402 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1403 | if (!initialized) { |
Victor Stinner | 1c8f059 | 2013-07-22 22:24:54 +0200 | [diff] [blame] | 1404 | if (PyStructSequence_InitType2(&StructTimeType, |
| 1405 | &struct_time_type_desc) < 0) |
| 1406 | return NULL; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1407 | } |
| 1408 | Py_INCREF(&StructTimeType); |
Alexander Belopolsky | c142bba | 2012-06-13 22:15:26 -0400 | [diff] [blame] | 1409 | PyModule_AddIntConstant(m, "_STRUCT_TM_ITEMS", 11); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1410 | PyModule_AddObject(m, "struct_time", (PyObject*) &StructTimeType); |
| 1411 | initialized = 1; |
| 1412 | return m; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1413 | } |
| 1414 | |
Victor Stinner | 071eca3 | 2012-03-15 01:17:09 +0100 | [diff] [blame] | 1415 | static PyObject* |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1416 | floattime(_Py_clock_info_t *info) |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 1417 | { |
Victor Stinner | a47b881 | 2015-03-27 18:16:17 +0100 | [diff] [blame] | 1418 | _PyTime_t t; |
| 1419 | double d; |
| 1420 | if (_PyTime_GetSystemClockWithInfo(&t, info) < 0) { |
Victor Stinner | 0011124 | 2014-08-29 16:31:59 +0200 | [diff] [blame] | 1421 | assert(info != NULL); |
| 1422 | return NULL; |
| 1423 | } |
Victor Stinner | a47b881 | 2015-03-27 18:16:17 +0100 | [diff] [blame] | 1424 | d = _PyTime_AsSecondsDouble(t); |
| 1425 | return PyFloat_FromDouble(d); |
Victor Stinner | 4195b5c | 2012-02-08 23:03:19 +0100 | [diff] [blame] | 1426 | } |
| 1427 | |
| 1428 | |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1429 | /* Implement pysleep() for various platforms. |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1430 | When interrupted (or when another error occurs), return -1 and |
| 1431 | set an exception; else return 0. */ |
| 1432 | |
| 1433 | static int |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1434 | pysleep(_PyTime_t secs) |
Guido van Rossum | 426035c | 1991-02-19 12:27:35 +0000 | [diff] [blame] | 1435 | { |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1436 | _PyTime_t deadline, monotonic; |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1437 | #ifndef MS_WINDOWS |
| 1438 | struct timeval timeout; |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1439 | int err = 0; |
| 1440 | #else |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1441 | _PyTime_t millisecs; |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1442 | unsigned long ul_millis; |
| 1443 | DWORD rc; |
| 1444 | HANDLE hInterruptEvent; |
Victor Stinner | 0c2fd89 | 2015-03-17 10:49:17 +0100 | [diff] [blame] | 1445 | #endif |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1446 | |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1447 | deadline = _PyTime_GetMonotonicClock() + secs; |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1448 | |
| 1449 | do { |
| 1450 | #ifndef MS_WINDOWS |
Victor Stinner | 869e177 | 2015-03-30 03:49:14 +0200 | [diff] [blame] | 1451 | if (_PyTime_AsTimeval(secs, &timeout, _PyTime_ROUND_CEILING) < 0) |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1452 | return -1; |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1453 | |
| 1454 | Py_BEGIN_ALLOW_THREADS |
| 1455 | err = select(0, (fd_set *)0, (fd_set *)0, (fd_set *)0, &timeout); |
| 1456 | Py_END_ALLOW_THREADS |
| 1457 | |
| 1458 | if (err == 0) |
| 1459 | break; |
| 1460 | |
| 1461 | if (errno != EINTR) { |
Victor Stinner | 0c2fd89 | 2015-03-17 10:49:17 +0100 | [diff] [blame] | 1462 | PyErr_SetFromErrno(PyExc_OSError); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1463 | return -1; |
| 1464 | } |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1465 | #else |
Victor Stinner | 869e177 | 2015-03-30 03:49:14 +0200 | [diff] [blame] | 1466 | millisecs = _PyTime_AsMilliseconds(secs, _PyTime_ROUND_CEILING); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1467 | if (millisecs > (double)ULONG_MAX) { |
| 1468 | PyErr_SetString(PyExc_OverflowError, |
| 1469 | "sleep length is too large"); |
| 1470 | return -1; |
| 1471 | } |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1472 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1473 | /* Allow sleep(0) to maintain win32 semantics, and as decreed |
| 1474 | * by Guido, only the main thread can be interrupted. |
| 1475 | */ |
| 1476 | ul_millis = (unsigned long)millisecs; |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1477 | if (ul_millis == 0 || !_PyOS_IsMainThread()) { |
| 1478 | Py_BEGIN_ALLOW_THREADS |
Victor Stinner | 0eac130 | 2015-03-20 03:06:12 +0100 | [diff] [blame] | 1479 | Sleep(ul_millis); |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1480 | Py_END_ALLOW_THREADS |
| 1481 | break; |
Victor Stinner | 945c82e | 2015-03-12 16:19:01 +0100 | [diff] [blame] | 1482 | } |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1483 | |
| 1484 | hInterruptEvent = _PyOS_SigintEvent(); |
| 1485 | ResetEvent(hInterruptEvent); |
| 1486 | |
| 1487 | Py_BEGIN_ALLOW_THREADS |
| 1488 | rc = WaitForSingleObjectEx(hInterruptEvent, ul_millis, FALSE); |
Victor Stinner | 0c2fd89 | 2015-03-17 10:49:17 +0100 | [diff] [blame] | 1489 | Py_END_ALLOW_THREADS |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1490 | |
| 1491 | if (rc != WAIT_OBJECT_0) |
| 1492 | break; |
Victor Stinner | 945c82e | 2015-03-12 16:19:01 +0100 | [diff] [blame] | 1493 | #endif |
Victor Stinner | 0c2fd89 | 2015-03-17 10:49:17 +0100 | [diff] [blame] | 1494 | |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1495 | /* sleep was interrupted by SIGINT */ |
| 1496 | if (PyErr_CheckSignals()) |
| 1497 | return -1; |
| 1498 | |
Victor Stinner | cb29f01 | 2015-03-27 13:31:18 +0100 | [diff] [blame] | 1499 | monotonic = _PyTime_GetMonotonicClock(); |
| 1500 | secs = deadline - monotonic; |
Victor Stinner | 6aa446c | 2015-03-30 21:33:51 +0200 | [diff] [blame] | 1501 | if (secs < 0) |
Victor Stinner | 79d68f9 | 2015-03-19 21:54:09 +0100 | [diff] [blame] | 1502 | break; |
| 1503 | /* retry with the recomputed delay */ |
| 1504 | } while (1); |
| 1505 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1506 | return 0; |
Guido van Rossum | 80c9d88 | 1991-04-16 08:47:51 +0000 | [diff] [blame] | 1507 | } |