Don't abbreviate ABS, use long name ABSOLUTE.
[python.git] / Modules / datetimemodule.c
blob68231101858790ad9217a7480da1c9c8b4432cff
1 /* C implementation for the date/time type documented at
2 * http://www.zope.org/Members/fdrake/DateTimeWiki/FrontPage
3 */
5 #include "Python.h"
6 #include "modsupport.h"
7 #include "structmember.h"
9 #include <time.h>
11 #include "timefuncs.h"
13 /* Differentiate between building the core module and building extension
14 * modules.
16 #define Py_BUILD_CORE
17 #include "datetime.h"
18 #undef Py_BUILD_CORE
20 /* We require that C int be at least 32 bits, and use int virtually
21 * everywhere. In just a few cases we use a temp long, where a Python
22 * API returns a C long. In such cases, we have to ensure that the
23 * final result fits in a C int (this can be an issue on 64-bit boxes).
25 #if SIZEOF_INT < 4
26 # error "datetime.c requires that C int have at least 32 bits"
27 #endif
29 #define MINYEAR 1
30 #define MAXYEAR 9999
32 /* Nine decimal digits is easy to communicate, and leaves enough room
33 * so that two delta days can be added w/o fear of overflowing a signed
34 * 32-bit int, and with plenty of room left over to absorb any possible
35 * carries from adding seconds.
37 #define MAX_DELTA_DAYS 999999999
39 /* Rename the long macros in datetime.h to more reasonable short names. */
40 #define GET_YEAR PyDateTime_GET_YEAR
41 #define GET_MONTH PyDateTime_GET_MONTH
42 #define GET_DAY PyDateTime_GET_DAY
43 #define DATE_GET_HOUR PyDateTime_DATE_GET_HOUR
44 #define DATE_GET_MINUTE PyDateTime_DATE_GET_MINUTE
45 #define DATE_GET_SECOND PyDateTime_DATE_GET_SECOND
46 #define DATE_GET_MICROSECOND PyDateTime_DATE_GET_MICROSECOND
48 /* Date accessors for date and datetime. */
49 #define SET_YEAR(o, v) (((o)->data[0] = ((v) & 0xff00) >> 8), \
50 ((o)->data[1] = ((v) & 0x00ff)))
51 #define SET_MONTH(o, v) (PyDateTime_GET_MONTH(o) = (v))
52 #define SET_DAY(o, v) (PyDateTime_GET_DAY(o) = (v))
54 /* Date/Time accessors for datetime. */
55 #define DATE_SET_HOUR(o, v) (PyDateTime_DATE_GET_HOUR(o) = (v))
56 #define DATE_SET_MINUTE(o, v) (PyDateTime_DATE_GET_MINUTE(o) = (v))
57 #define DATE_SET_SECOND(o, v) (PyDateTime_DATE_GET_SECOND(o) = (v))
58 #define DATE_SET_MICROSECOND(o, v) \
59 (((o)->data[7] = ((v) & 0xff0000) >> 16), \
60 ((o)->data[8] = ((v) & 0x00ff00) >> 8), \
61 ((o)->data[9] = ((v) & 0x0000ff)))
63 /* Time accessors for time. */
64 #define TIME_GET_HOUR PyDateTime_TIME_GET_HOUR
65 #define TIME_GET_MINUTE PyDateTime_TIME_GET_MINUTE
66 #define TIME_GET_SECOND PyDateTime_TIME_GET_SECOND
67 #define TIME_GET_MICROSECOND PyDateTime_TIME_GET_MICROSECOND
68 #define TIME_SET_HOUR(o, v) (PyDateTime_TIME_GET_HOUR(o) = (v))
69 #define TIME_SET_MINUTE(o, v) (PyDateTime_TIME_GET_MINUTE(o) = (v))
70 #define TIME_SET_SECOND(o, v) (PyDateTime_TIME_GET_SECOND(o) = (v))
71 #define TIME_SET_MICROSECOND(o, v) \
72 (((o)->data[3] = ((v) & 0xff0000) >> 16), \
73 ((o)->data[4] = ((v) & 0x00ff00) >> 8), \
74 ((o)->data[5] = ((v) & 0x0000ff)))
76 /* Delta accessors for timedelta. */
77 #define GET_TD_DAYS(o) (((PyDateTime_Delta *)(o))->days)
78 #define GET_TD_SECONDS(o) (((PyDateTime_Delta *)(o))->seconds)
79 #define GET_TD_MICROSECONDS(o) (((PyDateTime_Delta *)(o))->microseconds)
81 #define SET_TD_DAYS(o, v) ((o)->days = (v))
82 #define SET_TD_SECONDS(o, v) ((o)->seconds = (v))
83 #define SET_TD_MICROSECONDS(o, v) ((o)->microseconds = (v))
85 /* p is a pointer to a time or a datetime object; HASTZINFO(p) returns
86 * p->hastzinfo.
88 #define HASTZINFO(p) (((_PyDateTime_BaseTZInfo *)(p))->hastzinfo)
90 /* M is a char or int claiming to be a valid month. The macro is equivalent
91 * to the two-sided Python test
92 * 1 <= M <= 12
94 #define MONTH_IS_SANE(M) ((unsigned int)(M) - 1 < 12)
96 /* Forward declarations. */
97 static PyTypeObject PyDateTime_DateType;
98 static PyTypeObject PyDateTime_DateTimeType;
99 static PyTypeObject PyDateTime_DeltaType;
100 static PyTypeObject PyDateTime_TimeType;
101 static PyTypeObject PyDateTime_TZInfoType;
103 /* ---------------------------------------------------------------------------
104 * Math utilities.
107 /* k = i+j overflows iff k differs in sign from both inputs,
108 * iff k^i has sign bit set and k^j has sign bit set,
109 * iff (k^i)&(k^j) has sign bit set.
111 #define SIGNED_ADD_OVERFLOWED(RESULT, I, J) \
112 ((((RESULT) ^ (I)) & ((RESULT) ^ (J))) < 0)
114 /* Compute Python divmod(x, y), returning the quotient and storing the
115 * remainder into *r. The quotient is the floor of x/y, and that's
116 * the real point of this. C will probably truncate instead (C99
117 * requires truncation; C89 left it implementation-defined).
118 * Simplification: we *require* that y > 0 here. That's appropriate
119 * for all the uses made of it. This simplifies the code and makes
120 * the overflow case impossible (divmod(LONG_MIN, -1) is the only
121 * overflow case).
123 static int
124 divmod(int x, int y, int *r)
126 int quo;
128 assert(y > 0);
129 quo = x / y;
130 *r = x - quo * y;
131 if (*r < 0) {
132 --quo;
133 *r += y;
135 assert(0 <= *r && *r < y);
136 return quo;
139 /* Round a double to the nearest long. |x| must be small enough to fit
140 * in a C long; this is not checked.
142 static long
143 round_to_long(double x)
145 if (x >= 0.0)
146 x = floor(x + 0.5);
147 else
148 x = ceil(x - 0.5);
149 return (long)x;
152 /* ---------------------------------------------------------------------------
153 * General calendrical helper functions
156 /* For each month ordinal in 1..12, the number of days in that month,
157 * and the number of days before that month in the same year. These
158 * are correct for non-leap years only.
160 static int _days_in_month[] = {
161 0, /* unused; this vector uses 1-based indexing */
162 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
165 static int _days_before_month[] = {
166 0, /* unused; this vector uses 1-based indexing */
167 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
170 /* year -> 1 if leap year, else 0. */
171 static int
172 is_leap(int year)
174 /* Cast year to unsigned. The result is the same either way, but
175 * C can generate faster code for unsigned mod than for signed
176 * mod (especially for % 4 -- a good compiler should just grab
177 * the last 2 bits when the LHS is unsigned).
179 const unsigned int ayear = (unsigned int)year;
180 return ayear % 4 == 0 && (ayear % 100 != 0 || ayear % 400 == 0);
183 /* year, month -> number of days in that month in that year */
184 static int
185 days_in_month(int year, int month)
187 assert(month >= 1);
188 assert(month <= 12);
189 if (month == 2 && is_leap(year))
190 return 29;
191 else
192 return _days_in_month[month];
195 /* year, month -> number of days in year preceeding first day of month */
196 static int
197 days_before_month(int year, int month)
199 int days;
201 assert(month >= 1);
202 assert(month <= 12);
203 days = _days_before_month[month];
204 if (month > 2 && is_leap(year))
205 ++days;
206 return days;
209 /* year -> number of days before January 1st of year. Remember that we
210 * start with year 1, so days_before_year(1) == 0.
212 static int
213 days_before_year(int year)
215 int y = year - 1;
216 /* This is incorrect if year <= 0; we really want the floor
217 * here. But so long as MINYEAR is 1, the smallest year this
218 * can see is 0 (this can happen in some normalization endcases),
219 * so we'll just special-case that.
221 assert (year >= 0);
222 if (y >= 0)
223 return y*365 + y/4 - y/100 + y/400;
224 else {
225 assert(y == -1);
226 return -366;
230 /* Number of days in 4, 100, and 400 year cycles. That these have
231 * the correct values is asserted in the module init function.
233 #define DI4Y 1461 /* days_before_year(5); days in 4 years */
234 #define DI100Y 36524 /* days_before_year(101); days in 100 years */
235 #define DI400Y 146097 /* days_before_year(401); days in 400 years */
237 /* ordinal -> year, month, day, considering 01-Jan-0001 as day 1. */
238 static void
239 ord_to_ymd(int ordinal, int *year, int *month, int *day)
241 int n, n1, n4, n100, n400, leapyear, preceding;
243 /* ordinal is a 1-based index, starting at 1-Jan-1. The pattern of
244 * leap years repeats exactly every 400 years. The basic strategy is
245 * to find the closest 400-year boundary at or before ordinal, then
246 * work with the offset from that boundary to ordinal. Life is much
247 * clearer if we subtract 1 from ordinal first -- then the values
248 * of ordinal at 400-year boundaries are exactly those divisible
249 * by DI400Y:
251 * D M Y n n-1
252 * -- --- ---- ---------- ----------------
253 * 31 Dec -400 -DI400Y -DI400Y -1
254 * 1 Jan -399 -DI400Y +1 -DI400Y 400-year boundary
255 * ...
256 * 30 Dec 000 -1 -2
257 * 31 Dec 000 0 -1
258 * 1 Jan 001 1 0 400-year boundary
259 * 2 Jan 001 2 1
260 * 3 Jan 001 3 2
261 * ...
262 * 31 Dec 400 DI400Y DI400Y -1
263 * 1 Jan 401 DI400Y +1 DI400Y 400-year boundary
265 assert(ordinal >= 1);
266 --ordinal;
267 n400 = ordinal / DI400Y;
268 n = ordinal % DI400Y;
269 *year = n400 * 400 + 1;
271 /* Now n is the (non-negative) offset, in days, from January 1 of
272 * year, to the desired date. Now compute how many 100-year cycles
273 * precede n.
274 * Note that it's possible for n100 to equal 4! In that case 4 full
275 * 100-year cycles precede the desired day, which implies the
276 * desired day is December 31 at the end of a 400-year cycle.
278 n100 = n / DI100Y;
279 n = n % DI100Y;
281 /* Now compute how many 4-year cycles precede it. */
282 n4 = n / DI4Y;
283 n = n % DI4Y;
285 /* And now how many single years. Again n1 can be 4, and again
286 * meaning that the desired day is December 31 at the end of the
287 * 4-year cycle.
289 n1 = n / 365;
290 n = n % 365;
292 *year += n100 * 100 + n4 * 4 + n1;
293 if (n1 == 4 || n100 == 4) {
294 assert(n == 0);
295 *year -= 1;
296 *month = 12;
297 *day = 31;
298 return;
301 /* Now the year is correct, and n is the offset from January 1. We
302 * find the month via an estimate that's either exact or one too
303 * large.
305 leapyear = n1 == 3 && (n4 != 24 || n100 == 3);
306 assert(leapyear == is_leap(*year));
307 *month = (n + 50) >> 5;
308 preceding = (_days_before_month[*month] + (*month > 2 && leapyear));
309 if (preceding > n) {
310 /* estimate is too large */
311 *month -= 1;
312 preceding -= days_in_month(*year, *month);
314 n -= preceding;
315 assert(0 <= n);
316 assert(n < days_in_month(*year, *month));
318 *day = n + 1;
321 /* year, month, day -> ordinal, considering 01-Jan-0001 as day 1. */
322 static int
323 ymd_to_ord(int year, int month, int day)
325 return days_before_year(year) + days_before_month(year, month) + day;
328 /* Day of week, where Monday==0, ..., Sunday==6. 1/1/1 was a Monday. */
329 static int
330 weekday(int year, int month, int day)
332 return (ymd_to_ord(year, month, day) + 6) % 7;
335 /* Ordinal of the Monday starting week 1 of the ISO year. Week 1 is the
336 * first calendar week containing a Thursday.
338 static int
339 iso_week1_monday(int year)
341 int first_day = ymd_to_ord(year, 1, 1); /* ord of 1/1 */
342 /* 0 if 1/1 is a Monday, 1 if a Tue, etc. */
343 int first_weekday = (first_day + 6) % 7;
344 /* ordinal of closest Monday at or before 1/1 */
345 int week1_monday = first_day - first_weekday;
347 if (first_weekday > 3) /* if 1/1 was Fri, Sat, Sun */
348 week1_monday += 7;
349 return week1_monday;
352 /* ---------------------------------------------------------------------------
353 * Range checkers.
356 /* Check that -MAX_DELTA_DAYS <= days <= MAX_DELTA_DAYS. If so, return 0.
357 * If not, raise OverflowError and return -1.
359 static int
360 check_delta_day_range(int days)
362 if (-MAX_DELTA_DAYS <= days && days <= MAX_DELTA_DAYS)
363 return 0;
364 PyErr_Format(PyExc_OverflowError,
365 "days=%d; must have magnitude <= %d",
366 days, MAX_DELTA_DAYS);
367 return -1;
370 /* Check that date arguments are in range. Return 0 if they are. If they
371 * aren't, raise ValueError and return -1.
373 static int
374 check_date_args(int year, int month, int day)
377 if (year < MINYEAR || year > MAXYEAR) {
378 PyErr_SetString(PyExc_ValueError,
379 "year is out of range");
380 return -1;
382 if (month < 1 || month > 12) {
383 PyErr_SetString(PyExc_ValueError,
384 "month must be in 1..12");
385 return -1;
387 if (day < 1 || day > days_in_month(year, month)) {
388 PyErr_SetString(PyExc_ValueError,
389 "day is out of range for month");
390 return -1;
392 return 0;
395 /* Check that time arguments are in range. Return 0 if they are. If they
396 * aren't, raise ValueError and return -1.
398 static int
399 check_time_args(int h, int m, int s, int us)
401 if (h < 0 || h > 23) {
402 PyErr_SetString(PyExc_ValueError,
403 "hour must be in 0..23");
404 return -1;
406 if (m < 0 || m > 59) {
407 PyErr_SetString(PyExc_ValueError,
408 "minute must be in 0..59");
409 return -1;
411 if (s < 0 || s > 59) {
412 PyErr_SetString(PyExc_ValueError,
413 "second must be in 0..59");
414 return -1;
416 if (us < 0 || us > 999999) {
417 PyErr_SetString(PyExc_ValueError,
418 "microsecond must be in 0..999999");
419 return -1;
421 return 0;
424 /* ---------------------------------------------------------------------------
425 * Normalization utilities.
428 /* One step of a mixed-radix conversion. A "hi" unit is equivalent to
429 * factor "lo" units. factor must be > 0. If *lo is less than 0, or
430 * at least factor, enough of *lo is converted into "hi" units so that
431 * 0 <= *lo < factor. The input values must be such that int overflow
432 * is impossible.
434 static void
435 normalize_pair(int *hi, int *lo, int factor)
437 assert(factor > 0);
438 assert(lo != hi);
439 if (*lo < 0 || *lo >= factor) {
440 const int num_hi = divmod(*lo, factor, lo);
441 const int new_hi = *hi + num_hi;
442 assert(! SIGNED_ADD_OVERFLOWED(new_hi, *hi, num_hi));
443 *hi = new_hi;
445 assert(0 <= *lo && *lo < factor);
448 /* Fiddle days (d), seconds (s), and microseconds (us) so that
449 * 0 <= *s < 24*3600
450 * 0 <= *us < 1000000
451 * The input values must be such that the internals don't overflow.
452 * The way this routine is used, we don't get close.
454 static void
455 normalize_d_s_us(int *d, int *s, int *us)
457 if (*us < 0 || *us >= 1000000) {
458 normalize_pair(s, us, 1000000);
459 /* |s| can't be bigger than about
460 * |original s| + |original us|/1000000 now.
464 if (*s < 0 || *s >= 24*3600) {
465 normalize_pair(d, s, 24*3600);
466 /* |d| can't be bigger than about
467 * |original d| +
468 * (|original s| + |original us|/1000000) / (24*3600) now.
471 assert(0 <= *s && *s < 24*3600);
472 assert(0 <= *us && *us < 1000000);
475 /* Fiddle years (y), months (m), and days (d) so that
476 * 1 <= *m <= 12
477 * 1 <= *d <= days_in_month(*y, *m)
478 * The input values must be such that the internals don't overflow.
479 * The way this routine is used, we don't get close.
481 static void
482 normalize_y_m_d(int *y, int *m, int *d)
484 int dim; /* # of days in month */
486 /* This gets muddy: the proper range for day can't be determined
487 * without knowing the correct month and year, but if day is, e.g.,
488 * plus or minus a million, the current month and year values make
489 * no sense (and may also be out of bounds themselves).
490 * Saying 12 months == 1 year should be non-controversial.
492 if (*m < 1 || *m > 12) {
493 --*m;
494 normalize_pair(y, m, 12);
495 ++*m;
496 /* |y| can't be bigger than about
497 * |original y| + |original m|/12 now.
500 assert(1 <= *m && *m <= 12);
502 /* Now only day can be out of bounds (year may also be out of bounds
503 * for a datetime object, but we don't care about that here).
504 * If day is out of bounds, what to do is arguable, but at least the
505 * method here is principled and explainable.
507 dim = days_in_month(*y, *m);
508 if (*d < 1 || *d > dim) {
509 /* Move day-1 days from the first of the month. First try to
510 * get off cheap if we're only one day out of range
511 * (adjustments for timezone alone can't be worse than that).
513 if (*d == 0) {
514 --*m;
515 if (*m > 0)
516 *d = days_in_month(*y, *m);
517 else {
518 --*y;
519 *m = 12;
520 *d = 31;
523 else if (*d == dim + 1) {
524 /* move forward a day */
525 ++*m;
526 *d = 1;
527 if (*m > 12) {
528 *m = 1;
529 ++*y;
532 else {
533 int ordinal = ymd_to_ord(*y, *m, 1) +
534 *d - 1;
535 ord_to_ymd(ordinal, y, m, d);
538 assert(*m > 0);
539 assert(*d > 0);
542 /* Fiddle out-of-bounds months and days so that the result makes some kind
543 * of sense. The parameters are both inputs and outputs. Returns < 0 on
544 * failure, where failure means the adjusted year is out of bounds.
546 static int
547 normalize_date(int *year, int *month, int *day)
549 int result;
551 normalize_y_m_d(year, month, day);
552 if (MINYEAR <= *year && *year <= MAXYEAR)
553 result = 0;
554 else {
555 PyErr_SetString(PyExc_OverflowError,
556 "date value out of range");
557 result = -1;
559 return result;
562 /* Force all the datetime fields into range. The parameters are both
563 * inputs and outputs. Returns < 0 on error.
565 static int
566 normalize_datetime(int *year, int *month, int *day,
567 int *hour, int *minute, int *second,
568 int *microsecond)
570 normalize_pair(second, microsecond, 1000000);
571 normalize_pair(minute, second, 60);
572 normalize_pair(hour, minute, 60);
573 normalize_pair(day, hour, 24);
574 return normalize_date(year, month, day);
577 /* ---------------------------------------------------------------------------
578 * Basic object allocation: tp_alloc implementations. These allocate
579 * Python objects of the right size and type, and do the Python object-
580 * initialization bit. If there's not enough memory, they return NULL after
581 * setting MemoryError. All data members remain uninitialized trash.
583 * We abuse the tp_alloc "nitems" argument to communicate whether a tzinfo
584 * member is needed. This is ugly, imprecise, and possibly insecure.
585 * tp_basicsize for the time and datetime types is set to the size of the
586 * struct that has room for the tzinfo member, so subclasses in Python will
587 * allocate enough space for a tzinfo member whether or not one is actually
588 * needed. That's the "ugly and imprecise" parts. The "possibly insecure"
589 * part is that PyType_GenericAlloc() (which subclasses in Python end up
590 * using) just happens today to effectively ignore the nitems argument
591 * when tp_itemsize is 0, which it is for these type objects. If that
592 * changes, perhaps the callers of tp_alloc slots in this file should
593 * be changed to force a 0 nitems argument unless the type being allocated
594 * is a base type implemented in this file (so that tp_alloc is time_alloc
595 * or datetime_alloc below, which know about the nitems abuse).
598 static PyObject *
599 time_alloc(PyTypeObject *type, Py_ssize_t aware)
601 PyObject *self;
603 self = (PyObject *)
604 PyObject_MALLOC(aware ?
605 sizeof(PyDateTime_Time) :
606 sizeof(_PyDateTime_BaseTime));
607 if (self == NULL)
608 return (PyObject *)PyErr_NoMemory();
609 PyObject_INIT(self, type);
610 return self;
613 static PyObject *
614 datetime_alloc(PyTypeObject *type, Py_ssize_t aware)
616 PyObject *self;
618 self = (PyObject *)
619 PyObject_MALLOC(aware ?
620 sizeof(PyDateTime_DateTime) :
621 sizeof(_PyDateTime_BaseDateTime));
622 if (self == NULL)
623 return (PyObject *)PyErr_NoMemory();
624 PyObject_INIT(self, type);
625 return self;
628 /* ---------------------------------------------------------------------------
629 * Helpers for setting object fields. These work on pointers to the
630 * appropriate base class.
633 /* For date and datetime. */
634 static void
635 set_date_fields(PyDateTime_Date *self, int y, int m, int d)
637 self->hashcode = -1;
638 SET_YEAR(self, y);
639 SET_MONTH(self, m);
640 SET_DAY(self, d);
643 /* ---------------------------------------------------------------------------
644 * Create various objects, mostly without range checking.
647 /* Create a date instance with no range checking. */
648 static PyObject *
649 new_date_ex(int year, int month, int day, PyTypeObject *type)
651 PyDateTime_Date *self;
653 self = (PyDateTime_Date *) (type->tp_alloc(type, 0));
654 if (self != NULL)
655 set_date_fields(self, year, month, day);
656 return (PyObject *) self;
659 #define new_date(year, month, day) \
660 new_date_ex(year, month, day, &PyDateTime_DateType)
662 /* Create a datetime instance with no range checking. */
663 static PyObject *
664 new_datetime_ex(int year, int month, int day, int hour, int minute,
665 int second, int usecond, PyObject *tzinfo, PyTypeObject *type)
667 PyDateTime_DateTime *self;
668 char aware = tzinfo != Py_None;
670 self = (PyDateTime_DateTime *) (type->tp_alloc(type, aware));
671 if (self != NULL) {
672 self->hastzinfo = aware;
673 set_date_fields((PyDateTime_Date *)self, year, month, day);
674 DATE_SET_HOUR(self, hour);
675 DATE_SET_MINUTE(self, minute);
676 DATE_SET_SECOND(self, second);
677 DATE_SET_MICROSECOND(self, usecond);
678 if (aware) {
679 Py_INCREF(tzinfo);
680 self->tzinfo = tzinfo;
683 return (PyObject *)self;
686 #define new_datetime(y, m, d, hh, mm, ss, us, tzinfo) \
687 new_datetime_ex(y, m, d, hh, mm, ss, us, tzinfo, \
688 &PyDateTime_DateTimeType)
690 /* Create a time instance with no range checking. */
691 static PyObject *
692 new_time_ex(int hour, int minute, int second, int usecond,
693 PyObject *tzinfo, PyTypeObject *type)
695 PyDateTime_Time *self;
696 char aware = tzinfo != Py_None;
698 self = (PyDateTime_Time *) (type->tp_alloc(type, aware));
699 if (self != NULL) {
700 self->hastzinfo = aware;
701 self->hashcode = -1;
702 TIME_SET_HOUR(self, hour);
703 TIME_SET_MINUTE(self, minute);
704 TIME_SET_SECOND(self, second);
705 TIME_SET_MICROSECOND(self, usecond);
706 if (aware) {
707 Py_INCREF(tzinfo);
708 self->tzinfo = tzinfo;
711 return (PyObject *)self;
714 #define new_time(hh, mm, ss, us, tzinfo) \
715 new_time_ex(hh, mm, ss, us, tzinfo, &PyDateTime_TimeType)
717 /* Create a timedelta instance. Normalize the members iff normalize is
718 * true. Passing false is a speed optimization, if you know for sure
719 * that seconds and microseconds are already in their proper ranges. In any
720 * case, raises OverflowError and returns NULL if the normalized days is out
721 * of range).
723 static PyObject *
724 new_delta_ex(int days, int seconds, int microseconds, int normalize,
725 PyTypeObject *type)
727 PyDateTime_Delta *self;
729 if (normalize)
730 normalize_d_s_us(&days, &seconds, &microseconds);
731 assert(0 <= seconds && seconds < 24*3600);
732 assert(0 <= microseconds && microseconds < 1000000);
734 if (check_delta_day_range(days) < 0)
735 return NULL;
737 self = (PyDateTime_Delta *) (type->tp_alloc(type, 0));
738 if (self != NULL) {
739 self->hashcode = -1;
740 SET_TD_DAYS(self, days);
741 SET_TD_SECONDS(self, seconds);
742 SET_TD_MICROSECONDS(self, microseconds);
744 return (PyObject *) self;
747 #define new_delta(d, s, us, normalize) \
748 new_delta_ex(d, s, us, normalize, &PyDateTime_DeltaType)
750 /* ---------------------------------------------------------------------------
751 * tzinfo helpers.
754 /* Ensure that p is None or of a tzinfo subclass. Return 0 if OK; if not
755 * raise TypeError and return -1.
757 static int
758 check_tzinfo_subclass(PyObject *p)
760 if (p == Py_None || PyTZInfo_Check(p))
761 return 0;
762 PyErr_Format(PyExc_TypeError,
763 "tzinfo argument must be None or of a tzinfo subclass, "
764 "not type '%s'",
765 p->ob_type->tp_name);
766 return -1;
769 /* Return tzinfo.methname(tzinfoarg), without any checking of results.
770 * If tzinfo is None, returns None.
772 static PyObject *
773 call_tzinfo_method(PyObject *tzinfo, char *methname, PyObject *tzinfoarg)
775 PyObject *result;
777 assert(tzinfo && methname && tzinfoarg);
778 assert(check_tzinfo_subclass(tzinfo) >= 0);
779 if (tzinfo == Py_None) {
780 result = Py_None;
781 Py_INCREF(result);
783 else
784 result = PyObject_CallMethod(tzinfo, methname, "O", tzinfoarg);
785 return result;
788 /* If self has a tzinfo member, return a BORROWED reference to it. Else
789 * return NULL, which is NOT AN ERROR. There are no error returns here,
790 * and the caller must not decref the result.
792 static PyObject *
793 get_tzinfo_member(PyObject *self)
795 PyObject *tzinfo = NULL;
797 if (PyDateTime_Check(self) && HASTZINFO(self))
798 tzinfo = ((PyDateTime_DateTime *)self)->tzinfo;
799 else if (PyTime_Check(self) && HASTZINFO(self))
800 tzinfo = ((PyDateTime_Time *)self)->tzinfo;
802 return tzinfo;
805 /* Call getattr(tzinfo, name)(tzinfoarg), and extract an int from the
806 * result. tzinfo must be an instance of the tzinfo class. If the method
807 * returns None, this returns 0 and sets *none to 1. If the method doesn't
808 * return None or timedelta, TypeError is raised and this returns -1. If it
809 * returnsa timedelta and the value is out of range or isn't a whole number
810 * of minutes, ValueError is raised and this returns -1.
811 * Else *none is set to 0 and the integer method result is returned.
813 static int
814 call_utc_tzinfo_method(PyObject *tzinfo, char *name, PyObject *tzinfoarg,
815 int *none)
817 PyObject *u;
818 int result = -1;
820 assert(tzinfo != NULL);
821 assert(PyTZInfo_Check(tzinfo));
822 assert(tzinfoarg != NULL);
824 *none = 0;
825 u = call_tzinfo_method(tzinfo, name, tzinfoarg);
826 if (u == NULL)
827 return -1;
829 else if (u == Py_None) {
830 result = 0;
831 *none = 1;
833 else if (PyDelta_Check(u)) {
834 const int days = GET_TD_DAYS(u);
835 if (days < -1 || days > 0)
836 result = 24*60; /* trigger ValueError below */
837 else {
838 /* next line can't overflow because we know days
839 * is -1 or 0 now
841 int ss = days * 24 * 3600 + GET_TD_SECONDS(u);
842 result = divmod(ss, 60, &ss);
843 if (ss || GET_TD_MICROSECONDS(u)) {
844 PyErr_Format(PyExc_ValueError,
845 "tzinfo.%s() must return a "
846 "whole number of minutes",
847 name);
848 result = -1;
852 else {
853 PyErr_Format(PyExc_TypeError,
854 "tzinfo.%s() must return None or "
855 "timedelta, not '%s'",
856 name, u->ob_type->tp_name);
859 Py_DECREF(u);
860 if (result < -1439 || result > 1439) {
861 PyErr_Format(PyExc_ValueError,
862 "tzinfo.%s() returned %d; must be in "
863 "-1439 .. 1439",
864 name, result);
865 result = -1;
867 return result;
870 /* Call tzinfo.utcoffset(tzinfoarg), and extract an integer from the
871 * result. tzinfo must be an instance of the tzinfo class. If utcoffset()
872 * returns None, call_utcoffset returns 0 and sets *none to 1. If uctoffset()
873 * doesn't return None or timedelta, TypeError is raised and this returns -1.
874 * If utcoffset() returns an invalid timedelta (out of range, or not a whole
875 * # of minutes), ValueError is raised and this returns -1. Else *none is
876 * set to 0 and the offset is returned (as int # of minutes east of UTC).
878 static int
879 call_utcoffset(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
881 return call_utc_tzinfo_method(tzinfo, "utcoffset", tzinfoarg, none);
884 /* Call tzinfo.name(tzinfoarg), and return the offset as a timedelta or None.
886 static PyObject *
887 offset_as_timedelta(PyObject *tzinfo, char *name, PyObject *tzinfoarg) {
888 PyObject *result;
890 assert(tzinfo && name && tzinfoarg);
891 if (tzinfo == Py_None) {
892 result = Py_None;
893 Py_INCREF(result);
895 else {
896 int none;
897 int offset = call_utc_tzinfo_method(tzinfo, name, tzinfoarg,
898 &none);
899 if (offset < 0 && PyErr_Occurred())
900 return NULL;
901 if (none) {
902 result = Py_None;
903 Py_INCREF(result);
905 else
906 result = new_delta(0, offset * 60, 0, 1);
908 return result;
911 /* Call tzinfo.dst(tzinfoarg), and extract an integer from the
912 * result. tzinfo must be an instance of the tzinfo class. If dst()
913 * returns None, call_dst returns 0 and sets *none to 1. If dst()
914 & doesn't return None or timedelta, TypeError is raised and this
915 * returns -1. If dst() returns an invalid timedelta for a UTC offset,
916 * ValueError is raised and this returns -1. Else *none is set to 0 and
917 * the offset is returned (as an int # of minutes east of UTC).
919 static int
920 call_dst(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
922 return call_utc_tzinfo_method(tzinfo, "dst", tzinfoarg, none);
925 /* Call tzinfo.tzname(tzinfoarg), and return the result. tzinfo must be
926 * an instance of the tzinfo class or None. If tzinfo isn't None, and
927 * tzname() doesn't return None or a string, TypeError is raised and this
928 * returns NULL.
930 static PyObject *
931 call_tzname(PyObject *tzinfo, PyObject *tzinfoarg)
933 PyObject *result;
935 assert(tzinfo != NULL);
936 assert(check_tzinfo_subclass(tzinfo) >= 0);
937 assert(tzinfoarg != NULL);
939 if (tzinfo == Py_None) {
940 result = Py_None;
941 Py_INCREF(result);
943 else
944 result = PyObject_CallMethod(tzinfo, "tzname", "O", tzinfoarg);
946 if (result != NULL && result != Py_None && ! PyString_Check(result)) {
947 PyErr_Format(PyExc_TypeError, "tzinfo.tzname() must "
948 "return None or a string, not '%s'",
949 result->ob_type->tp_name);
950 Py_DECREF(result);
951 result = NULL;
953 return result;
956 typedef enum {
957 /* an exception has been set; the caller should pass it on */
958 OFFSET_ERROR,
960 /* type isn't date, datetime, or time subclass */
961 OFFSET_UNKNOWN,
963 /* date,
964 * datetime with !hastzinfo
965 * datetime with None tzinfo,
966 * datetime where utcoffset() returns None
967 * time with !hastzinfo
968 * time with None tzinfo,
969 * time where utcoffset() returns None
971 OFFSET_NAIVE,
973 /* time or datetime where utcoffset() doesn't return None */
974 OFFSET_AWARE
975 } naivety;
977 /* Classify an object as to whether it's naive or offset-aware. See
978 * the "naivety" typedef for details. If the type is aware, *offset is set
979 * to minutes east of UTC (as returned by the tzinfo.utcoffset() method).
980 * If the type is offset-naive (or unknown, or error), *offset is set to 0.
981 * tzinfoarg is the argument to pass to the tzinfo.utcoffset() method.
983 static naivety
984 classify_utcoffset(PyObject *op, PyObject *tzinfoarg, int *offset)
986 int none;
987 PyObject *tzinfo;
989 assert(tzinfoarg != NULL);
990 *offset = 0;
991 tzinfo = get_tzinfo_member(op); /* NULL means no tzinfo, not error */
992 if (tzinfo == Py_None)
993 return OFFSET_NAIVE;
994 if (tzinfo == NULL) {
995 /* note that a datetime passes the PyDate_Check test */
996 return (PyTime_Check(op) || PyDate_Check(op)) ?
997 OFFSET_NAIVE : OFFSET_UNKNOWN;
999 *offset = call_utcoffset(tzinfo, tzinfoarg, &none);
1000 if (*offset == -1 && PyErr_Occurred())
1001 return OFFSET_ERROR;
1002 return none ? OFFSET_NAIVE : OFFSET_AWARE;
1005 /* Classify two objects as to whether they're naive or offset-aware.
1006 * This isn't quite the same as calling classify_utcoffset() twice: for
1007 * binary operations (comparison and subtraction), we generally want to
1008 * ignore the tzinfo members if they're identical. This is by design,
1009 * so that results match "naive" expectations when mixing objects from a
1010 * single timezone. So in that case, this sets both offsets to 0 and
1011 * both naiveties to OFFSET_NAIVE.
1012 * The function returns 0 if everything's OK, and -1 on error.
1014 static int
1015 classify_two_utcoffsets(PyObject *o1, int *offset1, naivety *n1,
1016 PyObject *tzinfoarg1,
1017 PyObject *o2, int *offset2, naivety *n2,
1018 PyObject *tzinfoarg2)
1020 if (get_tzinfo_member(o1) == get_tzinfo_member(o2)) {
1021 *offset1 = *offset2 = 0;
1022 *n1 = *n2 = OFFSET_NAIVE;
1024 else {
1025 *n1 = classify_utcoffset(o1, tzinfoarg1, offset1);
1026 if (*n1 == OFFSET_ERROR)
1027 return -1;
1028 *n2 = classify_utcoffset(o2, tzinfoarg2, offset2);
1029 if (*n2 == OFFSET_ERROR)
1030 return -1;
1032 return 0;
1035 /* repr is like "someclass(arg1, arg2)". If tzinfo isn't None,
1036 * stuff
1037 * ", tzinfo=" + repr(tzinfo)
1038 * before the closing ")".
1040 static PyObject *
1041 append_keyword_tzinfo(PyObject *repr, PyObject *tzinfo)
1043 PyObject *temp;
1045 assert(PyString_Check(repr));
1046 assert(tzinfo);
1047 if (tzinfo == Py_None)
1048 return repr;
1049 /* Get rid of the trailing ')'. */
1050 assert(PyString_AsString(repr)[PyString_Size(repr)-1] == ')');
1051 temp = PyString_FromStringAndSize(PyString_AsString(repr),
1052 PyString_Size(repr) - 1);
1053 Py_DECREF(repr);
1054 if (temp == NULL)
1055 return NULL;
1056 repr = temp;
1058 /* Append ", tzinfo=". */
1059 PyString_ConcatAndDel(&repr, PyString_FromString(", tzinfo="));
1061 /* Append repr(tzinfo). */
1062 PyString_ConcatAndDel(&repr, PyObject_Repr(tzinfo));
1064 /* Add a closing paren. */
1065 PyString_ConcatAndDel(&repr, PyString_FromString(")"));
1066 return repr;
1069 /* ---------------------------------------------------------------------------
1070 * String format helpers.
1073 static PyObject *
1074 format_ctime(PyDateTime_Date *date, int hours, int minutes, int seconds)
1076 static const char *DayNames[] = {
1077 "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"
1079 static const char *MonthNames[] = {
1080 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1081 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
1084 char buffer[128];
1085 int wday = weekday(GET_YEAR(date), GET_MONTH(date), GET_DAY(date));
1087 PyOS_snprintf(buffer, sizeof(buffer), "%s %s %2d %02d:%02d:%02d %04d",
1088 DayNames[wday], MonthNames[GET_MONTH(date) - 1],
1089 GET_DAY(date), hours, minutes, seconds,
1090 GET_YEAR(date));
1091 return PyString_FromString(buffer);
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.
1104 static int
1105 format_utcoffset(char *buf, size_t buflen, const char *sep,
1106 PyObject *tzinfo, PyObject *tzinfoarg)
1108 int offset;
1109 int hours;
1110 int minutes;
1111 char sign;
1112 int none;
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;
1121 sign = '+';
1122 if (offset < 0) {
1123 sign = '-';
1124 offset = - offset;
1126 hours = divmod(offset, 60, &minutes);
1127 PyOS_snprintf(buf, buflen, "%c%02d%s%02d", sign, hours, sep, minutes);
1128 return 0;
1131 /* I sure don't want to reproduce the strftime code from the time module,
1132 * so this imports the module and calls it. All the hair is due to
1133 * giving special meanings to the %z and %Z format codes via a preprocessing
1134 * step on the format string.
1135 * tzinfoarg is the argument to pass to the object's tzinfo method, if
1136 * needed.
1138 static PyObject *
1139 wrap_strftime(PyObject *object, PyObject *format, PyObject *timetuple,
1140 PyObject *tzinfoarg)
1142 PyObject *result = NULL; /* guilty until proved innocent */
1144 PyObject *zreplacement = NULL; /* py string, replacement for %z */
1145 PyObject *Zreplacement = NULL; /* py string, replacement for %Z */
1147 char *pin; /* pointer to next char in input format */
1148 char ch; /* next char in input format */
1150 PyObject *newfmt = NULL; /* py string, the output format */
1151 char *pnew; /* pointer to available byte in output format */
1152 char totalnew; /* number bytes total in output format buffer,
1153 exclusive of trailing \0 */
1154 char usednew; /* number bytes used so far in output format buffer */
1156 char *ptoappend; /* pointer to string to append to output buffer */
1157 int ntoappend; /* # of bytes to append to output buffer */
1159 assert(object && format && timetuple);
1160 assert(PyString_Check(format));
1162 /* Give up if the year is before 1900.
1163 * Python strftime() plays games with the year, and different
1164 * games depending on whether envar PYTHON2K is set. This makes
1165 * years before 1900 a nightmare, even if the platform strftime
1166 * supports them (and not all do).
1167 * We could get a lot farther here by avoiding Python's strftime
1168 * wrapper and calling the C strftime() directly, but that isn't
1169 * an option in the Python implementation of this module.
1172 long year;
1173 PyObject *pyyear = PySequence_GetItem(timetuple, 0);
1174 if (pyyear == NULL) return NULL;
1175 assert(PyInt_Check(pyyear));
1176 year = PyInt_AsLong(pyyear);
1177 Py_DECREF(pyyear);
1178 if (year < 1900) {
1179 PyErr_Format(PyExc_ValueError, "year=%ld is before "
1180 "1900; the datetime strftime() "
1181 "methods require year >= 1900",
1182 year);
1183 return NULL;
1187 /* Scan the input format, looking for %z and %Z escapes, building
1188 * a new format. Since computing the replacements for those codes
1189 * is expensive, don't unless they're actually used.
1191 totalnew = PyString_Size(format) + 1; /* realistic if no %z/%Z */
1192 newfmt = PyString_FromStringAndSize(NULL, totalnew);
1193 if (newfmt == NULL) goto Done;
1194 pnew = PyString_AsString(newfmt);
1195 usednew = 0;
1197 pin = PyString_AsString(format);
1198 while ((ch = *pin++) != '\0') {
1199 if (ch != '%') {
1200 ptoappend = pin - 1;
1201 ntoappend = 1;
1203 else if ((ch = *pin++) == '\0') {
1204 /* There's a lone trailing %; doesn't make sense. */
1205 PyErr_SetString(PyExc_ValueError, "strftime format "
1206 "ends with raw %");
1207 goto Done;
1209 /* A % has been seen and ch is the character after it. */
1210 else if (ch == 'z') {
1211 if (zreplacement == NULL) {
1212 /* format utcoffset */
1213 char buf[100];
1214 PyObject *tzinfo = get_tzinfo_member(object);
1215 zreplacement = PyString_FromString("");
1216 if (zreplacement == NULL) goto Done;
1217 if (tzinfo != Py_None && tzinfo != NULL) {
1218 assert(tzinfoarg != NULL);
1219 if (format_utcoffset(buf,
1220 sizeof(buf),
1222 tzinfo,
1223 tzinfoarg) < 0)
1224 goto Done;
1225 Py_DECREF(zreplacement);
1226 zreplacement = PyString_FromString(buf);
1227 if (zreplacement == NULL) goto Done;
1230 assert(zreplacement != NULL);
1231 ptoappend = PyString_AS_STRING(zreplacement);
1232 ntoappend = PyString_GET_SIZE(zreplacement);
1234 else if (ch == 'Z') {
1235 /* format tzname */
1236 if (Zreplacement == NULL) {
1237 PyObject *tzinfo = get_tzinfo_member(object);
1238 Zreplacement = PyString_FromString("");
1239 if (Zreplacement == NULL) goto Done;
1240 if (tzinfo != Py_None && tzinfo != NULL) {
1241 PyObject *temp;
1242 assert(tzinfoarg != NULL);
1243 temp = call_tzname(tzinfo, tzinfoarg);
1244 if (temp == NULL) goto Done;
1245 if (temp != Py_None) {
1246 assert(PyString_Check(temp));
1247 /* Since the tzname is getting
1248 * stuffed into the format, we
1249 * have to double any % signs
1250 * so that strftime doesn't
1251 * treat them as format codes.
1253 Py_DECREF(Zreplacement);
1254 Zreplacement = PyObject_CallMethod(
1255 temp, "replace",
1256 "ss", "%", "%%");
1257 Py_DECREF(temp);
1258 if (Zreplacement == NULL)
1259 goto Done;
1260 if (!PyString_Check(Zreplacement)) {
1261 PyErr_SetString(PyExc_TypeError, "tzname.replace() did not return a string");
1262 goto Done;
1265 else
1266 Py_DECREF(temp);
1269 assert(Zreplacement != NULL);
1270 ptoappend = PyString_AS_STRING(Zreplacement);
1271 ntoappend = PyString_GET_SIZE(Zreplacement);
1273 else {
1274 /* percent followed by neither z nor Z */
1275 ptoappend = pin - 2;
1276 ntoappend = 2;
1279 /* Append the ntoappend chars starting at ptoappend to
1280 * the new format.
1282 assert(ptoappend != NULL);
1283 assert(ntoappend >= 0);
1284 if (ntoappend == 0)
1285 continue;
1286 while (usednew + ntoappend > totalnew) {
1287 int bigger = totalnew << 1;
1288 if ((bigger >> 1) != totalnew) { /* overflow */
1289 PyErr_NoMemory();
1290 goto Done;
1292 if (_PyString_Resize(&newfmt, bigger) < 0)
1293 goto Done;
1294 totalnew = bigger;
1295 pnew = PyString_AsString(newfmt) + usednew;
1297 memcpy(pnew, ptoappend, ntoappend);
1298 pnew += ntoappend;
1299 usednew += ntoappend;
1300 assert(usednew <= totalnew);
1301 } /* end while() */
1303 if (_PyString_Resize(&newfmt, usednew) < 0)
1304 goto Done;
1306 PyObject *time = PyImport_ImportModule("time");
1307 if (time == NULL)
1308 goto Done;
1309 result = PyObject_CallMethod(time, "strftime", "OO",
1310 newfmt, timetuple);
1311 Py_DECREF(time);
1313 Done:
1314 Py_XDECREF(zreplacement);
1315 Py_XDECREF(Zreplacement);
1316 Py_XDECREF(newfmt);
1317 return result;
1320 static char *
1321 isoformat_date(PyDateTime_Date *dt, char buffer[], int bufflen)
1323 int x;
1324 x = PyOS_snprintf(buffer, bufflen,
1325 "%04d-%02d-%02d",
1326 GET_YEAR(dt), GET_MONTH(dt), GET_DAY(dt));
1327 return buffer + x;
1330 static void
1331 isoformat_time(PyDateTime_DateTime *dt, char buffer[], int bufflen)
1333 int us = DATE_GET_MICROSECOND(dt);
1335 PyOS_snprintf(buffer, bufflen,
1336 "%02d:%02d:%02d", /* 8 characters */
1337 DATE_GET_HOUR(dt),
1338 DATE_GET_MINUTE(dt),
1339 DATE_GET_SECOND(dt));
1340 if (us)
1341 PyOS_snprintf(buffer + 8, bufflen - 8, ".%06d", us);
1344 /* ---------------------------------------------------------------------------
1345 * Wrap functions from the time module. These aren't directly available
1346 * from C. Perhaps they should be.
1349 /* Call time.time() and return its result (a Python float). */
1350 static PyObject *
1351 time_time(void)
1353 PyObject *result = NULL;
1354 PyObject *time = PyImport_ImportModule("time");
1356 if (time != NULL) {
1357 result = PyObject_CallMethod(time, "time", "()");
1358 Py_DECREF(time);
1360 return result;
1363 /* Build a time.struct_time. The weekday and day number are automatically
1364 * computed from the y,m,d args.
1366 static PyObject *
1367 build_struct_time(int y, int m, int d, int hh, int mm, int ss, int dstflag)
1369 PyObject *time;
1370 PyObject *result = NULL;
1372 time = PyImport_ImportModule("time");
1373 if (time != NULL) {
1374 result = PyObject_CallMethod(time, "struct_time",
1375 "((iiiiiiiii))",
1376 y, m, d,
1377 hh, mm, ss,
1378 weekday(y, m, d),
1379 days_before_month(y, m) + d,
1380 dstflag);
1381 Py_DECREF(time);
1383 return result;
1386 /* ---------------------------------------------------------------------------
1387 * Miscellaneous helpers.
1390 /* For obscure reasons, we need to use tp_richcompare instead of tp_compare.
1391 * The comparisons here all most naturally compute a cmp()-like result.
1392 * This little helper turns that into a bool result for rich comparisons.
1394 static PyObject *
1395 diff_to_bool(int diff, int op)
1397 PyObject *result;
1398 int istrue;
1400 switch (op) {
1401 case Py_EQ: istrue = diff == 0; break;
1402 case Py_NE: istrue = diff != 0; break;
1403 case Py_LE: istrue = diff <= 0; break;
1404 case Py_GE: istrue = diff >= 0; break;
1405 case Py_LT: istrue = diff < 0; break;
1406 case Py_GT: istrue = diff > 0; break;
1407 default:
1408 assert(! "op unknown");
1409 istrue = 0; /* To shut up compiler */
1411 result = istrue ? Py_True : Py_False;
1412 Py_INCREF(result);
1413 return result;
1416 /* Raises a "can't compare" TypeError and returns NULL. */
1417 static PyObject *
1418 cmperror(PyObject *a, PyObject *b)
1420 PyErr_Format(PyExc_TypeError,
1421 "can't compare %s to %s",
1422 a->ob_type->tp_name, b->ob_type->tp_name);
1423 return NULL;
1426 /* ---------------------------------------------------------------------------
1427 * Cached Python objects; these are set by the module init function.
1430 /* Conversion factors. */
1431 static PyObject *us_per_us = NULL; /* 1 */
1432 static PyObject *us_per_ms = NULL; /* 1000 */
1433 static PyObject *us_per_second = NULL; /* 1000000 */
1434 static PyObject *us_per_minute = NULL; /* 1e6 * 60 as Python int */
1435 static PyObject *us_per_hour = NULL; /* 1e6 * 3600 as Python long */
1436 static PyObject *us_per_day = NULL; /* 1e6 * 3600 * 24 as Python long */
1437 static PyObject *us_per_week = NULL; /* 1e6*3600*24*7 as Python long */
1438 static PyObject *seconds_per_day = NULL; /* 3600*24 as Python int */
1440 /* ---------------------------------------------------------------------------
1441 * Class implementations.
1445 * PyDateTime_Delta implementation.
1448 /* Convert a timedelta to a number of us,
1449 * (24*3600*self.days + self.seconds)*1000000 + self.microseconds
1450 * as a Python int or long.
1451 * Doing mixed-radix arithmetic by hand instead is excruciating in C,
1452 * due to ubiquitous overflow possibilities.
1454 static PyObject *
1455 delta_to_microseconds(PyDateTime_Delta *self)
1457 PyObject *x1 = NULL;
1458 PyObject *x2 = NULL;
1459 PyObject *x3 = NULL;
1460 PyObject *result = NULL;
1462 x1 = PyInt_FromLong(GET_TD_DAYS(self));
1463 if (x1 == NULL)
1464 goto Done;
1465 x2 = PyNumber_Multiply(x1, seconds_per_day); /* days in seconds */
1466 if (x2 == NULL)
1467 goto Done;
1468 Py_DECREF(x1);
1469 x1 = NULL;
1471 /* x2 has days in seconds */
1472 x1 = PyInt_FromLong(GET_TD_SECONDS(self)); /* seconds */
1473 if (x1 == NULL)
1474 goto Done;
1475 x3 = PyNumber_Add(x1, x2); /* days and seconds in seconds */
1476 if (x3 == NULL)
1477 goto Done;
1478 Py_DECREF(x1);
1479 Py_DECREF(x2);
1480 x1 = x2 = NULL;
1482 /* x3 has days+seconds in seconds */
1483 x1 = PyNumber_Multiply(x3, us_per_second); /* us */
1484 if (x1 == NULL)
1485 goto Done;
1486 Py_DECREF(x3);
1487 x3 = NULL;
1489 /* x1 has days+seconds in us */
1490 x2 = PyInt_FromLong(GET_TD_MICROSECONDS(self));
1491 if (x2 == NULL)
1492 goto Done;
1493 result = PyNumber_Add(x1, x2);
1495 Done:
1496 Py_XDECREF(x1);
1497 Py_XDECREF(x2);
1498 Py_XDECREF(x3);
1499 return result;
1502 /* Convert a number of us (as a Python int or long) to a timedelta.
1504 static PyObject *
1505 microseconds_to_delta_ex(PyObject *pyus, PyTypeObject *type)
1507 int us;
1508 int s;
1509 int d;
1510 long temp;
1512 PyObject *tuple = NULL;
1513 PyObject *num = NULL;
1514 PyObject *result = NULL;
1516 tuple = PyNumber_Divmod(pyus, us_per_second);
1517 if (tuple == NULL)
1518 goto Done;
1520 num = PyTuple_GetItem(tuple, 1); /* us */
1521 if (num == NULL)
1522 goto Done;
1523 temp = PyLong_AsLong(num);
1524 num = NULL;
1525 if (temp == -1 && PyErr_Occurred())
1526 goto Done;
1527 assert(0 <= temp && temp < 1000000);
1528 us = (int)temp;
1529 if (us < 0) {
1530 /* The divisor was positive, so this must be an error. */
1531 assert(PyErr_Occurred());
1532 goto Done;
1535 num = PyTuple_GetItem(tuple, 0); /* leftover seconds */
1536 if (num == NULL)
1537 goto Done;
1538 Py_INCREF(num);
1539 Py_DECREF(tuple);
1541 tuple = PyNumber_Divmod(num, seconds_per_day);
1542 if (tuple == NULL)
1543 goto Done;
1544 Py_DECREF(num);
1546 num = PyTuple_GetItem(tuple, 1); /* seconds */
1547 if (num == NULL)
1548 goto Done;
1549 temp = PyLong_AsLong(num);
1550 num = NULL;
1551 if (temp == -1 && PyErr_Occurred())
1552 goto Done;
1553 assert(0 <= temp && temp < 24*3600);
1554 s = (int)temp;
1556 if (s < 0) {
1557 /* The divisor was positive, so this must be an error. */
1558 assert(PyErr_Occurred());
1559 goto Done;
1562 num = PyTuple_GetItem(tuple, 0); /* leftover days */
1563 if (num == NULL)
1564 goto Done;
1565 Py_INCREF(num);
1566 temp = PyLong_AsLong(num);
1567 if (temp == -1 && PyErr_Occurred())
1568 goto Done;
1569 d = (int)temp;
1570 if ((long)d != temp) {
1571 PyErr_SetString(PyExc_OverflowError, "normalized days too "
1572 "large to fit in a C int");
1573 goto Done;
1575 result = new_delta_ex(d, s, us, 0, type);
1577 Done:
1578 Py_XDECREF(tuple);
1579 Py_XDECREF(num);
1580 return result;
1583 #define microseconds_to_delta(pymicros) \
1584 microseconds_to_delta_ex(pymicros, &PyDateTime_DeltaType)
1586 static PyObject *
1587 multiply_int_timedelta(PyObject *intobj, PyDateTime_Delta *delta)
1589 PyObject *pyus_in;
1590 PyObject *pyus_out;
1591 PyObject *result;
1593 pyus_in = delta_to_microseconds(delta);
1594 if (pyus_in == NULL)
1595 return NULL;
1597 pyus_out = PyNumber_Multiply(pyus_in, intobj);
1598 Py_DECREF(pyus_in);
1599 if (pyus_out == NULL)
1600 return NULL;
1602 result = microseconds_to_delta(pyus_out);
1603 Py_DECREF(pyus_out);
1604 return result;
1607 static PyObject *
1608 divide_timedelta_int(PyDateTime_Delta *delta, PyObject *intobj)
1610 PyObject *pyus_in;
1611 PyObject *pyus_out;
1612 PyObject *result;
1614 pyus_in = delta_to_microseconds(delta);
1615 if (pyus_in == NULL)
1616 return NULL;
1618 pyus_out = PyNumber_FloorDivide(pyus_in, intobj);
1619 Py_DECREF(pyus_in);
1620 if (pyus_out == NULL)
1621 return NULL;
1623 result = microseconds_to_delta(pyus_out);
1624 Py_DECREF(pyus_out);
1625 return result;
1628 static PyObject *
1629 delta_add(PyObject *left, PyObject *right)
1631 PyObject *result = Py_NotImplemented;
1633 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1634 /* delta + delta */
1635 /* The C-level additions can't overflow because of the
1636 * invariant bounds.
1638 int days = GET_TD_DAYS(left) + GET_TD_DAYS(right);
1639 int seconds = GET_TD_SECONDS(left) + GET_TD_SECONDS(right);
1640 int microseconds = GET_TD_MICROSECONDS(left) +
1641 GET_TD_MICROSECONDS(right);
1642 result = new_delta(days, seconds, microseconds, 1);
1645 if (result == Py_NotImplemented)
1646 Py_INCREF(result);
1647 return result;
1650 static PyObject *
1651 delta_negative(PyDateTime_Delta *self)
1653 return new_delta(-GET_TD_DAYS(self),
1654 -GET_TD_SECONDS(self),
1655 -GET_TD_MICROSECONDS(self),
1659 static PyObject *
1660 delta_positive(PyDateTime_Delta *self)
1662 /* Could optimize this (by returning self) if this isn't a
1663 * subclass -- but who uses unary + ? Approximately nobody.
1665 return new_delta(GET_TD_DAYS(self),
1666 GET_TD_SECONDS(self),
1667 GET_TD_MICROSECONDS(self),
1671 static PyObject *
1672 delta_abs(PyDateTime_Delta *self)
1674 PyObject *result;
1676 assert(GET_TD_MICROSECONDS(self) >= 0);
1677 assert(GET_TD_SECONDS(self) >= 0);
1679 if (GET_TD_DAYS(self) < 0)
1680 result = delta_negative(self);
1681 else
1682 result = delta_positive(self);
1684 return result;
1687 static PyObject *
1688 delta_subtract(PyObject *left, PyObject *right)
1690 PyObject *result = Py_NotImplemented;
1692 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1693 /* delta - delta */
1694 PyObject *minus_right = PyNumber_Negative(right);
1695 if (minus_right) {
1696 result = delta_add(left, minus_right);
1697 Py_DECREF(minus_right);
1699 else
1700 result = NULL;
1703 if (result == Py_NotImplemented)
1704 Py_INCREF(result);
1705 return result;
1708 /* This is more natural as a tp_compare, but doesn't work then: for whatever
1709 * reason, Python's try_3way_compare ignores tp_compare unless
1710 * PyInstance_Check returns true, but these aren't old-style classes.
1712 static PyObject *
1713 delta_richcompare(PyDateTime_Delta *self, PyObject *other, int op)
1715 int diff = 42; /* nonsense */
1717 if (PyDelta_Check(other)) {
1718 diff = GET_TD_DAYS(self) - GET_TD_DAYS(other);
1719 if (diff == 0) {
1720 diff = GET_TD_SECONDS(self) - GET_TD_SECONDS(other);
1721 if (diff == 0)
1722 diff = GET_TD_MICROSECONDS(self) -
1723 GET_TD_MICROSECONDS(other);
1726 else if (op == Py_EQ || op == Py_NE)
1727 diff = 1; /* any non-zero value will do */
1729 else /* stop this from falling back to address comparison */
1730 return cmperror((PyObject *)self, other);
1732 return diff_to_bool(diff, op);
1735 static PyObject *delta_getstate(PyDateTime_Delta *self);
1737 static long
1738 delta_hash(PyDateTime_Delta *self)
1740 if (self->hashcode == -1) {
1741 PyObject *temp = delta_getstate(self);
1742 if (temp != NULL) {
1743 self->hashcode = PyObject_Hash(temp);
1744 Py_DECREF(temp);
1747 return self->hashcode;
1750 static PyObject *
1751 delta_multiply(PyObject *left, PyObject *right)
1753 PyObject *result = Py_NotImplemented;
1755 if (PyDelta_Check(left)) {
1756 /* delta * ??? */
1757 if (PyInt_Check(right) || PyLong_Check(right))
1758 result = multiply_int_timedelta(right,
1759 (PyDateTime_Delta *) left);
1761 else if (PyInt_Check(left) || PyLong_Check(left))
1762 result = multiply_int_timedelta(left,
1763 (PyDateTime_Delta *) right);
1765 if (result == Py_NotImplemented)
1766 Py_INCREF(result);
1767 return result;
1770 static PyObject *
1771 delta_divide(PyObject *left, PyObject *right)
1773 PyObject *result = Py_NotImplemented;
1775 if (PyDelta_Check(left)) {
1776 /* delta * ??? */
1777 if (PyInt_Check(right) || PyLong_Check(right))
1778 result = divide_timedelta_int(
1779 (PyDateTime_Delta *)left,
1780 right);
1783 if (result == Py_NotImplemented)
1784 Py_INCREF(result);
1785 return result;
1788 /* Fold in the value of the tag ("seconds", "weeks", etc) component of a
1789 * timedelta constructor. sofar is the # of microseconds accounted for
1790 * so far, and there are factor microseconds per current unit, the number
1791 * of which is given by num. num * factor is added to sofar in a
1792 * numerically careful way, and that's the result. Any fractional
1793 * microseconds left over (this can happen if num is a float type) are
1794 * added into *leftover.
1795 * Note that there are many ways this can give an error (NULL) return.
1797 static PyObject *
1798 accum(const char* tag, PyObject *sofar, PyObject *num, PyObject *factor,
1799 double *leftover)
1801 PyObject *prod;
1802 PyObject *sum;
1804 assert(num != NULL);
1806 if (PyInt_Check(num) || PyLong_Check(num)) {
1807 prod = PyNumber_Multiply(num, factor);
1808 if (prod == NULL)
1809 return NULL;
1810 sum = PyNumber_Add(sofar, prod);
1811 Py_DECREF(prod);
1812 return sum;
1815 if (PyFloat_Check(num)) {
1816 double dnum;
1817 double fracpart;
1818 double intpart;
1819 PyObject *x;
1820 PyObject *y;
1822 /* The Plan: decompose num into an integer part and a
1823 * fractional part, num = intpart + fracpart.
1824 * Then num * factor ==
1825 * intpart * factor + fracpart * factor
1826 * and the LHS can be computed exactly in long arithmetic.
1827 * The RHS is again broken into an int part and frac part.
1828 * and the frac part is added into *leftover.
1830 dnum = PyFloat_AsDouble(num);
1831 if (dnum == -1.0 && PyErr_Occurred())
1832 return NULL;
1833 fracpart = modf(dnum, &intpart);
1834 x = PyLong_FromDouble(intpart);
1835 if (x == NULL)
1836 return NULL;
1838 prod = PyNumber_Multiply(x, factor);
1839 Py_DECREF(x);
1840 if (prod == NULL)
1841 return NULL;
1843 sum = PyNumber_Add(sofar, prod);
1844 Py_DECREF(prod);
1845 if (sum == NULL)
1846 return NULL;
1848 if (fracpart == 0.0)
1849 return sum;
1850 /* So far we've lost no information. Dealing with the
1851 * fractional part requires float arithmetic, and may
1852 * lose a little info.
1854 assert(PyInt_Check(factor) || PyLong_Check(factor));
1855 if (PyInt_Check(factor))
1856 dnum = (double)PyInt_AsLong(factor);
1857 else
1858 dnum = PyLong_AsDouble(factor);
1860 dnum *= fracpart;
1861 fracpart = modf(dnum, &intpart);
1862 x = PyLong_FromDouble(intpart);
1863 if (x == NULL) {
1864 Py_DECREF(sum);
1865 return NULL;
1868 y = PyNumber_Add(sum, x);
1869 Py_DECREF(sum);
1870 Py_DECREF(x);
1871 *leftover += fracpart;
1872 return y;
1875 PyErr_Format(PyExc_TypeError,
1876 "unsupported type for timedelta %s component: %s",
1877 tag, num->ob_type->tp_name);
1878 return NULL;
1881 static PyObject *
1882 delta_new(PyTypeObject *type, PyObject *args, PyObject *kw)
1884 PyObject *self = NULL;
1886 /* Argument objects. */
1887 PyObject *day = NULL;
1888 PyObject *second = NULL;
1889 PyObject *us = NULL;
1890 PyObject *ms = NULL;
1891 PyObject *minute = NULL;
1892 PyObject *hour = NULL;
1893 PyObject *week = NULL;
1895 PyObject *x = NULL; /* running sum of microseconds */
1896 PyObject *y = NULL; /* temp sum of microseconds */
1897 double leftover_us = 0.0;
1899 static char *keywords[] = {
1900 "days", "seconds", "microseconds", "milliseconds",
1901 "minutes", "hours", "weeks", NULL
1904 if (PyArg_ParseTupleAndKeywords(args, kw, "|OOOOOOO:__new__",
1905 keywords,
1906 &day, &second, &us,
1907 &ms, &minute, &hour, &week) == 0)
1908 goto Done;
1910 x = PyInt_FromLong(0);
1911 if (x == NULL)
1912 goto Done;
1914 #define CLEANUP \
1915 Py_DECREF(x); \
1916 x = y; \
1917 if (x == NULL) \
1918 goto Done
1920 if (us) {
1921 y = accum("microseconds", x, us, us_per_us, &leftover_us);
1922 CLEANUP;
1924 if (ms) {
1925 y = accum("milliseconds", x, ms, us_per_ms, &leftover_us);
1926 CLEANUP;
1928 if (second) {
1929 y = accum("seconds", x, second, us_per_second, &leftover_us);
1930 CLEANUP;
1932 if (minute) {
1933 y = accum("minutes", x, minute, us_per_minute, &leftover_us);
1934 CLEANUP;
1936 if (hour) {
1937 y = accum("hours", x, hour, us_per_hour, &leftover_us);
1938 CLEANUP;
1940 if (day) {
1941 y = accum("days", x, day, us_per_day, &leftover_us);
1942 CLEANUP;
1944 if (week) {
1945 y = accum("weeks", x, week, us_per_week, &leftover_us);
1946 CLEANUP;
1948 if (leftover_us) {
1949 /* Round to nearest whole # of us, and add into x. */
1950 PyObject *temp = PyLong_FromLong(round_to_long(leftover_us));
1951 if (temp == NULL) {
1952 Py_DECREF(x);
1953 goto Done;
1955 y = PyNumber_Add(x, temp);
1956 Py_DECREF(temp);
1957 CLEANUP;
1960 self = microseconds_to_delta_ex(x, type);
1961 Py_DECREF(x);
1962 Done:
1963 return self;
1965 #undef CLEANUP
1968 static int
1969 delta_nonzero(PyDateTime_Delta *self)
1971 return (GET_TD_DAYS(self) != 0
1972 || GET_TD_SECONDS(self) != 0
1973 || GET_TD_MICROSECONDS(self) != 0);
1976 static PyObject *
1977 delta_repr(PyDateTime_Delta *self)
1979 if (GET_TD_MICROSECONDS(self) != 0)
1980 return PyString_FromFormat("%s(%d, %d, %d)",
1981 self->ob_type->tp_name,
1982 GET_TD_DAYS(self),
1983 GET_TD_SECONDS(self),
1984 GET_TD_MICROSECONDS(self));
1985 if (GET_TD_SECONDS(self) != 0)
1986 return PyString_FromFormat("%s(%d, %d)",
1987 self->ob_type->tp_name,
1988 GET_TD_DAYS(self),
1989 GET_TD_SECONDS(self));
1991 return PyString_FromFormat("%s(%d)",
1992 self->ob_type->tp_name,
1993 GET_TD_DAYS(self));
1996 static PyObject *
1997 delta_str(PyDateTime_Delta *self)
1999 int days = GET_TD_DAYS(self);
2000 int seconds = GET_TD_SECONDS(self);
2001 int us = GET_TD_MICROSECONDS(self);
2002 int hours;
2003 int minutes;
2004 char buf[100];
2005 char *pbuf = buf;
2006 size_t buflen = sizeof(buf);
2007 int n;
2009 minutes = divmod(seconds, 60, &seconds);
2010 hours = divmod(minutes, 60, &minutes);
2012 if (days) {
2013 n = PyOS_snprintf(pbuf, buflen, "%d day%s, ", days,
2014 (days == 1 || days == -1) ? "" : "s");
2015 if (n < 0 || (size_t)n >= buflen)
2016 goto Fail;
2017 pbuf += n;
2018 buflen -= (size_t)n;
2021 n = PyOS_snprintf(pbuf, buflen, "%d:%02d:%02d",
2022 hours, minutes, seconds);
2023 if (n < 0 || (size_t)n >= buflen)
2024 goto Fail;
2025 pbuf += n;
2026 buflen -= (size_t)n;
2028 if (us) {
2029 n = PyOS_snprintf(pbuf, buflen, ".%06d", us);
2030 if (n < 0 || (size_t)n >= buflen)
2031 goto Fail;
2032 pbuf += n;
2035 return PyString_FromStringAndSize(buf, pbuf - buf);
2037 Fail:
2038 PyErr_SetString(PyExc_SystemError, "goofy result from PyOS_snprintf");
2039 return NULL;
2042 /* Pickle support, a simple use of __reduce__. */
2044 /* __getstate__ isn't exposed */
2045 static PyObject *
2046 delta_getstate(PyDateTime_Delta *self)
2048 return Py_BuildValue("iii", GET_TD_DAYS(self),
2049 GET_TD_SECONDS(self),
2050 GET_TD_MICROSECONDS(self));
2053 static PyObject *
2054 delta_reduce(PyDateTime_Delta* self)
2056 return Py_BuildValue("ON", self->ob_type, delta_getstate(self));
2059 #define OFFSET(field) offsetof(PyDateTime_Delta, field)
2061 static PyMemberDef delta_members[] = {
2063 {"days", T_INT, OFFSET(days), READONLY,
2064 PyDoc_STR("Number of days.")},
2066 {"seconds", T_INT, OFFSET(seconds), READONLY,
2067 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
2069 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
2070 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
2071 {NULL}
2074 static PyMethodDef delta_methods[] = {
2075 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
2076 PyDoc_STR("__reduce__() -> (cls, state)")},
2078 {NULL, NULL},
2081 static char delta_doc[] =
2082 PyDoc_STR("Difference between two datetime values.");
2084 static PyNumberMethods delta_as_number = {
2085 delta_add, /* nb_add */
2086 delta_subtract, /* nb_subtract */
2087 delta_multiply, /* nb_multiply */
2088 delta_divide, /* nb_divide */
2089 0, /* nb_remainder */
2090 0, /* nb_divmod */
2091 0, /* nb_power */
2092 (unaryfunc)delta_negative, /* nb_negative */
2093 (unaryfunc)delta_positive, /* nb_positive */
2094 (unaryfunc)delta_abs, /* nb_absolute */
2095 (inquiry)delta_nonzero, /* nb_nonzero */
2096 0, /*nb_invert*/
2097 0, /*nb_lshift*/
2098 0, /*nb_rshift*/
2099 0, /*nb_and*/
2100 0, /*nb_xor*/
2101 0, /*nb_or*/
2102 0, /*nb_coerce*/
2103 0, /*nb_int*/
2104 0, /*nb_long*/
2105 0, /*nb_float*/
2106 0, /*nb_oct*/
2107 0, /*nb_hex*/
2108 0, /*nb_inplace_add*/
2109 0, /*nb_inplace_subtract*/
2110 0, /*nb_inplace_multiply*/
2111 0, /*nb_inplace_divide*/
2112 0, /*nb_inplace_remainder*/
2113 0, /*nb_inplace_power*/
2114 0, /*nb_inplace_lshift*/
2115 0, /*nb_inplace_rshift*/
2116 0, /*nb_inplace_and*/
2117 0, /*nb_inplace_xor*/
2118 0, /*nb_inplace_or*/
2119 delta_divide, /* nb_floor_divide */
2120 0, /* nb_true_divide */
2121 0, /* nb_inplace_floor_divide */
2122 0, /* nb_inplace_true_divide */
2125 static PyTypeObject PyDateTime_DeltaType = {
2126 PyObject_HEAD_INIT(NULL)
2127 0, /* ob_size */
2128 "datetime.timedelta", /* tp_name */
2129 sizeof(PyDateTime_Delta), /* tp_basicsize */
2130 0, /* tp_itemsize */
2131 0, /* tp_dealloc */
2132 0, /* tp_print */
2133 0, /* tp_getattr */
2134 0, /* tp_setattr */
2135 0, /* tp_compare */
2136 (reprfunc)delta_repr, /* tp_repr */
2137 &delta_as_number, /* tp_as_number */
2138 0, /* tp_as_sequence */
2139 0, /* tp_as_mapping */
2140 (hashfunc)delta_hash, /* tp_hash */
2141 0, /* tp_call */
2142 (reprfunc)delta_str, /* tp_str */
2143 PyObject_GenericGetAttr, /* tp_getattro */
2144 0, /* tp_setattro */
2145 0, /* tp_as_buffer */
2146 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2147 Py_TPFLAGS_BASETYPE, /* tp_flags */
2148 delta_doc, /* tp_doc */
2149 0, /* tp_traverse */
2150 0, /* tp_clear */
2151 (richcmpfunc)delta_richcompare, /* tp_richcompare */
2152 0, /* tp_weaklistoffset */
2153 0, /* tp_iter */
2154 0, /* tp_iternext */
2155 delta_methods, /* tp_methods */
2156 delta_members, /* tp_members */
2157 0, /* tp_getset */
2158 0, /* tp_base */
2159 0, /* tp_dict */
2160 0, /* tp_descr_get */
2161 0, /* tp_descr_set */
2162 0, /* tp_dictoffset */
2163 0, /* tp_init */
2164 0, /* tp_alloc */
2165 delta_new, /* tp_new */
2166 0, /* tp_free */
2170 * PyDateTime_Date implementation.
2173 /* Accessor properties. */
2175 static PyObject *
2176 date_year(PyDateTime_Date *self, void *unused)
2178 return PyInt_FromLong(GET_YEAR(self));
2181 static PyObject *
2182 date_month(PyDateTime_Date *self, void *unused)
2184 return PyInt_FromLong(GET_MONTH(self));
2187 static PyObject *
2188 date_day(PyDateTime_Date *self, void *unused)
2190 return PyInt_FromLong(GET_DAY(self));
2193 static PyGetSetDef date_getset[] = {
2194 {"year", (getter)date_year},
2195 {"month", (getter)date_month},
2196 {"day", (getter)date_day},
2197 {NULL}
2200 /* Constructors. */
2202 static char *date_kws[] = {"year", "month", "day", NULL};
2204 static PyObject *
2205 date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2207 PyObject *self = NULL;
2208 PyObject *state;
2209 int year;
2210 int month;
2211 int day;
2213 /* Check for invocation from pickle with __getstate__ state */
2214 if (PyTuple_GET_SIZE(args) == 1 &&
2215 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
2216 PyString_GET_SIZE(state) == _PyDateTime_DATE_DATASIZE &&
2217 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
2219 PyDateTime_Date *me;
2221 me = (PyDateTime_Date *) (type->tp_alloc(type, 0));
2222 if (me != NULL) {
2223 char *pdata = PyString_AS_STRING(state);
2224 memcpy(me->data, pdata, _PyDateTime_DATE_DATASIZE);
2225 me->hashcode = -1;
2227 return (PyObject *)me;
2230 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
2231 &year, &month, &day)) {
2232 if (check_date_args(year, month, day) < 0)
2233 return NULL;
2234 self = new_date_ex(year, month, day, type);
2236 return self;
2239 /* Return new date from localtime(t). */
2240 static PyObject *
2241 date_local_from_time_t(PyObject *cls, double ts)
2243 struct tm *tm;
2244 time_t t;
2245 PyObject *result = NULL;
2247 t = _PyTime_DoubleToTimet(ts);
2248 if (t == (time_t)-1 && PyErr_Occurred())
2249 return NULL;
2250 tm = localtime(&t);
2251 if (tm)
2252 result = PyObject_CallFunction(cls, "iii",
2253 tm->tm_year + 1900,
2254 tm->tm_mon + 1,
2255 tm->tm_mday);
2256 else
2257 PyErr_SetString(PyExc_ValueError,
2258 "timestamp out of range for "
2259 "platform localtime() function");
2260 return result;
2263 /* Return new date from current time.
2264 * We say this is equivalent to fromtimestamp(time.time()), and the
2265 * only way to be sure of that is to *call* time.time(). That's not
2266 * generally the same as calling C's time.
2268 static PyObject *
2269 date_today(PyObject *cls, PyObject *dummy)
2271 PyObject *time;
2272 PyObject *result;
2274 time = time_time();
2275 if (time == NULL)
2276 return NULL;
2278 /* Note well: today() is a class method, so this may not call
2279 * date.fromtimestamp. For example, it may call
2280 * datetime.fromtimestamp. That's why we need all the accuracy
2281 * time.time() delivers; if someone were gonzo about optimization,
2282 * date.today() could get away with plain C time().
2284 result = PyObject_CallMethod(cls, "fromtimestamp", "O", time);
2285 Py_DECREF(time);
2286 return result;
2289 /* Return new date from given timestamp (Python timestamp -- a double). */
2290 static PyObject *
2291 date_fromtimestamp(PyObject *cls, PyObject *args)
2293 double timestamp;
2294 PyObject *result = NULL;
2296 if (PyArg_ParseTuple(args, "d:fromtimestamp", &timestamp))
2297 result = date_local_from_time_t(cls, timestamp);
2298 return result;
2301 /* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2302 * the ordinal is out of range.
2304 static PyObject *
2305 date_fromordinal(PyObject *cls, PyObject *args)
2307 PyObject *result = NULL;
2308 int ordinal;
2310 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2311 int year;
2312 int month;
2313 int day;
2315 if (ordinal < 1)
2316 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2317 ">= 1");
2318 else {
2319 ord_to_ymd(ordinal, &year, &month, &day);
2320 result = PyObject_CallFunction(cls, "iii",
2321 year, month, day);
2324 return result;
2328 * Date arithmetic.
2331 /* date + timedelta -> date. If arg negate is true, subtract the timedelta
2332 * instead.
2334 static PyObject *
2335 add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
2337 PyObject *result = NULL;
2338 int year = GET_YEAR(date);
2339 int month = GET_MONTH(date);
2340 int deltadays = GET_TD_DAYS(delta);
2341 /* C-level overflow is impossible because |deltadays| < 1e9. */
2342 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
2344 if (normalize_date(&year, &month, &day) >= 0)
2345 result = new_date(year, month, day);
2346 return result;
2349 static PyObject *
2350 date_add(PyObject *left, PyObject *right)
2352 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2353 Py_INCREF(Py_NotImplemented);
2354 return Py_NotImplemented;
2356 if (PyDate_Check(left)) {
2357 /* date + ??? */
2358 if (PyDelta_Check(right))
2359 /* date + delta */
2360 return add_date_timedelta((PyDateTime_Date *) left,
2361 (PyDateTime_Delta *) right,
2364 else {
2365 /* ??? + date
2366 * 'right' must be one of us, or we wouldn't have been called
2368 if (PyDelta_Check(left))
2369 /* delta + date */
2370 return add_date_timedelta((PyDateTime_Date *) right,
2371 (PyDateTime_Delta *) left,
2374 Py_INCREF(Py_NotImplemented);
2375 return Py_NotImplemented;
2378 static PyObject *
2379 date_subtract(PyObject *left, PyObject *right)
2381 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2382 Py_INCREF(Py_NotImplemented);
2383 return Py_NotImplemented;
2385 if (PyDate_Check(left)) {
2386 if (PyDate_Check(right)) {
2387 /* date - date */
2388 int left_ord = ymd_to_ord(GET_YEAR(left),
2389 GET_MONTH(left),
2390 GET_DAY(left));
2391 int right_ord = ymd_to_ord(GET_YEAR(right),
2392 GET_MONTH(right),
2393 GET_DAY(right));
2394 return new_delta(left_ord - right_ord, 0, 0, 0);
2396 if (PyDelta_Check(right)) {
2397 /* date - delta */
2398 return add_date_timedelta((PyDateTime_Date *) left,
2399 (PyDateTime_Delta *) right,
2403 Py_INCREF(Py_NotImplemented);
2404 return Py_NotImplemented;
2408 /* Various ways to turn a date into a string. */
2410 static PyObject *
2411 date_repr(PyDateTime_Date *self)
2413 char buffer[1028];
2414 const char *typename;
2416 typename = self->ob_type->tp_name;
2417 PyOS_snprintf(buffer, sizeof(buffer), "%s(%d, %d, %d)",
2418 typename,
2419 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2421 return PyString_FromString(buffer);
2424 static PyObject *
2425 date_isoformat(PyDateTime_Date *self)
2427 char buffer[128];
2429 isoformat_date(self, buffer, sizeof(buffer));
2430 return PyString_FromString(buffer);
2433 /* str() calls the appropriate isoformat() method. */
2434 static PyObject *
2435 date_str(PyDateTime_Date *self)
2437 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
2441 static PyObject *
2442 date_ctime(PyDateTime_Date *self)
2444 return format_ctime(self, 0, 0, 0);
2447 static PyObject *
2448 date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2450 /* This method can be inherited, and needs to call the
2451 * timetuple() method appropriate to self's class.
2453 PyObject *result;
2454 PyObject *format;
2455 PyObject *tuple;
2456 static char *keywords[] = {"format", NULL};
2458 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
2459 &PyString_Type, &format))
2460 return NULL;
2462 tuple = PyObject_CallMethod((PyObject *)self, "timetuple", "()");
2463 if (tuple == NULL)
2464 return NULL;
2465 result = wrap_strftime((PyObject *)self, format, tuple,
2466 (PyObject *)self);
2467 Py_DECREF(tuple);
2468 return result;
2471 /* ISO methods. */
2473 static PyObject *
2474 date_isoweekday(PyDateTime_Date *self)
2476 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2478 return PyInt_FromLong(dow + 1);
2481 static PyObject *
2482 date_isocalendar(PyDateTime_Date *self)
2484 int year = GET_YEAR(self);
2485 int week1_monday = iso_week1_monday(year);
2486 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
2487 int week;
2488 int day;
2490 week = divmod(today - week1_monday, 7, &day);
2491 if (week < 0) {
2492 --year;
2493 week1_monday = iso_week1_monday(year);
2494 week = divmod(today - week1_monday, 7, &day);
2496 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
2497 ++year;
2498 week = 0;
2500 return Py_BuildValue("iii", year, week + 1, day + 1);
2503 /* Miscellaneous methods. */
2505 /* This is more natural as a tp_compare, but doesn't work then: for whatever
2506 * reason, Python's try_3way_compare ignores tp_compare unless
2507 * PyInstance_Check returns true, but these aren't old-style classes.
2509 static PyObject *
2510 date_richcompare(PyDateTime_Date *self, PyObject *other, int op)
2512 int diff = 42; /* nonsense */
2514 if (PyDate_Check(other))
2515 diff = memcmp(self->data, ((PyDateTime_Date *)other)->data,
2516 _PyDateTime_DATE_DATASIZE);
2518 else if (PyObject_HasAttrString(other, "timetuple")) {
2519 /* A hook for other kinds of date objects. */
2520 Py_INCREF(Py_NotImplemented);
2521 return Py_NotImplemented;
2523 else if (op == Py_EQ || op == Py_NE)
2524 diff = 1; /* any non-zero value will do */
2526 else /* stop this from falling back to address comparison */
2527 return cmperror((PyObject *)self, other);
2529 return diff_to_bool(diff, op);
2532 static PyObject *
2533 date_timetuple(PyDateTime_Date *self)
2535 return build_struct_time(GET_YEAR(self),
2536 GET_MONTH(self),
2537 GET_DAY(self),
2538 0, 0, 0, -1);
2541 static PyObject *
2542 date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2544 PyObject *clone;
2545 PyObject *tuple;
2546 int year = GET_YEAR(self);
2547 int month = GET_MONTH(self);
2548 int day = GET_DAY(self);
2550 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
2551 &year, &month, &day))
2552 return NULL;
2553 tuple = Py_BuildValue("iii", year, month, day);
2554 if (tuple == NULL)
2555 return NULL;
2556 clone = date_new(self->ob_type, tuple, NULL);
2557 Py_DECREF(tuple);
2558 return clone;
2561 static PyObject *date_getstate(PyDateTime_Date *self);
2563 static long
2564 date_hash(PyDateTime_Date *self)
2566 if (self->hashcode == -1) {
2567 PyObject *temp = date_getstate(self);
2568 if (temp != NULL) {
2569 self->hashcode = PyObject_Hash(temp);
2570 Py_DECREF(temp);
2573 return self->hashcode;
2576 static PyObject *
2577 date_toordinal(PyDateTime_Date *self)
2579 return PyInt_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
2580 GET_DAY(self)));
2583 static PyObject *
2584 date_weekday(PyDateTime_Date *self)
2586 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2588 return PyInt_FromLong(dow);
2591 /* Pickle support, a simple use of __reduce__. */
2593 /* __getstate__ isn't exposed */
2594 static PyObject *
2595 date_getstate(PyDateTime_Date *self)
2597 return Py_BuildValue(
2598 "(N)",
2599 PyString_FromStringAndSize((char *)self->data,
2600 _PyDateTime_DATE_DATASIZE));
2603 static PyObject *
2604 date_reduce(PyDateTime_Date *self, PyObject *arg)
2606 return Py_BuildValue("(ON)", self->ob_type, date_getstate(self));
2609 static PyMethodDef date_methods[] = {
2611 /* Class methods: */
2613 {"fromtimestamp", (PyCFunction)date_fromtimestamp, METH_VARARGS |
2614 METH_CLASS,
2615 PyDoc_STR("timestamp -> local date from a POSIX timestamp (like "
2616 "time.time()).")},
2618 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
2619 METH_CLASS,
2620 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
2621 "ordinal.")},
2623 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
2624 PyDoc_STR("Current date or datetime: same as "
2625 "self.__class__.fromtimestamp(time.time()).")},
2627 /* Instance methods: */
2629 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
2630 PyDoc_STR("Return ctime() style string.")},
2632 {"strftime", (PyCFunction)date_strftime, METH_KEYWORDS,
2633 PyDoc_STR("format -> strftime() style string.")},
2635 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
2636 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
2638 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
2639 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
2640 "weekday.")},
2642 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
2643 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
2645 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
2646 PyDoc_STR("Return the day of the week represented by the date.\n"
2647 "Monday == 1 ... Sunday == 7")},
2649 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
2650 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
2651 "1 is day 1.")},
2653 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
2654 PyDoc_STR("Return the day of the week represented by the date.\n"
2655 "Monday == 0 ... Sunday == 6")},
2657 {"replace", (PyCFunction)date_replace, METH_KEYWORDS,
2658 PyDoc_STR("Return date with new specified fields.")},
2660 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
2661 PyDoc_STR("__reduce__() -> (cls, state)")},
2663 {NULL, NULL}
2666 static char date_doc[] =
2667 PyDoc_STR("date(year, month, day) --> date object");
2669 static PyNumberMethods date_as_number = {
2670 date_add, /* nb_add */
2671 date_subtract, /* nb_subtract */
2672 0, /* nb_multiply */
2673 0, /* nb_divide */
2674 0, /* nb_remainder */
2675 0, /* nb_divmod */
2676 0, /* nb_power */
2677 0, /* nb_negative */
2678 0, /* nb_positive */
2679 0, /* nb_absolute */
2680 0, /* nb_nonzero */
2683 static PyTypeObject PyDateTime_DateType = {
2684 PyObject_HEAD_INIT(NULL)
2685 0, /* ob_size */
2686 "datetime.date", /* tp_name */
2687 sizeof(PyDateTime_Date), /* tp_basicsize */
2688 0, /* tp_itemsize */
2689 0, /* tp_dealloc */
2690 0, /* tp_print */
2691 0, /* tp_getattr */
2692 0, /* tp_setattr */
2693 0, /* tp_compare */
2694 (reprfunc)date_repr, /* tp_repr */
2695 &date_as_number, /* tp_as_number */
2696 0, /* tp_as_sequence */
2697 0, /* tp_as_mapping */
2698 (hashfunc)date_hash, /* tp_hash */
2699 0, /* tp_call */
2700 (reprfunc)date_str, /* tp_str */
2701 PyObject_GenericGetAttr, /* tp_getattro */
2702 0, /* tp_setattro */
2703 0, /* tp_as_buffer */
2704 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2705 Py_TPFLAGS_BASETYPE, /* tp_flags */
2706 date_doc, /* tp_doc */
2707 0, /* tp_traverse */
2708 0, /* tp_clear */
2709 (richcmpfunc)date_richcompare, /* tp_richcompare */
2710 0, /* tp_weaklistoffset */
2711 0, /* tp_iter */
2712 0, /* tp_iternext */
2713 date_methods, /* tp_methods */
2714 0, /* tp_members */
2715 date_getset, /* tp_getset */
2716 0, /* tp_base */
2717 0, /* tp_dict */
2718 0, /* tp_descr_get */
2719 0, /* tp_descr_set */
2720 0, /* tp_dictoffset */
2721 0, /* tp_init */
2722 0, /* tp_alloc */
2723 date_new, /* tp_new */
2724 0, /* tp_free */
2728 * PyDateTime_TZInfo implementation.
2731 /* This is a pure abstract base class, so doesn't do anything beyond
2732 * raising NotImplemented exceptions. Real tzinfo classes need
2733 * to derive from this. This is mostly for clarity, and for efficiency in
2734 * datetime and time constructors (their tzinfo arguments need to
2735 * be subclasses of this tzinfo class, which is easy and quick to check).
2737 * Note: For reasons having to do with pickling of subclasses, we have
2738 * to allow tzinfo objects to be instantiated. This wasn't an issue
2739 * in the Python implementation (__init__() could raise NotImplementedError
2740 * there without ill effect), but doing so in the C implementation hit a
2741 * brick wall.
2744 static PyObject *
2745 tzinfo_nogo(const char* methodname)
2747 PyErr_Format(PyExc_NotImplementedError,
2748 "a tzinfo subclass must implement %s()",
2749 methodname);
2750 return NULL;
2753 /* Methods. A subclass must implement these. */
2755 static PyObject *
2756 tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
2758 return tzinfo_nogo("tzname");
2761 static PyObject *
2762 tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
2764 return tzinfo_nogo("utcoffset");
2767 static PyObject *
2768 tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
2770 return tzinfo_nogo("dst");
2773 static PyObject *
2774 tzinfo_fromutc(PyDateTime_TZInfo *self, PyDateTime_DateTime *dt)
2776 int y, m, d, hh, mm, ss, us;
2778 PyObject *result;
2779 int off, dst;
2780 int none;
2781 int delta;
2783 if (! PyDateTime_Check(dt)) {
2784 PyErr_SetString(PyExc_TypeError,
2785 "fromutc: argument must be a datetime");
2786 return NULL;
2788 if (! HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
2789 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
2790 "is not self");
2791 return NULL;
2794 off = call_utcoffset(dt->tzinfo, (PyObject *)dt, &none);
2795 if (off == -1 && PyErr_Occurred())
2796 return NULL;
2797 if (none) {
2798 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2799 "utcoffset() result required");
2800 return NULL;
2803 dst = call_dst(dt->tzinfo, (PyObject *)dt, &none);
2804 if (dst == -1 && PyErr_Occurred())
2805 return NULL;
2806 if (none) {
2807 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2808 "dst() result required");
2809 return NULL;
2812 y = GET_YEAR(dt);
2813 m = GET_MONTH(dt);
2814 d = GET_DAY(dt);
2815 hh = DATE_GET_HOUR(dt);
2816 mm = DATE_GET_MINUTE(dt);
2817 ss = DATE_GET_SECOND(dt);
2818 us = DATE_GET_MICROSECOND(dt);
2820 delta = off - dst;
2821 mm += delta;
2822 if ((mm < 0 || mm >= 60) &&
2823 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
2824 return NULL;
2825 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2826 if (result == NULL)
2827 return result;
2829 dst = call_dst(dt->tzinfo, result, &none);
2830 if (dst == -1 && PyErr_Occurred())
2831 goto Fail;
2832 if (none)
2833 goto Inconsistent;
2834 if (dst == 0)
2835 return result;
2837 mm += dst;
2838 if ((mm < 0 || mm >= 60) &&
2839 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
2840 goto Fail;
2841 Py_DECREF(result);
2842 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2843 return result;
2845 Inconsistent:
2846 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave"
2847 "inconsistent results; cannot convert");
2849 /* fall thru to failure */
2850 Fail:
2851 Py_DECREF(result);
2852 return NULL;
2856 * Pickle support. This is solely so that tzinfo subclasses can use
2857 * pickling -- tzinfo itself is supposed to be uninstantiable.
2860 static PyObject *
2861 tzinfo_reduce(PyObject *self)
2863 PyObject *args, *state, *tmp;
2864 PyObject *getinitargs, *getstate;
2866 tmp = PyTuple_New(0);
2867 if (tmp == NULL)
2868 return NULL;
2870 getinitargs = PyObject_GetAttrString(self, "__getinitargs__");
2871 if (getinitargs != NULL) {
2872 args = PyObject_CallObject(getinitargs, tmp);
2873 Py_DECREF(getinitargs);
2874 if (args == NULL) {
2875 Py_DECREF(tmp);
2876 return NULL;
2879 else {
2880 PyErr_Clear();
2881 args = tmp;
2882 Py_INCREF(args);
2885 getstate = PyObject_GetAttrString(self, "__getstate__");
2886 if (getstate != NULL) {
2887 state = PyObject_CallObject(getstate, tmp);
2888 Py_DECREF(getstate);
2889 if (state == NULL) {
2890 Py_DECREF(args);
2891 Py_DECREF(tmp);
2892 return NULL;
2895 else {
2896 PyObject **dictptr;
2897 PyErr_Clear();
2898 state = Py_None;
2899 dictptr = _PyObject_GetDictPtr(self);
2900 if (dictptr && *dictptr && PyDict_Size(*dictptr))
2901 state = *dictptr;
2902 Py_INCREF(state);
2905 Py_DECREF(tmp);
2907 if (state == Py_None) {
2908 Py_DECREF(state);
2909 return Py_BuildValue("(ON)", self->ob_type, args);
2911 else
2912 return Py_BuildValue("(ONN)", self->ob_type, args, state);
2915 static PyMethodDef tzinfo_methods[] = {
2917 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
2918 PyDoc_STR("datetime -> string name of time zone.")},
2920 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
2921 PyDoc_STR("datetime -> minutes east of UTC (negative for "
2922 "west of UTC).")},
2924 {"dst", (PyCFunction)tzinfo_dst, METH_O,
2925 PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
2927 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
2928 PyDoc_STR("datetime in UTC -> datetime in local time.")},
2930 {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
2931 PyDoc_STR("-> (cls, state)")},
2933 {NULL, NULL}
2936 static char tzinfo_doc[] =
2937 PyDoc_STR("Abstract base class for time zone info objects.");
2939 statichere PyTypeObject PyDateTime_TZInfoType = {
2940 PyObject_HEAD_INIT(NULL)
2941 0, /* ob_size */
2942 "datetime.tzinfo", /* tp_name */
2943 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
2944 0, /* tp_itemsize */
2945 0, /* tp_dealloc */
2946 0, /* tp_print */
2947 0, /* tp_getattr */
2948 0, /* tp_setattr */
2949 0, /* tp_compare */
2950 0, /* tp_repr */
2951 0, /* tp_as_number */
2952 0, /* tp_as_sequence */
2953 0, /* tp_as_mapping */
2954 0, /* tp_hash */
2955 0, /* tp_call */
2956 0, /* tp_str */
2957 PyObject_GenericGetAttr, /* tp_getattro */
2958 0, /* tp_setattro */
2959 0, /* tp_as_buffer */
2960 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2961 Py_TPFLAGS_BASETYPE, /* tp_flags */
2962 tzinfo_doc, /* tp_doc */
2963 0, /* tp_traverse */
2964 0, /* tp_clear */
2965 0, /* tp_richcompare */
2966 0, /* tp_weaklistoffset */
2967 0, /* tp_iter */
2968 0, /* tp_iternext */
2969 tzinfo_methods, /* tp_methods */
2970 0, /* tp_members */
2971 0, /* tp_getset */
2972 0, /* tp_base */
2973 0, /* tp_dict */
2974 0, /* tp_descr_get */
2975 0, /* tp_descr_set */
2976 0, /* tp_dictoffset */
2977 0, /* tp_init */
2978 0, /* tp_alloc */
2979 PyType_GenericNew, /* tp_new */
2980 0, /* tp_free */
2984 * PyDateTime_Time implementation.
2987 /* Accessor properties.
2990 static PyObject *
2991 time_hour(PyDateTime_Time *self, void *unused)
2993 return PyInt_FromLong(TIME_GET_HOUR(self));
2996 static PyObject *
2997 time_minute(PyDateTime_Time *self, void *unused)
2999 return PyInt_FromLong(TIME_GET_MINUTE(self));
3002 /* The name time_second conflicted with some platform header file. */
3003 static PyObject *
3004 py_time_second(PyDateTime_Time *self, void *unused)
3006 return PyInt_FromLong(TIME_GET_SECOND(self));
3009 static PyObject *
3010 time_microsecond(PyDateTime_Time *self, void *unused)
3012 return PyInt_FromLong(TIME_GET_MICROSECOND(self));
3015 static PyObject *
3016 time_tzinfo(PyDateTime_Time *self, void *unused)
3018 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3019 Py_INCREF(result);
3020 return result;
3023 static PyGetSetDef time_getset[] = {
3024 {"hour", (getter)time_hour},
3025 {"minute", (getter)time_minute},
3026 {"second", (getter)py_time_second},
3027 {"microsecond", (getter)time_microsecond},
3028 {"tzinfo", (getter)time_tzinfo},
3029 {NULL}
3033 * Constructors.
3036 static char *time_kws[] = {"hour", "minute", "second", "microsecond",
3037 "tzinfo", NULL};
3039 static PyObject *
3040 time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
3042 PyObject *self = NULL;
3043 PyObject *state;
3044 int hour = 0;
3045 int minute = 0;
3046 int second = 0;
3047 int usecond = 0;
3048 PyObject *tzinfo = Py_None;
3050 /* Check for invocation from pickle with __getstate__ state */
3051 if (PyTuple_GET_SIZE(args) >= 1 &&
3052 PyTuple_GET_SIZE(args) <= 2 &&
3053 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
3054 PyString_GET_SIZE(state) == _PyDateTime_TIME_DATASIZE &&
3055 ((unsigned char) (PyString_AS_STRING(state)[0])) < 24)
3057 PyDateTime_Time *me;
3058 char aware;
3060 if (PyTuple_GET_SIZE(args) == 2) {
3061 tzinfo = PyTuple_GET_ITEM(args, 1);
3062 if (check_tzinfo_subclass(tzinfo) < 0) {
3063 PyErr_SetString(PyExc_TypeError, "bad "
3064 "tzinfo state arg");
3065 return NULL;
3068 aware = (char)(tzinfo != Py_None);
3069 me = (PyDateTime_Time *) (type->tp_alloc(type, aware));
3070 if (me != NULL) {
3071 char *pdata = PyString_AS_STRING(state);
3073 memcpy(me->data, pdata, _PyDateTime_TIME_DATASIZE);
3074 me->hashcode = -1;
3075 me->hastzinfo = aware;
3076 if (aware) {
3077 Py_INCREF(tzinfo);
3078 me->tzinfo = tzinfo;
3081 return (PyObject *)me;
3084 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO", time_kws,
3085 &hour, &minute, &second, &usecond,
3086 &tzinfo)) {
3087 if (check_time_args(hour, minute, second, usecond) < 0)
3088 return NULL;
3089 if (check_tzinfo_subclass(tzinfo) < 0)
3090 return NULL;
3091 self = new_time_ex(hour, minute, second, usecond, tzinfo,
3092 type);
3094 return self;
3098 * Destructor.
3101 static void
3102 time_dealloc(PyDateTime_Time *self)
3104 if (HASTZINFO(self)) {
3105 Py_XDECREF(self->tzinfo);
3107 self->ob_type->tp_free((PyObject *)self);
3111 * Indirect access to tzinfo methods.
3114 /* These are all METH_NOARGS, so don't need to check the arglist. */
3115 static PyObject *
3116 time_utcoffset(PyDateTime_Time *self, PyObject *unused) {
3117 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3118 "utcoffset", Py_None);
3121 static PyObject *
3122 time_dst(PyDateTime_Time *self, PyObject *unused) {
3123 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3124 "dst", Py_None);
3127 static PyObject *
3128 time_tzname(PyDateTime_Time *self, PyObject *unused) {
3129 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
3130 Py_None);
3134 * Various ways to turn a time into a string.
3137 static PyObject *
3138 time_repr(PyDateTime_Time *self)
3140 char buffer[100];
3141 const char *typename = self->ob_type->tp_name;
3142 int h = TIME_GET_HOUR(self);
3143 int m = TIME_GET_MINUTE(self);
3144 int s = TIME_GET_SECOND(self);
3145 int us = TIME_GET_MICROSECOND(self);
3146 PyObject *result = NULL;
3148 if (us)
3149 PyOS_snprintf(buffer, sizeof(buffer),
3150 "%s(%d, %d, %d, %d)", typename, h, m, s, us);
3151 else if (s)
3152 PyOS_snprintf(buffer, sizeof(buffer),
3153 "%s(%d, %d, %d)", typename, h, m, s);
3154 else
3155 PyOS_snprintf(buffer, sizeof(buffer),
3156 "%s(%d, %d)", typename, h, m);
3157 result = PyString_FromString(buffer);
3158 if (result != NULL && HASTZINFO(self))
3159 result = append_keyword_tzinfo(result, self->tzinfo);
3160 return result;
3163 static PyObject *
3164 time_str(PyDateTime_Time *self)
3166 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
3169 static PyObject *
3170 time_isoformat(PyDateTime_Time *self)
3172 char buf[100];
3173 PyObject *result;
3174 /* Reuse the time format code from the datetime type. */
3175 PyDateTime_DateTime datetime;
3176 PyDateTime_DateTime *pdatetime = &datetime;
3178 /* Copy over just the time bytes. */
3179 memcpy(pdatetime->data + _PyDateTime_DATE_DATASIZE,
3180 self->data,
3181 _PyDateTime_TIME_DATASIZE);
3183 isoformat_time(pdatetime, buf, sizeof(buf));
3184 result = PyString_FromString(buf);
3185 if (result == NULL || ! HASTZINFO(self) || self->tzinfo == Py_None)
3186 return result;
3188 /* We need to append the UTC offset. */
3189 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
3190 Py_None) < 0) {
3191 Py_DECREF(result);
3192 return NULL;
3194 PyString_ConcatAndDel(&result, PyString_FromString(buf));
3195 return result;
3198 static PyObject *
3199 time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3201 PyObject *result;
3202 PyObject *format;
3203 PyObject *tuple;
3204 static char *keywords[] = {"format", NULL};
3206 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
3207 &PyString_Type, &format))
3208 return NULL;
3210 /* Python's strftime does insane things with the year part of the
3211 * timetuple. The year is forced to (the otherwise nonsensical)
3212 * 1900 to worm around that.
3214 tuple = Py_BuildValue("iiiiiiiii",
3215 1900, 1, 1, /* year, month, day */
3216 TIME_GET_HOUR(self),
3217 TIME_GET_MINUTE(self),
3218 TIME_GET_SECOND(self),
3219 0, 1, -1); /* weekday, daynum, dst */
3220 if (tuple == NULL)
3221 return NULL;
3222 assert(PyTuple_Size(tuple) == 9);
3223 result = wrap_strftime((PyObject *)self, format, tuple, Py_None);
3224 Py_DECREF(tuple);
3225 return result;
3229 * Miscellaneous methods.
3232 /* This is more natural as a tp_compare, but doesn't work then: for whatever
3233 * reason, Python's try_3way_compare ignores tp_compare unless
3234 * PyInstance_Check returns true, but these aren't old-style classes.
3236 static PyObject *
3237 time_richcompare(PyDateTime_Time *self, PyObject *other, int op)
3239 int diff;
3240 naivety n1, n2;
3241 int offset1, offset2;
3243 if (! PyTime_Check(other)) {
3244 if (op == Py_EQ || op == Py_NE) {
3245 PyObject *result = op == Py_EQ ? Py_False : Py_True;
3246 Py_INCREF(result);
3247 return result;
3249 /* Stop this from falling back to address comparison. */
3250 return cmperror((PyObject *)self, other);
3252 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1, Py_None,
3253 other, &offset2, &n2, Py_None) < 0)
3254 return NULL;
3255 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
3256 /* If they're both naive, or both aware and have the same offsets,
3257 * we get off cheap. Note that if they're both naive, offset1 ==
3258 * offset2 == 0 at this point.
3260 if (n1 == n2 && offset1 == offset2) {
3261 diff = memcmp(self->data, ((PyDateTime_Time *)other)->data,
3262 _PyDateTime_TIME_DATASIZE);
3263 return diff_to_bool(diff, op);
3266 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
3267 assert(offset1 != offset2); /* else last "if" handled it */
3268 /* Convert everything except microseconds to seconds. These
3269 * can't overflow (no more than the # of seconds in 2 days).
3271 offset1 = TIME_GET_HOUR(self) * 3600 +
3272 (TIME_GET_MINUTE(self) - offset1) * 60 +
3273 TIME_GET_SECOND(self);
3274 offset2 = TIME_GET_HOUR(other) * 3600 +
3275 (TIME_GET_MINUTE(other) - offset2) * 60 +
3276 TIME_GET_SECOND(other);
3277 diff = offset1 - offset2;
3278 if (diff == 0)
3279 diff = TIME_GET_MICROSECOND(self) -
3280 TIME_GET_MICROSECOND(other);
3281 return diff_to_bool(diff, op);
3284 assert(n1 != n2);
3285 PyErr_SetString(PyExc_TypeError,
3286 "can't compare offset-naive and "
3287 "offset-aware times");
3288 return NULL;
3291 static long
3292 time_hash(PyDateTime_Time *self)
3294 if (self->hashcode == -1) {
3295 naivety n;
3296 int offset;
3297 PyObject *temp;
3299 n = classify_utcoffset((PyObject *)self, Py_None, &offset);
3300 assert(n != OFFSET_UNKNOWN);
3301 if (n == OFFSET_ERROR)
3302 return -1;
3304 /* Reduce this to a hash of another object. */
3305 if (offset == 0)
3306 temp = PyString_FromStringAndSize((char *)self->data,
3307 _PyDateTime_TIME_DATASIZE);
3308 else {
3309 int hour;
3310 int minute;
3312 assert(n == OFFSET_AWARE);
3313 assert(HASTZINFO(self));
3314 hour = divmod(TIME_GET_HOUR(self) * 60 +
3315 TIME_GET_MINUTE(self) - offset,
3317 &minute);
3318 if (0 <= hour && hour < 24)
3319 temp = new_time(hour, minute,
3320 TIME_GET_SECOND(self),
3321 TIME_GET_MICROSECOND(self),
3322 Py_None);
3323 else
3324 temp = Py_BuildValue("iiii",
3325 hour, minute,
3326 TIME_GET_SECOND(self),
3327 TIME_GET_MICROSECOND(self));
3329 if (temp != NULL) {
3330 self->hashcode = PyObject_Hash(temp);
3331 Py_DECREF(temp);
3334 return self->hashcode;
3337 static PyObject *
3338 time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3340 PyObject *clone;
3341 PyObject *tuple;
3342 int hh = TIME_GET_HOUR(self);
3343 int mm = TIME_GET_MINUTE(self);
3344 int ss = TIME_GET_SECOND(self);
3345 int us = TIME_GET_MICROSECOND(self);
3346 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
3348 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO:replace",
3349 time_kws,
3350 &hh, &mm, &ss, &us, &tzinfo))
3351 return NULL;
3352 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
3353 if (tuple == NULL)
3354 return NULL;
3355 clone = time_new(self->ob_type, tuple, NULL);
3356 Py_DECREF(tuple);
3357 return clone;
3360 static int
3361 time_nonzero(PyDateTime_Time *self)
3363 int offset;
3364 int none;
3366 if (TIME_GET_SECOND(self) || TIME_GET_MICROSECOND(self)) {
3367 /* Since utcoffset is in whole minutes, nothing can
3368 * alter the conclusion that this is nonzero.
3370 return 1;
3372 offset = 0;
3373 if (HASTZINFO(self) && self->tzinfo != Py_None) {
3374 offset = call_utcoffset(self->tzinfo, Py_None, &none);
3375 if (offset == -1 && PyErr_Occurred())
3376 return -1;
3378 return (TIME_GET_MINUTE(self) - offset + TIME_GET_HOUR(self)*60) != 0;
3381 /* Pickle support, a simple use of __reduce__. */
3383 /* Let basestate be the non-tzinfo data string.
3384 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
3385 * So it's a tuple in any (non-error) case.
3386 * __getstate__ isn't exposed.
3388 static PyObject *
3389 time_getstate(PyDateTime_Time *self)
3391 PyObject *basestate;
3392 PyObject *result = NULL;
3394 basestate = PyString_FromStringAndSize((char *)self->data,
3395 _PyDateTime_TIME_DATASIZE);
3396 if (basestate != NULL) {
3397 if (! HASTZINFO(self) || self->tzinfo == Py_None)
3398 result = PyTuple_Pack(1, basestate);
3399 else
3400 result = PyTuple_Pack(2, basestate, self->tzinfo);
3401 Py_DECREF(basestate);
3403 return result;
3406 static PyObject *
3407 time_reduce(PyDateTime_Time *self, PyObject *arg)
3409 return Py_BuildValue("(ON)", self->ob_type, time_getstate(self));
3412 static PyMethodDef time_methods[] = {
3414 {"isoformat", (PyCFunction)time_isoformat, METH_KEYWORDS,
3415 PyDoc_STR("Return string in ISO 8601 format, HH:MM:SS[.mmmmmm]"
3416 "[+HH:MM].")},
3418 {"strftime", (PyCFunction)time_strftime, METH_KEYWORDS,
3419 PyDoc_STR("format -> strftime() style string.")},
3421 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
3422 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
3424 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
3425 PyDoc_STR("Return self.tzinfo.tzname(self).")},
3427 {"dst", (PyCFunction)time_dst, METH_NOARGS,
3428 PyDoc_STR("Return self.tzinfo.dst(self).")},
3430 {"replace", (PyCFunction)time_replace, METH_KEYWORDS,
3431 PyDoc_STR("Return time with new specified fields.")},
3433 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
3434 PyDoc_STR("__reduce__() -> (cls, state)")},
3436 {NULL, NULL}
3439 static char time_doc[] =
3440 PyDoc_STR("time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object\n\
3442 All arguments are optional. tzinfo may be None, or an instance of\n\
3443 a tzinfo subclass. The remaining arguments may be ints or longs.\n");
3445 static PyNumberMethods time_as_number = {
3446 0, /* nb_add */
3447 0, /* nb_subtract */
3448 0, /* nb_multiply */
3449 0, /* nb_divide */
3450 0, /* nb_remainder */
3451 0, /* nb_divmod */
3452 0, /* nb_power */
3453 0, /* nb_negative */
3454 0, /* nb_positive */
3455 0, /* nb_absolute */
3456 (inquiry)time_nonzero, /* nb_nonzero */
3459 statichere PyTypeObject PyDateTime_TimeType = {
3460 PyObject_HEAD_INIT(NULL)
3461 0, /* ob_size */
3462 "datetime.time", /* tp_name */
3463 sizeof(PyDateTime_Time), /* tp_basicsize */
3464 0, /* tp_itemsize */
3465 (destructor)time_dealloc, /* tp_dealloc */
3466 0, /* tp_print */
3467 0, /* tp_getattr */
3468 0, /* tp_setattr */
3469 0, /* tp_compare */
3470 (reprfunc)time_repr, /* tp_repr */
3471 &time_as_number, /* tp_as_number */
3472 0, /* tp_as_sequence */
3473 0, /* tp_as_mapping */
3474 (hashfunc)time_hash, /* tp_hash */
3475 0, /* tp_call */
3476 (reprfunc)time_str, /* tp_str */
3477 PyObject_GenericGetAttr, /* tp_getattro */
3478 0, /* tp_setattro */
3479 0, /* tp_as_buffer */
3480 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
3481 Py_TPFLAGS_BASETYPE, /* tp_flags */
3482 time_doc, /* tp_doc */
3483 0, /* tp_traverse */
3484 0, /* tp_clear */
3485 (richcmpfunc)time_richcompare, /* tp_richcompare */
3486 0, /* tp_weaklistoffset */
3487 0, /* tp_iter */
3488 0, /* tp_iternext */
3489 time_methods, /* tp_methods */
3490 0, /* tp_members */
3491 time_getset, /* tp_getset */
3492 0, /* tp_base */
3493 0, /* tp_dict */
3494 0, /* tp_descr_get */
3495 0, /* tp_descr_set */
3496 0, /* tp_dictoffset */
3497 0, /* tp_init */
3498 time_alloc, /* tp_alloc */
3499 time_new, /* tp_new */
3500 0, /* tp_free */
3504 * PyDateTime_DateTime implementation.
3507 /* Accessor properties. Properties for day, month, and year are inherited
3508 * from date.
3511 static PyObject *
3512 datetime_hour(PyDateTime_DateTime *self, void *unused)
3514 return PyInt_FromLong(DATE_GET_HOUR(self));
3517 static PyObject *
3518 datetime_minute(PyDateTime_DateTime *self, void *unused)
3520 return PyInt_FromLong(DATE_GET_MINUTE(self));
3523 static PyObject *
3524 datetime_second(PyDateTime_DateTime *self, void *unused)
3526 return PyInt_FromLong(DATE_GET_SECOND(self));
3529 static PyObject *
3530 datetime_microsecond(PyDateTime_DateTime *self, void *unused)
3532 return PyInt_FromLong(DATE_GET_MICROSECOND(self));
3535 static PyObject *
3536 datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
3538 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3539 Py_INCREF(result);
3540 return result;
3543 static PyGetSetDef datetime_getset[] = {
3544 {"hour", (getter)datetime_hour},
3545 {"minute", (getter)datetime_minute},
3546 {"second", (getter)datetime_second},
3547 {"microsecond", (getter)datetime_microsecond},
3548 {"tzinfo", (getter)datetime_tzinfo},
3549 {NULL}
3553 * Constructors.
3556 static char *datetime_kws[] = {
3557 "year", "month", "day", "hour", "minute", "second",
3558 "microsecond", "tzinfo", NULL
3561 static PyObject *
3562 datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
3564 PyObject *self = NULL;
3565 PyObject *state;
3566 int year;
3567 int month;
3568 int day;
3569 int hour = 0;
3570 int minute = 0;
3571 int second = 0;
3572 int usecond = 0;
3573 PyObject *tzinfo = Py_None;
3575 /* Check for invocation from pickle with __getstate__ state */
3576 if (PyTuple_GET_SIZE(args) >= 1 &&
3577 PyTuple_GET_SIZE(args) <= 2 &&
3578 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
3579 PyString_GET_SIZE(state) == _PyDateTime_DATETIME_DATASIZE &&
3580 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
3582 PyDateTime_DateTime *me;
3583 char aware;
3585 if (PyTuple_GET_SIZE(args) == 2) {
3586 tzinfo = PyTuple_GET_ITEM(args, 1);
3587 if (check_tzinfo_subclass(tzinfo) < 0) {
3588 PyErr_SetString(PyExc_TypeError, "bad "
3589 "tzinfo state arg");
3590 return NULL;
3593 aware = (char)(tzinfo != Py_None);
3594 me = (PyDateTime_DateTime *) (type->tp_alloc(type , aware));
3595 if (me != NULL) {
3596 char *pdata = PyString_AS_STRING(state);
3598 memcpy(me->data, pdata, _PyDateTime_DATETIME_DATASIZE);
3599 me->hashcode = -1;
3600 me->hastzinfo = aware;
3601 if (aware) {
3602 Py_INCREF(tzinfo);
3603 me->tzinfo = tzinfo;
3606 return (PyObject *)me;
3609 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO", datetime_kws,
3610 &year, &month, &day, &hour, &minute,
3611 &second, &usecond, &tzinfo)) {
3612 if (check_date_args(year, month, day) < 0)
3613 return NULL;
3614 if (check_time_args(hour, minute, second, usecond) < 0)
3615 return NULL;
3616 if (check_tzinfo_subclass(tzinfo) < 0)
3617 return NULL;
3618 self = new_datetime_ex(year, month, day,
3619 hour, minute, second, usecond,
3620 tzinfo, type);
3622 return self;
3625 /* TM_FUNC is the shared type of localtime() and gmtime(). */
3626 typedef struct tm *(*TM_FUNC)(const time_t *timer);
3628 /* Internal helper.
3629 * Build datetime from a time_t and a distinct count of microseconds.
3630 * Pass localtime or gmtime for f, to control the interpretation of timet.
3632 static PyObject *
3633 datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
3634 PyObject *tzinfo)
3636 struct tm *tm;
3637 PyObject *result = NULL;
3639 tm = f(&timet);
3640 if (tm) {
3641 /* The platform localtime/gmtime may insert leap seconds,
3642 * indicated by tm->tm_sec > 59. We don't care about them,
3643 * except to the extent that passing them on to the datetime
3644 * constructor would raise ValueError for a reason that
3645 * made no sense to the user.
3647 if (tm->tm_sec > 59)
3648 tm->tm_sec = 59;
3649 result = PyObject_CallFunction(cls, "iiiiiiiO",
3650 tm->tm_year + 1900,
3651 tm->tm_mon + 1,
3652 tm->tm_mday,
3653 tm->tm_hour,
3654 tm->tm_min,
3655 tm->tm_sec,
3657 tzinfo);
3659 else
3660 PyErr_SetString(PyExc_ValueError,
3661 "timestamp out of range for "
3662 "platform localtime()/gmtime() function");
3663 return result;
3666 /* Internal helper.
3667 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
3668 * to control the interpretation of the timestamp. Since a double doesn't
3669 * have enough bits to cover a datetime's full range of precision, it's
3670 * better to call datetime_from_timet_and_us provided you have a way
3671 * to get that much precision (e.g., C time() isn't good enough).
3673 static PyObject *
3674 datetime_from_timestamp(PyObject *cls, TM_FUNC f, double timestamp,
3675 PyObject *tzinfo)
3677 time_t timet;
3678 double fraction;
3679 int us;
3681 timet = _PyTime_DoubleToTimet(timestamp);
3682 if (timet == (time_t)-1 && PyErr_Occurred())
3683 return NULL;
3684 fraction = timestamp - (double)timet;
3685 us = (int)round_to_long(fraction * 1e6);
3686 return datetime_from_timet_and_us(cls, f, timet, us, tzinfo);
3689 /* Internal helper.
3690 * Build most accurate possible datetime for current time. Pass localtime or
3691 * gmtime for f as appropriate.
3693 static PyObject *
3694 datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
3696 #ifdef HAVE_GETTIMEOFDAY
3697 struct timeval t;
3699 #ifdef GETTIMEOFDAY_NO_TZ
3700 gettimeofday(&t);
3701 #else
3702 gettimeofday(&t, (struct timezone *)NULL);
3703 #endif
3704 return datetime_from_timet_and_us(cls, f, t.tv_sec, (int)t.tv_usec,
3705 tzinfo);
3707 #else /* ! HAVE_GETTIMEOFDAY */
3708 /* No flavor of gettimeofday exists on this platform. Python's
3709 * time.time() does a lot of other platform tricks to get the
3710 * best time it can on the platform, and we're not going to do
3711 * better than that (if we could, the better code would belong
3712 * in time.time()!) We're limited by the precision of a double,
3713 * though.
3715 PyObject *time;
3716 double dtime;
3718 time = time_time();
3719 if (time == NULL)
3720 return NULL;
3721 dtime = PyFloat_AsDouble(time);
3722 Py_DECREF(time);
3723 if (dtime == -1.0 && PyErr_Occurred())
3724 return NULL;
3725 return datetime_from_timestamp(cls, f, dtime, tzinfo);
3726 #endif /* ! HAVE_GETTIMEOFDAY */
3729 /* Return best possible local time -- this isn't constrained by the
3730 * precision of a timestamp.
3732 static PyObject *
3733 datetime_now(PyObject *cls, PyObject *args, PyObject *kw)
3735 PyObject *self;
3736 PyObject *tzinfo = Py_None;
3737 static char *keywords[] = {"tz", NULL};
3739 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:now", keywords,
3740 &tzinfo))
3741 return NULL;
3742 if (check_tzinfo_subclass(tzinfo) < 0)
3743 return NULL;
3745 self = datetime_best_possible(cls,
3746 tzinfo == Py_None ? localtime : gmtime,
3747 tzinfo);
3748 if (self != NULL && tzinfo != Py_None) {
3749 /* Convert UTC to tzinfo's zone. */
3750 PyObject *temp = self;
3751 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3752 Py_DECREF(temp);
3754 return self;
3757 /* Return best possible UTC time -- this isn't constrained by the
3758 * precision of a timestamp.
3760 static PyObject *
3761 datetime_utcnow(PyObject *cls, PyObject *dummy)
3763 return datetime_best_possible(cls, gmtime, Py_None);
3766 /* Return new local datetime from timestamp (Python timestamp -- a double). */
3767 static PyObject *
3768 datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
3770 PyObject *self;
3771 double timestamp;
3772 PyObject *tzinfo = Py_None;
3773 static char *keywords[] = {"timestamp", "tz", NULL};
3775 if (! PyArg_ParseTupleAndKeywords(args, kw, "d|O:fromtimestamp",
3776 keywords, &timestamp, &tzinfo))
3777 return NULL;
3778 if (check_tzinfo_subclass(tzinfo) < 0)
3779 return NULL;
3781 self = datetime_from_timestamp(cls,
3782 tzinfo == Py_None ? localtime : gmtime,
3783 timestamp,
3784 tzinfo);
3785 if (self != NULL && tzinfo != Py_None) {
3786 /* Convert UTC to tzinfo's zone. */
3787 PyObject *temp = self;
3788 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3789 Py_DECREF(temp);
3791 return self;
3794 /* Return new UTC datetime from timestamp (Python timestamp -- a double). */
3795 static PyObject *
3796 datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
3798 double timestamp;
3799 PyObject *result = NULL;
3801 if (PyArg_ParseTuple(args, "d:utcfromtimestamp", &timestamp))
3802 result = datetime_from_timestamp(cls, gmtime, timestamp,
3803 Py_None);
3804 return result;
3807 /* Return new datetime from time.strptime(). */
3808 static PyObject *
3809 datetime_strptime(PyObject *cls, PyObject *args)
3811 PyObject *result = NULL, *obj, *module;
3812 const char *string, *format;
3814 if (!PyArg_ParseTuple(args, "ss:strptime", &string, &format))
3815 return NULL;
3817 if ((module = PyImport_ImportModule("time")) == NULL)
3818 return NULL;
3819 obj = PyObject_CallMethod(module, "strptime", "ss", string, format);
3820 Py_DECREF(module);
3822 if (obj != NULL) {
3823 int i, good_timetuple = 1;
3824 long int ia[6];
3825 if (PySequence_Check(obj) && PySequence_Size(obj) >= 6)
3826 for (i=0; i < 6; i++) {
3827 PyObject *p = PySequence_GetItem(obj, i);
3828 if (PyInt_Check(p))
3829 ia[i] = PyInt_AsLong(p);
3830 else
3831 good_timetuple = 0;
3832 Py_DECREF(p);
3834 else
3835 good_timetuple = 0;
3836 if (good_timetuple)
3837 result = PyObject_CallFunction(cls, "iiiiii",
3838 ia[0], ia[1], ia[2], ia[3], ia[4], ia[5]);
3839 else
3840 PyErr_SetString(PyExc_ValueError,
3841 "unexpected value from time.strptime");
3842 Py_DECREF(obj);
3844 return result;
3847 /* Return new datetime from date/datetime and time arguments. */
3848 static PyObject *
3849 datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
3851 static char *keywords[] = {"date", "time", NULL};
3852 PyObject *date;
3853 PyObject *time;
3854 PyObject *result = NULL;
3856 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!:combine", keywords,
3857 &PyDateTime_DateType, &date,
3858 &PyDateTime_TimeType, &time)) {
3859 PyObject *tzinfo = Py_None;
3861 if (HASTZINFO(time))
3862 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
3863 result = PyObject_CallFunction(cls, "iiiiiiiO",
3864 GET_YEAR(date),
3865 GET_MONTH(date),
3866 GET_DAY(date),
3867 TIME_GET_HOUR(time),
3868 TIME_GET_MINUTE(time),
3869 TIME_GET_SECOND(time),
3870 TIME_GET_MICROSECOND(time),
3871 tzinfo);
3873 return result;
3877 * Destructor.
3880 static void
3881 datetime_dealloc(PyDateTime_DateTime *self)
3883 if (HASTZINFO(self)) {
3884 Py_XDECREF(self->tzinfo);
3886 self->ob_type->tp_free((PyObject *)self);
3890 * Indirect access to tzinfo methods.
3893 /* These are all METH_NOARGS, so don't need to check the arglist. */
3894 static PyObject *
3895 datetime_utcoffset(PyDateTime_DateTime *self, PyObject *unused) {
3896 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3897 "utcoffset", (PyObject *)self);
3900 static PyObject *
3901 datetime_dst(PyDateTime_DateTime *self, PyObject *unused) {
3902 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3903 "dst", (PyObject *)self);
3906 static PyObject *
3907 datetime_tzname(PyDateTime_DateTime *self, PyObject *unused) {
3908 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
3909 (PyObject *)self);
3913 * datetime arithmetic.
3916 /* factor must be 1 (to add) or -1 (to subtract). The result inherits
3917 * the tzinfo state of date.
3919 static PyObject *
3920 add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
3921 int factor)
3923 /* Note that the C-level additions can't overflow, because of
3924 * invariant bounds on the member values.
3926 int year = GET_YEAR(date);
3927 int month = GET_MONTH(date);
3928 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
3929 int hour = DATE_GET_HOUR(date);
3930 int minute = DATE_GET_MINUTE(date);
3931 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
3932 int microsecond = DATE_GET_MICROSECOND(date) +
3933 GET_TD_MICROSECONDS(delta) * factor;
3935 assert(factor == 1 || factor == -1);
3936 if (normalize_datetime(&year, &month, &day,
3937 &hour, &minute, &second, &microsecond) < 0)
3938 return NULL;
3939 else
3940 return new_datetime(year, month, day,
3941 hour, minute, second, microsecond,
3942 HASTZINFO(date) ? date->tzinfo : Py_None);
3945 static PyObject *
3946 datetime_add(PyObject *left, PyObject *right)
3948 if (PyDateTime_Check(left)) {
3949 /* datetime + ??? */
3950 if (PyDelta_Check(right))
3951 /* datetime + delta */
3952 return add_datetime_timedelta(
3953 (PyDateTime_DateTime *)left,
3954 (PyDateTime_Delta *)right,
3957 else if (PyDelta_Check(left)) {
3958 /* delta + datetime */
3959 return add_datetime_timedelta((PyDateTime_DateTime *) right,
3960 (PyDateTime_Delta *) left,
3963 Py_INCREF(Py_NotImplemented);
3964 return Py_NotImplemented;
3967 static PyObject *
3968 datetime_subtract(PyObject *left, PyObject *right)
3970 PyObject *result = Py_NotImplemented;
3972 if (PyDateTime_Check(left)) {
3973 /* datetime - ??? */
3974 if (PyDateTime_Check(right)) {
3975 /* datetime - datetime */
3976 naivety n1, n2;
3977 int offset1, offset2;
3978 int delta_d, delta_s, delta_us;
3980 if (classify_two_utcoffsets(left, &offset1, &n1, left,
3981 right, &offset2, &n2,
3982 right) < 0)
3983 return NULL;
3984 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
3985 if (n1 != n2) {
3986 PyErr_SetString(PyExc_TypeError,
3987 "can't subtract offset-naive and "
3988 "offset-aware datetimes");
3989 return NULL;
3991 delta_d = ymd_to_ord(GET_YEAR(left),
3992 GET_MONTH(left),
3993 GET_DAY(left)) -
3994 ymd_to_ord(GET_YEAR(right),
3995 GET_MONTH(right),
3996 GET_DAY(right));
3997 /* These can't overflow, since the values are
3998 * normalized. At most this gives the number of
3999 * seconds in one day.
4001 delta_s = (DATE_GET_HOUR(left) -
4002 DATE_GET_HOUR(right)) * 3600 +
4003 (DATE_GET_MINUTE(left) -
4004 DATE_GET_MINUTE(right)) * 60 +
4005 (DATE_GET_SECOND(left) -
4006 DATE_GET_SECOND(right));
4007 delta_us = DATE_GET_MICROSECOND(left) -
4008 DATE_GET_MICROSECOND(right);
4009 /* (left - offset1) - (right - offset2) =
4010 * (left - right) + (offset2 - offset1)
4012 delta_s += (offset2 - offset1) * 60;
4013 result = new_delta(delta_d, delta_s, delta_us, 1);
4015 else if (PyDelta_Check(right)) {
4016 /* datetime - delta */
4017 result = add_datetime_timedelta(
4018 (PyDateTime_DateTime *)left,
4019 (PyDateTime_Delta *)right,
4020 -1);
4024 if (result == Py_NotImplemented)
4025 Py_INCREF(result);
4026 return result;
4029 /* Various ways to turn a datetime into a string. */
4031 static PyObject *
4032 datetime_repr(PyDateTime_DateTime *self)
4034 char buffer[1000];
4035 const char *typename = self->ob_type->tp_name;
4036 PyObject *baserepr;
4038 if (DATE_GET_MICROSECOND(self)) {
4039 PyOS_snprintf(buffer, sizeof(buffer),
4040 "%s(%d, %d, %d, %d, %d, %d, %d)",
4041 typename,
4042 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4043 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4044 DATE_GET_SECOND(self),
4045 DATE_GET_MICROSECOND(self));
4047 else if (DATE_GET_SECOND(self)) {
4048 PyOS_snprintf(buffer, sizeof(buffer),
4049 "%s(%d, %d, %d, %d, %d, %d)",
4050 typename,
4051 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4052 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4053 DATE_GET_SECOND(self));
4055 else {
4056 PyOS_snprintf(buffer, sizeof(buffer),
4057 "%s(%d, %d, %d, %d, %d)",
4058 typename,
4059 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4060 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
4062 baserepr = PyString_FromString(buffer);
4063 if (baserepr == NULL || ! HASTZINFO(self))
4064 return baserepr;
4065 return append_keyword_tzinfo(baserepr, self->tzinfo);
4068 static PyObject *
4069 datetime_str(PyDateTime_DateTime *self)
4071 return PyObject_CallMethod((PyObject *)self, "isoformat", "(s)", " ");
4074 static PyObject *
4075 datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
4077 char sep = 'T';
4078 static char *keywords[] = {"sep", NULL};
4079 char buffer[100];
4080 char *cp;
4081 PyObject *result;
4083 if (!PyArg_ParseTupleAndKeywords(args, kw, "|c:isoformat", keywords,
4084 &sep))
4085 return NULL;
4086 cp = isoformat_date((PyDateTime_Date *)self, buffer, sizeof(buffer));
4087 assert(cp != NULL);
4088 *cp++ = sep;
4089 isoformat_time(self, cp, sizeof(buffer) - (cp - buffer));
4090 result = PyString_FromString(buffer);
4091 if (result == NULL || ! HASTZINFO(self))
4092 return result;
4094 /* We need to append the UTC offset. */
4095 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
4096 (PyObject *)self) < 0) {
4097 Py_DECREF(result);
4098 return NULL;
4100 PyString_ConcatAndDel(&result, PyString_FromString(buffer));
4101 return result;
4104 static PyObject *
4105 datetime_ctime(PyDateTime_DateTime *self)
4107 return format_ctime((PyDateTime_Date *)self,
4108 DATE_GET_HOUR(self),
4109 DATE_GET_MINUTE(self),
4110 DATE_GET_SECOND(self));
4113 /* Miscellaneous methods. */
4115 /* This is more natural as a tp_compare, but doesn't work then: for whatever
4116 * reason, Python's try_3way_compare ignores tp_compare unless
4117 * PyInstance_Check returns true, but these aren't old-style classes.
4119 static PyObject *
4120 datetime_richcompare(PyDateTime_DateTime *self, PyObject *other, int op)
4122 int diff;
4123 naivety n1, n2;
4124 int offset1, offset2;
4126 if (! PyDateTime_Check(other)) {
4127 /* If other has a "timetuple" attr, that's an advertised
4128 * hook for other classes to ask to get comparison control.
4129 * However, date instances have a timetuple attr, and we
4130 * don't want to allow that comparison. Because datetime
4131 * is a subclass of date, when mixing date and datetime
4132 * in a comparison, Python gives datetime the first shot
4133 * (it's the more specific subtype). So we can stop that
4134 * combination here reliably.
4136 if (PyObject_HasAttrString(other, "timetuple") &&
4137 ! PyDate_Check(other)) {
4138 /* A hook for other kinds of datetime objects. */
4139 Py_INCREF(Py_NotImplemented);
4140 return Py_NotImplemented;
4142 if (op == Py_EQ || op == Py_NE) {
4143 PyObject *result = op == Py_EQ ? Py_False : Py_True;
4144 Py_INCREF(result);
4145 return result;
4147 /* Stop this from falling back to address comparison. */
4148 return cmperror((PyObject *)self, other);
4151 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1,
4152 (PyObject *)self,
4153 other, &offset2, &n2,
4154 other) < 0)
4155 return NULL;
4156 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
4157 /* If they're both naive, or both aware and have the same offsets,
4158 * we get off cheap. Note that if they're both naive, offset1 ==
4159 * offset2 == 0 at this point.
4161 if (n1 == n2 && offset1 == offset2) {
4162 diff = memcmp(self->data, ((PyDateTime_DateTime *)other)->data,
4163 _PyDateTime_DATETIME_DATASIZE);
4164 return diff_to_bool(diff, op);
4167 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
4168 PyDateTime_Delta *delta;
4170 assert(offset1 != offset2); /* else last "if" handled it */
4171 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
4172 other);
4173 if (delta == NULL)
4174 return NULL;
4175 diff = GET_TD_DAYS(delta);
4176 if (diff == 0)
4177 diff = GET_TD_SECONDS(delta) |
4178 GET_TD_MICROSECONDS(delta);
4179 Py_DECREF(delta);
4180 return diff_to_bool(diff, op);
4183 assert(n1 != n2);
4184 PyErr_SetString(PyExc_TypeError,
4185 "can't compare offset-naive and "
4186 "offset-aware datetimes");
4187 return NULL;
4190 static long
4191 datetime_hash(PyDateTime_DateTime *self)
4193 if (self->hashcode == -1) {
4194 naivety n;
4195 int offset;
4196 PyObject *temp;
4198 n = classify_utcoffset((PyObject *)self, (PyObject *)self,
4199 &offset);
4200 assert(n != OFFSET_UNKNOWN);
4201 if (n == OFFSET_ERROR)
4202 return -1;
4204 /* Reduce this to a hash of another object. */
4205 if (n == OFFSET_NAIVE)
4206 temp = PyString_FromStringAndSize(
4207 (char *)self->data,
4208 _PyDateTime_DATETIME_DATASIZE);
4209 else {
4210 int days;
4211 int seconds;
4213 assert(n == OFFSET_AWARE);
4214 assert(HASTZINFO(self));
4215 days = ymd_to_ord(GET_YEAR(self),
4216 GET_MONTH(self),
4217 GET_DAY(self));
4218 seconds = DATE_GET_HOUR(self) * 3600 +
4219 (DATE_GET_MINUTE(self) - offset) * 60 +
4220 DATE_GET_SECOND(self);
4221 temp = new_delta(days,
4222 seconds,
4223 DATE_GET_MICROSECOND(self),
4226 if (temp != NULL) {
4227 self->hashcode = PyObject_Hash(temp);
4228 Py_DECREF(temp);
4231 return self->hashcode;
4234 static PyObject *
4235 datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
4237 PyObject *clone;
4238 PyObject *tuple;
4239 int y = GET_YEAR(self);
4240 int m = GET_MONTH(self);
4241 int d = GET_DAY(self);
4242 int hh = DATE_GET_HOUR(self);
4243 int mm = DATE_GET_MINUTE(self);
4244 int ss = DATE_GET_SECOND(self);
4245 int us = DATE_GET_MICROSECOND(self);
4246 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
4248 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO:replace",
4249 datetime_kws,
4250 &y, &m, &d, &hh, &mm, &ss, &us,
4251 &tzinfo))
4252 return NULL;
4253 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
4254 if (tuple == NULL)
4255 return NULL;
4256 clone = datetime_new(self->ob_type, tuple, NULL);
4257 Py_DECREF(tuple);
4258 return clone;
4261 static PyObject *
4262 datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
4264 int y, m, d, hh, mm, ss, us;
4265 PyObject *result;
4266 int offset, none;
4268 PyObject *tzinfo;
4269 static char *keywords[] = {"tz", NULL};
4271 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:astimezone", keywords,
4272 &PyDateTime_TZInfoType, &tzinfo))
4273 return NULL;
4275 if (!HASTZINFO(self) || self->tzinfo == Py_None)
4276 goto NeedAware;
4278 /* Conversion to self's own time zone is a NOP. */
4279 if (self->tzinfo == tzinfo) {
4280 Py_INCREF(self);
4281 return (PyObject *)self;
4284 /* Convert self to UTC. */
4285 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4286 if (offset == -1 && PyErr_Occurred())
4287 return NULL;
4288 if (none)
4289 goto NeedAware;
4291 y = GET_YEAR(self);
4292 m = GET_MONTH(self);
4293 d = GET_DAY(self);
4294 hh = DATE_GET_HOUR(self);
4295 mm = DATE_GET_MINUTE(self);
4296 ss = DATE_GET_SECOND(self);
4297 us = DATE_GET_MICROSECOND(self);
4299 mm -= offset;
4300 if ((mm < 0 || mm >= 60) &&
4301 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
4302 return NULL;
4304 /* Attach new tzinfo and let fromutc() do the rest. */
4305 result = new_datetime(y, m, d, hh, mm, ss, us, tzinfo);
4306 if (result != NULL) {
4307 PyObject *temp = result;
4309 result = PyObject_CallMethod(tzinfo, "fromutc", "O", temp);
4310 Py_DECREF(temp);
4312 return result;
4314 NeedAware:
4315 PyErr_SetString(PyExc_ValueError, "astimezone() cannot be applied to "
4316 "a naive datetime");
4317 return NULL;
4320 static PyObject *
4321 datetime_timetuple(PyDateTime_DateTime *self)
4323 int dstflag = -1;
4325 if (HASTZINFO(self) && self->tzinfo != Py_None) {
4326 int none;
4328 dstflag = call_dst(self->tzinfo, (PyObject *)self, &none);
4329 if (dstflag == -1 && PyErr_Occurred())
4330 return NULL;
4332 if (none)
4333 dstflag = -1;
4334 else if (dstflag != 0)
4335 dstflag = 1;
4338 return build_struct_time(GET_YEAR(self),
4339 GET_MONTH(self),
4340 GET_DAY(self),
4341 DATE_GET_HOUR(self),
4342 DATE_GET_MINUTE(self),
4343 DATE_GET_SECOND(self),
4344 dstflag);
4347 static PyObject *
4348 datetime_getdate(PyDateTime_DateTime *self)
4350 return new_date(GET_YEAR(self),
4351 GET_MONTH(self),
4352 GET_DAY(self));
4355 static PyObject *
4356 datetime_gettime(PyDateTime_DateTime *self)
4358 return new_time(DATE_GET_HOUR(self),
4359 DATE_GET_MINUTE(self),
4360 DATE_GET_SECOND(self),
4361 DATE_GET_MICROSECOND(self),
4362 Py_None);
4365 static PyObject *
4366 datetime_gettimetz(PyDateTime_DateTime *self)
4368 return new_time(DATE_GET_HOUR(self),
4369 DATE_GET_MINUTE(self),
4370 DATE_GET_SECOND(self),
4371 DATE_GET_MICROSECOND(self),
4372 HASTZINFO(self) ? self->tzinfo : Py_None);
4375 static PyObject *
4376 datetime_utctimetuple(PyDateTime_DateTime *self)
4378 int y = GET_YEAR(self);
4379 int m = GET_MONTH(self);
4380 int d = GET_DAY(self);
4381 int hh = DATE_GET_HOUR(self);
4382 int mm = DATE_GET_MINUTE(self);
4383 int ss = DATE_GET_SECOND(self);
4384 int us = 0; /* microseconds are ignored in a timetuple */
4385 int offset = 0;
4387 if (HASTZINFO(self) && self->tzinfo != Py_None) {
4388 int none;
4390 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4391 if (offset == -1 && PyErr_Occurred())
4392 return NULL;
4394 /* Even if offset is 0, don't call timetuple() -- tm_isdst should be
4395 * 0 in a UTC timetuple regardless of what dst() says.
4397 if (offset) {
4398 /* Subtract offset minutes & normalize. */
4399 int stat;
4401 mm -= offset;
4402 stat = normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us);
4403 if (stat < 0) {
4404 /* At the edges, it's possible we overflowed
4405 * beyond MINYEAR or MAXYEAR.
4407 if (PyErr_ExceptionMatches(PyExc_OverflowError))
4408 PyErr_Clear();
4409 else
4410 return NULL;
4413 return build_struct_time(y, m, d, hh, mm, ss, 0);
4416 /* Pickle support, a simple use of __reduce__. */
4418 /* Let basestate be the non-tzinfo data string.
4419 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4420 * So it's a tuple in any (non-error) case.
4421 * __getstate__ isn't exposed.
4423 static PyObject *
4424 datetime_getstate(PyDateTime_DateTime *self)
4426 PyObject *basestate;
4427 PyObject *result = NULL;
4429 basestate = PyString_FromStringAndSize((char *)self->data,
4430 _PyDateTime_DATETIME_DATASIZE);
4431 if (basestate != NULL) {
4432 if (! HASTZINFO(self) || self->tzinfo == Py_None)
4433 result = PyTuple_Pack(1, basestate);
4434 else
4435 result = PyTuple_Pack(2, basestate, self->tzinfo);
4436 Py_DECREF(basestate);
4438 return result;
4441 static PyObject *
4442 datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
4444 return Py_BuildValue("(ON)", self->ob_type, datetime_getstate(self));
4447 static PyMethodDef datetime_methods[] = {
4449 /* Class methods: */
4451 {"now", (PyCFunction)datetime_now,
4452 METH_KEYWORDS | METH_CLASS,
4453 PyDoc_STR("[tz] -> new datetime with tz's local day and time.")},
4455 {"utcnow", (PyCFunction)datetime_utcnow,
4456 METH_NOARGS | METH_CLASS,
4457 PyDoc_STR("Return a new datetime representing UTC day and time.")},
4459 {"fromtimestamp", (PyCFunction)datetime_fromtimestamp,
4460 METH_KEYWORDS | METH_CLASS,
4461 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
4463 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
4464 METH_VARARGS | METH_CLASS,
4465 PyDoc_STR("timestamp -> UTC datetime from a POSIX timestamp "
4466 "(like time.time()).")},
4468 {"strptime", (PyCFunction)datetime_strptime,
4469 METH_VARARGS | METH_CLASS,
4470 PyDoc_STR("string, format -> new datetime parsed from a string "
4471 "(like time.strptime()).")},
4473 {"combine", (PyCFunction)datetime_combine,
4474 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4475 PyDoc_STR("date, time -> datetime with same date and time fields")},
4477 /* Instance methods: */
4479 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
4480 PyDoc_STR("Return date object with same year, month and day.")},
4482 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
4483 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
4485 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
4486 PyDoc_STR("Return time object with same time and tzinfo.")},
4488 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
4489 PyDoc_STR("Return ctime() style string.")},
4491 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
4492 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
4494 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
4495 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
4497 {"isoformat", (PyCFunction)datetime_isoformat, METH_KEYWORDS,
4498 PyDoc_STR("[sep] -> string in ISO 8601 format, "
4499 "YYYY-MM-DDTHH:MM:SS[.mmmmmm][+HH:MM].\n\n"
4500 "sep is used to separate the year from the time, and "
4501 "defaults to 'T'.")},
4503 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
4504 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
4506 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
4507 PyDoc_STR("Return self.tzinfo.tzname(self).")},
4509 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
4510 PyDoc_STR("Return self.tzinfo.dst(self).")},
4512 {"replace", (PyCFunction)datetime_replace, METH_KEYWORDS,
4513 PyDoc_STR("Return datetime with new specified fields.")},
4515 {"astimezone", (PyCFunction)datetime_astimezone, METH_KEYWORDS,
4516 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
4518 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
4519 PyDoc_STR("__reduce__() -> (cls, state)")},
4521 {NULL, NULL}
4524 static char datetime_doc[] =
4525 PyDoc_STR("datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])\n\
4527 The year, month and day arguments are required. tzinfo may be None, or an\n\
4528 instance of a tzinfo subclass. The remaining arguments may be ints or longs.\n");
4530 static PyNumberMethods datetime_as_number = {
4531 datetime_add, /* nb_add */
4532 datetime_subtract, /* nb_subtract */
4533 0, /* nb_multiply */
4534 0, /* nb_divide */
4535 0, /* nb_remainder */
4536 0, /* nb_divmod */
4537 0, /* nb_power */
4538 0, /* nb_negative */
4539 0, /* nb_positive */
4540 0, /* nb_absolute */
4541 0, /* nb_nonzero */
4544 statichere PyTypeObject PyDateTime_DateTimeType = {
4545 PyObject_HEAD_INIT(NULL)
4546 0, /* ob_size */
4547 "datetime.datetime", /* tp_name */
4548 sizeof(PyDateTime_DateTime), /* tp_basicsize */
4549 0, /* tp_itemsize */
4550 (destructor)datetime_dealloc, /* tp_dealloc */
4551 0, /* tp_print */
4552 0, /* tp_getattr */
4553 0, /* tp_setattr */
4554 0, /* tp_compare */
4555 (reprfunc)datetime_repr, /* tp_repr */
4556 &datetime_as_number, /* tp_as_number */
4557 0, /* tp_as_sequence */
4558 0, /* tp_as_mapping */
4559 (hashfunc)datetime_hash, /* tp_hash */
4560 0, /* tp_call */
4561 (reprfunc)datetime_str, /* tp_str */
4562 PyObject_GenericGetAttr, /* tp_getattro */
4563 0, /* tp_setattro */
4564 0, /* tp_as_buffer */
4565 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
4566 Py_TPFLAGS_BASETYPE, /* tp_flags */
4567 datetime_doc, /* tp_doc */
4568 0, /* tp_traverse */
4569 0, /* tp_clear */
4570 (richcmpfunc)datetime_richcompare, /* tp_richcompare */
4571 0, /* tp_weaklistoffset */
4572 0, /* tp_iter */
4573 0, /* tp_iternext */
4574 datetime_methods, /* tp_methods */
4575 0, /* tp_members */
4576 datetime_getset, /* tp_getset */
4577 &PyDateTime_DateType, /* tp_base */
4578 0, /* tp_dict */
4579 0, /* tp_descr_get */
4580 0, /* tp_descr_set */
4581 0, /* tp_dictoffset */
4582 0, /* tp_init */
4583 datetime_alloc, /* tp_alloc */
4584 datetime_new, /* tp_new */
4585 0, /* tp_free */
4588 /* ---------------------------------------------------------------------------
4589 * Module methods and initialization.
4592 static PyMethodDef module_methods[] = {
4593 {NULL, NULL}
4596 /* C API. Clients get at this via PyDateTime_IMPORT, defined in
4597 * datetime.h.
4599 static PyDateTime_CAPI CAPI = {
4600 &PyDateTime_DateType,
4601 &PyDateTime_DateTimeType,
4602 &PyDateTime_TimeType,
4603 &PyDateTime_DeltaType,
4604 &PyDateTime_TZInfoType,
4605 new_date_ex,
4606 new_datetime_ex,
4607 new_time_ex,
4608 new_delta_ex,
4609 datetime_fromtimestamp,
4610 date_fromtimestamp
4614 PyMODINIT_FUNC
4615 initdatetime(void)
4617 PyObject *m; /* a module object */
4618 PyObject *d; /* its dict */
4619 PyObject *x;
4621 m = Py_InitModule3("datetime", module_methods,
4622 "Fast implementation of the datetime type.");
4623 if (m == NULL)
4624 return;
4626 if (PyType_Ready(&PyDateTime_DateType) < 0)
4627 return;
4628 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
4629 return;
4630 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
4631 return;
4632 if (PyType_Ready(&PyDateTime_TimeType) < 0)
4633 return;
4634 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
4635 return;
4637 /* timedelta values */
4638 d = PyDateTime_DeltaType.tp_dict;
4640 x = new_delta(0, 0, 1, 0);
4641 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4642 return;
4643 Py_DECREF(x);
4645 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
4646 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4647 return;
4648 Py_DECREF(x);
4650 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
4651 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4652 return;
4653 Py_DECREF(x);
4655 /* date values */
4656 d = PyDateTime_DateType.tp_dict;
4658 x = new_date(1, 1, 1);
4659 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4660 return;
4661 Py_DECREF(x);
4663 x = new_date(MAXYEAR, 12, 31);
4664 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4665 return;
4666 Py_DECREF(x);
4668 x = new_delta(1, 0, 0, 0);
4669 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4670 return;
4671 Py_DECREF(x);
4673 /* time values */
4674 d = PyDateTime_TimeType.tp_dict;
4676 x = new_time(0, 0, 0, 0, Py_None);
4677 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4678 return;
4679 Py_DECREF(x);
4681 x = new_time(23, 59, 59, 999999, Py_None);
4682 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4683 return;
4684 Py_DECREF(x);
4686 x = new_delta(0, 0, 1, 0);
4687 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4688 return;
4689 Py_DECREF(x);
4691 /* datetime values */
4692 d = PyDateTime_DateTimeType.tp_dict;
4694 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None);
4695 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4696 return;
4697 Py_DECREF(x);
4699 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None);
4700 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4701 return;
4702 Py_DECREF(x);
4704 x = new_delta(0, 0, 1, 0);
4705 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4706 return;
4707 Py_DECREF(x);
4709 /* module initialization */
4710 PyModule_AddIntConstant(m, "MINYEAR", MINYEAR);
4711 PyModule_AddIntConstant(m, "MAXYEAR", MAXYEAR);
4713 Py_INCREF(&PyDateTime_DateType);
4714 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
4716 Py_INCREF(&PyDateTime_DateTimeType);
4717 PyModule_AddObject(m, "datetime",
4718 (PyObject *)&PyDateTime_DateTimeType);
4720 Py_INCREF(&PyDateTime_TimeType);
4721 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
4723 Py_INCREF(&PyDateTime_DeltaType);
4724 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
4726 Py_INCREF(&PyDateTime_TZInfoType);
4727 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
4729 x = PyCObject_FromVoidPtrAndDesc(&CAPI, (void*) DATETIME_API_MAGIC,
4730 NULL);
4731 if (x == NULL)
4732 return;
4733 PyModule_AddObject(m, "datetime_CAPI", x);
4735 /* A 4-year cycle has an extra leap day over what we'd get from
4736 * pasting together 4 single years.
4738 assert(DI4Y == 4 * 365 + 1);
4739 assert(DI4Y == days_before_year(4+1));
4741 /* Similarly, a 400-year cycle has an extra leap day over what we'd
4742 * get from pasting together 4 100-year cycles.
4744 assert(DI400Y == 4 * DI100Y + 1);
4745 assert(DI400Y == days_before_year(400+1));
4747 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
4748 * pasting together 25 4-year cycles.
4750 assert(DI100Y == 25 * DI4Y - 1);
4751 assert(DI100Y == days_before_year(100+1));
4753 us_per_us = PyInt_FromLong(1);
4754 us_per_ms = PyInt_FromLong(1000);
4755 us_per_second = PyInt_FromLong(1000000);
4756 us_per_minute = PyInt_FromLong(60000000);
4757 seconds_per_day = PyInt_FromLong(24 * 3600);
4758 if (us_per_us == NULL || us_per_ms == NULL || us_per_second == NULL ||
4759 us_per_minute == NULL || seconds_per_day == NULL)
4760 return;
4762 /* The rest are too big for 32-bit ints, but even
4763 * us_per_week fits in 40 bits, so doubles should be exact.
4765 us_per_hour = PyLong_FromDouble(3600000000.0);
4766 us_per_day = PyLong_FromDouble(86400000000.0);
4767 us_per_week = PyLong_FromDouble(604800000000.0);
4768 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
4769 return;
4772 /* ---------------------------------------------------------------------------
4773 Some time zone algebra. For a datetime x, let
4774 x.n = x stripped of its timezone -- its naive time.
4775 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
4776 return None
4777 x.d = x.dst(), and assuming that doesn't raise an exception or
4778 return None
4779 x.s = x's standard offset, x.o - x.d
4781 Now some derived rules, where k is a duration (timedelta).
4783 1. x.o = x.s + x.d
4784 This follows from the definition of x.s.
4786 2. If x and y have the same tzinfo member, x.s = y.s.
4787 This is actually a requirement, an assumption we need to make about
4788 sane tzinfo classes.
4790 3. The naive UTC time corresponding to x is x.n - x.o.
4791 This is again a requirement for a sane tzinfo class.
4793 4. (x+k).s = x.s
4794 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
4796 5. (x+k).n = x.n + k
4797 Again follows from how arithmetic is defined.
4799 Now we can explain tz.fromutc(x). Let's assume it's an interesting case
4800 (meaning that the various tzinfo methods exist, and don't blow up or return
4801 None when called).
4803 The function wants to return a datetime y with timezone tz, equivalent to x.
4804 x is already in UTC.
4806 By #3, we want
4808 y.n - y.o = x.n [1]
4810 The algorithm starts by attaching tz to x.n, and calling that y. So
4811 x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
4812 becomes true; in effect, we want to solve [2] for k:
4814 (y+k).n - (y+k).o = x.n [2]
4816 By #1, this is the same as
4818 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
4820 By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
4821 Substituting that into [3],
4823 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
4824 k - (y+k).s - (y+k).d = 0; rearranging,
4825 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
4826 k = y.s - (y+k).d
4828 On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
4829 approximate k by ignoring the (y+k).d term at first. Note that k can't be
4830 very large, since all offset-returning methods return a duration of magnitude
4831 less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
4832 be 0, so ignoring it has no consequence then.
4834 In any case, the new value is
4836 z = y + y.s [4]
4838 It's helpful to step back at look at [4] from a higher level: it's simply
4839 mapping from UTC to tz's standard time.
4841 At this point, if
4843 z.n - z.o = x.n [5]
4845 we have an equivalent time, and are almost done. The insecurity here is
4846 at the start of daylight time. Picture US Eastern for concreteness. The wall
4847 time jumps from 1:59 to 3:00, and wall hours of the form 2:MM don't make good
4848 sense then. The docs ask that an Eastern tzinfo class consider such a time to
4849 be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
4850 on the day DST starts. We want to return the 1:MM EST spelling because that's
4851 the only spelling that makes sense on the local wall clock.
4853 In fact, if [5] holds at this point, we do have the standard-time spelling,
4854 but that takes a bit of proof. We first prove a stronger result. What's the
4855 difference between the LHS and RHS of [5]? Let
4857 diff = x.n - (z.n - z.o) [6]
4860 z.n = by [4]
4861 (y + y.s).n = by #5
4862 y.n + y.s = since y.n = x.n
4863 x.n + y.s = since z and y are have the same tzinfo member,
4864 y.s = z.s by #2
4865 x.n + z.s
4867 Plugging that back into [6] gives
4869 diff =
4870 x.n - ((x.n + z.s) - z.o) = expanding
4871 x.n - x.n - z.s + z.o = cancelling
4872 - z.s + z.o = by #2
4875 So diff = z.d.
4877 If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
4878 spelling we wanted in the endcase described above. We're done. Contrarily,
4879 if z.d = 0, then we have a UTC equivalent, and are also done.
4881 If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
4882 add to z (in effect, z is in tz's standard time, and we need to shift the
4883 local clock into tz's daylight time).
4887 z' = z + z.d = z + diff [7]
4889 and we can again ask whether
4891 z'.n - z'.o = x.n [8]
4893 If so, we're done. If not, the tzinfo class is insane, according to the
4894 assumptions we've made. This also requires a bit of proof. As before, let's
4895 compute the difference between the LHS and RHS of [8] (and skipping some of
4896 the justifications for the kinds of substitutions we've done several times
4897 already):
4899 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
4900 x.n - (z.n + diff - z'.o) = replacing diff via [6]
4901 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
4902 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
4903 - z.n + z.n - z.o + z'.o = cancel z.n
4904 - z.o + z'.o = #1 twice
4905 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
4906 z'.d - z.d
4908 So z' is UTC-equivalent to x iff z'.d = z.d at this point. If they are equal,
4909 we've found the UTC-equivalent so are done. In fact, we stop with [7] and
4910 return z', not bothering to compute z'.d.
4912 How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
4913 a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
4914 would have to change the result dst() returns: we start in DST, and moving
4915 a little further into it takes us out of DST.
4917 There isn't a sane case where this can happen. The closest it gets is at
4918 the end of DST, where there's an hour in UTC with no spelling in a hybrid
4919 tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
4920 that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
4921 UTC) because the docs insist on that, but 0:MM is taken as being in daylight
4922 time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
4923 clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
4924 standard time. Since that's what the local clock *does*, we want to map both
4925 UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
4926 in local time, but so it goes -- it's the way the local clock works.
4928 When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
4929 so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
4930 z' = z + z.d = 1:MM then, and z'.d=0, and z'.d - z.d = -60 != 0 so [8]
4931 (correctly) concludes that z' is not UTC-equivalent to x.
4933 Because we know z.d said z was in daylight time (else [5] would have held and
4934 we would have stopped then), and we know z.d != z'.d (else [8] would have held
4935 and we would have stopped then), and there are only 2 possible values dst() can
4936 return in Eastern, it follows that z'.d must be 0 (which it is in the example,
4937 but the reasoning doesn't depend on the example -- it depends on there being
4938 two possible dst() outcomes, one zero and the other non-zero). Therefore
4939 z' must be in standard time, and is the spelling we want in this case.
4941 Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
4942 concerned (because it takes z' as being in standard time rather than the
4943 daylight time we intend here), but returning it gives the real-life "local
4944 clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
4947 When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
4948 the 1:MM standard time spelling we want.
4950 So how can this break? One of the assumptions must be violated. Two
4951 possibilities:
4953 1) [2] effectively says that y.s is invariant across all y belong to a given
4954 time zone. This isn't true if, for political reasons or continental drift,
4955 a region decides to change its base offset from UTC.
4957 2) There may be versions of "double daylight" time where the tail end of
4958 the analysis gives up a step too early. I haven't thought about that
4959 enough to say.
4961 In any case, it's clear that the default fromutc() is strong enough to handle
4962 "almost all" time zones: so long as the standard offset is invariant, it
4963 doesn't matter if daylight time transition points change from year to year, or
4964 if daylight time is skipped in some years; it doesn't matter how large or
4965 small dst() may get within its bounds; and it doesn't even matter if some
4966 perverse time zone returns a negative dst()). So a breaking case must be
4967 pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
4968 --------------------------------------------------------------------------- */