time – time and timing related functions
This module implements a subset of the corresponding CPython module,
as described below. For more information, refer to the original
CPython documentation: cpython:time.
Available on these boards
- time.monotonic() float
Returns an always increasing value of time with an unknown reference point. Only use it to compare against other values from
time.monotonic()during the same code run.On most boards,
time.monotonic()converts a 64-bit millisecond tick counter to a float. Floats on most boards are encoded in 30 bits internally, with effectively 22 bits of precision. The float returned bytime.monotonic()will accurately represent time to millisecond precision only up to 2**22 milliseconds (about 1.165 hours). At that point it will start losing precision, and its value will change only every second millisecond. At 2**23 milliseconds it will change every fourth millisecond, and so forth.If you need more consistent precision, use
time.monotonic_ns(), orsupervisor.ticks_ms().time.monotonic_ns()is not available on boards without long integer support.supervisor.ticks_ms()uses intervals of a millisecond, but wraps around, and is not CPython-compatible.- Returns:
the current monotonic time
- Return type:
- time.sleep(seconds: float) None
Sleep for a given number of seconds.
- Parameters:
seconds (float) – the time to sleep in fractional seconds
- class time.struct_time(time_tuple: Sequence[int])
Structure used to capture a date and time. Can be constructed from a
struct_time,tuple,list, ornamedtuplewith 9 elements.- Parameters:
time_tuple (Sequence) –
Sequence of time info:
(tm_year, tm_mon, tm_mday, tm_hour, tm_min, tm_sec, tm_wday, tm_yday, tm_isdst)tm_year: the year, 2017 for exampletm_mon: the month, range [1, 12]tm_mday: the day of the month, range [1, 31]tm_hour: the hour, range [0, 23]tm_min: the minute, range [0, 59]tm_sec: the second, range [0, 61]tm_wday: the day of the week, range [0, 6], Monday is 0tm_yday: the day of the year, range [1, 366], -1 indicates not knowntm_isdst: 1 when in daylight savings, 0 when not, -1 if unknown.
- time.time() int
Return the current time in seconds since since Jan 1, 1970.
- Returns:
the current time
- Return type:
- time.monotonic_ns() int
Return the time of the monotonic clock, which cannot go backward, in nanoseconds. Not available on boards without long integer support. Only use it to compare against other values from
time.monotonic()during a single code run.- Returns:
the current time
- Return type:
- time.localtime(secs: int) struct_time
Convert a time expressed in seconds since Jan 1, 1970 to a struct_time in local time. If secs is not provided or None, the current time as returned by time() is used. The earliest date for which it can generate a time is Jan 1, 2000.
- Returns:
the current time
- Return type:
- time.mktime(t: struct_time) int
This is the inverse function of localtime(). Its argument is the struct_time or full 9-tuple (since the dst flag is needed; use -1 as the dst flag if it is unknown) which expresses the time in local time, not UTC. The earliest date for which it can generate a time is Jan 1, 2000.
- Returns:
seconds
- Return type: