blob: bc03c504380decc9d18f1f01983979686b803b4d [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
Paul Ganssle0d126722018-11-13 03:02:25 -05005/* bpo-35081: Defining this prevents including the C API capsule;
6 * internal versions of the Py*_Check macros which do not require
7 * the capsule are defined below */
8#define _PY_DATETIME_IMPL
9
Tim Peters2a799bf2002-12-16 20:18:38 +000010#include "Python.h"
Paul Ganssle0d126722018-11-13 03:02:25 -050011#include "datetime.h"
Tim Peters2a799bf2002-12-16 20:18:38 +000012#include "structmember.h"
13
14#include <time.h>
15
Victor Stinner09e5cf22015-03-30 00:09:18 +020016#ifdef MS_WINDOWS
17# include <winsock2.h> /* struct timeval */
18#endif
19
Paul Ganssle0d126722018-11-13 03:02:25 -050020#define PyDate_Check(op) PyObject_TypeCheck(op, &PyDateTime_DateType)
21#define PyDate_CheckExact(op) (Py_TYPE(op) == &PyDateTime_DateType)
22
23#define PyDateTime_Check(op) PyObject_TypeCheck(op, &PyDateTime_DateTimeType)
24#define PyDateTime_CheckExact(op) (Py_TYPE(op) == &PyDateTime_DateTimeType)
25
26#define PyTime_Check(op) PyObject_TypeCheck(op, &PyDateTime_TimeType)
27#define PyTime_CheckExact(op) (Py_TYPE(op) == &PyDateTime_TimeType)
28
29#define PyDelta_Check(op) PyObject_TypeCheck(op, &PyDateTime_DeltaType)
30#define PyDelta_CheckExact(op) (Py_TYPE(op) == &PyDateTime_DeltaType)
31
32#define PyTZInfo_Check(op) PyObject_TypeCheck(op, &PyDateTime_TZInfoType)
33#define PyTZInfo_CheckExact(op) (Py_TYPE(op) == &PyDateTime_TZInfoType)
34
Pablo Galindo4be11c02019-08-22 20:24:25 +010035#define PyTimezone_Check(op) PyObject_TypeCheck(op, &PyDateTime_TimeZoneType)
Tim Peters2a799bf2002-12-16 20:18:38 +000036
Larry Hastings61272b72014-01-07 12:41:53 -080037/*[clinic input]
Larry Hastings44e2eaa2013-11-23 15:37:55 -080038module datetime
Larry Hastingsc2047262014-01-25 20:43:29 -080039class datetime.datetime "PyDateTime_DateTime *" "&PyDateTime_DateTimeType"
Tim Hoffmanna0fd7f12018-09-24 10:39:02 +020040class datetime.date "PyDateTime_Date *" "&PyDateTime_DateType"
Larry Hastings61272b72014-01-07 12:41:53 -080041[clinic start generated code]*/
Tim Hoffmanna0fd7f12018-09-24 10:39:02 +020042/*[clinic end generated code: output=da39a3ee5e6b4b0d input=25138ad6a696b785]*/
Larry Hastings44e2eaa2013-11-23 15:37:55 -080043
Serhiy Storchaka1009bf12015-04-03 23:53:51 +030044#include "clinic/_datetimemodule.c.h"
45
Tim Peters2a799bf2002-12-16 20:18:38 +000046/* We require that C int be at least 32 bits, and use int virtually
47 * everywhere. In just a few cases we use a temp long, where a Python
48 * API returns a C long. In such cases, we have to ensure that the
49 * final result fits in a C int (this can be an issue on 64-bit boxes).
50 */
51#if SIZEOF_INT < 4
Alexander Belopolskycf86e362010-07-23 19:25:47 +000052# error "_datetime.c requires that C int have at least 32 bits"
Tim Peters2a799bf2002-12-16 20:18:38 +000053#endif
54
55#define MINYEAR 1
56#define MAXYEAR 9999
Alexander Belopolskyf03a6162010-05-27 21:42:58 +000057#define MAXORDINAL 3652059 /* date(9999,12,31).toordinal() */
Tim Peters2a799bf2002-12-16 20:18:38 +000058
59/* Nine decimal digits is easy to communicate, and leaves enough room
60 * so that two delta days can be added w/o fear of overflowing a signed
61 * 32-bit int, and with plenty of room left over to absorb any possible
62 * carries from adding seconds.
63 */
64#define MAX_DELTA_DAYS 999999999
65
66/* Rename the long macros in datetime.h to more reasonable short names. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000067#define GET_YEAR PyDateTime_GET_YEAR
68#define GET_MONTH PyDateTime_GET_MONTH
69#define GET_DAY PyDateTime_GET_DAY
70#define DATE_GET_HOUR PyDateTime_DATE_GET_HOUR
71#define DATE_GET_MINUTE PyDateTime_DATE_GET_MINUTE
72#define DATE_GET_SECOND PyDateTime_DATE_GET_SECOND
73#define DATE_GET_MICROSECOND PyDateTime_DATE_GET_MICROSECOND
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -040074#define DATE_GET_FOLD PyDateTime_DATE_GET_FOLD
Tim Peters2a799bf2002-12-16 20:18:38 +000075
76/* Date accessors for date and datetime. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077#define SET_YEAR(o, v) (((o)->data[0] = ((v) & 0xff00) >> 8), \
78 ((o)->data[1] = ((v) & 0x00ff)))
79#define SET_MONTH(o, v) (PyDateTime_GET_MONTH(o) = (v))
80#define SET_DAY(o, v) (PyDateTime_GET_DAY(o) = (v))
Tim Peters2a799bf2002-12-16 20:18:38 +000081
82/* Date/Time accessors for datetime. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000083#define DATE_SET_HOUR(o, v) (PyDateTime_DATE_GET_HOUR(o) = (v))
84#define DATE_SET_MINUTE(o, v) (PyDateTime_DATE_GET_MINUTE(o) = (v))
85#define DATE_SET_SECOND(o, v) (PyDateTime_DATE_GET_SECOND(o) = (v))
86#define DATE_SET_MICROSECOND(o, v) \
87 (((o)->data[7] = ((v) & 0xff0000) >> 16), \
88 ((o)->data[8] = ((v) & 0x00ff00) >> 8), \
89 ((o)->data[9] = ((v) & 0x0000ff)))
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -040090#define DATE_SET_FOLD(o, v) (PyDateTime_DATE_GET_FOLD(o) = (v))
Tim Peters2a799bf2002-12-16 20:18:38 +000091
92/* Time accessors for time. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000093#define TIME_GET_HOUR PyDateTime_TIME_GET_HOUR
94#define TIME_GET_MINUTE PyDateTime_TIME_GET_MINUTE
95#define TIME_GET_SECOND PyDateTime_TIME_GET_SECOND
96#define TIME_GET_MICROSECOND PyDateTime_TIME_GET_MICROSECOND
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -040097#define TIME_GET_FOLD PyDateTime_TIME_GET_FOLD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000098#define TIME_SET_HOUR(o, v) (PyDateTime_TIME_GET_HOUR(o) = (v))
99#define TIME_SET_MINUTE(o, v) (PyDateTime_TIME_GET_MINUTE(o) = (v))
100#define TIME_SET_SECOND(o, v) (PyDateTime_TIME_GET_SECOND(o) = (v))
101#define TIME_SET_MICROSECOND(o, v) \
102 (((o)->data[3] = ((v) & 0xff0000) >> 16), \
103 ((o)->data[4] = ((v) & 0x00ff00) >> 8), \
104 ((o)->data[5] = ((v) & 0x0000ff)))
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -0400105#define TIME_SET_FOLD(o, v) (PyDateTime_TIME_GET_FOLD(o) = (v))
Tim Peters2a799bf2002-12-16 20:18:38 +0000106
107/* Delta accessors for timedelta. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000108#define GET_TD_DAYS(o) (((PyDateTime_Delta *)(o))->days)
109#define GET_TD_SECONDS(o) (((PyDateTime_Delta *)(o))->seconds)
110#define GET_TD_MICROSECONDS(o) (((PyDateTime_Delta *)(o))->microseconds)
Tim Peters2a799bf2002-12-16 20:18:38 +0000111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112#define SET_TD_DAYS(o, v) ((o)->days = (v))
113#define SET_TD_SECONDS(o, v) ((o)->seconds = (v))
Tim Peters2a799bf2002-12-16 20:18:38 +0000114#define SET_TD_MICROSECONDS(o, v) ((o)->microseconds = (v))
115
Tim Petersa032d2e2003-01-11 00:15:54 +0000116/* p is a pointer to a time or a datetime object; HASTZINFO(p) returns
117 * p->hastzinfo.
118 */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +0000119#define HASTZINFO(p) (((_PyDateTime_BaseTZInfo *)(p))->hastzinfo)
120#define GET_TIME_TZINFO(p) (HASTZINFO(p) ? \
121 ((PyDateTime_Time *)(p))->tzinfo : Py_None)
122#define GET_DT_TZINFO(p) (HASTZINFO(p) ? \
123 ((PyDateTime_DateTime *)(p))->tzinfo : Py_None)
Tim Peters3f606292004-03-21 23:38:41 +0000124/* M is a char or int claiming to be a valid month. The macro is equivalent
125 * to the two-sided Python test
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000126 * 1 <= M <= 12
Tim Peters3f606292004-03-21 23:38:41 +0000127 */
128#define MONTH_IS_SANE(M) ((unsigned int)(M) - 1 < 12)
129
Tim Peters2a799bf2002-12-16 20:18:38 +0000130/* Forward declarations. */
131static PyTypeObject PyDateTime_DateType;
132static PyTypeObject PyDateTime_DateTimeType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000133static PyTypeObject PyDateTime_DeltaType;
134static PyTypeObject PyDateTime_TimeType;
135static PyTypeObject PyDateTime_TZInfoType;
Alexander Belopolsky4e749a12010-06-14 14:15:50 +0000136static PyTypeObject PyDateTime_TimeZoneType;
Tim Peters2a799bf2002-12-16 20:18:38 +0000137
Victor Stinnerb67f0962017-02-10 10:34:02 +0100138static int check_tzinfo_subclass(PyObject *p);
139
Martin v. Löwise75fc142013-11-07 18:46:53 +0100140_Py_IDENTIFIER(as_integer_ratio);
141_Py_IDENTIFIER(fromutc);
142_Py_IDENTIFIER(isoformat);
143_Py_IDENTIFIER(strftime);
144
Tim Peters2a799bf2002-12-16 20:18:38 +0000145/* ---------------------------------------------------------------------------
146 * Math utilities.
147 */
148
149/* k = i+j overflows iff k differs in sign from both inputs,
150 * iff k^i has sign bit set and k^j has sign bit set,
151 * iff (k^i)&(k^j) has sign bit set.
152 */
153#define SIGNED_ADD_OVERFLOWED(RESULT, I, J) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000154 ((((RESULT) ^ (I)) & ((RESULT) ^ (J))) < 0)
Tim Peters2a799bf2002-12-16 20:18:38 +0000155
156/* Compute Python divmod(x, y), returning the quotient and storing the
157 * remainder into *r. The quotient is the floor of x/y, and that's
158 * the real point of this. C will probably truncate instead (C99
159 * requires truncation; C89 left it implementation-defined).
160 * Simplification: we *require* that y > 0 here. That's appropriate
161 * for all the uses made of it. This simplifies the code and makes
162 * the overflow case impossible (divmod(LONG_MIN, -1) is the only
163 * overflow case).
164 */
165static int
166divmod(int x, int y, int *r)
167{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000168 int quo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000169
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 assert(y > 0);
171 quo = x / y;
172 *r = x - quo * y;
173 if (*r < 0) {
174 --quo;
175 *r += y;
176 }
177 assert(0 <= *r && *r < y);
178 return quo;
Tim Peters2a799bf2002-12-16 20:18:38 +0000179}
180
Alexander Belopolsky1790bc42010-05-31 17:33:47 +0000181/* Nearest integer to m / n for integers m and n. Half-integer results
182 * are rounded to even.
183 */
184static PyObject *
185divide_nearest(PyObject *m, PyObject *n)
186{
187 PyObject *result;
188 PyObject *temp;
189
Mark Dickinsonfa68a612010-06-07 18:47:09 +0000190 temp = _PyLong_DivmodNear(m, n);
Alexander Belopolsky1790bc42010-05-31 17:33:47 +0000191 if (temp == NULL)
192 return NULL;
193 result = PyTuple_GET_ITEM(temp, 0);
194 Py_INCREF(result);
195 Py_DECREF(temp);
196
197 return result;
198}
199
Tim Peters2a799bf2002-12-16 20:18:38 +0000200/* ---------------------------------------------------------------------------
201 * General calendrical helper functions
202 */
203
204/* For each month ordinal in 1..12, the number of days in that month,
205 * and the number of days before that month in the same year. These
206 * are correct for non-leap years only.
207 */
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200208static const int _days_in_month[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000209 0, /* unused; this vector uses 1-based indexing */
210 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
Tim Peters2a799bf2002-12-16 20:18:38 +0000211};
212
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200213static const int _days_before_month[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000214 0, /* unused; this vector uses 1-based indexing */
215 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
Tim Peters2a799bf2002-12-16 20:18:38 +0000216};
217
218/* year -> 1 if leap year, else 0. */
219static int
220is_leap(int year)
221{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000222 /* Cast year to unsigned. The result is the same either way, but
223 * C can generate faster code for unsigned mod than for signed
224 * mod (especially for % 4 -- a good compiler should just grab
225 * the last 2 bits when the LHS is unsigned).
226 */
227 const unsigned int ayear = (unsigned int)year;
228 return ayear % 4 == 0 && (ayear % 100 != 0 || ayear % 400 == 0);
Tim Peters2a799bf2002-12-16 20:18:38 +0000229}
230
231/* year, month -> number of days in that month in that year */
232static int
233days_in_month(int year, int month)
234{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000235 assert(month >= 1);
236 assert(month <= 12);
237 if (month == 2 && is_leap(year))
238 return 29;
239 else
240 return _days_in_month[month];
Tim Peters2a799bf2002-12-16 20:18:38 +0000241}
242
Martin Panter46f50722016-05-26 05:35:26 +0000243/* year, month -> number of days in year preceding first day of month */
Tim Peters2a799bf2002-12-16 20:18:38 +0000244static int
245days_before_month(int year, int month)
246{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000247 int days;
Tim Peters2a799bf2002-12-16 20:18:38 +0000248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000249 assert(month >= 1);
250 assert(month <= 12);
251 days = _days_before_month[month];
252 if (month > 2 && is_leap(year))
253 ++days;
254 return days;
Tim Peters2a799bf2002-12-16 20:18:38 +0000255}
256
257/* year -> number of days before January 1st of year. Remember that we
258 * start with year 1, so days_before_year(1) == 0.
259 */
260static int
261days_before_year(int year)
262{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000263 int y = year - 1;
264 /* This is incorrect if year <= 0; we really want the floor
265 * here. But so long as MINYEAR is 1, the smallest year this
Alexander Belopolsky59a289d2010-10-13 22:54:34 +0000266 * can see is 1.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000267 */
Alexander Belopolsky59a289d2010-10-13 22:54:34 +0000268 assert (year >= 1);
269 return y*365 + y/4 - y/100 + y/400;
Tim Peters2a799bf2002-12-16 20:18:38 +0000270}
271
272/* Number of days in 4, 100, and 400 year cycles. That these have
273 * the correct values is asserted in the module init function.
274 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000275#define DI4Y 1461 /* days_before_year(5); days in 4 years */
276#define DI100Y 36524 /* days_before_year(101); days in 100 years */
277#define DI400Y 146097 /* days_before_year(401); days in 400 years */
Tim Peters2a799bf2002-12-16 20:18:38 +0000278
279/* ordinal -> year, month, day, considering 01-Jan-0001 as day 1. */
280static void
281ord_to_ymd(int ordinal, int *year, int *month, int *day)
282{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000283 int n, n1, n4, n100, n400, leapyear, preceding;
Tim Peters2a799bf2002-12-16 20:18:38 +0000284
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000285 /* ordinal is a 1-based index, starting at 1-Jan-1. The pattern of
286 * leap years repeats exactly every 400 years. The basic strategy is
287 * to find the closest 400-year boundary at or before ordinal, then
288 * work with the offset from that boundary to ordinal. Life is much
289 * clearer if we subtract 1 from ordinal first -- then the values
290 * of ordinal at 400-year boundaries are exactly those divisible
291 * by DI400Y:
292 *
293 * D M Y n n-1
294 * -- --- ---- ---------- ----------------
295 * 31 Dec -400 -DI400Y -DI400Y -1
296 * 1 Jan -399 -DI400Y +1 -DI400Y 400-year boundary
297 * ...
298 * 30 Dec 000 -1 -2
299 * 31 Dec 000 0 -1
300 * 1 Jan 001 1 0 400-year boundary
301 * 2 Jan 001 2 1
302 * 3 Jan 001 3 2
303 * ...
304 * 31 Dec 400 DI400Y DI400Y -1
305 * 1 Jan 401 DI400Y +1 DI400Y 400-year boundary
306 */
307 assert(ordinal >= 1);
308 --ordinal;
309 n400 = ordinal / DI400Y;
310 n = ordinal % DI400Y;
311 *year = n400 * 400 + 1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000312
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000313 /* Now n is the (non-negative) offset, in days, from January 1 of
314 * year, to the desired date. Now compute how many 100-year cycles
315 * precede n.
316 * Note that it's possible for n100 to equal 4! In that case 4 full
317 * 100-year cycles precede the desired day, which implies the
318 * desired day is December 31 at the end of a 400-year cycle.
319 */
320 n100 = n / DI100Y;
321 n = n % DI100Y;
Tim Peters2a799bf2002-12-16 20:18:38 +0000322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000323 /* Now compute how many 4-year cycles precede it. */
324 n4 = n / DI4Y;
325 n = n % DI4Y;
Tim Peters2a799bf2002-12-16 20:18:38 +0000326
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000327 /* And now how many single years. Again n1 can be 4, and again
328 * meaning that the desired day is December 31 at the end of the
329 * 4-year cycle.
330 */
331 n1 = n / 365;
332 n = n % 365;
Tim Peters2a799bf2002-12-16 20:18:38 +0000333
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000334 *year += n100 * 100 + n4 * 4 + n1;
335 if (n1 == 4 || n100 == 4) {
336 assert(n == 0);
337 *year -= 1;
338 *month = 12;
339 *day = 31;
340 return;
341 }
Tim Peters2a799bf2002-12-16 20:18:38 +0000342
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 /* Now the year is correct, and n is the offset from January 1. We
344 * find the month via an estimate that's either exact or one too
345 * large.
346 */
347 leapyear = n1 == 3 && (n4 != 24 || n100 == 3);
348 assert(leapyear == is_leap(*year));
349 *month = (n + 50) >> 5;
350 preceding = (_days_before_month[*month] + (*month > 2 && leapyear));
351 if (preceding > n) {
352 /* estimate is too large */
353 *month -= 1;
354 preceding -= days_in_month(*year, *month);
355 }
356 n -= preceding;
357 assert(0 <= n);
358 assert(n < days_in_month(*year, *month));
Tim Peters2a799bf2002-12-16 20:18:38 +0000359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000360 *day = n + 1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000361}
362
363/* year, month, day -> ordinal, considering 01-Jan-0001 as day 1. */
364static int
365ymd_to_ord(int year, int month, int day)
366{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 return days_before_year(year) + days_before_month(year, month) + day;
Tim Peters2a799bf2002-12-16 20:18:38 +0000368}
369
370/* Day of week, where Monday==0, ..., Sunday==6. 1/1/1 was a Monday. */
371static int
372weekday(int year, int month, int day)
373{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000374 return (ymd_to_ord(year, month, day) + 6) % 7;
Tim Peters2a799bf2002-12-16 20:18:38 +0000375}
376
377/* Ordinal of the Monday starting week 1 of the ISO year. Week 1 is the
378 * first calendar week containing a Thursday.
379 */
380static int
381iso_week1_monday(int year)
382{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000383 int first_day = ymd_to_ord(year, 1, 1); /* ord of 1/1 */
384 /* 0 if 1/1 is a Monday, 1 if a Tue, etc. */
385 int first_weekday = (first_day + 6) % 7;
386 /* ordinal of closest Monday at or before 1/1 */
387 int week1_monday = first_day - first_weekday;
Tim Peters2a799bf2002-12-16 20:18:38 +0000388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 if (first_weekday > 3) /* if 1/1 was Fri, Sat, Sun */
390 week1_monday += 7;
391 return week1_monday;
Tim Peters2a799bf2002-12-16 20:18:38 +0000392}
393
394/* ---------------------------------------------------------------------------
395 * Range checkers.
396 */
397
398/* Check that -MAX_DELTA_DAYS <= days <= MAX_DELTA_DAYS. If so, return 0.
399 * If not, raise OverflowError and return -1.
400 */
401static int
402check_delta_day_range(int days)
403{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 if (-MAX_DELTA_DAYS <= days && days <= MAX_DELTA_DAYS)
405 return 0;
406 PyErr_Format(PyExc_OverflowError,
407 "days=%d; must have magnitude <= %d",
408 days, MAX_DELTA_DAYS);
409 return -1;
Tim Peters2a799bf2002-12-16 20:18:38 +0000410}
411
412/* Check that date arguments are in range. Return 0 if they are. If they
413 * aren't, raise ValueError and return -1.
414 */
415static int
416check_date_args(int year, int month, int day)
417{
418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000419 if (year < MINYEAR || year > MAXYEAR) {
Victor Stinnerb67f0962017-02-10 10:34:02 +0100420 PyErr_Format(PyExc_ValueError, "year %i is out of range", year);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 return -1;
422 }
423 if (month < 1 || month > 12) {
424 PyErr_SetString(PyExc_ValueError,
425 "month must be in 1..12");
426 return -1;
427 }
428 if (day < 1 || day > days_in_month(year, month)) {
429 PyErr_SetString(PyExc_ValueError,
430 "day is out of range for month");
431 return -1;
432 }
433 return 0;
Tim Peters2a799bf2002-12-16 20:18:38 +0000434}
435
436/* Check that time arguments are in range. Return 0 if they are. If they
437 * aren't, raise ValueError and return -1.
438 */
439static int
Alexander Belopolsky47649ab2016-08-08 17:05:40 -0400440check_time_args(int h, int m, int s, int us, int fold)
Tim Peters2a799bf2002-12-16 20:18:38 +0000441{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 if (h < 0 || h > 23) {
443 PyErr_SetString(PyExc_ValueError,
444 "hour must be in 0..23");
445 return -1;
446 }
447 if (m < 0 || m > 59) {
448 PyErr_SetString(PyExc_ValueError,
449 "minute must be in 0..59");
450 return -1;
451 }
452 if (s < 0 || s > 59) {
453 PyErr_SetString(PyExc_ValueError,
454 "second must be in 0..59");
455 return -1;
456 }
457 if (us < 0 || us > 999999) {
458 PyErr_SetString(PyExc_ValueError,
459 "microsecond must be in 0..999999");
460 return -1;
461 }
Alexander Belopolsky47649ab2016-08-08 17:05:40 -0400462 if (fold != 0 && fold != 1) {
463 PyErr_SetString(PyExc_ValueError,
464 "fold must be either 0 or 1");
465 return -1;
466 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000467 return 0;
Tim Peters2a799bf2002-12-16 20:18:38 +0000468}
469
470/* ---------------------------------------------------------------------------
471 * Normalization utilities.
472 */
473
474/* One step of a mixed-radix conversion. A "hi" unit is equivalent to
475 * factor "lo" units. factor must be > 0. If *lo is less than 0, or
476 * at least factor, enough of *lo is converted into "hi" units so that
477 * 0 <= *lo < factor. The input values must be such that int overflow
478 * is impossible.
479 */
480static void
481normalize_pair(int *hi, int *lo, int factor)
482{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000483 assert(factor > 0);
484 assert(lo != hi);
485 if (*lo < 0 || *lo >= factor) {
486 const int num_hi = divmod(*lo, factor, lo);
487 const int new_hi = *hi + num_hi;
488 assert(! SIGNED_ADD_OVERFLOWED(new_hi, *hi, num_hi));
489 *hi = new_hi;
490 }
491 assert(0 <= *lo && *lo < factor);
Tim Peters2a799bf2002-12-16 20:18:38 +0000492}
493
494/* Fiddle days (d), seconds (s), and microseconds (us) so that
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 * 0 <= *s < 24*3600
496 * 0 <= *us < 1000000
Tim Peters2a799bf2002-12-16 20:18:38 +0000497 * The input values must be such that the internals don't overflow.
498 * The way this routine is used, we don't get close.
499 */
500static void
501normalize_d_s_us(int *d, int *s, int *us)
502{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000503 if (*us < 0 || *us >= 1000000) {
504 normalize_pair(s, us, 1000000);
505 /* |s| can't be bigger than about
506 * |original s| + |original us|/1000000 now.
507 */
Tim Peters2a799bf2002-12-16 20:18:38 +0000508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000509 }
510 if (*s < 0 || *s >= 24*3600) {
511 normalize_pair(d, s, 24*3600);
512 /* |d| can't be bigger than about
513 * |original d| +
514 * (|original s| + |original us|/1000000) / (24*3600) now.
515 */
516 }
517 assert(0 <= *s && *s < 24*3600);
518 assert(0 <= *us && *us < 1000000);
Tim Peters2a799bf2002-12-16 20:18:38 +0000519}
520
521/* Fiddle years (y), months (m), and days (d) so that
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 * 1 <= *m <= 12
523 * 1 <= *d <= days_in_month(*y, *m)
Tim Peters2a799bf2002-12-16 20:18:38 +0000524 * The input values must be such that the internals don't overflow.
525 * The way this routine is used, we don't get close.
526 */
Alexander Belopolskyf03a6162010-05-27 21:42:58 +0000527static int
Tim Peters2a799bf2002-12-16 20:18:38 +0000528normalize_y_m_d(int *y, int *m, int *d)
529{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 int dim; /* # of days in month */
Tim Peters2a799bf2002-12-16 20:18:38 +0000531
Alexander Belopolsky59a289d2010-10-13 22:54:34 +0000532 /* In actual use, m is always the month component extracted from a
533 * date/datetime object. Therefore it is always in [1, 12] range.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000534 */
Alexander Belopolsky59a289d2010-10-13 22:54:34 +0000535
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000536 assert(1 <= *m && *m <= 12);
Tim Peters2a799bf2002-12-16 20:18:38 +0000537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 /* Now only day can be out of bounds (year may also be out of bounds
539 * for a datetime object, but we don't care about that here).
540 * If day is out of bounds, what to do is arguable, but at least the
541 * method here is principled and explainable.
542 */
543 dim = days_in_month(*y, *m);
544 if (*d < 1 || *d > dim) {
545 /* Move day-1 days from the first of the month. First try to
546 * get off cheap if we're only one day out of range
547 * (adjustments for timezone alone can't be worse than that).
548 */
549 if (*d == 0) {
550 --*m;
551 if (*m > 0)
552 *d = days_in_month(*y, *m);
553 else {
554 --*y;
555 *m = 12;
556 *d = 31;
557 }
558 }
559 else if (*d == dim + 1) {
560 /* move forward a day */
561 ++*m;
562 *d = 1;
563 if (*m > 12) {
564 *m = 1;
565 ++*y;
566 }
567 }
568 else {
569 int ordinal = ymd_to_ord(*y, *m, 1) +
570 *d - 1;
Alexander Belopolskyf03a6162010-05-27 21:42:58 +0000571 if (ordinal < 1 || ordinal > MAXORDINAL) {
572 goto error;
573 } else {
574 ord_to_ymd(ordinal, y, m, d);
575 return 0;
576 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 }
578 }
579 assert(*m > 0);
580 assert(*d > 0);
Alexander Belopolskyf03a6162010-05-27 21:42:58 +0000581 if (MINYEAR <= *y && *y <= MAXYEAR)
582 return 0;
583 error:
584 PyErr_SetString(PyExc_OverflowError,
585 "date value out of range");
586 return -1;
587
Tim Peters2a799bf2002-12-16 20:18:38 +0000588}
589
590/* Fiddle out-of-bounds months and days so that the result makes some kind
591 * of sense. The parameters are both inputs and outputs. Returns < 0 on
592 * failure, where failure means the adjusted year is out of bounds.
593 */
594static int
595normalize_date(int *year, int *month, int *day)
596{
Alexander Belopolskyf03a6162010-05-27 21:42:58 +0000597 return normalize_y_m_d(year, month, day);
Tim Peters2a799bf2002-12-16 20:18:38 +0000598}
599
600/* Force all the datetime fields into range. The parameters are both
601 * inputs and outputs. Returns < 0 on error.
602 */
603static int
604normalize_datetime(int *year, int *month, int *day,
605 int *hour, int *minute, int *second,
606 int *microsecond)
607{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000608 normalize_pair(second, microsecond, 1000000);
609 normalize_pair(minute, second, 60);
610 normalize_pair(hour, minute, 60);
611 normalize_pair(day, hour, 24);
612 return normalize_date(year, month, day);
Tim Peters2a799bf2002-12-16 20:18:38 +0000613}
614
615/* ---------------------------------------------------------------------------
Tim Petersb0c854d2003-05-17 15:57:00 +0000616 * Basic object allocation: tp_alloc implementations. These allocate
617 * Python objects of the right size and type, and do the Python object-
618 * initialization bit. If there's not enough memory, they return NULL after
619 * setting MemoryError. All data members remain uninitialized trash.
620 *
621 * We abuse the tp_alloc "nitems" argument to communicate whether a tzinfo
Tim Peters03eaf8b2003-05-18 02:24:46 +0000622 * member is needed. This is ugly, imprecise, and possibly insecure.
623 * tp_basicsize for the time and datetime types is set to the size of the
624 * struct that has room for the tzinfo member, so subclasses in Python will
625 * allocate enough space for a tzinfo member whether or not one is actually
626 * needed. That's the "ugly and imprecise" parts. The "possibly insecure"
627 * part is that PyType_GenericAlloc() (which subclasses in Python end up
628 * using) just happens today to effectively ignore the nitems argument
629 * when tp_itemsize is 0, which it is for these type objects. If that
630 * changes, perhaps the callers of tp_alloc slots in this file should
631 * be changed to force a 0 nitems argument unless the type being allocated
632 * is a base type implemented in this file (so that tp_alloc is time_alloc
633 * or datetime_alloc below, which know about the nitems abuse).
Tim Petersb0c854d2003-05-17 15:57:00 +0000634 */
635
636static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000637time_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000638{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000639 PyObject *self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000640
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 self = (PyObject *)
642 PyObject_MALLOC(aware ?
643 sizeof(PyDateTime_Time) :
644 sizeof(_PyDateTime_BaseTime));
645 if (self == NULL)
646 return (PyObject *)PyErr_NoMemory();
Christian Heimesecb4e6a2013-12-04 09:34:29 +0100647 (void)PyObject_INIT(self, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000648 return self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000649}
650
651static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000652datetime_alloc(PyTypeObject *type, Py_ssize_t aware)
Tim Petersb0c854d2003-05-17 15:57:00 +0000653{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000654 PyObject *self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000656 self = (PyObject *)
657 PyObject_MALLOC(aware ?
658 sizeof(PyDateTime_DateTime) :
659 sizeof(_PyDateTime_BaseDateTime));
660 if (self == NULL)
661 return (PyObject *)PyErr_NoMemory();
Christian Heimesecb4e6a2013-12-04 09:34:29 +0100662 (void)PyObject_INIT(self, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000663 return self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000664}
665
666/* ---------------------------------------------------------------------------
667 * Helpers for setting object fields. These work on pointers to the
668 * appropriate base class.
669 */
670
671/* For date and datetime. */
672static void
673set_date_fields(PyDateTime_Date *self, int y, int m, int d)
674{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 self->hashcode = -1;
676 SET_YEAR(self, y);
677 SET_MONTH(self, m);
678 SET_DAY(self, d);
Tim Petersb0c854d2003-05-17 15:57:00 +0000679}
680
681/* ---------------------------------------------------------------------------
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500682 * String parsing utilities and helper functions
683 */
684
Paul Ganssle3df85402018-10-22 12:32:52 -0400685static const char *
686parse_digits(const char *ptr, int *var, size_t num_digits)
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500687{
688 for (size_t i = 0; i < num_digits; ++i) {
689 unsigned int tmp = (unsigned int)(*(ptr++) - '0');
690 if (tmp > 9) {
691 return NULL;
692 }
693 *var *= 10;
694 *var += (signed int)tmp;
695 }
696
697 return ptr;
698}
699
Paul Ganssle3df85402018-10-22 12:32:52 -0400700static int
701parse_isoformat_date(const char *dtstr, int *year, int *month, int *day)
702{
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500703 /* Parse the date components of the result of date.isoformat()
Paul Ganssle3df85402018-10-22 12:32:52 -0400704 *
705 * Return codes:
706 * 0: Success
707 * -1: Failed to parse date component
708 * -2: Failed to parse dateseparator
709 */
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500710 const char *p = dtstr;
711 p = parse_digits(p, year, 4);
712 if (NULL == p) {
713 return -1;
714 }
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100715
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500716 if (*(p++) != '-') {
717 return -2;
718 }
719
720 p = parse_digits(p, month, 2);
721 if (NULL == p) {
722 return -1;
723 }
724
725 if (*(p++) != '-') {
726 return -2;
727 }
728
729 p = parse_digits(p, day, 2);
730 if (p == NULL) {
731 return -1;
732 }
733
734 return 0;
735}
736
737static int
Paul Ganssle3df85402018-10-22 12:32:52 -0400738parse_hh_mm_ss_ff(const char *tstr, const char *tstr_end, int *hour,
739 int *minute, int *second, int *microsecond)
740{
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500741 const char *p = tstr;
742 const char *p_end = tstr_end;
743 int *vals[3] = {hour, minute, second};
744
745 // Parse [HH[:MM[:SS]]]
746 for (size_t i = 0; i < 3; ++i) {
747 p = parse_digits(p, vals[i], 2);
748 if (NULL == p) {
749 return -3;
750 }
751
752 char c = *(p++);
753 if (p >= p_end) {
754 return c != '\0';
Paul Ganssle3df85402018-10-22 12:32:52 -0400755 }
756 else if (c == ':') {
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500757 continue;
Paul Ganssle3df85402018-10-22 12:32:52 -0400758 }
759 else if (c == '.') {
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500760 break;
Paul Ganssle3df85402018-10-22 12:32:52 -0400761 }
762 else {
763 return -4; // Malformed time separator
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500764 }
765 }
766
767 // Parse .fff[fff]
768 size_t len_remains = p_end - p;
769 if (!(len_remains == 6 || len_remains == 3)) {
770 return -3;
771 }
772
773 p = parse_digits(p, microsecond, len_remains);
774 if (NULL == p) {
775 return -3;
776 }
777
778 if (len_remains == 3) {
779 *microsecond *= 1000;
780 }
781
782 // Return 1 if it's not the end of the string
783 return *p != '\0';
784}
785
786static int
Paul Ganssle3df85402018-10-22 12:32:52 -0400787parse_isoformat_time(const char *dtstr, size_t dtlen, int *hour, int *minute,
788 int *second, int *microsecond, int *tzoffset,
789 int *tzmicrosecond)
790{
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500791 // Parse the time portion of a datetime.isoformat() string
792 //
793 // Return codes:
794 // 0: Success (no tzoffset)
795 // 1: Success (with tzoffset)
796 // -3: Failed to parse time component
797 // -4: Failed to parse time separator
798 // -5: Malformed timezone string
799
800 const char *p = dtstr;
801 const char *p_end = dtstr + dtlen;
802
803 const char *tzinfo_pos = p;
804 do {
805 if (*tzinfo_pos == '+' || *tzinfo_pos == '-') {
806 break;
807 }
Paul Ganssle3df85402018-10-22 12:32:52 -0400808 } while (++tzinfo_pos < p_end);
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500809
Paul Ganssle3df85402018-10-22 12:32:52 -0400810 int rv = parse_hh_mm_ss_ff(dtstr, tzinfo_pos, hour, minute, second,
811 microsecond);
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500812
813 if (rv < 0) {
814 return rv;
Paul Ganssle3df85402018-10-22 12:32:52 -0400815 }
816 else if (tzinfo_pos == p_end) {
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500817 // We know that there's no time zone, so if there's stuff at the
818 // end of the string it's an error.
819 if (rv == 1) {
820 return -5;
Paul Ganssle3df85402018-10-22 12:32:52 -0400821 }
822 else {
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500823 return 0;
824 }
825 }
826
827 // Parse time zone component
828 // Valid formats are:
829 // - +HH:MM (len 6)
830 // - +HH:MM:SS (len 9)
831 // - +HH:MM:SS.ffffff (len 16)
832 size_t tzlen = p_end - tzinfo_pos;
833 if (!(tzlen == 6 || tzlen == 9 || tzlen == 16)) {
834 return -5;
835 }
836
Paul Ganssle3df85402018-10-22 12:32:52 -0400837 int tzsign = (*tzinfo_pos == '-') ? -1 : 1;
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500838 tzinfo_pos++;
839 int tzhour = 0, tzminute = 0, tzsecond = 0;
Paul Ganssle3df85402018-10-22 12:32:52 -0400840 rv = parse_hh_mm_ss_ff(tzinfo_pos, p_end, &tzhour, &tzminute, &tzsecond,
841 tzmicrosecond);
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500842
843 *tzoffset = tzsign * ((tzhour * 3600) + (tzminute * 60) + tzsecond);
844 *tzmicrosecond *= tzsign;
845
Paul Ganssle3df85402018-10-22 12:32:52 -0400846 return rv ? -5 : 1;
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500847}
848
Paul Ganssle09dc2f52017-12-21 00:33:49 -0500849/* ---------------------------------------------------------------------------
Tim Petersb0c854d2003-05-17 15:57:00 +0000850 * Create various objects, mostly without range checking.
851 */
852
853/* Create a date instance with no range checking. */
854static PyObject *
855new_date_ex(int year, int month, int day, PyTypeObject *type)
856{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 PyDateTime_Date *self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000858
Victor Stinnerb67f0962017-02-10 10:34:02 +0100859 if (check_date_args(year, month, day) < 0) {
860 return NULL;
861 }
862
Paul Ganssle3df85402018-10-22 12:32:52 -0400863 self = (PyDateTime_Date *)(type->tp_alloc(type, 0));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000864 if (self != NULL)
865 set_date_fields(self, year, month, day);
Paul Ganssle3df85402018-10-22 12:32:52 -0400866 return (PyObject *)self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000867}
868
869#define new_date(year, month, day) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 new_date_ex(year, month, day, &PyDateTime_DateType)
Tim Petersb0c854d2003-05-17 15:57:00 +0000871
Paul Ganssle9f1b7b92018-01-16 13:06:31 -0500872// Forward declaration
Paul Ganssle3df85402018-10-22 12:32:52 -0400873static PyObject *
874new_datetime_ex(int, int, int, int, int, int, int, PyObject *, PyTypeObject *);
Paul Ganssle9f1b7b92018-01-16 13:06:31 -0500875
876/* Create date instance with no range checking, or call subclass constructor */
877static PyObject *
Paul Ganssle3df85402018-10-22 12:32:52 -0400878new_date_subclass_ex(int year, int month, int day, PyObject *cls)
879{
Paul Ganssle9f1b7b92018-01-16 13:06:31 -0500880 PyObject *result;
881 // We have "fast path" constructors for two subclasses: date and datetime
882 if ((PyTypeObject *)cls == &PyDateTime_DateType) {
883 result = new_date_ex(year, month, day, (PyTypeObject *)cls);
Paul Ganssle3df85402018-10-22 12:32:52 -0400884 }
885 else if ((PyTypeObject *)cls == &PyDateTime_DateTimeType) {
Paul Ganssle9f1b7b92018-01-16 13:06:31 -0500886 result = new_datetime_ex(year, month, day, 0, 0, 0, 0, Py_None,
887 (PyTypeObject *)cls);
Paul Ganssle3df85402018-10-22 12:32:52 -0400888 }
889 else {
Paul Ganssle9f1b7b92018-01-16 13:06:31 -0500890 result = PyObject_CallFunction(cls, "iii", year, month, day);
891 }
892
893 return result;
894}
895
Tim Petersb0c854d2003-05-17 15:57:00 +0000896/* Create a datetime instance with no range checking. */
897static PyObject *
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -0400898new_datetime_ex2(int year, int month, int day, int hour, int minute,
899 int second, int usecond, PyObject *tzinfo, int fold, PyTypeObject *type)
Tim Petersb0c854d2003-05-17 15:57:00 +0000900{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000901 PyDateTime_DateTime *self;
902 char aware = tzinfo != Py_None;
Tim Petersb0c854d2003-05-17 15:57:00 +0000903
Victor Stinnerb67f0962017-02-10 10:34:02 +0100904 if (check_date_args(year, month, day) < 0) {
905 return NULL;
906 }
907 if (check_time_args(hour, minute, second, usecond, fold) < 0) {
908 return NULL;
909 }
910 if (check_tzinfo_subclass(tzinfo) < 0) {
911 return NULL;
912 }
913
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000914 self = (PyDateTime_DateTime *) (type->tp_alloc(type, aware));
915 if (self != NULL) {
916 self->hastzinfo = aware;
917 set_date_fields((PyDateTime_Date *)self, year, month, day);
918 DATE_SET_HOUR(self, hour);
919 DATE_SET_MINUTE(self, minute);
920 DATE_SET_SECOND(self, second);
921 DATE_SET_MICROSECOND(self, usecond);
922 if (aware) {
923 Py_INCREF(tzinfo);
924 self->tzinfo = tzinfo;
925 }
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -0400926 DATE_SET_FOLD(self, fold);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 }
928 return (PyObject *)self;
Tim Petersb0c854d2003-05-17 15:57:00 +0000929}
930
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -0400931static PyObject *
932new_datetime_ex(int year, int month, int day, int hour, int minute,
933 int second, int usecond, PyObject *tzinfo, PyTypeObject *type)
934{
935 return new_datetime_ex2(year, month, day, hour, minute, second, usecond,
936 tzinfo, 0, type);
937}
938
939#define new_datetime(y, m, d, hh, mm, ss, us, tzinfo, fold) \
940 new_datetime_ex2(y, m, d, hh, mm, ss, us, tzinfo, fold, \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 &PyDateTime_DateTimeType)
Tim Petersb0c854d2003-05-17 15:57:00 +0000942
Paul Ganssle9f1b7b92018-01-16 13:06:31 -0500943static PyObject *
944new_datetime_subclass_fold_ex(int year, int month, int day, int hour, int minute,
945 int second, int usecond, PyObject *tzinfo,
946 int fold, PyObject *cls) {
947 PyObject* dt;
948 if ((PyTypeObject*)cls == &PyDateTime_DateTimeType) {
949 // Use the fast path constructor
950 dt = new_datetime(year, month, day, hour, minute, second, usecond,
951 tzinfo, fold);
952 } else {
953 // Subclass
954 dt = PyObject_CallFunction(cls, "iiiiiiiO",
955 year,
956 month,
957 day,
958 hour,
959 minute,
960 second,
961 usecond,
962 tzinfo);
963 }
964
965 return dt;
966}
967
968static PyObject *
969new_datetime_subclass_ex(int year, int month, int day, int hour, int minute,
970 int second, int usecond, PyObject *tzinfo,
971 PyObject *cls) {
972 return new_datetime_subclass_fold_ex(year, month, day, hour, minute,
973 second, usecond, tzinfo, 0,
974 cls);
975}
976
Tim Petersb0c854d2003-05-17 15:57:00 +0000977/* Create a time instance with no range checking. */
978static PyObject *
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -0400979new_time_ex2(int hour, int minute, int second, int usecond,
980 PyObject *tzinfo, int fold, PyTypeObject *type)
Tim Petersb0c854d2003-05-17 15:57:00 +0000981{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 PyDateTime_Time *self;
983 char aware = tzinfo != Py_None;
Tim Petersb0c854d2003-05-17 15:57:00 +0000984
Victor Stinnerb67f0962017-02-10 10:34:02 +0100985 if (check_time_args(hour, minute, second, usecond, fold) < 0) {
986 return NULL;
987 }
988 if (check_tzinfo_subclass(tzinfo) < 0) {
989 return NULL;
990 }
991
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000992 self = (PyDateTime_Time *) (type->tp_alloc(type, aware));
993 if (self != NULL) {
994 self->hastzinfo = aware;
995 self->hashcode = -1;
996 TIME_SET_HOUR(self, hour);
997 TIME_SET_MINUTE(self, minute);
998 TIME_SET_SECOND(self, second);
999 TIME_SET_MICROSECOND(self, usecond);
1000 if (aware) {
1001 Py_INCREF(tzinfo);
1002 self->tzinfo = tzinfo;
1003 }
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04001004 TIME_SET_FOLD(self, fold);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001005 }
1006 return (PyObject *)self;
Tim Petersb0c854d2003-05-17 15:57:00 +00001007}
1008
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04001009static PyObject *
1010new_time_ex(int hour, int minute, int second, int usecond,
1011 PyObject *tzinfo, PyTypeObject *type)
1012{
1013 return new_time_ex2(hour, minute, second, usecond, tzinfo, 0, type);
1014}
1015
1016#define new_time(hh, mm, ss, us, tzinfo, fold) \
1017 new_time_ex2(hh, mm, ss, us, tzinfo, fold, &PyDateTime_TimeType)
Tim Petersb0c854d2003-05-17 15:57:00 +00001018
1019/* Create a timedelta instance. Normalize the members iff normalize is
1020 * true. Passing false is a speed optimization, if you know for sure
1021 * that seconds and microseconds are already in their proper ranges. In any
1022 * case, raises OverflowError and returns NULL if the normalized days is out
1023 * of range).
1024 */
1025static PyObject *
1026new_delta_ex(int days, int seconds, int microseconds, int normalize,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 PyTypeObject *type)
Tim Petersb0c854d2003-05-17 15:57:00 +00001028{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001029 PyDateTime_Delta *self;
Tim Petersb0c854d2003-05-17 15:57:00 +00001030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001031 if (normalize)
1032 normalize_d_s_us(&days, &seconds, &microseconds);
1033 assert(0 <= seconds && seconds < 24*3600);
1034 assert(0 <= microseconds && microseconds < 1000000);
Tim Petersb0c854d2003-05-17 15:57:00 +00001035
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 if (check_delta_day_range(days) < 0)
1037 return NULL;
Tim Petersb0c854d2003-05-17 15:57:00 +00001038
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001039 self = (PyDateTime_Delta *) (type->tp_alloc(type, 0));
1040 if (self != NULL) {
1041 self->hashcode = -1;
1042 SET_TD_DAYS(self, days);
1043 SET_TD_SECONDS(self, seconds);
1044 SET_TD_MICROSECONDS(self, microseconds);
1045 }
1046 return (PyObject *) self;
Tim Petersb0c854d2003-05-17 15:57:00 +00001047}
1048
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001049#define new_delta(d, s, us, normalize) \
1050 new_delta_ex(d, s, us, normalize, &PyDateTime_DeltaType)
Tim Petersb0c854d2003-05-17 15:57:00 +00001051
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00001052
1053typedef struct
1054{
1055 PyObject_HEAD
1056 PyObject *offset;
1057 PyObject *name;
1058} PyDateTime_TimeZone;
1059
Victor Stinner6ced7c42011-03-21 18:15:42 +01001060/* The interned UTC timezone instance */
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +00001061static PyObject *PyDateTime_TimeZone_UTC;
Alexander Belopolskya4415142012-06-08 12:33:09 -04001062/* The interned Epoch datetime instance */
1063static PyObject *PyDateTime_Epoch;
Alexander Belopolskya11d8c02010-07-06 23:19:45 +00001064
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00001065/* Create new timezone instance checking offset range. This
1066 function does not check the name argument. Caller must assure
1067 that offset is a timedelta instance and name is either NULL
1068 or a unicode object. */
1069static PyObject *
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +00001070create_timezone(PyObject *offset, PyObject *name)
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00001071{
1072 PyDateTime_TimeZone *self;
1073 PyTypeObject *type = &PyDateTime_TimeZoneType;
1074
1075 assert(offset != NULL);
1076 assert(PyDelta_Check(offset));
1077 assert(name == NULL || PyUnicode_Check(name));
1078
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +00001079 self = (PyDateTime_TimeZone *)(type->tp_alloc(type, 0));
1080 if (self == NULL) {
1081 return NULL;
1082 }
1083 Py_INCREF(offset);
1084 self->offset = offset;
1085 Py_XINCREF(name);
1086 self->name = name;
1087 return (PyObject *)self;
1088}
1089
1090static int delta_bool(PyDateTime_Delta *self);
1091
1092static PyObject *
1093new_timezone(PyObject *offset, PyObject *name)
1094{
1095 assert(offset != NULL);
1096 assert(PyDelta_Check(offset));
1097 assert(name == NULL || PyUnicode_Check(name));
1098
1099 if (name == NULL && delta_bool((PyDateTime_Delta *)offset) == 0) {
1100 Py_INCREF(PyDateTime_TimeZone_UTC);
1101 return PyDateTime_TimeZone_UTC;
1102 }
Ngalim Siregar92c7e302019-08-09 21:22:16 +07001103 if ((GET_TD_DAYS(offset) == -1 &&
1104 GET_TD_SECONDS(offset) == 0 &&
1105 GET_TD_MICROSECONDS(offset) < 1) ||
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00001106 GET_TD_DAYS(offset) < -1 || GET_TD_DAYS(offset) >= 1) {
1107 PyErr_Format(PyExc_ValueError, "offset must be a timedelta"
1108 " strictly between -timedelta(hours=24) and"
Alexander Belopolsky31227ca2012-06-22 13:23:21 -04001109 " timedelta(hours=24),"
1110 " not %R.", offset);
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00001111 return NULL;
1112 }
1113
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +00001114 return create_timezone(offset, name);
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00001115}
1116
Tim Petersb0c854d2003-05-17 15:57:00 +00001117/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +00001118 * tzinfo helpers.
1119 */
1120
Tim Peters855fe882002-12-22 03:43:39 +00001121/* Ensure that p is None or of a tzinfo subclass. Return 0 if OK; if not
1122 * raise TypeError and return -1.
1123 */
1124static int
1125check_tzinfo_subclass(PyObject *p)
1126{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001127 if (p == Py_None || PyTZInfo_Check(p))
1128 return 0;
1129 PyErr_Format(PyExc_TypeError,
1130 "tzinfo argument must be None or of a tzinfo subclass, "
1131 "not type '%s'",
1132 Py_TYPE(p)->tp_name);
1133 return -1;
Tim Peters855fe882002-12-22 03:43:39 +00001134}
1135
Tim Peters2a799bf2002-12-16 20:18:38 +00001136/* If self has a tzinfo member, return a BORROWED reference to it. Else
1137 * return NULL, which is NOT AN ERROR. There are no error returns here,
1138 * and the caller must not decref the result.
1139 */
1140static PyObject *
1141get_tzinfo_member(PyObject *self)
1142{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001143 PyObject *tzinfo = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001145 if (PyDateTime_Check(self) && HASTZINFO(self))
1146 tzinfo = ((PyDateTime_DateTime *)self)->tzinfo;
1147 else if (PyTime_Check(self) && HASTZINFO(self))
1148 tzinfo = ((PyDateTime_Time *)self)->tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +00001149
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001150 return tzinfo;
Tim Peters2a799bf2002-12-16 20:18:38 +00001151}
1152
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001153/* Call getattr(tzinfo, name)(tzinfoarg), and check the result. tzinfo must
1154 * be an instance of the tzinfo class. If the method returns None, this
1155 * returns None. If the method doesn't return None or timedelta, TypeError is
1156 * raised and this returns NULL. If it returns a timedelta and the value is
1157 * out of range or isn't a whole number of minutes, ValueError is raised and
1158 * this returns NULL. Else result is returned.
Tim Peters2a799bf2002-12-16 20:18:38 +00001159 */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001160static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001161call_tzinfo_method(PyObject *tzinfo, const char *name, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001162{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001163 PyObject *offset;
Tim Peters2a799bf2002-12-16 20:18:38 +00001164
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001165 assert(tzinfo != NULL);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001166 assert(PyTZInfo_Check(tzinfo) || tzinfo == Py_None);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001167 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001168
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001169 if (tzinfo == Py_None)
1170 Py_RETURN_NONE;
1171 offset = PyObject_CallMethod(tzinfo, name, "O", tzinfoarg);
1172 if (offset == Py_None || offset == NULL)
1173 return offset;
1174 if (PyDelta_Check(offset)) {
Ngalim Siregar92c7e302019-08-09 21:22:16 +07001175 if ((GET_TD_DAYS(offset) == -1 &&
1176 GET_TD_SECONDS(offset) == 0 &&
1177 GET_TD_MICROSECONDS(offset) < 1) ||
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001178 GET_TD_DAYS(offset) < -1 || GET_TD_DAYS(offset) >= 1) {
1179 Py_DECREF(offset);
1180 PyErr_Format(PyExc_ValueError, "offset must be a timedelta"
1181 " strictly between -timedelta(hours=24) and"
1182 " timedelta(hours=24).");
1183 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001184 }
1185 }
1186 else {
1187 PyErr_Format(PyExc_TypeError,
1188 "tzinfo.%s() must return None or "
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001189 "timedelta, not '%.200s'",
1190 name, Py_TYPE(offset)->tp_name);
Raymond Hettinger5a2146a2014-07-25 14:59:48 -07001191 Py_DECREF(offset);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001192 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001193 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001194
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001195 return offset;
Tim Peters2a799bf2002-12-16 20:18:38 +00001196}
1197
1198/* Call tzinfo.utcoffset(tzinfoarg), and extract an integer from the
1199 * result. tzinfo must be an instance of the tzinfo class. If utcoffset()
1200 * returns None, call_utcoffset returns 0 and sets *none to 1. If uctoffset()
Tim Peters397301e2003-01-02 21:28:08 +00001201 * doesn't return None or timedelta, TypeError is raised and this returns -1.
Alexander Belopolsky018d3532017-07-31 10:26:50 -04001202 * If utcoffset() returns an out of range timedelta,
1203 * ValueError is raised and this returns -1. Else *none is
1204 * set to 0 and the offset is returned (as timedelta, positive east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +00001205 */
Tim Peters855fe882002-12-22 03:43:39 +00001206static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001207call_utcoffset(PyObject *tzinfo, PyObject *tzinfoarg)
1208{
1209 return call_tzinfo_method(tzinfo, "utcoffset", tzinfoarg);
Tim Peters855fe882002-12-22 03:43:39 +00001210}
1211
Tim Peters2a799bf2002-12-16 20:18:38 +00001212/* Call tzinfo.dst(tzinfoarg), and extract an integer from the
1213 * result. tzinfo must be an instance of the tzinfo class. If dst()
1214 * returns None, call_dst returns 0 and sets *none to 1. If dst()
Alexander Belopolsky018d3532017-07-31 10:26:50 -04001215 * doesn't return None or timedelta, TypeError is raised and this
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00001216 * returns -1. If dst() returns an invalid timedelta for a UTC offset,
Tim Peters397301e2003-01-02 21:28:08 +00001217 * ValueError is raised and this returns -1. Else *none is set to 0 and
Alexander Belopolsky018d3532017-07-31 10:26:50 -04001218 * the offset is returned (as timedelta, positive east of UTC).
Tim Peters2a799bf2002-12-16 20:18:38 +00001219 */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001220static PyObject *
1221call_dst(PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001222{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001223 return call_tzinfo_method(tzinfo, "dst", tzinfoarg);
Tim Peters2a799bf2002-12-16 20:18:38 +00001224}
1225
Tim Petersbad8ff02002-12-30 20:52:32 +00001226/* Call tzinfo.tzname(tzinfoarg), and return the result. tzinfo must be
Tim Peters855fe882002-12-22 03:43:39 +00001227 * an instance of the tzinfo class or None. If tzinfo isn't None, and
Tim Petersbad8ff02002-12-30 20:52:32 +00001228 * tzname() doesn't return None or a string, TypeError is raised and this
Guido van Rossume3d1d412007-05-23 21:24:35 +00001229 * returns NULL. If the result is a string, we ensure it is a Unicode
1230 * string.
Tim Peters2a799bf2002-12-16 20:18:38 +00001231 */
1232static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +00001233call_tzname(PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001234{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001235 PyObject *result;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001236 _Py_IDENTIFIER(tzname);
Tim Peters2a799bf2002-12-16 20:18:38 +00001237
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 assert(tzinfo != NULL);
1239 assert(check_tzinfo_subclass(tzinfo) >= 0);
1240 assert(tzinfoarg != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00001241
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001242 if (tzinfo == Py_None)
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001243 Py_RETURN_NONE;
Tim Peters2a799bf2002-12-16 20:18:38 +00001244
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02001245 result = _PyObject_CallMethodIdOneArg(tzinfo, &PyId_tzname, tzinfoarg);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001246
1247 if (result == NULL || result == Py_None)
1248 return result;
1249
1250 if (!PyUnicode_Check(result)) {
1251 PyErr_Format(PyExc_TypeError, "tzinfo.tzname() must "
1252 "return None or a string, not '%s'",
1253 Py_TYPE(result)->tp_name);
1254 Py_DECREF(result);
1255 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001256 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001257
1258 return result;
Tim Peters00237032002-12-27 02:21:51 +00001259}
1260
Tim Peters2a799bf2002-12-16 20:18:38 +00001261/* repr is like "someclass(arg1, arg2)". If tzinfo isn't None,
1262 * stuff
1263 * ", tzinfo=" + repr(tzinfo)
1264 * before the closing ")".
1265 */
1266static PyObject *
1267append_keyword_tzinfo(PyObject *repr, PyObject *tzinfo)
1268{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 PyObject *temp;
Tim Peters2a799bf2002-12-16 20:18:38 +00001270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 assert(PyUnicode_Check(repr));
1272 assert(tzinfo);
1273 if (tzinfo == Py_None)
1274 return repr;
1275 /* Get rid of the trailing ')'. */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001276 assert(PyUnicode_READ_CHAR(repr, PyUnicode_GET_LENGTH(repr)-1) == ')');
1277 temp = PyUnicode_Substring(repr, 0, PyUnicode_GET_LENGTH(repr) - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001278 Py_DECREF(repr);
1279 if (temp == NULL)
1280 return NULL;
1281 repr = PyUnicode_FromFormat("%U, tzinfo=%R)", temp, tzinfo);
1282 Py_DECREF(temp);
1283 return repr;
Tim Peters2a799bf2002-12-16 20:18:38 +00001284}
1285
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04001286/* repr is like "someclass(arg1, arg2)". If fold isn't 0,
1287 * stuff
1288 * ", fold=" + repr(tzinfo)
1289 * before the closing ")".
1290 */
1291static PyObject *
1292append_keyword_fold(PyObject *repr, int fold)
1293{
1294 PyObject *temp;
1295
1296 assert(PyUnicode_Check(repr));
1297 if (fold == 0)
1298 return repr;
1299 /* Get rid of the trailing ')'. */
1300 assert(PyUnicode_READ_CHAR(repr, PyUnicode_GET_LENGTH(repr)-1) == ')');
1301 temp = PyUnicode_Substring(repr, 0, PyUnicode_GET_LENGTH(repr) - 1);
1302 Py_DECREF(repr);
1303 if (temp == NULL)
1304 return NULL;
1305 repr = PyUnicode_FromFormat("%U, fold=%d)", temp, fold);
1306 Py_DECREF(temp);
1307 return repr;
1308}
1309
Paul Ganssle09dc2f52017-12-21 00:33:49 -05001310static inline PyObject *
Paul Ganssle3df85402018-10-22 12:32:52 -04001311tzinfo_from_isoformat_results(int rv, int tzoffset, int tz_useconds)
1312{
Paul Ganssle09dc2f52017-12-21 00:33:49 -05001313 PyObject *tzinfo;
1314 if (rv == 1) {
1315 // Create a timezone from offset in seconds (0 returns UTC)
1316 if (tzoffset == 0) {
1317 Py_INCREF(PyDateTime_TimeZone_UTC);
1318 return PyDateTime_TimeZone_UTC;
1319 }
1320
1321 PyObject *delta = new_delta(0, tzoffset, tz_useconds, 1);
Alexey Izbyshev49884532018-08-24 18:53:16 +03001322 if (delta == NULL) {
1323 return NULL;
1324 }
Paul Ganssle09dc2f52017-12-21 00:33:49 -05001325 tzinfo = new_timezone(delta, NULL);
Alexey Izbyshev49884532018-08-24 18:53:16 +03001326 Py_DECREF(delta);
Paul Ganssle3df85402018-10-22 12:32:52 -04001327 }
1328 else {
Paul Ganssle09dc2f52017-12-21 00:33:49 -05001329 tzinfo = Py_None;
1330 Py_INCREF(Py_None);
1331 }
1332
1333 return tzinfo;
1334}
1335
Tim Peters2a799bf2002-12-16 20:18:38 +00001336/* ---------------------------------------------------------------------------
1337 * String format helpers.
1338 */
1339
1340static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00001341format_ctime(PyDateTime_Date *date, int hours, int minutes, int seconds)
Tim Peters2a799bf2002-12-16 20:18:38 +00001342{
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02001343 static const char * const DayNames[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"
1345 };
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02001346 static const char * const MonthNames[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
1348 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
1349 };
Tim Peters2a799bf2002-12-16 20:18:38 +00001350
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001351 int wday = weekday(GET_YEAR(date), GET_MONTH(date), GET_DAY(date));
Tim Peters2a799bf2002-12-16 20:18:38 +00001352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 return PyUnicode_FromFormat("%s %s %2d %02d:%02d:%02d %04d",
1354 DayNames[wday], MonthNames[GET_MONTH(date)-1],
1355 GET_DAY(date), hours, minutes, seconds,
1356 GET_YEAR(date));
Tim Peters2a799bf2002-12-16 20:18:38 +00001357}
1358
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001359static PyObject *delta_negative(PyDateTime_Delta *self);
1360
Alexander Belopolsky018d3532017-07-31 10:26:50 -04001361/* Add formatted UTC offset string to buf. buf has no more than
Tim Peters2a799bf2002-12-16 20:18:38 +00001362 * buflen bytes remaining. The UTC offset is gotten by calling
1363 * tzinfo.uctoffset(tzinfoarg). If that returns None, \0 is stored into
1364 * *buf, and that's all. Else the returned value is checked for sanity (an
1365 * integer in range), and if that's OK it's converted to an hours & minutes
1366 * string of the form
Alexander Belopolsky018d3532017-07-31 10:26:50 -04001367 * sign HH sep MM [sep SS [. UUUUUU]]
Tim Peters2a799bf2002-12-16 20:18:38 +00001368 * Returns 0 if everything is OK. If the return value from utcoffset() is
1369 * bogus, an appropriate exception is set and -1 is returned.
1370 */
1371static int
Tim Peters328fff72002-12-20 01:31:27 +00001372format_utcoffset(char *buf, size_t buflen, const char *sep,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001373 PyObject *tzinfo, PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001374{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001375 PyObject *offset;
Alexander Belopolsky018d3532017-07-31 10:26:50 -04001376 int hours, minutes, seconds, microseconds;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 char sign;
Tim Peters2a799bf2002-12-16 20:18:38 +00001378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 assert(buflen >= 1);
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +00001380
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001381 offset = call_utcoffset(tzinfo, tzinfoarg);
1382 if (offset == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001383 return -1;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001384 if (offset == Py_None) {
1385 Py_DECREF(offset);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001386 *buf = '\0';
1387 return 0;
1388 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001389 /* Offset is normalized, so it is negative if days < 0 */
1390 if (GET_TD_DAYS(offset) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 sign = '-';
Serhiy Storchakaf01e4082016-04-10 18:12:01 +03001392 Py_SETREF(offset, delta_negative((PyDateTime_Delta *)offset));
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001393 if (offset == NULL)
1394 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001396 else {
1397 sign = '+';
1398 }
1399 /* Offset is not negative here. */
Alexander Belopolsky018d3532017-07-31 10:26:50 -04001400 microseconds = GET_TD_MICROSECONDS(offset);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00001401 seconds = GET_TD_SECONDS(offset);
1402 Py_DECREF(offset);
1403 minutes = divmod(seconds, 60, &seconds);
1404 hours = divmod(minutes, 60, &minutes);
Alexander Belopolsky018d3532017-07-31 10:26:50 -04001405 if (microseconds) {
1406 PyOS_snprintf(buf, buflen, "%c%02d%s%02d%s%02d.%06d", sign,
1407 hours, sep, minutes, sep, seconds, microseconds);
1408 return 0;
1409 }
1410 if (seconds) {
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04001411 PyOS_snprintf(buf, buflen, "%c%02d%s%02d%s%02d", sign, hours,
1412 sep, minutes, sep, seconds);
Alexander Belopolsky018d3532017-07-31 10:26:50 -04001413 return 0;
1414 }
1415 PyOS_snprintf(buf, buflen, "%c%02d%s%02d", sign, hours, sep, minutes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 return 0;
Tim Peters2a799bf2002-12-16 20:18:38 +00001417}
1418
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001419static PyObject *
1420make_Zreplacement(PyObject *object, PyObject *tzinfoarg)
1421{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 PyObject *temp;
1423 PyObject *tzinfo = get_tzinfo_member(object);
1424 PyObject *Zreplacement = PyUnicode_FromStringAndSize(NULL, 0);
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001425 _Py_IDENTIFIER(replace);
Victor Stinner9e30aa52011-11-21 02:49:52 +01001426
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 if (Zreplacement == NULL)
1428 return NULL;
1429 if (tzinfo == Py_None || tzinfo == NULL)
1430 return Zreplacement;
Neal Norwitzaea70e02007-08-12 04:32:26 +00001431
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 assert(tzinfoarg != NULL);
1433 temp = call_tzname(tzinfo, tzinfoarg);
1434 if (temp == NULL)
1435 goto Error;
1436 if (temp == Py_None) {
1437 Py_DECREF(temp);
1438 return Zreplacement;
1439 }
Neal Norwitzaea70e02007-08-12 04:32:26 +00001440
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 assert(PyUnicode_Check(temp));
1442 /* Since the tzname is getting stuffed into the
1443 * format, we have to double any % signs so that
1444 * strftime doesn't treat them as format codes.
1445 */
1446 Py_DECREF(Zreplacement);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001447 Zreplacement = _PyObject_CallMethodId(temp, &PyId_replace, "ss", "%", "%%");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 Py_DECREF(temp);
1449 if (Zreplacement == NULL)
1450 return NULL;
1451 if (!PyUnicode_Check(Zreplacement)) {
1452 PyErr_SetString(PyExc_TypeError,
1453 "tzname.replace() did not return a string");
1454 goto Error;
1455 }
1456 return Zreplacement;
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001457
1458 Error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001459 Py_DECREF(Zreplacement);
1460 return NULL;
Guido van Rossumd8595fe2007-05-23 21:36:49 +00001461}
1462
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001463static PyObject *
1464make_freplacement(PyObject *object)
1465{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 char freplacement[64];
1467 if (PyTime_Check(object))
1468 sprintf(freplacement, "%06d", TIME_GET_MICROSECOND(object));
1469 else if (PyDateTime_Check(object))
1470 sprintf(freplacement, "%06d", DATE_GET_MICROSECOND(object));
1471 else
1472 sprintf(freplacement, "%06d", 0);
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 return PyBytes_FromStringAndSize(freplacement, strlen(freplacement));
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001475}
1476
Tim Peters2a799bf2002-12-16 20:18:38 +00001477/* I sure don't want to reproduce the strftime code from the time module,
1478 * so this imports the module and calls it. All the hair is due to
Christian Heimesdd15f6c2008-03-16 00:07:10 +00001479 * giving special meanings to the %z, %Z and %f format codes via a
1480 * preprocessing step on the format string.
Tim Petersbad8ff02002-12-30 20:52:32 +00001481 * tzinfoarg is the argument to pass to the object's tzinfo method, if
1482 * needed.
Tim Peters2a799bf2002-12-16 20:18:38 +00001483 */
1484static PyObject *
Tim Petersbad8ff02002-12-30 20:52:32 +00001485wrap_strftime(PyObject *object, PyObject *format, PyObject *timetuple,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001486 PyObject *tzinfoarg)
Tim Peters2a799bf2002-12-16 20:18:38 +00001487{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001488 PyObject *result = NULL; /* guilty until proved innocent */
Tim Peters2a799bf2002-12-16 20:18:38 +00001489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 PyObject *zreplacement = NULL; /* py string, replacement for %z */
1491 PyObject *Zreplacement = NULL; /* py string, replacement for %Z */
1492 PyObject *freplacement = NULL; /* py string, replacement for %f */
Tim Peters2a799bf2002-12-16 20:18:38 +00001493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001494 const char *pin; /* pointer to next char in input format */
1495 Py_ssize_t flen; /* length of input format */
1496 char ch; /* next char in input format */
Tim Peters2a799bf2002-12-16 20:18:38 +00001497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 PyObject *newfmt = NULL; /* py string, the output format */
1499 char *pnew; /* pointer to available byte in output format */
1500 size_t totalnew; /* number bytes total in output format buffer,
1501 exclusive of trailing \0 */
1502 size_t usednew; /* number bytes used so far in output format buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001503
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 const char *ptoappend; /* ptr to string to append to output buffer */
1505 Py_ssize_t ntoappend; /* # of bytes to append to output buffer */
Tim Peters2a799bf2002-12-16 20:18:38 +00001506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001507 assert(object && format && timetuple);
1508 assert(PyUnicode_Check(format));
1509 /* Convert the input format to a C string and size */
Serhiy Storchaka06515832016-11-20 09:13:07 +02001510 pin = PyUnicode_AsUTF8AndSize(format, &flen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001511 if (!pin)
1512 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001514 /* Scan the input format, looking for %z/%Z/%f escapes, building
1515 * a new format. Since computing the replacements for those codes
1516 * is expensive, don't unless they're actually used.
1517 */
1518 if (flen > INT_MAX - 1) {
1519 PyErr_NoMemory();
1520 goto Done;
1521 }
Amaury Forgeot d'Arc9c74b142008-06-18 00:47:36 +00001522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 totalnew = flen + 1; /* realistic if no %z/%Z */
1524 newfmt = PyBytes_FromStringAndSize(NULL, totalnew);
1525 if (newfmt == NULL) goto Done;
1526 pnew = PyBytes_AsString(newfmt);
1527 usednew = 0;
Tim Peters2a799bf2002-12-16 20:18:38 +00001528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 while ((ch = *pin++) != '\0') {
1530 if (ch != '%') {
1531 ptoappend = pin - 1;
1532 ntoappend = 1;
1533 }
1534 else if ((ch = *pin++) == '\0') {
Victor Stinner2ff58a22019-06-17 14:27:23 +02001535 /* Null byte follows %, copy only '%'.
1536 *
MichaelSaah454b3d42019-01-14 05:23:39 -05001537 * Back the pin up one char so that we catch the null check
1538 * the next time through the loop.*/
1539 pin--;
1540 ptoappend = pin - 1;
1541 ntoappend = 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 }
1543 /* A % has been seen and ch is the character after it. */
1544 else if (ch == 'z') {
1545 if (zreplacement == NULL) {
1546 /* format utcoffset */
1547 char buf[100];
1548 PyObject *tzinfo = get_tzinfo_member(object);
1549 zreplacement = PyBytes_FromStringAndSize("", 0);
1550 if (zreplacement == NULL) goto Done;
1551 if (tzinfo != Py_None && tzinfo != NULL) {
1552 assert(tzinfoarg != NULL);
1553 if (format_utcoffset(buf,
1554 sizeof(buf),
1555 "",
1556 tzinfo,
1557 tzinfoarg) < 0)
1558 goto Done;
1559 Py_DECREF(zreplacement);
1560 zreplacement =
1561 PyBytes_FromStringAndSize(buf,
1562 strlen(buf));
1563 if (zreplacement == NULL)
1564 goto Done;
1565 }
1566 }
1567 assert(zreplacement != NULL);
1568 ptoappend = PyBytes_AS_STRING(zreplacement);
1569 ntoappend = PyBytes_GET_SIZE(zreplacement);
1570 }
1571 else if (ch == 'Z') {
1572 /* format tzname */
1573 if (Zreplacement == NULL) {
1574 Zreplacement = make_Zreplacement(object,
1575 tzinfoarg);
1576 if (Zreplacement == NULL)
1577 goto Done;
1578 }
1579 assert(Zreplacement != NULL);
1580 assert(PyUnicode_Check(Zreplacement));
Serhiy Storchaka06515832016-11-20 09:13:07 +02001581 ptoappend = PyUnicode_AsUTF8AndSize(Zreplacement,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001582 &ntoappend);
Alexander Belopolskye239d232010-12-08 23:31:48 +00001583 if (ptoappend == NULL)
1584 goto Done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 }
1586 else if (ch == 'f') {
1587 /* format microseconds */
1588 if (freplacement == NULL) {
1589 freplacement = make_freplacement(object);
1590 if (freplacement == NULL)
1591 goto Done;
1592 }
1593 assert(freplacement != NULL);
1594 assert(PyBytes_Check(freplacement));
1595 ptoappend = PyBytes_AS_STRING(freplacement);
1596 ntoappend = PyBytes_GET_SIZE(freplacement);
1597 }
1598 else {
1599 /* percent followed by neither z nor Z */
1600 ptoappend = pin - 2;
1601 ntoappend = 2;
1602 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 /* Append the ntoappend chars starting at ptoappend to
1605 * the new format.
1606 */
1607 if (ntoappend == 0)
1608 continue;
1609 assert(ptoappend != NULL);
1610 assert(ntoappend > 0);
1611 while (usednew + ntoappend > totalnew) {
Mark Dickinsonc04ddff2012-10-06 18:04:49 +01001612 if (totalnew > (PY_SSIZE_T_MAX >> 1)) { /* overflow */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 PyErr_NoMemory();
1614 goto Done;
1615 }
Mark Dickinsonc04ddff2012-10-06 18:04:49 +01001616 totalnew <<= 1;
1617 if (_PyBytes_Resize(&newfmt, totalnew) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001618 goto Done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001619 pnew = PyBytes_AsString(newfmt) + usednew;
1620 }
1621 memcpy(pnew, ptoappend, ntoappend);
1622 pnew += ntoappend;
1623 usednew += ntoappend;
1624 assert(usednew <= totalnew);
1625 } /* end while() */
Victor Stinner2ff58a22019-06-17 14:27:23 +02001626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 if (_PyBytes_Resize(&newfmt, usednew) < 0)
1628 goto Done;
1629 {
1630 PyObject *format;
1631 PyObject *time = PyImport_ImportModuleNoBlock("time");
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 if (time == NULL)
1634 goto Done;
1635 format = PyUnicode_FromString(PyBytes_AS_STRING(newfmt));
1636 if (format != NULL) {
Victor Stinner20401de2016-12-09 15:24:31 +01001637 result = _PyObject_CallMethodIdObjArgs(time, &PyId_strftime,
1638 format, timetuple, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001639 Py_DECREF(format);
1640 }
1641 Py_DECREF(time);
1642 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001643 Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001644 Py_XDECREF(freplacement);
1645 Py_XDECREF(zreplacement);
1646 Py_XDECREF(Zreplacement);
1647 Py_XDECREF(newfmt);
1648 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001649}
1650
Tim Peters2a799bf2002-12-16 20:18:38 +00001651/* ---------------------------------------------------------------------------
1652 * Wrap functions from the time module. These aren't directly available
1653 * from C. Perhaps they should be.
1654 */
1655
1656/* Call time.time() and return its result (a Python float). */
1657static PyObject *
Guido van Rossumbd43e912002-12-16 20:34:55 +00001658time_time(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00001659{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001660 PyObject *result = NULL;
1661 PyObject *time = PyImport_ImportModuleNoBlock("time");
Tim Peters2a799bf2002-12-16 20:18:38 +00001662
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001663 if (time != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001664 _Py_IDENTIFIER(time);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001665
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001666 result = _PyObject_CallMethodIdNoArgs(time, &PyId_time);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 Py_DECREF(time);
1668 }
1669 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001670}
1671
1672/* Build a time.struct_time. The weekday and day number are automatically
1673 * computed from the y,m,d args.
1674 */
1675static PyObject *
1676build_struct_time(int y, int m, int d, int hh, int mm, int ss, int dstflag)
1677{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001678 PyObject *time;
Victor Stinner2b635972016-12-09 00:38:16 +01001679 PyObject *result;
1680 _Py_IDENTIFIER(struct_time);
1681 PyObject *args;
1682
Tim Peters2a799bf2002-12-16 20:18:38 +00001683
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001684 time = PyImport_ImportModuleNoBlock("time");
Victor Stinner2b635972016-12-09 00:38:16 +01001685 if (time == NULL) {
1686 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001687 }
Victor Stinner2b635972016-12-09 00:38:16 +01001688
1689 args = Py_BuildValue("iiiiiiiii",
1690 y, m, d,
1691 hh, mm, ss,
1692 weekday(y, m, d),
1693 days_before_month(y, m) + d,
1694 dstflag);
1695 if (args == NULL) {
1696 Py_DECREF(time);
1697 return NULL;
1698 }
1699
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02001700 result = _PyObject_CallMethodIdOneArg(time, &PyId_struct_time, args);
Victor Stinner2b635972016-12-09 00:38:16 +01001701 Py_DECREF(time);
Victor Stinnerddc120f2016-12-09 15:35:40 +01001702 Py_DECREF(args);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001703 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001704}
1705
1706/* ---------------------------------------------------------------------------
1707 * Miscellaneous helpers.
1708 */
1709
Jeroen Demeyer530f5062019-05-31 04:13:39 +02001710/* The comparisons here all most naturally compute a cmp()-like result.
Tim Peters2a799bf2002-12-16 20:18:38 +00001711 * This little helper turns that into a bool result for rich comparisons.
1712 */
1713static PyObject *
1714diff_to_bool(int diff, int op)
1715{
stratakise8b19652017-11-02 11:32:54 +01001716 Py_RETURN_RICHCOMPARE(diff, 0, op);
Tim Peters2a799bf2002-12-16 20:18:38 +00001717}
1718
Tim Peters07534a62003-02-07 22:50:28 +00001719/* Raises a "can't compare" TypeError and returns NULL. */
1720static PyObject *
1721cmperror(PyObject *a, PyObject *b)
1722{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001723 PyErr_Format(PyExc_TypeError,
1724 "can't compare %s to %s",
1725 Py_TYPE(a)->tp_name, Py_TYPE(b)->tp_name);
1726 return NULL;
Tim Peters07534a62003-02-07 22:50:28 +00001727}
1728
Tim Peters2a799bf2002-12-16 20:18:38 +00001729/* ---------------------------------------------------------------------------
Tim Peters2a799bf2002-12-16 20:18:38 +00001730 * Cached Python objects; these are set by the module init function.
1731 */
1732
1733/* Conversion factors. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734static PyObject *us_per_ms = NULL; /* 1000 */
1735static PyObject *us_per_second = NULL; /* 1000000 */
1736static PyObject *us_per_minute = NULL; /* 1e6 * 60 as Python int */
Serhiy Storchaka95949422013-08-27 19:40:23 +03001737static PyObject *us_per_hour = NULL; /* 1e6 * 3600 as Python int */
1738static PyObject *us_per_day = NULL; /* 1e6 * 3600 * 24 as Python int */
1739static PyObject *us_per_week = NULL; /* 1e6*3600*24*7 as Python int */
Tim Peters2a799bf2002-12-16 20:18:38 +00001740static PyObject *seconds_per_day = NULL; /* 3600*24 as Python int */
1741
Tim Peters2a799bf2002-12-16 20:18:38 +00001742/* ---------------------------------------------------------------------------
1743 * Class implementations.
1744 */
1745
1746/*
1747 * PyDateTime_Delta implementation.
1748 */
1749
1750/* Convert a timedelta to a number of us,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001751 * (24*3600*self.days + self.seconds)*1000000 + self.microseconds
Serhiy Storchaka95949422013-08-27 19:40:23 +03001752 * as a Python int.
Tim Peters2a799bf2002-12-16 20:18:38 +00001753 * Doing mixed-radix arithmetic by hand instead is excruciating in C,
1754 * due to ubiquitous overflow possibilities.
1755 */
1756static PyObject *
1757delta_to_microseconds(PyDateTime_Delta *self)
1758{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001759 PyObject *x1 = NULL;
1760 PyObject *x2 = NULL;
1761 PyObject *x3 = NULL;
1762 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001763
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001764 x1 = PyLong_FromLong(GET_TD_DAYS(self));
1765 if (x1 == NULL)
1766 goto Done;
1767 x2 = PyNumber_Multiply(x1, seconds_per_day); /* days in seconds */
1768 if (x2 == NULL)
1769 goto Done;
1770 Py_DECREF(x1);
1771 x1 = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001772
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 /* x2 has days in seconds */
1774 x1 = PyLong_FromLong(GET_TD_SECONDS(self)); /* seconds */
1775 if (x1 == NULL)
1776 goto Done;
1777 x3 = PyNumber_Add(x1, x2); /* days and seconds in seconds */
1778 if (x3 == NULL)
1779 goto Done;
1780 Py_DECREF(x1);
1781 Py_DECREF(x2);
Brett Cannonb94767f2011-02-22 20:15:44 +00001782 /* x1 = */ x2 = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001783
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001784 /* x3 has days+seconds in seconds */
1785 x1 = PyNumber_Multiply(x3, us_per_second); /* us */
1786 if (x1 == NULL)
1787 goto Done;
1788 Py_DECREF(x3);
1789 x3 = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001791 /* x1 has days+seconds in us */
1792 x2 = PyLong_FromLong(GET_TD_MICROSECONDS(self));
1793 if (x2 == NULL)
1794 goto Done;
1795 result = PyNumber_Add(x1, x2);
Serhiy Storchaka4ffd4652017-10-23 17:12:28 +03001796 assert(result == NULL || PyLong_CheckExact(result));
Tim Peters2a799bf2002-12-16 20:18:38 +00001797
1798Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001799 Py_XDECREF(x1);
1800 Py_XDECREF(x2);
1801 Py_XDECREF(x3);
1802 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001803}
1804
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001805static PyObject *
1806checked_divmod(PyObject *a, PyObject *b)
1807{
1808 PyObject *result = PyNumber_Divmod(a, b);
1809 if (result != NULL) {
1810 if (!PyTuple_Check(result)) {
1811 PyErr_Format(PyExc_TypeError,
1812 "divmod() returned non-tuple (type %.200s)",
Victor Stinnerdaa97562020-02-07 03:37:06 +01001813 Py_TYPE(result)->tp_name);
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001814 Py_DECREF(result);
1815 return NULL;
1816 }
1817 if (PyTuple_GET_SIZE(result) != 2) {
1818 PyErr_Format(PyExc_TypeError,
1819 "divmod() returned a tuple of size %zd",
1820 PyTuple_GET_SIZE(result));
1821 Py_DECREF(result);
1822 return NULL;
1823 }
1824 }
1825 return result;
1826}
1827
Serhiy Storchaka95949422013-08-27 19:40:23 +03001828/* Convert a number of us (as a Python int) to a timedelta.
Tim Peters2a799bf2002-12-16 20:18:38 +00001829 */
1830static PyObject *
Tim Petersb0c854d2003-05-17 15:57:00 +00001831microseconds_to_delta_ex(PyObject *pyus, PyTypeObject *type)
Tim Peters2a799bf2002-12-16 20:18:38 +00001832{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001833 int us;
1834 int s;
1835 int d;
Tim Peters2a799bf2002-12-16 20:18:38 +00001836
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001837 PyObject *tuple = NULL;
1838 PyObject *num = NULL;
1839 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001840
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001841 tuple = checked_divmod(pyus, us_per_second);
1842 if (tuple == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001843 goto Done;
1844 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001845
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001846 num = PyTuple_GET_ITEM(tuple, 1); /* us */
1847 us = _PyLong_AsInt(num);
1848 num = NULL;
1849 if (us == -1 && PyErr_Occurred()) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001850 goto Done;
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001851 }
1852 if (!(0 <= us && us < 1000000)) {
1853 goto BadDivmod;
1854 }
1855
1856 num = PyTuple_GET_ITEM(tuple, 0); /* leftover seconds */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001857 Py_INCREF(num);
1858 Py_DECREF(tuple);
Tim Peters2a799bf2002-12-16 20:18:38 +00001859
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001860 tuple = checked_divmod(num, seconds_per_day);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001861 if (tuple == NULL)
1862 goto Done;
1863 Py_DECREF(num);
Tim Peters2a799bf2002-12-16 20:18:38 +00001864
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001865 num = PyTuple_GET_ITEM(tuple, 1); /* seconds */
1866 s = _PyLong_AsInt(num);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001867 num = NULL;
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001868 if (s == -1 && PyErr_Occurred()) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 goto Done;
1870 }
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001871 if (!(0 <= s && s < 24*3600)) {
1872 goto BadDivmod;
1873 }
Tim Peters2a799bf2002-12-16 20:18:38 +00001874
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001875 num = PyTuple_GET_ITEM(tuple, 0); /* leftover days */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001876 Py_INCREF(num);
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001877 d = _PyLong_AsInt(num);
1878 if (d == -1 && PyErr_Occurred()) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001879 goto Done;
1880 }
1881 result = new_delta_ex(d, s, us, 0, type);
Tim Peters2a799bf2002-12-16 20:18:38 +00001882
1883Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001884 Py_XDECREF(tuple);
1885 Py_XDECREF(num);
1886 return result;
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001887
1888BadDivmod:
1889 PyErr_SetString(PyExc_TypeError,
1890 "divmod() returned a value out of range");
1891 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00001892}
1893
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001894#define microseconds_to_delta(pymicros) \
1895 microseconds_to_delta_ex(pymicros, &PyDateTime_DeltaType)
Tim Petersb0c854d2003-05-17 15:57:00 +00001896
Tim Peters2a799bf2002-12-16 20:18:38 +00001897static PyObject *
1898multiply_int_timedelta(PyObject *intobj, PyDateTime_Delta *delta)
1899{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001900 PyObject *pyus_in;
1901 PyObject *pyus_out;
1902 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001903
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001904 pyus_in = delta_to_microseconds(delta);
1905 if (pyus_in == NULL)
1906 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001907
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02001908 pyus_out = PyNumber_Multiply(intobj, pyus_in);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 Py_DECREF(pyus_in);
1910 if (pyus_out == NULL)
1911 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001912
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001913 result = microseconds_to_delta(pyus_out);
1914 Py_DECREF(pyus_out);
1915 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001916}
1917
1918static PyObject *
Oren Milman865e4b42017-09-19 15:58:11 +03001919get_float_as_integer_ratio(PyObject *floatobj)
1920{
1921 PyObject *ratio;
1922
1923 assert(floatobj && PyFloat_Check(floatobj));
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001924 ratio = _PyObject_CallMethodIdNoArgs(floatobj, &PyId_as_integer_ratio);
Oren Milman865e4b42017-09-19 15:58:11 +03001925 if (ratio == NULL) {
1926 return NULL;
1927 }
1928 if (!PyTuple_Check(ratio)) {
1929 PyErr_Format(PyExc_TypeError,
1930 "unexpected return type from as_integer_ratio(): "
1931 "expected tuple, got '%.200s'",
1932 Py_TYPE(ratio)->tp_name);
1933 Py_DECREF(ratio);
1934 return NULL;
1935 }
1936 if (PyTuple_Size(ratio) != 2) {
1937 PyErr_SetString(PyExc_ValueError,
1938 "as_integer_ratio() must return a 2-tuple");
1939 Py_DECREF(ratio);
1940 return NULL;
1941 }
1942 return ratio;
1943}
1944
Serhiy Storchakadb12ef72017-10-04 20:30:09 +03001945/* op is 0 for multiplication, 1 for division */
Oren Milman865e4b42017-09-19 15:58:11 +03001946static PyObject *
Serhiy Storchakadb12ef72017-10-04 20:30:09 +03001947multiply_truedivide_timedelta_float(PyDateTime_Delta *delta, PyObject *floatobj, int op)
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00001948{
1949 PyObject *result = NULL;
1950 PyObject *pyus_in = NULL, *temp, *pyus_out;
1951 PyObject *ratio = NULL;
1952
1953 pyus_in = delta_to_microseconds(delta);
1954 if (pyus_in == NULL)
1955 return NULL;
Oren Milman865e4b42017-09-19 15:58:11 +03001956 ratio = get_float_as_integer_ratio(floatobj);
1957 if (ratio == NULL) {
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00001958 goto error;
Oren Milman865e4b42017-09-19 15:58:11 +03001959 }
Serhiy Storchakadb12ef72017-10-04 20:30:09 +03001960 temp = PyNumber_Multiply(pyus_in, PyTuple_GET_ITEM(ratio, op));
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00001961 Py_DECREF(pyus_in);
1962 pyus_in = NULL;
1963 if (temp == NULL)
1964 goto error;
Serhiy Storchakadb12ef72017-10-04 20:30:09 +03001965 pyus_out = divide_nearest(temp, PyTuple_GET_ITEM(ratio, !op));
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00001966 Py_DECREF(temp);
1967 if (pyus_out == NULL)
1968 goto error;
1969 result = microseconds_to_delta(pyus_out);
1970 Py_DECREF(pyus_out);
1971 error:
1972 Py_XDECREF(pyus_in);
1973 Py_XDECREF(ratio);
1974
1975 return result;
1976}
1977
1978static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00001979divide_timedelta_int(PyDateTime_Delta *delta, PyObject *intobj)
1980{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001981 PyObject *pyus_in;
1982 PyObject *pyus_out;
1983 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001984
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001985 pyus_in = delta_to_microseconds(delta);
1986 if (pyus_in == NULL)
1987 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001988
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001989 pyus_out = PyNumber_FloorDivide(pyus_in, intobj);
1990 Py_DECREF(pyus_in);
1991 if (pyus_out == NULL)
1992 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00001993
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001994 result = microseconds_to_delta(pyus_out);
1995 Py_DECREF(pyus_out);
1996 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00001997}
1998
1999static PyObject *
Mark Dickinson7c186e22010-04-20 22:32:49 +00002000divide_timedelta_timedelta(PyDateTime_Delta *left, PyDateTime_Delta *right)
2001{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002002 PyObject *pyus_left;
2003 PyObject *pyus_right;
2004 PyObject *result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002005
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002006 pyus_left = delta_to_microseconds(left);
2007 if (pyus_left == NULL)
2008 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002010 pyus_right = delta_to_microseconds(right);
2011 if (pyus_right == NULL) {
2012 Py_DECREF(pyus_left);
2013 return NULL;
2014 }
Mark Dickinson7c186e22010-04-20 22:32:49 +00002015
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002016 result = PyNumber_FloorDivide(pyus_left, pyus_right);
2017 Py_DECREF(pyus_left);
2018 Py_DECREF(pyus_right);
2019 return result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002020}
2021
2022static PyObject *
2023truedivide_timedelta_timedelta(PyDateTime_Delta *left, PyDateTime_Delta *right)
2024{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002025 PyObject *pyus_left;
2026 PyObject *pyus_right;
2027 PyObject *result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002028
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002029 pyus_left = delta_to_microseconds(left);
2030 if (pyus_left == NULL)
2031 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002032
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002033 pyus_right = delta_to_microseconds(right);
2034 if (pyus_right == NULL) {
2035 Py_DECREF(pyus_left);
2036 return NULL;
2037 }
Mark Dickinson7c186e22010-04-20 22:32:49 +00002038
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002039 result = PyNumber_TrueDivide(pyus_left, pyus_right);
2040 Py_DECREF(pyus_left);
2041 Py_DECREF(pyus_right);
2042 return result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002043}
2044
2045static PyObject *
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00002046truedivide_timedelta_int(PyDateTime_Delta *delta, PyObject *i)
2047{
2048 PyObject *result;
2049 PyObject *pyus_in, *pyus_out;
2050 pyus_in = delta_to_microseconds(delta);
2051 if (pyus_in == NULL)
2052 return NULL;
2053 pyus_out = divide_nearest(pyus_in, i);
2054 Py_DECREF(pyus_in);
2055 if (pyus_out == NULL)
2056 return NULL;
2057 result = microseconds_to_delta(pyus_out);
2058 Py_DECREF(pyus_out);
2059
2060 return result;
2061}
2062
2063static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002064delta_add(PyObject *left, PyObject *right)
2065{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002066 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002067
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002068 if (PyDelta_Check(left) && PyDelta_Check(right)) {
2069 /* delta + delta */
2070 /* The C-level additions can't overflow because of the
2071 * invariant bounds.
2072 */
2073 int days = GET_TD_DAYS(left) + GET_TD_DAYS(right);
2074 int seconds = GET_TD_SECONDS(left) + GET_TD_SECONDS(right);
2075 int microseconds = GET_TD_MICROSECONDS(left) +
2076 GET_TD_MICROSECONDS(right);
2077 result = new_delta(days, seconds, microseconds, 1);
2078 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002079
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002080 if (result == Py_NotImplemented)
2081 Py_INCREF(result);
2082 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002083}
2084
2085static PyObject *
2086delta_negative(PyDateTime_Delta *self)
2087{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002088 return new_delta(-GET_TD_DAYS(self),
2089 -GET_TD_SECONDS(self),
2090 -GET_TD_MICROSECONDS(self),
2091 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00002092}
2093
2094static PyObject *
2095delta_positive(PyDateTime_Delta *self)
2096{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002097 /* Could optimize this (by returning self) if this isn't a
2098 * subclass -- but who uses unary + ? Approximately nobody.
2099 */
2100 return new_delta(GET_TD_DAYS(self),
2101 GET_TD_SECONDS(self),
2102 GET_TD_MICROSECONDS(self),
2103 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00002104}
2105
2106static PyObject *
2107delta_abs(PyDateTime_Delta *self)
2108{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002109 PyObject *result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002110
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002111 assert(GET_TD_MICROSECONDS(self) >= 0);
2112 assert(GET_TD_SECONDS(self) >= 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00002113
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002114 if (GET_TD_DAYS(self) < 0)
2115 result = delta_negative(self);
2116 else
2117 result = delta_positive(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002119 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002120}
2121
2122static PyObject *
2123delta_subtract(PyObject *left, PyObject *right)
2124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002125 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002127 if (PyDelta_Check(left) && PyDelta_Check(right)) {
2128 /* delta - delta */
Alexander Belopolskyb6f5ec72011-04-05 20:07:38 -04002129 /* The C-level additions can't overflow because of the
2130 * invariant bounds.
2131 */
2132 int days = GET_TD_DAYS(left) - GET_TD_DAYS(right);
2133 int seconds = GET_TD_SECONDS(left) - GET_TD_SECONDS(right);
2134 int microseconds = GET_TD_MICROSECONDS(left) -
2135 GET_TD_MICROSECONDS(right);
2136 result = new_delta(days, seconds, microseconds, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002137 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002139 if (result == Py_NotImplemented)
2140 Py_INCREF(result);
2141 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002142}
2143
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00002144static int
2145delta_cmp(PyObject *self, PyObject *other)
2146{
2147 int diff = GET_TD_DAYS(self) - GET_TD_DAYS(other);
2148 if (diff == 0) {
2149 diff = GET_TD_SECONDS(self) - GET_TD_SECONDS(other);
2150 if (diff == 0)
2151 diff = GET_TD_MICROSECONDS(self) -
2152 GET_TD_MICROSECONDS(other);
2153 }
2154 return diff;
2155}
2156
Tim Peters2a799bf2002-12-16 20:18:38 +00002157static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00002158delta_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters2a799bf2002-12-16 20:18:38 +00002159{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002160 if (PyDelta_Check(other)) {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00002161 int diff = delta_cmp(self, other);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002162 return diff_to_bool(diff, op);
2163 }
2164 else {
Brian Curtindfc80e32011-08-10 20:28:54 -05002165 Py_RETURN_NOTIMPLEMENTED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002166 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002167}
2168
2169static PyObject *delta_getstate(PyDateTime_Delta *self);
2170
Benjamin Peterson8f67d082010-10-17 20:54:53 +00002171static Py_hash_t
Tim Peters2a799bf2002-12-16 20:18:38 +00002172delta_hash(PyDateTime_Delta *self)
2173{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002174 if (self->hashcode == -1) {
2175 PyObject *temp = delta_getstate(self);
2176 if (temp != NULL) {
2177 self->hashcode = PyObject_Hash(temp);
2178 Py_DECREF(temp);
2179 }
2180 }
2181 return self->hashcode;
Tim Peters2a799bf2002-12-16 20:18:38 +00002182}
2183
2184static PyObject *
2185delta_multiply(PyObject *left, PyObject *right)
2186{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002187 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002188
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002189 if (PyDelta_Check(left)) {
2190 /* delta * ??? */
2191 if (PyLong_Check(right))
2192 result = multiply_int_timedelta(right,
2193 (PyDateTime_Delta *) left);
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00002194 else if (PyFloat_Check(right))
Serhiy Storchakadb12ef72017-10-04 20:30:09 +03002195 result = multiply_truedivide_timedelta_float(
2196 (PyDateTime_Delta *) left, right, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002197 }
2198 else if (PyLong_Check(left))
2199 result = multiply_int_timedelta(left,
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00002200 (PyDateTime_Delta *) right);
2201 else if (PyFloat_Check(left))
Serhiy Storchakadb12ef72017-10-04 20:30:09 +03002202 result = multiply_truedivide_timedelta_float(
2203 (PyDateTime_Delta *) right, left, 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00002204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002205 if (result == Py_NotImplemented)
2206 Py_INCREF(result);
2207 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002208}
2209
2210static PyObject *
2211delta_divide(PyObject *left, PyObject *right)
2212{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002213 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00002214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002215 if (PyDelta_Check(left)) {
2216 /* delta * ??? */
2217 if (PyLong_Check(right))
2218 result = divide_timedelta_int(
2219 (PyDateTime_Delta *)left,
2220 right);
2221 else if (PyDelta_Check(right))
2222 result = divide_timedelta_timedelta(
2223 (PyDateTime_Delta *)left,
2224 (PyDateTime_Delta *)right);
2225 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002226
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002227 if (result == Py_NotImplemented)
2228 Py_INCREF(result);
2229 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002230}
2231
Mark Dickinson7c186e22010-04-20 22:32:49 +00002232static PyObject *
2233delta_truedivide(PyObject *left, PyObject *right)
2234{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002235 PyObject *result = Py_NotImplemented;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002236
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002237 if (PyDelta_Check(left)) {
2238 if (PyDelta_Check(right))
2239 result = truedivide_timedelta_timedelta(
2240 (PyDateTime_Delta *)left,
2241 (PyDateTime_Delta *)right);
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00002242 else if (PyFloat_Check(right))
Serhiy Storchakadb12ef72017-10-04 20:30:09 +03002243 result = multiply_truedivide_timedelta_float(
2244 (PyDateTime_Delta *)left, right, 1);
Alexander Belopolsky1790bc42010-05-31 17:33:47 +00002245 else if (PyLong_Check(right))
2246 result = truedivide_timedelta_int(
2247 (PyDateTime_Delta *)left, right);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002248 }
Mark Dickinson7c186e22010-04-20 22:32:49 +00002249
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002250 if (result == Py_NotImplemented)
2251 Py_INCREF(result);
2252 return result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002253}
2254
2255static PyObject *
2256delta_remainder(PyObject *left, PyObject *right)
2257{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002258 PyObject *pyus_left;
2259 PyObject *pyus_right;
2260 PyObject *pyus_remainder;
2261 PyObject *remainder;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002262
Brian Curtindfc80e32011-08-10 20:28:54 -05002263 if (!PyDelta_Check(left) || !PyDelta_Check(right))
2264 Py_RETURN_NOTIMPLEMENTED;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002265
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002266 pyus_left = delta_to_microseconds((PyDateTime_Delta *)left);
2267 if (pyus_left == NULL)
2268 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002269
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002270 pyus_right = delta_to_microseconds((PyDateTime_Delta *)right);
2271 if (pyus_right == NULL) {
2272 Py_DECREF(pyus_left);
2273 return NULL;
2274 }
Mark Dickinson7c186e22010-04-20 22:32:49 +00002275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002276 pyus_remainder = PyNumber_Remainder(pyus_left, pyus_right);
2277 Py_DECREF(pyus_left);
2278 Py_DECREF(pyus_right);
2279 if (pyus_remainder == NULL)
2280 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002282 remainder = microseconds_to_delta(pyus_remainder);
2283 Py_DECREF(pyus_remainder);
2284 if (remainder == NULL)
2285 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002286
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002287 return remainder;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002288}
2289
2290static PyObject *
2291delta_divmod(PyObject *left, PyObject *right)
2292{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002293 PyObject *pyus_left;
2294 PyObject *pyus_right;
2295 PyObject *divmod;
2296 PyObject *delta;
2297 PyObject *result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002298
Brian Curtindfc80e32011-08-10 20:28:54 -05002299 if (!PyDelta_Check(left) || !PyDelta_Check(right))
2300 Py_RETURN_NOTIMPLEMENTED;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002301
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002302 pyus_left = delta_to_microseconds((PyDateTime_Delta *)left);
2303 if (pyus_left == NULL)
2304 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002305
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002306 pyus_right = delta_to_microseconds((PyDateTime_Delta *)right);
2307 if (pyus_right == NULL) {
2308 Py_DECREF(pyus_left);
2309 return NULL;
2310 }
Mark Dickinson7c186e22010-04-20 22:32:49 +00002311
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02002312 divmod = checked_divmod(pyus_left, pyus_right);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002313 Py_DECREF(pyus_left);
2314 Py_DECREF(pyus_right);
2315 if (divmod == NULL)
2316 return NULL;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002318 delta = microseconds_to_delta(PyTuple_GET_ITEM(divmod, 1));
2319 if (delta == NULL) {
2320 Py_DECREF(divmod);
2321 return NULL;
2322 }
2323 result = PyTuple_Pack(2, PyTuple_GET_ITEM(divmod, 0), delta);
2324 Py_DECREF(delta);
2325 Py_DECREF(divmod);
2326 return result;
Mark Dickinson7c186e22010-04-20 22:32:49 +00002327}
2328
Tim Peters2a799bf2002-12-16 20:18:38 +00002329/* Fold in the value of the tag ("seconds", "weeks", etc) component of a
2330 * timedelta constructor. sofar is the # of microseconds accounted for
2331 * so far, and there are factor microseconds per current unit, the number
2332 * of which is given by num. num * factor is added to sofar in a
2333 * numerically careful way, and that's the result. Any fractional
2334 * microseconds left over (this can happen if num is a float type) are
2335 * added into *leftover.
2336 * Note that there are many ways this can give an error (NULL) return.
2337 */
2338static PyObject *
2339accum(const char* tag, PyObject *sofar, PyObject *num, PyObject *factor,
2340 double *leftover)
2341{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002342 PyObject *prod;
2343 PyObject *sum;
Tim Peters2a799bf2002-12-16 20:18:38 +00002344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002345 assert(num != NULL);
Tim Peters2a799bf2002-12-16 20:18:38 +00002346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002347 if (PyLong_Check(num)) {
Serhiy Storchaka3ec0f492018-11-20 20:41:09 +02002348 prod = PyNumber_Multiply(num, factor);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002349 if (prod == NULL)
2350 return NULL;
2351 sum = PyNumber_Add(sofar, prod);
2352 Py_DECREF(prod);
2353 return sum;
2354 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002355
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002356 if (PyFloat_Check(num)) {
2357 double dnum;
2358 double fracpart;
2359 double intpart;
2360 PyObject *x;
2361 PyObject *y;
Tim Peters2a799bf2002-12-16 20:18:38 +00002362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002363 /* The Plan: decompose num into an integer part and a
2364 * fractional part, num = intpart + fracpart.
2365 * Then num * factor ==
2366 * intpart * factor + fracpart * factor
2367 * and the LHS can be computed exactly in long arithmetic.
2368 * The RHS is again broken into an int part and frac part.
2369 * and the frac part is added into *leftover.
2370 */
2371 dnum = PyFloat_AsDouble(num);
2372 if (dnum == -1.0 && PyErr_Occurred())
2373 return NULL;
2374 fracpart = modf(dnum, &intpart);
2375 x = PyLong_FromDouble(intpart);
2376 if (x == NULL)
2377 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002379 prod = PyNumber_Multiply(x, factor);
2380 Py_DECREF(x);
2381 if (prod == NULL)
2382 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002383
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002384 sum = PyNumber_Add(sofar, prod);
2385 Py_DECREF(prod);
2386 if (sum == NULL)
2387 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002389 if (fracpart == 0.0)
2390 return sum;
2391 /* So far we've lost no information. Dealing with the
2392 * fractional part requires float arithmetic, and may
2393 * lose a little info.
2394 */
Serhiy Storchaka4ffd4652017-10-23 17:12:28 +03002395 assert(PyLong_CheckExact(factor));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002396 dnum = PyLong_AsDouble(factor);
Tim Peters2a799bf2002-12-16 20:18:38 +00002397
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002398 dnum *= fracpart;
2399 fracpart = modf(dnum, &intpart);
2400 x = PyLong_FromDouble(intpart);
2401 if (x == NULL) {
2402 Py_DECREF(sum);
2403 return NULL;
2404 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002406 y = PyNumber_Add(sum, x);
2407 Py_DECREF(sum);
2408 Py_DECREF(x);
2409 *leftover += fracpart;
2410 return y;
2411 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002412
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002413 PyErr_Format(PyExc_TypeError,
2414 "unsupported type for timedelta %s component: %s",
2415 tag, Py_TYPE(num)->tp_name);
2416 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002417}
2418
2419static PyObject *
2420delta_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2421{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002422 PyObject *self = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002423
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002424 /* Argument objects. */
2425 PyObject *day = NULL;
2426 PyObject *second = NULL;
2427 PyObject *us = NULL;
2428 PyObject *ms = NULL;
2429 PyObject *minute = NULL;
2430 PyObject *hour = NULL;
2431 PyObject *week = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 PyObject *x = NULL; /* running sum of microseconds */
2434 PyObject *y = NULL; /* temp sum of microseconds */
2435 double leftover_us = 0.0;
Tim Peters2a799bf2002-12-16 20:18:38 +00002436
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 static char *keywords[] = {
2438 "days", "seconds", "microseconds", "milliseconds",
2439 "minutes", "hours", "weeks", NULL
2440 };
Tim Peters2a799bf2002-12-16 20:18:38 +00002441
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002442 if (PyArg_ParseTupleAndKeywords(args, kw, "|OOOOOOO:__new__",
2443 keywords,
2444 &day, &second, &us,
2445 &ms, &minute, &hour, &week) == 0)
2446 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00002447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 x = PyLong_FromLong(0);
2449 if (x == NULL)
2450 goto Done;
Tim Peters2a799bf2002-12-16 20:18:38 +00002451
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452#define CLEANUP \
2453 Py_DECREF(x); \
2454 x = y; \
2455 if (x == NULL) \
2456 goto Done
Tim Peters2a799bf2002-12-16 20:18:38 +00002457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002458 if (us) {
Serhiy Storchakaba85d692017-03-30 09:09:41 +03002459 y = accum("microseconds", x, us, _PyLong_One, &leftover_us);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 CLEANUP;
2461 }
2462 if (ms) {
2463 y = accum("milliseconds", x, ms, us_per_ms, &leftover_us);
2464 CLEANUP;
2465 }
2466 if (second) {
2467 y = accum("seconds", x, second, us_per_second, &leftover_us);
2468 CLEANUP;
2469 }
2470 if (minute) {
2471 y = accum("minutes", x, minute, us_per_minute, &leftover_us);
2472 CLEANUP;
2473 }
2474 if (hour) {
2475 y = accum("hours", x, hour, us_per_hour, &leftover_us);
2476 CLEANUP;
2477 }
2478 if (day) {
2479 y = accum("days", x, day, us_per_day, &leftover_us);
2480 CLEANUP;
2481 }
2482 if (week) {
2483 y = accum("weeks", x, week, us_per_week, &leftover_us);
2484 CLEANUP;
2485 }
2486 if (leftover_us) {
2487 /* Round to nearest whole # of us, and add into x. */
Alexander Belopolsky790d2692013-08-04 14:51:35 -04002488 double whole_us = round(leftover_us);
Victor Stinner69cc4872015-09-08 23:58:54 +02002489 int x_is_odd;
Alexander Belopolsky790d2692013-08-04 14:51:35 -04002490 PyObject *temp;
2491
Victor Stinner69cc4872015-09-08 23:58:54 +02002492 if (fabs(whole_us - leftover_us) == 0.5) {
2493 /* We're exactly halfway between two integers. In order
2494 * to do round-half-to-even, we must determine whether x
2495 * is odd. Note that x is odd when it's last bit is 1. The
2496 * code below uses bitwise and operation to check the last
2497 * bit. */
Serhiy Storchakaba85d692017-03-30 09:09:41 +03002498 temp = PyNumber_And(x, _PyLong_One); /* temp <- x & 1 */
Victor Stinner69cc4872015-09-08 23:58:54 +02002499 if (temp == NULL) {
2500 Py_DECREF(x);
2501 goto Done;
2502 }
2503 x_is_odd = PyObject_IsTrue(temp);
2504 Py_DECREF(temp);
2505 if (x_is_odd == -1) {
2506 Py_DECREF(x);
2507 goto Done;
2508 }
2509 whole_us = 2.0 * round((leftover_us + x_is_odd) * 0.5) - x_is_odd;
2510 }
Alexander Belopolsky790d2692013-08-04 14:51:35 -04002511
Victor Stinner36a5a062013-08-28 01:53:39 +02002512 temp = PyLong_FromLong((long)whole_us);
Alexander Belopolsky790d2692013-08-04 14:51:35 -04002513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002514 if (temp == NULL) {
2515 Py_DECREF(x);
2516 goto Done;
2517 }
2518 y = PyNumber_Add(x, temp);
2519 Py_DECREF(temp);
2520 CLEANUP;
2521 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002523 self = microseconds_to_delta_ex(x, type);
2524 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00002525Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002526 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00002527
2528#undef CLEANUP
2529}
2530
2531static int
Jack Diederich4dafcc42006-11-28 19:15:13 +00002532delta_bool(PyDateTime_Delta *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00002533{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002534 return (GET_TD_DAYS(self) != 0
2535 || GET_TD_SECONDS(self) != 0
2536 || GET_TD_MICROSECONDS(self) != 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00002537}
2538
2539static PyObject *
2540delta_repr(PyDateTime_Delta *self)
2541{
Utkarsh Upadhyaycc5a65c2017-07-25 23:51:33 +02002542 PyObject *args = PyUnicode_FromString("");
Tim Peters2a799bf2002-12-16 20:18:38 +00002543
Utkarsh Upadhyaycc5a65c2017-07-25 23:51:33 +02002544 if (args == NULL) {
2545 return NULL;
2546 }
2547
2548 const char *sep = "";
2549
2550 if (GET_TD_DAYS(self) != 0) {
2551 Py_SETREF(args, PyUnicode_FromFormat("days=%d", GET_TD_DAYS(self)));
2552 if (args == NULL) {
2553 return NULL;
2554 }
2555 sep = ", ";
2556 }
2557
2558 if (GET_TD_SECONDS(self) != 0) {
2559 Py_SETREF(args, PyUnicode_FromFormat("%U%sseconds=%d", args, sep,
2560 GET_TD_SECONDS(self)));
2561 if (args == NULL) {
2562 return NULL;
2563 }
2564 sep = ", ";
2565 }
2566
2567 if (GET_TD_MICROSECONDS(self) != 0) {
2568 Py_SETREF(args, PyUnicode_FromFormat("%U%smicroseconds=%d", args, sep,
2569 GET_TD_MICROSECONDS(self)));
2570 if (args == NULL) {
2571 return NULL;
2572 }
2573 }
2574
2575 if (PyUnicode_GET_LENGTH(args) == 0) {
2576 Py_SETREF(args, PyUnicode_FromString("0"));
2577 if (args == NULL) {
2578 return NULL;
2579 }
2580 }
2581
2582 PyObject *repr = PyUnicode_FromFormat("%s(%S)", Py_TYPE(self)->tp_name,
2583 args);
2584 Py_DECREF(args);
2585 return repr;
Tim Peters2a799bf2002-12-16 20:18:38 +00002586}
2587
2588static PyObject *
2589delta_str(PyDateTime_Delta *self)
2590{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002591 int us = GET_TD_MICROSECONDS(self);
2592 int seconds = GET_TD_SECONDS(self);
2593 int minutes = divmod(seconds, 60, &seconds);
2594 int hours = divmod(minutes, 60, &minutes);
2595 int days = GET_TD_DAYS(self);
Tim Peters2a799bf2002-12-16 20:18:38 +00002596
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002597 if (days) {
2598 if (us)
2599 return PyUnicode_FromFormat("%d day%s, %d:%02d:%02d.%06d",
2600 days, (days == 1 || days == -1) ? "" : "s",
2601 hours, minutes, seconds, us);
2602 else
2603 return PyUnicode_FromFormat("%d day%s, %d:%02d:%02d",
2604 days, (days == 1 || days == -1) ? "" : "s",
2605 hours, minutes, seconds);
2606 } else {
2607 if (us)
2608 return PyUnicode_FromFormat("%d:%02d:%02d.%06d",
2609 hours, minutes, seconds, us);
2610 else
2611 return PyUnicode_FromFormat("%d:%02d:%02d",
2612 hours, minutes, seconds);
2613 }
Tim Peters2a799bf2002-12-16 20:18:38 +00002614
Tim Peters2a799bf2002-12-16 20:18:38 +00002615}
2616
Tim Peters371935f2003-02-01 01:52:50 +00002617/* Pickle support, a simple use of __reduce__. */
2618
Tim Petersb57f8f02003-02-01 02:54:15 +00002619/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00002620static PyObject *
2621delta_getstate(PyDateTime_Delta *self)
2622{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002623 return Py_BuildValue("iii", GET_TD_DAYS(self),
2624 GET_TD_SECONDS(self),
2625 GET_TD_MICROSECONDS(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002626}
2627
Tim Peters2a799bf2002-12-16 20:18:38 +00002628static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302629delta_total_seconds(PyObject *self, PyObject *Py_UNUSED(ignored))
Antoine Pitroube6859d2009-11-25 23:02:32 +00002630{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002631 PyObject *total_seconds;
2632 PyObject *total_microseconds;
Mark Dickinson0381e3f2010-05-08 14:35:02 +00002633
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002634 total_microseconds = delta_to_microseconds((PyDateTime_Delta *)self);
2635 if (total_microseconds == NULL)
2636 return NULL;
Mark Dickinson0381e3f2010-05-08 14:35:02 +00002637
Alexander Belopolskydf7027b2013-08-04 15:18:58 -04002638 total_seconds = PyNumber_TrueDivide(total_microseconds, us_per_second);
Mark Dickinson0381e3f2010-05-08 14:35:02 +00002639
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002640 Py_DECREF(total_microseconds);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002641 return total_seconds;
Antoine Pitroube6859d2009-11-25 23:02:32 +00002642}
2643
2644static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302645delta_reduce(PyDateTime_Delta* self, PyObject *Py_UNUSED(ignored))
Tim Peters2a799bf2002-12-16 20:18:38 +00002646{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002647 return Py_BuildValue("ON", Py_TYPE(self), delta_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002648}
2649
2650#define OFFSET(field) offsetof(PyDateTime_Delta, field)
2651
2652static PyMemberDef delta_members[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00002653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002654 {"days", T_INT, OFFSET(days), READONLY,
2655 PyDoc_STR("Number of days.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002656
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002657 {"seconds", T_INT, OFFSET(seconds), READONLY,
2658 PyDoc_STR("Number of seconds (>= 0 and less than 1 day).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00002659
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002660 {"microseconds", T_INT, OFFSET(microseconds), READONLY,
2661 PyDoc_STR("Number of microseconds (>= 0 and less than 1 second).")},
2662 {NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00002663};
2664
2665static PyMethodDef delta_methods[] = {
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302666 {"total_seconds", delta_total_seconds, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002667 PyDoc_STR("Total seconds in the duration.")},
Antoine Pitroube6859d2009-11-25 23:02:32 +00002668
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002669 {"__reduce__", (PyCFunction)delta_reduce, METH_NOARGS,
2670 PyDoc_STR("__reduce__() -> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00002671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 {NULL, NULL},
Tim Peters2a799bf2002-12-16 20:18:38 +00002673};
2674
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02002675static const char delta_doc[] =
Chris Barkerd6a61f22018-10-19 15:43:24 -07002676PyDoc_STR("Difference between two datetime values.\n\n"
2677 "timedelta(days=0, seconds=0, microseconds=0, milliseconds=0, "
2678 "minutes=0, hours=0, weeks=0)\n\n"
2679 "All arguments are optional and default to 0.\n"
2680 "Arguments may be integers or floats, and may be positive or negative.");
Tim Peters2a799bf2002-12-16 20:18:38 +00002681
2682static PyNumberMethods delta_as_number = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002683 delta_add, /* nb_add */
2684 delta_subtract, /* nb_subtract */
2685 delta_multiply, /* nb_multiply */
2686 delta_remainder, /* nb_remainder */
2687 delta_divmod, /* nb_divmod */
2688 0, /* nb_power */
2689 (unaryfunc)delta_negative, /* nb_negative */
2690 (unaryfunc)delta_positive, /* nb_positive */
2691 (unaryfunc)delta_abs, /* nb_absolute */
2692 (inquiry)delta_bool, /* nb_bool */
2693 0, /*nb_invert*/
2694 0, /*nb_lshift*/
2695 0, /*nb_rshift*/
2696 0, /*nb_and*/
2697 0, /*nb_xor*/
2698 0, /*nb_or*/
2699 0, /*nb_int*/
2700 0, /*nb_reserved*/
2701 0, /*nb_float*/
2702 0, /*nb_inplace_add*/
2703 0, /*nb_inplace_subtract*/
2704 0, /*nb_inplace_multiply*/
2705 0, /*nb_inplace_remainder*/
2706 0, /*nb_inplace_power*/
2707 0, /*nb_inplace_lshift*/
2708 0, /*nb_inplace_rshift*/
2709 0, /*nb_inplace_and*/
2710 0, /*nb_inplace_xor*/
2711 0, /*nb_inplace_or*/
2712 delta_divide, /* nb_floor_divide */
2713 delta_truedivide, /* nb_true_divide */
2714 0, /* nb_inplace_floor_divide */
2715 0, /* nb_inplace_true_divide */
Tim Peters2a799bf2002-12-16 20:18:38 +00002716};
2717
2718static PyTypeObject PyDateTime_DeltaType = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002719 PyVarObject_HEAD_INIT(NULL, 0)
2720 "datetime.timedelta", /* tp_name */
2721 sizeof(PyDateTime_Delta), /* tp_basicsize */
2722 0, /* tp_itemsize */
2723 0, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02002724 0, /* tp_vectorcall_offset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002725 0, /* tp_getattr */
2726 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02002727 0, /* tp_as_async */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002728 (reprfunc)delta_repr, /* tp_repr */
2729 &delta_as_number, /* tp_as_number */
2730 0, /* tp_as_sequence */
2731 0, /* tp_as_mapping */
2732 (hashfunc)delta_hash, /* tp_hash */
2733 0, /* tp_call */
2734 (reprfunc)delta_str, /* tp_str */
2735 PyObject_GenericGetAttr, /* tp_getattro */
2736 0, /* tp_setattro */
2737 0, /* tp_as_buffer */
2738 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
2739 delta_doc, /* tp_doc */
2740 0, /* tp_traverse */
2741 0, /* tp_clear */
2742 delta_richcompare, /* tp_richcompare */
2743 0, /* tp_weaklistoffset */
2744 0, /* tp_iter */
2745 0, /* tp_iternext */
2746 delta_methods, /* tp_methods */
2747 delta_members, /* tp_members */
2748 0, /* tp_getset */
2749 0, /* tp_base */
2750 0, /* tp_dict */
2751 0, /* tp_descr_get */
2752 0, /* tp_descr_set */
2753 0, /* tp_dictoffset */
2754 0, /* tp_init */
2755 0, /* tp_alloc */
2756 delta_new, /* tp_new */
2757 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00002758};
2759
2760/*
2761 * PyDateTime_Date implementation.
2762 */
2763
2764/* Accessor properties. */
2765
2766static PyObject *
2767date_year(PyDateTime_Date *self, void *unused)
2768{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002769 return PyLong_FromLong(GET_YEAR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002770}
2771
2772static PyObject *
2773date_month(PyDateTime_Date *self, void *unused)
2774{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002775 return PyLong_FromLong(GET_MONTH(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002776}
2777
2778static PyObject *
2779date_day(PyDateTime_Date *self, void *unused)
2780{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002781 return PyLong_FromLong(GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00002782}
2783
2784static PyGetSetDef date_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002785 {"year", (getter)date_year},
2786 {"month", (getter)date_month},
2787 {"day", (getter)date_day},
2788 {NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00002789};
2790
2791/* Constructors. */
2792
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00002793static char *date_kws[] = {"year", "month", "day", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00002794
Tim Peters2a799bf2002-12-16 20:18:38 +00002795static PyObject *
Serhiy Storchaka8452ca12018-12-07 13:42:10 +02002796date_from_pickle(PyTypeObject *type, PyObject *state)
2797{
2798 PyDateTime_Date *me;
2799
2800 me = (PyDateTime_Date *) (type->tp_alloc(type, 0));
2801 if (me != NULL) {
2802 const char *pdata = PyBytes_AS_STRING(state);
2803 memcpy(me->data, pdata, _PyDateTime_DATE_DATASIZE);
2804 me->hashcode = -1;
2805 }
2806 return (PyObject *)me;
2807}
2808
2809static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00002810date_new(PyTypeObject *type, PyObject *args, PyObject *kw)
2811{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002812 PyObject *self = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002813 int year;
2814 int month;
2815 int day;
Tim Peters2a799bf2002-12-16 20:18:38 +00002816
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002817 /* Check for invocation from pickle with __getstate__ state */
Serhiy Storchaka1133a8c2018-12-07 16:48:21 +02002818 if (PyTuple_GET_SIZE(args) == 1) {
Serhiy Storchaka8452ca12018-12-07 13:42:10 +02002819 PyObject *state = PyTuple_GET_ITEM(args, 0);
2820 if (PyBytes_Check(state)) {
2821 if (PyBytes_GET_SIZE(state) == _PyDateTime_DATE_DATASIZE &&
2822 MONTH_IS_SANE(PyBytes_AS_STRING(state)[2]))
2823 {
2824 return date_from_pickle(type, state);
Victor Stinnerb37672d2018-11-22 03:37:50 +01002825 }
Serhiy Storchaka8452ca12018-12-07 13:42:10 +02002826 }
2827 else if (PyUnicode_Check(state)) {
2828 if (PyUnicode_READY(state)) {
2829 return NULL;
2830 }
2831 if (PyUnicode_GET_LENGTH(state) == _PyDateTime_DATE_DATASIZE &&
2832 MONTH_IS_SANE(PyUnicode_READ_CHAR(state, 2)))
2833 {
2834 state = PyUnicode_AsLatin1String(state);
2835 if (state == NULL) {
2836 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
2837 /* More informative error message. */
2838 PyErr_SetString(PyExc_ValueError,
2839 "Failed to encode latin1 string when unpickling "
2840 "a date object. "
2841 "pickle.load(data, encoding='latin1') is assumed.");
2842 }
2843 return NULL;
2844 }
2845 self = date_from_pickle(type, state);
2846 Py_DECREF(state);
2847 return self;
2848 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002849 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002850 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00002851
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002852 if (PyArg_ParseTupleAndKeywords(args, kw, "iii", date_kws,
2853 &year, &month, &day)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002854 self = new_date_ex(year, month, day, type);
2855 }
2856 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00002857}
2858
Tim Peters2a799bf2002-12-16 20:18:38 +00002859static PyObject *
Tim Hoffmanna0fd7f12018-09-24 10:39:02 +02002860date_fromtimestamp(PyObject *cls, PyObject *obj)
Tim Peters2a799bf2002-12-16 20:18:38 +00002861{
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04002862 struct tm tm;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002863 time_t t;
Tim Peters2a799bf2002-12-16 20:18:38 +00002864
Victor Stinnere4a994d2015-03-30 01:10:14 +02002865 if (_PyTime_ObjectToTime_t(obj, &t, _PyTime_ROUND_FLOOR) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002866 return NULL;
Victor Stinner5d272cc2012-03-13 13:35:55 +01002867
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04002868 if (_PyTime_localtime(t, &tm) != 0)
Victor Stinner21f58932012-03-14 00:15:40 +01002869 return NULL;
Victor Stinner21f58932012-03-14 00:15:40 +01002870
Paul Ganssle9f1b7b92018-01-16 13:06:31 -05002871 return new_date_subclass_ex(tm.tm_year + 1900,
2872 tm.tm_mon + 1,
2873 tm.tm_mday,
2874 cls);
Tim Peters2a799bf2002-12-16 20:18:38 +00002875}
2876
2877/* Return new date from current time.
2878 * We say this is equivalent to fromtimestamp(time.time()), and the
2879 * only way to be sure of that is to *call* time.time(). That's not
2880 * generally the same as calling C's time.
2881 */
2882static PyObject *
2883date_today(PyObject *cls, PyObject *dummy)
2884{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002885 PyObject *time;
2886 PyObject *result;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002887 _Py_IDENTIFIER(fromtimestamp);
Tim Peters2a799bf2002-12-16 20:18:38 +00002888
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002889 time = time_time();
2890 if (time == NULL)
2891 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00002892
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002893 /* Note well: today() is a class method, so this may not call
2894 * date.fromtimestamp. For example, it may call
2895 * datetime.fromtimestamp. That's why we need all the accuracy
2896 * time.time() delivers; if someone were gonzo about optimization,
2897 * date.today() could get away with plain C time().
2898 */
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02002899 result = _PyObject_CallMethodIdOneArg(cls, &PyId_fromtimestamp, time);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002900 Py_DECREF(time);
2901 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002902}
2903
Tim Hoffmanna0fd7f12018-09-24 10:39:02 +02002904/*[clinic input]
2905@classmethod
2906datetime.date.fromtimestamp
2907
2908 timestamp: object
2909 /
2910
2911Create a date from a POSIX timestamp.
2912
2913The timestamp is a number, e.g. created via time.time(), that is interpreted
2914as local time.
2915[clinic start generated code]*/
2916
Tim Peters2a799bf2002-12-16 20:18:38 +00002917static PyObject *
Tim Hoffmanna0fd7f12018-09-24 10:39:02 +02002918datetime_date_fromtimestamp(PyTypeObject *type, PyObject *timestamp)
2919/*[clinic end generated code: output=fd045fda58168869 input=eabb3fe7f40491fe]*/
Tim Peters2a799bf2002-12-16 20:18:38 +00002920{
Tim Hoffmanna0fd7f12018-09-24 10:39:02 +02002921 return date_fromtimestamp((PyObject *) type, timestamp);
Tim Peters2a799bf2002-12-16 20:18:38 +00002922}
2923
Paul Ganssle4d8c8c02019-04-27 15:39:40 -04002924/* bpo-36025: This is a wrapper for API compatibility with the public C API,
2925 * which expects a function that takes an *args tuple, whereas the argument
2926 * clinic generates code that takes METH_O.
2927 */
2928static PyObject *
2929datetime_date_fromtimestamp_capi(PyObject *cls, PyObject *args)
2930{
2931 PyObject *timestamp;
2932 PyObject *result = NULL;
2933
2934 if (PyArg_UnpackTuple(args, "fromtimestamp", 1, 1, &timestamp)) {
2935 result = date_fromtimestamp(cls, timestamp);
2936 }
2937
2938 return result;
2939}
2940
Tim Peters2a799bf2002-12-16 20:18:38 +00002941/* Return new date from proleptic Gregorian ordinal. Raises ValueError if
2942 * the ordinal is out of range.
2943 */
2944static PyObject *
2945date_fromordinal(PyObject *cls, PyObject *args)
2946{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002947 PyObject *result = NULL;
2948 int ordinal;
Tim Peters2a799bf2002-12-16 20:18:38 +00002949
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002950 if (PyArg_ParseTuple(args, "i:fromordinal", &ordinal)) {
2951 int year;
2952 int month;
2953 int day;
Tim Peters2a799bf2002-12-16 20:18:38 +00002954
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002955 if (ordinal < 1)
2956 PyErr_SetString(PyExc_ValueError, "ordinal must be "
2957 ">= 1");
2958 else {
2959 ord_to_ymd(ordinal, &year, &month, &day);
Paul Ganssle9f1b7b92018-01-16 13:06:31 -05002960 result = new_date_subclass_ex(year, month, day, cls);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002961 }
2962 }
2963 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00002964}
2965
Paul Ganssle09dc2f52017-12-21 00:33:49 -05002966/* Return the new date from a string as generated by date.isoformat() */
2967static PyObject *
Paul Ganssle3df85402018-10-22 12:32:52 -04002968date_fromisoformat(PyObject *cls, PyObject *dtstr)
2969{
Paul Ganssle09dc2f52017-12-21 00:33:49 -05002970 assert(dtstr != NULL);
2971
2972 if (!PyUnicode_Check(dtstr)) {
Paul Ganssle3df85402018-10-22 12:32:52 -04002973 PyErr_SetString(PyExc_TypeError,
2974 "fromisoformat: argument must be str");
Paul Ganssle09dc2f52017-12-21 00:33:49 -05002975 return NULL;
2976 }
2977
2978 Py_ssize_t len;
2979
Paul Ganssle3df85402018-10-22 12:32:52 -04002980 const char *dt_ptr = PyUnicode_AsUTF8AndSize(dtstr, &len);
Paul Ganssle096329f2018-08-23 11:06:20 -04002981 if (dt_ptr == NULL) {
2982 goto invalid_string_error;
2983 }
Paul Ganssle09dc2f52017-12-21 00:33:49 -05002984
2985 int year = 0, month = 0, day = 0;
2986
2987 int rv;
2988 if (len == 10) {
2989 rv = parse_isoformat_date(dt_ptr, &year, &month, &day);
Paul Ganssle3df85402018-10-22 12:32:52 -04002990 }
2991 else {
Paul Ganssle09dc2f52017-12-21 00:33:49 -05002992 rv = -1;
2993 }
2994
2995 if (rv < 0) {
Paul Ganssle096329f2018-08-23 11:06:20 -04002996 goto invalid_string_error;
Paul Ganssle09dc2f52017-12-21 00:33:49 -05002997 }
2998
Paul Ganssle9f1b7b92018-01-16 13:06:31 -05002999 return new_date_subclass_ex(year, month, day, cls);
Paul Ganssle096329f2018-08-23 11:06:20 -04003000
3001invalid_string_error:
Paul Ganssle3df85402018-10-22 12:32:52 -04003002 PyErr_Format(PyExc_ValueError, "Invalid isoformat string: %R", dtstr);
Paul Ganssle096329f2018-08-23 11:06:20 -04003003 return NULL;
Paul Ganssle09dc2f52017-12-21 00:33:49 -05003004}
3005
Paul Ganssle88c09372019-04-29 09:22:03 -04003006
3007static PyObject *
3008date_fromisocalendar(PyObject *cls, PyObject *args, PyObject *kw)
3009{
3010 static char *keywords[] = {
3011 "year", "week", "day", NULL
3012 };
3013
3014 int year, week, day;
3015 if (PyArg_ParseTupleAndKeywords(args, kw, "iii:fromisocalendar",
3016 keywords,
3017 &year, &week, &day) == 0) {
3018 if (PyErr_ExceptionMatches(PyExc_OverflowError)) {
3019 PyErr_Format(PyExc_ValueError,
3020 "ISO calendar component out of range");
3021
3022 }
3023 return NULL;
3024 }
3025
3026 // Year is bounded to 0 < year < 10000 because 9999-12-31 is (9999, 52, 5)
3027 if (year < MINYEAR || year > MAXYEAR) {
3028 PyErr_Format(PyExc_ValueError, "Year is out of range: %d", year);
3029 return NULL;
3030 }
3031
3032 if (week <= 0 || week >= 53) {
3033 int out_of_range = 1;
3034 if (week == 53) {
3035 // ISO years have 53 weeks in it on years starting with a Thursday
3036 // and on leap years starting on Wednesday
3037 int first_weekday = weekday(year, 1, 1);
3038 if (first_weekday == 3 || (first_weekday == 2 && is_leap(year))) {
3039 out_of_range = 0;
3040 }
3041 }
3042
3043 if (out_of_range) {
3044 PyErr_Format(PyExc_ValueError, "Invalid week: %d", week);
3045 return NULL;
3046 }
3047 }
3048
3049 if (day <= 0 || day >= 8) {
3050 PyErr_Format(PyExc_ValueError, "Invalid day: %d (range is [1, 7])",
3051 day);
3052 return NULL;
3053 }
3054
3055 // Convert (Y, W, D) to (Y, M, D) in-place
3056 int day_1 = iso_week1_monday(year);
3057
3058 int month = week;
3059 int day_offset = (month - 1)*7 + day - 1;
3060
3061 ord_to_ymd(day_1 + day_offset, &year, &month, &day);
3062
3063 return new_date_subclass_ex(year, month, day, cls);
3064}
3065
3066
Tim Peters2a799bf2002-12-16 20:18:38 +00003067/*
3068 * Date arithmetic.
3069 */
3070
3071/* date + timedelta -> date. If arg negate is true, subtract the timedelta
3072 * instead.
3073 */
3074static PyObject *
3075add_date_timedelta(PyDateTime_Date *date, PyDateTime_Delta *delta, int negate)
3076{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003077 PyObject *result = NULL;
3078 int year = GET_YEAR(date);
3079 int month = GET_MONTH(date);
3080 int deltadays = GET_TD_DAYS(delta);
3081 /* C-level overflow is impossible because |deltadays| < 1e9. */
3082 int day = GET_DAY(date) + (negate ? -deltadays : deltadays);
Tim Peters2a799bf2002-12-16 20:18:38 +00003083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003084 if (normalize_date(&year, &month, &day) >= 0)
Paul Ganssle89427cd2019-02-04 14:42:04 -05003085 result = new_date_subclass_ex(year, month, day,
3086 (PyObject* )Py_TYPE(date));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003087 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003088}
3089
3090static PyObject *
3091date_add(PyObject *left, PyObject *right)
3092{
Brian Curtindfc80e32011-08-10 20:28:54 -05003093 if (PyDateTime_Check(left) || PyDateTime_Check(right))
3094 Py_RETURN_NOTIMPLEMENTED;
3095
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003096 if (PyDate_Check(left)) {
3097 /* date + ??? */
3098 if (PyDelta_Check(right))
3099 /* date + delta */
3100 return add_date_timedelta((PyDateTime_Date *) left,
3101 (PyDateTime_Delta *) right,
3102 0);
3103 }
3104 else {
3105 /* ??? + date
3106 * 'right' must be one of us, or we wouldn't have been called
3107 */
3108 if (PyDelta_Check(left))
3109 /* delta + date */
3110 return add_date_timedelta((PyDateTime_Date *) right,
3111 (PyDateTime_Delta *) left,
3112 0);
3113 }
Brian Curtindfc80e32011-08-10 20:28:54 -05003114 Py_RETURN_NOTIMPLEMENTED;
Tim Peters2a799bf2002-12-16 20:18:38 +00003115}
3116
3117static PyObject *
3118date_subtract(PyObject *left, PyObject *right)
3119{
Brian Curtindfc80e32011-08-10 20:28:54 -05003120 if (PyDateTime_Check(left) || PyDateTime_Check(right))
3121 Py_RETURN_NOTIMPLEMENTED;
3122
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003123 if (PyDate_Check(left)) {
3124 if (PyDate_Check(right)) {
3125 /* date - date */
3126 int left_ord = ymd_to_ord(GET_YEAR(left),
3127 GET_MONTH(left),
3128 GET_DAY(left));
3129 int right_ord = ymd_to_ord(GET_YEAR(right),
3130 GET_MONTH(right),
3131 GET_DAY(right));
3132 return new_delta(left_ord - right_ord, 0, 0, 0);
3133 }
3134 if (PyDelta_Check(right)) {
3135 /* date - delta */
3136 return add_date_timedelta((PyDateTime_Date *) left,
3137 (PyDateTime_Delta *) right,
3138 1);
3139 }
3140 }
Brian Curtindfc80e32011-08-10 20:28:54 -05003141 Py_RETURN_NOTIMPLEMENTED;
Tim Peters2a799bf2002-12-16 20:18:38 +00003142}
3143
3144
3145/* Various ways to turn a date into a string. */
3146
3147static PyObject *
3148date_repr(PyDateTime_Date *self)
3149{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003150 return PyUnicode_FromFormat("%s(%d, %d, %d)",
3151 Py_TYPE(self)->tp_name,
3152 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003153}
3154
3155static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303156date_isoformat(PyDateTime_Date *self, PyObject *Py_UNUSED(ignored))
Tim Peters2a799bf2002-12-16 20:18:38 +00003157{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003158 return PyUnicode_FromFormat("%04d-%02d-%02d",
3159 GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003160}
3161
Tim Peterse2df5ff2003-05-02 18:39:55 +00003162/* str() calls the appropriate isoformat() method. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003163static PyObject *
3164date_str(PyDateTime_Date *self)
3165{
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02003166 return _PyObject_CallMethodIdNoArgs((PyObject *)self, &PyId_isoformat);
Tim Peters2a799bf2002-12-16 20:18:38 +00003167}
3168
3169
3170static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303171date_ctime(PyDateTime_Date *self, PyObject *Py_UNUSED(ignored))
Tim Peters2a799bf2002-12-16 20:18:38 +00003172{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003173 return format_ctime(self, 0, 0, 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00003174}
3175
3176static PyObject *
3177date_strftime(PyDateTime_Date *self, PyObject *args, PyObject *kw)
3178{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003179 /* This method can be inherited, and needs to call the
3180 * timetuple() method appropriate to self's class.
3181 */
3182 PyObject *result;
3183 PyObject *tuple;
3184 PyObject *format;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02003185 _Py_IDENTIFIER(timetuple);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003186 static char *keywords[] = {"format", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00003187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003188 if (! PyArg_ParseTupleAndKeywords(args, kw, "U:strftime", keywords,
3189 &format))
3190 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003191
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02003192 tuple = _PyObject_CallMethodIdNoArgs((PyObject *)self, &PyId_timetuple);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003193 if (tuple == NULL)
3194 return NULL;
3195 result = wrap_strftime((PyObject *)self, format, tuple,
3196 (PyObject *)self);
3197 Py_DECREF(tuple);
3198 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00003199}
3200
Eric Smith1ba31142007-09-11 18:06:02 +00003201static PyObject *
3202date_format(PyDateTime_Date *self, PyObject *args)
3203{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003204 PyObject *format;
Eric Smith1ba31142007-09-11 18:06:02 +00003205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003206 if (!PyArg_ParseTuple(args, "U:__format__", &format))
3207 return NULL;
Eric Smith1ba31142007-09-11 18:06:02 +00003208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003209 /* if the format is zero length, return str(self) */
Victor Stinner9e30aa52011-11-21 02:49:52 +01003210 if (PyUnicode_GetLength(format) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003211 return PyObject_Str((PyObject *)self);
Eric Smith1ba31142007-09-11 18:06:02 +00003212
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02003213 return _PyObject_CallMethodIdOneArg((PyObject *)self, &PyId_strftime,
3214 format);
Eric Smith1ba31142007-09-11 18:06:02 +00003215}
3216
Tim Peters2a799bf2002-12-16 20:18:38 +00003217/* ISO methods. */
3218
3219static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303220date_isoweekday(PyDateTime_Date *self, PyObject *Py_UNUSED(ignored))
Tim Peters2a799bf2002-12-16 20:18:38 +00003221{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003222 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003223
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003224 return PyLong_FromLong(dow + 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00003225}
3226
3227static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303228date_isocalendar(PyDateTime_Date *self, PyObject *Py_UNUSED(ignored))
Tim Peters2a799bf2002-12-16 20:18:38 +00003229{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003230 int year = GET_YEAR(self);
3231 int week1_monday = iso_week1_monday(year);
3232 int today = ymd_to_ord(year, GET_MONTH(self), GET_DAY(self));
3233 int week;
3234 int day;
Tim Peters2a799bf2002-12-16 20:18:38 +00003235
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003236 week = divmod(today - week1_monday, 7, &day);
3237 if (week < 0) {
3238 --year;
3239 week1_monday = iso_week1_monday(year);
3240 week = divmod(today - week1_monday, 7, &day);
3241 }
3242 else if (week >= 52 && today >= iso_week1_monday(year + 1)) {
3243 ++year;
3244 week = 0;
3245 }
3246 return Py_BuildValue("iii", year, week + 1, day + 1);
Tim Peters2a799bf2002-12-16 20:18:38 +00003247}
3248
3249/* Miscellaneous methods. */
3250
Tim Peters2a799bf2002-12-16 20:18:38 +00003251static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00003252date_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters2a799bf2002-12-16 20:18:38 +00003253{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003254 if (PyDate_Check(other)) {
3255 int diff = memcmp(((PyDateTime_Date *)self)->data,
3256 ((PyDateTime_Date *)other)->data,
3257 _PyDateTime_DATE_DATASIZE);
3258 return diff_to_bool(diff, op);
3259 }
Brian Curtindfc80e32011-08-10 20:28:54 -05003260 else
3261 Py_RETURN_NOTIMPLEMENTED;
Tim Peters2a799bf2002-12-16 20:18:38 +00003262}
3263
3264static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303265date_timetuple(PyDateTime_Date *self, PyObject *Py_UNUSED(ignored))
Tim Peters2a799bf2002-12-16 20:18:38 +00003266{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003267 return build_struct_time(GET_YEAR(self),
3268 GET_MONTH(self),
3269 GET_DAY(self),
3270 0, 0, 0, -1);
Tim Peters2a799bf2002-12-16 20:18:38 +00003271}
3272
Tim Peters12bf3392002-12-24 05:41:27 +00003273static PyObject *
3274date_replace(PyDateTime_Date *self, PyObject *args, PyObject *kw)
3275{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003276 PyObject *clone;
3277 PyObject *tuple;
3278 int year = GET_YEAR(self);
3279 int month = GET_MONTH(self);
3280 int day = GET_DAY(self);
Tim Peters12bf3392002-12-24 05:41:27 +00003281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003282 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iii:replace", date_kws,
3283 &year, &month, &day))
3284 return NULL;
3285 tuple = Py_BuildValue("iii", year, month, day);
3286 if (tuple == NULL)
3287 return NULL;
3288 clone = date_new(Py_TYPE(self), tuple, NULL);
3289 Py_DECREF(tuple);
3290 return clone;
Tim Peters12bf3392002-12-24 05:41:27 +00003291}
3292
Benjamin Peterson8f67d082010-10-17 20:54:53 +00003293static Py_hash_t
Guido van Rossumfd53fd62007-08-24 04:05:13 +00003294generic_hash(unsigned char *data, int len)
3295{
Gregory P. Smith5831bd22012-01-14 14:31:13 -08003296 return _Py_HashBytes(data, len);
Guido van Rossumfd53fd62007-08-24 04:05:13 +00003297}
3298
3299
3300static PyObject *date_getstate(PyDateTime_Date *self);
Tim Peters2a799bf2002-12-16 20:18:38 +00003301
Benjamin Peterson8f67d082010-10-17 20:54:53 +00003302static Py_hash_t
Tim Peters2a799bf2002-12-16 20:18:38 +00003303date_hash(PyDateTime_Date *self)
3304{
Benjamin Petersondec2df32016-09-09 17:46:24 -07003305 if (self->hashcode == -1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003306 self->hashcode = generic_hash(
3307 (unsigned char *)self->data, _PyDateTime_DATE_DATASIZE);
Benjamin Petersondec2df32016-09-09 17:46:24 -07003308 }
Guido van Rossum254348e2007-11-21 19:29:53 +00003309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003310 return self->hashcode;
Tim Peters2a799bf2002-12-16 20:18:38 +00003311}
3312
3313static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303314date_toordinal(PyDateTime_Date *self, PyObject *Py_UNUSED(ignored))
Tim Peters2a799bf2002-12-16 20:18:38 +00003315{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003316 return PyLong_FromLong(ymd_to_ord(GET_YEAR(self), GET_MONTH(self),
3317 GET_DAY(self)));
Tim Peters2a799bf2002-12-16 20:18:38 +00003318}
3319
3320static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303321date_weekday(PyDateTime_Date *self, PyObject *Py_UNUSED(ignored))
Tim Peters2a799bf2002-12-16 20:18:38 +00003322{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003323 int dow = weekday(GET_YEAR(self), GET_MONTH(self), GET_DAY(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003324
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003325 return PyLong_FromLong(dow);
Tim Peters2a799bf2002-12-16 20:18:38 +00003326}
3327
Tim Peters371935f2003-02-01 01:52:50 +00003328/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00003329
Tim Petersb57f8f02003-02-01 02:54:15 +00003330/* __getstate__ isn't exposed */
Tim Peters2a799bf2002-12-16 20:18:38 +00003331static PyObject *
Guido van Rossumfd53fd62007-08-24 04:05:13 +00003332date_getstate(PyDateTime_Date *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00003333{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003334 PyObject* field;
3335 field = PyBytes_FromStringAndSize((char*)self->data,
3336 _PyDateTime_DATE_DATASIZE);
3337 return Py_BuildValue("(N)", field);
Tim Peters2a799bf2002-12-16 20:18:38 +00003338}
3339
3340static PyObject *
Guido van Rossum177e41a2003-01-30 22:06:23 +00003341date_reduce(PyDateTime_Date *self, PyObject *arg)
Tim Peters2a799bf2002-12-16 20:18:38 +00003342{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003343 return Py_BuildValue("(ON)", Py_TYPE(self), date_getstate(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003344}
3345
3346static PyMethodDef date_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003348 /* Class methods: */
Tim Hoffmanna0fd7f12018-09-24 10:39:02 +02003349 DATETIME_DATE_FROMTIMESTAMP_METHODDEF
Tim Peters2a799bf2002-12-16 20:18:38 +00003350
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003351 {"fromordinal", (PyCFunction)date_fromordinal, METH_VARARGS |
3352 METH_CLASS,
3353 PyDoc_STR("int -> date corresponding to a proleptic Gregorian "
3354 "ordinal.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003355
Paul Ganssle09dc2f52017-12-21 00:33:49 -05003356 {"fromisoformat", (PyCFunction)date_fromisoformat, METH_O |
3357 METH_CLASS,
3358 PyDoc_STR("str -> Construct a date from the output of date.isoformat()")},
3359
Paul Ganssle88c09372019-04-29 09:22:03 -04003360 {"fromisocalendar", (PyCFunction)(void(*)(void))date_fromisocalendar,
3361 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
3362 PyDoc_STR("int, int, int -> Construct a date from the ISO year, week "
3363 "number and weekday.\n\n"
3364 "This is the inverse of the date.isocalendar() function")},
3365
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003366 {"today", (PyCFunction)date_today, METH_NOARGS | METH_CLASS,
3367 PyDoc_STR("Current date or datetime: same as "
3368 "self.__class__.fromtimestamp(time.time()).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003369
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003370 /* Instance methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00003371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003372 {"ctime", (PyCFunction)date_ctime, METH_NOARGS,
3373 PyDoc_STR("Return ctime() style string.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003374
Serhiy Storchaka62be7422018-11-27 13:27:31 +02003375 {"strftime", (PyCFunction)(void(*)(void))date_strftime, METH_VARARGS | METH_KEYWORDS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003376 PyDoc_STR("format -> strftime() style string.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003377
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003378 {"__format__", (PyCFunction)date_format, METH_VARARGS,
3379 PyDoc_STR("Formats self with strftime.")},
Eric Smith1ba31142007-09-11 18:06:02 +00003380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003381 {"timetuple", (PyCFunction)date_timetuple, METH_NOARGS,
3382 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003383
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003384 {"isocalendar", (PyCFunction)date_isocalendar, METH_NOARGS,
3385 PyDoc_STR("Return a 3-tuple containing ISO year, week number, and "
3386 "weekday.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003388 {"isoformat", (PyCFunction)date_isoformat, METH_NOARGS,
3389 PyDoc_STR("Return string in ISO 8601 format, YYYY-MM-DD.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003390
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003391 {"isoweekday", (PyCFunction)date_isoweekday, METH_NOARGS,
3392 PyDoc_STR("Return the day of the week represented by the date.\n"
3393 "Monday == 1 ... Sunday == 7")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003395 {"toordinal", (PyCFunction)date_toordinal, METH_NOARGS,
3396 PyDoc_STR("Return proleptic Gregorian ordinal. January 1 of year "
3397 "1 is day 1.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003398
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003399 {"weekday", (PyCFunction)date_weekday, METH_NOARGS,
3400 PyDoc_STR("Return the day of the week represented by the date.\n"
3401 "Monday == 0 ... Sunday == 6")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003402
Serhiy Storchaka62be7422018-11-27 13:27:31 +02003403 {"replace", (PyCFunction)(void(*)(void))date_replace, METH_VARARGS | METH_KEYWORDS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003404 PyDoc_STR("Return date with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00003405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003406 {"__reduce__", (PyCFunction)date_reduce, METH_NOARGS,
3407 PyDoc_STR("__reduce__() -> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00003408
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003409 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003410};
3411
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02003412static const char date_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00003413PyDoc_STR("date(year, month, day) --> date object");
Tim Peters2a799bf2002-12-16 20:18:38 +00003414
3415static PyNumberMethods date_as_number = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003416 date_add, /* nb_add */
3417 date_subtract, /* nb_subtract */
3418 0, /* nb_multiply */
3419 0, /* nb_remainder */
3420 0, /* nb_divmod */
3421 0, /* nb_power */
3422 0, /* nb_negative */
3423 0, /* nb_positive */
3424 0, /* nb_absolute */
3425 0, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00003426};
3427
3428static PyTypeObject PyDateTime_DateType = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003429 PyVarObject_HEAD_INIT(NULL, 0)
3430 "datetime.date", /* tp_name */
3431 sizeof(PyDateTime_Date), /* tp_basicsize */
3432 0, /* tp_itemsize */
3433 0, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02003434 0, /* tp_vectorcall_offset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003435 0, /* tp_getattr */
3436 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02003437 0, /* tp_as_async */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003438 (reprfunc)date_repr, /* tp_repr */
3439 &date_as_number, /* tp_as_number */
3440 0, /* tp_as_sequence */
3441 0, /* tp_as_mapping */
3442 (hashfunc)date_hash, /* tp_hash */
3443 0, /* tp_call */
3444 (reprfunc)date_str, /* tp_str */
3445 PyObject_GenericGetAttr, /* tp_getattro */
3446 0, /* tp_setattro */
3447 0, /* tp_as_buffer */
3448 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
3449 date_doc, /* tp_doc */
3450 0, /* tp_traverse */
3451 0, /* tp_clear */
3452 date_richcompare, /* tp_richcompare */
3453 0, /* tp_weaklistoffset */
3454 0, /* tp_iter */
3455 0, /* tp_iternext */
3456 date_methods, /* tp_methods */
3457 0, /* tp_members */
3458 date_getset, /* tp_getset */
3459 0, /* tp_base */
3460 0, /* tp_dict */
3461 0, /* tp_descr_get */
3462 0, /* tp_descr_set */
3463 0, /* tp_dictoffset */
3464 0, /* tp_init */
3465 0, /* tp_alloc */
3466 date_new, /* tp_new */
3467 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00003468};
3469
3470/*
Tim Peters2a799bf2002-12-16 20:18:38 +00003471 * PyDateTime_TZInfo implementation.
3472 */
3473
3474/* This is a pure abstract base class, so doesn't do anything beyond
3475 * raising NotImplemented exceptions. Real tzinfo classes need
3476 * to derive from this. This is mostly for clarity, and for efficiency in
Tim Petersa9bc1682003-01-11 03:39:11 +00003477 * datetime and time constructors (their tzinfo arguments need to
Tim Peters2a799bf2002-12-16 20:18:38 +00003478 * be subclasses of this tzinfo class, which is easy and quick to check).
3479 *
3480 * Note: For reasons having to do with pickling of subclasses, we have
3481 * to allow tzinfo objects to be instantiated. This wasn't an issue
3482 * in the Python implementation (__init__() could raise NotImplementedError
3483 * there without ill effect), but doing so in the C implementation hit a
3484 * brick wall.
3485 */
3486
3487static PyObject *
3488tzinfo_nogo(const char* methodname)
3489{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003490 PyErr_Format(PyExc_NotImplementedError,
3491 "a tzinfo subclass must implement %s()",
3492 methodname);
3493 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00003494}
3495
3496/* Methods. A subclass must implement these. */
3497
Tim Peters52dcce22003-01-23 16:36:11 +00003498static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00003499tzinfo_tzname(PyDateTime_TZInfo *self, PyObject *dt)
3500{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003501 return tzinfo_nogo("tzname");
Tim Peters2a799bf2002-12-16 20:18:38 +00003502}
3503
Tim Peters52dcce22003-01-23 16:36:11 +00003504static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00003505tzinfo_utcoffset(PyDateTime_TZInfo *self, PyObject *dt)
3506{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003507 return tzinfo_nogo("utcoffset");
Tim Peters2a799bf2002-12-16 20:18:38 +00003508}
3509
Tim Peters52dcce22003-01-23 16:36:11 +00003510static PyObject *
Tim Peters2a799bf2002-12-16 20:18:38 +00003511tzinfo_dst(PyDateTime_TZInfo *self, PyObject *dt)
3512{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003513 return tzinfo_nogo("dst");
Tim Peters2a799bf2002-12-16 20:18:38 +00003514}
3515
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003516
3517static PyObject *add_datetime_timedelta(PyDateTime_DateTime *date,
3518 PyDateTime_Delta *delta,
3519 int factor);
3520static PyObject *datetime_utcoffset(PyObject *self, PyObject *);
3521static PyObject *datetime_dst(PyObject *self, PyObject *);
3522
Tim Peters52dcce22003-01-23 16:36:11 +00003523static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003524tzinfo_fromutc(PyDateTime_TZInfo *self, PyObject *dt)
Tim Peters52dcce22003-01-23 16:36:11 +00003525{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003526 PyObject *result = NULL;
3527 PyObject *off = NULL, *dst = NULL;
3528 PyDateTime_Delta *delta = NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00003529
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003530 if (!PyDateTime_Check(dt)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003531 PyErr_SetString(PyExc_TypeError,
3532 "fromutc: argument must be a datetime");
3533 return NULL;
3534 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003535 if (GET_DT_TZINFO(dt) != (PyObject *)self) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003536 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
3537 "is not self");
3538 return NULL;
3539 }
Tim Peters52dcce22003-01-23 16:36:11 +00003540
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003541 off = datetime_utcoffset(dt, NULL);
3542 if (off == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003543 return NULL;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003544 if (off == Py_None) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003545 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
3546 "utcoffset() result required");
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003547 goto Fail;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003548 }
Tim Peters52dcce22003-01-23 16:36:11 +00003549
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003550 dst = datetime_dst(dt, NULL);
3551 if (dst == NULL)
3552 goto Fail;
3553 if (dst == Py_None) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003554 PyErr_SetString(PyExc_ValueError, "fromutc: non-None "
3555 "dst() result required");
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003556 goto Fail;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003557 }
Tim Peters52dcce22003-01-23 16:36:11 +00003558
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003559 delta = (PyDateTime_Delta *)delta_subtract(off, dst);
3560 if (delta == NULL)
3561 goto Fail;
3562 result = add_datetime_timedelta((PyDateTime_DateTime *)dt, delta, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003563 if (result == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003564 goto Fail;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003565
3566 Py_DECREF(dst);
3567 dst = call_dst(GET_DT_TZINFO(dt), result);
3568 if (dst == NULL)
3569 goto Fail;
3570 if (dst == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003571 goto Inconsistent;
Alexander Belopolskyc79447b2015-09-27 21:41:55 -04003572 if (delta_bool((PyDateTime_Delta *)dst) != 0) {
Serhiy Storchakaf01e4082016-04-10 18:12:01 +03003573 Py_SETREF(result, add_datetime_timedelta((PyDateTime_DateTime *)result,
Serhiy Storchaka576f1322016-01-05 21:27:54 +02003574 (PyDateTime_Delta *)dst, 1));
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003575 if (result == NULL)
3576 goto Fail;
3577 }
3578 Py_DECREF(delta);
3579 Py_DECREF(dst);
3580 Py_DECREF(off);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003581 return result;
Tim Peters52dcce22003-01-23 16:36:11 +00003582
3583Inconsistent:
Serhiy Storchaka34fd4c22018-11-05 16:20:25 +02003584 PyErr_SetString(PyExc_ValueError, "fromutc: tz.dst() gave "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003585 "inconsistent results; cannot convert");
Tim Peters52dcce22003-01-23 16:36:11 +00003586
Leo Ariasc3d95082018-02-03 18:36:10 -06003587 /* fall through to failure */
Tim Peters52dcce22003-01-23 16:36:11 +00003588Fail:
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003589 Py_XDECREF(off);
3590 Py_XDECREF(dst);
3591 Py_XDECREF(delta);
3592 Py_XDECREF(result);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003593 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00003594}
3595
Tim Peters2a799bf2002-12-16 20:18:38 +00003596/*
3597 * Pickle support. This is solely so that tzinfo subclasses can use
Guido van Rossum177e41a2003-01-30 22:06:23 +00003598 * pickling -- tzinfo itself is supposed to be uninstantiable.
Tim Peters2a799bf2002-12-16 20:18:38 +00003599 */
3600
Guido van Rossum177e41a2003-01-30 22:06:23 +00003601static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303602tzinfo_reduce(PyObject *self, PyObject *Py_UNUSED(ignored))
Guido van Rossum177e41a2003-01-30 22:06:23 +00003603{
Victor Stinnerd1584d32016-08-23 00:11:04 +02003604 PyObject *args, *state;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003605 PyObject *getinitargs, *getstate;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02003606 _Py_IDENTIFIER(__getinitargs__);
3607 _Py_IDENTIFIER(__getstate__);
Tim Peters2a799bf2002-12-16 20:18:38 +00003608
Serhiy Storchaka41c57b32019-09-01 12:03:39 +03003609 if (_PyObject_LookupAttrId(self, &PyId___getinitargs__, &getinitargs) < 0) {
3610 return NULL;
3611 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003612 if (getinitargs != NULL) {
Victor Stinner2ff58a22019-06-17 14:27:23 +02003613 args = PyObject_CallNoArgs(getinitargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003614 Py_DECREF(getinitargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003615 }
3616 else {
Victor Stinnerd1584d32016-08-23 00:11:04 +02003617 args = PyTuple_New(0);
Serhiy Storchaka41c57b32019-09-01 12:03:39 +03003618 }
3619 if (args == NULL) {
3620 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003621 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00003622
Serhiy Storchaka41c57b32019-09-01 12:03:39 +03003623 if (_PyObject_LookupAttrId(self, &PyId___getstate__, &getstate) < 0) {
3624 Py_DECREF(args);
3625 return NULL;
3626 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003627 if (getstate != NULL) {
Victor Stinner2ff58a22019-06-17 14:27:23 +02003628 state = PyObject_CallNoArgs(getstate);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003629 Py_DECREF(getstate);
3630 if (state == NULL) {
3631 Py_DECREF(args);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003632 return NULL;
3633 }
3634 }
3635 else {
3636 PyObject **dictptr;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003637 state = Py_None;
3638 dictptr = _PyObject_GetDictPtr(self);
Serhiy Storchaka5ab81d72016-12-16 16:18:57 +02003639 if (dictptr && *dictptr && PyDict_GET_SIZE(*dictptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003640 state = *dictptr;
Victor Stinnerd1584d32016-08-23 00:11:04 +02003641 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003642 Py_INCREF(state);
3643 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00003644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003645 if (state == Py_None) {
3646 Py_DECREF(state);
3647 return Py_BuildValue("(ON)", Py_TYPE(self), args);
3648 }
3649 else
3650 return Py_BuildValue("(ONN)", Py_TYPE(self), args, state);
Guido van Rossum177e41a2003-01-30 22:06:23 +00003651}
Tim Peters2a799bf2002-12-16 20:18:38 +00003652
3653static PyMethodDef tzinfo_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00003654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003655 {"tzname", (PyCFunction)tzinfo_tzname, METH_O,
3656 PyDoc_STR("datetime -> string name of time zone.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003658 {"utcoffset", (PyCFunction)tzinfo_utcoffset, METH_O,
Sean Reifscheiderdeda8cb2010-06-04 01:51:38 +00003659 PyDoc_STR("datetime -> timedelta showing offset from UTC, negative "
3660 "values indicating West of UTC")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003662 {"dst", (PyCFunction)tzinfo_dst, METH_O,
Alexander Belopolsky018d3532017-07-31 10:26:50 -04003663 PyDoc_STR("datetime -> DST offset as timedelta positive east of UTC.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00003664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003665 {"fromutc", (PyCFunction)tzinfo_fromutc, METH_O,
Alexander Belopolsky2f194b92010-07-03 03:35:27 +00003666 PyDoc_STR("datetime in UTC -> datetime in local time.")},
Tim Peters52dcce22003-01-23 16:36:11 +00003667
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303668 {"__reduce__", tzinfo_reduce, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003669 PyDoc_STR("-> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00003670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003671 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00003672};
3673
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02003674static const char tzinfo_doc[] =
Tim Peters2a799bf2002-12-16 20:18:38 +00003675PyDoc_STR("Abstract base class for time zone info objects.");
3676
Neal Norwitz227b5332006-03-22 09:28:35 +00003677static PyTypeObject PyDateTime_TZInfoType = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003678 PyVarObject_HEAD_INIT(NULL, 0)
3679 "datetime.tzinfo", /* tp_name */
3680 sizeof(PyDateTime_TZInfo), /* tp_basicsize */
3681 0, /* tp_itemsize */
3682 0, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02003683 0, /* tp_vectorcall_offset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003684 0, /* tp_getattr */
3685 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02003686 0, /* tp_as_async */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003687 0, /* tp_repr */
3688 0, /* tp_as_number */
3689 0, /* tp_as_sequence */
3690 0, /* tp_as_mapping */
3691 0, /* tp_hash */
3692 0, /* tp_call */
3693 0, /* tp_str */
3694 PyObject_GenericGetAttr, /* tp_getattro */
3695 0, /* tp_setattro */
3696 0, /* tp_as_buffer */
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003697 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003698 tzinfo_doc, /* tp_doc */
3699 0, /* tp_traverse */
3700 0, /* tp_clear */
3701 0, /* tp_richcompare */
3702 0, /* tp_weaklistoffset */
3703 0, /* tp_iter */
3704 0, /* tp_iternext */
3705 tzinfo_methods, /* tp_methods */
3706 0, /* tp_members */
3707 0, /* tp_getset */
3708 0, /* tp_base */
3709 0, /* tp_dict */
3710 0, /* tp_descr_get */
3711 0, /* tp_descr_set */
3712 0, /* tp_dictoffset */
3713 0, /* tp_init */
3714 0, /* tp_alloc */
3715 PyType_GenericNew, /* tp_new */
3716 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00003717};
3718
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003719static char *timezone_kws[] = {"offset", "name", NULL};
3720
3721static PyObject *
3722timezone_new(PyTypeObject *type, PyObject *args, PyObject *kw)
3723{
3724 PyObject *offset;
3725 PyObject *name = NULL;
Serhiy Storchakaf8d7d412016-10-23 15:12:25 +03003726 if (PyArg_ParseTupleAndKeywords(args, kw, "O!|U:timezone", timezone_kws,
3727 &PyDateTime_DeltaType, &offset, &name))
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003728 return new_timezone(offset, name);
3729
3730 return NULL;
3731}
3732
3733static void
3734timezone_dealloc(PyDateTime_TimeZone *self)
3735{
3736 Py_CLEAR(self->offset);
3737 Py_CLEAR(self->name);
3738 Py_TYPE(self)->tp_free((PyObject *)self);
3739}
3740
3741static PyObject *
3742timezone_richcompare(PyDateTime_TimeZone *self,
3743 PyDateTime_TimeZone *other, int op)
3744{
Brian Curtindfc80e32011-08-10 20:28:54 -05003745 if (op != Py_EQ && op != Py_NE)
3746 Py_RETURN_NOTIMPLEMENTED;
Pablo Galindo4be11c02019-08-22 20:24:25 +01003747 if (!PyTimezone_Check(other)) {
Serhiy Storchaka17e52642019-08-04 12:38:46 +03003748 Py_RETURN_NOTIMPLEMENTED;
Georg Brandl0085a242012-09-22 09:23:12 +02003749 }
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003750 return delta_richcompare(self->offset, other->offset, op);
3751}
3752
Benjamin Peterson8f67d082010-10-17 20:54:53 +00003753static Py_hash_t
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003754timezone_hash(PyDateTime_TimeZone *self)
3755{
3756 return delta_hash((PyDateTime_Delta *)self->offset);
3757}
3758
3759/* Check argument type passed to tzname, utcoffset, or dst methods.
3760 Returns 0 for good argument. Returns -1 and sets exception info
3761 otherwise.
3762 */
3763static int
3764_timezone_check_argument(PyObject *dt, const char *meth)
3765{
3766 if (dt == Py_None || PyDateTime_Check(dt))
3767 return 0;
3768 PyErr_Format(PyExc_TypeError, "%s(dt) argument must be a datetime instance"
3769 " or None, not %.200s", meth, Py_TYPE(dt)->tp_name);
3770 return -1;
3771}
3772
3773static PyObject *
Alexander Belopolskya11d8c02010-07-06 23:19:45 +00003774timezone_repr(PyDateTime_TimeZone *self)
3775{
3776 /* Note that although timezone is not subclassable, it is convenient
3777 to use Py_TYPE(self)->tp_name here. */
3778 const char *type_name = Py_TYPE(self)->tp_name;
3779
3780 if (((PyObject *)self) == PyDateTime_TimeZone_UTC)
3781 return PyUnicode_FromFormat("%s.utc", type_name);
3782
3783 if (self->name == NULL)
3784 return PyUnicode_FromFormat("%s(%R)", type_name, self->offset);
3785
3786 return PyUnicode_FromFormat("%s(%R, %R)", type_name, self->offset,
3787 self->name);
3788}
3789
3790
3791static PyObject *
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003792timezone_str(PyDateTime_TimeZone *self)
3793{
Alexander Belopolsky018d3532017-07-31 10:26:50 -04003794 int hours, minutes, seconds, microseconds;
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003795 PyObject *offset;
3796 char sign;
3797
3798 if (self->name != NULL) {
3799 Py_INCREF(self->name);
3800 return self->name;
3801 }
Victor Stinner90fd8952015-09-08 00:12:49 +02003802 if ((PyObject *)self == PyDateTime_TimeZone_UTC ||
Alexander Belopolsky7827a5b2015-09-06 13:07:21 -04003803 (GET_TD_DAYS(self->offset) == 0 &&
3804 GET_TD_SECONDS(self->offset) == 0 &&
3805 GET_TD_MICROSECONDS(self->offset) == 0))
3806 return PyUnicode_FromString("UTC");
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003807 /* Offset is normalized, so it is negative if days < 0 */
3808 if (GET_TD_DAYS(self->offset) < 0) {
3809 sign = '-';
3810 offset = delta_negative((PyDateTime_Delta *)self->offset);
3811 if (offset == NULL)
3812 return NULL;
3813 }
3814 else {
3815 sign = '+';
3816 offset = self->offset;
3817 Py_INCREF(offset);
3818 }
3819 /* Offset is not negative here. */
Alexander Belopolsky018d3532017-07-31 10:26:50 -04003820 microseconds = GET_TD_MICROSECONDS(offset);
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003821 seconds = GET_TD_SECONDS(offset);
3822 Py_DECREF(offset);
3823 minutes = divmod(seconds, 60, &seconds);
3824 hours = divmod(minutes, 60, &minutes);
Alexander Belopolsky018d3532017-07-31 10:26:50 -04003825 if (microseconds != 0) {
3826 return PyUnicode_FromFormat("UTC%c%02d:%02d:%02d.%06d",
3827 sign, hours, minutes,
3828 seconds, microseconds);
3829 }
3830 if (seconds != 0) {
3831 return PyUnicode_FromFormat("UTC%c%02d:%02d:%02d",
3832 sign, hours, minutes, seconds);
3833 }
Victor Stinner6ced7c42011-03-21 18:15:42 +01003834 return PyUnicode_FromFormat("UTC%c%02d:%02d", sign, hours, minutes);
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003835}
3836
3837static PyObject *
3838timezone_tzname(PyDateTime_TimeZone *self, PyObject *dt)
3839{
3840 if (_timezone_check_argument(dt, "tzname") == -1)
3841 return NULL;
3842
3843 return timezone_str(self);
3844}
3845
3846static PyObject *
3847timezone_utcoffset(PyDateTime_TimeZone *self, PyObject *dt)
3848{
3849 if (_timezone_check_argument(dt, "utcoffset") == -1)
3850 return NULL;
3851
3852 Py_INCREF(self->offset);
3853 return self->offset;
3854}
3855
3856static PyObject *
3857timezone_dst(PyObject *self, PyObject *dt)
3858{
3859 if (_timezone_check_argument(dt, "dst") == -1)
3860 return NULL;
3861
3862 Py_RETURN_NONE;
3863}
3864
3865static PyObject *
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003866timezone_fromutc(PyDateTime_TimeZone *self, PyDateTime_DateTime *dt)
3867{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003868 if (!PyDateTime_Check(dt)) {
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003869 PyErr_SetString(PyExc_TypeError,
3870 "fromutc: argument must be a datetime");
3871 return NULL;
3872 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00003873 if (!HASTZINFO(dt) || dt->tzinfo != (PyObject *)self) {
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003874 PyErr_SetString(PyExc_ValueError, "fromutc: dt.tzinfo "
3875 "is not self");
3876 return NULL;
3877 }
3878
3879 return add_datetime_timedelta(dt, (PyDateTime_Delta *)self->offset, 1);
3880}
3881
Alexander Belopolsky1b7046b2010-06-23 21:40:15 +00003882static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303883timezone_getinitargs(PyDateTime_TimeZone *self, PyObject *Py_UNUSED(ignored))
Alexander Belopolsky1b7046b2010-06-23 21:40:15 +00003884{
3885 if (self->name == NULL)
3886 return Py_BuildValue("(O)", self->offset);
3887 return Py_BuildValue("(OO)", self->offset, self->name);
3888}
3889
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003890static PyMethodDef timezone_methods[] = {
3891 {"tzname", (PyCFunction)timezone_tzname, METH_O,
3892 PyDoc_STR("If name is specified when timezone is created, returns the name."
Alexander Belopolskyb39a0c22010-06-15 19:24:52 +00003893 " Otherwise returns offset as 'UTC(+|-)HH:MM'.")},
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003894
3895 {"utcoffset", (PyCFunction)timezone_utcoffset, METH_O,
Alexander Belopolskyb39a0c22010-06-15 19:24:52 +00003896 PyDoc_STR("Return fixed offset.")},
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003897
3898 {"dst", (PyCFunction)timezone_dst, METH_O,
Alexander Belopolskyb39a0c22010-06-15 19:24:52 +00003899 PyDoc_STR("Return None.")},
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003900
3901 {"fromutc", (PyCFunction)timezone_fromutc, METH_O,
3902 PyDoc_STR("datetime in UTC -> datetime in local time.")},
3903
Alexander Belopolsky1b7046b2010-06-23 21:40:15 +00003904 {"__getinitargs__", (PyCFunction)timezone_getinitargs, METH_NOARGS,
3905 PyDoc_STR("pickle support")},
3906
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003907 {NULL, NULL}
3908};
3909
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02003910static const char timezone_doc[] =
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003911PyDoc_STR("Fixed offset from UTC implementation of tzinfo.");
3912
3913static PyTypeObject PyDateTime_TimeZoneType = {
3914 PyVarObject_HEAD_INIT(NULL, 0)
3915 "datetime.timezone", /* tp_name */
3916 sizeof(PyDateTime_TimeZone), /* tp_basicsize */
3917 0, /* tp_itemsize */
3918 (destructor)timezone_dealloc, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02003919 0, /* tp_vectorcall_offset */
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003920 0, /* tp_getattr */
3921 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02003922 0, /* tp_as_async */
Alexander Belopolskya11d8c02010-07-06 23:19:45 +00003923 (reprfunc)timezone_repr, /* tp_repr */
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00003924 0, /* tp_as_number */
3925 0, /* tp_as_sequence */
3926 0, /* tp_as_mapping */
3927 (hashfunc)timezone_hash, /* tp_hash */
3928 0, /* tp_call */
3929 (reprfunc)timezone_str, /* tp_str */
3930 0, /* tp_getattro */
3931 0, /* tp_setattro */
3932 0, /* tp_as_buffer */
3933 Py_TPFLAGS_DEFAULT, /* tp_flags */
3934 timezone_doc, /* tp_doc */
3935 0, /* tp_traverse */
3936 0, /* tp_clear */
3937 (richcmpfunc)timezone_richcompare,/* tp_richcompare */
3938 0, /* tp_weaklistoffset */
3939 0, /* tp_iter */
3940 0, /* tp_iternext */
3941 timezone_methods, /* tp_methods */
3942 0, /* tp_members */
3943 0, /* tp_getset */
3944 &PyDateTime_TZInfoType, /* tp_base */
3945 0, /* tp_dict */
3946 0, /* tp_descr_get */
3947 0, /* tp_descr_set */
3948 0, /* tp_dictoffset */
3949 0, /* tp_init */
3950 0, /* tp_alloc */
3951 timezone_new, /* tp_new */
3952};
3953
Tim Peters2a799bf2002-12-16 20:18:38 +00003954/*
Tim Peters37f39822003-01-10 03:49:02 +00003955 * PyDateTime_Time implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00003956 */
3957
Tim Peters37f39822003-01-10 03:49:02 +00003958/* Accessor properties.
Tim Peters2a799bf2002-12-16 20:18:38 +00003959 */
3960
3961static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00003962time_hour(PyDateTime_Time *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00003963{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003964 return PyLong_FromLong(TIME_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00003965}
3966
Tim Peters37f39822003-01-10 03:49:02 +00003967static PyObject *
3968time_minute(PyDateTime_Time *self, void *unused)
3969{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003970 return PyLong_FromLong(TIME_GET_MINUTE(self));
Tim Peters37f39822003-01-10 03:49:02 +00003971}
3972
3973/* The name time_second conflicted with some platform header file. */
3974static PyObject *
3975py_time_second(PyDateTime_Time *self, void *unused)
3976{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003977 return PyLong_FromLong(TIME_GET_SECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003978}
3979
3980static PyObject *
3981time_microsecond(PyDateTime_Time *self, void *unused)
3982{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003983 return PyLong_FromLong(TIME_GET_MICROSECOND(self));
Tim Peters37f39822003-01-10 03:49:02 +00003984}
3985
3986static PyObject *
3987time_tzinfo(PyDateTime_Time *self, void *unused)
3988{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003989 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
3990 Py_INCREF(result);
3991 return result;
Tim Peters37f39822003-01-10 03:49:02 +00003992}
3993
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04003994static PyObject *
3995time_fold(PyDateTime_Time *self, void *unused)
3996{
3997 return PyLong_FromLong(TIME_GET_FOLD(self));
3998}
3999
Tim Peters37f39822003-01-10 03:49:02 +00004000static PyGetSetDef time_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004001 {"hour", (getter)time_hour},
4002 {"minute", (getter)time_minute},
4003 {"second", (getter)py_time_second},
4004 {"microsecond", (getter)time_microsecond},
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004005 {"tzinfo", (getter)time_tzinfo},
4006 {"fold", (getter)time_fold},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004007 {NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00004008};
4009
4010/*
4011 * Constructors.
4012 */
4013
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004014static char *time_kws[] = {"hour", "minute", "second", "microsecond",
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004015 "tzinfo", "fold", NULL};
Tim Peters12bf3392002-12-24 05:41:27 +00004016
Tim Peters2a799bf2002-12-16 20:18:38 +00004017static PyObject *
Serhiy Storchaka8452ca12018-12-07 13:42:10 +02004018time_from_pickle(PyTypeObject *type, PyObject *state, PyObject *tzinfo)
4019{
4020 PyDateTime_Time *me;
4021 char aware = (char)(tzinfo != Py_None);
4022
4023 if (aware && check_tzinfo_subclass(tzinfo) < 0) {
4024 PyErr_SetString(PyExc_TypeError, "bad tzinfo state arg");
4025 return NULL;
4026 }
4027
4028 me = (PyDateTime_Time *) (type->tp_alloc(type, aware));
4029 if (me != NULL) {
4030 const char *pdata = PyBytes_AS_STRING(state);
4031
4032 memcpy(me->data, pdata, _PyDateTime_TIME_DATASIZE);
4033 me->hashcode = -1;
4034 me->hastzinfo = aware;
4035 if (aware) {
4036 Py_INCREF(tzinfo);
4037 me->tzinfo = tzinfo;
4038 }
4039 if (pdata[0] & (1 << 7)) {
4040 me->data[0] -= 128;
4041 me->fold = 1;
4042 }
4043 else {
4044 me->fold = 0;
4045 }
4046 }
4047 return (PyObject *)me;
4048}
4049
4050static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00004051time_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004052{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004053 PyObject *self = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004054 int hour = 0;
4055 int minute = 0;
4056 int second = 0;
4057 int usecond = 0;
4058 PyObject *tzinfo = Py_None;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004059 int fold = 0;
Tim Peters2a799bf2002-12-16 20:18:38 +00004060
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004061 /* Check for invocation from pickle with __getstate__ state */
Serhiy Storchaka8452ca12018-12-07 13:42:10 +02004062 if (PyTuple_GET_SIZE(args) >= 1 && PyTuple_GET_SIZE(args) <= 2) {
4063 PyObject *state = PyTuple_GET_ITEM(args, 0);
4064 if (PyTuple_GET_SIZE(args) == 2) {
4065 tzinfo = PyTuple_GET_ITEM(args, 1);
4066 }
4067 if (PyBytes_Check(state)) {
4068 if (PyBytes_GET_SIZE(state) == _PyDateTime_TIME_DATASIZE &&
4069 (0x7F & ((unsigned char) (PyBytes_AS_STRING(state)[0]))) < 24)
4070 {
4071 return time_from_pickle(type, state, tzinfo);
4072 }
4073 }
4074 else if (PyUnicode_Check(state)) {
4075 if (PyUnicode_READY(state)) {
4076 return NULL;
4077 }
4078 if (PyUnicode_GET_LENGTH(state) == _PyDateTime_TIME_DATASIZE &&
Justin Blanchard122376d2019-08-29 03:36:15 -04004079 (0x7F & PyUnicode_READ_CHAR(state, 0)) < 24)
Serhiy Storchaka8452ca12018-12-07 13:42:10 +02004080 {
4081 state = PyUnicode_AsLatin1String(state);
4082 if (state == NULL) {
4083 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
4084 /* More informative error message. */
4085 PyErr_SetString(PyExc_ValueError,
4086 "Failed to encode latin1 string when unpickling "
4087 "a time object. "
4088 "pickle.load(data, encoding='latin1') is assumed.");
4089 }
Victor Stinnerb37672d2018-11-22 03:37:50 +01004090 return NULL;
4091 }
Serhiy Storchaka8452ca12018-12-07 13:42:10 +02004092 self = time_from_pickle(type, state, tzinfo);
4093 Py_DECREF(state);
4094 return self;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004095 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004096 }
Serhiy Storchaka8452ca12018-12-07 13:42:10 +02004097 tzinfo = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004098 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00004099
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004100 if (PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO$i", time_kws,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004101 &hour, &minute, &second, &usecond,
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004102 &tzinfo, &fold)) {
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004103 self = new_time_ex2(hour, minute, second, usecond, tzinfo, fold,
4104 type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004105 }
4106 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00004107}
4108
4109/*
4110 * Destructor.
4111 */
4112
4113static void
Tim Peters37f39822003-01-10 03:49:02 +00004114time_dealloc(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004115{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004116 if (HASTZINFO(self)) {
4117 Py_XDECREF(self->tzinfo);
4118 }
4119 Py_TYPE(self)->tp_free((PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00004120}
4121
4122/*
Tim Peters855fe882002-12-22 03:43:39 +00004123 * Indirect access to tzinfo methods.
Tim Peters2a799bf2002-12-16 20:18:38 +00004124 */
4125
Tim Peters2a799bf2002-12-16 20:18:38 +00004126/* These are all METH_NOARGS, so don't need to check the arglist. */
4127static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004128time_utcoffset(PyObject *self, PyObject *unused) {
4129 return call_utcoffset(GET_TIME_TZINFO(self), Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004130}
4131
4132static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004133time_dst(PyObject *self, PyObject *unused) {
4134 return call_dst(GET_TIME_TZINFO(self), Py_None);
Tim Peters855fe882002-12-22 03:43:39 +00004135}
4136
4137static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00004138time_tzname(PyDateTime_Time *self, PyObject *unused) {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004139 return call_tzname(GET_TIME_TZINFO(self), Py_None);
Tim Peters2a799bf2002-12-16 20:18:38 +00004140}
4141
4142/*
Tim Peters37f39822003-01-10 03:49:02 +00004143 * Various ways to turn a time into a string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004144 */
4145
4146static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00004147time_repr(PyDateTime_Time *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00004148{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004149 const char *type_name = Py_TYPE(self)->tp_name;
4150 int h = TIME_GET_HOUR(self);
4151 int m = TIME_GET_MINUTE(self);
4152 int s = TIME_GET_SECOND(self);
4153 int us = TIME_GET_MICROSECOND(self);
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004154 int fold = TIME_GET_FOLD(self);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004155 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004156
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004157 if (us)
4158 result = PyUnicode_FromFormat("%s(%d, %d, %d, %d)",
4159 type_name, h, m, s, us);
4160 else if (s)
4161 result = PyUnicode_FromFormat("%s(%d, %d, %d)",
4162 type_name, h, m, s);
4163 else
4164 result = PyUnicode_FromFormat("%s(%d, %d)", type_name, h, m);
4165 if (result != NULL && HASTZINFO(self))
4166 result = append_keyword_tzinfo(result, self->tzinfo);
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004167 if (result != NULL && fold)
4168 result = append_keyword_fold(result, fold);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004169 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004170}
4171
Tim Peters37f39822003-01-10 03:49:02 +00004172static PyObject *
4173time_str(PyDateTime_Time *self)
4174{
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02004175 return _PyObject_CallMethodIdNoArgs((PyObject *)self, &PyId_isoformat);
Tim Peters37f39822003-01-10 03:49:02 +00004176}
Tim Peters2a799bf2002-12-16 20:18:38 +00004177
4178static PyObject *
Alexander Belopolskya2998a62016-03-06 14:58:43 -05004179time_isoformat(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004180{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004181 char buf[100];
Alexander Belopolskya2998a62016-03-06 14:58:43 -05004182 char *timespec = NULL;
4183 static char *keywords[] = {"timespec", NULL};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004184 PyObject *result;
Ezio Melotti3f5db392013-01-27 06:20:14 +02004185 int us = TIME_GET_MICROSECOND(self);
Alexander Belopolskya2998a62016-03-06 14:58:43 -05004186 static char *specs[][2] = {
4187 {"hours", "%02d"},
4188 {"minutes", "%02d:%02d"},
4189 {"seconds", "%02d:%02d:%02d"},
4190 {"milliseconds", "%02d:%02d:%02d.%03d"},
4191 {"microseconds", "%02d:%02d:%02d.%06d"},
4192 };
4193 size_t given_spec;
Tim Peters2a799bf2002-12-16 20:18:38 +00004194
Alexander Belopolskya2998a62016-03-06 14:58:43 -05004195 if (!PyArg_ParseTupleAndKeywords(args, kw, "|s:isoformat", keywords, &timespec))
4196 return NULL;
4197
4198 if (timespec == NULL || strcmp(timespec, "auto") == 0) {
4199 if (us == 0) {
4200 /* seconds */
4201 given_spec = 2;
4202 }
4203 else {
4204 /* microseconds */
4205 given_spec = 4;
4206 }
4207 }
4208 else {
4209 for (given_spec = 0; given_spec < Py_ARRAY_LENGTH(specs); given_spec++) {
4210 if (strcmp(timespec, specs[given_spec][0]) == 0) {
4211 if (given_spec == 3) {
4212 /* milliseconds */
4213 us = us / 1000;
4214 }
4215 break;
4216 }
4217 }
4218 }
4219
4220 if (given_spec == Py_ARRAY_LENGTH(specs)) {
4221 PyErr_Format(PyExc_ValueError, "Unknown timespec value");
4222 return NULL;
4223 }
4224 else {
4225 result = PyUnicode_FromFormat(specs[given_spec][1],
4226 TIME_GET_HOUR(self), TIME_GET_MINUTE(self),
4227 TIME_GET_SECOND(self), us);
4228 }
Tim Peters37f39822003-01-10 03:49:02 +00004229
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004230 if (result == NULL || !HASTZINFO(self) || self->tzinfo == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004231 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004232
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004233 /* We need to append the UTC offset. */
4234 if (format_utcoffset(buf, sizeof(buf), ":", self->tzinfo,
4235 Py_None) < 0) {
4236 Py_DECREF(result);
4237 return NULL;
4238 }
4239 PyUnicode_AppendAndDel(&result, PyUnicode_FromString(buf));
4240 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004241}
4242
Tim Peters37f39822003-01-10 03:49:02 +00004243static PyObject *
4244time_strftime(PyDateTime_Time *self, PyObject *args, PyObject *kw)
4245{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004246 PyObject *result;
4247 PyObject *tuple;
4248 PyObject *format;
4249 static char *keywords[] = {"format", NULL};
Tim Peters37f39822003-01-10 03:49:02 +00004250
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004251 if (! PyArg_ParseTupleAndKeywords(args, kw, "U:strftime", keywords,
4252 &format))
4253 return NULL;
Tim Peters37f39822003-01-10 03:49:02 +00004254
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004255 /* Python's strftime does insane things with the year part of the
4256 * timetuple. The year is forced to (the otherwise nonsensical)
Alexander Belopolskyb8bb4662011-01-08 00:13:34 +00004257 * 1900 to work around that.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004258 */
4259 tuple = Py_BuildValue("iiiiiiiii",
4260 1900, 1, 1, /* year, month, day */
4261 TIME_GET_HOUR(self),
4262 TIME_GET_MINUTE(self),
4263 TIME_GET_SECOND(self),
4264 0, 1, -1); /* weekday, daynum, dst */
4265 if (tuple == NULL)
4266 return NULL;
4267 assert(PyTuple_Size(tuple) == 9);
4268 result = wrap_strftime((PyObject *)self, format, tuple,
4269 Py_None);
4270 Py_DECREF(tuple);
4271 return result;
Tim Peters37f39822003-01-10 03:49:02 +00004272}
Tim Peters2a799bf2002-12-16 20:18:38 +00004273
4274/*
4275 * Miscellaneous methods.
4276 */
4277
Tim Peters37f39822003-01-10 03:49:02 +00004278static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00004279time_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters37f39822003-01-10 03:49:02 +00004280{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004281 PyObject *result = NULL;
4282 PyObject *offset1, *offset2;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004283 int diff;
Tim Peters37f39822003-01-10 03:49:02 +00004284
Brian Curtindfc80e32011-08-10 20:28:54 -05004285 if (! PyTime_Check(other))
4286 Py_RETURN_NOTIMPLEMENTED;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004287
4288 if (GET_TIME_TZINFO(self) == GET_TIME_TZINFO(other)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004289 diff = memcmp(((PyDateTime_Time *)self)->data,
4290 ((PyDateTime_Time *)other)->data,
4291 _PyDateTime_TIME_DATASIZE);
4292 return diff_to_bool(diff, op);
4293 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004294 offset1 = time_utcoffset(self, NULL);
4295 if (offset1 == NULL)
4296 return NULL;
4297 offset2 = time_utcoffset(other, NULL);
4298 if (offset2 == NULL)
4299 goto done;
4300 /* If they're both naive, or both aware and have the same offsets,
4301 * we get off cheap. Note that if they're both naive, offset1 ==
4302 * offset2 == Py_None at this point.
4303 */
4304 if ((offset1 == offset2) ||
4305 (PyDelta_Check(offset1) && PyDelta_Check(offset2) &&
4306 delta_cmp(offset1, offset2) == 0)) {
4307 diff = memcmp(((PyDateTime_Time *)self)->data,
4308 ((PyDateTime_Time *)other)->data,
4309 _PyDateTime_TIME_DATASIZE);
4310 result = diff_to_bool(diff, op);
4311 }
4312 /* The hard case: both aware with different UTC offsets */
4313 else if (offset1 != Py_None && offset2 != Py_None) {
4314 int offsecs1, offsecs2;
4315 assert(offset1 != offset2); /* else last "if" handled it */
4316 offsecs1 = TIME_GET_HOUR(self) * 3600 +
4317 TIME_GET_MINUTE(self) * 60 +
4318 TIME_GET_SECOND(self) -
4319 GET_TD_DAYS(offset1) * 86400 -
4320 GET_TD_SECONDS(offset1);
4321 offsecs2 = TIME_GET_HOUR(other) * 3600 +
4322 TIME_GET_MINUTE(other) * 60 +
4323 TIME_GET_SECOND(other) -
4324 GET_TD_DAYS(offset2) * 86400 -
4325 GET_TD_SECONDS(offset2);
4326 diff = offsecs1 - offsecs2;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004327 if (diff == 0)
4328 diff = TIME_GET_MICROSECOND(self) -
4329 TIME_GET_MICROSECOND(other);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004330 result = diff_to_bool(diff, op);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004331 }
Alexander Belopolsky08313822012-06-15 20:19:47 -04004332 else if (op == Py_EQ) {
4333 result = Py_False;
4334 Py_INCREF(result);
4335 }
4336 else if (op == Py_NE) {
4337 result = Py_True;
4338 Py_INCREF(result);
4339 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004340 else {
4341 PyErr_SetString(PyExc_TypeError,
4342 "can't compare offset-naive and "
4343 "offset-aware times");
4344 }
4345 done:
4346 Py_DECREF(offset1);
4347 Py_XDECREF(offset2);
4348 return result;
Tim Peters37f39822003-01-10 03:49:02 +00004349}
4350
Benjamin Peterson8f67d082010-10-17 20:54:53 +00004351static Py_hash_t
Tim Peters37f39822003-01-10 03:49:02 +00004352time_hash(PyDateTime_Time *self)
4353{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004354 if (self->hashcode == -1) {
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004355 PyObject *offset, *self0;
Victor Stinner423c16b2017-01-03 23:47:12 +01004356 if (TIME_GET_FOLD(self)) {
4357 self0 = new_time_ex2(TIME_GET_HOUR(self),
4358 TIME_GET_MINUTE(self),
4359 TIME_GET_SECOND(self),
4360 TIME_GET_MICROSECOND(self),
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004361 HASTZINFO(self) ? self->tzinfo : Py_None,
4362 0, Py_TYPE(self));
4363 if (self0 == NULL)
4364 return -1;
4365 }
4366 else {
4367 self0 = (PyObject *)self;
4368 Py_INCREF(self0);
4369 }
4370 offset = time_utcoffset(self0, NULL);
4371 Py_DECREF(self0);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004372
4373 if (offset == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004374 return -1;
Tim Peters37f39822003-01-10 03:49:02 +00004375
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004376 /* Reduce this to a hash of another object. */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004377 if (offset == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004378 self->hashcode = generic_hash(
4379 (unsigned char *)self->data, _PyDateTime_TIME_DATASIZE);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004380 else {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004381 PyObject *temp1, *temp2;
4382 int seconds, microseconds;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004383 assert(HASTZINFO(self));
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004384 seconds = TIME_GET_HOUR(self) * 3600 +
4385 TIME_GET_MINUTE(self) * 60 +
4386 TIME_GET_SECOND(self);
4387 microseconds = TIME_GET_MICROSECOND(self);
4388 temp1 = new_delta(0, seconds, microseconds, 1);
4389 if (temp1 == NULL) {
4390 Py_DECREF(offset);
4391 return -1;
4392 }
4393 temp2 = delta_subtract(temp1, offset);
4394 Py_DECREF(temp1);
4395 if (temp2 == NULL) {
4396 Py_DECREF(offset);
4397 return -1;
4398 }
4399 self->hashcode = PyObject_Hash(temp2);
4400 Py_DECREF(temp2);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004401 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00004402 Py_DECREF(offset);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004403 }
4404 return self->hashcode;
Tim Peters37f39822003-01-10 03:49:02 +00004405}
Tim Peters2a799bf2002-12-16 20:18:38 +00004406
Tim Peters12bf3392002-12-24 05:41:27 +00004407static PyObject *
Tim Peters37f39822003-01-10 03:49:02 +00004408time_replace(PyDateTime_Time *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00004409{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004410 PyObject *clone;
4411 PyObject *tuple;
4412 int hh = TIME_GET_HOUR(self);
4413 int mm = TIME_GET_MINUTE(self);
4414 int ss = TIME_GET_SECOND(self);
4415 int us = TIME_GET_MICROSECOND(self);
4416 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004417 int fold = TIME_GET_FOLD(self);
Tim Peters12bf3392002-12-24 05:41:27 +00004418
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004419 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiO$i:replace",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004420 time_kws,
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004421 &hh, &mm, &ss, &us, &tzinfo, &fold))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004422 return NULL;
Serhiy Storchaka314d6fc2017-03-31 22:48:16 +03004423 if (fold != 0 && fold != 1) {
4424 PyErr_SetString(PyExc_ValueError,
4425 "fold must be either 0 or 1");
4426 return NULL;
4427 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004428 tuple = Py_BuildValue("iiiiO", hh, mm, ss, us, tzinfo);
4429 if (tuple == NULL)
4430 return NULL;
4431 clone = time_new(Py_TYPE(self), tuple, NULL);
Alexander Belopolsky47649ab2016-08-08 17:05:40 -04004432 if (clone != NULL) {
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004433 TIME_SET_FOLD(clone, fold);
Alexander Belopolsky47649ab2016-08-08 17:05:40 -04004434 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004435 Py_DECREF(tuple);
4436 return clone;
Tim Peters12bf3392002-12-24 05:41:27 +00004437}
4438
Paul Ganssle09dc2f52017-12-21 00:33:49 -05004439static PyObject *
4440time_fromisoformat(PyObject *cls, PyObject *tstr) {
4441 assert(tstr != NULL);
4442
4443 if (!PyUnicode_Check(tstr)) {
4444 PyErr_SetString(PyExc_TypeError, "fromisoformat: argument must be str");
4445 return NULL;
4446 }
4447
4448 Py_ssize_t len;
4449 const char *p = PyUnicode_AsUTF8AndSize(tstr, &len);
4450
Paul Ganssle096329f2018-08-23 11:06:20 -04004451 if (p == NULL) {
4452 goto invalid_string_error;
4453 }
4454
Paul Ganssle09dc2f52017-12-21 00:33:49 -05004455 int hour = 0, minute = 0, second = 0, microsecond = 0;
4456 int tzoffset, tzimicrosecond = 0;
4457 int rv = parse_isoformat_time(p, len,
4458 &hour, &minute, &second, &microsecond,
4459 &tzoffset, &tzimicrosecond);
4460
4461 if (rv < 0) {
Paul Ganssle096329f2018-08-23 11:06:20 -04004462 goto invalid_string_error;
Paul Ganssle09dc2f52017-12-21 00:33:49 -05004463 }
4464
4465 PyObject *tzinfo = tzinfo_from_isoformat_results(rv, tzoffset,
4466 tzimicrosecond);
4467
4468 if (tzinfo == NULL) {
4469 return NULL;
4470 }
4471
4472 PyObject *t;
4473 if ( (PyTypeObject *)cls == &PyDateTime_TimeType ) {
4474 t = new_time(hour, minute, second, microsecond, tzinfo, 0);
4475 } else {
4476 t = PyObject_CallFunction(cls, "iiiiO",
4477 hour, minute, second, microsecond, tzinfo);
4478 }
4479
4480 Py_DECREF(tzinfo);
4481 return t;
Paul Ganssle096329f2018-08-23 11:06:20 -04004482
4483invalid_string_error:
4484 PyErr_Format(PyExc_ValueError, "Invalid isoformat string: %R", tstr);
4485 return NULL;
Paul Ganssle09dc2f52017-12-21 00:33:49 -05004486}
4487
4488
Tim Peters371935f2003-02-01 01:52:50 +00004489/* Pickle support, a simple use of __reduce__. */
Tim Peters2a799bf2002-12-16 20:18:38 +00004490
Tim Peters33e0f382003-01-10 02:05:14 +00004491/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00004492 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
4493 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00004494 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00004495 */
4496static PyObject *
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004497time_getstate(PyDateTime_Time *self, int proto)
Tim Peters2a799bf2002-12-16 20:18:38 +00004498{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004499 PyObject *basestate;
4500 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00004501
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004502 basestate = PyBytes_FromStringAndSize((char *)self->data,
4503 _PyDateTime_TIME_DATASIZE);
4504 if (basestate != NULL) {
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004505 if (proto > 3 && TIME_GET_FOLD(self))
4506 /* Set the first bit of the first byte */
4507 PyBytes_AS_STRING(basestate)[0] |= (1 << 7);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004508 if (! HASTZINFO(self) || self->tzinfo == Py_None)
4509 result = PyTuple_Pack(1, basestate);
4510 else
4511 result = PyTuple_Pack(2, basestate, self->tzinfo);
4512 Py_DECREF(basestate);
4513 }
4514 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00004515}
4516
4517static PyObject *
Serhiy Storchaka546ce652016-11-22 00:29:42 +02004518time_reduce_ex(PyDateTime_Time *self, PyObject *args)
Tim Peters2a799bf2002-12-16 20:18:38 +00004519{
Serhiy Storchaka546ce652016-11-22 00:29:42 +02004520 int proto;
4521 if (!PyArg_ParseTuple(args, "i:__reduce_ex__", &proto))
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004522 return NULL;
4523
4524 return Py_BuildValue("(ON)", Py_TYPE(self), time_getstate(self, proto));
Tim Peters2a799bf2002-12-16 20:18:38 +00004525}
4526
Serhiy Storchaka546ce652016-11-22 00:29:42 +02004527static PyObject *
4528time_reduce(PyDateTime_Time *self, PyObject *arg)
4529{
4530 return Py_BuildValue("(ON)", Py_TYPE(self), time_getstate(self, 2));
4531}
4532
Tim Peters37f39822003-01-10 03:49:02 +00004533static PyMethodDef time_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00004534
Serhiy Storchaka62be7422018-11-27 13:27:31 +02004535 {"isoformat", (PyCFunction)(void(*)(void))time_isoformat, METH_VARARGS | METH_KEYWORDS,
Alexander Belopolskya2998a62016-03-06 14:58:43 -05004536 PyDoc_STR("Return string in ISO 8601 format, [HH[:MM[:SS[.mmm[uuu]]]]]"
4537 "[+HH:MM].\n\n"
4538 "timespec specifies what components of the time to include.\n")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004539
Serhiy Storchaka62be7422018-11-27 13:27:31 +02004540 {"strftime", (PyCFunction)(void(*)(void))time_strftime, METH_VARARGS | METH_KEYWORDS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004541 PyDoc_STR("format -> strftime() style string.")},
Tim Peters37f39822003-01-10 03:49:02 +00004542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004543 {"__format__", (PyCFunction)date_format, METH_VARARGS,
4544 PyDoc_STR("Formats self with strftime.")},
Eric Smith1ba31142007-09-11 18:06:02 +00004545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004546 {"utcoffset", (PyCFunction)time_utcoffset, METH_NOARGS,
4547 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004548
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004549 {"tzname", (PyCFunction)time_tzname, METH_NOARGS,
4550 PyDoc_STR("Return self.tzinfo.tzname(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004551
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004552 {"dst", (PyCFunction)time_dst, METH_NOARGS,
4553 PyDoc_STR("Return self.tzinfo.dst(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00004554
Serhiy Storchaka62be7422018-11-27 13:27:31 +02004555 {"replace", (PyCFunction)(void(*)(void))time_replace, METH_VARARGS | METH_KEYWORDS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004556 PyDoc_STR("Return time with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00004557
Paul Ganssle09dc2f52017-12-21 00:33:49 -05004558 {"fromisoformat", (PyCFunction)time_fromisoformat, METH_O | METH_CLASS,
4559 PyDoc_STR("string -> time from time.isoformat() output")},
4560
Serhiy Storchaka546ce652016-11-22 00:29:42 +02004561 {"__reduce_ex__", (PyCFunction)time_reduce_ex, METH_VARARGS,
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004562 PyDoc_STR("__reduce_ex__(proto) -> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00004563
Serhiy Storchaka546ce652016-11-22 00:29:42 +02004564 {"__reduce__", (PyCFunction)time_reduce, METH_NOARGS,
4565 PyDoc_STR("__reduce__() -> (cls, state)")},
4566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004567 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00004568};
4569
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02004570static const char time_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00004571PyDoc_STR("time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object\n\
4572\n\
4573All arguments are optional. tzinfo may be None, or an instance of\n\
Serhiy Storchaka95949422013-08-27 19:40:23 +03004574a tzinfo subclass. The remaining arguments may be ints.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00004575
Neal Norwitz227b5332006-03-22 09:28:35 +00004576static PyTypeObject PyDateTime_TimeType = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004577 PyVarObject_HEAD_INIT(NULL, 0)
4578 "datetime.time", /* tp_name */
4579 sizeof(PyDateTime_Time), /* tp_basicsize */
4580 0, /* tp_itemsize */
4581 (destructor)time_dealloc, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02004582 0, /* tp_vectorcall_offset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004583 0, /* tp_getattr */
4584 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02004585 0, /* tp_as_async */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004586 (reprfunc)time_repr, /* tp_repr */
Benjamin Petersonee6bdc02014-03-20 18:00:35 -05004587 0, /* tp_as_number */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004588 0, /* tp_as_sequence */
4589 0, /* tp_as_mapping */
4590 (hashfunc)time_hash, /* tp_hash */
4591 0, /* tp_call */
4592 (reprfunc)time_str, /* tp_str */
4593 PyObject_GenericGetAttr, /* tp_getattro */
4594 0, /* tp_setattro */
4595 0, /* tp_as_buffer */
4596 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
4597 time_doc, /* tp_doc */
4598 0, /* tp_traverse */
4599 0, /* tp_clear */
4600 time_richcompare, /* tp_richcompare */
4601 0, /* tp_weaklistoffset */
4602 0, /* tp_iter */
4603 0, /* tp_iternext */
4604 time_methods, /* tp_methods */
4605 0, /* tp_members */
4606 time_getset, /* tp_getset */
4607 0, /* tp_base */
4608 0, /* tp_dict */
4609 0, /* tp_descr_get */
4610 0, /* tp_descr_set */
4611 0, /* tp_dictoffset */
4612 0, /* tp_init */
4613 time_alloc, /* tp_alloc */
4614 time_new, /* tp_new */
4615 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00004616};
4617
4618/*
Tim Petersa9bc1682003-01-11 03:39:11 +00004619 * PyDateTime_DateTime implementation.
Tim Peters2a799bf2002-12-16 20:18:38 +00004620 */
4621
Tim Petersa9bc1682003-01-11 03:39:11 +00004622/* Accessor properties. Properties for day, month, and year are inherited
4623 * from date.
Tim Peters2a799bf2002-12-16 20:18:38 +00004624 */
4625
4626static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004627datetime_hour(PyDateTime_DateTime *self, void *unused)
Tim Peters2a799bf2002-12-16 20:18:38 +00004628{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004629 return PyLong_FromLong(DATE_GET_HOUR(self));
Tim Peters2a799bf2002-12-16 20:18:38 +00004630}
4631
Tim Petersa9bc1682003-01-11 03:39:11 +00004632static PyObject *
4633datetime_minute(PyDateTime_DateTime *self, void *unused)
4634{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004635 return PyLong_FromLong(DATE_GET_MINUTE(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00004636}
4637
4638static PyObject *
4639datetime_second(PyDateTime_DateTime *self, void *unused)
4640{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004641 return PyLong_FromLong(DATE_GET_SECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00004642}
4643
4644static PyObject *
4645datetime_microsecond(PyDateTime_DateTime *self, void *unused)
4646{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004647 return PyLong_FromLong(DATE_GET_MICROSECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00004648}
4649
4650static PyObject *
4651datetime_tzinfo(PyDateTime_DateTime *self, void *unused)
4652{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004653 PyObject *result = HASTZINFO(self) ? self->tzinfo : Py_None;
4654 Py_INCREF(result);
4655 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00004656}
4657
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004658static PyObject *
4659datetime_fold(PyDateTime_DateTime *self, void *unused)
4660{
4661 return PyLong_FromLong(DATE_GET_FOLD(self));
4662}
4663
Tim Petersa9bc1682003-01-11 03:39:11 +00004664static PyGetSetDef datetime_getset[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004665 {"hour", (getter)datetime_hour},
4666 {"minute", (getter)datetime_minute},
4667 {"second", (getter)datetime_second},
4668 {"microsecond", (getter)datetime_microsecond},
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004669 {"tzinfo", (getter)datetime_tzinfo},
4670 {"fold", (getter)datetime_fold},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004671 {NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00004672};
4673
4674/*
4675 * Constructors.
Tim Peters2a799bf2002-12-16 20:18:38 +00004676 */
4677
Martin v. Löwis02cbf4a2006-02-27 17:20:04 +00004678static char *datetime_kws[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004679 "year", "month", "day", "hour", "minute", "second",
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004680 "microsecond", "tzinfo", "fold", NULL
Tim Peters12bf3392002-12-24 05:41:27 +00004681};
4682
Tim Peters2a799bf2002-12-16 20:18:38 +00004683static PyObject *
Serhiy Storchaka8452ca12018-12-07 13:42:10 +02004684datetime_from_pickle(PyTypeObject *type, PyObject *state, PyObject *tzinfo)
4685{
4686 PyDateTime_DateTime *me;
4687 char aware = (char)(tzinfo != Py_None);
4688
4689 if (aware && check_tzinfo_subclass(tzinfo) < 0) {
4690 PyErr_SetString(PyExc_TypeError, "bad tzinfo state arg");
4691 return NULL;
4692 }
4693
4694 me = (PyDateTime_DateTime *) (type->tp_alloc(type , aware));
4695 if (me != NULL) {
4696 const char *pdata = PyBytes_AS_STRING(state);
4697
4698 memcpy(me->data, pdata, _PyDateTime_DATETIME_DATASIZE);
4699 me->hashcode = -1;
4700 me->hastzinfo = aware;
4701 if (aware) {
4702 Py_INCREF(tzinfo);
4703 me->tzinfo = tzinfo;
4704 }
4705 if (pdata[2] & (1 << 7)) {
4706 me->data[2] -= 128;
4707 me->fold = 1;
4708 }
4709 else {
4710 me->fold = 0;
4711 }
4712 }
4713 return (PyObject *)me;
4714}
4715
4716static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004717datetime_new(PyTypeObject *type, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004718{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004719 PyObject *self = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004720 int year;
4721 int month;
4722 int day;
4723 int hour = 0;
4724 int minute = 0;
4725 int second = 0;
4726 int usecond = 0;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004727 int fold = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004728 PyObject *tzinfo = Py_None;
Tim Peters2a799bf2002-12-16 20:18:38 +00004729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004730 /* Check for invocation from pickle with __getstate__ state */
Serhiy Storchaka8452ca12018-12-07 13:42:10 +02004731 if (PyTuple_GET_SIZE(args) >= 1 && PyTuple_GET_SIZE(args) <= 2) {
4732 PyObject *state = PyTuple_GET_ITEM(args, 0);
4733 if (PyTuple_GET_SIZE(args) == 2) {
4734 tzinfo = PyTuple_GET_ITEM(args, 1);
4735 }
4736 if (PyBytes_Check(state)) {
4737 if (PyBytes_GET_SIZE(state) == _PyDateTime_DATETIME_DATASIZE &&
4738 MONTH_IS_SANE(PyBytes_AS_STRING(state)[2] & 0x7F))
4739 {
4740 return datetime_from_pickle(type, state, tzinfo);
4741 }
4742 }
4743 else if (PyUnicode_Check(state)) {
4744 if (PyUnicode_READY(state)) {
4745 return NULL;
4746 }
4747 if (PyUnicode_GET_LENGTH(state) == _PyDateTime_DATETIME_DATASIZE &&
4748 MONTH_IS_SANE(PyUnicode_READ_CHAR(state, 2) & 0x7F))
4749 {
4750 state = PyUnicode_AsLatin1String(state);
4751 if (state == NULL) {
4752 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
4753 /* More informative error message. */
4754 PyErr_SetString(PyExc_ValueError,
4755 "Failed to encode latin1 string when unpickling "
4756 "a datetime object. "
4757 "pickle.load(data, encoding='latin1') is assumed.");
4758 }
Victor Stinnerb37672d2018-11-22 03:37:50 +01004759 return NULL;
4760 }
Serhiy Storchaka8452ca12018-12-07 13:42:10 +02004761 self = datetime_from_pickle(type, state, tzinfo);
4762 Py_DECREF(state);
4763 return self;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004764 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004765 }
Serhiy Storchaka8452ca12018-12-07 13:42:10 +02004766 tzinfo = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004767 }
Guido van Rossum177e41a2003-01-30 22:06:23 +00004768
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004769 if (PyArg_ParseTupleAndKeywords(args, kw, "iii|iiiiO$i", datetime_kws,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004770 &year, &month, &day, &hour, &minute,
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004771 &second, &usecond, &tzinfo, &fold)) {
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004772 self = new_datetime_ex2(year, month, day,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004773 hour, minute, second, usecond,
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004774 tzinfo, fold, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004775 }
4776 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00004777}
4778
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04004779/* TM_FUNC is the shared type of _PyTime_localtime() and
4780 * _PyTime_gmtime(). */
4781typedef int (*TM_FUNC)(time_t timer, struct tm*);
Tim Petersa9bc1682003-01-11 03:39:11 +00004782
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004783/* As of version 2015f max fold in IANA database is
4784 * 23 hours at 1969-09-30 13:00:00 in Kwajalein. */
Benjamin Petersonaf580df2016-09-06 10:46:49 -07004785static long long max_fold_seconds = 24 * 3600;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004786/* NB: date(1970,1,1).toordinal() == 719163 */
Benjamin Petersonac965ca2016-09-18 18:12:21 -07004787static long long epoch = 719163LL * 24 * 60 * 60;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004788
Benjamin Petersonaf580df2016-09-06 10:46:49 -07004789static long long
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004790utc_to_seconds(int year, int month, int day,
4791 int hour, int minute, int second)
4792{
Victor Stinnerb67f0962017-02-10 10:34:02 +01004793 long long ordinal;
4794
4795 /* ymd_to_ord() doesn't support year <= 0 */
4796 if (year < MINYEAR || year > MAXYEAR) {
4797 PyErr_Format(PyExc_ValueError, "year %i is out of range", year);
4798 return -1;
4799 }
4800
4801 ordinal = ymd_to_ord(year, month, day);
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004802 return ((ordinal * 24 + hour) * 60 + minute) * 60 + second;
4803}
4804
Benjamin Petersonaf580df2016-09-06 10:46:49 -07004805static long long
4806local(long long u)
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004807{
4808 struct tm local_time;
Alexander Belopolsky8e1d3a22016-07-25 13:54:51 -04004809 time_t t;
4810 u -= epoch;
4811 t = u;
4812 if (t != u) {
4813 PyErr_SetString(PyExc_OverflowError,
4814 "timestamp out of range for platform time_t");
4815 return -1;
4816 }
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04004817 if (_PyTime_localtime(t, &local_time) != 0)
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004818 return -1;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004819 return utc_to_seconds(local_time.tm_year + 1900,
4820 local_time.tm_mon + 1,
4821 local_time.tm_mday,
4822 local_time.tm_hour,
4823 local_time.tm_min,
4824 local_time.tm_sec);
4825}
4826
Tim Petersa9bc1682003-01-11 03:39:11 +00004827/* Internal helper.
4828 * Build datetime from a time_t and a distinct count of microseconds.
4829 * Pass localtime or gmtime for f, to control the interpretation of timet.
4830 */
4831static PyObject *
4832datetime_from_timet_and_us(PyObject *cls, TM_FUNC f, time_t timet, int us,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004833 PyObject *tzinfo)
Tim Petersa9bc1682003-01-11 03:39:11 +00004834{
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04004835 struct tm tm;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004836 int year, month, day, hour, minute, second, fold = 0;
Tim Petersa9bc1682003-01-11 03:39:11 +00004837
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04004838 if (f(timet, &tm) != 0)
4839 return NULL;
Victor Stinner21f58932012-03-14 00:15:40 +01004840
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04004841 year = tm.tm_year + 1900;
4842 month = tm.tm_mon + 1;
4843 day = tm.tm_mday;
4844 hour = tm.tm_hour;
4845 minute = tm.tm_min;
Victor Stinner21f58932012-03-14 00:15:40 +01004846 /* The platform localtime/gmtime may insert leap seconds,
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04004847 * indicated by tm.tm_sec > 59. We don't care about them,
Victor Stinner21f58932012-03-14 00:15:40 +01004848 * except to the extent that passing them on to the datetime
4849 * constructor would raise ValueError for a reason that
4850 * made no sense to the user.
4851 */
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04004852 second = Py_MIN(59, tm.tm_sec);
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004853
Victor Stinnerb67f0962017-02-10 10:34:02 +01004854 /* local timezone requires to compute fold */
Ammar Askar96d1e692018-07-25 09:54:58 -07004855 if (tzinfo == Py_None && f == _PyTime_localtime
4856 /* On Windows, passing a negative value to local results
4857 * in an OSError because localtime_s on Windows does
4858 * not support negative timestamps. Unfortunately this
4859 * means that fold detection for time values between
4860 * 0 and max_fold_seconds will result in an identical
4861 * error since we subtract max_fold_seconds to detect a
4862 * fold. However, since we know there haven't been any
4863 * folds in the interval [0, max_fold_seconds) in any
4864 * timezone, we can hackily just forego fold detection
4865 * for this time range.
4866 */
4867#ifdef MS_WINDOWS
4868 && (timet - max_fold_seconds > 0)
4869#endif
4870 ) {
Benjamin Petersonaf580df2016-09-06 10:46:49 -07004871 long long probe_seconds, result_seconds, transition;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04004872
4873 result_seconds = utc_to_seconds(year, month, day,
4874 hour, minute, second);
4875 /* Probe max_fold_seconds to detect a fold. */
4876 probe_seconds = local(epoch + timet - max_fold_seconds);
4877 if (probe_seconds == -1)
4878 return NULL;
4879 transition = result_seconds - probe_seconds - max_fold_seconds;
4880 if (transition < 0) {
4881 probe_seconds = local(epoch + timet + transition);
4882 if (probe_seconds == -1)
4883 return NULL;
4884 if (probe_seconds == result_seconds)
4885 fold = 1;
4886 }
4887 }
Paul Ganssle9f1b7b92018-01-16 13:06:31 -05004888 return new_datetime_subclass_fold_ex(year, month, day, hour, minute,
4889 second, us, tzinfo, fold, cls);
Tim Petersa9bc1682003-01-11 03:39:11 +00004890}
4891
4892/* Internal helper.
4893 * Build datetime from a Python timestamp. Pass localtime or gmtime for f,
4894 * to control the interpretation of the timestamp. Since a double doesn't
4895 * have enough bits to cover a datetime's full range of precision, it's
4896 * better to call datetime_from_timet_and_us provided you have a way
4897 * to get that much precision (e.g., C time() isn't good enough).
4898 */
4899static PyObject *
Victor Stinner5d272cc2012-03-13 13:35:55 +01004900datetime_from_timestamp(PyObject *cls, TM_FUNC f, PyObject *timestamp,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004901 PyObject *tzinfo)
Tim Petersa9bc1682003-01-11 03:39:11 +00004902{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004903 time_t timet;
Victor Stinner5d272cc2012-03-13 13:35:55 +01004904 long us;
Tim Petersa9bc1682003-01-11 03:39:11 +00004905
Victor Stinnere4a994d2015-03-30 01:10:14 +02004906 if (_PyTime_ObjectToTimeval(timestamp,
Victor Stinner7667f582015-09-09 01:02:23 +02004907 &timet, &us, _PyTime_ROUND_HALF_EVEN) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004908 return NULL;
Victor Stinner09e5cf22015-03-30 00:09:18 +02004909
Victor Stinner21f58932012-03-14 00:15:40 +01004910 return datetime_from_timet_and_us(cls, f, timet, (int)us, tzinfo);
Tim Petersa9bc1682003-01-11 03:39:11 +00004911}
4912
4913/* Internal helper.
4914 * Build most accurate possible datetime for current time. Pass localtime or
4915 * gmtime for f as appropriate.
4916 */
4917static PyObject *
4918datetime_best_possible(PyObject *cls, TM_FUNC f, PyObject *tzinfo)
4919{
Victor Stinner09e5cf22015-03-30 00:09:18 +02004920 _PyTime_t ts = _PyTime_GetSystemClock();
Victor Stinner1e2b6882015-09-18 13:23:02 +02004921 time_t secs;
4922 int us;
Victor Stinner09e5cf22015-03-30 00:09:18 +02004923
Victor Stinner1e2b6882015-09-18 13:23:02 +02004924 if (_PyTime_AsTimevalTime_t(ts, &secs, &us, _PyTime_ROUND_FLOOR) < 0)
Victor Stinner09e5cf22015-03-30 00:09:18 +02004925 return NULL;
Victor Stinner1e2b6882015-09-18 13:23:02 +02004926 assert(0 <= us && us <= 999999);
Victor Stinner09e5cf22015-03-30 00:09:18 +02004927
Victor Stinner1e2b6882015-09-18 13:23:02 +02004928 return datetime_from_timet_and_us(cls, f, secs, us, tzinfo);
Tim Petersa9bc1682003-01-11 03:39:11 +00004929}
4930
Larry Hastings61272b72014-01-07 12:41:53 -08004931/*[clinic input]
Larry Hastings31826802013-10-19 00:09:25 -07004932
4933@classmethod
Larry Hastingsed4a1c52013-11-18 09:32:13 -08004934datetime.datetime.now
Larry Hastings31826802013-10-19 00:09:25 -07004935
4936 tz: object = None
4937 Timezone object.
4938
4939Returns new datetime object representing current time local to tz.
4940
4941If no tz is specified, uses local timezone.
Larry Hastings61272b72014-01-07 12:41:53 -08004942[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07004943
Larry Hastings31826802013-10-19 00:09:25 -07004944static PyObject *
Larry Hastings5c661892014-01-24 06:17:25 -08004945datetime_datetime_now_impl(PyTypeObject *type, PyObject *tz)
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03004946/*[clinic end generated code: output=b3386e5345e2b47a input=80d09869c5267d00]*/
Tim Peters2a799bf2002-12-16 20:18:38 +00004947{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004948 PyObject *self;
Tim Peters2a799bf2002-12-16 20:18:38 +00004949
Larry Hastings31826802013-10-19 00:09:25 -07004950 /* Return best possible local time -- this isn't constrained by the
4951 * precision of a timestamp.
4952 */
4953 if (check_tzinfo_subclass(tz) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004954 return NULL;
Tim Peters10cadce2003-01-23 19:58:02 +00004955
Larry Hastings5c661892014-01-24 06:17:25 -08004956 self = datetime_best_possible((PyObject *)type,
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04004957 tz == Py_None ? _PyTime_localtime :
4958 _PyTime_gmtime,
Larry Hastings31826802013-10-19 00:09:25 -07004959 tz);
4960 if (self != NULL && tz != Py_None) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004961 /* Convert UTC to tzinfo's zone. */
Serhiy Storchaka576f1322016-01-05 21:27:54 +02004962 self = _PyObject_CallMethodId(tz, &PyId_fromutc, "N", self);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004963 }
4964 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00004965}
4966
Tim Petersa9bc1682003-01-11 03:39:11 +00004967/* Return best possible UTC time -- this isn't constrained by the
4968 * precision of a timestamp.
4969 */
4970static PyObject *
4971datetime_utcnow(PyObject *cls, PyObject *dummy)
4972{
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04004973 return datetime_best_possible(cls, _PyTime_gmtime, Py_None);
Tim Petersa9bc1682003-01-11 03:39:11 +00004974}
4975
Tim Peters2a799bf2002-12-16 20:18:38 +00004976/* Return new local datetime from timestamp (Python timestamp -- a double). */
4977static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00004978datetime_fromtimestamp(PyObject *cls, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00004979{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004980 PyObject *self;
Victor Stinner5d272cc2012-03-13 13:35:55 +01004981 PyObject *timestamp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004982 PyObject *tzinfo = Py_None;
4983 static char *keywords[] = {"timestamp", "tz", NULL};
Tim Peters2a799bf2002-12-16 20:18:38 +00004984
Victor Stinner5d272cc2012-03-13 13:35:55 +01004985 if (! PyArg_ParseTupleAndKeywords(args, kw, "O|O:fromtimestamp",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004986 keywords, &timestamp, &tzinfo))
4987 return NULL;
4988 if (check_tzinfo_subclass(tzinfo) < 0)
4989 return NULL;
Tim Peters2a44a8d2003-01-23 20:53:10 +00004990
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004991 self = datetime_from_timestamp(cls,
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04004992 tzinfo == Py_None ? _PyTime_localtime :
4993 _PyTime_gmtime,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004994 timestamp,
4995 tzinfo);
4996 if (self != NULL && tzinfo != Py_None) {
4997 /* Convert UTC to tzinfo's zone. */
Serhiy Storchaka576f1322016-01-05 21:27:54 +02004998 self = _PyObject_CallMethodId(tzinfo, &PyId_fromutc, "N", self);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004999 }
5000 return self;
Tim Peters2a799bf2002-12-16 20:18:38 +00005001}
5002
Tim Petersa9bc1682003-01-11 03:39:11 +00005003/* Return new UTC datetime from timestamp (Python timestamp -- a double). */
5004static PyObject *
5005datetime_utcfromtimestamp(PyObject *cls, PyObject *args)
5006{
Victor Stinner5d272cc2012-03-13 13:35:55 +01005007 PyObject *timestamp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005008 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00005009
Victor Stinner5d272cc2012-03-13 13:35:55 +01005010 if (PyArg_ParseTuple(args, "O:utcfromtimestamp", &timestamp))
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04005011 result = datetime_from_timestamp(cls, _PyTime_gmtime, timestamp,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005012 Py_None);
5013 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00005014}
5015
Alexander Belopolskyca94f552010-06-17 18:30:34 +00005016/* Return new datetime from _strptime.strptime_datetime(). */
Skip Montanaro0af3ade2005-01-13 04:12:31 +00005017static PyObject *
5018datetime_strptime(PyObject *cls, PyObject *args)
5019{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005020 static PyObject *module = NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02005021 PyObject *string, *format;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02005022 _Py_IDENTIFIER(_strptime_datetime);
Skip Montanaro0af3ade2005-01-13 04:12:31 +00005023
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02005024 if (!PyArg_ParseTuple(args, "UU:strptime", &string, &format))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005025 return NULL;
Skip Montanaro0af3ade2005-01-13 04:12:31 +00005026
Alexander Belopolskyca94f552010-06-17 18:30:34 +00005027 if (module == NULL) {
5028 module = PyImport_ImportModuleNoBlock("_strptime");
Alexander Belopolsky311d2a92010-06-28 14:36:55 +00005029 if (module == NULL)
Alexander Belopolskyca94f552010-06-17 18:30:34 +00005030 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005031 }
Victor Stinner20401de2016-12-09 15:24:31 +01005032 return _PyObject_CallMethodIdObjArgs(module, &PyId__strptime_datetime,
5033 cls, string, format, NULL);
Skip Montanaro0af3ade2005-01-13 04:12:31 +00005034}
5035
Tim Petersa9bc1682003-01-11 03:39:11 +00005036/* Return new datetime from date/datetime and time arguments. */
5037static PyObject *
5038datetime_combine(PyObject *cls, PyObject *args, PyObject *kw)
5039{
Alexander Belopolsky43746c32016-08-02 17:49:30 -04005040 static char *keywords[] = {"date", "time", "tzinfo", NULL};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005041 PyObject *date;
5042 PyObject *time;
Alexander Belopolsky43746c32016-08-02 17:49:30 -04005043 PyObject *tzinfo = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005044 PyObject *result = NULL;
Tim Petersa9bc1682003-01-11 03:39:11 +00005045
Alexander Belopolsky43746c32016-08-02 17:49:30 -04005046 if (PyArg_ParseTupleAndKeywords(args, kw, "O!O!|O:combine", keywords,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005047 &PyDateTime_DateType, &date,
Alexander Belopolsky43746c32016-08-02 17:49:30 -04005048 &PyDateTime_TimeType, &time, &tzinfo)) {
5049 if (tzinfo == NULL) {
5050 if (HASTZINFO(time))
5051 tzinfo = ((PyDateTime_Time *)time)->tzinfo;
5052 else
5053 tzinfo = Py_None;
5054 }
Paul Ganssle9f1b7b92018-01-16 13:06:31 -05005055 result = new_datetime_subclass_fold_ex(GET_YEAR(date),
5056 GET_MONTH(date),
5057 GET_DAY(date),
5058 TIME_GET_HOUR(time),
5059 TIME_GET_MINUTE(time),
5060 TIME_GET_SECOND(time),
5061 TIME_GET_MICROSECOND(time),
5062 tzinfo,
5063 TIME_GET_FOLD(time),
5064 cls);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005065 }
5066 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00005067}
Tim Peters2a799bf2002-12-16 20:18:38 +00005068
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005069static PyObject *
Paul Ganssle3df85402018-10-22 12:32:52 -04005070_sanitize_isoformat_str(PyObject *dtstr)
5071{
Paul Ganssle096329f2018-08-23 11:06:20 -04005072 // `fromisoformat` allows surrogate characters in exactly one position,
5073 // the separator; to allow datetime_fromisoformat to make the simplifying
5074 // assumption that all valid strings can be encoded in UTF-8, this function
5075 // replaces any surrogate character separators with `T`.
Paul Ganssle3df85402018-10-22 12:32:52 -04005076 //
5077 // The result of this, if not NULL, returns a new reference
Paul Ganssle096329f2018-08-23 11:06:20 -04005078 Py_ssize_t len = PyUnicode_GetLength(dtstr);
Paul Ganssle3df85402018-10-22 12:32:52 -04005079 if (len < 0) {
5080 return NULL;
5081 }
5082
5083 if (len <= 10 ||
5084 !Py_UNICODE_IS_SURROGATE(PyUnicode_READ_CHAR(dtstr, 10))) {
5085 Py_INCREF(dtstr);
Paul Ganssle096329f2018-08-23 11:06:20 -04005086 return dtstr;
5087 }
5088
Paul Ganssle3df85402018-10-22 12:32:52 -04005089 PyObject *str_out = _PyUnicode_Copy(dtstr);
Paul Ganssle096329f2018-08-23 11:06:20 -04005090 if (str_out == NULL) {
5091 return NULL;
5092 }
5093
Paul Ganssle3df85402018-10-22 12:32:52 -04005094 if (PyUnicode_WriteChar(str_out, 10, (Py_UCS4)'T')) {
Paul Ganssle096329f2018-08-23 11:06:20 -04005095 Py_DECREF(str_out);
5096 return NULL;
5097 }
5098
Paul Ganssle096329f2018-08-23 11:06:20 -04005099 return str_out;
5100}
5101
5102static PyObject *
Paul Ganssle3df85402018-10-22 12:32:52 -04005103datetime_fromisoformat(PyObject *cls, PyObject *dtstr)
5104{
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005105 assert(dtstr != NULL);
5106
5107 if (!PyUnicode_Check(dtstr)) {
Paul Ganssle3df85402018-10-22 12:32:52 -04005108 PyErr_SetString(PyExc_TypeError,
5109 "fromisoformat: argument must be str");
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005110 return NULL;
5111 }
5112
Paul Ganssle3df85402018-10-22 12:32:52 -04005113 PyObject *dtstr_clean = _sanitize_isoformat_str(dtstr);
5114 if (dtstr_clean == NULL) {
Paul Ganssle096329f2018-08-23 11:06:20 -04005115 goto error;
5116 }
5117
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005118 Py_ssize_t len;
Paul Ganssle3df85402018-10-22 12:32:52 -04005119 const char *dt_ptr = PyUnicode_AsUTF8AndSize(dtstr_clean, &len);
Paul Ganssle096329f2018-08-23 11:06:20 -04005120
5121 if (dt_ptr == NULL) {
Paul Ganssle3df85402018-10-22 12:32:52 -04005122 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
5123 // Encoding errors are invalid string errors at this point
5124 goto invalid_string_error;
5125 }
5126 else {
5127 goto error;
5128 }
Paul Ganssle096329f2018-08-23 11:06:20 -04005129 }
5130
5131 const char *p = dt_ptr;
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005132
5133 int year = 0, month = 0, day = 0;
5134 int hour = 0, minute = 0, second = 0, microsecond = 0;
5135 int tzoffset = 0, tzusec = 0;
5136
5137 // date has a fixed length of 10
5138 int rv = parse_isoformat_date(p, &year, &month, &day);
5139
5140 if (!rv && len > 10) {
5141 // In UTF-8, the length of multi-byte characters is encoded in the MSB
5142 if ((p[10] & 0x80) == 0) {
5143 p += 11;
Paul Ganssle3df85402018-10-22 12:32:52 -04005144 }
5145 else {
5146 switch (p[10] & 0xf0) {
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005147 case 0xe0:
5148 p += 13;
5149 break;
5150 case 0xf0:
5151 p += 14;
5152 break;
5153 default:
5154 p += 12;
5155 break;
5156 }
5157 }
5158
5159 len -= (p - dt_ptr);
Paul Ganssle3df85402018-10-22 12:32:52 -04005160 rv = parse_isoformat_time(p, len, &hour, &minute, &second,
5161 &microsecond, &tzoffset, &tzusec);
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005162 }
5163 if (rv < 0) {
Paul Ganssle096329f2018-08-23 11:06:20 -04005164 goto invalid_string_error;
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005165 }
5166
Paul Ganssle3df85402018-10-22 12:32:52 -04005167 PyObject *tzinfo = tzinfo_from_isoformat_results(rv, tzoffset, tzusec);
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005168 if (tzinfo == NULL) {
Paul Ganssle096329f2018-08-23 11:06:20 -04005169 goto error;
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005170 }
5171
Paul Ganssle9f1b7b92018-01-16 13:06:31 -05005172 PyObject *dt = new_datetime_subclass_ex(year, month, day, hour, minute,
5173 second, microsecond, tzinfo, cls);
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005174
5175 Py_DECREF(tzinfo);
Paul Ganssle3df85402018-10-22 12:32:52 -04005176 Py_DECREF(dtstr_clean);
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005177 return dt;
Paul Ganssle096329f2018-08-23 11:06:20 -04005178
5179invalid_string_error:
5180 PyErr_Format(PyExc_ValueError, "Invalid isoformat string: %R", dtstr);
5181
5182error:
Paul Ganssle3df85402018-10-22 12:32:52 -04005183 Py_XDECREF(dtstr_clean);
Paul Ganssle096329f2018-08-23 11:06:20 -04005184
5185 return NULL;
Paul Ganssle09dc2f52017-12-21 00:33:49 -05005186}
5187
Tim Peters2a799bf2002-12-16 20:18:38 +00005188/*
5189 * Destructor.
5190 */
5191
5192static void
Tim Petersa9bc1682003-01-11 03:39:11 +00005193datetime_dealloc(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00005194{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005195 if (HASTZINFO(self)) {
5196 Py_XDECREF(self->tzinfo);
5197 }
5198 Py_TYPE(self)->tp_free((PyObject *)self);
Tim Peters2a799bf2002-12-16 20:18:38 +00005199}
5200
5201/*
5202 * Indirect access to tzinfo methods.
5203 */
5204
Tim Peters2a799bf2002-12-16 20:18:38 +00005205/* These are all METH_NOARGS, so don't need to check the arglist. */
5206static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005207datetime_utcoffset(PyObject *self, PyObject *unused) {
5208 return call_utcoffset(GET_DT_TZINFO(self), self);
Tim Peters2a799bf2002-12-16 20:18:38 +00005209}
5210
5211static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005212datetime_dst(PyObject *self, PyObject *unused) {
5213 return call_dst(GET_DT_TZINFO(self), self);
Tim Peters855fe882002-12-22 03:43:39 +00005214}
5215
5216static PyObject *
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005217datetime_tzname(PyObject *self, PyObject *unused) {
5218 return call_tzname(GET_DT_TZINFO(self), self);
Tim Peters2a799bf2002-12-16 20:18:38 +00005219}
5220
5221/*
Tim Petersa9bc1682003-01-11 03:39:11 +00005222 * datetime arithmetic.
Tim Peters2a799bf2002-12-16 20:18:38 +00005223 */
5224
Tim Petersa9bc1682003-01-11 03:39:11 +00005225/* factor must be 1 (to add) or -1 (to subtract). The result inherits
5226 * the tzinfo state of date.
Tim Peters2a799bf2002-12-16 20:18:38 +00005227 */
5228static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00005229add_datetime_timedelta(PyDateTime_DateTime *date, PyDateTime_Delta *delta,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005230 int factor)
Tim Peters2a799bf2002-12-16 20:18:38 +00005231{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005232 /* Note that the C-level additions can't overflow, because of
5233 * invariant bounds on the member values.
5234 */
5235 int year = GET_YEAR(date);
5236 int month = GET_MONTH(date);
5237 int day = GET_DAY(date) + GET_TD_DAYS(delta) * factor;
5238 int hour = DATE_GET_HOUR(date);
5239 int minute = DATE_GET_MINUTE(date);
5240 int second = DATE_GET_SECOND(date) + GET_TD_SECONDS(delta) * factor;
5241 int microsecond = DATE_GET_MICROSECOND(date) +
5242 GET_TD_MICROSECONDS(delta) * factor;
Tim Peters2a799bf2002-12-16 20:18:38 +00005243
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005244 assert(factor == 1 || factor == -1);
5245 if (normalize_datetime(&year, &month, &day,
Victor Stinnerb67f0962017-02-10 10:34:02 +01005246 &hour, &minute, &second, &microsecond) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005247 return NULL;
Victor Stinnerb67f0962017-02-10 10:34:02 +01005248 }
5249
Paul Ganssle89427cd2019-02-04 14:42:04 -05005250 return new_datetime_subclass_ex(year, month, day,
5251 hour, minute, second, microsecond,
5252 HASTZINFO(date) ? date->tzinfo : Py_None,
5253 (PyObject *)Py_TYPE(date));
Tim Peters2a799bf2002-12-16 20:18:38 +00005254}
5255
5256static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00005257datetime_add(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00005258{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005259 if (PyDateTime_Check(left)) {
5260 /* datetime + ??? */
5261 if (PyDelta_Check(right))
5262 /* datetime + delta */
5263 return add_datetime_timedelta(
5264 (PyDateTime_DateTime *)left,
5265 (PyDateTime_Delta *)right,
5266 1);
5267 }
5268 else if (PyDelta_Check(left)) {
5269 /* delta + datetime */
5270 return add_datetime_timedelta((PyDateTime_DateTime *) right,
5271 (PyDateTime_Delta *) left,
5272 1);
5273 }
Brian Curtindfc80e32011-08-10 20:28:54 -05005274 Py_RETURN_NOTIMPLEMENTED;
Tim Peters2a799bf2002-12-16 20:18:38 +00005275}
5276
5277static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00005278datetime_subtract(PyObject *left, PyObject *right)
Tim Peters2a799bf2002-12-16 20:18:38 +00005279{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005280 PyObject *result = Py_NotImplemented;
Tim Peters2a799bf2002-12-16 20:18:38 +00005281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005282 if (PyDateTime_Check(left)) {
5283 /* datetime - ??? */
5284 if (PyDateTime_Check(right)) {
5285 /* datetime - datetime */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005286 PyObject *offset1, *offset2, *offdiff = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005287 int delta_d, delta_s, delta_us;
Tim Peters2a799bf2002-12-16 20:18:38 +00005288
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005289 if (GET_DT_TZINFO(left) == GET_DT_TZINFO(right)) {
5290 offset2 = offset1 = Py_None;
5291 Py_INCREF(offset1);
5292 Py_INCREF(offset2);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005293 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005294 else {
5295 offset1 = datetime_utcoffset(left, NULL);
5296 if (offset1 == NULL)
5297 return NULL;
5298 offset2 = datetime_utcoffset(right, NULL);
5299 if (offset2 == NULL) {
5300 Py_DECREF(offset1);
5301 return NULL;
5302 }
5303 if ((offset1 != Py_None) != (offset2 != Py_None)) {
5304 PyErr_SetString(PyExc_TypeError,
5305 "can't subtract offset-naive and "
5306 "offset-aware datetimes");
5307 Py_DECREF(offset1);
5308 Py_DECREF(offset2);
5309 return NULL;
5310 }
5311 }
5312 if ((offset1 != offset2) &&
5313 delta_cmp(offset1, offset2) != 0) {
5314 offdiff = delta_subtract(offset1, offset2);
5315 if (offdiff == NULL) {
5316 Py_DECREF(offset1);
5317 Py_DECREF(offset2);
5318 return NULL;
5319 }
5320 }
5321 Py_DECREF(offset1);
5322 Py_DECREF(offset2);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005323 delta_d = ymd_to_ord(GET_YEAR(left),
5324 GET_MONTH(left),
5325 GET_DAY(left)) -
5326 ymd_to_ord(GET_YEAR(right),
5327 GET_MONTH(right),
5328 GET_DAY(right));
5329 /* These can't overflow, since the values are
5330 * normalized. At most this gives the number of
5331 * seconds in one day.
5332 */
5333 delta_s = (DATE_GET_HOUR(left) -
5334 DATE_GET_HOUR(right)) * 3600 +
5335 (DATE_GET_MINUTE(left) -
5336 DATE_GET_MINUTE(right)) * 60 +
5337 (DATE_GET_SECOND(left) -
5338 DATE_GET_SECOND(right));
5339 delta_us = DATE_GET_MICROSECOND(left) -
5340 DATE_GET_MICROSECOND(right);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005341 result = new_delta(delta_d, delta_s, delta_us, 1);
Victor Stinner70e11ac2013-11-08 00:50:58 +01005342 if (result == NULL)
5343 return NULL;
5344
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005345 if (offdiff != NULL) {
Serhiy Storchakaf01e4082016-04-10 18:12:01 +03005346 Py_SETREF(result, delta_subtract(result, offdiff));
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005347 Py_DECREF(offdiff);
5348 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005349 }
5350 else if (PyDelta_Check(right)) {
5351 /* datetime - delta */
5352 result = add_datetime_timedelta(
5353 (PyDateTime_DateTime *)left,
5354 (PyDateTime_Delta *)right,
5355 -1);
5356 }
5357 }
Tim Peters2a799bf2002-12-16 20:18:38 +00005358
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005359 if (result == Py_NotImplemented)
5360 Py_INCREF(result);
5361 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00005362}
5363
5364/* Various ways to turn a datetime into a string. */
5365
5366static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00005367datetime_repr(PyDateTime_DateTime *self)
Tim Peters2a799bf2002-12-16 20:18:38 +00005368{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005369 const char *type_name = Py_TYPE(self)->tp_name;
5370 PyObject *baserepr;
Tim Peters2a799bf2002-12-16 20:18:38 +00005371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005372 if (DATE_GET_MICROSECOND(self)) {
5373 baserepr = PyUnicode_FromFormat(
5374 "%s(%d, %d, %d, %d, %d, %d, %d)",
5375 type_name,
5376 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
5377 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
5378 DATE_GET_SECOND(self),
5379 DATE_GET_MICROSECOND(self));
5380 }
5381 else if (DATE_GET_SECOND(self)) {
5382 baserepr = PyUnicode_FromFormat(
5383 "%s(%d, %d, %d, %d, %d, %d)",
5384 type_name,
5385 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
5386 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
5387 DATE_GET_SECOND(self));
5388 }
5389 else {
5390 baserepr = PyUnicode_FromFormat(
5391 "%s(%d, %d, %d, %d, %d)",
5392 type_name,
5393 GET_YEAR(self), GET_MONTH(self), GET_DAY(self),
5394 DATE_GET_HOUR(self), DATE_GET_MINUTE(self));
5395 }
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005396 if (baserepr != NULL && DATE_GET_FOLD(self) != 0)
5397 baserepr = append_keyword_fold(baserepr, DATE_GET_FOLD(self));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005398 if (baserepr == NULL || ! HASTZINFO(self))
5399 return baserepr;
5400 return append_keyword_tzinfo(baserepr, self->tzinfo);
Tim Peters2a799bf2002-12-16 20:18:38 +00005401}
5402
Tim Petersa9bc1682003-01-11 03:39:11 +00005403static PyObject *
5404datetime_str(PyDateTime_DateTime *self)
5405{
Victor Stinner4c381542016-12-09 00:33:39 +01005406 return _PyObject_CallMethodId((PyObject *)self, &PyId_isoformat, "s", " ");
Tim Petersa9bc1682003-01-11 03:39:11 +00005407}
Tim Peters2a799bf2002-12-16 20:18:38 +00005408
5409static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00005410datetime_isoformat(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters2a799bf2002-12-16 20:18:38 +00005411{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005412 int sep = 'T';
Alexander Belopolskya2998a62016-03-06 14:58:43 -05005413 char *timespec = NULL;
5414 static char *keywords[] = {"sep", "timespec", NULL};
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005415 char buffer[100];
Alexander Belopolskya2998a62016-03-06 14:58:43 -05005416 PyObject *result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005417 int us = DATE_GET_MICROSECOND(self);
Alexander Belopolskya2998a62016-03-06 14:58:43 -05005418 static char *specs[][2] = {
5419 {"hours", "%04d-%02d-%02d%c%02d"},
5420 {"minutes", "%04d-%02d-%02d%c%02d:%02d"},
5421 {"seconds", "%04d-%02d-%02d%c%02d:%02d:%02d"},
5422 {"milliseconds", "%04d-%02d-%02d%c%02d:%02d:%02d.%03d"},
5423 {"microseconds", "%04d-%02d-%02d%c%02d:%02d:%02d.%06d"},
5424 };
5425 size_t given_spec;
Tim Peters2a799bf2002-12-16 20:18:38 +00005426
Alexander Belopolskya2998a62016-03-06 14:58:43 -05005427 if (!PyArg_ParseTupleAndKeywords(args, kw, "|Cs:isoformat", keywords, &sep, &timespec))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005428 return NULL;
Alexander Belopolskya2998a62016-03-06 14:58:43 -05005429
5430 if (timespec == NULL || strcmp(timespec, "auto") == 0) {
5431 if (us == 0) {
5432 /* seconds */
5433 given_spec = 2;
5434 }
5435 else {
5436 /* microseconds */
5437 given_spec = 4;
5438 }
5439 }
5440 else {
5441 for (given_spec = 0; given_spec < Py_ARRAY_LENGTH(specs); given_spec++) {
5442 if (strcmp(timespec, specs[given_spec][0]) == 0) {
5443 if (given_spec == 3) {
5444 us = us / 1000;
5445 }
5446 break;
5447 }
5448 }
5449 }
5450
5451 if (given_spec == Py_ARRAY_LENGTH(specs)) {
5452 PyErr_Format(PyExc_ValueError, "Unknown timespec value");
5453 return NULL;
5454 }
5455 else {
5456 result = PyUnicode_FromFormat(specs[given_spec][1],
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005457 GET_YEAR(self), GET_MONTH(self),
5458 GET_DAY(self), (int)sep,
5459 DATE_GET_HOUR(self), DATE_GET_MINUTE(self),
5460 DATE_GET_SECOND(self), us);
Alexander Belopolskya2998a62016-03-06 14:58:43 -05005461 }
Walter Dörwaldbafa1372007-05-31 17:50:48 +00005462
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005463 if (!result || !HASTZINFO(self))
5464 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00005465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005466 /* We need to append the UTC offset. */
5467 if (format_utcoffset(buffer, sizeof(buffer), ":", self->tzinfo,
5468 (PyObject *)self) < 0) {
5469 Py_DECREF(result);
5470 return NULL;
5471 }
5472 PyUnicode_AppendAndDel(&result, PyUnicode_FromString(buffer));
5473 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00005474}
5475
Tim Petersa9bc1682003-01-11 03:39:11 +00005476static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05305477datetime_ctime(PyDateTime_DateTime *self, PyObject *Py_UNUSED(ignored))
Tim Petersa9bc1682003-01-11 03:39:11 +00005478{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005479 return format_ctime((PyDateTime_Date *)self,
5480 DATE_GET_HOUR(self),
5481 DATE_GET_MINUTE(self),
5482 DATE_GET_SECOND(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00005483}
5484
Tim Peters2a799bf2002-12-16 20:18:38 +00005485/* Miscellaneous methods. */
5486
Tim Petersa9bc1682003-01-11 03:39:11 +00005487static PyObject *
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005488flip_fold(PyObject *dt)
5489{
5490 return new_datetime_ex2(GET_YEAR(dt),
5491 GET_MONTH(dt),
5492 GET_DAY(dt),
5493 DATE_GET_HOUR(dt),
5494 DATE_GET_MINUTE(dt),
5495 DATE_GET_SECOND(dt),
5496 DATE_GET_MICROSECOND(dt),
5497 HASTZINFO(dt) ?
5498 ((PyDateTime_DateTime *)dt)->tzinfo : Py_None,
5499 !DATE_GET_FOLD(dt),
5500 Py_TYPE(dt));
5501}
5502
5503static PyObject *
5504get_flip_fold_offset(PyObject *dt)
5505{
5506 PyObject *result, *flip_dt;
5507
5508 flip_dt = flip_fold(dt);
5509 if (flip_dt == NULL)
5510 return NULL;
5511 result = datetime_utcoffset(flip_dt, NULL);
5512 Py_DECREF(flip_dt);
5513 return result;
5514}
5515
5516/* PEP 495 exception: Whenever one or both of the operands in
5517 * inter-zone comparison is such that its utcoffset() depends
Serhiy Storchakabac2d5b2018-03-28 22:14:26 +03005518 * on the value of its fold attribute, the result is False.
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005519 *
5520 * Return 1 if exception applies, 0 if not, and -1 on error.
5521 */
5522static int
5523pep495_eq_exception(PyObject *self, PyObject *other,
5524 PyObject *offset_self, PyObject *offset_other)
5525{
5526 int result = 0;
5527 PyObject *flip_offset;
5528
5529 flip_offset = get_flip_fold_offset(self);
5530 if (flip_offset == NULL)
5531 return -1;
5532 if (flip_offset != offset_self &&
5533 delta_cmp(flip_offset, offset_self))
5534 {
5535 result = 1;
5536 goto done;
5537 }
5538 Py_DECREF(flip_offset);
5539
5540 flip_offset = get_flip_fold_offset(other);
5541 if (flip_offset == NULL)
5542 return -1;
5543 if (flip_offset != offset_other &&
5544 delta_cmp(flip_offset, offset_other))
5545 result = 1;
5546 done:
5547 Py_DECREF(flip_offset);
5548 return result;
5549}
5550
5551static PyObject *
Guido van Rossum19960592006-08-24 17:29:38 +00005552datetime_richcompare(PyObject *self, PyObject *other, int op)
Tim Petersa9bc1682003-01-11 03:39:11 +00005553{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005554 PyObject *result = NULL;
5555 PyObject *offset1, *offset2;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005556 int diff;
Tim Petersa9bc1682003-01-11 03:39:11 +00005557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005558 if (! PyDateTime_Check(other)) {
5559 if (PyDate_Check(other)) {
5560 /* Prevent invocation of date_richcompare. We want to
5561 return NotImplemented here to give the other object
5562 a chance. But since DateTime is a subclass of
5563 Date, if the other object is a Date, it would
5564 compute an ordering based on the date part alone,
5565 and we don't want that. So force unequal or
5566 uncomparable here in that case. */
5567 if (op == Py_EQ)
5568 Py_RETURN_FALSE;
5569 if (op == Py_NE)
5570 Py_RETURN_TRUE;
5571 return cmperror(self, other);
5572 }
Brian Curtindfc80e32011-08-10 20:28:54 -05005573 Py_RETURN_NOTIMPLEMENTED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005574 }
Tim Petersa9bc1682003-01-11 03:39:11 +00005575
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005576 if (GET_DT_TZINFO(self) == GET_DT_TZINFO(other)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005577 diff = memcmp(((PyDateTime_DateTime *)self)->data,
5578 ((PyDateTime_DateTime *)other)->data,
5579 _PyDateTime_DATETIME_DATASIZE);
5580 return diff_to_bool(diff, op);
5581 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005582 offset1 = datetime_utcoffset(self, NULL);
5583 if (offset1 == NULL)
5584 return NULL;
5585 offset2 = datetime_utcoffset(other, NULL);
5586 if (offset2 == NULL)
5587 goto done;
5588 /* If they're both naive, or both aware and have the same offsets,
5589 * we get off cheap. Note that if they're both naive, offset1 ==
5590 * offset2 == Py_None at this point.
5591 */
5592 if ((offset1 == offset2) ||
5593 (PyDelta_Check(offset1) && PyDelta_Check(offset2) &&
5594 delta_cmp(offset1, offset2) == 0)) {
5595 diff = memcmp(((PyDateTime_DateTime *)self)->data,
5596 ((PyDateTime_DateTime *)other)->data,
5597 _PyDateTime_DATETIME_DATASIZE);
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005598 if ((op == Py_EQ || op == Py_NE) && diff == 0) {
5599 int ex = pep495_eq_exception(self, other, offset1, offset2);
5600 if (ex == -1)
5601 goto done;
5602 if (ex)
5603 diff = 1;
5604 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005605 result = diff_to_bool(diff, op);
5606 }
5607 else if (offset1 != Py_None && offset2 != Py_None) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005608 PyDateTime_Delta *delta;
Tim Petersa9bc1682003-01-11 03:39:11 +00005609
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005610 assert(offset1 != offset2); /* else last "if" handled it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005611 delta = (PyDateTime_Delta *)datetime_subtract((PyObject *)self,
5612 other);
5613 if (delta == NULL)
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005614 goto done;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005615 diff = GET_TD_DAYS(delta);
5616 if (diff == 0)
5617 diff = GET_TD_SECONDS(delta) |
5618 GET_TD_MICROSECONDS(delta);
5619 Py_DECREF(delta);
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005620 if ((op == Py_EQ || op == Py_NE) && diff == 0) {
5621 int ex = pep495_eq_exception(self, other, offset1, offset2);
5622 if (ex == -1)
5623 goto done;
5624 if (ex)
5625 diff = 1;
5626 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005627 result = diff_to_bool(diff, op);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005628 }
Alexander Belopolsky08313822012-06-15 20:19:47 -04005629 else if (op == Py_EQ) {
5630 result = Py_False;
5631 Py_INCREF(result);
5632 }
5633 else if (op == Py_NE) {
5634 result = Py_True;
5635 Py_INCREF(result);
5636 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005637 else {
5638 PyErr_SetString(PyExc_TypeError,
5639 "can't compare offset-naive and "
5640 "offset-aware datetimes");
5641 }
5642 done:
5643 Py_DECREF(offset1);
5644 Py_XDECREF(offset2);
5645 return result;
Tim Petersa9bc1682003-01-11 03:39:11 +00005646}
5647
Benjamin Peterson8f67d082010-10-17 20:54:53 +00005648static Py_hash_t
Tim Petersa9bc1682003-01-11 03:39:11 +00005649datetime_hash(PyDateTime_DateTime *self)
5650{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005651 if (self->hashcode == -1) {
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005652 PyObject *offset, *self0;
5653 if (DATE_GET_FOLD(self)) {
5654 self0 = new_datetime_ex2(GET_YEAR(self),
5655 GET_MONTH(self),
5656 GET_DAY(self),
5657 DATE_GET_HOUR(self),
5658 DATE_GET_MINUTE(self),
5659 DATE_GET_SECOND(self),
5660 DATE_GET_MICROSECOND(self),
5661 HASTZINFO(self) ? self->tzinfo : Py_None,
5662 0, Py_TYPE(self));
5663 if (self0 == NULL)
5664 return -1;
5665 }
5666 else {
5667 self0 = (PyObject *)self;
5668 Py_INCREF(self0);
5669 }
5670 offset = datetime_utcoffset(self0, NULL);
5671 Py_DECREF(self0);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005672
5673 if (offset == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005674 return -1;
Tim Petersa9bc1682003-01-11 03:39:11 +00005675
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005676 /* Reduce this to a hash of another object. */
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005677 if (offset == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005678 self->hashcode = generic_hash(
5679 (unsigned char *)self->data, _PyDateTime_DATETIME_DATASIZE);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005680 else {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005681 PyObject *temp1, *temp2;
5682 int days, seconds;
Tim Petersa9bc1682003-01-11 03:39:11 +00005683
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005684 assert(HASTZINFO(self));
5685 days = ymd_to_ord(GET_YEAR(self),
5686 GET_MONTH(self),
5687 GET_DAY(self));
5688 seconds = DATE_GET_HOUR(self) * 3600 +
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005689 DATE_GET_MINUTE(self) * 60 +
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005690 DATE_GET_SECOND(self);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005691 temp1 = new_delta(days, seconds,
5692 DATE_GET_MICROSECOND(self),
5693 1);
5694 if (temp1 == NULL) {
5695 Py_DECREF(offset);
5696 return -1;
5697 }
5698 temp2 = delta_subtract(temp1, offset);
5699 Py_DECREF(temp1);
5700 if (temp2 == NULL) {
5701 Py_DECREF(offset);
5702 return -1;
5703 }
5704 self->hashcode = PyObject_Hash(temp2);
5705 Py_DECREF(temp2);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005706 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005707 Py_DECREF(offset);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005708 }
5709 return self->hashcode;
Tim Petersa9bc1682003-01-11 03:39:11 +00005710}
Tim Peters2a799bf2002-12-16 20:18:38 +00005711
5712static PyObject *
Tim Petersa9bc1682003-01-11 03:39:11 +00005713datetime_replace(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters12bf3392002-12-24 05:41:27 +00005714{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005715 PyObject *clone;
5716 PyObject *tuple;
5717 int y = GET_YEAR(self);
5718 int m = GET_MONTH(self);
5719 int d = GET_DAY(self);
5720 int hh = DATE_GET_HOUR(self);
5721 int mm = DATE_GET_MINUTE(self);
5722 int ss = DATE_GET_SECOND(self);
5723 int us = DATE_GET_MICROSECOND(self);
5724 PyObject *tzinfo = HASTZINFO(self) ? self->tzinfo : Py_None;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005725 int fold = DATE_GET_FOLD(self);
Tim Peters12bf3392002-12-24 05:41:27 +00005726
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005727 if (! PyArg_ParseTupleAndKeywords(args, kw, "|iiiiiiiO$i:replace",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005728 datetime_kws,
5729 &y, &m, &d, &hh, &mm, &ss, &us,
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005730 &tzinfo, &fold))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005731 return NULL;
Serhiy Storchaka314d6fc2017-03-31 22:48:16 +03005732 if (fold != 0 && fold != 1) {
5733 PyErr_SetString(PyExc_ValueError,
5734 "fold must be either 0 or 1");
5735 return NULL;
5736 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005737 tuple = Py_BuildValue("iiiiiiiO", y, m, d, hh, mm, ss, us, tzinfo);
5738 if (tuple == NULL)
5739 return NULL;
5740 clone = datetime_new(Py_TYPE(self), tuple, NULL);
Alexander Belopolsky47649ab2016-08-08 17:05:40 -04005741 if (clone != NULL) {
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005742 DATE_SET_FOLD(clone, fold);
Alexander Belopolsky47649ab2016-08-08 17:05:40 -04005743 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005744 Py_DECREF(tuple);
5745 return clone;
Tim Peters12bf3392002-12-24 05:41:27 +00005746}
5747
5748static PyObject *
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005749local_timezone_from_timestamp(time_t timestamp)
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005750{
5751 PyObject *result = NULL;
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005752 PyObject *delta;
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04005753 struct tm local_time_tm;
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005754 PyObject *nameo = NULL;
5755 const char *zone = NULL;
5756
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04005757 if (_PyTime_localtime(timestamp, &local_time_tm) != 0)
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04005758 return NULL;
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005759#ifdef HAVE_STRUCT_TM_TM_ZONE
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04005760 zone = local_time_tm.tm_zone;
5761 delta = new_delta(0, local_time_tm.tm_gmtoff, 0, 1);
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005762#else /* HAVE_STRUCT_TM_TM_ZONE */
5763 {
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005764 PyObject *local_time, *utc_time;
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04005765 struct tm utc_time_tm;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005766 char buf[100];
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04005767 strftime(buf, sizeof(buf), "%Z", &local_time_tm);
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005768 zone = buf;
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04005769 local_time = new_datetime(local_time_tm.tm_year + 1900,
5770 local_time_tm.tm_mon + 1,
5771 local_time_tm.tm_mday,
5772 local_time_tm.tm_hour,
5773 local_time_tm.tm_min,
5774 local_time_tm.tm_sec, 0, Py_None, 0);
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005775 if (local_time == NULL) {
5776 return NULL;
5777 }
Alexander Belopolsky3e7a3cb2016-09-28 17:31:35 -04005778 if (_PyTime_gmtime(timestamp, &utc_time_tm) != 0)
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04005779 return NULL;
Alexander Belopolsky6d88fa52016-09-10 15:58:31 -04005780 utc_time = new_datetime(utc_time_tm.tm_year + 1900,
5781 utc_time_tm.tm_mon + 1,
5782 utc_time_tm.tm_mday,
5783 utc_time_tm.tm_hour,
5784 utc_time_tm.tm_min,
5785 utc_time_tm.tm_sec, 0, Py_None, 0);
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005786 if (utc_time == NULL) {
5787 Py_DECREF(local_time);
5788 return NULL;
5789 }
5790 delta = datetime_subtract(local_time, utc_time);
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005791 Py_DECREF(local_time);
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005792 Py_DECREF(utc_time);
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005793 }
5794#endif /* HAVE_STRUCT_TM_TM_ZONE */
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005795 if (delta == NULL) {
5796 return NULL;
5797 }
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005798 if (zone != NULL) {
5799 nameo = PyUnicode_DecodeLocale(zone, "surrogateescape");
5800 if (nameo == NULL)
5801 goto error;
5802 }
5803 result = new_timezone(delta, nameo);
Christian Heimesb91ffaa2013-06-29 20:52:33 +02005804 Py_XDECREF(nameo);
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005805 error:
5806 Py_DECREF(delta);
5807 return result;
5808}
5809
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005810static PyObject *
5811local_timezone(PyDateTime_DateTime *utc_time)
5812{
5813 time_t timestamp;
5814 PyObject *delta;
5815 PyObject *one_second;
5816 PyObject *seconds;
5817
5818 delta = datetime_subtract((PyObject *)utc_time, PyDateTime_Epoch);
5819 if (delta == NULL)
5820 return NULL;
5821 one_second = new_delta(0, 1, 0, 0);
5822 if (one_second == NULL) {
5823 Py_DECREF(delta);
5824 return NULL;
5825 }
5826 seconds = divide_timedelta_timedelta((PyDateTime_Delta *)delta,
5827 (PyDateTime_Delta *)one_second);
5828 Py_DECREF(one_second);
5829 Py_DECREF(delta);
5830 if (seconds == NULL)
5831 return NULL;
5832 timestamp = _PyLong_AsTime_t(seconds);
5833 Py_DECREF(seconds);
5834 if (timestamp == -1 && PyErr_Occurred())
5835 return NULL;
5836 return local_timezone_from_timestamp(timestamp);
5837}
5838
Benjamin Petersonaf580df2016-09-06 10:46:49 -07005839static long long
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005840local_to_seconds(int year, int month, int day,
5841 int hour, int minute, int second, int fold);
5842
5843static PyObject *
5844local_timezone_from_local(PyDateTime_DateTime *local_dt)
5845{
Benjamin Petersonaf580df2016-09-06 10:46:49 -07005846 long long seconds;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005847 time_t timestamp;
5848 seconds = local_to_seconds(GET_YEAR(local_dt),
5849 GET_MONTH(local_dt),
5850 GET_DAY(local_dt),
5851 DATE_GET_HOUR(local_dt),
5852 DATE_GET_MINUTE(local_dt),
5853 DATE_GET_SECOND(local_dt),
5854 DATE_GET_FOLD(local_dt));
5855 if (seconds == -1)
5856 return NULL;
5857 /* XXX: add bounds check */
5858 timestamp = seconds - epoch;
5859 return local_timezone_from_timestamp(timestamp);
5860}
5861
Alexander Belopolsky878054e2012-06-22 14:11:58 -04005862static PyDateTime_DateTime *
Tim Petersa9bc1682003-01-11 03:39:11 +00005863datetime_astimezone(PyDateTime_DateTime *self, PyObject *args, PyObject *kw)
Tim Peters80475bb2002-12-25 07:40:55 +00005864{
Alexander Belopolsky31227ca2012-06-22 13:23:21 -04005865 PyDateTime_DateTime *result;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005866 PyObject *offset;
5867 PyObject *temp;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005868 PyObject *self_tzinfo;
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005869 PyObject *tzinfo = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005870 static char *keywords[] = {"tz", NULL};
Tim Peters80475bb2002-12-25 07:40:55 +00005871
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005872 if (! PyArg_ParseTupleAndKeywords(args, kw, "|O:astimezone", keywords,
Raymond Hettinger5a2146a2014-07-25 14:59:48 -07005873 &tzinfo))
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005874 return NULL;
5875
5876 if (check_tzinfo_subclass(tzinfo) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005877 return NULL;
Tim Peters80475bb2002-12-25 07:40:55 +00005878
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005879 if (!HASTZINFO(self) || self->tzinfo == Py_None) {
Alexander Belopolsky877b2322018-06-10 17:02:58 -04005880 naive:
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005881 self_tzinfo = local_timezone_from_local(self);
5882 if (self_tzinfo == NULL)
5883 return NULL;
5884 } else {
5885 self_tzinfo = self->tzinfo;
5886 Py_INCREF(self_tzinfo);
5887 }
Tim Peters521fc152002-12-31 17:36:56 +00005888
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005889 /* Conversion to self's own time zone is a NOP. */
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005890 if (self_tzinfo == tzinfo) {
5891 Py_DECREF(self_tzinfo);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005892 Py_INCREF(self);
Alexander Belopolsky878054e2012-06-22 14:11:58 -04005893 return self;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005894 }
Tim Peters521fc152002-12-31 17:36:56 +00005895
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005896 /* Convert self to UTC. */
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005897 offset = call_utcoffset(self_tzinfo, (PyObject *)self);
5898 Py_DECREF(self_tzinfo);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005899 if (offset == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005900 return NULL;
Alexander Belopolsky877b2322018-06-10 17:02:58 -04005901 else if(offset == Py_None) {
5902 Py_DECREF(offset);
5903 goto naive;
5904 }
5905 else if (!PyDelta_Check(offset)) {
5906 Py_DECREF(offset);
5907 PyErr_Format(PyExc_TypeError, "utcoffset() returned %.200s,"
5908 " expected timedelta or None", Py_TYPE(offset)->tp_name);
5909 return NULL;
5910 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005911 /* result = self - offset */
Alexander Belopolsky31227ca2012-06-22 13:23:21 -04005912 result = (PyDateTime_DateTime *)add_datetime_timedelta(self,
5913 (PyDateTime_Delta *)offset, -1);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005914 Py_DECREF(offset);
5915 if (result == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005916 return NULL;
Tim Peters52dcce22003-01-23 16:36:11 +00005917
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005918 /* Make sure result is aware and UTC. */
5919 if (!HASTZINFO(result)) {
5920 temp = (PyObject *)result;
5921 result = (PyDateTime_DateTime *)
5922 new_datetime_ex2(GET_YEAR(result),
5923 GET_MONTH(result),
5924 GET_DAY(result),
5925 DATE_GET_HOUR(result),
5926 DATE_GET_MINUTE(result),
5927 DATE_GET_SECOND(result),
5928 DATE_GET_MICROSECOND(result),
5929 PyDateTime_TimeZone_UTC,
5930 DATE_GET_FOLD(result),
5931 Py_TYPE(result));
5932 Py_DECREF(temp);
5933 if (result == NULL)
5934 return NULL;
5935 }
5936 else {
5937 /* Result is already aware - just replace tzinfo. */
5938 temp = result->tzinfo;
5939 result->tzinfo = PyDateTime_TimeZone_UTC;
5940 Py_INCREF(result->tzinfo);
5941 Py_DECREF(temp);
5942 }
5943
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005944 /* Attach new tzinfo and let fromutc() do the rest. */
Alexander Belopolsky31227ca2012-06-22 13:23:21 -04005945 temp = result->tzinfo;
Alexander Belopolskyfdc860f2012-06-22 12:23:23 -04005946 if (tzinfo == Py_None) {
5947 tzinfo = local_timezone(result);
5948 if (tzinfo == NULL) {
5949 Py_DECREF(result);
5950 return NULL;
5951 }
5952 }
5953 else
5954 Py_INCREF(tzinfo);
Alexander Belopolsky31227ca2012-06-22 13:23:21 -04005955 result->tzinfo = tzinfo;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005956 Py_DECREF(temp);
Tim Peters52dcce22003-01-23 16:36:11 +00005957
Alexander Belopolsky31227ca2012-06-22 13:23:21 -04005958 temp = (PyObject *)result;
Alexander Belopolsky878054e2012-06-22 14:11:58 -04005959 result = (PyDateTime_DateTime *)
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02005960 _PyObject_CallMethodIdOneArg(tzinfo, &PyId_fromutc, temp);
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005961 Py_DECREF(temp);
5962
Alexander Belopolsky878054e2012-06-22 14:11:58 -04005963 return result;
Tim Peters80475bb2002-12-25 07:40:55 +00005964}
5965
5966static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05305967datetime_timetuple(PyDateTime_DateTime *self, PyObject *Py_UNUSED(ignored))
Tim Peters2a799bf2002-12-16 20:18:38 +00005968{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005969 int dstflag = -1;
Tim Peters2a799bf2002-12-16 20:18:38 +00005970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005971 if (HASTZINFO(self) && self->tzinfo != Py_None) {
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005972 PyObject * dst;
Tim Peters2a799bf2002-12-16 20:18:38 +00005973
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005974 dst = call_dst(self->tzinfo, (PyObject *)self);
5975 if (dst == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005976 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00005977
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00005978 if (dst != Py_None)
5979 dstflag = delta_bool((PyDateTime_Delta *)dst);
5980 Py_DECREF(dst);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00005981 }
5982 return build_struct_time(GET_YEAR(self),
5983 GET_MONTH(self),
5984 GET_DAY(self),
5985 DATE_GET_HOUR(self),
5986 DATE_GET_MINUTE(self),
5987 DATE_GET_SECOND(self),
5988 dstflag);
Tim Peters2a799bf2002-12-16 20:18:38 +00005989}
5990
Benjamin Petersonaf580df2016-09-06 10:46:49 -07005991static long long
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005992local_to_seconds(int year, int month, int day,
5993 int hour, int minute, int second, int fold)
5994{
Benjamin Petersonaf580df2016-09-06 10:46:49 -07005995 long long t, a, b, u1, u2, t1, t2, lt;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04005996 t = utc_to_seconds(year, month, day, hour, minute, second);
5997 /* Our goal is to solve t = local(u) for u. */
5998 lt = local(t);
5999 if (lt == -1)
6000 return -1;
6001 a = lt - t;
6002 u1 = t - a;
6003 t1 = local(u1);
6004 if (t1 == -1)
6005 return -1;
6006 if (t1 == t) {
6007 /* We found one solution, but it may not be the one we need.
6008 * Look for an earlier solution (if `fold` is 0), or a
6009 * later one (if `fold` is 1). */
6010 if (fold)
6011 u2 = u1 + max_fold_seconds;
6012 else
6013 u2 = u1 - max_fold_seconds;
6014 lt = local(u2);
6015 if (lt == -1)
6016 return -1;
6017 b = lt - u2;
6018 if (a == b)
6019 return u1;
6020 }
6021 else {
6022 b = t1 - u1;
6023 assert(a != b);
6024 }
6025 u2 = t - b;
6026 t2 = local(u2);
6027 if (t2 == -1)
6028 return -1;
6029 if (t2 == t)
6030 return u2;
6031 if (t1 == t)
6032 return u1;
6033 /* We have found both offsets a and b, but neither t - a nor t - b is
6034 * a solution. This means t is in the gap. */
6035 return fold?Py_MIN(u1, u2):Py_MAX(u1, u2);
6036}
6037
6038/* date(1970,1,1).toordinal() == 719163 */
6039#define EPOCH_SECONDS (719163LL * 24 * 60 * 60)
6040
Tim Peters2a799bf2002-12-16 20:18:38 +00006041static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05306042datetime_timestamp(PyDateTime_DateTime *self, PyObject *Py_UNUSED(ignored))
Alexander Belopolskya4415142012-06-08 12:33:09 -04006043{
6044 PyObject *result;
6045
6046 if (HASTZINFO(self) && self->tzinfo != Py_None) {
6047 PyObject *delta;
6048 delta = datetime_subtract((PyObject *)self, PyDateTime_Epoch);
6049 if (delta == NULL)
6050 return NULL;
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05306051 result = delta_total_seconds(delta, NULL);
Alexander Belopolskya4415142012-06-08 12:33:09 -04006052 Py_DECREF(delta);
6053 }
6054 else {
Benjamin Petersonaf580df2016-09-06 10:46:49 -07006055 long long seconds;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006056 seconds = local_to_seconds(GET_YEAR(self),
6057 GET_MONTH(self),
6058 GET_DAY(self),
6059 DATE_GET_HOUR(self),
6060 DATE_GET_MINUTE(self),
6061 DATE_GET_SECOND(self),
6062 DATE_GET_FOLD(self));
6063 if (seconds == -1)
Alexander Belopolskya4415142012-06-08 12:33:09 -04006064 return NULL;
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006065 result = PyFloat_FromDouble(seconds - EPOCH_SECONDS +
6066 DATE_GET_MICROSECOND(self) / 1e6);
Alexander Belopolskya4415142012-06-08 12:33:09 -04006067 }
6068 return result;
6069}
6070
6071static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05306072datetime_getdate(PyDateTime_DateTime *self, PyObject *Py_UNUSED(ignored))
Tim Petersa9bc1682003-01-11 03:39:11 +00006073{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006074 return new_date(GET_YEAR(self),
6075 GET_MONTH(self),
6076 GET_DAY(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00006077}
6078
6079static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05306080datetime_gettime(PyDateTime_DateTime *self, PyObject *Py_UNUSED(ignored))
Tim Petersa9bc1682003-01-11 03:39:11 +00006081{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006082 return new_time(DATE_GET_HOUR(self),
6083 DATE_GET_MINUTE(self),
6084 DATE_GET_SECOND(self),
6085 DATE_GET_MICROSECOND(self),
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006086 Py_None,
6087 DATE_GET_FOLD(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00006088}
6089
6090static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05306091datetime_gettimetz(PyDateTime_DateTime *self, PyObject *Py_UNUSED(ignored))
Tim Petersa9bc1682003-01-11 03:39:11 +00006092{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006093 return new_time(DATE_GET_HOUR(self),
6094 DATE_GET_MINUTE(self),
6095 DATE_GET_SECOND(self),
6096 DATE_GET_MICROSECOND(self),
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006097 GET_DT_TZINFO(self),
6098 DATE_GET_FOLD(self));
Tim Petersa9bc1682003-01-11 03:39:11 +00006099}
6100
6101static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05306102datetime_utctimetuple(PyDateTime_DateTime *self, PyObject *Py_UNUSED(ignored))
Tim Peters2a799bf2002-12-16 20:18:38 +00006103{
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00006104 int y, m, d, hh, mm, ss;
6105 PyObject *tzinfo;
6106 PyDateTime_DateTime *utcself;
Tim Peters2a799bf2002-12-16 20:18:38 +00006107
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00006108 tzinfo = GET_DT_TZINFO(self);
6109 if (tzinfo == Py_None) {
6110 utcself = self;
6111 Py_INCREF(utcself);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006112 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00006113 else {
6114 PyObject *offset;
6115 offset = call_utcoffset(tzinfo, (PyObject *)self);
6116 if (offset == NULL)
Alexander Belopolsky75f94c22010-06-21 15:21:14 +00006117 return NULL;
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00006118 if (offset == Py_None) {
6119 Py_DECREF(offset);
6120 utcself = self;
6121 Py_INCREF(utcself);
6122 }
6123 else {
6124 utcself = (PyDateTime_DateTime *)add_datetime_timedelta(self,
6125 (PyDateTime_Delta *)offset, -1);
6126 Py_DECREF(offset);
6127 if (utcself == NULL)
6128 return NULL;
6129 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006130 }
Alexander Belopolsky73ca4402010-07-07 23:56:38 +00006131 y = GET_YEAR(utcself);
6132 m = GET_MONTH(utcself);
6133 d = GET_DAY(utcself);
6134 hh = DATE_GET_HOUR(utcself);
6135 mm = DATE_GET_MINUTE(utcself);
6136 ss = DATE_GET_SECOND(utcself);
6137
6138 Py_DECREF(utcself);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006139 return build_struct_time(y, m, d, hh, mm, ss, 0);
Tim Peters2a799bf2002-12-16 20:18:38 +00006140}
6141
Tim Peters371935f2003-02-01 01:52:50 +00006142/* Pickle support, a simple use of __reduce__. */
Tim Peters33e0f382003-01-10 02:05:14 +00006143
Tim Petersa9bc1682003-01-11 03:39:11 +00006144/* Let basestate be the non-tzinfo data string.
Tim Peters2a799bf2002-12-16 20:18:38 +00006145 * If tzinfo is None, this returns (basestate,), else (basestate, tzinfo).
6146 * So it's a tuple in any (non-error) case.
Tim Petersb57f8f02003-02-01 02:54:15 +00006147 * __getstate__ isn't exposed.
Tim Peters2a799bf2002-12-16 20:18:38 +00006148 */
6149static PyObject *
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006150datetime_getstate(PyDateTime_DateTime *self, int proto)
Tim Peters2a799bf2002-12-16 20:18:38 +00006151{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006152 PyObject *basestate;
6153 PyObject *result = NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00006154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006155 basestate = PyBytes_FromStringAndSize((char *)self->data,
6156 _PyDateTime_DATETIME_DATASIZE);
6157 if (basestate != NULL) {
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006158 if (proto > 3 && DATE_GET_FOLD(self))
6159 /* Set the first bit of the third byte */
6160 PyBytes_AS_STRING(basestate)[2] |= (1 << 7);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006161 if (! HASTZINFO(self) || self->tzinfo == Py_None)
6162 result = PyTuple_Pack(1, basestate);
6163 else
6164 result = PyTuple_Pack(2, basestate, self->tzinfo);
6165 Py_DECREF(basestate);
6166 }
6167 return result;
Tim Peters2a799bf2002-12-16 20:18:38 +00006168}
6169
6170static PyObject *
Serhiy Storchaka546ce652016-11-22 00:29:42 +02006171datetime_reduce_ex(PyDateTime_DateTime *self, PyObject *args)
Tim Peters2a799bf2002-12-16 20:18:38 +00006172{
Serhiy Storchaka546ce652016-11-22 00:29:42 +02006173 int proto;
6174 if (!PyArg_ParseTuple(args, "i:__reduce_ex__", &proto))
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006175 return NULL;
6176
6177 return Py_BuildValue("(ON)", Py_TYPE(self), datetime_getstate(self, proto));
Tim Peters2a799bf2002-12-16 20:18:38 +00006178}
6179
Serhiy Storchaka546ce652016-11-22 00:29:42 +02006180static PyObject *
6181datetime_reduce(PyDateTime_DateTime *self, PyObject *arg)
6182{
6183 return Py_BuildValue("(ON)", Py_TYPE(self), datetime_getstate(self, 2));
6184}
6185
Tim Petersa9bc1682003-01-11 03:39:11 +00006186static PyMethodDef datetime_methods[] = {
Guido van Rossum177e41a2003-01-30 22:06:23 +00006187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006188 /* Class methods: */
Tim Peters2a799bf2002-12-16 20:18:38 +00006189
Larry Hastingsed4a1c52013-11-18 09:32:13 -08006190 DATETIME_DATETIME_NOW_METHODDEF
Tim Peters2a799bf2002-12-16 20:18:38 +00006191
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006192 {"utcnow", (PyCFunction)datetime_utcnow,
6193 METH_NOARGS | METH_CLASS,
6194 PyDoc_STR("Return a new datetime representing UTC day and time.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00006195
Serhiy Storchaka62be7422018-11-27 13:27:31 +02006196 {"fromtimestamp", (PyCFunction)(void(*)(void))datetime_fromtimestamp,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006197 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
6198 PyDoc_STR("timestamp[, tz] -> tz's local time from POSIX timestamp.")},
Tim Peters2a799bf2002-12-16 20:18:38 +00006199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006200 {"utcfromtimestamp", (PyCFunction)datetime_utcfromtimestamp,
6201 METH_VARARGS | METH_CLASS,
Alexander Belopolskye2e178e2015-03-01 14:52:07 -05006202 PyDoc_STR("Construct a naive UTC datetime from a POSIX timestamp.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00006203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006204 {"strptime", (PyCFunction)datetime_strptime,
6205 METH_VARARGS | METH_CLASS,
6206 PyDoc_STR("string, format -> new datetime parsed from a string "
6207 "(like time.strptime()).")},
Skip Montanaro0af3ade2005-01-13 04:12:31 +00006208
Serhiy Storchaka62be7422018-11-27 13:27:31 +02006209 {"combine", (PyCFunction)(void(*)(void))datetime_combine,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006210 METH_VARARGS | METH_KEYWORDS | METH_CLASS,
6211 PyDoc_STR("date, time -> datetime with same date and time fields")},
Tim Petersa9bc1682003-01-11 03:39:11 +00006212
Paul Ganssle09dc2f52017-12-21 00:33:49 -05006213 {"fromisoformat", (PyCFunction)datetime_fromisoformat,
6214 METH_O | METH_CLASS,
6215 PyDoc_STR("string -> datetime from datetime.isoformat() output")},
6216
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006217 /* Instance methods: */
Guido van Rossum177e41a2003-01-30 22:06:23 +00006218
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006219 {"date", (PyCFunction)datetime_getdate, METH_NOARGS,
6220 PyDoc_STR("Return date object with same year, month and day.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00006221
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006222 {"time", (PyCFunction)datetime_gettime, METH_NOARGS,
6223 PyDoc_STR("Return time object with same time but with tzinfo=None.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00006224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006225 {"timetz", (PyCFunction)datetime_gettimetz, METH_NOARGS,
6226 PyDoc_STR("Return time object with same time and tzinfo.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00006227
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006228 {"ctime", (PyCFunction)datetime_ctime, METH_NOARGS,
6229 PyDoc_STR("Return ctime() style string.")},
Tim Petersa9bc1682003-01-11 03:39:11 +00006230
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006231 {"timetuple", (PyCFunction)datetime_timetuple, METH_NOARGS,
6232 PyDoc_STR("Return time tuple, compatible with time.localtime().")},
Tim Peters2a799bf2002-12-16 20:18:38 +00006233
Alexander Belopolskya4415142012-06-08 12:33:09 -04006234 {"timestamp", (PyCFunction)datetime_timestamp, METH_NOARGS,
6235 PyDoc_STR("Return POSIX timestamp as float.")},
6236
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006237 {"utctimetuple", (PyCFunction)datetime_utctimetuple, METH_NOARGS,
6238 PyDoc_STR("Return UTC time tuple, compatible with time.localtime().")},
Tim Peters2a799bf2002-12-16 20:18:38 +00006239
Serhiy Storchaka62be7422018-11-27 13:27:31 +02006240 {"isoformat", (PyCFunction)(void(*)(void))datetime_isoformat, METH_VARARGS | METH_KEYWORDS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006241 PyDoc_STR("[sep] -> string in ISO 8601 format, "
Alexander Belopolskya2998a62016-03-06 14:58:43 -05006242 "YYYY-MM-DDT[HH[:MM[:SS[.mmm[uuu]]]]][+HH:MM].\n"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006243 "sep is used to separate the year from the time, and "
Alexander Belopolskya2998a62016-03-06 14:58:43 -05006244 "defaults to 'T'.\n"
6245 "timespec specifies what components of the time to include"
6246 " (allowed values are 'auto', 'hours', 'minutes', 'seconds',"
6247 " 'milliseconds', and 'microseconds').\n")},
Tim Peters2a799bf2002-12-16 20:18:38 +00006248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006249 {"utcoffset", (PyCFunction)datetime_utcoffset, METH_NOARGS,
6250 PyDoc_STR("Return self.tzinfo.utcoffset(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00006251
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006252 {"tzname", (PyCFunction)datetime_tzname, METH_NOARGS,
6253 PyDoc_STR("Return self.tzinfo.tzname(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00006254
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006255 {"dst", (PyCFunction)datetime_dst, METH_NOARGS,
6256 PyDoc_STR("Return self.tzinfo.dst(self).")},
Tim Peters2a799bf2002-12-16 20:18:38 +00006257
Serhiy Storchaka62be7422018-11-27 13:27:31 +02006258 {"replace", (PyCFunction)(void(*)(void))datetime_replace, METH_VARARGS | METH_KEYWORDS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006259 PyDoc_STR("Return datetime with new specified fields.")},
Tim Peters12bf3392002-12-24 05:41:27 +00006260
Serhiy Storchaka62be7422018-11-27 13:27:31 +02006261 {"astimezone", (PyCFunction)(void(*)(void))datetime_astimezone, METH_VARARGS | METH_KEYWORDS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006262 PyDoc_STR("tz -> convert to local time in new timezone tz\n")},
Tim Peters80475bb2002-12-25 07:40:55 +00006263
Serhiy Storchaka546ce652016-11-22 00:29:42 +02006264 {"__reduce_ex__", (PyCFunction)datetime_reduce_ex, METH_VARARGS,
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006265 PyDoc_STR("__reduce_ex__(proto) -> (cls, state)")},
Guido van Rossum177e41a2003-01-30 22:06:23 +00006266
Serhiy Storchaka546ce652016-11-22 00:29:42 +02006267 {"__reduce__", (PyCFunction)datetime_reduce, METH_NOARGS,
6268 PyDoc_STR("__reduce__() -> (cls, state)")},
6269
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006270 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00006271};
6272
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02006273static const char datetime_doc[] =
Raymond Hettinger3a4231d2004-12-19 20:13:24 +00006274PyDoc_STR("datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])\n\
6275\n\
6276The year, month and day arguments are required. tzinfo may be None, or an\n\
Serhiy Storchaka95949422013-08-27 19:40:23 +03006277instance of a tzinfo subclass. The remaining arguments may be ints.\n");
Tim Peters2a799bf2002-12-16 20:18:38 +00006278
Tim Petersa9bc1682003-01-11 03:39:11 +00006279static PyNumberMethods datetime_as_number = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006280 datetime_add, /* nb_add */
6281 datetime_subtract, /* nb_subtract */
6282 0, /* nb_multiply */
6283 0, /* nb_remainder */
6284 0, /* nb_divmod */
6285 0, /* nb_power */
6286 0, /* nb_negative */
6287 0, /* nb_positive */
6288 0, /* nb_absolute */
6289 0, /* nb_bool */
Tim Peters2a799bf2002-12-16 20:18:38 +00006290};
6291
Neal Norwitz227b5332006-03-22 09:28:35 +00006292static PyTypeObject PyDateTime_DateTimeType = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006293 PyVarObject_HEAD_INIT(NULL, 0)
6294 "datetime.datetime", /* tp_name */
6295 sizeof(PyDateTime_DateTime), /* tp_basicsize */
6296 0, /* tp_itemsize */
6297 (destructor)datetime_dealloc, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02006298 0, /* tp_vectorcall_offset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006299 0, /* tp_getattr */
6300 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +02006301 0, /* tp_as_async */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006302 (reprfunc)datetime_repr, /* tp_repr */
6303 &datetime_as_number, /* tp_as_number */
6304 0, /* tp_as_sequence */
6305 0, /* tp_as_mapping */
6306 (hashfunc)datetime_hash, /* tp_hash */
6307 0, /* tp_call */
6308 (reprfunc)datetime_str, /* tp_str */
6309 PyObject_GenericGetAttr, /* tp_getattro */
6310 0, /* tp_setattro */
6311 0, /* tp_as_buffer */
6312 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
6313 datetime_doc, /* tp_doc */
6314 0, /* tp_traverse */
6315 0, /* tp_clear */
6316 datetime_richcompare, /* tp_richcompare */
6317 0, /* tp_weaklistoffset */
6318 0, /* tp_iter */
6319 0, /* tp_iternext */
6320 datetime_methods, /* tp_methods */
6321 0, /* tp_members */
6322 datetime_getset, /* tp_getset */
6323 &PyDateTime_DateType, /* tp_base */
6324 0, /* tp_dict */
6325 0, /* tp_descr_get */
6326 0, /* tp_descr_set */
6327 0, /* tp_dictoffset */
6328 0, /* tp_init */
6329 datetime_alloc, /* tp_alloc */
6330 datetime_new, /* tp_new */
6331 0, /* tp_free */
Tim Peters2a799bf2002-12-16 20:18:38 +00006332};
6333
6334/* ---------------------------------------------------------------------------
6335 * Module methods and initialization.
6336 */
6337
6338static PyMethodDef module_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006339 {NULL, NULL}
Tim Peters2a799bf2002-12-16 20:18:38 +00006340};
6341
Tim Peters9ddf40b2004-06-20 22:41:32 +00006342/* C API. Clients get at this via PyDateTime_IMPORT, defined in
6343 * datetime.h.
6344 */
6345static PyDateTime_CAPI CAPI = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006346 &PyDateTime_DateType,
6347 &PyDateTime_DateTimeType,
6348 &PyDateTime_TimeType,
6349 &PyDateTime_DeltaType,
6350 &PyDateTime_TZInfoType,
Paul Ganssle04af5b12018-01-24 17:29:30 -05006351 NULL, // PyDatetime_TimeZone_UTC not initialized yet
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006352 new_date_ex,
6353 new_datetime_ex,
6354 new_time_ex,
6355 new_delta_ex,
Paul Ganssle04af5b12018-01-24 17:29:30 -05006356 new_timezone,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006357 datetime_fromtimestamp,
Paul Ganssle4d8c8c02019-04-27 15:39:40 -04006358 datetime_date_fromtimestamp_capi,
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006359 new_datetime_ex2,
6360 new_time_ex2
Tim Peters9ddf40b2004-06-20 22:41:32 +00006361};
6362
6363
Martin v. Löwis1a214512008-06-11 05:26:20 +00006364
6365static struct PyModuleDef datetimemodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006366 PyModuleDef_HEAD_INIT,
Alexander Belopolskycf86e362010-07-23 19:25:47 +00006367 "_datetime",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006368 "Fast implementation of the datetime type.",
6369 -1,
6370 module_methods,
6371 NULL,
6372 NULL,
6373 NULL,
6374 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00006375};
6376
Tim Peters2a799bf2002-12-16 20:18:38 +00006377PyMODINIT_FUNC
Alexander Belopolskycf86e362010-07-23 19:25:47 +00006378PyInit__datetime(void)
Tim Peters2a799bf2002-12-16 20:18:38 +00006379{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006380 PyObject *m; /* a module object */
6381 PyObject *d; /* its dict */
6382 PyObject *x;
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00006383 PyObject *delta;
Tim Peters2a799bf2002-12-16 20:18:38 +00006384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006385 m = PyModule_Create(&datetimemodule);
6386 if (m == NULL)
6387 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00006388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006389 if (PyType_Ready(&PyDateTime_DateType) < 0)
6390 return NULL;
6391 if (PyType_Ready(&PyDateTime_DateTimeType) < 0)
6392 return NULL;
6393 if (PyType_Ready(&PyDateTime_DeltaType) < 0)
6394 return NULL;
6395 if (PyType_Ready(&PyDateTime_TimeType) < 0)
6396 return NULL;
6397 if (PyType_Ready(&PyDateTime_TZInfoType) < 0)
6398 return NULL;
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00006399 if (PyType_Ready(&PyDateTime_TimeZoneType) < 0)
6400 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00006401
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006402 /* timedelta values */
6403 d = PyDateTime_DeltaType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00006404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006405 x = new_delta(0, 0, 1, 0);
6406 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
6407 return NULL;
6408 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00006409
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006410 x = new_delta(-MAX_DELTA_DAYS, 0, 0, 0);
6411 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
6412 return NULL;
6413 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00006414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006415 x = new_delta(MAX_DELTA_DAYS, 24*3600-1, 1000000-1, 0);
6416 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
6417 return NULL;
6418 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00006419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006420 /* date values */
6421 d = PyDateTime_DateType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00006422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006423 x = new_date(1, 1, 1);
6424 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
6425 return NULL;
6426 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00006427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006428 x = new_date(MAXYEAR, 12, 31);
6429 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
6430 return NULL;
6431 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00006432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006433 x = new_delta(1, 0, 0, 0);
6434 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
6435 return NULL;
6436 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00006437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006438 /* time values */
6439 d = PyDateTime_TimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00006440
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006441 x = new_time(0, 0, 0, 0, Py_None, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006442 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
6443 return NULL;
6444 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00006445
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006446 x = new_time(23, 59, 59, 999999, Py_None, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006447 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
6448 return NULL;
6449 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00006450
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006451 x = new_delta(0, 0, 1, 0);
6452 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
6453 return NULL;
6454 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00006455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006456 /* datetime values */
6457 d = PyDateTime_DateTimeType.tp_dict;
Tim Peters2a799bf2002-12-16 20:18:38 +00006458
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006459 x = new_datetime(1, 1, 1, 0, 0, 0, 0, Py_None, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006460 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
6461 return NULL;
6462 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00006463
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006464 x = new_datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, Py_None, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006465 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
6466 return NULL;
6467 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00006468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006469 x = new_delta(0, 0, 1, 0);
6470 if (x == NULL || PyDict_SetItemString(d, "resolution", x) < 0)
6471 return NULL;
6472 Py_DECREF(x);
Tim Peters2a799bf2002-12-16 20:18:38 +00006473
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00006474 /* timezone values */
6475 d = PyDateTime_TimeZoneType.tp_dict;
6476
6477 delta = new_delta(0, 0, 0, 0);
6478 if (delta == NULL)
6479 return NULL;
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +00006480 x = create_timezone(delta, NULL);
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00006481 Py_DECREF(delta);
6482 if (x == NULL || PyDict_SetItemString(d, "utc", x) < 0)
6483 return NULL;
Alexander Belopolskya11d8c02010-07-06 23:19:45 +00006484 PyDateTime_TimeZone_UTC = x;
Paul Ganssle04af5b12018-01-24 17:29:30 -05006485 CAPI.TimeZone_UTC = PyDateTime_TimeZone_UTC;
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00006486
Ngalim Siregar92c7e302019-08-09 21:22:16 +07006487 /* bpo-37642: These attributes are rounded to the nearest minute for backwards
6488 * compatibility, even though the constructor will accept a wider range of
6489 * values. This may change in the future.*/
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00006490 delta = new_delta(-1, 60, 0, 1); /* -23:59 */
6491 if (delta == NULL)
6492 return NULL;
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +00006493 x = create_timezone(delta, NULL);
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00006494 Py_DECREF(delta);
6495 if (x == NULL || PyDict_SetItemString(d, "min", x) < 0)
6496 return NULL;
6497 Py_DECREF(x);
6498
6499 delta = new_delta(0, (23 * 60 + 59) * 60, 0, 0); /* +23:59 */
6500 if (delta == NULL)
6501 return NULL;
Alexander Belopolsky1bcbaab2010-10-14 17:03:51 +00006502 x = create_timezone(delta, NULL);
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00006503 Py_DECREF(delta);
6504 if (x == NULL || PyDict_SetItemString(d, "max", x) < 0)
6505 return NULL;
6506 Py_DECREF(x);
6507
Alexander Belopolskya4415142012-06-08 12:33:09 -04006508 /* Epoch */
6509 PyDateTime_Epoch = new_datetime(1970, 1, 1, 0, 0, 0, 0,
Alexander Belopolsky5d0c5982016-07-22 18:47:04 -04006510 PyDateTime_TimeZone_UTC, 0);
Alexander Belopolskya4415142012-06-08 12:33:09 -04006511 if (PyDateTime_Epoch == NULL)
6512 return NULL;
6513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006514 /* module initialization */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +02006515 PyModule_AddIntMacro(m, MINYEAR);
6516 PyModule_AddIntMacro(m, MAXYEAR);
Tim Peters2a799bf2002-12-16 20:18:38 +00006517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006518 Py_INCREF(&PyDateTime_DateType);
6519 PyModule_AddObject(m, "date", (PyObject *) &PyDateTime_DateType);
Tim Peters2a799bf2002-12-16 20:18:38 +00006520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006521 Py_INCREF(&PyDateTime_DateTimeType);
6522 PyModule_AddObject(m, "datetime",
6523 (PyObject *)&PyDateTime_DateTimeType);
Tim Petersa9bc1682003-01-11 03:39:11 +00006524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006525 Py_INCREF(&PyDateTime_TimeType);
6526 PyModule_AddObject(m, "time", (PyObject *) &PyDateTime_TimeType);
Tim Petersa9bc1682003-01-11 03:39:11 +00006527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006528 Py_INCREF(&PyDateTime_DeltaType);
6529 PyModule_AddObject(m, "timedelta", (PyObject *) &PyDateTime_DeltaType);
Tim Peters2a799bf2002-12-16 20:18:38 +00006530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006531 Py_INCREF(&PyDateTime_TZInfoType);
6532 PyModule_AddObject(m, "tzinfo", (PyObject *) &PyDateTime_TZInfoType);
Tim Peters2a799bf2002-12-16 20:18:38 +00006533
Alexander Belopolsky4e749a12010-06-14 14:15:50 +00006534 Py_INCREF(&PyDateTime_TimeZoneType);
6535 PyModule_AddObject(m, "timezone", (PyObject *) &PyDateTime_TimeZoneType);
6536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006537 x = PyCapsule_New(&CAPI, PyDateTime_CAPSULE_NAME, NULL);
6538 if (x == NULL)
6539 return NULL;
6540 PyModule_AddObject(m, "datetime_CAPI", x);
Tim Peters9ddf40b2004-06-20 22:41:32 +00006541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006542 /* A 4-year cycle has an extra leap day over what we'd get from
6543 * pasting together 4 single years.
6544 */
Serhiy Storchakafad85aa2015-11-07 15:42:38 +02006545 Py_BUILD_ASSERT(DI4Y == 4 * 365 + 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006546 assert(DI4Y == days_before_year(4+1));
Tim Peters2a799bf2002-12-16 20:18:38 +00006547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006548 /* Similarly, a 400-year cycle has an extra leap day over what we'd
6549 * get from pasting together 4 100-year cycles.
6550 */
Serhiy Storchakafad85aa2015-11-07 15:42:38 +02006551 Py_BUILD_ASSERT(DI400Y == 4 * DI100Y + 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006552 assert(DI400Y == days_before_year(400+1));
Tim Peters2a799bf2002-12-16 20:18:38 +00006553
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006554 /* OTOH, a 100-year cycle has one fewer leap day than we'd get from
6555 * pasting together 25 4-year cycles.
6556 */
Serhiy Storchakafad85aa2015-11-07 15:42:38 +02006557 Py_BUILD_ASSERT(DI100Y == 25 * DI4Y - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006558 assert(DI100Y == days_before_year(100+1));
Tim Peters2a799bf2002-12-16 20:18:38 +00006559
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006560 us_per_ms = PyLong_FromLong(1000);
6561 us_per_second = PyLong_FromLong(1000000);
6562 us_per_minute = PyLong_FromLong(60000000);
6563 seconds_per_day = PyLong_FromLong(24 * 3600);
Serhiy Storchakaba85d692017-03-30 09:09:41 +03006564 if (us_per_ms == NULL || us_per_second == NULL ||
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006565 us_per_minute == NULL || seconds_per_day == NULL)
6566 return NULL;
Tim Peters2a799bf2002-12-16 20:18:38 +00006567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006568 /* The rest are too big for 32-bit ints, but even
6569 * us_per_week fits in 40 bits, so doubles should be exact.
6570 */
6571 us_per_hour = PyLong_FromDouble(3600000000.0);
6572 us_per_day = PyLong_FromDouble(86400000000.0);
6573 us_per_week = PyLong_FromDouble(604800000000.0);
6574 if (us_per_hour == NULL || us_per_day == NULL || us_per_week == NULL)
6575 return NULL;
6576 return m;
Tim Peters2a799bf2002-12-16 20:18:38 +00006577}
Tim Petersf3615152003-01-01 21:51:37 +00006578
6579/* ---------------------------------------------------------------------------
Tim Petersa9bc1682003-01-11 03:39:11 +00006580Some time zone algebra. For a datetime x, let
Tim Petersf3615152003-01-01 21:51:37 +00006581 x.n = x stripped of its timezone -- its naive time.
6582 x.o = x.utcoffset(), and assuming that doesn't raise an exception or
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006583 return None
Tim Petersf3615152003-01-01 21:51:37 +00006584 x.d = x.dst(), and assuming that doesn't raise an exception or
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006585 return None
Tim Petersf3615152003-01-01 21:51:37 +00006586 x.s = x's standard offset, x.o - x.d
6587
6588Now some derived rules, where k is a duration (timedelta).
6589
65901. x.o = x.s + x.d
6591 This follows from the definition of x.s.
6592
Tim Petersc5dc4da2003-01-02 17:55:03 +000065932. If x and y have the same tzinfo member, x.s = y.s.
Tim Petersf3615152003-01-01 21:51:37 +00006594 This is actually a requirement, an assumption we need to make about
6595 sane tzinfo classes.
6596
65973. The naive UTC time corresponding to x is x.n - x.o.
6598 This is again a requirement for a sane tzinfo class.
6599
66004. (x+k).s = x.s
Tim Peters8bb5ad22003-01-24 02:44:45 +00006601 This follows from #2, and that datimetimetz+timedelta preserves tzinfo.
Tim Petersf3615152003-01-01 21:51:37 +00006602
Tim Petersc5dc4da2003-01-02 17:55:03 +000066035. (x+k).n = x.n + k
Tim Petersf3615152003-01-01 21:51:37 +00006604 Again follows from how arithmetic is defined.
6605
Tim Peters8bb5ad22003-01-24 02:44:45 +00006606Now we can explain tz.fromutc(x). Let's assume it's an interesting case
Tim Petersf3615152003-01-01 21:51:37 +00006607(meaning that the various tzinfo methods exist, and don't blow up or return
6608None when called).
6609
Tim Petersa9bc1682003-01-11 03:39:11 +00006610The function wants to return a datetime y with timezone tz, equivalent to x.
Tim Peters8bb5ad22003-01-24 02:44:45 +00006611x is already in UTC.
Tim Petersf3615152003-01-01 21:51:37 +00006612
6613By #3, we want
6614
Tim Peters8bb5ad22003-01-24 02:44:45 +00006615 y.n - y.o = x.n [1]
Tim Petersf3615152003-01-01 21:51:37 +00006616
6617The algorithm starts by attaching tz to x.n, and calling that y. So
6618x.n = y.n at the start. Then it wants to add a duration k to y, so that [1]
6619becomes true; in effect, we want to solve [2] for k:
6620
Tim Peters8bb5ad22003-01-24 02:44:45 +00006621 (y+k).n - (y+k).o = x.n [2]
Tim Petersf3615152003-01-01 21:51:37 +00006622
6623By #1, this is the same as
6624
Tim Peters8bb5ad22003-01-24 02:44:45 +00006625 (y+k).n - ((y+k).s + (y+k).d) = x.n [3]
Tim Petersf3615152003-01-01 21:51:37 +00006626
6627By #5, (y+k).n = y.n + k, which equals x.n + k because x.n=y.n at the start.
6628Substituting that into [3],
6629
Tim Peters8bb5ad22003-01-24 02:44:45 +00006630 x.n + k - (y+k).s - (y+k).d = x.n; the x.n terms cancel, leaving
6631 k - (y+k).s - (y+k).d = 0; rearranging,
6632 k = (y+k).s - (y+k).d; by #4, (y+k).s == y.s, so
6633 k = y.s - (y+k).d
Tim Petersf3615152003-01-01 21:51:37 +00006634
Tim Peters8bb5ad22003-01-24 02:44:45 +00006635On the RHS, (y+k).d can't be computed directly, but y.s can be, and we
6636approximate k by ignoring the (y+k).d term at first. Note that k can't be
6637very large, since all offset-returning methods return a duration of magnitude
6638less than 24 hours. For that reason, if y is firmly in std time, (y+k).d must
6639be 0, so ignoring it has no consequence then.
Tim Petersf3615152003-01-01 21:51:37 +00006640
6641In any case, the new value is
6642
Tim Peters8bb5ad22003-01-24 02:44:45 +00006643 z = y + y.s [4]
Tim Petersf3615152003-01-01 21:51:37 +00006644
Tim Peters8bb5ad22003-01-24 02:44:45 +00006645It's helpful to step back at look at [4] from a higher level: it's simply
6646mapping from UTC to tz's standard time.
Tim Petersc5dc4da2003-01-02 17:55:03 +00006647
6648At this point, if
6649
Tim Peters8bb5ad22003-01-24 02:44:45 +00006650 z.n - z.o = x.n [5]
Tim Petersc5dc4da2003-01-02 17:55:03 +00006651
6652we have an equivalent time, and are almost done. The insecurity here is
Tim Petersf3615152003-01-01 21:51:37 +00006653at the start of daylight time. Picture US Eastern for concreteness. The wall
6654time 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 +00006655sense then. The docs ask that an Eastern tzinfo class consider such a time to
6656be EDT (because it's "after 2"), which is a redundant spelling of 1:MM EST
6657on the day DST starts. We want to return the 1:MM EST spelling because that's
Tim Petersf3615152003-01-01 21:51:37 +00006658the only spelling that makes sense on the local wall clock.
6659
Tim Petersc5dc4da2003-01-02 17:55:03 +00006660In fact, if [5] holds at this point, we do have the standard-time spelling,
6661but that takes a bit of proof. We first prove a stronger result. What's the
6662difference between the LHS and RHS of [5]? Let
Tim Petersf3615152003-01-01 21:51:37 +00006663
Tim Peters8bb5ad22003-01-24 02:44:45 +00006664 diff = x.n - (z.n - z.o) [6]
Tim Petersf3615152003-01-01 21:51:37 +00006665
Tim Petersc5dc4da2003-01-02 17:55:03 +00006666Now
6667 z.n = by [4]
Tim Peters8bb5ad22003-01-24 02:44:45 +00006668 (y + y.s).n = by #5
6669 y.n + y.s = since y.n = x.n
6670 x.n + y.s = since z and y are have the same tzinfo member,
6671 y.s = z.s by #2
6672 x.n + z.s
Tim Petersf3615152003-01-01 21:51:37 +00006673
Tim Petersc5dc4da2003-01-02 17:55:03 +00006674Plugging that back into [6] gives
Tim Petersf3615152003-01-01 21:51:37 +00006675
Tim Petersc5dc4da2003-01-02 17:55:03 +00006676 diff =
Tim Peters8bb5ad22003-01-24 02:44:45 +00006677 x.n - ((x.n + z.s) - z.o) = expanding
6678 x.n - x.n - z.s + z.o = cancelling
6679 - z.s + z.o = by #2
Tim Petersc5dc4da2003-01-02 17:55:03 +00006680 z.d
Tim Petersf3615152003-01-01 21:51:37 +00006681
Tim Petersc5dc4da2003-01-02 17:55:03 +00006682So diff = z.d.
Tim Petersf3615152003-01-01 21:51:37 +00006683
Tim Petersc5dc4da2003-01-02 17:55:03 +00006684If [5] is true now, diff = 0, so z.d = 0 too, and we have the standard-time
Tim Peters8bb5ad22003-01-24 02:44:45 +00006685spelling we wanted in the endcase described above. We're done. Contrarily,
6686if z.d = 0, then we have a UTC equivalent, and are also done.
Tim Petersf3615152003-01-01 21:51:37 +00006687
Tim Petersc5dc4da2003-01-02 17:55:03 +00006688If [5] is not true now, diff = z.d != 0, and z.d is the offset we need to
6689add to z (in effect, z is in tz's standard time, and we need to shift the
Tim Peters8bb5ad22003-01-24 02:44:45 +00006690local clock into tz's daylight time).
Tim Petersf3615152003-01-01 21:51:37 +00006691
Tim Petersc5dc4da2003-01-02 17:55:03 +00006692Let
Tim Petersf3615152003-01-01 21:51:37 +00006693
Tim Peters4fede1a2003-01-04 00:26:59 +00006694 z' = z + z.d = z + diff [7]
Tim Petersc3bb26a2003-01-02 03:14:59 +00006695
Tim Peters4fede1a2003-01-04 00:26:59 +00006696and we can again ask whether
Tim Petersc3bb26a2003-01-02 03:14:59 +00006697
Tim Peters8bb5ad22003-01-24 02:44:45 +00006698 z'.n - z'.o = x.n [8]
Tim Petersc3bb26a2003-01-02 03:14:59 +00006699
Tim Peters8bb5ad22003-01-24 02:44:45 +00006700If so, we're done. If not, the tzinfo class is insane, according to the
6701assumptions we've made. This also requires a bit of proof. As before, let's
6702compute the difference between the LHS and RHS of [8] (and skipping some of
6703the justifications for the kinds of substitutions we've done several times
6704already):
Tim Peters4fede1a2003-01-04 00:26:59 +00006705
Tim Peters8bb5ad22003-01-24 02:44:45 +00006706 diff' = x.n - (z'.n - z'.o) = replacing z'.n via [7]
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00006707 x.n - (z.n + diff - z'.o) = replacing diff via [6]
6708 x.n - (z.n + x.n - (z.n - z.o) - z'.o) =
6709 x.n - z.n - x.n + z.n - z.o + z'.o = cancel x.n
6710 - z.n + z.n - z.o + z'.o = cancel z.n
6711 - z.o + z'.o = #1 twice
6712 -z.s - z.d + z'.s + z'.d = z and z' have same tzinfo
6713 z'.d - z.d
Tim Peters4fede1a2003-01-04 00:26:59 +00006714
6715So 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 +00006716we've found the UTC-equivalent so are done. In fact, we stop with [7] and
6717return z', not bothering to compute z'.d.
Tim Peters4fede1a2003-01-04 00:26:59 +00006718
Tim Peters8bb5ad22003-01-24 02:44:45 +00006719How could z.d and z'd differ? z' = z + z.d [7], so merely moving z' by
6720a dst() offset, and starting *from* a time already in DST (we know z.d != 0),
6721would have to change the result dst() returns: we start in DST, and moving
6722a little further into it takes us out of DST.
Tim Peters4fede1a2003-01-04 00:26:59 +00006723
Tim Peters8bb5ad22003-01-24 02:44:45 +00006724There isn't a sane case where this can happen. The closest it gets is at
6725the end of DST, where there's an hour in UTC with no spelling in a hybrid
6726tzinfo class. In US Eastern, that's 5:MM UTC = 0:MM EST = 1:MM EDT. During
6727that hour, on an Eastern clock 1:MM is taken as being in standard time (6:MM
6728UTC) because the docs insist on that, but 0:MM is taken as being in daylight
6729time (4:MM UTC). There is no local time mapping to 5:MM UTC. The local
6730clock jumps from 1:59 back to 1:00 again, and repeats the 1:MM hour in
6731standard time. Since that's what the local clock *does*, we want to map both
6732UTC hours 5:MM and 6:MM to 1:MM Eastern. The result is ambiguous
Tim Peters4fede1a2003-01-04 00:26:59 +00006733in local time, but so it goes -- it's the way the local clock works.
6734
Tim Peters8bb5ad22003-01-24 02:44:45 +00006735When x = 5:MM UTC is the input to this algorithm, x.o=0, y.o=-5 and y.d=0,
6736so z=0:MM. z.d=60 (minutes) then, so [5] doesn't hold and we keep going.
6737z' = 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 +00006738(correctly) concludes that z' is not UTC-equivalent to x.
6739
6740Because we know z.d said z was in daylight time (else [5] would have held and
6741we would have stopped then), and we know z.d != z'.d (else [8] would have held
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00006742and we would have stopped then), and there are only 2 possible values dst() can
Tim Peters4fede1a2003-01-04 00:26:59 +00006743return in Eastern, it follows that z'.d must be 0 (which it is in the example,
6744but the reasoning doesn't depend on the example -- it depends on there being
6745two possible dst() outcomes, one zero and the other non-zero). Therefore
Tim Peters8bb5ad22003-01-24 02:44:45 +00006746z' must be in standard time, and is the spelling we want in this case.
6747
6748Note again that z' is not UTC-equivalent as far as the hybrid tzinfo class is
6749concerned (because it takes z' as being in standard time rather than the
6750daylight time we intend here), but returning it gives the real-life "local
6751clock repeats an hour" behavior when mapping the "unspellable" UTC hour into
6752tz.
6753
6754When the input is 6:MM, z=1:MM and z.d=0, and we stop at once, again with
6755the 1:MM standard time spelling we want.
6756
6757So how can this break? One of the assumptions must be violated. Two
6758possibilities:
6759
67601) [2] effectively says that y.s is invariant across all y belong to a given
6761 time zone. This isn't true if, for political reasons or continental drift,
6762 a region decides to change its base offset from UTC.
6763
67642) There may be versions of "double daylight" time where the tail end of
6765 the analysis gives up a step too early. I haven't thought about that
6766 enough to say.
6767
6768In any case, it's clear that the default fromutc() is strong enough to handle
6769"almost all" time zones: so long as the standard offset is invariant, it
6770doesn't matter if daylight time transition points change from year to year, or
6771if daylight time is skipped in some years; it doesn't matter how large or
6772small dst() may get within its bounds; and it doesn't even matter if some
6773perverse time zone returns a negative dst()). So a breaking case must be
6774pretty bizarre, and a tzinfo subclass can override fromutc() if it is.
Tim Petersf3615152003-01-01 21:51:37 +00006775--------------------------------------------------------------------------- */