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