blob: c149d1cc601a17e2eefc9508fae4ecf4c6584b96 [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
11#include "datetime.h"
12
13/* We require that C int be at least 32 bits, and use int virtually
14 * everywhere. In just a few cases we use a temp long, where a Python
15 * API returns a C long. In such cases, we have to ensure that the
16 * final result fits in a C int (this can be an issue on 64-bit boxes).
17 */
18#if SIZEOF_INT < 4
19# error "datetime.c requires that C int have at least 32 bits"
20#endif
21
22#define MINYEAR 1
23#define MAXYEAR 9999
24
25/* Nine decimal digits is easy to communicate, and leaves enough room
26 * so that two delta days can be added w/o fear of overflowing a signed
27 * 32-bit int, and with plenty of room left over to absorb any possible
28 * carries from adding seconds.
29 */
30#define MAX_DELTA_DAYS 999999999
31
32/* Rename the long macros in datetime.h to more reasonable short names. */
33#define GET_YEAR PyDateTime_GET_YEAR
34#define GET_MONTH PyDateTime_GET_MONTH
35#define GET_DAY PyDateTime_GET_DAY
36#define DATE_GET_HOUR PyDateTime_DATE_GET_HOUR
37#define DATE_GET_MINUTE PyDateTime_DATE_GET_MINUTE
38#define DATE_GET_SECOND PyDateTime_DATE_GET_SECOND
39#define DATE_GET_MICROSECOND PyDateTime_DATE_GET_MICROSECOND
40
41/* Date accessors for date and datetime. */
42#define SET_YEAR(o, v) (((o)->data[0] = ((v) & 0xff00) >> 8), \
43 ((o)->data[1] = ((v) & 0x00ff)))
44#define SET_MONTH(o, v) (PyDateTime_GET_MONTH(o) = (v))
45#define SET_DAY(o, v) (PyDateTime_GET_DAY(o) = (v))
46
47/* Date/Time accessors for datetime. */
48#define DATE_SET_HOUR(o, v) (PyDateTime_DATE_GET_HOUR(o) = (v))
49#define DATE_SET_MINUTE(o, v) (PyDateTime_DATE_GET_MINUTE(o) = (v))
50#define DATE_SET_SECOND(o, v) (PyDateTime_DATE_GET_SECOND(o) = (v))
51#define DATE_SET_MICROSECOND(o, v) \
52 (((o)->data[7] = ((v) & 0xff0000) >> 16), \
53 ((o)->data[8] = ((v) & 0x00ff00) >> 8), \
54 ((o)->data[9] = ((v) & 0x0000ff)))
55
56/* Time accessors for time. */
57#define TIME_GET_HOUR PyDateTime_TIME_GET_HOUR
58#define TIME_GET_MINUTE PyDateTime_TIME_GET_MINUTE
59#define TIME_GET_SECOND PyDateTime_TIME_GET_SECOND
60#define TIME_GET_MICROSECOND PyDateTime_TIME_GET_MICROSECOND
61#define TIME_SET_HOUR(o, v) (PyDateTime_TIME_GET_HOUR(o) = (v))
62#define TIME_SET_MINUTE(o, v) (PyDateTime_TIME_GET_MINUTE(o) = (v))
63#define TIME_SET_SECOND(o, v) (PyDateTime_TIME_GET_SECOND(o) = (v))
64#define TIME_SET_MICROSECOND(o, v) \
65 (((o)->data[3] = ((v) & 0xff0000) >> 16), \
66 ((o)->data[4] = ((v) & 0x00ff00) >> 8), \
67 ((o)->data[5] = ((v) & 0x0000ff)))
68
69/* Delta accessors for timedelta. */
70#define GET_TD_DAYS(o) (((PyDateTime_Delta *)(o))->days)
71#define GET_TD_SECONDS(o) (((PyDateTime_Delta *)(o))->seconds)
72#define GET_TD_MICROSECONDS(o) (((PyDateTime_Delta *)(o))->microseconds)
73
74#define SET_TD_DAYS(o, v) ((o)->days = (v))
75#define SET_TD_SECONDS(o, v) ((o)->seconds = (v))
76#define SET_TD_MICROSECONDS(o, v) ((o)->microseconds = (v))
77
Tim Petersa032d2e2003-01-11 00:15:54 +000078/* p is a pointer to a time or a datetime object; HASTZINFO(p) returns
79 * p->hastzinfo.
80 */
81#define HASTZINFO(p) (((_PyDateTime_BaseTZInfo *)(p))->hastzinfo)
82
Tim Peters2a799bf2002-12-16 20:18:38 +000083/* Forward declarations. */
84static PyTypeObject PyDateTime_DateType;
85static PyTypeObject PyDateTime_DateTimeType;
Tim Peters2a799bf2002-12-16 20:18:38 +000086static PyTypeObject PyDateTime_DeltaType;
87static PyTypeObject PyDateTime_TimeType;
88static PyTypeObject PyDateTime_TZInfoType;
Tim Peters2a799bf2002-12-16 20:18:38 +000089
90/* ---------------------------------------------------------------------------
91 * Math utilities.
92 */
93
94/* k = i+j overflows iff k differs in sign from both inputs,
95 * iff k^i has sign bit set and k^j has sign bit set,
96 * iff (k^i)&(k^j) has sign bit set.
97 */
98#define SIGNED_ADD_OVERFLOWED(RESULT, I, J) \
99 ((((RESULT) ^ (I)) & ((RESULT) ^ (J))) < 0)
100
101/* Compute Python divmod(x, y), returning the quotient and storing the
102 * remainder into *r. The quotient is the floor of x/y, and that's
103 * the real point of this. C will probably truncate instead (C99
104 * requires truncation; C89 left it implementation-defined).
105 * Simplification: we *require* that y > 0 here. That's appropriate
106 * for all the uses made of it. This simplifies the code and makes
107 * the overflow case impossible (divmod(LONG_MIN, -1) is the only
108 * overflow case).
109 */
110static int
111divmod(int x, int y, int *r)
112{
113 int quo;
114
115 assert(y > 0);
116 quo = x / y;
117 *r = x - quo * y;
118 if (*r < 0) {
119 --quo;
120 *r += y;
121 }
122 assert(0 <= *r && *r < y);
123 return quo;
124}
125
Tim Peters5d644dd2003-01-02 16:32:54 +0000126/* Round a double to the nearest long. |x| must be small enough to fit
127 * in a C long; this is not checked.
128 */
129static long
130round_to_long(double x)
131{
132 if (x >= 0.0)
133 x = floor(x + 0.5);
134 else
135 x = ceil(x - 0.5);
136 return (long)x;
137}
138
Tim Peters2a799bf2002-12-16 20:18:38 +0000139/* ---------------------------------------------------------------------------
140 * General calendrical helper functions
141 */
142
143/* For each month ordinal in 1..12, the number of days in that month,
144 * and the number of days before that month in the same year. These
145 * are correct for non-leap years only.
146 */
147static int _days_in_month[] = {
148 0, /* unused; this vector uses 1-based indexing */
149 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
150};
151
152static int _days_before_month[] = {
153 0, /* unused; this vector uses 1-based indexing */
154 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
155};
156
157/* year -> 1 if leap year, else 0. */
158static int
159is_leap(int year)
160{
161 /* Cast year to unsigned. The result is the same either way, but
162 * C can generate faster code for unsigned mod than for signed
163 * mod (especially for % 4 -- a good compiler should just grab
164 * the last 2 bits when the LHS is unsigned).
165 */
166 const unsigned int ayear = (unsigned int)year;
167 return ayear % 4 == 0 && (ayear % 100 != 0 || ayear % 400 == 0);
168}
169
170/* year, month -> number of days in that month in that year */
171static int
172days_in_month(int year, int month)
173{
174 assert(month >= 1);
175 assert(month <= 12);
176 if (month == 2 && is_leap(year))
177 return 29;
178 else
179 return _days_in_month[month];
180}
181
182/* year, month -> number of days in year preceeding first day of month */
183static int
184days_before_month(int year, int month)
185{
186 int days;
187
188 assert(month >= 1);
189 assert(month <= 12);
190 days = _days_before_month[month];
191 if (month > 2 && is_leap(year))
192 ++days;
193 return days;
194}
195
196/* year -> number of days before January 1st of year. Remember that we
197 * start with year 1, so days_before_year(1) == 0.
198 */
199static int
200days_before_year(int year)
201{
202 int y = year - 1;
203 /* This is incorrect if year <= 0; we really want the floor
204 * here. But so long as MINYEAR is 1, the smallest year this
205 * can see is 0 (this can happen in some normalization endcases),
206 * so we'll just special-case that.
207 */
208 assert (year >= 0);
209 if (y >= 0)
210 return y*365 + y/4 - y/100 + y/400;
211 else {
212 assert(y == -1);
213 return -366;
214 }
215}
216
217/* Number of days in 4, 100, and 400 year cycles. That these have
218 * the correct values is asserted in the module init function.
219 */
220#define DI4Y 1461 /* days_before_year(5); days in 4 years */
221#define DI100Y 36524 /* days_before_year(101); days in 100 years */
222#define DI400Y 146097 /* days_before_year(401); days in 400 years */
223
224/* ordinal -> year, month, day, considering 01-Jan-0001 as day 1. */
225static void
226ord_to_ymd(int ordinal, int *year, int *month, int *day)
227{
228 int n, n1, n4, n100, n400, leapyear, preceding;
229
230 /* ordinal is a 1-based index, starting at 1-Jan-1. The pattern of
231 * leap years repeats exactly every 400 years. The basic strategy is
232 * to find the closest 400-year boundary at or before ordinal, then
233 * work with the offset from that boundary to ordinal. Life is much
234 * clearer if we subtract 1 from ordinal first -- then the values
235 * of ordinal at 400-year boundaries are exactly those divisible
236 * by DI400Y:
237 *
238 * D M Y n n-1
239 * -- --- ---- ---------- ----------------
240 * 31 Dec -400 -DI400Y -DI400Y -1
241 * 1 Jan -399 -DI400Y +1 -DI400Y 400-year boundary
242 * ...
243 * 30 Dec 000 -1 -2
244 * 31 Dec 000 0 -1
245 * 1 Jan 001 1 0 400-year boundary
246 * 2 Jan 001 2 1
247 * 3 Jan 001 3 2
248 * ...
249 * 31 Dec 400 DI400Y DI400Y -1
250 * 1 Jan 401 DI400Y +1 DI400Y 400-year boundary
251 */
252 assert(ordinal >= 1);
253 --ordinal;
254 n400 = ordinal / DI400Y;
255 n = ordinal % DI400Y;
256 *year = n400 * 400 + 1;
257
258 /* Now n is the (non-negative) offset, in days, from January 1 of
259 * year, to the desired date. Now compute how many 100-year cycles
260 * precede n.
261 * Note that it's possible for n100 to equal 4! In that case 4 full
262 * 100-year cycles precede the desired day, which implies the
263 * desired day is December 31 at the end of a 400-year cycle.
264 */
265 n100 = n / DI100Y;
266 n = n % DI100Y;
267
268 /* Now compute how many 4-year cycles precede it. */
269 n4 = n / DI4Y;
270 n = n % DI4Y;
271
272 /* And now how many single years. Again n1 can be 4, and again
273 * meaning that the desired day is December 31 at the end of the
274 * 4-year cycle.
275 */
276 n1 = n / 365;
277 n = n % 365;
278
279 *year += n100 * 100 + n4 * 4 + n1;
280 if (n1 == 4 || n100 == 4) {
281 assert(n == 0);
282 *year -= 1;
283 *month = 12;
284 *day = 31;
285 return;
286 }
287
288 /* Now the year is correct, and n is the offset from January 1. We
289 * find the month via an estimate that's either exact or one too
290 * large.
291 */
292 leapyear = n1 == 3 && (n4 != 24 || n100 == 3);
293 assert(leapyear == is_leap(*year));
294 *month = (n + 50) >> 5;
295 preceding = (_days_before_month[*month] + (*month > 2 && leapyear));
296 if (preceding > n) {
297 /* estimate is too large */
298 *month -= 1;
299 preceding -= days_in_month(*year, *month);
300 }
301 n -= preceding;
302 assert(0 <= n);
303 assert(n < days_in_month(*year, *month));
304
305 *day = n + 1;
306}
307
308/* year, month, day -> ordinal, considering 01-Jan-0001 as day 1. */
309static int
310ymd_to_ord(int year, int month, int day)
311{
312 return days_before_year(year) + days_before_month(year, month) + day;
313}
314
315/* Day of week, where Monday==0, ..., Sunday==6. 1/1/1 was a Monday. */
316static int
317weekday(int year, int month, int day)
318{
319 return (ymd_to_ord(year, month, day) + 6) % 7;
320}
321
322/* Ordinal of the Monday starting week 1 of the ISO year. Week 1 is the
323 * first calendar week containing a Thursday.
324 */
325static int
326iso_week1_monday(int year)
327{
328 int first_day = ymd_to_ord(year, 1, 1); /* ord of 1/1 */
329 /* 0 if 1/1 is a Monday, 1 if a Tue, etc. */
330 int first_weekday = (first_day + 6) % 7;
331 /* ordinal of closest Monday at or before 1/1 */
332 int week1_monday = first_day - first_weekday;
333
334 if (first_weekday > 3) /* if 1/1 was Fri, Sat, Sun */
335 week1_monday += 7;
336 return week1_monday;
337}
338
339/* ---------------------------------------------------------------------------
340 * Range checkers.
341 */
342
343/* Check that -MAX_DELTA_DAYS <= days <= MAX_DELTA_DAYS. If so, return 0.
344 * If not, raise OverflowError and return -1.
345 */
346static int
347check_delta_day_range(int days)
348{
349 if (-MAX_DELTA_DAYS <= days && days <= MAX_DELTA_DAYS)
350 return 0;
351 PyErr_Format(PyExc_OverflowError,
352 "days=%d; must have magnitude <= %d",
Guido van Rossumbd43e912002-12-16 20:34:55 +0000353 days, MAX_DELTA_DAYS);
Tim Peters2a799bf2002-12-16 20:18:38 +0000354 return -1;
355}
356
357/* Check that date arguments are in range. Return 0 if they are. If they
358 * aren't, raise ValueError and return -1.
359 */
360static int
361check_date_args(int year, int month, int day)
362{
363
364 if (year < MINYEAR || year > MAXYEAR) {
365 PyErr_SetString(PyExc_ValueError,
366 "year is out of range");
367 return -1;
368 }
369 if (month < 1 || month > 12) {
370 PyErr_SetString(PyExc_ValueError,
371 "month must be in 1..12");
372 return -1;
373 }
374 if (day < 1 || day > days_in_month(year, month)) {
375 PyErr_SetString(PyExc_ValueError,
376 "day is out of range for month");
377 return -1;
378 }
379 return 0;
380}
381
382/* Check that time arguments are in range. Return 0 if they are. If they
383 * aren't, raise ValueError and return -1.
384 */
385static int
386check_time_args(int h, int m, int s, int us)
387{
388 if (h < 0 || h > 23) {
389 PyErr_SetString(PyExc_ValueError,
390 "hour must be in 0..23");
391 return -1;
392 }
393 if (m < 0 || m > 59) {
394 PyErr_SetString(PyExc_ValueError,
395 "minute must be in 0..59");
396 return -1;
397 }
398 if (s < 0 || s > 59) {
399 PyErr_SetString(PyExc_ValueError,
400 "second must be in 0..59");
401 return -1;
402 }
403 if (us < 0 || us > 999999) {
404 PyErr_SetString(PyExc_ValueError,
405 "microsecond must be in 0..999999");
406 return -1;
407 }
408 return 0;
409}
410
411/* ---------------------------------------------------------------------------
412 * Normalization utilities.
413 */
414
415/* One step of a mixed-radix conversion. A "hi" unit is equivalent to
416 * factor "lo" units. factor must be > 0. If *lo is less than 0, or
417 * at least factor, enough of *lo is converted into "hi" units so that
418 * 0 <= *lo < factor. The input values must be such that int overflow
419 * is impossible.
420 */
421static void
422normalize_pair(int *hi, int *lo, int factor)
423{
424 assert(factor > 0);
425 assert(lo != hi);
426 if (*lo < 0 || *lo >= factor) {
427 const int num_hi = divmod(*lo, factor, lo);
428 const int new_hi = *hi + num_hi;
429 assert(! SIGNED_ADD_OVERFLOWED(new_hi, *hi, num_hi));
430 *hi = new_hi;
431 }
432 assert(0 <= *lo && *lo < factor);
433}
434
435/* Fiddle days (d), seconds (s), and microseconds (us) so that
436 * 0 <= *s < 24*3600
437 * 0 <= *us < 1000000
438 * The input values must be such that the internals don't overflow.
439 * The way this routine is used, we don't get close.
440 */
441static void
442normalize_d_s_us(int *d, int *s, int *us)
443{
444 if (*us < 0 || *us >= 1000000) {
445 normalize_pair(s, us, 1000000);
446 /* |s| can't be bigger than about
447 * |original s| + |original us|/1000000 now.
448 */
449
450 }
451 if (*s < 0 || *s >= 24*3600) {
452 normalize_pair(d, s, 24*3600);
453 /* |d| can't be bigger than about
454 * |original d| +
455 * (|original s| + |original us|/1000000) / (24*3600) now.
456 */
457 }
458 assert(0 <= *s && *s < 24*3600);
459 assert(0 <= *us && *us < 1000000);
460}
461
462/* Fiddle years (y), months (m), and days (d) so that
463 * 1 <= *m <= 12
464 * 1 <= *d <= days_in_month(*y, *m)
465 * The input values must be such that the internals don't overflow.
466 * The way this routine is used, we don't get close.
467 */
468static void
469normalize_y_m_d(int *y, int *m, int *d)
470{
471 int dim; /* # of days in month */
472
473 /* This gets muddy: the proper range for day can't be determined
474 * without knowing the correct month and year, but if day is, e.g.,
475 * plus or minus a million, the current month and year values make
476 * no sense (and may also be out of bounds themselves).
477 * Saying 12 months == 1 year should be non-controversial.
478 */
479 if (*m < 1 || *m > 12) {
480 --*m;
481 normalize_pair(y, m, 12);
482 ++*m;
483 /* |y| can't be bigger than about
484 * |original y| + |original m|/12 now.
485 */
486 }
487 assert(1 <= *m && *m <= 12);
488
489 /* Now only day can be out of bounds (year may also be out of bounds
490 * for a datetime object, but we don't care about that here).
491 * If day is out of bounds, what to do is arguable, but at least the
492 * method here is principled and explainable.
493 */
494 dim = days_in_month(*y, *m);
495 if (*d < 1 || *d > dim) {
496 /* Move day-1 days from the first of the month. First try to
497 * get off cheap if we're only one day out of range
498 * (adjustments for timezone alone can't be worse than that).
499 */
500 if (*d == 0) {
501 --*m;
502 if (*m > 0)
503 *d = days_in_month(*y, *m);
504 else {
505 --*y;
506 *m = 12;
507 *d = 31;
508 }
509 }
510 else if (*d == dim + 1) {
511 /* move forward a day */
512 ++*m;
513 *d = 1;
514 if (*m > 12) {
515 *m = 1;
516 ++*y;
517 }
518 }
519 else {
520 int ordinal = ymd_to_ord(*y, *m, 1) +
521 *d - 1;
522 ord_to_ymd(ordinal, y, m, d);
523 }
524 }
525 assert(*m > 0);
526 assert(*d > 0);
527}
528
529/* Fiddle out-of-bounds months and days so that the result makes some kind
530 * of sense. The parameters are both inputs and outputs. Returns < 0 on
531 * failure, where failure means the adjusted year is out of bounds.
532 */
533static int
534normalize_date(int *year, int *month, int *day)
535{
536 int result;
537
538 normalize_y_m_d(year, month, day);
539 if (MINYEAR <= *year && *year <= MAXYEAR)
540 result = 0;
541 else {
542 PyErr_SetString(PyExc_OverflowError,
543 "date value out of range");
544 result = -1;
545 }
546 return result;
547}
548
549/* Force all the datetime fields into range. The parameters are both
550 * inputs and outputs. Returns < 0 on error.
551 */
552static int
553normalize_datetime(int *year, int *month, int *day,
554 int *hour, int *minute, int *second,
555 int *microsecond)
556{
557 normalize_pair(second, microsecond, 1000000);
558 normalize_pair(minute, second, 60);
559 normalize_pair(hour, minute, 60);
560 normalize_pair(day, hour, 24);
561 return normalize_date(year, month, day);
562}
563
564/* ---------------------------------------------------------------------------
565 * tzinfo helpers.
566 */
567
Tim Peters855fe882002-12-22 03:43:39 +0000568/* Ensure that p is None or of a tzinfo subclass. Return 0 if OK; if not
569 * raise TypeError and return -1.
570 */
571static int
572check_tzinfo_subclass(PyObject *p)
573{
574 if (p == Py_None || PyTZInfo_Check(p))
575 return 0;
576 PyErr_Format(PyExc_TypeError,
577 "tzinfo argument must be None or of a tzinfo subclass, "
578 "not type '%s'",
579 p->ob_type->tp_name);
580 return -1;
581}
582
Tim Petersbad8ff02002-12-30 20:52:32 +0000583/* Return tzinfo.methname(tzinfoarg), without any checking of results.
Tim Peters855fe882002-12-22 03:43:39 +0000584 * If tzinfo is None, returns None.
585 */
586static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000587call_tzinfo_method(PyObject *tzinfo, char *methname, PyObject *tzinfoarg)
Tim Peters855fe882002-12-22 03:43:39 +0000588{
589 PyObject *result;
590
Tim Petersbad8ff02002-12-30 20:52:32 +0000591 assert(tzinfo && methname && tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000592 assert(check_tzinfo_subclass(tzinfo) >= 0);
593 if (tzinfo == Py_None) {
594 result = Py_None;
595 Py_INCREF(result);
596 }
597 else
Tim Petersbad8ff02002-12-30 20:52:32 +0000598 result = PyObject_CallMethod(tzinfo, methname, "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000599 return result;
600}
601
Tim Peters2a799bf2002-12-16 20:18:38 +0000602/* If self has a tzinfo member, return a BORROWED reference to it. Else
603 * return NULL, which is NOT AN ERROR. There are no error returns here,
604 * and the caller must not decref the result.
605 */
606static PyObject *
607get_tzinfo_member(PyObject *self)
608{
609 PyObject *tzinfo = NULL;
610
Tim Petersa9bc1682003-01-11 03:39:11 +0000611 if (PyDateTime_Check(self) && HASTZINFO(self))
612 tzinfo = ((PyDateTime_DateTime *)self)->tzinfo;
Tim Petersa032d2e2003-01-11 00:15:54 +0000613 else if (PyTime_Check(self) && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +0000614 tzinfo = ((PyDateTime_Time *)self)->tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000615
616 return tzinfo;
617}
618
Tim Petersbad8ff02002-12-30 20:52:32 +0000619/* Call getattr(tzinfo, name)(tzinfoarg), and extract an int from the
Tim Peters2a799bf2002-12-16 20:18:38 +0000620 * result. tzinfo must be an instance of the tzinfo class. If the method
621 * returns None, this returns 0 and sets *none to 1. If the method doesn't
Tim Peters397301e2003-01-02 21:28:08 +0000622 * return None or timedelta, TypeError is raised and this returns -1. If it
623 * returnsa timedelta and the value is out of range or isn't a whole number
624 * of minutes, ValueError is raised and this returns -1.
Tim Peters2a799bf2002-12-16 20:18:38 +0000625 * Else *none is set to 0 and the integer method result is returned.
626 */
627static int
628call_utc_tzinfo_method(PyObject *tzinfo, char *name, PyObject *tzinfoarg,
629 int *none)
630{
631 PyObject *u;
Tim Peters397301e2003-01-02 21:28:08 +0000632 int result = -1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000633
634 assert(tzinfo != NULL);
635 assert(PyTZInfo_Check(tzinfo));
636 assert(tzinfoarg != NULL);
637
638 *none = 0;
Tim Petersbad8ff02002-12-30 20:52:32 +0000639 u = call_tzinfo_method(tzinfo, name, tzinfoarg);
Tim Peters2a799bf2002-12-16 20:18:38 +0000640 if (u == NULL)
641 return -1;
642
Tim Peters27362852002-12-23 16:17:39 +0000643 else if (u == Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +0000644 result = 0;
645 *none = 1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000646 }
Tim Peters855fe882002-12-22 03:43:39 +0000647 else if (PyDelta_Check(u)) {
648 const int days = GET_TD_DAYS(u);
649 if (days < -1 || days > 0)
650 result = 24*60; /* trigger ValueError below */
651 else {
652 /* next line can't overflow because we know days
653 * is -1 or 0 now
654 */
655 int ss = days * 24 * 3600 + GET_TD_SECONDS(u);
656 result = divmod(ss, 60, &ss);
657 if (ss || GET_TD_MICROSECONDS(u)) {
658 PyErr_Format(PyExc_ValueError,
659 "tzinfo.%s() must return a "
660 "whole number of minutes",
661 name);
662 result = -1;
Tim Peters855fe882002-12-22 03:43:39 +0000663 }
664 }
665 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000666 else {
667 PyErr_Format(PyExc_TypeError,
Tim Peters397301e2003-01-02 21:28:08 +0000668 "tzinfo.%s() must return None or "
Tim Peters855fe882002-12-22 03:43:39 +0000669 "timedelta, not '%s'",
670 name, u->ob_type->tp_name);
Tim Peters2a799bf2002-12-16 20:18:38 +0000671 }
672
Tim Peters2a799bf2002-12-16 20:18:38 +0000673 Py_DECREF(u);
674 if (result < -1439 || result > 1439) {
675 PyErr_Format(PyExc_ValueError,
Neal Norwitz506a2242003-01-04 01:02:25 +0000676 "tzinfo.%s() returned %d; must be in "
Tim Peters2a799bf2002-12-16 20:18:38 +0000677 "-1439 .. 1439",
678 name, result);
679 result = -1;
680 }
Tim Peters397301e2003-01-02 21:28:08 +0000681 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +0000682}
683
684/* Call tzinfo.utcoffset(tzinfoarg), and extract an integer from the
685 * result. tzinfo must be an instance of the tzinfo class. If utcoffset()
686 * returns None, call_utcoffset returns 0 and sets *none to 1. If uctoffset()
Tim Peters397301e2003-01-02 21:28:08 +0000687 * doesn't return None or timedelta, TypeError is raised and this returns -1.
688 * If utcoffset() returns an invalid timedelta (out of range, or not a whole
689 * # of minutes), ValueError is raised and this returns -1. Else *none is
690 * set to 0 and the offset is returned (as int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000691 */
692static int
693call_utcoffset(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
694{
695 return call_utc_tzinfo_method(tzinfo, "utcoffset", tzinfoarg, none);
696}
697
Tim Peters855fe882002-12-22 03:43:39 +0000698static PyObject *new_delta(int d, int sec, int usec, int normalize);
699
Tim Petersbad8ff02002-12-30 20:52:32 +0000700/* Call tzinfo.name(tzinfoarg), and return the offset as a timedelta or None.
701 */
Tim Peters855fe882002-12-22 03:43:39 +0000702static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000703offset_as_timedelta(PyObject *tzinfo, char *name, PyObject *tzinfoarg) {
Tim Peters855fe882002-12-22 03:43:39 +0000704 PyObject *result;
705
Tim Petersbad8ff02002-12-30 20:52:32 +0000706 assert(tzinfo && name && tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000707 if (tzinfo == Py_None) {
708 result = Py_None;
709 Py_INCREF(result);
710 }
711 else {
712 int none;
Tim Petersbad8ff02002-12-30 20:52:32 +0000713 int offset = call_utc_tzinfo_method(tzinfo, name, tzinfoarg,
714 &none);
Tim Peters855fe882002-12-22 03:43:39 +0000715 if (offset < 0 && PyErr_Occurred())
716 return NULL;
717 if (none) {
718 result = Py_None;
719 Py_INCREF(result);
720 }
721 else
722 result = new_delta(0, offset * 60, 0, 1);
723 }
724 return result;
725}
726
Tim Peters2a799bf2002-12-16 20:18:38 +0000727/* Call tzinfo.dst(tzinfoarg), and extract an integer from the
728 * result. tzinfo must be an instance of the tzinfo class. If dst()
729 * returns None, call_dst returns 0 and sets *none to 1. If dst()
Tim Peters397301e2003-01-02 21:28:08 +0000730 & doesn't return None or timedelta, TypeError is raised and this
731 * returns -1. If dst() returns an invalid timedelta for for a UTC offset,
732 * ValueError is raised and this returns -1. Else *none is set to 0 and
733 * the offset is returned (as an int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000734 */
735static int
736call_dst(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
737{
738 return call_utc_tzinfo_method(tzinfo, "dst", tzinfoarg, none);
739}
740
Tim Petersbad8ff02002-12-30 20:52:32 +0000741/* Call tzinfo.tzname(tzinfoarg), and return the result. tzinfo must be
Tim Peters855fe882002-12-22 03:43:39 +0000742 * an instance of the tzinfo class or None. If tzinfo isn't None, and
Tim Petersbad8ff02002-12-30 20:52:32 +0000743 * tzname() doesn't return None or a string, TypeError is raised and this
Tim Peters855fe882002-12-22 03:43:39 +0000744 * returns NULL.
Tim Peters2a799bf2002-12-16 20:18:38 +0000745 */
746static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000747call_tzname(PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +0000748{
749 PyObject *result;
750
751 assert(tzinfo != NULL);
Tim Peters855fe882002-12-22 03:43:39 +0000752 assert(check_tzinfo_subclass(tzinfo) >= 0);
Tim Petersbad8ff02002-12-30 20:52:32 +0000753 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000754
Tim Peters855fe882002-12-22 03:43:39 +0000755 if (tzinfo == Py_None) {
756 result = Py_None;
757 Py_INCREF(result);
758 }
759 else
Tim Petersbad8ff02002-12-30 20:52:32 +0000760 result = PyObject_CallMethod(tzinfo, "tzname", "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000761
762 if (result != NULL && result != Py_None && ! PyString_Check(result)) {
763 PyErr_Format(PyExc_TypeError, "tzinfo.tzname() must "
Tim Peters2a799bf2002-12-16 20:18:38 +0000764 "return None or a string, not '%s'",
765 result->ob_type->tp_name);
766 Py_DECREF(result);
767 result = NULL;
768 }
769 return result;
770}
771
772typedef enum {
773 /* an exception has been set; the caller should pass it on */
774 OFFSET_ERROR,
775
Tim Petersa9bc1682003-01-11 03:39:11 +0000776 /* type isn't date, datetime, or time subclass */
Tim Peters2a799bf2002-12-16 20:18:38 +0000777 OFFSET_UNKNOWN,
778
779 /* date,
Tim Petersa9bc1682003-01-11 03:39:11 +0000780 * datetime with !hastzinfo
781 * datetime with None tzinfo,
782 * datetime where utcoffset() returns None
Tim Peters37f39822003-01-10 03:49:02 +0000783 * time with !hastzinfo
784 * time with None tzinfo,
785 * time where utcoffset() returns None
Tim Peters2a799bf2002-12-16 20:18:38 +0000786 */
787 OFFSET_NAIVE,
788
Tim Petersa9bc1682003-01-11 03:39:11 +0000789 /* time or datetime where utcoffset() doesn't return None */
Tim Peters2a799bf2002-12-16 20:18:38 +0000790 OFFSET_AWARE,
791} naivety;
792
Tim Peters14b69412002-12-22 18:10:22 +0000793/* Classify an object as to whether it's naive or offset-aware. See
Tim Peters2a799bf2002-12-16 20:18:38 +0000794 * the "naivety" typedef for details. If the type is aware, *offset is set
795 * to minutes east of UTC (as returned by the tzinfo.utcoffset() method).
Tim Peters14b69412002-12-22 18:10:22 +0000796 * If the type is offset-naive (or unknown, or error), *offset is set to 0.
Tim Peterse39a80c2002-12-30 21:28:52 +0000797 * tzinfoarg is the argument to pass to the tzinfo.utcoffset() method.
Tim Peters2a799bf2002-12-16 20:18:38 +0000798 */
799static naivety
Tim Peterse39a80c2002-12-30 21:28:52 +0000800classify_utcoffset(PyObject *op, PyObject *tzinfoarg, int *offset)
Tim Peters2a799bf2002-12-16 20:18:38 +0000801{
802 int none;
803 PyObject *tzinfo;
804
Tim Peterse39a80c2002-12-30 21:28:52 +0000805 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000806 *offset = 0;
Tim Peters14b69412002-12-22 18:10:22 +0000807 tzinfo = get_tzinfo_member(op); /* NULL means no tzinfo, not error */
Tim Peters2a799bf2002-12-16 20:18:38 +0000808 if (tzinfo == Py_None)
809 return OFFSET_NAIVE;
Tim Peters14b69412002-12-22 18:10:22 +0000810 if (tzinfo == NULL) {
811 /* note that a datetime passes the PyDate_Check test */
812 return (PyTime_Check(op) || PyDate_Check(op)) ?
813 OFFSET_NAIVE : OFFSET_UNKNOWN;
814 }
Tim Peterse39a80c2002-12-30 21:28:52 +0000815 *offset = call_utcoffset(tzinfo, tzinfoarg, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +0000816 if (*offset == -1 && PyErr_Occurred())
817 return OFFSET_ERROR;
818 return none ? OFFSET_NAIVE : OFFSET_AWARE;
819}
820
Tim Peters00237032002-12-27 02:21:51 +0000821/* Classify two objects as to whether they're naive or offset-aware.
822 * This isn't quite the same as calling classify_utcoffset() twice: for
823 * binary operations (comparison and subtraction), we generally want to
824 * ignore the tzinfo members if they're identical. This is by design,
825 * so that results match "naive" expectations when mixing objects from a
826 * single timezone. So in that case, this sets both offsets to 0 and
827 * both naiveties to OFFSET_NAIVE.
828 * The function returns 0 if everything's OK, and -1 on error.
829 */
830static int
831classify_two_utcoffsets(PyObject *o1, int *offset1, naivety *n1,
Tim Peterse39a80c2002-12-30 21:28:52 +0000832 PyObject *tzinfoarg1,
833 PyObject *o2, int *offset2, naivety *n2,
834 PyObject *tzinfoarg2)
Tim Peters00237032002-12-27 02:21:51 +0000835{
836 if (get_tzinfo_member(o1) == get_tzinfo_member(o2)) {
837 *offset1 = *offset2 = 0;
838 *n1 = *n2 = OFFSET_NAIVE;
839 }
840 else {
Tim Peterse39a80c2002-12-30 21:28:52 +0000841 *n1 = classify_utcoffset(o1, tzinfoarg1, offset1);
Tim Peters00237032002-12-27 02:21:51 +0000842 if (*n1 == OFFSET_ERROR)
843 return -1;
Tim Peterse39a80c2002-12-30 21:28:52 +0000844 *n2 = classify_utcoffset(o2, tzinfoarg2, offset2);
Tim Peters00237032002-12-27 02:21:51 +0000845 if (*n2 == OFFSET_ERROR)
846 return -1;
847 }
848 return 0;
849}
850
Tim Peters2a799bf2002-12-16 20:18:38 +0000851/* repr is like "someclass(arg1, arg2)". If tzinfo isn't None,
852 * stuff
853 * ", tzinfo=" + repr(tzinfo)
854 * before the closing ")".
855 */
856static PyObject *
857append_keyword_tzinfo(PyObject *repr, PyObject *tzinfo)
858{
859 PyObject *temp;
860
861 assert(PyString_Check(repr));
862 assert(tzinfo);
863 if (tzinfo == Py_None)
864 return repr;
865 /* Get rid of the trailing ')'. */
866 assert(PyString_AsString(repr)[PyString_Size(repr)-1] == ')');
867 temp = PyString_FromStringAndSize(PyString_AsString(repr),
868 PyString_Size(repr) - 1);
869 Py_DECREF(repr);
870 if (temp == NULL)
871 return NULL;
872 repr = temp;
873
874 /* Append ", tzinfo=". */
875 PyString_ConcatAndDel(&repr, PyString_FromString(", tzinfo="));
876
877 /* Append repr(tzinfo). */
878 PyString_ConcatAndDel(&repr, PyObject_Repr(tzinfo));
879
880 /* Add a closing paren. */
881 PyString_ConcatAndDel(&repr, PyString_FromString(")"));
882 return repr;
883}
884
885/* ---------------------------------------------------------------------------
886 * String format helpers.
887 */
888
889static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +0000890format_ctime(PyDateTime_Date *date, int hours, int minutes, int seconds)
Tim Peters2a799bf2002-12-16 20:18:38 +0000891{
892 static char *DayNames[] = {
893 "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"
894 };
895 static char *MonthNames[] = {
896 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
897 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
898 };
899
900 char buffer[128];
901 int wday = weekday(GET_YEAR(date), GET_MONTH(date), GET_DAY(date));
902
903 PyOS_snprintf(buffer, sizeof(buffer), "%s %s %2d %02d:%02d:%02d %04d",
904 DayNames[wday], MonthNames[GET_MONTH(date) - 1],
905 GET_DAY(date), hours, minutes, seconds,
906 GET_YEAR(date));
907 return PyString_FromString(buffer);
908}
909
910/* Add an hours & minutes UTC offset string to buf. buf has no more than
911 * buflen bytes remaining. The UTC offset is gotten by calling
912 * tzinfo.uctoffset(tzinfoarg). If that returns None, \0 is stored into
913 * *buf, and that's all. Else the returned value is checked for sanity (an
914 * integer in range), and if that's OK it's converted to an hours & minutes
915 * string of the form
916 * sign HH sep MM
917 * Returns 0 if everything is OK. If the return value from utcoffset() is
918 * bogus, an appropriate exception is set and -1 is returned.
919 */
920static int
Tim Peters328fff72002-12-20 01:31:27 +0000921format_utcoffset(char *buf, size_t buflen, const char *sep,
Tim Peters2a799bf2002-12-16 20:18:38 +0000922 PyObject *tzinfo, PyObject *tzinfoarg)
923{
924 int offset;
925 int hours;
926 int minutes;
927 char sign;
928 int none;
929
930 offset = call_utcoffset(tzinfo, tzinfoarg, &none);
931 if (offset == -1 && PyErr_Occurred())
932 return -1;
933 if (none) {
934 *buf = '\0';
935 return 0;
936 }
937 sign = '+';
938 if (offset < 0) {
939 sign = '-';
940 offset = - offset;
941 }
942 hours = divmod(offset, 60, &minutes);
943 PyOS_snprintf(buf, buflen, "%c%02d%s%02d", sign, hours, sep, minutes);
944 return 0;
945}
946
947/* I sure don't want to reproduce the strftime code from the time module,
948 * so this imports the module and calls it. All the hair is due to
949 * giving special meanings to the %z and %Z format codes via a preprocessing
950 * step on the format string.
Tim Petersbad8ff02002-12-30 20:52:32 +0000951 * tzinfoarg is the argument to pass to the object's tzinfo method, if
952 * needed.
Tim Peters2a799bf2002-12-16 20:18:38 +0000953 */
954static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000955wrap_strftime(PyObject *object, PyObject *format, PyObject *timetuple,
956 PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +0000957{
958 PyObject *result = NULL; /* guilty until proved innocent */
959
960 PyObject *zreplacement = NULL; /* py string, replacement for %z */
961 PyObject *Zreplacement = NULL; /* py string, replacement for %Z */
962
963 char *pin; /* pointer to next char in input format */
964 char ch; /* next char in input format */
965
966 PyObject *newfmt = NULL; /* py string, the output format */
967 char *pnew; /* pointer to available byte in output format */
968 char totalnew; /* number bytes total in output format buffer,
969 exclusive of trailing \0 */
970 char usednew; /* number bytes used so far in output format buffer */
971
972 char *ptoappend; /* pointer to string to append to output buffer */
973 int ntoappend; /* # of bytes to append to output buffer */
974
Tim Peters2a799bf2002-12-16 20:18:38 +0000975 assert(object && format && timetuple);
976 assert(PyString_Check(format));
977
Tim Petersd6844152002-12-22 20:58:42 +0000978 /* Give up if the year is before 1900.
979 * Python strftime() plays games with the year, and different
980 * games depending on whether envar PYTHON2K is set. This makes
981 * years before 1900 a nightmare, even if the platform strftime
982 * supports them (and not all do).
983 * We could get a lot farther here by avoiding Python's strftime
984 * wrapper and calling the C strftime() directly, but that isn't
985 * an option in the Python implementation of this module.
986 */
987 {
988 long year;
989 PyObject *pyyear = PySequence_GetItem(timetuple, 0);
990 if (pyyear == NULL) return NULL;
991 assert(PyInt_Check(pyyear));
992 year = PyInt_AsLong(pyyear);
993 Py_DECREF(pyyear);
994 if (year < 1900) {
995 PyErr_Format(PyExc_ValueError, "year=%ld is before "
996 "1900; the datetime strftime() "
997 "methods require year >= 1900",
998 year);
999 return NULL;
1000 }
1001 }
1002
Tim Peters2a799bf2002-12-16 20:18:38 +00001003 /* Scan the input format, looking for %z and %Z escapes, building
Tim Peters328fff72002-12-20 01:31:27 +00001004 * a new format. Since computing the replacements for those codes
1005 * is expensive, don't unless they're actually used.
Tim Peters2a799bf2002-12-16 20:18:38 +00001006 */
1007 totalnew = PyString_Size(format); /* realistic if no %z/%Z */
1008 newfmt = PyString_FromStringAndSize(NULL, totalnew);
1009 if (newfmt == NULL) goto Done;
1010 pnew = PyString_AsString(newfmt);
1011 usednew = 0;
1012
1013 pin = PyString_AsString(format);
1014 while ((ch = *pin++) != '\0') {
1015 if (ch != '%') {
Tim Peters328fff72002-12-20 01:31:27 +00001016 ptoappend = pin - 1;
Tim Peters2a799bf2002-12-16 20:18:38 +00001017 ntoappend = 1;
1018 }
1019 else if ((ch = *pin++) == '\0') {
1020 /* There's a lone trailing %; doesn't make sense. */
1021 PyErr_SetString(PyExc_ValueError, "strftime format "
1022 "ends with raw %");
1023 goto Done;
1024 }
1025 /* A % has been seen and ch is the character after it. */
1026 else if (ch == 'z') {
1027 if (zreplacement == NULL) {
1028 /* format utcoffset */
Tim Peters328fff72002-12-20 01:31:27 +00001029 char buf[100];
Tim Peters2a799bf2002-12-16 20:18:38 +00001030 PyObject *tzinfo = get_tzinfo_member(object);
1031 zreplacement = PyString_FromString("");
1032 if (zreplacement == NULL) goto Done;
1033 if (tzinfo != Py_None && tzinfo != NULL) {
Tim Petersbad8ff02002-12-30 20:52:32 +00001034 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001035 if (format_utcoffset(buf,
Tim Peters328fff72002-12-20 01:31:27 +00001036 sizeof(buf),
Tim Peters2a799bf2002-12-16 20:18:38 +00001037 "",
1038 tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00001039 tzinfoarg) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00001040 goto Done;
1041 Py_DECREF(zreplacement);
1042 zreplacement = PyString_FromString(buf);
1043 if (zreplacement == NULL) goto Done;
1044 }
1045 }
1046 assert(zreplacement != NULL);
1047 ptoappend = PyString_AsString(zreplacement);
1048 ntoappend = PyString_Size(zreplacement);
1049 }
1050 else if (ch == 'Z') {
1051 /* format tzname */
1052 if (Zreplacement == NULL) {
1053 PyObject *tzinfo = get_tzinfo_member(object);
1054 Zreplacement = PyString_FromString("");
1055 if (Zreplacement == NULL) goto Done;
1056 if (tzinfo != Py_None && tzinfo != NULL) {
Tim Petersbad8ff02002-12-30 20:52:32 +00001057 PyObject *temp;
1058 assert(tzinfoarg != NULL);
1059 temp = call_tzname(tzinfo, tzinfoarg);
Tim Peters2a799bf2002-12-16 20:18:38 +00001060 if (temp == NULL) goto Done;
1061 if (temp != Py_None) {
1062 assert(PyString_Check(temp));
1063 /* Since the tzname is getting
1064 * stuffed into the format, we
1065 * have to double any % signs
1066 * so that strftime doesn't
1067 * treat them as format codes.
1068 */
1069 Py_DECREF(Zreplacement);
1070 Zreplacement = PyObject_CallMethod(
1071 temp, "replace",
1072 "ss", "%", "%%");
1073 Py_DECREF(temp);
1074 if (Zreplacement == NULL)
1075 goto Done;
1076 }
1077 else
1078 Py_DECREF(temp);
1079 }
1080 }
1081 assert(Zreplacement != NULL);
1082 ptoappend = PyString_AsString(Zreplacement);
1083 ntoappend = PyString_Size(Zreplacement);
1084 }
1085 else {
Tim Peters328fff72002-12-20 01:31:27 +00001086 /* percent followed by neither z nor Z */
1087 ptoappend = pin - 2;
Tim Peters2a799bf2002-12-16 20:18:38 +00001088 ntoappend = 2;
1089 }
1090
1091 /* Append the ntoappend chars starting at ptoappend to
1092 * the new format.
1093 */
1094 assert(ntoappend >= 0);
1095 if (ntoappend == 0)
1096 continue;
1097 while (usednew + ntoappend > totalnew) {
1098 int bigger = totalnew << 1;
1099 if ((bigger >> 1) != totalnew) { /* overflow */
1100 PyErr_NoMemory();
1101 goto Done;
1102 }
1103 if (_PyString_Resize(&newfmt, bigger) < 0)
1104 goto Done;
1105 totalnew = bigger;
1106 pnew = PyString_AsString(newfmt) + usednew;
1107 }
1108 memcpy(pnew, ptoappend, ntoappend);
1109 pnew += ntoappend;
1110 usednew += ntoappend;
1111 assert(usednew <= totalnew);
1112 } /* end while() */
1113
1114 if (_PyString_Resize(&newfmt, usednew) < 0)
1115 goto Done;
1116 {
1117 PyObject *time = PyImport_ImportModule("time");
1118 if (time == NULL)
1119 goto Done;
1120 result = PyObject_CallMethod(time, "strftime", "OO",
1121 newfmt, timetuple);
1122 Py_DECREF(time);
1123 }
1124 Done:
1125 Py_XDECREF(zreplacement);
1126 Py_XDECREF(Zreplacement);
1127 Py_XDECREF(newfmt);
1128 return result;
1129}
1130
1131static char *
1132isoformat_date(PyDateTime_Date *dt, char buffer[], int bufflen)
1133{
1134 int x;
1135 x = PyOS_snprintf(buffer, bufflen,
1136 "%04d-%02d-%02d",
1137 GET_YEAR(dt), GET_MONTH(dt), GET_DAY(dt));
1138 return buffer + x;
1139}
1140
1141static void
1142isoformat_time(PyDateTime_DateTime *dt, char buffer[], int bufflen)
1143{
1144 int us = DATE_GET_MICROSECOND(dt);
1145
1146 PyOS_snprintf(buffer, bufflen,
1147 "%02d:%02d:%02d", /* 8 characters */
1148 DATE_GET_HOUR(dt),
1149 DATE_GET_MINUTE(dt),
1150 DATE_GET_SECOND(dt));
1151 if (us)
1152 PyOS_snprintf(buffer + 8, bufflen - 8, ".%06d", us);
1153}
1154
1155/* ---------------------------------------------------------------------------
1156 * Wrap functions from the time module. These aren't directly available
1157 * from C. Perhaps they should be.
1158 */
1159
1160/* Call time.time() and return its result (a Python float). */
1161static PyObject *
Guido van Rossumbd43e912002-12-16 20:34:55 +00001162time_time(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00001163{
1164 PyObject *result = NULL;
1165 PyObject *time = PyImport_ImportModule("time");
1166
1167 if (time != NULL) {
1168 result = PyObject_CallMethod(time, "time", "()");
1169 Py_DECREF(time);
1170 }
1171 return result;
1172}
1173
1174/* Build a time.struct_time. The weekday and day number are automatically
1175 * computed from the y,m,d args.
1176 */
1177static PyObject *
1178build_struct_time(int y, int m, int d, int hh, int mm, int ss, int dstflag)
1179{
1180 PyObject *time;
1181 PyObject *result = NULL;
1182
1183 time = PyImport_ImportModule("time");
1184 if (time != NULL) {
1185 result = PyObject_CallMethod(time, "struct_time",
1186 "((iiiiiiiii))",
1187 y, m, d,
1188 hh, mm, ss,
1189 weekday(y, m, d),
1190 days_before_month(y, m) + d,
1191 dstflag);
1192 Py_DECREF(time);
1193 }
1194 return result;
1195}
1196
1197/* ---------------------------------------------------------------------------
1198 * Miscellaneous helpers.
1199 */
1200
1201/* For obscure reasons, we need to use tp_richcompare instead of tp_compare.
1202 * The comparisons here all most naturally compute a cmp()-like result.
1203 * This little helper turns that into a bool result for rich comparisons.
1204 */
1205static PyObject *
1206diff_to_bool(int diff, int op)
1207{
1208 PyObject *result;
1209 int istrue;
1210
1211 switch (op) {
1212 case Py_EQ: istrue = diff == 0; break;
1213 case Py_NE: istrue = diff != 0; break;
1214 case Py_LE: istrue = diff <= 0; break;
1215 case Py_GE: istrue = diff >= 0; break;
1216 case Py_LT: istrue = diff < 0; break;
1217 case Py_GT: istrue = diff > 0; break;
1218 default:
1219 assert(! "op unknown");
1220 istrue = 0; /* To shut up compiler */
1221 }
1222 result = istrue ? Py_True : Py_False;
1223 Py_INCREF(result);
1224 return result;
1225}
1226
1227/* ---------------------------------------------------------------------------
1228 * Helpers for setting object fields. These work on pointers to the
1229 * appropriate base class.
1230 */
1231
Tim Petersa9bc1682003-01-11 03:39:11 +00001232/* For date and datetime. */
Tim Peters2a799bf2002-12-16 20:18:38 +00001233static void
1234set_date_fields(PyDateTime_Date *self, int y, int m, int d)
1235{
1236 self->hashcode = -1;
1237 SET_YEAR(self, y);
1238 SET_MONTH(self, m);
1239 SET_DAY(self, d);
1240}
1241
Tim Peters2a799bf2002-12-16 20:18:38 +00001242/* ---------------------------------------------------------------------------
1243 * Create various objects, mostly without range checking.
1244 */
1245
1246/* Create a date instance with no range checking. */
1247static PyObject *
1248new_date(int year, int month, int day)
1249{
1250 PyDateTime_Date *self;
1251
1252 self = PyObject_New(PyDateTime_Date, &PyDateTime_DateType);
1253 if (self != NULL)
1254 set_date_fields(self, year, month, day);
1255 return (PyObject *) self;
1256}
1257
1258/* Create a datetime instance with no range checking. */
1259static PyObject *
1260new_datetime(int year, int month, int day, int hour, int minute,
Tim Petersa9bc1682003-01-11 03:39:11 +00001261 int second, int usecond, PyObject *tzinfo)
Tim Peters2a799bf2002-12-16 20:18:38 +00001262{
1263 PyDateTime_DateTime *self;
Tim Petersa9bc1682003-01-11 03:39:11 +00001264 char aware = tzinfo != Py_None;
Tim Peters2a799bf2002-12-16 20:18:38 +00001265
Tim Petersa9bc1682003-01-11 03:39:11 +00001266 self = (PyDateTime_DateTime *)PyObject_MALLOC(aware ?
1267 sizeof(PyDateTime_DateTime) :
1268 sizeof(_PyDateTime_BaseDateTime));
1269 if (self == NULL)
1270 return PyErr_NoMemory();
1271 self->hastzinfo = aware;
1272 set_date_fields((PyDateTime_Date *)self, year, month, day);
1273 DATE_SET_HOUR(self, hour);
1274 DATE_SET_MINUTE(self, minute);
1275 DATE_SET_SECOND(self, second);
1276 DATE_SET_MICROSECOND(self, usecond);
1277 if (aware) {
Tim Peters2a799bf2002-12-16 20:18:38 +00001278 Py_INCREF(tzinfo);
1279 self->tzinfo = tzinfo;
1280 }
Tim Petersa9bc1682003-01-11 03:39:11 +00001281 return (PyObject *)PyObject_INIT(self, &PyDateTime_DateTimeType);
Tim Peters2a799bf2002-12-16 20:18:38 +00001282}
1283
1284/* Create a time instance with no range checking. */
1285static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00001286new_time(int hour, int minute, int second, int usecond, PyObject *tzinfo)
Tim Peters2a799bf2002-12-16 20:18:38 +00001287{
1288 PyDateTime_Time *self;
Tim Peters37f39822003-01-10 03:49:02 +00001289 char aware = tzinfo != Py_None;
Tim Peters2a799bf2002-12-16 20:18:38 +00001290
Tim Peters37f39822003-01-10 03:49:02 +00001291 self = (PyDateTime_Time *)PyObject_MALLOC(aware ?
1292 sizeof(PyDateTime_Time) :
1293 sizeof(_PyDateTime_BaseTime));
1294 if (self == NULL)
1295 return PyErr_NoMemory();
1296 self->hastzinfo = aware;
Tim Petersa9bc1682003-01-11 03:39:11 +00001297 self->hashcode = -1;
1298 TIME_SET_HOUR(self, hour);
1299 TIME_SET_MINUTE(self, minute);
1300 TIME_SET_SECOND(self, second);
1301 TIME_SET_MICROSECOND(self, usecond);
Tim Peters37f39822003-01-10 03:49:02 +00001302 if (aware) {
Tim Peters2a799bf2002-12-16 20:18:38 +00001303 Py_INCREF(tzinfo);
1304 self->tzinfo = tzinfo;
1305 }
Tim Peters37f39822003-01-10 03:49:02 +00001306 return (PyObject *)PyObject_INIT(self, &PyDateTime_TimeType);
Tim Peters2a799bf2002-12-16 20:18:38 +00001307}
1308
1309/* Create a timedelta instance. Normalize the members iff normalize is
1310 * true. Passing false is a speed optimization, if you know for sure
1311 * that seconds and microseconds are already in their proper ranges. In any
1312 * case, raises OverflowError and returns NULL if the normalized days is out
1313 * of range).
1314 */
1315static PyObject *
1316new_delta(int days, int seconds, int microseconds, int normalize)
1317{
1318 PyDateTime_Delta *self;
1319
1320 if (normalize)
1321 normalize_d_s_us(&days, &seconds, &microseconds);
1322 assert(0 <= seconds && seconds < 24*3600);
1323 assert(0 <= microseconds && microseconds < 1000000);
1324
1325 if (check_delta_day_range(days) < 0)
1326 return NULL;
1327
1328 self = PyObject_New(PyDateTime_Delta, &PyDateTime_DeltaType);
1329 if (self != NULL) {
1330 self->hashcode = -1;
1331 SET_TD_DAYS(self, days);
1332 SET_TD_SECONDS(self, seconds);
1333 SET_TD_MICROSECONDS(self, microseconds);
1334 }
1335 return (PyObject *) self;
1336}
1337
1338
1339/* ---------------------------------------------------------------------------
1340 * Cached Python objects; these are set by the module init function.
1341 */
1342
1343/* Conversion factors. */
1344static PyObject *us_per_us = NULL; /* 1 */
1345static PyObject *us_per_ms = NULL; /* 1000 */
1346static PyObject *us_per_second = NULL; /* 1000000 */
1347static PyObject *us_per_minute = NULL; /* 1e6 * 60 as Python int */
1348static PyObject *us_per_hour = NULL; /* 1e6 * 3600 as Python long */
1349static PyObject *us_per_day = NULL; /* 1e6 * 3600 * 24 as Python long */
1350static PyObject *us_per_week = NULL; /* 1e6*3600*24*7 as Python long */
1351static PyObject *seconds_per_day = NULL; /* 3600*24 as Python int */
1352
Tim Peters2a799bf2002-12-16 20:18:38 +00001353/* ---------------------------------------------------------------------------
1354 * Class implementations.
1355 */
1356
1357/*
1358 * PyDateTime_Delta implementation.
1359 */
1360
1361/* Convert a timedelta to a number of us,
1362 * (24*3600*self.days + self.seconds)*1000000 + self.microseconds
1363 * as a Python int or long.
1364 * Doing mixed-radix arithmetic by hand instead is excruciating in C,
1365 * due to ubiquitous overflow possibilities.
1366 */
1367static PyObject *
1368delta_to_microseconds(PyDateTime_Delta *self)
1369{
1370 PyObject *x1 = NULL;
1371 PyObject *x2 = NULL;
1372 PyObject *x3 = NULL;
1373 PyObject *result = NULL;
1374
1375 x1 = PyInt_FromLong(GET_TD_DAYS(self));
1376 if (x1 == NULL)
1377 goto Done;
1378 x2 = PyNumber_Multiply(x1, seconds_per_day); /* days in seconds */
1379 if (x2 == NULL)
1380 goto Done;
1381 Py_DECREF(x1);
1382 x1 = NULL;
1383
1384 /* x2 has days in seconds */
1385 x1 = PyInt_FromLong(GET_TD_SECONDS(self)); /* seconds */
1386 if (x1 == NULL)
1387 goto Done;
1388 x3 = PyNumber_Add(x1, x2); /* days and seconds in seconds */
1389 if (x3 == NULL)
1390 goto Done;
1391 Py_DECREF(x1);
1392 Py_DECREF(x2);
1393 x1 = x2 = NULL;
1394
1395 /* x3 has days+seconds in seconds */
1396 x1 = PyNumber_Multiply(x3, us_per_second); /* us */
1397 if (x1 == NULL)
1398 goto Done;
1399 Py_DECREF(x3);
1400 x3 = NULL;
1401
1402 /* x1 has days+seconds in us */
1403 x2 = PyInt_FromLong(GET_TD_MICROSECONDS(self));
1404 if (x2 == NULL)
1405 goto Done;
1406 result = PyNumber_Add(x1, x2);
1407
1408Done:
1409 Py_XDECREF(x1);
1410 Py_XDECREF(x2);
1411 Py_XDECREF(x3);
1412 return result;
1413}
1414
1415/* Convert a number of us (as a Python int or long) to a timedelta.
1416 */
1417static PyObject *
1418microseconds_to_delta(PyObject *pyus)
1419{
1420 int us;
1421 int s;
1422 int d;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001423 long temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001424
1425 PyObject *tuple = NULL;
1426 PyObject *num = NULL;
1427 PyObject *result = NULL;
1428
1429 tuple = PyNumber_Divmod(pyus, us_per_second);
1430 if (tuple == NULL)
1431 goto Done;
1432
1433 num = PyTuple_GetItem(tuple, 1); /* us */
1434 if (num == NULL)
1435 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001436 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001437 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001438 if (temp == -1 && PyErr_Occurred())
1439 goto Done;
1440 assert(0 <= temp && temp < 1000000);
1441 us = (int)temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001442 if (us < 0) {
1443 /* The divisor was positive, so this must be an error. */
1444 assert(PyErr_Occurred());
1445 goto Done;
1446 }
1447
1448 num = PyTuple_GetItem(tuple, 0); /* leftover seconds */
1449 if (num == NULL)
1450 goto Done;
1451 Py_INCREF(num);
1452 Py_DECREF(tuple);
1453
1454 tuple = PyNumber_Divmod(num, seconds_per_day);
1455 if (tuple == NULL)
1456 goto Done;
1457 Py_DECREF(num);
1458
1459 num = PyTuple_GetItem(tuple, 1); /* seconds */
1460 if (num == NULL)
1461 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001462 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001463 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001464 if (temp == -1 && PyErr_Occurred())
1465 goto Done;
1466 assert(0 <= temp && temp < 24*3600);
1467 s = (int)temp;
1468
Tim Peters2a799bf2002-12-16 20:18:38 +00001469 if (s < 0) {
1470 /* The divisor was positive, so this must be an error. */
1471 assert(PyErr_Occurred());
1472 goto Done;
1473 }
1474
1475 num = PyTuple_GetItem(tuple, 0); /* leftover days */
1476 if (num == NULL)
1477 goto Done;
1478 Py_INCREF(num);
Tim Peters0b0f41c2002-12-19 01:44:38 +00001479 temp = PyLong_AsLong(num);
1480 if (temp == -1 && PyErr_Occurred())
Tim Peters2a799bf2002-12-16 20:18:38 +00001481 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001482 d = (int)temp;
1483 if ((long)d != temp) {
1484 PyErr_SetString(PyExc_OverflowError, "normalized days too "
1485 "large to fit in a C int");
1486 goto Done;
1487 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001488 result = new_delta(d, s, us, 0);
1489
1490Done:
1491 Py_XDECREF(tuple);
1492 Py_XDECREF(num);
1493 return result;
1494}
1495
1496static PyObject *
1497multiply_int_timedelta(PyObject *intobj, PyDateTime_Delta *delta)
1498{
1499 PyObject *pyus_in;
1500 PyObject *pyus_out;
1501 PyObject *result;
1502
1503 pyus_in = delta_to_microseconds(delta);
1504 if (pyus_in == NULL)
1505 return NULL;
1506
1507 pyus_out = PyNumber_Multiply(pyus_in, intobj);
1508 Py_DECREF(pyus_in);
1509 if (pyus_out == NULL)
1510 return NULL;
1511
1512 result = microseconds_to_delta(pyus_out);
1513 Py_DECREF(pyus_out);
1514 return result;
1515}
1516
1517static PyObject *
1518divide_timedelta_int(PyDateTime_Delta *delta, PyObject *intobj)
1519{
1520 PyObject *pyus_in;
1521 PyObject *pyus_out;
1522 PyObject *result;
1523
1524 pyus_in = delta_to_microseconds(delta);
1525 if (pyus_in == NULL)
1526 return NULL;
1527
1528 pyus_out = PyNumber_FloorDivide(pyus_in, intobj);
1529 Py_DECREF(pyus_in);
1530 if (pyus_out == NULL)
1531 return NULL;
1532
1533 result = microseconds_to_delta(pyus_out);
1534 Py_DECREF(pyus_out);
1535 return result;
1536}
1537
1538static PyObject *
1539delta_add(PyObject *left, PyObject *right)
1540{
1541 PyObject *result = Py_NotImplemented;
1542
1543 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1544 /* delta + delta */
1545 /* The C-level additions can't overflow because of the
1546 * invariant bounds.
1547 */
1548 int days = GET_TD_DAYS(left) + GET_TD_DAYS(right);
1549 int seconds = GET_TD_SECONDS(left) + GET_TD_SECONDS(right);
1550 int microseconds = GET_TD_MICROSECONDS(left) +
1551 GET_TD_MICROSECONDS(right);
1552 result = new_delta(days, seconds, microseconds, 1);
1553 }
1554
1555 if (result == Py_NotImplemented)
1556 Py_INCREF(result);
1557 return result;
1558}
1559
1560static PyObject *
1561delta_negative(PyDateTime_Delta *self)
1562{
1563 return new_delta(-GET_TD_DAYS(self),
1564 -GET_TD_SECONDS(self),
1565 -GET_TD_MICROSECONDS(self),
1566 1);
1567}
1568
1569static PyObject *
1570delta_positive(PyDateTime_Delta *self)
1571{
1572 /* Could optimize this (by returning self) if this isn't a
1573 * subclass -- but who uses unary + ? Approximately nobody.
1574 */
1575 return new_delta(GET_TD_DAYS(self),
1576 GET_TD_SECONDS(self),
1577 GET_TD_MICROSECONDS(self),
1578 0);
1579}
1580
1581static PyObject *
1582delta_abs(PyDateTime_Delta *self)
1583{
1584 PyObject *result;
1585
1586 assert(GET_TD_MICROSECONDS(self) >= 0);
1587 assert(GET_TD_SECONDS(self) >= 0);
1588
1589 if (GET_TD_DAYS(self) < 0)
1590 result = delta_negative(self);
1591 else
1592 result = delta_positive(self);
1593
1594 return result;
1595}
1596
1597static PyObject *
1598delta_subtract(PyObject *left, PyObject *right)
1599{
1600 PyObject *result = Py_NotImplemented;
1601
1602 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1603 /* delta - delta */
1604 PyObject *minus_right = PyNumber_Negative(right);
1605 if (minus_right) {
1606 result = delta_add(left, minus_right);
1607 Py_DECREF(minus_right);
1608 }
1609 else
1610 result = NULL;
1611 }
1612
1613 if (result == Py_NotImplemented)
1614 Py_INCREF(result);
1615 return result;
1616}
1617
1618/* This is more natural as a tp_compare, but doesn't work then: for whatever
1619 * reason, Python's try_3way_compare ignores tp_compare unless
1620 * PyInstance_Check returns true, but these aren't old-style classes.
1621 */
1622static PyObject *
1623delta_richcompare(PyDateTime_Delta *self, PyObject *other, int op)
1624{
1625 int diff;
1626
1627 if (! PyDelta_CheckExact(other)) {
1628 PyErr_Format(PyExc_TypeError,
1629 "can't compare %s to %s instance",
1630 self->ob_type->tp_name, other->ob_type->tp_name);
1631 return NULL;
1632 }
1633 diff = GET_TD_DAYS(self) - GET_TD_DAYS(other);
1634 if (diff == 0) {
1635 diff = GET_TD_SECONDS(self) - GET_TD_SECONDS(other);
1636 if (diff == 0)
1637 diff = GET_TD_MICROSECONDS(self) -
1638 GET_TD_MICROSECONDS(other);
1639 }
1640 return diff_to_bool(diff, op);
1641}
1642
1643static PyObject *delta_getstate(PyDateTime_Delta *self);
1644
1645static long
1646delta_hash(PyDateTime_Delta *self)
1647{
1648 if (self->hashcode == -1) {
1649 PyObject *temp = delta_getstate(self);
1650 if (temp != NULL) {
1651 self->hashcode = PyObject_Hash(temp);
1652 Py_DECREF(temp);
1653 }
1654 }
1655 return self->hashcode;
1656}
1657
1658static PyObject *
1659delta_multiply(PyObject *left, PyObject *right)
1660{
1661 PyObject *result = Py_NotImplemented;
1662
1663 if (PyDelta_Check(left)) {
1664 /* delta * ??? */
1665 if (PyInt_Check(right) || PyLong_Check(right))
1666 result = multiply_int_timedelta(right,
1667 (PyDateTime_Delta *) left);
1668 }
1669 else if (PyInt_Check(left) || PyLong_Check(left))
1670 result = multiply_int_timedelta(left,
1671 (PyDateTime_Delta *) right);
1672
1673 if (result == Py_NotImplemented)
1674 Py_INCREF(result);
1675 return result;
1676}
1677
1678static PyObject *
1679delta_divide(PyObject *left, PyObject *right)
1680{
1681 PyObject *result = Py_NotImplemented;
1682
1683 if (PyDelta_Check(left)) {
1684 /* delta * ??? */
1685 if (PyInt_Check(right) || PyLong_Check(right))
1686 result = divide_timedelta_int(
1687 (PyDateTime_Delta *)left,
1688 right);
1689 }
1690
1691 if (result == Py_NotImplemented)
1692 Py_INCREF(result);
1693 return result;
1694}
1695
1696/* Fold in the value of the tag ("seconds", "weeks", etc) component of a
1697 * timedelta constructor. sofar is the # of microseconds accounted for
1698 * so far, and there are factor microseconds per current unit, the number
1699 * of which is given by num. num * factor is added to sofar in a
1700 * numerically careful way, and that's the result. Any fractional
1701 * microseconds left over (this can happen if num is a float type) are
1702 * added into *leftover.
1703 * Note that there are many ways this can give an error (NULL) return.
1704 */
1705static PyObject *
1706accum(const char* tag, PyObject *sofar, PyObject *num, PyObject *factor,
1707 double *leftover)
1708{
1709 PyObject *prod;
1710 PyObject *sum;
1711
1712 assert(num != NULL);
1713
1714 if (PyInt_Check(num) || PyLong_Check(num)) {
1715 prod = PyNumber_Multiply(num, factor);
1716 if (prod == NULL)
1717 return NULL;
1718 sum = PyNumber_Add(sofar, prod);
1719 Py_DECREF(prod);
1720 return sum;
1721 }
1722
1723 if (PyFloat_Check(num)) {
1724 double dnum;
1725 double fracpart;
1726 double intpart;
1727 PyObject *x;
1728 PyObject *y;
1729
1730 /* The Plan: decompose num into an integer part and a
1731 * fractional part, num = intpart + fracpart.
1732 * Then num * factor ==
1733 * intpart * factor + fracpart * factor
1734 * and the LHS can be computed exactly in long arithmetic.
1735 * The RHS is again broken into an int part and frac part.
1736 * and the frac part is added into *leftover.
1737 */
1738 dnum = PyFloat_AsDouble(num);
1739 if (dnum == -1.0 && PyErr_Occurred())
1740 return NULL;
1741 fracpart = modf(dnum, &intpart);
1742 x = PyLong_FromDouble(intpart);
1743 if (x == NULL)
1744 return NULL;
1745
1746 prod = PyNumber_Multiply(x, factor);
1747 Py_DECREF(x);
1748 if (prod == NULL)
1749 return NULL;
1750
1751 sum = PyNumber_Add(sofar, prod);
1752 Py_DECREF(prod);
1753 if (sum == NULL)
1754 return NULL;
1755
1756 if (fracpart == 0.0)
1757 return sum;
1758 /* So far we've lost no information. Dealing with the
1759 * fractional part requires float arithmetic, and may
1760 * lose a little info.
1761 */
1762 assert(PyInt_Check(factor) || PyLong_Check(factor));
1763 if (PyInt_Check(factor))
1764 dnum = (double)PyInt_AsLong(factor);
1765 else
1766 dnum = PyLong_AsDouble(factor);
1767
1768 dnum *= fracpart;
1769 fracpart = modf(dnum, &intpart);
1770 x = PyLong_FromDouble(intpart);
1771 if (x == NULL) {
1772 Py_DECREF(sum);
1773 return NULL;
1774 }
1775
1776 y = PyNumber_Add(sum, x);
1777 Py_DECREF(sum);
1778 Py_DECREF(x);
1779 *leftover += fracpart;
1780 return y;
1781 }
1782
1783 PyErr_Format(PyExc_TypeError,
1784 "unsupported type for timedelta %s component: %s",
1785 tag, num->ob_type->tp_name);
1786 return NULL;
1787}
1788
1789static PyObject *
1790delta_new(PyTypeObject *type, PyObject *args, PyObject *kw)
1791{
1792 PyObject *self = NULL;
1793
1794 /* Argument objects. */
1795 PyObject *day = NULL;
1796 PyObject *second = NULL;
1797 PyObject *us = NULL;
1798 PyObject *ms = NULL;
1799 PyObject *minute = NULL;
1800 PyObject *hour = NULL;
1801 PyObject *week = NULL;
1802
1803 PyObject *x = NULL; /* running sum of microseconds */
1804 PyObject *y = NULL; /* temp sum of microseconds */
1805 double leftover_us = 0.0;
1806
1807 static char *keywords[] = {
1808 "days", "seconds", "microseconds", "milliseconds",
1809 "minutes", "hours", "weeks", NULL
1810 };
1811
1812 if (PyArg_ParseTupleAndKeywords(args, kw, "|OOOOOOO:__new__",
1813 keywords,
1814 &day, &second, &us,
1815 &ms, &minute, &hour, &week) == 0)
1816 goto Done;
1817
1818 x = PyInt_FromLong(0);
1819 if (x == NULL)
1820 goto Done;
1821
1822#define CLEANUP \
1823 Py_DECREF(x); \
1824 x = y; \
1825 if (x == NULL) \
1826 goto Done
1827
1828 if (us) {
1829 y = accum("microseconds", x, us, us_per_us, &leftover_us);
1830 CLEANUP;
1831 }
1832 if (ms) {
1833 y = accum("milliseconds", x, ms, us_per_ms, &leftover_us);
1834 CLEANUP;
1835 }
1836 if (second) {
1837 y = accum("seconds", x, second, us_per_second, &leftover_us);
1838 CLEANUP;
1839 }
1840 if (minute) {
1841 y = accum("minutes", x, minute, us_per_minute, &leftover_us);
1842 CLEANUP;
1843 }
1844 if (hour) {
1845 y = accum("hours", x, hour, us_per_hour, &leftover_us);
1846 CLEANUP;
1847 }
1848 if (day) {
1849 y = accum("days", x, day, us_per_day, &leftover_us);
1850 CLEANUP;
1851 }
1852 if (week) {
1853 y = accum("weeks", x, week, us_per_week, &leftover_us);
1854 CLEANUP;
1855 }
1856 if (leftover_us) {
1857 /* Round to nearest whole # of us, and add into x. */
Tim Peters5d644dd2003-01-02 16:32:54 +00001858 PyObject *temp = PyLong_FromLong(round_to_long(leftover_us));
Tim Peters2a799bf2002-12-16 20:18:38 +00001859 if (temp == NULL) {
1860 Py_DECREF(x);
1861 goto Done;
1862 }
1863 y = PyNumber_Add(x, temp);
1864 Py_DECREF(temp);
1865 CLEANUP;
1866 }
1867
1868 self = microseconds_to_delta(x);
1869 Py_DECREF(x);
1870Done:
1871 return self;
1872
1873#undef CLEANUP
1874}
1875
1876static int
1877delta_nonzero(PyDateTime_Delta *self)
1878{
1879 return (GET_TD_DAYS(self) != 0
1880 || GET_TD_SECONDS(self) != 0
1881 || GET_TD_MICROSECONDS(self) != 0);
1882}
1883
1884static PyObject *
1885delta_repr(PyDateTime_Delta *self)
1886{
1887 if (GET_TD_MICROSECONDS(self) != 0)
1888 return PyString_FromFormat("%s(%d, %d, %d)",
1889 self->ob_type->tp_name,
1890 GET_TD_DAYS(self),
1891 GET_TD_SECONDS(self),
1892 GET_TD_MICROSECONDS(self));
1893 if (GET_TD_SECONDS(self) != 0)
1894 return PyString_FromFormat("%s(%d, %d)",
1895 self->ob_type->tp_name,
1896 GET_TD_DAYS(self),
1897 GET_TD_SECONDS(self));
1898
1899 return PyString_FromFormat("%s(%d)",
1900 self->ob_type->tp_name,
1901 GET_TD_DAYS(self));
1902}
1903
1904static PyObject *
1905delta_str(PyDateTime_Delta *self)
1906{
1907 int days = GET_TD_DAYS(self);
1908 int seconds = GET_TD_SECONDS(self);
1909 int us = GET_TD_MICROSECONDS(self);
1910 int hours;
1911 int minutes;
Tim Petersba873472002-12-18 20:19:21 +00001912 char buf[100];
1913 char *pbuf = buf;
1914 size_t buflen = sizeof(buf);
1915 int n;
Tim Peters2a799bf2002-12-16 20:18:38 +00001916
1917 minutes = divmod(seconds, 60, &seconds);
1918 hours = divmod(minutes, 60, &minutes);
1919
1920 if (days) {
Tim Petersba873472002-12-18 20:19:21 +00001921 n = PyOS_snprintf(pbuf, buflen, "%d day%s, ", days,
1922 (days == 1 || days == -1) ? "" : "s");
1923 if (n < 0 || (size_t)n >= buflen)
1924 goto Fail;
1925 pbuf += n;
1926 buflen -= (size_t)n;
Tim Peters2a799bf2002-12-16 20:18:38 +00001927 }
1928
Tim Petersba873472002-12-18 20:19:21 +00001929 n = PyOS_snprintf(pbuf, buflen, "%d:%02d:%02d",
1930 hours, minutes, seconds);
1931 if (n < 0 || (size_t)n >= buflen)
1932 goto Fail;
1933 pbuf += n;
1934 buflen -= (size_t)n;
Tim Peters2a799bf2002-12-16 20:18:38 +00001935
1936 if (us) {
Tim Petersba873472002-12-18 20:19:21 +00001937 n = PyOS_snprintf(pbuf, buflen, ".%06d", us);
1938 if (n < 0 || (size_t)n >= buflen)
1939 goto Fail;
1940 pbuf += n;
Tim Peters2a799bf2002-12-16 20:18:38 +00001941 }
1942
Tim Petersba873472002-12-18 20:19:21 +00001943 return PyString_FromStringAndSize(buf, pbuf - buf);
1944
1945 Fail:
1946 PyErr_SetString(PyExc_SystemError, "goofy result from PyOS_snprintf");
1947 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001948}
1949
Tim Peters371935f2003-02-01 01:52:50 +00001950/* Pickle support, a simple use of __reduce__. */
1951
Tim Peters2a799bf2002-12-16 20:18:38 +00001952static PyObject *
1953delta_getstate(PyDateTime_Delta *self)
1954{
1955 return Py_BuildValue("iii", GET_TD_DAYS(self),
1956 GET_TD_SECONDS(self),
1957 GET_TD_MICROSECONDS(self));
1958}
1959
Tim Peters2a799bf2002-12-16 20:18:38 +00001960static PyObject *
1961delta_reduce(PyDateTime_Delta* self)
1962{
Tim Peters8a60c222003-02-01 01:47:29 +00001963 return Py_BuildValue("ON", self->ob_type, delta_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00001964}
1965
1966#define OFFSET(field) offsetof(PyDateTime_Delta, field)
1967
1968static PyMemberDef delta_members[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00001969
Neal Norwitzdfb80862002-12-19 02:30:56 +00001970 {"days", T_INT, OFFSET(days), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00001971 PyDoc_STR("Number of days.")},
1972
Neal Norwitzdfb80862002-12-19 02:30:56 +00001973 {"seconds", T_INT, OFFSET(seconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00001974 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
1975
Neal Norwitzdfb80862002-12-19 02:30:56 +00001976 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00001977 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
1978 {NULL}
1979};
1980
1981static PyMethodDef delta_methods[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001982 {"__getstate__", (PyCFunction)delta_getstate, METH_NOARGS,
1983 PyDoc_STR("__getstate__() -> state")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00001984
1985 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
1986 PyDoc_STR("__reduce__() -> (cls, state)")},
1987
Tim Peters2a799bf2002-12-16 20:18:38 +00001988 {NULL, NULL},
1989};
1990
1991static char delta_doc[] =
1992PyDoc_STR("Difference between two datetime values.");
1993
1994static PyNumberMethods delta_as_number = {
1995 delta_add, /* nb_add */
1996 delta_subtract, /* nb_subtract */
1997 delta_multiply, /* nb_multiply */
1998 delta_divide, /* nb_divide */
1999 0, /* nb_remainder */
2000 0, /* nb_divmod */
2001 0, /* nb_power */
2002 (unaryfunc)delta_negative, /* nb_negative */
2003 (unaryfunc)delta_positive, /* nb_positive */
2004 (unaryfunc)delta_abs, /* nb_absolute */
2005 (inquiry)delta_nonzero, /* nb_nonzero */
2006 0, /*nb_invert*/
2007 0, /*nb_lshift*/
2008 0, /*nb_rshift*/
2009 0, /*nb_and*/
2010 0, /*nb_xor*/
2011 0, /*nb_or*/
2012 0, /*nb_coerce*/
2013 0, /*nb_int*/
2014 0, /*nb_long*/
2015 0, /*nb_float*/
2016 0, /*nb_oct*/
2017 0, /*nb_hex*/
2018 0, /*nb_inplace_add*/
2019 0, /*nb_inplace_subtract*/
2020 0, /*nb_inplace_multiply*/
2021 0, /*nb_inplace_divide*/
2022 0, /*nb_inplace_remainder*/
2023 0, /*nb_inplace_power*/
2024 0, /*nb_inplace_lshift*/
2025 0, /*nb_inplace_rshift*/
2026 0, /*nb_inplace_and*/
2027 0, /*nb_inplace_xor*/
2028 0, /*nb_inplace_or*/
2029 delta_divide, /* nb_floor_divide */
2030 0, /* nb_true_divide */
2031 0, /* nb_inplace_floor_divide */
2032 0, /* nb_inplace_true_divide */
2033};
2034
2035static PyTypeObject PyDateTime_DeltaType = {
2036 PyObject_HEAD_INIT(NULL)
2037 0, /* ob_size */
2038 "datetime.timedelta", /* tp_name */
2039 sizeof(PyDateTime_Delta), /* tp_basicsize */
2040 0, /* tp_itemsize */
2041 0, /* tp_dealloc */
2042 0, /* tp_print */
2043 0, /* tp_getattr */
2044 0, /* tp_setattr */
2045 0, /* tp_compare */
2046 (reprfunc)delta_repr, /* tp_repr */
2047 &delta_as_number, /* tp_as_number */
2048 0, /* tp_as_sequence */
2049 0, /* tp_as_mapping */
2050 (hashfunc)delta_hash, /* tp_hash */
2051 0, /* tp_call */
2052 (reprfunc)delta_str, /* tp_str */
2053 PyObject_GenericGetAttr, /* tp_getattro */
2054 0, /* tp_setattro */
2055 0, /* tp_as_buffer */
2056 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES, /* tp_flags */
2057 delta_doc, /* tp_doc */
2058 0, /* tp_traverse */
2059 0, /* tp_clear */
2060 (richcmpfunc)delta_richcompare, /* tp_richcompare */
2061 0, /* tp_weaklistoffset */
2062 0, /* tp_iter */
2063 0, /* tp_iternext */
2064 delta_methods, /* tp_methods */
2065 delta_members, /* tp_members */
2066 0, /* tp_getset */
2067 0, /* tp_base */
2068 0, /* tp_dict */
2069 0, /* tp_descr_get */
2070 0, /* tp_descr_set */
2071 0, /* tp_dictoffset */
2072 0, /* tp_init */
2073 0, /* tp_alloc */
2074 delta_new, /* tp_new */
2075 _PyObject_Del, /* tp_free */
2076};
2077
2078/*
2079 * PyDateTime_Date implementation.
2080 */
2081
2082/* Accessor properties. */
2083
2084static PyObject *
2085date_year(PyDateTime_Date *self, void *unused)
2086{
2087 return PyInt_FromLong(GET_YEAR(self));
2088}
2089
2090static PyObject *
2091date_month(PyDateTime_Date *self, void *unused)
2092{
2093 return PyInt_FromLong(GET_MONTH(self));
2094}
2095
2096static PyObject *
2097date_day(PyDateTime_Date *self, void *unused)
2098{
2099 return PyInt_FromLong(GET_DAY(self));
2100}
2101
2102static PyGetSetDef date_getset[] = {
2103 {"year", (getter)date_year},
2104 {"month", (getter)date_month},
2105 {"day", (getter)date_day},
2106 {NULL}
2107};
2108
2109/* Constructors. */
2110
Tim Peters12bf3392002-12-24 05:41:27 +00002111static char *date_kws[] = {"year", "month", "day", NULL};
2112
Tim Peters506be282003-01-31 22:27:17 +00002113/* __setstate__ isn't exposed. */
2114static PyObject *
2115date_setstate(PyDateTime_Date *self, PyObject *arg)
2116{
2117 PyObject *state;
2118 int len;
2119 unsigned char *pdata;
2120
2121 if (!PyTuple_Check(arg) || PyTuple_GET_SIZE(arg) != 1)
2122 goto error;
2123 state = PyTuple_GET_ITEM(arg, 0);
2124 if (!PyString_Check(state))
2125 goto error;
2126
2127 len = PyString_Size(state);
2128 if (len != _PyDateTime_DATE_DATASIZE)
2129 goto error;
2130
2131 pdata = (unsigned char*)PyString_AsString(state);
2132 memcpy(self->data, pdata, _PyDateTime_DATE_DATASIZE);
2133 self->hashcode = -1;
2134
2135 Py_INCREF(Py_None);
2136 return Py_None;
2137 error:
2138 PyErr_SetString(PyExc_TypeError,
2139 "bad argument to date.__setstate__");
2140 return NULL;
2141}
Guido van Rossum177e41a2003-01-30 22:06:23 +00002142
Tim Peters2a799bf2002-12-16 20:18:38 +00002143static PyObject *
2144date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2145{
2146 PyObject *self = NULL;
2147 int year;
2148 int month;
2149 int day;
2150
Guido van Rossum177e41a2003-01-30 22:06:23 +00002151 /* Check for invocation from pickle with __getstate__ state */
2152 if (PyTuple_GET_SIZE(args) == 1 &&
2153 PyString_Check(PyTuple_GET_ITEM(args, 0)))
2154 {
2155 self = new_date(1, 1, 1);
2156 if (self != NULL) {
2157 PyObject *res = date_setstate(
2158 (PyDateTime_Date *)self, args);
2159 if (res == Py_None)
2160 Py_DECREF(res);
2161 else {
2162 Py_DECREF(self);
2163 self = NULL;
2164 }
2165 }
2166 return self;
2167 }
2168
Tim Peters12bf3392002-12-24 05:41:27 +00002169 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00002170 &year, &month, &day)) {
2171 if (check_date_args(year, month, day) < 0)
2172 return NULL;
2173 self = new_date(year, month, day);
2174 }
2175 return self;
2176}
2177
2178/* Return new date from localtime(t). */
2179static PyObject *
2180date_local_from_time_t(PyObject *cls, time_t t)
2181{
2182 struct tm *tm;
2183 PyObject *result = NULL;
2184
2185 tm = localtime(&t);
2186 if (tm)
2187 result = PyObject_CallFunction(cls, "iii",
2188 tm->tm_year + 1900,
2189 tm->tm_mon + 1,
2190 tm->tm_mday);
2191 else
2192 PyErr_SetString(PyExc_ValueError,
2193 "timestamp out of range for "
2194 "platform localtime() function");
2195 return result;
2196}
2197
2198/* Return new date from current time.
2199 * We say this is equivalent to fromtimestamp(time.time()), and the
2200 * only way to be sure of that is to *call* time.time(). That's not
2201 * generally the same as calling C's time.
2202 */
2203static PyObject *
2204date_today(PyObject *cls, PyObject *dummy)
2205{
2206 PyObject *time;
2207 PyObject *result;
2208
2209 time = time_time();
2210 if (time == NULL)
2211 return NULL;
2212
2213 /* Note well: today() is a class method, so this may not call
2214 * date.fromtimestamp. For example, it may call
2215 * datetime.fromtimestamp. That's why we need all the accuracy
2216 * time.time() delivers; if someone were gonzo about optimization,
2217 * date.today() could get away with plain C time().
2218 */
2219 result = PyObject_CallMethod(cls, "fromtimestamp", "O", time);
2220 Py_DECREF(time);
2221 return result;
2222}
2223
2224/* Return new date from given timestamp (Python timestamp -- a double). */
2225static PyObject *
2226date_fromtimestamp(PyObject *cls, PyObject *args)
2227{
2228 double timestamp;
2229 PyObject *result = NULL;
2230
2231 if (PyArg_ParseTuple(args, "d:fromtimestamp", &timestamp))
2232 result = date_local_from_time_t(cls, (time_t)timestamp);
2233 return result;
2234}
2235
2236/* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2237 * the ordinal is out of range.
2238 */
2239static PyObject *
2240date_fromordinal(PyObject *cls, PyObject *args)
2241{
2242 PyObject *result = NULL;
2243 int ordinal;
2244
2245 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2246 int year;
2247 int month;
2248 int day;
2249
2250 if (ordinal < 1)
2251 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2252 ">= 1");
2253 else {
2254 ord_to_ymd(ordinal, &year, &month, &day);
2255 result = PyObject_CallFunction(cls, "iii",
2256 year, month, day);
2257 }
2258 }
2259 return result;
2260}
2261
2262/*
2263 * Date arithmetic.
2264 */
2265
2266/* date + timedelta -> date. If arg negate is true, subtract the timedelta
2267 * instead.
2268 */
2269static PyObject *
2270add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
2271{
2272 PyObject *result = NULL;
2273 int year = GET_YEAR(date);
2274 int month = GET_MONTH(date);
2275 int deltadays = GET_TD_DAYS(delta);
2276 /* C-level overflow is impossible because |deltadays| < 1e9. */
2277 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
2278
2279 if (normalize_date(&year, &month, &day) >= 0)
2280 result = new_date(year, month, day);
2281 return result;
2282}
2283
2284static PyObject *
2285date_add(PyObject *left, PyObject *right)
2286{
2287 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2288 Py_INCREF(Py_NotImplemented);
2289 return Py_NotImplemented;
2290 }
2291 if (PyDate_CheckExact(left)) {
2292 /* date + ??? */
2293 if (PyDelta_Check(right))
2294 /* date + delta */
2295 return add_date_timedelta((PyDateTime_Date *) left,
2296 (PyDateTime_Delta *) right,
2297 0);
2298 }
2299 else {
2300 /* ??? + date
2301 * 'right' must be one of us, or we wouldn't have been called
2302 */
2303 if (PyDelta_Check(left))
2304 /* delta + date */
2305 return add_date_timedelta((PyDateTime_Date *) right,
2306 (PyDateTime_Delta *) left,
2307 0);
2308 }
2309 Py_INCREF(Py_NotImplemented);
2310 return Py_NotImplemented;
2311}
2312
2313static PyObject *
2314date_subtract(PyObject *left, PyObject *right)
2315{
2316 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2317 Py_INCREF(Py_NotImplemented);
2318 return Py_NotImplemented;
2319 }
2320 if (PyDate_CheckExact(left)) {
2321 if (PyDate_CheckExact(right)) {
2322 /* date - date */
2323 int left_ord = ymd_to_ord(GET_YEAR(left),
2324 GET_MONTH(left),
2325 GET_DAY(left));
2326 int right_ord = ymd_to_ord(GET_YEAR(right),
2327 GET_MONTH(right),
2328 GET_DAY(right));
2329 return new_delta(left_ord - right_ord, 0, 0, 0);
2330 }
2331 if (PyDelta_Check(right)) {
2332 /* date - delta */
2333 return add_date_timedelta((PyDateTime_Date *) left,
2334 (PyDateTime_Delta *) right,
2335 1);
2336 }
2337 }
2338 Py_INCREF(Py_NotImplemented);
2339 return Py_NotImplemented;
2340}
2341
2342
2343/* Various ways to turn a date into a string. */
2344
2345static PyObject *
2346date_repr(PyDateTime_Date *self)
2347{
2348 char buffer[1028];
2349 char *typename;
2350
2351 typename = self->ob_type->tp_name;
2352 PyOS_snprintf(buffer, sizeof(buffer), "%s(%d, %d, %d)",
2353 typename,
2354 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2355
2356 return PyString_FromString(buffer);
2357}
2358
2359static PyObject *
2360date_isoformat(PyDateTime_Date *self)
2361{
2362 char buffer[128];
2363
2364 isoformat_date(self, buffer, sizeof(buffer));
2365 return PyString_FromString(buffer);
2366}
2367
2368/* str() calls the appropriate isofomat() method. */
2369static PyObject *
2370date_str(PyDateTime_Date *self)
2371{
2372 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
2373}
2374
2375
2376static PyObject *
2377date_ctime(PyDateTime_Date *self)
2378{
2379 return format_ctime(self, 0, 0, 0);
2380}
2381
2382static PyObject *
2383date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2384{
2385 /* This method can be inherited, and needs to call the
2386 * timetuple() method appropriate to self's class.
2387 */
2388 PyObject *result;
2389 PyObject *format;
2390 PyObject *tuple;
2391 static char *keywords[] = {"format", NULL};
2392
2393 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
2394 &PyString_Type, &format))
2395 return NULL;
2396
2397 tuple = PyObject_CallMethod((PyObject *)self, "timetuple", "()");
2398 if (tuple == NULL)
2399 return NULL;
Tim Petersbad8ff02002-12-30 20:52:32 +00002400 result = wrap_strftime((PyObject *)self, format, tuple,
2401 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002402 Py_DECREF(tuple);
2403 return result;
2404}
2405
2406/* ISO methods. */
2407
2408static PyObject *
2409date_isoweekday(PyDateTime_Date *self)
2410{
2411 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2412
2413 return PyInt_FromLong(dow + 1);
2414}
2415
2416static PyObject *
2417date_isocalendar(PyDateTime_Date *self)
2418{
2419 int year = GET_YEAR(self);
2420 int week1_monday = iso_week1_monday(year);
2421 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
2422 int week;
2423 int day;
2424
2425 week = divmod(today - week1_monday, 7, &day);
2426 if (week < 0) {
2427 --year;
2428 week1_monday = iso_week1_monday(year);
2429 week = divmod(today - week1_monday, 7, &day);
2430 }
2431 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
2432 ++year;
2433 week = 0;
2434 }
2435 return Py_BuildValue("iii", year, week + 1, day + 1);
2436}
2437
2438/* Miscellaneous methods. */
2439
2440/* This is more natural as a tp_compare, but doesn't work then: for whatever
2441 * reason, Python's try_3way_compare ignores tp_compare unless
2442 * PyInstance_Check returns true, but these aren't old-style classes.
2443 */
2444static PyObject *
2445date_richcompare(PyDateTime_Date *self, PyObject *other, int op)
2446{
2447 int diff;
2448
2449 if (! PyDate_Check(other)) {
Tim Peters8d81a012003-01-24 22:36:34 +00002450 if (PyObject_HasAttrString(other, "timetuple")) {
2451 /* A hook for other kinds of date objects. */
2452 Py_INCREF(Py_NotImplemented);
2453 return Py_NotImplemented;
2454 }
2455 /* Stop this from falling back to address comparison. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002456 PyErr_Format(PyExc_TypeError,
Tim Peters8d81a012003-01-24 22:36:34 +00002457 "can't compare '%s' to '%s'",
2458 self->ob_type->tp_name,
Tim Peters2a799bf2002-12-16 20:18:38 +00002459 other->ob_type->tp_name);
2460 return NULL;
2461 }
2462 diff = memcmp(self->data, ((PyDateTime_Date *)other)->data,
2463 _PyDateTime_DATE_DATASIZE);
2464 return diff_to_bool(diff, op);
2465}
2466
2467static PyObject *
2468date_timetuple(PyDateTime_Date *self)
2469{
2470 return build_struct_time(GET_YEAR(self),
2471 GET_MONTH(self),
2472 GET_DAY(self),
2473 0, 0, 0, -1);
2474}
2475
Tim Peters12bf3392002-12-24 05:41:27 +00002476static PyObject *
2477date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2478{
2479 PyObject *clone;
2480 PyObject *tuple;
2481 int year = GET_YEAR(self);
2482 int month = GET_MONTH(self);
2483 int day = GET_DAY(self);
2484
2485 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
2486 &year, &month, &day))
2487 return NULL;
2488 tuple = Py_BuildValue("iii", year, month, day);
2489 if (tuple == NULL)
2490 return NULL;
2491 clone = date_new(self->ob_type, tuple, NULL);
2492 Py_DECREF(tuple);
2493 return clone;
2494}
2495
Tim Peters2a799bf2002-12-16 20:18:38 +00002496static PyObject *date_getstate(PyDateTime_Date *self);
2497
2498static long
2499date_hash(PyDateTime_Date *self)
2500{
2501 if (self->hashcode == -1) {
2502 PyObject *temp = date_getstate(self);
2503 if (temp != NULL) {
2504 self->hashcode = PyObject_Hash(temp);
2505 Py_DECREF(temp);
2506 }
2507 }
2508 return self->hashcode;
2509}
2510
2511static PyObject *
2512date_toordinal(PyDateTime_Date *self)
2513{
2514 return PyInt_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
2515 GET_DAY(self)));
2516}
2517
2518static PyObject *
2519date_weekday(PyDateTime_Date *self)
2520{
2521 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2522
2523 return PyInt_FromLong(dow);
2524}
2525
Tim Peters371935f2003-02-01 01:52:50 +00002526/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002527
2528static PyObject *
2529date_getstate(PyDateTime_Date *self)
2530{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002531 return Py_BuildValue(
2532 "(N)",
2533 PyString_FromStringAndSize((char *)self->data,
2534 _PyDateTime_DATE_DATASIZE));
Tim Peters2a799bf2002-12-16 20:18:38 +00002535}
2536
2537static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00002538date_reduce(PyDateTime_Date *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00002539{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002540 return Py_BuildValue("(ON)", self->ob_type, date_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002541}
2542
2543static PyMethodDef date_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002544
Tim Peters2a799bf2002-12-16 20:18:38 +00002545 /* Class methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00002546
Tim Peters2a799bf2002-12-16 20:18:38 +00002547 {"fromtimestamp", (PyCFunction)date_fromtimestamp, METH_VARARGS |
2548 METH_CLASS,
2549 PyDoc_STR("timestamp -> local date from a POSIX timestamp (like "
2550 "time.time()).")},
2551
2552 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
2553 METH_CLASS,
2554 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
2555 "ordinal.")},
2556
2557 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
2558 PyDoc_STR("Current date or datetime: same as "
2559 "self.__class__.fromtimestamp(time.time()).")},
2560
2561 /* Instance methods: */
2562
2563 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
2564 PyDoc_STR("Return ctime() style string.")},
2565
2566 {"strftime", (PyCFunction)date_strftime, METH_KEYWORDS,
2567 PyDoc_STR("format -> strftime() style string.")},
2568
2569 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
2570 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
2571
2572 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
2573 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
2574 "weekday.")},
2575
2576 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
2577 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
2578
2579 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
2580 PyDoc_STR("Return the day of the week represented by the date.\n"
2581 "Monday == 1 ... Sunday == 7")},
2582
2583 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
2584 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
2585 "1 is day 1.")},
2586
2587 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
2588 PyDoc_STR("Return the day of the week represented by the date.\n"
2589 "Monday == 0 ... Sunday == 6")},
2590
Tim Peters12bf3392002-12-24 05:41:27 +00002591 {"replace", (PyCFunction)date_replace, METH_KEYWORDS,
2592 PyDoc_STR("Return date with new specified fields.")},
2593
Tim Peters2a799bf2002-12-16 20:18:38 +00002594 {"__getstate__", (PyCFunction)date_getstate, METH_NOARGS,
2595 PyDoc_STR("__getstate__() -> state")},
2596
Guido van Rossum177e41a2003-01-30 22:06:23 +00002597 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
2598 PyDoc_STR("__reduce__() -> (cls, state)")},
2599
Tim Peters2a799bf2002-12-16 20:18:38 +00002600 {NULL, NULL}
2601};
2602
2603static char date_doc[] =
2604PyDoc_STR("Basic date type.");
2605
2606static PyNumberMethods date_as_number = {
2607 date_add, /* nb_add */
2608 date_subtract, /* nb_subtract */
2609 0, /* nb_multiply */
2610 0, /* nb_divide */
2611 0, /* nb_remainder */
2612 0, /* nb_divmod */
2613 0, /* nb_power */
2614 0, /* nb_negative */
2615 0, /* nb_positive */
2616 0, /* nb_absolute */
2617 0, /* nb_nonzero */
2618};
2619
2620static PyTypeObject PyDateTime_DateType = {
2621 PyObject_HEAD_INIT(NULL)
2622 0, /* ob_size */
2623 "datetime.date", /* tp_name */
2624 sizeof(PyDateTime_Date), /* tp_basicsize */
2625 0, /* tp_itemsize */
2626 (destructor)PyObject_Del, /* tp_dealloc */
2627 0, /* tp_print */
2628 0, /* tp_getattr */
2629 0, /* tp_setattr */
2630 0, /* tp_compare */
2631 (reprfunc)date_repr, /* tp_repr */
2632 &date_as_number, /* tp_as_number */
2633 0, /* tp_as_sequence */
2634 0, /* tp_as_mapping */
2635 (hashfunc)date_hash, /* tp_hash */
2636 0, /* tp_call */
2637 (reprfunc)date_str, /* tp_str */
2638 PyObject_GenericGetAttr, /* tp_getattro */
2639 0, /* tp_setattro */
2640 0, /* tp_as_buffer */
2641 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2642 Py_TPFLAGS_BASETYPE, /* tp_flags */
2643 date_doc, /* tp_doc */
2644 0, /* tp_traverse */
2645 0, /* tp_clear */
2646 (richcmpfunc)date_richcompare, /* tp_richcompare */
2647 0, /* tp_weaklistoffset */
2648 0, /* tp_iter */
2649 0, /* tp_iternext */
2650 date_methods, /* tp_methods */
2651 0, /* tp_members */
2652 date_getset, /* tp_getset */
2653 0, /* tp_base */
2654 0, /* tp_dict */
2655 0, /* tp_descr_get */
2656 0, /* tp_descr_set */
2657 0, /* tp_dictoffset */
2658 0, /* tp_init */
2659 0, /* tp_alloc */
2660 date_new, /* tp_new */
2661 _PyObject_Del, /* tp_free */
2662};
2663
2664/*
Tim Peters2a799bf2002-12-16 20:18:38 +00002665 * PyDateTime_TZInfo implementation.
2666 */
2667
2668/* This is a pure abstract base class, so doesn't do anything beyond
2669 * raising NotImplemented exceptions. Real tzinfo classes need
2670 * to derive from this. This is mostly for clarity, and for efficiency in
Tim Petersa9bc1682003-01-11 03:39:11 +00002671 * datetime and time constructors (their tzinfo arguments need to
Tim Peters2a799bf2002-12-16 20:18:38 +00002672 * be subclasses of this tzinfo class, which is easy and quick to check).
2673 *
2674 * Note: For reasons having to do with pickling of subclasses, we have
2675 * to allow tzinfo objects to be instantiated. This wasn't an issue
2676 * in the Python implementation (__init__() could raise NotImplementedError
2677 * there without ill effect), but doing so in the C implementation hit a
2678 * brick wall.
2679 */
2680
2681static PyObject *
2682tzinfo_nogo(const char* methodname)
2683{
2684 PyErr_Format(PyExc_NotImplementedError,
2685 "a tzinfo subclass must implement %s()",
2686 methodname);
2687 return NULL;
2688}
2689
2690/* Methods. A subclass must implement these. */
2691
Tim Peters52dcce22003-01-23 16:36:11 +00002692static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002693tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
2694{
2695 return tzinfo_nogo("tzname");
2696}
2697
Tim Peters52dcce22003-01-23 16:36:11 +00002698static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002699tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
2700{
2701 return tzinfo_nogo("utcoffset");
2702}
2703
Tim Peters52dcce22003-01-23 16:36:11 +00002704static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002705tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
2706{
2707 return tzinfo_nogo("dst");
2708}
2709
Tim Peters52dcce22003-01-23 16:36:11 +00002710static PyObject *
2711tzinfo_fromutc(PyDateTime_TZInfo *self, PyDateTime_DateTime *dt)
2712{
2713 int y, m, d, hh, mm, ss, us;
2714
2715 PyObject *result;
2716 int off, dst;
2717 int none;
2718 int delta;
2719
2720 if (! PyDateTime_Check(dt)) {
2721 PyErr_SetString(PyExc_TypeError,
2722 "fromutc: argument must be a datetime");
2723 return NULL;
2724 }
2725 if (! HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
2726 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
2727 "is not self");
2728 return NULL;
2729 }
2730
2731 off = call_utcoffset(dt->tzinfo, (PyObject *)dt, &none);
2732 if (off == -1 && PyErr_Occurred())
2733 return NULL;
2734 if (none) {
2735 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2736 "utcoffset() result required");
2737 return NULL;
2738 }
2739
2740 dst = call_dst(dt->tzinfo, (PyObject *)dt, &none);
2741 if (dst == -1 && PyErr_Occurred())
2742 return NULL;
2743 if (none) {
2744 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2745 "dst() result required");
2746 return NULL;
2747 }
2748
2749 y = GET_YEAR(dt);
2750 m = GET_MONTH(dt);
2751 d = GET_DAY(dt);
2752 hh = DATE_GET_HOUR(dt);
2753 mm = DATE_GET_MINUTE(dt);
2754 ss = DATE_GET_SECOND(dt);
2755 us = DATE_GET_MICROSECOND(dt);
2756
2757 delta = off - dst;
2758 mm += delta;
2759 if ((mm < 0 || mm >= 60) &&
2760 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Petersb1049e82003-01-23 17:20:36 +00002761 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00002762 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2763 if (result == NULL)
2764 return result;
2765
2766 dst = call_dst(dt->tzinfo, result, &none);
2767 if (dst == -1 && PyErr_Occurred())
2768 goto Fail;
2769 if (none)
2770 goto Inconsistent;
2771 if (dst == 0)
2772 return result;
2773
2774 mm += dst;
2775 if ((mm < 0 || mm >= 60) &&
2776 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
2777 goto Fail;
2778 Py_DECREF(result);
2779 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2780 return result;
2781
2782Inconsistent:
2783 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave"
2784 "inconsistent results; cannot convert");
2785
2786 /* fall thru to failure */
2787Fail:
2788 Py_DECREF(result);
2789 return NULL;
2790}
2791
Tim Peters2a799bf2002-12-16 20:18:38 +00002792/*
2793 * Pickle support. This is solely so that tzinfo subclasses can use
Guido van Rossum177e41a2003-01-30 22:06:23 +00002794 * pickling -- tzinfo itself is supposed to be uninstantiable.
Tim Peters2a799bf2002-12-16 20:18:38 +00002795 */
2796
Guido van Rossum177e41a2003-01-30 22:06:23 +00002797static PyObject *
2798tzinfo_reduce(PyObject *self)
2799{
2800 PyObject *args, *state, *tmp;
2801 PyObject *getinitargs, *getstate;
Tim Peters2a799bf2002-12-16 20:18:38 +00002802
Guido van Rossum177e41a2003-01-30 22:06:23 +00002803 tmp = PyTuple_New(0);
2804 if (tmp == NULL)
2805 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002806
Guido van Rossum177e41a2003-01-30 22:06:23 +00002807 getinitargs = PyObject_GetAttrString(self, "__getinitargs__");
2808 if (getinitargs != NULL) {
2809 args = PyObject_CallObject(getinitargs, tmp);
2810 Py_DECREF(getinitargs);
2811 if (args == NULL) {
2812 Py_DECREF(tmp);
2813 return NULL;
2814 }
2815 }
2816 else {
2817 PyErr_Clear();
2818 args = tmp;
2819 Py_INCREF(args);
2820 }
2821
2822 getstate = PyObject_GetAttrString(self, "__getstate__");
2823 if (getstate != NULL) {
2824 state = PyObject_CallObject(getstate, tmp);
2825 Py_DECREF(getstate);
2826 if (state == NULL) {
2827 Py_DECREF(args);
2828 Py_DECREF(tmp);
2829 return NULL;
2830 }
2831 }
2832 else {
2833 PyObject **dictptr;
2834 PyErr_Clear();
2835 state = Py_None;
2836 dictptr = _PyObject_GetDictPtr(self);
2837 if (dictptr && *dictptr && PyDict_Size(*dictptr))
2838 state = *dictptr;
2839 Py_INCREF(state);
2840 }
2841
2842 Py_DECREF(tmp);
2843
2844 if (state == Py_None) {
2845 Py_DECREF(state);
2846 return Py_BuildValue("(ON)", self->ob_type, args);
2847 }
2848 else
2849 return Py_BuildValue("(ONN)", self->ob_type, args, state);
2850}
Tim Peters2a799bf2002-12-16 20:18:38 +00002851
2852static PyMethodDef tzinfo_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002853
Tim Peters2a799bf2002-12-16 20:18:38 +00002854 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
2855 PyDoc_STR("datetime -> string name of time zone.")},
2856
2857 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
2858 PyDoc_STR("datetime -> minutes east of UTC (negative for "
2859 "west of UTC).")},
2860
2861 {"dst", (PyCFunction)tzinfo_dst, METH_O,
2862 PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
2863
Tim Peters52dcce22003-01-23 16:36:11 +00002864 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
2865 PyDoc_STR("datetime in UTC -> datetime in local time.")},
2866
Guido van Rossum177e41a2003-01-30 22:06:23 +00002867 {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
2868 PyDoc_STR("-> (cls, state)")},
2869
Tim Peters2a799bf2002-12-16 20:18:38 +00002870 {NULL, NULL}
2871};
2872
2873static char tzinfo_doc[] =
2874PyDoc_STR("Abstract base class for time zone info objects.");
2875
2876 statichere PyTypeObject PyDateTime_TZInfoType = {
2877 PyObject_HEAD_INIT(NULL)
2878 0, /* ob_size */
2879 "datetime.tzinfo", /* tp_name */
2880 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
2881 0, /* tp_itemsize */
2882 0, /* tp_dealloc */
2883 0, /* tp_print */
2884 0, /* tp_getattr */
2885 0, /* tp_setattr */
2886 0, /* tp_compare */
2887 0, /* tp_repr */
2888 0, /* tp_as_number */
2889 0, /* tp_as_sequence */
2890 0, /* tp_as_mapping */
2891 0, /* tp_hash */
2892 0, /* tp_call */
2893 0, /* tp_str */
2894 PyObject_GenericGetAttr, /* tp_getattro */
2895 0, /* tp_setattro */
2896 0, /* tp_as_buffer */
2897 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2898 Py_TPFLAGS_BASETYPE, /* tp_flags */
2899 tzinfo_doc, /* tp_doc */
2900 0, /* tp_traverse */
2901 0, /* tp_clear */
2902 0, /* tp_richcompare */
2903 0, /* tp_weaklistoffset */
2904 0, /* tp_iter */
2905 0, /* tp_iternext */
2906 tzinfo_methods, /* tp_methods */
2907 0, /* tp_members */
2908 0, /* tp_getset */
2909 0, /* tp_base */
2910 0, /* tp_dict */
2911 0, /* tp_descr_get */
2912 0, /* tp_descr_set */
2913 0, /* tp_dictoffset */
2914 0, /* tp_init */
2915 0, /* tp_alloc */
2916 PyType_GenericNew, /* tp_new */
2917 0, /* tp_free */
2918};
2919
2920/*
Tim Peters37f39822003-01-10 03:49:02 +00002921 * PyDateTime_Time implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00002922 */
2923
Tim Peters37f39822003-01-10 03:49:02 +00002924/* Accessor properties.
Tim Peters2a799bf2002-12-16 20:18:38 +00002925 */
2926
2927static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00002928time_hour(PyDateTime_Time *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00002929{
Tim Peters37f39822003-01-10 03:49:02 +00002930 return PyInt_FromLong(TIME_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002931}
2932
Tim Peters37f39822003-01-10 03:49:02 +00002933static PyObject *
2934time_minute(PyDateTime_Time *self, void *unused)
2935{
2936 return PyInt_FromLong(TIME_GET_MINUTE(self));
2937}
2938
2939/* The name time_second conflicted with some platform header file. */
2940static PyObject *
2941py_time_second(PyDateTime_Time *self, void *unused)
2942{
2943 return PyInt_FromLong(TIME_GET_SECOND(self));
2944}
2945
2946static PyObject *
2947time_microsecond(PyDateTime_Time *self, void *unused)
2948{
2949 return PyInt_FromLong(TIME_GET_MICROSECOND(self));
2950}
2951
2952static PyObject *
2953time_tzinfo(PyDateTime_Time *self, void *unused)
2954{
Tim Petersa032d2e2003-01-11 00:15:54 +00002955 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters37f39822003-01-10 03:49:02 +00002956 Py_INCREF(result);
2957 return result;
2958}
2959
2960static PyGetSetDef time_getset[] = {
2961 {"hour", (getter)time_hour},
2962 {"minute", (getter)time_minute},
2963 {"second", (getter)py_time_second},
2964 {"microsecond", (getter)time_microsecond},
2965 {"tzinfo", (getter)time_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00002966 {NULL}
2967};
2968
2969/*
2970 * Constructors.
2971 */
2972
Tim Peters37f39822003-01-10 03:49:02 +00002973static char *time_kws[] = {"hour", "minute", "second", "microsecond",
2974 "tzinfo", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002975
Tim Peters506be282003-01-31 22:27:17 +00002976/* __setstate__ isn't exposed. */
2977static PyObject *
2978time_setstate(PyDateTime_Time *self, PyObject *state)
2979{
2980 PyObject *basestate;
2981 PyObject *tzinfo = Py_None;
2982
2983 if (! PyArg_ParseTuple(state, "O!|O:__setstate__",
2984 &PyString_Type, &basestate,
2985 &tzinfo))
2986 return NULL;
2987 if (PyString_Size(basestate) != _PyDateTime_TIME_DATASIZE ||
2988 check_tzinfo_subclass(tzinfo) < 0) {
2989 PyErr_SetString(PyExc_TypeError,
2990 "bad argument to time.__setstate__");
2991 return NULL;
2992 }
2993 if (tzinfo != Py_None && ! HASTZINFO(self)) {
2994 PyErr_SetString(PyExc_ValueError, "time.__setstate__ can't "
2995 "add a non-None tzinfo to a time object that "
2996 "doesn't have one already");
2997 return NULL;
2998 }
2999 memcpy((char *)self->data,
3000 PyString_AsString(basestate),
3001 _PyDateTime_TIME_DATASIZE);
3002 self->hashcode = -1;
3003 if (HASTZINFO(self)) {
3004 Py_INCREF(tzinfo);
3005 Py_XDECREF(self->tzinfo);
3006 self->tzinfo = tzinfo;
3007 }
3008 Py_INCREF(Py_None);
3009 return Py_None;
3010}
Guido van Rossum177e41a2003-01-30 22:06:23 +00003011
Tim Peters2a799bf2002-12-16 20:18:38 +00003012static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003013time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003014{
3015 PyObject *self = NULL;
3016 int hour = 0;
3017 int minute = 0;
3018 int second = 0;
3019 int usecond = 0;
3020 PyObject *tzinfo = Py_None;
3021
Guido van Rossum177e41a2003-01-30 22:06:23 +00003022 /* Check for invocation from pickle with __getstate__ state */
3023 if (PyTuple_GET_SIZE(args) >= 1 &&
3024 PyTuple_GET_SIZE(args) <= 2 &&
3025 PyString_Check(PyTuple_GET_ITEM(args, 0)))
3026 {
3027 if (PyTuple_GET_SIZE(args) == 2)
3028 tzinfo = PyTuple_GET_ITEM(args, 1);
3029 self = new_time(0, 0, 0, 0, tzinfo);
3030 if (self != NULL) {
3031 PyObject *res = time_setstate(
3032 (PyDateTime_Time *)self, args);
3033 if (res == Py_None)
3034 Py_DECREF(res);
3035 else {
3036 Py_DECREF(self);
3037 self = NULL;
3038 }
3039 }
3040 return self;
3041 }
3042
Tim Peters37f39822003-01-10 03:49:02 +00003043 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO", time_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003044 &hour, &minute, &second, &usecond,
3045 &tzinfo)) {
3046 if (check_time_args(hour, minute, second, usecond) < 0)
3047 return NULL;
3048 if (check_tzinfo_subclass(tzinfo) < 0)
3049 return NULL;
Tim Peters37f39822003-01-10 03:49:02 +00003050 self = new_time(hour, minute, second, usecond, tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00003051 }
3052 return self;
3053}
3054
3055/*
3056 * Destructor.
3057 */
3058
3059static void
Tim Peters37f39822003-01-10 03:49:02 +00003060time_dealloc(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003061{
Tim Petersa032d2e2003-01-11 00:15:54 +00003062 if (HASTZINFO(self)) {
Tim Peters37f39822003-01-10 03:49:02 +00003063 Py_XDECREF(self->tzinfo);
Neal Norwitz8e914d92003-01-10 15:29:16 +00003064 }
Tim Peters2a799bf2002-12-16 20:18:38 +00003065 self->ob_type->tp_free((PyObject *)self);
3066}
3067
3068/*
Tim Peters855fe882002-12-22 03:43:39 +00003069 * Indirect access to tzinfo methods.
Tim Peters2a799bf2002-12-16 20:18:38 +00003070 */
3071
Tim Peters2a799bf2002-12-16 20:18:38 +00003072/* These are all METH_NOARGS, so don't need to check the arglist. */
3073static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003074time_utcoffset(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003075 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003076 "utcoffset", Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003077}
3078
3079static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003080time_dst(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003081 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003082 "dst", Py_None);
Tim Peters855fe882002-12-22 03:43:39 +00003083}
3084
3085static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003086time_tzname(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003087 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003088 Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003089}
3090
3091/*
Tim Peters37f39822003-01-10 03:49:02 +00003092 * Various ways to turn a time into a string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003093 */
3094
3095static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003096time_repr(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003097{
Tim Peters37f39822003-01-10 03:49:02 +00003098 char buffer[100];
3099 char *typename = self->ob_type->tp_name;
3100 int h = TIME_GET_HOUR(self);
3101 int m = TIME_GET_MINUTE(self);
3102 int s = TIME_GET_SECOND(self);
3103 int us = TIME_GET_MICROSECOND(self);
3104 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003105
Tim Peters37f39822003-01-10 03:49:02 +00003106 if (us)
3107 PyOS_snprintf(buffer, sizeof(buffer),
3108 "%s(%d, %d, %d, %d)", typename, h, m, s, us);
3109 else if (s)
3110 PyOS_snprintf(buffer, sizeof(buffer),
3111 "%s(%d, %d, %d)", typename, h, m, s);
3112 else
3113 PyOS_snprintf(buffer, sizeof(buffer),
3114 "%s(%d, %d)", typename, h, m);
3115 result = PyString_FromString(buffer);
Tim Petersa032d2e2003-01-11 00:15:54 +00003116 if (result != NULL && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +00003117 result = append_keyword_tzinfo(result, self->tzinfo);
3118 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003119}
3120
Tim Peters37f39822003-01-10 03:49:02 +00003121static PyObject *
3122time_str(PyDateTime_Time *self)
3123{
3124 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
3125}
Tim Peters2a799bf2002-12-16 20:18:38 +00003126
3127static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003128time_isoformat(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003129{
3130 char buf[100];
Tim Peters37f39822003-01-10 03:49:02 +00003131 PyObject *result;
3132 /* Reuse the time format code from the datetime type. */
3133 PyDateTime_DateTime datetime;
3134 PyDateTime_DateTime *pdatetime = &datetime;
Tim Peters2a799bf2002-12-16 20:18:38 +00003135
Tim Peters37f39822003-01-10 03:49:02 +00003136 /* Copy over just the time bytes. */
3137 memcpy(pdatetime->data + _PyDateTime_DATE_DATASIZE,
3138 self->data,
3139 _PyDateTime_TIME_DATASIZE);
3140
3141 isoformat_time(pdatetime, buf, sizeof(buf));
3142 result = PyString_FromString(buf);
Tim Petersa032d2e2003-01-11 00:15:54 +00003143 if (result == NULL || ! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00003144 return result;
3145
3146 /* We need to append the UTC offset. */
3147 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00003148 Py_None) < 0) {
Tim Peters2a799bf2002-12-16 20:18:38 +00003149 Py_DECREF(result);
3150 return NULL;
3151 }
3152 PyString_ConcatAndDel(&result, PyString_FromString(buf));
3153 return result;
3154}
3155
Tim Peters37f39822003-01-10 03:49:02 +00003156static PyObject *
3157time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3158{
3159 PyObject *result;
3160 PyObject *format;
3161 PyObject *tuple;
3162 static char *keywords[] = {"format", NULL};
3163
3164 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
3165 &PyString_Type, &format))
3166 return NULL;
3167
3168 /* Python's strftime does insane things with the year part of the
3169 * timetuple. The year is forced to (the otherwise nonsensical)
3170 * 1900 to worm around that.
3171 */
3172 tuple = Py_BuildValue("iiiiiiiii",
3173 1900, 0, 0, /* year, month, day */
3174 TIME_GET_HOUR(self),
3175 TIME_GET_MINUTE(self),
3176 TIME_GET_SECOND(self),
3177 0, 0, -1); /* weekday, daynum, dst */
3178 if (tuple == NULL)
3179 return NULL;
3180 assert(PyTuple_Size(tuple) == 9);
3181 result = wrap_strftime((PyObject *)self, format, tuple, Py_None);
3182 Py_DECREF(tuple);
3183 return result;
3184}
Tim Peters2a799bf2002-12-16 20:18:38 +00003185
3186/*
3187 * Miscellaneous methods.
3188 */
3189
Tim Peters37f39822003-01-10 03:49:02 +00003190/* This is more natural as a tp_compare, but doesn't work then: for whatever
3191 * reason, Python's try_3way_compare ignores tp_compare unless
3192 * PyInstance_Check returns true, but these aren't old-style classes.
3193 */
3194static PyObject *
3195time_richcompare(PyDateTime_Time *self, PyObject *other, int op)
3196{
3197 int diff;
3198 naivety n1, n2;
3199 int offset1, offset2;
3200
3201 if (! PyTime_Check(other)) {
3202 /* Stop this from falling back to address comparison. */
3203 PyErr_Format(PyExc_TypeError,
3204 "can't compare '%s' to '%s'",
3205 self->ob_type->tp_name,
3206 other->ob_type->tp_name);
3207 return NULL;
3208 }
3209 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1, Py_None,
3210 other, &offset2, &n2, Py_None) < 0)
3211 return NULL;
3212 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
3213 /* If they're both naive, or both aware and have the same offsets,
3214 * we get off cheap. Note that if they're both naive, offset1 ==
3215 * offset2 == 0 at this point.
3216 */
3217 if (n1 == n2 && offset1 == offset2) {
3218 diff = memcmp(self->data, ((PyDateTime_Time *)other)->data,
3219 _PyDateTime_TIME_DATASIZE);
3220 return diff_to_bool(diff, op);
3221 }
3222
3223 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
3224 assert(offset1 != offset2); /* else last "if" handled it */
3225 /* Convert everything except microseconds to seconds. These
3226 * can't overflow (no more than the # of seconds in 2 days).
3227 */
3228 offset1 = TIME_GET_HOUR(self) * 3600 +
3229 (TIME_GET_MINUTE(self) - offset1) * 60 +
3230 TIME_GET_SECOND(self);
3231 offset2 = TIME_GET_HOUR(other) * 3600 +
3232 (TIME_GET_MINUTE(other) - offset2) * 60 +
3233 TIME_GET_SECOND(other);
3234 diff = offset1 - offset2;
3235 if (diff == 0)
3236 diff = TIME_GET_MICROSECOND(self) -
3237 TIME_GET_MICROSECOND(other);
3238 return diff_to_bool(diff, op);
3239 }
3240
3241 assert(n1 != n2);
3242 PyErr_SetString(PyExc_TypeError,
3243 "can't compare offset-naive and "
3244 "offset-aware times");
3245 return NULL;
3246}
3247
3248static long
3249time_hash(PyDateTime_Time *self)
3250{
3251 if (self->hashcode == -1) {
3252 naivety n;
3253 int offset;
3254 PyObject *temp;
3255
3256 n = classify_utcoffset((PyObject *)self, Py_None, &offset);
3257 assert(n != OFFSET_UNKNOWN);
3258 if (n == OFFSET_ERROR)
3259 return -1;
3260
3261 /* Reduce this to a hash of another object. */
3262 if (offset == 0)
3263 temp = PyString_FromStringAndSize((char *)self->data,
3264 _PyDateTime_TIME_DATASIZE);
3265 else {
3266 int hour;
3267 int minute;
3268
3269 assert(n == OFFSET_AWARE);
Tim Petersa032d2e2003-01-11 00:15:54 +00003270 assert(HASTZINFO(self));
Tim Peters37f39822003-01-10 03:49:02 +00003271 hour = divmod(TIME_GET_HOUR(self) * 60 +
3272 TIME_GET_MINUTE(self) - offset,
3273 60,
3274 &minute);
3275 if (0 <= hour && hour < 24)
3276 temp = new_time(hour, minute,
3277 TIME_GET_SECOND(self),
3278 TIME_GET_MICROSECOND(self),
3279 Py_None);
3280 else
3281 temp = Py_BuildValue("iiii",
3282 hour, minute,
3283 TIME_GET_SECOND(self),
3284 TIME_GET_MICROSECOND(self));
3285 }
3286 if (temp != NULL) {
3287 self->hashcode = PyObject_Hash(temp);
3288 Py_DECREF(temp);
3289 }
3290 }
3291 return self->hashcode;
3292}
Tim Peters2a799bf2002-12-16 20:18:38 +00003293
Tim Peters12bf3392002-12-24 05:41:27 +00003294static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003295time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00003296{
3297 PyObject *clone;
3298 PyObject *tuple;
3299 int hh = TIME_GET_HOUR(self);
3300 int mm = TIME_GET_MINUTE(self);
3301 int ss = TIME_GET_SECOND(self);
3302 int us = TIME_GET_MICROSECOND(self);
Tim Petersa032d2e2003-01-11 00:15:54 +00003303 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00003304
3305 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO:replace",
Tim Peters37f39822003-01-10 03:49:02 +00003306 time_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00003307 &hh, &mm, &ss, &us, &tzinfo))
3308 return NULL;
3309 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
3310 if (tuple == NULL)
3311 return NULL;
Tim Peters37f39822003-01-10 03:49:02 +00003312 clone = time_new(self->ob_type, tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00003313 Py_DECREF(tuple);
3314 return clone;
3315}
3316
Tim Peters2a799bf2002-12-16 20:18:38 +00003317static int
Tim Peters37f39822003-01-10 03:49:02 +00003318time_nonzero(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003319{
3320 int offset;
3321 int none;
3322
3323 if (TIME_GET_SECOND(self) || TIME_GET_MICROSECOND(self)) {
3324 /* Since utcoffset is in whole minutes, nothing can
3325 * alter the conclusion that this is nonzero.
3326 */
3327 return 1;
3328 }
3329 offset = 0;
Tim Petersa032d2e2003-01-11 00:15:54 +00003330 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Petersbad8ff02002-12-30 20:52:32 +00003331 offset = call_utcoffset(self->tzinfo, Py_None, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00003332 if (offset == -1 && PyErr_Occurred())
3333 return -1;
3334 }
3335 return (TIME_GET_MINUTE(self) - offset + TIME_GET_HOUR(self)*60) != 0;
3336}
3337
Tim Peters371935f2003-02-01 01:52:50 +00003338/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003339
Tim Peters33e0f382003-01-10 02:05:14 +00003340/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003341 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
3342 * So it's a tuple in any (non-error) case.
3343 */
3344static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003345time_getstate(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003346{
3347 PyObject *basestate;
3348 PyObject *result = NULL;
3349
Tim Peters33e0f382003-01-10 02:05:14 +00003350 basestate = PyString_FromStringAndSize((char *)self->data,
3351 _PyDateTime_TIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00003352 if (basestate != NULL) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003353 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00003354 result = Py_BuildValue("(O)", basestate);
3355 else
3356 result = Py_BuildValue("OO", basestate, self->tzinfo);
3357 Py_DECREF(basestate);
3358 }
3359 return result;
3360}
3361
3362static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00003363time_reduce(PyDateTime_Time *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00003364{
Guido van Rossum177e41a2003-01-30 22:06:23 +00003365 return Py_BuildValue("(ON)", self->ob_type, time_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003366}
3367
Tim Peters37f39822003-01-10 03:49:02 +00003368static PyMethodDef time_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003369
Tim Peters37f39822003-01-10 03:49:02 +00003370 {"isoformat", (PyCFunction)time_isoformat, METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003371 PyDoc_STR("Return string in ISO 8601 format, HH:MM:SS[.mmmmmm]"
3372 "[+HH:MM].")},
3373
Tim Peters37f39822003-01-10 03:49:02 +00003374 {"strftime", (PyCFunction)time_strftime, METH_KEYWORDS,
3375 PyDoc_STR("format -> strftime() style string.")},
3376
3377 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003378 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
3379
Tim Peters37f39822003-01-10 03:49:02 +00003380 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003381 PyDoc_STR("Return self.tzinfo.tzname(self).")},
3382
Tim Peters37f39822003-01-10 03:49:02 +00003383 {"dst", (PyCFunction)time_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003384 PyDoc_STR("Return self.tzinfo.dst(self).")},
3385
Tim Peters37f39822003-01-10 03:49:02 +00003386 {"replace", (PyCFunction)time_replace, METH_KEYWORDS,
3387 PyDoc_STR("Return time with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00003388
Tim Peters37f39822003-01-10 03:49:02 +00003389 {"__getstate__", (PyCFunction)time_getstate, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003390 PyDoc_STR("__getstate__() -> state")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00003391
3392 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
3393 PyDoc_STR("__reduce__() -> (cls, state)")},
3394
Tim Peters2a799bf2002-12-16 20:18:38 +00003395 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003396};
3397
Tim Peters37f39822003-01-10 03:49:02 +00003398static char time_doc[] =
Tim Peters2a799bf2002-12-16 20:18:38 +00003399PyDoc_STR("Time type.");
3400
Tim Peters37f39822003-01-10 03:49:02 +00003401static PyNumberMethods time_as_number = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003402 0, /* nb_add */
3403 0, /* nb_subtract */
3404 0, /* nb_multiply */
3405 0, /* nb_divide */
3406 0, /* nb_remainder */
3407 0, /* nb_divmod */
3408 0, /* nb_power */
3409 0, /* nb_negative */
3410 0, /* nb_positive */
3411 0, /* nb_absolute */
Tim Peters37f39822003-01-10 03:49:02 +00003412 (inquiry)time_nonzero, /* nb_nonzero */
Tim Peters2a799bf2002-12-16 20:18:38 +00003413};
3414
Tim Peters37f39822003-01-10 03:49:02 +00003415statichere PyTypeObject PyDateTime_TimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003416 PyObject_HEAD_INIT(NULL)
3417 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00003418 "datetime.time", /* tp_name */
Tim Peters37f39822003-01-10 03:49:02 +00003419 sizeof(PyDateTime_Time), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00003420 0, /* tp_itemsize */
Tim Peters37f39822003-01-10 03:49:02 +00003421 (destructor)time_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003422 0, /* tp_print */
3423 0, /* tp_getattr */
3424 0, /* tp_setattr */
3425 0, /* tp_compare */
Tim Peters37f39822003-01-10 03:49:02 +00003426 (reprfunc)time_repr, /* tp_repr */
3427 &time_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00003428 0, /* tp_as_sequence */
3429 0, /* tp_as_mapping */
Tim Peters37f39822003-01-10 03:49:02 +00003430 (hashfunc)time_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00003431 0, /* tp_call */
Tim Peters37f39822003-01-10 03:49:02 +00003432 (reprfunc)time_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00003433 PyObject_GenericGetAttr, /* tp_getattro */
3434 0, /* tp_setattro */
3435 0, /* tp_as_buffer */
3436 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
3437 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters37f39822003-01-10 03:49:02 +00003438 time_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003439 0, /* tp_traverse */
3440 0, /* tp_clear */
Tim Peters37f39822003-01-10 03:49:02 +00003441 (richcmpfunc)time_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00003442 0, /* tp_weaklistoffset */
3443 0, /* tp_iter */
3444 0, /* tp_iternext */
Tim Peters37f39822003-01-10 03:49:02 +00003445 time_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00003446 0, /* tp_members */
Tim Peters37f39822003-01-10 03:49:02 +00003447 time_getset, /* tp_getset */
3448 0, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00003449 0, /* tp_dict */
3450 0, /* tp_descr_get */
3451 0, /* tp_descr_set */
3452 0, /* tp_dictoffset */
3453 0, /* tp_init */
3454 0, /* tp_alloc */
Tim Peters37f39822003-01-10 03:49:02 +00003455 time_new, /* tp_new */
Tim Peters2a799bf2002-12-16 20:18:38 +00003456 _PyObject_Del, /* tp_free */
3457};
3458
3459/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003460 * PyDateTime_DateTime implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003461 */
3462
Tim Petersa9bc1682003-01-11 03:39:11 +00003463/* Accessor properties. Properties for day, month, and year are inherited
3464 * from date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003465 */
3466
3467static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003468datetime_hour(PyDateTime_DateTime *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003469{
Tim Petersa9bc1682003-01-11 03:39:11 +00003470 return PyInt_FromLong(DATE_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003471}
3472
Tim Petersa9bc1682003-01-11 03:39:11 +00003473static PyObject *
3474datetime_minute(PyDateTime_DateTime *self, void *unused)
3475{
3476 return PyInt_FromLong(DATE_GET_MINUTE(self));
3477}
3478
3479static PyObject *
3480datetime_second(PyDateTime_DateTime *self, void *unused)
3481{
3482 return PyInt_FromLong(DATE_GET_SECOND(self));
3483}
3484
3485static PyObject *
3486datetime_microsecond(PyDateTime_DateTime *self, void *unused)
3487{
3488 return PyInt_FromLong(DATE_GET_MICROSECOND(self));
3489}
3490
3491static PyObject *
3492datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
3493{
3494 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3495 Py_INCREF(result);
3496 return result;
3497}
3498
3499static PyGetSetDef datetime_getset[] = {
3500 {"hour", (getter)datetime_hour},
3501 {"minute", (getter)datetime_minute},
3502 {"second", (getter)datetime_second},
3503 {"microsecond", (getter)datetime_microsecond},
3504 {"tzinfo", (getter)datetime_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003505 {NULL}
3506};
3507
3508/*
3509 * Constructors.
Tim Peters2a799bf2002-12-16 20:18:38 +00003510 */
3511
Tim Petersa9bc1682003-01-11 03:39:11 +00003512static char *datetime_kws[] = {
Tim Peters12bf3392002-12-24 05:41:27 +00003513 "year", "month", "day", "hour", "minute", "second",
3514 "microsecond", "tzinfo", NULL
3515};
3516
Tim Peters506be282003-01-31 22:27:17 +00003517/* __setstate__ isn't exposed. */
3518static PyObject *
3519datetime_setstate(PyDateTime_DateTime *self, PyObject *state)
3520{
3521 PyObject *basestate;
3522 PyObject *tzinfo = Py_None;
3523
3524 if (! PyArg_ParseTuple(state, "O!|O:__setstate__",
3525 &PyString_Type, &basestate,
3526 &tzinfo))
3527 return NULL;
3528 if (PyString_Size(basestate) != _PyDateTime_DATETIME_DATASIZE ||
3529 check_tzinfo_subclass(tzinfo) < 0) {
3530 PyErr_SetString(PyExc_TypeError,
3531 "bad argument to datetime.__setstate__");
3532 return NULL;
3533 }
3534 if (tzinfo != Py_None && ! HASTZINFO(self)) {
3535 PyErr_SetString(PyExc_ValueError, "datetime.__setstate__ "
3536 "can't add a non-None tzinfo to a datetime "
3537 "object that doesn't have one already");
3538 return NULL;
3539 }
3540 memcpy((char *)self->data,
3541 PyString_AsString(basestate),
3542 _PyDateTime_DATETIME_DATASIZE);
3543 self->hashcode = -1;
3544 if (HASTZINFO(self)) {
3545 Py_INCREF(tzinfo);
3546 Py_XDECREF(self->tzinfo);
3547 self->tzinfo = tzinfo;
3548 }
3549 Py_INCREF(Py_None);
3550 return Py_None;
3551}
Guido van Rossum177e41a2003-01-30 22:06:23 +00003552
Tim Peters2a799bf2002-12-16 20:18:38 +00003553static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003554datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003555{
3556 PyObject *self = NULL;
3557 int year;
3558 int month;
3559 int day;
3560 int hour = 0;
3561 int minute = 0;
3562 int second = 0;
3563 int usecond = 0;
3564 PyObject *tzinfo = Py_None;
3565
Guido van Rossum177e41a2003-01-30 22:06:23 +00003566 /* Check for invocation from pickle with __getstate__ state */
3567 if (PyTuple_GET_SIZE(args) >= 1 &&
3568 PyTuple_GET_SIZE(args) <= 2 &&
3569 PyString_Check(PyTuple_GET_ITEM(args, 0)))
3570 {
3571 if (PyTuple_GET_SIZE(args) == 2)
3572 tzinfo = PyTuple_GET_ITEM(args, 1);
3573 self = new_datetime(1, 1, 1, 0, 0, 0, 0, tzinfo);
3574 if (self != NULL) {
3575 PyObject *res = datetime_setstate(
3576 (PyDateTime_DateTime *)self, args);
3577 if (res == Py_None)
3578 Py_DECREF(res);
3579 else {
3580 Py_DECREF(self);
3581 self = NULL;
3582 }
3583 }
3584 return self;
3585 }
3586
Tim Petersa9bc1682003-01-11 03:39:11 +00003587 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO", datetime_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003588 &year, &month, &day, &hour, &minute,
3589 &second, &usecond, &tzinfo)) {
3590 if (check_date_args(year, month, day) < 0)
3591 return NULL;
3592 if (check_time_args(hour, minute, second, usecond) < 0)
3593 return NULL;
3594 if (check_tzinfo_subclass(tzinfo) < 0)
3595 return NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00003596 self = new_datetime(year, month, day,
3597 hour, minute, second, usecond,
3598 tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00003599 }
3600 return self;
3601}
3602
Tim Petersa9bc1682003-01-11 03:39:11 +00003603/* TM_FUNC is the shared type of localtime() and gmtime(). */
3604typedef struct tm *(*TM_FUNC)(const time_t *timer);
3605
3606/* Internal helper.
3607 * Build datetime from a time_t and a distinct count of microseconds.
3608 * Pass localtime or gmtime for f, to control the interpretation of timet.
3609 */
3610static PyObject *
3611datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
3612 PyObject *tzinfo)
3613{
3614 struct tm *tm;
3615 PyObject *result = NULL;
3616
3617 tm = f(&timet);
3618 if (tm) {
3619 /* The platform localtime/gmtime may insert leap seconds,
3620 * indicated by tm->tm_sec > 59. We don't care about them,
3621 * except to the extent that passing them on to the datetime
3622 * constructor would raise ValueError for a reason that
3623 * made no sense to the user.
3624 */
3625 if (tm->tm_sec > 59)
3626 tm->tm_sec = 59;
3627 result = PyObject_CallFunction(cls, "iiiiiiiO",
3628 tm->tm_year + 1900,
3629 tm->tm_mon + 1,
3630 tm->tm_mday,
3631 tm->tm_hour,
3632 tm->tm_min,
3633 tm->tm_sec,
3634 us,
3635 tzinfo);
3636 }
3637 else
3638 PyErr_SetString(PyExc_ValueError,
3639 "timestamp out of range for "
3640 "platform localtime()/gmtime() function");
3641 return result;
3642}
3643
3644/* Internal helper.
3645 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
3646 * to control the interpretation of the timestamp. Since a double doesn't
3647 * have enough bits to cover a datetime's full range of precision, it's
3648 * better to call datetime_from_timet_and_us provided you have a way
3649 * to get that much precision (e.g., C time() isn't good enough).
3650 */
3651static PyObject *
3652datetime_from_timestamp(PyObject *cls, TM_FUNC f, double timestamp,
3653 PyObject *tzinfo)
3654{
3655 time_t timet = (time_t)timestamp;
3656 double fraction = timestamp - (double)timet;
3657 int us = (int)round_to_long(fraction * 1e6);
3658
3659 return datetime_from_timet_and_us(cls, f, timet, us, tzinfo);
3660}
3661
3662/* Internal helper.
3663 * Build most accurate possible datetime for current time. Pass localtime or
3664 * gmtime for f as appropriate.
3665 */
3666static PyObject *
3667datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
3668{
3669#ifdef HAVE_GETTIMEOFDAY
3670 struct timeval t;
3671
3672#ifdef GETTIMEOFDAY_NO_TZ
3673 gettimeofday(&t);
3674#else
3675 gettimeofday(&t, (struct timezone *)NULL);
3676#endif
3677 return datetime_from_timet_and_us(cls, f, t.tv_sec, (int)t.tv_usec,
3678 tzinfo);
3679
3680#else /* ! HAVE_GETTIMEOFDAY */
3681 /* No flavor of gettimeofday exists on this platform. Python's
3682 * time.time() does a lot of other platform tricks to get the
3683 * best time it can on the platform, and we're not going to do
3684 * better than that (if we could, the better code would belong
3685 * in time.time()!) We're limited by the precision of a double,
3686 * though.
3687 */
3688 PyObject *time;
3689 double dtime;
3690
3691 time = time_time();
3692 if (time == NULL)
3693 return NULL;
3694 dtime = PyFloat_AsDouble(time);
3695 Py_DECREF(time);
3696 if (dtime == -1.0 && PyErr_Occurred())
3697 return NULL;
3698 return datetime_from_timestamp(cls, f, dtime, tzinfo);
3699#endif /* ! HAVE_GETTIMEOFDAY */
3700}
3701
Tim Peters2a799bf2002-12-16 20:18:38 +00003702/* Return best possible local time -- this isn't constrained by the
3703 * precision of a timestamp.
3704 */
3705static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003706datetime_now(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003707{
Tim Peters10cadce2003-01-23 19:58:02 +00003708 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003709 PyObject *tzinfo = Py_None;
Tim Peters10cadce2003-01-23 19:58:02 +00003710 static char *keywords[] = {"tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003711
Tim Peters10cadce2003-01-23 19:58:02 +00003712 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:now", keywords,
3713 &tzinfo))
3714 return NULL;
3715 if (check_tzinfo_subclass(tzinfo) < 0)
3716 return NULL;
3717
3718 self = datetime_best_possible(cls,
3719 tzinfo == Py_None ? localtime : gmtime,
3720 tzinfo);
3721 if (self != NULL && tzinfo != Py_None) {
3722 /* Convert UTC to tzinfo's zone. */
3723 PyObject *temp = self;
Tim Peters2a44a8d2003-01-23 20:53:10 +00003724 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
Tim Peters10cadce2003-01-23 19:58:02 +00003725 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003726 }
3727 return self;
3728}
3729
Tim Petersa9bc1682003-01-11 03:39:11 +00003730/* Return best possible UTC time -- this isn't constrained by the
3731 * precision of a timestamp.
3732 */
3733static PyObject *
3734datetime_utcnow(PyObject *cls, PyObject *dummy)
3735{
3736 return datetime_best_possible(cls, gmtime, Py_None);
3737}
3738
Tim Peters2a799bf2002-12-16 20:18:38 +00003739/* Return new local datetime from timestamp (Python timestamp -- a double). */
3740static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003741datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003742{
Tim Peters2a44a8d2003-01-23 20:53:10 +00003743 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003744 double timestamp;
3745 PyObject *tzinfo = Py_None;
Tim Peters2a44a8d2003-01-23 20:53:10 +00003746 static char *keywords[] = {"timestamp", "tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003747
Tim Peters2a44a8d2003-01-23 20:53:10 +00003748 if (! PyArg_ParseTupleAndKeywords(args, kw, "d|O:fromtimestamp",
3749 keywords, &timestamp, &tzinfo))
3750 return NULL;
3751 if (check_tzinfo_subclass(tzinfo) < 0)
3752 return NULL;
3753
3754 self = datetime_from_timestamp(cls,
3755 tzinfo == Py_None ? localtime : gmtime,
3756 timestamp,
3757 tzinfo);
3758 if (self != NULL && tzinfo != Py_None) {
3759 /* Convert UTC to tzinfo's zone. */
3760 PyObject *temp = self;
3761 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3762 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003763 }
3764 return self;
3765}
3766
Tim Petersa9bc1682003-01-11 03:39:11 +00003767/* Return new UTC datetime from timestamp (Python timestamp -- a double). */
3768static PyObject *
3769datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
3770{
3771 double timestamp;
3772 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003773
Tim Petersa9bc1682003-01-11 03:39:11 +00003774 if (PyArg_ParseTuple(args, "d:utcfromtimestamp", &timestamp))
3775 result = datetime_from_timestamp(cls, gmtime, timestamp,
3776 Py_None);
3777 return result;
3778}
3779
3780/* Return new datetime from date/datetime and time arguments. */
3781static PyObject *
3782datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
3783{
3784 static char *keywords[] = {"date", "time", NULL};
3785 PyObject *date;
3786 PyObject *time;
3787 PyObject *result = NULL;
3788
3789 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!:combine", keywords,
3790 &PyDateTime_DateType, &date,
3791 &PyDateTime_TimeType, &time)) {
3792 PyObject *tzinfo = Py_None;
3793
3794 if (HASTZINFO(time))
3795 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
3796 result = PyObject_CallFunction(cls, "iiiiiiiO",
3797 GET_YEAR(date),
3798 GET_MONTH(date),
3799 GET_DAY(date),
3800 TIME_GET_HOUR(time),
3801 TIME_GET_MINUTE(time),
3802 TIME_GET_SECOND(time),
3803 TIME_GET_MICROSECOND(time),
3804 tzinfo);
3805 }
3806 return result;
3807}
Tim Peters2a799bf2002-12-16 20:18:38 +00003808
3809/*
3810 * Destructor.
3811 */
3812
3813static void
Tim Petersa9bc1682003-01-11 03:39:11 +00003814datetime_dealloc(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003815{
Tim Petersa9bc1682003-01-11 03:39:11 +00003816 if (HASTZINFO(self)) {
3817 Py_XDECREF(self->tzinfo);
3818 }
Tim Peters2a799bf2002-12-16 20:18:38 +00003819 self->ob_type->tp_free((PyObject *)self);
3820}
3821
3822/*
3823 * Indirect access to tzinfo methods.
3824 */
3825
Tim Peters2a799bf2002-12-16 20:18:38 +00003826/* These are all METH_NOARGS, so don't need to check the arglist. */
3827static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003828datetime_utcoffset(PyDateTime_DateTime *self, PyObject *unused) {
3829 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3830 "utcoffset", (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003831}
3832
3833static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003834datetime_dst(PyDateTime_DateTime *self, PyObject *unused) {
3835 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3836 "dst", (PyObject *)self);
Tim Peters855fe882002-12-22 03:43:39 +00003837}
3838
3839static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003840datetime_tzname(PyDateTime_DateTime *self, PyObject *unused) {
3841 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
3842 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003843}
3844
3845/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003846 * datetime arithmetic.
Tim Peters2a799bf2002-12-16 20:18:38 +00003847 */
3848
Tim Petersa9bc1682003-01-11 03:39:11 +00003849/* factor must be 1 (to add) or -1 (to subtract). The result inherits
3850 * the tzinfo state of date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003851 */
3852static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003853add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
3854 int factor)
Tim Peters2a799bf2002-12-16 20:18:38 +00003855{
Tim Petersa9bc1682003-01-11 03:39:11 +00003856 /* Note that the C-level additions can't overflow, because of
3857 * invariant bounds on the member values.
3858 */
3859 int year = GET_YEAR(date);
3860 int month = GET_MONTH(date);
3861 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
3862 int hour = DATE_GET_HOUR(date);
3863 int minute = DATE_GET_MINUTE(date);
3864 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
3865 int microsecond = DATE_GET_MICROSECOND(date) +
3866 GET_TD_MICROSECONDS(delta) * factor;
Tim Peters2a799bf2002-12-16 20:18:38 +00003867
Tim Petersa9bc1682003-01-11 03:39:11 +00003868 assert(factor == 1 || factor == -1);
3869 if (normalize_datetime(&year, &month, &day,
3870 &hour, &minute, &second, &microsecond) < 0)
3871 return NULL;
3872 else
3873 return new_datetime(year, month, day,
3874 hour, minute, second, microsecond,
3875 HASTZINFO(date) ? date->tzinfo : Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003876}
3877
3878static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003879datetime_add(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003880{
Tim Petersa9bc1682003-01-11 03:39:11 +00003881 if (PyDateTime_Check(left)) {
3882 /* datetime + ??? */
3883 if (PyDelta_Check(right))
3884 /* datetime + delta */
3885 return add_datetime_timedelta(
3886 (PyDateTime_DateTime *)left,
3887 (PyDateTime_Delta *)right,
3888 1);
3889 }
3890 else if (PyDelta_Check(left)) {
3891 /* delta + datetime */
3892 return add_datetime_timedelta((PyDateTime_DateTime *) right,
3893 (PyDateTime_Delta *) left,
3894 1);
3895 }
3896 Py_INCREF(Py_NotImplemented);
3897 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00003898}
3899
3900static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003901datetime_subtract(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003902{
3903 PyObject *result = Py_NotImplemented;
3904
3905 if (PyDateTime_Check(left)) {
3906 /* datetime - ??? */
3907 if (PyDateTime_Check(right)) {
3908 /* datetime - datetime */
3909 naivety n1, n2;
3910 int offset1, offset2;
Tim Petersa9bc1682003-01-11 03:39:11 +00003911 int delta_d, delta_s, delta_us;
Tim Peters2a799bf2002-12-16 20:18:38 +00003912
Tim Peterse39a80c2002-12-30 21:28:52 +00003913 if (classify_two_utcoffsets(left, &offset1, &n1, left,
3914 right, &offset2, &n2,
3915 right) < 0)
Tim Peters00237032002-12-27 02:21:51 +00003916 return NULL;
Tim Peters8702d5f2002-12-27 02:26:16 +00003917 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
Tim Peters2a799bf2002-12-16 20:18:38 +00003918 if (n1 != n2) {
3919 PyErr_SetString(PyExc_TypeError,
3920 "can't subtract offset-naive and "
3921 "offset-aware datetimes");
3922 return NULL;
3923 }
Tim Petersa9bc1682003-01-11 03:39:11 +00003924 delta_d = ymd_to_ord(GET_YEAR(left),
3925 GET_MONTH(left),
3926 GET_DAY(left)) -
3927 ymd_to_ord(GET_YEAR(right),
3928 GET_MONTH(right),
3929 GET_DAY(right));
3930 /* These can't overflow, since the values are
3931 * normalized. At most this gives the number of
3932 * seconds in one day.
3933 */
3934 delta_s = (DATE_GET_HOUR(left) -
3935 DATE_GET_HOUR(right)) * 3600 +
3936 (DATE_GET_MINUTE(left) -
3937 DATE_GET_MINUTE(right)) * 60 +
3938 (DATE_GET_SECOND(left) -
3939 DATE_GET_SECOND(right));
3940 delta_us = DATE_GET_MICROSECOND(left) -
3941 DATE_GET_MICROSECOND(right);
Tim Peters2a799bf2002-12-16 20:18:38 +00003942 /* (left - offset1) - (right - offset2) =
3943 * (left - right) + (offset2 - offset1)
3944 */
Tim Petersa9bc1682003-01-11 03:39:11 +00003945 delta_s += (offset2 - offset1) * 60;
3946 result = new_delta(delta_d, delta_s, delta_us, 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00003947 }
3948 else if (PyDelta_Check(right)) {
Tim Petersa9bc1682003-01-11 03:39:11 +00003949 /* datetime - delta */
3950 result = add_datetime_timedelta(
Tim Peters2a799bf2002-12-16 20:18:38 +00003951 (PyDateTime_DateTime *)left,
Tim Petersa9bc1682003-01-11 03:39:11 +00003952 (PyDateTime_Delta *)right,
3953 -1);
Tim Peters2a799bf2002-12-16 20:18:38 +00003954 }
3955 }
3956
3957 if (result == Py_NotImplemented)
3958 Py_INCREF(result);
3959 return result;
3960}
3961
3962/* Various ways to turn a datetime into a string. */
3963
3964static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003965datetime_repr(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003966{
Tim Petersa9bc1682003-01-11 03:39:11 +00003967 char buffer[1000];
3968 char *typename = self->ob_type->tp_name;
3969 PyObject *baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00003970
Tim Petersa9bc1682003-01-11 03:39:11 +00003971 if (DATE_GET_MICROSECOND(self)) {
3972 PyOS_snprintf(buffer, sizeof(buffer),
3973 "%s(%d, %d, %d, %d, %d, %d, %d)",
3974 typename,
3975 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
3976 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
3977 DATE_GET_SECOND(self),
3978 DATE_GET_MICROSECOND(self));
3979 }
3980 else if (DATE_GET_SECOND(self)) {
3981 PyOS_snprintf(buffer, sizeof(buffer),
3982 "%s(%d, %d, %d, %d, %d, %d)",
3983 typename,
3984 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
3985 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
3986 DATE_GET_SECOND(self));
3987 }
3988 else {
3989 PyOS_snprintf(buffer, sizeof(buffer),
3990 "%s(%d, %d, %d, %d, %d)",
3991 typename,
3992 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
3993 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
3994 }
3995 baserepr = PyString_FromString(buffer);
3996 if (baserepr == NULL || ! HASTZINFO(self))
3997 return baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00003998 return append_keyword_tzinfo(baserepr, self->tzinfo);
3999}
4000
Tim Petersa9bc1682003-01-11 03:39:11 +00004001static PyObject *
4002datetime_str(PyDateTime_DateTime *self)
4003{
4004 return PyObject_CallMethod((PyObject *)self, "isoformat", "(s)", " ");
4005}
Tim Peters2a799bf2002-12-16 20:18:38 +00004006
4007static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004008datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004009{
Tim Petersa9bc1682003-01-11 03:39:11 +00004010 char sep = 'T';
4011 static char *keywords[] = {"sep", NULL};
4012 char buffer[100];
4013 char *cp;
4014 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004015
Tim Petersa9bc1682003-01-11 03:39:11 +00004016 if (!PyArg_ParseTupleAndKeywords(args, kw, "|c:isoformat", keywords,
4017 &sep))
4018 return NULL;
4019 cp = isoformat_date((PyDateTime_Date *)self, buffer, sizeof(buffer));
4020 assert(cp != NULL);
4021 *cp++ = sep;
4022 isoformat_time(self, cp, sizeof(buffer) - (cp - buffer));
4023 result = PyString_FromString(buffer);
4024 if (result == NULL || ! HASTZINFO(self))
Tim Peters2a799bf2002-12-16 20:18:38 +00004025 return result;
4026
4027 /* We need to append the UTC offset. */
Tim Petersa9bc1682003-01-11 03:39:11 +00004028 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
Tim Peters2a799bf2002-12-16 20:18:38 +00004029 (PyObject *)self) < 0) {
4030 Py_DECREF(result);
4031 return NULL;
4032 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004033 PyString_ConcatAndDel(&result, PyString_FromString(buffer));
Tim Peters2a799bf2002-12-16 20:18:38 +00004034 return result;
4035}
4036
Tim Petersa9bc1682003-01-11 03:39:11 +00004037static PyObject *
4038datetime_ctime(PyDateTime_DateTime *self)
4039{
4040 return format_ctime((PyDateTime_Date *)self,
4041 DATE_GET_HOUR(self),
4042 DATE_GET_MINUTE(self),
4043 DATE_GET_SECOND(self));
4044}
4045
Tim Peters2a799bf2002-12-16 20:18:38 +00004046/* Miscellaneous methods. */
4047
Tim Petersa9bc1682003-01-11 03:39:11 +00004048/* This is more natural as a tp_compare, but doesn't work then: for whatever
4049 * reason, Python's try_3way_compare ignores tp_compare unless
4050 * PyInstance_Check returns true, but these aren't old-style classes.
4051 */
4052static PyObject *
4053datetime_richcompare(PyDateTime_DateTime *self, PyObject *other, int op)
4054{
4055 int diff;
4056 naivety n1, n2;
4057 int offset1, offset2;
4058
4059 if (! PyDateTime_Check(other)) {
Tim Peters8d81a012003-01-24 22:36:34 +00004060 if (PyObject_HasAttrString(other, "timetuple")) {
4061 /* A hook for other kinds of datetime objects. */
4062 Py_INCREF(Py_NotImplemented);
4063 return Py_NotImplemented;
4064 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004065 /* Stop this from falling back to address comparison. */
4066 PyErr_Format(PyExc_TypeError,
4067 "can't compare '%s' to '%s'",
4068 self->ob_type->tp_name,
4069 other->ob_type->tp_name);
4070 return NULL;
4071 }
4072
4073 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1,
4074 (PyObject *)self,
4075 other, &offset2, &n2,
4076 other) < 0)
4077 return NULL;
4078 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
4079 /* If they're both naive, or both aware and have the same offsets,
4080 * we get off cheap. Note that if they're both naive, offset1 ==
4081 * offset2 == 0 at this point.
4082 */
4083 if (n1 == n2 && offset1 == offset2) {
4084 diff = memcmp(self->data, ((PyDateTime_DateTime *)other)->data,
4085 _PyDateTime_DATETIME_DATASIZE);
4086 return diff_to_bool(diff, op);
4087 }
4088
4089 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
4090 PyDateTime_Delta *delta;
4091
4092 assert(offset1 != offset2); /* else last "if" handled it */
4093 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
4094 other);
4095 if (delta == NULL)
4096 return NULL;
4097 diff = GET_TD_DAYS(delta);
4098 if (diff == 0)
4099 diff = GET_TD_SECONDS(delta) |
4100 GET_TD_MICROSECONDS(delta);
4101 Py_DECREF(delta);
4102 return diff_to_bool(diff, op);
4103 }
4104
4105 assert(n1 != n2);
4106 PyErr_SetString(PyExc_TypeError,
4107 "can't compare offset-naive and "
4108 "offset-aware datetimes");
4109 return NULL;
4110}
4111
4112static long
4113datetime_hash(PyDateTime_DateTime *self)
4114{
4115 if (self->hashcode == -1) {
4116 naivety n;
4117 int offset;
4118 PyObject *temp;
4119
4120 n = classify_utcoffset((PyObject *)self, (PyObject *)self,
4121 &offset);
4122 assert(n != OFFSET_UNKNOWN);
4123 if (n == OFFSET_ERROR)
4124 return -1;
4125
4126 /* Reduce this to a hash of another object. */
4127 if (n == OFFSET_NAIVE)
4128 temp = PyString_FromStringAndSize(
4129 (char *)self->data,
4130 _PyDateTime_DATETIME_DATASIZE);
4131 else {
4132 int days;
4133 int seconds;
4134
4135 assert(n == OFFSET_AWARE);
4136 assert(HASTZINFO(self));
4137 days = ymd_to_ord(GET_YEAR(self),
4138 GET_MONTH(self),
4139 GET_DAY(self));
4140 seconds = DATE_GET_HOUR(self) * 3600 +
4141 (DATE_GET_MINUTE(self) - offset) * 60 +
4142 DATE_GET_SECOND(self);
4143 temp = new_delta(days,
4144 seconds,
4145 DATE_GET_MICROSECOND(self),
4146 1);
4147 }
4148 if (temp != NULL) {
4149 self->hashcode = PyObject_Hash(temp);
4150 Py_DECREF(temp);
4151 }
4152 }
4153 return self->hashcode;
4154}
Tim Peters2a799bf2002-12-16 20:18:38 +00004155
4156static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004157datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00004158{
4159 PyObject *clone;
4160 PyObject *tuple;
4161 int y = GET_YEAR(self);
4162 int m = GET_MONTH(self);
4163 int d = GET_DAY(self);
4164 int hh = DATE_GET_HOUR(self);
4165 int mm = DATE_GET_MINUTE(self);
4166 int ss = DATE_GET_SECOND(self);
4167 int us = DATE_GET_MICROSECOND(self);
Tim Petersa9bc1682003-01-11 03:39:11 +00004168 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00004169
4170 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO:replace",
Tim Petersa9bc1682003-01-11 03:39:11 +00004171 datetime_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00004172 &y, &m, &d, &hh, &mm, &ss, &us,
4173 &tzinfo))
4174 return NULL;
4175 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
4176 if (tuple == NULL)
4177 return NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00004178 clone = datetime_new(self->ob_type, tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00004179 Py_DECREF(tuple);
4180 return clone;
4181}
4182
4183static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004184datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters80475bb2002-12-25 07:40:55 +00004185{
Tim Peters52dcce22003-01-23 16:36:11 +00004186 int y, m, d, hh, mm, ss, us;
Tim Peters521fc152002-12-31 17:36:56 +00004187 PyObject *result;
Tim Peters52dcce22003-01-23 16:36:11 +00004188 int offset, none;
Tim Peters521fc152002-12-31 17:36:56 +00004189
Tim Peters80475bb2002-12-25 07:40:55 +00004190 PyObject *tzinfo;
4191 static char *keywords[] = {"tz", NULL};
4192
Tim Peters52dcce22003-01-23 16:36:11 +00004193 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:astimezone", keywords,
4194 &PyDateTime_TZInfoType, &tzinfo))
Tim Peters80475bb2002-12-25 07:40:55 +00004195 return NULL;
4196
Tim Peters52dcce22003-01-23 16:36:11 +00004197 if (!HASTZINFO(self) || self->tzinfo == Py_None)
4198 goto NeedAware;
Tim Peters521fc152002-12-31 17:36:56 +00004199
Tim Peters52dcce22003-01-23 16:36:11 +00004200 /* Conversion to self's own time zone is a NOP. */
4201 if (self->tzinfo == tzinfo) {
4202 Py_INCREF(self);
4203 return (PyObject *)self;
Tim Peters710fb152003-01-02 19:35:54 +00004204 }
Tim Peters521fc152002-12-31 17:36:56 +00004205
Tim Peters52dcce22003-01-23 16:36:11 +00004206 /* Convert self to UTC. */
4207 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4208 if (offset == -1 && PyErr_Occurred())
4209 return NULL;
4210 if (none)
4211 goto NeedAware;
Tim Petersf3615152003-01-01 21:51:37 +00004212
Tim Peters52dcce22003-01-23 16:36:11 +00004213 y = GET_YEAR(self);
4214 m = GET_MONTH(self);
4215 d = GET_DAY(self);
4216 hh = DATE_GET_HOUR(self);
4217 mm = DATE_GET_MINUTE(self);
4218 ss = DATE_GET_SECOND(self);
4219 us = DATE_GET_MICROSECOND(self);
4220
4221 mm -= offset;
Tim Petersf3615152003-01-01 21:51:37 +00004222 if ((mm < 0 || mm >= 60) &&
4223 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Peters52dcce22003-01-23 16:36:11 +00004224 return NULL;
4225
4226 /* Attach new tzinfo and let fromutc() do the rest. */
4227 result = new_datetime(y, m, d, hh, mm, ss, us, tzinfo);
4228 if (result != NULL) {
4229 PyObject *temp = result;
4230
4231 result = PyObject_CallMethod(tzinfo, "fromutc", "O", temp);
4232 Py_DECREF(temp);
4233 }
Tim Petersadf64202003-01-04 06:03:15 +00004234 return result;
Tim Peters521fc152002-12-31 17:36:56 +00004235
Tim Peters52dcce22003-01-23 16:36:11 +00004236NeedAware:
4237 PyErr_SetString(PyExc_ValueError, "astimezone() cannot be applied to "
4238 "a naive datetime");
Tim Peters521fc152002-12-31 17:36:56 +00004239 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00004240}
4241
4242static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004243datetime_timetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004244{
4245 int dstflag = -1;
4246
Tim Petersa9bc1682003-01-11 03:39:11 +00004247 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004248 int none;
4249
4250 dstflag = call_dst(self->tzinfo, (PyObject *)self, &none);
4251 if (dstflag == -1 && PyErr_Occurred())
4252 return NULL;
4253
4254 if (none)
4255 dstflag = -1;
4256 else if (dstflag != 0)
4257 dstflag = 1;
4258
4259 }
4260 return build_struct_time(GET_YEAR(self),
4261 GET_MONTH(self),
4262 GET_DAY(self),
4263 DATE_GET_HOUR(self),
4264 DATE_GET_MINUTE(self),
4265 DATE_GET_SECOND(self),
4266 dstflag);
4267}
4268
4269static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004270datetime_getdate(PyDateTime_DateTime *self)
4271{
4272 return new_date(GET_YEAR(self),
4273 GET_MONTH(self),
4274 GET_DAY(self));
4275}
4276
4277static PyObject *
4278datetime_gettime(PyDateTime_DateTime *self)
4279{
4280 return new_time(DATE_GET_HOUR(self),
4281 DATE_GET_MINUTE(self),
4282 DATE_GET_SECOND(self),
4283 DATE_GET_MICROSECOND(self),
4284 Py_None);
4285}
4286
4287static PyObject *
4288datetime_gettimetz(PyDateTime_DateTime *self)
4289{
4290 return new_time(DATE_GET_HOUR(self),
4291 DATE_GET_MINUTE(self),
4292 DATE_GET_SECOND(self),
4293 DATE_GET_MICROSECOND(self),
4294 HASTZINFO(self) ? self->tzinfo : Py_None);
4295}
4296
4297static PyObject *
4298datetime_utctimetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004299{
4300 int y = GET_YEAR(self);
4301 int m = GET_MONTH(self);
4302 int d = GET_DAY(self);
4303 int hh = DATE_GET_HOUR(self);
4304 int mm = DATE_GET_MINUTE(self);
4305 int ss = DATE_GET_SECOND(self);
4306 int us = 0; /* microseconds are ignored in a timetuple */
4307 int offset = 0;
4308
Tim Petersa9bc1682003-01-11 03:39:11 +00004309 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004310 int none;
4311
4312 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4313 if (offset == -1 && PyErr_Occurred())
4314 return NULL;
4315 }
4316 /* Even if offset is 0, don't call timetuple() -- tm_isdst should be
4317 * 0 in a UTC timetuple regardless of what dst() says.
4318 */
4319 if (offset) {
4320 /* Subtract offset minutes & normalize. */
4321 int stat;
4322
4323 mm -= offset;
4324 stat = normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us);
4325 if (stat < 0) {
4326 /* At the edges, it's possible we overflowed
4327 * beyond MINYEAR or MAXYEAR.
4328 */
4329 if (PyErr_ExceptionMatches(PyExc_OverflowError))
4330 PyErr_Clear();
4331 else
4332 return NULL;
4333 }
4334 }
4335 return build_struct_time(y, m, d, hh, mm, ss, 0);
4336}
4337
Tim Peters371935f2003-02-01 01:52:50 +00004338/* Pickle support, a simple use of __reduce__. */
Tim Peters33e0f382003-01-10 02:05:14 +00004339
Tim Petersa9bc1682003-01-11 03:39:11 +00004340/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004341 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4342 * So it's a tuple in any (non-error) case.
4343 */
4344static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004345datetime_getstate(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004346{
4347 PyObject *basestate;
4348 PyObject *result = NULL;
4349
Tim Peters33e0f382003-01-10 02:05:14 +00004350 basestate = PyString_FromStringAndSize((char *)self->data,
4351 _PyDateTime_DATETIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00004352 if (basestate != NULL) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004353 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00004354 result = Py_BuildValue("(O)", basestate);
4355 else
4356 result = Py_BuildValue("OO", basestate, self->tzinfo);
4357 Py_DECREF(basestate);
4358 }
4359 return result;
4360}
4361
4362static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00004363datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00004364{
Guido van Rossum177e41a2003-01-30 22:06:23 +00004365 return Py_BuildValue("(ON)", self->ob_type, datetime_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00004366}
4367
Tim Petersa9bc1682003-01-11 03:39:11 +00004368static PyMethodDef datetime_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004369
Tim Peters2a799bf2002-12-16 20:18:38 +00004370 /* Class methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00004371
Tim Petersa9bc1682003-01-11 03:39:11 +00004372 {"now", (PyCFunction)datetime_now,
Tim Peters2a799bf2002-12-16 20:18:38 +00004373 METH_KEYWORDS | METH_CLASS,
Neal Norwitz2fbe5372003-01-23 21:09:05 +00004374 PyDoc_STR("[tz] -> new datetime with tz's local day and time.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004375
Tim Petersa9bc1682003-01-11 03:39:11 +00004376 {"utcnow", (PyCFunction)datetime_utcnow,
4377 METH_NOARGS | METH_CLASS,
4378 PyDoc_STR("Return a new datetime representing UTC day and time.")},
4379
4380 {"fromtimestamp", (PyCFunction)datetime_fromtimestamp,
Tim Peters2a799bf2002-12-16 20:18:38 +00004381 METH_KEYWORDS | METH_CLASS,
Tim Peters2a44a8d2003-01-23 20:53:10 +00004382 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004383
Tim Petersa9bc1682003-01-11 03:39:11 +00004384 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
4385 METH_VARARGS | METH_CLASS,
4386 PyDoc_STR("timestamp -> UTC datetime from a POSIX timestamp "
4387 "(like time.time()).")},
4388
4389 {"combine", (PyCFunction)datetime_combine,
4390 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4391 PyDoc_STR("date, time -> datetime with same date and time fields")},
4392
Tim Peters2a799bf2002-12-16 20:18:38 +00004393 /* Instance methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00004394
Tim Petersa9bc1682003-01-11 03:39:11 +00004395 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
4396 PyDoc_STR("Return date object with same year, month and day.")},
4397
4398 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
4399 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
4400
4401 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
4402 PyDoc_STR("Return time object with same time and tzinfo.")},
4403
4404 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
4405 PyDoc_STR("Return ctime() style string.")},
4406
4407 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004408 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
4409
Tim Petersa9bc1682003-01-11 03:39:11 +00004410 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004411 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
4412
Tim Petersa9bc1682003-01-11 03:39:11 +00004413 {"isoformat", (PyCFunction)datetime_isoformat, METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004414 PyDoc_STR("[sep] -> string in ISO 8601 format, "
4415 "YYYY-MM-DDTHH:MM:SS[.mmmmmm][+HH:MM].\n\n"
4416 "sep is used to separate the year from the time, and "
4417 "defaults to 'T'.")},
4418
Tim Petersa9bc1682003-01-11 03:39:11 +00004419 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004420 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
4421
Tim Petersa9bc1682003-01-11 03:39:11 +00004422 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004423 PyDoc_STR("Return self.tzinfo.tzname(self).")},
4424
Tim Petersa9bc1682003-01-11 03:39:11 +00004425 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004426 PyDoc_STR("Return self.tzinfo.dst(self).")},
4427
Tim Petersa9bc1682003-01-11 03:39:11 +00004428 {"replace", (PyCFunction)datetime_replace, METH_KEYWORDS,
4429 PyDoc_STR("Return datetime with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00004430
Tim Petersa9bc1682003-01-11 03:39:11 +00004431 {"astimezone", (PyCFunction)datetime_astimezone, METH_KEYWORDS,
Tim Peters80475bb2002-12-25 07:40:55 +00004432 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
4433
Tim Petersa9bc1682003-01-11 03:39:11 +00004434 {"__getstate__", (PyCFunction)datetime_getstate, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004435 PyDoc_STR("__getstate__() -> state")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00004436
4437 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
4438 PyDoc_STR("__reduce__() -> (cls, state)")},
4439
Tim Peters2a799bf2002-12-16 20:18:38 +00004440 {NULL, NULL}
4441};
4442
Tim Petersa9bc1682003-01-11 03:39:11 +00004443static char datetime_doc[] =
Tim Peters2a799bf2002-12-16 20:18:38 +00004444PyDoc_STR("date/time type.");
4445
Tim Petersa9bc1682003-01-11 03:39:11 +00004446static PyNumberMethods datetime_as_number = {
4447 datetime_add, /* nb_add */
4448 datetime_subtract, /* nb_subtract */
Tim Peters2a799bf2002-12-16 20:18:38 +00004449 0, /* nb_multiply */
4450 0, /* nb_divide */
4451 0, /* nb_remainder */
4452 0, /* nb_divmod */
4453 0, /* nb_power */
4454 0, /* nb_negative */
4455 0, /* nb_positive */
4456 0, /* nb_absolute */
4457 0, /* nb_nonzero */
4458};
4459
Tim Petersa9bc1682003-01-11 03:39:11 +00004460statichere PyTypeObject PyDateTime_DateTimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004461 PyObject_HEAD_INIT(NULL)
4462 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00004463 "datetime.datetime", /* tp_name */
Tim Petersa9bc1682003-01-11 03:39:11 +00004464 sizeof(PyDateTime_DateTime), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00004465 0, /* tp_itemsize */
Tim Petersa9bc1682003-01-11 03:39:11 +00004466 (destructor)datetime_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004467 0, /* tp_print */
4468 0, /* tp_getattr */
4469 0, /* tp_setattr */
4470 0, /* tp_compare */
Tim Petersa9bc1682003-01-11 03:39:11 +00004471 (reprfunc)datetime_repr, /* tp_repr */
4472 &datetime_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00004473 0, /* tp_as_sequence */
4474 0, /* tp_as_mapping */
Tim Petersa9bc1682003-01-11 03:39:11 +00004475 (hashfunc)datetime_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00004476 0, /* tp_call */
Tim Petersa9bc1682003-01-11 03:39:11 +00004477 (reprfunc)datetime_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00004478 PyObject_GenericGetAttr, /* tp_getattro */
4479 0, /* tp_setattro */
4480 0, /* tp_as_buffer */
4481 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
4482 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Petersa9bc1682003-01-11 03:39:11 +00004483 datetime_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004484 0, /* tp_traverse */
4485 0, /* tp_clear */
Tim Petersa9bc1682003-01-11 03:39:11 +00004486 (richcmpfunc)datetime_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00004487 0, /* tp_weaklistoffset */
4488 0, /* tp_iter */
4489 0, /* tp_iternext */
Tim Petersa9bc1682003-01-11 03:39:11 +00004490 datetime_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00004491 0, /* tp_members */
Tim Petersa9bc1682003-01-11 03:39:11 +00004492 datetime_getset, /* tp_getset */
4493 &PyDateTime_DateType, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00004494 0, /* tp_dict */
4495 0, /* tp_descr_get */
4496 0, /* tp_descr_set */
4497 0, /* tp_dictoffset */
4498 0, /* tp_init */
4499 0, /* tp_alloc */
Tim Petersa9bc1682003-01-11 03:39:11 +00004500 datetime_new, /* tp_new */
Tim Peters2a799bf2002-12-16 20:18:38 +00004501 _PyObject_Del, /* tp_free */
4502};
4503
4504/* ---------------------------------------------------------------------------
4505 * Module methods and initialization.
4506 */
4507
4508static PyMethodDef module_methods[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004509 {NULL, NULL}
4510};
4511
4512PyMODINIT_FUNC
4513initdatetime(void)
4514{
4515 PyObject *m; /* a module object */
4516 PyObject *d; /* its dict */
4517 PyObject *x;
4518
4519 /* Types that use __reduce__ for pickling need to set the following
4520 * magical attr in the type dict, with a true value.
4521 */
4522 PyObject *safepickle = PyString_FromString("__safe_for_unpickling__");
4523 if (safepickle == NULL)
4524 return;
4525
4526 m = Py_InitModule3("datetime", module_methods,
4527 "Fast implementation of the datetime type.");
4528
4529 if (PyType_Ready(&PyDateTime_DateType) < 0)
4530 return;
4531 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
4532 return;
4533 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
4534 return;
4535 if (PyType_Ready(&PyDateTime_TimeType) < 0)
4536 return;
4537 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
4538 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004539
Guido van Rossum177e41a2003-01-30 22:06:23 +00004540 /* Make __getnewargs__ a true alias for __getstate__ */
Tim Peters2a799bf2002-12-16 20:18:38 +00004541 {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004542 PyObject *d, *f;
Tim Peters2a799bf2002-12-16 20:18:38 +00004543
Guido van Rossum177e41a2003-01-30 22:06:23 +00004544 d = PyDateTime_DateType.tp_dict;
4545 f = PyDict_GetItemString(d, "__getstate__");
4546 if (f != NULL) {
4547 if (PyDict_SetItemString(d, "__getnewargs__", f) < 0)
4548 return;
4549 }
Tim Peters2a799bf2002-12-16 20:18:38 +00004550
Guido van Rossum177e41a2003-01-30 22:06:23 +00004551 d = PyDateTime_DateTimeType.tp_dict;
4552 f = PyDict_GetItemString(d, "__getstate__");
4553 if (f != NULL) {
4554 if (PyDict_SetItemString(d, "__getnewargs__", f) < 0)
4555 return;
4556 }
Tim Peters2a799bf2002-12-16 20:18:38 +00004557
Guido van Rossum177e41a2003-01-30 22:06:23 +00004558 d = PyDateTime_DeltaType.tp_dict;
4559 f = PyDict_GetItemString(d, "__getstate__");
4560 if (f != NULL) {
4561 if (PyDict_SetItemString(d, "__getnewargs__", f) < 0)
4562 return;
4563 }
Tim Peters2a799bf2002-12-16 20:18:38 +00004564
Guido van Rossum177e41a2003-01-30 22:06:23 +00004565 d = PyDateTime_TimeType.tp_dict;
4566 f = PyDict_GetItemString(d, "__getstate__");
4567 if (f != NULL) {
4568 if (PyDict_SetItemString(d, "__getnewargs__", f) < 0)
4569 return;
4570 }
Tim Peters2a799bf2002-12-16 20:18:38 +00004571
Guido van Rossum177e41a2003-01-30 22:06:23 +00004572 d = PyDateTime_TZInfoType.tp_dict;
4573 f = PyDict_GetItemString(d, "__getstate__");
4574 if (f != NULL) {
4575 if (PyDict_SetItemString(d, "__getnewargs__", f) < 0)
4576 return;
4577 }
Tim Peters2a799bf2002-12-16 20:18:38 +00004578 }
4579
Guido van Rossum177e41a2003-01-30 22:06:23 +00004580 /* tzinfo values */
4581 d = PyDateTime_TZInfoType.tp_dict;
4582
4583 if (PyDict_SetItem(d, safepickle, Py_True) < 0)
4584 return;
4585
Tim Peters2a799bf2002-12-16 20:18:38 +00004586 /* timedelta values */
4587 d = PyDateTime_DeltaType.tp_dict;
4588
4589 if (PyDict_SetItem(d, safepickle, Py_True) < 0)
4590 return;
4591
4592 x = new_delta(0, 0, 1, 0);
4593 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4594 return;
4595 Py_DECREF(x);
4596
4597 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
4598 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4599 return;
4600 Py_DECREF(x);
4601
4602 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
4603 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4604 return;
4605 Py_DECREF(x);
4606
4607 /* date values */
4608 d = PyDateTime_DateType.tp_dict;
4609
Guido van Rossum177e41a2003-01-30 22:06:23 +00004610 if (PyDict_SetItem(d, safepickle, Py_True) < 0)
4611 return;
4612
Tim Peters2a799bf2002-12-16 20:18:38 +00004613 x = new_date(1, 1, 1);
4614 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4615 return;
4616 Py_DECREF(x);
4617
4618 x = new_date(MAXYEAR, 12, 31);
4619 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4620 return;
4621 Py_DECREF(x);
4622
4623 x = new_delta(1, 0, 0, 0);
4624 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4625 return;
4626 Py_DECREF(x);
4627
Tim Peters37f39822003-01-10 03:49:02 +00004628 /* time values */
4629 d = PyDateTime_TimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004630
Guido van Rossum177e41a2003-01-30 22:06:23 +00004631 if (PyDict_SetItem(d, safepickle, Py_True) < 0)
4632 return;
4633
Tim Peters37f39822003-01-10 03:49:02 +00004634 x = new_time(0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004635 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4636 return;
4637 Py_DECREF(x);
4638
Tim Peters37f39822003-01-10 03:49:02 +00004639 x = new_time(23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004640 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4641 return;
4642 Py_DECREF(x);
4643
4644 x = new_delta(0, 0, 1, 0);
4645 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4646 return;
4647 Py_DECREF(x);
4648
Tim Petersa9bc1682003-01-11 03:39:11 +00004649 /* datetime values */
4650 d = PyDateTime_DateTimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004651
Guido van Rossum177e41a2003-01-30 22:06:23 +00004652 if (PyDict_SetItem(d, safepickle, Py_True) < 0)
4653 return;
4654
Tim Petersa9bc1682003-01-11 03:39:11 +00004655 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004656 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4657 return;
4658 Py_DECREF(x);
4659
Tim Petersa9bc1682003-01-11 03:39:11 +00004660 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004661 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4662 return;
4663 Py_DECREF(x);
4664
4665 x = new_delta(0, 0, 1, 0);
4666 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4667 return;
4668 Py_DECREF(x);
4669
4670 Py_DECREF(safepickle);
4671
4672 /* module initialization */
4673 PyModule_AddIntConstant(m, "MINYEAR", MINYEAR);
4674 PyModule_AddIntConstant(m, "MAXYEAR", MAXYEAR);
4675
4676 Py_INCREF(&PyDateTime_DateType);
4677 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
4678
Tim Petersa9bc1682003-01-11 03:39:11 +00004679 Py_INCREF(&PyDateTime_DateTimeType);
4680 PyModule_AddObject(m, "datetime",
4681 (PyObject *)&PyDateTime_DateTimeType);
4682
4683 Py_INCREF(&PyDateTime_TimeType);
4684 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
4685
Tim Peters2a799bf2002-12-16 20:18:38 +00004686 Py_INCREF(&PyDateTime_DeltaType);
4687 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
4688
Tim Peters2a799bf2002-12-16 20:18:38 +00004689 Py_INCREF(&PyDateTime_TZInfoType);
4690 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
4691
Tim Peters2a799bf2002-12-16 20:18:38 +00004692 /* A 4-year cycle has an extra leap day over what we'd get from
4693 * pasting together 4 single years.
4694 */
4695 assert(DI4Y == 4 * 365 + 1);
4696 assert(DI4Y == days_before_year(4+1));
4697
4698 /* Similarly, a 400-year cycle has an extra leap day over what we'd
4699 * get from pasting together 4 100-year cycles.
4700 */
4701 assert(DI400Y == 4 * DI100Y + 1);
4702 assert(DI400Y == days_before_year(400+1));
4703
4704 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
4705 * pasting together 25 4-year cycles.
4706 */
4707 assert(DI100Y == 25 * DI4Y - 1);
4708 assert(DI100Y == days_before_year(100+1));
4709
4710 us_per_us = PyInt_FromLong(1);
4711 us_per_ms = PyInt_FromLong(1000);
4712 us_per_second = PyInt_FromLong(1000000);
4713 us_per_minute = PyInt_FromLong(60000000);
4714 seconds_per_day = PyInt_FromLong(24 * 3600);
4715 if (us_per_us == NULL || us_per_ms == NULL || us_per_second == NULL ||
4716 us_per_minute == NULL || seconds_per_day == NULL)
4717 return;
4718
4719 /* The rest are too big for 32-bit ints, but even
4720 * us_per_week fits in 40 bits, so doubles should be exact.
4721 */
4722 us_per_hour = PyLong_FromDouble(3600000000.0);
4723 us_per_day = PyLong_FromDouble(86400000000.0);
4724 us_per_week = PyLong_FromDouble(604800000000.0);
4725 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
4726 return;
4727}
Tim Petersf3615152003-01-01 21:51:37 +00004728
4729/* ---------------------------------------------------------------------------
Tim Petersa9bc1682003-01-11 03:39:11 +00004730Some time zone algebra. For a datetime x, let
Tim Petersf3615152003-01-01 21:51:37 +00004731 x.n = x stripped of its timezone -- its naive time.
4732 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
4733 return None
4734 x.d = x.dst(), and assuming that doesn't raise an exception or
4735 return None
4736 x.s = x's standard offset, x.o - x.d
4737
4738Now some derived rules, where k is a duration (timedelta).
4739
47401. x.o = x.s + x.d
4741 This follows from the definition of x.s.
4742
Tim Petersc5dc4da2003-01-02 17:55:03 +000047432. If x and y have the same tzinfo member, x.s = y.s.
Tim Petersf3615152003-01-01 21:51:37 +00004744 This is actually a requirement, an assumption we need to make about
4745 sane tzinfo classes.
4746
47473. The naive UTC time corresponding to x is x.n - x.o.
4748 This is again a requirement for a sane tzinfo class.
4749
47504. (x+k).s = x.s
Tim Peters8bb5ad22003-01-24 02:44:45 +00004751 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
Tim Petersf3615152003-01-01 21:51:37 +00004752
Tim Petersc5dc4da2003-01-02 17:55:03 +000047535. (x+k).n = x.n + k
Tim Petersf3615152003-01-01 21:51:37 +00004754 Again follows from how arithmetic is defined.
4755
Tim Peters8bb5ad22003-01-24 02:44:45 +00004756Now we can explain tz.fromutc(x). Let's assume it's an interesting case
Tim Petersf3615152003-01-01 21:51:37 +00004757(meaning that the various tzinfo methods exist, and don't blow up or return
4758None when called).
4759
Tim Petersa9bc1682003-01-11 03:39:11 +00004760The function wants to return a datetime y with timezone tz, equivalent to x.
Tim Peters8bb5ad22003-01-24 02:44:45 +00004761x is already in UTC.
Tim Petersf3615152003-01-01 21:51:37 +00004762
4763By #3, we want
4764
Tim Peters8bb5ad22003-01-24 02:44:45 +00004765 y.n - y.o = x.n [1]
Tim Petersf3615152003-01-01 21:51:37 +00004766
4767The algorithm starts by attaching tz to x.n, and calling that y. So
4768x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
4769becomes true; in effect, we want to solve [2] for k:
4770
Tim Peters8bb5ad22003-01-24 02:44:45 +00004771 (y+k).n - (y+k).o = x.n [2]
Tim Petersf3615152003-01-01 21:51:37 +00004772
4773By #1, this is the same as
4774
Tim Peters8bb5ad22003-01-24 02:44:45 +00004775 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
Tim Petersf3615152003-01-01 21:51:37 +00004776
4777By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
4778Substituting that into [3],
4779
Tim Peters8bb5ad22003-01-24 02:44:45 +00004780 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
4781 k - (y+k).s - (y+k).d = 0; rearranging,
4782 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
4783 k = y.s - (y+k).d
Tim Petersf3615152003-01-01 21:51:37 +00004784
Tim Peters8bb5ad22003-01-24 02:44:45 +00004785On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
4786approximate k by ignoring the (y+k).d term at first. Note that k can't be
4787very large, since all offset-returning methods return a duration of magnitude
4788less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
4789be 0, so ignoring it has no consequence then.
Tim Petersf3615152003-01-01 21:51:37 +00004790
4791In any case, the new value is
4792
Tim Peters8bb5ad22003-01-24 02:44:45 +00004793 z = y + y.s [4]
Tim Petersf3615152003-01-01 21:51:37 +00004794
Tim Peters8bb5ad22003-01-24 02:44:45 +00004795It's helpful to step back at look at [4] from a higher level: it's simply
4796mapping from UTC to tz's standard time.
Tim Petersc5dc4da2003-01-02 17:55:03 +00004797
4798At this point, if
4799
Tim Peters8bb5ad22003-01-24 02:44:45 +00004800 z.n - z.o = x.n [5]
Tim Petersc5dc4da2003-01-02 17:55:03 +00004801
4802we have an equivalent time, and are almost done. The insecurity here is
Tim Petersf3615152003-01-01 21:51:37 +00004803at the start of daylight time. Picture US Eastern for concreteness. The wall
4804time 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 +00004805sense then. The docs ask that an Eastern tzinfo class consider such a time to
4806be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
4807on the day DST starts. We want to return the 1:MM EST spelling because that's
Tim Petersf3615152003-01-01 21:51:37 +00004808the only spelling that makes sense on the local wall clock.
4809
Tim Petersc5dc4da2003-01-02 17:55:03 +00004810In fact, if [5] holds at this point, we do have the standard-time spelling,
4811but that takes a bit of proof. We first prove a stronger result. What's the
4812difference between the LHS and RHS of [5]? Let
Tim Petersf3615152003-01-01 21:51:37 +00004813
Tim Peters8bb5ad22003-01-24 02:44:45 +00004814 diff = x.n - (z.n - z.o) [6]
Tim Petersf3615152003-01-01 21:51:37 +00004815
Tim Petersc5dc4da2003-01-02 17:55:03 +00004816Now
4817 z.n = by [4]
Tim Peters8bb5ad22003-01-24 02:44:45 +00004818 (y + y.s).n = by #5
4819 y.n + y.s = since y.n = x.n
4820 x.n + y.s = since z and y are have the same tzinfo member,
4821 y.s = z.s by #2
4822 x.n + z.s
Tim Petersf3615152003-01-01 21:51:37 +00004823
Tim Petersc5dc4da2003-01-02 17:55:03 +00004824Plugging that back into [6] gives
Tim Petersf3615152003-01-01 21:51:37 +00004825
Tim Petersc5dc4da2003-01-02 17:55:03 +00004826 diff =
Tim Peters8bb5ad22003-01-24 02:44:45 +00004827 x.n - ((x.n + z.s) - z.o) = expanding
4828 x.n - x.n - z.s + z.o = cancelling
4829 - z.s + z.o = by #2
Tim Petersc5dc4da2003-01-02 17:55:03 +00004830 z.d
Tim Petersf3615152003-01-01 21:51:37 +00004831
Tim Petersc5dc4da2003-01-02 17:55:03 +00004832So diff = z.d.
Tim Petersf3615152003-01-01 21:51:37 +00004833
Tim Petersc5dc4da2003-01-02 17:55:03 +00004834If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
Tim Peters8bb5ad22003-01-24 02:44:45 +00004835spelling we wanted in the endcase described above. We're done. Contrarily,
4836if z.d = 0, then we have a UTC equivalent, and are also done.
Tim Petersf3615152003-01-01 21:51:37 +00004837
Tim Petersc5dc4da2003-01-02 17:55:03 +00004838If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
4839add to z (in effect, z is in tz's standard time, and we need to shift the
Tim Peters8bb5ad22003-01-24 02:44:45 +00004840local clock into tz's daylight time).
Tim Petersf3615152003-01-01 21:51:37 +00004841
Tim Petersc5dc4da2003-01-02 17:55:03 +00004842Let
Tim Petersf3615152003-01-01 21:51:37 +00004843
Tim Peters4fede1a2003-01-04 00:26:59 +00004844 z' = z + z.d = z + diff [7]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004845
Tim Peters4fede1a2003-01-04 00:26:59 +00004846and we can again ask whether
Tim Petersc3bb26a2003-01-02 03:14:59 +00004847
Tim Peters8bb5ad22003-01-24 02:44:45 +00004848 z'.n - z'.o = x.n [8]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004849
Tim Peters8bb5ad22003-01-24 02:44:45 +00004850If so, we're done. If not, the tzinfo class is insane, according to the
4851assumptions we've made. This also requires a bit of proof. As before, let's
4852compute the difference between the LHS and RHS of [8] (and skipping some of
4853the justifications for the kinds of substitutions we've done several times
4854already):
Tim Peters4fede1a2003-01-04 00:26:59 +00004855
Tim Peters8bb5ad22003-01-24 02:44:45 +00004856 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
4857 x.n - (z.n + diff - z'.o) = replacing diff via [6]
4858 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
4859 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
4860 - z.n + z.n - z.o + z'.o = cancel z.n
Tim Peters4fede1a2003-01-04 00:26:59 +00004861 - z.o + z'.o = #1 twice
4862 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
4863 z'.d - z.d
4864
4865So 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 +00004866we've found the UTC-equivalent so are done. In fact, we stop with [7] and
4867return z', not bothering to compute z'.d.
Tim Peters4fede1a2003-01-04 00:26:59 +00004868
Tim Peters8bb5ad22003-01-24 02:44:45 +00004869How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
4870a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
4871would have to change the result dst() returns: we start in DST, and moving
4872a little further into it takes us out of DST.
Tim Peters4fede1a2003-01-04 00:26:59 +00004873
Tim Peters8bb5ad22003-01-24 02:44:45 +00004874There isn't a sane case where this can happen. The closest it gets is at
4875the end of DST, where there's an hour in UTC with no spelling in a hybrid
4876tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
4877that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
4878UTC) because the docs insist on that, but 0:MM is taken as being in daylight
4879time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
4880clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
4881standard time. Since that's what the local clock *does*, we want to map both
4882UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
Tim Peters4fede1a2003-01-04 00:26:59 +00004883in local time, but so it goes -- it's the way the local clock works.
4884
Tim Peters8bb5ad22003-01-24 02:44:45 +00004885When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
4886so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
4887z' = 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 +00004888(correctly) concludes that z' is not UTC-equivalent to x.
4889
4890Because we know z.d said z was in daylight time (else [5] would have held and
4891we would have stopped then), and we know z.d != z'.d (else [8] would have held
4892and we we have stopped then), and there are only 2 possible values dst() can
4893return in Eastern, it follows that z'.d must be 0 (which it is in the example,
4894but the reasoning doesn't depend on the example -- it depends on there being
4895two possible dst() outcomes, one zero and the other non-zero). Therefore
Tim Peters8bb5ad22003-01-24 02:44:45 +00004896z' must be in standard time, and is the spelling we want in this case.
4897
4898Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
4899concerned (because it takes z' as being in standard time rather than the
4900daylight time we intend here), but returning it gives the real-life "local
4901clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
4902tz.
4903
4904When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
4905the 1:MM standard time spelling we want.
4906
4907So how can this break? One of the assumptions must be violated. Two
4908possibilities:
4909
49101) [2] effectively says that y.s is invariant across all y belong to a given
4911 time zone. This isn't true if, for political reasons or continental drift,
4912 a region decides to change its base offset from UTC.
4913
49142) There may be versions of "double daylight" time where the tail end of
4915 the analysis gives up a step too early. I haven't thought about that
4916 enough to say.
4917
4918In any case, it's clear that the default fromutc() is strong enough to handle
4919"almost all" time zones: so long as the standard offset is invariant, it
4920doesn't matter if daylight time transition points change from year to year, or
4921if daylight time is skipped in some years; it doesn't matter how large or
4922small dst() may get within its bounds; and it doesn't even matter if some
4923perverse time zone returns a negative dst()). So a breaking case must be
4924pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
Tim Petersf3615152003-01-01 21:51:37 +00004925--------------------------------------------------------------------------- */