blob: acd3fc3e07b7dd4578d4e402f56cc4567f1a471e [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"
Alexander Belopolsky6fc4ade2010-08-05 17:34:27 +00006#include "_time.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
Guido van Rossum87ce7bb1998-06-09 16:30:31 +000010#include <ctype.h>
11
Thomas Wouters0e3f5912006-08-11 14:57:12 +000012#ifdef HAVE_SYS_TYPES_H
Guido van Rossumb6775db1994-08-01 11:34:53 +000013#include <sys/types.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000014#endif /* HAVE_SYS_TYPES_H */
Guido van Rossum6d946f91992-08-14 13:49:30 +000015
Guido van Rossumb6775db1994-08-01 11:34:53 +000016#ifdef QUICKWIN
17#include <io.h>
18#endif
19
Guido van Rossum7bf22de1997-12-02 20:34:19 +000020#if defined(__WATCOMC__) && !defined(__QNX__)
Guido van Rossumbceeac81996-05-23 22:53:47 +000021#include <i86.h>
22#else
Guido van Rossumcac6c721996-09-06 13:34:02 +000023#ifdef MS_WINDOWS
Mark Hammond975e3922002-07-16 01:29:19 +000024#define WIN32_LEAN_AND_MEAN
Guido van Rossum258ccd42001-03-02 06:53:29 +000025#include <windows.h>
Mark Hammond975e3922002-07-16 01:29:19 +000026#include "pythread.h"
27
28/* helper to allow us to interrupt sleep() on Windows*/
29static HANDLE hInterruptEvent = NULL;
30static BOOL WINAPI PyCtrlHandler(DWORD dwCtrlType)
31{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000032 SetEvent(hInterruptEvent);
33 /* allow other default handlers to be called.
34 Default Python handler will setup the
35 KeyboardInterrupt exception.
36 */
37 return FALSE;
Mark Hammond975e3922002-07-16 01:29:19 +000038}
39static long main_thread;
40
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000041#if defined(__BORLANDC__)
Guido van Rossumb2fb3641996-09-07 00:47:35 +000042/* These overrides not needed for Win32 */
Guido van Rossumb6775db1994-08-01 11:34:53 +000043#define timezone _timezone
Guido van Rossumcc081121995-03-14 15:05:41 +000044#define tzname _tzname
45#define daylight _daylight
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000046#endif /* __BORLANDC__ */
Guido van Rossumcac6c721996-09-06 13:34:02 +000047#endif /* MS_WINDOWS */
Guido van Rossum7bf22de1997-12-02 20:34:19 +000048#endif /* !__WATCOMC__ || __QNX__ */
Guido van Rossum234f9421993-06-17 12:35:49 +000049
Thomas Wouters477c8d52006-05-27 19:21:47 +000050#if defined(MS_WINDOWS) && !defined(__BORLANDC__)
51/* Win32 has better clock replacement; we have our own version below. */
52#undef HAVE_CLOCK
Martin v. Löwis3bb00702007-08-30 14:37:48 +000053#undef TZNAME_ENCODING
54#define TZNAME_ENCODING "mbcs"
Thomas Wouters477c8d52006-05-27 19:21:47 +000055#endif /* MS_WINDOWS && !defined(__BORLANDC__) */
Guido van Rossum3917c221997-04-02 05:35:28 +000056
Andrew MacIntyre7bf68332002-03-03 02:59:16 +000057#if defined(PYOS_OS2)
58#define INCL_DOS
59#define INCL_ERRORS
60#include <os2.h>
61#endif
62
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +000063#if defined(PYCC_VACPP)
Guido van Rossum26452411998-09-28 22:07:11 +000064#include <sys/time.h>
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +000065#endif
66
Guido van Rossum234f9421993-06-17 12:35:49 +000067/* Forward declarations */
Tim Petersdbd9ba62000-07-09 03:09:57 +000068static int floatsleep(double);
Thomas Woutersed77bac2000-07-24 15:26:39 +000069static double floattime(void);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000070
Guido van Rossumcfbaecc1998-08-25 14:51:12 +000071/* For Y2K check */
72static PyObject *moddict;
73
Barry Warsaw9a2a8a81996-12-06 23:32:14 +000074static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +000075time_time(PyObject *self, PyObject *unused)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000076{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077 double secs;
78 secs = floattime();
79 if (secs == 0.0) {
80 PyErr_SetFromErrno(PyExc_IOError);
81 return NULL;
82 }
83 return PyFloat_FromDouble(secs);
Guido van Rossumb6775db1994-08-01 11:34:53 +000084}
85
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000086PyDoc_STRVAR(time_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +000087"time() -> floating point number\n\
88\n\
89Return the current time in seconds since the Epoch.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000090Fractions of a second may be present if the system clock provides them.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +000091
Guido van Rossumb6775db1994-08-01 11:34:53 +000092#ifdef HAVE_CLOCK
93
94#ifndef CLOCKS_PER_SEC
Guido van Rossum1b66a4f1996-02-25 04:50:33 +000095#ifdef CLK_TCK
96#define CLOCKS_PER_SEC CLK_TCK
97#else
Guido van Rossumb6775db1994-08-01 11:34:53 +000098#define CLOCKS_PER_SEC 1000000
99#endif
Guido van Rossum1b66a4f1996-02-25 04:50:33 +0000100#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000101
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000102static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000103time_clock(PyObject *self, PyObject *unused)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000104{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000105 return PyFloat_FromDouble(((double)clock()) / CLOCKS_PER_SEC);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000106}
Guido van Rossumb6775db1994-08-01 11:34:53 +0000107#endif /* HAVE_CLOCK */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000108
Thomas Wouters477c8d52006-05-27 19:21:47 +0000109#if defined(MS_WINDOWS) && !defined(__BORLANDC__)
Mark Hammond7ba5e812002-02-12 04:02:33 +0000110/* Due to Mark Hammond and Tim Peters */
Guido van Rossum3917c221997-04-02 05:35:28 +0000111static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000112time_clock(PyObject *self, PyObject *unused)
Guido van Rossum3917c221997-04-02 05:35:28 +0000113{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000114 static LARGE_INTEGER ctrStart;
115 static double divisor = 0.0;
116 LARGE_INTEGER now;
117 double diff;
Guido van Rossum3917c221997-04-02 05:35:28 +0000118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000119 if (divisor == 0.0) {
120 LARGE_INTEGER freq;
121 QueryPerformanceCounter(&ctrStart);
122 if (!QueryPerformanceFrequency(&freq) || freq.QuadPart == 0) {
123 /* Unlikely to happen - this works on all intel
124 machines at least! Revert to clock() */
125 return PyFloat_FromDouble(((double)clock()) /
126 CLOCKS_PER_SEC);
127 }
128 divisor = (double)freq.QuadPart;
129 }
130 QueryPerformanceCounter(&now);
131 diff = (double)(now.QuadPart - ctrStart.QuadPart);
132 return PyFloat_FromDouble(diff / divisor);
Guido van Rossum3917c221997-04-02 05:35:28 +0000133}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000134
Guido van Rossum3917c221997-04-02 05:35:28 +0000135#define HAVE_CLOCK /* So it gets included in the methods */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000136#endif /* MS_WINDOWS && !defined(__BORLANDC__) */
Guido van Rossum3917c221997-04-02 05:35:28 +0000137
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000138#ifdef HAVE_CLOCK
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000139PyDoc_STRVAR(clock_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000140"clock() -> floating point number\n\
141\n\
142Return the CPU time or real time since the start of the process or since\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000143the first call to clock(). This has as much precision as the system\n\
144records.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000145#endif
146
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000147static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000148time_sleep(PyObject *self, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000149{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000150 double secs;
151 if (!PyArg_ParseTuple(args, "d:sleep", &secs))
152 return NULL;
153 if (floatsleep(secs) != 0)
154 return NULL;
155 Py_INCREF(Py_None);
156 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000157}
158
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000159PyDoc_STRVAR(sleep_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000160"sleep(seconds)\n\
161\n\
162Delay execution for a given number of seconds. The argument may be\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000163a floating point number for subsecond precision.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000164
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000165static PyStructSequence_Field struct_time_type_fields[] = {
Alexander Belopolsky69f3fd02010-06-05 15:04:51 +0000166 {"tm_year", "year, for example, 1993"},
167 {"tm_mon", "month of year, range [1, 12]"},
168 {"tm_mday", "day of month, range [1, 31]"},
169 {"tm_hour", "hours, range [0, 23]"},
170 {"tm_min", "minutes, range [0, 59]"},
171 {"tm_sec", "seconds, range [0, 61])"},
172 {"tm_wday", "day of week, range [0, 6], Monday is 0"},
173 {"tm_yday", "day of year, range [1, 366]"},
174 {"tm_isdst", "1 if summer time is in effect, 0 if not, and -1 if unknown"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000175 {0}
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000176};
177
178static PyStructSequence_Desc struct_time_type_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000179 "time.struct_time",
Alexander Belopolsky69f3fd02010-06-05 15:04:51 +0000180 "The time value as returned by gmtime(), localtime(), and strptime(), and\n"
181 " accepted by asctime(), mktime() and strftime(). May be considered as a\n"
182 " sequence of 9 integers.\n\n"
183 " Note that several fields' values are not the same as those defined by\n"
184 " the C language standard for struct tm. For example, the value of the\n"
185 " field tm_year is the actual year, not year - 1900. See individual\n"
186 " fields' descriptions for details.",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000187 struct_time_type_fields,
188 9,
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000189};
Tim Peters9ad4b682002-02-13 05:14:18 +0000190
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000191static int initialized;
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000192static PyTypeObject StructTimeType;
193
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000194static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000195tmtotuple(struct tm *p)
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000196{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000197 PyObject *v = PyStructSequence_New(&StructTimeType);
198 if (v == NULL)
199 return NULL;
Tim Peters9ad4b682002-02-13 05:14:18 +0000200
Christian Heimes217cfd12007-12-02 14:31:20 +0000201#define SET(i,val) PyStructSequence_SET_ITEM(v, i, PyLong_FromLong((long) val))
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000202
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000203 SET(0, p->tm_year + 1900);
204 SET(1, p->tm_mon + 1); /* Want January == 1 */
205 SET(2, p->tm_mday);
206 SET(3, p->tm_hour);
207 SET(4, p->tm_min);
208 SET(5, p->tm_sec);
209 SET(6, (p->tm_wday + 6) % 7); /* Want Monday == 0 */
210 SET(7, p->tm_yday + 1); /* Want January, 1 == 1 */
211 SET(8, p->tm_isdst);
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000212#undef SET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000213 if (PyErr_Occurred()) {
214 Py_XDECREF(v);
215 return NULL;
216 }
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000218 return v;
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000219}
220
221static PyObject *
Skip Montanaro41cfce92007-08-24 21:11:00 +0000222structtime_totuple(PyObject *t)
223{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000224 PyObject *x = NULL;
225 unsigned int i;
226 PyObject *v = PyTuple_New(9);
227 if (v == NULL)
228 return NULL;
Skip Montanaro41cfce92007-08-24 21:11:00 +0000229
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000230 for (i=0; i<9; i++) {
231 x = PyStructSequence_GET_ITEM(t, i);
232 Py_INCREF(x);
233 PyTuple_SET_ITEM(v, i, x);
234 }
Skip Montanaro41cfce92007-08-24 21:11:00 +0000235
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000236 if (PyErr_Occurred()) {
237 Py_XDECREF(v);
238 return NULL;
239 }
Skip Montanaro41cfce92007-08-24 21:11:00 +0000240
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000241 return v;
Skip Montanaro41cfce92007-08-24 21:11:00 +0000242}
243
244static PyObject *
Brett Cannon298c3802004-06-19 20:48:43 +0000245time_convert(double when, struct tm * (*function)(const time_t *))
Guido van Rossum234f9421993-06-17 12:35:49 +0000246{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000247 struct tm *p;
248 time_t whent = _PyTime_DoubleToTimet(when);
Brett Cannon298c3802004-06-19 20:48:43 +0000249
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 if (whent == (time_t)-1 && PyErr_Occurred())
251 return NULL;
252 errno = 0;
253 p = function(&whent);
254 if (p == NULL) {
Guido van Rossum6e8583d1996-10-08 14:19:52 +0000255#ifdef EINVAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000256 if (errno == 0)
257 errno = EINVAL;
Guido van Rossum6e8583d1996-10-08 14:19:52 +0000258#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000259 return PyErr_SetFromErrno(PyExc_ValueError);
260 }
261 return tmtotuple(p);
Guido van Rossum234f9421993-06-17 12:35:49 +0000262}
263
Fred Drakef901abd2004-08-03 17:58:55 +0000264/* Parse arg tuple that can contain an optional float-or-None value;
265 format needs to be "|O:name".
266 Returns non-zero on success (parallels PyArg_ParseTuple).
267*/
268static int
269parse_time_double_args(PyObject *args, char *format, double *pwhen)
270{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000271 PyObject *ot = NULL;
Fred Drakef901abd2004-08-03 17:58:55 +0000272
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000273 if (!PyArg_ParseTuple(args, format, &ot))
274 return 0;
275 if (ot == NULL || ot == Py_None)
276 *pwhen = floattime();
277 else {
278 double when = PyFloat_AsDouble(ot);
279 if (PyErr_Occurred())
280 return 0;
281 *pwhen = when;
282 }
283 return 1;
Fred Drakef901abd2004-08-03 17:58:55 +0000284}
285
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000286static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000287time_gmtime(PyObject *self, PyObject *args)
Guido van Rossum234f9421993-06-17 12:35:49 +0000288{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000289 double when;
290 if (!parse_time_double_args(args, "|O:gmtime", &when))
291 return NULL;
292 return time_convert(when, gmtime);
Guido van Rossum234f9421993-06-17 12:35:49 +0000293}
294
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000295PyDoc_STRVAR(gmtime_doc,
Christian Heimes9a371592007-12-28 14:08:13 +0000296"gmtime([seconds]) -> (tm_year, tm_mon, tm_mday, tm_hour, tm_min,\n\
Fred Drake193a3f62002-03-12 21:38:49 +0000297 tm_sec, tm_wday, tm_yday, tm_isdst)\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000298\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000299Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000300GMT). When 'seconds' is not passed in, convert the current time instead.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000301
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000302static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000303time_localtime(PyObject *self, PyObject *args)
Guido van Rossum234f9421993-06-17 12:35:49 +0000304{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000305 double when;
306 if (!parse_time_double_args(args, "|O:localtime", &when))
307 return NULL;
308 return time_convert(when, localtime);
Guido van Rossum234f9421993-06-17 12:35:49 +0000309}
310
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000311PyDoc_STRVAR(localtime_doc,
Christian Heimes9a371592007-12-28 14:08:13 +0000312"localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,\n\
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000313 tm_sec,tm_wday,tm_yday,tm_isdst)\n\
Martin v. Löwisb3cfc1d2001-12-02 12:27:43 +0000314\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000315Convert seconds since the Epoch to a time tuple expressing local time.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000316When 'seconds' is not passed in, convert the current time instead.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000317
Guido van Rossum9e90a671993-06-24 11:10:19 +0000318static int
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000319gettmarg(PyObject *args, struct tm *p)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000320{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000321 int y;
322 PyObject *t = NULL;
Guido van Rossumcfbaecc1998-08-25 14:51:12 +0000323
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000324 memset((void *) p, '\0', sizeof(struct tm));
Guido van Rossumb9081262007-08-25 03:14:09 +0000325
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 if (PyTuple_Check(args)) {
327 t = args;
328 Py_INCREF(t);
329 }
330 else if (Py_TYPE(args) == &StructTimeType) {
331 t = structtime_totuple(args);
332 }
333 else {
334 PyErr_SetString(PyExc_TypeError,
335 "Tuple or struct_time argument required");
336 return 0;
337 }
Skip Montanaro41cfce92007-08-24 21:11:00 +0000338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 if (t == NULL || !PyArg_ParseTuple(t, "iiiiiiiii",
340 &y,
341 &p->tm_mon,
342 &p->tm_mday,
343 &p->tm_hour,
344 &p->tm_min,
345 &p->tm_sec,
346 &p->tm_wday,
347 &p->tm_yday,
348 &p->tm_isdst)) {
349 Py_XDECREF(t);
350 return 0;
351 }
352 Py_DECREF(t);
Skip Montanaro41cfce92007-08-24 21:11:00 +0000353
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000354 if (y < 1900) {
355 PyObject *accept = PyDict_GetItemString(moddict,
356 "accept2dyear");
357 if (accept == NULL || !PyLong_CheckExact(accept) ||
358 !PyObject_IsTrue(accept)) {
359 PyErr_SetString(PyExc_ValueError,
360 "year >= 1900 required");
361 return 0;
362 }
363 if (69 <= y && y <= 99)
364 y += 1900;
365 else if (0 <= y && y <= 68)
366 y += 2000;
367 else {
368 PyErr_SetString(PyExc_ValueError,
369 "year out of range");
370 return 0;
371 }
372 }
373 p->tm_year = y - 1900;
374 p->tm_mon--;
375 p->tm_wday = (p->tm_wday + 1) % 7;
376 p->tm_yday--;
377 return 1;
Guido van Rossum9e90a671993-06-24 11:10:19 +0000378}
379
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000380#ifdef HAVE_STRFTIME
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000381#ifdef HAVE_WCSFTIME
382#define time_char wchar_t
383#define format_time wcsftime
384#define time_strlen wcslen
385#else
386#define time_char char
387#define format_time strftime
388#define time_strlen strlen
389#endif
390
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000391static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000392time_strftime(PyObject *self, PyObject *args)
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000393{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394 PyObject *tup = NULL;
395 struct tm buf;
396 const time_char *fmt;
Victor Stinnerb2904782010-09-29 10:34:19 +0000397#ifdef HAVE_WCSFTIME
398 wchar_t *format;
399#else
400 PyObject *format;
401#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402 size_t fmtlen, buflen;
Victor Stinnerb2904782010-09-29 10:34:19 +0000403 time_char *outbuf = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 size_t i;
Victor Stinnerb2904782010-09-29 10:34:19 +0000405 PyObject *ret = NULL;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000407 memset((void *) &buf, '\0', sizeof(buf));
Guido van Rossum1f41f841998-04-27 19:04:26 +0000408
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 /* Will always expect a unicode string to be passed as format.
410 Given that there's no str type anymore in py3k this seems safe.
411 */
412 if (!PyArg_ParseTuple(args, "U|O:strftime", &format, &tup))
413 return NULL;
Thomas Woutersfe385252001-01-19 23:16:56 +0000414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000415 if (tup == NULL) {
416 time_t tt = time(NULL);
417 buf = *localtime(&tt);
418 } else if (!gettmarg(tup, &buf))
419 return NULL;
Guido van Rossum10b164a2001-09-25 13:59:01 +0000420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 /* Checks added to make sure strftime() does not crash Python by
422 indexing blindly into some array for a textual representation
423 by some bad index (fixes bug #897625).
Tim Peters1b6f7a92004-06-20 02:50:16 +0000424
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 Also support values of zero from Python code for arguments in which
426 that is out of range by forcing that value to the lowest value that
427 is valid (fixed bug #1520914).
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000428
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 Valid ranges based on what is allowed in struct tm:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000430
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000431 - tm_year: [0, max(int)] (1)
432 - tm_mon: [0, 11] (2)
433 - tm_mday: [1, 31]
434 - tm_hour: [0, 23]
435 - tm_min: [0, 59]
436 - tm_sec: [0, 60]
437 - tm_wday: [0, 6] (1)
438 - tm_yday: [0, 365] (2)
439 - tm_isdst: [-max(int), max(int)]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000440
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000441 (1) gettmarg() handles bounds-checking.
442 (2) Python's acceptable range is one greater than the range in C,
443 thus need to check against automatic decrement by gettmarg().
444 */
445 if (buf.tm_mon == -1)
446 buf.tm_mon = 0;
447 else if (buf.tm_mon < 0 || buf.tm_mon > 11) {
448 PyErr_SetString(PyExc_ValueError, "month out of range");
449 return NULL;
450 }
451 if (buf.tm_mday == 0)
452 buf.tm_mday = 1;
453 else if (buf.tm_mday < 0 || buf.tm_mday > 31) {
454 PyErr_SetString(PyExc_ValueError, "day of month out of range");
455 return NULL;
456 }
457 if (buf.tm_hour < 0 || buf.tm_hour > 23) {
458 PyErr_SetString(PyExc_ValueError, "hour out of range");
459 return NULL;
460 }
461 if (buf.tm_min < 0 || buf.tm_min > 59) {
462 PyErr_SetString(PyExc_ValueError, "minute out of range");
463 return NULL;
464 }
465 if (buf.tm_sec < 0 || buf.tm_sec > 61) {
466 PyErr_SetString(PyExc_ValueError, "seconds out of range");
467 return NULL;
468 }
469 /* tm_wday does not need checking of its upper-bound since taking
470 ``% 7`` in gettmarg() automatically restricts the range. */
471 if (buf.tm_wday < 0) {
472 PyErr_SetString(PyExc_ValueError, "day of week out of range");
473 return NULL;
474 }
475 if (buf.tm_yday == -1)
476 buf.tm_yday = 0;
477 else if (buf.tm_yday < 0 || buf.tm_yday > 365) {
478 PyErr_SetString(PyExc_ValueError, "day of year out of range");
479 return NULL;
480 }
481 /* Normalize tm_isdst just in case someone foolishly implements %Z
482 based on the assumption that tm_isdst falls within the range of
483 [-1, 1] */
484 if (buf.tm_isdst < -1)
485 buf.tm_isdst = -1;
486 else if (buf.tm_isdst > 1)
487 buf.tm_isdst = 1;
Brett Cannond1080a32004-03-02 04:38:10 +0000488
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000489#ifdef HAVE_WCSFTIME
Victor Stinnerb2904782010-09-29 10:34:19 +0000490 format = PyUnicode_AsWideCharString((PyUnicodeObject*)format, NULL);
491 if (format == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000492 return NULL;
Victor Stinnerb2904782010-09-29 10:34:19 +0000493 fmt = format;
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000494#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 /* Convert the unicode string to an ascii one */
496 format = PyUnicode_AsEncodedString(format, TZNAME_ENCODING, NULL);
497 if (format == NULL)
498 return NULL;
499 fmt = PyBytes_AS_STRING(format);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000500#endif
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000501
Hirokazu Yamamoto6b0e51a2009-06-03 05:19:18 +0000502#if defined(MS_WINDOWS) && defined(HAVE_WCSFTIME)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000503 /* check that the format string contains only valid directives */
504 for(outbuf = wcschr(fmt, L'%');
505 outbuf != NULL;
506 outbuf = wcschr(outbuf+2, L'%'))
507 {
508 if (outbuf[1]=='#')
509 ++outbuf; /* not documented by python, */
510 if (outbuf[1]=='\0' ||
511 !wcschr(L"aAbBcdfHIjmMpSUwWxXyYzZ%", outbuf[1]))
512 {
513 PyErr_SetString(PyExc_ValueError, "Invalid format string");
514 return 0;
515 }
516 }
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000517#endif
518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000519 fmtlen = time_strlen(fmt);
Guido van Rossumc222ec21999-02-23 00:00:10 +0000520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000521 /* I hate these functions that presume you know how big the output
522 * will be ahead of time...
523 */
524 for (i = 1024; ; i += i) {
525 outbuf = (time_char *)PyMem_Malloc(i*sizeof(time_char));
526 if (outbuf == NULL) {
Victor Stinnerb2904782010-09-29 10:34:19 +0000527 PyErr_NoMemory();
528 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000529 }
530 buflen = format_time(outbuf, i, fmt, &buf);
531 if (buflen > 0 || i >= 256 * fmtlen) {
532 /* If the buffer is 256 times as long as the format,
533 it's probably not failing for lack of room!
534 More likely, the format yields an empty result,
535 e.g. an empty format, or %Z when the timezone
536 is unknown. */
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000537#ifdef HAVE_WCSFTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 ret = PyUnicode_FromWideChar(outbuf, buflen);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000539#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000540 ret = PyUnicode_Decode(outbuf, buflen,
541 TZNAME_ENCODING, NULL);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000542#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000543 PyMem_Free(outbuf);
Victor Stinnerb2904782010-09-29 10:34:19 +0000544 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000545 }
546 PyMem_Free(outbuf);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000547#if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000548 /* VisualStudio .NET 2005 does this properly */
549 if (buflen == 0 && errno == EINVAL) {
550 PyErr_SetString(PyExc_ValueError, "Invalid format string");
Victor Stinnerb2904782010-09-29 10:34:19 +0000551 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000553#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 }
Victor Stinnerb2904782010-09-29 10:34:19 +0000555#ifdef HAVE_WCSFTIME
556 PyMem_Free(format);
557#else
558 Py_DECREF(format);
559#endif
560 return ret;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000561}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000562
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000563#undef time_char
564#undef format_time
565
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000566PyDoc_STRVAR(strftime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000567"strftime(format[, tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000568\n\
569Convert a time tuple to a string according to a format specification.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000570See the library reference manual for formatting codes. When the time tuple\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000571is not present, current time as returned by localtime() is used.");
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000572#endif /* HAVE_STRFTIME */
573
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000574static PyObject *
575time_strptime(PyObject *self, PyObject *args)
576{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 PyObject *strptime_module = PyImport_ImportModuleNoBlock("_strptime");
578 PyObject *strptime_result;
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000579
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000580 if (!strptime_module)
581 return NULL;
582 strptime_result = PyObject_CallMethod(strptime_module,
583 "_strptime_time", "O", args);
584 Py_DECREF(strptime_module);
585 return strptime_result;
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000586}
587
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000588PyDoc_STRVAR(strptime_doc,
Brett Cannon20def8b2003-07-01 05:16:08 +0000589"strptime(string, format) -> struct_time\n\
Martin v. Löwisb3cfc1d2001-12-02 12:27:43 +0000590\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000591Parse a string to a time tuple according to a format specification.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000592See the library reference manual for formatting codes (same as strftime()).");
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000593
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000594
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000595static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000596time_asctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000597{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 PyObject *tup = NULL;
599 struct tm buf;
600 char *p;
601 if (!PyArg_UnpackTuple(args, "asctime", 0, 1, &tup))
602 return NULL;
603 if (tup == NULL) {
604 time_t tt = time(NULL);
605 buf = *localtime(&tt);
606 } else if (!gettmarg(tup, &buf))
607 return NULL;
608 p = asctime(&buf);
609 if (p[24] == '\n')
610 p[24] = '\0';
611 return PyUnicode_FromString(p);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000612}
613
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000614PyDoc_STRVAR(asctime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000615"asctime([tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000616\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000617Convert a time tuple to a string, e.g. 'Sat Jun 06 16:26:11 1998'.\n\
618When the time tuple is not present, current time as returned by localtime()\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000619is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000620
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000621static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000622time_ctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000623{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000624 PyObject *ot = NULL;
625 time_t tt;
626 char *p;
Guido van Rossum10b164a2001-09-25 13:59:01 +0000627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000628 if (!PyArg_UnpackTuple(args, "ctime", 0, 1, &ot))
629 return NULL;
630 if (ot == NULL || ot == Py_None)
631 tt = time(NULL);
632 else {
633 double dt = PyFloat_AsDouble(ot);
634 if (PyErr_Occurred())
635 return NULL;
636 tt = _PyTime_DoubleToTimet(dt);
637 if (tt == (time_t)-1 && PyErr_Occurred())
638 return NULL;
639 }
640 p = ctime(&tt);
641 if (p == NULL) {
642 PyErr_SetString(PyExc_ValueError, "unconvertible time");
643 return NULL;
644 }
645 if (p[24] == '\n')
646 p[24] = '\0';
647 return PyUnicode_FromString(p);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000648}
649
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000650PyDoc_STRVAR(ctime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000651"ctime(seconds) -> string\n\
652\n\
653Convert a time in seconds since the Epoch to a string in local time.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000654This is equivalent to asctime(localtime(seconds)). When the time tuple is\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000655not present, current time as returned by localtime() is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000656
Guido van Rossum60cd8131998-03-06 17:16:21 +0000657#ifdef HAVE_MKTIME
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000658static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000659time_mktime(PyObject *self, PyObject *tup)
Guido van Rossum234f9421993-06-17 12:35:49 +0000660{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 struct tm buf;
662 time_t tt;
663 if (!gettmarg(tup, &buf))
664 return NULL;
665 tt = mktime(&buf);
666 if (tt == (time_t)(-1)) {
667 PyErr_SetString(PyExc_OverflowError,
668 "mktime argument out of range");
669 return NULL;
670 }
671 return PyFloat_FromDouble((double)tt);
Guido van Rossum234f9421993-06-17 12:35:49 +0000672}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000673
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000674PyDoc_STRVAR(mktime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000675"mktime(tuple) -> floating point number\n\
676\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000677Convert a time tuple in local time to seconds since the Epoch.");
Guido van Rossum60cd8131998-03-06 17:16:21 +0000678#endif /* HAVE_MKTIME */
Guido van Rossum234f9421993-06-17 12:35:49 +0000679
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000680#ifdef HAVE_WORKING_TZSET
Martin v. Löwis1a214512008-06-11 05:26:20 +0000681static void PyInit_timezone(PyObject *module);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000682
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000683static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000684time_tzset(PyObject *self, PyObject *unused)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000685{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000686 PyObject* m;
Fred Drake9bb74322002-04-01 14:49:59 +0000687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000688 m = PyImport_ImportModuleNoBlock("time");
689 if (m == NULL) {
690 return NULL;
691 }
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 tzset();
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000695 /* Reset timezone, altzone, daylight and tzname */
696 PyInit_timezone(m);
697 Py_DECREF(m);
Tim Peters1b6f7a92004-06-20 02:50:16 +0000698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 Py_INCREF(Py_None);
700 return Py_None;
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000701}
702
703PyDoc_STRVAR(tzset_doc,
704"tzset(zone)\n\
705\n\
706Initialize, or reinitialize, the local timezone to the value stored in\n\
707os.environ['TZ']. The TZ environment variable should be specified in\n\
Neal Norwitzdc8e1942004-07-20 22:34:37 +0000708standard Unix timezone format as documented in the tzset man page\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000709(eg. 'US/Eastern', 'Europe/Amsterdam'). Unknown timezones will silently\n\
710fall back to UTC. If the TZ environment variable is not set, the local\n\
711timezone is set to the systems best guess of wallclock time.\n\
712Changing the TZ environment variable without calling tzset *may* change\n\
713the local timezone used by methods such as localtime, but this behaviour\n\
714should not be relied on.");
715#endif /* HAVE_WORKING_TZSET */
716
Martin v. Löwisd218dc12008-04-07 03:17:54 +0000717static void
Martin v. Löwis1a214512008-06-11 05:26:20 +0000718PyInit_timezone(PyObject *m) {
719 /* This code moved from PyInit_time wholesale to allow calling it from
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000720 time_tzset. In the future, some parts of it can be moved back
721 (for platforms that don't HAVE_WORKING_TZSET, when we know what they
722 are), and the extraneous calls to tzset(3) should be removed.
723 I haven't done this yet, as I don't want to change this code as
724 little as possible when introducing the time.tzset and time.tzsetwall
725 methods. This should simply be a method of doing the following once,
726 at the top of this function and removing the call to tzset() from
727 time_tzset():
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000728
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 #ifdef HAVE_TZSET
730 tzset()
731 #endif
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000732
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000733 And I'm lazy and hate C so nyer.
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000734 */
Guido van Rossum10b164a2001-09-25 13:59:01 +0000735#if defined(HAVE_TZNAME) && !defined(__GLIBC__) && !defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 PyObject *otz0, *otz1;
737 tzset();
Guido van Rossum26452411998-09-28 22:07:11 +0000738#ifdef PYOS_OS2
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 PyModule_AddIntConstant(m, "timezone", _timezone);
Guido van Rossum26452411998-09-28 22:07:11 +0000740#else /* !PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000741 PyModule_AddIntConstant(m, "timezone", timezone);
Guido van Rossum26452411998-09-28 22:07:11 +0000742#endif /* PYOS_OS2 */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000743#ifdef HAVE_ALTZONE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 PyModule_AddIntConstant(m, "altzone", altzone);
Guido van Rossumb6775db1994-08-01 11:34:53 +0000745#else
Guido van Rossum26452411998-09-28 22:07:11 +0000746#ifdef PYOS_OS2
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 PyModule_AddIntConstant(m, "altzone", _timezone-3600);
Guido van Rossum26452411998-09-28 22:07:11 +0000748#else /* !PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000749 PyModule_AddIntConstant(m, "altzone", timezone-3600);
Guido van Rossum26452411998-09-28 22:07:11 +0000750#endif /* PYOS_OS2 */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000751#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000752 PyModule_AddIntConstant(m, "daylight", daylight);
753 otz0 = PyUnicode_Decode(tzname[0], strlen(tzname[0]), TZNAME_ENCODING, NULL);
754 otz1 = PyUnicode_Decode(tzname[1], strlen(tzname[1]), TZNAME_ENCODING, NULL);
755 PyModule_AddObject(m, "tzname", Py_BuildValue("(NN)", otz0, otz1));
Guido van Rossum10b164a2001-09-25 13:59:01 +0000756#else /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Martin v. Löwis60a5d722002-10-16 20:28:25 +0000757#ifdef HAVE_STRUCT_TM_TM_ZONE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000758 {
Guido van Rossum234f9421993-06-17 12:35:49 +0000759#define YEAR ((time_t)((365 * 24 + 6) * 3600))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 time_t t;
761 struct tm *p;
762 long janzone, julyzone;
763 char janname[10], julyname[10];
764 t = (time((time_t *)0) / YEAR) * YEAR;
765 p = localtime(&t);
766 janzone = -p->tm_gmtoff;
767 strncpy(janname, p->tm_zone ? p->tm_zone : " ", 9);
768 janname[9] = '\0';
769 t += YEAR/2;
770 p = localtime(&t);
771 julyzone = -p->tm_gmtoff;
772 strncpy(julyname, p->tm_zone ? p->tm_zone : " ", 9);
773 julyname[9] = '\0';
Guido van Rossum10b164a2001-09-25 13:59:01 +0000774
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000775 if( janzone < julyzone ) {
776 /* DST is reversed in the southern hemisphere */
777 PyModule_AddIntConstant(m, "timezone", julyzone);
778 PyModule_AddIntConstant(m, "altzone", janzone);
779 PyModule_AddIntConstant(m, "daylight",
780 janzone != julyzone);
781 PyModule_AddObject(m, "tzname",
782 Py_BuildValue("(zz)",
783 julyname, janname));
784 } else {
785 PyModule_AddIntConstant(m, "timezone", janzone);
786 PyModule_AddIntConstant(m, "altzone", julyzone);
787 PyModule_AddIntConstant(m, "daylight",
788 janzone != julyzone);
789 PyModule_AddObject(m, "tzname",
790 Py_BuildValue("(zz)",
791 janname, julyname));
792 }
793 }
Guido van Rossume6a4b7b1997-10-08 15:27:56 +0000794#else
Martin v. Löwis60a5d722002-10-16 20:28:25 +0000795#endif /* HAVE_STRUCT_TM_TM_ZONE */
Tim Peters26ae7cd2001-03-20 03:26:49 +0000796#ifdef __CYGWIN__
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000797 tzset();
798 PyModule_AddIntConstant(m, "timezone", _timezone);
799 PyModule_AddIntConstant(m, "altzone", _timezone-3600);
800 PyModule_AddIntConstant(m, "daylight", _daylight);
801 PyModule_AddObject(m, "tzname",
802 Py_BuildValue("(zz)", _tzname[0], _tzname[1]));
Tim Peters26ae7cd2001-03-20 03:26:49 +0000803#endif /* __CYGWIN__ */
Guido van Rossum10b164a2001-09-25 13:59:01 +0000804#endif /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000805}
806
807
808static PyMethodDef time_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000809 {"time", time_time, METH_NOARGS, time_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000810#ifdef HAVE_CLOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000811 {"clock", time_clock, METH_NOARGS, clock_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000812#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 {"sleep", time_sleep, METH_VARARGS, sleep_doc},
814 {"gmtime", time_gmtime, METH_VARARGS, gmtime_doc},
815 {"localtime", time_localtime, METH_VARARGS, localtime_doc},
816 {"asctime", time_asctime, METH_VARARGS, asctime_doc},
817 {"ctime", time_ctime, METH_VARARGS, ctime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000818#ifdef HAVE_MKTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 {"mktime", time_mktime, METH_O, mktime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000820#endif
821#ifdef HAVE_STRFTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000822 {"strftime", time_strftime, METH_VARARGS, strftime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000823#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 {"strptime", time_strptime, METH_VARARGS, strptime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000825#ifdef HAVE_WORKING_TZSET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000826 {"tzset", time_tzset, METH_NOARGS, tzset_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000827#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 {NULL, NULL} /* sentinel */
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000829};
830
831
832PyDoc_STRVAR(module_doc,
833"This module provides various functions to manipulate time values.\n\
834\n\
835There are two standard representations of time. One is the number\n\
836of seconds since the Epoch, in UTC (a.k.a. GMT). It may be an integer\n\
837or a floating point number (to represent fractions of seconds).\n\
838The Epoch is system-defined; on Unix, it is generally January 1st, 1970.\n\
839The actual value can be retrieved by calling gmtime(0).\n\
840\n\
841The other representation is a tuple of 9 integers giving local time.\n\
842The tuple items are:\n\
843 year (four digits, e.g. 1998)\n\
844 month (1-12)\n\
845 day (1-31)\n\
846 hours (0-23)\n\
847 minutes (0-59)\n\
848 seconds (0-59)\n\
849 weekday (0-6, Monday is 0)\n\
850 Julian day (day in the year, 1-366)\n\
851 DST (Daylight Savings Time) flag (-1, 0 or 1)\n\
852If the DST flag is 0, the time is given in the regular time zone;\n\
853if it is 1, the time is given in the DST time zone;\n\
854if it is -1, mktime() should guess based on the date and time.\n\
855\n\
856Variables:\n\
857\n\
858timezone -- difference in seconds between UTC and local standard time\n\
859altzone -- difference in seconds between UTC and local DST time\n\
860daylight -- whether local time should reflect DST\n\
861tzname -- tuple of (standard time zone name, DST time zone name)\n\
862\n\
863Functions:\n\
864\n\
865time() -- return current time in seconds since the Epoch as a float\n\
866clock() -- return CPU time since process start as a float\n\
867sleep() -- delay for a number of seconds given as a float\n\
868gmtime() -- convert seconds since Epoch to UTC tuple\n\
869localtime() -- convert seconds since Epoch to local time tuple\n\
870asctime() -- convert time tuple to string\n\
871ctime() -- convert time in seconds to string\n\
872mktime() -- convert local time tuple to seconds since Epoch\n\
873strftime() -- convert time tuple to string according to format specification\n\
874strptime() -- parse string to time tuple according to format specification\n\
875tzset() -- change the local timezone");
876
877
Martin v. Löwis1a214512008-06-11 05:26:20 +0000878
879static struct PyModuleDef timemodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 PyModuleDef_HEAD_INIT,
881 "time",
882 module_doc,
883 -1,
884 time_methods,
885 NULL,
886 NULL,
887 NULL,
888 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +0000889};
890
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000891PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +0000892PyInit_time(void)
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000893{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000894 PyObject *m;
895 char *p;
896 m = PyModule_Create(&timemodule);
897 if (m == NULL)
898 return NULL;
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000899
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000900 /* Accept 2-digit dates unless PYTHONY2K is set and non-empty */
901 p = Py_GETENV("PYTHONY2K");
902 PyModule_AddIntConstant(m, "accept2dyear", (long) (!p || !*p));
903 /* Squirrel away the module's dictionary for the y2k check */
904 moddict = PyModule_GetDict(m);
905 Py_INCREF(moddict);
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000906
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 /* Set, or reset, module variables like time.timezone */
908 PyInit_timezone(m);
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000909
Mark Hammond975e3922002-07-16 01:29:19 +0000910#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000911 /* Helper to allow interrupts for Windows.
912 If Ctrl+C event delivered while not sleeping
913 it will be ignored.
914 */
915 main_thread = PyThread_get_thread_ident();
916 hInterruptEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
917 SetConsoleCtrlHandler( PyCtrlHandler, TRUE);
Mark Hammond975e3922002-07-16 01:29:19 +0000918#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 if (!initialized) {
920 PyStructSequence_InitType(&StructTimeType,
921 &struct_time_type_desc);
922 }
923 Py_INCREF(&StructTimeType);
924 PyModule_AddObject(m, "struct_time", (PyObject*) &StructTimeType);
925 initialized = 1;
926 return m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000927}
928
Guido van Rossumb6775db1994-08-01 11:34:53 +0000929static double
Thomas Woutersf3f33dc2000-07-21 06:00:07 +0000930floattime(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000931{
Alexander Belopolsky6fc4ade2010-08-05 17:34:27 +0000932 _PyTime_timeval t;
933 _PyTime_gettimeofday(&t);
934 return (double)t.tv_sec + t.tv_usec*0.000001;
Guido van Rossum426035c1991-02-19 12:27:35 +0000935}
936
Guido van Rossumb6775db1994-08-01 11:34:53 +0000937
938/* Implement floatsleep() for various platforms.
939 When interrupted (or when another error occurs), return -1 and
940 set an exception; else return 0. */
941
942static int
Guido van Rossuma320fd31995-03-09 12:14:15 +0000943floatsleep(double secs)
Guido van Rossum426035c1991-02-19 12:27:35 +0000944{
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000945/* XXX Should test for MS_WINDOWS first! */
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000946#if defined(HAVE_SELECT) && !defined(__EMX__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 struct timeval t;
948 double frac;
949 frac = fmod(secs, 1.0);
950 secs = floor(secs);
951 t.tv_sec = (long)secs;
952 t.tv_usec = (long)(frac*1000000.0);
953 Py_BEGIN_ALLOW_THREADS
954 if (select(0, (fd_set *)0, (fd_set *)0, (fd_set *)0, &t) != 0) {
Guido van Rossum09cbb011999-11-08 15:32:27 +0000955#ifdef EINTR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 if (errno != EINTR) {
Guido van Rossum09cbb011999-11-08 15:32:27 +0000957#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 if (1) {
Guido van Rossum09cbb011999-11-08 15:32:27 +0000959#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 Py_BLOCK_THREADS
961 PyErr_SetFromErrno(PyExc_IOError);
962 return -1;
963 }
964 }
965 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +0000966#elif defined(__WATCOMC__) && !defined(__QNX__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 /* XXX Can't interrupt this sleep */
968 Py_BEGIN_ALLOW_THREADS
969 delay((int)(secs * 1000 + 0.5)); /* delay() uses milliseconds */
970 Py_END_ALLOW_THREADS
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000971#elif defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 {
973 double millisecs = secs * 1000.0;
974 unsigned long ul_millis;
Tim Peters513a1cd2003-01-19 04:54:58 +0000975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 if (millisecs > (double)ULONG_MAX) {
977 PyErr_SetString(PyExc_OverflowError,
978 "sleep length is too large");
979 return -1;
980 }
981 Py_BEGIN_ALLOW_THREADS
982 /* Allow sleep(0) to maintain win32 semantics, and as decreed
983 * by Guido, only the main thread can be interrupted.
984 */
985 ul_millis = (unsigned long)millisecs;
986 if (ul_millis == 0 ||
987 main_thread != PyThread_get_thread_ident())
988 Sleep(ul_millis);
989 else {
990 DWORD rc;
991 ResetEvent(hInterruptEvent);
992 rc = WaitForSingleObject(hInterruptEvent, ul_millis);
993 if (rc == WAIT_OBJECT_0) {
994 /* Yield to make sure real Python signal
995 * handler called.
996 */
997 Sleep(1);
998 Py_BLOCK_THREADS
999 errno = EINTR;
1000 PyErr_SetFromErrno(PyExc_IOError);
1001 return -1;
1002 }
1003 }
1004 Py_END_ALLOW_THREADS
1005 }
Martin v. Löwis02af9642002-01-16 11:04:06 +00001006#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001007 /* This Sleep *IS* Interruptable by Exceptions */
1008 Py_BEGIN_ALLOW_THREADS
1009 if (DosSleep(secs * 1000) != NO_ERROR) {
1010 Py_BLOCK_THREADS
1011 PyErr_SetFromErrno(PyExc_IOError);
1012 return -1;
1013 }
1014 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +00001015#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001016 /* XXX Can't interrupt this sleep */
1017 Py_BEGIN_ALLOW_THREADS
1018 sleep((int)secs);
1019 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +00001020#endif
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001021
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001022 return 0;
Guido van Rossum80c9d881991-04-16 08:47:51 +00001023}