blob: d39791a8e848579c738a643733af7e8e599c831b [file] [log] [blame]
Tim Peters2a799bf2002-12-16 20:18:38 +00001/* C implementation for the date/time type documented at
2 * http://www.zope.org/Members/fdrake/DateTimeWiki/FrontPage
3 */
4
5#include "Python.h"
6#include "modsupport.h"
7#include "structmember.h"
8
9#include <time.h>
10
Tim Peters1b6f7a92004-06-20 02:50:16 +000011#include "timefuncs.h"
Tim Peters9ddf40b2004-06-20 22:41:32 +000012
13/* Differentiate between building the core module and building extension
14 * modules.
15 */
Guido van Rossum360e4b82007-05-14 22:51:27 +000016#ifndef Py_BUILD_CORE
Tim Peters9ddf40b2004-06-20 22:41:32 +000017#define Py_BUILD_CORE
Guido van Rossum360e4b82007-05-14 22:51:27 +000018#endif
Tim Peters2a799bf2002-12-16 20:18:38 +000019#include "datetime.h"
Tim Peters9ddf40b2004-06-20 22:41:32 +000020#undef Py_BUILD_CORE
Tim Peters2a799bf2002-12-16 20:18:38 +000021
22/* We require that C int be at least 32 bits, and use int virtually
23 * everywhere. In just a few cases we use a temp long, where a Python
24 * API returns a C long. In such cases, we have to ensure that the
25 * final result fits in a C int (this can be an issue on 64-bit boxes).
26 */
27#if SIZEOF_INT < 4
28# error "datetime.c requires that C int have at least 32 bits"
29#endif
30
31#define MINYEAR 1
32#define MAXYEAR 9999
33
34/* Nine decimal digits is easy to communicate, and leaves enough room
35 * so that two delta days can be added w/o fear of overflowing a signed
36 * 32-bit int, and with plenty of room left over to absorb any possible
37 * carries from adding seconds.
38 */
39#define MAX_DELTA_DAYS 999999999
40
41/* Rename the long macros in datetime.h to more reasonable short names. */
42#define GET_YEAR PyDateTime_GET_YEAR
43#define GET_MONTH PyDateTime_GET_MONTH
44#define GET_DAY PyDateTime_GET_DAY
45#define DATE_GET_HOUR PyDateTime_DATE_GET_HOUR
46#define DATE_GET_MINUTE PyDateTime_DATE_GET_MINUTE
47#define DATE_GET_SECOND PyDateTime_DATE_GET_SECOND
48#define DATE_GET_MICROSECOND PyDateTime_DATE_GET_MICROSECOND
49
50/* Date accessors for date and datetime. */
51#define SET_YEAR(o, v) (((o)->data[0] = ((v) & 0xff00) >> 8), \
52 ((o)->data[1] = ((v) & 0x00ff)))
53#define SET_MONTH(o, v) (PyDateTime_GET_MONTH(o) = (v))
54#define SET_DAY(o, v) (PyDateTime_GET_DAY(o) = (v))
55
56/* Date/Time accessors for datetime. */
57#define DATE_SET_HOUR(o, v) (PyDateTime_DATE_GET_HOUR(o) = (v))
58#define DATE_SET_MINUTE(o, v) (PyDateTime_DATE_GET_MINUTE(o) = (v))
59#define DATE_SET_SECOND(o, v) (PyDateTime_DATE_GET_SECOND(o) = (v))
60#define DATE_SET_MICROSECOND(o, v) \
61 (((o)->data[7] = ((v) & 0xff0000) >> 16), \
62 ((o)->data[8] = ((v) & 0x00ff00) >> 8), \
63 ((o)->data[9] = ((v) & 0x0000ff)))
64
65/* Time accessors for time. */
66#define TIME_GET_HOUR PyDateTime_TIME_GET_HOUR
67#define TIME_GET_MINUTE PyDateTime_TIME_GET_MINUTE
68#define TIME_GET_SECOND PyDateTime_TIME_GET_SECOND
69#define TIME_GET_MICROSECOND PyDateTime_TIME_GET_MICROSECOND
70#define TIME_SET_HOUR(o, v) (PyDateTime_TIME_GET_HOUR(o) = (v))
71#define TIME_SET_MINUTE(o, v) (PyDateTime_TIME_GET_MINUTE(o) = (v))
72#define TIME_SET_SECOND(o, v) (PyDateTime_TIME_GET_SECOND(o) = (v))
73#define TIME_SET_MICROSECOND(o, v) \
74 (((o)->data[3] = ((v) & 0xff0000) >> 16), \
75 ((o)->data[4] = ((v) & 0x00ff00) >> 8), \
76 ((o)->data[5] = ((v) & 0x0000ff)))
77
78/* Delta accessors for timedelta. */
79#define GET_TD_DAYS(o) (((PyDateTime_Delta *)(o))->days)
80#define GET_TD_SECONDS(o) (((PyDateTime_Delta *)(o))->seconds)
81#define GET_TD_MICROSECONDS(o) (((PyDateTime_Delta *)(o))->microseconds)
82
83#define SET_TD_DAYS(o, v) ((o)->days = (v))
84#define SET_TD_SECONDS(o, v) ((o)->seconds = (v))
85#define SET_TD_MICROSECONDS(o, v) ((o)->microseconds = (v))
86
Tim Petersa032d2e2003-01-11 00:15:54 +000087/* p is a pointer to a time or a datetime object; HASTZINFO(p) returns
88 * p->hastzinfo.
89 */
90#define HASTZINFO(p) (((_PyDateTime_BaseTZInfo *)(p))->hastzinfo)
91
Tim Peters3f606292004-03-21 23:38:41 +000092/* M is a char or int claiming to be a valid month. The macro is equivalent
93 * to the two-sided Python test
94 * 1 <= M <= 12
95 */
96#define MONTH_IS_SANE(M) ((unsigned int)(M) - 1 < 12)
97
Tim Peters2a799bf2002-12-16 20:18:38 +000098/* Forward declarations. */
99static PyTypeObject PyDateTime_DateType;
100static PyTypeObject PyDateTime_DateTimeType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000101static PyTypeObject PyDateTime_DeltaType;
102static PyTypeObject PyDateTime_TimeType;
103static PyTypeObject PyDateTime_TZInfoType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000104
105/* ---------------------------------------------------------------------------
106 * Math utilities.
107 */
108
109/* k = i+j overflows iff k differs in sign from both inputs,
110 * iff k^i has sign bit set and k^j has sign bit set,
111 * iff (k^i)&(k^j) has sign bit set.
112 */
113#define SIGNED_ADD_OVERFLOWED(RESULT, I, J) \
114 ((((RESULT) ^ (I)) & ((RESULT) ^ (J))) < 0)
115
116/* Compute Python divmod(x, y), returning the quotient and storing the
117 * remainder into *r. The quotient is the floor of x/y, and that's
118 * the real point of this. C will probably truncate instead (C99
119 * requires truncation; C89 left it implementation-defined).
120 * Simplification: we *require* that y > 0 here. That's appropriate
121 * for all the uses made of it. This simplifies the code and makes
122 * the overflow case impossible (divmod(LONG_MIN, -1) is the only
123 * overflow case).
124 */
125static int
126divmod(int x, int y, int *r)
127{
128 int quo;
129
130 assert(y > 0);
131 quo = x / y;
132 *r = x - quo * y;
133 if (*r < 0) {
134 --quo;
135 *r += y;
136 }
137 assert(0 <= *r && *r < y);
138 return quo;
139}
140
Tim Peters5d644dd2003-01-02 16:32:54 +0000141/* Round a double to the nearest long. |x| must be small enough to fit
142 * in a C long; this is not checked.
143 */
144static long
145round_to_long(double x)
146{
147 if (x >= 0.0)
148 x = floor(x + 0.5);
149 else
150 x = ceil(x - 0.5);
151 return (long)x;
152}
153
Tim Peters2a799bf2002-12-16 20:18:38 +0000154/* ---------------------------------------------------------------------------
155 * General calendrical helper functions
156 */
157
158/* For each month ordinal in 1..12, the number of days in that month,
159 * and the number of days before that month in the same year. These
160 * are correct for non-leap years only.
161 */
162static int _days_in_month[] = {
163 0, /* unused; this vector uses 1-based indexing */
164 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
165};
166
167static int _days_before_month[] = {
168 0, /* unused; this vector uses 1-based indexing */
169 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
170};
171
172/* year -> 1 if leap year, else 0. */
173static int
174is_leap(int year)
175{
176 /* Cast year to unsigned. The result is the same either way, but
177 * C can generate faster code for unsigned mod than for signed
178 * mod (especially for % 4 -- a good compiler should just grab
179 * the last 2 bits when the LHS is unsigned).
180 */
181 const unsigned int ayear = (unsigned int)year;
182 return ayear % 4 == 0 && (ayear % 100 != 0 || ayear % 400 == 0);
183}
184
185/* year, month -> number of days in that month in that year */
186static int
187days_in_month(int year, int month)
188{
189 assert(month >= 1);
190 assert(month <= 12);
191 if (month == 2 && is_leap(year))
192 return 29;
193 else
194 return _days_in_month[month];
195}
196
197/* year, month -> number of days in year preceeding first day of month */
198static int
199days_before_month(int year, int month)
200{
201 int days;
202
203 assert(month >= 1);
204 assert(month <= 12);
205 days = _days_before_month[month];
206 if (month > 2 && is_leap(year))
207 ++days;
208 return days;
209}
210
211/* year -> number of days before January 1st of year. Remember that we
212 * start with year 1, so days_before_year(1) == 0.
213 */
214static int
215days_before_year(int year)
216{
217 int y = year - 1;
218 /* This is incorrect if year <= 0; we really want the floor
219 * here. But so long as MINYEAR is 1, the smallest year this
220 * can see is 0 (this can happen in some normalization endcases),
221 * so we'll just special-case that.
222 */
223 assert (year >= 0);
224 if (y >= 0)
225 return y*365 + y/4 - y/100 + y/400;
226 else {
227 assert(y == -1);
228 return -366;
229 }
230}
231
232/* Number of days in 4, 100, and 400 year cycles. That these have
233 * the correct values is asserted in the module init function.
234 */
235#define DI4Y 1461 /* days_before_year(5); days in 4 years */
236#define DI100Y 36524 /* days_before_year(101); days in 100 years */
237#define DI400Y 146097 /* days_before_year(401); days in 400 years */
238
239/* ordinal -> year, month, day, considering 01-Jan-0001 as day 1. */
240static void
241ord_to_ymd(int ordinal, int *year, int *month, int *day)
242{
243 int n, n1, n4, n100, n400, leapyear, preceding;
244
245 /* ordinal is a 1-based index, starting at 1-Jan-1. The pattern of
246 * leap years repeats exactly every 400 years. The basic strategy is
247 * to find the closest 400-year boundary at or before ordinal, then
248 * work with the offset from that boundary to ordinal. Life is much
249 * clearer if we subtract 1 from ordinal first -- then the values
250 * of ordinal at 400-year boundaries are exactly those divisible
251 * by DI400Y:
252 *
253 * D M Y n n-1
254 * -- --- ---- ---------- ----------------
255 * 31 Dec -400 -DI400Y -DI400Y -1
256 * 1 Jan -399 -DI400Y +1 -DI400Y 400-year boundary
257 * ...
258 * 30 Dec 000 -1 -2
259 * 31 Dec 000 0 -1
260 * 1 Jan 001 1 0 400-year boundary
261 * 2 Jan 001 2 1
262 * 3 Jan 001 3 2
263 * ...
264 * 31 Dec 400 DI400Y DI400Y -1
265 * 1 Jan 401 DI400Y +1 DI400Y 400-year boundary
266 */
267 assert(ordinal >= 1);
268 --ordinal;
269 n400 = ordinal / DI400Y;
270 n = ordinal % DI400Y;
271 *year = n400 * 400 + 1;
272
273 /* Now n is the (non-negative) offset, in days, from January 1 of
274 * year, to the desired date. Now compute how many 100-year cycles
275 * precede n.
276 * Note that it's possible for n100 to equal 4! In that case 4 full
277 * 100-year cycles precede the desired day, which implies the
278 * desired day is December 31 at the end of a 400-year cycle.
279 */
280 n100 = n / DI100Y;
281 n = n % DI100Y;
282
283 /* Now compute how many 4-year cycles precede it. */
284 n4 = n / DI4Y;
285 n = n % DI4Y;
286
287 /* And now how many single years. Again n1 can be 4, and again
288 * meaning that the desired day is December 31 at the end of the
289 * 4-year cycle.
290 */
291 n1 = n / 365;
292 n = n % 365;
293
294 *year += n100 * 100 + n4 * 4 + n1;
295 if (n1 == 4 || n100 == 4) {
296 assert(n == 0);
297 *year -= 1;
298 *month = 12;
299 *day = 31;
300 return;
301 }
302
303 /* Now the year is correct, and n is the offset from January 1. We
304 * find the month via an estimate that's either exact or one too
305 * large.
306 */
307 leapyear = n1 == 3 && (n4 != 24 || n100 == 3);
308 assert(leapyear == is_leap(*year));
309 *month = (n + 50) >> 5;
310 preceding = (_days_before_month[*month] + (*month > 2 && leapyear));
311 if (preceding > n) {
312 /* estimate is too large */
313 *month -= 1;
314 preceding -= days_in_month(*year, *month);
315 }
316 n -= preceding;
317 assert(0 <= n);
318 assert(n < days_in_month(*year, *month));
319
320 *day = n + 1;
321}
322
323/* year, month, day -> ordinal, considering 01-Jan-0001 as day 1. */
324static int
325ymd_to_ord(int year, int month, int day)
326{
327 return days_before_year(year) + days_before_month(year, month) + day;
328}
329
330/* Day of week, where Monday==0, ..., Sunday==6. 1/1/1 was a Monday. */
331static int
332weekday(int year, int month, int day)
333{
334 return (ymd_to_ord(year, month, day) + 6) % 7;
335}
336
337/* Ordinal of the Monday starting week 1 of the ISO year. Week 1 is the
338 * first calendar week containing a Thursday.
339 */
340static int
341iso_week1_monday(int year)
342{
343 int first_day = ymd_to_ord(year, 1, 1); /* ord of 1/1 */
344 /* 0 if 1/1 is a Monday, 1 if a Tue, etc. */
345 int first_weekday = (first_day + 6) % 7;
346 /* ordinal of closest Monday at or before 1/1 */
347 int week1_monday = first_day - first_weekday;
348
349 if (first_weekday > 3) /* if 1/1 was Fri, Sat, Sun */
350 week1_monday += 7;
351 return week1_monday;
352}
353
354/* ---------------------------------------------------------------------------
355 * Range checkers.
356 */
357
358/* Check that -MAX_DELTA_DAYS <= days <= MAX_DELTA_DAYS. If so, return 0.
359 * If not, raise OverflowError and return -1.
360 */
361static int
362check_delta_day_range(int days)
363{
364 if (-MAX_DELTA_DAYS <= days && days <= MAX_DELTA_DAYS)
365 return 0;
366 PyErr_Format(PyExc_OverflowError,
367 "days=%d; must have magnitude <= %d",
Guido van Rossumbd43e912002-12-16 20:34:55 +0000368 days, MAX_DELTA_DAYS);
Tim Peters2a799bf2002-12-16 20:18:38 +0000369 return -1;
370}
371
372/* Check that date arguments are in range. Return 0 if they are. If they
373 * aren't, raise ValueError and return -1.
374 */
375static int
376check_date_args(int year, int month, int day)
377{
378
379 if (year < MINYEAR || year > MAXYEAR) {
380 PyErr_SetString(PyExc_ValueError,
381 "year is out of range");
382 return -1;
383 }
384 if (month < 1 || month > 12) {
385 PyErr_SetString(PyExc_ValueError,
386 "month must be in 1..12");
387 return -1;
388 }
389 if (day < 1 || day > days_in_month(year, month)) {
390 PyErr_SetString(PyExc_ValueError,
391 "day is out of range for month");
392 return -1;
393 }
394 return 0;
395}
396
397/* Check that time arguments are in range. Return 0 if they are. If they
398 * aren't, raise ValueError and return -1.
399 */
400static int
401check_time_args(int h, int m, int s, int us)
402{
403 if (h < 0 || h > 23) {
404 PyErr_SetString(PyExc_ValueError,
405 "hour must be in 0..23");
406 return -1;
407 }
408 if (m < 0 || m > 59) {
409 PyErr_SetString(PyExc_ValueError,
410 "minute must be in 0..59");
411 return -1;
412 }
413 if (s < 0 || s > 59) {
414 PyErr_SetString(PyExc_ValueError,
415 "second must be in 0..59");
416 return -1;
417 }
418 if (us < 0 || us > 999999) {
419 PyErr_SetString(PyExc_ValueError,
420 "microsecond must be in 0..999999");
421 return -1;
422 }
423 return 0;
424}
425
426/* ---------------------------------------------------------------------------
427 * Normalization utilities.
428 */
429
430/* One step of a mixed-radix conversion. A "hi" unit is equivalent to
431 * factor "lo" units. factor must be > 0. If *lo is less than 0, or
432 * at least factor, enough of *lo is converted into "hi" units so that
433 * 0 <= *lo < factor. The input values must be such that int overflow
434 * is impossible.
435 */
436static void
437normalize_pair(int *hi, int *lo, int factor)
438{
439 assert(factor > 0);
440 assert(lo != hi);
441 if (*lo < 0 || *lo >= factor) {
442 const int num_hi = divmod(*lo, factor, lo);
443 const int new_hi = *hi + num_hi;
444 assert(! SIGNED_ADD_OVERFLOWED(new_hi, *hi, num_hi));
445 *hi = new_hi;
446 }
447 assert(0 <= *lo && *lo < factor);
448}
449
450/* Fiddle days (d), seconds (s), and microseconds (us) so that
451 * 0 <= *s < 24*3600
452 * 0 <= *us < 1000000
453 * The input values must be such that the internals don't overflow.
454 * The way this routine is used, we don't get close.
455 */
456static void
457normalize_d_s_us(int *d, int *s, int *us)
458{
459 if (*us < 0 || *us >= 1000000) {
460 normalize_pair(s, us, 1000000);
461 /* |s| can't be bigger than about
462 * |original s| + |original us|/1000000 now.
463 */
464
465 }
466 if (*s < 0 || *s >= 24*3600) {
467 normalize_pair(d, s, 24*3600);
468 /* |d| can't be bigger than about
469 * |original d| +
470 * (|original s| + |original us|/1000000) / (24*3600) now.
471 */
472 }
473 assert(0 <= *s && *s < 24*3600);
474 assert(0 <= *us && *us < 1000000);
475}
476
477/* Fiddle years (y), months (m), and days (d) so that
478 * 1 <= *m <= 12
479 * 1 <= *d <= days_in_month(*y, *m)
480 * The input values must be such that the internals don't overflow.
481 * The way this routine is used, we don't get close.
482 */
483static void
484normalize_y_m_d(int *y, int *m, int *d)
485{
486 int dim; /* # of days in month */
487
488 /* This gets muddy: the proper range for day can't be determined
489 * without knowing the correct month and year, but if day is, e.g.,
490 * plus or minus a million, the current month and year values make
491 * no sense (and may also be out of bounds themselves).
492 * Saying 12 months == 1 year should be non-controversial.
493 */
494 if (*m < 1 || *m > 12) {
495 --*m;
496 normalize_pair(y, m, 12);
497 ++*m;
498 /* |y| can't be bigger than about
499 * |original y| + |original m|/12 now.
500 */
501 }
502 assert(1 <= *m && *m <= 12);
503
504 /* Now only day can be out of bounds (year may also be out of bounds
505 * for a datetime object, but we don't care about that here).
506 * If day is out of bounds, what to do is arguable, but at least the
507 * method here is principled and explainable.
508 */
509 dim = days_in_month(*y, *m);
510 if (*d < 1 || *d > dim) {
511 /* Move day-1 days from the first of the month. First try to
512 * get off cheap if we're only one day out of range
513 * (adjustments for timezone alone can't be worse than that).
514 */
515 if (*d == 0) {
516 --*m;
517 if (*m > 0)
518 *d = days_in_month(*y, *m);
519 else {
520 --*y;
521 *m = 12;
522 *d = 31;
523 }
524 }
525 else if (*d == dim + 1) {
526 /* move forward a day */
527 ++*m;
528 *d = 1;
529 if (*m > 12) {
530 *m = 1;
531 ++*y;
532 }
533 }
534 else {
535 int ordinal = ymd_to_ord(*y, *m, 1) +
536 *d - 1;
537 ord_to_ymd(ordinal, y, m, d);
538 }
539 }
540 assert(*m > 0);
541 assert(*d > 0);
542}
543
544/* Fiddle out-of-bounds months and days so that the result makes some kind
545 * of sense. The parameters are both inputs and outputs. Returns < 0 on
546 * failure, where failure means the adjusted year is out of bounds.
547 */
548static int
549normalize_date(int *year, int *month, int *day)
550{
551 int result;
552
553 normalize_y_m_d(year, month, day);
554 if (MINYEAR <= *year && *year <= MAXYEAR)
555 result = 0;
556 else {
557 PyErr_SetString(PyExc_OverflowError,
558 "date value out of range");
559 result = -1;
560 }
561 return result;
562}
563
564/* Force all the datetime fields into range. The parameters are both
565 * inputs and outputs. Returns < 0 on error.
566 */
567static int
568normalize_datetime(int *year, int *month, int *day,
569 int *hour, int *minute, int *second,
570 int *microsecond)
571{
572 normalize_pair(second, microsecond, 1000000);
573 normalize_pair(minute, second, 60);
574 normalize_pair(hour, minute, 60);
575 normalize_pair(day, hour, 24);
576 return normalize_date(year, month, day);
577}
578
579/* ---------------------------------------------------------------------------
Tim Petersb0c854d2003-05-17 15:57:00 +0000580 * Basic object allocation: tp_alloc implementations. These allocate
581 * Python objects of the right size and type, and do the Python object-
582 * initialization bit. If there's not enough memory, they return NULL after
583 * setting MemoryError. All data members remain uninitialized trash.
584 *
585 * We abuse the tp_alloc "nitems" argument to communicate whether a tzinfo
Tim Peters03eaf8b2003-05-18 02:24:46 +0000586 * member is needed. This is ugly, imprecise, and possibly insecure.
587 * tp_basicsize for the time and datetime types is set to the size of the
588 * struct that has room for the tzinfo member, so subclasses in Python will
589 * allocate enough space for a tzinfo member whether or not one is actually
590 * needed. That's the "ugly and imprecise" parts. The "possibly insecure"
591 * part is that PyType_GenericAlloc() (which subclasses in Python end up
592 * using) just happens today to effectively ignore the nitems argument
593 * when tp_itemsize is 0, which it is for these type objects. If that
594 * changes, perhaps the callers of tp_alloc slots in this file should
595 * be changed to force a 0 nitems argument unless the type being allocated
596 * is a base type implemented in this file (so that tp_alloc is time_alloc
597 * or datetime_alloc below, which know about the nitems abuse).
Tim Petersb0c854d2003-05-17 15:57:00 +0000598 */
599
600static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000601time_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000602{
603 PyObject *self;
604
605 self = (PyObject *)
606 PyObject_MALLOC(aware ?
607 sizeof(PyDateTime_Time) :
608 sizeof(_PyDateTime_BaseTime));
609 if (self == NULL)
610 return (PyObject *)PyErr_NoMemory();
611 PyObject_INIT(self, type);
612 return self;
613}
614
615static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000616datetime_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000617{
618 PyObject *self;
619
620 self = (PyObject *)
621 PyObject_MALLOC(aware ?
622 sizeof(PyDateTime_DateTime) :
623 sizeof(_PyDateTime_BaseDateTime));
624 if (self == NULL)
625 return (PyObject *)PyErr_NoMemory();
626 PyObject_INIT(self, type);
627 return self;
628}
629
630/* ---------------------------------------------------------------------------
631 * Helpers for setting object fields. These work on pointers to the
632 * appropriate base class.
633 */
634
635/* For date and datetime. */
636static void
637set_date_fields(PyDateTime_Date *self, int y, int m, int d)
638{
639 self->hashcode = -1;
640 SET_YEAR(self, y);
641 SET_MONTH(self, m);
642 SET_DAY(self, d);
643}
644
645/* ---------------------------------------------------------------------------
646 * Create various objects, mostly without range checking.
647 */
648
649/* Create a date instance with no range checking. */
650static PyObject *
651new_date_ex(int year, int month, int day, PyTypeObject *type)
652{
653 PyDateTime_Date *self;
654
655 self = (PyDateTime_Date *) (type->tp_alloc(type, 0));
656 if (self != NULL)
657 set_date_fields(self, year, month, day);
658 return (PyObject *) self;
659}
660
661#define new_date(year, month, day) \
662 new_date_ex(year, month, day, &PyDateTime_DateType)
663
664/* Create a datetime instance with no range checking. */
665static PyObject *
666new_datetime_ex(int year, int month, int day, int hour, int minute,
667 int second, int usecond, PyObject *tzinfo, PyTypeObject *type)
668{
669 PyDateTime_DateTime *self;
670 char aware = tzinfo != Py_None;
671
672 self = (PyDateTime_DateTime *) (type->tp_alloc(type, aware));
673 if (self != NULL) {
674 self->hastzinfo = aware;
675 set_date_fields((PyDateTime_Date *)self, year, month, day);
676 DATE_SET_HOUR(self, hour);
677 DATE_SET_MINUTE(self, minute);
678 DATE_SET_SECOND(self, second);
679 DATE_SET_MICROSECOND(self, usecond);
680 if (aware) {
681 Py_INCREF(tzinfo);
682 self->tzinfo = tzinfo;
683 }
684 }
685 return (PyObject *)self;
686}
687
688#define new_datetime(y, m, d, hh, mm, ss, us, tzinfo) \
689 new_datetime_ex(y, m, d, hh, mm, ss, us, tzinfo, \
690 &PyDateTime_DateTimeType)
691
692/* Create a time instance with no range checking. */
693static PyObject *
694new_time_ex(int hour, int minute, int second, int usecond,
695 PyObject *tzinfo, PyTypeObject *type)
696{
697 PyDateTime_Time *self;
698 char aware = tzinfo != Py_None;
699
700 self = (PyDateTime_Time *) (type->tp_alloc(type, aware));
701 if (self != NULL) {
702 self->hastzinfo = aware;
703 self->hashcode = -1;
704 TIME_SET_HOUR(self, hour);
705 TIME_SET_MINUTE(self, minute);
706 TIME_SET_SECOND(self, second);
707 TIME_SET_MICROSECOND(self, usecond);
708 if (aware) {
709 Py_INCREF(tzinfo);
710 self->tzinfo = tzinfo;
711 }
712 }
713 return (PyObject *)self;
714}
715
716#define new_time(hh, mm, ss, us, tzinfo) \
717 new_time_ex(hh, mm, ss, us, tzinfo, &PyDateTime_TimeType)
718
719/* Create a timedelta instance. Normalize the members iff normalize is
720 * true. Passing false is a speed optimization, if you know for sure
721 * that seconds and microseconds are already in their proper ranges. In any
722 * case, raises OverflowError and returns NULL if the normalized days is out
723 * of range).
724 */
725static PyObject *
726new_delta_ex(int days, int seconds, int microseconds, int normalize,
727 PyTypeObject *type)
728{
729 PyDateTime_Delta *self;
730
731 if (normalize)
732 normalize_d_s_us(&days, &seconds, &microseconds);
733 assert(0 <= seconds && seconds < 24*3600);
734 assert(0 <= microseconds && microseconds < 1000000);
735
736 if (check_delta_day_range(days) < 0)
737 return NULL;
738
739 self = (PyDateTime_Delta *) (type->tp_alloc(type, 0));
740 if (self != NULL) {
741 self->hashcode = -1;
742 SET_TD_DAYS(self, days);
743 SET_TD_SECONDS(self, seconds);
744 SET_TD_MICROSECONDS(self, microseconds);
745 }
746 return (PyObject *) self;
747}
748
749#define new_delta(d, s, us, normalize) \
750 new_delta_ex(d, s, us, normalize, &PyDateTime_DeltaType)
751
752/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +0000753 * tzinfo helpers.
754 */
755
Tim Peters855fe882002-12-22 03:43:39 +0000756/* Ensure that p is None or of a tzinfo subclass. Return 0 if OK; if not
757 * raise TypeError and return -1.
758 */
759static int
760check_tzinfo_subclass(PyObject *p)
761{
762 if (p == Py_None || PyTZInfo_Check(p))
763 return 0;
764 PyErr_Format(PyExc_TypeError,
765 "tzinfo argument must be None or of a tzinfo subclass, "
766 "not type '%s'",
767 p->ob_type->tp_name);
768 return -1;
769}
770
Tim Petersbad8ff02002-12-30 20:52:32 +0000771/* Return tzinfo.methname(tzinfoarg), without any checking of results.
Tim Peters855fe882002-12-22 03:43:39 +0000772 * If tzinfo is None, returns None.
773 */
774static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000775call_tzinfo_method(PyObject *tzinfo, char *methname, PyObject *tzinfoarg)
Tim Peters855fe882002-12-22 03:43:39 +0000776{
777 PyObject *result;
778
Tim Petersbad8ff02002-12-30 20:52:32 +0000779 assert(tzinfo && methname && tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000780 assert(check_tzinfo_subclass(tzinfo) >= 0);
781 if (tzinfo == Py_None) {
782 result = Py_None;
783 Py_INCREF(result);
784 }
785 else
Tim Petersbad8ff02002-12-30 20:52:32 +0000786 result = PyObject_CallMethod(tzinfo, methname, "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000787 return result;
788}
789
Tim Peters2a799bf2002-12-16 20:18:38 +0000790/* If self has a tzinfo member, return a BORROWED reference to it. Else
791 * return NULL, which is NOT AN ERROR. There are no error returns here,
792 * and the caller must not decref the result.
793 */
794static PyObject *
795get_tzinfo_member(PyObject *self)
796{
797 PyObject *tzinfo = NULL;
798
Tim Petersa9bc1682003-01-11 03:39:11 +0000799 if (PyDateTime_Check(self) && HASTZINFO(self))
800 tzinfo = ((PyDateTime_DateTime *)self)->tzinfo;
Tim Petersa032d2e2003-01-11 00:15:54 +0000801 else if (PyTime_Check(self) && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +0000802 tzinfo = ((PyDateTime_Time *)self)->tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000803
804 return tzinfo;
805}
806
Tim Petersbad8ff02002-12-30 20:52:32 +0000807/* Call getattr(tzinfo, name)(tzinfoarg), and extract an int from the
Tim Peters2a799bf2002-12-16 20:18:38 +0000808 * result. tzinfo must be an instance of the tzinfo class. If the method
809 * returns None, this returns 0 and sets *none to 1. If the method doesn't
Tim Peters397301e2003-01-02 21:28:08 +0000810 * return None or timedelta, TypeError is raised and this returns -1. If it
811 * returnsa timedelta and the value is out of range or isn't a whole number
812 * of minutes, ValueError is raised and this returns -1.
Tim Peters2a799bf2002-12-16 20:18:38 +0000813 * Else *none is set to 0 and the integer method result is returned.
814 */
815static int
816call_utc_tzinfo_method(PyObject *tzinfo, char *name, PyObject *tzinfoarg,
817 int *none)
818{
819 PyObject *u;
Tim Peters397301e2003-01-02 21:28:08 +0000820 int result = -1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000821
822 assert(tzinfo != NULL);
823 assert(PyTZInfo_Check(tzinfo));
824 assert(tzinfoarg != NULL);
825
826 *none = 0;
Tim Petersbad8ff02002-12-30 20:52:32 +0000827 u = call_tzinfo_method(tzinfo, name, tzinfoarg);
Tim Peters2a799bf2002-12-16 20:18:38 +0000828 if (u == NULL)
829 return -1;
830
Tim Peters27362852002-12-23 16:17:39 +0000831 else if (u == Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +0000832 result = 0;
833 *none = 1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000834 }
Tim Peters855fe882002-12-22 03:43:39 +0000835 else if (PyDelta_Check(u)) {
836 const int days = GET_TD_DAYS(u);
837 if (days < -1 || days > 0)
838 result = 24*60; /* trigger ValueError below */
839 else {
840 /* next line can't overflow because we know days
841 * is -1 or 0 now
842 */
843 int ss = days * 24 * 3600 + GET_TD_SECONDS(u);
844 result = divmod(ss, 60, &ss);
845 if (ss || GET_TD_MICROSECONDS(u)) {
846 PyErr_Format(PyExc_ValueError,
847 "tzinfo.%s() must return a "
848 "whole number of minutes",
849 name);
850 result = -1;
Tim Peters855fe882002-12-22 03:43:39 +0000851 }
852 }
853 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000854 else {
855 PyErr_Format(PyExc_TypeError,
Tim Peters397301e2003-01-02 21:28:08 +0000856 "tzinfo.%s() must return None or "
Tim Peters855fe882002-12-22 03:43:39 +0000857 "timedelta, not '%s'",
858 name, u->ob_type->tp_name);
Tim Peters2a799bf2002-12-16 20:18:38 +0000859 }
860
Tim Peters2a799bf2002-12-16 20:18:38 +0000861 Py_DECREF(u);
862 if (result < -1439 || result > 1439) {
863 PyErr_Format(PyExc_ValueError,
Neal Norwitz506a2242003-01-04 01:02:25 +0000864 "tzinfo.%s() returned %d; must be in "
Tim Peters2a799bf2002-12-16 20:18:38 +0000865 "-1439 .. 1439",
866 name, result);
867 result = -1;
868 }
Tim Peters397301e2003-01-02 21:28:08 +0000869 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +0000870}
871
872/* Call tzinfo.utcoffset(tzinfoarg), and extract an integer from the
873 * result. tzinfo must be an instance of the tzinfo class. If utcoffset()
874 * returns None, call_utcoffset returns 0 and sets *none to 1. If uctoffset()
Tim Peters397301e2003-01-02 21:28:08 +0000875 * doesn't return None or timedelta, TypeError is raised and this returns -1.
876 * If utcoffset() returns an invalid timedelta (out of range, or not a whole
877 * # of minutes), ValueError is raised and this returns -1. Else *none is
878 * set to 0 and the offset is returned (as int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000879 */
880static int
881call_utcoffset(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
882{
883 return call_utc_tzinfo_method(tzinfo, "utcoffset", tzinfoarg, none);
884}
885
Tim Petersbad8ff02002-12-30 20:52:32 +0000886/* Call tzinfo.name(tzinfoarg), and return the offset as a timedelta or None.
887 */
Tim Peters855fe882002-12-22 03:43:39 +0000888static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000889offset_as_timedelta(PyObject *tzinfo, char *name, PyObject *tzinfoarg) {
Tim Peters855fe882002-12-22 03:43:39 +0000890 PyObject *result;
891
Tim Petersbad8ff02002-12-30 20:52:32 +0000892 assert(tzinfo && name && tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000893 if (tzinfo == Py_None) {
894 result = Py_None;
895 Py_INCREF(result);
896 }
897 else {
898 int none;
Tim Petersbad8ff02002-12-30 20:52:32 +0000899 int offset = call_utc_tzinfo_method(tzinfo, name, tzinfoarg,
900 &none);
Tim Peters855fe882002-12-22 03:43:39 +0000901 if (offset < 0 && PyErr_Occurred())
902 return NULL;
903 if (none) {
904 result = Py_None;
905 Py_INCREF(result);
906 }
907 else
908 result = new_delta(0, offset * 60, 0, 1);
909 }
910 return result;
911}
912
Tim Peters2a799bf2002-12-16 20:18:38 +0000913/* Call tzinfo.dst(tzinfoarg), and extract an integer from the
914 * result. tzinfo must be an instance of the tzinfo class. If dst()
915 * returns None, call_dst returns 0 and sets *none to 1. If dst()
Tim Peters397301e2003-01-02 21:28:08 +0000916 & doesn't return None or timedelta, TypeError is raised and this
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000917 * returns -1. If dst() returns an invalid timedelta for a UTC offset,
Tim Peters397301e2003-01-02 21:28:08 +0000918 * ValueError is raised and this returns -1. Else *none is set to 0 and
919 * the offset is returned (as an int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000920 */
921static int
922call_dst(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
923{
924 return call_utc_tzinfo_method(tzinfo, "dst", tzinfoarg, none);
925}
926
Tim Petersbad8ff02002-12-30 20:52:32 +0000927/* Call tzinfo.tzname(tzinfoarg), and return the result. tzinfo must be
Tim Peters855fe882002-12-22 03:43:39 +0000928 * an instance of the tzinfo class or None. If tzinfo isn't None, and
Tim Petersbad8ff02002-12-30 20:52:32 +0000929 * tzname() doesn't return None or a string, TypeError is raised and this
Guido van Rossume3d1d412007-05-23 21:24:35 +0000930 * returns NULL. If the result is a string, we ensure it is a Unicode
931 * string.
Tim Peters2a799bf2002-12-16 20:18:38 +0000932 */
933static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000934call_tzname(PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +0000935{
936 PyObject *result;
937
938 assert(tzinfo != NULL);
Tim Peters855fe882002-12-22 03:43:39 +0000939 assert(check_tzinfo_subclass(tzinfo) >= 0);
Tim Petersbad8ff02002-12-30 20:52:32 +0000940 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000941
Tim Peters855fe882002-12-22 03:43:39 +0000942 if (tzinfo == Py_None) {
943 result = Py_None;
944 Py_INCREF(result);
945 }
946 else
Tim Petersbad8ff02002-12-30 20:52:32 +0000947 result = PyObject_CallMethod(tzinfo, "tzname", "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000948
Guido van Rossume3d1d412007-05-23 21:24:35 +0000949 if (result != NULL && result != Py_None) {
950 if (!PyString_Check(result) && !PyUnicode_Check(result)) {
951 PyErr_Format(PyExc_TypeError, "tzinfo.tzname() must "
952 "return None or a string, not '%s'",
953 result->ob_type->tp_name);
954 Py_DECREF(result);
955 result = NULL;
956 }
957 else if (!PyUnicode_Check(result)) {
958 PyObject *temp = PyUnicode_FromObject(result);
959 Py_DECREF(result);
960 result = temp;
961 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000962 }
963 return result;
964}
965
966typedef enum {
967 /* an exception has been set; the caller should pass it on */
968 OFFSET_ERROR,
969
Tim Petersa9bc1682003-01-11 03:39:11 +0000970 /* type isn't date, datetime, or time subclass */
Tim Peters2a799bf2002-12-16 20:18:38 +0000971 OFFSET_UNKNOWN,
972
973 /* date,
Tim Petersa9bc1682003-01-11 03:39:11 +0000974 * datetime with !hastzinfo
975 * datetime with None tzinfo,
976 * datetime where utcoffset() returns None
Tim Peters37f39822003-01-10 03:49:02 +0000977 * time with !hastzinfo
978 * time with None tzinfo,
979 * time where utcoffset() returns None
Tim Peters2a799bf2002-12-16 20:18:38 +0000980 */
981 OFFSET_NAIVE,
982
Tim Petersa9bc1682003-01-11 03:39:11 +0000983 /* time or datetime where utcoffset() doesn't return None */
Georg Brandle810fe22006-02-19 15:28:47 +0000984 OFFSET_AWARE
Tim Peters2a799bf2002-12-16 20:18:38 +0000985} naivety;
986
Tim Peters14b69412002-12-22 18:10:22 +0000987/* Classify an object as to whether it's naive or offset-aware. See
Tim Peters2a799bf2002-12-16 20:18:38 +0000988 * the "naivety" typedef for details. If the type is aware, *offset is set
989 * to minutes east of UTC (as returned by the tzinfo.utcoffset() method).
Tim Peters14b69412002-12-22 18:10:22 +0000990 * If the type is offset-naive (or unknown, or error), *offset is set to 0.
Tim Peterse39a80c2002-12-30 21:28:52 +0000991 * tzinfoarg is the argument to pass to the tzinfo.utcoffset() method.
Tim Peters2a799bf2002-12-16 20:18:38 +0000992 */
993static naivety
Tim Peterse39a80c2002-12-30 21:28:52 +0000994classify_utcoffset(PyObject *op, PyObject *tzinfoarg, int *offset)
Tim Peters2a799bf2002-12-16 20:18:38 +0000995{
996 int none;
997 PyObject *tzinfo;
998
Tim Peterse39a80c2002-12-30 21:28:52 +0000999 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001000 *offset = 0;
Tim Peters14b69412002-12-22 18:10:22 +00001001 tzinfo = get_tzinfo_member(op); /* NULL means no tzinfo, not error */
Tim Peters2a799bf2002-12-16 20:18:38 +00001002 if (tzinfo == Py_None)
1003 return OFFSET_NAIVE;
Tim Peters14b69412002-12-22 18:10:22 +00001004 if (tzinfo == NULL) {
1005 /* note that a datetime passes the PyDate_Check test */
1006 return (PyTime_Check(op) || PyDate_Check(op)) ?
1007 OFFSET_NAIVE : OFFSET_UNKNOWN;
1008 }
Tim Peterse39a80c2002-12-30 21:28:52 +00001009 *offset = call_utcoffset(tzinfo, tzinfoarg, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00001010 if (*offset == -1 && PyErr_Occurred())
1011 return OFFSET_ERROR;
1012 return none ? OFFSET_NAIVE : OFFSET_AWARE;
1013}
1014
Tim Peters00237032002-12-27 02:21:51 +00001015/* Classify two objects as to whether they're naive or offset-aware.
1016 * This isn't quite the same as calling classify_utcoffset() twice: for
1017 * binary operations (comparison and subtraction), we generally want to
1018 * ignore the tzinfo members if they're identical. This is by design,
1019 * so that results match "naive" expectations when mixing objects from a
1020 * single timezone. So in that case, this sets both offsets to 0 and
1021 * both naiveties to OFFSET_NAIVE.
1022 * The function returns 0 if everything's OK, and -1 on error.
1023 */
1024static int
1025classify_two_utcoffsets(PyObject *o1, int *offset1, naivety *n1,
Tim Peterse39a80c2002-12-30 21:28:52 +00001026 PyObject *tzinfoarg1,
1027 PyObject *o2, int *offset2, naivety *n2,
1028 PyObject *tzinfoarg2)
Tim Peters00237032002-12-27 02:21:51 +00001029{
1030 if (get_tzinfo_member(o1) == get_tzinfo_member(o2)) {
1031 *offset1 = *offset2 = 0;
1032 *n1 = *n2 = OFFSET_NAIVE;
1033 }
1034 else {
Tim Peterse39a80c2002-12-30 21:28:52 +00001035 *n1 = classify_utcoffset(o1, tzinfoarg1, offset1);
Tim Peters00237032002-12-27 02:21:51 +00001036 if (*n1 == OFFSET_ERROR)
1037 return -1;
Tim Peterse39a80c2002-12-30 21:28:52 +00001038 *n2 = classify_utcoffset(o2, tzinfoarg2, offset2);
Tim Peters00237032002-12-27 02:21:51 +00001039 if (*n2 == OFFSET_ERROR)
1040 return -1;
1041 }
1042 return 0;
1043}
1044
Tim Peters2a799bf2002-12-16 20:18:38 +00001045/* repr is like "someclass(arg1, arg2)". If tzinfo isn't None,
1046 * stuff
1047 * ", tzinfo=" + repr(tzinfo)
1048 * before the closing ")".
1049 */
1050static PyObject *
1051append_keyword_tzinfo(PyObject *repr, PyObject *tzinfo)
1052{
1053 PyObject *temp;
1054
Walter Dörwald1ab83302007-05-18 17:15:44 +00001055 assert(PyUnicode_Check(repr));
Tim Peters2a799bf2002-12-16 20:18:38 +00001056 assert(tzinfo);
1057 if (tzinfo == Py_None)
1058 return repr;
1059 /* Get rid of the trailing ')'. */
Walter Dörwald1ab83302007-05-18 17:15:44 +00001060 assert(PyUnicode_AS_UNICODE(repr)[PyUnicode_GET_SIZE(repr)-1] == ')');
1061 temp = PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(repr),
1062 PyUnicode_GET_SIZE(repr) - 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00001063 Py_DECREF(repr);
1064 if (temp == NULL)
1065 return NULL;
Walter Dörwald517bcfe2007-05-23 20:45:05 +00001066 repr = PyUnicode_FromFormat("%U, tzinfo=%R)", temp, tzinfo);
1067 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00001068 return repr;
1069}
1070
1071/* ---------------------------------------------------------------------------
1072 * String format helpers.
1073 */
1074
1075static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00001076format_ctime(PyDateTime_Date *date, int hours, int minutes, int seconds)
Tim Peters2a799bf2002-12-16 20:18:38 +00001077{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001078 static const char *DayNames[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001079 "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"
1080 };
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001081 static const char *MonthNames[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001082 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1083 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
1084 };
1085
Tim Peters2a799bf2002-12-16 20:18:38 +00001086 int wday = weekday(GET_YEAR(date), GET_MONTH(date), GET_DAY(date));
1087
Walter Dörwald4af32b32007-05-31 16:19:50 +00001088 return PyUnicode_FromFormat("%s %s %2d %02d:%02d:%02d %04d",
1089 DayNames[wday], MonthNames[GET_MONTH(date)-1],
1090 GET_DAY(date), hours, minutes, seconds,
1091 GET_YEAR(date));
Tim Peters2a799bf2002-12-16 20:18:38 +00001092}
1093
1094/* Add an hours & minutes UTC offset string to buf. buf has no more than
1095 * buflen bytes remaining. The UTC offset is gotten by calling
1096 * tzinfo.uctoffset(tzinfoarg). If that returns None, \0 is stored into
1097 * *buf, and that's all. Else the returned value is checked for sanity (an
1098 * integer in range), and if that's OK it's converted to an hours & minutes
1099 * string of the form
1100 * sign HH sep MM
1101 * Returns 0 if everything is OK. If the return value from utcoffset() is
1102 * bogus, an appropriate exception is set and -1 is returned.
1103 */
1104static int
Tim Peters328fff72002-12-20 01:31:27 +00001105format_utcoffset(char *buf, size_t buflen, const char *sep,
Tim Peters2a799bf2002-12-16 20:18:38 +00001106 PyObject *tzinfo, PyObject *tzinfoarg)
1107{
1108 int offset;
1109 int hours;
1110 int minutes;
1111 char sign;
1112 int none;
1113
1114 offset = call_utcoffset(tzinfo, tzinfoarg, &none);
1115 if (offset == -1 && PyErr_Occurred())
1116 return -1;
1117 if (none) {
1118 *buf = '\0';
1119 return 0;
1120 }
1121 sign = '+';
1122 if (offset < 0) {
1123 sign = '-';
1124 offset = - offset;
1125 }
1126 hours = divmod(offset, 60, &minutes);
1127 PyOS_snprintf(buf, buflen, "%c%02d%s%02d", sign, hours, sep, minutes);
1128 return 0;
1129}
1130
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001131static PyObject *
1132make_Zreplacement(PyObject *object, PyObject *tzinfoarg)
1133{
1134 PyObject *tzinfo = get_tzinfo_member(object);
1135 PyObject *Zreplacement = PyString_FromString("");
1136 if (Zreplacement == NULL)
1137 return NULL;
1138 if (tzinfo != Py_None && tzinfo != NULL) {
1139 PyObject *temp;
1140 assert(tzinfoarg != NULL);
1141 temp = call_tzname(tzinfo, tzinfoarg);
1142 if (temp == NULL)
1143 goto Error;
1144 if (temp != Py_None) {
1145 assert(PyUnicode_Check(temp));
1146 /* Since the tzname is getting stuffed into the
1147 * format, we have to double any % signs so that
1148 * strftime doesn't treat them as format codes.
1149 */
1150 Py_DECREF(Zreplacement);
1151 Zreplacement = PyObject_CallMethod(temp, "replace",
1152 "ss", "%", "%%");
1153 Py_DECREF(temp);
1154 if (Zreplacement == NULL)
1155 return NULL;
1156 if (PyUnicode_Check(Zreplacement)) {
1157 Zreplacement =
1158 _PyUnicode_AsDefaultEncodedString(
1159 Zreplacement, NULL);
1160 if (Zreplacement == NULL)
1161 return NULL;
1162 }
1163 if (!PyString_Check(Zreplacement)) {
1164 PyErr_SetString(PyExc_TypeError,
1165 "tzname.replace() did not return a string");
1166 goto Error;
1167 }
1168 }
1169 else
1170 Py_DECREF(temp);
1171 }
1172 return Zreplacement;
1173
1174 Error:
1175 Py_DECREF(Zreplacement);
1176 return NULL;
1177}
1178
Tim Peters2a799bf2002-12-16 20:18:38 +00001179/* I sure don't want to reproduce the strftime code from the time module,
1180 * so this imports the module and calls it. All the hair is due to
1181 * giving special meanings to the %z and %Z format codes via a preprocessing
1182 * step on the format string.
Tim Petersbad8ff02002-12-30 20:52:32 +00001183 * tzinfoarg is the argument to pass to the object's tzinfo method, if
1184 * needed.
Tim Peters2a799bf2002-12-16 20:18:38 +00001185 */
1186static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +00001187wrap_strftime(PyObject *object, PyObject *format, PyObject *timetuple,
1188 PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001189{
1190 PyObject *result = NULL; /* guilty until proved innocent */
1191
1192 PyObject *zreplacement = NULL; /* py string, replacement for %z */
1193 PyObject *Zreplacement = NULL; /* py string, replacement for %Z */
1194
Guido van Rossumbce56a62007-05-10 18:04:33 +00001195 const char *pin;/* pointer to next char in input format */
1196 Py_ssize_t flen;/* length of input format */
Tim Peters2a799bf2002-12-16 20:18:38 +00001197 char ch; /* next char in input format */
1198
1199 PyObject *newfmt = NULL; /* py string, the output format */
1200 char *pnew; /* pointer to available byte in output format */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001201 int totalnew; /* number bytes total in output format buffer,
Tim Peters2a799bf2002-12-16 20:18:38 +00001202 exclusive of trailing \0 */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001203 int usednew; /* number bytes used so far in output format buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001204
Guido van Rossumbce56a62007-05-10 18:04:33 +00001205 const char *ptoappend;/* pointer to string to append to output buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001206 int ntoappend; /* # of bytes to append to output buffer */
1207
Tim Peters2a799bf2002-12-16 20:18:38 +00001208 assert(object && format && timetuple);
Guido van Rossumbce56a62007-05-10 18:04:33 +00001209 assert(PyString_Check(format) || PyUnicode_Check(format));
1210
1211 /* Convert the input format to a C string and size */
1212 if (PyObject_AsCharBuffer(format, &pin, &flen) < 0)
1213 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001214
Tim Petersd6844152002-12-22 20:58:42 +00001215 /* Give up if the year is before 1900.
1216 * Python strftime() plays games with the year, and different
1217 * games depending on whether envar PYTHON2K is set. This makes
1218 * years before 1900 a nightmare, even if the platform strftime
1219 * supports them (and not all do).
1220 * We could get a lot farther here by avoiding Python's strftime
1221 * wrapper and calling the C strftime() directly, but that isn't
1222 * an option in the Python implementation of this module.
1223 */
1224 {
1225 long year;
1226 PyObject *pyyear = PySequence_GetItem(timetuple, 0);
1227 if (pyyear == NULL) return NULL;
1228 assert(PyInt_Check(pyyear));
1229 year = PyInt_AsLong(pyyear);
1230 Py_DECREF(pyyear);
1231 if (year < 1900) {
1232 PyErr_Format(PyExc_ValueError, "year=%ld is before "
1233 "1900; the datetime strftime() "
1234 "methods require year >= 1900",
1235 year);
1236 return NULL;
1237 }
1238 }
1239
Tim Peters2a799bf2002-12-16 20:18:38 +00001240 /* Scan the input format, looking for %z and %Z escapes, building
Tim Peters328fff72002-12-20 01:31:27 +00001241 * a new format. Since computing the replacements for those codes
1242 * is expensive, don't unless they're actually used.
Tim Peters2a799bf2002-12-16 20:18:38 +00001243 */
Guido van Rossumbce56a62007-05-10 18:04:33 +00001244 totalnew = flen + 1; /* realistic if no %z/%Z */
Tim Peters2a799bf2002-12-16 20:18:38 +00001245 newfmt = PyString_FromStringAndSize(NULL, totalnew);
1246 if (newfmt == NULL) goto Done;
1247 pnew = PyString_AsString(newfmt);
1248 usednew = 0;
1249
Tim Peters2a799bf2002-12-16 20:18:38 +00001250 while ((ch = *pin++) != '\0') {
1251 if (ch != '%') {
Tim Peters328fff72002-12-20 01:31:27 +00001252 ptoappend = pin - 1;
Tim Peters2a799bf2002-12-16 20:18:38 +00001253 ntoappend = 1;
1254 }
1255 else if ((ch = *pin++) == '\0') {
1256 /* There's a lone trailing %; doesn't make sense. */
1257 PyErr_SetString(PyExc_ValueError, "strftime format "
1258 "ends with raw %");
1259 goto Done;
1260 }
1261 /* A % has been seen and ch is the character after it. */
1262 else if (ch == 'z') {
1263 if (zreplacement == NULL) {
1264 /* format utcoffset */
Tim Peters328fff72002-12-20 01:31:27 +00001265 char buf[100];
Tim Peters2a799bf2002-12-16 20:18:38 +00001266 PyObject *tzinfo = get_tzinfo_member(object);
1267 zreplacement = PyString_FromString("");
1268 if (zreplacement == NULL) goto Done;
1269 if (tzinfo != Py_None && tzinfo != NULL) {
Tim Petersbad8ff02002-12-30 20:52:32 +00001270 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001271 if (format_utcoffset(buf,
Tim Peters328fff72002-12-20 01:31:27 +00001272 sizeof(buf),
Tim Peters2a799bf2002-12-16 20:18:38 +00001273 "",
1274 tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00001275 tzinfoarg) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00001276 goto Done;
1277 Py_DECREF(zreplacement);
1278 zreplacement = PyString_FromString(buf);
1279 if (zreplacement == NULL) goto Done;
1280 }
1281 }
1282 assert(zreplacement != NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001283 ptoappend = PyString_AS_STRING(zreplacement);
1284 ntoappend = PyString_GET_SIZE(zreplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001285 }
1286 else if (ch == 'Z') {
1287 /* format tzname */
1288 if (Zreplacement == NULL) {
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001289 Zreplacement = make_Zreplacement(object,
1290 tzinfoarg);
1291 if (Zreplacement == NULL)
1292 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00001293 }
1294 assert(Zreplacement != NULL);
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001295 assert(PyString_Check(Zreplacement));
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001296 ptoappend = PyString_AS_STRING(Zreplacement);
1297 ntoappend = PyString_GET_SIZE(Zreplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001298 }
1299 else {
Tim Peters328fff72002-12-20 01:31:27 +00001300 /* percent followed by neither z nor Z */
1301 ptoappend = pin - 2;
Tim Peters2a799bf2002-12-16 20:18:38 +00001302 ntoappend = 2;
1303 }
1304
1305 /* Append the ntoappend chars starting at ptoappend to
1306 * the new format.
1307 */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001308 assert(ptoappend != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001309 assert(ntoappend >= 0);
1310 if (ntoappend == 0)
1311 continue;
1312 while (usednew + ntoappend > totalnew) {
1313 int bigger = totalnew << 1;
1314 if ((bigger >> 1) != totalnew) { /* overflow */
1315 PyErr_NoMemory();
1316 goto Done;
1317 }
1318 if (_PyString_Resize(&newfmt, bigger) < 0)
1319 goto Done;
1320 totalnew = bigger;
1321 pnew = PyString_AsString(newfmt) + usednew;
1322 }
1323 memcpy(pnew, ptoappend, ntoappend);
1324 pnew += ntoappend;
1325 usednew += ntoappend;
1326 assert(usednew <= totalnew);
1327 } /* end while() */
1328
1329 if (_PyString_Resize(&newfmt, usednew) < 0)
1330 goto Done;
1331 {
1332 PyObject *time = PyImport_ImportModule("time");
1333 if (time == NULL)
1334 goto Done;
1335 result = PyObject_CallMethod(time, "strftime", "OO",
1336 newfmt, timetuple);
1337 Py_DECREF(time);
1338 }
1339 Done:
1340 Py_XDECREF(zreplacement);
1341 Py_XDECREF(Zreplacement);
1342 Py_XDECREF(newfmt);
1343 return result;
1344}
1345
Tim Peters2a799bf2002-12-16 20:18:38 +00001346/* ---------------------------------------------------------------------------
1347 * Wrap functions from the time module. These aren't directly available
1348 * from C. Perhaps they should be.
1349 */
1350
1351/* Call time.time() and return its result (a Python float). */
1352static PyObject *
Guido van Rossumbd43e912002-12-16 20:34:55 +00001353time_time(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00001354{
1355 PyObject *result = NULL;
1356 PyObject *time = PyImport_ImportModule("time");
1357
1358 if (time != NULL) {
1359 result = PyObject_CallMethod(time, "time", "()");
1360 Py_DECREF(time);
1361 }
1362 return result;
1363}
1364
1365/* Build a time.struct_time. The weekday and day number are automatically
1366 * computed from the y,m,d args.
1367 */
1368static PyObject *
1369build_struct_time(int y, int m, int d, int hh, int mm, int ss, int dstflag)
1370{
1371 PyObject *time;
1372 PyObject *result = NULL;
1373
1374 time = PyImport_ImportModule("time");
1375 if (time != NULL) {
1376 result = PyObject_CallMethod(time, "struct_time",
1377 "((iiiiiiiii))",
1378 y, m, d,
1379 hh, mm, ss,
1380 weekday(y, m, d),
1381 days_before_month(y, m) + d,
1382 dstflag);
1383 Py_DECREF(time);
1384 }
1385 return result;
1386}
1387
1388/* ---------------------------------------------------------------------------
1389 * Miscellaneous helpers.
1390 */
1391
Guido van Rossum19960592006-08-24 17:29:38 +00001392/* For various reasons, we need to use tp_richcompare instead of tp_compare.
Tim Peters2a799bf2002-12-16 20:18:38 +00001393 * The comparisons here all most naturally compute a cmp()-like result.
1394 * This little helper turns that into a bool result for rich comparisons.
1395 */
1396static PyObject *
1397diff_to_bool(int diff, int op)
1398{
1399 PyObject *result;
1400 int istrue;
1401
1402 switch (op) {
1403 case Py_EQ: istrue = diff == 0; break;
1404 case Py_NE: istrue = diff != 0; break;
1405 case Py_LE: istrue = diff <= 0; break;
1406 case Py_GE: istrue = diff >= 0; break;
1407 case Py_LT: istrue = diff < 0; break;
1408 case Py_GT: istrue = diff > 0; break;
1409 default:
1410 assert(! "op unknown");
1411 istrue = 0; /* To shut up compiler */
1412 }
1413 result = istrue ? Py_True : Py_False;
1414 Py_INCREF(result);
1415 return result;
1416}
1417
Tim Peters07534a62003-02-07 22:50:28 +00001418/* Raises a "can't compare" TypeError and returns NULL. */
1419static PyObject *
1420cmperror(PyObject *a, PyObject *b)
1421{
1422 PyErr_Format(PyExc_TypeError,
1423 "can't compare %s to %s",
1424 a->ob_type->tp_name, b->ob_type->tp_name);
1425 return NULL;
1426}
1427
Tim Peters2a799bf2002-12-16 20:18:38 +00001428/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +00001429 * Cached Python objects; these are set by the module init function.
1430 */
1431
1432/* Conversion factors. */
1433static PyObject *us_per_us = NULL; /* 1 */
1434static PyObject *us_per_ms = NULL; /* 1000 */
1435static PyObject *us_per_second = NULL; /* 1000000 */
1436static PyObject *us_per_minute = NULL; /* 1e6 * 60 as Python int */
1437static PyObject *us_per_hour = NULL; /* 1e6 * 3600 as Python long */
1438static PyObject *us_per_day = NULL; /* 1e6 * 3600 * 24 as Python long */
1439static PyObject *us_per_week = NULL; /* 1e6*3600*24*7 as Python long */
1440static PyObject *seconds_per_day = NULL; /* 3600*24 as Python int */
1441
Tim Peters2a799bf2002-12-16 20:18:38 +00001442/* ---------------------------------------------------------------------------
1443 * Class implementations.
1444 */
1445
1446/*
1447 * PyDateTime_Delta implementation.
1448 */
1449
1450/* Convert a timedelta to a number of us,
1451 * (24*3600*self.days + self.seconds)*1000000 + self.microseconds
1452 * as a Python int or long.
1453 * Doing mixed-radix arithmetic by hand instead is excruciating in C,
1454 * due to ubiquitous overflow possibilities.
1455 */
1456static PyObject *
1457delta_to_microseconds(PyDateTime_Delta *self)
1458{
1459 PyObject *x1 = NULL;
1460 PyObject *x2 = NULL;
1461 PyObject *x3 = NULL;
1462 PyObject *result = NULL;
1463
1464 x1 = PyInt_FromLong(GET_TD_DAYS(self));
1465 if (x1 == NULL)
1466 goto Done;
1467 x2 = PyNumber_Multiply(x1, seconds_per_day); /* days in seconds */
1468 if (x2 == NULL)
1469 goto Done;
1470 Py_DECREF(x1);
1471 x1 = NULL;
1472
1473 /* x2 has days in seconds */
1474 x1 = PyInt_FromLong(GET_TD_SECONDS(self)); /* seconds */
1475 if (x1 == NULL)
1476 goto Done;
1477 x3 = PyNumber_Add(x1, x2); /* days and seconds in seconds */
1478 if (x3 == NULL)
1479 goto Done;
1480 Py_DECREF(x1);
1481 Py_DECREF(x2);
1482 x1 = x2 = NULL;
1483
1484 /* x3 has days+seconds in seconds */
1485 x1 = PyNumber_Multiply(x3, us_per_second); /* us */
1486 if (x1 == NULL)
1487 goto Done;
1488 Py_DECREF(x3);
1489 x3 = NULL;
1490
1491 /* x1 has days+seconds in us */
1492 x2 = PyInt_FromLong(GET_TD_MICROSECONDS(self));
1493 if (x2 == NULL)
1494 goto Done;
1495 result = PyNumber_Add(x1, x2);
1496
1497Done:
1498 Py_XDECREF(x1);
1499 Py_XDECREF(x2);
1500 Py_XDECREF(x3);
1501 return result;
1502}
1503
1504/* Convert a number of us (as a Python int or long) to a timedelta.
1505 */
1506static PyObject *
Tim Petersb0c854d2003-05-17 15:57:00 +00001507microseconds_to_delta_ex(PyObject *pyus, PyTypeObject *type)
Tim Peters2a799bf2002-12-16 20:18:38 +00001508{
1509 int us;
1510 int s;
1511 int d;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001512 long temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001513
1514 PyObject *tuple = NULL;
1515 PyObject *num = NULL;
1516 PyObject *result = NULL;
1517
1518 tuple = PyNumber_Divmod(pyus, us_per_second);
1519 if (tuple == NULL)
1520 goto Done;
1521
1522 num = PyTuple_GetItem(tuple, 1); /* us */
1523 if (num == NULL)
1524 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001525 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001526 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001527 if (temp == -1 && PyErr_Occurred())
1528 goto Done;
1529 assert(0 <= temp && temp < 1000000);
1530 us = (int)temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001531 if (us < 0) {
1532 /* The divisor was positive, so this must be an error. */
1533 assert(PyErr_Occurred());
1534 goto Done;
1535 }
1536
1537 num = PyTuple_GetItem(tuple, 0); /* leftover seconds */
1538 if (num == NULL)
1539 goto Done;
1540 Py_INCREF(num);
1541 Py_DECREF(tuple);
1542
1543 tuple = PyNumber_Divmod(num, seconds_per_day);
1544 if (tuple == NULL)
1545 goto Done;
1546 Py_DECREF(num);
1547
1548 num = PyTuple_GetItem(tuple, 1); /* seconds */
1549 if (num == NULL)
1550 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001551 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001552 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001553 if (temp == -1 && PyErr_Occurred())
1554 goto Done;
1555 assert(0 <= temp && temp < 24*3600);
1556 s = (int)temp;
1557
Tim Peters2a799bf2002-12-16 20:18:38 +00001558 if (s < 0) {
1559 /* The divisor was positive, so this must be an error. */
1560 assert(PyErr_Occurred());
1561 goto Done;
1562 }
1563
1564 num = PyTuple_GetItem(tuple, 0); /* leftover days */
1565 if (num == NULL)
1566 goto Done;
1567 Py_INCREF(num);
Tim Peters0b0f41c2002-12-19 01:44:38 +00001568 temp = PyLong_AsLong(num);
1569 if (temp == -1 && PyErr_Occurred())
Tim Peters2a799bf2002-12-16 20:18:38 +00001570 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001571 d = (int)temp;
1572 if ((long)d != temp) {
1573 PyErr_SetString(PyExc_OverflowError, "normalized days too "
1574 "large to fit in a C int");
1575 goto Done;
1576 }
Tim Petersb0c854d2003-05-17 15:57:00 +00001577 result = new_delta_ex(d, s, us, 0, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001578
1579Done:
1580 Py_XDECREF(tuple);
1581 Py_XDECREF(num);
1582 return result;
1583}
1584
Tim Petersb0c854d2003-05-17 15:57:00 +00001585#define microseconds_to_delta(pymicros) \
1586 microseconds_to_delta_ex(pymicros, &PyDateTime_DeltaType)
1587
Tim Peters2a799bf2002-12-16 20:18:38 +00001588static PyObject *
1589multiply_int_timedelta(PyObject *intobj, PyDateTime_Delta *delta)
1590{
1591 PyObject *pyus_in;
1592 PyObject *pyus_out;
1593 PyObject *result;
1594
1595 pyus_in = delta_to_microseconds(delta);
1596 if (pyus_in == NULL)
1597 return NULL;
1598
1599 pyus_out = PyNumber_Multiply(pyus_in, intobj);
1600 Py_DECREF(pyus_in);
1601 if (pyus_out == NULL)
1602 return NULL;
1603
1604 result = microseconds_to_delta(pyus_out);
1605 Py_DECREF(pyus_out);
1606 return result;
1607}
1608
1609static PyObject *
1610divide_timedelta_int(PyDateTime_Delta *delta, PyObject *intobj)
1611{
1612 PyObject *pyus_in;
1613 PyObject *pyus_out;
1614 PyObject *result;
1615
1616 pyus_in = delta_to_microseconds(delta);
1617 if (pyus_in == NULL)
1618 return NULL;
1619
1620 pyus_out = PyNumber_FloorDivide(pyus_in, intobj);
1621 Py_DECREF(pyus_in);
1622 if (pyus_out == NULL)
1623 return NULL;
1624
1625 result = microseconds_to_delta(pyus_out);
1626 Py_DECREF(pyus_out);
1627 return result;
1628}
1629
1630static PyObject *
1631delta_add(PyObject *left, PyObject *right)
1632{
1633 PyObject *result = Py_NotImplemented;
1634
1635 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1636 /* delta + delta */
1637 /* The C-level additions can't overflow because of the
1638 * invariant bounds.
1639 */
1640 int days = GET_TD_DAYS(left) + GET_TD_DAYS(right);
1641 int seconds = GET_TD_SECONDS(left) + GET_TD_SECONDS(right);
1642 int microseconds = GET_TD_MICROSECONDS(left) +
1643 GET_TD_MICROSECONDS(right);
1644 result = new_delta(days, seconds, microseconds, 1);
1645 }
1646
1647 if (result == Py_NotImplemented)
1648 Py_INCREF(result);
1649 return result;
1650}
1651
1652static PyObject *
1653delta_negative(PyDateTime_Delta *self)
1654{
1655 return new_delta(-GET_TD_DAYS(self),
1656 -GET_TD_SECONDS(self),
1657 -GET_TD_MICROSECONDS(self),
1658 1);
1659}
1660
1661static PyObject *
1662delta_positive(PyDateTime_Delta *self)
1663{
1664 /* Could optimize this (by returning self) if this isn't a
1665 * subclass -- but who uses unary + ? Approximately nobody.
1666 */
1667 return new_delta(GET_TD_DAYS(self),
1668 GET_TD_SECONDS(self),
1669 GET_TD_MICROSECONDS(self),
1670 0);
1671}
1672
1673static PyObject *
1674delta_abs(PyDateTime_Delta *self)
1675{
1676 PyObject *result;
1677
1678 assert(GET_TD_MICROSECONDS(self) >= 0);
1679 assert(GET_TD_SECONDS(self) >= 0);
1680
1681 if (GET_TD_DAYS(self) < 0)
1682 result = delta_negative(self);
1683 else
1684 result = delta_positive(self);
1685
1686 return result;
1687}
1688
1689static PyObject *
1690delta_subtract(PyObject *left, PyObject *right)
1691{
1692 PyObject *result = Py_NotImplemented;
1693
1694 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1695 /* delta - delta */
1696 PyObject *minus_right = PyNumber_Negative(right);
1697 if (minus_right) {
1698 result = delta_add(left, minus_right);
1699 Py_DECREF(minus_right);
1700 }
1701 else
1702 result = NULL;
1703 }
1704
1705 if (result == Py_NotImplemented)
1706 Py_INCREF(result);
1707 return result;
1708}
1709
Tim Peters2a799bf2002-12-16 20:18:38 +00001710static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00001711delta_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters2a799bf2002-12-16 20:18:38 +00001712{
Tim Petersaa7d8492003-02-08 03:28:59 +00001713 if (PyDelta_Check(other)) {
Guido van Rossum19960592006-08-24 17:29:38 +00001714 int diff = GET_TD_DAYS(self) - GET_TD_DAYS(other);
Tim Peters07534a62003-02-07 22:50:28 +00001715 if (diff == 0) {
1716 diff = GET_TD_SECONDS(self) - GET_TD_SECONDS(other);
1717 if (diff == 0)
1718 diff = GET_TD_MICROSECONDS(self) -
1719 GET_TD_MICROSECONDS(other);
1720 }
Guido van Rossum19960592006-08-24 17:29:38 +00001721 return diff_to_bool(diff, op);
Tim Peters2a799bf2002-12-16 20:18:38 +00001722 }
Guido van Rossum19960592006-08-24 17:29:38 +00001723 else {
1724 Py_INCREF(Py_NotImplemented);
1725 return Py_NotImplemented;
1726 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001727}
1728
1729static PyObject *delta_getstate(PyDateTime_Delta *self);
1730
1731static long
1732delta_hash(PyDateTime_Delta *self)
1733{
1734 if (self->hashcode == -1) {
1735 PyObject *temp = delta_getstate(self);
1736 if (temp != NULL) {
1737 self->hashcode = PyObject_Hash(temp);
1738 Py_DECREF(temp);
1739 }
1740 }
1741 return self->hashcode;
1742}
1743
1744static PyObject *
1745delta_multiply(PyObject *left, PyObject *right)
1746{
1747 PyObject *result = Py_NotImplemented;
1748
1749 if (PyDelta_Check(left)) {
1750 /* delta * ??? */
1751 if (PyInt_Check(right) || PyLong_Check(right))
1752 result = multiply_int_timedelta(right,
1753 (PyDateTime_Delta *) left);
1754 }
1755 else if (PyInt_Check(left) || PyLong_Check(left))
1756 result = multiply_int_timedelta(left,
1757 (PyDateTime_Delta *) right);
1758
1759 if (result == Py_NotImplemented)
1760 Py_INCREF(result);
1761 return result;
1762}
1763
1764static PyObject *
1765delta_divide(PyObject *left, PyObject *right)
1766{
1767 PyObject *result = Py_NotImplemented;
1768
1769 if (PyDelta_Check(left)) {
1770 /* delta * ??? */
1771 if (PyInt_Check(right) || PyLong_Check(right))
1772 result = divide_timedelta_int(
1773 (PyDateTime_Delta *)left,
1774 right);
1775 }
1776
1777 if (result == Py_NotImplemented)
1778 Py_INCREF(result);
1779 return result;
1780}
1781
1782/* Fold in the value of the tag ("seconds", "weeks", etc) component of a
1783 * timedelta constructor. sofar is the # of microseconds accounted for
1784 * so far, and there are factor microseconds per current unit, the number
1785 * of which is given by num. num * factor is added to sofar in a
1786 * numerically careful way, and that's the result. Any fractional
1787 * microseconds left over (this can happen if num is a float type) are
1788 * added into *leftover.
1789 * Note that there are many ways this can give an error (NULL) return.
1790 */
1791static PyObject *
1792accum(const char* tag, PyObject *sofar, PyObject *num, PyObject *factor,
1793 double *leftover)
1794{
1795 PyObject *prod;
1796 PyObject *sum;
1797
1798 assert(num != NULL);
1799
1800 if (PyInt_Check(num) || PyLong_Check(num)) {
1801 prod = PyNumber_Multiply(num, factor);
1802 if (prod == NULL)
1803 return NULL;
1804 sum = PyNumber_Add(sofar, prod);
1805 Py_DECREF(prod);
1806 return sum;
1807 }
1808
1809 if (PyFloat_Check(num)) {
1810 double dnum;
1811 double fracpart;
1812 double intpart;
1813 PyObject *x;
1814 PyObject *y;
1815
1816 /* The Plan: decompose num into an integer part and a
1817 * fractional part, num = intpart + fracpart.
1818 * Then num * factor ==
1819 * intpart * factor + fracpart * factor
1820 * and the LHS can be computed exactly in long arithmetic.
1821 * The RHS is again broken into an int part and frac part.
1822 * and the frac part is added into *leftover.
1823 */
1824 dnum = PyFloat_AsDouble(num);
1825 if (dnum == -1.0 && PyErr_Occurred())
1826 return NULL;
1827 fracpart = modf(dnum, &intpart);
1828 x = PyLong_FromDouble(intpart);
1829 if (x == NULL)
1830 return NULL;
1831
1832 prod = PyNumber_Multiply(x, factor);
1833 Py_DECREF(x);
1834 if (prod == NULL)
1835 return NULL;
1836
1837 sum = PyNumber_Add(sofar, prod);
1838 Py_DECREF(prod);
1839 if (sum == NULL)
1840 return NULL;
1841
1842 if (fracpart == 0.0)
1843 return sum;
1844 /* So far we've lost no information. Dealing with the
1845 * fractional part requires float arithmetic, and may
1846 * lose a little info.
1847 */
1848 assert(PyInt_Check(factor) || PyLong_Check(factor));
Guido van Rossumddefaf32007-01-14 03:31:43 +00001849 dnum = PyLong_AsDouble(factor);
Tim Peters2a799bf2002-12-16 20:18:38 +00001850
1851 dnum *= fracpart;
1852 fracpart = modf(dnum, &intpart);
1853 x = PyLong_FromDouble(intpart);
1854 if (x == NULL) {
1855 Py_DECREF(sum);
1856 return NULL;
1857 }
1858
1859 y = PyNumber_Add(sum, x);
1860 Py_DECREF(sum);
1861 Py_DECREF(x);
1862 *leftover += fracpart;
1863 return y;
1864 }
1865
1866 PyErr_Format(PyExc_TypeError,
1867 "unsupported type for timedelta %s component: %s",
1868 tag, num->ob_type->tp_name);
1869 return NULL;
1870}
1871
1872static PyObject *
1873delta_new(PyTypeObject *type, PyObject *args, PyObject *kw)
1874{
1875 PyObject *self = NULL;
1876
1877 /* Argument objects. */
1878 PyObject *day = NULL;
1879 PyObject *second = NULL;
1880 PyObject *us = NULL;
1881 PyObject *ms = NULL;
1882 PyObject *minute = NULL;
1883 PyObject *hour = NULL;
1884 PyObject *week = NULL;
1885
1886 PyObject *x = NULL; /* running sum of microseconds */
1887 PyObject *y = NULL; /* temp sum of microseconds */
1888 double leftover_us = 0.0;
1889
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00001890 static char *keywords[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001891 "days", "seconds", "microseconds", "milliseconds",
1892 "minutes", "hours", "weeks", NULL
1893 };
1894
1895 if (PyArg_ParseTupleAndKeywords(args, kw, "|OOOOOOO:__new__",
1896 keywords,
1897 &day, &second, &us,
1898 &ms, &minute, &hour, &week) == 0)
1899 goto Done;
1900
1901 x = PyInt_FromLong(0);
1902 if (x == NULL)
1903 goto Done;
1904
1905#define CLEANUP \
1906 Py_DECREF(x); \
1907 x = y; \
1908 if (x == NULL) \
1909 goto Done
1910
1911 if (us) {
1912 y = accum("microseconds", x, us, us_per_us, &leftover_us);
1913 CLEANUP;
1914 }
1915 if (ms) {
1916 y = accum("milliseconds", x, ms, us_per_ms, &leftover_us);
1917 CLEANUP;
1918 }
1919 if (second) {
1920 y = accum("seconds", x, second, us_per_second, &leftover_us);
1921 CLEANUP;
1922 }
1923 if (minute) {
1924 y = accum("minutes", x, minute, us_per_minute, &leftover_us);
1925 CLEANUP;
1926 }
1927 if (hour) {
1928 y = accum("hours", x, hour, us_per_hour, &leftover_us);
1929 CLEANUP;
1930 }
1931 if (day) {
1932 y = accum("days", x, day, us_per_day, &leftover_us);
1933 CLEANUP;
1934 }
1935 if (week) {
1936 y = accum("weeks", x, week, us_per_week, &leftover_us);
1937 CLEANUP;
1938 }
1939 if (leftover_us) {
1940 /* Round to nearest whole # of us, and add into x. */
Tim Peters5d644dd2003-01-02 16:32:54 +00001941 PyObject *temp = PyLong_FromLong(round_to_long(leftover_us));
Tim Peters2a799bf2002-12-16 20:18:38 +00001942 if (temp == NULL) {
1943 Py_DECREF(x);
1944 goto Done;
1945 }
1946 y = PyNumber_Add(x, temp);
1947 Py_DECREF(temp);
1948 CLEANUP;
1949 }
1950
Tim Petersb0c854d2003-05-17 15:57:00 +00001951 self = microseconds_to_delta_ex(x, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001952 Py_DECREF(x);
1953Done:
1954 return self;
1955
1956#undef CLEANUP
1957}
1958
1959static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00001960delta_bool(PyDateTime_Delta *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00001961{
1962 return (GET_TD_DAYS(self) != 0
1963 || GET_TD_SECONDS(self) != 0
1964 || GET_TD_MICROSECONDS(self) != 0);
1965}
1966
1967static PyObject *
1968delta_repr(PyDateTime_Delta *self)
1969{
1970 if (GET_TD_MICROSECONDS(self) != 0)
Walter Dörwald1ab83302007-05-18 17:15:44 +00001971 return PyUnicode_FromFormat("%s(%d, %d, %d)",
Walter Dörwald7569dfe2007-05-19 21:49:49 +00001972 self->ob_type->tp_name,
1973 GET_TD_DAYS(self),
1974 GET_TD_SECONDS(self),
1975 GET_TD_MICROSECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00001976 if (GET_TD_SECONDS(self) != 0)
Walter Dörwald1ab83302007-05-18 17:15:44 +00001977 return PyUnicode_FromFormat("%s(%d, %d)",
Walter Dörwald7569dfe2007-05-19 21:49:49 +00001978 self->ob_type->tp_name,
1979 GET_TD_DAYS(self),
1980 GET_TD_SECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00001981
Walter Dörwald1ab83302007-05-18 17:15:44 +00001982 return PyUnicode_FromFormat("%s(%d)",
Walter Dörwald7569dfe2007-05-19 21:49:49 +00001983 self->ob_type->tp_name,
1984 GET_TD_DAYS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00001985}
1986
1987static PyObject *
1988delta_str(PyDateTime_Delta *self)
1989{
Tim Peters2a799bf2002-12-16 20:18:38 +00001990 int us = GET_TD_MICROSECONDS(self);
Walter Dörwaldbaf853c2007-05-31 18:42:47 +00001991 int seconds = GET_TD_SECONDS(self);
1992 int minutes = divmod(seconds, 60, &seconds);
1993 int hours = divmod(minutes, 60, &minutes);
1994 int days = GET_TD_DAYS(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00001995
1996 if (days) {
Walter Dörwaldbaf853c2007-05-31 18:42:47 +00001997 if (us)
1998 return PyUnicode_FromFormat("%d day%s, %d:%02d:%02d.%06d",
1999 days, (days == 1 || days == -1) ? "" : "s",
2000 hours, minutes, seconds, us);
2001 else
2002 return PyUnicode_FromFormat("%d day%s, %d:%02d:%02d",
2003 days, (days == 1 || days == -1) ? "" : "s",
2004 hours, minutes, seconds);
2005 } else {
2006 if (us)
2007 return PyUnicode_FromFormat("%d:%02d:%02d.%06d",
2008 hours, minutes, seconds, us);
2009 else
2010 return PyUnicode_FromFormat("%d:%02d:%02d",
2011 hours, minutes, seconds);
Tim Peters2a799bf2002-12-16 20:18:38 +00002012 }
2013
Tim Peters2a799bf2002-12-16 20:18:38 +00002014}
2015
Tim Peters371935f2003-02-01 01:52:50 +00002016/* Pickle support, a simple use of __reduce__. */
2017
Tim Petersb57f8f02003-02-01 02:54:15 +00002018/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002019static PyObject *
2020delta_getstate(PyDateTime_Delta *self)
2021{
2022 return Py_BuildValue("iii", GET_TD_DAYS(self),
2023 GET_TD_SECONDS(self),
2024 GET_TD_MICROSECONDS(self));
2025}
2026
Tim Peters2a799bf2002-12-16 20:18:38 +00002027static PyObject *
2028delta_reduce(PyDateTime_Delta* self)
2029{
Tim Peters8a60c222003-02-01 01:47:29 +00002030 return Py_BuildValue("ON", self->ob_type, delta_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002031}
2032
2033#define OFFSET(field) offsetof(PyDateTime_Delta, field)
2034
2035static PyMemberDef delta_members[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002036
Neal Norwitzdfb80862002-12-19 02:30:56 +00002037 {"days", T_INT, OFFSET(days), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002038 PyDoc_STR("Number of days.")},
2039
Neal Norwitzdfb80862002-12-19 02:30:56 +00002040 {"seconds", T_INT, OFFSET(seconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002041 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
2042
Neal Norwitzdfb80862002-12-19 02:30:56 +00002043 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002044 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
2045 {NULL}
2046};
2047
2048static PyMethodDef delta_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002049 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
2050 PyDoc_STR("__reduce__() -> (cls, state)")},
2051
Tim Peters2a799bf2002-12-16 20:18:38 +00002052 {NULL, NULL},
2053};
2054
2055static char delta_doc[] =
2056PyDoc_STR("Difference between two datetime values.");
2057
2058static PyNumberMethods delta_as_number = {
2059 delta_add, /* nb_add */
2060 delta_subtract, /* nb_subtract */
2061 delta_multiply, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00002062 0, /* nb_remainder */
2063 0, /* nb_divmod */
2064 0, /* nb_power */
2065 (unaryfunc)delta_negative, /* nb_negative */
2066 (unaryfunc)delta_positive, /* nb_positive */
2067 (unaryfunc)delta_abs, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +00002068 (inquiry)delta_bool, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00002069 0, /*nb_invert*/
2070 0, /*nb_lshift*/
2071 0, /*nb_rshift*/
2072 0, /*nb_and*/
2073 0, /*nb_xor*/
2074 0, /*nb_or*/
2075 0, /*nb_coerce*/
2076 0, /*nb_int*/
2077 0, /*nb_long*/
2078 0, /*nb_float*/
2079 0, /*nb_oct*/
2080 0, /*nb_hex*/
2081 0, /*nb_inplace_add*/
2082 0, /*nb_inplace_subtract*/
2083 0, /*nb_inplace_multiply*/
Tim Peters2a799bf2002-12-16 20:18:38 +00002084 0, /*nb_inplace_remainder*/
2085 0, /*nb_inplace_power*/
2086 0, /*nb_inplace_lshift*/
2087 0, /*nb_inplace_rshift*/
2088 0, /*nb_inplace_and*/
2089 0, /*nb_inplace_xor*/
2090 0, /*nb_inplace_or*/
2091 delta_divide, /* nb_floor_divide */
2092 0, /* nb_true_divide */
2093 0, /* nb_inplace_floor_divide */
2094 0, /* nb_inplace_true_divide */
2095};
2096
2097static PyTypeObject PyDateTime_DeltaType = {
2098 PyObject_HEAD_INIT(NULL)
2099 0, /* ob_size */
2100 "datetime.timedelta", /* tp_name */
2101 sizeof(PyDateTime_Delta), /* tp_basicsize */
2102 0, /* tp_itemsize */
2103 0, /* tp_dealloc */
2104 0, /* tp_print */
2105 0, /* tp_getattr */
2106 0, /* tp_setattr */
2107 0, /* tp_compare */
2108 (reprfunc)delta_repr, /* tp_repr */
2109 &delta_as_number, /* tp_as_number */
2110 0, /* tp_as_sequence */
2111 0, /* tp_as_mapping */
2112 (hashfunc)delta_hash, /* tp_hash */
2113 0, /* tp_call */
2114 (reprfunc)delta_str, /* tp_str */
2115 PyObject_GenericGetAttr, /* tp_getattro */
2116 0, /* tp_setattro */
2117 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002118 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00002119 delta_doc, /* tp_doc */
2120 0, /* tp_traverse */
2121 0, /* tp_clear */
Guido van Rossum19960592006-08-24 17:29:38 +00002122 delta_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00002123 0, /* tp_weaklistoffset */
2124 0, /* tp_iter */
2125 0, /* tp_iternext */
2126 delta_methods, /* tp_methods */
2127 delta_members, /* tp_members */
2128 0, /* tp_getset */
2129 0, /* tp_base */
2130 0, /* tp_dict */
2131 0, /* tp_descr_get */
2132 0, /* tp_descr_set */
2133 0, /* tp_dictoffset */
2134 0, /* tp_init */
2135 0, /* tp_alloc */
2136 delta_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002137 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002138};
2139
2140/*
2141 * PyDateTime_Date implementation.
2142 */
2143
2144/* Accessor properties. */
2145
2146static PyObject *
2147date_year(PyDateTime_Date *self, void *unused)
2148{
2149 return PyInt_FromLong(GET_YEAR(self));
2150}
2151
2152static PyObject *
2153date_month(PyDateTime_Date *self, void *unused)
2154{
2155 return PyInt_FromLong(GET_MONTH(self));
2156}
2157
2158static PyObject *
2159date_day(PyDateTime_Date *self, void *unused)
2160{
2161 return PyInt_FromLong(GET_DAY(self));
2162}
2163
2164static PyGetSetDef date_getset[] = {
2165 {"year", (getter)date_year},
2166 {"month", (getter)date_month},
2167 {"day", (getter)date_day},
2168 {NULL}
2169};
2170
2171/* Constructors. */
2172
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002173static char *date_kws[] = {"year", "month", "day", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002174
Tim Peters2a799bf2002-12-16 20:18:38 +00002175static PyObject *
2176date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2177{
2178 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00002179 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00002180 int year;
2181 int month;
2182 int day;
2183
Guido van Rossum177e41a2003-01-30 22:06:23 +00002184 /* Check for invocation from pickle with __getstate__ state */
2185 if (PyTuple_GET_SIZE(args) == 1 &&
Tim Peters70533e22003-02-01 04:40:04 +00002186 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Tim Peters3f606292004-03-21 23:38:41 +00002187 PyString_GET_SIZE(state) == _PyDateTime_DATE_DATASIZE &&
2188 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00002189 {
Tim Peters70533e22003-02-01 04:40:04 +00002190 PyDateTime_Date *me;
2191
Tim Peters604c0132004-06-07 23:04:33 +00002192 me = (PyDateTime_Date *) (type->tp_alloc(type, 0));
Tim Peters70533e22003-02-01 04:40:04 +00002193 if (me != NULL) {
2194 char *pdata = PyString_AS_STRING(state);
2195 memcpy(me->data, pdata, _PyDateTime_DATE_DATASIZE);
2196 me->hashcode = -1;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002197 }
Tim Peters70533e22003-02-01 04:40:04 +00002198 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002199 }
2200
Tim Peters12bf3392002-12-24 05:41:27 +00002201 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00002202 &year, &month, &day)) {
2203 if (check_date_args(year, month, day) < 0)
2204 return NULL;
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002205 self = new_date_ex(year, month, day, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00002206 }
2207 return self;
2208}
2209
2210/* Return new date from localtime(t). */
2211static PyObject *
Tim Peters1b6f7a92004-06-20 02:50:16 +00002212date_local_from_time_t(PyObject *cls, double ts)
Tim Peters2a799bf2002-12-16 20:18:38 +00002213{
2214 struct tm *tm;
Tim Peters1b6f7a92004-06-20 02:50:16 +00002215 time_t t;
Tim Peters2a799bf2002-12-16 20:18:38 +00002216 PyObject *result = NULL;
2217
Tim Peters1b6f7a92004-06-20 02:50:16 +00002218 t = _PyTime_DoubleToTimet(ts);
2219 if (t == (time_t)-1 && PyErr_Occurred())
2220 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002221 tm = localtime(&t);
2222 if (tm)
2223 result = PyObject_CallFunction(cls, "iii",
2224 tm->tm_year + 1900,
2225 tm->tm_mon + 1,
2226 tm->tm_mday);
2227 else
2228 PyErr_SetString(PyExc_ValueError,
2229 "timestamp out of range for "
2230 "platform localtime() function");
2231 return result;
2232}
2233
2234/* Return new date from current time.
2235 * We say this is equivalent to fromtimestamp(time.time()), and the
2236 * only way to be sure of that is to *call* time.time(). That's not
2237 * generally the same as calling C's time.
2238 */
2239static PyObject *
2240date_today(PyObject *cls, PyObject *dummy)
2241{
2242 PyObject *time;
2243 PyObject *result;
2244
2245 time = time_time();
2246 if (time == NULL)
2247 return NULL;
2248
2249 /* Note well: today() is a class method, so this may not call
2250 * date.fromtimestamp. For example, it may call
2251 * datetime.fromtimestamp. That's why we need all the accuracy
2252 * time.time() delivers; if someone were gonzo about optimization,
2253 * date.today() could get away with plain C time().
2254 */
2255 result = PyObject_CallMethod(cls, "fromtimestamp", "O", time);
2256 Py_DECREF(time);
2257 return result;
2258}
2259
2260/* Return new date from given timestamp (Python timestamp -- a double). */
2261static PyObject *
2262date_fromtimestamp(PyObject *cls, PyObject *args)
2263{
2264 double timestamp;
2265 PyObject *result = NULL;
2266
2267 if (PyArg_ParseTuple(args, "d:fromtimestamp", &timestamp))
Tim Peters1b6f7a92004-06-20 02:50:16 +00002268 result = date_local_from_time_t(cls, timestamp);
Tim Peters2a799bf2002-12-16 20:18:38 +00002269 return result;
2270}
2271
2272/* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2273 * the ordinal is out of range.
2274 */
2275static PyObject *
2276date_fromordinal(PyObject *cls, PyObject *args)
2277{
2278 PyObject *result = NULL;
2279 int ordinal;
2280
2281 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2282 int year;
2283 int month;
2284 int day;
2285
2286 if (ordinal < 1)
2287 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2288 ">= 1");
2289 else {
2290 ord_to_ymd(ordinal, &year, &month, &day);
2291 result = PyObject_CallFunction(cls, "iii",
2292 year, month, day);
2293 }
2294 }
2295 return result;
2296}
2297
2298/*
2299 * Date arithmetic.
2300 */
2301
2302/* date + timedelta -> date. If arg negate is true, subtract the timedelta
2303 * instead.
2304 */
2305static PyObject *
2306add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
2307{
2308 PyObject *result = NULL;
2309 int year = GET_YEAR(date);
2310 int month = GET_MONTH(date);
2311 int deltadays = GET_TD_DAYS(delta);
2312 /* C-level overflow is impossible because |deltadays| < 1e9. */
2313 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
2314
2315 if (normalize_date(&year, &month, &day) >= 0)
2316 result = new_date(year, month, day);
2317 return result;
2318}
2319
2320static PyObject *
2321date_add(PyObject *left, PyObject *right)
2322{
2323 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2324 Py_INCREF(Py_NotImplemented);
2325 return Py_NotImplemented;
2326 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002327 if (PyDate_Check(left)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002328 /* date + ??? */
2329 if (PyDelta_Check(right))
2330 /* date + delta */
2331 return add_date_timedelta((PyDateTime_Date *) left,
2332 (PyDateTime_Delta *) right,
2333 0);
2334 }
2335 else {
2336 /* ??? + date
2337 * 'right' must be one of us, or we wouldn't have been called
2338 */
2339 if (PyDelta_Check(left))
2340 /* delta + date */
2341 return add_date_timedelta((PyDateTime_Date *) right,
2342 (PyDateTime_Delta *) left,
2343 0);
2344 }
2345 Py_INCREF(Py_NotImplemented);
2346 return Py_NotImplemented;
2347}
2348
2349static PyObject *
2350date_subtract(PyObject *left, PyObject *right)
2351{
2352 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2353 Py_INCREF(Py_NotImplemented);
2354 return Py_NotImplemented;
2355 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002356 if (PyDate_Check(left)) {
2357 if (PyDate_Check(right)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002358 /* date - date */
2359 int left_ord = ymd_to_ord(GET_YEAR(left),
2360 GET_MONTH(left),
2361 GET_DAY(left));
2362 int right_ord = ymd_to_ord(GET_YEAR(right),
2363 GET_MONTH(right),
2364 GET_DAY(right));
2365 return new_delta(left_ord - right_ord, 0, 0, 0);
2366 }
2367 if (PyDelta_Check(right)) {
2368 /* date - delta */
2369 return add_date_timedelta((PyDateTime_Date *) left,
2370 (PyDateTime_Delta *) right,
2371 1);
2372 }
2373 }
2374 Py_INCREF(Py_NotImplemented);
2375 return Py_NotImplemented;
2376}
2377
2378
2379/* Various ways to turn a date into a string. */
2380
2381static PyObject *
2382date_repr(PyDateTime_Date *self)
2383{
Walter Dörwald7569dfe2007-05-19 21:49:49 +00002384 return PyUnicode_FromFormat("%s(%d, %d, %d)",
2385 self->ob_type->tp_name,
2386 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002387}
2388
2389static PyObject *
2390date_isoformat(PyDateTime_Date *self)
2391{
Walter Dörwaldbafa1372007-05-31 17:50:48 +00002392 return PyUnicode_FromFormat("%04d-%02d-%02d",
2393 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002394}
2395
Tim Peterse2df5ff2003-05-02 18:39:55 +00002396/* str() calls the appropriate isoformat() method. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002397static PyObject *
2398date_str(PyDateTime_Date *self)
2399{
2400 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
2401}
2402
2403
2404static PyObject *
2405date_ctime(PyDateTime_Date *self)
2406{
2407 return format_ctime(self, 0, 0, 0);
2408}
2409
2410static PyObject *
2411date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2412{
2413 /* This method can be inherited, and needs to call the
2414 * timetuple() method appropriate to self's class.
2415 */
2416 PyObject *result;
2417 PyObject *format;
2418 PyObject *tuple;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002419 static char *keywords[] = {"format", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00002420
Guido van Rossumbce56a62007-05-10 18:04:33 +00002421 if (! PyArg_ParseTupleAndKeywords(args, kw, "S:strftime", keywords,
2422 &format))
Tim Peters2a799bf2002-12-16 20:18:38 +00002423 return NULL;
2424
2425 tuple = PyObject_CallMethod((PyObject *)self, "timetuple", "()");
2426 if (tuple == NULL)
2427 return NULL;
Tim Petersbad8ff02002-12-30 20:52:32 +00002428 result = wrap_strftime((PyObject *)self, format, tuple,
2429 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002430 Py_DECREF(tuple);
2431 return result;
2432}
2433
2434/* ISO methods. */
2435
2436static PyObject *
2437date_isoweekday(PyDateTime_Date *self)
2438{
2439 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2440
2441 return PyInt_FromLong(dow + 1);
2442}
2443
2444static PyObject *
2445date_isocalendar(PyDateTime_Date *self)
2446{
2447 int year = GET_YEAR(self);
2448 int week1_monday = iso_week1_monday(year);
2449 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
2450 int week;
2451 int day;
2452
2453 week = divmod(today - week1_monday, 7, &day);
2454 if (week < 0) {
2455 --year;
2456 week1_monday = iso_week1_monday(year);
2457 week = divmod(today - week1_monday, 7, &day);
2458 }
2459 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
2460 ++year;
2461 week = 0;
2462 }
2463 return Py_BuildValue("iii", year, week + 1, day + 1);
2464}
2465
2466/* Miscellaneous methods. */
2467
Tim Peters2a799bf2002-12-16 20:18:38 +00002468static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00002469date_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters2a799bf2002-12-16 20:18:38 +00002470{
Guido van Rossum19960592006-08-24 17:29:38 +00002471 if (PyDate_Check(other)) {
2472 int diff = memcmp(((PyDateTime_Date *)self)->data,
2473 ((PyDateTime_Date *)other)->data,
2474 _PyDateTime_DATE_DATASIZE);
2475 return diff_to_bool(diff, op);
2476 }
2477 else {
Tim Peters07534a62003-02-07 22:50:28 +00002478 Py_INCREF(Py_NotImplemented);
2479 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002480 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002481}
2482
2483static PyObject *
2484date_timetuple(PyDateTime_Date *self)
2485{
2486 return build_struct_time(GET_YEAR(self),
2487 GET_MONTH(self),
2488 GET_DAY(self),
2489 0, 0, 0, -1);
2490}
2491
Tim Peters12bf3392002-12-24 05:41:27 +00002492static PyObject *
2493date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2494{
2495 PyObject *clone;
2496 PyObject *tuple;
2497 int year = GET_YEAR(self);
2498 int month = GET_MONTH(self);
2499 int day = GET_DAY(self);
2500
2501 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
2502 &year, &month, &day))
2503 return NULL;
2504 tuple = Py_BuildValue("iii", year, month, day);
2505 if (tuple == NULL)
2506 return NULL;
2507 clone = date_new(self->ob_type, tuple, NULL);
2508 Py_DECREF(tuple);
2509 return clone;
2510}
2511
Tim Peters2a799bf2002-12-16 20:18:38 +00002512static PyObject *date_getstate(PyDateTime_Date *self);
2513
2514static long
2515date_hash(PyDateTime_Date *self)
2516{
2517 if (self->hashcode == -1) {
2518 PyObject *temp = date_getstate(self);
2519 if (temp != NULL) {
2520 self->hashcode = PyObject_Hash(temp);
2521 Py_DECREF(temp);
2522 }
2523 }
2524 return self->hashcode;
2525}
2526
2527static PyObject *
2528date_toordinal(PyDateTime_Date *self)
2529{
2530 return PyInt_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
2531 GET_DAY(self)));
2532}
2533
2534static PyObject *
2535date_weekday(PyDateTime_Date *self)
2536{
2537 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2538
2539 return PyInt_FromLong(dow);
2540}
2541
Tim Peters371935f2003-02-01 01:52:50 +00002542/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002543
Tim Petersb57f8f02003-02-01 02:54:15 +00002544/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002545static PyObject *
2546date_getstate(PyDateTime_Date *self)
2547{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002548 return Py_BuildValue(
2549 "(N)",
2550 PyString_FromStringAndSize((char *)self->data,
2551 _PyDateTime_DATE_DATASIZE));
Tim Peters2a799bf2002-12-16 20:18:38 +00002552}
2553
2554static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00002555date_reduce(PyDateTime_Date *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00002556{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002557 return Py_BuildValue("(ON)", self->ob_type, date_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002558}
2559
2560static PyMethodDef date_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002561
Tim Peters2a799bf2002-12-16 20:18:38 +00002562 /* Class methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00002563
Tim Peters2a799bf2002-12-16 20:18:38 +00002564 {"fromtimestamp", (PyCFunction)date_fromtimestamp, METH_VARARGS |
2565 METH_CLASS,
2566 PyDoc_STR("timestamp -> local date from a POSIX timestamp (like "
2567 "time.time()).")},
2568
2569 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
2570 METH_CLASS,
2571 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
2572 "ordinal.")},
2573
2574 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
2575 PyDoc_STR("Current date or datetime: same as "
2576 "self.__class__.fromtimestamp(time.time()).")},
2577
2578 /* Instance methods: */
2579
2580 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
2581 PyDoc_STR("Return ctime() style string.")},
2582
Guido van Rossumd59da4b2007-05-22 18:11:13 +00002583 {"strftime", (PyCFunction)date_strftime, METH_VARARGS | METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00002584 PyDoc_STR("format -> strftime() style string.")},
2585
2586 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
2587 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
2588
2589 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
2590 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
2591 "weekday.")},
2592
2593 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
2594 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
2595
2596 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
2597 PyDoc_STR("Return the day of the week represented by the date.\n"
2598 "Monday == 1 ... Sunday == 7")},
2599
2600 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
2601 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
2602 "1 is day 1.")},
2603
2604 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
2605 PyDoc_STR("Return the day of the week represented by the date.\n"
2606 "Monday == 0 ... Sunday == 6")},
2607
Guido van Rossumd59da4b2007-05-22 18:11:13 +00002608 {"replace", (PyCFunction)date_replace, METH_VARARGS | METH_KEYWORDS,
Tim Peters12bf3392002-12-24 05:41:27 +00002609 PyDoc_STR("Return date with new specified fields.")},
2610
Guido van Rossum177e41a2003-01-30 22:06:23 +00002611 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
2612 PyDoc_STR("__reduce__() -> (cls, state)")},
2613
Tim Peters2a799bf2002-12-16 20:18:38 +00002614 {NULL, NULL}
2615};
2616
2617static char date_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00002618PyDoc_STR("date(year, month, day) --> date object");
Tim Peters2a799bf2002-12-16 20:18:38 +00002619
2620static PyNumberMethods date_as_number = {
2621 date_add, /* nb_add */
2622 date_subtract, /* nb_subtract */
2623 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00002624 0, /* nb_remainder */
2625 0, /* nb_divmod */
2626 0, /* nb_power */
2627 0, /* nb_negative */
2628 0, /* nb_positive */
2629 0, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +00002630 0, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00002631};
2632
2633static PyTypeObject PyDateTime_DateType = {
2634 PyObject_HEAD_INIT(NULL)
2635 0, /* ob_size */
2636 "datetime.date", /* tp_name */
2637 sizeof(PyDateTime_Date), /* tp_basicsize */
2638 0, /* tp_itemsize */
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002639 0, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00002640 0, /* tp_print */
2641 0, /* tp_getattr */
2642 0, /* tp_setattr */
2643 0, /* tp_compare */
2644 (reprfunc)date_repr, /* tp_repr */
2645 &date_as_number, /* tp_as_number */
2646 0, /* tp_as_sequence */
2647 0, /* tp_as_mapping */
2648 (hashfunc)date_hash, /* tp_hash */
2649 0, /* tp_call */
2650 (reprfunc)date_str, /* tp_str */
2651 PyObject_GenericGetAttr, /* tp_getattro */
2652 0, /* tp_setattro */
2653 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002654 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00002655 date_doc, /* tp_doc */
2656 0, /* tp_traverse */
2657 0, /* tp_clear */
Guido van Rossum19960592006-08-24 17:29:38 +00002658 date_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00002659 0, /* tp_weaklistoffset */
2660 0, /* tp_iter */
2661 0, /* tp_iternext */
2662 date_methods, /* tp_methods */
2663 0, /* tp_members */
2664 date_getset, /* tp_getset */
2665 0, /* tp_base */
2666 0, /* tp_dict */
2667 0, /* tp_descr_get */
2668 0, /* tp_descr_set */
2669 0, /* tp_dictoffset */
2670 0, /* tp_init */
2671 0, /* tp_alloc */
2672 date_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002673 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002674};
2675
2676/*
Tim Peters2a799bf2002-12-16 20:18:38 +00002677 * PyDateTime_TZInfo implementation.
2678 */
2679
2680/* This is a pure abstract base class, so doesn't do anything beyond
2681 * raising NotImplemented exceptions. Real tzinfo classes need
2682 * to derive from this. This is mostly for clarity, and for efficiency in
Tim Petersa9bc1682003-01-11 03:39:11 +00002683 * datetime and time constructors (their tzinfo arguments need to
Tim Peters2a799bf2002-12-16 20:18:38 +00002684 * be subclasses of this tzinfo class, which is easy and quick to check).
2685 *
2686 * Note: For reasons having to do with pickling of subclasses, we have
2687 * to allow tzinfo objects to be instantiated. This wasn't an issue
2688 * in the Python implementation (__init__() could raise NotImplementedError
2689 * there without ill effect), but doing so in the C implementation hit a
2690 * brick wall.
2691 */
2692
2693static PyObject *
2694tzinfo_nogo(const char* methodname)
2695{
2696 PyErr_Format(PyExc_NotImplementedError,
2697 "a tzinfo subclass must implement %s()",
2698 methodname);
2699 return NULL;
2700}
2701
2702/* Methods. A subclass must implement these. */
2703
Tim Peters52dcce22003-01-23 16:36:11 +00002704static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002705tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
2706{
2707 return tzinfo_nogo("tzname");
2708}
2709
Tim Peters52dcce22003-01-23 16:36:11 +00002710static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002711tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
2712{
2713 return tzinfo_nogo("utcoffset");
2714}
2715
Tim Peters52dcce22003-01-23 16:36:11 +00002716static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002717tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
2718{
2719 return tzinfo_nogo("dst");
2720}
2721
Tim Peters52dcce22003-01-23 16:36:11 +00002722static PyObject *
2723tzinfo_fromutc(PyDateTime_TZInfo *self, PyDateTime_DateTime *dt)
2724{
2725 int y, m, d, hh, mm, ss, us;
2726
2727 PyObject *result;
2728 int off, dst;
2729 int none;
2730 int delta;
2731
2732 if (! PyDateTime_Check(dt)) {
2733 PyErr_SetString(PyExc_TypeError,
2734 "fromutc: argument must be a datetime");
2735 return NULL;
2736 }
2737 if (! HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
2738 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
2739 "is not self");
2740 return NULL;
2741 }
2742
2743 off = call_utcoffset(dt->tzinfo, (PyObject *)dt, &none);
2744 if (off == -1 && PyErr_Occurred())
2745 return NULL;
2746 if (none) {
2747 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2748 "utcoffset() result required");
2749 return NULL;
2750 }
2751
2752 dst = call_dst(dt->tzinfo, (PyObject *)dt, &none);
2753 if (dst == -1 && PyErr_Occurred())
2754 return NULL;
2755 if (none) {
2756 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2757 "dst() result required");
2758 return NULL;
2759 }
2760
2761 y = GET_YEAR(dt);
2762 m = GET_MONTH(dt);
2763 d = GET_DAY(dt);
2764 hh = DATE_GET_HOUR(dt);
2765 mm = DATE_GET_MINUTE(dt);
2766 ss = DATE_GET_SECOND(dt);
2767 us = DATE_GET_MICROSECOND(dt);
2768
2769 delta = off - dst;
2770 mm += delta;
2771 if ((mm < 0 || mm >= 60) &&
2772 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Petersb1049e82003-01-23 17:20:36 +00002773 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00002774 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2775 if (result == NULL)
2776 return result;
2777
2778 dst = call_dst(dt->tzinfo, result, &none);
2779 if (dst == -1 && PyErr_Occurred())
2780 goto Fail;
2781 if (none)
2782 goto Inconsistent;
2783 if (dst == 0)
2784 return result;
2785
2786 mm += dst;
2787 if ((mm < 0 || mm >= 60) &&
2788 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
2789 goto Fail;
2790 Py_DECREF(result);
2791 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2792 return result;
2793
2794Inconsistent:
2795 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave"
2796 "inconsistent results; cannot convert");
2797
2798 /* fall thru to failure */
2799Fail:
2800 Py_DECREF(result);
2801 return NULL;
2802}
2803
Tim Peters2a799bf2002-12-16 20:18:38 +00002804/*
2805 * Pickle support. This is solely so that tzinfo subclasses can use
Guido van Rossum177e41a2003-01-30 22:06:23 +00002806 * pickling -- tzinfo itself is supposed to be uninstantiable.
Tim Peters2a799bf2002-12-16 20:18:38 +00002807 */
2808
Guido van Rossum177e41a2003-01-30 22:06:23 +00002809static PyObject *
2810tzinfo_reduce(PyObject *self)
2811{
2812 PyObject *args, *state, *tmp;
2813 PyObject *getinitargs, *getstate;
Tim Peters2a799bf2002-12-16 20:18:38 +00002814
Guido van Rossum177e41a2003-01-30 22:06:23 +00002815 tmp = PyTuple_New(0);
2816 if (tmp == NULL)
2817 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002818
Guido van Rossum177e41a2003-01-30 22:06:23 +00002819 getinitargs = PyObject_GetAttrString(self, "__getinitargs__");
2820 if (getinitargs != NULL) {
2821 args = PyObject_CallObject(getinitargs, tmp);
2822 Py_DECREF(getinitargs);
2823 if (args == NULL) {
2824 Py_DECREF(tmp);
2825 return NULL;
2826 }
2827 }
2828 else {
2829 PyErr_Clear();
2830 args = tmp;
2831 Py_INCREF(args);
2832 }
2833
2834 getstate = PyObject_GetAttrString(self, "__getstate__");
2835 if (getstate != NULL) {
2836 state = PyObject_CallObject(getstate, tmp);
2837 Py_DECREF(getstate);
2838 if (state == NULL) {
2839 Py_DECREF(args);
2840 Py_DECREF(tmp);
2841 return NULL;
2842 }
2843 }
2844 else {
2845 PyObject **dictptr;
2846 PyErr_Clear();
2847 state = Py_None;
2848 dictptr = _PyObject_GetDictPtr(self);
2849 if (dictptr && *dictptr && PyDict_Size(*dictptr))
2850 state = *dictptr;
2851 Py_INCREF(state);
2852 }
2853
2854 Py_DECREF(tmp);
2855
2856 if (state == Py_None) {
2857 Py_DECREF(state);
2858 return Py_BuildValue("(ON)", self->ob_type, args);
2859 }
2860 else
2861 return Py_BuildValue("(ONN)", self->ob_type, args, state);
2862}
Tim Peters2a799bf2002-12-16 20:18:38 +00002863
2864static PyMethodDef tzinfo_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002865
Tim Peters2a799bf2002-12-16 20:18:38 +00002866 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
2867 PyDoc_STR("datetime -> string name of time zone.")},
2868
2869 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
2870 PyDoc_STR("datetime -> minutes east of UTC (negative for "
2871 "west of UTC).")},
2872
2873 {"dst", (PyCFunction)tzinfo_dst, METH_O,
2874 PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
2875
Tim Peters52dcce22003-01-23 16:36:11 +00002876 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
2877 PyDoc_STR("datetime in UTC -> datetime in local time.")},
2878
Guido van Rossum177e41a2003-01-30 22:06:23 +00002879 {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
2880 PyDoc_STR("-> (cls, state)")},
2881
Tim Peters2a799bf2002-12-16 20:18:38 +00002882 {NULL, NULL}
2883};
2884
2885static char tzinfo_doc[] =
2886PyDoc_STR("Abstract base class for time zone info objects.");
2887
Neal Norwitz227b5332006-03-22 09:28:35 +00002888static PyTypeObject PyDateTime_TZInfoType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00002889 PyObject_HEAD_INIT(NULL)
2890 0, /* ob_size */
2891 "datetime.tzinfo", /* tp_name */
2892 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
2893 0, /* tp_itemsize */
2894 0, /* tp_dealloc */
2895 0, /* tp_print */
2896 0, /* tp_getattr */
2897 0, /* tp_setattr */
2898 0, /* tp_compare */
2899 0, /* tp_repr */
2900 0, /* tp_as_number */
2901 0, /* tp_as_sequence */
2902 0, /* tp_as_mapping */
2903 0, /* tp_hash */
2904 0, /* tp_call */
2905 0, /* tp_str */
2906 PyObject_GenericGetAttr, /* tp_getattro */
2907 0, /* tp_setattro */
2908 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002909 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00002910 tzinfo_doc, /* tp_doc */
2911 0, /* tp_traverse */
2912 0, /* tp_clear */
2913 0, /* tp_richcompare */
2914 0, /* tp_weaklistoffset */
2915 0, /* tp_iter */
2916 0, /* tp_iternext */
2917 tzinfo_methods, /* tp_methods */
2918 0, /* tp_members */
2919 0, /* tp_getset */
2920 0, /* tp_base */
2921 0, /* tp_dict */
2922 0, /* tp_descr_get */
2923 0, /* tp_descr_set */
2924 0, /* tp_dictoffset */
2925 0, /* tp_init */
2926 0, /* tp_alloc */
2927 PyType_GenericNew, /* tp_new */
2928 0, /* tp_free */
2929};
2930
2931/*
Tim Peters37f39822003-01-10 03:49:02 +00002932 * PyDateTime_Time implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00002933 */
2934
Tim Peters37f39822003-01-10 03:49:02 +00002935/* Accessor properties.
Tim Peters2a799bf2002-12-16 20:18:38 +00002936 */
2937
2938static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00002939time_hour(PyDateTime_Time *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00002940{
Tim Peters37f39822003-01-10 03:49:02 +00002941 return PyInt_FromLong(TIME_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002942}
2943
Tim Peters37f39822003-01-10 03:49:02 +00002944static PyObject *
2945time_minute(PyDateTime_Time *self, void *unused)
2946{
2947 return PyInt_FromLong(TIME_GET_MINUTE(self));
2948}
2949
2950/* The name time_second conflicted with some platform header file. */
2951static PyObject *
2952py_time_second(PyDateTime_Time *self, void *unused)
2953{
2954 return PyInt_FromLong(TIME_GET_SECOND(self));
2955}
2956
2957static PyObject *
2958time_microsecond(PyDateTime_Time *self, void *unused)
2959{
2960 return PyInt_FromLong(TIME_GET_MICROSECOND(self));
2961}
2962
2963static PyObject *
2964time_tzinfo(PyDateTime_Time *self, void *unused)
2965{
Tim Petersa032d2e2003-01-11 00:15:54 +00002966 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters37f39822003-01-10 03:49:02 +00002967 Py_INCREF(result);
2968 return result;
2969}
2970
2971static PyGetSetDef time_getset[] = {
2972 {"hour", (getter)time_hour},
2973 {"minute", (getter)time_minute},
2974 {"second", (getter)py_time_second},
2975 {"microsecond", (getter)time_microsecond},
2976 {"tzinfo", (getter)time_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00002977 {NULL}
2978};
2979
2980/*
2981 * Constructors.
2982 */
2983
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002984static char *time_kws[] = {"hour", "minute", "second", "microsecond",
Tim Peters37f39822003-01-10 03:49:02 +00002985 "tzinfo", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002986
Tim Peters2a799bf2002-12-16 20:18:38 +00002987static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00002988time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00002989{
2990 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00002991 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00002992 int hour = 0;
2993 int minute = 0;
2994 int second = 0;
2995 int usecond = 0;
2996 PyObject *tzinfo = Py_None;
2997
Guido van Rossum177e41a2003-01-30 22:06:23 +00002998 /* Check for invocation from pickle with __getstate__ state */
2999 if (PyTuple_GET_SIZE(args) >= 1 &&
3000 PyTuple_GET_SIZE(args) <= 2 &&
Tim Peters70533e22003-02-01 04:40:04 +00003001 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Armin Rigof4afb212005-11-07 07:15:48 +00003002 PyString_GET_SIZE(state) == _PyDateTime_TIME_DATASIZE &&
3003 ((unsigned char) (PyString_AS_STRING(state)[0])) < 24)
Guido van Rossum177e41a2003-01-30 22:06:23 +00003004 {
Tim Peters70533e22003-02-01 04:40:04 +00003005 PyDateTime_Time *me;
3006 char aware;
3007
3008 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003009 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003010 if (check_tzinfo_subclass(tzinfo) < 0) {
3011 PyErr_SetString(PyExc_TypeError, "bad "
3012 "tzinfo state arg");
3013 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003014 }
3015 }
Tim Peters70533e22003-02-01 04:40:04 +00003016 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003017 me = (PyDateTime_Time *) (type->tp_alloc(type, aware));
Tim Peters70533e22003-02-01 04:40:04 +00003018 if (me != NULL) {
3019 char *pdata = PyString_AS_STRING(state);
3020
3021 memcpy(me->data, pdata, _PyDateTime_TIME_DATASIZE);
3022 me->hashcode = -1;
3023 me->hastzinfo = aware;
3024 if (aware) {
3025 Py_INCREF(tzinfo);
3026 me->tzinfo = tzinfo;
3027 }
3028 }
3029 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003030 }
3031
Tim Peters37f39822003-01-10 03:49:02 +00003032 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO", time_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003033 &hour, &minute, &second, &usecond,
3034 &tzinfo)) {
3035 if (check_time_args(hour, minute, second, usecond) < 0)
3036 return NULL;
3037 if (check_tzinfo_subclass(tzinfo) < 0)
3038 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003039 self = new_time_ex(hour, minute, second, usecond, tzinfo,
3040 type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003041 }
3042 return self;
3043}
3044
3045/*
3046 * Destructor.
3047 */
3048
3049static void
Tim Peters37f39822003-01-10 03:49:02 +00003050time_dealloc(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003051{
Tim Petersa032d2e2003-01-11 00:15:54 +00003052 if (HASTZINFO(self)) {
Tim Peters37f39822003-01-10 03:49:02 +00003053 Py_XDECREF(self->tzinfo);
Neal Norwitz8e914d92003-01-10 15:29:16 +00003054 }
Tim Peters2a799bf2002-12-16 20:18:38 +00003055 self->ob_type->tp_free((PyObject *)self);
3056}
3057
3058/*
Tim Peters855fe882002-12-22 03:43:39 +00003059 * Indirect access to tzinfo methods.
Tim Peters2a799bf2002-12-16 20:18:38 +00003060 */
3061
Tim Peters2a799bf2002-12-16 20:18:38 +00003062/* These are all METH_NOARGS, so don't need to check the arglist. */
3063static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003064time_utcoffset(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003065 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003066 "utcoffset", Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003067}
3068
3069static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003070time_dst(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003071 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003072 "dst", Py_None);
Tim Peters855fe882002-12-22 03:43:39 +00003073}
3074
3075static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003076time_tzname(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003077 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003078 Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003079}
3080
3081/*
Tim Peters37f39822003-01-10 03:49:02 +00003082 * Various ways to turn a time into a string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003083 */
3084
3085static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003086time_repr(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003087{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003088 const char *type_name = self->ob_type->tp_name;
Tim Peters37f39822003-01-10 03:49:02 +00003089 int h = TIME_GET_HOUR(self);
3090 int m = TIME_GET_MINUTE(self);
3091 int s = TIME_GET_SECOND(self);
3092 int us = TIME_GET_MICROSECOND(self);
3093 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003094
Tim Peters37f39822003-01-10 03:49:02 +00003095 if (us)
Walter Dörwald7569dfe2007-05-19 21:49:49 +00003096 result = PyUnicode_FromFormat("%s(%d, %d, %d, %d)",
3097 type_name, h, m, s, us);
Tim Peters37f39822003-01-10 03:49:02 +00003098 else if (s)
Walter Dörwald7569dfe2007-05-19 21:49:49 +00003099 result = PyUnicode_FromFormat("%s(%d, %d, %d)",
3100 type_name, h, m, s);
Tim Peters37f39822003-01-10 03:49:02 +00003101 else
Walter Dörwald7569dfe2007-05-19 21:49:49 +00003102 result = PyUnicode_FromFormat("%s(%d, %d)", type_name, h, m);
Tim Petersa032d2e2003-01-11 00:15:54 +00003103 if (result != NULL && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +00003104 result = append_keyword_tzinfo(result, self->tzinfo);
3105 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003106}
3107
Tim Peters37f39822003-01-10 03:49:02 +00003108static PyObject *
3109time_str(PyDateTime_Time *self)
3110{
3111 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
3112}
Tim Peters2a799bf2002-12-16 20:18:38 +00003113
3114static PyObject *
Thomas Wouterscf297e42007-02-23 15:07:44 +00003115time_isoformat(PyDateTime_Time *self, PyObject *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003116{
3117 char buf[100];
Tim Peters37f39822003-01-10 03:49:02 +00003118 PyObject *result;
Walter Dörwaldbafa1372007-05-31 17:50:48 +00003119 int us = TIME_GET_MICROSECOND(self);;
Tim Peters2a799bf2002-12-16 20:18:38 +00003120
Walter Dörwaldbafa1372007-05-31 17:50:48 +00003121 if (us)
3122 result = PyUnicode_FromFormat("%02d:%02d:%02d.%06d",
3123 TIME_GET_HOUR(self),
3124 TIME_GET_MINUTE(self),
3125 TIME_GET_SECOND(self),
3126 us);
3127 else
3128 result = PyUnicode_FromFormat("%02d:%02d:%02d",
3129 TIME_GET_HOUR(self),
3130 TIME_GET_MINUTE(self),
3131 TIME_GET_SECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003132
Tim Petersa032d2e2003-01-11 00:15:54 +00003133 if (result == NULL || ! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00003134 return result;
3135
3136 /* We need to append the UTC offset. */
3137 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00003138 Py_None) < 0) {
Tim Peters2a799bf2002-12-16 20:18:38 +00003139 Py_DECREF(result);
3140 return NULL;
3141 }
Walter Dörwaldbafa1372007-05-31 17:50:48 +00003142 PyUnicode_AppendAndDel(&result, PyUnicode_FromString(buf));
Tim Peters2a799bf2002-12-16 20:18:38 +00003143 return result;
3144}
3145
Tim Peters37f39822003-01-10 03:49:02 +00003146static PyObject *
3147time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3148{
3149 PyObject *result;
3150 PyObject *format;
3151 PyObject *tuple;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003152 static char *keywords[] = {"format", NULL};
Tim Peters37f39822003-01-10 03:49:02 +00003153
Guido van Rossumbce56a62007-05-10 18:04:33 +00003154 if (! PyArg_ParseTupleAndKeywords(args, kw, "S:strftime", keywords,
3155 &format))
Tim Peters37f39822003-01-10 03:49:02 +00003156 return NULL;
3157
3158 /* Python's strftime does insane things with the year part of the
3159 * timetuple. The year is forced to (the otherwise nonsensical)
3160 * 1900 to worm around that.
3161 */
3162 tuple = Py_BuildValue("iiiiiiiii",
Brett Cannond1080a32004-03-02 04:38:10 +00003163 1900, 1, 1, /* year, month, day */
Tim Peters37f39822003-01-10 03:49:02 +00003164 TIME_GET_HOUR(self),
3165 TIME_GET_MINUTE(self),
3166 TIME_GET_SECOND(self),
Brett Cannond1080a32004-03-02 04:38:10 +00003167 0, 1, -1); /* weekday, daynum, dst */
Tim Peters37f39822003-01-10 03:49:02 +00003168 if (tuple == NULL)
3169 return NULL;
3170 assert(PyTuple_Size(tuple) == 9);
3171 result = wrap_strftime((PyObject *)self, format, tuple, Py_None);
3172 Py_DECREF(tuple);
3173 return result;
3174}
Tim Peters2a799bf2002-12-16 20:18:38 +00003175
3176/*
3177 * Miscellaneous methods.
3178 */
3179
Tim Peters37f39822003-01-10 03:49:02 +00003180static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00003181time_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters37f39822003-01-10 03:49:02 +00003182{
3183 int diff;
3184 naivety n1, n2;
3185 int offset1, offset2;
3186
3187 if (! PyTime_Check(other)) {
Guido van Rossum19960592006-08-24 17:29:38 +00003188 Py_INCREF(Py_NotImplemented);
3189 return Py_NotImplemented;
Tim Peters37f39822003-01-10 03:49:02 +00003190 }
Guido van Rossum19960592006-08-24 17:29:38 +00003191 if (classify_two_utcoffsets(self, &offset1, &n1, Py_None,
3192 other, &offset2, &n2, Py_None) < 0)
Tim Peters37f39822003-01-10 03:49:02 +00003193 return NULL;
3194 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
3195 /* If they're both naive, or both aware and have the same offsets,
3196 * we get off cheap. Note that if they're both naive, offset1 ==
3197 * offset2 == 0 at this point.
3198 */
3199 if (n1 == n2 && offset1 == offset2) {
Guido van Rossum19960592006-08-24 17:29:38 +00003200 diff = memcmp(((PyDateTime_Time *)self)->data,
3201 ((PyDateTime_Time *)other)->data,
Tim Peters37f39822003-01-10 03:49:02 +00003202 _PyDateTime_TIME_DATASIZE);
3203 return diff_to_bool(diff, op);
3204 }
3205
3206 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
3207 assert(offset1 != offset2); /* else last "if" handled it */
3208 /* Convert everything except microseconds to seconds. These
3209 * can't overflow (no more than the # of seconds in 2 days).
3210 */
3211 offset1 = TIME_GET_HOUR(self) * 3600 +
3212 (TIME_GET_MINUTE(self) - offset1) * 60 +
3213 TIME_GET_SECOND(self);
3214 offset2 = TIME_GET_HOUR(other) * 3600 +
3215 (TIME_GET_MINUTE(other) - offset2) * 60 +
3216 TIME_GET_SECOND(other);
3217 diff = offset1 - offset2;
3218 if (diff == 0)
3219 diff = TIME_GET_MICROSECOND(self) -
3220 TIME_GET_MICROSECOND(other);
3221 return diff_to_bool(diff, op);
3222 }
3223
3224 assert(n1 != n2);
3225 PyErr_SetString(PyExc_TypeError,
3226 "can't compare offset-naive and "
3227 "offset-aware times");
3228 return NULL;
3229}
3230
3231static long
3232time_hash(PyDateTime_Time *self)
3233{
3234 if (self->hashcode == -1) {
3235 naivety n;
3236 int offset;
3237 PyObject *temp;
3238
3239 n = classify_utcoffset((PyObject *)self, Py_None, &offset);
3240 assert(n != OFFSET_UNKNOWN);
3241 if (n == OFFSET_ERROR)
3242 return -1;
3243
3244 /* Reduce this to a hash of another object. */
3245 if (offset == 0)
3246 temp = PyString_FromStringAndSize((char *)self->data,
3247 _PyDateTime_TIME_DATASIZE);
3248 else {
3249 int hour;
3250 int minute;
3251
3252 assert(n == OFFSET_AWARE);
Tim Petersa032d2e2003-01-11 00:15:54 +00003253 assert(HASTZINFO(self));
Tim Peters37f39822003-01-10 03:49:02 +00003254 hour = divmod(TIME_GET_HOUR(self) * 60 +
3255 TIME_GET_MINUTE(self) - offset,
3256 60,
3257 &minute);
3258 if (0 <= hour && hour < 24)
3259 temp = new_time(hour, minute,
3260 TIME_GET_SECOND(self),
3261 TIME_GET_MICROSECOND(self),
3262 Py_None);
3263 else
3264 temp = Py_BuildValue("iiii",
3265 hour, minute,
3266 TIME_GET_SECOND(self),
3267 TIME_GET_MICROSECOND(self));
3268 }
3269 if (temp != NULL) {
3270 self->hashcode = PyObject_Hash(temp);
3271 Py_DECREF(temp);
3272 }
3273 }
3274 return self->hashcode;
3275}
Tim Peters2a799bf2002-12-16 20:18:38 +00003276
Tim Peters12bf3392002-12-24 05:41:27 +00003277static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003278time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00003279{
3280 PyObject *clone;
3281 PyObject *tuple;
3282 int hh = TIME_GET_HOUR(self);
3283 int mm = TIME_GET_MINUTE(self);
3284 int ss = TIME_GET_SECOND(self);
3285 int us = TIME_GET_MICROSECOND(self);
Tim Petersa032d2e2003-01-11 00:15:54 +00003286 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00003287
3288 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO:replace",
Tim Peters37f39822003-01-10 03:49:02 +00003289 time_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00003290 &hh, &mm, &ss, &us, &tzinfo))
3291 return NULL;
3292 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
3293 if (tuple == NULL)
3294 return NULL;
Tim Peters37f39822003-01-10 03:49:02 +00003295 clone = time_new(self->ob_type, tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00003296 Py_DECREF(tuple);
3297 return clone;
3298}
3299
Tim Peters2a799bf2002-12-16 20:18:38 +00003300static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00003301time_bool(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003302{
3303 int offset;
3304 int none;
3305
3306 if (TIME_GET_SECOND(self) || TIME_GET_MICROSECOND(self)) {
3307 /* Since utcoffset is in whole minutes, nothing can
3308 * alter the conclusion that this is nonzero.
3309 */
3310 return 1;
3311 }
3312 offset = 0;
Tim Petersa032d2e2003-01-11 00:15:54 +00003313 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Petersbad8ff02002-12-30 20:52:32 +00003314 offset = call_utcoffset(self->tzinfo, Py_None, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00003315 if (offset == -1 && PyErr_Occurred())
3316 return -1;
3317 }
3318 return (TIME_GET_MINUTE(self) - offset + TIME_GET_HOUR(self)*60) != 0;
3319}
3320
Tim Peters371935f2003-02-01 01:52:50 +00003321/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003322
Tim Peters33e0f382003-01-10 02:05:14 +00003323/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003324 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
3325 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00003326 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00003327 */
3328static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003329time_getstate(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003330{
3331 PyObject *basestate;
3332 PyObject *result = NULL;
3333
Tim Peters33e0f382003-01-10 02:05:14 +00003334 basestate = PyString_FromStringAndSize((char *)self->data,
3335 _PyDateTime_TIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00003336 if (basestate != NULL) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003337 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003338 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00003339 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003340 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00003341 Py_DECREF(basestate);
3342 }
3343 return result;
3344}
3345
3346static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00003347time_reduce(PyDateTime_Time *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00003348{
Guido van Rossum177e41a2003-01-30 22:06:23 +00003349 return Py_BuildValue("(ON)", self->ob_type, time_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003350}
3351
Tim Peters37f39822003-01-10 03:49:02 +00003352static PyMethodDef time_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003353
Thomas Wouterscf297e42007-02-23 15:07:44 +00003354 {"isoformat", (PyCFunction)time_isoformat, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003355 PyDoc_STR("Return string in ISO 8601 format, HH:MM:SS[.mmmmmm]"
3356 "[+HH:MM].")},
3357
Guido van Rossumd59da4b2007-05-22 18:11:13 +00003358 {"strftime", (PyCFunction)time_strftime, METH_VARARGS | METH_KEYWORDS,
Tim Peters37f39822003-01-10 03:49:02 +00003359 PyDoc_STR("format -> strftime() style string.")},
3360
3361 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003362 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
3363
Tim Peters37f39822003-01-10 03:49:02 +00003364 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003365 PyDoc_STR("Return self.tzinfo.tzname(self).")},
3366
Tim Peters37f39822003-01-10 03:49:02 +00003367 {"dst", (PyCFunction)time_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003368 PyDoc_STR("Return self.tzinfo.dst(self).")},
3369
Guido van Rossumd59da4b2007-05-22 18:11:13 +00003370 {"replace", (PyCFunction)time_replace, METH_VARARGS | METH_KEYWORDS,
Tim Peters37f39822003-01-10 03:49:02 +00003371 PyDoc_STR("Return time with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00003372
Guido van Rossum177e41a2003-01-30 22:06:23 +00003373 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
3374 PyDoc_STR("__reduce__() -> (cls, state)")},
3375
Tim Peters2a799bf2002-12-16 20:18:38 +00003376 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003377};
3378
Tim Peters37f39822003-01-10 03:49:02 +00003379static char time_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00003380PyDoc_STR("time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object\n\
3381\n\
3382All arguments are optional. tzinfo may be None, or an instance of\n\
3383a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00003384
Tim Peters37f39822003-01-10 03:49:02 +00003385static PyNumberMethods time_as_number = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003386 0, /* nb_add */
3387 0, /* nb_subtract */
3388 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00003389 0, /* nb_remainder */
3390 0, /* nb_divmod */
3391 0, /* nb_power */
3392 0, /* nb_negative */
3393 0, /* nb_positive */
3394 0, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +00003395 (inquiry)time_bool, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00003396};
3397
Neal Norwitz227b5332006-03-22 09:28:35 +00003398static PyTypeObject PyDateTime_TimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003399 PyObject_HEAD_INIT(NULL)
3400 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00003401 "datetime.time", /* tp_name */
Tim Peters37f39822003-01-10 03:49:02 +00003402 sizeof(PyDateTime_Time), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00003403 0, /* tp_itemsize */
Tim Peters37f39822003-01-10 03:49:02 +00003404 (destructor)time_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003405 0, /* tp_print */
3406 0, /* tp_getattr */
3407 0, /* tp_setattr */
3408 0, /* tp_compare */
Tim Peters37f39822003-01-10 03:49:02 +00003409 (reprfunc)time_repr, /* tp_repr */
3410 &time_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00003411 0, /* tp_as_sequence */
3412 0, /* tp_as_mapping */
Tim Peters37f39822003-01-10 03:49:02 +00003413 (hashfunc)time_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00003414 0, /* tp_call */
Tim Peters37f39822003-01-10 03:49:02 +00003415 (reprfunc)time_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00003416 PyObject_GenericGetAttr, /* tp_getattro */
3417 0, /* tp_setattro */
3418 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00003419 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters37f39822003-01-10 03:49:02 +00003420 time_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003421 0, /* tp_traverse */
3422 0, /* tp_clear */
Guido van Rossum19960592006-08-24 17:29:38 +00003423 time_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00003424 0, /* tp_weaklistoffset */
3425 0, /* tp_iter */
3426 0, /* tp_iternext */
Tim Peters37f39822003-01-10 03:49:02 +00003427 time_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00003428 0, /* tp_members */
Tim Peters37f39822003-01-10 03:49:02 +00003429 time_getset, /* tp_getset */
3430 0, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00003431 0, /* tp_dict */
3432 0, /* tp_descr_get */
3433 0, /* tp_descr_set */
3434 0, /* tp_dictoffset */
3435 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00003436 time_alloc, /* tp_alloc */
Tim Peters37f39822003-01-10 03:49:02 +00003437 time_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00003438 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00003439};
3440
3441/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003442 * PyDateTime_DateTime implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003443 */
3444
Tim Petersa9bc1682003-01-11 03:39:11 +00003445/* Accessor properties. Properties for day, month, and year are inherited
3446 * from date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003447 */
3448
3449static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003450datetime_hour(PyDateTime_DateTime *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003451{
Tim Petersa9bc1682003-01-11 03:39:11 +00003452 return PyInt_FromLong(DATE_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003453}
3454
Tim Petersa9bc1682003-01-11 03:39:11 +00003455static PyObject *
3456datetime_minute(PyDateTime_DateTime *self, void *unused)
3457{
3458 return PyInt_FromLong(DATE_GET_MINUTE(self));
3459}
3460
3461static PyObject *
3462datetime_second(PyDateTime_DateTime *self, void *unused)
3463{
3464 return PyInt_FromLong(DATE_GET_SECOND(self));
3465}
3466
3467static PyObject *
3468datetime_microsecond(PyDateTime_DateTime *self, void *unused)
3469{
3470 return PyInt_FromLong(DATE_GET_MICROSECOND(self));
3471}
3472
3473static PyObject *
3474datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
3475{
3476 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3477 Py_INCREF(result);
3478 return result;
3479}
3480
3481static PyGetSetDef datetime_getset[] = {
3482 {"hour", (getter)datetime_hour},
3483 {"minute", (getter)datetime_minute},
3484 {"second", (getter)datetime_second},
3485 {"microsecond", (getter)datetime_microsecond},
3486 {"tzinfo", (getter)datetime_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003487 {NULL}
3488};
3489
3490/*
3491 * Constructors.
Tim Peters2a799bf2002-12-16 20:18:38 +00003492 */
3493
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003494static char *datetime_kws[] = {
Tim Peters12bf3392002-12-24 05:41:27 +00003495 "year", "month", "day", "hour", "minute", "second",
3496 "microsecond", "tzinfo", NULL
3497};
3498
Tim Peters2a799bf2002-12-16 20:18:38 +00003499static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003500datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003501{
3502 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003503 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003504 int year;
3505 int month;
3506 int day;
3507 int hour = 0;
3508 int minute = 0;
3509 int second = 0;
3510 int usecond = 0;
3511 PyObject *tzinfo = Py_None;
3512
Guido van Rossum177e41a2003-01-30 22:06:23 +00003513 /* Check for invocation from pickle with __getstate__ state */
3514 if (PyTuple_GET_SIZE(args) >= 1 &&
3515 PyTuple_GET_SIZE(args) <= 2 &&
Tim Peters70533e22003-02-01 04:40:04 +00003516 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Tim Peters3f606292004-03-21 23:38:41 +00003517 PyString_GET_SIZE(state) == _PyDateTime_DATETIME_DATASIZE &&
3518 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00003519 {
Tim Peters70533e22003-02-01 04:40:04 +00003520 PyDateTime_DateTime *me;
3521 char aware;
3522
3523 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003524 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003525 if (check_tzinfo_subclass(tzinfo) < 0) {
3526 PyErr_SetString(PyExc_TypeError, "bad "
3527 "tzinfo state arg");
3528 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003529 }
3530 }
Tim Peters70533e22003-02-01 04:40:04 +00003531 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003532 me = (PyDateTime_DateTime *) (type->tp_alloc(type , aware));
Tim Peters70533e22003-02-01 04:40:04 +00003533 if (me != NULL) {
3534 char *pdata = PyString_AS_STRING(state);
3535
3536 memcpy(me->data, pdata, _PyDateTime_DATETIME_DATASIZE);
3537 me->hashcode = -1;
3538 me->hastzinfo = aware;
3539 if (aware) {
3540 Py_INCREF(tzinfo);
3541 me->tzinfo = tzinfo;
3542 }
3543 }
3544 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003545 }
3546
Tim Petersa9bc1682003-01-11 03:39:11 +00003547 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO", datetime_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003548 &year, &month, &day, &hour, &minute,
3549 &second, &usecond, &tzinfo)) {
3550 if (check_date_args(year, month, day) < 0)
3551 return NULL;
3552 if (check_time_args(hour, minute, second, usecond) < 0)
3553 return NULL;
3554 if (check_tzinfo_subclass(tzinfo) < 0)
3555 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003556 self = new_datetime_ex(year, month, day,
3557 hour, minute, second, usecond,
3558 tzinfo, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003559 }
3560 return self;
3561}
3562
Tim Petersa9bc1682003-01-11 03:39:11 +00003563/* TM_FUNC is the shared type of localtime() and gmtime(). */
3564typedef struct tm *(*TM_FUNC)(const time_t *timer);
3565
3566/* Internal helper.
3567 * Build datetime from a time_t and a distinct count of microseconds.
3568 * Pass localtime or gmtime for f, to control the interpretation of timet.
3569 */
3570static PyObject *
3571datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
3572 PyObject *tzinfo)
3573{
3574 struct tm *tm;
3575 PyObject *result = NULL;
3576
3577 tm = f(&timet);
3578 if (tm) {
3579 /* The platform localtime/gmtime may insert leap seconds,
3580 * indicated by tm->tm_sec > 59. We don't care about them,
3581 * except to the extent that passing them on to the datetime
3582 * constructor would raise ValueError for a reason that
3583 * made no sense to the user.
3584 */
3585 if (tm->tm_sec > 59)
3586 tm->tm_sec = 59;
3587 result = PyObject_CallFunction(cls, "iiiiiiiO",
3588 tm->tm_year + 1900,
3589 tm->tm_mon + 1,
3590 tm->tm_mday,
3591 tm->tm_hour,
3592 tm->tm_min,
3593 tm->tm_sec,
3594 us,
3595 tzinfo);
3596 }
3597 else
3598 PyErr_SetString(PyExc_ValueError,
3599 "timestamp out of range for "
3600 "platform localtime()/gmtime() function");
3601 return result;
3602}
3603
3604/* Internal helper.
3605 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
3606 * to control the interpretation of the timestamp. Since a double doesn't
3607 * have enough bits to cover a datetime's full range of precision, it's
3608 * better to call datetime_from_timet_and_us provided you have a way
3609 * to get that much precision (e.g., C time() isn't good enough).
3610 */
3611static PyObject *
3612datetime_from_timestamp(PyObject *cls, TM_FUNC f, double timestamp,
3613 PyObject *tzinfo)
3614{
Tim Peters1b6f7a92004-06-20 02:50:16 +00003615 time_t timet;
3616 double fraction;
3617 int us;
Tim Petersa9bc1682003-01-11 03:39:11 +00003618
Tim Peters1b6f7a92004-06-20 02:50:16 +00003619 timet = _PyTime_DoubleToTimet(timestamp);
3620 if (timet == (time_t)-1 && PyErr_Occurred())
3621 return NULL;
3622 fraction = timestamp - (double)timet;
3623 us = (int)round_to_long(fraction * 1e6);
Guido van Rossumd8faa362007-04-27 19:54:29 +00003624 if (us < 0) {
3625 /* Truncation towards zero is not what we wanted
3626 for negative numbers (Python's mod semantics) */
3627 timet -= 1;
3628 us += 1000000;
3629 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00003630 /* If timestamp is less than one microsecond smaller than a
3631 * full second, round up. Otherwise, ValueErrors are raised
3632 * for some floats. */
3633 if (us == 1000000) {
3634 timet += 1;
3635 us = 0;
3636 }
Tim Petersa9bc1682003-01-11 03:39:11 +00003637 return datetime_from_timet_and_us(cls, f, timet, us, tzinfo);
3638}
3639
3640/* Internal helper.
3641 * Build most accurate possible datetime for current time. Pass localtime or
3642 * gmtime for f as appropriate.
3643 */
3644static PyObject *
3645datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
3646{
3647#ifdef HAVE_GETTIMEOFDAY
3648 struct timeval t;
3649
3650#ifdef GETTIMEOFDAY_NO_TZ
3651 gettimeofday(&t);
3652#else
3653 gettimeofday(&t, (struct timezone *)NULL);
3654#endif
3655 return datetime_from_timet_and_us(cls, f, t.tv_sec, (int)t.tv_usec,
3656 tzinfo);
3657
3658#else /* ! HAVE_GETTIMEOFDAY */
3659 /* No flavor of gettimeofday exists on this platform. Python's
3660 * time.time() does a lot of other platform tricks to get the
3661 * best time it can on the platform, and we're not going to do
3662 * better than that (if we could, the better code would belong
3663 * in time.time()!) We're limited by the precision of a double,
3664 * though.
3665 */
3666 PyObject *time;
3667 double dtime;
3668
3669 time = time_time();
3670 if (time == NULL)
3671 return NULL;
3672 dtime = PyFloat_AsDouble(time);
3673 Py_DECREF(time);
3674 if (dtime == -1.0 && PyErr_Occurred())
3675 return NULL;
3676 return datetime_from_timestamp(cls, f, dtime, tzinfo);
3677#endif /* ! HAVE_GETTIMEOFDAY */
3678}
3679
Tim Peters2a799bf2002-12-16 20:18:38 +00003680/* Return best possible local time -- this isn't constrained by the
3681 * precision of a timestamp.
3682 */
3683static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003684datetime_now(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003685{
Tim Peters10cadce2003-01-23 19:58:02 +00003686 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003687 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003688 static char *keywords[] = {"tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003689
Tim Peters10cadce2003-01-23 19:58:02 +00003690 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:now", keywords,
3691 &tzinfo))
3692 return NULL;
3693 if (check_tzinfo_subclass(tzinfo) < 0)
3694 return NULL;
3695
3696 self = datetime_best_possible(cls,
3697 tzinfo == Py_None ? localtime : gmtime,
3698 tzinfo);
3699 if (self != NULL && tzinfo != Py_None) {
3700 /* Convert UTC to tzinfo's zone. */
3701 PyObject *temp = self;
Tim Peters2a44a8d2003-01-23 20:53:10 +00003702 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
Tim Peters10cadce2003-01-23 19:58:02 +00003703 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003704 }
3705 return self;
3706}
3707
Tim Petersa9bc1682003-01-11 03:39:11 +00003708/* Return best possible UTC time -- this isn't constrained by the
3709 * precision of a timestamp.
3710 */
3711static PyObject *
3712datetime_utcnow(PyObject *cls, PyObject *dummy)
3713{
3714 return datetime_best_possible(cls, gmtime, Py_None);
3715}
3716
Tim Peters2a799bf2002-12-16 20:18:38 +00003717/* Return new local datetime from timestamp (Python timestamp -- a double). */
3718static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003719datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003720{
Tim Peters2a44a8d2003-01-23 20:53:10 +00003721 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003722 double timestamp;
3723 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003724 static char *keywords[] = {"timestamp", "tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003725
Tim Peters2a44a8d2003-01-23 20:53:10 +00003726 if (! PyArg_ParseTupleAndKeywords(args, kw, "d|O:fromtimestamp",
3727 keywords, &timestamp, &tzinfo))
3728 return NULL;
3729 if (check_tzinfo_subclass(tzinfo) < 0)
3730 return NULL;
3731
3732 self = datetime_from_timestamp(cls,
3733 tzinfo == Py_None ? localtime : gmtime,
3734 timestamp,
3735 tzinfo);
3736 if (self != NULL && tzinfo != Py_None) {
3737 /* Convert UTC to tzinfo's zone. */
3738 PyObject *temp = self;
3739 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3740 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003741 }
3742 return self;
3743}
3744
Tim Petersa9bc1682003-01-11 03:39:11 +00003745/* Return new UTC datetime from timestamp (Python timestamp -- a double). */
3746static PyObject *
3747datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
3748{
3749 double timestamp;
3750 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003751
Tim Petersa9bc1682003-01-11 03:39:11 +00003752 if (PyArg_ParseTuple(args, "d:utcfromtimestamp", &timestamp))
3753 result = datetime_from_timestamp(cls, gmtime, timestamp,
3754 Py_None);
3755 return result;
3756}
3757
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003758/* Return new datetime from time.strptime(). */
3759static PyObject *
3760datetime_strptime(PyObject *cls, PyObject *args)
3761{
3762 PyObject *result = NULL, *obj, *module;
3763 const char *string, *format;
3764
3765 if (!PyArg_ParseTuple(args, "ss:strptime", &string, &format))
3766 return NULL;
3767
3768 if ((module = PyImport_ImportModule("time")) == NULL)
3769 return NULL;
3770 obj = PyObject_CallMethod(module, "strptime", "ss", string, format);
3771 Py_DECREF(module);
3772
3773 if (obj != NULL) {
3774 int i, good_timetuple = 1;
3775 long int ia[6];
3776 if (PySequence_Check(obj) && PySequence_Size(obj) >= 6)
3777 for (i=0; i < 6; i++) {
3778 PyObject *p = PySequence_GetItem(obj, i);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003779 if (p == NULL) {
3780 Py_DECREF(obj);
3781 return NULL;
3782 }
Guido van Rossumddefaf32007-01-14 03:31:43 +00003783 if (PyInt_CheckExact(p))
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003784 ia[i] = PyInt_AsLong(p);
3785 else
3786 good_timetuple = 0;
3787 Py_DECREF(p);
3788 }
3789 else
3790 good_timetuple = 0;
3791 if (good_timetuple)
3792 result = PyObject_CallFunction(cls, "iiiiii",
3793 ia[0], ia[1], ia[2], ia[3], ia[4], ia[5]);
3794 else
3795 PyErr_SetString(PyExc_ValueError,
3796 "unexpected value from time.strptime");
3797 Py_DECREF(obj);
3798 }
3799 return result;
3800}
3801
Tim Petersa9bc1682003-01-11 03:39:11 +00003802/* Return new datetime from date/datetime and time arguments. */
3803static PyObject *
3804datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
3805{
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003806 static char *keywords[] = {"date", "time", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00003807 PyObject *date;
3808 PyObject *time;
3809 PyObject *result = NULL;
3810
3811 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!:combine", keywords,
3812 &PyDateTime_DateType, &date,
3813 &PyDateTime_TimeType, &time)) {
3814 PyObject *tzinfo = Py_None;
3815
3816 if (HASTZINFO(time))
3817 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
3818 result = PyObject_CallFunction(cls, "iiiiiiiO",
3819 GET_YEAR(date),
3820 GET_MONTH(date),
3821 GET_DAY(date),
3822 TIME_GET_HOUR(time),
3823 TIME_GET_MINUTE(time),
3824 TIME_GET_SECOND(time),
3825 TIME_GET_MICROSECOND(time),
3826 tzinfo);
3827 }
3828 return result;
3829}
Tim Peters2a799bf2002-12-16 20:18:38 +00003830
3831/*
3832 * Destructor.
3833 */
3834
3835static void
Tim Petersa9bc1682003-01-11 03:39:11 +00003836datetime_dealloc(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003837{
Tim Petersa9bc1682003-01-11 03:39:11 +00003838 if (HASTZINFO(self)) {
3839 Py_XDECREF(self->tzinfo);
3840 }
Tim Peters2a799bf2002-12-16 20:18:38 +00003841 self->ob_type->tp_free((PyObject *)self);
3842}
3843
3844/*
3845 * Indirect access to tzinfo methods.
3846 */
3847
Tim Peters2a799bf2002-12-16 20:18:38 +00003848/* These are all METH_NOARGS, so don't need to check the arglist. */
3849static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003850datetime_utcoffset(PyDateTime_DateTime *self, PyObject *unused) {
3851 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3852 "utcoffset", (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003853}
3854
3855static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003856datetime_dst(PyDateTime_DateTime *self, PyObject *unused) {
3857 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3858 "dst", (PyObject *)self);
Tim Peters855fe882002-12-22 03:43:39 +00003859}
3860
3861static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003862datetime_tzname(PyDateTime_DateTime *self, PyObject *unused) {
3863 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
3864 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003865}
3866
3867/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003868 * datetime arithmetic.
Tim Peters2a799bf2002-12-16 20:18:38 +00003869 */
3870
Tim Petersa9bc1682003-01-11 03:39:11 +00003871/* factor must be 1 (to add) or -1 (to subtract). The result inherits
3872 * the tzinfo state of date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003873 */
3874static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003875add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
3876 int factor)
Tim Peters2a799bf2002-12-16 20:18:38 +00003877{
Tim Petersa9bc1682003-01-11 03:39:11 +00003878 /* Note that the C-level additions can't overflow, because of
3879 * invariant bounds on the member values.
3880 */
3881 int year = GET_YEAR(date);
3882 int month = GET_MONTH(date);
3883 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
3884 int hour = DATE_GET_HOUR(date);
3885 int minute = DATE_GET_MINUTE(date);
3886 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
3887 int microsecond = DATE_GET_MICROSECOND(date) +
3888 GET_TD_MICROSECONDS(delta) * factor;
Tim Peters2a799bf2002-12-16 20:18:38 +00003889
Tim Petersa9bc1682003-01-11 03:39:11 +00003890 assert(factor == 1 || factor == -1);
3891 if (normalize_datetime(&year, &month, &day,
3892 &hour, &minute, &second, &microsecond) < 0)
3893 return NULL;
3894 else
3895 return new_datetime(year, month, day,
3896 hour, minute, second, microsecond,
3897 HASTZINFO(date) ? date->tzinfo : Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003898}
3899
3900static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003901datetime_add(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003902{
Tim Petersa9bc1682003-01-11 03:39:11 +00003903 if (PyDateTime_Check(left)) {
3904 /* datetime + ??? */
3905 if (PyDelta_Check(right))
3906 /* datetime + delta */
3907 return add_datetime_timedelta(
3908 (PyDateTime_DateTime *)left,
3909 (PyDateTime_Delta *)right,
3910 1);
3911 }
3912 else if (PyDelta_Check(left)) {
3913 /* delta + datetime */
3914 return add_datetime_timedelta((PyDateTime_DateTime *) right,
3915 (PyDateTime_Delta *) left,
3916 1);
3917 }
3918 Py_INCREF(Py_NotImplemented);
3919 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00003920}
3921
3922static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003923datetime_subtract(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003924{
3925 PyObject *result = Py_NotImplemented;
3926
3927 if (PyDateTime_Check(left)) {
3928 /* datetime - ??? */
3929 if (PyDateTime_Check(right)) {
3930 /* datetime - datetime */
3931 naivety n1, n2;
3932 int offset1, offset2;
Tim Petersa9bc1682003-01-11 03:39:11 +00003933 int delta_d, delta_s, delta_us;
Tim Peters2a799bf2002-12-16 20:18:38 +00003934
Tim Peterse39a80c2002-12-30 21:28:52 +00003935 if (classify_two_utcoffsets(left, &offset1, &n1, left,
3936 right, &offset2, &n2,
3937 right) < 0)
Tim Peters00237032002-12-27 02:21:51 +00003938 return NULL;
Tim Peters8702d5f2002-12-27 02:26:16 +00003939 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
Tim Peters2a799bf2002-12-16 20:18:38 +00003940 if (n1 != n2) {
3941 PyErr_SetString(PyExc_TypeError,
3942 "can't subtract offset-naive and "
3943 "offset-aware datetimes");
3944 return NULL;
3945 }
Tim Petersa9bc1682003-01-11 03:39:11 +00003946 delta_d = ymd_to_ord(GET_YEAR(left),
3947 GET_MONTH(left),
3948 GET_DAY(left)) -
3949 ymd_to_ord(GET_YEAR(right),
3950 GET_MONTH(right),
3951 GET_DAY(right));
3952 /* These can't overflow, since the values are
3953 * normalized. At most this gives the number of
3954 * seconds in one day.
3955 */
3956 delta_s = (DATE_GET_HOUR(left) -
3957 DATE_GET_HOUR(right)) * 3600 +
3958 (DATE_GET_MINUTE(left) -
3959 DATE_GET_MINUTE(right)) * 60 +
3960 (DATE_GET_SECOND(left) -
3961 DATE_GET_SECOND(right));
3962 delta_us = DATE_GET_MICROSECOND(left) -
3963 DATE_GET_MICROSECOND(right);
Tim Peters2a799bf2002-12-16 20:18:38 +00003964 /* (left - offset1) - (right - offset2) =
3965 * (left - right) + (offset2 - offset1)
3966 */
Tim Petersa9bc1682003-01-11 03:39:11 +00003967 delta_s += (offset2 - offset1) * 60;
3968 result = new_delta(delta_d, delta_s, delta_us, 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00003969 }
3970 else if (PyDelta_Check(right)) {
Tim Petersa9bc1682003-01-11 03:39:11 +00003971 /* datetime - delta */
3972 result = add_datetime_timedelta(
Tim Peters2a799bf2002-12-16 20:18:38 +00003973 (PyDateTime_DateTime *)left,
Tim Petersa9bc1682003-01-11 03:39:11 +00003974 (PyDateTime_Delta *)right,
3975 -1);
Tim Peters2a799bf2002-12-16 20:18:38 +00003976 }
3977 }
3978
3979 if (result == Py_NotImplemented)
3980 Py_INCREF(result);
3981 return result;
3982}
3983
3984/* Various ways to turn a datetime into a string. */
3985
3986static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003987datetime_repr(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003988{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003989 const char *type_name = self->ob_type->tp_name;
Tim Petersa9bc1682003-01-11 03:39:11 +00003990 PyObject *baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00003991
Tim Petersa9bc1682003-01-11 03:39:11 +00003992 if (DATE_GET_MICROSECOND(self)) {
Walter Dörwald7569dfe2007-05-19 21:49:49 +00003993 baserepr = PyUnicode_FromFormat(
Tim Petersa9bc1682003-01-11 03:39:11 +00003994 "%s(%d, %d, %d, %d, %d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003995 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00003996 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
3997 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
3998 DATE_GET_SECOND(self),
3999 DATE_GET_MICROSECOND(self));
4000 }
4001 else if (DATE_GET_SECOND(self)) {
Walter Dörwald7569dfe2007-05-19 21:49:49 +00004002 baserepr = PyUnicode_FromFormat(
Tim Petersa9bc1682003-01-11 03:39:11 +00004003 "%s(%d, %d, %d, %d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004004 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004005 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4006 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4007 DATE_GET_SECOND(self));
4008 }
4009 else {
Walter Dörwald7569dfe2007-05-19 21:49:49 +00004010 baserepr = PyUnicode_FromFormat(
Tim Petersa9bc1682003-01-11 03:39:11 +00004011 "%s(%d, %d, %d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004012 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004013 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4014 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
4015 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004016 if (baserepr == NULL || ! HASTZINFO(self))
4017 return baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004018 return append_keyword_tzinfo(baserepr, self->tzinfo);
4019}
4020
Tim Petersa9bc1682003-01-11 03:39:11 +00004021static PyObject *
4022datetime_str(PyDateTime_DateTime *self)
4023{
4024 return PyObject_CallMethod((PyObject *)self, "isoformat", "(s)", " ");
4025}
Tim Peters2a799bf2002-12-16 20:18:38 +00004026
4027static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004028datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004029{
Tim Petersa9bc1682003-01-11 03:39:11 +00004030 char sep = 'T';
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004031 static char *keywords[] = {"sep", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00004032 char buffer[100];
Tim Petersa9bc1682003-01-11 03:39:11 +00004033 PyObject *result;
Walter Dörwaldbafa1372007-05-31 17:50:48 +00004034 int us = DATE_GET_MICROSECOND(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00004035
Walter Dörwaldbafa1372007-05-31 17:50:48 +00004036 if (!PyArg_ParseTupleAndKeywords(args, kw, "|c:isoformat", keywords, &sep))
Tim Petersa9bc1682003-01-11 03:39:11 +00004037 return NULL;
Walter Dörwaldbafa1372007-05-31 17:50:48 +00004038 if (us)
4039 result = PyUnicode_FromFormat("%04d-%02d-%02d%c%02d:%02d:%02d.%06d",
4040 GET_YEAR(self), GET_MONTH(self),
4041 GET_DAY(self), (int)sep,
4042 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4043 DATE_GET_SECOND(self), us);
4044 else
4045 result = PyUnicode_FromFormat("%04d-%02d-%02d%c%02d:%02d:%02d",
4046 GET_YEAR(self), GET_MONTH(self),
4047 GET_DAY(self), (int)sep,
4048 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4049 DATE_GET_SECOND(self));
4050
4051 if (!result || !HASTZINFO(self))
Tim Peters2a799bf2002-12-16 20:18:38 +00004052 return result;
4053
4054 /* We need to append the UTC offset. */
Tim Petersa9bc1682003-01-11 03:39:11 +00004055 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
Tim Peters2a799bf2002-12-16 20:18:38 +00004056 (PyObject *)self) < 0) {
4057 Py_DECREF(result);
4058 return NULL;
4059 }
Walter Dörwaldbafa1372007-05-31 17:50:48 +00004060 PyUnicode_AppendAndDel(&result, PyUnicode_FromString(buffer));
Tim Peters2a799bf2002-12-16 20:18:38 +00004061 return result;
4062}
4063
Tim Petersa9bc1682003-01-11 03:39:11 +00004064static PyObject *
4065datetime_ctime(PyDateTime_DateTime *self)
4066{
4067 return format_ctime((PyDateTime_Date *)self,
4068 DATE_GET_HOUR(self),
4069 DATE_GET_MINUTE(self),
4070 DATE_GET_SECOND(self));
4071}
4072
Tim Peters2a799bf2002-12-16 20:18:38 +00004073/* Miscellaneous methods. */
4074
Tim Petersa9bc1682003-01-11 03:39:11 +00004075static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00004076datetime_richcompare(PyObject *self, PyObject *other, int op)
Tim Petersa9bc1682003-01-11 03:39:11 +00004077{
4078 int diff;
4079 naivety n1, n2;
4080 int offset1, offset2;
4081
4082 if (! PyDateTime_Check(other)) {
Guido van Rossum19960592006-08-24 17:29:38 +00004083 if (PyDate_Check(other)) {
4084 /* Prevent invocation of date_richcompare. We want to
4085 return NotImplemented here to give the other object
4086 a chance. But since DateTime is a subclass of
4087 Date, if the other object is a Date, it would
4088 compute an ordering based on the date part alone,
4089 and we don't want that. So force unequal or
4090 uncomparable here in that case. */
4091 if (op == Py_EQ)
4092 Py_RETURN_FALSE;
4093 if (op == Py_NE)
4094 Py_RETURN_TRUE;
4095 return cmperror(self, other);
Tim Peters8d81a012003-01-24 22:36:34 +00004096 }
Guido van Rossum19960592006-08-24 17:29:38 +00004097 Py_INCREF(Py_NotImplemented);
4098 return Py_NotImplemented;
Tim Petersa9bc1682003-01-11 03:39:11 +00004099 }
4100
Guido van Rossum19960592006-08-24 17:29:38 +00004101 if (classify_two_utcoffsets(self, &offset1, &n1, self,
4102 other, &offset2, &n2, other) < 0)
Tim Petersa9bc1682003-01-11 03:39:11 +00004103 return NULL;
4104 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
4105 /* If they're both naive, or both aware and have the same offsets,
4106 * we get off cheap. Note that if they're both naive, offset1 ==
4107 * offset2 == 0 at this point.
4108 */
4109 if (n1 == n2 && offset1 == offset2) {
Guido van Rossum19960592006-08-24 17:29:38 +00004110 diff = memcmp(((PyDateTime_DateTime *)self)->data,
4111 ((PyDateTime_DateTime *)other)->data,
Tim Petersa9bc1682003-01-11 03:39:11 +00004112 _PyDateTime_DATETIME_DATASIZE);
4113 return diff_to_bool(diff, op);
4114 }
4115
4116 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
4117 PyDateTime_Delta *delta;
4118
4119 assert(offset1 != offset2); /* else last "if" handled it */
4120 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
4121 other);
4122 if (delta == NULL)
4123 return NULL;
4124 diff = GET_TD_DAYS(delta);
4125 if (diff == 0)
4126 diff = GET_TD_SECONDS(delta) |
4127 GET_TD_MICROSECONDS(delta);
4128 Py_DECREF(delta);
4129 return diff_to_bool(diff, op);
4130 }
4131
4132 assert(n1 != n2);
4133 PyErr_SetString(PyExc_TypeError,
4134 "can't compare offset-naive and "
4135 "offset-aware datetimes");
4136 return NULL;
4137}
4138
4139static long
4140datetime_hash(PyDateTime_DateTime *self)
4141{
4142 if (self->hashcode == -1) {
4143 naivety n;
4144 int offset;
4145 PyObject *temp;
4146
4147 n = classify_utcoffset((PyObject *)self, (PyObject *)self,
4148 &offset);
4149 assert(n != OFFSET_UNKNOWN);
4150 if (n == OFFSET_ERROR)
4151 return -1;
4152
4153 /* Reduce this to a hash of another object. */
4154 if (n == OFFSET_NAIVE)
4155 temp = PyString_FromStringAndSize(
4156 (char *)self->data,
4157 _PyDateTime_DATETIME_DATASIZE);
4158 else {
4159 int days;
4160 int seconds;
4161
4162 assert(n == OFFSET_AWARE);
4163 assert(HASTZINFO(self));
4164 days = ymd_to_ord(GET_YEAR(self),
4165 GET_MONTH(self),
4166 GET_DAY(self));
4167 seconds = DATE_GET_HOUR(self) * 3600 +
4168 (DATE_GET_MINUTE(self) - offset) * 60 +
4169 DATE_GET_SECOND(self);
4170 temp = new_delta(days,
4171 seconds,
4172 DATE_GET_MICROSECOND(self),
4173 1);
4174 }
4175 if (temp != NULL) {
4176 self->hashcode = PyObject_Hash(temp);
4177 Py_DECREF(temp);
4178 }
4179 }
4180 return self->hashcode;
4181}
Tim Peters2a799bf2002-12-16 20:18:38 +00004182
4183static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004184datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00004185{
4186 PyObject *clone;
4187 PyObject *tuple;
4188 int y = GET_YEAR(self);
4189 int m = GET_MONTH(self);
4190 int d = GET_DAY(self);
4191 int hh = DATE_GET_HOUR(self);
4192 int mm = DATE_GET_MINUTE(self);
4193 int ss = DATE_GET_SECOND(self);
4194 int us = DATE_GET_MICROSECOND(self);
Tim Petersa9bc1682003-01-11 03:39:11 +00004195 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00004196
4197 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO:replace",
Tim Petersa9bc1682003-01-11 03:39:11 +00004198 datetime_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00004199 &y, &m, &d, &hh, &mm, &ss, &us,
4200 &tzinfo))
4201 return NULL;
4202 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
4203 if (tuple == NULL)
4204 return NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00004205 clone = datetime_new(self->ob_type, tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00004206 Py_DECREF(tuple);
4207 return clone;
4208}
4209
4210static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004211datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters80475bb2002-12-25 07:40:55 +00004212{
Tim Peters52dcce22003-01-23 16:36:11 +00004213 int y, m, d, hh, mm, ss, us;
Tim Peters521fc152002-12-31 17:36:56 +00004214 PyObject *result;
Tim Peters52dcce22003-01-23 16:36:11 +00004215 int offset, none;
Tim Peters521fc152002-12-31 17:36:56 +00004216
Tim Peters80475bb2002-12-25 07:40:55 +00004217 PyObject *tzinfo;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004218 static char *keywords[] = {"tz", NULL};
Tim Peters80475bb2002-12-25 07:40:55 +00004219
Tim Peters52dcce22003-01-23 16:36:11 +00004220 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:astimezone", keywords,
4221 &PyDateTime_TZInfoType, &tzinfo))
Tim Peters80475bb2002-12-25 07:40:55 +00004222 return NULL;
4223
Tim Peters52dcce22003-01-23 16:36:11 +00004224 if (!HASTZINFO(self) || self->tzinfo == Py_None)
4225 goto NeedAware;
Tim Peters521fc152002-12-31 17:36:56 +00004226
Tim Peters52dcce22003-01-23 16:36:11 +00004227 /* Conversion to self's own time zone is a NOP. */
4228 if (self->tzinfo == tzinfo) {
4229 Py_INCREF(self);
4230 return (PyObject *)self;
Tim Peters710fb152003-01-02 19:35:54 +00004231 }
Tim Peters521fc152002-12-31 17:36:56 +00004232
Tim Peters52dcce22003-01-23 16:36:11 +00004233 /* Convert self to UTC. */
4234 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4235 if (offset == -1 && PyErr_Occurred())
4236 return NULL;
4237 if (none)
4238 goto NeedAware;
Tim Petersf3615152003-01-01 21:51:37 +00004239
Tim Peters52dcce22003-01-23 16:36:11 +00004240 y = GET_YEAR(self);
4241 m = GET_MONTH(self);
4242 d = GET_DAY(self);
4243 hh = DATE_GET_HOUR(self);
4244 mm = DATE_GET_MINUTE(self);
4245 ss = DATE_GET_SECOND(self);
4246 us = DATE_GET_MICROSECOND(self);
4247
4248 mm -= offset;
Tim Petersf3615152003-01-01 21:51:37 +00004249 if ((mm < 0 || mm >= 60) &&
4250 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Peters52dcce22003-01-23 16:36:11 +00004251 return NULL;
4252
4253 /* Attach new tzinfo and let fromutc() do the rest. */
4254 result = new_datetime(y, m, d, hh, mm, ss, us, tzinfo);
4255 if (result != NULL) {
4256 PyObject *temp = result;
4257
4258 result = PyObject_CallMethod(tzinfo, "fromutc", "O", temp);
4259 Py_DECREF(temp);
4260 }
Tim Petersadf64202003-01-04 06:03:15 +00004261 return result;
Tim Peters521fc152002-12-31 17:36:56 +00004262
Tim Peters52dcce22003-01-23 16:36:11 +00004263NeedAware:
4264 PyErr_SetString(PyExc_ValueError, "astimezone() cannot be applied to "
4265 "a naive datetime");
Tim Peters521fc152002-12-31 17:36:56 +00004266 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00004267}
4268
4269static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004270datetime_timetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004271{
4272 int dstflag = -1;
4273
Tim Petersa9bc1682003-01-11 03:39:11 +00004274 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004275 int none;
4276
4277 dstflag = call_dst(self->tzinfo, (PyObject *)self, &none);
4278 if (dstflag == -1 && PyErr_Occurred())
4279 return NULL;
4280
4281 if (none)
4282 dstflag = -1;
4283 else if (dstflag != 0)
4284 dstflag = 1;
4285
4286 }
4287 return build_struct_time(GET_YEAR(self),
4288 GET_MONTH(self),
4289 GET_DAY(self),
4290 DATE_GET_HOUR(self),
4291 DATE_GET_MINUTE(self),
4292 DATE_GET_SECOND(self),
4293 dstflag);
4294}
4295
4296static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004297datetime_getdate(PyDateTime_DateTime *self)
4298{
4299 return new_date(GET_YEAR(self),
4300 GET_MONTH(self),
4301 GET_DAY(self));
4302}
4303
4304static PyObject *
4305datetime_gettime(PyDateTime_DateTime *self)
4306{
4307 return new_time(DATE_GET_HOUR(self),
4308 DATE_GET_MINUTE(self),
4309 DATE_GET_SECOND(self),
4310 DATE_GET_MICROSECOND(self),
4311 Py_None);
4312}
4313
4314static PyObject *
4315datetime_gettimetz(PyDateTime_DateTime *self)
4316{
4317 return new_time(DATE_GET_HOUR(self),
4318 DATE_GET_MINUTE(self),
4319 DATE_GET_SECOND(self),
4320 DATE_GET_MICROSECOND(self),
4321 HASTZINFO(self) ? self->tzinfo : Py_None);
4322}
4323
4324static PyObject *
4325datetime_utctimetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004326{
4327 int y = GET_YEAR(self);
4328 int m = GET_MONTH(self);
4329 int d = GET_DAY(self);
4330 int hh = DATE_GET_HOUR(self);
4331 int mm = DATE_GET_MINUTE(self);
4332 int ss = DATE_GET_SECOND(self);
4333 int us = 0; /* microseconds are ignored in a timetuple */
4334 int offset = 0;
4335
Tim Petersa9bc1682003-01-11 03:39:11 +00004336 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004337 int none;
4338
4339 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4340 if (offset == -1 && PyErr_Occurred())
4341 return NULL;
4342 }
4343 /* Even if offset is 0, don't call timetuple() -- tm_isdst should be
4344 * 0 in a UTC timetuple regardless of what dst() says.
4345 */
4346 if (offset) {
4347 /* Subtract offset minutes & normalize. */
4348 int stat;
4349
4350 mm -= offset;
4351 stat = normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us);
4352 if (stat < 0) {
4353 /* At the edges, it's possible we overflowed
4354 * beyond MINYEAR or MAXYEAR.
4355 */
4356 if (PyErr_ExceptionMatches(PyExc_OverflowError))
4357 PyErr_Clear();
4358 else
4359 return NULL;
4360 }
4361 }
4362 return build_struct_time(y, m, d, hh, mm, ss, 0);
4363}
4364
Tim Peters371935f2003-02-01 01:52:50 +00004365/* Pickle support, a simple use of __reduce__. */
Tim Peters33e0f382003-01-10 02:05:14 +00004366
Tim Petersa9bc1682003-01-11 03:39:11 +00004367/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004368 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4369 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00004370 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00004371 */
4372static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004373datetime_getstate(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004374{
4375 PyObject *basestate;
4376 PyObject *result = NULL;
4377
Tim Peters33e0f382003-01-10 02:05:14 +00004378 basestate = PyString_FromStringAndSize((char *)self->data,
4379 _PyDateTime_DATETIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00004380 if (basestate != NULL) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004381 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004382 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00004383 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004384 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00004385 Py_DECREF(basestate);
4386 }
4387 return result;
4388}
4389
4390static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00004391datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00004392{
Guido van Rossum177e41a2003-01-30 22:06:23 +00004393 return Py_BuildValue("(ON)", self->ob_type, datetime_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00004394}
4395
Tim Petersa9bc1682003-01-11 03:39:11 +00004396static PyMethodDef datetime_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004397
Tim Peters2a799bf2002-12-16 20:18:38 +00004398 /* Class methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00004399
Tim Petersa9bc1682003-01-11 03:39:11 +00004400 {"now", (PyCFunction)datetime_now,
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004401 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
Neal Norwitz2fbe5372003-01-23 21:09:05 +00004402 PyDoc_STR("[tz] -> new datetime with tz's local day and time.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004403
Tim Petersa9bc1682003-01-11 03:39:11 +00004404 {"utcnow", (PyCFunction)datetime_utcnow,
4405 METH_NOARGS | METH_CLASS,
4406 PyDoc_STR("Return a new datetime representing UTC day and time.")},
4407
4408 {"fromtimestamp", (PyCFunction)datetime_fromtimestamp,
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004409 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
Tim Peters2a44a8d2003-01-23 20:53:10 +00004410 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004411
Tim Petersa9bc1682003-01-11 03:39:11 +00004412 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
4413 METH_VARARGS | METH_CLASS,
4414 PyDoc_STR("timestamp -> UTC datetime from a POSIX timestamp "
4415 "(like time.time()).")},
4416
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004417 {"strptime", (PyCFunction)datetime_strptime,
4418 METH_VARARGS | METH_CLASS,
4419 PyDoc_STR("string, format -> new datetime parsed from a string "
4420 "(like time.strptime()).")},
4421
Tim Petersa9bc1682003-01-11 03:39:11 +00004422 {"combine", (PyCFunction)datetime_combine,
4423 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4424 PyDoc_STR("date, time -> datetime with same date and time fields")},
4425
Tim Peters2a799bf2002-12-16 20:18:38 +00004426 /* Instance methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00004427
Tim Petersa9bc1682003-01-11 03:39:11 +00004428 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
4429 PyDoc_STR("Return date object with same year, month and day.")},
4430
4431 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
4432 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
4433
4434 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
4435 PyDoc_STR("Return time object with same time and tzinfo.")},
4436
4437 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
4438 PyDoc_STR("Return ctime() style string.")},
4439
4440 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004441 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
4442
Tim Petersa9bc1682003-01-11 03:39:11 +00004443 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004444 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
4445
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004446 {"isoformat", (PyCFunction)datetime_isoformat, METH_VARARGS | METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004447 PyDoc_STR("[sep] -> string in ISO 8601 format, "
4448 "YYYY-MM-DDTHH:MM:SS[.mmmmmm][+HH:MM].\n\n"
4449 "sep is used to separate the year from the time, and "
4450 "defaults to 'T'.")},
4451
Tim Petersa9bc1682003-01-11 03:39:11 +00004452 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004453 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
4454
Tim Petersa9bc1682003-01-11 03:39:11 +00004455 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004456 PyDoc_STR("Return self.tzinfo.tzname(self).")},
4457
Tim Petersa9bc1682003-01-11 03:39:11 +00004458 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004459 PyDoc_STR("Return self.tzinfo.dst(self).")},
4460
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004461 {"replace", (PyCFunction)datetime_replace, METH_VARARGS | METH_KEYWORDS,
Tim Petersa9bc1682003-01-11 03:39:11 +00004462 PyDoc_STR("Return datetime with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00004463
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004464 {"astimezone", (PyCFunction)datetime_astimezone, METH_VARARGS | METH_KEYWORDS,
Tim Peters80475bb2002-12-25 07:40:55 +00004465 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
4466
Guido van Rossum177e41a2003-01-30 22:06:23 +00004467 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
4468 PyDoc_STR("__reduce__() -> (cls, state)")},
4469
Tim Peters2a799bf2002-12-16 20:18:38 +00004470 {NULL, NULL}
4471};
4472
Tim Petersa9bc1682003-01-11 03:39:11 +00004473static char datetime_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00004474PyDoc_STR("datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])\n\
4475\n\
4476The year, month and day arguments are required. tzinfo may be None, or an\n\
4477instance of a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00004478
Tim Petersa9bc1682003-01-11 03:39:11 +00004479static PyNumberMethods datetime_as_number = {
4480 datetime_add, /* nb_add */
4481 datetime_subtract, /* nb_subtract */
Tim Peters2a799bf2002-12-16 20:18:38 +00004482 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00004483 0, /* nb_remainder */
4484 0, /* nb_divmod */
4485 0, /* nb_power */
4486 0, /* nb_negative */
4487 0, /* nb_positive */
4488 0, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +00004489 0, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00004490};
4491
Neal Norwitz227b5332006-03-22 09:28:35 +00004492static PyTypeObject PyDateTime_DateTimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004493 PyObject_HEAD_INIT(NULL)
4494 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00004495 "datetime.datetime", /* tp_name */
Tim Petersa9bc1682003-01-11 03:39:11 +00004496 sizeof(PyDateTime_DateTime), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00004497 0, /* tp_itemsize */
Tim Petersa9bc1682003-01-11 03:39:11 +00004498 (destructor)datetime_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004499 0, /* tp_print */
4500 0, /* tp_getattr */
4501 0, /* tp_setattr */
4502 0, /* tp_compare */
Tim Petersa9bc1682003-01-11 03:39:11 +00004503 (reprfunc)datetime_repr, /* tp_repr */
4504 &datetime_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00004505 0, /* tp_as_sequence */
4506 0, /* tp_as_mapping */
Tim Petersa9bc1682003-01-11 03:39:11 +00004507 (hashfunc)datetime_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00004508 0, /* tp_call */
Tim Petersa9bc1682003-01-11 03:39:11 +00004509 (reprfunc)datetime_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00004510 PyObject_GenericGetAttr, /* tp_getattro */
4511 0, /* tp_setattro */
4512 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00004513 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Petersa9bc1682003-01-11 03:39:11 +00004514 datetime_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004515 0, /* tp_traverse */
4516 0, /* tp_clear */
Guido van Rossum19960592006-08-24 17:29:38 +00004517 datetime_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00004518 0, /* tp_weaklistoffset */
4519 0, /* tp_iter */
4520 0, /* tp_iternext */
Tim Petersa9bc1682003-01-11 03:39:11 +00004521 datetime_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00004522 0, /* tp_members */
Tim Petersa9bc1682003-01-11 03:39:11 +00004523 datetime_getset, /* tp_getset */
4524 &PyDateTime_DateType, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00004525 0, /* tp_dict */
4526 0, /* tp_descr_get */
4527 0, /* tp_descr_set */
4528 0, /* tp_dictoffset */
4529 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00004530 datetime_alloc, /* tp_alloc */
Tim Petersa9bc1682003-01-11 03:39:11 +00004531 datetime_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00004532 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00004533};
4534
4535/* ---------------------------------------------------------------------------
4536 * Module methods and initialization.
4537 */
4538
4539static PyMethodDef module_methods[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004540 {NULL, NULL}
4541};
4542
Tim Peters9ddf40b2004-06-20 22:41:32 +00004543/* C API. Clients get at this via PyDateTime_IMPORT, defined in
4544 * datetime.h.
4545 */
4546static PyDateTime_CAPI CAPI = {
4547 &PyDateTime_DateType,
4548 &PyDateTime_DateTimeType,
4549 &PyDateTime_TimeType,
4550 &PyDateTime_DeltaType,
4551 &PyDateTime_TZInfoType,
4552 new_date_ex,
4553 new_datetime_ex,
4554 new_time_ex,
4555 new_delta_ex,
4556 datetime_fromtimestamp,
4557 date_fromtimestamp
4558};
4559
4560
Tim Peters2a799bf2002-12-16 20:18:38 +00004561PyMODINIT_FUNC
4562initdatetime(void)
4563{
4564 PyObject *m; /* a module object */
4565 PyObject *d; /* its dict */
4566 PyObject *x;
4567
Tim Peters2a799bf2002-12-16 20:18:38 +00004568 m = Py_InitModule3("datetime", module_methods,
4569 "Fast implementation of the datetime type.");
Neal Norwitz1ac754f2006-01-19 06:09:39 +00004570 if (m == NULL)
4571 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004572
4573 if (PyType_Ready(&PyDateTime_DateType) < 0)
4574 return;
4575 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
4576 return;
4577 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
4578 return;
4579 if (PyType_Ready(&PyDateTime_TimeType) < 0)
4580 return;
4581 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
4582 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004583
Tim Peters2a799bf2002-12-16 20:18:38 +00004584 /* timedelta values */
4585 d = PyDateTime_DeltaType.tp_dict;
4586
Tim Peters2a799bf2002-12-16 20:18:38 +00004587 x = new_delta(0, 0, 1, 0);
4588 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4589 return;
4590 Py_DECREF(x);
4591
4592 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
4593 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4594 return;
4595 Py_DECREF(x);
4596
4597 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
4598 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4599 return;
4600 Py_DECREF(x);
4601
4602 /* date values */
4603 d = PyDateTime_DateType.tp_dict;
4604
4605 x = new_date(1, 1, 1);
4606 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4607 return;
4608 Py_DECREF(x);
4609
4610 x = new_date(MAXYEAR, 12, 31);
4611 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4612 return;
4613 Py_DECREF(x);
4614
4615 x = new_delta(1, 0, 0, 0);
4616 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4617 return;
4618 Py_DECREF(x);
4619
Tim Peters37f39822003-01-10 03:49:02 +00004620 /* time values */
4621 d = PyDateTime_TimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004622
Tim Peters37f39822003-01-10 03:49:02 +00004623 x = new_time(0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004624 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4625 return;
4626 Py_DECREF(x);
4627
Tim Peters37f39822003-01-10 03:49:02 +00004628 x = new_time(23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004629 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4630 return;
4631 Py_DECREF(x);
4632
4633 x = new_delta(0, 0, 1, 0);
4634 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4635 return;
4636 Py_DECREF(x);
4637
Tim Petersa9bc1682003-01-11 03:39:11 +00004638 /* datetime values */
4639 d = PyDateTime_DateTimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004640
Tim Petersa9bc1682003-01-11 03:39:11 +00004641 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004642 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4643 return;
4644 Py_DECREF(x);
4645
Tim Petersa9bc1682003-01-11 03:39:11 +00004646 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004647 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4648 return;
4649 Py_DECREF(x);
4650
4651 x = new_delta(0, 0, 1, 0);
4652 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4653 return;
4654 Py_DECREF(x);
4655
Tim Peters2a799bf2002-12-16 20:18:38 +00004656 /* module initialization */
4657 PyModule_AddIntConstant(m, "MINYEAR", MINYEAR);
4658 PyModule_AddIntConstant(m, "MAXYEAR", MAXYEAR);
4659
4660 Py_INCREF(&PyDateTime_DateType);
4661 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
4662
Tim Petersa9bc1682003-01-11 03:39:11 +00004663 Py_INCREF(&PyDateTime_DateTimeType);
4664 PyModule_AddObject(m, "datetime",
4665 (PyObject *)&PyDateTime_DateTimeType);
4666
4667 Py_INCREF(&PyDateTime_TimeType);
4668 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
4669
Tim Peters2a799bf2002-12-16 20:18:38 +00004670 Py_INCREF(&PyDateTime_DeltaType);
4671 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
4672
Tim Peters2a799bf2002-12-16 20:18:38 +00004673 Py_INCREF(&PyDateTime_TZInfoType);
4674 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
4675
Tim Peters9ddf40b2004-06-20 22:41:32 +00004676 x = PyCObject_FromVoidPtrAndDesc(&CAPI, (void*) DATETIME_API_MAGIC,
4677 NULL);
4678 if (x == NULL)
4679 return;
4680 PyModule_AddObject(m, "datetime_CAPI", x);
4681
Tim Peters2a799bf2002-12-16 20:18:38 +00004682 /* A 4-year cycle has an extra leap day over what we'd get from
4683 * pasting together 4 single years.
4684 */
4685 assert(DI4Y == 4 * 365 + 1);
4686 assert(DI4Y == days_before_year(4+1));
4687
4688 /* Similarly, a 400-year cycle has an extra leap day over what we'd
4689 * get from pasting together 4 100-year cycles.
4690 */
4691 assert(DI400Y == 4 * DI100Y + 1);
4692 assert(DI400Y == days_before_year(400+1));
4693
4694 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
4695 * pasting together 25 4-year cycles.
4696 */
4697 assert(DI100Y == 25 * DI4Y - 1);
4698 assert(DI100Y == days_before_year(100+1));
4699
4700 us_per_us = PyInt_FromLong(1);
4701 us_per_ms = PyInt_FromLong(1000);
4702 us_per_second = PyInt_FromLong(1000000);
4703 us_per_minute = PyInt_FromLong(60000000);
4704 seconds_per_day = PyInt_FromLong(24 * 3600);
4705 if (us_per_us == NULL || us_per_ms == NULL || us_per_second == NULL ||
4706 us_per_minute == NULL || seconds_per_day == NULL)
4707 return;
4708
4709 /* The rest are too big for 32-bit ints, but even
4710 * us_per_week fits in 40 bits, so doubles should be exact.
4711 */
4712 us_per_hour = PyLong_FromDouble(3600000000.0);
4713 us_per_day = PyLong_FromDouble(86400000000.0);
4714 us_per_week = PyLong_FromDouble(604800000000.0);
4715 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
4716 return;
4717}
Tim Petersf3615152003-01-01 21:51:37 +00004718
4719/* ---------------------------------------------------------------------------
Tim Petersa9bc1682003-01-11 03:39:11 +00004720Some time zone algebra. For a datetime x, let
Tim Petersf3615152003-01-01 21:51:37 +00004721 x.n = x stripped of its timezone -- its naive time.
4722 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
4723 return None
4724 x.d = x.dst(), and assuming that doesn't raise an exception or
4725 return None
4726 x.s = x's standard offset, x.o - x.d
4727
4728Now some derived rules, where k is a duration (timedelta).
4729
47301. x.o = x.s + x.d
4731 This follows from the definition of x.s.
4732
Tim Petersc5dc4da2003-01-02 17:55:03 +000047332. If x and y have the same tzinfo member, x.s = y.s.
Tim Petersf3615152003-01-01 21:51:37 +00004734 This is actually a requirement, an assumption we need to make about
4735 sane tzinfo classes.
4736
47373. The naive UTC time corresponding to x is x.n - x.o.
4738 This is again a requirement for a sane tzinfo class.
4739
47404. (x+k).s = x.s
Tim Peters8bb5ad22003-01-24 02:44:45 +00004741 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
Tim Petersf3615152003-01-01 21:51:37 +00004742
Tim Petersc5dc4da2003-01-02 17:55:03 +000047435. (x+k).n = x.n + k
Tim Petersf3615152003-01-01 21:51:37 +00004744 Again follows from how arithmetic is defined.
4745
Tim Peters8bb5ad22003-01-24 02:44:45 +00004746Now we can explain tz.fromutc(x). Let's assume it's an interesting case
Tim Petersf3615152003-01-01 21:51:37 +00004747(meaning that the various tzinfo methods exist, and don't blow up or return
4748None when called).
4749
Tim Petersa9bc1682003-01-11 03:39:11 +00004750The function wants to return a datetime y with timezone tz, equivalent to x.
Tim Peters8bb5ad22003-01-24 02:44:45 +00004751x is already in UTC.
Tim Petersf3615152003-01-01 21:51:37 +00004752
4753By #3, we want
4754
Tim Peters8bb5ad22003-01-24 02:44:45 +00004755 y.n - y.o = x.n [1]
Tim Petersf3615152003-01-01 21:51:37 +00004756
4757The algorithm starts by attaching tz to x.n, and calling that y. So
4758x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
4759becomes true; in effect, we want to solve [2] for k:
4760
Tim Peters8bb5ad22003-01-24 02:44:45 +00004761 (y+k).n - (y+k).o = x.n [2]
Tim Petersf3615152003-01-01 21:51:37 +00004762
4763By #1, this is the same as
4764
Tim Peters8bb5ad22003-01-24 02:44:45 +00004765 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
Tim Petersf3615152003-01-01 21:51:37 +00004766
4767By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
4768Substituting that into [3],
4769
Tim Peters8bb5ad22003-01-24 02:44:45 +00004770 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
4771 k - (y+k).s - (y+k).d = 0; rearranging,
4772 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
4773 k = y.s - (y+k).d
Tim Petersf3615152003-01-01 21:51:37 +00004774
Tim Peters8bb5ad22003-01-24 02:44:45 +00004775On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
4776approximate k by ignoring the (y+k).d term at first. Note that k can't be
4777very large, since all offset-returning methods return a duration of magnitude
4778less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
4779be 0, so ignoring it has no consequence then.
Tim Petersf3615152003-01-01 21:51:37 +00004780
4781In any case, the new value is
4782
Tim Peters8bb5ad22003-01-24 02:44:45 +00004783 z = y + y.s [4]
Tim Petersf3615152003-01-01 21:51:37 +00004784
Tim Peters8bb5ad22003-01-24 02:44:45 +00004785It's helpful to step back at look at [4] from a higher level: it's simply
4786mapping from UTC to tz's standard time.
Tim Petersc5dc4da2003-01-02 17:55:03 +00004787
4788At this point, if
4789
Tim Peters8bb5ad22003-01-24 02:44:45 +00004790 z.n - z.o = x.n [5]
Tim Petersc5dc4da2003-01-02 17:55:03 +00004791
4792we have an equivalent time, and are almost done. The insecurity here is
Tim Petersf3615152003-01-01 21:51:37 +00004793at the start of daylight time. Picture US Eastern for concreteness. The wall
4794time jumps from 1:59 to 3:00, and wall hours of the form 2:MM don't make good
Tim Peters8bb5ad22003-01-24 02:44:45 +00004795sense then. The docs ask that an Eastern tzinfo class consider such a time to
4796be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
4797on the day DST starts. We want to return the 1:MM EST spelling because that's
Tim Petersf3615152003-01-01 21:51:37 +00004798the only spelling that makes sense on the local wall clock.
4799
Tim Petersc5dc4da2003-01-02 17:55:03 +00004800In fact, if [5] holds at this point, we do have the standard-time spelling,
4801but that takes a bit of proof. We first prove a stronger result. What's the
4802difference between the LHS and RHS of [5]? Let
Tim Petersf3615152003-01-01 21:51:37 +00004803
Tim Peters8bb5ad22003-01-24 02:44:45 +00004804 diff = x.n - (z.n - z.o) [6]
Tim Petersf3615152003-01-01 21:51:37 +00004805
Tim Petersc5dc4da2003-01-02 17:55:03 +00004806Now
4807 z.n = by [4]
Tim Peters8bb5ad22003-01-24 02:44:45 +00004808 (y + y.s).n = by #5
4809 y.n + y.s = since y.n = x.n
4810 x.n + y.s = since z and y are have the same tzinfo member,
4811 y.s = z.s by #2
4812 x.n + z.s
Tim Petersf3615152003-01-01 21:51:37 +00004813
Tim Petersc5dc4da2003-01-02 17:55:03 +00004814Plugging that back into [6] gives
Tim Petersf3615152003-01-01 21:51:37 +00004815
Tim Petersc5dc4da2003-01-02 17:55:03 +00004816 diff =
Tim Peters8bb5ad22003-01-24 02:44:45 +00004817 x.n - ((x.n + z.s) - z.o) = expanding
4818 x.n - x.n - z.s + z.o = cancelling
4819 - z.s + z.o = by #2
Tim Petersc5dc4da2003-01-02 17:55:03 +00004820 z.d
Tim Petersf3615152003-01-01 21:51:37 +00004821
Tim Petersc5dc4da2003-01-02 17:55:03 +00004822So diff = z.d.
Tim Petersf3615152003-01-01 21:51:37 +00004823
Tim Petersc5dc4da2003-01-02 17:55:03 +00004824If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
Tim Peters8bb5ad22003-01-24 02:44:45 +00004825spelling we wanted in the endcase described above. We're done. Contrarily,
4826if z.d = 0, then we have a UTC equivalent, and are also done.
Tim Petersf3615152003-01-01 21:51:37 +00004827
Tim Petersc5dc4da2003-01-02 17:55:03 +00004828If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
4829add to z (in effect, z is in tz's standard time, and we need to shift the
Tim Peters8bb5ad22003-01-24 02:44:45 +00004830local clock into tz's daylight time).
Tim Petersf3615152003-01-01 21:51:37 +00004831
Tim Petersc5dc4da2003-01-02 17:55:03 +00004832Let
Tim Petersf3615152003-01-01 21:51:37 +00004833
Tim Peters4fede1a2003-01-04 00:26:59 +00004834 z' = z + z.d = z + diff [7]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004835
Tim Peters4fede1a2003-01-04 00:26:59 +00004836and we can again ask whether
Tim Petersc3bb26a2003-01-02 03:14:59 +00004837
Tim Peters8bb5ad22003-01-24 02:44:45 +00004838 z'.n - z'.o = x.n [8]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004839
Tim Peters8bb5ad22003-01-24 02:44:45 +00004840If so, we're done. If not, the tzinfo class is insane, according to the
4841assumptions we've made. This also requires a bit of proof. As before, let's
4842compute the difference between the LHS and RHS of [8] (and skipping some of
4843the justifications for the kinds of substitutions we've done several times
4844already):
Tim Peters4fede1a2003-01-04 00:26:59 +00004845
Tim Peters8bb5ad22003-01-24 02:44:45 +00004846 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
4847 x.n - (z.n + diff - z'.o) = replacing diff via [6]
4848 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
4849 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
4850 - z.n + z.n - z.o + z'.o = cancel z.n
Tim Peters4fede1a2003-01-04 00:26:59 +00004851 - z.o + z'.o = #1 twice
4852 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
4853 z'.d - z.d
4854
4855So z' is UTC-equivalent to x iff z'.d = z.d at this point. If they are equal,
Tim Peters8bb5ad22003-01-24 02:44:45 +00004856we've found the UTC-equivalent so are done. In fact, we stop with [7] and
4857return z', not bothering to compute z'.d.
Tim Peters4fede1a2003-01-04 00:26:59 +00004858
Tim Peters8bb5ad22003-01-24 02:44:45 +00004859How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
4860a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
4861would have to change the result dst() returns: we start in DST, and moving
4862a little further into it takes us out of DST.
Tim Peters4fede1a2003-01-04 00:26:59 +00004863
Tim Peters8bb5ad22003-01-24 02:44:45 +00004864There isn't a sane case where this can happen. The closest it gets is at
4865the end of DST, where there's an hour in UTC with no spelling in a hybrid
4866tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
4867that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
4868UTC) because the docs insist on that, but 0:MM is taken as being in daylight
4869time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
4870clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
4871standard time. Since that's what the local clock *does*, we want to map both
4872UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
Tim Peters4fede1a2003-01-04 00:26:59 +00004873in local time, but so it goes -- it's the way the local clock works.
4874
Tim Peters8bb5ad22003-01-24 02:44:45 +00004875When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
4876so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
4877z' = z + z.d = 1:MM then, and z'.d=0, and z'.d - z.d = -60 != 0 so [8]
Tim Peters4fede1a2003-01-04 00:26:59 +00004878(correctly) concludes that z' is not UTC-equivalent to x.
4879
4880Because we know z.d said z was in daylight time (else [5] would have held and
4881we would have stopped then), and we know z.d != z'.d (else [8] would have held
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00004882and we would have stopped then), and there are only 2 possible values dst() can
Tim Peters4fede1a2003-01-04 00:26:59 +00004883return in Eastern, it follows that z'.d must be 0 (which it is in the example,
4884but the reasoning doesn't depend on the example -- it depends on there being
4885two possible dst() outcomes, one zero and the other non-zero). Therefore
Tim Peters8bb5ad22003-01-24 02:44:45 +00004886z' must be in standard time, and is the spelling we want in this case.
4887
4888Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
4889concerned (because it takes z' as being in standard time rather than the
4890daylight time we intend here), but returning it gives the real-life "local
4891clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
4892tz.
4893
4894When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
4895the 1:MM standard time spelling we want.
4896
4897So how can this break? One of the assumptions must be violated. Two
4898possibilities:
4899
49001) [2] effectively says that y.s is invariant across all y belong to a given
4901 time zone. This isn't true if, for political reasons or continental drift,
4902 a region decides to change its base offset from UTC.
4903
49042) There may be versions of "double daylight" time where the tail end of
4905 the analysis gives up a step too early. I haven't thought about that
4906 enough to say.
4907
4908In any case, it's clear that the default fromutc() is strong enough to handle
4909"almost all" time zones: so long as the standard offset is invariant, it
4910doesn't matter if daylight time transition points change from year to year, or
4911if daylight time is skipped in some years; it doesn't matter how large or
4912small dst() may get within its bounds; and it doesn't even matter if some
4913perverse time zone returns a negative dst()). So a breaking case must be
4914pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
Tim Petersf3615152003-01-01 21:51:37 +00004915--------------------------------------------------------------------------- */