blob: 6ee531768a55b44358b55ca1371e4a6427fcf22a [file] [log] [blame]
Tim Peters2a799bf2002-12-16 20:18:38 +00001/* C implementation for the date/time type documented at
2 * http://www.zope.org/Members/fdrake/DateTimeWiki/FrontPage
3 */
4
5#include "Python.h"
Tim Peters2a799bf2002-12-16 20:18:38 +00006#include "structmember.h"
7
8#include <time.h>
9
Alexander Belopolsky6fc4ade2010-08-05 17:34:27 +000010#include "_time.h"
Tim Peters9ddf40b2004-06-20 22:41:32 +000011
12/* Differentiate between building the core module and building extension
13 * modules.
14 */
Guido van Rossum360e4b82007-05-14 22:51:27 +000015#ifndef Py_BUILD_CORE
Tim Peters9ddf40b2004-06-20 22:41:32 +000016#define Py_BUILD_CORE
Guido van Rossum360e4b82007-05-14 22:51:27 +000017#endif
Tim Peters2a799bf2002-12-16 20:18:38 +000018#include "datetime.h"
Tim Peters9ddf40b2004-06-20 22:41:32 +000019#undef Py_BUILD_CORE
Tim Peters2a799bf2002-12-16 20:18:38 +000020
21/* We require that C int be at least 32 bits, and use int virtually
22 * everywhere. In just a few cases we use a temp long, where a Python
23 * API returns a C long. In such cases, we have to ensure that the
24 * final result fits in a C int (this can be an issue on 64-bit boxes).
25 */
26#if SIZEOF_INT < 4
Alexander Belopolskycf86e362010-07-23 19:25:47 +000027# error "_datetime.c requires that C int have at least 32 bits"
Tim Peters2a799bf2002-12-16 20:18:38 +000028#endif
29
30#define MINYEAR 1
31#define MAXYEAR 9999
Alexander Belopolskyf03a6162010-05-27 21:42:58 +000032#define MAXORDINAL 3652059 /* date(9999,12,31).toordinal() */
Tim Peters2a799bf2002-12-16 20:18:38 +000033
34/* Nine decimal digits is easy to communicate, and leaves enough room
35 * so that two delta days can be added w/o fear of overflowing a signed
36 * 32-bit int, and with plenty of room left over to absorb any possible
37 * carries from adding seconds.
38 */
39#define MAX_DELTA_DAYS 999999999
40
41/* Rename the long macros in datetime.h to more reasonable short names. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000042#define GET_YEAR PyDateTime_GET_YEAR
43#define GET_MONTH PyDateTime_GET_MONTH
44#define GET_DAY PyDateTime_GET_DAY
45#define DATE_GET_HOUR PyDateTime_DATE_GET_HOUR
46#define DATE_GET_MINUTE PyDateTime_DATE_GET_MINUTE
47#define DATE_GET_SECOND PyDateTime_DATE_GET_SECOND
48#define DATE_GET_MICROSECOND PyDateTime_DATE_GET_MICROSECOND
Tim Peters2a799bf2002-12-16 20:18:38 +000049
50/* Date accessors for date and datetime. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000051#define SET_YEAR(o, v) (((o)->data[0] = ((v) & 0xff00) >> 8), \
52 ((o)->data[1] = ((v) & 0x00ff)))
53#define SET_MONTH(o, v) (PyDateTime_GET_MONTH(o) = (v))
54#define SET_DAY(o, v) (PyDateTime_GET_DAY(o) = (v))
Tim Peters2a799bf2002-12-16 20:18:38 +000055
56/* Date/Time accessors for datetime. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000057#define DATE_SET_HOUR(o, v) (PyDateTime_DATE_GET_HOUR(o) = (v))
58#define DATE_SET_MINUTE(o, v) (PyDateTime_DATE_GET_MINUTE(o) = (v))
59#define DATE_SET_SECOND(o, v) (PyDateTime_DATE_GET_SECOND(o) = (v))
60#define DATE_SET_MICROSECOND(o, v) \
61 (((o)->data[7] = ((v) & 0xff0000) >> 16), \
62 ((o)->data[8] = ((v) & 0x00ff00) >> 8), \
63 ((o)->data[9] = ((v) & 0x0000ff)))
Tim Peters2a799bf2002-12-16 20:18:38 +000064
65/* Time accessors for time. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000066#define TIME_GET_HOUR PyDateTime_TIME_GET_HOUR
67#define TIME_GET_MINUTE PyDateTime_TIME_GET_MINUTE
68#define TIME_GET_SECOND PyDateTime_TIME_GET_SECOND
69#define TIME_GET_MICROSECOND PyDateTime_TIME_GET_MICROSECOND
70#define TIME_SET_HOUR(o, v) (PyDateTime_TIME_GET_HOUR(o) = (v))
71#define TIME_SET_MINUTE(o, v) (PyDateTime_TIME_GET_MINUTE(o) = (v))
72#define TIME_SET_SECOND(o, v) (PyDateTime_TIME_GET_SECOND(o) = (v))
73#define TIME_SET_MICROSECOND(o, v) \
74 (((o)->data[3] = ((v) & 0xff0000) >> 16), \
75 ((o)->data[4] = ((v) & 0x00ff00) >> 8), \
76 ((o)->data[5] = ((v) & 0x0000ff)))
Tim Peters2a799bf2002-12-16 20:18:38 +000077
78/* Delta accessors for timedelta. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000079#define GET_TD_DAYS(o) (((PyDateTime_Delta *)(o))->days)
80#define GET_TD_SECONDS(o) (((PyDateTime_Delta *)(o))->seconds)
81#define GET_TD_MICROSECONDS(o) (((PyDateTime_Delta *)(o))->microseconds)
Tim Peters2a799bf2002-12-16 20:18:38 +000082
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000083#define SET_TD_DAYS(o, v) ((o)->days = (v))
84#define SET_TD_SECONDS(o, v) ((o)->seconds = (v))
Tim Peters2a799bf2002-12-16 20:18:38 +000085#define SET_TD_MICROSECONDS(o, v) ((o)->microseconds = (v))
86
Tim Petersa032d2e2003-01-11 00:15:54 +000087/* p is a pointer to a time or a datetime object; HASTZINFO(p) returns
88 * p->hastzinfo.
89 */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +000090#define HASTZINFO(p) (((_PyDateTime_BaseTZInfo *)(p))->hastzinfo)
91#define GET_TIME_TZINFO(p) (HASTZINFO(p) ? \
92 ((PyDateTime_Time *)(p))->tzinfo : Py_None)
93#define GET_DT_TZINFO(p) (HASTZINFO(p) ? \
94 ((PyDateTime_DateTime *)(p))->tzinfo : Py_None)
Tim Peters3f606292004-03-21 23:38:41 +000095/* M is a char or int claiming to be a valid month. The macro is equivalent
96 * to the two-sided Python test
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000097 * 1 <= M <= 12
Tim Peters3f606292004-03-21 23:38:41 +000098 */
99#define MONTH_IS_SANE(M) ((unsigned int)(M) - 1 < 12)
100
Tim Peters2a799bf2002-12-16 20:18:38 +0000101/* Forward declarations. */
102static PyTypeObject PyDateTime_DateType;
103static PyTypeObject PyDateTime_DateTimeType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000104static PyTypeObject PyDateTime_DeltaType;
105static PyTypeObject PyDateTime_TimeType;
106static PyTypeObject PyDateTime_TZInfoType;
Alexander Belopolsky4e749a12010-06-14 14:15:50 +0000107static PyTypeObject PyDateTime_TimeZoneType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000108
109/* ---------------------------------------------------------------------------
110 * Math utilities.
111 */
112
113/* k = i+j overflows iff k differs in sign from both inputs,
114 * iff k^i has sign bit set and k^j has sign bit set,
115 * iff (k^i)&(k^j) has sign bit set.
116 */
117#define SIGNED_ADD_OVERFLOWED(RESULT, I, J) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000118 ((((RESULT) ^ (I)) & ((RESULT) ^ (J))) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +0000119
120/* Compute Python divmod(x, y), returning the quotient and storing the
121 * remainder into *r. The quotient is the floor of x/y, and that's
122 * the real point of this. C will probably truncate instead (C99
123 * requires truncation; C89 left it implementation-defined).
124 * Simplification: we *require* that y > 0 here. That's appropriate
125 * for all the uses made of it. This simplifies the code and makes
126 * the overflow case impossible (divmod(LONG_MIN, -1) is the only
127 * overflow case).
128 */
129static int
130divmod(int x, int y, int *r)
131{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000132 int quo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000133
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000134 assert(y > 0);
135 quo = x / y;
136 *r = x - quo * y;
137 if (*r < 0) {
138 --quo;
139 *r += y;
140 }
141 assert(0 <= *r && *r < y);
142 return quo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000143}
144
Tim Peters5d644dd2003-01-02 16:32:54 +0000145/* Round a double to the nearest long. |x| must be small enough to fit
146 * in a C long; this is not checked.
147 */
148static long
149round_to_long(double x)
150{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000151 if (x >= 0.0)
152 x = floor(x + 0.5);
153 else
154 x = ceil(x - 0.5);
155 return (long)x;
Tim Peters5d644dd2003-01-02 16:32:54 +0000156}
157
Alexander Belopolsky1790bc42010-05-31 17:33:47 +0000158/* Nearest integer to m / n for integers m and n. Half-integer results
159 * are rounded to even.
160 */
161static PyObject *
162divide_nearest(PyObject *m, PyObject *n)
163{
164 PyObject *result;
165 PyObject *temp;
166
Mark Dickinsonfa68a612010-06-07 18:47:09 +0000167 temp = _PyLong_DivmodNear(m, n);
Alexander Belopolsky1790bc42010-05-31 17:33:47 +0000168 if (temp == NULL)
169 return NULL;
170 result = PyTuple_GET_ITEM(temp, 0);
171 Py_INCREF(result);
172 Py_DECREF(temp);
173
174 return result;
175}
176
Tim Peters2a799bf2002-12-16 20:18:38 +0000177/* ---------------------------------------------------------------------------
178 * General calendrical helper functions
179 */
180
181/* For each month ordinal in 1..12, the number of days in that month,
182 * and the number of days before that month in the same year. These
183 * are correct for non-leap years only.
184 */
185static int _days_in_month[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 0, /* unused; this vector uses 1-based indexing */
187 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
Tim Peters2a799bf2002-12-16 20:18:38 +0000188};
189
190static int _days_before_month[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 0, /* unused; this vector uses 1-based indexing */
192 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
Tim Peters2a799bf2002-12-16 20:18:38 +0000193};
194
195/* year -> 1 if leap year, else 0. */
196static int
197is_leap(int year)
198{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000199 /* Cast year to unsigned. The result is the same either way, but
200 * C can generate faster code for unsigned mod than for signed
201 * mod (especially for % 4 -- a good compiler should just grab
202 * the last 2 bits when the LHS is unsigned).
203 */
204 const unsigned int ayear = (unsigned int)year;
205 return ayear % 4 == 0 && (ayear % 100 != 0 || ayear % 400 == 0);
Tim Peters2a799bf2002-12-16 20:18:38 +0000206}
207
208/* year, month -> number of days in that month in that year */
209static int
210days_in_month(int year, int month)
211{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000212 assert(month >= 1);
213 assert(month <= 12);
214 if (month == 2 && is_leap(year))
215 return 29;
216 else
217 return _days_in_month[month];
Tim Peters2a799bf2002-12-16 20:18:38 +0000218}
219
220/* year, month -> number of days in year preceeding first day of month */
221static int
222days_before_month(int year, int month)
223{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000224 int days;
Tim Peters2a799bf2002-12-16 20:18:38 +0000225
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000226 assert(month >= 1);
227 assert(month <= 12);
228 days = _days_before_month[month];
229 if (month > 2 && is_leap(year))
230 ++days;
231 return days;
Tim Peters2a799bf2002-12-16 20:18:38 +0000232}
233
234/* year -> number of days before January 1st of year. Remember that we
235 * start with year 1, so days_before_year(1) == 0.
236 */
237static int
238days_before_year(int year)
239{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000240 int y = year - 1;
241 /* This is incorrect if year <= 0; we really want the floor
242 * here. But so long as MINYEAR is 1, the smallest year this
Alexander Belopolsky59a289d2010-10-13 22:54:34 +0000243 * can see is 1.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000244 */
Alexander Belopolsky59a289d2010-10-13 22:54:34 +0000245 assert (year >= 1);
246 return y*365 + y/4 - y/100 + y/400;
Tim Peters2a799bf2002-12-16 20:18:38 +0000247}
248
249/* Number of days in 4, 100, and 400 year cycles. That these have
250 * the correct values is asserted in the module init function.
251 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000252#define DI4Y 1461 /* days_before_year(5); days in 4 years */
253#define DI100Y 36524 /* days_before_year(101); days in 100 years */
254#define DI400Y 146097 /* days_before_year(401); days in 400 years */
Tim Peters2a799bf2002-12-16 20:18:38 +0000255
256/* ordinal -> year, month, day, considering 01-Jan-0001 as day 1. */
257static void
258ord_to_ymd(int ordinal, int *year, int *month, int *day)
259{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000260 int n, n1, n4, n100, n400, leapyear, preceding;
Tim Peters2a799bf2002-12-16 20:18:38 +0000261
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000262 /* ordinal is a 1-based index, starting at 1-Jan-1. The pattern of
263 * leap years repeats exactly every 400 years. The basic strategy is
264 * to find the closest 400-year boundary at or before ordinal, then
265 * work with the offset from that boundary to ordinal. Life is much
266 * clearer if we subtract 1 from ordinal first -- then the values
267 * of ordinal at 400-year boundaries are exactly those divisible
268 * by DI400Y:
269 *
270 * D M Y n n-1
271 * -- --- ---- ---------- ----------------
272 * 31 Dec -400 -DI400Y -DI400Y -1
273 * 1 Jan -399 -DI400Y +1 -DI400Y 400-year boundary
274 * ...
275 * 30 Dec 000 -1 -2
276 * 31 Dec 000 0 -1
277 * 1 Jan 001 1 0 400-year boundary
278 * 2 Jan 001 2 1
279 * 3 Jan 001 3 2
280 * ...
281 * 31 Dec 400 DI400Y DI400Y -1
282 * 1 Jan 401 DI400Y +1 DI400Y 400-year boundary
283 */
284 assert(ordinal >= 1);
285 --ordinal;
286 n400 = ordinal / DI400Y;
287 n = ordinal % DI400Y;
288 *year = n400 * 400 + 1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000290 /* Now n is the (non-negative) offset, in days, from January 1 of
291 * year, to the desired date. Now compute how many 100-year cycles
292 * precede n.
293 * Note that it's possible for n100 to equal 4! In that case 4 full
294 * 100-year cycles precede the desired day, which implies the
295 * desired day is December 31 at the end of a 400-year cycle.
296 */
297 n100 = n / DI100Y;
298 n = n % DI100Y;
Tim Peters2a799bf2002-12-16 20:18:38 +0000299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000300 /* Now compute how many 4-year cycles precede it. */
301 n4 = n / DI4Y;
302 n = n % DI4Y;
Tim Peters2a799bf2002-12-16 20:18:38 +0000303
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000304 /* And now how many single years. Again n1 can be 4, and again
305 * meaning that the desired day is December 31 at the end of the
306 * 4-year cycle.
307 */
308 n1 = n / 365;
309 n = n % 365;
Tim Peters2a799bf2002-12-16 20:18:38 +0000310
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000311 *year += n100 * 100 + n4 * 4 + n1;
312 if (n1 == 4 || n100 == 4) {
313 assert(n == 0);
314 *year -= 1;
315 *month = 12;
316 *day = 31;
317 return;
318 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000319
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000320 /* Now the year is correct, and n is the offset from January 1. We
321 * find the month via an estimate that's either exact or one too
322 * large.
323 */
324 leapyear = n1 == 3 && (n4 != 24 || n100 == 3);
325 assert(leapyear == is_leap(*year));
326 *month = (n + 50) >> 5;
327 preceding = (_days_before_month[*month] + (*month > 2 && leapyear));
328 if (preceding > n) {
329 /* estimate is too large */
330 *month -= 1;
331 preceding -= days_in_month(*year, *month);
332 }
333 n -= preceding;
334 assert(0 <= n);
335 assert(n < days_in_month(*year, *month));
Tim Peters2a799bf2002-12-16 20:18:38 +0000336
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000337 *day = n + 1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000338}
339
340/* year, month, day -> ordinal, considering 01-Jan-0001 as day 1. */
341static int
342ymd_to_ord(int year, int month, int day)
343{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000344 return days_before_year(year) + days_before_month(year, month) + day;
Tim Peters2a799bf2002-12-16 20:18:38 +0000345}
346
347/* Day of week, where Monday==0, ..., Sunday==6. 1/1/1 was a Monday. */
348static int
349weekday(int year, int month, int day)
350{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 return (ymd_to_ord(year, month, day) + 6) % 7;
Tim Peters2a799bf2002-12-16 20:18:38 +0000352}
353
354/* Ordinal of the Monday starting week 1 of the ISO year. Week 1 is the
355 * first calendar week containing a Thursday.
356 */
357static int
358iso_week1_monday(int year)
359{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000360 int first_day = ymd_to_ord(year, 1, 1); /* ord of 1/1 */
361 /* 0 if 1/1 is a Monday, 1 if a Tue, etc. */
362 int first_weekday = (first_day + 6) % 7;
363 /* ordinal of closest Monday at or before 1/1 */
364 int week1_monday = first_day - first_weekday;
Tim Peters2a799bf2002-12-16 20:18:38 +0000365
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 if (first_weekday > 3) /* if 1/1 was Fri, Sat, Sun */
367 week1_monday += 7;
368 return week1_monday;
Tim Peters2a799bf2002-12-16 20:18:38 +0000369}
370
371/* ---------------------------------------------------------------------------
372 * Range checkers.
373 */
374
375/* Check that -MAX_DELTA_DAYS <= days <= MAX_DELTA_DAYS. If so, return 0.
376 * If not, raise OverflowError and return -1.
377 */
378static int
379check_delta_day_range(int days)
380{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000381 if (-MAX_DELTA_DAYS <= days && days <= MAX_DELTA_DAYS)
382 return 0;
383 PyErr_Format(PyExc_OverflowError,
384 "days=%d; must have magnitude <= %d",
385 days, MAX_DELTA_DAYS);
386 return -1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000387}
388
389/* Check that date arguments are in range. Return 0 if they are. If they
390 * aren't, raise ValueError and return -1.
391 */
392static int
393check_date_args(int year, int month, int day)
394{
395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000396 if (year < MINYEAR || year > MAXYEAR) {
397 PyErr_SetString(PyExc_ValueError,
398 "year is out of range");
399 return -1;
400 }
401 if (month < 1 || month > 12) {
402 PyErr_SetString(PyExc_ValueError,
403 "month must be in 1..12");
404 return -1;
405 }
406 if (day < 1 || day > days_in_month(year, month)) {
407 PyErr_SetString(PyExc_ValueError,
408 "day is out of range for month");
409 return -1;
410 }
411 return 0;
Tim Peters2a799bf2002-12-16 20:18:38 +0000412}
413
414/* Check that time arguments are in range. Return 0 if they are. If they
415 * aren't, raise ValueError and return -1.
416 */
417static int
418check_time_args(int h, int m, int s, int us)
419{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 if (h < 0 || h > 23) {
421 PyErr_SetString(PyExc_ValueError,
422 "hour must be in 0..23");
423 return -1;
424 }
425 if (m < 0 || m > 59) {
426 PyErr_SetString(PyExc_ValueError,
427 "minute must be in 0..59");
428 return -1;
429 }
430 if (s < 0 || s > 59) {
431 PyErr_SetString(PyExc_ValueError,
432 "second must be in 0..59");
433 return -1;
434 }
435 if (us < 0 || us > 999999) {
436 PyErr_SetString(PyExc_ValueError,
437 "microsecond must be in 0..999999");
438 return -1;
439 }
440 return 0;
Tim Peters2a799bf2002-12-16 20:18:38 +0000441}
442
443/* ---------------------------------------------------------------------------
444 * Normalization utilities.
445 */
446
447/* One step of a mixed-radix conversion. A "hi" unit is equivalent to
448 * factor "lo" units. factor must be > 0. If *lo is less than 0, or
449 * at least factor, enough of *lo is converted into "hi" units so that
450 * 0 <= *lo < factor. The input values must be such that int overflow
451 * is impossible.
452 */
453static void
454normalize_pair(int *hi, int *lo, int factor)
455{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 assert(factor > 0);
457 assert(lo != hi);
458 if (*lo < 0 || *lo >= factor) {
459 const int num_hi = divmod(*lo, factor, lo);
460 const int new_hi = *hi + num_hi;
461 assert(! SIGNED_ADD_OVERFLOWED(new_hi, *hi, num_hi));
462 *hi = new_hi;
463 }
464 assert(0 <= *lo && *lo < factor);
Tim Peters2a799bf2002-12-16 20:18:38 +0000465}
466
467/* Fiddle days (d), seconds (s), and microseconds (us) so that
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000468 * 0 <= *s < 24*3600
469 * 0 <= *us < 1000000
Tim Peters2a799bf2002-12-16 20:18:38 +0000470 * The input values must be such that the internals don't overflow.
471 * The way this routine is used, we don't get close.
472 */
473static void
474normalize_d_s_us(int *d, int *s, int *us)
475{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 if (*us < 0 || *us >= 1000000) {
477 normalize_pair(s, us, 1000000);
478 /* |s| can't be bigger than about
479 * |original s| + |original us|/1000000 now.
480 */
Tim Peters2a799bf2002-12-16 20:18:38 +0000481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000482 }
483 if (*s < 0 || *s >= 24*3600) {
484 normalize_pair(d, s, 24*3600);
485 /* |d| can't be bigger than about
486 * |original d| +
487 * (|original s| + |original us|/1000000) / (24*3600) now.
488 */
489 }
490 assert(0 <= *s && *s < 24*3600);
491 assert(0 <= *us && *us < 1000000);
Tim Peters2a799bf2002-12-16 20:18:38 +0000492}
493
494/* Fiddle years (y), months (m), and days (d) so that
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 * 1 <= *m <= 12
496 * 1 <= *d <= days_in_month(*y, *m)
Tim Peters2a799bf2002-12-16 20:18:38 +0000497 * The input values must be such that the internals don't overflow.
498 * The way this routine is used, we don't get close.
499 */
Alexander Belopolskyf03a6162010-05-27 21:42:58 +0000500static int
Tim Peters2a799bf2002-12-16 20:18:38 +0000501normalize_y_m_d(int *y, int *m, int *d)
502{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000503 int dim; /* # of days in month */
Tim Peters2a799bf2002-12-16 20:18:38 +0000504
Alexander Belopolsky59a289d2010-10-13 22:54:34 +0000505 /* In actual use, m is always the month component extracted from a
506 * date/datetime object. Therefore it is always in [1, 12] range.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 */
Alexander Belopolsky59a289d2010-10-13 22:54:34 +0000508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000509 assert(1 <= *m && *m <= 12);
Tim Peters2a799bf2002-12-16 20:18:38 +0000510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 /* Now only day can be out of bounds (year may also be out of bounds
512 * for a datetime object, but we don't care about that here).
513 * If day is out of bounds, what to do is arguable, but at least the
514 * method here is principled and explainable.
515 */
516 dim = days_in_month(*y, *m);
517 if (*d < 1 || *d > dim) {
518 /* Move day-1 days from the first of the month. First try to
519 * get off cheap if we're only one day out of range
520 * (adjustments for timezone alone can't be worse than that).
521 */
522 if (*d == 0) {
523 --*m;
524 if (*m > 0)
525 *d = days_in_month(*y, *m);
526 else {
527 --*y;
528 *m = 12;
529 *d = 31;
530 }
531 }
532 else if (*d == dim + 1) {
533 /* move forward a day */
534 ++*m;
535 *d = 1;
536 if (*m > 12) {
537 *m = 1;
538 ++*y;
539 }
540 }
541 else {
542 int ordinal = ymd_to_ord(*y, *m, 1) +
543 *d - 1;
Alexander Belopolskyf03a6162010-05-27 21:42:58 +0000544 if (ordinal < 1 || ordinal > MAXORDINAL) {
545 goto error;
546 } else {
547 ord_to_ymd(ordinal, y, m, d);
548 return 0;
549 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000550 }
551 }
552 assert(*m > 0);
553 assert(*d > 0);
Alexander Belopolskyf03a6162010-05-27 21:42:58 +0000554 if (MINYEAR <= *y && *y <= MAXYEAR)
555 return 0;
556 error:
557 PyErr_SetString(PyExc_OverflowError,
558 "date value out of range");
559 return -1;
560
Tim Peters2a799bf2002-12-16 20:18:38 +0000561}
562
563/* Fiddle out-of-bounds months and days so that the result makes some kind
564 * of sense. The parameters are both inputs and outputs. Returns < 0 on
565 * failure, where failure means the adjusted year is out of bounds.
566 */
567static int
568normalize_date(int *year, int *month, int *day)
569{
Alexander Belopolskyf03a6162010-05-27 21:42:58 +0000570 return normalize_y_m_d(year, month, day);
Tim Peters2a799bf2002-12-16 20:18:38 +0000571}
572
573/* Force all the datetime fields into range. The parameters are both
574 * inputs and outputs. Returns < 0 on error.
575 */
576static int
577normalize_datetime(int *year, int *month, int *day,
578 int *hour, int *minute, int *second,
579 int *microsecond)
580{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000581 normalize_pair(second, microsecond, 1000000);
582 normalize_pair(minute, second, 60);
583 normalize_pair(hour, minute, 60);
584 normalize_pair(day, hour, 24);
585 return normalize_date(year, month, day);
Tim Peters2a799bf2002-12-16 20:18:38 +0000586}
587
588/* ---------------------------------------------------------------------------
Tim Petersb0c854d2003-05-17 15:57:00 +0000589 * Basic object allocation: tp_alloc implementations. These allocate
590 * Python objects of the right size and type, and do the Python object-
591 * initialization bit. If there's not enough memory, they return NULL after
592 * setting MemoryError. All data members remain uninitialized trash.
593 *
594 * We abuse the tp_alloc "nitems" argument to communicate whether a tzinfo
Tim Peters03eaf8b2003-05-18 02:24:46 +0000595 * member is needed. This is ugly, imprecise, and possibly insecure.
596 * tp_basicsize for the time and datetime types is set to the size of the
597 * struct that has room for the tzinfo member, so subclasses in Python will
598 * allocate enough space for a tzinfo member whether or not one is actually
599 * needed. That's the "ugly and imprecise" parts. The "possibly insecure"
600 * part is that PyType_GenericAlloc() (which subclasses in Python end up
601 * using) just happens today to effectively ignore the nitems argument
602 * when tp_itemsize is 0, which it is for these type objects. If that
603 * changes, perhaps the callers of tp_alloc slots in this file should
604 * be changed to force a 0 nitems argument unless the type being allocated
605 * is a base type implemented in this file (so that tp_alloc is time_alloc
606 * or datetime_alloc below, which know about the nitems abuse).
Tim Petersb0c854d2003-05-17 15:57:00 +0000607 */
608
609static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000610time_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000611{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000612 PyObject *self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000613
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000614 self = (PyObject *)
615 PyObject_MALLOC(aware ?
616 sizeof(PyDateTime_Time) :
617 sizeof(_PyDateTime_BaseTime));
618 if (self == NULL)
619 return (PyObject *)PyErr_NoMemory();
620 PyObject_INIT(self, type);
621 return self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000622}
623
624static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000625datetime_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000626{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 PyObject *self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000628
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000629 self = (PyObject *)
630 PyObject_MALLOC(aware ?
631 sizeof(PyDateTime_DateTime) :
632 sizeof(_PyDateTime_BaseDateTime));
633 if (self == NULL)
634 return (PyObject *)PyErr_NoMemory();
635 PyObject_INIT(self, type);
636 return self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000637}
638
639/* ---------------------------------------------------------------------------
640 * Helpers for setting object fields. These work on pointers to the
641 * appropriate base class.
642 */
643
644/* For date and datetime. */
645static void
646set_date_fields(PyDateTime_Date *self, int y, int m, int d)
647{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000648 self->hashcode = -1;
649 SET_YEAR(self, y);
650 SET_MONTH(self, m);
651 SET_DAY(self, d);
Tim Petersb0c854d2003-05-17 15:57:00 +0000652}
653
654/* ---------------------------------------------------------------------------
655 * Create various objects, mostly without range checking.
656 */
657
658/* Create a date instance with no range checking. */
659static PyObject *
660new_date_ex(int year, int month, int day, PyTypeObject *type)
661{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000662 PyDateTime_Date *self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000663
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000664 self = (PyDateTime_Date *) (type->tp_alloc(type, 0));
665 if (self != NULL)
666 set_date_fields(self, year, month, day);
667 return (PyObject *) self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000668}
669
670#define new_date(year, month, day) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000671 new_date_ex(year, month, day, &PyDateTime_DateType)
Tim Petersb0c854d2003-05-17 15:57:00 +0000672
673/* Create a datetime instance with no range checking. */
674static PyObject *
675new_datetime_ex(int year, int month, int day, int hour, int minute,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000676 int second, int usecond, PyObject *tzinfo, PyTypeObject *type)
Tim Petersb0c854d2003-05-17 15:57:00 +0000677{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000678 PyDateTime_DateTime *self;
679 char aware = tzinfo != Py_None;
Tim Petersb0c854d2003-05-17 15:57:00 +0000680
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000681 self = (PyDateTime_DateTime *) (type->tp_alloc(type, aware));
682 if (self != NULL) {
683 self->hastzinfo = aware;
684 set_date_fields((PyDateTime_Date *)self, year, month, day);
685 DATE_SET_HOUR(self, hour);
686 DATE_SET_MINUTE(self, minute);
687 DATE_SET_SECOND(self, second);
688 DATE_SET_MICROSECOND(self, usecond);
689 if (aware) {
690 Py_INCREF(tzinfo);
691 self->tzinfo = tzinfo;
692 }
693 }
694 return (PyObject *)self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000695}
696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697#define new_datetime(y, m, d, hh, mm, ss, us, tzinfo) \
698 new_datetime_ex(y, m, d, hh, mm, ss, us, tzinfo, \
699 &PyDateTime_DateTimeType)
Tim Petersb0c854d2003-05-17 15:57:00 +0000700
701/* Create a time instance with no range checking. */
702static PyObject *
703new_time_ex(int hour, int minute, int second, int usecond,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000704 PyObject *tzinfo, PyTypeObject *type)
Tim Petersb0c854d2003-05-17 15:57:00 +0000705{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000706 PyDateTime_Time *self;
707 char aware = tzinfo != Py_None;
Tim Petersb0c854d2003-05-17 15:57:00 +0000708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 self = (PyDateTime_Time *) (type->tp_alloc(type, aware));
710 if (self != NULL) {
711 self->hastzinfo = aware;
712 self->hashcode = -1;
713 TIME_SET_HOUR(self, hour);
714 TIME_SET_MINUTE(self, minute);
715 TIME_SET_SECOND(self, second);
716 TIME_SET_MICROSECOND(self, usecond);
717 if (aware) {
718 Py_INCREF(tzinfo);
719 self->tzinfo = tzinfo;
720 }
721 }
722 return (PyObject *)self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000723}
724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725#define new_time(hh, mm, ss, us, tzinfo) \
726 new_time_ex(hh, mm, ss, us, tzinfo, &PyDateTime_TimeType)
Tim Petersb0c854d2003-05-17 15:57:00 +0000727
728/* Create a timedelta instance. Normalize the members iff normalize is
729 * true. Passing false is a speed optimization, if you know for sure
730 * that seconds and microseconds are already in their proper ranges. In any
731 * case, raises OverflowError and returns NULL if the normalized days is out
732 * of range).
733 */
734static PyObject *
735new_delta_ex(int days, int seconds, int microseconds, int normalize,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 PyTypeObject *type)
Tim Petersb0c854d2003-05-17 15:57:00 +0000737{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000738 PyDateTime_Delta *self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 if (normalize)
741 normalize_d_s_us(&days, &seconds, &microseconds);
742 assert(0 <= seconds && seconds < 24*3600);
743 assert(0 <= microseconds && microseconds < 1000000);
Tim Petersb0c854d2003-05-17 15:57:00 +0000744
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000745 if (check_delta_day_range(days) < 0)
746 return NULL;
Tim Petersb0c854d2003-05-17 15:57:00 +0000747
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 self = (PyDateTime_Delta *) (type->tp_alloc(type, 0));
749 if (self != NULL) {
750 self->hashcode = -1;
751 SET_TD_DAYS(self, days);
752 SET_TD_SECONDS(self, seconds);
753 SET_TD_MICROSECONDS(self, microseconds);
754 }
755 return (PyObject *) self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000756}
757
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000758#define new_delta(d, s, us, normalize) \
759 new_delta_ex(d, s, us, normalize, &PyDateTime_DeltaType)
Tim Petersb0c854d2003-05-17 15:57:00 +0000760
Alexander Belopolsky4e749a12010-06-14 14:15:50 +0000761
762typedef struct
763{
764 PyObject_HEAD
765 PyObject *offset;
766 PyObject *name;
767} PyDateTime_TimeZone;
768
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +0000769/* The interned UTC timezone instance */
770static PyObject *PyDateTime_TimeZone_UTC;
Alexander Belopolskya11d8c02010-07-06 23:19:45 +0000771
Alexander Belopolsky4e749a12010-06-14 14:15:50 +0000772/* Create new timezone instance checking offset range. This
773 function does not check the name argument. Caller must assure
774 that offset is a timedelta instance and name is either NULL
775 or a unicode object. */
776static PyObject *
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +0000777create_timezone(PyObject *offset, PyObject *name)
Alexander Belopolsky4e749a12010-06-14 14:15:50 +0000778{
779 PyDateTime_TimeZone *self;
780 PyTypeObject *type = &PyDateTime_TimeZoneType;
781
782 assert(offset != NULL);
783 assert(PyDelta_Check(offset));
784 assert(name == NULL || PyUnicode_Check(name));
785
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +0000786 self = (PyDateTime_TimeZone *)(type->tp_alloc(type, 0));
787 if (self == NULL) {
788 return NULL;
789 }
790 Py_INCREF(offset);
791 self->offset = offset;
792 Py_XINCREF(name);
793 self->name = name;
794 return (PyObject *)self;
795}
796
797static int delta_bool(PyDateTime_Delta *self);
798
799static PyObject *
800new_timezone(PyObject *offset, PyObject *name)
801{
802 assert(offset != NULL);
803 assert(PyDelta_Check(offset));
804 assert(name == NULL || PyUnicode_Check(name));
805
806 if (name == NULL && delta_bool((PyDateTime_Delta *)offset) == 0) {
807 Py_INCREF(PyDateTime_TimeZone_UTC);
808 return PyDateTime_TimeZone_UTC;
809 }
Alexander Belopolsky4e749a12010-06-14 14:15:50 +0000810 if (GET_TD_MICROSECONDS(offset) != 0 || GET_TD_SECONDS(offset) % 60 != 0) {
811 PyErr_Format(PyExc_ValueError, "offset must be a timedelta"
812 " representing a whole number of minutes");
813 return NULL;
814 }
815 if ((GET_TD_DAYS(offset) == -1 && GET_TD_SECONDS(offset) == 0) ||
816 GET_TD_DAYS(offset) < -1 || GET_TD_DAYS(offset) >= 1) {
817 PyErr_Format(PyExc_ValueError, "offset must be a timedelta"
818 " strictly between -timedelta(hours=24) and"
819 " timedelta(hours=24).");
820 return NULL;
821 }
822
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +0000823 return create_timezone(offset, name);
Alexander Belopolsky4e749a12010-06-14 14:15:50 +0000824}
825
Tim Petersb0c854d2003-05-17 15:57:00 +0000826/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +0000827 * tzinfo helpers.
828 */
829
Tim Peters855fe882002-12-22 03:43:39 +0000830/* Ensure that p is None or of a tzinfo subclass. Return 0 if OK; if not
831 * raise TypeError and return -1.
832 */
833static int
834check_tzinfo_subclass(PyObject *p)
835{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000836 if (p == Py_None || PyTZInfo_Check(p))
837 return 0;
838 PyErr_Format(PyExc_TypeError,
839 "tzinfo argument must be None or of a tzinfo subclass, "
840 "not type '%s'",
841 Py_TYPE(p)->tp_name);
842 return -1;
Tim Peters855fe882002-12-22 03:43:39 +0000843}
844
Tim Peters2a799bf2002-12-16 20:18:38 +0000845/* If self has a tzinfo member, return a BORROWED reference to it. Else
846 * return NULL, which is NOT AN ERROR. There are no error returns here,
847 * and the caller must not decref the result.
848 */
849static PyObject *
850get_tzinfo_member(PyObject *self)
851{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 PyObject *tzinfo = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +0000853
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 if (PyDateTime_Check(self) && HASTZINFO(self))
855 tzinfo = ((PyDateTime_DateTime *)self)->tzinfo;
856 else if (PyTime_Check(self) && HASTZINFO(self))
857 tzinfo = ((PyDateTime_Time *)self)->tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000858
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 return tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000860}
861
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000862/* Call getattr(tzinfo, name)(tzinfoarg), and check the result. tzinfo must
863 * be an instance of the tzinfo class. If the method returns None, this
864 * returns None. If the method doesn't return None or timedelta, TypeError is
865 * raised and this returns NULL. If it returns a timedelta and the value is
866 * out of range or isn't a whole number of minutes, ValueError is raised and
867 * this returns NULL. Else result is returned.
Tim Peters2a799bf2002-12-16 20:18:38 +0000868 */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000869static PyObject *
870call_tzinfo_method(PyObject *tzinfo, char *name, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +0000871{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000872 PyObject *offset;
Tim Peters2a799bf2002-12-16 20:18:38 +0000873
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000874 assert(tzinfo != NULL);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000875 assert(PyTZInfo_Check(tzinfo) || tzinfo == Py_None);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000876 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000877
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000878 if (tzinfo == Py_None)
879 Py_RETURN_NONE;
880 offset = PyObject_CallMethod(tzinfo, name, "O", tzinfoarg);
881 if (offset == Py_None || offset == NULL)
882 return offset;
883 if (PyDelta_Check(offset)) {
884 if (GET_TD_MICROSECONDS(offset) != 0 || GET_TD_SECONDS(offset) % 60 != 0) {
885 Py_DECREF(offset);
886 PyErr_Format(PyExc_ValueError, "offset must be a timedelta"
887 " representing a whole number of minutes");
888 return NULL;
889 }
890 if ((GET_TD_DAYS(offset) == -1 && GET_TD_SECONDS(offset) == 0) ||
891 GET_TD_DAYS(offset) < -1 || GET_TD_DAYS(offset) >= 1) {
892 Py_DECREF(offset);
893 PyErr_Format(PyExc_ValueError, "offset must be a timedelta"
894 " strictly between -timedelta(hours=24) and"
895 " timedelta(hours=24).");
896 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000897 }
898 }
899 else {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000900 Py_DECREF(offset);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000901 PyErr_Format(PyExc_TypeError,
902 "tzinfo.%s() must return None or "
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000903 "timedelta, not '%.200s'",
904 name, Py_TYPE(offset)->tp_name);
905 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000906 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000907
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000908 return offset;
Tim Peters2a799bf2002-12-16 20:18:38 +0000909}
910
911/* Call tzinfo.utcoffset(tzinfoarg), and extract an integer from the
912 * result. tzinfo must be an instance of the tzinfo class. If utcoffset()
913 * returns None, call_utcoffset returns 0 and sets *none to 1. If uctoffset()
Tim Peters397301e2003-01-02 21:28:08 +0000914 * doesn't return None or timedelta, TypeError is raised and this returns -1.
915 * If utcoffset() returns an invalid timedelta (out of range, or not a whole
916 * # of minutes), ValueError is raised and this returns -1. Else *none is
917 * set to 0 and the offset is returned (as int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000918 */
Tim Peters855fe882002-12-22 03:43:39 +0000919static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000920call_utcoffset(PyObject *tzinfo, PyObject *tzinfoarg)
921{
922 return call_tzinfo_method(tzinfo, "utcoffset", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000923}
924
Tim Peters2a799bf2002-12-16 20:18:38 +0000925/* Call tzinfo.dst(tzinfoarg), and extract an integer from the
926 * result. tzinfo must be an instance of the tzinfo class. If dst()
927 * returns None, call_dst returns 0 and sets *none to 1. If dst()
Tim Peters397301e2003-01-02 21:28:08 +0000928 & doesn't return None or timedelta, TypeError is raised and this
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000929 * returns -1. If dst() returns an invalid timedelta for a UTC offset,
Tim Peters397301e2003-01-02 21:28:08 +0000930 * ValueError is raised and this returns -1. Else *none is set to 0 and
931 * the offset is returned (as an int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000932 */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000933static PyObject *
934call_dst(PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +0000935{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000936 return call_tzinfo_method(tzinfo, "dst", tzinfoarg);
Tim Peters2a799bf2002-12-16 20:18:38 +0000937}
938
Tim Petersbad8ff02002-12-30 20:52:32 +0000939/* Call tzinfo.tzname(tzinfoarg), and return the result. tzinfo must be
Tim Peters855fe882002-12-22 03:43:39 +0000940 * an instance of the tzinfo class or None. If tzinfo isn't None, and
Tim Petersbad8ff02002-12-30 20:52:32 +0000941 * tzname() doesn't return None or a string, TypeError is raised and this
Guido van Rossume3d1d412007-05-23 21:24:35 +0000942 * returns NULL. If the result is a string, we ensure it is a Unicode
943 * string.
Tim Peters2a799bf2002-12-16 20:18:38 +0000944 */
945static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000946call_tzname(PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +0000947{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000948 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +0000949
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 assert(tzinfo != NULL);
951 assert(check_tzinfo_subclass(tzinfo) >= 0);
952 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000953
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000954 if (tzinfo == Py_None)
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000955 Py_RETURN_NONE;
Tim Peters2a799bf2002-12-16 20:18:38 +0000956
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000957 result = PyObject_CallMethod(tzinfo, "tzname", "O", tzinfoarg);
958
959 if (result == NULL || result == Py_None)
960 return result;
961
962 if (!PyUnicode_Check(result)) {
963 PyErr_Format(PyExc_TypeError, "tzinfo.tzname() must "
964 "return None or a string, not '%s'",
965 Py_TYPE(result)->tp_name);
966 Py_DECREF(result);
967 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000969
970 return result;
Tim Peters00237032002-12-27 02:21:51 +0000971}
972
Tim Peters2a799bf2002-12-16 20:18:38 +0000973/* repr is like "someclass(arg1, arg2)". If tzinfo isn't None,
974 * stuff
975 * ", tzinfo=" + repr(tzinfo)
976 * before the closing ")".
977 */
978static PyObject *
979append_keyword_tzinfo(PyObject *repr, PyObject *tzinfo)
980{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 PyObject *temp;
Tim Peters2a799bf2002-12-16 20:18:38 +0000982
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 assert(PyUnicode_Check(repr));
984 assert(tzinfo);
985 if (tzinfo == Py_None)
986 return repr;
987 /* Get rid of the trailing ')'. */
988 assert(PyUnicode_AS_UNICODE(repr)[PyUnicode_GET_SIZE(repr)-1] == ')');
989 temp = PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(repr),
990 PyUnicode_GET_SIZE(repr) - 1);
991 Py_DECREF(repr);
992 if (temp == NULL)
993 return NULL;
994 repr = PyUnicode_FromFormat("%U, tzinfo=%R)", temp, tzinfo);
995 Py_DECREF(temp);
996 return repr;
Tim Peters2a799bf2002-12-16 20:18:38 +0000997}
998
999/* ---------------------------------------------------------------------------
1000 * String format helpers.
1001 */
1002
1003static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00001004format_ctime(PyDateTime_Date *date, int hours, int minutes, int seconds)
Tim Peters2a799bf2002-12-16 20:18:38 +00001005{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 static const char *DayNames[] = {
1007 "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"
1008 };
1009 static const char *MonthNames[] = {
1010 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1011 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
1012 };
Tim Peters2a799bf2002-12-16 20:18:38 +00001013
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 int wday = weekday(GET_YEAR(date), GET_MONTH(date), GET_DAY(date));
Tim Peters2a799bf2002-12-16 20:18:38 +00001015
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001016 return PyUnicode_FromFormat("%s %s %2d %02d:%02d:%02d %04d",
1017 DayNames[wday], MonthNames[GET_MONTH(date)-1],
1018 GET_DAY(date), hours, minutes, seconds,
1019 GET_YEAR(date));
Tim Peters2a799bf2002-12-16 20:18:38 +00001020}
1021
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001022static PyObject *delta_negative(PyDateTime_Delta *self);
1023
Tim Peters2a799bf2002-12-16 20:18:38 +00001024/* Add an hours & minutes UTC offset string to buf. buf has no more than
1025 * buflen bytes remaining. The UTC offset is gotten by calling
1026 * tzinfo.uctoffset(tzinfoarg). If that returns None, \0 is stored into
1027 * *buf, and that's all. Else the returned value is checked for sanity (an
1028 * integer in range), and if that's OK it's converted to an hours & minutes
1029 * string of the form
1030 * sign HH sep MM
1031 * Returns 0 if everything is OK. If the return value from utcoffset() is
1032 * bogus, an appropriate exception is set and -1 is returned.
1033 */
1034static int
Tim Peters328fff72002-12-20 01:31:27 +00001035format_utcoffset(char *buf, size_t buflen, const char *sep,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001037{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001038 PyObject *offset;
1039 int hours, minutes, seconds;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001040 char sign;
Tim Peters2a799bf2002-12-16 20:18:38 +00001041
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042 assert(buflen >= 1);
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +00001043
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001044 offset = call_utcoffset(tzinfo, tzinfoarg);
1045 if (offset == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 return -1;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001047 if (offset == Py_None) {
1048 Py_DECREF(offset);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001049 *buf = '\0';
1050 return 0;
1051 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001052 /* Offset is normalized, so it is negative if days < 0 */
1053 if (GET_TD_DAYS(offset) < 0) {
1054 PyObject *temp = offset;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 sign = '-';
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001056 offset = delta_negative((PyDateTime_Delta *)offset);
1057 Py_DECREF(temp);
1058 if (offset == NULL)
1059 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001060 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001061 else {
1062 sign = '+';
1063 }
1064 /* Offset is not negative here. */
1065 seconds = GET_TD_SECONDS(offset);
1066 Py_DECREF(offset);
1067 minutes = divmod(seconds, 60, &seconds);
1068 hours = divmod(minutes, 60, &minutes);
1069 assert(seconds == 0);
1070 /* XXX ignore sub-minute data, curently not allowed. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001071 PyOS_snprintf(buf, buflen, "%c%02d%s%02d", sign, hours, sep, minutes);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001072
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001073 return 0;
Tim Peters2a799bf2002-12-16 20:18:38 +00001074}
1075
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001076static PyObject *
1077make_Zreplacement(PyObject *object, PyObject *tzinfoarg)
1078{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001079 PyObject *temp;
1080 PyObject *tzinfo = get_tzinfo_member(object);
1081 PyObject *Zreplacement = PyUnicode_FromStringAndSize(NULL, 0);
1082 if (Zreplacement == NULL)
1083 return NULL;
1084 if (tzinfo == Py_None || tzinfo == NULL)
1085 return Zreplacement;
Neal Norwitzaea70e02007-08-12 04:32:26 +00001086
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001087 assert(tzinfoarg != NULL);
1088 temp = call_tzname(tzinfo, tzinfoarg);
1089 if (temp == NULL)
1090 goto Error;
1091 if (temp == Py_None) {
1092 Py_DECREF(temp);
1093 return Zreplacement;
1094 }
Neal Norwitzaea70e02007-08-12 04:32:26 +00001095
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 assert(PyUnicode_Check(temp));
1097 /* Since the tzname is getting stuffed into the
1098 * format, we have to double any % signs so that
1099 * strftime doesn't treat them as format codes.
1100 */
1101 Py_DECREF(Zreplacement);
1102 Zreplacement = PyObject_CallMethod(temp, "replace", "ss", "%", "%%");
1103 Py_DECREF(temp);
1104 if (Zreplacement == NULL)
1105 return NULL;
1106 if (!PyUnicode_Check(Zreplacement)) {
1107 PyErr_SetString(PyExc_TypeError,
1108 "tzname.replace() did not return a string");
1109 goto Error;
1110 }
1111 return Zreplacement;
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001112
1113 Error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 Py_DECREF(Zreplacement);
1115 return NULL;
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001116}
1117
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001118static PyObject *
1119make_freplacement(PyObject *object)
1120{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001121 char freplacement[64];
1122 if (PyTime_Check(object))
1123 sprintf(freplacement, "%06d", TIME_GET_MICROSECOND(object));
1124 else if (PyDateTime_Check(object))
1125 sprintf(freplacement, "%06d", DATE_GET_MICROSECOND(object));
1126 else
1127 sprintf(freplacement, "%06d", 0);
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001128
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001129 return PyBytes_FromStringAndSize(freplacement, strlen(freplacement));
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001130}
1131
Tim Peters2a799bf2002-12-16 20:18:38 +00001132/* I sure don't want to reproduce the strftime code from the time module,
1133 * so this imports the module and calls it. All the hair is due to
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001134 * giving special meanings to the %z, %Z and %f format codes via a
1135 * preprocessing step on the format string.
Tim Petersbad8ff02002-12-30 20:52:32 +00001136 * tzinfoarg is the argument to pass to the object's tzinfo method, if
1137 * needed.
Tim Peters2a799bf2002-12-16 20:18:38 +00001138 */
1139static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +00001140wrap_strftime(PyObject *object, PyObject *format, PyObject *timetuple,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001141 PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001142{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001143 PyObject *result = NULL; /* guilty until proved innocent */
Tim Peters2a799bf2002-12-16 20:18:38 +00001144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001145 PyObject *zreplacement = NULL; /* py string, replacement for %z */
1146 PyObject *Zreplacement = NULL; /* py string, replacement for %Z */
1147 PyObject *freplacement = NULL; /* py string, replacement for %f */
Tim Peters2a799bf2002-12-16 20:18:38 +00001148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 const char *pin; /* pointer to next char in input format */
1150 Py_ssize_t flen; /* length of input format */
1151 char ch; /* next char in input format */
Tim Peters2a799bf2002-12-16 20:18:38 +00001152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001153 PyObject *newfmt = NULL; /* py string, the output format */
1154 char *pnew; /* pointer to available byte in output format */
1155 size_t totalnew; /* number bytes total in output format buffer,
1156 exclusive of trailing \0 */
1157 size_t usednew; /* number bytes used so far in output format buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001158
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001159 const char *ptoappend; /* ptr to string to append to output buffer */
1160 Py_ssize_t ntoappend; /* # of bytes to append to output buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001162 assert(object && format && timetuple);
1163 assert(PyUnicode_Check(format));
1164 /* Convert the input format to a C string and size */
1165 pin = _PyUnicode_AsStringAndSize(format, &flen);
1166 if (!pin)
1167 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001168
Alexander Belopolskyb8bb4662011-01-08 00:13:34 +00001169 /* Give up if the year is before 1000.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001170 * Python strftime() plays games with the year, and different
1171 * games depending on whether envar PYTHON2K is set. This makes
Alexander Belopolskyb8bb4662011-01-08 00:13:34 +00001172 * years before 1000 a nightmare, even if the platform strftime
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 * supports them (and not all do).
1174 * We could get a lot farther here by avoiding Python's strftime
1175 * wrapper and calling the C strftime() directly, but that isn't
1176 * an option in the Python implementation of this module.
1177 */
1178 {
1179 long year;
1180 PyObject *pyyear = PySequence_GetItem(timetuple, 0);
1181 if (pyyear == NULL) return NULL;
1182 assert(PyLong_Check(pyyear));
1183 year = PyLong_AsLong(pyyear);
1184 Py_DECREF(pyyear);
Alexander Belopolskyb8bb4662011-01-08 00:13:34 +00001185 if (year < 1000) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001186 PyErr_Format(PyExc_ValueError, "year=%ld is before "
Alexander Belopolskyb8bb4662011-01-08 00:13:34 +00001187 "1000; the datetime strftime() "
1188 "methods require year >= 1000",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 year);
1190 return NULL;
1191 }
1192 }
Tim Petersd6844152002-12-22 20:58:42 +00001193
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001194 /* Scan the input format, looking for %z/%Z/%f escapes, building
1195 * a new format. Since computing the replacements for those codes
1196 * is expensive, don't unless they're actually used.
1197 */
1198 if (flen > INT_MAX - 1) {
1199 PyErr_NoMemory();
1200 goto Done;
1201 }
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +00001202
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001203 totalnew = flen + 1; /* realistic if no %z/%Z */
1204 newfmt = PyBytes_FromStringAndSize(NULL, totalnew);
1205 if (newfmt == NULL) goto Done;
1206 pnew = PyBytes_AsString(newfmt);
1207 usednew = 0;
Tim Peters2a799bf2002-12-16 20:18:38 +00001208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001209 while ((ch = *pin++) != '\0') {
1210 if (ch != '%') {
1211 ptoappend = pin - 1;
1212 ntoappend = 1;
1213 }
1214 else if ((ch = *pin++) == '\0') {
1215 /* There's a lone trailing %; doesn't make sense. */
1216 PyErr_SetString(PyExc_ValueError, "strftime format "
1217 "ends with raw %");
1218 goto Done;
1219 }
1220 /* A % has been seen and ch is the character after it. */
1221 else if (ch == 'z') {
1222 if (zreplacement == NULL) {
1223 /* format utcoffset */
1224 char buf[100];
1225 PyObject *tzinfo = get_tzinfo_member(object);
1226 zreplacement = PyBytes_FromStringAndSize("", 0);
1227 if (zreplacement == NULL) goto Done;
1228 if (tzinfo != Py_None && tzinfo != NULL) {
1229 assert(tzinfoarg != NULL);
1230 if (format_utcoffset(buf,
1231 sizeof(buf),
1232 "",
1233 tzinfo,
1234 tzinfoarg) < 0)
1235 goto Done;
1236 Py_DECREF(zreplacement);
1237 zreplacement =
1238 PyBytes_FromStringAndSize(buf,
1239 strlen(buf));
1240 if (zreplacement == NULL)
1241 goto Done;
1242 }
1243 }
1244 assert(zreplacement != NULL);
1245 ptoappend = PyBytes_AS_STRING(zreplacement);
1246 ntoappend = PyBytes_GET_SIZE(zreplacement);
1247 }
1248 else if (ch == 'Z') {
1249 /* format tzname */
1250 if (Zreplacement == NULL) {
1251 Zreplacement = make_Zreplacement(object,
1252 tzinfoarg);
1253 if (Zreplacement == NULL)
1254 goto Done;
1255 }
1256 assert(Zreplacement != NULL);
1257 assert(PyUnicode_Check(Zreplacement));
1258 ptoappend = _PyUnicode_AsStringAndSize(Zreplacement,
1259 &ntoappend);
Alexander Belopolskye239d232010-12-08 23:31:48 +00001260 if (ptoappend == NULL)
1261 goto Done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001262 }
1263 else if (ch == 'f') {
1264 /* format microseconds */
1265 if (freplacement == NULL) {
1266 freplacement = make_freplacement(object);
1267 if (freplacement == NULL)
1268 goto Done;
1269 }
1270 assert(freplacement != NULL);
1271 assert(PyBytes_Check(freplacement));
1272 ptoappend = PyBytes_AS_STRING(freplacement);
1273 ntoappend = PyBytes_GET_SIZE(freplacement);
1274 }
1275 else {
1276 /* percent followed by neither z nor Z */
1277 ptoappend = pin - 2;
1278 ntoappend = 2;
1279 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001280
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001281 /* Append the ntoappend chars starting at ptoappend to
1282 * the new format.
1283 */
1284 if (ntoappend == 0)
1285 continue;
1286 assert(ptoappend != NULL);
1287 assert(ntoappend > 0);
1288 while (usednew + ntoappend > totalnew) {
1289 size_t bigger = totalnew << 1;
1290 if ((bigger >> 1) != totalnew) { /* overflow */
1291 PyErr_NoMemory();
1292 goto Done;
1293 }
1294 if (_PyBytes_Resize(&newfmt, bigger) < 0)
1295 goto Done;
1296 totalnew = bigger;
1297 pnew = PyBytes_AsString(newfmt) + usednew;
1298 }
1299 memcpy(pnew, ptoappend, ntoappend);
1300 pnew += ntoappend;
1301 usednew += ntoappend;
1302 assert(usednew <= totalnew);
1303 } /* end while() */
Tim Peters2a799bf2002-12-16 20:18:38 +00001304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 if (_PyBytes_Resize(&newfmt, usednew) < 0)
1306 goto Done;
1307 {
1308 PyObject *format;
1309 PyObject *time = PyImport_ImportModuleNoBlock("time");
1310 if (time == NULL)
1311 goto Done;
1312 format = PyUnicode_FromString(PyBytes_AS_STRING(newfmt));
1313 if (format != NULL) {
1314 result = PyObject_CallMethod(time, "strftime", "OO",
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001315 format, timetuple, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 Py_DECREF(format);
1317 }
1318 Py_DECREF(time);
1319 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001320 Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001321 Py_XDECREF(freplacement);
1322 Py_XDECREF(zreplacement);
1323 Py_XDECREF(Zreplacement);
1324 Py_XDECREF(newfmt);
1325 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001326}
1327
Tim Peters2a799bf2002-12-16 20:18:38 +00001328/* ---------------------------------------------------------------------------
1329 * Wrap functions from the time module. These aren't directly available
1330 * from C. Perhaps they should be.
1331 */
1332
1333/* Call time.time() and return its result (a Python float). */
1334static PyObject *
Guido van Rossumbd43e912002-12-16 20:34:55 +00001335time_time(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00001336{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 PyObject *result = NULL;
1338 PyObject *time = PyImport_ImportModuleNoBlock("time");
Tim Peters2a799bf2002-12-16 20:18:38 +00001339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001340 if (time != NULL) {
1341 result = PyObject_CallMethod(time, "time", "()");
1342 Py_DECREF(time);
1343 }
1344 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001345}
1346
1347/* Build a time.struct_time. The weekday and day number are automatically
1348 * computed from the y,m,d args.
1349 */
1350static PyObject *
1351build_struct_time(int y, int m, int d, int hh, int mm, int ss, int dstflag)
1352{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 PyObject *time;
1354 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001355
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001356 time = PyImport_ImportModuleNoBlock("time");
1357 if (time != NULL) {
1358 result = PyObject_CallMethod(time, "struct_time",
1359 "((iiiiiiiii))",
1360 y, m, d,
1361 hh, mm, ss,
1362 weekday(y, m, d),
1363 days_before_month(y, m) + d,
1364 dstflag);
1365 Py_DECREF(time);
1366 }
1367 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001368}
1369
1370/* ---------------------------------------------------------------------------
1371 * Miscellaneous helpers.
1372 */
1373
Mark Dickinsone94c6792009-02-02 20:36:42 +00001374/* For various reasons, we need to use tp_richcompare instead of tp_reserved.
Tim Peters2a799bf2002-12-16 20:18:38 +00001375 * The comparisons here all most naturally compute a cmp()-like result.
1376 * This little helper turns that into a bool result for rich comparisons.
1377 */
1378static PyObject *
1379diff_to_bool(int diff, int op)
1380{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 PyObject *result;
1382 int istrue;
Tim Peters2a799bf2002-12-16 20:18:38 +00001383
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001384 switch (op) {
1385 case Py_EQ: istrue = diff == 0; break;
1386 case Py_NE: istrue = diff != 0; break;
1387 case Py_LE: istrue = diff <= 0; break;
1388 case Py_GE: istrue = diff >= 0; break;
1389 case Py_LT: istrue = diff < 0; break;
1390 case Py_GT: istrue = diff > 0; break;
1391 default:
1392 assert(! "op unknown");
1393 istrue = 0; /* To shut up compiler */
1394 }
1395 result = istrue ? Py_True : Py_False;
1396 Py_INCREF(result);
1397 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001398}
1399
Tim Peters07534a62003-02-07 22:50:28 +00001400/* Raises a "can't compare" TypeError and returns NULL. */
1401static PyObject *
1402cmperror(PyObject *a, PyObject *b)
1403{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 PyErr_Format(PyExc_TypeError,
1405 "can't compare %s to %s",
1406 Py_TYPE(a)->tp_name, Py_TYPE(b)->tp_name);
1407 return NULL;
Tim Peters07534a62003-02-07 22:50:28 +00001408}
1409
Tim Peters2a799bf2002-12-16 20:18:38 +00001410/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +00001411 * Cached Python objects; these are set by the module init function.
1412 */
1413
1414/* Conversion factors. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415static PyObject *us_per_us = NULL; /* 1 */
1416static PyObject *us_per_ms = NULL; /* 1000 */
1417static PyObject *us_per_second = NULL; /* 1000000 */
1418static PyObject *us_per_minute = NULL; /* 1e6 * 60 as Python int */
1419static PyObject *us_per_hour = NULL; /* 1e6 * 3600 as Python long */
1420static PyObject *us_per_day = NULL; /* 1e6 * 3600 * 24 as Python long */
1421static PyObject *us_per_week = NULL; /* 1e6*3600*24*7 as Python long */
Tim Peters2a799bf2002-12-16 20:18:38 +00001422static PyObject *seconds_per_day = NULL; /* 3600*24 as Python int */
1423
Tim Peters2a799bf2002-12-16 20:18:38 +00001424/* ---------------------------------------------------------------------------
1425 * Class implementations.
1426 */
1427
1428/*
1429 * PyDateTime_Delta implementation.
1430 */
1431
1432/* Convert a timedelta to a number of us,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 * (24*3600*self.days + self.seconds)*1000000 + self.microseconds
Tim Peters2a799bf2002-12-16 20:18:38 +00001434 * as a Python int or long.
1435 * Doing mixed-radix arithmetic by hand instead is excruciating in C,
1436 * due to ubiquitous overflow possibilities.
1437 */
1438static PyObject *
1439delta_to_microseconds(PyDateTime_Delta *self)
1440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 PyObject *x1 = NULL;
1442 PyObject *x2 = NULL;
1443 PyObject *x3 = NULL;
1444 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001446 x1 = PyLong_FromLong(GET_TD_DAYS(self));
1447 if (x1 == NULL)
1448 goto Done;
1449 x2 = PyNumber_Multiply(x1, seconds_per_day); /* days in seconds */
1450 if (x2 == NULL)
1451 goto Done;
1452 Py_DECREF(x1);
1453 x1 = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001454
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 /* x2 has days in seconds */
1456 x1 = PyLong_FromLong(GET_TD_SECONDS(self)); /* seconds */
1457 if (x1 == NULL)
1458 goto Done;
1459 x3 = PyNumber_Add(x1, x2); /* days and seconds in seconds */
1460 if (x3 == NULL)
1461 goto Done;
1462 Py_DECREF(x1);
1463 Py_DECREF(x2);
1464 x1 = x2 = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 /* x3 has days+seconds in seconds */
1467 x1 = PyNumber_Multiply(x3, us_per_second); /* us */
1468 if (x1 == NULL)
1469 goto Done;
1470 Py_DECREF(x3);
1471 x3 = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001472
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001473 /* x1 has days+seconds in us */
1474 x2 = PyLong_FromLong(GET_TD_MICROSECONDS(self));
1475 if (x2 == NULL)
1476 goto Done;
1477 result = PyNumber_Add(x1, x2);
Tim Peters2a799bf2002-12-16 20:18:38 +00001478
1479Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 Py_XDECREF(x1);
1481 Py_XDECREF(x2);
1482 Py_XDECREF(x3);
1483 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001484}
1485
1486/* Convert a number of us (as a Python int or long) to a timedelta.
1487 */
1488static PyObject *
Tim Petersb0c854d2003-05-17 15:57:00 +00001489microseconds_to_delta_ex(PyObject *pyus, PyTypeObject *type)
Tim Peters2a799bf2002-12-16 20:18:38 +00001490{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 int us;
1492 int s;
1493 int d;
1494 long temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 PyObject *tuple = NULL;
1497 PyObject *num = NULL;
1498 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 tuple = PyNumber_Divmod(pyus, us_per_second);
1501 if (tuple == NULL)
1502 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00001503
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 num = PyTuple_GetItem(tuple, 1); /* us */
1505 if (num == NULL)
1506 goto Done;
1507 temp = PyLong_AsLong(num);
1508 num = NULL;
1509 if (temp == -1 && PyErr_Occurred())
1510 goto Done;
1511 assert(0 <= temp && temp < 1000000);
1512 us = (int)temp;
1513 if (us < 0) {
1514 /* The divisor was positive, so this must be an error. */
1515 assert(PyErr_Occurred());
1516 goto Done;
1517 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 num = PyTuple_GetItem(tuple, 0); /* leftover seconds */
1520 if (num == NULL)
1521 goto Done;
1522 Py_INCREF(num);
1523 Py_DECREF(tuple);
Tim Peters2a799bf2002-12-16 20:18:38 +00001524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 tuple = PyNumber_Divmod(num, seconds_per_day);
1526 if (tuple == NULL)
1527 goto Done;
1528 Py_DECREF(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001530 num = PyTuple_GetItem(tuple, 1); /* seconds */
1531 if (num == NULL)
1532 goto Done;
1533 temp = PyLong_AsLong(num);
1534 num = NULL;
1535 if (temp == -1 && PyErr_Occurred())
1536 goto Done;
1537 assert(0 <= temp && temp < 24*3600);
1538 s = (int)temp;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 if (s < 0) {
1541 /* The divisor was positive, so this must be an error. */
1542 assert(PyErr_Occurred());
1543 goto Done;
1544 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001546 num = PyTuple_GetItem(tuple, 0); /* leftover days */
1547 if (num == NULL)
1548 goto Done;
1549 Py_INCREF(num);
1550 temp = PyLong_AsLong(num);
1551 if (temp == -1 && PyErr_Occurred())
1552 goto Done;
1553 d = (int)temp;
1554 if ((long)d != temp) {
1555 PyErr_SetString(PyExc_OverflowError, "normalized days too "
1556 "large to fit in a C int");
1557 goto Done;
1558 }
1559 result = new_delta_ex(d, s, us, 0, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001560
1561Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 Py_XDECREF(tuple);
1563 Py_XDECREF(num);
1564 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001565}
1566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567#define microseconds_to_delta(pymicros) \
1568 microseconds_to_delta_ex(pymicros, &PyDateTime_DeltaType)
Tim Petersb0c854d2003-05-17 15:57:00 +00001569
Tim Peters2a799bf2002-12-16 20:18:38 +00001570static PyObject *
1571multiply_int_timedelta(PyObject *intobj, PyDateTime_Delta *delta)
1572{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001573 PyObject *pyus_in;
1574 PyObject *pyus_out;
1575 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001577 pyus_in = delta_to_microseconds(delta);
1578 if (pyus_in == NULL)
1579 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001580
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 pyus_out = PyNumber_Multiply(pyus_in, intobj);
1582 Py_DECREF(pyus_in);
1583 if (pyus_out == NULL)
1584 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 result = microseconds_to_delta(pyus_out);
1587 Py_DECREF(pyus_out);
1588 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001589}
1590
1591static PyObject *
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00001592multiply_float_timedelta(PyObject *floatobj, PyDateTime_Delta *delta)
1593{
1594 PyObject *result = NULL;
1595 PyObject *pyus_in = NULL, *temp, *pyus_out;
1596 PyObject *ratio = NULL;
1597
1598 pyus_in = delta_to_microseconds(delta);
1599 if (pyus_in == NULL)
1600 return NULL;
1601 ratio = PyObject_CallMethod(floatobj, "as_integer_ratio", NULL);
1602 if (ratio == NULL)
1603 goto error;
1604 temp = PyNumber_Multiply(pyus_in, PyTuple_GET_ITEM(ratio, 0));
1605 Py_DECREF(pyus_in);
1606 pyus_in = NULL;
1607 if (temp == NULL)
1608 goto error;
1609 pyus_out = divide_nearest(temp, PyTuple_GET_ITEM(ratio, 1));
1610 Py_DECREF(temp);
1611 if (pyus_out == NULL)
1612 goto error;
1613 result = microseconds_to_delta(pyus_out);
1614 Py_DECREF(pyus_out);
1615 error:
1616 Py_XDECREF(pyus_in);
1617 Py_XDECREF(ratio);
1618
1619 return result;
1620}
1621
1622static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00001623divide_timedelta_int(PyDateTime_Delta *delta, PyObject *intobj)
1624{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001625 PyObject *pyus_in;
1626 PyObject *pyus_out;
1627 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001628
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 pyus_in = delta_to_microseconds(delta);
1630 if (pyus_in == NULL)
1631 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 pyus_out = PyNumber_FloorDivide(pyus_in, intobj);
1634 Py_DECREF(pyus_in);
1635 if (pyus_out == NULL)
1636 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001638 result = microseconds_to_delta(pyus_out);
1639 Py_DECREF(pyus_out);
1640 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001641}
1642
1643static PyObject *
Mark Dickinson7c186e22010-04-20 22:32:49 +00001644divide_timedelta_timedelta(PyDateTime_Delta *left, PyDateTime_Delta *right)
1645{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 PyObject *pyus_left;
1647 PyObject *pyus_right;
1648 PyObject *result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001649
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 pyus_left = delta_to_microseconds(left);
1651 if (pyus_left == NULL)
1652 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001654 pyus_right = delta_to_microseconds(right);
1655 if (pyus_right == NULL) {
1656 Py_DECREF(pyus_left);
1657 return NULL;
1658 }
Mark Dickinson7c186e22010-04-20 22:32:49 +00001659
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001660 result = PyNumber_FloorDivide(pyus_left, pyus_right);
1661 Py_DECREF(pyus_left);
1662 Py_DECREF(pyus_right);
1663 return result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001664}
1665
1666static PyObject *
1667truedivide_timedelta_timedelta(PyDateTime_Delta *left, PyDateTime_Delta *right)
1668{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 PyObject *pyus_left;
1670 PyObject *pyus_right;
1671 PyObject *result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001672
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 pyus_left = delta_to_microseconds(left);
1674 if (pyus_left == NULL)
1675 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 pyus_right = delta_to_microseconds(right);
1678 if (pyus_right == NULL) {
1679 Py_DECREF(pyus_left);
1680 return NULL;
1681 }
Mark Dickinson7c186e22010-04-20 22:32:49 +00001682
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001683 result = PyNumber_TrueDivide(pyus_left, pyus_right);
1684 Py_DECREF(pyus_left);
1685 Py_DECREF(pyus_right);
1686 return result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001687}
1688
1689static PyObject *
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00001690truedivide_timedelta_float(PyDateTime_Delta *delta, PyObject *f)
1691{
1692 PyObject *result = NULL;
1693 PyObject *pyus_in = NULL, *temp, *pyus_out;
1694 PyObject *ratio = NULL;
1695
1696 pyus_in = delta_to_microseconds(delta);
1697 if (pyus_in == NULL)
1698 return NULL;
1699 ratio = PyObject_CallMethod(f, "as_integer_ratio", NULL);
1700 if (ratio == NULL)
1701 goto error;
1702 temp = PyNumber_Multiply(pyus_in, PyTuple_GET_ITEM(ratio, 1));
1703 Py_DECREF(pyus_in);
1704 pyus_in = NULL;
1705 if (temp == NULL)
1706 goto error;
1707 pyus_out = divide_nearest(temp, PyTuple_GET_ITEM(ratio, 0));
1708 Py_DECREF(temp);
1709 if (pyus_out == NULL)
1710 goto error;
1711 result = microseconds_to_delta(pyus_out);
1712 Py_DECREF(pyus_out);
1713 error:
1714 Py_XDECREF(pyus_in);
1715 Py_XDECREF(ratio);
1716
1717 return result;
1718}
1719
1720static PyObject *
1721truedivide_timedelta_int(PyDateTime_Delta *delta, PyObject *i)
1722{
1723 PyObject *result;
1724 PyObject *pyus_in, *pyus_out;
1725 pyus_in = delta_to_microseconds(delta);
1726 if (pyus_in == NULL)
1727 return NULL;
1728 pyus_out = divide_nearest(pyus_in, i);
1729 Py_DECREF(pyus_in);
1730 if (pyus_out == NULL)
1731 return NULL;
1732 result = microseconds_to_delta(pyus_out);
1733 Py_DECREF(pyus_out);
1734
1735 return result;
1736}
1737
1738static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00001739delta_add(PyObject *left, PyObject *right)
1740{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001741 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00001742
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001743 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1744 /* delta + delta */
1745 /* The C-level additions can't overflow because of the
1746 * invariant bounds.
1747 */
1748 int days = GET_TD_DAYS(left) + GET_TD_DAYS(right);
1749 int seconds = GET_TD_SECONDS(left) + GET_TD_SECONDS(right);
1750 int microseconds = GET_TD_MICROSECONDS(left) +
1751 GET_TD_MICROSECONDS(right);
1752 result = new_delta(days, seconds, microseconds, 1);
1753 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 if (result == Py_NotImplemented)
1756 Py_INCREF(result);
1757 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001758}
1759
1760static PyObject *
1761delta_negative(PyDateTime_Delta *self)
1762{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001763 return new_delta(-GET_TD_DAYS(self),
1764 -GET_TD_SECONDS(self),
1765 -GET_TD_MICROSECONDS(self),
1766 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00001767}
1768
1769static PyObject *
1770delta_positive(PyDateTime_Delta *self)
1771{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001772 /* Could optimize this (by returning self) if this isn't a
1773 * subclass -- but who uses unary + ? Approximately nobody.
1774 */
1775 return new_delta(GET_TD_DAYS(self),
1776 GET_TD_SECONDS(self),
1777 GET_TD_MICROSECONDS(self),
1778 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00001779}
1780
1781static PyObject *
1782delta_abs(PyDateTime_Delta *self)
1783{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001784 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001785
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001786 assert(GET_TD_MICROSECONDS(self) >= 0);
1787 assert(GET_TD_SECONDS(self) >= 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00001788
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001789 if (GET_TD_DAYS(self) < 0)
1790 result = delta_negative(self);
1791 else
1792 result = delta_positive(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00001793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001795}
1796
1797static PyObject *
1798delta_subtract(PyObject *left, PyObject *right)
1799{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00001801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1803 /* delta - delta */
Alexander Belopolskyb6f5ec72011-04-05 20:07:38 -04001804 /* The C-level additions can't overflow because of the
1805 * invariant bounds.
1806 */
1807 int days = GET_TD_DAYS(left) - GET_TD_DAYS(right);
1808 int seconds = GET_TD_SECONDS(left) - GET_TD_SECONDS(right);
1809 int microseconds = GET_TD_MICROSECONDS(left) -
1810 GET_TD_MICROSECONDS(right);
1811 result = new_delta(days, seconds, microseconds, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001812 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001813
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001814 if (result == Py_NotImplemented)
1815 Py_INCREF(result);
1816 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001817}
1818
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001819static int
1820delta_cmp(PyObject *self, PyObject *other)
1821{
1822 int diff = GET_TD_DAYS(self) - GET_TD_DAYS(other);
1823 if (diff == 0) {
1824 diff = GET_TD_SECONDS(self) - GET_TD_SECONDS(other);
1825 if (diff == 0)
1826 diff = GET_TD_MICROSECONDS(self) -
1827 GET_TD_MICROSECONDS(other);
1828 }
1829 return diff;
1830}
1831
Tim Peters2a799bf2002-12-16 20:18:38 +00001832static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00001833delta_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters2a799bf2002-12-16 20:18:38 +00001834{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001835 if (PyDelta_Check(other)) {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001836 int diff = delta_cmp(self, other);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001837 return diff_to_bool(diff, op);
1838 }
1839 else {
1840 Py_INCREF(Py_NotImplemented);
1841 return Py_NotImplemented;
1842 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001843}
1844
1845static PyObject *delta_getstate(PyDateTime_Delta *self);
1846
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001847static Py_hash_t
Tim Peters2a799bf2002-12-16 20:18:38 +00001848delta_hash(PyDateTime_Delta *self)
1849{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001850 if (self->hashcode == -1) {
1851 PyObject *temp = delta_getstate(self);
1852 if (temp != NULL) {
1853 self->hashcode = PyObject_Hash(temp);
1854 Py_DECREF(temp);
1855 }
1856 }
1857 return self->hashcode;
Tim Peters2a799bf2002-12-16 20:18:38 +00001858}
1859
1860static PyObject *
1861delta_multiply(PyObject *left, PyObject *right)
1862{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001863 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00001864
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001865 if (PyDelta_Check(left)) {
1866 /* delta * ??? */
1867 if (PyLong_Check(right))
1868 result = multiply_int_timedelta(right,
1869 (PyDateTime_Delta *) left);
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00001870 else if (PyFloat_Check(right))
1871 result = multiply_float_timedelta(right,
1872 (PyDateTime_Delta *) left);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001873 }
1874 else if (PyLong_Check(left))
1875 result = multiply_int_timedelta(left,
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00001876 (PyDateTime_Delta *) right);
1877 else if (PyFloat_Check(left))
1878 result = multiply_float_timedelta(left,
1879 (PyDateTime_Delta *) right);
Tim Peters2a799bf2002-12-16 20:18:38 +00001880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001881 if (result == Py_NotImplemented)
1882 Py_INCREF(result);
1883 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001884}
1885
1886static PyObject *
1887delta_divide(PyObject *left, PyObject *right)
1888{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001889 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00001890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001891 if (PyDelta_Check(left)) {
1892 /* delta * ??? */
1893 if (PyLong_Check(right))
1894 result = divide_timedelta_int(
1895 (PyDateTime_Delta *)left,
1896 right);
1897 else if (PyDelta_Check(right))
1898 result = divide_timedelta_timedelta(
1899 (PyDateTime_Delta *)left,
1900 (PyDateTime_Delta *)right);
1901 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001902
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001903 if (result == Py_NotImplemented)
1904 Py_INCREF(result);
1905 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001906}
1907
Mark Dickinson7c186e22010-04-20 22:32:49 +00001908static PyObject *
1909delta_truedivide(PyObject *left, PyObject *right)
1910{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001911 PyObject *result = Py_NotImplemented;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001912
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001913 if (PyDelta_Check(left)) {
1914 if (PyDelta_Check(right))
1915 result = truedivide_timedelta_timedelta(
1916 (PyDateTime_Delta *)left,
1917 (PyDateTime_Delta *)right);
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00001918 else if (PyFloat_Check(right))
1919 result = truedivide_timedelta_float(
1920 (PyDateTime_Delta *)left, right);
1921 else if (PyLong_Check(right))
1922 result = truedivide_timedelta_int(
1923 (PyDateTime_Delta *)left, right);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001924 }
Mark Dickinson7c186e22010-04-20 22:32:49 +00001925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 if (result == Py_NotImplemented)
1927 Py_INCREF(result);
1928 return result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001929}
1930
1931static PyObject *
1932delta_remainder(PyObject *left, PyObject *right)
1933{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001934 PyObject *pyus_left;
1935 PyObject *pyus_right;
1936 PyObject *pyus_remainder;
1937 PyObject *remainder;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001938
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001939 if (!PyDelta_Check(left) || !PyDelta_Check(right)) {
1940 Py_INCREF(Py_NotImplemented);
1941 return Py_NotImplemented;
1942 }
Mark Dickinson7c186e22010-04-20 22:32:49 +00001943
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001944 pyus_left = delta_to_microseconds((PyDateTime_Delta *)left);
1945 if (pyus_left == NULL)
1946 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001947
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001948 pyus_right = delta_to_microseconds((PyDateTime_Delta *)right);
1949 if (pyus_right == NULL) {
1950 Py_DECREF(pyus_left);
1951 return NULL;
1952 }
Mark Dickinson7c186e22010-04-20 22:32:49 +00001953
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001954 pyus_remainder = PyNumber_Remainder(pyus_left, pyus_right);
1955 Py_DECREF(pyus_left);
1956 Py_DECREF(pyus_right);
1957 if (pyus_remainder == NULL)
1958 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001959
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001960 remainder = microseconds_to_delta(pyus_remainder);
1961 Py_DECREF(pyus_remainder);
1962 if (remainder == NULL)
1963 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001964
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001965 return remainder;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001966}
1967
1968static PyObject *
1969delta_divmod(PyObject *left, PyObject *right)
1970{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001971 PyObject *pyus_left;
1972 PyObject *pyus_right;
1973 PyObject *divmod;
1974 PyObject *delta;
1975 PyObject *result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001976
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001977 if (!PyDelta_Check(left) || !PyDelta_Check(right)) {
1978 Py_INCREF(Py_NotImplemented);
1979 return Py_NotImplemented;
1980 }
Mark Dickinson7c186e22010-04-20 22:32:49 +00001981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001982 pyus_left = delta_to_microseconds((PyDateTime_Delta *)left);
1983 if (pyus_left == NULL)
1984 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001985
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001986 pyus_right = delta_to_microseconds((PyDateTime_Delta *)right);
1987 if (pyus_right == NULL) {
1988 Py_DECREF(pyus_left);
1989 return NULL;
1990 }
Mark Dickinson7c186e22010-04-20 22:32:49 +00001991
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001992 divmod = PyNumber_Divmod(pyus_left, pyus_right);
1993 Py_DECREF(pyus_left);
1994 Py_DECREF(pyus_right);
1995 if (divmod == NULL)
1996 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001997
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001998 assert(PyTuple_Size(divmod) == 2);
1999 delta = microseconds_to_delta(PyTuple_GET_ITEM(divmod, 1));
2000 if (delta == NULL) {
2001 Py_DECREF(divmod);
2002 return NULL;
2003 }
2004 result = PyTuple_Pack(2, PyTuple_GET_ITEM(divmod, 0), delta);
2005 Py_DECREF(delta);
2006 Py_DECREF(divmod);
2007 return result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002008}
2009
Tim Peters2a799bf2002-12-16 20:18:38 +00002010/* Fold in the value of the tag ("seconds", "weeks", etc) component of a
2011 * timedelta constructor. sofar is the # of microseconds accounted for
2012 * so far, and there are factor microseconds per current unit, the number
2013 * of which is given by num. num * factor is added to sofar in a
2014 * numerically careful way, and that's the result. Any fractional
2015 * microseconds left over (this can happen if num is a float type) are
2016 * added into *leftover.
2017 * Note that there are many ways this can give an error (NULL) return.
2018 */
2019static PyObject *
2020accum(const char* tag, PyObject *sofar, PyObject *num, PyObject *factor,
2021 double *leftover)
2022{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002023 PyObject *prod;
2024 PyObject *sum;
Tim Peters2a799bf2002-12-16 20:18:38 +00002025
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002026 assert(num != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00002027
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002028 if (PyLong_Check(num)) {
2029 prod = PyNumber_Multiply(num, factor);
2030 if (prod == NULL)
2031 return NULL;
2032 sum = PyNumber_Add(sofar, prod);
2033 Py_DECREF(prod);
2034 return sum;
2035 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002036
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002037 if (PyFloat_Check(num)) {
2038 double dnum;
2039 double fracpart;
2040 double intpart;
2041 PyObject *x;
2042 PyObject *y;
Tim Peters2a799bf2002-12-16 20:18:38 +00002043
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002044 /* The Plan: decompose num into an integer part and a
2045 * fractional part, num = intpart + fracpart.
2046 * Then num * factor ==
2047 * intpart * factor + fracpart * factor
2048 * and the LHS can be computed exactly in long arithmetic.
2049 * The RHS is again broken into an int part and frac part.
2050 * and the frac part is added into *leftover.
2051 */
2052 dnum = PyFloat_AsDouble(num);
2053 if (dnum == -1.0 && PyErr_Occurred())
2054 return NULL;
2055 fracpart = modf(dnum, &intpart);
2056 x = PyLong_FromDouble(intpart);
2057 if (x == NULL)
2058 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002060 prod = PyNumber_Multiply(x, factor);
2061 Py_DECREF(x);
2062 if (prod == NULL)
2063 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002064
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002065 sum = PyNumber_Add(sofar, prod);
2066 Py_DECREF(prod);
2067 if (sum == NULL)
2068 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002070 if (fracpart == 0.0)
2071 return sum;
2072 /* So far we've lost no information. Dealing with the
2073 * fractional part requires float arithmetic, and may
2074 * lose a little info.
2075 */
2076 assert(PyLong_Check(factor));
2077 dnum = PyLong_AsDouble(factor);
Tim Peters2a799bf2002-12-16 20:18:38 +00002078
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002079 dnum *= fracpart;
2080 fracpart = modf(dnum, &intpart);
2081 x = PyLong_FromDouble(intpart);
2082 if (x == NULL) {
2083 Py_DECREF(sum);
2084 return NULL;
2085 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002086
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002087 y = PyNumber_Add(sum, x);
2088 Py_DECREF(sum);
2089 Py_DECREF(x);
2090 *leftover += fracpart;
2091 return y;
2092 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002093
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002094 PyErr_Format(PyExc_TypeError,
2095 "unsupported type for timedelta %s component: %s",
2096 tag, Py_TYPE(num)->tp_name);
2097 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002098}
2099
2100static PyObject *
2101delta_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2102{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002103 PyObject *self = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002104
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002105 /* Argument objects. */
2106 PyObject *day = NULL;
2107 PyObject *second = NULL;
2108 PyObject *us = NULL;
2109 PyObject *ms = NULL;
2110 PyObject *minute = NULL;
2111 PyObject *hour = NULL;
2112 PyObject *week = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002113
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002114 PyObject *x = NULL; /* running sum of microseconds */
2115 PyObject *y = NULL; /* temp sum of microseconds */
2116 double leftover_us = 0.0;
Tim Peters2a799bf2002-12-16 20:18:38 +00002117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002118 static char *keywords[] = {
2119 "days", "seconds", "microseconds", "milliseconds",
2120 "minutes", "hours", "weeks", NULL
2121 };
Tim Peters2a799bf2002-12-16 20:18:38 +00002122
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002123 if (PyArg_ParseTupleAndKeywords(args, kw, "|OOOOOOO:__new__",
2124 keywords,
2125 &day, &second, &us,
2126 &ms, &minute, &hour, &week) == 0)
2127 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00002128
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002129 x = PyLong_FromLong(0);
2130 if (x == NULL)
2131 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00002132
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002133#define CLEANUP \
2134 Py_DECREF(x); \
2135 x = y; \
2136 if (x == NULL) \
2137 goto Done
Tim Peters2a799bf2002-12-16 20:18:38 +00002138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002139 if (us) {
2140 y = accum("microseconds", x, us, us_per_us, &leftover_us);
2141 CLEANUP;
2142 }
2143 if (ms) {
2144 y = accum("milliseconds", x, ms, us_per_ms, &leftover_us);
2145 CLEANUP;
2146 }
2147 if (second) {
2148 y = accum("seconds", x, second, us_per_second, &leftover_us);
2149 CLEANUP;
2150 }
2151 if (minute) {
2152 y = accum("minutes", x, minute, us_per_minute, &leftover_us);
2153 CLEANUP;
2154 }
2155 if (hour) {
2156 y = accum("hours", x, hour, us_per_hour, &leftover_us);
2157 CLEANUP;
2158 }
2159 if (day) {
2160 y = accum("days", x, day, us_per_day, &leftover_us);
2161 CLEANUP;
2162 }
2163 if (week) {
2164 y = accum("weeks", x, week, us_per_week, &leftover_us);
2165 CLEANUP;
2166 }
2167 if (leftover_us) {
2168 /* Round to nearest whole # of us, and add into x. */
2169 PyObject *temp = PyLong_FromLong(round_to_long(leftover_us));
2170 if (temp == NULL) {
2171 Py_DECREF(x);
2172 goto Done;
2173 }
2174 y = PyNumber_Add(x, temp);
2175 Py_DECREF(temp);
2176 CLEANUP;
2177 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002178
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002179 self = microseconds_to_delta_ex(x, type);
2180 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00002181Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002182 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00002183
2184#undef CLEANUP
2185}
2186
2187static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00002188delta_bool(PyDateTime_Delta *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00002189{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002190 return (GET_TD_DAYS(self) != 0
2191 || GET_TD_SECONDS(self) != 0
2192 || GET_TD_MICROSECONDS(self) != 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00002193}
2194
2195static PyObject *
2196delta_repr(PyDateTime_Delta *self)
2197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002198 if (GET_TD_MICROSECONDS(self) != 0)
2199 return PyUnicode_FromFormat("%s(%d, %d, %d)",
2200 Py_TYPE(self)->tp_name,
2201 GET_TD_DAYS(self),
2202 GET_TD_SECONDS(self),
2203 GET_TD_MICROSECONDS(self));
2204 if (GET_TD_SECONDS(self) != 0)
2205 return PyUnicode_FromFormat("%s(%d, %d)",
2206 Py_TYPE(self)->tp_name,
2207 GET_TD_DAYS(self),
2208 GET_TD_SECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002210 return PyUnicode_FromFormat("%s(%d)",
2211 Py_TYPE(self)->tp_name,
2212 GET_TD_DAYS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002213}
2214
2215static PyObject *
2216delta_str(PyDateTime_Delta *self)
2217{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002218 int us = GET_TD_MICROSECONDS(self);
2219 int seconds = GET_TD_SECONDS(self);
2220 int minutes = divmod(seconds, 60, &seconds);
2221 int hours = divmod(minutes, 60, &minutes);
2222 int days = GET_TD_DAYS(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002223
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002224 if (days) {
2225 if (us)
2226 return PyUnicode_FromFormat("%d day%s, %d:%02d:%02d.%06d",
2227 days, (days == 1 || days == -1) ? "" : "s",
2228 hours, minutes, seconds, us);
2229 else
2230 return PyUnicode_FromFormat("%d day%s, %d:%02d:%02d",
2231 days, (days == 1 || days == -1) ? "" : "s",
2232 hours, minutes, seconds);
2233 } else {
2234 if (us)
2235 return PyUnicode_FromFormat("%d:%02d:%02d.%06d",
2236 hours, minutes, seconds, us);
2237 else
2238 return PyUnicode_FromFormat("%d:%02d:%02d",
2239 hours, minutes, seconds);
2240 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002241
Tim Peters2a799bf2002-12-16 20:18:38 +00002242}
2243
Tim Peters371935f2003-02-01 01:52:50 +00002244/* Pickle support, a simple use of __reduce__. */
2245
Tim Petersb57f8f02003-02-01 02:54:15 +00002246/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002247static PyObject *
2248delta_getstate(PyDateTime_Delta *self)
2249{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002250 return Py_BuildValue("iii", GET_TD_DAYS(self),
2251 GET_TD_SECONDS(self),
2252 GET_TD_MICROSECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002253}
2254
Tim Peters2a799bf2002-12-16 20:18:38 +00002255static PyObject *
Antoine Pitroube6859d2009-11-25 23:02:32 +00002256delta_total_seconds(PyObject *self)
2257{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002258 PyObject *total_seconds;
2259 PyObject *total_microseconds;
2260 PyObject *one_million;
Mark Dickinson0381e3f2010-05-08 14:35:02 +00002261
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002262 total_microseconds = delta_to_microseconds((PyDateTime_Delta *)self);
2263 if (total_microseconds == NULL)
2264 return NULL;
Mark Dickinson0381e3f2010-05-08 14:35:02 +00002265
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002266 one_million = PyLong_FromLong(1000000L);
2267 if (one_million == NULL) {
2268 Py_DECREF(total_microseconds);
2269 return NULL;
2270 }
Mark Dickinson0381e3f2010-05-08 14:35:02 +00002271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002272 total_seconds = PyNumber_TrueDivide(total_microseconds, one_million);
Mark Dickinson0381e3f2010-05-08 14:35:02 +00002273
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002274 Py_DECREF(total_microseconds);
2275 Py_DECREF(one_million);
2276 return total_seconds;
Antoine Pitroube6859d2009-11-25 23:02:32 +00002277}
2278
2279static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002280delta_reduce(PyDateTime_Delta* self)
2281{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002282 return Py_BuildValue("ON", Py_TYPE(self), delta_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002283}
2284
2285#define OFFSET(field) offsetof(PyDateTime_Delta, field)
2286
2287static PyMemberDef delta_members[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002288
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002289 {"days", T_INT, OFFSET(days), READONLY,
2290 PyDoc_STR("Number of days.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002291
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002292 {"seconds", T_INT, OFFSET(seconds), READONLY,
2293 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002294
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002295 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
2296 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
2297 {NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00002298};
2299
2300static PyMethodDef delta_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002301 {"total_seconds", (PyCFunction)delta_total_seconds, METH_NOARGS,
2302 PyDoc_STR("Total seconds in the duration.")},
Antoine Pitroube6859d2009-11-25 23:02:32 +00002303
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002304 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
2305 PyDoc_STR("__reduce__() -> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00002306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002307 {NULL, NULL},
Tim Peters2a799bf2002-12-16 20:18:38 +00002308};
2309
2310static char delta_doc[] =
2311PyDoc_STR("Difference between two datetime values.");
2312
2313static PyNumberMethods delta_as_number = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002314 delta_add, /* nb_add */
2315 delta_subtract, /* nb_subtract */
2316 delta_multiply, /* nb_multiply */
2317 delta_remainder, /* nb_remainder */
2318 delta_divmod, /* nb_divmod */
2319 0, /* nb_power */
2320 (unaryfunc)delta_negative, /* nb_negative */
2321 (unaryfunc)delta_positive, /* nb_positive */
2322 (unaryfunc)delta_abs, /* nb_absolute */
2323 (inquiry)delta_bool, /* nb_bool */
2324 0, /*nb_invert*/
2325 0, /*nb_lshift*/
2326 0, /*nb_rshift*/
2327 0, /*nb_and*/
2328 0, /*nb_xor*/
2329 0, /*nb_or*/
2330 0, /*nb_int*/
2331 0, /*nb_reserved*/
2332 0, /*nb_float*/
2333 0, /*nb_inplace_add*/
2334 0, /*nb_inplace_subtract*/
2335 0, /*nb_inplace_multiply*/
2336 0, /*nb_inplace_remainder*/
2337 0, /*nb_inplace_power*/
2338 0, /*nb_inplace_lshift*/
2339 0, /*nb_inplace_rshift*/
2340 0, /*nb_inplace_and*/
2341 0, /*nb_inplace_xor*/
2342 0, /*nb_inplace_or*/
2343 delta_divide, /* nb_floor_divide */
2344 delta_truedivide, /* nb_true_divide */
2345 0, /* nb_inplace_floor_divide */
2346 0, /* nb_inplace_true_divide */
Tim Peters2a799bf2002-12-16 20:18:38 +00002347};
2348
2349static PyTypeObject PyDateTime_DeltaType = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002350 PyVarObject_HEAD_INIT(NULL, 0)
2351 "datetime.timedelta", /* tp_name */
2352 sizeof(PyDateTime_Delta), /* tp_basicsize */
2353 0, /* tp_itemsize */
2354 0, /* tp_dealloc */
2355 0, /* tp_print */
2356 0, /* tp_getattr */
2357 0, /* tp_setattr */
2358 0, /* tp_reserved */
2359 (reprfunc)delta_repr, /* tp_repr */
2360 &delta_as_number, /* tp_as_number */
2361 0, /* tp_as_sequence */
2362 0, /* tp_as_mapping */
2363 (hashfunc)delta_hash, /* tp_hash */
2364 0, /* tp_call */
2365 (reprfunc)delta_str, /* tp_str */
2366 PyObject_GenericGetAttr, /* tp_getattro */
2367 0, /* tp_setattro */
2368 0, /* tp_as_buffer */
2369 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
2370 delta_doc, /* tp_doc */
2371 0, /* tp_traverse */
2372 0, /* tp_clear */
2373 delta_richcompare, /* tp_richcompare */
2374 0, /* tp_weaklistoffset */
2375 0, /* tp_iter */
2376 0, /* tp_iternext */
2377 delta_methods, /* tp_methods */
2378 delta_members, /* tp_members */
2379 0, /* tp_getset */
2380 0, /* tp_base */
2381 0, /* tp_dict */
2382 0, /* tp_descr_get */
2383 0, /* tp_descr_set */
2384 0, /* tp_dictoffset */
2385 0, /* tp_init */
2386 0, /* tp_alloc */
2387 delta_new, /* tp_new */
2388 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002389};
2390
2391/*
2392 * PyDateTime_Date implementation.
2393 */
2394
2395/* Accessor properties. */
2396
2397static PyObject *
2398date_year(PyDateTime_Date *self, void *unused)
2399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002400 return PyLong_FromLong(GET_YEAR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002401}
2402
2403static PyObject *
2404date_month(PyDateTime_Date *self, void *unused)
2405{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002406 return PyLong_FromLong(GET_MONTH(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002407}
2408
2409static PyObject *
2410date_day(PyDateTime_Date *self, void *unused)
2411{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002412 return PyLong_FromLong(GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002413}
2414
2415static PyGetSetDef date_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002416 {"year", (getter)date_year},
2417 {"month", (getter)date_month},
2418 {"day", (getter)date_day},
2419 {NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00002420};
2421
2422/* Constructors. */
2423
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002424static char *date_kws[] = {"year", "month", "day", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002425
Tim Peters2a799bf2002-12-16 20:18:38 +00002426static PyObject *
2427date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2428{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002429 PyObject *self = NULL;
2430 PyObject *state;
2431 int year;
2432 int month;
2433 int day;
Tim Peters2a799bf2002-12-16 20:18:38 +00002434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002435 /* Check for invocation from pickle with __getstate__ state */
2436 if (PyTuple_GET_SIZE(args) == 1 &&
2437 PyBytes_Check(state = PyTuple_GET_ITEM(args, 0)) &&
2438 PyBytes_GET_SIZE(state) == _PyDateTime_DATE_DATASIZE &&
2439 MONTH_IS_SANE(PyBytes_AS_STRING(state)[2]))
2440 {
2441 PyDateTime_Date *me;
Tim Peters70533e22003-02-01 04:40:04 +00002442
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002443 me = (PyDateTime_Date *) (type->tp_alloc(type, 0));
2444 if (me != NULL) {
2445 char *pdata = PyBytes_AS_STRING(state);
2446 memcpy(me->data, pdata, _PyDateTime_DATE_DATASIZE);
2447 me->hashcode = -1;
2448 }
2449 return (PyObject *)me;
2450 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00002451
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
2453 &year, &month, &day)) {
2454 if (check_date_args(year, month, day) < 0)
2455 return NULL;
2456 self = new_date_ex(year, month, day, type);
2457 }
2458 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00002459}
2460
2461/* Return new date from localtime(t). */
2462static PyObject *
Tim Peters1b6f7a92004-06-20 02:50:16 +00002463date_local_from_time_t(PyObject *cls, double ts)
Tim Peters2a799bf2002-12-16 20:18:38 +00002464{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 struct tm *tm;
2466 time_t t;
2467 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 t = _PyTime_DoubleToTimet(ts);
2470 if (t == (time_t)-1 && PyErr_Occurred())
2471 return NULL;
2472 tm = localtime(&t);
2473 if (tm)
2474 result = PyObject_CallFunction(cls, "iii",
2475 tm->tm_year + 1900,
2476 tm->tm_mon + 1,
2477 tm->tm_mday);
2478 else
2479 PyErr_SetString(PyExc_ValueError,
2480 "timestamp out of range for "
2481 "platform localtime() function");
2482 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002483}
2484
2485/* Return new date from current time.
2486 * We say this is equivalent to fromtimestamp(time.time()), and the
2487 * only way to be sure of that is to *call* time.time(). That's not
2488 * generally the same as calling C's time.
2489 */
2490static PyObject *
2491date_today(PyObject *cls, PyObject *dummy)
2492{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 PyObject *time;
2494 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002496 time = time_time();
2497 if (time == NULL)
2498 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002500 /* Note well: today() is a class method, so this may not call
2501 * date.fromtimestamp. For example, it may call
2502 * datetime.fromtimestamp. That's why we need all the accuracy
2503 * time.time() delivers; if someone were gonzo about optimization,
2504 * date.today() could get away with plain C time().
2505 */
2506 result = PyObject_CallMethod(cls, "fromtimestamp", "O", time);
2507 Py_DECREF(time);
2508 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002509}
2510
2511/* Return new date from given timestamp (Python timestamp -- a double). */
2512static PyObject *
2513date_fromtimestamp(PyObject *cls, PyObject *args)
2514{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002515 double timestamp;
2516 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002518 if (PyArg_ParseTuple(args, "d:fromtimestamp", &timestamp))
2519 result = date_local_from_time_t(cls, timestamp);
2520 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002521}
2522
2523/* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2524 * the ordinal is out of range.
2525 */
2526static PyObject *
2527date_fromordinal(PyObject *cls, PyObject *args)
2528{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 PyObject *result = NULL;
2530 int ordinal;
Tim Peters2a799bf2002-12-16 20:18:38 +00002531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2533 int year;
2534 int month;
2535 int day;
Tim Peters2a799bf2002-12-16 20:18:38 +00002536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002537 if (ordinal < 1)
2538 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2539 ">= 1");
2540 else {
2541 ord_to_ymd(ordinal, &year, &month, &day);
2542 result = PyObject_CallFunction(cls, "iii",
2543 year, month, day);
2544 }
2545 }
2546 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002547}
2548
2549/*
2550 * Date arithmetic.
2551 */
2552
2553/* date + timedelta -> date. If arg negate is true, subtract the timedelta
2554 * instead.
2555 */
2556static PyObject *
2557add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
2558{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002559 PyObject *result = NULL;
2560 int year = GET_YEAR(date);
2561 int month = GET_MONTH(date);
2562 int deltadays = GET_TD_DAYS(delta);
2563 /* C-level overflow is impossible because |deltadays| < 1e9. */
2564 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
Tim Peters2a799bf2002-12-16 20:18:38 +00002565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002566 if (normalize_date(&year, &month, &day) >= 0)
2567 result = new_date(year, month, day);
2568 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002569}
2570
2571static PyObject *
2572date_add(PyObject *left, PyObject *right)
2573{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002574 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2575 Py_INCREF(Py_NotImplemented);
2576 return Py_NotImplemented;
2577 }
2578 if (PyDate_Check(left)) {
2579 /* date + ??? */
2580 if (PyDelta_Check(right))
2581 /* date + delta */
2582 return add_date_timedelta((PyDateTime_Date *) left,
2583 (PyDateTime_Delta *) right,
2584 0);
2585 }
2586 else {
2587 /* ??? + date
2588 * 'right' must be one of us, or we wouldn't have been called
2589 */
2590 if (PyDelta_Check(left))
2591 /* delta + date */
2592 return add_date_timedelta((PyDateTime_Date *) right,
2593 (PyDateTime_Delta *) left,
2594 0);
2595 }
2596 Py_INCREF(Py_NotImplemented);
2597 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002598}
2599
2600static PyObject *
2601date_subtract(PyObject *left, PyObject *right)
2602{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002603 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2604 Py_INCREF(Py_NotImplemented);
2605 return Py_NotImplemented;
2606 }
2607 if (PyDate_Check(left)) {
2608 if (PyDate_Check(right)) {
2609 /* date - date */
2610 int left_ord = ymd_to_ord(GET_YEAR(left),
2611 GET_MONTH(left),
2612 GET_DAY(left));
2613 int right_ord = ymd_to_ord(GET_YEAR(right),
2614 GET_MONTH(right),
2615 GET_DAY(right));
2616 return new_delta(left_ord - right_ord, 0, 0, 0);
2617 }
2618 if (PyDelta_Check(right)) {
2619 /* date - delta */
2620 return add_date_timedelta((PyDateTime_Date *) left,
2621 (PyDateTime_Delta *) right,
2622 1);
2623 }
2624 }
2625 Py_INCREF(Py_NotImplemented);
2626 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002627}
2628
2629
2630/* Various ways to turn a date into a string. */
2631
2632static PyObject *
2633date_repr(PyDateTime_Date *self)
2634{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002635 return PyUnicode_FromFormat("%s(%d, %d, %d)",
2636 Py_TYPE(self)->tp_name,
2637 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002638}
2639
2640static PyObject *
2641date_isoformat(PyDateTime_Date *self)
2642{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002643 return PyUnicode_FromFormat("%04d-%02d-%02d",
2644 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002645}
2646
Tim Peterse2df5ff2003-05-02 18:39:55 +00002647/* str() calls the appropriate isoformat() method. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002648static PyObject *
2649date_str(PyDateTime_Date *self)
2650{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002651 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
Tim Peters2a799bf2002-12-16 20:18:38 +00002652}
2653
2654
2655static PyObject *
2656date_ctime(PyDateTime_Date *self)
2657{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002658 return format_ctime(self, 0, 0, 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00002659}
2660
2661static PyObject *
2662date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2663{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002664 /* This method can be inherited, and needs to call the
2665 * timetuple() method appropriate to self's class.
2666 */
2667 PyObject *result;
2668 PyObject *tuple;
2669 PyObject *format;
2670 static char *keywords[] = {"format", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00002671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 if (! PyArg_ParseTupleAndKeywords(args, kw, "U:strftime", keywords,
2673 &format))
2674 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002675
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002676 tuple = PyObject_CallMethod((PyObject *)self, "timetuple", "()");
2677 if (tuple == NULL)
2678 return NULL;
2679 result = wrap_strftime((PyObject *)self, format, tuple,
2680 (PyObject *)self);
2681 Py_DECREF(tuple);
2682 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002683}
2684
Eric Smith1ba31142007-09-11 18:06:02 +00002685static PyObject *
2686date_format(PyDateTime_Date *self, PyObject *args)
2687{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002688 PyObject *format;
Eric Smith1ba31142007-09-11 18:06:02 +00002689
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002690 if (!PyArg_ParseTuple(args, "U:__format__", &format))
2691 return NULL;
Eric Smith1ba31142007-09-11 18:06:02 +00002692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002693 /* if the format is zero length, return str(self) */
2694 if (PyUnicode_GetSize(format) == 0)
2695 return PyObject_Str((PyObject *)self);
Eric Smith1ba31142007-09-11 18:06:02 +00002696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002697 return PyObject_CallMethod((PyObject *)self, "strftime", "O", format);
Eric Smith1ba31142007-09-11 18:06:02 +00002698}
2699
Tim Peters2a799bf2002-12-16 20:18:38 +00002700/* ISO methods. */
2701
2702static PyObject *
2703date_isoweekday(PyDateTime_Date *self)
2704{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002705 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002706
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002707 return PyLong_FromLong(dow + 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00002708}
2709
2710static PyObject *
2711date_isocalendar(PyDateTime_Date *self)
2712{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002713 int year = GET_YEAR(self);
2714 int week1_monday = iso_week1_monday(year);
2715 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
2716 int week;
2717 int day;
Tim Peters2a799bf2002-12-16 20:18:38 +00002718
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002719 week = divmod(today - week1_monday, 7, &day);
2720 if (week < 0) {
2721 --year;
2722 week1_monday = iso_week1_monday(year);
2723 week = divmod(today - week1_monday, 7, &day);
2724 }
2725 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
2726 ++year;
2727 week = 0;
2728 }
2729 return Py_BuildValue("iii", year, week + 1, day + 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00002730}
2731
2732/* Miscellaneous methods. */
2733
Tim Peters2a799bf2002-12-16 20:18:38 +00002734static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00002735date_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters2a799bf2002-12-16 20:18:38 +00002736{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002737 if (PyDate_Check(other)) {
2738 int diff = memcmp(((PyDateTime_Date *)self)->data,
2739 ((PyDateTime_Date *)other)->data,
2740 _PyDateTime_DATE_DATASIZE);
2741 return diff_to_bool(diff, op);
2742 }
2743 else {
2744 Py_INCREF(Py_NotImplemented);
2745 return Py_NotImplemented;
2746 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002747}
2748
2749static PyObject *
2750date_timetuple(PyDateTime_Date *self)
2751{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002752 return build_struct_time(GET_YEAR(self),
2753 GET_MONTH(self),
2754 GET_DAY(self),
2755 0, 0, 0, -1);
Tim Peters2a799bf2002-12-16 20:18:38 +00002756}
2757
Tim Peters12bf3392002-12-24 05:41:27 +00002758static PyObject *
2759date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2760{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002761 PyObject *clone;
2762 PyObject *tuple;
2763 int year = GET_YEAR(self);
2764 int month = GET_MONTH(self);
2765 int day = GET_DAY(self);
Tim Peters12bf3392002-12-24 05:41:27 +00002766
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002767 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
2768 &year, &month, &day))
2769 return NULL;
2770 tuple = Py_BuildValue("iii", year, month, day);
2771 if (tuple == NULL)
2772 return NULL;
2773 clone = date_new(Py_TYPE(self), tuple, NULL);
2774 Py_DECREF(tuple);
2775 return clone;
Tim Peters12bf3392002-12-24 05:41:27 +00002776}
2777
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002778/*
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002779 Borrowed from stringobject.c, originally it was string_hash()
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002780*/
Benjamin Peterson8f67d082010-10-17 20:54:53 +00002781static Py_hash_t
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002782generic_hash(unsigned char *data, int len)
2783{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002784 register unsigned char *p;
Benjamin Peterson8f67d082010-10-17 20:54:53 +00002785 register Py_hash_t x;
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002787 p = (unsigned char *) data;
2788 x = *p << 7;
2789 while (--len >= 0)
2790 x = (1000003*x) ^ *p++;
2791 x ^= len;
2792 if (x == -1)
2793 x = -2;
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002794
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002795 return x;
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002796}
2797
2798
2799static PyObject *date_getstate(PyDateTime_Date *self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002800
Benjamin Peterson8f67d082010-10-17 20:54:53 +00002801static Py_hash_t
Tim Peters2a799bf2002-12-16 20:18:38 +00002802date_hash(PyDateTime_Date *self)
2803{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002804 if (self->hashcode == -1)
2805 self->hashcode = generic_hash(
2806 (unsigned char *)self->data, _PyDateTime_DATE_DATASIZE);
Guido van Rossum254348e2007-11-21 19:29:53 +00002807
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002808 return self->hashcode;
Tim Peters2a799bf2002-12-16 20:18:38 +00002809}
2810
2811static PyObject *
2812date_toordinal(PyDateTime_Date *self)
2813{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002814 return PyLong_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
2815 GET_DAY(self)));
Tim Peters2a799bf2002-12-16 20:18:38 +00002816}
2817
2818static PyObject *
2819date_weekday(PyDateTime_Date *self)
2820{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002821 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002822
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002823 return PyLong_FromLong(dow);
Tim Peters2a799bf2002-12-16 20:18:38 +00002824}
2825
Tim Peters371935f2003-02-01 01:52:50 +00002826/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002827
Tim Petersb57f8f02003-02-01 02:54:15 +00002828/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002829static PyObject *
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002830date_getstate(PyDateTime_Date *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00002831{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002832 PyObject* field;
2833 field = PyBytes_FromStringAndSize((char*)self->data,
2834 _PyDateTime_DATE_DATASIZE);
2835 return Py_BuildValue("(N)", field);
Tim Peters2a799bf2002-12-16 20:18:38 +00002836}
2837
2838static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00002839date_reduce(PyDateTime_Date *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00002840{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002841 return Py_BuildValue("(ON)", Py_TYPE(self), date_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002842}
2843
2844static PyMethodDef date_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002845
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002846 /* Class methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00002847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002848 {"fromtimestamp", (PyCFunction)date_fromtimestamp, METH_VARARGS |
2849 METH_CLASS,
2850 PyDoc_STR("timestamp -> local date from a POSIX timestamp (like "
2851 "time.time()).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002852
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002853 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
2854 METH_CLASS,
2855 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
2856 "ordinal.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002857
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002858 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
2859 PyDoc_STR("Current date or datetime: same as "
2860 "self.__class__.fromtimestamp(time.time()).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002861
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002862 /* Instance methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00002863
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002864 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
2865 PyDoc_STR("Return ctime() style string.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002866
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002867 {"strftime", (PyCFunction)date_strftime, METH_VARARGS | METH_KEYWORDS,
2868 PyDoc_STR("format -> strftime() style string.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002869
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002870 {"__format__", (PyCFunction)date_format, METH_VARARGS,
2871 PyDoc_STR("Formats self with strftime.")},
Eric Smith1ba31142007-09-11 18:06:02 +00002872
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002873 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
2874 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002875
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002876 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
2877 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
2878 "weekday.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002880 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
2881 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002882
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002883 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
2884 PyDoc_STR("Return the day of the week represented by the date.\n"
2885 "Monday == 1 ... Sunday == 7")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002886
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002887 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
2888 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
2889 "1 is day 1.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002891 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
2892 PyDoc_STR("Return the day of the week represented by the date.\n"
2893 "Monday == 0 ... Sunday == 6")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002894
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002895 {"replace", (PyCFunction)date_replace, METH_VARARGS | METH_KEYWORDS,
2896 PyDoc_STR("Return date with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00002897
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002898 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
2899 PyDoc_STR("__reduce__() -> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00002900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002901 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00002902};
2903
2904static char date_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00002905PyDoc_STR("date(year, month, day) --> date object");
Tim Peters2a799bf2002-12-16 20:18:38 +00002906
2907static PyNumberMethods date_as_number = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002908 date_add, /* nb_add */
2909 date_subtract, /* nb_subtract */
2910 0, /* nb_multiply */
2911 0, /* nb_remainder */
2912 0, /* nb_divmod */
2913 0, /* nb_power */
2914 0, /* nb_negative */
2915 0, /* nb_positive */
2916 0, /* nb_absolute */
2917 0, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00002918};
2919
2920static PyTypeObject PyDateTime_DateType = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002921 PyVarObject_HEAD_INIT(NULL, 0)
2922 "datetime.date", /* tp_name */
2923 sizeof(PyDateTime_Date), /* tp_basicsize */
2924 0, /* tp_itemsize */
2925 0, /* tp_dealloc */
2926 0, /* tp_print */
2927 0, /* tp_getattr */
2928 0, /* tp_setattr */
2929 0, /* tp_reserved */
2930 (reprfunc)date_repr, /* tp_repr */
2931 &date_as_number, /* tp_as_number */
2932 0, /* tp_as_sequence */
2933 0, /* tp_as_mapping */
2934 (hashfunc)date_hash, /* tp_hash */
2935 0, /* tp_call */
2936 (reprfunc)date_str, /* tp_str */
2937 PyObject_GenericGetAttr, /* tp_getattro */
2938 0, /* tp_setattro */
2939 0, /* tp_as_buffer */
2940 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
2941 date_doc, /* tp_doc */
2942 0, /* tp_traverse */
2943 0, /* tp_clear */
2944 date_richcompare, /* tp_richcompare */
2945 0, /* tp_weaklistoffset */
2946 0, /* tp_iter */
2947 0, /* tp_iternext */
2948 date_methods, /* tp_methods */
2949 0, /* tp_members */
2950 date_getset, /* tp_getset */
2951 0, /* tp_base */
2952 0, /* tp_dict */
2953 0, /* tp_descr_get */
2954 0, /* tp_descr_set */
2955 0, /* tp_dictoffset */
2956 0, /* tp_init */
2957 0, /* tp_alloc */
2958 date_new, /* tp_new */
2959 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002960};
2961
2962/*
Tim Peters2a799bf2002-12-16 20:18:38 +00002963 * PyDateTime_TZInfo implementation.
2964 */
2965
2966/* This is a pure abstract base class, so doesn't do anything beyond
2967 * raising NotImplemented exceptions. Real tzinfo classes need
2968 * to derive from this. This is mostly for clarity, and for efficiency in
Tim Petersa9bc1682003-01-11 03:39:11 +00002969 * datetime and time constructors (their tzinfo arguments need to
Tim Peters2a799bf2002-12-16 20:18:38 +00002970 * be subclasses of this tzinfo class, which is easy and quick to check).
2971 *
2972 * Note: For reasons having to do with pickling of subclasses, we have
2973 * to allow tzinfo objects to be instantiated. This wasn't an issue
2974 * in the Python implementation (__init__() could raise NotImplementedError
2975 * there without ill effect), but doing so in the C implementation hit a
2976 * brick wall.
2977 */
2978
2979static PyObject *
2980tzinfo_nogo(const char* methodname)
2981{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002982 PyErr_Format(PyExc_NotImplementedError,
2983 "a tzinfo subclass must implement %s()",
2984 methodname);
2985 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002986}
2987
2988/* Methods. A subclass must implement these. */
2989
Tim Peters52dcce22003-01-23 16:36:11 +00002990static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002991tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
2992{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002993 return tzinfo_nogo("tzname");
Tim Peters2a799bf2002-12-16 20:18:38 +00002994}
2995
Tim Peters52dcce22003-01-23 16:36:11 +00002996static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002997tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
2998{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002999 return tzinfo_nogo("utcoffset");
Tim Peters2a799bf2002-12-16 20:18:38 +00003000}
3001
Tim Peters52dcce22003-01-23 16:36:11 +00003002static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00003003tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
3004{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003005 return tzinfo_nogo("dst");
Tim Peters2a799bf2002-12-16 20:18:38 +00003006}
3007
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003008
3009static PyObject *add_datetime_timedelta(PyDateTime_DateTime *date,
3010 PyDateTime_Delta *delta,
3011 int factor);
3012static PyObject *datetime_utcoffset(PyObject *self, PyObject *);
3013static PyObject *datetime_dst(PyObject *self, PyObject *);
3014
Tim Peters52dcce22003-01-23 16:36:11 +00003015static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003016tzinfo_fromutc(PyDateTime_TZInfo *self, PyObject *dt)
Tim Peters52dcce22003-01-23 16:36:11 +00003017{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003018 PyObject *result = NULL;
3019 PyObject *off = NULL, *dst = NULL;
3020 PyDateTime_Delta *delta = NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00003021
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003022 if (!PyDateTime_Check(dt)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003023 PyErr_SetString(PyExc_TypeError,
3024 "fromutc: argument must be a datetime");
3025 return NULL;
3026 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003027 if (GET_DT_TZINFO(dt) != (PyObject *)self) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003028 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
3029 "is not self");
3030 return NULL;
3031 }
Tim Peters52dcce22003-01-23 16:36:11 +00003032
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003033 off = datetime_utcoffset(dt, NULL);
3034 if (off == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003035 return NULL;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003036 if (off == Py_None) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003037 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
3038 "utcoffset() result required");
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003039 goto Fail;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003040 }
Tim Peters52dcce22003-01-23 16:36:11 +00003041
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003042 dst = datetime_dst(dt, NULL);
3043 if (dst == NULL)
3044 goto Fail;
3045 if (dst == Py_None) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003046 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
3047 "dst() result required");
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003048 goto Fail;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003049 }
Tim Peters52dcce22003-01-23 16:36:11 +00003050
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003051 delta = (PyDateTime_Delta *)delta_subtract(off, dst);
3052 if (delta == NULL)
3053 goto Fail;
3054 result = add_datetime_timedelta((PyDateTime_DateTime *)dt, delta, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003055 if (result == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003056 goto Fail;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003057
3058 Py_DECREF(dst);
3059 dst = call_dst(GET_DT_TZINFO(dt), result);
3060 if (dst == NULL)
3061 goto Fail;
3062 if (dst == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003063 goto Inconsistent;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003064 if (delta_bool(delta) != 0) {
3065 PyObject *temp = result;
3066 result = add_datetime_timedelta((PyDateTime_DateTime *)result,
3067 (PyDateTime_Delta *)dst, 1);
3068 Py_DECREF(temp);
3069 if (result == NULL)
3070 goto Fail;
3071 }
3072 Py_DECREF(delta);
3073 Py_DECREF(dst);
3074 Py_DECREF(off);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003075 return result;
Tim Peters52dcce22003-01-23 16:36:11 +00003076
3077Inconsistent:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003078 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave"
3079 "inconsistent results; cannot convert");
Tim Peters52dcce22003-01-23 16:36:11 +00003080
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003081 /* fall thru to failure */
Tim Peters52dcce22003-01-23 16:36:11 +00003082Fail:
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003083 Py_XDECREF(off);
3084 Py_XDECREF(dst);
3085 Py_XDECREF(delta);
3086 Py_XDECREF(result);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003087 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00003088}
3089
Tim Peters2a799bf2002-12-16 20:18:38 +00003090/*
3091 * Pickle support. This is solely so that tzinfo subclasses can use
Guido van Rossum177e41a2003-01-30 22:06:23 +00003092 * pickling -- tzinfo itself is supposed to be uninstantiable.
Tim Peters2a799bf2002-12-16 20:18:38 +00003093 */
3094
Guido van Rossum177e41a2003-01-30 22:06:23 +00003095static PyObject *
3096tzinfo_reduce(PyObject *self)
3097{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003098 PyObject *args, *state, *tmp;
3099 PyObject *getinitargs, *getstate;
Tim Peters2a799bf2002-12-16 20:18:38 +00003100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003101 tmp = PyTuple_New(0);
3102 if (tmp == NULL)
3103 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003104
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003105 getinitargs = PyObject_GetAttrString(self, "__getinitargs__");
3106 if (getinitargs != NULL) {
3107 args = PyObject_CallObject(getinitargs, tmp);
3108 Py_DECREF(getinitargs);
3109 if (args == NULL) {
3110 Py_DECREF(tmp);
3111 return NULL;
3112 }
3113 }
3114 else {
3115 PyErr_Clear();
3116 args = tmp;
3117 Py_INCREF(args);
3118 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00003119
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003120 getstate = PyObject_GetAttrString(self, "__getstate__");
3121 if (getstate != NULL) {
3122 state = PyObject_CallObject(getstate, tmp);
3123 Py_DECREF(getstate);
3124 if (state == NULL) {
3125 Py_DECREF(args);
3126 Py_DECREF(tmp);
3127 return NULL;
3128 }
3129 }
3130 else {
3131 PyObject **dictptr;
3132 PyErr_Clear();
3133 state = Py_None;
3134 dictptr = _PyObject_GetDictPtr(self);
3135 if (dictptr && *dictptr && PyDict_Size(*dictptr))
3136 state = *dictptr;
3137 Py_INCREF(state);
3138 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00003139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003140 Py_DECREF(tmp);
Guido van Rossum177e41a2003-01-30 22:06:23 +00003141
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003142 if (state == Py_None) {
3143 Py_DECREF(state);
3144 return Py_BuildValue("(ON)", Py_TYPE(self), args);
3145 }
3146 else
3147 return Py_BuildValue("(ONN)", Py_TYPE(self), args, state);
Guido van Rossum177e41a2003-01-30 22:06:23 +00003148}
Tim Peters2a799bf2002-12-16 20:18:38 +00003149
3150static PyMethodDef tzinfo_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003151
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003152 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
3153 PyDoc_STR("datetime -> string name of time zone.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003155 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
Sean Reifscheiderdeda8cb2010-06-04 01:51:38 +00003156 PyDoc_STR("datetime -> timedelta showing offset from UTC, negative "
3157 "values indicating West of UTC")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003158
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003159 {"dst", (PyCFunction)tzinfo_dst, METH_O,
3160 PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003162 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
Alexander Belopolsky2f194b92010-07-03 03:35:27 +00003163 PyDoc_STR("datetime in UTC -> datetime in local time.")},
Tim Peters52dcce22003-01-23 16:36:11 +00003164
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003165 {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
3166 PyDoc_STR("-> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00003167
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003168 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003169};
3170
3171static char tzinfo_doc[] =
3172PyDoc_STR("Abstract base class for time zone info objects.");
3173
Neal Norwitz227b5332006-03-22 09:28:35 +00003174static PyTypeObject PyDateTime_TZInfoType = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003175 PyVarObject_HEAD_INIT(NULL, 0)
3176 "datetime.tzinfo", /* tp_name */
3177 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
3178 0, /* tp_itemsize */
3179 0, /* tp_dealloc */
3180 0, /* tp_print */
3181 0, /* tp_getattr */
3182 0, /* tp_setattr */
3183 0, /* tp_reserved */
3184 0, /* tp_repr */
3185 0, /* tp_as_number */
3186 0, /* tp_as_sequence */
3187 0, /* tp_as_mapping */
3188 0, /* tp_hash */
3189 0, /* tp_call */
3190 0, /* tp_str */
3191 PyObject_GenericGetAttr, /* tp_getattro */
3192 0, /* tp_setattro */
3193 0, /* tp_as_buffer */
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003194 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003195 tzinfo_doc, /* tp_doc */
3196 0, /* tp_traverse */
3197 0, /* tp_clear */
3198 0, /* tp_richcompare */
3199 0, /* tp_weaklistoffset */
3200 0, /* tp_iter */
3201 0, /* tp_iternext */
3202 tzinfo_methods, /* tp_methods */
3203 0, /* tp_members */
3204 0, /* tp_getset */
3205 0, /* tp_base */
3206 0, /* tp_dict */
3207 0, /* tp_descr_get */
3208 0, /* tp_descr_set */
3209 0, /* tp_dictoffset */
3210 0, /* tp_init */
3211 0, /* tp_alloc */
3212 PyType_GenericNew, /* tp_new */
3213 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00003214};
3215
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003216static char *timezone_kws[] = {"offset", "name", NULL};
3217
3218static PyObject *
3219timezone_new(PyTypeObject *type, PyObject *args, PyObject *kw)
3220{
3221 PyObject *offset;
3222 PyObject *name = NULL;
3223 if (PyArg_ParseTupleAndKeywords(args, kw, "O!|O!:timezone", timezone_kws,
3224 &PyDateTime_DeltaType, &offset,
3225 &PyUnicode_Type, &name))
3226 return new_timezone(offset, name);
3227
3228 return NULL;
3229}
3230
3231static void
3232timezone_dealloc(PyDateTime_TimeZone *self)
3233{
3234 Py_CLEAR(self->offset);
3235 Py_CLEAR(self->name);
3236 Py_TYPE(self)->tp_free((PyObject *)self);
3237}
3238
3239static PyObject *
3240timezone_richcompare(PyDateTime_TimeZone *self,
3241 PyDateTime_TimeZone *other, int op)
3242{
3243 if (op != Py_EQ && op != Py_NE) {
3244 Py_INCREF(Py_NotImplemented);
3245 return Py_NotImplemented;
3246 }
3247 return delta_richcompare(self->offset, other->offset, op);
3248}
3249
Benjamin Peterson8f67d082010-10-17 20:54:53 +00003250static Py_hash_t
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003251timezone_hash(PyDateTime_TimeZone *self)
3252{
3253 return delta_hash((PyDateTime_Delta *)self->offset);
3254}
3255
3256/* Check argument type passed to tzname, utcoffset, or dst methods.
3257 Returns 0 for good argument. Returns -1 and sets exception info
3258 otherwise.
3259 */
3260static int
3261_timezone_check_argument(PyObject *dt, const char *meth)
3262{
3263 if (dt == Py_None || PyDateTime_Check(dt))
3264 return 0;
3265 PyErr_Format(PyExc_TypeError, "%s(dt) argument must be a datetime instance"
3266 " or None, not %.200s", meth, Py_TYPE(dt)->tp_name);
3267 return -1;
3268}
3269
3270static PyObject *
Alexander Belopolskya11d8c02010-07-06 23:19:45 +00003271timezone_repr(PyDateTime_TimeZone *self)
3272{
3273 /* Note that although timezone is not subclassable, it is convenient
3274 to use Py_TYPE(self)->tp_name here. */
3275 const char *type_name = Py_TYPE(self)->tp_name;
3276
3277 if (((PyObject *)self) == PyDateTime_TimeZone_UTC)
3278 return PyUnicode_FromFormat("%s.utc", type_name);
3279
3280 if (self->name == NULL)
3281 return PyUnicode_FromFormat("%s(%R)", type_name, self->offset);
3282
3283 return PyUnicode_FromFormat("%s(%R, %R)", type_name, self->offset,
3284 self->name);
3285}
3286
3287
3288static PyObject *
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003289timezone_str(PyDateTime_TimeZone *self)
3290{
3291 char buf[10];
3292 int hours, minutes, seconds;
3293 PyObject *offset;
3294 char sign;
3295
3296 if (self->name != NULL) {
3297 Py_INCREF(self->name);
3298 return self->name;
3299 }
3300 /* Offset is normalized, so it is negative if days < 0 */
3301 if (GET_TD_DAYS(self->offset) < 0) {
3302 sign = '-';
3303 offset = delta_negative((PyDateTime_Delta *)self->offset);
3304 if (offset == NULL)
3305 return NULL;
3306 }
3307 else {
3308 sign = '+';
3309 offset = self->offset;
3310 Py_INCREF(offset);
3311 }
3312 /* Offset is not negative here. */
3313 seconds = GET_TD_SECONDS(offset);
3314 Py_DECREF(offset);
3315 minutes = divmod(seconds, 60, &seconds);
3316 hours = divmod(minutes, 60, &minutes);
3317 assert(seconds == 0);
3318 /* XXX ignore sub-minute data, curently not allowed. */
3319 PyOS_snprintf(buf, sizeof(buf), "UTC%c%02d:%02d", sign, hours, minutes);
3320
3321 return PyUnicode_FromString(buf);
3322}
3323
3324static PyObject *
3325timezone_tzname(PyDateTime_TimeZone *self, PyObject *dt)
3326{
3327 if (_timezone_check_argument(dt, "tzname") == -1)
3328 return NULL;
3329
3330 return timezone_str(self);
3331}
3332
3333static PyObject *
3334timezone_utcoffset(PyDateTime_TimeZone *self, PyObject *dt)
3335{
3336 if (_timezone_check_argument(dt, "utcoffset") == -1)
3337 return NULL;
3338
3339 Py_INCREF(self->offset);
3340 return self->offset;
3341}
3342
3343static PyObject *
3344timezone_dst(PyObject *self, PyObject *dt)
3345{
3346 if (_timezone_check_argument(dt, "dst") == -1)
3347 return NULL;
3348
3349 Py_RETURN_NONE;
3350}
3351
3352static PyObject *
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003353timezone_fromutc(PyDateTime_TimeZone *self, PyDateTime_DateTime *dt)
3354{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003355 if (!PyDateTime_Check(dt)) {
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003356 PyErr_SetString(PyExc_TypeError,
3357 "fromutc: argument must be a datetime");
3358 return NULL;
3359 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003360 if (!HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003361 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
3362 "is not self");
3363 return NULL;
3364 }
3365
3366 return add_datetime_timedelta(dt, (PyDateTime_Delta *)self->offset, 1);
3367}
3368
Alexander Belopolsky1b7046b2010-06-23 21:40:15 +00003369static PyObject *
3370timezone_getinitargs(PyDateTime_TimeZone *self)
3371{
3372 if (self->name == NULL)
3373 return Py_BuildValue("(O)", self->offset);
3374 return Py_BuildValue("(OO)", self->offset, self->name);
3375}
3376
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003377static PyMethodDef timezone_methods[] = {
3378 {"tzname", (PyCFunction)timezone_tzname, METH_O,
3379 PyDoc_STR("If name is specified when timezone is created, returns the name."
Alexander Belopolskyb39a0c22010-06-15 19:24:52 +00003380 " Otherwise returns offset as 'UTC(+|-)HH:MM'.")},
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003381
3382 {"utcoffset", (PyCFunction)timezone_utcoffset, METH_O,
Alexander Belopolskyb39a0c22010-06-15 19:24:52 +00003383 PyDoc_STR("Return fixed offset.")},
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003384
3385 {"dst", (PyCFunction)timezone_dst, METH_O,
Alexander Belopolskyb39a0c22010-06-15 19:24:52 +00003386 PyDoc_STR("Return None.")},
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003387
3388 {"fromutc", (PyCFunction)timezone_fromutc, METH_O,
3389 PyDoc_STR("datetime in UTC -> datetime in local time.")},
3390
Alexander Belopolsky1b7046b2010-06-23 21:40:15 +00003391 {"__getinitargs__", (PyCFunction)timezone_getinitargs, METH_NOARGS,
3392 PyDoc_STR("pickle support")},
3393
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003394 {NULL, NULL}
3395};
3396
3397static char timezone_doc[] =
3398PyDoc_STR("Fixed offset from UTC implementation of tzinfo.");
3399
3400static PyTypeObject PyDateTime_TimeZoneType = {
3401 PyVarObject_HEAD_INIT(NULL, 0)
3402 "datetime.timezone", /* tp_name */
3403 sizeof(PyDateTime_TimeZone), /* tp_basicsize */
3404 0, /* tp_itemsize */
3405 (destructor)timezone_dealloc, /* tp_dealloc */
3406 0, /* tp_print */
3407 0, /* tp_getattr */
3408 0, /* tp_setattr */
3409 0, /* tp_reserved */
Alexander Belopolskya11d8c02010-07-06 23:19:45 +00003410 (reprfunc)timezone_repr, /* tp_repr */
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003411 0, /* tp_as_number */
3412 0, /* tp_as_sequence */
3413 0, /* tp_as_mapping */
3414 (hashfunc)timezone_hash, /* tp_hash */
3415 0, /* tp_call */
3416 (reprfunc)timezone_str, /* tp_str */
3417 0, /* tp_getattro */
3418 0, /* tp_setattro */
3419 0, /* tp_as_buffer */
3420 Py_TPFLAGS_DEFAULT, /* tp_flags */
3421 timezone_doc, /* tp_doc */
3422 0, /* tp_traverse */
3423 0, /* tp_clear */
3424 (richcmpfunc)timezone_richcompare,/* tp_richcompare */
3425 0, /* tp_weaklistoffset */
3426 0, /* tp_iter */
3427 0, /* tp_iternext */
3428 timezone_methods, /* tp_methods */
3429 0, /* tp_members */
3430 0, /* tp_getset */
3431 &PyDateTime_TZInfoType, /* tp_base */
3432 0, /* tp_dict */
3433 0, /* tp_descr_get */
3434 0, /* tp_descr_set */
3435 0, /* tp_dictoffset */
3436 0, /* tp_init */
3437 0, /* tp_alloc */
3438 timezone_new, /* tp_new */
3439};
3440
Tim Peters2a799bf2002-12-16 20:18:38 +00003441/*
Tim Peters37f39822003-01-10 03:49:02 +00003442 * PyDateTime_Time implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003443 */
3444
Tim Peters37f39822003-01-10 03:49:02 +00003445/* Accessor properties.
Tim Peters2a799bf2002-12-16 20:18:38 +00003446 */
3447
3448static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003449time_hour(PyDateTime_Time *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003450{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003451 return PyLong_FromLong(TIME_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003452}
3453
Tim Peters37f39822003-01-10 03:49:02 +00003454static PyObject *
3455time_minute(PyDateTime_Time *self, void *unused)
3456{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003457 return PyLong_FromLong(TIME_GET_MINUTE(self));
Tim Peters37f39822003-01-10 03:49:02 +00003458}
3459
3460/* The name time_second conflicted with some platform header file. */
3461static PyObject *
3462py_time_second(PyDateTime_Time *self, void *unused)
3463{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003464 return PyLong_FromLong(TIME_GET_SECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003465}
3466
3467static PyObject *
3468time_microsecond(PyDateTime_Time *self, void *unused)
3469{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003470 return PyLong_FromLong(TIME_GET_MICROSECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003471}
3472
3473static PyObject *
3474time_tzinfo(PyDateTime_Time *self, void *unused)
3475{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003476 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3477 Py_INCREF(result);
3478 return result;
Tim Peters37f39822003-01-10 03:49:02 +00003479}
3480
3481static PyGetSetDef time_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003482 {"hour", (getter)time_hour},
3483 {"minute", (getter)time_minute},
3484 {"second", (getter)py_time_second},
3485 {"microsecond", (getter)time_microsecond},
3486 {"tzinfo", (getter)time_tzinfo},
3487 {NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003488};
3489
3490/*
3491 * Constructors.
3492 */
3493
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003494static char *time_kws[] = {"hour", "minute", "second", "microsecond",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003495 "tzinfo", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00003496
Tim Peters2a799bf2002-12-16 20:18:38 +00003497static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003498time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003499{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003500 PyObject *self = NULL;
3501 PyObject *state;
3502 int hour = 0;
3503 int minute = 0;
3504 int second = 0;
3505 int usecond = 0;
3506 PyObject *tzinfo = Py_None;
Tim Peters2a799bf2002-12-16 20:18:38 +00003507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003508 /* Check for invocation from pickle with __getstate__ state */
3509 if (PyTuple_GET_SIZE(args) >= 1 &&
3510 PyTuple_GET_SIZE(args) <= 2 &&
3511 PyBytes_Check(state = PyTuple_GET_ITEM(args, 0)) &&
3512 PyBytes_GET_SIZE(state) == _PyDateTime_TIME_DATASIZE &&
3513 ((unsigned char) (PyBytes_AS_STRING(state)[0])) < 24)
3514 {
3515 PyDateTime_Time *me;
3516 char aware;
Tim Peters70533e22003-02-01 04:40:04 +00003517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003518 if (PyTuple_GET_SIZE(args) == 2) {
3519 tzinfo = PyTuple_GET_ITEM(args, 1);
3520 if (check_tzinfo_subclass(tzinfo) < 0) {
3521 PyErr_SetString(PyExc_TypeError, "bad "
3522 "tzinfo state arg");
3523 return NULL;
3524 }
3525 }
3526 aware = (char)(tzinfo != Py_None);
3527 me = (PyDateTime_Time *) (type->tp_alloc(type, aware));
3528 if (me != NULL) {
3529 char *pdata = PyBytes_AS_STRING(state);
Tim Peters70533e22003-02-01 04:40:04 +00003530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003531 memcpy(me->data, pdata, _PyDateTime_TIME_DATASIZE);
3532 me->hashcode = -1;
3533 me->hastzinfo = aware;
3534 if (aware) {
3535 Py_INCREF(tzinfo);
3536 me->tzinfo = tzinfo;
3537 }
3538 }
3539 return (PyObject *)me;
3540 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00003541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003542 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO", time_kws,
3543 &hour, &minute, &second, &usecond,
3544 &tzinfo)) {
3545 if (check_time_args(hour, minute, second, usecond) < 0)
3546 return NULL;
3547 if (check_tzinfo_subclass(tzinfo) < 0)
3548 return NULL;
3549 self = new_time_ex(hour, minute, second, usecond, tzinfo,
3550 type);
3551 }
3552 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003553}
3554
3555/*
3556 * Destructor.
3557 */
3558
3559static void
Tim Peters37f39822003-01-10 03:49:02 +00003560time_dealloc(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003561{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003562 if (HASTZINFO(self)) {
3563 Py_XDECREF(self->tzinfo);
3564 }
3565 Py_TYPE(self)->tp_free((PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003566}
3567
3568/*
Tim Peters855fe882002-12-22 03:43:39 +00003569 * Indirect access to tzinfo methods.
Tim Peters2a799bf2002-12-16 20:18:38 +00003570 */
3571
Tim Peters2a799bf2002-12-16 20:18:38 +00003572/* These are all METH_NOARGS, so don't need to check the arglist. */
3573static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003574time_utcoffset(PyObject *self, PyObject *unused) {
3575 return call_utcoffset(GET_TIME_TZINFO(self), Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003576}
3577
3578static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003579time_dst(PyObject *self, PyObject *unused) {
3580 return call_dst(GET_TIME_TZINFO(self), Py_None);
Tim Peters855fe882002-12-22 03:43:39 +00003581}
3582
3583static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003584time_tzname(PyDateTime_Time *self, PyObject *unused) {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003585 return call_tzname(GET_TIME_TZINFO(self), Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003586}
3587
3588/*
Tim Peters37f39822003-01-10 03:49:02 +00003589 * Various ways to turn a time into a string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003590 */
3591
3592static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003593time_repr(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003594{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003595 const char *type_name = Py_TYPE(self)->tp_name;
3596 int h = TIME_GET_HOUR(self);
3597 int m = TIME_GET_MINUTE(self);
3598 int s = TIME_GET_SECOND(self);
3599 int us = TIME_GET_MICROSECOND(self);
3600 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003601
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003602 if (us)
3603 result = PyUnicode_FromFormat("%s(%d, %d, %d, %d)",
3604 type_name, h, m, s, us);
3605 else if (s)
3606 result = PyUnicode_FromFormat("%s(%d, %d, %d)",
3607 type_name, h, m, s);
3608 else
3609 result = PyUnicode_FromFormat("%s(%d, %d)", type_name, h, m);
3610 if (result != NULL && HASTZINFO(self))
3611 result = append_keyword_tzinfo(result, self->tzinfo);
3612 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003613}
3614
Tim Peters37f39822003-01-10 03:49:02 +00003615static PyObject *
3616time_str(PyDateTime_Time *self)
3617{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003618 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
Tim Peters37f39822003-01-10 03:49:02 +00003619}
Tim Peters2a799bf2002-12-16 20:18:38 +00003620
3621static PyObject *
Thomas Wouterscf297e42007-02-23 15:07:44 +00003622time_isoformat(PyDateTime_Time *self, PyObject *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003623{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003624 char buf[100];
3625 PyObject *result;
3626 int us = TIME_GET_MICROSECOND(self);;
Tim Peters2a799bf2002-12-16 20:18:38 +00003627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003628 if (us)
3629 result = PyUnicode_FromFormat("%02d:%02d:%02d.%06d",
3630 TIME_GET_HOUR(self),
3631 TIME_GET_MINUTE(self),
3632 TIME_GET_SECOND(self),
3633 us);
3634 else
3635 result = PyUnicode_FromFormat("%02d:%02d:%02d",
3636 TIME_GET_HOUR(self),
3637 TIME_GET_MINUTE(self),
3638 TIME_GET_SECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003639
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003640 if (result == NULL || !HASTZINFO(self) || self->tzinfo == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003641 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003642
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003643 /* We need to append the UTC offset. */
3644 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
3645 Py_None) < 0) {
3646 Py_DECREF(result);
3647 return NULL;
3648 }
3649 PyUnicode_AppendAndDel(&result, PyUnicode_FromString(buf));
3650 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003651}
3652
Tim Peters37f39822003-01-10 03:49:02 +00003653static PyObject *
3654time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3655{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003656 PyObject *result;
3657 PyObject *tuple;
3658 PyObject *format;
3659 static char *keywords[] = {"format", NULL};
Tim Peters37f39822003-01-10 03:49:02 +00003660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003661 if (! PyArg_ParseTupleAndKeywords(args, kw, "U:strftime", keywords,
3662 &format))
3663 return NULL;
Tim Peters37f39822003-01-10 03:49:02 +00003664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003665 /* Python's strftime does insane things with the year part of the
3666 * timetuple. The year is forced to (the otherwise nonsensical)
Alexander Belopolskyb8bb4662011-01-08 00:13:34 +00003667 * 1900 to work around that.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003668 */
3669 tuple = Py_BuildValue("iiiiiiiii",
3670 1900, 1, 1, /* year, month, day */
3671 TIME_GET_HOUR(self),
3672 TIME_GET_MINUTE(self),
3673 TIME_GET_SECOND(self),
3674 0, 1, -1); /* weekday, daynum, dst */
3675 if (tuple == NULL)
3676 return NULL;
3677 assert(PyTuple_Size(tuple) == 9);
3678 result = wrap_strftime((PyObject *)self, format, tuple,
3679 Py_None);
3680 Py_DECREF(tuple);
3681 return result;
Tim Peters37f39822003-01-10 03:49:02 +00003682}
Tim Peters2a799bf2002-12-16 20:18:38 +00003683
3684/*
3685 * Miscellaneous methods.
3686 */
3687
Tim Peters37f39822003-01-10 03:49:02 +00003688static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00003689time_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters37f39822003-01-10 03:49:02 +00003690{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003691 PyObject *result = NULL;
3692 PyObject *offset1, *offset2;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003693 int diff;
Tim Peters37f39822003-01-10 03:49:02 +00003694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003695 if (! PyTime_Check(other)) {
3696 Py_INCREF(Py_NotImplemented);
3697 return Py_NotImplemented;
3698 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003699
3700 if (GET_TIME_TZINFO(self) == GET_TIME_TZINFO(other)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003701 diff = memcmp(((PyDateTime_Time *)self)->data,
3702 ((PyDateTime_Time *)other)->data,
3703 _PyDateTime_TIME_DATASIZE);
3704 return diff_to_bool(diff, op);
3705 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003706 offset1 = time_utcoffset(self, NULL);
3707 if (offset1 == NULL)
3708 return NULL;
3709 offset2 = time_utcoffset(other, NULL);
3710 if (offset2 == NULL)
3711 goto done;
3712 /* If they're both naive, or both aware and have the same offsets,
3713 * we get off cheap. Note that if they're both naive, offset1 ==
3714 * offset2 == Py_None at this point.
3715 */
3716 if ((offset1 == offset2) ||
3717 (PyDelta_Check(offset1) && PyDelta_Check(offset2) &&
3718 delta_cmp(offset1, offset2) == 0)) {
3719 diff = memcmp(((PyDateTime_Time *)self)->data,
3720 ((PyDateTime_Time *)other)->data,
3721 _PyDateTime_TIME_DATASIZE);
3722 result = diff_to_bool(diff, op);
3723 }
3724 /* The hard case: both aware with different UTC offsets */
3725 else if (offset1 != Py_None && offset2 != Py_None) {
3726 int offsecs1, offsecs2;
3727 assert(offset1 != offset2); /* else last "if" handled it */
3728 offsecs1 = TIME_GET_HOUR(self) * 3600 +
3729 TIME_GET_MINUTE(self) * 60 +
3730 TIME_GET_SECOND(self) -
3731 GET_TD_DAYS(offset1) * 86400 -
3732 GET_TD_SECONDS(offset1);
3733 offsecs2 = TIME_GET_HOUR(other) * 3600 +
3734 TIME_GET_MINUTE(other) * 60 +
3735 TIME_GET_SECOND(other) -
3736 GET_TD_DAYS(offset2) * 86400 -
3737 GET_TD_SECONDS(offset2);
3738 diff = offsecs1 - offsecs2;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003739 if (diff == 0)
3740 diff = TIME_GET_MICROSECOND(self) -
3741 TIME_GET_MICROSECOND(other);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003742 result = diff_to_bool(diff, op);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003743 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003744 else {
3745 PyErr_SetString(PyExc_TypeError,
3746 "can't compare offset-naive and "
3747 "offset-aware times");
3748 }
3749 done:
3750 Py_DECREF(offset1);
3751 Py_XDECREF(offset2);
3752 return result;
Tim Peters37f39822003-01-10 03:49:02 +00003753}
3754
Benjamin Peterson8f67d082010-10-17 20:54:53 +00003755static Py_hash_t
Tim Peters37f39822003-01-10 03:49:02 +00003756time_hash(PyDateTime_Time *self)
3757{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003758 if (self->hashcode == -1) {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003759 PyObject *offset;
Tim Peters37f39822003-01-10 03:49:02 +00003760
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003761 offset = time_utcoffset((PyObject *)self, NULL);
3762
3763 if (offset == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003764 return -1;
Tim Peters37f39822003-01-10 03:49:02 +00003765
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003766 /* Reduce this to a hash of another object. */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003767 if (offset == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003768 self->hashcode = generic_hash(
3769 (unsigned char *)self->data, _PyDateTime_TIME_DATASIZE);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003770 else {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003771 PyObject *temp1, *temp2;
3772 int seconds, microseconds;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003773 assert(HASTZINFO(self));
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003774 seconds = TIME_GET_HOUR(self) * 3600 +
3775 TIME_GET_MINUTE(self) * 60 +
3776 TIME_GET_SECOND(self);
3777 microseconds = TIME_GET_MICROSECOND(self);
3778 temp1 = new_delta(0, seconds, microseconds, 1);
3779 if (temp1 == NULL) {
3780 Py_DECREF(offset);
3781 return -1;
3782 }
3783 temp2 = delta_subtract(temp1, offset);
3784 Py_DECREF(temp1);
3785 if (temp2 == NULL) {
3786 Py_DECREF(offset);
3787 return -1;
3788 }
3789 self->hashcode = PyObject_Hash(temp2);
3790 Py_DECREF(temp2);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003791 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003792 Py_DECREF(offset);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003793 }
3794 return self->hashcode;
Tim Peters37f39822003-01-10 03:49:02 +00003795}
Tim Peters2a799bf2002-12-16 20:18:38 +00003796
Tim Peters12bf3392002-12-24 05:41:27 +00003797static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003798time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00003799{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003800 PyObject *clone;
3801 PyObject *tuple;
3802 int hh = TIME_GET_HOUR(self);
3803 int mm = TIME_GET_MINUTE(self);
3804 int ss = TIME_GET_SECOND(self);
3805 int us = TIME_GET_MICROSECOND(self);
3806 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00003807
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003808 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO:replace",
3809 time_kws,
3810 &hh, &mm, &ss, &us, &tzinfo))
3811 return NULL;
3812 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
3813 if (tuple == NULL)
3814 return NULL;
3815 clone = time_new(Py_TYPE(self), tuple, NULL);
3816 Py_DECREF(tuple);
3817 return clone;
Tim Peters12bf3392002-12-24 05:41:27 +00003818}
3819
Tim Peters2a799bf2002-12-16 20:18:38 +00003820static int
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003821time_bool(PyObject *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003822{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003823 PyObject *offset, *tzinfo;
3824 int offsecs = 0;
Tim Peters2a799bf2002-12-16 20:18:38 +00003825
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003826 if (TIME_GET_SECOND(self) || TIME_GET_MICROSECOND(self)) {
3827 /* Since utcoffset is in whole minutes, nothing can
3828 * alter the conclusion that this is nonzero.
3829 */
3830 return 1;
3831 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003832 tzinfo = GET_TIME_TZINFO(self);
3833 if (tzinfo != Py_None) {
3834 offset = call_utcoffset(tzinfo, Py_None);
3835 if (offset == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003836 return -1;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003837 offsecs = GET_TD_DAYS(offset)*86400 + GET_TD_SECONDS(offset);
3838 Py_DECREF(offset);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003839 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003840 return (TIME_GET_MINUTE(self)*60 - offsecs + TIME_GET_HOUR(self)*3600) != 0;
Tim Peters2a799bf2002-12-16 20:18:38 +00003841}
3842
Tim Peters371935f2003-02-01 01:52:50 +00003843/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003844
Tim Peters33e0f382003-01-10 02:05:14 +00003845/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003846 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
3847 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00003848 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00003849 */
3850static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003851time_getstate(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003852{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003853 PyObject *basestate;
3854 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003855
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003856 basestate = PyBytes_FromStringAndSize((char *)self->data,
3857 _PyDateTime_TIME_DATASIZE);
3858 if (basestate != NULL) {
3859 if (! HASTZINFO(self) || self->tzinfo == Py_None)
3860 result = PyTuple_Pack(1, basestate);
3861 else
3862 result = PyTuple_Pack(2, basestate, self->tzinfo);
3863 Py_DECREF(basestate);
3864 }
3865 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003866}
3867
3868static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00003869time_reduce(PyDateTime_Time *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00003870{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003871 return Py_BuildValue("(ON)", Py_TYPE(self), time_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003872}
3873
Tim Peters37f39822003-01-10 03:49:02 +00003874static PyMethodDef time_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003875
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003876 {"isoformat", (PyCFunction)time_isoformat, METH_NOARGS,
3877 PyDoc_STR("Return string in ISO 8601 format, HH:MM:SS[.mmmmmm]"
3878 "[+HH:MM].")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003880 {"strftime", (PyCFunction)time_strftime, METH_VARARGS | METH_KEYWORDS,
3881 PyDoc_STR("format -> strftime() style string.")},
Tim Peters37f39822003-01-10 03:49:02 +00003882
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003883 {"__format__", (PyCFunction)date_format, METH_VARARGS,
3884 PyDoc_STR("Formats self with strftime.")},
Eric Smith1ba31142007-09-11 18:06:02 +00003885
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003886 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
3887 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003888
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003889 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
3890 PyDoc_STR("Return self.tzinfo.tzname(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003891
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003892 {"dst", (PyCFunction)time_dst, METH_NOARGS,
3893 PyDoc_STR("Return self.tzinfo.dst(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003894
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003895 {"replace", (PyCFunction)time_replace, METH_VARARGS | METH_KEYWORDS,
3896 PyDoc_STR("Return time with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00003897
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003898 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
3899 PyDoc_STR("__reduce__() -> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00003900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003901 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003902};
3903
Tim Peters37f39822003-01-10 03:49:02 +00003904static char time_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00003905PyDoc_STR("time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object\n\
3906\n\
3907All arguments are optional. tzinfo may be None, or an instance of\n\
3908a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00003909
Tim Peters37f39822003-01-10 03:49:02 +00003910static PyNumberMethods time_as_number = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003911 0, /* nb_add */
3912 0, /* nb_subtract */
3913 0, /* nb_multiply */
3914 0, /* nb_remainder */
3915 0, /* nb_divmod */
3916 0, /* nb_power */
3917 0, /* nb_negative */
3918 0, /* nb_positive */
3919 0, /* nb_absolute */
3920 (inquiry)time_bool, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00003921};
3922
Neal Norwitz227b5332006-03-22 09:28:35 +00003923static PyTypeObject PyDateTime_TimeType = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003924 PyVarObject_HEAD_INIT(NULL, 0)
3925 "datetime.time", /* tp_name */
3926 sizeof(PyDateTime_Time), /* tp_basicsize */
3927 0, /* tp_itemsize */
3928 (destructor)time_dealloc, /* tp_dealloc */
3929 0, /* tp_print */
3930 0, /* tp_getattr */
3931 0, /* tp_setattr */
3932 0, /* tp_reserved */
3933 (reprfunc)time_repr, /* tp_repr */
3934 &time_as_number, /* tp_as_number */
3935 0, /* tp_as_sequence */
3936 0, /* tp_as_mapping */
3937 (hashfunc)time_hash, /* tp_hash */
3938 0, /* tp_call */
3939 (reprfunc)time_str, /* tp_str */
3940 PyObject_GenericGetAttr, /* tp_getattro */
3941 0, /* tp_setattro */
3942 0, /* tp_as_buffer */
3943 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
3944 time_doc, /* tp_doc */
3945 0, /* tp_traverse */
3946 0, /* tp_clear */
3947 time_richcompare, /* tp_richcompare */
3948 0, /* tp_weaklistoffset */
3949 0, /* tp_iter */
3950 0, /* tp_iternext */
3951 time_methods, /* tp_methods */
3952 0, /* tp_members */
3953 time_getset, /* tp_getset */
3954 0, /* tp_base */
3955 0, /* tp_dict */
3956 0, /* tp_descr_get */
3957 0, /* tp_descr_set */
3958 0, /* tp_dictoffset */
3959 0, /* tp_init */
3960 time_alloc, /* tp_alloc */
3961 time_new, /* tp_new */
3962 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00003963};
3964
3965/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003966 * PyDateTime_DateTime implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003967 */
3968
Tim Petersa9bc1682003-01-11 03:39:11 +00003969/* Accessor properties. Properties for day, month, and year are inherited
3970 * from date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003971 */
3972
3973static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003974datetime_hour(PyDateTime_DateTime *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003975{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003976 return PyLong_FromLong(DATE_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003977}
3978
Tim Petersa9bc1682003-01-11 03:39:11 +00003979static PyObject *
3980datetime_minute(PyDateTime_DateTime *self, void *unused)
3981{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003982 return PyLong_FromLong(DATE_GET_MINUTE(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00003983}
3984
3985static PyObject *
3986datetime_second(PyDateTime_DateTime *self, void *unused)
3987{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003988 return PyLong_FromLong(DATE_GET_SECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00003989}
3990
3991static PyObject *
3992datetime_microsecond(PyDateTime_DateTime *self, void *unused)
3993{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003994 return PyLong_FromLong(DATE_GET_MICROSECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00003995}
3996
3997static PyObject *
3998datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
3999{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004000 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
4001 Py_INCREF(result);
4002 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00004003}
4004
4005static PyGetSetDef datetime_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004006 {"hour", (getter)datetime_hour},
4007 {"minute", (getter)datetime_minute},
4008 {"second", (getter)datetime_second},
4009 {"microsecond", (getter)datetime_microsecond},
4010 {"tzinfo", (getter)datetime_tzinfo},
4011 {NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00004012};
4013
4014/*
4015 * Constructors.
Tim Peters2a799bf2002-12-16 20:18:38 +00004016 */
4017
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004018static char *datetime_kws[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004019 "year", "month", "day", "hour", "minute", "second",
4020 "microsecond", "tzinfo", NULL
Tim Peters12bf3392002-12-24 05:41:27 +00004021};
4022
Tim Peters2a799bf2002-12-16 20:18:38 +00004023static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004024datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004025{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004026 PyObject *self = NULL;
4027 PyObject *state;
4028 int year;
4029 int month;
4030 int day;
4031 int hour = 0;
4032 int minute = 0;
4033 int second = 0;
4034 int usecond = 0;
4035 PyObject *tzinfo = Py_None;
Tim Peters2a799bf2002-12-16 20:18:38 +00004036
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004037 /* Check for invocation from pickle with __getstate__ state */
4038 if (PyTuple_GET_SIZE(args) >= 1 &&
4039 PyTuple_GET_SIZE(args) <= 2 &&
4040 PyBytes_Check(state = PyTuple_GET_ITEM(args, 0)) &&
4041 PyBytes_GET_SIZE(state) == _PyDateTime_DATETIME_DATASIZE &&
4042 MONTH_IS_SANE(PyBytes_AS_STRING(state)[2]))
4043 {
4044 PyDateTime_DateTime *me;
4045 char aware;
Tim Peters70533e22003-02-01 04:40:04 +00004046
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004047 if (PyTuple_GET_SIZE(args) == 2) {
4048 tzinfo = PyTuple_GET_ITEM(args, 1);
4049 if (check_tzinfo_subclass(tzinfo) < 0) {
4050 PyErr_SetString(PyExc_TypeError, "bad "
4051 "tzinfo state arg");
4052 return NULL;
4053 }
4054 }
4055 aware = (char)(tzinfo != Py_None);
4056 me = (PyDateTime_DateTime *) (type->tp_alloc(type , aware));
4057 if (me != NULL) {
4058 char *pdata = PyBytes_AS_STRING(state);
Tim Peters70533e22003-02-01 04:40:04 +00004059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004060 memcpy(me->data, pdata, _PyDateTime_DATETIME_DATASIZE);
4061 me->hashcode = -1;
4062 me->hastzinfo = aware;
4063 if (aware) {
4064 Py_INCREF(tzinfo);
4065 me->tzinfo = tzinfo;
4066 }
4067 }
4068 return (PyObject *)me;
4069 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00004070
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004071 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO", datetime_kws,
4072 &year, &month, &day, &hour, &minute,
4073 &second, &usecond, &tzinfo)) {
4074 if (check_date_args(year, month, day) < 0)
4075 return NULL;
4076 if (check_time_args(hour, minute, second, usecond) < 0)
4077 return NULL;
4078 if (check_tzinfo_subclass(tzinfo) < 0)
4079 return NULL;
4080 self = new_datetime_ex(year, month, day,
4081 hour, minute, second, usecond,
4082 tzinfo, type);
4083 }
4084 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00004085}
4086
Tim Petersa9bc1682003-01-11 03:39:11 +00004087/* TM_FUNC is the shared type of localtime() and gmtime(). */
4088typedef struct tm *(*TM_FUNC)(const time_t *timer);
4089
4090/* Internal helper.
4091 * Build datetime from a time_t and a distinct count of microseconds.
4092 * Pass localtime or gmtime for f, to control the interpretation of timet.
4093 */
4094static PyObject *
4095datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004096 PyObject *tzinfo)
Tim Petersa9bc1682003-01-11 03:39:11 +00004097{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004098 struct tm *tm;
4099 PyObject *result = NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00004100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004101 tm = f(&timet);
4102 if (tm) {
4103 /* The platform localtime/gmtime may insert leap seconds,
4104 * indicated by tm->tm_sec > 59. We don't care about them,
4105 * except to the extent that passing them on to the datetime
4106 * constructor would raise ValueError for a reason that
4107 * made no sense to the user.
4108 */
4109 if (tm->tm_sec > 59)
4110 tm->tm_sec = 59;
4111 result = PyObject_CallFunction(cls, "iiiiiiiO",
4112 tm->tm_year + 1900,
4113 tm->tm_mon + 1,
4114 tm->tm_mday,
4115 tm->tm_hour,
4116 tm->tm_min,
4117 tm->tm_sec,
4118 us,
4119 tzinfo);
4120 }
4121 else
4122 PyErr_SetString(PyExc_ValueError,
4123 "timestamp out of range for "
4124 "platform localtime()/gmtime() function");
4125 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00004126}
4127
4128/* Internal helper.
4129 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
4130 * to control the interpretation of the timestamp. Since a double doesn't
4131 * have enough bits to cover a datetime's full range of precision, it's
4132 * better to call datetime_from_timet_and_us provided you have a way
4133 * to get that much precision (e.g., C time() isn't good enough).
4134 */
4135static PyObject *
4136datetime_from_timestamp(PyObject *cls, TM_FUNC f, double timestamp,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004137 PyObject *tzinfo)
Tim Petersa9bc1682003-01-11 03:39:11 +00004138{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004139 time_t timet;
4140 double fraction;
4141 int us;
Tim Petersa9bc1682003-01-11 03:39:11 +00004142
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004143 timet = _PyTime_DoubleToTimet(timestamp);
4144 if (timet == (time_t)-1 && PyErr_Occurred())
4145 return NULL;
4146 fraction = timestamp - (double)timet;
4147 us = (int)round_to_long(fraction * 1e6);
4148 if (us < 0) {
4149 /* Truncation towards zero is not what we wanted
4150 for negative numbers (Python's mod semantics) */
4151 timet -= 1;
4152 us += 1000000;
4153 }
4154 /* If timestamp is less than one microsecond smaller than a
4155 * full second, round up. Otherwise, ValueErrors are raised
4156 * for some floats. */
4157 if (us == 1000000) {
4158 timet += 1;
4159 us = 0;
4160 }
4161 return datetime_from_timet_and_us(cls, f, timet, us, tzinfo);
Tim Petersa9bc1682003-01-11 03:39:11 +00004162}
4163
4164/* Internal helper.
4165 * Build most accurate possible datetime for current time. Pass localtime or
4166 * gmtime for f as appropriate.
4167 */
4168static PyObject *
4169datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
4170{
Alexander Belopolsky6fc4ade2010-08-05 17:34:27 +00004171 _PyTime_timeval t;
4172 _PyTime_gettimeofday(&t);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004173 return datetime_from_timet_and_us(cls, f, t.tv_sec, (int)t.tv_usec,
4174 tzinfo);
Tim Petersa9bc1682003-01-11 03:39:11 +00004175}
4176
Tim Peters2a799bf2002-12-16 20:18:38 +00004177/* Return best possible local time -- this isn't constrained by the
4178 * precision of a timestamp.
4179 */
4180static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004181datetime_now(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004182{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004183 PyObject *self;
4184 PyObject *tzinfo = Py_None;
4185 static char *keywords[] = {"tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00004186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004187 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:now", keywords,
4188 &tzinfo))
4189 return NULL;
4190 if (check_tzinfo_subclass(tzinfo) < 0)
4191 return NULL;
Tim Peters10cadce2003-01-23 19:58:02 +00004192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004193 self = datetime_best_possible(cls,
4194 tzinfo == Py_None ? localtime : gmtime,
4195 tzinfo);
4196 if (self != NULL && tzinfo != Py_None) {
4197 /* Convert UTC to tzinfo's zone. */
4198 PyObject *temp = self;
4199 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
4200 Py_DECREF(temp);
4201 }
4202 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00004203}
4204
Tim Petersa9bc1682003-01-11 03:39:11 +00004205/* Return best possible UTC time -- this isn't constrained by the
4206 * precision of a timestamp.
4207 */
4208static PyObject *
4209datetime_utcnow(PyObject *cls, PyObject *dummy)
4210{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004211 return datetime_best_possible(cls, gmtime, Py_None);
Tim Petersa9bc1682003-01-11 03:39:11 +00004212}
4213
Tim Peters2a799bf2002-12-16 20:18:38 +00004214/* Return new local datetime from timestamp (Python timestamp -- a double). */
4215static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004216datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004217{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004218 PyObject *self;
4219 double timestamp;
4220 PyObject *tzinfo = Py_None;
4221 static char *keywords[] = {"timestamp", "tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00004222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004223 if (! PyArg_ParseTupleAndKeywords(args, kw, "d|O:fromtimestamp",
4224 keywords, &timestamp, &tzinfo))
4225 return NULL;
4226 if (check_tzinfo_subclass(tzinfo) < 0)
4227 return NULL;
Tim Peters2a44a8d2003-01-23 20:53:10 +00004228
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004229 self = datetime_from_timestamp(cls,
4230 tzinfo == Py_None ? localtime : gmtime,
4231 timestamp,
4232 tzinfo);
4233 if (self != NULL && tzinfo != Py_None) {
4234 /* Convert UTC to tzinfo's zone. */
4235 PyObject *temp = self;
4236 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
4237 Py_DECREF(temp);
4238 }
4239 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00004240}
4241
Tim Petersa9bc1682003-01-11 03:39:11 +00004242/* Return new UTC datetime from timestamp (Python timestamp -- a double). */
4243static PyObject *
4244datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
4245{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004246 double timestamp;
4247 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004249 if (PyArg_ParseTuple(args, "d:utcfromtimestamp", &timestamp))
4250 result = datetime_from_timestamp(cls, gmtime, timestamp,
4251 Py_None);
4252 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00004253}
4254
Alexander Belopolskyca94f552010-06-17 18:30:34 +00004255/* Return new datetime from _strptime.strptime_datetime(). */
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004256static PyObject *
4257datetime_strptime(PyObject *cls, PyObject *args)
4258{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004259 static PyObject *module = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004260 const Py_UNICODE *string, *format;
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004261
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004262 if (!PyArg_ParseTuple(args, "uu:strptime", &string, &format))
4263 return NULL;
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004264
Alexander Belopolskyca94f552010-06-17 18:30:34 +00004265 if (module == NULL) {
4266 module = PyImport_ImportModuleNoBlock("_strptime");
Alexander Belopolsky311d2a92010-06-28 14:36:55 +00004267 if (module == NULL)
Alexander Belopolskyca94f552010-06-17 18:30:34 +00004268 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004269 }
Alexander Belopolskyf5682182010-06-18 18:44:37 +00004270 return PyObject_CallMethod(module, "_strptime_datetime", "Ouu",
4271 cls, string, format);
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004272}
4273
Tim Petersa9bc1682003-01-11 03:39:11 +00004274/* Return new datetime from date/datetime and time arguments. */
4275static PyObject *
4276datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
4277{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004278 static char *keywords[] = {"date", "time", NULL};
4279 PyObject *date;
4280 PyObject *time;
4281 PyObject *result = NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00004282
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004283 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!:combine", keywords,
4284 &PyDateTime_DateType, &date,
4285 &PyDateTime_TimeType, &time)) {
4286 PyObject *tzinfo = Py_None;
Tim Petersa9bc1682003-01-11 03:39:11 +00004287
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004288 if (HASTZINFO(time))
4289 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
4290 result = PyObject_CallFunction(cls, "iiiiiiiO",
4291 GET_YEAR(date),
4292 GET_MONTH(date),
4293 GET_DAY(date),
4294 TIME_GET_HOUR(time),
4295 TIME_GET_MINUTE(time),
4296 TIME_GET_SECOND(time),
4297 TIME_GET_MICROSECOND(time),
4298 tzinfo);
4299 }
4300 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00004301}
Tim Peters2a799bf2002-12-16 20:18:38 +00004302
4303/*
4304 * Destructor.
4305 */
4306
4307static void
Tim Petersa9bc1682003-01-11 03:39:11 +00004308datetime_dealloc(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004309{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004310 if (HASTZINFO(self)) {
4311 Py_XDECREF(self->tzinfo);
4312 }
4313 Py_TYPE(self)->tp_free((PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00004314}
4315
4316/*
4317 * Indirect access to tzinfo methods.
4318 */
4319
Tim Peters2a799bf2002-12-16 20:18:38 +00004320/* These are all METH_NOARGS, so don't need to check the arglist. */
4321static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004322datetime_utcoffset(PyObject *self, PyObject *unused) {
4323 return call_utcoffset(GET_DT_TZINFO(self), self);
Tim Peters2a799bf2002-12-16 20:18:38 +00004324}
4325
4326static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004327datetime_dst(PyObject *self, PyObject *unused) {
4328 return call_dst(GET_DT_TZINFO(self), self);
Tim Peters855fe882002-12-22 03:43:39 +00004329}
4330
4331static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004332datetime_tzname(PyObject *self, PyObject *unused) {
4333 return call_tzname(GET_DT_TZINFO(self), self);
Tim Peters2a799bf2002-12-16 20:18:38 +00004334}
4335
4336/*
Tim Petersa9bc1682003-01-11 03:39:11 +00004337 * datetime arithmetic.
Tim Peters2a799bf2002-12-16 20:18:38 +00004338 */
4339
Tim Petersa9bc1682003-01-11 03:39:11 +00004340/* factor must be 1 (to add) or -1 (to subtract). The result inherits
4341 * the tzinfo state of date.
Tim Peters2a799bf2002-12-16 20:18:38 +00004342 */
4343static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004344add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004345 int factor)
Tim Peters2a799bf2002-12-16 20:18:38 +00004346{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004347 /* Note that the C-level additions can't overflow, because of
4348 * invariant bounds on the member values.
4349 */
4350 int year = GET_YEAR(date);
4351 int month = GET_MONTH(date);
4352 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
4353 int hour = DATE_GET_HOUR(date);
4354 int minute = DATE_GET_MINUTE(date);
4355 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
4356 int microsecond = DATE_GET_MICROSECOND(date) +
4357 GET_TD_MICROSECONDS(delta) * factor;
Tim Peters2a799bf2002-12-16 20:18:38 +00004358
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004359 assert(factor == 1 || factor == -1);
4360 if (normalize_datetime(&year, &month, &day,
4361 &hour, &minute, &second, &microsecond) < 0)
4362 return NULL;
4363 else
4364 return new_datetime(year, month, day,
4365 hour, minute, second, microsecond,
4366 HASTZINFO(date) ? date->tzinfo : Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004367}
4368
4369static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004370datetime_add(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00004371{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004372 if (PyDateTime_Check(left)) {
4373 /* datetime + ??? */
4374 if (PyDelta_Check(right))
4375 /* datetime + delta */
4376 return add_datetime_timedelta(
4377 (PyDateTime_DateTime *)left,
4378 (PyDateTime_Delta *)right,
4379 1);
4380 }
4381 else if (PyDelta_Check(left)) {
4382 /* delta + datetime */
4383 return add_datetime_timedelta((PyDateTime_DateTime *) right,
4384 (PyDateTime_Delta *) left,
4385 1);
4386 }
4387 Py_INCREF(Py_NotImplemented);
4388 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00004389}
4390
4391static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004392datetime_subtract(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00004393{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004394 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00004395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004396 if (PyDateTime_Check(left)) {
4397 /* datetime - ??? */
4398 if (PyDateTime_Check(right)) {
4399 /* datetime - datetime */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004400 PyObject *offset1, *offset2, *offdiff = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004401 int delta_d, delta_s, delta_us;
Tim Peters2a799bf2002-12-16 20:18:38 +00004402
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004403 if (GET_DT_TZINFO(left) == GET_DT_TZINFO(right)) {
4404 offset2 = offset1 = Py_None;
4405 Py_INCREF(offset1);
4406 Py_INCREF(offset2);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004407 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004408 else {
4409 offset1 = datetime_utcoffset(left, NULL);
4410 if (offset1 == NULL)
4411 return NULL;
4412 offset2 = datetime_utcoffset(right, NULL);
4413 if (offset2 == NULL) {
4414 Py_DECREF(offset1);
4415 return NULL;
4416 }
4417 if ((offset1 != Py_None) != (offset2 != Py_None)) {
4418 PyErr_SetString(PyExc_TypeError,
4419 "can't subtract offset-naive and "
4420 "offset-aware datetimes");
4421 Py_DECREF(offset1);
4422 Py_DECREF(offset2);
4423 return NULL;
4424 }
4425 }
4426 if ((offset1 != offset2) &&
4427 delta_cmp(offset1, offset2) != 0) {
4428 offdiff = delta_subtract(offset1, offset2);
4429 if (offdiff == NULL) {
4430 Py_DECREF(offset1);
4431 Py_DECREF(offset2);
4432 return NULL;
4433 }
4434 }
4435 Py_DECREF(offset1);
4436 Py_DECREF(offset2);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004437 delta_d = ymd_to_ord(GET_YEAR(left),
4438 GET_MONTH(left),
4439 GET_DAY(left)) -
4440 ymd_to_ord(GET_YEAR(right),
4441 GET_MONTH(right),
4442 GET_DAY(right));
4443 /* These can't overflow, since the values are
4444 * normalized. At most this gives the number of
4445 * seconds in one day.
4446 */
4447 delta_s = (DATE_GET_HOUR(left) -
4448 DATE_GET_HOUR(right)) * 3600 +
4449 (DATE_GET_MINUTE(left) -
4450 DATE_GET_MINUTE(right)) * 60 +
4451 (DATE_GET_SECOND(left) -
4452 DATE_GET_SECOND(right));
4453 delta_us = DATE_GET_MICROSECOND(left) -
4454 DATE_GET_MICROSECOND(right);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004455 result = new_delta(delta_d, delta_s, delta_us, 1);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004456 if (offdiff != NULL) {
4457 PyObject *temp = result;
4458 result = delta_subtract(result, offdiff);
4459 Py_DECREF(temp);
4460 Py_DECREF(offdiff);
4461 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004462 }
4463 else if (PyDelta_Check(right)) {
4464 /* datetime - delta */
4465 result = add_datetime_timedelta(
4466 (PyDateTime_DateTime *)left,
4467 (PyDateTime_Delta *)right,
4468 -1);
4469 }
4470 }
Tim Peters2a799bf2002-12-16 20:18:38 +00004471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004472 if (result == Py_NotImplemented)
4473 Py_INCREF(result);
4474 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004475}
4476
4477/* Various ways to turn a datetime into a string. */
4478
4479static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004480datetime_repr(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004481{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004482 const char *type_name = Py_TYPE(self)->tp_name;
4483 PyObject *baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004485 if (DATE_GET_MICROSECOND(self)) {
4486 baserepr = PyUnicode_FromFormat(
4487 "%s(%d, %d, %d, %d, %d, %d, %d)",
4488 type_name,
4489 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4490 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4491 DATE_GET_SECOND(self),
4492 DATE_GET_MICROSECOND(self));
4493 }
4494 else if (DATE_GET_SECOND(self)) {
4495 baserepr = PyUnicode_FromFormat(
4496 "%s(%d, %d, %d, %d, %d, %d)",
4497 type_name,
4498 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4499 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4500 DATE_GET_SECOND(self));
4501 }
4502 else {
4503 baserepr = PyUnicode_FromFormat(
4504 "%s(%d, %d, %d, %d, %d)",
4505 type_name,
4506 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4507 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
4508 }
4509 if (baserepr == NULL || ! HASTZINFO(self))
4510 return baserepr;
4511 return append_keyword_tzinfo(baserepr, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00004512}
4513
Tim Petersa9bc1682003-01-11 03:39:11 +00004514static PyObject *
4515datetime_str(PyDateTime_DateTime *self)
4516{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004517 return PyObject_CallMethod((PyObject *)self, "isoformat", "(s)", " ");
Tim Petersa9bc1682003-01-11 03:39:11 +00004518}
Tim Peters2a799bf2002-12-16 20:18:38 +00004519
4520static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004521datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004522{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004523 int sep = 'T';
4524 static char *keywords[] = {"sep", NULL};
4525 char buffer[100];
4526 PyObject *result;
4527 int us = DATE_GET_MICROSECOND(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00004528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004529 if (!PyArg_ParseTupleAndKeywords(args, kw, "|C:isoformat", keywords, &sep))
4530 return NULL;
4531 if (us)
4532 result = PyUnicode_FromFormat("%04d-%02d-%02d%c%02d:%02d:%02d.%06d",
4533 GET_YEAR(self), GET_MONTH(self),
4534 GET_DAY(self), (int)sep,
4535 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4536 DATE_GET_SECOND(self), us);
4537 else
4538 result = PyUnicode_FromFormat("%04d-%02d-%02d%c%02d:%02d:%02d",
4539 GET_YEAR(self), GET_MONTH(self),
4540 GET_DAY(self), (int)sep,
4541 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4542 DATE_GET_SECOND(self));
Walter Dörwaldbafa1372007-05-31 17:50:48 +00004543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004544 if (!result || !HASTZINFO(self))
4545 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004547 /* We need to append the UTC offset. */
4548 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
4549 (PyObject *)self) < 0) {
4550 Py_DECREF(result);
4551 return NULL;
4552 }
4553 PyUnicode_AppendAndDel(&result, PyUnicode_FromString(buffer));
4554 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004555}
4556
Tim Petersa9bc1682003-01-11 03:39:11 +00004557static PyObject *
4558datetime_ctime(PyDateTime_DateTime *self)
4559{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004560 return format_ctime((PyDateTime_Date *)self,
4561 DATE_GET_HOUR(self),
4562 DATE_GET_MINUTE(self),
4563 DATE_GET_SECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00004564}
4565
Tim Peters2a799bf2002-12-16 20:18:38 +00004566/* Miscellaneous methods. */
4567
Tim Petersa9bc1682003-01-11 03:39:11 +00004568static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00004569datetime_richcompare(PyObject *self, PyObject *other, int op)
Tim Petersa9bc1682003-01-11 03:39:11 +00004570{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004571 PyObject *result = NULL;
4572 PyObject *offset1, *offset2;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004573 int diff;
Tim Petersa9bc1682003-01-11 03:39:11 +00004574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004575 if (! PyDateTime_Check(other)) {
4576 if (PyDate_Check(other)) {
4577 /* Prevent invocation of date_richcompare. We want to
4578 return NotImplemented here to give the other object
4579 a chance. But since DateTime is a subclass of
4580 Date, if the other object is a Date, it would
4581 compute an ordering based on the date part alone,
4582 and we don't want that. So force unequal or
4583 uncomparable here in that case. */
4584 if (op == Py_EQ)
4585 Py_RETURN_FALSE;
4586 if (op == Py_NE)
4587 Py_RETURN_TRUE;
4588 return cmperror(self, other);
4589 }
4590 Py_INCREF(Py_NotImplemented);
4591 return Py_NotImplemented;
4592 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004593
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004594 if (GET_DT_TZINFO(self) == GET_DT_TZINFO(other)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004595 diff = memcmp(((PyDateTime_DateTime *)self)->data,
4596 ((PyDateTime_DateTime *)other)->data,
4597 _PyDateTime_DATETIME_DATASIZE);
4598 return diff_to_bool(diff, op);
4599 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004600 offset1 = datetime_utcoffset(self, NULL);
4601 if (offset1 == NULL)
4602 return NULL;
4603 offset2 = datetime_utcoffset(other, NULL);
4604 if (offset2 == NULL)
4605 goto done;
4606 /* If they're both naive, or both aware and have the same offsets,
4607 * we get off cheap. Note that if they're both naive, offset1 ==
4608 * offset2 == Py_None at this point.
4609 */
4610 if ((offset1 == offset2) ||
4611 (PyDelta_Check(offset1) && PyDelta_Check(offset2) &&
4612 delta_cmp(offset1, offset2) == 0)) {
4613 diff = memcmp(((PyDateTime_DateTime *)self)->data,
4614 ((PyDateTime_DateTime *)other)->data,
4615 _PyDateTime_DATETIME_DATASIZE);
4616 result = diff_to_bool(diff, op);
4617 }
4618 else if (offset1 != Py_None && offset2 != Py_None) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004619 PyDateTime_Delta *delta;
Tim Petersa9bc1682003-01-11 03:39:11 +00004620
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004621 assert(offset1 != offset2); /* else last "if" handled it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004622 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
4623 other);
4624 if (delta == NULL)
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004625 goto done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004626 diff = GET_TD_DAYS(delta);
4627 if (diff == 0)
4628 diff = GET_TD_SECONDS(delta) |
4629 GET_TD_MICROSECONDS(delta);
4630 Py_DECREF(delta);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004631 result = diff_to_bool(diff, op);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004632 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004633 else {
4634 PyErr_SetString(PyExc_TypeError,
4635 "can't compare offset-naive and "
4636 "offset-aware datetimes");
4637 }
4638 done:
4639 Py_DECREF(offset1);
4640 Py_XDECREF(offset2);
4641 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00004642}
4643
Benjamin Peterson8f67d082010-10-17 20:54:53 +00004644static Py_hash_t
Tim Petersa9bc1682003-01-11 03:39:11 +00004645datetime_hash(PyDateTime_DateTime *self)
4646{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004647 if (self->hashcode == -1) {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004648 PyObject *offset;
Tim Petersa9bc1682003-01-11 03:39:11 +00004649
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004650 offset = datetime_utcoffset((PyObject *)self, NULL);
4651
4652 if (offset == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004653 return -1;
Tim Petersa9bc1682003-01-11 03:39:11 +00004654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004655 /* Reduce this to a hash of another object. */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004656 if (offset == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004657 self->hashcode = generic_hash(
4658 (unsigned char *)self->data, _PyDateTime_DATETIME_DATASIZE);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004659 else {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004660 PyObject *temp1, *temp2;
4661 int days, seconds;
Tim Petersa9bc1682003-01-11 03:39:11 +00004662
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004663 assert(HASTZINFO(self));
4664 days = ymd_to_ord(GET_YEAR(self),
4665 GET_MONTH(self),
4666 GET_DAY(self));
4667 seconds = DATE_GET_HOUR(self) * 3600 +
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004668 DATE_GET_MINUTE(self) * 60 +
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004669 DATE_GET_SECOND(self);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004670 temp1 = new_delta(days, seconds,
4671 DATE_GET_MICROSECOND(self),
4672 1);
4673 if (temp1 == NULL) {
4674 Py_DECREF(offset);
4675 return -1;
4676 }
4677 temp2 = delta_subtract(temp1, offset);
4678 Py_DECREF(temp1);
4679 if (temp2 == NULL) {
4680 Py_DECREF(offset);
4681 return -1;
4682 }
4683 self->hashcode = PyObject_Hash(temp2);
4684 Py_DECREF(temp2);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004685 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004686 Py_DECREF(offset);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004687 }
4688 return self->hashcode;
Tim Petersa9bc1682003-01-11 03:39:11 +00004689}
Tim Peters2a799bf2002-12-16 20:18:38 +00004690
4691static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004692datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00004693{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004694 PyObject *clone;
4695 PyObject *tuple;
4696 int y = GET_YEAR(self);
4697 int m = GET_MONTH(self);
4698 int d = GET_DAY(self);
4699 int hh = DATE_GET_HOUR(self);
4700 int mm = DATE_GET_MINUTE(self);
4701 int ss = DATE_GET_SECOND(self);
4702 int us = DATE_GET_MICROSECOND(self);
4703 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00004704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004705 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO:replace",
4706 datetime_kws,
4707 &y, &m, &d, &hh, &mm, &ss, &us,
4708 &tzinfo))
4709 return NULL;
4710 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
4711 if (tuple == NULL)
4712 return NULL;
4713 clone = datetime_new(Py_TYPE(self), tuple, NULL);
4714 Py_DECREF(tuple);
4715 return clone;
Tim Peters12bf3392002-12-24 05:41:27 +00004716}
4717
4718static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004719datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters80475bb2002-12-25 07:40:55 +00004720{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004721 PyObject *result;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004722 PyObject *offset;
4723 PyObject *temp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004724 PyObject *tzinfo;
4725 static char *keywords[] = {"tz", NULL};
Tim Peters80475bb2002-12-25 07:40:55 +00004726
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004727 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:astimezone", keywords,
4728 &PyDateTime_TZInfoType, &tzinfo))
4729 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00004730
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004731 if (!HASTZINFO(self) || self->tzinfo == Py_None)
4732 goto NeedAware;
Tim Peters521fc152002-12-31 17:36:56 +00004733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004734 /* Conversion to self's own time zone is a NOP. */
4735 if (self->tzinfo == tzinfo) {
4736 Py_INCREF(self);
4737 return (PyObject *)self;
4738 }
Tim Peters521fc152002-12-31 17:36:56 +00004739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004740 /* Convert self to UTC. */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004741 offset = datetime_utcoffset((PyObject *)self, NULL);
4742 if (offset == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004743 return NULL;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004744 if (offset == Py_None) {
4745 Py_DECREF(offset);
4746 NeedAware:
4747 PyErr_SetString(PyExc_ValueError, "astimezone() cannot be applied to "
4748 "a naive datetime");
4749 return NULL;
4750 }
Tim Petersf3615152003-01-01 21:51:37 +00004751
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004752 /* result = self - offset */
4753 result = add_datetime_timedelta(self,
4754 (PyDateTime_Delta *)offset, -1);
4755 Py_DECREF(offset);
4756 if (result == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004757 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00004758
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004759 /* Attach new tzinfo and let fromutc() do the rest. */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004760 temp = ((PyDateTime_DateTime *)result)->tzinfo;
4761 ((PyDateTime_DateTime *)result)->tzinfo = tzinfo;
4762 Py_INCREF(tzinfo);
4763 Py_DECREF(temp);
Tim Peters52dcce22003-01-23 16:36:11 +00004764
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004765 temp = result;
4766 result = PyObject_CallMethod(tzinfo, "fromutc", "O", temp);
4767 Py_DECREF(temp);
4768
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004769 return result;
Tim Peters80475bb2002-12-25 07:40:55 +00004770}
4771
4772static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004773datetime_timetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004774{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004775 int dstflag = -1;
Tim Peters2a799bf2002-12-16 20:18:38 +00004776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004777 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004778 PyObject * dst;
Tim Peters2a799bf2002-12-16 20:18:38 +00004779
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004780 dst = call_dst(self->tzinfo, (PyObject *)self);
4781 if (dst == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004782 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004783
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004784 if (dst != Py_None)
4785 dstflag = delta_bool((PyDateTime_Delta *)dst);
4786 Py_DECREF(dst);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004787 }
4788 return build_struct_time(GET_YEAR(self),
4789 GET_MONTH(self),
4790 GET_DAY(self),
4791 DATE_GET_HOUR(self),
4792 DATE_GET_MINUTE(self),
4793 DATE_GET_SECOND(self),
4794 dstflag);
Tim Peters2a799bf2002-12-16 20:18:38 +00004795}
4796
4797static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004798datetime_getdate(PyDateTime_DateTime *self)
4799{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004800 return new_date(GET_YEAR(self),
4801 GET_MONTH(self),
4802 GET_DAY(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00004803}
4804
4805static PyObject *
4806datetime_gettime(PyDateTime_DateTime *self)
4807{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004808 return new_time(DATE_GET_HOUR(self),
4809 DATE_GET_MINUTE(self),
4810 DATE_GET_SECOND(self),
4811 DATE_GET_MICROSECOND(self),
4812 Py_None);
Tim Petersa9bc1682003-01-11 03:39:11 +00004813}
4814
4815static PyObject *
4816datetime_gettimetz(PyDateTime_DateTime *self)
4817{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004818 return new_time(DATE_GET_HOUR(self),
4819 DATE_GET_MINUTE(self),
4820 DATE_GET_SECOND(self),
4821 DATE_GET_MICROSECOND(self),
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004822 GET_DT_TZINFO(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00004823}
4824
4825static PyObject *
4826datetime_utctimetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004827{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004828 int y, m, d, hh, mm, ss;
4829 PyObject *tzinfo;
4830 PyDateTime_DateTime *utcself;
Tim Peters2a799bf2002-12-16 20:18:38 +00004831
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004832 tzinfo = GET_DT_TZINFO(self);
4833 if (tzinfo == Py_None) {
4834 utcself = self;
4835 Py_INCREF(utcself);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004836 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004837 else {
4838 PyObject *offset;
4839 offset = call_utcoffset(tzinfo, (PyObject *)self);
4840 if (offset == NULL)
Alexander Belopolsky75f94c22010-06-21 15:21:14 +00004841 return NULL;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004842 if (offset == Py_None) {
4843 Py_DECREF(offset);
4844 utcself = self;
4845 Py_INCREF(utcself);
4846 }
4847 else {
4848 utcself = (PyDateTime_DateTime *)add_datetime_timedelta(self,
4849 (PyDateTime_Delta *)offset, -1);
4850 Py_DECREF(offset);
4851 if (utcself == NULL)
4852 return NULL;
4853 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004854 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004855 y = GET_YEAR(utcself);
4856 m = GET_MONTH(utcself);
4857 d = GET_DAY(utcself);
4858 hh = DATE_GET_HOUR(utcself);
4859 mm = DATE_GET_MINUTE(utcself);
4860 ss = DATE_GET_SECOND(utcself);
4861
4862 Py_DECREF(utcself);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004863 return build_struct_time(y, m, d, hh, mm, ss, 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00004864}
4865
Tim Peters371935f2003-02-01 01:52:50 +00004866/* Pickle support, a simple use of __reduce__. */
Tim Peters33e0f382003-01-10 02:05:14 +00004867
Tim Petersa9bc1682003-01-11 03:39:11 +00004868/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004869 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4870 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00004871 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00004872 */
4873static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004874datetime_getstate(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004875{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004876 PyObject *basestate;
4877 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004879 basestate = PyBytes_FromStringAndSize((char *)self->data,
4880 _PyDateTime_DATETIME_DATASIZE);
4881 if (basestate != NULL) {
4882 if (! HASTZINFO(self) || self->tzinfo == Py_None)
4883 result = PyTuple_Pack(1, basestate);
4884 else
4885 result = PyTuple_Pack(2, basestate, self->tzinfo);
4886 Py_DECREF(basestate);
4887 }
4888 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004889}
4890
4891static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00004892datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00004893{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004894 return Py_BuildValue("(ON)", Py_TYPE(self), datetime_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00004895}
4896
Tim Petersa9bc1682003-01-11 03:39:11 +00004897static PyMethodDef datetime_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004898
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004899 /* Class methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00004900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004901 {"now", (PyCFunction)datetime_now,
4902 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4903 PyDoc_STR("[tz] -> new datetime with tz's local day and time.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004904
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004905 {"utcnow", (PyCFunction)datetime_utcnow,
4906 METH_NOARGS | METH_CLASS,
4907 PyDoc_STR("Return a new datetime representing UTC day and time.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004909 {"fromtimestamp", (PyCFunction)datetime_fromtimestamp,
4910 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4911 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004912
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004913 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
4914 METH_VARARGS | METH_CLASS,
4915 PyDoc_STR("timestamp -> UTC datetime from a POSIX timestamp "
4916 "(like time.time()).")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004918 {"strptime", (PyCFunction)datetime_strptime,
4919 METH_VARARGS | METH_CLASS,
4920 PyDoc_STR("string, format -> new datetime parsed from a string "
4921 "(like time.strptime()).")},
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004923 {"combine", (PyCFunction)datetime_combine,
4924 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4925 PyDoc_STR("date, time -> datetime with same date and time fields")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004927 /* Instance methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00004928
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004929 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
4930 PyDoc_STR("Return date object with same year, month and day.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004931
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004932 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
4933 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004934
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004935 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
4936 PyDoc_STR("Return time object with same time and tzinfo.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004937
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004938 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
4939 PyDoc_STR("Return ctime() style string.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004940
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004941 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
4942 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004943
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004944 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
4945 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004946
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004947 {"isoformat", (PyCFunction)datetime_isoformat, METH_VARARGS | METH_KEYWORDS,
4948 PyDoc_STR("[sep] -> string in ISO 8601 format, "
4949 "YYYY-MM-DDTHH:MM:SS[.mmmmmm][+HH:MM].\n\n"
4950 "sep is used to separate the year from the time, and "
4951 "defaults to 'T'.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004952
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004953 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
4954 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004956 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
4957 PyDoc_STR("Return self.tzinfo.tzname(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004959 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
4960 PyDoc_STR("Return self.tzinfo.dst(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004961
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004962 {"replace", (PyCFunction)datetime_replace, METH_VARARGS | METH_KEYWORDS,
4963 PyDoc_STR("Return datetime with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00004964
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004965 {"astimezone", (PyCFunction)datetime_astimezone, METH_VARARGS | METH_KEYWORDS,
4966 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
Tim Peters80475bb2002-12-25 07:40:55 +00004967
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004968 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
4969 PyDoc_STR("__reduce__() -> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00004970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004971 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00004972};
4973
Tim Petersa9bc1682003-01-11 03:39:11 +00004974static char datetime_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00004975PyDoc_STR("datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])\n\
4976\n\
4977The year, month and day arguments are required. tzinfo may be None, or an\n\
4978instance of a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00004979
Tim Petersa9bc1682003-01-11 03:39:11 +00004980static PyNumberMethods datetime_as_number = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004981 datetime_add, /* nb_add */
4982 datetime_subtract, /* nb_subtract */
4983 0, /* nb_multiply */
4984 0, /* nb_remainder */
4985 0, /* nb_divmod */
4986 0, /* nb_power */
4987 0, /* nb_negative */
4988 0, /* nb_positive */
4989 0, /* nb_absolute */
4990 0, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00004991};
4992
Neal Norwitz227b5332006-03-22 09:28:35 +00004993static PyTypeObject PyDateTime_DateTimeType = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004994 PyVarObject_HEAD_INIT(NULL, 0)
4995 "datetime.datetime", /* tp_name */
4996 sizeof(PyDateTime_DateTime), /* tp_basicsize */
4997 0, /* tp_itemsize */
4998 (destructor)datetime_dealloc, /* tp_dealloc */
4999 0, /* tp_print */
5000 0, /* tp_getattr */
5001 0, /* tp_setattr */
5002 0, /* tp_reserved */
5003 (reprfunc)datetime_repr, /* tp_repr */
5004 &datetime_as_number, /* tp_as_number */
5005 0, /* tp_as_sequence */
5006 0, /* tp_as_mapping */
5007 (hashfunc)datetime_hash, /* tp_hash */
5008 0, /* tp_call */
5009 (reprfunc)datetime_str, /* tp_str */
5010 PyObject_GenericGetAttr, /* tp_getattro */
5011 0, /* tp_setattro */
5012 0, /* tp_as_buffer */
5013 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
5014 datetime_doc, /* tp_doc */
5015 0, /* tp_traverse */
5016 0, /* tp_clear */
5017 datetime_richcompare, /* tp_richcompare */
5018 0, /* tp_weaklistoffset */
5019 0, /* tp_iter */
5020 0, /* tp_iternext */
5021 datetime_methods, /* tp_methods */
5022 0, /* tp_members */
5023 datetime_getset, /* tp_getset */
5024 &PyDateTime_DateType, /* tp_base */
5025 0, /* tp_dict */
5026 0, /* tp_descr_get */
5027 0, /* tp_descr_set */
5028 0, /* tp_dictoffset */
5029 0, /* tp_init */
5030 datetime_alloc, /* tp_alloc */
5031 datetime_new, /* tp_new */
5032 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00005033};
5034
5035/* ---------------------------------------------------------------------------
5036 * Module methods and initialization.
5037 */
5038
5039static PyMethodDef module_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005040 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00005041};
5042
Tim Peters9ddf40b2004-06-20 22:41:32 +00005043/* C API. Clients get at this via PyDateTime_IMPORT, defined in
5044 * datetime.h.
5045 */
5046static PyDateTime_CAPI CAPI = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005047 &PyDateTime_DateType,
5048 &PyDateTime_DateTimeType,
5049 &PyDateTime_TimeType,
5050 &PyDateTime_DeltaType,
5051 &PyDateTime_TZInfoType,
5052 new_date_ex,
5053 new_datetime_ex,
5054 new_time_ex,
5055 new_delta_ex,
5056 datetime_fromtimestamp,
5057 date_fromtimestamp
Tim Peters9ddf40b2004-06-20 22:41:32 +00005058};
5059
5060
Martin v. Löwis1a214512008-06-11 05:26:20 +00005061
5062static struct PyModuleDef datetimemodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005063 PyModuleDef_HEAD_INIT,
Alexander Belopolskycf86e362010-07-23 19:25:47 +00005064 "_datetime",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005065 "Fast implementation of the datetime type.",
5066 -1,
5067 module_methods,
5068 NULL,
5069 NULL,
5070 NULL,
5071 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00005072};
5073
Tim Peters2a799bf2002-12-16 20:18:38 +00005074PyMODINIT_FUNC
Alexander Belopolskycf86e362010-07-23 19:25:47 +00005075PyInit__datetime(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00005076{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005077 PyObject *m; /* a module object */
5078 PyObject *d; /* its dict */
5079 PyObject *x;
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00005080 PyObject *delta;
Tim Peters2a799bf2002-12-16 20:18:38 +00005081
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005082 m = PyModule_Create(&datetimemodule);
5083 if (m == NULL)
5084 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00005085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005086 if (PyType_Ready(&PyDateTime_DateType) < 0)
5087 return NULL;
5088 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
5089 return NULL;
5090 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
5091 return NULL;
5092 if (PyType_Ready(&PyDateTime_TimeType) < 0)
5093 return NULL;
5094 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
5095 return NULL;
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00005096 if (PyType_Ready(&PyDateTime_TimeZoneType) < 0)
5097 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00005098
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005099 /* timedelta values */
5100 d = PyDateTime_DeltaType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00005101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005102 x = new_delta(0, 0, 1, 0);
5103 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
5104 return NULL;
5105 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00005106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005107 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
5108 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
5109 return NULL;
5110 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00005111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005112 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
5113 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
5114 return NULL;
5115 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00005116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005117 /* date values */
5118 d = PyDateTime_DateType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00005119
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005120 x = new_date(1, 1, 1);
5121 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
5122 return NULL;
5123 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00005124
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005125 x = new_date(MAXYEAR, 12, 31);
5126 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
5127 return NULL;
5128 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00005129
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005130 x = new_delta(1, 0, 0, 0);
5131 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
5132 return NULL;
5133 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00005134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005135 /* time values */
5136 d = PyDateTime_TimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00005137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005138 x = new_time(0, 0, 0, 0, Py_None);
5139 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
5140 return NULL;
5141 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00005142
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005143 x = new_time(23, 59, 59, 999999, Py_None);
5144 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
5145 return NULL;
5146 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00005147
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005148 x = new_delta(0, 0, 1, 0);
5149 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
5150 return NULL;
5151 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00005152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005153 /* datetime values */
5154 d = PyDateTime_DateTimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00005155
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005156 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None);
5157 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
5158 return NULL;
5159 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00005160
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005161 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None);
5162 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
5163 return NULL;
5164 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00005165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005166 x = new_delta(0, 0, 1, 0);
5167 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
5168 return NULL;
5169 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00005170
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00005171 /* timezone values */
5172 d = PyDateTime_TimeZoneType.tp_dict;
5173
5174 delta = new_delta(0, 0, 0, 0);
5175 if (delta == NULL)
5176 return NULL;
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +00005177 x = create_timezone(delta, NULL);
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00005178 Py_DECREF(delta);
5179 if (x == NULL || PyDict_SetItemString(d, "utc", x) < 0)
5180 return NULL;
Alexander Belopolskya11d8c02010-07-06 23:19:45 +00005181 PyDateTime_TimeZone_UTC = x;
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00005182
5183 delta = new_delta(-1, 60, 0, 1); /* -23:59 */
5184 if (delta == NULL)
5185 return NULL;
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +00005186 x = create_timezone(delta, NULL);
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00005187 Py_DECREF(delta);
5188 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
5189 return NULL;
5190 Py_DECREF(x);
5191
5192 delta = new_delta(0, (23 * 60 + 59) * 60, 0, 0); /* +23:59 */
5193 if (delta == NULL)
5194 return NULL;
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +00005195 x = create_timezone(delta, NULL);
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00005196 Py_DECREF(delta);
5197 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
5198 return NULL;
5199 Py_DECREF(x);
5200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005201 /* module initialization */
5202 PyModule_AddIntConstant(m, "MINYEAR", MINYEAR);
5203 PyModule_AddIntConstant(m, "MAXYEAR", MAXYEAR);
Tim Peters2a799bf2002-12-16 20:18:38 +00005204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005205 Py_INCREF(&PyDateTime_DateType);
5206 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
Tim Peters2a799bf2002-12-16 20:18:38 +00005207
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005208 Py_INCREF(&PyDateTime_DateTimeType);
5209 PyModule_AddObject(m, "datetime",
5210 (PyObject *)&PyDateTime_DateTimeType);
Tim Petersa9bc1682003-01-11 03:39:11 +00005211
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005212 Py_INCREF(&PyDateTime_TimeType);
5213 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
Tim Petersa9bc1682003-01-11 03:39:11 +00005214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005215 Py_INCREF(&PyDateTime_DeltaType);
5216 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
Tim Peters2a799bf2002-12-16 20:18:38 +00005217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005218 Py_INCREF(&PyDateTime_TZInfoType);
5219 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
Tim Peters2a799bf2002-12-16 20:18:38 +00005220
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00005221 Py_INCREF(&PyDateTime_TimeZoneType);
5222 PyModule_AddObject(m, "timezone", (PyObject *) &PyDateTime_TimeZoneType);
5223
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005224 x = PyCapsule_New(&CAPI, PyDateTime_CAPSULE_NAME, NULL);
5225 if (x == NULL)
5226 return NULL;
5227 PyModule_AddObject(m, "datetime_CAPI", x);
Tim Peters9ddf40b2004-06-20 22:41:32 +00005228
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005229 /* A 4-year cycle has an extra leap day over what we'd get from
5230 * pasting together 4 single years.
5231 */
5232 assert(DI4Y == 4 * 365 + 1);
5233 assert(DI4Y == days_before_year(4+1));
Tim Peters2a799bf2002-12-16 20:18:38 +00005234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005235 /* Similarly, a 400-year cycle has an extra leap day over what we'd
5236 * get from pasting together 4 100-year cycles.
5237 */
5238 assert(DI400Y == 4 * DI100Y + 1);
5239 assert(DI400Y == days_before_year(400+1));
Tim Peters2a799bf2002-12-16 20:18:38 +00005240
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005241 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
5242 * pasting together 25 4-year cycles.
5243 */
5244 assert(DI100Y == 25 * DI4Y - 1);
5245 assert(DI100Y == days_before_year(100+1));
Tim Peters2a799bf2002-12-16 20:18:38 +00005246
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005247 us_per_us = PyLong_FromLong(1);
5248 us_per_ms = PyLong_FromLong(1000);
5249 us_per_second = PyLong_FromLong(1000000);
5250 us_per_minute = PyLong_FromLong(60000000);
5251 seconds_per_day = PyLong_FromLong(24 * 3600);
5252 if (us_per_us == NULL || us_per_ms == NULL || us_per_second == NULL ||
5253 us_per_minute == NULL || seconds_per_day == NULL)
5254 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00005255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005256 /* The rest are too big for 32-bit ints, but even
5257 * us_per_week fits in 40 bits, so doubles should be exact.
5258 */
5259 us_per_hour = PyLong_FromDouble(3600000000.0);
5260 us_per_day = PyLong_FromDouble(86400000000.0);
5261 us_per_week = PyLong_FromDouble(604800000000.0);
5262 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
5263 return NULL;
5264 return m;
Tim Peters2a799bf2002-12-16 20:18:38 +00005265}
Tim Petersf3615152003-01-01 21:51:37 +00005266
5267/* ---------------------------------------------------------------------------
Tim Petersa9bc1682003-01-11 03:39:11 +00005268Some time zone algebra. For a datetime x, let
Tim Petersf3615152003-01-01 21:51:37 +00005269 x.n = x stripped of its timezone -- its naive time.
5270 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005271 return None
Tim Petersf3615152003-01-01 21:51:37 +00005272 x.d = x.dst(), and assuming that doesn't raise an exception or
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005273 return None
Tim Petersf3615152003-01-01 21:51:37 +00005274 x.s = x's standard offset, x.o - x.d
5275
5276Now some derived rules, where k is a duration (timedelta).
5277
52781. x.o = x.s + x.d
5279 This follows from the definition of x.s.
5280
Tim Petersc5dc4da2003-01-02 17:55:03 +000052812. If x and y have the same tzinfo member, x.s = y.s.
Tim Petersf3615152003-01-01 21:51:37 +00005282 This is actually a requirement, an assumption we need to make about
5283 sane tzinfo classes.
5284
52853. The naive UTC time corresponding to x is x.n - x.o.
5286 This is again a requirement for a sane tzinfo class.
5287
52884. (x+k).s = x.s
Tim Peters8bb5ad22003-01-24 02:44:45 +00005289 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
Tim Petersf3615152003-01-01 21:51:37 +00005290
Tim Petersc5dc4da2003-01-02 17:55:03 +000052915. (x+k).n = x.n + k
Tim Petersf3615152003-01-01 21:51:37 +00005292 Again follows from how arithmetic is defined.
5293
Tim Peters8bb5ad22003-01-24 02:44:45 +00005294Now we can explain tz.fromutc(x). Let's assume it's an interesting case
Tim Petersf3615152003-01-01 21:51:37 +00005295(meaning that the various tzinfo methods exist, and don't blow up or return
5296None when called).
5297
Tim Petersa9bc1682003-01-11 03:39:11 +00005298The function wants to return a datetime y with timezone tz, equivalent to x.
Tim Peters8bb5ad22003-01-24 02:44:45 +00005299x is already in UTC.
Tim Petersf3615152003-01-01 21:51:37 +00005300
5301By #3, we want
5302
Tim Peters8bb5ad22003-01-24 02:44:45 +00005303 y.n - y.o = x.n [1]
Tim Petersf3615152003-01-01 21:51:37 +00005304
5305The algorithm starts by attaching tz to x.n, and calling that y. So
5306x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
5307becomes true; in effect, we want to solve [2] for k:
5308
Tim Peters8bb5ad22003-01-24 02:44:45 +00005309 (y+k).n - (y+k).o = x.n [2]
Tim Petersf3615152003-01-01 21:51:37 +00005310
5311By #1, this is the same as
5312
Tim Peters8bb5ad22003-01-24 02:44:45 +00005313 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
Tim Petersf3615152003-01-01 21:51:37 +00005314
5315By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
5316Substituting that into [3],
5317
Tim Peters8bb5ad22003-01-24 02:44:45 +00005318 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
5319 k - (y+k).s - (y+k).d = 0; rearranging,
5320 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
5321 k = y.s - (y+k).d
Tim Petersf3615152003-01-01 21:51:37 +00005322
Tim Peters8bb5ad22003-01-24 02:44:45 +00005323On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
5324approximate k by ignoring the (y+k).d term at first. Note that k can't be
5325very large, since all offset-returning methods return a duration of magnitude
5326less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
5327be 0, so ignoring it has no consequence then.
Tim Petersf3615152003-01-01 21:51:37 +00005328
5329In any case, the new value is
5330
Tim Peters8bb5ad22003-01-24 02:44:45 +00005331 z = y + y.s [4]
Tim Petersf3615152003-01-01 21:51:37 +00005332
Tim Peters8bb5ad22003-01-24 02:44:45 +00005333It's helpful to step back at look at [4] from a higher level: it's simply
5334mapping from UTC to tz's standard time.
Tim Petersc5dc4da2003-01-02 17:55:03 +00005335
5336At this point, if
5337
Tim Peters8bb5ad22003-01-24 02:44:45 +00005338 z.n - z.o = x.n [5]
Tim Petersc5dc4da2003-01-02 17:55:03 +00005339
5340we have an equivalent time, and are almost done. The insecurity here is
Tim Petersf3615152003-01-01 21:51:37 +00005341at the start of daylight time. Picture US Eastern for concreteness. The wall
5342time jumps from 1:59 to 3:00, and wall hours of the form 2:MM don't make good
Tim Peters8bb5ad22003-01-24 02:44:45 +00005343sense then. The docs ask that an Eastern tzinfo class consider such a time to
5344be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
5345on the day DST starts. We want to return the 1:MM EST spelling because that's
Tim Petersf3615152003-01-01 21:51:37 +00005346the only spelling that makes sense on the local wall clock.
5347
Tim Petersc5dc4da2003-01-02 17:55:03 +00005348In fact, if [5] holds at this point, we do have the standard-time spelling,
5349but that takes a bit of proof. We first prove a stronger result. What's the
5350difference between the LHS and RHS of [5]? Let
Tim Petersf3615152003-01-01 21:51:37 +00005351
Tim Peters8bb5ad22003-01-24 02:44:45 +00005352 diff = x.n - (z.n - z.o) [6]
Tim Petersf3615152003-01-01 21:51:37 +00005353
Tim Petersc5dc4da2003-01-02 17:55:03 +00005354Now
5355 z.n = by [4]
Tim Peters8bb5ad22003-01-24 02:44:45 +00005356 (y + y.s).n = by #5
5357 y.n + y.s = since y.n = x.n
5358 x.n + y.s = since z and y are have the same tzinfo member,
5359 y.s = z.s by #2
5360 x.n + z.s
Tim Petersf3615152003-01-01 21:51:37 +00005361
Tim Petersc5dc4da2003-01-02 17:55:03 +00005362Plugging that back into [6] gives
Tim Petersf3615152003-01-01 21:51:37 +00005363
Tim Petersc5dc4da2003-01-02 17:55:03 +00005364 diff =
Tim Peters8bb5ad22003-01-24 02:44:45 +00005365 x.n - ((x.n + z.s) - z.o) = expanding
5366 x.n - x.n - z.s + z.o = cancelling
5367 - z.s + z.o = by #2
Tim Petersc5dc4da2003-01-02 17:55:03 +00005368 z.d
Tim Petersf3615152003-01-01 21:51:37 +00005369
Tim Petersc5dc4da2003-01-02 17:55:03 +00005370So diff = z.d.
Tim Petersf3615152003-01-01 21:51:37 +00005371
Tim Petersc5dc4da2003-01-02 17:55:03 +00005372If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
Tim Peters8bb5ad22003-01-24 02:44:45 +00005373spelling we wanted in the endcase described above. We're done. Contrarily,
5374if z.d = 0, then we have a UTC equivalent, and are also done.
Tim Petersf3615152003-01-01 21:51:37 +00005375
Tim Petersc5dc4da2003-01-02 17:55:03 +00005376If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
5377add to z (in effect, z is in tz's standard time, and we need to shift the
Tim Peters8bb5ad22003-01-24 02:44:45 +00005378local clock into tz's daylight time).
Tim Petersf3615152003-01-01 21:51:37 +00005379
Tim Petersc5dc4da2003-01-02 17:55:03 +00005380Let
Tim Petersf3615152003-01-01 21:51:37 +00005381
Tim Peters4fede1a2003-01-04 00:26:59 +00005382 z' = z + z.d = z + diff [7]
Tim Petersc3bb26a2003-01-02 03:14:59 +00005383
Tim Peters4fede1a2003-01-04 00:26:59 +00005384and we can again ask whether
Tim Petersc3bb26a2003-01-02 03:14:59 +00005385
Tim Peters8bb5ad22003-01-24 02:44:45 +00005386 z'.n - z'.o = x.n [8]
Tim Petersc3bb26a2003-01-02 03:14:59 +00005387
Tim Peters8bb5ad22003-01-24 02:44:45 +00005388If so, we're done. If not, the tzinfo class is insane, according to the
5389assumptions we've made. This also requires a bit of proof. As before, let's
5390compute the difference between the LHS and RHS of [8] (and skipping some of
5391the justifications for the kinds of substitutions we've done several times
5392already):
Tim Peters4fede1a2003-01-04 00:26:59 +00005393
Tim Peters8bb5ad22003-01-24 02:44:45 +00005394 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005395 x.n - (z.n + diff - z'.o) = replacing diff via [6]
5396 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
5397 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
5398 - z.n + z.n - z.o + z'.o = cancel z.n
5399 - z.o + z'.o = #1 twice
5400 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
5401 z'.d - z.d
Tim Peters4fede1a2003-01-04 00:26:59 +00005402
5403So z' is UTC-equivalent to x iff z'.d = z.d at this point. If they are equal,
Tim Peters8bb5ad22003-01-24 02:44:45 +00005404we've found the UTC-equivalent so are done. In fact, we stop with [7] and
5405return z', not bothering to compute z'.d.
Tim Peters4fede1a2003-01-04 00:26:59 +00005406
Tim Peters8bb5ad22003-01-24 02:44:45 +00005407How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
5408a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
5409would have to change the result dst() returns: we start in DST, and moving
5410a little further into it takes us out of DST.
Tim Peters4fede1a2003-01-04 00:26:59 +00005411
Tim Peters8bb5ad22003-01-24 02:44:45 +00005412There isn't a sane case where this can happen. The closest it gets is at
5413the end of DST, where there's an hour in UTC with no spelling in a hybrid
5414tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
5415that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
5416UTC) because the docs insist on that, but 0:MM is taken as being in daylight
5417time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
5418clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
5419standard time. Since that's what the local clock *does*, we want to map both
5420UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
Tim Peters4fede1a2003-01-04 00:26:59 +00005421in local time, but so it goes -- it's the way the local clock works.
5422
Tim Peters8bb5ad22003-01-24 02:44:45 +00005423When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
5424so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
5425z' = z + z.d = 1:MM then, and z'.d=0, and z'.d - z.d = -60 != 0 so [8]
Tim Peters4fede1a2003-01-04 00:26:59 +00005426(correctly) concludes that z' is not UTC-equivalent to x.
5427
5428Because we know z.d said z was in daylight time (else [5] would have held and
5429we would have stopped then), and we know z.d != z'.d (else [8] would have held
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00005430and we would have stopped then), and there are only 2 possible values dst() can
Tim Peters4fede1a2003-01-04 00:26:59 +00005431return in Eastern, it follows that z'.d must be 0 (which it is in the example,
5432but the reasoning doesn't depend on the example -- it depends on there being
5433two possible dst() outcomes, one zero and the other non-zero). Therefore
Tim Peters8bb5ad22003-01-24 02:44:45 +00005434z' must be in standard time, and is the spelling we want in this case.
5435
5436Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
5437concerned (because it takes z' as being in standard time rather than the
5438daylight time we intend here), but returning it gives the real-life "local
5439clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
5440tz.
5441
5442When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
5443the 1:MM standard time spelling we want.
5444
5445So how can this break? One of the assumptions must be violated. Two
5446possibilities:
5447
54481) [2] effectively says that y.s is invariant across all y belong to a given
5449 time zone. This isn't true if, for political reasons or continental drift,
5450 a region decides to change its base offset from UTC.
5451
54522) There may be versions of "double daylight" time where the tail end of
5453 the analysis gives up a step too early. I haven't thought about that
5454 enough to say.
5455
5456In any case, it's clear that the default fromutc() is strong enough to handle
5457"almost all" time zones: so long as the standard offset is invariant, it
5458doesn't matter if daylight time transition points change from year to year, or
5459if daylight time is skipped in some years; it doesn't matter how large or
5460small dst() may get within its bounds; and it doesn't even matter if some
5461perverse time zone returns a negative dst()). So a breaking case must be
5462pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
Tim Petersf3615152003-01-01 21:51:37 +00005463--------------------------------------------------------------------------- */