blob: 3d335c88674fb99db05df669f47d9e4f88843f65 [file] [log] [blame]
Georg Brandl116aa622007-08-15 14:28:22 +00001:mod:`time` --- Time access and conversions
2===========================================
3
4.. module:: time
5 :synopsis: Time access and conversions.
6
7
8This module provides various time-related functions. For related
9functionality, see also the :mod:`datetime` and :mod:`calendar` modules.
10
11Although this module is always available,
12not all functions are available on all platforms. Most of the functions
13defined in this module call platform C library functions with the same name. It
14may sometimes be helpful to consult the platform documentation, because the
15semantics of these functions varies among platforms.
16
17An explanation of some terminology and conventions is in order.
18
Georg Brandlb67878a2010-10-15 17:01:15 +000019.. index:: single: epoch
Georg Brandl116aa622007-08-15 14:28:22 +000020
21* The :dfn:`epoch` is the point where the time starts. On January 1st of that
22 year, at 0 hours, the "time since the epoch" is zero. For Unix, the epoch is
23 1970. To find out what the epoch is, look at ``gmtime(0)``.
24
Georg Brandlb67878a2010-10-15 17:01:15 +000025.. index:: single: Year 2038
Georg Brandl116aa622007-08-15 14:28:22 +000026
Alexander Belopolskyc64708a2011-01-07 19:59:19 +000027* The functions in this module may not handle dates and times before the epoch or
Georg Brandl116aa622007-08-15 14:28:22 +000028 far in the future. The cut-off point in the future is determined by the C
Alexander Belopolskyc64708a2011-01-07 19:59:19 +000029 library; for 32-bit systems, it is typically in 2038.
Georg Brandl116aa622007-08-15 14:28:22 +000030
Georg Brandlb67878a2010-10-15 17:01:15 +000031.. index::
32 single: Year 2000
33 single: Y2K
34
35.. _time-y2kissues:
Georg Brandl116aa622007-08-15 14:28:22 +000036
Alexander Belopolskyc64708a2011-01-07 19:59:19 +000037* **Year 2000 (Y2K) issues**: Python depends on the platform's C library, which
Georg Brandl116aa622007-08-15 14:28:22 +000038 generally doesn't have year 2000 issues, since all dates and times are
Alexander Belopolskyc64708a2011-01-07 19:59:19 +000039 represented internally as seconds since the epoch. Function :func:`strptime`
40 can parse 2-digit years when given ``%y`` format code. When 2-digit years are
41 parsed, they are converted according to the POSIX and ISO C standards: values
42 69--99 are mapped to 1969--1999, and values 0--68 are mapped to 2000--2068.
43
Georg Brandlb67878a2010-10-15 17:01:15 +000044.. index::
45 single: UTC
46 single: Coordinated Universal Time
47 single: Greenwich Mean Time
Georg Brandl116aa622007-08-15 14:28:22 +000048
49* UTC is Coordinated Universal Time (formerly known as Greenwich Mean Time, or
50 GMT). The acronym UTC is not a mistake but a compromise between English and
51 French.
52
Georg Brandlb67878a2010-10-15 17:01:15 +000053.. index:: single: Daylight Saving Time
Georg Brandl116aa622007-08-15 14:28:22 +000054
55* DST is Daylight Saving Time, an adjustment of the timezone by (usually) one
56 hour during part of the year. DST rules are magic (determined by local law) and
57 can change from year to year. The C library has a table containing the local
58 rules (often it is read from a system file for flexibility) and is the only
59 source of True Wisdom in this respect.
60
61* The precision of the various real-time functions may be less than suggested by
62 the units in which their value or argument is expressed. E.g. on most Unix
Georg Brandlc575c902008-09-13 17:46:05 +000063 systems, the clock "ticks" only 50 or 100 times a second.
Georg Brandl116aa622007-08-15 14:28:22 +000064
Petri Lehtinen1033b312012-05-18 21:19:17 +030065* On the other hand, the precision of :func:`.time` and :func:`sleep` is better
Georg Brandl116aa622007-08-15 14:28:22 +000066 than their Unix equivalents: times are expressed as floating point numbers,
Petri Lehtinen1033b312012-05-18 21:19:17 +030067 :func:`.time` returns the most accurate time available (using Unix
Georg Brandl60203b42010-10-06 10:11:56 +000068 :c:func:`gettimeofday` where available), and :func:`sleep` will accept a time
69 with a nonzero fraction (Unix :c:func:`select` is used to implement this, where
Georg Brandl116aa622007-08-15 14:28:22 +000070 available).
71
72* The time value as returned by :func:`gmtime`, :func:`localtime`, and
73 :func:`strptime`, and accepted by :func:`asctime`, :func:`mktime` and
74 :func:`strftime`, is a sequence of 9 integers. The return values of
75 :func:`gmtime`, :func:`localtime`, and :func:`strptime` also offer attribute
76 names for individual fields.
77
Georg Brandlb67878a2010-10-15 17:01:15 +000078 See :class:`struct_time` for a description of these objects.
Georg Brandl116aa622007-08-15 14:28:22 +000079
Alexander Belopolskyc142bba2012-06-13 22:15:26 -040080 .. versionchanged:: 3.3
Georg Brandl61063cc2012-06-24 22:48:30 +020081 The :class:`struct_time` type was extended to provide the :attr:`tm_gmtoff`
82 and :attr:`tm_zone` attributes when platform supports corresponding
83 ``struct tm`` members.
Alexander Belopolskyc142bba2012-06-13 22:15:26 -040084
Benjamin Petersone0124bd2009-03-09 21:04:33 +000085* Use the following functions to convert between time representations:
86
87 +-------------------------+-------------------------+-------------------------+
88 | From | To | Use |
89 +=========================+=========================+=========================+
90 | seconds since the epoch | :class:`struct_time` in | :func:`gmtime` |
91 | | UTC | |
92 +-------------------------+-------------------------+-------------------------+
93 | seconds since the epoch | :class:`struct_time` in | :func:`localtime` |
94 | | local time | |
95 +-------------------------+-------------------------+-------------------------+
96 | :class:`struct_time` in | seconds since the epoch | :func:`calendar.timegm` |
97 | UTC | | |
98 +-------------------------+-------------------------+-------------------------+
99 | :class:`struct_time` in | seconds since the epoch | :func:`mktime` |
100 | local time | | |
101 +-------------------------+-------------------------+-------------------------+
102
103
Georg Brandl116aa622007-08-15 14:28:22 +0000104The module defines the following functions and data items:
105
Georg Brandl116aa622007-08-15 14:28:22 +0000106.. data:: altzone
107
108 The offset of the local DST timezone, in seconds west of UTC, if one is defined.
109 This is negative if the local DST timezone is east of UTC (as in Western Europe,
110 including the UK). Only use this if ``daylight`` is nonzero.
111
112
113.. function:: asctime([t])
114
115 Convert a tuple or :class:`struct_time` representing a time as returned by
Alexander Belopolskyb9588b52011-01-04 16:34:30 +0000116 :func:`gmtime` or :func:`localtime` to a string of the following
Georg Brandl116aa622007-08-15 14:28:22 +0000117 form: ``'Sun Jun 20 23:21:05 1993'``. If *t* is not provided, the current time
118 as returned by :func:`localtime` is used. Locale information is not used by
119 :func:`asctime`.
120
121 .. note::
122
Georg Brandl538343d2012-02-02 22:22:19 +0100123 Unlike the C function of the same name, :func:`asctime` does not add a
124 trailing newline.
Georg Brandl116aa622007-08-15 14:28:22 +0000125
Georg Brandl116aa622007-08-15 14:28:22 +0000126
Victor Stinner4195b5c2012-02-08 23:03:19 +0100127.. function:: clock()
Georg Brandl116aa622007-08-15 14:28:22 +0000128
129 .. index::
130 single: CPU time
131 single: processor time
132 single: benchmarking
133
134 On Unix, return the current processor time as a floating point number expressed
135 in seconds. The precision, and in fact the very definition of the meaning of
Georg Brandl01546a82014-10-28 21:35:35 +0100136 "processor time", depends on that of the C function of the same name.
Georg Brandl116aa622007-08-15 14:28:22 +0000137
138 On Windows, this function returns wall-clock seconds elapsed since the first
139 call to this function, as a floating point number, based on the Win32 function
Georg Brandl60203b42010-10-06 10:11:56 +0000140 :c:func:`QueryPerformanceCounter`. The resolution is typically better than one
Georg Brandl116aa622007-08-15 14:28:22 +0000141 microsecond.
142
Victor Stinner47620a62012-04-29 02:52:39 +0200143 .. deprecated:: 3.3
144 The behaviour of this function depends on the platform: use
145 :func:`perf_counter` or :func:`process_time` instead, depending on your
146 requirements, to have a well defined behaviour.
147
Georg Brandl116aa622007-08-15 14:28:22 +0000148
Victor Stinner4195b5c2012-02-08 23:03:19 +0100149.. function:: clock_getres(clk_id)
Victor Stinnere0be4232011-10-25 13:06:09 +0200150
151 Return the resolution (precision) of the specified clock *clk_id*.
152
Victor Stinnerca6e40f2012-04-28 23:47:33 +0200153 Availability: Unix.
154
Victor Stinnere0be4232011-10-25 13:06:09 +0200155 .. versionadded:: 3.3
156
Georg Brandl909f5bc2012-03-29 09:18:14 +0200157
Victor Stinner4195b5c2012-02-08 23:03:19 +0100158.. function:: clock_gettime(clk_id)
Victor Stinnere0be4232011-10-25 13:06:09 +0200159
160 Return the time of the specified clock *clk_id*.
161
Victor Stinnerca6e40f2012-04-28 23:47:33 +0200162 Availability: Unix.
163
Victor Stinnere0be4232011-10-25 13:06:09 +0200164 .. versionadded:: 3.3
165
Georg Brandl909f5bc2012-03-29 09:18:14 +0200166
Victor Stinner30d79472012-04-03 00:45:07 +0200167.. function:: clock_settime(clk_id, time)
168
169 Set the time of the specified clock *clk_id*.
170
Victor Stinnerca6e40f2012-04-28 23:47:33 +0200171 Availability: Unix.
172
Victor Stinner30d79472012-04-03 00:45:07 +0200173 .. versionadded:: 3.3
174
175
Victor Stinner1470f352012-04-03 00:31:17 +0200176.. data:: CLOCK_HIGHRES
177
178 The Solaris OS has a CLOCK_HIGHRES timer that attempts to use an optimal
Georg Brandl514880c2012-04-30 12:50:30 +0200179 hardware source, and may give close to nanosecond resolution. CLOCK_HIGHRES
Victor Stinner1470f352012-04-03 00:31:17 +0200180 is the nonadjustable, high-resolution clock.
181
Victor Stinnerca6e40f2012-04-28 23:47:33 +0200182 Availability: Solaris.
183
Victor Stinner1470f352012-04-03 00:31:17 +0200184 .. versionadded:: 3.3
185
186
Victor Stinnere0be4232011-10-25 13:06:09 +0200187.. data:: CLOCK_MONOTONIC
188
Georg Brandl514880c2012-04-30 12:50:30 +0200189 Clock that cannot be set and represents monotonic time since some unspecified
190 starting point.
Victor Stinnere0be4232011-10-25 13:06:09 +0200191
Victor Stinnerca6e40f2012-04-28 23:47:33 +0200192 Availability: Unix.
193
Victor Stinnere0be4232011-10-25 13:06:09 +0200194 .. versionadded:: 3.3
195
Georg Brandl909f5bc2012-03-29 09:18:14 +0200196
Victor Stinnere0be4232011-10-25 13:06:09 +0200197.. data:: CLOCK_MONOTONIC_RAW
198
199 Similar to :data:`CLOCK_MONOTONIC`, but provides access to a raw
200 hardware-based time that is not subject to NTP adjustments.
201
202 Availability: Linux 2.6.28 or later.
203
204 .. versionadded:: 3.3
205
Georg Brandl909f5bc2012-03-29 09:18:14 +0200206
Victor Stinnere0be4232011-10-25 13:06:09 +0200207.. data:: CLOCK_PROCESS_CPUTIME_ID
208
209 High-resolution per-process timer from the CPU.
210
Victor Stinnerca6e40f2012-04-28 23:47:33 +0200211 Availability: Unix.
212
Victor Stinnere0be4232011-10-25 13:06:09 +0200213 .. versionadded:: 3.3
214
Georg Brandl909f5bc2012-03-29 09:18:14 +0200215
Victor Stinner6125e232012-04-12 21:40:14 +0200216.. data:: CLOCK_REALTIME
217
Georg Brandl514880c2012-04-30 12:50:30 +0200218 System-wide real-time clock. Setting this clock requires appropriate
Victor Stinner6125e232012-04-12 21:40:14 +0200219 privileges.
220
Victor Stinnerca6e40f2012-04-28 23:47:33 +0200221 Availability: Unix.
222
Victor Stinner6125e232012-04-12 21:40:14 +0200223 .. versionadded:: 3.3
224
225
Victor Stinnere0be4232011-10-25 13:06:09 +0200226.. data:: CLOCK_THREAD_CPUTIME_ID
227
228 Thread-specific CPU-time clock.
229
Victor Stinnerca6e40f2012-04-28 23:47:33 +0200230 Availability: Unix.
231
Victor Stinnere0be4232011-10-25 13:06:09 +0200232 .. versionadded:: 3.3
233
Georg Brandl909f5bc2012-03-29 09:18:14 +0200234
Georg Brandl116aa622007-08-15 14:28:22 +0000235.. function:: ctime([secs])
236
237 Convert a time expressed in seconds since the epoch to a string representing
238 local time. If *secs* is not provided or :const:`None`, the current time as
Petri Lehtinen1033b312012-05-18 21:19:17 +0300239 returned by :func:`.time` is used. ``ctime(secs)`` is equivalent to
Georg Brandl116aa622007-08-15 14:28:22 +0000240 ``asctime(localtime(secs))``. Locale information is not used by :func:`ctime`.
241
Georg Brandl116aa622007-08-15 14:28:22 +0000242
243.. data:: daylight
244
245 Nonzero if a DST timezone is defined.
246
247
Victor Stinnerec895392012-04-29 02:41:27 +0200248.. function:: get_clock_info(name)
249
Victor Stinnerbda4b882012-06-12 22:11:44 +0200250 Get information on the specified clock as a namespace object.
Georg Brandl514880c2012-04-30 12:50:30 +0200251 Supported clock names and the corresponding functions to read their value
252 are:
Victor Stinnerec895392012-04-29 02:41:27 +0200253
Georg Brandl514880c2012-04-30 12:50:30 +0200254 * ``'clock'``: :func:`time.clock`
255 * ``'monotonic'``: :func:`time.monotonic`
256 * ``'perf_counter'``: :func:`time.perf_counter`
257 * ``'process_time'``: :func:`time.process_time`
258 * ``'time'``: :func:`time.time`
Victor Stinnerec895392012-04-29 02:41:27 +0200259
Victor Stinnerbda4b882012-06-12 22:11:44 +0200260 The result has the following attributes:
261
Victor Stinner2b89fdf2012-06-12 22:46:37 +0200262 - *adjustable*: ``True`` if the clock can be changed automatically (e.g. by
263 a NTP daemon) or manually by the system administrator, ``False`` otherwise
Victor Stinnerbda4b882012-06-12 22:11:44 +0200264 - *implementation*: The name of the underlying C function used to get
265 the clock value
266 - *monotonic*: ``True`` if the clock cannot go backward,
267 ``False`` otherwise
268 - *resolution*: The resolution of the clock in seconds (:class:`float`)
269
Victor Stinnerec895392012-04-29 02:41:27 +0200270 .. versionadded:: 3.3
271
272
Georg Brandl116aa622007-08-15 14:28:22 +0000273.. function:: gmtime([secs])
274
275 Convert a time expressed in seconds since the epoch to a :class:`struct_time` in
276 UTC in which the dst flag is always zero. If *secs* is not provided or
Petri Lehtinen1033b312012-05-18 21:19:17 +0300277 :const:`None`, the current time as returned by :func:`.time` is used. Fractions
Georg Brandl116aa622007-08-15 14:28:22 +0000278 of a second are ignored. See above for a description of the
279 :class:`struct_time` object. See :func:`calendar.timegm` for the inverse of this
280 function.
281
Georg Brandl116aa622007-08-15 14:28:22 +0000282
283.. function:: localtime([secs])
284
285 Like :func:`gmtime` but converts to local time. If *secs* is not provided or
Petri Lehtinen1033b312012-05-18 21:19:17 +0300286 :const:`None`, the current time as returned by :func:`.time` is used. The dst
Georg Brandl116aa622007-08-15 14:28:22 +0000287 flag is set to ``1`` when DST applies to the given time.
288
Georg Brandl116aa622007-08-15 14:28:22 +0000289
Victor Stinner4195b5c2012-02-08 23:03:19 +0100290.. function:: mktime(t)
Georg Brandl116aa622007-08-15 14:28:22 +0000291
292 This is the inverse function of :func:`localtime`. Its argument is the
293 :class:`struct_time` or full 9-tuple (since the dst flag is needed; use ``-1``
294 as the dst flag if it is unknown) which expresses the time in *local* time, not
Petri Lehtinen1033b312012-05-18 21:19:17 +0300295 UTC. It returns a floating point number, for compatibility with :func:`.time`.
Georg Brandl116aa622007-08-15 14:28:22 +0000296 If the input value cannot be represented as a valid time, either
297 :exc:`OverflowError` or :exc:`ValueError` will be raised (which depends on
298 whether the invalid value is caught by Python or the underlying C libraries).
299 The earliest date for which it can generate a time is platform-dependent.
300
301
Victor Stinnerec895392012-04-29 02:41:27 +0200302.. function:: monotonic()
Victor Stinner8b302012012-02-07 23:29:46 +0100303
Georg Brandl514880c2012-04-30 12:50:30 +0200304 Return the value (in fractional seconds) of a monotonic clock, i.e. a clock
305 that cannot go backwards. The clock is not affected by system clock updates.
306 The reference point of the returned value is undefined, so that only the
307 difference between the results of consecutive calls is valid.
Victor Stinnerec919cc2012-03-15 00:58:32 +0100308
Victor Stinnerec895392012-04-29 02:41:27 +0200309 On Windows versions older than Vista, :func:`monotonic` detects
Georg Brandl514880c2012-04-30 12:50:30 +0200310 :c:func:`GetTickCount` integer overflow (32 bits, roll-over after 49.7 days).
Ezio Melotti99bafff2012-11-05 22:22:48 +0200311 It increases an internal epoch (reference time) by 2\ :sup:`32` each time
Georg Brandl514880c2012-04-30 12:50:30 +0200312 that an overflow is detected. The epoch is stored in the process-local state
313 and so the value of :func:`monotonic` may be different in two Python
Victor Stinnerec895392012-04-29 02:41:27 +0200314 processes running for more than 49 days. On more recent versions of Windows
315 and on other operating systems, :func:`monotonic` is system-wide.
Victor Stinner8b302012012-02-07 23:29:46 +0100316
Victor Stinnerec895392012-04-29 02:41:27 +0200317 .. versionadded:: 3.3
Victor Stinnerae586492014-09-02 23:18:25 +0200318 .. versionchanged:: 3.5
319 The function is now always available.
Victor Stinnerec895392012-04-29 02:41:27 +0200320
321
322.. function:: perf_counter()
323
Georg Brandl514880c2012-04-30 12:50:30 +0200324 Return the value (in fractional seconds) of a performance counter, i.e. a
325 clock with the highest available resolution to measure a short duration. It
326 does include time elapsed during sleep and is system-wide. The reference
327 point of the returned value is undefined, so that only the difference between
328 the results of consecutive calls is valid.
Victor Stinnerec895392012-04-29 02:41:27 +0200329
330 .. versionadded:: 3.3
331
332
333.. function:: process_time()
334
Georg Brandl514880c2012-04-30 12:50:30 +0200335 Return the value (in fractional seconds) of the sum of the system and user
336 CPU time of the current process. It does not include time elapsed during
337 sleep. It is process-wide by definition. The reference point of the
338 returned value is undefined, so that only the difference between the results
339 of consecutive calls is valid.
Victor Stinner071eca32012-03-15 01:17:09 +0100340
Victor Stinner0f7888d2012-02-14 02:42:21 +0100341 .. versionadded:: 3.3
Victor Stinner8b302012012-02-07 23:29:46 +0100342
Georg Brandl116aa622007-08-15 14:28:22 +0000343.. function:: sleep(secs)
344
R David Murrayf1f96752015-01-25 15:45:14 -0500345 Suspend execution of the calling thread for the given number of seconds.
R David Murray1923b622015-01-25 15:46:22 -0500346 The argument may be a floating point number to indicate a more precise sleep
347 time. The actual suspension time may be less than that requested because any
348 caught signal will terminate the :func:`sleep` following execution of that
349 signal's catching routine. Also, the suspension time may be longer than
350 requested by an arbitrary amount because of the scheduling of other activity
351 in the system.
Georg Brandl116aa622007-08-15 14:28:22 +0000352
Victor Stinner79d68f92015-03-19 21:54:09 +0100353 .. versionchanged:: 3.5
354 The function now sleeps at least *secs* even if the sleep is interrupted
355 by a signal, except if the signal handler raises an exception (see
356 :pep:`475` for the rationale).
357
Georg Brandl116aa622007-08-15 14:28:22 +0000358
359.. function:: strftime(format[, t])
360
361 Convert a tuple or :class:`struct_time` representing a time as returned by
362 :func:`gmtime` or :func:`localtime` to a string as specified by the *format*
363 argument. If *t* is not provided, the current time as returned by
364 :func:`localtime` is used. *format* must be a string. :exc:`ValueError` is
365 raised if any field in *t* is outside of the allowed range.
366
Georg Brandl55ac8f02007-09-01 13:51:09 +0000367 0 is a legal argument for any position in the time tuple; if it is normally
368 illegal the value is forced to a correct one.
Georg Brandl116aa622007-08-15 14:28:22 +0000369
370 The following directives can be embedded in the *format* string. They are shown
371 without the optional field width and precision specification, and are replaced
372 by the indicated characters in the :func:`strftime` result:
373
Georg Brandl55ac8f02007-09-01 13:51:09 +0000374 +-----------+------------------------------------------------+-------+
375 | Directive | Meaning | Notes |
376 +===========+================================================+=======+
377 | ``%a`` | Locale's abbreviated weekday name. | |
378 | | | |
379 +-----------+------------------------------------------------+-------+
380 | ``%A`` | Locale's full weekday name. | |
381 +-----------+------------------------------------------------+-------+
382 | ``%b`` | Locale's abbreviated month name. | |
383 | | | |
384 +-----------+------------------------------------------------+-------+
385 | ``%B`` | Locale's full month name. | |
386 +-----------+------------------------------------------------+-------+
387 | ``%c`` | Locale's appropriate date and time | |
388 | | representation. | |
389 +-----------+------------------------------------------------+-------+
390 | ``%d`` | Day of the month as a decimal number [01,31]. | |
391 | | | |
392 +-----------+------------------------------------------------+-------+
393 | ``%H`` | Hour (24-hour clock) as a decimal number | |
394 | | [00,23]. | |
395 +-----------+------------------------------------------------+-------+
396 | ``%I`` | Hour (12-hour clock) as a decimal number | |
397 | | [01,12]. | |
398 +-----------+------------------------------------------------+-------+
399 | ``%j`` | Day of the year as a decimal number [001,366]. | |
400 | | | |
401 +-----------+------------------------------------------------+-------+
402 | ``%m`` | Month as a decimal number [01,12]. | |
403 | | | |
404 +-----------+------------------------------------------------+-------+
405 | ``%M`` | Minute as a decimal number [00,59]. | |
406 | | | |
407 +-----------+------------------------------------------------+-------+
408 | ``%p`` | Locale's equivalent of either AM or PM. | \(1) |
409 | | | |
410 +-----------+------------------------------------------------+-------+
411 | ``%S`` | Second as a decimal number [00,61]. | \(2) |
412 | | | |
413 +-----------+------------------------------------------------+-------+
414 | ``%U`` | Week number of the year (Sunday as the first | \(3) |
415 | | day of the week) as a decimal number [00,53]. | |
416 | | All days in a new year preceding the first | |
417 | | Sunday are considered to be in week 0. | |
418 | | | |
419 | | | |
420 | | | |
421 +-----------+------------------------------------------------+-------+
422 | ``%w`` | Weekday as a decimal number [0(Sunday),6]. | |
423 | | | |
424 +-----------+------------------------------------------------+-------+
425 | ``%W`` | Week number of the year (Monday as the first | \(3) |
426 | | day of the week) as a decimal number [00,53]. | |
427 | | All days in a new year preceding the first | |
428 | | Monday are considered to be in week 0. | |
429 | | | |
430 | | | |
431 | | | |
432 +-----------+------------------------------------------------+-------+
433 | ``%x`` | Locale's appropriate date representation. | |
434 | | | |
435 +-----------+------------------------------------------------+-------+
436 | ``%X`` | Locale's appropriate time representation. | |
437 | | | |
438 +-----------+------------------------------------------------+-------+
439 | ``%y`` | Year without century as a decimal number | |
440 | | [00,99]. | |
441 +-----------+------------------------------------------------+-------+
Alexander Belopolsky03163ac2011-05-02 12:20:52 -0400442 | ``%Y`` | Year with century as a decimal number. | |
Georg Brandl55ac8f02007-09-01 13:51:09 +0000443 | | | |
444 +-----------+------------------------------------------------+-------+
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400445 | ``%z`` | Time zone offset indicating a positive or | |
446 | | negative time difference from UTC/GMT of the | |
447 | | form +HHMM or -HHMM, where H represents decimal| |
448 | | hour digits and M represents decimal minute | |
449 | | digits [-23:59, +23:59]. | |
450 +-----------+------------------------------------------------+-------+
Georg Brandl55ac8f02007-09-01 13:51:09 +0000451 | ``%Z`` | Time zone name (no characters if no time zone | |
452 | | exists). | |
453 +-----------+------------------------------------------------+-------+
454 | ``%%`` | A literal ``'%'`` character. | |
455 +-----------+------------------------------------------------+-------+
Georg Brandl116aa622007-08-15 14:28:22 +0000456
457 Notes:
458
459 (1)
460 When used with the :func:`strptime` function, the ``%p`` directive only affects
461 the output hour field if the ``%I`` directive is used to parse the hour.
462
463 (2)
Alexander Belopolsky9971e002011-01-10 22:56:14 +0000464 The range really is ``0`` to ``61``; value ``60`` is valid in
465 timestamps representing leap seconds and value ``61`` is supported
466 for historical reasons.
Georg Brandl116aa622007-08-15 14:28:22 +0000467
468 (3)
469 When used with the :func:`strptime` function, ``%U`` and ``%W`` are only used in
470 calculations when the day of the week and the year are specified.
471
472 Here is an example, a format for dates compatible with that specified in the
473 :rfc:`2822` Internet email standard. [#]_ ::
474
475 >>> from time import gmtime, strftime
476 >>> strftime("%a, %d %b %Y %H:%M:%S +0000", gmtime())
477 'Thu, 28 Jun 2001 14:17:15 +0000'
478
Georg Brandlb7117af2013-10-13 18:28:25 +0200479 Additional directives may be supported on certain platforms, but only the
480 ones listed here have a meaning standardized by ANSI C. To see the full set
481 of format codes supported on your platform, consult the :manpage:`strftime(3)`
482 documentation.
Georg Brandl116aa622007-08-15 14:28:22 +0000483
484 On some platforms, an optional field width and precision specification can
485 immediately follow the initial ``'%'`` of a directive in the following order;
486 this is also not portable. The field width is normally 2 except for ``%j`` where
487 it is 3.
488
489
490.. function:: strptime(string[, format])
491
Brett Cannon7f6b4f82009-03-30 21:30:26 +0000492 Parse a string representing a time according to a format. The return value
493 is a :class:`struct_time` as returned by :func:`gmtime` or
494 :func:`localtime`.
Georg Brandl116aa622007-08-15 14:28:22 +0000495
496 The *format* parameter uses the same directives as those used by
497 :func:`strftime`; it defaults to ``"%a %b %d %H:%M:%S %Y"`` which matches the
Brett Cannon7f6b4f82009-03-30 21:30:26 +0000498 formatting returned by :func:`ctime`. If *string* cannot be parsed according
499 to *format*, or if it has excess data after parsing, :exc:`ValueError` is
500 raised. The default values used to fill in any missing data when more
501 accurate values cannot be inferred are ``(1900, 1, 1, 0, 0, 0, 0, 1, -1)``.
502 Both *string* and *format* must be strings.
Georg Brandl116aa622007-08-15 14:28:22 +0000503
Christian Heimesfe337bf2008-03-23 21:54:12 +0000504 For example:
Georg Brandl116aa622007-08-15 14:28:22 +0000505
506 >>> import time
Christian Heimesfe337bf2008-03-23 21:54:12 +0000507 >>> time.strptime("30 Nov 00", "%d %b %y") # doctest: +NORMALIZE_WHITESPACE
508 time.struct_time(tm_year=2000, tm_mon=11, tm_mday=30, tm_hour=0, tm_min=0,
509 tm_sec=0, tm_wday=3, tm_yday=335, tm_isdst=-1)
Georg Brandl116aa622007-08-15 14:28:22 +0000510
511 Support for the ``%Z`` directive is based on the values contained in ``tzname``
512 and whether ``daylight`` is true. Because of this, it is platform-specific
513 except for recognizing UTC and GMT which are always known (and are considered to
514 be non-daylight savings timezones).
515
516 Only the directives specified in the documentation are supported. Because
517 ``strftime()`` is implemented per platform it can sometimes offer more
518 directives than those listed. But ``strptime()`` is independent of any platform
519 and thus does not necessarily support all directives available that are not
520 documented as supported.
521
522
Georg Brandlb67878a2010-10-15 17:01:15 +0000523.. class:: struct_time
Georg Brandl116aa622007-08-15 14:28:22 +0000524
525 The type of the time value sequence returned by :func:`gmtime`,
Georg Brandlb67878a2010-10-15 17:01:15 +0000526 :func:`localtime`, and :func:`strptime`. It is an object with a :term:`named
527 tuple` interface: values can be accessed by index and by attribute name. The
528 following values are present:
529
530 +-------+-------------------+---------------------------------+
531 | Index | Attribute | Values |
532 +=======+===================+=================================+
533 | 0 | :attr:`tm_year` | (for example, 1993) |
534 +-------+-------------------+---------------------------------+
535 | 1 | :attr:`tm_mon` | range [1, 12] |
536 +-------+-------------------+---------------------------------+
537 | 2 | :attr:`tm_mday` | range [1, 31] |
538 +-------+-------------------+---------------------------------+
539 | 3 | :attr:`tm_hour` | range [0, 23] |
540 +-------+-------------------+---------------------------------+
541 | 4 | :attr:`tm_min` | range [0, 59] |
542 +-------+-------------------+---------------------------------+
Alexander Belopolsky04da1e02011-01-10 19:14:38 +0000543 | 5 | :attr:`tm_sec` | range [0, 61]; see **(2)** in |
Georg Brandlb67878a2010-10-15 17:01:15 +0000544 | | | :func:`strftime` description |
545 +-------+-------------------+---------------------------------+
546 | 6 | :attr:`tm_wday` | range [0, 6], Monday is 0 |
547 +-------+-------------------+---------------------------------+
548 | 7 | :attr:`tm_yday` | range [1, 366] |
549 +-------+-------------------+---------------------------------+
550 | 8 | :attr:`tm_isdst` | 0, 1 or -1; see below |
551 +-------+-------------------+---------------------------------+
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400552 | N/A | :attr:`tm_zone` | abbreviation of timezone name |
553 +-------+-------------------+---------------------------------+
Alexander Belopolsky93c9cd02012-06-22 16:04:19 -0400554 | N/A | :attr:`tm_gmtoff` | offset east of UTC in seconds |
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400555 +-------+-------------------+---------------------------------+
Georg Brandlb67878a2010-10-15 17:01:15 +0000556
557 Note that unlike the C structure, the month value is a range of [1, 12], not
Alexander Belopolsky03163ac2011-05-02 12:20:52 -0400558 [0, 11]. A ``-1`` argument as the daylight
Georg Brandlb67878a2010-10-15 17:01:15 +0000559 savings flag, passed to :func:`mktime` will usually result in the correct
560 daylight savings state to be filled in.
561
562 When a tuple with an incorrect length is passed to a function expecting a
563 :class:`struct_time`, or having elements of the wrong type, a
564 :exc:`TypeError` is raised.
Georg Brandl116aa622007-08-15 14:28:22 +0000565
Alexander Belopolskyc142bba2012-06-13 22:15:26 -0400566 .. versionchanged:: 3.3
Andrew Svetlov3934b612012-10-04 19:52:32 +0300567 :attr:`tm_gmtoff` and :attr:`tm_zone` attributes are available on platforms
Georg Brandl61063cc2012-06-24 22:48:30 +0200568 with C library supporting the corresponding fields in ``struct tm``.
Georg Brandl116aa622007-08-15 14:28:22 +0000569
Victor Stinner4195b5c2012-02-08 23:03:19 +0100570.. function:: time()
Georg Brandl116aa622007-08-15 14:28:22 +0000571
R David Murray38c27542012-03-15 03:06:15 -0400572 Return the time in seconds since the epoch as a floating point number.
573 Note that even though the time is always returned as a floating point
Georg Brandl116aa622007-08-15 14:28:22 +0000574 number, not all systems provide time with a better precision than 1 second.
575 While this function normally returns non-decreasing values, it can return a
576 lower value than a previous call if the system clock has been set back between
577 the two calls.
578
Georg Brandl116aa622007-08-15 14:28:22 +0000579.. data:: timezone
580
581 The offset of the local (non-DST) timezone, in seconds west of UTC (negative in
582 most of Western Europe, positive in the US, zero in the UK).
583
584
585.. data:: tzname
586
587 A tuple of two strings: the first is the name of the local non-DST timezone, the
588 second is the name of the local DST timezone. If no DST timezone is defined,
589 the second string should not be used.
590
591
592.. function:: tzset()
593
594 Resets the time conversion rules used by the library routines. The environment
595 variable :envvar:`TZ` specifies how this is done.
596
Georg Brandl116aa622007-08-15 14:28:22 +0000597 Availability: Unix.
598
599 .. note::
600
601 Although in many cases, changing the :envvar:`TZ` environment variable may
602 affect the output of functions like :func:`localtime` without calling
603 :func:`tzset`, this behavior should not be relied on.
604
605 The :envvar:`TZ` environment variable should contain no whitespace.
606
607 The standard format of the :envvar:`TZ` environment variable is (whitespace
608 added for clarity)::
609
610 std offset [dst [offset [,start[/time], end[/time]]]]
611
612 Where the components are:
613
614 ``std`` and ``dst``
615 Three or more alphanumerics giving the timezone abbreviations. These will be
616 propagated into time.tzname
617
618 ``offset``
619 The offset has the form: ``± hh[:mm[:ss]]``. This indicates the value
620 added the local time to arrive at UTC. If preceded by a '-', the timezone
621 is east of the Prime Meridian; otherwise, it is west. If no offset follows
622 dst, summer time is assumed to be one hour ahead of standard time.
623
624 ``start[/time], end[/time]``
625 Indicates when to change to and back from DST. The format of the
626 start and end dates are one of the following:
627
628 :samp:`J{n}`
629 The Julian day *n* (1 <= *n* <= 365). Leap days are not counted, so in
630 all years February 28 is day 59 and March 1 is day 60.
631
632 :samp:`{n}`
633 The zero-based Julian day (0 <= *n* <= 365). Leap days are counted, and
634 it is possible to refer to February 29.
635
636 :samp:`M{m}.{n}.{d}`
637 The *d*'th day (0 <= *d* <= 6) or week *n* of month *m* of the year (1
638 <= *n* <= 5, 1 <= *m* <= 12, where week 5 means "the last *d* day in
639 month *m*" which may occur in either the fourth or the fifth
640 week). Week 1 is the first week in which the *d*'th day occurs. Day
641 zero is Sunday.
642
643 ``time`` has the same format as ``offset`` except that no leading sign
644 ('-' or '+') is allowed. The default, if time is not given, is 02:00:00.
645
646 ::
647
648 >>> os.environ['TZ'] = 'EST+05EDT,M4.1.0,M10.5.0'
649 >>> time.tzset()
650 >>> time.strftime('%X %x %Z')
651 '02:07:36 05/08/03 EDT'
652 >>> os.environ['TZ'] = 'AEST-10AEDT-11,M10.5.0,M3.5.0'
653 >>> time.tzset()
654 >>> time.strftime('%X %x %Z')
655 '16:08:12 05/08/03 AEST'
656
657 On many Unix systems (including \*BSD, Linux, Solaris, and Darwin), it is more
658 convenient to use the system's zoneinfo (:manpage:`tzfile(5)`) database to
659 specify the timezone rules. To do this, set the :envvar:`TZ` environment
660 variable to the path of the required timezone datafile, relative to the root of
661 the systems 'zoneinfo' timezone database, usually located at
662 :file:`/usr/share/zoneinfo`. For example, ``'US/Eastern'``,
663 ``'Australia/Melbourne'``, ``'Egypt'`` or ``'Europe/Amsterdam'``. ::
664
665 >>> os.environ['TZ'] = 'US/Eastern'
666 >>> time.tzset()
667 >>> time.tzname
668 ('EST', 'EDT')
669 >>> os.environ['TZ'] = 'Egypt'
670 >>> time.tzset()
671 >>> time.tzname
672 ('EET', 'EEST')
673
674
675.. seealso::
676
677 Module :mod:`datetime`
678 More object-oriented interface to dates and times.
679
680 Module :mod:`locale`
Terry Jan Reedyb5e2e7e2013-04-03 12:34:57 -0400681 Internationalization services. The locale setting affects the interpretation
Terry Jan Reedy41459a92013-04-03 12:45:24 -0400682 of many format specifiers in :func:`strftime` and :func:`strptime`.
Georg Brandl116aa622007-08-15 14:28:22 +0000683
684 Module :mod:`calendar`
Serhiy Storchakabfdcd432013-10-13 23:09:14 +0300685 General calendar-related functions. :func:`~calendar.timegm` is the
686 inverse of :func:`gmtime` from this module.
Georg Brandl116aa622007-08-15 14:28:22 +0000687
688.. rubric:: Footnotes
689
690.. [#] The use of ``%Z`` is now deprecated, but the ``%z`` escape that expands to the
691 preferred hour/minute offset is not supported by all ANSI C libraries. Also, a
692 strict reading of the original 1982 :rfc:`822` standard calls for a two-digit
693 year (%y rather than %Y), but practice moved to 4-digit years long before the
Sandro Tosif6938102011-08-19 18:40:21 +0200694 year 2000. After that, :rfc:`822` became obsolete and the 4-digit year has
695 been first recommended by :rfc:`1123` and then mandated by :rfc:`2822`.
Georg Brandl116aa622007-08-15 14:28:22 +0000696