blob: 760ab317e6df02ef5f64348ee5450438378c8f5d [file] [log] [blame]
Tim Peters2a799bf2002-12-16 20:18:38 +00001/* C implementation for the date/time type documented at
2 * http://www.zope.org/Members/fdrake/DateTimeWiki/FrontPage
3 */
4
5#include "Python.h"
6#include "modsupport.h"
7#include "structmember.h"
8
9#include <time.h>
10
Tim Peters1b6f7a92004-06-20 02:50:16 +000011#include "timefuncs.h"
Tim Peters9ddf40b2004-06-20 22:41:32 +000012
13/* Differentiate between building the core module and building extension
14 * modules.
15 */
16#define Py_BUILD_CORE
Tim Peters2a799bf2002-12-16 20:18:38 +000017#include "datetime.h"
Tim Peters9ddf40b2004-06-20 22:41:32 +000018#undef Py_BUILD_CORE
Tim Peters2a799bf2002-12-16 20:18:38 +000019
20/* We require that C int be at least 32 bits, and use int virtually
21 * everywhere. In just a few cases we use a temp long, where a Python
22 * API returns a C long. In such cases, we have to ensure that the
23 * final result fits in a C int (this can be an issue on 64-bit boxes).
24 */
25#if SIZEOF_INT < 4
26# error "datetime.c requires that C int have at least 32 bits"
27#endif
28
29#define MINYEAR 1
30#define MAXYEAR 9999
31
32/* Nine decimal digits is easy to communicate, and leaves enough room
33 * so that two delta days can be added w/o fear of overflowing a signed
34 * 32-bit int, and with plenty of room left over to absorb any possible
35 * carries from adding seconds.
36 */
37#define MAX_DELTA_DAYS 999999999
38
39/* Rename the long macros in datetime.h to more reasonable short names. */
40#define GET_YEAR PyDateTime_GET_YEAR
41#define GET_MONTH PyDateTime_GET_MONTH
42#define GET_DAY PyDateTime_GET_DAY
43#define DATE_GET_HOUR PyDateTime_DATE_GET_HOUR
44#define DATE_GET_MINUTE PyDateTime_DATE_GET_MINUTE
45#define DATE_GET_SECOND PyDateTime_DATE_GET_SECOND
46#define DATE_GET_MICROSECOND PyDateTime_DATE_GET_MICROSECOND
47
48/* Date accessors for date and datetime. */
49#define SET_YEAR(o, v) (((o)->data[0] = ((v) & 0xff00) >> 8), \
50 ((o)->data[1] = ((v) & 0x00ff)))
51#define SET_MONTH(o, v) (PyDateTime_GET_MONTH(o) = (v))
52#define SET_DAY(o, v) (PyDateTime_GET_DAY(o) = (v))
53
54/* Date/Time accessors for datetime. */
55#define DATE_SET_HOUR(o, v) (PyDateTime_DATE_GET_HOUR(o) = (v))
56#define DATE_SET_MINUTE(o, v) (PyDateTime_DATE_GET_MINUTE(o) = (v))
57#define DATE_SET_SECOND(o, v) (PyDateTime_DATE_GET_SECOND(o) = (v))
58#define DATE_SET_MICROSECOND(o, v) \
59 (((o)->data[7] = ((v) & 0xff0000) >> 16), \
60 ((o)->data[8] = ((v) & 0x00ff00) >> 8), \
61 ((o)->data[9] = ((v) & 0x0000ff)))
62
63/* Time accessors for time. */
64#define TIME_GET_HOUR PyDateTime_TIME_GET_HOUR
65#define TIME_GET_MINUTE PyDateTime_TIME_GET_MINUTE
66#define TIME_GET_SECOND PyDateTime_TIME_GET_SECOND
67#define TIME_GET_MICROSECOND PyDateTime_TIME_GET_MICROSECOND
68#define TIME_SET_HOUR(o, v) (PyDateTime_TIME_GET_HOUR(o) = (v))
69#define TIME_SET_MINUTE(o, v) (PyDateTime_TIME_GET_MINUTE(o) = (v))
70#define TIME_SET_SECOND(o, v) (PyDateTime_TIME_GET_SECOND(o) = (v))
71#define TIME_SET_MICROSECOND(o, v) \
72 (((o)->data[3] = ((v) & 0xff0000) >> 16), \
73 ((o)->data[4] = ((v) & 0x00ff00) >> 8), \
74 ((o)->data[5] = ((v) & 0x0000ff)))
75
76/* Delta accessors for timedelta. */
77#define GET_TD_DAYS(o) (((PyDateTime_Delta *)(o))->days)
78#define GET_TD_SECONDS(o) (((PyDateTime_Delta *)(o))->seconds)
79#define GET_TD_MICROSECONDS(o) (((PyDateTime_Delta *)(o))->microseconds)
80
81#define SET_TD_DAYS(o, v) ((o)->days = (v))
82#define SET_TD_SECONDS(o, v) ((o)->seconds = (v))
83#define SET_TD_MICROSECONDS(o, v) ((o)->microseconds = (v))
84
Tim Petersa032d2e2003-01-11 00:15:54 +000085/* p is a pointer to a time or a datetime object; HASTZINFO(p) returns
86 * p->hastzinfo.
87 */
88#define HASTZINFO(p) (((_PyDateTime_BaseTZInfo *)(p))->hastzinfo)
89
Tim Peters3f606292004-03-21 23:38:41 +000090/* M is a char or int claiming to be a valid month. The macro is equivalent
91 * to the two-sided Python test
92 * 1 <= M <= 12
93 */
94#define MONTH_IS_SANE(M) ((unsigned int)(M) - 1 < 12)
95
Tim Peters2a799bf2002-12-16 20:18:38 +000096/* Forward declarations. */
97static PyTypeObject PyDateTime_DateType;
98static PyTypeObject PyDateTime_DateTimeType;
Tim Peters2a799bf2002-12-16 20:18:38 +000099static PyTypeObject PyDateTime_DeltaType;
100static PyTypeObject PyDateTime_TimeType;
101static PyTypeObject PyDateTime_TZInfoType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000102
103/* ---------------------------------------------------------------------------
104 * Math utilities.
105 */
106
107/* k = i+j overflows iff k differs in sign from both inputs,
108 * iff k^i has sign bit set and k^j has sign bit set,
109 * iff (k^i)&(k^j) has sign bit set.
110 */
111#define SIGNED_ADD_OVERFLOWED(RESULT, I, J) \
112 ((((RESULT) ^ (I)) & ((RESULT) ^ (J))) < 0)
113
114/* Compute Python divmod(x, y), returning the quotient and storing the
115 * remainder into *r. The quotient is the floor of x/y, and that's
116 * the real point of this. C will probably truncate instead (C99
117 * requires truncation; C89 left it implementation-defined).
118 * Simplification: we *require* that y > 0 here. That's appropriate
119 * for all the uses made of it. This simplifies the code and makes
120 * the overflow case impossible (divmod(LONG_MIN, -1) is the only
121 * overflow case).
122 */
123static int
124divmod(int x, int y, int *r)
125{
126 int quo;
127
128 assert(y > 0);
129 quo = x / y;
130 *r = x - quo * y;
131 if (*r < 0) {
132 --quo;
133 *r += y;
134 }
135 assert(0 <= *r && *r < y);
136 return quo;
137}
138
Tim Peters5d644dd2003-01-02 16:32:54 +0000139/* Round a double to the nearest long. |x| must be small enough to fit
140 * in a C long; this is not checked.
141 */
142static long
143round_to_long(double x)
144{
145 if (x >= 0.0)
146 x = floor(x + 0.5);
147 else
148 x = ceil(x - 0.5);
149 return (long)x;
150}
151
Tim Peters2a799bf2002-12-16 20:18:38 +0000152/* ---------------------------------------------------------------------------
153 * General calendrical helper functions
154 */
155
156/* For each month ordinal in 1..12, the number of days in that month,
157 * and the number of days before that month in the same year. These
158 * are correct for non-leap years only.
159 */
160static int _days_in_month[] = {
161 0, /* unused; this vector uses 1-based indexing */
162 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
163};
164
165static int _days_before_month[] = {
166 0, /* unused; this vector uses 1-based indexing */
167 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
168};
169
170/* year -> 1 if leap year, else 0. */
171static int
172is_leap(int year)
173{
174 /* Cast year to unsigned. The result is the same either way, but
175 * C can generate faster code for unsigned mod than for signed
176 * mod (especially for % 4 -- a good compiler should just grab
177 * the last 2 bits when the LHS is unsigned).
178 */
179 const unsigned int ayear = (unsigned int)year;
180 return ayear % 4 == 0 && (ayear % 100 != 0 || ayear % 400 == 0);
181}
182
183/* year, month -> number of days in that month in that year */
184static int
185days_in_month(int year, int month)
186{
187 assert(month >= 1);
188 assert(month <= 12);
189 if (month == 2 && is_leap(year))
190 return 29;
191 else
192 return _days_in_month[month];
193}
194
195/* year, month -> number of days in year preceeding first day of month */
196static int
197days_before_month(int year, int month)
198{
199 int days;
200
201 assert(month >= 1);
202 assert(month <= 12);
203 days = _days_before_month[month];
204 if (month > 2 && is_leap(year))
205 ++days;
206 return days;
207}
208
209/* year -> number of days before January 1st of year. Remember that we
210 * start with year 1, so days_before_year(1) == 0.
211 */
212static int
213days_before_year(int year)
214{
215 int y = year - 1;
216 /* This is incorrect if year <= 0; we really want the floor
217 * here. But so long as MINYEAR is 1, the smallest year this
218 * can see is 0 (this can happen in some normalization endcases),
219 * so we'll just special-case that.
220 */
221 assert (year >= 0);
222 if (y >= 0)
223 return y*365 + y/4 - y/100 + y/400;
224 else {
225 assert(y == -1);
226 return -366;
227 }
228}
229
230/* Number of days in 4, 100, and 400 year cycles. That these have
231 * the correct values is asserted in the module init function.
232 */
233#define DI4Y 1461 /* days_before_year(5); days in 4 years */
234#define DI100Y 36524 /* days_before_year(101); days in 100 years */
235#define DI400Y 146097 /* days_before_year(401); days in 400 years */
236
237/* ordinal -> year, month, day, considering 01-Jan-0001 as day 1. */
238static void
239ord_to_ymd(int ordinal, int *year, int *month, int *day)
240{
241 int n, n1, n4, n100, n400, leapyear, preceding;
242
243 /* ordinal is a 1-based index, starting at 1-Jan-1. The pattern of
244 * leap years repeats exactly every 400 years. The basic strategy is
245 * to find the closest 400-year boundary at or before ordinal, then
246 * work with the offset from that boundary to ordinal. Life is much
247 * clearer if we subtract 1 from ordinal first -- then the values
248 * of ordinal at 400-year boundaries are exactly those divisible
249 * by DI400Y:
250 *
251 * D M Y n n-1
252 * -- --- ---- ---------- ----------------
253 * 31 Dec -400 -DI400Y -DI400Y -1
254 * 1 Jan -399 -DI400Y +1 -DI400Y 400-year boundary
255 * ...
256 * 30 Dec 000 -1 -2
257 * 31 Dec 000 0 -1
258 * 1 Jan 001 1 0 400-year boundary
259 * 2 Jan 001 2 1
260 * 3 Jan 001 3 2
261 * ...
262 * 31 Dec 400 DI400Y DI400Y -1
263 * 1 Jan 401 DI400Y +1 DI400Y 400-year boundary
264 */
265 assert(ordinal >= 1);
266 --ordinal;
267 n400 = ordinal / DI400Y;
268 n = ordinal % DI400Y;
269 *year = n400 * 400 + 1;
270
271 /* Now n is the (non-negative) offset, in days, from January 1 of
272 * year, to the desired date. Now compute how many 100-year cycles
273 * precede n.
274 * Note that it's possible for n100 to equal 4! In that case 4 full
275 * 100-year cycles precede the desired day, which implies the
276 * desired day is December 31 at the end of a 400-year cycle.
277 */
278 n100 = n / DI100Y;
279 n = n % DI100Y;
280
281 /* Now compute how many 4-year cycles precede it. */
282 n4 = n / DI4Y;
283 n = n % DI4Y;
284
285 /* And now how many single years. Again n1 can be 4, and again
286 * meaning that the desired day is December 31 at the end of the
287 * 4-year cycle.
288 */
289 n1 = n / 365;
290 n = n % 365;
291
292 *year += n100 * 100 + n4 * 4 + n1;
293 if (n1 == 4 || n100 == 4) {
294 assert(n == 0);
295 *year -= 1;
296 *month = 12;
297 *day = 31;
298 return;
299 }
300
301 /* Now the year is correct, and n is the offset from January 1. We
302 * find the month via an estimate that's either exact or one too
303 * large.
304 */
305 leapyear = n1 == 3 && (n4 != 24 || n100 == 3);
306 assert(leapyear == is_leap(*year));
307 *month = (n + 50) >> 5;
308 preceding = (_days_before_month[*month] + (*month > 2 && leapyear));
309 if (preceding > n) {
310 /* estimate is too large */
311 *month -= 1;
312 preceding -= days_in_month(*year, *month);
313 }
314 n -= preceding;
315 assert(0 <= n);
316 assert(n < days_in_month(*year, *month));
317
318 *day = n + 1;
319}
320
321/* year, month, day -> ordinal, considering 01-Jan-0001 as day 1. */
322static int
323ymd_to_ord(int year, int month, int day)
324{
325 return days_before_year(year) + days_before_month(year, month) + day;
326}
327
328/* Day of week, where Monday==0, ..., Sunday==6. 1/1/1 was a Monday. */
329static int
330weekday(int year, int month, int day)
331{
332 return (ymd_to_ord(year, month, day) + 6) % 7;
333}
334
335/* Ordinal of the Monday starting week 1 of the ISO year. Week 1 is the
336 * first calendar week containing a Thursday.
337 */
338static int
339iso_week1_monday(int year)
340{
341 int first_day = ymd_to_ord(year, 1, 1); /* ord of 1/1 */
342 /* 0 if 1/1 is a Monday, 1 if a Tue, etc. */
343 int first_weekday = (first_day + 6) % 7;
344 /* ordinal of closest Monday at or before 1/1 */
345 int week1_monday = first_day - first_weekday;
346
347 if (first_weekday > 3) /* if 1/1 was Fri, Sat, Sun */
348 week1_monday += 7;
349 return week1_monday;
350}
351
352/* ---------------------------------------------------------------------------
353 * Range checkers.
354 */
355
356/* Check that -MAX_DELTA_DAYS <= days <= MAX_DELTA_DAYS. If so, return 0.
357 * If not, raise OverflowError and return -1.
358 */
359static int
360check_delta_day_range(int days)
361{
362 if (-MAX_DELTA_DAYS <= days && days <= MAX_DELTA_DAYS)
363 return 0;
364 PyErr_Format(PyExc_OverflowError,
365 "days=%d; must have magnitude <= %d",
Guido van Rossumbd43e912002-12-16 20:34:55 +0000366 days, MAX_DELTA_DAYS);
Tim Peters2a799bf2002-12-16 20:18:38 +0000367 return -1;
368}
369
370/* Check that date arguments are in range. Return 0 if they are. If they
371 * aren't, raise ValueError and return -1.
372 */
373static int
374check_date_args(int year, int month, int day)
375{
376
377 if (year < MINYEAR || year > MAXYEAR) {
378 PyErr_SetString(PyExc_ValueError,
379 "year is out of range");
380 return -1;
381 }
382 if (month < 1 || month > 12) {
383 PyErr_SetString(PyExc_ValueError,
384 "month must be in 1..12");
385 return -1;
386 }
387 if (day < 1 || day > days_in_month(year, month)) {
388 PyErr_SetString(PyExc_ValueError,
389 "day is out of range for month");
390 return -1;
391 }
392 return 0;
393}
394
395/* Check that time arguments are in range. Return 0 if they are. If they
396 * aren't, raise ValueError and return -1.
397 */
398static int
399check_time_args(int h, int m, int s, int us)
400{
401 if (h < 0 || h > 23) {
402 PyErr_SetString(PyExc_ValueError,
403 "hour must be in 0..23");
404 return -1;
405 }
406 if (m < 0 || m > 59) {
407 PyErr_SetString(PyExc_ValueError,
408 "minute must be in 0..59");
409 return -1;
410 }
411 if (s < 0 || s > 59) {
412 PyErr_SetString(PyExc_ValueError,
413 "second must be in 0..59");
414 return -1;
415 }
416 if (us < 0 || us > 999999) {
417 PyErr_SetString(PyExc_ValueError,
418 "microsecond must be in 0..999999");
419 return -1;
420 }
421 return 0;
422}
423
424/* ---------------------------------------------------------------------------
425 * Normalization utilities.
426 */
427
428/* One step of a mixed-radix conversion. A "hi" unit is equivalent to
429 * factor "lo" units. factor must be > 0. If *lo is less than 0, or
430 * at least factor, enough of *lo is converted into "hi" units so that
431 * 0 <= *lo < factor. The input values must be such that int overflow
432 * is impossible.
433 */
434static void
435normalize_pair(int *hi, int *lo, int factor)
436{
437 assert(factor > 0);
438 assert(lo != hi);
439 if (*lo < 0 || *lo >= factor) {
440 const int num_hi = divmod(*lo, factor, lo);
441 const int new_hi = *hi + num_hi;
442 assert(! SIGNED_ADD_OVERFLOWED(new_hi, *hi, num_hi));
443 *hi = new_hi;
444 }
445 assert(0 <= *lo && *lo < factor);
446}
447
448/* Fiddle days (d), seconds (s), and microseconds (us) so that
449 * 0 <= *s < 24*3600
450 * 0 <= *us < 1000000
451 * The input values must be such that the internals don't overflow.
452 * The way this routine is used, we don't get close.
453 */
454static void
455normalize_d_s_us(int *d, int *s, int *us)
456{
457 if (*us < 0 || *us >= 1000000) {
458 normalize_pair(s, us, 1000000);
459 /* |s| can't be bigger than about
460 * |original s| + |original us|/1000000 now.
461 */
462
463 }
464 if (*s < 0 || *s >= 24*3600) {
465 normalize_pair(d, s, 24*3600);
466 /* |d| can't be bigger than about
467 * |original d| +
468 * (|original s| + |original us|/1000000) / (24*3600) now.
469 */
470 }
471 assert(0 <= *s && *s < 24*3600);
472 assert(0 <= *us && *us < 1000000);
473}
474
475/* Fiddle years (y), months (m), and days (d) so that
476 * 1 <= *m <= 12
477 * 1 <= *d <= days_in_month(*y, *m)
478 * The input values must be such that the internals don't overflow.
479 * The way this routine is used, we don't get close.
480 */
481static void
482normalize_y_m_d(int *y, int *m, int *d)
483{
484 int dim; /* # of days in month */
485
486 /* This gets muddy: the proper range for day can't be determined
487 * without knowing the correct month and year, but if day is, e.g.,
488 * plus or minus a million, the current month and year values make
489 * no sense (and may also be out of bounds themselves).
490 * Saying 12 months == 1 year should be non-controversial.
491 */
492 if (*m < 1 || *m > 12) {
493 --*m;
494 normalize_pair(y, m, 12);
495 ++*m;
496 /* |y| can't be bigger than about
497 * |original y| + |original m|/12 now.
498 */
499 }
500 assert(1 <= *m && *m <= 12);
501
502 /* Now only day can be out of bounds (year may also be out of bounds
503 * for a datetime object, but we don't care about that here).
504 * If day is out of bounds, what to do is arguable, but at least the
505 * method here is principled and explainable.
506 */
507 dim = days_in_month(*y, *m);
508 if (*d < 1 || *d > dim) {
509 /* Move day-1 days from the first of the month. First try to
510 * get off cheap if we're only one day out of range
511 * (adjustments for timezone alone can't be worse than that).
512 */
513 if (*d == 0) {
514 --*m;
515 if (*m > 0)
516 *d = days_in_month(*y, *m);
517 else {
518 --*y;
519 *m = 12;
520 *d = 31;
521 }
522 }
523 else if (*d == dim + 1) {
524 /* move forward a day */
525 ++*m;
526 *d = 1;
527 if (*m > 12) {
528 *m = 1;
529 ++*y;
530 }
531 }
532 else {
533 int ordinal = ymd_to_ord(*y, *m, 1) +
534 *d - 1;
535 ord_to_ymd(ordinal, y, m, d);
536 }
537 }
538 assert(*m > 0);
539 assert(*d > 0);
540}
541
542/* Fiddle out-of-bounds months and days so that the result makes some kind
543 * of sense. The parameters are both inputs and outputs. Returns < 0 on
544 * failure, where failure means the adjusted year is out of bounds.
545 */
546static int
547normalize_date(int *year, int *month, int *day)
548{
549 int result;
550
551 normalize_y_m_d(year, month, day);
552 if (MINYEAR <= *year && *year <= MAXYEAR)
553 result = 0;
554 else {
555 PyErr_SetString(PyExc_OverflowError,
556 "date value out of range");
557 result = -1;
558 }
559 return result;
560}
561
562/* Force all the datetime fields into range. The parameters are both
563 * inputs and outputs. Returns < 0 on error.
564 */
565static int
566normalize_datetime(int *year, int *month, int *day,
567 int *hour, int *minute, int *second,
568 int *microsecond)
569{
570 normalize_pair(second, microsecond, 1000000);
571 normalize_pair(minute, second, 60);
572 normalize_pair(hour, minute, 60);
573 normalize_pair(day, hour, 24);
574 return normalize_date(year, month, day);
575}
576
577/* ---------------------------------------------------------------------------
Tim Petersb0c854d2003-05-17 15:57:00 +0000578 * Basic object allocation: tp_alloc implementations. These allocate
579 * Python objects of the right size and type, and do the Python object-
580 * initialization bit. If there's not enough memory, they return NULL after
581 * setting MemoryError. All data members remain uninitialized trash.
582 *
583 * We abuse the tp_alloc "nitems" argument to communicate whether a tzinfo
Tim Peters03eaf8b2003-05-18 02:24:46 +0000584 * member is needed. This is ugly, imprecise, and possibly insecure.
585 * tp_basicsize for the time and datetime types is set to the size of the
586 * struct that has room for the tzinfo member, so subclasses in Python will
587 * allocate enough space for a tzinfo member whether or not one is actually
588 * needed. That's the "ugly and imprecise" parts. The "possibly insecure"
589 * part is that PyType_GenericAlloc() (which subclasses in Python end up
590 * using) just happens today to effectively ignore the nitems argument
591 * when tp_itemsize is 0, which it is for these type objects. If that
592 * changes, perhaps the callers of tp_alloc slots in this file should
593 * be changed to force a 0 nitems argument unless the type being allocated
594 * is a base type implemented in this file (so that tp_alloc is time_alloc
595 * or datetime_alloc below, which know about the nitems abuse).
Tim Petersb0c854d2003-05-17 15:57:00 +0000596 */
597
598static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000599time_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000600{
601 PyObject *self;
602
603 self = (PyObject *)
604 PyObject_MALLOC(aware ?
605 sizeof(PyDateTime_Time) :
606 sizeof(_PyDateTime_BaseTime));
607 if (self == NULL)
608 return (PyObject *)PyErr_NoMemory();
609 PyObject_INIT(self, type);
610 return self;
611}
612
613static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000614datetime_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000615{
616 PyObject *self;
617
618 self = (PyObject *)
619 PyObject_MALLOC(aware ?
620 sizeof(PyDateTime_DateTime) :
621 sizeof(_PyDateTime_BaseDateTime));
622 if (self == NULL)
623 return (PyObject *)PyErr_NoMemory();
624 PyObject_INIT(self, type);
625 return self;
626}
627
628/* ---------------------------------------------------------------------------
629 * Helpers for setting object fields. These work on pointers to the
630 * appropriate base class.
631 */
632
633/* For date and datetime. */
634static void
635set_date_fields(PyDateTime_Date *self, int y, int m, int d)
636{
637 self->hashcode = -1;
638 SET_YEAR(self, y);
639 SET_MONTH(self, m);
640 SET_DAY(self, d);
641}
642
643/* ---------------------------------------------------------------------------
644 * Create various objects, mostly without range checking.
645 */
646
647/* Create a date instance with no range checking. */
648static PyObject *
649new_date_ex(int year, int month, int day, PyTypeObject *type)
650{
651 PyDateTime_Date *self;
652
653 self = (PyDateTime_Date *) (type->tp_alloc(type, 0));
654 if (self != NULL)
655 set_date_fields(self, year, month, day);
656 return (PyObject *) self;
657}
658
659#define new_date(year, month, day) \
660 new_date_ex(year, month, day, &PyDateTime_DateType)
661
662/* Create a datetime instance with no range checking. */
663static PyObject *
664new_datetime_ex(int year, int month, int day, int hour, int minute,
665 int second, int usecond, PyObject *tzinfo, PyTypeObject *type)
666{
667 PyDateTime_DateTime *self;
668 char aware = tzinfo != Py_None;
669
670 self = (PyDateTime_DateTime *) (type->tp_alloc(type, aware));
671 if (self != NULL) {
672 self->hastzinfo = aware;
673 set_date_fields((PyDateTime_Date *)self, year, month, day);
674 DATE_SET_HOUR(self, hour);
675 DATE_SET_MINUTE(self, minute);
676 DATE_SET_SECOND(self, second);
677 DATE_SET_MICROSECOND(self, usecond);
678 if (aware) {
679 Py_INCREF(tzinfo);
680 self->tzinfo = tzinfo;
681 }
682 }
683 return (PyObject *)self;
684}
685
686#define new_datetime(y, m, d, hh, mm, ss, us, tzinfo) \
687 new_datetime_ex(y, m, d, hh, mm, ss, us, tzinfo, \
688 &PyDateTime_DateTimeType)
689
690/* Create a time instance with no range checking. */
691static PyObject *
692new_time_ex(int hour, int minute, int second, int usecond,
693 PyObject *tzinfo, PyTypeObject *type)
694{
695 PyDateTime_Time *self;
696 char aware = tzinfo != Py_None;
697
698 self = (PyDateTime_Time *) (type->tp_alloc(type, aware));
699 if (self != NULL) {
700 self->hastzinfo = aware;
701 self->hashcode = -1;
702 TIME_SET_HOUR(self, hour);
703 TIME_SET_MINUTE(self, minute);
704 TIME_SET_SECOND(self, second);
705 TIME_SET_MICROSECOND(self, usecond);
706 if (aware) {
707 Py_INCREF(tzinfo);
708 self->tzinfo = tzinfo;
709 }
710 }
711 return (PyObject *)self;
712}
713
714#define new_time(hh, mm, ss, us, tzinfo) \
715 new_time_ex(hh, mm, ss, us, tzinfo, &PyDateTime_TimeType)
716
717/* Create a timedelta instance. Normalize the members iff normalize is
718 * true. Passing false is a speed optimization, if you know for sure
719 * that seconds and microseconds are already in their proper ranges. In any
720 * case, raises OverflowError and returns NULL if the normalized days is out
721 * of range).
722 */
723static PyObject *
724new_delta_ex(int days, int seconds, int microseconds, int normalize,
725 PyTypeObject *type)
726{
727 PyDateTime_Delta *self;
728
729 if (normalize)
730 normalize_d_s_us(&days, &seconds, &microseconds);
731 assert(0 <= seconds && seconds < 24*3600);
732 assert(0 <= microseconds && microseconds < 1000000);
733
734 if (check_delta_day_range(days) < 0)
735 return NULL;
736
737 self = (PyDateTime_Delta *) (type->tp_alloc(type, 0));
738 if (self != NULL) {
739 self->hashcode = -1;
740 SET_TD_DAYS(self, days);
741 SET_TD_SECONDS(self, seconds);
742 SET_TD_MICROSECONDS(self, microseconds);
743 }
744 return (PyObject *) self;
745}
746
747#define new_delta(d, s, us, normalize) \
748 new_delta_ex(d, s, us, normalize, &PyDateTime_DeltaType)
749
750/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +0000751 * tzinfo helpers.
752 */
753
Tim Peters855fe882002-12-22 03:43:39 +0000754/* Ensure that p is None or of a tzinfo subclass. Return 0 if OK; if not
755 * raise TypeError and return -1.
756 */
757static int
758check_tzinfo_subclass(PyObject *p)
759{
760 if (p == Py_None || PyTZInfo_Check(p))
761 return 0;
762 PyErr_Format(PyExc_TypeError,
763 "tzinfo argument must be None or of a tzinfo subclass, "
764 "not type '%s'",
765 p->ob_type->tp_name);
766 return -1;
767}
768
Tim Petersbad8ff02002-12-30 20:52:32 +0000769/* Return tzinfo.methname(tzinfoarg), without any checking of results.
Tim Peters855fe882002-12-22 03:43:39 +0000770 * If tzinfo is None, returns None.
771 */
772static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000773call_tzinfo_method(PyObject *tzinfo, char *methname, PyObject *tzinfoarg)
Tim Peters855fe882002-12-22 03:43:39 +0000774{
775 PyObject *result;
776
Tim Petersbad8ff02002-12-30 20:52:32 +0000777 assert(tzinfo && methname && tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000778 assert(check_tzinfo_subclass(tzinfo) >= 0);
779 if (tzinfo == Py_None) {
780 result = Py_None;
781 Py_INCREF(result);
782 }
783 else
Tim Petersbad8ff02002-12-30 20:52:32 +0000784 result = PyObject_CallMethod(tzinfo, methname, "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000785 return result;
786}
787
Tim Peters2a799bf2002-12-16 20:18:38 +0000788/* If self has a tzinfo member, return a BORROWED reference to it. Else
789 * return NULL, which is NOT AN ERROR. There are no error returns here,
790 * and the caller must not decref the result.
791 */
792static PyObject *
793get_tzinfo_member(PyObject *self)
794{
795 PyObject *tzinfo = NULL;
796
Tim Petersa9bc1682003-01-11 03:39:11 +0000797 if (PyDateTime_Check(self) && HASTZINFO(self))
798 tzinfo = ((PyDateTime_DateTime *)self)->tzinfo;
Tim Petersa032d2e2003-01-11 00:15:54 +0000799 else if (PyTime_Check(self) && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +0000800 tzinfo = ((PyDateTime_Time *)self)->tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000801
802 return tzinfo;
803}
804
Tim Petersbad8ff02002-12-30 20:52:32 +0000805/* Call getattr(tzinfo, name)(tzinfoarg), and extract an int from the
Tim Peters2a799bf2002-12-16 20:18:38 +0000806 * result. tzinfo must be an instance of the tzinfo class. If the method
807 * returns None, this returns 0 and sets *none to 1. If the method doesn't
Tim Peters397301e2003-01-02 21:28:08 +0000808 * return None or timedelta, TypeError is raised and this returns -1. If it
809 * returnsa timedelta and the value is out of range or isn't a whole number
810 * of minutes, ValueError is raised and this returns -1.
Tim Peters2a799bf2002-12-16 20:18:38 +0000811 * Else *none is set to 0 and the integer method result is returned.
812 */
813static int
814call_utc_tzinfo_method(PyObject *tzinfo, char *name, PyObject *tzinfoarg,
815 int *none)
816{
817 PyObject *u;
Tim Peters397301e2003-01-02 21:28:08 +0000818 int result = -1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000819
820 assert(tzinfo != NULL);
821 assert(PyTZInfo_Check(tzinfo));
822 assert(tzinfoarg != NULL);
823
824 *none = 0;
Tim Petersbad8ff02002-12-30 20:52:32 +0000825 u = call_tzinfo_method(tzinfo, name, tzinfoarg);
Tim Peters2a799bf2002-12-16 20:18:38 +0000826 if (u == NULL)
827 return -1;
828
Tim Peters27362852002-12-23 16:17:39 +0000829 else if (u == Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +0000830 result = 0;
831 *none = 1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000832 }
Tim Peters855fe882002-12-22 03:43:39 +0000833 else if (PyDelta_Check(u)) {
834 const int days = GET_TD_DAYS(u);
835 if (days < -1 || days > 0)
836 result = 24*60; /* trigger ValueError below */
837 else {
838 /* next line can't overflow because we know days
839 * is -1 or 0 now
840 */
841 int ss = days * 24 * 3600 + GET_TD_SECONDS(u);
842 result = divmod(ss, 60, &ss);
843 if (ss || GET_TD_MICROSECONDS(u)) {
844 PyErr_Format(PyExc_ValueError,
845 "tzinfo.%s() must return a "
846 "whole number of minutes",
847 name);
848 result = -1;
Tim Peters855fe882002-12-22 03:43:39 +0000849 }
850 }
851 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000852 else {
853 PyErr_Format(PyExc_TypeError,
Tim Peters397301e2003-01-02 21:28:08 +0000854 "tzinfo.%s() must return None or "
Tim Peters855fe882002-12-22 03:43:39 +0000855 "timedelta, not '%s'",
856 name, u->ob_type->tp_name);
Tim Peters2a799bf2002-12-16 20:18:38 +0000857 }
858
Tim Peters2a799bf2002-12-16 20:18:38 +0000859 Py_DECREF(u);
860 if (result < -1439 || result > 1439) {
861 PyErr_Format(PyExc_ValueError,
Neal Norwitz506a2242003-01-04 01:02:25 +0000862 "tzinfo.%s() returned %d; must be in "
Tim Peters2a799bf2002-12-16 20:18:38 +0000863 "-1439 .. 1439",
864 name, result);
865 result = -1;
866 }
Tim Peters397301e2003-01-02 21:28:08 +0000867 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +0000868}
869
870/* Call tzinfo.utcoffset(tzinfoarg), and extract an integer from the
871 * result. tzinfo must be an instance of the tzinfo class. If utcoffset()
872 * returns None, call_utcoffset returns 0 and sets *none to 1. If uctoffset()
Tim Peters397301e2003-01-02 21:28:08 +0000873 * doesn't return None or timedelta, TypeError is raised and this returns -1.
874 * If utcoffset() returns an invalid timedelta (out of range, or not a whole
875 * # of minutes), ValueError is raised and this returns -1. Else *none is
876 * set to 0 and the offset is returned (as int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000877 */
878static int
879call_utcoffset(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
880{
881 return call_utc_tzinfo_method(tzinfo, "utcoffset", tzinfoarg, none);
882}
883
Tim Petersbad8ff02002-12-30 20:52:32 +0000884/* Call tzinfo.name(tzinfoarg), and return the offset as a timedelta or None.
885 */
Tim Peters855fe882002-12-22 03:43:39 +0000886static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000887offset_as_timedelta(PyObject *tzinfo, char *name, PyObject *tzinfoarg) {
Tim Peters855fe882002-12-22 03:43:39 +0000888 PyObject *result;
889
Tim Petersbad8ff02002-12-30 20:52:32 +0000890 assert(tzinfo && name && tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000891 if (tzinfo == Py_None) {
892 result = Py_None;
893 Py_INCREF(result);
894 }
895 else {
896 int none;
Tim Petersbad8ff02002-12-30 20:52:32 +0000897 int offset = call_utc_tzinfo_method(tzinfo, name, tzinfoarg,
898 &none);
Tim Peters855fe882002-12-22 03:43:39 +0000899 if (offset < 0 && PyErr_Occurred())
900 return NULL;
901 if (none) {
902 result = Py_None;
903 Py_INCREF(result);
904 }
905 else
906 result = new_delta(0, offset * 60, 0, 1);
907 }
908 return result;
909}
910
Tim Peters2a799bf2002-12-16 20:18:38 +0000911/* Call tzinfo.dst(tzinfoarg), and extract an integer from the
912 * result. tzinfo must be an instance of the tzinfo class. If dst()
913 * returns None, call_dst returns 0 and sets *none to 1. If dst()
Tim Peters397301e2003-01-02 21:28:08 +0000914 & doesn't return None or timedelta, TypeError is raised and this
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000915 * returns -1. If dst() returns an invalid timedelta for a UTC offset,
Tim Peters397301e2003-01-02 21:28:08 +0000916 * ValueError is raised and this returns -1. Else *none is set to 0 and
917 * the offset is returned (as an int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000918 */
919static int
920call_dst(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
921{
922 return call_utc_tzinfo_method(tzinfo, "dst", tzinfoarg, none);
923}
924
Tim Petersbad8ff02002-12-30 20:52:32 +0000925/* Call tzinfo.tzname(tzinfoarg), and return the result. tzinfo must be
Tim Peters855fe882002-12-22 03:43:39 +0000926 * an instance of the tzinfo class or None. If tzinfo isn't None, and
Tim Petersbad8ff02002-12-30 20:52:32 +0000927 * tzname() doesn't return None or a string, TypeError is raised and this
Tim Peters855fe882002-12-22 03:43:39 +0000928 * returns NULL.
Tim Peters2a799bf2002-12-16 20:18:38 +0000929 */
930static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000931call_tzname(PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +0000932{
933 PyObject *result;
934
935 assert(tzinfo != NULL);
Tim Peters855fe882002-12-22 03:43:39 +0000936 assert(check_tzinfo_subclass(tzinfo) >= 0);
Tim Petersbad8ff02002-12-30 20:52:32 +0000937 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000938
Tim Peters855fe882002-12-22 03:43:39 +0000939 if (tzinfo == Py_None) {
940 result = Py_None;
941 Py_INCREF(result);
942 }
943 else
Tim Petersbad8ff02002-12-30 20:52:32 +0000944 result = PyObject_CallMethod(tzinfo, "tzname", "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000945
946 if (result != NULL && result != Py_None && ! PyString_Check(result)) {
947 PyErr_Format(PyExc_TypeError, "tzinfo.tzname() must "
Tim Peters2a799bf2002-12-16 20:18:38 +0000948 "return None or a string, not '%s'",
949 result->ob_type->tp_name);
950 Py_DECREF(result);
951 result = NULL;
952 }
953 return result;
954}
955
956typedef enum {
957 /* an exception has been set; the caller should pass it on */
958 OFFSET_ERROR,
959
Tim Petersa9bc1682003-01-11 03:39:11 +0000960 /* type isn't date, datetime, or time subclass */
Tim Peters2a799bf2002-12-16 20:18:38 +0000961 OFFSET_UNKNOWN,
962
963 /* date,
Tim Petersa9bc1682003-01-11 03:39:11 +0000964 * datetime with !hastzinfo
965 * datetime with None tzinfo,
966 * datetime where utcoffset() returns None
Tim Peters37f39822003-01-10 03:49:02 +0000967 * time with !hastzinfo
968 * time with None tzinfo,
969 * time where utcoffset() returns None
Tim Peters2a799bf2002-12-16 20:18:38 +0000970 */
971 OFFSET_NAIVE,
972
Tim Petersa9bc1682003-01-11 03:39:11 +0000973 /* time or datetime where utcoffset() doesn't return None */
Georg Brandle810fe22006-02-19 15:28:47 +0000974 OFFSET_AWARE
Tim Peters2a799bf2002-12-16 20:18:38 +0000975} naivety;
976
Tim Peters14b69412002-12-22 18:10:22 +0000977/* Classify an object as to whether it's naive or offset-aware. See
Tim Peters2a799bf2002-12-16 20:18:38 +0000978 * the "naivety" typedef for details. If the type is aware, *offset is set
979 * to minutes east of UTC (as returned by the tzinfo.utcoffset() method).
Tim Peters14b69412002-12-22 18:10:22 +0000980 * If the type is offset-naive (or unknown, or error), *offset is set to 0.
Tim Peterse39a80c2002-12-30 21:28:52 +0000981 * tzinfoarg is the argument to pass to the tzinfo.utcoffset() method.
Tim Peters2a799bf2002-12-16 20:18:38 +0000982 */
983static naivety
Tim Peterse39a80c2002-12-30 21:28:52 +0000984classify_utcoffset(PyObject *op, PyObject *tzinfoarg, int *offset)
Tim Peters2a799bf2002-12-16 20:18:38 +0000985{
986 int none;
987 PyObject *tzinfo;
988
Tim Peterse39a80c2002-12-30 21:28:52 +0000989 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000990 *offset = 0;
Tim Peters14b69412002-12-22 18:10:22 +0000991 tzinfo = get_tzinfo_member(op); /* NULL means no tzinfo, not error */
Tim Peters2a799bf2002-12-16 20:18:38 +0000992 if (tzinfo == Py_None)
993 return OFFSET_NAIVE;
Tim Peters14b69412002-12-22 18:10:22 +0000994 if (tzinfo == NULL) {
995 /* note that a datetime passes the PyDate_Check test */
996 return (PyTime_Check(op) || PyDate_Check(op)) ?
997 OFFSET_NAIVE : OFFSET_UNKNOWN;
998 }
Tim Peterse39a80c2002-12-30 21:28:52 +0000999 *offset = call_utcoffset(tzinfo, tzinfoarg, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00001000 if (*offset == -1 && PyErr_Occurred())
1001 return OFFSET_ERROR;
1002 return none ? OFFSET_NAIVE : OFFSET_AWARE;
1003}
1004
Tim Peters00237032002-12-27 02:21:51 +00001005/* Classify two objects as to whether they're naive or offset-aware.
1006 * This isn't quite the same as calling classify_utcoffset() twice: for
1007 * binary operations (comparison and subtraction), we generally want to
1008 * ignore the tzinfo members if they're identical. This is by design,
1009 * so that results match "naive" expectations when mixing objects from a
1010 * single timezone. So in that case, this sets both offsets to 0 and
1011 * both naiveties to OFFSET_NAIVE.
1012 * The function returns 0 if everything's OK, and -1 on error.
1013 */
1014static int
1015classify_two_utcoffsets(PyObject *o1, int *offset1, naivety *n1,
Tim Peterse39a80c2002-12-30 21:28:52 +00001016 PyObject *tzinfoarg1,
1017 PyObject *o2, int *offset2, naivety *n2,
1018 PyObject *tzinfoarg2)
Tim Peters00237032002-12-27 02:21:51 +00001019{
1020 if (get_tzinfo_member(o1) == get_tzinfo_member(o2)) {
1021 *offset1 = *offset2 = 0;
1022 *n1 = *n2 = OFFSET_NAIVE;
1023 }
1024 else {
Tim Peterse39a80c2002-12-30 21:28:52 +00001025 *n1 = classify_utcoffset(o1, tzinfoarg1, offset1);
Tim Peters00237032002-12-27 02:21:51 +00001026 if (*n1 == OFFSET_ERROR)
1027 return -1;
Tim Peterse39a80c2002-12-30 21:28:52 +00001028 *n2 = classify_utcoffset(o2, tzinfoarg2, offset2);
Tim Peters00237032002-12-27 02:21:51 +00001029 if (*n2 == OFFSET_ERROR)
1030 return -1;
1031 }
1032 return 0;
1033}
1034
Tim Peters2a799bf2002-12-16 20:18:38 +00001035/* repr is like "someclass(arg1, arg2)". If tzinfo isn't None,
1036 * stuff
1037 * ", tzinfo=" + repr(tzinfo)
1038 * before the closing ")".
1039 */
1040static PyObject *
1041append_keyword_tzinfo(PyObject *repr, PyObject *tzinfo)
1042{
1043 PyObject *temp;
1044
1045 assert(PyString_Check(repr));
1046 assert(tzinfo);
1047 if (tzinfo == Py_None)
1048 return repr;
1049 /* Get rid of the trailing ')'. */
1050 assert(PyString_AsString(repr)[PyString_Size(repr)-1] == ')');
1051 temp = PyString_FromStringAndSize(PyString_AsString(repr),
1052 PyString_Size(repr) - 1);
1053 Py_DECREF(repr);
1054 if (temp == NULL)
1055 return NULL;
1056 repr = temp;
1057
1058 /* Append ", tzinfo=". */
1059 PyString_ConcatAndDel(&repr, PyString_FromString(", tzinfo="));
1060
1061 /* Append repr(tzinfo). */
1062 PyString_ConcatAndDel(&repr, PyObject_Repr(tzinfo));
1063
1064 /* Add a closing paren. */
1065 PyString_ConcatAndDel(&repr, PyString_FromString(")"));
1066 return repr;
1067}
1068
1069/* ---------------------------------------------------------------------------
1070 * String format helpers.
1071 */
1072
1073static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00001074format_ctime(PyDateTime_Date *date, int hours, int minutes, int seconds)
Tim Peters2a799bf2002-12-16 20:18:38 +00001075{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001076 static const char *DayNames[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001077 "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"
1078 };
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001079 static const char *MonthNames[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001080 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1081 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
1082 };
1083
1084 char buffer[128];
1085 int wday = weekday(GET_YEAR(date), GET_MONTH(date), GET_DAY(date));
1086
1087 PyOS_snprintf(buffer, sizeof(buffer), "%s %s %2d %02d:%02d:%02d %04d",
1088 DayNames[wday], MonthNames[GET_MONTH(date) - 1],
1089 GET_DAY(date), hours, minutes, seconds,
1090 GET_YEAR(date));
1091 return PyString_FromString(buffer);
1092}
1093
1094/* Add an hours & minutes UTC offset string to buf. buf has no more than
1095 * buflen bytes remaining. The UTC offset is gotten by calling
1096 * tzinfo.uctoffset(tzinfoarg). If that returns None, \0 is stored into
1097 * *buf, and that's all. Else the returned value is checked for sanity (an
1098 * integer in range), and if that's OK it's converted to an hours & minutes
1099 * string of the form
1100 * sign HH sep MM
1101 * Returns 0 if everything is OK. If the return value from utcoffset() is
1102 * bogus, an appropriate exception is set and -1 is returned.
1103 */
1104static int
Tim Peters328fff72002-12-20 01:31:27 +00001105format_utcoffset(char *buf, size_t buflen, const char *sep,
Tim Peters2a799bf2002-12-16 20:18:38 +00001106 PyObject *tzinfo, PyObject *tzinfoarg)
1107{
1108 int offset;
1109 int hours;
1110 int minutes;
1111 char sign;
1112 int none;
1113
1114 offset = call_utcoffset(tzinfo, tzinfoarg, &none);
1115 if (offset == -1 && PyErr_Occurred())
1116 return -1;
1117 if (none) {
1118 *buf = '\0';
1119 return 0;
1120 }
1121 sign = '+';
1122 if (offset < 0) {
1123 sign = '-';
1124 offset = - offset;
1125 }
1126 hours = divmod(offset, 60, &minutes);
1127 PyOS_snprintf(buf, buflen, "%c%02d%s%02d", sign, hours, sep, minutes);
1128 return 0;
1129}
1130
1131/* I sure don't want to reproduce the strftime code from the time module,
1132 * so this imports the module and calls it. All the hair is due to
1133 * giving special meanings to the %z and %Z format codes via a preprocessing
1134 * step on the format string.
Tim Petersbad8ff02002-12-30 20:52:32 +00001135 * tzinfoarg is the argument to pass to the object's tzinfo method, if
1136 * needed.
Tim Peters2a799bf2002-12-16 20:18:38 +00001137 */
1138static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +00001139wrap_strftime(PyObject *object, PyObject *format, PyObject *timetuple,
1140 PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001141{
1142 PyObject *result = NULL; /* guilty until proved innocent */
1143
1144 PyObject *zreplacement = NULL; /* py string, replacement for %z */
1145 PyObject *Zreplacement = NULL; /* py string, replacement for %Z */
1146
1147 char *pin; /* pointer to next char in input format */
1148 char ch; /* next char in input format */
1149
1150 PyObject *newfmt = NULL; /* py string, the output format */
1151 char *pnew; /* pointer to available byte in output format */
1152 char totalnew; /* number bytes total in output format buffer,
1153 exclusive of trailing \0 */
1154 char usednew; /* number bytes used so far in output format buffer */
1155
1156 char *ptoappend; /* pointer to string to append to output buffer */
1157 int ntoappend; /* # of bytes to append to output buffer */
1158
Tim Peters2a799bf2002-12-16 20:18:38 +00001159 assert(object && format && timetuple);
1160 assert(PyString_Check(format));
1161
Tim Petersd6844152002-12-22 20:58:42 +00001162 /* Give up if the year is before 1900.
1163 * Python strftime() plays games with the year, and different
1164 * games depending on whether envar PYTHON2K is set. This makes
1165 * years before 1900 a nightmare, even if the platform strftime
1166 * supports them (and not all do).
1167 * We could get a lot farther here by avoiding Python's strftime
1168 * wrapper and calling the C strftime() directly, but that isn't
1169 * an option in the Python implementation of this module.
1170 */
1171 {
1172 long year;
1173 PyObject *pyyear = PySequence_GetItem(timetuple, 0);
1174 if (pyyear == NULL) return NULL;
1175 assert(PyInt_Check(pyyear));
1176 year = PyInt_AsLong(pyyear);
1177 Py_DECREF(pyyear);
1178 if (year < 1900) {
1179 PyErr_Format(PyExc_ValueError, "year=%ld is before "
1180 "1900; the datetime strftime() "
1181 "methods require year >= 1900",
1182 year);
1183 return NULL;
1184 }
1185 }
1186
Tim Peters2a799bf2002-12-16 20:18:38 +00001187 /* Scan the input format, looking for %z and %Z escapes, building
Tim Peters328fff72002-12-20 01:31:27 +00001188 * a new format. Since computing the replacements for those codes
1189 * is expensive, don't unless they're actually used.
Tim Peters2a799bf2002-12-16 20:18:38 +00001190 */
Raymond Hettingerf69d9f62003-06-27 08:14:17 +00001191 totalnew = PyString_Size(format) + 1; /* realistic if no %z/%Z */
Tim Peters2a799bf2002-12-16 20:18:38 +00001192 newfmt = PyString_FromStringAndSize(NULL, totalnew);
1193 if (newfmt == NULL) goto Done;
1194 pnew = PyString_AsString(newfmt);
1195 usednew = 0;
1196
1197 pin = PyString_AsString(format);
1198 while ((ch = *pin++) != '\0') {
1199 if (ch != '%') {
Tim Peters328fff72002-12-20 01:31:27 +00001200 ptoappend = pin - 1;
Tim Peters2a799bf2002-12-16 20:18:38 +00001201 ntoappend = 1;
1202 }
1203 else if ((ch = *pin++) == '\0') {
1204 /* There's a lone trailing %; doesn't make sense. */
1205 PyErr_SetString(PyExc_ValueError, "strftime format "
1206 "ends with raw %");
1207 goto Done;
1208 }
1209 /* A % has been seen and ch is the character after it. */
1210 else if (ch == 'z') {
1211 if (zreplacement == NULL) {
1212 /* format utcoffset */
Tim Peters328fff72002-12-20 01:31:27 +00001213 char buf[100];
Tim Peters2a799bf2002-12-16 20:18:38 +00001214 PyObject *tzinfo = get_tzinfo_member(object);
1215 zreplacement = PyString_FromString("");
1216 if (zreplacement == NULL) goto Done;
1217 if (tzinfo != Py_None && tzinfo != NULL) {
Tim Petersbad8ff02002-12-30 20:52:32 +00001218 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001219 if (format_utcoffset(buf,
Tim Peters328fff72002-12-20 01:31:27 +00001220 sizeof(buf),
Tim Peters2a799bf2002-12-16 20:18:38 +00001221 "",
1222 tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00001223 tzinfoarg) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00001224 goto Done;
1225 Py_DECREF(zreplacement);
1226 zreplacement = PyString_FromString(buf);
1227 if (zreplacement == NULL) goto Done;
1228 }
1229 }
1230 assert(zreplacement != NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001231 ptoappend = PyString_AS_STRING(zreplacement);
1232 ntoappend = PyString_GET_SIZE(zreplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001233 }
1234 else if (ch == 'Z') {
1235 /* format tzname */
1236 if (Zreplacement == NULL) {
1237 PyObject *tzinfo = get_tzinfo_member(object);
1238 Zreplacement = PyString_FromString("");
1239 if (Zreplacement == NULL) goto Done;
1240 if (tzinfo != Py_None && tzinfo != NULL) {
Tim Petersbad8ff02002-12-30 20:52:32 +00001241 PyObject *temp;
1242 assert(tzinfoarg != NULL);
1243 temp = call_tzname(tzinfo, tzinfoarg);
Tim Peters2a799bf2002-12-16 20:18:38 +00001244 if (temp == NULL) goto Done;
1245 if (temp != Py_None) {
1246 assert(PyString_Check(temp));
1247 /* Since the tzname is getting
1248 * stuffed into the format, we
1249 * have to double any % signs
1250 * so that strftime doesn't
1251 * treat them as format codes.
1252 */
1253 Py_DECREF(Zreplacement);
1254 Zreplacement = PyObject_CallMethod(
1255 temp, "replace",
1256 "ss", "%", "%%");
1257 Py_DECREF(temp);
1258 if (Zreplacement == NULL)
1259 goto Done;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001260 if (!PyString_Check(Zreplacement)) {
1261 PyErr_SetString(PyExc_TypeError, "tzname.replace() did not return a string");
1262 goto Done;
1263 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001264 }
1265 else
1266 Py_DECREF(temp);
1267 }
1268 }
1269 assert(Zreplacement != NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001270 ptoappend = PyString_AS_STRING(Zreplacement);
1271 ntoappend = PyString_GET_SIZE(Zreplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001272 }
1273 else {
Tim Peters328fff72002-12-20 01:31:27 +00001274 /* percent followed by neither z nor Z */
1275 ptoappend = pin - 2;
Tim Peters2a799bf2002-12-16 20:18:38 +00001276 ntoappend = 2;
1277 }
1278
1279 /* Append the ntoappend chars starting at ptoappend to
1280 * the new format.
1281 */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001282 assert(ptoappend != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001283 assert(ntoappend >= 0);
1284 if (ntoappend == 0)
1285 continue;
1286 while (usednew + ntoappend > totalnew) {
1287 int bigger = totalnew << 1;
1288 if ((bigger >> 1) != totalnew) { /* overflow */
1289 PyErr_NoMemory();
1290 goto Done;
1291 }
1292 if (_PyString_Resize(&newfmt, bigger) < 0)
1293 goto Done;
1294 totalnew = bigger;
1295 pnew = PyString_AsString(newfmt) + usednew;
1296 }
1297 memcpy(pnew, ptoappend, ntoappend);
1298 pnew += ntoappend;
1299 usednew += ntoappend;
1300 assert(usednew <= totalnew);
1301 } /* end while() */
1302
1303 if (_PyString_Resize(&newfmt, usednew) < 0)
1304 goto Done;
1305 {
1306 PyObject *time = PyImport_ImportModule("time");
1307 if (time == NULL)
1308 goto Done;
1309 result = PyObject_CallMethod(time, "strftime", "OO",
1310 newfmt, timetuple);
1311 Py_DECREF(time);
1312 }
1313 Done:
1314 Py_XDECREF(zreplacement);
1315 Py_XDECREF(Zreplacement);
1316 Py_XDECREF(newfmt);
1317 return result;
1318}
1319
1320static char *
1321isoformat_date(PyDateTime_Date *dt, char buffer[], int bufflen)
1322{
1323 int x;
1324 x = PyOS_snprintf(buffer, bufflen,
1325 "%04d-%02d-%02d",
1326 GET_YEAR(dt), GET_MONTH(dt), GET_DAY(dt));
1327 return buffer + x;
1328}
1329
1330static void
1331isoformat_time(PyDateTime_DateTime *dt, char buffer[], int bufflen)
1332{
1333 int us = DATE_GET_MICROSECOND(dt);
1334
1335 PyOS_snprintf(buffer, bufflen,
1336 "%02d:%02d:%02d", /* 8 characters */
1337 DATE_GET_HOUR(dt),
1338 DATE_GET_MINUTE(dt),
1339 DATE_GET_SECOND(dt));
1340 if (us)
1341 PyOS_snprintf(buffer + 8, bufflen - 8, ".%06d", us);
1342}
1343
1344/* ---------------------------------------------------------------------------
1345 * Wrap functions from the time module. These aren't directly available
1346 * from C. Perhaps they should be.
1347 */
1348
1349/* Call time.time() and return its result (a Python float). */
1350static PyObject *
Guido van Rossumbd43e912002-12-16 20:34:55 +00001351time_time(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00001352{
1353 PyObject *result = NULL;
1354 PyObject *time = PyImport_ImportModule("time");
1355
1356 if (time != NULL) {
1357 result = PyObject_CallMethod(time, "time", "()");
1358 Py_DECREF(time);
1359 }
1360 return result;
1361}
1362
1363/* Build a time.struct_time. The weekday and day number are automatically
1364 * computed from the y,m,d args.
1365 */
1366static PyObject *
1367build_struct_time(int y, int m, int d, int hh, int mm, int ss, int dstflag)
1368{
1369 PyObject *time;
1370 PyObject *result = NULL;
1371
1372 time = PyImport_ImportModule("time");
1373 if (time != NULL) {
1374 result = PyObject_CallMethod(time, "struct_time",
1375 "((iiiiiiiii))",
1376 y, m, d,
1377 hh, mm, ss,
1378 weekday(y, m, d),
1379 days_before_month(y, m) + d,
1380 dstflag);
1381 Py_DECREF(time);
1382 }
1383 return result;
1384}
1385
1386/* ---------------------------------------------------------------------------
1387 * Miscellaneous helpers.
1388 */
1389
1390/* For obscure reasons, we need to use tp_richcompare instead of tp_compare.
1391 * The comparisons here all most naturally compute a cmp()-like result.
1392 * This little helper turns that into a bool result for rich comparisons.
1393 */
1394static PyObject *
1395diff_to_bool(int diff, int op)
1396{
1397 PyObject *result;
1398 int istrue;
1399
1400 switch (op) {
1401 case Py_EQ: istrue = diff == 0; break;
1402 case Py_NE: istrue = diff != 0; break;
1403 case Py_LE: istrue = diff <= 0; break;
1404 case Py_GE: istrue = diff >= 0; break;
1405 case Py_LT: istrue = diff < 0; break;
1406 case Py_GT: istrue = diff > 0; break;
1407 default:
1408 assert(! "op unknown");
1409 istrue = 0; /* To shut up compiler */
1410 }
1411 result = istrue ? Py_True : Py_False;
1412 Py_INCREF(result);
1413 return result;
1414}
1415
Tim Peters07534a62003-02-07 22:50:28 +00001416/* Raises a "can't compare" TypeError and returns NULL. */
1417static PyObject *
1418cmperror(PyObject *a, PyObject *b)
1419{
1420 PyErr_Format(PyExc_TypeError,
1421 "can't compare %s to %s",
1422 a->ob_type->tp_name, b->ob_type->tp_name);
1423 return NULL;
1424}
1425
Tim Peters2a799bf2002-12-16 20:18:38 +00001426/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +00001427 * Cached Python objects; these are set by the module init function.
1428 */
1429
1430/* Conversion factors. */
1431static PyObject *us_per_us = NULL; /* 1 */
1432static PyObject *us_per_ms = NULL; /* 1000 */
1433static PyObject *us_per_second = NULL; /* 1000000 */
1434static PyObject *us_per_minute = NULL; /* 1e6 * 60 as Python int */
1435static PyObject *us_per_hour = NULL; /* 1e6 * 3600 as Python long */
1436static PyObject *us_per_day = NULL; /* 1e6 * 3600 * 24 as Python long */
1437static PyObject *us_per_week = NULL; /* 1e6*3600*24*7 as Python long */
1438static PyObject *seconds_per_day = NULL; /* 3600*24 as Python int */
1439
Tim Peters2a799bf2002-12-16 20:18:38 +00001440/* ---------------------------------------------------------------------------
1441 * Class implementations.
1442 */
1443
1444/*
1445 * PyDateTime_Delta implementation.
1446 */
1447
1448/* Convert a timedelta to a number of us,
1449 * (24*3600*self.days + self.seconds)*1000000 + self.microseconds
1450 * as a Python int or long.
1451 * Doing mixed-radix arithmetic by hand instead is excruciating in C,
1452 * due to ubiquitous overflow possibilities.
1453 */
1454static PyObject *
1455delta_to_microseconds(PyDateTime_Delta *self)
1456{
1457 PyObject *x1 = NULL;
1458 PyObject *x2 = NULL;
1459 PyObject *x3 = NULL;
1460 PyObject *result = NULL;
1461
1462 x1 = PyInt_FromLong(GET_TD_DAYS(self));
1463 if (x1 == NULL)
1464 goto Done;
1465 x2 = PyNumber_Multiply(x1, seconds_per_day); /* days in seconds */
1466 if (x2 == NULL)
1467 goto Done;
1468 Py_DECREF(x1);
1469 x1 = NULL;
1470
1471 /* x2 has days in seconds */
1472 x1 = PyInt_FromLong(GET_TD_SECONDS(self)); /* seconds */
1473 if (x1 == NULL)
1474 goto Done;
1475 x3 = PyNumber_Add(x1, x2); /* days and seconds in seconds */
1476 if (x3 == NULL)
1477 goto Done;
1478 Py_DECREF(x1);
1479 Py_DECREF(x2);
1480 x1 = x2 = NULL;
1481
1482 /* x3 has days+seconds in seconds */
1483 x1 = PyNumber_Multiply(x3, us_per_second); /* us */
1484 if (x1 == NULL)
1485 goto Done;
1486 Py_DECREF(x3);
1487 x3 = NULL;
1488
1489 /* x1 has days+seconds in us */
1490 x2 = PyInt_FromLong(GET_TD_MICROSECONDS(self));
1491 if (x2 == NULL)
1492 goto Done;
1493 result = PyNumber_Add(x1, x2);
1494
1495Done:
1496 Py_XDECREF(x1);
1497 Py_XDECREF(x2);
1498 Py_XDECREF(x3);
1499 return result;
1500}
1501
1502/* Convert a number of us (as a Python int or long) to a timedelta.
1503 */
1504static PyObject *
Tim Petersb0c854d2003-05-17 15:57:00 +00001505microseconds_to_delta_ex(PyObject *pyus, PyTypeObject *type)
Tim Peters2a799bf2002-12-16 20:18:38 +00001506{
1507 int us;
1508 int s;
1509 int d;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001510 long temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001511
1512 PyObject *tuple = NULL;
1513 PyObject *num = NULL;
1514 PyObject *result = NULL;
1515
1516 tuple = PyNumber_Divmod(pyus, us_per_second);
1517 if (tuple == NULL)
1518 goto Done;
1519
1520 num = PyTuple_GetItem(tuple, 1); /* us */
1521 if (num == NULL)
1522 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001523 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001524 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001525 if (temp == -1 && PyErr_Occurred())
1526 goto Done;
1527 assert(0 <= temp && temp < 1000000);
1528 us = (int)temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001529 if (us < 0) {
1530 /* The divisor was positive, so this must be an error. */
1531 assert(PyErr_Occurred());
1532 goto Done;
1533 }
1534
1535 num = PyTuple_GetItem(tuple, 0); /* leftover seconds */
1536 if (num == NULL)
1537 goto Done;
1538 Py_INCREF(num);
1539 Py_DECREF(tuple);
1540
1541 tuple = PyNumber_Divmod(num, seconds_per_day);
1542 if (tuple == NULL)
1543 goto Done;
1544 Py_DECREF(num);
1545
1546 num = PyTuple_GetItem(tuple, 1); /* seconds */
1547 if (num == NULL)
1548 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001549 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001550 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001551 if (temp == -1 && PyErr_Occurred())
1552 goto Done;
1553 assert(0 <= temp && temp < 24*3600);
1554 s = (int)temp;
1555
Tim Peters2a799bf2002-12-16 20:18:38 +00001556 if (s < 0) {
1557 /* The divisor was positive, so this must be an error. */
1558 assert(PyErr_Occurred());
1559 goto Done;
1560 }
1561
1562 num = PyTuple_GetItem(tuple, 0); /* leftover days */
1563 if (num == NULL)
1564 goto Done;
1565 Py_INCREF(num);
Tim Peters0b0f41c2002-12-19 01:44:38 +00001566 temp = PyLong_AsLong(num);
1567 if (temp == -1 && PyErr_Occurred())
Tim Peters2a799bf2002-12-16 20:18:38 +00001568 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001569 d = (int)temp;
1570 if ((long)d != temp) {
1571 PyErr_SetString(PyExc_OverflowError, "normalized days too "
1572 "large to fit in a C int");
1573 goto Done;
1574 }
Tim Petersb0c854d2003-05-17 15:57:00 +00001575 result = new_delta_ex(d, s, us, 0, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001576
1577Done:
1578 Py_XDECREF(tuple);
1579 Py_XDECREF(num);
1580 return result;
1581}
1582
Tim Petersb0c854d2003-05-17 15:57:00 +00001583#define microseconds_to_delta(pymicros) \
1584 microseconds_to_delta_ex(pymicros, &PyDateTime_DeltaType)
1585
Tim Peters2a799bf2002-12-16 20:18:38 +00001586static PyObject *
1587multiply_int_timedelta(PyObject *intobj, PyDateTime_Delta *delta)
1588{
1589 PyObject *pyus_in;
1590 PyObject *pyus_out;
1591 PyObject *result;
1592
1593 pyus_in = delta_to_microseconds(delta);
1594 if (pyus_in == NULL)
1595 return NULL;
1596
1597 pyus_out = PyNumber_Multiply(pyus_in, intobj);
1598 Py_DECREF(pyus_in);
1599 if (pyus_out == NULL)
1600 return NULL;
1601
1602 result = microseconds_to_delta(pyus_out);
1603 Py_DECREF(pyus_out);
1604 return result;
1605}
1606
1607static PyObject *
1608divide_timedelta_int(PyDateTime_Delta *delta, PyObject *intobj)
1609{
1610 PyObject *pyus_in;
1611 PyObject *pyus_out;
1612 PyObject *result;
1613
1614 pyus_in = delta_to_microseconds(delta);
1615 if (pyus_in == NULL)
1616 return NULL;
1617
1618 pyus_out = PyNumber_FloorDivide(pyus_in, intobj);
1619 Py_DECREF(pyus_in);
1620 if (pyus_out == NULL)
1621 return NULL;
1622
1623 result = microseconds_to_delta(pyus_out);
1624 Py_DECREF(pyus_out);
1625 return result;
1626}
1627
1628static PyObject *
1629delta_add(PyObject *left, PyObject *right)
1630{
1631 PyObject *result = Py_NotImplemented;
1632
1633 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1634 /* delta + delta */
1635 /* The C-level additions can't overflow because of the
1636 * invariant bounds.
1637 */
1638 int days = GET_TD_DAYS(left) + GET_TD_DAYS(right);
1639 int seconds = GET_TD_SECONDS(left) + GET_TD_SECONDS(right);
1640 int microseconds = GET_TD_MICROSECONDS(left) +
1641 GET_TD_MICROSECONDS(right);
1642 result = new_delta(days, seconds, microseconds, 1);
1643 }
1644
1645 if (result == Py_NotImplemented)
1646 Py_INCREF(result);
1647 return result;
1648}
1649
1650static PyObject *
1651delta_negative(PyDateTime_Delta *self)
1652{
1653 return new_delta(-GET_TD_DAYS(self),
1654 -GET_TD_SECONDS(self),
1655 -GET_TD_MICROSECONDS(self),
1656 1);
1657}
1658
1659static PyObject *
1660delta_positive(PyDateTime_Delta *self)
1661{
1662 /* Could optimize this (by returning self) if this isn't a
1663 * subclass -- but who uses unary + ? Approximately nobody.
1664 */
1665 return new_delta(GET_TD_DAYS(self),
1666 GET_TD_SECONDS(self),
1667 GET_TD_MICROSECONDS(self),
1668 0);
1669}
1670
1671static PyObject *
1672delta_abs(PyDateTime_Delta *self)
1673{
1674 PyObject *result;
1675
1676 assert(GET_TD_MICROSECONDS(self) >= 0);
1677 assert(GET_TD_SECONDS(self) >= 0);
1678
1679 if (GET_TD_DAYS(self) < 0)
1680 result = delta_negative(self);
1681 else
1682 result = delta_positive(self);
1683
1684 return result;
1685}
1686
1687static PyObject *
1688delta_subtract(PyObject *left, PyObject *right)
1689{
1690 PyObject *result = Py_NotImplemented;
1691
1692 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1693 /* delta - delta */
1694 PyObject *minus_right = PyNumber_Negative(right);
1695 if (minus_right) {
1696 result = delta_add(left, minus_right);
1697 Py_DECREF(minus_right);
1698 }
1699 else
1700 result = NULL;
1701 }
1702
1703 if (result == Py_NotImplemented)
1704 Py_INCREF(result);
1705 return result;
1706}
1707
1708/* This is more natural as a tp_compare, but doesn't work then: for whatever
1709 * reason, Python's try_3way_compare ignores tp_compare unless
1710 * PyInstance_Check returns true, but these aren't old-style classes.
1711 */
1712static PyObject *
1713delta_richcompare(PyDateTime_Delta *self, PyObject *other, int op)
1714{
Tim Peters07534a62003-02-07 22:50:28 +00001715 int diff = 42; /* nonsense */
Tim Peters2a799bf2002-12-16 20:18:38 +00001716
Tim Petersaa7d8492003-02-08 03:28:59 +00001717 if (PyDelta_Check(other)) {
Tim Peters07534a62003-02-07 22:50:28 +00001718 diff = GET_TD_DAYS(self) - GET_TD_DAYS(other);
1719 if (diff == 0) {
1720 diff = GET_TD_SECONDS(self) - GET_TD_SECONDS(other);
1721 if (diff == 0)
1722 diff = GET_TD_MICROSECONDS(self) -
1723 GET_TD_MICROSECONDS(other);
1724 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001725 }
Tim Peters07534a62003-02-07 22:50:28 +00001726 else if (op == Py_EQ || op == Py_NE)
1727 diff = 1; /* any non-zero value will do */
1728
1729 else /* stop this from falling back to address comparison */
1730 return cmperror((PyObject *)self, other);
1731
Tim Peters2a799bf2002-12-16 20:18:38 +00001732 return diff_to_bool(diff, op);
1733}
1734
1735static PyObject *delta_getstate(PyDateTime_Delta *self);
1736
1737static long
1738delta_hash(PyDateTime_Delta *self)
1739{
1740 if (self->hashcode == -1) {
1741 PyObject *temp = delta_getstate(self);
1742 if (temp != NULL) {
1743 self->hashcode = PyObject_Hash(temp);
1744 Py_DECREF(temp);
1745 }
1746 }
1747 return self->hashcode;
1748}
1749
1750static PyObject *
1751delta_multiply(PyObject *left, PyObject *right)
1752{
1753 PyObject *result = Py_NotImplemented;
1754
1755 if (PyDelta_Check(left)) {
1756 /* delta * ??? */
1757 if (PyInt_Check(right) || PyLong_Check(right))
1758 result = multiply_int_timedelta(right,
1759 (PyDateTime_Delta *) left);
1760 }
1761 else if (PyInt_Check(left) || PyLong_Check(left))
1762 result = multiply_int_timedelta(left,
1763 (PyDateTime_Delta *) right);
1764
1765 if (result == Py_NotImplemented)
1766 Py_INCREF(result);
1767 return result;
1768}
1769
1770static PyObject *
1771delta_divide(PyObject *left, PyObject *right)
1772{
1773 PyObject *result = Py_NotImplemented;
1774
1775 if (PyDelta_Check(left)) {
1776 /* delta * ??? */
1777 if (PyInt_Check(right) || PyLong_Check(right))
1778 result = divide_timedelta_int(
1779 (PyDateTime_Delta *)left,
1780 right);
1781 }
1782
1783 if (result == Py_NotImplemented)
1784 Py_INCREF(result);
1785 return result;
1786}
1787
1788/* Fold in the value of the tag ("seconds", "weeks", etc) component of a
1789 * timedelta constructor. sofar is the # of microseconds accounted for
1790 * so far, and there are factor microseconds per current unit, the number
1791 * of which is given by num. num * factor is added to sofar in a
1792 * numerically careful way, and that's the result. Any fractional
1793 * microseconds left over (this can happen if num is a float type) are
1794 * added into *leftover.
1795 * Note that there are many ways this can give an error (NULL) return.
1796 */
1797static PyObject *
1798accum(const char* tag, PyObject *sofar, PyObject *num, PyObject *factor,
1799 double *leftover)
1800{
1801 PyObject *prod;
1802 PyObject *sum;
1803
1804 assert(num != NULL);
1805
1806 if (PyInt_Check(num) || PyLong_Check(num)) {
1807 prod = PyNumber_Multiply(num, factor);
1808 if (prod == NULL)
1809 return NULL;
1810 sum = PyNumber_Add(sofar, prod);
1811 Py_DECREF(prod);
1812 return sum;
1813 }
1814
1815 if (PyFloat_Check(num)) {
1816 double dnum;
1817 double fracpart;
1818 double intpart;
1819 PyObject *x;
1820 PyObject *y;
1821
1822 /* The Plan: decompose num into an integer part and a
1823 * fractional part, num = intpart + fracpart.
1824 * Then num * factor ==
1825 * intpart * factor + fracpart * factor
1826 * and the LHS can be computed exactly in long arithmetic.
1827 * The RHS is again broken into an int part and frac part.
1828 * and the frac part is added into *leftover.
1829 */
1830 dnum = PyFloat_AsDouble(num);
1831 if (dnum == -1.0 && PyErr_Occurred())
1832 return NULL;
1833 fracpart = modf(dnum, &intpart);
1834 x = PyLong_FromDouble(intpart);
1835 if (x == NULL)
1836 return NULL;
1837
1838 prod = PyNumber_Multiply(x, factor);
1839 Py_DECREF(x);
1840 if (prod == NULL)
1841 return NULL;
1842
1843 sum = PyNumber_Add(sofar, prod);
1844 Py_DECREF(prod);
1845 if (sum == NULL)
1846 return NULL;
1847
1848 if (fracpart == 0.0)
1849 return sum;
1850 /* So far we've lost no information. Dealing with the
1851 * fractional part requires float arithmetic, and may
1852 * lose a little info.
1853 */
1854 assert(PyInt_Check(factor) || PyLong_Check(factor));
1855 if (PyInt_Check(factor))
1856 dnum = (double)PyInt_AsLong(factor);
1857 else
1858 dnum = PyLong_AsDouble(factor);
1859
1860 dnum *= fracpart;
1861 fracpart = modf(dnum, &intpart);
1862 x = PyLong_FromDouble(intpart);
1863 if (x == NULL) {
1864 Py_DECREF(sum);
1865 return NULL;
1866 }
1867
1868 y = PyNumber_Add(sum, x);
1869 Py_DECREF(sum);
1870 Py_DECREF(x);
1871 *leftover += fracpart;
1872 return y;
1873 }
1874
1875 PyErr_Format(PyExc_TypeError,
1876 "unsupported type for timedelta %s component: %s",
1877 tag, num->ob_type->tp_name);
1878 return NULL;
1879}
1880
1881static PyObject *
1882delta_new(PyTypeObject *type, PyObject *args, PyObject *kw)
1883{
1884 PyObject *self = NULL;
1885
1886 /* Argument objects. */
1887 PyObject *day = NULL;
1888 PyObject *second = NULL;
1889 PyObject *us = NULL;
1890 PyObject *ms = NULL;
1891 PyObject *minute = NULL;
1892 PyObject *hour = NULL;
1893 PyObject *week = NULL;
1894
1895 PyObject *x = NULL; /* running sum of microseconds */
1896 PyObject *y = NULL; /* temp sum of microseconds */
1897 double leftover_us = 0.0;
1898
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00001899 static char *keywords[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001900 "days", "seconds", "microseconds", "milliseconds",
1901 "minutes", "hours", "weeks", NULL
1902 };
1903
1904 if (PyArg_ParseTupleAndKeywords(args, kw, "|OOOOOOO:__new__",
1905 keywords,
1906 &day, &second, &us,
1907 &ms, &minute, &hour, &week) == 0)
1908 goto Done;
1909
1910 x = PyInt_FromLong(0);
1911 if (x == NULL)
1912 goto Done;
1913
1914#define CLEANUP \
1915 Py_DECREF(x); \
1916 x = y; \
1917 if (x == NULL) \
1918 goto Done
1919
1920 if (us) {
1921 y = accum("microseconds", x, us, us_per_us, &leftover_us);
1922 CLEANUP;
1923 }
1924 if (ms) {
1925 y = accum("milliseconds", x, ms, us_per_ms, &leftover_us);
1926 CLEANUP;
1927 }
1928 if (second) {
1929 y = accum("seconds", x, second, us_per_second, &leftover_us);
1930 CLEANUP;
1931 }
1932 if (minute) {
1933 y = accum("minutes", x, minute, us_per_minute, &leftover_us);
1934 CLEANUP;
1935 }
1936 if (hour) {
1937 y = accum("hours", x, hour, us_per_hour, &leftover_us);
1938 CLEANUP;
1939 }
1940 if (day) {
1941 y = accum("days", x, day, us_per_day, &leftover_us);
1942 CLEANUP;
1943 }
1944 if (week) {
1945 y = accum("weeks", x, week, us_per_week, &leftover_us);
1946 CLEANUP;
1947 }
1948 if (leftover_us) {
1949 /* Round to nearest whole # of us, and add into x. */
Tim Peters5d644dd2003-01-02 16:32:54 +00001950 PyObject *temp = PyLong_FromLong(round_to_long(leftover_us));
Tim Peters2a799bf2002-12-16 20:18:38 +00001951 if (temp == NULL) {
1952 Py_DECREF(x);
1953 goto Done;
1954 }
1955 y = PyNumber_Add(x, temp);
1956 Py_DECREF(temp);
1957 CLEANUP;
1958 }
1959
Tim Petersb0c854d2003-05-17 15:57:00 +00001960 self = microseconds_to_delta_ex(x, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001961 Py_DECREF(x);
1962Done:
1963 return self;
1964
1965#undef CLEANUP
1966}
1967
1968static int
1969delta_nonzero(PyDateTime_Delta *self)
1970{
1971 return (GET_TD_DAYS(self) != 0
1972 || GET_TD_SECONDS(self) != 0
1973 || GET_TD_MICROSECONDS(self) != 0);
1974}
1975
1976static PyObject *
1977delta_repr(PyDateTime_Delta *self)
1978{
1979 if (GET_TD_MICROSECONDS(self) != 0)
1980 return PyString_FromFormat("%s(%d, %d, %d)",
1981 self->ob_type->tp_name,
1982 GET_TD_DAYS(self),
1983 GET_TD_SECONDS(self),
1984 GET_TD_MICROSECONDS(self));
1985 if (GET_TD_SECONDS(self) != 0)
1986 return PyString_FromFormat("%s(%d, %d)",
1987 self->ob_type->tp_name,
1988 GET_TD_DAYS(self),
1989 GET_TD_SECONDS(self));
1990
1991 return PyString_FromFormat("%s(%d)",
1992 self->ob_type->tp_name,
1993 GET_TD_DAYS(self));
1994}
1995
1996static PyObject *
1997delta_str(PyDateTime_Delta *self)
1998{
1999 int days = GET_TD_DAYS(self);
2000 int seconds = GET_TD_SECONDS(self);
2001 int us = GET_TD_MICROSECONDS(self);
2002 int hours;
2003 int minutes;
Tim Petersba873472002-12-18 20:19:21 +00002004 char buf[100];
2005 char *pbuf = buf;
2006 size_t buflen = sizeof(buf);
2007 int n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002008
2009 minutes = divmod(seconds, 60, &seconds);
2010 hours = divmod(minutes, 60, &minutes);
2011
2012 if (days) {
Tim Petersba873472002-12-18 20:19:21 +00002013 n = PyOS_snprintf(pbuf, buflen, "%d day%s, ", days,
2014 (days == 1 || days == -1) ? "" : "s");
2015 if (n < 0 || (size_t)n >= buflen)
2016 goto Fail;
2017 pbuf += n;
2018 buflen -= (size_t)n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002019 }
2020
Tim Petersba873472002-12-18 20:19:21 +00002021 n = PyOS_snprintf(pbuf, buflen, "%d:%02d:%02d",
2022 hours, minutes, seconds);
2023 if (n < 0 || (size_t)n >= buflen)
2024 goto Fail;
2025 pbuf += n;
2026 buflen -= (size_t)n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002027
2028 if (us) {
Tim Petersba873472002-12-18 20:19:21 +00002029 n = PyOS_snprintf(pbuf, buflen, ".%06d", us);
2030 if (n < 0 || (size_t)n >= buflen)
2031 goto Fail;
2032 pbuf += n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002033 }
2034
Tim Petersba873472002-12-18 20:19:21 +00002035 return PyString_FromStringAndSize(buf, pbuf - buf);
2036
2037 Fail:
2038 PyErr_SetString(PyExc_SystemError, "goofy result from PyOS_snprintf");
2039 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002040}
2041
Tim Peters371935f2003-02-01 01:52:50 +00002042/* Pickle support, a simple use of __reduce__. */
2043
Tim Petersb57f8f02003-02-01 02:54:15 +00002044/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002045static PyObject *
2046delta_getstate(PyDateTime_Delta *self)
2047{
2048 return Py_BuildValue("iii", GET_TD_DAYS(self),
2049 GET_TD_SECONDS(self),
2050 GET_TD_MICROSECONDS(self));
2051}
2052
Tim Peters2a799bf2002-12-16 20:18:38 +00002053static PyObject *
2054delta_reduce(PyDateTime_Delta* self)
2055{
Tim Peters8a60c222003-02-01 01:47:29 +00002056 return Py_BuildValue("ON", self->ob_type, delta_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002057}
2058
2059#define OFFSET(field) offsetof(PyDateTime_Delta, field)
2060
2061static PyMemberDef delta_members[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002062
Neal Norwitzdfb80862002-12-19 02:30:56 +00002063 {"days", T_INT, OFFSET(days), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002064 PyDoc_STR("Number of days.")},
2065
Neal Norwitzdfb80862002-12-19 02:30:56 +00002066 {"seconds", T_INT, OFFSET(seconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002067 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
2068
Neal Norwitzdfb80862002-12-19 02:30:56 +00002069 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002070 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
2071 {NULL}
2072};
2073
2074static PyMethodDef delta_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002075 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
2076 PyDoc_STR("__reduce__() -> (cls, state)")},
2077
Tim Peters2a799bf2002-12-16 20:18:38 +00002078 {NULL, NULL},
2079};
2080
2081static char delta_doc[] =
2082PyDoc_STR("Difference between two datetime values.");
2083
2084static PyNumberMethods delta_as_number = {
2085 delta_add, /* nb_add */
2086 delta_subtract, /* nb_subtract */
2087 delta_multiply, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00002088 0, /* nb_remainder */
2089 0, /* nb_divmod */
2090 0, /* nb_power */
2091 (unaryfunc)delta_negative, /* nb_negative */
2092 (unaryfunc)delta_positive, /* nb_positive */
2093 (unaryfunc)delta_abs, /* nb_absolute */
2094 (inquiry)delta_nonzero, /* nb_nonzero */
2095 0, /*nb_invert*/
2096 0, /*nb_lshift*/
2097 0, /*nb_rshift*/
2098 0, /*nb_and*/
2099 0, /*nb_xor*/
2100 0, /*nb_or*/
2101 0, /*nb_coerce*/
2102 0, /*nb_int*/
2103 0, /*nb_long*/
2104 0, /*nb_float*/
2105 0, /*nb_oct*/
2106 0, /*nb_hex*/
2107 0, /*nb_inplace_add*/
2108 0, /*nb_inplace_subtract*/
2109 0, /*nb_inplace_multiply*/
Tim Peters2a799bf2002-12-16 20:18:38 +00002110 0, /*nb_inplace_remainder*/
2111 0, /*nb_inplace_power*/
2112 0, /*nb_inplace_lshift*/
2113 0, /*nb_inplace_rshift*/
2114 0, /*nb_inplace_and*/
2115 0, /*nb_inplace_xor*/
2116 0, /*nb_inplace_or*/
2117 delta_divide, /* nb_floor_divide */
2118 0, /* nb_true_divide */
2119 0, /* nb_inplace_floor_divide */
2120 0, /* nb_inplace_true_divide */
2121};
2122
2123static PyTypeObject PyDateTime_DeltaType = {
2124 PyObject_HEAD_INIT(NULL)
2125 0, /* ob_size */
2126 "datetime.timedelta", /* tp_name */
2127 sizeof(PyDateTime_Delta), /* tp_basicsize */
2128 0, /* tp_itemsize */
2129 0, /* tp_dealloc */
2130 0, /* tp_print */
2131 0, /* tp_getattr */
2132 0, /* tp_setattr */
2133 0, /* tp_compare */
2134 (reprfunc)delta_repr, /* tp_repr */
2135 &delta_as_number, /* tp_as_number */
2136 0, /* tp_as_sequence */
2137 0, /* tp_as_mapping */
2138 (hashfunc)delta_hash, /* tp_hash */
2139 0, /* tp_call */
2140 (reprfunc)delta_str, /* tp_str */
2141 PyObject_GenericGetAttr, /* tp_getattro */
2142 0, /* tp_setattro */
2143 0, /* tp_as_buffer */
Tim Petersb0c854d2003-05-17 15:57:00 +00002144 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2145 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00002146 delta_doc, /* tp_doc */
2147 0, /* tp_traverse */
2148 0, /* tp_clear */
2149 (richcmpfunc)delta_richcompare, /* tp_richcompare */
2150 0, /* tp_weaklistoffset */
2151 0, /* tp_iter */
2152 0, /* tp_iternext */
2153 delta_methods, /* tp_methods */
2154 delta_members, /* tp_members */
2155 0, /* tp_getset */
2156 0, /* tp_base */
2157 0, /* tp_dict */
2158 0, /* tp_descr_get */
2159 0, /* tp_descr_set */
2160 0, /* tp_dictoffset */
2161 0, /* tp_init */
2162 0, /* tp_alloc */
2163 delta_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002164 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002165};
2166
2167/*
2168 * PyDateTime_Date implementation.
2169 */
2170
2171/* Accessor properties. */
2172
2173static PyObject *
2174date_year(PyDateTime_Date *self, void *unused)
2175{
2176 return PyInt_FromLong(GET_YEAR(self));
2177}
2178
2179static PyObject *
2180date_month(PyDateTime_Date *self, void *unused)
2181{
2182 return PyInt_FromLong(GET_MONTH(self));
2183}
2184
2185static PyObject *
2186date_day(PyDateTime_Date *self, void *unused)
2187{
2188 return PyInt_FromLong(GET_DAY(self));
2189}
2190
2191static PyGetSetDef date_getset[] = {
2192 {"year", (getter)date_year},
2193 {"month", (getter)date_month},
2194 {"day", (getter)date_day},
2195 {NULL}
2196};
2197
2198/* Constructors. */
2199
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002200static char *date_kws[] = {"year", "month", "day", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002201
Tim Peters2a799bf2002-12-16 20:18:38 +00002202static PyObject *
2203date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2204{
2205 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00002206 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00002207 int year;
2208 int month;
2209 int day;
2210
Guido van Rossum177e41a2003-01-30 22:06:23 +00002211 /* Check for invocation from pickle with __getstate__ state */
2212 if (PyTuple_GET_SIZE(args) == 1 &&
Tim Peters70533e22003-02-01 04:40:04 +00002213 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Tim Peters3f606292004-03-21 23:38:41 +00002214 PyString_GET_SIZE(state) == _PyDateTime_DATE_DATASIZE &&
2215 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00002216 {
Tim Peters70533e22003-02-01 04:40:04 +00002217 PyDateTime_Date *me;
2218
Tim Peters604c0132004-06-07 23:04:33 +00002219 me = (PyDateTime_Date *) (type->tp_alloc(type, 0));
Tim Peters70533e22003-02-01 04:40:04 +00002220 if (me != NULL) {
2221 char *pdata = PyString_AS_STRING(state);
2222 memcpy(me->data, pdata, _PyDateTime_DATE_DATASIZE);
2223 me->hashcode = -1;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002224 }
Tim Peters70533e22003-02-01 04:40:04 +00002225 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002226 }
2227
Tim Peters12bf3392002-12-24 05:41:27 +00002228 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00002229 &year, &month, &day)) {
2230 if (check_date_args(year, month, day) < 0)
2231 return NULL;
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002232 self = new_date_ex(year, month, day, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00002233 }
2234 return self;
2235}
2236
2237/* Return new date from localtime(t). */
2238static PyObject *
Tim Peters1b6f7a92004-06-20 02:50:16 +00002239date_local_from_time_t(PyObject *cls, double ts)
Tim Peters2a799bf2002-12-16 20:18:38 +00002240{
2241 struct tm *tm;
Tim Peters1b6f7a92004-06-20 02:50:16 +00002242 time_t t;
Tim Peters2a799bf2002-12-16 20:18:38 +00002243 PyObject *result = NULL;
2244
Tim Peters1b6f7a92004-06-20 02:50:16 +00002245 t = _PyTime_DoubleToTimet(ts);
2246 if (t == (time_t)-1 && PyErr_Occurred())
2247 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002248 tm = localtime(&t);
2249 if (tm)
2250 result = PyObject_CallFunction(cls, "iii",
2251 tm->tm_year + 1900,
2252 tm->tm_mon + 1,
2253 tm->tm_mday);
2254 else
2255 PyErr_SetString(PyExc_ValueError,
2256 "timestamp out of range for "
2257 "platform localtime() function");
2258 return result;
2259}
2260
2261/* Return new date from current time.
2262 * We say this is equivalent to fromtimestamp(time.time()), and the
2263 * only way to be sure of that is to *call* time.time(). That's not
2264 * generally the same as calling C's time.
2265 */
2266static PyObject *
2267date_today(PyObject *cls, PyObject *dummy)
2268{
2269 PyObject *time;
2270 PyObject *result;
2271
2272 time = time_time();
2273 if (time == NULL)
2274 return NULL;
2275
2276 /* Note well: today() is a class method, so this may not call
2277 * date.fromtimestamp. For example, it may call
2278 * datetime.fromtimestamp. That's why we need all the accuracy
2279 * time.time() delivers; if someone were gonzo about optimization,
2280 * date.today() could get away with plain C time().
2281 */
2282 result = PyObject_CallMethod(cls, "fromtimestamp", "O", time);
2283 Py_DECREF(time);
2284 return result;
2285}
2286
2287/* Return new date from given timestamp (Python timestamp -- a double). */
2288static PyObject *
2289date_fromtimestamp(PyObject *cls, PyObject *args)
2290{
2291 double timestamp;
2292 PyObject *result = NULL;
2293
2294 if (PyArg_ParseTuple(args, "d:fromtimestamp", &timestamp))
Tim Peters1b6f7a92004-06-20 02:50:16 +00002295 result = date_local_from_time_t(cls, timestamp);
Tim Peters2a799bf2002-12-16 20:18:38 +00002296 return result;
2297}
2298
2299/* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2300 * the ordinal is out of range.
2301 */
2302static PyObject *
2303date_fromordinal(PyObject *cls, PyObject *args)
2304{
2305 PyObject *result = NULL;
2306 int ordinal;
2307
2308 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2309 int year;
2310 int month;
2311 int day;
2312
2313 if (ordinal < 1)
2314 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2315 ">= 1");
2316 else {
2317 ord_to_ymd(ordinal, &year, &month, &day);
2318 result = PyObject_CallFunction(cls, "iii",
2319 year, month, day);
2320 }
2321 }
2322 return result;
2323}
2324
2325/*
2326 * Date arithmetic.
2327 */
2328
2329/* date + timedelta -> date. If arg negate is true, subtract the timedelta
2330 * instead.
2331 */
2332static PyObject *
2333add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
2334{
2335 PyObject *result = NULL;
2336 int year = GET_YEAR(date);
2337 int month = GET_MONTH(date);
2338 int deltadays = GET_TD_DAYS(delta);
2339 /* C-level overflow is impossible because |deltadays| < 1e9. */
2340 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
2341
2342 if (normalize_date(&year, &month, &day) >= 0)
2343 result = new_date(year, month, day);
2344 return result;
2345}
2346
2347static PyObject *
2348date_add(PyObject *left, PyObject *right)
2349{
2350 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2351 Py_INCREF(Py_NotImplemented);
2352 return Py_NotImplemented;
2353 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002354 if (PyDate_Check(left)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002355 /* date + ??? */
2356 if (PyDelta_Check(right))
2357 /* date + delta */
2358 return add_date_timedelta((PyDateTime_Date *) left,
2359 (PyDateTime_Delta *) right,
2360 0);
2361 }
2362 else {
2363 /* ??? + date
2364 * 'right' must be one of us, or we wouldn't have been called
2365 */
2366 if (PyDelta_Check(left))
2367 /* delta + date */
2368 return add_date_timedelta((PyDateTime_Date *) right,
2369 (PyDateTime_Delta *) left,
2370 0);
2371 }
2372 Py_INCREF(Py_NotImplemented);
2373 return Py_NotImplemented;
2374}
2375
2376static PyObject *
2377date_subtract(PyObject *left, PyObject *right)
2378{
2379 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2380 Py_INCREF(Py_NotImplemented);
2381 return Py_NotImplemented;
2382 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002383 if (PyDate_Check(left)) {
2384 if (PyDate_Check(right)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002385 /* date - date */
2386 int left_ord = ymd_to_ord(GET_YEAR(left),
2387 GET_MONTH(left),
2388 GET_DAY(left));
2389 int right_ord = ymd_to_ord(GET_YEAR(right),
2390 GET_MONTH(right),
2391 GET_DAY(right));
2392 return new_delta(left_ord - right_ord, 0, 0, 0);
2393 }
2394 if (PyDelta_Check(right)) {
2395 /* date - delta */
2396 return add_date_timedelta((PyDateTime_Date *) left,
2397 (PyDateTime_Delta *) right,
2398 1);
2399 }
2400 }
2401 Py_INCREF(Py_NotImplemented);
2402 return Py_NotImplemented;
2403}
2404
2405
2406/* Various ways to turn a date into a string. */
2407
2408static PyObject *
2409date_repr(PyDateTime_Date *self)
2410{
2411 char buffer[1028];
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002412 const char *type_name;
Tim Peters2a799bf2002-12-16 20:18:38 +00002413
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002414 type_name = self->ob_type->tp_name;
Tim Peters2a799bf2002-12-16 20:18:38 +00002415 PyOS_snprintf(buffer, sizeof(buffer), "%s(%d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002416 type_name,
Tim Peters2a799bf2002-12-16 20:18:38 +00002417 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2418
2419 return PyString_FromString(buffer);
2420}
2421
2422static PyObject *
2423date_isoformat(PyDateTime_Date *self)
2424{
2425 char buffer[128];
2426
2427 isoformat_date(self, buffer, sizeof(buffer));
2428 return PyString_FromString(buffer);
2429}
2430
Tim Peterse2df5ff2003-05-02 18:39:55 +00002431/* str() calls the appropriate isoformat() method. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002432static PyObject *
2433date_str(PyDateTime_Date *self)
2434{
2435 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
2436}
2437
2438
2439static PyObject *
2440date_ctime(PyDateTime_Date *self)
2441{
2442 return format_ctime(self, 0, 0, 0);
2443}
2444
2445static PyObject *
2446date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2447{
2448 /* This method can be inherited, and needs to call the
2449 * timetuple() method appropriate to self's class.
2450 */
2451 PyObject *result;
2452 PyObject *format;
2453 PyObject *tuple;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002454 static char *keywords[] = {"format", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00002455
2456 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
2457 &PyString_Type, &format))
2458 return NULL;
2459
2460 tuple = PyObject_CallMethod((PyObject *)self, "timetuple", "()");
2461 if (tuple == NULL)
2462 return NULL;
Tim Petersbad8ff02002-12-30 20:52:32 +00002463 result = wrap_strftime((PyObject *)self, format, tuple,
2464 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002465 Py_DECREF(tuple);
2466 return result;
2467}
2468
2469/* ISO methods. */
2470
2471static PyObject *
2472date_isoweekday(PyDateTime_Date *self)
2473{
2474 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2475
2476 return PyInt_FromLong(dow + 1);
2477}
2478
2479static PyObject *
2480date_isocalendar(PyDateTime_Date *self)
2481{
2482 int year = GET_YEAR(self);
2483 int week1_monday = iso_week1_monday(year);
2484 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
2485 int week;
2486 int day;
2487
2488 week = divmod(today - week1_monday, 7, &day);
2489 if (week < 0) {
2490 --year;
2491 week1_monday = iso_week1_monday(year);
2492 week = divmod(today - week1_monday, 7, &day);
2493 }
2494 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
2495 ++year;
2496 week = 0;
2497 }
2498 return Py_BuildValue("iii", year, week + 1, day + 1);
2499}
2500
2501/* Miscellaneous methods. */
2502
2503/* This is more natural as a tp_compare, but doesn't work then: for whatever
2504 * reason, Python's try_3way_compare ignores tp_compare unless
2505 * PyInstance_Check returns true, but these aren't old-style classes.
2506 */
2507static PyObject *
2508date_richcompare(PyDateTime_Date *self, PyObject *other, int op)
2509{
Tim Peters07534a62003-02-07 22:50:28 +00002510 int diff = 42; /* nonsense */
Tim Peters2a799bf2002-12-16 20:18:38 +00002511
Tim Peters07534a62003-02-07 22:50:28 +00002512 if (PyDate_Check(other))
2513 diff = memcmp(self->data, ((PyDateTime_Date *)other)->data,
2514 _PyDateTime_DATE_DATASIZE);
2515
2516 else if (PyObject_HasAttrString(other, "timetuple")) {
2517 /* A hook for other kinds of date objects. */
2518 Py_INCREF(Py_NotImplemented);
2519 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002520 }
Tim Peters07534a62003-02-07 22:50:28 +00002521 else if (op == Py_EQ || op == Py_NE)
2522 diff = 1; /* any non-zero value will do */
2523
2524 else /* stop this from falling back to address comparison */
2525 return cmperror((PyObject *)self, other);
2526
Tim Peters2a799bf2002-12-16 20:18:38 +00002527 return diff_to_bool(diff, op);
2528}
2529
2530static PyObject *
2531date_timetuple(PyDateTime_Date *self)
2532{
2533 return build_struct_time(GET_YEAR(self),
2534 GET_MONTH(self),
2535 GET_DAY(self),
2536 0, 0, 0, -1);
2537}
2538
Tim Peters12bf3392002-12-24 05:41:27 +00002539static PyObject *
2540date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2541{
2542 PyObject *clone;
2543 PyObject *tuple;
2544 int year = GET_YEAR(self);
2545 int month = GET_MONTH(self);
2546 int day = GET_DAY(self);
2547
2548 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
2549 &year, &month, &day))
2550 return NULL;
2551 tuple = Py_BuildValue("iii", year, month, day);
2552 if (tuple == NULL)
2553 return NULL;
2554 clone = date_new(self->ob_type, tuple, NULL);
2555 Py_DECREF(tuple);
2556 return clone;
2557}
2558
Tim Peters2a799bf2002-12-16 20:18:38 +00002559static PyObject *date_getstate(PyDateTime_Date *self);
2560
2561static long
2562date_hash(PyDateTime_Date *self)
2563{
2564 if (self->hashcode == -1) {
2565 PyObject *temp = date_getstate(self);
2566 if (temp != NULL) {
2567 self->hashcode = PyObject_Hash(temp);
2568 Py_DECREF(temp);
2569 }
2570 }
2571 return self->hashcode;
2572}
2573
2574static PyObject *
2575date_toordinal(PyDateTime_Date *self)
2576{
2577 return PyInt_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
2578 GET_DAY(self)));
2579}
2580
2581static PyObject *
2582date_weekday(PyDateTime_Date *self)
2583{
2584 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2585
2586 return PyInt_FromLong(dow);
2587}
2588
Tim Peters371935f2003-02-01 01:52:50 +00002589/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002590
Tim Petersb57f8f02003-02-01 02:54:15 +00002591/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002592static PyObject *
2593date_getstate(PyDateTime_Date *self)
2594{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002595 return Py_BuildValue(
2596 "(N)",
2597 PyString_FromStringAndSize((char *)self->data,
2598 _PyDateTime_DATE_DATASIZE));
Tim Peters2a799bf2002-12-16 20:18:38 +00002599}
2600
2601static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00002602date_reduce(PyDateTime_Date *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00002603{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002604 return Py_BuildValue("(ON)", self->ob_type, date_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002605}
2606
2607static PyMethodDef date_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002608
Tim Peters2a799bf2002-12-16 20:18:38 +00002609 /* Class methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00002610
Tim Peters2a799bf2002-12-16 20:18:38 +00002611 {"fromtimestamp", (PyCFunction)date_fromtimestamp, METH_VARARGS |
2612 METH_CLASS,
2613 PyDoc_STR("timestamp -> local date from a POSIX timestamp (like "
2614 "time.time()).")},
2615
2616 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
2617 METH_CLASS,
2618 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
2619 "ordinal.")},
2620
2621 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
2622 PyDoc_STR("Current date or datetime: same as "
2623 "self.__class__.fromtimestamp(time.time()).")},
2624
2625 /* Instance methods: */
2626
2627 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
2628 PyDoc_STR("Return ctime() style string.")},
2629
2630 {"strftime", (PyCFunction)date_strftime, METH_KEYWORDS,
2631 PyDoc_STR("format -> strftime() style string.")},
2632
2633 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
2634 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
2635
2636 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
2637 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
2638 "weekday.")},
2639
2640 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
2641 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
2642
2643 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
2644 PyDoc_STR("Return the day of the week represented by the date.\n"
2645 "Monday == 1 ... Sunday == 7")},
2646
2647 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
2648 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
2649 "1 is day 1.")},
2650
2651 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
2652 PyDoc_STR("Return the day of the week represented by the date.\n"
2653 "Monday == 0 ... Sunday == 6")},
2654
Tim Peters12bf3392002-12-24 05:41:27 +00002655 {"replace", (PyCFunction)date_replace, METH_KEYWORDS,
2656 PyDoc_STR("Return date with new specified fields.")},
2657
Guido van Rossum177e41a2003-01-30 22:06:23 +00002658 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
2659 PyDoc_STR("__reduce__() -> (cls, state)")},
2660
Tim Peters2a799bf2002-12-16 20:18:38 +00002661 {NULL, NULL}
2662};
2663
2664static char date_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00002665PyDoc_STR("date(year, month, day) --> date object");
Tim Peters2a799bf2002-12-16 20:18:38 +00002666
2667static PyNumberMethods date_as_number = {
2668 date_add, /* nb_add */
2669 date_subtract, /* nb_subtract */
2670 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00002671 0, /* nb_remainder */
2672 0, /* nb_divmod */
2673 0, /* nb_power */
2674 0, /* nb_negative */
2675 0, /* nb_positive */
2676 0, /* nb_absolute */
2677 0, /* nb_nonzero */
2678};
2679
2680static PyTypeObject PyDateTime_DateType = {
2681 PyObject_HEAD_INIT(NULL)
2682 0, /* ob_size */
2683 "datetime.date", /* tp_name */
2684 sizeof(PyDateTime_Date), /* tp_basicsize */
2685 0, /* tp_itemsize */
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002686 0, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00002687 0, /* tp_print */
2688 0, /* tp_getattr */
2689 0, /* tp_setattr */
2690 0, /* tp_compare */
2691 (reprfunc)date_repr, /* tp_repr */
2692 &date_as_number, /* tp_as_number */
2693 0, /* tp_as_sequence */
2694 0, /* tp_as_mapping */
2695 (hashfunc)date_hash, /* tp_hash */
2696 0, /* tp_call */
2697 (reprfunc)date_str, /* tp_str */
2698 PyObject_GenericGetAttr, /* tp_getattro */
2699 0, /* tp_setattro */
2700 0, /* tp_as_buffer */
2701 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2702 Py_TPFLAGS_BASETYPE, /* tp_flags */
2703 date_doc, /* tp_doc */
2704 0, /* tp_traverse */
2705 0, /* tp_clear */
2706 (richcmpfunc)date_richcompare, /* tp_richcompare */
2707 0, /* tp_weaklistoffset */
2708 0, /* tp_iter */
2709 0, /* tp_iternext */
2710 date_methods, /* tp_methods */
2711 0, /* tp_members */
2712 date_getset, /* tp_getset */
2713 0, /* tp_base */
2714 0, /* tp_dict */
2715 0, /* tp_descr_get */
2716 0, /* tp_descr_set */
2717 0, /* tp_dictoffset */
2718 0, /* tp_init */
2719 0, /* tp_alloc */
2720 date_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002721 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002722};
2723
2724/*
Tim Peters2a799bf2002-12-16 20:18:38 +00002725 * PyDateTime_TZInfo implementation.
2726 */
2727
2728/* This is a pure abstract base class, so doesn't do anything beyond
2729 * raising NotImplemented exceptions. Real tzinfo classes need
2730 * to derive from this. This is mostly for clarity, and for efficiency in
Tim Petersa9bc1682003-01-11 03:39:11 +00002731 * datetime and time constructors (their tzinfo arguments need to
Tim Peters2a799bf2002-12-16 20:18:38 +00002732 * be subclasses of this tzinfo class, which is easy and quick to check).
2733 *
2734 * Note: For reasons having to do with pickling of subclasses, we have
2735 * to allow tzinfo objects to be instantiated. This wasn't an issue
2736 * in the Python implementation (__init__() could raise NotImplementedError
2737 * there without ill effect), but doing so in the C implementation hit a
2738 * brick wall.
2739 */
2740
2741static PyObject *
2742tzinfo_nogo(const char* methodname)
2743{
2744 PyErr_Format(PyExc_NotImplementedError,
2745 "a tzinfo subclass must implement %s()",
2746 methodname);
2747 return NULL;
2748}
2749
2750/* Methods. A subclass must implement these. */
2751
Tim Peters52dcce22003-01-23 16:36:11 +00002752static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002753tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
2754{
2755 return tzinfo_nogo("tzname");
2756}
2757
Tim Peters52dcce22003-01-23 16:36:11 +00002758static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002759tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
2760{
2761 return tzinfo_nogo("utcoffset");
2762}
2763
Tim Peters52dcce22003-01-23 16:36:11 +00002764static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002765tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
2766{
2767 return tzinfo_nogo("dst");
2768}
2769
Tim Peters52dcce22003-01-23 16:36:11 +00002770static PyObject *
2771tzinfo_fromutc(PyDateTime_TZInfo *self, PyDateTime_DateTime *dt)
2772{
2773 int y, m, d, hh, mm, ss, us;
2774
2775 PyObject *result;
2776 int off, dst;
2777 int none;
2778 int delta;
2779
2780 if (! PyDateTime_Check(dt)) {
2781 PyErr_SetString(PyExc_TypeError,
2782 "fromutc: argument must be a datetime");
2783 return NULL;
2784 }
2785 if (! HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
2786 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
2787 "is not self");
2788 return NULL;
2789 }
2790
2791 off = call_utcoffset(dt->tzinfo, (PyObject *)dt, &none);
2792 if (off == -1 && PyErr_Occurred())
2793 return NULL;
2794 if (none) {
2795 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2796 "utcoffset() result required");
2797 return NULL;
2798 }
2799
2800 dst = call_dst(dt->tzinfo, (PyObject *)dt, &none);
2801 if (dst == -1 && PyErr_Occurred())
2802 return NULL;
2803 if (none) {
2804 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2805 "dst() result required");
2806 return NULL;
2807 }
2808
2809 y = GET_YEAR(dt);
2810 m = GET_MONTH(dt);
2811 d = GET_DAY(dt);
2812 hh = DATE_GET_HOUR(dt);
2813 mm = DATE_GET_MINUTE(dt);
2814 ss = DATE_GET_SECOND(dt);
2815 us = DATE_GET_MICROSECOND(dt);
2816
2817 delta = off - dst;
2818 mm += delta;
2819 if ((mm < 0 || mm >= 60) &&
2820 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Petersb1049e82003-01-23 17:20:36 +00002821 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00002822 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2823 if (result == NULL)
2824 return result;
2825
2826 dst = call_dst(dt->tzinfo, result, &none);
2827 if (dst == -1 && PyErr_Occurred())
2828 goto Fail;
2829 if (none)
2830 goto Inconsistent;
2831 if (dst == 0)
2832 return result;
2833
2834 mm += dst;
2835 if ((mm < 0 || mm >= 60) &&
2836 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
2837 goto Fail;
2838 Py_DECREF(result);
2839 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2840 return result;
2841
2842Inconsistent:
2843 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave"
2844 "inconsistent results; cannot convert");
2845
2846 /* fall thru to failure */
2847Fail:
2848 Py_DECREF(result);
2849 return NULL;
2850}
2851
Tim Peters2a799bf2002-12-16 20:18:38 +00002852/*
2853 * Pickle support. This is solely so that tzinfo subclasses can use
Guido van Rossum177e41a2003-01-30 22:06:23 +00002854 * pickling -- tzinfo itself is supposed to be uninstantiable.
Tim Peters2a799bf2002-12-16 20:18:38 +00002855 */
2856
Guido van Rossum177e41a2003-01-30 22:06:23 +00002857static PyObject *
2858tzinfo_reduce(PyObject *self)
2859{
2860 PyObject *args, *state, *tmp;
2861 PyObject *getinitargs, *getstate;
Tim Peters2a799bf2002-12-16 20:18:38 +00002862
Guido van Rossum177e41a2003-01-30 22:06:23 +00002863 tmp = PyTuple_New(0);
2864 if (tmp == NULL)
2865 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002866
Guido van Rossum177e41a2003-01-30 22:06:23 +00002867 getinitargs = PyObject_GetAttrString(self, "__getinitargs__");
2868 if (getinitargs != NULL) {
2869 args = PyObject_CallObject(getinitargs, tmp);
2870 Py_DECREF(getinitargs);
2871 if (args == NULL) {
2872 Py_DECREF(tmp);
2873 return NULL;
2874 }
2875 }
2876 else {
2877 PyErr_Clear();
2878 args = tmp;
2879 Py_INCREF(args);
2880 }
2881
2882 getstate = PyObject_GetAttrString(self, "__getstate__");
2883 if (getstate != NULL) {
2884 state = PyObject_CallObject(getstate, tmp);
2885 Py_DECREF(getstate);
2886 if (state == NULL) {
2887 Py_DECREF(args);
2888 Py_DECREF(tmp);
2889 return NULL;
2890 }
2891 }
2892 else {
2893 PyObject **dictptr;
2894 PyErr_Clear();
2895 state = Py_None;
2896 dictptr = _PyObject_GetDictPtr(self);
2897 if (dictptr && *dictptr && PyDict_Size(*dictptr))
2898 state = *dictptr;
2899 Py_INCREF(state);
2900 }
2901
2902 Py_DECREF(tmp);
2903
2904 if (state == Py_None) {
2905 Py_DECREF(state);
2906 return Py_BuildValue("(ON)", self->ob_type, args);
2907 }
2908 else
2909 return Py_BuildValue("(ONN)", self->ob_type, args, state);
2910}
Tim Peters2a799bf2002-12-16 20:18:38 +00002911
2912static PyMethodDef tzinfo_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002913
Tim Peters2a799bf2002-12-16 20:18:38 +00002914 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
2915 PyDoc_STR("datetime -> string name of time zone.")},
2916
2917 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
2918 PyDoc_STR("datetime -> minutes east of UTC (negative for "
2919 "west of UTC).")},
2920
2921 {"dst", (PyCFunction)tzinfo_dst, METH_O,
2922 PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
2923
Tim Peters52dcce22003-01-23 16:36:11 +00002924 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
2925 PyDoc_STR("datetime in UTC -> datetime in local time.")},
2926
Guido van Rossum177e41a2003-01-30 22:06:23 +00002927 {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
2928 PyDoc_STR("-> (cls, state)")},
2929
Tim Peters2a799bf2002-12-16 20:18:38 +00002930 {NULL, NULL}
2931};
2932
2933static char tzinfo_doc[] =
2934PyDoc_STR("Abstract base class for time zone info objects.");
2935
Neal Norwitz227b5332006-03-22 09:28:35 +00002936static PyTypeObject PyDateTime_TZInfoType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00002937 PyObject_HEAD_INIT(NULL)
2938 0, /* ob_size */
2939 "datetime.tzinfo", /* tp_name */
2940 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
2941 0, /* tp_itemsize */
2942 0, /* tp_dealloc */
2943 0, /* tp_print */
2944 0, /* tp_getattr */
2945 0, /* tp_setattr */
2946 0, /* tp_compare */
2947 0, /* tp_repr */
2948 0, /* tp_as_number */
2949 0, /* tp_as_sequence */
2950 0, /* tp_as_mapping */
2951 0, /* tp_hash */
2952 0, /* tp_call */
2953 0, /* tp_str */
2954 PyObject_GenericGetAttr, /* tp_getattro */
2955 0, /* tp_setattro */
2956 0, /* tp_as_buffer */
2957 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2958 Py_TPFLAGS_BASETYPE, /* tp_flags */
2959 tzinfo_doc, /* tp_doc */
2960 0, /* tp_traverse */
2961 0, /* tp_clear */
2962 0, /* tp_richcompare */
2963 0, /* tp_weaklistoffset */
2964 0, /* tp_iter */
2965 0, /* tp_iternext */
2966 tzinfo_methods, /* tp_methods */
2967 0, /* tp_members */
2968 0, /* tp_getset */
2969 0, /* tp_base */
2970 0, /* tp_dict */
2971 0, /* tp_descr_get */
2972 0, /* tp_descr_set */
2973 0, /* tp_dictoffset */
2974 0, /* tp_init */
2975 0, /* tp_alloc */
2976 PyType_GenericNew, /* tp_new */
2977 0, /* tp_free */
2978};
2979
2980/*
Tim Peters37f39822003-01-10 03:49:02 +00002981 * PyDateTime_Time implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00002982 */
2983
Tim Peters37f39822003-01-10 03:49:02 +00002984/* Accessor properties.
Tim Peters2a799bf2002-12-16 20:18:38 +00002985 */
2986
2987static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00002988time_hour(PyDateTime_Time *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00002989{
Tim Peters37f39822003-01-10 03:49:02 +00002990 return PyInt_FromLong(TIME_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002991}
2992
Tim Peters37f39822003-01-10 03:49:02 +00002993static PyObject *
2994time_minute(PyDateTime_Time *self, void *unused)
2995{
2996 return PyInt_FromLong(TIME_GET_MINUTE(self));
2997}
2998
2999/* The name time_second conflicted with some platform header file. */
3000static PyObject *
3001py_time_second(PyDateTime_Time *self, void *unused)
3002{
3003 return PyInt_FromLong(TIME_GET_SECOND(self));
3004}
3005
3006static PyObject *
3007time_microsecond(PyDateTime_Time *self, void *unused)
3008{
3009 return PyInt_FromLong(TIME_GET_MICROSECOND(self));
3010}
3011
3012static PyObject *
3013time_tzinfo(PyDateTime_Time *self, void *unused)
3014{
Tim Petersa032d2e2003-01-11 00:15:54 +00003015 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters37f39822003-01-10 03:49:02 +00003016 Py_INCREF(result);
3017 return result;
3018}
3019
3020static PyGetSetDef time_getset[] = {
3021 {"hour", (getter)time_hour},
3022 {"minute", (getter)time_minute},
3023 {"second", (getter)py_time_second},
3024 {"microsecond", (getter)time_microsecond},
3025 {"tzinfo", (getter)time_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003026 {NULL}
3027};
3028
3029/*
3030 * Constructors.
3031 */
3032
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003033static char *time_kws[] = {"hour", "minute", "second", "microsecond",
Tim Peters37f39822003-01-10 03:49:02 +00003034 "tzinfo", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00003035
Tim Peters2a799bf2002-12-16 20:18:38 +00003036static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003037time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003038{
3039 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003040 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003041 int hour = 0;
3042 int minute = 0;
3043 int second = 0;
3044 int usecond = 0;
3045 PyObject *tzinfo = Py_None;
3046
Guido van Rossum177e41a2003-01-30 22:06:23 +00003047 /* Check for invocation from pickle with __getstate__ state */
3048 if (PyTuple_GET_SIZE(args) >= 1 &&
3049 PyTuple_GET_SIZE(args) <= 2 &&
Tim Peters70533e22003-02-01 04:40:04 +00003050 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Armin Rigof4afb212005-11-07 07:15:48 +00003051 PyString_GET_SIZE(state) == _PyDateTime_TIME_DATASIZE &&
3052 ((unsigned char) (PyString_AS_STRING(state)[0])) < 24)
Guido van Rossum177e41a2003-01-30 22:06:23 +00003053 {
Tim Peters70533e22003-02-01 04:40:04 +00003054 PyDateTime_Time *me;
3055 char aware;
3056
3057 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003058 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003059 if (check_tzinfo_subclass(tzinfo) < 0) {
3060 PyErr_SetString(PyExc_TypeError, "bad "
3061 "tzinfo state arg");
3062 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003063 }
3064 }
Tim Peters70533e22003-02-01 04:40:04 +00003065 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003066 me = (PyDateTime_Time *) (type->tp_alloc(type, aware));
Tim Peters70533e22003-02-01 04:40:04 +00003067 if (me != NULL) {
3068 char *pdata = PyString_AS_STRING(state);
3069
3070 memcpy(me->data, pdata, _PyDateTime_TIME_DATASIZE);
3071 me->hashcode = -1;
3072 me->hastzinfo = aware;
3073 if (aware) {
3074 Py_INCREF(tzinfo);
3075 me->tzinfo = tzinfo;
3076 }
3077 }
3078 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003079 }
3080
Tim Peters37f39822003-01-10 03:49:02 +00003081 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO", time_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003082 &hour, &minute, &second, &usecond,
3083 &tzinfo)) {
3084 if (check_time_args(hour, minute, second, usecond) < 0)
3085 return NULL;
3086 if (check_tzinfo_subclass(tzinfo) < 0)
3087 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003088 self = new_time_ex(hour, minute, second, usecond, tzinfo,
3089 type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003090 }
3091 return self;
3092}
3093
3094/*
3095 * Destructor.
3096 */
3097
3098static void
Tim Peters37f39822003-01-10 03:49:02 +00003099time_dealloc(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003100{
Tim Petersa032d2e2003-01-11 00:15:54 +00003101 if (HASTZINFO(self)) {
Tim Peters37f39822003-01-10 03:49:02 +00003102 Py_XDECREF(self->tzinfo);
Neal Norwitz8e914d92003-01-10 15:29:16 +00003103 }
Tim Peters2a799bf2002-12-16 20:18:38 +00003104 self->ob_type->tp_free((PyObject *)self);
3105}
3106
3107/*
Tim Peters855fe882002-12-22 03:43:39 +00003108 * Indirect access to tzinfo methods.
Tim Peters2a799bf2002-12-16 20:18:38 +00003109 */
3110
Tim Peters2a799bf2002-12-16 20:18:38 +00003111/* These are all METH_NOARGS, so don't need to check the arglist. */
3112static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003113time_utcoffset(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003114 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003115 "utcoffset", Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003116}
3117
3118static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003119time_dst(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003120 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003121 "dst", Py_None);
Tim Peters855fe882002-12-22 03:43:39 +00003122}
3123
3124static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003125time_tzname(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003126 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003127 Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003128}
3129
3130/*
Tim Peters37f39822003-01-10 03:49:02 +00003131 * Various ways to turn a time into a string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003132 */
3133
3134static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003135time_repr(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003136{
Tim Peters37f39822003-01-10 03:49:02 +00003137 char buffer[100];
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003138 const char *type_name = self->ob_type->tp_name;
Tim Peters37f39822003-01-10 03:49:02 +00003139 int h = TIME_GET_HOUR(self);
3140 int m = TIME_GET_MINUTE(self);
3141 int s = TIME_GET_SECOND(self);
3142 int us = TIME_GET_MICROSECOND(self);
3143 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003144
Tim Peters37f39822003-01-10 03:49:02 +00003145 if (us)
3146 PyOS_snprintf(buffer, sizeof(buffer),
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003147 "%s(%d, %d, %d, %d)", type_name, h, m, s, us);
Tim Peters37f39822003-01-10 03:49:02 +00003148 else if (s)
3149 PyOS_snprintf(buffer, sizeof(buffer),
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003150 "%s(%d, %d, %d)", type_name, h, m, s);
Tim Peters37f39822003-01-10 03:49:02 +00003151 else
3152 PyOS_snprintf(buffer, sizeof(buffer),
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003153 "%s(%d, %d)", type_name, h, m);
Tim Peters37f39822003-01-10 03:49:02 +00003154 result = PyString_FromString(buffer);
Tim Petersa032d2e2003-01-11 00:15:54 +00003155 if (result != NULL && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +00003156 result = append_keyword_tzinfo(result, self->tzinfo);
3157 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003158}
3159
Tim Peters37f39822003-01-10 03:49:02 +00003160static PyObject *
3161time_str(PyDateTime_Time *self)
3162{
3163 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
3164}
Tim Peters2a799bf2002-12-16 20:18:38 +00003165
3166static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003167time_isoformat(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003168{
3169 char buf[100];
Tim Peters37f39822003-01-10 03:49:02 +00003170 PyObject *result;
3171 /* Reuse the time format code from the datetime type. */
3172 PyDateTime_DateTime datetime;
3173 PyDateTime_DateTime *pdatetime = &datetime;
Tim Peters2a799bf2002-12-16 20:18:38 +00003174
Tim Peters37f39822003-01-10 03:49:02 +00003175 /* Copy over just the time bytes. */
3176 memcpy(pdatetime->data + _PyDateTime_DATE_DATASIZE,
3177 self->data,
3178 _PyDateTime_TIME_DATASIZE);
3179
3180 isoformat_time(pdatetime, buf, sizeof(buf));
3181 result = PyString_FromString(buf);
Tim Petersa032d2e2003-01-11 00:15:54 +00003182 if (result == NULL || ! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00003183 return result;
3184
3185 /* We need to append the UTC offset. */
3186 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00003187 Py_None) < 0) {
Tim Peters2a799bf2002-12-16 20:18:38 +00003188 Py_DECREF(result);
3189 return NULL;
3190 }
3191 PyString_ConcatAndDel(&result, PyString_FromString(buf));
3192 return result;
3193}
3194
Tim Peters37f39822003-01-10 03:49:02 +00003195static PyObject *
3196time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3197{
3198 PyObject *result;
3199 PyObject *format;
3200 PyObject *tuple;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003201 static char *keywords[] = {"format", NULL};
Tim Peters37f39822003-01-10 03:49:02 +00003202
3203 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
3204 &PyString_Type, &format))
3205 return NULL;
3206
3207 /* Python's strftime does insane things with the year part of the
3208 * timetuple. The year is forced to (the otherwise nonsensical)
3209 * 1900 to worm around that.
3210 */
3211 tuple = Py_BuildValue("iiiiiiiii",
Brett Cannond1080a32004-03-02 04:38:10 +00003212 1900, 1, 1, /* year, month, day */
Tim Peters37f39822003-01-10 03:49:02 +00003213 TIME_GET_HOUR(self),
3214 TIME_GET_MINUTE(self),
3215 TIME_GET_SECOND(self),
Brett Cannond1080a32004-03-02 04:38:10 +00003216 0, 1, -1); /* weekday, daynum, dst */
Tim Peters37f39822003-01-10 03:49:02 +00003217 if (tuple == NULL)
3218 return NULL;
3219 assert(PyTuple_Size(tuple) == 9);
3220 result = wrap_strftime((PyObject *)self, format, tuple, Py_None);
3221 Py_DECREF(tuple);
3222 return result;
3223}
Tim Peters2a799bf2002-12-16 20:18:38 +00003224
3225/*
3226 * Miscellaneous methods.
3227 */
3228
Tim Peters37f39822003-01-10 03:49:02 +00003229/* This is more natural as a tp_compare, but doesn't work then: for whatever
3230 * reason, Python's try_3way_compare ignores tp_compare unless
3231 * PyInstance_Check returns true, but these aren't old-style classes.
3232 */
3233static PyObject *
3234time_richcompare(PyDateTime_Time *self, PyObject *other, int op)
3235{
3236 int diff;
3237 naivety n1, n2;
3238 int offset1, offset2;
3239
3240 if (! PyTime_Check(other)) {
Tim Peters07534a62003-02-07 22:50:28 +00003241 if (op == Py_EQ || op == Py_NE) {
3242 PyObject *result = op == Py_EQ ? Py_False : Py_True;
3243 Py_INCREF(result);
3244 return result;
3245 }
Tim Peters37f39822003-01-10 03:49:02 +00003246 /* Stop this from falling back to address comparison. */
Tim Peters07534a62003-02-07 22:50:28 +00003247 return cmperror((PyObject *)self, other);
Tim Peters37f39822003-01-10 03:49:02 +00003248 }
3249 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1, Py_None,
3250 other, &offset2, &n2, Py_None) < 0)
3251 return NULL;
3252 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
3253 /* If they're both naive, or both aware and have the same offsets,
3254 * we get off cheap. Note that if they're both naive, offset1 ==
3255 * offset2 == 0 at this point.
3256 */
3257 if (n1 == n2 && offset1 == offset2) {
3258 diff = memcmp(self->data, ((PyDateTime_Time *)other)->data,
3259 _PyDateTime_TIME_DATASIZE);
3260 return diff_to_bool(diff, op);
3261 }
3262
3263 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
3264 assert(offset1 != offset2); /* else last "if" handled it */
3265 /* Convert everything except microseconds to seconds. These
3266 * can't overflow (no more than the # of seconds in 2 days).
3267 */
3268 offset1 = TIME_GET_HOUR(self) * 3600 +
3269 (TIME_GET_MINUTE(self) - offset1) * 60 +
3270 TIME_GET_SECOND(self);
3271 offset2 = TIME_GET_HOUR(other) * 3600 +
3272 (TIME_GET_MINUTE(other) - offset2) * 60 +
3273 TIME_GET_SECOND(other);
3274 diff = offset1 - offset2;
3275 if (diff == 0)
3276 diff = TIME_GET_MICROSECOND(self) -
3277 TIME_GET_MICROSECOND(other);
3278 return diff_to_bool(diff, op);
3279 }
3280
3281 assert(n1 != n2);
3282 PyErr_SetString(PyExc_TypeError,
3283 "can't compare offset-naive and "
3284 "offset-aware times");
3285 return NULL;
3286}
3287
3288static long
3289time_hash(PyDateTime_Time *self)
3290{
3291 if (self->hashcode == -1) {
3292 naivety n;
3293 int offset;
3294 PyObject *temp;
3295
3296 n = classify_utcoffset((PyObject *)self, Py_None, &offset);
3297 assert(n != OFFSET_UNKNOWN);
3298 if (n == OFFSET_ERROR)
3299 return -1;
3300
3301 /* Reduce this to a hash of another object. */
3302 if (offset == 0)
3303 temp = PyString_FromStringAndSize((char *)self->data,
3304 _PyDateTime_TIME_DATASIZE);
3305 else {
3306 int hour;
3307 int minute;
3308
3309 assert(n == OFFSET_AWARE);
Tim Petersa032d2e2003-01-11 00:15:54 +00003310 assert(HASTZINFO(self));
Tim Peters37f39822003-01-10 03:49:02 +00003311 hour = divmod(TIME_GET_HOUR(self) * 60 +
3312 TIME_GET_MINUTE(self) - offset,
3313 60,
3314 &minute);
3315 if (0 <= hour && hour < 24)
3316 temp = new_time(hour, minute,
3317 TIME_GET_SECOND(self),
3318 TIME_GET_MICROSECOND(self),
3319 Py_None);
3320 else
3321 temp = Py_BuildValue("iiii",
3322 hour, minute,
3323 TIME_GET_SECOND(self),
3324 TIME_GET_MICROSECOND(self));
3325 }
3326 if (temp != NULL) {
3327 self->hashcode = PyObject_Hash(temp);
3328 Py_DECREF(temp);
3329 }
3330 }
3331 return self->hashcode;
3332}
Tim Peters2a799bf2002-12-16 20:18:38 +00003333
Tim Peters12bf3392002-12-24 05:41:27 +00003334static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003335time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00003336{
3337 PyObject *clone;
3338 PyObject *tuple;
3339 int hh = TIME_GET_HOUR(self);
3340 int mm = TIME_GET_MINUTE(self);
3341 int ss = TIME_GET_SECOND(self);
3342 int us = TIME_GET_MICROSECOND(self);
Tim Petersa032d2e2003-01-11 00:15:54 +00003343 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00003344
3345 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO:replace",
Tim Peters37f39822003-01-10 03:49:02 +00003346 time_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00003347 &hh, &mm, &ss, &us, &tzinfo))
3348 return NULL;
3349 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
3350 if (tuple == NULL)
3351 return NULL;
Tim Peters37f39822003-01-10 03:49:02 +00003352 clone = time_new(self->ob_type, tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00003353 Py_DECREF(tuple);
3354 return clone;
3355}
3356
Tim Peters2a799bf2002-12-16 20:18:38 +00003357static int
Tim Peters37f39822003-01-10 03:49:02 +00003358time_nonzero(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003359{
3360 int offset;
3361 int none;
3362
3363 if (TIME_GET_SECOND(self) || TIME_GET_MICROSECOND(self)) {
3364 /* Since utcoffset is in whole minutes, nothing can
3365 * alter the conclusion that this is nonzero.
3366 */
3367 return 1;
3368 }
3369 offset = 0;
Tim Petersa032d2e2003-01-11 00:15:54 +00003370 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Petersbad8ff02002-12-30 20:52:32 +00003371 offset = call_utcoffset(self->tzinfo, Py_None, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00003372 if (offset == -1 && PyErr_Occurred())
3373 return -1;
3374 }
3375 return (TIME_GET_MINUTE(self) - offset + TIME_GET_HOUR(self)*60) != 0;
3376}
3377
Tim Peters371935f2003-02-01 01:52:50 +00003378/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003379
Tim Peters33e0f382003-01-10 02:05:14 +00003380/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003381 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
3382 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00003383 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00003384 */
3385static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003386time_getstate(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003387{
3388 PyObject *basestate;
3389 PyObject *result = NULL;
3390
Tim Peters33e0f382003-01-10 02:05:14 +00003391 basestate = PyString_FromStringAndSize((char *)self->data,
3392 _PyDateTime_TIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00003393 if (basestate != NULL) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003394 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003395 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00003396 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003397 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00003398 Py_DECREF(basestate);
3399 }
3400 return result;
3401}
3402
3403static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00003404time_reduce(PyDateTime_Time *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00003405{
Guido van Rossum177e41a2003-01-30 22:06:23 +00003406 return Py_BuildValue("(ON)", self->ob_type, time_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003407}
3408
Tim Peters37f39822003-01-10 03:49:02 +00003409static PyMethodDef time_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003410
Tim Peters37f39822003-01-10 03:49:02 +00003411 {"isoformat", (PyCFunction)time_isoformat, METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003412 PyDoc_STR("Return string in ISO 8601 format, HH:MM:SS[.mmmmmm]"
3413 "[+HH:MM].")},
3414
Tim Peters37f39822003-01-10 03:49:02 +00003415 {"strftime", (PyCFunction)time_strftime, METH_KEYWORDS,
3416 PyDoc_STR("format -> strftime() style string.")},
3417
3418 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003419 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
3420
Tim Peters37f39822003-01-10 03:49:02 +00003421 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003422 PyDoc_STR("Return self.tzinfo.tzname(self).")},
3423
Tim Peters37f39822003-01-10 03:49:02 +00003424 {"dst", (PyCFunction)time_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003425 PyDoc_STR("Return self.tzinfo.dst(self).")},
3426
Tim Peters37f39822003-01-10 03:49:02 +00003427 {"replace", (PyCFunction)time_replace, METH_KEYWORDS,
3428 PyDoc_STR("Return time with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00003429
Guido van Rossum177e41a2003-01-30 22:06:23 +00003430 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
3431 PyDoc_STR("__reduce__() -> (cls, state)")},
3432
Tim Peters2a799bf2002-12-16 20:18:38 +00003433 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003434};
3435
Tim Peters37f39822003-01-10 03:49:02 +00003436static char time_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00003437PyDoc_STR("time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object\n\
3438\n\
3439All arguments are optional. tzinfo may be None, or an instance of\n\
3440a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00003441
Tim Peters37f39822003-01-10 03:49:02 +00003442static PyNumberMethods time_as_number = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003443 0, /* nb_add */
3444 0, /* nb_subtract */
3445 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00003446 0, /* nb_remainder */
3447 0, /* nb_divmod */
3448 0, /* nb_power */
3449 0, /* nb_negative */
3450 0, /* nb_positive */
3451 0, /* nb_absolute */
Tim Peters37f39822003-01-10 03:49:02 +00003452 (inquiry)time_nonzero, /* nb_nonzero */
Tim Peters2a799bf2002-12-16 20:18:38 +00003453};
3454
Neal Norwitz227b5332006-03-22 09:28:35 +00003455static PyTypeObject PyDateTime_TimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003456 PyObject_HEAD_INIT(NULL)
3457 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00003458 "datetime.time", /* tp_name */
Tim Peters37f39822003-01-10 03:49:02 +00003459 sizeof(PyDateTime_Time), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00003460 0, /* tp_itemsize */
Tim Peters37f39822003-01-10 03:49:02 +00003461 (destructor)time_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003462 0, /* tp_print */
3463 0, /* tp_getattr */
3464 0, /* tp_setattr */
3465 0, /* tp_compare */
Tim Peters37f39822003-01-10 03:49:02 +00003466 (reprfunc)time_repr, /* tp_repr */
3467 &time_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00003468 0, /* tp_as_sequence */
3469 0, /* tp_as_mapping */
Tim Peters37f39822003-01-10 03:49:02 +00003470 (hashfunc)time_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00003471 0, /* tp_call */
Tim Peters37f39822003-01-10 03:49:02 +00003472 (reprfunc)time_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00003473 PyObject_GenericGetAttr, /* tp_getattro */
3474 0, /* tp_setattro */
3475 0, /* tp_as_buffer */
3476 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
3477 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters37f39822003-01-10 03:49:02 +00003478 time_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003479 0, /* tp_traverse */
3480 0, /* tp_clear */
Tim Peters37f39822003-01-10 03:49:02 +00003481 (richcmpfunc)time_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00003482 0, /* tp_weaklistoffset */
3483 0, /* tp_iter */
3484 0, /* tp_iternext */
Tim Peters37f39822003-01-10 03:49:02 +00003485 time_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00003486 0, /* tp_members */
Tim Peters37f39822003-01-10 03:49:02 +00003487 time_getset, /* tp_getset */
3488 0, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00003489 0, /* tp_dict */
3490 0, /* tp_descr_get */
3491 0, /* tp_descr_set */
3492 0, /* tp_dictoffset */
3493 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00003494 time_alloc, /* tp_alloc */
Tim Peters37f39822003-01-10 03:49:02 +00003495 time_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00003496 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00003497};
3498
3499/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003500 * PyDateTime_DateTime implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003501 */
3502
Tim Petersa9bc1682003-01-11 03:39:11 +00003503/* Accessor properties. Properties for day, month, and year are inherited
3504 * from date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003505 */
3506
3507static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003508datetime_hour(PyDateTime_DateTime *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003509{
Tim Petersa9bc1682003-01-11 03:39:11 +00003510 return PyInt_FromLong(DATE_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003511}
3512
Tim Petersa9bc1682003-01-11 03:39:11 +00003513static PyObject *
3514datetime_minute(PyDateTime_DateTime *self, void *unused)
3515{
3516 return PyInt_FromLong(DATE_GET_MINUTE(self));
3517}
3518
3519static PyObject *
3520datetime_second(PyDateTime_DateTime *self, void *unused)
3521{
3522 return PyInt_FromLong(DATE_GET_SECOND(self));
3523}
3524
3525static PyObject *
3526datetime_microsecond(PyDateTime_DateTime *self, void *unused)
3527{
3528 return PyInt_FromLong(DATE_GET_MICROSECOND(self));
3529}
3530
3531static PyObject *
3532datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
3533{
3534 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3535 Py_INCREF(result);
3536 return result;
3537}
3538
3539static PyGetSetDef datetime_getset[] = {
3540 {"hour", (getter)datetime_hour},
3541 {"minute", (getter)datetime_minute},
3542 {"second", (getter)datetime_second},
3543 {"microsecond", (getter)datetime_microsecond},
3544 {"tzinfo", (getter)datetime_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003545 {NULL}
3546};
3547
3548/*
3549 * Constructors.
Tim Peters2a799bf2002-12-16 20:18:38 +00003550 */
3551
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003552static char *datetime_kws[] = {
Tim Peters12bf3392002-12-24 05:41:27 +00003553 "year", "month", "day", "hour", "minute", "second",
3554 "microsecond", "tzinfo", NULL
3555};
3556
Tim Peters2a799bf2002-12-16 20:18:38 +00003557static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003558datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003559{
3560 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003561 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003562 int year;
3563 int month;
3564 int day;
3565 int hour = 0;
3566 int minute = 0;
3567 int second = 0;
3568 int usecond = 0;
3569 PyObject *tzinfo = Py_None;
3570
Guido van Rossum177e41a2003-01-30 22:06:23 +00003571 /* Check for invocation from pickle with __getstate__ state */
3572 if (PyTuple_GET_SIZE(args) >= 1 &&
3573 PyTuple_GET_SIZE(args) <= 2 &&
Tim Peters70533e22003-02-01 04:40:04 +00003574 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Tim Peters3f606292004-03-21 23:38:41 +00003575 PyString_GET_SIZE(state) == _PyDateTime_DATETIME_DATASIZE &&
3576 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00003577 {
Tim Peters70533e22003-02-01 04:40:04 +00003578 PyDateTime_DateTime *me;
3579 char aware;
3580
3581 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003582 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003583 if (check_tzinfo_subclass(tzinfo) < 0) {
3584 PyErr_SetString(PyExc_TypeError, "bad "
3585 "tzinfo state arg");
3586 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003587 }
3588 }
Tim Peters70533e22003-02-01 04:40:04 +00003589 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003590 me = (PyDateTime_DateTime *) (type->tp_alloc(type , aware));
Tim Peters70533e22003-02-01 04:40:04 +00003591 if (me != NULL) {
3592 char *pdata = PyString_AS_STRING(state);
3593
3594 memcpy(me->data, pdata, _PyDateTime_DATETIME_DATASIZE);
3595 me->hashcode = -1;
3596 me->hastzinfo = aware;
3597 if (aware) {
3598 Py_INCREF(tzinfo);
3599 me->tzinfo = tzinfo;
3600 }
3601 }
3602 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003603 }
3604
Tim Petersa9bc1682003-01-11 03:39:11 +00003605 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO", datetime_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003606 &year, &month, &day, &hour, &minute,
3607 &second, &usecond, &tzinfo)) {
3608 if (check_date_args(year, month, day) < 0)
3609 return NULL;
3610 if (check_time_args(hour, minute, second, usecond) < 0)
3611 return NULL;
3612 if (check_tzinfo_subclass(tzinfo) < 0)
3613 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003614 self = new_datetime_ex(year, month, day,
3615 hour, minute, second, usecond,
3616 tzinfo, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003617 }
3618 return self;
3619}
3620
Tim Petersa9bc1682003-01-11 03:39:11 +00003621/* TM_FUNC is the shared type of localtime() and gmtime(). */
3622typedef struct tm *(*TM_FUNC)(const time_t *timer);
3623
3624/* Internal helper.
3625 * Build datetime from a time_t and a distinct count of microseconds.
3626 * Pass localtime or gmtime for f, to control the interpretation of timet.
3627 */
3628static PyObject *
3629datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
3630 PyObject *tzinfo)
3631{
3632 struct tm *tm;
3633 PyObject *result = NULL;
3634
3635 tm = f(&timet);
3636 if (tm) {
3637 /* The platform localtime/gmtime may insert leap seconds,
3638 * indicated by tm->tm_sec > 59. We don't care about them,
3639 * except to the extent that passing them on to the datetime
3640 * constructor would raise ValueError for a reason that
3641 * made no sense to the user.
3642 */
3643 if (tm->tm_sec > 59)
3644 tm->tm_sec = 59;
3645 result = PyObject_CallFunction(cls, "iiiiiiiO",
3646 tm->tm_year + 1900,
3647 tm->tm_mon + 1,
3648 tm->tm_mday,
3649 tm->tm_hour,
3650 tm->tm_min,
3651 tm->tm_sec,
3652 us,
3653 tzinfo);
3654 }
3655 else
3656 PyErr_SetString(PyExc_ValueError,
3657 "timestamp out of range for "
3658 "platform localtime()/gmtime() function");
3659 return result;
3660}
3661
3662/* Internal helper.
3663 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
3664 * to control the interpretation of the timestamp. Since a double doesn't
3665 * have enough bits to cover a datetime's full range of precision, it's
3666 * better to call datetime_from_timet_and_us provided you have a way
3667 * to get that much precision (e.g., C time() isn't good enough).
3668 */
3669static PyObject *
3670datetime_from_timestamp(PyObject *cls, TM_FUNC f, double timestamp,
3671 PyObject *tzinfo)
3672{
Tim Peters1b6f7a92004-06-20 02:50:16 +00003673 time_t timet;
3674 double fraction;
3675 int us;
Tim Petersa9bc1682003-01-11 03:39:11 +00003676
Tim Peters1b6f7a92004-06-20 02:50:16 +00003677 timet = _PyTime_DoubleToTimet(timestamp);
3678 if (timet == (time_t)-1 && PyErr_Occurred())
3679 return NULL;
3680 fraction = timestamp - (double)timet;
3681 us = (int)round_to_long(fraction * 1e6);
Thomas Wouters477c8d52006-05-27 19:21:47 +00003682 /* If timestamp is less than one microsecond smaller than a
3683 * full second, round up. Otherwise, ValueErrors are raised
3684 * for some floats. */
3685 if (us == 1000000) {
3686 timet += 1;
3687 us = 0;
3688 }
Tim Petersa9bc1682003-01-11 03:39:11 +00003689 return datetime_from_timet_and_us(cls, f, timet, us, tzinfo);
3690}
3691
3692/* Internal helper.
3693 * Build most accurate possible datetime for current time. Pass localtime or
3694 * gmtime for f as appropriate.
3695 */
3696static PyObject *
3697datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
3698{
3699#ifdef HAVE_GETTIMEOFDAY
3700 struct timeval t;
3701
3702#ifdef GETTIMEOFDAY_NO_TZ
3703 gettimeofday(&t);
3704#else
3705 gettimeofday(&t, (struct timezone *)NULL);
3706#endif
3707 return datetime_from_timet_and_us(cls, f, t.tv_sec, (int)t.tv_usec,
3708 tzinfo);
3709
3710#else /* ! HAVE_GETTIMEOFDAY */
3711 /* No flavor of gettimeofday exists on this platform. Python's
3712 * time.time() does a lot of other platform tricks to get the
3713 * best time it can on the platform, and we're not going to do
3714 * better than that (if we could, the better code would belong
3715 * in time.time()!) We're limited by the precision of a double,
3716 * though.
3717 */
3718 PyObject *time;
3719 double dtime;
3720
3721 time = time_time();
3722 if (time == NULL)
3723 return NULL;
3724 dtime = PyFloat_AsDouble(time);
3725 Py_DECREF(time);
3726 if (dtime == -1.0 && PyErr_Occurred())
3727 return NULL;
3728 return datetime_from_timestamp(cls, f, dtime, tzinfo);
3729#endif /* ! HAVE_GETTIMEOFDAY */
3730}
3731
Tim Peters2a799bf2002-12-16 20:18:38 +00003732/* Return best possible local time -- this isn't constrained by the
3733 * precision of a timestamp.
3734 */
3735static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003736datetime_now(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003737{
Tim Peters10cadce2003-01-23 19:58:02 +00003738 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003739 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003740 static char *keywords[] = {"tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003741
Tim Peters10cadce2003-01-23 19:58:02 +00003742 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:now", keywords,
3743 &tzinfo))
3744 return NULL;
3745 if (check_tzinfo_subclass(tzinfo) < 0)
3746 return NULL;
3747
3748 self = datetime_best_possible(cls,
3749 tzinfo == Py_None ? localtime : gmtime,
3750 tzinfo);
3751 if (self != NULL && tzinfo != Py_None) {
3752 /* Convert UTC to tzinfo's zone. */
3753 PyObject *temp = self;
Tim Peters2a44a8d2003-01-23 20:53:10 +00003754 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
Tim Peters10cadce2003-01-23 19:58:02 +00003755 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003756 }
3757 return self;
3758}
3759
Tim Petersa9bc1682003-01-11 03:39:11 +00003760/* Return best possible UTC time -- this isn't constrained by the
3761 * precision of a timestamp.
3762 */
3763static PyObject *
3764datetime_utcnow(PyObject *cls, PyObject *dummy)
3765{
3766 return datetime_best_possible(cls, gmtime, Py_None);
3767}
3768
Tim Peters2a799bf2002-12-16 20:18:38 +00003769/* Return new local datetime from timestamp (Python timestamp -- a double). */
3770static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003771datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003772{
Tim Peters2a44a8d2003-01-23 20:53:10 +00003773 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003774 double timestamp;
3775 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003776 static char *keywords[] = {"timestamp", "tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003777
Tim Peters2a44a8d2003-01-23 20:53:10 +00003778 if (! PyArg_ParseTupleAndKeywords(args, kw, "d|O:fromtimestamp",
3779 keywords, &timestamp, &tzinfo))
3780 return NULL;
3781 if (check_tzinfo_subclass(tzinfo) < 0)
3782 return NULL;
3783
3784 self = datetime_from_timestamp(cls,
3785 tzinfo == Py_None ? localtime : gmtime,
3786 timestamp,
3787 tzinfo);
3788 if (self != NULL && tzinfo != Py_None) {
3789 /* Convert UTC to tzinfo's zone. */
3790 PyObject *temp = self;
3791 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3792 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003793 }
3794 return self;
3795}
3796
Tim Petersa9bc1682003-01-11 03:39:11 +00003797/* Return new UTC datetime from timestamp (Python timestamp -- a double). */
3798static PyObject *
3799datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
3800{
3801 double timestamp;
3802 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003803
Tim Petersa9bc1682003-01-11 03:39:11 +00003804 if (PyArg_ParseTuple(args, "d:utcfromtimestamp", &timestamp))
3805 result = datetime_from_timestamp(cls, gmtime, timestamp,
3806 Py_None);
3807 return result;
3808}
3809
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003810/* Return new datetime from time.strptime(). */
3811static PyObject *
3812datetime_strptime(PyObject *cls, PyObject *args)
3813{
3814 PyObject *result = NULL, *obj, *module;
3815 const char *string, *format;
3816
3817 if (!PyArg_ParseTuple(args, "ss:strptime", &string, &format))
3818 return NULL;
3819
3820 if ((module = PyImport_ImportModule("time")) == NULL)
3821 return NULL;
3822 obj = PyObject_CallMethod(module, "strptime", "ss", string, format);
3823 Py_DECREF(module);
3824
3825 if (obj != NULL) {
3826 int i, good_timetuple = 1;
3827 long int ia[6];
3828 if (PySequence_Check(obj) && PySequence_Size(obj) >= 6)
3829 for (i=0; i < 6; i++) {
3830 PyObject *p = PySequence_GetItem(obj, i);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003831 if (p == NULL) {
3832 Py_DECREF(obj);
3833 return NULL;
3834 }
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003835 if (PyInt_Check(p))
3836 ia[i] = PyInt_AsLong(p);
3837 else
3838 good_timetuple = 0;
3839 Py_DECREF(p);
3840 }
3841 else
3842 good_timetuple = 0;
3843 if (good_timetuple)
3844 result = PyObject_CallFunction(cls, "iiiiii",
3845 ia[0], ia[1], ia[2], ia[3], ia[4], ia[5]);
3846 else
3847 PyErr_SetString(PyExc_ValueError,
3848 "unexpected value from time.strptime");
3849 Py_DECREF(obj);
3850 }
3851 return result;
3852}
3853
Tim Petersa9bc1682003-01-11 03:39:11 +00003854/* Return new datetime from date/datetime and time arguments. */
3855static PyObject *
3856datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
3857{
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003858 static char *keywords[] = {"date", "time", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00003859 PyObject *date;
3860 PyObject *time;
3861 PyObject *result = NULL;
3862
3863 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!:combine", keywords,
3864 &PyDateTime_DateType, &date,
3865 &PyDateTime_TimeType, &time)) {
3866 PyObject *tzinfo = Py_None;
3867
3868 if (HASTZINFO(time))
3869 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
3870 result = PyObject_CallFunction(cls, "iiiiiiiO",
3871 GET_YEAR(date),
3872 GET_MONTH(date),
3873 GET_DAY(date),
3874 TIME_GET_HOUR(time),
3875 TIME_GET_MINUTE(time),
3876 TIME_GET_SECOND(time),
3877 TIME_GET_MICROSECOND(time),
3878 tzinfo);
3879 }
3880 return result;
3881}
Tim Peters2a799bf2002-12-16 20:18:38 +00003882
3883/*
3884 * Destructor.
3885 */
3886
3887static void
Tim Petersa9bc1682003-01-11 03:39:11 +00003888datetime_dealloc(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003889{
Tim Petersa9bc1682003-01-11 03:39:11 +00003890 if (HASTZINFO(self)) {
3891 Py_XDECREF(self->tzinfo);
3892 }
Tim Peters2a799bf2002-12-16 20:18:38 +00003893 self->ob_type->tp_free((PyObject *)self);
3894}
3895
3896/*
3897 * Indirect access to tzinfo methods.
3898 */
3899
Tim Peters2a799bf2002-12-16 20:18:38 +00003900/* These are all METH_NOARGS, so don't need to check the arglist. */
3901static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003902datetime_utcoffset(PyDateTime_DateTime *self, PyObject *unused) {
3903 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3904 "utcoffset", (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003905}
3906
3907static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003908datetime_dst(PyDateTime_DateTime *self, PyObject *unused) {
3909 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3910 "dst", (PyObject *)self);
Tim Peters855fe882002-12-22 03:43:39 +00003911}
3912
3913static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003914datetime_tzname(PyDateTime_DateTime *self, PyObject *unused) {
3915 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
3916 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003917}
3918
3919/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003920 * datetime arithmetic.
Tim Peters2a799bf2002-12-16 20:18:38 +00003921 */
3922
Tim Petersa9bc1682003-01-11 03:39:11 +00003923/* factor must be 1 (to add) or -1 (to subtract). The result inherits
3924 * the tzinfo state of date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003925 */
3926static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003927add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
3928 int factor)
Tim Peters2a799bf2002-12-16 20:18:38 +00003929{
Tim Petersa9bc1682003-01-11 03:39:11 +00003930 /* Note that the C-level additions can't overflow, because of
3931 * invariant bounds on the member values.
3932 */
3933 int year = GET_YEAR(date);
3934 int month = GET_MONTH(date);
3935 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
3936 int hour = DATE_GET_HOUR(date);
3937 int minute = DATE_GET_MINUTE(date);
3938 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
3939 int microsecond = DATE_GET_MICROSECOND(date) +
3940 GET_TD_MICROSECONDS(delta) * factor;
Tim Peters2a799bf2002-12-16 20:18:38 +00003941
Tim Petersa9bc1682003-01-11 03:39:11 +00003942 assert(factor == 1 || factor == -1);
3943 if (normalize_datetime(&year, &month, &day,
3944 &hour, &minute, &second, &microsecond) < 0)
3945 return NULL;
3946 else
3947 return new_datetime(year, month, day,
3948 hour, minute, second, microsecond,
3949 HASTZINFO(date) ? date->tzinfo : Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003950}
3951
3952static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003953datetime_add(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003954{
Tim Petersa9bc1682003-01-11 03:39:11 +00003955 if (PyDateTime_Check(left)) {
3956 /* datetime + ??? */
3957 if (PyDelta_Check(right))
3958 /* datetime + delta */
3959 return add_datetime_timedelta(
3960 (PyDateTime_DateTime *)left,
3961 (PyDateTime_Delta *)right,
3962 1);
3963 }
3964 else if (PyDelta_Check(left)) {
3965 /* delta + datetime */
3966 return add_datetime_timedelta((PyDateTime_DateTime *) right,
3967 (PyDateTime_Delta *) left,
3968 1);
3969 }
3970 Py_INCREF(Py_NotImplemented);
3971 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00003972}
3973
3974static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003975datetime_subtract(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003976{
3977 PyObject *result = Py_NotImplemented;
3978
3979 if (PyDateTime_Check(left)) {
3980 /* datetime - ??? */
3981 if (PyDateTime_Check(right)) {
3982 /* datetime - datetime */
3983 naivety n1, n2;
3984 int offset1, offset2;
Tim Petersa9bc1682003-01-11 03:39:11 +00003985 int delta_d, delta_s, delta_us;
Tim Peters2a799bf2002-12-16 20:18:38 +00003986
Tim Peterse39a80c2002-12-30 21:28:52 +00003987 if (classify_two_utcoffsets(left, &offset1, &n1, left,
3988 right, &offset2, &n2,
3989 right) < 0)
Tim Peters00237032002-12-27 02:21:51 +00003990 return NULL;
Tim Peters8702d5f2002-12-27 02:26:16 +00003991 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
Tim Peters2a799bf2002-12-16 20:18:38 +00003992 if (n1 != n2) {
3993 PyErr_SetString(PyExc_TypeError,
3994 "can't subtract offset-naive and "
3995 "offset-aware datetimes");
3996 return NULL;
3997 }
Tim Petersa9bc1682003-01-11 03:39:11 +00003998 delta_d = ymd_to_ord(GET_YEAR(left),
3999 GET_MONTH(left),
4000 GET_DAY(left)) -
4001 ymd_to_ord(GET_YEAR(right),
4002 GET_MONTH(right),
4003 GET_DAY(right));
4004 /* These can't overflow, since the values are
4005 * normalized. At most this gives the number of
4006 * seconds in one day.
4007 */
4008 delta_s = (DATE_GET_HOUR(left) -
4009 DATE_GET_HOUR(right)) * 3600 +
4010 (DATE_GET_MINUTE(left) -
4011 DATE_GET_MINUTE(right)) * 60 +
4012 (DATE_GET_SECOND(left) -
4013 DATE_GET_SECOND(right));
4014 delta_us = DATE_GET_MICROSECOND(left) -
4015 DATE_GET_MICROSECOND(right);
Tim Peters2a799bf2002-12-16 20:18:38 +00004016 /* (left - offset1) - (right - offset2) =
4017 * (left - right) + (offset2 - offset1)
4018 */
Tim Petersa9bc1682003-01-11 03:39:11 +00004019 delta_s += (offset2 - offset1) * 60;
4020 result = new_delta(delta_d, delta_s, delta_us, 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00004021 }
4022 else if (PyDelta_Check(right)) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004023 /* datetime - delta */
4024 result = add_datetime_timedelta(
Tim Peters2a799bf2002-12-16 20:18:38 +00004025 (PyDateTime_DateTime *)left,
Tim Petersa9bc1682003-01-11 03:39:11 +00004026 (PyDateTime_Delta *)right,
4027 -1);
Tim Peters2a799bf2002-12-16 20:18:38 +00004028 }
4029 }
4030
4031 if (result == Py_NotImplemented)
4032 Py_INCREF(result);
4033 return result;
4034}
4035
4036/* Various ways to turn a datetime into a string. */
4037
4038static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004039datetime_repr(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004040{
Tim Petersa9bc1682003-01-11 03:39:11 +00004041 char buffer[1000];
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004042 const char *type_name = self->ob_type->tp_name;
Tim Petersa9bc1682003-01-11 03:39:11 +00004043 PyObject *baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004044
Tim Petersa9bc1682003-01-11 03:39:11 +00004045 if (DATE_GET_MICROSECOND(self)) {
4046 PyOS_snprintf(buffer, sizeof(buffer),
4047 "%s(%d, %d, %d, %d, %d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004048 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004049 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4050 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4051 DATE_GET_SECOND(self),
4052 DATE_GET_MICROSECOND(self));
4053 }
4054 else if (DATE_GET_SECOND(self)) {
4055 PyOS_snprintf(buffer, sizeof(buffer),
4056 "%s(%d, %d, %d, %d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004057 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004058 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4059 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4060 DATE_GET_SECOND(self));
4061 }
4062 else {
4063 PyOS_snprintf(buffer, sizeof(buffer),
4064 "%s(%d, %d, %d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004065 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004066 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4067 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
4068 }
4069 baserepr = PyString_FromString(buffer);
4070 if (baserepr == NULL || ! HASTZINFO(self))
4071 return baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004072 return append_keyword_tzinfo(baserepr, self->tzinfo);
4073}
4074
Tim Petersa9bc1682003-01-11 03:39:11 +00004075static PyObject *
4076datetime_str(PyDateTime_DateTime *self)
4077{
4078 return PyObject_CallMethod((PyObject *)self, "isoformat", "(s)", " ");
4079}
Tim Peters2a799bf2002-12-16 20:18:38 +00004080
4081static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004082datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004083{
Tim Petersa9bc1682003-01-11 03:39:11 +00004084 char sep = 'T';
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004085 static char *keywords[] = {"sep", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00004086 char buffer[100];
4087 char *cp;
4088 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004089
Tim Petersa9bc1682003-01-11 03:39:11 +00004090 if (!PyArg_ParseTupleAndKeywords(args, kw, "|c:isoformat", keywords,
4091 &sep))
4092 return NULL;
4093 cp = isoformat_date((PyDateTime_Date *)self, buffer, sizeof(buffer));
4094 assert(cp != NULL);
4095 *cp++ = sep;
4096 isoformat_time(self, cp, sizeof(buffer) - (cp - buffer));
4097 result = PyString_FromString(buffer);
4098 if (result == NULL || ! HASTZINFO(self))
Tim Peters2a799bf2002-12-16 20:18:38 +00004099 return result;
4100
4101 /* We need to append the UTC offset. */
Tim Petersa9bc1682003-01-11 03:39:11 +00004102 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
Tim Peters2a799bf2002-12-16 20:18:38 +00004103 (PyObject *)self) < 0) {
4104 Py_DECREF(result);
4105 return NULL;
4106 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004107 PyString_ConcatAndDel(&result, PyString_FromString(buffer));
Tim Peters2a799bf2002-12-16 20:18:38 +00004108 return result;
4109}
4110
Tim Petersa9bc1682003-01-11 03:39:11 +00004111static PyObject *
4112datetime_ctime(PyDateTime_DateTime *self)
4113{
4114 return format_ctime((PyDateTime_Date *)self,
4115 DATE_GET_HOUR(self),
4116 DATE_GET_MINUTE(self),
4117 DATE_GET_SECOND(self));
4118}
4119
Tim Peters2a799bf2002-12-16 20:18:38 +00004120/* Miscellaneous methods. */
4121
Tim Petersa9bc1682003-01-11 03:39:11 +00004122/* This is more natural as a tp_compare, but doesn't work then: for whatever
4123 * reason, Python's try_3way_compare ignores tp_compare unless
4124 * PyInstance_Check returns true, but these aren't old-style classes.
4125 */
4126static PyObject *
4127datetime_richcompare(PyDateTime_DateTime *self, PyObject *other, int op)
4128{
4129 int diff;
4130 naivety n1, n2;
4131 int offset1, offset2;
4132
4133 if (! PyDateTime_Check(other)) {
Tim Peters528ca532004-09-16 01:30:50 +00004134 /* If other has a "timetuple" attr, that's an advertised
4135 * hook for other classes to ask to get comparison control.
4136 * However, date instances have a timetuple attr, and we
4137 * don't want to allow that comparison. Because datetime
4138 * is a subclass of date, when mixing date and datetime
4139 * in a comparison, Python gives datetime the first shot
4140 * (it's the more specific subtype). So we can stop that
4141 * combination here reliably.
4142 */
4143 if (PyObject_HasAttrString(other, "timetuple") &&
4144 ! PyDate_Check(other)) {
Tim Peters8d81a012003-01-24 22:36:34 +00004145 /* A hook for other kinds of datetime objects. */
4146 Py_INCREF(Py_NotImplemented);
4147 return Py_NotImplemented;
4148 }
Tim Peters07534a62003-02-07 22:50:28 +00004149 if (op == Py_EQ || op == Py_NE) {
4150 PyObject *result = op == Py_EQ ? Py_False : Py_True;
4151 Py_INCREF(result);
4152 return result;
4153 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004154 /* Stop this from falling back to address comparison. */
Tim Peters07534a62003-02-07 22:50:28 +00004155 return cmperror((PyObject *)self, other);
Tim Petersa9bc1682003-01-11 03:39:11 +00004156 }
4157
4158 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1,
4159 (PyObject *)self,
4160 other, &offset2, &n2,
4161 other) < 0)
4162 return NULL;
4163 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
4164 /* If they're both naive, or both aware and have the same offsets,
4165 * we get off cheap. Note that if they're both naive, offset1 ==
4166 * offset2 == 0 at this point.
4167 */
4168 if (n1 == n2 && offset1 == offset2) {
4169 diff = memcmp(self->data, ((PyDateTime_DateTime *)other)->data,
4170 _PyDateTime_DATETIME_DATASIZE);
4171 return diff_to_bool(diff, op);
4172 }
4173
4174 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
4175 PyDateTime_Delta *delta;
4176
4177 assert(offset1 != offset2); /* else last "if" handled it */
4178 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
4179 other);
4180 if (delta == NULL)
4181 return NULL;
4182 diff = GET_TD_DAYS(delta);
4183 if (diff == 0)
4184 diff = GET_TD_SECONDS(delta) |
4185 GET_TD_MICROSECONDS(delta);
4186 Py_DECREF(delta);
4187 return diff_to_bool(diff, op);
4188 }
4189
4190 assert(n1 != n2);
4191 PyErr_SetString(PyExc_TypeError,
4192 "can't compare offset-naive and "
4193 "offset-aware datetimes");
4194 return NULL;
4195}
4196
4197static long
4198datetime_hash(PyDateTime_DateTime *self)
4199{
4200 if (self->hashcode == -1) {
4201 naivety n;
4202 int offset;
4203 PyObject *temp;
4204
4205 n = classify_utcoffset((PyObject *)self, (PyObject *)self,
4206 &offset);
4207 assert(n != OFFSET_UNKNOWN);
4208 if (n == OFFSET_ERROR)
4209 return -1;
4210
4211 /* Reduce this to a hash of another object. */
4212 if (n == OFFSET_NAIVE)
4213 temp = PyString_FromStringAndSize(
4214 (char *)self->data,
4215 _PyDateTime_DATETIME_DATASIZE);
4216 else {
4217 int days;
4218 int seconds;
4219
4220 assert(n == OFFSET_AWARE);
4221 assert(HASTZINFO(self));
4222 days = ymd_to_ord(GET_YEAR(self),
4223 GET_MONTH(self),
4224 GET_DAY(self));
4225 seconds = DATE_GET_HOUR(self) * 3600 +
4226 (DATE_GET_MINUTE(self) - offset) * 60 +
4227 DATE_GET_SECOND(self);
4228 temp = new_delta(days,
4229 seconds,
4230 DATE_GET_MICROSECOND(self),
4231 1);
4232 }
4233 if (temp != NULL) {
4234 self->hashcode = PyObject_Hash(temp);
4235 Py_DECREF(temp);
4236 }
4237 }
4238 return self->hashcode;
4239}
Tim Peters2a799bf2002-12-16 20:18:38 +00004240
4241static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004242datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00004243{
4244 PyObject *clone;
4245 PyObject *tuple;
4246 int y = GET_YEAR(self);
4247 int m = GET_MONTH(self);
4248 int d = GET_DAY(self);
4249 int hh = DATE_GET_HOUR(self);
4250 int mm = DATE_GET_MINUTE(self);
4251 int ss = DATE_GET_SECOND(self);
4252 int us = DATE_GET_MICROSECOND(self);
Tim Petersa9bc1682003-01-11 03:39:11 +00004253 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00004254
4255 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO:replace",
Tim Petersa9bc1682003-01-11 03:39:11 +00004256 datetime_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00004257 &y, &m, &d, &hh, &mm, &ss, &us,
4258 &tzinfo))
4259 return NULL;
4260 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
4261 if (tuple == NULL)
4262 return NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00004263 clone = datetime_new(self->ob_type, tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00004264 Py_DECREF(tuple);
4265 return clone;
4266}
4267
4268static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004269datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters80475bb2002-12-25 07:40:55 +00004270{
Tim Peters52dcce22003-01-23 16:36:11 +00004271 int y, m, d, hh, mm, ss, us;
Tim Peters521fc152002-12-31 17:36:56 +00004272 PyObject *result;
Tim Peters52dcce22003-01-23 16:36:11 +00004273 int offset, none;
Tim Peters521fc152002-12-31 17:36:56 +00004274
Tim Peters80475bb2002-12-25 07:40:55 +00004275 PyObject *tzinfo;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004276 static char *keywords[] = {"tz", NULL};
Tim Peters80475bb2002-12-25 07:40:55 +00004277
Tim Peters52dcce22003-01-23 16:36:11 +00004278 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:astimezone", keywords,
4279 &PyDateTime_TZInfoType, &tzinfo))
Tim Peters80475bb2002-12-25 07:40:55 +00004280 return NULL;
4281
Tim Peters52dcce22003-01-23 16:36:11 +00004282 if (!HASTZINFO(self) || self->tzinfo == Py_None)
4283 goto NeedAware;
Tim Peters521fc152002-12-31 17:36:56 +00004284
Tim Peters52dcce22003-01-23 16:36:11 +00004285 /* Conversion to self's own time zone is a NOP. */
4286 if (self->tzinfo == tzinfo) {
4287 Py_INCREF(self);
4288 return (PyObject *)self;
Tim Peters710fb152003-01-02 19:35:54 +00004289 }
Tim Peters521fc152002-12-31 17:36:56 +00004290
Tim Peters52dcce22003-01-23 16:36:11 +00004291 /* Convert self to UTC. */
4292 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4293 if (offset == -1 && PyErr_Occurred())
4294 return NULL;
4295 if (none)
4296 goto NeedAware;
Tim Petersf3615152003-01-01 21:51:37 +00004297
Tim Peters52dcce22003-01-23 16:36:11 +00004298 y = GET_YEAR(self);
4299 m = GET_MONTH(self);
4300 d = GET_DAY(self);
4301 hh = DATE_GET_HOUR(self);
4302 mm = DATE_GET_MINUTE(self);
4303 ss = DATE_GET_SECOND(self);
4304 us = DATE_GET_MICROSECOND(self);
4305
4306 mm -= offset;
Tim Petersf3615152003-01-01 21:51:37 +00004307 if ((mm < 0 || mm >= 60) &&
4308 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Peters52dcce22003-01-23 16:36:11 +00004309 return NULL;
4310
4311 /* Attach new tzinfo and let fromutc() do the rest. */
4312 result = new_datetime(y, m, d, hh, mm, ss, us, tzinfo);
4313 if (result != NULL) {
4314 PyObject *temp = result;
4315
4316 result = PyObject_CallMethod(tzinfo, "fromutc", "O", temp);
4317 Py_DECREF(temp);
4318 }
Tim Petersadf64202003-01-04 06:03:15 +00004319 return result;
Tim Peters521fc152002-12-31 17:36:56 +00004320
Tim Peters52dcce22003-01-23 16:36:11 +00004321NeedAware:
4322 PyErr_SetString(PyExc_ValueError, "astimezone() cannot be applied to "
4323 "a naive datetime");
Tim Peters521fc152002-12-31 17:36:56 +00004324 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00004325}
4326
4327static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004328datetime_timetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004329{
4330 int dstflag = -1;
4331
Tim Petersa9bc1682003-01-11 03:39:11 +00004332 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004333 int none;
4334
4335 dstflag = call_dst(self->tzinfo, (PyObject *)self, &none);
4336 if (dstflag == -1 && PyErr_Occurred())
4337 return NULL;
4338
4339 if (none)
4340 dstflag = -1;
4341 else if (dstflag != 0)
4342 dstflag = 1;
4343
4344 }
4345 return build_struct_time(GET_YEAR(self),
4346 GET_MONTH(self),
4347 GET_DAY(self),
4348 DATE_GET_HOUR(self),
4349 DATE_GET_MINUTE(self),
4350 DATE_GET_SECOND(self),
4351 dstflag);
4352}
4353
4354static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004355datetime_getdate(PyDateTime_DateTime *self)
4356{
4357 return new_date(GET_YEAR(self),
4358 GET_MONTH(self),
4359 GET_DAY(self));
4360}
4361
4362static PyObject *
4363datetime_gettime(PyDateTime_DateTime *self)
4364{
4365 return new_time(DATE_GET_HOUR(self),
4366 DATE_GET_MINUTE(self),
4367 DATE_GET_SECOND(self),
4368 DATE_GET_MICROSECOND(self),
4369 Py_None);
4370}
4371
4372static PyObject *
4373datetime_gettimetz(PyDateTime_DateTime *self)
4374{
4375 return new_time(DATE_GET_HOUR(self),
4376 DATE_GET_MINUTE(self),
4377 DATE_GET_SECOND(self),
4378 DATE_GET_MICROSECOND(self),
4379 HASTZINFO(self) ? self->tzinfo : Py_None);
4380}
4381
4382static PyObject *
4383datetime_utctimetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004384{
4385 int y = GET_YEAR(self);
4386 int m = GET_MONTH(self);
4387 int d = GET_DAY(self);
4388 int hh = DATE_GET_HOUR(self);
4389 int mm = DATE_GET_MINUTE(self);
4390 int ss = DATE_GET_SECOND(self);
4391 int us = 0; /* microseconds are ignored in a timetuple */
4392 int offset = 0;
4393
Tim Petersa9bc1682003-01-11 03:39:11 +00004394 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004395 int none;
4396
4397 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4398 if (offset == -1 && PyErr_Occurred())
4399 return NULL;
4400 }
4401 /* Even if offset is 0, don't call timetuple() -- tm_isdst should be
4402 * 0 in a UTC timetuple regardless of what dst() says.
4403 */
4404 if (offset) {
4405 /* Subtract offset minutes & normalize. */
4406 int stat;
4407
4408 mm -= offset;
4409 stat = normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us);
4410 if (stat < 0) {
4411 /* At the edges, it's possible we overflowed
4412 * beyond MINYEAR or MAXYEAR.
4413 */
4414 if (PyErr_ExceptionMatches(PyExc_OverflowError))
4415 PyErr_Clear();
4416 else
4417 return NULL;
4418 }
4419 }
4420 return build_struct_time(y, m, d, hh, mm, ss, 0);
4421}
4422
Tim Peters371935f2003-02-01 01:52:50 +00004423/* Pickle support, a simple use of __reduce__. */
Tim Peters33e0f382003-01-10 02:05:14 +00004424
Tim Petersa9bc1682003-01-11 03:39:11 +00004425/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004426 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4427 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00004428 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00004429 */
4430static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004431datetime_getstate(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004432{
4433 PyObject *basestate;
4434 PyObject *result = NULL;
4435
Tim Peters33e0f382003-01-10 02:05:14 +00004436 basestate = PyString_FromStringAndSize((char *)self->data,
4437 _PyDateTime_DATETIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00004438 if (basestate != NULL) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004439 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004440 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00004441 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004442 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00004443 Py_DECREF(basestate);
4444 }
4445 return result;
4446}
4447
4448static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00004449datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00004450{
Guido van Rossum177e41a2003-01-30 22:06:23 +00004451 return Py_BuildValue("(ON)", self->ob_type, datetime_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00004452}
4453
Tim Petersa9bc1682003-01-11 03:39:11 +00004454static PyMethodDef datetime_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004455
Tim Peters2a799bf2002-12-16 20:18:38 +00004456 /* Class methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00004457
Tim Petersa9bc1682003-01-11 03:39:11 +00004458 {"now", (PyCFunction)datetime_now,
Tim Peters2a799bf2002-12-16 20:18:38 +00004459 METH_KEYWORDS | METH_CLASS,
Neal Norwitz2fbe5372003-01-23 21:09:05 +00004460 PyDoc_STR("[tz] -> new datetime with tz's local day and time.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004461
Tim Petersa9bc1682003-01-11 03:39:11 +00004462 {"utcnow", (PyCFunction)datetime_utcnow,
4463 METH_NOARGS | METH_CLASS,
4464 PyDoc_STR("Return a new datetime representing UTC day and time.")},
4465
4466 {"fromtimestamp", (PyCFunction)datetime_fromtimestamp,
Tim Peters2a799bf2002-12-16 20:18:38 +00004467 METH_KEYWORDS | METH_CLASS,
Tim Peters2a44a8d2003-01-23 20:53:10 +00004468 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004469
Tim Petersa9bc1682003-01-11 03:39:11 +00004470 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
4471 METH_VARARGS | METH_CLASS,
4472 PyDoc_STR("timestamp -> UTC datetime from a POSIX timestamp "
4473 "(like time.time()).")},
4474
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004475 {"strptime", (PyCFunction)datetime_strptime,
4476 METH_VARARGS | METH_CLASS,
4477 PyDoc_STR("string, format -> new datetime parsed from a string "
4478 "(like time.strptime()).")},
4479
Tim Petersa9bc1682003-01-11 03:39:11 +00004480 {"combine", (PyCFunction)datetime_combine,
4481 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4482 PyDoc_STR("date, time -> datetime with same date and time fields")},
4483
Tim Peters2a799bf2002-12-16 20:18:38 +00004484 /* Instance methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00004485
Tim Petersa9bc1682003-01-11 03:39:11 +00004486 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
4487 PyDoc_STR("Return date object with same year, month and day.")},
4488
4489 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
4490 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
4491
4492 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
4493 PyDoc_STR("Return time object with same time and tzinfo.")},
4494
4495 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
4496 PyDoc_STR("Return ctime() style string.")},
4497
4498 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004499 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
4500
Tim Petersa9bc1682003-01-11 03:39:11 +00004501 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004502 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
4503
Tim Petersa9bc1682003-01-11 03:39:11 +00004504 {"isoformat", (PyCFunction)datetime_isoformat, METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004505 PyDoc_STR("[sep] -> string in ISO 8601 format, "
4506 "YYYY-MM-DDTHH:MM:SS[.mmmmmm][+HH:MM].\n\n"
4507 "sep is used to separate the year from the time, and "
4508 "defaults to 'T'.")},
4509
Tim Petersa9bc1682003-01-11 03:39:11 +00004510 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004511 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
4512
Tim Petersa9bc1682003-01-11 03:39:11 +00004513 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004514 PyDoc_STR("Return self.tzinfo.tzname(self).")},
4515
Tim Petersa9bc1682003-01-11 03:39:11 +00004516 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004517 PyDoc_STR("Return self.tzinfo.dst(self).")},
4518
Tim Petersa9bc1682003-01-11 03:39:11 +00004519 {"replace", (PyCFunction)datetime_replace, METH_KEYWORDS,
4520 PyDoc_STR("Return datetime with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00004521
Tim Petersa9bc1682003-01-11 03:39:11 +00004522 {"astimezone", (PyCFunction)datetime_astimezone, METH_KEYWORDS,
Tim Peters80475bb2002-12-25 07:40:55 +00004523 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
4524
Guido van Rossum177e41a2003-01-30 22:06:23 +00004525 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
4526 PyDoc_STR("__reduce__() -> (cls, state)")},
4527
Tim Peters2a799bf2002-12-16 20:18:38 +00004528 {NULL, NULL}
4529};
4530
Tim Petersa9bc1682003-01-11 03:39:11 +00004531static char datetime_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00004532PyDoc_STR("datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])\n\
4533\n\
4534The year, month and day arguments are required. tzinfo may be None, or an\n\
4535instance of a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00004536
Tim Petersa9bc1682003-01-11 03:39:11 +00004537static PyNumberMethods datetime_as_number = {
4538 datetime_add, /* nb_add */
4539 datetime_subtract, /* nb_subtract */
Tim Peters2a799bf2002-12-16 20:18:38 +00004540 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00004541 0, /* nb_remainder */
4542 0, /* nb_divmod */
4543 0, /* nb_power */
4544 0, /* nb_negative */
4545 0, /* nb_positive */
4546 0, /* nb_absolute */
4547 0, /* nb_nonzero */
4548};
4549
Neal Norwitz227b5332006-03-22 09:28:35 +00004550static PyTypeObject PyDateTime_DateTimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004551 PyObject_HEAD_INIT(NULL)
4552 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00004553 "datetime.datetime", /* tp_name */
Tim Petersa9bc1682003-01-11 03:39:11 +00004554 sizeof(PyDateTime_DateTime), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00004555 0, /* tp_itemsize */
Tim Petersa9bc1682003-01-11 03:39:11 +00004556 (destructor)datetime_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004557 0, /* tp_print */
4558 0, /* tp_getattr */
4559 0, /* tp_setattr */
4560 0, /* tp_compare */
Tim Petersa9bc1682003-01-11 03:39:11 +00004561 (reprfunc)datetime_repr, /* tp_repr */
4562 &datetime_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00004563 0, /* tp_as_sequence */
4564 0, /* tp_as_mapping */
Tim Petersa9bc1682003-01-11 03:39:11 +00004565 (hashfunc)datetime_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00004566 0, /* tp_call */
Tim Petersa9bc1682003-01-11 03:39:11 +00004567 (reprfunc)datetime_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00004568 PyObject_GenericGetAttr, /* tp_getattro */
4569 0, /* tp_setattro */
4570 0, /* tp_as_buffer */
4571 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
4572 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Petersa9bc1682003-01-11 03:39:11 +00004573 datetime_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004574 0, /* tp_traverse */
4575 0, /* tp_clear */
Tim Petersa9bc1682003-01-11 03:39:11 +00004576 (richcmpfunc)datetime_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00004577 0, /* tp_weaklistoffset */
4578 0, /* tp_iter */
4579 0, /* tp_iternext */
Tim Petersa9bc1682003-01-11 03:39:11 +00004580 datetime_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00004581 0, /* tp_members */
Tim Petersa9bc1682003-01-11 03:39:11 +00004582 datetime_getset, /* tp_getset */
4583 &PyDateTime_DateType, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00004584 0, /* tp_dict */
4585 0, /* tp_descr_get */
4586 0, /* tp_descr_set */
4587 0, /* tp_dictoffset */
4588 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00004589 datetime_alloc, /* tp_alloc */
Tim Petersa9bc1682003-01-11 03:39:11 +00004590 datetime_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00004591 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00004592};
4593
4594/* ---------------------------------------------------------------------------
4595 * Module methods and initialization.
4596 */
4597
4598static PyMethodDef module_methods[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004599 {NULL, NULL}
4600};
4601
Tim Peters9ddf40b2004-06-20 22:41:32 +00004602/* C API. Clients get at this via PyDateTime_IMPORT, defined in
4603 * datetime.h.
4604 */
4605static PyDateTime_CAPI CAPI = {
4606 &PyDateTime_DateType,
4607 &PyDateTime_DateTimeType,
4608 &PyDateTime_TimeType,
4609 &PyDateTime_DeltaType,
4610 &PyDateTime_TZInfoType,
4611 new_date_ex,
4612 new_datetime_ex,
4613 new_time_ex,
4614 new_delta_ex,
4615 datetime_fromtimestamp,
4616 date_fromtimestamp
4617};
4618
4619
Tim Peters2a799bf2002-12-16 20:18:38 +00004620PyMODINIT_FUNC
4621initdatetime(void)
4622{
4623 PyObject *m; /* a module object */
4624 PyObject *d; /* its dict */
4625 PyObject *x;
4626
Tim Peters2a799bf2002-12-16 20:18:38 +00004627 m = Py_InitModule3("datetime", module_methods,
4628 "Fast implementation of the datetime type.");
Neal Norwitz1ac754f2006-01-19 06:09:39 +00004629 if (m == NULL)
4630 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004631
4632 if (PyType_Ready(&PyDateTime_DateType) < 0)
4633 return;
4634 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
4635 return;
4636 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
4637 return;
4638 if (PyType_Ready(&PyDateTime_TimeType) < 0)
4639 return;
4640 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
4641 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004642
Tim Peters2a799bf2002-12-16 20:18:38 +00004643 /* timedelta values */
4644 d = PyDateTime_DeltaType.tp_dict;
4645
Tim Peters2a799bf2002-12-16 20:18:38 +00004646 x = new_delta(0, 0, 1, 0);
4647 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4648 return;
4649 Py_DECREF(x);
4650
4651 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
4652 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4653 return;
4654 Py_DECREF(x);
4655
4656 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
4657 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4658 return;
4659 Py_DECREF(x);
4660
4661 /* date values */
4662 d = PyDateTime_DateType.tp_dict;
4663
4664 x = new_date(1, 1, 1);
4665 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4666 return;
4667 Py_DECREF(x);
4668
4669 x = new_date(MAXYEAR, 12, 31);
4670 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4671 return;
4672 Py_DECREF(x);
4673
4674 x = new_delta(1, 0, 0, 0);
4675 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4676 return;
4677 Py_DECREF(x);
4678
Tim Peters37f39822003-01-10 03:49:02 +00004679 /* time values */
4680 d = PyDateTime_TimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004681
Tim Peters37f39822003-01-10 03:49:02 +00004682 x = new_time(0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004683 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4684 return;
4685 Py_DECREF(x);
4686
Tim Peters37f39822003-01-10 03:49:02 +00004687 x = new_time(23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004688 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4689 return;
4690 Py_DECREF(x);
4691
4692 x = new_delta(0, 0, 1, 0);
4693 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4694 return;
4695 Py_DECREF(x);
4696
Tim Petersa9bc1682003-01-11 03:39:11 +00004697 /* datetime values */
4698 d = PyDateTime_DateTimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004699
Tim Petersa9bc1682003-01-11 03:39:11 +00004700 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004701 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4702 return;
4703 Py_DECREF(x);
4704
Tim Petersa9bc1682003-01-11 03:39:11 +00004705 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004706 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4707 return;
4708 Py_DECREF(x);
4709
4710 x = new_delta(0, 0, 1, 0);
4711 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4712 return;
4713 Py_DECREF(x);
4714
Tim Peters2a799bf2002-12-16 20:18:38 +00004715 /* module initialization */
4716 PyModule_AddIntConstant(m, "MINYEAR", MINYEAR);
4717 PyModule_AddIntConstant(m, "MAXYEAR", MAXYEAR);
4718
4719 Py_INCREF(&PyDateTime_DateType);
4720 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
4721
Tim Petersa9bc1682003-01-11 03:39:11 +00004722 Py_INCREF(&PyDateTime_DateTimeType);
4723 PyModule_AddObject(m, "datetime",
4724 (PyObject *)&PyDateTime_DateTimeType);
4725
4726 Py_INCREF(&PyDateTime_TimeType);
4727 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
4728
Tim Peters2a799bf2002-12-16 20:18:38 +00004729 Py_INCREF(&PyDateTime_DeltaType);
4730 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
4731
Tim Peters2a799bf2002-12-16 20:18:38 +00004732 Py_INCREF(&PyDateTime_TZInfoType);
4733 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
4734
Tim Peters9ddf40b2004-06-20 22:41:32 +00004735 x = PyCObject_FromVoidPtrAndDesc(&CAPI, (void*) DATETIME_API_MAGIC,
4736 NULL);
4737 if (x == NULL)
4738 return;
4739 PyModule_AddObject(m, "datetime_CAPI", x);
4740
Tim Peters2a799bf2002-12-16 20:18:38 +00004741 /* A 4-year cycle has an extra leap day over what we'd get from
4742 * pasting together 4 single years.
4743 */
4744 assert(DI4Y == 4 * 365 + 1);
4745 assert(DI4Y == days_before_year(4+1));
4746
4747 /* Similarly, a 400-year cycle has an extra leap day over what we'd
4748 * get from pasting together 4 100-year cycles.
4749 */
4750 assert(DI400Y == 4 * DI100Y + 1);
4751 assert(DI400Y == days_before_year(400+1));
4752
4753 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
4754 * pasting together 25 4-year cycles.
4755 */
4756 assert(DI100Y == 25 * DI4Y - 1);
4757 assert(DI100Y == days_before_year(100+1));
4758
4759 us_per_us = PyInt_FromLong(1);
4760 us_per_ms = PyInt_FromLong(1000);
4761 us_per_second = PyInt_FromLong(1000000);
4762 us_per_minute = PyInt_FromLong(60000000);
4763 seconds_per_day = PyInt_FromLong(24 * 3600);
4764 if (us_per_us == NULL || us_per_ms == NULL || us_per_second == NULL ||
4765 us_per_minute == NULL || seconds_per_day == NULL)
4766 return;
4767
4768 /* The rest are too big for 32-bit ints, but even
4769 * us_per_week fits in 40 bits, so doubles should be exact.
4770 */
4771 us_per_hour = PyLong_FromDouble(3600000000.0);
4772 us_per_day = PyLong_FromDouble(86400000000.0);
4773 us_per_week = PyLong_FromDouble(604800000000.0);
4774 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
4775 return;
4776}
Tim Petersf3615152003-01-01 21:51:37 +00004777
4778/* ---------------------------------------------------------------------------
Tim Petersa9bc1682003-01-11 03:39:11 +00004779Some time zone algebra. For a datetime x, let
Tim Petersf3615152003-01-01 21:51:37 +00004780 x.n = x stripped of its timezone -- its naive time.
4781 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
4782 return None
4783 x.d = x.dst(), and assuming that doesn't raise an exception or
4784 return None
4785 x.s = x's standard offset, x.o - x.d
4786
4787Now some derived rules, where k is a duration (timedelta).
4788
47891. x.o = x.s + x.d
4790 This follows from the definition of x.s.
4791
Tim Petersc5dc4da2003-01-02 17:55:03 +000047922. If x and y have the same tzinfo member, x.s = y.s.
Tim Petersf3615152003-01-01 21:51:37 +00004793 This is actually a requirement, an assumption we need to make about
4794 sane tzinfo classes.
4795
47963. The naive UTC time corresponding to x is x.n - x.o.
4797 This is again a requirement for a sane tzinfo class.
4798
47994. (x+k).s = x.s
Tim Peters8bb5ad22003-01-24 02:44:45 +00004800 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
Tim Petersf3615152003-01-01 21:51:37 +00004801
Tim Petersc5dc4da2003-01-02 17:55:03 +000048025. (x+k).n = x.n + k
Tim Petersf3615152003-01-01 21:51:37 +00004803 Again follows from how arithmetic is defined.
4804
Tim Peters8bb5ad22003-01-24 02:44:45 +00004805Now we can explain tz.fromutc(x). Let's assume it's an interesting case
Tim Petersf3615152003-01-01 21:51:37 +00004806(meaning that the various tzinfo methods exist, and don't blow up or return
4807None when called).
4808
Tim Petersa9bc1682003-01-11 03:39:11 +00004809The function wants to return a datetime y with timezone tz, equivalent to x.
Tim Peters8bb5ad22003-01-24 02:44:45 +00004810x is already in UTC.
Tim Petersf3615152003-01-01 21:51:37 +00004811
4812By #3, we want
4813
Tim Peters8bb5ad22003-01-24 02:44:45 +00004814 y.n - y.o = x.n [1]
Tim Petersf3615152003-01-01 21:51:37 +00004815
4816The algorithm starts by attaching tz to x.n, and calling that y. So
4817x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
4818becomes true; in effect, we want to solve [2] for k:
4819
Tim Peters8bb5ad22003-01-24 02:44:45 +00004820 (y+k).n - (y+k).o = x.n [2]
Tim Petersf3615152003-01-01 21:51:37 +00004821
4822By #1, this is the same as
4823
Tim Peters8bb5ad22003-01-24 02:44:45 +00004824 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
Tim Petersf3615152003-01-01 21:51:37 +00004825
4826By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
4827Substituting that into [3],
4828
Tim Peters8bb5ad22003-01-24 02:44:45 +00004829 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
4830 k - (y+k).s - (y+k).d = 0; rearranging,
4831 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
4832 k = y.s - (y+k).d
Tim Petersf3615152003-01-01 21:51:37 +00004833
Tim Peters8bb5ad22003-01-24 02:44:45 +00004834On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
4835approximate k by ignoring the (y+k).d term at first. Note that k can't be
4836very large, since all offset-returning methods return a duration of magnitude
4837less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
4838be 0, so ignoring it has no consequence then.
Tim Petersf3615152003-01-01 21:51:37 +00004839
4840In any case, the new value is
4841
Tim Peters8bb5ad22003-01-24 02:44:45 +00004842 z = y + y.s [4]
Tim Petersf3615152003-01-01 21:51:37 +00004843
Tim Peters8bb5ad22003-01-24 02:44:45 +00004844It's helpful to step back at look at [4] from a higher level: it's simply
4845mapping from UTC to tz's standard time.
Tim Petersc5dc4da2003-01-02 17:55:03 +00004846
4847At this point, if
4848
Tim Peters8bb5ad22003-01-24 02:44:45 +00004849 z.n - z.o = x.n [5]
Tim Petersc5dc4da2003-01-02 17:55:03 +00004850
4851we have an equivalent time, and are almost done. The insecurity here is
Tim Petersf3615152003-01-01 21:51:37 +00004852at the start of daylight time. Picture US Eastern for concreteness. The wall
4853time 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 +00004854sense then. The docs ask that an Eastern tzinfo class consider such a time to
4855be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
4856on the day DST starts. We want to return the 1:MM EST spelling because that's
Tim Petersf3615152003-01-01 21:51:37 +00004857the only spelling that makes sense on the local wall clock.
4858
Tim Petersc5dc4da2003-01-02 17:55:03 +00004859In fact, if [5] holds at this point, we do have the standard-time spelling,
4860but that takes a bit of proof. We first prove a stronger result. What's the
4861difference between the LHS and RHS of [5]? Let
Tim Petersf3615152003-01-01 21:51:37 +00004862
Tim Peters8bb5ad22003-01-24 02:44:45 +00004863 diff = x.n - (z.n - z.o) [6]
Tim Petersf3615152003-01-01 21:51:37 +00004864
Tim Petersc5dc4da2003-01-02 17:55:03 +00004865Now
4866 z.n = by [4]
Tim Peters8bb5ad22003-01-24 02:44:45 +00004867 (y + y.s).n = by #5
4868 y.n + y.s = since y.n = x.n
4869 x.n + y.s = since z and y are have the same tzinfo member,
4870 y.s = z.s by #2
4871 x.n + z.s
Tim Petersf3615152003-01-01 21:51:37 +00004872
Tim Petersc5dc4da2003-01-02 17:55:03 +00004873Plugging that back into [6] gives
Tim Petersf3615152003-01-01 21:51:37 +00004874
Tim Petersc5dc4da2003-01-02 17:55:03 +00004875 diff =
Tim Peters8bb5ad22003-01-24 02:44:45 +00004876 x.n - ((x.n + z.s) - z.o) = expanding
4877 x.n - x.n - z.s + z.o = cancelling
4878 - z.s + z.o = by #2
Tim Petersc5dc4da2003-01-02 17:55:03 +00004879 z.d
Tim Petersf3615152003-01-01 21:51:37 +00004880
Tim Petersc5dc4da2003-01-02 17:55:03 +00004881So diff = z.d.
Tim Petersf3615152003-01-01 21:51:37 +00004882
Tim Petersc5dc4da2003-01-02 17:55:03 +00004883If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
Tim Peters8bb5ad22003-01-24 02:44:45 +00004884spelling we wanted in the endcase described above. We're done. Contrarily,
4885if z.d = 0, then we have a UTC equivalent, and are also done.
Tim Petersf3615152003-01-01 21:51:37 +00004886
Tim Petersc5dc4da2003-01-02 17:55:03 +00004887If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
4888add to z (in effect, z is in tz's standard time, and we need to shift the
Tim Peters8bb5ad22003-01-24 02:44:45 +00004889local clock into tz's daylight time).
Tim Petersf3615152003-01-01 21:51:37 +00004890
Tim Petersc5dc4da2003-01-02 17:55:03 +00004891Let
Tim Petersf3615152003-01-01 21:51:37 +00004892
Tim Peters4fede1a2003-01-04 00:26:59 +00004893 z' = z + z.d = z + diff [7]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004894
Tim Peters4fede1a2003-01-04 00:26:59 +00004895and we can again ask whether
Tim Petersc3bb26a2003-01-02 03:14:59 +00004896
Tim Peters8bb5ad22003-01-24 02:44:45 +00004897 z'.n - z'.o = x.n [8]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004898
Tim Peters8bb5ad22003-01-24 02:44:45 +00004899If so, we're done. If not, the tzinfo class is insane, according to the
4900assumptions we've made. This also requires a bit of proof. As before, let's
4901compute the difference between the LHS and RHS of [8] (and skipping some of
4902the justifications for the kinds of substitutions we've done several times
4903already):
Tim Peters4fede1a2003-01-04 00:26:59 +00004904
Tim Peters8bb5ad22003-01-24 02:44:45 +00004905 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
4906 x.n - (z.n + diff - z'.o) = replacing diff via [6]
4907 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
4908 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
4909 - z.n + z.n - z.o + z'.o = cancel z.n
Tim Peters4fede1a2003-01-04 00:26:59 +00004910 - z.o + z'.o = #1 twice
4911 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
4912 z'.d - z.d
4913
4914So 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 +00004915we've found the UTC-equivalent so are done. In fact, we stop with [7] and
4916return z', not bothering to compute z'.d.
Tim Peters4fede1a2003-01-04 00:26:59 +00004917
Tim Peters8bb5ad22003-01-24 02:44:45 +00004918How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
4919a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
4920would have to change the result dst() returns: we start in DST, and moving
4921a little further into it takes us out of DST.
Tim Peters4fede1a2003-01-04 00:26:59 +00004922
Tim Peters8bb5ad22003-01-24 02:44:45 +00004923There isn't a sane case where this can happen. The closest it gets is at
4924the end of DST, where there's an hour in UTC with no spelling in a hybrid
4925tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
4926that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
4927UTC) because the docs insist on that, but 0:MM is taken as being in daylight
4928time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
4929clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
4930standard time. Since that's what the local clock *does*, we want to map both
4931UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
Tim Peters4fede1a2003-01-04 00:26:59 +00004932in local time, but so it goes -- it's the way the local clock works.
4933
Tim Peters8bb5ad22003-01-24 02:44:45 +00004934When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
4935so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
4936z' = 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 +00004937(correctly) concludes that z' is not UTC-equivalent to x.
4938
4939Because we know z.d said z was in daylight time (else [5] would have held and
4940we would have stopped then), and we know z.d != z'.d (else [8] would have held
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00004941and we would have stopped then), and there are only 2 possible values dst() can
Tim Peters4fede1a2003-01-04 00:26:59 +00004942return in Eastern, it follows that z'.d must be 0 (which it is in the example,
4943but the reasoning doesn't depend on the example -- it depends on there being
4944two possible dst() outcomes, one zero and the other non-zero). Therefore
Tim Peters8bb5ad22003-01-24 02:44:45 +00004945z' must be in standard time, and is the spelling we want in this case.
4946
4947Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
4948concerned (because it takes z' as being in standard time rather than the
4949daylight time we intend here), but returning it gives the real-life "local
4950clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
4951tz.
4952
4953When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
4954the 1:MM standard time spelling we want.
4955
4956So how can this break? One of the assumptions must be violated. Two
4957possibilities:
4958
49591) [2] effectively says that y.s is invariant across all y belong to a given
4960 time zone. This isn't true if, for political reasons or continental drift,
4961 a region decides to change its base offset from UTC.
4962
49632) There may be versions of "double daylight" time where the tail end of
4964 the analysis gives up a step too early. I haven't thought about that
4965 enough to say.
4966
4967In any case, it's clear that the default fromutc() is strong enough to handle
4968"almost all" time zones: so long as the standard offset is invariant, it
4969doesn't matter if daylight time transition points change from year to year, or
4970if daylight time is skipped in some years; it doesn't matter how large or
4971small dst() may get within its bounds; and it doesn't even matter if some
4972perverse time zone returns a negative dst()). So a breaking case must be
4973pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
Tim Petersf3615152003-01-01 21:51:37 +00004974--------------------------------------------------------------------------- */