blob: 4113e84fd570f29c8fbf4833dfd0d70993423eda [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 */
Kristján Valur Jónsson7a0da192007-04-30 15:17:46 +000016#ifndef Py_BUILD_CORE
Tim Peters9ddf40b2004-06-20 22:41:32 +000017#define Py_BUILD_CORE
Kristján Valur Jónsson7a0da192007-04-30 15:17:46 +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'",
Martin v. Löwis68192102007-07-21 06:55:02 +0000767 Py_Type(p)->tp_name);
Tim Peters855fe882002-12-22 03:43:39 +0000768 return -1;
769}
770
Tim Petersbad8ff02002-12-30 20:52:32 +0000771/* Return tzinfo.methname(tzinfoarg), without any checking of results.
Tim Peters855fe882002-12-22 03:43:39 +0000772 * If tzinfo is None, returns None.
773 */
774static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000775call_tzinfo_method(PyObject *tzinfo, char *methname, PyObject *tzinfoarg)
Tim Peters855fe882002-12-22 03:43:39 +0000776{
777 PyObject *result;
778
Tim Petersbad8ff02002-12-30 20:52:32 +0000779 assert(tzinfo && methname && tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000780 assert(check_tzinfo_subclass(tzinfo) >= 0);
781 if (tzinfo == Py_None) {
782 result = Py_None;
783 Py_INCREF(result);
784 }
785 else
Tim Petersbad8ff02002-12-30 20:52:32 +0000786 result = PyObject_CallMethod(tzinfo, methname, "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000787 return result;
788}
789
Tim Peters2a799bf2002-12-16 20:18:38 +0000790/* If self has a tzinfo member, return a BORROWED reference to it. Else
791 * return NULL, which is NOT AN ERROR. There are no error returns here,
792 * and the caller must not decref the result.
793 */
794static PyObject *
795get_tzinfo_member(PyObject *self)
796{
797 PyObject *tzinfo = NULL;
798
Tim Petersa9bc1682003-01-11 03:39:11 +0000799 if (PyDateTime_Check(self) && HASTZINFO(self))
800 tzinfo = ((PyDateTime_DateTime *)self)->tzinfo;
Tim Petersa032d2e2003-01-11 00:15:54 +0000801 else if (PyTime_Check(self) && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +0000802 tzinfo = ((PyDateTime_Time *)self)->tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000803
804 return tzinfo;
805}
806
Tim Petersbad8ff02002-12-30 20:52:32 +0000807/* Call getattr(tzinfo, name)(tzinfoarg), and extract an int from the
Tim Peters2a799bf2002-12-16 20:18:38 +0000808 * result. tzinfo must be an instance of the tzinfo class. If the method
809 * returns None, this returns 0 and sets *none to 1. If the method doesn't
Tim Peters397301e2003-01-02 21:28:08 +0000810 * return None or timedelta, TypeError is raised and this returns -1. If it
811 * returnsa timedelta and the value is out of range or isn't a whole number
812 * of minutes, ValueError is raised and this returns -1.
Tim Peters2a799bf2002-12-16 20:18:38 +0000813 * Else *none is set to 0 and the integer method result is returned.
814 */
815static int
816call_utc_tzinfo_method(PyObject *tzinfo, char *name, PyObject *tzinfoarg,
817 int *none)
818{
819 PyObject *u;
Tim Peters397301e2003-01-02 21:28:08 +0000820 int result = -1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000821
822 assert(tzinfo != NULL);
823 assert(PyTZInfo_Check(tzinfo));
824 assert(tzinfoarg != NULL);
825
826 *none = 0;
Tim Petersbad8ff02002-12-30 20:52:32 +0000827 u = call_tzinfo_method(tzinfo, name, tzinfoarg);
Tim Peters2a799bf2002-12-16 20:18:38 +0000828 if (u == NULL)
829 return -1;
830
Tim Peters27362852002-12-23 16:17:39 +0000831 else if (u == Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +0000832 result = 0;
833 *none = 1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000834 }
Tim Peters855fe882002-12-22 03:43:39 +0000835 else if (PyDelta_Check(u)) {
836 const int days = GET_TD_DAYS(u);
837 if (days < -1 || days > 0)
838 result = 24*60; /* trigger ValueError below */
839 else {
840 /* next line can't overflow because we know days
841 * is -1 or 0 now
842 */
843 int ss = days * 24 * 3600 + GET_TD_SECONDS(u);
844 result = divmod(ss, 60, &ss);
845 if (ss || GET_TD_MICROSECONDS(u)) {
846 PyErr_Format(PyExc_ValueError,
847 "tzinfo.%s() must return a "
848 "whole number of minutes",
849 name);
850 result = -1;
Tim Peters855fe882002-12-22 03:43:39 +0000851 }
852 }
853 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000854 else {
855 PyErr_Format(PyExc_TypeError,
Tim Peters397301e2003-01-02 21:28:08 +0000856 "tzinfo.%s() must return None or "
Tim Peters855fe882002-12-22 03:43:39 +0000857 "timedelta, not '%s'",
Martin v. Löwis68192102007-07-21 06:55:02 +0000858 name, Py_Type(u)->tp_name);
Tim Peters2a799bf2002-12-16 20:18:38 +0000859 }
860
Tim Peters2a799bf2002-12-16 20:18:38 +0000861 Py_DECREF(u);
862 if (result < -1439 || result > 1439) {
863 PyErr_Format(PyExc_ValueError,
Neal Norwitz506a2242003-01-04 01:02:25 +0000864 "tzinfo.%s() returned %d; must be in "
Tim Peters2a799bf2002-12-16 20:18:38 +0000865 "-1439 .. 1439",
866 name, result);
867 result = -1;
868 }
Tim Peters397301e2003-01-02 21:28:08 +0000869 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +0000870}
871
872/* Call tzinfo.utcoffset(tzinfoarg), and extract an integer from the
873 * result. tzinfo must be an instance of the tzinfo class. If utcoffset()
874 * returns None, call_utcoffset returns 0 and sets *none to 1. If uctoffset()
Tim Peters397301e2003-01-02 21:28:08 +0000875 * doesn't return None or timedelta, TypeError is raised and this returns -1.
876 * If utcoffset() returns an invalid timedelta (out of range, or not a whole
877 * # of minutes), ValueError is raised and this returns -1. Else *none is
878 * set to 0 and the offset is returned (as int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000879 */
880static int
881call_utcoffset(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
882{
883 return call_utc_tzinfo_method(tzinfo, "utcoffset", tzinfoarg, none);
884}
885
Tim Petersbad8ff02002-12-30 20:52:32 +0000886/* Call tzinfo.name(tzinfoarg), and return the offset as a timedelta or None.
887 */
Tim Peters855fe882002-12-22 03:43:39 +0000888static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000889offset_as_timedelta(PyObject *tzinfo, char *name, PyObject *tzinfoarg) {
Tim Peters855fe882002-12-22 03:43:39 +0000890 PyObject *result;
891
Tim Petersbad8ff02002-12-30 20:52:32 +0000892 assert(tzinfo && name && tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000893 if (tzinfo == Py_None) {
894 result = Py_None;
895 Py_INCREF(result);
896 }
897 else {
898 int none;
Tim Petersbad8ff02002-12-30 20:52:32 +0000899 int offset = call_utc_tzinfo_method(tzinfo, name, tzinfoarg,
900 &none);
Tim Peters855fe882002-12-22 03:43:39 +0000901 if (offset < 0 && PyErr_Occurred())
902 return NULL;
903 if (none) {
904 result = Py_None;
905 Py_INCREF(result);
906 }
907 else
908 result = new_delta(0, offset * 60, 0, 1);
909 }
910 return result;
911}
912
Tim Peters2a799bf2002-12-16 20:18:38 +0000913/* Call tzinfo.dst(tzinfoarg), and extract an integer from the
914 * result. tzinfo must be an instance of the tzinfo class. If dst()
915 * returns None, call_dst returns 0 and sets *none to 1. If dst()
Tim Peters397301e2003-01-02 21:28:08 +0000916 & doesn't return None or timedelta, TypeError is raised and this
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000917 * returns -1. If dst() returns an invalid timedelta for a UTC offset,
Tim Peters397301e2003-01-02 21:28:08 +0000918 * ValueError is raised and this returns -1. Else *none is set to 0 and
919 * the offset is returned (as an int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000920 */
921static int
922call_dst(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
923{
924 return call_utc_tzinfo_method(tzinfo, "dst", tzinfoarg, none);
925}
926
Tim Petersbad8ff02002-12-30 20:52:32 +0000927/* Call tzinfo.tzname(tzinfoarg), and return the result. tzinfo must be
Tim Peters855fe882002-12-22 03:43:39 +0000928 * an instance of the tzinfo class or None. If tzinfo isn't None, and
Tim Petersbad8ff02002-12-30 20:52:32 +0000929 * tzname() doesn't return None or a string, TypeError is raised and this
Tim Peters855fe882002-12-22 03:43:39 +0000930 * returns NULL.
Tim Peters2a799bf2002-12-16 20:18:38 +0000931 */
932static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000933call_tzname(PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +0000934{
935 PyObject *result;
936
937 assert(tzinfo != NULL);
Tim Peters855fe882002-12-22 03:43:39 +0000938 assert(check_tzinfo_subclass(tzinfo) >= 0);
Tim Petersbad8ff02002-12-30 20:52:32 +0000939 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000940
Tim Peters855fe882002-12-22 03:43:39 +0000941 if (tzinfo == Py_None) {
942 result = Py_None;
943 Py_INCREF(result);
944 }
945 else
Tim Petersbad8ff02002-12-30 20:52:32 +0000946 result = PyObject_CallMethod(tzinfo, "tzname", "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000947
948 if (result != NULL && result != Py_None && ! PyString_Check(result)) {
949 PyErr_Format(PyExc_TypeError, "tzinfo.tzname() must "
Tim Peters2a799bf2002-12-16 20:18:38 +0000950 "return None or a string, not '%s'",
Martin v. Löwis68192102007-07-21 06:55:02 +0000951 Py_Type(result)->tp_name);
Tim Peters2a799bf2002-12-16 20:18:38 +0000952 Py_DECREF(result);
953 result = NULL;
954 }
955 return result;
956}
957
958typedef enum {
959 /* an exception has been set; the caller should pass it on */
960 OFFSET_ERROR,
961
Tim Petersa9bc1682003-01-11 03:39:11 +0000962 /* type isn't date, datetime, or time subclass */
Tim Peters2a799bf2002-12-16 20:18:38 +0000963 OFFSET_UNKNOWN,
964
965 /* date,
Tim Petersa9bc1682003-01-11 03:39:11 +0000966 * datetime with !hastzinfo
967 * datetime with None tzinfo,
968 * datetime where utcoffset() returns None
Tim Peters37f39822003-01-10 03:49:02 +0000969 * time with !hastzinfo
970 * time with None tzinfo,
971 * time where utcoffset() returns None
Tim Peters2a799bf2002-12-16 20:18:38 +0000972 */
973 OFFSET_NAIVE,
974
Tim Petersa9bc1682003-01-11 03:39:11 +0000975 /* time or datetime where utcoffset() doesn't return None */
Georg Brandle810fe22006-02-19 15:28:47 +0000976 OFFSET_AWARE
Tim Peters2a799bf2002-12-16 20:18:38 +0000977} naivety;
978
Tim Peters14b69412002-12-22 18:10:22 +0000979/* Classify an object as to whether it's naive or offset-aware. See
Tim Peters2a799bf2002-12-16 20:18:38 +0000980 * the "naivety" typedef for details. If the type is aware, *offset is set
981 * to minutes east of UTC (as returned by the tzinfo.utcoffset() method).
Tim Peters14b69412002-12-22 18:10:22 +0000982 * If the type is offset-naive (or unknown, or error), *offset is set to 0.
Tim Peterse39a80c2002-12-30 21:28:52 +0000983 * tzinfoarg is the argument to pass to the tzinfo.utcoffset() method.
Tim Peters2a799bf2002-12-16 20:18:38 +0000984 */
985static naivety
Tim Peterse39a80c2002-12-30 21:28:52 +0000986classify_utcoffset(PyObject *op, PyObject *tzinfoarg, int *offset)
Tim Peters2a799bf2002-12-16 20:18:38 +0000987{
988 int none;
989 PyObject *tzinfo;
990
Tim Peterse39a80c2002-12-30 21:28:52 +0000991 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000992 *offset = 0;
Tim Peters14b69412002-12-22 18:10:22 +0000993 tzinfo = get_tzinfo_member(op); /* NULL means no tzinfo, not error */
Tim Peters2a799bf2002-12-16 20:18:38 +0000994 if (tzinfo == Py_None)
995 return OFFSET_NAIVE;
Tim Peters14b69412002-12-22 18:10:22 +0000996 if (tzinfo == NULL) {
997 /* note that a datetime passes the PyDate_Check test */
998 return (PyTime_Check(op) || PyDate_Check(op)) ?
999 OFFSET_NAIVE : OFFSET_UNKNOWN;
1000 }
Tim Peterse39a80c2002-12-30 21:28:52 +00001001 *offset = call_utcoffset(tzinfo, tzinfoarg, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00001002 if (*offset == -1 && PyErr_Occurred())
1003 return OFFSET_ERROR;
1004 return none ? OFFSET_NAIVE : OFFSET_AWARE;
1005}
1006
Tim Peters00237032002-12-27 02:21:51 +00001007/* Classify two objects as to whether they're naive or offset-aware.
1008 * This isn't quite the same as calling classify_utcoffset() twice: for
1009 * binary operations (comparison and subtraction), we generally want to
1010 * ignore the tzinfo members if they're identical. This is by design,
1011 * so that results match "naive" expectations when mixing objects from a
1012 * single timezone. So in that case, this sets both offsets to 0 and
1013 * both naiveties to OFFSET_NAIVE.
1014 * The function returns 0 if everything's OK, and -1 on error.
1015 */
1016static int
1017classify_two_utcoffsets(PyObject *o1, int *offset1, naivety *n1,
Tim Peterse39a80c2002-12-30 21:28:52 +00001018 PyObject *tzinfoarg1,
1019 PyObject *o2, int *offset2, naivety *n2,
1020 PyObject *tzinfoarg2)
Tim Peters00237032002-12-27 02:21:51 +00001021{
1022 if (get_tzinfo_member(o1) == get_tzinfo_member(o2)) {
1023 *offset1 = *offset2 = 0;
1024 *n1 = *n2 = OFFSET_NAIVE;
1025 }
1026 else {
Tim Peterse39a80c2002-12-30 21:28:52 +00001027 *n1 = classify_utcoffset(o1, tzinfoarg1, offset1);
Tim Peters00237032002-12-27 02:21:51 +00001028 if (*n1 == OFFSET_ERROR)
1029 return -1;
Tim Peterse39a80c2002-12-30 21:28:52 +00001030 *n2 = classify_utcoffset(o2, tzinfoarg2, offset2);
Tim Peters00237032002-12-27 02:21:51 +00001031 if (*n2 == OFFSET_ERROR)
1032 return -1;
1033 }
1034 return 0;
1035}
1036
Tim Peters2a799bf2002-12-16 20:18:38 +00001037/* repr is like "someclass(arg1, arg2)". If tzinfo isn't None,
1038 * stuff
1039 * ", tzinfo=" + repr(tzinfo)
1040 * before the closing ")".
1041 */
1042static PyObject *
1043append_keyword_tzinfo(PyObject *repr, PyObject *tzinfo)
1044{
1045 PyObject *temp;
1046
1047 assert(PyString_Check(repr));
1048 assert(tzinfo);
1049 if (tzinfo == Py_None)
1050 return repr;
1051 /* Get rid of the trailing ')'. */
1052 assert(PyString_AsString(repr)[PyString_Size(repr)-1] == ')');
1053 temp = PyString_FromStringAndSize(PyString_AsString(repr),
1054 PyString_Size(repr) - 1);
1055 Py_DECREF(repr);
1056 if (temp == NULL)
1057 return NULL;
1058 repr = temp;
1059
1060 /* Append ", tzinfo=". */
1061 PyString_ConcatAndDel(&repr, PyString_FromString(", tzinfo="));
1062
1063 /* Append repr(tzinfo). */
1064 PyString_ConcatAndDel(&repr, PyObject_Repr(tzinfo));
1065
1066 /* Add a closing paren. */
1067 PyString_ConcatAndDel(&repr, PyString_FromString(")"));
1068 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
1086 char buffer[128];
1087 int wday = weekday(GET_YEAR(date), GET_MONTH(date), GET_DAY(date));
1088
1089 PyOS_snprintf(buffer, sizeof(buffer), "%s %s %2d %02d:%02d:%02d %04d",
1090 DayNames[wday], MonthNames[GET_MONTH(date) - 1],
1091 GET_DAY(date), hours, minutes, seconds,
1092 GET_YEAR(date));
1093 return PyString_FromString(buffer);
1094}
1095
1096/* Add an hours & minutes UTC offset string to buf. buf has no more than
1097 * buflen bytes remaining. The UTC offset is gotten by calling
1098 * tzinfo.uctoffset(tzinfoarg). If that returns None, \0 is stored into
1099 * *buf, and that's all. Else the returned value is checked for sanity (an
1100 * integer in range), and if that's OK it's converted to an hours & minutes
1101 * string of the form
1102 * sign HH sep MM
1103 * Returns 0 if everything is OK. If the return value from utcoffset() is
1104 * bogus, an appropriate exception is set and -1 is returned.
1105 */
1106static int
Tim Peters328fff72002-12-20 01:31:27 +00001107format_utcoffset(char *buf, size_t buflen, const char *sep,
Tim Peters2a799bf2002-12-16 20:18:38 +00001108 PyObject *tzinfo, PyObject *tzinfoarg)
1109{
1110 int offset;
1111 int hours;
1112 int minutes;
1113 char sign;
1114 int none;
1115
1116 offset = call_utcoffset(tzinfo, tzinfoarg, &none);
1117 if (offset == -1 && PyErr_Occurred())
1118 return -1;
1119 if (none) {
1120 *buf = '\0';
1121 return 0;
1122 }
1123 sign = '+';
1124 if (offset < 0) {
1125 sign = '-';
1126 offset = - offset;
1127 }
1128 hours = divmod(offset, 60, &minutes);
1129 PyOS_snprintf(buf, buflen, "%c%02d%s%02d", sign, hours, sep, minutes);
1130 return 0;
1131}
1132
1133/* I sure don't want to reproduce the strftime code from the time module,
1134 * so this imports the module and calls it. All the hair is due to
1135 * giving special meanings to the %z and %Z format codes via a preprocessing
1136 * step on the format string.
Tim Petersbad8ff02002-12-30 20:52:32 +00001137 * tzinfoarg is the argument to pass to the object's tzinfo method, if
1138 * needed.
Tim Peters2a799bf2002-12-16 20:18:38 +00001139 */
1140static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +00001141wrap_strftime(PyObject *object, PyObject *format, PyObject *timetuple,
1142 PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001143{
1144 PyObject *result = NULL; /* guilty until proved innocent */
1145
1146 PyObject *zreplacement = NULL; /* py string, replacement for %z */
1147 PyObject *Zreplacement = NULL; /* py string, replacement for %Z */
1148
1149 char *pin; /* pointer to next char in input format */
1150 char ch; /* next char in input format */
1151
1152 PyObject *newfmt = NULL; /* py string, the output format */
1153 char *pnew; /* pointer to available byte in output format */
Georg Brandl4ddfcd32006-09-30 11:17:34 +00001154 int totalnew; /* number bytes total in output format buffer,
Tim Peters2a799bf2002-12-16 20:18:38 +00001155 exclusive of trailing \0 */
Georg Brandl4ddfcd32006-09-30 11:17:34 +00001156 int usednew; /* number bytes used so far in output format buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001157
1158 char *ptoappend; /* pointer to string to append to output buffer */
1159 int ntoappend; /* # of bytes to append to output buffer */
1160
Tim Peters2a799bf2002-12-16 20:18:38 +00001161 assert(object && format && timetuple);
1162 assert(PyString_Check(format));
1163
Tim Petersd6844152002-12-22 20:58:42 +00001164 /* Give up if the year is before 1900.
1165 * Python strftime() plays games with the year, and different
1166 * games depending on whether envar PYTHON2K is set. This makes
1167 * years before 1900 a nightmare, even if the platform strftime
1168 * supports them (and not all do).
1169 * We could get a lot farther here by avoiding Python's strftime
1170 * wrapper and calling the C strftime() directly, but that isn't
1171 * an option in the Python implementation of this module.
1172 */
1173 {
1174 long year;
1175 PyObject *pyyear = PySequence_GetItem(timetuple, 0);
1176 if (pyyear == NULL) return NULL;
1177 assert(PyInt_Check(pyyear));
1178 year = PyInt_AsLong(pyyear);
1179 Py_DECREF(pyyear);
1180 if (year < 1900) {
1181 PyErr_Format(PyExc_ValueError, "year=%ld is before "
1182 "1900; the datetime strftime() "
1183 "methods require year >= 1900",
1184 year);
1185 return NULL;
1186 }
1187 }
1188
Tim Peters2a799bf2002-12-16 20:18:38 +00001189 /* Scan the input format, looking for %z and %Z escapes, building
Tim Peters328fff72002-12-20 01:31:27 +00001190 * a new format. Since computing the replacements for those codes
1191 * is expensive, don't unless they're actually used.
Tim Peters2a799bf2002-12-16 20:18:38 +00001192 */
Raymond Hettingerf69d9f62003-06-27 08:14:17 +00001193 totalnew = PyString_Size(format) + 1; /* realistic if no %z/%Z */
Tim Peters2a799bf2002-12-16 20:18:38 +00001194 newfmt = PyString_FromStringAndSize(NULL, totalnew);
1195 if (newfmt == NULL) goto Done;
1196 pnew = PyString_AsString(newfmt);
1197 usednew = 0;
1198
1199 pin = PyString_AsString(format);
1200 while ((ch = *pin++) != '\0') {
1201 if (ch != '%') {
Tim Peters328fff72002-12-20 01:31:27 +00001202 ptoappend = pin - 1;
Tim Peters2a799bf2002-12-16 20:18:38 +00001203 ntoappend = 1;
1204 }
1205 else if ((ch = *pin++) == '\0') {
1206 /* There's a lone trailing %; doesn't make sense. */
1207 PyErr_SetString(PyExc_ValueError, "strftime format "
1208 "ends with raw %");
1209 goto Done;
1210 }
1211 /* A % has been seen and ch is the character after it. */
1212 else if (ch == 'z') {
1213 if (zreplacement == NULL) {
1214 /* format utcoffset */
Tim Peters328fff72002-12-20 01:31:27 +00001215 char buf[100];
Tim Peters2a799bf2002-12-16 20:18:38 +00001216 PyObject *tzinfo = get_tzinfo_member(object);
1217 zreplacement = PyString_FromString("");
1218 if (zreplacement == NULL) goto Done;
1219 if (tzinfo != Py_None && tzinfo != NULL) {
Tim Petersbad8ff02002-12-30 20:52:32 +00001220 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001221 if (format_utcoffset(buf,
Tim Peters328fff72002-12-20 01:31:27 +00001222 sizeof(buf),
Tim Peters2a799bf2002-12-16 20:18:38 +00001223 "",
1224 tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00001225 tzinfoarg) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00001226 goto Done;
1227 Py_DECREF(zreplacement);
1228 zreplacement = PyString_FromString(buf);
1229 if (zreplacement == NULL) goto Done;
1230 }
1231 }
1232 assert(zreplacement != NULL);
Neal Norwitzd5b0c9b2006-03-20 01:58:39 +00001233 ptoappend = PyString_AS_STRING(zreplacement);
1234 ntoappend = PyString_GET_SIZE(zreplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001235 }
1236 else if (ch == 'Z') {
1237 /* format tzname */
1238 if (Zreplacement == NULL) {
1239 PyObject *tzinfo = get_tzinfo_member(object);
1240 Zreplacement = PyString_FromString("");
1241 if (Zreplacement == NULL) goto Done;
1242 if (tzinfo != Py_None && tzinfo != NULL) {
Tim Petersbad8ff02002-12-30 20:52:32 +00001243 PyObject *temp;
1244 assert(tzinfoarg != NULL);
1245 temp = call_tzname(tzinfo, tzinfoarg);
Tim Peters2a799bf2002-12-16 20:18:38 +00001246 if (temp == NULL) goto Done;
1247 if (temp != Py_None) {
1248 assert(PyString_Check(temp));
1249 /* Since the tzname is getting
1250 * stuffed into the format, we
1251 * have to double any % signs
1252 * so that strftime doesn't
1253 * treat them as format codes.
1254 */
1255 Py_DECREF(Zreplacement);
1256 Zreplacement = PyObject_CallMethod(
1257 temp, "replace",
1258 "ss", "%", "%%");
1259 Py_DECREF(temp);
1260 if (Zreplacement == NULL)
1261 goto Done;
Neal Norwitzd5b0c9b2006-03-20 01:58:39 +00001262 if (!PyString_Check(Zreplacement)) {
1263 PyErr_SetString(PyExc_TypeError, "tzname.replace() did not return a string");
1264 goto Done;
1265 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001266 }
1267 else
1268 Py_DECREF(temp);
1269 }
1270 }
1271 assert(Zreplacement != NULL);
Neal Norwitzd5b0c9b2006-03-20 01:58:39 +00001272 ptoappend = PyString_AS_STRING(Zreplacement);
1273 ntoappend = PyString_GET_SIZE(Zreplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001274 }
1275 else {
Tim Peters328fff72002-12-20 01:31:27 +00001276 /* percent followed by neither z nor Z */
1277 ptoappend = pin - 2;
Tim Peters2a799bf2002-12-16 20:18:38 +00001278 ntoappend = 2;
1279 }
1280
1281 /* Append the ntoappend chars starting at ptoappend to
1282 * the new format.
1283 */
Neal Norwitzd5b0c9b2006-03-20 01:58:39 +00001284 assert(ptoappend != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001285 assert(ntoappend >= 0);
1286 if (ntoappend == 0)
1287 continue;
1288 while (usednew + ntoappend > totalnew) {
1289 int bigger = totalnew << 1;
1290 if ((bigger >> 1) != totalnew) { /* overflow */
1291 PyErr_NoMemory();
1292 goto Done;
1293 }
1294 if (_PyString_Resize(&newfmt, bigger) < 0)
1295 goto Done;
1296 totalnew = bigger;
1297 pnew = PyString_AsString(newfmt) + usednew;
1298 }
1299 memcpy(pnew, ptoappend, ntoappend);
1300 pnew += ntoappend;
1301 usednew += ntoappend;
1302 assert(usednew <= totalnew);
1303 } /* end while() */
1304
1305 if (_PyString_Resize(&newfmt, usednew) < 0)
1306 goto Done;
1307 {
1308 PyObject *time = PyImport_ImportModule("time");
1309 if (time == NULL)
1310 goto Done;
1311 result = PyObject_CallMethod(time, "strftime", "OO",
1312 newfmt, timetuple);
1313 Py_DECREF(time);
1314 }
1315 Done:
1316 Py_XDECREF(zreplacement);
1317 Py_XDECREF(Zreplacement);
1318 Py_XDECREF(newfmt);
1319 return result;
1320}
1321
1322static char *
1323isoformat_date(PyDateTime_Date *dt, char buffer[], int bufflen)
1324{
1325 int x;
1326 x = PyOS_snprintf(buffer, bufflen,
1327 "%04d-%02d-%02d",
1328 GET_YEAR(dt), GET_MONTH(dt), GET_DAY(dt));
1329 return buffer + x;
1330}
1331
1332static void
1333isoformat_time(PyDateTime_DateTime *dt, char buffer[], int bufflen)
1334{
1335 int us = DATE_GET_MICROSECOND(dt);
1336
1337 PyOS_snprintf(buffer, bufflen,
1338 "%02d:%02d:%02d", /* 8 characters */
1339 DATE_GET_HOUR(dt),
1340 DATE_GET_MINUTE(dt),
1341 DATE_GET_SECOND(dt));
1342 if (us)
1343 PyOS_snprintf(buffer + 8, bufflen - 8, ".%06d", us);
1344}
1345
1346/* ---------------------------------------------------------------------------
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
1392/* For obscure reasons, we need to use tp_richcompare instead of tp_compare.
1393 * 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",
Martin v. Löwis68192102007-07-21 06:55:02 +00001424 Py_Type(a)->tp_name, Py_Type(b)->tp_name);
Tim Peters07534a62003-02-07 22:50:28 +00001425 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
1710/* This is more natural as a tp_compare, but doesn't work then: for whatever
1711 * reason, Python's try_3way_compare ignores tp_compare unless
1712 * PyInstance_Check returns true, but these aren't old-style classes.
1713 */
1714static PyObject *
1715delta_richcompare(PyDateTime_Delta *self, PyObject *other, int op)
1716{
Tim Peters07534a62003-02-07 22:50:28 +00001717 int diff = 42; /* nonsense */
Tim Peters2a799bf2002-12-16 20:18:38 +00001718
Tim Petersaa7d8492003-02-08 03:28:59 +00001719 if (PyDelta_Check(other)) {
Tim Peters07534a62003-02-07 22:50:28 +00001720 diff = GET_TD_DAYS(self) - GET_TD_DAYS(other);
1721 if (diff == 0) {
1722 diff = GET_TD_SECONDS(self) - GET_TD_SECONDS(other);
1723 if (diff == 0)
1724 diff = GET_TD_MICROSECONDS(self) -
1725 GET_TD_MICROSECONDS(other);
1726 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001727 }
Tim Peters07534a62003-02-07 22:50:28 +00001728 else if (op == Py_EQ || op == Py_NE)
1729 diff = 1; /* any non-zero value will do */
1730
1731 else /* stop this from falling back to address comparison */
1732 return cmperror((PyObject *)self, other);
1733
Tim Peters2a799bf2002-12-16 20:18:38 +00001734 return diff_to_bool(diff, op);
1735}
1736
1737static PyObject *delta_getstate(PyDateTime_Delta *self);
1738
1739static long
1740delta_hash(PyDateTime_Delta *self)
1741{
1742 if (self->hashcode == -1) {
1743 PyObject *temp = delta_getstate(self);
1744 if (temp != NULL) {
1745 self->hashcode = PyObject_Hash(temp);
1746 Py_DECREF(temp);
1747 }
1748 }
1749 return self->hashcode;
1750}
1751
1752static PyObject *
1753delta_multiply(PyObject *left, PyObject *right)
1754{
1755 PyObject *result = Py_NotImplemented;
1756
1757 if (PyDelta_Check(left)) {
1758 /* delta * ??? */
1759 if (PyInt_Check(right) || PyLong_Check(right))
1760 result = multiply_int_timedelta(right,
1761 (PyDateTime_Delta *) left);
1762 }
1763 else if (PyInt_Check(left) || PyLong_Check(left))
1764 result = multiply_int_timedelta(left,
1765 (PyDateTime_Delta *) right);
1766
1767 if (result == Py_NotImplemented)
1768 Py_INCREF(result);
1769 return result;
1770}
1771
1772static PyObject *
1773delta_divide(PyObject *left, PyObject *right)
1774{
1775 PyObject *result = Py_NotImplemented;
1776
1777 if (PyDelta_Check(left)) {
1778 /* delta * ??? */
1779 if (PyInt_Check(right) || PyLong_Check(right))
1780 result = divide_timedelta_int(
1781 (PyDateTime_Delta *)left,
1782 right);
1783 }
1784
1785 if (result == Py_NotImplemented)
1786 Py_INCREF(result);
1787 return result;
1788}
1789
1790/* Fold in the value of the tag ("seconds", "weeks", etc) component of a
1791 * timedelta constructor. sofar is the # of microseconds accounted for
1792 * so far, and there are factor microseconds per current unit, the number
1793 * of which is given by num. num * factor is added to sofar in a
1794 * numerically careful way, and that's the result. Any fractional
1795 * microseconds left over (this can happen if num is a float type) are
1796 * added into *leftover.
1797 * Note that there are many ways this can give an error (NULL) return.
1798 */
1799static PyObject *
1800accum(const char* tag, PyObject *sofar, PyObject *num, PyObject *factor,
1801 double *leftover)
1802{
1803 PyObject *prod;
1804 PyObject *sum;
1805
1806 assert(num != NULL);
1807
1808 if (PyInt_Check(num) || PyLong_Check(num)) {
1809 prod = PyNumber_Multiply(num, factor);
1810 if (prod == NULL)
1811 return NULL;
1812 sum = PyNumber_Add(sofar, prod);
1813 Py_DECREF(prod);
1814 return sum;
1815 }
1816
1817 if (PyFloat_Check(num)) {
1818 double dnum;
1819 double fracpart;
1820 double intpart;
1821 PyObject *x;
1822 PyObject *y;
1823
1824 /* The Plan: decompose num into an integer part and a
1825 * fractional part, num = intpart + fracpart.
1826 * Then num * factor ==
1827 * intpart * factor + fracpart * factor
1828 * and the LHS can be computed exactly in long arithmetic.
1829 * The RHS is again broken into an int part and frac part.
1830 * and the frac part is added into *leftover.
1831 */
1832 dnum = PyFloat_AsDouble(num);
1833 if (dnum == -1.0 && PyErr_Occurred())
1834 return NULL;
1835 fracpart = modf(dnum, &intpart);
1836 x = PyLong_FromDouble(intpart);
1837 if (x == NULL)
1838 return NULL;
1839
1840 prod = PyNumber_Multiply(x, factor);
1841 Py_DECREF(x);
1842 if (prod == NULL)
1843 return NULL;
1844
1845 sum = PyNumber_Add(sofar, prod);
1846 Py_DECREF(prod);
1847 if (sum == NULL)
1848 return NULL;
1849
1850 if (fracpart == 0.0)
1851 return sum;
1852 /* So far we've lost no information. Dealing with the
1853 * fractional part requires float arithmetic, and may
1854 * lose a little info.
1855 */
1856 assert(PyInt_Check(factor) || PyLong_Check(factor));
1857 if (PyInt_Check(factor))
1858 dnum = (double)PyInt_AsLong(factor);
1859 else
1860 dnum = PyLong_AsDouble(factor);
1861
1862 dnum *= fracpart;
1863 fracpart = modf(dnum, &intpart);
1864 x = PyLong_FromDouble(intpart);
1865 if (x == NULL) {
1866 Py_DECREF(sum);
1867 return NULL;
1868 }
1869
1870 y = PyNumber_Add(sum, x);
1871 Py_DECREF(sum);
1872 Py_DECREF(x);
1873 *leftover += fracpart;
1874 return y;
1875 }
1876
1877 PyErr_Format(PyExc_TypeError,
1878 "unsupported type for timedelta %s component: %s",
Martin v. Löwis68192102007-07-21 06:55:02 +00001879 tag, Py_Type(num)->tp_name);
Tim Peters2a799bf2002-12-16 20:18:38 +00001880 return NULL;
1881}
1882
1883static PyObject *
1884delta_new(PyTypeObject *type, PyObject *args, PyObject *kw)
1885{
1886 PyObject *self = NULL;
1887
1888 /* Argument objects. */
1889 PyObject *day = NULL;
1890 PyObject *second = NULL;
1891 PyObject *us = NULL;
1892 PyObject *ms = NULL;
1893 PyObject *minute = NULL;
1894 PyObject *hour = NULL;
1895 PyObject *week = NULL;
1896
1897 PyObject *x = NULL; /* running sum of microseconds */
1898 PyObject *y = NULL; /* temp sum of microseconds */
1899 double leftover_us = 0.0;
1900
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00001901 static char *keywords[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001902 "days", "seconds", "microseconds", "milliseconds",
1903 "minutes", "hours", "weeks", NULL
1904 };
1905
1906 if (PyArg_ParseTupleAndKeywords(args, kw, "|OOOOOOO:__new__",
1907 keywords,
1908 &day, &second, &us,
1909 &ms, &minute, &hour, &week) == 0)
1910 goto Done;
1911
1912 x = PyInt_FromLong(0);
1913 if (x == NULL)
1914 goto Done;
1915
1916#define CLEANUP \
1917 Py_DECREF(x); \
1918 x = y; \
1919 if (x == NULL) \
1920 goto Done
1921
1922 if (us) {
1923 y = accum("microseconds", x, us, us_per_us, &leftover_us);
1924 CLEANUP;
1925 }
1926 if (ms) {
1927 y = accum("milliseconds", x, ms, us_per_ms, &leftover_us);
1928 CLEANUP;
1929 }
1930 if (second) {
1931 y = accum("seconds", x, second, us_per_second, &leftover_us);
1932 CLEANUP;
1933 }
1934 if (minute) {
1935 y = accum("minutes", x, minute, us_per_minute, &leftover_us);
1936 CLEANUP;
1937 }
1938 if (hour) {
1939 y = accum("hours", x, hour, us_per_hour, &leftover_us);
1940 CLEANUP;
1941 }
1942 if (day) {
1943 y = accum("days", x, day, us_per_day, &leftover_us);
1944 CLEANUP;
1945 }
1946 if (week) {
1947 y = accum("weeks", x, week, us_per_week, &leftover_us);
1948 CLEANUP;
1949 }
1950 if (leftover_us) {
1951 /* Round to nearest whole # of us, and add into x. */
Tim Peters5d644dd2003-01-02 16:32:54 +00001952 PyObject *temp = PyLong_FromLong(round_to_long(leftover_us));
Tim Peters2a799bf2002-12-16 20:18:38 +00001953 if (temp == NULL) {
1954 Py_DECREF(x);
1955 goto Done;
1956 }
1957 y = PyNumber_Add(x, temp);
1958 Py_DECREF(temp);
1959 CLEANUP;
1960 }
1961
Tim Petersb0c854d2003-05-17 15:57:00 +00001962 self = microseconds_to_delta_ex(x, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001963 Py_DECREF(x);
1964Done:
1965 return self;
1966
1967#undef CLEANUP
1968}
1969
1970static int
1971delta_nonzero(PyDateTime_Delta *self)
1972{
1973 return (GET_TD_DAYS(self) != 0
1974 || GET_TD_SECONDS(self) != 0
1975 || GET_TD_MICROSECONDS(self) != 0);
1976}
1977
1978static PyObject *
1979delta_repr(PyDateTime_Delta *self)
1980{
1981 if (GET_TD_MICROSECONDS(self) != 0)
1982 return PyString_FromFormat("%s(%d, %d, %d)",
Martin v. Löwis68192102007-07-21 06:55:02 +00001983 Py_Type(self)->tp_name,
Tim Peters2a799bf2002-12-16 20:18:38 +00001984 GET_TD_DAYS(self),
1985 GET_TD_SECONDS(self),
1986 GET_TD_MICROSECONDS(self));
1987 if (GET_TD_SECONDS(self) != 0)
1988 return PyString_FromFormat("%s(%d, %d)",
Martin v. Löwis68192102007-07-21 06:55:02 +00001989 Py_Type(self)->tp_name,
Tim Peters2a799bf2002-12-16 20:18:38 +00001990 GET_TD_DAYS(self),
1991 GET_TD_SECONDS(self));
1992
1993 return PyString_FromFormat("%s(%d)",
Martin v. Löwis68192102007-07-21 06:55:02 +00001994 Py_Type(self)->tp_name,
Tim Peters2a799bf2002-12-16 20:18:38 +00001995 GET_TD_DAYS(self));
1996}
1997
1998static PyObject *
1999delta_str(PyDateTime_Delta *self)
2000{
2001 int days = GET_TD_DAYS(self);
2002 int seconds = GET_TD_SECONDS(self);
2003 int us = GET_TD_MICROSECONDS(self);
2004 int hours;
2005 int minutes;
Tim Petersba873472002-12-18 20:19:21 +00002006 char buf[100];
2007 char *pbuf = buf;
2008 size_t buflen = sizeof(buf);
2009 int n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002010
2011 minutes = divmod(seconds, 60, &seconds);
2012 hours = divmod(minutes, 60, &minutes);
2013
2014 if (days) {
Tim Petersba873472002-12-18 20:19:21 +00002015 n = PyOS_snprintf(pbuf, buflen, "%d day%s, ", days,
2016 (days == 1 || days == -1) ? "" : "s");
2017 if (n < 0 || (size_t)n >= buflen)
2018 goto Fail;
2019 pbuf += n;
2020 buflen -= (size_t)n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002021 }
2022
Tim Petersba873472002-12-18 20:19:21 +00002023 n = PyOS_snprintf(pbuf, buflen, "%d:%02d:%02d",
2024 hours, minutes, seconds);
2025 if (n < 0 || (size_t)n >= buflen)
2026 goto Fail;
2027 pbuf += n;
2028 buflen -= (size_t)n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002029
2030 if (us) {
Tim Petersba873472002-12-18 20:19:21 +00002031 n = PyOS_snprintf(pbuf, buflen, ".%06d", us);
2032 if (n < 0 || (size_t)n >= buflen)
2033 goto Fail;
2034 pbuf += n;
Tim Peters2a799bf2002-12-16 20:18:38 +00002035 }
2036
Tim Petersba873472002-12-18 20:19:21 +00002037 return PyString_FromStringAndSize(buf, pbuf - buf);
2038
2039 Fail:
2040 PyErr_SetString(PyExc_SystemError, "goofy result from PyOS_snprintf");
2041 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002042}
2043
Tim Peters371935f2003-02-01 01:52:50 +00002044/* Pickle support, a simple use of __reduce__. */
2045
Tim Petersb57f8f02003-02-01 02:54:15 +00002046/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002047static PyObject *
2048delta_getstate(PyDateTime_Delta *self)
2049{
2050 return Py_BuildValue("iii", GET_TD_DAYS(self),
2051 GET_TD_SECONDS(self),
2052 GET_TD_MICROSECONDS(self));
2053}
2054
Tim Peters2a799bf2002-12-16 20:18:38 +00002055static PyObject *
2056delta_reduce(PyDateTime_Delta* self)
2057{
Martin v. Löwis68192102007-07-21 06:55:02 +00002058 return Py_BuildValue("ON", Py_Type(self), delta_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002059}
2060
2061#define OFFSET(field) offsetof(PyDateTime_Delta, field)
2062
2063static PyMemberDef delta_members[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002064
Neal Norwitzdfb80862002-12-19 02:30:56 +00002065 {"days", T_INT, OFFSET(days), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002066 PyDoc_STR("Number of days.")},
2067
Neal Norwitzdfb80862002-12-19 02:30:56 +00002068 {"seconds", T_INT, OFFSET(seconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002069 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
2070
Neal Norwitzdfb80862002-12-19 02:30:56 +00002071 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002072 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
2073 {NULL}
2074};
2075
2076static PyMethodDef delta_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002077 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
2078 PyDoc_STR("__reduce__() -> (cls, state)")},
2079
Tim Peters2a799bf2002-12-16 20:18:38 +00002080 {NULL, NULL},
2081};
2082
2083static char delta_doc[] =
2084PyDoc_STR("Difference between two datetime values.");
2085
2086static PyNumberMethods delta_as_number = {
2087 delta_add, /* nb_add */
2088 delta_subtract, /* nb_subtract */
2089 delta_multiply, /* nb_multiply */
2090 delta_divide, /* nb_divide */
2091 0, /* nb_remainder */
2092 0, /* nb_divmod */
2093 0, /* nb_power */
2094 (unaryfunc)delta_negative, /* nb_negative */
2095 (unaryfunc)delta_positive, /* nb_positive */
2096 (unaryfunc)delta_abs, /* nb_absolute */
2097 (inquiry)delta_nonzero, /* nb_nonzero */
2098 0, /*nb_invert*/
2099 0, /*nb_lshift*/
2100 0, /*nb_rshift*/
2101 0, /*nb_and*/
2102 0, /*nb_xor*/
2103 0, /*nb_or*/
2104 0, /*nb_coerce*/
2105 0, /*nb_int*/
2106 0, /*nb_long*/
2107 0, /*nb_float*/
2108 0, /*nb_oct*/
2109 0, /*nb_hex*/
2110 0, /*nb_inplace_add*/
2111 0, /*nb_inplace_subtract*/
2112 0, /*nb_inplace_multiply*/
2113 0, /*nb_inplace_divide*/
2114 0, /*nb_inplace_remainder*/
2115 0, /*nb_inplace_power*/
2116 0, /*nb_inplace_lshift*/
2117 0, /*nb_inplace_rshift*/
2118 0, /*nb_inplace_and*/
2119 0, /*nb_inplace_xor*/
2120 0, /*nb_inplace_or*/
2121 delta_divide, /* nb_floor_divide */
2122 0, /* nb_true_divide */
2123 0, /* nb_inplace_floor_divide */
2124 0, /* nb_inplace_true_divide */
2125};
2126
2127static PyTypeObject PyDateTime_DeltaType = {
Martin v. Löwis68192102007-07-21 06:55:02 +00002128 PyVarObject_HEAD_INIT(NULL, 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00002129 "datetime.timedelta", /* tp_name */
2130 sizeof(PyDateTime_Delta), /* tp_basicsize */
2131 0, /* tp_itemsize */
2132 0, /* tp_dealloc */
2133 0, /* tp_print */
2134 0, /* tp_getattr */
2135 0, /* tp_setattr */
2136 0, /* tp_compare */
2137 (reprfunc)delta_repr, /* tp_repr */
2138 &delta_as_number, /* tp_as_number */
2139 0, /* tp_as_sequence */
2140 0, /* tp_as_mapping */
2141 (hashfunc)delta_hash, /* tp_hash */
2142 0, /* tp_call */
2143 (reprfunc)delta_str, /* tp_str */
2144 PyObject_GenericGetAttr, /* tp_getattro */
2145 0, /* tp_setattro */
2146 0, /* tp_as_buffer */
Tim Petersb0c854d2003-05-17 15:57:00 +00002147 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2148 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00002149 delta_doc, /* tp_doc */
2150 0, /* tp_traverse */
2151 0, /* tp_clear */
2152 (richcmpfunc)delta_richcompare, /* tp_richcompare */
2153 0, /* tp_weaklistoffset */
2154 0, /* tp_iter */
2155 0, /* tp_iternext */
2156 delta_methods, /* tp_methods */
2157 delta_members, /* tp_members */
2158 0, /* tp_getset */
2159 0, /* tp_base */
2160 0, /* tp_dict */
2161 0, /* tp_descr_get */
2162 0, /* tp_descr_set */
2163 0, /* tp_dictoffset */
2164 0, /* tp_init */
2165 0, /* tp_alloc */
2166 delta_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002167 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002168};
2169
2170/*
2171 * PyDateTime_Date implementation.
2172 */
2173
2174/* Accessor properties. */
2175
2176static PyObject *
2177date_year(PyDateTime_Date *self, void *unused)
2178{
2179 return PyInt_FromLong(GET_YEAR(self));
2180}
2181
2182static PyObject *
2183date_month(PyDateTime_Date *self, void *unused)
2184{
2185 return PyInt_FromLong(GET_MONTH(self));
2186}
2187
2188static PyObject *
2189date_day(PyDateTime_Date *self, void *unused)
2190{
2191 return PyInt_FromLong(GET_DAY(self));
2192}
2193
2194static PyGetSetDef date_getset[] = {
2195 {"year", (getter)date_year},
2196 {"month", (getter)date_month},
2197 {"day", (getter)date_day},
2198 {NULL}
2199};
2200
2201/* Constructors. */
2202
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002203static char *date_kws[] = {"year", "month", "day", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002204
Tim Peters2a799bf2002-12-16 20:18:38 +00002205static PyObject *
2206date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2207{
2208 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00002209 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00002210 int year;
2211 int month;
2212 int day;
2213
Guido van Rossum177e41a2003-01-30 22:06:23 +00002214 /* Check for invocation from pickle with __getstate__ state */
2215 if (PyTuple_GET_SIZE(args) == 1 &&
Tim Peters70533e22003-02-01 04:40:04 +00002216 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Tim Peters3f606292004-03-21 23:38:41 +00002217 PyString_GET_SIZE(state) == _PyDateTime_DATE_DATASIZE &&
2218 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00002219 {
Tim Peters70533e22003-02-01 04:40:04 +00002220 PyDateTime_Date *me;
2221
Tim Peters604c0132004-06-07 23:04:33 +00002222 me = (PyDateTime_Date *) (type->tp_alloc(type, 0));
Tim Peters70533e22003-02-01 04:40:04 +00002223 if (me != NULL) {
2224 char *pdata = PyString_AS_STRING(state);
2225 memcpy(me->data, pdata, _PyDateTime_DATE_DATASIZE);
2226 me->hashcode = -1;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002227 }
Tim Peters70533e22003-02-01 04:40:04 +00002228 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002229 }
2230
Tim Peters12bf3392002-12-24 05:41:27 +00002231 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00002232 &year, &month, &day)) {
2233 if (check_date_args(year, month, day) < 0)
2234 return NULL;
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002235 self = new_date_ex(year, month, day, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00002236 }
2237 return self;
2238}
2239
2240/* Return new date from localtime(t). */
2241static PyObject *
Tim Peters1b6f7a92004-06-20 02:50:16 +00002242date_local_from_time_t(PyObject *cls, double ts)
Tim Peters2a799bf2002-12-16 20:18:38 +00002243{
2244 struct tm *tm;
Tim Peters1b6f7a92004-06-20 02:50:16 +00002245 time_t t;
Tim Peters2a799bf2002-12-16 20:18:38 +00002246 PyObject *result = NULL;
2247
Tim Peters1b6f7a92004-06-20 02:50:16 +00002248 t = _PyTime_DoubleToTimet(ts);
2249 if (t == (time_t)-1 && PyErr_Occurred())
2250 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002251 tm = localtime(&t);
2252 if (tm)
2253 result = PyObject_CallFunction(cls, "iii",
2254 tm->tm_year + 1900,
2255 tm->tm_mon + 1,
2256 tm->tm_mday);
2257 else
2258 PyErr_SetString(PyExc_ValueError,
2259 "timestamp out of range for "
2260 "platform localtime() function");
2261 return result;
2262}
2263
2264/* Return new date from current time.
2265 * We say this is equivalent to fromtimestamp(time.time()), and the
2266 * only way to be sure of that is to *call* time.time(). That's not
2267 * generally the same as calling C's time.
2268 */
2269static PyObject *
2270date_today(PyObject *cls, PyObject *dummy)
2271{
2272 PyObject *time;
2273 PyObject *result;
2274
2275 time = time_time();
2276 if (time == NULL)
2277 return NULL;
2278
2279 /* Note well: today() is a class method, so this may not call
2280 * date.fromtimestamp. For example, it may call
2281 * datetime.fromtimestamp. That's why we need all the accuracy
2282 * time.time() delivers; if someone were gonzo about optimization,
2283 * date.today() could get away with plain C time().
2284 */
2285 result = PyObject_CallMethod(cls, "fromtimestamp", "O", time);
2286 Py_DECREF(time);
2287 return result;
2288}
2289
2290/* Return new date from given timestamp (Python timestamp -- a double). */
2291static PyObject *
2292date_fromtimestamp(PyObject *cls, PyObject *args)
2293{
2294 double timestamp;
2295 PyObject *result = NULL;
2296
2297 if (PyArg_ParseTuple(args, "d:fromtimestamp", &timestamp))
Tim Peters1b6f7a92004-06-20 02:50:16 +00002298 result = date_local_from_time_t(cls, timestamp);
Tim Peters2a799bf2002-12-16 20:18:38 +00002299 return result;
2300}
2301
2302/* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2303 * the ordinal is out of range.
2304 */
2305static PyObject *
2306date_fromordinal(PyObject *cls, PyObject *args)
2307{
2308 PyObject *result = NULL;
2309 int ordinal;
2310
2311 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2312 int year;
2313 int month;
2314 int day;
2315
2316 if (ordinal < 1)
2317 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2318 ">= 1");
2319 else {
2320 ord_to_ymd(ordinal, &year, &month, &day);
2321 result = PyObject_CallFunction(cls, "iii",
2322 year, month, day);
2323 }
2324 }
2325 return result;
2326}
2327
2328/*
2329 * Date arithmetic.
2330 */
2331
2332/* date + timedelta -> date. If arg negate is true, subtract the timedelta
2333 * instead.
2334 */
2335static PyObject *
2336add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
2337{
2338 PyObject *result = NULL;
2339 int year = GET_YEAR(date);
2340 int month = GET_MONTH(date);
2341 int deltadays = GET_TD_DAYS(delta);
2342 /* C-level overflow is impossible because |deltadays| < 1e9. */
2343 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
2344
2345 if (normalize_date(&year, &month, &day) >= 0)
2346 result = new_date(year, month, day);
2347 return result;
2348}
2349
2350static PyObject *
2351date_add(PyObject *left, PyObject *right)
2352{
2353 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2354 Py_INCREF(Py_NotImplemented);
2355 return Py_NotImplemented;
2356 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002357 if (PyDate_Check(left)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002358 /* date + ??? */
2359 if (PyDelta_Check(right))
2360 /* date + delta */
2361 return add_date_timedelta((PyDateTime_Date *) left,
2362 (PyDateTime_Delta *) right,
2363 0);
2364 }
2365 else {
2366 /* ??? + date
2367 * 'right' must be one of us, or we wouldn't have been called
2368 */
2369 if (PyDelta_Check(left))
2370 /* delta + date */
2371 return add_date_timedelta((PyDateTime_Date *) right,
2372 (PyDateTime_Delta *) left,
2373 0);
2374 }
2375 Py_INCREF(Py_NotImplemented);
2376 return Py_NotImplemented;
2377}
2378
2379static PyObject *
2380date_subtract(PyObject *left, PyObject *right)
2381{
2382 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2383 Py_INCREF(Py_NotImplemented);
2384 return Py_NotImplemented;
2385 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002386 if (PyDate_Check(left)) {
2387 if (PyDate_Check(right)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002388 /* date - date */
2389 int left_ord = ymd_to_ord(GET_YEAR(left),
2390 GET_MONTH(left),
2391 GET_DAY(left));
2392 int right_ord = ymd_to_ord(GET_YEAR(right),
2393 GET_MONTH(right),
2394 GET_DAY(right));
2395 return new_delta(left_ord - right_ord, 0, 0, 0);
2396 }
2397 if (PyDelta_Check(right)) {
2398 /* date - delta */
2399 return add_date_timedelta((PyDateTime_Date *) left,
2400 (PyDateTime_Delta *) right,
2401 1);
2402 }
2403 }
2404 Py_INCREF(Py_NotImplemented);
2405 return Py_NotImplemented;
2406}
2407
2408
2409/* Various ways to turn a date into a string. */
2410
2411static PyObject *
2412date_repr(PyDateTime_Date *self)
2413{
2414 char buffer[1028];
Skip Montanaro14f88992006-04-18 19:35:04 +00002415 const char *type_name;
Tim Peters2a799bf2002-12-16 20:18:38 +00002416
Martin v. Löwis68192102007-07-21 06:55:02 +00002417 type_name = Py_Type(self)->tp_name;
Tim Peters2a799bf2002-12-16 20:18:38 +00002418 PyOS_snprintf(buffer, sizeof(buffer), "%s(%d, %d, %d)",
Skip Montanaro14f88992006-04-18 19:35:04 +00002419 type_name,
Tim Peters2a799bf2002-12-16 20:18:38 +00002420 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2421
2422 return PyString_FromString(buffer);
2423}
2424
2425static PyObject *
2426date_isoformat(PyDateTime_Date *self)
2427{
2428 char buffer[128];
2429
2430 isoformat_date(self, buffer, sizeof(buffer));
2431 return PyString_FromString(buffer);
2432}
2433
Tim Peterse2df5ff2003-05-02 18:39:55 +00002434/* str() calls the appropriate isoformat() method. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002435static PyObject *
2436date_str(PyDateTime_Date *self)
2437{
2438 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
2439}
2440
2441
2442static PyObject *
2443date_ctime(PyDateTime_Date *self)
2444{
2445 return format_ctime(self, 0, 0, 0);
2446}
2447
2448static PyObject *
2449date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2450{
2451 /* This method can be inherited, and needs to call the
2452 * timetuple() method appropriate to self's class.
2453 */
2454 PyObject *result;
2455 PyObject *format;
2456 PyObject *tuple;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002457 static char *keywords[] = {"format", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00002458
2459 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
2460 &PyString_Type, &format))
2461 return NULL;
2462
2463 tuple = PyObject_CallMethod((PyObject *)self, "timetuple", "()");
2464 if (tuple == NULL)
2465 return NULL;
Tim Petersbad8ff02002-12-30 20:52:32 +00002466 result = wrap_strftime((PyObject *)self, format, tuple,
2467 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002468 Py_DECREF(tuple);
2469 return result;
2470}
2471
2472/* ISO methods. */
2473
2474static PyObject *
2475date_isoweekday(PyDateTime_Date *self)
2476{
2477 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2478
2479 return PyInt_FromLong(dow + 1);
2480}
2481
2482static PyObject *
2483date_isocalendar(PyDateTime_Date *self)
2484{
2485 int year = GET_YEAR(self);
2486 int week1_monday = iso_week1_monday(year);
2487 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
2488 int week;
2489 int day;
2490
2491 week = divmod(today - week1_monday, 7, &day);
2492 if (week < 0) {
2493 --year;
2494 week1_monday = iso_week1_monday(year);
2495 week = divmod(today - week1_monday, 7, &day);
2496 }
2497 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
2498 ++year;
2499 week = 0;
2500 }
2501 return Py_BuildValue("iii", year, week + 1, day + 1);
2502}
2503
2504/* Miscellaneous methods. */
2505
2506/* This is more natural as a tp_compare, but doesn't work then: for whatever
2507 * reason, Python's try_3way_compare ignores tp_compare unless
2508 * PyInstance_Check returns true, but these aren't old-style classes.
2509 */
2510static PyObject *
2511date_richcompare(PyDateTime_Date *self, PyObject *other, int op)
2512{
Tim Peters07534a62003-02-07 22:50:28 +00002513 int diff = 42; /* nonsense */
Tim Peters2a799bf2002-12-16 20:18:38 +00002514
Tim Peters07534a62003-02-07 22:50:28 +00002515 if (PyDate_Check(other))
2516 diff = memcmp(self->data, ((PyDateTime_Date *)other)->data,
2517 _PyDateTime_DATE_DATASIZE);
2518
2519 else if (PyObject_HasAttrString(other, "timetuple")) {
2520 /* A hook for other kinds of date objects. */
2521 Py_INCREF(Py_NotImplemented);
2522 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002523 }
Tim Peters07534a62003-02-07 22:50:28 +00002524 else if (op == Py_EQ || op == Py_NE)
2525 diff = 1; /* any non-zero value will do */
2526
2527 else /* stop this from falling back to address comparison */
2528 return cmperror((PyObject *)self, other);
2529
Tim Peters2a799bf2002-12-16 20:18:38 +00002530 return diff_to_bool(diff, op);
2531}
2532
2533static PyObject *
2534date_timetuple(PyDateTime_Date *self)
2535{
2536 return build_struct_time(GET_YEAR(self),
2537 GET_MONTH(self),
2538 GET_DAY(self),
2539 0, 0, 0, -1);
2540}
2541
Tim Peters12bf3392002-12-24 05:41:27 +00002542static PyObject *
2543date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2544{
2545 PyObject *clone;
2546 PyObject *tuple;
2547 int year = GET_YEAR(self);
2548 int month = GET_MONTH(self);
2549 int day = GET_DAY(self);
2550
2551 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
2552 &year, &month, &day))
2553 return NULL;
2554 tuple = Py_BuildValue("iii", year, month, day);
2555 if (tuple == NULL)
2556 return NULL;
Martin v. Löwis68192102007-07-21 06:55:02 +00002557 clone = date_new(Py_Type(self), tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00002558 Py_DECREF(tuple);
2559 return clone;
2560}
2561
Tim Peters2a799bf2002-12-16 20:18:38 +00002562static PyObject *date_getstate(PyDateTime_Date *self);
2563
2564static long
2565date_hash(PyDateTime_Date *self)
2566{
2567 if (self->hashcode == -1) {
2568 PyObject *temp = date_getstate(self);
2569 if (temp != NULL) {
2570 self->hashcode = PyObject_Hash(temp);
2571 Py_DECREF(temp);
2572 }
2573 }
2574 return self->hashcode;
2575}
2576
2577static PyObject *
2578date_toordinal(PyDateTime_Date *self)
2579{
2580 return PyInt_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
2581 GET_DAY(self)));
2582}
2583
2584static PyObject *
2585date_weekday(PyDateTime_Date *self)
2586{
2587 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2588
2589 return PyInt_FromLong(dow);
2590}
2591
Tim Peters371935f2003-02-01 01:52:50 +00002592/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002593
Tim Petersb57f8f02003-02-01 02:54:15 +00002594/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002595static PyObject *
2596date_getstate(PyDateTime_Date *self)
2597{
Guido van Rossum177e41a2003-01-30 22:06:23 +00002598 return Py_BuildValue(
2599 "(N)",
2600 PyString_FromStringAndSize((char *)self->data,
2601 _PyDateTime_DATE_DATASIZE));
Tim Peters2a799bf2002-12-16 20:18:38 +00002602}
2603
2604static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00002605date_reduce(PyDateTime_Date *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00002606{
Martin v. Löwis68192102007-07-21 06:55:02 +00002607 return Py_BuildValue("(ON)", Py_Type(self), date_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002608}
2609
2610static PyMethodDef date_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002611
Tim Peters2a799bf2002-12-16 20:18:38 +00002612 /* Class methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00002613
Tim Peters2a799bf2002-12-16 20:18:38 +00002614 {"fromtimestamp", (PyCFunction)date_fromtimestamp, METH_VARARGS |
2615 METH_CLASS,
2616 PyDoc_STR("timestamp -> local date from a POSIX timestamp (like "
2617 "time.time()).")},
2618
2619 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
2620 METH_CLASS,
2621 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
2622 "ordinal.")},
2623
2624 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
2625 PyDoc_STR("Current date or datetime: same as "
2626 "self.__class__.fromtimestamp(time.time()).")},
2627
2628 /* Instance methods: */
2629
2630 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
2631 PyDoc_STR("Return ctime() style string.")},
2632
Neal Norwitza84dcd72007-05-22 07:16:44 +00002633 {"strftime", (PyCFunction)date_strftime, METH_VARARGS | METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00002634 PyDoc_STR("format -> strftime() style string.")},
2635
2636 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
2637 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
2638
2639 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
2640 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
2641 "weekday.")},
2642
2643 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
2644 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
2645
2646 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
2647 PyDoc_STR("Return the day of the week represented by the date.\n"
2648 "Monday == 1 ... Sunday == 7")},
2649
2650 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
2651 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
2652 "1 is day 1.")},
2653
2654 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
2655 PyDoc_STR("Return the day of the week represented by the date.\n"
2656 "Monday == 0 ... Sunday == 6")},
2657
Neal Norwitza84dcd72007-05-22 07:16:44 +00002658 {"replace", (PyCFunction)date_replace, METH_VARARGS | METH_KEYWORDS,
Tim Peters12bf3392002-12-24 05:41:27 +00002659 PyDoc_STR("Return date with new specified fields.")},
2660
Guido van Rossum177e41a2003-01-30 22:06:23 +00002661 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
2662 PyDoc_STR("__reduce__() -> (cls, state)")},
2663
Tim Peters2a799bf2002-12-16 20:18:38 +00002664 {NULL, NULL}
2665};
2666
2667static char date_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00002668PyDoc_STR("date(year, month, day) --> date object");
Tim Peters2a799bf2002-12-16 20:18:38 +00002669
2670static PyNumberMethods date_as_number = {
2671 date_add, /* nb_add */
2672 date_subtract, /* nb_subtract */
2673 0, /* nb_multiply */
2674 0, /* nb_divide */
2675 0, /* nb_remainder */
2676 0, /* nb_divmod */
2677 0, /* nb_power */
2678 0, /* nb_negative */
2679 0, /* nb_positive */
2680 0, /* nb_absolute */
2681 0, /* nb_nonzero */
2682};
2683
2684static PyTypeObject PyDateTime_DateType = {
Martin v. Löwis68192102007-07-21 06:55:02 +00002685 PyVarObject_HEAD_INIT(NULL, 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00002686 "datetime.date", /* tp_name */
2687 sizeof(PyDateTime_Date), /* tp_basicsize */
2688 0, /* tp_itemsize */
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002689 0, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00002690 0, /* tp_print */
2691 0, /* tp_getattr */
2692 0, /* tp_setattr */
2693 0, /* tp_compare */
2694 (reprfunc)date_repr, /* tp_repr */
2695 &date_as_number, /* tp_as_number */
2696 0, /* tp_as_sequence */
2697 0, /* tp_as_mapping */
2698 (hashfunc)date_hash, /* tp_hash */
2699 0, /* tp_call */
2700 (reprfunc)date_str, /* tp_str */
2701 PyObject_GenericGetAttr, /* tp_getattro */
2702 0, /* tp_setattro */
2703 0, /* tp_as_buffer */
2704 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2705 Py_TPFLAGS_BASETYPE, /* tp_flags */
2706 date_doc, /* tp_doc */
2707 0, /* tp_traverse */
2708 0, /* tp_clear */
2709 (richcmpfunc)date_richcompare, /* tp_richcompare */
2710 0, /* tp_weaklistoffset */
2711 0, /* tp_iter */
2712 0, /* tp_iternext */
2713 date_methods, /* tp_methods */
2714 0, /* tp_members */
2715 date_getset, /* tp_getset */
2716 0, /* tp_base */
2717 0, /* tp_dict */
2718 0, /* tp_descr_get */
2719 0, /* tp_descr_set */
2720 0, /* tp_dictoffset */
2721 0, /* tp_init */
2722 0, /* tp_alloc */
2723 date_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002724 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002725};
2726
2727/*
Tim Peters2a799bf2002-12-16 20:18:38 +00002728 * PyDateTime_TZInfo implementation.
2729 */
2730
2731/* This is a pure abstract base class, so doesn't do anything beyond
2732 * raising NotImplemented exceptions. Real tzinfo classes need
2733 * to derive from this. This is mostly for clarity, and for efficiency in
Tim Petersa9bc1682003-01-11 03:39:11 +00002734 * datetime and time constructors (their tzinfo arguments need to
Tim Peters2a799bf2002-12-16 20:18:38 +00002735 * be subclasses of this tzinfo class, which is easy and quick to check).
2736 *
2737 * Note: For reasons having to do with pickling of subclasses, we have
2738 * to allow tzinfo objects to be instantiated. This wasn't an issue
2739 * in the Python implementation (__init__() could raise NotImplementedError
2740 * there without ill effect), but doing so in the C implementation hit a
2741 * brick wall.
2742 */
2743
2744static PyObject *
2745tzinfo_nogo(const char* methodname)
2746{
2747 PyErr_Format(PyExc_NotImplementedError,
2748 "a tzinfo subclass must implement %s()",
2749 methodname);
2750 return NULL;
2751}
2752
2753/* Methods. A subclass must implement these. */
2754
Tim Peters52dcce22003-01-23 16:36:11 +00002755static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002756tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
2757{
2758 return tzinfo_nogo("tzname");
2759}
2760
Tim Peters52dcce22003-01-23 16:36:11 +00002761static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002762tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
2763{
2764 return tzinfo_nogo("utcoffset");
2765}
2766
Tim Peters52dcce22003-01-23 16:36:11 +00002767static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002768tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
2769{
2770 return tzinfo_nogo("dst");
2771}
2772
Tim Peters52dcce22003-01-23 16:36:11 +00002773static PyObject *
2774tzinfo_fromutc(PyDateTime_TZInfo *self, PyDateTime_DateTime *dt)
2775{
2776 int y, m, d, hh, mm, ss, us;
2777
2778 PyObject *result;
2779 int off, dst;
2780 int none;
2781 int delta;
2782
2783 if (! PyDateTime_Check(dt)) {
2784 PyErr_SetString(PyExc_TypeError,
2785 "fromutc: argument must be a datetime");
2786 return NULL;
2787 }
2788 if (! HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
2789 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
2790 "is not self");
2791 return NULL;
2792 }
2793
2794 off = call_utcoffset(dt->tzinfo, (PyObject *)dt, &none);
2795 if (off == -1 && PyErr_Occurred())
2796 return NULL;
2797 if (none) {
2798 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2799 "utcoffset() result required");
2800 return NULL;
2801 }
2802
2803 dst = call_dst(dt->tzinfo, (PyObject *)dt, &none);
2804 if (dst == -1 && PyErr_Occurred())
2805 return NULL;
2806 if (none) {
2807 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2808 "dst() result required");
2809 return NULL;
2810 }
2811
2812 y = GET_YEAR(dt);
2813 m = GET_MONTH(dt);
2814 d = GET_DAY(dt);
2815 hh = DATE_GET_HOUR(dt);
2816 mm = DATE_GET_MINUTE(dt);
2817 ss = DATE_GET_SECOND(dt);
2818 us = DATE_GET_MICROSECOND(dt);
2819
2820 delta = off - dst;
2821 mm += delta;
2822 if ((mm < 0 || mm >= 60) &&
2823 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Petersb1049e82003-01-23 17:20:36 +00002824 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00002825 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2826 if (result == NULL)
2827 return result;
2828
2829 dst = call_dst(dt->tzinfo, result, &none);
2830 if (dst == -1 && PyErr_Occurred())
2831 goto Fail;
2832 if (none)
2833 goto Inconsistent;
2834 if (dst == 0)
2835 return result;
2836
2837 mm += dst;
2838 if ((mm < 0 || mm >= 60) &&
2839 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
2840 goto Fail;
2841 Py_DECREF(result);
2842 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2843 return result;
2844
2845Inconsistent:
2846 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave"
2847 "inconsistent results; cannot convert");
2848
2849 /* fall thru to failure */
2850Fail:
2851 Py_DECREF(result);
2852 return NULL;
2853}
2854
Tim Peters2a799bf2002-12-16 20:18:38 +00002855/*
2856 * Pickle support. This is solely so that tzinfo subclasses can use
Guido van Rossum177e41a2003-01-30 22:06:23 +00002857 * pickling -- tzinfo itself is supposed to be uninstantiable.
Tim Peters2a799bf2002-12-16 20:18:38 +00002858 */
2859
Guido van Rossum177e41a2003-01-30 22:06:23 +00002860static PyObject *
2861tzinfo_reduce(PyObject *self)
2862{
2863 PyObject *args, *state, *tmp;
2864 PyObject *getinitargs, *getstate;
Tim Peters2a799bf2002-12-16 20:18:38 +00002865
Guido van Rossum177e41a2003-01-30 22:06:23 +00002866 tmp = PyTuple_New(0);
2867 if (tmp == NULL)
2868 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002869
Guido van Rossum177e41a2003-01-30 22:06:23 +00002870 getinitargs = PyObject_GetAttrString(self, "__getinitargs__");
2871 if (getinitargs != NULL) {
2872 args = PyObject_CallObject(getinitargs, tmp);
2873 Py_DECREF(getinitargs);
2874 if (args == NULL) {
2875 Py_DECREF(tmp);
2876 return NULL;
2877 }
2878 }
2879 else {
2880 PyErr_Clear();
2881 args = tmp;
2882 Py_INCREF(args);
2883 }
2884
2885 getstate = PyObject_GetAttrString(self, "__getstate__");
2886 if (getstate != NULL) {
2887 state = PyObject_CallObject(getstate, tmp);
2888 Py_DECREF(getstate);
2889 if (state == NULL) {
2890 Py_DECREF(args);
2891 Py_DECREF(tmp);
2892 return NULL;
2893 }
2894 }
2895 else {
2896 PyObject **dictptr;
2897 PyErr_Clear();
2898 state = Py_None;
2899 dictptr = _PyObject_GetDictPtr(self);
2900 if (dictptr && *dictptr && PyDict_Size(*dictptr))
2901 state = *dictptr;
2902 Py_INCREF(state);
2903 }
2904
2905 Py_DECREF(tmp);
2906
2907 if (state == Py_None) {
2908 Py_DECREF(state);
Martin v. Löwis68192102007-07-21 06:55:02 +00002909 return Py_BuildValue("(ON)", Py_Type(self), args);
Guido van Rossum177e41a2003-01-30 22:06:23 +00002910 }
2911 else
Martin v. Löwis68192102007-07-21 06:55:02 +00002912 return Py_BuildValue("(ONN)", Py_Type(self), args, state);
Guido van Rossum177e41a2003-01-30 22:06:23 +00002913}
Tim Peters2a799bf2002-12-16 20:18:38 +00002914
2915static PyMethodDef tzinfo_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002916
Tim Peters2a799bf2002-12-16 20:18:38 +00002917 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
2918 PyDoc_STR("datetime -> string name of time zone.")},
2919
2920 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
2921 PyDoc_STR("datetime -> minutes east of UTC (negative for "
2922 "west of UTC).")},
2923
2924 {"dst", (PyCFunction)tzinfo_dst, METH_O,
2925 PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
2926
Tim Peters52dcce22003-01-23 16:36:11 +00002927 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
2928 PyDoc_STR("datetime in UTC -> datetime in local time.")},
2929
Guido van Rossum177e41a2003-01-30 22:06:23 +00002930 {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
2931 PyDoc_STR("-> (cls, state)")},
2932
Tim Peters2a799bf2002-12-16 20:18:38 +00002933 {NULL, NULL}
2934};
2935
2936static char tzinfo_doc[] =
2937PyDoc_STR("Abstract base class for time zone info objects.");
2938
Neal Norwitzce3d34d2003-02-04 20:45:17 +00002939statichere PyTypeObject PyDateTime_TZInfoType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00002940 PyObject_HEAD_INIT(NULL)
2941 0, /* ob_size */
2942 "datetime.tzinfo", /* tp_name */
2943 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
2944 0, /* tp_itemsize */
2945 0, /* tp_dealloc */
2946 0, /* tp_print */
2947 0, /* tp_getattr */
2948 0, /* tp_setattr */
2949 0, /* tp_compare */
2950 0, /* tp_repr */
2951 0, /* tp_as_number */
2952 0, /* tp_as_sequence */
2953 0, /* tp_as_mapping */
2954 0, /* tp_hash */
2955 0, /* tp_call */
2956 0, /* tp_str */
2957 PyObject_GenericGetAttr, /* tp_getattro */
2958 0, /* tp_setattro */
2959 0, /* tp_as_buffer */
2960 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
2961 Py_TPFLAGS_BASETYPE, /* tp_flags */
2962 tzinfo_doc, /* tp_doc */
2963 0, /* tp_traverse */
2964 0, /* tp_clear */
2965 0, /* tp_richcompare */
2966 0, /* tp_weaklistoffset */
2967 0, /* tp_iter */
2968 0, /* tp_iternext */
2969 tzinfo_methods, /* tp_methods */
2970 0, /* tp_members */
2971 0, /* tp_getset */
2972 0, /* tp_base */
2973 0, /* tp_dict */
2974 0, /* tp_descr_get */
2975 0, /* tp_descr_set */
2976 0, /* tp_dictoffset */
2977 0, /* tp_init */
2978 0, /* tp_alloc */
2979 PyType_GenericNew, /* tp_new */
2980 0, /* tp_free */
2981};
2982
2983/*
Tim Peters37f39822003-01-10 03:49:02 +00002984 * PyDateTime_Time implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00002985 */
2986
Tim Peters37f39822003-01-10 03:49:02 +00002987/* Accessor properties.
Tim Peters2a799bf2002-12-16 20:18:38 +00002988 */
2989
2990static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00002991time_hour(PyDateTime_Time *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00002992{
Tim Peters37f39822003-01-10 03:49:02 +00002993 return PyInt_FromLong(TIME_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002994}
2995
Tim Peters37f39822003-01-10 03:49:02 +00002996static PyObject *
2997time_minute(PyDateTime_Time *self, void *unused)
2998{
2999 return PyInt_FromLong(TIME_GET_MINUTE(self));
3000}
3001
3002/* The name time_second conflicted with some platform header file. */
3003static PyObject *
3004py_time_second(PyDateTime_Time *self, void *unused)
3005{
3006 return PyInt_FromLong(TIME_GET_SECOND(self));
3007}
3008
3009static PyObject *
3010time_microsecond(PyDateTime_Time *self, void *unused)
3011{
3012 return PyInt_FromLong(TIME_GET_MICROSECOND(self));
3013}
3014
3015static PyObject *
3016time_tzinfo(PyDateTime_Time *self, void *unused)
3017{
Tim Petersa032d2e2003-01-11 00:15:54 +00003018 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters37f39822003-01-10 03:49:02 +00003019 Py_INCREF(result);
3020 return result;
3021}
3022
3023static PyGetSetDef time_getset[] = {
3024 {"hour", (getter)time_hour},
3025 {"minute", (getter)time_minute},
3026 {"second", (getter)py_time_second},
3027 {"microsecond", (getter)time_microsecond},
3028 {"tzinfo", (getter)time_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003029 {NULL}
3030};
3031
3032/*
3033 * Constructors.
3034 */
3035
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003036static char *time_kws[] = {"hour", "minute", "second", "microsecond",
Tim Peters37f39822003-01-10 03:49:02 +00003037 "tzinfo", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00003038
Tim Peters2a799bf2002-12-16 20:18:38 +00003039static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003040time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003041{
3042 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003043 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003044 int hour = 0;
3045 int minute = 0;
3046 int second = 0;
3047 int usecond = 0;
3048 PyObject *tzinfo = Py_None;
3049
Guido van Rossum177e41a2003-01-30 22:06:23 +00003050 /* Check for invocation from pickle with __getstate__ state */
3051 if (PyTuple_GET_SIZE(args) >= 1 &&
3052 PyTuple_GET_SIZE(args) <= 2 &&
Tim Peters70533e22003-02-01 04:40:04 +00003053 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Armin Rigof4afb212005-11-07 07:15:48 +00003054 PyString_GET_SIZE(state) == _PyDateTime_TIME_DATASIZE &&
3055 ((unsigned char) (PyString_AS_STRING(state)[0])) < 24)
Guido van Rossum177e41a2003-01-30 22:06:23 +00003056 {
Tim Peters70533e22003-02-01 04:40:04 +00003057 PyDateTime_Time *me;
3058 char aware;
3059
3060 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003061 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003062 if (check_tzinfo_subclass(tzinfo) < 0) {
3063 PyErr_SetString(PyExc_TypeError, "bad "
3064 "tzinfo state arg");
3065 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003066 }
3067 }
Tim Peters70533e22003-02-01 04:40:04 +00003068 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003069 me = (PyDateTime_Time *) (type->tp_alloc(type, aware));
Tim Peters70533e22003-02-01 04:40:04 +00003070 if (me != NULL) {
3071 char *pdata = PyString_AS_STRING(state);
3072
3073 memcpy(me->data, pdata, _PyDateTime_TIME_DATASIZE);
3074 me->hashcode = -1;
3075 me->hastzinfo = aware;
3076 if (aware) {
3077 Py_INCREF(tzinfo);
3078 me->tzinfo = tzinfo;
3079 }
3080 }
3081 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003082 }
3083
Tim Peters37f39822003-01-10 03:49:02 +00003084 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO", time_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003085 &hour, &minute, &second, &usecond,
3086 &tzinfo)) {
3087 if (check_time_args(hour, minute, second, usecond) < 0)
3088 return NULL;
3089 if (check_tzinfo_subclass(tzinfo) < 0)
3090 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003091 self = new_time_ex(hour, minute, second, usecond, tzinfo,
3092 type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003093 }
3094 return self;
3095}
3096
3097/*
3098 * Destructor.
3099 */
3100
3101static void
Tim Peters37f39822003-01-10 03:49:02 +00003102time_dealloc(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003103{
Tim Petersa032d2e2003-01-11 00:15:54 +00003104 if (HASTZINFO(self)) {
Tim Peters37f39822003-01-10 03:49:02 +00003105 Py_XDECREF(self->tzinfo);
Neal Norwitz8e914d92003-01-10 15:29:16 +00003106 }
Martin v. Löwis68192102007-07-21 06:55:02 +00003107 Py_Type(self)->tp_free((PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003108}
3109
3110/*
Tim Peters855fe882002-12-22 03:43:39 +00003111 * Indirect access to tzinfo methods.
Tim Peters2a799bf2002-12-16 20:18:38 +00003112 */
3113
Tim Peters2a799bf2002-12-16 20:18:38 +00003114/* These are all METH_NOARGS, so don't need to check the arglist. */
3115static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003116time_utcoffset(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003117 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003118 "utcoffset", Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003119}
3120
3121static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003122time_dst(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003123 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003124 "dst", Py_None);
Tim Peters855fe882002-12-22 03:43:39 +00003125}
3126
3127static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003128time_tzname(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003129 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003130 Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003131}
3132
3133/*
Tim Peters37f39822003-01-10 03:49:02 +00003134 * Various ways to turn a time into a string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003135 */
3136
3137static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003138time_repr(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003139{
Tim Peters37f39822003-01-10 03:49:02 +00003140 char buffer[100];
Martin v. Löwis68192102007-07-21 06:55:02 +00003141 const char *type_name = Py_Type(self)->tp_name;
Tim Peters37f39822003-01-10 03:49:02 +00003142 int h = TIME_GET_HOUR(self);
3143 int m = TIME_GET_MINUTE(self);
3144 int s = TIME_GET_SECOND(self);
3145 int us = TIME_GET_MICROSECOND(self);
3146 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003147
Tim Peters37f39822003-01-10 03:49:02 +00003148 if (us)
3149 PyOS_snprintf(buffer, sizeof(buffer),
Skip Montanaro14f88992006-04-18 19:35:04 +00003150 "%s(%d, %d, %d, %d)", type_name, h, m, s, us);
Tim Peters37f39822003-01-10 03:49:02 +00003151 else if (s)
3152 PyOS_snprintf(buffer, sizeof(buffer),
Skip Montanaro14f88992006-04-18 19:35:04 +00003153 "%s(%d, %d, %d)", type_name, h, m, s);
Tim Peters37f39822003-01-10 03:49:02 +00003154 else
3155 PyOS_snprintf(buffer, sizeof(buffer),
Skip Montanaro14f88992006-04-18 19:35:04 +00003156 "%s(%d, %d)", type_name, h, m);
Tim Peters37f39822003-01-10 03:49:02 +00003157 result = PyString_FromString(buffer);
Tim Petersa032d2e2003-01-11 00:15:54 +00003158 if (result != NULL && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +00003159 result = append_keyword_tzinfo(result, self->tzinfo);
3160 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003161}
3162
Tim Peters37f39822003-01-10 03:49:02 +00003163static PyObject *
3164time_str(PyDateTime_Time *self)
3165{
3166 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
3167}
Tim Peters2a799bf2002-12-16 20:18:38 +00003168
3169static PyObject *
Martin v. Löwis4c11a922007-02-08 09:13:36 +00003170time_isoformat(PyDateTime_Time *self, PyObject *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003171{
3172 char buf[100];
Tim Peters37f39822003-01-10 03:49:02 +00003173 PyObject *result;
3174 /* Reuse the time format code from the datetime type. */
3175 PyDateTime_DateTime datetime;
3176 PyDateTime_DateTime *pdatetime = &datetime;
Tim Peters2a799bf2002-12-16 20:18:38 +00003177
Tim Peters37f39822003-01-10 03:49:02 +00003178 /* Copy over just the time bytes. */
3179 memcpy(pdatetime->data + _PyDateTime_DATE_DATASIZE,
3180 self->data,
3181 _PyDateTime_TIME_DATASIZE);
3182
3183 isoformat_time(pdatetime, buf, sizeof(buf));
3184 result = PyString_FromString(buf);
Tim Petersa032d2e2003-01-11 00:15:54 +00003185 if (result == NULL || ! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00003186 return result;
3187
3188 /* We need to append the UTC offset. */
3189 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00003190 Py_None) < 0) {
Tim Peters2a799bf2002-12-16 20:18:38 +00003191 Py_DECREF(result);
3192 return NULL;
3193 }
3194 PyString_ConcatAndDel(&result, PyString_FromString(buf));
3195 return result;
3196}
3197
Tim Peters37f39822003-01-10 03:49:02 +00003198static PyObject *
3199time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3200{
3201 PyObject *result;
3202 PyObject *format;
3203 PyObject *tuple;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003204 static char *keywords[] = {"format", NULL};
Tim Peters37f39822003-01-10 03:49:02 +00003205
3206 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:strftime", keywords,
3207 &PyString_Type, &format))
3208 return NULL;
3209
3210 /* Python's strftime does insane things with the year part of the
3211 * timetuple. The year is forced to (the otherwise nonsensical)
3212 * 1900 to worm around that.
3213 */
3214 tuple = Py_BuildValue("iiiiiiiii",
Brett Cannond1080a32004-03-02 04:38:10 +00003215 1900, 1, 1, /* year, month, day */
Tim Peters37f39822003-01-10 03:49:02 +00003216 TIME_GET_HOUR(self),
3217 TIME_GET_MINUTE(self),
3218 TIME_GET_SECOND(self),
Brett Cannond1080a32004-03-02 04:38:10 +00003219 0, 1, -1); /* weekday, daynum, dst */
Tim Peters37f39822003-01-10 03:49:02 +00003220 if (tuple == NULL)
3221 return NULL;
3222 assert(PyTuple_Size(tuple) == 9);
3223 result = wrap_strftime((PyObject *)self, format, tuple, Py_None);
3224 Py_DECREF(tuple);
3225 return result;
3226}
Tim Peters2a799bf2002-12-16 20:18:38 +00003227
3228/*
3229 * Miscellaneous methods.
3230 */
3231
Tim Peters37f39822003-01-10 03:49:02 +00003232/* This is more natural as a tp_compare, but doesn't work then: for whatever
3233 * reason, Python's try_3way_compare ignores tp_compare unless
3234 * PyInstance_Check returns true, but these aren't old-style classes.
3235 */
3236static PyObject *
3237time_richcompare(PyDateTime_Time *self, PyObject *other, int op)
3238{
3239 int diff;
3240 naivety n1, n2;
3241 int offset1, offset2;
3242
3243 if (! PyTime_Check(other)) {
Tim Peters07534a62003-02-07 22:50:28 +00003244 if (op == Py_EQ || op == Py_NE) {
3245 PyObject *result = op == Py_EQ ? Py_False : Py_True;
3246 Py_INCREF(result);
3247 return result;
3248 }
Tim Peters37f39822003-01-10 03:49:02 +00003249 /* Stop this from falling back to address comparison. */
Tim Peters07534a62003-02-07 22:50:28 +00003250 return cmperror((PyObject *)self, other);
Tim Peters37f39822003-01-10 03:49:02 +00003251 }
3252 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1, Py_None,
3253 other, &offset2, &n2, Py_None) < 0)
3254 return NULL;
3255 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
3256 /* If they're both naive, or both aware and have the same offsets,
3257 * we get off cheap. Note that if they're both naive, offset1 ==
3258 * offset2 == 0 at this point.
3259 */
3260 if (n1 == n2 && offset1 == offset2) {
3261 diff = memcmp(self->data, ((PyDateTime_Time *)other)->data,
3262 _PyDateTime_TIME_DATASIZE);
3263 return diff_to_bool(diff, op);
3264 }
3265
3266 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
3267 assert(offset1 != offset2); /* else last "if" handled it */
3268 /* Convert everything except microseconds to seconds. These
3269 * can't overflow (no more than the # of seconds in 2 days).
3270 */
3271 offset1 = TIME_GET_HOUR(self) * 3600 +
3272 (TIME_GET_MINUTE(self) - offset1) * 60 +
3273 TIME_GET_SECOND(self);
3274 offset2 = TIME_GET_HOUR(other) * 3600 +
3275 (TIME_GET_MINUTE(other) - offset2) * 60 +
3276 TIME_GET_SECOND(other);
3277 diff = offset1 - offset2;
3278 if (diff == 0)
3279 diff = TIME_GET_MICROSECOND(self) -
3280 TIME_GET_MICROSECOND(other);
3281 return diff_to_bool(diff, op);
3282 }
3283
3284 assert(n1 != n2);
3285 PyErr_SetString(PyExc_TypeError,
3286 "can't compare offset-naive and "
3287 "offset-aware times");
3288 return NULL;
3289}
3290
3291static long
3292time_hash(PyDateTime_Time *self)
3293{
3294 if (self->hashcode == -1) {
3295 naivety n;
3296 int offset;
3297 PyObject *temp;
3298
3299 n = classify_utcoffset((PyObject *)self, Py_None, &offset);
3300 assert(n != OFFSET_UNKNOWN);
3301 if (n == OFFSET_ERROR)
3302 return -1;
3303
3304 /* Reduce this to a hash of another object. */
3305 if (offset == 0)
3306 temp = PyString_FromStringAndSize((char *)self->data,
3307 _PyDateTime_TIME_DATASIZE);
3308 else {
3309 int hour;
3310 int minute;
3311
3312 assert(n == OFFSET_AWARE);
Tim Petersa032d2e2003-01-11 00:15:54 +00003313 assert(HASTZINFO(self));
Tim Peters37f39822003-01-10 03:49:02 +00003314 hour = divmod(TIME_GET_HOUR(self) * 60 +
3315 TIME_GET_MINUTE(self) - offset,
3316 60,
3317 &minute);
3318 if (0 <= hour && hour < 24)
3319 temp = new_time(hour, minute,
3320 TIME_GET_SECOND(self),
3321 TIME_GET_MICROSECOND(self),
3322 Py_None);
3323 else
3324 temp = Py_BuildValue("iiii",
3325 hour, minute,
3326 TIME_GET_SECOND(self),
3327 TIME_GET_MICROSECOND(self));
3328 }
3329 if (temp != NULL) {
3330 self->hashcode = PyObject_Hash(temp);
3331 Py_DECREF(temp);
3332 }
3333 }
3334 return self->hashcode;
3335}
Tim Peters2a799bf2002-12-16 20:18:38 +00003336
Tim Peters12bf3392002-12-24 05:41:27 +00003337static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003338time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00003339{
3340 PyObject *clone;
3341 PyObject *tuple;
3342 int hh = TIME_GET_HOUR(self);
3343 int mm = TIME_GET_MINUTE(self);
3344 int ss = TIME_GET_SECOND(self);
3345 int us = TIME_GET_MICROSECOND(self);
Tim Petersa032d2e2003-01-11 00:15:54 +00003346 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00003347
3348 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO:replace",
Tim Peters37f39822003-01-10 03:49:02 +00003349 time_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00003350 &hh, &mm, &ss, &us, &tzinfo))
3351 return NULL;
3352 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
3353 if (tuple == NULL)
3354 return NULL;
Martin v. Löwis68192102007-07-21 06:55:02 +00003355 clone = time_new(Py_Type(self), tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00003356 Py_DECREF(tuple);
3357 return clone;
3358}
3359
Tim Peters2a799bf2002-12-16 20:18:38 +00003360static int
Tim Peters37f39822003-01-10 03:49:02 +00003361time_nonzero(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003362{
3363 int offset;
3364 int none;
3365
3366 if (TIME_GET_SECOND(self) || TIME_GET_MICROSECOND(self)) {
3367 /* Since utcoffset is in whole minutes, nothing can
3368 * alter the conclusion that this is nonzero.
3369 */
3370 return 1;
3371 }
3372 offset = 0;
Tim Petersa032d2e2003-01-11 00:15:54 +00003373 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Petersbad8ff02002-12-30 20:52:32 +00003374 offset = call_utcoffset(self->tzinfo, Py_None, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00003375 if (offset == -1 && PyErr_Occurred())
3376 return -1;
3377 }
3378 return (TIME_GET_MINUTE(self) - offset + TIME_GET_HOUR(self)*60) != 0;
3379}
3380
Tim Peters371935f2003-02-01 01:52:50 +00003381/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003382
Tim Peters33e0f382003-01-10 02:05:14 +00003383/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003384 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
3385 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00003386 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00003387 */
3388static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003389time_getstate(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003390{
3391 PyObject *basestate;
3392 PyObject *result = NULL;
3393
Tim Peters33e0f382003-01-10 02:05:14 +00003394 basestate = PyString_FromStringAndSize((char *)self->data,
3395 _PyDateTime_TIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00003396 if (basestate != NULL) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003397 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003398 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00003399 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003400 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00003401 Py_DECREF(basestate);
3402 }
3403 return result;
3404}
3405
3406static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00003407time_reduce(PyDateTime_Time *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00003408{
Martin v. Löwis68192102007-07-21 06:55:02 +00003409 return Py_BuildValue("(ON)", Py_Type(self), time_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003410}
3411
Tim Peters37f39822003-01-10 03:49:02 +00003412static PyMethodDef time_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003413
Martin v. Löwis4c11a922007-02-08 09:13:36 +00003414 {"isoformat", (PyCFunction)time_isoformat, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003415 PyDoc_STR("Return string in ISO 8601 format, HH:MM:SS[.mmmmmm]"
3416 "[+HH:MM].")},
3417
Neal Norwitza84dcd72007-05-22 07:16:44 +00003418 {"strftime", (PyCFunction)time_strftime, METH_VARARGS | METH_KEYWORDS,
Tim Peters37f39822003-01-10 03:49:02 +00003419 PyDoc_STR("format -> strftime() style string.")},
3420
3421 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003422 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
3423
Tim Peters37f39822003-01-10 03:49:02 +00003424 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003425 PyDoc_STR("Return self.tzinfo.tzname(self).")},
3426
Tim Peters37f39822003-01-10 03:49:02 +00003427 {"dst", (PyCFunction)time_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003428 PyDoc_STR("Return self.tzinfo.dst(self).")},
3429
Neal Norwitza84dcd72007-05-22 07:16:44 +00003430 {"replace", (PyCFunction)time_replace, METH_VARARGS | METH_KEYWORDS,
Tim Peters37f39822003-01-10 03:49:02 +00003431 PyDoc_STR("Return time with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00003432
Guido van Rossum177e41a2003-01-30 22:06:23 +00003433 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
3434 PyDoc_STR("__reduce__() -> (cls, state)")},
3435
Tim Peters2a799bf2002-12-16 20:18:38 +00003436 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003437};
3438
Tim Peters37f39822003-01-10 03:49:02 +00003439static char time_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00003440PyDoc_STR("time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object\n\
3441\n\
3442All arguments are optional. tzinfo may be None, or an instance of\n\
3443a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00003444
Tim Peters37f39822003-01-10 03:49:02 +00003445static PyNumberMethods time_as_number = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003446 0, /* nb_add */
3447 0, /* nb_subtract */
3448 0, /* nb_multiply */
3449 0, /* nb_divide */
3450 0, /* nb_remainder */
3451 0, /* nb_divmod */
3452 0, /* nb_power */
3453 0, /* nb_negative */
3454 0, /* nb_positive */
3455 0, /* nb_absolute */
Tim Peters37f39822003-01-10 03:49:02 +00003456 (inquiry)time_nonzero, /* nb_nonzero */
Tim Peters2a799bf2002-12-16 20:18:38 +00003457};
3458
Tim Peters37f39822003-01-10 03:49:02 +00003459statichere PyTypeObject PyDateTime_TimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003460 PyObject_HEAD_INIT(NULL)
3461 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00003462 "datetime.time", /* tp_name */
Tim Peters37f39822003-01-10 03:49:02 +00003463 sizeof(PyDateTime_Time), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00003464 0, /* tp_itemsize */
Tim Peters37f39822003-01-10 03:49:02 +00003465 (destructor)time_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003466 0, /* tp_print */
3467 0, /* tp_getattr */
3468 0, /* tp_setattr */
3469 0, /* tp_compare */
Tim Peters37f39822003-01-10 03:49:02 +00003470 (reprfunc)time_repr, /* tp_repr */
3471 &time_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00003472 0, /* tp_as_sequence */
3473 0, /* tp_as_mapping */
Tim Peters37f39822003-01-10 03:49:02 +00003474 (hashfunc)time_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00003475 0, /* tp_call */
Tim Peters37f39822003-01-10 03:49:02 +00003476 (reprfunc)time_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00003477 PyObject_GenericGetAttr, /* tp_getattro */
3478 0, /* tp_setattro */
3479 0, /* tp_as_buffer */
3480 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
3481 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters37f39822003-01-10 03:49:02 +00003482 time_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003483 0, /* tp_traverse */
3484 0, /* tp_clear */
Tim Peters37f39822003-01-10 03:49:02 +00003485 (richcmpfunc)time_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00003486 0, /* tp_weaklistoffset */
3487 0, /* tp_iter */
3488 0, /* tp_iternext */
Tim Peters37f39822003-01-10 03:49:02 +00003489 time_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00003490 0, /* tp_members */
Tim Peters37f39822003-01-10 03:49:02 +00003491 time_getset, /* tp_getset */
3492 0, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00003493 0, /* tp_dict */
3494 0, /* tp_descr_get */
3495 0, /* tp_descr_set */
3496 0, /* tp_dictoffset */
3497 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00003498 time_alloc, /* tp_alloc */
Tim Peters37f39822003-01-10 03:49:02 +00003499 time_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00003500 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00003501};
3502
3503/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003504 * PyDateTime_DateTime implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003505 */
3506
Tim Petersa9bc1682003-01-11 03:39:11 +00003507/* Accessor properties. Properties for day, month, and year are inherited
3508 * from date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003509 */
3510
3511static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003512datetime_hour(PyDateTime_DateTime *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003513{
Tim Petersa9bc1682003-01-11 03:39:11 +00003514 return PyInt_FromLong(DATE_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003515}
3516
Tim Petersa9bc1682003-01-11 03:39:11 +00003517static PyObject *
3518datetime_minute(PyDateTime_DateTime *self, void *unused)
3519{
3520 return PyInt_FromLong(DATE_GET_MINUTE(self));
3521}
3522
3523static PyObject *
3524datetime_second(PyDateTime_DateTime *self, void *unused)
3525{
3526 return PyInt_FromLong(DATE_GET_SECOND(self));
3527}
3528
3529static PyObject *
3530datetime_microsecond(PyDateTime_DateTime *self, void *unused)
3531{
3532 return PyInt_FromLong(DATE_GET_MICROSECOND(self));
3533}
3534
3535static PyObject *
3536datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
3537{
3538 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3539 Py_INCREF(result);
3540 return result;
3541}
3542
3543static PyGetSetDef datetime_getset[] = {
3544 {"hour", (getter)datetime_hour},
3545 {"minute", (getter)datetime_minute},
3546 {"second", (getter)datetime_second},
3547 {"microsecond", (getter)datetime_microsecond},
3548 {"tzinfo", (getter)datetime_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003549 {NULL}
3550};
3551
3552/*
3553 * Constructors.
Tim Peters2a799bf2002-12-16 20:18:38 +00003554 */
3555
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003556static char *datetime_kws[] = {
Tim Peters12bf3392002-12-24 05:41:27 +00003557 "year", "month", "day", "hour", "minute", "second",
3558 "microsecond", "tzinfo", NULL
3559};
3560
Tim Peters2a799bf2002-12-16 20:18:38 +00003561static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003562datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003563{
3564 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003565 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003566 int year;
3567 int month;
3568 int day;
3569 int hour = 0;
3570 int minute = 0;
3571 int second = 0;
3572 int usecond = 0;
3573 PyObject *tzinfo = Py_None;
3574
Guido van Rossum177e41a2003-01-30 22:06:23 +00003575 /* Check for invocation from pickle with __getstate__ state */
3576 if (PyTuple_GET_SIZE(args) >= 1 &&
3577 PyTuple_GET_SIZE(args) <= 2 &&
Tim Peters70533e22003-02-01 04:40:04 +00003578 PyString_Check(state = PyTuple_GET_ITEM(args, 0)) &&
Tim Peters3f606292004-03-21 23:38:41 +00003579 PyString_GET_SIZE(state) == _PyDateTime_DATETIME_DATASIZE &&
3580 MONTH_IS_SANE(PyString_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00003581 {
Tim Peters70533e22003-02-01 04:40:04 +00003582 PyDateTime_DateTime *me;
3583 char aware;
3584
3585 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003586 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003587 if (check_tzinfo_subclass(tzinfo) < 0) {
3588 PyErr_SetString(PyExc_TypeError, "bad "
3589 "tzinfo state arg");
3590 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003591 }
3592 }
Tim Peters70533e22003-02-01 04:40:04 +00003593 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003594 me = (PyDateTime_DateTime *) (type->tp_alloc(type , aware));
Tim Peters70533e22003-02-01 04:40:04 +00003595 if (me != NULL) {
3596 char *pdata = PyString_AS_STRING(state);
3597
3598 memcpy(me->data, pdata, _PyDateTime_DATETIME_DATASIZE);
3599 me->hashcode = -1;
3600 me->hastzinfo = aware;
3601 if (aware) {
3602 Py_INCREF(tzinfo);
3603 me->tzinfo = tzinfo;
3604 }
3605 }
3606 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003607 }
3608
Tim Petersa9bc1682003-01-11 03:39:11 +00003609 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO", datetime_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003610 &year, &month, &day, &hour, &minute,
3611 &second, &usecond, &tzinfo)) {
3612 if (check_date_args(year, month, day) < 0)
3613 return NULL;
3614 if (check_time_args(hour, minute, second, usecond) < 0)
3615 return NULL;
3616 if (check_tzinfo_subclass(tzinfo) < 0)
3617 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003618 self = new_datetime_ex(year, month, day,
3619 hour, minute, second, usecond,
3620 tzinfo, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003621 }
3622 return self;
3623}
3624
Tim Petersa9bc1682003-01-11 03:39:11 +00003625/* TM_FUNC is the shared type of localtime() and gmtime(). */
3626typedef struct tm *(*TM_FUNC)(const time_t *timer);
3627
3628/* Internal helper.
3629 * Build datetime from a time_t and a distinct count of microseconds.
3630 * Pass localtime or gmtime for f, to control the interpretation of timet.
3631 */
3632static PyObject *
3633datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
3634 PyObject *tzinfo)
3635{
3636 struct tm *tm;
3637 PyObject *result = NULL;
3638
3639 tm = f(&timet);
3640 if (tm) {
3641 /* The platform localtime/gmtime may insert leap seconds,
3642 * indicated by tm->tm_sec > 59. We don't care about them,
3643 * except to the extent that passing them on to the datetime
3644 * constructor would raise ValueError for a reason that
3645 * made no sense to the user.
3646 */
3647 if (tm->tm_sec > 59)
3648 tm->tm_sec = 59;
3649 result = PyObject_CallFunction(cls, "iiiiiiiO",
3650 tm->tm_year + 1900,
3651 tm->tm_mon + 1,
3652 tm->tm_mday,
3653 tm->tm_hour,
3654 tm->tm_min,
3655 tm->tm_sec,
3656 us,
3657 tzinfo);
3658 }
3659 else
3660 PyErr_SetString(PyExc_ValueError,
3661 "timestamp out of range for "
3662 "platform localtime()/gmtime() function");
3663 return result;
3664}
3665
3666/* Internal helper.
3667 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
3668 * to control the interpretation of the timestamp. Since a double doesn't
3669 * have enough bits to cover a datetime's full range of precision, it's
3670 * better to call datetime_from_timet_and_us provided you have a way
3671 * to get that much precision (e.g., C time() isn't good enough).
3672 */
3673static PyObject *
3674datetime_from_timestamp(PyObject *cls, TM_FUNC f, double timestamp,
3675 PyObject *tzinfo)
3676{
Tim Peters1b6f7a92004-06-20 02:50:16 +00003677 time_t timet;
3678 double fraction;
3679 int us;
Tim Petersa9bc1682003-01-11 03:39:11 +00003680
Tim Peters1b6f7a92004-06-20 02:50:16 +00003681 timet = _PyTime_DoubleToTimet(timestamp);
3682 if (timet == (time_t)-1 && PyErr_Occurred())
3683 return NULL;
3684 fraction = timestamp - (double)timet;
3685 us = (int)round_to_long(fraction * 1e6);
Guido van Rossum2054ee92007-03-06 15:50:01 +00003686 if (us < 0) {
3687 /* Truncation towards zero is not what we wanted
3688 for negative numbers (Python's mod semantics) */
3689 timet -= 1;
3690 us += 1000000;
3691 }
Georg Brandl6d78a582006-04-28 19:09:24 +00003692 /* If timestamp is less than one microsecond smaller than a
3693 * full second, round up. Otherwise, ValueErrors are raised
3694 * for some floats. */
3695 if (us == 1000000) {
3696 timet += 1;
3697 us = 0;
3698 }
Tim Petersa9bc1682003-01-11 03:39:11 +00003699 return datetime_from_timet_and_us(cls, f, timet, us, tzinfo);
3700}
3701
3702/* Internal helper.
3703 * Build most accurate possible datetime for current time. Pass localtime or
3704 * gmtime for f as appropriate.
3705 */
3706static PyObject *
3707datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
3708{
3709#ifdef HAVE_GETTIMEOFDAY
3710 struct timeval t;
3711
3712#ifdef GETTIMEOFDAY_NO_TZ
3713 gettimeofday(&t);
3714#else
3715 gettimeofday(&t, (struct timezone *)NULL);
3716#endif
3717 return datetime_from_timet_and_us(cls, f, t.tv_sec, (int)t.tv_usec,
3718 tzinfo);
3719
3720#else /* ! HAVE_GETTIMEOFDAY */
3721 /* No flavor of gettimeofday exists on this platform. Python's
3722 * time.time() does a lot of other platform tricks to get the
3723 * best time it can on the platform, and we're not going to do
3724 * better than that (if we could, the better code would belong
3725 * in time.time()!) We're limited by the precision of a double,
3726 * though.
3727 */
3728 PyObject *time;
3729 double dtime;
3730
3731 time = time_time();
3732 if (time == NULL)
3733 return NULL;
3734 dtime = PyFloat_AsDouble(time);
3735 Py_DECREF(time);
3736 if (dtime == -1.0 && PyErr_Occurred())
3737 return NULL;
3738 return datetime_from_timestamp(cls, f, dtime, tzinfo);
3739#endif /* ! HAVE_GETTIMEOFDAY */
3740}
3741
Tim Peters2a799bf2002-12-16 20:18:38 +00003742/* Return best possible local time -- this isn't constrained by the
3743 * precision of a timestamp.
3744 */
3745static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003746datetime_now(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003747{
Tim Peters10cadce2003-01-23 19:58:02 +00003748 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003749 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003750 static char *keywords[] = {"tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003751
Tim Peters10cadce2003-01-23 19:58:02 +00003752 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:now", keywords,
3753 &tzinfo))
3754 return NULL;
3755 if (check_tzinfo_subclass(tzinfo) < 0)
3756 return NULL;
3757
3758 self = datetime_best_possible(cls,
3759 tzinfo == Py_None ? localtime : gmtime,
3760 tzinfo);
3761 if (self != NULL && tzinfo != Py_None) {
3762 /* Convert UTC to tzinfo's zone. */
3763 PyObject *temp = self;
Tim Peters2a44a8d2003-01-23 20:53:10 +00003764 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
Tim Peters10cadce2003-01-23 19:58:02 +00003765 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003766 }
3767 return self;
3768}
3769
Tim Petersa9bc1682003-01-11 03:39:11 +00003770/* Return best possible UTC time -- this isn't constrained by the
3771 * precision of a timestamp.
3772 */
3773static PyObject *
3774datetime_utcnow(PyObject *cls, PyObject *dummy)
3775{
3776 return datetime_best_possible(cls, gmtime, Py_None);
3777}
3778
Tim Peters2a799bf2002-12-16 20:18:38 +00003779/* Return new local datetime from timestamp (Python timestamp -- a double). */
3780static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003781datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003782{
Tim Peters2a44a8d2003-01-23 20:53:10 +00003783 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003784 double timestamp;
3785 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003786 static char *keywords[] = {"timestamp", "tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003787
Tim Peters2a44a8d2003-01-23 20:53:10 +00003788 if (! PyArg_ParseTupleAndKeywords(args, kw, "d|O:fromtimestamp",
3789 keywords, &timestamp, &tzinfo))
3790 return NULL;
3791 if (check_tzinfo_subclass(tzinfo) < 0)
3792 return NULL;
3793
3794 self = datetime_from_timestamp(cls,
3795 tzinfo == Py_None ? localtime : gmtime,
3796 timestamp,
3797 tzinfo);
3798 if (self != NULL && tzinfo != Py_None) {
3799 /* Convert UTC to tzinfo's zone. */
3800 PyObject *temp = self;
3801 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3802 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003803 }
3804 return self;
3805}
3806
Tim Petersa9bc1682003-01-11 03:39:11 +00003807/* Return new UTC datetime from timestamp (Python timestamp -- a double). */
3808static PyObject *
3809datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
3810{
3811 double timestamp;
3812 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003813
Tim Petersa9bc1682003-01-11 03:39:11 +00003814 if (PyArg_ParseTuple(args, "d:utcfromtimestamp", &timestamp))
3815 result = datetime_from_timestamp(cls, gmtime, timestamp,
3816 Py_None);
3817 return result;
3818}
3819
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003820/* Return new datetime from time.strptime(). */
3821static PyObject *
3822datetime_strptime(PyObject *cls, PyObject *args)
3823{
3824 PyObject *result = NULL, *obj, *module;
3825 const char *string, *format;
3826
3827 if (!PyArg_ParseTuple(args, "ss:strptime", &string, &format))
3828 return NULL;
3829
3830 if ((module = PyImport_ImportModule("time")) == NULL)
3831 return NULL;
3832 obj = PyObject_CallMethod(module, "strptime", "ss", string, format);
3833 Py_DECREF(module);
3834
3835 if (obj != NULL) {
3836 int i, good_timetuple = 1;
3837 long int ia[6];
3838 if (PySequence_Check(obj) && PySequence_Size(obj) >= 6)
3839 for (i=0; i < 6; i++) {
3840 PyObject *p = PySequence_GetItem(obj, i);
Thomas Wouters3cfea2d2006-04-14 21:23:42 +00003841 if (p == NULL) {
3842 Py_DECREF(obj);
3843 return NULL;
3844 }
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003845 if (PyInt_Check(p))
3846 ia[i] = PyInt_AsLong(p);
3847 else
3848 good_timetuple = 0;
3849 Py_DECREF(p);
3850 }
3851 else
3852 good_timetuple = 0;
3853 if (good_timetuple)
3854 result = PyObject_CallFunction(cls, "iiiiii",
3855 ia[0], ia[1], ia[2], ia[3], ia[4], ia[5]);
3856 else
3857 PyErr_SetString(PyExc_ValueError,
3858 "unexpected value from time.strptime");
3859 Py_DECREF(obj);
3860 }
3861 return result;
3862}
3863
Tim Petersa9bc1682003-01-11 03:39:11 +00003864/* Return new datetime from date/datetime and time arguments. */
3865static PyObject *
3866datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
3867{
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003868 static char *keywords[] = {"date", "time", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00003869 PyObject *date;
3870 PyObject *time;
3871 PyObject *result = NULL;
3872
3873 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!:combine", keywords,
3874 &PyDateTime_DateType, &date,
3875 &PyDateTime_TimeType, &time)) {
3876 PyObject *tzinfo = Py_None;
3877
3878 if (HASTZINFO(time))
3879 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
3880 result = PyObject_CallFunction(cls, "iiiiiiiO",
3881 GET_YEAR(date),
3882 GET_MONTH(date),
3883 GET_DAY(date),
3884 TIME_GET_HOUR(time),
3885 TIME_GET_MINUTE(time),
3886 TIME_GET_SECOND(time),
3887 TIME_GET_MICROSECOND(time),
3888 tzinfo);
3889 }
3890 return result;
3891}
Tim Peters2a799bf2002-12-16 20:18:38 +00003892
3893/*
3894 * Destructor.
3895 */
3896
3897static void
Tim Petersa9bc1682003-01-11 03:39:11 +00003898datetime_dealloc(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003899{
Tim Petersa9bc1682003-01-11 03:39:11 +00003900 if (HASTZINFO(self)) {
3901 Py_XDECREF(self->tzinfo);
3902 }
Martin v. Löwis68192102007-07-21 06:55:02 +00003903 Py_Type(self)->tp_free((PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003904}
3905
3906/*
3907 * Indirect access to tzinfo methods.
3908 */
3909
Tim Peters2a799bf2002-12-16 20:18:38 +00003910/* These are all METH_NOARGS, so don't need to check the arglist. */
3911static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003912datetime_utcoffset(PyDateTime_DateTime *self, PyObject *unused) {
3913 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3914 "utcoffset", (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003915}
3916
3917static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003918datetime_dst(PyDateTime_DateTime *self, PyObject *unused) {
3919 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
3920 "dst", (PyObject *)self);
Tim Peters855fe882002-12-22 03:43:39 +00003921}
3922
3923static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003924datetime_tzname(PyDateTime_DateTime *self, PyObject *unused) {
3925 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
3926 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003927}
3928
3929/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003930 * datetime arithmetic.
Tim Peters2a799bf2002-12-16 20:18:38 +00003931 */
3932
Tim Petersa9bc1682003-01-11 03:39:11 +00003933/* factor must be 1 (to add) or -1 (to subtract). The result inherits
3934 * the tzinfo state of date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003935 */
3936static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003937add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
3938 int factor)
Tim Peters2a799bf2002-12-16 20:18:38 +00003939{
Tim Petersa9bc1682003-01-11 03:39:11 +00003940 /* Note that the C-level additions can't overflow, because of
3941 * invariant bounds on the member values.
3942 */
3943 int year = GET_YEAR(date);
3944 int month = GET_MONTH(date);
3945 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
3946 int hour = DATE_GET_HOUR(date);
3947 int minute = DATE_GET_MINUTE(date);
3948 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
3949 int microsecond = DATE_GET_MICROSECOND(date) +
3950 GET_TD_MICROSECONDS(delta) * factor;
Tim Peters2a799bf2002-12-16 20:18:38 +00003951
Tim Petersa9bc1682003-01-11 03:39:11 +00003952 assert(factor == 1 || factor == -1);
3953 if (normalize_datetime(&year, &month, &day,
3954 &hour, &minute, &second, &microsecond) < 0)
3955 return NULL;
3956 else
3957 return new_datetime(year, month, day,
3958 hour, minute, second, microsecond,
3959 HASTZINFO(date) ? date->tzinfo : Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003960}
3961
3962static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003963datetime_add(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003964{
Tim Petersa9bc1682003-01-11 03:39:11 +00003965 if (PyDateTime_Check(left)) {
3966 /* datetime + ??? */
3967 if (PyDelta_Check(right))
3968 /* datetime + delta */
3969 return add_datetime_timedelta(
3970 (PyDateTime_DateTime *)left,
3971 (PyDateTime_Delta *)right,
3972 1);
3973 }
3974 else if (PyDelta_Check(left)) {
3975 /* delta + datetime */
3976 return add_datetime_timedelta((PyDateTime_DateTime *) right,
3977 (PyDateTime_Delta *) left,
3978 1);
3979 }
3980 Py_INCREF(Py_NotImplemented);
3981 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00003982}
3983
3984static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003985datetime_subtract(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00003986{
3987 PyObject *result = Py_NotImplemented;
3988
3989 if (PyDateTime_Check(left)) {
3990 /* datetime - ??? */
3991 if (PyDateTime_Check(right)) {
3992 /* datetime - datetime */
3993 naivety n1, n2;
3994 int offset1, offset2;
Tim Petersa9bc1682003-01-11 03:39:11 +00003995 int delta_d, delta_s, delta_us;
Tim Peters2a799bf2002-12-16 20:18:38 +00003996
Tim Peterse39a80c2002-12-30 21:28:52 +00003997 if (classify_two_utcoffsets(left, &offset1, &n1, left,
3998 right, &offset2, &n2,
3999 right) < 0)
Tim Peters00237032002-12-27 02:21:51 +00004000 return NULL;
Tim Peters8702d5f2002-12-27 02:26:16 +00004001 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
Tim Peters2a799bf2002-12-16 20:18:38 +00004002 if (n1 != n2) {
4003 PyErr_SetString(PyExc_TypeError,
4004 "can't subtract offset-naive and "
4005 "offset-aware datetimes");
4006 return NULL;
4007 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004008 delta_d = ymd_to_ord(GET_YEAR(left),
4009 GET_MONTH(left),
4010 GET_DAY(left)) -
4011 ymd_to_ord(GET_YEAR(right),
4012 GET_MONTH(right),
4013 GET_DAY(right));
4014 /* These can't overflow, since the values are
4015 * normalized. At most this gives the number of
4016 * seconds in one day.
4017 */
4018 delta_s = (DATE_GET_HOUR(left) -
4019 DATE_GET_HOUR(right)) * 3600 +
4020 (DATE_GET_MINUTE(left) -
4021 DATE_GET_MINUTE(right)) * 60 +
4022 (DATE_GET_SECOND(left) -
4023 DATE_GET_SECOND(right));
4024 delta_us = DATE_GET_MICROSECOND(left) -
4025 DATE_GET_MICROSECOND(right);
Tim Peters2a799bf2002-12-16 20:18:38 +00004026 /* (left - offset1) - (right - offset2) =
4027 * (left - right) + (offset2 - offset1)
4028 */
Tim Petersa9bc1682003-01-11 03:39:11 +00004029 delta_s += (offset2 - offset1) * 60;
4030 result = new_delta(delta_d, delta_s, delta_us, 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00004031 }
4032 else if (PyDelta_Check(right)) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004033 /* datetime - delta */
4034 result = add_datetime_timedelta(
Tim Peters2a799bf2002-12-16 20:18:38 +00004035 (PyDateTime_DateTime *)left,
Tim Petersa9bc1682003-01-11 03:39:11 +00004036 (PyDateTime_Delta *)right,
4037 -1);
Tim Peters2a799bf2002-12-16 20:18:38 +00004038 }
4039 }
4040
4041 if (result == Py_NotImplemented)
4042 Py_INCREF(result);
4043 return result;
4044}
4045
4046/* Various ways to turn a datetime into a string. */
4047
4048static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004049datetime_repr(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004050{
Tim Petersa9bc1682003-01-11 03:39:11 +00004051 char buffer[1000];
Martin v. Löwis68192102007-07-21 06:55:02 +00004052 const char *type_name = Py_Type(self)->tp_name;
Tim Petersa9bc1682003-01-11 03:39:11 +00004053 PyObject *baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004054
Tim Petersa9bc1682003-01-11 03:39:11 +00004055 if (DATE_GET_MICROSECOND(self)) {
4056 PyOS_snprintf(buffer, sizeof(buffer),
4057 "%s(%d, %d, %d, %d, %d, %d, %d)",
Skip Montanaro14f88992006-04-18 19:35:04 +00004058 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004059 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4060 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4061 DATE_GET_SECOND(self),
4062 DATE_GET_MICROSECOND(self));
4063 }
4064 else if (DATE_GET_SECOND(self)) {
4065 PyOS_snprintf(buffer, sizeof(buffer),
4066 "%s(%d, %d, %d, %d, %d, %d)",
Skip Montanaro14f88992006-04-18 19:35:04 +00004067 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004068 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4069 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4070 DATE_GET_SECOND(self));
4071 }
4072 else {
4073 PyOS_snprintf(buffer, sizeof(buffer),
4074 "%s(%d, %d, %d, %d, %d)",
Skip Montanaro14f88992006-04-18 19:35:04 +00004075 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004076 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4077 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
4078 }
4079 baserepr = PyString_FromString(buffer);
4080 if (baserepr == NULL || ! HASTZINFO(self))
4081 return baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004082 return append_keyword_tzinfo(baserepr, self->tzinfo);
4083}
4084
Tim Petersa9bc1682003-01-11 03:39:11 +00004085static PyObject *
4086datetime_str(PyDateTime_DateTime *self)
4087{
4088 return PyObject_CallMethod((PyObject *)self, "isoformat", "(s)", " ");
4089}
Tim Peters2a799bf2002-12-16 20:18:38 +00004090
4091static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004092datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004093{
Tim Petersa9bc1682003-01-11 03:39:11 +00004094 char sep = 'T';
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004095 static char *keywords[] = {"sep", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00004096 char buffer[100];
4097 char *cp;
4098 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004099
Tim Petersa9bc1682003-01-11 03:39:11 +00004100 if (!PyArg_ParseTupleAndKeywords(args, kw, "|c:isoformat", keywords,
4101 &sep))
4102 return NULL;
4103 cp = isoformat_date((PyDateTime_Date *)self, buffer, sizeof(buffer));
4104 assert(cp != NULL);
4105 *cp++ = sep;
4106 isoformat_time(self, cp, sizeof(buffer) - (cp - buffer));
4107 result = PyString_FromString(buffer);
4108 if (result == NULL || ! HASTZINFO(self))
Tim Peters2a799bf2002-12-16 20:18:38 +00004109 return result;
4110
4111 /* We need to append the UTC offset. */
Tim Petersa9bc1682003-01-11 03:39:11 +00004112 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
Tim Peters2a799bf2002-12-16 20:18:38 +00004113 (PyObject *)self) < 0) {
4114 Py_DECREF(result);
4115 return NULL;
4116 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004117 PyString_ConcatAndDel(&result, PyString_FromString(buffer));
Tim Peters2a799bf2002-12-16 20:18:38 +00004118 return result;
4119}
4120
Tim Petersa9bc1682003-01-11 03:39:11 +00004121static PyObject *
4122datetime_ctime(PyDateTime_DateTime *self)
4123{
4124 return format_ctime((PyDateTime_Date *)self,
4125 DATE_GET_HOUR(self),
4126 DATE_GET_MINUTE(self),
4127 DATE_GET_SECOND(self));
4128}
4129
Tim Peters2a799bf2002-12-16 20:18:38 +00004130/* Miscellaneous methods. */
4131
Tim Petersa9bc1682003-01-11 03:39:11 +00004132/* This is more natural as a tp_compare, but doesn't work then: for whatever
4133 * reason, Python's try_3way_compare ignores tp_compare unless
4134 * PyInstance_Check returns true, but these aren't old-style classes.
4135 */
4136static PyObject *
4137datetime_richcompare(PyDateTime_DateTime *self, PyObject *other, int op)
4138{
4139 int diff;
4140 naivety n1, n2;
4141 int offset1, offset2;
4142
4143 if (! PyDateTime_Check(other)) {
Tim Peters528ca532004-09-16 01:30:50 +00004144 /* If other has a "timetuple" attr, that's an advertised
4145 * hook for other classes to ask to get comparison control.
4146 * However, date instances have a timetuple attr, and we
4147 * don't want to allow that comparison. Because datetime
4148 * is a subclass of date, when mixing date and datetime
4149 * in a comparison, Python gives datetime the first shot
4150 * (it's the more specific subtype). So we can stop that
4151 * combination here reliably.
4152 */
4153 if (PyObject_HasAttrString(other, "timetuple") &&
4154 ! PyDate_Check(other)) {
Tim Peters8d81a012003-01-24 22:36:34 +00004155 /* A hook for other kinds of datetime objects. */
4156 Py_INCREF(Py_NotImplemented);
4157 return Py_NotImplemented;
4158 }
Tim Peters07534a62003-02-07 22:50:28 +00004159 if (op == Py_EQ || op == Py_NE) {
4160 PyObject *result = op == Py_EQ ? Py_False : Py_True;
4161 Py_INCREF(result);
4162 return result;
4163 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004164 /* Stop this from falling back to address comparison. */
Tim Peters07534a62003-02-07 22:50:28 +00004165 return cmperror((PyObject *)self, other);
Tim Petersa9bc1682003-01-11 03:39:11 +00004166 }
4167
4168 if (classify_two_utcoffsets((PyObject *)self, &offset1, &n1,
4169 (PyObject *)self,
4170 other, &offset2, &n2,
4171 other) < 0)
4172 return NULL;
4173 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
4174 /* If they're both naive, or both aware and have the same offsets,
4175 * we get off cheap. Note that if they're both naive, offset1 ==
4176 * offset2 == 0 at this point.
4177 */
4178 if (n1 == n2 && offset1 == offset2) {
4179 diff = memcmp(self->data, ((PyDateTime_DateTime *)other)->data,
4180 _PyDateTime_DATETIME_DATASIZE);
4181 return diff_to_bool(diff, op);
4182 }
4183
4184 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
4185 PyDateTime_Delta *delta;
4186
4187 assert(offset1 != offset2); /* else last "if" handled it */
4188 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
4189 other);
4190 if (delta == NULL)
4191 return NULL;
4192 diff = GET_TD_DAYS(delta);
4193 if (diff == 0)
4194 diff = GET_TD_SECONDS(delta) |
4195 GET_TD_MICROSECONDS(delta);
4196 Py_DECREF(delta);
4197 return diff_to_bool(diff, op);
4198 }
4199
4200 assert(n1 != n2);
4201 PyErr_SetString(PyExc_TypeError,
4202 "can't compare offset-naive and "
4203 "offset-aware datetimes");
4204 return NULL;
4205}
4206
4207static long
4208datetime_hash(PyDateTime_DateTime *self)
4209{
4210 if (self->hashcode == -1) {
4211 naivety n;
4212 int offset;
4213 PyObject *temp;
4214
4215 n = classify_utcoffset((PyObject *)self, (PyObject *)self,
4216 &offset);
4217 assert(n != OFFSET_UNKNOWN);
4218 if (n == OFFSET_ERROR)
4219 return -1;
4220
4221 /* Reduce this to a hash of another object. */
4222 if (n == OFFSET_NAIVE)
4223 temp = PyString_FromStringAndSize(
4224 (char *)self->data,
4225 _PyDateTime_DATETIME_DATASIZE);
4226 else {
4227 int days;
4228 int seconds;
4229
4230 assert(n == OFFSET_AWARE);
4231 assert(HASTZINFO(self));
4232 days = ymd_to_ord(GET_YEAR(self),
4233 GET_MONTH(self),
4234 GET_DAY(self));
4235 seconds = DATE_GET_HOUR(self) * 3600 +
4236 (DATE_GET_MINUTE(self) - offset) * 60 +
4237 DATE_GET_SECOND(self);
4238 temp = new_delta(days,
4239 seconds,
4240 DATE_GET_MICROSECOND(self),
4241 1);
4242 }
4243 if (temp != NULL) {
4244 self->hashcode = PyObject_Hash(temp);
4245 Py_DECREF(temp);
4246 }
4247 }
4248 return self->hashcode;
4249}
Tim Peters2a799bf2002-12-16 20:18:38 +00004250
4251static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004252datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00004253{
4254 PyObject *clone;
4255 PyObject *tuple;
4256 int y = GET_YEAR(self);
4257 int m = GET_MONTH(self);
4258 int d = GET_DAY(self);
4259 int hh = DATE_GET_HOUR(self);
4260 int mm = DATE_GET_MINUTE(self);
4261 int ss = DATE_GET_SECOND(self);
4262 int us = DATE_GET_MICROSECOND(self);
Tim Petersa9bc1682003-01-11 03:39:11 +00004263 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00004264
4265 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO:replace",
Tim Petersa9bc1682003-01-11 03:39:11 +00004266 datetime_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00004267 &y, &m, &d, &hh, &mm, &ss, &us,
4268 &tzinfo))
4269 return NULL;
4270 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
4271 if (tuple == NULL)
4272 return NULL;
Martin v. Löwis68192102007-07-21 06:55:02 +00004273 clone = datetime_new(Py_Type(self), tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00004274 Py_DECREF(tuple);
4275 return clone;
4276}
4277
4278static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004279datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters80475bb2002-12-25 07:40:55 +00004280{
Tim Peters52dcce22003-01-23 16:36:11 +00004281 int y, m, d, hh, mm, ss, us;
Tim Peters521fc152002-12-31 17:36:56 +00004282 PyObject *result;
Tim Peters52dcce22003-01-23 16:36:11 +00004283 int offset, none;
Tim Peters521fc152002-12-31 17:36:56 +00004284
Tim Peters80475bb2002-12-25 07:40:55 +00004285 PyObject *tzinfo;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004286 static char *keywords[] = {"tz", NULL};
Tim Peters80475bb2002-12-25 07:40:55 +00004287
Tim Peters52dcce22003-01-23 16:36:11 +00004288 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:astimezone", keywords,
4289 &PyDateTime_TZInfoType, &tzinfo))
Tim Peters80475bb2002-12-25 07:40:55 +00004290 return NULL;
4291
Tim Peters52dcce22003-01-23 16:36:11 +00004292 if (!HASTZINFO(self) || self->tzinfo == Py_None)
4293 goto NeedAware;
Tim Peters521fc152002-12-31 17:36:56 +00004294
Tim Peters52dcce22003-01-23 16:36:11 +00004295 /* Conversion to self's own time zone is a NOP. */
4296 if (self->tzinfo == tzinfo) {
4297 Py_INCREF(self);
4298 return (PyObject *)self;
Tim Peters710fb152003-01-02 19:35:54 +00004299 }
Tim Peters521fc152002-12-31 17:36:56 +00004300
Tim Peters52dcce22003-01-23 16:36:11 +00004301 /* Convert self to UTC. */
4302 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4303 if (offset == -1 && PyErr_Occurred())
4304 return NULL;
4305 if (none)
4306 goto NeedAware;
Tim Petersf3615152003-01-01 21:51:37 +00004307
Tim Peters52dcce22003-01-23 16:36:11 +00004308 y = GET_YEAR(self);
4309 m = GET_MONTH(self);
4310 d = GET_DAY(self);
4311 hh = DATE_GET_HOUR(self);
4312 mm = DATE_GET_MINUTE(self);
4313 ss = DATE_GET_SECOND(self);
4314 us = DATE_GET_MICROSECOND(self);
4315
4316 mm -= offset;
Tim Petersf3615152003-01-01 21:51:37 +00004317 if ((mm < 0 || mm >= 60) &&
4318 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Peters52dcce22003-01-23 16:36:11 +00004319 return NULL;
4320
4321 /* Attach new tzinfo and let fromutc() do the rest. */
4322 result = new_datetime(y, m, d, hh, mm, ss, us, tzinfo);
4323 if (result != NULL) {
4324 PyObject *temp = result;
4325
4326 result = PyObject_CallMethod(tzinfo, "fromutc", "O", temp);
4327 Py_DECREF(temp);
4328 }
Tim Petersadf64202003-01-04 06:03:15 +00004329 return result;
Tim Peters521fc152002-12-31 17:36:56 +00004330
Tim Peters52dcce22003-01-23 16:36:11 +00004331NeedAware:
4332 PyErr_SetString(PyExc_ValueError, "astimezone() cannot be applied to "
4333 "a naive datetime");
Tim Peters521fc152002-12-31 17:36:56 +00004334 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00004335}
4336
4337static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004338datetime_timetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004339{
4340 int dstflag = -1;
4341
Tim Petersa9bc1682003-01-11 03:39:11 +00004342 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004343 int none;
4344
4345 dstflag = call_dst(self->tzinfo, (PyObject *)self, &none);
4346 if (dstflag == -1 && PyErr_Occurred())
4347 return NULL;
4348
4349 if (none)
4350 dstflag = -1;
4351 else if (dstflag != 0)
4352 dstflag = 1;
4353
4354 }
4355 return build_struct_time(GET_YEAR(self),
4356 GET_MONTH(self),
4357 GET_DAY(self),
4358 DATE_GET_HOUR(self),
4359 DATE_GET_MINUTE(self),
4360 DATE_GET_SECOND(self),
4361 dstflag);
4362}
4363
4364static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004365datetime_getdate(PyDateTime_DateTime *self)
4366{
4367 return new_date(GET_YEAR(self),
4368 GET_MONTH(self),
4369 GET_DAY(self));
4370}
4371
4372static PyObject *
4373datetime_gettime(PyDateTime_DateTime *self)
4374{
4375 return new_time(DATE_GET_HOUR(self),
4376 DATE_GET_MINUTE(self),
4377 DATE_GET_SECOND(self),
4378 DATE_GET_MICROSECOND(self),
4379 Py_None);
4380}
4381
4382static PyObject *
4383datetime_gettimetz(PyDateTime_DateTime *self)
4384{
4385 return new_time(DATE_GET_HOUR(self),
4386 DATE_GET_MINUTE(self),
4387 DATE_GET_SECOND(self),
4388 DATE_GET_MICROSECOND(self),
4389 HASTZINFO(self) ? self->tzinfo : Py_None);
4390}
4391
4392static PyObject *
4393datetime_utctimetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004394{
4395 int y = GET_YEAR(self);
4396 int m = GET_MONTH(self);
4397 int d = GET_DAY(self);
4398 int hh = DATE_GET_HOUR(self);
4399 int mm = DATE_GET_MINUTE(self);
4400 int ss = DATE_GET_SECOND(self);
4401 int us = 0; /* microseconds are ignored in a timetuple */
4402 int offset = 0;
4403
Tim Petersa9bc1682003-01-11 03:39:11 +00004404 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004405 int none;
4406
4407 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4408 if (offset == -1 && PyErr_Occurred())
4409 return NULL;
4410 }
4411 /* Even if offset is 0, don't call timetuple() -- tm_isdst should be
4412 * 0 in a UTC timetuple regardless of what dst() says.
4413 */
4414 if (offset) {
4415 /* Subtract offset minutes & normalize. */
4416 int stat;
4417
4418 mm -= offset;
4419 stat = normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us);
4420 if (stat < 0) {
4421 /* At the edges, it's possible we overflowed
4422 * beyond MINYEAR or MAXYEAR.
4423 */
4424 if (PyErr_ExceptionMatches(PyExc_OverflowError))
4425 PyErr_Clear();
4426 else
4427 return NULL;
4428 }
4429 }
4430 return build_struct_time(y, m, d, hh, mm, ss, 0);
4431}
4432
Tim Peters371935f2003-02-01 01:52:50 +00004433/* Pickle support, a simple use of __reduce__. */
Tim Peters33e0f382003-01-10 02:05:14 +00004434
Tim Petersa9bc1682003-01-11 03:39:11 +00004435/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004436 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4437 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00004438 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00004439 */
4440static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004441datetime_getstate(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004442{
4443 PyObject *basestate;
4444 PyObject *result = NULL;
4445
Tim Peters33e0f382003-01-10 02:05:14 +00004446 basestate = PyString_FromStringAndSize((char *)self->data,
4447 _PyDateTime_DATETIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00004448 if (basestate != NULL) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004449 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004450 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00004451 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004452 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00004453 Py_DECREF(basestate);
4454 }
4455 return result;
4456}
4457
4458static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00004459datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00004460{
Martin v. Löwis68192102007-07-21 06:55:02 +00004461 return Py_BuildValue("(ON)", Py_Type(self), datetime_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00004462}
4463
Tim Petersa9bc1682003-01-11 03:39:11 +00004464static PyMethodDef datetime_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004465
Tim Peters2a799bf2002-12-16 20:18:38 +00004466 /* Class methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00004467
Tim Petersa9bc1682003-01-11 03:39:11 +00004468 {"now", (PyCFunction)datetime_now,
Neal Norwitza84dcd72007-05-22 07:16:44 +00004469 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
Neal Norwitz2fbe5372003-01-23 21:09:05 +00004470 PyDoc_STR("[tz] -> new datetime with tz's local day and time.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004471
Tim Petersa9bc1682003-01-11 03:39:11 +00004472 {"utcnow", (PyCFunction)datetime_utcnow,
4473 METH_NOARGS | METH_CLASS,
4474 PyDoc_STR("Return a new datetime representing UTC day and time.")},
4475
4476 {"fromtimestamp", (PyCFunction)datetime_fromtimestamp,
Neal Norwitza84dcd72007-05-22 07:16:44 +00004477 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
Tim Peters2a44a8d2003-01-23 20:53:10 +00004478 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004479
Tim Petersa9bc1682003-01-11 03:39:11 +00004480 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
4481 METH_VARARGS | METH_CLASS,
4482 PyDoc_STR("timestamp -> UTC datetime from a POSIX timestamp "
4483 "(like time.time()).")},
4484
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004485 {"strptime", (PyCFunction)datetime_strptime,
4486 METH_VARARGS | METH_CLASS,
4487 PyDoc_STR("string, format -> new datetime parsed from a string "
4488 "(like time.strptime()).")},
4489
Tim Petersa9bc1682003-01-11 03:39:11 +00004490 {"combine", (PyCFunction)datetime_combine,
4491 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4492 PyDoc_STR("date, time -> datetime with same date and time fields")},
4493
Tim Peters2a799bf2002-12-16 20:18:38 +00004494 /* Instance methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00004495
Tim Petersa9bc1682003-01-11 03:39:11 +00004496 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
4497 PyDoc_STR("Return date object with same year, month and day.")},
4498
4499 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
4500 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
4501
4502 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
4503 PyDoc_STR("Return time object with same time and tzinfo.")},
4504
4505 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
4506 PyDoc_STR("Return ctime() style string.")},
4507
4508 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004509 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
4510
Tim Petersa9bc1682003-01-11 03:39:11 +00004511 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004512 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
4513
Neal Norwitza84dcd72007-05-22 07:16:44 +00004514 {"isoformat", (PyCFunction)datetime_isoformat, METH_VARARGS | METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004515 PyDoc_STR("[sep] -> string in ISO 8601 format, "
4516 "YYYY-MM-DDTHH:MM:SS[.mmmmmm][+HH:MM].\n\n"
4517 "sep is used to separate the year from the time, and "
4518 "defaults to 'T'.")},
4519
Tim Petersa9bc1682003-01-11 03:39:11 +00004520 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004521 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
4522
Tim Petersa9bc1682003-01-11 03:39:11 +00004523 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004524 PyDoc_STR("Return self.tzinfo.tzname(self).")},
4525
Tim Petersa9bc1682003-01-11 03:39:11 +00004526 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004527 PyDoc_STR("Return self.tzinfo.dst(self).")},
4528
Neal Norwitza84dcd72007-05-22 07:16:44 +00004529 {"replace", (PyCFunction)datetime_replace, METH_VARARGS | METH_KEYWORDS,
Tim Petersa9bc1682003-01-11 03:39:11 +00004530 PyDoc_STR("Return datetime with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00004531
Neal Norwitza84dcd72007-05-22 07:16:44 +00004532 {"astimezone", (PyCFunction)datetime_astimezone, METH_VARARGS | METH_KEYWORDS,
Tim Peters80475bb2002-12-25 07:40:55 +00004533 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
4534
Guido van Rossum177e41a2003-01-30 22:06:23 +00004535 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
4536 PyDoc_STR("__reduce__() -> (cls, state)")},
4537
Tim Peters2a799bf2002-12-16 20:18:38 +00004538 {NULL, NULL}
4539};
4540
Tim Petersa9bc1682003-01-11 03:39:11 +00004541static char datetime_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00004542PyDoc_STR("datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])\n\
4543\n\
4544The year, month and day arguments are required. tzinfo may be None, or an\n\
4545instance of a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00004546
Tim Petersa9bc1682003-01-11 03:39:11 +00004547static PyNumberMethods datetime_as_number = {
4548 datetime_add, /* nb_add */
4549 datetime_subtract, /* nb_subtract */
Tim Peters2a799bf2002-12-16 20:18:38 +00004550 0, /* nb_multiply */
4551 0, /* nb_divide */
4552 0, /* nb_remainder */
4553 0, /* nb_divmod */
4554 0, /* nb_power */
4555 0, /* nb_negative */
4556 0, /* nb_positive */
4557 0, /* nb_absolute */
4558 0, /* nb_nonzero */
4559};
4560
Tim Petersa9bc1682003-01-11 03:39:11 +00004561statichere PyTypeObject PyDateTime_DateTimeType = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004562 PyObject_HEAD_INIT(NULL)
4563 0, /* ob_size */
Tim Peters0bf60bd2003-01-08 20:40:01 +00004564 "datetime.datetime", /* tp_name */
Tim Petersa9bc1682003-01-11 03:39:11 +00004565 sizeof(PyDateTime_DateTime), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00004566 0, /* tp_itemsize */
Tim Petersa9bc1682003-01-11 03:39:11 +00004567 (destructor)datetime_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004568 0, /* tp_print */
4569 0, /* tp_getattr */
4570 0, /* tp_setattr */
4571 0, /* tp_compare */
Tim Petersa9bc1682003-01-11 03:39:11 +00004572 (reprfunc)datetime_repr, /* tp_repr */
4573 &datetime_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00004574 0, /* tp_as_sequence */
4575 0, /* tp_as_mapping */
Tim Petersa9bc1682003-01-11 03:39:11 +00004576 (hashfunc)datetime_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00004577 0, /* tp_call */
Tim Petersa9bc1682003-01-11 03:39:11 +00004578 (reprfunc)datetime_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00004579 PyObject_GenericGetAttr, /* tp_getattro */
4580 0, /* tp_setattro */
4581 0, /* tp_as_buffer */
4582 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_CHECKTYPES |
4583 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Petersa9bc1682003-01-11 03:39:11 +00004584 datetime_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004585 0, /* tp_traverse */
4586 0, /* tp_clear */
Tim Petersa9bc1682003-01-11 03:39:11 +00004587 (richcmpfunc)datetime_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00004588 0, /* tp_weaklistoffset */
4589 0, /* tp_iter */
4590 0, /* tp_iternext */
Tim Petersa9bc1682003-01-11 03:39:11 +00004591 datetime_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00004592 0, /* tp_members */
Tim Petersa9bc1682003-01-11 03:39:11 +00004593 datetime_getset, /* tp_getset */
4594 &PyDateTime_DateType, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00004595 0, /* tp_dict */
4596 0, /* tp_descr_get */
4597 0, /* tp_descr_set */
4598 0, /* tp_dictoffset */
4599 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00004600 datetime_alloc, /* tp_alloc */
Tim Petersa9bc1682003-01-11 03:39:11 +00004601 datetime_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00004602 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00004603};
4604
4605/* ---------------------------------------------------------------------------
4606 * Module methods and initialization.
4607 */
4608
4609static PyMethodDef module_methods[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004610 {NULL, NULL}
4611};
4612
Tim Peters9ddf40b2004-06-20 22:41:32 +00004613/* C API. Clients get at this via PyDateTime_IMPORT, defined in
4614 * datetime.h.
4615 */
4616static PyDateTime_CAPI CAPI = {
4617 &PyDateTime_DateType,
4618 &PyDateTime_DateTimeType,
4619 &PyDateTime_TimeType,
4620 &PyDateTime_DeltaType,
4621 &PyDateTime_TZInfoType,
4622 new_date_ex,
4623 new_datetime_ex,
4624 new_time_ex,
4625 new_delta_ex,
4626 datetime_fromtimestamp,
4627 date_fromtimestamp
4628};
4629
4630
Tim Peters2a799bf2002-12-16 20:18:38 +00004631PyMODINIT_FUNC
4632initdatetime(void)
4633{
4634 PyObject *m; /* a module object */
4635 PyObject *d; /* its dict */
4636 PyObject *x;
4637
Tim Peters2a799bf2002-12-16 20:18:38 +00004638 m = Py_InitModule3("datetime", module_methods,
4639 "Fast implementation of the datetime type.");
Neal Norwitz1ac754f2006-01-19 06:09:39 +00004640 if (m == NULL)
4641 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004642
4643 if (PyType_Ready(&PyDateTime_DateType) < 0)
4644 return;
4645 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
4646 return;
4647 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
4648 return;
4649 if (PyType_Ready(&PyDateTime_TimeType) < 0)
4650 return;
4651 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
4652 return;
Tim Peters2a799bf2002-12-16 20:18:38 +00004653
Tim Peters2a799bf2002-12-16 20:18:38 +00004654 /* timedelta values */
4655 d = PyDateTime_DeltaType.tp_dict;
4656
Tim Peters2a799bf2002-12-16 20:18:38 +00004657 x = new_delta(0, 0, 1, 0);
4658 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4659 return;
4660 Py_DECREF(x);
4661
4662 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
4663 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4664 return;
4665 Py_DECREF(x);
4666
4667 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
4668 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4669 return;
4670 Py_DECREF(x);
4671
4672 /* date values */
4673 d = PyDateTime_DateType.tp_dict;
4674
4675 x = new_date(1, 1, 1);
4676 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4677 return;
4678 Py_DECREF(x);
4679
4680 x = new_date(MAXYEAR, 12, 31);
4681 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4682 return;
4683 Py_DECREF(x);
4684
4685 x = new_delta(1, 0, 0, 0);
4686 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4687 return;
4688 Py_DECREF(x);
4689
Tim Peters37f39822003-01-10 03:49:02 +00004690 /* time values */
4691 d = PyDateTime_TimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004692
Tim Peters37f39822003-01-10 03:49:02 +00004693 x = new_time(0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004694 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4695 return;
4696 Py_DECREF(x);
4697
Tim Peters37f39822003-01-10 03:49:02 +00004698 x = new_time(23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004699 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4700 return;
4701 Py_DECREF(x);
4702
4703 x = new_delta(0, 0, 1, 0);
4704 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4705 return;
4706 Py_DECREF(x);
4707
Tim Petersa9bc1682003-01-11 03:39:11 +00004708 /* datetime values */
4709 d = PyDateTime_DateTimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004710
Tim Petersa9bc1682003-01-11 03:39:11 +00004711 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004712 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
4713 return;
4714 Py_DECREF(x);
4715
Tim Petersa9bc1682003-01-11 03:39:11 +00004716 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004717 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
4718 return;
4719 Py_DECREF(x);
4720
4721 x = new_delta(0, 0, 1, 0);
4722 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
4723 return;
4724 Py_DECREF(x);
4725
Tim Peters2a799bf2002-12-16 20:18:38 +00004726 /* module initialization */
4727 PyModule_AddIntConstant(m, "MINYEAR", MINYEAR);
4728 PyModule_AddIntConstant(m, "MAXYEAR", MAXYEAR);
4729
4730 Py_INCREF(&PyDateTime_DateType);
4731 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
4732
Tim Petersa9bc1682003-01-11 03:39:11 +00004733 Py_INCREF(&PyDateTime_DateTimeType);
4734 PyModule_AddObject(m, "datetime",
4735 (PyObject *)&PyDateTime_DateTimeType);
4736
4737 Py_INCREF(&PyDateTime_TimeType);
4738 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
4739
Tim Peters2a799bf2002-12-16 20:18:38 +00004740 Py_INCREF(&PyDateTime_DeltaType);
4741 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
4742
Tim Peters2a799bf2002-12-16 20:18:38 +00004743 Py_INCREF(&PyDateTime_TZInfoType);
4744 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
4745
Tim Peters9ddf40b2004-06-20 22:41:32 +00004746 x = PyCObject_FromVoidPtrAndDesc(&CAPI, (void*) DATETIME_API_MAGIC,
4747 NULL);
4748 if (x == NULL)
4749 return;
4750 PyModule_AddObject(m, "datetime_CAPI", x);
4751
Tim Peters2a799bf2002-12-16 20:18:38 +00004752 /* A 4-year cycle has an extra leap day over what we'd get from
4753 * pasting together 4 single years.
4754 */
4755 assert(DI4Y == 4 * 365 + 1);
4756 assert(DI4Y == days_before_year(4+1));
4757
4758 /* Similarly, a 400-year cycle has an extra leap day over what we'd
4759 * get from pasting together 4 100-year cycles.
4760 */
4761 assert(DI400Y == 4 * DI100Y + 1);
4762 assert(DI400Y == days_before_year(400+1));
4763
4764 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
4765 * pasting together 25 4-year cycles.
4766 */
4767 assert(DI100Y == 25 * DI4Y - 1);
4768 assert(DI100Y == days_before_year(100+1));
4769
4770 us_per_us = PyInt_FromLong(1);
4771 us_per_ms = PyInt_FromLong(1000);
4772 us_per_second = PyInt_FromLong(1000000);
4773 us_per_minute = PyInt_FromLong(60000000);
4774 seconds_per_day = PyInt_FromLong(24 * 3600);
4775 if (us_per_us == NULL || us_per_ms == NULL || us_per_second == NULL ||
4776 us_per_minute == NULL || seconds_per_day == NULL)
4777 return;
4778
4779 /* The rest are too big for 32-bit ints, but even
4780 * us_per_week fits in 40 bits, so doubles should be exact.
4781 */
4782 us_per_hour = PyLong_FromDouble(3600000000.0);
4783 us_per_day = PyLong_FromDouble(86400000000.0);
4784 us_per_week = PyLong_FromDouble(604800000000.0);
4785 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
4786 return;
4787}
Tim Petersf3615152003-01-01 21:51:37 +00004788
4789/* ---------------------------------------------------------------------------
Tim Petersa9bc1682003-01-11 03:39:11 +00004790Some time zone algebra. For a datetime x, let
Tim Petersf3615152003-01-01 21:51:37 +00004791 x.n = x stripped of its timezone -- its naive time.
4792 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
4793 return None
4794 x.d = x.dst(), and assuming that doesn't raise an exception or
4795 return None
4796 x.s = x's standard offset, x.o - x.d
4797
4798Now some derived rules, where k is a duration (timedelta).
4799
48001. x.o = x.s + x.d
4801 This follows from the definition of x.s.
4802
Tim Petersc5dc4da2003-01-02 17:55:03 +000048032. If x and y have the same tzinfo member, x.s = y.s.
Tim Petersf3615152003-01-01 21:51:37 +00004804 This is actually a requirement, an assumption we need to make about
4805 sane tzinfo classes.
4806
48073. The naive UTC time corresponding to x is x.n - x.o.
4808 This is again a requirement for a sane tzinfo class.
4809
48104. (x+k).s = x.s
Tim Peters8bb5ad22003-01-24 02:44:45 +00004811 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
Tim Petersf3615152003-01-01 21:51:37 +00004812
Tim Petersc5dc4da2003-01-02 17:55:03 +000048135. (x+k).n = x.n + k
Tim Petersf3615152003-01-01 21:51:37 +00004814 Again follows from how arithmetic is defined.
4815
Tim Peters8bb5ad22003-01-24 02:44:45 +00004816Now we can explain tz.fromutc(x). Let's assume it's an interesting case
Tim Petersf3615152003-01-01 21:51:37 +00004817(meaning that the various tzinfo methods exist, and don't blow up or return
4818None when called).
4819
Tim Petersa9bc1682003-01-11 03:39:11 +00004820The function wants to return a datetime y with timezone tz, equivalent to x.
Tim Peters8bb5ad22003-01-24 02:44:45 +00004821x is already in UTC.
Tim Petersf3615152003-01-01 21:51:37 +00004822
4823By #3, we want
4824
Tim Peters8bb5ad22003-01-24 02:44:45 +00004825 y.n - y.o = x.n [1]
Tim Petersf3615152003-01-01 21:51:37 +00004826
4827The algorithm starts by attaching tz to x.n, and calling that y. So
4828x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
4829becomes true; in effect, we want to solve [2] for k:
4830
Tim Peters8bb5ad22003-01-24 02:44:45 +00004831 (y+k).n - (y+k).o = x.n [2]
Tim Petersf3615152003-01-01 21:51:37 +00004832
4833By #1, this is the same as
4834
Tim Peters8bb5ad22003-01-24 02:44:45 +00004835 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
Tim Petersf3615152003-01-01 21:51:37 +00004836
4837By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
4838Substituting that into [3],
4839
Tim Peters8bb5ad22003-01-24 02:44:45 +00004840 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
4841 k - (y+k).s - (y+k).d = 0; rearranging,
4842 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
4843 k = y.s - (y+k).d
Tim Petersf3615152003-01-01 21:51:37 +00004844
Tim Peters8bb5ad22003-01-24 02:44:45 +00004845On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
4846approximate k by ignoring the (y+k).d term at first. Note that k can't be
4847very large, since all offset-returning methods return a duration of magnitude
4848less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
4849be 0, so ignoring it has no consequence then.
Tim Petersf3615152003-01-01 21:51:37 +00004850
4851In any case, the new value is
4852
Tim Peters8bb5ad22003-01-24 02:44:45 +00004853 z = y + y.s [4]
Tim Petersf3615152003-01-01 21:51:37 +00004854
Tim Peters8bb5ad22003-01-24 02:44:45 +00004855It's helpful to step back at look at [4] from a higher level: it's simply
4856mapping from UTC to tz's standard time.
Tim Petersc5dc4da2003-01-02 17:55:03 +00004857
4858At this point, if
4859
Tim Peters8bb5ad22003-01-24 02:44:45 +00004860 z.n - z.o = x.n [5]
Tim Petersc5dc4da2003-01-02 17:55:03 +00004861
4862we have an equivalent time, and are almost done. The insecurity here is
Tim Petersf3615152003-01-01 21:51:37 +00004863at the start of daylight time. Picture US Eastern for concreteness. The wall
4864time 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 +00004865sense then. The docs ask that an Eastern tzinfo class consider such a time to
4866be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
4867on the day DST starts. We want to return the 1:MM EST spelling because that's
Tim Petersf3615152003-01-01 21:51:37 +00004868the only spelling that makes sense on the local wall clock.
4869
Tim Petersc5dc4da2003-01-02 17:55:03 +00004870In fact, if [5] holds at this point, we do have the standard-time spelling,
4871but that takes a bit of proof. We first prove a stronger result. What's the
4872difference between the LHS and RHS of [5]? Let
Tim Petersf3615152003-01-01 21:51:37 +00004873
Tim Peters8bb5ad22003-01-24 02:44:45 +00004874 diff = x.n - (z.n - z.o) [6]
Tim Petersf3615152003-01-01 21:51:37 +00004875
Tim Petersc5dc4da2003-01-02 17:55:03 +00004876Now
4877 z.n = by [4]
Tim Peters8bb5ad22003-01-24 02:44:45 +00004878 (y + y.s).n = by #5
4879 y.n + y.s = since y.n = x.n
4880 x.n + y.s = since z and y are have the same tzinfo member,
4881 y.s = z.s by #2
4882 x.n + z.s
Tim Petersf3615152003-01-01 21:51:37 +00004883
Tim Petersc5dc4da2003-01-02 17:55:03 +00004884Plugging that back into [6] gives
Tim Petersf3615152003-01-01 21:51:37 +00004885
Tim Petersc5dc4da2003-01-02 17:55:03 +00004886 diff =
Tim Peters8bb5ad22003-01-24 02:44:45 +00004887 x.n - ((x.n + z.s) - z.o) = expanding
4888 x.n - x.n - z.s + z.o = cancelling
4889 - z.s + z.o = by #2
Tim Petersc5dc4da2003-01-02 17:55:03 +00004890 z.d
Tim Petersf3615152003-01-01 21:51:37 +00004891
Tim Petersc5dc4da2003-01-02 17:55:03 +00004892So diff = z.d.
Tim Petersf3615152003-01-01 21:51:37 +00004893
Tim Petersc5dc4da2003-01-02 17:55:03 +00004894If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
Tim Peters8bb5ad22003-01-24 02:44:45 +00004895spelling we wanted in the endcase described above. We're done. Contrarily,
4896if z.d = 0, then we have a UTC equivalent, and are also done.
Tim Petersf3615152003-01-01 21:51:37 +00004897
Tim Petersc5dc4da2003-01-02 17:55:03 +00004898If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
4899add to z (in effect, z is in tz's standard time, and we need to shift the
Tim Peters8bb5ad22003-01-24 02:44:45 +00004900local clock into tz's daylight time).
Tim Petersf3615152003-01-01 21:51:37 +00004901
Tim Petersc5dc4da2003-01-02 17:55:03 +00004902Let
Tim Petersf3615152003-01-01 21:51:37 +00004903
Tim Peters4fede1a2003-01-04 00:26:59 +00004904 z' = z + z.d = z + diff [7]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004905
Tim Peters4fede1a2003-01-04 00:26:59 +00004906and we can again ask whether
Tim Petersc3bb26a2003-01-02 03:14:59 +00004907
Tim Peters8bb5ad22003-01-24 02:44:45 +00004908 z'.n - z'.o = x.n [8]
Tim Petersc3bb26a2003-01-02 03:14:59 +00004909
Tim Peters8bb5ad22003-01-24 02:44:45 +00004910If so, we're done. If not, the tzinfo class is insane, according to the
4911assumptions we've made. This also requires a bit of proof. As before, let's
4912compute the difference between the LHS and RHS of [8] (and skipping some of
4913the justifications for the kinds of substitutions we've done several times
4914already):
Tim Peters4fede1a2003-01-04 00:26:59 +00004915
Tim Peters8bb5ad22003-01-24 02:44:45 +00004916 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
4917 x.n - (z.n + diff - z'.o) = replacing diff via [6]
4918 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
4919 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
4920 - z.n + z.n - z.o + z'.o = cancel z.n
Tim Peters4fede1a2003-01-04 00:26:59 +00004921 - z.o + z'.o = #1 twice
4922 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
4923 z'.d - z.d
4924
4925So 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 +00004926we've found the UTC-equivalent so are done. In fact, we stop with [7] and
4927return z', not bothering to compute z'.d.
Tim Peters4fede1a2003-01-04 00:26:59 +00004928
Tim Peters8bb5ad22003-01-24 02:44:45 +00004929How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
4930a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
4931would have to change the result dst() returns: we start in DST, and moving
4932a little further into it takes us out of DST.
Tim Peters4fede1a2003-01-04 00:26:59 +00004933
Tim Peters8bb5ad22003-01-24 02:44:45 +00004934There isn't a sane case where this can happen. The closest it gets is at
4935the end of DST, where there's an hour in UTC with no spelling in a hybrid
4936tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
4937that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
4938UTC) because the docs insist on that, but 0:MM is taken as being in daylight
4939time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
4940clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
4941standard time. Since that's what the local clock *does*, we want to map both
4942UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
Tim Peters4fede1a2003-01-04 00:26:59 +00004943in local time, but so it goes -- it's the way the local clock works.
4944
Tim Peters8bb5ad22003-01-24 02:44:45 +00004945When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
4946so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
4947z' = 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 +00004948(correctly) concludes that z' is not UTC-equivalent to x.
4949
4950Because we know z.d said z was in daylight time (else [5] would have held and
4951we would have stopped then), and we know z.d != z'.d (else [8] would have held
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00004952and we would have stopped then), and there are only 2 possible values dst() can
Tim Peters4fede1a2003-01-04 00:26:59 +00004953return in Eastern, it follows that z'.d must be 0 (which it is in the example,
4954but the reasoning doesn't depend on the example -- it depends on there being
4955two possible dst() outcomes, one zero and the other non-zero). Therefore
Tim Peters8bb5ad22003-01-24 02:44:45 +00004956z' must be in standard time, and is the spelling we want in this case.
4957
4958Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
4959concerned (because it takes z' as being in standard time rather than the
4960daylight time we intend here), but returning it gives the real-life "local
4961clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
4962tz.
4963
4964When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
4965the 1:MM standard time spelling we want.
4966
4967So how can this break? One of the assumptions must be violated. Two
4968possibilities:
4969
49701) [2] effectively says that y.s is invariant across all y belong to a given
4971 time zone. This isn't true if, for political reasons or continental drift,
4972 a region decides to change its base offset from UTC.
4973
49742) There may be versions of "double daylight" time where the tail end of
4975 the analysis gives up a step too early. I haven't thought about that
4976 enough to say.
4977
4978In any case, it's clear that the default fromutc() is strong enough to handle
4979"almost all" time zones: so long as the standard offset is invariant, it
4980doesn't matter if daylight time transition points change from year to year, or
4981if daylight time is skipped in some years; it doesn't matter how large or
4982small dst() may get within its bounds; and it doesn't even matter if some
4983perverse time zone returns a negative dst()). So a breaking case must be
4984pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
Tim Petersf3615152003-01-01 21:51:37 +00004985--------------------------------------------------------------------------- */