blob: f3103eaf69956a93e9ee0492de4f69f0ab22e4b2 [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"
6#include "modsupport.h"
7#include "structmember.h"
8
9#include <time.h>
10
Tim Peters1b6f7a92004-06-20 02:50:16 +000011#include "timefuncs.h"
Tim Peters9ddf40b2004-06-20 22:41:32 +000012
13/* Differentiate between building the core module and building extension
14 * modules.
15 */
Guido van Rossum360e4b82007-05-14 22:51:27 +000016#ifndef Py_BUILD_CORE
Tim Peters9ddf40b2004-06-20 22:41:32 +000017#define Py_BUILD_CORE
Guido van Rossum360e4b82007-05-14 22:51:27 +000018#endif
Tim Peters2a799bf2002-12-16 20:18:38 +000019#include "datetime.h"
Tim Peters9ddf40b2004-06-20 22:41:32 +000020#undef Py_BUILD_CORE
Tim Peters2a799bf2002-12-16 20:18:38 +000021
22/* We require that C int be at least 32 bits, and use int virtually
23 * everywhere. In just a few cases we use a temp long, where a Python
24 * API returns a C long. In such cases, we have to ensure that the
25 * final result fits in a C int (this can be an issue on 64-bit boxes).
26 */
27#if SIZEOF_INT < 4
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000028# error "datetime.c requires that C int have at least 32 bits"
Tim Peters2a799bf2002-12-16 20:18:38 +000029#endif
30
31#define MINYEAR 1
32#define MAXYEAR 9999
Alexander Belopolsky3efc2fd2010-05-27 22:03:53 +000033#define MAXORDINAL 3652059 /* date(9999,12,31).toordinal() */
Tim Peters2a799bf2002-12-16 20:18:38 +000034
35/* Nine decimal digits is easy to communicate, and leaves enough room
36 * so that two delta days can be added w/o fear of overflowing a signed
37 * 32-bit int, and with plenty of room left over to absorb any possible
38 * carries from adding seconds.
39 */
40#define MAX_DELTA_DAYS 999999999
41
42/* Rename the long macros in datetime.h to more reasonable short names. */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000043#define GET_YEAR PyDateTime_GET_YEAR
44#define GET_MONTH PyDateTime_GET_MONTH
45#define GET_DAY PyDateTime_GET_DAY
46#define DATE_GET_HOUR PyDateTime_DATE_GET_HOUR
47#define DATE_GET_MINUTE PyDateTime_DATE_GET_MINUTE
48#define DATE_GET_SECOND PyDateTime_DATE_GET_SECOND
49#define DATE_GET_MICROSECOND PyDateTime_DATE_GET_MICROSECOND
Tim Peters2a799bf2002-12-16 20:18:38 +000050
51/* Date accessors for date and datetime. */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000052#define SET_YEAR(o, v) (((o)->data[0] = ((v) & 0xff00) >> 8), \
53 ((o)->data[1] = ((v) & 0x00ff)))
54#define SET_MONTH(o, v) (PyDateTime_GET_MONTH(o) = (v))
55#define SET_DAY(o, v) (PyDateTime_GET_DAY(o) = (v))
Tim Peters2a799bf2002-12-16 20:18:38 +000056
57/* Date/Time accessors for datetime. */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000058#define DATE_SET_HOUR(o, v) (PyDateTime_DATE_GET_HOUR(o) = (v))
59#define DATE_SET_MINUTE(o, v) (PyDateTime_DATE_GET_MINUTE(o) = (v))
60#define DATE_SET_SECOND(o, v) (PyDateTime_DATE_GET_SECOND(o) = (v))
61#define DATE_SET_MICROSECOND(o, v) \
62 (((o)->data[7] = ((v) & 0xff0000) >> 16), \
63 ((o)->data[8] = ((v) & 0x00ff00) >> 8), \
64 ((o)->data[9] = ((v) & 0x0000ff)))
Tim Peters2a799bf2002-12-16 20:18:38 +000065
66/* Time accessors for time. */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000067#define TIME_GET_HOUR PyDateTime_TIME_GET_HOUR
68#define TIME_GET_MINUTE PyDateTime_TIME_GET_MINUTE
69#define TIME_GET_SECOND PyDateTime_TIME_GET_SECOND
70#define TIME_GET_MICROSECOND PyDateTime_TIME_GET_MICROSECOND
71#define TIME_SET_HOUR(o, v) (PyDateTime_TIME_GET_HOUR(o) = (v))
72#define TIME_SET_MINUTE(o, v) (PyDateTime_TIME_GET_MINUTE(o) = (v))
73#define TIME_SET_SECOND(o, v) (PyDateTime_TIME_GET_SECOND(o) = (v))
74#define TIME_SET_MICROSECOND(o, v) \
75 (((o)->data[3] = ((v) & 0xff0000) >> 16), \
76 ((o)->data[4] = ((v) & 0x00ff00) >> 8), \
77 ((o)->data[5] = ((v) & 0x0000ff)))
Tim Peters2a799bf2002-12-16 20:18:38 +000078
79/* Delta accessors for timedelta. */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000080#define GET_TD_DAYS(o) (((PyDateTime_Delta *)(o))->days)
81#define GET_TD_SECONDS(o) (((PyDateTime_Delta *)(o))->seconds)
82#define GET_TD_MICROSECONDS(o) (((PyDateTime_Delta *)(o))->microseconds)
Tim Peters2a799bf2002-12-16 20:18:38 +000083
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000084#define SET_TD_DAYS(o, v) ((o)->days = (v))
85#define SET_TD_SECONDS(o, v) ((o)->seconds = (v))
Tim Peters2a799bf2002-12-16 20:18:38 +000086#define SET_TD_MICROSECONDS(o, v) ((o)->microseconds = (v))
87
Tim Petersa032d2e2003-01-11 00:15:54 +000088/* p is a pointer to a time or a datetime object; HASTZINFO(p) returns
89 * p->hastzinfo.
90 */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000091#define HASTZINFO(p) (((_PyDateTime_BaseTZInfo *)(p))->hastzinfo)
Tim Petersa032d2e2003-01-11 00:15:54 +000092
Tim Peters3f606292004-03-21 23:38:41 +000093/* M is a char or int claiming to be a valid month. The macro is equivalent
94 * to the two-sided Python test
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000095 * 1 <= M <= 12
Tim Peters3f606292004-03-21 23:38:41 +000096 */
97#define MONTH_IS_SANE(M) ((unsigned int)(M) - 1 < 12)
98
Tim Peters2a799bf2002-12-16 20:18:38 +000099/* Forward declarations. */
100static PyTypeObject PyDateTime_DateType;
101static PyTypeObject PyDateTime_DateTimeType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000102static PyTypeObject PyDateTime_DeltaType;
103static PyTypeObject PyDateTime_TimeType;
104static PyTypeObject PyDateTime_TZInfoType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000105
106/* ---------------------------------------------------------------------------
107 * Math utilities.
108 */
109
110/* k = i+j overflows iff k differs in sign from both inputs,
111 * iff k^i has sign bit set and k^j has sign bit set,
112 * iff (k^i)&(k^j) has sign bit set.
113 */
114#define SIGNED_ADD_OVERFLOWED(RESULT, I, J) \
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000115 ((((RESULT) ^ (I)) & ((RESULT) ^ (J))) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +0000116
117/* Compute Python divmod(x, y), returning the quotient and storing the
118 * remainder into *r. The quotient is the floor of x/y, and that's
119 * the real point of this. C will probably truncate instead (C99
120 * requires truncation; C89 left it implementation-defined).
121 * Simplification: we *require* that y > 0 here. That's appropriate
122 * for all the uses made of it. This simplifies the code and makes
123 * the overflow case impossible (divmod(LONG_MIN, -1) is the only
124 * overflow case).
125 */
126static int
127divmod(int x, int y, int *r)
128{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000129 int quo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000130
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000131 assert(y > 0);
132 quo = x / y;
133 *r = x - quo * y;
134 if (*r < 0) {
135 --quo;
136 *r += y;
137 }
138 assert(0 <= *r && *r < y);
139 return quo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000140}
141
Tim Peters5d644dd2003-01-02 16:32:54 +0000142/* Round a double to the nearest long. |x| must be small enough to fit
143 * in a C long; this is not checked.
144 */
145static long
146round_to_long(double x)
147{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000148 if (x >= 0.0)
149 x = floor(x + 0.5);
150 else
151 x = ceil(x - 0.5);
152 return (long)x;
Tim Peters5d644dd2003-01-02 16:32:54 +0000153}
154
Tim Peters2a799bf2002-12-16 20:18:38 +0000155/* ---------------------------------------------------------------------------
156 * General calendrical helper functions
157 */
158
159/* For each month ordinal in 1..12, the number of days in that month,
160 * and the number of days before that month in the same year. These
161 * are correct for non-leap years only.
162 */
163static int _days_in_month[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000164 0, /* unused; this vector uses 1-based indexing */
165 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
Tim Peters2a799bf2002-12-16 20:18:38 +0000166};
167
168static int _days_before_month[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000169 0, /* unused; this vector uses 1-based indexing */
170 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
Tim Peters2a799bf2002-12-16 20:18:38 +0000171};
172
173/* year -> 1 if leap year, else 0. */
174static int
175is_leap(int year)
176{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000177 /* Cast year to unsigned. The result is the same either way, but
178 * C can generate faster code for unsigned mod than for signed
179 * mod (especially for % 4 -- a good compiler should just grab
180 * the last 2 bits when the LHS is unsigned).
181 */
182 const unsigned int ayear = (unsigned int)year;
183 return ayear % 4 == 0 && (ayear % 100 != 0 || ayear % 400 == 0);
Tim Peters2a799bf2002-12-16 20:18:38 +0000184}
185
186/* year, month -> number of days in that month in that year */
187static int
188days_in_month(int year, int month)
189{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000190 assert(month >= 1);
191 assert(month <= 12);
192 if (month == 2 && is_leap(year))
193 return 29;
194 else
195 return _days_in_month[month];
Tim Peters2a799bf2002-12-16 20:18:38 +0000196}
197
198/* year, month -> number of days in year preceeding first day of month */
199static int
200days_before_month(int year, int month)
201{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000202 int days;
Tim Peters2a799bf2002-12-16 20:18:38 +0000203
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000204 assert(month >= 1);
205 assert(month <= 12);
206 days = _days_before_month[month];
207 if (month > 2 && is_leap(year))
208 ++days;
209 return days;
Tim Peters2a799bf2002-12-16 20:18:38 +0000210}
211
212/* year -> number of days before January 1st of year. Remember that we
213 * start with year 1, so days_before_year(1) == 0.
214 */
215static int
216days_before_year(int year)
217{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000218 int y = year - 1;
219 /* This is incorrect if year <= 0; we really want the floor
220 * here. But so long as MINYEAR is 1, the smallest year this
221 * can see is 0 (this can happen in some normalization endcases),
222 * so we'll just special-case that.
223 */
224 assert (year >= 0);
225 if (y >= 0)
226 return y*365 + y/4 - y/100 + y/400;
227 else {
228 assert(y == -1);
229 return -366;
230 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000231}
232
233/* Number of days in 4, 100, and 400 year cycles. That these have
234 * the correct values is asserted in the module init function.
235 */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000236#define DI4Y 1461 /* days_before_year(5); days in 4 years */
237#define DI100Y 36524 /* days_before_year(101); days in 100 years */
238#define DI400Y 146097 /* days_before_year(401); days in 400 years */
Tim Peters2a799bf2002-12-16 20:18:38 +0000239
240/* ordinal -> year, month, day, considering 01-Jan-0001 as day 1. */
241static void
242ord_to_ymd(int ordinal, int *year, int *month, int *day)
243{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000244 int n, n1, n4, n100, n400, leapyear, preceding;
Tim Peters2a799bf2002-12-16 20:18:38 +0000245
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000246 /* ordinal is a 1-based index, starting at 1-Jan-1. The pattern of
247 * leap years repeats exactly every 400 years. The basic strategy is
248 * to find the closest 400-year boundary at or before ordinal, then
249 * work with the offset from that boundary to ordinal. Life is much
250 * clearer if we subtract 1 from ordinal first -- then the values
251 * of ordinal at 400-year boundaries are exactly those divisible
252 * by DI400Y:
253 *
254 * D M Y n n-1
255 * -- --- ---- ---------- ----------------
256 * 31 Dec -400 -DI400Y -DI400Y -1
257 * 1 Jan -399 -DI400Y +1 -DI400Y 400-year boundary
258 * ...
259 * 30 Dec 000 -1 -2
260 * 31 Dec 000 0 -1
261 * 1 Jan 001 1 0 400-year boundary
262 * 2 Jan 001 2 1
263 * 3 Jan 001 3 2
264 * ...
265 * 31 Dec 400 DI400Y DI400Y -1
266 * 1 Jan 401 DI400Y +1 DI400Y 400-year boundary
267 */
268 assert(ordinal >= 1);
269 --ordinal;
270 n400 = ordinal / DI400Y;
271 n = ordinal % DI400Y;
272 *year = n400 * 400 + 1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000273
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000274 /* Now n is the (non-negative) offset, in days, from January 1 of
275 * year, to the desired date. Now compute how many 100-year cycles
276 * precede n.
277 * Note that it's possible for n100 to equal 4! In that case 4 full
278 * 100-year cycles precede the desired day, which implies the
279 * desired day is December 31 at the end of a 400-year cycle.
280 */
281 n100 = n / DI100Y;
282 n = n % DI100Y;
Tim Peters2a799bf2002-12-16 20:18:38 +0000283
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000284 /* Now compute how many 4-year cycles precede it. */
285 n4 = n / DI4Y;
286 n = n % DI4Y;
Tim Peters2a799bf2002-12-16 20:18:38 +0000287
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000288 /* And now how many single years. Again n1 can be 4, and again
289 * meaning that the desired day is December 31 at the end of the
290 * 4-year cycle.
291 */
292 n1 = n / 365;
293 n = n % 365;
Tim Peters2a799bf2002-12-16 20:18:38 +0000294
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000295 *year += n100 * 100 + n4 * 4 + n1;
296 if (n1 == 4 || n100 == 4) {
297 assert(n == 0);
298 *year -= 1;
299 *month = 12;
300 *day = 31;
301 return;
302 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000303
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000304 /* Now the year is correct, and n is the offset from January 1. We
305 * find the month via an estimate that's either exact or one too
306 * large.
307 */
308 leapyear = n1 == 3 && (n4 != 24 || n100 == 3);
309 assert(leapyear == is_leap(*year));
310 *month = (n + 50) >> 5;
311 preceding = (_days_before_month[*month] + (*month > 2 && leapyear));
312 if (preceding > n) {
313 /* estimate is too large */
314 *month -= 1;
315 preceding -= days_in_month(*year, *month);
316 }
317 n -= preceding;
318 assert(0 <= n);
319 assert(n < days_in_month(*year, *month));
Tim Peters2a799bf2002-12-16 20:18:38 +0000320
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000321 *day = n + 1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000322}
323
324/* year, month, day -> ordinal, considering 01-Jan-0001 as day 1. */
325static int
326ymd_to_ord(int year, int month, int day)
327{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000328 return days_before_year(year) + days_before_month(year, month) + day;
Tim Peters2a799bf2002-12-16 20:18:38 +0000329}
330
331/* Day of week, where Monday==0, ..., Sunday==6. 1/1/1 was a Monday. */
332static int
333weekday(int year, int month, int day)
334{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000335 return (ymd_to_ord(year, month, day) + 6) % 7;
Tim Peters2a799bf2002-12-16 20:18:38 +0000336}
337
338/* Ordinal of the Monday starting week 1 of the ISO year. Week 1 is the
339 * first calendar week containing a Thursday.
340 */
341static int
342iso_week1_monday(int year)
343{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000344 int first_day = ymd_to_ord(year, 1, 1); /* ord of 1/1 */
345 /* 0 if 1/1 is a Monday, 1 if a Tue, etc. */
346 int first_weekday = (first_day + 6) % 7;
347 /* ordinal of closest Monday at or before 1/1 */
348 int week1_monday = first_day - first_weekday;
Tim Peters2a799bf2002-12-16 20:18:38 +0000349
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000350 if (first_weekday > 3) /* if 1/1 was Fri, Sat, Sun */
351 week1_monday += 7;
352 return week1_monday;
Tim Peters2a799bf2002-12-16 20:18:38 +0000353}
354
355/* ---------------------------------------------------------------------------
356 * Range checkers.
357 */
358
359/* Check that -MAX_DELTA_DAYS <= days <= MAX_DELTA_DAYS. If so, return 0.
360 * If not, raise OverflowError and return -1.
361 */
362static int
363check_delta_day_range(int days)
364{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000365 if (-MAX_DELTA_DAYS <= days && days <= MAX_DELTA_DAYS)
366 return 0;
367 PyErr_Format(PyExc_OverflowError,
368 "days=%d; must have magnitude <= %d",
369 days, MAX_DELTA_DAYS);
370 return -1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000371}
372
373/* Check that date arguments are in range. Return 0 if they are. If they
374 * aren't, raise ValueError and return -1.
375 */
376static int
377check_date_args(int year, int month, int day)
378{
379
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000380 if (year < MINYEAR || year > MAXYEAR) {
381 PyErr_SetString(PyExc_ValueError,
382 "year is out of range");
383 return -1;
384 }
385 if (month < 1 || month > 12) {
386 PyErr_SetString(PyExc_ValueError,
387 "month must be in 1..12");
388 return -1;
389 }
390 if (day < 1 || day > days_in_month(year, month)) {
391 PyErr_SetString(PyExc_ValueError,
392 "day is out of range for month");
393 return -1;
394 }
395 return 0;
Tim Peters2a799bf2002-12-16 20:18:38 +0000396}
397
398/* Check that time arguments are in range. Return 0 if they are. If they
399 * aren't, raise ValueError and return -1.
400 */
401static int
402check_time_args(int h, int m, int s, int us)
403{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000404 if (h < 0 || h > 23) {
405 PyErr_SetString(PyExc_ValueError,
406 "hour must be in 0..23");
407 return -1;
408 }
409 if (m < 0 || m > 59) {
410 PyErr_SetString(PyExc_ValueError,
411 "minute must be in 0..59");
412 return -1;
413 }
414 if (s < 0 || s > 59) {
415 PyErr_SetString(PyExc_ValueError,
416 "second must be in 0..59");
417 return -1;
418 }
419 if (us < 0 || us > 999999) {
420 PyErr_SetString(PyExc_ValueError,
421 "microsecond must be in 0..999999");
422 return -1;
423 }
424 return 0;
Tim Peters2a799bf2002-12-16 20:18:38 +0000425}
426
427/* ---------------------------------------------------------------------------
428 * Normalization utilities.
429 */
430
431/* One step of a mixed-radix conversion. A "hi" unit is equivalent to
432 * factor "lo" units. factor must be > 0. If *lo is less than 0, or
433 * at least factor, enough of *lo is converted into "hi" units so that
434 * 0 <= *lo < factor. The input values must be such that int overflow
435 * is impossible.
436 */
437static void
438normalize_pair(int *hi, int *lo, int factor)
439{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000440 assert(factor > 0);
441 assert(lo != hi);
442 if (*lo < 0 || *lo >= factor) {
443 const int num_hi = divmod(*lo, factor, lo);
444 const int new_hi = *hi + num_hi;
445 assert(! SIGNED_ADD_OVERFLOWED(new_hi, *hi, num_hi));
446 *hi = new_hi;
447 }
448 assert(0 <= *lo && *lo < factor);
Tim Peters2a799bf2002-12-16 20:18:38 +0000449}
450
451/* Fiddle days (d), seconds (s), and microseconds (us) so that
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000452 * 0 <= *s < 24*3600
453 * 0 <= *us < 1000000
Tim Peters2a799bf2002-12-16 20:18:38 +0000454 * The input values must be such that the internals don't overflow.
455 * The way this routine is used, we don't get close.
456 */
457static void
458normalize_d_s_us(int *d, int *s, int *us)
459{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000460 if (*us < 0 || *us >= 1000000) {
461 normalize_pair(s, us, 1000000);
462 /* |s| can't be bigger than about
463 * |original s| + |original us|/1000000 now.
464 */
Tim Peters2a799bf2002-12-16 20:18:38 +0000465
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000466 }
467 if (*s < 0 || *s >= 24*3600) {
468 normalize_pair(d, s, 24*3600);
469 /* |d| can't be bigger than about
470 * |original d| +
471 * (|original s| + |original us|/1000000) / (24*3600) now.
472 */
473 }
474 assert(0 <= *s && *s < 24*3600);
475 assert(0 <= *us && *us < 1000000);
Tim Peters2a799bf2002-12-16 20:18:38 +0000476}
477
478/* Fiddle years (y), months (m), and days (d) so that
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000479 * 1 <= *m <= 12
480 * 1 <= *d <= days_in_month(*y, *m)
Tim Peters2a799bf2002-12-16 20:18:38 +0000481 * The input values must be such that the internals don't overflow.
482 * The way this routine is used, we don't get close.
483 */
Alexander Belopolsky3efc2fd2010-05-27 22:03:53 +0000484static int
Tim Peters2a799bf2002-12-16 20:18:38 +0000485normalize_y_m_d(int *y, int *m, int *d)
486{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000487 int dim; /* # of days in month */
Tim Peters2a799bf2002-12-16 20:18:38 +0000488
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000489 /* This gets muddy: the proper range for day can't be determined
490 * without knowing the correct month and year, but if day is, e.g.,
491 * plus or minus a million, the current month and year values make
492 * no sense (and may also be out of bounds themselves).
493 * Saying 12 months == 1 year should be non-controversial.
494 */
495 if (*m < 1 || *m > 12) {
496 --*m;
497 normalize_pair(y, m, 12);
498 ++*m;
499 /* |y| can't be bigger than about
500 * |original y| + |original m|/12 now.
501 */
502 }
503 assert(1 <= *m && *m <= 12);
Tim Peters2a799bf2002-12-16 20:18:38 +0000504
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000505 /* Now only day can be out of bounds (year may also be out of bounds
506 * for a datetime object, but we don't care about that here).
507 * If day is out of bounds, what to do is arguable, but at least the
508 * method here is principled and explainable.
509 */
510 dim = days_in_month(*y, *m);
511 if (*d < 1 || *d > dim) {
512 /* Move day-1 days from the first of the month. First try to
513 * get off cheap if we're only one day out of range
514 * (adjustments for timezone alone can't be worse than that).
515 */
516 if (*d == 0) {
517 --*m;
518 if (*m > 0)
519 *d = days_in_month(*y, *m);
520 else {
521 --*y;
522 *m = 12;
523 *d = 31;
524 }
525 }
526 else if (*d == dim + 1) {
527 /* move forward a day */
528 ++*m;
529 *d = 1;
530 if (*m > 12) {
531 *m = 1;
532 ++*y;
533 }
534 }
535 else {
536 int ordinal = ymd_to_ord(*y, *m, 1) +
537 *d - 1;
Alexander Belopolsky3efc2fd2010-05-27 22:03:53 +0000538 if (ordinal < 1 || ordinal > MAXORDINAL) {
539 goto error;
540 } else {
541 ord_to_ymd(ordinal, y, m, d);
542 return 0;
543 }
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000544 }
545 }
546 assert(*m > 0);
547 assert(*d > 0);
Alexander Belopolsky3efc2fd2010-05-27 22:03:53 +0000548 if (MINYEAR <= *y && *y <= MAXYEAR)
549 return 0;
550 error:
551 PyErr_SetString(PyExc_OverflowError,
552 "date value out of range");
553 return -1;
554
Tim Peters2a799bf2002-12-16 20:18:38 +0000555}
556
557/* Fiddle out-of-bounds months and days so that the result makes some kind
558 * of sense. The parameters are both inputs and outputs. Returns < 0 on
559 * failure, where failure means the adjusted year is out of bounds.
560 */
561static int
562normalize_date(int *year, int *month, int *day)
563{
Alexander Belopolsky3efc2fd2010-05-27 22:03:53 +0000564 return normalize_y_m_d(year, month, day);
Tim Peters2a799bf2002-12-16 20:18:38 +0000565}
566
567/* Force all the datetime fields into range. The parameters are both
568 * inputs and outputs. Returns < 0 on error.
569 */
570static int
571normalize_datetime(int *year, int *month, int *day,
572 int *hour, int *minute, int *second,
573 int *microsecond)
574{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000575 normalize_pair(second, microsecond, 1000000);
576 normalize_pair(minute, second, 60);
577 normalize_pair(hour, minute, 60);
578 normalize_pair(day, hour, 24);
579 return normalize_date(year, month, day);
Tim Peters2a799bf2002-12-16 20:18:38 +0000580}
581
582/* ---------------------------------------------------------------------------
Tim Petersb0c854d2003-05-17 15:57:00 +0000583 * Basic object allocation: tp_alloc implementations. These allocate
584 * Python objects of the right size and type, and do the Python object-
585 * initialization bit. If there's not enough memory, they return NULL after
586 * setting MemoryError. All data members remain uninitialized trash.
587 *
588 * We abuse the tp_alloc "nitems" argument to communicate whether a tzinfo
Tim Peters03eaf8b2003-05-18 02:24:46 +0000589 * member is needed. This is ugly, imprecise, and possibly insecure.
590 * tp_basicsize for the time and datetime types is set to the size of the
591 * struct that has room for the tzinfo member, so subclasses in Python will
592 * allocate enough space for a tzinfo member whether or not one is actually
593 * needed. That's the "ugly and imprecise" parts. The "possibly insecure"
594 * part is that PyType_GenericAlloc() (which subclasses in Python end up
595 * using) just happens today to effectively ignore the nitems argument
596 * when tp_itemsize is 0, which it is for these type objects. If that
597 * changes, perhaps the callers of tp_alloc slots in this file should
598 * be changed to force a 0 nitems argument unless the type being allocated
599 * is a base type implemented in this file (so that tp_alloc is time_alloc
600 * or datetime_alloc below, which know about the nitems abuse).
Tim Petersb0c854d2003-05-17 15:57:00 +0000601 */
602
603static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000604time_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000605{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000606 PyObject *self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000607
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000608 self = (PyObject *)
609 PyObject_MALLOC(aware ?
610 sizeof(PyDateTime_Time) :
611 sizeof(_PyDateTime_BaseTime));
612 if (self == NULL)
613 return (PyObject *)PyErr_NoMemory();
614 PyObject_INIT(self, type);
615 return self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000616}
617
618static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000619datetime_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000620{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000621 PyObject *self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000622
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000623 self = (PyObject *)
624 PyObject_MALLOC(aware ?
625 sizeof(PyDateTime_DateTime) :
626 sizeof(_PyDateTime_BaseDateTime));
627 if (self == NULL)
628 return (PyObject *)PyErr_NoMemory();
629 PyObject_INIT(self, type);
630 return self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000631}
632
633/* ---------------------------------------------------------------------------
634 * Helpers for setting object fields. These work on pointers to the
635 * appropriate base class.
636 */
637
638/* For date and datetime. */
639static void
640set_date_fields(PyDateTime_Date *self, int y, int m, int d)
641{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000642 self->hashcode = -1;
643 SET_YEAR(self, y);
644 SET_MONTH(self, m);
645 SET_DAY(self, d);
Tim Petersb0c854d2003-05-17 15:57:00 +0000646}
647
648/* ---------------------------------------------------------------------------
649 * Create various objects, mostly without range checking.
650 */
651
652/* Create a date instance with no range checking. */
653static PyObject *
654new_date_ex(int year, int month, int day, PyTypeObject *type)
655{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000656 PyDateTime_Date *self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000657
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000658 self = (PyDateTime_Date *) (type->tp_alloc(type, 0));
659 if (self != NULL)
660 set_date_fields(self, year, month, day);
661 return (PyObject *) self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000662}
663
664#define new_date(year, month, day) \
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000665 new_date_ex(year, month, day, &PyDateTime_DateType)
Tim Petersb0c854d2003-05-17 15:57:00 +0000666
667/* Create a datetime instance with no range checking. */
668static PyObject *
669new_datetime_ex(int year, int month, int day, int hour, int minute,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000670 int second, int usecond, PyObject *tzinfo, PyTypeObject *type)
Tim Petersb0c854d2003-05-17 15:57:00 +0000671{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000672 PyDateTime_DateTime *self;
673 char aware = tzinfo != Py_None;
Tim Petersb0c854d2003-05-17 15:57:00 +0000674
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000675 self = (PyDateTime_DateTime *) (type->tp_alloc(type, aware));
676 if (self != NULL) {
677 self->hastzinfo = aware;
678 set_date_fields((PyDateTime_Date *)self, year, month, day);
679 DATE_SET_HOUR(self, hour);
680 DATE_SET_MINUTE(self, minute);
681 DATE_SET_SECOND(self, second);
682 DATE_SET_MICROSECOND(self, usecond);
683 if (aware) {
684 Py_INCREF(tzinfo);
685 self->tzinfo = tzinfo;
686 }
687 }
688 return (PyObject *)self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000689}
690
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000691#define new_datetime(y, m, d, hh, mm, ss, us, tzinfo) \
692 new_datetime_ex(y, m, d, hh, mm, ss, us, tzinfo, \
693 &PyDateTime_DateTimeType)
Tim Petersb0c854d2003-05-17 15:57:00 +0000694
695/* Create a time instance with no range checking. */
696static PyObject *
697new_time_ex(int hour, int minute, int second, int usecond,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000698 PyObject *tzinfo, PyTypeObject *type)
Tim Petersb0c854d2003-05-17 15:57:00 +0000699{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000700 PyDateTime_Time *self;
701 char aware = tzinfo != Py_None;
Tim Petersb0c854d2003-05-17 15:57:00 +0000702
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000703 self = (PyDateTime_Time *) (type->tp_alloc(type, aware));
704 if (self != NULL) {
705 self->hastzinfo = aware;
706 self->hashcode = -1;
707 TIME_SET_HOUR(self, hour);
708 TIME_SET_MINUTE(self, minute);
709 TIME_SET_SECOND(self, second);
710 TIME_SET_MICROSECOND(self, usecond);
711 if (aware) {
712 Py_INCREF(tzinfo);
713 self->tzinfo = tzinfo;
714 }
715 }
716 return (PyObject *)self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000717}
718
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000719#define new_time(hh, mm, ss, us, tzinfo) \
720 new_time_ex(hh, mm, ss, us, tzinfo, &PyDateTime_TimeType)
Tim Petersb0c854d2003-05-17 15:57:00 +0000721
722/* Create a timedelta instance. Normalize the members iff normalize is
723 * true. Passing false is a speed optimization, if you know for sure
724 * that seconds and microseconds are already in their proper ranges. In any
725 * case, raises OverflowError and returns NULL if the normalized days is out
726 * of range).
727 */
728static PyObject *
729new_delta_ex(int days, int seconds, int microseconds, int normalize,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000730 PyTypeObject *type)
Tim Petersb0c854d2003-05-17 15:57:00 +0000731{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000732 PyDateTime_Delta *self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000733
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000734 if (normalize)
735 normalize_d_s_us(&days, &seconds, &microseconds);
736 assert(0 <= seconds && seconds < 24*3600);
737 assert(0 <= microseconds && microseconds < 1000000);
Tim Petersb0c854d2003-05-17 15:57:00 +0000738
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000739 if (check_delta_day_range(days) < 0)
740 return NULL;
Tim Petersb0c854d2003-05-17 15:57:00 +0000741
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000742 self = (PyDateTime_Delta *) (type->tp_alloc(type, 0));
743 if (self != NULL) {
744 self->hashcode = -1;
745 SET_TD_DAYS(self, days);
746 SET_TD_SECONDS(self, seconds);
747 SET_TD_MICROSECONDS(self, microseconds);
748 }
749 return (PyObject *) self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000750}
751
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000752#define new_delta(d, s, us, normalize) \
753 new_delta_ex(d, s, us, normalize, &PyDateTime_DeltaType)
Tim Petersb0c854d2003-05-17 15:57:00 +0000754
755/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +0000756 * tzinfo helpers.
757 */
758
Tim Peters855fe882002-12-22 03:43:39 +0000759/* Ensure that p is None or of a tzinfo subclass. Return 0 if OK; if not
760 * raise TypeError and return -1.
761 */
762static int
763check_tzinfo_subclass(PyObject *p)
764{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000765 if (p == Py_None || PyTZInfo_Check(p))
766 return 0;
767 PyErr_Format(PyExc_TypeError,
768 "tzinfo argument must be None or of a tzinfo subclass, "
769 "not type '%s'",
770 Py_TYPE(p)->tp_name);
771 return -1;
Tim Peters855fe882002-12-22 03:43:39 +0000772}
773
Tim Petersbad8ff02002-12-30 20:52:32 +0000774/* Return tzinfo.methname(tzinfoarg), without any checking of results.
Tim Peters855fe882002-12-22 03:43:39 +0000775 * If tzinfo is None, returns None.
776 */
777static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000778call_tzinfo_method(PyObject *tzinfo, char *methname, PyObject *tzinfoarg)
Tim Peters855fe882002-12-22 03:43:39 +0000779{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000780 PyObject *result;
Tim Peters855fe882002-12-22 03:43:39 +0000781
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000782 assert(tzinfo && methname && tzinfoarg);
783 assert(check_tzinfo_subclass(tzinfo) >= 0);
784 if (tzinfo == Py_None) {
785 result = Py_None;
786 Py_INCREF(result);
787 }
788 else
789 result = PyObject_CallMethod(tzinfo, methname, "O", tzinfoarg);
790 return result;
Tim Peters855fe882002-12-22 03:43:39 +0000791}
792
Tim Peters2a799bf2002-12-16 20:18:38 +0000793/* If self has a tzinfo member, return a BORROWED reference to it. Else
794 * return NULL, which is NOT AN ERROR. There are no error returns here,
795 * and the caller must not decref the result.
796 */
797static PyObject *
798get_tzinfo_member(PyObject *self)
799{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000800 PyObject *tzinfo = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +0000801
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000802 if (PyDateTime_Check(self) && HASTZINFO(self))
803 tzinfo = ((PyDateTime_DateTime *)self)->tzinfo;
804 else if (PyTime_Check(self) && HASTZINFO(self))
805 tzinfo = ((PyDateTime_Time *)self)->tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000806
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000807 return tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000808}
809
Tim Petersbad8ff02002-12-30 20:52:32 +0000810/* Call getattr(tzinfo, name)(tzinfoarg), and extract an int from the
Tim Peters2a799bf2002-12-16 20:18:38 +0000811 * result. tzinfo must be an instance of the tzinfo class. If the method
812 * returns None, this returns 0 and sets *none to 1. If the method doesn't
Tim Peters397301e2003-01-02 21:28:08 +0000813 * return None or timedelta, TypeError is raised and this returns -1. If it
814 * returnsa timedelta and the value is out of range or isn't a whole number
815 * of minutes, ValueError is raised and this returns -1.
Tim Peters2a799bf2002-12-16 20:18:38 +0000816 * Else *none is set to 0 and the integer method result is returned.
817 */
818static int
819call_utc_tzinfo_method(PyObject *tzinfo, char *name, PyObject *tzinfoarg,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000820 int *none)
Tim Peters2a799bf2002-12-16 20:18:38 +0000821{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000822 PyObject *u;
823 int result = -1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000824
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000825 assert(tzinfo != NULL);
826 assert(PyTZInfo_Check(tzinfo));
827 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000828
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000829 *none = 0;
830 u = call_tzinfo_method(tzinfo, name, tzinfoarg);
831 if (u == NULL)
832 return -1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000833
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000834 else if (u == Py_None) {
835 result = 0;
836 *none = 1;
837 }
838 else if (PyDelta_Check(u)) {
839 const int days = GET_TD_DAYS(u);
840 if (days < -1 || days > 0)
841 result = 24*60; /* trigger ValueError below */
842 else {
843 /* next line can't overflow because we know days
844 * is -1 or 0 now
845 */
846 int ss = days * 24 * 3600 + GET_TD_SECONDS(u);
847 result = divmod(ss, 60, &ss);
848 if (ss || GET_TD_MICROSECONDS(u)) {
849 PyErr_Format(PyExc_ValueError,
850 "tzinfo.%s() must return a "
851 "whole number of minutes",
852 name);
853 result = -1;
854 }
855 }
856 }
857 else {
858 PyErr_Format(PyExc_TypeError,
859 "tzinfo.%s() must return None or "
860 "timedelta, not '%s'",
861 name, Py_TYPE(u)->tp_name);
862 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000863
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000864 Py_DECREF(u);
865 if (result < -1439 || result > 1439) {
866 PyErr_Format(PyExc_ValueError,
867 "tzinfo.%s() returned %d; must be in "
868 "-1439 .. 1439",
869 name, result);
870 result = -1;
871 }
872 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +0000873}
874
875/* Call tzinfo.utcoffset(tzinfoarg), and extract an integer from the
876 * result. tzinfo must be an instance of the tzinfo class. If utcoffset()
877 * returns None, call_utcoffset returns 0 and sets *none to 1. If uctoffset()
Tim Peters397301e2003-01-02 21:28:08 +0000878 * doesn't return None or timedelta, TypeError is raised and this returns -1.
879 * If utcoffset() returns an invalid timedelta (out of range, or not a whole
880 * # of minutes), ValueError is raised and this returns -1. Else *none is
881 * set to 0 and the offset is returned (as int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000882 */
883static int
884call_utcoffset(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
885{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000886 return call_utc_tzinfo_method(tzinfo, "utcoffset", tzinfoarg, none);
Tim Peters2a799bf2002-12-16 20:18:38 +0000887}
888
Tim Petersbad8ff02002-12-30 20:52:32 +0000889/* Call tzinfo.name(tzinfoarg), and return the offset as a timedelta or None.
890 */
Tim Peters855fe882002-12-22 03:43:39 +0000891static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000892offset_as_timedelta(PyObject *tzinfo, char *name, PyObject *tzinfoarg) {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000893 PyObject *result;
Tim Peters855fe882002-12-22 03:43:39 +0000894
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000895 assert(tzinfo && name && tzinfoarg);
896 if (tzinfo == Py_None) {
897 result = Py_None;
898 Py_INCREF(result);
899 }
900 else {
901 int none;
902 int offset = call_utc_tzinfo_method(tzinfo, name, tzinfoarg,
903 &none);
904 if (offset < 0 && PyErr_Occurred())
905 return NULL;
906 if (none) {
907 result = Py_None;
908 Py_INCREF(result);
909 }
910 else
911 result = new_delta(0, offset * 60, 0, 1);
912 }
913 return result;
Tim Peters855fe882002-12-22 03:43:39 +0000914}
915
Tim Peters2a799bf2002-12-16 20:18:38 +0000916/* Call tzinfo.dst(tzinfoarg), and extract an integer from the
917 * result. tzinfo must be an instance of the tzinfo class. If dst()
918 * returns None, call_dst returns 0 and sets *none to 1. If dst()
Tim Peters397301e2003-01-02 21:28:08 +0000919 & doesn't return None or timedelta, TypeError is raised and this
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000920 * returns -1. If dst() returns an invalid timedelta for a UTC offset,
Tim Peters397301e2003-01-02 21:28:08 +0000921 * ValueError is raised and this returns -1. Else *none is set to 0 and
922 * the offset is returned (as an int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000923 */
924static int
925call_dst(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
926{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000927 return call_utc_tzinfo_method(tzinfo, "dst", tzinfoarg, none);
Tim Peters2a799bf2002-12-16 20:18:38 +0000928}
929
Tim Petersbad8ff02002-12-30 20:52:32 +0000930/* Call tzinfo.tzname(tzinfoarg), and return the result. tzinfo must be
Tim Peters855fe882002-12-22 03:43:39 +0000931 * an instance of the tzinfo class or None. If tzinfo isn't None, and
Tim Petersbad8ff02002-12-30 20:52:32 +0000932 * tzname() doesn't return None or a string, TypeError is raised and this
Guido van Rossume3d1d412007-05-23 21:24:35 +0000933 * returns NULL. If the result is a string, we ensure it is a Unicode
934 * string.
Tim Peters2a799bf2002-12-16 20:18:38 +0000935 */
936static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000937call_tzname(PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +0000938{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000939 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +0000940
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000941 assert(tzinfo != NULL);
942 assert(check_tzinfo_subclass(tzinfo) >= 0);
943 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000944
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000945 if (tzinfo == Py_None) {
946 result = Py_None;
947 Py_INCREF(result);
948 }
949 else
950 result = PyObject_CallMethod(tzinfo, "tzname", "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000951
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000952 if (result != NULL && result != Py_None) {
953 if (!PyUnicode_Check(result)) {
954 PyErr_Format(PyExc_TypeError, "tzinfo.tzname() must "
955 "return None or a string, not '%s'",
956 Py_TYPE(result)->tp_name);
957 Py_DECREF(result);
958 result = NULL;
959 }
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000960 }
961 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +0000962}
963
964typedef enum {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000965 /* an exception has been set; the caller should pass it on */
966 OFFSET_ERROR,
Tim Peters2a799bf2002-12-16 20:18:38 +0000967
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000968 /* type isn't date, datetime, or time subclass */
969 OFFSET_UNKNOWN,
Tim Peters2a799bf2002-12-16 20:18:38 +0000970
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000971 /* date,
972 * datetime with !hastzinfo
973 * datetime with None tzinfo,
974 * datetime where utcoffset() returns None
975 * time with !hastzinfo
976 * time with None tzinfo,
977 * time where utcoffset() returns None
978 */
979 OFFSET_NAIVE,
Tim Peters2a799bf2002-12-16 20:18:38 +0000980
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000981 /* time or datetime where utcoffset() doesn't return None */
982 OFFSET_AWARE
Tim Peters2a799bf2002-12-16 20:18:38 +0000983} naivety;
984
Tim Peters14b69412002-12-22 18:10:22 +0000985/* Classify an object as to whether it's naive or offset-aware. See
Tim Peters2a799bf2002-12-16 20:18:38 +0000986 * the "naivety" typedef for details. If the type is aware, *offset is set
987 * to minutes east of UTC (as returned by the tzinfo.utcoffset() method).
Tim Peters14b69412002-12-22 18:10:22 +0000988 * If the type is offset-naive (or unknown, or error), *offset is set to 0.
Tim Peterse39a80c2002-12-30 21:28:52 +0000989 * tzinfoarg is the argument to pass to the tzinfo.utcoffset() method.
Tim Peters2a799bf2002-12-16 20:18:38 +0000990 */
991static naivety
Tim Peterse39a80c2002-12-30 21:28:52 +0000992classify_utcoffset(PyObject *op, PyObject *tzinfoarg, int *offset)
Tim Peters2a799bf2002-12-16 20:18:38 +0000993{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000994 int none;
995 PyObject *tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000996
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000997 assert(tzinfoarg != NULL);
998 *offset = 0;
999 tzinfo = get_tzinfo_member(op); /* NULL means no tzinfo, not error */
1000 if (tzinfo == Py_None)
1001 return OFFSET_NAIVE;
1002 if (tzinfo == NULL) {
1003 /* note that a datetime passes the PyDate_Check test */
1004 return (PyTime_Check(op) || PyDate_Check(op)) ?
1005 OFFSET_NAIVE : OFFSET_UNKNOWN;
1006 }
1007 *offset = call_utcoffset(tzinfo, tzinfoarg, &none);
1008 if (*offset == -1 && PyErr_Occurred())
1009 return OFFSET_ERROR;
1010 return none ? OFFSET_NAIVE : OFFSET_AWARE;
Tim Peters2a799bf2002-12-16 20:18:38 +00001011}
1012
Tim Peters00237032002-12-27 02:21:51 +00001013/* Classify two objects as to whether they're naive or offset-aware.
1014 * This isn't quite the same as calling classify_utcoffset() twice: for
1015 * binary operations (comparison and subtraction), we generally want to
1016 * ignore the tzinfo members if they're identical. This is by design,
1017 * so that results match "naive" expectations when mixing objects from a
1018 * single timezone. So in that case, this sets both offsets to 0 and
1019 * both naiveties to OFFSET_NAIVE.
1020 * The function returns 0 if everything's OK, and -1 on error.
1021 */
1022static int
1023classify_two_utcoffsets(PyObject *o1, int *offset1, naivety *n1,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001024 PyObject *tzinfoarg1,
1025 PyObject *o2, int *offset2, naivety *n2,
1026 PyObject *tzinfoarg2)
Tim Peters00237032002-12-27 02:21:51 +00001027{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001028 if (get_tzinfo_member(o1) == get_tzinfo_member(o2)) {
1029 *offset1 = *offset2 = 0;
1030 *n1 = *n2 = OFFSET_NAIVE;
1031 }
1032 else {
1033 *n1 = classify_utcoffset(o1, tzinfoarg1, offset1);
1034 if (*n1 == OFFSET_ERROR)
1035 return -1;
1036 *n2 = classify_utcoffset(o2, tzinfoarg2, offset2);
1037 if (*n2 == OFFSET_ERROR)
1038 return -1;
1039 }
1040 return 0;
Tim Peters00237032002-12-27 02:21:51 +00001041}
1042
Tim Peters2a799bf2002-12-16 20:18:38 +00001043/* repr is like "someclass(arg1, arg2)". If tzinfo isn't None,
1044 * stuff
1045 * ", tzinfo=" + repr(tzinfo)
1046 * before the closing ")".
1047 */
1048static PyObject *
1049append_keyword_tzinfo(PyObject *repr, PyObject *tzinfo)
1050{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001051 PyObject *temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001052
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001053 assert(PyUnicode_Check(repr));
1054 assert(tzinfo);
1055 if (tzinfo == Py_None)
1056 return repr;
1057 /* Get rid of the trailing ')'. */
1058 assert(PyUnicode_AS_UNICODE(repr)[PyUnicode_GET_SIZE(repr)-1] == ')');
1059 temp = PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(repr),
1060 PyUnicode_GET_SIZE(repr) - 1);
1061 Py_DECREF(repr);
1062 if (temp == NULL)
1063 return NULL;
1064 repr = PyUnicode_FromFormat("%U, tzinfo=%R)", temp, tzinfo);
1065 Py_DECREF(temp);
1066 return repr;
Tim Peters2a799bf2002-12-16 20:18:38 +00001067}
1068
1069/* ---------------------------------------------------------------------------
1070 * String format helpers.
1071 */
1072
1073static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00001074format_ctime(PyDateTime_Date *date, int hours, int minutes, int seconds)
Tim Peters2a799bf2002-12-16 20:18:38 +00001075{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001076 static const char *DayNames[] = {
1077 "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"
1078 };
1079 static const char *MonthNames[] = {
1080 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1081 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
1082 };
Tim Peters2a799bf2002-12-16 20:18:38 +00001083
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001084 int wday = weekday(GET_YEAR(date), GET_MONTH(date), GET_DAY(date));
Tim Peters2a799bf2002-12-16 20:18:38 +00001085
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001086 return PyUnicode_FromFormat("%s %s %2d %02d:%02d:%02d %04d",
1087 DayNames[wday], MonthNames[GET_MONTH(date)-1],
1088 GET_DAY(date), hours, minutes, seconds,
1089 GET_YEAR(date));
Tim Peters2a799bf2002-12-16 20:18:38 +00001090}
1091
1092/* Add an hours & minutes UTC offset string to buf. buf has no more than
1093 * buflen bytes remaining. The UTC offset is gotten by calling
1094 * tzinfo.uctoffset(tzinfoarg). If that returns None, \0 is stored into
1095 * *buf, and that's all. Else the returned value is checked for sanity (an
1096 * integer in range), and if that's OK it's converted to an hours & minutes
1097 * string of the form
1098 * sign HH sep MM
1099 * Returns 0 if everything is OK. If the return value from utcoffset() is
1100 * bogus, an appropriate exception is set and -1 is returned.
1101 */
1102static int
Tim Peters328fff72002-12-20 01:31:27 +00001103format_utcoffset(char *buf, size_t buflen, const char *sep,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001104 PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001105{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001106 int offset;
1107 int hours;
1108 int minutes;
1109 char sign;
1110 int none;
Tim Peters2a799bf2002-12-16 20:18:38 +00001111
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001112 assert(buflen >= 1);
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +00001113
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001114 offset = call_utcoffset(tzinfo, tzinfoarg, &none);
1115 if (offset == -1 && PyErr_Occurred())
1116 return -1;
1117 if (none) {
1118 *buf = '\0';
1119 return 0;
1120 }
1121 sign = '+';
1122 if (offset < 0) {
1123 sign = '-';
1124 offset = - offset;
1125 }
1126 hours = divmod(offset, 60, &minutes);
1127 PyOS_snprintf(buf, buflen, "%c%02d%s%02d", sign, hours, sep, minutes);
1128 return 0;
Tim Peters2a799bf2002-12-16 20:18:38 +00001129}
1130
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001131static PyObject *
1132make_Zreplacement(PyObject *object, PyObject *tzinfoarg)
1133{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001134 PyObject *temp;
1135 PyObject *tzinfo = get_tzinfo_member(object);
1136 PyObject *Zreplacement = PyUnicode_FromStringAndSize(NULL, 0);
1137 if (Zreplacement == NULL)
1138 return NULL;
1139 if (tzinfo == Py_None || tzinfo == NULL)
1140 return Zreplacement;
Neal Norwitzaea70e02007-08-12 04:32:26 +00001141
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001142 assert(tzinfoarg != NULL);
1143 temp = call_tzname(tzinfo, tzinfoarg);
1144 if (temp == NULL)
1145 goto Error;
1146 if (temp == Py_None) {
1147 Py_DECREF(temp);
1148 return Zreplacement;
1149 }
Neal Norwitzaea70e02007-08-12 04:32:26 +00001150
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001151 assert(PyUnicode_Check(temp));
1152 /* Since the tzname is getting stuffed into the
1153 * format, we have to double any % signs so that
1154 * strftime doesn't treat them as format codes.
1155 */
1156 Py_DECREF(Zreplacement);
1157 Zreplacement = PyObject_CallMethod(temp, "replace", "ss", "%", "%%");
1158 Py_DECREF(temp);
1159 if (Zreplacement == NULL)
1160 return NULL;
1161 if (!PyUnicode_Check(Zreplacement)) {
1162 PyErr_SetString(PyExc_TypeError,
1163 "tzname.replace() did not return a string");
1164 goto Error;
1165 }
1166 return Zreplacement;
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001167
1168 Error:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001169 Py_DECREF(Zreplacement);
1170 return NULL;
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001171}
1172
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001173static PyObject *
1174make_freplacement(PyObject *object)
1175{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001176 char freplacement[64];
1177 if (PyTime_Check(object))
1178 sprintf(freplacement, "%06d", TIME_GET_MICROSECOND(object));
1179 else if (PyDateTime_Check(object))
1180 sprintf(freplacement, "%06d", DATE_GET_MICROSECOND(object));
1181 else
1182 sprintf(freplacement, "%06d", 0);
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001183
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001184 return PyBytes_FromStringAndSize(freplacement, strlen(freplacement));
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001185}
1186
Tim Peters2a799bf2002-12-16 20:18:38 +00001187/* I sure don't want to reproduce the strftime code from the time module,
1188 * so this imports the module and calls it. All the hair is due to
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001189 * giving special meanings to the %z, %Z and %f format codes via a
1190 * preprocessing step on the format string.
Tim Petersbad8ff02002-12-30 20:52:32 +00001191 * tzinfoarg is the argument to pass to the object's tzinfo method, if
1192 * needed.
Tim Peters2a799bf2002-12-16 20:18:38 +00001193 */
1194static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +00001195wrap_strftime(PyObject *object, PyObject *format, PyObject *timetuple,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001196 PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001197{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001198 PyObject *result = NULL; /* guilty until proved innocent */
Tim Peters2a799bf2002-12-16 20:18:38 +00001199
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001200 PyObject *zreplacement = NULL; /* py string, replacement for %z */
1201 PyObject *Zreplacement = NULL; /* py string, replacement for %Z */
1202 PyObject *freplacement = NULL; /* py string, replacement for %f */
Tim Peters2a799bf2002-12-16 20:18:38 +00001203
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001204 const char *pin; /* pointer to next char in input format */
1205 Py_ssize_t flen; /* length of input format */
1206 char ch; /* next char in input format */
Tim Peters2a799bf2002-12-16 20:18:38 +00001207
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001208 PyObject *newfmt = NULL; /* py string, the output format */
1209 char *pnew; /* pointer to available byte in output format */
1210 size_t totalnew; /* number bytes total in output format buffer,
1211 exclusive of trailing \0 */
1212 size_t usednew; /* number bytes used so far in output format buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001213
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001214 const char *ptoappend; /* ptr to string to append to output buffer */
1215 Py_ssize_t ntoappend; /* # of bytes to append to output buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001216
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001217 assert(object && format && timetuple);
1218 assert(PyUnicode_Check(format));
1219 /* Convert the input format to a C string and size */
1220 pin = _PyUnicode_AsStringAndSize(format, &flen);
1221 if (!pin)
1222 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001223
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001224 /* Give up if the year is before 1900.
1225 * Python strftime() plays games with the year, and different
1226 * games depending on whether envar PYTHON2K is set. This makes
1227 * years before 1900 a nightmare, even if the platform strftime
1228 * supports them (and not all do).
1229 * We could get a lot farther here by avoiding Python's strftime
1230 * wrapper and calling the C strftime() directly, but that isn't
1231 * an option in the Python implementation of this module.
1232 */
1233 {
1234 long year;
1235 PyObject *pyyear = PySequence_GetItem(timetuple, 0);
1236 if (pyyear == NULL) return NULL;
1237 assert(PyLong_Check(pyyear));
1238 year = PyLong_AsLong(pyyear);
1239 Py_DECREF(pyyear);
1240 if (year < 1900) {
1241 PyErr_Format(PyExc_ValueError, "year=%ld is before "
1242 "1900; the datetime strftime() "
1243 "methods require year >= 1900",
1244 year);
1245 return NULL;
1246 }
1247 }
Tim Petersd6844152002-12-22 20:58:42 +00001248
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001249 /* Scan the input format, looking for %z/%Z/%f escapes, building
1250 * a new format. Since computing the replacements for those codes
1251 * is expensive, don't unless they're actually used.
1252 */
1253 if (flen > INT_MAX - 1) {
1254 PyErr_NoMemory();
1255 goto Done;
1256 }
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +00001257
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001258 totalnew = flen + 1; /* realistic if no %z/%Z */
1259 newfmt = PyBytes_FromStringAndSize(NULL, totalnew);
1260 if (newfmt == NULL) goto Done;
1261 pnew = PyBytes_AsString(newfmt);
1262 usednew = 0;
Tim Peters2a799bf2002-12-16 20:18:38 +00001263
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001264 while ((ch = *pin++) != '\0') {
1265 if (ch != '%') {
1266 ptoappend = pin - 1;
1267 ntoappend = 1;
1268 }
1269 else if ((ch = *pin++) == '\0') {
1270 /* There's a lone trailing %; doesn't make sense. */
1271 PyErr_SetString(PyExc_ValueError, "strftime format "
1272 "ends with raw %");
1273 goto Done;
1274 }
1275 /* A % has been seen and ch is the character after it. */
1276 else if (ch == 'z') {
1277 if (zreplacement == NULL) {
1278 /* format utcoffset */
1279 char buf[100];
1280 PyObject *tzinfo = get_tzinfo_member(object);
1281 zreplacement = PyBytes_FromStringAndSize("", 0);
1282 if (zreplacement == NULL) goto Done;
1283 if (tzinfo != Py_None && tzinfo != NULL) {
1284 assert(tzinfoarg != NULL);
1285 if (format_utcoffset(buf,
1286 sizeof(buf),
1287 "",
1288 tzinfo,
1289 tzinfoarg) < 0)
1290 goto Done;
1291 Py_DECREF(zreplacement);
1292 zreplacement =
1293 PyBytes_FromStringAndSize(buf,
1294 strlen(buf));
1295 if (zreplacement == NULL)
1296 goto Done;
1297 }
1298 }
1299 assert(zreplacement != NULL);
1300 ptoappend = PyBytes_AS_STRING(zreplacement);
1301 ntoappend = PyBytes_GET_SIZE(zreplacement);
1302 }
1303 else if (ch == 'Z') {
1304 /* format tzname */
1305 if (Zreplacement == NULL) {
1306 Zreplacement = make_Zreplacement(object,
1307 tzinfoarg);
1308 if (Zreplacement == NULL)
1309 goto Done;
1310 }
1311 assert(Zreplacement != NULL);
1312 assert(PyUnicode_Check(Zreplacement));
1313 ptoappend = _PyUnicode_AsStringAndSize(Zreplacement,
1314 &ntoappend);
1315 ntoappend = Py_SIZE(Zreplacement);
1316 }
1317 else if (ch == 'f') {
1318 /* format microseconds */
1319 if (freplacement == NULL) {
1320 freplacement = make_freplacement(object);
1321 if (freplacement == NULL)
1322 goto Done;
1323 }
1324 assert(freplacement != NULL);
1325 assert(PyBytes_Check(freplacement));
1326 ptoappend = PyBytes_AS_STRING(freplacement);
1327 ntoappend = PyBytes_GET_SIZE(freplacement);
1328 }
1329 else {
1330 /* percent followed by neither z nor Z */
1331 ptoappend = pin - 2;
1332 ntoappend = 2;
1333 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001334
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001335 /* Append the ntoappend chars starting at ptoappend to
1336 * the new format.
1337 */
1338 if (ntoappend == 0)
1339 continue;
1340 assert(ptoappend != NULL);
1341 assert(ntoappend > 0);
1342 while (usednew + ntoappend > totalnew) {
1343 size_t bigger = totalnew << 1;
1344 if ((bigger >> 1) != totalnew) { /* overflow */
1345 PyErr_NoMemory();
1346 goto Done;
1347 }
1348 if (_PyBytes_Resize(&newfmt, bigger) < 0)
1349 goto Done;
1350 totalnew = bigger;
1351 pnew = PyBytes_AsString(newfmt) + usednew;
1352 }
1353 memcpy(pnew, ptoappend, ntoappend);
1354 pnew += ntoappend;
1355 usednew += ntoappend;
1356 assert(usednew <= totalnew);
1357 } /* end while() */
Tim Peters2a799bf2002-12-16 20:18:38 +00001358
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001359 if (_PyBytes_Resize(&newfmt, usednew) < 0)
1360 goto Done;
1361 {
1362 PyObject *format;
1363 PyObject *time = PyImport_ImportModuleNoBlock("time");
1364 if (time == NULL)
1365 goto Done;
1366 format = PyUnicode_FromString(PyBytes_AS_STRING(newfmt));
1367 if (format != NULL) {
1368 result = PyObject_CallMethod(time, "strftime", "OO",
1369 format, timetuple);
1370 Py_DECREF(format);
1371 }
1372 Py_DECREF(time);
1373 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001374 Done:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001375 Py_XDECREF(freplacement);
1376 Py_XDECREF(zreplacement);
1377 Py_XDECREF(Zreplacement);
1378 Py_XDECREF(newfmt);
1379 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001380}
1381
Tim Peters2a799bf2002-12-16 20:18:38 +00001382/* ---------------------------------------------------------------------------
1383 * Wrap functions from the time module. These aren't directly available
1384 * from C. Perhaps they should be.
1385 */
1386
1387/* Call time.time() and return its result (a Python float). */
1388static PyObject *
Guido van Rossumbd43e912002-12-16 20:34:55 +00001389time_time(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00001390{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001391 PyObject *result = NULL;
1392 PyObject *time = PyImport_ImportModuleNoBlock("time");
Tim Peters2a799bf2002-12-16 20:18:38 +00001393
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001394 if (time != NULL) {
1395 result = PyObject_CallMethod(time, "time", "()");
1396 Py_DECREF(time);
1397 }
1398 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001399}
1400
1401/* Build a time.struct_time. The weekday and day number are automatically
1402 * computed from the y,m,d args.
1403 */
1404static PyObject *
1405build_struct_time(int y, int m, int d, int hh, int mm, int ss, int dstflag)
1406{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001407 PyObject *time;
1408 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001409
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001410 time = PyImport_ImportModuleNoBlock("time");
1411 if (time != NULL) {
1412 result = PyObject_CallMethod(time, "struct_time",
1413 "((iiiiiiiii))",
1414 y, m, d,
1415 hh, mm, ss,
1416 weekday(y, m, d),
1417 days_before_month(y, m) + d,
1418 dstflag);
1419 Py_DECREF(time);
1420 }
1421 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001422}
1423
1424/* ---------------------------------------------------------------------------
1425 * Miscellaneous helpers.
1426 */
1427
Mark Dickinsone94c6792009-02-02 20:36:42 +00001428/* For various reasons, we need to use tp_richcompare instead of tp_reserved.
Tim Peters2a799bf2002-12-16 20:18:38 +00001429 * The comparisons here all most naturally compute a cmp()-like result.
1430 * This little helper turns that into a bool result for rich comparisons.
1431 */
1432static PyObject *
1433diff_to_bool(int diff, int op)
1434{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001435 PyObject *result;
1436 int istrue;
Tim Peters2a799bf2002-12-16 20:18:38 +00001437
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001438 switch (op) {
1439 case Py_EQ: istrue = diff == 0; break;
1440 case Py_NE: istrue = diff != 0; break;
1441 case Py_LE: istrue = diff <= 0; break;
1442 case Py_GE: istrue = diff >= 0; break;
1443 case Py_LT: istrue = diff < 0; break;
1444 case Py_GT: istrue = diff > 0; break;
1445 default:
1446 assert(! "op unknown");
1447 istrue = 0; /* To shut up compiler */
1448 }
1449 result = istrue ? Py_True : Py_False;
1450 Py_INCREF(result);
1451 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001452}
1453
Tim Peters07534a62003-02-07 22:50:28 +00001454/* Raises a "can't compare" TypeError and returns NULL. */
1455static PyObject *
1456cmperror(PyObject *a, PyObject *b)
1457{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001458 PyErr_Format(PyExc_TypeError,
1459 "can't compare %s to %s",
1460 Py_TYPE(a)->tp_name, Py_TYPE(b)->tp_name);
1461 return NULL;
Tim Peters07534a62003-02-07 22:50:28 +00001462}
1463
Tim Peters2a799bf2002-12-16 20:18:38 +00001464/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +00001465 * Cached Python objects; these are set by the module init function.
1466 */
1467
1468/* Conversion factors. */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001469static PyObject *us_per_us = NULL; /* 1 */
1470static PyObject *us_per_ms = NULL; /* 1000 */
1471static PyObject *us_per_second = NULL; /* 1000000 */
1472static PyObject *us_per_minute = NULL; /* 1e6 * 60 as Python int */
1473static PyObject *us_per_hour = NULL; /* 1e6 * 3600 as Python long */
1474static PyObject *us_per_day = NULL; /* 1e6 * 3600 * 24 as Python long */
1475static PyObject *us_per_week = NULL; /* 1e6*3600*24*7 as Python long */
Tim Peters2a799bf2002-12-16 20:18:38 +00001476static PyObject *seconds_per_day = NULL; /* 3600*24 as Python int */
1477
Tim Peters2a799bf2002-12-16 20:18:38 +00001478/* ---------------------------------------------------------------------------
1479 * Class implementations.
1480 */
1481
1482/*
1483 * PyDateTime_Delta implementation.
1484 */
1485
1486/* Convert a timedelta to a number of us,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001487 * (24*3600*self.days + self.seconds)*1000000 + self.microseconds
Tim Peters2a799bf2002-12-16 20:18:38 +00001488 * as a Python int or long.
1489 * Doing mixed-radix arithmetic by hand instead is excruciating in C,
1490 * due to ubiquitous overflow possibilities.
1491 */
1492static PyObject *
1493delta_to_microseconds(PyDateTime_Delta *self)
1494{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001495 PyObject *x1 = NULL;
1496 PyObject *x2 = NULL;
1497 PyObject *x3 = NULL;
1498 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001499
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001500 x1 = PyLong_FromLong(GET_TD_DAYS(self));
1501 if (x1 == NULL)
1502 goto Done;
1503 x2 = PyNumber_Multiply(x1, seconds_per_day); /* days in seconds */
1504 if (x2 == NULL)
1505 goto Done;
1506 Py_DECREF(x1);
1507 x1 = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001508
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001509 /* x2 has days in seconds */
1510 x1 = PyLong_FromLong(GET_TD_SECONDS(self)); /* seconds */
1511 if (x1 == NULL)
1512 goto Done;
1513 x3 = PyNumber_Add(x1, x2); /* days and seconds in seconds */
1514 if (x3 == NULL)
1515 goto Done;
1516 Py_DECREF(x1);
1517 Py_DECREF(x2);
1518 x1 = x2 = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001519
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001520 /* x3 has days+seconds in seconds */
1521 x1 = PyNumber_Multiply(x3, us_per_second); /* us */
1522 if (x1 == NULL)
1523 goto Done;
1524 Py_DECREF(x3);
1525 x3 = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001526
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001527 /* x1 has days+seconds in us */
1528 x2 = PyLong_FromLong(GET_TD_MICROSECONDS(self));
1529 if (x2 == NULL)
1530 goto Done;
1531 result = PyNumber_Add(x1, x2);
Tim Peters2a799bf2002-12-16 20:18:38 +00001532
1533Done:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001534 Py_XDECREF(x1);
1535 Py_XDECREF(x2);
1536 Py_XDECREF(x3);
1537 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001538}
1539
1540/* Convert a number of us (as a Python int or long) to a timedelta.
1541 */
1542static PyObject *
Tim Petersb0c854d2003-05-17 15:57:00 +00001543microseconds_to_delta_ex(PyObject *pyus, PyTypeObject *type)
Tim Peters2a799bf2002-12-16 20:18:38 +00001544{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001545 int us;
1546 int s;
1547 int d;
1548 long temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001549
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001550 PyObject *tuple = NULL;
1551 PyObject *num = NULL;
1552 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001553
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001554 tuple = PyNumber_Divmod(pyus, us_per_second);
1555 if (tuple == NULL)
1556 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00001557
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001558 num = PyTuple_GetItem(tuple, 1); /* us */
1559 if (num == NULL)
1560 goto Done;
1561 temp = PyLong_AsLong(num);
1562 num = NULL;
1563 if (temp == -1 && PyErr_Occurred())
1564 goto Done;
1565 assert(0 <= temp && temp < 1000000);
1566 us = (int)temp;
1567 if (us < 0) {
1568 /* The divisor was positive, so this must be an error. */
1569 assert(PyErr_Occurred());
1570 goto Done;
1571 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001572
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001573 num = PyTuple_GetItem(tuple, 0); /* leftover seconds */
1574 if (num == NULL)
1575 goto Done;
1576 Py_INCREF(num);
1577 Py_DECREF(tuple);
Tim Peters2a799bf2002-12-16 20:18:38 +00001578
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001579 tuple = PyNumber_Divmod(num, seconds_per_day);
1580 if (tuple == NULL)
1581 goto Done;
1582 Py_DECREF(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001583
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001584 num = PyTuple_GetItem(tuple, 1); /* seconds */
1585 if (num == NULL)
1586 goto Done;
1587 temp = PyLong_AsLong(num);
1588 num = NULL;
1589 if (temp == -1 && PyErr_Occurred())
1590 goto Done;
1591 assert(0 <= temp && temp < 24*3600);
1592 s = (int)temp;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001593
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001594 if (s < 0) {
1595 /* The divisor was positive, so this must be an error. */
1596 assert(PyErr_Occurred());
1597 goto Done;
1598 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001599
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001600 num = PyTuple_GetItem(tuple, 0); /* leftover days */
1601 if (num == NULL)
1602 goto Done;
1603 Py_INCREF(num);
1604 temp = PyLong_AsLong(num);
1605 if (temp == -1 && PyErr_Occurred())
1606 goto Done;
1607 d = (int)temp;
1608 if ((long)d != temp) {
1609 PyErr_SetString(PyExc_OverflowError, "normalized days too "
1610 "large to fit in a C int");
1611 goto Done;
1612 }
1613 result = new_delta_ex(d, s, us, 0, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001614
1615Done:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001616 Py_XDECREF(tuple);
1617 Py_XDECREF(num);
1618 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001619}
1620
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001621#define microseconds_to_delta(pymicros) \
1622 microseconds_to_delta_ex(pymicros, &PyDateTime_DeltaType)
Tim Petersb0c854d2003-05-17 15:57:00 +00001623
Tim Peters2a799bf2002-12-16 20:18:38 +00001624static PyObject *
1625multiply_int_timedelta(PyObject *intobj, PyDateTime_Delta *delta)
1626{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001627 PyObject *pyus_in;
1628 PyObject *pyus_out;
1629 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001630
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001631 pyus_in = delta_to_microseconds(delta);
1632 if (pyus_in == NULL)
1633 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001634
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001635 pyus_out = PyNumber_Multiply(pyus_in, intobj);
1636 Py_DECREF(pyus_in);
1637 if (pyus_out == NULL)
1638 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001639
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001640 result = microseconds_to_delta(pyus_out);
1641 Py_DECREF(pyus_out);
1642 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001643}
1644
1645static PyObject *
1646divide_timedelta_int(PyDateTime_Delta *delta, PyObject *intobj)
1647{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001648 PyObject *pyus_in;
1649 PyObject *pyus_out;
1650 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001651
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001652 pyus_in = delta_to_microseconds(delta);
1653 if (pyus_in == NULL)
1654 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001655
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001656 pyus_out = PyNumber_FloorDivide(pyus_in, intobj);
1657 Py_DECREF(pyus_in);
1658 if (pyus_out == NULL)
1659 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001660
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001661 result = microseconds_to_delta(pyus_out);
1662 Py_DECREF(pyus_out);
1663 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001664}
1665
1666static PyObject *
1667delta_add(PyObject *left, PyObject *right)
1668{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001669 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00001670
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001671 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1672 /* delta + delta */
1673 /* The C-level additions can't overflow because of the
1674 * invariant bounds.
1675 */
1676 int days = GET_TD_DAYS(left) + GET_TD_DAYS(right);
1677 int seconds = GET_TD_SECONDS(left) + GET_TD_SECONDS(right);
1678 int microseconds = GET_TD_MICROSECONDS(left) +
1679 GET_TD_MICROSECONDS(right);
1680 result = new_delta(days, seconds, microseconds, 1);
1681 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001682
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001683 if (result == Py_NotImplemented)
1684 Py_INCREF(result);
1685 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001686}
1687
1688static PyObject *
1689delta_negative(PyDateTime_Delta *self)
1690{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001691 return new_delta(-GET_TD_DAYS(self),
1692 -GET_TD_SECONDS(self),
1693 -GET_TD_MICROSECONDS(self),
1694 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00001695}
1696
1697static PyObject *
1698delta_positive(PyDateTime_Delta *self)
1699{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001700 /* Could optimize this (by returning self) if this isn't a
1701 * subclass -- but who uses unary + ? Approximately nobody.
1702 */
1703 return new_delta(GET_TD_DAYS(self),
1704 GET_TD_SECONDS(self),
1705 GET_TD_MICROSECONDS(self),
1706 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00001707}
1708
1709static PyObject *
1710delta_abs(PyDateTime_Delta *self)
1711{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001712 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001713
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001714 assert(GET_TD_MICROSECONDS(self) >= 0);
1715 assert(GET_TD_SECONDS(self) >= 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00001716
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001717 if (GET_TD_DAYS(self) < 0)
1718 result = delta_negative(self);
1719 else
1720 result = delta_positive(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00001721
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001722 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001723}
1724
1725static PyObject *
1726delta_subtract(PyObject *left, PyObject *right)
1727{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001728 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00001729
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001730 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1731 /* delta - delta */
1732 PyObject *minus_right = PyNumber_Negative(right);
1733 if (minus_right) {
1734 result = delta_add(left, minus_right);
1735 Py_DECREF(minus_right);
1736 }
1737 else
1738 result = NULL;
1739 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001740
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001741 if (result == Py_NotImplemented)
1742 Py_INCREF(result);
1743 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001744}
1745
Tim Peters2a799bf2002-12-16 20:18:38 +00001746static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00001747delta_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters2a799bf2002-12-16 20:18:38 +00001748{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001749 if (PyDelta_Check(other)) {
1750 int diff = GET_TD_DAYS(self) - GET_TD_DAYS(other);
1751 if (diff == 0) {
1752 diff = GET_TD_SECONDS(self) - GET_TD_SECONDS(other);
1753 if (diff == 0)
1754 diff = GET_TD_MICROSECONDS(self) -
1755 GET_TD_MICROSECONDS(other);
1756 }
1757 return diff_to_bool(diff, op);
1758 }
1759 else {
1760 Py_INCREF(Py_NotImplemented);
1761 return Py_NotImplemented;
1762 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001763}
1764
1765static PyObject *delta_getstate(PyDateTime_Delta *self);
1766
1767static long
1768delta_hash(PyDateTime_Delta *self)
1769{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001770 if (self->hashcode == -1) {
1771 PyObject *temp = delta_getstate(self);
1772 if (temp != NULL) {
1773 self->hashcode = PyObject_Hash(temp);
1774 Py_DECREF(temp);
1775 }
1776 }
1777 return self->hashcode;
Tim Peters2a799bf2002-12-16 20:18:38 +00001778}
1779
1780static PyObject *
1781delta_multiply(PyObject *left, PyObject *right)
1782{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001783 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00001784
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001785 if (PyDelta_Check(left)) {
1786 /* delta * ??? */
1787 if (PyLong_Check(right))
1788 result = multiply_int_timedelta(right,
1789 (PyDateTime_Delta *) left);
1790 }
1791 else if (PyLong_Check(left))
1792 result = multiply_int_timedelta(left,
1793 (PyDateTime_Delta *) right);
Tim Peters2a799bf2002-12-16 20:18:38 +00001794
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001795 if (result == Py_NotImplemented)
1796 Py_INCREF(result);
1797 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001798}
1799
1800static PyObject *
1801delta_divide(PyObject *left, PyObject *right)
1802{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001803 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00001804
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001805 if (PyDelta_Check(left)) {
1806 /* delta * ??? */
1807 if (PyLong_Check(right))
1808 result = divide_timedelta_int(
1809 (PyDateTime_Delta *)left,
1810 right);
1811 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001812
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001813 if (result == Py_NotImplemented)
1814 Py_INCREF(result);
1815 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001816}
1817
1818/* Fold in the value of the tag ("seconds", "weeks", etc) component of a
1819 * timedelta constructor. sofar is the # of microseconds accounted for
1820 * so far, and there are factor microseconds per current unit, the number
1821 * of which is given by num. num * factor is added to sofar in a
1822 * numerically careful way, and that's the result. Any fractional
1823 * microseconds left over (this can happen if num is a float type) are
1824 * added into *leftover.
1825 * Note that there are many ways this can give an error (NULL) return.
1826 */
1827static PyObject *
1828accum(const char* tag, PyObject *sofar, PyObject *num, PyObject *factor,
1829 double *leftover)
1830{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001831 PyObject *prod;
1832 PyObject *sum;
Tim Peters2a799bf2002-12-16 20:18:38 +00001833
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001834 assert(num != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001835
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001836 if (PyLong_Check(num)) {
1837 prod = PyNumber_Multiply(num, factor);
1838 if (prod == NULL)
1839 return NULL;
1840 sum = PyNumber_Add(sofar, prod);
1841 Py_DECREF(prod);
1842 return sum;
1843 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001844
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001845 if (PyFloat_Check(num)) {
1846 double dnum;
1847 double fracpart;
1848 double intpart;
1849 PyObject *x;
1850 PyObject *y;
Tim Peters2a799bf2002-12-16 20:18:38 +00001851
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001852 /* The Plan: decompose num into an integer part and a
1853 * fractional part, num = intpart + fracpart.
1854 * Then num * factor ==
1855 * intpart * factor + fracpart * factor
1856 * and the LHS can be computed exactly in long arithmetic.
1857 * The RHS is again broken into an int part and frac part.
1858 * and the frac part is added into *leftover.
1859 */
1860 dnum = PyFloat_AsDouble(num);
1861 if (dnum == -1.0 && PyErr_Occurred())
1862 return NULL;
1863 fracpart = modf(dnum, &intpart);
1864 x = PyLong_FromDouble(intpart);
1865 if (x == NULL)
1866 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001867
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001868 prod = PyNumber_Multiply(x, factor);
1869 Py_DECREF(x);
1870 if (prod == NULL)
1871 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001872
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001873 sum = PyNumber_Add(sofar, prod);
1874 Py_DECREF(prod);
1875 if (sum == NULL)
1876 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001877
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001878 if (fracpart == 0.0)
1879 return sum;
1880 /* So far we've lost no information. Dealing with the
1881 * fractional part requires float arithmetic, and may
1882 * lose a little info.
1883 */
1884 assert(PyLong_Check(factor));
1885 dnum = PyLong_AsDouble(factor);
Tim Peters2a799bf2002-12-16 20:18:38 +00001886
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001887 dnum *= fracpart;
1888 fracpart = modf(dnum, &intpart);
1889 x = PyLong_FromDouble(intpart);
1890 if (x == NULL) {
1891 Py_DECREF(sum);
1892 return NULL;
1893 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001894
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001895 y = PyNumber_Add(sum, x);
1896 Py_DECREF(sum);
1897 Py_DECREF(x);
1898 *leftover += fracpart;
1899 return y;
1900 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001901
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001902 PyErr_Format(PyExc_TypeError,
1903 "unsupported type for timedelta %s component: %s",
1904 tag, Py_TYPE(num)->tp_name);
1905 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001906}
1907
1908static PyObject *
1909delta_new(PyTypeObject *type, PyObject *args, PyObject *kw)
1910{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001911 PyObject *self = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001912
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001913 /* Argument objects. */
1914 PyObject *day = NULL;
1915 PyObject *second = NULL;
1916 PyObject *us = NULL;
1917 PyObject *ms = NULL;
1918 PyObject *minute = NULL;
1919 PyObject *hour = NULL;
1920 PyObject *week = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001921
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001922 PyObject *x = NULL; /* running sum of microseconds */
1923 PyObject *y = NULL; /* temp sum of microseconds */
1924 double leftover_us = 0.0;
Tim Peters2a799bf2002-12-16 20:18:38 +00001925
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001926 static char *keywords[] = {
1927 "days", "seconds", "microseconds", "milliseconds",
1928 "minutes", "hours", "weeks", NULL
1929 };
Tim Peters2a799bf2002-12-16 20:18:38 +00001930
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001931 if (PyArg_ParseTupleAndKeywords(args, kw, "|OOOOOOO:__new__",
1932 keywords,
1933 &day, &second, &us,
1934 &ms, &minute, &hour, &week) == 0)
1935 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00001936
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001937 x = PyLong_FromLong(0);
1938 if (x == NULL)
1939 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00001940
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001941#define CLEANUP \
1942 Py_DECREF(x); \
1943 x = y; \
1944 if (x == NULL) \
1945 goto Done
Tim Peters2a799bf2002-12-16 20:18:38 +00001946
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001947 if (us) {
1948 y = accum("microseconds", x, us, us_per_us, &leftover_us);
1949 CLEANUP;
1950 }
1951 if (ms) {
1952 y = accum("milliseconds", x, ms, us_per_ms, &leftover_us);
1953 CLEANUP;
1954 }
1955 if (second) {
1956 y = accum("seconds", x, second, us_per_second, &leftover_us);
1957 CLEANUP;
1958 }
1959 if (minute) {
1960 y = accum("minutes", x, minute, us_per_minute, &leftover_us);
1961 CLEANUP;
1962 }
1963 if (hour) {
1964 y = accum("hours", x, hour, us_per_hour, &leftover_us);
1965 CLEANUP;
1966 }
1967 if (day) {
1968 y = accum("days", x, day, us_per_day, &leftover_us);
1969 CLEANUP;
1970 }
1971 if (week) {
1972 y = accum("weeks", x, week, us_per_week, &leftover_us);
1973 CLEANUP;
1974 }
1975 if (leftover_us) {
1976 /* Round to nearest whole # of us, and add into x. */
1977 PyObject *temp = PyLong_FromLong(round_to_long(leftover_us));
1978 if (temp == NULL) {
1979 Py_DECREF(x);
1980 goto Done;
1981 }
1982 y = PyNumber_Add(x, temp);
1983 Py_DECREF(temp);
1984 CLEANUP;
1985 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001986
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001987 self = microseconds_to_delta_ex(x, type);
1988 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00001989Done:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001990 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00001991
1992#undef CLEANUP
1993}
1994
1995static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00001996delta_bool(PyDateTime_Delta *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00001997{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001998 return (GET_TD_DAYS(self) != 0
1999 || GET_TD_SECONDS(self) != 0
2000 || GET_TD_MICROSECONDS(self) != 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00002001}
2002
2003static PyObject *
2004delta_repr(PyDateTime_Delta *self)
2005{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002006 if (GET_TD_MICROSECONDS(self) != 0)
2007 return PyUnicode_FromFormat("%s(%d, %d, %d)",
2008 Py_TYPE(self)->tp_name,
2009 GET_TD_DAYS(self),
2010 GET_TD_SECONDS(self),
2011 GET_TD_MICROSECONDS(self));
2012 if (GET_TD_SECONDS(self) != 0)
2013 return PyUnicode_FromFormat("%s(%d, %d)",
2014 Py_TYPE(self)->tp_name,
2015 GET_TD_DAYS(self),
2016 GET_TD_SECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002017
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002018 return PyUnicode_FromFormat("%s(%d)",
2019 Py_TYPE(self)->tp_name,
2020 GET_TD_DAYS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002021}
2022
2023static PyObject *
2024delta_str(PyDateTime_Delta *self)
2025{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002026 int us = GET_TD_MICROSECONDS(self);
2027 int seconds = GET_TD_SECONDS(self);
2028 int minutes = divmod(seconds, 60, &seconds);
2029 int hours = divmod(minutes, 60, &minutes);
2030 int days = GET_TD_DAYS(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002031
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002032 if (days) {
2033 if (us)
2034 return PyUnicode_FromFormat("%d day%s, %d:%02d:%02d.%06d",
2035 days, (days == 1 || days == -1) ? "" : "s",
2036 hours, minutes, seconds, us);
2037 else
2038 return PyUnicode_FromFormat("%d day%s, %d:%02d:%02d",
2039 days, (days == 1 || days == -1) ? "" : "s",
2040 hours, minutes, seconds);
2041 } else {
2042 if (us)
2043 return PyUnicode_FromFormat("%d:%02d:%02d.%06d",
2044 hours, minutes, seconds, us);
2045 else
2046 return PyUnicode_FromFormat("%d:%02d:%02d",
2047 hours, minutes, seconds);
2048 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002049
Tim Peters2a799bf2002-12-16 20:18:38 +00002050}
2051
Tim Peters371935f2003-02-01 01:52:50 +00002052/* Pickle support, a simple use of __reduce__. */
2053
Tim Petersb57f8f02003-02-01 02:54:15 +00002054/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002055static PyObject *
2056delta_getstate(PyDateTime_Delta *self)
2057{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002058 return Py_BuildValue("iii", GET_TD_DAYS(self),
2059 GET_TD_SECONDS(self),
2060 GET_TD_MICROSECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002061}
2062
Tim Peters2a799bf2002-12-16 20:18:38 +00002063static PyObject *
2064delta_reduce(PyDateTime_Delta* self)
2065{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002066 return Py_BuildValue("ON", Py_TYPE(self), delta_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002067}
2068
2069#define OFFSET(field) offsetof(PyDateTime_Delta, field)
2070
2071static PyMemberDef delta_members[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002072
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002073 {"days", T_INT, OFFSET(days), READONLY,
2074 PyDoc_STR("Number of days.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002075
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002076 {"seconds", T_INT, OFFSET(seconds), READONLY,
2077 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002078
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002079 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
2080 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
2081 {NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00002082};
2083
2084static PyMethodDef delta_methods[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002085 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
2086 PyDoc_STR("__reduce__() -> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00002087
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002088 {NULL, NULL},
Tim Peters2a799bf2002-12-16 20:18:38 +00002089};
2090
2091static char delta_doc[] =
2092PyDoc_STR("Difference between two datetime values.");
2093
2094static PyNumberMethods delta_as_number = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002095 delta_add, /* nb_add */
2096 delta_subtract, /* nb_subtract */
2097 delta_multiply, /* nb_multiply */
2098 0, /* nb_remainder */
2099 0, /* nb_divmod */
2100 0, /* nb_power */
2101 (unaryfunc)delta_negative, /* nb_negative */
2102 (unaryfunc)delta_positive, /* nb_positive */
2103 (unaryfunc)delta_abs, /* nb_absolute */
2104 (inquiry)delta_bool, /* nb_bool */
2105 0, /*nb_invert*/
2106 0, /*nb_lshift*/
2107 0, /*nb_rshift*/
2108 0, /*nb_and*/
2109 0, /*nb_xor*/
2110 0, /*nb_or*/
2111 0, /*nb_int*/
2112 0, /*nb_reserved*/
2113 0, /*nb_float*/
2114 0, /*nb_inplace_add*/
2115 0, /*nb_inplace_subtract*/
2116 0, /*nb_inplace_multiply*/
2117 0, /*nb_inplace_remainder*/
2118 0, /*nb_inplace_power*/
2119 0, /*nb_inplace_lshift*/
2120 0, /*nb_inplace_rshift*/
2121 0, /*nb_inplace_and*/
2122 0, /*nb_inplace_xor*/
2123 0, /*nb_inplace_or*/
2124 delta_divide, /* nb_floor_divide */
2125 0, /* nb_true_divide */
2126 0, /* nb_inplace_floor_divide */
2127 0, /* nb_inplace_true_divide */
Tim Peters2a799bf2002-12-16 20:18:38 +00002128};
2129
2130static PyTypeObject PyDateTime_DeltaType = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002131 PyVarObject_HEAD_INIT(NULL, 0)
2132 "datetime.timedelta", /* tp_name */
2133 sizeof(PyDateTime_Delta), /* tp_basicsize */
2134 0, /* tp_itemsize */
2135 0, /* tp_dealloc */
2136 0, /* tp_print */
2137 0, /* tp_getattr */
2138 0, /* tp_setattr */
2139 0, /* tp_reserved */
2140 (reprfunc)delta_repr, /* tp_repr */
2141 &delta_as_number, /* tp_as_number */
2142 0, /* tp_as_sequence */
2143 0, /* tp_as_mapping */
2144 (hashfunc)delta_hash, /* tp_hash */
2145 0, /* tp_call */
2146 (reprfunc)delta_str, /* tp_str */
2147 PyObject_GenericGetAttr, /* tp_getattro */
2148 0, /* tp_setattro */
2149 0, /* tp_as_buffer */
2150 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
2151 delta_doc, /* tp_doc */
2152 0, /* tp_traverse */
2153 0, /* tp_clear */
2154 delta_richcompare, /* tp_richcompare */
2155 0, /* tp_weaklistoffset */
2156 0, /* tp_iter */
2157 0, /* tp_iternext */
2158 delta_methods, /* tp_methods */
2159 delta_members, /* tp_members */
2160 0, /* tp_getset */
2161 0, /* tp_base */
2162 0, /* tp_dict */
2163 0, /* tp_descr_get */
2164 0, /* tp_descr_set */
2165 0, /* tp_dictoffset */
2166 0, /* tp_init */
2167 0, /* tp_alloc */
2168 delta_new, /* tp_new */
2169 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002170};
2171
2172/*
2173 * PyDateTime_Date implementation.
2174 */
2175
2176/* Accessor properties. */
2177
2178static PyObject *
2179date_year(PyDateTime_Date *self, void *unused)
2180{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002181 return PyLong_FromLong(GET_YEAR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002182}
2183
2184static PyObject *
2185date_month(PyDateTime_Date *self, void *unused)
2186{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002187 return PyLong_FromLong(GET_MONTH(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002188}
2189
2190static PyObject *
2191date_day(PyDateTime_Date *self, void *unused)
2192{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002193 return PyLong_FromLong(GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002194}
2195
2196static PyGetSetDef date_getset[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002197 {"year", (getter)date_year},
2198 {"month", (getter)date_month},
2199 {"day", (getter)date_day},
2200 {NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00002201};
2202
2203/* Constructors. */
2204
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002205static char *date_kws[] = {"year", "month", "day", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002206
Tim Peters2a799bf2002-12-16 20:18:38 +00002207static PyObject *
2208date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2209{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002210 PyObject *self = NULL;
2211 PyObject *state;
2212 int year;
2213 int month;
2214 int day;
Tim Peters2a799bf2002-12-16 20:18:38 +00002215
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002216 /* Check for invocation from pickle with __getstate__ state */
2217 if (PyTuple_GET_SIZE(args) == 1 &&
2218 PyBytes_Check(state = PyTuple_GET_ITEM(args, 0)) &&
2219 PyBytes_GET_SIZE(state) == _PyDateTime_DATE_DATASIZE &&
2220 MONTH_IS_SANE(PyBytes_AS_STRING(state)[2]))
2221 {
2222 PyDateTime_Date *me;
Tim Peters70533e22003-02-01 04:40:04 +00002223
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002224 me = (PyDateTime_Date *) (type->tp_alloc(type, 0));
2225 if (me != NULL) {
2226 char *pdata = PyBytes_AS_STRING(state);
2227 memcpy(me->data, pdata, _PyDateTime_DATE_DATASIZE);
2228 me->hashcode = -1;
2229 }
2230 return (PyObject *)me;
2231 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00002232
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002233 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
2234 &year, &month, &day)) {
2235 if (check_date_args(year, month, day) < 0)
2236 return NULL;
2237 self = new_date_ex(year, month, day, type);
2238 }
2239 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00002240}
2241
2242/* Return new date from localtime(t). */
2243static PyObject *
Tim Peters1b6f7a92004-06-20 02:50:16 +00002244date_local_from_time_t(PyObject *cls, double ts)
Tim Peters2a799bf2002-12-16 20:18:38 +00002245{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002246 struct tm *tm;
2247 time_t t;
2248 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002249
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002250 t = _PyTime_DoubleToTimet(ts);
2251 if (t == (time_t)-1 && PyErr_Occurred())
2252 return NULL;
2253 tm = localtime(&t);
2254 if (tm)
2255 result = PyObject_CallFunction(cls, "iii",
2256 tm->tm_year + 1900,
2257 tm->tm_mon + 1,
2258 tm->tm_mday);
2259 else
2260 PyErr_SetString(PyExc_ValueError,
2261 "timestamp out of range for "
2262 "platform localtime() function");
2263 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002264}
2265
2266/* Return new date from current time.
2267 * We say this is equivalent to fromtimestamp(time.time()), and the
2268 * only way to be sure of that is to *call* time.time(). That's not
2269 * generally the same as calling C's time.
2270 */
2271static PyObject *
2272date_today(PyObject *cls, PyObject *dummy)
2273{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002274 PyObject *time;
2275 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002276
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002277 time = time_time();
2278 if (time == NULL)
2279 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002280
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002281 /* Note well: today() is a class method, so this may not call
2282 * date.fromtimestamp. For example, it may call
2283 * datetime.fromtimestamp. That's why we need all the accuracy
2284 * time.time() delivers; if someone were gonzo about optimization,
2285 * date.today() could get away with plain C time().
2286 */
2287 result = PyObject_CallMethod(cls, "fromtimestamp", "O", time);
2288 Py_DECREF(time);
2289 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002290}
2291
2292/* Return new date from given timestamp (Python timestamp -- a double). */
2293static PyObject *
2294date_fromtimestamp(PyObject *cls, PyObject *args)
2295{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002296 double timestamp;
2297 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002298
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002299 if (PyArg_ParseTuple(args, "d:fromtimestamp", &timestamp))
2300 result = date_local_from_time_t(cls, timestamp);
2301 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002302}
2303
2304/* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2305 * the ordinal is out of range.
2306 */
2307static PyObject *
2308date_fromordinal(PyObject *cls, PyObject *args)
2309{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002310 PyObject *result = NULL;
2311 int ordinal;
Tim Peters2a799bf2002-12-16 20:18:38 +00002312
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002313 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2314 int year;
2315 int month;
2316 int day;
Tim Peters2a799bf2002-12-16 20:18:38 +00002317
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002318 if (ordinal < 1)
2319 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2320 ">= 1");
2321 else {
2322 ord_to_ymd(ordinal, &year, &month, &day);
2323 result = PyObject_CallFunction(cls, "iii",
2324 year, month, day);
2325 }
2326 }
2327 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002328}
2329
2330/*
2331 * Date arithmetic.
2332 */
2333
2334/* date + timedelta -> date. If arg negate is true, subtract the timedelta
2335 * instead.
2336 */
2337static PyObject *
2338add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
2339{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002340 PyObject *result = NULL;
2341 int year = GET_YEAR(date);
2342 int month = GET_MONTH(date);
2343 int deltadays = GET_TD_DAYS(delta);
2344 /* C-level overflow is impossible because |deltadays| < 1e9. */
2345 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
Tim Peters2a799bf2002-12-16 20:18:38 +00002346
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002347 if (normalize_date(&year, &month, &day) >= 0)
2348 result = new_date(year, month, day);
2349 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002350}
2351
2352static PyObject *
2353date_add(PyObject *left, PyObject *right)
2354{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002355 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2356 Py_INCREF(Py_NotImplemented);
2357 return Py_NotImplemented;
2358 }
2359 if (PyDate_Check(left)) {
2360 /* date + ??? */
2361 if (PyDelta_Check(right))
2362 /* date + delta */
2363 return add_date_timedelta((PyDateTime_Date *) left,
2364 (PyDateTime_Delta *) right,
2365 0);
2366 }
2367 else {
2368 /* ??? + date
2369 * 'right' must be one of us, or we wouldn't have been called
2370 */
2371 if (PyDelta_Check(left))
2372 /* delta + date */
2373 return add_date_timedelta((PyDateTime_Date *) right,
2374 (PyDateTime_Delta *) left,
2375 0);
2376 }
2377 Py_INCREF(Py_NotImplemented);
2378 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002379}
2380
2381static PyObject *
2382date_subtract(PyObject *left, PyObject *right)
2383{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002384 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2385 Py_INCREF(Py_NotImplemented);
2386 return Py_NotImplemented;
2387 }
2388 if (PyDate_Check(left)) {
2389 if (PyDate_Check(right)) {
2390 /* date - date */
2391 int left_ord = ymd_to_ord(GET_YEAR(left),
2392 GET_MONTH(left),
2393 GET_DAY(left));
2394 int right_ord = ymd_to_ord(GET_YEAR(right),
2395 GET_MONTH(right),
2396 GET_DAY(right));
2397 return new_delta(left_ord - right_ord, 0, 0, 0);
2398 }
2399 if (PyDelta_Check(right)) {
2400 /* date - delta */
2401 return add_date_timedelta((PyDateTime_Date *) left,
2402 (PyDateTime_Delta *) right,
2403 1);
2404 }
2405 }
2406 Py_INCREF(Py_NotImplemented);
2407 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002408}
2409
2410
2411/* Various ways to turn a date into a string. */
2412
2413static PyObject *
2414date_repr(PyDateTime_Date *self)
2415{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002416 return PyUnicode_FromFormat("%s(%d, %d, %d)",
2417 Py_TYPE(self)->tp_name,
2418 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002419}
2420
2421static PyObject *
2422date_isoformat(PyDateTime_Date *self)
2423{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002424 return PyUnicode_FromFormat("%04d-%02d-%02d",
2425 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002426}
2427
Tim Peterse2df5ff2003-05-02 18:39:55 +00002428/* str() calls the appropriate isoformat() method. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002429static PyObject *
2430date_str(PyDateTime_Date *self)
2431{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002432 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
Tim Peters2a799bf2002-12-16 20:18:38 +00002433}
2434
2435
2436static PyObject *
2437date_ctime(PyDateTime_Date *self)
2438{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002439 return format_ctime(self, 0, 0, 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00002440}
2441
2442static PyObject *
2443date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2444{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002445 /* This method can be inherited, and needs to call the
2446 * timetuple() method appropriate to self's class.
2447 */
2448 PyObject *result;
2449 PyObject *tuple;
2450 PyObject *format;
2451 static char *keywords[] = {"format", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00002452
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002453 if (! PyArg_ParseTupleAndKeywords(args, kw, "U:strftime", keywords,
2454 &format))
2455 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002456
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002457 tuple = PyObject_CallMethod((PyObject *)self, "timetuple", "()");
2458 if (tuple == NULL)
2459 return NULL;
2460 result = wrap_strftime((PyObject *)self, format, tuple,
2461 (PyObject *)self);
2462 Py_DECREF(tuple);
2463 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002464}
2465
Eric Smith1ba31142007-09-11 18:06:02 +00002466static PyObject *
2467date_format(PyDateTime_Date *self, PyObject *args)
2468{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002469 PyObject *format;
Eric Smith1ba31142007-09-11 18:06:02 +00002470
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002471 if (!PyArg_ParseTuple(args, "U:__format__", &format))
2472 return NULL;
Eric Smith1ba31142007-09-11 18:06:02 +00002473
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002474 /* if the format is zero length, return str(self) */
2475 if (PyUnicode_GetSize(format) == 0)
2476 return PyObject_Str((PyObject *)self);
Eric Smith1ba31142007-09-11 18:06:02 +00002477
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002478 return PyObject_CallMethod((PyObject *)self, "strftime", "O", format);
Eric Smith1ba31142007-09-11 18:06:02 +00002479}
2480
Tim Peters2a799bf2002-12-16 20:18:38 +00002481/* ISO methods. */
2482
2483static PyObject *
2484date_isoweekday(PyDateTime_Date *self)
2485{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002486 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002487
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002488 return PyLong_FromLong(dow + 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00002489}
2490
2491static PyObject *
2492date_isocalendar(PyDateTime_Date *self)
2493{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002494 int year = GET_YEAR(self);
2495 int week1_monday = iso_week1_monday(year);
2496 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
2497 int week;
2498 int day;
Tim Peters2a799bf2002-12-16 20:18:38 +00002499
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002500 week = divmod(today - week1_monday, 7, &day);
2501 if (week < 0) {
2502 --year;
2503 week1_monday = iso_week1_monday(year);
2504 week = divmod(today - week1_monday, 7, &day);
2505 }
2506 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
2507 ++year;
2508 week = 0;
2509 }
2510 return Py_BuildValue("iii", year, week + 1, day + 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00002511}
2512
2513/* Miscellaneous methods. */
2514
Tim Peters2a799bf2002-12-16 20:18:38 +00002515static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00002516date_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters2a799bf2002-12-16 20:18:38 +00002517{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002518 if (PyDate_Check(other)) {
2519 int diff = memcmp(((PyDateTime_Date *)self)->data,
2520 ((PyDateTime_Date *)other)->data,
2521 _PyDateTime_DATE_DATASIZE);
2522 return diff_to_bool(diff, op);
2523 }
2524 else {
2525 Py_INCREF(Py_NotImplemented);
2526 return Py_NotImplemented;
2527 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002528}
2529
2530static PyObject *
2531date_timetuple(PyDateTime_Date *self)
2532{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002533 return build_struct_time(GET_YEAR(self),
2534 GET_MONTH(self),
2535 GET_DAY(self),
2536 0, 0, 0, -1);
Tim Peters2a799bf2002-12-16 20:18:38 +00002537}
2538
Tim Peters12bf3392002-12-24 05:41:27 +00002539static PyObject *
2540date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2541{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002542 PyObject *clone;
2543 PyObject *tuple;
2544 int year = GET_YEAR(self);
2545 int month = GET_MONTH(self);
2546 int day = GET_DAY(self);
Tim Peters12bf3392002-12-24 05:41:27 +00002547
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002548 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
2549 &year, &month, &day))
2550 return NULL;
2551 tuple = Py_BuildValue("iii", year, month, day);
2552 if (tuple == NULL)
2553 return NULL;
2554 clone = date_new(Py_TYPE(self), tuple, NULL);
2555 Py_DECREF(tuple);
2556 return clone;
Tim Peters12bf3392002-12-24 05:41:27 +00002557}
2558
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002559/*
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002560 Borrowed from stringobject.c, originally it was string_hash()
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002561*/
2562static long
2563generic_hash(unsigned char *data, int len)
2564{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002565 register unsigned char *p;
2566 register long x;
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002567
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002568 p = (unsigned char *) data;
Georg Brandl2daf6ae2012-02-20 19:54:16 +01002569 x = _Py_HashSecret.prefix;
2570 x ^= *p << 7;
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002571 while (--len >= 0)
2572 x = (1000003*x) ^ *p++;
2573 x ^= len;
Georg Brandl2daf6ae2012-02-20 19:54:16 +01002574 x ^= _Py_HashSecret.suffix;
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002575 if (x == -1)
2576 x = -2;
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002577
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002578 return x;
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002579}
2580
2581
2582static PyObject *date_getstate(PyDateTime_Date *self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002583
2584static long
2585date_hash(PyDateTime_Date *self)
2586{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002587 if (self->hashcode == -1)
2588 self->hashcode = generic_hash(
2589 (unsigned char *)self->data, _PyDateTime_DATE_DATASIZE);
Guido van Rossum254348e2007-11-21 19:29:53 +00002590
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002591 return self->hashcode;
Tim Peters2a799bf2002-12-16 20:18:38 +00002592}
2593
2594static PyObject *
2595date_toordinal(PyDateTime_Date *self)
2596{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002597 return PyLong_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
2598 GET_DAY(self)));
Tim Peters2a799bf2002-12-16 20:18:38 +00002599}
2600
2601static PyObject *
2602date_weekday(PyDateTime_Date *self)
2603{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002604 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002605
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002606 return PyLong_FromLong(dow);
Tim Peters2a799bf2002-12-16 20:18:38 +00002607}
2608
Tim Peters371935f2003-02-01 01:52:50 +00002609/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002610
Tim Petersb57f8f02003-02-01 02:54:15 +00002611/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002612static PyObject *
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002613date_getstate(PyDateTime_Date *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00002614{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002615 PyObject* field;
2616 field = PyBytes_FromStringAndSize((char*)self->data,
2617 _PyDateTime_DATE_DATASIZE);
2618 return Py_BuildValue("(N)", field);
Tim Peters2a799bf2002-12-16 20:18:38 +00002619}
2620
2621static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00002622date_reduce(PyDateTime_Date *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00002623{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002624 return Py_BuildValue("(ON)", Py_TYPE(self), date_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002625}
2626
2627static PyMethodDef date_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002628
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002629 /* Class methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00002630
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002631 {"fromtimestamp", (PyCFunction)date_fromtimestamp, METH_VARARGS |
2632 METH_CLASS,
2633 PyDoc_STR("timestamp -> local date from a POSIX timestamp (like "
2634 "time.time()).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002635
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002636 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
2637 METH_CLASS,
2638 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
2639 "ordinal.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002640
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002641 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
2642 PyDoc_STR("Current date or datetime: same as "
2643 "self.__class__.fromtimestamp(time.time()).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002644
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002645 /* Instance methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00002646
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002647 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
2648 PyDoc_STR("Return ctime() style string.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002649
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002650 {"strftime", (PyCFunction)date_strftime, METH_VARARGS | METH_KEYWORDS,
2651 PyDoc_STR("format -> strftime() style string.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002652
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002653 {"__format__", (PyCFunction)date_format, METH_VARARGS,
2654 PyDoc_STR("Formats self with strftime.")},
Eric Smith1ba31142007-09-11 18:06:02 +00002655
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002656 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
2657 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002658
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002659 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
2660 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
2661 "weekday.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002662
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002663 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
2664 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002665
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002666 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
2667 PyDoc_STR("Return the day of the week represented by the date.\n"
2668 "Monday == 1 ... Sunday == 7")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002669
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002670 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
2671 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
2672 "1 is day 1.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002673
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002674 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
2675 PyDoc_STR("Return the day of the week represented by the date.\n"
2676 "Monday == 0 ... Sunday == 6")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002677
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002678 {"replace", (PyCFunction)date_replace, METH_VARARGS | METH_KEYWORDS,
2679 PyDoc_STR("Return date with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00002680
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002681 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
2682 PyDoc_STR("__reduce__() -> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00002683
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002684 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00002685};
2686
2687static char date_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00002688PyDoc_STR("date(year, month, day) --> date object");
Tim Peters2a799bf2002-12-16 20:18:38 +00002689
2690static PyNumberMethods date_as_number = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002691 date_add, /* nb_add */
2692 date_subtract, /* nb_subtract */
2693 0, /* nb_multiply */
2694 0, /* nb_remainder */
2695 0, /* nb_divmod */
2696 0, /* nb_power */
2697 0, /* nb_negative */
2698 0, /* nb_positive */
2699 0, /* nb_absolute */
2700 0, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00002701};
2702
2703static PyTypeObject PyDateTime_DateType = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002704 PyVarObject_HEAD_INIT(NULL, 0)
2705 "datetime.date", /* tp_name */
2706 sizeof(PyDateTime_Date), /* tp_basicsize */
2707 0, /* tp_itemsize */
2708 0, /* tp_dealloc */
2709 0, /* tp_print */
2710 0, /* tp_getattr */
2711 0, /* tp_setattr */
2712 0, /* tp_reserved */
2713 (reprfunc)date_repr, /* tp_repr */
2714 &date_as_number, /* tp_as_number */
2715 0, /* tp_as_sequence */
2716 0, /* tp_as_mapping */
2717 (hashfunc)date_hash, /* tp_hash */
2718 0, /* tp_call */
2719 (reprfunc)date_str, /* tp_str */
2720 PyObject_GenericGetAttr, /* tp_getattro */
2721 0, /* tp_setattro */
2722 0, /* tp_as_buffer */
2723 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
2724 date_doc, /* tp_doc */
2725 0, /* tp_traverse */
2726 0, /* tp_clear */
2727 date_richcompare, /* tp_richcompare */
2728 0, /* tp_weaklistoffset */
2729 0, /* tp_iter */
2730 0, /* tp_iternext */
2731 date_methods, /* tp_methods */
2732 0, /* tp_members */
2733 date_getset, /* tp_getset */
2734 0, /* tp_base */
2735 0, /* tp_dict */
2736 0, /* tp_descr_get */
2737 0, /* tp_descr_set */
2738 0, /* tp_dictoffset */
2739 0, /* tp_init */
2740 0, /* tp_alloc */
2741 date_new, /* tp_new */
2742 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002743};
2744
2745/*
Tim Peters2a799bf2002-12-16 20:18:38 +00002746 * PyDateTime_TZInfo implementation.
2747 */
2748
2749/* This is a pure abstract base class, so doesn't do anything beyond
2750 * raising NotImplemented exceptions. Real tzinfo classes need
2751 * to derive from this. This is mostly for clarity, and for efficiency in
Tim Petersa9bc1682003-01-11 03:39:11 +00002752 * datetime and time constructors (their tzinfo arguments need to
Tim Peters2a799bf2002-12-16 20:18:38 +00002753 * be subclasses of this tzinfo class, which is easy and quick to check).
2754 *
2755 * Note: For reasons having to do with pickling of subclasses, we have
2756 * to allow tzinfo objects to be instantiated. This wasn't an issue
2757 * in the Python implementation (__init__() could raise NotImplementedError
2758 * there without ill effect), but doing so in the C implementation hit a
2759 * brick wall.
2760 */
2761
2762static PyObject *
2763tzinfo_nogo(const char* methodname)
2764{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002765 PyErr_Format(PyExc_NotImplementedError,
2766 "a tzinfo subclass must implement %s()",
2767 methodname);
2768 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002769}
2770
2771/* Methods. A subclass must implement these. */
2772
Tim Peters52dcce22003-01-23 16:36:11 +00002773static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002774tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
2775{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002776 return tzinfo_nogo("tzname");
Tim Peters2a799bf2002-12-16 20:18:38 +00002777}
2778
Tim Peters52dcce22003-01-23 16:36:11 +00002779static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002780tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
2781{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002782 return tzinfo_nogo("utcoffset");
Tim Peters2a799bf2002-12-16 20:18:38 +00002783}
2784
Tim Peters52dcce22003-01-23 16:36:11 +00002785static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002786tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
2787{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002788 return tzinfo_nogo("dst");
Tim Peters2a799bf2002-12-16 20:18:38 +00002789}
2790
Tim Peters52dcce22003-01-23 16:36:11 +00002791static PyObject *
2792tzinfo_fromutc(PyDateTime_TZInfo *self, PyDateTime_DateTime *dt)
2793{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002794 int y, m, d, hh, mm, ss, us;
Tim Peters52dcce22003-01-23 16:36:11 +00002795
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002796 PyObject *result;
2797 int off, dst;
2798 int none;
2799 int delta;
Tim Peters52dcce22003-01-23 16:36:11 +00002800
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002801 if (! PyDateTime_Check(dt)) {
2802 PyErr_SetString(PyExc_TypeError,
2803 "fromutc: argument must be a datetime");
2804 return NULL;
2805 }
2806 if (! HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
2807 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
2808 "is not self");
2809 return NULL;
2810 }
Tim Peters52dcce22003-01-23 16:36:11 +00002811
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002812 off = call_utcoffset(dt->tzinfo, (PyObject *)dt, &none);
2813 if (off == -1 && PyErr_Occurred())
2814 return NULL;
2815 if (none) {
2816 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2817 "utcoffset() result required");
2818 return NULL;
2819 }
Tim Peters52dcce22003-01-23 16:36:11 +00002820
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002821 dst = call_dst(dt->tzinfo, (PyObject *)dt, &none);
2822 if (dst == -1 && PyErr_Occurred())
2823 return NULL;
2824 if (none) {
2825 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2826 "dst() result required");
2827 return NULL;
2828 }
Tim Peters52dcce22003-01-23 16:36:11 +00002829
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002830 y = GET_YEAR(dt);
2831 m = GET_MONTH(dt);
2832 d = GET_DAY(dt);
2833 hh = DATE_GET_HOUR(dt);
2834 mm = DATE_GET_MINUTE(dt);
2835 ss = DATE_GET_SECOND(dt);
2836 us = DATE_GET_MICROSECOND(dt);
Tim Peters52dcce22003-01-23 16:36:11 +00002837
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002838 delta = off - dst;
2839 mm += delta;
2840 if ((mm < 0 || mm >= 60) &&
2841 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
2842 return NULL;
2843 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2844 if (result == NULL)
2845 return result;
Tim Peters52dcce22003-01-23 16:36:11 +00002846
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002847 dst = call_dst(dt->tzinfo, result, &none);
2848 if (dst == -1 && PyErr_Occurred())
2849 goto Fail;
2850 if (none)
2851 goto Inconsistent;
2852 if (dst == 0)
2853 return result;
Tim Peters52dcce22003-01-23 16:36:11 +00002854
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002855 mm += dst;
2856 if ((mm < 0 || mm >= 60) &&
2857 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
2858 goto Fail;
2859 Py_DECREF(result);
2860 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2861 return result;
Tim Peters52dcce22003-01-23 16:36:11 +00002862
2863Inconsistent:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002864 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave"
2865 "inconsistent results; cannot convert");
Tim Peters52dcce22003-01-23 16:36:11 +00002866
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002867 /* fall thru to failure */
Tim Peters52dcce22003-01-23 16:36:11 +00002868Fail:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002869 Py_DECREF(result);
2870 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00002871}
2872
Tim Peters2a799bf2002-12-16 20:18:38 +00002873/*
2874 * Pickle support. This is solely so that tzinfo subclasses can use
Guido van Rossum177e41a2003-01-30 22:06:23 +00002875 * pickling -- tzinfo itself is supposed to be uninstantiable.
Tim Peters2a799bf2002-12-16 20:18:38 +00002876 */
2877
Guido van Rossum177e41a2003-01-30 22:06:23 +00002878static PyObject *
2879tzinfo_reduce(PyObject *self)
2880{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002881 PyObject *args, *state, *tmp;
2882 PyObject *getinitargs, *getstate;
Tim Peters2a799bf2002-12-16 20:18:38 +00002883
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002884 tmp = PyTuple_New(0);
2885 if (tmp == NULL)
2886 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002887
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002888 getinitargs = PyObject_GetAttrString(self, "__getinitargs__");
2889 if (getinitargs != NULL) {
2890 args = PyObject_CallObject(getinitargs, tmp);
2891 Py_DECREF(getinitargs);
2892 if (args == NULL) {
2893 Py_DECREF(tmp);
2894 return NULL;
2895 }
2896 }
2897 else {
2898 PyErr_Clear();
2899 args = tmp;
2900 Py_INCREF(args);
2901 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00002902
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002903 getstate = PyObject_GetAttrString(self, "__getstate__");
2904 if (getstate != NULL) {
2905 state = PyObject_CallObject(getstate, tmp);
2906 Py_DECREF(getstate);
2907 if (state == NULL) {
2908 Py_DECREF(args);
2909 Py_DECREF(tmp);
2910 return NULL;
2911 }
2912 }
2913 else {
2914 PyObject **dictptr;
2915 PyErr_Clear();
2916 state = Py_None;
2917 dictptr = _PyObject_GetDictPtr(self);
2918 if (dictptr && *dictptr && PyDict_Size(*dictptr))
2919 state = *dictptr;
2920 Py_INCREF(state);
2921 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00002922
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002923 Py_DECREF(tmp);
Guido van Rossum177e41a2003-01-30 22:06:23 +00002924
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002925 if (state == Py_None) {
2926 Py_DECREF(state);
2927 return Py_BuildValue("(ON)", Py_TYPE(self), args);
2928 }
2929 else
2930 return Py_BuildValue("(ONN)", Py_TYPE(self), args, state);
Guido van Rossum177e41a2003-01-30 22:06:23 +00002931}
Tim Peters2a799bf2002-12-16 20:18:38 +00002932
2933static PyMethodDef tzinfo_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002934
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002935 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
2936 PyDoc_STR("datetime -> string name of time zone.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002937
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002938 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
2939 PyDoc_STR("datetime -> minutes east of UTC (negative for "
2940 "west of UTC).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002941
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002942 {"dst", (PyCFunction)tzinfo_dst, METH_O,
2943 PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002944
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002945 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
Georg Brandlc62efa82010-07-11 10:41:07 +00002946 PyDoc_STR("datetime -> timedelta showing offset from UTC, negative "
2947 "values indicating West of UTC")},
Tim Peters52dcce22003-01-23 16:36:11 +00002948
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002949 {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
2950 PyDoc_STR("-> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00002951
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002952 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00002953};
2954
2955static char tzinfo_doc[] =
2956PyDoc_STR("Abstract base class for time zone info objects.");
2957
Neal Norwitz227b5332006-03-22 09:28:35 +00002958static PyTypeObject PyDateTime_TZInfoType = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00002959 PyVarObject_HEAD_INIT(NULL, 0)
2960 "datetime.tzinfo", /* tp_name */
2961 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
2962 0, /* tp_itemsize */
2963 0, /* tp_dealloc */
2964 0, /* tp_print */
2965 0, /* tp_getattr */
2966 0, /* tp_setattr */
2967 0, /* tp_reserved */
2968 0, /* tp_repr */
2969 0, /* tp_as_number */
2970 0, /* tp_as_sequence */
2971 0, /* tp_as_mapping */
2972 0, /* tp_hash */
2973 0, /* tp_call */
2974 0, /* tp_str */
2975 PyObject_GenericGetAttr, /* tp_getattro */
2976 0, /* tp_setattro */
2977 0, /* tp_as_buffer */
2978 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
2979 tzinfo_doc, /* tp_doc */
2980 0, /* tp_traverse */
2981 0, /* tp_clear */
2982 0, /* tp_richcompare */
2983 0, /* tp_weaklistoffset */
2984 0, /* tp_iter */
2985 0, /* tp_iternext */
2986 tzinfo_methods, /* tp_methods */
2987 0, /* tp_members */
2988 0, /* tp_getset */
2989 0, /* tp_base */
2990 0, /* tp_dict */
2991 0, /* tp_descr_get */
2992 0, /* tp_descr_set */
2993 0, /* tp_dictoffset */
2994 0, /* tp_init */
2995 0, /* tp_alloc */
2996 PyType_GenericNew, /* tp_new */
2997 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002998};
2999
3000/*
Tim Peters37f39822003-01-10 03:49:02 +00003001 * PyDateTime_Time implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003002 */
3003
Tim Peters37f39822003-01-10 03:49:02 +00003004/* Accessor properties.
Tim Peters2a799bf2002-12-16 20:18:38 +00003005 */
3006
3007static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003008time_hour(PyDateTime_Time *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003009{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003010 return PyLong_FromLong(TIME_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003011}
3012
Tim Peters37f39822003-01-10 03:49:02 +00003013static PyObject *
3014time_minute(PyDateTime_Time *self, void *unused)
3015{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003016 return PyLong_FromLong(TIME_GET_MINUTE(self));
Tim Peters37f39822003-01-10 03:49:02 +00003017}
3018
3019/* The name time_second conflicted with some platform header file. */
3020static PyObject *
3021py_time_second(PyDateTime_Time *self, void *unused)
3022{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003023 return PyLong_FromLong(TIME_GET_SECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003024}
3025
3026static PyObject *
3027time_microsecond(PyDateTime_Time *self, void *unused)
3028{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003029 return PyLong_FromLong(TIME_GET_MICROSECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003030}
3031
3032static PyObject *
3033time_tzinfo(PyDateTime_Time *self, void *unused)
3034{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003035 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3036 Py_INCREF(result);
3037 return result;
Tim Peters37f39822003-01-10 03:49:02 +00003038}
3039
3040static PyGetSetDef time_getset[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003041 {"hour", (getter)time_hour},
3042 {"minute", (getter)time_minute},
3043 {"second", (getter)py_time_second},
3044 {"microsecond", (getter)time_microsecond},
3045 {"tzinfo", (getter)time_tzinfo},
3046 {NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003047};
3048
3049/*
3050 * Constructors.
3051 */
3052
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003053static char *time_kws[] = {"hour", "minute", "second", "microsecond",
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003054 "tzinfo", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00003055
Tim Peters2a799bf2002-12-16 20:18:38 +00003056static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003057time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003058{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003059 PyObject *self = NULL;
3060 PyObject *state;
3061 int hour = 0;
3062 int minute = 0;
3063 int second = 0;
3064 int usecond = 0;
3065 PyObject *tzinfo = Py_None;
Tim Peters2a799bf2002-12-16 20:18:38 +00003066
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003067 /* Check for invocation from pickle with __getstate__ state */
3068 if (PyTuple_GET_SIZE(args) >= 1 &&
3069 PyTuple_GET_SIZE(args) <= 2 &&
3070 PyBytes_Check(state = PyTuple_GET_ITEM(args, 0)) &&
3071 PyBytes_GET_SIZE(state) == _PyDateTime_TIME_DATASIZE &&
3072 ((unsigned char) (PyBytes_AS_STRING(state)[0])) < 24)
3073 {
3074 PyDateTime_Time *me;
3075 char aware;
Tim Peters70533e22003-02-01 04:40:04 +00003076
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003077 if (PyTuple_GET_SIZE(args) == 2) {
3078 tzinfo = PyTuple_GET_ITEM(args, 1);
3079 if (check_tzinfo_subclass(tzinfo) < 0) {
3080 PyErr_SetString(PyExc_TypeError, "bad "
3081 "tzinfo state arg");
3082 return NULL;
3083 }
3084 }
3085 aware = (char)(tzinfo != Py_None);
3086 me = (PyDateTime_Time *) (type->tp_alloc(type, aware));
3087 if (me != NULL) {
3088 char *pdata = PyBytes_AS_STRING(state);
Tim Peters70533e22003-02-01 04:40:04 +00003089
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003090 memcpy(me->data, pdata, _PyDateTime_TIME_DATASIZE);
3091 me->hashcode = -1;
3092 me->hastzinfo = aware;
3093 if (aware) {
3094 Py_INCREF(tzinfo);
3095 me->tzinfo = tzinfo;
3096 }
3097 }
3098 return (PyObject *)me;
3099 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00003100
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003101 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO", time_kws,
3102 &hour, &minute, &second, &usecond,
3103 &tzinfo)) {
3104 if (check_time_args(hour, minute, second, usecond) < 0)
3105 return NULL;
3106 if (check_tzinfo_subclass(tzinfo) < 0)
3107 return NULL;
3108 self = new_time_ex(hour, minute, second, usecond, tzinfo,
3109 type);
3110 }
3111 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003112}
3113
3114/*
3115 * Destructor.
3116 */
3117
3118static void
Tim Peters37f39822003-01-10 03:49:02 +00003119time_dealloc(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003120{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003121 if (HASTZINFO(self)) {
3122 Py_XDECREF(self->tzinfo);
3123 }
3124 Py_TYPE(self)->tp_free((PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003125}
3126
3127/*
Tim Peters855fe882002-12-22 03:43:39 +00003128 * Indirect access to tzinfo methods.
Tim Peters2a799bf2002-12-16 20:18:38 +00003129 */
3130
Tim Peters2a799bf2002-12-16 20:18:38 +00003131/* These are all METH_NOARGS, so don't need to check the arglist. */
3132static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003133time_utcoffset(PyDateTime_Time *self, PyObject *unused) {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003134 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3135 "utcoffset", Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003136}
3137
3138static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003139time_dst(PyDateTime_Time *self, PyObject *unused) {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003140 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3141 "dst", Py_None);
Tim Peters855fe882002-12-22 03:43:39 +00003142}
3143
3144static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003145time_tzname(PyDateTime_Time *self, PyObject *unused) {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003146 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
3147 Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003148}
3149
3150/*
Tim Peters37f39822003-01-10 03:49:02 +00003151 * Various ways to turn a time into a string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003152 */
3153
3154static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003155time_repr(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003156{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003157 const char *type_name = Py_TYPE(self)->tp_name;
3158 int h = TIME_GET_HOUR(self);
3159 int m = TIME_GET_MINUTE(self);
3160 int s = TIME_GET_SECOND(self);
3161 int us = TIME_GET_MICROSECOND(self);
3162 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003163
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003164 if (us)
3165 result = PyUnicode_FromFormat("%s(%d, %d, %d, %d)",
3166 type_name, h, m, s, us);
3167 else if (s)
3168 result = PyUnicode_FromFormat("%s(%d, %d, %d)",
3169 type_name, h, m, s);
3170 else
3171 result = PyUnicode_FromFormat("%s(%d, %d)", type_name, h, m);
3172 if (result != NULL && HASTZINFO(self))
3173 result = append_keyword_tzinfo(result, self->tzinfo);
3174 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003175}
3176
Tim Peters37f39822003-01-10 03:49:02 +00003177static PyObject *
3178time_str(PyDateTime_Time *self)
3179{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003180 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
Tim Peters37f39822003-01-10 03:49:02 +00003181}
Tim Peters2a799bf2002-12-16 20:18:38 +00003182
3183static PyObject *
Thomas Wouterscf297e42007-02-23 15:07:44 +00003184time_isoformat(PyDateTime_Time *self, PyObject *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003185{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003186 char buf[100];
3187 PyObject *result;
3188 int us = TIME_GET_MICROSECOND(self);;
Tim Peters2a799bf2002-12-16 20:18:38 +00003189
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003190 if (us)
3191 result = PyUnicode_FromFormat("%02d:%02d:%02d.%06d",
3192 TIME_GET_HOUR(self),
3193 TIME_GET_MINUTE(self),
3194 TIME_GET_SECOND(self),
3195 us);
3196 else
3197 result = PyUnicode_FromFormat("%02d:%02d:%02d",
3198 TIME_GET_HOUR(self),
3199 TIME_GET_MINUTE(self),
3200 TIME_GET_SECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003201
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003202 if (result == NULL || ! HASTZINFO(self) || self->tzinfo == Py_None)
3203 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003204
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003205 /* We need to append the UTC offset. */
3206 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
3207 Py_None) < 0) {
3208 Py_DECREF(result);
3209 return NULL;
3210 }
3211 PyUnicode_AppendAndDel(&result, PyUnicode_FromString(buf));
3212 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003213}
3214
Tim Peters37f39822003-01-10 03:49:02 +00003215static PyObject *
3216time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3217{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003218 PyObject *result;
3219 PyObject *tuple;
3220 PyObject *format;
3221 static char *keywords[] = {"format", NULL};
Tim Peters37f39822003-01-10 03:49:02 +00003222
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003223 if (! PyArg_ParseTupleAndKeywords(args, kw, "U:strftime", keywords,
3224 &format))
3225 return NULL;
Tim Peters37f39822003-01-10 03:49:02 +00003226
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003227 /* Python's strftime does insane things with the year part of the
3228 * timetuple. The year is forced to (the otherwise nonsensical)
3229 * 1900 to worm around that.
3230 */
3231 tuple = Py_BuildValue("iiiiiiiii",
3232 1900, 1, 1, /* year, month, day */
3233 TIME_GET_HOUR(self),
3234 TIME_GET_MINUTE(self),
3235 TIME_GET_SECOND(self),
3236 0, 1, -1); /* weekday, daynum, dst */
3237 if (tuple == NULL)
3238 return NULL;
3239 assert(PyTuple_Size(tuple) == 9);
3240 result = wrap_strftime((PyObject *)self, format, tuple,
3241 Py_None);
3242 Py_DECREF(tuple);
3243 return result;
Tim Peters37f39822003-01-10 03:49:02 +00003244}
Tim Peters2a799bf2002-12-16 20:18:38 +00003245
3246/*
3247 * Miscellaneous methods.
3248 */
3249
Tim Peters37f39822003-01-10 03:49:02 +00003250static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00003251time_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters37f39822003-01-10 03:49:02 +00003252{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003253 int diff;
3254 naivety n1, n2;
3255 int offset1, offset2;
Tim Peters37f39822003-01-10 03:49:02 +00003256
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003257 if (! PyTime_Check(other)) {
3258 Py_INCREF(Py_NotImplemented);
3259 return Py_NotImplemented;
3260 }
3261 if (classify_two_utcoffsets(self, &offset1, &n1, Py_None,
3262 other, &offset2, &n2, Py_None) < 0)
3263 return NULL;
3264 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
3265 /* If they're both naive, or both aware and have the same offsets,
3266 * we get off cheap. Note that if they're both naive, offset1 ==
3267 * offset2 == 0 at this point.
3268 */
3269 if (n1 == n2 && offset1 == offset2) {
3270 diff = memcmp(((PyDateTime_Time *)self)->data,
3271 ((PyDateTime_Time *)other)->data,
3272 _PyDateTime_TIME_DATASIZE);
3273 return diff_to_bool(diff, op);
3274 }
Tim Peters37f39822003-01-10 03:49:02 +00003275
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003276 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
3277 assert(offset1 != offset2); /* else last "if" handled it */
3278 /* Convert everything except microseconds to seconds. These
3279 * can't overflow (no more than the # of seconds in 2 days).
3280 */
3281 offset1 = TIME_GET_HOUR(self) * 3600 +
3282 (TIME_GET_MINUTE(self) - offset1) * 60 +
3283 TIME_GET_SECOND(self);
3284 offset2 = TIME_GET_HOUR(other) * 3600 +
3285 (TIME_GET_MINUTE(other) - offset2) * 60 +
3286 TIME_GET_SECOND(other);
3287 diff = offset1 - offset2;
3288 if (diff == 0)
3289 diff = TIME_GET_MICROSECOND(self) -
3290 TIME_GET_MICROSECOND(other);
3291 return diff_to_bool(diff, op);
3292 }
Tim Peters37f39822003-01-10 03:49:02 +00003293
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003294 assert(n1 != n2);
3295 PyErr_SetString(PyExc_TypeError,
3296 "can't compare offset-naive and "
3297 "offset-aware times");
3298 return NULL;
Tim Peters37f39822003-01-10 03:49:02 +00003299}
3300
3301static long
3302time_hash(PyDateTime_Time *self)
3303{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003304 if (self->hashcode == -1) {
3305 naivety n;
3306 int offset;
3307 PyObject *temp;
Tim Peters37f39822003-01-10 03:49:02 +00003308
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003309 n = classify_utcoffset((PyObject *)self, Py_None, &offset);
3310 assert(n != OFFSET_UNKNOWN);
3311 if (n == OFFSET_ERROR)
3312 return -1;
Tim Peters37f39822003-01-10 03:49:02 +00003313
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003314 /* Reduce this to a hash of another object. */
3315 if (offset == 0) {
3316 self->hashcode = generic_hash(
3317 (unsigned char *)self->data, _PyDateTime_TIME_DATASIZE);
3318 return self->hashcode;
3319 }
3320 else {
3321 int hour;
3322 int minute;
Tim Peters37f39822003-01-10 03:49:02 +00003323
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003324 assert(n == OFFSET_AWARE);
3325 assert(HASTZINFO(self));
3326 hour = divmod(TIME_GET_HOUR(self) * 60 +
3327 TIME_GET_MINUTE(self) - offset,
3328 60,
3329 &minute);
3330 if (0 <= hour && hour < 24)
3331 temp = new_time(hour, minute,
3332 TIME_GET_SECOND(self),
3333 TIME_GET_MICROSECOND(self),
3334 Py_None);
3335 else
3336 temp = Py_BuildValue("iiii",
3337 hour, minute,
3338 TIME_GET_SECOND(self),
3339 TIME_GET_MICROSECOND(self));
3340 }
3341 if (temp != NULL) {
3342 self->hashcode = PyObject_Hash(temp);
3343 Py_DECREF(temp);
3344 }
3345 }
3346 return self->hashcode;
Tim Peters37f39822003-01-10 03:49:02 +00003347}
Tim Peters2a799bf2002-12-16 20:18:38 +00003348
Tim Peters12bf3392002-12-24 05:41:27 +00003349static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003350time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00003351{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003352 PyObject *clone;
3353 PyObject *tuple;
3354 int hh = TIME_GET_HOUR(self);
3355 int mm = TIME_GET_MINUTE(self);
3356 int ss = TIME_GET_SECOND(self);
3357 int us = TIME_GET_MICROSECOND(self);
3358 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00003359
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003360 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO:replace",
3361 time_kws,
3362 &hh, &mm, &ss, &us, &tzinfo))
3363 return NULL;
3364 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
3365 if (tuple == NULL)
3366 return NULL;
3367 clone = time_new(Py_TYPE(self), tuple, NULL);
3368 Py_DECREF(tuple);
3369 return clone;
Tim Peters12bf3392002-12-24 05:41:27 +00003370}
3371
Tim Peters2a799bf2002-12-16 20:18:38 +00003372static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00003373time_bool(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003374{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003375 int offset;
3376 int none;
Tim Peters2a799bf2002-12-16 20:18:38 +00003377
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003378 if (TIME_GET_SECOND(self) || TIME_GET_MICROSECOND(self)) {
3379 /* Since utcoffset is in whole minutes, nothing can
3380 * alter the conclusion that this is nonzero.
3381 */
3382 return 1;
3383 }
3384 offset = 0;
3385 if (HASTZINFO(self) && self->tzinfo != Py_None) {
3386 offset = call_utcoffset(self->tzinfo, Py_None, &none);
3387 if (offset == -1 && PyErr_Occurred())
3388 return -1;
3389 }
3390 return (TIME_GET_MINUTE(self) - offset + TIME_GET_HOUR(self)*60) != 0;
Tim Peters2a799bf2002-12-16 20:18:38 +00003391}
3392
Tim Peters371935f2003-02-01 01:52:50 +00003393/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003394
Tim Peters33e0f382003-01-10 02:05:14 +00003395/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003396 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
3397 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00003398 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00003399 */
3400static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003401time_getstate(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003402{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003403 PyObject *basestate;
3404 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003405
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003406 basestate = PyBytes_FromStringAndSize((char *)self->data,
3407 _PyDateTime_TIME_DATASIZE);
3408 if (basestate != NULL) {
3409 if (! HASTZINFO(self) || self->tzinfo == Py_None)
3410 result = PyTuple_Pack(1, basestate);
3411 else
3412 result = PyTuple_Pack(2, basestate, self->tzinfo);
3413 Py_DECREF(basestate);
3414 }
3415 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003416}
3417
3418static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00003419time_reduce(PyDateTime_Time *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00003420{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003421 return Py_BuildValue("(ON)", Py_TYPE(self), time_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003422}
3423
Tim Peters37f39822003-01-10 03:49:02 +00003424static PyMethodDef time_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003425
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003426 {"isoformat", (PyCFunction)time_isoformat, METH_NOARGS,
3427 PyDoc_STR("Return string in ISO 8601 format, HH:MM:SS[.mmmmmm]"
3428 "[+HH:MM].")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003429
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003430 {"strftime", (PyCFunction)time_strftime, METH_VARARGS | METH_KEYWORDS,
3431 PyDoc_STR("format -> strftime() style string.")},
Tim Peters37f39822003-01-10 03:49:02 +00003432
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003433 {"__format__", (PyCFunction)date_format, METH_VARARGS,
3434 PyDoc_STR("Formats self with strftime.")},
Eric Smith1ba31142007-09-11 18:06:02 +00003435
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003436 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
3437 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003438
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003439 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
3440 PyDoc_STR("Return self.tzinfo.tzname(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003441
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003442 {"dst", (PyCFunction)time_dst, METH_NOARGS,
3443 PyDoc_STR("Return self.tzinfo.dst(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003444
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003445 {"replace", (PyCFunction)time_replace, METH_VARARGS | METH_KEYWORDS,
3446 PyDoc_STR("Return time with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00003447
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003448 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
3449 PyDoc_STR("__reduce__() -> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00003450
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003451 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003452};
3453
Tim Peters37f39822003-01-10 03:49:02 +00003454static char time_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00003455PyDoc_STR("time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object\n\
3456\n\
3457All arguments are optional. tzinfo may be None, or an instance of\n\
3458a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00003459
Tim Peters37f39822003-01-10 03:49:02 +00003460static PyNumberMethods time_as_number = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003461 0, /* nb_add */
3462 0, /* nb_subtract */
3463 0, /* nb_multiply */
3464 0, /* nb_remainder */
3465 0, /* nb_divmod */
3466 0, /* nb_power */
3467 0, /* nb_negative */
3468 0, /* nb_positive */
3469 0, /* nb_absolute */
3470 (inquiry)time_bool, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00003471};
3472
Neal Norwitz227b5332006-03-22 09:28:35 +00003473static PyTypeObject PyDateTime_TimeType = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003474 PyVarObject_HEAD_INIT(NULL, 0)
3475 "datetime.time", /* tp_name */
3476 sizeof(PyDateTime_Time), /* tp_basicsize */
3477 0, /* tp_itemsize */
3478 (destructor)time_dealloc, /* tp_dealloc */
3479 0, /* tp_print */
3480 0, /* tp_getattr */
3481 0, /* tp_setattr */
3482 0, /* tp_reserved */
3483 (reprfunc)time_repr, /* tp_repr */
3484 &time_as_number, /* tp_as_number */
3485 0, /* tp_as_sequence */
3486 0, /* tp_as_mapping */
3487 (hashfunc)time_hash, /* tp_hash */
3488 0, /* tp_call */
3489 (reprfunc)time_str, /* tp_str */
3490 PyObject_GenericGetAttr, /* tp_getattro */
3491 0, /* tp_setattro */
3492 0, /* tp_as_buffer */
3493 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
3494 time_doc, /* tp_doc */
3495 0, /* tp_traverse */
3496 0, /* tp_clear */
3497 time_richcompare, /* tp_richcompare */
3498 0, /* tp_weaklistoffset */
3499 0, /* tp_iter */
3500 0, /* tp_iternext */
3501 time_methods, /* tp_methods */
3502 0, /* tp_members */
3503 time_getset, /* tp_getset */
3504 0, /* tp_base */
3505 0, /* tp_dict */
3506 0, /* tp_descr_get */
3507 0, /* tp_descr_set */
3508 0, /* tp_dictoffset */
3509 0, /* tp_init */
3510 time_alloc, /* tp_alloc */
3511 time_new, /* tp_new */
3512 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00003513};
3514
3515/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003516 * PyDateTime_DateTime implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003517 */
3518
Tim Petersa9bc1682003-01-11 03:39:11 +00003519/* Accessor properties. Properties for day, month, and year are inherited
3520 * from date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003521 */
3522
3523static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003524datetime_hour(PyDateTime_DateTime *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003525{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003526 return PyLong_FromLong(DATE_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003527}
3528
Tim Petersa9bc1682003-01-11 03:39:11 +00003529static PyObject *
3530datetime_minute(PyDateTime_DateTime *self, void *unused)
3531{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003532 return PyLong_FromLong(DATE_GET_MINUTE(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00003533}
3534
3535static PyObject *
3536datetime_second(PyDateTime_DateTime *self, void *unused)
3537{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003538 return PyLong_FromLong(DATE_GET_SECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00003539}
3540
3541static PyObject *
3542datetime_microsecond(PyDateTime_DateTime *self, void *unused)
3543{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003544 return PyLong_FromLong(DATE_GET_MICROSECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00003545}
3546
3547static PyObject *
3548datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
3549{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003550 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3551 Py_INCREF(result);
3552 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00003553}
3554
3555static PyGetSetDef datetime_getset[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003556 {"hour", (getter)datetime_hour},
3557 {"minute", (getter)datetime_minute},
3558 {"second", (getter)datetime_second},
3559 {"microsecond", (getter)datetime_microsecond},
3560 {"tzinfo", (getter)datetime_tzinfo},
3561 {NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003562};
3563
3564/*
3565 * Constructors.
Tim Peters2a799bf2002-12-16 20:18:38 +00003566 */
3567
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003568static char *datetime_kws[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003569 "year", "month", "day", "hour", "minute", "second",
3570 "microsecond", "tzinfo", NULL
Tim Peters12bf3392002-12-24 05:41:27 +00003571};
3572
Tim Peters2a799bf2002-12-16 20:18:38 +00003573static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003574datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003575{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003576 PyObject *self = NULL;
3577 PyObject *state;
3578 int year;
3579 int month;
3580 int day;
3581 int hour = 0;
3582 int minute = 0;
3583 int second = 0;
3584 int usecond = 0;
3585 PyObject *tzinfo = Py_None;
Tim Peters2a799bf2002-12-16 20:18:38 +00003586
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003587 /* Check for invocation from pickle with __getstate__ state */
3588 if (PyTuple_GET_SIZE(args) >= 1 &&
3589 PyTuple_GET_SIZE(args) <= 2 &&
3590 PyBytes_Check(state = PyTuple_GET_ITEM(args, 0)) &&
3591 PyBytes_GET_SIZE(state) == _PyDateTime_DATETIME_DATASIZE &&
3592 MONTH_IS_SANE(PyBytes_AS_STRING(state)[2]))
3593 {
3594 PyDateTime_DateTime *me;
3595 char aware;
Tim Peters70533e22003-02-01 04:40:04 +00003596
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003597 if (PyTuple_GET_SIZE(args) == 2) {
3598 tzinfo = PyTuple_GET_ITEM(args, 1);
3599 if (check_tzinfo_subclass(tzinfo) < 0) {
3600 PyErr_SetString(PyExc_TypeError, "bad "
3601 "tzinfo state arg");
3602 return NULL;
3603 }
3604 }
3605 aware = (char)(tzinfo != Py_None);
3606 me = (PyDateTime_DateTime *) (type->tp_alloc(type , aware));
3607 if (me != NULL) {
3608 char *pdata = PyBytes_AS_STRING(state);
Tim Peters70533e22003-02-01 04:40:04 +00003609
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003610 memcpy(me->data, pdata, _PyDateTime_DATETIME_DATASIZE);
3611 me->hashcode = -1;
3612 me->hastzinfo = aware;
3613 if (aware) {
3614 Py_INCREF(tzinfo);
3615 me->tzinfo = tzinfo;
3616 }
3617 }
3618 return (PyObject *)me;
3619 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00003620
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003621 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO", datetime_kws,
3622 &year, &month, &day, &hour, &minute,
3623 &second, &usecond, &tzinfo)) {
3624 if (check_date_args(year, month, day) < 0)
3625 return NULL;
3626 if (check_time_args(hour, minute, second, usecond) < 0)
3627 return NULL;
3628 if (check_tzinfo_subclass(tzinfo) < 0)
3629 return NULL;
3630 self = new_datetime_ex(year, month, day,
3631 hour, minute, second, usecond,
3632 tzinfo, type);
3633 }
3634 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003635}
3636
Tim Petersa9bc1682003-01-11 03:39:11 +00003637/* TM_FUNC is the shared type of localtime() and gmtime(). */
3638typedef struct tm *(*TM_FUNC)(const time_t *timer);
3639
3640/* Internal helper.
3641 * Build datetime from a time_t and a distinct count of microseconds.
3642 * Pass localtime or gmtime for f, to control the interpretation of timet.
3643 */
3644static PyObject *
3645datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003646 PyObject *tzinfo)
Tim Petersa9bc1682003-01-11 03:39:11 +00003647{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003648 struct tm *tm;
3649 PyObject *result = NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00003650
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003651 tm = f(&timet);
3652 if (tm) {
3653 /* The platform localtime/gmtime may insert leap seconds,
3654 * indicated by tm->tm_sec > 59. We don't care about them,
3655 * except to the extent that passing them on to the datetime
3656 * constructor would raise ValueError for a reason that
3657 * made no sense to the user.
3658 */
3659 if (tm->tm_sec > 59)
3660 tm->tm_sec = 59;
3661 result = PyObject_CallFunction(cls, "iiiiiiiO",
3662 tm->tm_year + 1900,
3663 tm->tm_mon + 1,
3664 tm->tm_mday,
3665 tm->tm_hour,
3666 tm->tm_min,
3667 tm->tm_sec,
3668 us,
3669 tzinfo);
3670 }
3671 else
3672 PyErr_SetString(PyExc_ValueError,
3673 "timestamp out of range for "
3674 "platform localtime()/gmtime() function");
3675 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00003676}
3677
3678/* Internal helper.
3679 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
3680 * to control the interpretation of the timestamp. Since a double doesn't
3681 * have enough bits to cover a datetime's full range of precision, it's
3682 * better to call datetime_from_timet_and_us provided you have a way
3683 * to get that much precision (e.g., C time() isn't good enough).
3684 */
3685static PyObject *
3686datetime_from_timestamp(PyObject *cls, TM_FUNC f, double timestamp,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003687 PyObject *tzinfo)
Tim Petersa9bc1682003-01-11 03:39:11 +00003688{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003689 time_t timet;
3690 double fraction;
3691 int us;
Tim Petersa9bc1682003-01-11 03:39:11 +00003692
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003693 timet = _PyTime_DoubleToTimet(timestamp);
3694 if (timet == (time_t)-1 && PyErr_Occurred())
3695 return NULL;
3696 fraction = timestamp - (double)timet;
3697 us = (int)round_to_long(fraction * 1e6);
3698 if (us < 0) {
3699 /* Truncation towards zero is not what we wanted
3700 for negative numbers (Python's mod semantics) */
3701 timet -= 1;
3702 us += 1000000;
3703 }
3704 /* If timestamp is less than one microsecond smaller than a
3705 * full second, round up. Otherwise, ValueErrors are raised
3706 * for some floats. */
3707 if (us == 1000000) {
3708 timet += 1;
3709 us = 0;
3710 }
3711 return datetime_from_timet_and_us(cls, f, timet, us, tzinfo);
Tim Petersa9bc1682003-01-11 03:39:11 +00003712}
3713
3714/* Internal helper.
3715 * Build most accurate possible datetime for current time. Pass localtime or
3716 * gmtime for f as appropriate.
3717 */
3718static PyObject *
3719datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
3720{
3721#ifdef HAVE_GETTIMEOFDAY
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003722 struct timeval t;
Tim Petersa9bc1682003-01-11 03:39:11 +00003723
3724#ifdef GETTIMEOFDAY_NO_TZ
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003725 gettimeofday(&t);
Tim Petersa9bc1682003-01-11 03:39:11 +00003726#else
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003727 gettimeofday(&t, (struct timezone *)NULL);
Tim Petersa9bc1682003-01-11 03:39:11 +00003728#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003729 return datetime_from_timet_and_us(cls, f, t.tv_sec, (int)t.tv_usec,
3730 tzinfo);
Tim Petersa9bc1682003-01-11 03:39:11 +00003731
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003732#else /* ! HAVE_GETTIMEOFDAY */
3733 /* No flavor of gettimeofday exists on this platform. Python's
3734 * time.time() does a lot of other platform tricks to get the
3735 * best time it can on the platform, and we're not going to do
3736 * better than that (if we could, the better code would belong
3737 * in time.time()!) We're limited by the precision of a double,
3738 * though.
3739 */
3740 PyObject *time;
3741 double dtime;
Tim Petersa9bc1682003-01-11 03:39:11 +00003742
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003743 time = time_time();
3744 if (time == NULL)
3745 return NULL;
3746 dtime = PyFloat_AsDouble(time);
3747 Py_DECREF(time);
3748 if (dtime == -1.0 && PyErr_Occurred())
3749 return NULL;
3750 return datetime_from_timestamp(cls, f, dtime, tzinfo);
3751#endif /* ! HAVE_GETTIMEOFDAY */
Tim Petersa9bc1682003-01-11 03:39:11 +00003752}
3753
Tim Peters2a799bf2002-12-16 20:18:38 +00003754/* Return best possible local time -- this isn't constrained by the
3755 * precision of a timestamp.
3756 */
3757static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003758datetime_now(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003759{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003760 PyObject *self;
3761 PyObject *tzinfo = Py_None;
3762 static char *keywords[] = {"tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003763
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003764 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:now", keywords,
3765 &tzinfo))
3766 return NULL;
3767 if (check_tzinfo_subclass(tzinfo) < 0)
3768 return NULL;
Tim Peters10cadce2003-01-23 19:58:02 +00003769
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003770 self = datetime_best_possible(cls,
3771 tzinfo == Py_None ? localtime : gmtime,
3772 tzinfo);
3773 if (self != NULL && tzinfo != Py_None) {
3774 /* Convert UTC to tzinfo's zone. */
3775 PyObject *temp = self;
3776 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3777 Py_DECREF(temp);
3778 }
3779 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003780}
3781
Tim Petersa9bc1682003-01-11 03:39:11 +00003782/* Return best possible UTC time -- this isn't constrained by the
3783 * precision of a timestamp.
3784 */
3785static PyObject *
3786datetime_utcnow(PyObject *cls, PyObject *dummy)
3787{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003788 return datetime_best_possible(cls, gmtime, Py_None);
Tim Petersa9bc1682003-01-11 03:39:11 +00003789}
3790
Tim Peters2a799bf2002-12-16 20:18:38 +00003791/* Return new local datetime from timestamp (Python timestamp -- a double). */
3792static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003793datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003794{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003795 PyObject *self;
3796 double timestamp;
3797 PyObject *tzinfo = Py_None;
3798 static char *keywords[] = {"timestamp", "tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003799
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003800 if (! PyArg_ParseTupleAndKeywords(args, kw, "d|O:fromtimestamp",
3801 keywords, &timestamp, &tzinfo))
3802 return NULL;
3803 if (check_tzinfo_subclass(tzinfo) < 0)
3804 return NULL;
Tim Peters2a44a8d2003-01-23 20:53:10 +00003805
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003806 self = datetime_from_timestamp(cls,
3807 tzinfo == Py_None ? localtime : gmtime,
3808 timestamp,
3809 tzinfo);
3810 if (self != NULL && tzinfo != Py_None) {
3811 /* Convert UTC to tzinfo's zone. */
3812 PyObject *temp = self;
3813 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3814 Py_DECREF(temp);
3815 }
3816 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003817}
3818
Tim Petersa9bc1682003-01-11 03:39:11 +00003819/* Return new UTC datetime from timestamp (Python timestamp -- a double). */
3820static PyObject *
3821datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
3822{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003823 double timestamp;
3824 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003825
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003826 if (PyArg_ParseTuple(args, "d:utcfromtimestamp", &timestamp))
3827 result = datetime_from_timestamp(cls, gmtime, timestamp,
3828 Py_None);
3829 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00003830}
3831
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003832/* Return new datetime from time.strptime(). */
3833static PyObject *
3834datetime_strptime(PyObject *cls, PyObject *args)
3835{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003836 static PyObject *module = NULL;
3837 PyObject *result = NULL, *obj, *st = NULL, *frac = NULL;
3838 const Py_UNICODE *string, *format;
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003839
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003840 if (!PyArg_ParseTuple(args, "uu:strptime", &string, &format))
3841 return NULL;
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003842
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003843 if (module == NULL &&
3844 (module = PyImport_ImportModuleNoBlock("_strptime")) == NULL)
3845 return NULL;
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003846
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003847 /* _strptime._strptime returns a two-element tuple. The first
3848 element is a time.struct_time object. The second is the
3849 microseconds (which are not defined for time.struct_time). */
3850 obj = PyObject_CallMethod(module, "_strptime", "uu", string, format);
3851 if (obj != NULL) {
3852 int i, good_timetuple = 1;
3853 long int ia[7];
3854 if (PySequence_Check(obj) && PySequence_Size(obj) == 2) {
3855 st = PySequence_GetItem(obj, 0);
3856 frac = PySequence_GetItem(obj, 1);
3857 if (st == NULL || frac == NULL)
3858 good_timetuple = 0;
3859 /* copy y/m/d/h/m/s values out of the
3860 time.struct_time */
3861 if (good_timetuple &&
3862 PySequence_Check(st) &&
3863 PySequence_Size(st) >= 6) {
3864 for (i=0; i < 6; i++) {
3865 PyObject *p = PySequence_GetItem(st, i);
3866 if (p == NULL) {
3867 good_timetuple = 0;
3868 break;
3869 }
3870 if (PyLong_Check(p))
3871 ia[i] = PyLong_AsLong(p);
3872 else
3873 good_timetuple = 0;
3874 Py_DECREF(p);
3875 }
3876/* if (PyLong_CheckExact(p)) {
3877 ia[i] = PyLong_AsLongAndOverflow(p, &overflow);
3878 if (overflow)
3879 good_timetuple = 0;
3880 }
3881 else
3882 good_timetuple = 0;
3883 Py_DECREF(p);
3884*/ }
3885 else
3886 good_timetuple = 0;
3887 /* follow that up with a little dose of microseconds */
3888 if (PyLong_Check(frac))
3889 ia[6] = PyLong_AsLong(frac);
3890 else
3891 good_timetuple = 0;
3892 }
3893 else
3894 good_timetuple = 0;
3895 if (good_timetuple)
3896 result = PyObject_CallFunction(cls, "iiiiiii",
3897 ia[0], ia[1], ia[2],
3898 ia[3], ia[4], ia[5],
3899 ia[6]);
3900 else
3901 PyErr_SetString(PyExc_ValueError,
3902 "unexpected value from _strptime._strptime");
3903 }
3904 Py_XDECREF(obj);
3905 Py_XDECREF(st);
3906 Py_XDECREF(frac);
3907 return result;
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003908}
3909
Tim Petersa9bc1682003-01-11 03:39:11 +00003910/* Return new datetime from date/datetime and time arguments. */
3911static PyObject *
3912datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
3913{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003914 static char *keywords[] = {"date", "time", NULL};
3915 PyObject *date;
3916 PyObject *time;
3917 PyObject *result = NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00003918
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003919 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!:combine", keywords,
3920 &PyDateTime_DateType, &date,
3921 &PyDateTime_TimeType, &time)) {
3922 PyObject *tzinfo = Py_None;
Tim Petersa9bc1682003-01-11 03:39:11 +00003923
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003924 if (HASTZINFO(time))
3925 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
3926 result = PyObject_CallFunction(cls, "iiiiiiiO",
3927 GET_YEAR(date),
3928 GET_MONTH(date),
3929 GET_DAY(date),
3930 TIME_GET_HOUR(time),
3931 TIME_GET_MINUTE(time),
3932 TIME_GET_SECOND(time),
3933 TIME_GET_MICROSECOND(time),
3934 tzinfo);
3935 }
3936 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00003937}
Tim Peters2a799bf2002-12-16 20:18:38 +00003938
3939/*
3940 * Destructor.
3941 */
3942
3943static void
Tim Petersa9bc1682003-01-11 03:39:11 +00003944datetime_dealloc(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003945{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003946 if (HASTZINFO(self)) {
3947 Py_XDECREF(self->tzinfo);
3948 }
3949 Py_TYPE(self)->tp_free((PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003950}
3951
3952/*
3953 * Indirect access to tzinfo methods.
3954 */
3955
Tim Peters2a799bf2002-12-16 20:18:38 +00003956/* These are all METH_NOARGS, so don't need to check the arglist. */
3957static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003958datetime_utcoffset(PyDateTime_DateTime *self, PyObject *unused) {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003959 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3960 "utcoffset", (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003961}
3962
3963static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003964datetime_dst(PyDateTime_DateTime *self, PyObject *unused) {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003965 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3966 "dst", (PyObject *)self);
Tim Peters855fe882002-12-22 03:43:39 +00003967}
3968
3969static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003970datetime_tzname(PyDateTime_DateTime *self, PyObject *unused) {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003971 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
3972 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003973}
3974
3975/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003976 * datetime arithmetic.
Tim Peters2a799bf2002-12-16 20:18:38 +00003977 */
3978
Tim Petersa9bc1682003-01-11 03:39:11 +00003979/* factor must be 1 (to add) or -1 (to subtract). The result inherits
3980 * the tzinfo state of date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003981 */
3982static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003983add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003984 int factor)
Tim Peters2a799bf2002-12-16 20:18:38 +00003985{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003986 /* Note that the C-level additions can't overflow, because of
3987 * invariant bounds on the member values.
3988 */
3989 int year = GET_YEAR(date);
3990 int month = GET_MONTH(date);
3991 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
3992 int hour = DATE_GET_HOUR(date);
3993 int minute = DATE_GET_MINUTE(date);
3994 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
3995 int microsecond = DATE_GET_MICROSECOND(date) +
3996 GET_TD_MICROSECONDS(delta) * factor;
Tim Peters2a799bf2002-12-16 20:18:38 +00003997
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00003998 assert(factor == 1 || factor == -1);
3999 if (normalize_datetime(&year, &month, &day,
4000 &hour, &minute, &second, &microsecond) < 0)
4001 return NULL;
4002 else
4003 return new_datetime(year, month, day,
4004 hour, minute, second, microsecond,
4005 HASTZINFO(date) ? date->tzinfo : Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004006}
4007
4008static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004009datetime_add(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00004010{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004011 if (PyDateTime_Check(left)) {
4012 /* datetime + ??? */
4013 if (PyDelta_Check(right))
4014 /* datetime + delta */
4015 return add_datetime_timedelta(
4016 (PyDateTime_DateTime *)left,
4017 (PyDateTime_Delta *)right,
4018 1);
4019 }
4020 else if (PyDelta_Check(left)) {
4021 /* delta + datetime */
4022 return add_datetime_timedelta((PyDateTime_DateTime *) right,
4023 (PyDateTime_Delta *) left,
4024 1);
4025 }
4026 Py_INCREF(Py_NotImplemented);
4027 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00004028}
4029
4030static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004031datetime_subtract(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00004032{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004033 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00004034
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004035 if (PyDateTime_Check(left)) {
4036 /* datetime - ??? */
4037 if (PyDateTime_Check(right)) {
4038 /* datetime - datetime */
4039 naivety n1, n2;
4040 int offset1, offset2;
4041 int delta_d, delta_s, delta_us;
Tim Peters2a799bf2002-12-16 20:18:38 +00004042
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004043 if (classify_two_utcoffsets(left, &offset1, &n1, left,
4044 right, &offset2, &n2,
4045 right) < 0)
4046 return NULL;
4047 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
4048 if (n1 != n2) {
4049 PyErr_SetString(PyExc_TypeError,
4050 "can't subtract offset-naive and "
4051 "offset-aware datetimes");
4052 return NULL;
4053 }
4054 delta_d = ymd_to_ord(GET_YEAR(left),
4055 GET_MONTH(left),
4056 GET_DAY(left)) -
4057 ymd_to_ord(GET_YEAR(right),
4058 GET_MONTH(right),
4059 GET_DAY(right));
4060 /* These can't overflow, since the values are
4061 * normalized. At most this gives the number of
4062 * seconds in one day.
4063 */
4064 delta_s = (DATE_GET_HOUR(left) -
4065 DATE_GET_HOUR(right)) * 3600 +
4066 (DATE_GET_MINUTE(left) -
4067 DATE_GET_MINUTE(right)) * 60 +
4068 (DATE_GET_SECOND(left) -
4069 DATE_GET_SECOND(right));
4070 delta_us = DATE_GET_MICROSECOND(left) -
4071 DATE_GET_MICROSECOND(right);
4072 /* (left - offset1) - (right - offset2) =
4073 * (left - right) + (offset2 - offset1)
4074 */
4075 delta_s += (offset2 - offset1) * 60;
4076 result = new_delta(delta_d, delta_s, delta_us, 1);
4077 }
4078 else if (PyDelta_Check(right)) {
4079 /* datetime - delta */
4080 result = add_datetime_timedelta(
4081 (PyDateTime_DateTime *)left,
4082 (PyDateTime_Delta *)right,
4083 -1);
4084 }
4085 }
Tim Peters2a799bf2002-12-16 20:18:38 +00004086
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004087 if (result == Py_NotImplemented)
4088 Py_INCREF(result);
4089 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004090}
4091
4092/* Various ways to turn a datetime into a string. */
4093
4094static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004095datetime_repr(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004096{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004097 const char *type_name = Py_TYPE(self)->tp_name;
4098 PyObject *baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004099
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004100 if (DATE_GET_MICROSECOND(self)) {
4101 baserepr = PyUnicode_FromFormat(
4102 "%s(%d, %d, %d, %d, %d, %d, %d)",
4103 type_name,
4104 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4105 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4106 DATE_GET_SECOND(self),
4107 DATE_GET_MICROSECOND(self));
4108 }
4109 else if (DATE_GET_SECOND(self)) {
4110 baserepr = PyUnicode_FromFormat(
4111 "%s(%d, %d, %d, %d, %d, %d)",
4112 type_name,
4113 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4114 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4115 DATE_GET_SECOND(self));
4116 }
4117 else {
4118 baserepr = PyUnicode_FromFormat(
4119 "%s(%d, %d, %d, %d, %d)",
4120 type_name,
4121 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4122 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
4123 }
4124 if (baserepr == NULL || ! HASTZINFO(self))
4125 return baserepr;
4126 return append_keyword_tzinfo(baserepr, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00004127}
4128
Tim Petersa9bc1682003-01-11 03:39:11 +00004129static PyObject *
4130datetime_str(PyDateTime_DateTime *self)
4131{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004132 return PyObject_CallMethod((PyObject *)self, "isoformat", "(s)", " ");
Tim Petersa9bc1682003-01-11 03:39:11 +00004133}
Tim Peters2a799bf2002-12-16 20:18:38 +00004134
4135static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004136datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004137{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004138 int sep = 'T';
4139 static char *keywords[] = {"sep", NULL};
4140 char buffer[100];
4141 PyObject *result;
4142 int us = DATE_GET_MICROSECOND(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00004143
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004144 if (!PyArg_ParseTupleAndKeywords(args, kw, "|C:isoformat", keywords, &sep))
4145 return NULL;
4146 if (us)
4147 result = PyUnicode_FromFormat("%04d-%02d-%02d%c%02d:%02d:%02d.%06d",
4148 GET_YEAR(self), GET_MONTH(self),
4149 GET_DAY(self), (int)sep,
4150 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4151 DATE_GET_SECOND(self), us);
4152 else
4153 result = PyUnicode_FromFormat("%04d-%02d-%02d%c%02d:%02d:%02d",
4154 GET_YEAR(self), GET_MONTH(self),
4155 GET_DAY(self), (int)sep,
4156 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4157 DATE_GET_SECOND(self));
Walter Dörwaldbafa1372007-05-31 17:50:48 +00004158
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004159 if (!result || !HASTZINFO(self))
4160 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004161
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004162 /* We need to append the UTC offset. */
4163 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
4164 (PyObject *)self) < 0) {
4165 Py_DECREF(result);
4166 return NULL;
4167 }
4168 PyUnicode_AppendAndDel(&result, PyUnicode_FromString(buffer));
4169 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004170}
4171
Tim Petersa9bc1682003-01-11 03:39:11 +00004172static PyObject *
4173datetime_ctime(PyDateTime_DateTime *self)
4174{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004175 return format_ctime((PyDateTime_Date *)self,
4176 DATE_GET_HOUR(self),
4177 DATE_GET_MINUTE(self),
4178 DATE_GET_SECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00004179}
4180
Tim Peters2a799bf2002-12-16 20:18:38 +00004181/* Miscellaneous methods. */
4182
Tim Petersa9bc1682003-01-11 03:39:11 +00004183static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00004184datetime_richcompare(PyObject *self, PyObject *other, int op)
Tim Petersa9bc1682003-01-11 03:39:11 +00004185{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004186 int diff;
4187 naivety n1, n2;
4188 int offset1, offset2;
Tim Petersa9bc1682003-01-11 03:39:11 +00004189
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004190 if (! PyDateTime_Check(other)) {
4191 if (PyDate_Check(other)) {
4192 /* Prevent invocation of date_richcompare. We want to
4193 return NotImplemented here to give the other object
4194 a chance. But since DateTime is a subclass of
4195 Date, if the other object is a Date, it would
4196 compute an ordering based on the date part alone,
4197 and we don't want that. So force unequal or
4198 uncomparable here in that case. */
4199 if (op == Py_EQ)
4200 Py_RETURN_FALSE;
4201 if (op == Py_NE)
4202 Py_RETURN_TRUE;
4203 return cmperror(self, other);
4204 }
4205 Py_INCREF(Py_NotImplemented);
4206 return Py_NotImplemented;
4207 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004208
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004209 if (classify_two_utcoffsets(self, &offset1, &n1, self,
4210 other, &offset2, &n2, other) < 0)
4211 return NULL;
4212 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
4213 /* If they're both naive, or both aware and have the same offsets,
4214 * we get off cheap. Note that if they're both naive, offset1 ==
4215 * offset2 == 0 at this point.
4216 */
4217 if (n1 == n2 && offset1 == offset2) {
4218 diff = memcmp(((PyDateTime_DateTime *)self)->data,
4219 ((PyDateTime_DateTime *)other)->data,
4220 _PyDateTime_DATETIME_DATASIZE);
4221 return diff_to_bool(diff, op);
4222 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004223
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004224 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
4225 PyDateTime_Delta *delta;
Tim Petersa9bc1682003-01-11 03:39:11 +00004226
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004227 assert(offset1 != offset2); /* else last "if" handled it */
4228 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
4229 other);
4230 if (delta == NULL)
4231 return NULL;
4232 diff = GET_TD_DAYS(delta);
4233 if (diff == 0)
4234 diff = GET_TD_SECONDS(delta) |
4235 GET_TD_MICROSECONDS(delta);
4236 Py_DECREF(delta);
4237 return diff_to_bool(diff, op);
4238 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004239
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004240 assert(n1 != n2);
4241 PyErr_SetString(PyExc_TypeError,
4242 "can't compare offset-naive and "
4243 "offset-aware datetimes");
4244 return NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00004245}
4246
4247static long
4248datetime_hash(PyDateTime_DateTime *self)
4249{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004250 if (self->hashcode == -1) {
4251 naivety n;
4252 int offset;
4253 PyObject *temp;
Tim Petersa9bc1682003-01-11 03:39:11 +00004254
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004255 n = classify_utcoffset((PyObject *)self, (PyObject *)self,
4256 &offset);
4257 assert(n != OFFSET_UNKNOWN);
4258 if (n == OFFSET_ERROR)
4259 return -1;
Tim Petersa9bc1682003-01-11 03:39:11 +00004260
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004261 /* Reduce this to a hash of another object. */
4262 if (n == OFFSET_NAIVE) {
4263 self->hashcode = generic_hash(
4264 (unsigned char *)self->data, _PyDateTime_DATETIME_DATASIZE);
4265 return self->hashcode;
4266 }
4267 else {
4268 int days;
4269 int seconds;
Tim Petersa9bc1682003-01-11 03:39:11 +00004270
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004271 assert(n == OFFSET_AWARE);
4272 assert(HASTZINFO(self));
4273 days = ymd_to_ord(GET_YEAR(self),
4274 GET_MONTH(self),
4275 GET_DAY(self));
4276 seconds = DATE_GET_HOUR(self) * 3600 +
4277 (DATE_GET_MINUTE(self) - offset) * 60 +
4278 DATE_GET_SECOND(self);
4279 temp = new_delta(days,
4280 seconds,
4281 DATE_GET_MICROSECOND(self),
4282 1);
4283 }
4284 if (temp != NULL) {
4285 self->hashcode = PyObject_Hash(temp);
4286 Py_DECREF(temp);
4287 }
4288 }
4289 return self->hashcode;
Tim Petersa9bc1682003-01-11 03:39:11 +00004290}
Tim Peters2a799bf2002-12-16 20:18:38 +00004291
4292static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004293datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00004294{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004295 PyObject *clone;
4296 PyObject *tuple;
4297 int y = GET_YEAR(self);
4298 int m = GET_MONTH(self);
4299 int d = GET_DAY(self);
4300 int hh = DATE_GET_HOUR(self);
4301 int mm = DATE_GET_MINUTE(self);
4302 int ss = DATE_GET_SECOND(self);
4303 int us = DATE_GET_MICROSECOND(self);
4304 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00004305
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004306 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO:replace",
4307 datetime_kws,
4308 &y, &m, &d, &hh, &mm, &ss, &us,
4309 &tzinfo))
4310 return NULL;
4311 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
4312 if (tuple == NULL)
4313 return NULL;
4314 clone = datetime_new(Py_TYPE(self), tuple, NULL);
4315 Py_DECREF(tuple);
4316 return clone;
Tim Peters12bf3392002-12-24 05:41:27 +00004317}
4318
4319static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004320datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters80475bb2002-12-25 07:40:55 +00004321{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004322 int y, m, d, hh, mm, ss, us;
4323 PyObject *result;
4324 int offset, none;
Tim Peters521fc152002-12-31 17:36:56 +00004325
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004326 PyObject *tzinfo;
4327 static char *keywords[] = {"tz", NULL};
Tim Peters80475bb2002-12-25 07:40:55 +00004328
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004329 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:astimezone", keywords,
4330 &PyDateTime_TZInfoType, &tzinfo))
4331 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00004332
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004333 if (!HASTZINFO(self) || self->tzinfo == Py_None)
4334 goto NeedAware;
Tim Peters521fc152002-12-31 17:36:56 +00004335
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004336 /* Conversion to self's own time zone is a NOP. */
4337 if (self->tzinfo == tzinfo) {
4338 Py_INCREF(self);
4339 return (PyObject *)self;
4340 }
Tim Peters521fc152002-12-31 17:36:56 +00004341
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004342 /* Convert self to UTC. */
4343 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4344 if (offset == -1 && PyErr_Occurred())
4345 return NULL;
4346 if (none)
4347 goto NeedAware;
Tim Petersf3615152003-01-01 21:51:37 +00004348
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004349 y = GET_YEAR(self);
4350 m = GET_MONTH(self);
4351 d = GET_DAY(self);
4352 hh = DATE_GET_HOUR(self);
4353 mm = DATE_GET_MINUTE(self);
4354 ss = DATE_GET_SECOND(self);
4355 us = DATE_GET_MICROSECOND(self);
Tim Peters52dcce22003-01-23 16:36:11 +00004356
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004357 mm -= offset;
4358 if ((mm < 0 || mm >= 60) &&
4359 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
4360 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00004361
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004362 /* Attach new tzinfo and let fromutc() do the rest. */
4363 result = new_datetime(y, m, d, hh, mm, ss, us, tzinfo);
4364 if (result != NULL) {
4365 PyObject *temp = result;
Tim Peters52dcce22003-01-23 16:36:11 +00004366
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004367 result = PyObject_CallMethod(tzinfo, "fromutc", "O", temp);
4368 Py_DECREF(temp);
4369 }
4370 return result;
Tim Peters521fc152002-12-31 17:36:56 +00004371
Tim Peters52dcce22003-01-23 16:36:11 +00004372NeedAware:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004373 PyErr_SetString(PyExc_ValueError, "astimezone() cannot be applied to "
4374 "a naive datetime");
4375 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00004376}
4377
4378static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004379datetime_timetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004380{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004381 int dstflag = -1;
Tim Peters2a799bf2002-12-16 20:18:38 +00004382
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004383 if (HASTZINFO(self) && self->tzinfo != Py_None) {
4384 int none;
Tim Peters2a799bf2002-12-16 20:18:38 +00004385
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004386 dstflag = call_dst(self->tzinfo, (PyObject *)self, &none);
4387 if (dstflag == -1 && PyErr_Occurred())
4388 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004389
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004390 if (none)
4391 dstflag = -1;
4392 else if (dstflag != 0)
4393 dstflag = 1;
Tim Peters2a799bf2002-12-16 20:18:38 +00004394
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004395 }
4396 return build_struct_time(GET_YEAR(self),
4397 GET_MONTH(self),
4398 GET_DAY(self),
4399 DATE_GET_HOUR(self),
4400 DATE_GET_MINUTE(self),
4401 DATE_GET_SECOND(self),
4402 dstflag);
Tim Peters2a799bf2002-12-16 20:18:38 +00004403}
4404
4405static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004406datetime_getdate(PyDateTime_DateTime *self)
4407{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004408 return new_date(GET_YEAR(self),
4409 GET_MONTH(self),
4410 GET_DAY(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00004411}
4412
4413static PyObject *
4414datetime_gettime(PyDateTime_DateTime *self)
4415{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004416 return new_time(DATE_GET_HOUR(self),
4417 DATE_GET_MINUTE(self),
4418 DATE_GET_SECOND(self),
4419 DATE_GET_MICROSECOND(self),
4420 Py_None);
Tim Petersa9bc1682003-01-11 03:39:11 +00004421}
4422
4423static PyObject *
4424datetime_gettimetz(PyDateTime_DateTime *self)
4425{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004426 return new_time(DATE_GET_HOUR(self),
4427 DATE_GET_MINUTE(self),
4428 DATE_GET_SECOND(self),
4429 DATE_GET_MICROSECOND(self),
4430 HASTZINFO(self) ? self->tzinfo : Py_None);
Tim Petersa9bc1682003-01-11 03:39:11 +00004431}
4432
4433static PyObject *
4434datetime_utctimetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004435{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004436 int y = GET_YEAR(self);
4437 int m = GET_MONTH(self);
4438 int d = GET_DAY(self);
4439 int hh = DATE_GET_HOUR(self);
4440 int mm = DATE_GET_MINUTE(self);
4441 int ss = DATE_GET_SECOND(self);
4442 int us = 0; /* microseconds are ignored in a timetuple */
4443 int offset = 0;
Tim Peters2a799bf2002-12-16 20:18:38 +00004444
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004445 if (HASTZINFO(self) && self->tzinfo != Py_None) {
4446 int none;
Tim Peters2a799bf2002-12-16 20:18:38 +00004447
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004448 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4449 if (offset == -1 && PyErr_Occurred())
4450 return NULL;
4451 }
4452 /* Even if offset is 0, don't call timetuple() -- tm_isdst should be
4453 * 0 in a UTC timetuple regardless of what dst() says.
4454 */
4455 if (offset) {
4456 /* Subtract offset minutes & normalize. */
4457 int stat;
Tim Peters2a799bf2002-12-16 20:18:38 +00004458
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004459 mm -= offset;
4460 stat = normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us);
4461 if (stat < 0) {
4462 /* At the edges, it's possible we overflowed
4463 * beyond MINYEAR or MAXYEAR.
4464 */
4465 if (PyErr_ExceptionMatches(PyExc_OverflowError))
4466 PyErr_Clear();
4467 else
4468 return NULL;
4469 }
4470 }
4471 return build_struct_time(y, m, d, hh, mm, ss, 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00004472}
4473
Tim Peters371935f2003-02-01 01:52:50 +00004474/* Pickle support, a simple use of __reduce__. */
Tim Peters33e0f382003-01-10 02:05:14 +00004475
Tim Petersa9bc1682003-01-11 03:39:11 +00004476/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004477 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4478 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00004479 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00004480 */
4481static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004482datetime_getstate(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004483{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004484 PyObject *basestate;
4485 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004486
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004487 basestate = PyBytes_FromStringAndSize((char *)self->data,
4488 _PyDateTime_DATETIME_DATASIZE);
4489 if (basestate != NULL) {
4490 if (! HASTZINFO(self) || self->tzinfo == Py_None)
4491 result = PyTuple_Pack(1, basestate);
4492 else
4493 result = PyTuple_Pack(2, basestate, self->tzinfo);
4494 Py_DECREF(basestate);
4495 }
4496 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004497}
4498
4499static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00004500datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00004501{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004502 return Py_BuildValue("(ON)", Py_TYPE(self), datetime_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00004503}
4504
Tim Petersa9bc1682003-01-11 03:39:11 +00004505static PyMethodDef datetime_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004506
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004507 /* Class methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00004508
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004509 {"now", (PyCFunction)datetime_now,
4510 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4511 PyDoc_STR("[tz] -> new datetime with tz's local day and time.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004512
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004513 {"utcnow", (PyCFunction)datetime_utcnow,
4514 METH_NOARGS | METH_CLASS,
4515 PyDoc_STR("Return a new datetime representing UTC day and time.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004516
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004517 {"fromtimestamp", (PyCFunction)datetime_fromtimestamp,
4518 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4519 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004520
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004521 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
4522 METH_VARARGS | METH_CLASS,
4523 PyDoc_STR("timestamp -> UTC datetime from a POSIX timestamp "
4524 "(like time.time()).")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004525
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004526 {"strptime", (PyCFunction)datetime_strptime,
4527 METH_VARARGS | METH_CLASS,
4528 PyDoc_STR("string, format -> new datetime parsed from a string "
4529 "(like time.strptime()).")},
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004530
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004531 {"combine", (PyCFunction)datetime_combine,
4532 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4533 PyDoc_STR("date, time -> datetime with same date and time fields")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004534
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004535 /* Instance methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00004536
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004537 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
4538 PyDoc_STR("Return date object with same year, month and day.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004539
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004540 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
4541 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004542
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004543 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
4544 PyDoc_STR("Return time object with same time and tzinfo.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004545
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004546 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
4547 PyDoc_STR("Return ctime() style string.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00004548
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004549 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
4550 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004551
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004552 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
4553 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004554
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004555 {"isoformat", (PyCFunction)datetime_isoformat, METH_VARARGS | METH_KEYWORDS,
4556 PyDoc_STR("[sep] -> string in ISO 8601 format, "
4557 "YYYY-MM-DDTHH:MM:SS[.mmmmmm][+HH:MM].\n\n"
4558 "sep is used to separate the year from the time, and "
4559 "defaults to 'T'.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004560
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004561 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
4562 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004563
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004564 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
4565 PyDoc_STR("Return self.tzinfo.tzname(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004566
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004567 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
4568 PyDoc_STR("Return self.tzinfo.dst(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004569
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004570 {"replace", (PyCFunction)datetime_replace, METH_VARARGS | METH_KEYWORDS,
4571 PyDoc_STR("Return datetime with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00004572
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004573 {"astimezone", (PyCFunction)datetime_astimezone, METH_VARARGS | METH_KEYWORDS,
4574 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
Tim Peters80475bb2002-12-25 07:40:55 +00004575
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004576 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
4577 PyDoc_STR("__reduce__() -> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00004578
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004579 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00004580};
4581
Tim Petersa9bc1682003-01-11 03:39:11 +00004582static char datetime_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00004583PyDoc_STR("datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])\n\
4584\n\
4585The year, month and day arguments are required. tzinfo may be None, or an\n\
4586instance of a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00004587
Tim Petersa9bc1682003-01-11 03:39:11 +00004588static PyNumberMethods datetime_as_number = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004589 datetime_add, /* nb_add */
4590 datetime_subtract, /* nb_subtract */
4591 0, /* nb_multiply */
4592 0, /* nb_remainder */
4593 0, /* nb_divmod */
4594 0, /* nb_power */
4595 0, /* nb_negative */
4596 0, /* nb_positive */
4597 0, /* nb_absolute */
4598 0, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00004599};
4600
Neal Norwitz227b5332006-03-22 09:28:35 +00004601static PyTypeObject PyDateTime_DateTimeType = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004602 PyVarObject_HEAD_INIT(NULL, 0)
4603 "datetime.datetime", /* tp_name */
4604 sizeof(PyDateTime_DateTime), /* tp_basicsize */
4605 0, /* tp_itemsize */
4606 (destructor)datetime_dealloc, /* tp_dealloc */
4607 0, /* tp_print */
4608 0, /* tp_getattr */
4609 0, /* tp_setattr */
4610 0, /* tp_reserved */
4611 (reprfunc)datetime_repr, /* tp_repr */
4612 &datetime_as_number, /* tp_as_number */
4613 0, /* tp_as_sequence */
4614 0, /* tp_as_mapping */
4615 (hashfunc)datetime_hash, /* tp_hash */
4616 0, /* tp_call */
4617 (reprfunc)datetime_str, /* tp_str */
4618 PyObject_GenericGetAttr, /* tp_getattro */
4619 0, /* tp_setattro */
4620 0, /* tp_as_buffer */
4621 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
4622 datetime_doc, /* tp_doc */
4623 0, /* tp_traverse */
4624 0, /* tp_clear */
4625 datetime_richcompare, /* tp_richcompare */
4626 0, /* tp_weaklistoffset */
4627 0, /* tp_iter */
4628 0, /* tp_iternext */
4629 datetime_methods, /* tp_methods */
4630 0, /* tp_members */
4631 datetime_getset, /* tp_getset */
4632 &PyDateTime_DateType, /* tp_base */
4633 0, /* tp_dict */
4634 0, /* tp_descr_get */
4635 0, /* tp_descr_set */
4636 0, /* tp_dictoffset */
4637 0, /* tp_init */
4638 datetime_alloc, /* tp_alloc */
4639 datetime_new, /* tp_new */
4640 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00004641};
4642
4643/* ---------------------------------------------------------------------------
4644 * Module methods and initialization.
4645 */
4646
4647static PyMethodDef module_methods[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004648 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00004649};
4650
Tim Peters9ddf40b2004-06-20 22:41:32 +00004651/* C API. Clients get at this via PyDateTime_IMPORT, defined in
4652 * datetime.h.
4653 */
4654static PyDateTime_CAPI CAPI = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004655 &PyDateTime_DateType,
4656 &PyDateTime_DateTimeType,
4657 &PyDateTime_TimeType,
4658 &PyDateTime_DeltaType,
4659 &PyDateTime_TZInfoType,
4660 new_date_ex,
4661 new_datetime_ex,
4662 new_time_ex,
4663 new_delta_ex,
4664 datetime_fromtimestamp,
4665 date_fromtimestamp
Tim Peters9ddf40b2004-06-20 22:41:32 +00004666};
4667
4668
Martin v. Löwis1a214512008-06-11 05:26:20 +00004669
4670static struct PyModuleDef datetimemodule = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004671 PyModuleDef_HEAD_INIT,
4672 "datetime",
4673 "Fast implementation of the datetime type.",
4674 -1,
4675 module_methods,
4676 NULL,
4677 NULL,
4678 NULL,
4679 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004680};
4681
Tim Peters2a799bf2002-12-16 20:18:38 +00004682PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004683PyInit_datetime(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00004684{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004685 PyObject *m; /* a module object */
4686 PyObject *d; /* its dict */
4687 PyObject *x;
Tim Peters2a799bf2002-12-16 20:18:38 +00004688
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004689 m = PyModule_Create(&datetimemodule);
4690 if (m == NULL)
4691 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004692
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004693 if (PyType_Ready(&PyDateTime_DateType) < 0)
4694 return NULL;
4695 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
4696 return NULL;
4697 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
4698 return NULL;
4699 if (PyType_Ready(&PyDateTime_TimeType) < 0)
4700 return NULL;
4701 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
4702 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004703
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004704 /* timedelta values */
4705 d = PyDateTime_DeltaType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004706
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004707 x = new_delta(0, 0, 1, 0);
4708 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4709 return NULL;
4710 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00004711
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004712 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
4713 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4714 return NULL;
4715 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00004716
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004717 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
4718 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4719 return NULL;
4720 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00004721
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004722 /* date values */
4723 d = PyDateTime_DateType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004724
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004725 x = new_date(1, 1, 1);
4726 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4727 return NULL;
4728 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00004729
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004730 x = new_date(MAXYEAR, 12, 31);
4731 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4732 return NULL;
4733 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00004734
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004735 x = new_delta(1, 0, 0, 0);
4736 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4737 return NULL;
4738 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00004739
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004740 /* time values */
4741 d = PyDateTime_TimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004742
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004743 x = new_time(0, 0, 0, 0, Py_None);
4744 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4745 return NULL;
4746 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00004747
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004748 x = new_time(23, 59, 59, 999999, Py_None);
4749 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4750 return NULL;
4751 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00004752
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004753 x = new_delta(0, 0, 1, 0);
4754 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4755 return NULL;
4756 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00004757
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004758 /* datetime values */
4759 d = PyDateTime_DateTimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004760
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004761 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None);
4762 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4763 return NULL;
4764 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00004765
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004766 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None);
4767 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4768 return NULL;
4769 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00004770
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004771 x = new_delta(0, 0, 1, 0);
4772 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4773 return NULL;
4774 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00004775
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004776 /* module initialization */
4777 PyModule_AddIntConstant(m, "MINYEAR", MINYEAR);
4778 PyModule_AddIntConstant(m, "MAXYEAR", MAXYEAR);
Tim Peters2a799bf2002-12-16 20:18:38 +00004779
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004780 Py_INCREF(&PyDateTime_DateType);
4781 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
Tim Peters2a799bf2002-12-16 20:18:38 +00004782
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004783 Py_INCREF(&PyDateTime_DateTimeType);
4784 PyModule_AddObject(m, "datetime",
4785 (PyObject *)&PyDateTime_DateTimeType);
Tim Petersa9bc1682003-01-11 03:39:11 +00004786
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004787 Py_INCREF(&PyDateTime_TimeType);
4788 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
Tim Petersa9bc1682003-01-11 03:39:11 +00004789
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004790 Py_INCREF(&PyDateTime_DeltaType);
4791 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
Tim Peters2a799bf2002-12-16 20:18:38 +00004792
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004793 Py_INCREF(&PyDateTime_TZInfoType);
4794 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
Tim Peters2a799bf2002-12-16 20:18:38 +00004795
Benjamin Petersonb173f782009-05-05 22:31:58 +00004796 x = PyCapsule_New(&CAPI, PyDateTime_CAPSULE_NAME, NULL);
4797 if (x == NULL)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004798 return NULL;
Benjamin Petersonb173f782009-05-05 22:31:58 +00004799 PyModule_AddObject(m, "datetime_CAPI", x);
Tim Peters9ddf40b2004-06-20 22:41:32 +00004800
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004801 /* A 4-year cycle has an extra leap day over what we'd get from
4802 * pasting together 4 single years.
4803 */
4804 assert(DI4Y == 4 * 365 + 1);
4805 assert(DI4Y == days_before_year(4+1));
Tim Peters2a799bf2002-12-16 20:18:38 +00004806
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004807 /* Similarly, a 400-year cycle has an extra leap day over what we'd
4808 * get from pasting together 4 100-year cycles.
4809 */
4810 assert(DI400Y == 4 * DI100Y + 1);
4811 assert(DI400Y == days_before_year(400+1));
Tim Peters2a799bf2002-12-16 20:18:38 +00004812
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004813 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
4814 * pasting together 25 4-year cycles.
4815 */
4816 assert(DI100Y == 25 * DI4Y - 1);
4817 assert(DI100Y == days_before_year(100+1));
Tim Peters2a799bf2002-12-16 20:18:38 +00004818
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004819 us_per_us = PyLong_FromLong(1);
4820 us_per_ms = PyLong_FromLong(1000);
4821 us_per_second = PyLong_FromLong(1000000);
4822 us_per_minute = PyLong_FromLong(60000000);
4823 seconds_per_day = PyLong_FromLong(24 * 3600);
4824 if (us_per_us == NULL || us_per_ms == NULL || us_per_second == NULL ||
4825 us_per_minute == NULL || seconds_per_day == NULL)
4826 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004827
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004828 /* The rest are too big for 32-bit ints, but even
4829 * us_per_week fits in 40 bits, so doubles should be exact.
4830 */
4831 us_per_hour = PyLong_FromDouble(3600000000.0);
4832 us_per_day = PyLong_FromDouble(86400000000.0);
4833 us_per_week = PyLong_FromDouble(604800000000.0);
4834 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
4835 return NULL;
4836 return m;
Tim Peters2a799bf2002-12-16 20:18:38 +00004837}
Tim Petersf3615152003-01-01 21:51:37 +00004838
4839/* ---------------------------------------------------------------------------
Tim Petersa9bc1682003-01-11 03:39:11 +00004840Some time zone algebra. For a datetime x, let
Tim Petersf3615152003-01-01 21:51:37 +00004841 x.n = x stripped of its timezone -- its naive time.
4842 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004843 return None
Tim Petersf3615152003-01-01 21:51:37 +00004844 x.d = x.dst(), and assuming that doesn't raise an exception or
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004845 return None
Tim Petersf3615152003-01-01 21:51:37 +00004846 x.s = x's standard offset, x.o - x.d
4847
4848Now some derived rules, where k is a duration (timedelta).
4849
48501. x.o = x.s + x.d
4851 This follows from the definition of x.s.
4852
Tim Petersc5dc4da2003-01-02 17:55:03 +000048532. If x and y have the same tzinfo member, x.s = y.s.
Tim Petersf3615152003-01-01 21:51:37 +00004854 This is actually a requirement, an assumption we need to make about
4855 sane tzinfo classes.
4856
48573. The naive UTC time corresponding to x is x.n - x.o.
4858 This is again a requirement for a sane tzinfo class.
4859
48604. (x+k).s = x.s
Tim Peters8bb5ad22003-01-24 02:44:45 +00004861 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
Tim Petersf3615152003-01-01 21:51:37 +00004862
Tim Petersc5dc4da2003-01-02 17:55:03 +000048635. (x+k).n = x.n + k
Tim Petersf3615152003-01-01 21:51:37 +00004864 Again follows from how arithmetic is defined.
4865
Tim Peters8bb5ad22003-01-24 02:44:45 +00004866Now we can explain tz.fromutc(x). Let's assume it's an interesting case
Tim Petersf3615152003-01-01 21:51:37 +00004867(meaning that the various tzinfo methods exist, and don't blow up or return
4868None when called).
4869
Tim Petersa9bc1682003-01-11 03:39:11 +00004870The function wants to return a datetime y with timezone tz, equivalent to x.
Tim Peters8bb5ad22003-01-24 02:44:45 +00004871x is already in UTC.
Tim Petersf3615152003-01-01 21:51:37 +00004872
4873By #3, we want
4874
Tim Peters8bb5ad22003-01-24 02:44:45 +00004875 y.n - y.o = x.n [1]
Tim Petersf3615152003-01-01 21:51:37 +00004876
4877The algorithm starts by attaching tz to x.n, and calling that y. So
4878x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
4879becomes true; in effect, we want to solve [2] for k:
4880
Tim Peters8bb5ad22003-01-24 02:44:45 +00004881 (y+k).n - (y+k).o = x.n [2]
Tim Petersf3615152003-01-01 21:51:37 +00004882
4883By #1, this is the same as
4884
Tim Peters8bb5ad22003-01-24 02:44:45 +00004885 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
Tim Petersf3615152003-01-01 21:51:37 +00004886
4887By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
4888Substituting that into [3],
4889
Tim Peters8bb5ad22003-01-24 02:44:45 +00004890 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
4891 k - (y+k).s - (y+k).d = 0; rearranging,
4892 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
4893 k = y.s - (y+k).d
Tim Petersf3615152003-01-01 21:51:37 +00004894
Tim Peters8bb5ad22003-01-24 02:44:45 +00004895On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
4896approximate k by ignoring the (y+k).d term at first. Note that k can't be
4897very large, since all offset-returning methods return a duration of magnitude
4898less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
4899be 0, so ignoring it has no consequence then.
Tim Petersf3615152003-01-01 21:51:37 +00004900
4901In any case, the new value is
4902
Tim Peters8bb5ad22003-01-24 02:44:45 +00004903 z = y + y.s [4]
Tim Petersf3615152003-01-01 21:51:37 +00004904
Tim Peters8bb5ad22003-01-24 02:44:45 +00004905It's helpful to step back at look at [4] from a higher level: it's simply
4906mapping from UTC to tz's standard time.
Tim Petersc5dc4da2003-01-02 17:55:03 +00004907
4908At this point, if
4909
Tim Peters8bb5ad22003-01-24 02:44:45 +00004910 z.n - z.o = x.n [5]
Tim Petersc5dc4da2003-01-02 17:55:03 +00004911
4912we have an equivalent time, and are almost done. The insecurity here is
Tim Petersf3615152003-01-01 21:51:37 +00004913at the start of daylight time. Picture US Eastern for concreteness. The wall
4914time 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 +00004915sense then. The docs ask that an Eastern tzinfo class consider such a time to
4916be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
4917on the day DST starts. We want to return the 1:MM EST spelling because that's
Tim Petersf3615152003-01-01 21:51:37 +00004918the only spelling that makes sense on the local wall clock.
4919
Tim Petersc5dc4da2003-01-02 17:55:03 +00004920In fact, if [5] holds at this point, we do have the standard-time spelling,
4921but that takes a bit of proof. We first prove a stronger result. What's the
4922difference between the LHS and RHS of [5]? Let
Tim Petersf3615152003-01-01 21:51:37 +00004923
Tim Peters8bb5ad22003-01-24 02:44:45 +00004924 diff = x.n - (z.n - z.o) [6]
Tim Petersf3615152003-01-01 21:51:37 +00004925
Tim Petersc5dc4da2003-01-02 17:55:03 +00004926Now
4927 z.n = by [4]
Tim Peters8bb5ad22003-01-24 02:44:45 +00004928 (y + y.s).n = by #5
4929 y.n + y.s = since y.n = x.n
4930 x.n + y.s = since z and y are have the same tzinfo member,
4931 y.s = z.s by #2
4932 x.n + z.s
Tim Petersf3615152003-01-01 21:51:37 +00004933
Tim Petersc5dc4da2003-01-02 17:55:03 +00004934Plugging that back into [6] gives
Tim Petersf3615152003-01-01 21:51:37 +00004935
Tim Petersc5dc4da2003-01-02 17:55:03 +00004936 diff =
Tim Peters8bb5ad22003-01-24 02:44:45 +00004937 x.n - ((x.n + z.s) - z.o) = expanding
4938 x.n - x.n - z.s + z.o = cancelling
4939 - z.s + z.o = by #2
Tim Petersc5dc4da2003-01-02 17:55:03 +00004940 z.d
Tim Petersf3615152003-01-01 21:51:37 +00004941
Tim Petersc5dc4da2003-01-02 17:55:03 +00004942So diff = z.d.
Tim Petersf3615152003-01-01 21:51:37 +00004943
Tim Petersc5dc4da2003-01-02 17:55:03 +00004944If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
Tim Peters8bb5ad22003-01-24 02:44:45 +00004945spelling we wanted in the endcase described above. We're done. Contrarily,
4946if z.d = 0, then we have a UTC equivalent, and are also done.
Tim Petersf3615152003-01-01 21:51:37 +00004947
Tim Petersc5dc4da2003-01-02 17:55:03 +00004948If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
4949add to z (in effect, z is in tz's standard time, and we need to shift the
Tim Peters8bb5ad22003-01-24 02:44:45 +00004950local clock into tz's daylight time).
Tim Petersf3615152003-01-01 21:51:37 +00004951
Tim Petersc5dc4da2003-01-02 17:55:03 +00004952Let
Tim Petersf3615152003-01-01 21:51:37 +00004953
Tim Peters4fede1a2003-01-04 00:26:59 +00004954 z' = z + z.d = z + diff [7]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004955
Tim Peters4fede1a2003-01-04 00:26:59 +00004956and we can again ask whether
Tim Petersc3bb26a2003-01-02 03:14:59 +00004957
Tim Peters8bb5ad22003-01-24 02:44:45 +00004958 z'.n - z'.o = x.n [8]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004959
Tim Peters8bb5ad22003-01-24 02:44:45 +00004960If so, we're done. If not, the tzinfo class is insane, according to the
4961assumptions we've made. This also requires a bit of proof. As before, let's
4962compute the difference between the LHS and RHS of [8] (and skipping some of
4963the justifications for the kinds of substitutions we've done several times
4964already):
Tim Peters4fede1a2003-01-04 00:26:59 +00004965
Tim Peters8bb5ad22003-01-24 02:44:45 +00004966 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00004967 x.n - (z.n + diff - z'.o) = replacing diff via [6]
4968 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
4969 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
4970 - z.n + z.n - z.o + z'.o = cancel z.n
4971 - z.o + z'.o = #1 twice
4972 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
4973 z'.d - z.d
Tim Peters4fede1a2003-01-04 00:26:59 +00004974
4975So 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 +00004976we've found the UTC-equivalent so are done. In fact, we stop with [7] and
4977return z', not bothering to compute z'.d.
Tim Peters4fede1a2003-01-04 00:26:59 +00004978
Tim Peters8bb5ad22003-01-24 02:44:45 +00004979How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
4980a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
4981would have to change the result dst() returns: we start in DST, and moving
4982a little further into it takes us out of DST.
Tim Peters4fede1a2003-01-04 00:26:59 +00004983
Tim Peters8bb5ad22003-01-24 02:44:45 +00004984There isn't a sane case where this can happen. The closest it gets is at
4985the end of DST, where there's an hour in UTC with no spelling in a hybrid
4986tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
4987that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
4988UTC) because the docs insist on that, but 0:MM is taken as being in daylight
4989time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
4990clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
4991standard time. Since that's what the local clock *does*, we want to map both
4992UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
Tim Peters4fede1a2003-01-04 00:26:59 +00004993in local time, but so it goes -- it's the way the local clock works.
4994
Tim Peters8bb5ad22003-01-24 02:44:45 +00004995When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
4996so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
4997z' = 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 +00004998(correctly) concludes that z' is not UTC-equivalent to x.
4999
5000Because we know z.d said z was in daylight time (else [5] would have held and
5001we would have stopped then), and we know z.d != z'.d (else [8] would have held
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00005002and we would have stopped then), and there are only 2 possible values dst() can
Tim Peters4fede1a2003-01-04 00:26:59 +00005003return in Eastern, it follows that z'.d must be 0 (which it is in the example,
5004but the reasoning doesn't depend on the example -- it depends on there being
5005two possible dst() outcomes, one zero and the other non-zero). Therefore
Tim Peters8bb5ad22003-01-24 02:44:45 +00005006z' must be in standard time, and is the spelling we want in this case.
5007
5008Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
5009concerned (because it takes z' as being in standard time rather than the
5010daylight time we intend here), but returning it gives the real-life "local
5011clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
5012tz.
5013
5014When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
5015the 1:MM standard time spelling we want.
5016
5017So how can this break? One of the assumptions must be violated. Two
5018possibilities:
5019
50201) [2] effectively says that y.s is invariant across all y belong to a given
5021 time zone. This isn't true if, for political reasons or continental drift,
5022 a region decides to change its base offset from UTC.
5023
50242) There may be versions of "double daylight" time where the tail end of
5025 the analysis gives up a step too early. I haven't thought about that
5026 enough to say.
5027
5028In any case, it's clear that the default fromutc() is strong enough to handle
5029"almost all" time zones: so long as the standard offset is invariant, it
5030doesn't matter if daylight time transition points change from year to year, or
5031if daylight time is skipped in some years; it doesn't matter how large or
5032small dst() may get within its bounds; and it doesn't even matter if some
5033perverse time zone returns a negative dst()). So a breaking case must be
5034pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
Tim Petersf3615152003-01-01 21:51:37 +00005035--------------------------------------------------------------------------- */