blob: 6ff7eb3c0a27bb37ebaf1281c82258674fb3cb06 [file] [log] [blame]
Tim Peters2a799bf2002-12-16 20:18:38 +00001/* C implementation for the date/time type documented at
2 * http://www.zope.org/Members/fdrake/DateTimeWiki/FrontPage
3 */
4
5#include "Python.h"
6#include "modsupport.h"
7#include "structmember.h"
8
9#include <time.h>
10
Tim Peters1b6f7a92004-06-20 02:50:16 +000011#include "timefuncs.h"
Tim Peters9ddf40b2004-06-20 22:41:32 +000012
13/* Differentiate between building the core module and building extension
14 * modules.
15 */
Guido van Rossum360e4b82007-05-14 22:51:27 +000016#ifndef Py_BUILD_CORE
Tim Peters9ddf40b2004-06-20 22:41:32 +000017#define Py_BUILD_CORE
Guido van Rossum360e4b82007-05-14 22:51:27 +000018#endif
Tim Peters2a799bf2002-12-16 20:18:38 +000019#include "datetime.h"
Tim Peters9ddf40b2004-06-20 22:41:32 +000020#undef Py_BUILD_CORE
Tim Peters2a799bf2002-12-16 20:18:38 +000021
22/* We require that C int be at least 32 bits, and use int virtually
23 * everywhere. In just a few cases we use a temp long, where a Python
24 * API returns a C long. In such cases, we have to ensure that the
25 * final result fits in a C int (this can be an issue on 64-bit boxes).
26 */
27#if SIZEOF_INT < 4
28# error "datetime.c requires that C int have at least 32 bits"
29#endif
30
31#define MINYEAR 1
32#define MAXYEAR 9999
33
34/* Nine decimal digits is easy to communicate, and leaves enough room
35 * so that two delta days can be added w/o fear of overflowing a signed
36 * 32-bit int, and with plenty of room left over to absorb any possible
37 * carries from adding seconds.
38 */
39#define MAX_DELTA_DAYS 999999999
40
41/* Rename the long macros in datetime.h to more reasonable short names. */
42#define GET_YEAR PyDateTime_GET_YEAR
43#define GET_MONTH PyDateTime_GET_MONTH
44#define GET_DAY PyDateTime_GET_DAY
45#define DATE_GET_HOUR PyDateTime_DATE_GET_HOUR
46#define DATE_GET_MINUTE PyDateTime_DATE_GET_MINUTE
47#define DATE_GET_SECOND PyDateTime_DATE_GET_SECOND
48#define DATE_GET_MICROSECOND PyDateTime_DATE_GET_MICROSECOND
49
50/* Date accessors for date and datetime. */
51#define SET_YEAR(o, v) (((o)->data[0] = ((v) & 0xff00) >> 8), \
52 ((o)->data[1] = ((v) & 0x00ff)))
53#define SET_MONTH(o, v) (PyDateTime_GET_MONTH(o) = (v))
54#define SET_DAY(o, v) (PyDateTime_GET_DAY(o) = (v))
55
56/* Date/Time accessors for datetime. */
57#define DATE_SET_HOUR(o, v) (PyDateTime_DATE_GET_HOUR(o) = (v))
58#define DATE_SET_MINUTE(o, v) (PyDateTime_DATE_GET_MINUTE(o) = (v))
59#define DATE_SET_SECOND(o, v) (PyDateTime_DATE_GET_SECOND(o) = (v))
60#define DATE_SET_MICROSECOND(o, v) \
61 (((o)->data[7] = ((v) & 0xff0000) >> 16), \
62 ((o)->data[8] = ((v) & 0x00ff00) >> 8), \
63 ((o)->data[9] = ((v) & 0x0000ff)))
64
65/* Time accessors for time. */
66#define TIME_GET_HOUR PyDateTime_TIME_GET_HOUR
67#define TIME_GET_MINUTE PyDateTime_TIME_GET_MINUTE
68#define TIME_GET_SECOND PyDateTime_TIME_GET_SECOND
69#define TIME_GET_MICROSECOND PyDateTime_TIME_GET_MICROSECOND
70#define TIME_SET_HOUR(o, v) (PyDateTime_TIME_GET_HOUR(o) = (v))
71#define TIME_SET_MINUTE(o, v) (PyDateTime_TIME_GET_MINUTE(o) = (v))
72#define TIME_SET_SECOND(o, v) (PyDateTime_TIME_GET_SECOND(o) = (v))
73#define TIME_SET_MICROSECOND(o, v) \
74 (((o)->data[3] = ((v) & 0xff0000) >> 16), \
75 ((o)->data[4] = ((v) & 0x00ff00) >> 8), \
76 ((o)->data[5] = ((v) & 0x0000ff)))
77
78/* Delta accessors for timedelta. */
79#define GET_TD_DAYS(o) (((PyDateTime_Delta *)(o))->days)
80#define GET_TD_SECONDS(o) (((PyDateTime_Delta *)(o))->seconds)
81#define GET_TD_MICROSECONDS(o) (((PyDateTime_Delta *)(o))->microseconds)
82
83#define SET_TD_DAYS(o, v) ((o)->days = (v))
84#define SET_TD_SECONDS(o, v) ((o)->seconds = (v))
85#define SET_TD_MICROSECONDS(o, v) ((o)->microseconds = (v))
86
Tim Petersa032d2e2003-01-11 00:15:54 +000087/* p is a pointer to a time or a datetime object; HASTZINFO(p) returns
88 * p->hastzinfo.
89 */
90#define HASTZINFO(p) (((_PyDateTime_BaseTZInfo *)(p))->hastzinfo)
91
Tim Peters3f606292004-03-21 23:38:41 +000092/* M is a char or int claiming to be a valid month. The macro is equivalent
93 * to the two-sided Python test
94 * 1 <= M <= 12
95 */
96#define MONTH_IS_SANE(M) ((unsigned int)(M) - 1 < 12)
97
Tim Peters2a799bf2002-12-16 20:18:38 +000098/* Forward declarations. */
99static PyTypeObject PyDateTime_DateType;
100static PyTypeObject PyDateTime_DateTimeType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000101static PyTypeObject PyDateTime_DeltaType;
102static PyTypeObject PyDateTime_TimeType;
103static PyTypeObject PyDateTime_TZInfoType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000104
105/* ---------------------------------------------------------------------------
106 * Math utilities.
107 */
108
109/* k = i+j overflows iff k differs in sign from both inputs,
110 * iff k^i has sign bit set and k^j has sign bit set,
111 * iff (k^i)&(k^j) has sign bit set.
112 */
113#define SIGNED_ADD_OVERFLOWED(RESULT, I, J) \
114 ((((RESULT) ^ (I)) & ((RESULT) ^ (J))) < 0)
115
116/* Compute Python divmod(x, y), returning the quotient and storing the
117 * remainder into *r. The quotient is the floor of x/y, and that's
118 * the real point of this. C will probably truncate instead (C99
119 * requires truncation; C89 left it implementation-defined).
120 * Simplification: we *require* that y > 0 here. That's appropriate
121 * for all the uses made of it. This simplifies the code and makes
122 * the overflow case impossible (divmod(LONG_MIN, -1) is the only
123 * overflow case).
124 */
125static int
126divmod(int x, int y, int *r)
127{
128 int quo;
129
130 assert(y > 0);
131 quo = x / y;
132 *r = x - quo * y;
133 if (*r < 0) {
134 --quo;
135 *r += y;
136 }
137 assert(0 <= *r && *r < y);
138 return quo;
139}
140
Tim Peters5d644dd2003-01-02 16:32:54 +0000141/* Round a double to the nearest long. |x| must be small enough to fit
142 * in a C long; this is not checked.
143 */
144static long
145round_to_long(double x)
146{
147 if (x >= 0.0)
148 x = floor(x + 0.5);
149 else
150 x = ceil(x - 0.5);
151 return (long)x;
152}
153
Tim Peters2a799bf2002-12-16 20:18:38 +0000154/* ---------------------------------------------------------------------------
155 * General calendrical helper functions
156 */
157
158/* For each month ordinal in 1..12, the number of days in that month,
159 * and the number of days before that month in the same year. These
160 * are correct for non-leap years only.
161 */
162static int _days_in_month[] = {
163 0, /* unused; this vector uses 1-based indexing */
164 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
165};
166
167static int _days_before_month[] = {
168 0, /* unused; this vector uses 1-based indexing */
169 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
170};
171
172/* year -> 1 if leap year, else 0. */
173static int
174is_leap(int year)
175{
176 /* Cast year to unsigned. The result is the same either way, but
177 * C can generate faster code for unsigned mod than for signed
178 * mod (especially for % 4 -- a good compiler should just grab
179 * the last 2 bits when the LHS is unsigned).
180 */
181 const unsigned int ayear = (unsigned int)year;
182 return ayear % 4 == 0 && (ayear % 100 != 0 || ayear % 400 == 0);
183}
184
185/* year, month -> number of days in that month in that year */
186static int
187days_in_month(int year, int month)
188{
189 assert(month >= 1);
190 assert(month <= 12);
191 if (month == 2 && is_leap(year))
192 return 29;
193 else
194 return _days_in_month[month];
195}
196
197/* year, month -> number of days in year preceeding first day of month */
198static int
199days_before_month(int year, int month)
200{
201 int days;
202
203 assert(month >= 1);
204 assert(month <= 12);
205 days = _days_before_month[month];
206 if (month > 2 && is_leap(year))
207 ++days;
208 return days;
209}
210
211/* year -> number of days before January 1st of year. Remember that we
212 * start with year 1, so days_before_year(1) == 0.
213 */
214static int
215days_before_year(int year)
216{
217 int y = year - 1;
218 /* This is incorrect if year <= 0; we really want the floor
219 * here. But so long as MINYEAR is 1, the smallest year this
220 * can see is 0 (this can happen in some normalization endcases),
221 * so we'll just special-case that.
222 */
223 assert (year >= 0);
224 if (y >= 0)
225 return y*365 + y/4 - y/100 + y/400;
226 else {
227 assert(y == -1);
228 return -366;
229 }
230}
231
232/* Number of days in 4, 100, and 400 year cycles. That these have
233 * the correct values is asserted in the module init function.
234 */
235#define DI4Y 1461 /* days_before_year(5); days in 4 years */
236#define DI100Y 36524 /* days_before_year(101); days in 100 years */
237#define DI400Y 146097 /* days_before_year(401); days in 400 years */
238
239/* ordinal -> year, month, day, considering 01-Jan-0001 as day 1. */
240static void
241ord_to_ymd(int ordinal, int *year, int *month, int *day)
242{
243 int n, n1, n4, n100, n400, leapyear, preceding;
244
245 /* ordinal is a 1-based index, starting at 1-Jan-1. The pattern of
246 * leap years repeats exactly every 400 years. The basic strategy is
247 * to find the closest 400-year boundary at or before ordinal, then
248 * work with the offset from that boundary to ordinal. Life is much
249 * clearer if we subtract 1 from ordinal first -- then the values
250 * of ordinal at 400-year boundaries are exactly those divisible
251 * by DI400Y:
252 *
253 * D M Y n n-1
254 * -- --- ---- ---------- ----------------
255 * 31 Dec -400 -DI400Y -DI400Y -1
256 * 1 Jan -399 -DI400Y +1 -DI400Y 400-year boundary
257 * ...
258 * 30 Dec 000 -1 -2
259 * 31 Dec 000 0 -1
260 * 1 Jan 001 1 0 400-year boundary
261 * 2 Jan 001 2 1
262 * 3 Jan 001 3 2
263 * ...
264 * 31 Dec 400 DI400Y DI400Y -1
265 * 1 Jan 401 DI400Y +1 DI400Y 400-year boundary
266 */
267 assert(ordinal >= 1);
268 --ordinal;
269 n400 = ordinal / DI400Y;
270 n = ordinal % DI400Y;
271 *year = n400 * 400 + 1;
272
273 /* Now n is the (non-negative) offset, in days, from January 1 of
274 * year, to the desired date. Now compute how many 100-year cycles
275 * precede n.
276 * Note that it's possible for n100 to equal 4! In that case 4 full
277 * 100-year cycles precede the desired day, which implies the
278 * desired day is December 31 at the end of a 400-year cycle.
279 */
280 n100 = n / DI100Y;
281 n = n % DI100Y;
282
283 /* Now compute how many 4-year cycles precede it. */
284 n4 = n / DI4Y;
285 n = n % DI4Y;
286
287 /* And now how many single years. Again n1 can be 4, and again
288 * meaning that the desired day is December 31 at the end of the
289 * 4-year cycle.
290 */
291 n1 = n / 365;
292 n = n % 365;
293
294 *year += n100 * 100 + n4 * 4 + n1;
295 if (n1 == 4 || n100 == 4) {
296 assert(n == 0);
297 *year -= 1;
298 *month = 12;
299 *day = 31;
300 return;
301 }
302
303 /* Now the year is correct, and n is the offset from January 1. We
304 * find the month via an estimate that's either exact or one too
305 * large.
306 */
307 leapyear = n1 == 3 && (n4 != 24 || n100 == 3);
308 assert(leapyear == is_leap(*year));
309 *month = (n + 50) >> 5;
310 preceding = (_days_before_month[*month] + (*month > 2 && leapyear));
311 if (preceding > n) {
312 /* estimate is too large */
313 *month -= 1;
314 preceding -= days_in_month(*year, *month);
315 }
316 n -= preceding;
317 assert(0 <= n);
318 assert(n < days_in_month(*year, *month));
319
320 *day = n + 1;
321}
322
323/* year, month, day -> ordinal, considering 01-Jan-0001 as day 1. */
324static int
325ymd_to_ord(int year, int month, int day)
326{
327 return days_before_year(year) + days_before_month(year, month) + day;
328}
329
330/* Day of week, where Monday==0, ..., Sunday==6. 1/1/1 was a Monday. */
331static int
332weekday(int year, int month, int day)
333{
334 return (ymd_to_ord(year, month, day) + 6) % 7;
335}
336
337/* Ordinal of the Monday starting week 1 of the ISO year. Week 1 is the
338 * first calendar week containing a Thursday.
339 */
340static int
341iso_week1_monday(int year)
342{
343 int first_day = ymd_to_ord(year, 1, 1); /* ord of 1/1 */
344 /* 0 if 1/1 is a Monday, 1 if a Tue, etc. */
345 int first_weekday = (first_day + 6) % 7;
346 /* ordinal of closest Monday at or before 1/1 */
347 int week1_monday = first_day - first_weekday;
348
349 if (first_weekday > 3) /* if 1/1 was Fri, Sat, Sun */
350 week1_monday += 7;
351 return week1_monday;
352}
353
354/* ---------------------------------------------------------------------------
355 * Range checkers.
356 */
357
358/* Check that -MAX_DELTA_DAYS <= days <= MAX_DELTA_DAYS. If so, return 0.
359 * If not, raise OverflowError and return -1.
360 */
361static int
362check_delta_day_range(int days)
363{
364 if (-MAX_DELTA_DAYS <= days && days <= MAX_DELTA_DAYS)
365 return 0;
366 PyErr_Format(PyExc_OverflowError,
367 "days=%d; must have magnitude <= %d",
Guido van Rossumbd43e912002-12-16 20:34:55 +0000368 days, MAX_DELTA_DAYS);
Tim Peters2a799bf2002-12-16 20:18:38 +0000369 return -1;
370}
371
372/* Check that date arguments are in range. Return 0 if they are. If they
373 * aren't, raise ValueError and return -1.
374 */
375static int
376check_date_args(int year, int month, int day)
377{
378
379 if (year < MINYEAR || year > MAXYEAR) {
380 PyErr_SetString(PyExc_ValueError,
381 "year is out of range");
382 return -1;
383 }
384 if (month < 1 || month > 12) {
385 PyErr_SetString(PyExc_ValueError,
386 "month must be in 1..12");
387 return -1;
388 }
389 if (day < 1 || day > days_in_month(year, month)) {
390 PyErr_SetString(PyExc_ValueError,
391 "day is out of range for month");
392 return -1;
393 }
394 return 0;
395}
396
397/* Check that time arguments are in range. Return 0 if they are. If they
398 * aren't, raise ValueError and return -1.
399 */
400static int
401check_time_args(int h, int m, int s, int us)
402{
403 if (h < 0 || h > 23) {
404 PyErr_SetString(PyExc_ValueError,
405 "hour must be in 0..23");
406 return -1;
407 }
408 if (m < 0 || m > 59) {
409 PyErr_SetString(PyExc_ValueError,
410 "minute must be in 0..59");
411 return -1;
412 }
413 if (s < 0 || s > 59) {
414 PyErr_SetString(PyExc_ValueError,
415 "second must be in 0..59");
416 return -1;
417 }
418 if (us < 0 || us > 999999) {
419 PyErr_SetString(PyExc_ValueError,
420 "microsecond must be in 0..999999");
421 return -1;
422 }
423 return 0;
424}
425
426/* ---------------------------------------------------------------------------
427 * Normalization utilities.
428 */
429
430/* One step of a mixed-radix conversion. A "hi" unit is equivalent to
431 * factor "lo" units. factor must be > 0. If *lo is less than 0, or
432 * at least factor, enough of *lo is converted into "hi" units so that
433 * 0 <= *lo < factor. The input values must be such that int overflow
434 * is impossible.
435 */
436static void
437normalize_pair(int *hi, int *lo, int factor)
438{
439 assert(factor > 0);
440 assert(lo != hi);
441 if (*lo < 0 || *lo >= factor) {
442 const int num_hi = divmod(*lo, factor, lo);
443 const int new_hi = *hi + num_hi;
444 assert(! SIGNED_ADD_OVERFLOWED(new_hi, *hi, num_hi));
445 *hi = new_hi;
446 }
447 assert(0 <= *lo && *lo < factor);
448}
449
450/* Fiddle days (d), seconds (s), and microseconds (us) so that
451 * 0 <= *s < 24*3600
452 * 0 <= *us < 1000000
453 * The input values must be such that the internals don't overflow.
454 * The way this routine is used, we don't get close.
455 */
456static void
457normalize_d_s_us(int *d, int *s, int *us)
458{
459 if (*us < 0 || *us >= 1000000) {
460 normalize_pair(s, us, 1000000);
461 /* |s| can't be bigger than about
462 * |original s| + |original us|/1000000 now.
463 */
464
465 }
466 if (*s < 0 || *s >= 24*3600) {
467 normalize_pair(d, s, 24*3600);
468 /* |d| can't be bigger than about
469 * |original d| +
470 * (|original s| + |original us|/1000000) / (24*3600) now.
471 */
472 }
473 assert(0 <= *s && *s < 24*3600);
474 assert(0 <= *us && *us < 1000000);
475}
476
477/* Fiddle years (y), months (m), and days (d) so that
478 * 1 <= *m <= 12
479 * 1 <= *d <= days_in_month(*y, *m)
480 * The input values must be such that the internals don't overflow.
481 * The way this routine is used, we don't get close.
482 */
483static void
484normalize_y_m_d(int *y, int *m, int *d)
485{
486 int dim; /* # of days in month */
487
488 /* This gets muddy: the proper range for day can't be determined
489 * without knowing the correct month and year, but if day is, e.g.,
490 * plus or minus a million, the current month and year values make
491 * no sense (and may also be out of bounds themselves).
492 * Saying 12 months == 1 year should be non-controversial.
493 */
494 if (*m < 1 || *m > 12) {
495 --*m;
496 normalize_pair(y, m, 12);
497 ++*m;
498 /* |y| can't be bigger than about
499 * |original y| + |original m|/12 now.
500 */
501 }
502 assert(1 <= *m && *m <= 12);
503
504 /* Now only day can be out of bounds (year may also be out of bounds
505 * for a datetime object, but we don't care about that here).
506 * If day is out of bounds, what to do is arguable, but at least the
507 * method here is principled and explainable.
508 */
509 dim = days_in_month(*y, *m);
510 if (*d < 1 || *d > dim) {
511 /* Move day-1 days from the first of the month. First try to
512 * get off cheap if we're only one day out of range
513 * (adjustments for timezone alone can't be worse than that).
514 */
515 if (*d == 0) {
516 --*m;
517 if (*m > 0)
518 *d = days_in_month(*y, *m);
519 else {
520 --*y;
521 *m = 12;
522 *d = 31;
523 }
524 }
525 else if (*d == dim + 1) {
526 /* move forward a day */
527 ++*m;
528 *d = 1;
529 if (*m > 12) {
530 *m = 1;
531 ++*y;
532 }
533 }
534 else {
535 int ordinal = ymd_to_ord(*y, *m, 1) +
536 *d - 1;
537 ord_to_ymd(ordinal, y, m, d);
538 }
539 }
540 assert(*m > 0);
541 assert(*d > 0);
542}
543
544/* Fiddle out-of-bounds months and days so that the result makes some kind
545 * of sense. The parameters are both inputs and outputs. Returns < 0 on
546 * failure, where failure means the adjusted year is out of bounds.
547 */
548static int
549normalize_date(int *year, int *month, int *day)
550{
551 int result;
552
553 normalize_y_m_d(year, month, day);
554 if (MINYEAR <= *year && *year <= MAXYEAR)
555 result = 0;
556 else {
557 PyErr_SetString(PyExc_OverflowError,
558 "date value out of range");
559 result = -1;
560 }
561 return result;
562}
563
564/* Force all the datetime fields into range. The parameters are both
565 * inputs and outputs. Returns < 0 on error.
566 */
567static int
568normalize_datetime(int *year, int *month, int *day,
569 int *hour, int *minute, int *second,
570 int *microsecond)
571{
572 normalize_pair(second, microsecond, 1000000);
573 normalize_pair(minute, second, 60);
574 normalize_pair(hour, minute, 60);
575 normalize_pair(day, hour, 24);
576 return normalize_date(year, month, day);
577}
578
579/* ---------------------------------------------------------------------------
Tim Petersb0c854d2003-05-17 15:57:00 +0000580 * Basic object allocation: tp_alloc implementations. These allocate
581 * Python objects of the right size and type, and do the Python object-
582 * initialization bit. If there's not enough memory, they return NULL after
583 * setting MemoryError. All data members remain uninitialized trash.
584 *
585 * We abuse the tp_alloc "nitems" argument to communicate whether a tzinfo
Tim Peters03eaf8b2003-05-18 02:24:46 +0000586 * member is needed. This is ugly, imprecise, and possibly insecure.
587 * tp_basicsize for the time and datetime types is set to the size of the
588 * struct that has room for the tzinfo member, so subclasses in Python will
589 * allocate enough space for a tzinfo member whether or not one is actually
590 * needed. That's the "ugly and imprecise" parts. The "possibly insecure"
591 * part is that PyType_GenericAlloc() (which subclasses in Python end up
592 * using) just happens today to effectively ignore the nitems argument
593 * when tp_itemsize is 0, which it is for these type objects. If that
594 * changes, perhaps the callers of tp_alloc slots in this file should
595 * be changed to force a 0 nitems argument unless the type being allocated
596 * is a base type implemented in this file (so that tp_alloc is time_alloc
597 * or datetime_alloc below, which know about the nitems abuse).
Tim Petersb0c854d2003-05-17 15:57:00 +0000598 */
599
600static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000601time_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000602{
603 PyObject *self;
604
605 self = (PyObject *)
606 PyObject_MALLOC(aware ?
607 sizeof(PyDateTime_Time) :
608 sizeof(_PyDateTime_BaseTime));
609 if (self == NULL)
610 return (PyObject *)PyErr_NoMemory();
611 PyObject_INIT(self, type);
612 return self;
613}
614
615static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000616datetime_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000617{
618 PyObject *self;
619
620 self = (PyObject *)
621 PyObject_MALLOC(aware ?
622 sizeof(PyDateTime_DateTime) :
623 sizeof(_PyDateTime_BaseDateTime));
624 if (self == NULL)
625 return (PyObject *)PyErr_NoMemory();
626 PyObject_INIT(self, type);
627 return self;
628}
629
630/* ---------------------------------------------------------------------------
631 * Helpers for setting object fields. These work on pointers to the
632 * appropriate base class.
633 */
634
635/* For date and datetime. */
636static void
637set_date_fields(PyDateTime_Date *self, int y, int m, int d)
638{
639 self->hashcode = -1;
640 SET_YEAR(self, y);
641 SET_MONTH(self, m);
642 SET_DAY(self, d);
643}
644
645/* ---------------------------------------------------------------------------
646 * Create various objects, mostly without range checking.
647 */
648
649/* Create a date instance with no range checking. */
650static PyObject *
651new_date_ex(int year, int month, int day, PyTypeObject *type)
652{
653 PyDateTime_Date *self;
654
655 self = (PyDateTime_Date *) (type->tp_alloc(type, 0));
656 if (self != NULL)
657 set_date_fields(self, year, month, day);
658 return (PyObject *) self;
659}
660
661#define new_date(year, month, day) \
662 new_date_ex(year, month, day, &PyDateTime_DateType)
663
664/* Create a datetime instance with no range checking. */
665static PyObject *
666new_datetime_ex(int year, int month, int day, int hour, int minute,
667 int second, int usecond, PyObject *tzinfo, PyTypeObject *type)
668{
669 PyDateTime_DateTime *self;
670 char aware = tzinfo != Py_None;
671
672 self = (PyDateTime_DateTime *) (type->tp_alloc(type, aware));
673 if (self != NULL) {
674 self->hastzinfo = aware;
675 set_date_fields((PyDateTime_Date *)self, year, month, day);
676 DATE_SET_HOUR(self, hour);
677 DATE_SET_MINUTE(self, minute);
678 DATE_SET_SECOND(self, second);
679 DATE_SET_MICROSECOND(self, usecond);
680 if (aware) {
681 Py_INCREF(tzinfo);
682 self->tzinfo = tzinfo;
683 }
684 }
685 return (PyObject *)self;
686}
687
688#define new_datetime(y, m, d, hh, mm, ss, us, tzinfo) \
689 new_datetime_ex(y, m, d, hh, mm, ss, us, tzinfo, \
690 &PyDateTime_DateTimeType)
691
692/* Create a time instance with no range checking. */
693static PyObject *
694new_time_ex(int hour, int minute, int second, int usecond,
695 PyObject *tzinfo, PyTypeObject *type)
696{
697 PyDateTime_Time *self;
698 char aware = tzinfo != Py_None;
699
700 self = (PyDateTime_Time *) (type->tp_alloc(type, aware));
701 if (self != NULL) {
702 self->hastzinfo = aware;
703 self->hashcode = -1;
704 TIME_SET_HOUR(self, hour);
705 TIME_SET_MINUTE(self, minute);
706 TIME_SET_SECOND(self, second);
707 TIME_SET_MICROSECOND(self, usecond);
708 if (aware) {
709 Py_INCREF(tzinfo);
710 self->tzinfo = tzinfo;
711 }
712 }
713 return (PyObject *)self;
714}
715
716#define new_time(hh, mm, ss, us, tzinfo) \
717 new_time_ex(hh, mm, ss, us, tzinfo, &PyDateTime_TimeType)
718
719/* Create a timedelta instance. Normalize the members iff normalize is
720 * true. Passing false is a speed optimization, if you know for sure
721 * that seconds and microseconds are already in their proper ranges. In any
722 * case, raises OverflowError and returns NULL if the normalized days is out
723 * of range).
724 */
725static PyObject *
726new_delta_ex(int days, int seconds, int microseconds, int normalize,
727 PyTypeObject *type)
728{
729 PyDateTime_Delta *self;
730
731 if (normalize)
732 normalize_d_s_us(&days, &seconds, &microseconds);
733 assert(0 <= seconds && seconds < 24*3600);
734 assert(0 <= microseconds && microseconds < 1000000);
735
736 if (check_delta_day_range(days) < 0)
737 return NULL;
738
739 self = (PyDateTime_Delta *) (type->tp_alloc(type, 0));
740 if (self != NULL) {
741 self->hashcode = -1;
742 SET_TD_DAYS(self, days);
743 SET_TD_SECONDS(self, seconds);
744 SET_TD_MICROSECONDS(self, microseconds);
745 }
746 return (PyObject *) self;
747}
748
749#define new_delta(d, s, us, normalize) \
750 new_delta_ex(d, s, us, normalize, &PyDateTime_DeltaType)
751
752/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +0000753 * tzinfo helpers.
754 */
755
Tim Peters855fe882002-12-22 03:43:39 +0000756/* Ensure that p is None or of a tzinfo subclass. Return 0 if OK; if not
757 * raise TypeError and return -1.
758 */
759static int
760check_tzinfo_subclass(PyObject *p)
761{
762 if (p == Py_None || PyTZInfo_Check(p))
763 return 0;
764 PyErr_Format(PyExc_TypeError,
765 "tzinfo argument must be None or of a tzinfo subclass, "
766 "not type '%s'",
Christian Heimes90aa7642007-12-19 02:45:37 +0000767 Py_TYPE(p)->tp_name);
Tim Peters855fe882002-12-22 03:43:39 +0000768 return -1;
769}
770
Tim Petersbad8ff02002-12-30 20:52:32 +0000771/* Return tzinfo.methname(tzinfoarg), without any checking of results.
Tim Peters855fe882002-12-22 03:43:39 +0000772 * If tzinfo is None, returns None.
773 */
774static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000775call_tzinfo_method(PyObject *tzinfo, char *methname, PyObject *tzinfoarg)
Tim Peters855fe882002-12-22 03:43:39 +0000776{
777 PyObject *result;
778
Tim Petersbad8ff02002-12-30 20:52:32 +0000779 assert(tzinfo && methname && tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000780 assert(check_tzinfo_subclass(tzinfo) >= 0);
781 if (tzinfo == Py_None) {
782 result = Py_None;
783 Py_INCREF(result);
784 }
785 else
Tim Petersbad8ff02002-12-30 20:52:32 +0000786 result = PyObject_CallMethod(tzinfo, methname, "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000787 return result;
788}
789
Tim Peters2a799bf2002-12-16 20:18:38 +0000790/* If self has a tzinfo member, return a BORROWED reference to it. Else
791 * return NULL, which is NOT AN ERROR. There are no error returns here,
792 * and the caller must not decref the result.
793 */
794static PyObject *
795get_tzinfo_member(PyObject *self)
796{
797 PyObject *tzinfo = NULL;
798
Tim Petersa9bc1682003-01-11 03:39:11 +0000799 if (PyDateTime_Check(self) && HASTZINFO(self))
800 tzinfo = ((PyDateTime_DateTime *)self)->tzinfo;
Tim Petersa032d2e2003-01-11 00:15:54 +0000801 else if (PyTime_Check(self) && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +0000802 tzinfo = ((PyDateTime_Time *)self)->tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000803
804 return tzinfo;
805}
806
Tim Petersbad8ff02002-12-30 20:52:32 +0000807/* Call getattr(tzinfo, name)(tzinfoarg), and extract an int from the
Tim Peters2a799bf2002-12-16 20:18:38 +0000808 * result. tzinfo must be an instance of the tzinfo class. If the method
809 * returns None, this returns 0 and sets *none to 1. If the method doesn't
Tim Peters397301e2003-01-02 21:28:08 +0000810 * return None or timedelta, TypeError is raised and this returns -1. If it
811 * returnsa timedelta and the value is out of range or isn't a whole number
812 * of minutes, ValueError is raised and this returns -1.
Tim Peters2a799bf2002-12-16 20:18:38 +0000813 * Else *none is set to 0 and the integer method result is returned.
814 */
815static int
816call_utc_tzinfo_method(PyObject *tzinfo, char *name, PyObject *tzinfoarg,
817 int *none)
818{
819 PyObject *u;
Tim Peters397301e2003-01-02 21:28:08 +0000820 int result = -1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000821
822 assert(tzinfo != NULL);
823 assert(PyTZInfo_Check(tzinfo));
824 assert(tzinfoarg != NULL);
825
826 *none = 0;
Tim Petersbad8ff02002-12-30 20:52:32 +0000827 u = call_tzinfo_method(tzinfo, name, tzinfoarg);
Tim Peters2a799bf2002-12-16 20:18:38 +0000828 if (u == NULL)
829 return -1;
830
Tim Peters27362852002-12-23 16:17:39 +0000831 else if (u == Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +0000832 result = 0;
833 *none = 1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000834 }
Tim Peters855fe882002-12-22 03:43:39 +0000835 else if (PyDelta_Check(u)) {
836 const int days = GET_TD_DAYS(u);
837 if (days < -1 || days > 0)
838 result = 24*60; /* trigger ValueError below */
839 else {
840 /* next line can't overflow because we know days
841 * is -1 or 0 now
842 */
843 int ss = days * 24 * 3600 + GET_TD_SECONDS(u);
844 result = divmod(ss, 60, &ss);
845 if (ss || GET_TD_MICROSECONDS(u)) {
846 PyErr_Format(PyExc_ValueError,
847 "tzinfo.%s() must return a "
848 "whole number of minutes",
849 name);
850 result = -1;
Tim Peters855fe882002-12-22 03:43:39 +0000851 }
852 }
853 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000854 else {
855 PyErr_Format(PyExc_TypeError,
Tim Peters397301e2003-01-02 21:28:08 +0000856 "tzinfo.%s() must return None or "
Tim Peters855fe882002-12-22 03:43:39 +0000857 "timedelta, not '%s'",
Christian Heimes90aa7642007-12-19 02:45:37 +0000858 name, Py_TYPE(u)->tp_name);
Tim Peters2a799bf2002-12-16 20:18:38 +0000859 }
860
Tim Peters2a799bf2002-12-16 20:18:38 +0000861 Py_DECREF(u);
862 if (result < -1439 || result > 1439) {
863 PyErr_Format(PyExc_ValueError,
Neal Norwitz506a2242003-01-04 01:02:25 +0000864 "tzinfo.%s() returned %d; must be in "
Tim Peters2a799bf2002-12-16 20:18:38 +0000865 "-1439 .. 1439",
866 name, result);
867 result = -1;
868 }
Tim Peters397301e2003-01-02 21:28:08 +0000869 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +0000870}
871
872/* Call tzinfo.utcoffset(tzinfoarg), and extract an integer from the
873 * result. tzinfo must be an instance of the tzinfo class. If utcoffset()
874 * returns None, call_utcoffset returns 0 and sets *none to 1. If uctoffset()
Tim Peters397301e2003-01-02 21:28:08 +0000875 * doesn't return None or timedelta, TypeError is raised and this returns -1.
876 * If utcoffset() returns an invalid timedelta (out of range, or not a whole
877 * # of minutes), ValueError is raised and this returns -1. Else *none is
878 * set to 0 and the offset is returned (as int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000879 */
880static int
881call_utcoffset(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
882{
883 return call_utc_tzinfo_method(tzinfo, "utcoffset", tzinfoarg, none);
884}
885
Tim Petersbad8ff02002-12-30 20:52:32 +0000886/* Call tzinfo.name(tzinfoarg), and return the offset as a timedelta or None.
887 */
Tim Peters855fe882002-12-22 03:43:39 +0000888static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000889offset_as_timedelta(PyObject *tzinfo, char *name, PyObject *tzinfoarg) {
Tim Peters855fe882002-12-22 03:43:39 +0000890 PyObject *result;
891
Tim Petersbad8ff02002-12-30 20:52:32 +0000892 assert(tzinfo && name && tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000893 if (tzinfo == Py_None) {
894 result = Py_None;
895 Py_INCREF(result);
896 }
897 else {
898 int none;
Tim Petersbad8ff02002-12-30 20:52:32 +0000899 int offset = call_utc_tzinfo_method(tzinfo, name, tzinfoarg,
900 &none);
Tim Peters855fe882002-12-22 03:43:39 +0000901 if (offset < 0 && PyErr_Occurred())
902 return NULL;
903 if (none) {
904 result = Py_None;
905 Py_INCREF(result);
906 }
907 else
908 result = new_delta(0, offset * 60, 0, 1);
909 }
910 return result;
911}
912
Tim Peters2a799bf2002-12-16 20:18:38 +0000913/* Call tzinfo.dst(tzinfoarg), and extract an integer from the
914 * result. tzinfo must be an instance of the tzinfo class. If dst()
915 * returns None, call_dst returns 0 and sets *none to 1. If dst()
Tim Peters397301e2003-01-02 21:28:08 +0000916 & doesn't return None or timedelta, TypeError is raised and this
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000917 * returns -1. If dst() returns an invalid timedelta for a UTC offset,
Tim Peters397301e2003-01-02 21:28:08 +0000918 * ValueError is raised and this returns -1. Else *none is set to 0 and
919 * the offset is returned (as an int # of minutes east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +0000920 */
921static int
922call_dst(PyObject *tzinfo, PyObject *tzinfoarg, int *none)
923{
924 return call_utc_tzinfo_method(tzinfo, "dst", tzinfoarg, none);
925}
926
Tim Petersbad8ff02002-12-30 20:52:32 +0000927/* Call tzinfo.tzname(tzinfoarg), and return the result. tzinfo must be
Tim Peters855fe882002-12-22 03:43:39 +0000928 * an instance of the tzinfo class or None. If tzinfo isn't None, and
Tim Petersbad8ff02002-12-30 20:52:32 +0000929 * tzname() doesn't return None or a string, TypeError is raised and this
Guido van Rossume3d1d412007-05-23 21:24:35 +0000930 * returns NULL. If the result is a string, we ensure it is a Unicode
931 * string.
Tim Peters2a799bf2002-12-16 20:18:38 +0000932 */
933static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +0000934call_tzname(PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +0000935{
936 PyObject *result;
937
938 assert(tzinfo != NULL);
Tim Peters855fe882002-12-22 03:43:39 +0000939 assert(check_tzinfo_subclass(tzinfo) >= 0);
Tim Petersbad8ff02002-12-30 20:52:32 +0000940 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +0000941
Tim Peters855fe882002-12-22 03:43:39 +0000942 if (tzinfo == Py_None) {
943 result = Py_None;
944 Py_INCREF(result);
945 }
946 else
Tim Petersbad8ff02002-12-30 20:52:32 +0000947 result = PyObject_CallMethod(tzinfo, "tzname", "O", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +0000948
Guido van Rossume3d1d412007-05-23 21:24:35 +0000949 if (result != NULL && result != Py_None) {
Guido van Rossumfd53fd62007-08-24 04:05:13 +0000950 if (!PyUnicode_Check(result)) {
Guido van Rossume3d1d412007-05-23 21:24:35 +0000951 PyErr_Format(PyExc_TypeError, "tzinfo.tzname() must "
952 "return None or a string, not '%s'",
Christian Heimes90aa7642007-12-19 02:45:37 +0000953 Py_TYPE(result)->tp_name);
Guido van Rossume3d1d412007-05-23 21:24:35 +0000954 Py_DECREF(result);
955 result = NULL;
956 }
957 else if (!PyUnicode_Check(result)) {
958 PyObject *temp = PyUnicode_FromObject(result);
959 Py_DECREF(result);
960 result = temp;
961 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000962 }
963 return result;
964}
965
966typedef enum {
967 /* an exception has been set; the caller should pass it on */
968 OFFSET_ERROR,
969
Tim Petersa9bc1682003-01-11 03:39:11 +0000970 /* type isn't date, datetime, or time subclass */
Tim Peters2a799bf2002-12-16 20:18:38 +0000971 OFFSET_UNKNOWN,
972
973 /* date,
Tim Petersa9bc1682003-01-11 03:39:11 +0000974 * datetime with !hastzinfo
975 * datetime with None tzinfo,
976 * datetime where utcoffset() returns None
Tim Peters37f39822003-01-10 03:49:02 +0000977 * time with !hastzinfo
978 * time with None tzinfo,
979 * time where utcoffset() returns None
Tim Peters2a799bf2002-12-16 20:18:38 +0000980 */
981 OFFSET_NAIVE,
982
Tim Petersa9bc1682003-01-11 03:39:11 +0000983 /* time or datetime where utcoffset() doesn't return None */
Georg Brandle810fe22006-02-19 15:28:47 +0000984 OFFSET_AWARE
Tim Peters2a799bf2002-12-16 20:18:38 +0000985} naivety;
986
Tim Peters14b69412002-12-22 18:10:22 +0000987/* Classify an object as to whether it's naive or offset-aware. See
Tim Peters2a799bf2002-12-16 20:18:38 +0000988 * the "naivety" typedef for details. If the type is aware, *offset is set
989 * to minutes east of UTC (as returned by the tzinfo.utcoffset() method).
Tim Peters14b69412002-12-22 18:10:22 +0000990 * If the type is offset-naive (or unknown, or error), *offset is set to 0.
Tim Peterse39a80c2002-12-30 21:28:52 +0000991 * tzinfoarg is the argument to pass to the tzinfo.utcoffset() method.
Tim Peters2a799bf2002-12-16 20:18:38 +0000992 */
993static naivety
Tim Peterse39a80c2002-12-30 21:28:52 +0000994classify_utcoffset(PyObject *op, PyObject *tzinfoarg, int *offset)
Tim Peters2a799bf2002-12-16 20:18:38 +0000995{
996 int none;
997 PyObject *tzinfo;
998
Tim Peterse39a80c2002-12-30 21:28:52 +0000999 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001000 *offset = 0;
Tim Peters14b69412002-12-22 18:10:22 +00001001 tzinfo = get_tzinfo_member(op); /* NULL means no tzinfo, not error */
Tim Peters2a799bf2002-12-16 20:18:38 +00001002 if (tzinfo == Py_None)
1003 return OFFSET_NAIVE;
Tim Peters14b69412002-12-22 18:10:22 +00001004 if (tzinfo == NULL) {
1005 /* note that a datetime passes the PyDate_Check test */
1006 return (PyTime_Check(op) || PyDate_Check(op)) ?
1007 OFFSET_NAIVE : OFFSET_UNKNOWN;
1008 }
Tim Peterse39a80c2002-12-30 21:28:52 +00001009 *offset = call_utcoffset(tzinfo, tzinfoarg, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00001010 if (*offset == -1 && PyErr_Occurred())
1011 return OFFSET_ERROR;
1012 return none ? OFFSET_NAIVE : OFFSET_AWARE;
1013}
1014
Tim Peters00237032002-12-27 02:21:51 +00001015/* Classify two objects as to whether they're naive or offset-aware.
1016 * This isn't quite the same as calling classify_utcoffset() twice: for
1017 * binary operations (comparison and subtraction), we generally want to
1018 * ignore the tzinfo members if they're identical. This is by design,
1019 * so that results match "naive" expectations when mixing objects from a
1020 * single timezone. So in that case, this sets both offsets to 0 and
1021 * both naiveties to OFFSET_NAIVE.
1022 * The function returns 0 if everything's OK, and -1 on error.
1023 */
1024static int
1025classify_two_utcoffsets(PyObject *o1, int *offset1, naivety *n1,
Tim Peterse39a80c2002-12-30 21:28:52 +00001026 PyObject *tzinfoarg1,
1027 PyObject *o2, int *offset2, naivety *n2,
1028 PyObject *tzinfoarg2)
Tim Peters00237032002-12-27 02:21:51 +00001029{
1030 if (get_tzinfo_member(o1) == get_tzinfo_member(o2)) {
1031 *offset1 = *offset2 = 0;
1032 *n1 = *n2 = OFFSET_NAIVE;
1033 }
1034 else {
Tim Peterse39a80c2002-12-30 21:28:52 +00001035 *n1 = classify_utcoffset(o1, tzinfoarg1, offset1);
Tim Peters00237032002-12-27 02:21:51 +00001036 if (*n1 == OFFSET_ERROR)
1037 return -1;
Tim Peterse39a80c2002-12-30 21:28:52 +00001038 *n2 = classify_utcoffset(o2, tzinfoarg2, offset2);
Tim Peters00237032002-12-27 02:21:51 +00001039 if (*n2 == OFFSET_ERROR)
1040 return -1;
1041 }
1042 return 0;
1043}
1044
Tim Peters2a799bf2002-12-16 20:18:38 +00001045/* repr is like "someclass(arg1, arg2)". If tzinfo isn't None,
1046 * stuff
1047 * ", tzinfo=" + repr(tzinfo)
1048 * before the closing ")".
1049 */
1050static PyObject *
1051append_keyword_tzinfo(PyObject *repr, PyObject *tzinfo)
1052{
1053 PyObject *temp;
1054
Walter Dörwald1ab83302007-05-18 17:15:44 +00001055 assert(PyUnicode_Check(repr));
Tim Peters2a799bf2002-12-16 20:18:38 +00001056 assert(tzinfo);
1057 if (tzinfo == Py_None)
1058 return repr;
1059 /* Get rid of the trailing ')'. */
Walter Dörwald1ab83302007-05-18 17:15:44 +00001060 assert(PyUnicode_AS_UNICODE(repr)[PyUnicode_GET_SIZE(repr)-1] == ')');
1061 temp = PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(repr),
1062 PyUnicode_GET_SIZE(repr) - 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00001063 Py_DECREF(repr);
1064 if (temp == NULL)
1065 return NULL;
Walter Dörwald517bcfe2007-05-23 20:45:05 +00001066 repr = PyUnicode_FromFormat("%U, tzinfo=%R)", temp, tzinfo);
1067 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00001068 return repr;
1069}
1070
1071/* ---------------------------------------------------------------------------
1072 * String format helpers.
1073 */
1074
1075static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00001076format_ctime(PyDateTime_Date *date, int hours, int minutes, int seconds)
Tim Peters2a799bf2002-12-16 20:18:38 +00001077{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001078 static const char *DayNames[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001079 "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"
1080 };
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001081 static const char *MonthNames[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00001082 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1083 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
1084 };
1085
Tim Peters2a799bf2002-12-16 20:18:38 +00001086 int wday = weekday(GET_YEAR(date), GET_MONTH(date), GET_DAY(date));
1087
Walter Dörwald4af32b32007-05-31 16:19:50 +00001088 return PyUnicode_FromFormat("%s %s %2d %02d:%02d:%02d %04d",
1089 DayNames[wday], MonthNames[GET_MONTH(date)-1],
1090 GET_DAY(date), hours, minutes, seconds,
1091 GET_YEAR(date));
Tim Peters2a799bf2002-12-16 20:18:38 +00001092}
1093
1094/* Add an hours & minutes UTC offset string to buf. buf has no more than
1095 * buflen bytes remaining. The UTC offset is gotten by calling
1096 * tzinfo.uctoffset(tzinfoarg). If that returns None, \0 is stored into
1097 * *buf, and that's all. Else the returned value is checked for sanity (an
1098 * integer in range), and if that's OK it's converted to an hours & minutes
1099 * string of the form
1100 * sign HH sep MM
1101 * Returns 0 if everything is OK. If the return value from utcoffset() is
1102 * bogus, an appropriate exception is set and -1 is returned.
1103 */
1104static int
Tim Peters328fff72002-12-20 01:31:27 +00001105format_utcoffset(char *buf, size_t buflen, const char *sep,
Tim Peters2a799bf2002-12-16 20:18:38 +00001106 PyObject *tzinfo, PyObject *tzinfoarg)
1107{
1108 int offset;
1109 int hours;
1110 int minutes;
1111 char sign;
1112 int none;
1113
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +00001114 assert(buflen >= 1);
1115
Tim Peters2a799bf2002-12-16 20:18:38 +00001116 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
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001133static PyObject *
1134make_Zreplacement(PyObject *object, PyObject *tzinfoarg)
1135{
Neal Norwitzaea70e02007-08-12 04:32:26 +00001136 PyObject *temp;
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001137 PyObject *tzinfo = get_tzinfo_member(object);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001138 PyObject *Zreplacement = PyUnicode_FromStringAndSize(NULL, 0);
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001139 if (Zreplacement == NULL)
1140 return NULL;
Neal Norwitzaea70e02007-08-12 04:32:26 +00001141 if (tzinfo == Py_None || tzinfo == NULL)
1142 return Zreplacement;
1143
1144 assert(tzinfoarg != NULL);
1145 temp = call_tzname(tzinfo, tzinfoarg);
1146 if (temp == NULL)
1147 goto Error;
1148 if (temp == Py_None) {
1149 Py_DECREF(temp);
1150 return Zreplacement;
1151 }
1152
1153 assert(PyUnicode_Check(temp));
1154 /* Since the tzname is getting stuffed into the
1155 * format, we have to double any % signs so that
1156 * strftime doesn't treat them as format codes.
1157 */
1158 Py_DECREF(Zreplacement);
1159 Zreplacement = PyObject_CallMethod(temp, "replace", "ss", "%", "%%");
1160 Py_DECREF(temp);
1161 if (Zreplacement == NULL)
1162 return NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001163 if (!PyUnicode_Check(Zreplacement)) {
Neal Norwitzaea70e02007-08-12 04:32:26 +00001164 PyErr_SetString(PyExc_TypeError,
1165 "tzname.replace() did not return a string");
1166 goto Error;
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001167 }
1168 return Zreplacement;
1169
1170 Error:
1171 Py_DECREF(Zreplacement);
1172 return NULL;
1173}
1174
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001175static PyObject *
1176make_freplacement(PyObject *object)
1177{
Christian Heimesb186d002008-03-18 15:15:01 +00001178 char freplacement[64];
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001179 if (PyTime_Check(object))
1180 sprintf(freplacement, "%06d", TIME_GET_MICROSECOND(object));
1181 else if (PyDateTime_Check(object))
1182 sprintf(freplacement, "%06d", DATE_GET_MICROSECOND(object));
1183 else
1184 sprintf(freplacement, "%06d", 0);
1185
Christian Heimes72b710a2008-05-26 13:28:38 +00001186 return PyBytes_FromStringAndSize(freplacement, strlen(freplacement));
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001187}
1188
Tim Peters2a799bf2002-12-16 20:18:38 +00001189/* I sure don't want to reproduce the strftime code from the time module,
1190 * so this imports the module and calls it. All the hair is due to
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001191 * giving special meanings to the %z, %Z and %f format codes via a
1192 * preprocessing step on the format string.
Tim Petersbad8ff02002-12-30 20:52:32 +00001193 * tzinfoarg is the argument to pass to the object's tzinfo method, if
1194 * needed.
Tim Peters2a799bf2002-12-16 20:18:38 +00001195 */
1196static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +00001197wrap_strftime(PyObject *object, PyObject *format, PyObject *timetuple,
1198 PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001199{
1200 PyObject *result = NULL; /* guilty until proved innocent */
1201
1202 PyObject *zreplacement = NULL; /* py string, replacement for %z */
1203 PyObject *Zreplacement = NULL; /* py string, replacement for %Z */
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001204 PyObject *freplacement = NULL; /* py string, replacement for %f */
Tim Peters2a799bf2002-12-16 20:18:38 +00001205
Georg Brandlf78e02b2008-06-10 17:40:04 +00001206 const char *pin; /* pointer to next char in input format */
1207 Py_ssize_t flen; /* length of input format */
1208 char ch; /* next char in input format */
Tim Peters2a799bf2002-12-16 20:18:38 +00001209
1210 PyObject *newfmt = NULL; /* py string, the output format */
1211 char *pnew; /* pointer to available byte in output format */
Georg Brandlf78e02b2008-06-10 17:40:04 +00001212 size_t totalnew; /* number bytes total in output format buffer,
1213 exclusive of trailing \0 */
1214 size_t usednew; /* number bytes used so far in output format buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001215
Georg Brandlf78e02b2008-06-10 17:40:04 +00001216 const char *ptoappend; /* ptr to string to append to output buffer */
Brett Cannon27da8122007-11-06 23:15:11 +00001217 Py_ssize_t ntoappend; /* # of bytes to append to output buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001218
Tim Peters2a799bf2002-12-16 20:18:38 +00001219 assert(object && format && timetuple);
Guido van Rossumfd53fd62007-08-24 04:05:13 +00001220 assert(PyUnicode_Check(format));
Neal Norwitz908c8712007-08-27 04:58:38 +00001221 /* Convert the input format to a C string and size */
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001222 pin = _PyUnicode_AsStringAndSize(format, &flen);
Neal Norwitz908c8712007-08-27 04:58:38 +00001223 if (!pin)
1224 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001225
Tim Petersd6844152002-12-22 20:58:42 +00001226 /* Give up if the year is before 1900.
1227 * Python strftime() plays games with the year, and different
1228 * games depending on whether envar PYTHON2K is set. This makes
1229 * years before 1900 a nightmare, even if the platform strftime
1230 * supports them (and not all do).
1231 * We could get a lot farther here by avoiding Python's strftime
1232 * wrapper and calling the C strftime() directly, but that isn't
1233 * an option in the Python implementation of this module.
1234 */
1235 {
1236 long year;
1237 PyObject *pyyear = PySequence_GetItem(timetuple, 0);
1238 if (pyyear == NULL) return NULL;
Christian Heimes217cfd12007-12-02 14:31:20 +00001239 assert(PyLong_Check(pyyear));
1240 year = PyLong_AsLong(pyyear);
Tim Petersd6844152002-12-22 20:58:42 +00001241 Py_DECREF(pyyear);
1242 if (year < 1900) {
1243 PyErr_Format(PyExc_ValueError, "year=%ld is before "
1244 "1900; the datetime strftime() "
1245 "methods require year >= 1900",
1246 year);
1247 return NULL;
1248 }
1249 }
1250
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001251 /* Scan the input format, looking for %z/%Z/%f escapes, building
Tim Peters328fff72002-12-20 01:31:27 +00001252 * a new format. Since computing the replacements for those codes
1253 * is expensive, don't unless they're actually used.
Tim Peters2a799bf2002-12-16 20:18:38 +00001254 */
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +00001255 if (flen > INT_MAX - 1) {
1256 PyErr_NoMemory();
1257 goto Done;
1258 }
1259
Guido van Rossumbce56a62007-05-10 18:04:33 +00001260 totalnew = flen + 1; /* realistic if no %z/%Z */
Christian Heimes72b710a2008-05-26 13:28:38 +00001261 newfmt = PyBytes_FromStringAndSize(NULL, totalnew);
Tim Peters2a799bf2002-12-16 20:18:38 +00001262 if (newfmt == NULL) goto Done;
Christian Heimes72b710a2008-05-26 13:28:38 +00001263 pnew = PyBytes_AsString(newfmt);
Tim Peters2a799bf2002-12-16 20:18:38 +00001264 usednew = 0;
1265
Tim Peters2a799bf2002-12-16 20:18:38 +00001266 while ((ch = *pin++) != '\0') {
1267 if (ch != '%') {
Tim Peters328fff72002-12-20 01:31:27 +00001268 ptoappend = pin - 1;
Tim Peters2a799bf2002-12-16 20:18:38 +00001269 ntoappend = 1;
1270 }
1271 else if ((ch = *pin++) == '\0') {
1272 /* There's a lone trailing %; doesn't make sense. */
1273 PyErr_SetString(PyExc_ValueError, "strftime format "
1274 "ends with raw %");
1275 goto Done;
1276 }
1277 /* A % has been seen and ch is the character after it. */
1278 else if (ch == 'z') {
1279 if (zreplacement == NULL) {
1280 /* format utcoffset */
Tim Peters328fff72002-12-20 01:31:27 +00001281 char buf[100];
Tim Peters2a799bf2002-12-16 20:18:38 +00001282 PyObject *tzinfo = get_tzinfo_member(object);
Christian Heimes72b710a2008-05-26 13:28:38 +00001283 zreplacement = PyBytes_FromStringAndSize("", 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00001284 if (zreplacement == NULL) goto Done;
1285 if (tzinfo != Py_None && tzinfo != NULL) {
Tim Petersbad8ff02002-12-30 20:52:32 +00001286 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001287 if (format_utcoffset(buf,
Tim Peters328fff72002-12-20 01:31:27 +00001288 sizeof(buf),
Tim Peters2a799bf2002-12-16 20:18:38 +00001289 "",
1290 tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00001291 tzinfoarg) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00001292 goto Done;
1293 Py_DECREF(zreplacement);
Guido van Rossumfd53fd62007-08-24 04:05:13 +00001294 zreplacement =
Christian Heimes72b710a2008-05-26 13:28:38 +00001295 PyBytes_FromStringAndSize(buf,
Guido van Rossumfd53fd62007-08-24 04:05:13 +00001296 strlen(buf));
1297 if (zreplacement == NULL)
1298 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00001299 }
1300 }
1301 assert(zreplacement != NULL);
Christian Heimes72b710a2008-05-26 13:28:38 +00001302 ptoappend = PyBytes_AS_STRING(zreplacement);
1303 ntoappend = PyBytes_GET_SIZE(zreplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001304 }
1305 else if (ch == 'Z') {
1306 /* format tzname */
1307 if (Zreplacement == NULL) {
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001308 Zreplacement = make_Zreplacement(object,
1309 tzinfoarg);
1310 if (Zreplacement == NULL)
1311 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00001312 }
1313 assert(Zreplacement != NULL);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001314 assert(PyUnicode_Check(Zreplacement));
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00001315 ptoappend = _PyUnicode_AsStringAndSize(Zreplacement,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001316 &ntoappend);
Christian Heimes90aa7642007-12-19 02:45:37 +00001317 ntoappend = Py_SIZE(Zreplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001318 }
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001319 else if (ch == 'f') {
1320 /* format microseconds */
1321 if (freplacement == NULL) {
1322 freplacement = make_freplacement(object);
1323 if (freplacement == NULL)
1324 goto Done;
1325 }
1326 assert(freplacement != NULL);
Christian Heimes72b710a2008-05-26 13:28:38 +00001327 assert(PyBytes_Check(freplacement));
1328 ptoappend = PyBytes_AS_STRING(freplacement);
1329 ntoappend = PyBytes_GET_SIZE(freplacement);
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001330 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001331 else {
Tim Peters328fff72002-12-20 01:31:27 +00001332 /* percent followed by neither z nor Z */
1333 ptoappend = pin - 2;
Tim Peters2a799bf2002-12-16 20:18:38 +00001334 ntoappend = 2;
1335 }
1336
1337 /* Append the ntoappend chars starting at ptoappend to
1338 * the new format.
1339 */
Tim Peters2a799bf2002-12-16 20:18:38 +00001340 if (ntoappend == 0)
1341 continue;
Guido van Rossumfd53fd62007-08-24 04:05:13 +00001342 assert(ptoappend != NULL);
1343 assert(ntoappend > 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00001344 while (usednew + ntoappend > totalnew) {
Georg Brandlf78e02b2008-06-10 17:40:04 +00001345 size_t bigger = totalnew << 1;
Tim Peters2a799bf2002-12-16 20:18:38 +00001346 if ((bigger >> 1) != totalnew) { /* overflow */
1347 PyErr_NoMemory();
1348 goto Done;
1349 }
Christian Heimes72b710a2008-05-26 13:28:38 +00001350 if (_PyBytes_Resize(&newfmt, bigger) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00001351 goto Done;
1352 totalnew = bigger;
Christian Heimes72b710a2008-05-26 13:28:38 +00001353 pnew = PyBytes_AsString(newfmt) + usednew;
Tim Peters2a799bf2002-12-16 20:18:38 +00001354 }
1355 memcpy(pnew, ptoappend, ntoappend);
1356 pnew += ntoappend;
1357 usednew += ntoappend;
1358 assert(usednew <= totalnew);
1359 } /* end while() */
1360
Christian Heimes72b710a2008-05-26 13:28:38 +00001361 if (_PyBytes_Resize(&newfmt, usednew) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00001362 goto Done;
1363 {
Neal Norwitz908c8712007-08-27 04:58:38 +00001364 PyObject *format;
Christian Heimes072c0f12008-01-03 23:01:04 +00001365 PyObject *time = PyImport_ImportModuleNoBlock("time");
Tim Peters2a799bf2002-12-16 20:18:38 +00001366 if (time == NULL)
1367 goto Done;
Christian Heimes72b710a2008-05-26 13:28:38 +00001368 format = PyUnicode_FromString(PyBytes_AS_STRING(newfmt));
Neal Norwitz908c8712007-08-27 04:58:38 +00001369 if (format != NULL) {
1370 result = PyObject_CallMethod(time, "strftime", "OO",
1371 format, timetuple);
1372 Py_DECREF(format);
1373 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001374 Py_DECREF(time);
1375 }
1376 Done:
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001377 Py_XDECREF(freplacement);
Tim Peters2a799bf2002-12-16 20:18:38 +00001378 Py_XDECREF(zreplacement);
1379 Py_XDECREF(Zreplacement);
1380 Py_XDECREF(newfmt);
1381 return result;
1382}
1383
Tim Peters2a799bf2002-12-16 20:18:38 +00001384/* ---------------------------------------------------------------------------
1385 * Wrap functions from the time module. These aren't directly available
1386 * from C. Perhaps they should be.
1387 */
1388
1389/* Call time.time() and return its result (a Python float). */
1390static PyObject *
Guido van Rossumbd43e912002-12-16 20:34:55 +00001391time_time(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00001392{
1393 PyObject *result = NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00001394 PyObject *time = PyImport_ImportModuleNoBlock("time");
Tim Peters2a799bf2002-12-16 20:18:38 +00001395
1396 if (time != NULL) {
1397 result = PyObject_CallMethod(time, "time", "()");
1398 Py_DECREF(time);
1399 }
1400 return result;
1401}
1402
1403/* Build a time.struct_time. The weekday and day number are automatically
1404 * computed from the y,m,d args.
1405 */
1406static PyObject *
1407build_struct_time(int y, int m, int d, int hh, int mm, int ss, int dstflag)
1408{
1409 PyObject *time;
1410 PyObject *result = NULL;
1411
Christian Heimes072c0f12008-01-03 23:01:04 +00001412 time = PyImport_ImportModuleNoBlock("time");
Tim Peters2a799bf2002-12-16 20:18:38 +00001413 if (time != NULL) {
1414 result = PyObject_CallMethod(time, "struct_time",
1415 "((iiiiiiiii))",
1416 y, m, d,
1417 hh, mm, ss,
1418 weekday(y, m, d),
1419 days_before_month(y, m) + d,
1420 dstflag);
1421 Py_DECREF(time);
1422 }
1423 return result;
1424}
1425
1426/* ---------------------------------------------------------------------------
1427 * Miscellaneous helpers.
1428 */
1429
Mark Dickinsone94c6792009-02-02 20:36:42 +00001430/* For various reasons, we need to use tp_richcompare instead of tp_reserved.
Tim Peters2a799bf2002-12-16 20:18:38 +00001431 * The comparisons here all most naturally compute a cmp()-like result.
1432 * This little helper turns that into a bool result for rich comparisons.
1433 */
1434static PyObject *
1435diff_to_bool(int diff, int op)
1436{
1437 PyObject *result;
1438 int istrue;
1439
1440 switch (op) {
1441 case Py_EQ: istrue = diff == 0; break;
1442 case Py_NE: istrue = diff != 0; break;
1443 case Py_LE: istrue = diff <= 0; break;
1444 case Py_GE: istrue = diff >= 0; break;
1445 case Py_LT: istrue = diff < 0; break;
1446 case Py_GT: istrue = diff > 0; break;
1447 default:
1448 assert(! "op unknown");
1449 istrue = 0; /* To shut up compiler */
1450 }
1451 result = istrue ? Py_True : Py_False;
1452 Py_INCREF(result);
1453 return result;
1454}
1455
Tim Peters07534a62003-02-07 22:50:28 +00001456/* Raises a "can't compare" TypeError and returns NULL. */
1457static PyObject *
1458cmperror(PyObject *a, PyObject *b)
1459{
1460 PyErr_Format(PyExc_TypeError,
1461 "can't compare %s to %s",
Christian Heimes90aa7642007-12-19 02:45:37 +00001462 Py_TYPE(a)->tp_name, Py_TYPE(b)->tp_name);
Tim Peters07534a62003-02-07 22:50:28 +00001463 return NULL;
1464}
1465
Tim Peters2a799bf2002-12-16 20:18:38 +00001466/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +00001467 * Cached Python objects; these are set by the module init function.
1468 */
1469
1470/* Conversion factors. */
1471static PyObject *us_per_us = NULL; /* 1 */
1472static PyObject *us_per_ms = NULL; /* 1000 */
1473static PyObject *us_per_second = NULL; /* 1000000 */
1474static PyObject *us_per_minute = NULL; /* 1e6 * 60 as Python int */
1475static PyObject *us_per_hour = NULL; /* 1e6 * 3600 as Python long */
1476static PyObject *us_per_day = NULL; /* 1e6 * 3600 * 24 as Python long */
1477static PyObject *us_per_week = NULL; /* 1e6*3600*24*7 as Python long */
1478static PyObject *seconds_per_day = NULL; /* 3600*24 as Python int */
1479
Tim Peters2a799bf2002-12-16 20:18:38 +00001480/* ---------------------------------------------------------------------------
1481 * Class implementations.
1482 */
1483
1484/*
1485 * PyDateTime_Delta implementation.
1486 */
1487
1488/* Convert a timedelta to a number of us,
1489 * (24*3600*self.days + self.seconds)*1000000 + self.microseconds
1490 * as a Python int or long.
1491 * Doing mixed-radix arithmetic by hand instead is excruciating in C,
1492 * due to ubiquitous overflow possibilities.
1493 */
1494static PyObject *
1495delta_to_microseconds(PyDateTime_Delta *self)
1496{
1497 PyObject *x1 = NULL;
1498 PyObject *x2 = NULL;
1499 PyObject *x3 = NULL;
1500 PyObject *result = NULL;
1501
Christian Heimes217cfd12007-12-02 14:31:20 +00001502 x1 = PyLong_FromLong(GET_TD_DAYS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00001503 if (x1 == NULL)
1504 goto Done;
1505 x2 = PyNumber_Multiply(x1, seconds_per_day); /* days in seconds */
1506 if (x2 == NULL)
1507 goto Done;
1508 Py_DECREF(x1);
1509 x1 = NULL;
1510
1511 /* x2 has days in seconds */
Christian Heimes217cfd12007-12-02 14:31:20 +00001512 x1 = PyLong_FromLong(GET_TD_SECONDS(self)); /* seconds */
Tim Peters2a799bf2002-12-16 20:18:38 +00001513 if (x1 == NULL)
1514 goto Done;
1515 x3 = PyNumber_Add(x1, x2); /* days and seconds in seconds */
1516 if (x3 == NULL)
1517 goto Done;
1518 Py_DECREF(x1);
1519 Py_DECREF(x2);
1520 x1 = x2 = NULL;
1521
1522 /* x3 has days+seconds in seconds */
1523 x1 = PyNumber_Multiply(x3, us_per_second); /* us */
1524 if (x1 == NULL)
1525 goto Done;
1526 Py_DECREF(x3);
1527 x3 = NULL;
1528
1529 /* x1 has days+seconds in us */
Christian Heimes217cfd12007-12-02 14:31:20 +00001530 x2 = PyLong_FromLong(GET_TD_MICROSECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00001531 if (x2 == NULL)
1532 goto Done;
1533 result = PyNumber_Add(x1, x2);
1534
1535Done:
1536 Py_XDECREF(x1);
1537 Py_XDECREF(x2);
1538 Py_XDECREF(x3);
1539 return result;
1540}
1541
1542/* Convert a number of us (as a Python int or long) to a timedelta.
1543 */
1544static PyObject *
Tim Petersb0c854d2003-05-17 15:57:00 +00001545microseconds_to_delta_ex(PyObject *pyus, PyTypeObject *type)
Tim Peters2a799bf2002-12-16 20:18:38 +00001546{
1547 int us;
1548 int s;
1549 int d;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001550 long temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001551
1552 PyObject *tuple = NULL;
1553 PyObject *num = NULL;
1554 PyObject *result = NULL;
1555
1556 tuple = PyNumber_Divmod(pyus, us_per_second);
1557 if (tuple == NULL)
1558 goto Done;
1559
1560 num = PyTuple_GetItem(tuple, 1); /* us */
1561 if (num == NULL)
1562 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001563 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001564 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001565 if (temp == -1 && PyErr_Occurred())
1566 goto Done;
1567 assert(0 <= temp && temp < 1000000);
1568 us = (int)temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001569 if (us < 0) {
1570 /* The divisor was positive, so this must be an error. */
1571 assert(PyErr_Occurred());
1572 goto Done;
1573 }
1574
1575 num = PyTuple_GetItem(tuple, 0); /* leftover seconds */
1576 if (num == NULL)
1577 goto Done;
1578 Py_INCREF(num);
1579 Py_DECREF(tuple);
1580
1581 tuple = PyNumber_Divmod(num, seconds_per_day);
1582 if (tuple == NULL)
1583 goto Done;
1584 Py_DECREF(num);
1585
1586 num = PyTuple_GetItem(tuple, 1); /* seconds */
1587 if (num == NULL)
1588 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001589 temp = PyLong_AsLong(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001590 num = NULL;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001591 if (temp == -1 && PyErr_Occurred())
1592 goto Done;
1593 assert(0 <= temp && temp < 24*3600);
1594 s = (int)temp;
1595
Tim Peters2a799bf2002-12-16 20:18:38 +00001596 if (s < 0) {
1597 /* The divisor was positive, so this must be an error. */
1598 assert(PyErr_Occurred());
1599 goto Done;
1600 }
1601
1602 num = PyTuple_GetItem(tuple, 0); /* leftover days */
1603 if (num == NULL)
1604 goto Done;
1605 Py_INCREF(num);
Tim Peters0b0f41c2002-12-19 01:44:38 +00001606 temp = PyLong_AsLong(num);
1607 if (temp == -1 && PyErr_Occurred())
Tim Peters2a799bf2002-12-16 20:18:38 +00001608 goto Done;
Tim Peters0b0f41c2002-12-19 01:44:38 +00001609 d = (int)temp;
1610 if ((long)d != temp) {
1611 PyErr_SetString(PyExc_OverflowError, "normalized days too "
1612 "large to fit in a C int");
1613 goto Done;
1614 }
Tim Petersb0c854d2003-05-17 15:57:00 +00001615 result = new_delta_ex(d, s, us, 0, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001616
1617Done:
1618 Py_XDECREF(tuple);
1619 Py_XDECREF(num);
1620 return result;
1621}
1622
Tim Petersb0c854d2003-05-17 15:57:00 +00001623#define microseconds_to_delta(pymicros) \
1624 microseconds_to_delta_ex(pymicros, &PyDateTime_DeltaType)
1625
Tim Peters2a799bf2002-12-16 20:18:38 +00001626static PyObject *
1627multiply_int_timedelta(PyObject *intobj, PyDateTime_Delta *delta)
1628{
1629 PyObject *pyus_in;
1630 PyObject *pyus_out;
1631 PyObject *result;
1632
1633 pyus_in = delta_to_microseconds(delta);
1634 if (pyus_in == NULL)
1635 return NULL;
1636
1637 pyus_out = PyNumber_Multiply(pyus_in, intobj);
1638 Py_DECREF(pyus_in);
1639 if (pyus_out == NULL)
1640 return NULL;
1641
1642 result = microseconds_to_delta(pyus_out);
1643 Py_DECREF(pyus_out);
1644 return result;
1645}
1646
1647static PyObject *
1648divide_timedelta_int(PyDateTime_Delta *delta, PyObject *intobj)
1649{
1650 PyObject *pyus_in;
1651 PyObject *pyus_out;
1652 PyObject *result;
1653
1654 pyus_in = delta_to_microseconds(delta);
1655 if (pyus_in == NULL)
1656 return NULL;
1657
1658 pyus_out = PyNumber_FloorDivide(pyus_in, intobj);
1659 Py_DECREF(pyus_in);
1660 if (pyus_out == NULL)
1661 return NULL;
1662
1663 result = microseconds_to_delta(pyus_out);
1664 Py_DECREF(pyus_out);
1665 return result;
1666}
1667
1668static PyObject *
Mark Dickinson7c186e22010-04-20 22:32:49 +00001669divide_timedelta_timedelta(PyDateTime_Delta *left, PyDateTime_Delta *right)
1670{
1671 PyObject *pyus_left;
1672 PyObject *pyus_right;
1673 PyObject *result;
1674
1675 pyus_left = delta_to_microseconds(left);
1676 if (pyus_left == NULL)
1677 return NULL;
1678
1679 pyus_right = delta_to_microseconds(right);
1680 if (pyus_right == NULL) {
1681 Py_DECREF(pyus_left);
1682 return NULL;
1683 }
1684
1685 result = PyNumber_FloorDivide(pyus_left, pyus_right);
1686 Py_DECREF(pyus_left);
1687 Py_DECREF(pyus_right);
1688 return result;
1689}
1690
1691static PyObject *
1692truedivide_timedelta_timedelta(PyDateTime_Delta *left, PyDateTime_Delta *right)
1693{
1694 PyObject *pyus_left;
1695 PyObject *pyus_right;
1696 PyObject *result;
1697
1698 pyus_left = delta_to_microseconds(left);
1699 if (pyus_left == NULL)
1700 return NULL;
1701
1702 pyus_right = delta_to_microseconds(right);
1703 if (pyus_right == NULL) {
1704 Py_DECREF(pyus_left);
1705 return NULL;
1706 }
1707
1708 result = PyNumber_TrueDivide(pyus_left, pyus_right);
1709 Py_DECREF(pyus_left);
1710 Py_DECREF(pyus_right);
1711 return result;
1712}
1713
1714static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00001715delta_add(PyObject *left, PyObject *right)
1716{
1717 PyObject *result = Py_NotImplemented;
1718
1719 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1720 /* delta + delta */
1721 /* The C-level additions can't overflow because of the
1722 * invariant bounds.
1723 */
1724 int days = GET_TD_DAYS(left) + GET_TD_DAYS(right);
1725 int seconds = GET_TD_SECONDS(left) + GET_TD_SECONDS(right);
1726 int microseconds = GET_TD_MICROSECONDS(left) +
1727 GET_TD_MICROSECONDS(right);
1728 result = new_delta(days, seconds, microseconds, 1);
1729 }
1730
1731 if (result == Py_NotImplemented)
1732 Py_INCREF(result);
1733 return result;
1734}
1735
1736static PyObject *
1737delta_negative(PyDateTime_Delta *self)
1738{
1739 return new_delta(-GET_TD_DAYS(self),
1740 -GET_TD_SECONDS(self),
1741 -GET_TD_MICROSECONDS(self),
1742 1);
1743}
1744
1745static PyObject *
1746delta_positive(PyDateTime_Delta *self)
1747{
1748 /* Could optimize this (by returning self) if this isn't a
1749 * subclass -- but who uses unary + ? Approximately nobody.
1750 */
1751 return new_delta(GET_TD_DAYS(self),
1752 GET_TD_SECONDS(self),
1753 GET_TD_MICROSECONDS(self),
1754 0);
1755}
1756
1757static PyObject *
1758delta_abs(PyDateTime_Delta *self)
1759{
1760 PyObject *result;
1761
1762 assert(GET_TD_MICROSECONDS(self) >= 0);
1763 assert(GET_TD_SECONDS(self) >= 0);
1764
1765 if (GET_TD_DAYS(self) < 0)
1766 result = delta_negative(self);
1767 else
1768 result = delta_positive(self);
1769
1770 return result;
1771}
1772
1773static PyObject *
1774delta_subtract(PyObject *left, PyObject *right)
1775{
1776 PyObject *result = Py_NotImplemented;
1777
1778 if (PyDelta_Check(left) && PyDelta_Check(right)) {
1779 /* delta - delta */
1780 PyObject *minus_right = PyNumber_Negative(right);
1781 if (minus_right) {
1782 result = delta_add(left, minus_right);
1783 Py_DECREF(minus_right);
1784 }
1785 else
1786 result = NULL;
1787 }
1788
1789 if (result == Py_NotImplemented)
1790 Py_INCREF(result);
1791 return result;
1792}
1793
Tim Peters2a799bf2002-12-16 20:18:38 +00001794static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00001795delta_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters2a799bf2002-12-16 20:18:38 +00001796{
Tim Petersaa7d8492003-02-08 03:28:59 +00001797 if (PyDelta_Check(other)) {
Guido van Rossum19960592006-08-24 17:29:38 +00001798 int diff = GET_TD_DAYS(self) - GET_TD_DAYS(other);
Tim Peters07534a62003-02-07 22:50:28 +00001799 if (diff == 0) {
1800 diff = GET_TD_SECONDS(self) - GET_TD_SECONDS(other);
1801 if (diff == 0)
1802 diff = GET_TD_MICROSECONDS(self) -
1803 GET_TD_MICROSECONDS(other);
1804 }
Guido van Rossum19960592006-08-24 17:29:38 +00001805 return diff_to_bool(diff, op);
Tim Peters2a799bf2002-12-16 20:18:38 +00001806 }
Guido van Rossum19960592006-08-24 17:29:38 +00001807 else {
1808 Py_INCREF(Py_NotImplemented);
1809 return Py_NotImplemented;
1810 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001811}
1812
1813static PyObject *delta_getstate(PyDateTime_Delta *self);
1814
1815static long
1816delta_hash(PyDateTime_Delta *self)
1817{
1818 if (self->hashcode == -1) {
1819 PyObject *temp = delta_getstate(self);
1820 if (temp != NULL) {
1821 self->hashcode = PyObject_Hash(temp);
1822 Py_DECREF(temp);
1823 }
1824 }
1825 return self->hashcode;
1826}
1827
1828static PyObject *
1829delta_multiply(PyObject *left, PyObject *right)
1830{
1831 PyObject *result = Py_NotImplemented;
1832
1833 if (PyDelta_Check(left)) {
1834 /* delta * ??? */
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001835 if (PyLong_Check(right))
Tim Peters2a799bf2002-12-16 20:18:38 +00001836 result = multiply_int_timedelta(right,
1837 (PyDateTime_Delta *) left);
1838 }
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001839 else if (PyLong_Check(left))
Tim Peters2a799bf2002-12-16 20:18:38 +00001840 result = multiply_int_timedelta(left,
1841 (PyDateTime_Delta *) right);
1842
1843 if (result == Py_NotImplemented)
1844 Py_INCREF(result);
1845 return result;
1846}
1847
1848static PyObject *
1849delta_divide(PyObject *left, PyObject *right)
1850{
1851 PyObject *result = Py_NotImplemented;
1852
1853 if (PyDelta_Check(left)) {
1854 /* delta * ??? */
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001855 if (PyLong_Check(right))
Tim Peters2a799bf2002-12-16 20:18:38 +00001856 result = divide_timedelta_int(
1857 (PyDateTime_Delta *)left,
1858 right);
Mark Dickinson7c186e22010-04-20 22:32:49 +00001859 else if (PyDelta_Check(right))
1860 result = divide_timedelta_timedelta(
1861 (PyDateTime_Delta *)left,
1862 (PyDateTime_Delta *)right);
Tim Peters2a799bf2002-12-16 20:18:38 +00001863 }
1864
1865 if (result == Py_NotImplemented)
1866 Py_INCREF(result);
1867 return result;
1868}
1869
Mark Dickinson7c186e22010-04-20 22:32:49 +00001870static PyObject *
1871delta_truedivide(PyObject *left, PyObject *right)
1872{
1873 PyObject *result = Py_NotImplemented;
1874
1875 if (PyDelta_Check(left)) {
1876 if (PyDelta_Check(right))
1877 result = truedivide_timedelta_timedelta(
1878 (PyDateTime_Delta *)left,
1879 (PyDateTime_Delta *)right);
1880 }
1881
1882 if (result == Py_NotImplemented)
1883 Py_INCREF(result);
1884 return result;
1885}
1886
1887static PyObject *
1888delta_remainder(PyObject *left, PyObject *right)
1889{
1890 PyObject *pyus_left;
1891 PyObject *pyus_right;
1892 PyObject *pyus_remainder;
1893 PyObject *remainder;
1894
1895 if (!PyDelta_Check(left) || !PyDelta_Check(right)) {
1896 Py_INCREF(Py_NotImplemented);
1897 return Py_NotImplemented;
1898 }
1899
1900 pyus_left = delta_to_microseconds((PyDateTime_Delta *)left);
1901 if (pyus_left == NULL)
1902 return NULL;
1903
1904 pyus_right = delta_to_microseconds((PyDateTime_Delta *)right);
1905 if (pyus_right == NULL) {
1906 Py_DECREF(pyus_left);
1907 return NULL;
1908 }
1909
1910 pyus_remainder = PyNumber_Remainder(pyus_left, pyus_right);
1911 Py_DECREF(pyus_left);
1912 Py_DECREF(pyus_right);
1913 if (pyus_remainder == NULL)
1914 return NULL;
1915
1916 remainder = microseconds_to_delta(pyus_remainder);
Mark Dickinson56a60872010-04-20 22:39:53 +00001917 Py_DECREF(pyus_remainder);
1918 if (remainder == NULL)
Mark Dickinson7c186e22010-04-20 22:32:49 +00001919 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00001920
1921 return remainder;
1922}
1923
1924static PyObject *
1925delta_divmod(PyObject *left, PyObject *right)
1926{
1927 PyObject *pyus_left;
1928 PyObject *pyus_right;
1929 PyObject *divmod;
1930 PyObject *microseconds, *delta;
1931
1932 if (!PyDelta_Check(left) || !PyDelta_Check(right)) {
1933 Py_INCREF(Py_NotImplemented);
1934 return Py_NotImplemented;
1935 }
1936
1937 pyus_left = delta_to_microseconds((PyDateTime_Delta *)left);
1938 if (pyus_left == NULL)
1939 return NULL;
1940
1941 pyus_right = delta_to_microseconds((PyDateTime_Delta *)right);
1942 if (pyus_right == NULL) {
1943 Py_DECREF(pyus_left);
1944 return NULL;
1945 }
1946
1947 divmod = PyNumber_Divmod(pyus_left, pyus_right);
1948 Py_DECREF(pyus_left);
1949 Py_DECREF(pyus_right);
1950 if (divmod == NULL)
1951 return NULL;
1952
1953 microseconds = PyTuple_GetItem(divmod, 1);
1954 delta = microseconds_to_delta(microseconds);
1955 if (delta == NULL) {
1956 Py_DECREF(divmod);
1957 return NULL;
1958 }
1959 PyTuple_SetItem(divmod, 1, delta);
1960 return divmod;
1961}
1962
Tim Peters2a799bf2002-12-16 20:18:38 +00001963/* Fold in the value of the tag ("seconds", "weeks", etc) component of a
1964 * timedelta constructor. sofar is the # of microseconds accounted for
1965 * so far, and there are factor microseconds per current unit, the number
1966 * of which is given by num. num * factor is added to sofar in a
1967 * numerically careful way, and that's the result. Any fractional
1968 * microseconds left over (this can happen if num is a float type) are
1969 * added into *leftover.
1970 * Note that there are many ways this can give an error (NULL) return.
1971 */
1972static PyObject *
1973accum(const char* tag, PyObject *sofar, PyObject *num, PyObject *factor,
1974 double *leftover)
1975{
1976 PyObject *prod;
1977 PyObject *sum;
1978
1979 assert(num != NULL);
1980
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001981 if (PyLong_Check(num)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00001982 prod = PyNumber_Multiply(num, factor);
1983 if (prod == NULL)
1984 return NULL;
1985 sum = PyNumber_Add(sofar, prod);
1986 Py_DECREF(prod);
1987 return sum;
1988 }
1989
1990 if (PyFloat_Check(num)) {
1991 double dnum;
1992 double fracpart;
1993 double intpart;
1994 PyObject *x;
1995 PyObject *y;
1996
1997 /* The Plan: decompose num into an integer part and a
1998 * fractional part, num = intpart + fracpart.
1999 * Then num * factor ==
2000 * intpart * factor + fracpart * factor
2001 * and the LHS can be computed exactly in long arithmetic.
2002 * The RHS is again broken into an int part and frac part.
2003 * and the frac part is added into *leftover.
2004 */
2005 dnum = PyFloat_AsDouble(num);
2006 if (dnum == -1.0 && PyErr_Occurred())
2007 return NULL;
2008 fracpart = modf(dnum, &intpart);
2009 x = PyLong_FromDouble(intpart);
2010 if (x == NULL)
2011 return NULL;
2012
2013 prod = PyNumber_Multiply(x, factor);
2014 Py_DECREF(x);
2015 if (prod == NULL)
2016 return NULL;
2017
2018 sum = PyNumber_Add(sofar, prod);
2019 Py_DECREF(prod);
2020 if (sum == NULL)
2021 return NULL;
2022
2023 if (fracpart == 0.0)
2024 return sum;
2025 /* So far we've lost no information. Dealing with the
2026 * fractional part requires float arithmetic, and may
2027 * lose a little info.
2028 */
Neal Norwitz1fe5f382007-08-31 04:32:55 +00002029 assert(PyLong_Check(factor));
Guido van Rossumddefaf32007-01-14 03:31:43 +00002030 dnum = PyLong_AsDouble(factor);
Tim Peters2a799bf2002-12-16 20:18:38 +00002031
2032 dnum *= fracpart;
2033 fracpart = modf(dnum, &intpart);
2034 x = PyLong_FromDouble(intpart);
2035 if (x == NULL) {
2036 Py_DECREF(sum);
2037 return NULL;
2038 }
2039
2040 y = PyNumber_Add(sum, x);
2041 Py_DECREF(sum);
2042 Py_DECREF(x);
2043 *leftover += fracpart;
2044 return y;
2045 }
2046
2047 PyErr_Format(PyExc_TypeError,
2048 "unsupported type for timedelta %s component: %s",
Christian Heimes90aa7642007-12-19 02:45:37 +00002049 tag, Py_TYPE(num)->tp_name);
Tim Peters2a799bf2002-12-16 20:18:38 +00002050 return NULL;
2051}
2052
2053static PyObject *
2054delta_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2055{
2056 PyObject *self = NULL;
2057
2058 /* Argument objects. */
2059 PyObject *day = NULL;
2060 PyObject *second = NULL;
2061 PyObject *us = NULL;
2062 PyObject *ms = NULL;
2063 PyObject *minute = NULL;
2064 PyObject *hour = NULL;
2065 PyObject *week = NULL;
2066
2067 PyObject *x = NULL; /* running sum of microseconds */
2068 PyObject *y = NULL; /* temp sum of microseconds */
2069 double leftover_us = 0.0;
2070
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002071 static char *keywords[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00002072 "days", "seconds", "microseconds", "milliseconds",
2073 "minutes", "hours", "weeks", NULL
2074 };
2075
2076 if (PyArg_ParseTupleAndKeywords(args, kw, "|OOOOOOO:__new__",
2077 keywords,
2078 &day, &second, &us,
2079 &ms, &minute, &hour, &week) == 0)
2080 goto Done;
2081
Christian Heimes217cfd12007-12-02 14:31:20 +00002082 x = PyLong_FromLong(0);
Tim Peters2a799bf2002-12-16 20:18:38 +00002083 if (x == NULL)
2084 goto Done;
2085
2086#define CLEANUP \
2087 Py_DECREF(x); \
2088 x = y; \
2089 if (x == NULL) \
2090 goto Done
2091
2092 if (us) {
2093 y = accum("microseconds", x, us, us_per_us, &leftover_us);
2094 CLEANUP;
2095 }
2096 if (ms) {
2097 y = accum("milliseconds", x, ms, us_per_ms, &leftover_us);
2098 CLEANUP;
2099 }
2100 if (second) {
2101 y = accum("seconds", x, second, us_per_second, &leftover_us);
2102 CLEANUP;
2103 }
2104 if (minute) {
2105 y = accum("minutes", x, minute, us_per_minute, &leftover_us);
2106 CLEANUP;
2107 }
2108 if (hour) {
2109 y = accum("hours", x, hour, us_per_hour, &leftover_us);
2110 CLEANUP;
2111 }
2112 if (day) {
2113 y = accum("days", x, day, us_per_day, &leftover_us);
2114 CLEANUP;
2115 }
2116 if (week) {
2117 y = accum("weeks", x, week, us_per_week, &leftover_us);
2118 CLEANUP;
2119 }
2120 if (leftover_us) {
2121 /* Round to nearest whole # of us, and add into x. */
Tim Peters5d644dd2003-01-02 16:32:54 +00002122 PyObject *temp = PyLong_FromLong(round_to_long(leftover_us));
Tim Peters2a799bf2002-12-16 20:18:38 +00002123 if (temp == NULL) {
2124 Py_DECREF(x);
2125 goto Done;
2126 }
2127 y = PyNumber_Add(x, temp);
2128 Py_DECREF(temp);
2129 CLEANUP;
2130 }
2131
Tim Petersb0c854d2003-05-17 15:57:00 +00002132 self = microseconds_to_delta_ex(x, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00002133 Py_DECREF(x);
2134Done:
2135 return self;
2136
2137#undef CLEANUP
2138}
2139
2140static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00002141delta_bool(PyDateTime_Delta *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00002142{
2143 return (GET_TD_DAYS(self) != 0
2144 || GET_TD_SECONDS(self) != 0
2145 || GET_TD_MICROSECONDS(self) != 0);
2146}
2147
2148static PyObject *
2149delta_repr(PyDateTime_Delta *self)
2150{
2151 if (GET_TD_MICROSECONDS(self) != 0)
Walter Dörwald1ab83302007-05-18 17:15:44 +00002152 return PyUnicode_FromFormat("%s(%d, %d, %d)",
Christian Heimes90aa7642007-12-19 02:45:37 +00002153 Py_TYPE(self)->tp_name,
Walter Dörwald7569dfe2007-05-19 21:49:49 +00002154 GET_TD_DAYS(self),
2155 GET_TD_SECONDS(self),
2156 GET_TD_MICROSECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002157 if (GET_TD_SECONDS(self) != 0)
Walter Dörwald1ab83302007-05-18 17:15:44 +00002158 return PyUnicode_FromFormat("%s(%d, %d)",
Christian Heimes90aa7642007-12-19 02:45:37 +00002159 Py_TYPE(self)->tp_name,
Walter Dörwald7569dfe2007-05-19 21:49:49 +00002160 GET_TD_DAYS(self),
2161 GET_TD_SECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002162
Walter Dörwald1ab83302007-05-18 17:15:44 +00002163 return PyUnicode_FromFormat("%s(%d)",
Christian Heimes90aa7642007-12-19 02:45:37 +00002164 Py_TYPE(self)->tp_name,
Walter Dörwald7569dfe2007-05-19 21:49:49 +00002165 GET_TD_DAYS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002166}
2167
2168static PyObject *
2169delta_str(PyDateTime_Delta *self)
2170{
Tim Peters2a799bf2002-12-16 20:18:38 +00002171 int us = GET_TD_MICROSECONDS(self);
Walter Dörwaldbaf853c2007-05-31 18:42:47 +00002172 int seconds = GET_TD_SECONDS(self);
2173 int minutes = divmod(seconds, 60, &seconds);
2174 int hours = divmod(minutes, 60, &minutes);
2175 int days = GET_TD_DAYS(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002176
2177 if (days) {
Walter Dörwaldbaf853c2007-05-31 18:42:47 +00002178 if (us)
2179 return PyUnicode_FromFormat("%d day%s, %d:%02d:%02d.%06d",
2180 days, (days == 1 || days == -1) ? "" : "s",
2181 hours, minutes, seconds, us);
2182 else
2183 return PyUnicode_FromFormat("%d day%s, %d:%02d:%02d",
2184 days, (days == 1 || days == -1) ? "" : "s",
2185 hours, minutes, seconds);
2186 } else {
2187 if (us)
2188 return PyUnicode_FromFormat("%d:%02d:%02d.%06d",
2189 hours, minutes, seconds, us);
2190 else
2191 return PyUnicode_FromFormat("%d:%02d:%02d",
2192 hours, minutes, seconds);
Tim Peters2a799bf2002-12-16 20:18:38 +00002193 }
2194
Tim Peters2a799bf2002-12-16 20:18:38 +00002195}
2196
Tim Peters371935f2003-02-01 01:52:50 +00002197/* Pickle support, a simple use of __reduce__. */
2198
Tim Petersb57f8f02003-02-01 02:54:15 +00002199/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002200static PyObject *
2201delta_getstate(PyDateTime_Delta *self)
2202{
2203 return Py_BuildValue("iii", GET_TD_DAYS(self),
2204 GET_TD_SECONDS(self),
2205 GET_TD_MICROSECONDS(self));
2206}
2207
Tim Peters2a799bf2002-12-16 20:18:38 +00002208static PyObject *
Antoine Pitroube6859d2009-11-25 23:02:32 +00002209delta_total_seconds(PyObject *self)
2210{
2211 return PyFloat_FromDouble(GET_TD_MICROSECONDS(self) / 1000000.0 +
2212 GET_TD_SECONDS(self) +
2213 GET_TD_DAYS(self) * 24.0 * 3600.0);
2214}
2215
2216static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002217delta_reduce(PyDateTime_Delta* self)
2218{
Christian Heimes90aa7642007-12-19 02:45:37 +00002219 return Py_BuildValue("ON", Py_TYPE(self), delta_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002220}
2221
2222#define OFFSET(field) offsetof(PyDateTime_Delta, field)
2223
2224static PyMemberDef delta_members[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002225
Neal Norwitzdfb80862002-12-19 02:30:56 +00002226 {"days", T_INT, OFFSET(days), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002227 PyDoc_STR("Number of days.")},
2228
Neal Norwitzdfb80862002-12-19 02:30:56 +00002229 {"seconds", T_INT, OFFSET(seconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002230 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
2231
Neal Norwitzdfb80862002-12-19 02:30:56 +00002232 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
Tim Peters2a799bf2002-12-16 20:18:38 +00002233 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
2234 {NULL}
2235};
2236
2237static PyMethodDef delta_methods[] = {
Antoine Pitroube6859d2009-11-25 23:02:32 +00002238 {"total_seconds", (PyCFunction)delta_total_seconds, METH_NOARGS,
2239 PyDoc_STR("Total seconds in the duration.")},
2240
2241 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
Guido van Rossum177e41a2003-01-30 22:06:23 +00002242 PyDoc_STR("__reduce__() -> (cls, state)")},
2243
Tim Peters2a799bf2002-12-16 20:18:38 +00002244 {NULL, NULL},
2245};
2246
2247static char delta_doc[] =
2248PyDoc_STR("Difference between two datetime values.");
2249
2250static PyNumberMethods delta_as_number = {
2251 delta_add, /* nb_add */
2252 delta_subtract, /* nb_subtract */
2253 delta_multiply, /* nb_multiply */
Mark Dickinson7c186e22010-04-20 22:32:49 +00002254 delta_remainder, /* nb_remainder */
2255 delta_divmod, /* nb_divmod */
Tim Peters2a799bf2002-12-16 20:18:38 +00002256 0, /* nb_power */
2257 (unaryfunc)delta_negative, /* nb_negative */
2258 (unaryfunc)delta_positive, /* nb_positive */
2259 (unaryfunc)delta_abs, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +00002260 (inquiry)delta_bool, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00002261 0, /*nb_invert*/
2262 0, /*nb_lshift*/
2263 0, /*nb_rshift*/
2264 0, /*nb_and*/
2265 0, /*nb_xor*/
2266 0, /*nb_or*/
Tim Peters2a799bf2002-12-16 20:18:38 +00002267 0, /*nb_int*/
Mark Dickinson8055afd2009-01-17 10:04:45 +00002268 0, /*nb_reserved*/
Tim Peters2a799bf2002-12-16 20:18:38 +00002269 0, /*nb_float*/
Tim Peters2a799bf2002-12-16 20:18:38 +00002270 0, /*nb_inplace_add*/
2271 0, /*nb_inplace_subtract*/
2272 0, /*nb_inplace_multiply*/
Tim Peters2a799bf2002-12-16 20:18:38 +00002273 0, /*nb_inplace_remainder*/
2274 0, /*nb_inplace_power*/
2275 0, /*nb_inplace_lshift*/
2276 0, /*nb_inplace_rshift*/
2277 0, /*nb_inplace_and*/
2278 0, /*nb_inplace_xor*/
2279 0, /*nb_inplace_or*/
2280 delta_divide, /* nb_floor_divide */
Mark Dickinson7c186e22010-04-20 22:32:49 +00002281 delta_truedivide, /* nb_true_divide */
Tim Peters2a799bf2002-12-16 20:18:38 +00002282 0, /* nb_inplace_floor_divide */
2283 0, /* nb_inplace_true_divide */
2284};
2285
2286static PyTypeObject PyDateTime_DeltaType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002287 PyVarObject_HEAD_INIT(NULL, 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00002288 "datetime.timedelta", /* tp_name */
2289 sizeof(PyDateTime_Delta), /* tp_basicsize */
2290 0, /* tp_itemsize */
2291 0, /* tp_dealloc */
2292 0, /* tp_print */
2293 0, /* tp_getattr */
2294 0, /* tp_setattr */
Mark Dickinsone94c6792009-02-02 20:36:42 +00002295 0, /* tp_reserved */
Tim Peters2a799bf2002-12-16 20:18:38 +00002296 (reprfunc)delta_repr, /* tp_repr */
2297 &delta_as_number, /* tp_as_number */
2298 0, /* tp_as_sequence */
2299 0, /* tp_as_mapping */
2300 (hashfunc)delta_hash, /* tp_hash */
2301 0, /* tp_call */
2302 (reprfunc)delta_str, /* tp_str */
2303 PyObject_GenericGetAttr, /* tp_getattro */
2304 0, /* tp_setattro */
2305 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002306 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00002307 delta_doc, /* tp_doc */
2308 0, /* tp_traverse */
2309 0, /* tp_clear */
Guido van Rossum19960592006-08-24 17:29:38 +00002310 delta_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00002311 0, /* tp_weaklistoffset */
2312 0, /* tp_iter */
2313 0, /* tp_iternext */
2314 delta_methods, /* tp_methods */
2315 delta_members, /* tp_members */
2316 0, /* tp_getset */
2317 0, /* tp_base */
2318 0, /* tp_dict */
2319 0, /* tp_descr_get */
2320 0, /* tp_descr_set */
2321 0, /* tp_dictoffset */
2322 0, /* tp_init */
2323 0, /* tp_alloc */
2324 delta_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002325 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002326};
2327
2328/*
2329 * PyDateTime_Date implementation.
2330 */
2331
2332/* Accessor properties. */
2333
2334static PyObject *
2335date_year(PyDateTime_Date *self, void *unused)
2336{
Christian Heimes217cfd12007-12-02 14:31:20 +00002337 return PyLong_FromLong(GET_YEAR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002338}
2339
2340static PyObject *
2341date_month(PyDateTime_Date *self, void *unused)
2342{
Christian Heimes217cfd12007-12-02 14:31:20 +00002343 return PyLong_FromLong(GET_MONTH(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002344}
2345
2346static PyObject *
2347date_day(PyDateTime_Date *self, void *unused)
2348{
Christian Heimes217cfd12007-12-02 14:31:20 +00002349 return PyLong_FromLong(GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002350}
2351
2352static PyGetSetDef date_getset[] = {
2353 {"year", (getter)date_year},
2354 {"month", (getter)date_month},
2355 {"day", (getter)date_day},
2356 {NULL}
2357};
2358
2359/* Constructors. */
2360
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002361static char *date_kws[] = {"year", "month", "day", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002362
Tim Peters2a799bf2002-12-16 20:18:38 +00002363static PyObject *
2364date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2365{
2366 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00002367 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00002368 int year;
2369 int month;
2370 int day;
2371
Guido van Rossum177e41a2003-01-30 22:06:23 +00002372 /* Check for invocation from pickle with __getstate__ state */
2373 if (PyTuple_GET_SIZE(args) == 1 &&
Christian Heimes72b710a2008-05-26 13:28:38 +00002374 PyBytes_Check(state = PyTuple_GET_ITEM(args, 0)) &&
2375 PyBytes_GET_SIZE(state) == _PyDateTime_DATE_DATASIZE &&
2376 MONTH_IS_SANE(PyBytes_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00002377 {
Tim Peters70533e22003-02-01 04:40:04 +00002378 PyDateTime_Date *me;
2379
Tim Peters604c0132004-06-07 23:04:33 +00002380 me = (PyDateTime_Date *) (type->tp_alloc(type, 0));
Tim Peters70533e22003-02-01 04:40:04 +00002381 if (me != NULL) {
Christian Heimes72b710a2008-05-26 13:28:38 +00002382 char *pdata = PyBytes_AS_STRING(state);
Tim Peters70533e22003-02-01 04:40:04 +00002383 memcpy(me->data, pdata, _PyDateTime_DATE_DATASIZE);
2384 me->hashcode = -1;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002385 }
Tim Peters70533e22003-02-01 04:40:04 +00002386 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00002387 }
2388
Tim Peters12bf3392002-12-24 05:41:27 +00002389 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00002390 &year, &month, &day)) {
2391 if (check_date_args(year, month, day) < 0)
2392 return NULL;
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002393 self = new_date_ex(year, month, day, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00002394 }
2395 return self;
2396}
2397
2398/* Return new date from localtime(t). */
2399static PyObject *
Tim Peters1b6f7a92004-06-20 02:50:16 +00002400date_local_from_time_t(PyObject *cls, double ts)
Tim Peters2a799bf2002-12-16 20:18:38 +00002401{
2402 struct tm *tm;
Tim Peters1b6f7a92004-06-20 02:50:16 +00002403 time_t t;
Tim Peters2a799bf2002-12-16 20:18:38 +00002404 PyObject *result = NULL;
2405
Tim Peters1b6f7a92004-06-20 02:50:16 +00002406 t = _PyTime_DoubleToTimet(ts);
2407 if (t == (time_t)-1 && PyErr_Occurred())
2408 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002409 tm = localtime(&t);
2410 if (tm)
2411 result = PyObject_CallFunction(cls, "iii",
2412 tm->tm_year + 1900,
2413 tm->tm_mon + 1,
2414 tm->tm_mday);
2415 else
2416 PyErr_SetString(PyExc_ValueError,
2417 "timestamp out of range for "
2418 "platform localtime() function");
2419 return result;
2420}
2421
2422/* Return new date from current time.
2423 * We say this is equivalent to fromtimestamp(time.time()), and the
2424 * only way to be sure of that is to *call* time.time(). That's not
2425 * generally the same as calling C's time.
2426 */
2427static PyObject *
2428date_today(PyObject *cls, PyObject *dummy)
2429{
2430 PyObject *time;
2431 PyObject *result;
2432
2433 time = time_time();
2434 if (time == NULL)
2435 return NULL;
2436
2437 /* Note well: today() is a class method, so this may not call
2438 * date.fromtimestamp. For example, it may call
2439 * datetime.fromtimestamp. That's why we need all the accuracy
2440 * time.time() delivers; if someone were gonzo about optimization,
2441 * date.today() could get away with plain C time().
2442 */
2443 result = PyObject_CallMethod(cls, "fromtimestamp", "O", time);
2444 Py_DECREF(time);
2445 return result;
2446}
2447
2448/* Return new date from given timestamp (Python timestamp -- a double). */
2449static PyObject *
2450date_fromtimestamp(PyObject *cls, PyObject *args)
2451{
2452 double timestamp;
2453 PyObject *result = NULL;
2454
2455 if (PyArg_ParseTuple(args, "d:fromtimestamp", &timestamp))
Tim Peters1b6f7a92004-06-20 02:50:16 +00002456 result = date_local_from_time_t(cls, timestamp);
Tim Peters2a799bf2002-12-16 20:18:38 +00002457 return result;
2458}
2459
2460/* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2461 * the ordinal is out of range.
2462 */
2463static PyObject *
2464date_fromordinal(PyObject *cls, PyObject *args)
2465{
2466 PyObject *result = NULL;
2467 int ordinal;
2468
2469 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2470 int year;
2471 int month;
2472 int day;
2473
2474 if (ordinal < 1)
2475 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2476 ">= 1");
2477 else {
2478 ord_to_ymd(ordinal, &year, &month, &day);
2479 result = PyObject_CallFunction(cls, "iii",
2480 year, month, day);
2481 }
2482 }
2483 return result;
2484}
2485
2486/*
2487 * Date arithmetic.
2488 */
2489
2490/* date + timedelta -> date. If arg negate is true, subtract the timedelta
2491 * instead.
2492 */
2493static PyObject *
2494add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
2495{
2496 PyObject *result = NULL;
2497 int year = GET_YEAR(date);
2498 int month = GET_MONTH(date);
2499 int deltadays = GET_TD_DAYS(delta);
2500 /* C-level overflow is impossible because |deltadays| < 1e9. */
2501 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
2502
2503 if (normalize_date(&year, &month, &day) >= 0)
2504 result = new_date(year, month, day);
2505 return result;
2506}
2507
2508static PyObject *
2509date_add(PyObject *left, PyObject *right)
2510{
2511 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2512 Py_INCREF(Py_NotImplemented);
2513 return Py_NotImplemented;
2514 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002515 if (PyDate_Check(left)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002516 /* date + ??? */
2517 if (PyDelta_Check(right))
2518 /* date + delta */
2519 return add_date_timedelta((PyDateTime_Date *) left,
2520 (PyDateTime_Delta *) right,
2521 0);
2522 }
2523 else {
2524 /* ??? + date
2525 * 'right' must be one of us, or we wouldn't have been called
2526 */
2527 if (PyDelta_Check(left))
2528 /* delta + date */
2529 return add_date_timedelta((PyDateTime_Date *) right,
2530 (PyDateTime_Delta *) left,
2531 0);
2532 }
2533 Py_INCREF(Py_NotImplemented);
2534 return Py_NotImplemented;
2535}
2536
2537static PyObject *
2538date_subtract(PyObject *left, PyObject *right)
2539{
2540 if (PyDateTime_Check(left) || PyDateTime_Check(right)) {
2541 Py_INCREF(Py_NotImplemented);
2542 return Py_NotImplemented;
2543 }
Tim Petersaa7d8492003-02-08 03:28:59 +00002544 if (PyDate_Check(left)) {
2545 if (PyDate_Check(right)) {
Tim Peters2a799bf2002-12-16 20:18:38 +00002546 /* date - date */
2547 int left_ord = ymd_to_ord(GET_YEAR(left),
2548 GET_MONTH(left),
2549 GET_DAY(left));
2550 int right_ord = ymd_to_ord(GET_YEAR(right),
2551 GET_MONTH(right),
2552 GET_DAY(right));
2553 return new_delta(left_ord - right_ord, 0, 0, 0);
2554 }
2555 if (PyDelta_Check(right)) {
2556 /* date - delta */
2557 return add_date_timedelta((PyDateTime_Date *) left,
2558 (PyDateTime_Delta *) right,
2559 1);
2560 }
2561 }
2562 Py_INCREF(Py_NotImplemented);
2563 return Py_NotImplemented;
2564}
2565
2566
2567/* Various ways to turn a date into a string. */
2568
2569static PyObject *
2570date_repr(PyDateTime_Date *self)
2571{
Walter Dörwald7569dfe2007-05-19 21:49:49 +00002572 return PyUnicode_FromFormat("%s(%d, %d, %d)",
Christian Heimes90aa7642007-12-19 02:45:37 +00002573 Py_TYPE(self)->tp_name,
Walter Dörwald7569dfe2007-05-19 21:49:49 +00002574 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002575}
2576
2577static PyObject *
2578date_isoformat(PyDateTime_Date *self)
2579{
Walter Dörwaldbafa1372007-05-31 17:50:48 +00002580 return PyUnicode_FromFormat("%04d-%02d-%02d",
2581 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002582}
2583
Tim Peterse2df5ff2003-05-02 18:39:55 +00002584/* str() calls the appropriate isoformat() method. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002585static PyObject *
2586date_str(PyDateTime_Date *self)
2587{
2588 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
2589}
2590
2591
2592static PyObject *
2593date_ctime(PyDateTime_Date *self)
2594{
2595 return format_ctime(self, 0, 0, 0);
2596}
2597
2598static PyObject *
2599date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2600{
2601 /* This method can be inherited, and needs to call the
2602 * timetuple() method appropriate to self's class.
2603 */
2604 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002605 PyObject *tuple;
Georg Brandlf78e02b2008-06-10 17:40:04 +00002606 PyObject *format;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002607 static char *keywords[] = {"format", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00002608
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002609 if (! PyArg_ParseTupleAndKeywords(args, kw, "U:strftime", keywords,
Guido van Rossumbce56a62007-05-10 18:04:33 +00002610 &format))
Tim Peters2a799bf2002-12-16 20:18:38 +00002611 return NULL;
2612
2613 tuple = PyObject_CallMethod((PyObject *)self, "timetuple", "()");
2614 if (tuple == NULL)
2615 return NULL;
Tim Petersbad8ff02002-12-30 20:52:32 +00002616 result = wrap_strftime((PyObject *)self, format, tuple,
2617 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002618 Py_DECREF(tuple);
2619 return result;
2620}
2621
Eric Smith1ba31142007-09-11 18:06:02 +00002622static PyObject *
2623date_format(PyDateTime_Date *self, PyObject *args)
2624{
2625 PyObject *format;
2626
2627 if (!PyArg_ParseTuple(args, "U:__format__", &format))
2628 return NULL;
2629
2630 /* if the format is zero length, return str(self) */
2631 if (PyUnicode_GetSize(format) == 0)
Thomas Heller519a0422007-11-15 20:48:54 +00002632 return PyObject_Str((PyObject *)self);
Eric Smith1ba31142007-09-11 18:06:02 +00002633
2634 return PyObject_CallMethod((PyObject *)self, "strftime", "O", format);
2635}
2636
Tim Peters2a799bf2002-12-16 20:18:38 +00002637/* ISO methods. */
2638
2639static PyObject *
2640date_isoweekday(PyDateTime_Date *self)
2641{
2642 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2643
Christian Heimes217cfd12007-12-02 14:31:20 +00002644 return PyLong_FromLong(dow + 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00002645}
2646
2647static PyObject *
2648date_isocalendar(PyDateTime_Date *self)
2649{
2650 int year = GET_YEAR(self);
2651 int week1_monday = iso_week1_monday(year);
2652 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
2653 int week;
2654 int day;
2655
2656 week = divmod(today - week1_monday, 7, &day);
2657 if (week < 0) {
2658 --year;
2659 week1_monday = iso_week1_monday(year);
2660 week = divmod(today - week1_monday, 7, &day);
2661 }
2662 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
2663 ++year;
2664 week = 0;
2665 }
2666 return Py_BuildValue("iii", year, week + 1, day + 1);
2667}
2668
2669/* Miscellaneous methods. */
2670
Tim Peters2a799bf2002-12-16 20:18:38 +00002671static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00002672date_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters2a799bf2002-12-16 20:18:38 +00002673{
Guido van Rossum19960592006-08-24 17:29:38 +00002674 if (PyDate_Check(other)) {
2675 int diff = memcmp(((PyDateTime_Date *)self)->data,
2676 ((PyDateTime_Date *)other)->data,
2677 _PyDateTime_DATE_DATASIZE);
2678 return diff_to_bool(diff, op);
2679 }
2680 else {
Tim Peters07534a62003-02-07 22:50:28 +00002681 Py_INCREF(Py_NotImplemented);
2682 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002683 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002684}
2685
2686static PyObject *
2687date_timetuple(PyDateTime_Date *self)
2688{
2689 return build_struct_time(GET_YEAR(self),
2690 GET_MONTH(self),
2691 GET_DAY(self),
2692 0, 0, 0, -1);
2693}
2694
Tim Peters12bf3392002-12-24 05:41:27 +00002695static PyObject *
2696date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
2697{
2698 PyObject *clone;
2699 PyObject *tuple;
2700 int year = GET_YEAR(self);
2701 int month = GET_MONTH(self);
2702 int day = GET_DAY(self);
2703
2704 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
2705 &year, &month, &day))
2706 return NULL;
2707 tuple = Py_BuildValue("iii", year, month, day);
2708 if (tuple == NULL)
2709 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00002710 clone = date_new(Py_TYPE(self), tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00002711 Py_DECREF(tuple);
2712 return clone;
2713}
2714
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002715/*
2716 Borrowed from stringobject.c, originally it was string_hash()
2717*/
2718static long
2719generic_hash(unsigned char *data, int len)
2720{
2721 register unsigned char *p;
2722 register long x;
2723
2724 p = (unsigned char *) data;
2725 x = *p << 7;
2726 while (--len >= 0)
2727 x = (1000003*x) ^ *p++;
2728 x ^= len;
2729 if (x == -1)
2730 x = -2;
2731
2732 return x;
2733}
2734
2735
2736static PyObject *date_getstate(PyDateTime_Date *self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002737
2738static long
2739date_hash(PyDateTime_Date *self)
2740{
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002741 if (self->hashcode == -1)
2742 self->hashcode = generic_hash(
2743 (unsigned char *)self->data, _PyDateTime_DATE_DATASIZE);
Guido van Rossum254348e2007-11-21 19:29:53 +00002744
Tim Peters2a799bf2002-12-16 20:18:38 +00002745 return self->hashcode;
2746}
2747
2748static PyObject *
2749date_toordinal(PyDateTime_Date *self)
2750{
Christian Heimes217cfd12007-12-02 14:31:20 +00002751 return PyLong_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
Tim Peters2a799bf2002-12-16 20:18:38 +00002752 GET_DAY(self)));
2753}
2754
2755static PyObject *
2756date_weekday(PyDateTime_Date *self)
2757{
2758 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
2759
Christian Heimes217cfd12007-12-02 14:31:20 +00002760 return PyLong_FromLong(dow);
Tim Peters2a799bf2002-12-16 20:18:38 +00002761}
2762
Tim Peters371935f2003-02-01 01:52:50 +00002763/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00002764
Tim Petersb57f8f02003-02-01 02:54:15 +00002765/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002766static PyObject *
Guido van Rossumfd53fd62007-08-24 04:05:13 +00002767date_getstate(PyDateTime_Date *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00002768{
Martin v. Löwis10a60b32007-07-18 02:28:27 +00002769 PyObject* field;
Christian Heimes72b710a2008-05-26 13:28:38 +00002770 field = PyBytes_FromStringAndSize((char*)self->data,
Guido van Rossum254348e2007-11-21 19:29:53 +00002771 _PyDateTime_DATE_DATASIZE);
Martin v. Löwis10a60b32007-07-18 02:28:27 +00002772 return Py_BuildValue("(N)", field);
Tim Peters2a799bf2002-12-16 20:18:38 +00002773}
2774
2775static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00002776date_reduce(PyDateTime_Date *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00002777{
Christian Heimes90aa7642007-12-19 02:45:37 +00002778 return Py_BuildValue("(ON)", Py_TYPE(self), date_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002779}
2780
2781static PyMethodDef date_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002782
Tim Peters2a799bf2002-12-16 20:18:38 +00002783 /* Class methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00002784
Tim Peters2a799bf2002-12-16 20:18:38 +00002785 {"fromtimestamp", (PyCFunction)date_fromtimestamp, METH_VARARGS |
2786 METH_CLASS,
2787 PyDoc_STR("timestamp -> local date from a POSIX timestamp (like "
2788 "time.time()).")},
2789
2790 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
2791 METH_CLASS,
2792 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
2793 "ordinal.")},
2794
2795 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
2796 PyDoc_STR("Current date or datetime: same as "
2797 "self.__class__.fromtimestamp(time.time()).")},
2798
2799 /* Instance methods: */
2800
2801 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
2802 PyDoc_STR("Return ctime() style string.")},
2803
Guido van Rossumd59da4b2007-05-22 18:11:13 +00002804 {"strftime", (PyCFunction)date_strftime, METH_VARARGS | METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00002805 PyDoc_STR("format -> strftime() style string.")},
2806
Eric Smith1ba31142007-09-11 18:06:02 +00002807 {"__format__", (PyCFunction)date_format, METH_VARARGS,
2808 PyDoc_STR("Formats self with strftime.")},
2809
Tim Peters2a799bf2002-12-16 20:18:38 +00002810 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
2811 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
2812
2813 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
2814 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
2815 "weekday.")},
2816
2817 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
2818 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
2819
2820 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
2821 PyDoc_STR("Return the day of the week represented by the date.\n"
2822 "Monday == 1 ... Sunday == 7")},
2823
2824 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
2825 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
2826 "1 is day 1.")},
2827
2828 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
2829 PyDoc_STR("Return the day of the week represented by the date.\n"
2830 "Monday == 0 ... Sunday == 6")},
2831
Guido van Rossumd59da4b2007-05-22 18:11:13 +00002832 {"replace", (PyCFunction)date_replace, METH_VARARGS | METH_KEYWORDS,
Tim Peters12bf3392002-12-24 05:41:27 +00002833 PyDoc_STR("Return date with new specified fields.")},
2834
Guido van Rossum177e41a2003-01-30 22:06:23 +00002835 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
2836 PyDoc_STR("__reduce__() -> (cls, state)")},
2837
Tim Peters2a799bf2002-12-16 20:18:38 +00002838 {NULL, NULL}
2839};
2840
2841static char date_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00002842PyDoc_STR("date(year, month, day) --> date object");
Tim Peters2a799bf2002-12-16 20:18:38 +00002843
2844static PyNumberMethods date_as_number = {
2845 date_add, /* nb_add */
2846 date_subtract, /* nb_subtract */
2847 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00002848 0, /* nb_remainder */
2849 0, /* nb_divmod */
2850 0, /* nb_power */
2851 0, /* nb_negative */
2852 0, /* nb_positive */
2853 0, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +00002854 0, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00002855};
2856
2857static PyTypeObject PyDateTime_DateType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002858 PyVarObject_HEAD_INIT(NULL, 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00002859 "datetime.date", /* tp_name */
2860 sizeof(PyDateTime_Date), /* tp_basicsize */
2861 0, /* tp_itemsize */
Guido van Rossum8b7a9a32003-04-14 22:01:58 +00002862 0, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00002863 0, /* tp_print */
2864 0, /* tp_getattr */
2865 0, /* tp_setattr */
Mark Dickinsone94c6792009-02-02 20:36:42 +00002866 0, /* tp_reserved */
Tim Peters2a799bf2002-12-16 20:18:38 +00002867 (reprfunc)date_repr, /* tp_repr */
2868 &date_as_number, /* tp_as_number */
2869 0, /* tp_as_sequence */
2870 0, /* tp_as_mapping */
2871 (hashfunc)date_hash, /* tp_hash */
2872 0, /* tp_call */
2873 (reprfunc)date_str, /* tp_str */
2874 PyObject_GenericGetAttr, /* tp_getattro */
2875 0, /* tp_setattro */
2876 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002877 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00002878 date_doc, /* tp_doc */
2879 0, /* tp_traverse */
2880 0, /* tp_clear */
Guido van Rossum19960592006-08-24 17:29:38 +00002881 date_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00002882 0, /* tp_weaklistoffset */
2883 0, /* tp_iter */
2884 0, /* tp_iternext */
2885 date_methods, /* tp_methods */
2886 0, /* tp_members */
2887 date_getset, /* tp_getset */
2888 0, /* tp_base */
2889 0, /* tp_dict */
2890 0, /* tp_descr_get */
2891 0, /* tp_descr_set */
2892 0, /* tp_dictoffset */
2893 0, /* tp_init */
2894 0, /* tp_alloc */
2895 date_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00002896 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002897};
2898
2899/*
Tim Peters2a799bf2002-12-16 20:18:38 +00002900 * PyDateTime_TZInfo implementation.
2901 */
2902
2903/* This is a pure abstract base class, so doesn't do anything beyond
2904 * raising NotImplemented exceptions. Real tzinfo classes need
2905 * to derive from this. This is mostly for clarity, and for efficiency in
Tim Petersa9bc1682003-01-11 03:39:11 +00002906 * datetime and time constructors (their tzinfo arguments need to
Tim Peters2a799bf2002-12-16 20:18:38 +00002907 * be subclasses of this tzinfo class, which is easy and quick to check).
2908 *
2909 * Note: For reasons having to do with pickling of subclasses, we have
2910 * to allow tzinfo objects to be instantiated. This wasn't an issue
2911 * in the Python implementation (__init__() could raise NotImplementedError
2912 * there without ill effect), but doing so in the C implementation hit a
2913 * brick wall.
2914 */
2915
2916static PyObject *
2917tzinfo_nogo(const char* methodname)
2918{
2919 PyErr_Format(PyExc_NotImplementedError,
2920 "a tzinfo subclass must implement %s()",
2921 methodname);
2922 return NULL;
2923}
2924
2925/* Methods. A subclass must implement these. */
2926
Tim Peters52dcce22003-01-23 16:36:11 +00002927static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002928tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
2929{
2930 return tzinfo_nogo("tzname");
2931}
2932
Tim Peters52dcce22003-01-23 16:36:11 +00002933static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002934tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
2935{
2936 return tzinfo_nogo("utcoffset");
2937}
2938
Tim Peters52dcce22003-01-23 16:36:11 +00002939static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002940tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
2941{
2942 return tzinfo_nogo("dst");
2943}
2944
Tim Peters52dcce22003-01-23 16:36:11 +00002945static PyObject *
2946tzinfo_fromutc(PyDateTime_TZInfo *self, PyDateTime_DateTime *dt)
2947{
2948 int y, m, d, hh, mm, ss, us;
2949
2950 PyObject *result;
2951 int off, dst;
2952 int none;
2953 int delta;
2954
2955 if (! PyDateTime_Check(dt)) {
2956 PyErr_SetString(PyExc_TypeError,
2957 "fromutc: argument must be a datetime");
2958 return NULL;
2959 }
2960 if (! HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
2961 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
2962 "is not self");
2963 return NULL;
2964 }
2965
2966 off = call_utcoffset(dt->tzinfo, (PyObject *)dt, &none);
2967 if (off == -1 && PyErr_Occurred())
2968 return NULL;
2969 if (none) {
2970 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2971 "utcoffset() result required");
2972 return NULL;
2973 }
2974
2975 dst = call_dst(dt->tzinfo, (PyObject *)dt, &none);
2976 if (dst == -1 && PyErr_Occurred())
2977 return NULL;
2978 if (none) {
2979 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
2980 "dst() result required");
2981 return NULL;
2982 }
2983
2984 y = GET_YEAR(dt);
2985 m = GET_MONTH(dt);
2986 d = GET_DAY(dt);
2987 hh = DATE_GET_HOUR(dt);
2988 mm = DATE_GET_MINUTE(dt);
2989 ss = DATE_GET_SECOND(dt);
2990 us = DATE_GET_MICROSECOND(dt);
2991
2992 delta = off - dst;
2993 mm += delta;
2994 if ((mm < 0 || mm >= 60) &&
2995 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Petersb1049e82003-01-23 17:20:36 +00002996 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00002997 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
2998 if (result == NULL)
2999 return result;
3000
3001 dst = call_dst(dt->tzinfo, result, &none);
3002 if (dst == -1 && PyErr_Occurred())
3003 goto Fail;
3004 if (none)
3005 goto Inconsistent;
3006 if (dst == 0)
3007 return result;
3008
3009 mm += dst;
3010 if ((mm < 0 || mm >= 60) &&
3011 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
3012 goto Fail;
3013 Py_DECREF(result);
3014 result = new_datetime(y, m, d, hh, mm, ss, us, dt->tzinfo);
3015 return result;
3016
3017Inconsistent:
3018 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave"
3019 "inconsistent results; cannot convert");
3020
3021 /* fall thru to failure */
3022Fail:
3023 Py_DECREF(result);
3024 return NULL;
3025}
3026
Tim Peters2a799bf2002-12-16 20:18:38 +00003027/*
3028 * Pickle support. This is solely so that tzinfo subclasses can use
Guido van Rossum177e41a2003-01-30 22:06:23 +00003029 * pickling -- tzinfo itself is supposed to be uninstantiable.
Tim Peters2a799bf2002-12-16 20:18:38 +00003030 */
3031
Guido van Rossum177e41a2003-01-30 22:06:23 +00003032static PyObject *
3033tzinfo_reduce(PyObject *self)
3034{
3035 PyObject *args, *state, *tmp;
3036 PyObject *getinitargs, *getstate;
Tim Peters2a799bf2002-12-16 20:18:38 +00003037
Guido van Rossum177e41a2003-01-30 22:06:23 +00003038 tmp = PyTuple_New(0);
3039 if (tmp == NULL)
3040 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003041
Guido van Rossum177e41a2003-01-30 22:06:23 +00003042 getinitargs = PyObject_GetAttrString(self, "__getinitargs__");
3043 if (getinitargs != NULL) {
3044 args = PyObject_CallObject(getinitargs, tmp);
3045 Py_DECREF(getinitargs);
3046 if (args == NULL) {
3047 Py_DECREF(tmp);
3048 return NULL;
3049 }
3050 }
3051 else {
3052 PyErr_Clear();
3053 args = tmp;
3054 Py_INCREF(args);
3055 }
3056
3057 getstate = PyObject_GetAttrString(self, "__getstate__");
3058 if (getstate != NULL) {
3059 state = PyObject_CallObject(getstate, tmp);
3060 Py_DECREF(getstate);
3061 if (state == NULL) {
3062 Py_DECREF(args);
3063 Py_DECREF(tmp);
3064 return NULL;
3065 }
3066 }
3067 else {
3068 PyObject **dictptr;
3069 PyErr_Clear();
3070 state = Py_None;
3071 dictptr = _PyObject_GetDictPtr(self);
3072 if (dictptr && *dictptr && PyDict_Size(*dictptr))
3073 state = *dictptr;
3074 Py_INCREF(state);
3075 }
3076
3077 Py_DECREF(tmp);
3078
3079 if (state == Py_None) {
3080 Py_DECREF(state);
Christian Heimes90aa7642007-12-19 02:45:37 +00003081 return Py_BuildValue("(ON)", Py_TYPE(self), args);
Guido van Rossum177e41a2003-01-30 22:06:23 +00003082 }
3083 else
Christian Heimes90aa7642007-12-19 02:45:37 +00003084 return Py_BuildValue("(ONN)", Py_TYPE(self), args, state);
Guido van Rossum177e41a2003-01-30 22:06:23 +00003085}
Tim Peters2a799bf2002-12-16 20:18:38 +00003086
3087static PyMethodDef tzinfo_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003088
Tim Peters2a799bf2002-12-16 20:18:38 +00003089 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
3090 PyDoc_STR("datetime -> string name of time zone.")},
3091
3092 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
3093 PyDoc_STR("datetime -> minutes east of UTC (negative for "
3094 "west of UTC).")},
3095
3096 {"dst", (PyCFunction)tzinfo_dst, METH_O,
3097 PyDoc_STR("datetime -> DST offset in minutes east of UTC.")},
3098
Tim Peters52dcce22003-01-23 16:36:11 +00003099 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
3100 PyDoc_STR("datetime in UTC -> datetime in local time.")},
3101
Guido van Rossum177e41a2003-01-30 22:06:23 +00003102 {"__reduce__", (PyCFunction)tzinfo_reduce, METH_NOARGS,
3103 PyDoc_STR("-> (cls, state)")},
3104
Tim Peters2a799bf2002-12-16 20:18:38 +00003105 {NULL, NULL}
3106};
3107
3108static char tzinfo_doc[] =
3109PyDoc_STR("Abstract base class for time zone info objects.");
3110
Neal Norwitz227b5332006-03-22 09:28:35 +00003111static PyTypeObject PyDateTime_TZInfoType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003112 PyVarObject_HEAD_INIT(NULL, 0)
Tim Peters2a799bf2002-12-16 20:18:38 +00003113 "datetime.tzinfo", /* tp_name */
3114 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
3115 0, /* tp_itemsize */
3116 0, /* tp_dealloc */
3117 0, /* tp_print */
3118 0, /* tp_getattr */
3119 0, /* tp_setattr */
Mark Dickinsone94c6792009-02-02 20:36:42 +00003120 0, /* tp_reserved */
Tim Peters2a799bf2002-12-16 20:18:38 +00003121 0, /* tp_repr */
3122 0, /* tp_as_number */
3123 0, /* tp_as_sequence */
3124 0, /* tp_as_mapping */
3125 0, /* tp_hash */
3126 0, /* tp_call */
3127 0, /* tp_str */
3128 PyObject_GenericGetAttr, /* tp_getattro */
3129 0, /* tp_setattro */
3130 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00003131 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters2a799bf2002-12-16 20:18:38 +00003132 tzinfo_doc, /* tp_doc */
3133 0, /* tp_traverse */
3134 0, /* tp_clear */
3135 0, /* tp_richcompare */
3136 0, /* tp_weaklistoffset */
3137 0, /* tp_iter */
3138 0, /* tp_iternext */
3139 tzinfo_methods, /* tp_methods */
3140 0, /* tp_members */
3141 0, /* tp_getset */
3142 0, /* tp_base */
3143 0, /* tp_dict */
3144 0, /* tp_descr_get */
3145 0, /* tp_descr_set */
3146 0, /* tp_dictoffset */
3147 0, /* tp_init */
3148 0, /* tp_alloc */
3149 PyType_GenericNew, /* tp_new */
3150 0, /* tp_free */
3151};
3152
3153/*
Tim Peters37f39822003-01-10 03:49:02 +00003154 * PyDateTime_Time implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003155 */
3156
Tim Peters37f39822003-01-10 03:49:02 +00003157/* Accessor properties.
Tim Peters2a799bf2002-12-16 20:18:38 +00003158 */
3159
3160static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003161time_hour(PyDateTime_Time *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003162{
Christian Heimes217cfd12007-12-02 14:31:20 +00003163 return PyLong_FromLong(TIME_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003164}
3165
Tim Peters37f39822003-01-10 03:49:02 +00003166static PyObject *
3167time_minute(PyDateTime_Time *self, void *unused)
3168{
Christian Heimes217cfd12007-12-02 14:31:20 +00003169 return PyLong_FromLong(TIME_GET_MINUTE(self));
Tim Peters37f39822003-01-10 03:49:02 +00003170}
3171
3172/* The name time_second conflicted with some platform header file. */
3173static PyObject *
3174py_time_second(PyDateTime_Time *self, void *unused)
3175{
Christian Heimes217cfd12007-12-02 14:31:20 +00003176 return PyLong_FromLong(TIME_GET_SECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003177}
3178
3179static PyObject *
3180time_microsecond(PyDateTime_Time *self, void *unused)
3181{
Christian Heimes217cfd12007-12-02 14:31:20 +00003182 return PyLong_FromLong(TIME_GET_MICROSECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003183}
3184
3185static PyObject *
3186time_tzinfo(PyDateTime_Time *self, void *unused)
3187{
Tim Petersa032d2e2003-01-11 00:15:54 +00003188 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters37f39822003-01-10 03:49:02 +00003189 Py_INCREF(result);
3190 return result;
3191}
3192
3193static PyGetSetDef time_getset[] = {
3194 {"hour", (getter)time_hour},
3195 {"minute", (getter)time_minute},
3196 {"second", (getter)py_time_second},
3197 {"microsecond", (getter)time_microsecond},
3198 {"tzinfo", (getter)time_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003199 {NULL}
3200};
3201
3202/*
3203 * Constructors.
3204 */
3205
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003206static char *time_kws[] = {"hour", "minute", "second", "microsecond",
Tim Peters37f39822003-01-10 03:49:02 +00003207 "tzinfo", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00003208
Tim Peters2a799bf2002-12-16 20:18:38 +00003209static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003210time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003211{
3212 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003213 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003214 int hour = 0;
3215 int minute = 0;
3216 int second = 0;
3217 int usecond = 0;
3218 PyObject *tzinfo = Py_None;
3219
Guido van Rossum177e41a2003-01-30 22:06:23 +00003220 /* Check for invocation from pickle with __getstate__ state */
3221 if (PyTuple_GET_SIZE(args) >= 1 &&
3222 PyTuple_GET_SIZE(args) <= 2 &&
Christian Heimes72b710a2008-05-26 13:28:38 +00003223 PyBytes_Check(state = PyTuple_GET_ITEM(args, 0)) &&
3224 PyBytes_GET_SIZE(state) == _PyDateTime_TIME_DATASIZE &&
3225 ((unsigned char) (PyBytes_AS_STRING(state)[0])) < 24)
Guido van Rossum177e41a2003-01-30 22:06:23 +00003226 {
Tim Peters70533e22003-02-01 04:40:04 +00003227 PyDateTime_Time *me;
3228 char aware;
3229
3230 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003231 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003232 if (check_tzinfo_subclass(tzinfo) < 0) {
3233 PyErr_SetString(PyExc_TypeError, "bad "
3234 "tzinfo state arg");
3235 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003236 }
3237 }
Tim Peters70533e22003-02-01 04:40:04 +00003238 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003239 me = (PyDateTime_Time *) (type->tp_alloc(type, aware));
Tim Peters70533e22003-02-01 04:40:04 +00003240 if (me != NULL) {
Christian Heimes72b710a2008-05-26 13:28:38 +00003241 char *pdata = PyBytes_AS_STRING(state);
Tim Peters70533e22003-02-01 04:40:04 +00003242
3243 memcpy(me->data, pdata, _PyDateTime_TIME_DATASIZE);
3244 me->hashcode = -1;
3245 me->hastzinfo = aware;
3246 if (aware) {
3247 Py_INCREF(tzinfo);
3248 me->tzinfo = tzinfo;
3249 }
3250 }
3251 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003252 }
3253
Tim Peters37f39822003-01-10 03:49:02 +00003254 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO", time_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003255 &hour, &minute, &second, &usecond,
3256 &tzinfo)) {
3257 if (check_time_args(hour, minute, second, usecond) < 0)
3258 return NULL;
3259 if (check_tzinfo_subclass(tzinfo) < 0)
3260 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003261 self = new_time_ex(hour, minute, second, usecond, tzinfo,
3262 type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003263 }
3264 return self;
3265}
3266
3267/*
3268 * Destructor.
3269 */
3270
3271static void
Tim Peters37f39822003-01-10 03:49:02 +00003272time_dealloc(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003273{
Tim Petersa032d2e2003-01-11 00:15:54 +00003274 if (HASTZINFO(self)) {
Tim Peters37f39822003-01-10 03:49:02 +00003275 Py_XDECREF(self->tzinfo);
Neal Norwitz8e914d92003-01-10 15:29:16 +00003276 }
Christian Heimes90aa7642007-12-19 02:45:37 +00003277 Py_TYPE(self)->tp_free((PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003278}
3279
3280/*
Tim Peters855fe882002-12-22 03:43:39 +00003281 * Indirect access to tzinfo methods.
Tim Peters2a799bf2002-12-16 20:18:38 +00003282 */
3283
Tim Peters2a799bf2002-12-16 20:18:38 +00003284/* These are all METH_NOARGS, so don't need to check the arglist. */
3285static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003286time_utcoffset(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003287 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003288 "utcoffset", Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003289}
3290
3291static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003292time_dst(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003293 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003294 "dst", Py_None);
Tim Peters855fe882002-12-22 03:43:39 +00003295}
3296
3297static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003298time_tzname(PyDateTime_Time *self, PyObject *unused) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003299 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
Tim Peters37f39822003-01-10 03:49:02 +00003300 Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00003301}
3302
3303/*
Tim Peters37f39822003-01-10 03:49:02 +00003304 * Various ways to turn a time into a string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003305 */
3306
3307static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003308time_repr(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003309{
Christian Heimes90aa7642007-12-19 02:45:37 +00003310 const char *type_name = Py_TYPE(self)->tp_name;
Tim Peters37f39822003-01-10 03:49:02 +00003311 int h = TIME_GET_HOUR(self);
3312 int m = TIME_GET_MINUTE(self);
3313 int s = TIME_GET_SECOND(self);
3314 int us = TIME_GET_MICROSECOND(self);
3315 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003316
Tim Peters37f39822003-01-10 03:49:02 +00003317 if (us)
Walter Dörwald7569dfe2007-05-19 21:49:49 +00003318 result = PyUnicode_FromFormat("%s(%d, %d, %d, %d)",
3319 type_name, h, m, s, us);
Tim Peters37f39822003-01-10 03:49:02 +00003320 else if (s)
Walter Dörwald7569dfe2007-05-19 21:49:49 +00003321 result = PyUnicode_FromFormat("%s(%d, %d, %d)",
3322 type_name, h, m, s);
Tim Peters37f39822003-01-10 03:49:02 +00003323 else
Walter Dörwald7569dfe2007-05-19 21:49:49 +00003324 result = PyUnicode_FromFormat("%s(%d, %d)", type_name, h, m);
Tim Petersa032d2e2003-01-11 00:15:54 +00003325 if (result != NULL && HASTZINFO(self))
Tim Peters37f39822003-01-10 03:49:02 +00003326 result = append_keyword_tzinfo(result, self->tzinfo);
3327 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003328}
3329
Tim Peters37f39822003-01-10 03:49:02 +00003330static PyObject *
3331time_str(PyDateTime_Time *self)
3332{
3333 return PyObject_CallMethod((PyObject *)self, "isoformat", "()");
3334}
Tim Peters2a799bf2002-12-16 20:18:38 +00003335
3336static PyObject *
Thomas Wouterscf297e42007-02-23 15:07:44 +00003337time_isoformat(PyDateTime_Time *self, PyObject *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003338{
3339 char buf[100];
Tim Peters37f39822003-01-10 03:49:02 +00003340 PyObject *result;
Walter Dörwaldbafa1372007-05-31 17:50:48 +00003341 int us = TIME_GET_MICROSECOND(self);;
Tim Peters2a799bf2002-12-16 20:18:38 +00003342
Walter Dörwaldbafa1372007-05-31 17:50:48 +00003343 if (us)
3344 result = PyUnicode_FromFormat("%02d:%02d:%02d.%06d",
3345 TIME_GET_HOUR(self),
3346 TIME_GET_MINUTE(self),
3347 TIME_GET_SECOND(self),
3348 us);
3349 else
3350 result = PyUnicode_FromFormat("%02d:%02d:%02d",
3351 TIME_GET_HOUR(self),
3352 TIME_GET_MINUTE(self),
3353 TIME_GET_SECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003354
Tim Petersa032d2e2003-01-11 00:15:54 +00003355 if (result == NULL || ! HASTZINFO(self) || self->tzinfo == Py_None)
Tim Peters2a799bf2002-12-16 20:18:38 +00003356 return result;
3357
3358 /* We need to append the UTC offset. */
3359 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
Tim Petersbad8ff02002-12-30 20:52:32 +00003360 Py_None) < 0) {
Tim Peters2a799bf2002-12-16 20:18:38 +00003361 Py_DECREF(result);
3362 return NULL;
3363 }
Walter Dörwaldbafa1372007-05-31 17:50:48 +00003364 PyUnicode_AppendAndDel(&result, PyUnicode_FromString(buf));
Tim Peters2a799bf2002-12-16 20:18:38 +00003365 return result;
3366}
3367
Tim Peters37f39822003-01-10 03:49:02 +00003368static PyObject *
3369time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
3370{
3371 PyObject *result;
Tim Peters37f39822003-01-10 03:49:02 +00003372 PyObject *tuple;
Georg Brandlf78e02b2008-06-10 17:40:04 +00003373 PyObject *format;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003374 static char *keywords[] = {"format", NULL};
Tim Peters37f39822003-01-10 03:49:02 +00003375
Guido van Rossum98297ee2007-11-06 21:34:58 +00003376 if (! PyArg_ParseTupleAndKeywords(args, kw, "U:strftime", keywords,
Guido van Rossumbce56a62007-05-10 18:04:33 +00003377 &format))
Tim Peters37f39822003-01-10 03:49:02 +00003378 return NULL;
3379
3380 /* Python's strftime does insane things with the year part of the
3381 * timetuple. The year is forced to (the otherwise nonsensical)
3382 * 1900 to worm around that.
3383 */
3384 tuple = Py_BuildValue("iiiiiiiii",
Brett Cannond1080a32004-03-02 04:38:10 +00003385 1900, 1, 1, /* year, month, day */
Tim Peters37f39822003-01-10 03:49:02 +00003386 TIME_GET_HOUR(self),
3387 TIME_GET_MINUTE(self),
3388 TIME_GET_SECOND(self),
Brett Cannond1080a32004-03-02 04:38:10 +00003389 0, 1, -1); /* weekday, daynum, dst */
Tim Peters37f39822003-01-10 03:49:02 +00003390 if (tuple == NULL)
3391 return NULL;
3392 assert(PyTuple_Size(tuple) == 9);
Georg Brandlf78e02b2008-06-10 17:40:04 +00003393 result = wrap_strftime((PyObject *)self, format, tuple,
3394 Py_None);
Tim Peters37f39822003-01-10 03:49:02 +00003395 Py_DECREF(tuple);
3396 return result;
3397}
Tim Peters2a799bf2002-12-16 20:18:38 +00003398
3399/*
3400 * Miscellaneous methods.
3401 */
3402
Tim Peters37f39822003-01-10 03:49:02 +00003403static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00003404time_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters37f39822003-01-10 03:49:02 +00003405{
3406 int diff;
3407 naivety n1, n2;
3408 int offset1, offset2;
3409
3410 if (! PyTime_Check(other)) {
Guido van Rossum19960592006-08-24 17:29:38 +00003411 Py_INCREF(Py_NotImplemented);
3412 return Py_NotImplemented;
Tim Peters37f39822003-01-10 03:49:02 +00003413 }
Guido van Rossum19960592006-08-24 17:29:38 +00003414 if (classify_two_utcoffsets(self, &offset1, &n1, Py_None,
3415 other, &offset2, &n2, Py_None) < 0)
Tim Peters37f39822003-01-10 03:49:02 +00003416 return NULL;
3417 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
3418 /* If they're both naive, or both aware and have the same offsets,
3419 * we get off cheap. Note that if they're both naive, offset1 ==
3420 * offset2 == 0 at this point.
3421 */
3422 if (n1 == n2 && offset1 == offset2) {
Guido van Rossum19960592006-08-24 17:29:38 +00003423 diff = memcmp(((PyDateTime_Time *)self)->data,
3424 ((PyDateTime_Time *)other)->data,
Tim Peters37f39822003-01-10 03:49:02 +00003425 _PyDateTime_TIME_DATASIZE);
3426 return diff_to_bool(diff, op);
3427 }
3428
3429 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
3430 assert(offset1 != offset2); /* else last "if" handled it */
3431 /* Convert everything except microseconds to seconds. These
3432 * can't overflow (no more than the # of seconds in 2 days).
3433 */
3434 offset1 = TIME_GET_HOUR(self) * 3600 +
3435 (TIME_GET_MINUTE(self) - offset1) * 60 +
3436 TIME_GET_SECOND(self);
3437 offset2 = TIME_GET_HOUR(other) * 3600 +
3438 (TIME_GET_MINUTE(other) - offset2) * 60 +
3439 TIME_GET_SECOND(other);
3440 diff = offset1 - offset2;
3441 if (diff == 0)
3442 diff = TIME_GET_MICROSECOND(self) -
3443 TIME_GET_MICROSECOND(other);
3444 return diff_to_bool(diff, op);
3445 }
3446
3447 assert(n1 != n2);
3448 PyErr_SetString(PyExc_TypeError,
3449 "can't compare offset-naive and "
3450 "offset-aware times");
3451 return NULL;
3452}
3453
3454static long
3455time_hash(PyDateTime_Time *self)
3456{
3457 if (self->hashcode == -1) {
3458 naivety n;
3459 int offset;
3460 PyObject *temp;
3461
3462 n = classify_utcoffset((PyObject *)self, Py_None, &offset);
3463 assert(n != OFFSET_UNKNOWN);
3464 if (n == OFFSET_ERROR)
3465 return -1;
3466
3467 /* Reduce this to a hash of another object. */
Guido van Rossumfd53fd62007-08-24 04:05:13 +00003468 if (offset == 0) {
3469 self->hashcode = generic_hash(
3470 (unsigned char *)self->data, _PyDateTime_TIME_DATASIZE);
3471 return self->hashcode;
3472 }
Tim Peters37f39822003-01-10 03:49:02 +00003473 else {
3474 int hour;
3475 int minute;
3476
3477 assert(n == OFFSET_AWARE);
Tim Petersa032d2e2003-01-11 00:15:54 +00003478 assert(HASTZINFO(self));
Tim Peters37f39822003-01-10 03:49:02 +00003479 hour = divmod(TIME_GET_HOUR(self) * 60 +
3480 TIME_GET_MINUTE(self) - offset,
3481 60,
3482 &minute);
3483 if (0 <= hour && hour < 24)
3484 temp = new_time(hour, minute,
3485 TIME_GET_SECOND(self),
3486 TIME_GET_MICROSECOND(self),
3487 Py_None);
3488 else
3489 temp = Py_BuildValue("iiii",
3490 hour, minute,
3491 TIME_GET_SECOND(self),
3492 TIME_GET_MICROSECOND(self));
3493 }
3494 if (temp != NULL) {
3495 self->hashcode = PyObject_Hash(temp);
3496 Py_DECREF(temp);
3497 }
3498 }
3499 return self->hashcode;
3500}
Tim Peters2a799bf2002-12-16 20:18:38 +00003501
Tim Peters12bf3392002-12-24 05:41:27 +00003502static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003503time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00003504{
3505 PyObject *clone;
3506 PyObject *tuple;
3507 int hh = TIME_GET_HOUR(self);
3508 int mm = TIME_GET_MINUTE(self);
3509 int ss = TIME_GET_SECOND(self);
3510 int us = TIME_GET_MICROSECOND(self);
Tim Petersa032d2e2003-01-11 00:15:54 +00003511 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00003512
3513 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO:replace",
Tim Peters37f39822003-01-10 03:49:02 +00003514 time_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00003515 &hh, &mm, &ss, &us, &tzinfo))
3516 return NULL;
3517 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
3518 if (tuple == NULL)
3519 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00003520 clone = time_new(Py_TYPE(self), tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00003521 Py_DECREF(tuple);
3522 return clone;
3523}
3524
Tim Peters2a799bf2002-12-16 20:18:38 +00003525static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00003526time_bool(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003527{
3528 int offset;
3529 int none;
3530
3531 if (TIME_GET_SECOND(self) || TIME_GET_MICROSECOND(self)) {
3532 /* Since utcoffset is in whole minutes, nothing can
3533 * alter the conclusion that this is nonzero.
3534 */
3535 return 1;
3536 }
3537 offset = 0;
Tim Petersa032d2e2003-01-11 00:15:54 +00003538 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Petersbad8ff02002-12-30 20:52:32 +00003539 offset = call_utcoffset(self->tzinfo, Py_None, &none);
Tim Peters2a799bf2002-12-16 20:18:38 +00003540 if (offset == -1 && PyErr_Occurred())
3541 return -1;
3542 }
3543 return (TIME_GET_MINUTE(self) - offset + TIME_GET_HOUR(self)*60) != 0;
3544}
3545
Tim Peters371935f2003-02-01 01:52:50 +00003546/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003547
Tim Peters33e0f382003-01-10 02:05:14 +00003548/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00003549 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
3550 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00003551 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00003552 */
3553static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003554time_getstate(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003555{
3556 PyObject *basestate;
3557 PyObject *result = NULL;
3558
Christian Heimes72b710a2008-05-26 13:28:38 +00003559 basestate = PyBytes_FromStringAndSize((char *)self->data,
Tim Peters33e0f382003-01-10 02:05:14 +00003560 _PyDateTime_TIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00003561 if (basestate != NULL) {
Tim Petersa032d2e2003-01-11 00:15:54 +00003562 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003563 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00003564 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003565 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00003566 Py_DECREF(basestate);
3567 }
3568 return result;
3569}
3570
3571static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00003572time_reduce(PyDateTime_Time *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00003573{
Christian Heimes90aa7642007-12-19 02:45:37 +00003574 return Py_BuildValue("(ON)", Py_TYPE(self), time_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003575}
3576
Tim Peters37f39822003-01-10 03:49:02 +00003577static PyMethodDef time_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003578
Thomas Wouterscf297e42007-02-23 15:07:44 +00003579 {"isoformat", (PyCFunction)time_isoformat, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003580 PyDoc_STR("Return string in ISO 8601 format, HH:MM:SS[.mmmmmm]"
3581 "[+HH:MM].")},
3582
Guido van Rossumd59da4b2007-05-22 18:11:13 +00003583 {"strftime", (PyCFunction)time_strftime, METH_VARARGS | METH_KEYWORDS,
Tim Peters37f39822003-01-10 03:49:02 +00003584 PyDoc_STR("format -> strftime() style string.")},
3585
Eric Smith8fd3eba2008-02-17 19:48:00 +00003586 {"__format__", (PyCFunction)date_format, METH_VARARGS,
Eric Smith1ba31142007-09-11 18:06:02 +00003587 PyDoc_STR("Formats self with strftime.")},
3588
Tim Peters37f39822003-01-10 03:49:02 +00003589 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003590 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
3591
Tim Peters37f39822003-01-10 03:49:02 +00003592 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003593 PyDoc_STR("Return self.tzinfo.tzname(self).")},
3594
Tim Peters37f39822003-01-10 03:49:02 +00003595 {"dst", (PyCFunction)time_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00003596 PyDoc_STR("Return self.tzinfo.dst(self).")},
3597
Guido van Rossumd59da4b2007-05-22 18:11:13 +00003598 {"replace", (PyCFunction)time_replace, METH_VARARGS | METH_KEYWORDS,
Tim Peters37f39822003-01-10 03:49:02 +00003599 PyDoc_STR("Return time with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00003600
Guido van Rossum177e41a2003-01-30 22:06:23 +00003601 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
3602 PyDoc_STR("__reduce__() -> (cls, state)")},
3603
Tim Peters2a799bf2002-12-16 20:18:38 +00003604 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003605};
3606
Tim Peters37f39822003-01-10 03:49:02 +00003607static char time_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00003608PyDoc_STR("time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object\n\
3609\n\
3610All arguments are optional. tzinfo may be None, or an instance of\n\
3611a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00003612
Tim Peters37f39822003-01-10 03:49:02 +00003613static PyNumberMethods time_as_number = {
Tim Peters2a799bf2002-12-16 20:18:38 +00003614 0, /* nb_add */
3615 0, /* nb_subtract */
3616 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00003617 0, /* nb_remainder */
3618 0, /* nb_divmod */
3619 0, /* nb_power */
3620 0, /* nb_negative */
3621 0, /* nb_positive */
3622 0, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +00003623 (inquiry)time_bool, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00003624};
3625
Neal Norwitz227b5332006-03-22 09:28:35 +00003626static PyTypeObject PyDateTime_TimeType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003627 PyVarObject_HEAD_INIT(NULL, 0)
Tim Peters0bf60bd2003-01-08 20:40:01 +00003628 "datetime.time", /* tp_name */
Tim Peters37f39822003-01-10 03:49:02 +00003629 sizeof(PyDateTime_Time), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00003630 0, /* tp_itemsize */
Tim Peters37f39822003-01-10 03:49:02 +00003631 (destructor)time_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003632 0, /* tp_print */
3633 0, /* tp_getattr */
3634 0, /* tp_setattr */
Mark Dickinsone94c6792009-02-02 20:36:42 +00003635 0, /* tp_reserved */
Tim Peters37f39822003-01-10 03:49:02 +00003636 (reprfunc)time_repr, /* tp_repr */
3637 &time_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00003638 0, /* tp_as_sequence */
3639 0, /* tp_as_mapping */
Tim Peters37f39822003-01-10 03:49:02 +00003640 (hashfunc)time_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00003641 0, /* tp_call */
Tim Peters37f39822003-01-10 03:49:02 +00003642 (reprfunc)time_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00003643 PyObject_GenericGetAttr, /* tp_getattro */
3644 0, /* tp_setattro */
3645 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00003646 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters37f39822003-01-10 03:49:02 +00003647 time_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00003648 0, /* tp_traverse */
3649 0, /* tp_clear */
Guido van Rossum19960592006-08-24 17:29:38 +00003650 time_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00003651 0, /* tp_weaklistoffset */
3652 0, /* tp_iter */
3653 0, /* tp_iternext */
Tim Peters37f39822003-01-10 03:49:02 +00003654 time_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00003655 0, /* tp_members */
Tim Peters37f39822003-01-10 03:49:02 +00003656 time_getset, /* tp_getset */
3657 0, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00003658 0, /* tp_dict */
3659 0, /* tp_descr_get */
3660 0, /* tp_descr_set */
3661 0, /* tp_dictoffset */
3662 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00003663 time_alloc, /* tp_alloc */
Tim Peters37f39822003-01-10 03:49:02 +00003664 time_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00003665 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00003666};
3667
3668/*
Tim Petersa9bc1682003-01-11 03:39:11 +00003669 * PyDateTime_DateTime implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003670 */
3671
Tim Petersa9bc1682003-01-11 03:39:11 +00003672/* Accessor properties. Properties for day, month, and year are inherited
3673 * from date.
Tim Peters2a799bf2002-12-16 20:18:38 +00003674 */
3675
3676static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003677datetime_hour(PyDateTime_DateTime *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003678{
Christian Heimes217cfd12007-12-02 14:31:20 +00003679 return PyLong_FromLong(DATE_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003680}
3681
Tim Petersa9bc1682003-01-11 03:39:11 +00003682static PyObject *
3683datetime_minute(PyDateTime_DateTime *self, void *unused)
3684{
Christian Heimes217cfd12007-12-02 14:31:20 +00003685 return PyLong_FromLong(DATE_GET_MINUTE(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00003686}
3687
3688static PyObject *
3689datetime_second(PyDateTime_DateTime *self, void *unused)
3690{
Christian Heimes217cfd12007-12-02 14:31:20 +00003691 return PyLong_FromLong(DATE_GET_SECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00003692}
3693
3694static PyObject *
3695datetime_microsecond(PyDateTime_DateTime *self, void *unused)
3696{
Christian Heimes217cfd12007-12-02 14:31:20 +00003697 return PyLong_FromLong(DATE_GET_MICROSECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00003698}
3699
3700static PyObject *
3701datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
3702{
3703 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3704 Py_INCREF(result);
3705 return result;
3706}
3707
3708static PyGetSetDef datetime_getset[] = {
3709 {"hour", (getter)datetime_hour},
3710 {"minute", (getter)datetime_minute},
3711 {"second", (getter)datetime_second},
3712 {"microsecond", (getter)datetime_microsecond},
3713 {"tzinfo", (getter)datetime_tzinfo},
Tim Peters2a799bf2002-12-16 20:18:38 +00003714 {NULL}
3715};
3716
3717/*
3718 * Constructors.
Tim Peters2a799bf2002-12-16 20:18:38 +00003719 */
3720
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003721static char *datetime_kws[] = {
Tim Peters12bf3392002-12-24 05:41:27 +00003722 "year", "month", "day", "hour", "minute", "second",
3723 "microsecond", "tzinfo", NULL
3724};
3725
Tim Peters2a799bf2002-12-16 20:18:38 +00003726static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003727datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003728{
3729 PyObject *self = NULL;
Tim Peters70533e22003-02-01 04:40:04 +00003730 PyObject *state;
Tim Peters2a799bf2002-12-16 20:18:38 +00003731 int year;
3732 int month;
3733 int day;
3734 int hour = 0;
3735 int minute = 0;
3736 int second = 0;
3737 int usecond = 0;
3738 PyObject *tzinfo = Py_None;
3739
Guido van Rossum177e41a2003-01-30 22:06:23 +00003740 /* Check for invocation from pickle with __getstate__ state */
3741 if (PyTuple_GET_SIZE(args) >= 1 &&
3742 PyTuple_GET_SIZE(args) <= 2 &&
Christian Heimes72b710a2008-05-26 13:28:38 +00003743 PyBytes_Check(state = PyTuple_GET_ITEM(args, 0)) &&
3744 PyBytes_GET_SIZE(state) == _PyDateTime_DATETIME_DATASIZE &&
3745 MONTH_IS_SANE(PyBytes_AS_STRING(state)[2]))
Guido van Rossum177e41a2003-01-30 22:06:23 +00003746 {
Tim Peters70533e22003-02-01 04:40:04 +00003747 PyDateTime_DateTime *me;
3748 char aware;
3749
3750 if (PyTuple_GET_SIZE(args) == 2) {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003751 tzinfo = PyTuple_GET_ITEM(args, 1);
Tim Peters70533e22003-02-01 04:40:04 +00003752 if (check_tzinfo_subclass(tzinfo) < 0) {
3753 PyErr_SetString(PyExc_TypeError, "bad "
3754 "tzinfo state arg");
3755 return NULL;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003756 }
3757 }
Tim Peters70533e22003-02-01 04:40:04 +00003758 aware = (char)(tzinfo != Py_None);
Tim Peters604c0132004-06-07 23:04:33 +00003759 me = (PyDateTime_DateTime *) (type->tp_alloc(type , aware));
Tim Peters70533e22003-02-01 04:40:04 +00003760 if (me != NULL) {
Christian Heimes72b710a2008-05-26 13:28:38 +00003761 char *pdata = PyBytes_AS_STRING(state);
Tim Peters70533e22003-02-01 04:40:04 +00003762
3763 memcpy(me->data, pdata, _PyDateTime_DATETIME_DATASIZE);
3764 me->hashcode = -1;
3765 me->hastzinfo = aware;
3766 if (aware) {
3767 Py_INCREF(tzinfo);
3768 me->tzinfo = tzinfo;
3769 }
3770 }
3771 return (PyObject *)me;
Guido van Rossum177e41a2003-01-30 22:06:23 +00003772 }
3773
Tim Petersa9bc1682003-01-11 03:39:11 +00003774 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO", datetime_kws,
Tim Peters2a799bf2002-12-16 20:18:38 +00003775 &year, &month, &day, &hour, &minute,
3776 &second, &usecond, &tzinfo)) {
3777 if (check_date_args(year, month, day) < 0)
3778 return NULL;
3779 if (check_time_args(hour, minute, second, usecond) < 0)
3780 return NULL;
3781 if (check_tzinfo_subclass(tzinfo) < 0)
3782 return NULL;
Tim Petersa98924a2003-05-17 05:55:19 +00003783 self = new_datetime_ex(year, month, day,
3784 hour, minute, second, usecond,
3785 tzinfo, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00003786 }
3787 return self;
3788}
3789
Tim Petersa9bc1682003-01-11 03:39:11 +00003790/* TM_FUNC is the shared type of localtime() and gmtime(). */
3791typedef struct tm *(*TM_FUNC)(const time_t *timer);
3792
3793/* Internal helper.
3794 * Build datetime from a time_t and a distinct count of microseconds.
3795 * Pass localtime or gmtime for f, to control the interpretation of timet.
3796 */
3797static PyObject *
3798datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
3799 PyObject *tzinfo)
3800{
3801 struct tm *tm;
3802 PyObject *result = NULL;
3803
3804 tm = f(&timet);
3805 if (tm) {
3806 /* The platform localtime/gmtime may insert leap seconds,
3807 * indicated by tm->tm_sec > 59. We don't care about them,
3808 * except to the extent that passing them on to the datetime
3809 * constructor would raise ValueError for a reason that
3810 * made no sense to the user.
3811 */
3812 if (tm->tm_sec > 59)
3813 tm->tm_sec = 59;
3814 result = PyObject_CallFunction(cls, "iiiiiiiO",
3815 tm->tm_year + 1900,
3816 tm->tm_mon + 1,
3817 tm->tm_mday,
3818 tm->tm_hour,
3819 tm->tm_min,
3820 tm->tm_sec,
3821 us,
3822 tzinfo);
3823 }
3824 else
3825 PyErr_SetString(PyExc_ValueError,
3826 "timestamp out of range for "
3827 "platform localtime()/gmtime() function");
3828 return result;
3829}
3830
3831/* Internal helper.
3832 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
3833 * to control the interpretation of the timestamp. Since a double doesn't
3834 * have enough bits to cover a datetime's full range of precision, it's
3835 * better to call datetime_from_timet_and_us provided you have a way
3836 * to get that much precision (e.g., C time() isn't good enough).
3837 */
3838static PyObject *
3839datetime_from_timestamp(PyObject *cls, TM_FUNC f, double timestamp,
3840 PyObject *tzinfo)
3841{
Tim Peters1b6f7a92004-06-20 02:50:16 +00003842 time_t timet;
3843 double fraction;
3844 int us;
Tim Petersa9bc1682003-01-11 03:39:11 +00003845
Tim Peters1b6f7a92004-06-20 02:50:16 +00003846 timet = _PyTime_DoubleToTimet(timestamp);
3847 if (timet == (time_t)-1 && PyErr_Occurred())
3848 return NULL;
3849 fraction = timestamp - (double)timet;
3850 us = (int)round_to_long(fraction * 1e6);
Guido van Rossumd8faa362007-04-27 19:54:29 +00003851 if (us < 0) {
3852 /* Truncation towards zero is not what we wanted
3853 for negative numbers (Python's mod semantics) */
3854 timet -= 1;
3855 us += 1000000;
3856 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00003857 /* If timestamp is less than one microsecond smaller than a
3858 * full second, round up. Otherwise, ValueErrors are raised
3859 * for some floats. */
3860 if (us == 1000000) {
3861 timet += 1;
3862 us = 0;
3863 }
Tim Petersa9bc1682003-01-11 03:39:11 +00003864 return datetime_from_timet_and_us(cls, f, timet, us, tzinfo);
3865}
3866
3867/* Internal helper.
3868 * Build most accurate possible datetime for current time. Pass localtime or
3869 * gmtime for f as appropriate.
3870 */
3871static PyObject *
3872datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
3873{
3874#ifdef HAVE_GETTIMEOFDAY
3875 struct timeval t;
3876
3877#ifdef GETTIMEOFDAY_NO_TZ
3878 gettimeofday(&t);
3879#else
3880 gettimeofday(&t, (struct timezone *)NULL);
3881#endif
3882 return datetime_from_timet_and_us(cls, f, t.tv_sec, (int)t.tv_usec,
3883 tzinfo);
3884
3885#else /* ! HAVE_GETTIMEOFDAY */
3886 /* No flavor of gettimeofday exists on this platform. Python's
3887 * time.time() does a lot of other platform tricks to get the
3888 * best time it can on the platform, and we're not going to do
3889 * better than that (if we could, the better code would belong
3890 * in time.time()!) We're limited by the precision of a double,
3891 * though.
3892 */
3893 PyObject *time;
3894 double dtime;
3895
3896 time = time_time();
3897 if (time == NULL)
3898 return NULL;
3899 dtime = PyFloat_AsDouble(time);
3900 Py_DECREF(time);
3901 if (dtime == -1.0 && PyErr_Occurred())
3902 return NULL;
3903 return datetime_from_timestamp(cls, f, dtime, tzinfo);
3904#endif /* ! HAVE_GETTIMEOFDAY */
3905}
3906
Tim Peters2a799bf2002-12-16 20:18:38 +00003907/* Return best possible local time -- this isn't constrained by the
3908 * precision of a timestamp.
3909 */
3910static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003911datetime_now(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003912{
Tim Peters10cadce2003-01-23 19:58:02 +00003913 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003914 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003915 static char *keywords[] = {"tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003916
Tim Peters10cadce2003-01-23 19:58:02 +00003917 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:now", keywords,
3918 &tzinfo))
3919 return NULL;
3920 if (check_tzinfo_subclass(tzinfo) < 0)
3921 return NULL;
3922
3923 self = datetime_best_possible(cls,
3924 tzinfo == Py_None ? localtime : gmtime,
3925 tzinfo);
3926 if (self != NULL && tzinfo != Py_None) {
3927 /* Convert UTC to tzinfo's zone. */
3928 PyObject *temp = self;
Tim Peters2a44a8d2003-01-23 20:53:10 +00003929 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
Tim Peters10cadce2003-01-23 19:58:02 +00003930 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003931 }
3932 return self;
3933}
3934
Tim Petersa9bc1682003-01-11 03:39:11 +00003935/* Return best possible UTC time -- this isn't constrained by the
3936 * precision of a timestamp.
3937 */
3938static PyObject *
3939datetime_utcnow(PyObject *cls, PyObject *dummy)
3940{
3941 return datetime_best_possible(cls, gmtime, Py_None);
3942}
3943
Tim Peters2a799bf2002-12-16 20:18:38 +00003944/* Return new local datetime from timestamp (Python timestamp -- a double). */
3945static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00003946datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00003947{
Tim Peters2a44a8d2003-01-23 20:53:10 +00003948 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00003949 double timestamp;
3950 PyObject *tzinfo = Py_None;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00003951 static char *keywords[] = {"timestamp", "tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003952
Tim Peters2a44a8d2003-01-23 20:53:10 +00003953 if (! PyArg_ParseTupleAndKeywords(args, kw, "d|O:fromtimestamp",
3954 keywords, &timestamp, &tzinfo))
3955 return NULL;
3956 if (check_tzinfo_subclass(tzinfo) < 0)
3957 return NULL;
3958
3959 self = datetime_from_timestamp(cls,
3960 tzinfo == Py_None ? localtime : gmtime,
3961 timestamp,
3962 tzinfo);
3963 if (self != NULL && tzinfo != Py_None) {
3964 /* Convert UTC to tzinfo's zone. */
3965 PyObject *temp = self;
3966 self = PyObject_CallMethod(tzinfo, "fromutc", "O", self);
3967 Py_DECREF(temp);
Tim Peters2a799bf2002-12-16 20:18:38 +00003968 }
3969 return self;
3970}
3971
Tim Petersa9bc1682003-01-11 03:39:11 +00003972/* Return new UTC datetime from timestamp (Python timestamp -- a double). */
3973static PyObject *
3974datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
3975{
3976 double timestamp;
3977 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003978
Tim Petersa9bc1682003-01-11 03:39:11 +00003979 if (PyArg_ParseTuple(args, "d:utcfromtimestamp", &timestamp))
3980 result = datetime_from_timestamp(cls, gmtime, timestamp,
3981 Py_None);
3982 return result;
3983}
3984
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003985/* Return new datetime from time.strptime(). */
3986static PyObject *
3987datetime_strptime(PyObject *cls, PyObject *args)
3988{
Christian Heimesdd15f6c2008-03-16 00:07:10 +00003989 static PyObject *module = NULL;
3990 PyObject *result = NULL, *obj, *st = NULL, *frac = NULL;
Guido van Rossume8a17aa2007-08-29 17:28:42 +00003991 const Py_UNICODE *string, *format;
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003992
Guido van Rossumfd53fd62007-08-24 04:05:13 +00003993 if (!PyArg_ParseTuple(args, "uu:strptime", &string, &format))
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003994 return NULL;
3995
Christian Heimesdd15f6c2008-03-16 00:07:10 +00003996 if (module == NULL &&
3997 (module = PyImport_ImportModuleNoBlock("_strptime")) == NULL)
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003998 return NULL;
Skip Montanaro0af3ade2005-01-13 04:12:31 +00003999
Christian Heimesdd15f6c2008-03-16 00:07:10 +00004000 /* _strptime._strptime returns a two-element tuple. The first
4001 element is a time.struct_time object. The second is the
4002 microseconds (which are not defined for time.struct_time). */
Mark Dickinsonfc689dd2008-03-16 03:45:34 +00004003 obj = PyObject_CallMethod(module, "_strptime", "uu", string, format);
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004004 if (obj != NULL) {
Christian Heimesdd15f6c2008-03-16 00:07:10 +00004005 int i, good_timetuple = 1;
4006 long int ia[7];
4007 if (PySequence_Check(obj) && PySequence_Size(obj) == 2) {
4008 st = PySequence_GetItem(obj, 0);
4009 frac = PySequence_GetItem(obj, 1);
4010 if (st == NULL || frac == NULL)
4011 good_timetuple = 0;
4012 /* copy y/m/d/h/m/s values out of the
4013 time.struct_time */
4014 if (good_timetuple &&
4015 PySequence_Check(st) &&
4016 PySequence_Size(st) >= 6) {
4017 for (i=0; i < 6; i++) {
4018 PyObject *p = PySequence_GetItem(st, i);
4019 if (p == NULL) {
4020 good_timetuple = 0;
4021 break;
4022 }
4023 if (PyLong_Check(p))
4024 ia[i] = PyLong_AsLong(p);
4025 else
4026 good_timetuple = 0;
4027 Py_DECREF(p);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004028 }
Christian Heimesdd15f6c2008-03-16 00:07:10 +00004029/* if (PyLong_CheckExact(p)) {
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +00004030 ia[i] = PyLong_AsLongAndOverflow(p, &overflow);
4031 if (overflow)
4032 good_timetuple = 0;
4033 }
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004034 else
4035 good_timetuple = 0;
4036 Py_DECREF(p);
Christian Heimesdd15f6c2008-03-16 00:07:10 +00004037*/ }
4038 else
4039 good_timetuple = 0;
4040 /* follow that up with a little dose of microseconds */
4041 if (PyLong_Check(frac))
4042 ia[6] = PyLong_AsLong(frac);
4043 else
4044 good_timetuple = 0;
4045 }
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004046 else
4047 good_timetuple = 0;
4048 if (good_timetuple)
Christian Heimesdd15f6c2008-03-16 00:07:10 +00004049 result = PyObject_CallFunction(cls, "iiiiiii",
4050 ia[0], ia[1], ia[2],
4051 ia[3], ia[4], ia[5],
4052 ia[6]);
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004053 else
4054 PyErr_SetString(PyExc_ValueError,
Christian Heimesdd15f6c2008-03-16 00:07:10 +00004055 "unexpected value from _strptime._strptime");
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004056 }
Christian Heimesdd15f6c2008-03-16 00:07:10 +00004057 Py_XDECREF(obj);
4058 Py_XDECREF(st);
4059 Py_XDECREF(frac);
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004060 return result;
4061}
4062
Tim Petersa9bc1682003-01-11 03:39:11 +00004063/* Return new datetime from date/datetime and time arguments. */
4064static PyObject *
4065datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
4066{
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004067 static char *keywords[] = {"date", "time", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00004068 PyObject *date;
4069 PyObject *time;
4070 PyObject *result = NULL;
4071
4072 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!:combine", keywords,
4073 &PyDateTime_DateType, &date,
4074 &PyDateTime_TimeType, &time)) {
4075 PyObject *tzinfo = Py_None;
4076
4077 if (HASTZINFO(time))
4078 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
4079 result = PyObject_CallFunction(cls, "iiiiiiiO",
4080 GET_YEAR(date),
4081 GET_MONTH(date),
4082 GET_DAY(date),
4083 TIME_GET_HOUR(time),
4084 TIME_GET_MINUTE(time),
4085 TIME_GET_SECOND(time),
4086 TIME_GET_MICROSECOND(time),
4087 tzinfo);
4088 }
4089 return result;
4090}
Tim Peters2a799bf2002-12-16 20:18:38 +00004091
4092/*
4093 * Destructor.
4094 */
4095
4096static void
Tim Petersa9bc1682003-01-11 03:39:11 +00004097datetime_dealloc(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004098{
Tim Petersa9bc1682003-01-11 03:39:11 +00004099 if (HASTZINFO(self)) {
4100 Py_XDECREF(self->tzinfo);
4101 }
Christian Heimes90aa7642007-12-19 02:45:37 +00004102 Py_TYPE(self)->tp_free((PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00004103}
4104
4105/*
4106 * Indirect access to tzinfo methods.
4107 */
4108
Tim Peters2a799bf2002-12-16 20:18:38 +00004109/* These are all METH_NOARGS, so don't need to check the arglist. */
4110static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004111datetime_utcoffset(PyDateTime_DateTime *self, PyObject *unused) {
4112 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
4113 "utcoffset", (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00004114}
4115
4116static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004117datetime_dst(PyDateTime_DateTime *self, PyObject *unused) {
4118 return offset_as_timedelta(HASTZINFO(self) ? self->tzinfo : Py_None,
4119 "dst", (PyObject *)self);
Tim Peters855fe882002-12-22 03:43:39 +00004120}
4121
4122static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004123datetime_tzname(PyDateTime_DateTime *self, PyObject *unused) {
4124 return call_tzname(HASTZINFO(self) ? self->tzinfo : Py_None,
4125 (PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00004126}
4127
4128/*
Tim Petersa9bc1682003-01-11 03:39:11 +00004129 * datetime arithmetic.
Tim Peters2a799bf2002-12-16 20:18:38 +00004130 */
4131
Tim Petersa9bc1682003-01-11 03:39:11 +00004132/* factor must be 1 (to add) or -1 (to subtract). The result inherits
4133 * the tzinfo state of date.
Tim Peters2a799bf2002-12-16 20:18:38 +00004134 */
4135static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004136add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
4137 int factor)
Tim Peters2a799bf2002-12-16 20:18:38 +00004138{
Tim Petersa9bc1682003-01-11 03:39:11 +00004139 /* Note that the C-level additions can't overflow, because of
4140 * invariant bounds on the member values.
4141 */
4142 int year = GET_YEAR(date);
4143 int month = GET_MONTH(date);
4144 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
4145 int hour = DATE_GET_HOUR(date);
4146 int minute = DATE_GET_MINUTE(date);
4147 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
4148 int microsecond = DATE_GET_MICROSECOND(date) +
4149 GET_TD_MICROSECONDS(delta) * factor;
Tim Peters2a799bf2002-12-16 20:18:38 +00004150
Tim Petersa9bc1682003-01-11 03:39:11 +00004151 assert(factor == 1 || factor == -1);
4152 if (normalize_datetime(&year, &month, &day,
4153 &hour, &minute, &second, &microsecond) < 0)
4154 return NULL;
4155 else
4156 return new_datetime(year, month, day,
4157 hour, minute, second, microsecond,
4158 HASTZINFO(date) ? date->tzinfo : Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004159}
4160
4161static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004162datetime_add(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00004163{
Tim Petersa9bc1682003-01-11 03:39:11 +00004164 if (PyDateTime_Check(left)) {
4165 /* datetime + ??? */
4166 if (PyDelta_Check(right))
4167 /* datetime + delta */
4168 return add_datetime_timedelta(
4169 (PyDateTime_DateTime *)left,
4170 (PyDateTime_Delta *)right,
4171 1);
4172 }
4173 else if (PyDelta_Check(left)) {
4174 /* delta + datetime */
4175 return add_datetime_timedelta((PyDateTime_DateTime *) right,
4176 (PyDateTime_Delta *) left,
4177 1);
4178 }
4179 Py_INCREF(Py_NotImplemented);
4180 return Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00004181}
4182
4183static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004184datetime_subtract(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00004185{
4186 PyObject *result = Py_NotImplemented;
4187
4188 if (PyDateTime_Check(left)) {
4189 /* datetime - ??? */
4190 if (PyDateTime_Check(right)) {
4191 /* datetime - datetime */
4192 naivety n1, n2;
4193 int offset1, offset2;
Tim Petersa9bc1682003-01-11 03:39:11 +00004194 int delta_d, delta_s, delta_us;
Tim Peters2a799bf2002-12-16 20:18:38 +00004195
Tim Peterse39a80c2002-12-30 21:28:52 +00004196 if (classify_two_utcoffsets(left, &offset1, &n1, left,
4197 right, &offset2, &n2,
4198 right) < 0)
Tim Peters00237032002-12-27 02:21:51 +00004199 return NULL;
Tim Peters8702d5f2002-12-27 02:26:16 +00004200 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
Tim Peters2a799bf2002-12-16 20:18:38 +00004201 if (n1 != n2) {
4202 PyErr_SetString(PyExc_TypeError,
4203 "can't subtract offset-naive and "
4204 "offset-aware datetimes");
4205 return NULL;
4206 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004207 delta_d = ymd_to_ord(GET_YEAR(left),
4208 GET_MONTH(left),
4209 GET_DAY(left)) -
4210 ymd_to_ord(GET_YEAR(right),
4211 GET_MONTH(right),
4212 GET_DAY(right));
4213 /* These can't overflow, since the values are
4214 * normalized. At most this gives the number of
4215 * seconds in one day.
4216 */
4217 delta_s = (DATE_GET_HOUR(left) -
4218 DATE_GET_HOUR(right)) * 3600 +
4219 (DATE_GET_MINUTE(left) -
4220 DATE_GET_MINUTE(right)) * 60 +
4221 (DATE_GET_SECOND(left) -
4222 DATE_GET_SECOND(right));
4223 delta_us = DATE_GET_MICROSECOND(left) -
4224 DATE_GET_MICROSECOND(right);
Tim Peters2a799bf2002-12-16 20:18:38 +00004225 /* (left - offset1) - (right - offset2) =
4226 * (left - right) + (offset2 - offset1)
4227 */
Tim Petersa9bc1682003-01-11 03:39:11 +00004228 delta_s += (offset2 - offset1) * 60;
4229 result = new_delta(delta_d, delta_s, delta_us, 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00004230 }
4231 else if (PyDelta_Check(right)) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004232 /* datetime - delta */
4233 result = add_datetime_timedelta(
Tim Peters2a799bf2002-12-16 20:18:38 +00004234 (PyDateTime_DateTime *)left,
Tim Petersa9bc1682003-01-11 03:39:11 +00004235 (PyDateTime_Delta *)right,
4236 -1);
Tim Peters2a799bf2002-12-16 20:18:38 +00004237 }
4238 }
4239
4240 if (result == Py_NotImplemented)
4241 Py_INCREF(result);
4242 return result;
4243}
4244
4245/* Various ways to turn a datetime into a string. */
4246
4247static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004248datetime_repr(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004249{
Christian Heimes90aa7642007-12-19 02:45:37 +00004250 const char *type_name = Py_TYPE(self)->tp_name;
Tim Petersa9bc1682003-01-11 03:39:11 +00004251 PyObject *baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004252
Tim Petersa9bc1682003-01-11 03:39:11 +00004253 if (DATE_GET_MICROSECOND(self)) {
Walter Dörwald7569dfe2007-05-19 21:49:49 +00004254 baserepr = PyUnicode_FromFormat(
Tim Petersa9bc1682003-01-11 03:39:11 +00004255 "%s(%d, %d, %d, %d, %d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004256 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004257 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4258 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4259 DATE_GET_SECOND(self),
4260 DATE_GET_MICROSECOND(self));
4261 }
4262 else if (DATE_GET_SECOND(self)) {
Walter Dörwald7569dfe2007-05-19 21:49:49 +00004263 baserepr = PyUnicode_FromFormat(
Tim Petersa9bc1682003-01-11 03:39:11 +00004264 "%s(%d, %d, %d, %d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004265 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004266 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4267 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4268 DATE_GET_SECOND(self));
4269 }
4270 else {
Walter Dörwald7569dfe2007-05-19 21:49:49 +00004271 baserepr = PyUnicode_FromFormat(
Tim Petersa9bc1682003-01-11 03:39:11 +00004272 "%s(%d, %d, %d, %d, %d)",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004273 type_name,
Tim Petersa9bc1682003-01-11 03:39:11 +00004274 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
4275 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
4276 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004277 if (baserepr == NULL || ! HASTZINFO(self))
4278 return baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00004279 return append_keyword_tzinfo(baserepr, self->tzinfo);
4280}
4281
Tim Petersa9bc1682003-01-11 03:39:11 +00004282static PyObject *
4283datetime_str(PyDateTime_DateTime *self)
4284{
4285 return PyObject_CallMethod((PyObject *)self, "isoformat", "(s)", " ");
4286}
Tim Peters2a799bf2002-12-16 20:18:38 +00004287
4288static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004289datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004290{
Walter Dörwaldbc1f8862007-06-20 11:02:38 +00004291 int sep = 'T';
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004292 static char *keywords[] = {"sep", NULL};
Tim Petersa9bc1682003-01-11 03:39:11 +00004293 char buffer[100];
Tim Petersa9bc1682003-01-11 03:39:11 +00004294 PyObject *result;
Walter Dörwaldbafa1372007-05-31 17:50:48 +00004295 int us = DATE_GET_MICROSECOND(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00004296
Walter Dörwaldd0941302007-07-01 21:58:22 +00004297 if (!PyArg_ParseTupleAndKeywords(args, kw, "|C:isoformat", keywords, &sep))
Tim Petersa9bc1682003-01-11 03:39:11 +00004298 return NULL;
Walter Dörwaldbafa1372007-05-31 17:50:48 +00004299 if (us)
4300 result = PyUnicode_FromFormat("%04d-%02d-%02d%c%02d:%02d:%02d.%06d",
4301 GET_YEAR(self), GET_MONTH(self),
4302 GET_DAY(self), (int)sep,
4303 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4304 DATE_GET_SECOND(self), us);
4305 else
4306 result = PyUnicode_FromFormat("%04d-%02d-%02d%c%02d:%02d:%02d",
4307 GET_YEAR(self), GET_MONTH(self),
4308 GET_DAY(self), (int)sep,
4309 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
4310 DATE_GET_SECOND(self));
4311
4312 if (!result || !HASTZINFO(self))
Tim Peters2a799bf2002-12-16 20:18:38 +00004313 return result;
4314
4315 /* We need to append the UTC offset. */
Tim Petersa9bc1682003-01-11 03:39:11 +00004316 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
Tim Peters2a799bf2002-12-16 20:18:38 +00004317 (PyObject *)self) < 0) {
4318 Py_DECREF(result);
4319 return NULL;
4320 }
Walter Dörwaldbafa1372007-05-31 17:50:48 +00004321 PyUnicode_AppendAndDel(&result, PyUnicode_FromString(buffer));
Tim Peters2a799bf2002-12-16 20:18:38 +00004322 return result;
4323}
4324
Tim Petersa9bc1682003-01-11 03:39:11 +00004325static PyObject *
4326datetime_ctime(PyDateTime_DateTime *self)
4327{
4328 return format_ctime((PyDateTime_Date *)self,
4329 DATE_GET_HOUR(self),
4330 DATE_GET_MINUTE(self),
4331 DATE_GET_SECOND(self));
4332}
4333
Tim Peters2a799bf2002-12-16 20:18:38 +00004334/* Miscellaneous methods. */
4335
Tim Petersa9bc1682003-01-11 03:39:11 +00004336static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00004337datetime_richcompare(PyObject *self, PyObject *other, int op)
Tim Petersa9bc1682003-01-11 03:39:11 +00004338{
4339 int diff;
4340 naivety n1, n2;
4341 int offset1, offset2;
4342
4343 if (! PyDateTime_Check(other)) {
Guido van Rossum19960592006-08-24 17:29:38 +00004344 if (PyDate_Check(other)) {
4345 /* Prevent invocation of date_richcompare. We want to
4346 return NotImplemented here to give the other object
4347 a chance. But since DateTime is a subclass of
4348 Date, if the other object is a Date, it would
4349 compute an ordering based on the date part alone,
4350 and we don't want that. So force unequal or
4351 uncomparable here in that case. */
4352 if (op == Py_EQ)
4353 Py_RETURN_FALSE;
4354 if (op == Py_NE)
4355 Py_RETURN_TRUE;
4356 return cmperror(self, other);
Tim Peters8d81a012003-01-24 22:36:34 +00004357 }
Guido van Rossum19960592006-08-24 17:29:38 +00004358 Py_INCREF(Py_NotImplemented);
4359 return Py_NotImplemented;
Tim Petersa9bc1682003-01-11 03:39:11 +00004360 }
4361
Guido van Rossum19960592006-08-24 17:29:38 +00004362 if (classify_two_utcoffsets(self, &offset1, &n1, self,
4363 other, &offset2, &n2, other) < 0)
Tim Petersa9bc1682003-01-11 03:39:11 +00004364 return NULL;
4365 assert(n1 != OFFSET_UNKNOWN && n2 != OFFSET_UNKNOWN);
4366 /* If they're both naive, or both aware and have the same offsets,
4367 * we get off cheap. Note that if they're both naive, offset1 ==
4368 * offset2 == 0 at this point.
4369 */
4370 if (n1 == n2 && offset1 == offset2) {
Guido van Rossum19960592006-08-24 17:29:38 +00004371 diff = memcmp(((PyDateTime_DateTime *)self)->data,
4372 ((PyDateTime_DateTime *)other)->data,
Tim Petersa9bc1682003-01-11 03:39:11 +00004373 _PyDateTime_DATETIME_DATASIZE);
4374 return diff_to_bool(diff, op);
4375 }
4376
4377 if (n1 == OFFSET_AWARE && n2 == OFFSET_AWARE) {
4378 PyDateTime_Delta *delta;
4379
4380 assert(offset1 != offset2); /* else last "if" handled it */
4381 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
4382 other);
4383 if (delta == NULL)
4384 return NULL;
4385 diff = GET_TD_DAYS(delta);
4386 if (diff == 0)
4387 diff = GET_TD_SECONDS(delta) |
4388 GET_TD_MICROSECONDS(delta);
4389 Py_DECREF(delta);
4390 return diff_to_bool(diff, op);
4391 }
4392
4393 assert(n1 != n2);
4394 PyErr_SetString(PyExc_TypeError,
4395 "can't compare offset-naive and "
4396 "offset-aware datetimes");
4397 return NULL;
4398}
4399
4400static long
4401datetime_hash(PyDateTime_DateTime *self)
4402{
4403 if (self->hashcode == -1) {
4404 naivety n;
4405 int offset;
4406 PyObject *temp;
4407
4408 n = classify_utcoffset((PyObject *)self, (PyObject *)self,
4409 &offset);
4410 assert(n != OFFSET_UNKNOWN);
4411 if (n == OFFSET_ERROR)
4412 return -1;
4413
4414 /* Reduce this to a hash of another object. */
Guido van Rossumfd53fd62007-08-24 04:05:13 +00004415 if (n == OFFSET_NAIVE) {
4416 self->hashcode = generic_hash(
4417 (unsigned char *)self->data, _PyDateTime_DATETIME_DATASIZE);
4418 return self->hashcode;
4419 }
Tim Petersa9bc1682003-01-11 03:39:11 +00004420 else {
4421 int days;
4422 int seconds;
4423
4424 assert(n == OFFSET_AWARE);
4425 assert(HASTZINFO(self));
4426 days = ymd_to_ord(GET_YEAR(self),
4427 GET_MONTH(self),
4428 GET_DAY(self));
4429 seconds = DATE_GET_HOUR(self) * 3600 +
4430 (DATE_GET_MINUTE(self) - offset) * 60 +
4431 DATE_GET_SECOND(self);
4432 temp = new_delta(days,
4433 seconds,
4434 DATE_GET_MICROSECOND(self),
4435 1);
4436 }
4437 if (temp != NULL) {
4438 self->hashcode = PyObject_Hash(temp);
4439 Py_DECREF(temp);
4440 }
4441 }
4442 return self->hashcode;
4443}
Tim Peters2a799bf2002-12-16 20:18:38 +00004444
4445static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004446datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00004447{
4448 PyObject *clone;
4449 PyObject *tuple;
4450 int y = GET_YEAR(self);
4451 int m = GET_MONTH(self);
4452 int d = GET_DAY(self);
4453 int hh = DATE_GET_HOUR(self);
4454 int mm = DATE_GET_MINUTE(self);
4455 int ss = DATE_GET_SECOND(self);
4456 int us = DATE_GET_MICROSECOND(self);
Tim Petersa9bc1682003-01-11 03:39:11 +00004457 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Tim Peters12bf3392002-12-24 05:41:27 +00004458
4459 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO:replace",
Tim Petersa9bc1682003-01-11 03:39:11 +00004460 datetime_kws,
Tim Peters12bf3392002-12-24 05:41:27 +00004461 &y, &m, &d, &hh, &mm, &ss, &us,
4462 &tzinfo))
4463 return NULL;
4464 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
4465 if (tuple == NULL)
4466 return NULL;
Christian Heimes90aa7642007-12-19 02:45:37 +00004467 clone = datetime_new(Py_TYPE(self), tuple, NULL);
Tim Peters12bf3392002-12-24 05:41:27 +00004468 Py_DECREF(tuple);
4469 return clone;
4470}
4471
4472static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004473datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters80475bb2002-12-25 07:40:55 +00004474{
Tim Peters52dcce22003-01-23 16:36:11 +00004475 int y, m, d, hh, mm, ss, us;
Tim Peters521fc152002-12-31 17:36:56 +00004476 PyObject *result;
Tim Peters52dcce22003-01-23 16:36:11 +00004477 int offset, none;
Tim Peters521fc152002-12-31 17:36:56 +00004478
Tim Peters80475bb2002-12-25 07:40:55 +00004479 PyObject *tzinfo;
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004480 static char *keywords[] = {"tz", NULL};
Tim Peters80475bb2002-12-25 07:40:55 +00004481
Tim Peters52dcce22003-01-23 16:36:11 +00004482 if (! PyArg_ParseTupleAndKeywords(args, kw, "O!:astimezone", keywords,
4483 &PyDateTime_TZInfoType, &tzinfo))
Tim Peters80475bb2002-12-25 07:40:55 +00004484 return NULL;
4485
Tim Peters52dcce22003-01-23 16:36:11 +00004486 if (!HASTZINFO(self) || self->tzinfo == Py_None)
4487 goto NeedAware;
Tim Peters521fc152002-12-31 17:36:56 +00004488
Tim Peters52dcce22003-01-23 16:36:11 +00004489 /* Conversion to self's own time zone is a NOP. */
4490 if (self->tzinfo == tzinfo) {
4491 Py_INCREF(self);
4492 return (PyObject *)self;
Tim Peters710fb152003-01-02 19:35:54 +00004493 }
Tim Peters521fc152002-12-31 17:36:56 +00004494
Tim Peters52dcce22003-01-23 16:36:11 +00004495 /* Convert self to UTC. */
4496 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4497 if (offset == -1 && PyErr_Occurred())
4498 return NULL;
4499 if (none)
4500 goto NeedAware;
Tim Petersf3615152003-01-01 21:51:37 +00004501
Tim Peters52dcce22003-01-23 16:36:11 +00004502 y = GET_YEAR(self);
4503 m = GET_MONTH(self);
4504 d = GET_DAY(self);
4505 hh = DATE_GET_HOUR(self);
4506 mm = DATE_GET_MINUTE(self);
4507 ss = DATE_GET_SECOND(self);
4508 us = DATE_GET_MICROSECOND(self);
4509
4510 mm -= offset;
Tim Petersf3615152003-01-01 21:51:37 +00004511 if ((mm < 0 || mm >= 60) &&
4512 normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us) < 0)
Tim Peters52dcce22003-01-23 16:36:11 +00004513 return NULL;
4514
4515 /* Attach new tzinfo and let fromutc() do the rest. */
4516 result = new_datetime(y, m, d, hh, mm, ss, us, tzinfo);
4517 if (result != NULL) {
4518 PyObject *temp = result;
4519
4520 result = PyObject_CallMethod(tzinfo, "fromutc", "O", temp);
4521 Py_DECREF(temp);
4522 }
Tim Petersadf64202003-01-04 06:03:15 +00004523 return result;
Tim Peters521fc152002-12-31 17:36:56 +00004524
Tim Peters52dcce22003-01-23 16:36:11 +00004525NeedAware:
4526 PyErr_SetString(PyExc_ValueError, "astimezone() cannot be applied to "
4527 "a naive datetime");
Tim Peters521fc152002-12-31 17:36:56 +00004528 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00004529}
4530
4531static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004532datetime_timetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004533{
4534 int dstflag = -1;
4535
Tim Petersa9bc1682003-01-11 03:39:11 +00004536 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004537 int none;
4538
4539 dstflag = call_dst(self->tzinfo, (PyObject *)self, &none);
4540 if (dstflag == -1 && PyErr_Occurred())
4541 return NULL;
4542
4543 if (none)
4544 dstflag = -1;
4545 else if (dstflag != 0)
4546 dstflag = 1;
4547
4548 }
4549 return build_struct_time(GET_YEAR(self),
4550 GET_MONTH(self),
4551 GET_DAY(self),
4552 DATE_GET_HOUR(self),
4553 DATE_GET_MINUTE(self),
4554 DATE_GET_SECOND(self),
4555 dstflag);
4556}
4557
4558static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004559datetime_getdate(PyDateTime_DateTime *self)
4560{
4561 return new_date(GET_YEAR(self),
4562 GET_MONTH(self),
4563 GET_DAY(self));
4564}
4565
4566static PyObject *
4567datetime_gettime(PyDateTime_DateTime *self)
4568{
4569 return new_time(DATE_GET_HOUR(self),
4570 DATE_GET_MINUTE(self),
4571 DATE_GET_SECOND(self),
4572 DATE_GET_MICROSECOND(self),
4573 Py_None);
4574}
4575
4576static PyObject *
4577datetime_gettimetz(PyDateTime_DateTime *self)
4578{
4579 return new_time(DATE_GET_HOUR(self),
4580 DATE_GET_MINUTE(self),
4581 DATE_GET_SECOND(self),
4582 DATE_GET_MICROSECOND(self),
4583 HASTZINFO(self) ? self->tzinfo : Py_None);
4584}
4585
4586static PyObject *
4587datetime_utctimetuple(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004588{
4589 int y = GET_YEAR(self);
4590 int m = GET_MONTH(self);
4591 int d = GET_DAY(self);
4592 int hh = DATE_GET_HOUR(self);
4593 int mm = DATE_GET_MINUTE(self);
4594 int ss = DATE_GET_SECOND(self);
4595 int us = 0; /* microseconds are ignored in a timetuple */
4596 int offset = 0;
4597
Tim Petersa9bc1682003-01-11 03:39:11 +00004598 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Tim Peters2a799bf2002-12-16 20:18:38 +00004599 int none;
4600
4601 offset = call_utcoffset(self->tzinfo, (PyObject *)self, &none);
4602 if (offset == -1 && PyErr_Occurred())
4603 return NULL;
4604 }
4605 /* Even if offset is 0, don't call timetuple() -- tm_isdst should be
4606 * 0 in a UTC timetuple regardless of what dst() says.
4607 */
4608 if (offset) {
4609 /* Subtract offset minutes & normalize. */
4610 int stat;
4611
4612 mm -= offset;
4613 stat = normalize_datetime(&y, &m, &d, &hh, &mm, &ss, &us);
4614 if (stat < 0) {
4615 /* At the edges, it's possible we overflowed
4616 * beyond MINYEAR or MAXYEAR.
4617 */
4618 if (PyErr_ExceptionMatches(PyExc_OverflowError))
4619 PyErr_Clear();
4620 else
4621 return NULL;
4622 }
4623 }
4624 return build_struct_time(y, m, d, hh, mm, ss, 0);
4625}
4626
Tim Peters371935f2003-02-01 01:52:50 +00004627/* Pickle support, a simple use of __reduce__. */
Tim Peters33e0f382003-01-10 02:05:14 +00004628
Tim Petersa9bc1682003-01-11 03:39:11 +00004629/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004630 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4631 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00004632 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00004633 */
4634static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004635datetime_getstate(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004636{
4637 PyObject *basestate;
4638 PyObject *result = NULL;
4639
Christian Heimes72b710a2008-05-26 13:28:38 +00004640 basestate = PyBytes_FromStringAndSize((char *)self->data,
Guido van Rossum254348e2007-11-21 19:29:53 +00004641 _PyDateTime_DATETIME_DATASIZE);
Tim Peters2a799bf2002-12-16 20:18:38 +00004642 if (basestate != NULL) {
Tim Petersa9bc1682003-01-11 03:39:11 +00004643 if (! HASTZINFO(self) || self->tzinfo == Py_None)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004644 result = PyTuple_Pack(1, basestate);
Tim Peters2a799bf2002-12-16 20:18:38 +00004645 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004646 result = PyTuple_Pack(2, basestate, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00004647 Py_DECREF(basestate);
4648 }
4649 return result;
4650}
4651
4652static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00004653datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00004654{
Christian Heimes90aa7642007-12-19 02:45:37 +00004655 return Py_BuildValue("(ON)", Py_TYPE(self), datetime_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00004656}
4657
Tim Petersa9bc1682003-01-11 03:39:11 +00004658static PyMethodDef datetime_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004659
Tim Peters2a799bf2002-12-16 20:18:38 +00004660 /* Class methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00004661
Tim Petersa9bc1682003-01-11 03:39:11 +00004662 {"now", (PyCFunction)datetime_now,
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004663 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
Neal Norwitz2fbe5372003-01-23 21:09:05 +00004664 PyDoc_STR("[tz] -> new datetime with tz's local day and time.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004665
Tim Petersa9bc1682003-01-11 03:39:11 +00004666 {"utcnow", (PyCFunction)datetime_utcnow,
4667 METH_NOARGS | METH_CLASS,
4668 PyDoc_STR("Return a new datetime representing UTC day and time.")},
4669
4670 {"fromtimestamp", (PyCFunction)datetime_fromtimestamp,
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004671 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
Tim Peters2a44a8d2003-01-23 20:53:10 +00004672 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004673
Tim Petersa9bc1682003-01-11 03:39:11 +00004674 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
4675 METH_VARARGS | METH_CLASS,
4676 PyDoc_STR("timestamp -> UTC datetime from a POSIX timestamp "
4677 "(like time.time()).")},
4678
Skip Montanaro0af3ade2005-01-13 04:12:31 +00004679 {"strptime", (PyCFunction)datetime_strptime,
4680 METH_VARARGS | METH_CLASS,
4681 PyDoc_STR("string, format -> new datetime parsed from a string "
4682 "(like time.strptime()).")},
4683
Tim Petersa9bc1682003-01-11 03:39:11 +00004684 {"combine", (PyCFunction)datetime_combine,
4685 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
4686 PyDoc_STR("date, time -> datetime with same date and time fields")},
4687
Tim Peters2a799bf2002-12-16 20:18:38 +00004688 /* Instance methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00004689
Tim Petersa9bc1682003-01-11 03:39:11 +00004690 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
4691 PyDoc_STR("Return date object with same year, month and day.")},
4692
4693 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
4694 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
4695
4696 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
4697 PyDoc_STR("Return time object with same time and tzinfo.")},
4698
4699 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
4700 PyDoc_STR("Return ctime() style string.")},
4701
4702 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004703 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
4704
Tim Petersa9bc1682003-01-11 03:39:11 +00004705 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004706 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
4707
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004708 {"isoformat", (PyCFunction)datetime_isoformat, METH_VARARGS | METH_KEYWORDS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004709 PyDoc_STR("[sep] -> string in ISO 8601 format, "
4710 "YYYY-MM-DDTHH:MM:SS[.mmmmmm][+HH:MM].\n\n"
4711 "sep is used to separate the year from the time, and "
4712 "defaults to 'T'.")},
4713
Tim Petersa9bc1682003-01-11 03:39:11 +00004714 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004715 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
4716
Tim Petersa9bc1682003-01-11 03:39:11 +00004717 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004718 PyDoc_STR("Return self.tzinfo.tzname(self).")},
4719
Tim Petersa9bc1682003-01-11 03:39:11 +00004720 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
Tim Peters2a799bf2002-12-16 20:18:38 +00004721 PyDoc_STR("Return self.tzinfo.dst(self).")},
4722
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004723 {"replace", (PyCFunction)datetime_replace, METH_VARARGS | METH_KEYWORDS,
Tim Petersa9bc1682003-01-11 03:39:11 +00004724 PyDoc_STR("Return datetime with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00004725
Guido van Rossumd59da4b2007-05-22 18:11:13 +00004726 {"astimezone", (PyCFunction)datetime_astimezone, METH_VARARGS | METH_KEYWORDS,
Tim Peters80475bb2002-12-25 07:40:55 +00004727 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
4728
Guido van Rossum177e41a2003-01-30 22:06:23 +00004729 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
4730 PyDoc_STR("__reduce__() -> (cls, state)")},
4731
Tim Peters2a799bf2002-12-16 20:18:38 +00004732 {NULL, NULL}
4733};
4734
Tim Petersa9bc1682003-01-11 03:39:11 +00004735static char datetime_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00004736PyDoc_STR("datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])\n\
4737\n\
4738The year, month and day arguments are required. tzinfo may be None, or an\n\
4739instance of a tzinfo subclass. The remaining arguments may be ints or longs.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00004740
Tim Petersa9bc1682003-01-11 03:39:11 +00004741static PyNumberMethods datetime_as_number = {
4742 datetime_add, /* nb_add */
4743 datetime_subtract, /* nb_subtract */
Tim Peters2a799bf2002-12-16 20:18:38 +00004744 0, /* nb_multiply */
Tim Peters2a799bf2002-12-16 20:18:38 +00004745 0, /* nb_remainder */
4746 0, /* nb_divmod */
4747 0, /* nb_power */
4748 0, /* nb_negative */
4749 0, /* nb_positive */
4750 0, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +00004751 0, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00004752};
4753
Neal Norwitz227b5332006-03-22 09:28:35 +00004754static PyTypeObject PyDateTime_DateTimeType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00004755 PyVarObject_HEAD_INIT(NULL, 0)
Tim Peters0bf60bd2003-01-08 20:40:01 +00004756 "datetime.datetime", /* tp_name */
Tim Petersa9bc1682003-01-11 03:39:11 +00004757 sizeof(PyDateTime_DateTime), /* tp_basicsize */
Tim Peters2a799bf2002-12-16 20:18:38 +00004758 0, /* tp_itemsize */
Tim Petersa9bc1682003-01-11 03:39:11 +00004759 (destructor)datetime_dealloc, /* tp_dealloc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004760 0, /* tp_print */
4761 0, /* tp_getattr */
4762 0, /* tp_setattr */
Mark Dickinsone94c6792009-02-02 20:36:42 +00004763 0, /* tp_reserved */
Tim Petersa9bc1682003-01-11 03:39:11 +00004764 (reprfunc)datetime_repr, /* tp_repr */
4765 &datetime_as_number, /* tp_as_number */
Tim Peters2a799bf2002-12-16 20:18:38 +00004766 0, /* tp_as_sequence */
4767 0, /* tp_as_mapping */
Tim Petersa9bc1682003-01-11 03:39:11 +00004768 (hashfunc)datetime_hash, /* tp_hash */
Tim Peters2a799bf2002-12-16 20:18:38 +00004769 0, /* tp_call */
Tim Petersa9bc1682003-01-11 03:39:11 +00004770 (reprfunc)datetime_str, /* tp_str */
Tim Peters2a799bf2002-12-16 20:18:38 +00004771 PyObject_GenericGetAttr, /* tp_getattro */
4772 0, /* tp_setattro */
4773 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00004774 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Petersa9bc1682003-01-11 03:39:11 +00004775 datetime_doc, /* tp_doc */
Tim Peters2a799bf2002-12-16 20:18:38 +00004776 0, /* tp_traverse */
4777 0, /* tp_clear */
Guido van Rossum19960592006-08-24 17:29:38 +00004778 datetime_richcompare, /* tp_richcompare */
Tim Peters2a799bf2002-12-16 20:18:38 +00004779 0, /* tp_weaklistoffset */
4780 0, /* tp_iter */
4781 0, /* tp_iternext */
Tim Petersa9bc1682003-01-11 03:39:11 +00004782 datetime_methods, /* tp_methods */
Tim Peters2a799bf2002-12-16 20:18:38 +00004783 0, /* tp_members */
Tim Petersa9bc1682003-01-11 03:39:11 +00004784 datetime_getset, /* tp_getset */
4785 &PyDateTime_DateType, /* tp_base */
Tim Peters2a799bf2002-12-16 20:18:38 +00004786 0, /* tp_dict */
4787 0, /* tp_descr_get */
4788 0, /* tp_descr_set */
4789 0, /* tp_dictoffset */
4790 0, /* tp_init */
Tim Petersa98924a2003-05-17 05:55:19 +00004791 datetime_alloc, /* tp_alloc */
Tim Petersa9bc1682003-01-11 03:39:11 +00004792 datetime_new, /* tp_new */
Tim Peters4c530132003-05-16 22:44:06 +00004793 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00004794};
4795
4796/* ---------------------------------------------------------------------------
4797 * Module methods and initialization.
4798 */
4799
4800static PyMethodDef module_methods[] = {
Tim Peters2a799bf2002-12-16 20:18:38 +00004801 {NULL, NULL}
4802};
4803
Tim Peters9ddf40b2004-06-20 22:41:32 +00004804/* C API. Clients get at this via PyDateTime_IMPORT, defined in
4805 * datetime.h.
4806 */
4807static PyDateTime_CAPI CAPI = {
4808 &PyDateTime_DateType,
4809 &PyDateTime_DateTimeType,
4810 &PyDateTime_TimeType,
4811 &PyDateTime_DeltaType,
4812 &PyDateTime_TZInfoType,
4813 new_date_ex,
4814 new_datetime_ex,
4815 new_time_ex,
4816 new_delta_ex,
4817 datetime_fromtimestamp,
4818 date_fromtimestamp
4819};
4820
4821
Martin v. Löwis1a214512008-06-11 05:26:20 +00004822
4823static struct PyModuleDef datetimemodule = {
4824 PyModuleDef_HEAD_INIT,
4825 "datetime",
4826 "Fast implementation of the datetime type.",
4827 -1,
4828 module_methods,
4829 NULL,
4830 NULL,
4831 NULL,
4832 NULL
4833};
4834
Tim Peters2a799bf2002-12-16 20:18:38 +00004835PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004836PyInit_datetime(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00004837{
4838 PyObject *m; /* a module object */
4839 PyObject *d; /* its dict */
4840 PyObject *x;
4841
Martin v. Löwis1a214512008-06-11 05:26:20 +00004842 m = PyModule_Create(&datetimemodule);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00004843 if (m == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004844 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004845
4846 if (PyType_Ready(&PyDateTime_DateType) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004847 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004848 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004849 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004850 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004851 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004852 if (PyType_Ready(&PyDateTime_TimeType) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004853 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004854 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004855 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004856
Tim Peters2a799bf2002-12-16 20:18:38 +00004857 /* timedelta values */
4858 d = PyDateTime_DeltaType.tp_dict;
4859
Tim Peters2a799bf2002-12-16 20:18:38 +00004860 x = new_delta(0, 0, 1, 0);
4861 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004862 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004863 Py_DECREF(x);
4864
4865 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
4866 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004867 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004868 Py_DECREF(x);
4869
4870 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
4871 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004872 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004873 Py_DECREF(x);
4874
4875 /* date values */
4876 d = PyDateTime_DateType.tp_dict;
4877
4878 x = new_date(1, 1, 1);
4879 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004880 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004881 Py_DECREF(x);
4882
4883 x = new_date(MAXYEAR, 12, 31);
4884 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004885 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004886 Py_DECREF(x);
4887
4888 x = new_delta(1, 0, 0, 0);
4889 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004890 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004891 Py_DECREF(x);
4892
Tim Peters37f39822003-01-10 03:49:02 +00004893 /* time values */
4894 d = PyDateTime_TimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004895
Tim Peters37f39822003-01-10 03:49:02 +00004896 x = new_time(0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004897 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004898 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004899 Py_DECREF(x);
4900
Tim Peters37f39822003-01-10 03:49:02 +00004901 x = new_time(23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004902 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004903 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004904 Py_DECREF(x);
4905
4906 x = new_delta(0, 0, 1, 0);
4907 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004908 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004909 Py_DECREF(x);
4910
Tim Petersa9bc1682003-01-11 03:39:11 +00004911 /* datetime values */
4912 d = PyDateTime_DateTimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00004913
Tim Petersa9bc1682003-01-11 03:39:11 +00004914 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004915 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004916 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004917 Py_DECREF(x);
4918
Tim Petersa9bc1682003-01-11 03:39:11 +00004919 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004920 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004921 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004922 Py_DECREF(x);
4923
4924 x = new_delta(0, 0, 1, 0);
4925 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004926 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004927 Py_DECREF(x);
4928
Tim Peters2a799bf2002-12-16 20:18:38 +00004929 /* module initialization */
4930 PyModule_AddIntConstant(m, "MINYEAR", MINYEAR);
4931 PyModule_AddIntConstant(m, "MAXYEAR", MAXYEAR);
4932
4933 Py_INCREF(&PyDateTime_DateType);
4934 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
4935
Tim Petersa9bc1682003-01-11 03:39:11 +00004936 Py_INCREF(&PyDateTime_DateTimeType);
4937 PyModule_AddObject(m, "datetime",
4938 (PyObject *)&PyDateTime_DateTimeType);
4939
4940 Py_INCREF(&PyDateTime_TimeType);
4941 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
4942
Tim Peters2a799bf2002-12-16 20:18:38 +00004943 Py_INCREF(&PyDateTime_DeltaType);
4944 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
4945
Tim Peters2a799bf2002-12-16 20:18:38 +00004946 Py_INCREF(&PyDateTime_TZInfoType);
4947 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
4948
Benjamin Peterson08bf91c2010-04-11 16:12:57 +00004949 x = PyCapsule_New(&CAPI, PyDateTime_CAPSULE_NAME, NULL);
4950 if (x == NULL)
4951 return NULL;
4952 PyModule_AddObject(m, "datetime_CAPI", x);
Tim Peters9ddf40b2004-06-20 22:41:32 +00004953
Tim Peters2a799bf2002-12-16 20:18:38 +00004954 /* A 4-year cycle has an extra leap day over what we'd get from
4955 * pasting together 4 single years.
4956 */
4957 assert(DI4Y == 4 * 365 + 1);
4958 assert(DI4Y == days_before_year(4+1));
4959
4960 /* Similarly, a 400-year cycle has an extra leap day over what we'd
4961 * get from pasting together 4 100-year cycles.
4962 */
4963 assert(DI400Y == 4 * DI100Y + 1);
4964 assert(DI400Y == days_before_year(400+1));
4965
4966 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
4967 * pasting together 25 4-year cycles.
4968 */
4969 assert(DI100Y == 25 * DI4Y - 1);
4970 assert(DI100Y == days_before_year(100+1));
4971
Christian Heimes217cfd12007-12-02 14:31:20 +00004972 us_per_us = PyLong_FromLong(1);
4973 us_per_ms = PyLong_FromLong(1000);
4974 us_per_second = PyLong_FromLong(1000000);
4975 us_per_minute = PyLong_FromLong(60000000);
4976 seconds_per_day = PyLong_FromLong(24 * 3600);
Tim Peters2a799bf2002-12-16 20:18:38 +00004977 if (us_per_us == NULL || us_per_ms == NULL || us_per_second == NULL ||
4978 us_per_minute == NULL || seconds_per_day == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004979 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004980
4981 /* The rest are too big for 32-bit ints, but even
4982 * us_per_week fits in 40 bits, so doubles should be exact.
4983 */
4984 us_per_hour = PyLong_FromDouble(3600000000.0);
4985 us_per_day = PyLong_FromDouble(86400000000.0);
4986 us_per_week = PyLong_FromDouble(604800000000.0);
4987 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +00004988 return NULL;
4989 return m;
Tim Peters2a799bf2002-12-16 20:18:38 +00004990}
Tim Petersf3615152003-01-01 21:51:37 +00004991
4992/* ---------------------------------------------------------------------------
Tim Petersa9bc1682003-01-11 03:39:11 +00004993Some time zone algebra. For a datetime x, let
Tim Petersf3615152003-01-01 21:51:37 +00004994 x.n = x stripped of its timezone -- its naive time.
4995 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
4996 return None
4997 x.d = x.dst(), and assuming that doesn't raise an exception or
4998 return None
4999 x.s = x's standard offset, x.o - x.d
5000
5001Now some derived rules, where k is a duration (timedelta).
5002
50031. x.o = x.s + x.d
5004 This follows from the definition of x.s.
5005
Tim Petersc5dc4da2003-01-02 17:55:03 +000050062. If x and y have the same tzinfo member, x.s = y.s.
Tim Petersf3615152003-01-01 21:51:37 +00005007 This is actually a requirement, an assumption we need to make about
5008 sane tzinfo classes.
5009
50103. The naive UTC time corresponding to x is x.n - x.o.
5011 This is again a requirement for a sane tzinfo class.
5012
50134. (x+k).s = x.s
Tim Peters8bb5ad22003-01-24 02:44:45 +00005014 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
Tim Petersf3615152003-01-01 21:51:37 +00005015
Tim Petersc5dc4da2003-01-02 17:55:03 +000050165. (x+k).n = x.n + k
Tim Petersf3615152003-01-01 21:51:37 +00005017 Again follows from how arithmetic is defined.
5018
Tim Peters8bb5ad22003-01-24 02:44:45 +00005019Now we can explain tz.fromutc(x). Let's assume it's an interesting case
Tim Petersf3615152003-01-01 21:51:37 +00005020(meaning that the various tzinfo methods exist, and don't blow up or return
5021None when called).
5022
Tim Petersa9bc1682003-01-11 03:39:11 +00005023The function wants to return a datetime y with timezone tz, equivalent to x.
Tim Peters8bb5ad22003-01-24 02:44:45 +00005024x is already in UTC.
Tim Petersf3615152003-01-01 21:51:37 +00005025
5026By #3, we want
5027
Tim Peters8bb5ad22003-01-24 02:44:45 +00005028 y.n - y.o = x.n [1]
Tim Petersf3615152003-01-01 21:51:37 +00005029
5030The algorithm starts by attaching tz to x.n, and calling that y. So
5031x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
5032becomes true; in effect, we want to solve [2] for k:
5033
Tim Peters8bb5ad22003-01-24 02:44:45 +00005034 (y+k).n - (y+k).o = x.n [2]
Tim Petersf3615152003-01-01 21:51:37 +00005035
5036By #1, this is the same as
5037
Tim Peters8bb5ad22003-01-24 02:44:45 +00005038 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
Tim Petersf3615152003-01-01 21:51:37 +00005039
5040By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
5041Substituting that into [3],
5042
Tim Peters8bb5ad22003-01-24 02:44:45 +00005043 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
5044 k - (y+k).s - (y+k).d = 0; rearranging,
5045 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
5046 k = y.s - (y+k).d
Tim Petersf3615152003-01-01 21:51:37 +00005047
Tim Peters8bb5ad22003-01-24 02:44:45 +00005048On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
5049approximate k by ignoring the (y+k).d term at first. Note that k can't be
5050very large, since all offset-returning methods return a duration of magnitude
5051less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
5052be 0, so ignoring it has no consequence then.
Tim Petersf3615152003-01-01 21:51:37 +00005053
5054In any case, the new value is
5055
Tim Peters8bb5ad22003-01-24 02:44:45 +00005056 z = y + y.s [4]
Tim Petersf3615152003-01-01 21:51:37 +00005057
Tim Peters8bb5ad22003-01-24 02:44:45 +00005058It's helpful to step back at look at [4] from a higher level: it's simply
5059mapping from UTC to tz's standard time.
Tim Petersc5dc4da2003-01-02 17:55:03 +00005060
5061At this point, if
5062
Tim Peters8bb5ad22003-01-24 02:44:45 +00005063 z.n - z.o = x.n [5]
Tim Petersc5dc4da2003-01-02 17:55:03 +00005064
5065we have an equivalent time, and are almost done. The insecurity here is
Tim Petersf3615152003-01-01 21:51:37 +00005066at the start of daylight time. Picture US Eastern for concreteness. The wall
5067time 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 +00005068sense then. The docs ask that an Eastern tzinfo class consider such a time to
5069be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
5070on the day DST starts. We want to return the 1:MM EST spelling because that's
Tim Petersf3615152003-01-01 21:51:37 +00005071the only spelling that makes sense on the local wall clock.
5072
Tim Petersc5dc4da2003-01-02 17:55:03 +00005073In fact, if [5] holds at this point, we do have the standard-time spelling,
5074but that takes a bit of proof. We first prove a stronger result. What's the
5075difference between the LHS and RHS of [5]? Let
Tim Petersf3615152003-01-01 21:51:37 +00005076
Tim Peters8bb5ad22003-01-24 02:44:45 +00005077 diff = x.n - (z.n - z.o) [6]
Tim Petersf3615152003-01-01 21:51:37 +00005078
Tim Petersc5dc4da2003-01-02 17:55:03 +00005079Now
5080 z.n = by [4]
Tim Peters8bb5ad22003-01-24 02:44:45 +00005081 (y + y.s).n = by #5
5082 y.n + y.s = since y.n = x.n
5083 x.n + y.s = since z and y are have the same tzinfo member,
5084 y.s = z.s by #2
5085 x.n + z.s
Tim Petersf3615152003-01-01 21:51:37 +00005086
Tim Petersc5dc4da2003-01-02 17:55:03 +00005087Plugging that back into [6] gives
Tim Petersf3615152003-01-01 21:51:37 +00005088
Tim Petersc5dc4da2003-01-02 17:55:03 +00005089 diff =
Tim Peters8bb5ad22003-01-24 02:44:45 +00005090 x.n - ((x.n + z.s) - z.o) = expanding
5091 x.n - x.n - z.s + z.o = cancelling
5092 - z.s + z.o = by #2
Tim Petersc5dc4da2003-01-02 17:55:03 +00005093 z.d
Tim Petersf3615152003-01-01 21:51:37 +00005094
Tim Petersc5dc4da2003-01-02 17:55:03 +00005095So diff = z.d.
Tim Petersf3615152003-01-01 21:51:37 +00005096
Tim Petersc5dc4da2003-01-02 17:55:03 +00005097If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
Tim Peters8bb5ad22003-01-24 02:44:45 +00005098spelling we wanted in the endcase described above. We're done. Contrarily,
5099if z.d = 0, then we have a UTC equivalent, and are also done.
Tim Petersf3615152003-01-01 21:51:37 +00005100
Tim Petersc5dc4da2003-01-02 17:55:03 +00005101If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
5102add to z (in effect, z is in tz's standard time, and we need to shift the
Tim Peters8bb5ad22003-01-24 02:44:45 +00005103local clock into tz's daylight time).
Tim Petersf3615152003-01-01 21:51:37 +00005104
Tim Petersc5dc4da2003-01-02 17:55:03 +00005105Let
Tim Petersf3615152003-01-01 21:51:37 +00005106
Tim Peters4fede1a2003-01-04 00:26:59 +00005107 z' = z + z.d = z + diff [7]
Tim Petersc3bb26a2003-01-02 03:14:59 +00005108
Tim Peters4fede1a2003-01-04 00:26:59 +00005109and we can again ask whether
Tim Petersc3bb26a2003-01-02 03:14:59 +00005110
Tim Peters8bb5ad22003-01-24 02:44:45 +00005111 z'.n - z'.o = x.n [8]
Tim Petersc3bb26a2003-01-02 03:14:59 +00005112
Tim Peters8bb5ad22003-01-24 02:44:45 +00005113If so, we're done. If not, the tzinfo class is insane, according to the
5114assumptions we've made. This also requires a bit of proof. As before, let's
5115compute the difference between the LHS and RHS of [8] (and skipping some of
5116the justifications for the kinds of substitutions we've done several times
5117already):
Tim Peters4fede1a2003-01-04 00:26:59 +00005118
Tim Peters8bb5ad22003-01-24 02:44:45 +00005119 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
5120 x.n - (z.n + diff - z'.o) = replacing diff via [6]
5121 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
5122 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
5123 - z.n + z.n - z.o + z'.o = cancel z.n
Tim Peters4fede1a2003-01-04 00:26:59 +00005124 - z.o + z'.o = #1 twice
5125 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
5126 z'.d - z.d
5127
5128So 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 +00005129we've found the UTC-equivalent so are done. In fact, we stop with [7] and
5130return z', not bothering to compute z'.d.
Tim Peters4fede1a2003-01-04 00:26:59 +00005131
Tim Peters8bb5ad22003-01-24 02:44:45 +00005132How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
5133a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
5134would have to change the result dst() returns: we start in DST, and moving
5135a little further into it takes us out of DST.
Tim Peters4fede1a2003-01-04 00:26:59 +00005136
Tim Peters8bb5ad22003-01-24 02:44:45 +00005137There isn't a sane case where this can happen. The closest it gets is at
5138the end of DST, where there's an hour in UTC with no spelling in a hybrid
5139tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
5140that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
5141UTC) because the docs insist on that, but 0:MM is taken as being in daylight
5142time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
5143clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
5144standard time. Since that's what the local clock *does*, we want to map both
5145UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
Tim Peters4fede1a2003-01-04 00:26:59 +00005146in local time, but so it goes -- it's the way the local clock works.
5147
Tim Peters8bb5ad22003-01-24 02:44:45 +00005148When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
5149so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
5150z' = 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 +00005151(correctly) concludes that z' is not UTC-equivalent to x.
5152
5153Because we know z.d said z was in daylight time (else [5] would have held and
5154we would have stopped then), and we know z.d != z'.d (else [8] would have held
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00005155and we would have stopped then), and there are only 2 possible values dst() can
Tim Peters4fede1a2003-01-04 00:26:59 +00005156return in Eastern, it follows that z'.d must be 0 (which it is in the example,
5157but the reasoning doesn't depend on the example -- it depends on there being
5158two possible dst() outcomes, one zero and the other non-zero). Therefore
Tim Peters8bb5ad22003-01-24 02:44:45 +00005159z' must be in standard time, and is the spelling we want in this case.
5160
5161Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
5162concerned (because it takes z' as being in standard time rather than the
5163daylight time we intend here), but returning it gives the real-life "local
5164clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
5165tz.
5166
5167When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
5168the 1:MM standard time spelling we want.
5169
5170So how can this break? One of the assumptions must be violated. Two
5171possibilities:
5172
51731) [2] effectively says that y.s is invariant across all y belong to a given
5174 time zone. This isn't true if, for political reasons or continental drift,
5175 a region decides to change its base offset from UTC.
5176
51772) There may be versions of "double daylight" time where the tail end of
5178 the analysis gives up a step too early. I haven't thought about that
5179 enough to say.
5180
5181In any case, it's clear that the default fromutc() is strong enough to handle
5182"almost all" time zones: so long as the standard offset is invariant, it
5183doesn't matter if daylight time transition points change from year to year, or
5184if daylight time is skipped in some years; it doesn't matter how large or
5185small dst() may get within its bounds; and it doesn't even matter if some
5186perverse time zone returns a negative dst()). So a breaking case must be
5187pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
Tim Petersf3615152003-01-01 21:51:37 +00005188--------------------------------------------------------------------------- */