blob: ba2b737d4933f2517b18ec40382851de94d24126 [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 Petersb57f8f02003-02-01 02:54:15 +00001952/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00001953static PyObject *
1954delta_getstate(PyDateTime_Delta *self)
1955{
1956 return Py_BuildValue("iii", GET_TD_DAYS(self),
1957 GET_TD_SECONDS(self),
1958 GET_TD_MICROSECONDS(self));
1959}
1960
Tim Peters2a799bf2002-12-16 20:18:38 +00001961static PyObject *
1962delta_reduce(PyDateTime_Delta* self)
1963{
Tim Peters8a60c222003-02-01 01:47:29 +00001964 return Py_BuildValue("ON", self->ob_type, delta_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00001965}
1966
1967#define OFFSET(field) offsetof(PyDateTime_Delta, field)
1968
1969static PyMemberDef delta_members[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00001970
Neal Norwitzdfb80862002-12-19 02:30:56 +00001971 {"days", T_INT, OFFSET(days), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00001972 PyDoc_STR("Number of days.")},
1973
Neal Norwitzdfb80862002-12-19 02:30:56 +00001974 {"seconds", T_INT, OFFSET(seconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00001975 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
1976
Neal Norwitzdfb80862002-12-19 02:30:56 +00001977 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00001978 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
1979 {NULL}
1980};
1981
1982static PyMethodDef delta_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00001983 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
1984 PyDoc_STR("__reduce__() -> (cls, state)")},
1985
Tim Peters2a799bf2002-12-16 20:18:38 +00001986 {NULL, NULL},
1987};
1988
1989static char delta_doc[] =
1990PyDoc_STR("Difference between two datetime values.");
1991
1992static PyNumberMethods delta_as_number = {
1993 delta_add, /* nb_add */
1994 delta_subtract, /* nb_subtract */
1995 delta_multiply, /* nb_multiply */
1996 delta_divide, /* nb_divide */
1997 0, /* nb_remainder */
1998 0, /* nb_divmod */
1999 0, /* nb_power */
2000 (unaryfunc)delta_negative, /* nb_negative */
2001 (unaryfunc)delta_positive, /* nb_positive */
2002 (unaryfunc)delta_abs, /* nb_absolute */
2003 (inquiry)delta_nonzero, /* nb_nonzero */
2004 0, /*nb_invert*/
2005 0, /*nb_lshift*/
2006 0, /*nb_rshift*/
2007 0, /*nb_and*/
2008 0, /*nb_xor*/
2009 0, /*nb_or*/
2010 0, /*nb_coerce*/
2011 0, /*nb_int*/
2012 0, /*nb_long*/
2013 0, /*nb_float*/
2014 0, /*nb_oct*/
2015 0, /*nb_hex*/
2016 0, /*nb_inplace_add*/
2017 0, /*nb_inplace_subtract*/
2018 0, /*nb_inplace_multiply*/
2019 0, /*nb_inplace_divide*/
2020 0, /*nb_inplace_remainder*/
2021 0, /*nb_inplace_power*/
2022 0, /*nb_inplace_lshift*/
2023 0, /*nb_inplace_rshift*/
2024 0, /*nb_inplace_and*/
2025 0, /*nb_inplace_xor*/
2026 0, /*nb_inplace_or*/
2027 delta_divide, /* nb_floor_divide */
2028 0, /* nb_true_divide */
2029 0, /* nb_inplace_floor_divide */
2030 0, /* nb_inplace_true_divide */
2031};
2032
2033static PyTypeObject PyDateTime_DeltaType = {
2034 PyObject_HEAD_INIT(NULL)
2035 0, /* ob_size */
2036 "datetime.timedelta", /* tp_name */
2037 sizeof(PyDateTime_Delta), /* tp_basicsize */
2038 0, /* tp_itemsize */
2039 0, /* tp_dealloc */
2040 0, /* tp_print */
2041 0, /* tp_getattr */
2042 0, /* tp_setattr */
2043 0, /* tp_compare */
2044 (reprfunc)delta_repr, /* tp_repr */
2045 &delta_as_number, /* tp_as_number */
2046 0, /* tp_as_sequence */
2047 0, /* tp_as_mapping */
2048 (hashfunc)delta_hash, /* tp_hash */
2049 0, /* tp_call */
2050 (reprfunc)delta_str, /* tp_str */
2051 PyObject_GenericGetAttr, /* tp_getattro */
2052 0, /* tp_setattro */
2053 0, /* tp_as_buffer */
2054 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES, /* tp_flags */
2055 delta_doc, /* tp_doc */
2056 0, /* tp_traverse */
2057 0, /* tp_clear */
2058 (richcmpfunc)delta_richcompare, /* tp_richcompare */
2059 0, /* tp_weaklistoffset */
2060 0, /* tp_iter */
2061 0, /* tp_iternext */
2062 delta_methods, /* tp_methods */
2063 delta_members, /* tp_members */
2064 0, /* tp_getset */
2065 0, /* tp_base */
2066 0, /* tp_dict */
2067 0, /* tp_descr_get */
2068 0, /* tp_descr_set */
2069 0, /* tp_dictoffset */
2070 0, /* tp_init */
2071 0, /* tp_alloc */
2072 delta_new, /* tp_new */
2073 _PyObject_Del, /* tp_free */
2074};
2075
2076/*
2077 * PyDateTime_Date implementation.
2078 */
2079
2080/* Accessor properties. */
2081
2082static PyObject *
2083date_year(PyDateTime_Date *self, void *unused)
2084{
2085 return PyInt_FromLong(GET_YEAR(self));
2086}
2087
2088static PyObject *
2089date_month(PyDateTime_Date *self, void *unused)
2090{
2091 return PyInt_FromLong(GET_MONTH(self));
2092}
2093
2094static PyObject *
2095date_day(PyDateTime_Date *self, void *unused)
2096{
2097 return PyInt_FromLong(GET_DAY(self));
2098}
2099
2100static PyGetSetDef date_getset[] = {
2101 {"year", (getter)date_year},
2102 {"month", (getter)date_month},
2103 {"day", (getter)date_day},
2104 {NULL}
2105};
2106
2107/* Constructors. */
2108
Tim Peters12bf3392002-12-24 05:41:27 +00002109static char *date_kws[] = {"year", "month", "day", NULL};
2110
Tim Peters506be282003-01-31 22:27:17 +00002111/* __setstate__ isn't exposed. */
2112static PyObject *
2113date_setstate(PyDateTime_Date *self, PyObject *arg)
2114{
2115 PyObject *state;
2116 int len;
2117 unsigned char *pdata;
2118
2119 if (!PyTuple_Check(arg) || PyTuple_GET_SIZE(arg) != 1)
2120 goto error;
2121 state = PyTuple_GET_ITEM(arg, 0);
2122 if (!PyString_Check(state))
2123 goto error;
2124
2125 len = PyString_Size(state);
2126 if (len != _PyDateTime_DATE_DATASIZE)
2127 goto error;
2128
2129 pdata = (unsigned char*)PyString_AsString(state);
2130 memcpy(self->data, pdata, _PyDateTime_DATE_DATASIZE);
2131 self->hashcode = -1;
2132
2133 Py_INCREF(Py_None);
2134 return Py_None;
2135 error:
2136 PyErr_SetString(PyExc_TypeError,
2137 "bad argument to date.__setstate__");
2138 return NULL;
2139}
Guido van Rossum177e41a2003-01-30 22:06:23 +00002140
Tim Peters2a799bf2002-12-16 20:18:38 +00002141static PyObject *
2142date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2143{
2144 PyObject *self = NULL;
2145 int year;
2146 int month;
2147 int day;
2148
Guido van Rossum177e41a2003-01-30 22:06:23 +00002149 /* Check for invocation from pickle with __getstate__ state */
2150 if (PyTuple_GET_SIZE(args) == 1 &&
2151 PyString_Check(PyTuple_GET_ITEM(args, 0)))
2152 {
2153 self = new_date(1, 1, 1);
2154 if (self != NULL) {
2155 PyObject *res = date_setstate(
2156 (PyDateTime_Date *)self, args);
2157 if (res == Py_None)
2158 Py_DECREF(res);
2159 else {
2160 Py_DECREF(self);
2161 self = NULL;
2162 }
2163 }
2164 return self;
2165 }
2166
Tim Peters12bf3392002-12-24 05:41:27 +00002167 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00002168 &year, &month, &day)) {
2169 if (check_date_args(year, month, day) < 0)
2170 return NULL;
2171 self = new_date(year, month, day);
2172 }
2173 return self;
2174}
2175
2176/* Return new date from localtime(t). */
2177static PyObject *
2178date_local_from_time_t(PyObject *cls, time_t t)
2179{
2180 struct tm *tm;
2181 PyObject *result = NULL;
2182
2183 tm = localtime(&t);
2184 if (tm)
2185 result = PyObject_CallFunction(cls, "iii",
2186 tm->tm_year + 1900,
2187 tm->tm_mon + 1,
2188 tm->tm_mday);
2189 else
2190 PyErr_SetString(PyExc_ValueError,
2191 "timestamp out of range for "
2192 "platform localtime() function");
2193 return result;
2194}
2195
2196/* Return new date from current time.
2197 * We say this is equivalent to fromtimestamp(time.time()), and the
2198 * only way to be sure of that is to *call* time.time(). That's not
2199 * generally the same as calling C's time.
2200 */
2201static PyObject *
2202date_today(PyObject *cls, PyObject *dummy)
2203{
2204 PyObject *time;
2205 PyObject *result;
2206
2207 time = time_time();
2208 if (time == NULL)
2209 return NULL;
2210
2211 /* Note well: today() is a class method, so this may not call
2212 * date.fromtimestamp. For example, it may call
2213 * datetime.fromtimestamp. That's why we need all the accuracy
2214 * time.time() delivers; if someone were gonzo about optimization,
2215 * date.today() could get away with plain C time().
2216 */
2217 result = PyObject_CallMethod(cls, "fromtimestamp", "O", time);
2218 Py_DECREF(time);
2219 return result;
2220}
2221
2222/* Return new date from given timestamp (Python timestamp -- a double). */
2223static PyObject *
2224date_fromtimestamp(PyObject *cls, PyObject *args)
2225{
2226 double timestamp;
2227 PyObject *result = NULL;
2228
2229 if (PyArg_ParseTuple(args, "d:fromtimestamp", &timestamp))
2230 result = date_local_from_time_t(cls, (time_t)timestamp);
2231 return result;
2232}
2233
2234/* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2235 * the ordinal is out of range.
2236 */
2237static PyObject *
2238date_fromordinal(PyObject *cls, PyObject *args)
2239{
2240 PyObject *result = NULL;
2241 int ordinal;
2242
2243 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2244 int year;
2245 int month;
2246 int day;
2247
2248 if (ordinal < 1)
2249 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2250 ">= 1");
2251 else {
2252 ord_to_ymd(ordinal, &year, &month, &day);
2253 result = PyObject_CallFunction(cls, "iii",
2254 year, month, day);
2255 }
2256 }
2257 return result;
2258}
2259
2260/*
2261 * Date arithmetic.
2262 */
2263
2264/* date + timedelta -> date. If arg negate is true, subtract the timedelta
2265 * instead.
2266 */
2267static PyObject *
2268add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
2269{
2270 PyObject *result = NULL;
2271 int year = GET_YEAR(date);
2272 int month = GET_MONTH(date);
2273 int deltadays = GET_TD_DAYS(delta);
2274 /* C-level overflow is impossible because |deltadays| < 1e9. */
2275 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
2276
2277 if (normalize_date(&year, &month, &day) >= 0)
2278 result = new_date(year, month, day);
2279 return result;
2280}
2281
2282static PyObject *
2283date_add(PyObject *left, PyObject *right)
2284{
2285 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2286 Py_INCREF(Py_NotImplemented);
2287 return Py_NotImplemented;
2288 }
2289 if (PyDate_CheckExact(left)) {
2290 /* date + ??? */
2291 if (PyDelta_Check(right))
2292 /* date + delta */
2293 return add_date_timedelta((PyDateTime_Date *) left,
2294 (PyDateTime_Delta *) right,
2295 0);
2296 }
2297 else {
2298 /* ??? + date
2299 * 'right' must be one of us, or we wouldn't have been called
2300 */
2301 if (PyDelta_Check(left))
2302 /* delta + date */
2303 return add_date_timedelta((PyDateTime_Date *) right,
2304 (PyDateTime_Delta *) left,
2305 0);
2306 }
2307 Py_INCREF(Py_NotImplemented);
2308 return Py_NotImplemented;
2309}
2310
2311static PyObject *
2312date_subtract(PyObject *left, PyObject *right)
2313{
2314 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2315 Py_INCREF(Py_NotImplemented);
2316 return Py_NotImplemented;
2317 }
2318 if (PyDate_CheckExact(left)) {
2319 if (PyDate_CheckExact(right)) {
2320 /* date - date */
2321 int left_ord = ymd_to_ord(GET_YEAR(left),
2322 GET_MONTH(left),
2323 GET_DAY(left));
2324 int right_ord = ymd_to_ord(GET_YEAR(right),
2325 GET_MONTH(right),
2326 GET_DAY(right));
2327 return new_delta(left_ord - right_ord, 0, 0, 0);
2328 }
2329 if (PyDelta_Check(right)) {
2330 /* date - delta */
2331 return add_date_timedelta((PyDateTime_Date *) left,
2332 (PyDateTime_Delta *) right,
2333 1);
2334 }
2335 }
2336 Py_INCREF(Py_NotImplemented);
2337 return Py_NotImplemented;
2338}
2339
2340
2341/* Various ways to turn a date into a string. */
2342
2343static PyObject *
2344date_repr(PyDateTime_Date *self)
2345{
2346 char buffer[1028];
2347 char *typename;
2348
2349 typename = self->ob_type->tp_name;
2350 PyOS_snprintf(buffer, sizeof(buffer), "%s(%d, %d, %d)",
2351 typename,
2352 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2353
2354 return PyString_FromString(buffer);
2355}
2356
2357static PyObject *
2358date_isoformat(PyDateTime_Date *self)
2359{
2360 char buffer[128];
2361
2362 isoformat_date(self, buffer, sizeof(buffer));
2363 return PyString_FromString(buffer);
2364}
2365
2366/* str() calls the appropriate isofomat() method. */
2367static PyObject *
2368date_str(PyDateTime_Date *self)
2369{
2370 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
2371}
2372
2373
2374static PyObject *
2375date_ctime(PyDateTime_Date *self)
2376{
2377 return format_ctime(self, 0, 0, 0);
2378}
2379
2380static PyObject *
2381date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2382{
2383 /* This method can be inherited, and needs to call the
2384 * timetuple() method appropriate to self's class.
2385 */
2386 PyObject *result;
2387 PyObject *format;
2388 PyObject *tuple;
2389 static char *keywords[] = {"format", NULL};
2390
2391 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
2392 &PyString_Type, &format))
2393 return NULL;
2394
2395 tuple = PyObject_CallMethod((PyObject *)self, "timetuple", "()");
2396 if (tuple == NULL)
2397 return NULL;
Tim Petersbad8ff02002-12-30 20:52:32 +00002398 result = wrap_strftime((PyObject *)self, format, tuple,
2399 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002400 Py_DECREF(tuple);
2401 return result;
2402}
2403
2404/* ISO methods. */
2405
2406static PyObject *
2407date_isoweekday(PyDateTime_Date *self)
2408{
2409 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2410
2411 return PyInt_FromLong(dow + 1);
2412}
2413
2414static PyObject *
2415date_isocalendar(PyDateTime_Date *self)
2416{
2417 int year = GET_YEAR(self);
2418 int week1_monday = iso_week1_monday(year);
2419 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
2420 int week;
2421 int day;
2422
2423 week = divmod(today - week1_monday, 7, &day);
2424 if (week < 0) {
2425 --year;
2426 week1_monday = iso_week1_monday(year);
2427 week = divmod(today - week1_monday, 7, &day);
2428 }
2429 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
2430 ++year;
2431 week = 0;
2432 }
2433 return Py_BuildValue("iii", year, week + 1, day + 1);
2434}
2435
2436/* Miscellaneous methods. */
2437
2438/* This is more natural as a tp_compare, but doesn't work then: for whatever
2439 * reason, Python's try_3way_compare ignores tp_compare unless
2440 * PyInstance_Check returns true, but these aren't old-style classes.
2441 */
2442static PyObject *
2443date_richcompare(PyDateTime_Date *self, PyObject *other, int op)
2444{
2445 int diff;
2446
2447 if (! PyDate_Check(other)) {
Tim Peters8d81a012003-01-24 22:36:34 +00002448 if (PyObject_HasAttrString(other, "timetuple")) {
2449 /* A hook for other kinds of date objects. */
2450 Py_INCREF(Py_NotImplemented);
2451 return Py_NotImplemented;
2452 }
2453 /* Stop this from falling back to address comparison. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002454 PyErr_Format(PyExc_TypeError,
Tim Peters8d81a012003-01-24 22:36:34 +00002455 "can't compare '%s' to '%s'",
2456 self->ob_type->tp_name,
Tim Peters2a799bf2002-12-16 20:18:38 +00002457 other->ob_type->tp_name);
2458 return NULL;
2459 }
2460 diff = memcmp(self->data, ((PyDateTime_Date *)other)->data,
2461 _PyDateTime_DATE_DATASIZE);
2462 return diff_to_bool(diff, op);
2463}
2464
2465static PyObject *
2466date_timetuple(PyDateTime_Date *self)
2467{
2468 return build_struct_time(GET_YEAR(self),
2469 GET_MONTH(self),
2470 GET_DAY(self),
2471 0, 0, 0, -1);
2472}
2473
Tim Peters12bf3392002-12-24 05:41:27 +00002474static PyObject *
2475date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2476{
2477 PyObject *clone;
2478 PyObject *tuple;
2479 int year = GET_YEAR(self);
2480 int month = GET_MONTH(self);
2481 int day = GET_DAY(self);
2482
2483 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
2484 &year, &month, &day))
2485 return NULL;
2486 tuple = Py_BuildValue("iii", year, month, day);
2487 if (tuple == NULL)
2488 return NULL;
2489 clone = date_new(self->ob_type, tuple, NULL);
2490 Py_DECREF(tuple);
2491 return clone;
2492}
2493
Tim Peters2a799bf2002-12-16 20:18:38 +00002494static PyObject *date_getstate(PyDateTime_Date *self);
2495
2496static long
2497date_hash(PyDateTime_Date *self)
2498{
2499 if (self->hashcode == -1) {
2500 PyObject *temp = date_getstate(self);
2501 if (temp != NULL) {
2502 self->hashcode = PyObject_Hash(temp);
2503 Py_DECREF(temp);
2504 }
2505 }
2506 return self->hashcode;
2507}
2508
2509static PyObject *
2510date_toordinal(PyDateTime_Date *self)
2511{
2512 return PyInt_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
2513 GET_DAY(self)));
2514}
2515
2516static PyObject *
2517date_weekday(PyDateTime_Date *self)
2518{
2519 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2520
2521 return PyInt_FromLong(dow);
2522}
2523
Tim Peters371935f2003-02-01 01:52:50 +00002524/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002525
Tim Petersb57f8f02003-02-01 02:54:15 +00002526/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002527static PyObject *
2528date_getstate(PyDateTime_Date *self)
2529{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002530 return Py_BuildValue(
2531 "(N)",
2532 PyString_FromStringAndSize((char *)self->data,
2533 _PyDateTime_DATE_DATASIZE));
Tim Peters2a799bf2002-12-16 20:18:38 +00002534}
2535
2536static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00002537date_reduce(PyDateTime_Date *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00002538{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002539 return Py_BuildValue("(ON)", self->ob_type, date_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002540}
2541
2542static PyMethodDef date_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002543
Tim Peters2a799bf2002-12-16 20:18:38 +00002544 /* Class methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00002545
Tim Peters2a799bf2002-12-16 20:18:38 +00002546 {"fromtimestamp", (PyCFunction)date_fromtimestamp, METH_VARARGS |
2547 METH_CLASS,
2548 PyDoc_STR("timestamp -> local date from a POSIX timestamp (like "
2549 "time.time()).")},
2550
2551 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
2552 METH_CLASS,
2553 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
2554 "ordinal.")},
2555
2556 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
2557 PyDoc_STR("Current date or datetime: same as "
2558 "self.__class__.fromtimestamp(time.time()).")},
2559
2560 /* Instance methods: */
2561
2562 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
2563 PyDoc_STR("Return ctime() style string.")},
2564
2565 {"strftime", (PyCFunction)date_strftime, METH_KEYWORDS,
2566 PyDoc_STR("format -> strftime() style string.")},
2567
2568 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
2569 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
2570
2571 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
2572 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
2573 "weekday.")},
2574
2575 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
2576 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
2577
2578 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
2579 PyDoc_STR("Return the day of the week represented by the date.\n"
2580 "Monday == 1 ... Sunday == 7")},
2581
2582 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
2583 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
2584 "1 is day 1.")},
2585
2586 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
2587 PyDoc_STR("Return the day of the week represented by the date.\n"
2588 "Monday == 0 ... Sunday == 6")},
2589
Tim Peters12bf3392002-12-24 05:41:27 +00002590 {"replace", (PyCFunction)date_replace, METH_KEYWORDS,
2591 PyDoc_STR("Return date with new specified fields.")},
2592
Guido van Rossum177e41a2003-01-30 22:06:23 +00002593 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
2594 PyDoc_STR("__reduce__() -> (cls, state)")},
2595
Tim Peters2a799bf2002-12-16 20:18:38 +00002596 {NULL, NULL}
2597};
2598
2599static char date_doc[] =
2600PyDoc_STR("Basic date type.");
2601
2602static PyNumberMethods date_as_number = {
2603 date_add, /* nb_add */
2604 date_subtract, /* nb_subtract */
2605 0, /* nb_multiply */
2606 0, /* nb_divide */
2607 0, /* nb_remainder */
2608 0, /* nb_divmod */
2609 0, /* nb_power */
2610 0, /* nb_negative */
2611 0, /* nb_positive */
2612 0, /* nb_absolute */
2613 0, /* nb_nonzero */
2614};
2615
2616static PyTypeObject PyDateTime_DateType = {
2617 PyObject_HEAD_INIT(NULL)
2618 0, /* ob_size */
2619 "datetime.date", /* tp_name */
2620 sizeof(PyDateTime_Date), /* tp_basicsize */
2621 0, /* tp_itemsize */
2622 (destructor)PyObject_Del, /* tp_dealloc */
2623 0, /* tp_print */
2624 0, /* tp_getattr */
2625 0, /* tp_setattr */
2626 0, /* tp_compare */
2627 (reprfunc)date_repr, /* tp_repr */
2628 &date_as_number, /* tp_as_number */
2629 0, /* tp_as_sequence */
2630 0, /* tp_as_mapping */
2631 (hashfunc)date_hash, /* tp_hash */
2632 0, /* tp_call */
2633 (reprfunc)date_str, /* tp_str */
2634 PyObject_GenericGetAttr, /* tp_getattro */
2635 0, /* tp_setattro */
2636 0, /* tp_as_buffer */
2637 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2638 Py_TPFLAGS_BASETYPE, /* tp_flags */
2639 date_doc, /* tp_doc */
2640 0, /* tp_traverse */
2641 0, /* tp_clear */
2642 (richcmpfunc)date_richcompare, /* tp_richcompare */
2643 0, /* tp_weaklistoffset */
2644 0, /* tp_iter */
2645 0, /* tp_iternext */
2646 date_methods, /* tp_methods */
2647 0, /* tp_members */
2648 date_getset, /* tp_getset */
2649 0, /* tp_base */
2650 0, /* tp_dict */
2651 0, /* tp_descr_get */
2652 0, /* tp_descr_set */
2653 0, /* tp_dictoffset */
2654 0, /* tp_init */
2655 0, /* tp_alloc */
2656 date_new, /* tp_new */
2657 _PyObject_Del, /* tp_free */
2658};
2659
2660/*
Tim Peters2a799bf2002-12-16 20:18:38 +00002661 * PyDateTime_TZInfo implementation.
2662 */
2663
2664/* This is a pure abstract base class, so doesn't do anything beyond
2665 * raising NotImplemented exceptions. Real tzinfo classes need
2666 * to derive from this. This is mostly for clarity, and for efficiency in
Tim Petersa9bc1682003-01-11 03:39:11 +00002667 * datetime and time constructors (their tzinfo arguments need to
Tim Peters2a799bf2002-12-16 20:18:38 +00002668 * be subclasses of this tzinfo class, which is easy and quick to check).
2669 *
2670 * Note: For reasons having to do with pickling of subclasses, we have
2671 * to allow tzinfo objects to be instantiated. This wasn't an issue
2672 * in the Python implementation (__init__() could raise NotImplementedError
2673 * there without ill effect), but doing so in the C implementation hit a
2674 * brick wall.
2675 */
2676
2677static PyObject *
2678tzinfo_nogo(const char* methodname)
2679{
2680 PyErr_Format(PyExc_NotImplementedError,
2681 "a tzinfo subclass must implement %s()",
2682 methodname);
2683 return NULL;
2684}
2685
2686/* Methods. A subclass must implement these. */
2687
Tim Peters52dcce22003-01-23 16:36:11 +00002688static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002689tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
2690{
2691 return tzinfo_nogo("tzname");
2692}
2693
Tim Peters52dcce22003-01-23 16:36:11 +00002694static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002695tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
2696{
2697 return tzinfo_nogo("utcoffset");
2698}
2699
Tim Peters52dcce22003-01-23 16:36:11 +00002700static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002701tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
2702{
2703 return tzinfo_nogo("dst");
2704}
2705
Tim Peters52dcce22003-01-23 16:36:11 +00002706static PyObject *
2707tzinfo_fromutc(PyDateTime_TZInfo *self, PyDateTime_DateTime *dt)
2708{
2709 int y, m, d, hh, mm, ss, us;
2710
2711 PyObject *result;
2712 int off, dst;
2713 int none;
2714 int delta;
2715
2716 if (! PyDateTime_Check(dt)) {
2717 PyErr_SetString(PyExc_TypeError,
2718 "fromutc: argument must be a datetime");
2719 return NULL;
2720 }
2721 if (! HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
2722 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
2723 "is not self");
2724 return NULL;
2725 }
2726
2727 off = call_utcoffset(dt->tzinfo, (PyObject *)dt, &none);
2728 if (off == -1 && PyErr_Occurred())
2729 return NULL;
2730 if (none) {
2731 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2732 "utcoffset() result required");
2733 return NULL;
2734 }
2735
2736 dst = call_dst(dt->tzinfo, (PyObject *)dt, &none);
2737 if (dst == -1 && PyErr_Occurred())
2738 return NULL;
2739 if (none) {
2740 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2741 "dst() result required");
2742 return NULL;
2743 }
2744
2745 y = GET_YEAR(dt);
2746 m = GET_MONTH(dt);
2747 d = GET_DAY(dt);
2748 hh = DATE_GET_HOUR(dt);
2749 mm = DATE_GET_MINUTE(dt);
2750 ss = DATE_GET_SECOND(dt);
2751 us = DATE_GET_MICROSECOND(dt);
2752
2753 delta = off - dst;
2754 mm += delta;
2755 if ((mm < 0 || mm >= 60) &&
2756 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Petersb1049e82003-01-23 17:20:36 +00002757 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00002758 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2759 if (result == NULL)
2760 return result;
2761
2762 dst = call_dst(dt->tzinfo, result, &none);
2763 if (dst == -1 && PyErr_Occurred())
2764 goto Fail;
2765 if (none)
2766 goto Inconsistent;
2767 if (dst == 0)
2768 return result;
2769
2770 mm += dst;
2771 if ((mm < 0 || mm >= 60) &&
2772 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
2773 goto Fail;
2774 Py_DECREF(result);
2775 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2776 return result;
2777
2778Inconsistent:
2779 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave"
2780 "inconsistent results; cannot convert");
2781
2782 /* fall thru to failure */
2783Fail:
2784 Py_DECREF(result);
2785 return NULL;
2786}
2787
Tim Peters2a799bf2002-12-16 20:18:38 +00002788/*
2789 * Pickle support. This is solely so that tzinfo subclasses can use
Guido van Rossum177e41a2003-01-30 22:06:23 +00002790 * pickling -- tzinfo itself is supposed to be uninstantiable.
Tim Peters2a799bf2002-12-16 20:18:38 +00002791 */
2792
Guido van Rossum177e41a2003-01-30 22:06:23 +00002793static PyObject *
2794tzinfo_reduce(PyObject *self)
2795{
2796 PyObject *args, *state, *tmp;
2797 PyObject *getinitargs, *getstate;
Tim Peters2a799bf2002-12-16 20:18:38 +00002798
Guido van Rossum177e41a2003-01-30 22:06:23 +00002799 tmp = PyTuple_New(0);
2800 if (tmp == NULL)
2801 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002802
Guido van Rossum177e41a2003-01-30 22:06:23 +00002803 getinitargs = PyObject_GetAttrString(self, "__getinitargs__");
2804 if (getinitargs != NULL) {
2805 args = PyObject_CallObject(getinitargs, tmp);
2806 Py_DECREF(getinitargs);
2807 if (args == NULL) {
2808 Py_DECREF(tmp);
2809 return NULL;
2810 }
2811 }
2812 else {
2813 PyErr_Clear();
2814 args = tmp;
2815 Py_INCREF(args);
2816 }
2817
2818 getstate = PyObject_GetAttrString(self, "__getstate__");
2819 if (getstate != NULL) {
2820 state = PyObject_CallObject(getstate, tmp);
2821 Py_DECREF(getstate);
2822 if (state == NULL) {
2823 Py_DECREF(args);
2824 Py_DECREF(tmp);
2825 return NULL;
2826 }
2827 }
2828 else {
2829 PyObject **dictptr;
2830 PyErr_Clear();
2831 state = Py_None;
2832 dictptr = _PyObject_GetDictPtr(self);
2833 if (dictptr && *dictptr && PyDict_Size(*dictptr))
2834 state = *dictptr;
2835 Py_INCREF(state);
2836 }
2837
2838 Py_DECREF(tmp);
2839
2840 if (state == Py_None) {
2841 Py_DECREF(state);
2842 return Py_BuildValue("(ON)", self->ob_type, args);
2843 }
2844 else
2845 return Py_BuildValue("(ONN)", self->ob_type, args, state);
2846}
Tim Peters2a799bf2002-12-16 20:18:38 +00002847
2848static PyMethodDef tzinfo_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002849
Tim Peters2a799bf2002-12-16 20:18:38 +00002850 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
2851 PyDoc_STR("datetime -> string name of time zone.")},
2852
2853 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
2854 PyDoc_STR("datetime -> minutes east of UTC (negative for "
2855 "west of UTC).")},
2856
2857 {"dst", (PyCFunction)tzinfo_dst, METH_O,
2858 PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
2859
Tim Peters52dcce22003-01-23 16:36:11 +00002860 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
2861 PyDoc_STR("datetime in UTC -> datetime in local time.")},
2862
Guido van Rossum177e41a2003-01-30 22:06:23 +00002863 {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
2864 PyDoc_STR("-> (cls, state)")},
2865
Tim Peters2a799bf2002-12-16 20:18:38 +00002866 {NULL, NULL}
2867};
2868
2869static char tzinfo_doc[] =
2870PyDoc_STR("Abstract base class for time zone info objects.");
2871
2872 statichere PyTypeObject PyDateTime_TZInfoType = {
2873 PyObject_HEAD_INIT(NULL)
2874 0, /* ob_size */
2875 "datetime.tzinfo", /* tp_name */
2876 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
2877 0, /* tp_itemsize */
2878 0, /* tp_dealloc */
2879 0, /* tp_print */
2880 0, /* tp_getattr */
2881 0, /* tp_setattr */
2882 0, /* tp_compare */
2883 0, /* tp_repr */
2884 0, /* tp_as_number */
2885 0, /* tp_as_sequence */
2886 0, /* tp_as_mapping */
2887 0, /* tp_hash */
2888 0, /* tp_call */
2889 0, /* tp_str */
2890 PyObject_GenericGetAttr, /* tp_getattro */
2891 0, /* tp_setattro */
2892 0, /* tp_as_buffer */
2893 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2894 Py_TPFLAGS_BASETYPE, /* tp_flags */
2895 tzinfo_doc, /* tp_doc */
2896 0, /* tp_traverse */
2897 0, /* tp_clear */
2898 0, /* tp_richcompare */
2899 0, /* tp_weaklistoffset */
2900 0, /* tp_iter */
2901 0, /* tp_iternext */
2902 tzinfo_methods, /* tp_methods */
2903 0, /* tp_members */
2904 0, /* tp_getset */
2905 0, /* tp_base */
2906 0, /* tp_dict */
2907 0, /* tp_descr_get */
2908 0, /* tp_descr_set */
2909 0, /* tp_dictoffset */
2910 0, /* tp_init */
2911 0, /* tp_alloc */
2912 PyType_GenericNew, /* tp_new */
2913 0, /* tp_free */
2914};
2915
2916/*
Tim Peters37f39822003-01-10 03:49:02 +00002917 * PyDateTime_Time implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00002918 */
2919
Tim Peters37f39822003-01-10 03:49:02 +00002920/* Accessor properties.
Tim Peters2a799bf2002-12-16 20:18:38 +00002921 */
2922
2923static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00002924time_hour(PyDateTime_Time *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00002925{
Tim Peters37f39822003-01-10 03:49:02 +00002926 return PyInt_FromLong(TIME_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002927}
2928
Tim Peters37f39822003-01-10 03:49:02 +00002929static PyObject *
2930time_minute(PyDateTime_Time *self, void *unused)
2931{
2932 return PyInt_FromLong(TIME_GET_MINUTE(self));
2933}
2934
2935/* The name time_second conflicted with some platform header file. */
2936static PyObject *
2937py_time_second(PyDateTime_Time *self, void *unused)
2938{
2939 return PyInt_FromLong(TIME_GET_SECOND(self));
2940}
2941
2942static PyObject *
2943time_microsecond(PyDateTime_Time *self, void *unused)
2944{
2945 return PyInt_FromLong(TIME_GET_MICROSECOND(self));
2946}
2947
2948static PyObject *
2949time_tzinfo(PyDateTime_Time *self, void *unused)
2950{
Tim Petersa032d2e2003-01-11 00:15:54 +00002951 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters37f39822003-01-10 03:49:02 +00002952 Py_INCREF(result);
2953 return result;
2954}
2955
2956static PyGetSetDef time_getset[] = {
2957 {"hour", (getter)time_hour},
2958 {"minute", (getter)time_minute},
2959 {"second", (getter)py_time_second},
2960 {"microsecond", (getter)time_microsecond},
2961 {"tzinfo", (getter)time_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00002962 {NULL}
2963};
2964
2965/*
2966 * Constructors.
2967 */
2968
Tim Peters37f39822003-01-10 03:49:02 +00002969static char *time_kws[] = {"hour", "minute", "second", "microsecond",
2970 "tzinfo", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002971
Tim Peters506be282003-01-31 22:27:17 +00002972/* __setstate__ isn't exposed. */
2973static PyObject *
2974time_setstate(PyDateTime_Time *self, PyObject *state)
2975{
2976 PyObject *basestate;
2977 PyObject *tzinfo = Py_None;
2978
2979 if (! PyArg_ParseTuple(state, "O!|O:__setstate__",
2980 &PyString_Type, &basestate,
2981 &tzinfo))
2982 return NULL;
2983 if (PyString_Size(basestate) != _PyDateTime_TIME_DATASIZE ||
2984 check_tzinfo_subclass(tzinfo) < 0) {
2985 PyErr_SetString(PyExc_TypeError,
2986 "bad argument to time.__setstate__");
2987 return NULL;
2988 }
2989 if (tzinfo != Py_None && ! HASTZINFO(self)) {
2990 PyErr_SetString(PyExc_ValueError, "time.__setstate__ can't "
2991 "add a non-None tzinfo to a time object that "
2992 "doesn't have one already");
2993 return NULL;
2994 }
2995 memcpy((char *)self->data,
2996 PyString_AsString(basestate),
2997 _PyDateTime_TIME_DATASIZE);
2998 self->hashcode = -1;
2999 if (HASTZINFO(self)) {
3000 Py_INCREF(tzinfo);
3001 Py_XDECREF(self->tzinfo);
3002 self->tzinfo = tzinfo;
3003 }
3004 Py_INCREF(Py_None);
3005 return Py_None;
3006}
Guido van Rossum177e41a2003-01-30 22:06:23 +00003007
Tim Peters2a799bf2002-12-16 20:18:38 +00003008static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003009time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003010{
3011 PyObject *self = NULL;
3012 int hour = 0;
3013 int minute = 0;
3014 int second = 0;
3015 int usecond = 0;
3016 PyObject *tzinfo = Py_None;
3017
Guido van Rossum177e41a2003-01-30 22:06:23 +00003018 /* Check for invocation from pickle with __getstate__ state */
3019 if (PyTuple_GET_SIZE(args) >= 1 &&
3020 PyTuple_GET_SIZE(args) <= 2 &&
3021 PyString_Check(PyTuple_GET_ITEM(args, 0)))
3022 {
3023 if (PyTuple_GET_SIZE(args) == 2)
3024 tzinfo = PyTuple_GET_ITEM(args, 1);
3025 self = new_time(0, 0, 0, 0, tzinfo);
3026 if (self != NULL) {
3027 PyObject *res = time_setstate(
3028 (PyDateTime_Time *)self, args);
3029 if (res == Py_None)
3030 Py_DECREF(res);
3031 else {
3032 Py_DECREF(self);
3033 self = NULL;
3034 }
3035 }
3036 return self;
3037 }
3038
Tim Peters37f39822003-01-10 03:49:02 +00003039 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO", time_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003040 &hour, &minute, &second, &usecond,
3041 &tzinfo)) {
3042 if (check_time_args(hour, minute, second, usecond) < 0)
3043 return NULL;
3044 if (check_tzinfo_subclass(tzinfo) < 0)
3045 return NULL;
Tim Peters37f39822003-01-10 03:49:02 +00003046 self = new_time(hour, minute, second, usecond, tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00003047 }
3048 return self;
3049}
3050
3051/*
3052 * Destructor.
3053 */
3054
3055static void
Tim Peters37f39822003-01-10 03:49:02 +00003056time_dealloc(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003057{
Tim Petersa032d2e2003-01-11 00:15:54 +00003058 if (HASTZINFO(self)) {
Tim Peters37f39822003-01-10 03:49:02 +00003059 Py_XDECREF(self->tzinfo);
Neal Norwitz8e914d92003-01-10 15:29:16 +00003060 }
Tim Peters2a799bf2002-12-16 20:18:38 +00003061 self->ob_type->tp_free((PyObject *)self);
3062}
3063
3064/*
Tim Peters855fe882002-12-22 03:43:39 +00003065 * Indirect access to tzinfo methods.
Tim Peters2a799bf2002-12-16 20:18:38 +00003066 */
3067
Tim Peters2a799bf2002-12-16 20:18:38 +00003068/* These are all METH_NOARGS, so don't need to check the arglist. */
3069static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003070time_utcoffset(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003071 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003072 "utcoffset", Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003073}
3074
3075static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003076time_dst(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003077 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003078 "dst", Py_None);
Tim Peters855fe882002-12-22 03:43:39 +00003079}
3080
3081static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003082time_tzname(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003083 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003084 Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003085}
3086
3087/*
Tim Peters37f39822003-01-10 03:49:02 +00003088 * Various ways to turn a time into a string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003089 */
3090
3091static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003092time_repr(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003093{
Tim Peters37f39822003-01-10 03:49:02 +00003094 char buffer[100];
3095 char *typename = self->ob_type->tp_name;
3096 int h = TIME_GET_HOUR(self);
3097 int m = TIME_GET_MINUTE(self);
3098 int s = TIME_GET_SECOND(self);
3099 int us = TIME_GET_MICROSECOND(self);
3100 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003101
Tim Peters37f39822003-01-10 03:49:02 +00003102 if (us)
3103 PyOS_snprintf(buffer, sizeof(buffer),
3104 "%s(%d, %d, %d, %d)", typename, h, m, s, us);
3105 else if (s)
3106 PyOS_snprintf(buffer, sizeof(buffer),
3107 "%s(%d, %d, %d)", typename, h, m, s);
3108 else
3109 PyOS_snprintf(buffer, sizeof(buffer),
3110 "%s(%d, %d)", typename, h, m);
3111 result = PyString_FromString(buffer);
Tim Petersa032d2e2003-01-11 00:15:54 +00003112 if (result != NULL && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +00003113 result = append_keyword_tzinfo(result, self->tzinfo);
3114 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003115}
3116
Tim Peters37f39822003-01-10 03:49:02 +00003117static PyObject *
3118time_str(PyDateTime_Time *self)
3119{
3120 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
3121}
Tim Peters2a799bf2002-12-16 20:18:38 +00003122
3123static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003124time_isoformat(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003125{
3126 char buf[100];
Tim Peters37f39822003-01-10 03:49:02 +00003127 PyObject *result;
3128 /* Reuse the time format code from the datetime type. */
3129 PyDateTime_DateTime datetime;
3130 PyDateTime_DateTime *pdatetime = &datetime;
Tim Peters2a799bf2002-12-16 20:18:38 +00003131
Tim Peters37f39822003-01-10 03:49:02 +00003132 /* Copy over just the time bytes. */
3133 memcpy(pdatetime->data + _PyDateTime_DATE_DATASIZE,
3134 self->data,
3135 _PyDateTime_TIME_DATASIZE);
3136
3137 isoformat_time(pdatetime, buf, sizeof(buf));
3138 result = PyString_FromString(buf);
Tim Petersa032d2e2003-01-11 00:15:54 +00003139 if (result == NULL || ! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00003140 return result;
3141
3142 /* We need to append the UTC offset. */
3143 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00003144 Py_None) < 0) {
Tim Peters2a799bf2002-12-16 20:18:38 +00003145 Py_DECREF(result);
3146 return NULL;
3147 }
3148 PyString_ConcatAndDel(&result, PyString_FromString(buf));
3149 return result;
3150}
3151
Tim Peters37f39822003-01-10 03:49:02 +00003152static PyObject *
3153time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3154{
3155 PyObject *result;
3156 PyObject *format;
3157 PyObject *tuple;
3158 static char *keywords[] = {"format", NULL};
3159
3160 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
3161 &PyString_Type, &format))
3162 return NULL;
3163
3164 /* Python's strftime does insane things with the year part of the
3165 * timetuple. The year is forced to (the otherwise nonsensical)
3166 * 1900 to worm around that.
3167 */
3168 tuple = Py_BuildValue("iiiiiiiii",
3169 1900, 0, 0, /* year, month, day */
3170 TIME_GET_HOUR(self),
3171 TIME_GET_MINUTE(self),
3172 TIME_GET_SECOND(self),
3173 0, 0, -1); /* weekday, daynum, dst */
3174 if (tuple == NULL)
3175 return NULL;
3176 assert(PyTuple_Size(tuple) == 9);
3177 result = wrap_strftime((PyObject *)self, format, tuple, Py_None);
3178 Py_DECREF(tuple);
3179 return result;
3180}
Tim Peters2a799bf2002-12-16 20:18:38 +00003181
3182/*
3183 * Miscellaneous methods.
3184 */
3185
Tim Peters37f39822003-01-10 03:49:02 +00003186/* This is more natural as a tp_compare, but doesn't work then: for whatever
3187 * reason, Python's try_3way_compare ignores tp_compare unless
3188 * PyInstance_Check returns true, but these aren't old-style classes.
3189 */
3190static PyObject *
3191time_richcompare(PyDateTime_Time *self, PyObject *other, int op)
3192{
3193 int diff;
3194 naivety n1, n2;
3195 int offset1, offset2;
3196
3197 if (! PyTime_Check(other)) {
3198 /* Stop this from falling back to address comparison. */
3199 PyErr_Format(PyExc_TypeError,
3200 "can't compare '%s' to '%s'",
3201 self->ob_type->tp_name,
3202 other->ob_type->tp_name);
3203 return NULL;
3204 }
3205 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1, Py_None,
3206 other, &offset2, &n2, Py_None) < 0)
3207 return NULL;
3208 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
3209 /* If they're both naive, or both aware and have the same offsets,
3210 * we get off cheap. Note that if they're both naive, offset1 ==
3211 * offset2 == 0 at this point.
3212 */
3213 if (n1 == n2 && offset1 == offset2) {
3214 diff = memcmp(self->data, ((PyDateTime_Time *)other)->data,
3215 _PyDateTime_TIME_DATASIZE);
3216 return diff_to_bool(diff, op);
3217 }
3218
3219 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
3220 assert(offset1 != offset2); /* else last "if" handled it */
3221 /* Convert everything except microseconds to seconds. These
3222 * can't overflow (no more than the # of seconds in 2 days).
3223 */
3224 offset1 = TIME_GET_HOUR(self) * 3600 +
3225 (TIME_GET_MINUTE(self) - offset1) * 60 +
3226 TIME_GET_SECOND(self);
3227 offset2 = TIME_GET_HOUR(other) * 3600 +
3228 (TIME_GET_MINUTE(other) - offset2) * 60 +
3229 TIME_GET_SECOND(other);
3230 diff = offset1 - offset2;
3231 if (diff == 0)
3232 diff = TIME_GET_MICROSECOND(self) -
3233 TIME_GET_MICROSECOND(other);
3234 return diff_to_bool(diff, op);
3235 }
3236
3237 assert(n1 != n2);
3238 PyErr_SetString(PyExc_TypeError,
3239 "can't compare offset-naive and "
3240 "offset-aware times");
3241 return NULL;
3242}
3243
3244static long
3245time_hash(PyDateTime_Time *self)
3246{
3247 if (self->hashcode == -1) {
3248 naivety n;
3249 int offset;
3250 PyObject *temp;
3251
3252 n = classify_utcoffset((PyObject *)self, Py_None, &offset);
3253 assert(n != OFFSET_UNKNOWN);
3254 if (n == OFFSET_ERROR)
3255 return -1;
3256
3257 /* Reduce this to a hash of another object. */
3258 if (offset == 0)
3259 temp = PyString_FromStringAndSize((char *)self->data,
3260 _PyDateTime_TIME_DATASIZE);
3261 else {
3262 int hour;
3263 int minute;
3264
3265 assert(n == OFFSET_AWARE);
Tim Petersa032d2e2003-01-11 00:15:54 +00003266 assert(HASTZINFO(self));
Tim Peters37f39822003-01-10 03:49:02 +00003267 hour = divmod(TIME_GET_HOUR(self) * 60 +
3268 TIME_GET_MINUTE(self) - offset,
3269 60,
3270 &minute);
3271 if (0 <= hour && hour < 24)
3272 temp = new_time(hour, minute,
3273 TIME_GET_SECOND(self),
3274 TIME_GET_MICROSECOND(self),
3275 Py_None);
3276 else
3277 temp = Py_BuildValue("iiii",
3278 hour, minute,
3279 TIME_GET_SECOND(self),
3280 TIME_GET_MICROSECOND(self));
3281 }
3282 if (temp != NULL) {
3283 self->hashcode = PyObject_Hash(temp);
3284 Py_DECREF(temp);
3285 }
3286 }
3287 return self->hashcode;
3288}
Tim Peters2a799bf2002-12-16 20:18:38 +00003289
Tim Peters12bf3392002-12-24 05:41:27 +00003290static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003291time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00003292{
3293 PyObject *clone;
3294 PyObject *tuple;
3295 int hh = TIME_GET_HOUR(self);
3296 int mm = TIME_GET_MINUTE(self);
3297 int ss = TIME_GET_SECOND(self);
3298 int us = TIME_GET_MICROSECOND(self);
Tim Petersa032d2e2003-01-11 00:15:54 +00003299 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00003300
3301 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO:replace",
Tim Peters37f39822003-01-10 03:49:02 +00003302 time_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00003303 &hh, &mm, &ss, &us, &tzinfo))
3304 return NULL;
3305 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
3306 if (tuple == NULL)
3307 return NULL;
Tim Peters37f39822003-01-10 03:49:02 +00003308 clone = time_new(self->ob_type, tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00003309 Py_DECREF(tuple);
3310 return clone;
3311}
3312
Tim Peters2a799bf2002-12-16 20:18:38 +00003313static int
Tim Peters37f39822003-01-10 03:49:02 +00003314time_nonzero(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003315{
3316 int offset;
3317 int none;
3318
3319 if (TIME_GET_SECOND(self) || TIME_GET_MICROSECOND(self)) {
3320 /* Since utcoffset is in whole minutes, nothing can
3321 * alter the conclusion that this is nonzero.
3322 */
3323 return 1;
3324 }
3325 offset = 0;
Tim Petersa032d2e2003-01-11 00:15:54 +00003326 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Petersbad8ff02002-12-30 20:52:32 +00003327 offset = call_utcoffset(self->tzinfo, Py_None, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00003328 if (offset == -1 && PyErr_Occurred())
3329 return -1;
3330 }
3331 return (TIME_GET_MINUTE(self) - offset + TIME_GET_HOUR(self)*60) != 0;
3332}
3333
Tim Peters371935f2003-02-01 01:52:50 +00003334/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003335
Tim Peters33e0f382003-01-10 02:05:14 +00003336/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003337 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
3338 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00003339 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00003340 */
3341static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003342time_getstate(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003343{
3344 PyObject *basestate;
3345 PyObject *result = NULL;
3346
Tim Peters33e0f382003-01-10 02:05:14 +00003347 basestate = PyString_FromStringAndSize((char *)self->data,
3348 _PyDateTime_TIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00003349 if (basestate != NULL) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003350 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00003351 result = Py_BuildValue("(O)", basestate);
3352 else
3353 result = Py_BuildValue("OO", basestate, self->tzinfo);
3354 Py_DECREF(basestate);
3355 }
3356 return result;
3357}
3358
3359static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00003360time_reduce(PyDateTime_Time *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00003361{
Guido van Rossum177e41a2003-01-30 22:06:23 +00003362 return Py_BuildValue("(ON)", self->ob_type, time_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003363}
3364
Tim Peters37f39822003-01-10 03:49:02 +00003365static PyMethodDef time_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003366
Tim Peters37f39822003-01-10 03:49:02 +00003367 {"isoformat", (PyCFunction)time_isoformat, METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003368 PyDoc_STR("Return string in ISO 8601 format, HH:MM:SS[.mmmmmm]"
3369 "[+HH:MM].")},
3370
Tim Peters37f39822003-01-10 03:49:02 +00003371 {"strftime", (PyCFunction)time_strftime, METH_KEYWORDS,
3372 PyDoc_STR("format -> strftime() style string.")},
3373
3374 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003375 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
3376
Tim Peters37f39822003-01-10 03:49:02 +00003377 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003378 PyDoc_STR("Return self.tzinfo.tzname(self).")},
3379
Tim Peters37f39822003-01-10 03:49:02 +00003380 {"dst", (PyCFunction)time_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003381 PyDoc_STR("Return self.tzinfo.dst(self).")},
3382
Tim Peters37f39822003-01-10 03:49:02 +00003383 {"replace", (PyCFunction)time_replace, METH_KEYWORDS,
3384 PyDoc_STR("Return time with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00003385
Guido van Rossum177e41a2003-01-30 22:06:23 +00003386 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
3387 PyDoc_STR("__reduce__() -> (cls, state)")},
3388
Tim Peters2a799bf2002-12-16 20:18:38 +00003389 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003390};
3391
Tim Peters37f39822003-01-10 03:49:02 +00003392static char time_doc[] =
Tim Peters2a799bf2002-12-16 20:18:38 +00003393PyDoc_STR("Time type.");
3394
Tim Peters37f39822003-01-10 03:49:02 +00003395static PyNumberMethods time_as_number = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003396 0, /* nb_add */
3397 0, /* nb_subtract */
3398 0, /* nb_multiply */
3399 0, /* nb_divide */
3400 0, /* nb_remainder */
3401 0, /* nb_divmod */
3402 0, /* nb_power */
3403 0, /* nb_negative */
3404 0, /* nb_positive */
3405 0, /* nb_absolute */
Tim Peters37f39822003-01-10 03:49:02 +00003406 (inquiry)time_nonzero, /* nb_nonzero */
Tim Peters2a799bf2002-12-16 20:18:38 +00003407};
3408
Tim Peters37f39822003-01-10 03:49:02 +00003409statichere PyTypeObject PyDateTime_TimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003410 PyObject_HEAD_INIT(NULL)
3411 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00003412 "datetime.time", /* tp_name */
Tim Peters37f39822003-01-10 03:49:02 +00003413 sizeof(PyDateTime_Time), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00003414 0, /* tp_itemsize */
Tim Peters37f39822003-01-10 03:49:02 +00003415 (destructor)time_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003416 0, /* tp_print */
3417 0, /* tp_getattr */
3418 0, /* tp_setattr */
3419 0, /* tp_compare */
Tim Peters37f39822003-01-10 03:49:02 +00003420 (reprfunc)time_repr, /* tp_repr */
3421 &time_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00003422 0, /* tp_as_sequence */
3423 0, /* tp_as_mapping */
Tim Peters37f39822003-01-10 03:49:02 +00003424 (hashfunc)time_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00003425 0, /* tp_call */
Tim Peters37f39822003-01-10 03:49:02 +00003426 (reprfunc)time_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00003427 PyObject_GenericGetAttr, /* tp_getattro */
3428 0, /* tp_setattro */
3429 0, /* tp_as_buffer */
3430 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
3431 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters37f39822003-01-10 03:49:02 +00003432 time_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003433 0, /* tp_traverse */
3434 0, /* tp_clear */
Tim Peters37f39822003-01-10 03:49:02 +00003435 (richcmpfunc)time_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00003436 0, /* tp_weaklistoffset */
3437 0, /* tp_iter */
3438 0, /* tp_iternext */
Tim Peters37f39822003-01-10 03:49:02 +00003439 time_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00003440 0, /* tp_members */
Tim Peters37f39822003-01-10 03:49:02 +00003441 time_getset, /* tp_getset */
3442 0, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00003443 0, /* tp_dict */
3444 0, /* tp_descr_get */
3445 0, /* tp_descr_set */
3446 0, /* tp_dictoffset */
3447 0, /* tp_init */
3448 0, /* tp_alloc */
Tim Peters37f39822003-01-10 03:49:02 +00003449 time_new, /* tp_new */
Tim Peters2a799bf2002-12-16 20:18:38 +00003450 _PyObject_Del, /* tp_free */
3451};
3452
3453/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003454 * PyDateTime_DateTime implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003455 */
3456
Tim Petersa9bc1682003-01-11 03:39:11 +00003457/* Accessor properties. Properties for day, month, and year are inherited
3458 * from date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003459 */
3460
3461static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003462datetime_hour(PyDateTime_DateTime *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003463{
Tim Petersa9bc1682003-01-11 03:39:11 +00003464 return PyInt_FromLong(DATE_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003465}
3466
Tim Petersa9bc1682003-01-11 03:39:11 +00003467static PyObject *
3468datetime_minute(PyDateTime_DateTime *self, void *unused)
3469{
3470 return PyInt_FromLong(DATE_GET_MINUTE(self));
3471}
3472
3473static PyObject *
3474datetime_second(PyDateTime_DateTime *self, void *unused)
3475{
3476 return PyInt_FromLong(DATE_GET_SECOND(self));
3477}
3478
3479static PyObject *
3480datetime_microsecond(PyDateTime_DateTime *self, void *unused)
3481{
3482 return PyInt_FromLong(DATE_GET_MICROSECOND(self));
3483}
3484
3485static PyObject *
3486datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
3487{
3488 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3489 Py_INCREF(result);
3490 return result;
3491}
3492
3493static PyGetSetDef datetime_getset[] = {
3494 {"hour", (getter)datetime_hour},
3495 {"minute", (getter)datetime_minute},
3496 {"second", (getter)datetime_second},
3497 {"microsecond", (getter)datetime_microsecond},
3498 {"tzinfo", (getter)datetime_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003499 {NULL}
3500};
3501
3502/*
3503 * Constructors.
Tim Peters2a799bf2002-12-16 20:18:38 +00003504 */
3505
Tim Petersa9bc1682003-01-11 03:39:11 +00003506static char *datetime_kws[] = {
Tim Peters12bf3392002-12-24 05:41:27 +00003507 "year", "month", "day", "hour", "minute", "second",
3508 "microsecond", "tzinfo", NULL
3509};
3510
Tim Peters506be282003-01-31 22:27:17 +00003511/* __setstate__ isn't exposed. */
3512static PyObject *
3513datetime_setstate(PyDateTime_DateTime *self, PyObject *state)
3514{
3515 PyObject *basestate;
3516 PyObject *tzinfo = Py_None;
3517
3518 if (! PyArg_ParseTuple(state, "O!|O:__setstate__",
3519 &PyString_Type, &basestate,
3520 &tzinfo))
3521 return NULL;
3522 if (PyString_Size(basestate) != _PyDateTime_DATETIME_DATASIZE ||
3523 check_tzinfo_subclass(tzinfo) < 0) {
3524 PyErr_SetString(PyExc_TypeError,
3525 "bad argument to datetime.__setstate__");
3526 return NULL;
3527 }
3528 if (tzinfo != Py_None && ! HASTZINFO(self)) {
3529 PyErr_SetString(PyExc_ValueError, "datetime.__setstate__ "
3530 "can't add a non-None tzinfo to a datetime "
3531 "object that doesn't have one already");
3532 return NULL;
3533 }
3534 memcpy((char *)self->data,
3535 PyString_AsString(basestate),
3536 _PyDateTime_DATETIME_DATASIZE);
3537 self->hashcode = -1;
3538 if (HASTZINFO(self)) {
3539 Py_INCREF(tzinfo);
3540 Py_XDECREF(self->tzinfo);
3541 self->tzinfo = tzinfo;
3542 }
3543 Py_INCREF(Py_None);
3544 return Py_None;
3545}
Guido van Rossum177e41a2003-01-30 22:06:23 +00003546
Tim Peters2a799bf2002-12-16 20:18:38 +00003547static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003548datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003549{
3550 PyObject *self = NULL;
3551 int year;
3552 int month;
3553 int day;
3554 int hour = 0;
3555 int minute = 0;
3556 int second = 0;
3557 int usecond = 0;
3558 PyObject *tzinfo = Py_None;
3559
Guido van Rossum177e41a2003-01-30 22:06:23 +00003560 /* Check for invocation from pickle with __getstate__ state */
3561 if (PyTuple_GET_SIZE(args) >= 1 &&
3562 PyTuple_GET_SIZE(args) <= 2 &&
3563 PyString_Check(PyTuple_GET_ITEM(args, 0)))
3564 {
3565 if (PyTuple_GET_SIZE(args) == 2)
3566 tzinfo = PyTuple_GET_ITEM(args, 1);
3567 self = new_datetime(1, 1, 1, 0, 0, 0, 0, tzinfo);
3568 if (self != NULL) {
3569 PyObject *res = datetime_setstate(
3570 (PyDateTime_DateTime *)self, args);
3571 if (res == Py_None)
3572 Py_DECREF(res);
3573 else {
3574 Py_DECREF(self);
3575 self = NULL;
3576 }
3577 }
3578 return self;
3579 }
3580
Tim Petersa9bc1682003-01-11 03:39:11 +00003581 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO", datetime_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003582 &year, &month, &day, &hour, &minute,
3583 &second, &usecond, &tzinfo)) {
3584 if (check_date_args(year, month, day) < 0)
3585 return NULL;
3586 if (check_time_args(hour, minute, second, usecond) < 0)
3587 return NULL;
3588 if (check_tzinfo_subclass(tzinfo) < 0)
3589 return NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00003590 self = new_datetime(year, month, day,
3591 hour, minute, second, usecond,
3592 tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00003593 }
3594 return self;
3595}
3596
Tim Petersa9bc1682003-01-11 03:39:11 +00003597/* TM_FUNC is the shared type of localtime() and gmtime(). */
3598typedef struct tm *(*TM_FUNC)(const time_t *timer);
3599
3600/* Internal helper.
3601 * Build datetime from a time_t and a distinct count of microseconds.
3602 * Pass localtime or gmtime for f, to control the interpretation of timet.
3603 */
3604static PyObject *
3605datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
3606 PyObject *tzinfo)
3607{
3608 struct tm *tm;
3609 PyObject *result = NULL;
3610
3611 tm = f(&timet);
3612 if (tm) {
3613 /* The platform localtime/gmtime may insert leap seconds,
3614 * indicated by tm->tm_sec > 59. We don't care about them,
3615 * except to the extent that passing them on to the datetime
3616 * constructor would raise ValueError for a reason that
3617 * made no sense to the user.
3618 */
3619 if (tm->tm_sec > 59)
3620 tm->tm_sec = 59;
3621 result = PyObject_CallFunction(cls, "iiiiiiiO",
3622 tm->tm_year + 1900,
3623 tm->tm_mon + 1,
3624 tm->tm_mday,
3625 tm->tm_hour,
3626 tm->tm_min,
3627 tm->tm_sec,
3628 us,
3629 tzinfo);
3630 }
3631 else
3632 PyErr_SetString(PyExc_ValueError,
3633 "timestamp out of range for "
3634 "platform localtime()/gmtime() function");
3635 return result;
3636}
3637
3638/* Internal helper.
3639 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
3640 * to control the interpretation of the timestamp. Since a double doesn't
3641 * have enough bits to cover a datetime's full range of precision, it's
3642 * better to call datetime_from_timet_and_us provided you have a way
3643 * to get that much precision (e.g., C time() isn't good enough).
3644 */
3645static PyObject *
3646datetime_from_timestamp(PyObject *cls, TM_FUNC f, double timestamp,
3647 PyObject *tzinfo)
3648{
3649 time_t timet = (time_t)timestamp;
3650 double fraction = timestamp - (double)timet;
3651 int us = (int)round_to_long(fraction * 1e6);
3652
3653 return datetime_from_timet_and_us(cls, f, timet, us, tzinfo);
3654}
3655
3656/* Internal helper.
3657 * Build most accurate possible datetime for current time. Pass localtime or
3658 * gmtime for f as appropriate.
3659 */
3660static PyObject *
3661datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
3662{
3663#ifdef HAVE_GETTIMEOFDAY
3664 struct timeval t;
3665
3666#ifdef GETTIMEOFDAY_NO_TZ
3667 gettimeofday(&t);
3668#else
3669 gettimeofday(&t, (struct timezone *)NULL);
3670#endif
3671 return datetime_from_timet_and_us(cls, f, t.tv_sec, (int)t.tv_usec,
3672 tzinfo);
3673
3674#else /* ! HAVE_GETTIMEOFDAY */
3675 /* No flavor of gettimeofday exists on this platform. Python's
3676 * time.time() does a lot of other platform tricks to get the
3677 * best time it can on the platform, and we're not going to do
3678 * better than that (if we could, the better code would belong
3679 * in time.time()!) We're limited by the precision of a double,
3680 * though.
3681 */
3682 PyObject *time;
3683 double dtime;
3684
3685 time = time_time();
3686 if (time == NULL)
3687 return NULL;
3688 dtime = PyFloat_AsDouble(time);
3689 Py_DECREF(time);
3690 if (dtime == -1.0 && PyErr_Occurred())
3691 return NULL;
3692 return datetime_from_timestamp(cls, f, dtime, tzinfo);
3693#endif /* ! HAVE_GETTIMEOFDAY */
3694}
3695
Tim Peters2a799bf2002-12-16 20:18:38 +00003696/* Return best possible local time -- this isn't constrained by the
3697 * precision of a timestamp.
3698 */
3699static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003700datetime_now(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003701{
Tim Peters10cadce2003-01-23 19:58:02 +00003702 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003703 PyObject *tzinfo = Py_None;
Tim Peters10cadce2003-01-23 19:58:02 +00003704 static char *keywords[] = {"tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003705
Tim Peters10cadce2003-01-23 19:58:02 +00003706 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:now", keywords,
3707 &tzinfo))
3708 return NULL;
3709 if (check_tzinfo_subclass(tzinfo) < 0)
3710 return NULL;
3711
3712 self = datetime_best_possible(cls,
3713 tzinfo == Py_None ? localtime : gmtime,
3714 tzinfo);
3715 if (self != NULL && tzinfo != Py_None) {
3716 /* Convert UTC to tzinfo's zone. */
3717 PyObject *temp = self;
Tim Peters2a44a8d2003-01-23 20:53:10 +00003718 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
Tim Peters10cadce2003-01-23 19:58:02 +00003719 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003720 }
3721 return self;
3722}
3723
Tim Petersa9bc1682003-01-11 03:39:11 +00003724/* Return best possible UTC time -- this isn't constrained by the
3725 * precision of a timestamp.
3726 */
3727static PyObject *
3728datetime_utcnow(PyObject *cls, PyObject *dummy)
3729{
3730 return datetime_best_possible(cls, gmtime, Py_None);
3731}
3732
Tim Peters2a799bf2002-12-16 20:18:38 +00003733/* Return new local datetime from timestamp (Python timestamp -- a double). */
3734static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003735datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003736{
Tim Peters2a44a8d2003-01-23 20:53:10 +00003737 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003738 double timestamp;
3739 PyObject *tzinfo = Py_None;
Tim Peters2a44a8d2003-01-23 20:53:10 +00003740 static char *keywords[] = {"timestamp", "tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003741
Tim Peters2a44a8d2003-01-23 20:53:10 +00003742 if (! PyArg_ParseTupleAndKeywords(args, kw, "d|O:fromtimestamp",
3743 keywords, &timestamp, &tzinfo))
3744 return NULL;
3745 if (check_tzinfo_subclass(tzinfo) < 0)
3746 return NULL;
3747
3748 self = datetime_from_timestamp(cls,
3749 tzinfo == Py_None ? localtime : gmtime,
3750 timestamp,
3751 tzinfo);
3752 if (self != NULL && tzinfo != Py_None) {
3753 /* Convert UTC to tzinfo's zone. */
3754 PyObject *temp = self;
3755 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3756 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003757 }
3758 return self;
3759}
3760
Tim Petersa9bc1682003-01-11 03:39:11 +00003761/* Return new UTC datetime from timestamp (Python timestamp -- a double). */
3762static PyObject *
3763datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
3764{
3765 double timestamp;
3766 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003767
Tim Petersa9bc1682003-01-11 03:39:11 +00003768 if (PyArg_ParseTuple(args, "d:utcfromtimestamp", &timestamp))
3769 result = datetime_from_timestamp(cls, gmtime, timestamp,
3770 Py_None);
3771 return result;
3772}
3773
3774/* Return new datetime from date/datetime and time arguments. */
3775static PyObject *
3776datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
3777{
3778 static char *keywords[] = {"date", "time", NULL};
3779 PyObject *date;
3780 PyObject *time;
3781 PyObject *result = NULL;
3782
3783 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!:combine", keywords,
3784 &PyDateTime_DateType, &date,
3785 &PyDateTime_TimeType, &time)) {
3786 PyObject *tzinfo = Py_None;
3787
3788 if (HASTZINFO(time))
3789 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
3790 result = PyObject_CallFunction(cls, "iiiiiiiO",
3791 GET_YEAR(date),
3792 GET_MONTH(date),
3793 GET_DAY(date),
3794 TIME_GET_HOUR(time),
3795 TIME_GET_MINUTE(time),
3796 TIME_GET_SECOND(time),
3797 TIME_GET_MICROSECOND(time),
3798 tzinfo);
3799 }
3800 return result;
3801}
Tim Peters2a799bf2002-12-16 20:18:38 +00003802
3803/*
3804 * Destructor.
3805 */
3806
3807static void
Tim Petersa9bc1682003-01-11 03:39:11 +00003808datetime_dealloc(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003809{
Tim Petersa9bc1682003-01-11 03:39:11 +00003810 if (HASTZINFO(self)) {
3811 Py_XDECREF(self->tzinfo);
3812 }
Tim Peters2a799bf2002-12-16 20:18:38 +00003813 self->ob_type->tp_free((PyObject *)self);
3814}
3815
3816/*
3817 * Indirect access to tzinfo methods.
3818 */
3819
Tim Peters2a799bf2002-12-16 20:18:38 +00003820/* These are all METH_NOARGS, so don't need to check the arglist. */
3821static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003822datetime_utcoffset(PyDateTime_DateTime *self, PyObject *unused) {
3823 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3824 "utcoffset", (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003825}
3826
3827static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003828datetime_dst(PyDateTime_DateTime *self, PyObject *unused) {
3829 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3830 "dst", (PyObject *)self);
Tim Peters855fe882002-12-22 03:43:39 +00003831}
3832
3833static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003834datetime_tzname(PyDateTime_DateTime *self, PyObject *unused) {
3835 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
3836 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003837}
3838
3839/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003840 * datetime arithmetic.
Tim Peters2a799bf2002-12-16 20:18:38 +00003841 */
3842
Tim Petersa9bc1682003-01-11 03:39:11 +00003843/* factor must be 1 (to add) or -1 (to subtract). The result inherits
3844 * the tzinfo state of date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003845 */
3846static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003847add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
3848 int factor)
Tim Peters2a799bf2002-12-16 20:18:38 +00003849{
Tim Petersa9bc1682003-01-11 03:39:11 +00003850 /* Note that the C-level additions can't overflow, because of
3851 * invariant bounds on the member values.
3852 */
3853 int year = GET_YEAR(date);
3854 int month = GET_MONTH(date);
3855 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
3856 int hour = DATE_GET_HOUR(date);
3857 int minute = DATE_GET_MINUTE(date);
3858 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
3859 int microsecond = DATE_GET_MICROSECOND(date) +
3860 GET_TD_MICROSECONDS(delta) * factor;
Tim Peters2a799bf2002-12-16 20:18:38 +00003861
Tim Petersa9bc1682003-01-11 03:39:11 +00003862 assert(factor == 1 || factor == -1);
3863 if (normalize_datetime(&year, &month, &day,
3864 &hour, &minute, &second, &microsecond) < 0)
3865 return NULL;
3866 else
3867 return new_datetime(year, month, day,
3868 hour, minute, second, microsecond,
3869 HASTZINFO(date) ? date->tzinfo : Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003870}
3871
3872static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003873datetime_add(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003874{
Tim Petersa9bc1682003-01-11 03:39:11 +00003875 if (PyDateTime_Check(left)) {
3876 /* datetime + ??? */
3877 if (PyDelta_Check(right))
3878 /* datetime + delta */
3879 return add_datetime_timedelta(
3880 (PyDateTime_DateTime *)left,
3881 (PyDateTime_Delta *)right,
3882 1);
3883 }
3884 else if (PyDelta_Check(left)) {
3885 /* delta + datetime */
3886 return add_datetime_timedelta((PyDateTime_DateTime *) right,
3887 (PyDateTime_Delta *) left,
3888 1);
3889 }
3890 Py_INCREF(Py_NotImplemented);
3891 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00003892}
3893
3894static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003895datetime_subtract(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003896{
3897 PyObject *result = Py_NotImplemented;
3898
3899 if (PyDateTime_Check(left)) {
3900 /* datetime - ??? */
3901 if (PyDateTime_Check(right)) {
3902 /* datetime - datetime */
3903 naivety n1, n2;
3904 int offset1, offset2;
Tim Petersa9bc1682003-01-11 03:39:11 +00003905 int delta_d, delta_s, delta_us;
Tim Peters2a799bf2002-12-16 20:18:38 +00003906
Tim Peterse39a80c2002-12-30 21:28:52 +00003907 if (classify_two_utcoffsets(left, &offset1, &n1, left,
3908 right, &offset2, &n2,
3909 right) < 0)
Tim Peters00237032002-12-27 02:21:51 +00003910 return NULL;
Tim Peters8702d5f2002-12-27 02:26:16 +00003911 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
Tim Peters2a799bf2002-12-16 20:18:38 +00003912 if (n1 != n2) {
3913 PyErr_SetString(PyExc_TypeError,
3914 "can't subtract offset-naive and "
3915 "offset-aware datetimes");
3916 return NULL;
3917 }
Tim Petersa9bc1682003-01-11 03:39:11 +00003918 delta_d = ymd_to_ord(GET_YEAR(left),
3919 GET_MONTH(left),
3920 GET_DAY(left)) -
3921 ymd_to_ord(GET_YEAR(right),
3922 GET_MONTH(right),
3923 GET_DAY(right));
3924 /* These can't overflow, since the values are
3925 * normalized. At most this gives the number of
3926 * seconds in one day.
3927 */
3928 delta_s = (DATE_GET_HOUR(left) -
3929 DATE_GET_HOUR(right)) * 3600 +
3930 (DATE_GET_MINUTE(left) -
3931 DATE_GET_MINUTE(right)) * 60 +
3932 (DATE_GET_SECOND(left) -
3933 DATE_GET_SECOND(right));
3934 delta_us = DATE_GET_MICROSECOND(left) -
3935 DATE_GET_MICROSECOND(right);
Tim Peters2a799bf2002-12-16 20:18:38 +00003936 /* (left - offset1) - (right - offset2) =
3937 * (left - right) + (offset2 - offset1)
3938 */
Tim Petersa9bc1682003-01-11 03:39:11 +00003939 delta_s += (offset2 - offset1) * 60;
3940 result = new_delta(delta_d, delta_s, delta_us, 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00003941 }
3942 else if (PyDelta_Check(right)) {
Tim Petersa9bc1682003-01-11 03:39:11 +00003943 /* datetime - delta */
3944 result = add_datetime_timedelta(
Tim Peters2a799bf2002-12-16 20:18:38 +00003945 (PyDateTime_DateTime *)left,
Tim Petersa9bc1682003-01-11 03:39:11 +00003946 (PyDateTime_Delta *)right,
3947 -1);
Tim Peters2a799bf2002-12-16 20:18:38 +00003948 }
3949 }
3950
3951 if (result == Py_NotImplemented)
3952 Py_INCREF(result);
3953 return result;
3954}
3955
3956/* Various ways to turn a datetime into a string. */
3957
3958static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003959datetime_repr(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003960{
Tim Petersa9bc1682003-01-11 03:39:11 +00003961 char buffer[1000];
3962 char *typename = self->ob_type->tp_name;
3963 PyObject *baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00003964
Tim Petersa9bc1682003-01-11 03:39:11 +00003965 if (DATE_GET_MICROSECOND(self)) {
3966 PyOS_snprintf(buffer, sizeof(buffer),
3967 "%s(%d, %d, %d, %d, %d, %d, %d)",
3968 typename,
3969 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
3970 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
3971 DATE_GET_SECOND(self),
3972 DATE_GET_MICROSECOND(self));
3973 }
3974 else if (DATE_GET_SECOND(self)) {
3975 PyOS_snprintf(buffer, sizeof(buffer),
3976 "%s(%d, %d, %d, %d, %d, %d)",
3977 typename,
3978 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
3979 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
3980 DATE_GET_SECOND(self));
3981 }
3982 else {
3983 PyOS_snprintf(buffer, sizeof(buffer),
3984 "%s(%d, %d, %d, %d, %d)",
3985 typename,
3986 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
3987 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
3988 }
3989 baserepr = PyString_FromString(buffer);
3990 if (baserepr == NULL || ! HASTZINFO(self))
3991 return baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00003992 return append_keyword_tzinfo(baserepr, self->tzinfo);
3993}
3994
Tim Petersa9bc1682003-01-11 03:39:11 +00003995static PyObject *
3996datetime_str(PyDateTime_DateTime *self)
3997{
3998 return PyObject_CallMethod((PyObject *)self, "isoformat", "(s)", " ");
3999}
Tim Peters2a799bf2002-12-16 20:18:38 +00004000
4001static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004002datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004003{
Tim Petersa9bc1682003-01-11 03:39:11 +00004004 char sep = 'T';
4005 static char *keywords[] = {"sep", NULL};
4006 char buffer[100];
4007 char *cp;
4008 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004009
Tim Petersa9bc1682003-01-11 03:39:11 +00004010 if (!PyArg_ParseTupleAndKeywords(args, kw, "|c:isoformat", keywords,
4011 &sep))
4012 return NULL;
4013 cp = isoformat_date((PyDateTime_Date *)self, buffer, sizeof(buffer));
4014 assert(cp != NULL);
4015 *cp++ = sep;
4016 isoformat_time(self, cp, sizeof(buffer) - (cp - buffer));
4017 result = PyString_FromString(buffer);
4018 if (result == NULL || ! HASTZINFO(self))
Tim Peters2a799bf2002-12-16 20:18:38 +00004019 return result;
4020
4021 /* We need to append the UTC offset. */
Tim Petersa9bc1682003-01-11 03:39:11 +00004022 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
Tim Peters2a799bf2002-12-16 20:18:38 +00004023 (PyObject *)self) < 0) {
4024 Py_DECREF(result);
4025 return NULL;
4026 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004027 PyString_ConcatAndDel(&result, PyString_FromString(buffer));
Tim Peters2a799bf2002-12-16 20:18:38 +00004028 return result;
4029}
4030
Tim Petersa9bc1682003-01-11 03:39:11 +00004031static PyObject *
4032datetime_ctime(PyDateTime_DateTime *self)
4033{
4034 return format_ctime((PyDateTime_Date *)self,
4035 DATE_GET_HOUR(self),
4036 DATE_GET_MINUTE(self),
4037 DATE_GET_SECOND(self));
4038}
4039
Tim Peters2a799bf2002-12-16 20:18:38 +00004040/* Miscellaneous methods. */
4041
Tim Petersa9bc1682003-01-11 03:39:11 +00004042/* This is more natural as a tp_compare, but doesn't work then: for whatever
4043 * reason, Python's try_3way_compare ignores tp_compare unless
4044 * PyInstance_Check returns true, but these aren't old-style classes.
4045 */
4046static PyObject *
4047datetime_richcompare(PyDateTime_DateTime *self, PyObject *other, int op)
4048{
4049 int diff;
4050 naivety n1, n2;
4051 int offset1, offset2;
4052
4053 if (! PyDateTime_Check(other)) {
Tim Peters8d81a012003-01-24 22:36:34 +00004054 if (PyObject_HasAttrString(other, "timetuple")) {
4055 /* A hook for other kinds of datetime objects. */
4056 Py_INCREF(Py_NotImplemented);
4057 return Py_NotImplemented;
4058 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004059 /* Stop this from falling back to address comparison. */
4060 PyErr_Format(PyExc_TypeError,
4061 "can't compare '%s' to '%s'",
4062 self->ob_type->tp_name,
4063 other->ob_type->tp_name);
4064 return NULL;
4065 }
4066
4067 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1,
4068 (PyObject *)self,
4069 other, &offset2, &n2,
4070 other) < 0)
4071 return NULL;
4072 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
4073 /* If they're both naive, or both aware and have the same offsets,
4074 * we get off cheap. Note that if they're both naive, offset1 ==
4075 * offset2 == 0 at this point.
4076 */
4077 if (n1 == n2 && offset1 == offset2) {
4078 diff = memcmp(self->data, ((PyDateTime_DateTime *)other)->data,
4079 _PyDateTime_DATETIME_DATASIZE);
4080 return diff_to_bool(diff, op);
4081 }
4082
4083 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
4084 PyDateTime_Delta *delta;
4085
4086 assert(offset1 != offset2); /* else last "if" handled it */
4087 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
4088 other);
4089 if (delta == NULL)
4090 return NULL;
4091 diff = GET_TD_DAYS(delta);
4092 if (diff == 0)
4093 diff = GET_TD_SECONDS(delta) |
4094 GET_TD_MICROSECONDS(delta);
4095 Py_DECREF(delta);
4096 return diff_to_bool(diff, op);
4097 }
4098
4099 assert(n1 != n2);
4100 PyErr_SetString(PyExc_TypeError,
4101 "can't compare offset-naive and "
4102 "offset-aware datetimes");
4103 return NULL;
4104}
4105
4106static long
4107datetime_hash(PyDateTime_DateTime *self)
4108{
4109 if (self->hashcode == -1) {
4110 naivety n;
4111 int offset;
4112 PyObject *temp;
4113
4114 n = classify_utcoffset((PyObject *)self, (PyObject *)self,
4115 &offset);
4116 assert(n != OFFSET_UNKNOWN);
4117 if (n == OFFSET_ERROR)
4118 return -1;
4119
4120 /* Reduce this to a hash of another object. */
4121 if (n == OFFSET_NAIVE)
4122 temp = PyString_FromStringAndSize(
4123 (char *)self->data,
4124 _PyDateTime_DATETIME_DATASIZE);
4125 else {
4126 int days;
4127 int seconds;
4128
4129 assert(n == OFFSET_AWARE);
4130 assert(HASTZINFO(self));
4131 days = ymd_to_ord(GET_YEAR(self),
4132 GET_MONTH(self),
4133 GET_DAY(self));
4134 seconds = DATE_GET_HOUR(self) * 3600 +
4135 (DATE_GET_MINUTE(self) - offset) * 60 +
4136 DATE_GET_SECOND(self);
4137 temp = new_delta(days,
4138 seconds,
4139 DATE_GET_MICROSECOND(self),
4140 1);
4141 }
4142 if (temp != NULL) {
4143 self->hashcode = PyObject_Hash(temp);
4144 Py_DECREF(temp);
4145 }
4146 }
4147 return self->hashcode;
4148}
Tim Peters2a799bf2002-12-16 20:18:38 +00004149
4150static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004151datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00004152{
4153 PyObject *clone;
4154 PyObject *tuple;
4155 int y = GET_YEAR(self);
4156 int m = GET_MONTH(self);
4157 int d = GET_DAY(self);
4158 int hh = DATE_GET_HOUR(self);
4159 int mm = DATE_GET_MINUTE(self);
4160 int ss = DATE_GET_SECOND(self);
4161 int us = DATE_GET_MICROSECOND(self);
Tim Petersa9bc1682003-01-11 03:39:11 +00004162 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00004163
4164 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO:replace",
Tim Petersa9bc1682003-01-11 03:39:11 +00004165 datetime_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00004166 &y, &m, &d, &hh, &mm, &ss, &us,
4167 &tzinfo))
4168 return NULL;
4169 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
4170 if (tuple == NULL)
4171 return NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00004172 clone = datetime_new(self->ob_type, tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00004173 Py_DECREF(tuple);
4174 return clone;
4175}
4176
4177static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004178datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters80475bb2002-12-25 07:40:55 +00004179{
Tim Peters52dcce22003-01-23 16:36:11 +00004180 int y, m, d, hh, mm, ss, us;
Tim Peters521fc152002-12-31 17:36:56 +00004181 PyObject *result;
Tim Peters52dcce22003-01-23 16:36:11 +00004182 int offset, none;
Tim Peters521fc152002-12-31 17:36:56 +00004183
Tim Peters80475bb2002-12-25 07:40:55 +00004184 PyObject *tzinfo;
4185 static char *keywords[] = {"tz", NULL};
4186
Tim Peters52dcce22003-01-23 16:36:11 +00004187 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:astimezone", keywords,
4188 &PyDateTime_TZInfoType, &tzinfo))
Tim Peters80475bb2002-12-25 07:40:55 +00004189 return NULL;
4190
Tim Peters52dcce22003-01-23 16:36:11 +00004191 if (!HASTZINFO(self) || self->tzinfo == Py_None)
4192 goto NeedAware;
Tim Peters521fc152002-12-31 17:36:56 +00004193
Tim Peters52dcce22003-01-23 16:36:11 +00004194 /* Conversion to self's own time zone is a NOP. */
4195 if (self->tzinfo == tzinfo) {
4196 Py_INCREF(self);
4197 return (PyObject *)self;
Tim Peters710fb152003-01-02 19:35:54 +00004198 }
Tim Peters521fc152002-12-31 17:36:56 +00004199
Tim Peters52dcce22003-01-23 16:36:11 +00004200 /* Convert self to UTC. */
4201 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4202 if (offset == -1 && PyErr_Occurred())
4203 return NULL;
4204 if (none)
4205 goto NeedAware;
Tim Petersf3615152003-01-01 21:51:37 +00004206
Tim Peters52dcce22003-01-23 16:36:11 +00004207 y = GET_YEAR(self);
4208 m = GET_MONTH(self);
4209 d = GET_DAY(self);
4210 hh = DATE_GET_HOUR(self);
4211 mm = DATE_GET_MINUTE(self);
4212 ss = DATE_GET_SECOND(self);
4213 us = DATE_GET_MICROSECOND(self);
4214
4215 mm -= offset;
Tim Petersf3615152003-01-01 21:51:37 +00004216 if ((mm < 0 || mm >= 60) &&
4217 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Peters52dcce22003-01-23 16:36:11 +00004218 return NULL;
4219
4220 /* Attach new tzinfo and let fromutc() do the rest. */
4221 result = new_datetime(y, m, d, hh, mm, ss, us, tzinfo);
4222 if (result != NULL) {
4223 PyObject *temp = result;
4224
4225 result = PyObject_CallMethod(tzinfo, "fromutc", "O", temp);
4226 Py_DECREF(temp);
4227 }
Tim Petersadf64202003-01-04 06:03:15 +00004228 return result;
Tim Peters521fc152002-12-31 17:36:56 +00004229
Tim Peters52dcce22003-01-23 16:36:11 +00004230NeedAware:
4231 PyErr_SetString(PyExc_ValueError, "astimezone() cannot be applied to "
4232 "a naive datetime");
Tim Peters521fc152002-12-31 17:36:56 +00004233 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00004234}
4235
4236static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004237datetime_timetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004238{
4239 int dstflag = -1;
4240
Tim Petersa9bc1682003-01-11 03:39:11 +00004241 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004242 int none;
4243
4244 dstflag = call_dst(self->tzinfo, (PyObject *)self, &none);
4245 if (dstflag == -1 && PyErr_Occurred())
4246 return NULL;
4247
4248 if (none)
4249 dstflag = -1;
4250 else if (dstflag != 0)
4251 dstflag = 1;
4252
4253 }
4254 return build_struct_time(GET_YEAR(self),
4255 GET_MONTH(self),
4256 GET_DAY(self),
4257 DATE_GET_HOUR(self),
4258 DATE_GET_MINUTE(self),
4259 DATE_GET_SECOND(self),
4260 dstflag);
4261}
4262
4263static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004264datetime_getdate(PyDateTime_DateTime *self)
4265{
4266 return new_date(GET_YEAR(self),
4267 GET_MONTH(self),
4268 GET_DAY(self));
4269}
4270
4271static PyObject *
4272datetime_gettime(PyDateTime_DateTime *self)
4273{
4274 return new_time(DATE_GET_HOUR(self),
4275 DATE_GET_MINUTE(self),
4276 DATE_GET_SECOND(self),
4277 DATE_GET_MICROSECOND(self),
4278 Py_None);
4279}
4280
4281static PyObject *
4282datetime_gettimetz(PyDateTime_DateTime *self)
4283{
4284 return new_time(DATE_GET_HOUR(self),
4285 DATE_GET_MINUTE(self),
4286 DATE_GET_SECOND(self),
4287 DATE_GET_MICROSECOND(self),
4288 HASTZINFO(self) ? self->tzinfo : Py_None);
4289}
4290
4291static PyObject *
4292datetime_utctimetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004293{
4294 int y = GET_YEAR(self);
4295 int m = GET_MONTH(self);
4296 int d = GET_DAY(self);
4297 int hh = DATE_GET_HOUR(self);
4298 int mm = DATE_GET_MINUTE(self);
4299 int ss = DATE_GET_SECOND(self);
4300 int us = 0; /* microseconds are ignored in a timetuple */
4301 int offset = 0;
4302
Tim Petersa9bc1682003-01-11 03:39:11 +00004303 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004304 int none;
4305
4306 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4307 if (offset == -1 && PyErr_Occurred())
4308 return NULL;
4309 }
4310 /* Even if offset is 0, don't call timetuple() -- tm_isdst should be
4311 * 0 in a UTC timetuple regardless of what dst() says.
4312 */
4313 if (offset) {
4314 /* Subtract offset minutes & normalize. */
4315 int stat;
4316
4317 mm -= offset;
4318 stat = normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us);
4319 if (stat < 0) {
4320 /* At the edges, it's possible we overflowed
4321 * beyond MINYEAR or MAXYEAR.
4322 */
4323 if (PyErr_ExceptionMatches(PyExc_OverflowError))
4324 PyErr_Clear();
4325 else
4326 return NULL;
4327 }
4328 }
4329 return build_struct_time(y, m, d, hh, mm, ss, 0);
4330}
4331
Tim Peters371935f2003-02-01 01:52:50 +00004332/* Pickle support, a simple use of __reduce__. */
Tim Peters33e0f382003-01-10 02:05:14 +00004333
Tim Petersa9bc1682003-01-11 03:39:11 +00004334/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004335 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4336 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00004337 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00004338 */
4339static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004340datetime_getstate(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004341{
4342 PyObject *basestate;
4343 PyObject *result = NULL;
4344
Tim Peters33e0f382003-01-10 02:05:14 +00004345 basestate = PyString_FromStringAndSize((char *)self->data,
4346 _PyDateTime_DATETIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00004347 if (basestate != NULL) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004348 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00004349 result = Py_BuildValue("(O)", basestate);
4350 else
4351 result = Py_BuildValue("OO", basestate, self->tzinfo);
4352 Py_DECREF(basestate);
4353 }
4354 return result;
4355}
4356
4357static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00004358datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00004359{
Guido van Rossum177e41a2003-01-30 22:06:23 +00004360 return Py_BuildValue("(ON)", self->ob_type, datetime_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00004361}
4362
Tim Petersa9bc1682003-01-11 03:39:11 +00004363static PyMethodDef datetime_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004364
Tim Peters2a799bf2002-12-16 20:18:38 +00004365 /* Class methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00004366
Tim Petersa9bc1682003-01-11 03:39:11 +00004367 {"now", (PyCFunction)datetime_now,
Tim Peters2a799bf2002-12-16 20:18:38 +00004368 METH_KEYWORDS | METH_CLASS,
Neal Norwitz2fbe5372003-01-23 21:09:05 +00004369 PyDoc_STR("[tz] -> new datetime with tz's local day and time.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004370
Tim Petersa9bc1682003-01-11 03:39:11 +00004371 {"utcnow", (PyCFunction)datetime_utcnow,
4372 METH_NOARGS | METH_CLASS,
4373 PyDoc_STR("Return a new datetime representing UTC day and time.")},
4374
4375 {"fromtimestamp", (PyCFunction)datetime_fromtimestamp,
Tim Peters2a799bf2002-12-16 20:18:38 +00004376 METH_KEYWORDS | METH_CLASS,
Tim Peters2a44a8d2003-01-23 20:53:10 +00004377 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004378
Tim Petersa9bc1682003-01-11 03:39:11 +00004379 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
4380 METH_VARARGS | METH_CLASS,
4381 PyDoc_STR("timestamp -> UTC datetime from a POSIX timestamp "
4382 "(like time.time()).")},
4383
4384 {"combine", (PyCFunction)datetime_combine,
4385 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4386 PyDoc_STR("date, time -> datetime with same date and time fields")},
4387
Tim Peters2a799bf2002-12-16 20:18:38 +00004388 /* Instance methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00004389
Tim Petersa9bc1682003-01-11 03:39:11 +00004390 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
4391 PyDoc_STR("Return date object with same year, month and day.")},
4392
4393 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
4394 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
4395
4396 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
4397 PyDoc_STR("Return time object with same time and tzinfo.")},
4398
4399 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
4400 PyDoc_STR("Return ctime() style string.")},
4401
4402 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004403 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
4404
Tim Petersa9bc1682003-01-11 03:39:11 +00004405 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004406 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
4407
Tim Petersa9bc1682003-01-11 03:39:11 +00004408 {"isoformat", (PyCFunction)datetime_isoformat, METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004409 PyDoc_STR("[sep] -> string in ISO 8601 format, "
4410 "YYYY-MM-DDTHH:MM:SS[.mmmmmm][+HH:MM].\n\n"
4411 "sep is used to separate the year from the time, and "
4412 "defaults to 'T'.")},
4413
Tim Petersa9bc1682003-01-11 03:39:11 +00004414 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004415 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
4416
Tim Petersa9bc1682003-01-11 03:39:11 +00004417 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004418 PyDoc_STR("Return self.tzinfo.tzname(self).")},
4419
Tim Petersa9bc1682003-01-11 03:39:11 +00004420 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004421 PyDoc_STR("Return self.tzinfo.dst(self).")},
4422
Tim Petersa9bc1682003-01-11 03:39:11 +00004423 {"replace", (PyCFunction)datetime_replace, METH_KEYWORDS,
4424 PyDoc_STR("Return datetime with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00004425
Tim Petersa9bc1682003-01-11 03:39:11 +00004426 {"astimezone", (PyCFunction)datetime_astimezone, METH_KEYWORDS,
Tim Peters80475bb2002-12-25 07:40:55 +00004427 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
4428
Guido van Rossum177e41a2003-01-30 22:06:23 +00004429 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
4430 PyDoc_STR("__reduce__() -> (cls, state)")},
4431
Tim Peters2a799bf2002-12-16 20:18:38 +00004432 {NULL, NULL}
4433};
4434
Tim Petersa9bc1682003-01-11 03:39:11 +00004435static char datetime_doc[] =
Tim Peters2a799bf2002-12-16 20:18:38 +00004436PyDoc_STR("date/time type.");
4437
Tim Petersa9bc1682003-01-11 03:39:11 +00004438static PyNumberMethods datetime_as_number = {
4439 datetime_add, /* nb_add */
4440 datetime_subtract, /* nb_subtract */
Tim Peters2a799bf2002-12-16 20:18:38 +00004441 0, /* nb_multiply */
4442 0, /* nb_divide */
4443 0, /* nb_remainder */
4444 0, /* nb_divmod */
4445 0, /* nb_power */
4446 0, /* nb_negative */
4447 0, /* nb_positive */
4448 0, /* nb_absolute */
4449 0, /* nb_nonzero */
4450};
4451
Tim Petersa9bc1682003-01-11 03:39:11 +00004452statichere PyTypeObject PyDateTime_DateTimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004453 PyObject_HEAD_INIT(NULL)
4454 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00004455 "datetime.datetime", /* tp_name */
Tim Petersa9bc1682003-01-11 03:39:11 +00004456 sizeof(PyDateTime_DateTime), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00004457 0, /* tp_itemsize */
Tim Petersa9bc1682003-01-11 03:39:11 +00004458 (destructor)datetime_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004459 0, /* tp_print */
4460 0, /* tp_getattr */
4461 0, /* tp_setattr */
4462 0, /* tp_compare */
Tim Petersa9bc1682003-01-11 03:39:11 +00004463 (reprfunc)datetime_repr, /* tp_repr */
4464 &datetime_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00004465 0, /* tp_as_sequence */
4466 0, /* tp_as_mapping */
Tim Petersa9bc1682003-01-11 03:39:11 +00004467 (hashfunc)datetime_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00004468 0, /* tp_call */
Tim Petersa9bc1682003-01-11 03:39:11 +00004469 (reprfunc)datetime_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00004470 PyObject_GenericGetAttr, /* tp_getattro */
4471 0, /* tp_setattro */
4472 0, /* tp_as_buffer */
4473 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
4474 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Petersa9bc1682003-01-11 03:39:11 +00004475 datetime_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004476 0, /* tp_traverse */
4477 0, /* tp_clear */
Tim Petersa9bc1682003-01-11 03:39:11 +00004478 (richcmpfunc)datetime_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00004479 0, /* tp_weaklistoffset */
4480 0, /* tp_iter */
4481 0, /* tp_iternext */
Tim Petersa9bc1682003-01-11 03:39:11 +00004482 datetime_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00004483 0, /* tp_members */
Tim Petersa9bc1682003-01-11 03:39:11 +00004484 datetime_getset, /* tp_getset */
4485 &PyDateTime_DateType, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00004486 0, /* tp_dict */
4487 0, /* tp_descr_get */
4488 0, /* tp_descr_set */
4489 0, /* tp_dictoffset */
4490 0, /* tp_init */
4491 0, /* tp_alloc */
Tim Petersa9bc1682003-01-11 03:39:11 +00004492 datetime_new, /* tp_new */
Tim Peters2a799bf2002-12-16 20:18:38 +00004493 _PyObject_Del, /* tp_free */
4494};
4495
4496/* ---------------------------------------------------------------------------
4497 * Module methods and initialization.
4498 */
4499
4500static PyMethodDef module_methods[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004501 {NULL, NULL}
4502};
4503
4504PyMODINIT_FUNC
4505initdatetime(void)
4506{
4507 PyObject *m; /* a module object */
4508 PyObject *d; /* its dict */
4509 PyObject *x;
4510
Tim Peters2a799bf2002-12-16 20:18:38 +00004511 m = Py_InitModule3("datetime", module_methods,
4512 "Fast implementation of the datetime type.");
4513
4514 if (PyType_Ready(&PyDateTime_DateType) < 0)
4515 return;
4516 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
4517 return;
4518 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
4519 return;
4520 if (PyType_Ready(&PyDateTime_TimeType) < 0)
4521 return;
4522 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
4523 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004524
Tim Peters2a799bf2002-12-16 20:18:38 +00004525 /* timedelta values */
4526 d = PyDateTime_DeltaType.tp_dict;
4527
Tim Peters2a799bf2002-12-16 20:18:38 +00004528 x = new_delta(0, 0, 1, 0);
4529 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4530 return;
4531 Py_DECREF(x);
4532
4533 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
4534 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4535 return;
4536 Py_DECREF(x);
4537
4538 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
4539 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4540 return;
4541 Py_DECREF(x);
4542
4543 /* date values */
4544 d = PyDateTime_DateType.tp_dict;
4545
4546 x = new_date(1, 1, 1);
4547 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4548 return;
4549 Py_DECREF(x);
4550
4551 x = new_date(MAXYEAR, 12, 31);
4552 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4553 return;
4554 Py_DECREF(x);
4555
4556 x = new_delta(1, 0, 0, 0);
4557 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4558 return;
4559 Py_DECREF(x);
4560
Tim Peters37f39822003-01-10 03:49:02 +00004561 /* time values */
4562 d = PyDateTime_TimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004563
Tim Peters37f39822003-01-10 03:49:02 +00004564 x = new_time(0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004565 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4566 return;
4567 Py_DECREF(x);
4568
Tim Peters37f39822003-01-10 03:49:02 +00004569 x = new_time(23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004570 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4571 return;
4572 Py_DECREF(x);
4573
4574 x = new_delta(0, 0, 1, 0);
4575 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4576 return;
4577 Py_DECREF(x);
4578
Tim Petersa9bc1682003-01-11 03:39:11 +00004579 /* datetime values */
4580 d = PyDateTime_DateTimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004581
Tim Petersa9bc1682003-01-11 03:39:11 +00004582 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004583 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4584 return;
4585 Py_DECREF(x);
4586
Tim Petersa9bc1682003-01-11 03:39:11 +00004587 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004588 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4589 return;
4590 Py_DECREF(x);
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
Tim Peters2a799bf2002-12-16 20:18:38 +00004597 /* module initialization */
4598 PyModule_AddIntConstant(m, "MINYEAR", MINYEAR);
4599 PyModule_AddIntConstant(m, "MAXYEAR", MAXYEAR);
4600
4601 Py_INCREF(&PyDateTime_DateType);
4602 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
4603
Tim Petersa9bc1682003-01-11 03:39:11 +00004604 Py_INCREF(&PyDateTime_DateTimeType);
4605 PyModule_AddObject(m, "datetime",
4606 (PyObject *)&PyDateTime_DateTimeType);
4607
4608 Py_INCREF(&PyDateTime_TimeType);
4609 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
4610
Tim Peters2a799bf2002-12-16 20:18:38 +00004611 Py_INCREF(&PyDateTime_DeltaType);
4612 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
4613
Tim Peters2a799bf2002-12-16 20:18:38 +00004614 Py_INCREF(&PyDateTime_TZInfoType);
4615 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
4616
Tim Peters2a799bf2002-12-16 20:18:38 +00004617 /* A 4-year cycle has an extra leap day over what we'd get from
4618 * pasting together 4 single years.
4619 */
4620 assert(DI4Y == 4 * 365 + 1);
4621 assert(DI4Y == days_before_year(4+1));
4622
4623 /* Similarly, a 400-year cycle has an extra leap day over what we'd
4624 * get from pasting together 4 100-year cycles.
4625 */
4626 assert(DI400Y == 4 * DI100Y + 1);
4627 assert(DI400Y == days_before_year(400+1));
4628
4629 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
4630 * pasting together 25 4-year cycles.
4631 */
4632 assert(DI100Y == 25 * DI4Y - 1);
4633 assert(DI100Y == days_before_year(100+1));
4634
4635 us_per_us = PyInt_FromLong(1);
4636 us_per_ms = PyInt_FromLong(1000);
4637 us_per_second = PyInt_FromLong(1000000);
4638 us_per_minute = PyInt_FromLong(60000000);
4639 seconds_per_day = PyInt_FromLong(24 * 3600);
4640 if (us_per_us == NULL || us_per_ms == NULL || us_per_second == NULL ||
4641 us_per_minute == NULL || seconds_per_day == NULL)
4642 return;
4643
4644 /* The rest are too big for 32-bit ints, but even
4645 * us_per_week fits in 40 bits, so doubles should be exact.
4646 */
4647 us_per_hour = PyLong_FromDouble(3600000000.0);
4648 us_per_day = PyLong_FromDouble(86400000000.0);
4649 us_per_week = PyLong_FromDouble(604800000000.0);
4650 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
4651 return;
4652}
Tim Petersf3615152003-01-01 21:51:37 +00004653
4654/* ---------------------------------------------------------------------------
Tim Petersa9bc1682003-01-11 03:39:11 +00004655Some time zone algebra. For a datetime x, let
Tim Petersf3615152003-01-01 21:51:37 +00004656 x.n = x stripped of its timezone -- its naive time.
4657 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
4658 return None
4659 x.d = x.dst(), and assuming that doesn't raise an exception or
4660 return None
4661 x.s = x's standard offset, x.o - x.d
4662
4663Now some derived rules, where k is a duration (timedelta).
4664
46651. x.o = x.s + x.d
4666 This follows from the definition of x.s.
4667
Tim Petersc5dc4da2003-01-02 17:55:03 +000046682. If x and y have the same tzinfo member, x.s = y.s.
Tim Petersf3615152003-01-01 21:51:37 +00004669 This is actually a requirement, an assumption we need to make about
4670 sane tzinfo classes.
4671
46723. The naive UTC time corresponding to x is x.n - x.o.
4673 This is again a requirement for a sane tzinfo class.
4674
46754. (x+k).s = x.s
Tim Peters8bb5ad22003-01-24 02:44:45 +00004676 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
Tim Petersf3615152003-01-01 21:51:37 +00004677
Tim Petersc5dc4da2003-01-02 17:55:03 +000046785. (x+k).n = x.n + k
Tim Petersf3615152003-01-01 21:51:37 +00004679 Again follows from how arithmetic is defined.
4680
Tim Peters8bb5ad22003-01-24 02:44:45 +00004681Now we can explain tz.fromutc(x). Let's assume it's an interesting case
Tim Petersf3615152003-01-01 21:51:37 +00004682(meaning that the various tzinfo methods exist, and don't blow up or return
4683None when called).
4684
Tim Petersa9bc1682003-01-11 03:39:11 +00004685The function wants to return a datetime y with timezone tz, equivalent to x.
Tim Peters8bb5ad22003-01-24 02:44:45 +00004686x is already in UTC.
Tim Petersf3615152003-01-01 21:51:37 +00004687
4688By #3, we want
4689
Tim Peters8bb5ad22003-01-24 02:44:45 +00004690 y.n - y.o = x.n [1]
Tim Petersf3615152003-01-01 21:51:37 +00004691
4692The algorithm starts by attaching tz to x.n, and calling that y. So
4693x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
4694becomes true; in effect, we want to solve [2] for k:
4695
Tim Peters8bb5ad22003-01-24 02:44:45 +00004696 (y+k).n - (y+k).o = x.n [2]
Tim Petersf3615152003-01-01 21:51:37 +00004697
4698By #1, this is the same as
4699
Tim Peters8bb5ad22003-01-24 02:44:45 +00004700 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
Tim Petersf3615152003-01-01 21:51:37 +00004701
4702By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
4703Substituting that into [3],
4704
Tim Peters8bb5ad22003-01-24 02:44:45 +00004705 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
4706 k - (y+k).s - (y+k).d = 0; rearranging,
4707 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
4708 k = y.s - (y+k).d
Tim Petersf3615152003-01-01 21:51:37 +00004709
Tim Peters8bb5ad22003-01-24 02:44:45 +00004710On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
4711approximate k by ignoring the (y+k).d term at first. Note that k can't be
4712very large, since all offset-returning methods return a duration of magnitude
4713less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
4714be 0, so ignoring it has no consequence then.
Tim Petersf3615152003-01-01 21:51:37 +00004715
4716In any case, the new value is
4717
Tim Peters8bb5ad22003-01-24 02:44:45 +00004718 z = y + y.s [4]
Tim Petersf3615152003-01-01 21:51:37 +00004719
Tim Peters8bb5ad22003-01-24 02:44:45 +00004720It's helpful to step back at look at [4] from a higher level: it's simply
4721mapping from UTC to tz's standard time.
Tim Petersc5dc4da2003-01-02 17:55:03 +00004722
4723At this point, if
4724
Tim Peters8bb5ad22003-01-24 02:44:45 +00004725 z.n - z.o = x.n [5]
Tim Petersc5dc4da2003-01-02 17:55:03 +00004726
4727we have an equivalent time, and are almost done. The insecurity here is
Tim Petersf3615152003-01-01 21:51:37 +00004728at the start of daylight time. Picture US Eastern for concreteness. The wall
4729time 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 +00004730sense then. The docs ask that an Eastern tzinfo class consider such a time to
4731be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
4732on the day DST starts. We want to return the 1:MM EST spelling because that's
Tim Petersf3615152003-01-01 21:51:37 +00004733the only spelling that makes sense on the local wall clock.
4734
Tim Petersc5dc4da2003-01-02 17:55:03 +00004735In fact, if [5] holds at this point, we do have the standard-time spelling,
4736but that takes a bit of proof. We first prove a stronger result. What's the
4737difference between the LHS and RHS of [5]? Let
Tim Petersf3615152003-01-01 21:51:37 +00004738
Tim Peters8bb5ad22003-01-24 02:44:45 +00004739 diff = x.n - (z.n - z.o) [6]
Tim Petersf3615152003-01-01 21:51:37 +00004740
Tim Petersc5dc4da2003-01-02 17:55:03 +00004741Now
4742 z.n = by [4]
Tim Peters8bb5ad22003-01-24 02:44:45 +00004743 (y + y.s).n = by #5
4744 y.n + y.s = since y.n = x.n
4745 x.n + y.s = since z and y are have the same tzinfo member,
4746 y.s = z.s by #2
4747 x.n + z.s
Tim Petersf3615152003-01-01 21:51:37 +00004748
Tim Petersc5dc4da2003-01-02 17:55:03 +00004749Plugging that back into [6] gives
Tim Petersf3615152003-01-01 21:51:37 +00004750
Tim Petersc5dc4da2003-01-02 17:55:03 +00004751 diff =
Tim Peters8bb5ad22003-01-24 02:44:45 +00004752 x.n - ((x.n + z.s) - z.o) = expanding
4753 x.n - x.n - z.s + z.o = cancelling
4754 - z.s + z.o = by #2
Tim Petersc5dc4da2003-01-02 17:55:03 +00004755 z.d
Tim Petersf3615152003-01-01 21:51:37 +00004756
Tim Petersc5dc4da2003-01-02 17:55:03 +00004757So diff = z.d.
Tim Petersf3615152003-01-01 21:51:37 +00004758
Tim Petersc5dc4da2003-01-02 17:55:03 +00004759If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
Tim Peters8bb5ad22003-01-24 02:44:45 +00004760spelling we wanted in the endcase described above. We're done. Contrarily,
4761if z.d = 0, then we have a UTC equivalent, and are also done.
Tim Petersf3615152003-01-01 21:51:37 +00004762
Tim Petersc5dc4da2003-01-02 17:55:03 +00004763If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
4764add to z (in effect, z is in tz's standard time, and we need to shift the
Tim Peters8bb5ad22003-01-24 02:44:45 +00004765local clock into tz's daylight time).
Tim Petersf3615152003-01-01 21:51:37 +00004766
Tim Petersc5dc4da2003-01-02 17:55:03 +00004767Let
Tim Petersf3615152003-01-01 21:51:37 +00004768
Tim Peters4fede1a2003-01-04 00:26:59 +00004769 z' = z + z.d = z + diff [7]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004770
Tim Peters4fede1a2003-01-04 00:26:59 +00004771and we can again ask whether
Tim Petersc3bb26a2003-01-02 03:14:59 +00004772
Tim Peters8bb5ad22003-01-24 02:44:45 +00004773 z'.n - z'.o = x.n [8]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004774
Tim Peters8bb5ad22003-01-24 02:44:45 +00004775If so, we're done. If not, the tzinfo class is insane, according to the
4776assumptions we've made. This also requires a bit of proof. As before, let's
4777compute the difference between the LHS and RHS of [8] (and skipping some of
4778the justifications for the kinds of substitutions we've done several times
4779already):
Tim Peters4fede1a2003-01-04 00:26:59 +00004780
Tim Peters8bb5ad22003-01-24 02:44:45 +00004781 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
4782 x.n - (z.n + diff - z'.o) = replacing diff via [6]
4783 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
4784 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
4785 - z.n + z.n - z.o + z'.o = cancel z.n
Tim Peters4fede1a2003-01-04 00:26:59 +00004786 - z.o + z'.o = #1 twice
4787 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
4788 z'.d - z.d
4789
4790So 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 +00004791we've found the UTC-equivalent so are done. In fact, we stop with [7] and
4792return z', not bothering to compute z'.d.
Tim Peters4fede1a2003-01-04 00:26:59 +00004793
Tim Peters8bb5ad22003-01-24 02:44:45 +00004794How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
4795a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
4796would have to change the result dst() returns: we start in DST, and moving
4797a little further into it takes us out of DST.
Tim Peters4fede1a2003-01-04 00:26:59 +00004798
Tim Peters8bb5ad22003-01-24 02:44:45 +00004799There isn't a sane case where this can happen. The closest it gets is at
4800the end of DST, where there's an hour in UTC with no spelling in a hybrid
4801tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
4802that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
4803UTC) because the docs insist on that, but 0:MM is taken as being in daylight
4804time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
4805clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
4806standard time. Since that's what the local clock *does*, we want to map both
4807UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
Tim Peters4fede1a2003-01-04 00:26:59 +00004808in local time, but so it goes -- it's the way the local clock works.
4809
Tim Peters8bb5ad22003-01-24 02:44:45 +00004810When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
4811so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
4812z' = 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 +00004813(correctly) concludes that z' is not UTC-equivalent to x.
4814
4815Because we know z.d said z was in daylight time (else [5] would have held and
4816we would have stopped then), and we know z.d != z'.d (else [8] would have held
4817and we we have stopped then), and there are only 2 possible values dst() can
4818return in Eastern, it follows that z'.d must be 0 (which it is in the example,
4819but the reasoning doesn't depend on the example -- it depends on there being
4820two possible dst() outcomes, one zero and the other non-zero). Therefore
Tim Peters8bb5ad22003-01-24 02:44:45 +00004821z' must be in standard time, and is the spelling we want in this case.
4822
4823Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
4824concerned (because it takes z' as being in standard time rather than the
4825daylight time we intend here), but returning it gives the real-life "local
4826clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
4827tz.
4828
4829When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
4830the 1:MM standard time spelling we want.
4831
4832So how can this break? One of the assumptions must be violated. Two
4833possibilities:
4834
48351) [2] effectively says that y.s is invariant across all y belong to a given
4836 time zone. This isn't true if, for political reasons or continental drift,
4837 a region decides to change its base offset from UTC.
4838
48392) There may be versions of "double daylight" time where the tail end of
4840 the analysis gives up a step too early. I haven't thought about that
4841 enough to say.
4842
4843In any case, it's clear that the default fromutc() is strong enough to handle
4844"almost all" time zones: so long as the standard offset is invariant, it
4845doesn't matter if daylight time transition points change from year to year, or
4846if daylight time is skipped in some years; it doesn't matter how large or
4847small dst() may get within its bounds; and it doesn't even matter if some
4848perverse time zone returns a negative dst()). So a breaking case must be
4849pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
Tim Petersf3615152003-01-01 21:51:37 +00004850--------------------------------------------------------------------------- */