Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
allendowney
GitHub Repository: allendowney/cpython
Path: blob/main/Include/datetime.h
12 views
1
/* datetime.h
2
*/
3
#ifndef Py_LIMITED_API
4
#ifndef DATETIME_H
5
#define DATETIME_H
6
#ifdef __cplusplus
7
extern "C" {
8
#endif
9
10
/* Fields are packed into successive bytes, each viewed as unsigned and
11
* big-endian, unless otherwise noted:
12
*
13
* byte offset
14
* 0 year 2 bytes, 1-9999
15
* 2 month 1 byte, 1-12
16
* 3 day 1 byte, 1-31
17
* 4 hour 1 byte, 0-23
18
* 5 minute 1 byte, 0-59
19
* 6 second 1 byte, 0-59
20
* 7 usecond 3 bytes, 0-999999
21
* 10
22
*/
23
24
/* # of bytes for year, month, and day. */
25
#define _PyDateTime_DATE_DATASIZE 4
26
27
/* # of bytes for hour, minute, second, and usecond. */
28
#define _PyDateTime_TIME_DATASIZE 6
29
30
/* # of bytes for year, month, day, hour, minute, second, and usecond. */
31
#define _PyDateTime_DATETIME_DATASIZE 10
32
33
34
typedef struct
35
{
36
PyObject_HEAD
37
Py_hash_t hashcode; /* -1 when unknown */
38
int days; /* -MAX_DELTA_DAYS <= days <= MAX_DELTA_DAYS */
39
int seconds; /* 0 <= seconds < 24*3600 is invariant */
40
int microseconds; /* 0 <= microseconds < 1000000 is invariant */
41
} PyDateTime_Delta;
42
43
typedef struct
44
{
45
PyObject_HEAD /* a pure abstract base class */
46
} PyDateTime_TZInfo;
47
48
49
/* The datetime and time types have hashcodes, and an optional tzinfo member,
50
* present if and only if hastzinfo is true.
51
*/
52
#define _PyTZINFO_HEAD \
53
PyObject_HEAD \
54
Py_hash_t hashcode; \
55
char hastzinfo; /* boolean flag */
56
57
/* No _PyDateTime_BaseTZInfo is allocated; it's just to have something
58
* convenient to cast to, when getting at the hastzinfo member of objects
59
* starting with _PyTZINFO_HEAD.
60
*/
61
typedef struct
62
{
63
_PyTZINFO_HEAD
64
} _PyDateTime_BaseTZInfo;
65
66
/* All time objects are of PyDateTime_TimeType, but that can be allocated
67
* in two ways, with or without a tzinfo member. Without is the same as
68
* tzinfo == None, but consumes less memory. _PyDateTime_BaseTime is an
69
* internal struct used to allocate the right amount of space for the
70
* "without" case.
71
*/
72
#define _PyDateTime_TIMEHEAD \
73
_PyTZINFO_HEAD \
74
unsigned char data[_PyDateTime_TIME_DATASIZE];
75
76
typedef struct
77
{
78
_PyDateTime_TIMEHEAD
79
} _PyDateTime_BaseTime; /* hastzinfo false */
80
81
typedef struct
82
{
83
_PyDateTime_TIMEHEAD
84
unsigned char fold;
85
PyObject *tzinfo;
86
} PyDateTime_Time; /* hastzinfo true */
87
88
89
/* All datetime objects are of PyDateTime_DateTimeType, but that can be
90
* allocated in two ways too, just like for time objects above. In addition,
91
* the plain date type is a base class for datetime, so it must also have
92
* a hastzinfo member (although it's unused there).
93
*/
94
typedef struct
95
{
96
_PyTZINFO_HEAD
97
unsigned char data[_PyDateTime_DATE_DATASIZE];
98
} PyDateTime_Date;
99
100
#define _PyDateTime_DATETIMEHEAD \
101
_PyTZINFO_HEAD \
102
unsigned char data[_PyDateTime_DATETIME_DATASIZE];
103
104
typedef struct
105
{
106
_PyDateTime_DATETIMEHEAD
107
} _PyDateTime_BaseDateTime; /* hastzinfo false */
108
109
typedef struct
110
{
111
_PyDateTime_DATETIMEHEAD
112
unsigned char fold;
113
PyObject *tzinfo;
114
} PyDateTime_DateTime; /* hastzinfo true */
115
116
117
/* Apply for date and datetime instances. */
118
119
// o is a pointer to a time or a datetime object.
120
#define _PyDateTime_HAS_TZINFO(o) (((_PyDateTime_BaseTZInfo *)(o))->hastzinfo)
121
122
#define PyDateTime_GET_YEAR(o) ((((PyDateTime_Date*)(o))->data[0] << 8) | \
123
((PyDateTime_Date*)(o))->data[1])
124
#define PyDateTime_GET_MONTH(o) (((PyDateTime_Date*)(o))->data[2])
125
#define PyDateTime_GET_DAY(o) (((PyDateTime_Date*)(o))->data[3])
126
127
#define PyDateTime_DATE_GET_HOUR(o) (((PyDateTime_DateTime*)(o))->data[4])
128
#define PyDateTime_DATE_GET_MINUTE(o) (((PyDateTime_DateTime*)(o))->data[5])
129
#define PyDateTime_DATE_GET_SECOND(o) (((PyDateTime_DateTime*)(o))->data[6])
130
#define PyDateTime_DATE_GET_MICROSECOND(o) \
131
((((PyDateTime_DateTime*)(o))->data[7] << 16) | \
132
(((PyDateTime_DateTime*)(o))->data[8] << 8) | \
133
((PyDateTime_DateTime*)(o))->data[9])
134
#define PyDateTime_DATE_GET_FOLD(o) (((PyDateTime_DateTime*)(o))->fold)
135
#define PyDateTime_DATE_GET_TZINFO(o) (_PyDateTime_HAS_TZINFO((o)) ? \
136
((PyDateTime_DateTime *)(o))->tzinfo : Py_None)
137
138
/* Apply for time instances. */
139
#define PyDateTime_TIME_GET_HOUR(o) (((PyDateTime_Time*)(o))->data[0])
140
#define PyDateTime_TIME_GET_MINUTE(o) (((PyDateTime_Time*)(o))->data[1])
141
#define PyDateTime_TIME_GET_SECOND(o) (((PyDateTime_Time*)(o))->data[2])
142
#define PyDateTime_TIME_GET_MICROSECOND(o) \
143
((((PyDateTime_Time*)(o))->data[3] << 16) | \
144
(((PyDateTime_Time*)(o))->data[4] << 8) | \
145
((PyDateTime_Time*)(o))->data[5])
146
#define PyDateTime_TIME_GET_FOLD(o) (((PyDateTime_Time*)(o))->fold)
147
#define PyDateTime_TIME_GET_TZINFO(o) (_PyDateTime_HAS_TZINFO(o) ? \
148
((PyDateTime_Time *)(o))->tzinfo : Py_None)
149
150
/* Apply for time delta instances */
151
#define PyDateTime_DELTA_GET_DAYS(o) (((PyDateTime_Delta*)(o))->days)
152
#define PyDateTime_DELTA_GET_SECONDS(o) (((PyDateTime_Delta*)(o))->seconds)
153
#define PyDateTime_DELTA_GET_MICROSECONDS(o) \
154
(((PyDateTime_Delta*)(o))->microseconds)
155
156
157
/* Define structure for C API. */
158
typedef struct {
159
/* type objects */
160
PyTypeObject *DateType;
161
PyTypeObject *DateTimeType;
162
PyTypeObject *TimeType;
163
PyTypeObject *DeltaType;
164
PyTypeObject *TZInfoType;
165
166
/* singletons */
167
PyObject *TimeZone_UTC;
168
169
/* constructors */
170
PyObject *(*Date_FromDate)(int, int, int, PyTypeObject*);
171
PyObject *(*DateTime_FromDateAndTime)(int, int, int, int, int, int, int,
172
PyObject*, PyTypeObject*);
173
PyObject *(*Time_FromTime)(int, int, int, int, PyObject*, PyTypeObject*);
174
PyObject *(*Delta_FromDelta)(int, int, int, int, PyTypeObject*);
175
PyObject *(*TimeZone_FromTimeZone)(PyObject *offset, PyObject *name);
176
177
/* constructors for the DB API */
178
PyObject *(*DateTime_FromTimestamp)(PyObject*, PyObject*, PyObject*);
179
PyObject *(*Date_FromTimestamp)(PyObject*, PyObject*);
180
181
/* PEP 495 constructors */
182
PyObject *(*DateTime_FromDateAndTimeAndFold)(int, int, int, int, int, int, int,
183
PyObject*, int, PyTypeObject*);
184
PyObject *(*Time_FromTimeAndFold)(int, int, int, int, PyObject*, int, PyTypeObject*);
185
186
} PyDateTime_CAPI;
187
188
#define PyDateTime_CAPSULE_NAME "datetime.datetime_CAPI"
189
190
191
/* This block is only used as part of the public API and should not be
192
* included in _datetimemodule.c, which does not use the C API capsule.
193
* See bpo-35081 for more details.
194
* */
195
#ifndef _PY_DATETIME_IMPL
196
/* Define global variable for the C API and a macro for setting it. */
197
static PyDateTime_CAPI *PyDateTimeAPI = NULL;
198
199
#define PyDateTime_IMPORT \
200
PyDateTimeAPI = (PyDateTime_CAPI *)PyCapsule_Import(PyDateTime_CAPSULE_NAME, 0)
201
202
/* Macro for access to the UTC singleton */
203
#define PyDateTime_TimeZone_UTC PyDateTimeAPI->TimeZone_UTC
204
205
/* Macros for type checking when not building the Python core. */
206
#define PyDate_Check(op) PyObject_TypeCheck((op), PyDateTimeAPI->DateType)
207
#define PyDate_CheckExact(op) Py_IS_TYPE((op), PyDateTimeAPI->DateType)
208
209
#define PyDateTime_Check(op) PyObject_TypeCheck((op), PyDateTimeAPI->DateTimeType)
210
#define PyDateTime_CheckExact(op) Py_IS_TYPE((op), PyDateTimeAPI->DateTimeType)
211
212
#define PyTime_Check(op) PyObject_TypeCheck((op), PyDateTimeAPI->TimeType)
213
#define PyTime_CheckExact(op) Py_IS_TYPE((op), PyDateTimeAPI->TimeType)
214
215
#define PyDelta_Check(op) PyObject_TypeCheck((op), PyDateTimeAPI->DeltaType)
216
#define PyDelta_CheckExact(op) Py_IS_TYPE((op), PyDateTimeAPI->DeltaType)
217
218
#define PyTZInfo_Check(op) PyObject_TypeCheck((op), PyDateTimeAPI->TZInfoType)
219
#define PyTZInfo_CheckExact(op) Py_IS_TYPE((op), PyDateTimeAPI->TZInfoType)
220
221
222
/* Macros for accessing constructors in a simplified fashion. */
223
#define PyDate_FromDate(year, month, day) \
224
PyDateTimeAPI->Date_FromDate((year), (month), (day), PyDateTimeAPI->DateType)
225
226
#define PyDateTime_FromDateAndTime(year, month, day, hour, min, sec, usec) \
227
PyDateTimeAPI->DateTime_FromDateAndTime((year), (month), (day), (hour), \
228
(min), (sec), (usec), Py_None, PyDateTimeAPI->DateTimeType)
229
230
#define PyDateTime_FromDateAndTimeAndFold(year, month, day, hour, min, sec, usec, fold) \
231
PyDateTimeAPI->DateTime_FromDateAndTimeAndFold((year), (month), (day), (hour), \
232
(min), (sec), (usec), Py_None, (fold), PyDateTimeAPI->DateTimeType)
233
234
#define PyTime_FromTime(hour, minute, second, usecond) \
235
PyDateTimeAPI->Time_FromTime((hour), (minute), (second), (usecond), \
236
Py_None, PyDateTimeAPI->TimeType)
237
238
#define PyTime_FromTimeAndFold(hour, minute, second, usecond, fold) \
239
PyDateTimeAPI->Time_FromTimeAndFold((hour), (minute), (second), (usecond), \
240
Py_None, (fold), PyDateTimeAPI->TimeType)
241
242
#define PyDelta_FromDSU(days, seconds, useconds) \
243
PyDateTimeAPI->Delta_FromDelta((days), (seconds), (useconds), 1, \
244
PyDateTimeAPI->DeltaType)
245
246
#define PyTimeZone_FromOffset(offset) \
247
PyDateTimeAPI->TimeZone_FromTimeZone((offset), NULL)
248
249
#define PyTimeZone_FromOffsetAndName(offset, name) \
250
PyDateTimeAPI->TimeZone_FromTimeZone((offset), (name))
251
252
/* Macros supporting the DB API. */
253
#define PyDateTime_FromTimestamp(args) \
254
PyDateTimeAPI->DateTime_FromTimestamp( \
255
(PyObject*) (PyDateTimeAPI->DateTimeType), (args), NULL)
256
257
#define PyDate_FromTimestamp(args) \
258
PyDateTimeAPI->Date_FromTimestamp( \
259
(PyObject*) (PyDateTimeAPI->DateType), (args))
260
261
#endif /* !defined(_PY_DATETIME_IMPL) */
262
263
#ifdef __cplusplus
264
}
265
#endif
266
#endif
267
#endif /* !Py_LIMITED_API */
268
269