blob: 1954d0c75bfbf65a65922d84af6e952feb8885b8 [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
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000420static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000421time_strftime(PyObject *self, PyObject *args)
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000422{
Thomas Woutersfe385252001-01-19 23:16:56 +0000423 PyObject *tup = NULL;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000424 struct tm buf;
425 const char *fmt;
Guido van Rossumeda12ec2007-08-24 03:51:52 +0000426 PyObject *format;
Guido van Rossumfa481162000-06-28 21:33:59 +0000427 size_t fmtlen, buflen;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000428 char *outbuf = 0;
Guido van Rossumfa481162000-06-28 21:33:59 +0000429 size_t i;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000430
Thomas Wouters334fb892000-07-25 12:56:38 +0000431 memset((void *) &buf, '\0', sizeof(buf));
Guido van Rossum1f41f841998-04-27 19:04:26 +0000432
Guido van Rossumeda12ec2007-08-24 03:51:52 +0000433 /* Will always expect a unicode string to be passed as format.
434 Given that there's no str type anymore in py3k this seems safe.
435 */
436 if (!PyArg_ParseTuple(args, "U|O:strftime", &format, &tup))
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000437 return NULL;
Thomas Woutersfe385252001-01-19 23:16:56 +0000438
439 if (tup == NULL) {
440 time_t tt = time(NULL);
441 buf = *localtime(&tt);
442 } else if (!gettmarg(tup, &buf))
443 return NULL;
Guido van Rossum10b164a2001-09-25 13:59:01 +0000444
Brett Cannond1080a32004-03-02 04:38:10 +0000445 /* Checks added to make sure strftime() does not crash Python by
446 indexing blindly into some array for a textual representation
447 by some bad index (fixes bug #897625).
Tim Peters1b6f7a92004-06-20 02:50:16 +0000448
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000449 Also support values of zero from Python code for arguments in which
450 that is out of range by forcing that value to the lowest value that
451 is valid (fixed bug #1520914).
452
453 Valid ranges based on what is allowed in struct tm:
454
455 - tm_year: [0, max(int)] (1)
456 - tm_mon: [0, 11] (2)
457 - tm_mday: [1, 31]
458 - tm_hour: [0, 23]
459 - tm_min: [0, 59]
460 - tm_sec: [0, 60]
461 - tm_wday: [0, 6] (1)
462 - tm_yday: [0, 365] (2)
463 - tm_isdst: [-max(int), max(int)]
464
465 (1) gettmarg() handles bounds-checking.
466 (2) Python's acceptable range is one greater than the range in C,
467 thus need to check against automatic decrement by gettmarg().
Brett Cannond1080a32004-03-02 04:38:10 +0000468 */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000469 if (buf.tm_mon == -1)
470 buf.tm_mon = 0;
471 else if (buf.tm_mon < 0 || buf.tm_mon > 11) {
Brett Cannond1080a32004-03-02 04:38:10 +0000472 PyErr_SetString(PyExc_ValueError, "month out of range");
473 return NULL;
474 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000475 if (buf.tm_mday == 0)
476 buf.tm_mday = 1;
477 else if (buf.tm_mday < 0 || buf.tm_mday > 31) {
Brett Cannond1080a32004-03-02 04:38:10 +0000478 PyErr_SetString(PyExc_ValueError, "day of month out of range");
479 return NULL;
480 }
481 if (buf.tm_hour < 0 || buf.tm_hour > 23) {
482 PyErr_SetString(PyExc_ValueError, "hour out of range");
483 return NULL;
484 }
485 if (buf.tm_min < 0 || buf.tm_min > 59) {
486 PyErr_SetString(PyExc_ValueError, "minute out of range");
487 return NULL;
488 }
489 if (buf.tm_sec < 0 || buf.tm_sec > 61) {
490 PyErr_SetString(PyExc_ValueError, "seconds out of range");
491 return NULL;
492 }
493 /* tm_wday does not need checking of its upper-bound since taking
494 ``% 7`` in gettmarg() automatically restricts the range. */
495 if (buf.tm_wday < 0) {
496 PyErr_SetString(PyExc_ValueError, "day of week out of range");
497 return NULL;
498 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000499 if (buf.tm_yday == -1)
500 buf.tm_yday = 0;
501 else if (buf.tm_yday < 0 || buf.tm_yday > 365) {
Brett Cannond1080a32004-03-02 04:38:10 +0000502 PyErr_SetString(PyExc_ValueError, "day of year out of range");
503 return NULL;
504 }
505 if (buf.tm_isdst < -1 || buf.tm_isdst > 1) {
506 PyErr_SetString(PyExc_ValueError,
507 "daylight savings flag out of range");
508 return NULL;
509 }
510
Guido van Rossumeda12ec2007-08-24 03:51:52 +0000511 /* Convert the unicode string to an ascii one */
512 fmt = PyUnicode_AsString(format);
513
Guido van Rossumc222ec21999-02-23 00:00:10 +0000514 fmtlen = strlen(fmt);
515
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000516 /* I hate these functions that presume you know how big the output
517 * will be ahead of time...
518 */
Guido van Rossumc222ec21999-02-23 00:00:10 +0000519 for (i = 1024; ; i += i) {
Walter Dörwaldcf47af42007-05-31 19:23:17 +0000520 outbuf = (char *)PyMem_Malloc(i);
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000521 if (outbuf == NULL) {
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000522 return PyErr_NoMemory();
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000523 }
Guido van Rossumc222ec21999-02-23 00:00:10 +0000524 buflen = strftime(outbuf, i, fmt, &buf);
525 if (buflen > 0 || i >= 256 * fmtlen) {
526 /* If the buffer is 256 times as long as the format,
527 it's probably not failing for lack of room!
528 More likely, the format yields an empty result,
529 e.g. an empty format, or %Z when the timezone
530 is unknown. */
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000531 PyObject *ret;
Guido van Rossumb98cda42007-10-23 19:43:28 +0000532 ret = PyUnicode_Decode(outbuf, buflen,
533 TZNAME_ENCODING, NULL);
Walter Dörwaldcf47af42007-05-31 19:23:17 +0000534 PyMem_Free(outbuf);
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000535 return ret;
536 }
Walter Dörwaldcf47af42007-05-31 19:23:17 +0000537 PyMem_Free(outbuf);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000538#if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__)
539 /* VisualStudio .NET 2005 does this properly */
540 if (buflen == 0 && errno == EINVAL) {
541 PyErr_SetString(PyExc_ValueError, "Invalid format string");
542 return 0;
543 }
544#endif
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000545 }
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000546}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000547
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000548PyDoc_STRVAR(strftime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000549"strftime(format[, tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000550\n\
551Convert a time tuple to a string according to a format specification.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000552See the library reference manual for formatting codes. When the time tuple\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000553is not present, current time as returned by localtime() is used.");
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000554#endif /* HAVE_STRFTIME */
555
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000556static PyObject *
557time_strptime(PyObject *self, PyObject *args)
558{
Christian Heimes072c0f12008-01-03 23:01:04 +0000559 PyObject *strptime_module = PyImport_ImportModuleNoBlock("_strptime");
Raymond Hettinger502168a2003-04-10 16:03:22 +0000560 PyObject *strptime_result;
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000561
Tim Peters513a1cd2003-01-19 04:54:58 +0000562 if (!strptime_module)
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000563 return NULL;
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000564 strptime_result = PyObject_CallMethod(strptime_module, "_strptime_time", "O", args);
Raymond Hettinger502168a2003-04-10 16:03:22 +0000565 Py_DECREF(strptime_module);
566 return strptime_result;
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000567}
568
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000569PyDoc_STRVAR(strptime_doc,
Brett Cannon20def8b2003-07-01 05:16:08 +0000570"strptime(string, format) -> struct_time\n\
Martin v. Löwisb3cfc1d2001-12-02 12:27:43 +0000571\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000572Parse a string to a time tuple according to a format specification.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000573See the library reference manual for formatting codes (same as strftime()).");
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000574
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000575
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000576static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000577time_asctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000578{
Thomas Woutersfe385252001-01-19 23:16:56 +0000579 PyObject *tup = NULL;
Guido van Rossum9e90a671993-06-24 11:10:19 +0000580 struct tm buf;
581 char *p;
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000582 if (!PyArg_UnpackTuple(args, "asctime", 0, 1, &tup))
Guido van Rossumb2b42dd2000-01-12 16:38:20 +0000583 return NULL;
Thomas Woutersfe385252001-01-19 23:16:56 +0000584 if (tup == NULL) {
585 time_t tt = time(NULL);
586 buf = *localtime(&tt);
587 } else if (!gettmarg(tup, &buf))
Guido van Rossum9e90a671993-06-24 11:10:19 +0000588 return NULL;
589 p = asctime(&buf);
590 if (p[24] == '\n')
591 p[24] = '\0';
Guido van Rossumeda12ec2007-08-24 03:51:52 +0000592 return PyUnicode_FromString(p);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000593}
594
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000595PyDoc_STRVAR(asctime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000596"asctime([tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000597\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000598Convert a time tuple to a string, e.g. 'Sat Jun 06 16:26:11 1998'.\n\
599When the time tuple is not present, current time as returned by localtime()\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000600is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000601
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000602static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000603time_ctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000604{
Fred Drakef901abd2004-08-03 17:58:55 +0000605 PyObject *ot = NULL;
Guido van Rossum9e90a671993-06-24 11:10:19 +0000606 time_t tt;
607 char *p;
Guido van Rossum10b164a2001-09-25 13:59:01 +0000608
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000609 if (!PyArg_UnpackTuple(args, "ctime", 0, 1, &ot))
Fred Drakef901abd2004-08-03 17:58:55 +0000610 return NULL;
611 if (ot == NULL || ot == Py_None)
Thomas Woutersfe385252001-01-19 23:16:56 +0000612 tt = time(NULL);
613 else {
Fred Drakef901abd2004-08-03 17:58:55 +0000614 double dt = PyFloat_AsDouble(ot);
615 if (PyErr_Occurred())
Thomas Woutersfe385252001-01-19 23:16:56 +0000616 return NULL;
Brett Cannon298c3802004-06-19 20:48:43 +0000617 tt = _PyTime_DoubleToTimet(dt);
618 if (tt == (time_t)-1 && PyErr_Occurred())
619 return NULL;
Thomas Woutersfe385252001-01-19 23:16:56 +0000620 }
Guido van Rossum9e90a671993-06-24 11:10:19 +0000621 p = ctime(&tt);
Guido van Rossum78535701998-03-03 22:19:10 +0000622 if (p == NULL) {
623 PyErr_SetString(PyExc_ValueError, "unconvertible time");
624 return NULL;
625 }
Guido van Rossum9e90a671993-06-24 11:10:19 +0000626 if (p[24] == '\n')
627 p[24] = '\0';
Guido van Rossumeda12ec2007-08-24 03:51:52 +0000628 return PyUnicode_FromString(p);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000629}
630
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000631PyDoc_STRVAR(ctime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000632"ctime(seconds) -> string\n\
633\n\
634Convert a time in seconds since the Epoch to a string in local time.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000635This is equivalent to asctime(localtime(seconds)). When the time tuple is\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000636not present, current time as returned by localtime() is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000637
Guido van Rossum60cd8131998-03-06 17:16:21 +0000638#ifdef HAVE_MKTIME
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000639static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000640time_mktime(PyObject *self, PyObject *tup)
Guido van Rossum234f9421993-06-17 12:35:49 +0000641{
642 struct tm buf;
Guido van Rossumbceeac81996-05-23 22:53:47 +0000643 time_t tt;
644 tt = time(&tt);
645 buf = *localtime(&tt);
Guido van Rossumb2b42dd2000-01-12 16:38:20 +0000646 if (!gettmarg(tup, &buf))
Guido van Rossum234f9421993-06-17 12:35:49 +0000647 return NULL;
Guido van Rossumbceeac81996-05-23 22:53:47 +0000648 tt = mktime(&buf);
649 if (tt == (time_t)(-1)) {
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000650 PyErr_SetString(PyExc_OverflowError,
Guido van Rossum10b164a2001-09-25 13:59:01 +0000651 "mktime argument out of range");
Guido van Rossumbceeac81996-05-23 22:53:47 +0000652 return NULL;
653 }
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000654 return PyFloat_FromDouble((double)tt);
Guido van Rossum234f9421993-06-17 12:35:49 +0000655}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000656
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000657PyDoc_STRVAR(mktime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000658"mktime(tuple) -> floating point number\n\
659\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000660Convert a time tuple in local time to seconds since the Epoch.");
Guido van Rossum60cd8131998-03-06 17:16:21 +0000661#endif /* HAVE_MKTIME */
Guido van Rossum234f9421993-06-17 12:35:49 +0000662
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000663#ifdef HAVE_WORKING_TZSET
Martin v. Löwis1a214512008-06-11 05:26:20 +0000664static void PyInit_timezone(PyObject *module);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000665
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000666static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000667time_tzset(PyObject *self, PyObject *unused)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000668{
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000669 PyObject* m;
Fred Drake9bb74322002-04-01 14:49:59 +0000670
Christian Heimes072c0f12008-01-03 23:01:04 +0000671 m = PyImport_ImportModuleNoBlock("time");
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000672 if (m == NULL) {
673 return NULL;
674 }
675
676 tzset();
677
678 /* Reset timezone, altzone, daylight and tzname */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000679 PyInit_timezone(m);
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000680 Py_DECREF(m);
Tim Peters1b6f7a92004-06-20 02:50:16 +0000681
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000682 Py_INCREF(Py_None);
683 return Py_None;
684}
685
686PyDoc_STRVAR(tzset_doc,
687"tzset(zone)\n\
688\n\
689Initialize, or reinitialize, the local timezone to the value stored in\n\
690os.environ['TZ']. The TZ environment variable should be specified in\n\
Neal Norwitzdc8e1942004-07-20 22:34:37 +0000691standard Unix timezone format as documented in the tzset man page\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000692(eg. 'US/Eastern', 'Europe/Amsterdam'). Unknown timezones will silently\n\
693fall back to UTC. If the TZ environment variable is not set, the local\n\
694timezone is set to the systems best guess of wallclock time.\n\
695Changing the TZ environment variable without calling tzset *may* change\n\
696the local timezone used by methods such as localtime, but this behaviour\n\
697should not be relied on.");
698#endif /* HAVE_WORKING_TZSET */
699
Martin v. Löwisd218dc12008-04-07 03:17:54 +0000700static void
Martin v. Löwis1a214512008-06-11 05:26:20 +0000701PyInit_timezone(PyObject *m) {
702 /* This code moved from PyInit_time wholesale to allow calling it from
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000703 time_tzset. In the future, some parts of it can be moved back
704 (for platforms that don't HAVE_WORKING_TZSET, when we know what they
Martin v. Löwisd218dc12008-04-07 03:17:54 +0000705 are), and the extraneous calls to tzset(3) should be removed.
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000706 I haven't done this yet, as I don't want to change this code as
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000707 little as possible when introducing the time.tzset and time.tzsetwall
708 methods. This should simply be a method of doing the following once,
709 at the top of this function and removing the call to tzset() from
710 time_tzset():
711
712 #ifdef HAVE_TZSET
713 tzset()
714 #endif
715
716 And I'm lazy and hate C so nyer.
717 */
Guido van Rossum10b164a2001-09-25 13:59:01 +0000718#if defined(HAVE_TZNAME) && !defined(__GLIBC__) && !defined(__CYGWIN__)
Martin v. Löwis3bb00702007-08-30 14:37:48 +0000719 PyObject *otz0, *otz1;
Guido van Rossum234f9421993-06-17 12:35:49 +0000720 tzset();
Guido van Rossum26452411998-09-28 22:07:11 +0000721#ifdef PYOS_OS2
Fred Drake9bb74322002-04-01 14:49:59 +0000722 PyModule_AddIntConstant(m, "timezone", _timezone);
Guido van Rossum26452411998-09-28 22:07:11 +0000723#else /* !PYOS_OS2 */
Fred Drake9bb74322002-04-01 14:49:59 +0000724 PyModule_AddIntConstant(m, "timezone", timezone);
Guido van Rossum26452411998-09-28 22:07:11 +0000725#endif /* PYOS_OS2 */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000726#ifdef HAVE_ALTZONE
Fred Drake9bb74322002-04-01 14:49:59 +0000727 PyModule_AddIntConstant(m, "altzone", altzone);
Guido van Rossumb6775db1994-08-01 11:34:53 +0000728#else
Guido van Rossum26452411998-09-28 22:07:11 +0000729#ifdef PYOS_OS2
Fred Drake9bb74322002-04-01 14:49:59 +0000730 PyModule_AddIntConstant(m, "altzone", _timezone-3600);
Guido van Rossum26452411998-09-28 22:07:11 +0000731#else /* !PYOS_OS2 */
Fred Drake9bb74322002-04-01 14:49:59 +0000732 PyModule_AddIntConstant(m, "altzone", timezone-3600);
Guido van Rossum26452411998-09-28 22:07:11 +0000733#endif /* PYOS_OS2 */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000734#endif
Fred Drake9bb74322002-04-01 14:49:59 +0000735 PyModule_AddIntConstant(m, "daylight", daylight);
Martin v. Löwis3bb00702007-08-30 14:37:48 +0000736 otz0 = PyUnicode_Decode(tzname[0], strlen(tzname[0]), TZNAME_ENCODING, NULL);
737 otz1 = PyUnicode_Decode(tzname[1], strlen(tzname[1]), TZNAME_ENCODING, NULL);
738 PyModule_AddObject(m, "tzname", Py_BuildValue("(NN)", otz0, otz1));
Guido van Rossum10b164a2001-09-25 13:59:01 +0000739#else /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Martin v. Löwis60a5d722002-10-16 20:28:25 +0000740#ifdef HAVE_STRUCT_TM_TM_ZONE
Guido van Rossum234f9421993-06-17 12:35:49 +0000741 {
742#define YEAR ((time_t)((365 * 24 + 6) * 3600))
743 time_t t;
744 struct tm *p;
Guido van Rossum57731601999-03-29 19:12:04 +0000745 long janzone, julyzone;
746 char janname[10], julyname[10];
Guido van Rossum234f9421993-06-17 12:35:49 +0000747 t = (time((time_t *)0) / YEAR) * YEAR;
748 p = localtime(&t);
Guido van Rossum57731601999-03-29 19:12:04 +0000749 janzone = -p->tm_gmtoff;
750 strncpy(janname, p->tm_zone ? p->tm_zone : " ", 9);
751 janname[9] = '\0';
Guido van Rossum234f9421993-06-17 12:35:49 +0000752 t += YEAR/2;
753 p = localtime(&t);
Guido van Rossum57731601999-03-29 19:12:04 +0000754 julyzone = -p->tm_gmtoff;
755 strncpy(julyname, p->tm_zone ? p->tm_zone : " ", 9);
756 julyname[9] = '\0';
Guido van Rossum10b164a2001-09-25 13:59:01 +0000757
Guido van Rossum57731601999-03-29 19:12:04 +0000758 if( janzone < julyzone ) {
759 /* DST is reversed in the southern hemisphere */
Fred Drake9bb74322002-04-01 14:49:59 +0000760 PyModule_AddIntConstant(m, "timezone", julyzone);
761 PyModule_AddIntConstant(m, "altzone", janzone);
762 PyModule_AddIntConstant(m, "daylight",
763 janzone != julyzone);
764 PyModule_AddObject(m, "tzname",
765 Py_BuildValue("(zz)",
766 julyname, janname));
Guido van Rossum57731601999-03-29 19:12:04 +0000767 } else {
Fred Drake9bb74322002-04-01 14:49:59 +0000768 PyModule_AddIntConstant(m, "timezone", janzone);
769 PyModule_AddIntConstant(m, "altzone", julyzone);
770 PyModule_AddIntConstant(m, "daylight",
771 janzone != julyzone);
772 PyModule_AddObject(m, "tzname",
773 Py_BuildValue("(zz)",
774 janname, julyname));
Guido van Rossum57731601999-03-29 19:12:04 +0000775 }
Guido van Rossum234f9421993-06-17 12:35:49 +0000776 }
Guido van Rossume6a4b7b1997-10-08 15:27:56 +0000777#else
Martin v. Löwis60a5d722002-10-16 20:28:25 +0000778#endif /* HAVE_STRUCT_TM_TM_ZONE */
Tim Peters26ae7cd2001-03-20 03:26:49 +0000779#ifdef __CYGWIN__
780 tzset();
Fred Drake9bb74322002-04-01 14:49:59 +0000781 PyModule_AddIntConstant(m, "timezone", _timezone);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000782 PyModule_AddIntConstant(m, "altzone", _timezone-3600);
Fred Drake9bb74322002-04-01 14:49:59 +0000783 PyModule_AddIntConstant(m, "daylight", _daylight);
784 PyModule_AddObject(m, "tzname",
785 Py_BuildValue("(zz)", _tzname[0], _tzname[1]));
Tim Peters26ae7cd2001-03-20 03:26:49 +0000786#endif /* __CYGWIN__ */
Guido van Rossum10b164a2001-09-25 13:59:01 +0000787#endif /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000788}
789
790
791static PyMethodDef time_methods[] = {
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000792 {"time", time_time, METH_NOARGS, time_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000793#ifdef HAVE_CLOCK
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000794 {"clock", time_clock, METH_NOARGS, clock_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000795#endif
796 {"sleep", time_sleep, METH_VARARGS, sleep_doc},
797 {"gmtime", time_gmtime, METH_VARARGS, gmtime_doc},
798 {"localtime", time_localtime, METH_VARARGS, localtime_doc},
799 {"asctime", time_asctime, METH_VARARGS, asctime_doc},
800 {"ctime", time_ctime, METH_VARARGS, ctime_doc},
801#ifdef HAVE_MKTIME
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000802 {"mktime", time_mktime, METH_O, mktime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000803#endif
804#ifdef HAVE_STRFTIME
805 {"strftime", time_strftime, METH_VARARGS, strftime_doc},
806#endif
807 {"strptime", time_strptime, METH_VARARGS, strptime_doc},
808#ifdef HAVE_WORKING_TZSET
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000809 {"tzset", time_tzset, METH_NOARGS, tzset_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000810#endif
811 {NULL, NULL} /* sentinel */
812};
813
814
815PyDoc_STRVAR(module_doc,
816"This module provides various functions to manipulate time values.\n\
817\n\
818There are two standard representations of time. One is the number\n\
819of seconds since the Epoch, in UTC (a.k.a. GMT). It may be an integer\n\
820or a floating point number (to represent fractions of seconds).\n\
821The Epoch is system-defined; on Unix, it is generally January 1st, 1970.\n\
822The actual value can be retrieved by calling gmtime(0).\n\
823\n\
824The other representation is a tuple of 9 integers giving local time.\n\
825The tuple items are:\n\
826 year (four digits, e.g. 1998)\n\
827 month (1-12)\n\
828 day (1-31)\n\
829 hours (0-23)\n\
830 minutes (0-59)\n\
831 seconds (0-59)\n\
832 weekday (0-6, Monday is 0)\n\
833 Julian day (day in the year, 1-366)\n\
834 DST (Daylight Savings Time) flag (-1, 0 or 1)\n\
835If the DST flag is 0, the time is given in the regular time zone;\n\
836if it is 1, the time is given in the DST time zone;\n\
837if it is -1, mktime() should guess based on the date and time.\n\
838\n\
839Variables:\n\
840\n\
841timezone -- difference in seconds between UTC and local standard time\n\
842altzone -- difference in seconds between UTC and local DST time\n\
843daylight -- whether local time should reflect DST\n\
844tzname -- tuple of (standard time zone name, DST time zone name)\n\
845\n\
846Functions:\n\
847\n\
848time() -- return current time in seconds since the Epoch as a float\n\
849clock() -- return CPU time since process start as a float\n\
850sleep() -- delay for a number of seconds given as a float\n\
851gmtime() -- convert seconds since Epoch to UTC tuple\n\
852localtime() -- convert seconds since Epoch to local time tuple\n\
853asctime() -- convert time tuple to string\n\
854ctime() -- convert time in seconds to string\n\
855mktime() -- convert local time tuple to seconds since Epoch\n\
856strftime() -- convert time tuple to string according to format specification\n\
857strptime() -- parse string to time tuple according to format specification\n\
858tzset() -- change the local timezone");
859
860
Martin v. Löwis1a214512008-06-11 05:26:20 +0000861
862static struct PyModuleDef timemodule = {
863 PyModuleDef_HEAD_INIT,
864 "time",
865 module_doc,
866 -1,
867 time_methods,
868 NULL,
869 NULL,
870 NULL,
871 NULL
872};
873
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000874PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +0000875PyInit_time(void)
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000876{
877 PyObject *m;
878 char *p;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000879 m = PyModule_Create(&timemodule);
Neal Norwitz1ac754f2006-01-19 06:09:39 +0000880 if (m == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000881 return NULL;
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000882
883 /* Accept 2-digit dates unless PYTHONY2K is set and non-empty */
884 p = Py_GETENV("PYTHONY2K");
885 PyModule_AddIntConstant(m, "accept2dyear", (long) (!p || !*p));
886 /* Squirrel away the module's dictionary for the y2k check */
887 moddict = PyModule_GetDict(m);
888 Py_INCREF(moddict);
889
890 /* Set, or reset, module variables like time.timezone */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000891 PyInit_timezone(m);
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000892
Mark Hammond975e3922002-07-16 01:29:19 +0000893#ifdef MS_WINDOWS
894 /* Helper to allow interrupts for Windows.
895 If Ctrl+C event delivered while not sleeping
896 it will be ignored.
897 */
898 main_thread = PyThread_get_thread_ident();
899 hInterruptEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
900 SetConsoleCtrlHandler( PyCtrlHandler, TRUE);
901#endif /* MS_WINDOWS */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000902 if (!initialized) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000903 PyStructSequence_InitType(&StructTimeType,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000904 &struct_time_type_desc);
905 }
Fred Drake9bb74322002-04-01 14:49:59 +0000906 Py_INCREF(&StructTimeType);
907 PyModule_AddObject(m, "struct_time", (PyObject*) &StructTimeType);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000908 initialized = 1;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000909 return m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000910}
911
912
Guido van Rossumb6775db1994-08-01 11:34:53 +0000913/* Implement floattime() for various platforms */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000914
Guido van Rossumb6775db1994-08-01 11:34:53 +0000915static double
Thomas Woutersf3f33dc2000-07-21 06:00:07 +0000916floattime(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000917{
Guido van Rossumb6775db1994-08-01 11:34:53 +0000918 /* There are three ways to get the time:
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000919 (1) gettimeofday() -- resolution in microseconds
920 (2) ftime() -- resolution in milliseconds
921 (3) time() -- resolution in seconds
922 In all cases the return value is a float in seconds.
923 Since on some systems (e.g. SCO ODT 3.0) gettimeofday() may
924 fail, so we fall back on ftime() or time().
925 Note: clock resolution does not imply clock accuracy! */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000926#ifdef HAVE_GETTIMEOFDAY
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000927 {
928 struct timeval t;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000929#ifdef GETTIMEOFDAY_NO_TZ
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000930 if (gettimeofday(&t) == 0)
931 return (double)t.tv_sec + t.tv_usec*0.000001;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000932#else /* !GETTIMEOFDAY_NO_TZ */
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000933 if (gettimeofday(&t, (struct timezone *)NULL) == 0)
934 return (double)t.tv_sec + t.tv_usec*0.000001;
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000935#endif /* !GETTIMEOFDAY_NO_TZ */
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000936 }
Thomas Wouters477c8d52006-05-27 19:21:47 +0000937
Guido van Rossumb6775db1994-08-01 11:34:53 +0000938#endif /* !HAVE_GETTIMEOFDAY */
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000939 {
Guido van Rossumd3eb5771999-03-09 16:07:23 +0000940#if defined(HAVE_FTIME)
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000941 struct timeb t;
942 ftime(&t);
943 return (double)t.time + (double)t.millitm * (double)0.001;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000944#else /* !HAVE_FTIME */
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000945 time_t secs;
946 time(&secs);
947 return (double)secs;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000948#endif /* !HAVE_FTIME */
Barry Warsaw4a6cf411997-01-13 22:44:55 +0000949 }
Guido van Rossum426035c1991-02-19 12:27:35 +0000950}
951
Guido van Rossumb6775db1994-08-01 11:34:53 +0000952
953/* Implement floatsleep() for various platforms.
954 When interrupted (or when another error occurs), return -1 and
955 set an exception; else return 0. */
956
957static int
Guido van Rossuma320fd31995-03-09 12:14:15 +0000958floatsleep(double secs)
Guido van Rossum426035c1991-02-19 12:27:35 +0000959{
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000960/* XXX Should test for MS_WINDOWS first! */
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000961#if defined(HAVE_SELECT) && !defined(__EMX__)
Guido van Rossum426035c1991-02-19 12:27:35 +0000962 struct timeval t;
Guido van Rossum775f4da1993-01-09 17:18:52 +0000963 double frac;
Guido van Rossum775f4da1993-01-09 17:18:52 +0000964 frac = fmod(secs, 1.0);
965 secs = floor(secs);
966 t.tv_sec = (long)secs;
967 t.tv_usec = (long)(frac*1000000.0);
Guido van Rossum8607ae21997-11-03 22:04:46 +0000968 Py_BEGIN_ALLOW_THREADS
Guido van Rossumb6775db1994-08-01 11:34:53 +0000969 if (select(0, (fd_set *)0, (fd_set *)0, (fd_set *)0, &t) != 0) {
Guido van Rossum09cbb011999-11-08 15:32:27 +0000970#ifdef EINTR
Guido van Rossuma5456d51999-08-19 14:40:27 +0000971 if (errno != EINTR) {
Guido van Rossum09cbb011999-11-08 15:32:27 +0000972#else
973 if (1) {
974#endif
Andrew M. Kuchlingc24ca4b2000-03-24 20:35:20 +0000975 Py_BLOCK_THREADS
Guido van Rossuma5456d51999-08-19 14:40:27 +0000976 PyErr_SetFromErrno(PyExc_IOError);
977 return -1;
978 }
Guido van Rossumb6775db1994-08-01 11:34:53 +0000979 }
Guido van Rossum8607ae21997-11-03 22:04:46 +0000980 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +0000981#elif defined(__WATCOMC__) && !defined(__QNX__)
Guido van Rossumbceeac81996-05-23 22:53:47 +0000982 /* XXX Can't interrupt this sleep */
Guido van Rossum8607ae21997-11-03 22:04:46 +0000983 Py_BEGIN_ALLOW_THREADS
Guido van Rossumbceeac81996-05-23 22:53:47 +0000984 delay((int)(secs * 1000 + 0.5)); /* delay() uses milliseconds */
Guido van Rossum8607ae21997-11-03 22:04:46 +0000985 Py_END_ALLOW_THREADS
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000986#elif defined(MS_WINDOWS)
Fred Drake0e123952000-06-29 21:31:02 +0000987 {
988 double millisecs = secs * 1000.0;
Tim Peters513a1cd2003-01-19 04:54:58 +0000989 unsigned long ul_millis;
990
Fred Drake0e123952000-06-29 21:31:02 +0000991 if (millisecs > (double)ULONG_MAX) {
Tim Peters513a1cd2003-01-19 04:54:58 +0000992 PyErr_SetString(PyExc_OverflowError,
993 "sleep length is too large");
Fred Drake0e123952000-06-29 21:31:02 +0000994 return -1;
995 }
Fred Drake0e123952000-06-29 21:31:02 +0000996 Py_BEGIN_ALLOW_THREADS
Tim Peters513a1cd2003-01-19 04:54:58 +0000997 /* Allow sleep(0) to maintain win32 semantics, and as decreed
998 * by Guido, only the main thread can be interrupted.
999 */
1000 ul_millis = (unsigned long)millisecs;
1001 if (ul_millis == 0 ||
1002 main_thread != PyThread_get_thread_ident())
1003 Sleep(ul_millis);
Mark Hammond975e3922002-07-16 01:29:19 +00001004 else {
1005 DWORD rc;
1006 ResetEvent(hInterruptEvent);
Tim Peters513a1cd2003-01-19 04:54:58 +00001007 rc = WaitForSingleObject(hInterruptEvent, ul_millis);
1008 if (rc == WAIT_OBJECT_0) {
1009 /* Yield to make sure real Python signal
1010 * handler called.
1011 */
Mark Hammond975e3922002-07-16 01:29:19 +00001012 Sleep(1);
1013 Py_BLOCK_THREADS
Mark Hammond975e3922002-07-16 01:29:19 +00001014 errno = EINTR;
1015 PyErr_SetFromErrno(PyExc_IOError);
1016 return -1;
1017 }
1018 }
Fred Drake0e123952000-06-29 21:31:02 +00001019 Py_END_ALLOW_THREADS
1020 }
Martin v. Löwis02af9642002-01-16 11:04:06 +00001021#elif defined(PYOS_OS2)
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +00001022 /* This Sleep *IS* Interruptable by Exceptions */
Guido van Rossum1d0d7e41997-12-29 20:03:10 +00001023 Py_BEGIN_ALLOW_THREADS
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +00001024 if (DosSleep(secs * 1000) != NO_ERROR) {
Guido van Rossum1d0d7e41997-12-29 20:03:10 +00001025 Py_BLOCK_THREADS
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +00001026 PyErr_SetFromErrno(PyExc_IOError);
1027 return -1;
1028 }
Guido van Rossum1d0d7e41997-12-29 20:03:10 +00001029 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +00001030#elif defined(PLAN9)
1031 {
1032 double millisecs = secs * 1000.0;
1033 if (millisecs > (double)LONG_MAX) {
1034 PyErr_SetString(PyExc_OverflowError, "sleep length is too large");
1035 return -1;
1036 }
1037 /* This sleep *CAN BE* interrupted. */
1038 Py_BEGIN_ALLOW_THREADS
1039 if(sleep((long)millisecs) < 0){
1040 Py_BLOCK_THREADS
1041 PyErr_SetFromErrno(PyExc_IOError);
1042 return -1;
1043 }
1044 Py_END_ALLOW_THREADS
1045 }
1046#else
Guido van Rossumb6775db1994-08-01 11:34:53 +00001047 /* XXX Can't interrupt this sleep */
Guido van Rossum8607ae21997-11-03 22:04:46 +00001048 Py_BEGIN_ALLOW_THREADS
Guido van Rossumb6775db1994-08-01 11:34:53 +00001049 sleep((int)secs);
Guido van Rossum8607ae21997-11-03 22:04:46 +00001050 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +00001051#endif
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001052
Guido van Rossumb6775db1994-08-01 11:34:53 +00001053 return 0;
Guido van Rossum80c9d881991-04-16 08:47:51 +00001054}