blob: 4b45f6e30d360fad3f7b97aef592b3b16007271b [file] [log] [blame]
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001/* Time module */
2
Barry Warsaw9a2a8a81996-12-06 23:32:14 +00003#include "Python.h"
Alexander Belopolsky6fc4ade2010-08-05 17:34:27 +00004#include "_time.h"
Guido van Rossum3f5da241990-12-20 15:06:42 +00005
Martin v. Löwis8a7c8662007-08-30 15:40:24 +00006#define TZNAME_ENCODING "utf-8"
7
Guido van Rossum87ce7bb1998-06-09 16:30:31 +00008#include <ctype.h>
9
Thomas Wouters0e3f5912006-08-11 14:57:12 +000010#ifdef HAVE_SYS_TYPES_H
Guido van Rossumb6775db1994-08-01 11:34:53 +000011#include <sys/types.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000012#endif /* HAVE_SYS_TYPES_H */
Guido van Rossum6d946f91992-08-14 13:49:30 +000013
Guido van Rossumb6775db1994-08-01 11:34:53 +000014#ifdef QUICKWIN
15#include <io.h>
16#endif
17
Guido van Rossum7bf22de1997-12-02 20:34:19 +000018#if defined(__WATCOMC__) && !defined(__QNX__)
Guido van Rossumbceeac81996-05-23 22:53:47 +000019#include <i86.h>
20#else
Guido van Rossumcac6c721996-09-06 13:34:02 +000021#ifdef MS_WINDOWS
Mark Hammond975e3922002-07-16 01:29:19 +000022#define WIN32_LEAN_AND_MEAN
Guido van Rossum258ccd42001-03-02 06:53:29 +000023#include <windows.h>
Mark Hammond975e3922002-07-16 01:29:19 +000024#include "pythread.h"
25
26/* helper to allow us to interrupt sleep() on Windows*/
27static HANDLE hInterruptEvent = NULL;
28static BOOL WINAPI PyCtrlHandler(DWORD dwCtrlType)
29{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000030 SetEvent(hInterruptEvent);
31 /* allow other default handlers to be called.
32 Default Python handler will setup the
33 KeyboardInterrupt exception.
34 */
35 return FALSE;
Mark Hammond975e3922002-07-16 01:29:19 +000036}
37static long main_thread;
38
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000039#if defined(__BORLANDC__)
Guido van Rossumb2fb3641996-09-07 00:47:35 +000040/* These overrides not needed for Win32 */
Guido van Rossumb6775db1994-08-01 11:34:53 +000041#define timezone _timezone
Guido van Rossumcc081121995-03-14 15:05:41 +000042#define tzname _tzname
43#define daylight _daylight
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000044#endif /* __BORLANDC__ */
Guido van Rossumcac6c721996-09-06 13:34:02 +000045#endif /* MS_WINDOWS */
Guido van Rossum7bf22de1997-12-02 20:34:19 +000046#endif /* !__WATCOMC__ || __QNX__ */
Guido van Rossum234f9421993-06-17 12:35:49 +000047
Thomas Wouters477c8d52006-05-27 19:21:47 +000048#if defined(MS_WINDOWS) && !defined(__BORLANDC__)
49/* Win32 has better clock replacement; we have our own version below. */
50#undef HAVE_CLOCK
Martin v. Löwis3bb00702007-08-30 14:37:48 +000051#undef TZNAME_ENCODING
52#define TZNAME_ENCODING "mbcs"
Thomas Wouters477c8d52006-05-27 19:21:47 +000053#endif /* MS_WINDOWS && !defined(__BORLANDC__) */
Guido van Rossum3917c221997-04-02 05:35:28 +000054
Andrew MacIntyre7bf68332002-03-03 02:59:16 +000055#if defined(PYOS_OS2)
56#define INCL_DOS
57#define INCL_ERRORS
58#include <os2.h>
59#endif
60
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +000061#if defined(PYCC_VACPP)
Guido van Rossum26452411998-09-28 22:07:11 +000062#include <sys/time.h>
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +000063#endif
64
Guido van Rossum234f9421993-06-17 12:35:49 +000065/* Forward declarations */
Tim Petersdbd9ba62000-07-09 03:09:57 +000066static int floatsleep(double);
Thomas Woutersed77bac2000-07-24 15:26:39 +000067static double floattime(void);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000068
Guido van Rossumcfbaecc1998-08-25 14:51:12 +000069/* For Y2K check */
70static PyObject *moddict;
71
Barry Warsaw9a2a8a81996-12-06 23:32:14 +000072static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +000073time_time(PyObject *self, PyObject *unused)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000074{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000075 double secs;
76 secs = floattime();
77 if (secs == 0.0) {
78 PyErr_SetFromErrno(PyExc_IOError);
79 return NULL;
80 }
81 return PyFloat_FromDouble(secs);
Guido van Rossumb6775db1994-08-01 11:34:53 +000082}
83
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000084PyDoc_STRVAR(time_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +000085"time() -> floating point number\n\
86\n\
87Return the current time in seconds since the Epoch.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000088Fractions of a second may be present if the system clock provides them.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +000089
Guido van Rossumb6775db1994-08-01 11:34:53 +000090#ifdef HAVE_CLOCK
91
92#ifndef CLOCKS_PER_SEC
Guido van Rossum1b66a4f1996-02-25 04:50:33 +000093#ifdef CLK_TCK
94#define CLOCKS_PER_SEC CLK_TCK
95#else
Guido van Rossumb6775db1994-08-01 11:34:53 +000096#define CLOCKS_PER_SEC 1000000
97#endif
Guido van Rossum1b66a4f1996-02-25 04:50:33 +000098#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +000099
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000100static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000101time_clock(PyObject *self, PyObject *unused)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000102{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000103 return PyFloat_FromDouble(((double)clock()) / CLOCKS_PER_SEC);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000104}
Guido van Rossumb6775db1994-08-01 11:34:53 +0000105#endif /* HAVE_CLOCK */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000106
Thomas Wouters477c8d52006-05-27 19:21:47 +0000107#if defined(MS_WINDOWS) && !defined(__BORLANDC__)
Mark Hammond7ba5e812002-02-12 04:02:33 +0000108/* Due to Mark Hammond and Tim Peters */
Guido van Rossum3917c221997-04-02 05:35:28 +0000109static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000110time_clock(PyObject *self, PyObject *unused)
Guido van Rossum3917c221997-04-02 05:35:28 +0000111{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 static LARGE_INTEGER ctrStart;
113 static double divisor = 0.0;
114 LARGE_INTEGER now;
115 double diff;
Guido van Rossum3917c221997-04-02 05:35:28 +0000116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000117 if (divisor == 0.0) {
118 LARGE_INTEGER freq;
119 QueryPerformanceCounter(&ctrStart);
120 if (!QueryPerformanceFrequency(&freq) || freq.QuadPart == 0) {
121 /* Unlikely to happen - this works on all intel
122 machines at least! Revert to clock() */
123 return PyFloat_FromDouble(((double)clock()) /
124 CLOCKS_PER_SEC);
125 }
126 divisor = (double)freq.QuadPart;
127 }
128 QueryPerformanceCounter(&now);
129 diff = (double)(now.QuadPart - ctrStart.QuadPart);
130 return PyFloat_FromDouble(diff / divisor);
Guido van Rossum3917c221997-04-02 05:35:28 +0000131}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000132
Guido van Rossum3917c221997-04-02 05:35:28 +0000133#define HAVE_CLOCK /* So it gets included in the methods */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000134#endif /* MS_WINDOWS && !defined(__BORLANDC__) */
Guido van Rossum3917c221997-04-02 05:35:28 +0000135
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000136#ifdef HAVE_CLOCK
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000137PyDoc_STRVAR(clock_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000138"clock() -> floating point number\n\
139\n\
140Return the CPU time or real time since the start of the process or since\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000141the first call to clock(). This has as much precision as the system\n\
142records.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000143#endif
144
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000145static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000146time_sleep(PyObject *self, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000147{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000148 double secs;
149 if (!PyArg_ParseTuple(args, "d:sleep", &secs))
150 return NULL;
151 if (floatsleep(secs) != 0)
152 return NULL;
153 Py_INCREF(Py_None);
154 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000155}
156
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000157PyDoc_STRVAR(sleep_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000158"sleep(seconds)\n\
159\n\
160Delay execution for a given number of seconds. The argument may be\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000161a floating point number for subsecond precision.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000162
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000163static PyStructSequence_Field struct_time_type_fields[] = {
Alexander Belopolsky69f3fd02010-06-05 15:04:51 +0000164 {"tm_year", "year, for example, 1993"},
165 {"tm_mon", "month of year, range [1, 12]"},
166 {"tm_mday", "day of month, range [1, 31]"},
167 {"tm_hour", "hours, range [0, 23]"},
168 {"tm_min", "minutes, range [0, 59]"},
169 {"tm_sec", "seconds, range [0, 61])"},
170 {"tm_wday", "day of week, range [0, 6], Monday is 0"},
171 {"tm_yday", "day of year, range [1, 366]"},
172 {"tm_isdst", "1 if summer time is in effect, 0 if not, and -1 if unknown"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000173 {0}
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000174};
175
176static PyStructSequence_Desc struct_time_type_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 "time.struct_time",
Alexander Belopolsky69f3fd02010-06-05 15:04:51 +0000178 "The time value as returned by gmtime(), localtime(), and strptime(), and\n"
179 " accepted by asctime(), mktime() and strftime(). May be considered as a\n"
180 " sequence of 9 integers.\n\n"
181 " Note that several fields' values are not the same as those defined by\n"
182 " the C language standard for struct tm. For example, the value of the\n"
183 " field tm_year is the actual year, not year - 1900. See individual\n"
184 " fields' descriptions for details.",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000185 struct_time_type_fields,
186 9,
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000187};
Tim Peters9ad4b682002-02-13 05:14:18 +0000188
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000189static int initialized;
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000190static PyTypeObject StructTimeType;
191
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000192static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000193tmtotuple(struct tm *p)
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000194{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000195 PyObject *v = PyStructSequence_New(&StructTimeType);
196 if (v == NULL)
197 return NULL;
Tim Peters9ad4b682002-02-13 05:14:18 +0000198
Christian Heimes217cfd12007-12-02 14:31:20 +0000199#define SET(i,val) PyStructSequence_SET_ITEM(v, i, PyLong_FromLong((long) val))
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000201 SET(0, p->tm_year + 1900);
202 SET(1, p->tm_mon + 1); /* Want January == 1 */
203 SET(2, p->tm_mday);
204 SET(3, p->tm_hour);
205 SET(4, p->tm_min);
206 SET(5, p->tm_sec);
207 SET(6, (p->tm_wday + 6) % 7); /* Want Monday == 0 */
208 SET(7, p->tm_yday + 1); /* Want January, 1 == 1 */
209 SET(8, p->tm_isdst);
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000210#undef SET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000211 if (PyErr_Occurred()) {
212 Py_XDECREF(v);
213 return NULL;
214 }
Guido van Rossum98bf58f2001-10-18 20:34:25 +0000215
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000216 return v;
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000217}
218
219static PyObject *
Brett Cannon298c3802004-06-19 20:48:43 +0000220time_convert(double when, struct tm * (*function)(const time_t *))
Guido van Rossum234f9421993-06-17 12:35:49 +0000221{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000222 struct tm *p;
223 time_t whent = _PyTime_DoubleToTimet(when);
Brett Cannon298c3802004-06-19 20:48:43 +0000224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000225 if (whent == (time_t)-1 && PyErr_Occurred())
226 return NULL;
227 errno = 0;
228 p = function(&whent);
229 if (p == NULL) {
Guido van Rossum6e8583d1996-10-08 14:19:52 +0000230#ifdef EINVAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000231 if (errno == 0)
232 errno = EINVAL;
Guido van Rossum6e8583d1996-10-08 14:19:52 +0000233#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000234 return PyErr_SetFromErrno(PyExc_ValueError);
235 }
236 return tmtotuple(p);
Guido van Rossum234f9421993-06-17 12:35:49 +0000237}
238
Fred Drakef901abd2004-08-03 17:58:55 +0000239/* Parse arg tuple that can contain an optional float-or-None value;
240 format needs to be "|O:name".
241 Returns non-zero on success (parallels PyArg_ParseTuple).
242*/
243static int
244parse_time_double_args(PyObject *args, char *format, double *pwhen)
245{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000246 PyObject *ot = NULL;
Fred Drakef901abd2004-08-03 17:58:55 +0000247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000248 if (!PyArg_ParseTuple(args, format, &ot))
249 return 0;
250 if (ot == NULL || ot == Py_None)
251 *pwhen = floattime();
252 else {
253 double when = PyFloat_AsDouble(ot);
254 if (PyErr_Occurred())
255 return 0;
256 *pwhen = when;
257 }
258 return 1;
Fred Drakef901abd2004-08-03 17:58:55 +0000259}
260
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000261static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000262time_gmtime(PyObject *self, PyObject *args)
Guido van Rossum234f9421993-06-17 12:35:49 +0000263{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000264 double when;
265 if (!parse_time_double_args(args, "|O:gmtime", &when))
266 return NULL;
267 return time_convert(when, gmtime);
Guido van Rossum234f9421993-06-17 12:35:49 +0000268}
269
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000270PyDoc_STRVAR(gmtime_doc,
Christian Heimes9a371592007-12-28 14:08:13 +0000271"gmtime([seconds]) -> (tm_year, tm_mon, tm_mday, tm_hour, tm_min,\n\
Fred Drake193a3f62002-03-12 21:38:49 +0000272 tm_sec, tm_wday, tm_yday, tm_isdst)\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000273\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000274Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000275GMT). When 'seconds' is not passed in, convert the current time instead.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000276
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000277static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000278time_localtime(PyObject *self, PyObject *args)
Guido van Rossum234f9421993-06-17 12:35:49 +0000279{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000280 double when;
281 if (!parse_time_double_args(args, "|O:localtime", &when))
282 return NULL;
283 return time_convert(when, localtime);
Guido van Rossum234f9421993-06-17 12:35:49 +0000284}
285
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000286PyDoc_STRVAR(localtime_doc,
Christian Heimes9a371592007-12-28 14:08:13 +0000287"localtime([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min,\n\
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000288 tm_sec,tm_wday,tm_yday,tm_isdst)\n\
Martin v. Löwisb3cfc1d2001-12-02 12:27:43 +0000289\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000290Convert seconds since the Epoch to a time tuple expressing local time.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000291When 'seconds' is not passed in, convert the current time instead.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000292
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000293/* Convert 9-item tuple to tm structure. Return 1 on success, set
294 * an exception and return 0 on error.
295 */
Guido van Rossum9e90a671993-06-24 11:10:19 +0000296static int
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000297gettmarg(PyObject *args, struct tm *p)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000298{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 int y;
Guido van Rossumcfbaecc1998-08-25 14:51:12 +0000300
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000301 memset((void *) p, '\0', sizeof(struct tm));
Guido van Rossumb9081262007-08-25 03:14:09 +0000302
Alexander Belopolsky610e5442011-01-06 21:57:06 +0000303 if (!PyTuple_Check(args)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000304 PyErr_SetString(PyExc_TypeError,
305 "Tuple or struct_time argument required");
306 return 0;
307 }
Skip Montanaro41cfce92007-08-24 21:11:00 +0000308
Alexander Belopolsky610e5442011-01-06 21:57:06 +0000309 if (!PyArg_ParseTuple(args, "iiiiiiiii",
310 &y, &p->tm_mon, &p->tm_mday,
311 &p->tm_hour, &p->tm_min, &p->tm_sec,
312 &p->tm_wday, &p->tm_yday, &p->tm_isdst))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000313 return 0;
Skip Montanaro41cfce92007-08-24 21:11:00 +0000314
Alexander Belopolskya6867252011-01-05 23:00:47 +0000315 /* XXX: Why 1900? If the goal is to interpret 2-digit years as those in
316 * 20th / 21st century according to the POSIX standard, we can just treat
317 * 0 <= y < 100 as special. Year 100 is probably too ambiguous and should
318 * be rejected, but years 101 through 1899 can be passed through.
319 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000320 if (y < 1900) {
321 PyObject *accept = PyDict_GetItemString(moddict,
322 "accept2dyear");
Alexander Belopolskya6867252011-01-05 23:00:47 +0000323 int acceptval = accept != NULL && PyObject_IsTrue(accept);
324 if (acceptval == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000325 return 0;
Alexander Belopolskya6867252011-01-05 23:00:47 +0000326 if (acceptval) {
327 if (69 <= y && y <= 99)
328 y += 1900;
329 else if (0 <= y && y <= 68)
330 y += 2000;
331 else {
332 PyErr_SetString(PyExc_ValueError,
333 "year out of range");
334 return 0;
335 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000336 }
Alexander Belopolskya6867252011-01-05 23:00:47 +0000337 /* XXX: When accept2dyear is false, we don't have to reject y < 1900.
338 * Consider removing the following else-clause. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 else {
340 PyErr_SetString(PyExc_ValueError,
341 "year out of range");
342 return 0;
343 }
344 }
345 p->tm_year = y - 1900;
346 p->tm_mon--;
347 p->tm_wday = (p->tm_wday + 1) % 7;
348 p->tm_yday--;
349 return 1;
Guido van Rossum9e90a671993-06-24 11:10:19 +0000350}
351
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000352/* Check values of the struct tm fields before it is passed to strftime() and
353 * asctime(). Return 1 if all values are valid, otherwise set an exception
354 * and returns 0.
355 */
Victor Stinneref128102010-10-07 01:00:52 +0000356static int
357checktm(struct tm* buf)
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000358{
Victor Stinneref128102010-10-07 01:00:52 +0000359 /* Checks added to make sure strftime() and asctime() does not crash Python by
360 indexing blindly into some array for a textual representation
361 by some bad index (fixes bug #897625 and #6608).
362
363 Also support values of zero from Python code for arguments in which
364 that is out of range by forcing that value to the lowest value that
365 is valid (fixed bug #1520914).
366
367 Valid ranges based on what is allowed in struct tm:
368
369 - tm_year: [0, max(int)] (1)
370 - tm_mon: [0, 11] (2)
371 - tm_mday: [1, 31]
372 - tm_hour: [0, 23]
373 - tm_min: [0, 59]
374 - tm_sec: [0, 60]
375 - tm_wday: [0, 6] (1)
376 - tm_yday: [0, 365] (2)
377 - tm_isdst: [-max(int), max(int)]
378
379 (1) gettmarg() handles bounds-checking.
380 (2) Python's acceptable range is one greater than the range in C,
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000381 thus need to check against automatic decrement by gettmarg().
382 */
383 if (buf->tm_mon == -1)
384 buf->tm_mon = 0;
385 else if (buf->tm_mon < 0 || buf->tm_mon > 11) {
386 PyErr_SetString(PyExc_ValueError, "month out of range");
387 return 0;
388 }
389 if (buf->tm_mday == 0)
390 buf->tm_mday = 1;
391 else if (buf->tm_mday < 0 || buf->tm_mday > 31) {
392 PyErr_SetString(PyExc_ValueError, "day of month out of range");
393 return 0;
394 }
395 if (buf->tm_hour < 0 || buf->tm_hour > 23) {
396 PyErr_SetString(PyExc_ValueError, "hour out of range");
397 return 0;
398 }
399 if (buf->tm_min < 0 || buf->tm_min > 59) {
400 PyErr_SetString(PyExc_ValueError, "minute out of range");
401 return 0;
402 }
403 if (buf->tm_sec < 0 || buf->tm_sec > 61) {
404 PyErr_SetString(PyExc_ValueError, "seconds out of range");
405 return 0;
406 }
407 /* tm_wday does not need checking of its upper-bound since taking
408 ``% 7`` in gettmarg() automatically restricts the range. */
409 if (buf->tm_wday < 0) {
410 PyErr_SetString(PyExc_ValueError, "day of week out of range");
411 return 0;
412 }
413 if (buf->tm_yday == -1)
414 buf->tm_yday = 0;
415 else if (buf->tm_yday < 0 || buf->tm_yday > 365) {
416 PyErr_SetString(PyExc_ValueError, "day of year out of range");
417 return 0;
418 }
419 return 1;
420}
421
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000422#ifdef HAVE_STRFTIME
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000423#ifdef HAVE_WCSFTIME
424#define time_char wchar_t
425#define format_time wcsftime
426#define time_strlen wcslen
427#else
428#define time_char char
429#define format_time strftime
430#define time_strlen strlen
431#endif
432
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000433static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000434time_strftime(PyObject *self, PyObject *args)
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000435{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000436 PyObject *tup = NULL;
437 struct tm buf;
438 const time_char *fmt;
Victor Stinnerb2904782010-09-29 10:34:19 +0000439#ifdef HAVE_WCSFTIME
440 wchar_t *format;
441#else
442 PyObject *format;
443#endif
Victor Stinneref128102010-10-07 01:00:52 +0000444 PyObject *format_arg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000445 size_t fmtlen, buflen;
Victor Stinnerb2904782010-09-29 10:34:19 +0000446 time_char *outbuf = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000447 size_t i;
Victor Stinnerb2904782010-09-29 10:34:19 +0000448 PyObject *ret = NULL;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000450 memset((void *) &buf, '\0', sizeof(buf));
Guido van Rossum1f41f841998-04-27 19:04:26 +0000451
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000452 /* Will always expect a unicode string to be passed as format.
453 Given that there's no str type anymore in py3k this seems safe.
454 */
Victor Stinneref128102010-10-07 01:00:52 +0000455 if (!PyArg_ParseTuple(args, "U|O:strftime", &format_arg, &tup))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 return NULL;
Thomas Woutersfe385252001-01-19 23:16:56 +0000457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000458 if (tup == NULL) {
459 time_t tt = time(NULL);
460 buf = *localtime(&tt);
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000461 }
462 else if (!gettmarg(tup, &buf) || !checktm(&buf))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000463 return NULL;
Guido van Rossum10b164a2001-09-25 13:59:01 +0000464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000465 /* Normalize tm_isdst just in case someone foolishly implements %Z
466 based on the assumption that tm_isdst falls within the range of
467 [-1, 1] */
468 if (buf.tm_isdst < -1)
469 buf.tm_isdst = -1;
470 else if (buf.tm_isdst > 1)
471 buf.tm_isdst = 1;
Brett Cannond1080a32004-03-02 04:38:10 +0000472
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000473#ifdef HAVE_WCSFTIME
Victor Stinnerbeb4135b2010-10-07 01:02:42 +0000474 format = PyUnicode_AsWideCharString(format_arg, NULL);
Victor Stinnerb2904782010-09-29 10:34:19 +0000475 if (format == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 return NULL;
Victor Stinnerb2904782010-09-29 10:34:19 +0000477 fmt = format;
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000478#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000479 /* Convert the unicode string to an ascii one */
Victor Stinneref128102010-10-07 01:00:52 +0000480 format = PyUnicode_AsEncodedString(format_arg, TZNAME_ENCODING, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000481 if (format == NULL)
482 return NULL;
483 fmt = PyBytes_AS_STRING(format);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000484#endif
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000485
Hirokazu Yamamoto6b0e51a2009-06-03 05:19:18 +0000486#if defined(MS_WINDOWS) && defined(HAVE_WCSFTIME)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000487 /* check that the format string contains only valid directives */
488 for(outbuf = wcschr(fmt, L'%');
489 outbuf != NULL;
490 outbuf = wcschr(outbuf+2, L'%'))
491 {
492 if (outbuf[1]=='#')
493 ++outbuf; /* not documented by python, */
494 if (outbuf[1]=='\0' ||
495 !wcschr(L"aAbBcdfHIjmMpSUwWxXyYzZ%", outbuf[1]))
496 {
497 PyErr_SetString(PyExc_ValueError, "Invalid format string");
498 return 0;
499 }
500 }
Amaury Forgeot d'Arcb5be6d42009-03-02 23:52:57 +0000501#endif
502
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000503 fmtlen = time_strlen(fmt);
Guido van Rossumc222ec21999-02-23 00:00:10 +0000504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000505 /* I hate these functions that presume you know how big the output
506 * will be ahead of time...
507 */
508 for (i = 1024; ; i += i) {
509 outbuf = (time_char *)PyMem_Malloc(i*sizeof(time_char));
510 if (outbuf == NULL) {
Victor Stinnerb2904782010-09-29 10:34:19 +0000511 PyErr_NoMemory();
512 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000513 }
514 buflen = format_time(outbuf, i, fmt, &buf);
515 if (buflen > 0 || i >= 256 * fmtlen) {
516 /* If the buffer is 256 times as long as the format,
517 it's probably not failing for lack of room!
518 More likely, the format yields an empty result,
519 e.g. an empty format, or %Z when the timezone
520 is unknown. */
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000521#ifdef HAVE_WCSFTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 ret = PyUnicode_FromWideChar(outbuf, buflen);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000523#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000524 ret = PyUnicode_Decode(outbuf, buflen,
525 TZNAME_ENCODING, NULL);
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000526#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000527 PyMem_Free(outbuf);
Victor Stinnerb2904782010-09-29 10:34:19 +0000528 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000529 }
530 PyMem_Free(outbuf);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000531#if defined _MSC_VER && _MSC_VER >= 1400 && defined(__STDC_SECURE_LIB__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000532 /* VisualStudio .NET 2005 does this properly */
533 if (buflen == 0 && errno == EINVAL) {
534 PyErr_SetString(PyExc_ValueError, "Invalid format string");
Victor Stinnerb2904782010-09-29 10:34:19 +0000535 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000536 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000537#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 }
Victor Stinnerb2904782010-09-29 10:34:19 +0000539#ifdef HAVE_WCSFTIME
540 PyMem_Free(format);
541#else
542 Py_DECREF(format);
543#endif
544 return ret;
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000545}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000546
Martin v. Löwis1b01ccd2009-05-30 06:13:40 +0000547#undef time_char
548#undef format_time
549
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000550PyDoc_STRVAR(strftime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000551"strftime(format[, tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000552\n\
553Convert a time tuple to a string according to a format specification.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000554See the library reference manual for formatting codes. When the time tuple\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000555is not present, current time as returned by localtime() is used.");
Guido van Rossum8d8c1ee1995-09-13 17:38:35 +0000556#endif /* HAVE_STRFTIME */
557
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000558static PyObject *
559time_strptime(PyObject *self, PyObject *args)
560{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000561 PyObject *strptime_module = PyImport_ImportModuleNoBlock("_strptime");
562 PyObject *strptime_result;
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000563
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000564 if (!strptime_module)
565 return NULL;
566 strptime_result = PyObject_CallMethod(strptime_module,
567 "_strptime_time", "O", args);
568 Py_DECREF(strptime_module);
569 return strptime_result;
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000570}
571
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000572
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000573PyDoc_STRVAR(strptime_doc,
Brett Cannon20def8b2003-07-01 05:16:08 +0000574"strptime(string, format) -> struct_time\n\
Martin v. Löwisb3cfc1d2001-12-02 12:27:43 +0000575\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000576Parse a string to a time tuple according to a format specification.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000577See the library reference manual for formatting codes (same as strftime()).");
Guido van Rossumd3c46d52002-07-19 17:06:47 +0000578
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000579static PyObject *
580_asctime(struct tm *timeptr)
581{
582 /* Inspired by Open Group reference implementation available at
583 * http://pubs.opengroup.org/onlinepubs/009695399/functions/asctime.html */
584 static char wday_name[7][3] = {
585 "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"
586 };
587 static char mon_name[12][3] = {
588 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
589 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
590 };
591 char buf[20]; /* 'Sun Sep 16 01:03:52\0' */
592 int n;
593
Alexander Belopolskyecbb8dc2011-01-06 16:45:25 +0000594 n = PyOS_snprintf(buf, sizeof(buf), "%.3s %.3s%3d %.2d:%.2d:%.2d",
595 wday_name[timeptr->tm_wday],
596 mon_name[timeptr->tm_mon],
597 timeptr->tm_mday, timeptr->tm_hour,
598 timeptr->tm_min, timeptr->tm_sec);
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000599 /* XXX: since the fields used by snprintf above are validated in checktm,
600 * the following condition should never trigger. We keep the check because
601 * historically fixed size buffer used in asctime was the source of
602 * crashes. */
603 if (n + 1 != sizeof(buf)) {
604 PyErr_SetString(PyExc_ValueError, "unconvertible time");
605 return NULL;
606 }
607
608 return PyUnicode_FromFormat("%s %d", buf, 1900 + timeptr->tm_year);
609}
Guido van Rossum87ce7bb1998-06-09 16:30:31 +0000610
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000611static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000612time_asctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000613{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000614 PyObject *tup = NULL;
615 struct tm buf;
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000617 if (!PyArg_UnpackTuple(args, "asctime", 0, 1, &tup))
618 return NULL;
619 if (tup == NULL) {
620 time_t tt = time(NULL);
621 buf = *localtime(&tt);
Alexander Belopolsky38e29962010-10-01 14:18:49 +0000622 } else if (!gettmarg(tup, &buf) || !checktm(&buf))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000623 return NULL;
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000624 return _asctime(&buf);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000625}
626
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000627PyDoc_STRVAR(asctime_doc,
Thomas Woutersfe385252001-01-19 23:16:56 +0000628"asctime([tuple]) -> string\n\
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000629\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000630Convert a time tuple to a string, e.g. 'Sat Jun 06 16:26:11 1998'.\n\
631When the time tuple is not present, current time as returned by localtime()\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000632is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000633
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000634static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000635time_ctime(PyObject *self, PyObject *args)
Guido van Rossum9e90a671993-06-24 11:10:19 +0000636{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000637 PyObject *ot = NULL;
638 time_t tt;
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000639 struct tm *timeptr;
Guido van Rossum10b164a2001-09-25 13:59:01 +0000640
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 if (!PyArg_UnpackTuple(args, "ctime", 0, 1, &ot))
642 return NULL;
643 if (ot == NULL || ot == Py_None)
644 tt = time(NULL);
645 else {
646 double dt = PyFloat_AsDouble(ot);
647 if (PyErr_Occurred())
648 return NULL;
649 tt = _PyTime_DoubleToTimet(dt);
650 if (tt == (time_t)-1 && PyErr_Occurred())
651 return NULL;
652 }
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000653 timeptr = localtime(&tt);
654 if (timeptr == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000655 PyErr_SetString(PyExc_ValueError, "unconvertible time");
Alexander Belopolsky5da468f2011-01-04 17:15:52 +0000656 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000657 }
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000658 return _asctime(timeptr);
Guido van Rossum9e90a671993-06-24 11:10:19 +0000659}
660
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000661PyDoc_STRVAR(ctime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000662"ctime(seconds) -> string\n\
663\n\
664Convert a time in seconds since the Epoch to a string in local time.\n\
Thomas Woutersfe385252001-01-19 23:16:56 +0000665This is equivalent to asctime(localtime(seconds)). When the time tuple is\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000666not present, current time as returned by localtime() is used.");
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000667
Guido van Rossum60cd8131998-03-06 17:16:21 +0000668#ifdef HAVE_MKTIME
Barry Warsaw9a2a8a81996-12-06 23:32:14 +0000669static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000670time_mktime(PyObject *self, PyObject *tup)
Guido van Rossum234f9421993-06-17 12:35:49 +0000671{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000672 struct tm buf;
673 time_t tt;
674 if (!gettmarg(tup, &buf))
675 return NULL;
676 tt = mktime(&buf);
677 if (tt == (time_t)(-1)) {
678 PyErr_SetString(PyExc_OverflowError,
679 "mktime argument out of range");
680 return NULL;
681 }
682 return PyFloat_FromDouble((double)tt);
Guido van Rossum234f9421993-06-17 12:35:49 +0000683}
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000684
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000685PyDoc_STRVAR(mktime_doc,
Guido van Rossum0ef577b1998-06-27 20:38:36 +0000686"mktime(tuple) -> floating point number\n\
687\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000688Convert a time tuple in local time to seconds since the Epoch.");
Guido van Rossum60cd8131998-03-06 17:16:21 +0000689#endif /* HAVE_MKTIME */
Guido van Rossum234f9421993-06-17 12:35:49 +0000690
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000691#ifdef HAVE_WORKING_TZSET
Martin v. Löwis1a214512008-06-11 05:26:20 +0000692static void PyInit_timezone(PyObject *module);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000693
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000694static PyObject *
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000695time_tzset(PyObject *self, PyObject *unused)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000696{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 PyObject* m;
Fred Drake9bb74322002-04-01 14:49:59 +0000698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 m = PyImport_ImportModuleNoBlock("time");
700 if (m == NULL) {
701 return NULL;
702 }
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000703
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000704 tzset();
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000705
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000706 /* Reset timezone, altzone, daylight and tzname */
707 PyInit_timezone(m);
708 Py_DECREF(m);
Tim Peters1b6f7a92004-06-20 02:50:16 +0000709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000710 Py_INCREF(Py_None);
711 return Py_None;
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000712}
713
714PyDoc_STRVAR(tzset_doc,
R. David Murray4d55bf92010-12-14 00:55:46 +0000715"tzset()\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000716\n\
717Initialize, or reinitialize, the local timezone to the value stored in\n\
718os.environ['TZ']. The TZ environment variable should be specified in\n\
Neal Norwitzdc8e1942004-07-20 22:34:37 +0000719standard Unix timezone format as documented in the tzset man page\n\
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000720(eg. 'US/Eastern', 'Europe/Amsterdam'). Unknown timezones will silently\n\
721fall back to UTC. If the TZ environment variable is not set, the local\n\
722timezone is set to the systems best guess of wallclock time.\n\
723Changing the TZ environment variable without calling tzset *may* change\n\
724the local timezone used by methods such as localtime, but this behaviour\n\
725should not be relied on.");
726#endif /* HAVE_WORKING_TZSET */
727
Martin v. Löwisd218dc12008-04-07 03:17:54 +0000728static void
Martin v. Löwis1a214512008-06-11 05:26:20 +0000729PyInit_timezone(PyObject *m) {
730 /* This code moved from PyInit_time wholesale to allow calling it from
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000731 time_tzset. In the future, some parts of it can be moved back
732 (for platforms that don't HAVE_WORKING_TZSET, when we know what they
733 are), and the extraneous calls to tzset(3) should be removed.
734 I haven't done this yet, as I don't want to change this code as
735 little as possible when introducing the time.tzset and time.tzsetwall
736 methods. This should simply be a method of doing the following once,
737 at the top of this function and removing the call to tzset() from
738 time_tzset():
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 #ifdef HAVE_TZSET
741 tzset()
742 #endif
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000743
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 And I'm lazy and hate C so nyer.
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000745 */
Guido van Rossum10b164a2001-09-25 13:59:01 +0000746#if defined(HAVE_TZNAME) && !defined(__GLIBC__) && !defined(__CYGWIN__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 PyObject *otz0, *otz1;
748 tzset();
Guido van Rossum26452411998-09-28 22:07:11 +0000749#ifdef PYOS_OS2
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 PyModule_AddIntConstant(m, "timezone", _timezone);
Guido van Rossum26452411998-09-28 22:07:11 +0000751#else /* !PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000752 PyModule_AddIntConstant(m, "timezone", timezone);
Guido van Rossum26452411998-09-28 22:07:11 +0000753#endif /* PYOS_OS2 */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000754#ifdef HAVE_ALTZONE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 PyModule_AddIntConstant(m, "altzone", altzone);
Guido van Rossumb6775db1994-08-01 11:34:53 +0000756#else
Guido van Rossum26452411998-09-28 22:07:11 +0000757#ifdef PYOS_OS2
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000758 PyModule_AddIntConstant(m, "altzone", _timezone-3600);
Guido van Rossum26452411998-09-28 22:07:11 +0000759#else /* !PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 PyModule_AddIntConstant(m, "altzone", timezone-3600);
Guido van Rossum26452411998-09-28 22:07:11 +0000761#endif /* PYOS_OS2 */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000762#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000763 PyModule_AddIntConstant(m, "daylight", daylight);
764 otz0 = PyUnicode_Decode(tzname[0], strlen(tzname[0]), TZNAME_ENCODING, NULL);
765 otz1 = PyUnicode_Decode(tzname[1], strlen(tzname[1]), TZNAME_ENCODING, NULL);
766 PyModule_AddObject(m, "tzname", Py_BuildValue("(NN)", otz0, otz1));
Guido van Rossum10b164a2001-09-25 13:59:01 +0000767#else /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Martin v. Löwis60a5d722002-10-16 20:28:25 +0000768#ifdef HAVE_STRUCT_TM_TM_ZONE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000769 {
Guido van Rossum234f9421993-06-17 12:35:49 +0000770#define YEAR ((time_t)((365 * 24 + 6) * 3600))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 time_t t;
772 struct tm *p;
773 long janzone, julyzone;
774 char janname[10], julyname[10];
775 t = (time((time_t *)0) / YEAR) * YEAR;
776 p = localtime(&t);
777 janzone = -p->tm_gmtoff;
778 strncpy(janname, p->tm_zone ? p->tm_zone : " ", 9);
779 janname[9] = '\0';
780 t += YEAR/2;
781 p = localtime(&t);
782 julyzone = -p->tm_gmtoff;
783 strncpy(julyname, p->tm_zone ? p->tm_zone : " ", 9);
784 julyname[9] = '\0';
Guido van Rossum10b164a2001-09-25 13:59:01 +0000785
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000786 if( janzone < julyzone ) {
787 /* DST is reversed in the southern hemisphere */
788 PyModule_AddIntConstant(m, "timezone", julyzone);
789 PyModule_AddIntConstant(m, "altzone", janzone);
790 PyModule_AddIntConstant(m, "daylight",
791 janzone != julyzone);
792 PyModule_AddObject(m, "tzname",
793 Py_BuildValue("(zz)",
794 julyname, janname));
795 } else {
796 PyModule_AddIntConstant(m, "timezone", janzone);
797 PyModule_AddIntConstant(m, "altzone", julyzone);
798 PyModule_AddIntConstant(m, "daylight",
799 janzone != julyzone);
800 PyModule_AddObject(m, "tzname",
801 Py_BuildValue("(zz)",
802 janname, julyname));
803 }
804 }
Guido van Rossume6a4b7b1997-10-08 15:27:56 +0000805#else
Martin v. Löwis60a5d722002-10-16 20:28:25 +0000806#endif /* HAVE_STRUCT_TM_TM_ZONE */
Tim Peters26ae7cd2001-03-20 03:26:49 +0000807#ifdef __CYGWIN__
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 tzset();
809 PyModule_AddIntConstant(m, "timezone", _timezone);
810 PyModule_AddIntConstant(m, "altzone", _timezone-3600);
811 PyModule_AddIntConstant(m, "daylight", _daylight);
812 PyModule_AddObject(m, "tzname",
813 Py_BuildValue("(zz)", _tzname[0], _tzname[1]));
Tim Peters26ae7cd2001-03-20 03:26:49 +0000814#endif /* __CYGWIN__ */
Guido van Rossum10b164a2001-09-25 13:59:01 +0000815#endif /* !HAVE_TZNAME || __GLIBC__ || __CYGWIN__*/
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000816}
817
818
819static PyMethodDef time_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000820 {"time", time_time, METH_NOARGS, time_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000821#ifdef HAVE_CLOCK
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000822 {"clock", time_clock, METH_NOARGS, clock_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000823#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 {"sleep", time_sleep, METH_VARARGS, sleep_doc},
825 {"gmtime", time_gmtime, METH_VARARGS, gmtime_doc},
826 {"localtime", time_localtime, METH_VARARGS, localtime_doc},
827 {"asctime", time_asctime, METH_VARARGS, asctime_doc},
828 {"ctime", time_ctime, METH_VARARGS, ctime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000829#ifdef HAVE_MKTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 {"mktime", time_mktime, METH_O, mktime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000831#endif
832#ifdef HAVE_STRFTIME
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000833 {"strftime", time_strftime, METH_VARARGS, strftime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000834#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000835 {"strptime", time_strptime, METH_VARARGS, strptime_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000836#ifdef HAVE_WORKING_TZSET
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000837 {"tzset", time_tzset, METH_NOARGS, tzset_doc},
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000838#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000839 {NULL, NULL} /* sentinel */
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000840};
841
842
843PyDoc_STRVAR(module_doc,
844"This module provides various functions to manipulate time values.\n\
845\n\
846There are two standard representations of time. One is the number\n\
847of seconds since the Epoch, in UTC (a.k.a. GMT). It may be an integer\n\
848or a floating point number (to represent fractions of seconds).\n\
849The Epoch is system-defined; on Unix, it is generally January 1st, 1970.\n\
850The actual value can be retrieved by calling gmtime(0).\n\
851\n\
852The other representation is a tuple of 9 integers giving local time.\n\
853The tuple items are:\n\
854 year (four digits, e.g. 1998)\n\
855 month (1-12)\n\
856 day (1-31)\n\
857 hours (0-23)\n\
858 minutes (0-59)\n\
859 seconds (0-59)\n\
860 weekday (0-6, Monday is 0)\n\
861 Julian day (day in the year, 1-366)\n\
862 DST (Daylight Savings Time) flag (-1, 0 or 1)\n\
863If the DST flag is 0, the time is given in the regular time zone;\n\
864if it is 1, the time is given in the DST time zone;\n\
865if it is -1, mktime() should guess based on the date and time.\n\
866\n\
867Variables:\n\
868\n\
869timezone -- difference in seconds between UTC and local standard time\n\
870altzone -- difference in seconds between UTC and local DST time\n\
871daylight -- whether local time should reflect DST\n\
872tzname -- tuple of (standard time zone name, DST time zone name)\n\
873\n\
874Functions:\n\
875\n\
876time() -- return current time in seconds since the Epoch as a float\n\
877clock() -- return CPU time since process start as a float\n\
878sleep() -- delay for a number of seconds given as a float\n\
879gmtime() -- convert seconds since Epoch to UTC tuple\n\
880localtime() -- convert seconds since Epoch to local time tuple\n\
881asctime() -- convert time tuple to string\n\
882ctime() -- convert time in seconds to string\n\
883mktime() -- convert local time tuple to seconds since Epoch\n\
884strftime() -- convert time tuple to string according to format specification\n\
885strptime() -- parse string to time tuple according to format specification\n\
886tzset() -- change the local timezone");
887
888
Martin v. Löwis1a214512008-06-11 05:26:20 +0000889
890static struct PyModuleDef timemodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000891 PyModuleDef_HEAD_INIT,
892 "time",
893 module_doc,
894 -1,
895 time_methods,
896 NULL,
897 NULL,
898 NULL,
899 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +0000900};
901
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000902PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +0000903PyInit_time(void)
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000904{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 PyObject *m;
906 char *p;
907 m = PyModule_Create(&timemodule);
908 if (m == NULL)
909 return NULL;
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000910
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000911 /* Accept 2-digit dates unless PYTHONY2K is set and non-empty */
912 p = Py_GETENV("PYTHONY2K");
913 PyModule_AddIntConstant(m, "accept2dyear", (long) (!p || !*p));
914 /* Squirrel away the module's dictionary for the y2k check */
915 moddict = PyModule_GetDict(m);
916 Py_INCREF(moddict);
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 /* Set, or reset, module variables like time.timezone */
919 PyInit_timezone(m);
Guido van Rossumd11b62e2003-03-14 21:51:36 +0000920
Mark Hammond975e3922002-07-16 01:29:19 +0000921#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000922 /* Helper to allow interrupts for Windows.
923 If Ctrl+C event delivered while not sleeping
924 it will be ignored.
925 */
926 main_thread = PyThread_get_thread_ident();
927 hInterruptEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
928 SetConsoleCtrlHandler( PyCtrlHandler, TRUE);
Mark Hammond975e3922002-07-16 01:29:19 +0000929#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 if (!initialized) {
931 PyStructSequence_InitType(&StructTimeType,
932 &struct_time_type_desc);
933 }
934 Py_INCREF(&StructTimeType);
935 PyModule_AddObject(m, "struct_time", (PyObject*) &StructTimeType);
936 initialized = 1;
937 return m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000938}
939
Guido van Rossumb6775db1994-08-01 11:34:53 +0000940static double
Thomas Woutersf3f33dc2000-07-21 06:00:07 +0000941floattime(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000942{
Alexander Belopolsky6fc4ade2010-08-05 17:34:27 +0000943 _PyTime_timeval t;
944 _PyTime_gettimeofday(&t);
945 return (double)t.tv_sec + t.tv_usec*0.000001;
Guido van Rossum426035c1991-02-19 12:27:35 +0000946}
947
Guido van Rossumb6775db1994-08-01 11:34:53 +0000948
949/* Implement floatsleep() for various platforms.
950 When interrupted (or when another error occurs), return -1 and
951 set an exception; else return 0. */
952
953static int
Guido van Rossuma320fd31995-03-09 12:14:15 +0000954floatsleep(double secs)
Guido van Rossum426035c1991-02-19 12:27:35 +0000955{
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000956/* XXX Should test for MS_WINDOWS first! */
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000957#if defined(HAVE_SELECT) && !defined(__EMX__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 struct timeval t;
959 double frac;
960 frac = fmod(secs, 1.0);
961 secs = floor(secs);
962 t.tv_sec = (long)secs;
963 t.tv_usec = (long)(frac*1000000.0);
964 Py_BEGIN_ALLOW_THREADS
965 if (select(0, (fd_set *)0, (fd_set *)0, (fd_set *)0, &t) != 0) {
Guido van Rossum09cbb011999-11-08 15:32:27 +0000966#ifdef EINTR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 if (errno != EINTR) {
Guido van Rossum09cbb011999-11-08 15:32:27 +0000968#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 if (1) {
Guido van Rossum09cbb011999-11-08 15:32:27 +0000970#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 Py_BLOCK_THREADS
972 PyErr_SetFromErrno(PyExc_IOError);
973 return -1;
974 }
975 }
976 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +0000977#elif defined(__WATCOMC__) && !defined(__QNX__)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 /* XXX Can't interrupt this sleep */
979 Py_BEGIN_ALLOW_THREADS
980 delay((int)(secs * 1000 + 0.5)); /* delay() uses milliseconds */
981 Py_END_ALLOW_THREADS
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000982#elif defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 {
984 double millisecs = secs * 1000.0;
985 unsigned long ul_millis;
Tim Peters513a1cd2003-01-19 04:54:58 +0000986
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 if (millisecs > (double)ULONG_MAX) {
988 PyErr_SetString(PyExc_OverflowError,
989 "sleep length is too large");
990 return -1;
991 }
992 Py_BEGIN_ALLOW_THREADS
993 /* Allow sleep(0) to maintain win32 semantics, and as decreed
994 * by Guido, only the main thread can be interrupted.
995 */
996 ul_millis = (unsigned long)millisecs;
997 if (ul_millis == 0 ||
998 main_thread != PyThread_get_thread_ident())
999 Sleep(ul_millis);
1000 else {
1001 DWORD rc;
1002 ResetEvent(hInterruptEvent);
1003 rc = WaitForSingleObject(hInterruptEvent, ul_millis);
1004 if (rc == WAIT_OBJECT_0) {
1005 /* Yield to make sure real Python signal
1006 * handler called.
1007 */
1008 Sleep(1);
1009 Py_BLOCK_THREADS
1010 errno = EINTR;
1011 PyErr_SetFromErrno(PyExc_IOError);
1012 return -1;
1013 }
1014 }
1015 Py_END_ALLOW_THREADS
1016 }
Martin v. Löwis02af9642002-01-16 11:04:06 +00001017#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001018 /* This Sleep *IS* Interruptable by Exceptions */
1019 Py_BEGIN_ALLOW_THREADS
1020 if (DosSleep(secs * 1000) != NO_ERROR) {
1021 Py_BLOCK_THREADS
1022 PyErr_SetFromErrno(PyExc_IOError);
1023 return -1;
1024 }
1025 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +00001026#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 /* XXX Can't interrupt this sleep */
1028 Py_BEGIN_ALLOW_THREADS
1029 sleep((int)secs);
1030 Py_END_ALLOW_THREADS
Martin v. Löwis02af9642002-01-16 11:04:06 +00001031#endif
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001032
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001033 return 0;
Guido van Rossum80c9d881991-04-16 08:47:51 +00001034}