blob: c1a0cb3171ba2aee770e71b9fa6c8cfc693420f2 [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);
1231 ptoappend = PyString_AsString(zreplacement);
1232 ntoappend = PyString_Size(zreplacement);
1233 }
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;
1260 }
1261 else
1262 Py_DECREF(temp);
1263 }
1264 }
1265 assert(Zreplacement != NULL);
1266 ptoappend = PyString_AsString(Zreplacement);
1267 ntoappend = PyString_Size(Zreplacement);
1268 }
1269 else {
Tim Peters328fff72002-12-20 01:31:27 +00001270 /* percent followed by neither z nor Z */
1271 ptoappend = pin - 2;
Tim Peters2a799bf2002-12-16 20:18:38 +00001272 ntoappend = 2;
1273 }
1274
1275 /* Append the ntoappend chars starting at ptoappend to
1276 * the new format.
1277 */
1278 assert(ntoappend >= 0);
1279 if (ntoappend == 0)
1280 continue;
1281 while (usednew + ntoappend > totalnew) {
1282 int bigger = totalnew << 1;
1283 if ((bigger >> 1) != totalnew) { /* overflow */
1284 PyErr_NoMemory();
1285 goto Done;
1286 }
1287 if (_PyString_Resize(&newfmt, bigger) < 0)
1288 goto Done;
1289 totalnew = bigger;
1290 pnew = PyString_AsString(newfmt) + usednew;
1291 }
1292 memcpy(pnew, ptoappend, ntoappend);
1293 pnew += ntoappend;
1294 usednew += ntoappend;
1295 assert(usednew <= totalnew);
1296 } /* end while() */
1297
1298 if (_PyString_Resize(&newfmt, usednew) < 0)
1299 goto Done;
1300 {
1301 PyObject *time = PyImport_ImportModule("time");
1302 if (time == NULL)
1303 goto Done;
1304 result = PyObject_CallMethod(time, "strftime", "OO",
1305 newfmt, timetuple);
1306 Py_DECREF(time);
1307 }
1308 Done:
1309 Py_XDECREF(zreplacement);
1310 Py_XDECREF(Zreplacement);
1311 Py_XDECREF(newfmt);
1312 return result;
1313}
1314
1315static char *
1316isoformat_date(PyDateTime_Date *dt, char buffer[], int bufflen)
1317{
1318 int x;
1319 x = PyOS_snprintf(buffer, bufflen,
1320 "%04d-%02d-%02d",
1321 GET_YEAR(dt), GET_MONTH(dt), GET_DAY(dt));
1322 return buffer + x;
1323}
1324
1325static void
1326isoformat_time(PyDateTime_DateTime *dt, char buffer[], int bufflen)
1327{
1328 int us = DATE_GET_MICROSECOND(dt);
1329
1330 PyOS_snprintf(buffer, bufflen,
1331 "%02d:%02d:%02d", /* 8 characters */
1332 DATE_GET_HOUR(dt),
1333 DATE_GET_MINUTE(dt),
1334 DATE_GET_SECOND(dt));
1335 if (us)
1336 PyOS_snprintf(buffer + 8, bufflen - 8, ".%06d", us);
1337}
1338
1339/* ---------------------------------------------------------------------------
1340 * Wrap functions from the time module. These aren't directly available
1341 * from C. Perhaps they should be.
1342 */
1343
1344/* Call time.time() and return its result (a Python float). */
1345static PyObject *
Guido van Rossumbd43e912002-12-16 20:34:55 +00001346time_time(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00001347{
1348 PyObject *result = NULL;
1349 PyObject *time = PyImport_ImportModule("time");
1350
1351 if (time != NULL) {
1352 result = PyObject_CallMethod(time, "time", "()");
1353 Py_DECREF(time);
1354 }
1355 return result;
1356}
1357
1358/* Build a time.struct_time. The weekday and day number are automatically
1359 * computed from the y,m,d args.
1360 */
1361static PyObject *
1362build_struct_time(int y, int m, int d, int hh, int mm, int ss, int dstflag)
1363{
1364 PyObject *time;
1365 PyObject *result = NULL;
1366
1367 time = PyImport_ImportModule("time");
1368 if (time != NULL) {
1369 result = PyObject_CallMethod(time, "struct_time",
1370 "((iiiiiiiii))",
1371 y, m, d,
1372 hh, mm, ss,
1373 weekday(y, m, d),
1374 days_before_month(y, m) + d,
1375 dstflag);
1376 Py_DECREF(time);
1377 }
1378 return result;
1379}
1380
1381/* ---------------------------------------------------------------------------
1382 * Miscellaneous helpers.
1383 */
1384
1385/* For obscure reasons, we need to use tp_richcompare instead of tp_compare.
1386 * The comparisons here all most naturally compute a cmp()-like result.
1387 * This little helper turns that into a bool result for rich comparisons.
1388 */
1389static PyObject *
1390diff_to_bool(int diff, int op)
1391{
1392 PyObject *result;
1393 int istrue;
1394
1395 switch (op) {
1396 case Py_EQ: istrue = diff == 0; break;
1397 case Py_NE: istrue = diff != 0; break;
1398 case Py_LE: istrue = diff <= 0; break;
1399 case Py_GE: istrue = diff >= 0; break;
1400 case Py_LT: istrue = diff < 0; break;
1401 case Py_GT: istrue = diff > 0; break;
1402 default:
1403 assert(! "op unknown");
1404 istrue = 0; /* To shut up compiler */
1405 }
1406 result = istrue ? Py_True : Py_False;
1407 Py_INCREF(result);
1408 return result;
1409}
1410
Tim Peters07534a62003-02-07 22:50:28 +00001411/* Raises a "can't compare" TypeError and returns NULL. */
1412static PyObject *
1413cmperror(PyObject *a, PyObject *b)
1414{
1415 PyErr_Format(PyExc_TypeError,
1416 "can't compare %s to %s",
1417 a->ob_type->tp_name, b->ob_type->tp_name);
1418 return NULL;
1419}
1420
Tim Peters2a799bf2002-12-16 20:18:38 +00001421/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +00001422 * Cached Python objects; these are set by the module init function.
1423 */
1424
1425/* Conversion factors. */
1426static PyObject *us_per_us = NULL; /* 1 */
1427static PyObject *us_per_ms = NULL; /* 1000 */
1428static PyObject *us_per_second = NULL; /* 1000000 */
1429static PyObject *us_per_minute = NULL; /* 1e6 * 60 as Python int */
1430static PyObject *us_per_hour = NULL; /* 1e6 * 3600 as Python long */
1431static PyObject *us_per_day = NULL; /* 1e6 * 3600 * 24 as Python long */
1432static PyObject *us_per_week = NULL; /* 1e6*3600*24*7 as Python long */
1433static PyObject *seconds_per_day = NULL; /* 3600*24 as Python int */
1434
Tim Peters2a799bf2002-12-16 20:18:38 +00001435/* ---------------------------------------------------------------------------
1436 * Class implementations.
1437 */
1438
1439/*
1440 * PyDateTime_Delta implementation.
1441 */
1442
1443/* Convert a timedelta to a number of us,
1444 * (24*3600*self.days + self.seconds)*1000000 + self.microseconds
1445 * as a Python int or long.
1446 * Doing mixed-radix arithmetic by hand instead is excruciating in C,
1447 * due to ubiquitous overflow possibilities.
1448 */
1449static PyObject *
1450delta_to_microseconds(PyDateTime_Delta *self)
1451{
1452 PyObject *x1 = NULL;
1453 PyObject *x2 = NULL;
1454 PyObject *x3 = NULL;
1455 PyObject *result = NULL;
1456
1457 x1 = PyInt_FromLong(GET_TD_DAYS(self));
1458 if (x1 == NULL)
1459 goto Done;
1460 x2 = PyNumber_Multiply(x1, seconds_per_day); /* days in seconds */
1461 if (x2 == NULL)
1462 goto Done;
1463 Py_DECREF(x1);
1464 x1 = NULL;
1465
1466 /* x2 has days in seconds */
1467 x1 = PyInt_FromLong(GET_TD_SECONDS(self)); /* seconds */
1468 if (x1 == NULL)
1469 goto Done;
1470 x3 = PyNumber_Add(x1, x2); /* days and seconds in seconds */
1471 if (x3 == NULL)
1472 goto Done;
1473 Py_DECREF(x1);
1474 Py_DECREF(x2);
1475 x1 = x2 = NULL;
1476
1477 /* x3 has days+seconds in seconds */
1478 x1 = PyNumber_Multiply(x3, us_per_second); /* us */
1479 if (x1 == NULL)
1480 goto Done;
1481 Py_DECREF(x3);
1482 x3 = NULL;
1483
1484 /* x1 has days+seconds in us */
1485 x2 = PyInt_FromLong(GET_TD_MICROSECONDS(self));
1486 if (x2 == NULL)
1487 goto Done;
1488 result = PyNumber_Add(x1, x2);
1489
1490Done:
1491 Py_XDECREF(x1);
1492 Py_XDECREF(x2);
1493 Py_XDECREF(x3);
1494 return result;
1495}
1496
1497/* Convert a number of us (as a Python int or long) to a timedelta.
1498 */
1499static PyObject *
Tim Petersb0c854d2003-05-17 15:57:00 +00001500microseconds_to_delta_ex(PyObject *pyus, PyTypeObject *type)
Tim Peters2a799bf2002-12-16 20:18:38 +00001501{
1502 int us;
1503 int s;
1504 int d;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001505 long temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001506
1507 PyObject *tuple = NULL;
1508 PyObject *num = NULL;
1509 PyObject *result = NULL;
1510
1511 tuple = PyNumber_Divmod(pyus, us_per_second);
1512 if (tuple == NULL)
1513 goto Done;
1514
1515 num = PyTuple_GetItem(tuple, 1); /* us */
1516 if (num == NULL)
1517 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001518 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001519 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001520 if (temp == -1 && PyErr_Occurred())
1521 goto Done;
1522 assert(0 <= temp && temp < 1000000);
1523 us = (int)temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001524 if (us < 0) {
1525 /* The divisor was positive, so this must be an error. */
1526 assert(PyErr_Occurred());
1527 goto Done;
1528 }
1529
1530 num = PyTuple_GetItem(tuple, 0); /* leftover seconds */
1531 if (num == NULL)
1532 goto Done;
1533 Py_INCREF(num);
1534 Py_DECREF(tuple);
1535
1536 tuple = PyNumber_Divmod(num, seconds_per_day);
1537 if (tuple == NULL)
1538 goto Done;
1539 Py_DECREF(num);
1540
1541 num = PyTuple_GetItem(tuple, 1); /* seconds */
1542 if (num == NULL)
1543 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001544 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001545 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001546 if (temp == -1 && PyErr_Occurred())
1547 goto Done;
1548 assert(0 <= temp && temp < 24*3600);
1549 s = (int)temp;
1550
Tim Peters2a799bf2002-12-16 20:18:38 +00001551 if (s < 0) {
1552 /* The divisor was positive, so this must be an error. */
1553 assert(PyErr_Occurred());
1554 goto Done;
1555 }
1556
1557 num = PyTuple_GetItem(tuple, 0); /* leftover days */
1558 if (num == NULL)
1559 goto Done;
1560 Py_INCREF(num);
Tim Peters0b0f41c2002-12-19 01:44:38 +00001561 temp = PyLong_AsLong(num);
1562 if (temp == -1 && PyErr_Occurred())
Tim Peters2a799bf2002-12-16 20:18:38 +00001563 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001564 d = (int)temp;
1565 if ((long)d != temp) {
1566 PyErr_SetString(PyExc_OverflowError, "normalized days too "
1567 "large to fit in a C int");
1568 goto Done;
1569 }
Tim Petersb0c854d2003-05-17 15:57:00 +00001570 result = new_delta_ex(d, s, us, 0, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001571
1572Done:
1573 Py_XDECREF(tuple);
1574 Py_XDECREF(num);
1575 return result;
1576}
1577
Tim Petersb0c854d2003-05-17 15:57:00 +00001578#define microseconds_to_delta(pymicros) \
1579 microseconds_to_delta_ex(pymicros, &PyDateTime_DeltaType)
1580
Tim Peters2a799bf2002-12-16 20:18:38 +00001581static PyObject *
1582multiply_int_timedelta(PyObject *intobj, PyDateTime_Delta *delta)
1583{
1584 PyObject *pyus_in;
1585 PyObject *pyus_out;
1586 PyObject *result;
1587
1588 pyus_in = delta_to_microseconds(delta);
1589 if (pyus_in == NULL)
1590 return NULL;
1591
1592 pyus_out = PyNumber_Multiply(pyus_in, intobj);
1593 Py_DECREF(pyus_in);
1594 if (pyus_out == NULL)
1595 return NULL;
1596
1597 result = microseconds_to_delta(pyus_out);
1598 Py_DECREF(pyus_out);
1599 return result;
1600}
1601
1602static PyObject *
1603divide_timedelta_int(PyDateTime_Delta *delta, PyObject *intobj)
1604{
1605 PyObject *pyus_in;
1606 PyObject *pyus_out;
1607 PyObject *result;
1608
1609 pyus_in = delta_to_microseconds(delta);
1610 if (pyus_in == NULL)
1611 return NULL;
1612
1613 pyus_out = PyNumber_FloorDivide(pyus_in, intobj);
1614 Py_DECREF(pyus_in);
1615 if (pyus_out == NULL)
1616 return NULL;
1617
1618 result = microseconds_to_delta(pyus_out);
1619 Py_DECREF(pyus_out);
1620 return result;
1621}
1622
1623static PyObject *
1624delta_add(PyObject *left, PyObject *right)
1625{
1626 PyObject *result = Py_NotImplemented;
1627
1628 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1629 /* delta + delta */
1630 /* The C-level additions can't overflow because of the
1631 * invariant bounds.
1632 */
1633 int days = GET_TD_DAYS(left) + GET_TD_DAYS(right);
1634 int seconds = GET_TD_SECONDS(left) + GET_TD_SECONDS(right);
1635 int microseconds = GET_TD_MICROSECONDS(left) +
1636 GET_TD_MICROSECONDS(right);
1637 result = new_delta(days, seconds, microseconds, 1);
1638 }
1639
1640 if (result == Py_NotImplemented)
1641 Py_INCREF(result);
1642 return result;
1643}
1644
1645static PyObject *
1646delta_negative(PyDateTime_Delta *self)
1647{
1648 return new_delta(-GET_TD_DAYS(self),
1649 -GET_TD_SECONDS(self),
1650 -GET_TD_MICROSECONDS(self),
1651 1);
1652}
1653
1654static PyObject *
1655delta_positive(PyDateTime_Delta *self)
1656{
1657 /* Could optimize this (by returning self) if this isn't a
1658 * subclass -- but who uses unary + ? Approximately nobody.
1659 */
1660 return new_delta(GET_TD_DAYS(self),
1661 GET_TD_SECONDS(self),
1662 GET_TD_MICROSECONDS(self),
1663 0);
1664}
1665
1666static PyObject *
1667delta_abs(PyDateTime_Delta *self)
1668{
1669 PyObject *result;
1670
1671 assert(GET_TD_MICROSECONDS(self) >= 0);
1672 assert(GET_TD_SECONDS(self) >= 0);
1673
1674 if (GET_TD_DAYS(self) < 0)
1675 result = delta_negative(self);
1676 else
1677 result = delta_positive(self);
1678
1679 return result;
1680}
1681
1682static PyObject *
1683delta_subtract(PyObject *left, PyObject *right)
1684{
1685 PyObject *result = Py_NotImplemented;
1686
1687 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1688 /* delta - delta */
1689 PyObject *minus_right = PyNumber_Negative(right);
1690 if (minus_right) {
1691 result = delta_add(left, minus_right);
1692 Py_DECREF(minus_right);
1693 }
1694 else
1695 result = NULL;
1696 }
1697
1698 if (result == Py_NotImplemented)
1699 Py_INCREF(result);
1700 return result;
1701}
1702
1703/* This is more natural as a tp_compare, but doesn't work then: for whatever
1704 * reason, Python's try_3way_compare ignores tp_compare unless
1705 * PyInstance_Check returns true, but these aren't old-style classes.
1706 */
1707static PyObject *
1708delta_richcompare(PyDateTime_Delta *self, PyObject *other, int op)
1709{
Tim Peters07534a62003-02-07 22:50:28 +00001710 int diff = 42; /* nonsense */
Tim Peters2a799bf2002-12-16 20:18:38 +00001711
Tim Petersaa7d8492003-02-08 03:28:59 +00001712 if (PyDelta_Check(other)) {
Tim Peters07534a62003-02-07 22:50:28 +00001713 diff = GET_TD_DAYS(self) - GET_TD_DAYS(other);
1714 if (diff == 0) {
1715 diff = GET_TD_SECONDS(self) - GET_TD_SECONDS(other);
1716 if (diff == 0)
1717 diff = GET_TD_MICROSECONDS(self) -
1718 GET_TD_MICROSECONDS(other);
1719 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001720 }
Tim Peters07534a62003-02-07 22:50:28 +00001721 else if (op == Py_EQ || op == Py_NE)
1722 diff = 1; /* any non-zero value will do */
1723
1724 else /* stop this from falling back to address comparison */
1725 return cmperror((PyObject *)self, other);
1726
Tim Peters2a799bf2002-12-16 20:18:38 +00001727 return diff_to_bool(diff, op);
1728}
1729
1730static PyObject *delta_getstate(PyDateTime_Delta *self);
1731
1732static long
1733delta_hash(PyDateTime_Delta *self)
1734{
1735 if (self->hashcode == -1) {
1736 PyObject *temp = delta_getstate(self);
1737 if (temp != NULL) {
1738 self->hashcode = PyObject_Hash(temp);
1739 Py_DECREF(temp);
1740 }
1741 }
1742 return self->hashcode;
1743}
1744
1745static PyObject *
1746delta_multiply(PyObject *left, PyObject *right)
1747{
1748 PyObject *result = Py_NotImplemented;
1749
1750 if (PyDelta_Check(left)) {
1751 /* delta * ??? */
1752 if (PyInt_Check(right) || PyLong_Check(right))
1753 result = multiply_int_timedelta(right,
1754 (PyDateTime_Delta *) left);
1755 }
1756 else if (PyInt_Check(left) || PyLong_Check(left))
1757 result = multiply_int_timedelta(left,
1758 (PyDateTime_Delta *) right);
1759
1760 if (result == Py_NotImplemented)
1761 Py_INCREF(result);
1762 return result;
1763}
1764
1765static PyObject *
1766delta_divide(PyObject *left, PyObject *right)
1767{
1768 PyObject *result = Py_NotImplemented;
1769
1770 if (PyDelta_Check(left)) {
1771 /* delta * ??? */
1772 if (PyInt_Check(right) || PyLong_Check(right))
1773 result = divide_timedelta_int(
1774 (PyDateTime_Delta *)left,
1775 right);
1776 }
1777
1778 if (result == Py_NotImplemented)
1779 Py_INCREF(result);
1780 return result;
1781}
1782
1783/* Fold in the value of the tag ("seconds", "weeks", etc) component of a
1784 * timedelta constructor. sofar is the # of microseconds accounted for
1785 * so far, and there are factor microseconds per current unit, the number
1786 * of which is given by num. num * factor is added to sofar in a
1787 * numerically careful way, and that's the result. Any fractional
1788 * microseconds left over (this can happen if num is a float type) are
1789 * added into *leftover.
1790 * Note that there are many ways this can give an error (NULL) return.
1791 */
1792static PyObject *
1793accum(const char* tag, PyObject *sofar, PyObject *num, PyObject *factor,
1794 double *leftover)
1795{
1796 PyObject *prod;
1797 PyObject *sum;
1798
1799 assert(num != NULL);
1800
1801 if (PyInt_Check(num) || PyLong_Check(num)) {
1802 prod = PyNumber_Multiply(num, factor);
1803 if (prod == NULL)
1804 return NULL;
1805 sum = PyNumber_Add(sofar, prod);
1806 Py_DECREF(prod);
1807 return sum;
1808 }
1809
1810 if (PyFloat_Check(num)) {
1811 double dnum;
1812 double fracpart;
1813 double intpart;
1814 PyObject *x;
1815 PyObject *y;
1816
1817 /* The Plan: decompose num into an integer part and a
1818 * fractional part, num = intpart + fracpart.
1819 * Then num * factor ==
1820 * intpart * factor + fracpart * factor
1821 * and the LHS can be computed exactly in long arithmetic.
1822 * The RHS is again broken into an int part and frac part.
1823 * and the frac part is added into *leftover.
1824 */
1825 dnum = PyFloat_AsDouble(num);
1826 if (dnum == -1.0 && PyErr_Occurred())
1827 return NULL;
1828 fracpart = modf(dnum, &intpart);
1829 x = PyLong_FromDouble(intpart);
1830 if (x == NULL)
1831 return NULL;
1832
1833 prod = PyNumber_Multiply(x, factor);
1834 Py_DECREF(x);
1835 if (prod == NULL)
1836 return NULL;
1837
1838 sum = PyNumber_Add(sofar, prod);
1839 Py_DECREF(prod);
1840 if (sum == NULL)
1841 return NULL;
1842
1843 if (fracpart == 0.0)
1844 return sum;
1845 /* So far we've lost no information. Dealing with the
1846 * fractional part requires float arithmetic, and may
1847 * lose a little info.
1848 */
1849 assert(PyInt_Check(factor) || PyLong_Check(factor));
1850 if (PyInt_Check(factor))
1851 dnum = (double)PyInt_AsLong(factor);
1852 else
1853 dnum = PyLong_AsDouble(factor);
1854
1855 dnum *= fracpart;
1856 fracpart = modf(dnum, &intpart);
1857 x = PyLong_FromDouble(intpart);
1858 if (x == NULL) {
1859 Py_DECREF(sum);
1860 return NULL;
1861 }
1862
1863 y = PyNumber_Add(sum, x);
1864 Py_DECREF(sum);
1865 Py_DECREF(x);
1866 *leftover += fracpart;
1867 return y;
1868 }
1869
1870 PyErr_Format(PyExc_TypeError,
1871 "unsupported type for timedelta %s component: %s",
1872 tag, num->ob_type->tp_name);
1873 return NULL;
1874}
1875
1876static PyObject *
1877delta_new(PyTypeObject *type, PyObject *args, PyObject *kw)
1878{
1879 PyObject *self = NULL;
1880
1881 /* Argument objects. */
1882 PyObject *day = NULL;
1883 PyObject *second = NULL;
1884 PyObject *us = NULL;
1885 PyObject *ms = NULL;
1886 PyObject *minute = NULL;
1887 PyObject *hour = NULL;
1888 PyObject *week = NULL;
1889
1890 PyObject *x = NULL; /* running sum of microseconds */
1891 PyObject *y = NULL; /* temp sum of microseconds */
1892 double leftover_us = 0.0;
1893
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00001894 static char *keywords[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001895 "days", "seconds", "microseconds", "milliseconds",
1896 "minutes", "hours", "weeks", NULL
1897 };
1898
1899 if (PyArg_ParseTupleAndKeywords(args, kw, "|OOOOOOO:__new__",
1900 keywords,
1901 &day, &second, &us,
1902 &ms, &minute, &hour, &week) == 0)
1903 goto Done;
1904
1905 x = PyInt_FromLong(0);
1906 if (x == NULL)
1907 goto Done;
1908
1909#define CLEANUP \
1910 Py_DECREF(x); \
1911 x = y; \
1912 if (x == NULL) \
1913 goto Done
1914
1915 if (us) {
1916 y = accum("microseconds", x, us, us_per_us, &leftover_us);
1917 CLEANUP;
1918 }
1919 if (ms) {
1920 y = accum("milliseconds", x, ms, us_per_ms, &leftover_us);
1921 CLEANUP;
1922 }
1923 if (second) {
1924 y = accum("seconds", x, second, us_per_second, &leftover_us);
1925 CLEANUP;
1926 }
1927 if (minute) {
1928 y = accum("minutes", x, minute, us_per_minute, &leftover_us);
1929 CLEANUP;
1930 }
1931 if (hour) {
1932 y = accum("hours", x, hour, us_per_hour, &leftover_us);
1933 CLEANUP;
1934 }
1935 if (day) {
1936 y = accum("days", x, day, us_per_day, &leftover_us);
1937 CLEANUP;
1938 }
1939 if (week) {
1940 y = accum("weeks", x, week, us_per_week, &leftover_us);
1941 CLEANUP;
1942 }
1943 if (leftover_us) {
1944 /* Round to nearest whole # of us, and add into x. */
Tim Peters5d644dd2003-01-02 16:32:54 +00001945 PyObject *temp = PyLong_FromLong(round_to_long(leftover_us));
Tim Peters2a799bf2002-12-16 20:18:38 +00001946 if (temp == NULL) {
1947 Py_DECREF(x);
1948 goto Done;
1949 }
1950 y = PyNumber_Add(x, temp);
1951 Py_DECREF(temp);
1952 CLEANUP;
1953 }
1954
Tim Petersb0c854d2003-05-17 15:57:00 +00001955 self = microseconds_to_delta_ex(x, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001956 Py_DECREF(x);
1957Done:
1958 return self;
1959
1960#undef CLEANUP
1961}
1962
1963static int
1964delta_nonzero(PyDateTime_Delta *self)
1965{
1966 return (GET_TD_DAYS(self) != 0
1967 || GET_TD_SECONDS(self) != 0
1968 || GET_TD_MICROSECONDS(self) != 0);
1969}
1970
1971static PyObject *
1972delta_repr(PyDateTime_Delta *self)
1973{
1974 if (GET_TD_MICROSECONDS(self) != 0)
1975 return PyString_FromFormat("%s(%d, %d, %d)",
1976 self->ob_type->tp_name,
1977 GET_TD_DAYS(self),
1978 GET_TD_SECONDS(self),
1979 GET_TD_MICROSECONDS(self));
1980 if (GET_TD_SECONDS(self) != 0)
1981 return PyString_FromFormat("%s(%d, %d)",
1982 self->ob_type->tp_name,
1983 GET_TD_DAYS(self),
1984 GET_TD_SECONDS(self));
1985
1986 return PyString_FromFormat("%s(%d)",
1987 self->ob_type->tp_name,
1988 GET_TD_DAYS(self));
1989}
1990
1991static PyObject *
1992delta_str(PyDateTime_Delta *self)
1993{
1994 int days = GET_TD_DAYS(self);
1995 int seconds = GET_TD_SECONDS(self);
1996 int us = GET_TD_MICROSECONDS(self);
1997 int hours;
1998 int minutes;
Tim Petersba873472002-12-18 20:19:21 +00001999 char buf[100];
2000 char *pbuf = buf;
2001 size_t buflen = sizeof(buf);
2002 int n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002003
2004 minutes = divmod(seconds, 60, &seconds);
2005 hours = divmod(minutes, 60, &minutes);
2006
2007 if (days) {
Tim Petersba873472002-12-18 20:19:21 +00002008 n = PyOS_snprintf(pbuf, buflen, "%d day%s, ", days,
2009 (days == 1 || days == -1) ? "" : "s");
2010 if (n < 0 || (size_t)n >= buflen)
2011 goto Fail;
2012 pbuf += n;
2013 buflen -= (size_t)n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002014 }
2015
Tim Petersba873472002-12-18 20:19:21 +00002016 n = PyOS_snprintf(pbuf, buflen, "%d:%02d:%02d",
2017 hours, minutes, seconds);
2018 if (n < 0 || (size_t)n >= buflen)
2019 goto Fail;
2020 pbuf += n;
2021 buflen -= (size_t)n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002022
2023 if (us) {
Tim Petersba873472002-12-18 20:19:21 +00002024 n = PyOS_snprintf(pbuf, buflen, ".%06d", us);
2025 if (n < 0 || (size_t)n >= buflen)
2026 goto Fail;
2027 pbuf += n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002028 }
2029
Tim Petersba873472002-12-18 20:19:21 +00002030 return PyString_FromStringAndSize(buf, pbuf - buf);
2031
2032 Fail:
2033 PyErr_SetString(PyExc_SystemError, "goofy result from PyOS_snprintf");
2034 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002035}
2036
Tim Peters371935f2003-02-01 01:52:50 +00002037/* Pickle support, a simple use of __reduce__. */
2038
Tim Petersb57f8f02003-02-01 02:54:15 +00002039/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002040static PyObject *
2041delta_getstate(PyDateTime_Delta *self)
2042{
2043 return Py_BuildValue("iii", GET_TD_DAYS(self),
2044 GET_TD_SECONDS(self),
2045 GET_TD_MICROSECONDS(self));
2046}
2047
Tim Peters2a799bf2002-12-16 20:18:38 +00002048static PyObject *
2049delta_reduce(PyDateTime_Delta* self)
2050{
Tim Peters8a60c222003-02-01 01:47:29 +00002051 return Py_BuildValue("ON", self->ob_type, delta_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002052}
2053
2054#define OFFSET(field) offsetof(PyDateTime_Delta, field)
2055
2056static PyMemberDef delta_members[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002057
Neal Norwitzdfb80862002-12-19 02:30:56 +00002058 {"days", T_INT, OFFSET(days), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002059 PyDoc_STR("Number of days.")},
2060
Neal Norwitzdfb80862002-12-19 02:30:56 +00002061 {"seconds", T_INT, OFFSET(seconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002062 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
2063
Neal Norwitzdfb80862002-12-19 02:30:56 +00002064 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002065 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
2066 {NULL}
2067};
2068
2069static PyMethodDef delta_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002070 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
2071 PyDoc_STR("__reduce__() -> (cls, state)")},
2072
Tim Peters2a799bf2002-12-16 20:18:38 +00002073 {NULL, NULL},
2074};
2075
2076static char delta_doc[] =
2077PyDoc_STR("Difference between two datetime values.");
2078
2079static PyNumberMethods delta_as_number = {
2080 delta_add, /* nb_add */
2081 delta_subtract, /* nb_subtract */
2082 delta_multiply, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00002083 0, /* nb_remainder */
2084 0, /* nb_divmod */
2085 0, /* nb_power */
2086 (unaryfunc)delta_negative, /* nb_negative */
2087 (unaryfunc)delta_positive, /* nb_positive */
2088 (unaryfunc)delta_abs, /* nb_absolute */
2089 (inquiry)delta_nonzero, /* nb_nonzero */
2090 0, /*nb_invert*/
2091 0, /*nb_lshift*/
2092 0, /*nb_rshift*/
2093 0, /*nb_and*/
2094 0, /*nb_xor*/
2095 0, /*nb_or*/
2096 0, /*nb_coerce*/
2097 0, /*nb_int*/
2098 0, /*nb_long*/
2099 0, /*nb_float*/
2100 0, /*nb_oct*/
2101 0, /*nb_hex*/
2102 0, /*nb_inplace_add*/
2103 0, /*nb_inplace_subtract*/
2104 0, /*nb_inplace_multiply*/
Tim Peters2a799bf2002-12-16 20:18:38 +00002105 0, /*nb_inplace_remainder*/
2106 0, /*nb_inplace_power*/
2107 0, /*nb_inplace_lshift*/
2108 0, /*nb_inplace_rshift*/
2109 0, /*nb_inplace_and*/
2110 0, /*nb_inplace_xor*/
2111 0, /*nb_inplace_or*/
2112 delta_divide, /* nb_floor_divide */
2113 0, /* nb_true_divide */
2114 0, /* nb_inplace_floor_divide */
2115 0, /* nb_inplace_true_divide */
2116};
2117
2118static PyTypeObject PyDateTime_DeltaType = {
2119 PyObject_HEAD_INIT(NULL)
2120 0, /* ob_size */
2121 "datetime.timedelta", /* tp_name */
2122 sizeof(PyDateTime_Delta), /* tp_basicsize */
2123 0, /* tp_itemsize */
2124 0, /* tp_dealloc */
2125 0, /* tp_print */
2126 0, /* tp_getattr */
2127 0, /* tp_setattr */
2128 0, /* tp_compare */
2129 (reprfunc)delta_repr, /* tp_repr */
2130 &delta_as_number, /* tp_as_number */
2131 0, /* tp_as_sequence */
2132 0, /* tp_as_mapping */
2133 (hashfunc)delta_hash, /* tp_hash */
2134 0, /* tp_call */
2135 (reprfunc)delta_str, /* tp_str */
2136 PyObject_GenericGetAttr, /* tp_getattro */
2137 0, /* tp_setattro */
2138 0, /* tp_as_buffer */
Tim Petersb0c854d2003-05-17 15:57:00 +00002139 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2140 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00002141 delta_doc, /* tp_doc */
2142 0, /* tp_traverse */
2143 0, /* tp_clear */
2144 (richcmpfunc)delta_richcompare, /* tp_richcompare */
2145 0, /* tp_weaklistoffset */
2146 0, /* tp_iter */
2147 0, /* tp_iternext */
2148 delta_methods, /* tp_methods */
2149 delta_members, /* tp_members */
2150 0, /* tp_getset */
2151 0, /* tp_base */
2152 0, /* tp_dict */
2153 0, /* tp_descr_get */
2154 0, /* tp_descr_set */
2155 0, /* tp_dictoffset */
2156 0, /* tp_init */
2157 0, /* tp_alloc */
2158 delta_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002159 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002160};
2161
2162/*
2163 * PyDateTime_Date implementation.
2164 */
2165
2166/* Accessor properties. */
2167
2168static PyObject *
2169date_year(PyDateTime_Date *self, void *unused)
2170{
2171 return PyInt_FromLong(GET_YEAR(self));
2172}
2173
2174static PyObject *
2175date_month(PyDateTime_Date *self, void *unused)
2176{
2177 return PyInt_FromLong(GET_MONTH(self));
2178}
2179
2180static PyObject *
2181date_day(PyDateTime_Date *self, void *unused)
2182{
2183 return PyInt_FromLong(GET_DAY(self));
2184}
2185
2186static PyGetSetDef date_getset[] = {
2187 {"year", (getter)date_year},
2188 {"month", (getter)date_month},
2189 {"day", (getter)date_day},
2190 {NULL}
2191};
2192
2193/* Constructors. */
2194
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002195static char *date_kws[] = {"year", "month", "day", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002196
Tim Peters2a799bf2002-12-16 20:18:38 +00002197static PyObject *
2198date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2199{
2200 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00002201 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00002202 int year;
2203 int month;
2204 int day;
2205
Guido van Rossum177e41a2003-01-30 22:06:23 +00002206 /* Check for invocation from pickle with __getstate__ state */
2207 if (PyTuple_GET_SIZE(args) == 1 &&
Tim Peters70533e22003-02-01 04:40:04 +00002208 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Tim Peters3f606292004-03-21 23:38:41 +00002209 PyString_GET_SIZE(state) == _PyDateTime_DATE_DATASIZE &&
2210 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00002211 {
Tim Peters70533e22003-02-01 04:40:04 +00002212 PyDateTime_Date *me;
2213
Tim Peters604c0132004-06-07 23:04:33 +00002214 me = (PyDateTime_Date *) (type->tp_alloc(type, 0));
Tim Peters70533e22003-02-01 04:40:04 +00002215 if (me != NULL) {
2216 char *pdata = PyString_AS_STRING(state);
2217 memcpy(me->data, pdata, _PyDateTime_DATE_DATASIZE);
2218 me->hashcode = -1;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002219 }
Tim Peters70533e22003-02-01 04:40:04 +00002220 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002221 }
2222
Tim Peters12bf3392002-12-24 05:41:27 +00002223 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00002224 &year, &month, &day)) {
2225 if (check_date_args(year, month, day) < 0)
2226 return NULL;
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002227 self = new_date_ex(year, month, day, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00002228 }
2229 return self;
2230}
2231
2232/* Return new date from localtime(t). */
2233static PyObject *
Tim Peters1b6f7a92004-06-20 02:50:16 +00002234date_local_from_time_t(PyObject *cls, double ts)
Tim Peters2a799bf2002-12-16 20:18:38 +00002235{
2236 struct tm *tm;
Tim Peters1b6f7a92004-06-20 02:50:16 +00002237 time_t t;
Tim Peters2a799bf2002-12-16 20:18:38 +00002238 PyObject *result = NULL;
2239
Tim Peters1b6f7a92004-06-20 02:50:16 +00002240 t = _PyTime_DoubleToTimet(ts);
2241 if (t == (time_t)-1 && PyErr_Occurred())
2242 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002243 tm = localtime(&t);
2244 if (tm)
2245 result = PyObject_CallFunction(cls, "iii",
2246 tm->tm_year + 1900,
2247 tm->tm_mon + 1,
2248 tm->tm_mday);
2249 else
2250 PyErr_SetString(PyExc_ValueError,
2251 "timestamp out of range for "
2252 "platform localtime() function");
2253 return result;
2254}
2255
2256/* Return new date from current time.
2257 * We say this is equivalent to fromtimestamp(time.time()), and the
2258 * only way to be sure of that is to *call* time.time(). That's not
2259 * generally the same as calling C's time.
2260 */
2261static PyObject *
2262date_today(PyObject *cls, PyObject *dummy)
2263{
2264 PyObject *time;
2265 PyObject *result;
2266
2267 time = time_time();
2268 if (time == NULL)
2269 return NULL;
2270
2271 /* Note well: today() is a class method, so this may not call
2272 * date.fromtimestamp. For example, it may call
2273 * datetime.fromtimestamp. That's why we need all the accuracy
2274 * time.time() delivers; if someone were gonzo about optimization,
2275 * date.today() could get away with plain C time().
2276 */
2277 result = PyObject_CallMethod(cls, "fromtimestamp", "O", time);
2278 Py_DECREF(time);
2279 return result;
2280}
2281
2282/* Return new date from given timestamp (Python timestamp -- a double). */
2283static PyObject *
2284date_fromtimestamp(PyObject *cls, PyObject *args)
2285{
2286 double timestamp;
2287 PyObject *result = NULL;
2288
2289 if (PyArg_ParseTuple(args, "d:fromtimestamp", &timestamp))
Tim Peters1b6f7a92004-06-20 02:50:16 +00002290 result = date_local_from_time_t(cls, timestamp);
Tim Peters2a799bf2002-12-16 20:18:38 +00002291 return result;
2292}
2293
2294/* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2295 * the ordinal is out of range.
2296 */
2297static PyObject *
2298date_fromordinal(PyObject *cls, PyObject *args)
2299{
2300 PyObject *result = NULL;
2301 int ordinal;
2302
2303 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2304 int year;
2305 int month;
2306 int day;
2307
2308 if (ordinal < 1)
2309 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2310 ">= 1");
2311 else {
2312 ord_to_ymd(ordinal, &year, &month, &day);
2313 result = PyObject_CallFunction(cls, "iii",
2314 year, month, day);
2315 }
2316 }
2317 return result;
2318}
2319
2320/*
2321 * Date arithmetic.
2322 */
2323
2324/* date + timedelta -> date. If arg negate is true, subtract the timedelta
2325 * instead.
2326 */
2327static PyObject *
2328add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
2329{
2330 PyObject *result = NULL;
2331 int year = GET_YEAR(date);
2332 int month = GET_MONTH(date);
2333 int deltadays = GET_TD_DAYS(delta);
2334 /* C-level overflow is impossible because |deltadays| < 1e9. */
2335 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
2336
2337 if (normalize_date(&year, &month, &day) >= 0)
2338 result = new_date(year, month, day);
2339 return result;
2340}
2341
2342static PyObject *
2343date_add(PyObject *left, PyObject *right)
2344{
2345 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2346 Py_INCREF(Py_NotImplemented);
2347 return Py_NotImplemented;
2348 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002349 if (PyDate_Check(left)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002350 /* date + ??? */
2351 if (PyDelta_Check(right))
2352 /* date + delta */
2353 return add_date_timedelta((PyDateTime_Date *) left,
2354 (PyDateTime_Delta *) right,
2355 0);
2356 }
2357 else {
2358 /* ??? + date
2359 * 'right' must be one of us, or we wouldn't have been called
2360 */
2361 if (PyDelta_Check(left))
2362 /* delta + date */
2363 return add_date_timedelta((PyDateTime_Date *) right,
2364 (PyDateTime_Delta *) left,
2365 0);
2366 }
2367 Py_INCREF(Py_NotImplemented);
2368 return Py_NotImplemented;
2369}
2370
2371static PyObject *
2372date_subtract(PyObject *left, PyObject *right)
2373{
2374 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2375 Py_INCREF(Py_NotImplemented);
2376 return Py_NotImplemented;
2377 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002378 if (PyDate_Check(left)) {
2379 if (PyDate_Check(right)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002380 /* date - date */
2381 int left_ord = ymd_to_ord(GET_YEAR(left),
2382 GET_MONTH(left),
2383 GET_DAY(left));
2384 int right_ord = ymd_to_ord(GET_YEAR(right),
2385 GET_MONTH(right),
2386 GET_DAY(right));
2387 return new_delta(left_ord - right_ord, 0, 0, 0);
2388 }
2389 if (PyDelta_Check(right)) {
2390 /* date - delta */
2391 return add_date_timedelta((PyDateTime_Date *) left,
2392 (PyDateTime_Delta *) right,
2393 1);
2394 }
2395 }
2396 Py_INCREF(Py_NotImplemented);
2397 return Py_NotImplemented;
2398}
2399
2400
2401/* Various ways to turn a date into a string. */
2402
2403static PyObject *
2404date_repr(PyDateTime_Date *self)
2405{
2406 char buffer[1028];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002407 const char *typename;
Tim Peters2a799bf2002-12-16 20:18:38 +00002408
2409 typename = self->ob_type->tp_name;
2410 PyOS_snprintf(buffer, sizeof(buffer), "%s(%d, %d, %d)",
2411 typename,
2412 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2413
2414 return PyString_FromString(buffer);
2415}
2416
2417static PyObject *
2418date_isoformat(PyDateTime_Date *self)
2419{
2420 char buffer[128];
2421
2422 isoformat_date(self, buffer, sizeof(buffer));
2423 return PyString_FromString(buffer);
2424}
2425
Tim Peterse2df5ff2003-05-02 18:39:55 +00002426/* str() calls the appropriate isoformat() method. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002427static PyObject *
2428date_str(PyDateTime_Date *self)
2429{
2430 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
2431}
2432
2433
2434static PyObject *
2435date_ctime(PyDateTime_Date *self)
2436{
2437 return format_ctime(self, 0, 0, 0);
2438}
2439
2440static PyObject *
2441date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2442{
2443 /* This method can be inherited, and needs to call the
2444 * timetuple() method appropriate to self's class.
2445 */
2446 PyObject *result;
2447 PyObject *format;
2448 PyObject *tuple;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002449 static char *keywords[] = {"format", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00002450
2451 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
2452 &PyString_Type, &format))
2453 return NULL;
2454
2455 tuple = PyObject_CallMethod((PyObject *)self, "timetuple", "()");
2456 if (tuple == NULL)
2457 return NULL;
Tim Petersbad8ff02002-12-30 20:52:32 +00002458 result = wrap_strftime((PyObject *)self, format, tuple,
2459 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002460 Py_DECREF(tuple);
2461 return result;
2462}
2463
2464/* ISO methods. */
2465
2466static PyObject *
2467date_isoweekday(PyDateTime_Date *self)
2468{
2469 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2470
2471 return PyInt_FromLong(dow + 1);
2472}
2473
2474static PyObject *
2475date_isocalendar(PyDateTime_Date *self)
2476{
2477 int year = GET_YEAR(self);
2478 int week1_monday = iso_week1_monday(year);
2479 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
2480 int week;
2481 int day;
2482
2483 week = divmod(today - week1_monday, 7, &day);
2484 if (week < 0) {
2485 --year;
2486 week1_monday = iso_week1_monday(year);
2487 week = divmod(today - week1_monday, 7, &day);
2488 }
2489 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
2490 ++year;
2491 week = 0;
2492 }
2493 return Py_BuildValue("iii", year, week + 1, day + 1);
2494}
2495
2496/* Miscellaneous methods. */
2497
2498/* This is more natural as a tp_compare, but doesn't work then: for whatever
2499 * reason, Python's try_3way_compare ignores tp_compare unless
2500 * PyInstance_Check returns true, but these aren't old-style classes.
2501 */
2502static PyObject *
2503date_richcompare(PyDateTime_Date *self, PyObject *other, int op)
2504{
Tim Peters07534a62003-02-07 22:50:28 +00002505 int diff = 42; /* nonsense */
Tim Peters2a799bf2002-12-16 20:18:38 +00002506
Tim Peters07534a62003-02-07 22:50:28 +00002507 if (PyDate_Check(other))
2508 diff = memcmp(self->data, ((PyDateTime_Date *)other)->data,
2509 _PyDateTime_DATE_DATASIZE);
2510
2511 else if (PyObject_HasAttrString(other, "timetuple")) {
2512 /* A hook for other kinds of date objects. */
2513 Py_INCREF(Py_NotImplemented);
2514 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002515 }
Tim Peters07534a62003-02-07 22:50:28 +00002516 else if (op == Py_EQ || op == Py_NE)
2517 diff = 1; /* any non-zero value will do */
2518
2519 else /* stop this from falling back to address comparison */
2520 return cmperror((PyObject *)self, other);
2521
Tim Peters2a799bf2002-12-16 20:18:38 +00002522 return diff_to_bool(diff, op);
2523}
2524
2525static PyObject *
2526date_timetuple(PyDateTime_Date *self)
2527{
2528 return build_struct_time(GET_YEAR(self),
2529 GET_MONTH(self),
2530 GET_DAY(self),
2531 0, 0, 0, -1);
2532}
2533
Tim Peters12bf3392002-12-24 05:41:27 +00002534static PyObject *
2535date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2536{
2537 PyObject *clone;
2538 PyObject *tuple;
2539 int year = GET_YEAR(self);
2540 int month = GET_MONTH(self);
2541 int day = GET_DAY(self);
2542
2543 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
2544 &year, &month, &day))
2545 return NULL;
2546 tuple = Py_BuildValue("iii", year, month, day);
2547 if (tuple == NULL)
2548 return NULL;
2549 clone = date_new(self->ob_type, tuple, NULL);
2550 Py_DECREF(tuple);
2551 return clone;
2552}
2553
Tim Peters2a799bf2002-12-16 20:18:38 +00002554static PyObject *date_getstate(PyDateTime_Date *self);
2555
2556static long
2557date_hash(PyDateTime_Date *self)
2558{
2559 if (self->hashcode == -1) {
2560 PyObject *temp = date_getstate(self);
2561 if (temp != NULL) {
2562 self->hashcode = PyObject_Hash(temp);
2563 Py_DECREF(temp);
2564 }
2565 }
2566 return self->hashcode;
2567}
2568
2569static PyObject *
2570date_toordinal(PyDateTime_Date *self)
2571{
2572 return PyInt_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
2573 GET_DAY(self)));
2574}
2575
2576static PyObject *
2577date_weekday(PyDateTime_Date *self)
2578{
2579 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2580
2581 return PyInt_FromLong(dow);
2582}
2583
Tim Peters371935f2003-02-01 01:52:50 +00002584/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002585
Tim Petersb57f8f02003-02-01 02:54:15 +00002586/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002587static PyObject *
2588date_getstate(PyDateTime_Date *self)
2589{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002590 return Py_BuildValue(
2591 "(N)",
2592 PyString_FromStringAndSize((char *)self->data,
2593 _PyDateTime_DATE_DATASIZE));
Tim Peters2a799bf2002-12-16 20:18:38 +00002594}
2595
2596static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00002597date_reduce(PyDateTime_Date *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00002598{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002599 return Py_BuildValue("(ON)", self->ob_type, date_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002600}
2601
2602static PyMethodDef date_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002603
Tim Peters2a799bf2002-12-16 20:18:38 +00002604 /* Class methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00002605
Tim Peters2a799bf2002-12-16 20:18:38 +00002606 {"fromtimestamp", (PyCFunction)date_fromtimestamp, METH_VARARGS |
2607 METH_CLASS,
2608 PyDoc_STR("timestamp -> local date from a POSIX timestamp (like "
2609 "time.time()).")},
2610
2611 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
2612 METH_CLASS,
2613 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
2614 "ordinal.")},
2615
2616 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
2617 PyDoc_STR("Current date or datetime: same as "
2618 "self.__class__.fromtimestamp(time.time()).")},
2619
2620 /* Instance methods: */
2621
2622 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
2623 PyDoc_STR("Return ctime() style string.")},
2624
2625 {"strftime", (PyCFunction)date_strftime, METH_KEYWORDS,
2626 PyDoc_STR("format -> strftime() style string.")},
2627
2628 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
2629 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
2630
2631 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
2632 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
2633 "weekday.")},
2634
2635 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
2636 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
2637
2638 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
2639 PyDoc_STR("Return the day of the week represented by the date.\n"
2640 "Monday == 1 ... Sunday == 7")},
2641
2642 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
2643 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
2644 "1 is day 1.")},
2645
2646 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
2647 PyDoc_STR("Return the day of the week represented by the date.\n"
2648 "Monday == 0 ... Sunday == 6")},
2649
Tim Peters12bf3392002-12-24 05:41:27 +00002650 {"replace", (PyCFunction)date_replace, METH_KEYWORDS,
2651 PyDoc_STR("Return date with new specified fields.")},
2652
Guido van Rossum177e41a2003-01-30 22:06:23 +00002653 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
2654 PyDoc_STR("__reduce__() -> (cls, state)")},
2655
Tim Peters2a799bf2002-12-16 20:18:38 +00002656 {NULL, NULL}
2657};
2658
2659static char date_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00002660PyDoc_STR("date(year, month, day) --> date object");
Tim Peters2a799bf2002-12-16 20:18:38 +00002661
2662static PyNumberMethods date_as_number = {
2663 date_add, /* nb_add */
2664 date_subtract, /* nb_subtract */
2665 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00002666 0, /* nb_remainder */
2667 0, /* nb_divmod */
2668 0, /* nb_power */
2669 0, /* nb_negative */
2670 0, /* nb_positive */
2671 0, /* nb_absolute */
2672 0, /* nb_nonzero */
2673};
2674
2675static PyTypeObject PyDateTime_DateType = {
2676 PyObject_HEAD_INIT(NULL)
2677 0, /* ob_size */
2678 "datetime.date", /* tp_name */
2679 sizeof(PyDateTime_Date), /* tp_basicsize */
2680 0, /* tp_itemsize */
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002681 0, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00002682 0, /* tp_print */
2683 0, /* tp_getattr */
2684 0, /* tp_setattr */
2685 0, /* tp_compare */
2686 (reprfunc)date_repr, /* tp_repr */
2687 &date_as_number, /* tp_as_number */
2688 0, /* tp_as_sequence */
2689 0, /* tp_as_mapping */
2690 (hashfunc)date_hash, /* tp_hash */
2691 0, /* tp_call */
2692 (reprfunc)date_str, /* tp_str */
2693 PyObject_GenericGetAttr, /* tp_getattro */
2694 0, /* tp_setattro */
2695 0, /* tp_as_buffer */
2696 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2697 Py_TPFLAGS_BASETYPE, /* tp_flags */
2698 date_doc, /* tp_doc */
2699 0, /* tp_traverse */
2700 0, /* tp_clear */
2701 (richcmpfunc)date_richcompare, /* tp_richcompare */
2702 0, /* tp_weaklistoffset */
2703 0, /* tp_iter */
2704 0, /* tp_iternext */
2705 date_methods, /* tp_methods */
2706 0, /* tp_members */
2707 date_getset, /* tp_getset */
2708 0, /* tp_base */
2709 0, /* tp_dict */
2710 0, /* tp_descr_get */
2711 0, /* tp_descr_set */
2712 0, /* tp_dictoffset */
2713 0, /* tp_init */
2714 0, /* tp_alloc */
2715 date_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002716 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002717};
2718
2719/*
Tim Peters2a799bf2002-12-16 20:18:38 +00002720 * PyDateTime_TZInfo implementation.
2721 */
2722
2723/* This is a pure abstract base class, so doesn't do anything beyond
2724 * raising NotImplemented exceptions. Real tzinfo classes need
2725 * to derive from this. This is mostly for clarity, and for efficiency in
Tim Petersa9bc1682003-01-11 03:39:11 +00002726 * datetime and time constructors (their tzinfo arguments need to
Tim Peters2a799bf2002-12-16 20:18:38 +00002727 * be subclasses of this tzinfo class, which is easy and quick to check).
2728 *
2729 * Note: For reasons having to do with pickling of subclasses, we have
2730 * to allow tzinfo objects to be instantiated. This wasn't an issue
2731 * in the Python implementation (__init__() could raise NotImplementedError
2732 * there without ill effect), but doing so in the C implementation hit a
2733 * brick wall.
2734 */
2735
2736static PyObject *
2737tzinfo_nogo(const char* methodname)
2738{
2739 PyErr_Format(PyExc_NotImplementedError,
2740 "a tzinfo subclass must implement %s()",
2741 methodname);
2742 return NULL;
2743}
2744
2745/* Methods. A subclass must implement these. */
2746
Tim Peters52dcce22003-01-23 16:36:11 +00002747static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002748tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
2749{
2750 return tzinfo_nogo("tzname");
2751}
2752
Tim Peters52dcce22003-01-23 16:36:11 +00002753static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002754tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
2755{
2756 return tzinfo_nogo("utcoffset");
2757}
2758
Tim Peters52dcce22003-01-23 16:36:11 +00002759static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002760tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
2761{
2762 return tzinfo_nogo("dst");
2763}
2764
Tim Peters52dcce22003-01-23 16:36:11 +00002765static PyObject *
2766tzinfo_fromutc(PyDateTime_TZInfo *self, PyDateTime_DateTime *dt)
2767{
2768 int y, m, d, hh, mm, ss, us;
2769
2770 PyObject *result;
2771 int off, dst;
2772 int none;
2773 int delta;
2774
2775 if (! PyDateTime_Check(dt)) {
2776 PyErr_SetString(PyExc_TypeError,
2777 "fromutc: argument must be a datetime");
2778 return NULL;
2779 }
2780 if (! HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
2781 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
2782 "is not self");
2783 return NULL;
2784 }
2785
2786 off = call_utcoffset(dt->tzinfo, (PyObject *)dt, &none);
2787 if (off == -1 && PyErr_Occurred())
2788 return NULL;
2789 if (none) {
2790 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2791 "utcoffset() result required");
2792 return NULL;
2793 }
2794
2795 dst = call_dst(dt->tzinfo, (PyObject *)dt, &none);
2796 if (dst == -1 && PyErr_Occurred())
2797 return NULL;
2798 if (none) {
2799 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2800 "dst() result required");
2801 return NULL;
2802 }
2803
2804 y = GET_YEAR(dt);
2805 m = GET_MONTH(dt);
2806 d = GET_DAY(dt);
2807 hh = DATE_GET_HOUR(dt);
2808 mm = DATE_GET_MINUTE(dt);
2809 ss = DATE_GET_SECOND(dt);
2810 us = DATE_GET_MICROSECOND(dt);
2811
2812 delta = off - dst;
2813 mm += delta;
2814 if ((mm < 0 || mm >= 60) &&
2815 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Petersb1049e82003-01-23 17:20:36 +00002816 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00002817 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2818 if (result == NULL)
2819 return result;
2820
2821 dst = call_dst(dt->tzinfo, result, &none);
2822 if (dst == -1 && PyErr_Occurred())
2823 goto Fail;
2824 if (none)
2825 goto Inconsistent;
2826 if (dst == 0)
2827 return result;
2828
2829 mm += dst;
2830 if ((mm < 0 || mm >= 60) &&
2831 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
2832 goto Fail;
2833 Py_DECREF(result);
2834 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2835 return result;
2836
2837Inconsistent:
2838 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave"
2839 "inconsistent results; cannot convert");
2840
2841 /* fall thru to failure */
2842Fail:
2843 Py_DECREF(result);
2844 return NULL;
2845}
2846
Tim Peters2a799bf2002-12-16 20:18:38 +00002847/*
2848 * Pickle support. This is solely so that tzinfo subclasses can use
Guido van Rossum177e41a2003-01-30 22:06:23 +00002849 * pickling -- tzinfo itself is supposed to be uninstantiable.
Tim Peters2a799bf2002-12-16 20:18:38 +00002850 */
2851
Guido van Rossum177e41a2003-01-30 22:06:23 +00002852static PyObject *
2853tzinfo_reduce(PyObject *self)
2854{
2855 PyObject *args, *state, *tmp;
2856 PyObject *getinitargs, *getstate;
Tim Peters2a799bf2002-12-16 20:18:38 +00002857
Guido van Rossum177e41a2003-01-30 22:06:23 +00002858 tmp = PyTuple_New(0);
2859 if (tmp == NULL)
2860 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002861
Guido van Rossum177e41a2003-01-30 22:06:23 +00002862 getinitargs = PyObject_GetAttrString(self, "__getinitargs__");
2863 if (getinitargs != NULL) {
2864 args = PyObject_CallObject(getinitargs, tmp);
2865 Py_DECREF(getinitargs);
2866 if (args == NULL) {
2867 Py_DECREF(tmp);
2868 return NULL;
2869 }
2870 }
2871 else {
2872 PyErr_Clear();
2873 args = tmp;
2874 Py_INCREF(args);
2875 }
2876
2877 getstate = PyObject_GetAttrString(self, "__getstate__");
2878 if (getstate != NULL) {
2879 state = PyObject_CallObject(getstate, tmp);
2880 Py_DECREF(getstate);
2881 if (state == NULL) {
2882 Py_DECREF(args);
2883 Py_DECREF(tmp);
2884 return NULL;
2885 }
2886 }
2887 else {
2888 PyObject **dictptr;
2889 PyErr_Clear();
2890 state = Py_None;
2891 dictptr = _PyObject_GetDictPtr(self);
2892 if (dictptr && *dictptr && PyDict_Size(*dictptr))
2893 state = *dictptr;
2894 Py_INCREF(state);
2895 }
2896
2897 Py_DECREF(tmp);
2898
2899 if (state == Py_None) {
2900 Py_DECREF(state);
2901 return Py_BuildValue("(ON)", self->ob_type, args);
2902 }
2903 else
2904 return Py_BuildValue("(ONN)", self->ob_type, args, state);
2905}
Tim Peters2a799bf2002-12-16 20:18:38 +00002906
2907static PyMethodDef tzinfo_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002908
Tim Peters2a799bf2002-12-16 20:18:38 +00002909 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
2910 PyDoc_STR("datetime -> string name of time zone.")},
2911
2912 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
2913 PyDoc_STR("datetime -> minutes east of UTC (negative for "
2914 "west of UTC).")},
2915
2916 {"dst", (PyCFunction)tzinfo_dst, METH_O,
2917 PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
2918
Tim Peters52dcce22003-01-23 16:36:11 +00002919 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
2920 PyDoc_STR("datetime in UTC -> datetime in local time.")},
2921
Guido van Rossum177e41a2003-01-30 22:06:23 +00002922 {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
2923 PyDoc_STR("-> (cls, state)")},
2924
Tim Peters2a799bf2002-12-16 20:18:38 +00002925 {NULL, NULL}
2926};
2927
2928static char tzinfo_doc[] =
2929PyDoc_STR("Abstract base class for time zone info objects.");
2930
Neal Norwitz227b5332006-03-22 09:28:35 +00002931static PyTypeObject PyDateTime_TZInfoType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00002932 PyObject_HEAD_INIT(NULL)
2933 0, /* ob_size */
2934 "datetime.tzinfo", /* tp_name */
2935 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
2936 0, /* tp_itemsize */
2937 0, /* tp_dealloc */
2938 0, /* tp_print */
2939 0, /* tp_getattr */
2940 0, /* tp_setattr */
2941 0, /* tp_compare */
2942 0, /* tp_repr */
2943 0, /* tp_as_number */
2944 0, /* tp_as_sequence */
2945 0, /* tp_as_mapping */
2946 0, /* tp_hash */
2947 0, /* tp_call */
2948 0, /* tp_str */
2949 PyObject_GenericGetAttr, /* tp_getattro */
2950 0, /* tp_setattro */
2951 0, /* tp_as_buffer */
2952 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2953 Py_TPFLAGS_BASETYPE, /* tp_flags */
2954 tzinfo_doc, /* tp_doc */
2955 0, /* tp_traverse */
2956 0, /* tp_clear */
2957 0, /* tp_richcompare */
2958 0, /* tp_weaklistoffset */
2959 0, /* tp_iter */
2960 0, /* tp_iternext */
2961 tzinfo_methods, /* tp_methods */
2962 0, /* tp_members */
2963 0, /* tp_getset */
2964 0, /* tp_base */
2965 0, /* tp_dict */
2966 0, /* tp_descr_get */
2967 0, /* tp_descr_set */
2968 0, /* tp_dictoffset */
2969 0, /* tp_init */
2970 0, /* tp_alloc */
2971 PyType_GenericNew, /* tp_new */
2972 0, /* tp_free */
2973};
2974
2975/*
Tim Peters37f39822003-01-10 03:49:02 +00002976 * PyDateTime_Time implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00002977 */
2978
Tim Peters37f39822003-01-10 03:49:02 +00002979/* Accessor properties.
Tim Peters2a799bf2002-12-16 20:18:38 +00002980 */
2981
2982static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00002983time_hour(PyDateTime_Time *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00002984{
Tim Peters37f39822003-01-10 03:49:02 +00002985 return PyInt_FromLong(TIME_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002986}
2987
Tim Peters37f39822003-01-10 03:49:02 +00002988static PyObject *
2989time_minute(PyDateTime_Time *self, void *unused)
2990{
2991 return PyInt_FromLong(TIME_GET_MINUTE(self));
2992}
2993
2994/* The name time_second conflicted with some platform header file. */
2995static PyObject *
2996py_time_second(PyDateTime_Time *self, void *unused)
2997{
2998 return PyInt_FromLong(TIME_GET_SECOND(self));
2999}
3000
3001static PyObject *
3002time_microsecond(PyDateTime_Time *self, void *unused)
3003{
3004 return PyInt_FromLong(TIME_GET_MICROSECOND(self));
3005}
3006
3007static PyObject *
3008time_tzinfo(PyDateTime_Time *self, void *unused)
3009{
Tim Petersa032d2e2003-01-11 00:15:54 +00003010 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters37f39822003-01-10 03:49:02 +00003011 Py_INCREF(result);
3012 return result;
3013}
3014
3015static PyGetSetDef time_getset[] = {
3016 {"hour", (getter)time_hour},
3017 {"minute", (getter)time_minute},
3018 {"second", (getter)py_time_second},
3019 {"microsecond", (getter)time_microsecond},
3020 {"tzinfo", (getter)time_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003021 {NULL}
3022};
3023
3024/*
3025 * Constructors.
3026 */
3027
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003028static char *time_kws[] = {"hour", "minute", "second", "microsecond",
Tim Peters37f39822003-01-10 03:49:02 +00003029 "tzinfo", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00003030
Tim Peters2a799bf2002-12-16 20:18:38 +00003031static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003032time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003033{
3034 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003035 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003036 int hour = 0;
3037 int minute = 0;
3038 int second = 0;
3039 int usecond = 0;
3040 PyObject *tzinfo = Py_None;
3041
Guido van Rossum177e41a2003-01-30 22:06:23 +00003042 /* Check for invocation from pickle with __getstate__ state */
3043 if (PyTuple_GET_SIZE(args) >= 1 &&
3044 PyTuple_GET_SIZE(args) <= 2 &&
Tim Peters70533e22003-02-01 04:40:04 +00003045 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Armin Rigof4afb212005-11-07 07:15:48 +00003046 PyString_GET_SIZE(state) == _PyDateTime_TIME_DATASIZE &&
3047 ((unsigned char) (PyString_AS_STRING(state)[0])) < 24)
Guido van Rossum177e41a2003-01-30 22:06:23 +00003048 {
Tim Peters70533e22003-02-01 04:40:04 +00003049 PyDateTime_Time *me;
3050 char aware;
3051
3052 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003053 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003054 if (check_tzinfo_subclass(tzinfo) < 0) {
3055 PyErr_SetString(PyExc_TypeError, "bad "
3056 "tzinfo state arg");
3057 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003058 }
3059 }
Tim Peters70533e22003-02-01 04:40:04 +00003060 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003061 me = (PyDateTime_Time *) (type->tp_alloc(type, aware));
Tim Peters70533e22003-02-01 04:40:04 +00003062 if (me != NULL) {
3063 char *pdata = PyString_AS_STRING(state);
3064
3065 memcpy(me->data, pdata, _PyDateTime_TIME_DATASIZE);
3066 me->hashcode = -1;
3067 me->hastzinfo = aware;
3068 if (aware) {
3069 Py_INCREF(tzinfo);
3070 me->tzinfo = tzinfo;
3071 }
3072 }
3073 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003074 }
3075
Tim Peters37f39822003-01-10 03:49:02 +00003076 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO", time_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003077 &hour, &minute, &second, &usecond,
3078 &tzinfo)) {
3079 if (check_time_args(hour, minute, second, usecond) < 0)
3080 return NULL;
3081 if (check_tzinfo_subclass(tzinfo) < 0)
3082 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003083 self = new_time_ex(hour, minute, second, usecond, tzinfo,
3084 type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003085 }
3086 return self;
3087}
3088
3089/*
3090 * Destructor.
3091 */
3092
3093static void
Tim Peters37f39822003-01-10 03:49:02 +00003094time_dealloc(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003095{
Tim Petersa032d2e2003-01-11 00:15:54 +00003096 if (HASTZINFO(self)) {
Tim Peters37f39822003-01-10 03:49:02 +00003097 Py_XDECREF(self->tzinfo);
Neal Norwitz8e914d92003-01-10 15:29:16 +00003098 }
Tim Peters2a799bf2002-12-16 20:18:38 +00003099 self->ob_type->tp_free((PyObject *)self);
3100}
3101
3102/*
Tim Peters855fe882002-12-22 03:43:39 +00003103 * Indirect access to tzinfo methods.
Tim Peters2a799bf2002-12-16 20:18:38 +00003104 */
3105
Tim Peters2a799bf2002-12-16 20:18:38 +00003106/* These are all METH_NOARGS, so don't need to check the arglist. */
3107static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003108time_utcoffset(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003109 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003110 "utcoffset", Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003111}
3112
3113static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003114time_dst(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003115 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003116 "dst", Py_None);
Tim Peters855fe882002-12-22 03:43:39 +00003117}
3118
3119static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003120time_tzname(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003121 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003122 Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003123}
3124
3125/*
Tim Peters37f39822003-01-10 03:49:02 +00003126 * Various ways to turn a time into a string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003127 */
3128
3129static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003130time_repr(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003131{
Tim Peters37f39822003-01-10 03:49:02 +00003132 char buffer[100];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00003133 const char *typename = self->ob_type->tp_name;
Tim Peters37f39822003-01-10 03:49:02 +00003134 int h = TIME_GET_HOUR(self);
3135 int m = TIME_GET_MINUTE(self);
3136 int s = TIME_GET_SECOND(self);
3137 int us = TIME_GET_MICROSECOND(self);
3138 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003139
Tim Peters37f39822003-01-10 03:49:02 +00003140 if (us)
3141 PyOS_snprintf(buffer, sizeof(buffer),
3142 "%s(%d, %d, %d, %d)", typename, h, m, s, us);
3143 else if (s)
3144 PyOS_snprintf(buffer, sizeof(buffer),
3145 "%s(%d, %d, %d)", typename, h, m, s);
3146 else
3147 PyOS_snprintf(buffer, sizeof(buffer),
3148 "%s(%d, %d)", typename, h, m);
3149 result = PyString_FromString(buffer);
Tim Petersa032d2e2003-01-11 00:15:54 +00003150 if (result != NULL && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +00003151 result = append_keyword_tzinfo(result, self->tzinfo);
3152 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003153}
3154
Tim Peters37f39822003-01-10 03:49:02 +00003155static PyObject *
3156time_str(PyDateTime_Time *self)
3157{
3158 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
3159}
Tim Peters2a799bf2002-12-16 20:18:38 +00003160
3161static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003162time_isoformat(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003163{
3164 char buf[100];
Tim Peters37f39822003-01-10 03:49:02 +00003165 PyObject *result;
3166 /* Reuse the time format code from the datetime type. */
3167 PyDateTime_DateTime datetime;
3168 PyDateTime_DateTime *pdatetime = &datetime;
Tim Peters2a799bf2002-12-16 20:18:38 +00003169
Tim Peters37f39822003-01-10 03:49:02 +00003170 /* Copy over just the time bytes. */
3171 memcpy(pdatetime->data + _PyDateTime_DATE_DATASIZE,
3172 self->data,
3173 _PyDateTime_TIME_DATASIZE);
3174
3175 isoformat_time(pdatetime, buf, sizeof(buf));
3176 result = PyString_FromString(buf);
Tim Petersa032d2e2003-01-11 00:15:54 +00003177 if (result == NULL || ! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00003178 return result;
3179
3180 /* We need to append the UTC offset. */
3181 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00003182 Py_None) < 0) {
Tim Peters2a799bf2002-12-16 20:18:38 +00003183 Py_DECREF(result);
3184 return NULL;
3185 }
3186 PyString_ConcatAndDel(&result, PyString_FromString(buf));
3187 return result;
3188}
3189
Tim Peters37f39822003-01-10 03:49:02 +00003190static PyObject *
3191time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3192{
3193 PyObject *result;
3194 PyObject *format;
3195 PyObject *tuple;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003196 static char *keywords[] = {"format", NULL};
Tim Peters37f39822003-01-10 03:49:02 +00003197
3198 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
3199 &PyString_Type, &format))
3200 return NULL;
3201
3202 /* Python's strftime does insane things with the year part of the
3203 * timetuple. The year is forced to (the otherwise nonsensical)
3204 * 1900 to worm around that.
3205 */
3206 tuple = Py_BuildValue("iiiiiiiii",
Brett Cannond1080a32004-03-02 04:38:10 +00003207 1900, 1, 1, /* year, month, day */
Tim Peters37f39822003-01-10 03:49:02 +00003208 TIME_GET_HOUR(self),
3209 TIME_GET_MINUTE(self),
3210 TIME_GET_SECOND(self),
Brett Cannond1080a32004-03-02 04:38:10 +00003211 0, 1, -1); /* weekday, daynum, dst */
Tim Peters37f39822003-01-10 03:49:02 +00003212 if (tuple == NULL)
3213 return NULL;
3214 assert(PyTuple_Size(tuple) == 9);
3215 result = wrap_strftime((PyObject *)self, format, tuple, Py_None);
3216 Py_DECREF(tuple);
3217 return result;
3218}
Tim Peters2a799bf2002-12-16 20:18:38 +00003219
3220/*
3221 * Miscellaneous methods.
3222 */
3223
Tim Peters37f39822003-01-10 03:49:02 +00003224/* This is more natural as a tp_compare, but doesn't work then: for whatever
3225 * reason, Python's try_3way_compare ignores tp_compare unless
3226 * PyInstance_Check returns true, but these aren't old-style classes.
3227 */
3228static PyObject *
3229time_richcompare(PyDateTime_Time *self, PyObject *other, int op)
3230{
3231 int diff;
3232 naivety n1, n2;
3233 int offset1, offset2;
3234
3235 if (! PyTime_Check(other)) {
Tim Peters07534a62003-02-07 22:50:28 +00003236 if (op == Py_EQ || op == Py_NE) {
3237 PyObject *result = op == Py_EQ ? Py_False : Py_True;
3238 Py_INCREF(result);
3239 return result;
3240 }
Tim Peters37f39822003-01-10 03:49:02 +00003241 /* Stop this from falling back to address comparison. */
Tim Peters07534a62003-02-07 22:50:28 +00003242 return cmperror((PyObject *)self, other);
Tim Peters37f39822003-01-10 03:49:02 +00003243 }
3244 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1, Py_None,
3245 other, &offset2, &n2, Py_None) < 0)
3246 return NULL;
3247 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
3248 /* If they're both naive, or both aware and have the same offsets,
3249 * we get off cheap. Note that if they're both naive, offset1 ==
3250 * offset2 == 0 at this point.
3251 */
3252 if (n1 == n2 && offset1 == offset2) {
3253 diff = memcmp(self->data, ((PyDateTime_Time *)other)->data,
3254 _PyDateTime_TIME_DATASIZE);
3255 return diff_to_bool(diff, op);
3256 }
3257
3258 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
3259 assert(offset1 != offset2); /* else last "if" handled it */
3260 /* Convert everything except microseconds to seconds. These
3261 * can't overflow (no more than the # of seconds in 2 days).
3262 */
3263 offset1 = TIME_GET_HOUR(self) * 3600 +
3264 (TIME_GET_MINUTE(self) - offset1) * 60 +
3265 TIME_GET_SECOND(self);
3266 offset2 = TIME_GET_HOUR(other) * 3600 +
3267 (TIME_GET_MINUTE(other) - offset2) * 60 +
3268 TIME_GET_SECOND(other);
3269 diff = offset1 - offset2;
3270 if (diff == 0)
3271 diff = TIME_GET_MICROSECOND(self) -
3272 TIME_GET_MICROSECOND(other);
3273 return diff_to_bool(diff, op);
3274 }
3275
3276 assert(n1 != n2);
3277 PyErr_SetString(PyExc_TypeError,
3278 "can't compare offset-naive and "
3279 "offset-aware times");
3280 return NULL;
3281}
3282
3283static long
3284time_hash(PyDateTime_Time *self)
3285{
3286 if (self->hashcode == -1) {
3287 naivety n;
3288 int offset;
3289 PyObject *temp;
3290
3291 n = classify_utcoffset((PyObject *)self, Py_None, &offset);
3292 assert(n != OFFSET_UNKNOWN);
3293 if (n == OFFSET_ERROR)
3294 return -1;
3295
3296 /* Reduce this to a hash of another object. */
3297 if (offset == 0)
3298 temp = PyString_FromStringAndSize((char *)self->data,
3299 _PyDateTime_TIME_DATASIZE);
3300 else {
3301 int hour;
3302 int minute;
3303
3304 assert(n == OFFSET_AWARE);
Tim Petersa032d2e2003-01-11 00:15:54 +00003305 assert(HASTZINFO(self));
Tim Peters37f39822003-01-10 03:49:02 +00003306 hour = divmod(TIME_GET_HOUR(self) * 60 +
3307 TIME_GET_MINUTE(self) - offset,
3308 60,
3309 &minute);
3310 if (0 <= hour && hour < 24)
3311 temp = new_time(hour, minute,
3312 TIME_GET_SECOND(self),
3313 TIME_GET_MICROSECOND(self),
3314 Py_None);
3315 else
3316 temp = Py_BuildValue("iiii",
3317 hour, minute,
3318 TIME_GET_SECOND(self),
3319 TIME_GET_MICROSECOND(self));
3320 }
3321 if (temp != NULL) {
3322 self->hashcode = PyObject_Hash(temp);
3323 Py_DECREF(temp);
3324 }
3325 }
3326 return self->hashcode;
3327}
Tim Peters2a799bf2002-12-16 20:18:38 +00003328
Tim Peters12bf3392002-12-24 05:41:27 +00003329static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003330time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00003331{
3332 PyObject *clone;
3333 PyObject *tuple;
3334 int hh = TIME_GET_HOUR(self);
3335 int mm = TIME_GET_MINUTE(self);
3336 int ss = TIME_GET_SECOND(self);
3337 int us = TIME_GET_MICROSECOND(self);
Tim Petersa032d2e2003-01-11 00:15:54 +00003338 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00003339
3340 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO:replace",
Tim Peters37f39822003-01-10 03:49:02 +00003341 time_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00003342 &hh, &mm, &ss, &us, &tzinfo))
3343 return NULL;
3344 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
3345 if (tuple == NULL)
3346 return NULL;
Tim Peters37f39822003-01-10 03:49:02 +00003347 clone = time_new(self->ob_type, tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00003348 Py_DECREF(tuple);
3349 return clone;
3350}
3351
Tim Peters2a799bf2002-12-16 20:18:38 +00003352static int
Tim Peters37f39822003-01-10 03:49:02 +00003353time_nonzero(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003354{
3355 int offset;
3356 int none;
3357
3358 if (TIME_GET_SECOND(self) || TIME_GET_MICROSECOND(self)) {
3359 /* Since utcoffset is in whole minutes, nothing can
3360 * alter the conclusion that this is nonzero.
3361 */
3362 return 1;
3363 }
3364 offset = 0;
Tim Petersa032d2e2003-01-11 00:15:54 +00003365 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Petersbad8ff02002-12-30 20:52:32 +00003366 offset = call_utcoffset(self->tzinfo, Py_None, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00003367 if (offset == -1 && PyErr_Occurred())
3368 return -1;
3369 }
3370 return (TIME_GET_MINUTE(self) - offset + TIME_GET_HOUR(self)*60) != 0;
3371}
3372
Tim Peters371935f2003-02-01 01:52:50 +00003373/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003374
Tim Peters33e0f382003-01-10 02:05:14 +00003375/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003376 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
3377 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00003378 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00003379 */
3380static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003381time_getstate(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003382{
3383 PyObject *basestate;
3384 PyObject *result = NULL;
3385
Tim Peters33e0f382003-01-10 02:05:14 +00003386 basestate = PyString_FromStringAndSize((char *)self->data,
3387 _PyDateTime_TIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00003388 if (basestate != NULL) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003389 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003390 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00003391 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003392 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00003393 Py_DECREF(basestate);
3394 }
3395 return result;
3396}
3397
3398static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00003399time_reduce(PyDateTime_Time *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00003400{
Guido van Rossum177e41a2003-01-30 22:06:23 +00003401 return Py_BuildValue("(ON)", self->ob_type, time_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003402}
3403
Tim Peters37f39822003-01-10 03:49:02 +00003404static PyMethodDef time_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003405
Tim Peters37f39822003-01-10 03:49:02 +00003406 {"isoformat", (PyCFunction)time_isoformat, METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003407 PyDoc_STR("Return string in ISO 8601 format, HH:MM:SS[.mmmmmm]"
3408 "[+HH:MM].")},
3409
Tim Peters37f39822003-01-10 03:49:02 +00003410 {"strftime", (PyCFunction)time_strftime, METH_KEYWORDS,
3411 PyDoc_STR("format -> strftime() style string.")},
3412
3413 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003414 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
3415
Tim Peters37f39822003-01-10 03:49:02 +00003416 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003417 PyDoc_STR("Return self.tzinfo.tzname(self).")},
3418
Tim Peters37f39822003-01-10 03:49:02 +00003419 {"dst", (PyCFunction)time_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003420 PyDoc_STR("Return self.tzinfo.dst(self).")},
3421
Tim Peters37f39822003-01-10 03:49:02 +00003422 {"replace", (PyCFunction)time_replace, METH_KEYWORDS,
3423 PyDoc_STR("Return time with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00003424
Guido van Rossum177e41a2003-01-30 22:06:23 +00003425 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
3426 PyDoc_STR("__reduce__() -> (cls, state)")},
3427
Tim Peters2a799bf2002-12-16 20:18:38 +00003428 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003429};
3430
Tim Peters37f39822003-01-10 03:49:02 +00003431static char time_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00003432PyDoc_STR("time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object\n\
3433\n\
3434All arguments are optional. tzinfo may be None, or an instance of\n\
3435a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00003436
Tim Peters37f39822003-01-10 03:49:02 +00003437static PyNumberMethods time_as_number = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003438 0, /* nb_add */
3439 0, /* nb_subtract */
3440 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00003441 0, /* nb_remainder */
3442 0, /* nb_divmod */
3443 0, /* nb_power */
3444 0, /* nb_negative */
3445 0, /* nb_positive */
3446 0, /* nb_absolute */
Tim Peters37f39822003-01-10 03:49:02 +00003447 (inquiry)time_nonzero, /* nb_nonzero */
Tim Peters2a799bf2002-12-16 20:18:38 +00003448};
3449
Neal Norwitz227b5332006-03-22 09:28:35 +00003450static PyTypeObject PyDateTime_TimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003451 PyObject_HEAD_INIT(NULL)
3452 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00003453 "datetime.time", /* tp_name */
Tim Peters37f39822003-01-10 03:49:02 +00003454 sizeof(PyDateTime_Time), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00003455 0, /* tp_itemsize */
Tim Peters37f39822003-01-10 03:49:02 +00003456 (destructor)time_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003457 0, /* tp_print */
3458 0, /* tp_getattr */
3459 0, /* tp_setattr */
3460 0, /* tp_compare */
Tim Peters37f39822003-01-10 03:49:02 +00003461 (reprfunc)time_repr, /* tp_repr */
3462 &time_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00003463 0, /* tp_as_sequence */
3464 0, /* tp_as_mapping */
Tim Peters37f39822003-01-10 03:49:02 +00003465 (hashfunc)time_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00003466 0, /* tp_call */
Tim Peters37f39822003-01-10 03:49:02 +00003467 (reprfunc)time_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00003468 PyObject_GenericGetAttr, /* tp_getattro */
3469 0, /* tp_setattro */
3470 0, /* tp_as_buffer */
3471 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
3472 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters37f39822003-01-10 03:49:02 +00003473 time_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003474 0, /* tp_traverse */
3475 0, /* tp_clear */
Tim Peters37f39822003-01-10 03:49:02 +00003476 (richcmpfunc)time_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00003477 0, /* tp_weaklistoffset */
3478 0, /* tp_iter */
3479 0, /* tp_iternext */
Tim Peters37f39822003-01-10 03:49:02 +00003480 time_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00003481 0, /* tp_members */
Tim Peters37f39822003-01-10 03:49:02 +00003482 time_getset, /* tp_getset */
3483 0, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00003484 0, /* tp_dict */
3485 0, /* tp_descr_get */
3486 0, /* tp_descr_set */
3487 0, /* tp_dictoffset */
3488 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00003489 time_alloc, /* tp_alloc */
Tim Peters37f39822003-01-10 03:49:02 +00003490 time_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00003491 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00003492};
3493
3494/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003495 * PyDateTime_DateTime implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003496 */
3497
Tim Petersa9bc1682003-01-11 03:39:11 +00003498/* Accessor properties. Properties for day, month, and year are inherited
3499 * from date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003500 */
3501
3502static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003503datetime_hour(PyDateTime_DateTime *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003504{
Tim Petersa9bc1682003-01-11 03:39:11 +00003505 return PyInt_FromLong(DATE_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003506}
3507
Tim Petersa9bc1682003-01-11 03:39:11 +00003508static PyObject *
3509datetime_minute(PyDateTime_DateTime *self, void *unused)
3510{
3511 return PyInt_FromLong(DATE_GET_MINUTE(self));
3512}
3513
3514static PyObject *
3515datetime_second(PyDateTime_DateTime *self, void *unused)
3516{
3517 return PyInt_FromLong(DATE_GET_SECOND(self));
3518}
3519
3520static PyObject *
3521datetime_microsecond(PyDateTime_DateTime *self, void *unused)
3522{
3523 return PyInt_FromLong(DATE_GET_MICROSECOND(self));
3524}
3525
3526static PyObject *
3527datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
3528{
3529 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3530 Py_INCREF(result);
3531 return result;
3532}
3533
3534static PyGetSetDef datetime_getset[] = {
3535 {"hour", (getter)datetime_hour},
3536 {"minute", (getter)datetime_minute},
3537 {"second", (getter)datetime_second},
3538 {"microsecond", (getter)datetime_microsecond},
3539 {"tzinfo", (getter)datetime_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003540 {NULL}
3541};
3542
3543/*
3544 * Constructors.
Tim Peters2a799bf2002-12-16 20:18:38 +00003545 */
3546
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003547static char *datetime_kws[] = {
Tim Peters12bf3392002-12-24 05:41:27 +00003548 "year", "month", "day", "hour", "minute", "second",
3549 "microsecond", "tzinfo", NULL
3550};
3551
Tim Peters2a799bf2002-12-16 20:18:38 +00003552static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003553datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003554{
3555 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003556 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003557 int year;
3558 int month;
3559 int day;
3560 int hour = 0;
3561 int minute = 0;
3562 int second = 0;
3563 int usecond = 0;
3564 PyObject *tzinfo = Py_None;
3565
Guido van Rossum177e41a2003-01-30 22:06:23 +00003566 /* Check for invocation from pickle with __getstate__ state */
3567 if (PyTuple_GET_SIZE(args) >= 1 &&
3568 PyTuple_GET_SIZE(args) <= 2 &&
Tim Peters70533e22003-02-01 04:40:04 +00003569 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Tim Peters3f606292004-03-21 23:38:41 +00003570 PyString_GET_SIZE(state) == _PyDateTime_DATETIME_DATASIZE &&
3571 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00003572 {
Tim Peters70533e22003-02-01 04:40:04 +00003573 PyDateTime_DateTime *me;
3574 char aware;
3575
3576 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003577 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003578 if (check_tzinfo_subclass(tzinfo) < 0) {
3579 PyErr_SetString(PyExc_TypeError, "bad "
3580 "tzinfo state arg");
3581 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003582 }
3583 }
Tim Peters70533e22003-02-01 04:40:04 +00003584 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003585 me = (PyDateTime_DateTime *) (type->tp_alloc(type , aware));
Tim Peters70533e22003-02-01 04:40:04 +00003586 if (me != NULL) {
3587 char *pdata = PyString_AS_STRING(state);
3588
3589 memcpy(me->data, pdata, _PyDateTime_DATETIME_DATASIZE);
3590 me->hashcode = -1;
3591 me->hastzinfo = aware;
3592 if (aware) {
3593 Py_INCREF(tzinfo);
3594 me->tzinfo = tzinfo;
3595 }
3596 }
3597 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003598 }
3599
Tim Petersa9bc1682003-01-11 03:39:11 +00003600 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO", datetime_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003601 &year, &month, &day, &hour, &minute,
3602 &second, &usecond, &tzinfo)) {
3603 if (check_date_args(year, month, day) < 0)
3604 return NULL;
3605 if (check_time_args(hour, minute, second, usecond) < 0)
3606 return NULL;
3607 if (check_tzinfo_subclass(tzinfo) < 0)
3608 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003609 self = new_datetime_ex(year, month, day,
3610 hour, minute, second, usecond,
3611 tzinfo, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003612 }
3613 return self;
3614}
3615
Tim Petersa9bc1682003-01-11 03:39:11 +00003616/* TM_FUNC is the shared type of localtime() and gmtime(). */
3617typedef struct tm *(*TM_FUNC)(const time_t *timer);
3618
3619/* Internal helper.
3620 * Build datetime from a time_t and a distinct count of microseconds.
3621 * Pass localtime or gmtime for f, to control the interpretation of timet.
3622 */
3623static PyObject *
3624datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
3625 PyObject *tzinfo)
3626{
3627 struct tm *tm;
3628 PyObject *result = NULL;
3629
3630 tm = f(&timet);
3631 if (tm) {
3632 /* The platform localtime/gmtime may insert leap seconds,
3633 * indicated by tm->tm_sec > 59. We don't care about them,
3634 * except to the extent that passing them on to the datetime
3635 * constructor would raise ValueError for a reason that
3636 * made no sense to the user.
3637 */
3638 if (tm->tm_sec > 59)
3639 tm->tm_sec = 59;
3640 result = PyObject_CallFunction(cls, "iiiiiiiO",
3641 tm->tm_year + 1900,
3642 tm->tm_mon + 1,
3643 tm->tm_mday,
3644 tm->tm_hour,
3645 tm->tm_min,
3646 tm->tm_sec,
3647 us,
3648 tzinfo);
3649 }
3650 else
3651 PyErr_SetString(PyExc_ValueError,
3652 "timestamp out of range for "
3653 "platform localtime()/gmtime() function");
3654 return result;
3655}
3656
3657/* Internal helper.
3658 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
3659 * to control the interpretation of the timestamp. Since a double doesn't
3660 * have enough bits to cover a datetime's full range of precision, it's
3661 * better to call datetime_from_timet_and_us provided you have a way
3662 * to get that much precision (e.g., C time() isn't good enough).
3663 */
3664static PyObject *
3665datetime_from_timestamp(PyObject *cls, TM_FUNC f, double timestamp,
3666 PyObject *tzinfo)
3667{
Tim Peters1b6f7a92004-06-20 02:50:16 +00003668 time_t timet;
3669 double fraction;
3670 int us;
Tim Petersa9bc1682003-01-11 03:39:11 +00003671
Tim Peters1b6f7a92004-06-20 02:50:16 +00003672 timet = _PyTime_DoubleToTimet(timestamp);
3673 if (timet == (time_t)-1 && PyErr_Occurred())
3674 return NULL;
3675 fraction = timestamp - (double)timet;
3676 us = (int)round_to_long(fraction * 1e6);
Tim Petersa9bc1682003-01-11 03:39:11 +00003677 return datetime_from_timet_and_us(cls, f, timet, us, tzinfo);
3678}
3679
3680/* Internal helper.
3681 * Build most accurate possible datetime for current time. Pass localtime or
3682 * gmtime for f as appropriate.
3683 */
3684static PyObject *
3685datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
3686{
3687#ifdef HAVE_GETTIMEOFDAY
3688 struct timeval t;
3689
3690#ifdef GETTIMEOFDAY_NO_TZ
3691 gettimeofday(&t);
3692#else
3693 gettimeofday(&t, (struct timezone *)NULL);
3694#endif
3695 return datetime_from_timet_and_us(cls, f, t.tv_sec, (int)t.tv_usec,
3696 tzinfo);
3697
3698#else /* ! HAVE_GETTIMEOFDAY */
3699 /* No flavor of gettimeofday exists on this platform. Python's
3700 * time.time() does a lot of other platform tricks to get the
3701 * best time it can on the platform, and we're not going to do
3702 * better than that (if we could, the better code would belong
3703 * in time.time()!) We're limited by the precision of a double,
3704 * though.
3705 */
3706 PyObject *time;
3707 double dtime;
3708
3709 time = time_time();
3710 if (time == NULL)
3711 return NULL;
3712 dtime = PyFloat_AsDouble(time);
3713 Py_DECREF(time);
3714 if (dtime == -1.0 && PyErr_Occurred())
3715 return NULL;
3716 return datetime_from_timestamp(cls, f, dtime, tzinfo);
3717#endif /* ! HAVE_GETTIMEOFDAY */
3718}
3719
Tim Peters2a799bf2002-12-16 20:18:38 +00003720/* Return best possible local time -- this isn't constrained by the
3721 * precision of a timestamp.
3722 */
3723static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003724datetime_now(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003725{
Tim Peters10cadce2003-01-23 19:58:02 +00003726 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003727 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003728 static char *keywords[] = {"tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003729
Tim Peters10cadce2003-01-23 19:58:02 +00003730 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:now", keywords,
3731 &tzinfo))
3732 return NULL;
3733 if (check_tzinfo_subclass(tzinfo) < 0)
3734 return NULL;
3735
3736 self = datetime_best_possible(cls,
3737 tzinfo == Py_None ? localtime : gmtime,
3738 tzinfo);
3739 if (self != NULL && tzinfo != Py_None) {
3740 /* Convert UTC to tzinfo's zone. */
3741 PyObject *temp = self;
Tim Peters2a44a8d2003-01-23 20:53:10 +00003742 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
Tim Peters10cadce2003-01-23 19:58:02 +00003743 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003744 }
3745 return self;
3746}
3747
Tim Petersa9bc1682003-01-11 03:39:11 +00003748/* Return best possible UTC time -- this isn't constrained by the
3749 * precision of a timestamp.
3750 */
3751static PyObject *
3752datetime_utcnow(PyObject *cls, PyObject *dummy)
3753{
3754 return datetime_best_possible(cls, gmtime, Py_None);
3755}
3756
Tim Peters2a799bf2002-12-16 20:18:38 +00003757/* Return new local datetime from timestamp (Python timestamp -- a double). */
3758static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003759datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003760{
Tim Peters2a44a8d2003-01-23 20:53:10 +00003761 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003762 double timestamp;
3763 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003764 static char *keywords[] = {"timestamp", "tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003765
Tim Peters2a44a8d2003-01-23 20:53:10 +00003766 if (! PyArg_ParseTupleAndKeywords(args, kw, "d|O:fromtimestamp",
3767 keywords, &timestamp, &tzinfo))
3768 return NULL;
3769 if (check_tzinfo_subclass(tzinfo) < 0)
3770 return NULL;
3771
3772 self = datetime_from_timestamp(cls,
3773 tzinfo == Py_None ? localtime : gmtime,
3774 timestamp,
3775 tzinfo);
3776 if (self != NULL && tzinfo != Py_None) {
3777 /* Convert UTC to tzinfo's zone. */
3778 PyObject *temp = self;
3779 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3780 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003781 }
3782 return self;
3783}
3784
Tim Petersa9bc1682003-01-11 03:39:11 +00003785/* Return new UTC datetime from timestamp (Python timestamp -- a double). */
3786static PyObject *
3787datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
3788{
3789 double timestamp;
3790 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003791
Tim Petersa9bc1682003-01-11 03:39:11 +00003792 if (PyArg_ParseTuple(args, "d:utcfromtimestamp", &timestamp))
3793 result = datetime_from_timestamp(cls, gmtime, timestamp,
3794 Py_None);
3795 return result;
3796}
3797
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003798/* Return new datetime from time.strptime(). */
3799static PyObject *
3800datetime_strptime(PyObject *cls, PyObject *args)
3801{
3802 PyObject *result = NULL, *obj, *module;
3803 const char *string, *format;
3804
3805 if (!PyArg_ParseTuple(args, "ss:strptime", &string, &format))
3806 return NULL;
3807
3808 if ((module = PyImport_ImportModule("time")) == NULL)
3809 return NULL;
3810 obj = PyObject_CallMethod(module, "strptime", "ss", string, format);
3811 Py_DECREF(module);
3812
3813 if (obj != NULL) {
3814 int i, good_timetuple = 1;
3815 long int ia[6];
3816 if (PySequence_Check(obj) && PySequence_Size(obj) >= 6)
3817 for (i=0; i < 6; i++) {
3818 PyObject *p = PySequence_GetItem(obj, i);
3819 if (PyInt_Check(p))
3820 ia[i] = PyInt_AsLong(p);
3821 else
3822 good_timetuple = 0;
3823 Py_DECREF(p);
3824 }
3825 else
3826 good_timetuple = 0;
3827 if (good_timetuple)
3828 result = PyObject_CallFunction(cls, "iiiiii",
3829 ia[0], ia[1], ia[2], ia[3], ia[4], ia[5]);
3830 else
3831 PyErr_SetString(PyExc_ValueError,
3832 "unexpected value from time.strptime");
3833 Py_DECREF(obj);
3834 }
3835 return result;
3836}
3837
Tim Petersa9bc1682003-01-11 03:39:11 +00003838/* Return new datetime from date/datetime and time arguments. */
3839static PyObject *
3840datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
3841{
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003842 static char *keywords[] = {"date", "time", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00003843 PyObject *date;
3844 PyObject *time;
3845 PyObject *result = NULL;
3846
3847 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!:combine", keywords,
3848 &PyDateTime_DateType, &date,
3849 &PyDateTime_TimeType, &time)) {
3850 PyObject *tzinfo = Py_None;
3851
3852 if (HASTZINFO(time))
3853 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
3854 result = PyObject_CallFunction(cls, "iiiiiiiO",
3855 GET_YEAR(date),
3856 GET_MONTH(date),
3857 GET_DAY(date),
3858 TIME_GET_HOUR(time),
3859 TIME_GET_MINUTE(time),
3860 TIME_GET_SECOND(time),
3861 TIME_GET_MICROSECOND(time),
3862 tzinfo);
3863 }
3864 return result;
3865}
Tim Peters2a799bf2002-12-16 20:18:38 +00003866
3867/*
3868 * Destructor.
3869 */
3870
3871static void
Tim Petersa9bc1682003-01-11 03:39:11 +00003872datetime_dealloc(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003873{
Tim Petersa9bc1682003-01-11 03:39:11 +00003874 if (HASTZINFO(self)) {
3875 Py_XDECREF(self->tzinfo);
3876 }
Tim Peters2a799bf2002-12-16 20:18:38 +00003877 self->ob_type->tp_free((PyObject *)self);
3878}
3879
3880/*
3881 * Indirect access to tzinfo methods.
3882 */
3883
Tim Peters2a799bf2002-12-16 20:18:38 +00003884/* These are all METH_NOARGS, so don't need to check the arglist. */
3885static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003886datetime_utcoffset(PyDateTime_DateTime *self, PyObject *unused) {
3887 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3888 "utcoffset", (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003889}
3890
3891static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003892datetime_dst(PyDateTime_DateTime *self, PyObject *unused) {
3893 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3894 "dst", (PyObject *)self);
Tim Peters855fe882002-12-22 03:43:39 +00003895}
3896
3897static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003898datetime_tzname(PyDateTime_DateTime *self, PyObject *unused) {
3899 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
3900 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003901}
3902
3903/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003904 * datetime arithmetic.
Tim Peters2a799bf2002-12-16 20:18:38 +00003905 */
3906
Tim Petersa9bc1682003-01-11 03:39:11 +00003907/* factor must be 1 (to add) or -1 (to subtract). The result inherits
3908 * the tzinfo state of date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003909 */
3910static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003911add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
3912 int factor)
Tim Peters2a799bf2002-12-16 20:18:38 +00003913{
Tim Petersa9bc1682003-01-11 03:39:11 +00003914 /* Note that the C-level additions can't overflow, because of
3915 * invariant bounds on the member values.
3916 */
3917 int year = GET_YEAR(date);
3918 int month = GET_MONTH(date);
3919 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
3920 int hour = DATE_GET_HOUR(date);
3921 int minute = DATE_GET_MINUTE(date);
3922 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
3923 int microsecond = DATE_GET_MICROSECOND(date) +
3924 GET_TD_MICROSECONDS(delta) * factor;
Tim Peters2a799bf2002-12-16 20:18:38 +00003925
Tim Petersa9bc1682003-01-11 03:39:11 +00003926 assert(factor == 1 || factor == -1);
3927 if (normalize_datetime(&year, &month, &day,
3928 &hour, &minute, &second, &microsecond) < 0)
3929 return NULL;
3930 else
3931 return new_datetime(year, month, day,
3932 hour, minute, second, microsecond,
3933 HASTZINFO(date) ? date->tzinfo : Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003934}
3935
3936static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003937datetime_add(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003938{
Tim Petersa9bc1682003-01-11 03:39:11 +00003939 if (PyDateTime_Check(left)) {
3940 /* datetime + ??? */
3941 if (PyDelta_Check(right))
3942 /* datetime + delta */
3943 return add_datetime_timedelta(
3944 (PyDateTime_DateTime *)left,
3945 (PyDateTime_Delta *)right,
3946 1);
3947 }
3948 else if (PyDelta_Check(left)) {
3949 /* delta + datetime */
3950 return add_datetime_timedelta((PyDateTime_DateTime *) right,
3951 (PyDateTime_Delta *) left,
3952 1);
3953 }
3954 Py_INCREF(Py_NotImplemented);
3955 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00003956}
3957
3958static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003959datetime_subtract(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003960{
3961 PyObject *result = Py_NotImplemented;
3962
3963 if (PyDateTime_Check(left)) {
3964 /* datetime - ??? */
3965 if (PyDateTime_Check(right)) {
3966 /* datetime - datetime */
3967 naivety n1, n2;
3968 int offset1, offset2;
Tim Petersa9bc1682003-01-11 03:39:11 +00003969 int delta_d, delta_s, delta_us;
Tim Peters2a799bf2002-12-16 20:18:38 +00003970
Tim Peterse39a80c2002-12-30 21:28:52 +00003971 if (classify_two_utcoffsets(left, &offset1, &n1, left,
3972 right, &offset2, &n2,
3973 right) < 0)
Tim Peters00237032002-12-27 02:21:51 +00003974 return NULL;
Tim Peters8702d5f2002-12-27 02:26:16 +00003975 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
Tim Peters2a799bf2002-12-16 20:18:38 +00003976 if (n1 != n2) {
3977 PyErr_SetString(PyExc_TypeError,
3978 "can't subtract offset-naive and "
3979 "offset-aware datetimes");
3980 return NULL;
3981 }
Tim Petersa9bc1682003-01-11 03:39:11 +00003982 delta_d = ymd_to_ord(GET_YEAR(left),
3983 GET_MONTH(left),
3984 GET_DAY(left)) -
3985 ymd_to_ord(GET_YEAR(right),
3986 GET_MONTH(right),
3987 GET_DAY(right));
3988 /* These can't overflow, since the values are
3989 * normalized. At most this gives the number of
3990 * seconds in one day.
3991 */
3992 delta_s = (DATE_GET_HOUR(left) -
3993 DATE_GET_HOUR(right)) * 3600 +
3994 (DATE_GET_MINUTE(left) -
3995 DATE_GET_MINUTE(right)) * 60 +
3996 (DATE_GET_SECOND(left) -
3997 DATE_GET_SECOND(right));
3998 delta_us = DATE_GET_MICROSECOND(left) -
3999 DATE_GET_MICROSECOND(right);
Tim Peters2a799bf2002-12-16 20:18:38 +00004000 /* (left - offset1) - (right - offset2) =
4001 * (left - right) + (offset2 - offset1)
4002 */
Tim Petersa9bc1682003-01-11 03:39:11 +00004003 delta_s += (offset2 - offset1) * 60;
4004 result = new_delta(delta_d, delta_s, delta_us, 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00004005 }
4006 else if (PyDelta_Check(right)) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004007 /* datetime - delta */
4008 result = add_datetime_timedelta(
Tim Peters2a799bf2002-12-16 20:18:38 +00004009 (PyDateTime_DateTime *)left,
Tim Petersa9bc1682003-01-11 03:39:11 +00004010 (PyDateTime_Delta *)right,
4011 -1);
Tim Peters2a799bf2002-12-16 20:18:38 +00004012 }
4013 }
4014
4015 if (result == Py_NotImplemented)
4016 Py_INCREF(result);
4017 return result;
4018}
4019
4020/* Various ways to turn a datetime into a string. */
4021
4022static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004023datetime_repr(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004024{
Tim Petersa9bc1682003-01-11 03:39:11 +00004025 char buffer[1000];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00004026 const char *typename = self->ob_type->tp_name;
Tim Petersa9bc1682003-01-11 03:39:11 +00004027 PyObject *baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004028
Tim Petersa9bc1682003-01-11 03:39:11 +00004029 if (DATE_GET_MICROSECOND(self)) {
4030 PyOS_snprintf(buffer, sizeof(buffer),
4031 "%s(%d, %d, %d, %d, %d, %d, %d)",
4032 typename,
4033 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4034 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4035 DATE_GET_SECOND(self),
4036 DATE_GET_MICROSECOND(self));
4037 }
4038 else if (DATE_GET_SECOND(self)) {
4039 PyOS_snprintf(buffer, sizeof(buffer),
4040 "%s(%d, %d, %d, %d, %d, %d)",
4041 typename,
4042 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4043 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4044 DATE_GET_SECOND(self));
4045 }
4046 else {
4047 PyOS_snprintf(buffer, sizeof(buffer),
4048 "%s(%d, %d, %d, %d, %d)",
4049 typename,
4050 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4051 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
4052 }
4053 baserepr = PyString_FromString(buffer);
4054 if (baserepr == NULL || ! HASTZINFO(self))
4055 return baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004056 return append_keyword_tzinfo(baserepr, self->tzinfo);
4057}
4058
Tim Petersa9bc1682003-01-11 03:39:11 +00004059static PyObject *
4060datetime_str(PyDateTime_DateTime *self)
4061{
4062 return PyObject_CallMethod((PyObject *)self, "isoformat", "(s)", " ");
4063}
Tim Peters2a799bf2002-12-16 20:18:38 +00004064
4065static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004066datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004067{
Tim Petersa9bc1682003-01-11 03:39:11 +00004068 char sep = 'T';
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004069 static char *keywords[] = {"sep", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00004070 char buffer[100];
4071 char *cp;
4072 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004073
Tim Petersa9bc1682003-01-11 03:39:11 +00004074 if (!PyArg_ParseTupleAndKeywords(args, kw, "|c:isoformat", keywords,
4075 &sep))
4076 return NULL;
4077 cp = isoformat_date((PyDateTime_Date *)self, buffer, sizeof(buffer));
4078 assert(cp != NULL);
4079 *cp++ = sep;
4080 isoformat_time(self, cp, sizeof(buffer) - (cp - buffer));
4081 result = PyString_FromString(buffer);
4082 if (result == NULL || ! HASTZINFO(self))
Tim Peters2a799bf2002-12-16 20:18:38 +00004083 return result;
4084
4085 /* We need to append the UTC offset. */
Tim Petersa9bc1682003-01-11 03:39:11 +00004086 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
Tim Peters2a799bf2002-12-16 20:18:38 +00004087 (PyObject *)self) < 0) {
4088 Py_DECREF(result);
4089 return NULL;
4090 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004091 PyString_ConcatAndDel(&result, PyString_FromString(buffer));
Tim Peters2a799bf2002-12-16 20:18:38 +00004092 return result;
4093}
4094
Tim Petersa9bc1682003-01-11 03:39:11 +00004095static PyObject *
4096datetime_ctime(PyDateTime_DateTime *self)
4097{
4098 return format_ctime((PyDateTime_Date *)self,
4099 DATE_GET_HOUR(self),
4100 DATE_GET_MINUTE(self),
4101 DATE_GET_SECOND(self));
4102}
4103
Tim Peters2a799bf2002-12-16 20:18:38 +00004104/* Miscellaneous methods. */
4105
Tim Petersa9bc1682003-01-11 03:39:11 +00004106/* This is more natural as a tp_compare, but doesn't work then: for whatever
4107 * reason, Python's try_3way_compare ignores tp_compare unless
4108 * PyInstance_Check returns true, but these aren't old-style classes.
4109 */
4110static PyObject *
4111datetime_richcompare(PyDateTime_DateTime *self, PyObject *other, int op)
4112{
4113 int diff;
4114 naivety n1, n2;
4115 int offset1, offset2;
4116
4117 if (! PyDateTime_Check(other)) {
Tim Peters528ca532004-09-16 01:30:50 +00004118 /* If other has a "timetuple" attr, that's an advertised
4119 * hook for other classes to ask to get comparison control.
4120 * However, date instances have a timetuple attr, and we
4121 * don't want to allow that comparison. Because datetime
4122 * is a subclass of date, when mixing date and datetime
4123 * in a comparison, Python gives datetime the first shot
4124 * (it's the more specific subtype). So we can stop that
4125 * combination here reliably.
4126 */
4127 if (PyObject_HasAttrString(other, "timetuple") &&
4128 ! PyDate_Check(other)) {
Tim Peters8d81a012003-01-24 22:36:34 +00004129 /* A hook for other kinds of datetime objects. */
4130 Py_INCREF(Py_NotImplemented);
4131 return Py_NotImplemented;
4132 }
Tim Peters07534a62003-02-07 22:50:28 +00004133 if (op == Py_EQ || op == Py_NE) {
4134 PyObject *result = op == Py_EQ ? Py_False : Py_True;
4135 Py_INCREF(result);
4136 return result;
4137 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004138 /* Stop this from falling back to address comparison. */
Tim Peters07534a62003-02-07 22:50:28 +00004139 return cmperror((PyObject *)self, other);
Tim Petersa9bc1682003-01-11 03:39:11 +00004140 }
4141
4142 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1,
4143 (PyObject *)self,
4144 other, &offset2, &n2,
4145 other) < 0)
4146 return NULL;
4147 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
4148 /* If they're both naive, or both aware and have the same offsets,
4149 * we get off cheap. Note that if they're both naive, offset1 ==
4150 * offset2 == 0 at this point.
4151 */
4152 if (n1 == n2 && offset1 == offset2) {
4153 diff = memcmp(self->data, ((PyDateTime_DateTime *)other)->data,
4154 _PyDateTime_DATETIME_DATASIZE);
4155 return diff_to_bool(diff, op);
4156 }
4157
4158 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
4159 PyDateTime_Delta *delta;
4160
4161 assert(offset1 != offset2); /* else last "if" handled it */
4162 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
4163 other);
4164 if (delta == NULL)
4165 return NULL;
4166 diff = GET_TD_DAYS(delta);
4167 if (diff == 0)
4168 diff = GET_TD_SECONDS(delta) |
4169 GET_TD_MICROSECONDS(delta);
4170 Py_DECREF(delta);
4171 return diff_to_bool(diff, op);
4172 }
4173
4174 assert(n1 != n2);
4175 PyErr_SetString(PyExc_TypeError,
4176 "can't compare offset-naive and "
4177 "offset-aware datetimes");
4178 return NULL;
4179}
4180
4181static long
4182datetime_hash(PyDateTime_DateTime *self)
4183{
4184 if (self->hashcode == -1) {
4185 naivety n;
4186 int offset;
4187 PyObject *temp;
4188
4189 n = classify_utcoffset((PyObject *)self, (PyObject *)self,
4190 &offset);
4191 assert(n != OFFSET_UNKNOWN);
4192 if (n == OFFSET_ERROR)
4193 return -1;
4194
4195 /* Reduce this to a hash of another object. */
4196 if (n == OFFSET_NAIVE)
4197 temp = PyString_FromStringAndSize(
4198 (char *)self->data,
4199 _PyDateTime_DATETIME_DATASIZE);
4200 else {
4201 int days;
4202 int seconds;
4203
4204 assert(n == OFFSET_AWARE);
4205 assert(HASTZINFO(self));
4206 days = ymd_to_ord(GET_YEAR(self),
4207 GET_MONTH(self),
4208 GET_DAY(self));
4209 seconds = DATE_GET_HOUR(self) * 3600 +
4210 (DATE_GET_MINUTE(self) - offset) * 60 +
4211 DATE_GET_SECOND(self);
4212 temp = new_delta(days,
4213 seconds,
4214 DATE_GET_MICROSECOND(self),
4215 1);
4216 }
4217 if (temp != NULL) {
4218 self->hashcode = PyObject_Hash(temp);
4219 Py_DECREF(temp);
4220 }
4221 }
4222 return self->hashcode;
4223}
Tim Peters2a799bf2002-12-16 20:18:38 +00004224
4225static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004226datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00004227{
4228 PyObject *clone;
4229 PyObject *tuple;
4230 int y = GET_YEAR(self);
4231 int m = GET_MONTH(self);
4232 int d = GET_DAY(self);
4233 int hh = DATE_GET_HOUR(self);
4234 int mm = DATE_GET_MINUTE(self);
4235 int ss = DATE_GET_SECOND(self);
4236 int us = DATE_GET_MICROSECOND(self);
Tim Petersa9bc1682003-01-11 03:39:11 +00004237 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00004238
4239 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO:replace",
Tim Petersa9bc1682003-01-11 03:39:11 +00004240 datetime_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00004241 &y, &m, &d, &hh, &mm, &ss, &us,
4242 &tzinfo))
4243 return NULL;
4244 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
4245 if (tuple == NULL)
4246 return NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00004247 clone = datetime_new(self->ob_type, tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00004248 Py_DECREF(tuple);
4249 return clone;
4250}
4251
4252static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004253datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters80475bb2002-12-25 07:40:55 +00004254{
Tim Peters52dcce22003-01-23 16:36:11 +00004255 int y, m, d, hh, mm, ss, us;
Tim Peters521fc152002-12-31 17:36:56 +00004256 PyObject *result;
Tim Peters52dcce22003-01-23 16:36:11 +00004257 int offset, none;
Tim Peters521fc152002-12-31 17:36:56 +00004258
Tim Peters80475bb2002-12-25 07:40:55 +00004259 PyObject *tzinfo;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004260 static char *keywords[] = {"tz", NULL};
Tim Peters80475bb2002-12-25 07:40:55 +00004261
Tim Peters52dcce22003-01-23 16:36:11 +00004262 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:astimezone", keywords,
4263 &PyDateTime_TZInfoType, &tzinfo))
Tim Peters80475bb2002-12-25 07:40:55 +00004264 return NULL;
4265
Tim Peters52dcce22003-01-23 16:36:11 +00004266 if (!HASTZINFO(self) || self->tzinfo == Py_None)
4267 goto NeedAware;
Tim Peters521fc152002-12-31 17:36:56 +00004268
Tim Peters52dcce22003-01-23 16:36:11 +00004269 /* Conversion to self's own time zone is a NOP. */
4270 if (self->tzinfo == tzinfo) {
4271 Py_INCREF(self);
4272 return (PyObject *)self;
Tim Peters710fb152003-01-02 19:35:54 +00004273 }
Tim Peters521fc152002-12-31 17:36:56 +00004274
Tim Peters52dcce22003-01-23 16:36:11 +00004275 /* Convert self to UTC. */
4276 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4277 if (offset == -1 && PyErr_Occurred())
4278 return NULL;
4279 if (none)
4280 goto NeedAware;
Tim Petersf3615152003-01-01 21:51:37 +00004281
Tim Peters52dcce22003-01-23 16:36:11 +00004282 y = GET_YEAR(self);
4283 m = GET_MONTH(self);
4284 d = GET_DAY(self);
4285 hh = DATE_GET_HOUR(self);
4286 mm = DATE_GET_MINUTE(self);
4287 ss = DATE_GET_SECOND(self);
4288 us = DATE_GET_MICROSECOND(self);
4289
4290 mm -= offset;
Tim Petersf3615152003-01-01 21:51:37 +00004291 if ((mm < 0 || mm >= 60) &&
4292 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Peters52dcce22003-01-23 16:36:11 +00004293 return NULL;
4294
4295 /* Attach new tzinfo and let fromutc() do the rest. */
4296 result = new_datetime(y, m, d, hh, mm, ss, us, tzinfo);
4297 if (result != NULL) {
4298 PyObject *temp = result;
4299
4300 result = PyObject_CallMethod(tzinfo, "fromutc", "O", temp);
4301 Py_DECREF(temp);
4302 }
Tim Petersadf64202003-01-04 06:03:15 +00004303 return result;
Tim Peters521fc152002-12-31 17:36:56 +00004304
Tim Peters52dcce22003-01-23 16:36:11 +00004305NeedAware:
4306 PyErr_SetString(PyExc_ValueError, "astimezone() cannot be applied to "
4307 "a naive datetime");
Tim Peters521fc152002-12-31 17:36:56 +00004308 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00004309}
4310
4311static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004312datetime_timetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004313{
4314 int dstflag = -1;
4315
Tim Petersa9bc1682003-01-11 03:39:11 +00004316 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004317 int none;
4318
4319 dstflag = call_dst(self->tzinfo, (PyObject *)self, &none);
4320 if (dstflag == -1 && PyErr_Occurred())
4321 return NULL;
4322
4323 if (none)
4324 dstflag = -1;
4325 else if (dstflag != 0)
4326 dstflag = 1;
4327
4328 }
4329 return build_struct_time(GET_YEAR(self),
4330 GET_MONTH(self),
4331 GET_DAY(self),
4332 DATE_GET_HOUR(self),
4333 DATE_GET_MINUTE(self),
4334 DATE_GET_SECOND(self),
4335 dstflag);
4336}
4337
4338static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004339datetime_getdate(PyDateTime_DateTime *self)
4340{
4341 return new_date(GET_YEAR(self),
4342 GET_MONTH(self),
4343 GET_DAY(self));
4344}
4345
4346static PyObject *
4347datetime_gettime(PyDateTime_DateTime *self)
4348{
4349 return new_time(DATE_GET_HOUR(self),
4350 DATE_GET_MINUTE(self),
4351 DATE_GET_SECOND(self),
4352 DATE_GET_MICROSECOND(self),
4353 Py_None);
4354}
4355
4356static PyObject *
4357datetime_gettimetz(PyDateTime_DateTime *self)
4358{
4359 return new_time(DATE_GET_HOUR(self),
4360 DATE_GET_MINUTE(self),
4361 DATE_GET_SECOND(self),
4362 DATE_GET_MICROSECOND(self),
4363 HASTZINFO(self) ? self->tzinfo : Py_None);
4364}
4365
4366static PyObject *
4367datetime_utctimetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004368{
4369 int y = GET_YEAR(self);
4370 int m = GET_MONTH(self);
4371 int d = GET_DAY(self);
4372 int hh = DATE_GET_HOUR(self);
4373 int mm = DATE_GET_MINUTE(self);
4374 int ss = DATE_GET_SECOND(self);
4375 int us = 0; /* microseconds are ignored in a timetuple */
4376 int offset = 0;
4377
Tim Petersa9bc1682003-01-11 03:39:11 +00004378 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004379 int none;
4380
4381 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4382 if (offset == -1 && PyErr_Occurred())
4383 return NULL;
4384 }
4385 /* Even if offset is 0, don't call timetuple() -- tm_isdst should be
4386 * 0 in a UTC timetuple regardless of what dst() says.
4387 */
4388 if (offset) {
4389 /* Subtract offset minutes & normalize. */
4390 int stat;
4391
4392 mm -= offset;
4393 stat = normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us);
4394 if (stat < 0) {
4395 /* At the edges, it's possible we overflowed
4396 * beyond MINYEAR or MAXYEAR.
4397 */
4398 if (PyErr_ExceptionMatches(PyExc_OverflowError))
4399 PyErr_Clear();
4400 else
4401 return NULL;
4402 }
4403 }
4404 return build_struct_time(y, m, d, hh, mm, ss, 0);
4405}
4406
Tim Peters371935f2003-02-01 01:52:50 +00004407/* Pickle support, a simple use of __reduce__. */
Tim Peters33e0f382003-01-10 02:05:14 +00004408
Tim Petersa9bc1682003-01-11 03:39:11 +00004409/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004410 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4411 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00004412 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00004413 */
4414static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004415datetime_getstate(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004416{
4417 PyObject *basestate;
4418 PyObject *result = NULL;
4419
Tim Peters33e0f382003-01-10 02:05:14 +00004420 basestate = PyString_FromStringAndSize((char *)self->data,
4421 _PyDateTime_DATETIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00004422 if (basestate != NULL) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004423 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004424 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00004425 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004426 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00004427 Py_DECREF(basestate);
4428 }
4429 return result;
4430}
4431
4432static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00004433datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00004434{
Guido van Rossum177e41a2003-01-30 22:06:23 +00004435 return Py_BuildValue("(ON)", self->ob_type, datetime_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00004436}
4437
Tim Petersa9bc1682003-01-11 03:39:11 +00004438static PyMethodDef datetime_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004439
Tim Peters2a799bf2002-12-16 20:18:38 +00004440 /* Class methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00004441
Tim Petersa9bc1682003-01-11 03:39:11 +00004442 {"now", (PyCFunction)datetime_now,
Tim Peters2a799bf2002-12-16 20:18:38 +00004443 METH_KEYWORDS | METH_CLASS,
Neal Norwitz2fbe5372003-01-23 21:09:05 +00004444 PyDoc_STR("[tz] -> new datetime with tz's local day and time.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004445
Tim Petersa9bc1682003-01-11 03:39:11 +00004446 {"utcnow", (PyCFunction)datetime_utcnow,
4447 METH_NOARGS | METH_CLASS,
4448 PyDoc_STR("Return a new datetime representing UTC day and time.")},
4449
4450 {"fromtimestamp", (PyCFunction)datetime_fromtimestamp,
Tim Peters2a799bf2002-12-16 20:18:38 +00004451 METH_KEYWORDS | METH_CLASS,
Tim Peters2a44a8d2003-01-23 20:53:10 +00004452 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004453
Tim Petersa9bc1682003-01-11 03:39:11 +00004454 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
4455 METH_VARARGS | METH_CLASS,
4456 PyDoc_STR("timestamp -> UTC datetime from a POSIX timestamp "
4457 "(like time.time()).")},
4458
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004459 {"strptime", (PyCFunction)datetime_strptime,
4460 METH_VARARGS | METH_CLASS,
4461 PyDoc_STR("string, format -> new datetime parsed from a string "
4462 "(like time.strptime()).")},
4463
Tim Petersa9bc1682003-01-11 03:39:11 +00004464 {"combine", (PyCFunction)datetime_combine,
4465 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4466 PyDoc_STR("date, time -> datetime with same date and time fields")},
4467
Tim Peters2a799bf2002-12-16 20:18:38 +00004468 /* Instance methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00004469
Tim Petersa9bc1682003-01-11 03:39:11 +00004470 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
4471 PyDoc_STR("Return date object with same year, month and day.")},
4472
4473 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
4474 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
4475
4476 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
4477 PyDoc_STR("Return time object with same time and tzinfo.")},
4478
4479 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
4480 PyDoc_STR("Return ctime() style string.")},
4481
4482 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004483 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
4484
Tim Petersa9bc1682003-01-11 03:39:11 +00004485 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004486 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
4487
Tim Petersa9bc1682003-01-11 03:39:11 +00004488 {"isoformat", (PyCFunction)datetime_isoformat, METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004489 PyDoc_STR("[sep] -> string in ISO 8601 format, "
4490 "YYYY-MM-DDTHH:MM:SS[.mmmmmm][+HH:MM].\n\n"
4491 "sep is used to separate the year from the time, and "
4492 "defaults to 'T'.")},
4493
Tim Petersa9bc1682003-01-11 03:39:11 +00004494 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004495 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
4496
Tim Petersa9bc1682003-01-11 03:39:11 +00004497 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004498 PyDoc_STR("Return self.tzinfo.tzname(self).")},
4499
Tim Petersa9bc1682003-01-11 03:39:11 +00004500 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004501 PyDoc_STR("Return self.tzinfo.dst(self).")},
4502
Tim Petersa9bc1682003-01-11 03:39:11 +00004503 {"replace", (PyCFunction)datetime_replace, METH_KEYWORDS,
4504 PyDoc_STR("Return datetime with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00004505
Tim Petersa9bc1682003-01-11 03:39:11 +00004506 {"astimezone", (PyCFunction)datetime_astimezone, METH_KEYWORDS,
Tim Peters80475bb2002-12-25 07:40:55 +00004507 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
4508
Guido van Rossum177e41a2003-01-30 22:06:23 +00004509 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
4510 PyDoc_STR("__reduce__() -> (cls, state)")},
4511
Tim Peters2a799bf2002-12-16 20:18:38 +00004512 {NULL, NULL}
4513};
4514
Tim Petersa9bc1682003-01-11 03:39:11 +00004515static char datetime_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00004516PyDoc_STR("datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])\n\
4517\n\
4518The year, month and day arguments are required. tzinfo may be None, or an\n\
4519instance of a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00004520
Tim Petersa9bc1682003-01-11 03:39:11 +00004521static PyNumberMethods datetime_as_number = {
4522 datetime_add, /* nb_add */
4523 datetime_subtract, /* nb_subtract */
Tim Peters2a799bf2002-12-16 20:18:38 +00004524 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00004525 0, /* nb_remainder */
4526 0, /* nb_divmod */
4527 0, /* nb_power */
4528 0, /* nb_negative */
4529 0, /* nb_positive */
4530 0, /* nb_absolute */
4531 0, /* nb_nonzero */
4532};
4533
Neal Norwitz227b5332006-03-22 09:28:35 +00004534static PyTypeObject PyDateTime_DateTimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004535 PyObject_HEAD_INIT(NULL)
4536 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00004537 "datetime.datetime", /* tp_name */
Tim Petersa9bc1682003-01-11 03:39:11 +00004538 sizeof(PyDateTime_DateTime), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00004539 0, /* tp_itemsize */
Tim Petersa9bc1682003-01-11 03:39:11 +00004540 (destructor)datetime_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004541 0, /* tp_print */
4542 0, /* tp_getattr */
4543 0, /* tp_setattr */
4544 0, /* tp_compare */
Tim Petersa9bc1682003-01-11 03:39:11 +00004545 (reprfunc)datetime_repr, /* tp_repr */
4546 &datetime_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00004547 0, /* tp_as_sequence */
4548 0, /* tp_as_mapping */
Tim Petersa9bc1682003-01-11 03:39:11 +00004549 (hashfunc)datetime_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00004550 0, /* tp_call */
Tim Petersa9bc1682003-01-11 03:39:11 +00004551 (reprfunc)datetime_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00004552 PyObject_GenericGetAttr, /* tp_getattro */
4553 0, /* tp_setattro */
4554 0, /* tp_as_buffer */
4555 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
4556 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Petersa9bc1682003-01-11 03:39:11 +00004557 datetime_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004558 0, /* tp_traverse */
4559 0, /* tp_clear */
Tim Petersa9bc1682003-01-11 03:39:11 +00004560 (richcmpfunc)datetime_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00004561 0, /* tp_weaklistoffset */
4562 0, /* tp_iter */
4563 0, /* tp_iternext */
Tim Petersa9bc1682003-01-11 03:39:11 +00004564 datetime_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00004565 0, /* tp_members */
Tim Petersa9bc1682003-01-11 03:39:11 +00004566 datetime_getset, /* tp_getset */
4567 &PyDateTime_DateType, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00004568 0, /* tp_dict */
4569 0, /* tp_descr_get */
4570 0, /* tp_descr_set */
4571 0, /* tp_dictoffset */
4572 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00004573 datetime_alloc, /* tp_alloc */
Tim Petersa9bc1682003-01-11 03:39:11 +00004574 datetime_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00004575 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00004576};
4577
4578/* ---------------------------------------------------------------------------
4579 * Module methods and initialization.
4580 */
4581
4582static PyMethodDef module_methods[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004583 {NULL, NULL}
4584};
4585
Tim Peters9ddf40b2004-06-20 22:41:32 +00004586/* C API. Clients get at this via PyDateTime_IMPORT, defined in
4587 * datetime.h.
4588 */
4589static PyDateTime_CAPI CAPI = {
4590 &PyDateTime_DateType,
4591 &PyDateTime_DateTimeType,
4592 &PyDateTime_TimeType,
4593 &PyDateTime_DeltaType,
4594 &PyDateTime_TZInfoType,
4595 new_date_ex,
4596 new_datetime_ex,
4597 new_time_ex,
4598 new_delta_ex,
4599 datetime_fromtimestamp,
4600 date_fromtimestamp
4601};
4602
4603
Tim Peters2a799bf2002-12-16 20:18:38 +00004604PyMODINIT_FUNC
4605initdatetime(void)
4606{
4607 PyObject *m; /* a module object */
4608 PyObject *d; /* its dict */
4609 PyObject *x;
4610
Tim Peters2a799bf2002-12-16 20:18:38 +00004611 m = Py_InitModule3("datetime", module_methods,
4612 "Fast implementation of the datetime type.");
Neal Norwitz1ac754f2006-01-19 06:09:39 +00004613 if (m == NULL)
4614 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004615
4616 if (PyType_Ready(&PyDateTime_DateType) < 0)
4617 return;
4618 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
4619 return;
4620 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
4621 return;
4622 if (PyType_Ready(&PyDateTime_TimeType) < 0)
4623 return;
4624 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
4625 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004626
Tim Peters2a799bf2002-12-16 20:18:38 +00004627 /* timedelta values */
4628 d = PyDateTime_DeltaType.tp_dict;
4629
Tim Peters2a799bf2002-12-16 20:18:38 +00004630 x = new_delta(0, 0, 1, 0);
4631 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4632 return;
4633 Py_DECREF(x);
4634
4635 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
4636 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4637 return;
4638 Py_DECREF(x);
4639
4640 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
4641 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4642 return;
4643 Py_DECREF(x);
4644
4645 /* date values */
4646 d = PyDateTime_DateType.tp_dict;
4647
4648 x = new_date(1, 1, 1);
4649 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4650 return;
4651 Py_DECREF(x);
4652
4653 x = new_date(MAXYEAR, 12, 31);
4654 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4655 return;
4656 Py_DECREF(x);
4657
4658 x = new_delta(1, 0, 0, 0);
4659 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4660 return;
4661 Py_DECREF(x);
4662
Tim Peters37f39822003-01-10 03:49:02 +00004663 /* time values */
4664 d = PyDateTime_TimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004665
Tim Peters37f39822003-01-10 03:49:02 +00004666 x = new_time(0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004667 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4668 return;
4669 Py_DECREF(x);
4670
Tim Peters37f39822003-01-10 03:49:02 +00004671 x = new_time(23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004672 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4673 return;
4674 Py_DECREF(x);
4675
4676 x = new_delta(0, 0, 1, 0);
4677 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4678 return;
4679 Py_DECREF(x);
4680
Tim Petersa9bc1682003-01-11 03:39:11 +00004681 /* datetime values */
4682 d = PyDateTime_DateTimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004683
Tim Petersa9bc1682003-01-11 03:39:11 +00004684 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004685 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4686 return;
4687 Py_DECREF(x);
4688
Tim Petersa9bc1682003-01-11 03:39:11 +00004689 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004690 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4691 return;
4692 Py_DECREF(x);
4693
4694 x = new_delta(0, 0, 1, 0);
4695 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4696 return;
4697 Py_DECREF(x);
4698
Tim Peters2a799bf2002-12-16 20:18:38 +00004699 /* module initialization */
4700 PyModule_AddIntConstant(m, "MINYEAR", MINYEAR);
4701 PyModule_AddIntConstant(m, "MAXYEAR", MAXYEAR);
4702
4703 Py_INCREF(&PyDateTime_DateType);
4704 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
4705
Tim Petersa9bc1682003-01-11 03:39:11 +00004706 Py_INCREF(&PyDateTime_DateTimeType);
4707 PyModule_AddObject(m, "datetime",
4708 (PyObject *)&PyDateTime_DateTimeType);
4709
4710 Py_INCREF(&PyDateTime_TimeType);
4711 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
4712
Tim Peters2a799bf2002-12-16 20:18:38 +00004713 Py_INCREF(&PyDateTime_DeltaType);
4714 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
4715
Tim Peters2a799bf2002-12-16 20:18:38 +00004716 Py_INCREF(&PyDateTime_TZInfoType);
4717 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
4718
Tim Peters9ddf40b2004-06-20 22:41:32 +00004719 x = PyCObject_FromVoidPtrAndDesc(&CAPI, (void*) DATETIME_API_MAGIC,
4720 NULL);
4721 if (x == NULL)
4722 return;
4723 PyModule_AddObject(m, "datetime_CAPI", x);
4724
Tim Peters2a799bf2002-12-16 20:18:38 +00004725 /* A 4-year cycle has an extra leap day over what we'd get from
4726 * pasting together 4 single years.
4727 */
4728 assert(DI4Y == 4 * 365 + 1);
4729 assert(DI4Y == days_before_year(4+1));
4730
4731 /* Similarly, a 400-year cycle has an extra leap day over what we'd
4732 * get from pasting together 4 100-year cycles.
4733 */
4734 assert(DI400Y == 4 * DI100Y + 1);
4735 assert(DI400Y == days_before_year(400+1));
4736
4737 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
4738 * pasting together 25 4-year cycles.
4739 */
4740 assert(DI100Y == 25 * DI4Y - 1);
4741 assert(DI100Y == days_before_year(100+1));
4742
4743 us_per_us = PyInt_FromLong(1);
4744 us_per_ms = PyInt_FromLong(1000);
4745 us_per_second = PyInt_FromLong(1000000);
4746 us_per_minute = PyInt_FromLong(60000000);
4747 seconds_per_day = PyInt_FromLong(24 * 3600);
4748 if (us_per_us == NULL || us_per_ms == NULL || us_per_second == NULL ||
4749 us_per_minute == NULL || seconds_per_day == NULL)
4750 return;
4751
4752 /* The rest are too big for 32-bit ints, but even
4753 * us_per_week fits in 40 bits, so doubles should be exact.
4754 */
4755 us_per_hour = PyLong_FromDouble(3600000000.0);
4756 us_per_day = PyLong_FromDouble(86400000000.0);
4757 us_per_week = PyLong_FromDouble(604800000000.0);
4758 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
4759 return;
4760}
Tim Petersf3615152003-01-01 21:51:37 +00004761
4762/* ---------------------------------------------------------------------------
Tim Petersa9bc1682003-01-11 03:39:11 +00004763Some time zone algebra. For a datetime x, let
Tim Petersf3615152003-01-01 21:51:37 +00004764 x.n = x stripped of its timezone -- its naive time.
4765 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
4766 return None
4767 x.d = x.dst(), and assuming that doesn't raise an exception or
4768 return None
4769 x.s = x's standard offset, x.o - x.d
4770
4771Now some derived rules, where k is a duration (timedelta).
4772
47731. x.o = x.s + x.d
4774 This follows from the definition of x.s.
4775
Tim Petersc5dc4da2003-01-02 17:55:03 +000047762. If x and y have the same tzinfo member, x.s = y.s.
Tim Petersf3615152003-01-01 21:51:37 +00004777 This is actually a requirement, an assumption we need to make about
4778 sane tzinfo classes.
4779
47803. The naive UTC time corresponding to x is x.n - x.o.
4781 This is again a requirement for a sane tzinfo class.
4782
47834. (x+k).s = x.s
Tim Peters8bb5ad22003-01-24 02:44:45 +00004784 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
Tim Petersf3615152003-01-01 21:51:37 +00004785
Tim Petersc5dc4da2003-01-02 17:55:03 +000047865. (x+k).n = x.n + k
Tim Petersf3615152003-01-01 21:51:37 +00004787 Again follows from how arithmetic is defined.
4788
Tim Peters8bb5ad22003-01-24 02:44:45 +00004789Now we can explain tz.fromutc(x). Let's assume it's an interesting case
Tim Petersf3615152003-01-01 21:51:37 +00004790(meaning that the various tzinfo methods exist, and don't blow up or return
4791None when called).
4792
Tim Petersa9bc1682003-01-11 03:39:11 +00004793The function wants to return a datetime y with timezone tz, equivalent to x.
Tim Peters8bb5ad22003-01-24 02:44:45 +00004794x is already in UTC.
Tim Petersf3615152003-01-01 21:51:37 +00004795
4796By #3, we want
4797
Tim Peters8bb5ad22003-01-24 02:44:45 +00004798 y.n - y.o = x.n [1]
Tim Petersf3615152003-01-01 21:51:37 +00004799
4800The algorithm starts by attaching tz to x.n, and calling that y. So
4801x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
4802becomes true; in effect, we want to solve [2] for k:
4803
Tim Peters8bb5ad22003-01-24 02:44:45 +00004804 (y+k).n - (y+k).o = x.n [2]
Tim Petersf3615152003-01-01 21:51:37 +00004805
4806By #1, this is the same as
4807
Tim Peters8bb5ad22003-01-24 02:44:45 +00004808 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
Tim Petersf3615152003-01-01 21:51:37 +00004809
4810By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
4811Substituting that into [3],
4812
Tim Peters8bb5ad22003-01-24 02:44:45 +00004813 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
4814 k - (y+k).s - (y+k).d = 0; rearranging,
4815 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
4816 k = y.s - (y+k).d
Tim Petersf3615152003-01-01 21:51:37 +00004817
Tim Peters8bb5ad22003-01-24 02:44:45 +00004818On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
4819approximate k by ignoring the (y+k).d term at first. Note that k can't be
4820very large, since all offset-returning methods return a duration of magnitude
4821less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
4822be 0, so ignoring it has no consequence then.
Tim Petersf3615152003-01-01 21:51:37 +00004823
4824In any case, the new value is
4825
Tim Peters8bb5ad22003-01-24 02:44:45 +00004826 z = y + y.s [4]
Tim Petersf3615152003-01-01 21:51:37 +00004827
Tim Peters8bb5ad22003-01-24 02:44:45 +00004828It's helpful to step back at look at [4] from a higher level: it's simply
4829mapping from UTC to tz's standard time.
Tim Petersc5dc4da2003-01-02 17:55:03 +00004830
4831At this point, if
4832
Tim Peters8bb5ad22003-01-24 02:44:45 +00004833 z.n - z.o = x.n [5]
Tim Petersc5dc4da2003-01-02 17:55:03 +00004834
4835we have an equivalent time, and are almost done. The insecurity here is
Tim Petersf3615152003-01-01 21:51:37 +00004836at the start of daylight time. Picture US Eastern for concreteness. The wall
4837time 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 +00004838sense then. The docs ask that an Eastern tzinfo class consider such a time to
4839be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
4840on the day DST starts. We want to return the 1:MM EST spelling because that's
Tim Petersf3615152003-01-01 21:51:37 +00004841the only spelling that makes sense on the local wall clock.
4842
Tim Petersc5dc4da2003-01-02 17:55:03 +00004843In fact, if [5] holds at this point, we do have the standard-time spelling,
4844but that takes a bit of proof. We first prove a stronger result. What's the
4845difference between the LHS and RHS of [5]? Let
Tim Petersf3615152003-01-01 21:51:37 +00004846
Tim Peters8bb5ad22003-01-24 02:44:45 +00004847 diff = x.n - (z.n - z.o) [6]
Tim Petersf3615152003-01-01 21:51:37 +00004848
Tim Petersc5dc4da2003-01-02 17:55:03 +00004849Now
4850 z.n = by [4]
Tim Peters8bb5ad22003-01-24 02:44:45 +00004851 (y + y.s).n = by #5
4852 y.n + y.s = since y.n = x.n
4853 x.n + y.s = since z and y are have the same tzinfo member,
4854 y.s = z.s by #2
4855 x.n + z.s
Tim Petersf3615152003-01-01 21:51:37 +00004856
Tim Petersc5dc4da2003-01-02 17:55:03 +00004857Plugging that back into [6] gives
Tim Petersf3615152003-01-01 21:51:37 +00004858
Tim Petersc5dc4da2003-01-02 17:55:03 +00004859 diff =
Tim Peters8bb5ad22003-01-24 02:44:45 +00004860 x.n - ((x.n + z.s) - z.o) = expanding
4861 x.n - x.n - z.s + z.o = cancelling
4862 - z.s + z.o = by #2
Tim Petersc5dc4da2003-01-02 17:55:03 +00004863 z.d
Tim Petersf3615152003-01-01 21:51:37 +00004864
Tim Petersc5dc4da2003-01-02 17:55:03 +00004865So diff = z.d.
Tim Petersf3615152003-01-01 21:51:37 +00004866
Tim Petersc5dc4da2003-01-02 17:55:03 +00004867If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
Tim Peters8bb5ad22003-01-24 02:44:45 +00004868spelling we wanted in the endcase described above. We're done. Contrarily,
4869if z.d = 0, then we have a UTC equivalent, and are also done.
Tim Petersf3615152003-01-01 21:51:37 +00004870
Tim Petersc5dc4da2003-01-02 17:55:03 +00004871If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
4872add to z (in effect, z is in tz's standard time, and we need to shift the
Tim Peters8bb5ad22003-01-24 02:44:45 +00004873local clock into tz's daylight time).
Tim Petersf3615152003-01-01 21:51:37 +00004874
Tim Petersc5dc4da2003-01-02 17:55:03 +00004875Let
Tim Petersf3615152003-01-01 21:51:37 +00004876
Tim Peters4fede1a2003-01-04 00:26:59 +00004877 z' = z + z.d = z + diff [7]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004878
Tim Peters4fede1a2003-01-04 00:26:59 +00004879and we can again ask whether
Tim Petersc3bb26a2003-01-02 03:14:59 +00004880
Tim Peters8bb5ad22003-01-24 02:44:45 +00004881 z'.n - z'.o = x.n [8]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004882
Tim Peters8bb5ad22003-01-24 02:44:45 +00004883If so, we're done. If not, the tzinfo class is insane, according to the
4884assumptions we've made. This also requires a bit of proof. As before, let's
4885compute the difference between the LHS and RHS of [8] (and skipping some of
4886the justifications for the kinds of substitutions we've done several times
4887already):
Tim Peters4fede1a2003-01-04 00:26:59 +00004888
Tim Peters8bb5ad22003-01-24 02:44:45 +00004889 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
4890 x.n - (z.n + diff - z'.o) = replacing diff via [6]
4891 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
4892 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
4893 - z.n + z.n - z.o + z'.o = cancel z.n
Tim Peters4fede1a2003-01-04 00:26:59 +00004894 - z.o + z'.o = #1 twice
4895 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
4896 z'.d - z.d
4897
4898So 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 +00004899we've found the UTC-equivalent so are done. In fact, we stop with [7] and
4900return z', not bothering to compute z'.d.
Tim Peters4fede1a2003-01-04 00:26:59 +00004901
Tim Peters8bb5ad22003-01-24 02:44:45 +00004902How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
4903a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
4904would have to change the result dst() returns: we start in DST, and moving
4905a little further into it takes us out of DST.
Tim Peters4fede1a2003-01-04 00:26:59 +00004906
Tim Peters8bb5ad22003-01-24 02:44:45 +00004907There isn't a sane case where this can happen. The closest it gets is at
4908the end of DST, where there's an hour in UTC with no spelling in a hybrid
4909tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
4910that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
4911UTC) because the docs insist on that, but 0:MM is taken as being in daylight
4912time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
4913clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
4914standard time. Since that's what the local clock *does*, we want to map both
4915UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
Tim Peters4fede1a2003-01-04 00:26:59 +00004916in local time, but so it goes -- it's the way the local clock works.
4917
Tim Peters8bb5ad22003-01-24 02:44:45 +00004918When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
4919so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
4920z' = 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 +00004921(correctly) concludes that z' is not UTC-equivalent to x.
4922
4923Because we know z.d said z was in daylight time (else [5] would have held and
4924we would have stopped then), and we know z.d != z'.d (else [8] would have held
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00004925and we would have stopped then), and there are only 2 possible values dst() can
Tim Peters4fede1a2003-01-04 00:26:59 +00004926return in Eastern, it follows that z'.d must be 0 (which it is in the example,
4927but the reasoning doesn't depend on the example -- it depends on there being
4928two possible dst() outcomes, one zero and the other non-zero). Therefore
Tim Peters8bb5ad22003-01-24 02:44:45 +00004929z' must be in standard time, and is the spelling we want in this case.
4930
4931Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
4932concerned (because it takes z' as being in standard time rather than the
4933daylight time we intend here), but returning it gives the real-life "local
4934clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
4935tz.
4936
4937When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
4938the 1:MM standard time spelling we want.
4939
4940So how can this break? One of the assumptions must be violated. Two
4941possibilities:
4942
49431) [2] effectively says that y.s is invariant across all y belong to a given
4944 time zone. This isn't true if, for political reasons or continental drift,
4945 a region decides to change its base offset from UTC.
4946
49472) There may be versions of "double daylight" time where the tail end of
4948 the analysis gives up a step too early. I haven't thought about that
4949 enough to say.
4950
4951In any case, it's clear that the default fromutc() is strong enough to handle
4952"almost all" time zones: so long as the standard offset is invariant, it
4953doesn't matter if daylight time transition points change from year to year, or
4954if daylight time is skipped in some years; it doesn't matter how large or
4955small dst() may get within its bounds; and it doesn't even matter if some
4956perverse time zone returns a negative dst()). So a breaking case must be
4957pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
Tim Petersf3615152003-01-01 21:51:37 +00004958--------------------------------------------------------------------------- */