diff options
Diffstat (limited to 'Doc/library/time.rst')
| -rw-r--r-- | Doc/library/time.rst | 50 |
1 files changed, 10 insertions, 40 deletions
diff --git a/Doc/library/time.rst b/Doc/library/time.rst index 73a9518..7865b5a 100644 --- a/Doc/library/time.rst +++ b/Doc/library/time.rst @@ -95,14 +95,6 @@ An explanation of some terminology and conventions is in order. | local time | | | +-------------------------+-------------------------+-------------------------+ -.. _timestamp-types: - -* Python supports the following timestamp types: - - * :class:`int` - * :class:`float` - * :class:`decimal.Decimal` - The module defines the following functions and data items: @@ -127,7 +119,7 @@ The module defines the following functions and data items: trailing newline. -.. function:: clock(timestamp=float) +.. function:: clock() .. index:: single: CPU time @@ -144,27 +136,16 @@ The module defines the following functions and data items: :c:func:`QueryPerformanceCounter`. The resolution is typically better than one microsecond. - Return as a floating point number by default, set the *timestamp* argument - to get another :ref:`timestamp type <timestamp-types>`. - - .. versionchanged:: 3.3 - Added the *timestamp* argument. - -.. function:: clock_getres(clk_id, timestamp=float) +.. function:: clock_getres(clk_id) Return the resolution (precision) of the specified clock *clk_id*. - Return a floating point number by default, set the *timestamp* argument to - get another :ref:`timestamp type <timestamp-types>`. - .. versionadded:: 3.3 -.. function:: clock_gettime(clk_id, timestamp=float) +.. function:: clock_gettime(clk_id) Return the time of the specified clock *clk_id*. - Return a floating point number by default, set the *timestamp* argument to - get another :ref:`timestamp type <timestamp-types>`. .. versionadded:: 3.3 @@ -233,22 +214,19 @@ The module defines the following functions and data items: flag is set to ``1`` when DST applies to the given time. -.. function:: mktime(t, timestamp=float) +.. function:: mktime(t) This is the inverse function of :func:`localtime`. Its argument is the :class:`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 - It returns a floating point number by default, for compatibility with - :func:`time`, set the *timestamp* argument to get another :ref:`timestamp - type <timestamp-types>`. - + UTC. It returns a floating point number, for compatibility with :func:`time`. If the input value cannot be represented as a valid time, either :exc:`OverflowError` or :exc:`ValueError` will be raised (which depends on whether the invalid value is caught by Python or the underlying C libraries). The earliest date for which it can generate a time is platform-dependent. -.. function:: monotonic(timestamp=float) +.. function:: monotonic() Monotonic clock. The reference point of the returned value is undefined so only the difference of consecutive calls is valid. @@ -462,20 +440,15 @@ The module defines the following functions and data items: :exc:`TypeError` is raised. -.. function:: time(timestamp=float) +.. function:: time() - Return the time expressed in seconds since the epoch in UTC. Return a - floating point number by default, set the *timestamp* argument to get - another :ref:`timestamp type <timestamp-types>`. - Note that even though the time is always returned as a floating point + Return the time as a floating point number expressed in seconds since the epoch, + in UTC. Note that even though the time is always returned as a floating point number, not all systems provide time with a better precision than 1 second. While this function normally returns non-decreasing values, it can return a lower value than a previous call if the system clock has been set back between the two calls. - .. versionchanged:: 3.3 - Added the *timestamp* argument. - .. data:: timezone @@ -573,16 +546,13 @@ The module defines the following functions and data items: ('EET', 'EEST') -.. function:: wallclock(timestamp=float) +.. function:: wallclock() .. index:: single: Wallclock single: benchmarking Return the current time in fractions of a second to the system's best ability. - Return a floating point number by default, set the *timestamp* argument to - get another :ref:`timestamp type <timestamp-types>`. - Use this when the most accurate representation of wall-clock is required, i.e. when "processor time" is inappropriate. The reference point of the returned value is undefined so only the difference of consecutive calls is valid. |