FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
cpython/Include/pytime.h at pythoncapi · pythoncapi/cpython · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
pythoncapi
/
cpython
Public
forked from
python/cpython
Notifications
You must be signed in to change notification settings
Fork
0
Star
1
Code
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
cpython
/
Include
/
pytime.h
Copy path
More file actions
More file actions
Latest commit
History
History
History
246 lines (197 loc) · 8.72 KB
Breadcrumbs
cpython
/
Include
/
pytime.h
Copy path
File metadata and controls
246 lines (197 loc) · 8.72 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
#ifndef
Py_LIMITED_API
#ifndef
Py_PYTIME_H
#define
Py_PYTIME_H
#include
"pyconfig.h"
/* include for defines */
#include
"object.h"
/**************************************************************************
Symbols and macros to supply platform-independent interfaces to time related
functions and constants
**************************************************************************/
#ifdef
__cplusplus
extern
"C"
{
#endif
/* _PyTime_t: Python timestamp with subsecond precision. It can be used to
store a duration, and so indirectly a date (related to another date, like
UNIX epoch). */
typedef
int64_t
_PyTime_t
;
#define
_PyTime_MIN
PY_LLONG_MIN
#define
_PyTime_MAX
PY_LLONG_MAX
typedef
enum
{
/* Round towards minus infinity (-inf).
For example, used to read a clock. */
_PyTime_ROUND_FLOOR
=
0
,
/* Round towards infinity (+inf).
For example, used for timeout to wait "at least" N seconds. */
_PyTime_ROUND_CEILING
=
1
,
/* Round to nearest with ties going to nearest even integer.
For example, used to round from a Python float. */
_PyTime_ROUND_HALF_EVEN
=
2
,
/* Round away from zero
For example, used for timeout. _PyTime_ROUND_CEILING rounds
-1e-9 to 0 milliseconds which causes bpo-31786 issue.
_PyTime_ROUND_UP rounds -1e-9 to -1 millisecond which keeps
the timeout sign as expected. select.poll(timeout) must block
for negative values." */
_PyTime_ROUND_UP
=
3
,
/* _PyTime_ROUND_TIMEOUT (an alias for _PyTime_ROUND_UP) should be
used for timeouts. */
_PyTime_ROUND_TIMEOUT
=
_PyTime_ROUND_UP
}
_PyTime_round_t
;
/* Convert a time_t to a PyLong. */
PyAPI_FUNC
(
PyObject
*
)
_PyLong_FromTime_t
(
time_t
sec
);
/* Convert a PyLong to a time_t. */
PyAPI_FUNC
(
time_t
)
_PyLong_AsTime_t
(
PyObject
*
obj
);
/* Convert a number of seconds, int or float, to time_t. */
PyAPI_FUNC
(
int
)
_PyTime_ObjectToTime_t
(
PyObject
*
obj
,
time_t
*
sec
,
_PyTime_round_t
);
/* Convert a number of seconds, int or float, to a timeval structure.
usec is in the range [0; 999999] and rounded towards zero.
For example, -1.2 is converted to (-2, 800000). */
PyAPI_FUNC
(
int
)
_PyTime_ObjectToTimeval
(
PyObject
*
obj
,
time_t
*
sec
,
long
*
usec
,
_PyTime_round_t
);
/* Convert a number of seconds, int or float, to a timespec structure.
nsec is in the range [0; 999999999] and rounded towards zero.
For example, -1.2 is converted to (-2, 800000000). */
PyAPI_FUNC
(
int
)
_PyTime_ObjectToTimespec
(
PyObject
*
obj
,
time_t
*
sec
,
long
*
nsec
,
_PyTime_round_t
);
/* Create a timestamp from a number of seconds. */
PyAPI_FUNC
(
_PyTime_t
)
_PyTime_FromSeconds
(
int
seconds
);
/* Macro to create a timestamp from a number of seconds, no integer overflow.
Only use the macro for small values, prefer _PyTime_FromSeconds(). */
#define
_PYTIME_FROMSECONDS
(
seconds
) \
((_PyTime_t)(seconds) * (1000 * 1000 * 1000))
/* Create a timestamp from a number of nanoseconds. */
PyAPI_FUNC
(
_PyTime_t
)
_PyTime_FromNanoseconds
(
_PyTime_t
ns
);
/* Create a timestamp from nanoseconds (Python int). */
PyAPI_FUNC
(
int
)
_PyTime_FromNanosecondsObject
(
_PyTime_t
*
t
,
PyObject
*
obj
);
/* Convert a number of seconds (Python float or int) to a timetamp.
Raise an exception and return -1 on error, return 0 on success. */
PyAPI_FUNC
(
int
)
_PyTime_FromSecondsObject
(
_PyTime_t
*
t
,
PyObject
*
obj
,
_PyTime_round_t
round
);
/* Convert a number of milliseconds (Python float or int, 10^-3) to a timetamp.
Raise an exception and return -1 on error, return 0 on success. */
PyAPI_FUNC
(
int
)
_PyTime_FromMillisecondsObject
(
_PyTime_t
*
t
,
PyObject
*
obj
,
_PyTime_round_t
round
);
/* Convert a timestamp to a number of seconds as a C double. */
PyAPI_FUNC
(
double
)
_PyTime_AsSecondsDouble
(
_PyTime_t
t
);
/* Convert timestamp to a number of milliseconds (10^-3 seconds). */
PyAPI_FUNC
(
_PyTime_t
)
_PyTime_AsMilliseconds
(
_PyTime_t
t
,
_PyTime_round_t
round
);
/* Convert timestamp to a number of microseconds (10^-6 seconds). */
PyAPI_FUNC
(
_PyTime_t
)
_PyTime_AsMicroseconds
(
_PyTime_t
t
,
_PyTime_round_t
round
);
/* Convert timestamp to a number of nanoseconds (10^-9 seconds) as a Python int
object. */
PyAPI_FUNC
(
PyObject
*
)
_PyTime_AsNanosecondsObject
(
_PyTime_t
t
);
/* Create a timestamp from a timeval structure.
Raise an exception and return -1 on overflow, return 0 on success. */
PyAPI_FUNC
(
int
)
_PyTime_FromTimeval
(
_PyTime_t
*
tp
,
struct
timeval
*
tv
);
/* Convert a timestamp to a timeval structure (microsecond resolution).
tv_usec is always positive.
Raise an exception and return -1 if the conversion overflowed,
return 0 on success. */
PyAPI_FUNC
(
int
)
_PyTime_AsTimeval
(
_PyTime_t
t
,
struct
timeval
*
tv
,
_PyTime_round_t
round
);
/* Similar to _PyTime_AsTimeval(), but don't raise an exception on error. */
PyAPI_FUNC
(
int
)
_PyTime_AsTimeval_noraise
(
_PyTime_t
t
,
struct
timeval
*
tv
,
_PyTime_round_t
round
);
/* Convert a timestamp to a number of seconds (secs) and microseconds (us).
us is always positive. This function is similar to _PyTime_AsTimeval()
except that secs is always a time_t type, whereas the timeval structure
uses a C long for tv_sec on Windows.
Raise an exception and return -1 if the conversion overflowed,
return 0 on success. */
PyAPI_FUNC
(
int
)
_PyTime_AsTimevalTime_t
(
_PyTime_t
t
,
time_t
*
secs
,
int
*
us
,
_PyTime_round_t
round
);
#if
defined(
HAVE_CLOCK_GETTIME
)
||
defined(
HAVE_KQUEUE
)
/* Create a timestamp from a timespec structure.
Raise an exception and return -1 on overflow, return 0 on success. */
PyAPI_FUNC
(
int
)
_PyTime_FromTimespec
(
_PyTime_t
*
tp
,
struct
timespec
*
ts
);
/* Convert a timestamp to a timespec structure (nanosecond resolution).
tv_nsec is always positive.
Raise an exception and return -1 on error, return 0 on success. */
PyAPI_FUNC
(
int
)
_PyTime_AsTimespec
(
_PyTime_t
t
,
struct
timespec
*
ts
);
#endif
/* Compute ticks * mul / div.
The caller must ensure that ((div - 1) * mul) cannot overflow. */
PyAPI_FUNC
(
_PyTime_t
)
_PyTime_MulDiv
(
_PyTime_t
ticks
,
_PyTime_t
mul
,
_PyTime_t
div
);
/* Get the current time from the system clock.
The function cannot fail. _PyTime_Init() ensures that the system clock
works. */
PyAPI_FUNC
(
_PyTime_t
)
_PyTime_GetSystemClock
(
void
);
/* Get the time of a monotonic clock, i.e. a clock that cannot go backwards.
The clock is not affected by system clock updates. The reference point of
the returned value is undefined, so that only the difference between the
results of consecutive calls is valid.
The function cannot fail. _PyTime_Init() ensures that a monotonic clock
is available and works. */
PyAPI_FUNC
(
_PyTime_t
)
_PyTime_GetMonotonicClock
(
void
);
/* Structure used by time.get_clock_info() */
typedef
struct
{
const
char
*
implementation
;
int
monotonic
;
int
adjustable
;
double
resolution
;
}
_Py_clock_info_t
;
/* Get the current time from the system clock.
* Fill clock information if info is not NULL.
* Raise an exception and return -1 on error, return 0 on success.
*/
PyAPI_FUNC
(
int
)
_PyTime_GetSystemClockWithInfo
(
_PyTime_t
*
t
,
_Py_clock_info_t
*
info
);
/* Get the time of a monotonic clock, i.e. a clock that cannot go backwards.
The clock is not affected by system clock updates. The reference point of
the returned value is undefined, so that only the difference between the
results of consecutive calls is valid.
Fill info (if set) with information of the function used to get the time.
Return 0 on success, raise an exception and return -1 on error. */
PyAPI_FUNC
(
int
)
_PyTime_GetMonotonicClockWithInfo
(
_PyTime_t
*
t
,
_Py_clock_info_t
*
info
);
/* Initialize time.
Return 0 on success, raise an exception and return -1 on error. */
PyAPI_FUNC
(
int
)
_PyTime_Init
(
void
);
/* Converts a timestamp to the Gregorian time, using the local time zone.
Return 0 on success, raise an exception and return -1 on error. */
PyAPI_FUNC
(
int
)
_PyTime_localtime
(
time_t
t
,
struct
tm
*
tm
);
/* Converts a timestamp to the Gregorian time, assuming UTC.
Return 0 on success, raise an exception and return -1 on error. */
PyAPI_FUNC
(
int
)
_PyTime_gmtime
(
time_t
t
,
struct
tm
*
tm
);
/* Get the performance counter: clock with the highest available resolution to
measure a short duration.
The function cannot fail. _PyTime_Init() ensures that the system clock
works. */
PyAPI_FUNC
(
_PyTime_t
)
_PyTime_GetPerfCounter
(
void
);
/* Get the performance counter: clock with the highest available resolution to
measure a short duration.
Fill info (if set) with information of the function used to get the time.
Return 0 on success, raise an exception and return -1 on error. */
PyAPI_FUNC
(
int
)
_PyTime_GetPerfCounterWithInfo
(
_PyTime_t
*
t
,
_Py_clock_info_t
*
info
);
#ifdef
__cplusplus
}
#endif
#endif
/* Py_PYTIME_H */
#endif
/* Py_LIMITED_API */
Back
|
FazBrowse Home
|
New Git URL