blob: 0317dbfed163d0c826d4224a3d80ce4ebb2a1a3b [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 */
Guido van Rossum360e4b82007-05-14 22:51:27 +000016#ifndef Py_BUILD_CORE
Tim Peters9ddf40b2004-06-20 22:41:32 +000017#define Py_BUILD_CORE
Guido van Rossum360e4b82007-05-14 22:51:27 +000018#endif
Tim Peters2a799bf2002-12-16 20:18:38 +000019#include "datetime.h"
Tim Peters9ddf40b2004-06-20 22:41:32 +000020#undef Py_BUILD_CORE
Tim Peters2a799bf2002-12-16 20:18:38 +000021
22/* We require that C int be at least 32 bits, and use int virtually
23 * everywhere. In just a few cases we use a temp long, where a Python
24 * API returns a C long. In such cases, we have to ensure that the
25 * final result fits in a C int (this can be an issue on 64-bit boxes).
26 */
27#if SIZEOF_INT < 4
28# error "datetime.c requires that C int have at least 32 bits"
29#endif
30
31#define MINYEAR 1
32#define MAXYEAR 9999
33
34/* Nine decimal digits is easy to communicate, and leaves enough room
35 * so that two delta days can be added w/o fear of overflowing a signed
36 * 32-bit int, and with plenty of room left over to absorb any possible
37 * carries from adding seconds.
38 */
39#define MAX_DELTA_DAYS 999999999
40
41/* Rename the long macros in datetime.h to more reasonable short names. */
42#define GET_YEAR PyDateTime_GET_YEAR
43#define GET_MONTH PyDateTime_GET_MONTH
44#define GET_DAY PyDateTime_GET_DAY
45#define DATE_GET_HOUR PyDateTime_DATE_GET_HOUR
46#define DATE_GET_MINUTE PyDateTime_DATE_GET_MINUTE
47#define DATE_GET_SECOND PyDateTime_DATE_GET_SECOND
48#define DATE_GET_MICROSECOND PyDateTime_DATE_GET_MICROSECOND
49
50/* Date accessors for date and datetime. */
51#define SET_YEAR(o, v) (((o)->data[0] = ((v) & 0xff00) >> 8), \
52 ((o)->data[1] = ((v) & 0x00ff)))
53#define SET_MONTH(o, v) (PyDateTime_GET_MONTH(o) = (v))
54#define SET_DAY(o, v) (PyDateTime_GET_DAY(o) = (v))
55
56/* Date/Time accessors for datetime. */
57#define DATE_SET_HOUR(o, v) (PyDateTime_DATE_GET_HOUR(o) = (v))
58#define DATE_SET_MINUTE(o, v) (PyDateTime_DATE_GET_MINUTE(o) = (v))
59#define DATE_SET_SECOND(o, v) (PyDateTime_DATE_GET_SECOND(o) = (v))
60#define DATE_SET_MICROSECOND(o, v) \
61 (((o)->data[7] = ((v) & 0xff0000) >> 16), \
62 ((o)->data[8] = ((v) & 0x00ff00) >> 8), \
63 ((o)->data[9] = ((v) & 0x0000ff)))
64
65/* Time accessors for time. */
66#define TIME_GET_HOUR PyDateTime_TIME_GET_HOUR
67#define TIME_GET_MINUTE PyDateTime_TIME_GET_MINUTE
68#define TIME_GET_SECOND PyDateTime_TIME_GET_SECOND
69#define TIME_GET_MICROSECOND PyDateTime_TIME_GET_MICROSECOND
70#define TIME_SET_HOUR(o, v) (PyDateTime_TIME_GET_HOUR(o) = (v))
71#define TIME_SET_MINUTE(o, v) (PyDateTime_TIME_GET_MINUTE(o) = (v))
72#define TIME_SET_SECOND(o, v) (PyDateTime_TIME_GET_SECOND(o) = (v))
73#define TIME_SET_MICROSECOND(o, v) \
74 (((o)->data[3] = ((v) & 0xff0000) >> 16), \
75 ((o)->data[4] = ((v) & 0x00ff00) >> 8), \
76 ((o)->data[5] = ((v) & 0x0000ff)))
77
78/* Delta accessors for timedelta. */
79#define GET_TD_DAYS(o) (((PyDateTime_Delta *)(o))->days)
80#define GET_TD_SECONDS(o) (((PyDateTime_Delta *)(o))->seconds)
81#define GET_TD_MICROSECONDS(o) (((PyDateTime_Delta *)(o))->microseconds)
82
83#define SET_TD_DAYS(o, v) ((o)->days = (v))
84#define SET_TD_SECONDS(o, v) ((o)->seconds = (v))
85#define SET_TD_MICROSECONDS(o, v) ((o)->microseconds = (v))
86
Tim Petersa032d2e2003-01-11 00:15:54 +000087/* p is a pointer to a time or a datetime object; HASTZINFO(p) returns
88 * p->hastzinfo.
89 */
90#define HASTZINFO(p) (((_PyDateTime_BaseTZInfo *)(p))->hastzinfo)
91
Tim Peters3f606292004-03-21 23:38:41 +000092/* M is a char or int claiming to be a valid month. The macro is equivalent
93 * to the two-sided Python test
94 * 1 <= M <= 12
95 */
96#define MONTH_IS_SANE(M) ((unsigned int)(M) - 1 < 12)
97
Tim Peters2a799bf2002-12-16 20:18:38 +000098/* Forward declarations. */
99static PyTypeObject PyDateTime_DateType;
100static PyTypeObject PyDateTime_DateTimeType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000101static PyTypeObject PyDateTime_DeltaType;
102static PyTypeObject PyDateTime_TimeType;
103static PyTypeObject PyDateTime_TZInfoType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000104
105/* ---------------------------------------------------------------------------
106 * Math utilities.
107 */
108
109/* k = i+j overflows iff k differs in sign from both inputs,
110 * iff k^i has sign bit set and k^j has sign bit set,
111 * iff (k^i)&(k^j) has sign bit set.
112 */
113#define SIGNED_ADD_OVERFLOWED(RESULT, I, J) \
114 ((((RESULT) ^ (I)) & ((RESULT) ^ (J))) < 0)
115
116/* Compute Python divmod(x, y), returning the quotient and storing the
117 * remainder into *r. The quotient is the floor of x/y, and that's
118 * the real point of this. C will probably truncate instead (C99
119 * requires truncation; C89 left it implementation-defined).
120 * Simplification: we *require* that y > 0 here. That's appropriate
121 * for all the uses made of it. This simplifies the code and makes
122 * the overflow case impossible (divmod(LONG_MIN, -1) is the only
123 * overflow case).
124 */
125static int
126divmod(int x, int y, int *r)
127{
128 int quo;
129
130 assert(y > 0);
131 quo = x / y;
132 *r = x - quo * y;
133 if (*r < 0) {
134 --quo;
135 *r += y;
136 }
137 assert(0 <= *r && *r < y);
138 return quo;
139}
140
Tim Peters5d644dd2003-01-02 16:32:54 +0000141/* Round a double to the nearest long. |x| must be small enough to fit
142 * in a C long; this is not checked.
143 */
144static long
145round_to_long(double x)
146{
147 if (x >= 0.0)
148 x = floor(x + 0.5);
149 else
150 x = ceil(x - 0.5);
151 return (long)x;
152}
153
Tim Peters2a799bf2002-12-16 20:18:38 +0000154/* ---------------------------------------------------------------------------
155 * General calendrical helper functions
156 */
157
158/* For each month ordinal in 1..12, the number of days in that month,
159 * and the number of days before that month in the same year. These
160 * are correct for non-leap years only.
161 */
162static int _days_in_month[] = {
163 0, /* unused; this vector uses 1-based indexing */
164 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
165};
166
167static int _days_before_month[] = {
168 0, /* unused; this vector uses 1-based indexing */
169 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
170};
171
172/* year -> 1 if leap year, else 0. */
173static int
174is_leap(int year)
175{
176 /* Cast year to unsigned. The result is the same either way, but
177 * C can generate faster code for unsigned mod than for signed
178 * mod (especially for % 4 -- a good compiler should just grab
179 * the last 2 bits when the LHS is unsigned).
180 */
181 const unsigned int ayear = (unsigned int)year;
182 return ayear % 4 == 0 && (ayear % 100 != 0 || ayear % 400 == 0);
183}
184
185/* year, month -> number of days in that month in that year */
186static int
187days_in_month(int year, int month)
188{
189 assert(month >= 1);
190 assert(month <= 12);
191 if (month == 2 && is_leap(year))
192 return 29;
193 else
194 return _days_in_month[month];
195}
196
197/* year, month -> number of days in year preceeding first day of month */
198static int
199days_before_month(int year, int month)
200{
201 int days;
202
203 assert(month >= 1);
204 assert(month <= 12);
205 days = _days_before_month[month];
206 if (month > 2 && is_leap(year))
207 ++days;
208 return days;
209}
210
211/* year -> number of days before January 1st of year. Remember that we
212 * start with year 1, so days_before_year(1) == 0.
213 */
214static int
215days_before_year(int year)
216{
217 int y = year - 1;
218 /* This is incorrect if year <= 0; we really want the floor
219 * here. But so long as MINYEAR is 1, the smallest year this
220 * can see is 0 (this can happen in some normalization endcases),
221 * so we'll just special-case that.
222 */
223 assert (year >= 0);
224 if (y >= 0)
225 return y*365 + y/4 - y/100 + y/400;
226 else {
227 assert(y == -1);
228 return -366;
229 }
230}
231
232/* Number of days in 4, 100, and 400 year cycles. That these have
233 * the correct values is asserted in the module init function.
234 */
235#define DI4Y 1461 /* days_before_year(5); days in 4 years */
236#define DI100Y 36524 /* days_before_year(101); days in 100 years */
237#define DI400Y 146097 /* days_before_year(401); days in 400 years */
238
239/* ordinal -> year, month, day, considering 01-Jan-0001 as day 1. */
240static void
241ord_to_ymd(int ordinal, int *year, int *month, int *day)
242{
243 int n, n1, n4, n100, n400, leapyear, preceding;
244
245 /* ordinal is a 1-based index, starting at 1-Jan-1. The pattern of
246 * leap years repeats exactly every 400 years. The basic strategy is
247 * to find the closest 400-year boundary at or before ordinal, then
248 * work with the offset from that boundary to ordinal. Life is much
249 * clearer if we subtract 1 from ordinal first -- then the values
250 * of ordinal at 400-year boundaries are exactly those divisible
251 * by DI400Y:
252 *
253 * D M Y n n-1
254 * -- --- ---- ---------- ----------------
255 * 31 Dec -400 -DI400Y -DI400Y -1
256 * 1 Jan -399 -DI400Y +1 -DI400Y 400-year boundary
257 * ...
258 * 30 Dec 000 -1 -2
259 * 31 Dec 000 0 -1
260 * 1 Jan 001 1 0 400-year boundary
261 * 2 Jan 001 2 1
262 * 3 Jan 001 3 2
263 * ...
264 * 31 Dec 400 DI400Y DI400Y -1
265 * 1 Jan 401 DI400Y +1 DI400Y 400-year boundary
266 */
267 assert(ordinal >= 1);
268 --ordinal;
269 n400 = ordinal / DI400Y;
270 n = ordinal % DI400Y;
271 *year = n400 * 400 + 1;
272
273 /* Now n is the (non-negative) offset, in days, from January 1 of
274 * year, to the desired date. Now compute how many 100-year cycles
275 * precede n.
276 * Note that it's possible for n100 to equal 4! In that case 4 full
277 * 100-year cycles precede the desired day, which implies the
278 * desired day is December 31 at the end of a 400-year cycle.
279 */
280 n100 = n / DI100Y;
281 n = n % DI100Y;
282
283 /* Now compute how many 4-year cycles precede it. */
284 n4 = n / DI4Y;
285 n = n % DI4Y;
286
287 /* And now how many single years. Again n1 can be 4, and again
288 * meaning that the desired day is December 31 at the end of the
289 * 4-year cycle.
290 */
291 n1 = n / 365;
292 n = n % 365;
293
294 *year += n100 * 100 + n4 * 4 + n1;
295 if (n1 == 4 || n100 == 4) {
296 assert(n == 0);
297 *year -= 1;
298 *month = 12;
299 *day = 31;
300 return;
301 }
302
303 /* Now the year is correct, and n is the offset from January 1. We
304 * find the month via an estimate that's either exact or one too
305 * large.
306 */
307 leapyear = n1 == 3 && (n4 != 24 || n100 == 3);
308 assert(leapyear == is_leap(*year));
309 *month = (n + 50) >> 5;
310 preceding = (_days_before_month[*month] + (*month > 2 && leapyear));
311 if (preceding > n) {
312 /* estimate is too large */
313 *month -= 1;
314 preceding -= days_in_month(*year, *month);
315 }
316 n -= preceding;
317 assert(0 <= n);
318 assert(n < days_in_month(*year, *month));
319
320 *day = n + 1;
321}
322
323/* year, month, day -> ordinal, considering 01-Jan-0001 as day 1. */
324static int
325ymd_to_ord(int year, int month, int day)
326{
327 return days_before_year(year) + days_before_month(year, month) + day;
328}
329
330/* Day of week, where Monday==0, ..., Sunday==6. 1/1/1 was a Monday. */
331static int
332weekday(int year, int month, int day)
333{
334 return (ymd_to_ord(year, month, day) + 6) % 7;
335}
336
337/* Ordinal of the Monday starting week 1 of the ISO year. Week 1 is the
338 * first calendar week containing a Thursday.
339 */
340static int
341iso_week1_monday(int year)
342{
343 int first_day = ymd_to_ord(year, 1, 1); /* ord of 1/1 */
344 /* 0 if 1/1 is a Monday, 1 if a Tue, etc. */
345 int first_weekday = (first_day + 6) % 7;
346 /* ordinal of closest Monday at or before 1/1 */
347 int week1_monday = first_day - first_weekday;
348
349 if (first_weekday > 3) /* if 1/1 was Fri, Sat, Sun */
350 week1_monday += 7;
351 return week1_monday;
352}
353
354/* ---------------------------------------------------------------------------
355 * Range checkers.
356 */
357
358/* Check that -MAX_DELTA_DAYS <= days <= MAX_DELTA_DAYS. If so, return 0.
359 * If not, raise OverflowError and return -1.
360 */
361static int
362check_delta_day_range(int days)
363{
364 if (-MAX_DELTA_DAYS <= days && days <= MAX_DELTA_DAYS)
365 return 0;
366 PyErr_Format(PyExc_OverflowError,
367 "days=%d; must have magnitude <= %d",
Guido van Rossumbd43e912002-12-16 20:34:55 +0000368 days, MAX_DELTA_DAYS);
Tim Peters2a799bf2002-12-16 20:18:38 +0000369 return -1;
370}
371
372/* Check that date arguments are in range. Return 0 if they are. If they
373 * aren't, raise ValueError and return -1.
374 */
375static int
376check_date_args(int year, int month, int day)
377{
378
379 if (year < MINYEAR || year > MAXYEAR) {
380 PyErr_SetString(PyExc_ValueError,
381 "year is out of range");
382 return -1;
383 }
384 if (month < 1 || month > 12) {
385 PyErr_SetString(PyExc_ValueError,
386 "month must be in 1..12");
387 return -1;
388 }
389 if (day < 1 || day > days_in_month(year, month)) {
390 PyErr_SetString(PyExc_ValueError,
391 "day is out of range for month");
392 return -1;
393 }
394 return 0;
395}
396
397/* Check that time arguments are in range. Return 0 if they are. If they
398 * aren't, raise ValueError and return -1.
399 */
400static int
401check_time_args(int h, int m, int s, int us)
402{
403 if (h < 0 || h > 23) {
404 PyErr_SetString(PyExc_ValueError,
405 "hour must be in 0..23");
406 return -1;
407 }
408 if (m < 0 || m > 59) {
409 PyErr_SetString(PyExc_ValueError,
410 "minute must be in 0..59");
411 return -1;
412 }
413 if (s < 0 || s > 59) {
414 PyErr_SetString(PyExc_ValueError,
415 "second must be in 0..59");
416 return -1;
417 }
418 if (us < 0 || us > 999999) {
419 PyErr_SetString(PyExc_ValueError,
420 "microsecond must be in 0..999999");
421 return -1;
422 }
423 return 0;
424}
425
426/* ---------------------------------------------------------------------------
427 * Normalization utilities.
428 */
429
430/* One step of a mixed-radix conversion. A "hi" unit is equivalent to
431 * factor "lo" units. factor must be > 0. If *lo is less than 0, or
432 * at least factor, enough of *lo is converted into "hi" units so that
433 * 0 <= *lo < factor. The input values must be such that int overflow
434 * is impossible.
435 */
436static void
437normalize_pair(int *hi, int *lo, int factor)
438{
439 assert(factor > 0);
440 assert(lo != hi);
441 if (*lo < 0 || *lo >= factor) {
442 const int num_hi = divmod(*lo, factor, lo);
443 const int new_hi = *hi + num_hi;
444 assert(! SIGNED_ADD_OVERFLOWED(new_hi, *hi, num_hi));
445 *hi = new_hi;
446 }
447 assert(0 <= *lo && *lo < factor);
448}
449
450/* Fiddle days (d), seconds (s), and microseconds (us) so that
451 * 0 <= *s < 24*3600
452 * 0 <= *us < 1000000
453 * The input values must be such that the internals don't overflow.
454 * The way this routine is used, we don't get close.
455 */
456static void
457normalize_d_s_us(int *d, int *s, int *us)
458{
459 if (*us < 0 || *us >= 1000000) {
460 normalize_pair(s, us, 1000000);
461 /* |s| can't be bigger than about
462 * |original s| + |original us|/1000000 now.
463 */
464
465 }
466 if (*s < 0 || *s >= 24*3600) {
467 normalize_pair(d, s, 24*3600);
468 /* |d| can't be bigger than about
469 * |original d| +
470 * (|original s| + |original us|/1000000) / (24*3600) now.
471 */
472 }
473 assert(0 <= *s && *s < 24*3600);
474 assert(0 <= *us && *us < 1000000);
475}
476
477/* Fiddle years (y), months (m), and days (d) so that
478 * 1 <= *m <= 12
479 * 1 <= *d <= days_in_month(*y, *m)
480 * The input values must be such that the internals don't overflow.
481 * The way this routine is used, we don't get close.
482 */
483static void
484normalize_y_m_d(int *y, int *m, int *d)
485{
486 int dim; /* # of days in month */
487
488 /* This gets muddy: the proper range for day can't be determined
489 * without knowing the correct month and year, but if day is, e.g.,
490 * plus or minus a million, the current month and year values make
491 * no sense (and may also be out of bounds themselves).
492 * Saying 12 months == 1 year should be non-controversial.
493 */
494 if (*m < 1 || *m > 12) {
495 --*m;
496 normalize_pair(y, m, 12);
497 ++*m;
498 /* |y| can't be bigger than about
499 * |original y| + |original m|/12 now.
500 */
501 }
502 assert(1 <= *m && *m <= 12);
503
504 /* Now only day can be out of bounds (year may also be out of bounds
505 * for a datetime object, but we don't care about that here).
506 * If day is out of bounds, what to do is arguable, but at least the
507 * method here is principled and explainable.
508 */
509 dim = days_in_month(*y, *m);
510 if (*d < 1 || *d > dim) {
511 /* Move day-1 days from the first of the month. First try to
512 * get off cheap if we're only one day out of range
513 * (adjustments for timezone alone can't be worse than that).
514 */
515 if (*d == 0) {
516 --*m;
517 if (*m > 0)
518 *d = days_in_month(*y, *m);
519 else {
520 --*y;
521 *m = 12;
522 *d = 31;
523 }
524 }
525 else if (*d == dim + 1) {
526 /* move forward a day */
527 ++*m;
528 *d = 1;
529 if (*m > 12) {
530 *m = 1;
531 ++*y;
532 }
533 }
534 else {
535 int ordinal = ymd_to_ord(*y, *m, 1) +
536 *d - 1;
537 ord_to_ymd(ordinal, y, m, d);
538 }
539 }
540 assert(*m > 0);
541 assert(*d > 0);
542}
543
544/* Fiddle out-of-bounds months and days so that the result makes some kind
545 * of sense. The parameters are both inputs and outputs. Returns < 0 on
546 * failure, where failure means the adjusted year is out of bounds.
547 */
548static int
549normalize_date(int *year, int *month, int *day)
550{
551 int result;
552
553 normalize_y_m_d(year, month, day);
554 if (MINYEAR <= *year && *year <= MAXYEAR)
555 result = 0;
556 else {
557 PyErr_SetString(PyExc_OverflowError,
558 "date value out of range");
559 result = -1;
560 }
561 return result;
562}
563
564/* Force all the datetime fields into range. The parameters are both
565 * inputs and outputs. Returns < 0 on error.
566 */
567static int
568normalize_datetime(int *year, int *month, int *day,
569 int *hour, int *minute, int *second,
570 int *microsecond)
571{
572 normalize_pair(second, microsecond, 1000000);
573 normalize_pair(minute, second, 60);
574 normalize_pair(hour, minute, 60);
575 normalize_pair(day, hour, 24);
576 return normalize_date(year, month, day);
577}
578
579/* ---------------------------------------------------------------------------
Tim Petersb0c854d2003-05-17 15:57:00 +0000580 * Basic object allocation: tp_alloc implementations. These allocate
581 * Python objects of the right size and type, and do the Python object-
582 * initialization bit. If there's not enough memory, they return NULL after
583 * setting MemoryError. All data members remain uninitialized trash.
584 *
585 * We abuse the tp_alloc "nitems" argument to communicate whether a tzinfo
Tim Peters03eaf8b2003-05-18 02:24:46 +0000586 * member is needed. This is ugly, imprecise, and possibly insecure.
587 * tp_basicsize for the time and datetime types is set to the size of the
588 * struct that has room for the tzinfo member, so subclasses in Python will
589 * allocate enough space for a tzinfo member whether or not one is actually
590 * needed. That's the "ugly and imprecise" parts. The "possibly insecure"
591 * part is that PyType_GenericAlloc() (which subclasses in Python end up
592 * using) just happens today to effectively ignore the nitems argument
593 * when tp_itemsize is 0, which it is for these type objects. If that
594 * changes, perhaps the callers of tp_alloc slots in this file should
595 * be changed to force a 0 nitems argument unless the type being allocated
596 * is a base type implemented in this file (so that tp_alloc is time_alloc
597 * or datetime_alloc below, which know about the nitems abuse).
Tim Petersb0c854d2003-05-17 15:57:00 +0000598 */
599
600static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000601time_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000602{
603 PyObject *self;
604
605 self = (PyObject *)
606 PyObject_MALLOC(aware ?
607 sizeof(PyDateTime_Time) :
608 sizeof(_PyDateTime_BaseTime));
609 if (self == NULL)
610 return (PyObject *)PyErr_NoMemory();
611 PyObject_INIT(self, type);
612 return self;
613}
614
615static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000616datetime_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000617{
618 PyObject *self;
619
620 self = (PyObject *)
621 PyObject_MALLOC(aware ?
622 sizeof(PyDateTime_DateTime) :
623 sizeof(_PyDateTime_BaseDateTime));
624 if (self == NULL)
625 return (PyObject *)PyErr_NoMemory();
626 PyObject_INIT(self, type);
627 return self;
628}
629
630/* ---------------------------------------------------------------------------
631 * Helpers for setting object fields. These work on pointers to the
632 * appropriate base class.
633 */
634
635/* For date and datetime. */
636static void
637set_date_fields(PyDateTime_Date *self, int y, int m, int d)
638{
639 self->hashcode = -1;
640 SET_YEAR(self, y);
641 SET_MONTH(self, m);
642 SET_DAY(self, d);
643}
644
645/* ---------------------------------------------------------------------------
646 * Create various objects, mostly without range checking.
647 */
648
649/* Create a date instance with no range checking. */
650static PyObject *
651new_date_ex(int year, int month, int day, PyTypeObject *type)
652{
653 PyDateTime_Date *self;
654
655 self = (PyDateTime_Date *) (type->tp_alloc(type, 0));
656 if (self != NULL)
657 set_date_fields(self, year, month, day);
658 return (PyObject *) self;
659}
660
661#define new_date(year, month, day) \
662 new_date_ex(year, month, day, &PyDateTime_DateType)
663
664/* Create a datetime instance with no range checking. */
665static PyObject *
666new_datetime_ex(int year, int month, int day, int hour, int minute,
667 int second, int usecond, PyObject *tzinfo, PyTypeObject *type)
668{
669 PyDateTime_DateTime *self;
670 char aware = tzinfo != Py_None;
671
672 self = (PyDateTime_DateTime *) (type->tp_alloc(type, aware));
673 if (self != NULL) {
674 self->hastzinfo = aware;
675 set_date_fields((PyDateTime_Date *)self, year, month, day);
676 DATE_SET_HOUR(self, hour);
677 DATE_SET_MINUTE(self, minute);
678 DATE_SET_SECOND(self, second);
679 DATE_SET_MICROSECOND(self, usecond);
680 if (aware) {
681 Py_INCREF(tzinfo);
682 self->tzinfo = tzinfo;
683 }
684 }
685 return (PyObject *)self;
686}
687
688#define new_datetime(y, m, d, hh, mm, ss, us, tzinfo) \
689 new_datetime_ex(y, m, d, hh, mm, ss, us, tzinfo, \
690 &PyDateTime_DateTimeType)
691
692/* Create a time instance with no range checking. */
693static PyObject *
694new_time_ex(int hour, int minute, int second, int usecond,
695 PyObject *tzinfo, PyTypeObject *type)
696{
697 PyDateTime_Time *self;
698 char aware = tzinfo != Py_None;
699
700 self = (PyDateTime_Time *) (type->tp_alloc(type, aware));
701 if (self != NULL) {
702 self->hastzinfo = aware;
703 self->hashcode = -1;
704 TIME_SET_HOUR(self, hour);
705 TIME_SET_MINUTE(self, minute);
706 TIME_SET_SECOND(self, second);
707 TIME_SET_MICROSECOND(self, usecond);
708 if (aware) {
709 Py_INCREF(tzinfo);
710 self->tzinfo = tzinfo;
711 }
712 }
713 return (PyObject *)self;
714}
715
716#define new_time(hh, mm, ss, us, tzinfo) \
717 new_time_ex(hh, mm, ss, us, tzinfo, &PyDateTime_TimeType)
718
719/* Create a timedelta instance. Normalize the members iff normalize is
720 * true. Passing false is a speed optimization, if you know for sure
721 * that seconds and microseconds are already in their proper ranges. In any
722 * case, raises OverflowError and returns NULL if the normalized days is out
723 * of range).
724 */
725static PyObject *
726new_delta_ex(int days, int seconds, int microseconds, int normalize,
727 PyTypeObject *type)
728{
729 PyDateTime_Delta *self;
730
731 if (normalize)
732 normalize_d_s_us(&days, &seconds, &microseconds);
733 assert(0 <= seconds && seconds < 24*3600);
734 assert(0 <= microseconds && microseconds < 1000000);
735
736 if (check_delta_day_range(days) < 0)
737 return NULL;
738
739 self = (PyDateTime_Delta *) (type->tp_alloc(type, 0));
740 if (self != NULL) {
741 self->hashcode = -1;
742 SET_TD_DAYS(self, days);
743 SET_TD_SECONDS(self, seconds);
744 SET_TD_MICROSECONDS(self, microseconds);
745 }
746 return (PyObject *) self;
747}
748
749#define new_delta(d, s, us, normalize) \
750 new_delta_ex(d, s, us, normalize, &PyDateTime_DeltaType)
751
752/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +0000753 * tzinfo helpers.
754 */
755
Tim Peters855fe882002-12-22 03:43:39 +0000756/* Ensure that p is None or of a tzinfo subclass. Return 0 if OK; if not
757 * raise TypeError and return -1.
758 */
759static int
760check_tzinfo_subclass(PyObject *p)
761{
762 if (p == Py_None || PyTZInfo_Check(p))
763 return 0;
764 PyErr_Format(PyExc_TypeError,
765 "tzinfo argument must be None or of a tzinfo subclass, "
766 "not type '%s'",
Christian Heimes90aa7642007-12-19 02:45:37 +0000767 Py_TYPE(p)->tp_name);
Tim Peters855fe882002-12-22 03:43:39 +0000768 return -1;
769}
770
Tim Petersbad8ff02002-12-30 20:52:32 +0000771/* Return tzinfo.methname(tzinfoarg), without any checking of results.
Tim Peters855fe882002-12-22 03:43:39 +0000772 * If tzinfo is None, returns None.
773 */
774static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000775call_tzinfo_method(PyObject *tzinfo, char *methname, PyObject *tzinfoarg)
Tim Peters855fe882002-12-22 03:43:39 +0000776{
777 PyObject *result;
778
Tim Petersbad8ff02002-12-30 20:52:32 +0000779 assert(tzinfo && methname && tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000780 assert(check_tzinfo_subclass(tzinfo) >= 0);
781 if (tzinfo == Py_None) {
782 result = Py_None;
783 Py_INCREF(result);
784 }
785 else
Tim Petersbad8ff02002-12-30 20:52:32 +0000786 result = PyObject_CallMethod(tzinfo, methname, "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000787 return result;
788}
789
Tim Peters2a799bf2002-12-16 20:18:38 +0000790/* If self has a tzinfo member, return a BORROWED reference to it. Else
791 * return NULL, which is NOT AN ERROR. There are no error returns here,
792 * and the caller must not decref the result.
793 */
794static PyObject *
795get_tzinfo_member(PyObject *self)
796{
797 PyObject *tzinfo = NULL;
798
Tim Petersa9bc1682003-01-11 03:39:11 +0000799 if (PyDateTime_Check(self) && HASTZINFO(self))
800 tzinfo = ((PyDateTime_DateTime *)self)->tzinfo;
Tim Petersa032d2e2003-01-11 00:15:54 +0000801 else if (PyTime_Check(self) && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +0000802 tzinfo = ((PyDateTime_Time *)self)->tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000803
804 return tzinfo;
805}
806
Tim Petersbad8ff02002-12-30 20:52:32 +0000807/* Call getattr(tzinfo, name)(tzinfoarg), and extract an int from the
Tim Peters2a799bf2002-12-16 20:18:38 +0000808 * result. tzinfo must be an instance of the tzinfo class. If the method
809 * returns None, this returns 0 and sets *none to 1. If the method doesn't
Tim Peters397301e2003-01-02 21:28:08 +0000810 * return None or timedelta, TypeError is raised and this returns -1. If it
811 * returnsa timedelta and the value is out of range or isn't a whole number
812 * of minutes, ValueError is raised and this returns -1.
Tim Peters2a799bf2002-12-16 20:18:38 +0000813 * Else *none is set to 0 and the integer method result is returned.
814 */
815static int
816call_utc_tzinfo_method(PyObject *tzinfo, char *name, PyObject *tzinfoarg,
817 int *none)
818{
819 PyObject *u;
Tim Peters397301e2003-01-02 21:28:08 +0000820 int result = -1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000821
822 assert(tzinfo != NULL);
823 assert(PyTZInfo_Check(tzinfo));
824 assert(tzinfoarg != NULL);
825
826 *none = 0;
Tim Petersbad8ff02002-12-30 20:52:32 +0000827 u = call_tzinfo_method(tzinfo, name, tzinfoarg);
Tim Peters2a799bf2002-12-16 20:18:38 +0000828 if (u == NULL)
829 return -1;
830
Tim Peters27362852002-12-23 16:17:39 +0000831 else if (u == Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +0000832 result = 0;
833 *none = 1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000834 }
Tim Peters855fe882002-12-22 03:43:39 +0000835 else if (PyDelta_Check(u)) {
836 const int days = GET_TD_DAYS(u);
837 if (days < -1 || days > 0)
838 result = 24*60; /* trigger ValueError below */
839 else {
840 /* next line can't overflow because we know days
841 * is -1 or 0 now
842 */
843 int ss = days * 24 * 3600 + GET_TD_SECONDS(u);
844 result = divmod(ss, 60, &ss);
845 if (ss || GET_TD_MICROSECONDS(u)) {
846 PyErr_Format(PyExc_ValueError,
847 "tzinfo.%s() must return a "
848 "whole number of minutes",
849 name);
850 result = -1;
Tim Peters855fe882002-12-22 03:43:39 +0000851 }
852 }
853 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000854 else {
855 PyErr_Format(PyExc_TypeError,
Tim Peters397301e2003-01-02 21:28:08 +0000856 "tzinfo.%s() must return None or "
Tim Peters855fe882002-12-22 03:43:39 +0000857 "timedelta, not '%s'",
Christian Heimes90aa7642007-12-19 02:45:37 +0000858 name, Py_TYPE(u)->tp_name);
Tim Peters2a799bf2002-12-16 20:18:38 +0000859 }
860
Tim Peters2a799bf2002-12-16 20:18:38 +0000861 Py_DECREF(u);
862 if (result < -1439 || result > 1439) {
863 PyErr_Format(PyExc_ValueError,
Neal Norwitz506a2242003-01-04 01:02:25 +0000864 "tzinfo.%s() returned %d; must be in "
Tim Peters2a799bf2002-12-16 20:18:38 +0000865 "-1439 .. 1439",
866 name, result);
867 result = -1;
868 }
Tim Peters397301e2003-01-02 21:28:08 +0000869 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +0000870}
871
872/* Call tzinfo.utcoffset(tzinfoarg), and extract an integer from the
873 * result. tzinfo must be an instance of the tzinfo class. If utcoffset()
874 * returns None, call_utcoffset returns 0 and sets *none to 1. If uctoffset()
Tim Peters397301e2003-01-02 21:28:08 +0000875 * doesn't return None or timedelta, TypeError is raised and this returns -1.
876 * If utcoffset() returns an invalid timedelta (out of range, or not a whole
877 * # of minutes), ValueError is raised and this returns -1. Else *none is
878 * set to 0 and the offset is returned (as int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000879 */
880static int
881call_utcoffset(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
882{
883 return call_utc_tzinfo_method(tzinfo, "utcoffset", tzinfoarg, none);
884}
885
Tim Petersbad8ff02002-12-30 20:52:32 +0000886/* Call tzinfo.name(tzinfoarg), and return the offset as a timedelta or None.
887 */
Tim Peters855fe882002-12-22 03:43:39 +0000888static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000889offset_as_timedelta(PyObject *tzinfo, char *name, PyObject *tzinfoarg) {
Tim Peters855fe882002-12-22 03:43:39 +0000890 PyObject *result;
891
Tim Petersbad8ff02002-12-30 20:52:32 +0000892 assert(tzinfo && name && tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000893 if (tzinfo == Py_None) {
894 result = Py_None;
895 Py_INCREF(result);
896 }
897 else {
898 int none;
Tim Petersbad8ff02002-12-30 20:52:32 +0000899 int offset = call_utc_tzinfo_method(tzinfo, name, tzinfoarg,
900 &none);
Tim Peters855fe882002-12-22 03:43:39 +0000901 if (offset < 0 && PyErr_Occurred())
902 return NULL;
903 if (none) {
904 result = Py_None;
905 Py_INCREF(result);
906 }
907 else
908 result = new_delta(0, offset * 60, 0, 1);
909 }
910 return result;
911}
912
Tim Peters2a799bf2002-12-16 20:18:38 +0000913/* Call tzinfo.dst(tzinfoarg), and extract an integer from the
914 * result. tzinfo must be an instance of the tzinfo class. If dst()
915 * returns None, call_dst returns 0 and sets *none to 1. If dst()
Tim Peters397301e2003-01-02 21:28:08 +0000916 & doesn't return None or timedelta, TypeError is raised and this
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000917 * returns -1. If dst() returns an invalid timedelta for a UTC offset,
Tim Peters397301e2003-01-02 21:28:08 +0000918 * ValueError is raised and this returns -1. Else *none is set to 0 and
919 * the offset is returned (as an int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000920 */
921static int
922call_dst(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
923{
924 return call_utc_tzinfo_method(tzinfo, "dst", tzinfoarg, none);
925}
926
Tim Petersbad8ff02002-12-30 20:52:32 +0000927/* Call tzinfo.tzname(tzinfoarg), and return the result. tzinfo must be
Tim Peters855fe882002-12-22 03:43:39 +0000928 * an instance of the tzinfo class or None. If tzinfo isn't None, and
Tim Petersbad8ff02002-12-30 20:52:32 +0000929 * tzname() doesn't return None or a string, TypeError is raised and this
Guido van Rossume3d1d412007-05-23 21:24:35 +0000930 * returns NULL. If the result is a string, we ensure it is a Unicode
931 * string.
Tim Peters2a799bf2002-12-16 20:18:38 +0000932 */
933static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000934call_tzname(PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +0000935{
936 PyObject *result;
937
938 assert(tzinfo != NULL);
Tim Peters855fe882002-12-22 03:43:39 +0000939 assert(check_tzinfo_subclass(tzinfo) >= 0);
Tim Petersbad8ff02002-12-30 20:52:32 +0000940 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000941
Tim Peters855fe882002-12-22 03:43:39 +0000942 if (tzinfo == Py_None) {
943 result = Py_None;
944 Py_INCREF(result);
945 }
946 else
Tim Petersbad8ff02002-12-30 20:52:32 +0000947 result = PyObject_CallMethod(tzinfo, "tzname", "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000948
Guido van Rossume3d1d412007-05-23 21:24:35 +0000949 if (result != NULL && result != Py_None) {
Guido van Rossumfd53fd62007-08-24 04:05:13 +0000950 if (!PyUnicode_Check(result)) {
Guido van Rossume3d1d412007-05-23 21:24:35 +0000951 PyErr_Format(PyExc_TypeError, "tzinfo.tzname() must "
952 "return None or a string, not '%s'",
Christian Heimes90aa7642007-12-19 02:45:37 +0000953 Py_TYPE(result)->tp_name);
Guido van Rossume3d1d412007-05-23 21:24:35 +0000954 Py_DECREF(result);
955 result = NULL;
956 }
957 else if (!PyUnicode_Check(result)) {
958 PyObject *temp = PyUnicode_FromObject(result);
959 Py_DECREF(result);
960 result = temp;
961 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000962 }
963 return result;
964}
965
966typedef enum {
967 /* an exception has been set; the caller should pass it on */
968 OFFSET_ERROR,
969
Tim Petersa9bc1682003-01-11 03:39:11 +0000970 /* type isn't date, datetime, or time subclass */
Tim Peters2a799bf2002-12-16 20:18:38 +0000971 OFFSET_UNKNOWN,
972
973 /* date,
Tim Petersa9bc1682003-01-11 03:39:11 +0000974 * datetime with !hastzinfo
975 * datetime with None tzinfo,
976 * datetime where utcoffset() returns None
Tim Peters37f39822003-01-10 03:49:02 +0000977 * time with !hastzinfo
978 * time with None tzinfo,
979 * time where utcoffset() returns None
Tim Peters2a799bf2002-12-16 20:18:38 +0000980 */
981 OFFSET_NAIVE,
982
Tim Petersa9bc1682003-01-11 03:39:11 +0000983 /* time or datetime where utcoffset() doesn't return None */
Georg Brandle810fe22006-02-19 15:28:47 +0000984 OFFSET_AWARE
Tim Peters2a799bf2002-12-16 20:18:38 +0000985} naivety;
986
Tim Peters14b69412002-12-22 18:10:22 +0000987/* Classify an object as to whether it's naive or offset-aware. See
Tim Peters2a799bf2002-12-16 20:18:38 +0000988 * the "naivety" typedef for details. If the type is aware, *offset is set
989 * to minutes east of UTC (as returned by the tzinfo.utcoffset() method).
Tim Peters14b69412002-12-22 18:10:22 +0000990 * If the type is offset-naive (or unknown, or error), *offset is set to 0.
Tim Peterse39a80c2002-12-30 21:28:52 +0000991 * tzinfoarg is the argument to pass to the tzinfo.utcoffset() method.
Tim Peters2a799bf2002-12-16 20:18:38 +0000992 */
993static naivety
Tim Peterse39a80c2002-12-30 21:28:52 +0000994classify_utcoffset(PyObject *op, PyObject *tzinfoarg, int *offset)
Tim Peters2a799bf2002-12-16 20:18:38 +0000995{
996 int none;
997 PyObject *tzinfo;
998
Tim Peterse39a80c2002-12-30 21:28:52 +0000999 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001000 *offset = 0;
Tim Peters14b69412002-12-22 18:10:22 +00001001 tzinfo = get_tzinfo_member(op); /* NULL means no tzinfo, not error */
Tim Peters2a799bf2002-12-16 20:18:38 +00001002 if (tzinfo == Py_None)
1003 return OFFSET_NAIVE;
Tim Peters14b69412002-12-22 18:10:22 +00001004 if (tzinfo == NULL) {
1005 /* note that a datetime passes the PyDate_Check test */
1006 return (PyTime_Check(op) || PyDate_Check(op)) ?
1007 OFFSET_NAIVE : OFFSET_UNKNOWN;
1008 }
Tim Peterse39a80c2002-12-30 21:28:52 +00001009 *offset = call_utcoffset(tzinfo, tzinfoarg, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00001010 if (*offset == -1 && PyErr_Occurred())
1011 return OFFSET_ERROR;
1012 return none ? OFFSET_NAIVE : OFFSET_AWARE;
1013}
1014
Tim Peters00237032002-12-27 02:21:51 +00001015/* Classify two objects as to whether they're naive or offset-aware.
1016 * This isn't quite the same as calling classify_utcoffset() twice: for
1017 * binary operations (comparison and subtraction), we generally want to
1018 * ignore the tzinfo members if they're identical. This is by design,
1019 * so that results match "naive" expectations when mixing objects from a
1020 * single timezone. So in that case, this sets both offsets to 0 and
1021 * both naiveties to OFFSET_NAIVE.
1022 * The function returns 0 if everything's OK, and -1 on error.
1023 */
1024static int
1025classify_two_utcoffsets(PyObject *o1, int *offset1, naivety *n1,
Tim Peterse39a80c2002-12-30 21:28:52 +00001026 PyObject *tzinfoarg1,
1027 PyObject *o2, int *offset2, naivety *n2,
1028 PyObject *tzinfoarg2)
Tim Peters00237032002-12-27 02:21:51 +00001029{
1030 if (get_tzinfo_member(o1) == get_tzinfo_member(o2)) {
1031 *offset1 = *offset2 = 0;
1032 *n1 = *n2 = OFFSET_NAIVE;
1033 }
1034 else {
Tim Peterse39a80c2002-12-30 21:28:52 +00001035 *n1 = classify_utcoffset(o1, tzinfoarg1, offset1);
Tim Peters00237032002-12-27 02:21:51 +00001036 if (*n1 == OFFSET_ERROR)
1037 return -1;
Tim Peterse39a80c2002-12-30 21:28:52 +00001038 *n2 = classify_utcoffset(o2, tzinfoarg2, offset2);
Tim Peters00237032002-12-27 02:21:51 +00001039 if (*n2 == OFFSET_ERROR)
1040 return -1;
1041 }
1042 return 0;
1043}
1044
Tim Peters2a799bf2002-12-16 20:18:38 +00001045/* repr is like "someclass(arg1, arg2)". If tzinfo isn't None,
1046 * stuff
1047 * ", tzinfo=" + repr(tzinfo)
1048 * before the closing ")".
1049 */
1050static PyObject *
1051append_keyword_tzinfo(PyObject *repr, PyObject *tzinfo)
1052{
1053 PyObject *temp;
1054
Walter Dörwald1ab83302007-05-18 17:15:44 +00001055 assert(PyUnicode_Check(repr));
Tim Peters2a799bf2002-12-16 20:18:38 +00001056 assert(tzinfo);
1057 if (tzinfo == Py_None)
1058 return repr;
1059 /* Get rid of the trailing ')'. */
Walter Dörwald1ab83302007-05-18 17:15:44 +00001060 assert(PyUnicode_AS_UNICODE(repr)[PyUnicode_GET_SIZE(repr)-1] == ')');
1061 temp = PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(repr),
1062 PyUnicode_GET_SIZE(repr) - 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00001063 Py_DECREF(repr);
1064 if (temp == NULL)
1065 return NULL;
Walter Dörwald517bcfe2007-05-23 20:45:05 +00001066 repr = PyUnicode_FromFormat("%U, tzinfo=%R)", temp, tzinfo);
1067 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00001068 return repr;
1069}
1070
1071/* ---------------------------------------------------------------------------
1072 * String format helpers.
1073 */
1074
1075static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00001076format_ctime(PyDateTime_Date *date, int hours, int minutes, int seconds)
Tim Peters2a799bf2002-12-16 20:18:38 +00001077{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001078 static const char *DayNames[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001079 "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"
1080 };
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001081 static const char *MonthNames[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001082 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1083 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
1084 };
1085
Tim Peters2a799bf2002-12-16 20:18:38 +00001086 int wday = weekday(GET_YEAR(date), GET_MONTH(date), GET_DAY(date));
1087
Walter Dörwald4af32b32007-05-31 16:19:50 +00001088 return PyUnicode_FromFormat("%s %s %2d %02d:%02d:%02d %04d",
1089 DayNames[wday], MonthNames[GET_MONTH(date)-1],
1090 GET_DAY(date), hours, minutes, seconds,
1091 GET_YEAR(date));
Tim Peters2a799bf2002-12-16 20:18:38 +00001092}
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
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001131static PyObject *
1132make_Zreplacement(PyObject *object, PyObject *tzinfoarg)
1133{
Neal Norwitzaea70e02007-08-12 04:32:26 +00001134 PyObject *temp;
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001135 PyObject *tzinfo = get_tzinfo_member(object);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001136 PyObject *Zreplacement = PyUnicode_FromStringAndSize(NULL, 0);
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001137 if (Zreplacement == NULL)
1138 return NULL;
Neal Norwitzaea70e02007-08-12 04:32:26 +00001139 if (tzinfo == Py_None || tzinfo == NULL)
1140 return Zreplacement;
1141
1142 assert(tzinfoarg != NULL);
1143 temp = call_tzname(tzinfo, tzinfoarg);
1144 if (temp == NULL)
1145 goto Error;
1146 if (temp == Py_None) {
1147 Py_DECREF(temp);
1148 return Zreplacement;
1149 }
1150
1151 assert(PyUnicode_Check(temp));
1152 /* Since the tzname is getting stuffed into the
1153 * format, we have to double any % signs so that
1154 * strftime doesn't treat them as format codes.
1155 */
1156 Py_DECREF(Zreplacement);
1157 Zreplacement = PyObject_CallMethod(temp, "replace", "ss", "%", "%%");
1158 Py_DECREF(temp);
1159 if (Zreplacement == NULL)
1160 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001161 if (!PyUnicode_Check(Zreplacement)) {
Neal Norwitzaea70e02007-08-12 04:32:26 +00001162 PyErr_SetString(PyExc_TypeError,
1163 "tzname.replace() did not return a string");
1164 goto Error;
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001165 }
1166 return Zreplacement;
1167
1168 Error:
1169 Py_DECREF(Zreplacement);
1170 return NULL;
1171}
1172
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001173static PyObject *
1174make_freplacement(PyObject *object)
1175{
1176 char freplacement[7];
1177 if (PyTime_Check(object))
1178 sprintf(freplacement, "%06d", TIME_GET_MICROSECOND(object));
1179 else if (PyDateTime_Check(object))
1180 sprintf(freplacement, "%06d", DATE_GET_MICROSECOND(object));
1181 else
1182 sprintf(freplacement, "%06d", 0);
1183
1184 return PyString_FromStringAndSize(freplacement, strlen(freplacement));
1185}
1186
Tim Peters2a799bf2002-12-16 20:18:38 +00001187/* I sure don't want to reproduce the strftime code from the time module,
1188 * so this imports the module and calls it. All the hair is due to
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001189 * giving special meanings to the %z, %Z and %f format codes via a
1190 * preprocessing step on the format string.
Tim Petersbad8ff02002-12-30 20:52:32 +00001191 * tzinfoarg is the argument to pass to the object's tzinfo method, if
1192 * needed.
Tim Peters2a799bf2002-12-16 20:18:38 +00001193 */
1194static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +00001195wrap_strftime(PyObject *object, PyObject *format, PyObject *timetuple,
1196 PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001197{
1198 PyObject *result = NULL; /* guilty until proved innocent */
1199
1200 PyObject *zreplacement = NULL; /* py string, replacement for %z */
1201 PyObject *Zreplacement = NULL; /* py string, replacement for %Z */
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001202 PyObject *freplacement = NULL; /* py string, replacement for %f */
Tim Peters2a799bf2002-12-16 20:18:38 +00001203
Guido van Rossumbce56a62007-05-10 18:04:33 +00001204 const char *pin;/* pointer to next char in input format */
1205 Py_ssize_t flen;/* length of input format */
Tim Peters2a799bf2002-12-16 20:18:38 +00001206 char ch; /* next char in input format */
1207
1208 PyObject *newfmt = NULL; /* py string, the output format */
1209 char *pnew; /* pointer to available byte in output format */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001210 int totalnew; /* number bytes total in output format buffer,
Tim Peters2a799bf2002-12-16 20:18:38 +00001211 exclusive of trailing \0 */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001212 int usednew; /* number bytes used so far in output format buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001213
Guido van Rossumbce56a62007-05-10 18:04:33 +00001214 const char *ptoappend;/* pointer to string to append to output buffer */
Brett Cannon27da8122007-11-06 23:15:11 +00001215 Py_ssize_t ntoappend; /* # of bytes to append to output buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001216
Tim Peters2a799bf2002-12-16 20:18:38 +00001217 assert(object && format && timetuple);
Guido van Rossumfd53fd62007-08-24 04:05:13 +00001218 assert(PyUnicode_Check(format));
Neal Norwitz908c8712007-08-27 04:58:38 +00001219 /* Convert the input format to a C string and size */
1220 pin = PyUnicode_AsString(format);
1221 if (!pin)
1222 return NULL;
1223 flen = PyUnicode_GetSize(format);
Tim Peters2a799bf2002-12-16 20:18:38 +00001224
Tim Petersd6844152002-12-22 20:58:42 +00001225 /* Give up if the year is before 1900.
1226 * Python strftime() plays games with the year, and different
1227 * games depending on whether envar PYTHON2K is set. This makes
1228 * years before 1900 a nightmare, even if the platform strftime
1229 * supports them (and not all do).
1230 * We could get a lot farther here by avoiding Python's strftime
1231 * wrapper and calling the C strftime() directly, but that isn't
1232 * an option in the Python implementation of this module.
1233 */
1234 {
1235 long year;
1236 PyObject *pyyear = PySequence_GetItem(timetuple, 0);
1237 if (pyyear == NULL) return NULL;
Christian Heimes217cfd12007-12-02 14:31:20 +00001238 assert(PyLong_Check(pyyear));
1239 year = PyLong_AsLong(pyyear);
Tim Petersd6844152002-12-22 20:58:42 +00001240 Py_DECREF(pyyear);
1241 if (year < 1900) {
1242 PyErr_Format(PyExc_ValueError, "year=%ld is before "
1243 "1900; the datetime strftime() "
1244 "methods require year >= 1900",
1245 year);
1246 return NULL;
1247 }
1248 }
1249
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001250 /* Scan the input format, looking for %z/%Z/%f escapes, building
Tim Peters328fff72002-12-20 01:31:27 +00001251 * a new format. Since computing the replacements for those codes
1252 * is expensive, don't unless they're actually used.
Tim Peters2a799bf2002-12-16 20:18:38 +00001253 */
Guido van Rossumbce56a62007-05-10 18:04:33 +00001254 totalnew = flen + 1; /* realistic if no %z/%Z */
Walter Dörwald6bd238c2007-11-22 09:38:52 +00001255 newfmt = PyString_FromStringAndSize(NULL, totalnew);
Tim Peters2a799bf2002-12-16 20:18:38 +00001256 if (newfmt == NULL) goto Done;
Walter Dörwald6bd238c2007-11-22 09:38:52 +00001257 pnew = PyString_AsString(newfmt);
Tim Peters2a799bf2002-12-16 20:18:38 +00001258 usednew = 0;
1259
Tim Peters2a799bf2002-12-16 20:18:38 +00001260 while ((ch = *pin++) != '\0') {
1261 if (ch != '%') {
Tim Peters328fff72002-12-20 01:31:27 +00001262 ptoappend = pin - 1;
Tim Peters2a799bf2002-12-16 20:18:38 +00001263 ntoappend = 1;
1264 }
1265 else if ((ch = *pin++) == '\0') {
1266 /* There's a lone trailing %; doesn't make sense. */
1267 PyErr_SetString(PyExc_ValueError, "strftime format "
1268 "ends with raw %");
1269 goto Done;
1270 }
1271 /* A % has been seen and ch is the character after it. */
1272 else if (ch == 'z') {
1273 if (zreplacement == NULL) {
1274 /* format utcoffset */
Tim Peters328fff72002-12-20 01:31:27 +00001275 char buf[100];
Tim Peters2a799bf2002-12-16 20:18:38 +00001276 PyObject *tzinfo = get_tzinfo_member(object);
Walter Dörwald6bd238c2007-11-22 09:38:52 +00001277 zreplacement = PyString_FromStringAndSize("", 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00001278 if (zreplacement == NULL) goto Done;
1279 if (tzinfo != Py_None && tzinfo != NULL) {
Tim Petersbad8ff02002-12-30 20:52:32 +00001280 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001281 if (format_utcoffset(buf,
Tim Peters328fff72002-12-20 01:31:27 +00001282 sizeof(buf),
Tim Peters2a799bf2002-12-16 20:18:38 +00001283 "",
1284 tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00001285 tzinfoarg) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00001286 goto Done;
1287 Py_DECREF(zreplacement);
Guido van Rossumfd53fd62007-08-24 04:05:13 +00001288 zreplacement =
Walter Dörwald6bd238c2007-11-22 09:38:52 +00001289 PyString_FromStringAndSize(buf,
Guido van Rossumfd53fd62007-08-24 04:05:13 +00001290 strlen(buf));
1291 if (zreplacement == NULL)
1292 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00001293 }
1294 }
1295 assert(zreplacement != NULL);
Walter Dörwald6bd238c2007-11-22 09:38:52 +00001296 ptoappend = PyString_AS_STRING(zreplacement);
1297 ntoappend = PyString_GET_SIZE(zreplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001298 }
1299 else if (ch == 'Z') {
1300 /* format tzname */
1301 if (Zreplacement == NULL) {
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001302 Zreplacement = make_Zreplacement(object,
1303 tzinfoarg);
1304 if (Zreplacement == NULL)
1305 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00001306 }
1307 assert(Zreplacement != NULL);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001308 assert(PyUnicode_Check(Zreplacement));
1309 ptoappend = PyUnicode_AsStringAndSize(Zreplacement,
1310 &ntoappend);
Christian Heimes90aa7642007-12-19 02:45:37 +00001311 ntoappend = Py_SIZE(Zreplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001312 }
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001313 else if (ch == 'f') {
1314 /* format microseconds */
1315 if (freplacement == NULL) {
1316 freplacement = make_freplacement(object);
1317 if (freplacement == NULL)
1318 goto Done;
1319 }
1320 assert(freplacement != NULL);
1321 assert(PyString_Check(freplacement));
1322 ptoappend = PyString_AS_STRING(freplacement);
1323 ntoappend = PyString_GET_SIZE(freplacement);
1324 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001325 else {
Tim Peters328fff72002-12-20 01:31:27 +00001326 /* percent followed by neither z nor Z */
1327 ptoappend = pin - 2;
Tim Peters2a799bf2002-12-16 20:18:38 +00001328 ntoappend = 2;
1329 }
1330
1331 /* Append the ntoappend chars starting at ptoappend to
1332 * the new format.
1333 */
Tim Peters2a799bf2002-12-16 20:18:38 +00001334 if (ntoappend == 0)
1335 continue;
Guido van Rossumfd53fd62007-08-24 04:05:13 +00001336 assert(ptoappend != NULL);
1337 assert(ntoappend > 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00001338 while (usednew + ntoappend > totalnew) {
1339 int bigger = totalnew << 1;
1340 if ((bigger >> 1) != totalnew) { /* overflow */
1341 PyErr_NoMemory();
1342 goto Done;
1343 }
Walter Dörwald6bd238c2007-11-22 09:38:52 +00001344 if (_PyString_Resize(&newfmt, bigger) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00001345 goto Done;
1346 totalnew = bigger;
Walter Dörwald6bd238c2007-11-22 09:38:52 +00001347 pnew = PyString_AsString(newfmt) + usednew;
Tim Peters2a799bf2002-12-16 20:18:38 +00001348 }
1349 memcpy(pnew, ptoappend, ntoappend);
1350 pnew += ntoappend;
1351 usednew += ntoappend;
1352 assert(usednew <= totalnew);
1353 } /* end while() */
1354
Walter Dörwald6bd238c2007-11-22 09:38:52 +00001355 if (_PyString_Resize(&newfmt, usednew) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00001356 goto Done;
1357 {
Neal Norwitz908c8712007-08-27 04:58:38 +00001358 PyObject *format;
Christian Heimes072c0f12008-01-03 23:01:04 +00001359 PyObject *time = PyImport_ImportModuleNoBlock("time");
Tim Peters2a799bf2002-12-16 20:18:38 +00001360 if (time == NULL)
1361 goto Done;
Walter Dörwald6bd238c2007-11-22 09:38:52 +00001362 format = PyUnicode_FromString(PyString_AS_STRING(newfmt));
Neal Norwitz908c8712007-08-27 04:58:38 +00001363 if (format != NULL) {
1364 result = PyObject_CallMethod(time, "strftime", "OO",
1365 format, timetuple);
1366 Py_DECREF(format);
1367 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001368 Py_DECREF(time);
1369 }
1370 Done:
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001371 Py_XDECREF(freplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001372 Py_XDECREF(zreplacement);
1373 Py_XDECREF(Zreplacement);
1374 Py_XDECREF(newfmt);
1375 return result;
1376}
1377
Tim Peters2a799bf2002-12-16 20:18:38 +00001378/* ---------------------------------------------------------------------------
1379 * Wrap functions from the time module. These aren't directly available
1380 * from C. Perhaps they should be.
1381 */
1382
1383/* Call time.time() and return its result (a Python float). */
1384static PyObject *
Guido van Rossumbd43e912002-12-16 20:34:55 +00001385time_time(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00001386{
1387 PyObject *result = NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00001388 PyObject *time = PyImport_ImportModuleNoBlock("time");
Tim Peters2a799bf2002-12-16 20:18:38 +00001389
1390 if (time != NULL) {
1391 result = PyObject_CallMethod(time, "time", "()");
1392 Py_DECREF(time);
1393 }
1394 return result;
1395}
1396
1397/* Build a time.struct_time. The weekday and day number are automatically
1398 * computed from the y,m,d args.
1399 */
1400static PyObject *
1401build_struct_time(int y, int m, int d, int hh, int mm, int ss, int dstflag)
1402{
1403 PyObject *time;
1404 PyObject *result = NULL;
1405
Christian Heimes072c0f12008-01-03 23:01:04 +00001406 time = PyImport_ImportModuleNoBlock("time");
Tim Peters2a799bf2002-12-16 20:18:38 +00001407 if (time != NULL) {
1408 result = PyObject_CallMethod(time, "struct_time",
1409 "((iiiiiiiii))",
1410 y, m, d,
1411 hh, mm, ss,
1412 weekday(y, m, d),
1413 days_before_month(y, m) + d,
1414 dstflag);
1415 Py_DECREF(time);
1416 }
1417 return result;
1418}
1419
1420/* ---------------------------------------------------------------------------
1421 * Miscellaneous helpers.
1422 */
1423
Guido van Rossum19960592006-08-24 17:29:38 +00001424/* For various reasons, we need to use tp_richcompare instead of tp_compare.
Tim Peters2a799bf2002-12-16 20:18:38 +00001425 * The comparisons here all most naturally compute a cmp()-like result.
1426 * This little helper turns that into a bool result for rich comparisons.
1427 */
1428static PyObject *
1429diff_to_bool(int diff, int op)
1430{
1431 PyObject *result;
1432 int istrue;
1433
1434 switch (op) {
1435 case Py_EQ: istrue = diff == 0; break;
1436 case Py_NE: istrue = diff != 0; break;
1437 case Py_LE: istrue = diff <= 0; break;
1438 case Py_GE: istrue = diff >= 0; break;
1439 case Py_LT: istrue = diff < 0; break;
1440 case Py_GT: istrue = diff > 0; break;
1441 default:
1442 assert(! "op unknown");
1443 istrue = 0; /* To shut up compiler */
1444 }
1445 result = istrue ? Py_True : Py_False;
1446 Py_INCREF(result);
1447 return result;
1448}
1449
Tim Peters07534a62003-02-07 22:50:28 +00001450/* Raises a "can't compare" TypeError and returns NULL. */
1451static PyObject *
1452cmperror(PyObject *a, PyObject *b)
1453{
1454 PyErr_Format(PyExc_TypeError,
1455 "can't compare %s to %s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001456 Py_TYPE(a)->tp_name, Py_TYPE(b)->tp_name);
Tim Peters07534a62003-02-07 22:50:28 +00001457 return NULL;
1458}
1459
Tim Peters2a799bf2002-12-16 20:18:38 +00001460/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +00001461 * Cached Python objects; these are set by the module init function.
1462 */
1463
1464/* Conversion factors. */
1465static PyObject *us_per_us = NULL; /* 1 */
1466static PyObject *us_per_ms = NULL; /* 1000 */
1467static PyObject *us_per_second = NULL; /* 1000000 */
1468static PyObject *us_per_minute = NULL; /* 1e6 * 60 as Python int */
1469static PyObject *us_per_hour = NULL; /* 1e6 * 3600 as Python long */
1470static PyObject *us_per_day = NULL; /* 1e6 * 3600 * 24 as Python long */
1471static PyObject *us_per_week = NULL; /* 1e6*3600*24*7 as Python long */
1472static PyObject *seconds_per_day = NULL; /* 3600*24 as Python int */
1473
Tim Peters2a799bf2002-12-16 20:18:38 +00001474/* ---------------------------------------------------------------------------
1475 * Class implementations.
1476 */
1477
1478/*
1479 * PyDateTime_Delta implementation.
1480 */
1481
1482/* Convert a timedelta to a number of us,
1483 * (24*3600*self.days + self.seconds)*1000000 + self.microseconds
1484 * as a Python int or long.
1485 * Doing mixed-radix arithmetic by hand instead is excruciating in C,
1486 * due to ubiquitous overflow possibilities.
1487 */
1488static PyObject *
1489delta_to_microseconds(PyDateTime_Delta *self)
1490{
1491 PyObject *x1 = NULL;
1492 PyObject *x2 = NULL;
1493 PyObject *x3 = NULL;
1494 PyObject *result = NULL;
1495
Christian Heimes217cfd12007-12-02 14:31:20 +00001496 x1 = PyLong_FromLong(GET_TD_DAYS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00001497 if (x1 == NULL)
1498 goto Done;
1499 x2 = PyNumber_Multiply(x1, seconds_per_day); /* days in seconds */
1500 if (x2 == NULL)
1501 goto Done;
1502 Py_DECREF(x1);
1503 x1 = NULL;
1504
1505 /* x2 has days in seconds */
Christian Heimes217cfd12007-12-02 14:31:20 +00001506 x1 = PyLong_FromLong(GET_TD_SECONDS(self)); /* seconds */
Tim Peters2a799bf2002-12-16 20:18:38 +00001507 if (x1 == NULL)
1508 goto Done;
1509 x3 = PyNumber_Add(x1, x2); /* days and seconds in seconds */
1510 if (x3 == NULL)
1511 goto Done;
1512 Py_DECREF(x1);
1513 Py_DECREF(x2);
1514 x1 = x2 = NULL;
1515
1516 /* x3 has days+seconds in seconds */
1517 x1 = PyNumber_Multiply(x3, us_per_second); /* us */
1518 if (x1 == NULL)
1519 goto Done;
1520 Py_DECREF(x3);
1521 x3 = NULL;
1522
1523 /* x1 has days+seconds in us */
Christian Heimes217cfd12007-12-02 14:31:20 +00001524 x2 = PyLong_FromLong(GET_TD_MICROSECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00001525 if (x2 == NULL)
1526 goto Done;
1527 result = PyNumber_Add(x1, x2);
1528
1529Done:
1530 Py_XDECREF(x1);
1531 Py_XDECREF(x2);
1532 Py_XDECREF(x3);
1533 return result;
1534}
1535
1536/* Convert a number of us (as a Python int or long) to a timedelta.
1537 */
1538static PyObject *
Tim Petersb0c854d2003-05-17 15:57:00 +00001539microseconds_to_delta_ex(PyObject *pyus, PyTypeObject *type)
Tim Peters2a799bf2002-12-16 20:18:38 +00001540{
1541 int us;
1542 int s;
1543 int d;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001544 long temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001545
1546 PyObject *tuple = NULL;
1547 PyObject *num = NULL;
1548 PyObject *result = NULL;
1549
1550 tuple = PyNumber_Divmod(pyus, us_per_second);
1551 if (tuple == NULL)
1552 goto Done;
1553
1554 num = PyTuple_GetItem(tuple, 1); /* us */
1555 if (num == NULL)
1556 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001557 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001558 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001559 if (temp == -1 && PyErr_Occurred())
1560 goto Done;
1561 assert(0 <= temp && temp < 1000000);
1562 us = (int)temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001563 if (us < 0) {
1564 /* The divisor was positive, so this must be an error. */
1565 assert(PyErr_Occurred());
1566 goto Done;
1567 }
1568
1569 num = PyTuple_GetItem(tuple, 0); /* leftover seconds */
1570 if (num == NULL)
1571 goto Done;
1572 Py_INCREF(num);
1573 Py_DECREF(tuple);
1574
1575 tuple = PyNumber_Divmod(num, seconds_per_day);
1576 if (tuple == NULL)
1577 goto Done;
1578 Py_DECREF(num);
1579
1580 num = PyTuple_GetItem(tuple, 1); /* seconds */
1581 if (num == NULL)
1582 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001583 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001584 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001585 if (temp == -1 && PyErr_Occurred())
1586 goto Done;
1587 assert(0 <= temp && temp < 24*3600);
1588 s = (int)temp;
1589
Tim Peters2a799bf2002-12-16 20:18:38 +00001590 if (s < 0) {
1591 /* The divisor was positive, so this must be an error. */
1592 assert(PyErr_Occurred());
1593 goto Done;
1594 }
1595
1596 num = PyTuple_GetItem(tuple, 0); /* leftover days */
1597 if (num == NULL)
1598 goto Done;
1599 Py_INCREF(num);
Tim Peters0b0f41c2002-12-19 01:44:38 +00001600 temp = PyLong_AsLong(num);
1601 if (temp == -1 && PyErr_Occurred())
Tim Peters2a799bf2002-12-16 20:18:38 +00001602 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001603 d = (int)temp;
1604 if ((long)d != temp) {
1605 PyErr_SetString(PyExc_OverflowError, "normalized days too "
1606 "large to fit in a C int");
1607 goto Done;
1608 }
Tim Petersb0c854d2003-05-17 15:57:00 +00001609 result = new_delta_ex(d, s, us, 0, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001610
1611Done:
1612 Py_XDECREF(tuple);
1613 Py_XDECREF(num);
1614 return result;
1615}
1616
Tim Petersb0c854d2003-05-17 15:57:00 +00001617#define microseconds_to_delta(pymicros) \
1618 microseconds_to_delta_ex(pymicros, &PyDateTime_DeltaType)
1619
Tim Peters2a799bf2002-12-16 20:18:38 +00001620static PyObject *
1621multiply_int_timedelta(PyObject *intobj, PyDateTime_Delta *delta)
1622{
1623 PyObject *pyus_in;
1624 PyObject *pyus_out;
1625 PyObject *result;
1626
1627 pyus_in = delta_to_microseconds(delta);
1628 if (pyus_in == NULL)
1629 return NULL;
1630
1631 pyus_out = PyNumber_Multiply(pyus_in, intobj);
1632 Py_DECREF(pyus_in);
1633 if (pyus_out == NULL)
1634 return NULL;
1635
1636 result = microseconds_to_delta(pyus_out);
1637 Py_DECREF(pyus_out);
1638 return result;
1639}
1640
1641static PyObject *
1642divide_timedelta_int(PyDateTime_Delta *delta, PyObject *intobj)
1643{
1644 PyObject *pyus_in;
1645 PyObject *pyus_out;
1646 PyObject *result;
1647
1648 pyus_in = delta_to_microseconds(delta);
1649 if (pyus_in == NULL)
1650 return NULL;
1651
1652 pyus_out = PyNumber_FloorDivide(pyus_in, intobj);
1653 Py_DECREF(pyus_in);
1654 if (pyus_out == NULL)
1655 return NULL;
1656
1657 result = microseconds_to_delta(pyus_out);
1658 Py_DECREF(pyus_out);
1659 return result;
1660}
1661
1662static PyObject *
1663delta_add(PyObject *left, PyObject *right)
1664{
1665 PyObject *result = Py_NotImplemented;
1666
1667 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1668 /* delta + delta */
1669 /* The C-level additions can't overflow because of the
1670 * invariant bounds.
1671 */
1672 int days = GET_TD_DAYS(left) + GET_TD_DAYS(right);
1673 int seconds = GET_TD_SECONDS(left) + GET_TD_SECONDS(right);
1674 int microseconds = GET_TD_MICROSECONDS(left) +
1675 GET_TD_MICROSECONDS(right);
1676 result = new_delta(days, seconds, microseconds, 1);
1677 }
1678
1679 if (result == Py_NotImplemented)
1680 Py_INCREF(result);
1681 return result;
1682}
1683
1684static PyObject *
1685delta_negative(PyDateTime_Delta *self)
1686{
1687 return new_delta(-GET_TD_DAYS(self),
1688 -GET_TD_SECONDS(self),
1689 -GET_TD_MICROSECONDS(self),
1690 1);
1691}
1692
1693static PyObject *
1694delta_positive(PyDateTime_Delta *self)
1695{
1696 /* Could optimize this (by returning self) if this isn't a
1697 * subclass -- but who uses unary + ? Approximately nobody.
1698 */
1699 return new_delta(GET_TD_DAYS(self),
1700 GET_TD_SECONDS(self),
1701 GET_TD_MICROSECONDS(self),
1702 0);
1703}
1704
1705static PyObject *
1706delta_abs(PyDateTime_Delta *self)
1707{
1708 PyObject *result;
1709
1710 assert(GET_TD_MICROSECONDS(self) >= 0);
1711 assert(GET_TD_SECONDS(self) >= 0);
1712
1713 if (GET_TD_DAYS(self) < 0)
1714 result = delta_negative(self);
1715 else
1716 result = delta_positive(self);
1717
1718 return result;
1719}
1720
1721static PyObject *
1722delta_subtract(PyObject *left, PyObject *right)
1723{
1724 PyObject *result = Py_NotImplemented;
1725
1726 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1727 /* delta - delta */
1728 PyObject *minus_right = PyNumber_Negative(right);
1729 if (minus_right) {
1730 result = delta_add(left, minus_right);
1731 Py_DECREF(minus_right);
1732 }
1733 else
1734 result = NULL;
1735 }
1736
1737 if (result == Py_NotImplemented)
1738 Py_INCREF(result);
1739 return result;
1740}
1741
Tim Peters2a799bf2002-12-16 20:18:38 +00001742static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00001743delta_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters2a799bf2002-12-16 20:18:38 +00001744{
Tim Petersaa7d8492003-02-08 03:28:59 +00001745 if (PyDelta_Check(other)) {
Guido van Rossum19960592006-08-24 17:29:38 +00001746 int diff = GET_TD_DAYS(self) - GET_TD_DAYS(other);
Tim Peters07534a62003-02-07 22:50:28 +00001747 if (diff == 0) {
1748 diff = GET_TD_SECONDS(self) - GET_TD_SECONDS(other);
1749 if (diff == 0)
1750 diff = GET_TD_MICROSECONDS(self) -
1751 GET_TD_MICROSECONDS(other);
1752 }
Guido van Rossum19960592006-08-24 17:29:38 +00001753 return diff_to_bool(diff, op);
Tim Peters2a799bf2002-12-16 20:18:38 +00001754 }
Guido van Rossum19960592006-08-24 17:29:38 +00001755 else {
1756 Py_INCREF(Py_NotImplemented);
1757 return Py_NotImplemented;
1758 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001759}
1760
1761static PyObject *delta_getstate(PyDateTime_Delta *self);
1762
1763static long
1764delta_hash(PyDateTime_Delta *self)
1765{
1766 if (self->hashcode == -1) {
1767 PyObject *temp = delta_getstate(self);
1768 if (temp != NULL) {
1769 self->hashcode = PyObject_Hash(temp);
1770 Py_DECREF(temp);
1771 }
1772 }
1773 return self->hashcode;
1774}
1775
1776static PyObject *
1777delta_multiply(PyObject *left, PyObject *right)
1778{
1779 PyObject *result = Py_NotImplemented;
1780
1781 if (PyDelta_Check(left)) {
1782 /* delta * ??? */
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001783 if (PyLong_Check(right))
Tim Peters2a799bf2002-12-16 20:18:38 +00001784 result = multiply_int_timedelta(right,
1785 (PyDateTime_Delta *) left);
1786 }
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001787 else if (PyLong_Check(left))
Tim Peters2a799bf2002-12-16 20:18:38 +00001788 result = multiply_int_timedelta(left,
1789 (PyDateTime_Delta *) right);
1790
1791 if (result == Py_NotImplemented)
1792 Py_INCREF(result);
1793 return result;
1794}
1795
1796static PyObject *
1797delta_divide(PyObject *left, PyObject *right)
1798{
1799 PyObject *result = Py_NotImplemented;
1800
1801 if (PyDelta_Check(left)) {
1802 /* delta * ??? */
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001803 if (PyLong_Check(right))
Tim Peters2a799bf2002-12-16 20:18:38 +00001804 result = divide_timedelta_int(
1805 (PyDateTime_Delta *)left,
1806 right);
1807 }
1808
1809 if (result == Py_NotImplemented)
1810 Py_INCREF(result);
1811 return result;
1812}
1813
1814/* Fold in the value of the tag ("seconds", "weeks", etc) component of a
1815 * timedelta constructor. sofar is the # of microseconds accounted for
1816 * so far, and there are factor microseconds per current unit, the number
1817 * of which is given by num. num * factor is added to sofar in a
1818 * numerically careful way, and that's the result. Any fractional
1819 * microseconds left over (this can happen if num is a float type) are
1820 * added into *leftover.
1821 * Note that there are many ways this can give an error (NULL) return.
1822 */
1823static PyObject *
1824accum(const char* tag, PyObject *sofar, PyObject *num, PyObject *factor,
1825 double *leftover)
1826{
1827 PyObject *prod;
1828 PyObject *sum;
1829
1830 assert(num != NULL);
1831
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001832 if (PyLong_Check(num)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00001833 prod = PyNumber_Multiply(num, factor);
1834 if (prod == NULL)
1835 return NULL;
1836 sum = PyNumber_Add(sofar, prod);
1837 Py_DECREF(prod);
1838 return sum;
1839 }
1840
1841 if (PyFloat_Check(num)) {
1842 double dnum;
1843 double fracpart;
1844 double intpart;
1845 PyObject *x;
1846 PyObject *y;
1847
1848 /* The Plan: decompose num into an integer part and a
1849 * fractional part, num = intpart + fracpart.
1850 * Then num * factor ==
1851 * intpart * factor + fracpart * factor
1852 * and the LHS can be computed exactly in long arithmetic.
1853 * The RHS is again broken into an int part and frac part.
1854 * and the frac part is added into *leftover.
1855 */
1856 dnum = PyFloat_AsDouble(num);
1857 if (dnum == -1.0 && PyErr_Occurred())
1858 return NULL;
1859 fracpart = modf(dnum, &intpart);
1860 x = PyLong_FromDouble(intpart);
1861 if (x == NULL)
1862 return NULL;
1863
1864 prod = PyNumber_Multiply(x, factor);
1865 Py_DECREF(x);
1866 if (prod == NULL)
1867 return NULL;
1868
1869 sum = PyNumber_Add(sofar, prod);
1870 Py_DECREF(prod);
1871 if (sum == NULL)
1872 return NULL;
1873
1874 if (fracpart == 0.0)
1875 return sum;
1876 /* So far we've lost no information. Dealing with the
1877 * fractional part requires float arithmetic, and may
1878 * lose a little info.
1879 */
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001880 assert(PyLong_Check(factor));
Guido van Rossumddefaf32007-01-14 03:31:43 +00001881 dnum = PyLong_AsDouble(factor);
Tim Peters2a799bf2002-12-16 20:18:38 +00001882
1883 dnum *= fracpart;
1884 fracpart = modf(dnum, &intpart);
1885 x = PyLong_FromDouble(intpart);
1886 if (x == NULL) {
1887 Py_DECREF(sum);
1888 return NULL;
1889 }
1890
1891 y = PyNumber_Add(sum, x);
1892 Py_DECREF(sum);
1893 Py_DECREF(x);
1894 *leftover += fracpart;
1895 return y;
1896 }
1897
1898 PyErr_Format(PyExc_TypeError,
1899 "unsupported type for timedelta %s component: %s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001900 tag, Py_TYPE(num)->tp_name);
Tim Peters2a799bf2002-12-16 20:18:38 +00001901 return NULL;
1902}
1903
1904static PyObject *
1905delta_new(PyTypeObject *type, PyObject *args, PyObject *kw)
1906{
1907 PyObject *self = NULL;
1908
1909 /* Argument objects. */
1910 PyObject *day = NULL;
1911 PyObject *second = NULL;
1912 PyObject *us = NULL;
1913 PyObject *ms = NULL;
1914 PyObject *minute = NULL;
1915 PyObject *hour = NULL;
1916 PyObject *week = NULL;
1917
1918 PyObject *x = NULL; /* running sum of microseconds */
1919 PyObject *y = NULL; /* temp sum of microseconds */
1920 double leftover_us = 0.0;
1921
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00001922 static char *keywords[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001923 "days", "seconds", "microseconds", "milliseconds",
1924 "minutes", "hours", "weeks", NULL
1925 };
1926
1927 if (PyArg_ParseTupleAndKeywords(args, kw, "|OOOOOOO:__new__",
1928 keywords,
1929 &day, &second, &us,
1930 &ms, &minute, &hour, &week) == 0)
1931 goto Done;
1932
Christian Heimes217cfd12007-12-02 14:31:20 +00001933 x = PyLong_FromLong(0);
Tim Peters2a799bf2002-12-16 20:18:38 +00001934 if (x == NULL)
1935 goto Done;
1936
1937#define CLEANUP \
1938 Py_DECREF(x); \
1939 x = y; \
1940 if (x == NULL) \
1941 goto Done
1942
1943 if (us) {
1944 y = accum("microseconds", x, us, us_per_us, &leftover_us);
1945 CLEANUP;
1946 }
1947 if (ms) {
1948 y = accum("milliseconds", x, ms, us_per_ms, &leftover_us);
1949 CLEANUP;
1950 }
1951 if (second) {
1952 y = accum("seconds", x, second, us_per_second, &leftover_us);
1953 CLEANUP;
1954 }
1955 if (minute) {
1956 y = accum("minutes", x, minute, us_per_minute, &leftover_us);
1957 CLEANUP;
1958 }
1959 if (hour) {
1960 y = accum("hours", x, hour, us_per_hour, &leftover_us);
1961 CLEANUP;
1962 }
1963 if (day) {
1964 y = accum("days", x, day, us_per_day, &leftover_us);
1965 CLEANUP;
1966 }
1967 if (week) {
1968 y = accum("weeks", x, week, us_per_week, &leftover_us);
1969 CLEANUP;
1970 }
1971 if (leftover_us) {
1972 /* Round to nearest whole # of us, and add into x. */
Tim Peters5d644dd2003-01-02 16:32:54 +00001973 PyObject *temp = PyLong_FromLong(round_to_long(leftover_us));
Tim Peters2a799bf2002-12-16 20:18:38 +00001974 if (temp == NULL) {
1975 Py_DECREF(x);
1976 goto Done;
1977 }
1978 y = PyNumber_Add(x, temp);
1979 Py_DECREF(temp);
1980 CLEANUP;
1981 }
1982
Tim Petersb0c854d2003-05-17 15:57:00 +00001983 self = microseconds_to_delta_ex(x, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001984 Py_DECREF(x);
1985Done:
1986 return self;
1987
1988#undef CLEANUP
1989}
1990
1991static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00001992delta_bool(PyDateTime_Delta *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00001993{
1994 return (GET_TD_DAYS(self) != 0
1995 || GET_TD_SECONDS(self) != 0
1996 || GET_TD_MICROSECONDS(self) != 0);
1997}
1998
1999static PyObject *
2000delta_repr(PyDateTime_Delta *self)
2001{
2002 if (GET_TD_MICROSECONDS(self) != 0)
Walter Dörwald1ab83302007-05-18 17:15:44 +00002003 return PyUnicode_FromFormat("%s(%d, %d, %d)",
Christian Heimes90aa7642007-12-19 02:45:37 +00002004 Py_TYPE(self)->tp_name,
Walter Dörwald7569dfe2007-05-19 21:49:49 +00002005 GET_TD_DAYS(self),
2006 GET_TD_SECONDS(self),
2007 GET_TD_MICROSECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002008 if (GET_TD_SECONDS(self) != 0)
Walter Dörwald1ab83302007-05-18 17:15:44 +00002009 return PyUnicode_FromFormat("%s(%d, %d)",
Christian Heimes90aa7642007-12-19 02:45:37 +00002010 Py_TYPE(self)->tp_name,
Walter Dörwald7569dfe2007-05-19 21:49:49 +00002011 GET_TD_DAYS(self),
2012 GET_TD_SECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002013
Walter Dörwald1ab83302007-05-18 17:15:44 +00002014 return PyUnicode_FromFormat("%s(%d)",
Christian Heimes90aa7642007-12-19 02:45:37 +00002015 Py_TYPE(self)->tp_name,
Walter Dörwald7569dfe2007-05-19 21:49:49 +00002016 GET_TD_DAYS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002017}
2018
2019static PyObject *
2020delta_str(PyDateTime_Delta *self)
2021{
Tim Peters2a799bf2002-12-16 20:18:38 +00002022 int us = GET_TD_MICROSECONDS(self);
Walter Dörwaldbaf853c2007-05-31 18:42:47 +00002023 int seconds = GET_TD_SECONDS(self);
2024 int minutes = divmod(seconds, 60, &seconds);
2025 int hours = divmod(minutes, 60, &minutes);
2026 int days = GET_TD_DAYS(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002027
2028 if (days) {
Walter Dörwaldbaf853c2007-05-31 18:42:47 +00002029 if (us)
2030 return PyUnicode_FromFormat("%d day%s, %d:%02d:%02d.%06d",
2031 days, (days == 1 || days == -1) ? "" : "s",
2032 hours, minutes, seconds, us);
2033 else
2034 return PyUnicode_FromFormat("%d day%s, %d:%02d:%02d",
2035 days, (days == 1 || days == -1) ? "" : "s",
2036 hours, minutes, seconds);
2037 } else {
2038 if (us)
2039 return PyUnicode_FromFormat("%d:%02d:%02d.%06d",
2040 hours, minutes, seconds, us);
2041 else
2042 return PyUnicode_FromFormat("%d:%02d:%02d",
2043 hours, minutes, seconds);
Tim Peters2a799bf2002-12-16 20:18:38 +00002044 }
2045
Tim Peters2a799bf2002-12-16 20:18:38 +00002046}
2047
Tim Peters371935f2003-02-01 01:52:50 +00002048/* Pickle support, a simple use of __reduce__. */
2049
Tim Petersb57f8f02003-02-01 02:54:15 +00002050/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002051static PyObject *
2052delta_getstate(PyDateTime_Delta *self)
2053{
2054 return Py_BuildValue("iii", GET_TD_DAYS(self),
2055 GET_TD_SECONDS(self),
2056 GET_TD_MICROSECONDS(self));
2057}
2058
Tim Peters2a799bf2002-12-16 20:18:38 +00002059static PyObject *
2060delta_reduce(PyDateTime_Delta* self)
2061{
Christian Heimes90aa7642007-12-19 02:45:37 +00002062 return Py_BuildValue("ON", Py_TYPE(self), delta_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002063}
2064
2065#define OFFSET(field) offsetof(PyDateTime_Delta, field)
2066
2067static PyMemberDef delta_members[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002068
Neal Norwitzdfb80862002-12-19 02:30:56 +00002069 {"days", T_INT, OFFSET(days), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002070 PyDoc_STR("Number of days.")},
2071
Neal Norwitzdfb80862002-12-19 02:30:56 +00002072 {"seconds", T_INT, OFFSET(seconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002073 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
2074
Neal Norwitzdfb80862002-12-19 02:30:56 +00002075 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002076 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
2077 {NULL}
2078};
2079
2080static PyMethodDef delta_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002081 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
2082 PyDoc_STR("__reduce__() -> (cls, state)")},
2083
Tim Peters2a799bf2002-12-16 20:18:38 +00002084 {NULL, NULL},
2085};
2086
2087static char delta_doc[] =
2088PyDoc_STR("Difference between two datetime values.");
2089
2090static PyNumberMethods delta_as_number = {
2091 delta_add, /* nb_add */
2092 delta_subtract, /* nb_subtract */
2093 delta_multiply, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00002094 0, /* nb_remainder */
2095 0, /* nb_divmod */
2096 0, /* nb_power */
2097 (unaryfunc)delta_negative, /* nb_negative */
2098 (unaryfunc)delta_positive, /* nb_positive */
2099 (unaryfunc)delta_abs, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +00002100 (inquiry)delta_bool, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00002101 0, /*nb_invert*/
2102 0, /*nb_lshift*/
2103 0, /*nb_rshift*/
2104 0, /*nb_and*/
2105 0, /*nb_xor*/
2106 0, /*nb_or*/
Neil Schemenauer16c70752007-09-21 20:19:23 +00002107 0, /*nb_reserved*/
Tim Peters2a799bf2002-12-16 20:18:38 +00002108 0, /*nb_int*/
2109 0, /*nb_long*/
2110 0, /*nb_float*/
2111 0, /*nb_oct*/
2112 0, /*nb_hex*/
2113 0, /*nb_inplace_add*/
2114 0, /*nb_inplace_subtract*/
2115 0, /*nb_inplace_multiply*/
Tim Peters2a799bf2002-12-16 20:18:38 +00002116 0, /*nb_inplace_remainder*/
2117 0, /*nb_inplace_power*/
2118 0, /*nb_inplace_lshift*/
2119 0, /*nb_inplace_rshift*/
2120 0, /*nb_inplace_and*/
2121 0, /*nb_inplace_xor*/
2122 0, /*nb_inplace_or*/
2123 delta_divide, /* nb_floor_divide */
2124 0, /* nb_true_divide */
2125 0, /* nb_inplace_floor_divide */
2126 0, /* nb_inplace_true_divide */
2127};
2128
2129static PyTypeObject PyDateTime_DeltaType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002130 PyVarObject_HEAD_INIT(NULL, 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00002131 "datetime.timedelta", /* tp_name */
2132 sizeof(PyDateTime_Delta), /* tp_basicsize */
2133 0, /* tp_itemsize */
2134 0, /* tp_dealloc */
2135 0, /* tp_print */
2136 0, /* tp_getattr */
2137 0, /* tp_setattr */
2138 0, /* tp_compare */
2139 (reprfunc)delta_repr, /* tp_repr */
2140 &delta_as_number, /* tp_as_number */
2141 0, /* tp_as_sequence */
2142 0, /* tp_as_mapping */
2143 (hashfunc)delta_hash, /* tp_hash */
2144 0, /* tp_call */
2145 (reprfunc)delta_str, /* tp_str */
2146 PyObject_GenericGetAttr, /* tp_getattro */
2147 0, /* tp_setattro */
2148 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002149 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00002150 delta_doc, /* tp_doc */
2151 0, /* tp_traverse */
2152 0, /* tp_clear */
Guido van Rossum19960592006-08-24 17:29:38 +00002153 delta_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00002154 0, /* tp_weaklistoffset */
2155 0, /* tp_iter */
2156 0, /* tp_iternext */
2157 delta_methods, /* tp_methods */
2158 delta_members, /* tp_members */
2159 0, /* tp_getset */
2160 0, /* tp_base */
2161 0, /* tp_dict */
2162 0, /* tp_descr_get */
2163 0, /* tp_descr_set */
2164 0, /* tp_dictoffset */
2165 0, /* tp_init */
2166 0, /* tp_alloc */
2167 delta_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002168 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002169};
2170
2171/*
2172 * PyDateTime_Date implementation.
2173 */
2174
2175/* Accessor properties. */
2176
2177static PyObject *
2178date_year(PyDateTime_Date *self, void *unused)
2179{
Christian Heimes217cfd12007-12-02 14:31:20 +00002180 return PyLong_FromLong(GET_YEAR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002181}
2182
2183static PyObject *
2184date_month(PyDateTime_Date *self, void *unused)
2185{
Christian Heimes217cfd12007-12-02 14:31:20 +00002186 return PyLong_FromLong(GET_MONTH(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002187}
2188
2189static PyObject *
2190date_day(PyDateTime_Date *self, void *unused)
2191{
Christian Heimes217cfd12007-12-02 14:31:20 +00002192 return PyLong_FromLong(GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002193}
2194
2195static PyGetSetDef date_getset[] = {
2196 {"year", (getter)date_year},
2197 {"month", (getter)date_month},
2198 {"day", (getter)date_day},
2199 {NULL}
2200};
2201
2202/* Constructors. */
2203
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002204static char *date_kws[] = {"year", "month", "day", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002205
Tim Peters2a799bf2002-12-16 20:18:38 +00002206static PyObject *
2207date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2208{
2209 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00002210 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00002211 int year;
2212 int month;
2213 int day;
2214
Guido van Rossum177e41a2003-01-30 22:06:23 +00002215 /* Check for invocation from pickle with __getstate__ state */
2216 if (PyTuple_GET_SIZE(args) == 1 &&
Guido van Rossum254348e2007-11-21 19:29:53 +00002217 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
2218 PyString_GET_SIZE(state) == _PyDateTime_DATE_DATASIZE &&
2219 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00002220 {
Tim Peters70533e22003-02-01 04:40:04 +00002221 PyDateTime_Date *me;
2222
Tim Peters604c0132004-06-07 23:04:33 +00002223 me = (PyDateTime_Date *) (type->tp_alloc(type, 0));
Tim Peters70533e22003-02-01 04:40:04 +00002224 if (me != NULL) {
Guido van Rossum254348e2007-11-21 19:29:53 +00002225 char *pdata = PyString_AS_STRING(state);
Tim Peters70533e22003-02-01 04:40:04 +00002226 memcpy(me->data, pdata, _PyDateTime_DATE_DATASIZE);
2227 me->hashcode = -1;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002228 }
Tim Peters70533e22003-02-01 04:40:04 +00002229 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002230 }
2231
Tim Peters12bf3392002-12-24 05:41:27 +00002232 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00002233 &year, &month, &day)) {
2234 if (check_date_args(year, month, day) < 0)
2235 return NULL;
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002236 self = new_date_ex(year, month, day, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00002237 }
2238 return self;
2239}
2240
2241/* Return new date from localtime(t). */
2242static PyObject *
Tim Peters1b6f7a92004-06-20 02:50:16 +00002243date_local_from_time_t(PyObject *cls, double ts)
Tim Peters2a799bf2002-12-16 20:18:38 +00002244{
2245 struct tm *tm;
Tim Peters1b6f7a92004-06-20 02:50:16 +00002246 time_t t;
Tim Peters2a799bf2002-12-16 20:18:38 +00002247 PyObject *result = NULL;
2248
Tim Peters1b6f7a92004-06-20 02:50:16 +00002249 t = _PyTime_DoubleToTimet(ts);
2250 if (t == (time_t)-1 && PyErr_Occurred())
2251 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002252 tm = localtime(&t);
2253 if (tm)
2254 result = PyObject_CallFunction(cls, "iii",
2255 tm->tm_year + 1900,
2256 tm->tm_mon + 1,
2257 tm->tm_mday);
2258 else
2259 PyErr_SetString(PyExc_ValueError,
2260 "timestamp out of range for "
2261 "platform localtime() function");
2262 return result;
2263}
2264
2265/* Return new date from current time.
2266 * We say this is equivalent to fromtimestamp(time.time()), and the
2267 * only way to be sure of that is to *call* time.time(). That's not
2268 * generally the same as calling C's time.
2269 */
2270static PyObject *
2271date_today(PyObject *cls, PyObject *dummy)
2272{
2273 PyObject *time;
2274 PyObject *result;
2275
2276 time = time_time();
2277 if (time == NULL)
2278 return NULL;
2279
2280 /* Note well: today() is a class method, so this may not call
2281 * date.fromtimestamp. For example, it may call
2282 * datetime.fromtimestamp. That's why we need all the accuracy
2283 * time.time() delivers; if someone were gonzo about optimization,
2284 * date.today() could get away with plain C time().
2285 */
2286 result = PyObject_CallMethod(cls, "fromtimestamp", "O", time);
2287 Py_DECREF(time);
2288 return result;
2289}
2290
2291/* Return new date from given timestamp (Python timestamp -- a double). */
2292static PyObject *
2293date_fromtimestamp(PyObject *cls, PyObject *args)
2294{
2295 double timestamp;
2296 PyObject *result = NULL;
2297
2298 if (PyArg_ParseTuple(args, "d:fromtimestamp", &timestamp))
Tim Peters1b6f7a92004-06-20 02:50:16 +00002299 result = date_local_from_time_t(cls, timestamp);
Tim Peters2a799bf2002-12-16 20:18:38 +00002300 return result;
2301}
2302
2303/* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2304 * the ordinal is out of range.
2305 */
2306static PyObject *
2307date_fromordinal(PyObject *cls, PyObject *args)
2308{
2309 PyObject *result = NULL;
2310 int ordinal;
2311
2312 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2313 int year;
2314 int month;
2315 int day;
2316
2317 if (ordinal < 1)
2318 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2319 ">= 1");
2320 else {
2321 ord_to_ymd(ordinal, &year, &month, &day);
2322 result = PyObject_CallFunction(cls, "iii",
2323 year, month, day);
2324 }
2325 }
2326 return result;
2327}
2328
2329/*
2330 * Date arithmetic.
2331 */
2332
2333/* date + timedelta -> date. If arg negate is true, subtract the timedelta
2334 * instead.
2335 */
2336static PyObject *
2337add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
2338{
2339 PyObject *result = NULL;
2340 int year = GET_YEAR(date);
2341 int month = GET_MONTH(date);
2342 int deltadays = GET_TD_DAYS(delta);
2343 /* C-level overflow is impossible because |deltadays| < 1e9. */
2344 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
2345
2346 if (normalize_date(&year, &month, &day) >= 0)
2347 result = new_date(year, month, day);
2348 return result;
2349}
2350
2351static PyObject *
2352date_add(PyObject *left, PyObject *right)
2353{
2354 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2355 Py_INCREF(Py_NotImplemented);
2356 return Py_NotImplemented;
2357 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002358 if (PyDate_Check(left)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002359 /* date + ??? */
2360 if (PyDelta_Check(right))
2361 /* date + delta */
2362 return add_date_timedelta((PyDateTime_Date *) left,
2363 (PyDateTime_Delta *) right,
2364 0);
2365 }
2366 else {
2367 /* ??? + date
2368 * 'right' must be one of us, or we wouldn't have been called
2369 */
2370 if (PyDelta_Check(left))
2371 /* delta + date */
2372 return add_date_timedelta((PyDateTime_Date *) right,
2373 (PyDateTime_Delta *) left,
2374 0);
2375 }
2376 Py_INCREF(Py_NotImplemented);
2377 return Py_NotImplemented;
2378}
2379
2380static PyObject *
2381date_subtract(PyObject *left, PyObject *right)
2382{
2383 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2384 Py_INCREF(Py_NotImplemented);
2385 return Py_NotImplemented;
2386 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002387 if (PyDate_Check(left)) {
2388 if (PyDate_Check(right)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002389 /* date - date */
2390 int left_ord = ymd_to_ord(GET_YEAR(left),
2391 GET_MONTH(left),
2392 GET_DAY(left));
2393 int right_ord = ymd_to_ord(GET_YEAR(right),
2394 GET_MONTH(right),
2395 GET_DAY(right));
2396 return new_delta(left_ord - right_ord, 0, 0, 0);
2397 }
2398 if (PyDelta_Check(right)) {
2399 /* date - delta */
2400 return add_date_timedelta((PyDateTime_Date *) left,
2401 (PyDateTime_Delta *) right,
2402 1);
2403 }
2404 }
2405 Py_INCREF(Py_NotImplemented);
2406 return Py_NotImplemented;
2407}
2408
2409
2410/* Various ways to turn a date into a string. */
2411
2412static PyObject *
2413date_repr(PyDateTime_Date *self)
2414{
Walter Dörwald7569dfe2007-05-19 21:49:49 +00002415 return PyUnicode_FromFormat("%s(%d, %d, %d)",
Christian Heimes90aa7642007-12-19 02:45:37 +00002416 Py_TYPE(self)->tp_name,
Walter Dörwald7569dfe2007-05-19 21:49:49 +00002417 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002418}
2419
2420static PyObject *
2421date_isoformat(PyDateTime_Date *self)
2422{
Walter Dörwaldbafa1372007-05-31 17:50:48 +00002423 return PyUnicode_FromFormat("%04d-%02d-%02d",
2424 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002425}
2426
Tim Peterse2df5ff2003-05-02 18:39:55 +00002427/* str() calls the appropriate isoformat() method. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002428static PyObject *
2429date_str(PyDateTime_Date *self)
2430{
2431 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
2432}
2433
2434
2435static PyObject *
2436date_ctime(PyDateTime_Date *self)
2437{
2438 return format_ctime(self, 0, 0, 0);
2439}
2440
2441static PyObject *
2442date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2443{
2444 /* This method can be inherited, and needs to call the
2445 * timetuple() method appropriate to self's class.
2446 */
2447 PyObject *result;
2448 PyObject *format;
2449 PyObject *tuple;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002450 static char *keywords[] = {"format", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00002451
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002452 if (! PyArg_ParseTupleAndKeywords(args, kw, "U:strftime", keywords,
Guido van Rossumbce56a62007-05-10 18:04:33 +00002453 &format))
Tim Peters2a799bf2002-12-16 20:18:38 +00002454 return NULL;
2455
2456 tuple = PyObject_CallMethod((PyObject *)self, "timetuple", "()");
2457 if (tuple == NULL)
2458 return NULL;
Tim Petersbad8ff02002-12-30 20:52:32 +00002459 result = wrap_strftime((PyObject *)self, format, tuple,
2460 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002461 Py_DECREF(tuple);
2462 return result;
2463}
2464
Eric Smith1ba31142007-09-11 18:06:02 +00002465static PyObject *
2466date_format(PyDateTime_Date *self, PyObject *args)
2467{
2468 PyObject *format;
2469
2470 if (!PyArg_ParseTuple(args, "U:__format__", &format))
2471 return NULL;
2472
2473 /* if the format is zero length, return str(self) */
2474 if (PyUnicode_GetSize(format) == 0)
Thomas Heller519a0422007-11-15 20:48:54 +00002475 return PyObject_Str((PyObject *)self);
Eric Smith1ba31142007-09-11 18:06:02 +00002476
2477 return PyObject_CallMethod((PyObject *)self, "strftime", "O", format);
2478}
2479
Tim Peters2a799bf2002-12-16 20:18:38 +00002480/* ISO methods. */
2481
2482static PyObject *
2483date_isoweekday(PyDateTime_Date *self)
2484{
2485 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2486
Christian Heimes217cfd12007-12-02 14:31:20 +00002487 return PyLong_FromLong(dow + 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00002488}
2489
2490static PyObject *
2491date_isocalendar(PyDateTime_Date *self)
2492{
2493 int year = GET_YEAR(self);
2494 int week1_monday = iso_week1_monday(year);
2495 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
2496 int week;
2497 int day;
2498
2499 week = divmod(today - week1_monday, 7, &day);
2500 if (week < 0) {
2501 --year;
2502 week1_monday = iso_week1_monday(year);
2503 week = divmod(today - week1_monday, 7, &day);
2504 }
2505 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
2506 ++year;
2507 week = 0;
2508 }
2509 return Py_BuildValue("iii", year, week + 1, day + 1);
2510}
2511
2512/* Miscellaneous methods. */
2513
Tim Peters2a799bf2002-12-16 20:18:38 +00002514static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00002515date_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters2a799bf2002-12-16 20:18:38 +00002516{
Guido van Rossum19960592006-08-24 17:29:38 +00002517 if (PyDate_Check(other)) {
2518 int diff = memcmp(((PyDateTime_Date *)self)->data,
2519 ((PyDateTime_Date *)other)->data,
2520 _PyDateTime_DATE_DATASIZE);
2521 return diff_to_bool(diff, op);
2522 }
2523 else {
Tim Peters07534a62003-02-07 22:50:28 +00002524 Py_INCREF(Py_NotImplemented);
2525 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002526 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002527}
2528
2529static PyObject *
2530date_timetuple(PyDateTime_Date *self)
2531{
2532 return build_struct_time(GET_YEAR(self),
2533 GET_MONTH(self),
2534 GET_DAY(self),
2535 0, 0, 0, -1);
2536}
2537
Tim Peters12bf3392002-12-24 05:41:27 +00002538static PyObject *
2539date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2540{
2541 PyObject *clone;
2542 PyObject *tuple;
2543 int year = GET_YEAR(self);
2544 int month = GET_MONTH(self);
2545 int day = GET_DAY(self);
2546
2547 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
2548 &year, &month, &day))
2549 return NULL;
2550 tuple = Py_BuildValue("iii", year, month, day);
2551 if (tuple == NULL)
2552 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00002553 clone = date_new(Py_TYPE(self), tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00002554 Py_DECREF(tuple);
2555 return clone;
2556}
2557
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002558/*
2559 Borrowed from stringobject.c, originally it was string_hash()
2560*/
2561static long
2562generic_hash(unsigned char *data, int len)
2563{
2564 register unsigned char *p;
2565 register long x;
2566
2567 p = (unsigned char *) data;
2568 x = *p << 7;
2569 while (--len >= 0)
2570 x = (1000003*x) ^ *p++;
2571 x ^= len;
2572 if (x == -1)
2573 x = -2;
2574
2575 return x;
2576}
2577
2578
2579static PyObject *date_getstate(PyDateTime_Date *self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002580
2581static long
2582date_hash(PyDateTime_Date *self)
2583{
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002584 if (self->hashcode == -1)
2585 self->hashcode = generic_hash(
2586 (unsigned char *)self->data, _PyDateTime_DATE_DATASIZE);
Guido van Rossum254348e2007-11-21 19:29:53 +00002587
Tim Peters2a799bf2002-12-16 20:18:38 +00002588 return self->hashcode;
2589}
2590
2591static PyObject *
2592date_toordinal(PyDateTime_Date *self)
2593{
Christian Heimes217cfd12007-12-02 14:31:20 +00002594 return PyLong_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
Tim Peters2a799bf2002-12-16 20:18:38 +00002595 GET_DAY(self)));
2596}
2597
2598static PyObject *
2599date_weekday(PyDateTime_Date *self)
2600{
2601 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2602
Christian Heimes217cfd12007-12-02 14:31:20 +00002603 return PyLong_FromLong(dow);
Tim Peters2a799bf2002-12-16 20:18:38 +00002604}
2605
Tim Peters371935f2003-02-01 01:52:50 +00002606/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002607
Tim Petersb57f8f02003-02-01 02:54:15 +00002608/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002609static PyObject *
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002610date_getstate(PyDateTime_Date *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00002611{
Martin v. Löwis10a60b32007-07-18 02:28:27 +00002612 PyObject* field;
Guido van Rossum254348e2007-11-21 19:29:53 +00002613 field = PyString_FromStringAndSize((char*)self->data,
2614 _PyDateTime_DATE_DATASIZE);
Martin v. Löwis10a60b32007-07-18 02:28:27 +00002615 return Py_BuildValue("(N)", field);
Tim Peters2a799bf2002-12-16 20:18:38 +00002616}
2617
2618static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00002619date_reduce(PyDateTime_Date *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00002620{
Christian Heimes90aa7642007-12-19 02:45:37 +00002621 return Py_BuildValue("(ON)", Py_TYPE(self), date_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002622}
2623
2624static PyMethodDef date_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002625
Tim Peters2a799bf2002-12-16 20:18:38 +00002626 /* Class methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00002627
Tim Peters2a799bf2002-12-16 20:18:38 +00002628 {"fromtimestamp", (PyCFunction)date_fromtimestamp, METH_VARARGS |
2629 METH_CLASS,
2630 PyDoc_STR("timestamp -> local date from a POSIX timestamp (like "
2631 "time.time()).")},
2632
2633 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
2634 METH_CLASS,
2635 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
2636 "ordinal.")},
2637
2638 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
2639 PyDoc_STR("Current date or datetime: same as "
2640 "self.__class__.fromtimestamp(time.time()).")},
2641
2642 /* Instance methods: */
2643
2644 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
2645 PyDoc_STR("Return ctime() style string.")},
2646
Guido van Rossumd59da4b2007-05-22 18:11:13 +00002647 {"strftime", (PyCFunction)date_strftime, METH_VARARGS | METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00002648 PyDoc_STR("format -> strftime() style string.")},
2649
Eric Smith1ba31142007-09-11 18:06:02 +00002650 {"__format__", (PyCFunction)date_format, METH_VARARGS,
2651 PyDoc_STR("Formats self with strftime.")},
2652
Tim Peters2a799bf2002-12-16 20:18:38 +00002653 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
2654 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
2655
2656 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
2657 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
2658 "weekday.")},
2659
2660 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
2661 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
2662
2663 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
2664 PyDoc_STR("Return the day of the week represented by the date.\n"
2665 "Monday == 1 ... Sunday == 7")},
2666
2667 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
2668 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
2669 "1 is day 1.")},
2670
2671 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
2672 PyDoc_STR("Return the day of the week represented by the date.\n"
2673 "Monday == 0 ... Sunday == 6")},
2674
Guido van Rossumd59da4b2007-05-22 18:11:13 +00002675 {"replace", (PyCFunction)date_replace, METH_VARARGS | METH_KEYWORDS,
Tim Peters12bf3392002-12-24 05:41:27 +00002676 PyDoc_STR("Return date with new specified fields.")},
2677
Guido van Rossum177e41a2003-01-30 22:06:23 +00002678 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
2679 PyDoc_STR("__reduce__() -> (cls, state)")},
2680
Tim Peters2a799bf2002-12-16 20:18:38 +00002681 {NULL, NULL}
2682};
2683
2684static char date_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00002685PyDoc_STR("date(year, month, day) --> date object");
Tim Peters2a799bf2002-12-16 20:18:38 +00002686
2687static PyNumberMethods date_as_number = {
2688 date_add, /* nb_add */
2689 date_subtract, /* nb_subtract */
2690 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00002691 0, /* nb_remainder */
2692 0, /* nb_divmod */
2693 0, /* nb_power */
2694 0, /* nb_negative */
2695 0, /* nb_positive */
2696 0, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +00002697 0, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00002698};
2699
2700static PyTypeObject PyDateTime_DateType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002701 PyVarObject_HEAD_INIT(NULL, 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00002702 "datetime.date", /* tp_name */
2703 sizeof(PyDateTime_Date), /* tp_basicsize */
2704 0, /* tp_itemsize */
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002705 0, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00002706 0, /* tp_print */
2707 0, /* tp_getattr */
2708 0, /* tp_setattr */
2709 0, /* tp_compare */
2710 (reprfunc)date_repr, /* tp_repr */
2711 &date_as_number, /* tp_as_number */
2712 0, /* tp_as_sequence */
2713 0, /* tp_as_mapping */
2714 (hashfunc)date_hash, /* tp_hash */
2715 0, /* tp_call */
2716 (reprfunc)date_str, /* tp_str */
2717 PyObject_GenericGetAttr, /* tp_getattro */
2718 0, /* tp_setattro */
2719 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002720 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00002721 date_doc, /* tp_doc */
2722 0, /* tp_traverse */
2723 0, /* tp_clear */
Guido van Rossum19960592006-08-24 17:29:38 +00002724 date_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00002725 0, /* tp_weaklistoffset */
2726 0, /* tp_iter */
2727 0, /* tp_iternext */
2728 date_methods, /* tp_methods */
2729 0, /* tp_members */
2730 date_getset, /* tp_getset */
2731 0, /* tp_base */
2732 0, /* tp_dict */
2733 0, /* tp_descr_get */
2734 0, /* tp_descr_set */
2735 0, /* tp_dictoffset */
2736 0, /* tp_init */
2737 0, /* tp_alloc */
2738 date_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002739 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002740};
2741
2742/*
Tim Peters2a799bf2002-12-16 20:18:38 +00002743 * PyDateTime_TZInfo implementation.
2744 */
2745
2746/* This is a pure abstract base class, so doesn't do anything beyond
2747 * raising NotImplemented exceptions. Real tzinfo classes need
2748 * to derive from this. This is mostly for clarity, and for efficiency in
Tim Petersa9bc1682003-01-11 03:39:11 +00002749 * datetime and time constructors (their tzinfo arguments need to
Tim Peters2a799bf2002-12-16 20:18:38 +00002750 * be subclasses of this tzinfo class, which is easy and quick to check).
2751 *
2752 * Note: For reasons having to do with pickling of subclasses, we have
2753 * to allow tzinfo objects to be instantiated. This wasn't an issue
2754 * in the Python implementation (__init__() could raise NotImplementedError
2755 * there without ill effect), but doing so in the C implementation hit a
2756 * brick wall.
2757 */
2758
2759static PyObject *
2760tzinfo_nogo(const char* methodname)
2761{
2762 PyErr_Format(PyExc_NotImplementedError,
2763 "a tzinfo subclass must implement %s()",
2764 methodname);
2765 return NULL;
2766}
2767
2768/* Methods. A subclass must implement these. */
2769
Tim Peters52dcce22003-01-23 16:36:11 +00002770static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002771tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
2772{
2773 return tzinfo_nogo("tzname");
2774}
2775
Tim Peters52dcce22003-01-23 16:36:11 +00002776static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002777tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
2778{
2779 return tzinfo_nogo("utcoffset");
2780}
2781
Tim Peters52dcce22003-01-23 16:36:11 +00002782static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002783tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
2784{
2785 return tzinfo_nogo("dst");
2786}
2787
Tim Peters52dcce22003-01-23 16:36:11 +00002788static PyObject *
2789tzinfo_fromutc(PyDateTime_TZInfo *self, PyDateTime_DateTime *dt)
2790{
2791 int y, m, d, hh, mm, ss, us;
2792
2793 PyObject *result;
2794 int off, dst;
2795 int none;
2796 int delta;
2797
2798 if (! PyDateTime_Check(dt)) {
2799 PyErr_SetString(PyExc_TypeError,
2800 "fromutc: argument must be a datetime");
2801 return NULL;
2802 }
2803 if (! HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
2804 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
2805 "is not self");
2806 return NULL;
2807 }
2808
2809 off = call_utcoffset(dt->tzinfo, (PyObject *)dt, &none);
2810 if (off == -1 && PyErr_Occurred())
2811 return NULL;
2812 if (none) {
2813 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2814 "utcoffset() result required");
2815 return NULL;
2816 }
2817
2818 dst = call_dst(dt->tzinfo, (PyObject *)dt, &none);
2819 if (dst == -1 && PyErr_Occurred())
2820 return NULL;
2821 if (none) {
2822 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2823 "dst() result required");
2824 return NULL;
2825 }
2826
2827 y = GET_YEAR(dt);
2828 m = GET_MONTH(dt);
2829 d = GET_DAY(dt);
2830 hh = DATE_GET_HOUR(dt);
2831 mm = DATE_GET_MINUTE(dt);
2832 ss = DATE_GET_SECOND(dt);
2833 us = DATE_GET_MICROSECOND(dt);
2834
2835 delta = off - dst;
2836 mm += delta;
2837 if ((mm < 0 || mm >= 60) &&
2838 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Petersb1049e82003-01-23 17:20:36 +00002839 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00002840 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2841 if (result == NULL)
2842 return result;
2843
2844 dst = call_dst(dt->tzinfo, result, &none);
2845 if (dst == -1 && PyErr_Occurred())
2846 goto Fail;
2847 if (none)
2848 goto Inconsistent;
2849 if (dst == 0)
2850 return result;
2851
2852 mm += dst;
2853 if ((mm < 0 || mm >= 60) &&
2854 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
2855 goto Fail;
2856 Py_DECREF(result);
2857 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2858 return result;
2859
2860Inconsistent:
2861 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave"
2862 "inconsistent results; cannot convert");
2863
2864 /* fall thru to failure */
2865Fail:
2866 Py_DECREF(result);
2867 return NULL;
2868}
2869
Tim Peters2a799bf2002-12-16 20:18:38 +00002870/*
2871 * Pickle support. This is solely so that tzinfo subclasses can use
Guido van Rossum177e41a2003-01-30 22:06:23 +00002872 * pickling -- tzinfo itself is supposed to be uninstantiable.
Tim Peters2a799bf2002-12-16 20:18:38 +00002873 */
2874
Guido van Rossum177e41a2003-01-30 22:06:23 +00002875static PyObject *
2876tzinfo_reduce(PyObject *self)
2877{
2878 PyObject *args, *state, *tmp;
2879 PyObject *getinitargs, *getstate;
Tim Peters2a799bf2002-12-16 20:18:38 +00002880
Guido van Rossum177e41a2003-01-30 22:06:23 +00002881 tmp = PyTuple_New(0);
2882 if (tmp == NULL)
2883 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002884
Guido van Rossum177e41a2003-01-30 22:06:23 +00002885 getinitargs = PyObject_GetAttrString(self, "__getinitargs__");
2886 if (getinitargs != NULL) {
2887 args = PyObject_CallObject(getinitargs, tmp);
2888 Py_DECREF(getinitargs);
2889 if (args == NULL) {
2890 Py_DECREF(tmp);
2891 return NULL;
2892 }
2893 }
2894 else {
2895 PyErr_Clear();
2896 args = tmp;
2897 Py_INCREF(args);
2898 }
2899
2900 getstate = PyObject_GetAttrString(self, "__getstate__");
2901 if (getstate != NULL) {
2902 state = PyObject_CallObject(getstate, tmp);
2903 Py_DECREF(getstate);
2904 if (state == NULL) {
2905 Py_DECREF(args);
2906 Py_DECREF(tmp);
2907 return NULL;
2908 }
2909 }
2910 else {
2911 PyObject **dictptr;
2912 PyErr_Clear();
2913 state = Py_None;
2914 dictptr = _PyObject_GetDictPtr(self);
2915 if (dictptr && *dictptr && PyDict_Size(*dictptr))
2916 state = *dictptr;
2917 Py_INCREF(state);
2918 }
2919
2920 Py_DECREF(tmp);
2921
2922 if (state == Py_None) {
2923 Py_DECREF(state);
Christian Heimes90aa7642007-12-19 02:45:37 +00002924 return Py_BuildValue("(ON)", Py_TYPE(self), args);
Guido van Rossum177e41a2003-01-30 22:06:23 +00002925 }
2926 else
Christian Heimes90aa7642007-12-19 02:45:37 +00002927 return Py_BuildValue("(ONN)", Py_TYPE(self), args, state);
Guido van Rossum177e41a2003-01-30 22:06:23 +00002928}
Tim Peters2a799bf2002-12-16 20:18:38 +00002929
2930static PyMethodDef tzinfo_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002931
Tim Peters2a799bf2002-12-16 20:18:38 +00002932 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
2933 PyDoc_STR("datetime -> string name of time zone.")},
2934
2935 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
2936 PyDoc_STR("datetime -> minutes east of UTC (negative for "
2937 "west of UTC).")},
2938
2939 {"dst", (PyCFunction)tzinfo_dst, METH_O,
2940 PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
2941
Tim Peters52dcce22003-01-23 16:36:11 +00002942 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
2943 PyDoc_STR("datetime in UTC -> datetime in local time.")},
2944
Guido van Rossum177e41a2003-01-30 22:06:23 +00002945 {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
2946 PyDoc_STR("-> (cls, state)")},
2947
Tim Peters2a799bf2002-12-16 20:18:38 +00002948 {NULL, NULL}
2949};
2950
2951static char tzinfo_doc[] =
2952PyDoc_STR("Abstract base class for time zone info objects.");
2953
Neal Norwitz227b5332006-03-22 09:28:35 +00002954static PyTypeObject PyDateTime_TZInfoType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002955 PyVarObject_HEAD_INIT(NULL, 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00002956 "datetime.tzinfo", /* tp_name */
2957 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
2958 0, /* tp_itemsize */
2959 0, /* tp_dealloc */
2960 0, /* tp_print */
2961 0, /* tp_getattr */
2962 0, /* tp_setattr */
2963 0, /* tp_compare */
2964 0, /* tp_repr */
2965 0, /* tp_as_number */
2966 0, /* tp_as_sequence */
2967 0, /* tp_as_mapping */
2968 0, /* tp_hash */
2969 0, /* tp_call */
2970 0, /* tp_str */
2971 PyObject_GenericGetAttr, /* tp_getattro */
2972 0, /* tp_setattro */
2973 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002974 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00002975 tzinfo_doc, /* tp_doc */
2976 0, /* tp_traverse */
2977 0, /* tp_clear */
2978 0, /* tp_richcompare */
2979 0, /* tp_weaklistoffset */
2980 0, /* tp_iter */
2981 0, /* tp_iternext */
2982 tzinfo_methods, /* tp_methods */
2983 0, /* tp_members */
2984 0, /* tp_getset */
2985 0, /* tp_base */
2986 0, /* tp_dict */
2987 0, /* tp_descr_get */
2988 0, /* tp_descr_set */
2989 0, /* tp_dictoffset */
2990 0, /* tp_init */
2991 0, /* tp_alloc */
2992 PyType_GenericNew, /* tp_new */
2993 0, /* tp_free */
2994};
2995
2996/*
Tim Peters37f39822003-01-10 03:49:02 +00002997 * PyDateTime_Time implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00002998 */
2999
Tim Peters37f39822003-01-10 03:49:02 +00003000/* Accessor properties.
Tim Peters2a799bf2002-12-16 20:18:38 +00003001 */
3002
3003static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003004time_hour(PyDateTime_Time *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003005{
Christian Heimes217cfd12007-12-02 14:31:20 +00003006 return PyLong_FromLong(TIME_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003007}
3008
Tim Peters37f39822003-01-10 03:49:02 +00003009static PyObject *
3010time_minute(PyDateTime_Time *self, void *unused)
3011{
Christian Heimes217cfd12007-12-02 14:31:20 +00003012 return PyLong_FromLong(TIME_GET_MINUTE(self));
Tim Peters37f39822003-01-10 03:49:02 +00003013}
3014
3015/* The name time_second conflicted with some platform header file. */
3016static PyObject *
3017py_time_second(PyDateTime_Time *self, void *unused)
3018{
Christian Heimes217cfd12007-12-02 14:31:20 +00003019 return PyLong_FromLong(TIME_GET_SECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003020}
3021
3022static PyObject *
3023time_microsecond(PyDateTime_Time *self, void *unused)
3024{
Christian Heimes217cfd12007-12-02 14:31:20 +00003025 return PyLong_FromLong(TIME_GET_MICROSECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003026}
3027
3028static PyObject *
3029time_tzinfo(PyDateTime_Time *self, void *unused)
3030{
Tim Petersa032d2e2003-01-11 00:15:54 +00003031 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters37f39822003-01-10 03:49:02 +00003032 Py_INCREF(result);
3033 return result;
3034}
3035
3036static PyGetSetDef time_getset[] = {
3037 {"hour", (getter)time_hour},
3038 {"minute", (getter)time_minute},
3039 {"second", (getter)py_time_second},
3040 {"microsecond", (getter)time_microsecond},
3041 {"tzinfo", (getter)time_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003042 {NULL}
3043};
3044
3045/*
3046 * Constructors.
3047 */
3048
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003049static char *time_kws[] = {"hour", "minute", "second", "microsecond",
Tim Peters37f39822003-01-10 03:49:02 +00003050 "tzinfo", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00003051
Tim Peters2a799bf2002-12-16 20:18:38 +00003052static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003053time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003054{
3055 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003056 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003057 int hour = 0;
3058 int minute = 0;
3059 int second = 0;
3060 int usecond = 0;
3061 PyObject *tzinfo = Py_None;
3062
Guido van Rossum177e41a2003-01-30 22:06:23 +00003063 /* Check for invocation from pickle with __getstate__ state */
3064 if (PyTuple_GET_SIZE(args) >= 1 &&
3065 PyTuple_GET_SIZE(args) <= 2 &&
Guido van Rossum254348e2007-11-21 19:29:53 +00003066 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
3067 PyString_GET_SIZE(state) == _PyDateTime_TIME_DATASIZE &&
3068 ((unsigned char) (PyString_AS_STRING(state)[0])) < 24)
Guido van Rossum177e41a2003-01-30 22:06:23 +00003069 {
Tim Peters70533e22003-02-01 04:40:04 +00003070 PyDateTime_Time *me;
3071 char aware;
3072
3073 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003074 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003075 if (check_tzinfo_subclass(tzinfo) < 0) {
3076 PyErr_SetString(PyExc_TypeError, "bad "
3077 "tzinfo state arg");
3078 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003079 }
3080 }
Tim Peters70533e22003-02-01 04:40:04 +00003081 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003082 me = (PyDateTime_Time *) (type->tp_alloc(type, aware));
Tim Peters70533e22003-02-01 04:40:04 +00003083 if (me != NULL) {
Guido van Rossum254348e2007-11-21 19:29:53 +00003084 char *pdata = PyString_AS_STRING(state);
Tim Peters70533e22003-02-01 04:40:04 +00003085
3086 memcpy(me->data, pdata, _PyDateTime_TIME_DATASIZE);
3087 me->hashcode = -1;
3088 me->hastzinfo = aware;
3089 if (aware) {
3090 Py_INCREF(tzinfo);
3091 me->tzinfo = tzinfo;
3092 }
3093 }
3094 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003095 }
3096
Tim Peters37f39822003-01-10 03:49:02 +00003097 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO", time_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003098 &hour, &minute, &second, &usecond,
3099 &tzinfo)) {
3100 if (check_time_args(hour, minute, second, usecond) < 0)
3101 return NULL;
3102 if (check_tzinfo_subclass(tzinfo) < 0)
3103 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003104 self = new_time_ex(hour, minute, second, usecond, tzinfo,
3105 type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003106 }
3107 return self;
3108}
3109
3110/*
3111 * Destructor.
3112 */
3113
3114static void
Tim Peters37f39822003-01-10 03:49:02 +00003115time_dealloc(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003116{
Tim Petersa032d2e2003-01-11 00:15:54 +00003117 if (HASTZINFO(self)) {
Tim Peters37f39822003-01-10 03:49:02 +00003118 Py_XDECREF(self->tzinfo);
Neal Norwitz8e914d92003-01-10 15:29:16 +00003119 }
Christian Heimes90aa7642007-12-19 02:45:37 +00003120 Py_TYPE(self)->tp_free((PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003121}
3122
3123/*
Tim Peters855fe882002-12-22 03:43:39 +00003124 * Indirect access to tzinfo methods.
Tim Peters2a799bf2002-12-16 20:18:38 +00003125 */
3126
Tim Peters2a799bf2002-12-16 20:18:38 +00003127/* These are all METH_NOARGS, so don't need to check the arglist. */
3128static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003129time_utcoffset(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003130 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003131 "utcoffset", Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003132}
3133
3134static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003135time_dst(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003136 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003137 "dst", Py_None);
Tim Peters855fe882002-12-22 03:43:39 +00003138}
3139
3140static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003141time_tzname(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003142 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003143 Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003144}
3145
3146/*
Tim Peters37f39822003-01-10 03:49:02 +00003147 * Various ways to turn a time into a string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003148 */
3149
3150static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003151time_repr(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003152{
Christian Heimes90aa7642007-12-19 02:45:37 +00003153 const char *type_name = Py_TYPE(self)->tp_name;
Tim Peters37f39822003-01-10 03:49:02 +00003154 int h = TIME_GET_HOUR(self);
3155 int m = TIME_GET_MINUTE(self);
3156 int s = TIME_GET_SECOND(self);
3157 int us = TIME_GET_MICROSECOND(self);
3158 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003159
Tim Peters37f39822003-01-10 03:49:02 +00003160 if (us)
Walter Dörwald7569dfe2007-05-19 21:49:49 +00003161 result = PyUnicode_FromFormat("%s(%d, %d, %d, %d)",
3162 type_name, h, m, s, us);
Tim Peters37f39822003-01-10 03:49:02 +00003163 else if (s)
Walter Dörwald7569dfe2007-05-19 21:49:49 +00003164 result = PyUnicode_FromFormat("%s(%d, %d, %d)",
3165 type_name, h, m, s);
Tim Peters37f39822003-01-10 03:49:02 +00003166 else
Walter Dörwald7569dfe2007-05-19 21:49:49 +00003167 result = PyUnicode_FromFormat("%s(%d, %d)", type_name, h, m);
Tim Petersa032d2e2003-01-11 00:15:54 +00003168 if (result != NULL && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +00003169 result = append_keyword_tzinfo(result, self->tzinfo);
3170 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003171}
3172
Tim Peters37f39822003-01-10 03:49:02 +00003173static PyObject *
3174time_str(PyDateTime_Time *self)
3175{
3176 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
3177}
Tim Peters2a799bf2002-12-16 20:18:38 +00003178
3179static PyObject *
Thomas Wouterscf297e42007-02-23 15:07:44 +00003180time_isoformat(PyDateTime_Time *self, PyObject *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003181{
3182 char buf[100];
Tim Peters37f39822003-01-10 03:49:02 +00003183 PyObject *result;
Walter Dörwaldbafa1372007-05-31 17:50:48 +00003184 int us = TIME_GET_MICROSECOND(self);;
Tim Peters2a799bf2002-12-16 20:18:38 +00003185
Walter Dörwaldbafa1372007-05-31 17:50:48 +00003186 if (us)
3187 result = PyUnicode_FromFormat("%02d:%02d:%02d.%06d",
3188 TIME_GET_HOUR(self),
3189 TIME_GET_MINUTE(self),
3190 TIME_GET_SECOND(self),
3191 us);
3192 else
3193 result = PyUnicode_FromFormat("%02d:%02d:%02d",
3194 TIME_GET_HOUR(self),
3195 TIME_GET_MINUTE(self),
3196 TIME_GET_SECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003197
Tim Petersa032d2e2003-01-11 00:15:54 +00003198 if (result == NULL || ! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00003199 return result;
3200
3201 /* We need to append the UTC offset. */
3202 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00003203 Py_None) < 0) {
Tim Peters2a799bf2002-12-16 20:18:38 +00003204 Py_DECREF(result);
3205 return NULL;
3206 }
Walter Dörwaldbafa1372007-05-31 17:50:48 +00003207 PyUnicode_AppendAndDel(&result, PyUnicode_FromString(buf));
Tim Peters2a799bf2002-12-16 20:18:38 +00003208 return result;
3209}
3210
Tim Peters37f39822003-01-10 03:49:02 +00003211static PyObject *
3212time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3213{
3214 PyObject *result;
3215 PyObject *format;
3216 PyObject *tuple;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003217 static char *keywords[] = {"format", NULL};
Tim Peters37f39822003-01-10 03:49:02 +00003218
Guido van Rossum98297ee2007-11-06 21:34:58 +00003219 if (! PyArg_ParseTupleAndKeywords(args, kw, "U:strftime", keywords,
Guido van Rossumbce56a62007-05-10 18:04:33 +00003220 &format))
Tim Peters37f39822003-01-10 03:49:02 +00003221 return NULL;
3222
3223 /* Python's strftime does insane things with the year part of the
3224 * timetuple. The year is forced to (the otherwise nonsensical)
3225 * 1900 to worm around that.
3226 */
3227 tuple = Py_BuildValue("iiiiiiiii",
Brett Cannond1080a32004-03-02 04:38:10 +00003228 1900, 1, 1, /* year, month, day */
Tim Peters37f39822003-01-10 03:49:02 +00003229 TIME_GET_HOUR(self),
3230 TIME_GET_MINUTE(self),
3231 TIME_GET_SECOND(self),
Brett Cannond1080a32004-03-02 04:38:10 +00003232 0, 1, -1); /* weekday, daynum, dst */
Tim Peters37f39822003-01-10 03:49:02 +00003233 if (tuple == NULL)
3234 return NULL;
3235 assert(PyTuple_Size(tuple) == 9);
3236 result = wrap_strftime((PyObject *)self, format, tuple, Py_None);
3237 Py_DECREF(tuple);
3238 return result;
3239}
Tim Peters2a799bf2002-12-16 20:18:38 +00003240
3241/*
3242 * Miscellaneous methods.
3243 */
3244
Tim Peters37f39822003-01-10 03:49:02 +00003245static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00003246time_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters37f39822003-01-10 03:49:02 +00003247{
3248 int diff;
3249 naivety n1, n2;
3250 int offset1, offset2;
3251
3252 if (! PyTime_Check(other)) {
Guido van Rossum19960592006-08-24 17:29:38 +00003253 Py_INCREF(Py_NotImplemented);
3254 return Py_NotImplemented;
Tim Peters37f39822003-01-10 03:49:02 +00003255 }
Guido van Rossum19960592006-08-24 17:29:38 +00003256 if (classify_two_utcoffsets(self, &offset1, &n1, Py_None,
3257 other, &offset2, &n2, Py_None) < 0)
Tim Peters37f39822003-01-10 03:49:02 +00003258 return NULL;
3259 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
3260 /* If they're both naive, or both aware and have the same offsets,
3261 * we get off cheap. Note that if they're both naive, offset1 ==
3262 * offset2 == 0 at this point.
3263 */
3264 if (n1 == n2 && offset1 == offset2) {
Guido van Rossum19960592006-08-24 17:29:38 +00003265 diff = memcmp(((PyDateTime_Time *)self)->data,
3266 ((PyDateTime_Time *)other)->data,
Tim Peters37f39822003-01-10 03:49:02 +00003267 _PyDateTime_TIME_DATASIZE);
3268 return diff_to_bool(diff, op);
3269 }
3270
3271 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
3272 assert(offset1 != offset2); /* else last "if" handled it */
3273 /* Convert everything except microseconds to seconds. These
3274 * can't overflow (no more than the # of seconds in 2 days).
3275 */
3276 offset1 = TIME_GET_HOUR(self) * 3600 +
3277 (TIME_GET_MINUTE(self) - offset1) * 60 +
3278 TIME_GET_SECOND(self);
3279 offset2 = TIME_GET_HOUR(other) * 3600 +
3280 (TIME_GET_MINUTE(other) - offset2) * 60 +
3281 TIME_GET_SECOND(other);
3282 diff = offset1 - offset2;
3283 if (diff == 0)
3284 diff = TIME_GET_MICROSECOND(self) -
3285 TIME_GET_MICROSECOND(other);
3286 return diff_to_bool(diff, op);
3287 }
3288
3289 assert(n1 != n2);
3290 PyErr_SetString(PyExc_TypeError,
3291 "can't compare offset-naive and "
3292 "offset-aware times");
3293 return NULL;
3294}
3295
3296static long
3297time_hash(PyDateTime_Time *self)
3298{
3299 if (self->hashcode == -1) {
3300 naivety n;
3301 int offset;
3302 PyObject *temp;
3303
3304 n = classify_utcoffset((PyObject *)self, Py_None, &offset);
3305 assert(n != OFFSET_UNKNOWN);
3306 if (n == OFFSET_ERROR)
3307 return -1;
3308
3309 /* Reduce this to a hash of another object. */
Guido van Rossumfd53fd62007-08-24 04:05:13 +00003310 if (offset == 0) {
3311 self->hashcode = generic_hash(
3312 (unsigned char *)self->data, _PyDateTime_TIME_DATASIZE);
3313 return self->hashcode;
3314 }
Tim Peters37f39822003-01-10 03:49:02 +00003315 else {
3316 int hour;
3317 int minute;
3318
3319 assert(n == OFFSET_AWARE);
Tim Petersa032d2e2003-01-11 00:15:54 +00003320 assert(HASTZINFO(self));
Tim Peters37f39822003-01-10 03:49:02 +00003321 hour = divmod(TIME_GET_HOUR(self) * 60 +
3322 TIME_GET_MINUTE(self) - offset,
3323 60,
3324 &minute);
3325 if (0 <= hour && hour < 24)
3326 temp = new_time(hour, minute,
3327 TIME_GET_SECOND(self),
3328 TIME_GET_MICROSECOND(self),
3329 Py_None);
3330 else
3331 temp = Py_BuildValue("iiii",
3332 hour, minute,
3333 TIME_GET_SECOND(self),
3334 TIME_GET_MICROSECOND(self));
3335 }
3336 if (temp != NULL) {
3337 self->hashcode = PyObject_Hash(temp);
3338 Py_DECREF(temp);
3339 }
3340 }
3341 return self->hashcode;
3342}
Tim Peters2a799bf2002-12-16 20:18:38 +00003343
Tim Peters12bf3392002-12-24 05:41:27 +00003344static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003345time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00003346{
3347 PyObject *clone;
3348 PyObject *tuple;
3349 int hh = TIME_GET_HOUR(self);
3350 int mm = TIME_GET_MINUTE(self);
3351 int ss = TIME_GET_SECOND(self);
3352 int us = TIME_GET_MICROSECOND(self);
Tim Petersa032d2e2003-01-11 00:15:54 +00003353 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00003354
3355 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO:replace",
Tim Peters37f39822003-01-10 03:49:02 +00003356 time_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00003357 &hh, &mm, &ss, &us, &tzinfo))
3358 return NULL;
3359 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
3360 if (tuple == NULL)
3361 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00003362 clone = time_new(Py_TYPE(self), tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00003363 Py_DECREF(tuple);
3364 return clone;
3365}
3366
Tim Peters2a799bf2002-12-16 20:18:38 +00003367static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00003368time_bool(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003369{
3370 int offset;
3371 int none;
3372
3373 if (TIME_GET_SECOND(self) || TIME_GET_MICROSECOND(self)) {
3374 /* Since utcoffset is in whole minutes, nothing can
3375 * alter the conclusion that this is nonzero.
3376 */
3377 return 1;
3378 }
3379 offset = 0;
Tim Petersa032d2e2003-01-11 00:15:54 +00003380 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Petersbad8ff02002-12-30 20:52:32 +00003381 offset = call_utcoffset(self->tzinfo, Py_None, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00003382 if (offset == -1 && PyErr_Occurred())
3383 return -1;
3384 }
3385 return (TIME_GET_MINUTE(self) - offset + TIME_GET_HOUR(self)*60) != 0;
3386}
3387
Tim Peters371935f2003-02-01 01:52:50 +00003388/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003389
Tim Peters33e0f382003-01-10 02:05:14 +00003390/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003391 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
3392 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00003393 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00003394 */
3395static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003396time_getstate(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003397{
3398 PyObject *basestate;
3399 PyObject *result = NULL;
3400
Guido van Rossum254348e2007-11-21 19:29:53 +00003401 basestate = PyString_FromStringAndSize((char *)self->data,
Tim Peters33e0f382003-01-10 02:05:14 +00003402 _PyDateTime_TIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00003403 if (basestate != NULL) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003404 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003405 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00003406 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003407 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00003408 Py_DECREF(basestate);
3409 }
3410 return result;
3411}
3412
3413static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00003414time_reduce(PyDateTime_Time *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00003415{
Christian Heimes90aa7642007-12-19 02:45:37 +00003416 return Py_BuildValue("(ON)", Py_TYPE(self), time_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003417}
3418
Tim Peters37f39822003-01-10 03:49:02 +00003419static PyMethodDef time_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003420
Thomas Wouterscf297e42007-02-23 15:07:44 +00003421 {"isoformat", (PyCFunction)time_isoformat, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003422 PyDoc_STR("Return string in ISO 8601 format, HH:MM:SS[.mmmmmm]"
3423 "[+HH:MM].")},
3424
Guido van Rossumd59da4b2007-05-22 18:11:13 +00003425 {"strftime", (PyCFunction)time_strftime, METH_VARARGS | METH_KEYWORDS,
Tim Peters37f39822003-01-10 03:49:02 +00003426 PyDoc_STR("format -> strftime() style string.")},
3427
Eric Smith8fd3eba2008-02-17 19:48:00 +00003428 {"__format__", (PyCFunction)date_format, METH_VARARGS,
Eric Smith1ba31142007-09-11 18:06:02 +00003429 PyDoc_STR("Formats self with strftime.")},
3430
Tim Peters37f39822003-01-10 03:49:02 +00003431 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003432 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
3433
Tim Peters37f39822003-01-10 03:49:02 +00003434 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003435 PyDoc_STR("Return self.tzinfo.tzname(self).")},
3436
Tim Peters37f39822003-01-10 03:49:02 +00003437 {"dst", (PyCFunction)time_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003438 PyDoc_STR("Return self.tzinfo.dst(self).")},
3439
Guido van Rossumd59da4b2007-05-22 18:11:13 +00003440 {"replace", (PyCFunction)time_replace, METH_VARARGS | METH_KEYWORDS,
Tim Peters37f39822003-01-10 03:49:02 +00003441 PyDoc_STR("Return time with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00003442
Guido van Rossum177e41a2003-01-30 22:06:23 +00003443 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
3444 PyDoc_STR("__reduce__() -> (cls, state)")},
3445
Tim Peters2a799bf2002-12-16 20:18:38 +00003446 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003447};
3448
Tim Peters37f39822003-01-10 03:49:02 +00003449static char time_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00003450PyDoc_STR("time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object\n\
3451\n\
3452All arguments are optional. tzinfo may be None, or an instance of\n\
3453a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00003454
Tim Peters37f39822003-01-10 03:49:02 +00003455static PyNumberMethods time_as_number = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003456 0, /* nb_add */
3457 0, /* nb_subtract */
3458 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00003459 0, /* nb_remainder */
3460 0, /* nb_divmod */
3461 0, /* nb_power */
3462 0, /* nb_negative */
3463 0, /* nb_positive */
3464 0, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +00003465 (inquiry)time_bool, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00003466};
3467
Neal Norwitz227b5332006-03-22 09:28:35 +00003468static PyTypeObject PyDateTime_TimeType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003469 PyVarObject_HEAD_INIT(NULL, 0)
Tim Peters0bf60bd2003-01-08 20:40:01 +00003470 "datetime.time", /* tp_name */
Tim Peters37f39822003-01-10 03:49:02 +00003471 sizeof(PyDateTime_Time), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00003472 0, /* tp_itemsize */
Tim Peters37f39822003-01-10 03:49:02 +00003473 (destructor)time_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003474 0, /* tp_print */
3475 0, /* tp_getattr */
3476 0, /* tp_setattr */
3477 0, /* tp_compare */
Tim Peters37f39822003-01-10 03:49:02 +00003478 (reprfunc)time_repr, /* tp_repr */
3479 &time_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00003480 0, /* tp_as_sequence */
3481 0, /* tp_as_mapping */
Tim Peters37f39822003-01-10 03:49:02 +00003482 (hashfunc)time_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00003483 0, /* tp_call */
Tim Peters37f39822003-01-10 03:49:02 +00003484 (reprfunc)time_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00003485 PyObject_GenericGetAttr, /* tp_getattro */
3486 0, /* tp_setattro */
3487 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00003488 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters37f39822003-01-10 03:49:02 +00003489 time_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003490 0, /* tp_traverse */
3491 0, /* tp_clear */
Guido van Rossum19960592006-08-24 17:29:38 +00003492 time_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00003493 0, /* tp_weaklistoffset */
3494 0, /* tp_iter */
3495 0, /* tp_iternext */
Tim Peters37f39822003-01-10 03:49:02 +00003496 time_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00003497 0, /* tp_members */
Tim Peters37f39822003-01-10 03:49:02 +00003498 time_getset, /* tp_getset */
3499 0, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00003500 0, /* tp_dict */
3501 0, /* tp_descr_get */
3502 0, /* tp_descr_set */
3503 0, /* tp_dictoffset */
3504 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00003505 time_alloc, /* tp_alloc */
Tim Peters37f39822003-01-10 03:49:02 +00003506 time_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00003507 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00003508};
3509
3510/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003511 * PyDateTime_DateTime implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003512 */
3513
Tim Petersa9bc1682003-01-11 03:39:11 +00003514/* Accessor properties. Properties for day, month, and year are inherited
3515 * from date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003516 */
3517
3518static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003519datetime_hour(PyDateTime_DateTime *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003520{
Christian Heimes217cfd12007-12-02 14:31:20 +00003521 return PyLong_FromLong(DATE_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003522}
3523
Tim Petersa9bc1682003-01-11 03:39:11 +00003524static PyObject *
3525datetime_minute(PyDateTime_DateTime *self, void *unused)
3526{
Christian Heimes217cfd12007-12-02 14:31:20 +00003527 return PyLong_FromLong(DATE_GET_MINUTE(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00003528}
3529
3530static PyObject *
3531datetime_second(PyDateTime_DateTime *self, void *unused)
3532{
Christian Heimes217cfd12007-12-02 14:31:20 +00003533 return PyLong_FromLong(DATE_GET_SECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00003534}
3535
3536static PyObject *
3537datetime_microsecond(PyDateTime_DateTime *self, void *unused)
3538{
Christian Heimes217cfd12007-12-02 14:31:20 +00003539 return PyLong_FromLong(DATE_GET_MICROSECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00003540}
3541
3542static PyObject *
3543datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
3544{
3545 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3546 Py_INCREF(result);
3547 return result;
3548}
3549
3550static PyGetSetDef datetime_getset[] = {
3551 {"hour", (getter)datetime_hour},
3552 {"minute", (getter)datetime_minute},
3553 {"second", (getter)datetime_second},
3554 {"microsecond", (getter)datetime_microsecond},
3555 {"tzinfo", (getter)datetime_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003556 {NULL}
3557};
3558
3559/*
3560 * Constructors.
Tim Peters2a799bf2002-12-16 20:18:38 +00003561 */
3562
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003563static char *datetime_kws[] = {
Tim Peters12bf3392002-12-24 05:41:27 +00003564 "year", "month", "day", "hour", "minute", "second",
3565 "microsecond", "tzinfo", NULL
3566};
3567
Tim Peters2a799bf2002-12-16 20:18:38 +00003568static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003569datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003570{
3571 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003572 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003573 int year;
3574 int month;
3575 int day;
3576 int hour = 0;
3577 int minute = 0;
3578 int second = 0;
3579 int usecond = 0;
3580 PyObject *tzinfo = Py_None;
3581
Guido van Rossum177e41a2003-01-30 22:06:23 +00003582 /* Check for invocation from pickle with __getstate__ state */
3583 if (PyTuple_GET_SIZE(args) >= 1 &&
3584 PyTuple_GET_SIZE(args) <= 2 &&
Guido van Rossum254348e2007-11-21 19:29:53 +00003585 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
3586 PyString_GET_SIZE(state) == _PyDateTime_DATETIME_DATASIZE &&
3587 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00003588 {
Tim Peters70533e22003-02-01 04:40:04 +00003589 PyDateTime_DateTime *me;
3590 char aware;
3591
3592 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003593 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003594 if (check_tzinfo_subclass(tzinfo) < 0) {
3595 PyErr_SetString(PyExc_TypeError, "bad "
3596 "tzinfo state arg");
3597 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003598 }
3599 }
Tim Peters70533e22003-02-01 04:40:04 +00003600 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003601 me = (PyDateTime_DateTime *) (type->tp_alloc(type , aware));
Tim Peters70533e22003-02-01 04:40:04 +00003602 if (me != NULL) {
Guido van Rossum254348e2007-11-21 19:29:53 +00003603 char *pdata = PyString_AS_STRING(state);
Tim Peters70533e22003-02-01 04:40:04 +00003604
3605 memcpy(me->data, pdata, _PyDateTime_DATETIME_DATASIZE);
3606 me->hashcode = -1;
3607 me->hastzinfo = aware;
3608 if (aware) {
3609 Py_INCREF(tzinfo);
3610 me->tzinfo = tzinfo;
3611 }
3612 }
3613 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003614 }
3615
Tim Petersa9bc1682003-01-11 03:39:11 +00003616 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO", datetime_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003617 &year, &month, &day, &hour, &minute,
3618 &second, &usecond, &tzinfo)) {
3619 if (check_date_args(year, month, day) < 0)
3620 return NULL;
3621 if (check_time_args(hour, minute, second, usecond) < 0)
3622 return NULL;
3623 if (check_tzinfo_subclass(tzinfo) < 0)
3624 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003625 self = new_datetime_ex(year, month, day,
3626 hour, minute, second, usecond,
3627 tzinfo, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003628 }
3629 return self;
3630}
3631
Tim Petersa9bc1682003-01-11 03:39:11 +00003632/* TM_FUNC is the shared type of localtime() and gmtime(). */
3633typedef struct tm *(*TM_FUNC)(const time_t *timer);
3634
3635/* Internal helper.
3636 * Build datetime from a time_t and a distinct count of microseconds.
3637 * Pass localtime or gmtime for f, to control the interpretation of timet.
3638 */
3639static PyObject *
3640datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
3641 PyObject *tzinfo)
3642{
3643 struct tm *tm;
3644 PyObject *result = NULL;
3645
3646 tm = f(&timet);
3647 if (tm) {
3648 /* The platform localtime/gmtime may insert leap seconds,
3649 * indicated by tm->tm_sec > 59. We don't care about them,
3650 * except to the extent that passing them on to the datetime
3651 * constructor would raise ValueError for a reason that
3652 * made no sense to the user.
3653 */
3654 if (tm->tm_sec > 59)
3655 tm->tm_sec = 59;
3656 result = PyObject_CallFunction(cls, "iiiiiiiO",
3657 tm->tm_year + 1900,
3658 tm->tm_mon + 1,
3659 tm->tm_mday,
3660 tm->tm_hour,
3661 tm->tm_min,
3662 tm->tm_sec,
3663 us,
3664 tzinfo);
3665 }
3666 else
3667 PyErr_SetString(PyExc_ValueError,
3668 "timestamp out of range for "
3669 "platform localtime()/gmtime() function");
3670 return result;
3671}
3672
3673/* Internal helper.
3674 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
3675 * to control the interpretation of the timestamp. Since a double doesn't
3676 * have enough bits to cover a datetime's full range of precision, it's
3677 * better to call datetime_from_timet_and_us provided you have a way
3678 * to get that much precision (e.g., C time() isn't good enough).
3679 */
3680static PyObject *
3681datetime_from_timestamp(PyObject *cls, TM_FUNC f, double timestamp,
3682 PyObject *tzinfo)
3683{
Tim Peters1b6f7a92004-06-20 02:50:16 +00003684 time_t timet;
3685 double fraction;
3686 int us;
Tim Petersa9bc1682003-01-11 03:39:11 +00003687
Tim Peters1b6f7a92004-06-20 02:50:16 +00003688 timet = _PyTime_DoubleToTimet(timestamp);
3689 if (timet == (time_t)-1 && PyErr_Occurred())
3690 return NULL;
3691 fraction = timestamp - (double)timet;
3692 us = (int)round_to_long(fraction * 1e6);
Guido van Rossumd8faa362007-04-27 19:54:29 +00003693 if (us < 0) {
3694 /* Truncation towards zero is not what we wanted
3695 for negative numbers (Python's mod semantics) */
3696 timet -= 1;
3697 us += 1000000;
3698 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00003699 /* If timestamp is less than one microsecond smaller than a
3700 * full second, round up. Otherwise, ValueErrors are raised
3701 * for some floats. */
3702 if (us == 1000000) {
3703 timet += 1;
3704 us = 0;
3705 }
Tim Petersa9bc1682003-01-11 03:39:11 +00003706 return datetime_from_timet_and_us(cls, f, timet, us, tzinfo);
3707}
3708
3709/* Internal helper.
3710 * Build most accurate possible datetime for current time. Pass localtime or
3711 * gmtime for f as appropriate.
3712 */
3713static PyObject *
3714datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
3715{
3716#ifdef HAVE_GETTIMEOFDAY
3717 struct timeval t;
3718
3719#ifdef GETTIMEOFDAY_NO_TZ
3720 gettimeofday(&t);
3721#else
3722 gettimeofday(&t, (struct timezone *)NULL);
3723#endif
3724 return datetime_from_timet_and_us(cls, f, t.tv_sec, (int)t.tv_usec,
3725 tzinfo);
3726
3727#else /* ! HAVE_GETTIMEOFDAY */
3728 /* No flavor of gettimeofday exists on this platform. Python's
3729 * time.time() does a lot of other platform tricks to get the
3730 * best time it can on the platform, and we're not going to do
3731 * better than that (if we could, the better code would belong
3732 * in time.time()!) We're limited by the precision of a double,
3733 * though.
3734 */
3735 PyObject *time;
3736 double dtime;
3737
3738 time = time_time();
3739 if (time == NULL)
3740 return NULL;
3741 dtime = PyFloat_AsDouble(time);
3742 Py_DECREF(time);
3743 if (dtime == -1.0 && PyErr_Occurred())
3744 return NULL;
3745 return datetime_from_timestamp(cls, f, dtime, tzinfo);
3746#endif /* ! HAVE_GETTIMEOFDAY */
3747}
3748
Tim Peters2a799bf2002-12-16 20:18:38 +00003749/* Return best possible local time -- this isn't constrained by the
3750 * precision of a timestamp.
3751 */
3752static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003753datetime_now(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003754{
Tim Peters10cadce2003-01-23 19:58:02 +00003755 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003756 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003757 static char *keywords[] = {"tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003758
Tim Peters10cadce2003-01-23 19:58:02 +00003759 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:now", keywords,
3760 &tzinfo))
3761 return NULL;
3762 if (check_tzinfo_subclass(tzinfo) < 0)
3763 return NULL;
3764
3765 self = datetime_best_possible(cls,
3766 tzinfo == Py_None ? localtime : gmtime,
3767 tzinfo);
3768 if (self != NULL && tzinfo != Py_None) {
3769 /* Convert UTC to tzinfo's zone. */
3770 PyObject *temp = self;
Tim Peters2a44a8d2003-01-23 20:53:10 +00003771 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
Tim Peters10cadce2003-01-23 19:58:02 +00003772 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003773 }
3774 return self;
3775}
3776
Tim Petersa9bc1682003-01-11 03:39:11 +00003777/* Return best possible UTC time -- this isn't constrained by the
3778 * precision of a timestamp.
3779 */
3780static PyObject *
3781datetime_utcnow(PyObject *cls, PyObject *dummy)
3782{
3783 return datetime_best_possible(cls, gmtime, Py_None);
3784}
3785
Tim Peters2a799bf2002-12-16 20:18:38 +00003786/* Return new local datetime from timestamp (Python timestamp -- a double). */
3787static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003788datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003789{
Tim Peters2a44a8d2003-01-23 20:53:10 +00003790 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003791 double timestamp;
3792 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003793 static char *keywords[] = {"timestamp", "tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003794
Tim Peters2a44a8d2003-01-23 20:53:10 +00003795 if (! PyArg_ParseTupleAndKeywords(args, kw, "d|O:fromtimestamp",
3796 keywords, &timestamp, &tzinfo))
3797 return NULL;
3798 if (check_tzinfo_subclass(tzinfo) < 0)
3799 return NULL;
3800
3801 self = datetime_from_timestamp(cls,
3802 tzinfo == Py_None ? localtime : gmtime,
3803 timestamp,
3804 tzinfo);
3805 if (self != NULL && tzinfo != Py_None) {
3806 /* Convert UTC to tzinfo's zone. */
3807 PyObject *temp = self;
3808 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3809 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003810 }
3811 return self;
3812}
3813
Tim Petersa9bc1682003-01-11 03:39:11 +00003814/* Return new UTC datetime from timestamp (Python timestamp -- a double). */
3815static PyObject *
3816datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
3817{
3818 double timestamp;
3819 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003820
Tim Petersa9bc1682003-01-11 03:39:11 +00003821 if (PyArg_ParseTuple(args, "d:utcfromtimestamp", &timestamp))
3822 result = datetime_from_timestamp(cls, gmtime, timestamp,
3823 Py_None);
3824 return result;
3825}
3826
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003827/* Return new datetime from time.strptime(). */
3828static PyObject *
3829datetime_strptime(PyObject *cls, PyObject *args)
3830{
Christian Heimesdd15f6c2008-03-16 00:07:10 +00003831 static PyObject *module = NULL;
3832 PyObject *result = NULL, *obj, *st = NULL, *frac = NULL;
Guido van Rossume8a17aa2007-08-29 17:28:42 +00003833 const Py_UNICODE *string, *format;
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003834
Guido van Rossumfd53fd62007-08-24 04:05:13 +00003835 if (!PyArg_ParseTuple(args, "uu:strptime", &string, &format))
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003836 return NULL;
3837
Christian Heimesdd15f6c2008-03-16 00:07:10 +00003838 if (module == NULL &&
3839 (module = PyImport_ImportModuleNoBlock("_strptime")) == NULL)
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003840 return NULL;
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003841
Christian Heimesdd15f6c2008-03-16 00:07:10 +00003842 /* _strptime._strptime returns a two-element tuple. The first
3843 element is a time.struct_time object. The second is the
3844 microseconds (which are not defined for time.struct_time). */
Mark Dickinsonfc689dd2008-03-16 03:45:34 +00003845 obj = PyObject_CallMethod(module, "_strptime", "uu", string, format);
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003846 if (obj != NULL) {
Christian Heimesdd15f6c2008-03-16 00:07:10 +00003847 int i, good_timetuple = 1;
3848 long int ia[7];
3849 if (PySequence_Check(obj) && PySequence_Size(obj) == 2) {
3850 st = PySequence_GetItem(obj, 0);
3851 frac = PySequence_GetItem(obj, 1);
3852 if (st == NULL || frac == NULL)
3853 good_timetuple = 0;
3854 /* copy y/m/d/h/m/s values out of the
3855 time.struct_time */
3856 if (good_timetuple &&
3857 PySequence_Check(st) &&
3858 PySequence_Size(st) >= 6) {
3859 for (i=0; i < 6; i++) {
3860 PyObject *p = PySequence_GetItem(st, i);
3861 if (p == NULL) {
3862 good_timetuple = 0;
3863 break;
3864 }
3865 if (PyLong_Check(p))
3866 ia[i] = PyLong_AsLong(p);
3867 else
3868 good_timetuple = 0;
3869 Py_DECREF(p);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003870 }
Christian Heimesdd15f6c2008-03-16 00:07:10 +00003871/* if (PyLong_CheckExact(p)) {
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +00003872 ia[i] = PyLong_AsLongAndOverflow(p, &overflow);
3873 if (overflow)
3874 good_timetuple = 0;
3875 }
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003876 else
3877 good_timetuple = 0;
3878 Py_DECREF(p);
Christian Heimesdd15f6c2008-03-16 00:07:10 +00003879*/ }
3880 else
3881 good_timetuple = 0;
3882 /* follow that up with a little dose of microseconds */
3883 if (PyLong_Check(frac))
3884 ia[6] = PyLong_AsLong(frac);
3885 else
3886 good_timetuple = 0;
3887 }
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003888 else
3889 good_timetuple = 0;
3890 if (good_timetuple)
Christian Heimesdd15f6c2008-03-16 00:07:10 +00003891 result = PyObject_CallFunction(cls, "iiiiiii",
3892 ia[0], ia[1], ia[2],
3893 ia[3], ia[4], ia[5],
3894 ia[6]);
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003895 else
3896 PyErr_SetString(PyExc_ValueError,
Christian Heimesdd15f6c2008-03-16 00:07:10 +00003897 "unexpected value from _strptime._strptime");
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003898 }
Christian Heimesdd15f6c2008-03-16 00:07:10 +00003899 Py_XDECREF(obj);
3900 Py_XDECREF(st);
3901 Py_XDECREF(frac);
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003902 return result;
3903}
3904
Tim Petersa9bc1682003-01-11 03:39:11 +00003905/* Return new datetime from date/datetime and time arguments. */
3906static PyObject *
3907datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
3908{
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003909 static char *keywords[] = {"date", "time", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00003910 PyObject *date;
3911 PyObject *time;
3912 PyObject *result = NULL;
3913
3914 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!:combine", keywords,
3915 &PyDateTime_DateType, &date,
3916 &PyDateTime_TimeType, &time)) {
3917 PyObject *tzinfo = Py_None;
3918
3919 if (HASTZINFO(time))
3920 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
3921 result = PyObject_CallFunction(cls, "iiiiiiiO",
3922 GET_YEAR(date),
3923 GET_MONTH(date),
3924 GET_DAY(date),
3925 TIME_GET_HOUR(time),
3926 TIME_GET_MINUTE(time),
3927 TIME_GET_SECOND(time),
3928 TIME_GET_MICROSECOND(time),
3929 tzinfo);
3930 }
3931 return result;
3932}
Tim Peters2a799bf2002-12-16 20:18:38 +00003933
3934/*
3935 * Destructor.
3936 */
3937
3938static void
Tim Petersa9bc1682003-01-11 03:39:11 +00003939datetime_dealloc(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003940{
Tim Petersa9bc1682003-01-11 03:39:11 +00003941 if (HASTZINFO(self)) {
3942 Py_XDECREF(self->tzinfo);
3943 }
Christian Heimes90aa7642007-12-19 02:45:37 +00003944 Py_TYPE(self)->tp_free((PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003945}
3946
3947/*
3948 * Indirect access to tzinfo methods.
3949 */
3950
Tim Peters2a799bf2002-12-16 20:18:38 +00003951/* These are all METH_NOARGS, so don't need to check the arglist. */
3952static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003953datetime_utcoffset(PyDateTime_DateTime *self, PyObject *unused) {
3954 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3955 "utcoffset", (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003956}
3957
3958static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003959datetime_dst(PyDateTime_DateTime *self, PyObject *unused) {
3960 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3961 "dst", (PyObject *)self);
Tim Peters855fe882002-12-22 03:43:39 +00003962}
3963
3964static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003965datetime_tzname(PyDateTime_DateTime *self, PyObject *unused) {
3966 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
3967 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003968}
3969
3970/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003971 * datetime arithmetic.
Tim Peters2a799bf2002-12-16 20:18:38 +00003972 */
3973
Tim Petersa9bc1682003-01-11 03:39:11 +00003974/* factor must be 1 (to add) or -1 (to subtract). The result inherits
3975 * the tzinfo state of date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003976 */
3977static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003978add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
3979 int factor)
Tim Peters2a799bf2002-12-16 20:18:38 +00003980{
Tim Petersa9bc1682003-01-11 03:39:11 +00003981 /* Note that the C-level additions can't overflow, because of
3982 * invariant bounds on the member values.
3983 */
3984 int year = GET_YEAR(date);
3985 int month = GET_MONTH(date);
3986 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
3987 int hour = DATE_GET_HOUR(date);
3988 int minute = DATE_GET_MINUTE(date);
3989 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
3990 int microsecond = DATE_GET_MICROSECOND(date) +
3991 GET_TD_MICROSECONDS(delta) * factor;
Tim Peters2a799bf2002-12-16 20:18:38 +00003992
Tim Petersa9bc1682003-01-11 03:39:11 +00003993 assert(factor == 1 || factor == -1);
3994 if (normalize_datetime(&year, &month, &day,
3995 &hour, &minute, &second, &microsecond) < 0)
3996 return NULL;
3997 else
3998 return new_datetime(year, month, day,
3999 hour, minute, second, microsecond,
4000 HASTZINFO(date) ? date->tzinfo : Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004001}
4002
4003static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004004datetime_add(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00004005{
Tim Petersa9bc1682003-01-11 03:39:11 +00004006 if (PyDateTime_Check(left)) {
4007 /* datetime + ??? */
4008 if (PyDelta_Check(right))
4009 /* datetime + delta */
4010 return add_datetime_timedelta(
4011 (PyDateTime_DateTime *)left,
4012 (PyDateTime_Delta *)right,
4013 1);
4014 }
4015 else if (PyDelta_Check(left)) {
4016 /* delta + datetime */
4017 return add_datetime_timedelta((PyDateTime_DateTime *) right,
4018 (PyDateTime_Delta *) left,
4019 1);
4020 }
4021 Py_INCREF(Py_NotImplemented);
4022 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00004023}
4024
4025static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004026datetime_subtract(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00004027{
4028 PyObject *result = Py_NotImplemented;
4029
4030 if (PyDateTime_Check(left)) {
4031 /* datetime - ??? */
4032 if (PyDateTime_Check(right)) {
4033 /* datetime - datetime */
4034 naivety n1, n2;
4035 int offset1, offset2;
Tim Petersa9bc1682003-01-11 03:39:11 +00004036 int delta_d, delta_s, delta_us;
Tim Peters2a799bf2002-12-16 20:18:38 +00004037
Tim Peterse39a80c2002-12-30 21:28:52 +00004038 if (classify_two_utcoffsets(left, &offset1, &n1, left,
4039 right, &offset2, &n2,
4040 right) < 0)
Tim Peters00237032002-12-27 02:21:51 +00004041 return NULL;
Tim Peters8702d5f2002-12-27 02:26:16 +00004042 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
Tim Peters2a799bf2002-12-16 20:18:38 +00004043 if (n1 != n2) {
4044 PyErr_SetString(PyExc_TypeError,
4045 "can't subtract offset-naive and "
4046 "offset-aware datetimes");
4047 return NULL;
4048 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004049 delta_d = ymd_to_ord(GET_YEAR(left),
4050 GET_MONTH(left),
4051 GET_DAY(left)) -
4052 ymd_to_ord(GET_YEAR(right),
4053 GET_MONTH(right),
4054 GET_DAY(right));
4055 /* These can't overflow, since the values are
4056 * normalized. At most this gives the number of
4057 * seconds in one day.
4058 */
4059 delta_s = (DATE_GET_HOUR(left) -
4060 DATE_GET_HOUR(right)) * 3600 +
4061 (DATE_GET_MINUTE(left) -
4062 DATE_GET_MINUTE(right)) * 60 +
4063 (DATE_GET_SECOND(left) -
4064 DATE_GET_SECOND(right));
4065 delta_us = DATE_GET_MICROSECOND(left) -
4066 DATE_GET_MICROSECOND(right);
Tim Peters2a799bf2002-12-16 20:18:38 +00004067 /* (left - offset1) - (right - offset2) =
4068 * (left - right) + (offset2 - offset1)
4069 */
Tim Petersa9bc1682003-01-11 03:39:11 +00004070 delta_s += (offset2 - offset1) * 60;
4071 result = new_delta(delta_d, delta_s, delta_us, 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00004072 }
4073 else if (PyDelta_Check(right)) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004074 /* datetime - delta */
4075 result = add_datetime_timedelta(
Tim Peters2a799bf2002-12-16 20:18:38 +00004076 (PyDateTime_DateTime *)left,
Tim Petersa9bc1682003-01-11 03:39:11 +00004077 (PyDateTime_Delta *)right,
4078 -1);
Tim Peters2a799bf2002-12-16 20:18:38 +00004079 }
4080 }
4081
4082 if (result == Py_NotImplemented)
4083 Py_INCREF(result);
4084 return result;
4085}
4086
4087/* Various ways to turn a datetime into a string. */
4088
4089static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004090datetime_repr(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004091{
Christian Heimes90aa7642007-12-19 02:45:37 +00004092 const char *type_name = Py_TYPE(self)->tp_name;
Tim Petersa9bc1682003-01-11 03:39:11 +00004093 PyObject *baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004094
Tim Petersa9bc1682003-01-11 03:39:11 +00004095 if (DATE_GET_MICROSECOND(self)) {
Walter Dörwald7569dfe2007-05-19 21:49:49 +00004096 baserepr = PyUnicode_FromFormat(
Tim Petersa9bc1682003-01-11 03:39:11 +00004097 "%s(%d, %d, %d, %d, %d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004098 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004099 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4100 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4101 DATE_GET_SECOND(self),
4102 DATE_GET_MICROSECOND(self));
4103 }
4104 else if (DATE_GET_SECOND(self)) {
Walter Dörwald7569dfe2007-05-19 21:49:49 +00004105 baserepr = PyUnicode_FromFormat(
Tim Petersa9bc1682003-01-11 03:39:11 +00004106 "%s(%d, %d, %d, %d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004107 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004108 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4109 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4110 DATE_GET_SECOND(self));
4111 }
4112 else {
Walter Dörwald7569dfe2007-05-19 21:49:49 +00004113 baserepr = PyUnicode_FromFormat(
Tim Petersa9bc1682003-01-11 03:39:11 +00004114 "%s(%d, %d, %d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004115 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004116 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4117 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
4118 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004119 if (baserepr == NULL || ! HASTZINFO(self))
4120 return baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004121 return append_keyword_tzinfo(baserepr, self->tzinfo);
4122}
4123
Tim Petersa9bc1682003-01-11 03:39:11 +00004124static PyObject *
4125datetime_str(PyDateTime_DateTime *self)
4126{
4127 return PyObject_CallMethod((PyObject *)self, "isoformat", "(s)", " ");
4128}
Tim Peters2a799bf2002-12-16 20:18:38 +00004129
4130static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004131datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004132{
Walter Dörwaldbc1f8862007-06-20 11:02:38 +00004133 int sep = 'T';
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004134 static char *keywords[] = {"sep", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00004135 char buffer[100];
Tim Petersa9bc1682003-01-11 03:39:11 +00004136 PyObject *result;
Walter Dörwaldbafa1372007-05-31 17:50:48 +00004137 int us = DATE_GET_MICROSECOND(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00004138
Walter Dörwaldd0941302007-07-01 21:58:22 +00004139 if (!PyArg_ParseTupleAndKeywords(args, kw, "|C:isoformat", keywords, &sep))
Tim Petersa9bc1682003-01-11 03:39:11 +00004140 return NULL;
Walter Dörwaldbafa1372007-05-31 17:50:48 +00004141 if (us)
4142 result = PyUnicode_FromFormat("%04d-%02d-%02d%c%02d:%02d:%02d.%06d",
4143 GET_YEAR(self), GET_MONTH(self),
4144 GET_DAY(self), (int)sep,
4145 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4146 DATE_GET_SECOND(self), us);
4147 else
4148 result = PyUnicode_FromFormat("%04d-%02d-%02d%c%02d:%02d:%02d",
4149 GET_YEAR(self), GET_MONTH(self),
4150 GET_DAY(self), (int)sep,
4151 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4152 DATE_GET_SECOND(self));
4153
4154 if (!result || !HASTZINFO(self))
Tim Peters2a799bf2002-12-16 20:18:38 +00004155 return result;
4156
4157 /* We need to append the UTC offset. */
Tim Petersa9bc1682003-01-11 03:39:11 +00004158 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
Tim Peters2a799bf2002-12-16 20:18:38 +00004159 (PyObject *)self) < 0) {
4160 Py_DECREF(result);
4161 return NULL;
4162 }
Walter Dörwaldbafa1372007-05-31 17:50:48 +00004163 PyUnicode_AppendAndDel(&result, PyUnicode_FromString(buffer));
Tim Peters2a799bf2002-12-16 20:18:38 +00004164 return result;
4165}
4166
Tim Petersa9bc1682003-01-11 03:39:11 +00004167static PyObject *
4168datetime_ctime(PyDateTime_DateTime *self)
4169{
4170 return format_ctime((PyDateTime_Date *)self,
4171 DATE_GET_HOUR(self),
4172 DATE_GET_MINUTE(self),
4173 DATE_GET_SECOND(self));
4174}
4175
Tim Peters2a799bf2002-12-16 20:18:38 +00004176/* Miscellaneous methods. */
4177
Tim Petersa9bc1682003-01-11 03:39:11 +00004178static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00004179datetime_richcompare(PyObject *self, PyObject *other, int op)
Tim Petersa9bc1682003-01-11 03:39:11 +00004180{
4181 int diff;
4182 naivety n1, n2;
4183 int offset1, offset2;
4184
4185 if (! PyDateTime_Check(other)) {
Guido van Rossum19960592006-08-24 17:29:38 +00004186 if (PyDate_Check(other)) {
4187 /* Prevent invocation of date_richcompare. We want to
4188 return NotImplemented here to give the other object
4189 a chance. But since DateTime is a subclass of
4190 Date, if the other object is a Date, it would
4191 compute an ordering based on the date part alone,
4192 and we don't want that. So force unequal or
4193 uncomparable here in that case. */
4194 if (op == Py_EQ)
4195 Py_RETURN_FALSE;
4196 if (op == Py_NE)
4197 Py_RETURN_TRUE;
4198 return cmperror(self, other);
Tim Peters8d81a012003-01-24 22:36:34 +00004199 }
Guido van Rossum19960592006-08-24 17:29:38 +00004200 Py_INCREF(Py_NotImplemented);
4201 return Py_NotImplemented;
Tim Petersa9bc1682003-01-11 03:39:11 +00004202 }
4203
Guido van Rossum19960592006-08-24 17:29:38 +00004204 if (classify_two_utcoffsets(self, &offset1, &n1, self,
4205 other, &offset2, &n2, other) < 0)
Tim Petersa9bc1682003-01-11 03:39:11 +00004206 return NULL;
4207 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
4208 /* If they're both naive, or both aware and have the same offsets,
4209 * we get off cheap. Note that if they're both naive, offset1 ==
4210 * offset2 == 0 at this point.
4211 */
4212 if (n1 == n2 && offset1 == offset2) {
Guido van Rossum19960592006-08-24 17:29:38 +00004213 diff = memcmp(((PyDateTime_DateTime *)self)->data,
4214 ((PyDateTime_DateTime *)other)->data,
Tim Petersa9bc1682003-01-11 03:39:11 +00004215 _PyDateTime_DATETIME_DATASIZE);
4216 return diff_to_bool(diff, op);
4217 }
4218
4219 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
4220 PyDateTime_Delta *delta;
4221
4222 assert(offset1 != offset2); /* else last "if" handled it */
4223 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
4224 other);
4225 if (delta == NULL)
4226 return NULL;
4227 diff = GET_TD_DAYS(delta);
4228 if (diff == 0)
4229 diff = GET_TD_SECONDS(delta) |
4230 GET_TD_MICROSECONDS(delta);
4231 Py_DECREF(delta);
4232 return diff_to_bool(diff, op);
4233 }
4234
4235 assert(n1 != n2);
4236 PyErr_SetString(PyExc_TypeError,
4237 "can't compare offset-naive and "
4238 "offset-aware datetimes");
4239 return NULL;
4240}
4241
4242static long
4243datetime_hash(PyDateTime_DateTime *self)
4244{
4245 if (self->hashcode == -1) {
4246 naivety n;
4247 int offset;
4248 PyObject *temp;
4249
4250 n = classify_utcoffset((PyObject *)self, (PyObject *)self,
4251 &offset);
4252 assert(n != OFFSET_UNKNOWN);
4253 if (n == OFFSET_ERROR)
4254 return -1;
4255
4256 /* Reduce this to a hash of another object. */
Guido van Rossumfd53fd62007-08-24 04:05:13 +00004257 if (n == OFFSET_NAIVE) {
4258 self->hashcode = generic_hash(
4259 (unsigned char *)self->data, _PyDateTime_DATETIME_DATASIZE);
4260 return self->hashcode;
4261 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004262 else {
4263 int days;
4264 int seconds;
4265
4266 assert(n == OFFSET_AWARE);
4267 assert(HASTZINFO(self));
4268 days = ymd_to_ord(GET_YEAR(self),
4269 GET_MONTH(self),
4270 GET_DAY(self));
4271 seconds = DATE_GET_HOUR(self) * 3600 +
4272 (DATE_GET_MINUTE(self) - offset) * 60 +
4273 DATE_GET_SECOND(self);
4274 temp = new_delta(days,
4275 seconds,
4276 DATE_GET_MICROSECOND(self),
4277 1);
4278 }
4279 if (temp != NULL) {
4280 self->hashcode = PyObject_Hash(temp);
4281 Py_DECREF(temp);
4282 }
4283 }
4284 return self->hashcode;
4285}
Tim Peters2a799bf2002-12-16 20:18:38 +00004286
4287static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004288datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00004289{
4290 PyObject *clone;
4291 PyObject *tuple;
4292 int y = GET_YEAR(self);
4293 int m = GET_MONTH(self);
4294 int d = GET_DAY(self);
4295 int hh = DATE_GET_HOUR(self);
4296 int mm = DATE_GET_MINUTE(self);
4297 int ss = DATE_GET_SECOND(self);
4298 int us = DATE_GET_MICROSECOND(self);
Tim Petersa9bc1682003-01-11 03:39:11 +00004299 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00004300
4301 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO:replace",
Tim Petersa9bc1682003-01-11 03:39:11 +00004302 datetime_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00004303 &y, &m, &d, &hh, &mm, &ss, &us,
4304 &tzinfo))
4305 return NULL;
4306 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
4307 if (tuple == NULL)
4308 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00004309 clone = datetime_new(Py_TYPE(self), tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00004310 Py_DECREF(tuple);
4311 return clone;
4312}
4313
4314static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004315datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters80475bb2002-12-25 07:40:55 +00004316{
Tim Peters52dcce22003-01-23 16:36:11 +00004317 int y, m, d, hh, mm, ss, us;
Tim Peters521fc152002-12-31 17:36:56 +00004318 PyObject *result;
Tim Peters52dcce22003-01-23 16:36:11 +00004319 int offset, none;
Tim Peters521fc152002-12-31 17:36:56 +00004320
Tim Peters80475bb2002-12-25 07:40:55 +00004321 PyObject *tzinfo;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004322 static char *keywords[] = {"tz", NULL};
Tim Peters80475bb2002-12-25 07:40:55 +00004323
Tim Peters52dcce22003-01-23 16:36:11 +00004324 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:astimezone", keywords,
4325 &PyDateTime_TZInfoType, &tzinfo))
Tim Peters80475bb2002-12-25 07:40:55 +00004326 return NULL;
4327
Tim Peters52dcce22003-01-23 16:36:11 +00004328 if (!HASTZINFO(self) || self->tzinfo == Py_None)
4329 goto NeedAware;
Tim Peters521fc152002-12-31 17:36:56 +00004330
Tim Peters52dcce22003-01-23 16:36:11 +00004331 /* Conversion to self's own time zone is a NOP. */
4332 if (self->tzinfo == tzinfo) {
4333 Py_INCREF(self);
4334 return (PyObject *)self;
Tim Peters710fb152003-01-02 19:35:54 +00004335 }
Tim Peters521fc152002-12-31 17:36:56 +00004336
Tim Peters52dcce22003-01-23 16:36:11 +00004337 /* Convert self to UTC. */
4338 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4339 if (offset == -1 && PyErr_Occurred())
4340 return NULL;
4341 if (none)
4342 goto NeedAware;
Tim Petersf3615152003-01-01 21:51:37 +00004343
Tim Peters52dcce22003-01-23 16:36:11 +00004344 y = GET_YEAR(self);
4345 m = GET_MONTH(self);
4346 d = GET_DAY(self);
4347 hh = DATE_GET_HOUR(self);
4348 mm = DATE_GET_MINUTE(self);
4349 ss = DATE_GET_SECOND(self);
4350 us = DATE_GET_MICROSECOND(self);
4351
4352 mm -= offset;
Tim Petersf3615152003-01-01 21:51:37 +00004353 if ((mm < 0 || mm >= 60) &&
4354 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Peters52dcce22003-01-23 16:36:11 +00004355 return NULL;
4356
4357 /* Attach new tzinfo and let fromutc() do the rest. */
4358 result = new_datetime(y, m, d, hh, mm, ss, us, tzinfo);
4359 if (result != NULL) {
4360 PyObject *temp = result;
4361
4362 result = PyObject_CallMethod(tzinfo, "fromutc", "O", temp);
4363 Py_DECREF(temp);
4364 }
Tim Petersadf64202003-01-04 06:03:15 +00004365 return result;
Tim Peters521fc152002-12-31 17:36:56 +00004366
Tim Peters52dcce22003-01-23 16:36:11 +00004367NeedAware:
4368 PyErr_SetString(PyExc_ValueError, "astimezone() cannot be applied to "
4369 "a naive datetime");
Tim Peters521fc152002-12-31 17:36:56 +00004370 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00004371}
4372
4373static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004374datetime_timetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004375{
4376 int dstflag = -1;
4377
Tim Petersa9bc1682003-01-11 03:39:11 +00004378 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004379 int none;
4380
4381 dstflag = call_dst(self->tzinfo, (PyObject *)self, &none);
4382 if (dstflag == -1 && PyErr_Occurred())
4383 return NULL;
4384
4385 if (none)
4386 dstflag = -1;
4387 else if (dstflag != 0)
4388 dstflag = 1;
4389
4390 }
4391 return build_struct_time(GET_YEAR(self),
4392 GET_MONTH(self),
4393 GET_DAY(self),
4394 DATE_GET_HOUR(self),
4395 DATE_GET_MINUTE(self),
4396 DATE_GET_SECOND(self),
4397 dstflag);
4398}
4399
4400static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004401datetime_getdate(PyDateTime_DateTime *self)
4402{
4403 return new_date(GET_YEAR(self),
4404 GET_MONTH(self),
4405 GET_DAY(self));
4406}
4407
4408static PyObject *
4409datetime_gettime(PyDateTime_DateTime *self)
4410{
4411 return new_time(DATE_GET_HOUR(self),
4412 DATE_GET_MINUTE(self),
4413 DATE_GET_SECOND(self),
4414 DATE_GET_MICROSECOND(self),
4415 Py_None);
4416}
4417
4418static PyObject *
4419datetime_gettimetz(PyDateTime_DateTime *self)
4420{
4421 return new_time(DATE_GET_HOUR(self),
4422 DATE_GET_MINUTE(self),
4423 DATE_GET_SECOND(self),
4424 DATE_GET_MICROSECOND(self),
4425 HASTZINFO(self) ? self->tzinfo : Py_None);
4426}
4427
4428static PyObject *
4429datetime_utctimetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004430{
4431 int y = GET_YEAR(self);
4432 int m = GET_MONTH(self);
4433 int d = GET_DAY(self);
4434 int hh = DATE_GET_HOUR(self);
4435 int mm = DATE_GET_MINUTE(self);
4436 int ss = DATE_GET_SECOND(self);
4437 int us = 0; /* microseconds are ignored in a timetuple */
4438 int offset = 0;
4439
Tim Petersa9bc1682003-01-11 03:39:11 +00004440 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004441 int none;
4442
4443 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4444 if (offset == -1 && PyErr_Occurred())
4445 return NULL;
4446 }
4447 /* Even if offset is 0, don't call timetuple() -- tm_isdst should be
4448 * 0 in a UTC timetuple regardless of what dst() says.
4449 */
4450 if (offset) {
4451 /* Subtract offset minutes & normalize. */
4452 int stat;
4453
4454 mm -= offset;
4455 stat = normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us);
4456 if (stat < 0) {
4457 /* At the edges, it's possible we overflowed
4458 * beyond MINYEAR or MAXYEAR.
4459 */
4460 if (PyErr_ExceptionMatches(PyExc_OverflowError))
4461 PyErr_Clear();
4462 else
4463 return NULL;
4464 }
4465 }
4466 return build_struct_time(y, m, d, hh, mm, ss, 0);
4467}
4468
Tim Peters371935f2003-02-01 01:52:50 +00004469/* Pickle support, a simple use of __reduce__. */
Tim Peters33e0f382003-01-10 02:05:14 +00004470
Tim Petersa9bc1682003-01-11 03:39:11 +00004471/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004472 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4473 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00004474 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00004475 */
4476static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004477datetime_getstate(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004478{
4479 PyObject *basestate;
4480 PyObject *result = NULL;
4481
Guido van Rossum254348e2007-11-21 19:29:53 +00004482 basestate = PyString_FromStringAndSize((char *)self->data,
4483 _PyDateTime_DATETIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00004484 if (basestate != NULL) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004485 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004486 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00004487 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004488 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00004489 Py_DECREF(basestate);
4490 }
4491 return result;
4492}
4493
4494static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00004495datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00004496{
Christian Heimes90aa7642007-12-19 02:45:37 +00004497 return Py_BuildValue("(ON)", Py_TYPE(self), datetime_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00004498}
4499
Tim Petersa9bc1682003-01-11 03:39:11 +00004500static PyMethodDef datetime_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004501
Tim Peters2a799bf2002-12-16 20:18:38 +00004502 /* Class methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00004503
Tim Petersa9bc1682003-01-11 03:39:11 +00004504 {"now", (PyCFunction)datetime_now,
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004505 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
Neal Norwitz2fbe5372003-01-23 21:09:05 +00004506 PyDoc_STR("[tz] -> new datetime with tz's local day and time.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004507
Tim Petersa9bc1682003-01-11 03:39:11 +00004508 {"utcnow", (PyCFunction)datetime_utcnow,
4509 METH_NOARGS | METH_CLASS,
4510 PyDoc_STR("Return a new datetime representing UTC day and time.")},
4511
4512 {"fromtimestamp", (PyCFunction)datetime_fromtimestamp,
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004513 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
Tim Peters2a44a8d2003-01-23 20:53:10 +00004514 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004515
Tim Petersa9bc1682003-01-11 03:39:11 +00004516 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
4517 METH_VARARGS | METH_CLASS,
4518 PyDoc_STR("timestamp -> UTC datetime from a POSIX timestamp "
4519 "(like time.time()).")},
4520
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004521 {"strptime", (PyCFunction)datetime_strptime,
4522 METH_VARARGS | METH_CLASS,
4523 PyDoc_STR("string, format -> new datetime parsed from a string "
4524 "(like time.strptime()).")},
4525
Tim Petersa9bc1682003-01-11 03:39:11 +00004526 {"combine", (PyCFunction)datetime_combine,
4527 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4528 PyDoc_STR("date, time -> datetime with same date and time fields")},
4529
Tim Peters2a799bf2002-12-16 20:18:38 +00004530 /* Instance methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00004531
Tim Petersa9bc1682003-01-11 03:39:11 +00004532 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
4533 PyDoc_STR("Return date object with same year, month and day.")},
4534
4535 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
4536 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
4537
4538 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
4539 PyDoc_STR("Return time object with same time and tzinfo.")},
4540
4541 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
4542 PyDoc_STR("Return ctime() style string.")},
4543
4544 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004545 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
4546
Tim Petersa9bc1682003-01-11 03:39:11 +00004547 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004548 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
4549
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004550 {"isoformat", (PyCFunction)datetime_isoformat, METH_VARARGS | METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004551 PyDoc_STR("[sep] -> string in ISO 8601 format, "
4552 "YYYY-MM-DDTHH:MM:SS[.mmmmmm][+HH:MM].\n\n"
4553 "sep is used to separate the year from the time, and "
4554 "defaults to 'T'.")},
4555
Tim Petersa9bc1682003-01-11 03:39:11 +00004556 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004557 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
4558
Tim Petersa9bc1682003-01-11 03:39:11 +00004559 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004560 PyDoc_STR("Return self.tzinfo.tzname(self).")},
4561
Tim Petersa9bc1682003-01-11 03:39:11 +00004562 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004563 PyDoc_STR("Return self.tzinfo.dst(self).")},
4564
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004565 {"replace", (PyCFunction)datetime_replace, METH_VARARGS | METH_KEYWORDS,
Tim Petersa9bc1682003-01-11 03:39:11 +00004566 PyDoc_STR("Return datetime with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00004567
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004568 {"astimezone", (PyCFunction)datetime_astimezone, METH_VARARGS | METH_KEYWORDS,
Tim Peters80475bb2002-12-25 07:40:55 +00004569 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
4570
Guido van Rossum177e41a2003-01-30 22:06:23 +00004571 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
4572 PyDoc_STR("__reduce__() -> (cls, state)")},
4573
Tim Peters2a799bf2002-12-16 20:18:38 +00004574 {NULL, NULL}
4575};
4576
Tim Petersa9bc1682003-01-11 03:39:11 +00004577static char datetime_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00004578PyDoc_STR("datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])\n\
4579\n\
4580The year, month and day arguments are required. tzinfo may be None, or an\n\
4581instance of a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00004582
Tim Petersa9bc1682003-01-11 03:39:11 +00004583static PyNumberMethods datetime_as_number = {
4584 datetime_add, /* nb_add */
4585 datetime_subtract, /* nb_subtract */
Tim Peters2a799bf2002-12-16 20:18:38 +00004586 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00004587 0, /* nb_remainder */
4588 0, /* nb_divmod */
4589 0, /* nb_power */
4590 0, /* nb_negative */
4591 0, /* nb_positive */
4592 0, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +00004593 0, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00004594};
4595
Neal Norwitz227b5332006-03-22 09:28:35 +00004596static PyTypeObject PyDateTime_DateTimeType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00004597 PyVarObject_HEAD_INIT(NULL, 0)
Tim Peters0bf60bd2003-01-08 20:40:01 +00004598 "datetime.datetime", /* tp_name */
Tim Petersa9bc1682003-01-11 03:39:11 +00004599 sizeof(PyDateTime_DateTime), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00004600 0, /* tp_itemsize */
Tim Petersa9bc1682003-01-11 03:39:11 +00004601 (destructor)datetime_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004602 0, /* tp_print */
4603 0, /* tp_getattr */
4604 0, /* tp_setattr */
4605 0, /* tp_compare */
Tim Petersa9bc1682003-01-11 03:39:11 +00004606 (reprfunc)datetime_repr, /* tp_repr */
4607 &datetime_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00004608 0, /* tp_as_sequence */
4609 0, /* tp_as_mapping */
Tim Petersa9bc1682003-01-11 03:39:11 +00004610 (hashfunc)datetime_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00004611 0, /* tp_call */
Tim Petersa9bc1682003-01-11 03:39:11 +00004612 (reprfunc)datetime_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00004613 PyObject_GenericGetAttr, /* tp_getattro */
4614 0, /* tp_setattro */
4615 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00004616 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Petersa9bc1682003-01-11 03:39:11 +00004617 datetime_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004618 0, /* tp_traverse */
4619 0, /* tp_clear */
Guido van Rossum19960592006-08-24 17:29:38 +00004620 datetime_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00004621 0, /* tp_weaklistoffset */
4622 0, /* tp_iter */
4623 0, /* tp_iternext */
Tim Petersa9bc1682003-01-11 03:39:11 +00004624 datetime_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00004625 0, /* tp_members */
Tim Petersa9bc1682003-01-11 03:39:11 +00004626 datetime_getset, /* tp_getset */
4627 &PyDateTime_DateType, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00004628 0, /* tp_dict */
4629 0, /* tp_descr_get */
4630 0, /* tp_descr_set */
4631 0, /* tp_dictoffset */
4632 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00004633 datetime_alloc, /* tp_alloc */
Tim Petersa9bc1682003-01-11 03:39:11 +00004634 datetime_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00004635 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00004636};
4637
4638/* ---------------------------------------------------------------------------
4639 * Module methods and initialization.
4640 */
4641
4642static PyMethodDef module_methods[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004643 {NULL, NULL}
4644};
4645
Tim Peters9ddf40b2004-06-20 22:41:32 +00004646/* C API. Clients get at this via PyDateTime_IMPORT, defined in
4647 * datetime.h.
4648 */
4649static PyDateTime_CAPI CAPI = {
4650 &PyDateTime_DateType,
4651 &PyDateTime_DateTimeType,
4652 &PyDateTime_TimeType,
4653 &PyDateTime_DeltaType,
4654 &PyDateTime_TZInfoType,
4655 new_date_ex,
4656 new_datetime_ex,
4657 new_time_ex,
4658 new_delta_ex,
4659 datetime_fromtimestamp,
4660 date_fromtimestamp
4661};
4662
4663
Tim Peters2a799bf2002-12-16 20:18:38 +00004664PyMODINIT_FUNC
4665initdatetime(void)
4666{
4667 PyObject *m; /* a module object */
4668 PyObject *d; /* its dict */
4669 PyObject *x;
4670
Tim Peters2a799bf2002-12-16 20:18:38 +00004671 m = Py_InitModule3("datetime", module_methods,
4672 "Fast implementation of the datetime type.");
Neal Norwitz1ac754f2006-01-19 06:09:39 +00004673 if (m == NULL)
4674 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004675
4676 if (PyType_Ready(&PyDateTime_DateType) < 0)
4677 return;
4678 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
4679 return;
4680 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
4681 return;
4682 if (PyType_Ready(&PyDateTime_TimeType) < 0)
4683 return;
4684 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
4685 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004686
Tim Peters2a799bf2002-12-16 20:18:38 +00004687 /* timedelta values */
4688 d = PyDateTime_DeltaType.tp_dict;
4689
Tim Peters2a799bf2002-12-16 20:18:38 +00004690 x = new_delta(0, 0, 1, 0);
4691 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4692 return;
4693 Py_DECREF(x);
4694
4695 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
4696 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4697 return;
4698 Py_DECREF(x);
4699
4700 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
4701 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4702 return;
4703 Py_DECREF(x);
4704
4705 /* date values */
4706 d = PyDateTime_DateType.tp_dict;
4707
4708 x = new_date(1, 1, 1);
4709 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4710 return;
4711 Py_DECREF(x);
4712
4713 x = new_date(MAXYEAR, 12, 31);
4714 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4715 return;
4716 Py_DECREF(x);
4717
4718 x = new_delta(1, 0, 0, 0);
4719 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4720 return;
4721 Py_DECREF(x);
4722
Tim Peters37f39822003-01-10 03:49:02 +00004723 /* time values */
4724 d = PyDateTime_TimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004725
Tim Peters37f39822003-01-10 03:49:02 +00004726 x = new_time(0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004727 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4728 return;
4729 Py_DECREF(x);
4730
Tim Peters37f39822003-01-10 03:49:02 +00004731 x = new_time(23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004732 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4733 return;
4734 Py_DECREF(x);
4735
4736 x = new_delta(0, 0, 1, 0);
4737 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4738 return;
4739 Py_DECREF(x);
4740
Tim Petersa9bc1682003-01-11 03:39:11 +00004741 /* datetime values */
4742 d = PyDateTime_DateTimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004743
Tim Petersa9bc1682003-01-11 03:39:11 +00004744 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004745 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4746 return;
4747 Py_DECREF(x);
4748
Tim Petersa9bc1682003-01-11 03:39:11 +00004749 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004750 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4751 return;
4752 Py_DECREF(x);
4753
4754 x = new_delta(0, 0, 1, 0);
4755 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4756 return;
4757 Py_DECREF(x);
4758
Tim Peters2a799bf2002-12-16 20:18:38 +00004759 /* module initialization */
4760 PyModule_AddIntConstant(m, "MINYEAR", MINYEAR);
4761 PyModule_AddIntConstant(m, "MAXYEAR", MAXYEAR);
4762
4763 Py_INCREF(&PyDateTime_DateType);
4764 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
4765
Tim Petersa9bc1682003-01-11 03:39:11 +00004766 Py_INCREF(&PyDateTime_DateTimeType);
4767 PyModule_AddObject(m, "datetime",
4768 (PyObject *)&PyDateTime_DateTimeType);
4769
4770 Py_INCREF(&PyDateTime_TimeType);
4771 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
4772
Tim Peters2a799bf2002-12-16 20:18:38 +00004773 Py_INCREF(&PyDateTime_DeltaType);
4774 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
4775
Tim Peters2a799bf2002-12-16 20:18:38 +00004776 Py_INCREF(&PyDateTime_TZInfoType);
4777 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
4778
Tim Peters9ddf40b2004-06-20 22:41:32 +00004779 x = PyCObject_FromVoidPtrAndDesc(&CAPI, (void*) DATETIME_API_MAGIC,
4780 NULL);
4781 if (x == NULL)
4782 return;
4783 PyModule_AddObject(m, "datetime_CAPI", x);
4784
Tim Peters2a799bf2002-12-16 20:18:38 +00004785 /* A 4-year cycle has an extra leap day over what we'd get from
4786 * pasting together 4 single years.
4787 */
4788 assert(DI4Y == 4 * 365 + 1);
4789 assert(DI4Y == days_before_year(4+1));
4790
4791 /* Similarly, a 400-year cycle has an extra leap day over what we'd
4792 * get from pasting together 4 100-year cycles.
4793 */
4794 assert(DI400Y == 4 * DI100Y + 1);
4795 assert(DI400Y == days_before_year(400+1));
4796
4797 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
4798 * pasting together 25 4-year cycles.
4799 */
4800 assert(DI100Y == 25 * DI4Y - 1);
4801 assert(DI100Y == days_before_year(100+1));
4802
Christian Heimes217cfd12007-12-02 14:31:20 +00004803 us_per_us = PyLong_FromLong(1);
4804 us_per_ms = PyLong_FromLong(1000);
4805 us_per_second = PyLong_FromLong(1000000);
4806 us_per_minute = PyLong_FromLong(60000000);
4807 seconds_per_day = PyLong_FromLong(24 * 3600);
Tim Peters2a799bf2002-12-16 20:18:38 +00004808 if (us_per_us == NULL || us_per_ms == NULL || us_per_second == NULL ||
4809 us_per_minute == NULL || seconds_per_day == NULL)
4810 return;
4811
4812 /* The rest are too big for 32-bit ints, but even
4813 * us_per_week fits in 40 bits, so doubles should be exact.
4814 */
4815 us_per_hour = PyLong_FromDouble(3600000000.0);
4816 us_per_day = PyLong_FromDouble(86400000000.0);
4817 us_per_week = PyLong_FromDouble(604800000000.0);
4818 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
4819 return;
4820}
Tim Petersf3615152003-01-01 21:51:37 +00004821
4822/* ---------------------------------------------------------------------------
Tim Petersa9bc1682003-01-11 03:39:11 +00004823Some time zone algebra. For a datetime x, let
Tim Petersf3615152003-01-01 21:51:37 +00004824 x.n = x stripped of its timezone -- its naive time.
4825 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
4826 return None
4827 x.d = x.dst(), and assuming that doesn't raise an exception or
4828 return None
4829 x.s = x's standard offset, x.o - x.d
4830
4831Now some derived rules, where k is a duration (timedelta).
4832
48331. x.o = x.s + x.d
4834 This follows from the definition of x.s.
4835
Tim Petersc5dc4da2003-01-02 17:55:03 +000048362. If x and y have the same tzinfo member, x.s = y.s.
Tim Petersf3615152003-01-01 21:51:37 +00004837 This is actually a requirement, an assumption we need to make about
4838 sane tzinfo classes.
4839
48403. The naive UTC time corresponding to x is x.n - x.o.
4841 This is again a requirement for a sane tzinfo class.
4842
48434. (x+k).s = x.s
Tim Peters8bb5ad22003-01-24 02:44:45 +00004844 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
Tim Petersf3615152003-01-01 21:51:37 +00004845
Tim Petersc5dc4da2003-01-02 17:55:03 +000048465. (x+k).n = x.n + k
Tim Petersf3615152003-01-01 21:51:37 +00004847 Again follows from how arithmetic is defined.
4848
Tim Peters8bb5ad22003-01-24 02:44:45 +00004849Now we can explain tz.fromutc(x). Let's assume it's an interesting case
Tim Petersf3615152003-01-01 21:51:37 +00004850(meaning that the various tzinfo methods exist, and don't blow up or return
4851None when called).
4852
Tim Petersa9bc1682003-01-11 03:39:11 +00004853The function wants to return a datetime y with timezone tz, equivalent to x.
Tim Peters8bb5ad22003-01-24 02:44:45 +00004854x is already in UTC.
Tim Petersf3615152003-01-01 21:51:37 +00004855
4856By #3, we want
4857
Tim Peters8bb5ad22003-01-24 02:44:45 +00004858 y.n - y.o = x.n [1]
Tim Petersf3615152003-01-01 21:51:37 +00004859
4860The algorithm starts by attaching tz to x.n, and calling that y. So
4861x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
4862becomes true; in effect, we want to solve [2] for k:
4863
Tim Peters8bb5ad22003-01-24 02:44:45 +00004864 (y+k).n - (y+k).o = x.n [2]
Tim Petersf3615152003-01-01 21:51:37 +00004865
4866By #1, this is the same as
4867
Tim Peters8bb5ad22003-01-24 02:44:45 +00004868 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
Tim Petersf3615152003-01-01 21:51:37 +00004869
4870By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
4871Substituting that into [3],
4872
Tim Peters8bb5ad22003-01-24 02:44:45 +00004873 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
4874 k - (y+k).s - (y+k).d = 0; rearranging,
4875 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
4876 k = y.s - (y+k).d
Tim Petersf3615152003-01-01 21:51:37 +00004877
Tim Peters8bb5ad22003-01-24 02:44:45 +00004878On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
4879approximate k by ignoring the (y+k).d term at first. Note that k can't be
4880very large, since all offset-returning methods return a duration of magnitude
4881less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
4882be 0, so ignoring it has no consequence then.
Tim Petersf3615152003-01-01 21:51:37 +00004883
4884In any case, the new value is
4885
Tim Peters8bb5ad22003-01-24 02:44:45 +00004886 z = y + y.s [4]
Tim Petersf3615152003-01-01 21:51:37 +00004887
Tim Peters8bb5ad22003-01-24 02:44:45 +00004888It's helpful to step back at look at [4] from a higher level: it's simply
4889mapping from UTC to tz's standard time.
Tim Petersc5dc4da2003-01-02 17:55:03 +00004890
4891At this point, if
4892
Tim Peters8bb5ad22003-01-24 02:44:45 +00004893 z.n - z.o = x.n [5]
Tim Petersc5dc4da2003-01-02 17:55:03 +00004894
4895we have an equivalent time, and are almost done. The insecurity here is
Tim Petersf3615152003-01-01 21:51:37 +00004896at the start of daylight time. Picture US Eastern for concreteness. The wall
4897time 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 +00004898sense then. The docs ask that an Eastern tzinfo class consider such a time to
4899be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
4900on the day DST starts. We want to return the 1:MM EST spelling because that's
Tim Petersf3615152003-01-01 21:51:37 +00004901the only spelling that makes sense on the local wall clock.
4902
Tim Petersc5dc4da2003-01-02 17:55:03 +00004903In fact, if [5] holds at this point, we do have the standard-time spelling,
4904but that takes a bit of proof. We first prove a stronger result. What's the
4905difference between the LHS and RHS of [5]? Let
Tim Petersf3615152003-01-01 21:51:37 +00004906
Tim Peters8bb5ad22003-01-24 02:44:45 +00004907 diff = x.n - (z.n - z.o) [6]
Tim Petersf3615152003-01-01 21:51:37 +00004908
Tim Petersc5dc4da2003-01-02 17:55:03 +00004909Now
4910 z.n = by [4]
Tim Peters8bb5ad22003-01-24 02:44:45 +00004911 (y + y.s).n = by #5
4912 y.n + y.s = since y.n = x.n
4913 x.n + y.s = since z and y are have the same tzinfo member,
4914 y.s = z.s by #2
4915 x.n + z.s
Tim Petersf3615152003-01-01 21:51:37 +00004916
Tim Petersc5dc4da2003-01-02 17:55:03 +00004917Plugging that back into [6] gives
Tim Petersf3615152003-01-01 21:51:37 +00004918
Tim Petersc5dc4da2003-01-02 17:55:03 +00004919 diff =
Tim Peters8bb5ad22003-01-24 02:44:45 +00004920 x.n - ((x.n + z.s) - z.o) = expanding
4921 x.n - x.n - z.s + z.o = cancelling
4922 - z.s + z.o = by #2
Tim Petersc5dc4da2003-01-02 17:55:03 +00004923 z.d
Tim Petersf3615152003-01-01 21:51:37 +00004924
Tim Petersc5dc4da2003-01-02 17:55:03 +00004925So diff = z.d.
Tim Petersf3615152003-01-01 21:51:37 +00004926
Tim Petersc5dc4da2003-01-02 17:55:03 +00004927If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
Tim Peters8bb5ad22003-01-24 02:44:45 +00004928spelling we wanted in the endcase described above. We're done. Contrarily,
4929if z.d = 0, then we have a UTC equivalent, and are also done.
Tim Petersf3615152003-01-01 21:51:37 +00004930
Tim Petersc5dc4da2003-01-02 17:55:03 +00004931If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
4932add to z (in effect, z is in tz's standard time, and we need to shift the
Tim Peters8bb5ad22003-01-24 02:44:45 +00004933local clock into tz's daylight time).
Tim Petersf3615152003-01-01 21:51:37 +00004934
Tim Petersc5dc4da2003-01-02 17:55:03 +00004935Let
Tim Petersf3615152003-01-01 21:51:37 +00004936
Tim Peters4fede1a2003-01-04 00:26:59 +00004937 z' = z + z.d = z + diff [7]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004938
Tim Peters4fede1a2003-01-04 00:26:59 +00004939and we can again ask whether
Tim Petersc3bb26a2003-01-02 03:14:59 +00004940
Tim Peters8bb5ad22003-01-24 02:44:45 +00004941 z'.n - z'.o = x.n [8]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004942
Tim Peters8bb5ad22003-01-24 02:44:45 +00004943If so, we're done. If not, the tzinfo class is insane, according to the
4944assumptions we've made. This also requires a bit of proof. As before, let's
4945compute the difference between the LHS and RHS of [8] (and skipping some of
4946the justifications for the kinds of substitutions we've done several times
4947already):
Tim Peters4fede1a2003-01-04 00:26:59 +00004948
Tim Peters8bb5ad22003-01-24 02:44:45 +00004949 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
4950 x.n - (z.n + diff - z'.o) = replacing diff via [6]
4951 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
4952 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
4953 - z.n + z.n - z.o + z'.o = cancel z.n
Tim Peters4fede1a2003-01-04 00:26:59 +00004954 - z.o + z'.o = #1 twice
4955 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
4956 z'.d - z.d
4957
4958So 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 +00004959we've found the UTC-equivalent so are done. In fact, we stop with [7] and
4960return z', not bothering to compute z'.d.
Tim Peters4fede1a2003-01-04 00:26:59 +00004961
Tim Peters8bb5ad22003-01-24 02:44:45 +00004962How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
4963a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
4964would have to change the result dst() returns: we start in DST, and moving
4965a little further into it takes us out of DST.
Tim Peters4fede1a2003-01-04 00:26:59 +00004966
Tim Peters8bb5ad22003-01-24 02:44:45 +00004967There isn't a sane case where this can happen. The closest it gets is at
4968the end of DST, where there's an hour in UTC with no spelling in a hybrid
4969tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
4970that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
4971UTC) because the docs insist on that, but 0:MM is taken as being in daylight
4972time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
4973clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
4974standard time. Since that's what the local clock *does*, we want to map both
4975UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
Tim Peters4fede1a2003-01-04 00:26:59 +00004976in local time, but so it goes -- it's the way the local clock works.
4977
Tim Peters8bb5ad22003-01-24 02:44:45 +00004978When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
4979so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
4980z' = 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 +00004981(correctly) concludes that z' is not UTC-equivalent to x.
4982
4983Because we know z.d said z was in daylight time (else [5] would have held and
4984we would have stopped then), and we know z.d != z'.d (else [8] would have held
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00004985and we would have stopped then), and there are only 2 possible values dst() can
Tim Peters4fede1a2003-01-04 00:26:59 +00004986return in Eastern, it follows that z'.d must be 0 (which it is in the example,
4987but the reasoning doesn't depend on the example -- it depends on there being
4988two possible dst() outcomes, one zero and the other non-zero). Therefore
Tim Peters8bb5ad22003-01-24 02:44:45 +00004989z' must be in standard time, and is the spelling we want in this case.
4990
4991Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
4992concerned (because it takes z' as being in standard time rather than the
4993daylight time we intend here), but returning it gives the real-life "local
4994clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
4995tz.
4996
4997When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
4998the 1:MM standard time spelling we want.
4999
5000So how can this break? One of the assumptions must be violated. Two
5001possibilities:
5002
50031) [2] effectively says that y.s is invariant across all y belong to a given
5004 time zone. This isn't true if, for political reasons or continental drift,
5005 a region decides to change its base offset from UTC.
5006
50072) There may be versions of "double daylight" time where the tail end of
5008 the analysis gives up a step too early. I haven't thought about that
5009 enough to say.
5010
5011In any case, it's clear that the default fromutc() is strong enough to handle
5012"almost all" time zones: so long as the standard offset is invariant, it
5013doesn't matter if daylight time transition points change from year to year, or
5014if daylight time is skipped in some years; it doesn't matter how large or
5015small dst() may get within its bounds; and it doesn't even matter if some
5016perverse time zone returns a negative dst()). So a breaking case must be
5017pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
Tim Petersf3615152003-01-01 21:51:37 +00005018--------------------------------------------------------------------------- */