blob: c101819a676aba8a47db184d7aea86f9c875f04f [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"
Guido van Rossum98bf58f2001-10-18 20:34:25 +00005#include "structseq.h"
Tim Peters1b6f7a92004-06-20 02:50:16 +00006#include "timefuncs.h"
Guido van Rossum3f5da241990-12-20 15:06:42 +00007
Martin v. Löwis8a7c8662007-08-30 15:40:24 +00008#define TZNAME_ENCODING "utf-8"
9
Thomas Wouters477c8d52006-05-27 19:21:47 +000010#ifdef __APPLE__
11#if defined(HAVE_GETTIMEOFDAY) && defined(HAVE_FTIME)
12 /*
13 * floattime falls back to ftime when getttimeofday fails because the latter
14 * might fail on some platforms. This fallback is unwanted on MacOSX because
15 * that makes it impossible to use a binary build on OSX 10.4 on earlier
16 * releases of the OS. Therefore claim we don't support ftime.
17 */
18# undef HAVE_FTIME
19#endif
20#endif
21
Guido van Rossum87ce7bb1998-06-09 16:30:31 +000022#include <ctype.h>
23
Thomas Wouters0e3f5912006-08-11 14:57:12 +000024#ifdef HAVE_SYS_TYPES_H
Guido van Rossumb6775db1994-08-01 11:34:53 +000025#include <sys/types.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000026#endif /* HAVE_SYS_TYPES_H */
Guido van Rossum6d946f91992-08-14 13:49:30 +000027
Guido van Rossumb6775db1994-08-01 11:34:53 +000028#ifdef QUICKWIN
29#include <io.h>
30#endif
31
Guido van Rossumb6775db1994-08-01 11:34:53 +000032#ifdef HAVE_FTIME
33#include <sys/timeb.h>
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +000034#if !defined(MS_WINDOWS) && !defined(PYOS_OS2)
Thomas Woutersbd4bc4e2000-07-22 23:57:55 +000035extern int ftime(struct timeb *);
Guido van Rossum52174571996-12-09 18:38:52 +000036#endif /* MS_WINDOWS */
37#endif /* HAVE_FTIME */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000038
Guido van Rossum7bf22de1997-12-02 20:34:19 +000039#if defined(__WATCOMC__) && !defined(__QNX__)
Guido van Rossumbceeac81996-05-23 22:53:47 +000040#include <i86.h>
41#else
Guido van Rossumcac6c721996-09-06 13:34:02 +000042#ifdef MS_WINDOWS
Mark Hammond975e3922002-07-16 01:29:19 +000043#define WIN32_LEAN_AND_MEAN
Guido van Rossum258ccd42001-03-02 06:53:29 +000044#include <windows.h>
Mark Hammond975e3922002-07-16 01:29:19 +000045#include "pythread.h"
46
47/* helper to allow us to interrupt sleep() on Windows*/
48static HANDLE hInterruptEvent = NULL;
49static BOOL WINAPI PyCtrlHandler(DWORD dwCtrlType)
50{
51 SetEvent(hInterruptEvent);
52 /* allow other default handlers to be called.
53 Default Python handler will setup the
54 KeyboardInterrupt exception.
55 */
56 return FALSE;
57}
58static long main_thread;
59
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000060#if defined(__BORLANDC__)
Guido van Rossumb2fb3641996-09-07 00:47:35 +000061/* These overrides not needed for Win32 */
Guido van Rossumb6775db1994-08-01 11:34:53 +000062#define timezone _timezone
Guido van Rossumcc081121995-03-14 15:05:41 +000063#define tzname _tzname
64#define daylight _daylight
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000065#endif /* __BORLANDC__ */
Guido van Rossumcac6c721996-09-06 13:34:02 +000066#endif /* MS_WINDOWS */
Guido van Rossum7bf22de1997-12-02 20:34:19 +000067#endif /* !__WATCOMC__ || __QNX__ */
Guido van Rossum234f9421993-06-17 12:35:49 +000068
Thomas Wouters477c8d52006-05-27 19:21:47 +000069#if defined(MS_WINDOWS) && !defined(__BORLANDC__)
70/* Win32 has better clock replacement; we have our own version below. */
71#undef HAVE_CLOCK
Martin v. Löwis3bb00702007-08-30 14:37:48 +000072#undef TZNAME_ENCODING
73#define TZNAME_ENCODING "mbcs"
Thomas Wouters477c8d52006-05-27 19:21:47 +000074#endif /* MS_WINDOWS && !defined(__BORLANDC__) */
Guido van Rossum3917c221997-04-02 05:35:28 +000075
Andrew MacIntyre7bf68332002-03-03 02:59:16 +000076#if defined(PYOS_OS2)
77#define INCL_DOS
78#define INCL_ERRORS
79#include <os2.h>
80#endif
81
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +000082#if defined(PYCC_VACPP)
Guido van Rossum26452411998-09-28 22:07:11 +000083#include <sys/time.h>
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +000084#endif
85
Guido van Rossum234f9421993-06-17 12:35:49 +000086/* Forward declarations */
Tim Petersdbd9ba62000-07-09 03:09:57 +000087static int floatsleep(double);
Thomas Woutersed77bac2000-07-24 15:26:39 +000088static double floattime(void);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000089
Guido van Rossumcfbaecc1998-08-25 14:51:12 +000090/* For Y2K check */
91static PyObject *moddict;
92
Tim Peters1b6f7a92004-06-20 02:50:16 +000093/* Exposed in timefuncs.h. */
94time_t
Brett Cannon298c3802004-06-19 20:48:43 +000095_PyTime_DoubleToTimet(double x)
96{
97 time_t result;
98 double diff;
99
100 result = (time_t)x;
101 /* How much info did we lose? time_t may be an integral or
102 * floating type, and we don't know which. If it's integral,
103 * we don't know whether C truncates, rounds, returns the floor,
104 * etc. If we lost a second or more, the C rounding is
105 * unreasonable, or the input just doesn't fit in a time_t;
106 * call it an error regardless. Note that the original cast to
107 * time_t can cause a C error too, but nothing we can do to
108 * worm around that.
109 */
110 diff = x - (double)result;
111 if (diff <= -1.0 || diff >= 1.0) {
112 PyErr_SetString(PyExc_ValueError,
113 "timestamp out of range for platform time_t");
114 result = (time_t)-1;
115 }
116 return result;
117}
118
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000119static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000120time_time(PyObject *self, PyObject *unused)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000121{
Guido van Rossumb6775db1994-08-01 11:34:53 +0000122 double secs;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000123 secs = floattime();
124 if (secs == 0.0) {
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000125 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma2b7f401993-01-04 09:09:59 +0000126 return NULL;
127 }
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000128 return PyFloat_FromDouble(secs);
Guido van Rossumb6775db1994-08-01 11:34:53 +0000129}
130
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000131PyDoc_STRVAR(time_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000132"time() -> floating point number\n\
133\n\
134Return the current time in seconds since the Epoch.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000135Fractions of a second may be present if the system clock provides them.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000136
Guido van Rossumb6775db1994-08-01 11:34:53 +0000137#ifdef HAVE_CLOCK
138
139#ifndef CLOCKS_PER_SEC
Guido van Rossum1b66a4f1996-02-25 04:50:33 +0000140#ifdef CLK_TCK
141#define CLOCKS_PER_SEC CLK_TCK
142#else
Guido van Rossumb6775db1994-08-01 11:34:53 +0000143#define CLOCKS_PER_SEC 1000000
144#endif
Guido van Rossum1b66a4f1996-02-25 04:50:33 +0000145#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000146
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000147static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000148time_clock(PyObject *self, PyObject *unused)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000149{
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000150 return PyFloat_FromDouble(((double)clock()) / CLOCKS_PER_SEC);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000151}
Guido van Rossumb6775db1994-08-01 11:34:53 +0000152#endif /* HAVE_CLOCK */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000153
Thomas Wouters477c8d52006-05-27 19:21:47 +0000154#if defined(MS_WINDOWS) && !defined(__BORLANDC__)
Mark Hammond7ba5e812002-02-12 04:02:33 +0000155/* Due to Mark Hammond and Tim Peters */
Guido van Rossum3917c221997-04-02 05:35:28 +0000156static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000157time_clock(PyObject *self, PyObject *unused)
Guido van Rossum3917c221997-04-02 05:35:28 +0000158{
Tim Peters9ad4b682002-02-13 05:14:18 +0000159 static LARGE_INTEGER ctrStart;
Mark Hammond7ba5e812002-02-12 04:02:33 +0000160 static double divisor = 0.0;
Tim Peters9ad4b682002-02-13 05:14:18 +0000161 LARGE_INTEGER now;
Mark Hammond7ba5e812002-02-12 04:02:33 +0000162 double diff;
Guido van Rossum3917c221997-04-02 05:35:28 +0000163
Mark Hammond7ba5e812002-02-12 04:02:33 +0000164 if (divisor == 0.0) {
Tim Peters9ad4b682002-02-13 05:14:18 +0000165 LARGE_INTEGER freq;
166 QueryPerformanceCounter(&ctrStart);
167 if (!QueryPerformanceFrequency(&freq) || freq.QuadPart == 0) {
Mark Hammond7ba5e812002-02-12 04:02:33 +0000168 /* Unlikely to happen - this works on all intel
169 machines at least! Revert to clock() */
Guido van Rossumd8faa362007-04-27 19:54:29 +0000170 return PyFloat_FromDouble(((double)clock()) /
171 CLOCKS_PER_SEC);
Guido van Rossum3917c221997-04-02 05:35:28 +0000172 }
Tim Peters9ad4b682002-02-13 05:14:18 +0000173 divisor = (double)freq.QuadPart;
Guido van Rossum3917c221997-04-02 05:35:28 +0000174 }
Tim Peters9ad4b682002-02-13 05:14:18 +0000175 QueryPerformanceCounter(&now);
176 diff = (double)(now.QuadPart - ctrStart.QuadPart);
Mark Hammond7ba5e812002-02-12 04:02:33 +0000177 return PyFloat_FromDouble(diff / divisor);
Guido van Rossum3917c221997-04-02 05:35:28 +0000178}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000179
Guido van Rossum3917c221997-04-02 05:35:28 +0000180#define HAVE_CLOCK /* So it gets included in the methods */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000181#endif /* MS_WINDOWS && !defined(__BORLANDC__) */
Guido van Rossum3917c221997-04-02 05:35:28 +0000182
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000183#ifdef HAVE_CLOCK
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000184PyDoc_STRVAR(clock_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000185"clock() -> floating point number\n\
186\n\
187Return the CPU time or real time since the start of the process or since\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000188the first call to clock(). This has as much precision as the system\n\
189records.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000190#endif
191
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000192static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000193time_sleep(PyObject *self, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000194{
Guido van Rossum775f4da1993-01-09 17:18:52 +0000195 double secs;
Thomas Woutersfe385252001-01-19 23:16:56 +0000196 if (!PyArg_ParseTuple(args, "d:sleep", &secs))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000197 return NULL;
Guido van Rossum8607ae21997-11-03 22:04:46 +0000198 if (floatsleep(secs) != 0)
199 return NULL;
200 Py_INCREF(Py_None);
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000201 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000202}
203
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000204PyDoc_STRVAR(sleep_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000205"sleep(seconds)\n\
206\n\
207Delay execution for a given number of seconds. The argument may be\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000208a floating point number for subsecond precision.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000209
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000210static PyStructSequence_Field struct_time_type_fields[] = {
211 {"tm_year", NULL},
212 {"tm_mon", NULL},
213 {"tm_mday", NULL},
214 {"tm_hour", NULL},
215 {"tm_min", NULL},
216 {"tm_sec", NULL},
217 {"tm_wday", NULL},
218 {"tm_yday", NULL},
219 {"tm_isdst", NULL},
220 {0}
221};
222
223static PyStructSequence_Desc struct_time_type_desc = {
Guido van Rossum14648392001-12-08 18:02:58 +0000224 "time.struct_time",
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000225 NULL,
226 struct_time_type_fields,
227 9,
228};
Tim Peters9ad4b682002-02-13 05:14:18 +0000229
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000230static int initialized;
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000231static PyTypeObject StructTimeType;
232
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000233static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000234tmtotuple(struct tm *p)
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000235{
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000236 PyObject *v = PyStructSequence_New(&StructTimeType);
237 if (v == NULL)
238 return NULL;
Tim Peters9ad4b682002-02-13 05:14:18 +0000239
Christian Heimes217cfd12007-12-02 14:31:20 +0000240#define SET(i,val) PyStructSequence_SET_ITEM(v, i, PyLong_FromLong((long) val))
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000241
242 SET(0, p->tm_year + 1900);
243 SET(1, p->tm_mon + 1); /* Want January == 1 */
244 SET(2, p->tm_mday);
245 SET(3, p->tm_hour);
246 SET(4, p->tm_min);
247 SET(5, p->tm_sec);
248 SET(6, (p->tm_wday + 6) % 7); /* Want Monday == 0 */
249 SET(7, p->tm_yday + 1); /* Want January, 1 == 1 */
250 SET(8, p->tm_isdst);
251#undef SET
252 if (PyErr_Occurred()) {
253 Py_XDECREF(v);
254 return NULL;
255 }
256
257 return v;
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000258}
259
260static PyObject *
Skip Montanaro41cfce92007-08-24 21:11:00 +0000261structtime_totuple(PyObject *t)
262{
263 PyObject *x = NULL;
264 unsigned int i;
265 PyObject *v = PyTuple_New(9);
266 if (v == NULL)
267 return NULL;
268
269 for (i=0; i<9; i++) {
270 x = PyStructSequence_GET_ITEM(t, i);
271 Py_INCREF(x);
272 PyTuple_SET_ITEM(v, i, x);
273 }
274
275 if (PyErr_Occurred()) {
276 Py_XDECREF(v);
277 return NULL;
278 }
279
280 return v;
281}
282
283static PyObject *
Brett Cannon298c3802004-06-19 20:48:43 +0000284time_convert(double when, struct tm * (*function)(const time_t *))
Guido van Rossum234f9421993-06-17 12:35:49 +0000285{
Guido van Rossum6e8583d1996-10-08 14:19:52 +0000286 struct tm *p;
Brett Cannon298c3802004-06-19 20:48:43 +0000287 time_t whent = _PyTime_DoubleToTimet(when);
288
289 if (whent == (time_t)-1 && PyErr_Occurred())
290 return NULL;
Guido van Rossum6e8583d1996-10-08 14:19:52 +0000291 errno = 0;
Brett Cannon298c3802004-06-19 20:48:43 +0000292 p = function(&whent);
Guido van Rossum6e8583d1996-10-08 14:19:52 +0000293 if (p == NULL) {
294#ifdef EINVAL
Guido van Rossum0b1ff661996-11-02 17:31:22 +0000295 if (errno == 0)
Guido van Rossum6e8583d1996-10-08 14:19:52 +0000296 errno = EINVAL;
297#endif
Tim Peters8b19a932003-01-17 20:08:54 +0000298 return PyErr_SetFromErrno(PyExc_ValueError);
Guido van Rossum6e8583d1996-10-08 14:19:52 +0000299 }
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000300 return tmtotuple(p);
Guido van Rossum234f9421993-06-17 12:35:49 +0000301}
302
Fred Drakef901abd2004-08-03 17:58:55 +0000303/* Parse arg tuple that can contain an optional float-or-None value;
304 format needs to be "|O:name".
305 Returns non-zero on success (parallels PyArg_ParseTuple).
306*/
307static int
308parse_time_double_args(PyObject *args, char *format, double *pwhen)
309{
310 PyObject *ot = NULL;
311
312 if (!PyArg_ParseTuple(args, format, &ot))
313 return 0;
314 if (ot == NULL || ot == Py_None)
315 *pwhen = floattime();
316 else {
317 double when = PyFloat_AsDouble(ot);
318 if (PyErr_Occurred())
319 return 0;
320 *pwhen = when;
321 }
322 return 1;
323}
324
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000325static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000326time_gmtime(PyObject *self, PyObject *args)
Guido van Rossum234f9421993-06-17 12:35:49 +0000327{
328 double when;
Fred Drakef901abd2004-08-03 17:58:55 +0000329 if (!parse_time_double_args(args, "|O:gmtime", &when))
Guido van Rossum234f9421993-06-17 12:35:49 +0000330 return NULL;
Brett Cannon298c3802004-06-19 20:48:43 +0000331 return time_convert(when, gmtime);
Guido van Rossum234f9421993-06-17 12:35:49 +0000332}
333
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000334PyDoc_STRVAR(gmtime_doc,
Christian Heimes9a371592007-12-28 14:08:13 +0000335"gmtime([seconds]) -> (tm_year, tm_mon, tm_mday, tm_hour, tm_min,\n\
Fred Drake193a3f62002-03-12 21:38:49 +0000336 tm_sec, tm_wday, tm_yday, tm_isdst)\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000337\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000338Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000339GMT). When 'seconds' is not passed in, convert the current time instead.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000340
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000341static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000342time_localtime(PyObject *self, PyObject *args)
Guido van Rossum234f9421993-06-17 12:35:49 +0000343{
344 double when;
Fred Drakef901abd2004-08-03 17:58:55 +0000345 if (!parse_time_double_args(args, "|O:localtime", &when))
Guido van Rossum234f9421993-06-17 12:35:49 +0000346 return NULL;
Brett Cannon298c3802004-06-19 20:48:43 +0000347 return time_convert(when, localtime);
Guido van Rossum234f9421993-06-17 12:35:49 +0000348}
349
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000350PyDoc_STRVAR(localtime_doc,
Christian Heimes9a371592007-12-28 14:08:13 +0000351"localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,\n\
352 tm_sec,tm_wday,tm_yday,tm_isdst)\n\
Martin v. Löwisb3cfc1d2001-12-02 12:27:43 +0000353\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000354Convert seconds since the Epoch to a time tuple expressing local time.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000355When 'seconds' is not passed in, convert the current time instead.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000356
Guido van Rossum9e90a671993-06-24 11:10:19 +0000357static int
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000358gettmarg(PyObject *args, struct tm *p)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000359{
Guido van Rossumcfbaecc1998-08-25 14:51:12 +0000360 int y;
Skip Montanaro41cfce92007-08-24 21:11:00 +0000361 PyObject *t = NULL;
Guido van Rossumcfbaecc1998-08-25 14:51:12 +0000362
Guido van Rossumb9081262007-08-25 03:14:09 +0000363 memset((void *) p, '\0', sizeof(struct tm));
364
Skip Montanaro41cfce92007-08-24 21:11:00 +0000365 if (PyTuple_Check(args)) {
366 t = args;
367 Py_INCREF(t);
368 }
Christian Heimes90aa7642007-12-19 02:45:37 +0000369 else if (Py_TYPE(args) == &StructTimeType) {
Skip Montanaro41cfce92007-08-24 21:11:00 +0000370 t = structtime_totuple(args);
371 }
372 else {
373 PyErr_SetString(PyExc_TypeError,
374 "Tuple or struct_time argument required");
Guido van Rossum9e90a671993-06-24 11:10:19 +0000375 return 0;
Skip Montanaro41cfce92007-08-24 21:11:00 +0000376 }
377
378 if (t == NULL || !PyArg_ParseTuple(t, "iiiiiiiii",
379 &y,
380 &p->tm_mon,
381 &p->tm_mday,
382 &p->tm_hour,
383 &p->tm_min,
384 &p->tm_sec,
385 &p->tm_wday,
386 &p->tm_yday,
387 &p->tm_isdst)) {
388 Py_XDECREF(t);
389 return 0;
390 }
391 Py_DECREF(t);
392
Guido van Rossumcfbaecc1998-08-25 14:51:12 +0000393 if (y < 1900) {
394 PyObject *accept = PyDict_GetItemString(moddict,
395 "accept2dyear");
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +0000396 if (accept == NULL || !PyLong_CheckExact(accept) ||
397 !PyObject_IsTrue(accept)) {
Guido van Rossumcfbaecc1998-08-25 14:51:12 +0000398 PyErr_SetString(PyExc_ValueError,
399 "year >= 1900 required");
400 return 0;
401 }
402 if (69 <= y && y <= 99)
403 y += 1900;
404 else if (0 <= y && y <= 68)
405 y += 2000;
406 else {
407 PyErr_SetString(PyExc_ValueError,
Skip Montanaro1a10aac2001-08-22 12:39:16 +0000408 "year out of range");
Guido van Rossumcfbaecc1998-08-25 14:51:12 +0000409 return 0;
410 }
411 }
412 p->tm_year = y - 1900;
Guido van Rossum9e90a671993-06-24 11:10:19 +0000413 p->tm_mon--;
414 p->tm_wday = (p->tm_wday + 1) % 7;
415 p->tm_yday--;
416 return 1;
417}
418
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000419#ifdef HAVE_STRFTIME
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000420#ifdef HAVE_WCSFTIME
421#define time_char wchar_t
422#define format_time wcsftime
423#define time_strlen wcslen
424#else
425#define time_char char
426#define format_time strftime
427#define time_strlen strlen
428#endif
429
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000430static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000431time_strftime(PyObject *self, PyObject *args)
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000432{
Thomas Woutersfe385252001-01-19 23:16:56 +0000433 PyObject *tup = NULL;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000434 struct tm buf;
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000435 const time_char *fmt;
436 PyObject *format, *tmpfmt;
Guido van Rossumfa481162000-06-28 21:33:59 +0000437 size_t fmtlen, buflen;
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000438 time_char *outbuf = 0;
Guido van Rossumfa481162000-06-28 21:33:59 +0000439 size_t i;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000440
Thomas Wouters334fb892000-07-25 12:56:38 +0000441 memset((void *) &buf, '\0', sizeof(buf));
Guido van Rossum1f41f841998-04-27 19:04:26 +0000442
Guido van Rossumeda12ec2007-08-24 03:51:52 +0000443 /* Will always expect a unicode string to be passed as format.
444 Given that there's no str type anymore in py3k this seems safe.
445 */
446 if (!PyArg_ParseTuple(args, "U|O:strftime", &format, &tup))
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000447 return NULL;
Thomas Woutersfe385252001-01-19 23:16:56 +0000448
449 if (tup == NULL) {
450 time_t tt = time(NULL);
451 buf = *localtime(&tt);
452 } else if (!gettmarg(tup, &buf))
453 return NULL;
Guido van Rossum10b164a2001-09-25 13:59:01 +0000454
Brett Cannonec79b1c2009-09-22 19:15:35 +0000455 /* Checks added to make sure strftime() does not crash Python by
456 indexing blindly into some array for a textual representation
457 by some bad index (fixes bug #897625).
Tim Peters1b6f7a92004-06-20 02:50:16 +0000458
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000459 Also support values of zero from Python code for arguments in which
460 that is out of range by forcing that value to the lowest value that
461 is valid (fixed bug #1520914).
462
463 Valid ranges based on what is allowed in struct tm:
464
465 - tm_year: [0, max(int)] (1)
466 - tm_mon: [0, 11] (2)
467 - tm_mday: [1, 31]
468 - tm_hour: [0, 23]
469 - tm_min: [0, 59]
470 - tm_sec: [0, 60]
471 - tm_wday: [0, 6] (1)
472 - tm_yday: [0, 365] (2)
473 - tm_isdst: [-max(int), max(int)]
474
475 (1) gettmarg() handles bounds-checking.
476 (2) Python's acceptable range is one greater than the range in C,
477 thus need to check against automatic decrement by gettmarg().
Brett Cannonec79b1c2009-09-22 19:15:35 +0000478 */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000479 if (buf.tm_mon == -1)
480 buf.tm_mon = 0;
481 else if (buf.tm_mon < 0 || buf.tm_mon > 11) {
Brett Cannonec79b1c2009-09-22 19:15:35 +0000482 PyErr_SetString(PyExc_ValueError, "month out of range");
483 return NULL;
484 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000485 if (buf.tm_mday == 0)
486 buf.tm_mday = 1;
487 else if (buf.tm_mday < 0 || buf.tm_mday > 31) {
Brett Cannonec79b1c2009-09-22 19:15:35 +0000488 PyErr_SetString(PyExc_ValueError, "day of month out of range");
489 return NULL;
490 }
491 if (buf.tm_hour < 0 || buf.tm_hour > 23) {
492 PyErr_SetString(PyExc_ValueError, "hour out of range");
493 return NULL;
494 }
495 if (buf.tm_min < 0 || buf.tm_min > 59) {
496 PyErr_SetString(PyExc_ValueError, "minute out of range");
497 return NULL;
498 }
499 if (buf.tm_sec < 0 || buf.tm_sec > 61) {
500 PyErr_SetString(PyExc_ValueError, "seconds out of range");
501 return NULL;
502 }
503 /* tm_wday does not need checking of its upper-bound since taking
504 ``% 7`` in gettmarg() automatically restricts the range. */
505 if (buf.tm_wday < 0) {
506 PyErr_SetString(PyExc_ValueError, "day of week out of range");
507 return NULL;
508 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000509 if (buf.tm_yday == -1)
510 buf.tm_yday = 0;
511 else if (buf.tm_yday < 0 || buf.tm_yday > 365) {
Brett Cannonec79b1c2009-09-22 19:15:35 +0000512 PyErr_SetString(PyExc_ValueError, "day of year out of range");
513 return NULL;
514 }
Brett Cannon7d12c552009-09-22 00:32:59 +0000515 /* Normalize tm_isdst just in case someone foolishly implements %Z
516 based on the assumption that tm_isdst falls within the range of
517 [-1, 1] */
Brett Cannonec79b1c2009-09-22 19:15:35 +0000518 if (buf.tm_isdst < -1)
519 buf.tm_isdst = -1;
Brett Cannon7d12c552009-09-22 00:32:59 +0000520 else if (buf.tm_isdst > 1)
Brett Cannonec79b1c2009-09-22 19:15:35 +0000521 buf.tm_isdst = 1;
Brett Cannond1080a32004-03-02 04:38:10 +0000522
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000523#ifdef HAVE_WCSFTIME
524 tmpfmt = PyBytes_FromStringAndSize(NULL,
525 sizeof(wchar_t) * (PyUnicode_GetSize(format)+1));
526 if (!tmpfmt)
527 return NULL;
528 /* This assumes that PyUnicode_AsWideChar doesn't do any UTF-16
529 expansion. */
530 if (PyUnicode_AsWideChar((PyUnicodeObject*)format,
531 (wchar_t*)PyBytes_AS_STRING(tmpfmt),
532 PyUnicode_GetSize(format)+1) == (size_t)-1)
533 /* This shouldn't fail. */
534 Py_FatalError("PyUnicode_AsWideChar failed");
535 format = tmpfmt;
536 fmt = (wchar_t*)PyBytes_AS_STRING(format);
537#else
Hirokazu Yamamoto575d1332009-02-16 09:13:20 +0000538 /* Convert the unicode string to an ascii one */
539 format = PyUnicode_AsEncodedString(format, TZNAME_ENCODING, NULL);
540 if (format == NULL)
541 return NULL;
542 fmt = PyBytes_AS_STRING(format);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000543#endif
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000544
Hirokazu Yamamoto6b0e51a2009-06-03 05:19:18 +0000545#if defined(MS_WINDOWS) && defined(HAVE_WCSFTIME)
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000546 /* check that the format string contains only valid directives */
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000547 for(outbuf = wcschr(fmt, L'%');
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000548 outbuf != NULL;
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000549 outbuf = wcschr(outbuf+2, L'%'))
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000550 {
551 if (outbuf[1]=='#')
552 ++outbuf; /* not documented by python, */
553 if (outbuf[1]=='\0' ||
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000554 !wcschr(L"aAbBcdfHIjmMpSUwWxXyYzZ%", outbuf[1]))
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000555 {
556 PyErr_SetString(PyExc_ValueError, "Invalid format string");
557 return 0;
558 }
559 }
560#endif
561
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000562 fmtlen = time_strlen(fmt);
Guido van Rossumc222ec21999-02-23 00:00:10 +0000563
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000564 /* I hate these functions that presume you know how big the output
565 * will be ahead of time...
566 */
Guido van Rossumc222ec21999-02-23 00:00:10 +0000567 for (i = 1024; ; i += i) {
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000568 outbuf = (time_char *)PyMem_Malloc(i*sizeof(time_char));
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000569 if (outbuf == NULL) {
Hirokazu Yamamoto575d1332009-02-16 09:13:20 +0000570 Py_DECREF(format);
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000571 return PyErr_NoMemory();
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000572 }
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000573 buflen = format_time(outbuf, i, fmt, &buf);
Guido van Rossumc222ec21999-02-23 00:00:10 +0000574 if (buflen > 0 || i >= 256 * fmtlen) {
575 /* If the buffer is 256 times as long as the format,
576 it's probably not failing for lack of room!
577 More likely, the format yields an empty result,
578 e.g. an empty format, or %Z when the timezone
579 is unknown. */
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000580 PyObject *ret;
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000581#ifdef HAVE_WCSFTIME
582 ret = PyUnicode_FromWideChar(outbuf, buflen);
583#else
Guido van Rossumb98cda42007-10-23 19:43:28 +0000584 ret = PyUnicode_Decode(outbuf, buflen,
585 TZNAME_ENCODING, NULL);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000586#endif
Walter Dörwaldcf47af42007-05-31 19:23:17 +0000587 PyMem_Free(outbuf);
Hirokazu Yamamoto575d1332009-02-16 09:13:20 +0000588 Py_DECREF(format);
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000589 return ret;
590 }
Walter Dörwaldcf47af42007-05-31 19:23:17 +0000591 PyMem_Free(outbuf);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000592#if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__)
593 /* VisualStudio .NET 2005 does this properly */
594 if (buflen == 0 && errno == EINVAL) {
595 PyErr_SetString(PyExc_ValueError, "Invalid format string");
Hirokazu Yamamoto575d1332009-02-16 09:13:20 +0000596 Py_DECREF(format);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000597 return 0;
598 }
599#endif
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000600 }
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000601}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000602
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000603#undef time_char
604#undef format_time
605
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000606PyDoc_STRVAR(strftime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000607"strftime(format[, tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000608\n\
609Convert a time tuple to a string according to a format specification.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000610See the library reference manual for formatting codes. When the time tuple\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000611is not present, current time as returned by localtime() is used.");
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000612#endif /* HAVE_STRFTIME */
613
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000614static PyObject *
615time_strptime(PyObject *self, PyObject *args)
616{
Brett Cannonec79b1c2009-09-22 19:15:35 +0000617 PyObject *strptime_module = PyImport_ImportModuleNoBlock("_strptime");
618 PyObject *strptime_result;
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000619
Brett Cannonec79b1c2009-09-22 19:15:35 +0000620 if (!strptime_module)
621 return NULL;
622 strptime_result = PyObject_CallMethod(strptime_module,
623 "_strptime_time", "O", args);
624 Py_DECREF(strptime_module);
625 return strptime_result;
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000626}
627
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000628PyDoc_STRVAR(strptime_doc,
Brett Cannon20def8b2003-07-01 05:16:08 +0000629"strptime(string, format) -> struct_time\n\
Martin v. Löwisb3cfc1d2001-12-02 12:27:43 +0000630\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000631Parse a string to a time tuple according to a format specification.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000632See the library reference manual for formatting codes (same as strftime()).");
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000633
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000634
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000635static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000636time_asctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000637{
Thomas Woutersfe385252001-01-19 23:16:56 +0000638 PyObject *tup = NULL;
Guido van Rossum9e90a671993-06-24 11:10:19 +0000639 struct tm buf;
640 char *p;
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000641 if (!PyArg_UnpackTuple(args, "asctime", 0, 1, &tup))
Guido van Rossumb2b42dd2000-01-12 16:38:20 +0000642 return NULL;
Thomas Woutersfe385252001-01-19 23:16:56 +0000643 if (tup == NULL) {
644 time_t tt = time(NULL);
645 buf = *localtime(&tt);
646 } else if (!gettmarg(tup, &buf))
Guido van Rossum9e90a671993-06-24 11:10:19 +0000647 return NULL;
648 p = asctime(&buf);
649 if (p[24] == '\n')
650 p[24] = '\0';
Guido van Rossumeda12ec2007-08-24 03:51:52 +0000651 return PyUnicode_FromString(p);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000652}
653
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000654PyDoc_STRVAR(asctime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000655"asctime([tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000656\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000657Convert a time tuple to a string, e.g. 'Sat Jun 06 16:26:11 1998'.\n\
658When the time tuple is not present, current time as returned by localtime()\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000659is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000660
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000661static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000662time_ctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000663{
Fred Drakef901abd2004-08-03 17:58:55 +0000664 PyObject *ot = NULL;
Guido van Rossum9e90a671993-06-24 11:10:19 +0000665 time_t tt;
666 char *p;
Guido van Rossum10b164a2001-09-25 13:59:01 +0000667
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000668 if (!PyArg_UnpackTuple(args, "ctime", 0, 1, &ot))
Fred Drakef901abd2004-08-03 17:58:55 +0000669 return NULL;
670 if (ot == NULL || ot == Py_None)
Thomas Woutersfe385252001-01-19 23:16:56 +0000671 tt = time(NULL);
672 else {
Fred Drakef901abd2004-08-03 17:58:55 +0000673 double dt = PyFloat_AsDouble(ot);
674 if (PyErr_Occurred())
Thomas Woutersfe385252001-01-19 23:16:56 +0000675 return NULL;
Brett Cannon298c3802004-06-19 20:48:43 +0000676 tt = _PyTime_DoubleToTimet(dt);
677 if (tt == (time_t)-1 && PyErr_Occurred())
678 return NULL;
Thomas Woutersfe385252001-01-19 23:16:56 +0000679 }
Guido van Rossum9e90a671993-06-24 11:10:19 +0000680 p = ctime(&tt);
Guido van Rossum78535701998-03-03 22:19:10 +0000681 if (p == NULL) {
682 PyErr_SetString(PyExc_ValueError, "unconvertible time");
683 return NULL;
684 }
Guido van Rossum9e90a671993-06-24 11:10:19 +0000685 if (p[24] == '\n')
686 p[24] = '\0';
Guido van Rossumeda12ec2007-08-24 03:51:52 +0000687 return PyUnicode_FromString(p);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000688}
689
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000690PyDoc_STRVAR(ctime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000691"ctime(seconds) -> string\n\
692\n\
693Convert a time in seconds since the Epoch to a string in local time.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000694This is equivalent to asctime(localtime(seconds)). When the time tuple is\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000695not present, current time as returned by localtime() is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000696
Guido van Rossum60cd8131998-03-06 17:16:21 +0000697#ifdef HAVE_MKTIME
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000698static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000699time_mktime(PyObject *self, PyObject *tup)
Guido van Rossum234f9421993-06-17 12:35:49 +0000700{
701 struct tm buf;
Guido van Rossumbceeac81996-05-23 22:53:47 +0000702 time_t tt;
Guido van Rossumb2b42dd2000-01-12 16:38:20 +0000703 if (!gettmarg(tup, &buf))
Guido van Rossum234f9421993-06-17 12:35:49 +0000704 return NULL;
Guido van Rossumbceeac81996-05-23 22:53:47 +0000705 tt = mktime(&buf);
706 if (tt == (time_t)(-1)) {
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000707 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum10b164a2001-09-25 13:59:01 +0000708 "mktime argument out of range");
Guido van Rossumbceeac81996-05-23 22:53:47 +0000709 return NULL;
710 }
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000711 return PyFloat_FromDouble((double)tt);
Guido van Rossum234f9421993-06-17 12:35:49 +0000712}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000713
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000714PyDoc_STRVAR(mktime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000715"mktime(tuple) -> floating point number\n\
716\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000717Convert a time tuple in local time to seconds since the Epoch.");
Guido van Rossum60cd8131998-03-06 17:16:21 +0000718#endif /* HAVE_MKTIME */
Guido van Rossum234f9421993-06-17 12:35:49 +0000719
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000720#ifdef HAVE_WORKING_TZSET
Martin v. Löwis1a214512008-06-11 05:26:20 +0000721static void PyInit_timezone(PyObject *module);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000722
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000723static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000724time_tzset(PyObject *self, PyObject *unused)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000725{
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000726 PyObject* m;
Fred Drake9bb74322002-04-01 14:49:59 +0000727
Christian Heimes072c0f12008-01-03 23:01:04 +0000728 m = PyImport_ImportModuleNoBlock("time");
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000729 if (m == NULL) {
730 return NULL;
731 }
732
733 tzset();
734
735 /* Reset timezone, altzone, daylight and tzname */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000736 PyInit_timezone(m);
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000737 Py_DECREF(m);
Tim Peters1b6f7a92004-06-20 02:50:16 +0000738
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000739 Py_INCREF(Py_None);
740 return Py_None;
741}
742
743PyDoc_STRVAR(tzset_doc,
744"tzset(zone)\n\
745\n\
746Initialize, or reinitialize, the local timezone to the value stored in\n\
747os.environ['TZ']. The TZ environment variable should be specified in\n\
Neal Norwitzdc8e1942004-07-20 22:34:37 +0000748standard Unix timezone format as documented in the tzset man page\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000749(eg. 'US/Eastern', 'Europe/Amsterdam'). Unknown timezones will silently\n\
750fall back to UTC. If the TZ environment variable is not set, the local\n\
751timezone is set to the systems best guess of wallclock time.\n\
752Changing the TZ environment variable without calling tzset *may* change\n\
753the local timezone used by methods such as localtime, but this behaviour\n\
754should not be relied on.");
755#endif /* HAVE_WORKING_TZSET */
756
Martin v. Löwisd218dc12008-04-07 03:17:54 +0000757static void
Martin v. Löwis1a214512008-06-11 05:26:20 +0000758PyInit_timezone(PyObject *m) {
759 /* This code moved from PyInit_time wholesale to allow calling it from
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000760 time_tzset. In the future, some parts of it can be moved back
761 (for platforms that don't HAVE_WORKING_TZSET, when we know what they
Martin v. Löwisd218dc12008-04-07 03:17:54 +0000762 are), and the extraneous calls to tzset(3) should be removed.
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000763 I haven't done this yet, as I don't want to change this code as
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000764 little as possible when introducing the time.tzset and time.tzsetwall
765 methods. This should simply be a method of doing the following once,
766 at the top of this function and removing the call to tzset() from
767 time_tzset():
768
769 #ifdef HAVE_TZSET
770 tzset()
771 #endif
772
773 And I'm lazy and hate C so nyer.
774 */
Guido van Rossum10b164a2001-09-25 13:59:01 +0000775#if defined(HAVE_TZNAME) && !defined(__GLIBC__) && !defined(__CYGWIN__)
Martin v. Löwis3bb00702007-08-30 14:37:48 +0000776 PyObject *otz0, *otz1;
Guido van Rossum234f9421993-06-17 12:35:49 +0000777 tzset();
Guido van Rossum26452411998-09-28 22:07:11 +0000778#ifdef PYOS_OS2
Fred Drake9bb74322002-04-01 14:49:59 +0000779 PyModule_AddIntConstant(m, "timezone", _timezone);
Guido van Rossum26452411998-09-28 22:07:11 +0000780#else /* !PYOS_OS2 */
Fred Drake9bb74322002-04-01 14:49:59 +0000781 PyModule_AddIntConstant(m, "timezone", timezone);
Guido van Rossum26452411998-09-28 22:07:11 +0000782#endif /* PYOS_OS2 */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000783#ifdef HAVE_ALTZONE
Fred Drake9bb74322002-04-01 14:49:59 +0000784 PyModule_AddIntConstant(m, "altzone", altzone);
Guido van Rossumb6775db1994-08-01 11:34:53 +0000785#else
Guido van Rossum26452411998-09-28 22:07:11 +0000786#ifdef PYOS_OS2
Fred Drake9bb74322002-04-01 14:49:59 +0000787 PyModule_AddIntConstant(m, "altzone", _timezone-3600);
Guido van Rossum26452411998-09-28 22:07:11 +0000788#else /* !PYOS_OS2 */
Fred Drake9bb74322002-04-01 14:49:59 +0000789 PyModule_AddIntConstant(m, "altzone", timezone-3600);
Guido van Rossum26452411998-09-28 22:07:11 +0000790#endif /* PYOS_OS2 */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000791#endif
Fred Drake9bb74322002-04-01 14:49:59 +0000792 PyModule_AddIntConstant(m, "daylight", daylight);
Martin v. Löwis3bb00702007-08-30 14:37:48 +0000793 otz0 = PyUnicode_Decode(tzname[0], strlen(tzname[0]), TZNAME_ENCODING, NULL);
794 otz1 = PyUnicode_Decode(tzname[1], strlen(tzname[1]), TZNAME_ENCODING, NULL);
795 PyModule_AddObject(m, "tzname", Py_BuildValue("(NN)", otz0, otz1));
Guido van Rossum10b164a2001-09-25 13:59:01 +0000796#else /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Martin v. Löwis60a5d722002-10-16 20:28:25 +0000797#ifdef HAVE_STRUCT_TM_TM_ZONE
Guido van Rossum234f9421993-06-17 12:35:49 +0000798 {
799#define YEAR ((time_t)((365 * 24 + 6) * 3600))
800 time_t t;
801 struct tm *p;
Guido van Rossum57731601999-03-29 19:12:04 +0000802 long janzone, julyzone;
803 char janname[10], julyname[10];
Guido van Rossum234f9421993-06-17 12:35:49 +0000804 t = (time((time_t *)0) / YEAR) * YEAR;
805 p = localtime(&t);
Guido van Rossum57731601999-03-29 19:12:04 +0000806 janzone = -p->tm_gmtoff;
807 strncpy(janname, p->tm_zone ? p->tm_zone : " ", 9);
808 janname[9] = '\0';
Guido van Rossum234f9421993-06-17 12:35:49 +0000809 t += YEAR/2;
810 p = localtime(&t);
Guido van Rossum57731601999-03-29 19:12:04 +0000811 julyzone = -p->tm_gmtoff;
812 strncpy(julyname, p->tm_zone ? p->tm_zone : " ", 9);
813 julyname[9] = '\0';
Guido van Rossum10b164a2001-09-25 13:59:01 +0000814
Guido van Rossum57731601999-03-29 19:12:04 +0000815 if( janzone < julyzone ) {
816 /* DST is reversed in the southern hemisphere */
Fred Drake9bb74322002-04-01 14:49:59 +0000817 PyModule_AddIntConstant(m, "timezone", julyzone);
818 PyModule_AddIntConstant(m, "altzone", janzone);
819 PyModule_AddIntConstant(m, "daylight",
820 janzone != julyzone);
821 PyModule_AddObject(m, "tzname",
822 Py_BuildValue("(zz)",
823 julyname, janname));
Guido van Rossum57731601999-03-29 19:12:04 +0000824 } else {
Fred Drake9bb74322002-04-01 14:49:59 +0000825 PyModule_AddIntConstant(m, "timezone", janzone);
826 PyModule_AddIntConstant(m, "altzone", julyzone);
827 PyModule_AddIntConstant(m, "daylight",
828 janzone != julyzone);
829 PyModule_AddObject(m, "tzname",
830 Py_BuildValue("(zz)",
831 janname, julyname));
Guido van Rossum57731601999-03-29 19:12:04 +0000832 }
Guido van Rossum234f9421993-06-17 12:35:49 +0000833 }
Guido van Rossume6a4b7b1997-10-08 15:27:56 +0000834#else
Martin v. Löwis60a5d722002-10-16 20:28:25 +0000835#endif /* HAVE_STRUCT_TM_TM_ZONE */
Tim Peters26ae7cd2001-03-20 03:26:49 +0000836#ifdef __CYGWIN__
837 tzset();
Fred Drake9bb74322002-04-01 14:49:59 +0000838 PyModule_AddIntConstant(m, "timezone", _timezone);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000839 PyModule_AddIntConstant(m, "altzone", _timezone-3600);
Fred Drake9bb74322002-04-01 14:49:59 +0000840 PyModule_AddIntConstant(m, "daylight", _daylight);
841 PyModule_AddObject(m, "tzname",
842 Py_BuildValue("(zz)", _tzname[0], _tzname[1]));
Tim Peters26ae7cd2001-03-20 03:26:49 +0000843#endif /* __CYGWIN__ */
Guido van Rossum10b164a2001-09-25 13:59:01 +0000844#endif /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000845}
846
847
848static PyMethodDef time_methods[] = {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000849 {"time", time_time, METH_NOARGS, time_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000850#ifdef HAVE_CLOCK
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000851 {"clock", time_clock, METH_NOARGS, clock_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000852#endif
853 {"sleep", time_sleep, METH_VARARGS, sleep_doc},
854 {"gmtime", time_gmtime, METH_VARARGS, gmtime_doc},
855 {"localtime", time_localtime, METH_VARARGS, localtime_doc},
856 {"asctime", time_asctime, METH_VARARGS, asctime_doc},
857 {"ctime", time_ctime, METH_VARARGS, ctime_doc},
858#ifdef HAVE_MKTIME
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000859 {"mktime", time_mktime, METH_O, mktime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000860#endif
861#ifdef HAVE_STRFTIME
862 {"strftime", time_strftime, METH_VARARGS, strftime_doc},
863#endif
864 {"strptime", time_strptime, METH_VARARGS, strptime_doc},
865#ifdef HAVE_WORKING_TZSET
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000866 {"tzset", time_tzset, METH_NOARGS, tzset_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000867#endif
868 {NULL, NULL} /* sentinel */
869};
870
871
872PyDoc_STRVAR(module_doc,
873"This module provides various functions to manipulate time values.\n\
874\n\
875There are two standard representations of time. One is the number\n\
876of seconds since the Epoch, in UTC (a.k.a. GMT). It may be an integer\n\
877or a floating point number (to represent fractions of seconds).\n\
878The Epoch is system-defined; on Unix, it is generally January 1st, 1970.\n\
879The actual value can be retrieved by calling gmtime(0).\n\
880\n\
881The other representation is a tuple of 9 integers giving local time.\n\
882The tuple items are:\n\
883 year (four digits, e.g. 1998)\n\
884 month (1-12)\n\
885 day (1-31)\n\
886 hours (0-23)\n\
887 minutes (0-59)\n\
888 seconds (0-59)\n\
889 weekday (0-6, Monday is 0)\n\
890 Julian day (day in the year, 1-366)\n\
891 DST (Daylight Savings Time) flag (-1, 0 or 1)\n\
892If the DST flag is 0, the time is given in the regular time zone;\n\
893if it is 1, the time is given in the DST time zone;\n\
894if it is -1, mktime() should guess based on the date and time.\n\
895\n\
896Variables:\n\
897\n\
898timezone -- difference in seconds between UTC and local standard time\n\
899altzone -- difference in seconds between UTC and local DST time\n\
900daylight -- whether local time should reflect DST\n\
901tzname -- tuple of (standard time zone name, DST time zone name)\n\
902\n\
903Functions:\n\
904\n\
905time() -- return current time in seconds since the Epoch as a float\n\
906clock() -- return CPU time since process start as a float\n\
907sleep() -- delay for a number of seconds given as a float\n\
908gmtime() -- convert seconds since Epoch to UTC tuple\n\
909localtime() -- convert seconds since Epoch to local time tuple\n\
910asctime() -- convert time tuple to string\n\
911ctime() -- convert time in seconds to string\n\
912mktime() -- convert local time tuple to seconds since Epoch\n\
913strftime() -- convert time tuple to string according to format specification\n\
914strptime() -- parse string to time tuple according to format specification\n\
915tzset() -- change the local timezone");
916
917
Martin v. Löwis1a214512008-06-11 05:26:20 +0000918
919static struct PyModuleDef timemodule = {
920 PyModuleDef_HEAD_INIT,
921 "time",
922 module_doc,
923 -1,
924 time_methods,
925 NULL,
926 NULL,
927 NULL,
928 NULL
929};
930
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000931PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +0000932PyInit_time(void)
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000933{
934 PyObject *m;
935 char *p;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000936 m = PyModule_Create(&timemodule);
Neal Norwitz1ac754f2006-01-19 06:09:39 +0000937 if (m == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000938 return NULL;
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000939
940 /* Accept 2-digit dates unless PYTHONY2K is set and non-empty */
941 p = Py_GETENV("PYTHONY2K");
942 PyModule_AddIntConstant(m, "accept2dyear", (long) (!p || !*p));
943 /* Squirrel away the module's dictionary for the y2k check */
944 moddict = PyModule_GetDict(m);
945 Py_INCREF(moddict);
946
947 /* Set, or reset, module variables like time.timezone */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000948 PyInit_timezone(m);
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000949
Mark Hammond975e3922002-07-16 01:29:19 +0000950#ifdef MS_WINDOWS
951 /* Helper to allow interrupts for Windows.
952 If Ctrl+C event delivered while not sleeping
953 it will be ignored.
954 */
955 main_thread = PyThread_get_thread_ident();
956 hInterruptEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
957 SetConsoleCtrlHandler( PyCtrlHandler, TRUE);
958#endif /* MS_WINDOWS */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000959 if (!initialized) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000960 PyStructSequence_InitType(&StructTimeType,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000961 &struct_time_type_desc);
962 }
Fred Drake9bb74322002-04-01 14:49:59 +0000963 Py_INCREF(&StructTimeType);
964 PyModule_AddObject(m, "struct_time", (PyObject*) &StructTimeType);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000965 initialized = 1;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000966 return m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000967}
968
969
Guido van Rossumb6775db1994-08-01 11:34:53 +0000970/* Implement floattime() for various platforms */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000971
Guido van Rossumb6775db1994-08-01 11:34:53 +0000972static double
Thomas Woutersf3f33dc2000-07-21 06:00:07 +0000973floattime(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000974{
Guido van Rossumb6775db1994-08-01 11:34:53 +0000975 /* There are three ways to get the time:
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000976 (1) gettimeofday() -- resolution in microseconds
977 (2) ftime() -- resolution in milliseconds
978 (3) time() -- resolution in seconds
979 In all cases the return value is a float in seconds.
980 Since on some systems (e.g. SCO ODT 3.0) gettimeofday() may
981 fail, so we fall back on ftime() or time().
982 Note: clock resolution does not imply clock accuracy! */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000983#ifdef HAVE_GETTIMEOFDAY
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000984 {
985 struct timeval t;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000986#ifdef GETTIMEOFDAY_NO_TZ
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000987 if (gettimeofday(&t) == 0)
988 return (double)t.tv_sec + t.tv_usec*0.000001;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000989#else /* !GETTIMEOFDAY_NO_TZ */
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000990 if (gettimeofday(&t, (struct timezone *)NULL) == 0)
991 return (double)t.tv_sec + t.tv_usec*0.000001;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000992#endif /* !GETTIMEOFDAY_NO_TZ */
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000993 }
Thomas Wouters477c8d52006-05-27 19:21:47 +0000994
Guido van Rossumb6775db1994-08-01 11:34:53 +0000995#endif /* !HAVE_GETTIMEOFDAY */
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000996 {
Guido van Rossumd3eb5771999-03-09 16:07:23 +0000997#if defined(HAVE_FTIME)
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000998 struct timeb t;
999 ftime(&t);
1000 return (double)t.time + (double)t.millitm * (double)0.001;
Guido van Rossumb6775db1994-08-01 11:34:53 +00001001#else /* !HAVE_FTIME */
Barry Warsaw4a6cf411997-01-13 22:44:55 +00001002 time_t secs;
1003 time(&secs);
1004 return (double)secs;
Guido van Rossumb6775db1994-08-01 11:34:53 +00001005#endif /* !HAVE_FTIME */
Barry Warsaw4a6cf411997-01-13 22:44:55 +00001006 }
Guido van Rossum426035c1991-02-19 12:27:35 +00001007}
1008
Guido van Rossumb6775db1994-08-01 11:34:53 +00001009
1010/* Implement floatsleep() for various platforms.
1011 When interrupted (or when another error occurs), return -1 and
1012 set an exception; else return 0. */
1013
1014static int
Guido van Rossuma320fd31995-03-09 12:14:15 +00001015floatsleep(double secs)
Guido van Rossum426035c1991-02-19 12:27:35 +00001016{
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00001017/* XXX Should test for MS_WINDOWS first! */
Skip Montanaroeb33e5a2007-08-17 12:57:41 +00001018#if defined(HAVE_SELECT) && !defined(__EMX__)
Guido van Rossum426035c1991-02-19 12:27:35 +00001019 struct timeval t;
Guido van Rossum775f4da1993-01-09 17:18:52 +00001020 double frac;
Guido van Rossum775f4da1993-01-09 17:18:52 +00001021 frac = fmod(secs, 1.0);
1022 secs = floor(secs);
1023 t.tv_sec = (long)secs;
1024 t.tv_usec = (long)(frac*1000000.0);
Guido van Rossum8607ae21997-11-03 22:04:46 +00001025 Py_BEGIN_ALLOW_THREADS
Guido van Rossumb6775db1994-08-01 11:34:53 +00001026 if (select(0, (fd_set *)0, (fd_set *)0, (fd_set *)0, &t) != 0) {
Guido van Rossum09cbb011999-11-08 15:32:27 +00001027#ifdef EINTR
Guido van Rossuma5456d51999-08-19 14:40:27 +00001028 if (errno != EINTR) {
Guido van Rossum09cbb011999-11-08 15:32:27 +00001029#else
1030 if (1) {
1031#endif
Andrew M. Kuchlingc24ca4b2000-03-24 20:35:20 +00001032 Py_BLOCK_THREADS
Guido van Rossuma5456d51999-08-19 14:40:27 +00001033 PyErr_SetFromErrno(PyExc_IOError);
1034 return -1;
1035 }
Guido van Rossumb6775db1994-08-01 11:34:53 +00001036 }
Guido van Rossum8607ae21997-11-03 22:04:46 +00001037 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +00001038#elif defined(__WATCOMC__) && !defined(__QNX__)
Guido van Rossumbceeac81996-05-23 22:53:47 +00001039 /* XXX Can't interrupt this sleep */
Guido van Rossum8607ae21997-11-03 22:04:46 +00001040 Py_BEGIN_ALLOW_THREADS
Guido van Rossumbceeac81996-05-23 22:53:47 +00001041 delay((int)(secs * 1000 + 0.5)); /* delay() uses milliseconds */
Guido van Rossum8607ae21997-11-03 22:04:46 +00001042 Py_END_ALLOW_THREADS
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00001043#elif defined(MS_WINDOWS)
Fred Drake0e123952000-06-29 21:31:02 +00001044 {
1045 double millisecs = secs * 1000.0;
Tim Peters513a1cd2003-01-19 04:54:58 +00001046 unsigned long ul_millis;
1047
Fred Drake0e123952000-06-29 21:31:02 +00001048 if (millisecs > (double)ULONG_MAX) {
Tim Peters513a1cd2003-01-19 04:54:58 +00001049 PyErr_SetString(PyExc_OverflowError,
1050 "sleep length is too large");
Fred Drake0e123952000-06-29 21:31:02 +00001051 return -1;
1052 }
Fred Drake0e123952000-06-29 21:31:02 +00001053 Py_BEGIN_ALLOW_THREADS
Tim Peters513a1cd2003-01-19 04:54:58 +00001054 /* Allow sleep(0) to maintain win32 semantics, and as decreed
1055 * by Guido, only the main thread can be interrupted.
1056 */
1057 ul_millis = (unsigned long)millisecs;
1058 if (ul_millis == 0 ||
1059 main_thread != PyThread_get_thread_ident())
1060 Sleep(ul_millis);
Mark Hammond975e3922002-07-16 01:29:19 +00001061 else {
1062 DWORD rc;
1063 ResetEvent(hInterruptEvent);
Tim Peters513a1cd2003-01-19 04:54:58 +00001064 rc = WaitForSingleObject(hInterruptEvent, ul_millis);
1065 if (rc == WAIT_OBJECT_0) {
1066 /* Yield to make sure real Python signal
1067 * handler called.
1068 */
Mark Hammond975e3922002-07-16 01:29:19 +00001069 Sleep(1);
1070 Py_BLOCK_THREADS
Mark Hammond975e3922002-07-16 01:29:19 +00001071 errno = EINTR;
1072 PyErr_SetFromErrno(PyExc_IOError);
1073 return -1;
1074 }
1075 }
Fred Drake0e123952000-06-29 21:31:02 +00001076 Py_END_ALLOW_THREADS
1077 }
Martin v. Löwis02af9642002-01-16 11:04:06 +00001078#elif defined(PYOS_OS2)
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +00001079 /* This Sleep *IS* Interruptable by Exceptions */
Guido van Rossum1d0d7e41997-12-29 20:03:10 +00001080 Py_BEGIN_ALLOW_THREADS
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +00001081 if (DosSleep(secs * 1000) != NO_ERROR) {
Guido van Rossum1d0d7e41997-12-29 20:03:10 +00001082 Py_BLOCK_THREADS
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +00001083 PyErr_SetFromErrno(PyExc_IOError);
1084 return -1;
1085 }
Guido van Rossum1d0d7e41997-12-29 20:03:10 +00001086 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +00001087#elif defined(PLAN9)
1088 {
1089 double millisecs = secs * 1000.0;
1090 if (millisecs > (double)LONG_MAX) {
1091 PyErr_SetString(PyExc_OverflowError, "sleep length is too large");
1092 return -1;
1093 }
1094 /* This sleep *CAN BE* interrupted. */
1095 Py_BEGIN_ALLOW_THREADS
1096 if(sleep((long)millisecs) < 0){
1097 Py_BLOCK_THREADS
1098 PyErr_SetFromErrno(PyExc_IOError);
1099 return -1;
1100 }
1101 Py_END_ALLOW_THREADS
1102 }
1103#else
Guido van Rossumb6775db1994-08-01 11:34:53 +00001104 /* XXX Can't interrupt this sleep */
Guido van Rossum8607ae21997-11-03 22:04:46 +00001105 Py_BEGIN_ALLOW_THREADS
Guido van Rossumb6775db1994-08-01 11:34:53 +00001106 sleep((int)secs);
Guido van Rossum8607ae21997-11-03 22:04:46 +00001107 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +00001108#endif
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001109
Guido van Rossumb6775db1994-08-01 11:34:53 +00001110 return 0;
Guido van Rossum80c9d881991-04-16 08:47:51 +00001111}