blob: 29a2f2dc998c29d7e6e20a09db9c0135a6778a27 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Time module */
3
Barry Warsaw9a2a8a81996-12-06 23:32:14 +00004#include "Python.h"
Alexander Belopolsky6fc4ade2010-08-05 17:34:27 +00005#include "_time.h"
Guido van Rossum3f5da241990-12-20 15:06:42 +00006
Martin v. Löwis8a7c8662007-08-30 15:40:24 +00007#define TZNAME_ENCODING "utf-8"
8
Guido van Rossum87ce7bb1998-06-09 16:30:31 +00009#include <ctype.h>
10
Thomas Wouters0e3f5912006-08-11 14:57:12 +000011#ifdef HAVE_SYS_TYPES_H
Guido van Rossumb6775db1994-08-01 11:34:53 +000012#include <sys/types.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000013#endif /* HAVE_SYS_TYPES_H */
Guido van Rossum6d946f91992-08-14 13:49:30 +000014
Guido van Rossumb6775db1994-08-01 11:34:53 +000015#ifdef QUICKWIN
16#include <io.h>
17#endif
18
Guido van Rossum7bf22de1997-12-02 20:34:19 +000019#if defined(__WATCOMC__) && !defined(__QNX__)
Guido van Rossumbceeac81996-05-23 22:53:47 +000020#include <i86.h>
21#else
Guido van Rossumcac6c721996-09-06 13:34:02 +000022#ifdef MS_WINDOWS
Mark Hammond975e3922002-07-16 01:29:19 +000023#define WIN32_LEAN_AND_MEAN
Guido van Rossum258ccd42001-03-02 06:53:29 +000024#include <windows.h>
Mark Hammond975e3922002-07-16 01:29:19 +000025#include "pythread.h"
26
27/* helper to allow us to interrupt sleep() on Windows*/
28static HANDLE hInterruptEvent = NULL;
29static BOOL WINAPI PyCtrlHandler(DWORD dwCtrlType)
30{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000031 SetEvent(hInterruptEvent);
32 /* allow other default handlers to be called.
33 Default Python handler will setup the
34 KeyboardInterrupt exception.
35 */
36 return FALSE;
Mark Hammond975e3922002-07-16 01:29:19 +000037}
38static long main_thread;
39
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000040#if defined(__BORLANDC__)
Guido van Rossumb2fb3641996-09-07 00:47:35 +000041/* These overrides not needed for Win32 */
Guido van Rossumb6775db1994-08-01 11:34:53 +000042#define timezone _timezone
Guido van Rossumcc081121995-03-14 15:05:41 +000043#define tzname _tzname
44#define daylight _daylight
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000045#endif /* __BORLANDC__ */
Guido van Rossumcac6c721996-09-06 13:34:02 +000046#endif /* MS_WINDOWS */
Guido van Rossum7bf22de1997-12-02 20:34:19 +000047#endif /* !__WATCOMC__ || __QNX__ */
Guido van Rossum234f9421993-06-17 12:35:49 +000048
Thomas Wouters477c8d52006-05-27 19:21:47 +000049#if defined(MS_WINDOWS) && !defined(__BORLANDC__)
50/* Win32 has better clock replacement; we have our own version below. */
51#undef HAVE_CLOCK
Martin v. Löwis3bb00702007-08-30 14:37:48 +000052#undef TZNAME_ENCODING
53#define TZNAME_ENCODING "mbcs"
Thomas Wouters477c8d52006-05-27 19:21:47 +000054#endif /* MS_WINDOWS && !defined(__BORLANDC__) */
Guido van Rossum3917c221997-04-02 05:35:28 +000055
Andrew MacIntyre7bf68332002-03-03 02:59:16 +000056#if defined(PYOS_OS2)
57#define INCL_DOS
58#define INCL_ERRORS
59#include <os2.h>
60#endif
61
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +000062#if defined(PYCC_VACPP)
Guido van Rossum26452411998-09-28 22:07:11 +000063#include <sys/time.h>
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +000064#endif
65
Guido van Rossum234f9421993-06-17 12:35:49 +000066/* Forward declarations */
Tim Petersdbd9ba62000-07-09 03:09:57 +000067static int floatsleep(double);
Thomas Woutersed77bac2000-07-24 15:26:39 +000068static double floattime(void);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000069
Guido van Rossumcfbaecc1998-08-25 14:51:12 +000070/* For Y2K check */
71static PyObject *moddict;
72
Barry Warsaw9a2a8a81996-12-06 23:32:14 +000073static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +000074time_time(PyObject *self, PyObject *unused)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000075{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000076 double secs;
77 secs = floattime();
78 if (secs == 0.0) {
79 PyErr_SetFromErrno(PyExc_IOError);
80 return NULL;
81 }
82 return PyFloat_FromDouble(secs);
Guido van Rossumb6775db1994-08-01 11:34:53 +000083}
84
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000085PyDoc_STRVAR(time_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +000086"time() -> floating point number\n\
87\n\
88Return the current time in seconds since the Epoch.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000089Fractions of a second may be present if the system clock provides them.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +000090
Guido van Rossumb6775db1994-08-01 11:34:53 +000091#ifdef HAVE_CLOCK
92
93#ifndef CLOCKS_PER_SEC
Guido van Rossum1b66a4f1996-02-25 04:50:33 +000094#ifdef CLK_TCK
95#define CLOCKS_PER_SEC CLK_TCK
96#else
Guido van Rossumb6775db1994-08-01 11:34:53 +000097#define CLOCKS_PER_SEC 1000000
98#endif
Guido van Rossum1b66a4f1996-02-25 04:50:33 +000099#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000100
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000101static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000102time_clock(PyObject *self, PyObject *unused)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000103{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000104 return PyFloat_FromDouble(((double)clock()) / CLOCKS_PER_SEC);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000105}
Guido van Rossumb6775db1994-08-01 11:34:53 +0000106#endif /* HAVE_CLOCK */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000107
Thomas Wouters477c8d52006-05-27 19:21:47 +0000108#if defined(MS_WINDOWS) && !defined(__BORLANDC__)
Mark Hammond7ba5e812002-02-12 04:02:33 +0000109/* Due to Mark Hammond and Tim Peters */
Guido van Rossum3917c221997-04-02 05:35:28 +0000110static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000111time_clock(PyObject *self, PyObject *unused)
Guido van Rossum3917c221997-04-02 05:35:28 +0000112{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000113 static LARGE_INTEGER ctrStart;
114 static double divisor = 0.0;
115 LARGE_INTEGER now;
116 double diff;
Guido van Rossum3917c221997-04-02 05:35:28 +0000117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000118 if (divisor == 0.0) {
119 LARGE_INTEGER freq;
120 QueryPerformanceCounter(&ctrStart);
121 if (!QueryPerformanceFrequency(&freq) || freq.QuadPart == 0) {
122 /* Unlikely to happen - this works on all intel
123 machines at least! Revert to clock() */
124 return PyFloat_FromDouble(((double)clock()) /
125 CLOCKS_PER_SEC);
126 }
127 divisor = (double)freq.QuadPart;
128 }
129 QueryPerformanceCounter(&now);
130 diff = (double)(now.QuadPart - ctrStart.QuadPart);
131 return PyFloat_FromDouble(diff / divisor);
Guido van Rossum3917c221997-04-02 05:35:28 +0000132}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000133
Guido van Rossum3917c221997-04-02 05:35:28 +0000134#define HAVE_CLOCK /* So it gets included in the methods */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000135#endif /* MS_WINDOWS && !defined(__BORLANDC__) */
Guido van Rossum3917c221997-04-02 05:35:28 +0000136
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000137#ifdef HAVE_CLOCK
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000138PyDoc_STRVAR(clock_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000139"clock() -> floating point number\n\
140\n\
141Return the CPU time or real time since the start of the process or since\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000142the first call to clock(). This has as much precision as the system\n\
143records.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000144#endif
145
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000146static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000147time_sleep(PyObject *self, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000148{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000149 double secs;
150 if (!PyArg_ParseTuple(args, "d:sleep", &secs))
151 return NULL;
152 if (floatsleep(secs) != 0)
153 return NULL;
154 Py_INCREF(Py_None);
155 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000156}
157
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000158PyDoc_STRVAR(sleep_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000159"sleep(seconds)\n\
160\n\
161Delay execution for a given number of seconds. The argument may be\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000162a floating point number for subsecond precision.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000163
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000164static PyStructSequence_Field struct_time_type_fields[] = {
Alexander Belopolsky69f3fd02010-06-05 15:04:51 +0000165 {"tm_year", "year, for example, 1993"},
166 {"tm_mon", "month of year, range [1, 12]"},
167 {"tm_mday", "day of month, range [1, 31]"},
168 {"tm_hour", "hours, range [0, 23]"},
169 {"tm_min", "minutes, range [0, 59]"},
170 {"tm_sec", "seconds, range [0, 61])"},
171 {"tm_wday", "day of week, range [0, 6], Monday is 0"},
172 {"tm_yday", "day of year, range [1, 366]"},
173 {"tm_isdst", "1 if summer time is in effect, 0 if not, and -1 if unknown"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000174 {0}
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000175};
176
177static PyStructSequence_Desc struct_time_type_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000178 "time.struct_time",
Alexander Belopolsky69f3fd02010-06-05 15:04:51 +0000179 "The time value as returned by gmtime(), localtime(), and strptime(), and\n"
180 " accepted by asctime(), mktime() and strftime(). May be considered as a\n"
181 " sequence of 9 integers.\n\n"
182 " Note that several fields' values are not the same as those defined by\n"
183 " the C language standard for struct tm. For example, the value of the\n"
184 " field tm_year is the actual year, not year - 1900. See individual\n"
185 " fields' descriptions for details.",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 struct_time_type_fields,
187 9,
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000188};
Tim Peters9ad4b682002-02-13 05:14:18 +0000189
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000190static int initialized;
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000191static PyTypeObject StructTimeType;
192
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000193static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000194tmtotuple(struct tm *p)
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000195{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000196 PyObject *v = PyStructSequence_New(&StructTimeType);
197 if (v == NULL)
198 return NULL;
Tim Peters9ad4b682002-02-13 05:14:18 +0000199
Christian Heimes217cfd12007-12-02 14:31:20 +0000200#define SET(i,val) PyStructSequence_SET_ITEM(v, i, PyLong_FromLong((long) val))
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000201
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000202 SET(0, p->tm_year + 1900);
203 SET(1, p->tm_mon + 1); /* Want January == 1 */
204 SET(2, p->tm_mday);
205 SET(3, p->tm_hour);
206 SET(4, p->tm_min);
207 SET(5, p->tm_sec);
208 SET(6, (p->tm_wday + 6) % 7); /* Want Monday == 0 */
209 SET(7, p->tm_yday + 1); /* Want January, 1 == 1 */
210 SET(8, p->tm_isdst);
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000211#undef SET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000212 if (PyErr_Occurred()) {
213 Py_XDECREF(v);
214 return NULL;
215 }
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000216
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000217 return v;
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000218}
219
220static PyObject *
Skip Montanaro41cfce92007-08-24 21:11:00 +0000221structtime_totuple(PyObject *t)
222{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000223 PyObject *x = NULL;
224 unsigned int i;
225 PyObject *v = PyTuple_New(9);
226 if (v == NULL)
227 return NULL;
Skip Montanaro41cfce92007-08-24 21:11:00 +0000228
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000229 for (i=0; i<9; i++) {
230 x = PyStructSequence_GET_ITEM(t, i);
231 Py_INCREF(x);
232 PyTuple_SET_ITEM(v, i, x);
233 }
Skip Montanaro41cfce92007-08-24 21:11:00 +0000234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000235 if (PyErr_Occurred()) {
236 Py_XDECREF(v);
237 return NULL;
238 }
Skip Montanaro41cfce92007-08-24 21:11:00 +0000239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000240 return v;
Skip Montanaro41cfce92007-08-24 21:11:00 +0000241}
242
243static PyObject *
Brett Cannon298c3802004-06-19 20:48:43 +0000244time_convert(double when, struct tm * (*function)(const time_t *))
Guido van Rossum234f9421993-06-17 12:35:49 +0000245{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000246 struct tm *p;
247 time_t whent = _PyTime_DoubleToTimet(when);
Brett Cannon298c3802004-06-19 20:48:43 +0000248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000249 if (whent == (time_t)-1 && PyErr_Occurred())
250 return NULL;
251 errno = 0;
252 p = function(&whent);
253 if (p == NULL) {
Guido van Rossum6e8583d1996-10-08 14:19:52 +0000254#ifdef EINVAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000255 if (errno == 0)
256 errno = EINVAL;
Guido van Rossum6e8583d1996-10-08 14:19:52 +0000257#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000258 return PyErr_SetFromErrno(PyExc_ValueError);
259 }
260 return tmtotuple(p);
Guido van Rossum234f9421993-06-17 12:35:49 +0000261}
262
Fred Drakef901abd2004-08-03 17:58:55 +0000263/* Parse arg tuple that can contain an optional float-or-None value;
264 format needs to be "|O:name".
265 Returns non-zero on success (parallels PyArg_ParseTuple).
266*/
267static int
268parse_time_double_args(PyObject *args, char *format, double *pwhen)
269{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000270 PyObject *ot = NULL;
Fred Drakef901abd2004-08-03 17:58:55 +0000271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000272 if (!PyArg_ParseTuple(args, format, &ot))
273 return 0;
274 if (ot == NULL || ot == Py_None)
275 *pwhen = floattime();
276 else {
277 double when = PyFloat_AsDouble(ot);
278 if (PyErr_Occurred())
279 return 0;
280 *pwhen = when;
281 }
282 return 1;
Fred Drakef901abd2004-08-03 17:58:55 +0000283}
284
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000285static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000286time_gmtime(PyObject *self, PyObject *args)
Guido van Rossum234f9421993-06-17 12:35:49 +0000287{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000288 double when;
289 if (!parse_time_double_args(args, "|O:gmtime", &when))
290 return NULL;
291 return time_convert(when, gmtime);
Guido van Rossum234f9421993-06-17 12:35:49 +0000292}
293
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000294PyDoc_STRVAR(gmtime_doc,
Christian Heimes9a371592007-12-28 14:08:13 +0000295"gmtime([seconds]) -> (tm_year, tm_mon, tm_mday, tm_hour, tm_min,\n\
Fred Drake193a3f62002-03-12 21:38:49 +0000296 tm_sec, tm_wday, tm_yday, tm_isdst)\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000297\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000298Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000299GMT). When 'seconds' is not passed in, convert the current time instead.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000300
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000301static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000302time_localtime(PyObject *self, PyObject *args)
Guido van Rossum234f9421993-06-17 12:35:49 +0000303{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000304 double when;
305 if (!parse_time_double_args(args, "|O:localtime", &when))
306 return NULL;
307 return time_convert(when, localtime);
Guido van Rossum234f9421993-06-17 12:35:49 +0000308}
309
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000310PyDoc_STRVAR(localtime_doc,
Christian Heimes9a371592007-12-28 14:08:13 +0000311"localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,\n\
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000312 tm_sec,tm_wday,tm_yday,tm_isdst)\n\
Martin v. Löwisb3cfc1d2001-12-02 12:27:43 +0000313\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000314Convert seconds since the Epoch to a time tuple expressing local time.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000315When 'seconds' is not passed in, convert the current time instead.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000316
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000317/* Convert 9-item tuple to tm structure. Return 1 on success, set
318 * an exception and return 0 on error.
319 */
Guido van Rossum9e90a671993-06-24 11:10:19 +0000320static int
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000321gettmarg(PyObject *args, struct tm *p)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000322{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000323 int y;
324 PyObject *t = NULL;
Guido van Rossumcfbaecc1998-08-25 14:51:12 +0000325
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 memset((void *) p, '\0', sizeof(struct tm));
Guido van Rossumb9081262007-08-25 03:14:09 +0000327
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000328 if (PyTuple_Check(args)) {
329 t = args;
330 Py_INCREF(t);
331 }
332 else if (Py_TYPE(args) == &StructTimeType) {
333 t = structtime_totuple(args);
334 }
335 else {
336 PyErr_SetString(PyExc_TypeError,
337 "Tuple or struct_time argument required");
338 return 0;
339 }
Skip Montanaro41cfce92007-08-24 21:11:00 +0000340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000341 if (t == NULL || !PyArg_ParseTuple(t, "iiiiiiiii",
342 &y,
343 &p->tm_mon,
344 &p->tm_mday,
345 &p->tm_hour,
346 &p->tm_min,
347 &p->tm_sec,
348 &p->tm_wday,
349 &p->tm_yday,
350 &p->tm_isdst)) {
351 Py_XDECREF(t);
352 return 0;
353 }
354 Py_DECREF(t);
Skip Montanaro41cfce92007-08-24 21:11:00 +0000355
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000356 if (y < 1900) {
357 PyObject *accept = PyDict_GetItemString(moddict,
358 "accept2dyear");
359 if (accept == NULL || !PyLong_CheckExact(accept) ||
360 !PyObject_IsTrue(accept)) {
361 PyErr_SetString(PyExc_ValueError,
362 "year >= 1900 required");
363 return 0;
364 }
365 if (69 <= y && y <= 99)
366 y += 1900;
367 else if (0 <= y && y <= 68)
368 y += 2000;
369 else {
370 PyErr_SetString(PyExc_ValueError,
371 "year out of range");
372 return 0;
373 }
374 }
375 p->tm_year = y - 1900;
376 p->tm_mon--;
377 p->tm_wday = (p->tm_wday + 1) % 7;
378 p->tm_yday--;
379 return 1;
Guido van Rossum9e90a671993-06-24 11:10:19 +0000380}
381
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000382/* Check values of the struct tm fields before it is passed to strftime() and
383 * asctime(). Return 1 if all values are valid, otherwise set an exception
384 * and returns 0.
385 */
Victor Stinneref128102010-10-07 01:00:52 +0000386static int
387checktm(struct tm* buf)
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000388{
Victor Stinneref128102010-10-07 01:00:52 +0000389 /* Checks added to make sure strftime() and asctime() does not crash Python by
390 indexing blindly into some array for a textual representation
391 by some bad index (fixes bug #897625 and #6608).
392
393 Also support values of zero from Python code for arguments in which
394 that is out of range by forcing that value to the lowest value that
395 is valid (fixed bug #1520914).
396
397 Valid ranges based on what is allowed in struct tm:
398
399 - tm_year: [0, max(int)] (1)
400 - tm_mon: [0, 11] (2)
401 - tm_mday: [1, 31]
402 - tm_hour: [0, 23]
403 - tm_min: [0, 59]
404 - tm_sec: [0, 60]
405 - tm_wday: [0, 6] (1)
406 - tm_yday: [0, 365] (2)
407 - tm_isdst: [-max(int), max(int)]
408
409 (1) gettmarg() handles bounds-checking.
410 (2) Python's acceptable range is one greater than the range in C,
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000411 thus need to check against automatic decrement by gettmarg().
412 */
413 if (buf->tm_mon == -1)
414 buf->tm_mon = 0;
415 else if (buf->tm_mon < 0 || buf->tm_mon > 11) {
416 PyErr_SetString(PyExc_ValueError, "month out of range");
417 return 0;
418 }
419 if (buf->tm_mday == 0)
420 buf->tm_mday = 1;
421 else if (buf->tm_mday < 0 || buf->tm_mday > 31) {
422 PyErr_SetString(PyExc_ValueError, "day of month out of range");
423 return 0;
424 }
425 if (buf->tm_hour < 0 || buf->tm_hour > 23) {
426 PyErr_SetString(PyExc_ValueError, "hour out of range");
427 return 0;
428 }
429 if (buf->tm_min < 0 || buf->tm_min > 59) {
430 PyErr_SetString(PyExc_ValueError, "minute out of range");
431 return 0;
432 }
433 if (buf->tm_sec < 0 || buf->tm_sec > 61) {
434 PyErr_SetString(PyExc_ValueError, "seconds out of range");
435 return 0;
436 }
437 /* tm_wday does not need checking of its upper-bound since taking
438 ``% 7`` in gettmarg() automatically restricts the range. */
439 if (buf->tm_wday < 0) {
440 PyErr_SetString(PyExc_ValueError, "day of week out of range");
441 return 0;
442 }
443 if (buf->tm_yday == -1)
444 buf->tm_yday = 0;
445 else if (buf->tm_yday < 0 || buf->tm_yday > 365) {
446 PyErr_SetString(PyExc_ValueError, "day of year out of range");
447 return 0;
448 }
449 return 1;
450}
451
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000452#ifdef HAVE_STRFTIME
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000453#ifdef HAVE_WCSFTIME
454#define time_char wchar_t
455#define format_time wcsftime
456#define time_strlen wcslen
457#else
458#define time_char char
459#define format_time strftime
460#define time_strlen strlen
461#endif
462
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000463static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000464time_strftime(PyObject *self, PyObject *args)
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000465{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000466 PyObject *tup = NULL;
467 struct tm buf;
468 const time_char *fmt;
Victor Stinnerb2904782010-09-29 10:34:19 +0000469#ifdef HAVE_WCSFTIME
470 wchar_t *format;
471#else
472 PyObject *format;
473#endif
Victor Stinneref128102010-10-07 01:00:52 +0000474 PyObject *format_arg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000475 size_t fmtlen, buflen;
Victor Stinnerb2904782010-09-29 10:34:19 +0000476 time_char *outbuf = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000477 size_t i;
Victor Stinnerb2904782010-09-29 10:34:19 +0000478 PyObject *ret = NULL;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000480 memset((void *) &buf, '\0', sizeof(buf));
Guido van Rossum1f41f841998-04-27 19:04:26 +0000481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000482 /* Will always expect a unicode string to be passed as format.
483 Given that there's no str type anymore in py3k this seems safe.
484 */
Victor Stinneref128102010-10-07 01:00:52 +0000485 if (!PyArg_ParseTuple(args, "U|O:strftime", &format_arg, &tup))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000486 return NULL;
Thomas Woutersfe385252001-01-19 23:16:56 +0000487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 if (tup == NULL) {
489 time_t tt = time(NULL);
490 buf = *localtime(&tt);
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000491 }
492 else if (!gettmarg(tup, &buf) || !checktm(&buf))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 return NULL;
Guido van Rossum10b164a2001-09-25 13:59:01 +0000494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 /* Normalize tm_isdst just in case someone foolishly implements %Z
496 based on the assumption that tm_isdst falls within the range of
497 [-1, 1] */
498 if (buf.tm_isdst < -1)
499 buf.tm_isdst = -1;
500 else if (buf.tm_isdst > 1)
501 buf.tm_isdst = 1;
Brett Cannond1080a32004-03-02 04:38:10 +0000502
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000503#ifdef HAVE_WCSFTIME
Victor Stinnerbeb4135b2010-10-07 01:02:42 +0000504 format = PyUnicode_AsWideCharString(format_arg, NULL);
Victor Stinnerb2904782010-09-29 10:34:19 +0000505 if (format == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000506 return NULL;
Victor Stinnerb2904782010-09-29 10:34:19 +0000507 fmt = format;
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000508#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000509 /* Convert the unicode string to an ascii one */
Victor Stinneref128102010-10-07 01:00:52 +0000510 format = PyUnicode_AsEncodedString(format_arg, TZNAME_ENCODING, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 if (format == NULL)
512 return NULL;
513 fmt = PyBytes_AS_STRING(format);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000514#endif
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000515
Hirokazu Yamamoto6b0e51a2009-06-03 05:19:18 +0000516#if defined(MS_WINDOWS) && defined(HAVE_WCSFTIME)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 /* check that the format string contains only valid directives */
518 for(outbuf = wcschr(fmt, L'%');
519 outbuf != NULL;
520 outbuf = wcschr(outbuf+2, L'%'))
521 {
522 if (outbuf[1]=='#')
523 ++outbuf; /* not documented by python, */
524 if (outbuf[1]=='\0' ||
525 !wcschr(L"aAbBcdfHIjmMpSUwWxXyYzZ%", outbuf[1]))
526 {
527 PyErr_SetString(PyExc_ValueError, "Invalid format string");
528 return 0;
529 }
530 }
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000531#endif
532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 fmtlen = time_strlen(fmt);
Guido van Rossumc222ec21999-02-23 00:00:10 +0000534
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000535 /* I hate these functions that presume you know how big the output
536 * will be ahead of time...
537 */
538 for (i = 1024; ; i += i) {
539 outbuf = (time_char *)PyMem_Malloc(i*sizeof(time_char));
540 if (outbuf == NULL) {
Victor Stinnerb2904782010-09-29 10:34:19 +0000541 PyErr_NoMemory();
542 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000543 }
544 buflen = format_time(outbuf, i, fmt, &buf);
545 if (buflen > 0 || i >= 256 * fmtlen) {
546 /* If the buffer is 256 times as long as the format,
547 it's probably not failing for lack of room!
548 More likely, the format yields an empty result,
549 e.g. an empty format, or %Z when the timezone
550 is unknown. */
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000551#ifdef HAVE_WCSFTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 ret = PyUnicode_FromWideChar(outbuf, buflen);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000553#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 ret = PyUnicode_Decode(outbuf, buflen,
555 TZNAME_ENCODING, NULL);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000556#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000557 PyMem_Free(outbuf);
Victor Stinnerb2904782010-09-29 10:34:19 +0000558 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000559 }
560 PyMem_Free(outbuf);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000561#if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000562 /* VisualStudio .NET 2005 does this properly */
563 if (buflen == 0 && errno == EINVAL) {
564 PyErr_SetString(PyExc_ValueError, "Invalid format string");
Victor Stinnerb2904782010-09-29 10:34:19 +0000565 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000566 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000567#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 }
Victor Stinnerb2904782010-09-29 10:34:19 +0000569#ifdef HAVE_WCSFTIME
570 PyMem_Free(format);
571#else
572 Py_DECREF(format);
573#endif
574 return ret;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000575}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000576
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000577#undef time_char
578#undef format_time
579
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000580PyDoc_STRVAR(strftime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000581"strftime(format[, tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000582\n\
583Convert a time tuple to a string according to a format specification.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000584See the library reference manual for formatting codes. When the time tuple\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000585is not present, current time as returned by localtime() is used.");
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000586#endif /* HAVE_STRFTIME */
587
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000588static PyObject *
589time_strptime(PyObject *self, PyObject *args)
590{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000591 PyObject *strptime_module = PyImport_ImportModuleNoBlock("_strptime");
592 PyObject *strptime_result;
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000593
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000594 if (!strptime_module)
595 return NULL;
596 strptime_result = PyObject_CallMethod(strptime_module,
597 "_strptime_time", "O", args);
598 Py_DECREF(strptime_module);
599 return strptime_result;
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000600}
601
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000602
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000603PyDoc_STRVAR(strptime_doc,
Brett Cannon20def8b2003-07-01 05:16:08 +0000604"strptime(string, format) -> struct_time\n\
Martin v. Löwisb3cfc1d2001-12-02 12:27:43 +0000605\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000606Parse a string to a time tuple according to a format specification.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000607See the library reference manual for formatting codes (same as strftime()).");
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000608
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000609static PyObject *
610_asctime(struct tm *timeptr)
611{
612 /* Inspired by Open Group reference implementation available at
613 * http://pubs.opengroup.org/onlinepubs/009695399/functions/asctime.html */
614 static char wday_name[7][3] = {
615 "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"
616 };
617 static char mon_name[12][3] = {
618 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
619 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
620 };
621 char buf[20]; /* 'Sun Sep 16 01:03:52\0' */
622 int n;
623
624 n = snprintf(buf, sizeof(buf), "%.3s %.3s%3d %.2d:%.2d:%.2d",
625 wday_name[timeptr->tm_wday],
626 mon_name[timeptr->tm_mon],
627 timeptr->tm_mday, timeptr->tm_hour,
628 timeptr->tm_min, timeptr->tm_sec);
629 /* XXX: since the fields used by snprintf above are validated in checktm,
630 * the following condition should never trigger. We keep the check because
631 * historically fixed size buffer used in asctime was the source of
632 * crashes. */
633 if (n + 1 != sizeof(buf)) {
634 PyErr_SetString(PyExc_ValueError, "unconvertible time");
635 return NULL;
636 }
637
638 return PyUnicode_FromFormat("%s %d", buf, 1900 + timeptr->tm_year);
639}
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000640
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000641static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000642time_asctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000643{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000644 PyObject *tup = NULL;
645 struct tm buf;
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000646
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000647 if (!PyArg_UnpackTuple(args, "asctime", 0, 1, &tup))
648 return NULL;
649 if (tup == NULL) {
650 time_t tt = time(NULL);
651 buf = *localtime(&tt);
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000652 } else if (!gettmarg(tup, &buf) || !checktm(&buf))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653 return NULL;
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000654 return _asctime(&buf);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000655}
656
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000657PyDoc_STRVAR(asctime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000658"asctime([tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000659\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000660Convert a time tuple to a string, e.g. 'Sat Jun 06 16:26:11 1998'.\n\
661When the time tuple is not present, current time as returned by localtime()\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000662is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000663
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000664static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000665time_ctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000666{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000667 PyObject *ot = NULL;
668 time_t tt;
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000669 struct tm *timeptr;
Guido van Rossum10b164a2001-09-25 13:59:01 +0000670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000671 if (!PyArg_UnpackTuple(args, "ctime", 0, 1, &ot))
672 return NULL;
673 if (ot == NULL || ot == Py_None)
674 tt = time(NULL);
675 else {
676 double dt = PyFloat_AsDouble(ot);
677 if (PyErr_Occurred())
678 return NULL;
679 tt = _PyTime_DoubleToTimet(dt);
680 if (tt == (time_t)-1 && PyErr_Occurred())
681 return NULL;
682 }
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000683 timeptr = localtime(&tt);
684 if (timeptr == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 PyErr_SetString(PyExc_ValueError, "unconvertible time");
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000686 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 }
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000688 return _asctime(timeptr);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000689}
690
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000691PyDoc_STRVAR(ctime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000692"ctime(seconds) -> string\n\
693\n\
694Convert a time in seconds since the Epoch to a string in local time.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000695This is equivalent to asctime(localtime(seconds)). When the time tuple is\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000696not present, current time as returned by localtime() is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000697
Guido van Rossum60cd8131998-03-06 17:16:21 +0000698#ifdef HAVE_MKTIME
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000699static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000700time_mktime(PyObject *self, PyObject *tup)
Guido van Rossum234f9421993-06-17 12:35:49 +0000701{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000702 struct tm buf;
703 time_t tt;
704 if (!gettmarg(tup, &buf))
705 return NULL;
706 tt = mktime(&buf);
707 if (tt == (time_t)(-1)) {
708 PyErr_SetString(PyExc_OverflowError,
709 "mktime argument out of range");
710 return NULL;
711 }
712 return PyFloat_FromDouble((double)tt);
Guido van Rossum234f9421993-06-17 12:35:49 +0000713}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000714
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000715PyDoc_STRVAR(mktime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000716"mktime(tuple) -> floating point number\n\
717\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000718Convert a time tuple in local time to seconds since the Epoch.");
Guido van Rossum60cd8131998-03-06 17:16:21 +0000719#endif /* HAVE_MKTIME */
Guido van Rossum234f9421993-06-17 12:35:49 +0000720
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000721#ifdef HAVE_WORKING_TZSET
Martin v. Löwis1a214512008-06-11 05:26:20 +0000722static void PyInit_timezone(PyObject *module);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000723
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000724static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000725time_tzset(PyObject *self, PyObject *unused)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000726{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000727 PyObject* m;
Fred Drake9bb74322002-04-01 14:49:59 +0000728
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 m = PyImport_ImportModuleNoBlock("time");
730 if (m == NULL) {
731 return NULL;
732 }
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 tzset();
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 /* Reset timezone, altzone, daylight and tzname */
737 PyInit_timezone(m);
738 Py_DECREF(m);
Tim Peters1b6f7a92004-06-20 02:50:16 +0000739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 Py_INCREF(Py_None);
741 return Py_None;
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000742}
743
744PyDoc_STRVAR(tzset_doc,
R. David Murray4d55bf92010-12-14 00:55:46 +0000745"tzset()\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000746\n\
747Initialize, or reinitialize, the local timezone to the value stored in\n\
748os.environ['TZ']. The TZ environment variable should be specified in\n\
Neal Norwitzdc8e1942004-07-20 22:34:37 +0000749standard Unix timezone format as documented in the tzset man page\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000750(eg. 'US/Eastern', 'Europe/Amsterdam'). Unknown timezones will silently\n\
751fall back to UTC. If the TZ environment variable is not set, the local\n\
752timezone is set to the systems best guess of wallclock time.\n\
753Changing the TZ environment variable without calling tzset *may* change\n\
754the local timezone used by methods such as localtime, but this behaviour\n\
755should not be relied on.");
756#endif /* HAVE_WORKING_TZSET */
757
Martin v. Löwisd218dc12008-04-07 03:17:54 +0000758static void
Martin v. Löwis1a214512008-06-11 05:26:20 +0000759PyInit_timezone(PyObject *m) {
760 /* This code moved from PyInit_time wholesale to allow calling it from
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000761 time_tzset. In the future, some parts of it can be moved back
762 (for platforms that don't HAVE_WORKING_TZSET, when we know what they
763 are), and the extraneous calls to tzset(3) should be removed.
764 I haven't done this yet, as I don't want to change this code as
765 little as possible when introducing the time.tzset and time.tzsetwall
766 methods. This should simply be a method of doing the following once,
767 at the top of this function and removing the call to tzset() from
768 time_tzset():
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000769
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000770 #ifdef HAVE_TZSET
771 tzset()
772 #endif
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 And I'm lazy and hate C so nyer.
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000775 */
Guido van Rossum10b164a2001-09-25 13:59:01 +0000776#if defined(HAVE_TZNAME) && !defined(__GLIBC__) && !defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000777 PyObject *otz0, *otz1;
778 tzset();
Guido van Rossum26452411998-09-28 22:07:11 +0000779#ifdef PYOS_OS2
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000780 PyModule_AddIntConstant(m, "timezone", _timezone);
Guido van Rossum26452411998-09-28 22:07:11 +0000781#else /* !PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000782 PyModule_AddIntConstant(m, "timezone", timezone);
Guido van Rossum26452411998-09-28 22:07:11 +0000783#endif /* PYOS_OS2 */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000784#ifdef HAVE_ALTZONE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000785 PyModule_AddIntConstant(m, "altzone", altzone);
Guido van Rossumb6775db1994-08-01 11:34:53 +0000786#else
Guido van Rossum26452411998-09-28 22:07:11 +0000787#ifdef PYOS_OS2
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000788 PyModule_AddIntConstant(m, "altzone", _timezone-3600);
Guido van Rossum26452411998-09-28 22:07:11 +0000789#else /* !PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000790 PyModule_AddIntConstant(m, "altzone", timezone-3600);
Guido van Rossum26452411998-09-28 22:07:11 +0000791#endif /* PYOS_OS2 */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000792#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 PyModule_AddIntConstant(m, "daylight", daylight);
794 otz0 = PyUnicode_Decode(tzname[0], strlen(tzname[0]), TZNAME_ENCODING, NULL);
795 otz1 = PyUnicode_Decode(tzname[1], strlen(tzname[1]), TZNAME_ENCODING, NULL);
796 PyModule_AddObject(m, "tzname", Py_BuildValue("(NN)", otz0, otz1));
Guido van Rossum10b164a2001-09-25 13:59:01 +0000797#else /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Martin v. Löwis60a5d722002-10-16 20:28:25 +0000798#ifdef HAVE_STRUCT_TM_TM_ZONE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000799 {
Guido van Rossum234f9421993-06-17 12:35:49 +0000800#define YEAR ((time_t)((365 * 24 + 6) * 3600))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000801 time_t t;
802 struct tm *p;
803 long janzone, julyzone;
804 char janname[10], julyname[10];
805 t = (time((time_t *)0) / YEAR) * YEAR;
806 p = localtime(&t);
807 janzone = -p->tm_gmtoff;
808 strncpy(janname, p->tm_zone ? p->tm_zone : " ", 9);
809 janname[9] = '\0';
810 t += YEAR/2;
811 p = localtime(&t);
812 julyzone = -p->tm_gmtoff;
813 strncpy(julyname, p->tm_zone ? p->tm_zone : " ", 9);
814 julyname[9] = '\0';
Guido van Rossum10b164a2001-09-25 13:59:01 +0000815
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000816 if( janzone < julyzone ) {
817 /* DST is reversed in the southern hemisphere */
818 PyModule_AddIntConstant(m, "timezone", julyzone);
819 PyModule_AddIntConstant(m, "altzone", janzone);
820 PyModule_AddIntConstant(m, "daylight",
821 janzone != julyzone);
822 PyModule_AddObject(m, "tzname",
823 Py_BuildValue("(zz)",
824 julyname, janname));
825 } else {
826 PyModule_AddIntConstant(m, "timezone", janzone);
827 PyModule_AddIntConstant(m, "altzone", julyzone);
828 PyModule_AddIntConstant(m, "daylight",
829 janzone != julyzone);
830 PyModule_AddObject(m, "tzname",
831 Py_BuildValue("(zz)",
832 janname, julyname));
833 }
834 }
Guido van Rossume6a4b7b1997-10-08 15:27:56 +0000835#else
Martin v. Löwis60a5d722002-10-16 20:28:25 +0000836#endif /* HAVE_STRUCT_TM_TM_ZONE */
Tim Peters26ae7cd2001-03-20 03:26:49 +0000837#ifdef __CYGWIN__
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000838 tzset();
839 PyModule_AddIntConstant(m, "timezone", _timezone);
840 PyModule_AddIntConstant(m, "altzone", _timezone-3600);
841 PyModule_AddIntConstant(m, "daylight", _daylight);
842 PyModule_AddObject(m, "tzname",
843 Py_BuildValue("(zz)", _tzname[0], _tzname[1]));
Tim Peters26ae7cd2001-03-20 03:26:49 +0000844#endif /* __CYGWIN__ */
Guido van Rossum10b164a2001-09-25 13:59:01 +0000845#endif /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000846}
847
848
849static PyMethodDef time_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000850 {"time", time_time, METH_NOARGS, time_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000851#ifdef HAVE_CLOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 {"clock", time_clock, METH_NOARGS, clock_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000853#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 {"sleep", time_sleep, METH_VARARGS, sleep_doc},
855 {"gmtime", time_gmtime, METH_VARARGS, gmtime_doc},
856 {"localtime", time_localtime, METH_VARARGS, localtime_doc},
857 {"asctime", time_asctime, METH_VARARGS, asctime_doc},
858 {"ctime", time_ctime, METH_VARARGS, ctime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000859#ifdef HAVE_MKTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000860 {"mktime", time_mktime, METH_O, mktime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000861#endif
862#ifdef HAVE_STRFTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000863 {"strftime", time_strftime, METH_VARARGS, strftime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000864#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 {"strptime", time_strptime, METH_VARARGS, strptime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000866#ifdef HAVE_WORKING_TZSET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 {"tzset", time_tzset, METH_NOARGS, tzset_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000868#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 {NULL, NULL} /* sentinel */
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000870};
871
872
873PyDoc_STRVAR(module_doc,
874"This module provides various functions to manipulate time values.\n\
875\n\
876There are two standard representations of time. One is the number\n\
877of seconds since the Epoch, in UTC (a.k.a. GMT). It may be an integer\n\
878or a floating point number (to represent fractions of seconds).\n\
879The Epoch is system-defined; on Unix, it is generally January 1st, 1970.\n\
880The actual value can be retrieved by calling gmtime(0).\n\
881\n\
882The other representation is a tuple of 9 integers giving local time.\n\
883The tuple items are:\n\
884 year (four digits, e.g. 1998)\n\
885 month (1-12)\n\
886 day (1-31)\n\
887 hours (0-23)\n\
888 minutes (0-59)\n\
889 seconds (0-59)\n\
890 weekday (0-6, Monday is 0)\n\
891 Julian day (day in the year, 1-366)\n\
892 DST (Daylight Savings Time) flag (-1, 0 or 1)\n\
893If the DST flag is 0, the time is given in the regular time zone;\n\
894if it is 1, the time is given in the DST time zone;\n\
895if it is -1, mktime() should guess based on the date and time.\n\
896\n\
897Variables:\n\
898\n\
899timezone -- difference in seconds between UTC and local standard time\n\
900altzone -- difference in seconds between UTC and local DST time\n\
901daylight -- whether local time should reflect DST\n\
902tzname -- tuple of (standard time zone name, DST time zone name)\n\
903\n\
904Functions:\n\
905\n\
906time() -- return current time in seconds since the Epoch as a float\n\
907clock() -- return CPU time since process start as a float\n\
908sleep() -- delay for a number of seconds given as a float\n\
909gmtime() -- convert seconds since Epoch to UTC tuple\n\
910localtime() -- convert seconds since Epoch to local time tuple\n\
911asctime() -- convert time tuple to string\n\
912ctime() -- convert time in seconds to string\n\
913mktime() -- convert local time tuple to seconds since Epoch\n\
914strftime() -- convert time tuple to string according to format specification\n\
915strptime() -- parse string to time tuple according to format specification\n\
916tzset() -- change the local timezone");
917
918
Martin v. Löwis1a214512008-06-11 05:26:20 +0000919
920static struct PyModuleDef timemodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000921 PyModuleDef_HEAD_INIT,
922 "time",
923 module_doc,
924 -1,
925 time_methods,
926 NULL,
927 NULL,
928 NULL,
929 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +0000930};
931
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000932PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +0000933PyInit_time(void)
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000934{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 PyObject *m;
936 char *p;
937 m = PyModule_Create(&timemodule);
938 if (m == NULL)
939 return NULL;
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000940
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 /* Accept 2-digit dates unless PYTHONY2K is set and non-empty */
942 p = Py_GETENV("PYTHONY2K");
943 PyModule_AddIntConstant(m, "accept2dyear", (long) (!p || !*p));
944 /* Squirrel away the module's dictionary for the y2k check */
945 moddict = PyModule_GetDict(m);
946 Py_INCREF(moddict);
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000947
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000948 /* Set, or reset, module variables like time.timezone */
949 PyInit_timezone(m);
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000950
Mark Hammond975e3922002-07-16 01:29:19 +0000951#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 /* Helper to allow interrupts for Windows.
953 If Ctrl+C event delivered while not sleeping
954 it will be ignored.
955 */
956 main_thread = PyThread_get_thread_ident();
957 hInterruptEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
958 SetConsoleCtrlHandler( PyCtrlHandler, TRUE);
Mark Hammond975e3922002-07-16 01:29:19 +0000959#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 if (!initialized) {
961 PyStructSequence_InitType(&StructTimeType,
962 &struct_time_type_desc);
963 }
964 Py_INCREF(&StructTimeType);
965 PyModule_AddObject(m, "struct_time", (PyObject*) &StructTimeType);
966 initialized = 1;
967 return m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000968}
969
Guido van Rossumb6775db1994-08-01 11:34:53 +0000970static double
Thomas Woutersf3f33dc2000-07-21 06:00:07 +0000971floattime(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000972{
Alexander Belopolsky6fc4ade2010-08-05 17:34:27 +0000973 _PyTime_timeval t;
974 _PyTime_gettimeofday(&t);
975 return (double)t.tv_sec + t.tv_usec*0.000001;
Guido van Rossum426035c1991-02-19 12:27:35 +0000976}
977
Guido van Rossumb6775db1994-08-01 11:34:53 +0000978
979/* Implement floatsleep() for various platforms.
980 When interrupted (or when another error occurs), return -1 and
981 set an exception; else return 0. */
982
983static int
Guido van Rossuma320fd31995-03-09 12:14:15 +0000984floatsleep(double secs)
Guido van Rossum426035c1991-02-19 12:27:35 +0000985{
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000986/* XXX Should test for MS_WINDOWS first! */
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000987#if defined(HAVE_SELECT) && !defined(__EMX__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 struct timeval t;
989 double frac;
990 frac = fmod(secs, 1.0);
991 secs = floor(secs);
992 t.tv_sec = (long)secs;
993 t.tv_usec = (long)(frac*1000000.0);
994 Py_BEGIN_ALLOW_THREADS
995 if (select(0, (fd_set *)0, (fd_set *)0, (fd_set *)0, &t) != 0) {
Guido van Rossum09cbb011999-11-08 15:32:27 +0000996#ifdef EINTR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000997 if (errno != EINTR) {
Guido van Rossum09cbb011999-11-08 15:32:27 +0000998#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 if (1) {
Guido van Rossum09cbb011999-11-08 15:32:27 +00001000#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001001 Py_BLOCK_THREADS
1002 PyErr_SetFromErrno(PyExc_IOError);
1003 return -1;
1004 }
1005 }
1006 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +00001007#elif defined(__WATCOMC__) && !defined(__QNX__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001008 /* XXX Can't interrupt this sleep */
1009 Py_BEGIN_ALLOW_THREADS
1010 delay((int)(secs * 1000 + 0.5)); /* delay() uses milliseconds */
1011 Py_END_ALLOW_THREADS
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00001012#elif defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 {
1014 double millisecs = secs * 1000.0;
1015 unsigned long ul_millis;
Tim Peters513a1cd2003-01-19 04:54:58 +00001016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 if (millisecs > (double)ULONG_MAX) {
1018 PyErr_SetString(PyExc_OverflowError,
1019 "sleep length is too large");
1020 return -1;
1021 }
1022 Py_BEGIN_ALLOW_THREADS
1023 /* Allow sleep(0) to maintain win32 semantics, and as decreed
1024 * by Guido, only the main thread can be interrupted.
1025 */
1026 ul_millis = (unsigned long)millisecs;
1027 if (ul_millis == 0 ||
1028 main_thread != PyThread_get_thread_ident())
1029 Sleep(ul_millis);
1030 else {
1031 DWORD rc;
1032 ResetEvent(hInterruptEvent);
1033 rc = WaitForSingleObject(hInterruptEvent, ul_millis);
1034 if (rc == WAIT_OBJECT_0) {
1035 /* Yield to make sure real Python signal
1036 * handler called.
1037 */
1038 Sleep(1);
1039 Py_BLOCK_THREADS
1040 errno = EINTR;
1041 PyErr_SetFromErrno(PyExc_IOError);
1042 return -1;
1043 }
1044 }
1045 Py_END_ALLOW_THREADS
1046 }
Martin v. Löwis02af9642002-01-16 11:04:06 +00001047#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001048 /* This Sleep *IS* Interruptable by Exceptions */
1049 Py_BEGIN_ALLOW_THREADS
1050 if (DosSleep(secs * 1000) != NO_ERROR) {
1051 Py_BLOCK_THREADS
1052 PyErr_SetFromErrno(PyExc_IOError);
1053 return -1;
1054 }
1055 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +00001056#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001057 /* XXX Can't interrupt this sleep */
1058 Py_BEGIN_ALLOW_THREADS
1059 sleep((int)secs);
1060 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +00001061#endif
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001062
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001063 return 0;
Guido van Rossum80c9d881991-04-16 08:47:51 +00001064}