blob: 9ae77326b663505ad470ee6101f34c66ff0a84f9 [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 */
Georg Brandl6d7c3632006-09-30 11:17:43 +00001152 int totalnew; /* number bytes total in output format buffer,
Tim Peters2a799bf2002-12-16 20:18:38 +00001153 exclusive of trailing \0 */
Georg Brandl6d7c3632006-09-30 11:17:43 +00001154 int usednew; /* number bytes used so far in output format buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001155
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);
Neal Norwitzd5b0c9b2006-03-20 01:58:39 +00001231 ptoappend = PyString_AS_STRING(zreplacement);
1232 ntoappend = PyString_GET_SIZE(zreplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001233 }
1234 else if (ch == 'Z') {
1235 /* format tzname */
1236 if (Zreplacement == NULL) {
1237 PyObject *tzinfo = get_tzinfo_member(object);
1238 Zreplacement = PyString_FromString("");
1239 if (Zreplacement == NULL) goto Done;
1240 if (tzinfo != Py_None && tzinfo != NULL) {
Tim Petersbad8ff02002-12-30 20:52:32 +00001241 PyObject *temp;
1242 assert(tzinfoarg != NULL);
1243 temp = call_tzname(tzinfo, tzinfoarg);
Tim Peters2a799bf2002-12-16 20:18:38 +00001244 if (temp == NULL) goto Done;
1245 if (temp != Py_None) {
1246 assert(PyString_Check(temp));
1247 /* Since the tzname is getting
1248 * stuffed into the format, we
1249 * have to double any % signs
1250 * so that strftime doesn't
1251 * treat them as format codes.
1252 */
1253 Py_DECREF(Zreplacement);
1254 Zreplacement = PyObject_CallMethod(
1255 temp, "replace",
1256 "ss", "%", "%%");
1257 Py_DECREF(temp);
1258 if (Zreplacement == NULL)
1259 goto Done;
Neal Norwitzd5b0c9b2006-03-20 01:58:39 +00001260 if (!PyString_Check(Zreplacement)) {
1261 PyErr_SetString(PyExc_TypeError, "tzname.replace() did not return a string");
1262 goto Done;
1263 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001264 }
1265 else
1266 Py_DECREF(temp);
1267 }
1268 }
1269 assert(Zreplacement != NULL);
Neal Norwitzd5b0c9b2006-03-20 01:58:39 +00001270 ptoappend = PyString_AS_STRING(Zreplacement);
1271 ntoappend = PyString_GET_SIZE(Zreplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001272 }
1273 else {
Tim Peters328fff72002-12-20 01:31:27 +00001274 /* percent followed by neither z nor Z */
1275 ptoappend = pin - 2;
Tim Peters2a799bf2002-12-16 20:18:38 +00001276 ntoappend = 2;
1277 }
1278
1279 /* Append the ntoappend chars starting at ptoappend to
1280 * the new format.
1281 */
Neal Norwitzd5b0c9b2006-03-20 01:58:39 +00001282 assert(ptoappend != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001283 assert(ntoappend >= 0);
1284 if (ntoappend == 0)
1285 continue;
1286 while (usednew + ntoappend > totalnew) {
1287 int bigger = totalnew << 1;
1288 if ((bigger >> 1) != totalnew) { /* overflow */
1289 PyErr_NoMemory();
1290 goto Done;
1291 }
1292 if (_PyString_Resize(&newfmt, bigger) < 0)
1293 goto Done;
1294 totalnew = bigger;
1295 pnew = PyString_AsString(newfmt) + usednew;
1296 }
1297 memcpy(pnew, ptoappend, ntoappend);
1298 pnew += ntoappend;
1299 usednew += ntoappend;
1300 assert(usednew <= totalnew);
1301 } /* end while() */
1302
1303 if (_PyString_Resize(&newfmt, usednew) < 0)
1304 goto Done;
1305 {
1306 PyObject *time = PyImport_ImportModule("time");
1307 if (time == NULL)
1308 goto Done;
1309 result = PyObject_CallMethod(time, "strftime", "OO",
1310 newfmt, timetuple);
1311 Py_DECREF(time);
1312 }
1313 Done:
1314 Py_XDECREF(zreplacement);
1315 Py_XDECREF(Zreplacement);
1316 Py_XDECREF(newfmt);
1317 return result;
1318}
1319
1320static char *
1321isoformat_date(PyDateTime_Date *dt, char buffer[], int bufflen)
1322{
1323 int x;
1324 x = PyOS_snprintf(buffer, bufflen,
1325 "%04d-%02d-%02d",
1326 GET_YEAR(dt), GET_MONTH(dt), GET_DAY(dt));
1327 return buffer + x;
1328}
1329
1330static void
1331isoformat_time(PyDateTime_DateTime *dt, char buffer[], int bufflen)
1332{
1333 int us = DATE_GET_MICROSECOND(dt);
1334
1335 PyOS_snprintf(buffer, bufflen,
1336 "%02d:%02d:%02d", /* 8 characters */
1337 DATE_GET_HOUR(dt),
1338 DATE_GET_MINUTE(dt),
1339 DATE_GET_SECOND(dt));
1340 if (us)
1341 PyOS_snprintf(buffer + 8, bufflen - 8, ".%06d", us);
1342}
1343
1344/* ---------------------------------------------------------------------------
1345 * Wrap functions from the time module. These aren't directly available
1346 * from C. Perhaps they should be.
1347 */
1348
1349/* Call time.time() and return its result (a Python float). */
1350static PyObject *
Guido van Rossumbd43e912002-12-16 20:34:55 +00001351time_time(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00001352{
1353 PyObject *result = NULL;
1354 PyObject *time = PyImport_ImportModule("time");
1355
1356 if (time != NULL) {
1357 result = PyObject_CallMethod(time, "time", "()");
1358 Py_DECREF(time);
1359 }
1360 return result;
1361}
1362
1363/* Build a time.struct_time. The weekday and day number are automatically
1364 * computed from the y,m,d args.
1365 */
1366static PyObject *
1367build_struct_time(int y, int m, int d, int hh, int mm, int ss, int dstflag)
1368{
1369 PyObject *time;
1370 PyObject *result = NULL;
1371
1372 time = PyImport_ImportModule("time");
1373 if (time != NULL) {
1374 result = PyObject_CallMethod(time, "struct_time",
1375 "((iiiiiiiii))",
1376 y, m, d,
1377 hh, mm, ss,
1378 weekday(y, m, d),
1379 days_before_month(y, m) + d,
1380 dstflag);
1381 Py_DECREF(time);
1382 }
1383 return result;
1384}
1385
1386/* ---------------------------------------------------------------------------
1387 * Miscellaneous helpers.
1388 */
1389
1390/* For obscure reasons, we need to use tp_richcompare instead of tp_compare.
1391 * The comparisons here all most naturally compute a cmp()-like result.
1392 * This little helper turns that into a bool result for rich comparisons.
1393 */
1394static PyObject *
1395diff_to_bool(int diff, int op)
1396{
1397 PyObject *result;
1398 int istrue;
1399
1400 switch (op) {
1401 case Py_EQ: istrue = diff == 0; break;
1402 case Py_NE: istrue = diff != 0; break;
1403 case Py_LE: istrue = diff <= 0; break;
1404 case Py_GE: istrue = diff >= 0; break;
1405 case Py_LT: istrue = diff < 0; break;
1406 case Py_GT: istrue = diff > 0; break;
1407 default:
1408 assert(! "op unknown");
1409 istrue = 0; /* To shut up compiler */
1410 }
1411 result = istrue ? Py_True : Py_False;
1412 Py_INCREF(result);
1413 return result;
1414}
1415
Tim Peters07534a62003-02-07 22:50:28 +00001416/* Raises a "can't compare" TypeError and returns NULL. */
1417static PyObject *
1418cmperror(PyObject *a, PyObject *b)
1419{
1420 PyErr_Format(PyExc_TypeError,
1421 "can't compare %s to %s",
1422 a->ob_type->tp_name, b->ob_type->tp_name);
1423 return NULL;
1424}
1425
Tim Peters2a799bf2002-12-16 20:18:38 +00001426/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +00001427 * Cached Python objects; these are set by the module init function.
1428 */
1429
1430/* Conversion factors. */
1431static PyObject *us_per_us = NULL; /* 1 */
1432static PyObject *us_per_ms = NULL; /* 1000 */
1433static PyObject *us_per_second = NULL; /* 1000000 */
1434static PyObject *us_per_minute = NULL; /* 1e6 * 60 as Python int */
1435static PyObject *us_per_hour = NULL; /* 1e6 * 3600 as Python long */
1436static PyObject *us_per_day = NULL; /* 1e6 * 3600 * 24 as Python long */
1437static PyObject *us_per_week = NULL; /* 1e6*3600*24*7 as Python long */
1438static PyObject *seconds_per_day = NULL; /* 3600*24 as Python int */
1439
Tim Peters2a799bf2002-12-16 20:18:38 +00001440/* ---------------------------------------------------------------------------
1441 * Class implementations.
1442 */
1443
1444/*
1445 * PyDateTime_Delta implementation.
1446 */
1447
1448/* Convert a timedelta to a number of us,
1449 * (24*3600*self.days + self.seconds)*1000000 + self.microseconds
1450 * as a Python int or long.
1451 * Doing mixed-radix arithmetic by hand instead is excruciating in C,
1452 * due to ubiquitous overflow possibilities.
1453 */
1454static PyObject *
1455delta_to_microseconds(PyDateTime_Delta *self)
1456{
1457 PyObject *x1 = NULL;
1458 PyObject *x2 = NULL;
1459 PyObject *x3 = NULL;
1460 PyObject *result = NULL;
1461
1462 x1 = PyInt_FromLong(GET_TD_DAYS(self));
1463 if (x1 == NULL)
1464 goto Done;
1465 x2 = PyNumber_Multiply(x1, seconds_per_day); /* days in seconds */
1466 if (x2 == NULL)
1467 goto Done;
1468 Py_DECREF(x1);
1469 x1 = NULL;
1470
1471 /* x2 has days in seconds */
1472 x1 = PyInt_FromLong(GET_TD_SECONDS(self)); /* seconds */
1473 if (x1 == NULL)
1474 goto Done;
1475 x3 = PyNumber_Add(x1, x2); /* days and seconds in seconds */
1476 if (x3 == NULL)
1477 goto Done;
1478 Py_DECREF(x1);
1479 Py_DECREF(x2);
1480 x1 = x2 = NULL;
1481
1482 /* x3 has days+seconds in seconds */
1483 x1 = PyNumber_Multiply(x3, us_per_second); /* us */
1484 if (x1 == NULL)
1485 goto Done;
1486 Py_DECREF(x3);
1487 x3 = NULL;
1488
1489 /* x1 has days+seconds in us */
1490 x2 = PyInt_FromLong(GET_TD_MICROSECONDS(self));
1491 if (x2 == NULL)
1492 goto Done;
1493 result = PyNumber_Add(x1, x2);
1494
1495Done:
1496 Py_XDECREF(x1);
1497 Py_XDECREF(x2);
1498 Py_XDECREF(x3);
1499 return result;
1500}
1501
1502/* Convert a number of us (as a Python int or long) to a timedelta.
1503 */
1504static PyObject *
Tim Petersb0c854d2003-05-17 15:57:00 +00001505microseconds_to_delta_ex(PyObject *pyus, PyTypeObject *type)
Tim Peters2a799bf2002-12-16 20:18:38 +00001506{
1507 int us;
1508 int s;
1509 int d;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001510 long temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001511
1512 PyObject *tuple = NULL;
1513 PyObject *num = NULL;
1514 PyObject *result = NULL;
1515
1516 tuple = PyNumber_Divmod(pyus, us_per_second);
1517 if (tuple == NULL)
1518 goto Done;
1519
1520 num = PyTuple_GetItem(tuple, 1); /* us */
1521 if (num == NULL)
1522 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001523 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001524 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001525 if (temp == -1 && PyErr_Occurred())
1526 goto Done;
1527 assert(0 <= temp && temp < 1000000);
1528 us = (int)temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001529 if (us < 0) {
1530 /* The divisor was positive, so this must be an error. */
1531 assert(PyErr_Occurred());
1532 goto Done;
1533 }
1534
1535 num = PyTuple_GetItem(tuple, 0); /* leftover seconds */
1536 if (num == NULL)
1537 goto Done;
1538 Py_INCREF(num);
1539 Py_DECREF(tuple);
1540
1541 tuple = PyNumber_Divmod(num, seconds_per_day);
1542 if (tuple == NULL)
1543 goto Done;
1544 Py_DECREF(num);
1545
1546 num = PyTuple_GetItem(tuple, 1); /* seconds */
1547 if (num == NULL)
1548 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001549 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001550 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001551 if (temp == -1 && PyErr_Occurred())
1552 goto Done;
1553 assert(0 <= temp && temp < 24*3600);
1554 s = (int)temp;
1555
Tim Peters2a799bf2002-12-16 20:18:38 +00001556 if (s < 0) {
1557 /* The divisor was positive, so this must be an error. */
1558 assert(PyErr_Occurred());
1559 goto Done;
1560 }
1561
1562 num = PyTuple_GetItem(tuple, 0); /* leftover days */
1563 if (num == NULL)
1564 goto Done;
1565 Py_INCREF(num);
Tim Peters0b0f41c2002-12-19 01:44:38 +00001566 temp = PyLong_AsLong(num);
1567 if (temp == -1 && PyErr_Occurred())
Tim Peters2a799bf2002-12-16 20:18:38 +00001568 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001569 d = (int)temp;
1570 if ((long)d != temp) {
1571 PyErr_SetString(PyExc_OverflowError, "normalized days too "
1572 "large to fit in a C int");
1573 goto Done;
1574 }
Tim Petersb0c854d2003-05-17 15:57:00 +00001575 result = new_delta_ex(d, s, us, 0, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001576
1577Done:
1578 Py_XDECREF(tuple);
1579 Py_XDECREF(num);
1580 return result;
1581}
1582
Tim Petersb0c854d2003-05-17 15:57:00 +00001583#define microseconds_to_delta(pymicros) \
1584 microseconds_to_delta_ex(pymicros, &PyDateTime_DeltaType)
1585
Tim Peters2a799bf2002-12-16 20:18:38 +00001586static PyObject *
1587multiply_int_timedelta(PyObject *intobj, PyDateTime_Delta *delta)
1588{
1589 PyObject *pyus_in;
1590 PyObject *pyus_out;
1591 PyObject *result;
1592
1593 pyus_in = delta_to_microseconds(delta);
1594 if (pyus_in == NULL)
1595 return NULL;
1596
1597 pyus_out = PyNumber_Multiply(pyus_in, intobj);
1598 Py_DECREF(pyus_in);
1599 if (pyus_out == NULL)
1600 return NULL;
1601
1602 result = microseconds_to_delta(pyus_out);
1603 Py_DECREF(pyus_out);
1604 return result;
1605}
1606
1607static PyObject *
1608divide_timedelta_int(PyDateTime_Delta *delta, PyObject *intobj)
1609{
1610 PyObject *pyus_in;
1611 PyObject *pyus_out;
1612 PyObject *result;
1613
1614 pyus_in = delta_to_microseconds(delta);
1615 if (pyus_in == NULL)
1616 return NULL;
1617
1618 pyus_out = PyNumber_FloorDivide(pyus_in, intobj);
1619 Py_DECREF(pyus_in);
1620 if (pyus_out == NULL)
1621 return NULL;
1622
1623 result = microseconds_to_delta(pyus_out);
1624 Py_DECREF(pyus_out);
1625 return result;
1626}
1627
1628static PyObject *
1629delta_add(PyObject *left, PyObject *right)
1630{
1631 PyObject *result = Py_NotImplemented;
1632
1633 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1634 /* delta + delta */
1635 /* The C-level additions can't overflow because of the
1636 * invariant bounds.
1637 */
1638 int days = GET_TD_DAYS(left) + GET_TD_DAYS(right);
1639 int seconds = GET_TD_SECONDS(left) + GET_TD_SECONDS(right);
1640 int microseconds = GET_TD_MICROSECONDS(left) +
1641 GET_TD_MICROSECONDS(right);
1642 result = new_delta(days, seconds, microseconds, 1);
1643 }
1644
1645 if (result == Py_NotImplemented)
1646 Py_INCREF(result);
1647 return result;
1648}
1649
1650static PyObject *
1651delta_negative(PyDateTime_Delta *self)
1652{
1653 return new_delta(-GET_TD_DAYS(self),
1654 -GET_TD_SECONDS(self),
1655 -GET_TD_MICROSECONDS(self),
1656 1);
1657}
1658
1659static PyObject *
1660delta_positive(PyDateTime_Delta *self)
1661{
1662 /* Could optimize this (by returning self) if this isn't a
1663 * subclass -- but who uses unary + ? Approximately nobody.
1664 */
1665 return new_delta(GET_TD_DAYS(self),
1666 GET_TD_SECONDS(self),
1667 GET_TD_MICROSECONDS(self),
1668 0);
1669}
1670
1671static PyObject *
1672delta_abs(PyDateTime_Delta *self)
1673{
1674 PyObject *result;
1675
1676 assert(GET_TD_MICROSECONDS(self) >= 0);
1677 assert(GET_TD_SECONDS(self) >= 0);
1678
1679 if (GET_TD_DAYS(self) < 0)
1680 result = delta_negative(self);
1681 else
1682 result = delta_positive(self);
1683
1684 return result;
1685}
1686
1687static PyObject *
1688delta_subtract(PyObject *left, PyObject *right)
1689{
1690 PyObject *result = Py_NotImplemented;
1691
1692 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1693 /* delta - delta */
1694 PyObject *minus_right = PyNumber_Negative(right);
1695 if (minus_right) {
1696 result = delta_add(left, minus_right);
1697 Py_DECREF(minus_right);
1698 }
1699 else
1700 result = NULL;
1701 }
1702
1703 if (result == Py_NotImplemented)
1704 Py_INCREF(result);
1705 return result;
1706}
1707
1708/* This is more natural as a tp_compare, but doesn't work then: for whatever
1709 * reason, Python's try_3way_compare ignores tp_compare unless
1710 * PyInstance_Check returns true, but these aren't old-style classes.
1711 */
1712static PyObject *
1713delta_richcompare(PyDateTime_Delta *self, PyObject *other, int op)
1714{
Tim Peters07534a62003-02-07 22:50:28 +00001715 int diff = 42; /* nonsense */
Tim Peters2a799bf2002-12-16 20:18:38 +00001716
Tim Petersaa7d8492003-02-08 03:28:59 +00001717 if (PyDelta_Check(other)) {
Tim Peters07534a62003-02-07 22:50:28 +00001718 diff = GET_TD_DAYS(self) - GET_TD_DAYS(other);
1719 if (diff == 0) {
1720 diff = GET_TD_SECONDS(self) - GET_TD_SECONDS(other);
1721 if (diff == 0)
1722 diff = GET_TD_MICROSECONDS(self) -
1723 GET_TD_MICROSECONDS(other);
1724 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001725 }
Tim Peters07534a62003-02-07 22:50:28 +00001726 else if (op == Py_EQ || op == Py_NE)
1727 diff = 1; /* any non-zero value will do */
1728
1729 else /* stop this from falling back to address comparison */
1730 return cmperror((PyObject *)self, other);
1731
Tim Peters2a799bf2002-12-16 20:18:38 +00001732 return diff_to_bool(diff, op);
1733}
1734
1735static PyObject *delta_getstate(PyDateTime_Delta *self);
1736
1737static long
1738delta_hash(PyDateTime_Delta *self)
1739{
1740 if (self->hashcode == -1) {
1741 PyObject *temp = delta_getstate(self);
1742 if (temp != NULL) {
1743 self->hashcode = PyObject_Hash(temp);
1744 Py_DECREF(temp);
1745 }
1746 }
1747 return self->hashcode;
1748}
1749
1750static PyObject *
1751delta_multiply(PyObject *left, PyObject *right)
1752{
1753 PyObject *result = Py_NotImplemented;
1754
1755 if (PyDelta_Check(left)) {
1756 /* delta * ??? */
1757 if (PyInt_Check(right) || PyLong_Check(right))
1758 result = multiply_int_timedelta(right,
1759 (PyDateTime_Delta *) left);
1760 }
1761 else if (PyInt_Check(left) || PyLong_Check(left))
1762 result = multiply_int_timedelta(left,
1763 (PyDateTime_Delta *) right);
1764
1765 if (result == Py_NotImplemented)
1766 Py_INCREF(result);
1767 return result;
1768}
1769
1770static PyObject *
1771delta_divide(PyObject *left, PyObject *right)
1772{
1773 PyObject *result = Py_NotImplemented;
1774
1775 if (PyDelta_Check(left)) {
1776 /* delta * ??? */
1777 if (PyInt_Check(right) || PyLong_Check(right))
1778 result = divide_timedelta_int(
1779 (PyDateTime_Delta *)left,
1780 right);
1781 }
1782
1783 if (result == Py_NotImplemented)
1784 Py_INCREF(result);
1785 return result;
1786}
1787
1788/* Fold in the value of the tag ("seconds", "weeks", etc) component of a
1789 * timedelta constructor. sofar is the # of microseconds accounted for
1790 * so far, and there are factor microseconds per current unit, the number
1791 * of which is given by num. num * factor is added to sofar in a
1792 * numerically careful way, and that's the result. Any fractional
1793 * microseconds left over (this can happen if num is a float type) are
1794 * added into *leftover.
1795 * Note that there are many ways this can give an error (NULL) return.
1796 */
1797static PyObject *
1798accum(const char* tag, PyObject *sofar, PyObject *num, PyObject *factor,
1799 double *leftover)
1800{
1801 PyObject *prod;
1802 PyObject *sum;
1803
1804 assert(num != NULL);
1805
1806 if (PyInt_Check(num) || PyLong_Check(num)) {
1807 prod = PyNumber_Multiply(num, factor);
1808 if (prod == NULL)
1809 return NULL;
1810 sum = PyNumber_Add(sofar, prod);
1811 Py_DECREF(prod);
1812 return sum;
1813 }
1814
1815 if (PyFloat_Check(num)) {
1816 double dnum;
1817 double fracpart;
1818 double intpart;
1819 PyObject *x;
1820 PyObject *y;
1821
1822 /* The Plan: decompose num into an integer part and a
1823 * fractional part, num = intpart + fracpart.
1824 * Then num * factor ==
1825 * intpart * factor + fracpart * factor
1826 * and the LHS can be computed exactly in long arithmetic.
1827 * The RHS is again broken into an int part and frac part.
1828 * and the frac part is added into *leftover.
1829 */
1830 dnum = PyFloat_AsDouble(num);
1831 if (dnum == -1.0 && PyErr_Occurred())
1832 return NULL;
1833 fracpart = modf(dnum, &intpart);
1834 x = PyLong_FromDouble(intpart);
1835 if (x == NULL)
1836 return NULL;
1837
1838 prod = PyNumber_Multiply(x, factor);
1839 Py_DECREF(x);
1840 if (prod == NULL)
1841 return NULL;
1842
1843 sum = PyNumber_Add(sofar, prod);
1844 Py_DECREF(prod);
1845 if (sum == NULL)
1846 return NULL;
1847
1848 if (fracpart == 0.0)
1849 return sum;
1850 /* So far we've lost no information. Dealing with the
1851 * fractional part requires float arithmetic, and may
1852 * lose a little info.
1853 */
1854 assert(PyInt_Check(factor) || PyLong_Check(factor));
1855 if (PyInt_Check(factor))
1856 dnum = (double)PyInt_AsLong(factor);
1857 else
1858 dnum = PyLong_AsDouble(factor);
1859
1860 dnum *= fracpart;
1861 fracpart = modf(dnum, &intpart);
1862 x = PyLong_FromDouble(intpart);
1863 if (x == NULL) {
1864 Py_DECREF(sum);
1865 return NULL;
1866 }
1867
1868 y = PyNumber_Add(sum, x);
1869 Py_DECREF(sum);
1870 Py_DECREF(x);
1871 *leftover += fracpart;
1872 return y;
1873 }
1874
1875 PyErr_Format(PyExc_TypeError,
1876 "unsupported type for timedelta %s component: %s",
1877 tag, num->ob_type->tp_name);
1878 return NULL;
1879}
1880
1881static PyObject *
1882delta_new(PyTypeObject *type, PyObject *args, PyObject *kw)
1883{
1884 PyObject *self = NULL;
1885
1886 /* Argument objects. */
1887 PyObject *day = NULL;
1888 PyObject *second = NULL;
1889 PyObject *us = NULL;
1890 PyObject *ms = NULL;
1891 PyObject *minute = NULL;
1892 PyObject *hour = NULL;
1893 PyObject *week = NULL;
1894
1895 PyObject *x = NULL; /* running sum of microseconds */
1896 PyObject *y = NULL; /* temp sum of microseconds */
1897 double leftover_us = 0.0;
1898
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00001899 static char *keywords[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001900 "days", "seconds", "microseconds", "milliseconds",
1901 "minutes", "hours", "weeks", NULL
1902 };
1903
1904 if (PyArg_ParseTupleAndKeywords(args, kw, "|OOOOOOO:__new__",
1905 keywords,
1906 &day, &second, &us,
1907 &ms, &minute, &hour, &week) == 0)
1908 goto Done;
1909
1910 x = PyInt_FromLong(0);
1911 if (x == NULL)
1912 goto Done;
1913
1914#define CLEANUP \
1915 Py_DECREF(x); \
1916 x = y; \
1917 if (x == NULL) \
1918 goto Done
1919
1920 if (us) {
1921 y = accum("microseconds", x, us, us_per_us, &leftover_us);
1922 CLEANUP;
1923 }
1924 if (ms) {
1925 y = accum("milliseconds", x, ms, us_per_ms, &leftover_us);
1926 CLEANUP;
1927 }
1928 if (second) {
1929 y = accum("seconds", x, second, us_per_second, &leftover_us);
1930 CLEANUP;
1931 }
1932 if (minute) {
1933 y = accum("minutes", x, minute, us_per_minute, &leftover_us);
1934 CLEANUP;
1935 }
1936 if (hour) {
1937 y = accum("hours", x, hour, us_per_hour, &leftover_us);
1938 CLEANUP;
1939 }
1940 if (day) {
1941 y = accum("days", x, day, us_per_day, &leftover_us);
1942 CLEANUP;
1943 }
1944 if (week) {
1945 y = accum("weeks", x, week, us_per_week, &leftover_us);
1946 CLEANUP;
1947 }
1948 if (leftover_us) {
1949 /* Round to nearest whole # of us, and add into x. */
Tim Peters5d644dd2003-01-02 16:32:54 +00001950 PyObject *temp = PyLong_FromLong(round_to_long(leftover_us));
Tim Peters2a799bf2002-12-16 20:18:38 +00001951 if (temp == NULL) {
1952 Py_DECREF(x);
1953 goto Done;
1954 }
1955 y = PyNumber_Add(x, temp);
1956 Py_DECREF(temp);
1957 CLEANUP;
1958 }
1959
Tim Petersb0c854d2003-05-17 15:57:00 +00001960 self = microseconds_to_delta_ex(x, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001961 Py_DECREF(x);
1962Done:
1963 return self;
1964
1965#undef CLEANUP
1966}
1967
1968static int
1969delta_nonzero(PyDateTime_Delta *self)
1970{
1971 return (GET_TD_DAYS(self) != 0
1972 || GET_TD_SECONDS(self) != 0
1973 || GET_TD_MICROSECONDS(self) != 0);
1974}
1975
1976static PyObject *
1977delta_repr(PyDateTime_Delta *self)
1978{
1979 if (GET_TD_MICROSECONDS(self) != 0)
1980 return PyString_FromFormat("%s(%d, %d, %d)",
1981 self->ob_type->tp_name,
1982 GET_TD_DAYS(self),
1983 GET_TD_SECONDS(self),
1984 GET_TD_MICROSECONDS(self));
1985 if (GET_TD_SECONDS(self) != 0)
1986 return PyString_FromFormat("%s(%d, %d)",
1987 self->ob_type->tp_name,
1988 GET_TD_DAYS(self),
1989 GET_TD_SECONDS(self));
1990
1991 return PyString_FromFormat("%s(%d)",
1992 self->ob_type->tp_name,
1993 GET_TD_DAYS(self));
1994}
1995
1996static PyObject *
1997delta_str(PyDateTime_Delta *self)
1998{
1999 int days = GET_TD_DAYS(self);
2000 int seconds = GET_TD_SECONDS(self);
2001 int us = GET_TD_MICROSECONDS(self);
2002 int hours;
2003 int minutes;
Tim Petersba873472002-12-18 20:19:21 +00002004 char buf[100];
2005 char *pbuf = buf;
2006 size_t buflen = sizeof(buf);
2007 int n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002008
2009 minutes = divmod(seconds, 60, &seconds);
2010 hours = divmod(minutes, 60, &minutes);
2011
2012 if (days) {
Tim Petersba873472002-12-18 20:19:21 +00002013 n = PyOS_snprintf(pbuf, buflen, "%d day%s, ", days,
2014 (days == 1 || days == -1) ? "" : "s");
2015 if (n < 0 || (size_t)n >= buflen)
2016 goto Fail;
2017 pbuf += n;
2018 buflen -= (size_t)n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002019 }
2020
Tim Petersba873472002-12-18 20:19:21 +00002021 n = PyOS_snprintf(pbuf, buflen, "%d:%02d:%02d",
2022 hours, minutes, seconds);
2023 if (n < 0 || (size_t)n >= buflen)
2024 goto Fail;
2025 pbuf += n;
2026 buflen -= (size_t)n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002027
2028 if (us) {
Tim Petersba873472002-12-18 20:19:21 +00002029 n = PyOS_snprintf(pbuf, buflen, ".%06d", us);
2030 if (n < 0 || (size_t)n >= buflen)
2031 goto Fail;
2032 pbuf += n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002033 }
2034
Tim Petersba873472002-12-18 20:19:21 +00002035 return PyString_FromStringAndSize(buf, pbuf - buf);
2036
2037 Fail:
2038 PyErr_SetString(PyExc_SystemError, "goofy result from PyOS_snprintf");
2039 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002040}
2041
Tim Peters371935f2003-02-01 01:52:50 +00002042/* Pickle support, a simple use of __reduce__. */
2043
Tim Petersb57f8f02003-02-01 02:54:15 +00002044/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002045static PyObject *
2046delta_getstate(PyDateTime_Delta *self)
2047{
2048 return Py_BuildValue("iii", GET_TD_DAYS(self),
2049 GET_TD_SECONDS(self),
2050 GET_TD_MICROSECONDS(self));
2051}
2052
Tim Peters2a799bf2002-12-16 20:18:38 +00002053static PyObject *
2054delta_reduce(PyDateTime_Delta* self)
2055{
Tim Peters8a60c222003-02-01 01:47:29 +00002056 return Py_BuildValue("ON", self->ob_type, delta_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002057}
2058
2059#define OFFSET(field) offsetof(PyDateTime_Delta, field)
2060
2061static PyMemberDef delta_members[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002062
Neal Norwitzdfb80862002-12-19 02:30:56 +00002063 {"days", T_INT, OFFSET(days), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002064 PyDoc_STR("Number of days.")},
2065
Neal Norwitzdfb80862002-12-19 02:30:56 +00002066 {"seconds", T_INT, OFFSET(seconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002067 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
2068
Neal Norwitzdfb80862002-12-19 02:30:56 +00002069 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002070 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
2071 {NULL}
2072};
2073
2074static PyMethodDef delta_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002075 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
2076 PyDoc_STR("__reduce__() -> (cls, state)")},
2077
Tim Peters2a799bf2002-12-16 20:18:38 +00002078 {NULL, NULL},
2079};
2080
2081static char delta_doc[] =
2082PyDoc_STR("Difference between two datetime values.");
2083
2084static PyNumberMethods delta_as_number = {
2085 delta_add, /* nb_add */
2086 delta_subtract, /* nb_subtract */
2087 delta_multiply, /* nb_multiply */
2088 delta_divide, /* nb_divide */
2089 0, /* nb_remainder */
2090 0, /* nb_divmod */
2091 0, /* nb_power */
2092 (unaryfunc)delta_negative, /* nb_negative */
2093 (unaryfunc)delta_positive, /* nb_positive */
2094 (unaryfunc)delta_abs, /* nb_absolute */
2095 (inquiry)delta_nonzero, /* nb_nonzero */
2096 0, /*nb_invert*/
2097 0, /*nb_lshift*/
2098 0, /*nb_rshift*/
2099 0, /*nb_and*/
2100 0, /*nb_xor*/
2101 0, /*nb_or*/
2102 0, /*nb_coerce*/
2103 0, /*nb_int*/
2104 0, /*nb_long*/
2105 0, /*nb_float*/
2106 0, /*nb_oct*/
2107 0, /*nb_hex*/
2108 0, /*nb_inplace_add*/
2109 0, /*nb_inplace_subtract*/
2110 0, /*nb_inplace_multiply*/
2111 0, /*nb_inplace_divide*/
2112 0, /*nb_inplace_remainder*/
2113 0, /*nb_inplace_power*/
2114 0, /*nb_inplace_lshift*/
2115 0, /*nb_inplace_rshift*/
2116 0, /*nb_inplace_and*/
2117 0, /*nb_inplace_xor*/
2118 0, /*nb_inplace_or*/
2119 delta_divide, /* nb_floor_divide */
2120 0, /* nb_true_divide */
2121 0, /* nb_inplace_floor_divide */
2122 0, /* nb_inplace_true_divide */
2123};
2124
2125static PyTypeObject PyDateTime_DeltaType = {
2126 PyObject_HEAD_INIT(NULL)
2127 0, /* ob_size */
2128 "datetime.timedelta", /* tp_name */
2129 sizeof(PyDateTime_Delta), /* tp_basicsize */
2130 0, /* tp_itemsize */
2131 0, /* tp_dealloc */
2132 0, /* tp_print */
2133 0, /* tp_getattr */
2134 0, /* tp_setattr */
2135 0, /* tp_compare */
2136 (reprfunc)delta_repr, /* tp_repr */
2137 &delta_as_number, /* tp_as_number */
2138 0, /* tp_as_sequence */
2139 0, /* tp_as_mapping */
2140 (hashfunc)delta_hash, /* tp_hash */
2141 0, /* tp_call */
2142 (reprfunc)delta_str, /* tp_str */
2143 PyObject_GenericGetAttr, /* tp_getattro */
2144 0, /* tp_setattro */
2145 0, /* tp_as_buffer */
Tim Petersb0c854d2003-05-17 15:57:00 +00002146 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2147 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00002148 delta_doc, /* tp_doc */
2149 0, /* tp_traverse */
2150 0, /* tp_clear */
2151 (richcmpfunc)delta_richcompare, /* tp_richcompare */
2152 0, /* tp_weaklistoffset */
2153 0, /* tp_iter */
2154 0, /* tp_iternext */
2155 delta_methods, /* tp_methods */
2156 delta_members, /* tp_members */
2157 0, /* tp_getset */
2158 0, /* tp_base */
2159 0, /* tp_dict */
2160 0, /* tp_descr_get */
2161 0, /* tp_descr_set */
2162 0, /* tp_dictoffset */
2163 0, /* tp_init */
2164 0, /* tp_alloc */
2165 delta_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002166 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002167};
2168
2169/*
2170 * PyDateTime_Date implementation.
2171 */
2172
2173/* Accessor properties. */
2174
2175static PyObject *
2176date_year(PyDateTime_Date *self, void *unused)
2177{
2178 return PyInt_FromLong(GET_YEAR(self));
2179}
2180
2181static PyObject *
2182date_month(PyDateTime_Date *self, void *unused)
2183{
2184 return PyInt_FromLong(GET_MONTH(self));
2185}
2186
2187static PyObject *
2188date_day(PyDateTime_Date *self, void *unused)
2189{
2190 return PyInt_FromLong(GET_DAY(self));
2191}
2192
2193static PyGetSetDef date_getset[] = {
2194 {"year", (getter)date_year},
2195 {"month", (getter)date_month},
2196 {"day", (getter)date_day},
2197 {NULL}
2198};
2199
2200/* Constructors. */
2201
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002202static char *date_kws[] = {"year", "month", "day", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002203
Tim Peters2a799bf2002-12-16 20:18:38 +00002204static PyObject *
2205date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2206{
2207 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00002208 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00002209 int year;
2210 int month;
2211 int day;
2212
Guido van Rossum177e41a2003-01-30 22:06:23 +00002213 /* Check for invocation from pickle with __getstate__ state */
2214 if (PyTuple_GET_SIZE(args) == 1 &&
Tim Peters70533e22003-02-01 04:40:04 +00002215 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Tim Peters3f606292004-03-21 23:38:41 +00002216 PyString_GET_SIZE(state) == _PyDateTime_DATE_DATASIZE &&
2217 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00002218 {
Tim Peters70533e22003-02-01 04:40:04 +00002219 PyDateTime_Date *me;
2220
Tim Peters604c0132004-06-07 23:04:33 +00002221 me = (PyDateTime_Date *) (type->tp_alloc(type, 0));
Tim Peters70533e22003-02-01 04:40:04 +00002222 if (me != NULL) {
2223 char *pdata = PyString_AS_STRING(state);
2224 memcpy(me->data, pdata, _PyDateTime_DATE_DATASIZE);
2225 me->hashcode = -1;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002226 }
Tim Peters70533e22003-02-01 04:40:04 +00002227 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002228 }
2229
Tim Peters12bf3392002-12-24 05:41:27 +00002230 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00002231 &year, &month, &day)) {
2232 if (check_date_args(year, month, day) < 0)
2233 return NULL;
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002234 self = new_date_ex(year, month, day, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00002235 }
2236 return self;
2237}
2238
2239/* Return new date from localtime(t). */
2240static PyObject *
Tim Peters1b6f7a92004-06-20 02:50:16 +00002241date_local_from_time_t(PyObject *cls, double ts)
Tim Peters2a799bf2002-12-16 20:18:38 +00002242{
2243 struct tm *tm;
Tim Peters1b6f7a92004-06-20 02:50:16 +00002244 time_t t;
Tim Peters2a799bf2002-12-16 20:18:38 +00002245 PyObject *result = NULL;
2246
Tim Peters1b6f7a92004-06-20 02:50:16 +00002247 t = _PyTime_DoubleToTimet(ts);
2248 if (t == (time_t)-1 && PyErr_Occurred())
2249 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002250 tm = localtime(&t);
2251 if (tm)
2252 result = PyObject_CallFunction(cls, "iii",
2253 tm->tm_year + 1900,
2254 tm->tm_mon + 1,
2255 tm->tm_mday);
2256 else
2257 PyErr_SetString(PyExc_ValueError,
2258 "timestamp out of range for "
2259 "platform localtime() function");
2260 return result;
2261}
2262
2263/* Return new date from current time.
2264 * We say this is equivalent to fromtimestamp(time.time()), and the
2265 * only way to be sure of that is to *call* time.time(). That's not
2266 * generally the same as calling C's time.
2267 */
2268static PyObject *
2269date_today(PyObject *cls, PyObject *dummy)
2270{
2271 PyObject *time;
2272 PyObject *result;
2273
2274 time = time_time();
2275 if (time == NULL)
2276 return NULL;
2277
2278 /* Note well: today() is a class method, so this may not call
2279 * date.fromtimestamp. For example, it may call
2280 * datetime.fromtimestamp. That's why we need all the accuracy
2281 * time.time() delivers; if someone were gonzo about optimization,
2282 * date.today() could get away with plain C time().
2283 */
2284 result = PyObject_CallMethod(cls, "fromtimestamp", "O", time);
2285 Py_DECREF(time);
2286 return result;
2287}
2288
2289/* Return new date from given timestamp (Python timestamp -- a double). */
2290static PyObject *
2291date_fromtimestamp(PyObject *cls, PyObject *args)
2292{
2293 double timestamp;
2294 PyObject *result = NULL;
2295
2296 if (PyArg_ParseTuple(args, "d:fromtimestamp", &timestamp))
Tim Peters1b6f7a92004-06-20 02:50:16 +00002297 result = date_local_from_time_t(cls, timestamp);
Tim Peters2a799bf2002-12-16 20:18:38 +00002298 return result;
2299}
2300
2301/* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2302 * the ordinal is out of range.
2303 */
2304static PyObject *
2305date_fromordinal(PyObject *cls, PyObject *args)
2306{
2307 PyObject *result = NULL;
2308 int ordinal;
2309
2310 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2311 int year;
2312 int month;
2313 int day;
2314
2315 if (ordinal < 1)
2316 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2317 ">= 1");
2318 else {
2319 ord_to_ymd(ordinal, &year, &month, &day);
2320 result = PyObject_CallFunction(cls, "iii",
2321 year, month, day);
2322 }
2323 }
2324 return result;
2325}
2326
2327/*
2328 * Date arithmetic.
2329 */
2330
2331/* date + timedelta -> date. If arg negate is true, subtract the timedelta
2332 * instead.
2333 */
2334static PyObject *
2335add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
2336{
2337 PyObject *result = NULL;
2338 int year = GET_YEAR(date);
2339 int month = GET_MONTH(date);
2340 int deltadays = GET_TD_DAYS(delta);
2341 /* C-level overflow is impossible because |deltadays| < 1e9. */
2342 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
2343
2344 if (normalize_date(&year, &month, &day) >= 0)
2345 result = new_date(year, month, day);
2346 return result;
2347}
2348
2349static PyObject *
2350date_add(PyObject *left, PyObject *right)
2351{
2352 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2353 Py_INCREF(Py_NotImplemented);
2354 return Py_NotImplemented;
2355 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002356 if (PyDate_Check(left)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002357 /* date + ??? */
2358 if (PyDelta_Check(right))
2359 /* date + delta */
2360 return add_date_timedelta((PyDateTime_Date *) left,
2361 (PyDateTime_Delta *) right,
2362 0);
2363 }
2364 else {
2365 /* ??? + date
2366 * 'right' must be one of us, or we wouldn't have been called
2367 */
2368 if (PyDelta_Check(left))
2369 /* delta + date */
2370 return add_date_timedelta((PyDateTime_Date *) right,
2371 (PyDateTime_Delta *) left,
2372 0);
2373 }
2374 Py_INCREF(Py_NotImplemented);
2375 return Py_NotImplemented;
2376}
2377
2378static PyObject *
2379date_subtract(PyObject *left, PyObject *right)
2380{
2381 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2382 Py_INCREF(Py_NotImplemented);
2383 return Py_NotImplemented;
2384 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002385 if (PyDate_Check(left)) {
2386 if (PyDate_Check(right)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002387 /* date - date */
2388 int left_ord = ymd_to_ord(GET_YEAR(left),
2389 GET_MONTH(left),
2390 GET_DAY(left));
2391 int right_ord = ymd_to_ord(GET_YEAR(right),
2392 GET_MONTH(right),
2393 GET_DAY(right));
2394 return new_delta(left_ord - right_ord, 0, 0, 0);
2395 }
2396 if (PyDelta_Check(right)) {
2397 /* date - delta */
2398 return add_date_timedelta((PyDateTime_Date *) left,
2399 (PyDateTime_Delta *) right,
2400 1);
2401 }
2402 }
2403 Py_INCREF(Py_NotImplemented);
2404 return Py_NotImplemented;
2405}
2406
2407
2408/* Various ways to turn a date into a string. */
2409
2410static PyObject *
2411date_repr(PyDateTime_Date *self)
2412{
2413 char buffer[1028];
Skip Montanaro14f88992006-04-18 19:35:04 +00002414 const char *type_name;
Tim Peters2a799bf2002-12-16 20:18:38 +00002415
Skip Montanaro14f88992006-04-18 19:35:04 +00002416 type_name = self->ob_type->tp_name;
Tim Peters2a799bf2002-12-16 20:18:38 +00002417 PyOS_snprintf(buffer, sizeof(buffer), "%s(%d, %d, %d)",
Skip Montanaro14f88992006-04-18 19:35:04 +00002418 type_name,
Tim Peters2a799bf2002-12-16 20:18:38 +00002419 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2420
2421 return PyString_FromString(buffer);
2422}
2423
2424static PyObject *
2425date_isoformat(PyDateTime_Date *self)
2426{
2427 char buffer[128];
2428
2429 isoformat_date(self, buffer, sizeof(buffer));
2430 return PyString_FromString(buffer);
2431}
2432
Tim Peterse2df5ff2003-05-02 18:39:55 +00002433/* str() calls the appropriate isoformat() method. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002434static PyObject *
2435date_str(PyDateTime_Date *self)
2436{
2437 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
2438}
2439
2440
2441static PyObject *
2442date_ctime(PyDateTime_Date *self)
2443{
2444 return format_ctime(self, 0, 0, 0);
2445}
2446
2447static PyObject *
2448date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2449{
2450 /* This method can be inherited, and needs to call the
2451 * timetuple() method appropriate to self's class.
2452 */
2453 PyObject *result;
2454 PyObject *format;
2455 PyObject *tuple;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002456 static char *keywords[] = {"format", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00002457
2458 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
2459 &PyString_Type, &format))
2460 return NULL;
2461
2462 tuple = PyObject_CallMethod((PyObject *)self, "timetuple", "()");
2463 if (tuple == NULL)
2464 return NULL;
Tim Petersbad8ff02002-12-30 20:52:32 +00002465 result = wrap_strftime((PyObject *)self, format, tuple,
2466 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002467 Py_DECREF(tuple);
2468 return result;
2469}
2470
2471/* ISO methods. */
2472
2473static PyObject *
2474date_isoweekday(PyDateTime_Date *self)
2475{
2476 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2477
2478 return PyInt_FromLong(dow + 1);
2479}
2480
2481static PyObject *
2482date_isocalendar(PyDateTime_Date *self)
2483{
2484 int year = GET_YEAR(self);
2485 int week1_monday = iso_week1_monday(year);
2486 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
2487 int week;
2488 int day;
2489
2490 week = divmod(today - week1_monday, 7, &day);
2491 if (week < 0) {
2492 --year;
2493 week1_monday = iso_week1_monday(year);
2494 week = divmod(today - week1_monday, 7, &day);
2495 }
2496 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
2497 ++year;
2498 week = 0;
2499 }
2500 return Py_BuildValue("iii", year, week + 1, day + 1);
2501}
2502
2503/* Miscellaneous methods. */
2504
2505/* This is more natural as a tp_compare, but doesn't work then: for whatever
2506 * reason, Python's try_3way_compare ignores tp_compare unless
2507 * PyInstance_Check returns true, but these aren't old-style classes.
2508 */
2509static PyObject *
2510date_richcompare(PyDateTime_Date *self, PyObject *other, int op)
2511{
Tim Peters07534a62003-02-07 22:50:28 +00002512 int diff = 42; /* nonsense */
Tim Peters2a799bf2002-12-16 20:18:38 +00002513
Tim Peters07534a62003-02-07 22:50:28 +00002514 if (PyDate_Check(other))
2515 diff = memcmp(self->data, ((PyDateTime_Date *)other)->data,
2516 _PyDateTime_DATE_DATASIZE);
2517
2518 else if (PyObject_HasAttrString(other, "timetuple")) {
2519 /* A hook for other kinds of date objects. */
2520 Py_INCREF(Py_NotImplemented);
2521 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002522 }
Tim Peters07534a62003-02-07 22:50:28 +00002523 else if (op == Py_EQ || op == Py_NE)
2524 diff = 1; /* any non-zero value will do */
2525
2526 else /* stop this from falling back to address comparison */
2527 return cmperror((PyObject *)self, other);
2528
Tim Peters2a799bf2002-12-16 20:18:38 +00002529 return diff_to_bool(diff, op);
2530}
2531
2532static PyObject *
2533date_timetuple(PyDateTime_Date *self)
2534{
2535 return build_struct_time(GET_YEAR(self),
2536 GET_MONTH(self),
2537 GET_DAY(self),
2538 0, 0, 0, -1);
2539}
2540
Tim Peters12bf3392002-12-24 05:41:27 +00002541static PyObject *
2542date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2543{
2544 PyObject *clone;
2545 PyObject *tuple;
2546 int year = GET_YEAR(self);
2547 int month = GET_MONTH(self);
2548 int day = GET_DAY(self);
2549
2550 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
2551 &year, &month, &day))
2552 return NULL;
2553 tuple = Py_BuildValue("iii", year, month, day);
2554 if (tuple == NULL)
2555 return NULL;
2556 clone = date_new(self->ob_type, tuple, NULL);
2557 Py_DECREF(tuple);
2558 return clone;
2559}
2560
Tim Peters2a799bf2002-12-16 20:18:38 +00002561static PyObject *date_getstate(PyDateTime_Date *self);
2562
2563static long
2564date_hash(PyDateTime_Date *self)
2565{
2566 if (self->hashcode == -1) {
2567 PyObject *temp = date_getstate(self);
2568 if (temp != NULL) {
2569 self->hashcode = PyObject_Hash(temp);
2570 Py_DECREF(temp);
2571 }
2572 }
2573 return self->hashcode;
2574}
2575
2576static PyObject *
2577date_toordinal(PyDateTime_Date *self)
2578{
2579 return PyInt_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
2580 GET_DAY(self)));
2581}
2582
2583static PyObject *
2584date_weekday(PyDateTime_Date *self)
2585{
2586 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2587
2588 return PyInt_FromLong(dow);
2589}
2590
Tim Peters371935f2003-02-01 01:52:50 +00002591/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002592
Tim Petersb57f8f02003-02-01 02:54:15 +00002593/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002594static PyObject *
2595date_getstate(PyDateTime_Date *self)
2596{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002597 return Py_BuildValue(
2598 "(N)",
2599 PyString_FromStringAndSize((char *)self->data,
2600 _PyDateTime_DATE_DATASIZE));
Tim Peters2a799bf2002-12-16 20:18:38 +00002601}
2602
2603static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00002604date_reduce(PyDateTime_Date *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00002605{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002606 return Py_BuildValue("(ON)", self->ob_type, date_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002607}
2608
2609static PyMethodDef date_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002610
Tim Peters2a799bf2002-12-16 20:18:38 +00002611 /* Class methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00002612
Tim Peters2a799bf2002-12-16 20:18:38 +00002613 {"fromtimestamp", (PyCFunction)date_fromtimestamp, METH_VARARGS |
2614 METH_CLASS,
2615 PyDoc_STR("timestamp -> local date from a POSIX timestamp (like "
2616 "time.time()).")},
2617
2618 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
2619 METH_CLASS,
2620 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
2621 "ordinal.")},
2622
2623 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
2624 PyDoc_STR("Current date or datetime: same as "
2625 "self.__class__.fromtimestamp(time.time()).")},
2626
2627 /* Instance methods: */
2628
2629 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
2630 PyDoc_STR("Return ctime() style string.")},
2631
2632 {"strftime", (PyCFunction)date_strftime, METH_KEYWORDS,
2633 PyDoc_STR("format -> strftime() style string.")},
2634
2635 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
2636 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
2637
2638 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
2639 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
2640 "weekday.")},
2641
2642 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
2643 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
2644
2645 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
2646 PyDoc_STR("Return the day of the week represented by the date.\n"
2647 "Monday == 1 ... Sunday == 7")},
2648
2649 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
2650 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
2651 "1 is day 1.")},
2652
2653 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
2654 PyDoc_STR("Return the day of the week represented by the date.\n"
2655 "Monday == 0 ... Sunday == 6")},
2656
Tim Peters12bf3392002-12-24 05:41:27 +00002657 {"replace", (PyCFunction)date_replace, METH_KEYWORDS,
2658 PyDoc_STR("Return date with new specified fields.")},
2659
Guido van Rossum177e41a2003-01-30 22:06:23 +00002660 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
2661 PyDoc_STR("__reduce__() -> (cls, state)")},
2662
Tim Peters2a799bf2002-12-16 20:18:38 +00002663 {NULL, NULL}
2664};
2665
2666static char date_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00002667PyDoc_STR("date(year, month, day) --> date object");
Tim Peters2a799bf2002-12-16 20:18:38 +00002668
2669static PyNumberMethods date_as_number = {
2670 date_add, /* nb_add */
2671 date_subtract, /* nb_subtract */
2672 0, /* nb_multiply */
2673 0, /* nb_divide */
2674 0, /* nb_remainder */
2675 0, /* nb_divmod */
2676 0, /* nb_power */
2677 0, /* nb_negative */
2678 0, /* nb_positive */
2679 0, /* nb_absolute */
2680 0, /* nb_nonzero */
2681};
2682
2683static PyTypeObject PyDateTime_DateType = {
2684 PyObject_HEAD_INIT(NULL)
2685 0, /* ob_size */
2686 "datetime.date", /* tp_name */
2687 sizeof(PyDateTime_Date), /* tp_basicsize */
2688 0, /* tp_itemsize */
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002689 0, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00002690 0, /* tp_print */
2691 0, /* tp_getattr */
2692 0, /* tp_setattr */
2693 0, /* tp_compare */
2694 (reprfunc)date_repr, /* tp_repr */
2695 &date_as_number, /* tp_as_number */
2696 0, /* tp_as_sequence */
2697 0, /* tp_as_mapping */
2698 (hashfunc)date_hash, /* tp_hash */
2699 0, /* tp_call */
2700 (reprfunc)date_str, /* tp_str */
2701 PyObject_GenericGetAttr, /* tp_getattro */
2702 0, /* tp_setattro */
2703 0, /* tp_as_buffer */
2704 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2705 Py_TPFLAGS_BASETYPE, /* tp_flags */
2706 date_doc, /* tp_doc */
2707 0, /* tp_traverse */
2708 0, /* tp_clear */
2709 (richcmpfunc)date_richcompare, /* tp_richcompare */
2710 0, /* tp_weaklistoffset */
2711 0, /* tp_iter */
2712 0, /* tp_iternext */
2713 date_methods, /* tp_methods */
2714 0, /* tp_members */
2715 date_getset, /* tp_getset */
2716 0, /* tp_base */
2717 0, /* tp_dict */
2718 0, /* tp_descr_get */
2719 0, /* tp_descr_set */
2720 0, /* tp_dictoffset */
2721 0, /* tp_init */
2722 0, /* tp_alloc */
2723 date_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002724 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002725};
2726
2727/*
Tim Peters2a799bf2002-12-16 20:18:38 +00002728 * PyDateTime_TZInfo implementation.
2729 */
2730
2731/* This is a pure abstract base class, so doesn't do anything beyond
2732 * raising NotImplemented exceptions. Real tzinfo classes need
2733 * to derive from this. This is mostly for clarity, and for efficiency in
Tim Petersa9bc1682003-01-11 03:39:11 +00002734 * datetime and time constructors (their tzinfo arguments need to
Tim Peters2a799bf2002-12-16 20:18:38 +00002735 * be subclasses of this tzinfo class, which is easy and quick to check).
2736 *
2737 * Note: For reasons having to do with pickling of subclasses, we have
2738 * to allow tzinfo objects to be instantiated. This wasn't an issue
2739 * in the Python implementation (__init__() could raise NotImplementedError
2740 * there without ill effect), but doing so in the C implementation hit a
2741 * brick wall.
2742 */
2743
2744static PyObject *
2745tzinfo_nogo(const char* methodname)
2746{
2747 PyErr_Format(PyExc_NotImplementedError,
2748 "a tzinfo subclass must implement %s()",
2749 methodname);
2750 return NULL;
2751}
2752
2753/* Methods. A subclass must implement these. */
2754
Tim Peters52dcce22003-01-23 16:36:11 +00002755static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002756tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
2757{
2758 return tzinfo_nogo("tzname");
2759}
2760
Tim Peters52dcce22003-01-23 16:36:11 +00002761static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002762tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
2763{
2764 return tzinfo_nogo("utcoffset");
2765}
2766
Tim Peters52dcce22003-01-23 16:36:11 +00002767static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002768tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
2769{
2770 return tzinfo_nogo("dst");
2771}
2772
Tim Peters52dcce22003-01-23 16:36:11 +00002773static PyObject *
2774tzinfo_fromutc(PyDateTime_TZInfo *self, PyDateTime_DateTime *dt)
2775{
2776 int y, m, d, hh, mm, ss, us;
2777
2778 PyObject *result;
2779 int off, dst;
2780 int none;
2781 int delta;
2782
2783 if (! PyDateTime_Check(dt)) {
2784 PyErr_SetString(PyExc_TypeError,
2785 "fromutc: argument must be a datetime");
2786 return NULL;
2787 }
2788 if (! HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
2789 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
2790 "is not self");
2791 return NULL;
2792 }
2793
2794 off = call_utcoffset(dt->tzinfo, (PyObject *)dt, &none);
2795 if (off == -1 && PyErr_Occurred())
2796 return NULL;
2797 if (none) {
2798 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2799 "utcoffset() result required");
2800 return NULL;
2801 }
2802
2803 dst = call_dst(dt->tzinfo, (PyObject *)dt, &none);
2804 if (dst == -1 && PyErr_Occurred())
2805 return NULL;
2806 if (none) {
2807 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2808 "dst() result required");
2809 return NULL;
2810 }
2811
2812 y = GET_YEAR(dt);
2813 m = GET_MONTH(dt);
2814 d = GET_DAY(dt);
2815 hh = DATE_GET_HOUR(dt);
2816 mm = DATE_GET_MINUTE(dt);
2817 ss = DATE_GET_SECOND(dt);
2818 us = DATE_GET_MICROSECOND(dt);
2819
2820 delta = off - dst;
2821 mm += delta;
2822 if ((mm < 0 || mm >= 60) &&
2823 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Petersb1049e82003-01-23 17:20:36 +00002824 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00002825 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2826 if (result == NULL)
2827 return result;
2828
2829 dst = call_dst(dt->tzinfo, result, &none);
2830 if (dst == -1 && PyErr_Occurred())
2831 goto Fail;
2832 if (none)
2833 goto Inconsistent;
2834 if (dst == 0)
2835 return result;
2836
2837 mm += dst;
2838 if ((mm < 0 || mm >= 60) &&
2839 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
2840 goto Fail;
2841 Py_DECREF(result);
2842 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2843 return result;
2844
2845Inconsistent:
2846 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave"
2847 "inconsistent results; cannot convert");
2848
2849 /* fall thru to failure */
2850Fail:
2851 Py_DECREF(result);
2852 return NULL;
2853}
2854
Tim Peters2a799bf2002-12-16 20:18:38 +00002855/*
2856 * Pickle support. This is solely so that tzinfo subclasses can use
Guido van Rossum177e41a2003-01-30 22:06:23 +00002857 * pickling -- tzinfo itself is supposed to be uninstantiable.
Tim Peters2a799bf2002-12-16 20:18:38 +00002858 */
2859
Guido van Rossum177e41a2003-01-30 22:06:23 +00002860static PyObject *
2861tzinfo_reduce(PyObject *self)
2862{
2863 PyObject *args, *state, *tmp;
2864 PyObject *getinitargs, *getstate;
Tim Peters2a799bf2002-12-16 20:18:38 +00002865
Guido van Rossum177e41a2003-01-30 22:06:23 +00002866 tmp = PyTuple_New(0);
2867 if (tmp == NULL)
2868 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002869
Guido van Rossum177e41a2003-01-30 22:06:23 +00002870 getinitargs = PyObject_GetAttrString(self, "__getinitargs__");
2871 if (getinitargs != NULL) {
2872 args = PyObject_CallObject(getinitargs, tmp);
2873 Py_DECREF(getinitargs);
2874 if (args == NULL) {
2875 Py_DECREF(tmp);
2876 return NULL;
2877 }
2878 }
2879 else {
2880 PyErr_Clear();
2881 args = tmp;
2882 Py_INCREF(args);
2883 }
2884
2885 getstate = PyObject_GetAttrString(self, "__getstate__");
2886 if (getstate != NULL) {
2887 state = PyObject_CallObject(getstate, tmp);
2888 Py_DECREF(getstate);
2889 if (state == NULL) {
2890 Py_DECREF(args);
2891 Py_DECREF(tmp);
2892 return NULL;
2893 }
2894 }
2895 else {
2896 PyObject **dictptr;
2897 PyErr_Clear();
2898 state = Py_None;
2899 dictptr = _PyObject_GetDictPtr(self);
2900 if (dictptr && *dictptr && PyDict_Size(*dictptr))
2901 state = *dictptr;
2902 Py_INCREF(state);
2903 }
2904
2905 Py_DECREF(tmp);
2906
2907 if (state == Py_None) {
2908 Py_DECREF(state);
2909 return Py_BuildValue("(ON)", self->ob_type, args);
2910 }
2911 else
2912 return Py_BuildValue("(ONN)", self->ob_type, args, state);
2913}
Tim Peters2a799bf2002-12-16 20:18:38 +00002914
2915static PyMethodDef tzinfo_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002916
Tim Peters2a799bf2002-12-16 20:18:38 +00002917 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
2918 PyDoc_STR("datetime -> string name of time zone.")},
2919
2920 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
2921 PyDoc_STR("datetime -> minutes east of UTC (negative for "
2922 "west of UTC).")},
2923
2924 {"dst", (PyCFunction)tzinfo_dst, METH_O,
2925 PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
2926
Tim Peters52dcce22003-01-23 16:36:11 +00002927 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
2928 PyDoc_STR("datetime in UTC -> datetime in local time.")},
2929
Guido van Rossum177e41a2003-01-30 22:06:23 +00002930 {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
2931 PyDoc_STR("-> (cls, state)")},
2932
Tim Peters2a799bf2002-12-16 20:18:38 +00002933 {NULL, NULL}
2934};
2935
2936static char tzinfo_doc[] =
2937PyDoc_STR("Abstract base class for time zone info objects.");
2938
Neal Norwitzce3d34d2003-02-04 20:45:17 +00002939statichere PyTypeObject PyDateTime_TZInfoType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00002940 PyObject_HEAD_INIT(NULL)
2941 0, /* ob_size */
2942 "datetime.tzinfo", /* tp_name */
2943 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
2944 0, /* tp_itemsize */
2945 0, /* tp_dealloc */
2946 0, /* tp_print */
2947 0, /* tp_getattr */
2948 0, /* tp_setattr */
2949 0, /* tp_compare */
2950 0, /* tp_repr */
2951 0, /* tp_as_number */
2952 0, /* tp_as_sequence */
2953 0, /* tp_as_mapping */
2954 0, /* tp_hash */
2955 0, /* tp_call */
2956 0, /* tp_str */
2957 PyObject_GenericGetAttr, /* tp_getattro */
2958 0, /* tp_setattro */
2959 0, /* tp_as_buffer */
2960 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2961 Py_TPFLAGS_BASETYPE, /* tp_flags */
2962 tzinfo_doc, /* tp_doc */
2963 0, /* tp_traverse */
2964 0, /* tp_clear */
2965 0, /* tp_richcompare */
2966 0, /* tp_weaklistoffset */
2967 0, /* tp_iter */
2968 0, /* tp_iternext */
2969 tzinfo_methods, /* tp_methods */
2970 0, /* tp_members */
2971 0, /* tp_getset */
2972 0, /* tp_base */
2973 0, /* tp_dict */
2974 0, /* tp_descr_get */
2975 0, /* tp_descr_set */
2976 0, /* tp_dictoffset */
2977 0, /* tp_init */
2978 0, /* tp_alloc */
2979 PyType_GenericNew, /* tp_new */
2980 0, /* tp_free */
2981};
2982
2983/*
Tim Peters37f39822003-01-10 03:49:02 +00002984 * PyDateTime_Time implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00002985 */
2986
Tim Peters37f39822003-01-10 03:49:02 +00002987/* Accessor properties.
Tim Peters2a799bf2002-12-16 20:18:38 +00002988 */
2989
2990static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00002991time_hour(PyDateTime_Time *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00002992{
Tim Peters37f39822003-01-10 03:49:02 +00002993 return PyInt_FromLong(TIME_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002994}
2995
Tim Peters37f39822003-01-10 03:49:02 +00002996static PyObject *
2997time_minute(PyDateTime_Time *self, void *unused)
2998{
2999 return PyInt_FromLong(TIME_GET_MINUTE(self));
3000}
3001
3002/* The name time_second conflicted with some platform header file. */
3003static PyObject *
3004py_time_second(PyDateTime_Time *self, void *unused)
3005{
3006 return PyInt_FromLong(TIME_GET_SECOND(self));
3007}
3008
3009static PyObject *
3010time_microsecond(PyDateTime_Time *self, void *unused)
3011{
3012 return PyInt_FromLong(TIME_GET_MICROSECOND(self));
3013}
3014
3015static PyObject *
3016time_tzinfo(PyDateTime_Time *self, void *unused)
3017{
Tim Petersa032d2e2003-01-11 00:15:54 +00003018 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters37f39822003-01-10 03:49:02 +00003019 Py_INCREF(result);
3020 return result;
3021}
3022
3023static PyGetSetDef time_getset[] = {
3024 {"hour", (getter)time_hour},
3025 {"minute", (getter)time_minute},
3026 {"second", (getter)py_time_second},
3027 {"microsecond", (getter)time_microsecond},
3028 {"tzinfo", (getter)time_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003029 {NULL}
3030};
3031
3032/*
3033 * Constructors.
3034 */
3035
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003036static char *time_kws[] = {"hour", "minute", "second", "microsecond",
Tim Peters37f39822003-01-10 03:49:02 +00003037 "tzinfo", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00003038
Tim Peters2a799bf2002-12-16 20:18:38 +00003039static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003040time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003041{
3042 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003043 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003044 int hour = 0;
3045 int minute = 0;
3046 int second = 0;
3047 int usecond = 0;
3048 PyObject *tzinfo = Py_None;
3049
Guido van Rossum177e41a2003-01-30 22:06:23 +00003050 /* Check for invocation from pickle with __getstate__ state */
3051 if (PyTuple_GET_SIZE(args) >= 1 &&
3052 PyTuple_GET_SIZE(args) <= 2 &&
Tim Peters70533e22003-02-01 04:40:04 +00003053 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Armin Rigof4afb212005-11-07 07:15:48 +00003054 PyString_GET_SIZE(state) == _PyDateTime_TIME_DATASIZE &&
3055 ((unsigned char) (PyString_AS_STRING(state)[0])) < 24)
Guido van Rossum177e41a2003-01-30 22:06:23 +00003056 {
Tim Peters70533e22003-02-01 04:40:04 +00003057 PyDateTime_Time *me;
3058 char aware;
3059
3060 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003061 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003062 if (check_tzinfo_subclass(tzinfo) < 0) {
3063 PyErr_SetString(PyExc_TypeError, "bad "
3064 "tzinfo state arg");
3065 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003066 }
3067 }
Tim Peters70533e22003-02-01 04:40:04 +00003068 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003069 me = (PyDateTime_Time *) (type->tp_alloc(type, aware));
Tim Peters70533e22003-02-01 04:40:04 +00003070 if (me != NULL) {
3071 char *pdata = PyString_AS_STRING(state);
3072
3073 memcpy(me->data, pdata, _PyDateTime_TIME_DATASIZE);
3074 me->hashcode = -1;
3075 me->hastzinfo = aware;
3076 if (aware) {
3077 Py_INCREF(tzinfo);
3078 me->tzinfo = tzinfo;
3079 }
3080 }
3081 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003082 }
3083
Tim Peters37f39822003-01-10 03:49:02 +00003084 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO", time_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003085 &hour, &minute, &second, &usecond,
3086 &tzinfo)) {
3087 if (check_time_args(hour, minute, second, usecond) < 0)
3088 return NULL;
3089 if (check_tzinfo_subclass(tzinfo) < 0)
3090 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003091 self = new_time_ex(hour, minute, second, usecond, tzinfo,
3092 type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003093 }
3094 return self;
3095}
3096
3097/*
3098 * Destructor.
3099 */
3100
3101static void
Tim Peters37f39822003-01-10 03:49:02 +00003102time_dealloc(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003103{
Tim Petersa032d2e2003-01-11 00:15:54 +00003104 if (HASTZINFO(self)) {
Tim Peters37f39822003-01-10 03:49:02 +00003105 Py_XDECREF(self->tzinfo);
Neal Norwitz8e914d92003-01-10 15:29:16 +00003106 }
Tim Peters2a799bf2002-12-16 20:18:38 +00003107 self->ob_type->tp_free((PyObject *)self);
3108}
3109
3110/*
Tim Peters855fe882002-12-22 03:43:39 +00003111 * Indirect access to tzinfo methods.
Tim Peters2a799bf2002-12-16 20:18:38 +00003112 */
3113
Tim Peters2a799bf2002-12-16 20:18:38 +00003114/* These are all METH_NOARGS, so don't need to check the arglist. */
3115static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003116time_utcoffset(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003117 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003118 "utcoffset", Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003119}
3120
3121static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003122time_dst(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003123 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003124 "dst", Py_None);
Tim Peters855fe882002-12-22 03:43:39 +00003125}
3126
3127static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003128time_tzname(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003129 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003130 Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003131}
3132
3133/*
Tim Peters37f39822003-01-10 03:49:02 +00003134 * Various ways to turn a time into a string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003135 */
3136
3137static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003138time_repr(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003139{
Tim Peters37f39822003-01-10 03:49:02 +00003140 char buffer[100];
Skip Montanaro14f88992006-04-18 19:35:04 +00003141 const char *type_name = self->ob_type->tp_name;
Tim Peters37f39822003-01-10 03:49:02 +00003142 int h = TIME_GET_HOUR(self);
3143 int m = TIME_GET_MINUTE(self);
3144 int s = TIME_GET_SECOND(self);
3145 int us = TIME_GET_MICROSECOND(self);
3146 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003147
Tim Peters37f39822003-01-10 03:49:02 +00003148 if (us)
3149 PyOS_snprintf(buffer, sizeof(buffer),
Skip Montanaro14f88992006-04-18 19:35:04 +00003150 "%s(%d, %d, %d, %d)", type_name, h, m, s, us);
Tim Peters37f39822003-01-10 03:49:02 +00003151 else if (s)
3152 PyOS_snprintf(buffer, sizeof(buffer),
Skip Montanaro14f88992006-04-18 19:35:04 +00003153 "%s(%d, %d, %d)", type_name, h, m, s);
Tim Peters37f39822003-01-10 03:49:02 +00003154 else
3155 PyOS_snprintf(buffer, sizeof(buffer),
Skip Montanaro14f88992006-04-18 19:35:04 +00003156 "%s(%d, %d)", type_name, h, m);
Tim Peters37f39822003-01-10 03:49:02 +00003157 result = PyString_FromString(buffer);
Tim Petersa032d2e2003-01-11 00:15:54 +00003158 if (result != NULL && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +00003159 result = append_keyword_tzinfo(result, self->tzinfo);
3160 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003161}
3162
Tim Peters37f39822003-01-10 03:49:02 +00003163static PyObject *
3164time_str(PyDateTime_Time *self)
3165{
3166 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
3167}
Tim Peters2a799bf2002-12-16 20:18:38 +00003168
Martin v. Löwisb8d661b2007-02-18 08:50:38 +00003169/* Even though this silently ignores all arguments, it cannot
3170 be fixed to reject them in release25-maint */
Tim Peters2a799bf2002-12-16 20:18:38 +00003171static PyObject *
Martin v. Löwisb8d661b2007-02-18 08:50:38 +00003172time_isoformat(PyDateTime_Time *self, PyObject *unused_args,
3173 PyObject *unused_keywords)
Tim Peters2a799bf2002-12-16 20:18:38 +00003174{
3175 char buf[100];
Tim Peters37f39822003-01-10 03:49:02 +00003176 PyObject *result;
3177 /* Reuse the time format code from the datetime type. */
3178 PyDateTime_DateTime datetime;
3179 PyDateTime_DateTime *pdatetime = &datetime;
Tim Peters2a799bf2002-12-16 20:18:38 +00003180
Tim Peters37f39822003-01-10 03:49:02 +00003181 /* Copy over just the time bytes. */
3182 memcpy(pdatetime->data + _PyDateTime_DATE_DATASIZE,
3183 self->data,
3184 _PyDateTime_TIME_DATASIZE);
3185
3186 isoformat_time(pdatetime, buf, sizeof(buf));
3187 result = PyString_FromString(buf);
Tim Petersa032d2e2003-01-11 00:15:54 +00003188 if (result == NULL || ! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00003189 return result;
3190
3191 /* We need to append the UTC offset. */
3192 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00003193 Py_None) < 0) {
Tim Peters2a799bf2002-12-16 20:18:38 +00003194 Py_DECREF(result);
3195 return NULL;
3196 }
3197 PyString_ConcatAndDel(&result, PyString_FromString(buf));
3198 return result;
3199}
3200
Tim Peters37f39822003-01-10 03:49:02 +00003201static PyObject *
3202time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3203{
3204 PyObject *result;
3205 PyObject *format;
3206 PyObject *tuple;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003207 static char *keywords[] = {"format", NULL};
Tim Peters37f39822003-01-10 03:49:02 +00003208
3209 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
3210 &PyString_Type, &format))
3211 return NULL;
3212
3213 /* Python's strftime does insane things with the year part of the
3214 * timetuple. The year is forced to (the otherwise nonsensical)
3215 * 1900 to worm around that.
3216 */
3217 tuple = Py_BuildValue("iiiiiiiii",
Brett Cannond1080a32004-03-02 04:38:10 +00003218 1900, 1, 1, /* year, month, day */
Tim Peters37f39822003-01-10 03:49:02 +00003219 TIME_GET_HOUR(self),
3220 TIME_GET_MINUTE(self),
3221 TIME_GET_SECOND(self),
Brett Cannond1080a32004-03-02 04:38:10 +00003222 0, 1, -1); /* weekday, daynum, dst */
Tim Peters37f39822003-01-10 03:49:02 +00003223 if (tuple == NULL)
3224 return NULL;
3225 assert(PyTuple_Size(tuple) == 9);
3226 result = wrap_strftime((PyObject *)self, format, tuple, Py_None);
3227 Py_DECREF(tuple);
3228 return result;
3229}
Tim Peters2a799bf2002-12-16 20:18:38 +00003230
3231/*
3232 * Miscellaneous methods.
3233 */
3234
Tim Peters37f39822003-01-10 03:49:02 +00003235/* This is more natural as a tp_compare, but doesn't work then: for whatever
3236 * reason, Python's try_3way_compare ignores tp_compare unless
3237 * PyInstance_Check returns true, but these aren't old-style classes.
3238 */
3239static PyObject *
3240time_richcompare(PyDateTime_Time *self, PyObject *other, int op)
3241{
3242 int diff;
3243 naivety n1, n2;
3244 int offset1, offset2;
3245
3246 if (! PyTime_Check(other)) {
Tim Peters07534a62003-02-07 22:50:28 +00003247 if (op == Py_EQ || op == Py_NE) {
3248 PyObject *result = op == Py_EQ ? Py_False : Py_True;
3249 Py_INCREF(result);
3250 return result;
3251 }
Tim Peters37f39822003-01-10 03:49:02 +00003252 /* Stop this from falling back to address comparison. */
Tim Peters07534a62003-02-07 22:50:28 +00003253 return cmperror((PyObject *)self, other);
Tim Peters37f39822003-01-10 03:49:02 +00003254 }
3255 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1, Py_None,
3256 other, &offset2, &n2, Py_None) < 0)
3257 return NULL;
3258 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
3259 /* If they're both naive, or both aware and have the same offsets,
3260 * we get off cheap. Note that if they're both naive, offset1 ==
3261 * offset2 == 0 at this point.
3262 */
3263 if (n1 == n2 && offset1 == offset2) {
3264 diff = memcmp(self->data, ((PyDateTime_Time *)other)->data,
3265 _PyDateTime_TIME_DATASIZE);
3266 return diff_to_bool(diff, op);
3267 }
3268
3269 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
3270 assert(offset1 != offset2); /* else last "if" handled it */
3271 /* Convert everything except microseconds to seconds. These
3272 * can't overflow (no more than the # of seconds in 2 days).
3273 */
3274 offset1 = TIME_GET_HOUR(self) * 3600 +
3275 (TIME_GET_MINUTE(self) - offset1) * 60 +
3276 TIME_GET_SECOND(self);
3277 offset2 = TIME_GET_HOUR(other) * 3600 +
3278 (TIME_GET_MINUTE(other) - offset2) * 60 +
3279 TIME_GET_SECOND(other);
3280 diff = offset1 - offset2;
3281 if (diff == 0)
3282 diff = TIME_GET_MICROSECOND(self) -
3283 TIME_GET_MICROSECOND(other);
3284 return diff_to_bool(diff, op);
3285 }
3286
3287 assert(n1 != n2);
3288 PyErr_SetString(PyExc_TypeError,
3289 "can't compare offset-naive and "
3290 "offset-aware times");
3291 return NULL;
3292}
3293
3294static long
3295time_hash(PyDateTime_Time *self)
3296{
3297 if (self->hashcode == -1) {
3298 naivety n;
3299 int offset;
3300 PyObject *temp;
3301
3302 n = classify_utcoffset((PyObject *)self, Py_None, &offset);
3303 assert(n != OFFSET_UNKNOWN);
3304 if (n == OFFSET_ERROR)
3305 return -1;
3306
3307 /* Reduce this to a hash of another object. */
3308 if (offset == 0)
3309 temp = PyString_FromStringAndSize((char *)self->data,
3310 _PyDateTime_TIME_DATASIZE);
3311 else {
3312 int hour;
3313 int minute;
3314
3315 assert(n == OFFSET_AWARE);
Tim Petersa032d2e2003-01-11 00:15:54 +00003316 assert(HASTZINFO(self));
Tim Peters37f39822003-01-10 03:49:02 +00003317 hour = divmod(TIME_GET_HOUR(self) * 60 +
3318 TIME_GET_MINUTE(self) - offset,
3319 60,
3320 &minute);
3321 if (0 <= hour && hour < 24)
3322 temp = new_time(hour, minute,
3323 TIME_GET_SECOND(self),
3324 TIME_GET_MICROSECOND(self),
3325 Py_None);
3326 else
3327 temp = Py_BuildValue("iiii",
3328 hour, minute,
3329 TIME_GET_SECOND(self),
3330 TIME_GET_MICROSECOND(self));
3331 }
3332 if (temp != NULL) {
3333 self->hashcode = PyObject_Hash(temp);
3334 Py_DECREF(temp);
3335 }
3336 }
3337 return self->hashcode;
3338}
Tim Peters2a799bf2002-12-16 20:18:38 +00003339
Tim Peters12bf3392002-12-24 05:41:27 +00003340static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003341time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00003342{
3343 PyObject *clone;
3344 PyObject *tuple;
3345 int hh = TIME_GET_HOUR(self);
3346 int mm = TIME_GET_MINUTE(self);
3347 int ss = TIME_GET_SECOND(self);
3348 int us = TIME_GET_MICROSECOND(self);
Tim Petersa032d2e2003-01-11 00:15:54 +00003349 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00003350
3351 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO:replace",
Tim Peters37f39822003-01-10 03:49:02 +00003352 time_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00003353 &hh, &mm, &ss, &us, &tzinfo))
3354 return NULL;
3355 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
3356 if (tuple == NULL)
3357 return NULL;
Tim Peters37f39822003-01-10 03:49:02 +00003358 clone = time_new(self->ob_type, tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00003359 Py_DECREF(tuple);
3360 return clone;
3361}
3362
Tim Peters2a799bf2002-12-16 20:18:38 +00003363static int
Tim Peters37f39822003-01-10 03:49:02 +00003364time_nonzero(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003365{
3366 int offset;
3367 int none;
3368
3369 if (TIME_GET_SECOND(self) || TIME_GET_MICROSECOND(self)) {
3370 /* Since utcoffset is in whole minutes, nothing can
3371 * alter the conclusion that this is nonzero.
3372 */
3373 return 1;
3374 }
3375 offset = 0;
Tim Petersa032d2e2003-01-11 00:15:54 +00003376 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Petersbad8ff02002-12-30 20:52:32 +00003377 offset = call_utcoffset(self->tzinfo, Py_None, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00003378 if (offset == -1 && PyErr_Occurred())
3379 return -1;
3380 }
3381 return (TIME_GET_MINUTE(self) - offset + TIME_GET_HOUR(self)*60) != 0;
3382}
3383
Tim Peters371935f2003-02-01 01:52:50 +00003384/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003385
Tim Peters33e0f382003-01-10 02:05:14 +00003386/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003387 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
3388 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00003389 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00003390 */
3391static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003392time_getstate(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003393{
3394 PyObject *basestate;
3395 PyObject *result = NULL;
3396
Tim Peters33e0f382003-01-10 02:05:14 +00003397 basestate = PyString_FromStringAndSize((char *)self->data,
3398 _PyDateTime_TIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00003399 if (basestate != NULL) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003400 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003401 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00003402 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003403 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00003404 Py_DECREF(basestate);
3405 }
3406 return result;
3407}
3408
3409static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00003410time_reduce(PyDateTime_Time *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00003411{
Guido van Rossum177e41a2003-01-30 22:06:23 +00003412 return Py_BuildValue("(ON)", self->ob_type, time_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003413}
3414
Tim Peters37f39822003-01-10 03:49:02 +00003415static PyMethodDef time_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003416
Martin v. Löwisb8d661b2007-02-18 08:50:38 +00003417 {"isoformat", (PyCFunction)time_isoformat, METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003418 PyDoc_STR("Return string in ISO 8601 format, HH:MM:SS[.mmmmmm]"
3419 "[+HH:MM].")},
3420
Tim Peters37f39822003-01-10 03:49:02 +00003421 {"strftime", (PyCFunction)time_strftime, METH_KEYWORDS,
3422 PyDoc_STR("format -> strftime() style string.")},
3423
3424 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003425 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
3426
Tim Peters37f39822003-01-10 03:49:02 +00003427 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003428 PyDoc_STR("Return self.tzinfo.tzname(self).")},
3429
Tim Peters37f39822003-01-10 03:49:02 +00003430 {"dst", (PyCFunction)time_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003431 PyDoc_STR("Return self.tzinfo.dst(self).")},
3432
Tim Peters37f39822003-01-10 03:49:02 +00003433 {"replace", (PyCFunction)time_replace, METH_KEYWORDS,
3434 PyDoc_STR("Return time with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00003435
Guido van Rossum177e41a2003-01-30 22:06:23 +00003436 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
3437 PyDoc_STR("__reduce__() -> (cls, state)")},
3438
Tim Peters2a799bf2002-12-16 20:18:38 +00003439 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003440};
3441
Tim Peters37f39822003-01-10 03:49:02 +00003442static char time_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00003443PyDoc_STR("time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object\n\
3444\n\
3445All arguments are optional. tzinfo may be None, or an instance of\n\
3446a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00003447
Tim Peters37f39822003-01-10 03:49:02 +00003448static PyNumberMethods time_as_number = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003449 0, /* nb_add */
3450 0, /* nb_subtract */
3451 0, /* nb_multiply */
3452 0, /* nb_divide */
3453 0, /* nb_remainder */
3454 0, /* nb_divmod */
3455 0, /* nb_power */
3456 0, /* nb_negative */
3457 0, /* nb_positive */
3458 0, /* nb_absolute */
Tim Peters37f39822003-01-10 03:49:02 +00003459 (inquiry)time_nonzero, /* nb_nonzero */
Tim Peters2a799bf2002-12-16 20:18:38 +00003460};
3461
Tim Peters37f39822003-01-10 03:49:02 +00003462statichere PyTypeObject PyDateTime_TimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003463 PyObject_HEAD_INIT(NULL)
3464 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00003465 "datetime.time", /* tp_name */
Tim Peters37f39822003-01-10 03:49:02 +00003466 sizeof(PyDateTime_Time), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00003467 0, /* tp_itemsize */
Tim Peters37f39822003-01-10 03:49:02 +00003468 (destructor)time_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003469 0, /* tp_print */
3470 0, /* tp_getattr */
3471 0, /* tp_setattr */
3472 0, /* tp_compare */
Tim Peters37f39822003-01-10 03:49:02 +00003473 (reprfunc)time_repr, /* tp_repr */
3474 &time_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00003475 0, /* tp_as_sequence */
3476 0, /* tp_as_mapping */
Tim Peters37f39822003-01-10 03:49:02 +00003477 (hashfunc)time_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00003478 0, /* tp_call */
Tim Peters37f39822003-01-10 03:49:02 +00003479 (reprfunc)time_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00003480 PyObject_GenericGetAttr, /* tp_getattro */
3481 0, /* tp_setattro */
3482 0, /* tp_as_buffer */
3483 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
3484 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters37f39822003-01-10 03:49:02 +00003485 time_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003486 0, /* tp_traverse */
3487 0, /* tp_clear */
Tim Peters37f39822003-01-10 03:49:02 +00003488 (richcmpfunc)time_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00003489 0, /* tp_weaklistoffset */
3490 0, /* tp_iter */
3491 0, /* tp_iternext */
Tim Peters37f39822003-01-10 03:49:02 +00003492 time_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00003493 0, /* tp_members */
Tim Peters37f39822003-01-10 03:49:02 +00003494 time_getset, /* tp_getset */
3495 0, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00003496 0, /* tp_dict */
3497 0, /* tp_descr_get */
3498 0, /* tp_descr_set */
3499 0, /* tp_dictoffset */
3500 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00003501 time_alloc, /* tp_alloc */
Tim Peters37f39822003-01-10 03:49:02 +00003502 time_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00003503 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00003504};
3505
3506/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003507 * PyDateTime_DateTime implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003508 */
3509
Tim Petersa9bc1682003-01-11 03:39:11 +00003510/* Accessor properties. Properties for day, month, and year are inherited
3511 * from date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003512 */
3513
3514static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003515datetime_hour(PyDateTime_DateTime *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003516{
Tim Petersa9bc1682003-01-11 03:39:11 +00003517 return PyInt_FromLong(DATE_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003518}
3519
Tim Petersa9bc1682003-01-11 03:39:11 +00003520static PyObject *
3521datetime_minute(PyDateTime_DateTime *self, void *unused)
3522{
3523 return PyInt_FromLong(DATE_GET_MINUTE(self));
3524}
3525
3526static PyObject *
3527datetime_second(PyDateTime_DateTime *self, void *unused)
3528{
3529 return PyInt_FromLong(DATE_GET_SECOND(self));
3530}
3531
3532static PyObject *
3533datetime_microsecond(PyDateTime_DateTime *self, void *unused)
3534{
3535 return PyInt_FromLong(DATE_GET_MICROSECOND(self));
3536}
3537
3538static PyObject *
3539datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
3540{
3541 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3542 Py_INCREF(result);
3543 return result;
3544}
3545
3546static PyGetSetDef datetime_getset[] = {
3547 {"hour", (getter)datetime_hour},
3548 {"minute", (getter)datetime_minute},
3549 {"second", (getter)datetime_second},
3550 {"microsecond", (getter)datetime_microsecond},
3551 {"tzinfo", (getter)datetime_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003552 {NULL}
3553};
3554
3555/*
3556 * Constructors.
Tim Peters2a799bf2002-12-16 20:18:38 +00003557 */
3558
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003559static char *datetime_kws[] = {
Tim Peters12bf3392002-12-24 05:41:27 +00003560 "year", "month", "day", "hour", "minute", "second",
3561 "microsecond", "tzinfo", NULL
3562};
3563
Tim Peters2a799bf2002-12-16 20:18:38 +00003564static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003565datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003566{
3567 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003568 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003569 int year;
3570 int month;
3571 int day;
3572 int hour = 0;
3573 int minute = 0;
3574 int second = 0;
3575 int usecond = 0;
3576 PyObject *tzinfo = Py_None;
3577
Guido van Rossum177e41a2003-01-30 22:06:23 +00003578 /* Check for invocation from pickle with __getstate__ state */
3579 if (PyTuple_GET_SIZE(args) >= 1 &&
3580 PyTuple_GET_SIZE(args) <= 2 &&
Tim Peters70533e22003-02-01 04:40:04 +00003581 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Tim Peters3f606292004-03-21 23:38:41 +00003582 PyString_GET_SIZE(state) == _PyDateTime_DATETIME_DATASIZE &&
3583 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00003584 {
Tim Peters70533e22003-02-01 04:40:04 +00003585 PyDateTime_DateTime *me;
3586 char aware;
3587
3588 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003589 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003590 if (check_tzinfo_subclass(tzinfo) < 0) {
3591 PyErr_SetString(PyExc_TypeError, "bad "
3592 "tzinfo state arg");
3593 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003594 }
3595 }
Tim Peters70533e22003-02-01 04:40:04 +00003596 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003597 me = (PyDateTime_DateTime *) (type->tp_alloc(type , aware));
Tim Peters70533e22003-02-01 04:40:04 +00003598 if (me != NULL) {
3599 char *pdata = PyString_AS_STRING(state);
3600
3601 memcpy(me->data, pdata, _PyDateTime_DATETIME_DATASIZE);
3602 me->hashcode = -1;
3603 me->hastzinfo = aware;
3604 if (aware) {
3605 Py_INCREF(tzinfo);
3606 me->tzinfo = tzinfo;
3607 }
3608 }
3609 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003610 }
3611
Tim Petersa9bc1682003-01-11 03:39:11 +00003612 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO", datetime_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003613 &year, &month, &day, &hour, &minute,
3614 &second, &usecond, &tzinfo)) {
3615 if (check_date_args(year, month, day) < 0)
3616 return NULL;
3617 if (check_time_args(hour, minute, second, usecond) < 0)
3618 return NULL;
3619 if (check_tzinfo_subclass(tzinfo) < 0)
3620 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003621 self = new_datetime_ex(year, month, day,
3622 hour, minute, second, usecond,
3623 tzinfo, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003624 }
3625 return self;
3626}
3627
Tim Petersa9bc1682003-01-11 03:39:11 +00003628/* TM_FUNC is the shared type of localtime() and gmtime(). */
3629typedef struct tm *(*TM_FUNC)(const time_t *timer);
3630
3631/* Internal helper.
3632 * Build datetime from a time_t and a distinct count of microseconds.
3633 * Pass localtime or gmtime for f, to control the interpretation of timet.
3634 */
3635static PyObject *
3636datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
3637 PyObject *tzinfo)
3638{
3639 struct tm *tm;
3640 PyObject *result = NULL;
3641
3642 tm = f(&timet);
3643 if (tm) {
3644 /* The platform localtime/gmtime may insert leap seconds,
3645 * indicated by tm->tm_sec > 59. We don't care about them,
3646 * except to the extent that passing them on to the datetime
3647 * constructor would raise ValueError for a reason that
3648 * made no sense to the user.
3649 */
3650 if (tm->tm_sec > 59)
3651 tm->tm_sec = 59;
3652 result = PyObject_CallFunction(cls, "iiiiiiiO",
3653 tm->tm_year + 1900,
3654 tm->tm_mon + 1,
3655 tm->tm_mday,
3656 tm->tm_hour,
3657 tm->tm_min,
3658 tm->tm_sec,
3659 us,
3660 tzinfo);
3661 }
3662 else
3663 PyErr_SetString(PyExc_ValueError,
3664 "timestamp out of range for "
3665 "platform localtime()/gmtime() function");
3666 return result;
3667}
3668
3669/* Internal helper.
3670 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
3671 * to control the interpretation of the timestamp. Since a double doesn't
3672 * have enough bits to cover a datetime's full range of precision, it's
3673 * better to call datetime_from_timet_and_us provided you have a way
3674 * to get that much precision (e.g., C time() isn't good enough).
3675 */
3676static PyObject *
3677datetime_from_timestamp(PyObject *cls, TM_FUNC f, double timestamp,
3678 PyObject *tzinfo)
3679{
Tim Peters1b6f7a92004-06-20 02:50:16 +00003680 time_t timet;
3681 double fraction;
3682 int us;
Tim Petersa9bc1682003-01-11 03:39:11 +00003683
Tim Peters1b6f7a92004-06-20 02:50:16 +00003684 timet = _PyTime_DoubleToTimet(timestamp);
3685 if (timet == (time_t)-1 && PyErr_Occurred())
3686 return NULL;
3687 fraction = timestamp - (double)timet;
3688 us = (int)round_to_long(fraction * 1e6);
Georg Brandl6d78a582006-04-28 19:09:24 +00003689 /* If timestamp is less than one microsecond smaller than a
3690 * full second, round up. Otherwise, ValueErrors are raised
3691 * for some floats. */
3692 if (us == 1000000) {
3693 timet += 1;
3694 us = 0;
3695 }
Tim Petersa9bc1682003-01-11 03:39:11 +00003696 return datetime_from_timet_and_us(cls, f, timet, us, tzinfo);
3697}
3698
3699/* Internal helper.
3700 * Build most accurate possible datetime for current time. Pass localtime or
3701 * gmtime for f as appropriate.
3702 */
3703static PyObject *
3704datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
3705{
3706#ifdef HAVE_GETTIMEOFDAY
3707 struct timeval t;
3708
3709#ifdef GETTIMEOFDAY_NO_TZ
3710 gettimeofday(&t);
3711#else
3712 gettimeofday(&t, (struct timezone *)NULL);
3713#endif
3714 return datetime_from_timet_and_us(cls, f, t.tv_sec, (int)t.tv_usec,
3715 tzinfo);
3716
3717#else /* ! HAVE_GETTIMEOFDAY */
3718 /* No flavor of gettimeofday exists on this platform. Python's
3719 * time.time() does a lot of other platform tricks to get the
3720 * best time it can on the platform, and we're not going to do
3721 * better than that (if we could, the better code would belong
3722 * in time.time()!) We're limited by the precision of a double,
3723 * though.
3724 */
3725 PyObject *time;
3726 double dtime;
3727
3728 time = time_time();
3729 if (time == NULL)
3730 return NULL;
3731 dtime = PyFloat_AsDouble(time);
3732 Py_DECREF(time);
3733 if (dtime == -1.0 && PyErr_Occurred())
3734 return NULL;
3735 return datetime_from_timestamp(cls, f, dtime, tzinfo);
3736#endif /* ! HAVE_GETTIMEOFDAY */
3737}
3738
Tim Peters2a799bf2002-12-16 20:18:38 +00003739/* Return best possible local time -- this isn't constrained by the
3740 * precision of a timestamp.
3741 */
3742static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003743datetime_now(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003744{
Tim Peters10cadce2003-01-23 19:58:02 +00003745 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003746 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003747 static char *keywords[] = {"tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003748
Tim Peters10cadce2003-01-23 19:58:02 +00003749 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:now", keywords,
3750 &tzinfo))
3751 return NULL;
3752 if (check_tzinfo_subclass(tzinfo) < 0)
3753 return NULL;
3754
3755 self = datetime_best_possible(cls,
3756 tzinfo == Py_None ? localtime : gmtime,
3757 tzinfo);
3758 if (self != NULL && tzinfo != Py_None) {
3759 /* Convert UTC to tzinfo's zone. */
3760 PyObject *temp = self;
Tim Peters2a44a8d2003-01-23 20:53:10 +00003761 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
Tim Peters10cadce2003-01-23 19:58:02 +00003762 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003763 }
3764 return self;
3765}
3766
Tim Petersa9bc1682003-01-11 03:39:11 +00003767/* Return best possible UTC time -- this isn't constrained by the
3768 * precision of a timestamp.
3769 */
3770static PyObject *
3771datetime_utcnow(PyObject *cls, PyObject *dummy)
3772{
3773 return datetime_best_possible(cls, gmtime, Py_None);
3774}
3775
Tim Peters2a799bf2002-12-16 20:18:38 +00003776/* Return new local datetime from timestamp (Python timestamp -- a double). */
3777static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003778datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003779{
Tim Peters2a44a8d2003-01-23 20:53:10 +00003780 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003781 double timestamp;
3782 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003783 static char *keywords[] = {"timestamp", "tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003784
Tim Peters2a44a8d2003-01-23 20:53:10 +00003785 if (! PyArg_ParseTupleAndKeywords(args, kw, "d|O:fromtimestamp",
3786 keywords, &timestamp, &tzinfo))
3787 return NULL;
3788 if (check_tzinfo_subclass(tzinfo) < 0)
3789 return NULL;
3790
3791 self = datetime_from_timestamp(cls,
3792 tzinfo == Py_None ? localtime : gmtime,
3793 timestamp,
3794 tzinfo);
3795 if (self != NULL && tzinfo != Py_None) {
3796 /* Convert UTC to tzinfo's zone. */
3797 PyObject *temp = self;
3798 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3799 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003800 }
3801 return self;
3802}
3803
Tim Petersa9bc1682003-01-11 03:39:11 +00003804/* Return new UTC datetime from timestamp (Python timestamp -- a double). */
3805static PyObject *
3806datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
3807{
3808 double timestamp;
3809 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003810
Tim Petersa9bc1682003-01-11 03:39:11 +00003811 if (PyArg_ParseTuple(args, "d:utcfromtimestamp", &timestamp))
3812 result = datetime_from_timestamp(cls, gmtime, timestamp,
3813 Py_None);
3814 return result;
3815}
3816
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003817/* Return new datetime from time.strptime(). */
3818static PyObject *
3819datetime_strptime(PyObject *cls, PyObject *args)
3820{
3821 PyObject *result = NULL, *obj, *module;
3822 const char *string, *format;
3823
3824 if (!PyArg_ParseTuple(args, "ss:strptime", &string, &format))
3825 return NULL;
3826
3827 if ((module = PyImport_ImportModule("time")) == NULL)
3828 return NULL;
3829 obj = PyObject_CallMethod(module, "strptime", "ss", string, format);
3830 Py_DECREF(module);
3831
3832 if (obj != NULL) {
3833 int i, good_timetuple = 1;
3834 long int ia[6];
3835 if (PySequence_Check(obj) && PySequence_Size(obj) >= 6)
3836 for (i=0; i < 6; i++) {
3837 PyObject *p = PySequence_GetItem(obj, i);
Thomas Wouters3cfea2d2006-04-14 21:23:42 +00003838 if (p == NULL) {
3839 Py_DECREF(obj);
3840 return NULL;
3841 }
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003842 if (PyInt_Check(p))
3843 ia[i] = PyInt_AsLong(p);
3844 else
3845 good_timetuple = 0;
3846 Py_DECREF(p);
3847 }
3848 else
3849 good_timetuple = 0;
3850 if (good_timetuple)
3851 result = PyObject_CallFunction(cls, "iiiiii",
3852 ia[0], ia[1], ia[2], ia[3], ia[4], ia[5]);
3853 else
3854 PyErr_SetString(PyExc_ValueError,
3855 "unexpected value from time.strptime");
3856 Py_DECREF(obj);
3857 }
3858 return result;
3859}
3860
Tim Petersa9bc1682003-01-11 03:39:11 +00003861/* Return new datetime from date/datetime and time arguments. */
3862static PyObject *
3863datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
3864{
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003865 static char *keywords[] = {"date", "time", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00003866 PyObject *date;
3867 PyObject *time;
3868 PyObject *result = NULL;
3869
3870 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!:combine", keywords,
3871 &PyDateTime_DateType, &date,
3872 &PyDateTime_TimeType, &time)) {
3873 PyObject *tzinfo = Py_None;
3874
3875 if (HASTZINFO(time))
3876 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
3877 result = PyObject_CallFunction(cls, "iiiiiiiO",
3878 GET_YEAR(date),
3879 GET_MONTH(date),
3880 GET_DAY(date),
3881 TIME_GET_HOUR(time),
3882 TIME_GET_MINUTE(time),
3883 TIME_GET_SECOND(time),
3884 TIME_GET_MICROSECOND(time),
3885 tzinfo);
3886 }
3887 return result;
3888}
Tim Peters2a799bf2002-12-16 20:18:38 +00003889
3890/*
3891 * Destructor.
3892 */
3893
3894static void
Tim Petersa9bc1682003-01-11 03:39:11 +00003895datetime_dealloc(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003896{
Tim Petersa9bc1682003-01-11 03:39:11 +00003897 if (HASTZINFO(self)) {
3898 Py_XDECREF(self->tzinfo);
3899 }
Tim Peters2a799bf2002-12-16 20:18:38 +00003900 self->ob_type->tp_free((PyObject *)self);
3901}
3902
3903/*
3904 * Indirect access to tzinfo methods.
3905 */
3906
Tim Peters2a799bf2002-12-16 20:18:38 +00003907/* These are all METH_NOARGS, so don't need to check the arglist. */
3908static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003909datetime_utcoffset(PyDateTime_DateTime *self, PyObject *unused) {
3910 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3911 "utcoffset", (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003912}
3913
3914static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003915datetime_dst(PyDateTime_DateTime *self, PyObject *unused) {
3916 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3917 "dst", (PyObject *)self);
Tim Peters855fe882002-12-22 03:43:39 +00003918}
3919
3920static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003921datetime_tzname(PyDateTime_DateTime *self, PyObject *unused) {
3922 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
3923 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003924}
3925
3926/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003927 * datetime arithmetic.
Tim Peters2a799bf2002-12-16 20:18:38 +00003928 */
3929
Tim Petersa9bc1682003-01-11 03:39:11 +00003930/* factor must be 1 (to add) or -1 (to subtract). The result inherits
3931 * the tzinfo state of date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003932 */
3933static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003934add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
3935 int factor)
Tim Peters2a799bf2002-12-16 20:18:38 +00003936{
Tim Petersa9bc1682003-01-11 03:39:11 +00003937 /* Note that the C-level additions can't overflow, because of
3938 * invariant bounds on the member values.
3939 */
3940 int year = GET_YEAR(date);
3941 int month = GET_MONTH(date);
3942 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
3943 int hour = DATE_GET_HOUR(date);
3944 int minute = DATE_GET_MINUTE(date);
3945 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
3946 int microsecond = DATE_GET_MICROSECOND(date) +
3947 GET_TD_MICROSECONDS(delta) * factor;
Tim Peters2a799bf2002-12-16 20:18:38 +00003948
Tim Petersa9bc1682003-01-11 03:39:11 +00003949 assert(factor == 1 || factor == -1);
3950 if (normalize_datetime(&year, &month, &day,
3951 &hour, &minute, &second, &microsecond) < 0)
3952 return NULL;
3953 else
3954 return new_datetime(year, month, day,
3955 hour, minute, second, microsecond,
3956 HASTZINFO(date) ? date->tzinfo : Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003957}
3958
3959static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003960datetime_add(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003961{
Tim Petersa9bc1682003-01-11 03:39:11 +00003962 if (PyDateTime_Check(left)) {
3963 /* datetime + ??? */
3964 if (PyDelta_Check(right))
3965 /* datetime + delta */
3966 return add_datetime_timedelta(
3967 (PyDateTime_DateTime *)left,
3968 (PyDateTime_Delta *)right,
3969 1);
3970 }
3971 else if (PyDelta_Check(left)) {
3972 /* delta + datetime */
3973 return add_datetime_timedelta((PyDateTime_DateTime *) right,
3974 (PyDateTime_Delta *) left,
3975 1);
3976 }
3977 Py_INCREF(Py_NotImplemented);
3978 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00003979}
3980
3981static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003982datetime_subtract(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003983{
3984 PyObject *result = Py_NotImplemented;
3985
3986 if (PyDateTime_Check(left)) {
3987 /* datetime - ??? */
3988 if (PyDateTime_Check(right)) {
3989 /* datetime - datetime */
3990 naivety n1, n2;
3991 int offset1, offset2;
Tim Petersa9bc1682003-01-11 03:39:11 +00003992 int delta_d, delta_s, delta_us;
Tim Peters2a799bf2002-12-16 20:18:38 +00003993
Tim Peterse39a80c2002-12-30 21:28:52 +00003994 if (classify_two_utcoffsets(left, &offset1, &n1, left,
3995 right, &offset2, &n2,
3996 right) < 0)
Tim Peters00237032002-12-27 02:21:51 +00003997 return NULL;
Tim Peters8702d5f2002-12-27 02:26:16 +00003998 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
Tim Peters2a799bf2002-12-16 20:18:38 +00003999 if (n1 != n2) {
4000 PyErr_SetString(PyExc_TypeError,
4001 "can't subtract offset-naive and "
4002 "offset-aware datetimes");
4003 return NULL;
4004 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004005 delta_d = ymd_to_ord(GET_YEAR(left),
4006 GET_MONTH(left),
4007 GET_DAY(left)) -
4008 ymd_to_ord(GET_YEAR(right),
4009 GET_MONTH(right),
4010 GET_DAY(right));
4011 /* These can't overflow, since the values are
4012 * normalized. At most this gives the number of
4013 * seconds in one day.
4014 */
4015 delta_s = (DATE_GET_HOUR(left) -
4016 DATE_GET_HOUR(right)) * 3600 +
4017 (DATE_GET_MINUTE(left) -
4018 DATE_GET_MINUTE(right)) * 60 +
4019 (DATE_GET_SECOND(left) -
4020 DATE_GET_SECOND(right));
4021 delta_us = DATE_GET_MICROSECOND(left) -
4022 DATE_GET_MICROSECOND(right);
Tim Peters2a799bf2002-12-16 20:18:38 +00004023 /* (left - offset1) - (right - offset2) =
4024 * (left - right) + (offset2 - offset1)
4025 */
Tim Petersa9bc1682003-01-11 03:39:11 +00004026 delta_s += (offset2 - offset1) * 60;
4027 result = new_delta(delta_d, delta_s, delta_us, 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00004028 }
4029 else if (PyDelta_Check(right)) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004030 /* datetime - delta */
4031 result = add_datetime_timedelta(
Tim Peters2a799bf2002-12-16 20:18:38 +00004032 (PyDateTime_DateTime *)left,
Tim Petersa9bc1682003-01-11 03:39:11 +00004033 (PyDateTime_Delta *)right,
4034 -1);
Tim Peters2a799bf2002-12-16 20:18:38 +00004035 }
4036 }
4037
4038 if (result == Py_NotImplemented)
4039 Py_INCREF(result);
4040 return result;
4041}
4042
4043/* Various ways to turn a datetime into a string. */
4044
4045static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004046datetime_repr(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004047{
Tim Petersa9bc1682003-01-11 03:39:11 +00004048 char buffer[1000];
Skip Montanaro14f88992006-04-18 19:35:04 +00004049 const char *type_name = self->ob_type->tp_name;
Tim Petersa9bc1682003-01-11 03:39:11 +00004050 PyObject *baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004051
Tim Petersa9bc1682003-01-11 03:39:11 +00004052 if (DATE_GET_MICROSECOND(self)) {
4053 PyOS_snprintf(buffer, sizeof(buffer),
4054 "%s(%d, %d, %d, %d, %d, %d, %d)",
Skip Montanaro14f88992006-04-18 19:35:04 +00004055 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004056 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4057 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4058 DATE_GET_SECOND(self),
4059 DATE_GET_MICROSECOND(self));
4060 }
4061 else if (DATE_GET_SECOND(self)) {
4062 PyOS_snprintf(buffer, sizeof(buffer),
4063 "%s(%d, %d, %d, %d, %d, %d)",
Skip Montanaro14f88992006-04-18 19:35:04 +00004064 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004065 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4066 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4067 DATE_GET_SECOND(self));
4068 }
4069 else {
4070 PyOS_snprintf(buffer, sizeof(buffer),
4071 "%s(%d, %d, %d, %d, %d)",
Skip Montanaro14f88992006-04-18 19:35:04 +00004072 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004073 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4074 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
4075 }
4076 baserepr = PyString_FromString(buffer);
4077 if (baserepr == NULL || ! HASTZINFO(self))
4078 return baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004079 return append_keyword_tzinfo(baserepr, self->tzinfo);
4080}
4081
Tim Petersa9bc1682003-01-11 03:39:11 +00004082static PyObject *
4083datetime_str(PyDateTime_DateTime *self)
4084{
4085 return PyObject_CallMethod((PyObject *)self, "isoformat", "(s)", " ");
4086}
Tim Peters2a799bf2002-12-16 20:18:38 +00004087
4088static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004089datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004090{
Tim Petersa9bc1682003-01-11 03:39:11 +00004091 char sep = 'T';
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004092 static char *keywords[] = {"sep", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00004093 char buffer[100];
4094 char *cp;
4095 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004096
Tim Petersa9bc1682003-01-11 03:39:11 +00004097 if (!PyArg_ParseTupleAndKeywords(args, kw, "|c:isoformat", keywords,
4098 &sep))
4099 return NULL;
4100 cp = isoformat_date((PyDateTime_Date *)self, buffer, sizeof(buffer));
4101 assert(cp != NULL);
4102 *cp++ = sep;
4103 isoformat_time(self, cp, sizeof(buffer) - (cp - buffer));
4104 result = PyString_FromString(buffer);
4105 if (result == NULL || ! HASTZINFO(self))
Tim Peters2a799bf2002-12-16 20:18:38 +00004106 return result;
4107
4108 /* We need to append the UTC offset. */
Tim Petersa9bc1682003-01-11 03:39:11 +00004109 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
Tim Peters2a799bf2002-12-16 20:18:38 +00004110 (PyObject *)self) < 0) {
4111 Py_DECREF(result);
4112 return NULL;
4113 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004114 PyString_ConcatAndDel(&result, PyString_FromString(buffer));
Tim Peters2a799bf2002-12-16 20:18:38 +00004115 return result;
4116}
4117
Tim Petersa9bc1682003-01-11 03:39:11 +00004118static PyObject *
4119datetime_ctime(PyDateTime_DateTime *self)
4120{
4121 return format_ctime((PyDateTime_Date *)self,
4122 DATE_GET_HOUR(self),
4123 DATE_GET_MINUTE(self),
4124 DATE_GET_SECOND(self));
4125}
4126
Tim Peters2a799bf2002-12-16 20:18:38 +00004127/* Miscellaneous methods. */
4128
Tim Petersa9bc1682003-01-11 03:39:11 +00004129/* This is more natural as a tp_compare, but doesn't work then: for whatever
4130 * reason, Python's try_3way_compare ignores tp_compare unless
4131 * PyInstance_Check returns true, but these aren't old-style classes.
4132 */
4133static PyObject *
4134datetime_richcompare(PyDateTime_DateTime *self, PyObject *other, int op)
4135{
4136 int diff;
4137 naivety n1, n2;
4138 int offset1, offset2;
4139
4140 if (! PyDateTime_Check(other)) {
Tim Peters528ca532004-09-16 01:30:50 +00004141 /* If other has a "timetuple" attr, that's an advertised
4142 * hook for other classes to ask to get comparison control.
4143 * However, date instances have a timetuple attr, and we
4144 * don't want to allow that comparison. Because datetime
4145 * is a subclass of date, when mixing date and datetime
4146 * in a comparison, Python gives datetime the first shot
4147 * (it's the more specific subtype). So we can stop that
4148 * combination here reliably.
4149 */
4150 if (PyObject_HasAttrString(other, "timetuple") &&
4151 ! PyDate_Check(other)) {
Tim Peters8d81a012003-01-24 22:36:34 +00004152 /* A hook for other kinds of datetime objects. */
4153 Py_INCREF(Py_NotImplemented);
4154 return Py_NotImplemented;
4155 }
Tim Peters07534a62003-02-07 22:50:28 +00004156 if (op == Py_EQ || op == Py_NE) {
4157 PyObject *result = op == Py_EQ ? Py_False : Py_True;
4158 Py_INCREF(result);
4159 return result;
4160 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004161 /* Stop this from falling back to address comparison. */
Tim Peters07534a62003-02-07 22:50:28 +00004162 return cmperror((PyObject *)self, other);
Tim Petersa9bc1682003-01-11 03:39:11 +00004163 }
4164
4165 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1,
4166 (PyObject *)self,
4167 other, &offset2, &n2,
4168 other) < 0)
4169 return NULL;
4170 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
4171 /* If they're both naive, or both aware and have the same offsets,
4172 * we get off cheap. Note that if they're both naive, offset1 ==
4173 * offset2 == 0 at this point.
4174 */
4175 if (n1 == n2 && offset1 == offset2) {
4176 diff = memcmp(self->data, ((PyDateTime_DateTime *)other)->data,
4177 _PyDateTime_DATETIME_DATASIZE);
4178 return diff_to_bool(diff, op);
4179 }
4180
4181 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
4182 PyDateTime_Delta *delta;
4183
4184 assert(offset1 != offset2); /* else last "if" handled it */
4185 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
4186 other);
4187 if (delta == NULL)
4188 return NULL;
4189 diff = GET_TD_DAYS(delta);
4190 if (diff == 0)
4191 diff = GET_TD_SECONDS(delta) |
4192 GET_TD_MICROSECONDS(delta);
4193 Py_DECREF(delta);
4194 return diff_to_bool(diff, op);
4195 }
4196
4197 assert(n1 != n2);
4198 PyErr_SetString(PyExc_TypeError,
4199 "can't compare offset-naive and "
4200 "offset-aware datetimes");
4201 return NULL;
4202}
4203
4204static long
4205datetime_hash(PyDateTime_DateTime *self)
4206{
4207 if (self->hashcode == -1) {
4208 naivety n;
4209 int offset;
4210 PyObject *temp;
4211
4212 n = classify_utcoffset((PyObject *)self, (PyObject *)self,
4213 &offset);
4214 assert(n != OFFSET_UNKNOWN);
4215 if (n == OFFSET_ERROR)
4216 return -1;
4217
4218 /* Reduce this to a hash of another object. */
4219 if (n == OFFSET_NAIVE)
4220 temp = PyString_FromStringAndSize(
4221 (char *)self->data,
4222 _PyDateTime_DATETIME_DATASIZE);
4223 else {
4224 int days;
4225 int seconds;
4226
4227 assert(n == OFFSET_AWARE);
4228 assert(HASTZINFO(self));
4229 days = ymd_to_ord(GET_YEAR(self),
4230 GET_MONTH(self),
4231 GET_DAY(self));
4232 seconds = DATE_GET_HOUR(self) * 3600 +
4233 (DATE_GET_MINUTE(self) - offset) * 60 +
4234 DATE_GET_SECOND(self);
4235 temp = new_delta(days,
4236 seconds,
4237 DATE_GET_MICROSECOND(self),
4238 1);
4239 }
4240 if (temp != NULL) {
4241 self->hashcode = PyObject_Hash(temp);
4242 Py_DECREF(temp);
4243 }
4244 }
4245 return self->hashcode;
4246}
Tim Peters2a799bf2002-12-16 20:18:38 +00004247
4248static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004249datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00004250{
4251 PyObject *clone;
4252 PyObject *tuple;
4253 int y = GET_YEAR(self);
4254 int m = GET_MONTH(self);
4255 int d = GET_DAY(self);
4256 int hh = DATE_GET_HOUR(self);
4257 int mm = DATE_GET_MINUTE(self);
4258 int ss = DATE_GET_SECOND(self);
4259 int us = DATE_GET_MICROSECOND(self);
Tim Petersa9bc1682003-01-11 03:39:11 +00004260 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00004261
4262 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO:replace",
Tim Petersa9bc1682003-01-11 03:39:11 +00004263 datetime_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00004264 &y, &m, &d, &hh, &mm, &ss, &us,
4265 &tzinfo))
4266 return NULL;
4267 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
4268 if (tuple == NULL)
4269 return NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00004270 clone = datetime_new(self->ob_type, tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00004271 Py_DECREF(tuple);
4272 return clone;
4273}
4274
4275static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004276datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters80475bb2002-12-25 07:40:55 +00004277{
Tim Peters52dcce22003-01-23 16:36:11 +00004278 int y, m, d, hh, mm, ss, us;
Tim Peters521fc152002-12-31 17:36:56 +00004279 PyObject *result;
Tim Peters52dcce22003-01-23 16:36:11 +00004280 int offset, none;
Tim Peters521fc152002-12-31 17:36:56 +00004281
Tim Peters80475bb2002-12-25 07:40:55 +00004282 PyObject *tzinfo;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004283 static char *keywords[] = {"tz", NULL};
Tim Peters80475bb2002-12-25 07:40:55 +00004284
Tim Peters52dcce22003-01-23 16:36:11 +00004285 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:astimezone", keywords,
4286 &PyDateTime_TZInfoType, &tzinfo))
Tim Peters80475bb2002-12-25 07:40:55 +00004287 return NULL;
4288
Tim Peters52dcce22003-01-23 16:36:11 +00004289 if (!HASTZINFO(self) || self->tzinfo == Py_None)
4290 goto NeedAware;
Tim Peters521fc152002-12-31 17:36:56 +00004291
Tim Peters52dcce22003-01-23 16:36:11 +00004292 /* Conversion to self's own time zone is a NOP. */
4293 if (self->tzinfo == tzinfo) {
4294 Py_INCREF(self);
4295 return (PyObject *)self;
Tim Peters710fb152003-01-02 19:35:54 +00004296 }
Tim Peters521fc152002-12-31 17:36:56 +00004297
Tim Peters52dcce22003-01-23 16:36:11 +00004298 /* Convert self to UTC. */
4299 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4300 if (offset == -1 && PyErr_Occurred())
4301 return NULL;
4302 if (none)
4303 goto NeedAware;
Tim Petersf3615152003-01-01 21:51:37 +00004304
Tim Peters52dcce22003-01-23 16:36:11 +00004305 y = GET_YEAR(self);
4306 m = GET_MONTH(self);
4307 d = GET_DAY(self);
4308 hh = DATE_GET_HOUR(self);
4309 mm = DATE_GET_MINUTE(self);
4310 ss = DATE_GET_SECOND(self);
4311 us = DATE_GET_MICROSECOND(self);
4312
4313 mm -= offset;
Tim Petersf3615152003-01-01 21:51:37 +00004314 if ((mm < 0 || mm >= 60) &&
4315 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Peters52dcce22003-01-23 16:36:11 +00004316 return NULL;
4317
4318 /* Attach new tzinfo and let fromutc() do the rest. */
4319 result = new_datetime(y, m, d, hh, mm, ss, us, tzinfo);
4320 if (result != NULL) {
4321 PyObject *temp = result;
4322
4323 result = PyObject_CallMethod(tzinfo, "fromutc", "O", temp);
4324 Py_DECREF(temp);
4325 }
Tim Petersadf64202003-01-04 06:03:15 +00004326 return result;
Tim Peters521fc152002-12-31 17:36:56 +00004327
Tim Peters52dcce22003-01-23 16:36:11 +00004328NeedAware:
4329 PyErr_SetString(PyExc_ValueError, "astimezone() cannot be applied to "
4330 "a naive datetime");
Tim Peters521fc152002-12-31 17:36:56 +00004331 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00004332}
4333
4334static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004335datetime_timetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004336{
4337 int dstflag = -1;
4338
Tim Petersa9bc1682003-01-11 03:39:11 +00004339 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004340 int none;
4341
4342 dstflag = call_dst(self->tzinfo, (PyObject *)self, &none);
4343 if (dstflag == -1 && PyErr_Occurred())
4344 return NULL;
4345
4346 if (none)
4347 dstflag = -1;
4348 else if (dstflag != 0)
4349 dstflag = 1;
4350
4351 }
4352 return build_struct_time(GET_YEAR(self),
4353 GET_MONTH(self),
4354 GET_DAY(self),
4355 DATE_GET_HOUR(self),
4356 DATE_GET_MINUTE(self),
4357 DATE_GET_SECOND(self),
4358 dstflag);
4359}
4360
4361static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004362datetime_getdate(PyDateTime_DateTime *self)
4363{
4364 return new_date(GET_YEAR(self),
4365 GET_MONTH(self),
4366 GET_DAY(self));
4367}
4368
4369static PyObject *
4370datetime_gettime(PyDateTime_DateTime *self)
4371{
4372 return new_time(DATE_GET_HOUR(self),
4373 DATE_GET_MINUTE(self),
4374 DATE_GET_SECOND(self),
4375 DATE_GET_MICROSECOND(self),
4376 Py_None);
4377}
4378
4379static PyObject *
4380datetime_gettimetz(PyDateTime_DateTime *self)
4381{
4382 return new_time(DATE_GET_HOUR(self),
4383 DATE_GET_MINUTE(self),
4384 DATE_GET_SECOND(self),
4385 DATE_GET_MICROSECOND(self),
4386 HASTZINFO(self) ? self->tzinfo : Py_None);
4387}
4388
4389static PyObject *
4390datetime_utctimetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004391{
4392 int y = GET_YEAR(self);
4393 int m = GET_MONTH(self);
4394 int d = GET_DAY(self);
4395 int hh = DATE_GET_HOUR(self);
4396 int mm = DATE_GET_MINUTE(self);
4397 int ss = DATE_GET_SECOND(self);
4398 int us = 0; /* microseconds are ignored in a timetuple */
4399 int offset = 0;
4400
Tim Petersa9bc1682003-01-11 03:39:11 +00004401 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004402 int none;
4403
4404 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4405 if (offset == -1 && PyErr_Occurred())
4406 return NULL;
4407 }
4408 /* Even if offset is 0, don't call timetuple() -- tm_isdst should be
4409 * 0 in a UTC timetuple regardless of what dst() says.
4410 */
4411 if (offset) {
4412 /* Subtract offset minutes & normalize. */
4413 int stat;
4414
4415 mm -= offset;
4416 stat = normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us);
4417 if (stat < 0) {
4418 /* At the edges, it's possible we overflowed
4419 * beyond MINYEAR or MAXYEAR.
4420 */
4421 if (PyErr_ExceptionMatches(PyExc_OverflowError))
4422 PyErr_Clear();
4423 else
4424 return NULL;
4425 }
4426 }
4427 return build_struct_time(y, m, d, hh, mm, ss, 0);
4428}
4429
Tim Peters371935f2003-02-01 01:52:50 +00004430/* Pickle support, a simple use of __reduce__. */
Tim Peters33e0f382003-01-10 02:05:14 +00004431
Tim Petersa9bc1682003-01-11 03:39:11 +00004432/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004433 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4434 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00004435 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00004436 */
4437static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004438datetime_getstate(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004439{
4440 PyObject *basestate;
4441 PyObject *result = NULL;
4442
Tim Peters33e0f382003-01-10 02:05:14 +00004443 basestate = PyString_FromStringAndSize((char *)self->data,
4444 _PyDateTime_DATETIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00004445 if (basestate != NULL) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004446 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004447 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00004448 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004449 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00004450 Py_DECREF(basestate);
4451 }
4452 return result;
4453}
4454
4455static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00004456datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00004457{
Guido van Rossum177e41a2003-01-30 22:06:23 +00004458 return Py_BuildValue("(ON)", self->ob_type, datetime_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00004459}
4460
Tim Petersa9bc1682003-01-11 03:39:11 +00004461static PyMethodDef datetime_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004462
Tim Peters2a799bf2002-12-16 20:18:38 +00004463 /* Class methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00004464
Tim Petersa9bc1682003-01-11 03:39:11 +00004465 {"now", (PyCFunction)datetime_now,
Tim Peters2a799bf2002-12-16 20:18:38 +00004466 METH_KEYWORDS | METH_CLASS,
Neal Norwitz2fbe5372003-01-23 21:09:05 +00004467 PyDoc_STR("[tz] -> new datetime with tz's local day and time.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004468
Tim Petersa9bc1682003-01-11 03:39:11 +00004469 {"utcnow", (PyCFunction)datetime_utcnow,
4470 METH_NOARGS | METH_CLASS,
4471 PyDoc_STR("Return a new datetime representing UTC day and time.")},
4472
4473 {"fromtimestamp", (PyCFunction)datetime_fromtimestamp,
Tim Peters2a799bf2002-12-16 20:18:38 +00004474 METH_KEYWORDS | METH_CLASS,
Tim Peters2a44a8d2003-01-23 20:53:10 +00004475 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004476
Tim Petersa9bc1682003-01-11 03:39:11 +00004477 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
4478 METH_VARARGS | METH_CLASS,
4479 PyDoc_STR("timestamp -> UTC datetime from a POSIX timestamp "
4480 "(like time.time()).")},
4481
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004482 {"strptime", (PyCFunction)datetime_strptime,
4483 METH_VARARGS | METH_CLASS,
4484 PyDoc_STR("string, format -> new datetime parsed from a string "
4485 "(like time.strptime()).")},
4486
Tim Petersa9bc1682003-01-11 03:39:11 +00004487 {"combine", (PyCFunction)datetime_combine,
4488 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4489 PyDoc_STR("date, time -> datetime with same date and time fields")},
4490
Tim Peters2a799bf2002-12-16 20:18:38 +00004491 /* Instance methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00004492
Tim Petersa9bc1682003-01-11 03:39:11 +00004493 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
4494 PyDoc_STR("Return date object with same year, month and day.")},
4495
4496 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
4497 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
4498
4499 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
4500 PyDoc_STR("Return time object with same time and tzinfo.")},
4501
4502 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
4503 PyDoc_STR("Return ctime() style string.")},
4504
4505 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004506 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
4507
Tim Petersa9bc1682003-01-11 03:39:11 +00004508 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004509 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
4510
Tim Petersa9bc1682003-01-11 03:39:11 +00004511 {"isoformat", (PyCFunction)datetime_isoformat, METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004512 PyDoc_STR("[sep] -> string in ISO 8601 format, "
4513 "YYYY-MM-DDTHH:MM:SS[.mmmmmm][+HH:MM].\n\n"
4514 "sep is used to separate the year from the time, and "
4515 "defaults to 'T'.")},
4516
Tim Petersa9bc1682003-01-11 03:39:11 +00004517 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004518 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
4519
Tim Petersa9bc1682003-01-11 03:39:11 +00004520 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004521 PyDoc_STR("Return self.tzinfo.tzname(self).")},
4522
Tim Petersa9bc1682003-01-11 03:39:11 +00004523 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004524 PyDoc_STR("Return self.tzinfo.dst(self).")},
4525
Tim Petersa9bc1682003-01-11 03:39:11 +00004526 {"replace", (PyCFunction)datetime_replace, METH_KEYWORDS,
4527 PyDoc_STR("Return datetime with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00004528
Tim Petersa9bc1682003-01-11 03:39:11 +00004529 {"astimezone", (PyCFunction)datetime_astimezone, METH_KEYWORDS,
Tim Peters80475bb2002-12-25 07:40:55 +00004530 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
4531
Guido van Rossum177e41a2003-01-30 22:06:23 +00004532 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
4533 PyDoc_STR("__reduce__() -> (cls, state)")},
4534
Tim Peters2a799bf2002-12-16 20:18:38 +00004535 {NULL, NULL}
4536};
4537
Tim Petersa9bc1682003-01-11 03:39:11 +00004538static char datetime_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00004539PyDoc_STR("datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])\n\
4540\n\
4541The year, month and day arguments are required. tzinfo may be None, or an\n\
4542instance of a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00004543
Tim Petersa9bc1682003-01-11 03:39:11 +00004544static PyNumberMethods datetime_as_number = {
4545 datetime_add, /* nb_add */
4546 datetime_subtract, /* nb_subtract */
Tim Peters2a799bf2002-12-16 20:18:38 +00004547 0, /* nb_multiply */
4548 0, /* nb_divide */
4549 0, /* nb_remainder */
4550 0, /* nb_divmod */
4551 0, /* nb_power */
4552 0, /* nb_negative */
4553 0, /* nb_positive */
4554 0, /* nb_absolute */
4555 0, /* nb_nonzero */
4556};
4557
Tim Petersa9bc1682003-01-11 03:39:11 +00004558statichere PyTypeObject PyDateTime_DateTimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004559 PyObject_HEAD_INIT(NULL)
4560 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00004561 "datetime.datetime", /* tp_name */
Tim Petersa9bc1682003-01-11 03:39:11 +00004562 sizeof(PyDateTime_DateTime), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00004563 0, /* tp_itemsize */
Tim Petersa9bc1682003-01-11 03:39:11 +00004564 (destructor)datetime_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004565 0, /* tp_print */
4566 0, /* tp_getattr */
4567 0, /* tp_setattr */
4568 0, /* tp_compare */
Tim Petersa9bc1682003-01-11 03:39:11 +00004569 (reprfunc)datetime_repr, /* tp_repr */
4570 &datetime_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00004571 0, /* tp_as_sequence */
4572 0, /* tp_as_mapping */
Tim Petersa9bc1682003-01-11 03:39:11 +00004573 (hashfunc)datetime_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00004574 0, /* tp_call */
Tim Petersa9bc1682003-01-11 03:39:11 +00004575 (reprfunc)datetime_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00004576 PyObject_GenericGetAttr, /* tp_getattro */
4577 0, /* tp_setattro */
4578 0, /* tp_as_buffer */
4579 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
4580 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Petersa9bc1682003-01-11 03:39:11 +00004581 datetime_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004582 0, /* tp_traverse */
4583 0, /* tp_clear */
Tim Petersa9bc1682003-01-11 03:39:11 +00004584 (richcmpfunc)datetime_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00004585 0, /* tp_weaklistoffset */
4586 0, /* tp_iter */
4587 0, /* tp_iternext */
Tim Petersa9bc1682003-01-11 03:39:11 +00004588 datetime_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00004589 0, /* tp_members */
Tim Petersa9bc1682003-01-11 03:39:11 +00004590 datetime_getset, /* tp_getset */
4591 &PyDateTime_DateType, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00004592 0, /* tp_dict */
4593 0, /* tp_descr_get */
4594 0, /* tp_descr_set */
4595 0, /* tp_dictoffset */
4596 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00004597 datetime_alloc, /* tp_alloc */
Tim Petersa9bc1682003-01-11 03:39:11 +00004598 datetime_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00004599 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00004600};
4601
4602/* ---------------------------------------------------------------------------
4603 * Module methods and initialization.
4604 */
4605
4606static PyMethodDef module_methods[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004607 {NULL, NULL}
4608};
4609
Tim Peters9ddf40b2004-06-20 22:41:32 +00004610/* C API. Clients get at this via PyDateTime_IMPORT, defined in
4611 * datetime.h.
4612 */
4613static PyDateTime_CAPI CAPI = {
4614 &PyDateTime_DateType,
4615 &PyDateTime_DateTimeType,
4616 &PyDateTime_TimeType,
4617 &PyDateTime_DeltaType,
4618 &PyDateTime_TZInfoType,
4619 new_date_ex,
4620 new_datetime_ex,
4621 new_time_ex,
4622 new_delta_ex,
4623 datetime_fromtimestamp,
4624 date_fromtimestamp
4625};
4626
4627
Tim Peters2a799bf2002-12-16 20:18:38 +00004628PyMODINIT_FUNC
4629initdatetime(void)
4630{
4631 PyObject *m; /* a module object */
4632 PyObject *d; /* its dict */
4633 PyObject *x;
4634
Tim Peters2a799bf2002-12-16 20:18:38 +00004635 m = Py_InitModule3("datetime", module_methods,
4636 "Fast implementation of the datetime type.");
Neal Norwitz1ac754f2006-01-19 06:09:39 +00004637 if (m == NULL)
4638 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004639
4640 if (PyType_Ready(&PyDateTime_DateType) < 0)
4641 return;
4642 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
4643 return;
4644 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
4645 return;
4646 if (PyType_Ready(&PyDateTime_TimeType) < 0)
4647 return;
4648 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
4649 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004650
Tim Peters2a799bf2002-12-16 20:18:38 +00004651 /* timedelta values */
4652 d = PyDateTime_DeltaType.tp_dict;
4653
Tim Peters2a799bf2002-12-16 20:18:38 +00004654 x = new_delta(0, 0, 1, 0);
4655 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4656 return;
4657 Py_DECREF(x);
4658
4659 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
4660 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4661 return;
4662 Py_DECREF(x);
4663
4664 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
4665 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4666 return;
4667 Py_DECREF(x);
4668
4669 /* date values */
4670 d = PyDateTime_DateType.tp_dict;
4671
4672 x = new_date(1, 1, 1);
4673 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4674 return;
4675 Py_DECREF(x);
4676
4677 x = new_date(MAXYEAR, 12, 31);
4678 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4679 return;
4680 Py_DECREF(x);
4681
4682 x = new_delta(1, 0, 0, 0);
4683 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4684 return;
4685 Py_DECREF(x);
4686
Tim Peters37f39822003-01-10 03:49:02 +00004687 /* time values */
4688 d = PyDateTime_TimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004689
Tim Peters37f39822003-01-10 03:49:02 +00004690 x = new_time(0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004691 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4692 return;
4693 Py_DECREF(x);
4694
Tim Peters37f39822003-01-10 03:49:02 +00004695 x = new_time(23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004696 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4697 return;
4698 Py_DECREF(x);
4699
4700 x = new_delta(0, 0, 1, 0);
4701 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4702 return;
4703 Py_DECREF(x);
4704
Tim Petersa9bc1682003-01-11 03:39:11 +00004705 /* datetime values */
4706 d = PyDateTime_DateTimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004707
Tim Petersa9bc1682003-01-11 03:39:11 +00004708 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004709 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4710 return;
4711 Py_DECREF(x);
4712
Tim Petersa9bc1682003-01-11 03:39:11 +00004713 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004714 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4715 return;
4716 Py_DECREF(x);
4717
4718 x = new_delta(0, 0, 1, 0);
4719 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4720 return;
4721 Py_DECREF(x);
4722
Tim Peters2a799bf2002-12-16 20:18:38 +00004723 /* module initialization */
4724 PyModule_AddIntConstant(m, "MINYEAR", MINYEAR);
4725 PyModule_AddIntConstant(m, "MAXYEAR", MAXYEAR);
4726
4727 Py_INCREF(&PyDateTime_DateType);
4728 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
4729
Tim Petersa9bc1682003-01-11 03:39:11 +00004730 Py_INCREF(&PyDateTime_DateTimeType);
4731 PyModule_AddObject(m, "datetime",
4732 (PyObject *)&PyDateTime_DateTimeType);
4733
4734 Py_INCREF(&PyDateTime_TimeType);
4735 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
4736
Tim Peters2a799bf2002-12-16 20:18:38 +00004737 Py_INCREF(&PyDateTime_DeltaType);
4738 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
4739
Tim Peters2a799bf2002-12-16 20:18:38 +00004740 Py_INCREF(&PyDateTime_TZInfoType);
4741 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
4742
Tim Peters9ddf40b2004-06-20 22:41:32 +00004743 x = PyCObject_FromVoidPtrAndDesc(&CAPI, (void*) DATETIME_API_MAGIC,
4744 NULL);
4745 if (x == NULL)
4746 return;
4747 PyModule_AddObject(m, "datetime_CAPI", x);
4748
Tim Peters2a799bf2002-12-16 20:18:38 +00004749 /* A 4-year cycle has an extra leap day over what we'd get from
4750 * pasting together 4 single years.
4751 */
4752 assert(DI4Y == 4 * 365 + 1);
4753 assert(DI4Y == days_before_year(4+1));
4754
4755 /* Similarly, a 400-year cycle has an extra leap day over what we'd
4756 * get from pasting together 4 100-year cycles.
4757 */
4758 assert(DI400Y == 4 * DI100Y + 1);
4759 assert(DI400Y == days_before_year(400+1));
4760
4761 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
4762 * pasting together 25 4-year cycles.
4763 */
4764 assert(DI100Y == 25 * DI4Y - 1);
4765 assert(DI100Y == days_before_year(100+1));
4766
4767 us_per_us = PyInt_FromLong(1);
4768 us_per_ms = PyInt_FromLong(1000);
4769 us_per_second = PyInt_FromLong(1000000);
4770 us_per_minute = PyInt_FromLong(60000000);
4771 seconds_per_day = PyInt_FromLong(24 * 3600);
4772 if (us_per_us == NULL || us_per_ms == NULL || us_per_second == NULL ||
4773 us_per_minute == NULL || seconds_per_day == NULL)
4774 return;
4775
4776 /* The rest are too big for 32-bit ints, but even
4777 * us_per_week fits in 40 bits, so doubles should be exact.
4778 */
4779 us_per_hour = PyLong_FromDouble(3600000000.0);
4780 us_per_day = PyLong_FromDouble(86400000000.0);
4781 us_per_week = PyLong_FromDouble(604800000000.0);
4782 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
4783 return;
4784}
Tim Petersf3615152003-01-01 21:51:37 +00004785
4786/* ---------------------------------------------------------------------------
Tim Petersa9bc1682003-01-11 03:39:11 +00004787Some time zone algebra. For a datetime x, let
Tim Petersf3615152003-01-01 21:51:37 +00004788 x.n = x stripped of its timezone -- its naive time.
4789 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
4790 return None
4791 x.d = x.dst(), and assuming that doesn't raise an exception or
4792 return None
4793 x.s = x's standard offset, x.o - x.d
4794
4795Now some derived rules, where k is a duration (timedelta).
4796
47971. x.o = x.s + x.d
4798 This follows from the definition of x.s.
4799
Tim Petersc5dc4da2003-01-02 17:55:03 +000048002. If x and y have the same tzinfo member, x.s = y.s.
Tim Petersf3615152003-01-01 21:51:37 +00004801 This is actually a requirement, an assumption we need to make about
4802 sane tzinfo classes.
4803
48043. The naive UTC time corresponding to x is x.n - x.o.
4805 This is again a requirement for a sane tzinfo class.
4806
48074. (x+k).s = x.s
Tim Peters8bb5ad22003-01-24 02:44:45 +00004808 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
Tim Petersf3615152003-01-01 21:51:37 +00004809
Tim Petersc5dc4da2003-01-02 17:55:03 +000048105. (x+k).n = x.n + k
Tim Petersf3615152003-01-01 21:51:37 +00004811 Again follows from how arithmetic is defined.
4812
Tim Peters8bb5ad22003-01-24 02:44:45 +00004813Now we can explain tz.fromutc(x). Let's assume it's an interesting case
Tim Petersf3615152003-01-01 21:51:37 +00004814(meaning that the various tzinfo methods exist, and don't blow up or return
4815None when called).
4816
Tim Petersa9bc1682003-01-11 03:39:11 +00004817The function wants to return a datetime y with timezone tz, equivalent to x.
Tim Peters8bb5ad22003-01-24 02:44:45 +00004818x is already in UTC.
Tim Petersf3615152003-01-01 21:51:37 +00004819
4820By #3, we want
4821
Tim Peters8bb5ad22003-01-24 02:44:45 +00004822 y.n - y.o = x.n [1]
Tim Petersf3615152003-01-01 21:51:37 +00004823
4824The algorithm starts by attaching tz to x.n, and calling that y. So
4825x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
4826becomes true; in effect, we want to solve [2] for k:
4827
Tim Peters8bb5ad22003-01-24 02:44:45 +00004828 (y+k).n - (y+k).o = x.n [2]
Tim Petersf3615152003-01-01 21:51:37 +00004829
4830By #1, this is the same as
4831
Tim Peters8bb5ad22003-01-24 02:44:45 +00004832 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
Tim Petersf3615152003-01-01 21:51:37 +00004833
4834By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
4835Substituting that into [3],
4836
Tim Peters8bb5ad22003-01-24 02:44:45 +00004837 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
4838 k - (y+k).s - (y+k).d = 0; rearranging,
4839 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
4840 k = y.s - (y+k).d
Tim Petersf3615152003-01-01 21:51:37 +00004841
Tim Peters8bb5ad22003-01-24 02:44:45 +00004842On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
4843approximate k by ignoring the (y+k).d term at first. Note that k can't be
4844very large, since all offset-returning methods return a duration of magnitude
4845less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
4846be 0, so ignoring it has no consequence then.
Tim Petersf3615152003-01-01 21:51:37 +00004847
4848In any case, the new value is
4849
Tim Peters8bb5ad22003-01-24 02:44:45 +00004850 z = y + y.s [4]
Tim Petersf3615152003-01-01 21:51:37 +00004851
Tim Peters8bb5ad22003-01-24 02:44:45 +00004852It's helpful to step back at look at [4] from a higher level: it's simply
4853mapping from UTC to tz's standard time.
Tim Petersc5dc4da2003-01-02 17:55:03 +00004854
4855At this point, if
4856
Tim Peters8bb5ad22003-01-24 02:44:45 +00004857 z.n - z.o = x.n [5]
Tim Petersc5dc4da2003-01-02 17:55:03 +00004858
4859we have an equivalent time, and are almost done. The insecurity here is
Tim Petersf3615152003-01-01 21:51:37 +00004860at the start of daylight time. Picture US Eastern for concreteness. The wall
4861time 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 +00004862sense then. The docs ask that an Eastern tzinfo class consider such a time to
4863be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
4864on the day DST starts. We want to return the 1:MM EST spelling because that's
Tim Petersf3615152003-01-01 21:51:37 +00004865the only spelling that makes sense on the local wall clock.
4866
Tim Petersc5dc4da2003-01-02 17:55:03 +00004867In fact, if [5] holds at this point, we do have the standard-time spelling,
4868but that takes a bit of proof. We first prove a stronger result. What's the
4869difference between the LHS and RHS of [5]? Let
Tim Petersf3615152003-01-01 21:51:37 +00004870
Tim Peters8bb5ad22003-01-24 02:44:45 +00004871 diff = x.n - (z.n - z.o) [6]
Tim Petersf3615152003-01-01 21:51:37 +00004872
Tim Petersc5dc4da2003-01-02 17:55:03 +00004873Now
4874 z.n = by [4]
Tim Peters8bb5ad22003-01-24 02:44:45 +00004875 (y + y.s).n = by #5
4876 y.n + y.s = since y.n = x.n
4877 x.n + y.s = since z and y are have the same tzinfo member,
4878 y.s = z.s by #2
4879 x.n + z.s
Tim Petersf3615152003-01-01 21:51:37 +00004880
Tim Petersc5dc4da2003-01-02 17:55:03 +00004881Plugging that back into [6] gives
Tim Petersf3615152003-01-01 21:51:37 +00004882
Tim Petersc5dc4da2003-01-02 17:55:03 +00004883 diff =
Tim Peters8bb5ad22003-01-24 02:44:45 +00004884 x.n - ((x.n + z.s) - z.o) = expanding
4885 x.n - x.n - z.s + z.o = cancelling
4886 - z.s + z.o = by #2
Tim Petersc5dc4da2003-01-02 17:55:03 +00004887 z.d
Tim Petersf3615152003-01-01 21:51:37 +00004888
Tim Petersc5dc4da2003-01-02 17:55:03 +00004889So diff = z.d.
Tim Petersf3615152003-01-01 21:51:37 +00004890
Tim Petersc5dc4da2003-01-02 17:55:03 +00004891If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
Tim Peters8bb5ad22003-01-24 02:44:45 +00004892spelling we wanted in the endcase described above. We're done. Contrarily,
4893if z.d = 0, then we have a UTC equivalent, and are also done.
Tim Petersf3615152003-01-01 21:51:37 +00004894
Tim Petersc5dc4da2003-01-02 17:55:03 +00004895If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
4896add to z (in effect, z is in tz's standard time, and we need to shift the
Tim Peters8bb5ad22003-01-24 02:44:45 +00004897local clock into tz's daylight time).
Tim Petersf3615152003-01-01 21:51:37 +00004898
Tim Petersc5dc4da2003-01-02 17:55:03 +00004899Let
Tim Petersf3615152003-01-01 21:51:37 +00004900
Tim Peters4fede1a2003-01-04 00:26:59 +00004901 z' = z + z.d = z + diff [7]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004902
Tim Peters4fede1a2003-01-04 00:26:59 +00004903and we can again ask whether
Tim Petersc3bb26a2003-01-02 03:14:59 +00004904
Tim Peters8bb5ad22003-01-24 02:44:45 +00004905 z'.n - z'.o = x.n [8]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004906
Tim Peters8bb5ad22003-01-24 02:44:45 +00004907If so, we're done. If not, the tzinfo class is insane, according to the
4908assumptions we've made. This also requires a bit of proof. As before, let's
4909compute the difference between the LHS and RHS of [8] (and skipping some of
4910the justifications for the kinds of substitutions we've done several times
4911already):
Tim Peters4fede1a2003-01-04 00:26:59 +00004912
Tim Peters8bb5ad22003-01-24 02:44:45 +00004913 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
4914 x.n - (z.n + diff - z'.o) = replacing diff via [6]
4915 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
4916 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
4917 - z.n + z.n - z.o + z'.o = cancel z.n
Tim Peters4fede1a2003-01-04 00:26:59 +00004918 - z.o + z'.o = #1 twice
4919 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
4920 z'.d - z.d
4921
4922So 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 +00004923we've found the UTC-equivalent so are done. In fact, we stop with [7] and
4924return z', not bothering to compute z'.d.
Tim Peters4fede1a2003-01-04 00:26:59 +00004925
Tim Peters8bb5ad22003-01-24 02:44:45 +00004926How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
4927a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
4928would have to change the result dst() returns: we start in DST, and moving
4929a little further into it takes us out of DST.
Tim Peters4fede1a2003-01-04 00:26:59 +00004930
Tim Peters8bb5ad22003-01-24 02:44:45 +00004931There isn't a sane case where this can happen. The closest it gets is at
4932the end of DST, where there's an hour in UTC with no spelling in a hybrid
4933tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
4934that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
4935UTC) because the docs insist on that, but 0:MM is taken as being in daylight
4936time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
4937clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
4938standard time. Since that's what the local clock *does*, we want to map both
4939UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
Tim Peters4fede1a2003-01-04 00:26:59 +00004940in local time, but so it goes -- it's the way the local clock works.
4941
Tim Peters8bb5ad22003-01-24 02:44:45 +00004942When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
4943so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
4944z' = 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 +00004945(correctly) concludes that z' is not UTC-equivalent to x.
4946
4947Because we know z.d said z was in daylight time (else [5] would have held and
4948we would have stopped then), and we know z.d != z'.d (else [8] would have held
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00004949and we would have stopped then), and there are only 2 possible values dst() can
Tim Peters4fede1a2003-01-04 00:26:59 +00004950return in Eastern, it follows that z'.d must be 0 (which it is in the example,
4951but the reasoning doesn't depend on the example -- it depends on there being
4952two possible dst() outcomes, one zero and the other non-zero). Therefore
Tim Peters8bb5ad22003-01-24 02:44:45 +00004953z' must be in standard time, and is the spelling we want in this case.
4954
4955Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
4956concerned (because it takes z' as being in standard time rather than the
4957daylight time we intend here), but returning it gives the real-life "local
4958clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
4959tz.
4960
4961When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
4962the 1:MM standard time spelling we want.
4963
4964So how can this break? One of the assumptions must be violated. Two
4965possibilities:
4966
49671) [2] effectively says that y.s is invariant across all y belong to a given
4968 time zone. This isn't true if, for political reasons or continental drift,
4969 a region decides to change its base offset from UTC.
4970
49712) There may be versions of "double daylight" time where the tail end of
4972 the analysis gives up a step too early. I haven't thought about that
4973 enough to say.
4974
4975In any case, it's clear that the default fromutc() is strong enough to handle
4976"almost all" time zones: so long as the standard offset is invariant, it
4977doesn't matter if daylight time transition points change from year to year, or
4978if daylight time is skipped in some years; it doesn't matter how large or
4979small dst() may get within its bounds; and it doesn't even matter if some
4980perverse time zone returns a negative dst()). So a breaking case must be
4981pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
Tim Petersf3615152003-01-01 21:51:37 +00004982--------------------------------------------------------------------------- */